Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Status

Page Status

Owner
Stakeholders
Jira Request ID

Jira
serverSyensqo's Jira
columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverIdd8efc1ef-48bd-3b4e-8714-ad827f4f059b
keyERP-101

Jira Development ID

Jira
serverSyensqo's Jira
columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverIdd8efc1ef-48bd-3b4e-8714-ad827f4f059b
keyERP-290

High- Level Specification

Implementing SystemIcertis
Invoked byERP-289
ParameterValue
Application System (Source)Syniti
Application System ( Target)Icertis
Business Process Reference03.03.04.05. Manage Contract Master Data

Functional Overview

Syniti

SAP ECC, the source system for currency conversion master data, will be integrated with Icertis to create and update currency exchange master data records in a custom Currency Exchange Master Data table within Icertis.

This integration will be executed via SAP CPI, which will invoke the Icertis Business API to perform bulk upsert operations.

The exchange rates maintained in Icertis will be used to convert local currency values into Euros in agreements.

Records will be created or updated daily in Icertis. The objective of this FS is to create Currency Exchange Masterdata in Icertis so that the currency exchange rates can be maintained.

Scope and Objectives

Functional Scope:

This document outlines the functional configuration required in Icertis to support the creation and maintenance of currency exchange master data sourced from SynitiSAP ECC.

Scope Includes:

  1. Creation and update of currency exchange master data in Icertis.
  • Integration with Syniti via SAP CPI.
  • Use of Icertis Business API for bulk upsert operations.
    1. Daily update of exchange rates
    using the rate from the last day of the previous month
    1. .

    Functional Objectives:

    1. Ensure Accurate Currency Conversion

      • Maintain up-to-date exchange rates for converting local values to Euros in contracts.
    2. Maintain Data Integrity

      • Prevent outdated or duplicate exchange rate records.
    3. Enable Auditability and Traceability

      • Ensure all exchange rate records are timestamped and sourced for compliance and audit purposes. In Icertis when the masterdatas record is created, system automatically generates the Modified Date and time stamp as displayed belowImage Added
    4. Minimize Manual Intervention

      • Automate the monthly daily currency exchange masterdata update process to reduce errors and improve efficiency.

    Out of Scope:

    1. Deletion of any existing currency exchange masterdata record
    2. De-activating any existing currency exchange masterdata record


    Process Flow Diagram

    inc-drawio
    draw.io Board Diagram
    bordertrue
    diagramNameSyniti CPI to Icertis Currency Conversion
    includedDiagramsimpleViewer1false
    width641
    linksauto
    tbstyletop
    lboxtrue
    diagramWidth441
    height182
    revision1pageId945059193

    2

    Daily,

    Step

    Description

    Comment

    1

    The execution of the interface is triggered as per the defined job schedule in Syniti

    CPI will call the Icertis

    Business API's

    Currency API daily, upon receiving data from SAP ECC, to create

    /

    or update the currency exchange

    masterdata and

    master data. It will send only the Source-to-EUR direct rates and update the existing currency exchange

    masterdata record

    Assumptions

    • 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.
  • master data records accordingly

    CPI to Icertis 

    Assumptions

    • Not Applicable.

    Dependencies

    • Not Applicable.

    Security, Integrity and Controls

    • Authentication: Access to Create Masterdata Contract Type (CT)
    • A new security group to be created for the Integration Users with manage access to Currency Exchange Master CT. The new security group title will be "Integration User"
    Info
    titleDifferent Integration Users

    We will be using different users for CPI integration, IAG integration, Ariba Integration. All the users will be placed under Integration User security group

    Configuration Requirements

    • Configure Currency Exchange Masterdata CT in Icertis with below details:
    ParentFieldDescriptionMandatory (Y/N)Data Type
    ICMCurrencyExchangeRateSourceCurrencyCurrency code of the local currencyYString
    ICMCurrencyExchangeRateTargetCurrencyCurrency code of the target currency (EUR)YString
    ICMCurrencyExchangeRateRateConversion rate from source to targetY

    Number - Decimal upto 4 points. Eg: 01.8228

    01.0003

    01.3001

    ICMCurrencyExchangeRateUnique NameName FieldYString


    Following Technical Configuration is required to enable integration between CPI & Icertis using ICI Business API

    • OAuth Setup

      • Microsoft Identity Platform
        • Register application in Microsoft Identity Platform
        • Capture the following details from IDP     
    InformationDescription
    Application (client) IDApplication Id for the App created for accessing ICI API’s
    Directory (tenant) IDTenant Id for the App created for accessing ICI API’s
    Object IDObject Id for the App created for accessing ICI API’s
    OpenID Connect metadata documentMetadata document URL for the App created for accessing ICI API’s
      • Icertis Side Configuration

        • Configure new masterdata CT in Icertis to store currency exchange rates 
        • Create an Integration User (CPI Integration User) in Icertis with Admin access.
        • Create Security Group "Integration User" with Manage access to Currency Exchange Rate CT.
        • Configure the following OAuth keys in Icertis json file:
    Key Values
    Core.API.OAuth.STSDiscoveryEndpointhttps://login.microsoftonline.com/{Directory (tenant) ID}/v2.0/.well-known/openid-configuration
    Core.API.OAuth.ValidAudiencesapi://{Client ID}
    Core.API.OAuth.ValidIssuerhttps://sts.windows.net/{Directory (tenant) ID}/
    Core.API.OAuth.ExternalUpnClaimUrihttp://schemas.microsoft.com/identity/claims/objectidentifier
    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 Daily exchange rates from Syniti to middleware to Icertis.
    • Ensure that the latest rates are available for contract value conversion.

    API Use

    • System Consuming API: SAP CPI
    • System Providing API: Icertis

    Create a currency exchange rate master data CT in Icertis which will store the currency exchange rates

    Data

    Data

    Structure

    The following fields will be configured in Icertis to provide the required data structure of the interface:

    ParentFieldDescriptionMandatory (Y/N)Data Type
    ICMCurrencyExchangeRateSourceCurrencyCurrency code of the local currencyYString
    ICMCurrencyExchangeRateTargetCurrencyCurrency code of the target currency (EUR)YString
    ICMCurrencyExchangeRateRateConversion rate from source to targetY

    Number - Decimal upto 4 points. Eg: 01.8228

    01.0003

    01.3001

    ICMCurrencyExchangeRateUnique NameName FieldYString

    API Fields Mapping:

    Field Name
    Date the rate is valid fromYString
    DescriptionValue
    ContractTypeNameName of the MasterdataStatic value - ICMCurrencyConversion
    NextState
    Always Blank
    RequestIdentifierUse “RequestIdentifier” to uniquely identify each item on the result endpoint’s response. This can be used to track the status of each job item of a bulk JobAuto Increment (Eg: 1,2,3)
    EndpointVersion
      • “EndpointVersion” don’t have any default value set. Ensure to set it to a number. The recommended value is 3 for best error handling and reporting. Supported values are 1, 2, and 3. 1 – Not recommended, 2 – Enables attribute validation, and 3 – Handles concurrency errors and enables attribute validation.
    Static value - 3
    UseExternalId
    Static value - true
    SysIdUnique technical identifier of the record
      • Blank when creating the masterdata
      • 32 characters when updating
    ICMUniqueName

    Concatenate FromCurrency

    and ToCurrency with ":" colon in the middle

    Pass Unique Name of the Currency Pairs
    ICMFromCurrency

    Get the To-currency

    from ECC extract

    FromCurrency (Eg: USD, CAD)
    ICMAgreementCodeUnique masterdata code
    ICMToCurrency

    Get the From currency

     from ECC extract

    ToCurrency - Static Value EUR
    ICMRate-Replace comma with period (.). 
    -Remove the forward slash / (-1)
    Rate (1.07)
    TemplateSelection
    Static Value: none
    EndPointVersion
    Static Value: 1

    Calculation and Validation

    Not Applicable

    Processing Logic

      • The integration job runs daily.
      • Currency Conversion rates are pushed from
    • CPI to Icertis.
    • 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 in

    Delta or Full Load Requirements

      • Full Load:
        • The interface always pushes the complete set of exchange rates for all supported currencies, for a given date. This does not process historical data. 
        • 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.
      • Not Applicable as this FS objective is to create a masterdata CT in Icertis

    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
    • See the appendix for the list of Currencies which needs to be converted to Euros


    Performance Consideration

    Scheduling and Execution Window

    • The integration job should be scheduled during off-peak hours daily to avoid contention with other system processes.
    • The priority of the jobs will be decided based on the other jobs mentioned in the list DD-TEC-130 R2 Batch Jobs Register and Schedule


    Error Handling

    Not Applicable

    Error Handling

    No error handling is possible in Icertis and it is expected in Syniti in the middleware


    Testing

    Test Conditions and Expected Results

    IDConditionExpected Results
    TC1For the initial load, create new exchange rate masterdata. Valid exchange rate data for Source to EUR currency pairs is pushed from CPI to IcertisRecords are Record is successfully created or updated in Icertis.
    TC2Full load of  records.For subsequent loads, update the existing masterdata records from CPI to IcertisAll records processed updated successfully; API response confirms success.
    TC3Missing mandatory field .in the data load sent  from CPI to IcertisStatus of batch job should be Record is rejected; error logged; An email notification alert is triggered in CPI

    Test Considerations/Dependencies

    Not Applicable


    Other Information

    Not Applicable


    Development Details

    Package

    Package NameParent Package




    Other Development Objects

    Object TypeObject NamePurpose/High Level LogicDesign Rationale Reference









    Appendix

    Sample payload:

    Code Block
    languagejs
    {
      
    
    
      "Messages":
     null 
     null,
    
      "Data": {
        
    
    
        "ContractTypeName""ICMCurrencyExchangeRate",
        
    
    
        "JobItems": [
    
    
          {
            
    
    
            "NextState""",
            
    
    
            "RequestIdentifier":
     1,        
     1,
    
            "EndpointVersion":
     null,        
     null,
    
            "UseExternalId":
     true,        
     true,
    
            "SysId""5449222c-3d3a-4044-baae-a17165381ed1",
            
    
    
            "RequestBody": {
              
    
    
              "ICMUniqueName""AUD:EUR",
              
    
    
              "Name""Masterdata_1_created",
              
    
    
              "ICMFromCurrency""AUD",
              
    
    
              "ICMAgreementCode""ICMCurrencyExchangeRate_19",
              
    
    
              "ICMToCurrency": "EUR",
    
    
               "ICMRate": "0.59",
    
    
              }
    
    
            },
            
    
    
            "TemplateSelection""none",
            
    
    
            "EndPointVersion":
     1
     3
    
          },
    
    
          {
            
    
    
            "NextState""",
            
    
    
            "RequestIdentifier":
     2,        
     2,
    
            "EndpointVersion":
     null,        
     null,
    
            "UseExternalId":
     false,        
     false,
    
            "SysId""96c08d87-3c89-4b7d-b075-e360bb41db07",
            
    
    
            "RequestBody": {
    
    
             "ICMUniqueName""INR:EUR",
              
    
    
              "Name""Masterdata_2_created",
              
    
    
              "ICMFromCurrency""INR",
              
    
    
              "ICMAgreementCode""ICMCurrencyExchangeRate_20",
              
    
    
              "ICMToCurrency": "EUR",
    
    
               "ICMRate": "0.0099",
    
    
              }
    
    
            },
            
    
    
            "TemplateSelection""none",
            
    
    
            "EndPointVersion":
     1
     3
    
          }
    
    
        ]
    
    
      },
      
    
    
      "HasMoreData":
     false 
     false,
    
      "PagingData": null
    
    }



    View file
    nameCurrency Conversion for Icertis.xlsx
    height250
     null}

    See also


    Attachments
    previewfalse
    patterns^(?!.*\.(png|jpg|jpeg|svg)$).*
    sortOrderdescending

    Change log

    Change History
    limit10