Metric Studio: Value Stage File (.cmv)

We strongly recommend that you use the .cmo file to create metrics.

The value stage file (.cmv) imports metric values. Once you set up the scorecards and metric types, you can use this file to periodically update the metric values or to add new metrics to existing metric types. You can have more than one .cmv file.

Each row of information in the file contains a single value for a single period. For example, a metric named Web Sales has a target value of 200000 and an actual value of 210000 for the month of July. The value stage file needs two rows of information, one for the July actual, and one for the July target.

Ensure that the value stage file contains all columns even if they are null.

The value stage file loads the kpi_value_stage table. The columns in the value stage file are as follows.































































































































No. Column Description
1 year_nr

The year.

Format: yyyy.

This column is provided for backward compatibility with previous versions of Metric Studio. Use only if the start_time_cd and level_id columns are both empty.

2 time_period_cd

The time period.

Values: P (periodic), D (daily; if this value is used, you must enter a value for column 4, day_nr), Q (quarterly), Y (yearly)

This column is provided for backward compatibility with previous versions of Metric Studio. Use only if the start_time_cd and level_id columns are both empty.

3 period_nr

The period to which the metric data applies, such as period 1 for the first month of the fiscal year.

Default: 1

This column is provided for backward compatibility with previous versions of Metric Studio. Use only if the start_time_cd and level_id columns are both empty.

4 day_nr

The number of the day within the period. It is null for periodic data.

Default: 1

This column is provided for backward compatibility with previous versions of Metric Studio. Use only if the start_time_cd and level_id columns are both empty.

5 kpi_id

A unique identifier for the metric.

Maximum length: 255

Required

6 value_type_cd

One of these metric value types: A (actual), T (target), O (tolerance), B (default user-defined column), or object_id (identifier for a user-defined column if the default user-defined column is not used; corresponds to the object_id in the .cmo file).

Required

7 kpi_value

The metric value defined by value_type_cd.

Required

8 currency_cd

An ISO currency code.

Required if the metric type is currency; must be null if the metric type is not currency

Default: null

9 last_updated_dt

The date the metric was updated.

Only used when value_type_cd is set to actual.

Default: system date

10 kpi_nm

A name for the metric. We strongly recommend that you use object_nm in the .cmo file to define it.

Maximum length: 255

11 scorecard_id

The unique identifier for the home scorecard. We strongly recommend that you use object_id in the .cmo file to define it.

If the object_id does not exist, Metric Studio creates it based on the information entered in this column.

Maximum length: 255

Required if the metric is created in this file

12 scorecard_nm

The name for the scorecard. We strongly recommend that you use object_nm in the .cmo file to define it.

Maximum length: 255

Required if the scorecard is created in this file

13 kpi_class_id

The unique identifier for the metric type. We strongly recommend that you use kpi_indicator_type_id in the .cmo file to define it.

Maximum length: 255

Required if the metric is created in this file

14 data_source_id

The unique identifier for the import source. We strongly recommend that you use object_id in the .cmo file to define it.

Maximum length: 255

Required if the import source is new; if it does not exist, Metric Studio creates it

15 data_source_nm

A name for the import source. We strongly recommend that you use ds_filename in the .cmo file to define it.

Maximum length: 255

Required for a new import source

16 parent_scorecard_id

The unique identifier for the parent scorecard of the scorecard specified by scorecard_id. Specifies a value when the home scorecard is nested in another scorecard. We strongly recommend that you use parent_object_id in the .cmo file to define it.

Maximum length: 255

17 qualifier_id

The unique identifier of the qualifier to distinguish this metric from other metrics of the same type on the same home scorecard. We strongly recommend that you use object_id in the .cmo file to define it.

Not required to load data

18 qualifier_nm

The name of the qualifier. We strongly recommend that you use qualifier_nm in the .cmo file to define it.

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.

19 start_time_cd

The calendar date that identifies the period for the current data row.

20 level_id

The calendar level that identifies the period for the current data row.

21 kpi_text

The metric text value. Only applied when value_type_cd is specified as a user-defined column.

22 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: EN (English)

23 created_dt

The date and time the metric 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