DH API

Folder Structure

• The RuncontrolServices folder structure is organized into three subfolders for services: OrchestratorServices, ExecutorServices, and UploadFiles.
• Each service folder initially contains three files: an executable file, a script, and a VBS file (only for Windows for running the service in the background).

Initial Setup

• OrchestratorServices:

  • In orchestrator script, update the following as per the requirement: DB name(MSSQL or ORACLE), DB connection string, schema name and host url(ip:port).

  • The connection string will be of format:

    MSSQL
    Driver={ODBC Driver 17 for SQL Server};Server=servername;Database=dbname;UID=userid;PWD=password;
    
    ORACLE
    userid|password|servername:port/sid

• ExecutorServices:

  • In Executor script, update the following as per the requirement: executor url and orchestrator url.

• UploadFiles:

  • In Upload- Files script, update the following as per the requirement: DB name(MSSQL or ORACLE), DB connection string and schema name.

Starting the service

• Linux:

  • To start a specific service in Linux, simply run the corresponding script.

• Windows:

  • In Windows, starting the service in the background can be achieved by executing the specific VBS file, which internally calls the script.

Testing the service

• To ensure the functionality of the Orchestrator service, the following methods can be employed:

1. Using Curl Command:

curl -X POST --url http://127.0.0.0:6443/batch_full_status/1 -H 'Content-Type: application/json' -d '{ "as_on_date": "2023-03-31", "batch_id": 1, "token" :"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJGRjAxNjM5NEJDM0M0MEJCOUJGRjJGRTRCQzIwQkFCNyIsImlhdCI6MTY4NTY4NTI1OSwiZXhwIjoyMTQ3NDgzNjQ4fQ.QXmLhaR8IRPuZAfm9XB7Sv5G2TpSOX8-rS3YbiOdEKQ"}'

Note: Adjust the IP and port (same as provided for the Orchestrator service), as_on_date, and batch_id according to the requirements.

2. Using a Web Browser: If the curl utility is unavailable, the service can be tested by accessing the URL:

http://127.0.0.0:6443/batches/1

Note: Adjust the IP and port (same as provided for the Orchestrator service), and batch_id (/batches/batch_id) according to the requirements.

RuncontrolService Configuration

OrchestratorServices

This contains the configuration changes needs to be done for different service types.

1. ECL

• For ECL, rule configuration part needs to be updated.

• Additional Mandatory Parameters:

  #	Parameters	Description	Example
  1	client_id	The unique client identifier used to authenticate with the identity server.	72422448-d615-4b41-aea7-bef8ac3763d3
  2	client_secret	The secret key paired with the client ID for secure authentication.	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
  3	auth_url	The identity server endpoint URL used to obtain access tokens.

2. NGINX

• For NGINX, the following additional parameters need to be updated in the script.

• Additional Mandatory Parameters:

  #	Parameters	Description	Example
  1	ssl_mode	Tells the service that Nginx is handling the SSL/HTTPS layer.	NGINX
  2	is_ssl_verification_enabled	Disables SSL certificate verification within the service.	true/false
  3	host_url	The public-facing URL or address through which the Orchestrator service is accessible via Nginx.

ExecutorServices

This contains the configuration changes needs to be done for different service types.

1. NGINX

• For NGINX, the following additional parameters need to be updated in the script.

• Additional Mandatory Parameters:

  #	Parameters	Description	Example
  1	ssl_mode	Tells the service that Nginx is handling the SSL/HTTPS layer.	NGINX
  2	is_ssl_verification_enabled	Disables SSL certificate verification within the service.	true/false
  3	orch_url	The public-facing URL or address through which the Orchestrator service is accessible via Nginx.
  4	exec_url	The public-facing URL or address through which the Executor service is accessible via Nginx.

• Along with script change, the ip present in ExecutoDef table also needs to be changed.