Predefined Schedules and Connection Settings

To simplify development, Session Scheduler provides an ability to define session schedules and connecting settings in configuration files for later referencing in the source code.

Once presets are defined in the file, the session scheduler can use them during the instance initialization stage (OnixS::B3::BOE::Scheduling::SessionSchedulerOptions class exposes OnixS::B3::BOE::Scheduling::SessionSchedulerOptions::configurationFile member for these purposes). Afterwards, both schedules and connection settings can be referenced in the source code using the string identifiers. Scheduler exposes the OnixS::B3::BOE::Scheduling::SessionScheduler::add overload to schedule a session with parameters described in a configuration file.

Example

using namespace OnixS::B3::BOE;
using namespace OnixS::B3::BOE::Scheduling;

SessionSchedulerOptions schedulerOptions;

schedulerOptions.configurationFile("Scheduler.conf");

SessionScheduler scheduler(schedulerOptions);

scheduler.add(&session, "ScheduleId", "ConnectionId");

Moreover, OnixS::B3::BOE::Scheduling::SessionScheduler exposes OnixS::B3::BOE::Scheduling::SessionScheduler::findSchedule and OnixS::B3::BOE::Scheduling::SessionScheduler::findConnectionSettings members to access real instances of schedules and connection settings described in the configuration file. These members can help when a session has to be registered with a partially predefined configuration.

Example

The following example demonstrates how a session can be registered with a predefined schedule, but custom connection settings are not described in the configuration file.

using namespace OnixS::B3::BOE;
using namespace OnixS::B3::BOE::Scheduling;

scheduler.add(&testingEnvironmentSession, *scheduler.findSchedule("B3"), SessionConnectionSettings("gateway", 8000));

Configuration File Reference

Description of Scheduler settings has XML-based syntax. The following elements are supported:

Element	Description
SchedulerSettings	Root element of scheduler's configuration.
Schedules	Contains descriptions of predefined schedules.
Schedule	Describes attributes of a particular session schedule.
Connections	Contains descriptions of predefined session connection settings.
Connection	Defines characteristics of a particular session connection.

Note

Up-to-date Scheduler settings configuration schema available on Corporate Website.

Defining Session Schedule

Session Schedule description consists in definition of the following attributes for the Schedule element:

Attribute	Values	Notes
id	Non-empty String	It's a unique identifier for the schedule. The value of this attribute is used later in the source code to refer to the described schedule. It must be unique among all schedules.
firstDay	Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday	Defines the first day of the activity week for session.
lastDay	Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday	Defines the last day of the activity week for session.
logonTime	Time value from 0:00 till 23:59 in 24 hours format (with optional seconds resolution).	Defines the time of logon for a session.
logoutTime	Time value from 0:00 till 23:59 in 24 hours format (with optional seconds resolution).	Defines the time of logout for a session.

Defining Session Connection Settings

The description of connection settings consists of the definition of the following attributes for the Connection element:

Attribute	Values	Notes
id	Non-empty String	It's a unique identifier for the settings set. The value of this attribute is used later in the source code to refer to described settings. It must be unique among all settings sets.
host	String	If a session must be logged on in the role of initiator, this parameter defines a remote host to which the session must connect to. Otherwise, the attribute is ignored.
port	Number	If a session must be logged on in the role of initiator, this parameter defines a port number to which the session must connect to. Otherwise, the attribute is ignored.

Note

It's possible to specify multiple counter parties in session connection settings description. If Scheduler fails to connect session to one counterparty, it will switch, using another one and so on, until a successful connection will be established. For this reason, the session connection settings XML description accepts inner Counterparty nodes with host and port attributes. Inner nodes are ignored if the master Connection node contains host and port attributes.

Example

Below is a typical configuration file for Sessions Scheduler.

<?xml version="1.0" encoding="utf-8" ?>
<SchedulerSettings
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="https://ref.onixs.biz/fix/scheduler https://ref.onixs.biz/fix/scheduler/scheduler-settings-1.6.xsd"
  xmlns="https://ref.onixs.biz/fix/scheduler" >

  <Schedules>

    <Schedule
        id="B3"
        firstDay="Sunday"
        logonTime="18:00"
        lastDay="Friday"
        logoutTime="16:00"
    />

    <Schedule
      id="SimpleDaily"
      firstDay="Monday"
      lastDay="Friday"
      logonTime="08:00"
      logoutTime="17:00"
      />

  </Schedules>

  <Connections>
    <Connection
        id="LocalSession">
        <Counterparty host="localhost" port="4500"/>
    </Connection>
    <Connection
        id="SessionToTestingEnvironment">
        <Counterparty host="testing-evn.privatedomain.com" port="8000"/>
    </Connection>
    <Connection
        id="MultiTargetSession">
        <Counterparty host="primary.domain.com" port="4600"/>
        <Counterparty host="secondary.domain.com" port="4500"/>
    </Connection>
  </Connections>
</SchedulerSettings>