SAP IBP (Integration Business Planning)

Disclaimer

Your use of this download is governed by Stonebranch’s Terms of Use, which are available at https://www.stonebranch.com/integration-hub/Terms-and-Privacy/Terms-of-Use/.

Overview

SAP Integrated Business Planning (IBP) is a cloud-based planning software for supply chain management. This Universal Extension helps to integrate SAP Integrated Business Application (IBP) application and orchestrate the schedule and launch of SAP IBP jobs from UAC. The dependencies of the IBP jobs with other platforms or applications can also be managed via UAC workflows.

Version Information

Template Name

Extension Name

Extension Version

Template Name

Extension Name

Extension Version

CS SAP IBP

ue-cs-sap-ibp

1.0.1

Software Requirements

This integration requires a Universal Agent and a Python runtime to execute the Universal Task.

Software Requirements for Universal Agent

  • Both Windows and Linux agents are supported:

    • Universal Agent for Windows x64 Version 7.0.0.0 and later with Python options installed.

    • Universal Agent for Linux Version 7.0.0.0 and later with Python options installed.

Software Requirements for Universal Controller

  • Universal Controller Version 7.0.0.0 and later. 

Software Requirements for the Application

  • This integration is tested on SAP IBP OD 2211.

  • It can work with future SAP IBP versions unless there is no changes to the SAP IBP job management REST API.

Key Features

This Universal Extension provides the following main features:
                 

  • The ability to schedule, automate and execute SAP IBP jobs running in SAP Cloud via Stonebranch Universal Controller.

  • Monitor SAP IBP Jobs from the Stonebranch Universal Controller.

  • Start/Rerun/Cancel batch processes automatically or manually from the Stonebranch Universal Controller.

  • Retrieve the results of the SAP IBP Jobs that are executed.

  • Cancel an IBP Job execution via dynamic command from the execution instance or also possible via a separate task using the cancel function choice.

Import the Universal Template

To use this downloadable Universal Template, you first must perform the following steps:

  1. This Universal Task requires the Resolvable Credentials feature. Check that the Resolvable Credentials Permitted system property has been set to true.

  2. Download the provided ZIP file.

  3. In the Universal Controller UI, select Administration >Configuration > Universal Templates to display the current list of Universal Templates.

  4. Click Import Template.

  5. Select the template ZIP file and Import.

When the template has been imported successfully, the Universal Template will appear on the list. Refresh your Navigation Tree to see these tasks in the Automation Center Menu.

Configure Task

For the new Universal Task type, create a new task, and enter the task-specific details that were created in the Universal Template.

Field Descriptions

The SAP IBP Universal Task contains the following fields.

Field

Input Type

Default Value

Type

Description

SAP IBP Job Function

Required

Run a SAP IBP Job

Choice

The action performed upon the task execution.

Valid values are:

  • Run a SAP IBP Job.

  • Cancel a SAP IBP Running/scheduled Job.

SAP IBP User Credential

Required

-

Credentials

The SAP IBP user credentials that have access to SAP IBP RESTAPI functions.

They are comprised of:

  • Runtime username.

  • Runtime password.

IBP Service URL/Service Interface

Required

-

Text

SAP IBP Service URL , This can be obtained from SAP_COM_0064 in IBP console ==> Communication Arrangements.

Example URL : https://myxxxxxx-api.scmibp1.ondemand.com/sap/opu/odata/sap/BC_EXT_APPJOB_MANAGEMENT;v=0002

Job Template Name

Required

-

Dynamic Choice

Dynamic Choice field populated by getting a list of IBP job Template name from the server.

If Required you may also manually populate the field with "template name,id".

Job Text

Required

${ops_task_name}

Text

Provide the suitable SAP IBP Job title for the job execution so it can easily be identified in the SAP IBP system, Default name would be the name of the IBP task name defined in universal controller.

SAP IBP Job User

Optional

-

Text

SAP IBP user that can be used to execute the IBP Job, If not provided then the SAP IBP User credential will be used for execution.

JobName

-

-

Output only

SAP IBP Job run count generated out of the execution, Automatically populated in universal controller task instance when the selected function is "Run a SAP IBP Job".

Job Run Count

-

-

Output only

SAP IBP Job run count generated out of the execution, Automatically populated in universal controller task instance when the selected function is "Run a SAP IBP Job"

Cancel Job Name

Required

-

Text

Specify SAP IBP Job name that needs to be cancelled while its been in execution.

Cancel Job Run Count

Required

 

Text

Specify SAP IBP Run count ID for the execution that needs to be cancelled.

IBP Job status

-

-

Output only

Real time status of the IBP job execution ,This field is automatically populated in the universal controller task instance when the selected function is "Run a SAP IBP Job".

Examples 

Run a SAP IBP Job

Example of Universal Task for launching a SAP IBP Job execution 

 

Select IBP Job Template Dynamically 

 

IBP Job launch in Universal controller and locating it in SAP IBP Console :

 

Universal Controller IBP Task Instance 

   

SAP IBP Application Job Console 

 

Cancel IBP Job via Dynamic command

 

SAP IBP Execution Logs STDERR / STDOUT

 

Document References

This document references the following documents:

 

Changelog

ue-cs-sap-ibp-1.0.1 (2023-08-24)

  • Bugfix: Issue during import due to incompatibility of the extension name

ue-sap-ibp-1.0.0 (2023-02-06)

Initial Version