SCP Macro Service ION APIs in MT Cloud
SCP Macro Service is a set of ION APIs provided to execute a macro and receive the status of job execution. SCP Macro Service provides several APIs to support different functions:
- GET /v1/status: Status of the service. This simply tests whether the service is working.
- POST /v1/execute: Initiates macro execution (can be used to obtain job status).
- GET /v1/job/{jobid}: Returns status of the job execution, if job exists.
Documentation for each of the APIs is accessible directly in the ION APIs application.
This feature supports orchestration of SCP macros in cloud using the APIs in ION workflow, providing job queuing capabilities. It is like the 'SCP Macro tool' command line program provided with On-Premise installations, however, extends it further.
Using existing ION workflow features, one can create dependency links and conditional execution based on previously completed or successful job status.
The macro service requires a valid Infor OS user for execution of the ION APIs. If testing the service from the ION API documentation page, the current logged-in user is considered. This user must have appropriate permissions in SCP to execute a macro.
The use of the runAs parameter requires an additional permission to impersonate user: Macro – Impersonate User to Execute (Process).
The macro execution user requires the permission to execute macros. This user also requires access to the executed macro and macro context, if applicable, for example, the cycle period, scenario and data context.
Calling ION APIs from ION Workflows requires a special configuration with a service account. This process is covered by Infor OS documentation.