Table of Contents

Search

  1. Preface
  2. Informatica Intelligent Cloud Services REST API
  3. Platform REST API version 2 resources
  4. Platform REST API version 3 resources
  5. Data Integration REST API
  6. Mass Ingestion Files REST API
  7. Mass Ingestion Streaming REST API
  8. RunAJob utility
  9. ParamSetCli utility
  10. REST API codes
  11. REST API resource quick references

REST API Reference

REST API Reference

Using the RunAJob utility

Using the
RunAJob utility

To use the
RunAJob utility
, type the
RunAJob utility
command followed by arguments.
The following string is the
RunAJob utility
command:
cli.bat runAJobCli
For each job, you must specify the task or taskflow to run. The syntax that you use to run a
Data Integration
taskflow is slightly different from the syntax you use to run a task.

Running tasks

The following command is an example of the syntax you can use to run a task using the task name and location to specify the task:
cli.bat runAJobCli -t <tasktype> -n <task name> -fp <folder path to the task>
For example, to run a
Mass Ingestion
file ingestion
task, you might use the following command:
cli.bat runAJobCli -t MI_TASK -n mitask_Arch_2308 -fp myproject/folder1
The following command is an example of the syntax you can use to run a job using the federated task ID to specify the task:
cli.bat runAJobCli -t <tasktype> -fi <federated task ID>
For example, to run a
Data Integration
synchronization
task using the federated task ID, you might use the following command:
cli.bat runAJobCli -t DSS -fi kvOF40yLXyUihm7wYYskmh

Running
Data Integration
taskflows

To run a taskflow using the
RunAJob utility
, the taskflow must be published and you must include values for
Allowed Users
and
Allowed Groups
in the taskflow designer. For more information, see
Taskflows
.
For each job, you must specify the taskflow to run using the taskflow's name.
To run a taskflow, use the following syntax:
cli.bat runAJobCli -t TASKFLOW -un <taskflow name>
For example, you might use the following command:
cli.bat runAJobCli -t TASKFLOW -un myPublishedTaskflow

Running
Data Integration
taskflows using parameter sets

You can use a parameter set to provide values for taskflow input parameters and run the taskflow using the
RunAJob utility
.
You can download the RunAJob utility from the following community article:
When you run a taskflow that uses a parameter set, type the
RunAJob utility
command followed by the
-pun
or
--parameterSetUniqueName
argument.
To run a taskflow using the RunAJob utility, the taskflow must be published and you must include values for
Allowed Users
and
Allowed Groups
in the taskflow designer. For more information about taskflows, see the Taskflows documentation.
To run a taskflow that uses a parameter set, use one of the following syntaxes:
cli.bat runAJobCli -t TASKFLOW -un <taskflow_name> -fp <folder_path> -pun <unique_param_set_name>
cli.bat runAJobCli -t TASKFLOW -un <taskflow_name> -fp <folder_path> --parameterSetUniqueName <unique_param_set_name>
For example:
cli.bat runAJobCli -t TASKFLOW -un myTaskflow -fp myproject/folder1 -pun sampleParamSet
cli.bat runAJobCli -t TASKFLOW -un myTaskflow -fp myproject/folder1 --parameterSetUniqueName sampleParamSet
All taskflows run by using the
/tf
endpoint from the RunAJob utility.
If you use the utility on Linux and you use another script or wrapper script to call cli.sh, be sure to comment the following line in the cli.sh file:
cd "$SCRIPT_DIR"
If you do not comment this line, you might receive the following error:
Could not find or load main class com.informatica.saas.utilities.plugins.RunAJobPlugin.

0 COMMENTS

We’d like to hear from you!