| Table of Contents | ||
|---|---|---|
|
Use the Release Node to release data and documents from a Workflow to GlobalSearch or to the file system. You can use multiple Release Nodes in a Workflow if you need to release to more than one location , or if you need to conditionally release to different locations based on previous workflow steps.
Node Properties
Title
Add a title for this node. Titles are useful when reading the history in the history of a workflow for easier understanding of the overall process.
Description
Provide a synopsis of what this node is doing, or make note of any important details.
This is useful for providing additional information such as workflow details and use case information. A good description is helpful when returning to modify the workflow in the future.
Release Types
Release to File
| Note |
|---|
Release to File is available for GlobalCapture on-premise solutions only. |
You can release documents from the Workflow directly to a local or network file system.
Export Path: The location of the file folder to release document to.
| Info |
|---|
If releasing to a network share, be sure to use a network addressable path (UNC path), never a mapped drive. Also be sure that the service account GlobalCapture is using has permissions to the network share. |
Release to Inbox or Archive
You can file documents away automatically by releasing them directly to a GlobalSearch Archive. You can also release to Inboxes in the GlobalSearch desktop client. Documents are most commonly released to an Inbox post-processing, where no indexing has been automated but where features like page separation or image enhancement are required. You then access the documents from the Inbox, where they can be indexed into an Archive manually.
Configure the Workflow Release
When to Delete at Release.| Excerpt | ||
|---|---|---|
| ||
File Naming Format: When specifying the File Naming Format, you can specify a specific value or use Square 9 Notation to set the values automatically.
|
Overwrite Existing Files: Overwrite files in the release folder with new files of the same name.
| Excerpt | ||||
|---|---|---|---|---|
| ||||
Delete Files After Release: Remove the file from the GlobalCapture working directory. If releasing to multiple locations, this should only be enabled on the final release node.
|
|
In the Release Node Settings dialog that appears, enter a unique name and a description for the Node.
As you configure settings, it changes the next settings offered.
Release Files to a Folder
To release documents directly to a file directory, in the Release Type group, click File.
It is a good idea to put the export directory under a directory you know that the user who is running the GlobalCapture service has rights to.
Enter the format for file names.
You can use S9 Notation to select from available Process and Systems Fields to include in the file name. To do so, enter a brace ( { ) and select a Field from the list.
To replace captured files with new documents with duplicate file names, enable Overwrite Existing Files.
To delete files from GlobalCapture upon release, enable Delete Files after Release. This is enabled by default.
Delete Files after Release is similar to the Delete All Pages setting in the Delete Pages Node.
Click Save.
Use S9 Notation Process Fields
| borderWidth | 0 |
|---|
| Column | ||
|---|---|---|
| ||
|
| Column |
|---|
When doing a File release, you can use S9 Notation in a Release Node to get to properties of a document. For example, you can name a file on release using S9 Notation: To name files based on Invoice Number Field, the PO Number Field, and the Batch ID number, in the File Naming Format text box, enter |
Release to GlobalSearch Archives
You can release your GlobalCapture data and documents directly to an Archive, if you have GlobalSearch installed.
In the Release Type group, click Archive.
Select a GlobalSearch instance from the Square 9 API drop-down list. The default is Square9 API Portal.If you have added GlobalSearch instances in the Portals interface, they will also appear in the list.
Select a database from the Database Destination drop-down list that appears.
Select an Archive from the Archive Destination drop-down list that appears.
To automatically create a destination Archive based on Field data, enable Import to Automatically Generate Child Archive. If enabled, from the Process Field Value for Archive Name list that appears, choose a Field.
Use this setting very carefully. If you don’t go back and manually create a Search for the new Archive, you will never be able to find the documents in it.
To delete data and documents from GlobalCapture upon release, enable Delete Files after Release. This is enabled by default.
Click Save.
| Tip | |||
|---|---|---|---|
Examples: Release to Multiple Instances and to Nested ArchivesRelease to Multiple Instances.
|
Release to Archive
You can release your GlobalCapture data and documents directly to an GlobalSearch Archive.
Select the Square9API Portal, Database, and Archive.
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Import to automatically generated child archive: Create a destination archive based on the selected process field data. When enabled, select the name of the archive from the Process Field Value for Archive Name list.
| Warning |
|---|
Exercise caution when using this feature.
|
Release to Inbox
You can also release to Inboxes in the GlobalSearch. Documents are most commonly released to an Inbox post-processing where no indexing has been automated but where features like page separation or image enhancement are required. You then access the documents from the Inbox, where they can be indexed into an Archive manually.
| Note |
|---|
Index Field data is not retained in an Inbox. If you have extracted data (from using the Process Field Node, or the Validation Station, for instance) it will not be retained in the Inbox. Release to an Archive to preserve associated data. |
When selected, you’ll be asked to choose an Square9API Portal, Database, and Inbox.
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Use Cases
Configure multiple release nodes to release to different locations
Configure 3 different release nodes to release to 3 different archives within GlobalSearch. Having multiple release nodes is useful for automatically routing documents, without the need for users to move them manually into their proper locations.
Configure consecutive Release nodes to export to multiple locations
A GlobalCapture workflow that utilizes an Approve or Denied decision to route documents to their proper locations. When a document has been denied, the first release node is configured to save a copy of the document locally to a file folder and the second to an Inbox in GlobalSearch. To do this, I will need to uncheck the option to Delete Files After Release on the first release node so a document exists to be released by the second release node.
This process is useful to save copies of the document before they go through the remainder of the workflow, or to be used for other purposes without losing the original copy of the document.
Configure multiple release nodes to save copies of documents
A GlobalCapture workflow can utilizes multiple release nodes at different steps throughout the workflow process. immediately after importing a document, we can add in a release node to save the original document before it proceeds through the workflow process by disabling Delete Files After Release.
Adding in release nodes after certain steps can be useful for testing new functionality in workflow processes while maintaining our original test document.
| Tip |
|---|
Release to Multiple Instances of GlobalSearchIt is possible to have a single capture instance which is releasing to multiple GlobalSearch instances. If you run a service bureau, for example, you can capture documents and then release them to various customer GlobalSearch instances. You will be able to define the end points for each of those customers in your service bureau capture process. Release to Sub-Archives. Suppose that you want to release to the PO Archive, with your purchase orders organized by vendor names. You can release to Sub-Archives under PO Archives based on vendor names by enabling the Import to Automatically Generate Child Archive setting and then select the Vendor Name Field in the Process Field Value for Archive Name list. That way, if a Sub-Archive for a vendor doesn’t already exist, one will be automatically created. Just be careful when you use this, because those new Sub-Archives are not automatically added to your existing Searches. You will need to manually create the Searches, if you ever want to find the documents in those Sub-Archives. |
. |
Important Notes
Release Performance
For "on premise" customers (customers who host their own GlobalSearch environment on the same network as their GlobalCapture environment), performance optimizations can be made to minimize network traffic related to file transfer at release time. In the Square9.GlobalCapture.exe.config (by default, C:\GetSmart\CaptureServices\GlobalCapture_1) add the following entry to the appSettings section of the file:
<add key="GSReleaseDirectory" value="C:\SmartSearch\WebPortalCache" />
Note that the path for "value" should represent the path to your GlobalSearch server's ViewerCache location. This is defined in the Square9Api (C:\inetpub\wwwroot\Square9API) web.config file. If the GlobalSearch and GlobalCapture servers are not physically on the same server, the path specified must be a common network share.
When this key is present in your environment, files are transferred directly in the file system, rather than through API routes. This results in faster transfer rates as files don't need to be broken down into chunks, transferred, and then reassembled. All customers where throughput is a consideration should leverage this setting.info
Field Caching (GlobalCapture 2.1 and earlier)
GlobalCapture systems that release to GlobalSearch (on-premise or in the cloud - C2) have the ability to cache GlobalSearch field details. This minimizes network traffic and improves processing speeds. All new installations from GlobalCapture 2.2 and greater will have caching settings enabled by default. Customers upgrading from a previous version may not have the settings present. Any customer using GlobalSearch with their capture applications should add this setting. In the Square9.GlobalCapture.exe.config (by default, C:\GetSmart\CaptureServices\GlobalCapture_1) add the following entry to the appSettings section of the file:
<add key="FieldTimeout" value="600"/>
Release to GlobalSearch Inboxes
You can release your GlobalCapture documents directly Inboxes, if you have GlobalSearch installed. Be aware, however, that Index Field data is not retained in an Inbox. If you have extracted data (from using the Process Field Node, or the Validation Station, for instance) it will not be retained in the Inbox. Release to an Archive instead.
To release documents directly to a GlobalSearch Inbox, in the Release Type group, click Inbox.
Specify which GlobalSearch instance the documents will be released to from the Square 9 API drop-down list.Select a database from the Database Destination drop-down list that appears.
Select an Inbox from the Inbox Destination drop-down list that appears.
To delete data and documents from GlobalCapture upon release, enable Delete Files after Release. This is enabled by default.
Click Save.