Disclaimer

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

Version Information

Refer to Changelog for version history information.

Overview

The SAP Business Technology Platform (BTP) Job Scheduling Service delivers a streamlined, runtime-agnostic mechanism for orchestrating one-time or recurring jobs, whether triggering REST endpoints or launching Cloud Foundry tasks. It supports cron and human-readable formats, OAuth 2.0‑secure multitenant execution, and can be managed via a web dashboard for automating business processes in Cloud Foundry environments.

This integration builds on SAP BTP’s scheduler by offering a simplified interface for job creation, deployment, and lifecycle management. Users can schedule and trigger job runs immediately, retrieve information relating to the run progress in real time, and choose from flexible output options. Completed job schedules may be automatically deleted based on the run’s outcome, reducing manual cleanup.

Key Features

Requirements

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

Supported Actions

There is one Top-Level action controlled by the Action Field:

• Schedule & Run Job

Monitoring capabilities, as well as capabilities for retrieval of information relating to the job being executed are provided. 

Action Output

{
	"exit_code": 0,
	"status_description": "Job scheduled and executed successfully",
	"invocation": {
		"extension": "ue-sap-btp-jss",
		"version": "1.0.0",
		"fields": { ... }
	},
	"result": {
		"job_run_logs": "[2025-07-23 08:47:57] This message was printed to STDOUT by executed task",
		"job_run_info": {
			"runId": "c29faef3-2c94-4e6a-ab34-2543f9f6937e",
			"httpStatus": 202,
			"executionTimestamp": "2025-07-23 08:47:09",
			"runStatus": "COMPLETED",
			"runState": "SUCCESS",
			"statusMessage": "The endpoint has successfully executed the job",
			"scheduleTimestamp": "2025-07-23 08:47:09",
			"completionTimestamp": "2025-07-23 08:48:17"
		}
	}
}

{
	"exit_code": 1,
	"status_description": "Execution Failed: The job 'failing_job(12345)' has ended in failure.",
	"invocation": {
	"extension": "ue-sap-btp-jss",
	"version": "1.0.0",
	"fields": { ... }
	},
	"result": {
		"job_run_logs": null,
		"job_run_info": {
			"runId": "fd61f232-8f95-4527-be2e-7f9b67db9e6d",
			"httpStatus": 404,
			"executionTimestamp": "2025-07-23 09:18:01",
			"runStatus": "COMPLETED",
			"runState": "REQUEST_ERROR",
			"statusMessage": "Error encountered while sending job execution request to the endpoint",
			"scheduleTimestamp": "2025-07-23 09:18:01",
			"completionTimestamp": "2025-07-23 09:18:01"
		}
	}
}

--- Job Run Monitoring Events ---
Event Received:
	Timestamp: 2025-07-23 08:47:09
	Type: SCHEDULED
	Message: Next run at 2025-07-23 08:47:09 (UTC)
	Code: None


Event Received:
	Timestamp: 2025-07-23 08:47:09
	Type: TRIGGERED
	Message: 
	Code: None


Event Received:
	Timestamp: 2025-07-23 08:47:09
	Type: ACK_RECVD
	Message: CF task created with state RUNNING
	Code: 202


Event Received:
	Timestamp: 2025-07-23 08:48:17
	Type: SUCCESS
	Message: Logs: Exit status 0, Task finished successfully.
	Code: 200


--- Executed Job Logs ---
[2025-07-23 08:47:57] This message was printed to STDOUT by executed task
[2025-07-23 08:48:57] This is another message printed by the task
[2025-07-23 08:49:57] Yet another message printed by the task

Configuration Examples

Example: Schedule a Job for Immediate Execution

This configuration specifies an Authentication URL and an API URL. After selecting a specific job or task through the relevant dynamic choice field, it is scheduled for immediate execution, and the task returns immediately after verifying execution has been triggered.

Example: Schedule a Job for Immediate Execution and wait for its completion

This configuration specifies an Authentication URL and an API URL. After selecting a specific job or task through the relevant dynamic choice field, it IS scheduled for immediate execution, with the task waiting for its completion. Upon completion, all output options have been selected and will be displayed to the appropriate output streams. Job Run Logs are to be included only if produced by the executed job or task. Upon completion, the created schedule will be deleted if the run is successful.

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 and download the "SAP: BTP Job Scheduling Service" integration. Extract the downloaded archive on a directory in a local drive.

• STEP 2: Locate and import the above integration to the target Universal Controller. For more information refer to the "How To" section in this document

• STEP 3: For "SAP: BTP Job Scheduling Service", 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: 

  • variables.zip

  • credentials.zip

  • scripts.zip

  • tasks.zip

  • workflows.zip

• STEP 4: Update the uploaded UAC Credential entity introduced with proper Username / Password

• STEP 5: Update the UAC global variables introduced with variables.zip file. Their name is prefixed with "ue_sap_btp_jss". Review the descriptions of the variables as they include information on how they should be populated.

How to "Upload" Definition Files to a Universal Controller

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

Login to Universal Controller and:

• STEP 1: Click on "Tasks" → "All Tasks"

• STEP 2: Right click on the top of the column named "Name"

• STEP 3: Click "Upload..."

In the pop-up "Upload..." dialogue:

• STEP 1: Click "Choose File".

• STEP 2: Select the appropriate zip definition file and click "Upload".

• STEP 3: Observe the Console for possible errors.

Use Case 1: SAP BTP JSS - Job Scheduling & Execution and Email Notification.

Description

In this Use Case, the workflow demonstrates how to schedule and execute a job using SAP BTP Job Scheduling Service (JSS) and send an email notification based on the job's outcome (success or failure).

The tasks configured demonstrate the following capabilities among others:

• Scheduling and executing a job in SAP BTP Job Scheduling Service.

• Monitoring the job execution status.

• Sending an appropriate email notification upon job completion (success or failure).

The components of the solution are described below:

• "UC1: SAP BTP JSS - Schedule Job for Execution" – Schedules and executes a job in SAP BTP JSS.

• "UC1: SAP BTP JSS - Send Email for Success" – Sends a success notification email if the job completes successfully.

• "UC1: SAP BTP JSS - Send Email for Failure" – Sends a failure notification email if the job fails.

How to Run

Execution Steps:

STEP 1: Manually start the workflow. This triggers the first task, "UC1: SAP BTP JSS - Schedule Job for Execution", which schedules and runs a job in SAP BTP JSS.

STEP 2: The workflow monitors the job status.

• If the job completes successfully, the second task, "UC1: SAP BTP JSS - Send Email for Success", sends a success email to the configured recipients.

• If the job fails, the alternative task, "UC1: SAP BTP JSS - Send Email for Failure", sends a failure email notification.

Expected Results:

• The job is successfully scheduled and executed in SAP BTP JSS.

• A success email is sent if the job completes successfully.

• A failure email is sent if the job fails, including relevant error details.

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.

Cancelation and Rerun

In case of Cancelation, the currently running schedule is not deleted or altered in any way. Instead, only monitoring capabilities are stopped.

In case of Rerun, a completely new schedule is created, and the job is run inside of it.

Exit Codes

STDOUT and STDERR

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

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

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