*
Concepts
*
Settings
 

Setting up Site Interoperability Profiles for AWEIS

The site interoperability profiles that you define at the enterprise level make it easier to manage the availability of CMMS data at the site level.
You can assign a profile in the site’s AssetWise interoperability settings. For more information, see Activating AssetWise Enterprise Interoperability in APM.
This topic explains how to create an interoperability profile and provides sections explaining the settings:
•
To Create a Profile
•
To Specify the Data Available on Sites
•
To Use Editing Rules for Assets and Value Lists
•
To Set Options for Solution Packages
•
To Set up Failure Coding
•
To Set Work Management Options
•
To Select Characteristic Map Sets for Work Documents
•
To Set Selection List Restrictions
•
To Set Failure Creation Options
•
To Set Change Request Defaults
•
To Enable Publishing APM Events to AWEIS
•
To Set Redraft Options for Approvals
•
To Complete the Interoperability Profile

To Create a Profile

1.
In the Enterprise window, select the Integrations view, the AssetWise Interoperability tab, and then the Interoperability Profiles tab.
2.
Click New. The Site Interoperability Profile Properties window appears:
3.
Provide a descriptive name for the profile.

To Specify the Data Available on Sites

1.
In the General tab, Reliability program area, specify whether one or both of the following appear in the site’s Reliability Program view:
Setting Name
Description
Reliability program – APM
When this option is selected, APM standard tasks, standard jobs, and job tasks are available as follows:
•
Shown in the site’s Reliability Program view, Program tab.
•
Available for selection on action plans as corrective tasks
•
Available for selection on failure mode feasibility evaluations as reliability program recommendations
Reliability program – Interop
When this option is selected, solution packages, templates, and triggering profiles are available as follows:
•
Shown in the site’s and asset’s Reliability Program view
2.
In the Work documents to use area, specify which of the following can be created or referenced when acknowledging indicator alarms, requesting follow-up work, and requesting reliability program reviews:
Setting Name
Description
Work documents to use
Determines the system where work documents are sourced. You can select the following work documents:
•
CMMS work documents – for example, Maintenance orders and notifications when the CMMS is SAP Plant Maintenance
•
APM work documents – Work orders and work requests
•
Interop requests for work – Interop work documents
Note: Only one of the options above can be selected.
3.
In the Work management history to use area, specify whether one or both of the following are displayed in the site’s Work Management view:
Setting Name
Description
Work management history – APM
When this option is selected, only APM work documents (work orders, work order tasks, activity reports, and so on) are displayed in the Work Management view.
Work management history – Interop
When this option is selected, requests for work, interop work requests, and interop work orders are displayed in the Work Management view.

To Use Editing Rules for Assets and Value Lists

1.
Select the Assets tab.
Properties that are selected on the Asset Properties tab are read-only on interop assets (assets that are mastered by the CMMS). Most of these properties are synchronized with the CMMS assets, which means that they can be changed in the CMMS only and then updated automatically in APM.
On the other hand, properties that are not selected on the Asset Properties tab are maintained in APM only. They cannot be changed (for example, set to Null) by AWEIS.
2.
Select the Value Lists tab:
These settings determine whether you can create and update objects such as employees and maintenance groups in APM. Items that originate in the CMMS typically have read-only properties and disabled actions.

To Set Options for Solution Packages

1.
Select the Solution Packages tab, Options tab.
2.
Select the number of solution package levels that will be used at the site, from “One” to “Four”. A Level tab is added for each additional level. For example, if you choose to use four levels, Level 2, Level 3, and Level 4 tabs are added so that you can specify options for each level.
3.
Select the level at which solution packages can be triggered in requests for work.
4.
Select the level from which cycles can be selected in requests for work.
5.
On each Level tab, set the appropriate options:
Setting Name
Description
Name
This name appears in the user interface to identify instances of the solution package level.
Plural
This plural version of the name appears in the user interface to identify two or more instances of the solution package level.
Values at this level are subordinate to a higher level of solution package
For levels two and greater, this option identifies the level as being subordinate to higher levels. When selecting a solution package on a request for work, you will need to select a higher level solution package first.
Values at this level support a related solution package
This option identifies the level as supporting related solution packages. The related package is displayed in the Solution Package window, Properties view, General tab to show the link between the two packages.
Limit solution packages to indicator candidates when applicable
This option identifies the level as supporting only candidate indicators. When selecting a solution package on an alarm acknowledgment or indicator reading, only solution packages linked to the current indicator are available.
Asset filtering
Assets available for selection can be filtered according to their position in the site’s asset hierarchy.
Request for work options
The options are:
•
Entry requirements, that is, whether or not it is mandatory to enter this level in a request for work. The options are:
•
Not entered – no requirement to select a solution package level
•
Optional with warning – a warning message appears when you save a request without entering this level
•
Optional without warning – when you save a request without entering this level, no message appears
•
Required – You cannot save the request without entering this level
Note: If you are using subordinate levels and wish to make the 2nd or 3rd level mandatory, you must also make the first level required.
•
Only solution packages at the request for work’s site can be selected on the request
•
Solution packages at the request’s site and above can be selected on the request
6.
Select the Steps tab:
Steps describe tasks performed on the solution package.
7.
Provide the following information:
Setting Name
Description
Solution package level steps are defined at
The solution package level at which steps can be defined for this site.
Package name
The label corresponds to the name of the solution package level, for example, “Maintenance plan”.
APM automatically names the package with a sequential number. You can change the name to another unique string.
Step name plural
Plural form of the step name for display in the user interface.
8.
On the Solution Packages tab, select the Details tab:
9.
Properties that are selected in the Solution package properties area are read-only on solution packages, which means that they can be changed in the CMMS only and will then be updated in APM.
10.
In the Request for work creation area, identify the level to use a request for work is created from a solution package.
11.
Select the Task Links tab. Specify the incremental value to use when numbering tasks as they are added to a solution package. For example:

To Set up Failure Coding

1.
Select the Failure Coding tab, if it is available. For example:
The settings on this tab control the types of codes, if any, used to identify failures on requests for work and failure records in APM.
Note: To use this functionality in APM, you must enable feature 46. In the Enterprise window, select the Features view and the Enabled Features tab. Click Browse, select “Failure codes support with AssetWise Interoperability”, and click OK. If APM is running as a smart client, click Refresh Enabled Features on the server. Then restart the client to use the functionality.
2.
The settings available on this tab vary depending on the failure code type you select:
Setting Name
Description
Failure code type
Specifies the type of code, if any, used to identify failures on requests for work and failure records in APM. The options are:
•
Object part, damage and activity codes – For example, when acknowledging an indicator alarm with a request for work, you can add one or more recommendations for events to the request. Each event can be defined by a part group, part, damage code, and activity code
•
Failure codes – You can define as many as five levels of failure codes and name them to match the codes used in the CMMS
•
None – Codes are not identified on requests for work and failure records
3.
If you selected Object part, damage and activity codes, select an item in the Recommended event requires list. The specified item must be identified before an event can be added to the work document. For example, if “Object part” is selected, you can add an event with only a part number. If “Activity code” is selected, the event must have a part number, damage code, and activity code before it can be added.
Here is an example from the Acknowledge Indicator Alarm dialog, Events tab. The Add Event button is not enabled until the activity code is selected:
4.
If you selected Failure codes, select the number of levels required. You can define as many as five. Provide names for each of the levels, for example, “Activity Type”, “Activity Cause”, and “Activity Source”. APM uses these names to label failure codes in work documents.
Here is an example from the Acknowledge Indicator Alarm dialog, Failure Codes tab:
The failure code values are typically imported into APM with work documents from the CMMS. You can view and create them in the site’s Work Management settings.
For more information about failure codes, see Setting up Failure Codes.
5.
If you selected Failure codes, select a failure code priority matrix from the list. The matrix is used to default the work priority based on the request’s failure codes.
6.
If you selected Failure codes, select whether failure codes are selected on the request for work or at the recommendation from event level.

To Set Work Management Options

1.
Select the Work Management tab, Requests tab:
2.
Select a default employee to use when APM sends an object (such as an asset change request) to the CMMS via AWEIS. APM includes the selected default employee only if employees are restricted and an employee flagged as “AssetWise Interoperability Active” is not associated with the object.
The selection list contains only employees with the status of “AssetWise Interoperability Active”.
3.
In the Work description text area, you can specify the maximum number of characters allowed in long work descriptions. For example, when requests for work respond to two or more indicator alarms, the compiled descriptions and acknowledgment comments can exceed the length allowed by the CMMS. The maximum number you can enter in the Maximum work description text box is 1,000,000.
4.
By default, text in work document descriptions are formated as rich text. If the CMMS does not support rich text, select Plain text as the type of text.
5.
Select the site that owns secondary statuses and groups. Selection lists of statuses will be filtered to include only values from this site and above in the hierarchy.
6.
When Only secondary statuses that are in a status group are available for selection is selected, statuses that are not assigned to groups are not available for selection in requests for work.
7.
In the Solution packages area, you can select an option to filter the solution packages available for selection in a request for work according to the request’s asset.
8.
In the Work type options for requests for work area, you can do the following:
•
Work type is required on requests is selected by default, which means that requests cannot be saved unless they have a work type. This setting allows you to configure settings that are specific to a work type and site combination. For more information, see Setting up Site-Specific Work Types.
•
Select work types for sites with this profile. By default, All work types is selected. You can select Only the work types selected below and then select the appropriate work types in the list.
9.
In the Maintenance groups available for requests for work area, you can select the appropriate filter. For example, if you select The maintenance group hierarchy, the site’s top maintenance group and its descendants are available for selection on requests for work.
10.
Select the User Fields tab, if it is available. For example:
Note: To use this functionality in APM, you must enable feature 48. In the Enterprise window, select the Features view and the Enabled Features tab. Click Browse, select “Support for user-defined fields on AssetWise Interoperability Work Documents”, and click OK. If APM is running as a smart client, click Refresh Enabled Features on the server. Then restart the client to use the functionality.
11.
Select the properties you wish to include in interop work documents and provide a label for each one. The properties will be shown in the Details tab of work document windows for requests for work, interop work requests, and solution packages.
Note: Additional steps are required to integrate the properties with the CMMS. For more information, see Defining Properties to Display on Interop Work Documents.
12.
Select the Reference Numbers tab:
13.
You can enter up to five types of reference numbers to be included in the information for requests for work and interop work orders. The text that you provide will be displayed as the label for the reference number.
Tip: To send reference number values to the CMMS, be sure to set up characteristic map sets for work documents. See Setting up Characteristic Mapping for Interop Work Documents.
14.
Select the Checksheet Generation tab:
15.
Set the checksheet generation horizon and select the work order date to use. Checksheets will be generated when the work orders’ control dates are within the horizon (for example, 30 days).
16.
In the Checksheet creation for recommendations from events area, specify the interop work documents, if any, for which checksheets can be generated. The work document must be included in a request for work’s events, and the work document’s activity code or failure code must support checksheet generation. Possible values are:
•
Neither work order or work request events
•
Only work order events
•
Only work request events
•
Both work order and work request events
17.
Select the checksheet type to assign to checksheets generated for a work document.
18.
In the Checksheet request for work generation area, you can set a triggering horizon (for example, 30 days) for requests for work. Requests for work are generated when checksheet planning dates are within the horizon.

To Select Characteristic Map Sets for Work Documents

1.
Select the Characteristics tab:
2.
Select the characteristic map sets for each of the types of interop work documents that need characteristic values.
If this step is missed, a message is displayed in the work documents’ Characteristics tabs in APM. For example, if a map set has not been selected for requests for work, in all Request for Work windows, the Characteristics tab displays a message in the banner, as well as the Edit Settings button. Using the settings dialog, you can select the map set. If needed, you can define characteristic classes, add characteristics, and select default characteristic classes for sites using this dialog.
3.
If you do not intend to use characteristic mapping for a type of work document, click Hide characteristics mapping message. This prevents the message from appearing in the document’s Characteristics tab.

To Set Selection List Restrictions

1.
Select the Restrictions tab.
For requests for work and asset change requests, which are created in APM and then conveyed to the CMMS by AWEIS, you can restrict selection lists to objects that are interoperability-enabled; that is, their AssetWise Interoperability Active statuses are set to “True”.
For example, if employees are restricted, when you create a request for work, only interoperability-enabled employees are available in selection lists for requesters and “assigned to” employees on the recommended task. Similarly, when a request for work for an automatically-generated alarm acknowledgment is sent to the CMMS, an interoperability-enabled employee is referenced. Note that you can select a default employee for this situation in the Requests tab.
2.
Select the lists that you wish to restrict.
Tip: Click Review for any value type to see items that are – or are not – enabled for interoperability. For example:

To Set Failure Creation Options

1.
Select the Failures tab:
Note: To use this functionality in APM, you must enable feature 35. In the Enterprise window, select the Features view and the Enabled Features tab. Click Browse, select “Failure creation from Interop work requests and orders”, and click OK. If APM is running as a smart client, click Refresh Enabled Features on the server. Then restart the client to use the functionality.
2.
Select Create failure events for breakdowns to enable the other options.
3.
Select the appropriate options for creating failures at the site. These settings control whether failures are created from interop work requests, interop work orders, or both.

To Set Change Request Defaults

1.
Select the Change Requests tab.
Note: To use change requests, you must enable features 28 and 77. In the Enterprise window, select the Features view and the Enabled Features tab. Click Browse, select “Asset change requests”, select “Support for Interop work document change requests”, and click OK. If APM is running as a smart client, click Refresh Enabled Features on the server. Then restart the client to use the functionality.
2.
Select the Assets tab. When an asset change request is sent to the CMMS, AWEIS returns a status and message to APM. Select the asset change request statuses to assign to requests in response to the statuses returned from the CMMS.
Note: An asset change request status must reference an Interop status (Accepted, Error, Rejected, or Sent) to be available for selection on this tab. See Setting up Asset Change Request Statuses.
Setting Name
Description
Sent
The status assigned to an asset change request when it has been sent to the CMMS.
Accepted
The status assigned to an asset change request when it has been accepted by the CMMS.
Rejected
The status assigned to an asset change request when it has been rejected by the CMMS.
Error
The status assigned to an asset change request when the request was prevented from reaching the CMMS.
3.
Select the Site Settings tab to view the sites in the enterprise and their change request settings.
You can also edit row cells in place or use the Replace Column Data function to apply a change to a column in all sites. For more information, see Entering Data in Tables and Applying Mass Updates.
4.
Select the Work Orders tab.
5.
Select the change request statuses that correspond to interop events.
6.
Select the Work Requests tab and select the change request statuses that correspond to interop events.

To Enable Publishing APM Events to AWEIS

1.
Select the Events tab.
When APM objects are created, updated, or deleted, events can be produced (serialized) and published to an external system using AWEIS. Configuring this functionality involves creating an APM outbound event service provider and configuring a service instance. For more information, see Setting up APM Outbound Events.
2.
To implement outbound events, select Interop events enabled and select the interface package(s) to use. For example:

To Set Redraft Options for Approvals

1.
Select the Redraft tab.
You can use the APM formal approval process with the following interop documents: asset change requests, requests for work, work order change requests, and work request change requests. The redraft action allows documents that have been sent for approval or rejected to be reopened, modified, and sent through the approval process again. Use the options on this tab to control whether redraft is available to interop documents based on their interop statuses.
2.
By default, interop documents can be redrafted no matter their interop status. To prevent the redraft action from being available for a specific status, click Redraft is not allowed for the status.

To Complete the Interoperability Profile

1.
Select the Description tab to add more information.
2.
Click OK. The window closes and the profile is added to the table.
Tip: When the profile has been in use for a while, you can return to this window and select the Usage tab to view a list of the sites to which it has been assigned.