Interface Functional Design C4C.I.002

Transcription

1 Interface Functional Design C4C.I.002 Opportunity Query Interface CallidusCloud CPQ C4C Integration Project Version 0.5

2 Table of Contents Document Information 2 Overview and Scope 3 Functional Overview 3 Detailed Functional Requirements 4 Functional Specification 4 Process Flow Diagram 6 Field Mapping from Source to Destination 7 Technical Specifications 13 Creation of Communication System 13 Creation of Communication Arrangement 14 Overview of the Process Steps 15 Creation of New Project in HCP IS 15 Develop an integration flow diagram 17 Import WSDLs and schema files 23 Create message mapping 24 Configure Channels 25 Deployment of Artifact 28 1

3 1 Document Information FD Document Name C4C.I.002 Interface Name Opportunity Query interface Sub-Process Sales Quote update Complexity High Source System SAP C4C Destination System Callidus Cloud CPQ Target Environment 2

4 2 Overview and Scope 2.1 Functional Overview This functional design covers the requirement of passing opportunity data including account and contact to CallidusCloud CPQ from C4C. To use the pricing functionality provided by CallidusCloud CPQ system, specific data from C4C must be sent quote creation. This task would utilize a web service call from CPQ to SCP-IS for getting the data from C4C. The data required to create a quote in CPQ would include details from the opportunity, e.g. involved parties (Ship-to party, Bill-to party and end-user), address information, account (customer) and contact details. Detailed Requirements Requiremen t ID Business Process/Strea m Short Description Description Requirement Type 1 Opportunity Management Get account Details Get the details of the customer and involved parties from opportunity to the Callidus cloud CPQ Quote Functional 2 Opportunity Management Get contact details Get the contact details from the C4C opportunity Functional 3 Opportunity Management Get opportunity details Get opportunity header details to be updated in Callidus cloud CPQ quote Functional Gap in Standard SAP Filled by This Item N/A Solution Alternatives The alternative solution would have kept the involved parties data and the account/contact information in CPQ system. This option is not accepted by Callidus due to technical and performance constraints Proposed Solution The solution made is that Callidus CPQ would be making service calls to SCP IS to obtain the opportunity data from C4C based on opportunity ID. 3

5 The service calls can be made under two possible scenarios. One is when the service is being called during the creation of a new quote in the CPQ system. The second scenario is when the CPQ quote is being updated (provided that relevant configurations are made in CPQ). The required opportunity, involved parties (account) and contact information are fetched from C4C by the proposed web service call. A single service call originates from the CPQ system (based on the opportunity ID.) Then, the SCP (IS) layer / middleware makes subsequent calls to C4C to get the involved parties and contact address details. The responses are designed to be combined at the middleware and to be sent back in one single response to CallidusCloud CPQ. 2.2 Business Benefit The business users need not maintain (or input) involved parties data and opportunity-related information in CallidusCloud CPQ quote and can only focus on the pricing functionality that the CPQ system provides. In the case of any subsequent updates in the source system (changes of address, etc.), this information is sent to the corresponding CallidusCloud CPQ quote. 2.3 Scope Functionality The interface to be used to get the opportunity, contacts and involved parties (account) details from the C4C system to update the CPQ Quote Region or Localization Considerations N/A: As part of the product integration, this is not in scope and any such consideration would be handled by the implementation partner. 2.4 Dependencies/Constraints The response from a query with partner details depends on the configuration of the involved parties for C4C opportunity. The involved parties data has to be maintained in C4C accordingly. 2.5 Assumptions The master data for accounts has been maintained with complete address information. Involved parties have been maintained in C4C opportunity. For synchronizing existing quotes in CPQ with the latest contact / involved parties data, the required workflow actions should be configured in the source system (CPQ). 3 Detailed Functional Requirements 3.1 Functional Specification The CPQ quote creation requires opportunity, contacts and involved parties information from SAP Hybris C4C system. This is accomplished by a web service call from CPQ to SCP IS. From the application 4

6 standpoint, the web service endpoints and actions differ in case of new CPQ quote and existing CPQ quote and hence two different artifacts are created in both C4C and CPQ systems. The two artifacts are: 1) Get Opportunity Details for New CPQ Quote 2) Get Opportunity Details for Existing CPQ Quote Process for getting opportunity details for a new quote: A) As soon as the user navigates to the Callidus CPQ landing page / tab in C4C opportunity, the following parameters are passed to Callidus CPQ: a) Opportunity ID b) Sold-to Party / Customer (Account) ID B) As the user opens the CPQ tab for the first time for a given opportunity, in order to get the relevant data for a CPQ quote from C4C, the CPQ system makes a web service call to SCP IS. C) The web service request reaches C4C via SCP IS middleware and the opportunity query web service is invoked in C4C. Then, the query web service sends the following opportunity header details and involved parties IDs and their respective Primary Contact ID to get them to the middleware (SCP IS): C4C Opportunity Data Customer / Account ID (Sold-to party) C4C Code for Ship-to party C4C code for Bill-to party C4C code for End customer C4C code for Ship-to party s Primary Contact C4C code for Bill-to party s Primary Contact C4C code for End customer s Primary Contact D) At the middleware, each involved party ID is collected, and the subsequent serial calls to C4C get the address details. E) The opportunity and account information received in the response at the SCP IS layer are consolidated, and a combined response is sent back to CPQ to update the given CPQ quote. Process for getting opportunity details for an existing quote: A) As the user opens the CPQ tab to edit an existing opportunity, it triggers a workflow action in the CPQ system to make a web service call to C4C. B) The web service request reaches C4C via SCP IS middleware and the opportunity query web service is invoked in C4C. Then, the query web service carries the following opportunity header details and involved party IDs and their respective primary contact ID back to the middleware (SCP IS): 5

7 C4C Opportunity Data Customer / Account ID (Sold-to party) C4C Code for Ship-to party C4C code for Bill-to party C4C code for end customer C4C code for Ship-to party s Primary Contact C4C code for Bill-to party s Primary Contact C4C code for End customer s Primary Contact C) At the middleware, each involved party ID is collected, and the subsequent serial calls to C4C get the address details. D) The opportunity and account information received in the response at the SCP IS layer are consolidated, and a combined response is sent back to CPQ to update the given CPQ quote. 3.2 Process Flow Diagram Process flow for getting opportunity details for New Quote in CPQ Process flow for getting opportunity details for existing quote in CPQ 6

8 3.3 Initiating Process/Transaction/Program Real time interface 3.4 Security Requirements N/A 3.5 System Details and Direction Interface Type: A2X (Application to X Users) Direction: Inbound and Outbound Source System: CallidusCloud CPQ Destination System: SAP Hybris C4C Middleware : SCP - IS 3.6 Proposed Transfer Method / Program Transfer Method (SAP): Webservice (ODATA/SOAP) Transport Protocol to partner system: N/A Justification of proposed methods : N/A 3.7 Field Mapping from Source to Destination Mapping fields from C4C Opportunity and Involved parties to CPQ SAP fields, where to map from CPQ fields, where to map 7

9 1 /OpportunityDetails/Opportunity/Name /OpportunityDetails/Header/CustomFields/Opportu nityname 2 /OpportunityDetails/Opportunity/ID /OpportunityDetails/Header/CustomFields/Opportu nityid 3 No one for first phase, it is configurable /OpportunityDetails/ BillTo /CustomFields/CustomFi eld/name 4 No one for first phase, it is configurable /OpportunityDetails/ BillTo /CustomFields/CustomField/Value 5 /OpportunityDetails/BillTo/Customer/Organisation/Fi rstlinename /OpportunityDetails/ BillTo /FirstName 6 /OpportunityDetails/BillTo/Customer/Organisation/S econdlinename 7 /OpportunityDetails/BillTo/Customer/AddressInform ation/address/postaladdress/streetprefixname 8 /OpportunityDetails/BillTo/Customer/AddressInform ation/address/postaladdress/additionalstreetprefixn ame 9 /OpportunityDetails/BillTo/Customer/AddressInform ation/address/postaladdress/cityname 10 /OpportunityDetails/BillTo/Customer/AddressInform ation/address/postaladdress/regioncode 11 /OpportunityDetails/BillTo/Customer/AddressInform ation/address/postaladdress/countrycode 12 /OpportunityDetails/BillTo/Customer/AddressInform ation/address/postaladdress/streetpostalcode 13 /OpportunityDetails/BillTo/Customer/AddressInform ation/address/telephone/formattednumberdescript ion /OpportunityDetails/ BillTo /LastName /OpportunityDetails/ BillTo /AddressLine1 /OpportunityDetails/ BillTo /AddressLine2 /OpportunityDetails/ BillTo /City /OpportunityDetails/ BillTo /State /OpportunityDetails/ BillTo /Country /OpportunityDetails/ BillTo /ZipCode /OpportunityDetails/ BillTo /Phone 8

10 14 /OpportunityDetails/BillTo/Customer/AddressInform ation/address/facsimileformattednumberdescriptio n 15 /OpportunityDetails/BillTo/Customer/AddressInform ation/address/ /uri /OpportunityDetails/ BillTo /Fax /OpportunityDetails/ BillTo / 16 /OpportunityDetails/Opportunity/BillTo/AccountID /OpportunityDetails/ BillTo /CRMAccountId 17 /OpportunityDetails/Opportunity/BillTo/PrimaryCont actid /OpportunityDetails/ BillTo /CRMContactId 18 No one for first phase, it is configurable /OpportunityDetails/ ShipTo /CustomFields/CustomF ield/name 19 No one for first phase, it is configurable /OpportunityDetails/ ShipTo /CustomFields/CustomField/Value 20 /OpportunityDetails/ShipTo/Customer/Organisation/ FirstLineName /OpportunityDetails/ ShipTo /FirstName 21 /OpportunityDetails/ShipTo/Customer/Organisation/ SecondLineName 22 /OpportunityDetails/ShipTo/Customer/AddressInfor mation/address/postaladdress/streetprefixname 23 /OpportunityDetails/ShipTo/Customer/AddressInfor mation/address/postaladdress/additionalstreetprefi xname 24 /OpportunityDetails/ShipTo/Customer/AddressInfor mation/address/postaladdress/cityname 25 /OpportunityDetails/ShipTo/Customer/AddressInfor mation/address/postaladdress/regioncode 26 /OpportunityDetails/ShipTo/Customer/AddressInfor mation/address/postaladdress/countrycode /OpportunityDetails/ ShipTo /LastName /OpportunityDetails/ ShipTo /AddressLine1 /OpportunityDetails/ ShipTo /AddressLine2 /OpportunityDetails/ ShipTo /City /OpportunityDetails/ ShipTo /State /OpportunityDetails/ ShipTo /Country 9

11 27 /OpportunityDetails/ShipTo/Customer/AddressInfor mation/address/postaladdress/streetpostalcode 28 /OpportunityDetails/ShipTo/Customer/AddressInfor mation/address/telephone/formattednumberdescri ption 29 /OpportunityDetails/ShipTo/Customer/AddressInfor mation/address/facsimileformattednumberdescripti on 30 /OpportunityDetails/ShipTo/Customer/AddressInfor mation/address/ /uri /OpportunityDetails/ ShipTo /ZipCode /OpportunityDetails/ ShipTo /Phone /OpportunityDetails/ ShipTo /Fax /OpportunityDetails/ ShipTo / 31 /OpportunityDetails/Opportunity/ShipTo/AccountID /OpportunityDetails/ ShipTo /CRMAccountId 32 /OpportunityDetails/Opportunity/ShipTo/PrimaryCon tactid /OpportunityDetails/ ShipTo /CRMContactId 33 No one for first phase, it is configurable /OpportunityDetails/ EndUser /CustomFields/Custo mfield/name 34 No one for first phase, it is configurable /OpportunityDetails/ EndUser /CustomFields/Custo mfield/value 35 /OpportunityDetails/EndUser/Customer/Organisation /FirstLineName /OpportunityDetails/ EndUser /FirstName 36 /OpportunityDetails/EndUser/Customer/Organisation /SecondLineName 37 /OpportunityDetails/EndUser/Customer/AddressInfor mation/address/postaladdress/streetprefixname 38 /OpportunityDetails/EndUse/Customer/AddressInfor mation/address/postaladdress/additionalstreetprefi xname 39 /OpportunityDetails/EndUser/Customer/AddressInfor mation/address/postaladdress/cityname /OpportunityDetails/ EndUser /LastName /OpportunityDetails/ EndUser /AddressLine1 /OpportunityDetails/ EndUser /AddressLine2 /OpportunityDetails/ EndUser /City 10

12 40 /OpportunityDetails/EndUser/Customer/AddressInfor mation/address/postaladdress/regioncode 41 /OpportunityDetails/EndUser/Customer/AddressInfor mation/address/postaladdress/countrycode /OpportunityDetails/ EndUser /State /OpportunityDetails/ EndUser /Country 42 /OpportunityDetails/EndUser/Customer/AddressInfor mation/address/postaladdress/streetpostalcode 43 /OpportunityDetails/EndUser/Customer/AddressInfor mation/address/telephone/formattednumberdescri ption 44 /OpportunityDetails/EndUser/Customer/AddressInfor mation/address/facsimileformattednumberdescripti on 45 /OpportunityDetails/EndUser/Customer/AddressInfor mation/address/ /uri 46 /OpportunityDetails/Opportunity/EndCustomer/Acco untid 47 /OpportunityDetails/Opportunity/EndCustomer/Prim arycontactid /OpportunityDetails/ EndUser /ZipCode /OpportunityDetails/ EndUser /Phone /OpportunityDetails/ EndUser /Fax /OpportunityDetails/ EndUser / /OpportunityDetails/ EndUser /CRMAccountId /OpportunityDetails/ EndUser /CRMContactId Post-Interface Activities N/A 3.8 Custom Tables/Fields Specifications NA 3.9 Initial Data Set-Up, Conversion Requirements NA 3.10 Configuration Requirements NA 11

13 3.11 Language Considerations Decision is to go ahead with default EN language Reporting NA 3.12 Error Handling There is a standardized error format developed to capture application and business errors in C4C and SCP(IS). Below are the status codes expected from the CPQ system. 200 OK. Opportunity details found. 401 Unauthorized. In case when integration user credentials were not provided. 404 Object not found. In case service is not available. 501 Internal server error. Below are the expected technical errors: Error Other than application errors Application errors How to Handle Errors are captured in the response and can be handled. All the application errors are captured in web service message monitoring of SAP Hybris C4C Security and Authorization No special security required Reconciliation Procedures and Audit Requirements Approach NA Metrics NA 12

14 3.15 Processing and Operational Considerations Processing Type Real time update of data Transaction Volume NA Frequency and Timing TBD, dependent on the implementing customer Performance Batch Requirements NA Data Maintenance Requirements NA Re-use Details NA Multi-company, Multi-jurisdiction Considerations NA 4 Technical Specifications 4.1 Creation of Communication System For the exchange of data between C4C and CPQ systems, a communication system is created in C4C with a host name provided as the iflmap URL of the HCP IS system. HostName: (HCP IS Tenant URL based on the environment) Business System ID: CLDS_HCI 13

15 4.2 Creation of Communication Arrangement Create communication arrangement to link communication scenario and the System HCI created in previous steps. For current integration object, Query Accounts integration scenarios is used. Set Authentication Method to User ID and Password and Maintain Password. 14

16 4.3. Overview of the Process Steps Process Step No. PS1 PS2 PS3 PS4 Name Description Classification Create Integration project in SCP IS Develop integration flow diagram Import WSDLs and schema files Create message mapping Create new integration project in SCP IS through WebIDE/Eclipse Model IFlow based on Requirement Import all files which are used for message mapping Map source and target fields for data flow PS5 Configure Channels Configure sender and receiver channels New PS6 Deploy the artifact Deployment of artifact New New New New Creation of New Project in HCP IS Classification New Change of Existing Step Reuse of Existing Step Objective To create a new project in SCP IS through WebIDE/Eclipse. Involved Users Trigger Precondition Post-condition End User Interaction with the System N/A SCP IS developer is provided with the authorization to create artifact The Opportunity ID from CPQ system should be valid and present in C4C system. End user is not involved directly 1. Create an Integration Project in Eclipse. Go to File New Integration Project, enter the details of the project and click Next. 15

17 Select Point-to-Point Channel pattern for the integration project and click Finish. Integration project gets created with the below folders. 16

18 Develop an integration flow diagram Open the integration flow file and model it like below. Main Integration Process Step 1: Through header, opportunity id will be passed from CPQ. In SCP IS, using a request reply service call, Opportunity id will be passed to query the C4C opportunity through ODATA adapter. Step 2: Add a Router to check whether Opportunity Collection is returned or not. 17

19 A router is added to check whether opportunity Collection is returned or not based on router condition. Condition: Opportunity node is not empty - Proceed to Step 3. Default route - Frame Error response and end the process. Response: When Opportunity ID doesn t exist in C4C. Response: When Opportunity ID is not passed. Step 3: Add a filter to filter Opportunity Node. Step 4: Add Content Modifier and create following properties to store the Opportunity response body details, BillToParty, SoldToParty, EndCustomer from C4C system. The results obtained from query opportunity needs to be stored in content modifier to get the following details from opportunity query response with following properties: 18

20 Step 5: Add a script to query Account to get BillToParty information. Query the Account master to get the BillToParty details such as customer name and address information. To query the C4C Account using BillToParty s BusinessPartnerInternalID, a groovy script needs to be written to frame the request payload. Using local integration process created, a process call is made and the request payload will be sent to C4C receiver through SOAP channel adapter and the corresponding response will be stored as BillToRequestPayload in the following content modifier. Steps for writing a script: import jar file and utilities def Message def properties Get BillToParty AccountID If BillToParty not null Define BillToRequestPayload set Body(BillToRequestPayload) return message. Step 6: Creation of Query Account Integration Process (Local Integration Process) A local integration process that will be called in further steps needs to be created. This process call will check the incoming requests based on the following router condition expression. 1. //LowerBoundaryInternalID!='' (If the incoming request is a new webservice call to C4C) 2. //Customer!='' (If Party ID has already been queried) 3. Default Route (If Party ID is not present) 19

21 If the condition expression (1) is valid, then C4C Account query will be executed using Request-Reply service and pass the response to the next router which will check the following conditions: 1. Account Query Successful: This will Filter Customer node and the response will go to the next content modifier which is maintained as default route. 2. Account Query Fails: This will end the local process based on the router condition (//ReturnedQueryHitsNumberValue='0 ) and continue to the process flow. If the condition expression (2) is valid, then end the event. If the condition expression (3) is valid, then clear the payload body and end the event. Step 7: Call the local integration process created in previous step. Step 8: Add a Content Modifier and create a BillToResponse property to store response from Bill to party Query. The results obtained from query Account to get BillToParty details need to be stored in the content modifier with the following property: Step 9: Add a script to query Account to get ShipToParty information. Query the Account master to get the ShipToParty details such as Name and Address information. 20

22 To query the C4C Account using ShipToParty s BusinessPartnerInternalID, a groovy script needs to be written to frame the request payload. Using the local integration process created in the previous step, a process call is made and the payload is sent to a C4C receiver through the SOAP channel adapter and the corresponding response is stored as ShipToRequestPayload in the following content modifier. Steps for writing a script: import jar file and utilities Define Message Define properties Get ShipToPartyID and BillToPartyID If ShipToPartyID equals BillToPartyID Setproperty ShipToResponse to BillToResponse Else Define ShipToRequestPayload set Body(ShipToRequestPayload) return message. Step 10: Add Content Modifier and create ShipToResponse property to store response from Account Query. The results obtained from query Account to get ShipToParty need to be stored in the content modifier with the following property: Step 11: Add a script to query Account to get EndCustomer information. 21

23 Query the Account master to get the End Customer details such as Name and Address information. To query the C4C Account using EndCusomer s BusinessPartnerInternalID, a groovy script needs to be written to frame the request payload. Using the local integration process created in the previous step, a process call is made and the payload is sent to a C4C receiver through the SOAP channel adapter and the corresponding response is stored as EndCustomerRequestPayload in the following content modifier. Steps for writing a script: import jar file and utilities Define Message Define properties Get ShipToPartyID, EndCustomer and BillToPartyID If EndCustomer equals BillToPartyID Setproperty EndCustomerResponse as BillToResponse Else if EndCustomer equals ShipToPartyID Setproperty EndCustomerResponse as ShipToResponse Else Define EndCustomerRequestPayload set Body(EndCustomerRequestPayload) return message. Step 12: Add a Content Modifier and create EndCustomerResponse property to store response from Account Query. The results obtained from query Account to get End Customer Information need to be stored in the content modifier with the following property: Step 13: Add a script to get a combined response. The response obtained from querying opportunity and Account to get opportunity body information, BillToParty, ShipToParty and EndCustomer details, which have been stored in the content modifier, are combined to get the final response payload. A groovy script needs to be written to frame the request payload. 22

24 Import WSDLs and schema files Classification New Change of Existing Step Reuse of Existing Step Objective To Import all files which are used for message mapping Involved Users Trigger Precondition Post-condition End User Interaction with the System N/A There should be placeholder for each opportunity field coming from C4C in CPQ system. The Opportunity ID from CPQ system should be valid and present in C4C system. End user is not involved directly 23

25 Create message mapping Classification New Change of Existing Step Reuse of Existing Step Objective To map source and target fields for data flow Involved Users Trigger Precondition Post-condition End User Interaction with the System N/A There should be placeholder for each opportunity field coming from C4C in CPQ system. The Opportunity ID from CPQ system should be valid and present in C4C system. End user is not involved directly This is done to map source and target fields. Four mappings are created in this artifact. a) Create Message Mapping. b) Import CombinedResponse schema as Source and GetOpportunityDetailsForNewQuote schema as Target. 24

26 Refer to section 5.7 to see corresponding mapping between source and target fields Configure Channels Sender and Receiver channel need to be configured with below details to receive and send data in correct format. A) Sender s Channel : The following configurations need to be done on the sender s adapter: Adapter Type: HTTPS Transport Protocol: HTTPS Adapter Specific Connection: Address: Provide artifact path Authorization: User Role ( ESBMessaging.send) General: 25

27 Adapter Specific : General: B) Receiver Adapter: For Opportunity Query: The following configurations need to be done on the adapter: Adapter Type: ODATA Transport Protocol: HTTPS Message Protocol: Odata V2 Adapter Specific Connection Details: Address: C4C Odata service Url Proxy Type: Internet Authentication: Basic Credential Name: c4c_credentials (Provide deployed credential name) Adapter Specific Processing Details: Operation Details: Query (GET) Resource Path: OpportunityCollection Query Options: $expand=opportunityinvolvedparties&$filter=opportunityid eq '${header.opportunityid}' 26

28 Adapter Specific: For Account Query: The following configurations need to be done on the sender s adapter: Adapter Type: SOAP Transport Protocol: HTTPS Message Protocol: SAP1.x/SAP RM Adapter Specific Connection: Address: C4C Inbound Address Proxy Type: Internet Authentication: Basic Credential Name: artifact_credentials (Provide a deployed credential name.) 27

29 General : Adapter Specific for Account Query: Deployment of Artifact Classification New Change of Existing Step Reuse of Existing Step Objective To deploy the artifact Involved Users Trigger Precondition N/A Iflow should be saved 28

30 Post-condition End User Interaction with the System N/A End user is not involved directly After the completion of development, the artifact is ready to deploy. 29