Collect from Dispatcher Phoenix

4 minute read Last updated on October 16, 2024


Use this node to collect documents from any connected Dispatcher Phoenix installation and import them into Dispatcher Stratus. In this way, you can combine the powerful document processing tools of Dispatcher Phoenix with the People-based workflow capabilities of Dispatcher Stratus.

Collect from Phoenix Node

Node Licensing

This node consumes a non-MFP device license when used in a workflow. When you save the node or the workflow, if sufficient licenses are not available in the tenant to register the Collect from Dispatcher Phoenix node(s), the workflow will remain in Draft status until the nodes are registered.

Configuring the Collect from Phoenix Node

To open the Collect from Dispatcher Phoenix node’s configuration window (shown above), add the node to your workflow and double-click on it. You have the following options:

  • Enabled - To enable this node in the current workflow, select the toggle until “Enabled” displays. The default setting is “Enabled”. If you disable this node, and no other collection nodes are enabled, the workflow will not accept documents and will fail validation.

  • Name - The name in this field appears below the node’s icon in the workflow. The node’s name defaults, but you can edit it. For example, you can specify a name that indicates the node’s function in the workflow.

  • Description - Enter a description for this node that details its purpose in the workflow, and/or to distinguish it from other nodes in the workflow.

    This field is optional and is for internal use. That is, it appears only in this window and not in the workflow.

Buttons

  • Help - To access Online Help, click this button.
  • Cancel - To exit the window without saving any changes, click this button.
  • Save - To preserve your node configuration and exit the window, click this button.

Configuration Options

This node does not contain any configuration options. All configuration occurs in the corresponding Dispatcher Stratus Connector node, which is described in the Dispatcher Phoenix Online Help.

Metadata

The Collect from Dispatcher Phoenix node can import metadata from Dispatcher Phoenix workflows into Dispatcher Stratus. However, note the following:

  • At this time, only file-level and page-level metadata is passed between Dispatcher Stratus and Dispatcher Phoenix.

  • When sharing metadata between Dispatcher Phoenix and Dispatcher Stratus, metadata keys generated by one system will not be available for selection in the other system’s Metadata Browser or Metadata to File node. For example, when added to a Phoenix workflow, the Metadata to File node will list all metadata groups in the workflow (such as the OCR metadata group) except Stratus’ Send to Dispatcher Phoenix and Collect from Dispatcher Phoenix nodes. However, in either situation, you can manually select the metadata groups.

  • Metadata keys generated in Dispatcher Phoenix and collected by Dispatcher Stratus must be manually edited in Dispatcher Stratus for use in workflows. Conversely, metadata keys flowing from Dispatcher Stratus do not need to be modified in Dispatcher Phoenix.

    For any metadata keys collected from Dispatcher Phoenix, make the following adjustments before using them in a Stratus workflow:

    • Prefix the metadata keys with “file:”.
    • Replace any colons in the metadata key with a period.

    For example, assume the Phoenix workflow includes the Input Folder node. The Phoenix workflow generates a metadata key {input:total} that represents the total number of collected files. In order to access that data in the Stratus workflow, you must modify the metadata key to {file:input.total}.

    For page-level metadata, such as that generated by Forms Processing or Advanced OCR, you must encase parts of the metadata key in square brackets and quotes. For example, if the Phoenix workflow includes an Advanced OCR node that includes a zone called ProjectName, then the Phoenix workflow will add a metadata key {ocr:zone.ProjectName}. Accessing it by page number in Phoenix involves adding the page number minus 1 to the key, {ocr:zone.ProjectName[0]} for page 1. To access the metadata in Stratus, you must modify the metadata key as such: {file:ocr[“zone.ProjectName”][0].value}.

    For metadata keys generated by Phoenix that contain periods, colons, and/or underscores in its second half, you must encase the second part of the key in square brackets and quotes. For example, for an index form set up in Phoenix with a field that has a variable name “document_name”, Phoenix will generate a metadata key {form:document_name}. Modify the corresponding metadata key in Stratus to: {file:form[“document_name”]}.