IFS Connect for Integrating Cash Planning with Kyriba REST Endpoints¶
The purpose of this page is to provide a guide on how to configure IFS Connect for integrating Cash Planning with Kyriba REST endpoints.
Cash Planning provides capabilities to analyze, plan and consolidate future cash flows within a project, a company, or a group of companies. It can be used both for short term scenarios with input primarily from Finance sources or for longer term scenarios with additional input from other automated or manual sources. The ambition of integrating Cash Planning with Kyriba is to be able to re-use as much information as possible from existing cash flow sources within IFS Cloud and minimize manual processes.
REST endpoints exposed by Kyriba for this Integration¶
In this Integration Kyriba exposes three REST endpoints, which is accessed by IFS to,
-
Upload the Cash Planning CSV file to Kyriba.
-
Execute a task to update the Cash Forecasts in Kyriba.
-
Receive the status of integrated flows from Kyriba.
1. Example connect configuration for Uploading the Cash Planning CSV file to Kyriba.¶
- Routing Rule: Example_Upload_Cash_Forecast_Kyriba_File
- Routing Address: Example_Upload_Cash_Forecast_Kyriba_File
Fill the values properly in the example files below, as the first step, to make the integration works.
Configure Routing Address¶
- Navigate to Routing Addresses.
- Transport connector should be REST.
- Go to REST Address Data and fill the information as follows.
- Rest Root End Point: Provide the Kyriba REST endpoint URL for Upload Data API. (Example https://www.example.com/gateway/api/v1/data)
- Client Id: The client identifier issued by Kyriba.
- Client Secret: The client secret issued by Kyriba.
- Token Endpoint: Provide the Kyriba REST endpoint URL for Authentication of KYRIBA APIs. (Example https://www.example.com/gateway/oauth/token)
- Rest HTTP Method should be POST.
Configure Routing Rule¶
- Navigate to Routing Rules.
- Routing Rule Direction should be Outbound.
- Select APPLICATION_MESSAGE as Route From and ensure that the Enabled toggle is On.
- Enter a proper description in the Rule Name.
- Do not set a queue and select Finish.
- Navigate to group Content Based Conditions, and click on '+' icon. Add a condition as follows.
- MESSAGE_FUNCTION as Search, '=' as Operation and KYRIBA_CF_UPLOAD as Match.
- Navigate to group Destination Addresses and select Set Destination Address.
- Search for the Routing Address created above and select it.
2. Example connect configuration for Executing a task to update the Cash Forecasts in Kyriba.¶
Kyriba uses specific Process Templates, per each specific function, which creates a task when it is launched. The task is executed asynchronously. For updating the Cash Forecasts in Kyriba, this task should be executed via a REST endpoint.
-
Routing Rule: Example_Execute_Cash_Forecast_Kyriba_Task
-
Routing Address: Example_Execute_Cash_Forecast_Kyriba_Task
Configure Routing Address¶
- Navigate to Routing Addresses.
- Transport connector should be REST.
- Go to REST Address Data and fill the information as follows.
- Rest Root End Point: Provide the Kyriba REST endpoint URL for Imorting data through Process Template API (Example https://www.example.com/gateway/api/v1/process-templates/IFS_CF_IMP/run)
- Make sure to include the process template ID IFS_CF_IMP ,specific to IFS Cash Planning Integrations with Kyriba, as shown in the Example URL above.
- Client Id: The client identifier issued by Kyriba.
- Client Secret: The client secret issued by Kyriba.
- Token Endpoint: Provide the Kyriba REST endpoint URL for Authentication of KYRIBA APIs. (Example https://www.example.com/gateway/oauth/token)
- Rest HTTP Method should be POST.
Configure Routing Rule¶
- Navigate to Routing Rules.
- Routing Rule Direction should be Outbound.
- Select APPLICATION_MESSAGE as Route From and ensure that the Enabled toggle is On.
- Enter a proper description in the Rule Name.
- Do not set a queue and select Finish.
- Navigate to group Content Based Conditions, and click on '+' icon. Add a condition as follows.
- MESSAGE_FUNCTION as Search, equals as Operation and KYRIBA_CF_CREATE_TASK as Match.
- Navigate to group Destination Addresses and select Set Destination Address.
- Search for the Routing Address created above and select it.
3. Example connect configuration for receiving the status of Integrated Flows from Kyriba.¶
Kyriba provides a specific REST endpoint to get the status of Cash Forecasts integrated.
-
Routing Rule: Example_Get_Cash_Forecast_Kyriba_Status
-
Routing Address: Example_Get_Cash_Forecast_Kyriba_Status
Configure Routing Address¶
- Navigate to Routing Addresses.
- Transport connector should be REST.
- Go to REST Address Data and fill the information as follows.
- Rest Root End Point: Provide the Kyriba REST endpoint URL for fetching the status of Data Import. (Example https://www.example.com/gateway/api/v1/process-templates/{parameter1}/{parameter2} )
- Client Id: The client identifier issued by Kyriba.
- Client Secret: The client secret issued by Kyriba.
- Token Endpoint: Provide the Kyriba REST endpoint URL for Authentication of KYRIBA APIs. (Example https://www.example.com/gateway/oauth/token)
- Rest HTTP Method should be GET.
Configure Routing Rule¶
- Navigate to Routing Rules.
- Routing Rule Direction should be Outbound.
- Select APPLICATION_MESSAGE as Route From and ensure that the Enabled toggle is On
- Enter a proper description in the Rule Name.
- Do not set a queue and select Finish.
- Navigate to group Content Based Conditions, and click on '+' icon. Add a condition as follows.
- MESSAGE_FUNCTION as Search, equals as Operation and KYRIBA_CF_GET_STATUS as Match.
- Navigate to group Destination Addresses and select Set Destination Address.
- Search for the Routing Address created above and select it.