DSP Web Out

3 minute read Last updated on November 09, 2022

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

Using the DSP Web Out Node

To open the DSP Web Out node window, add a distribution node for DSP Web Out node and double-click on it.

There are several buttons and fields that appear, including:

  • Enabled - To enable this node in the current workflow, check the box at this field. If you leave the box blank, the workflow ignores the node and documents pass through as if the node was not present. Note that a disabled node does not check for logic or error conditions.

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

  • 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. If the description is long, you can hover the mouse over the field to read its entire contents.

  • Metadata - To access the Metadata Browser window, click this button.

  • Help - To access Dispatcher Phoenix Online Help, click this button.

  • Save - To preserve your node definition and exit the window, click this button.

  • Cancel - To exit the window without saving any changes, 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 Out node to open it.

  2. Enter the API Endpoint to the application.

  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 the HTTP Verb. Options include

    • Get

    • Post

    • Put

    • Patch

    • Delete

  5. 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.

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

  6. Select the Connect button. This will establish a connection between the DSP Web Out node and the application. This will also confirm that the application is properly registered with a valid DSP license key.

    Important! If you have not successfully connected, the workflow cannot be properly validated.

    Note: Any changes made to the API field will require you to select the Connect button to reestablish the connection.

  7. If needed, 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. Headers are also metadata compatible. To add metadata to a Header, click the Metadata button and drag-drop the metadata key into the Header Key or Value field.

  8. Save and close the node.

Note: The DSP Web Out node will distribute 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.