| Status | Approved |
|---|---|
| Owner | ROWLINSON-ext, Kerry |
| Stakeholders | |
| Jira Request ID | ERP-2583 - Getting issue details... STATUS |
| Jira Development ID | ERP-2611 - Getting issue details... STATUS |
High- Level Specification
| Parameter | Value |
|---|---|
| Application System | SAP ECC (both PF2 & WP2) |
| Business Process Reference | Not applicable |
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. Supplier Master Data is integrated from SAP ERP System to the SAP Ariba Sourcing solutions realms through SAP Ariba Cloud Integration Gateway (CIG) using Direct Connectivity. ERP-116 System Interface - Supplier Integration from SAP ECC (PRS) to Ariba details this integration.
The Ariba CIG Add-On is installed on SAP ERP and configuration completed to enable the program ARBCIG_MASTER_DATA_EXPORT to extract Supplier data from SAP standard Supplier tables.
The enhancements to ARBCIG_MASTER_DATA_EXPORT described in this functional specification are for two purposes:
- Two additional fields are required to be included in the CSV file sent to Ariba. in order to integrate the Ariba Catalog with EZBuy
CustomDomainName
CustomDomainValue - The value for the field 'State' is required to be changed to provide Ariba with the description of the State (region) instead of the SAP code as there is no mapping of country and region in SAP Ariba Sourcing.
The custom development will be done to extend the Ariba CIG Master data export (ARBCIG_MASTER_DATA_EXPORT) via BADI to add custom fields in the extract file.
Justification
The integration with Ariba Catalog with EzBuy will not be possible without the additional fields for the domain name and value being provided in the export file. With the integration of the supplier data from SAP being an automated process, manual updates to fill the sap domain field in Ariba are not feasible. In the standard CIG integration from ECC to Ariba, only internsupplierid and buyersystemid domain are automatically populated with SAP PRS ID. To integrate Ariba Catalog with EZBuy, sap domain is also required. However, this sap domain is not populated via the standard integration.
The mapping of country to region is not supported in the backend of SAP Ariba Sourcing. It is only available in Ariba Supplier Lifecycle and Performance (SLP). Without this mapping the region description cannot be displayed in the supplier address. Whilst sometimes these are recognizable abbreviations, in SAP some of the values for region are meaningless two-digit codes which are unsuitable for address formatting.
Alternatives considered
No suitable alternatives identified, SAP recommended consulting to update the export program with the additional fields. Manual updates are possible but unsuitable due to the automatic integration of new and changed supplier records.
Scope and Objectives
The standard SAP program ARBCIG_MASTER_DATA_EXPORT does not provide any configuration option to add additional fields or to control the use of the region code versus the description. SAP provides a BADI for these purposes. The purpose of this enhancement is to add the additional fields to enable the operation of the Ariba Catalog with EZBuy; and to ensure that the supplier addresses are correctly formatted in relation to the Region/State by exporting the Region description from SAP, rather than the two-character code.
Process steps:
Step | Description | Comment |
|---|---|---|
| 1 | New suppliers or changes to existing supplier records in SAP PRS system | Scheduled background job produces a supplier.csv file with details of the new and changed suppliers (LFA1 Vendor Client Level table only). The job details are based on the defined configuration for the supplier master data export to Ariba. |
| 2 | Supplier.csv file is sent via the managed gateway (CIG) to Ariba | The file is received via the managed gateway CIG to Ariba |
| 3 | File is processed creating new suppliers or changing existing suppliers in the parent realm in Ariba | File is processed in the parent realm in Ariba for use in Ariba Sourcing |
| 4 | File is processed creating new suppliers or changing existing suppliers in the child realm in Ariba | File is processed in the child realm in Ariba for use in Ariba Catalogs |
Assumptions
There are no identified assumptions.
Dependencies
There are no dependencies on this enhancement or on the integration of the supplier data. The Ariba CIG export for suppliers was specifically set up for the integration to Ariba for Syway, it was not in use at all prior and therefore these changes impact no other system receiving the supplier information.
Security, Integrity and Controls
There are no specific security, integrity or controls required for this enhancement.
Configuration Requirements
There are no additional configuration requirements associated with this enhancement.
Language Requirements
Region descriptions are held in SAP in multiple languages, only EN English description will be selected by this enhancement.
Special Requirements
There are no special requirements to be considered.
Design Rationale
Functional Requirements
- Two additional fields are required to be included in the CSV file sent to Ariba. in order to integrate the Ariba Catalog with EZBuy
CustomDomainName
CustomDomainValueThe field CustomDomainName is to have a constant value ‘sap’. The other field CustomDomainValue will contain the PRS Vendor ID. These fields will be available in the files produced in the full export and in the incremental load.
These two additional fields will be in columns Q & R in the consolidated .csv file.
- The value for the field 'State' is required to be changed to provide Ariba with the description of the State (region) instead of the SAP code as there is no mapping of country and region in SAP Ariba Sourcing.
Instead of the region code in column G of the consolidated file, logic in the user exit is to look up the description of the region/state based on the country in column H. In SAP, look up table T005U, always in EN English, with Country Code and Region Code to retrieve Description field (T005U-BEZEI). Due to the standard design of CIG, the standard field for Region under State (column G) will be renamed to std_State. Region description will be stored as State and as a new column after CustomDomainValue. In Ariba, the column 'std_State' will be ignored and the new column labelled 'State' will be loaded.
Proposed Technology to Use
Badi Name: ARBCIG_MASTERDATA
Available to enhance the Master Data Upload Request as required. Available in the ARBCIG_MASTER_DATA_EXPORT program.
Method PUBLISH_VENDOR will be used to enhance the vendor output.
Add the custom fields identified above to ARBCIG_VENDOR via Append Structure.
ARBCIG_FIELDMAP to be configured to link the new State field to the existing state field.
Data Source Considerations
Not applicable for this enhancement.
| Table | Field Name | Comments/Calculation/Field Manipulation |
|---|---|---|
Data Validation Considerations
There are no data validations required for this enhancement.
| Table | Field Name | Comments/Calculation/Field Manipulation |
|---|---|---|
Custom Tables
Not applicable for this enhancement.
Master Data
Not applicable for this enhancement.
| Field | Description | Data Type/Length | Validation rule/ Value Help |
|---|---|---|---|
Configuration Table
Not applicable for this enhancement.
| Field | Description | Data Type/Length | Validation rule/ Value Help |
|---|---|---|---|
Selection Screen Enhancement
Not applicable for this enhancement.
| Field Name | Description | Select: | Data Type/Length | Default Value/ Validation rule/ Value Help | Selection Logic |
|---|---|---|---|---|---|
Processing Logic
- Two additional fields are required to be included in the CSV file sent to Ariba. in order to integrate the Ariba Catalog with EZBuy
CustomDomainName
CustomDomainValueThe field CustomDomainName is to have a constant value ‘sap’. The other field CustomDomainValue will contain the PRS Vendor ID. These fields will be available in the files produced in the full export and in the incremental load.
These two additional fields will be in columns Q & R in the consolidated .csv file.
- The value for the field 'State' is required to be changed to provide Ariba with the description of the State (region) instead of the SAP code as there is no mapping of country and region in SAP Ariba Sourcing.
Instead of the region code in column G of the consolidated file, logic in the user exit is to look up the description of the region/state based on the country in column H. In SAP, look up table T005U, always in EN English, with Country Code and Region Code to retrieve Description field (T005U-BEZEI). Due to the standard design of CIG, the standard field for Region under State (column G) will be renamed to std_State. Region description will be stored as State and as a new column after CustomDomainValue. In Ariba, the column 'std_State' will be ignored and the new column labelled 'State' will be loaded.
Volumetrics
The initial export of suppliers is expected to be approximately 48,000 records (based on a selection of 47,000 for user acceptance testing in the test environment). The expected volume for the incremental loads is expected to be less than 100 records on average. The background job to identify new and changed records since the previous job is scheduled to run every 2 hours.
Performance Considerations
There are no specific performance considerations to take into account.
Error Handling
There are no specific error scenarios to handle for this enhancement. Once it is in place, the CIG integration will operate as intended. There always has to be a region and a supplier number in the SAP data in the supplier master record in table LFA1.
Testing
How to Test
This can only be tested by running the ARBCIG_MASTER_DATA_EXPORT program in SE38 in test mode to produce a file. The incremental load is tested by the background job and can only be checked if the full supplier export has been completed.
Note that the full supplier export has been completed in both the DF2/050 and QF2/050 environments, so test mode only is available in those environments. Note also that configuration and data changes MUST BE MADE before execution of the program in update mode in the DF2/050 environment in order to ensure a high volume of supplier records are not sent to the Ariba supplemental realm.
Concurrently to the build and functional test of this enhancement, configuration changes for change request CR0466 are being made to send .csv supplier file to the Ariba Child Realm. Therefore, validation of these changes in DF2 and QF2 must be made in conjunction with the testing of CR0466 (ERP-116 System Interface - Supplier Integration from SAP ECC (PRS) to Ariba) changes.
Test Conditions and Expected Results
| ID | Condition | Expected Result |
|---|---|---|
| 1 | Execute ARBCIG_MASTER_DATA_EXPORT in test mode | .CSV file produced with Region Description in Column G (State) and column Q filled with correct CustomDomainName & column R filled with correct CustomDomainValue |
| 2 | Complete a vendor name/address change | The next scheduled incremental job produces a .CSV file with Region Description in Column G (State) and column Q filled with correct CustomDomainName & column R filled with correct CustomDomainValue |
Test Considerations/Dependencies
Test in conjunction with the testing of CR0466 (ERP-116 System Interface - Supplier Integration from SAP ECC (PRS) to Ariba) changes.
Other Information
No further information identified.
Development Details
Package
| Package Name | Parent Package |
|---|---|
| ZWPU_5_08 | Main Package used for Purchasing changes |
Enhancement Implementation
| Enhancement Type | Standard Definition Name | Custom Implementation Name | Design Rationale Reference |
|---|---|---|---|
| BADI | ARBCIG_MASTERDATA | ZMM_ARBCIG_MASTERDATA | BADI to enhance the CIG output |
Other Development Objects
| Object Name | Design Rationale |
|---|---|
| ZMM_S_ARBCIG_VENDOR_EXT | Append structure attached to ARBCIG_VENDOR |
| ZCL_IM_ARBCIG_MASTERDATA | Custom Class used in the BADI |
