Skip to main content

Web connections

Web connection for a branch​

You can set up a web connection for a branch to communicate with any service or third party online. This connection can be used in the process flow connector Web connection.

For more information and a use case, see Web connection connector.

To set up a web connection:

menu Integration & AI > Web connections

  1. Enter a Web connection name.

  2. Enter the Base URL.

  3. Select the Authentication type.

  4. Depending on the authentication type, enter the required settings.

    tip

    With a 3-tier Software Factory in the Universal GUI, you can store key values encrypted. See Encryption for a branch.

  5. To define parameters for use across all endpoints (for example, for authentication), go to the tab Web connection parameters. You can use curly brackets { } to add parameters to many settings.

    For example, you can create a web connection parameter user_name by entering the value {user_name}. The parameter becomes an input parameter for the Web connection process action. The value that is set for the parameter user_name is then passed to the Username field, so the field is filled dynamically.

  6. To add an endpoint, go to the tab Endpoints. Add the required information:

    • tab General - Add a Method, Path, and Body type.
    • tab Query strings - Optional. Add a Name and Value. Can also be filled with {parameters}.
    • tab Request headers - Optional. Add a Name and Value. Can also be filled with {parameters}.

  7. To add input parameters for a specific endpoint, go to the tab Input parameters. The following settings are available:

    • Default constant value
    • Pre-processing - Process the parameter value like something else, such as JSON, so Indicium can use it

  8. To add output parameters for a specific endpoint, go to the tab Output parameters. The following settings are available:

    • Retrieve value from - Retrieve a value from a given response header
    • Base64 decode - Decode the value from Base64.
    • Apply JSON path - Based on a JSON path, obtain the value from the response
    • Always as array - Always return the value as an array
    • Apply XPath - Based on an XPath, obtain the value from the response
    • Apply Regex - Based on a regular expression, a value will be given that satisfies the expression
Override Web connection settings
  • To override these settings for a specific runtime configuration (for development and testing): menu Maintenance > Runtime configurations > tab Web connections. See Runtime configurations for more information.
  • To override these settings for an application in IAM: menu Authorization > Applications > tab Web connections. See Web connections settings in IAM.

Was this page helpful?