SAP EM Knowledge Bites 11 - What Web Services are available?

In our previous blog we hit on the hot topic of parameters and which ones should we use where.

Now let’s get in to a little nerd stuff  Web Services… This blog is intended to give you the quick links to go find the necessary detail to describe each of the available services. The documentation can be rather hard to find…. until now…

SAP EM web services can be found on the SAP Community Network or on the SAP help portal.

ProcessTracking

• Software Component Version: ESM SCEMSRV 7.01
• Technical Name: ProcessTracking
• Namespace: http://sap.com/xi/ESM/SCEMSRV

Applicable Business Objects: SAP EM provides two business objects for tracking using Web Services:

• Tracked Process – an Event Handler
• Tracked Process Event Notification – an event message

Available Web Service Interfaces: Six service interfaces are available:

1. Manage Tracked Process In – receives contents of a tracked process.

    Operations:

• Read Tracked Process – reads contents of a specific tracked process; returns track-ing IDs, parameters, measurements, statuses and events.

i.    Technical Name: TrackedProcessByIDQueryResponse_In

ii.    Namespace: http://sap.com/xi/EM/Global

iii.   SAP Defn: /SAPTRX/TRACKEDPROCESSBYIDQUER

iv.   Direction: Inbound

v.    Mode: Synchronous

vi.    Available BAdI: Retrieve Event Handler (/SAPTRX/SE_EH_RETRIEVAL)

vii.    Message Types:

1.    TrackedProcessByIDQueryMessage_sync

2.    TrackedProcessByIDResponse_sync

3.    Query Tracked Process In – receives results of a tracked process search.

• Find Tracked Process by elements – finds a tracked process according to specific criteria

i.    Technical Name: TrackedProcessSimpleByElementsQueryResponse_In

ii.    Namespace: http://sap.com/xi/EM/Global

iii.    SAP Defn: /SAPTRX/TRACKEDPROCESSSIMPLEBY

iv.    Direction: Inbound

v.    Mode: Synchronous

vi.    Available BAdI: Query Event Handler (/SAPTRX/SE_EH_QUERY)

vii.    Message Types:

1.    TrackedProcessSimpleByElementsQueryMessage_sync

2.    TrackedProcessSimpleByElementsResponseMessage_sync

3.    Tracked Process Event Notification Processing In – requests the crea-tion of a tracked process event notification (creates an event)

• Create Tracked Process Event Notification – creates a tracked process event notification.

i.    Technical Name: TrackedProcessEventNotificationCreateRequest_In

ii.    Namespace: http://sap.com/xi/EM/Global

iii.    Direction: Inbound

iv.    Mode: Asynchronous

v.    Available BAdI: Event Handler (create, update, delete) /SAPTRX/SE_EH_CRE_UPD_ DEL

vi.    Message Types:

1.    Tracked Process Event Notification Create Request

2.    Tracked Process Event Notification Processing Out – sends confirma-tion of the creation of a tracked process event notification.

• Confirm Creation Tracked Process Event Notification – confirms the creation of a tracked process event notification.

i.    Technical Name: TrackedProcessEventNotificationCreateConfirmation_Out

ii.    Namespace: http://sap.com/xi/EM/Global

iii.    Direction: Outbound

iv.    Mode: Asynchronous

v.    Message Types:

1.    Tracked Process Event Notification Create Confirmation

2.    Tracked Process Processing In – requests the creation or change of a tracked process.

• Maintain Tracked Process – request to create a new tracked process or update an existing tracked process

i.    Technical Name: TrackedProcessRequest_In

ii.    Namespace: http://sap.com/xi/EM/Global

iii.    Direction: Inbound

iv.    Mode: Asynchronous

v.    Available BAdI: Event Handler (create, update, delete) /SAPTRX/SE_EH_CRE_UPD_DEL

vi.    Message Types:

1.    Tracked Process Request

2.    Tracked Process Processing Out – sends confirmation of the creation of a tracked process.

• Confirm Tracked Process – confirms a request to create, change or delete a tracked process.

i.    Technical Name: TrackedProcessConfirmation_Out

ii.    Namespace: http://sap.com/xi/EM/Global

iii.    Direction: Outbound

iv.    Mode: Asynchronous

v.    Message Types: TrackedProcessConfirmation

We often get asked to suggest when to use web services vs. RFC / BAPI or IDocs. Here is the rule of thumb decision tree for you:

Use native RFC / BAPI Call if:

1. Event / EH is being created in an in-house SAP system

Use Web Service Call if:

1. Event is being sent from a 3rd party system in EPCIS format
2. If you are tracking serialized items
3. If your industry adopts EPCIS compliant messages to communicate events. E.g. Pharma

Use IDoc EVMSTA / EHPOST if:

1. Event is being sent from a 3rd party system in any format
2. You require error handling for event posting failures, using standard SAP business workflow
3. You require persistence of the interfaced data, for support and troubleshooting reasons

In our next installment of the SAP EM blog series we will run through some troubleshooting tips… Should be fun.