Start Document Service

The Start Document Service flow block allows Designers to apply batched operations on a generated document after the Generate document flow block creates it. The batching function enables you to use batch groups and batch configurationsClosed A table is defined with a schema that defines primary key columns and non-key columns that hold a specific type of data. Rows are added to hold data that can be queried. to complete multiple operations on your generated documents automatically.

The Start Document Service flow block is only available for subscriptions with access to the Portal (i.e., Business Cloud Light/Full). The Document Services component of the Portal comes out of the box with multiple operations to apply to generated documents. It also allows you to create custom operations to meet your exact business need such as renaming, zipping, template execution. Please contact our support team or your account manager for more information about custom operations.

Start Document Service flow block example

Figure 1-455   Start Document Service flow block

Parameters

The dropdown menus below provide all of the flow block's configuration options with detailed information and recommendations to help you configure your flow block.

You can further customize your flow block's parameters in several ways

  • Users can use linked fields to map data from your data set(s)

  • Users can use edit fields to customize the flow block

  • Using delayed output settings to wait for signatures or file names of completed documents

The Flow Output section serves as a comprehensive summary of the results and outcomes of a particular flow, providing valuable information to the user. Each setting that composes this output information is described in detail below:

Figure 1-456   Flow output

Flow output setting functions

Index No.

Field name

Description

1

Batch id

When checked, the system provides the batch ID that matches this run of the Batch configurationClosed A set of one or more operations to apply sequentially on the selected Document at the end of the flow run.

2

Batch name

When checked, the system provides the batch's name at the end of the flow block's run.

3

Time started

When checked, the system provides the time the Batch configurationClosed A table is defined with a schema that defines primary key columns and non-key columns that hold a specific type of data. Rows are added to hold data that can be queried. started. When unchecked, the system takes no action at the end of the flow block's run.

4

Output metadata

When checked, the system provides the metadata from the Batch configuration's actions at the end of the flow block's run. When unchecked, the system takes no action.

5

Batch execution

When checked, the system provides a link to the Portal's batch execution at the end of the flow block's run. When unchecked, the system takes no action.

6

Document

When checked, the system provides a download link to the document at the end of the flow block's run. When unchecked, the system takes no action.

The Basic settings of the Start Document Service flow block determine what batch group the document should use, what Batch configurationClosed A set of one or more operations to apply sequentially on the selected Document to apply to the document. You can also set how long the system should wait for your Batch configuration to run before moving onto to the new step in your flow.

Figure 1-457   Basic settings

Basic settings setting functions

Index No.

Field name

Description

1

Document

Defines the document to use for the flow block. The system uses the Generated document by default.

2

Batch group

Selects the name of the Batch Group within the Portal- Document services.

3

Batch configuration

Selects the service you wish to start on the Portal server to complete the Batch configurationClosed A set of one or more operations to apply sequentially on the selected Document for the flow block.

4

Execute & wait

Defines the maximum amount of time (in milliseconds) for Smart Flows to wait before moving to the next step in the flow.

When configuring the Execute and wait field, you do not have to enter a value for the field. If your Batch configuration operations do not need to complete before the next flow block starts, leave the field blank.

If you need the system to wait until your Batch configuration operations are completed, set the Execute and wait field to a value you are certain provides time for the system to complete the required operations.