SAP Advanced Financial Closing SDK for CDS

Integration with SAP Advanced Financial Closing is not yet published. Please refer to What's New for SAP Advanced Financial Closing for the latest updates.

About this Project

SAP Advanced Financial Closing SDK for CDS provides an SDK for SAP Advanced Financial Closing to be consumed with SAP Cloud Application Programming Model.

Table of Contents

• Requirements and Setup
• Getting Started
• CAP Node.js
  • Usage
  • Architecture
  • Options
  • Implement
    • Job Processing
    • Job Provider
    • Periodic Job Sync
  • API
  • Redis
  • Feature Toggles
• CAP Java
  • Usage
  • Architecture
  • Options
  • Implement
    • Job Processing
    • Job Provider
    • Periodic Job Sync
  • API
• Deployment
• Service Broker
• Miscellaneous
  • Testing
  • Authorization
  • Work Zone
  • Multitenancy
• Support, Feedback, Contributing
• Code of Conduct
• Licensing

Requirements and Setup

SAP Advanced Financial Closing (AFC) lets you define, automate, process, and monitor the entity close for your organization.

• To develop and test applications build with this SDK you need a CAP Node.js or CAP Java project
• To integrate you need access to an instance of SAP Advanced Financial Closing

Getting Started

A new CDS project can be initialized using SAP Build Code tools on SAP Business Technology Platform (BTP) or @sap/cds-dk CLI command cds init can be used to bootstrap a new CAP application. See capire.

Boostrap CDS

SAP Build Code:

• Open SAP Build Lobby
• Press Create
• Select objective Application
• Choose category Full-Stack
• Select type Full-Stack Node.JS or Full-Stack Java
• Provide project name and dev space
• Press Review
• Press Create
• Open project in SAP Business Application Studio

CDS Command-Line-Interface:

• Terminal: npm install -g @sap/cds-dk
• Init a new CDS project:
  • Terminal:
    • CAP Node.js: cds init <name>
    • CAP Java: cds init <name> --java
• Switch to project folder:
  • Terminal: cd <name>
• Install
  • Terminal: npm install

Adding SDK

• Add AFC SDK
  • Terminal npm install @cap-js-community/sap-afc-sdk
• Use afc command
  • Add globally:
    • Terminal: npm install -g @cap-js-community/sap-afc-sdk
  • Use locally:
    • Terminal: npx afc
• Init target environment
  • Cloud Foundry:
    • Terminal: afc init cf
  • Kyma:
    • Terminal: afc init kyma
• Add SDK features
  • Terminal: afc add broker,sample,http

Test Project

• Terminal: npm start
• Browser:
  • CAP Node.js: http://localhost:4004
  • CAP Java: http://localhost:8080

CAP Node.js

The SAP Advanced Financial Closing SDK for CDS provides a plugin for SAP Cloud Application Programming Model (CAP) for Node.js to extend and integrate with SAP Advanced Financial Closing (AFC). Specifically, it provides an out-of-the-box implementation of the SAP Advanced Financial Closing Scheduling Service Provider Interface to expose a Scheduling Provider service to manage Job definitions and Jobs.

Furthermore, it brings the following out-of-the-box features:

• API: Exposes a RESTful API implementing the AFC Scheduling Provider Interface to manage Job definitions and Jobs
• Event-Queue: Provides an Event Queue to process and synchronize Jobs (periodically) asynchronously and resiliently (circuit breaker, retry, load-balancing, etc.)
• Websocket: Provides websocket connection support to monitor Job processing live
• Feature-Toggle: Provides a feature toggle library to control the execution of the Event Queue
• UI: Provides a UI5 application to monitor and cancel Jobs
• Broker: Implements a service broker to manage service key management to API

Usage

• Run npm add @cap-js-community/sap-afc-sdk in @sap/cds CAP Node.js project
• Execute npm start to start server
  • Access welcome page at http://localhost:4004
  • Access Applications
    • /launchpad.html: Sandbox Launchpad
    • /scheduling.monitoring.job: Standalone Scheduling Monitoring Job UI
  • Access Service Endpoints
    • Public API
      • /api/job-scheduling/v1: Scheduling Provider API (OpenAPI Swagger UI)
    • OData API (UI)
      • /odata/v4/job-scheduling/monitoring: Job Scheduling Monitoring ($metadata)
    • WebSocket API
      • /ws/job-scheduling: Scheduling WebSocket endpoint
    • REST API
      • /rest/feature: Feature Toggle API
    • CDS Internal API
      • SchedulingProcessingService: Scheduling Processing service

        const schedulingProcessingService = await cds.connect.to("SchedulingProcessingService");

      • SchedulingWebsocketService: Scheduling Websocket service

        const schedulingWebsocketService = await cds.connect.to("SchedulingWebsocketService");

Architecture

The SAP Advanced Financial Closing SDK for CDS is build on the following architecture open source building blocks as depicted in the following diagram:

• WebSocket Adapter for CDS (https://github.com/cap-js-community/websocket)
  • Exposes a WebSocket protocol via WebSocket standard or Socket.IO for CDS services. Runs in context of the SAP Cloud Application Programming Model (CAP) using @sap/cds (CDS Node.js).
• Event Queue for CDS (https://github.com/cap-js-community/event-queue)
  • The Event-Queue is a framework built on top of CAP Node.js, designed specifically for efficient and streamlined asynchronous event processing
• Feature Toggle Library for CDS (https://github.com/cap-js-community/feature-toggle-library)
  • SAP BTP feature toggle library enables Node.js applications using the SAP Cloud Application Programming Model to maintain live-updatable feature toggles via Redis

Using the SAP Advanced Financial Closing SDK a 3rd-party scheduling provider can be built for SAP Advanced Financial Closing. The architectural design of the SAP Advanced Financial Closing (AFC) SDK for implementing a Scheduling Provider is based on the SAP Cloud Application Programming Model (CAP) and SAP Build Code. It leverages the @cap-js-community open-source components to enable scheduling services in AFC.

The following diagram illustrates the high-level architecture of the SAP Advanced Financial Closing SDK for CDS (Node.js):

Key components and processing flow:

• SAP Advanced Financial Closing (AFC):
  • Sends scheduling requests via AFC Scheduling Service Provider Interface using REST API (OpenAPI)
• Scheduling Provider Service:
  • Handles incoming scheduling requests
  • Creates scheduling jobs synchronously and places asynchronous requests into the Event Queue
• Scheduling Processing Service:
  • Processes scheduled jobs asynchronously
  • Retrieves job requests from the Event Queue and executes them.
• Scheduling WebSocket Service:
  • Listens for status updates of scheduled jobs
  • Notifies the Monitoring Scheduling Job UI via WebSockets when job statuses change
• Scheduling Monitoring Service:
  • Monitoring Scheduling Job UI (SAP Fiori Elements V4 / SAP UI5 application)
  • Reads scheduling job details from the database
  • Supports monitoring via OData V4 API
  • Displays scheduling job statuses and updates in real-time via WebSockets
• Event Queue & Feature Toggles:
  • Event Queue (using CDS Outbox) facilitates asynchronous job execution
  • Feature Toggles allow influence Job and Event Queue processing dynamically
• Database & Redis Caching:
  • Stores job scheduling data in the database
  • Redis is used for information distribution (e.g. Event Queue, WebSockets, Feature Toggles)

Options

Options can be passed to SDK via CDS environment in cds.requires.sap-afc-sdk section:

• endpoints: Object: Endpoint configuration. Default is {}
  • endpoints.approuter: String: Url of approuter. Default is null (derived from conventions <app>-srv)
  • endpoints.server: String: Url of server. Default is null (derived from environment, e.g. CF)
• api: Object: API configuration on /api paths. Default see below
  • api.cors: Boolean | Object: Cross-Origin Resource Sharing (CORS) configuration for cors module on /api paths. Default is { origin: true }
    • api.cors.origin: Boolean | String | String[]: Cross-Origin Resource Sharing (CORS) origin configuration. Default is true (allow approuter url)
  • api.csp: Object | Boolean: Content Security Policy (CSP) directives for helmet module on /api paths. Default is false
• ui: Object | Boolean: UI configuration. Use false to disable UI. Default is {}
  • ui.path: String: Path to the served UI5 application. Default is ''
  • ui.link: Boolean: Fill link of jobs to served UI5 launchpad, if null. Default is true
  • ui.swagger: Boolean | Object: Serve API docs via Swagger UI. Default is true
    • ui.swagger.SchedulingProviderService: Boolean: Serve API docs of Scheduling Provider via Swagger UI. Default is true
  • ui.launchpad: Boolean: Serve launchpad. Default is true
  • ui."scheduling.monitoring.job": Boolean: Serve Scheduling Monitoring Job UI separately, if no Launchpad is served. Default is true
• broker: Boolean | Object: Broker configuration. Serve broker endpoint, if truthy. Default is false and true in production
• mockProcessing: Boolean | Object: Activate mocked job processing. Default is false
  • mockProcessing.min: Number: Minimum processing time in seconds. Default is 0
  • mockProcessing.max: Number: Maximum processing time in seconds. Default is 10
  • mockProcessing.default: String: Default processing status. Default is completed
  • mockProcessing.status: Object: Status distribution values. Default is {}
    • mockProcessing.status.completed: Number: Completed status distribution value. Default is 0
    • mockProcessing.status.completedWithWarning: Number: Completed With Warning status distribution value. Default is 0
    • mockProcessing.status.completedWithError: Number: Completed With Error status distribution value. Default is 0
    • mockProcessing.status.failed: Number: Failed status distribution value. Default is 0
• config: Object: Advanced SDK configuration. See config.json. Default is {}

Implement

The SDK provides a set of services to implement the job processing service and the scheduling provider service.

Job Processing

The job processing service is responsible for processing the jobs.

Mock Processing

The library includes a mocked processing for jump-start development, which is disabled by default via option. cds.requires.sap-afc-sdk.mockProcessing: false

Setting option cds.requires.sap-afc-sdk.mockProcessing: true a basic mocked job processing completes jobs based on a random time value between 0-10 seconds:

{
  "cds": {
    "requires": {
      "sap-afc-sdk": {
        "mockProcessing": {
          "min": 0,
          "max": 10,
          "default": "completed"
        }
      }
    }
  }
}

The project can be adjusted to use basic mock processing automatically via command:

• Terminal: afc add -b mock

A more advanced mocked Job processing can be configured by setting the following CDS env options (as described in options):

{
  "cds": {
    "requires": {
      "sap-afc-sdk": {
        "mockProcessing": {
          "min": 0,
          "max": 10,
          "default": "completed",
          "status": {
            "completed": 0.5,
            "completedWithWarning": 0.2,
            "completedWithError": 0.2,
            "failed": 0.1
          }
        }
      }
    }
  }
}

This default advanced mocked Job processing can be also configured by using CDS profile mock via --profile mock or CDS_ENV=mock.

The project can be adjusted to use advanced mock processing (without additional mock profile) automatically via command:

• Terminal: afc add -a mock

Mock configuration can be adjusted in package.json afterward.

To disable mock processing remove CDS env cds.requires.sap-afc-sdk.mockProcessing, e.g. via command:

• Terminal: afc add -x mock

The default implementation of the job processing is already provided by the SDK. Focus can be put on custom processing logic, and the processing status update handling.

Custom Processing

To implement a custom job processing extend the job processing service definition as follows:

CDS file: /srv/scheduling-processing-service.cds

using SchedulingProcessingService from '@cap-js-community/sap-afc-sdk';

annotate SchedulingProcessingService with @impl: '/srv/scheduling-processing-service.js';

Implementation file: /srv/scheduling-processing-service.js

const { SchedulingProcessingService, JobStatus } = require("@cap-js-community/sap-afc-sdk");

class CustomSchedulingProcessingService extends SchedulingProcessingService {
  async init() {
    const { processJob, updateJob, cancelJob, syncJob } = this.operations;

    this.on(processJob, async (req, next) => {
      // Your logic goes here
      await next();
    });

    this.on(updateJob, async (req, next) => {
      // Your logic goes here
      await next();
    });

    this.on(cancelJob, async (req, next) => {
      // Your logic goes here
      await next();
    });

    this.on(syncJob, async (req, next) => {
      // Your logic goes here
      await next();
    });

    super.init();
  }
}

module.exports = CustomSchedulingProcessingService;

A stub implementation for custom scheduling processing service can be generated via command:

• Terminal: afc add stub

As part of the custom scheduling process service implementation, the following operations can be implemented:

• on(processJob):
  • A new job instance was created and needs to be processed
  • The job is due (start date time is reached), and the job is ready for processing
  • Implement your custom logic, how the job should be processed
  • Job ID is accessible via req.data.ID and job data can be accessed via req.job
  • Test run can be identified via flag req.data.testRun (if job definition supports test mode)
  • Call await next() to perform default implementation (set status to running)
  • Job update can be performed via this.processJobUpdate() providing the new status and job results
    • e.g. await this.processJobUpdate(req, JobStatus.completed, results)
  • Result data object shall contain stream objects to prevent data materialization
  • Throwing exceptions will automatically trigger the retry process in Event Queue
  • Disable mocked job processing via cds.requires.sap-afc-sdk.mockProcessing: false (default).
• on(updateJob):
  • A job status update is requested and the job results are stored
  • Implement your custom logic, how the job status should be updated
  • Job data can be retrieved via req.job
  • Job status transition is validated via async checkStatusTransition(req, statusBefore, statusAfter)
    • Valid status transitions are defined in this.statusTransitions
    • Check function and status transitions can be customized
  • Job results are checked and processed via async checkJobResults(req, results)
    • Valid results are valid according to job results signature constraints (see below)
    • Returns the processed job results to be inserted
  • Call await next() to perform default implementation (update status to requested status)
• on(cancelJob):
  • A job cancellation is requested
  • Implement your custom logic, how the job should be canceled
  • Job data can be retrieved via req.job
  • Call await next() to perform default implementation (update status to canceled)

The job results signature is defined as follows:

type ResultTypeCode   : String enum {
  link;
  data;
  message;
};

type MessageSeverityCode : String enum {
  success;
  info;
  warning;
  error;
};

type JobResult {
  name     : String(255) not null;
  type     : ResultTypeCode not null;
  link     : String(5000);
  mimeType : String(255);
  filename : String(5000);
  data     : LargeBinary;
  messages : many JobResultMessage;
};

type JobResultMessage {
  code      : String(255) not null;
  text      : String(5000);
  severity  : MessageSeverityCode not null;
  createdAt : Timestamp;
  texts     : many JobResultMessageText;
};

type JobResultMessageText {
  locale : Locale not null;
  text   : String(5000);
};

Multiple job results can be passed for job update. The following constraints apply for each job result type:

• link:
  • Properties name and link need to be provided
  • Other properties are not allowed
• data:
  • Properties name, mimeType, filename and data need to be provided
  • Data needs to be provided as base64 encoded string
  • Other properties are not allowed
• message:
  • Properties name and messages need to be provided
  • Messages need to be provided as array of job result messages
  • Other properties are not allowed

Job processing is performed as part of the Event Queue processing. The Event Queue is a framework built on top of CAP Node.js, designed specifically for efficient and streamlined asynchronous event processing. In case of errors, the Event Queue provides resilient processing (circuit breaker, retry, load-balancing, etc.).

In addition, to overwriting the default implementation via an on handler, also additional before and after handlers can be registered.

Job Provider

A job provider service is already provided per default by the SDK, implementing the SAP Advanced Financial Closing Scheduling Service Provider Interface. Therefore, focus can be put on additional custom provider logic (e.g. streaming of data from a remote location).

The SAP Advanced Financial Closing Scheduling Service Provider Interface is published on SAP Business Accelerator Hub under package SAP Advanced Financial Closing at https://api.sap.com/api/SSPIV1.

To implement a custom job provider extend the job provider service definition as follows:

CDS file: /srv/scheduling-provider-service.cds

using SchedulingProviderService from '@cap-js-community/sap-afc-sdk';

annotate SchedulingProviderService with @impl: '/srv/scheduling-provider-service.js';

Implementation file: /srv/scheduling-provider-service.js

const { SchedulingProviderService } = require("@cap-js-community/sap-afc-sdk");

class CustomSchedulingProviderService extends SchedulingProviderService {
  async init() {
    const { Job, JobResult } = this.entities;

    this.on("CREATE", Job, async (req, next) => {
      // Your logic goes here
      await next();
    });

    this.on(Job.actions.cancel, Job, async (req, next) => {
      // Your logic goes here
      await next();
    });

    this.on(JobResult.actions.data, JobResult, async (req, next) => {
      // Your logic goes here
      await next();
    });

    super.init();
  }
}

module.exports = CustomSchedulingProviderService;

A stub implementation for custom scheduling provider service can be generated via command:

• Terminal: afc add stub

As part of the custom scheduling provider service implementation, the following operations can be implemented:

• on("CREATE", Job):
  • Validates and creates a new job instance
  • Call await next() to perform default implementation
  • after: Calls scheduling processing service function processJob
• on(Job.actions.cancel, Job):
  • Cancels a job
  • Call await next() to perform default implementation
  • after: Calls scheduling processing service function cancelJob
• on(JobResult.actions.data, JobResult):
  • Call await next() to perform default implementation
  • Streams data of a job result (type data) from DB to response

In addition, to overwriting the default implementation via an on-handler, also additional before and after handlers can be registered.

Periodic Job Sync

A periodic scheduling job synchronization event named SchedulingProcessingService.syncJob is running per default every 1 minute in the Event Queue, to perform job synchronization from an external source. The default implementation is a no-op.

The event syncJob is registered automatically with cron interval */1 * * * * in the Event Queue configuration. To change the cron interval, the Event Queue configuration can be adjusted in the CDS env:

CDS Env:

{
  "cds": {
    "requires": {
      "SchedulingProcessingService": {
        "outbox": {
          "events": {
            "syncJob": {
              "cron": "*/2 * * * *"
            }
          }
        }
      }
    }
  }
}

The cron interval option defines the periodicity of the scheduling job synchronization.

CDS file: /srv/scheduling-processing-service.cds

using SchedulingProcessingService from '@cap-js-community/sap-afc-sdk';

annotate SchedulingProcessingService with @impl: '/srv/scheduling-processing-service.js';

Implementation file: /srv/scheduling-processing-service.js

const { SchedulingProcessingService } = require("@cap-js-community/sap-afc-sdk");

class CustomSchedulingProcessingService extends SchedulingProcessingService {
  async init() {
    const { syncJob } = this.operations;

    this.on(syncJob, async (req, next) => {
      // Your logic goes here
      await next();
    });

    super.init();
  }
}

module.exports = CustomSchedulingProcessingService;

A stub implementation for periodic job sync can be generated via command:

• Terminal: afc add stub

Details on how to implement periodic event via Event Queue can be found in Event-Queue documentation on Periodic Events.

API

The SDK based application expose the scheduling provider API. The out-of-the-box open service broker implementation can be used to manage service keys and access tokens to the API. After Deployment the Service Broker can be registered in Cloud Foundry.

After adding the broker to project via afc add broker, the default configuration is located at:

• srv/broker.json: Open service broker configuration
• srv/catalog.json: Open service broker catalog configuration

In addition, the broker configuration can be provided via options as part of CDS environment in cds.requires.sap-afc-sdk.broker section.

More details on how to use the service broker can be found in the Service Broker section.

Redis

The application can be scaled by adding a Redis cache to distribute workload across application instances. Add Redis to the project (already part of Adding SDK for CAP Node.js):

• Terminal: cds add redis

Redis is used by @cap-js-community/event-queue, @cap-js-community/websocket and @cap-js-community/feature-toggle-library modules to process events, distribute websocket messages and store and distribute feature toggles values.

Feature Toggles

The Feature Toggle Library is used to control the execution of the Event Queue. It exposes endpoints to manage feature toggles:

• GET /rest/feature/state(): Read current feature toggle state
• POST /rest/feature/redisUpdate: Update feature toggle state

See .http files in /http/toggles to call feature toggle endpoints. An internal OAuth token needs to be fetched via /http/auth/uaa.internal.cloud.http providing credentials from XSUAA instance or via calling:

• Terminal: afc api key -i

CAP Java

The SAP Advanced Financial Closing SDK for CDS provides a plugin for SAP Cloud Application Programming Model (CAP) for Java to extend and integrate with SAP Advanced Financial Closing (AFC). Specifically, it provides an out-of-the-box implementation of the SAP Advanced Financial Closing Scheduling Service Provider Interface to expose a Scheduling Provider service to manage Job definitions and Jobs. Furthermore, it brings the following out-of-the-box virtues:

• API: Exposes a RESTful API implementing the AFC Scheduling Provider Interface to manage Job definitions and Jobs
• Outbox: Provides an Outbox to process and synchronize Jobs (periodically) asynchronously and resiliently (circuit breaker, retry, load-balancing, etc.)
• Websocket: Provides websocket connection support to monitor Job processing live
• UI: Provides a UI5 application to monitor and cancel Jobs
• Broker: Implements a service broker to manage service key management to API

Usage

• Run npm add @cap-js-community/sap-afc-sdk in and com.sap.cds CAP Java project

• Execute npm start to start server

  • Access welcome page at http://localhost:8080

  • Access Applications

    • /launchpad.html: Sandbox Launchpad
    • /scheduling.monitoring.job: Standalone Scheduling Monitoring Job UI

  • Access Service Endpoints

    • Public API

      • /api/job-scheduling/v1: Scheduling Provider API (OpenAPI Swagger UI)

    • OData API (UI)

      • /odata/v4/job-scheduling/monitoring: Job Scheduling Monitoring ($metadata)

    • WebSocket API

      • /ws/job-scheduling: Scheduling WebSocket endpoint

    • CDS Internal API

      • SchedulingProcessingService: Scheduling Processing service

        @Autowired
        private SchedulingProcessingService processingService;

      • SchedulingWebsocketService: Scheduling Websocket service

        @Autowired
        private SchedulingWebsocketService websocketService;

Architecture

The SAP Advanced Financial Closing SDK for CDS is build on the following architecture open source building blocks as depicted in the following diagram:

Using the SAP Advanced Financial Closing SDK a 3rd-party scheduling provider can be built for SAP Advanced Financial Closing. The architectural design of the SAP Advanced Financial Closing (AFC) SDK for implementing a Scheduling Provider is based on the SAP Cloud Application Programming Model (CAP) and SAP Build Code.

The following diagram illustrates the high-level architecture of the SAP Advanced Financial Closing SDK for CDS (Java):

Key components and processing flow:

• SAP Advanced Financial Closing (AFC):
  • Sends scheduling requests via AFC Scheduling Service Provider Interface using REST API (OpenAPI)
• Scheduling Provider Service:
  • Handles incoming scheduling requests
  • Creates scheduling jobs synchronously and places asynchronous requests into the Event Queue
• Scheduling Processing Service:
  • Processes scheduled jobs asynchronously
  • Retrieves job requests from the Event Queue and executes them.
• Scheduling WebSocket Service:
  • Listens for status updates of scheduled jobs
  • Notifies the Monitoring Scheduling Job UI via WebSockets when job statuses change
• Scheduling Monitoring Service:
  • Monitoring Scheduling Job UI (SAP Fiori Elements V4 / SAP UI5 application)
  • Reads scheduling job details from the database
  • Supports monitoring via OData V4 API
  • Displays scheduling job statuses and updates in real-time via WebSockets
• Transactional Outbox:
  • CDS Transactional Outbox facilitates asynchronous job execution
• Database:
  • Stores job scheduling data in the database

Options

Options can be passed to SDK via Spring Boot environment in sap-afc-sdk section:

• endpoints: Object: Endpoint configuration. Default is {}
  • endpoints.approuter: String: Url of approuter. Default is null (derived from conventions <app>-srv)
  • endpoints.server: String: Url of server. Default is null (derived from environment, e.g. CF)
• api: Object: API configuration on /api paths. Default see below
  • api.cors: Object: Cross-Origin Resource Sharing (CORS) configuration cors module on /api paths. Default is { origin: true }
    • api.cors.origin: Boolean | String | String[]: Cross-Origin Resource Sharing (CORS) origin configuration. Default is true (allow approuter url)
    • api.cors.methods: String | String[]: Cross-Origin Resource Sharing (CORS) allow methods configuration. Default is []
    • api.cors.heqaders: String | String[]: Cross-Origin Resource Sharing (CORS) allow headers configuration. Default is []
    • api.cors.credentials: Boolean: Cross-Origin Resource Sharing (CORS) allow credentials configuration. Default is true
• ui: Object: UI configuration. Default is {}
  • ui.enabled: Boolean: UI apps are served. Default is false and true in cloud
• broker: Object: Service broker configuration. Default is {}
  • broker.name: String: Name of the broker. Default is <project name>
  • broker.enabled: Boolean: Is broker enabled. Default is false
  • broker.user: String: Name of the broker user. Default is broker-user
  • broker.credentialsHash: String: Credentials hash of the broker user. Default is generated
  • broker.endpoints: Object: Endpoints of the broker. Default is { api: "/api", job-scheduling-v1: "/api/job-scheduling/v1" }
  • broker.oauth2-configuration.credential-types: String[]: Credential types of the broker oauth2 configuration. Default is ["binding-secret", "x509"]
  • broker.authorities: String[]: Scope authorities. Default is []
• mockProcessing: Object: Activate mocked job processing. Default is {}
  • mockProcessing.min: Number: Minimum processing time in seconds. Default is 0
  • mockProcessing.max: Number: Maximum processing time in seconds. Default is 10
  • mockProcessing.default: String: Default processing status. Default is completed
  • mockProcessing.status: Object: Status distribution values. Default is {}
    • mockProcessing.status.completed: Number: Completed status distribution value. Default is 0
    • mockProcessing.status.completedWithWarning: Number: Completed With Warning status distribution value. Default is 0
    • mockProcessing.status.completedWithError: Number: Completed With Error status distribution value. Default is 0
    • mockProcessing.status.failed: Number: Failed status distribution value. Default is 0
• syncJob: Object: Sync job configuration. Default see below
  • cron: String: Sync job cron interval. Default is 0 */1 * * * *
• tenantCache: Object: Tenant cache configuration. Default see below
  • cron: String: Tenant cache invalidation cron interval. Default is 0 */30 * * * *

Implement

The SDK provides a set of services to implement the job processing service and the scheduling provider service.

Job Processing

The job processing service is responsible for processing the jobs.

Mock Processing

The library includes a mocked processing for jump-start development, which is disabled by default (no sap-afc-sdk.mock-processing config in application.yml).

Setting option sap-afc-sdk.mockProcessing a basic mocked job processing completes jobs based on a random time value between 0-10 seconds:

sap-afc-sdk:
  mock-processing:
    min: 0
    max: 10
    default: completed

The project can be adjusted to use basic mock processing automatically via command:

• Terminal: afc add -b mock

A more advanced mocked Job processing can be configured by setting the following CDS env options (as described in options):

sap-afc-sdk:
  mock-processing:
    min: 0
    max: 10
    default: completed
    status:
      completed: 0.5
      completedWithWarning: 0.2
      completedWithError: 0.2
      failed: 0.1

The project can be adjusted to use advanced mock processing automatically via command:

• Terminal: afc add -a mock

Mock configuration can be adjusted in application.yaml afterward.

To disable mock processing remove config sap-afc-sdk.mockProcessing, e.g. via command:

• Terminal: afc add -x mock

The default implementation of the job processing is already provided by the SDK. Focus can be put on custom processing logic, and the processing status update handling.

Custom Processing

To implement a custom job processing extend the job processing service definition as follows:

Implementation file: srv/src/main/java/customer/scheduling/CustomSchedulingProcessingHandler.java

package customer.scheduling;

import com.github.cap.js.community.sapafcsdk.model.schedulingprocessingservice.*;
import com.github.cap.js.community.sapafcsdk.scheduling.base.SchedulingProcessingBase;
import com.sap.cds.services.handler.annotations.HandlerOrder;
import com.sap.cds.services.handler.annotations.On;
import com.sap.cds.services.handler.annotations.ServiceName;
import org.springframework.stereotype.Component;

@Component
@ServiceName(SchedulingProcessingService_.CDS_NAME)
public class CustomSchedulingProcessingHandler extends SchedulingProcessingBase {

  @On(event = ProcessJobContext.CDS_NAME)
  @HandlerOrder(HandlerOrder.EARLY)
  public void processJob(ProcessJobContext context) {
    // Your logic goes here
    context.proceed();
  }

  @On(event = UpdateJobContext.CDS_NAME)
  @HandlerOrder(HandlerOrder.EARLY)
  public void updateJob(UpdateJobContext context) {
    // Your logic goes here
    context.proceed();
  }

  @On(event = CancelJobContext.CDS_NAME)
  @HandlerOrder(HandlerOrder.EARLY)
  public void cancelJob(CancelJobContext context) {
    // Your logic goes here
    context.proceed();
  }

  @On(event = SyncJobContext.CDS_NAME)
  @HandlerOrder(HandlerOrder.EARLY)
  public void syncJob(SyncJobContext context) {
    // Your logic goes here
    context.proceed();
  }
}

A stub implementation for custom scheduling processing service can be generated via command:

• Terminal: afc add stub

As part of the custom scheduling process service implementation, the following operations can be implemented:

• processJob:
  • A new job instance was created and needs to be processed
  • The job is due (start date time is reached), and the job is ready for processing
  • Implement your custom logic, how the job should be processed
  • Job ID is accessible via context.get("ID")
  • Test run can be identified via flag context.get("testRun") (if job definition supports test mode)
  • Call context.proceed() to perform default implementation (set status to running)
  • Job update can be performed via this.processJobUpdate() providing the new status and job results
    • e.g. this.processJobUpdate(context, JobStatusCode.completed, results)
  • Throwing exceptions will automatically trigger the retry process in outbox
  • Disable mocked job processing by deleting sap-afc-sdk.mockProcessing (default).
• updateJob:
  • A job status update is requested and the job results are stored
  • Implement your custom logic, how the job status should be updated
  • Job ID is accessible via context.get("ID")
  • Job status transition is validated via this.checkStatusTransition(context, statusBefore, statusAfter)
    • Valid status transitions are defined in this.statusTransitions
    • Check function and status transitions can be customized
  • Job results are checked and processed via checkJobResults(context, results)
    • Valid results are valid according to job results signature constraints (see below)
    • Returns the processed job results to be inserted
  • Call context.proceed() to perform default implementation (update status to requested status)
• cancelJob:
  • A job cancellation is requested
  • Implement your custom logic, how the job should be canceled
  • Job ID is accessible via context.get("ID")
  • Call context.proceed() to perform default implementation (update status to canceled)

The job results signature is defined as follows:

type ResultTypeCode   : String enum {
  link;
  data;
  message;
};

type MessageSeverityCode : String enum {
  success;
  info;
  warning;
  error;
};

type JobResult {
  name     : String(255) not null;
  type     : ResultTypeCode not null;
  link     : String(5000);
  mimeType : String(255);
  filename : String(5000);
  data     : LargeBinary;
  messages : many JobResultMessage;
};

type JobResultMessage {
  code      : String(255) not null;
  text      : String(5000);
  severity  : MessageSeverityCode not null;
  createdAt : Timestamp;
  texts     : many JobResultMessageText;
};

type JobResultMessageText {
  locale : Locale not null;
  text   : String(5000);
};

Multiple job results can be passed for job update. The following constraints apply for each job result type:

• link:
  • Properties name and link need to be provided
  • Other properties are not allowed
• data:
  • Properties name, mimeType, filename and data need to be provided
  • Data needs to be provided as base64 encoded string
  • Other properties are not allowed
• message:
  • Properties name and messages need to be provided
  • Messages need to be provided as array of job result messages
  • Other properties are not allowed

Job processing is performed as part of the Event Queue processing. The Event Queue is a framework built on top of CAP Node.js, designed specifically for efficient and streamlined asynchronous event processing. In case of errors, the Event Queue provides resilient processing (circuit breaker, retry, load-balancing, etc.).

In addition, to overwriting the default implementation via an on handler, also additional before and after handlers can be registered.

Job Provider

A job provider service is already provided per default by the SDK, implementing the SAP Advanced Financial Closing Scheduling Service Provider Interface. Therefore, focus can be put on additional custom provider logic (e.g. streaming of data from a remote location).

The SAP Advanced Financial Closing Scheduling Service Provider Interface is published on SAP Business Accelerator Hub under package SAP Advanced Financial Closing at https://api.sap.com/api/SSPIV1.

To implement a custom job provider extend the job provider service definition as follows:

Implementation file: srv/src/main/java/customer/scheduling/CustomSchedulingProviderHandler.java

package customer.scheduling;

import com.github.cap.js.community.sapafcsdk.model.schedulingproviderservice.*;
import com.github.cap.js.community.sapafcsdk.scheduling.base.SchedulingProviderBase;
import com.sap.cds.services.cds.CdsCreateEventContext;
import com.sap.cds.services.cds.CqnService;
import com.sap.cds.services.handler.annotations.HandlerOrder;
import com.sap.cds.services.handler.annotations.On;
import com.sap.cds.services.handler.annotations.ServiceName;
import java.util.List;
import org.springframework.stereotype.Component;

@Component
@ServiceName(SchedulingProviderService_.CDS_NAME)
public class CustomSchedulingProviderHandler extends SchedulingProviderBase {

  @On(event = CqnService.EVENT_CREATE, entity = Job_.CDS_NAME)
  @HandlerOrder(HandlerOrder.EARLY)
  public void createJob(CdsCreateEventContext context, List<Job> jobs) {
    // Your logic goes here
    context.proceed();
  }

  @On(event = JobCancelContext.CDS_NAME, entity = Job_.CDS_NAME)
  @HandlerOrder(HandlerOrder.EARLY)
  public void cancelJob(JobCancelContext context) {
    // Your logic goes here
    context.proceed();
  }

  @On(event = JobResultDataContext.CDS_NAME, entity = JobResult_.CDS_NAME)
  @HandlerOrder(HandlerOrder.EARLY)
  public void downloadData(JobResultDataContext context) {
    // Your logic goes here
    context.proceed();
  }
}

A stub implementation for custom scheduling provider service can be generated via command:

• Terminal: afc add stub

As part of the custom scheduling provider service implementation, the following operations can be implemented:

• createJob:
  • Validates and creates a new job instance
  • Call context.proceed() to perform default implementation
  • after: Calls scheduling processing service function processJob
• cancelJob:
  • Cancels a job
  • Call context.proceed() to perform default implementation
  • after: Calls scheduling processing service function cancelJob
• downloadData:
  • Call context.proceed() to perform default implementation
  • Streams data of a job result (type data) from DB to response

In addition, to overwriting the default implementation via an on-handler, also additional before and after handlers can be registered.

Periodic Job Sync

A periodic scheduling job synchronization event named SchedulingProcessingService.syncJob is running per default every 1 minute in Spring scheduling tasks, to perform job synchronization from an external source. The default implementation is a no-op.

The event syncJob is registered automatically with interval Spring scheduling configuration. To change the interval, the application.yaml configuration can be adjusted in the Spring environment:

Application file:

sap-afc-sdk:
  syncJob:
    cron: 0 */2 * * * *

Implementation file: srv/src/main/java/customer/scheduling/CustomSchedulingProcessingHandler.java

package customer.scheduling;

import com.github.cap.js.community.sapafcsdk.model.schedulingprocessingservice.*;
import com.github.cap.js.community.sapafcsdk.scheduling.base.SchedulingProcessingBase;
import com.sap.cds.services.handler.annotations.HandlerOrder;
import com.sap.cds.services.handler.annotations.On;
import com.sap.cds.services.handler.annotations.ServiceName;
import org.springframework.stereotype.Component;

@Component
@ServiceName(SchedulingProcessingService_.CDS_NAME)
public class CustomSchedulingProcessingHandler extends SchedulingProcessingBase {

  @On(event = SyncJobContext.CDS_NAME)
  @HandlerOrder(HandlerOrder.EARLY)
  public void syncJob(SyncJobContext context) {
    // Your logic goes here
    context.proceed();
  }
}

A stub implementation for periodic job sync can be generated via command:

• Terminal: afc add stub

API

The SDK based application expose the scheduling provider API. The out-of-the-box open service broker implementation can be used to manage service keys and access tokens to the API. After Deployment the Service Broker can be registered in Cloud Foundry.

After adding the broker to project via afc add broker, the default configuration is located in application.yaml at:

spring:
  cloud:
    openservicebroker:
      catalog:
        services: ...

For details see Spring Cloud Open Service Broker documentation.

More details on how to use the service broker can be found in the Service Broker section.

Deployment

To fully test the application, also accessing APIs from external, a deployment needs to be performed. BTP offers different deployment options, depending on the target environment (Cloud Foundry or Kyma).

Cloud Foundry

• Add MTA feature (already part of Adding SDK for Cloud Foundry)
  • Terminal: afc init cf
• Build MTA
  • Terminal: mbt build
• Deploy MTA
  • Terminal: cf deploy mta_archives/<mta>.mtar
• For details see guide Deployment to CF

Kyma

• Add helm feature (already part of Adding SDK for Kyma)
  • Terminal: afc init kyma
• Configuration
  • Set global domain in chart/values.yaml
  • Set global image registry in chart/values.yaml
  • Set repository in containerize.yaml
  • Set endpoints to approuter and server in sap-afc-sdk env to Kyma API rule hosts
• Containerize
  • Terminal: ctz containerize.yaml --push
• Upgrade
  • Terminal: helm upgrade --install <name> ./gen/chart -n <namespace>
• Rollout
  • Terminal: kubectl rollout restart deployment -n <namespace>
• For details see guide Deployment to Kyma

Service Broker

An Open Service Broker compliant broker implementation can be added to the CAP project. The broker is used to manage service key management to the API in a Cloud Foundry environment.

• Add broker and service configuration (already part of Adding SDK)
  • Terminal: afc add broker
• Deploy to CF (see Deployment to Cloud Foundry)
• Get API key credentials
  • Terminal: afc api key
• Use API key credentials
  • Swagger UI:
    • Open URL: https://<server-url>/api-docs/api/job-scheduling/v1/
    • Click Authorize and provide key credentials for client_id and client_secret
    • Try out endpoints
  • HTTP Client:
    • Add .http files
    • Update .http files placeholders
      • Terminal: afc api key -h
    • Perform OAuth token request using key credentials (clientId, clientSecret)
      • See http/auth/uaa.cloud.http for obtaining an OAuth token
      • Via CLI:
        • Terminal: afc api key -t
    • Call API using OAuth token
      • See .http files in /http to call API endpoints
      • See .http files in /http/scheduling to call scheduling provider API endpoints
    • Clear credentials in .http files via
      • Terminal: afc api key -c
  • Destination:
    • A destination file for an API endpoint can be created via command:
      • Terminal: afc add key -d -e <endpoint>
    • A destination file for Job Scheduling Provider API can be created via command:
      • Terminal: afc add key -d -j
• Reset API management in CF
  • Terminal: afc api key -r

Miscellaneous

Testing

The application can be tested locally using the following steps:

• Start application
  • Terminal: npm start
• Open welcome page
  • Browser:
    • CAP Node.js: http://localhost:4004
    • CAP Java: http://localhost:8080

Sample data

To add sample job definitions and job instances run:

• Terminal: afc add sample

Test data will be placed at /db/data

Unit-Tests

To add unit-tests for testing the API endpoints run:

• Terminal: afc add test

Test files will be placed at /test.

.http files

To add .http files for testing the API endpoints run

• Terminal: afc add http

HTTP files will be placed at /http.

Authorization

Authentication Method

The SDK supports authentication via xsuaa or ias. xsuaa is the default:

• xsuaa: Authentication via XSUAA service.
  • Boostrap SDK via cds init <target> xsuaa
  • Service Broker feature can be used to manage service keys and access tokens
• ias: Authentication via SAP Cloud Identity Services.
  • Boostrap SDK via cds init <target> ias
  • Is used to authenticate users for application and apis (broker feature is not available)

Service Restrictions

Scheduling Provider Service can be restricted for authorization adding @requires annotation:

using SchedulingProviderService from '@cap-js-community/sap-afc-sdk';

annotate SchedulingProviderService with @requires: 'JobScheduling';

Details can be found in CDS-based Authorization.

Work Zone

For development and testing purposes UIs are served as part of the server. Exposed UIs can be accessed via the server welcome page. For productive usage, UIs should be served via HTML5 repo:

• Add Work Zone and HTML5 Repo features (already part of Adding SDK)
  • Terminal: cds add workzone,html5-repo
• Setup and configure SAP Work Zone instance using HTML5 Apps Content Channel
  • Add Monitor Scheduling Jobs app to Content Explorer
  • Assign app to a group, role and site to be accessible
• (CAP Node.js) Disable UI served in server via CDS env: cds.requires.sap-afc-sdk.ui: false
• (Optional) Apps from AFC SDK can also be copied over into project at /app for further adjustments:
  • Terminal: afc add app

Multitenancy

The project can be enabled for multitenancy by following the guide: https://cap.cloud.sap/docs/guides/multitenancy/#enable-multitenancy

The MTX Tool is used to manage the application lifecycle. It can be used to manage the application in Cloud Foundry. Details can be found at https://github.com/cap-js-community/mtx-tool.

Support, Feedback, Contributing

This project is open to feature requests/suggestions, bug reports etc. via GitHub issues. Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines.

Code of Conduct

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its Code of Conduct at all times.

Licensing

Copyright 2025 SAP SE or an SAP affiliate company and sap-afc-sdk contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.