SAP IBP Connector 2.0.0.0
The SAP IBP connector allows you to schedule workload in SAP HANA (BTP).
New Features in 2.0.0.0
- Version 9.2.9 or higher
- Connections component support
Prerequisites
- Version 9.2.9 or higher
- Connection component 1.0.0.2 or later. Note that the Connections component will be installed or updated automatically if necessary when you install this extension.
- Privileges Required to Use SAP IBP Connections 2.x
- SAP BTP External Scheduler Integration API
Installation
The Redwood SAP IBP Connector is available in the Catalog.
Contents of the Component
The SA component consists of the following objects:
Object Type | Name | Description |
---|---|---|
Application | GLOBAL.Redwood.REDWOOD.IBP | SAP IBP Connector (2.0.0.0) |
Constraint Definition | REDWOOD.Redwood_IBPConnectionConstraint | Constraint for SAP IBP Connection fields |
Extension Point | REDWOOD.Redwood_IBP | SAP IBP |
Process Definition | REDWOOD.Redwood_IBP_ImportJobTemplate | Import SAP IBP Application Templates as Process Definitions |
Process Definition | REDWOOD.Redwood_IBP_ShowTemplates | Retrieve details about all available SAP IBP Templates |
Process Definition | REDWOOD.Redwood_IBP_SubmitJob | Submit an SAP IBP Job |
Process Definition | REDWOOD.Redwood_IBP_Template | Template for submitting an SAP IBP Job |
Process Definition Type | REDWOOD.Redwood_SAP_IBP | SAP IBP Connector |
Library | REDWOOD.Redwood_SAP_IBP | SAP IBP Connector: supporting library |
IBP
The Application containing all the built-in Process Definitions as well as the Redwood_SAP_IBP library.
Redwood_IBP_ImportJobTemplate
The IBP_ImportJobTemplate allows you to import a template using either the job template name or a SAP IBP job name.
Tab | Parameter | Description | Documentation | Values |
---|---|---|---|---|
Parameters | Connection
|
Connection | The Connection object that defines the connection to the SAP IBP Application. |
|
Parameters | templateName
|
Technical Name Filter | Filter on Technical Name (wildcards * and ? allowed, empty for all); for example ZHDVK0F2BIAPONJPTEHJC26PCR4 . If you leave both Technical Name Filter and Display Name Filter blank, all templates will be returned. |
|
Parameters | jobText
|
Display Name Filter | Filter on Description (wildcards * and ? allowed, empty for all), for example EH_HCI . If you leave both Technical Name Filter and Display Name Filter blank, all templates will be returned. |
|
Parameters | overwrite
|
Overwrite Existing Definition | This controls overwriting existing definitions in Redwood. | N - (default) do not overwrite existing Process Definitions Y - overwrite existing definitions |
Parameters | importType
|
Definition Name Type | This controls which filter will be used, technical name or job description | D - (default) use the job descriptionG - use the template name (technical name) |
Target | targetPartition
|
Partition | Partition of the generated Process Definition | List of existing Partitions |
Target | targetApplication
|
Application | Application of the generated Process Definition | List of existing Applications |
Target | targetQueue
|
Default Queue | Specifies the default Queue of the generated Process Definition | List of existing Queues |
Target | targetPrefix
|
Definition Name Prefix | Prefix to prepend to the name of the generated Process Definition | For example CUS_IBP_ |
Target | targetUser
|
Job User | User to run the job as |
|
Redwood_IBP_ShowTemplates
Lists all job templates available in the SAP IBP system. This definition has one parameter, Connection for you SAP IBP system. The process outputs lists of templates in RTX format and in its log the following syntax:
<sequence number>:
Technical Name: <template name>
Job Text: <job text>
Redwood_SAP_IBP
The library contains code used by the connection to connect to SAP IBP and
Redwood_IBP_SubmitJob
This allows you to submit a job in your SAP IBP system.
Tab | Parameter | Description | Documentation |
---|---|---|---|
Parameters | Connection
|
Connection | The Connection object that defines the connection to the SAP IBP Application. |
Parameters | jobText
|
Job Text | The job name to use for the job, for example EH_HCI |
Parameters | jobUser
|
Job User | The user to run the job as; the user must be the same as the user you see in the Fiori App Communication System |
Parameters | templateName
|
Template Technical Name | The job template to use for the job, for example ZHDVK0F2BIAPONJPTEHJC26PCR4 |
Parameters | jobName
|
Job Name (Out) | Job name in the SAP IBP system; this is an Out parameter that is set by the process. |
Parameters | jobRunCount
|
Job Run Count (Out) | Job run count in the SAP IBP system; this is an Out parameter that is set by the process. |
Note: The template name ZHDVK0F2BIAPONJPTEHJC26PCR4
is used for illustration purposes, only, you submit IBP.IBP_ShowTemplates to display available templates.
Redwood_IBP_Template
You duplicate this definition to create your own definition, the parameters are the same as for Redwood_IBP_SubmitJob, you use Redwood_IBP_ShowTemplates to retrieve a list of technical template names to choose from. Note that you can also import a template using [Redwood_IBP_ImportJonTemplate].
Setup
IBP processes need their own Process Server and Queue.The Connections component allows you to create Queues and Process Servers for this connector. For more information, see Creating an SAP IBP Connection.
Upgrade
If you have SAP IBP version 1 installed, you can install version 2 alongside it and have both running in parallel. You switch over to version 2 once you are ready. Do not attempt to remove the old version without prior contacting Redwood Support; removing the old Process Definitions will require all processes belonging to them to be removed.
Running IBP jobs
Finding IBP templates
To retrieve the list of job templates available for scheduling got to the IBP Application, click on Applications > IBP > Redwood_IBP_ShowTemplates and submit it.

Once the process has finished, click on the stdout.log
, and you will see the output as follows:
1:
Technical Name: ZHDVK0F2BIAPONJPTEHJC26PCR4
Job Text: EH_HCI
2:
Technical Name: ZHDVK0F2BIAPONJPTD3U3FCNCRQ
Job Text: EH_DS6A
3:
Technical Name: ZHDVK0F2BIAPONLXGJEEQBT3KVU
Job Text: INV_OPT
Here you can find the value later used as template name - it's the value after the sequence number and before the template title.
Schedule an IBP Job
In the IBP Application locate Redwood_IBP_SubmitJob and submit it.

Remember to use the correct job user - with this user, the job is scheduled, and, for example, the IBP visibility filter settings are taken from this user. Also, this is the user ID as seen in the Fiori App Maintain Business Users.
The template name is usually a GUID-like ID, the non-GUID-like template names are the SAP delivered templates, which usually have empty parameter values. Non-GUID-like template names contain one or more words, such as Material Requirement Planning (MRP), GUID-like template names contain specific letters and numbers, no spaces, like ZHDVK0F2BIAPONJPTEHJC26PCR4
. To list available template names submit IBP.IBP_ShowTemplates.
Import Templates as Process Definitions
Submit IBP.IBP_ImportJobTemplate to import the template as a Process Definition.

APPENDIX
Enable Connections Through HTTP Proxy
When the connection to the SAP IBP system needs to be established through an HTTP proxy, create a new proxy credential and specify a proxy for IBP independent of the Secure Gateway proxy. To create the credential, navigate to Security > Credentials and use the following settings:
- Protocol: HTTP
- Endpoint:
<hostname>:<port>
- FQDN hostname and port of the IBP instance.*
- Catch all credential to be used for all HTTP connections (not only SAP IBP).
- Real User:
http://[<proxy_user>@]<proxy_server>[:<proxy_port>]
<proxy_user>@
- No authentication will take place if omitted<proxy_port>
- defaults to3128
- Password: Password for the proxy server, if
<proxy_user>@
was not specified, use a dummy password, such as-
. - Virtual User:
proxy
Example of a proxy Credential:

See HTTP Proxy Credentials for more information.
Setup IBP Communication System & User

Open the Communication Systems Fiori App and click New and provide a meaningful system ID and description for your external scheduling tool. For example, you use JOBSCHEDULER
. Then you choose the correct hostname as it is used as source of the request to the IBP system.
Next, you add a new user for inbound communication (inbound from the IBP systems point of view).

We are then forwarded to the Communication User Fiori App and can create a completely new IBP local user which is used to identify the inbound communication from the external scheduler. For example, you use JOBSCHEDULERUSER
and let IBP generate a password.

In the communication system you specify Username and Password as authentication method. In the Communication Arrangement Fiori App you choose New and create a new communication arrangement based on scenario SAP_COM_0064.

We select the communication system and communication user from the previous step.

You can see in the lower right the URL which is to be used by the external scheduling tool as basis.