Web service activity mapping parameters

This topic covers the information related to mapping parameters.

• To help transfer asset binary data, map string variables as an input or output to byte[] array type parameter.

• To allow the binary content of a document to be optionally used (instead of the document instance ID), map the document variable as input or output to a binary stream or byte array type parameter and specify the mime type. A document's binary data can be of different mime types (such as PDF, TIFF, or JPEG). Therefore, you need to specify the mime type of the binary data to be correctly retrieved or updated in the capture document content at runtime.

• If the document variable is mapped to a string variable, it is possible to retrieve or update the document by specifying the binary data as a base64 string instead of the instance ID in a Web service activity (SOAP, SOAP WCF, RESTful and RESTful OpenAPI). The “Data as Base64 string” or “Instance id” options are available if a document variable is mapped to a string variable as input or output. By default, the “Instance id” is selected as the mapping type. If the data is set as a base64 string, you must specify a mime type. If the specified mime type is not available in the document, the system reports an error at runtime.

  When executing a Web service activity, for an input parameter, the document data is read and passed as byte[] or binary stream to the mapped API parameter. For an output parameter, the document data is set from the supplied byte[] or a stream. If the document variable points to an existing capture document, a new document is created instead of updating the old document data.

  See the mime types supported by TotalAgility. The "XLT" mime type is not applicable for a Web service activity.