Raw reason codes XML file format

The raw reason codes XML file format includes the following tagged elements to define a raw reason code list.

Raw Reason List Element

<raw_reason_list>

Specifies the content as a raw reason code list.

There can be only one <raw_reason_list> element per XML file.

Default Raw Reason Element

<default_raw_reason parameters>

The default raw reason code for the UCO. For more information, see Default raw reason code.

There must be one and only one <default_raw_reason> element per list.

raw_reas_cd

The name of the default raw reason code. This name must be unique among the raw reason codes included in the XML file.

The value should specify a raw reason code that is either included in this list or already defined in the UCO. Otherwise, an error will occur during the import operation.

This parameter can also be null (raw_reas_cd="").

overwrite

Specifies whether to overwrite the object's current default raw reason code value, if one has been specified. If set to True, the default raw reason code value will be overwritten by the raw reason code specified in this element unless the current default raw reason code setting is locked. If set to False, the current default raw reason code setting will not be overwritten. However, if a default raw reason code has not been defined for the object, then the raw reason code specified in this element will be used regardless of the overwrite setting.

Raw Reason Code Element

<raw_reason parameters>

Specifies a raw reason code. Each <raw_reason> element includes one <expression> element, one or more <available_reason> elements, and one <default_reason> element.

There can be one or more <raw_reason> elements per list.

raw_reas_cd

The name of the raw reason code.

Raw reason code names are case insensitive. For example, raw reason codes named RunningSlow and runningslow would be considered duplicate raw reason code records and would cause an error during import.

prompt

True or False (the default). Determines whether an operator will be prompted to manually select a utilization reason from the list of allowable reasons (specified by the <available_reason> elements) when a new raw reason code becomes active.

This parameter cannot be null.

priority

Required. A positive integer value that indicates the evaluation order of the raw reason code in the list. The value must be unique among raw reason codes included in the import file. If this parameter has no value or an invalid value, the file import will fail.

Each raw reason code element must have the priority value specified, and the value must be a positive integer. Otherwise, that raw reason code will not be imported. There should also not be duplicate priority values among the raw reason code elements in the file. If a duplicate priority value is found, that raw reason code and those that follow it will not be imported.

Priority is used to determine the order of the raw reason codes when they are imported into a UCO at the selected location among existing raw reason codes. For more information, see Set the raw reason code evaluation order.

When exporting raw reason codes, the priority of the first raw reason code in the list is set at 100 and each raw reason code after that is incremented by 100. This allows you to modify the XML file to add additional raw reason codes between the existing ones.

When importing a raw reason code XML file, the raw reason codes being imported are sorted by ascending priority before adding them at the selected location in the raw reason code list on the General tab.

min_time_before_activation

The period of time that determines how long the raw reason code’s expression has to be True before it is considered a candidate to be the active raw reason code. This value has the format hour:minute:second.millisecond (for example, 00:00:10.5 for 10 and a half seconds). For more information, see Minimum Time Before Activation.

The value must be in the proper format (hh:mm:ss). Otherwise, the raw reason code will not be imported.

last_edit_comment

A comment regarding when the raw reason code was created or last modified.

This parameter can be null.

description

A description of the raw reason code.

This parameter can be null. However, the string cannot exceed 1024 characters. Otherwise, the raw reason code will not be imported.

<expression><![CDATA[expression]>

A System Platform script expression that will determine whether the selected raw reason code is active. For more information, see Enter a raw reason code System Platform script expression and its sub-topics. The expression will be validated automatically when the object is saved after the import operation.

There must be one and only one <expression> element per <raw_reason> element.

<available_reason parameters>

A utilization reason that a user will be allowed to choose, when prompted (that is, if the prompt parameter is True), from a list of allowable reasons when the raw reason code becomes the active raw reason code.

There can be one or more <available_reason> elements per <raw_reason> element, or none. Each allowable reason must include values for both the reas_grp_desc and the reas_desc parameters.

If no <available_reason> element is included, then the user will be able to select from all utilization reasons in the MES database.

reas_grp_desc

The name of the raw reason group for the allowable raw reason.

The value should be a reason group that is actually in the MES database. The reason group and reason will be validated against the MES database on the first object Save operation after import. If it does not exist, the raw reason code will be indicated to be in an error state.

This parameter can be null.

reas_desc

The name of the allowable raw reason.

The value should be a reason that is actually in the MES database and in the reason group specified by the reas_grp_desc parameter. The reason group and reason will be validated against the MES database on the first object Save operation after import. If it does not exist, the raw reason code will be indicated to be in an error state.

This parameter can be null.

last_edit_comment

A comment regarding when the allowable reason group and reason were added or last modified.

This parameter can be null.

<default_reason parameters>

The default utilization reason for the raw reason code. For more information, see Default Reason Group and Reason.

There must be one and only one <default_reason> element per <raw_reason> element. Values for both the reas_grp_desc and the reas_desc parameters must be defined.

reas_grp_desc

The name of the default utilization reason group for the raw reason code.

The value should be a utilization reason group that is actually in the MES database. This value will be validated automatically when the object is saved after the import operation.

reas_desc

The name of the default utilization reason.

The value should be a utilization reason that is actually in the MES database and in the utilization reason group specified by the reas_grp_desc parameter. This value will be validated automatically when the object is saved after the import operation.

last_edit_comment

A comment regarding when the default reason was added or last modified.

This parameter can be null.