task.DocumentCaptureTask

Object Description

An asynchronous document capture task. Use the methods and properties for this object to submit a document capture task to the NetSuite task queue and execute it asynchronously.

You can create a task.DocumentCaptureTask object using task.create(options). You can populate the properties of this object as you create it. With a task.DocumentCaptureTask object, you can do the following:

Specify the following information about the document capture task:
- The document to extract content from using the DocumentCaptureTask.inputFile property. This property accepts a file.File object that represents a supported document in the NetSuite File Cabinet.
- The document type using the DocumentCaptureTask.documentType property. Use a value from the documentCapture.DocumentType enum to set the value of this property.
- The feature content to extract from the document (such as fields, tables, or text) using the DocumentCaptureTask.features property. Use values from the documentCapture.Feature to set the value of this property. If you don't specify any features, the TEXT_EXTRACTION and TABLE_EXTRACTION features are used by default.
- The language of the document using the DocumentCaptureTask.language property. Use a value from the documentCapture.Language enum to set the value of this property. If you don't specify a language, English is used by default.
- Oracle Cloud Infrastructure (OCI) credentials for unlimited usage mode using the DocumentCaptureTask.ociConfig property. If you don't specify these credentials, the document capture task consumes usage from the free usage pool provided in NetSuite by default. For more information, see Using OCI Credentials to Obtain Additional Usage.

Set the file path of a JSON file in the NetSuite File Cabinet using the DocumentCaptureTask.outputFilePath property. Document capture results are exported to this file.
Add dependent tasks to the document capture task using DocumentCaptureTask.addInboundDependency(options). Dependent tasks are processed automatically when the document capture task is complete.
Submit the document capture task to the task queue using DocumentCaptureTask.submit().
Get the status of a document capture task using the properties of an associated task.DocumentCaptureTaskStatus object. The task.checkStatus(options) method returns a task.DocumentCaptureTaskStatus object when you specify a task ID that represents a document capture task.

For an example of submitting an asynchronous document capture task, see Extract Content from a Document Asynchronously.

Supported Script Types

Server scripts

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

Module

N/task Module

Methods and Properties

DocumentCaptureTask Object Members

Since

2025.2

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 myDocumentCaptureTask = task.create({
    taskType: task.TaskType.DOCUMENT_CAPTURE
});
...
// Add additional code

Syntax

Related Topics