DocumentCaptureTask.inboundDependencies

Property Description

Key-value pairs that contain information about the dependent tasks added to the document capture task.

Use this property to verify the properties of dependent tasks after you add the tasks using DocumentCaptureTask.addInboundDependency(options).

This property uses nested objects to store information about each dependent task. A nested object is included for each dependent task added to the document capture task, and these objects are referenced by their index (starting at 0). Dependent tasks are indexed in the order they are added to the document capture task. Each nested object contains the task type, script ID, script deployment ID, and script parameters.

For example, consider a situation in which you add a scheduled script task to a document capture task as a dependent task. After you add the dependent task but before you submit the document capture task using DocumentCaptureTask.submit(), the value of the DocumentCaptureTask.inboundDependencies property is similar to the following:

                    {"0": {"type":"task.ScheduledScriptTask", "scriptId":"customscript_as_ftr_ss", "deploymentId":"customdeploy_ss_dpl", "params": {"custscript_ss_as_srch_res":"SuiteScripts/ExportFile.csv"} }}

After you submit the document capture task, the IDs of the dependent scripts are added to the DocumentCaptureTask.inboundDependencies property:

                    {"0": {"type":"task.ScheduledScriptTask", "id":"SCHEDSCRIPT_0168697b126d1705061d0d690a787755500b046a1912686b10_349d94266564827c739a2ba0a5b9d476f4097217", "scriptId":"customscript_as_ftr_ss", "deploymentId":"customdeploy_ss_dpl", "params": {"custscript_ss_as_srch_res":"SuiteScripts/ExportFile.csv"} }}

Type

Object[] (read-only)

Module

N/task Module

Parent Object

task.DocumentCaptureTask

Sibling Object Members

DocumentCaptureTask Object Members

Since

2025.2

Errors

Error Code	Thrown If
`READ_ONLY_PROPERTY`	You try to set the value of this property after the task.DocumentCaptureTask object is created.

Error Code

Thrown If

READ_ONLY_PROPERTY

You try to set the value of this property after the task.DocumentCaptureTask object is created.

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
...
// Be sure to use a script ID that represents a scheduled script in your account
var myScheduledScript = task.create({
    taskType: task.TaskType.SCHEDULED_SCRIPT,
    scriptId: 'customscript_as_ftr_ss'
});

// myDocCaptureTask is an existing task.DocumentCaptureTask object
myDocCaptureTask.addInboundDependency(myScheduledScript);
...
// Add additional code

General Notices