Skip to Content
Technical Articles
Author's profile photo Ian Henry

Scheduling RMS Flows in Data Intelligence via the Internal API

The DI (Data Intelligence) RMS (Replication Management Service) provides initial loads or initial  and delta, sometimes a scheduled delta is preferred.

In this blog post I will describe how we can achieve a scheduled delta with an RMS Flow and/or RMS Tasks. At the time of writing (November 2022) the Data Intelligence scheduler doesn’t allow that, which why this blog exists.

  1. Identify the Internal API Calls
  2. Additional API Calls Identified
  3. Data Intelligence pipeline for scheduling

1. Identify the Internal API Calls

Figure%201.1%20RMS%20Flows%20vs%20RMS%20Tasks

Figure 1.1 RMS Flows vs RMS Tasks

For clarity Figure 1.1 shows the relationship of RMS Flows to RMS Tasks, one flow can contain multiple tasks.

The official public DI API does not cover the RMS (Replication Management Service), this requires using the internal (unsupported) API, this has worked flawlessly in my testing. In fact most actions within Data Intelligence use internal APIs and that includes the management of RMS Flows and the RMS Tasks.

To understand the RMS internal API, check the browser developer tools and inspect the API calls.
Here, the GET calls are mainly used to populate the UI and the PUT stop and start the flows or tasks.

Figure%201.2%3A%20Developer%20Tools%2C%20Network%20trace

Figure 1.2: Developer Tools, Network trace

The requirement I have is to stop and start an entire RMS Flow. This is performed by the PUT calls, using the query parameter requestType. The flow name makes up the last part of the URL The resulting API call is below.

https://vsystem.ingress.{{Tenant}}.dhaas-live.shoot.live.k8s-hana.ondemand.com/app/rms/api/dt/v1/replicationflows/{{flowname}}?requestType=RUN_OR_RESUME_ALL_INACTIVE_TASKS

requestType paramers

Stop – SUSPEND_ALL_ACTIVE_TASKS

Start – RUN_OR_RESUME_ALL_INACTIVE_TASKS

As described in the Pubic Data Intelligence API, to use a Data Intelligence PUT API call you need to use the header as below.

x-requested-with: Fetch

Initial testing was done with Postman to confirm the API behaviour.

Figure%201.3%3A%20Postman%20to%20Validate%20API%20Calls

Figure 1.3: Postman to Validate API Calls

 

2. Additional API Calls Identified

Here are some additional API calls that were identified and could be useful to enhance the workflow and/or capture some statistics as to the performance of the replication process. These are not necessary for the the scheduling process, more for reference.

GET all flow statuses
source, target, status, change date, user
/app/rms/api/dt/v1/replicationflows/

GET specified flow details and tasks
source, target, connection, container, output format, load type
/app/rms/api/dt/v1/replicationflows/{{flowname}}

GET specified flow configuration
Priority, max connections source and target
/app/rms/api/dt/v1/replicationflows/{{flowname}}/configuration

GET (Monitor) specified flow
source, target, connection, container, output format, status, duration
/app/rms/api/dt/v1/replicationflowMonitors?name={{flowname}}

GET (Monitor) tasks in specified flow
/app/rms/api/dt/v1/replicationflows/{{flowname}}/taskMonitors
Source, target, priority, load type, status, number of records, number of partitions, duration, bytes sent

GET Status of last flow (PUT) action
Status, time of change
/app/rms/api/dt/v1/replicationflows/{{flowname}}/changerequeststatus

PUT start specified flow
/app/rms/api/dt/v1/replicationflows/{{flowname}}?requestType=RUN_OR_RESUME_ALL_INACTIVE_TASKS

PUT stop specified flow
/app/rms/api/dt/v1/replicationflows/{{flowname}}?requestType=SUSPEND_ALL_ACTIVE_TASKS

PUT start specified task(s) within flow
/app/rms/api/dt/v1/replicationflows/{{flowname}}?requestType=RUN_OR_RESUME_SELECTIVE_INACTIVE_TASKS
In the request body you need to specify the task name, the name is the name as shown from the “Get specified flow details and tasks” API call

PUT stop specified task(s) within flow
/app/rms/api/dt/v1/replicationflows/{{flowname}}?requestType=SUSPEND_SELECTIVE_ACTIVE_TASKS
In the request body you need to specify the task name, the name is the name as shown from the “Get specified flow details and tasks” API call

 

3. Data Intelligence pipeline for scheduling

To be able to schedule these actions I have created a simple pipeline to call these APIs and log the output of the call. The pipeline, which triggers the RMS flow can then be scheduled to run at the required times.

Using the Data Intelligence connection management provides a secure place to store the credentials.

Figure 3.1: Open API Connection

We can then use this connection in the Open API pipeline operator. The flowname is specified as a placeholder parameter, this will be set at runtime or during scheduling.

Figure 3.2: OpenAPI Pipeline

The operator is built using JavaScript, which makes it lighweight and easily transportable between environments.

Figure%202.2%3A%20Set%20Header%20Code

Figure 3.3: Set Header Code

The set header operator passes two attributes required for the API, the header and the query parameter requestType.

Figure%202.3%3A%20Capture%20the%20API%20Response%20to%20the%20Pipeline%20Log

Figure 3.4: Log API Output

I captured the API Response to monitor how the API responded to the request. Storing this in the pipeline log provides tracability.

This pipeline can now be run directly or scheduled to stop and start the RMS Flows. It should have the same effect as doing this from the User Interface. This pipeline does not check the status or activity of the RMS Flow, but it does allow the RMS Flow to be scheduled. One pipeline would start the RMS flow running and another pipeline stops it.

Figure%202.5%3A%20Schedule%20pipeline

Figure 3.5: Schedule pipeline

I have placed the pipeline json file in a shared github, this can be imported directly into the Data Intelligence Modeler.

Conclusion

With a small amount of development effort, we can interact with the RMS internal API and stop and start the RMS Flows.  Far more is possible with the RMS API, including logic that captures the RMS performance, tracked the activity and status.

Assigned Tags

      Be the first to leave a comment
      You must be Logged on to comment or reply to a post.