Disclaimer

Your use of this download is governed by Stonebranch’s Terms of Use.

Version Information

‎ ‎ ‎ 

Overview

SAP Business Technology Platform (SAP BTP) is a comprehensive, cloud‑based environment that enables organizations to build, deploy, and manage modern applications with agility and scalability.

This integration enables users to schedule, trigger, and monitor their SAP BTP Application Jobs directly from UAC.

Key Features

‎ ‎

Requirements

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

‎ ‎ 

Supported Actions

Action: Run Taskflow

The “Run Job” Action allows a Job to be triggered or scheduled. To execute the Action, the necessary Credentials, Service URL, and Job Template must be provided.

Optionally, the Job’s title can be specified using the Job Name. If omitted, the title defined in the Job Template is used.

The user on whose behalf the Job will run can also be specified. If not provided, the communication user is used by default.

You can also configure whether the task should only initiate the Job or wait until a final success or failure state is reached. The latest Job and Step status retrieved can be included in the Extension Output.

During task instance execution, the Job Name (ID), Job Run Count, Status, and Last Updated On are displayed as output fields.

Configuration examples

Example: Run and monitor a Job

The configuration example below shows a task configuration for a Job Run, using a custom Job name and executed by a different user. Once the Job is successfully triggered, the task instance enters a wait state and monitors the Job until it either completes or fails. Upon completion, the info from the Job monitor, the status from the Job, and its individual Steps are displayed according to the selected output options.

Action Output

{
    "exit_code": 0,
    "status_description": "Task executed successfully",
    "invocation": {
        "extension": "ue-sap-btp-appjobs",
        "version": "1.0.0",
        "fields": {
            "action": "Run Job",
            "sap_credential": {
                "user": "STONEBRANCH",
                "password": "****",
                "token": "****",
                "key_location": null,
                "passphrase": "****"
            },
            "url_service": "https://my*****.scmibp1.ondemand.com/",
            "job_template": "SB_QA_Template_Step_6",
            "job_name": "Lunched Job Step 6",
            "job_user": "*************",
            "wait_for_success_or_failure": true,
            "polling_interval": 5,
            "max_number_of_polls": 0,
            "stdout_options": [
                "Job Status",
                "Step Status",
                "Job Monitor"
            ],
            "extension_output_options": [
                "Job Status",
                "Step Status"
            ],
            "job_name_uid": null,
            "job_run_count": null
        }
    },
    "result": {
        "job_status": {
            "JobName": "5D2AABB034F61FE086EDE29830DC6EBC",
            "JobRunCount": "KofppKHq",
            "JobStatus": "F",
            "ReturnCode": 0
        },
        "step_status": [
            {
                "StepCount": 1,
                "StepStatus": "F",
                "StepStartDateTime": "/Date(1744882437000)/",
                "StepAppRC": 0
            },
            {
                "StepCount": 2,
                "StepStatus": "F",
                "StepStartDateTime": "/Date(1744882444000)/",
                "StepAppRC": 0
            },
            {
                "StepCount": 3,
                "StepStatus": "F",
                "StepStartDateTime": "/Date(1744882450000)/",
                "StepAppRC": 0
            },
            {
                "StepCount": 4,
                "StepStatus": "F",
                "StepStartDateTime": "/Date(1744882456000)/",
                "StepAppRC": 0
            },
            {
                "StepCount": 5,
                "StepStatus": "F",
                "StepStartDateTime": "/Date(1744882461000)/",
                "StepAppRC": 0
            },
            {
                "StepCount": 6,
                "StepStatus": "F",
                "StepStartDateTime": "/Date(1744882466000)/",
                "StepAppRC": 0
            }
        ]
    }
}

{
    "exit_code": 1,
    "status_description": "Execution Failed: The job has been cancelled.",
    "invocation": {
        "extension": "ue-sap-btp-appjobs",
        "version": "1.0.0",
        "fields": {
            "action": "Run Job",
            "sap_credential": {
                "user": "STONEBRANCH",
                "password": "****",
                "token": "****",
                "key_location": null,
                "passphrase": "****"
            },
            "url_service": "https://my******.scmibp1.ondemand.com/",
            "job_template": "SB_QA_Template_Step_6",
            "job_name": "Lunched Job Step 6",
            "job_user": "************",
            "wait_for_success_or_failure": true,
            "polling_interval": 5,
            "max_number_of_polls": 0,
            "stdout_options": [
                "Job Status",
                "Step Status",
                "Job Monitor"
            ],
            "extension_output_options": [
                "Job Status",
                "Step Status"
            ],
            "job_name_uid": null,
            "job_run_count": null
        }
    },
    "result": {
        "job_status": {
            "JobName": "5D2AABB034F61FE086EDE7729C6E2EBC",
            "JobRunCount": "bWPfATIb",
            "JobStatus": "C",
            "ReturnCode": 0
        },
        "step_status": [
            {
                "StepCount": 1,
                "StepStatus": "A",
                "StepStartDateTime": "/Date(1744882500000)/",
                "StepAppRC": 0
            },
            {
                "StepCount": 2,
                "StepStatus": "P",
                "StepStartDateTime": null,
                "StepAppRC": 0
            },
            {
                "StepCount": 3,
                "StepStatus": "P",
                "StepStartDateTime": null,
                "StepAppRC": 0
            },
            {
                "StepCount": 4,
                "StepStatus": "P",
                "StepStartDateTime": null,
                "StepAppRC": 0
            },
            {
                "StepCount": 5,
                "StepStatus": "P",
                "StepStartDateTime": null,
                "StepAppRC": 0
            },
            {
                "StepCount": 6,
                "StepStatus": "P",
                "StepStartDateTime": null,
                "StepAppRC": 0
            }
        ]
    }
}

‎

Importable Configuration Examples

This integration provides importable configuration examples along with their dependencies, grouped as Use Cases to better describe end to end capabilities. 

Initial Preparation Steps

• STEP 1: Go to Stonebranch Integration Hub download integration with name "SAP BTP: Application Jobs" and extract the archive in a local directory.
• STEP 2: Locate and import the "SAP BTP Application Jobs" integration to the target Universal Controller. For more information refer to the How To section in this document.
• STEP 3: Inside directory named "configuration_examples" you will find a list of definition zip files. Upload them one by one respecting the order presented below, by using the "Upload" functionality of Universal Controller:
  1. variables.zip
  2. credentials.zip
  3. tasks.zip
  4. workflows.zip

• STEP 4: Update the uploaded UAC Credential entity, with the proper SAP Communication User and Password.
• STEP 5: Update the UAC global variables introduced with the "variables.zip" definition file. Their name is prefixed with "ue_sap_btp_appjobs". Review the description of the variables as they include information on how should be populated.

How "Upload" Definition Files to a Universal Controller

 The "Upload" functionality of Universal Controller allows Users to import definitions exported with the "Download" functionality.

Input Fields

Output Fields

The following output-only fields provide better visibility during the execution of Universal Task Instances.

‎ ‎

Environment Variables

Environment Variables can be set from the Environment Variables task definition table. The following environment variables can affect the behavior of the extension.

‎ ‎

Cancellation and Rerun

• If the Task Instance is cancelled, the Job is also cancelled on the specific target product in the SAP BTP system.

• If the Task Instance is rerun, a new Job will be scheduled from the same Job Template. The Job Name (ID) and Job Run Count will be updated.

Dynamic Commands

Dynamic Command “Abort Job” is available in the “Running” state of the task instance. It is used to forcefully terminate and fail the scheduled Job.

Exit Codes

STDOUT and STDERR

STDOUT is used for displaying Job information. It is controlled by STDOUT Options field.

STDERR provides additional information to the user. The level of detail is tuned by the Log Level Task Definition field.

How To

Import Universal Template

To use the 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. To import the Universal Template into your Controller, follow these instructions.

3. When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.

Modifications of this integration, applied by users or customers, before or after import, might affect the supportability of this integration. For more information refer to Integration Modifications.

Configure Universal Task

For a new Universal Task, create a new task, and enter the required input fields.

Integration Modifications

Modifications applied by users or customers, before or after import, might affect the supportability of this integration. The following modifications are discouraged to retain the support level as applied for this integration.

• Python code modifications should not be done.

• Template Modifications

  • General Section

    • "Name", "Extension", "Variable Prefix", and "Icon" should not be changed.

  • Universal Template Details Section

    • "Template Type", "Agent Type", "Send Extension Variables", and "Always Cancel on Force Finish" should not be changed.

  • Result Processing Defaults Section

    • Success and Failure Exit codes should not be changed.

    • Success and Failure Output processing should not be changed.

  • Fields Restriction Section
    The setup of the template does not impose any restrictions. However, concerning the "Exit Code Processing Fields" section.

    1. Success/Failure exit codes need to be respected.

    2. In principle, as STDERR and STDOUT outputs can change in follow-up releases of this integration, they should not be considered as a reliable source for determining the success or failure of a task.

Users and customers are encouraged to report defects, or feature requests at Stonebranch Support Desk.

Document References

This document references the following documents:

‎ ‎ 

Changelog

ue-sap-btp-appjobs-1.0.0 (2025-05-14)

Initial Version