Form URL Writer

The Form URL Writer provides the ability to integrate with three types of service:

  • Form URL Encoded - This will post a sequence of key value pairs (e.g. key1=value1&key2=value2&key3=value3) as an application/x-www-form-urlencoded type request.
  • Parameter URL - Will post a sequence of key value pairs (e.g. key1=value1&key2=value2&key3=value3) as key/value pairs as URL parameters.
  • Multipart Form URL Handling - An extension of Form URL Encoded where a 'multipart' type request will encompass a set of form url encoded values and a binary type of data (such as images, Pdf's or any other non-textual file).

Due to the nature of the output the following limitations apply:

  • The writer only works with the HTTP IO Controller.
  • Only the values from the top Transaction Type will be included in the request.
  • A single request per record will be made.

Transform > OPTIONS

The options tab specifies key options on how the writer functions.

Transform Id

The unique user-defined name for the transform.

HTTP URL OPTIONS

See the HTTP IO Controller for more information.

Post Type

Controls how the values will be sent to the webservice. The Post Type has three options:

  • Form URL Encoded
    • The data is sent with the 'application/x-www-form-urlencoded' content type.
  • Paramterised URL
    • Parameterised URLs
  • Multipart Form URL Handling
    • Post a mix of form url encoded and binary type data in a single request as a multipart/form-data type request.

Rewrite Response Transaction

Allows you write the response back to the IMan dataset.

See Rewrite (HTTP) Write Response

Multipart Form URL Encoded does not support handling of responses.

Transform > Field Mapping

Current Transaction Id

The transaction type being edited.

Field Name

The field name within IMan.

Export

When set to True, field will be included in resultant request.

Parameter

The name of the parameter either on the form URL request or url.

Up/Down Arrows

Used to control the ordering of the fields sent of the request.

Top record will become first on the left of grid in Preview screen.

Multipart Form URL REquests

Multi-part Request

A multipart request consists of one or more sets of form url data and binary data.

The below visualisation of a multipart request where there are two sets of form url and binary data.

Creating a Multi-part Request

Important Notes

  • Ordering of fields is important.
  • The last field in a sequence must be a binary field.

Setup of Writer

  1. Order the fields on the reader so the form fields appear before the field representing the binary field.
  2. The binary field should be positioned last. The binary field can either be of Field Type 'Binary' or a file path to the binary resource.
  3. To create a second set of form url and binary data, position another field where the value is SYS.BOUNDARY and repeat steps 1 and 2.