PAS 23.1.1 With the URL adapter, it is possible to get and post messages from and to a web endpoint. The table below lists what you can do with the URL adapter and what protocols are supported.
| Task | Protocols | Adapter Action | Description | Documentation Reference |
|---|---|---|---|---|
| Send a request to a server |
| request | Send a request to a given URL using the given parameters. The response data is stored in memory. | |
| streamToFile | Send a request to a given URL using the given parameters. The response data is stored to a file. Streaming is mostly relevant in FTP context. In order to avoid consuming too much memory, the URL adapter offers the option to receive data in little chunks. This mechanism is called streaming: After receiving a small data chunk from the server, it is immediately written to a file before receiving the next one. | |||
| streamFromFile | Send a request to a given URL using the given parameters. The request data is read from a file. Streaming is mostly relevant in FTP context. In order to avoid consuming too much memory, the URL adapter offers the option to send data in little chunks. This mechanism is called streaming: The request data is available as a file and send in small data chunks. |
The input and output of this adapter is always of type Blob to support all possible data types (e.g. binary for images, text with HTML code, XML messages, etc.).
Static and Dynamic Requests
URL request can be static or dynamic.
- Static means that the whole backend information (host, path, protocol, etc.) is defined on the URL alias, and is not modified on the request action.
- For dynamic requests, the default information provided by the URL alias can be overridden on the request action before sending the request to the host. This is sometimes required, for example, when URL parameters must be calculated or are known at runtime only. Refer to URL Adapter Reference for more information on the URL adapter parameters.
If large amounts of data have to be transferred, the URL adapter offers the possibility of streaming the data from or into a file so avoiding to utilize large memory chunks. Streaming FTP explains how to do this for the ftp protocol. Applying streaming to the other protocols works analogously.
Find an overview on all attributes and parameters of the URL adapter on URL Adapter Reference.
HTTP Headers
With xUML service adapter calls, the xUML Runtime adds the following outgoing HTTP headers containing correlation information to the request: Transaction id and request id will be logged to the transaction log on the adapter call (refer to Administration Guide > Contents of the Transaction Log for more details). Having this information, you can use this for error analysis or usage metrics.
This header identifies the transaction the call belongs to. You can set the transaction id manually with setTransactionID. If not set, the Runtime will generate one.
This header will be passed through the callstack to identify all service calls that belong to a transaction.
This header identifies the unique request. The Runtime generates a unique number for each adapter call.
These headers contain the sender host resp. the sender service. They are set by the Runtime automatically.
Adding an URL Adapter Operation to a Diagram
| Expand the path to the URL adapter in the service panel (Base Types/Bridge Base/Base Components/Add Ons/URL). |
| You can drag out operations from the data model to any diagram: The example on the left shows how to add an URL adapter operation to a BPMN execution diagram. |
Configuring the URL Adapter Operation
Once an operation has been added to a diagram, it needs to be configured as an URL adapter.
| Select the newly added URL adapter operation and switch to the Attributes panel. Depending on the diagram type you can see the following information (example BPMN execution diagram):
All this is predefined and cannot be changed. | |||||||||
| Click Add Stereotype to define the selected operation as to be an URL adapter. | |||||||||
| Select SQL Adapter from the list of available adapter stereotypes. Click Save. | |||||||||
| The Attributes panel shows the added adapter stereotype. Now you still need to configure the adapter. Expand the stereotype by clicking the arrow on the right. | |||||||||
| An URL adapter is configured via its alias (see Aliases for more information on aliases). Additionally, you can insert
See further information below and on page URL Adapter Reference. | |||||||||
| You can select an existing alias from a drop-down list by clicking the text Select alias. If you want to remove an added alias, select None from the drop-down list:
| |||||||||
| You can also create and add a new alias by clicking the corresponding icon Refer to Aliases for more information on how to create a new alias. | |||||||||
| A dialog opens where you can name and configure the new alias. Refer to URL Adapter Reference for more information on the configuration options of this adapter. Click Save to create and add the new alias.
| |||||||||
| To add headerParameters click on the corresponding | |||||||||
| To select a digestAlgorithm, click icon Refer to URL Adapter Reference for detailed explanations of all options. |
On this Page:
UrlAdapter_Example
 | Click the icon to download a simple example model that shows the usage of the URL adapter in Scheer PAS Designer. |
Related Pages:
Related Documentation:
Overview
Content Tools