Metric Studio: Object Link Stage File (.cml)

The object link stage file (.cml) imports links or relationships between Metric Studio objects, such as between



  • a metric and a scorecard other than its home scorecard



  • a document URL and a metric, metric type, or scorecard



  • a metric or metric type and a strategy element



  • a metric and another metric, to define the impact of one metric on the other or to create derived metrics



  • a diagram and a metric, metric type, or scorecard



Use this file to set up your scorecarding environment. You can have more than one .cml file, such as one for mapping strategy elements and one for links.

Unlike previous versions of Metric Studio, you no longer use the object link stage file to assign permissions to view or edit an object. For information about transforming permissions in the object link stage file to the stage policy file (.cms), see the Installation and Configuration Guide.

You can also create links manually.

The object link stage file loads the object_link_stage table. The columns in the object link stage file are as follows.






































































































No. Column Description
1 object_id

The unique identifier for the object.

Must be the same as object_id in the .cmo file.

Maximum length: 255

2 object_type_cd

The code indicating the type of object.

Values: KPI (metric), KPICL (metric type), SC (scorecard), URL (report), GRP (strategy element), DGM (diagram), PRO (project)

Maximum length: 50

Required

3 kpi_indicator_type_id

The metric type identifier for the first metric.

This is the identifier that was staged for the metric type in the .cmm file or metric_type_stage table, or that was entered in the user interface.

4 kpi_home_sc_id

The home scorecard identifier of the first metric.

This is the identifier that was staged for the scorecard in the .cmo file or object_stage table, or that was entered in the user interface.

5 kpi_qualifier_id

The unique identifier of the qualifier used to distinguish the first metric from other metrics of the same type on the same home scorecard.

This is the identifier that was staged for the qualifier in the .cmo file or object_stage table, or that was entered in the user interface.

6 linked_object_id

The unique identifier for the object to which you are linking.

Maximum length: 255

Required

7 linked_object_type_cd

The object type of the object to which you are linking.

Values: KPI (metric), KPICL (metric type), SC (scorecard), URL (report), GRP (strategy element), DGM (diagram), PRO (project)

Required

8 linked_kpi_indicator_type_id

The metric type identifier for the second metric.

This is the identifier that was staged for the metric type in the .cmm file or metric_type_stage table, or that was entered in the user interface.

9 linked_kpi_home_sc_id

The home scorecard identifier of the second metric.

This is the identifier that was staged for the scorecard in the .cmo file or object_stage table, or that was entered in the user interface.

10 linked_kpi_qualifier_id

The unique identifier of the qualifier used to distinguish the second metric from other metrics of the same type on the same home scorecard.

This is the identifier that was staged for the qualifier in the .cmo file or object_stage table, or that was entered in the user interface.

11 link_qualifier

When linking two metrics, the specification of the first metric as the one that drives or is driven by the second metric.

The linked_object_type_cd must be KPI.

Values: DRIVES, DRIVEN_BY

These values are not case sensitive.

12 weight

The number representing the weighting of the link used when defining derived metrics.

Corresponds to the weight shown for a derived index.

Applies only to metric to metric links.

13 include_in_calc

For a derived index, the flag indicating whether to include this link as part of the calculation.

Values: Y (Yes), N (No: usually used when you link two metrics in a diagram)

Applies to metric-to-metric links.

14 include_descendants

The flag indicating whether descendants of this object should be linked.

Values: Y (Yes), N (No)

15 sort_order

A number indicating the ordering of the link in relation to other links to the same object.

This number controls the order in which metrics appear in the scorecard list.

Metrics in a scorecard cannot be sorted on user-defined columns.

Tip: To control the order in which metrics appear in the metrics types list, use the default_sort_order column in the .cmo file.

16 language_cd

The two-character identification code for the language of the data you are importing.

Values: EN (English), FR (French), JA (Japanese), and so on

Links are language independent, but some link types are identified using language dependent strings, such as a strategy name or a permission level.

If you are not using English, ensure that the string you are using matches the language code.

Default: EN (English)

17 delete_flag

The flag indicating whether the link is to be deleted.

Values: Y (Yes), N (No)

Default: N

18 created_dt

The date the link was created.

Format: yyyy-mm-dd hh:mm:ss (24-hour clock)

(hh:mm:ss values are optional)

Required


Source: Metric Studio User Guide 8.4.1

www.cogknowhow.com