REST API Reference > RunAJob utility > RunAJob utility setup
  

RunAJob utility setup

To set up the RunAJob utility, create copies of the template files that are included with the utility and configure the new files.
The following table describes the RunAJob utility template files:
File name
Description
Restenv_default.properties
Specifies login credentials and job polling behavior.
Set_cli_vars_default.bat
Specifies the keystore password that stores the encryption key on Windows machines.
Set_cli_vars_default.sh
Specifies the keystore password that stores the encryption key on Linux machines.
Log4j2_default.properties
Specifies the level of detail to return in log files.
You can find the template files in the following location:
<Secure Agent installation directory>\apps\runAJobCli
To customize the RunAJob properties, copy the template files, remove _default from the file names, and then configure the properties. Alternatively, you can update existing copied files if you already have them. Use the template files that are included with the utility as a reference.

Login properties

Specify Informatica Intelligent Cloud Services login credentials in the restenv.properties file or include the login parameters as arguments in a task command.
Use login credentials for a native Informatica Intelligent Cloud Services user account. You can't use a SAML user account for the RunAJob utility.
Include the following parameters in the restenv.properties file or in task commands:
Parameter
Description
baseUrl
Base URL.
Default is https://dm-us.informaticacloud.com/ma.
username
Informatica Intelligent Cloud Services user name.
password
Informatica Intelligent Cloud Services password or encrypted password string.
For more information about password encryption, see Using an encrypted password.
use.encryption
Enables use of an encrypted password. To use an encrypted password, set the value to true.
CONNECT_TIMEOUT_SECONDS
Specifies the connection timeout period to accommodate network issues or latency specific to your environment. Default is 30 seconds.
For more information, see RunAJob utility arguments

Using an encrypted password

You can encrypt your login password before you specify it in the restenv.properties file or a task command.
    1Use the template files to set a password for the keystore that stores the encryption key.
    1. aIf you're using a Linux machine, copy the template file set_cli_vars_default.sh and rename it to set_cli_vars.sh. If you're using a Windows machine, copy the template file set_cli_vars_default.bat and rename it to set_cli_vars.bat.
    2. bEdit the file to specify your keystore password in the following format: set RUNAJOB_KEYSTORE_PASSWORD=<password>
    2To encrypt your login password, run one of the following commands:
    3In the restenv.properties file, set the password to the encrypted string.
    4Set the use.encryption property to true.
The following example shows the restenv.properties file with an encrypted password and the use.encryption property set to true:
username=saki
password=:1xCGDTC0oD9B2Rmd8Sr4IZWaWWkcEmiK5fy+GkycA==
ACTIVITYMONITORWAIT=2000
TOTALWAIT=60000
PROXYHOST=
PROXYPORT=
RETRYCOUNT=30
use.encryption=true

Job status

Specify the frequency at which the RunAJob utility polls for status in the restenv.properties file.
You can use the following parameters:
Parameter
Description
ACTIVITYMONITORWAIT
Amount of time the utility waits before retrying if an internal exception occurs, such as a login failure or network problem.
Default is 5000 milliseconds.
TOTALWAIT
Maximum amount of time the utility waits for a job to complete before polling the activity monitor and activity log again for status.
Default is 5000 milliseconds.
RETRYCOUNT
Number of times the utility polls for status. Default is six. This parameter is used for polling the activity monitor and activity log for job status and for internal exceptions such as network failures.
Login failures are retried up to five times.
Note: Informatica Intelligent Cloud Services adds 10 seconds between each API call to prevent server issues.
When you configure the restenv.properties file to poll job status, consider the values you set for TOTALWAIT and RETRYCOUNT, and keep in mind the amount of time you expect a job to run.
For example, if you expect a job to run for approximately 25 minutes, you might set the the following parameters:
TOTALWAIT=60000
RETRYCOUNT=30
With these settings, the utility polls the job status every 60 seconds up to 30 times with 10 seconds between each retry, which totals 35 minutes. If the job runs for more than 35 minutes, the command exits with return code 6, which means the job is running. The job continues to run in Informatica Intelligent Cloud Services.
When you configure the restenv.properties file for internal exceptions, consider the values you set for ACTIVITYMONITOR and RETRYCOUNT.
For example, you might set the following parameters:
ACTIVITYMONITORWAIT=5000
RETRYCOUNT=30
With these settings, if the network fails, the utility retries the login every five seconds up to five times with an additional 10 seconds between each retry.

Log file detail

You can set the level of job detail to include in log files in the log4j2.properties file.
By default, the level of detail is set to INFO. At this level, log files include basic information such as user ID, job ID, and the time that the task was initiated. If you want log files to include job details for debugging purposes, you can change the level of detail to DEBUG. Or, for fine-grained details, you can change the level to TRACE.
To set the level of detail, change the value of the following parameter in the log4j2.properties file:
rootLogger.level=INFO