Add a raw reason code

To configure utilization events, you must add one or more raw reason codes in the Raw Reason Code list on the General tab. You must also select a default raw reason code; see Configure general utilization attributes. These two conditions must be met to successfully include the object instance in an Entity Model Builder build.

When defining raw reason codes, it is important to understand that codes higher in the list take precedence over codes lower in the list. The UCO processes the codes in order and records the first code whose expression evaluates to True. In general, this means you should add more specific codes higher in the list and more generic codes lower in the list. Another good practice is to have the last code in the list always evaluate to true and set an Unknown reason that requires further operator selection of an actual reason.

Note the following when adding or modifying a UCO’s raw reason codes:

• When a UCO instance (child) inherits another object’s raw reason code list and allowable reasons, you cannot alter the raw reason code list or allowable reasons that are inherited from a parent UCO’s raw reason code list. You can add new raw reason codes interleaved between the parent raw reason codes and allowable reasons.

• Changing a parent object’s raw reason codes or allowable reasons will invalidate all derived object instances. You will have to run the Entity Model Builder and redeploy the object to cascade the changed raw reason codes list to it’s derived object instances. For more detailed information, see Lock UCO attributes.

Add a raw reason code

1. In the System Platform IDE, open the UCO template or instance that you want to configure and go to the General tab.

2. Select the + Add button.

   A text box appears in the raw reason code list.

   

3. Enter the raw reason code name in the text box.

   The raw reason code name must adhere to the following rules:

   • Consist of alphanumeric or special characters ($, #, _)

   • Contain no more than 40 characters

   • Contain at least one letter

4. Press the Enter key.

   The new raw reason code is added to the list.

   

5. Configure the raw reason code attributes. For a description of the attributes, see Raw reason code attributes.