In this article
Table of Contents | ||||
---|---|---|---|---|
|
Overview
Use this Snap to route documents to output views based on the incoming HTTP request method. This Snap is primarily meant for use in Pipelines executed through Triggered Tasks. The Snap matches the HTTP request method used in the Triggered Task and routes the document to the corresponding output view as configured for the request method.
Prerequisites
None.
Support for Ultra Pipelines
Does not support Ultra Pipelines.
Limitations
None.
Known Issues
None.
Snap Input and Output
Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| A document containing the data to be processed based on the incoming HTTP request. |
Output | Document |
|
| If the input document is routed to more than one output views, they are all instances of the same input document. The Pipeline may fail if any downstream Snap attempts to modify the same document without copying it. |
Snap Settings
Parameter Name | Data Type | Description | Default Value | Example | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Label | String |
| N/A | HTTP Router | ||||||||
Routes | Required. Use this field set to define/map one output view each to one or more of the request methods supported. Only one method can be specified in each row. Click to add a new row in this table and define the values accordingly. This field set comprises of the following fields:
| |||||||||||
Request method | String/Expression/Suggestion | Select or enter one request method, per each row, depending on the different HTTP requests expected from the Triggered task. The following different request methods are supported:
This field allows an additional value OTHER to handle request methods coming from the Triggered Task that are not configured in this Snap. | N/A | GET | ||||||||
Output view name | Drop-down list | Select an output view name from this drop-down list for each Request method selected. Map the value OTHER to an output view that suits your exception handling requirements. For example, an incoming request method DELETE or HEAD in the above scenario (image) is routed to output4 that corresponds to the value OTHER.
| N/A | output3 | ||||||||
Snap Execution | Drop-down list | Select one of the three following modes in which the Snap executes:
| Validate & Execute | Execute only |
Troubleshooting
Error | Reason | Resolution |
---|---|---|
Failed to evaluate expression: _Reqest_Method. | The expression for the Request Method field contains an invalid Pipeline parameter and the Snap is unable to process the incoming requests. | Ensure that you use the correct spelling for Pipeline parameters within the expressions defined in Snap's settings. |
Examples
Using HTTP Router Snap to Process the Request from a Triggered Task
The following example Pipeline demonstrates the use of HTTP Router Snap to process an incoming POST request via a Triggered Task. This Pipeline contains the REQUEST_METHOD parameter configured with the value POST.
Triggered Task | Pipeline with HTTP Router Snap |
---|---|
Pipeline Properties | |
When the Triggered Task - Task_On_HTTP_Router is run from the Task's details page, the corresponding Pipeline is executed.
The HTTP Router is configured to route the incoming document to a corresponding output view, matching the Request method value with the REQUEST_METHOD Pipeline parameter.
HTTP Router Snap Settings | HTTP Router Snap Views |
---|---|
In this example, the HTTP Router uses this JSON document and the REQUEST_METHOD from the Triggered Task as inputs. Based on the incoming value for REQUEST_METHOD (POST in this example), the HTTP Router routes the document to the corresponding output view (output1 in the validated Pipeline above). The Pipeline execution continues further to finally write the formatted JSON output into a JSON file.
Downloads
Note | ||
---|---|---|
| ||
|
Attachments | ||
---|---|---|
|
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
...