Concepts

Tasks

Setting up Characteristic Mapping for Asset Change Requests

Change requests specify updates to be performed on assets in the external CMMS (for example, SAP) that manages assets and work. AssetWise Enterprise Interoperability (AWEIS) conveys requests to the CMMS and returns information to APM. The asset update is performed in the CMMS and then information such as a new equipment number is communicated back to APM, where the interop asset is updated.

Characteristic support extends to asset change requests of all types. You can create a characteristic map set so that APM information is sent to the CMMS to update characteristic values. For example, equipment removal requests might include a work order number and the date removed. Construction form change requests might include the work order number and construction form header properties. Asset properties change requests can include many properties from the asset type’s specifications.

When setting up asset change request types, you can specify the characteristic map. For example:

When the asset change request is created, APM refers to the characteristic map set to export information from the construction form or equipment removal request to send to characteristics in the CMMS.

For related information about asset change request types and working with requests, see:

•	Setting up Asset Change Request Types

•	Creating Asset Change Requests for Construction Forms

•	Creating Equipment Removal Requests

•	Creating Asset Properties Change Requests

In order to export characteristics with a request, you must set up the following:

•	Characteristic classes (for example, “Equipment Removal Requests”, “Construction Form Header details”, and “Asset Change Request Header Details”). See To Create a Characteristic Class and Add Characteristics

•	Add the appropriate characteristics to each class, ensuring that their names match the characteristic names in the CMMS

•	Create the map sets that identify each CMMS characteristic’s matching property in the APM object. See To Create a Map Set

Be sure to set up the “Map Characteristics to Asset Properties” scheduled action to execute regularly to keep the values current. For more information, see Scheduling Actions.

Note: If you wish to map a characteristic to a custom class in APM, the custom class must have a User key and a join path to Site. Otherwise, the mapping will not work.

To Create a Characteristic Class and Add Characteristics

1.	In the Site window, select the Assets view, the Settings tab and then the Characteristics tab. For example:

By default, the Characteristic Classes tab shows characteristic classes for the enterprise based on the Asset and AssetChangeRequest classes.

Tip: You can also create characteristic classes, characteristics, and map sets at the enterprise level. In the Administration menu, click Application Settings. In the Application Settings window, select the Characteristics tab.

2.	Click New. The Characteristic Class Properties dialog appears:

3.	By default, the top site is selected so that the characteristics are available for all child sites. You can select another site, if required.

4.	Provide the class with a descriptive name, for example, “Equipment Removal Requests” or “Construction Form Header details”.

5.	Ensure that the class is set to “AssetChangeRequest”.

6.

Set the interop export type. The default selection, Attribute sets, is appropriate for most implementations of characteristic export. The Attributes option exports characteristics as unrelated attribute elements. This mechanism is typically used to extend the Mimosa schema beyond the predefined fields.

7.	Select the Characteristics tab.

8.	For each characteristic that you wish to add, click New. The Characteristic Properties dialog appears. For example:

9.	Enter a name that exactly matches the characteristic name in the CMMS.

10.	Provide a descriptive title for the characteristic.

11.	The sequence number determines the characteristic’s order in the class.

12.	In the Quantity and durations area, you can set options that determine how exported information is presented in the CMMS characteristic:

•	Default units – If the characteristic value uses a number format, select the unit of measure to be used for this characteristic’s values

•	Export option – You can specify whether only the number is exported or the number and its unit of measure are exported

13.	Select the Description tab to add more information about the characteristic.

14.	Click OK to save the characteristic and close the dialog. The characteristic is added to the table.

15.	When you have added all of the characteristics, click OK to save the class and close the dialog.

Tip: You can return to the Characteristic Class Properties dialog to view information about it: the map sets it is used in and its history.

To Create a Map Set

1.	In the Site window, select the Assets view, Settings tab, and Characteristics tab.

2.	Select the Map Sets tab and click New. The Characteristic Map Set dialog appears:

3.	On the General tab, the top site is selected so that the map set is available for all child sites. You can select another site, if required.

4.	Select the characteristic class from the list, for example, Equipment removal requests.

5.	Provide a name for the map set.

6.	Select the Mappings tab and click Generate Mapping. APM creates mappings for the characteristics identified in the characteristic class. For example:

7.	Open each Characteristic Mapping dialog and click Edit. For example:

8.	Select the target join path (if appropriate) and type of property (attribute or relationship). Here are some examples:

Date removed (Remove equipment change request)

This mapping copies the “date removed” value from the asset change request.

Work order (Remove equipment change request)

When you select a join path to a related class, you can then select an attribute (or relationship) of that related class.

This mapping targets the work status of the InteropWorkOrder:

Construction form (Asset property change request)

9.	In the Options area, select settings as appropriate to the mapping:

•	Create new instances as required is available for a relationship to a class that is owned or scoped by Enterprise or Site, for example, Material type or Work center.

•	Date format is available when the target property is an attribute that uses the DateTime data type. You can enter any format that complies with standard or custom .NET formatting rules. For example:

“d” is the format specifier for the short date pattern, which differs by culture. For example: 2009-06-15T13:45:30 -> 6/15/2009 (en-US).

See the Microsoft topics for Standard date and time format strings and Custom date and time format strings.

Note: The default values for these options are set for the enterprise in Application settings. In the Enterprise window, click the Administration menu and then Application Settings. In the Application Settings window, select the Characteristics tab and then the Options tab.

•	Quantity precision is available for Quantity and Duration attributes. You can specify the number of decimal places supported:

“0” – No decimal places

“1” – One decimal place

“2” – Two decimal places

10.	Click OK to close the mapping dialog.

11.	In the Characteristic Map Set dialog, select the Description tab to add more information.

Tip: The History tab displays information about the map set’s creation and modifications.

12.	Click OK to close the map set.