Meta tags:
description= Get started with the ICE Equities Analytics;
author= KX Systems, Inc., a subsidiary of KX Software Limited;
Headings (most frequently used words):
the, analytics, order, data, quickstart, guide, pipeline, packages, deploy, exchange, ice, equities, accelerator, prerequisites, additional, configuration, download, install, database, pipelines, access, apis, run, generation, to, persist, view, summary, of, reference, session, open, conditions, composite, mapping, next, steps, nightly, schedules, ingest, fxrates, market,
Text of the page (most frequently used words):
the (107), ice (45), data (34), analytics (33), env (31), order (31), pipeline (28), fsi (28), #equities (24), #deploy (21), and (18), for (17), kxi (17), quickstart (15), bloomberg (15), with (14), this (14), ingest (13), you (13), eqea (13), aws_access_key_id (13), aws_secret_access_key (13), aws_session_token (13), generation (13), packages (13), pipelines (12), exchange (12), guide (12), are (11), app (11), accelerators (11), market (10), overview (10), run (10), reference (9), accelerator (9), configuration (9), summary (9), api (9), kdb (8), apis (8), download (8), release (8), notes (8), onetick (8), set (7), custom (7), my_s3_region (7), bucket (7), following (7), use (7), fxrates (7), install (7), insights (7), eqeacompositeticker (6), fsi_filepath (6), fsi_region (6), composite (6), eqeaexchopen (6), session (6), open (6), conditions (6), required (6), eqeaexchange (6), refdata (6), using (6), database (6), iceeqhistoricreplay (6), eqeafxrates (6), eqeaorderingest (6), export (6), bearer (6), consolidated (6), next (5), nightly (5), file (5), csv (5), command (5), can (5), access (5), your (5), configure (5), lib (5), get (5), started (5), bpipe (5), all (4), refer (4), documentation (4), details (4), setting (4), once (4), steps (4), mapping (4), calculate (4), time (4), additional (4), equity (4), execution (4), table (4), view (4), query (4), functions (4), persist (4), below (4), accelver (4), fsilibver (4), portal (4), library (4), prerequisites (4), screener (4), more (3), that (3), schedules (3), which (3), default (3), orders (3), follows (3), value (3), analytic (3), dashboards (3), dashboard (3), example (3), rollup (3), orderanalytics (3), ingested (3), ingestion (3), values (3), adjustment (3), deploying (3), enterprise (3), page (3), fixed (3), income (3), book (3), releases (3), examples (3), glossary (3), how (3), made (2), systems (2), inc (2), previous (2), occurring (2), schedule (2), feature (2), also (2), boolean (2), turned (2), tickers (2), used (2), then (2), map (2), not (2), arrivalbenchmarkprice (2), strike (2), into (2), metrics (2), from (2), analysis (2), been (2), eqeagentca (2), date (2), instance (2), corresponding (2), have (2), tables (2), getticks (2), historical (2), single (2), usd (2), target (2), normalization (2), before (2), stream (2), processor (2), point (2), gui (2), k9s (2), core (2), push (2), curl (2), fail (2), body (2), dev (2), stderr (2), oauth2 (2), https (2), com (2), assets (2), raw (2), downloads (2), installation (2), tools (2), installed (2), user (2), volume (2), prep (2), customize (2), getbars (2), getstats (2), daily (2), content (2), historic (2), feed (2), setup (2), window (2), factor (2), settings (2), prevailing (2), developer (2), test (2), add (2), results (2), other (2), than (2), bar (2), home (2), material, mkdocs, insiders, 2026, rights, reserved, registered, trademarks, subsidiary, software, limited, back, top, scheduling, happy, step, consume, followed, generates, maptocompositeticker, requires, enabled, overlay, compositetickermap, being, but, local, must, ticker, exchangesessionopenconditions, present, matches, arrivalmid, well, section, exchangehours, normalizing, full, log, investigate, named, serves, rendering, some, calculations, call, aggregations, there, two, ways, has, written, these, rollups, power, 2000, working, persists, persistence, deployed, preview, getdata, replay_123_20251001, txt, provided, containing, both, trades, quotes, parses, ingests, populating, trade, quote, period, covers, foundation, given, when, don, activate, without, calculation, zone, however, omitted, false, true, fsi_eqea_tznorm, first, chosen, insert_aws_s3_region, insert_aws_access_key_id, insert_aws_secret_access_key, insert_aws_session_token, environment, variables, listed, ensure, authenticate, aws, should, able, see, daps, booting, info, begin, version, shown, helps, simplify, commands, warning, viewing, running, accessing, installing, downloading, vscode, plugins, jupyter, helm, logged, nexus, kubernetes, kubectl, cli, nix, line, token, charts, represented, credentials, obtained, configured, users, client, assumes, pre, requisites, intended, comprehensive, information, regarding, provides, package, comes, ready, views, schemas, out, box, comp, pipe, utility, extending, cancellations, corrections, errors, generateorderanalytics, getorderanalyticsummary, deployment, realtime, entitlements, filter, emrs, manual, about, combined, initializing, search, skip,
Text of the page (random words):
ice equities analytics quickstart accelerators skip to content accelerators ice equities analytics quickstart initializing search home get started accelerators how to apis examples releases accelerators home get started get started get started with accelerators prerequisites ice combined accelerator fsi accelerators overview fsi library overview accelerators accelerators about ice order book ice order book ice ob overview ice ob quickstart configure ice ob ice ingestion ice fixed income screener ice fixed income screener ice fi screener overview ice fi quickstart configure ice fi screener ice fi data ingestion ice fi historic data set up daily bar generation set up manual bar generation ice equities analytics ice equities analytics ice equities overview ice equities quickstart ice equities quickstart on this page prerequisites quickstart guide download the packages install the packages deploy the database deploy the pipelines order ingest fxrates market data access apis run the generation pipeline to persist the order analytics view summary of order analytics additional pipeline configuration exchange reference data exchange session open conditions data composite mapping next steps nightly schedules ingest market data order ingest pipeline results generation use a table other than order add custom analytics test custom analytics custom analytics developer guide configure using prevailing values order execution analytics configuration settings equities order analytic functions glossary query window adjustment factor bloomberg equities analytics bloomberg equities analytics bloomberg equities overview bloomberg equities quickstart ingest bloomberg market data order ingest pipeline use a table other than order results generation add custom analytics test custom analytics custom analytics developer guide configure using prevailing values order execution analytics configuration settings equities order analytic functions glossary query window adjustment factor bloomberg bpipe bloomberg bpipe bloomberg bpipe overview bloomberg bpipe quickstart bloomberg bpipe feed install and setup bloomberg emrs feed install and setup bloomberg to insights enterprise user map bloomberg entitlements filter onetick us consolidated equities onetick us consolidated equities onetick us consolidated equities quickstart onetick us consolidated equities realtime pipeline onetick us consolidated equities historic pipeline onetick us consolidated equities data volume prep how to how to deployment and content configuration configuration in the fsi library use the accelerators set up daily pipeline execution apis apis api overview getticks getstats getbars getorderanalyticsummary generateorderanalytics customize getstats customize data for use with getbars api configuration api errors glossary examples examples cancellations and corrections extending accelerator apis utility functions releases releases overview ice order book release notes ice fixed income release notes ice equity analytics release notes bloomberg equity analytics release notes bloomberg b pipe release notes onetick volume prep release notes onetick us comp release notes fsi library release notes on this page prerequisites quickstart guide download the packages install the packages deploy the database deploy the pipelines order ingest fxrates market data access apis run the generation pipeline to persist the order analytics view summary of order analytics additional pipeline configuration exchange reference data exchange session open conditions data composite mapping next steps nightly schedules ice equities analytics accelerator quickstart guide this page provides a quickstart guide for the ice equities analytics accelerator the ice equities analytics is an fsi accelerator package that comes with ready made pipelines views and schemas out of the box prerequisites this quickstart guide is not intended to be a comprehensive kdb insights install guide for more information regarding kdb insights installation refer to the kdb insights enterprise documentation this guide assumes the following pre requisites kdb insights enterprise is installed and the following credentials have been obtained and configured for insights users gui user api client a kx downloads portal bearer token to download packages charts represented by bearer in this guide tools used access to nix command line kdb insights cli kxi kubernetes tools kubectl k9s helm installed and logged in to nexus vscode plugins kx kdb jupyter quickstart guide this guide details the following steps to get you started with the ice equity analytics accelerator downloading the packages installing the packages deploying the database deploying the pipelines accessing the apis running the generation pipeline to persist the order analytics viewing a summary of the order analytics warning before you begin set your accelerator and fsi lib version as shown below this helps simplify the download and installation commands export accelver 1 5 2 export fsilibver 1 3 7 download the packages download the required fsi packages from the kx downloads portal download fsi lib the core fsi library curl s fail with body d dev stderr oauth2 bearer bearer l oj https portal dl kx com assets raw kxi accelerators fsi fsi lib packages fsilibver fsi lib fsilibver kxi download fsi app ice eqea the ice equities analysis accelerator curl s fail with body d dev stderr oauth2 bearer bearer l oj https portal dl kx com assets raw kxi accelerators fsi fsi ice eqea packages accelver fsi app ice eqea accelver kxi install the packages run the command below to install the fsi packages kxi pm push fsi lib fsilibver kxi kxi pm push fsi app ice eqea accelver kxi deploy the database run the command below to deploy the database kxi pm deploy fsi app ice eqea db fsi core db info at this point you should be able to see the data access point daps booting up on the gui or on k9s deploy the pipelines before deploying the stream processor sp pipelines configure the environment variables listed below to ensure your sp can authenticate with your aws s3 bucket refer to stream processor documentation for more details export my_s3_region insert_aws_s3_region export aws_access_key_id insert_aws_access_key_id export aws_secret_access_key insert_aws_secret_access_key export aws_session_token insert_aws_session_token the deploy the pipelines for order ingest fxrates market data order ingest first deploy the order ingest pipeline with your chosen configuration if you are using normalization the setting is turned on by setting the fsi_eqea_tznorm boolean as true however in this example it is set as false which is the default so it can be omitted when you don t activate normalization your orders are ingested as default without a strike time calculation or time zone adjustment to deploy the pipeline with the target file given run the following kxi pm deploy fsi app ice eqea pipeline eqeaorderingest env eqeaorderingest fsi_filepath s3 my bucket orders csv env eqeaorderingest fsi_region my_s3_region env eqeaorderingest aws_access_key_id aws_access_key_id env eqeaorderingest aws_secret_access_key aws_secret_access_key env eqeaorderingest aws_session_token aws_session_token fxrates if you are using fxrates to calculate values in usd deploy the pipeline with the target file as follows kxi pm deploy fsi app ice eqea pipeline eqeafxrates env eqeafxrates fsi_filepath s3 my bucket fxrates csv env eqeafxrates fsi_region my_s3_region env eqeafxrates aws_access_key_id aws_access_key_id env eqeafxrates aws_secret_access_key aws_secret_access_key env eqeafxrates aws_session_token aws_session_token fxrates are required to calculate the value in usd which is the foundation of the dashboard metrics market data market data for the time period the order covers is required ice historical data is provided as a single file containing both trades and quotes a single pipeline parses and ingests this file populating the trade and quote tables deploy the ice market data ingestion pipeline with the corresponding ice historical data kxi pm deploy fsi app ice eqea pipeline iceeqhistoricreplay env iceeqhistoricreplay fsi_filepath s3 my bucket replay_123_20251001 txt gz env iceeqhistoricreplay fsi_region my_s3_region env iceeqhistoricreplay aws_access_key_id aws_access_key_id env iceeqhistoricreplay aws_secret_access_key aws_secret_access_key env iceeqhistoricreplay aws_session_token aws_session_token access apis once you have deployed all the pipelines and ingested the data you can query the tables using the getdata or getticks then use the generation api to preview the order analytics run the generation pipeline to persist the order analytics once the data is ingested and the api for generation is working you can run an instance of the nightly generation pipeline that persists the order analytics for details refer to the documentation for generation and persistence of orderanalytics to run an instance of the generation pipeline deploy the pipeline with the corresponding date as follows kxi pm deploy fsi app ice eqea pipeline eqeagentca env eqeagentca date 2000 01 01 view summary of order analytics once orderanalytics has been written into the database you can query the table and use the summary rollup functions these summary rollups power the example dashboards there are two ways to view a summary of order analytics api call the summary api on the orderanalytics table for rollup aggregations using the api dashboards log into the dashboards to investigate order analytics the dashboard is named equity execution analysis the dashboard serves as an example of rendering some metrics from the summary rollup calculations additional pipeline configuration to use the full feature set of the accelerator the following additional reference pipelines are also required exchange reference data exchange session open conditions data composite mapping exchange reference data if you are normalizing order data exchange reference data is required to calculate strike time for this run the following command kxi pm deploy fsi app ice eqea pipeline eqeaexchange refdata env eqeaexchange refdata fsi_filepath s3 my bucket exchangehours csv env eqeaexchange refdata fsi_region my_s3_region env eqeaexchange refdata aws_access_key_id aws_access_key_id env eqeaexchange refdata aws_secret_access_key aws_secret_access_key env eqeaexchange refdata aws_session_token aws_session_token exchange session open conditions data to calculate the arrivalbenchmarkprice order analytic reference data for exchange session open conditions is required as well as the exchange reference data in the previous section if this reference data is not present the arrivalbenchmarkprice value matches the arrivalmid value to ingest exchange session open conditions data run the following command kxi pm deploy fsi app ice eqea pipeline eqeaexchopen env eqeaexchopen fsi_filepath s3 my bucket exchangesessionopenconditions csv env eqeaexchopen fsi_region my_s3_region env eqeaexchopen aws_access_key_id aws_access_key_id env eqeaexchopen aws_secret_access_key aws_secret_access_key env eqeaexchopen aws_session_token aws_session_token composite mapping if composite tickers are being used for market data but orders are for local tickers then you must ingest a composite ticker map as follows kxi pm deploy fsi app ice eqea pipeline eqeacompositeticker env eqeacompositeticker fsi_filepath s3 my bucket compositetickermap csv env eqeacompositeticker fsi_region my_s3_region env eqeacompositeticker aws_access_key_id aws_access_key_id env eqeacompositeticker aws_secret_access_key aws_secret_access_key env eqeacompositeticker aws_session_token aws_session_token this feature also requires a boolean setting turned on which is enabled by default in a custom file in an overlay eqea maptocompositeticker 1b next steps nightly schedules once you are happy with all the pipelines the next step is to set up a re occurring schedule of ingest pipelines to consume all data nightly followed by a pipeline that generates the analytics refer to the scheduling pipelines documentation for more details on setting up a re occurring schedule back to top previous ice equities overview next ingest market data 2026 kx systems inc all rights reserved kx kdb x and kdb are registered trademarks of kx systems inc a subsidiary of kx software limited made with material for mkdocs insiders
|