Transform Service (com.ibi.agents.XDTransformAgent)

Syntax:

com.ibi.agents.XDTransformAgent

iIT Service Object:

transform: Transform Agent

Description:

This service applies a defined transform to each document. The transform name should be an alias specified in the transforms section of the engine configuration. The transformation can be an iWay transform or an XSLT transform. The transform service is especially useful as part of a sequence of business services in which the output is chained to another business service to execute a business process.

Note: The Transform service is only used to call a transform dynamically. Otherwise, you must configure a Transform object using iIT Designer. In order for a transform to be called properly during run time, the transform must be contained in a process flow, which is deployed as a service.

Parameters:

Parameter	Description
Transform name *	The name of the defined transform to execute.
Expected input	The type of document to reach this service. The actual input format must match the type that is declared. Select one of the following options: All Types (default). Any payload received by the service is passed to the transformation. Streams are not accepted. Flat. A non-XML payload is expected. XML. An XML payload is expected. It does not include an iWay error status document, which will be rejected. iWay Error. Only an iWay error status document will be accepted. Other payloads will be rejected. All XML. Any XML payload (including the iWay error format) is accepted. Only flat formats are rejected.
Document type	Type of output document being emitted by the transform. Select one of the following options: XML (default) Flat
Engine	Type of transformation. Select one of the following options: iWay Transformer (default) XSLT
Trim	Determines whether data should be trimmed before transformation. By default, this parameter is set to false.
Error Status Output	Sets the output format that is emitted by the service if an error occurs. Select one of the following options: status (default). Sets the output format as an error status document. input. Sets the output format as the input document.
Call at EOS	In a streaming environment, EOS (End of Stream) is the short message that is sent after the last document is processed, which signifies the EOS. This parameter determines whether this service should be called for the EOS message. By default, this parameter is set to false.
Error Masks
Input Side	If set to true, all non-fatal errors that occur during transform input parsing are suppressed. By default, this parameter is set to false.
Output Side	If set to true, all non-fatal errors that occur during transform output parsing are suppressed. By default, this parameter is set to false.

If transformation is not able to finish or if there are function errors in the output document (TRANSFORM_FUNCTION_ERROR), the agent returns an error status document if Error Status Output parameter and follows the fail_transform edge instead.

Edges:

The edges returned are listed in the following table.

Edge	Description
success	The transformation process completed successfully.
fail_transform	The transformation process completed with errors.
fail_format	The input document format does not match the expected input transform format.

The following is an example of an error status document that is returned:

<?xml version="1.0" encoding="UTF-8" ?>
<error status="1">
<msg>Transform returned function errors</msg>
<parms>
  <parm name="engine">iway</parm>
  <parm name="inmask">false</parm>
  <parm name="intype">all</parm>
  <parm name="outmask">false</parm>
  <parm name="outtype">flat</parm>
  <parm name="shouldTrimParm">false</parm>
  <parm name="stat">status</parm>
  <parm name="transform">case_61862517_FWFOut_reg</parm>
  <parm name="wanteos">false</parm>
</parms>
<timestamp>2011-01-21T22:03:14.214Z</timestamp>
<status>1</status>
<channel>ExecProcess</channel>
<nodename>agent_FWF_JDBC_Xform</nodename>
<functionerrors>
<item>[FUNCTION] Function JDBCLOOKUP error: com.iwaysoftware.transform.common.function.FunctionException: JDBC driver com.mysql.jdbc.Driver cannot be loaded. Detail: com.mysql.jdbc.Driver</item>
</functionerrors>
</error>