Skip to navigation
ExtensibilityWorkflowCreate and manage workflow definitionsWorkflow referenceWorkflow task referenceFile: Bulk Data Loader

File: Bulk Data Loader - Task settings

View as Markdown

This reference describes the settings of the File: Bulk Data Loader task.

Object

File (required) - The name of the file object in the workflow data payload to be uploaded for bulk processing. This must match an entry in the Files data structure produced by a previous task.

Bulk job configuration

The Bulk job configuration group corresponds to the parameters field in the schema and controls how the Bulk Data Loader job is created.

  • Name (required)Name of the Bulk Data Loader job. Maximum length is 255 characters.

  • Description (optional)Short description of the job. Maximum length is 255 characters.

  • Job type (required)Type of the bulk job being created. Supported values are: ImportDeleteUpdateCancel The default value is Import.

  • Object type (required)Type of the object for bulk processing. The value must be one of the object types supported by the Bulk Data Loader API (for example, account, invoice, payment, subscription, usage, and other supported objects in your tenant).

    (optional) Short description of the job. Maximum length is 255 characters.

  • Mappings (required)List of mappings that map source fields in the input file to target fields in the object. Each mapping maps a source field to a target field.

Additional Settings

  • Headers (optional)List of headers in the source file. This field is required if the source file does not have a header row.

  • Row ID header (optional)Header in the source file that contains the row ID.

  • Delimiter (optional)Delimiter used in the source file. Supported values are: comma, tab, pipe, semicolon, colon, caret, tilde, dot

    The default value is comma.

  • Has headers (optional)Indicates whether the source file has a header row. Default: false.

Failure handling

Fail task if any records fail (optional) - When this option is selected (true), the task is marked as failed if any records fail processing (rowsFailed > 0) even when the job status is Completed. When this option is cleared (false, the default), the task fails only if the job status is Failed; a Completed job with some failed rows does not fail the task.

Shared fields

The following shared fields are also available on this task and behave the same as on other Workflow tasks:

  • workflow_tags (optional, array, default empty)
  • strict_variables (optional, string, default "true")
  • disable_validation (optional, string, default "false")
  • delete_payload_paths (optional, array, default empty)

For details about how these shared fields work, see the general Workflow task reference.

Concurrency Mode

Concurrency Mode: Controls whether Workflow processes tasks in a single or multi-threaded manner for this task type. Select Sequential to single-thread, or Parallel to allow multi-threaded processing.

If you select Parallel, the Max Concurrency setting controls the maximum number of threads for this task type that can be utilized. You can specify a value from 1 up to the allowed maximum for this task type. A value of 1 behaves the same as Sequential processing.