DocumentCaptureTask.submit()

Method Description

Submits the document capture task for asynchronous processing.

This method returns a unique ID for the document capture task. When the submission is successful, this method adds the script IDs of any dependent tasks (added using DocumentCaptureTask.addInboundDependency(options)) to the DocumentCaptureTask.inboundDependencies property.

Use the task.DocumentCaptureTaskStatus object to view the status of a submitted document capture task. The task.checkStatus(options) method returns a task.DocumentCaptureTaskStatus object when you specify a task ID that represents a document capture task.

Returns

string

Supported Script Types

Server scripts

For more information, see SuiteScript 2.x Script Types.

Governance

100 units

Module

N/task Module

Parent Object

task.DocumentCaptureTask

Sibling Object Members

DocumentCaptureTask Object Members

Since

2025.2

Errors

Error Code	Thrown If
`CANNOT_RESUBMIT_SUBMITTED_DOCUMENT_CAPTURE_TASK`	The document capture task was already submitted and completed successfully.
`DOCUMENT_CAPTURE_DEPENDENCY_SS_ALREADY_SUBMITTED`	A dependent scheduled script task is already submitted and is not complete.
`DOCUMENT_CAPTURE_DEPENDENCY_SS_INCORRECT_STATUS`	The status of the script deployment record for the specified dependent scheduled script task has a value other than “Not Scheduled”.
`DOCUMENT_CAPTURE_DEPLOYMENT_FOR_DEPENDENCY`	A script deployment record for the specified dependent script task is not available for one of the following reasons: A script deployment record was not specified when the dependent task was created, and automatic lookup for an available script deployment record failed. The script deployment record specified when the dependent task was created is not found.
`DOCUMENT_CAPTURE_MULTIPLE_DEPENDENCIES`	The same dependent task is passed to this method more than one time.
`DOCUMENT_CAPTURE_SCRIPT_ID_NOT_FOUND`	The specified dependent task is not found.
`FAILED_TO_SUBMIT_JOB_REQUEST_1`	The document capture task cannot be submitted due to an unexpected error.
`MUST_IDENTIFY_A_FILE`	The DocumentCaptureTask.outputFilePath property specifies a folder and not a file.
`SSS_MISSING_REQD_ARGUMENT`	A required property is not specified.
`THAT_RECORD_DOES_NOT_EXIST`	The DocumentCaptureTask.inputFile property references a file that does not exist.
`YOU_DO_NOT_HAVE_ACCESS_TO_THE_MEDIA_ITEM_YOU_SELECTED`	You do not have permission to access the file specified by the DocumentCaptureTask.inputFile property.

Error Code

Thrown If

CANNOT_RESUBMIT_SUBMITTED_DOCUMENT_CAPTURE_TASK

The document capture task was already submitted and completed successfully.

DOCUMENT_CAPTURE_DEPENDENCY_SS_ALREADY_SUBMITTED

A dependent scheduled script task is already submitted and is not complete.

DOCUMENT_CAPTURE_DEPENDENCY_SS_INCORRECT_STATUS

The status of the script deployment record for the specified dependent scheduled script task has a value other than “Not Scheduled”.

DOCUMENT_CAPTURE_DEPLOYMENT_FOR_DEPENDENCY

A script deployment record for the specified dependent script task is not available for one of the following reasons:

A script deployment record was not specified when the dependent task was created, and automatic lookup for an available script deployment record failed.
The script deployment record specified when the dependent task was created is not found.

DOCUMENT_CAPTURE_MULTIPLE_DEPENDENCIES

The same dependent task is passed to this method more than one time.

DOCUMENT_CAPTURE_SCRIPT_ID_NOT_FOUND

The specified dependent task is not found.

FAILED_TO_SUBMIT_JOB_REQUEST_1

The document capture task cannot be submitted due to an unexpected error.

MUST_IDENTIFY_A_FILE

The DocumentCaptureTask.outputFilePath property specifies a folder and not a file.

SSS_MISSING_REQD_ARGUMENT

A required property is not specified.

THAT_RECORD_DOES_NOT_EXIST

The DocumentCaptureTask.inputFile property references a file that does not exist.

YOU_DO_NOT_HAVE_ACCESS_TO_THE_MEDIA_ITEM_YOU_SELECTED

You do not have permission to access the file specified by the DocumentCaptureTask.inputFile property.

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/task Module Script Samples.

            // Add additional code
...
var myDocCaptureTask = task.create({
    taskType: task.TaskType.DOCUMENT_CAPTURE
});
// Submit the task
var myTaskId = myDocCaptureTask.submit();

// Check the task status
var myStatus = task.checkStatus({
    taskId: myTaskId
});
...
// Add additional code

Errors

Syntax

Related Topics