GOAL CODES
- Pedro Jose Sanchez Luling
- Josep Benavent
The GOAL CODES define literals that are used when generating the evolution graph of a DATACODE for which some goals have been set.
This CODES are used by API function case_evolution_graph()
For example, we could want to draw the evolution of the DATACODE "STEPS", which represents the amount of steps walked by a CASE in a certain period. Additionally there may exists some goals that the CASE should have achieved (goals can be set using GOAL_SET () formula or goal_set (session, data_code, level, ref, type {, date} {, value}) API function).
When the graph is displayed, the steps walked in certain period may have reached the proposed goal, while other may be under the goal. Then the graph generated will include a legend with the corresponding literal to indicate which series are over and under the goal. The literals to generate the legend are retrieve from the GOAL CODES:
| Property | Value | Comments |
|---|---|---|
| #CODE:ID_STANDARD_CODE | "#EVOLUTION" | Constant value to identify CODE CATEGORY codes |
| #CODE:ID_CODE | The name of a DATA_CODE (e.g. "GOAL.NOT_REACHED") | |
| #CODE:ID_LANGUAGE | "ES"|"EN"|"CA"|"ZH" | Available languages. |
| #CODE:CODE_DESCRIPTION | Description of the CODE in the selected language. For example, the description for "GOAL.REACHED" could be "Reached" |
AVAILABLE CODE LIST
The following is a list of all CODE DESCRIPTIONS stored in DB (only 'EN' are shown):
| ID_CODE | ID_LANGUAGE | CODE_DESCRIPTION |
|---|---|---|
| GOAL.REACHED | EN | Reached |
| GOAL.FAILED | EN | Failed |
| GOAL.MIN | EN | Min. goal |
| GOAL.MAX | EN | Max. goal |