Metric Studio: Object Stage File (.cmo)

The object stage file (.cmo) imports metrics, scorecards, documents, import sources, user-defined columns, strategies, and diagrams into the staging tables. Use this file to set up your scorecarding environment when this information is already stored in another system.

You can have more than one .cmo file, such as one for each import source or one for each object type.

The object_id column is required so that you can later modify the home scorecard or qualifier of the metric using the .cmo file.

After you create a diagram in the object stage file, you must then specify information about every object in the stage diagram file

Metric Studio versions 8.1 and later use qualifiers. If you are upgrading from Metric Studio version 2.2, Metric Studio creates qualifiers for existing metrics. If you create more than one metric of the same type on a scorecard, you must use a qualifier to distinguish them.

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




























































































































































































































































No. Column Description
1 object_id

The unique identifier for the object.

For a user, this is the IBM Cognos 8 name. The name appears in the Metric Studio user interface and is not case sensitive.

Maximum length: 255

Required

2 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

Default: The language of the user running the task.

3 object_type_cd

The code indicating the type of object (object_id).

Values: KPI (metric), SC (scorecard), URL (report), DS (import source), UDC (user-defined column), DGM (diagram), DGMT (caption), QUAL (qualifier), GRP (strategy element), GTYPE (strategy), STELM (strategy element), STRAT (strategy), STLVL (strategy level)

GRP (strategy element) and GTYPE (strategy) are used for importing files with all file formats except version 8.3.1 or later.

STELM (strategy element) and STRAT (strategy) are used for importing files with file format version 8.3.1 or later.

4 default_sort_order

A number indicating the ordering of the object in relation to other objects of the same type in the system. This is the default order and can be overridden by a user.

For example, the default_sort_order for metrics controls the order in which the metrics appear in the metric type list.

Tip: To control the order in which metrics appear in the scorecard list, use the sort_order column in the .cml file.

5 object_nm

The name of the object.

Maximum length: 255

Required but not for metrics

6 object_desc

The description of the object.

Maximum length: 1000

7 object_technical_desc

The technical description of the object.

Maximum length: 1000

8 url

(1) For an object_type_cd of URL, specifies the URL for that document.

You can add the URL using the .cml file.

Corresponds to the URL on the General tab of a report.

Required

(2) For an object_type_cd of KPI, specifies the URL for the custom report that appears on the Reports tab.

Optional

Maximum length: 2100

The URL is for backward compatibility with version 2.2. The URL object is imported through the .cmo file (object_type_cd URL). The URL association with other objects is imported through the .cml file.

9 parent_object_id

The unique identifier of the parent object.

For example, if the object being loaded is a metric, then the parent_object_id is the unique identifier of the scorecard to which the metric belongs.

If the object being loaded is a strategy element, then the parent_object_id is the unique identifier of the strategy to which the strategy element belongs.

10 owner_user_ns_id

The identifier of a Cognos 8 authentication namespace used to resolve the reference in the owner_user_id column.

Used to differentiate the value in the owner_user_id when more than one Cognos 8 authentication namespace is configured.

Optional

11 owner_user_id

The unique identifier for the owner of the object.

The name of the user, the identification of the user, or the search-path field in IBM Cognos 8.

Value: owner ID

12 diagram_object_nm

The name of the diagram associated with the object.

Valid for metrics and scorecards.

Name or object_id of a diagram is permitted.

Maximum length: 255

This column is used for backward compatibility with version 2.2. You can import the diagram association with the object by using the .cml file for file formats other than version 2.2.

13 kpi_indicator_type_id

The unique identifier of the metric type for the metric.

Value: metric type ID

Required for a metric

14 kpi_home_sc_id

The unique identifier of the home scorecard for the metric.

Value: home scorecard ID

Required for a metric

15 kpi_qualifier_id

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

Corresponds to Qualifier Name and the object_id in the .cmo file.

Required if there is more than one metric of this type on the same home scorecard

16 kpi_actuals_ds_id

The unique identifier of the import source that provides the actual values for the metric.

Value: import source ID

17 kpi_target_ds_id

The unique identifier of the import source that provides the target values for the metric.

Value: import source ID

18 kpi_tolerance_ds_id

The unique identifier of the import source that provides the tolerance values for the metric.

Value: import source ID

19 kpi_benchmark_ds_id

The unique identifier of the import source that provides the user-defined column values for the metric.

Corresponds to the user-defined column import source.

Value: import source ID

20 kpi_rollup_cd

The rollup code specifying how the metric is calculated as a derived index or how the strategy element is calculated.

Values: MAX (maximum: bubble up green), MIN (minimum: bubble up red), MODE (majority rules), WA (weighted average), NO (no status) for the strategy element, blank for the metric that is not a derived index

21 ds_filename

The file name or directory name of the import source.

Used only when the object_type_cd is DS.

Maximum length: 255

22 include_subfolders_ind

The flag indicating whether to load the sub-folders from the import source.

Used only when the object_type_cd is DS.

Values: Y (Yes), N (No)

Default: N

23 delete_flag

The flag indicating whether the object is to be deleted.

Values: Y (Yes), N (No)

Setting the flag to Y deletes metric custom titles (alias).

Default: N

24 supports_cube_kpi_def

Identifies the import source type.

Values: R (relational database loaded directly using Metric Studio), T (tab-delimited file loaded directly using Metric Studio), C (cube administered by Metric Designer), P (relational database administered by Metric Designer)

25 package_path

Identifies the path for cube import sources.

The value is null if a cube is not the import source.

26 default_group_view_id

The identifier of the strategy to be used for the object’s default grouping.

27 show_group_status_counts

The flag indicating whether the strategy element has counters shown in the user interface.

Values: Y (Yes), N (No)

28 all_metrics

The flag indicating whether this strategy applies to all metrics.

Values: Y (Yes), N (No)

29 data_format_cd

The Metric Studio version of the files that the import source supplies.

Used for import sources only.

Values: 3 (2.2), 4 (8.1.1), 5 (8.1.2 MR1), 6 (8.1.2 MR2), 7 (8.2.1), 8 (8.3.1), 9 (8.4.2)

30 db_character_set

The collation to use to import the data for the import source.

Used for import sources only.

Example: Latin1_General_CI_AS for SQL Server

31 enabled_for_load

The value that enables or disables the import source.

Used for import sources only.

Values: Y (Yes), N (No)

32 expand_groups

The flag indicating whether strategy elements are expanded when first displayed.

Values: Y (Yes), N (No)

Default: N

33 diagram_ind_style_cd

The identifier of how strategy elements appear on a diagram.

Values: icon, circle, circle icon, rect, rect icon

Default: icon

34 primary_group_type_id

Not used.

35 secondary_group_type_id

Not used.

36 default_diagram_id

The identifier of the default diagram for this object.

Optional

37 default_report_id

The identifier of the default report for this object.

Optional

38 decimal_char

The character to be used for the decimal character

Values: . or ,

Default: .

Optional

39 unit_cd

The unique unit code.

Maximum length: 50

Required

40 show_others

The flag indicating whether the Other Metrics strategy is displayed.

Values: Y (Yes), N (No)

Default: N

41 show_icon

The flag indicating whether the icon for strategy elements is displayed on diagrams.

Values: Y (Yes), N (No)

Default: Y

42 default_weight

The default weight for metrics and metric types associated with the strategy element.

The weight determines how much influence the contributing metrics will have when calculating the status of the strategy element using the weighted average rollup rule. The weight can be overridden when metric and metric types are associated with the strategy element.

Only numerical values are allowed.

Default: 10

43 inherit

If the object is a URL and it belongs to a scorecard, inherit is the flag that shows this report on lower-level scorecards.

If the object is a URL and it belongs to a metric type, inherit is the flag that shows this report on all metrics of this type.

If the object is a diagram and it belongs to a scorecard, inherit is the flag that shows the diagram on lower-level scorecards.

If the object is a diagram and it belongs to a metric type, inherit is not applied. The user interface does not have this setting.

Values: Y (Yes), N (No)

44 auto_map_cube_periods

Automatically updates the time mappings when new times are added to the cube and the Metric Designer time mappings check box with the same label is selected.

Values: Y (Yes), N (No) for the import source object; NULL for other objects

45 parent_object_type_cd

The parent object type code for a report, a diagram, or a strategy element.

Values for a report: SC (scorecard), KPICL (metric type), KPI (metric), PRO (project), STRAT (strategy), STELM (strategy element)

Values for a diagram: SC (scorecard), KPICL (metric type), KPI (metric)

Values for a strategy element: STRAT (strategy), STELM (strategy element)

46 unit_display_ind

The flag indicating whether the unit for the user-defined column is shown.

Values: Y (Yes), N (No)

47 decimal_places

The number of decimal places used when showing metric values in the user-defined column. The number can be changed in the user interface.

Values: 0 to 5

46 created_dt

The date the value was set in the source system.

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