Export/Import Server Configuration (for FIXEdge C++)

Owned by Yaroslav Melyn
Last updated: Dec 03, 2022

Export/Import server configuration

FIXICC H2 provides availabilities of:

  • Exporting the server configuration in a ZIP archive
  • Importing the previously exported server configuration on a specified server
  • Importing a legacy server configuration on a specified server

Access to importing, exporting, and migrating server configuration is provided via the Configurations dropdown on the Server details view 

The Dropdown contains the following items:

  • Business Layer Configuration
  • Business Layer Scripts
  • Export Server Configuration
  • Import Server Configuration
  • Migrate Server Configuration

Export Server Configuration

To export the configuration of the selected server, click on the "Export configuration" menu item.

If your browser is configured to download files to the pre-defined location, the ZIP archive named <server_name>_configuration.zip will be downloaded automatically and the file name appears in the downloads section at the bottom of the screen.

Otherwise, the system dialog "Save As" appears.

Specify the desired location, change the name if required, and click the button "Save".

The downloaded ZIP archive contains the following items:

TitleTypeContent description

BL_configuration

folder
  • files <component_name>.json (one file per component)

schedules

folder
  • file schedules.properties with sessions' schedules in form of CRON expressions
  • file schedules.json with the list of sessions' schedules in JSON format

scripts

folder
  • files with Java Scripts
  • JSON files for each .js file
sessionsfolder
  • file FIXEdge.properties with the legacy FIX sessions
  • file sessions.json with the list of FIX sessions stored in the FIXICC H2 database
BL_Config.xmlfileXML file with BL rules, DLL handlers, Histories, and event handlers

This file can be imported to the FIXEdge server of the same type as described in the next section.

Import Server Configuration

To import the configuration, click on the "Import Configuration" menu item.

The dialog "Upload the file" appears.

You can drag the appropriate ZIP file and drop it in the specified area, or click on the button "Upload" to open the system dialog "Open".

Possible errors

In case the ZIP file is corrupted:

  • The error message appears: ;
  • None of the new sessions are imported;
  • None of the existing sessions are changed.


Import FIX Sessions

The sessions specified in the file session.json are to be imported to the FIXICC H2 DB as follows:

Check for SenderCompID and TargetCompID

All the sessions are to be checked against the existing sessions in terms of SenderCompID and TargetCompID combination.

The session qualifier (if any) is ignored during the check.

In case these combinations are the same, the sessions are considered duplicates and the confirmation dialog appears:

You may decide to replace the existing session and click the button "Replace". In this case, the properties of the existing session will be overwritten with values from the new session.

If you decide to skip the session and click the button "Skip", then the existing session remains unchanged and the new session will be ignored.

You also have an option "Apply to all sessions (n)" allowing you to apply your decision to all duplicated sessions (if any) and suppress the further notifications. "n" in parentheses denotes the number of not handled sessions in the file.

Check for Session Name

In case the FIX session with the same name is on the server, the duplicated FIX session is saved under the name copy of <session_name> in FIXICC H2 DB.

Other existing sessions on the server remain unchanged

In case the session.json file within the ZIP file is invalid:
  • The error message appears: "Can not read file <file_name>";
  • None of the new sessions are imported;
  • None of the existing sessions are changed.



Import Business Layer Configuration

The Business Layer Components specified in the file folder BL_configuration are to be imported to the FIXICC H2 DB as follows:

All the components' names are to be checked against the names of existing ones.

In case the names appear the same, the components are considered duplicates and the confirmation dialog appears:

You may decide to replace the existing component and click the button "Replace". In this case, the properties of the existing component will be overwritten with values from the new component.

The second possibility is clicking on the button "Import as a copy". In this case, the duplicated component is saved under the name copy of <component_name> in FIXICC H2 DB.

If you decide to skip the component and click the button "Skip", the existing component remains unchanged and the new component will be ignored.

You also have an option "Apply to all components (n)" allowing you to apply your decision to all duplicated components (if any) and suppress the further notifications. "n" in parentheses denotes the number of not handled components in the file.

Import Scripts

The scripts specified in the file folder scripts are to be imported to the FIXICC H2 DB as follows:

All the scripts' names are to be checked against the names of existing ones.

In case the names appear the same, the scripts are considered duplicates and the confirmation dialog appears:

You may decide to replace the existing script and click the button "Replace". In this case, the existing script will be overwritten with the new one.

The second possibility is clicking on the button "Import as a copy". In this case, the duplicated script is saved under the name copy of <script_name> in FIXICC H2 DB.

If you decide to skip the script and click the button "Skip", the existing script remains unchanged and the new script will be ignored.

You also have an option "Apply to all scripts (n)" allowing you to apply your decision to all duplicated scripts (if any) and suppress the further notifications. "n" in parentheses denotes the number of not handled scripts in the folder.

Import Schedules

The schedules specified in the file schedules.json of the folder schedules are to be imported to the FIXICC H2 DB as follows:

All the schedules' names are to be checked against the names of existing ones.

In case the names appear the same, the duplicated schedule is saved under the name copy of <schedule_name> in FIXICC H2 DB.

Migrate BL Configuration

To migrate the configuration, click on the "Migrate Server Configuration" menu item.

In case the FIXICC H2 already has the configuration for this server, the warning message appears:

You can cancel the migration by clicking the button "Cancel" or proceed by clicking the button "Yes".

The dialog "Upload the file" appears.

You can drag the appropriate ZIP file and drop it in the specified area, or click on the button "Upload" to open the system dialog "Open".

Migrate Legacy FIX Sessions

FIXICC H2 imports the legacy sessions specified in the FIXEdge.properties file.

As the FIXEdge.properties file contains registered FIX session properties and the default session properties, the FIX session properties are merged with default session properties before importing: the default property is used when the registered session does not have it.

The sessions specified in the file FIXEdge.properties are to be imported to the FIXICC H2 DB as follows:

Check for SenderCompID and TargetCompID

All the sessions are to be checked against the existing sessions in terms of SenderCompID and TargetCompID combination.

The session qualifier (if any) is ignored during the check.

In case these combinations are the same, the sessions are considered duplicates and the confirmation dialog appears:

You may decide to replace the existing session and click the button "Replace". In this case, the properties of the existing session will be overwritten with values from the new session.

If you decide to skip the session and click the button "Skip", then the existing session remains unchanged and the new session will be ignored.

You also have an option "Apply to all sessions (n)" allowing you to apply your decision to all duplicated sessions (if any) and suppress the further notifications. "n" in parentheses denotes the number of not handled sessions in the file.

Check for Session Name

In case the FIX session with the same name is on the server, the duplicated FIX session is saved under the name copy of <session_name> in FIXICC H2 DB.

Other existing sessions on the server remain unchanged

In case the FIXEdge.properties file within the ZIP file is invalid:

  • The error message appears: "Can not read file <file_name>";
  • None of the new sessions are imported;
  • None of the existing sessions are changed.

Migrate Legacy Business Layer Configuration

FIXICC H2 imports the legacy FE BL configuration specified in the BL_Config.xml file.

In case the BL component with the <component_name> name already exists, then the duplicated component is saved under the name copy of <component_name> in FIXICC H2 DB.

Although, the BL components in the BL_Config.xml file can have no name attributes. The unnamed BL components will be saved in FIXICC H2 DB under the generated names in <component_type>-UUID format (Generated name example: Rule-0d5de170-8a75-11ec-a8a3-0242ac120002).

If a BL component has an inline script, the BL component is saved in DB as is (with the inline script)

Migrate Legacy Scripts 

The BL_Config.XML file may contain the scripts section with built-in scripts that will be imported as well as the scripts in the folder scripts.

All the scripts' names are to be checked against the names of existing ones.

In case the names appear the same, the scripts are considered duplicates and the confirmation dialog appears:

You may decide to replace the existing script and click the button "Replace". In this case, the existing script will be overwritten with the new one.

The second possibility is clicking on the button "Import as a copy". In this case, the duplicated script is saved under the name copy of <script_name> in FIXICC H2 DB.

If you decide to skip the script and click the button "Skip", the existing script remains unchanged and the new script will be ignored.

You also have an option "Apply to all scripts (n)" allowing you to apply your decision to all duplicated scripts (if any) and suppress the further notifications. "n" in parentheses denotes the number of not handled scripts in the folder.

Migrate Legacy Schedules

The FIXEdge.properties file may contain the server schedules that will be imported as well as the schedules in the file schedules.json.

All the scripts' names are to be checked against the names of existing ones.

In case the names appear the same, the scripts are considered duplicates and the confirmation dialog appears:

You may decide to replace the existing script and click the button "Replace". In this case, the existing script will be overwritten with the new one.

The second possibility is clicking on the button "Import as a copy". In this case, the duplicated script is saved under the name copy of <script_name> in FIXICC H2 DB.

If you decide to skip the script and click the button "Skip", the existing script remains unchanged and the new script will be ignored.

You also have an option "Apply to all scripts (n)" allowing you to apply your decision to all duplicated scripts (if any) and suppress the further notifications. "n" in parentheses denotes the number of not handled scripts in the folder.