FIXYL - A tool for testing and verifying software that uses the FIX protocol
FIXYL
FIXYL is a tool for testing and verifying software that uses the FIX protocol. It allows establishing FIX sessions, and exchanging (and manipulating) FIX messages.
This tool provides support for all standard and custom FIX dictionaries across version 4 and 5 variants of the FIX protocol. It features a wide variety of options to support the testing and debugging of FIX gateways.
This tool is created using React and is based on Electron, and supports cross-platform builds.
Installation
Installing from binaries
Pre-built binaries can be downloaded from the Releases Page. Make sure to use the installer for that match your operating system.
Building from source
Building from source requires NodeJS 12 or higher. Note that this step can be initiated from all major operating systems (Linux, Windows, MacOS) and produces an installer for that operating system.
For production:
npm install
npm run build
Once the build is complete, the installer can be found inside the dist directory.
For development:
npm install
npm run start
This launches a React development server on localhost:3000, and starts an Electron application instance pointing to it. Make sure that port 3000 is not already occupied by some other program.
Usage
First start-up
Once you start the application for the first time, it will ask for a working directory to store configuration files. Set this to a valid directory.
This directory is used for storing user configuration such as profiles and favorites. Deleting this directory manually would remove such configuration and would cause the application to prompt for a working directory the next time it is launched.
Adding a new profile
A profile contains all the information required for creating a new FIX session. You may open the profile creation form by clicking on Profile menu item and clicking + button on the top of the opened panel.
Once this form is opened you should enter the following information of the target FIX server.
| Field | Description |
|---|---|
| Name | Name of the profile |
| IP Address | IP address of the targetserver |
| Port | Port address of the target server |
| HB Interval | Heartbeat interval for the session |
| SenderCompId | Username to use for the login and sender identification |
| Password | Password of the above user to use for login |
| TargetCompId | Target system/firm identification |
| Dictionary Location | Location of the FIX dictionary definition XML file |
Pressing Save will create a new profile with the entered information.
The profile information will be saved in a configuration file inside the working directory set for the application.
Starting a FIX session
Open the Profile menu and click the connet button of the profile that you’ve previously created. This will open a TCP connection to the FIX server mentioned in the profile, A new tab will be opened in main window for the established session.
If the connection is successfull, the connection indicator will go green and the state will be presented as CONNECTED.
FIX Session Management
Each FIX session tab consists of the following 3 sections.
- Session management
- Message streams
- Message preview
Session Management
This section provides an overview of the session and tools required to interact with the active session. The following tabs are available in this section.
| Section | Description | Screenshot |
|---|---|---|
| General | Provides basic information on the FIX session, such as connection details and the status. It also provides the functionality to connect and disconnect the session. |
|
| New Message | Use this to send a new message through your FIX session. A message definition can be found using the dropdown menu (which also supports auto complete). Selecting a messsage definition will prompt a form to fill relevant fields before sending the message. You can also add the message you’ve configured to your favorites for later use. Refer FIX Message Form for more information. | |
| Raw Data | This is another way of sending a message. If you have a raw FIX message with printable field separators, use this tab to send it. | |
| Favorites | All the favorites that you’ve saved previously are listed here. You can select a saved favorite message and send it. | |
| Scenarios | [EXPERIMATAL] This section gives the users the ability to add automated testing for a message flow to cover a scenario. Refer Scenario Configuration section for more information. |
Message Stream
This section shows all incoming and outgoing messages of the session. You can filter by Heartbeat , In-coming and Out-going messages.
You can select a message to get a preview of it. You can also select two messages (by selecting while pressing Ctrl) and click View Diff to compare the selected two messages in the message stream.
Message Perview
This section visualizes a message selected in the message stream.
Each message is shown in two formats.
- Decoded format where fields are shown in a tabular manner.
- Raw format where raw data of the message is shown. Raw data of the message can be copied by clicking on this section.
FIX Message Form
This form is used for editing messages before being sent on the session, and can also be used for adding a configured message to the list of favorites for later use.
Following are some noteworthy features of this form.
- If you press
Ctrl + Fyou’ll get a search panel for searching through message fields. - The form also supports auto-generated fields. In order to use this, set the value of the field to
{auto-gen}. Currently auto generation of values are only supported on FIX fields of typestring,char,int,float,utctimestamp,monthyear,utcdateonly, andutctimeonlyonly. For example, if a date/time field is set to auto generate, the field value would be auto populated with the date always being set to the current date.
Scenario Configuration
This section give the user the abiity to configure test scenarios. A scenario can have multiple stages and each stage has an input and an output. Both input and output can have mutiple messages and each can be selected either from your favorites or manually.
Execution is done stage by stage and the application will send each message in the input list and check the received messages against the ones mentioned in the output list. Each output message should have field values that you need to check when the actual message is received. You can ignore field from this validation by not having them in the output messages.
Another feature of this is that you can capture field values from the output message and use it in an input message. In above screenshot, the order stage contains an input message for submitting a new order and the output message as the execution report that can be recieved if the order submittion is successful.
The values recieved from the execution report can be captured using {get: <unique name>} tag.
The captured values are used in the next stage of this example by using {set: <unique name>}, to send an order cancellation request.
IMPORTANT: This is an experimental feature and may have issues at present.
License
Contribution
You may contribute to this project in any of the following manners.
- Use it in your work, and tell us about your experience. You can suggest changes, propose new features and report bugs.
- Better yet, fix bugs and implement features and submit your contribution as a pull request. We will review and merge. Note that all code contributed in this manner would be published under the same license terms as the main project.