Web Request

The Web Request connector is an extremely  flexible method for performing http requests to web based API's and REST services. These requests can be called when documents are exported or within Export Field Zones during processing. Requests can be stacked in a parent/child structure to enable multiple requests to be called where one is dependent on the result of a previous request.

This connector requires an understanding of web services and http request and response methods.

There are 3 types of web requests that can be configured. Each serves a slightly different function:

    1. Lookup Web Requests - Assigned to Export Field Zone, the lookup retrieves data from a web service and presents the result to a user during batch process
    2. Export Web Requests - Called during document export events
    3. Parent Web Requests - Are called by child Lookup and/or Export Web Requests. These are requests that must preceded a prior requests. As an  example, a parent request might be in an authentication request where a token is retrieved and used in a child request. 

Settings

Lookup Web Requests

Lookup web requests are assigned to Export Field Zones. These requests are called during processing and provide the user a browse/search function. The related zone value is assigned the resulting value.

New Web Request

Click the New Web Request button to create a request.

When creating a new web request, consider whether you should first create an authentication request. If authentication is required prior to your lookup request can be called, then create a Parent Web Request that performs this task ready to assign it as a parent to this lookup request.

The steps to creating a web request are as follows:

    1. Enter an identifying name for request*. This serve no other purpose other than to make it easy to reference and understand its function later.
    2. Select a parent request (when required) from the drop-down list. The parent request will always be called prior to this request.
    3. Select the zone this request is assigned to from the drop-down list. During processing, this zone will trigger the request to perform a search.
    4. Select the request method from the drop-down menu (ex. GET, POST, DELETE etc) and then enter the request endpoint* in the merge field.
    5. Parameters: Using the related merge fields, enter key-value pairs of any required parameters. Once added, these will be listed below the fields.
    6. Headers: Using the related merge fields,  enter key-value pairs of any required headers. Once added, these will be listed below the fields.
    7. Request Body: If required, create a request body in the text field area. Merge text can be inserted into the request body using the merge field.
    8. Response Body: Choose how Umango will interpret the response body:
      • As text - capture data with a regular expression. Enter the appropriate regex
      • As an XML/JSON object - capture data with an appropriate xPath reference pointing to the element(s) to be returned
    1. Test the request by clicking the blue "Test" button. If the test is successful and the correct data should be displayed.
    2. Click OK. The request will now be included in the list of Lookup Web Requests.

*Required

Continue to add new requests as required.

Note that the sequence in which they are created and displayed in the list is the order the requests will be performed. 

Export Web Requests

Export web requests are performed when a document is exported from a batch. This could be used to send the document or related data to populate into a server, etc. 

New Web Request

Click the blue New Web Request button to create a request.

The steps to creating a new web request are as follows:

    1. Enter an identifying name for request*. This serve no other purpose other than to make it easy to reference and understand its function later.
    2. Select a parent request (when required) from the drop-down list. The parent request will always be called prior to this request.
    3. Select the request method from the drop-down menu (ex. GET, POST, DELETE etc) and then enter the request endpoint* in the merge field.
    4. Parameters: Using the related merge fields, enter key-value pairs of any required parameters. Once added, these will be listed below the fields.
    5. Headers: Using the related merge fields,  enter key-value pairs of any required headers. Once added, these will be listed below the fields.
    6. Request Body: If required, create a request body in the text field area. Merge text can be inserted into the request body using the merge field.
    7. Response Body: Choose how Umango will interpret the response body:
      • As text - capture data with a regular expression. Enter the appropriate regex
      • As an XML/JSON object - capture data with an appropriate xPath reference pointing to the element(s) to be returned
    1. To add a validation check to ensure the request was performed successfully, enable the option and provide a regex that will be used to validate the response body. If the regex does not return a result then the request will be interpreted as invalid and throw an error accordingly.
    2. Test the request by clicking the blue "Test" button. If the test is successful the response body and validation result should be displayed.
    3. Click OK. The request will now be included in the list of Lookup Web Requests.

*Required

Continue to add new requests as required.

Note that the sequence in which they are created and displayed in the list is the order the requests will be performed.

Parent Web Requests

Parent Web requests are used to call requests prior to another request. These requests are only performed if they are referenced somewhere else.

New Web Request

Click the blue New Web Request button to create a request.

The steps to creating a new web request are as follows:

    1. Enter an identifying name for request*. This serve no other purpose other than to make it easy to reference and understand its function later.
    2. Select a parent request (when required) from the drop-down list. The parent request will always be called prior to this request.
    3. Select the request method from the drop-down menu (ex. GET, POST, DELETE etc) and then enter the request endpoint* in the merge field.
    4. Parameters: Using the related merge fields, enter key-value pairs of any required parameters. Once added, these will be listed below the fields.
    5. Headers: Using the related merge fields,  enter key-value pairs of any required headers. Once added, these will be listed below the fields.
    6. Request Body: If required, create a request body in the text field area. Merge text can be inserted into the request body using the merge field.
    7. Response Body: Choose how Umango will interpret the response body:
      • As text - capture data with a regular expression. Enter the appropriate regex
      • As an XML/JSON object - capture data with an appropriate xPath reference pointing to the element(s) to be returned
    1. To add a validation check to ensure the request was performed successfully, enable the option and provide a regex that will be used to validate the response body. If the regex does not return a result then the request will be interpreted as invalid and throw an error accordingly.
    2. Test the request by clicking the blue "Test" button. If the test is successful the response body and validation result should be displayed.
    3. Click OK. The request will now be included in the list of Lookup Web Requests.

*Required

Continue to add new requests as required.

Note that the sequence in which they are created and displayed in the list is the order the requests will be performed.

File Type Options

File Type Options and related information are available here.