Work History Adapter

About the Work History Adapter

If Orders and Notifications are associated with a Technical Object, you can extract Orders and Notifications from SAP to create Work History records and Work History Detail records in APM. To do so, you will need to run the Work History Adapter Job.

When you extract an Order (with or without Notifications), the following Work History records are created:

One Work History record to represent the Order Header, which appears on the HeaderData tab in SAP. This Work History record will be created for the Technical Objects that appears on the HeaderData tab in SAP. This means that the Work History record will be populated with values representing those Technical Objects, and it will also be linked to the Equipment or Functional Location records representing those objects. Only this Work History record will contain cost values and estimated and actual confirmed hours.
One Work History record per object that appears in the Order's object list (i.e., on the Objects tab when you are viewing the Order). These Work History records will be created for the Technical Objects that are specifically associated with those items. This means that these Work History records will be populated with values representing those Technical Objects, and they will also be linked to the Equipment or Functional Location records representing those Technical Objects.

When you extract a Notification that is not associated with an Order, one Work History record is created to represent the Notification, and this Work History record will be linked to Equipment and Functional Location records representing the Notification reference objects. Specifically:

If the Notification has only an Equipment reference object, the Work History record for that Notification will be linked to an Equipment record.
If the Notification has only a Functional Location reference object, the Work History record for that Notification will be linked to a Functional Location record.
If the Notification has Equipment and Functional Location reference objects, the Work History record for that Notification will be linked to an Equipment record and a Functional Location record.

If a Notification has items, one Work History Detail record will be created to represent each item.

The following tables detail what to expect when running a Work History Job based on your SAP work order and notification combinations:

Orders Without Notifications


After you:	...Run this Job:	...Result:
Create an Order that is not associated with a Notification.	SAP_WorkHistory	A Work History record is created.
Update the Order referenced above.	SAP_WorkHistory	The corresponding Work History record is updated.

Orders With Notifications

Table 1. Notifications Without Items:
After you:	...Run this Job:	...Result:
Create an Order that is associated with a Notification without items.	SAP_WorkHistory	A Work History record is created to capture the data in the Order and the Notification.
Update only the Order.	SAP_WorkHistory	The corresponding Work History record is updated.
Update only the Notification.	SAP_WorkHistory	The corresponding Work History and Work History Detail records are updated.
Update both the Order and Notification.	SAP_WorkHistory	The corresponding Work History and Work History Detail records are updated.

Table 2. Notifications With Items:
After you:	...Run this Job:	...Result:
Create a Notification with items, but do not associate it with an Order.	SAP_WorkHistory	A Work History record and a Work History Detail record are created to capture the data in the Notification.
Update the Notification referenced above.	SAP_WorkHistory	The corresponding Work History and Work History Detail records are updated.

Notifications and Work Orders transferred from SAP into APM maintain their SAP ID in the Work History Detail and Work History record naming convention.

For example, suppose Work Order 18652 and Notification 20087 are related in SAP. Then, the Work Order and Notification are transferred into APM. One Work History record will be created using the following syntax: WH ~ <Notification Number> ~ <Work Order Number>. In this example, the Work History record ID would be WH~20087~18652.

The following diagram exemplifies how records in SAP are mapped to Work History records in APM.

Example: Order With Notification: Items on Object List

Suppose the following SAP Order exists, where the red outlines indicate that:

The Order number is 4000483.
The associated Notification number is 10001363.
The reference Technical Objects are Functional Location ABC-PQR/12-34-56/8 and Equipment TURBINE.

In addition, you can see from the Objects tab that there are items on the object list:

If you were to extract this Order, two Work History records would be created:

One for the Order and Notification combination.
One for the object list item EQABC123.

Work History Record for the Order and Notification Combination

Suppose there is a Work History record for the Order and Notification combination, where the associated Technical Object is TURBINE, and the Work History record is also linked to the Equipment record TURBINE.

If the Notification contained items, a Work History Detail record would also be created to capture additional information about that Notification.

Work History Record for the Object List Item EQABC123

Suppose the Work History record for the object list item EQABC123, and that the Work History record is also linked to the Equipment record EQABC123.

Example: Order Without Notification: No Items on Object List

Suppose the following SAP Order exists, where the red outlines indicate that:

The Order number is 4000141.
There is no associated Notification.
The reference Technical Object is Equipment V100.

In addition, you can see from the Objects tab that there are no items on the object list:

If you were to extract this Order, the following Work History record would be created, with the following:

The referenced technical object is V100.
The Work History record is linked to the Equipment record V100.

Example: Notification Without Order: Without Notification Items

Suppose the following SAP Notification exists, where the red outlines indicate that:

The Notification number is 10001364.
The reference Technical Object is Functional Location A1.
There are no items.

If you were to extract this Notification, the Work History record would be created, with the following:

The Work History record is associated with the Notification's Technical Object A1.
The Work History record is linked to the Functional Location record A1.

Example: Notification Without Order: With Notification Items

Suppose the following SAP Notification exists, where the red outlines indicate that:

The Notification number is 10001365.
The reference Technical Object is Functional Location F1.
There are two items.

If you were to extract this Notification, the following records would be created:

One Work History record.
Two Work History Detail records: one to capture additional information about the first notification item, and another to capture additional information about the second notification item.

The Work History record, would be created with the following:

The Work History record is associated with the Notification's Technical Object F1.
The Work History record is linked to the two Work History Detail records.
The Work History record is linked to the Functional Location record F1.