Setting IICS Job Properties Through Scripts

Attributes defined for an object affect how the object is processed. Script statements allow you to dynamically change those object attributes and assign new values when the task is generated. The new values are only valid for the current generation and are not permanently stored in the object.

You can define the values of any of the settings of all IICS Jobs using scripts. You do this by using :PUT_ATT commands on the Pre-Process object definition page.

For more information, see the Automic Automation product documentation:

This page includes the following:

IICS Run Task Job Attributes

The attributes available for IICS Run Task Jobs are the following:

  • connection

    Defines the value of the IICS Connection object.

    Value: text

  • projectName

    Defines the name of the project in which the task is located.

    Value: text

  • folderName

    Defines the name of the folder in which the task is located.

    Value: text

  • taskType

    Defines the task type that you want to execute.

    Value: text

  • taskName

    Defines the name of the task that you want to execute.

    Value: text

  • timeoutInterval

    Defines the amount of time in minutes before the Agent fails the job.

    Value: text

    Default value: 0, indicating no timeout.

  • retrieveTasksSessionLogs

    Defines when task session logs are retrieved.

    Value: On Error (default), Always

IICS Run Taskflow Job Attributes

The attributes available for IICS Run Taskflow Jobs are the following:

  • connection

    Defines the value of the IICS Connection object.

    Value: text

  • taskflowName

    Defines the name of the taskflow that you want to execute.

    Value: text

  • inputFields

    Defines the value of the input field relevant to execute the taskflow.

    Value: JSON

  • failIfSuspended

    Defines if you want the job to fail when taskflow is suspended or not.

    Values: 0 (the suspended state and continue monitoring the job), 1 (fail the job when taskflow is suspended)

    Default value: 1

  • taskFlowWithParamSet

    Defines if you want to run the taskflow using a parameter set or not.

    Values: 0 (do not use a parameter set), 1 (use a parameter set)

    Default value: 0

  • parameterSetName

    Define the name of the parameter set that you want to use to override the one available in the cloud-hosted repository.

    Value: text

  • timeoutInterval

    Defines the amount of time in minutes before the Agent fails the job.

    Value: text

    Default value: 0, indicating no timeout.

  • retrieveTasksSessionLogs

    Defines when task session logs are retrieved.

    Value: On Error (default), Always

IICS Resume Taskflow Job Attributes

The attributes available for IICS Resume Taskflow Jobs are the following:

  • connection

    Defines the value of the IICS Connection object.

    Value: text

  • taskflowInstanceId

    Defines the Run ID of the suspended taskflow.

    Value: text

  • resumeWithFaultyRetry

    Define if you want to resume or skip the failed task in the taskflow:

    • Retry

      Select this option to resume a suspended taskflow instance from a faulted step.

    • Skip

      Select this option to skip a faulted step and resume a suspended taskflow instance from the next step.

    Values: Retry, Skip

  • failIfSuspended

    Defines if you want the job to fail when taskflow is suspended or not.

    Values: 0 (the suspended state and continue monitoring the job), 1 (fail the job when taskflow is suspended)

    Default value: 1

  • timeoutInterval

    Defines the amount of time in minutes before the Agent fails the job.

    Value: text

    Default value: 0, indicating no timeout.

  • retrieveTasksSessionLogs

    Defines when task session logs are retrieved.

    Value: On Error (default), Always

See also: