Square 9 Softworks Connector

4 minute read Last updated on November 14, 2024

Square 9 Softworks Connector icon

The Square 9 Softworks Connector node allows you to distribute documents to Square 9, a popular AI-powered document processing platform. Documents can be sent to Square 9 via an automated workflow, or you can log into Square 9 directly at the MFP panel.

Square 9 Softworks Connector

Configuring the Square 9 Softworks Connector Node

To open the Square 9 Softworks Connector node’s configuration window (shown above), add the node to your workflow and double-click on it. The following options are available:

  • Enabled - To enable this node in the current workflow, select the toggle until “Enabled” displays. The default setting is “Enabled”. If you disable the node:

    • The workflow will ignore the node.

    • The node will not check for logic or error conditions.

    Important! If you disable this node, and no other distribution nodes are enabled, it will not cause the workflow to fail validation, but no processed documents will output and they may be lost.

  • Name - The name in this field appears below the node’s icon in the workflow. By default, the node name defaults to “Square 9 Softworks Connector”, 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.
  • Metadata - Accesses the Metadata Browser.
  • 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.

Connecting to Square 9

To begin, you must first connect to the Square 9 server. In the Connection area, do the following:

  1. In the Server URL field, enter the URL of your Square 9 server.

  2. Enter your Square 9 server user credentials in the Username and Password fields.

  3. If necessary, update the value in the Connection Timeout field.

  4. When you are done, select the Login button to connect to your Square 9 server.

    Square 9 Softworks Connector

Configuring the Square 9 Softworks Connector

Once connected, the right hand side of the Square 9 node properties window displays a tree-view and listed view of your Square 9 databases and Inboxes. The tree view is optional and can be turned off.

Selecting a Database or Inbox

Square 9 organizes documents in two ways: databases and Inboxes. Databases are how Square 9 typically stores documents. Archives exist within databases and act much like folders. Inboxes are temporary repositories where documents can be reviewed by relevant parties before being indexed in a database.

After connecting to the Square 9 server, the databases, Archives, and Inboxes available to the user will appear in the configuration area. Navigate to the repository you would like to save documents to. Note that you must select an Archive or Inbox; selecting a database is not a valid configuration.

Square 9 Softworks Connector

Archive Fields

If you selected an Archive to save documents to, the Archive Fields area will populate with the associated fields. Archive Fields contain additional information that is uploaded with the document.

Note: Archive Fields support a single line of text. The maximum length is defined within GlobalSearch, Square 9 Softworks’ Enterprise Content Management tool.

Options

You can adjust the default view of your Square 9 Archives in the node properties window by using the control buttons in the top right hand side of the window. Do the following:

  • To turn off the default view, uncheck the Show tree view option.

    See the following illustrations for a comparison of the different views available:

    Tree View ON

    Tree View On

    Tree View OFF

    Tree View Off |

  • To refresh the node’s configuration area and display the most up-to-date databases, Archives, and Inboxes from Square 9, select the Refresh option. This will also refresh the Archive Fields section.

Accessing Square 9 at the MFP

At the MFP, take the following steps:

  1. Select your workflow - If only one workflow is currently running, that workflow appears. However, if multiple workflows are running, then select the workflow with the Square 9 node on the “Select a Workflow” screen.

  2. Scan your document - Use the MFP to scan your document. Options available are dependent upon the options selected in the MFP Capture node. If a Form Selector node has been configured, continue to step 3. Otherwise, skip to step 6.

  3. Enter your login credentials - If a Square 9 Softworks account has been configured, you will only need to select the “Login” button. If an account has not been configured, you will need to enter your login credentials here to proceed.

  4. Select your File Destination - When you are logged in, you can use the folder navigation to select the destination for your file upload.

  1. Enter Archive information - After selecting a database or Inbox, the available Archive Fields will appear. Enter any necessary Archive Field information.

  2. Select the “Scan” button - This will send the scanned document to the selected Square 9 destination.