Custom Index Generator¶
The Custom Index Generator worker creates a new custom index in the Everysk platform with user-supplied parameters. Save the result to the platform to reuse it across workflows, or keep it transient for use within the current run only.
Parameters¶
| Field | Description |
|---|---|
| Symbol | Short identifier for the custom index. Accepts Template Text or Upstream Data |
| Name | Display name of the custom index. Accepts Template Text or Upstream Data |
| Currency | Currency of the custom index. Accepts Fixed Value or Upstream Data |
| Periodicity | Frequency of index data. Accepts Fixed Value. Options: Daily, Weekly, Monthly |
| Data Type | How values are expressed. Accepts Fixed Value. Options: Price, Return (Decimal), Return (Percentual) |
| Base Price | Starting price for return-based data types. Accepts Fixed Number or Upstream Data |
| Tags | Labels for categorizing the index. Accepts Fixed Tags or Upstream Data |
| Data | Time series data for the index as a list of lists, passed from a previous worker. Accepts Upstream Data |
| Storage Mode | Whether to persist the index. Options: Transient (current run only), Create (saved to platform) |
| Projection | Which attributes to return in the result. Accepts Fixed Select. Default is Without Data |
| Enable Consistency Check By Link UID | Whether to enforce uniqueness by Link UID before saving. Accepts Boolean |
Result¶
Once the worker finishes successfully, it returns a result object containing the generated custom index.
- Custom Index (custom index)
- Symbol (string)
- Name (string)
- Currency (string)
- Periodicity (string)
- Data Type (string)
- Base Price (number)
- Tags (list)
- Data (list of lists)