DSP Web

3 minute read Last updated on October 30, 2024

The DSP Web node is designed for use with applications/features that have been developed by members of the Dispatcher Stratus Developer Support Program (DSP). For more information about the DSP, please contact your Konica Minolta representative.

To open the DSP Web node’s configuration window, add a DSP Web Process node to your workflow and double-click on it.

Configuring the DSP Web Node

The DSP Web node appears in the following illustration:

DSP Web

  • Enabled - To enable this node in the current workflow, ensure the Enabled toggle is to the right. By default, nodes are enabled upon creation. If you disable the node, the workflow will ignore it. While the workflow will still validate, documents will not be output from this node and may be lost. Note that a disabled node does not check for logic or error conditions.

  • Node Name - The node name defaults to this field. This name appears in the workflow below the node icon. Use this field to specify a meaningful name for the node that indicates its use in the workflow.

  • Node Description - Enter an optional description for this node. A description can help you remember the purpose of the node in the workflow or distinguish nodes from each other.

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.

Application Setup

To use this with a DSP-developed web service, you must configure the node to point to the web-based application or API’s location (e.g., a URL). To configure the node, do the following:

  1. Double-click the DSP Web node to open it.

  2. Enter the API Endpoint location of the application you would like to connect to the node.

  3. Select whether you would like to Include Metadata. When this checkbox is selected, the node includes all metadata gathered from previous nodes in the workflow.

  4. Select your Authentication type. Options include:

    • Basic - This will prompt you to enter your Username and Password.

    • APIKey - This will prompt you to enter your Key Name and Key Value.

    • BearerToken - This will prompt you to enter your Token.

  5. Select the Connect button. This will establish a connection between the DSP Web node and the web application and connect any metadata keys or value pairs provided from the application so the metadata can be used by subsequent nodes in the workflow. This will also confirm that the application is properly registered with a valid DSP license key.

    Important! You must select the Connect button in order to properly validate the workflow.

    Note: Any changes made to the API field, Include Metadata checkbox, and/or Authentication fields will require you to select the Connect button to reestablish the connection.

  6. If needed, select the Advanced Settings drop-down to reveal additional configuration options. You can:

    • Select the HTTP Verb. Options include:

      • Get

      • Post

      • Put

      • Patch

      • Delete

    • Add any Headers necessary for the application. To add a Header, select the Add Header button. This will allow you to enter a Key and Value for the Header. Headers are additional coding commands outside the application, which can alter how the application performs. Any necessary Header Keys and Values will likely be provided in the installation instructions along with the application; otherwise, this field can be left blank. You may add more than one Header. To delete a Header you’ve added, select the Remove button next to the Header.

  7. Save and close the node.

Note: The DSP Web node will process documents whenever possible, according to the specifications of the connected application. In the event that the node or application generates an error during processing, you will need to consult the application logs for specific details about the error.