Profile attributes
Attribute | Description | Value |
---|---|---|
| ID of the profile | Any unused profile ID |
| Name of the profile Note: this is not used during the workflow execution. | Free text |
type | The profile's type | "ContentPreparation" |
isFeatureProfile | ||
features | ||
| The properties used within the rules | |
| The source asset type | Free text |
| The source Asset Device Link (ADL) type |
|
businessRulesProperties.jitp | ||
| The destination asset type | Free |
| The destination ADL type |
|
businessRulesProperties.basedOnEndDate | When set to true, the job start date is based on the editorial content end date. If set to false, it is based on the editorial content start date. If no value is specified, the default value is used. | Default value: true |
businessRulesProperties.dueDateOffset | The job start date offset value in minutes. If no value is specified, the default value is used. | Default value: 0 |
businessRulesProperties.recorderProfileName | ||
| Device to use to allocate resources. This device will be used to manage the max parallel workflow jobs authorised for this profile. |
|
| Name of the workflow. Used by Workflow Manager (CWM) to identify which workflow must be executed. |
|
| The device on which the source asset is present. Used to determine the | |
workflow.sourceDevice.id | The ID of the source device | |
| Defines which access point to use on the source device to access to the source asset. It is used to generate the | |
workflow.ProcessingDevice | The device responsible for transferring assets from the source device to the destination device. | |
workflow.ProcessingDevice.id | The ID of the processing device | |
workflow.ProcessingDevice.accessPointType | The access point to use on the processing device. For both purge and transfer workflows, this is | "command" |
| The device to which to transfer the assets. (Not relevant for purge.) Used to determine the | |
| The ID of the destination device. For the transfer workflow, this is the destination FTP/S3/local repository. | ID of the destination device |
| The access point to use on the destination device. |
|
| The relative path to apply from the destination device access point to generate the |
|
| Parameters used during the execution of the workflow. | |
| Absolute location of the source asset. The Once set, this property must not be updated except for administrative purposes. |
|
workflow.workflowInputProperties.sourceId | ||
workflow.workflowInputProperties.captureEndDate | ||
workflow.workflowInputProperties.ltcuAssetNamePrefix | ||
| The absolute path of the destination folder location to which the assets will be transferred. If Once set, this property must not be updated except for administrative purposes. |
|
workflow.workflowInputProperties.encoderProfileId | The ID of the encoder profile to use | |
| If set to If the source cannot be deleted, the workflow will fail. | |
| If set to If the destination cannot be overwritten, the workflow will fail. | |
| If set to Once completed, the destination asset will be renamed to remove the | |
workflow.workflowInputProperties.cfiLocation | The location where the CFI module is deployed. The values is:
| "sourceDevice" or "destinationDevice" |
workflow.workflowInputProperties.successExtension | Specifies the the extension given to the status file that CFI generates once the asset transfer is successful. The default value is | ".success" |
workflow.workflowInputProperties.errorExtension | Specifies the extension given to the status file that CFI generates when the asset transfer fails. The default value is | ".error" |
workflow.workflowInputProperties.createDestinationDirectoryStructure | If true , the source's directory structure will be created in the destination if it does not exist. | |
workflow.workflowInputProperties.RescheduleOnMissingSource | If true , if a missing source error occurs, the job is rescheduled. | |
workflow.workflowInputProperties.statisticsExtension | Specifies the extension used for the statistics file that CFI generates when the asset transfer completed (whether successful or not). The default value is | ".statistics" |
workflow.workflowInputProperties.checkForSourceAssetPresence | If CWM then uses this information to decide whether to reschedule the job or to mark it as failed. (If this is set to true and the error message matches the one specified in | false |
workflow.workflowInputProperties.missingSourceErrorPattern | The string that CFI writes to the error status file if it detects that the source asset is missing. | "non existing file" |
workflow.workflowInputProperties.jobCompletionTimeout | The job completion timeout. This is the time that CWM waits to get the status from CFI. If it does not receive the status within this time, the job fails. If no value is specified, the default value is used. | Default value: 3600 seconds |
workflow.workflowInputProperties.loopBackTimer | Specifies how often CWM checks for the presence of a CFI status file If no value is specified, the default value is used. | Default value: 10 seconds |
| Enables ( If no value is specified, the default value is used. | Default value: false |
workflow.workflowInputProperties.channelBuffer | The time period in the past (in seconds) that the event must exist in for it to be captured. For example, if you set this to 86400, only events whose start time was in the last 24 hours will have their capture retried. Capture will not be retried for events that are older than 24 hours. | Default: events' age is not considered – all failed jobs are retried. |
workflow.workflowInputProperties.numberOfRetries | The maximum number of CFI connection retries. If CWM cannot establish a connection, it retries the specified number of times before giving up and marking the job as failed. If no value is specified, the default value is used. | Default value: 3 |
workflow.workflowInputProperties.retryDelay | The delay between retries on connection time out. If no value is specified, the default value is used. | Default value: 600 seconds |
workflow.workflowInputProperties.rescheduleDelay | The delay between retries on rescheduling the job. If no value is specified, the default value is used. | Default value: 3600 seconds |
| The maximum number of job reschedule retries. If not configured default values will be used | Default value: 3 |
workflow.workflowInputProperties.recordId | ||
workflow.workflowInputProperties.recorderType | ||
workflow.workflowInputProperties.securityInfo | ||
workflow.workflowInputProperties.captureStartDate | ||
workflow.workflowInputProperties.processingUri | The URL of the CFI module. | |
workflow.workflowInputProperties.proxyAddress | If proxy is enabled, use the specified host/port as the proxy. | |
| Information that results from the execution of the workflow. | |
workflow.workflowOutputProperties.deliveryURL | ||
| Absolute path of the destination asset (that is, including the filename) once the transfer is completed. It must not be updated except for admin purpose. | |
workflow.workflowOutputProperties.recordId | ||
workflow.workflowOutputProperties.consumptionUrls |