Skip to content

/AWS1/CL_TBD=>CREATEJOB()

About CreateJob

Creates a job. A job is a render submission submitted by a user. It contains specific job properties outlined as steps and tasks.

Method Signature

IMPORTING

Required arguments:

IV_FARMID TYPE /AWS1/TBDFARMID /AWS1/TBDFARMID

The farm ID of the farm to connect to the job.

IV_QUEUEID TYPE /AWS1/TBDQUEUEID /AWS1/TBDQUEUEID

The ID of the queue that the job is submitted to.

IV_TEMPLATE TYPE /AWS1/TBDJOBTEMPLATE /AWS1/TBDJOBTEMPLATE

The job template to use for this job.

IV_TEMPLATETYPE TYPE /AWS1/TBDJOBTEMPLATETYPE /AWS1/TBDJOBTEMPLATETYPE

The file type for the job template.

IV_PRIORITY TYPE /AWS1/TBDJOBPRIORITY /AWS1/TBDJOBPRIORITY

The priority of the job on a scale of 1 to 100. The highest priority is 1.

Optional arguments:

IV_CLIENTTOKEN TYPE /AWS1/TBDCLIENTTOKEN /AWS1/TBDCLIENTTOKEN

The unique token which the server uses to recognize retries of the same request.

IT_PARAMETERS TYPE /AWS1/CL_TBDJOBPARAMETER=>TT_JOBPARAMETERS TT_JOBPARAMETERS

The parameters for the job.

IO_ATTACHMENTS TYPE REF TO /AWS1/CL_TBDATTACHMENTS /AWS1/CL_TBDATTACHMENTS

The attachments for the job. Attach files required for the job to run to a render job.

IV_STORAGEPROFILEID TYPE /AWS1/TBDSTORAGEPROFILEID /AWS1/TBDSTORAGEPROFILEID

The storage profile ID for the storage profile to connect to the job.

IV_TARGETTASKRUNSTATUS TYPE /AWS1/TBDCREJOBTGTTASKRUNSTAT /AWS1/TBDCREJOBTGTTASKRUNSTAT

The initial status of the job's tasks when they are created. Tasks that are created with a SUSPENDED status will not run until you update their status.

IV_MAXFAILEDTASKSCOUNT TYPE /AWS1/TBDMAXFAILEDTASKSCOUNT /AWS1/TBDMAXFAILEDTASKSCOUNT

The number of task failures before the job stops running and is marked as FAILED.

IV_MAXRETRIESPERTASK TYPE /AWS1/TBDMAXRETRIESPERTASK /AWS1/TBDMAXRETRIESPERTASK

The maximum number of retries for a job.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_TBDCREATEJOBRESPONSE /AWS1/CL_TBDCREATEJOBRESPONSE