| Description | Master Project KPI |
| Name | InboundInterfaceMasterProjectKPIAndAlertRequest |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Project Processing |
| Process Component Name | ProfessionalServicesProcessComponent |
| Process Component Namespace | http://sap.com/xi/AP/CRM/Global |
| Deploymnent Unit Description | Customer Relationship Management |
| Endpoint Activation | By Comunication Arrangeent | Operations |
| Release Status | Not Released |
An interface to maintain master project KPI data and alert data.
The web service interface II_MANAGE_MP_KPI_IN enables you to connect external applications to your SAP system and to update KPI details and alert of Master Project.
As master project is embedded on opportunity, so an opportunity instance is required.
Action codes represent an instruction to the recipient of the web service request to process transmitted message node elements.
| Action Code | Description |
|---|---|
| 01 | Create; the system returns an error message if the node element already exists. |
| 02 | Update; the system returns an error message if the node element does not exist. |
| 03 | Delete; the system returns an error message if the node element does not exist. |
| 04 | Save; the system creates or changes the node element data. |
| 05 | Remove; the system deletes the node element. If the node element does not exist, the system does not send an error message. |
| 06 | No Action; the system does not change the node element. |
Default action code: 04 (Save).
Note: Action code 04 (Save) creates business documents if the system can not identify a matching target business document. This applies in particular if no business document ID or UUID is provided by the web service consumer. The web service consumer (external application) is responsible for providing correct business document IDs or UUIDs. This will avoid accidentally creating duplicate business documents.
| Field | Description |
|---|---|
| Project UUID | External project UUID can determine the unique master project |
| Project ID | Master project name |
| Opportunity UUID | Parent opportunity UUID |
| KPI Details | KPI table |
| Project Alert | Project alert table |
| Field | Description |
|---|---|
| ID | KPI ID |
| Description | KPI description |
| Actual Data | Actual data |
| Planned Data | Planned data |
| Field | Description |
|---|---|
| Alert ID | Alert ID |
| Alert Value | Alert value |
Optional leaf notes in request messages that are not transmitted within a web service request are not changed in corresponding business documents.
This interface triggers RFC call of CPM system. All KPI data and alert data are returned from RFC export parameters, it means KPI and alert data are determined by CPM configuration. You must specify KPIs in CPM for communication user which is assigned in add-on destination.
Note: You can specify at most 7 KPIs in CPM system.
This interface is part of KPI and alert data synchronization. The whole scenario is started with a corresponding outbound interface, then it reachs external system and triggers the inbound interface after data processing. You can not process the inbound interface separately because you can not get the alternative key.
Example
Request:
<?xml version="1.0"?>
-<ns1:CPMMasterProjectKPIRequest xmlns:ns1="http://sap.com/xi/SAPGlobal20/Global">
<MessageHeader>
<ID>FA163ED10E711EE59899BF5518931B3C</ID>
<UUID>FA163ED1-0E71-1EE5-9899-BF5518931B3C</UUID>
<CreationDateTime>2015-09-22T04:02:29Z</CreationDateTime>
<SenderParty>
<InternalID schemeAgencyID="310" schemeID="LocalSystemID">Q5ECLNT004</InternalID>
</SenderParty>
<RecipientParty>
<InternalID schemeAgencyID="310" schemeID="LocalSystemID">0LO7GIO</InternalID>
</RecipientParty>
</MessageHeader>
<CPMOpportunityKPIRequestMessageDataType>
<BasicMessageHeader/>
<CPMOpportunityProjectRequest ActionCode="06">
<ProjectUUID>40f2e963-dc32-1ee5-8d88-5aedc7b12361</ProjectUUID>
<KPIDetails ActionCode="06">
<KPIID>ZJW1</KPIID>
<AcutalData currencyCode="USD">000000</AcutalData>
<PlannedData currencyCode="USD">000000</PlannedData>
</KPIDetails>
<KPIDetails ActionCode="06">
<KPIID>0APA</KPIID>
<AcutalData currencyCode="USD">0.00</AcutalData>
<PlannedData currencyCode="USD">0.00</PlannedData>
</KPIDetails>
<KPIDetails ActionCode="06">
<KPIID>0REA</KPIID>
<AcutalData currencyCode="USD">0.00</AcutalData>
<PlannedData currencyCode="USD">0.00</PlannedData>
</KPIDetails>
<KPIDetails ActionCode="06">
<KPIID>0WIP</KPIID>
<AcutalData currencyCode="USD">0.00</AcutalData>
<PlannedData currencyCode="USD">0.00</PlannedData>
</KPIDetails>
<ProjectAlert ActionCode="06">
<AlertID>0RM</AlertID>
</ProjectAlert>
<ProjectAlert ActionCode="06">
<AlertID>0MC</AlertID>
<AlertValue>0</AlertValue>
</ProjectAlert>
<ProjectAlert ActionCode="06">
<AlertID>0IS</AlertID>
<AlertValue>000000</AlertValue>
</ProjectAlert>
<ProjectAlert ActionCode="06">
<AlertID>0RM</AlertID>
</ProjectAlert>
</CPMOpportunityProjectRequest>
</CPMOpportunityKPIRequestMessageDataType>
</ns1:CPMMasterProjectKPIRequest>
There is no response message exist.
| Description | Request master project key performance indicator |
| Name | MaintainCPMKPIAndAlertInformation |
| Synchronous | no |
| Release Status | Released |
To create and update master project KPI data.
This interface is part of KPI and alert synchronization scenario. With MDRO run outbound interface is triggered and then will return KPI and alert data from external system by consuming an inbound interface.
The parent opportunity must be exist, as opportunity UUID is an alternative key to update master project, which can be determine by external project UUID of request message.
Communication with external system like CPM system.
| Field | Description |
|---|---|
| Project UUID | External project UUID can determine the unique master project |
| Project ID | Master project name |
| Opportunity UUID | Parent opportunity UUID |
| KPI Details | KPI table |
| Project Alert | Project alert table |
| Field | Description |
|---|---|
| ID | KPI ID |
| Description | KPI description |
| Actual Data | Actual data |
| Planned Data | Planned data |
| Field | Description |
|---|---|
| Alert ID | Alert ID |
| Alert Value | Alert value |
Parent opportunity is already created and the external system is available.
No additional description.
<?xml version="1.0"?>
<ns1:CPMMasterProjectKPIRequest xmlns:ns1="http://sap.com/xi/SAPGlobal20/Global">
<MessageHeader>
<ID>FA163ED10E711EE597A18CDB89EC19DC</ID>
<UUID>FA163ED1-0E71-1EE5-97A1-8CDB89EC19DC</UUID>
<CreationDateTime>2015-09-17T09:19:15Z</CreationDateTime>
<SenderParty>
<InternalID schemeAgencyID="310" schemeID="LocalSystemID">Q5ECLNT004</InternalID>
</SenderParty>
<RecipientParty>
<InternalID schemeAgencyID="310" schemeID="LocalSystemID">0LO7GIO</InternalID>
</RecipientParty>
</MessageHeader>
<CPMOpportunityKPIRequestMessageDataType>
<BasicMessageHeader/>
<CPMOpportunityProjectRequest ActionCode="06">
<ProjectUUID>40f2e963-dc32-1ee5-979f-fc5398842ba3</ProjectUUID>
<KPIDetails ActionCode="01">
<KPIID>0APC</KPIID>
<AcutalData currencyCode="USD">0.00</AcutalData>
<PlannedData currencyCode="USD">0.00</PlannedData>
</KPIDetails>
<ProjectAlert ActionCode="01">
<AlertID>0IS</AlertID>
<AlertValue>000000</AlertValue>
</ProjectAlert>
<ProjectAlert ActionCode="01">
<AlertID>0MC</AlertID>
<AlertValue>0</AlertValue>
</ProjectAlert>
<ProjectAlert ActionCode="01">
<AlertID>0RM</AlertID>
</ProjectAlert>
</CPMOpportunityProjectRequest>
</CPMOpportunityKPIRequestMessageDataType>
</ns1:CPMMasterProjectKPIRequest>
It is necessary to update PI configuration when request message structure is updated, and regenerate the on promise proxy.
This interface is used to create and update KPI and alert data.
You can not use this interface separately but with a corresponding outbound interface and send the external project UUID to external system.
Show full documentation
Show full documentation