High- Level Specification
| Parameter | Value |
|---|---|
| Application System (Source) | Syniti |
| Application System ( Target) | Icertis |
| Business Process Reference | Masterdata Conversion |
Functional Overview
Syniti which is the source of Currency Conversion Master Data will be integrated with Icertis to create currency exchange masterdata records in Icertis custom Currency Exchange masterdata table using Icertis Business API.
This Exchange rate will be used to convert the local Value into Euros to identify the DOA approvers in agreement.
In Icertis, records will be created/updated in bulk once in a month preferably 1st of every month and it will take the rate of last date of the previous month.
Scope and Objectives
Functional Scope:
This interface facilitates the monthly integration of currency exchange rates from Syniti into Icertis Contract Intelligence (ICI) to support accurate financial calculations and DOA (Delegation of Authority) logic in contracts.
Scope Includes:
Source System:
- Syniti as the master source for currency exchange rates.
Target System:
- Icertis, with a custom Currency Exchange Master Data table.
Integration Mechanism:
- CPI will call Icertis Business API used for bulk creation and update of masterdata records.
Data Elements Transferred:
- From Currency
- Unique Name
- To Currency
- Rate
Frequency:
- Daily after Syniti to CPI batch job is completed.
Operation Type:
- Bulk Upsert (create new or update existing records).
Usage in Icertis:
- Used to convert local currency values to Euros.
- Enables correct DOA approver identification based on Euro thresholds.
Functional Objectives:
Ensure Accurate Currency Conversion
- Maintain up-to-date exchange rates for converting local values to Euros in contracts.
Support DOA Logic in Agreements
- Enable automated identification of approvers based on Euro-converted contract values.
Maintain Data Integrity
- Prevent outdated or duplicate exchange rate records.
- Ensure historical accuracy by using the rate from the last day of the previous month.
Enable Auditability and Traceability
- Ensure all exchange rate records are timestamped and sourced for compliance and audit purposes.
Minimize Manual Intervention
- Automate the monthly update process to reduce errors and improve efficiency.
Out of Scope:
- Deletion of any existing currency exchange masterdata record
- De-activating any existing currency exchange masterdata record
API Information
Get bulk api prepare for masterdata
POST/v{version}/bulk/masterdata/prepare
Sample Request
POST/{{baseUrl}}/{{version}}/bulk/masterdata/prepare
{
"Data": {
"ContractTypeName": "ICMOtherPartyMaster",
"SelectedAttributes": []
}
}
Create or update masterdata records in Bulk
POST/v{version}/bulk/masterdata
Process Flow Diagram
draw.io
/display/ER/REMOVE+----+ERP-288+System+Interface+-+Currency+Conversion+ECC+to+Icertis
Step | Description | Comment |
|---|---|---|
1 | The execution of the interface is triggered as per the defined job schedule | |
2 | Daily, Syniti will call Icertis Business API's to create/update currency exchange masterdata |
Assumptions
- Syniti will provide validated and complete exchange rate data for all required currency pairs.
- Only conversion rates from each source currency to EUR will be extracted and exported.
- The exchange rate for the last day will be available in Syniti.
- Icertis Business API will support bulk upsert operations without performance degradation.
- The Icertis custom Currency Exchange master table is already configured and accessible via API.
- Exchange rates will be used only for DOA logic and not for financial reporting or invoicing.
- No real-time updates are required; monthly sync is sufficient.
- Error handling and logging will be managed by the middleware or integration layer.
- The integration will be triggered by a scheduled job or batch process in the CPI daily after Syniti to CPI batch job is executed.
Dependencies
- Syniti Data Availability: Exchange rate data must be finalized and accessible by the 1st of each month.
- Icertis API Availability: Business API must be operational and accessible during the integration window.
- Middleware/ETL Tool: A tool or service must be in place to extract data from Syniti and push it to Icertis.
- Authentication Setup: Secure tokens or credentials must be configured for API access.
- Schedule Dependency: This interface must run after Syniti’s daily currency update job completes.
Security, Integrity and Controls
- Authentication: API access to Icertis must use secure OAuth tokens or API keys.
- Authorization: Only designated integration service accounts should have write access to the Currency Exchange master table.
- Encryption: Data in transit must be encrypted using HTTPS/TLS.
- Audit Logging: All API calls and data changes must be logged for audit purposes.
- Data Validation: Exchange rates must be validated for completeness and correctness before pushing to Icertis.
Configuration Requirements
- Icertis Custom Table: Must include fields for Source Currency, Target Currency, Exchange Rate, Effective Date, Source System, and Timestamp.
- API Endpoint Configuration: Business API endpoints must be configured to accept bulk upsert payloads.
- Job Scheduler: A scheduler (e.g., Control-M, SAP PO, or custom script) must be configured to run the job monthly.
- Error Handling Rules: Define retry logic, failure notifications, and fallback mechanisms.
Special Requirements
- Localization: Ensure currency formats comply with regional standards (e.g., decimal separators).
Design Rationale
Icertis will consume data from CPI middleware via a scheduled integration that uses the Icertis Business API to create or update currency exchange master data records.
The API will be used to:
- Push monthly exchange rates from Syniti to middleware to Icertis.
- Ensure that the latest rates are available for contract value conversion and DOA logic.
API Use
- System Consuming API: Icertis
- System Providing API: Syniti (or middleware extracting from Syniti)
Data Structure
The following fields will be used to provide the required data structure of the interface:
| Parent | Field | Description | Mandatory (Y/N) | Data Type |
|---|---|---|---|---|
| ICMCurrencyExchangeRate | SourceCurrency | Currency code of the local currency | Y | String |
| ICMCurrencyExchangeRate | TargetCurrency | Currency code of the target currency (EUR) | Y | String |
| ICMCurrencyExchangeRate | Rate | Conversion rate from source to target | Y | Decimal |
| ICMCurrencyExchangeRate | Unique Name | Date the rate is valid from | Y | String |
Calculation and Validation
Not Applicable
Processing Logic
- The integration job runs daily.
- It fetches exchange rates from Syniti.
- The data is transformed into the required format and pushed to Icertis via the Business API.
- The API performs bulk upsert: updates existing records or creates new ones.
- Errors are logged and flagged for manual review.
Delta or Full Load Requirements
- Full Load:
- The interface always pushes the complete set of exchange rates for all supported currencies.
- No delta tracking is required since the data is refreshed daily.
Interface Alert & Monitoring
- Alerts should be configured for:
- API failures
- Missing or incomplete data
- Validation errors
- Monitoring tools (middleware logs) should notify:
- Integration support team
- Business users (email)
- Retry logic should be in place for transient failures.
Language Requirements
- No multilingual support required for exchange rate data.
- All fields are numeric or standard ISO codes.
User Interface Requirements
Not Applicable
Volumetrics
Not Applicable
Performance Consideration
Scheduling and Execution Window
- The integration job should be scheduled during off-peak hours daily to avoid contention with other system processes.
Error Handling
No error handling is possible in Icertis and it is expected in Syniti as per FS-288 and in the middleware as per FS-289
Testing
Test Conditions and Expected Results
| ID | Condition | Expected Results |
|---|---|---|
| TC1 | Valid exchange rate data for multiple currency pairs | Record is successfully created or updated in Icertis. |
| TC2 | Full load of 100+ records. | All records processed successfully; API response confirms success. |
| TC3 | Missing mandatory field. | Record is rejected; error logged; alert triggered |
| TC4 | Invalid currency code | Validation error; record rejected |
| TC5 | Negative exchange rate | Validation error; record rejected. |
Test Considerations/Dependencies
Not Applicable
Other Information
Not Applicable
Development Details
Package
| Package Name | Parent Package |
|---|---|
Other Development Objects
| Object Type | Object Name | Purpose/High Level Logic | Design Rationale Reference |
|---|---|---|---|
Appendix
Sample payload:
{
"Messages": null,
"Data": {
"ContractTypeName": "ICMCurrencyExchangeRate",
"JobItems": [
{
"NextState": "",
"RequestIdentifier": 1,
"EndpointVersion": null,
"UseExternalId": true,
"SysId": "",
"RequestBody": {
"ICMUniqueName": "",
"Name": "Masterdata_1_created",
"ICMFromCurrency": "",
"ICMAgreementCode": "",
"ICMToCurrency": "",
"ICMRate": "",
}
},
"TemplateSelection": "none",
"EndPointVersion": 1
},
{
"NextState": "",
"RequestIdentifier": 2,
"EndpointVersion": null,
"UseExternalId": false,
"SysId": "",
"RequestBody": {
"ICMUniqueName": "",
"Name": "Masterdata_2_created",
"ICMFromCurrency": "",
"ICMAgreementCode": "",
"ICMToCurrency": "",
"ICMRate": "",
}
},
"TemplateSelection": "none",
"EndPointVersion": 1
}
]
},
"HasMoreData": false,
"PagingData": null
}