Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt

Use this file to discover all available pages before exploring further.

This object contains the Limit Structures. This table branches off the Limits store, which contains individual Limits per Limit Structure. Table name: LimitStructures
ColumnKeyTypeDescription
GroupYstringName of a group of limit structure. Group is a way of grouping similar limit structures together.
Structure IDstringUnique identifier of this limit structure.
NameYstringThe KPI name to be created in the Business Cube.
CommentstringA description of the limit structure.
Polling FrequencystringHow often to evaluate the limit structure. Can be End Of Day, Intraday, Daily, etc. See Alert Tasks for more info.
KPI TypestringType of KPI to be created. (Greater Than, Less Than).
Absolute Value IndicatorbooleanSpecifies whether to use the absolute value of the underlying measure. For example, when enabled, a Greater Than limit on 10 will fail when a measures value is -11.
Warning Thresholdinteger(Optional) The minimum utilization percentage of a limit goal to trigger a warning.
Measure NameYstringName of the underlying Measure or Calculated Measure in the Business Cube.
Scope Keysinteger arrayThe ids of the scope keys used by limits in this limit structure, which are available in the scope keys store.
Limit Changes WorkflowstringType of workflow to use for changes to the limit structure’s limits.
Limit Changes Workflow ParametersstringParameters of the workflow. Specifies the roles that can approve the workflow.
Exception WorkflowstringType of workflow to use for handling breaches and warnings.
Utilization Dashboard IDstringThe ID of a utilization dashboard that may exist for the limit structure. The ID maps to a dashboard ID in the content server.
Cube NameYstringName of the Cube the limit structure is on.
Server NameYstringName of the Server the limit structure is on.
System StatestringOptional field to note the state of the limit structure in the upstream system.
TimestamptimestampThe time the limit structure was created.
Exception StatusstringInformation on whether a limit structure was breached.