SAP Cloud Integration Connector 1.0.0.4
The SAP Cloud Integration Connector lets you connect to SAP CPI (Cloud Platform Integration) instances and do the following things:
-
Deploy iFlows.
-
Undeploy iFlows.
-
Monitor message logs generated by iFlows when they run.
Note: You can run only iFlows that have been deployed.
A few examples of how iFlows can be designed to run in SAP CPI:
-
If you start an iFlow with an HTTP sender, SAP generates a REST endpoint you can call from Postman to run the iFlow. You do not need this Connector to run such iFlows; you can use the Connector Wizard or an HTTP/REST Job Definition to do so.
-
If you start an iFlow with a Timer, SAP will run the iFlow based on the timer configuration, and it will start running as soon as it is deployed.
The only way this Connector can be used to run iFlows is with the Redwood_SAP_CloudIntegrationDeploy Job Definition. If the iFlow is configured to run automatically on deployment, you can use this Job Definition to deploy and run it. You can also configure it to directly monitor the iFlow until completion.
Prerequisites
- RunMyJobs 9.2.9 or higher.
- Connection Management Extension 1.0.0.3 or later. Note that the Connection Management Extension will be installed or updated automatically if necessary when you install this Connector.
- Privileges Required for SAP Cloud Integration.
- For authentication, one of the following:
- Basic authentication credentials (username and password).
- A client certificate credential (see Step-by-step Guide to Set Up Inbound Client Certificate Authentication, Cloud Foundry Environment). To use this option, you will need the following:
- A Service Instance for the Process Integration Runtime Service in the BTP instance for the API service plan.
- A service key of type Certificate created for the API service plan.
Note: The "Create Service Instance and Service Key in SAP BTP Cockpit" section of the above blog post mentioned chooses the integration-flow plan. To connect with RunMyJobs, use the api service plan instead.
- SAP OAuth 2.0 client credentials (see OAuth Setup for Cloud Integration in Cloud Foundry Environment). To use this option, you will need the following:
- A Service Instance for the Process Integration Runtime Service in the BTP instance for the API service plan.
- A service key of type Client ID/Secret created for the API service plan.
Contents
| Object Type | Name | Description |
|---|---|---|
| Folder | GLOBAL.Redwood.GLOBAL.SAP.REDWOOD.CloudIntegration | Integration Connector with SAP Cloud Integration (1.0.0.4). |
| Constraint Definition | REDWOOD.Redwood_JobAndWorkflowDefinitionsConstraint | Constraint for fields that support both Job Definitions and Workflow Definitions. |
| Constraint Definition | REDWOOD.Redwood_SAPCloudIntegrationConnectionConstraint | Constraint for SAP Cloud Integration Connection fields. |
| Extension Point | REDWOOD.Redwood_SAPCloudIntegration | Integration Connector with SAP Cloud Integration. |
| Job Definition | REDWOOD.Redwood_SAP_CloudIntegrationDeploy | Deploy an iFlow in Cloud Integration. |
| Job Definition | REDWOOD.Redwood_SAP_CloudIntegrationFlowJob | A default Job Definition to be submitted by the Cloud Integration Monitor when an iFlow completes. |
| Job Definition | REDWOOD.Redwood_SAP_CloudIntegrationMonitor | Monitors iFlows in Cloud Integration and generates Jobs with their final statuses. |
| Job Definition | REDWOOD.Redwood_SAP_CloudIntegrationUndeploy | Undeploy an iFlow in Cloud Integration. |
| Job Definition Type | REDWOOD.Redwood_SAPIntegrationSuite | Definition type to run Integration Suite definitions. |
| Library | REDWOOD.Redwood_SAPCloudIntegration | Library for SAP Cloud Integration Connector. |
Redwood_SAP_CloudIntegrationDeploy
Lets you deploy an iFlow in Cloud Integration.
| Tab | Name | Description | Documentation | Data Type | Direction | Default Expression | Values |
|---|---|---|---|---|---|---|---|
| Parameters | connection
|
SAP Cloud Integration Connection | The SAP Cloud Integration Connection object that contains the authentication information for the desired Cloud Integration instance. | String | In |
|
|
| Parameters | iflowId
|
iFlow ID | ID of the iFlow to deploy. | String | In |
|
|
| Parameters | version
|
Version | Version of the iFlow to deploy. | String | In | active
|
|
| Monitoring | monitorRun
|
Monitor First Run | Wait for the initial run of the iFlow to complete before completing this Job. | String | In | N
|
Y, N |
| Monitoring | successStates
|
Success States | Final state(s) that should complete this Job successfully. This is only applicable if Monitor First Run is set to 'Y'. | String | In | =Array.toStringArray('COMPLETED')
|
FAILED, ERROR, ESCALATED, COMPLETED, ABANDONED, CANCELLED |
| Monitoring | failureStates
|
Failure States | Final state(s) that should fail this Job. This is only applicable if Monitor First Run is set to 'Y'. | String | In | =Array.toStringArray('FAILED','ERROR')
|
FAILED, ERROR, ESCALATED, COMPLETED, ABANDONED, CANCELLED |
| Monitoring | monitorTimeout
|
Run Start Timeout | How long to wait for the first run of the iFlow to start (in minutes, from the start of the deployment process). | Number | In | 5
|
|
Redwood_SAP_CloudIntegrationFlowJob
A default definition to be submitted by the Redwood_SAP_CloudIntegrationMonitor Job Definition when an iFlow message log with a matching Monitor State completes.
This is a placeholder process definition that is used by Redwood_SAP_CloudIntegrationMonitor to track the progress of iFlows it intercepts. If the Redwood_SAP_CloudIntegrationMonitor Job detects a running iFlow that it wants to track, it runs an instance of this Job Definition to represent that iFlow and its status.
Note: Running this Job Definition manually will not do anything, because it is used only by Redwood_SAP_CloudIntegrationMonitor.
| Tab | Name | Description | Documentation | Data Type | Direction |
|---|---|---|---|---|---|
| Parameters | CONNECTION
|
SAP Cloud Integration Connection | The SAP Cloud Integration Connection object that contains the authentication information for the desired Cloud Integration instance. | String | In |
| Parameters | MESSAGEID
|
Message ID | The ID of the Log Processing Message that reported the final status of the iFlow. | String | In |
| Parameters | FLOWNAME
|
Flow Name | The name of the iFlow. | String | In |
| Parameters | STATUS
|
iFlow Status | The final status of the iFlow run. | String | In |
| Parameters | MONITORJOBID
|
Monitor Job ID | Job ID of the Redwood_SAP_CloudIntegrationMonitor Job that submitted this definition. | Number | In |
Redwood_SAP_CloudIntegrationMonitor
This Job Definition lets you monitor the SAP CPI environment for specific Monitored States (message log types), such as Failed, Error, Completed, and Escalated. By default, when this Job detects a message log that matches the filters it is monitoring for, the Job submits the placeholder definition Redwood_SAP_CloudIntegrationFlowJob with the information from that message log set as Parameters on the Job.
| Tab | Name | Description | Documentation | Data Type | Direction | Default Expression | Values |
|---|---|---|---|---|---|---|---|
| Parameters | CONNECTION
|
SAP Cloud Integration Connection | The SAP Cloud Integration Connection object that contains the authentication information for the desired Cloud Integration instance. | String | In |
|
|
| Parameters | STATES
|
Monitored States | The state(s) to monitor for. | String | In |
|
FAILED, ERROR, COMPLETED, RETRY, ESCALATED, ABANDONED |
| Parameters | POLLING_INTERVAL
|
Monitor Polling Interval | Polling interval in minutes. | Number | In | 5
|
|
| Parameters | FLOWNAME
|
Flow Name | Monitor for flows with a specific name. If this parameter is left blank, any flow that completes in a state that matches the State filter will trigger the selected Job Definition. | String | In |
|
|
| Parameters | DEFINITION_KEY
|
Definition to Run |
The Business Key of an existing Job or Workflow definition to run when the monitor finds an iFlow that matches the specified filters. If this is left blank, the Redwood_SAP_CloudIntegrationFlowJob Job Definition will be run. You can choose your own Job Definition rather than Redwood_SAP_CloudIntegrationFlowJob. The only requirement is that the Job Definition you choose has the message log Parameters that Redwood_SAP_CloudIntegrationMonitor normally sets on Redwood_SAP_CloudIntegrationFlowJob. |
String | In |
|
|
Redwood_SAP_CloudIntegrationUndeploy
Lets you undeploy an iFlow in Cloud Integration.
| Tab | Name | Description | Documentation | Data Type | Direction |
|---|---|---|---|---|---|
| Parameters | connection
|
SAP Cloud Integration Connection | The SAP Cloud Integration Connection object that contains the authentication information for the desired Cloud Integration instance. | String | In |
| Parameters | iflowId
|
iFlow ID | ID of the iFlow to undeploy. | String | In |
Setup
- Locate the JD Edwards EnterpriseOne Connector in the Catalog and install it.
- Navigate to Configure > Admin > Security > Connections.
- Click New.
- Choose SAP Cloud Integration under Select a Connection Type.
-
Choose Next or Basic Properties and create a Queue and Job Server for the SAP Cloud Integration Connection. All required settings will be set automatically.
- Click Next or Security and click
to specify which roles can access the connection information. It is recommended to grant the role at least the following additional privileges: View on the SAP Cloud Integration Job Server, View Processes on the SAP Cloud Integration Queue, View on library Redwood_SAPCloudIntegration, and Run on Redwood_SAP_CloudIntegrationMonitor and Redwood_SAP_CloudIntegrationFlowJob Job Definitions. - Click Next or SAP Cloud Integration Connection Properties. You have three options for authenticating with SAP Cloud Integration.
Basic. Enter the URL for your SAP Cloud Integration instance, your Username, and your Password.
Client Certificate. Enter the URL for your SAP instance. Use the Test Connection button to make sure the connection is working.
Note: If you choose this option, you must create an X509_ClientCertificate Credential. If your scheduler system does not already trust the Certificate Authority (CA) that signed the client certificate, you must also create an X509_TrustedCertificate Credential for the Root CA.
Oauth 2.0. Enter the URL for your SAP Cloud Integration Instance, your Access Token URL, the Client ID, and the Client Secret. Use the Test Connection button to make sure the Connection is working.
- Click Save & Close.
- Navigate to Navigate to Configure > Control > Job Servers, locate the SAP Cloud Integration Job Server, start it, and make sure it reaches status Running.
Using Redwood_SAP_CloudIntegrationMonitor
This Job Definition provides a way to monitor iFlows running in Cloud Integration Suite. You can configure this Job Definition to execute a specific Job Definition or Workflow Definition whenever an iFlow with a name that matches the provided Flow Name reaches one of the states in the Monitored States array. If you do not specify a Flow Name, the indicated Definition to Run will execute whenever ANY iFlow reaches one of the statuses in the Monitored States array.
This Job Definition must be manually run. After its submission, it will run indefinitely, starting a new monitor instance every 24 hours.
You can run more than one of these Job Definitions at a time, provided they have different Parameters (i.e., a different Connection, a different set of Monitored States, and/or a different Flow Name).
If you specify a Definition to Run, the following Parameters are automatically set on the Definition to Run if they exist there.
-
FLOWNAME: The name of the iFlow. -
MESSAGEID: The unique ID of the message that was detected in SAP. -
STATUS: The status of the running iFlow, as reported by this message. -
MONITORJOBID: The Job ID of the Redwood_SAP_CloudIntegrationMonitor Job that triggered the execution.
If you do NOT specify a Definition to Run, RunMyJobs will trigger the Redwood_SAP_CloudIntegrationFlowJob Job Definition.
Using Redwood_SAP_CloudIntegrationFlowJob
This Job Definition is submitted automatically by Redwood_SAP_CloudIntegrationMonitor if it detects a match and does not supply a Definition to Run. It attempts to fetch error information for the matching iFlow and write it to the process log.
If the iFlow status is FAILED or ERROR or there is an error log present on the message that was captured, this process will fail. Otherwise, it will succeed.
Deploying an iFlow
To deploy an iFlow:
-
In the SAP > CloudIntegration Folder, run Redwood_SAP_CloudIntegrationDeploy.
-
Choose the SAP Cloud Integration Connection.
-
Enter the iFlow ID of the target iFlow.
-
Choose an option from the Version dropdown list.
-
On the Monitoring tab, configure the options using this table.
-
Click Run.
Undeploying an iFlow
To undeploy an iFlow:
-
In the SAP > CloudIntegration Folder, run Redwood_SAP_CloudIntegrationUndeploy.
-
Choose the SAP Cloud Integration Connection.
-
Enter the iFlow ID of the target iFlow.
-
Click Run.