Filter rules & condition code management¶
The Administration platform provides you with a wide range of options for managing the available filters and the unique condition codes that appear within these filters. This extends to adding, removing, and customizing filters, manually adding and removing unique condition codes, and allowing you to manage new unique condition codes detected within the feed.
Viewing the filter rules and configuration¶
The existing filter rules are divided into 2 tables, one for trade filter rules and one for quote filter rules. These are the first and second tabs on the Filter Rule and Condition Code Management dashboard.
By default, the table is grouped and collapsed by exchange. On the right-hand side of the exchange name is a count of how many condition codes are contained within that exchange. On the left-hand side is a "+" which, when clicked, may be used to expand and view the contents of that exchange.
To group a table by column, drag the column header to the row directly above the table. To ungroup the table, click the "x" next to the name of the column within this row.
How to edit filter rules¶
To edit existing filter rules, click the "Edit" option in the top-right of the table. Once you have selected this, clicking any cell within the table will allow you to change this cell.
-
To set a cell to true, select it and check the box.
-
To set a cell to false, select it and uncheck the box.
-
To save changes, click out of the most recently changed cell and then click Submit changes. Note: If the most recently changed cell is not clicked out of before Submit Changes is clicked, any change to that cell will not be saved.
-
To cancel any changes made click the Cancel Changes option.
Setting a cell within a filter to true for an exchange/condition code combination will cause the ticks with that exchange/condition code combination to be included when that filter is used.
Note
Only the Boolean filter columns may be edited here. Any attempts to edit the exch or cond columns is not allowed.
How to add a new filter rule¶
The option to add a new filter is available within the Manage Filter Rules tab.
Select the type of filter at the top of this tab. If neither trade nor quote is selected, then trade will be used by default.
The name of the new filter to be added should be entered in the text box within the Add Filter Rule widget. Clicking Add Filter will add a filter of this name to the chosen table. A message regarding whether or not this addition has been successful will be displayed within the log table at the bottom of the tab.
When adding a new filter, the name used must not contain any blank spaces, begin with a number or contain any special characters e.g. - + /! \| \# = \* & \^ % \< \> \$ : ; @ \~ ? ,.
An example of an invalid filter rule name is test\$filter as it contains a $ and as such will not be created.
An example of a valid filter rule name is testFilter as it doesn't conflict with any of the criteria mentioned above.
To customize this filter navigate to the Filter Rules Viewer tab and follow the procedure outlined in Edit Existing Filter Rules.
Note
A column will not be added if another of the same name already exists within the chosen table.
How to remove a new filter rule¶
The option to remove a filter is available within the Manage Filter Rules tab.
Select your table type at the top of this tab. If neither trade nor quote is selected, then trade will be used by default.
The filter to be removed should be selected from the dropdown of existing filters within the Remove Filter Rule widget. Clicking Remove Filter will remove the selected filter from the chosen table. A message regarding whether the removal has been successful will be displayed within the log table at the bottom of the tab.
Note
Removing a filter will permanently delete any customizations to that filter. Adding a filter of the same name will not re-create any customizations made to filters of the same name.
How to manually add a condition code¶
You can manually add condition code/exchange combinations within the Manage Filter Rules tab.
Select your table type at the top of this tab. If neither trade nor quote is selected, then trade will be used by default.
Within the Add Condition Code widget there are 2 text boxes, one for typing the name of the exchange and one for entering the condition code. There is also a multi-select dropdown containing available filter rules. All filter rules selected in this will be set to true for this new unique condition code. When these 3 items are complete, click Add Condition Code. A message regarding whether the addition has been successful will be displayed within the log table at the bottom of the tab.
How to manually remove a filter rule¶
You can manually remove condition code/exchange combinations within the Manage Filter Rules tab.
Select your table type at the top of this tab. If neither trade nor quote is selected, then trade will be used by default.
Within the Remove Condition code widget there are 2 dropdowns, one for exchange and one for condition code. When an exchange is selected, the contents of the condition code dropdown reloads to contain only condition codes that appear for that exchange, and vice versa.
When you have selected an exchange and a condition code, click Remove Condition Code. A message regarding whether the removal has been successful will be displayed within the log table at the bottom of the tab.
Detection of new condition codes¶
As new market data comes into Refinery, condition codes that have not come into the system before may appear.
The system checks when new condition codes appear in the market data feed so that an administration user can decide how they want to add these codes to the current filtering configuration. The condition codes are not added to the filtering configuration until they are acknowledged by a user.
In the Filter Rule Management dashboard there is a tab called New Condition Code Management:
The left panel is for new trade condition codes and the right panel is for new quote condition codes.
In order to add the condition codes to the filtering configuration, click Edit at the top-right of the necessary data grid.
Once in Edit mode, click the checkboxes to set the condition codes to true for particular filter rules in the same way that you edit filter rules. Once you have completed your changes, click Submit Changes.
Then select the rows that you have edited and click Acknowledge above the relevant table. This allows you to acknowledge condition codes that you don't want the change the configuration for.
