How to Generate ICE Equities Analytics from Any Table

This page explains how to generate equity analytics from a table other than the default Order table using the .fsi.eqea.generateOrderAnalytics API and related pipelines.

Using a table other than order

It is possible to generate equity analytics from a table other than the Order table.

When generating analytics using the .fsi.eqea.generateOrderAnalytics API, specifying a different table name than Order as the table value in the argument dictionary, allows you to use order data from that table instead.

To ensure this works correctly, several configuration steps are required:

  • Define new schema. Add two schema definitions for the API to use. These must be equivalents of the Order and OrderAnalytics schema. The new schema must have the same column names and types as the existing `Order` and `OrderAnalytics` schema. They should also follow the same naming convention, that is <tableName> and <tableName>Analytics.

  • Ingest order data to the new table. By default, the eqeaorderingest pipeline ingests data into the Order table. However, it can be configured to ingest data into any table by setting the ORDERTABLE environment variable while deploying the pipeline. An example deployment command using this environment variable would be:

    Shell

    Copy 
    kxi pm deploy fsi-app-ice-eqea 1.0.0 --pipeline eqeaorderingest --env eqeaorderingest:FSI_REGION='us-east-2' --env eqeaorderingest:FSI_FILEPATH=':s3://pathToFile/orders.csv' --env eqeaorderingest:ORDERTABLE='StitchedOrder' --env eqeaorderingest:FSI_EQEA_TZNORM='false'

    Adjust this command as needed for your environment.

Persisting generated analytics

When persisting equity analytics using the eqeagentca pipeline, the default configuration uses the orders from the Order table and persists the results in the OrderAnalytics table.

You can override these defaults to use the alternate table defined in the previous section. The pipeline will then read from that table and persist analytics to the corresponding <tableName>Analytics table.

An example deployment command to achieve this would be:

 

Copy 
kxi pm deploy fsi-app-ice-eqea 1.0.0 --pipeline eqeagentca --env eqeagentca:DATE='2024.07.17' --env eqeagentca:ORDERTABLE='StitchedOrder'

Modify the command to suit your specific environment.