| Status | |
|---|---|
| Owner | The person responsible for driving this decision and documenting it. Type @ to mention people by name |
| Stakeholders | The business stakeholders involved in making, reviewing, and endorsing this decision. Type @ to mention people by name |
| Jira Request ID | |
| Jira Development ID |
High- Level Specification
| Implementing System | SAP ECC (PRS, Client 050) |
|---|---|
| Invokes | Standard Integration to SAP Ariba Sourcing via CIG |
| Business Process Reference |
Functional Overview
Supplier Master Data consists of general information stored in SAP that is used in SAP Ariba Sourcing solutions to construct Sourcing Projects and Sourcing Event. The SAP Ariba Sourcing Solutions provide the integration events for standard data imports from the SAP ERP System.
When you import large amounts of Master Data from your SAP System, ensure that you run the master data import task in the background. You can import Master Data by running integrations events manually from SAP Ariba Administrator.
For this implementation, Syensqo will integrate Master Data from SAP ERP System to the SAP Ariba Sourcing solutions 745255310 realm through SAP Ariba Cloud Integration Gateway (CIG) using Direct Connectivity.
This document describes SAP ERP System outbound interface for sending Supplier Master Data from SAP ERP System to SAP Ariba Sourcing System and will be exported via SAP Integration Suite, Managed Gateway for Spend Management and SAP Business Network (formerly known as Cloud Integration Gateway).
Scope and Objectives
CIG Add-On installed on SAP ERP has an embedded ARBCIG_MASTERDATA_EXPORT_PROGRAM which is used to extract Supplier data from SAP standard Supplier tables.
Below is the required Supplier Data for Ariba Guided Sourcing that need to be interfaced.
- SupplierConsolidated.csv
- SupplierConsolidated_Delete.csv
Process Flow Diagram
Step | Description | Comment |
|---|---|---|
1 | The execution of the extraction program is triggered as per the defined schedule in SAP PF2-050 (every 8 hours). | |
2 | When triggered, the program extracts the Supplier data according to the filtering criteria and functionality defined. Based on pre-defined development and data build requirements, additional data is transformed and included in the csv file. SupplierConsolidated.csv and/or SupplierConsolidated_Delete.csv is/are automatically created and zipped and stored in a defined sap temporary directory. | |
3 | The zipped Supplier CSV file/s embedded on the SOAP message is pushed to the CIG endpoint | |
4 | CIG then pushes the CSV file/s for upload to Ariba Sourcing |
Assumptions
- SAP ERP is able to extract the Supplier master data utilizing the extraction program embedded on CIG Add-on
- SAP ERP version is supported by CIG:
- SAP ERP 6.0
- SAP ERP 6.0 EhP2
- SAP ERP 6.0 EhP3
- SAP ERP 6.0 EhP4
- SAP ERP 6.0 EhP5
- SAP ERP 6.0 EhP6
- SAP ERP 6.0 EhP7
- SAP ERP 6.0 EhP8
Dependencies
- CIG Add-On installation and configuration in SAP ERP where Supplier data will be extracted
- CIG has been enabled on Ariba realm.
- CIG Certificate has been applied
- No dependency for Cloud Connector, as Cloud Connector is required for transactional data interfaces.
Security, Integrity and Controls
he following are the Security and Authorization considerations for this interface:
- Define a Web Services Security certificate and/or the shared secret key to use to secure the End Point connection.
- Access to interface parameters in SAP Ariba Sourcing are being addressed by Ariba standard security controls. Only authorized person with Ariba administrator’s role can access/ change interface parameters.
- Web service security configuration allows secure communications protocol provides a means for applying security to Web services.
Configuration Requirements
This section provides the configurations & settings required in SAP ERP / S4HANA and SAP Ariba to import Master Data in the SAP Ariba Procurement solution:
- Configure SAP Ariba Solutions for Synchronizing Master Data (SAP Ariba). Please refer to Configuration Workbook for CIG https://docs.google.com/document/d/1TaU152OT5KhjO16f0kdtScldVFkeGJGM/edit
- Maintain Parameters for SAP Ariba Procurement Solutions (SAP ERP)
- Maintain Filters for SAP Ariba Procurement Solutions (SAP ERP)
- Import Master Data from SAP ERP System to SAP Ariba Sourcing Solution
IN SAP ERP:
- Navigate to Integration with Other SAP Components > Ariba Cloud Integration Gateway > Master Data Integration > General Settings > Maintain Parameters using the transaction code SPRO.
- Expand Maintain Parameters section & click on IMG-Activity for Procurement – The Parameters – Ariba Procurement Master Data screen appears.
- Maintain the applicable parameters:
- CIG endpoint URL (as stated below) following the standard SOAP message structure
- CIG endpoint URL for Master Data (EU Data Center):
Test instance: https://testacig.ariba.com/cxf/receiveERPMD
Production instance: https://acig.ariba.com/cxf/receiveERPMD - Basic Authorization - setup with CIG PUser and password
- Parameters:
- CIG endpoint URL for Master Data (EU Data Center):
| realm | 7452310-SS-T | Sourcing realm ID in Supplemental site, a different realm ID would be used for Sourcing realm Test and Production sites |
| event | Import Batch Data | Constant Task or Event Name that triggers the Common Supplier data load in Ariba Buyer realm, which will then be replicated to Ariba Sourcing realm which is driven by the VendorPush parameters enabled in Ariba ICM (Intelligent Configuration Manager) page. |
| operation | Load | Incremental load, SupplierConsolidated.csv contains new and Updated supplier data while SupplierConsolidated_Delete.csv contains blocked or deleted supplier data |
| systemId | <*F2CLNT050> | This is the same ERP System ID - ECC or S4HANA setup in CIG |
| Solution | Buyer | |
| contentType | application.zip | |
| filename | <ImportBatchData zip filename embedded on the soap message> | |
| Content | Enccoded Base64 format of the attached zipped file |
- Below is the example payload request. Note that the value for the realm parameter will change based on the Ariba realm where the master data will be interfaced to.
Add / Update supplier sample:
Deactivated supplier sample:
4. Filter using the following conditions:
Equality and inclusion: where Option is EQ & Sign is I.
Ranges and exclusion: where Option is BT & Sign is E.
Patterns and comparisons: where Option is CP & Sign is I or E.
5. Currently custom attribute ZZR_ZLATR8 field in vendor master exists: if value = ZVN indicates obsolete vendor, if value = ZBY indicates Unauthorized vendor,
6. Click Save
Special Requirements
When a bidder has to be converted into a supplier, the process is described as under:
- The bidder / contact or supplier will have to be created in SAP PRS as a Supplier, a Unique Vendor ID will be created during this process.
- The mapping for Bidder (ACM_XXXXXX) and Supplier ERP ID will NOT be maintained on the standard ARBCIG_SYSTIDMAP table in SAP PRS. The Unique Vendor ID generated in PRS will be replicated to Ariba as buyersystemid and internalsupplierid domains after the successful upload. After that, the sap domain ID of the old bidder will be added and maintained manually, then the old bidder will be deactivated manually.
Design Rationale
This template section may be used to specify the custom API design. The requirement can be for an API provider which means the API will be designed in the system or can be for an API consumer which means that an API will be consumed in the system.
API Use
Populate the type of the API use in this section. Will the API be Consumed or Provided.
Data Structure
The following fields will be used to provide the required data structure of the interface:
NA
| Parent | Field | Description | Mandatory (Y/N) | Data Type |
|---|---|---|---|---|
Calculation and Validation
Populate the table below to list the calculation and validation rules per field
| Parent | Field | Rule Type | Rule Instruction |
|---|---|---|---|
Processing Logic
- A scheduled job (every 8 hours) runs in SAP PF2-050 to trigger ARBCIG_MASTERDATA_EXPORT_PROGRAM for Supplier data extraction.
- SupplierConsolidated.csv will be generated for new and updated suppliers while SupplierConsolidated_Delete.csv will be generated for blocked or deleted suppliers
- The Supplier CSV files will be zipped and embedded on the SOAP message and pushed to CIG endpoint. The zip filename can be anything but the recommendation is to have a date stamp (ImportBatchData_08012025.zip). See the sample files in the Appendix section.
Delta or Full Load Requirements
Please describe change tracking requirements, i.e. transferring only delta, or always full load
Interface Alert & Monitoring
The following should be monitored.
In Ariba:
- Interface status should be Completed - Ariba > Manage > Core Administration > Integration Manager or Site Manager > Data Import / Export > Search filter (Import Supplier Data) > Click on Status
- Interface status should be Completed - Ariba > Manage > Core Administration > Integration Manager or Site Manager > Data Import / Export > Search filter (Import Batch Data) > Click on Status
- Interface is active (both inbound, process and outbound component) in CIG - Ariba > Manage > Core Administration > Integration Manager > Managed Gateway for Spend&Network > Click on Visit the SAP Integration Suite, managed gateway for spend management and SAP Business Network (Europe DataCenter) > CIG Tool will open in a new web browser / tab - Click on Transaction Tracker > DocumentType (ProcurementMasterDataImport) > Click on Search button > Click on the Transaction Number
- For Failures - Download the payload from CIG via the same link mentioned on the above bullet point, check the XML payload parameters as well as decrypt the encoded zip file and validate the CSV file/s
- Messages are processed in reasonable time (XX elapse time) - it depends on the file size, 40MB is the maximum. Need to wait as well for the replication of the Supplier data between Procurement and Sourcing.
- All users with Customer Administrator access receives notification of successful or failed master data import from "aribasystem"
Language Requirements
Not Applicable
User Interface Requirements
Not Applicable
Volumetrics
Provide volumetrics details: Initial load volumes, Number of Records, Expected Frequency, Expected Long term Growth)
Performance Consideration
The maximum file size for a CSV or ZIP that is imported via the Ariba Administration area is 40MB, this applies to all Ariba solutions.
Error Handling
- Configure email notification alerts on the SAP Ariba application system to receive notification when an error occurs. This enables the administrator to log in to the SAP Ariba application to check the details of the errors.
- Directly log in to the SAP Ariba application, go to Administration or Core Administration > Integration Manager > CIG (Managed Gateway for Spend&Network) >
Visit the SAP Integration Suite, managed gateway for spend management and SAP Business Network (Europe Data Center) and check the details of the error. - Directly log in to the SAP Ariba application, go to Administration or Core Administration > Integration Manager or Site Manager > Import (Import Master Data Batch Pull) and check the details of the errors.
- To correct the error, the administrator must ensure that the data inconsistency is resolved in the ECC system and then must rerun the tasks for the Master Data again from the source system.
Testing
How to Test
Please provide some guidance and/or test data to help the developer unit test the interface. Please include both positive and negative testing (to validate error situations handling)
The developer will need to test repeatedly, so where appropriate provide instructions to reverse the actions performed so the test may be run again, or explain how to create new input data to the test. In particular, the developer will need logons for test users representing the various roles within the approval process.
Test Conditions and Expected Results
| ID | Condition | Expected Results |
|---|---|---|
| New Supplier is added in SAP ECC | Supplier Data will be loaded and reflected in Ariba Sourcing and Buying (Common Supplier Data) | |
| Supplier is updated in SAP ECC | Supplier updates will be loaded and reflected in Ariba Sourcing and Buying (Common Supplier Data) | |
| Supplier is marked for deletion in SAP ECC | Supplier will reflect as Deactivated in Ariba Sourcing and Buying (Common Supplier Data) |
Test Considerations/Dependencies
Test data need to be available in SAP ECC for extraction.
Other Information
The complete list of filters with usage is available in SAP Ariba Cloud Integration Gateway Configuration Guide under Working with Master Data > Importing Master Data for SAP Ariba Solutions section.
Development Details
Package
| Package Name | Parent Package |
|---|---|
Other Development Objects
| Object Type | Object Name | Purpose/High Level Logic | Design Rationale Reference |
|---|---|---|---|
Appendix
Sample compressed CSVs used in the sample XML payloads provided above :
See also
Insert links and references to other documents which are relevant when trying to understand this decision and its implications. Other decisions are often impacted, so it's good to list them here with links. Attachments are also possible but dangerous as they are static documents and not updated by their authors.
