Configuring Automated Nightly Runs for Integration API Processors

Adjust the configuration of inbound Integration API processors to enable automated nightly runs.

Overview

This guide explains how to enable automated nightly runs for an inbound Integration API processor by adjusting the processor configuration.

Enabling nightly runs allows you to ensure that your processors work without disruptions after the deprecation of workflows, which occurred on February 15, 2024. Previously, you could configure a custom schedule for a processor using workflows. To learn more about the deprecation of workflows, see Workflow Services Moving to Nightly Runs in our product updates.

📘

Note

Nightly runs only work on processors that don't require input in LDIF format and directly handle workspace data.

You can configure nightly runs only for inbound processors. For outbound processors, nightly runs are not supported.

Prerequisites

Before you start, ensure that you have administrator access to your workspace.

👍

Tip

For processors with custom scheduled workflows, please contact SAP LeanIX Support to remove the workflows first. Then you can configure automated nightly runs for these processors as described in this guide.

Procedure

  1. In the administration area, navigate to the Integration API section.

  2. On the Integration API page, select an inbound processor that you want to modify.

  3. Within the processor configuration object, add the scheduling object with the type attribute set to NIGHTLY, as shown in the following code. Click Save.

    {
      "processors": [
        {},
        {},
        {}
      ],
      "scheduling": {
        "type": "NIGHTLY"
      }
    }
    

    The following image shows an example processor configuration with the scheduling object.

    Adjusting the Configuration of an Integration API Processor to Enable Automated Nightly Runs

    scheduling Object in the Configuration of an Integration API Processor

Once configured, the processor will automatically run daily between 2 AM and 6 AM local time, as determined by your workspace location.