Navigation :

Limits Definition

This object contains the Limit Definitions. This table is the Base Table that all other tables are referenced from.

Table name: LimitDefinition

Column	Key	Type	Description
Group		string	Name of a group of limits. Group is a way of grouping similar limits together.
ID		string	Identifier for this limit. A secondary way to group limits together or track a limit from an upstream system.
Name	Y	string	The KPI name to be created in the business cube.
Comment		string	A description about the limit definition.
Start Date	Y	date	Date the limit is valid from.
End Date	Y	date	Date when the limit expires. No value means a limit is valid indefinitely.
Frequency Type	Y	string	OFFICIAL or TEMPORARY tag on this limit.
Polling Frequency	Y	string	How often to evaluate the limit. Can be End Of Day, Intraday, Daily, etc. See Alert Tasks for more info.
KPI Type		string	Type of KPI to be created. (Greater Than, Less Than).
Limit Values		list of double	Goal of the limit breach value(s). If a Greater Than or Less Than limit than there will only be one value.
Absolute Value Indicator		boolean	If we want to use the absolute value of the underlying measure. So a Greater Than limit on 10 will fail when a measures value is -11.
Warning Threshold		integer	(Optional) % Within limit goal to trigger a Warning workflow.
Measure Name		string	Name of the underlying Measure or Calculated Measure in the Business Cube.
Scope	Y	int	Location in the Business Cube to apply this limit. See Limit Scopes section for details.
Precedence		string	Precedence of a limit to be applied to a Location. If two limits apply to a location in the Cube, then the Precedence can help to enforce which limit will take effect.
Limit Status		string	The status of the limit that is in use. note A Pending Workflow does not affect this field until the Pending Workflow is Approved.
Exception Status		string	Information on whether a limit was breached.
Exception Category		string	Reason for the limit breach. Predefined list of reasons is set in the UI settings file: LimitsSettings.ts. Value is set in the Exception Tab of a limit. See the Exception Status field in the Dimensions section for more.
Exception Comment		string	Comment attached to an Exception Workflow.
Limit Changes Workflow		string	Type of workflow to use for changes to the limit. Similar to the Warning Workflow and Breach Workflow fields.
Limit Changes Workflow Parameters		string	Parameters of the workflow. Specifies the roles that can approve the workflow.
Exception Workflow		string	Type of workflow to use for handling Breaches and Warnings.
User ID		string	ID or name of the user who created the limit.
Cube Name	Y	string	Name of the Cube the limit is on.
Server Name	Y	string	Name of the Server the limit is on.
System State		string	Optional field to attach to a limit.
Timestamp		timestamp	When the limit was created.
limitKey	Y	int	Unique identifier of this limit. This value is the Hash Value of all other Key fields.
Pending Limit Definition		list of object	The modified Limit Definition in the workflow. For example, when performing an edit, the changes are stored here.
Pending Status		string	Status of the pending workflow. Once the pending workflow is approved, the limit will take on the values of the Pending Limit Definition.