Core Concepts
Control
A Control is defined by its reference, each control has a unique reference.
Reference is a string (text) that is unique in the database, two controls cannot have the same reference. It is preferable to have a pattern of reference for instance REF_0001
In addition to the reference the control is defined by :
a name mandatory: a string that can be more complete and explicit than the reference. Name is mandatory, but you can use the same name as another control if needed.
a list of tags : Each tag is a string, a tag can be created by pressing Enter key. Tags will be helpful to create group of controls or to organize controls with custom criteria.
a description : A text that can contain the explicit description of the control
a formula mandatory: The formula of the control; it is the core of the control, formula are basically composed by two members :left and right, and separated by an operator. More detail on formula on the Control-Grammar section.
a reporting date : a date, it is the date at which the formula is evaluated. It is useful for some control that use datapoints that are not valid in the actual taxonomy.
a base mandatory: Base Left or Base Right. Let's say the formula is A < B. If Base Left the comparison will be (A-B)/A<0; if Base Right it will be (A-B)/B<0
a match type mandatory: Threshold or Exact. If Threshold the formula will be compared to threshold values; if Exact the formula is checking strict equality or inequality
a precondition : Formula that must be true in order to execute the control, the same rule as formula applies.
Control Plan
A control plan is defined by its name. Each control plan as a unique name.
Name is a string (text) that is unique in the database, two control plans cannot have the same name. It is preferable to have a pattern of name for instance Control_plan_0001
In addition to the name the control plan is defined by :
a list of tags : Each tag is a string, a tag can be created by pressing Enter key. Tags will be helpful to create group of control plans or to organize control plans with custom criteria. Tags are not shared between type of objects. Tags used for control plan are not the same used for control.
a description : A text that can contain the explicit description of the control plan
a list of Custom Control : Each control plan can have none, one or more controls, control can be used in more than one control plan. If the control is updated it will be modified, it will be modified for all control plan as it is just a link.
a list of EGDQ Control : Each control plan can have none, one or more EGDQ Controls, EGDQ Control can be used in more than one control plan.
Thresholds
A Threshold is defined by its name. Each threshold as a unique name.
Name is a string (text) that is unique in the database, two threshold cannot have the same name. It is preferable to have a pattern of name for instance threshold_type_successvalue_warningvalue : T_Relative_5_10
In addition to the name the threshold is defined by :
a type mandatory: Relative, Absolute or Both. Relative means that the formula will be compared to percentage. Absolute means that the formula will be compared to a number. Both means that the formula will be compared to both a percentage and a number, validity will prevail if both condition are true (false if just one of the two)
a success value mandatory: Value under which the control is considered to be successful. Please note that in Both Type of threshold, two success values are required.
a warning value mandatory: Value under which the control is considered to be pass with reserve. Please note that in Both Type of threshold, two warning values are required.
Indicators
An indicator is defined by its reference, each indicator has a unique reference.
Reference is a string (text) that is unique in the database, two indicators cannot have the same reference. It is preferable to have a pattern of reference for instance IND_0001
In addition to the reference the indicator is defined by :
a name mandatory: a string that can be more complete and explicit than the reference. Name is mandatory, but you can use the same name as another indicator if needed.
a list of tags : Each tag is a string, a tag can be created by pressing Enter key. Tags will be helpful to create group of indicators or to organize indicators with custom criteria.
a type : Ratio or Amount. Ratio will define that the indicator is a percentage whereas Amount will set it as a number
a description : A text that can contain the explicit description of the indicator
a formula mandatory: The formula of the indicator; it is the core of the indicator, contrary to control formula, the indicator's formula only contain one member and do not need any operator. More detail on formula on the Control-Grammar section.
a reporting date : a date, it is the date at which the formula is evaluated. It is useful for some indicator that use datapoints that are not valid in the actual taxonomy.
Dashboard
A Dashboard is defined by its name. Each dashboard as a unique name.
Name is a string (text) that is unique in the database, two dashboard cannot have the same name. It is preferable to have a pattern of name for instance Dashboard_0001
In addition to the name the dashboard is defined by :
a list of tags : Each tag is a string, a tag can be created by pressing Enter key. Tags will be helpful to create group of dashboard or to organize dashboard with custom criteria. Tags are not shared between type of objects. Tags used for dashboard are not the same used for control plan for instance.
a description : A text that can contain the explicit description of the dashboard
a list of Indicator : Each dashboard can have none, one or more indicators, indicator can be used in more than one dashboard. If the indicator is updated it will be modified, it will be modified for all dashboard as it is just a link.