*
Concepts
*
Tasks
*
Settings

Setting up Solution Package Templates

When your external CMMS is SAP Plant Maintenance, for example, maintenance plan information is sent from SAP to APM in the form of solution packages that represent preplanned work. The solution package includes information such as the tasks to perform, work priority, work type, work classification, maintenance group, and so on.
The CMMS (SAP) is the master system for solution packages and sends updates any time that there is a change to the mapped data in the maintenance plan. This mechanism allows for a loose coupling between the SAP maintenance plan and the APM solution package. The schedule and work cycles are controlled in SAP, but the details of the corresponding inspections are maintained in APM and are linked through the solution package.
In APM, you can create solution package templates and link them and cycles to standard tasks in the asset program profiles that APM uses to generate inspection activities. You can create solution package templates from scratch or when setting up asset program profiles. You can also create a template from a solution package. Once the template exists, you can manually assign it to solution packages that arrive from the CMMS.
Solution package templates can also be referenced on requests for work created in APM, for example, in response to indicator alarms or for follow-up work. Solution package information can be included on standard tasks to be copied to the requests for work that are created from the checksheets generated from the standard task. In SAP, the request can trigger the maintenance plan that creates corrective tasks.
For each site, you can set up as many as four solution package levels, naming the levels with terms specific to your CMMS or organization. For example, the levels could be named Maintenance plan, Maintenance item, and Operation or Plan, Task, and Subtask.
A message sent to APM from the CMMS indicates the preplanned work’s level. In APM, the level is matched to the solution package type’s level (1 to 4). The solution package type identifies the kind of object, for example, maintenance plan. The site interoperability profile determines the behavior, for example, the level that supports cycles or steps.
For related information about solution packages, see Setting up Site Interoperability Profiles for AWEIS.
You can use asset program profiles to generate reliability and inspection programs for one or more assets at the same time. The profile specifies asset types and filters for selecting the specific assets to update, as well as the indicators, standard tasks, jobs, solution packages, and documents to assign to assets. If you are using the construction form feature, the profile also generates a checksheet for each of the assets’ standard tasks.
For more information, see Setting up Asset Program Profiles.
When the asset program is generated, APM selects the appropriate assets and creates standard tasks based on the task templates. The standard tasks are linked to the asset’s solution package tasks and cycles. If a solution package task does not already exist, it is created for the solution package. However, if a solution package corresponding to the referenced solution package template does not exist for the asset in APM, this part of the generation process is skipped.
Tip: You can create a template from a solution package. In the Solution Package window, click the Tools menu and Create template. Click Yes in the confirmation message. The solution package template window opens, where you can add task templates and adjust options.
This topic explains how to create a solution package template from scratch.

To Set up a Solution Package Template

1.
From the Site window, select the Reliability Program view.
2.
On the Program tab, select the Solution Package Templates tab. This tab displays a tab for each of the solution package levels defined in the site interoperability profile. In this example, the levels are Maintenance plans, Maintenance items, and Task lists:
3.
Select the appropriate tab and click New to open the Solution Package window. This example shows a maintenance plan:
4.
On the General tab, provide the following identification information:
Setting Name
Description
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.
Level
By default, the solution package level is set according to the tab from which you started the template. If you change the level, the window’s appearance changes to match.
Type
In APM, you can define solution package types and assign their levels, providing names of your choosing as well as sequence numbers.
The SyncSolutionPackage XML message sent to APM from the CMMS includes the preplanned work’s level. In APM, the level is matched to the solution package type’s level (1 to 4). The solution package type identifies the type of new object, for example, maintenance plan. The site interoperability profile determines the behavior.
Work title
Title used to identify the work document in lists and tables.
Site
Site where this solution package is used.
5.
On the General tab, provide the work details:
Setting Name
Description
Maintenance group
Work planners specify which maintenance group will perform the work defined in a work document.
Work type
Work types describe and control the work performed for the interop work document. For example, Inspection and Corrective types allow different activities and usage.
Work classification
Work classifications are used to categorize, sort, and filter work documents. Work types typically list classifications that are relevant to them. For example, the Corrective work type is associated with the classifications “based on inspections”, “modification”, “planned”, and “unplanned corrective”.
Work priority
Work priority indicates the urgency of work and the sequence in which it should be completed. For example, “Normal” and “Emergency” might be two priorities used by your organization.
Estimated cost
Approximation of the cost involved in performing the work.
Mark request as ready to send
When the Mark request as ready to send option is selected, the request is submitted to the CMMS when it is saved. In Requests for work tables, it has the Interop status “Ready to send”.
Request solution package trigger
When this option is selected, preplanned work is requested in the form of a solution package.
Create work order
If this option is selected, an interop work order is created in APM when the request is accepted. If this option is not selected, an interop work request is created.
6.
Select the Details tab. This tab shows strings, date boxes, and check boxes that have been defined for your organization. You can enter values as appropriate.
7.
Select the Inspections tab. Click Browse to locate and select standard task templates to add to the package template.
If the solution package level is superior to one or more levels, a tab for each level is available so that you can view related objects.
8.
Select the Cycles tab. Click New to define a cycle:
9.
Provide the following information:
Setting Name
Description
Cycle name
Descriptive name that identifies the cycle.
Cycle number
Sequence number for the cycle.
Repeat interval
Quantity and unit of measure for the interval at which cycles repeat.
10.
The tasks table lists the task templates associated with the solution package template. Select the tasks to be performed on this cycle.
11.
Click OK. The cycle is added to the Cycles tab.
12.
Select the Searches tab and select values. Search values make it easier for users to find objects based on trade, frequency, operating condition, maintenance group, and technology.
13.
If available, select the Failure Codes, for example:
Solution packages support failure codes, if specified by the Failure code type setting in the site’s interoperability profile. You can select failure codes and provide a default description on solution package templates. When a solution package is referenced in a request for work or other work document, the failure codes are copied from the solution package. Note that if the work document already has one or more failure codes, those codes are not replaced by values from the solution package.
14.
If available, select the Events tab. For example:
The tab is available if the site’s interoperability profile specifies that the failure code type is “Object type, damage and activity codes”. It will display the highest priority event from the associated work document.
15.
Select the Labor tab. For each requirement that you wish to add, click New to open the Labor Requirement window:
16.
Enter the following information:
Setting Name
Description
Trade
Trade resource needed to perform the work.
Required time
Amount of time that each trades person will need to perform the work.
Number of
Number of trade resources required for the task.
APM calculates the total requirement.
17.
Click OK. The labor requirement is added to the tab.
18.
Select the Statuses tab.
This tab displays the following information:
Setting Name
Description
Interop status
Indicates the work document’s stage in the integration workflow. Possible statuses are:
•
New / Pending – The document has not yet been submitted to AWEIS
•
Data entry complete – The request meets requirements. For example, it includes a recommendation from event or labor requirement
•
Ready to send – The document has been submitted and is ready to be sent to AWEIS
•
Sent – The message has been sent to the CMMS where it will be acknowledged
•
Accepted by system of record – The request has been acknowledged by the CMMS and an interop work request or interop work order has been added or updated in APM
•
Rejected by system of record – An error prevented the CMMS from accepting the request. An interop message returns the reason for rejection
•
Error – An error prevented the request from being sent to the CMMS. An interop message returns a description of the error
•
Request canceled – The user canceled the request
Effective status
Status assigned to the solution package by the CMMS.
Status effective
Date on which the solution package went into effect.
19.
Select the Characteristics tab if you wish to assign values to characteristics in a map set.
For more information, see Setting up Characteristic Mapping for Interop Work Documents.
20.
Select the Description tab to add more information.
21.
Save and close the solution package template.