Final Root *

The name and description of this parameter is derived from viewing XML documents as trees of element objects. A well-formed XML document has exactly one root element (also called document element). When you configure the Accumulate service, the name of the root element for the resulting document must be provided as the parameter. This means that the result of the processing must be enclosed between a root start-tag and a corresponding end-tag with the specified name. The root element of this document tree is serving as a wrapper for the accumulated document parts, combining them into a well-formed XML document. For example:

<Final Root Parameter Value>
   <Accumulated Piece> … </Accumulated Piece>
   <Accumulated Piece> ... </Accumulated Piece>
    …
</Final Root Parameter Value >

Transactional

Determines whether this event record will be included in the log based on the transaction. If set to true, the event is logged only if the entire process flow is successful. For transactional recording, the channel must be declared to control the local transaction.

Event

The event class to be included in the log. Select one of the following values from the drop-down list:

• security {security} (default)

  This class can be used for a security event.

• signature {signature}

  This class can be used for a digital signature event.

• crypto {crypto}

  This class can be used for a cryptographic event.

You can also type an arbitrary, user-defined value in the Event field.

Code

A code that further describes the event. Select one of the following values from the drop-down list:

• start {start} (default)
• end {end}
• fail {fail}
• sign {sign}
• encrypt {encrypt}
• decrypt {decrypt}

Note: If you specified an arbitrary, user-defined value in the Event field, the code value must be greater than 1000.

Message

An arbitrary message that you want to associate with this event record.

Input Data *

An expression that returns the contents of the attachment.

Java Character Set

The character set used to convert from Java characters to an array of bytes. If no value is specified, the default character set will be used.

Content-Type *

Value of the Content-Type MIME header.

Content Description

Value of the Content-Description MIME header.

Content-Disposition

Value of the Content-Disposition MIME header.

Content-ID

Value of the Content-ID MIME header.

MIME Header Namespace

Special register namespace from which additional MIME headers for the attachment are taken. If no value is specified, no MIME headers are added beyond those generated by the header-specific agent parameters.

Input Data *

Path to the file that contains the attachment data.

Content-Type *

Value of the Content-Type MIME header.

Content Description

Value of the Content-Description MIME header.

Content-Disposition

Value of the Content-Disposition MIME header.

Content-ID

Value of the Content-ID MIME header.

MIME Header Namespace

Special register namespace from which additional MIME headers for the attachment are taken. If no value is specified, no MIME headers are added beyond those generated by the header-specific agent parameters.

Host *

The primary host to be checked for reachability.

Alternate *

The secondary host to be checked for reachability.

Sreg *

Name of the special register to hold the name of the reachable host.

Timeout *

A timeout period to attempt to reach the host. The default value is 3 seconds.

success

A route could be obtained.

fail_connect

Neither host is reachable.

fail_partner

The host is not known. For example, the host is not identifiable in the DNS.

host

Network name of the machine where the target system resides.

password

Password of this user.

port

Service port that Oracle uses to exchange messages.

qtable

Database table used to manage queues.

queue

Queue to receive documents.

sid

Name of Oracle database service.

user

User name of access to the target system.

Send To *

Address to receive this message.

Outgoing Mail Host *

Destination email host to which outgoing email is sent.

SMTP User

Logon user ID for SMTP host.

SMTP Password

Logon password for SMTP host.

Sender Address *

Email address of sender.

Copy To

Copy this message to these locations (can be comma delimited list).

Blind Copy To

Blind copy this message to these locations (can be a comma delimited list).

Content Type *

Overrides content type of the message.

• application/XML

• application/EDIFACT

• application/EDI-X12

Return Status *

• A status document will be the out document.

• Input - in document will become the out document

Avoid Preemitter

Checks to see if any preemitter be avoided.

• true

• false

SMIME

Packaging *

Tells the emitter how the document should be packaged for transmission. For S/MIME packaging it will use configure for S/MIME system properties.

• regular (unsigned/unencrypted)

• smime_sign (signed only)

• smime_encrypt (encrypted only)

• smime_sign_encrypt (signed and encrypted)

Compression *

If checked, compression will be applied.

• false

• true

Request Receipt *

Tells the emitter to send a request for receipt, i.e. MDN(Message Disposition Notification).

• none

• signed

• unsigned

Deliver Receipt To

The address where receipt should be sent to (user@mail_host).

Public Key Alias

Alias for public key entry; used for encryption.

Private Key Alias

Alias for private key entry; used for signing and decryption.

Private Key Password

Password for key access. If omitted, store password is used.

Digest Algorithm

Digest algorithm.

• SHA-1

• MD5

Encrypt Algorithm *

Encryption algorithm.

• CAST5

• DES-EDE3

• IDEA

• RC2

Destination *

The URL where information is posted.

Content-Type *

Specifies the content-type of data to be sent.

• application/XML

• application/EDIFACT

• application/EDI-X12

Response timeout value in seconds

Seconds to wait for response before signaling error.

Content Disposition

File name to put in the Content-Disposition header value.

User ID

User ID for Basic Authentication challenges.

Password

Password for Basic Authentication challenges.

Packaging *

Tells the emitter how the document should be packaged for transmission. For encrypted and/or signed packaging configure S/MIME system properties.

• encypted

• signed

• signed and encrypted

• un-encrypted

Compression

If checked, compression will be applied.

• true

• false

AS2-From *

A textual value identifying the sender of data exchange.

AS2-To *

A textual value identifying the receiver of data exchange.

Subject

Sets the subject header.

Request Receipt *

Tells the emitter to send a request for receipt, i.e. MDN(Message Disposition Notification).

• None - no MDN Returned

• Signed - signed MDN Returned

• Unsigned - unsigned MDN Returned

Asynchronous receipt URL

If an asynchronous receipt should be requested, specify the URL to which the receipt should be sent. Supported values are in the form: mailto:<user>@<host> for asynchronous receipt by email http://<host>/... for asynchronous receipt by HTTP https://<host>/... for asynchronous receipt by HTTPS.

Receipt Destination

Encryption algorithm.

• CAST5

• DES-EDE3

• IDEA

• RC2

Public Key Entry Alias

The alias for the public key entry used for encryption.

Private Key Entry Alias

The alias for the private key entry used for signing.

Private Key Password

Password to access the private key. If left blank password used to access Keystore will be used.

Digest Algorithm

Digest algorithm used for signing.

• SHA-1

• MD5

Encryption Algorithm

Algorithm to be used for encrypting.

• CAST5

• DES-EDE3

• IDEA

• RC2

IP Interface Host

Local IP Interface from which the outgoing IP socket originates.

IP Interface Port

Local IP Port from which the outgoing IP socket originates.

Proxy

Proxy

If on, emit through proxy sever.

• true

• false

Proxy URL

URL of the proxy server.

Proxy User ID

User ID for Basic Authentication challenges issued by Proxy.

Proxy Password

Password for Basic Authentication challenges issued by Proxy.

HTTPS

Secure Connection

Use a secure connection. You may need to configure the Keystore under HTTPS section of the system properties if client authentication is required. Note, if keystore is configured in system properties make sure it has the CA certificate or the client certificate of the server you're connecting to. If keystore is not configured in system properties default truststore located under JRE_HOME/lib/security/cacerts will be used.

• true

• false

Use 128-bit Encryption

Enforces the use of 128-bit encryption.

• true

• false

Security Protocol

Security protocol. SSL - Supports some version of SSL; may support other versions. SSLv2 - Supports SSL version 2 or higher. SSLv3 - Supports SSL version 3; may support other versions. TLS - Supports some version of TLS; may support other versions. TLSv1 - Supports TLS version 1; may support other versions.

• SSL

• SSLv2

• SSLv3

• TLS

• TLSv1

Agent Specific Parameters

Return *

Checks to see if it should return from this agent.

• true

• false

Avoid Preemitter

Check to see if any preemitter be avoided.

• true

• false

Response Wrapper Tag

The tag name with which to wrap the response if the response is non-XML and must be XML.

Response Base64 Encoded

Checks to see if the response needs to be Base64 encoded.

• true

• false

Operation *

Determines which operation should be performed on this document. Select one of the following options from the drop-down list:

• deleteAll (default)
• deleteOne

Attachment Number

For operations on a specific attachment, which one, base 0. If a value is specified, this parameter takes precedence over the Content-ID parameter.

Content-ID

For operations on a specific attachment, the Content-ID of the attachment. This parameter is Ignored if a value for the Attachment Number parameter is specified.

Attachment Number

The number of the attachment to be retrieved. If specified, it takes precedence over the Content-ID.

Content-ID

The Content-ID of the attachment to be retrieved. This value is ignored if the attachment number is specified.

Header Namespace

Special register namespace where MIME headers for the selected attachment will be stored.

Main Body Part Header Namespace

If the current attachment is itself a Multipart, this is the special register namespace where the MIME headers for the main body part will be stored.

Keep Document Flat

Determines whether to keep the body of the document as an array of bytes. This parameter is set to false by default.

Delete Attachment

Determines whether to delete the attachment after it becomes the body of the document. This parameter is set to false by default.

Encode or Decode *

Encode to a base 64 representation or decode from a base 64 representation. The default value is encode.

XPATH expression to Data

The value of the XPATH expression within the input document that will be used as the input data to encode or decode.

If no value is specified, the entire input document is used.

Call at EOS?

In a streaming environment, EOS (End of Stream) is the short message that is sent after the last document, which signifies the EOS. This parameter determines whether this service should be called for the EOS message? The default value is false.

success

Successful conversion.

fail_parse

The input could not be converted.

Linefeed *

Determines whether to remove linefeed characters (\r). Select true (default) or false.

Carriage Return *

Determines whether to remove carriage returns (\n). Select true (default) or false.

Tab *

Determines whether to remove tab (\t) characters. Select true (default) or false.

End of File *

Determines whether to remove DOS end of file (0x1a) characters. Select true (default) or false.

Bell *

Determines whether to remove bell (0x07) characters. Select true (default) or false.

Control

Replace With *

Replace removed characters with this character. Select none (default), space, or period (.) from the drop-down list.

success

Successful conversion.

Info

Root of the information tree.

Channels

The configured runtime channels.

Properties of statistics per channel (master)

name

Name of the channel. There is one master for each defined channel, regardless of its state.

state

State of the channel (active for started channel), runnable for deployed (not started) channel, stopping for the channel that is stopping.

• Begin - Channel has been started, but has not yet completed the initialization.
• Config - Errors were found during the initialization and the channel cannot start.
• Retry - The channel initialization (or sometimes the execution phase) found a condition that is an error not related to the configuration. The channel can be automatically restarted at a later time.

failed

Number of times the channel execution failed.

completed

Number of times the channel execution completed.

active

Indicates whether the channel is active.

Properties of statistics per execution

user

User CPU time statistics.

cpu

CPU time statistics.

name

Name of the thread (required). Thread masters always have worker threads to execute messages.

Properties of statistics per transaction

variance

Variance of transaction time.

ehrlang

Ehrlang coefficient.

mean

Mean (average) time of transactions.

internalqs

Internal listeners are associated with queues. This section describes the queues themselves.

queue

The name of this queue. Usually this is the name of the internal listener that defines the queue (optional).

size

Number of messages waiting to be processed.

success

Successful extraction.

Schema File

If blank, look for schema in route area; else use this as file path of schema.

Fail on error *

If fail, schema errors cause fail; mark sets bad document.

success

Successful.

fail_parse

The schema could not be parsed or the document fails the schema check.

fail_missingschema

The schema could not be found.

fail_format

The input document was inappropriate for the test (for example, the input was not XML).

input

The input data to be converted. If this parameter is left blank, the entire message is converted. Otherwise this parameter can isolate a part of the incoming message; consider use of iFL or XPATH to extract the information.

base 64

Is the data base64? The COBOL record may contain binary information, and so it is being carried in base64 form.

output node

Where is the converted data to be carried.? Applies only if the incoming COBOL is contained within an existing XML tree. Use XPATH notation to locate the element on which the converted data is to be attached as a child.

encoding

The input IANA character set. May be needed in cases in which the data is in an alternate character set, such as EBCDIC on a standard ASCII machine.

full FD

Ste to true if record headings are to appear in the XML

multi

If the data is longer than the area described by the FD, the conversion restarts at the next position. This allows multiple "data elements" to be converted. If false, remaining data is ignored.

copybook

The location of the copybook containing the FD.

success

Conversion has been successful

full_parse

The data could not be converted. Also can be issued if the configuration iFL is invalid.

full_operation

Failed for another reason.

Constant Output To Emit *

The value that will be emitted by the Constant service. If the Output Format parameter value is set to xml, this value needs to be valid XML, otherwise the original input document can be emitted based on the Input Criterion parameter value.

Output Format *

The output format of the result.

Select one of the following values from the drop-down list:

• xml (default)

  This value emits a valid XML output.

• flat

  This value emits output as flat text.

Output as Error

Determines whether the input should be emitted as an error document. Select true or false (default) from the drop-down list.

Input Criterion

Emit status criteria based on input type, else copy. Select one of the following values from the drop-down list:

• always (default)

  Emits the constant regardless of the input document's format.

• xmlonly

  If the input document is XML, emit the constant, otherwise emit the original input document.

• flatonly

  if the input document is flat, emit the constant, otherwise emit the original input document.

Call at EOS?

In a streaming environment, EOS (End of Stream) is the short message that is sent after the last document, which signifies the EOS. This parameter determines whether this service should be called for the EOS message? The default value is false.

success

Successful.

fail_parse

An iFL expression could not be evaluated.

Listener

Specify the name of a listener to control. This value can also be comma-separated list.

Action

Select one of the following actions from the drop-down list:

• start
• pause
• pulse
• stop

Call at EOS?

In a streaming environment, EOS (End of Stream) is the short message that is sent after the last document, which signifies the EOS. This parameter determines whether this service should be called for the EOS message? The default value is false.

Correlation ID *

Identifier for the correlated process. This is normally a runtime function, such as XPATH() or SREG().

Namespace

Namespace for Correlation ID. IDs will normally be unique within a namespace.

Output Type *

Should agent simply output its input, or should it output an XML correlation report?

Include History? *

If set to true, correlation history is included in the report.

Namespace

Namespace for Correlation ID. IDs will normally be unique within a namespace.

Correlation Status *

Return correlation IDs in this state.

Inquire By *

Which date should be used in search?

Updated Since *

Where record has been inserted or updated within this duration.

Include History? *

If set to true, correlation history is included in the report.

Correlation Set ID

Identifies the set with which this correlation ID is associated. This is typically a batch or envelope identifier, expressed using a runtime function.

Namespace

Namespace for Correlation ID. IDs will normally be unique within a namespace.

Method of compression to use *

Determines what format of compression should be used on the output. Select one of the following options from the drop-down list:

• none (default) - No compression is used.
• smallest - The smallest possible output, regardless of the execution time.
• fastest - The fastest possible execution time, even if the degree of deflation is reduced.
• standard - A compromise between smallest and fastest is used.
• Huffman - An entropic encoding scheme is applied.

success

Successful operation.

fail_operation

The decompression could not be performed. The data is probably not deflated.

fail_parse

The compressed data could not be accessed.

Document Output *

The manner in which to process documents. XML can be processed as flat text, but the output document will result as designated. Select one of the following options from the drop-down list:

• Process to Flat text - Treats the incoming/outgoing data as flat text.
• Process to XML - Parses the document as XML.

Processing Method *

Modify document data before or after the find/replace operation. Select one of the following options from the drop-down list:

• Find/Replace then Build Document - Performs a find/replace operation then parses the document.
• Build Document then Find/Replace - Parses the document then performs a find/replace operation.
• Only Find/Replace - Performs a find/replace operation only.
• Only Build Document - Parses the document as XML or flat (no replace is performed).

Find/Replace

Find

Text to search for. Use a comma (,) to repeat searches (for example: search1,search2,search3).

Replace

Text to replace search text. Multiple searches must have an equal number of replacements.

Encoding

Specifies the encoding when converting a flat document to XML format. Platform encoding is used by default. The Encoding parameter is required for the Document Update service to function properly.

Data Sources

Data used to build the document. Use a comma (,) to repeat data sources (for example: SREG(VAR_A),SREG(VAR_B),SREG(VAR_C)). Use DS0 to include the original incoming document.

Attachment Name

The name of this attachment, for example, file name.

Attachment Type

The MIME type. If no value is specified, the attachment type is generated based on the data format.

Body Result

Specify how to handle the body of this document by selecting one of the following values from the drop-down list:

• keep (default)
• empty

Outgoing Mail Host *

Outgoing email host used to route outgoing e-mail (add :port for non-standard port).

To *

Message recipient as an email address. Use ';' to delimit multiple addresses.

Subject of Msg

Subject of the message.

Sender address

Sender of this email.

Copy To

Carbon copy recipient of this email. Use ';' to delimit multiple addresses.

Blind Copy To

Blind Carbon copy recipient of this email. Use ';' to delimit multiple addresses.

Reply-to

Address to replyto for this email. Use ';' to delimit multiple addresses.

Content

Contains the data for the email body, default (blank) is the inbound document.

Attachment Tag

Tag name that holds a path to a file to be attached.

Add As Attachment

If set to true, the inbound document is treated as an attachment. An attachment name is then required.

Document Attachment Name

Name of the inbound document attachment.

Attachment Content Type

Content Type of the attachment.

User ID

Is the valid user ID to log on to the SMTP host server.

Password

Is a valid password to authenticate the SMTP user ID.

Content Type

The content type of the data.

Return

Select one of the following options from the drop-down list:

• status - Status document will become the output document.
• input - Input document will become the output document

Security Protocol

Select one of the following options from the drop-down list:

• none - Clear SMTP connection.
• SSLv2 - SMTPS - Connect to secure SMTP server.
• STARTTLS - Connect to an unsecured SMTP server, then negotiate SSL/TLS connection.

Tag Name *

The name of the tag which wraps the data.

Base64 Encoding *

Determines whether the data requires Base64 encoding, so that valid XML could be formed. Select true or false from the drop-down list.

success

Successful operation.

SQL DML *

SQL statement.

Data Source URL *

URL to reach the data source.

Document Return Type *

Document to return. Select one of the following options from the drop-down list:

• Status
• Original Input
• Statistics

User ID

Default user ID for the connection.

Password

Default password for the connection.

Search Code

Search code to search for (for example, XXX,YYY,ZZZ).

Statistic Handler

The RPC to call to fetch ETL statistics. Called only when return document is set to Statistics.

Handler Parameters

Parameters passed to the Statistic Handler.

Stats Wait

The amount of time in seconds to wait after an unsuccessful attempt to retrieve statistics.

Stats Retry

The number of attempts to try retrieving ETL statistics.

Type of failure

The type of failure to be thrown. Select one of the following options from the drop-down list:

• fail
• retry

Message

Message to be issued to the user.

Call at EOS?

In a streaming environment, EOS (End of Stream) is the short message that is sent after the last document, which signifies the EOS. This parameter determines whether this service should be called for the EOS message? The default value is false.

Source of Data

Source of data to write. If omitted, document will be used, else specify a data source location via XPATH() function or any other function.

Target Directory *

The target output directory.

File Pattern *

The file name pattern. In the pattern, an asterisk (*) character is replaced by the current timestamp. So T*.out might become T2002-06- 25_12:02:24:43.out. A # character is considered a unique number. The number of # characters controls the length.

Avoid Preemitter

If a preemitter exists on this route for output, this allows it to be bypassed for this emit operation. Perform this action to enable the output file to include non-processed (raw) information. Select one of the following options from the drop-down list:

• true (default)
• false

Return

Select one of the following options from the drop-down list:

• status (default) - status document will be the output document.
• input - input document will become the output document.
• swap - as input, but replace written data in the source nodes with the file name to which the data was written.

Base64 Decode

If set, the value is assumed to be in base64 notation. Only applicable is a specific write value is specified. Select one of the following options from the drop-down list:

• true
• false (default)

Respect Transactionality *

If set, the emit respects the transactionality of the channel. If not set, the file is always written. Select one of the following options from the drop-down list:

• true
• false (default)

Call at EOS?

In a streaming environment, EOS (End of Stream) is the short message that is sent after the last document, which signifies the EOS. This parameter determines whether this service should be called for the EOS message? The default value is false.

File Name Tag *

Tag of input document whose value is the file name to read. The input document must be:

<filename>pathToFile</filename>

This assumes that the tagname is set to filename. If the input format is XML or an entag parameter is used, the output is in XML form. Otherwise, the output is a flat document.

Note: The File Read Service assumes that the input data format is flat by default, or if the entag option is set to any value even if the XML input data format is selected.

Base Path

Optional directory to be used if the incoming name is not absolute.

Input Data Format

Format of the input data. Select one of the following options from the drop-down list:

• flat (default)
• XML

Enclose Tag

The name of the tag in which to enclose that data that is read. If omitted, no entagging is performed. If used, the output is XML.

Encoding

Encoding to be performed on the input. Can be asis or base64. If omitted, no encoding is performed.

Delete After Read

Determines whether the file is deleted after it is read. Select one of the following options from the drop-down list:

• true (default)
• false

Host Name *

DNS name (or IP address) of the FTP server to which you want to connect.

Remote Port

Port number used by the FTP server. Port 21 is used by default if no value is specified.

User Name *

Valid user ID for the FTP server.

Password *

Valid password for the FTP server.

Account Name

Valid account name for the FTP server.

Remote Site Folder

Folder or directory on the FTP server that you want to use as a starting location when you connect. Login directory is used by default if no value is specified.

File Pattern *

Output file pattern. An asterisk character (*) can be used for a timestamp. For example, *.XML,*.txt, and so on.

Note: *.* is unsupported.

Append

Append on PUT if the destination file exists. Select one of the following options from the drop-down list:

• true
• false (default)

Retry Interval

Retry interval in seconds. The following format can also be used:

xxhxxmxxs

Leave blank or enter 0 to indicate no retry interval.

Connection Retry

Attempted failed connects to the FTP server.

Quote Command

This specified command is sent as typed, BEFORE any data transfer.

Transfer Mode *

Form of FTP transmission. Select one of the following options from the drop-down list:

• ascii
• binary

Put File Protection

Is the PUT protected by a rename of a temp file name? Select one of the following options from the drop-down list:

• true
• false (default)

Return

Select one of the following options from the drop-down list:

• status - Status document will become the output document.
• input - Input document will become the output document

Use Passive Command

Uses PASV command if true, otherwise the PORT command is used. Select one of the following options from the drop-down list:

• true
• false (default)

File Name Tag *

Name of the tag from the input document in which to find the file name.

Enclose Tag

The name of the tag in which to enclose data read. If omitted, no entagging. If used, output is XML.

Base Path

Optional directory to be used if the incoming name is not absolute.

Input Data Format

Format of the input data. Select one of the following options from the drop-down list:

• flat (default)
• XML

Transfer Type

For non-XML input, this parameter sets the transfer type. Select one of the following options from the drop-down list:

• ascii
• binary

Host Name *

DNS name (or IP address) of the FTP server to which you want to connect.

Remote Port

Port number used by the FTP server. Port 21 is used by default if no value is specified.

User Name *

Valid user ID for the FTP server.

Password *

Valid password for the FTP server.

Encoding

Character set encoding to be performed on the input. Select one of the following options from the drop-down list:

• asis
• base64

Delete After Read

Determines whether to delete the file after the read. Select one of the following options from the drop-down list:

• true
• false

Target URL *

Specify a URL to post this information.

Action Method

Select one of the following methods from the drop-down list:

• GET - Data on the URL and URL encoded.
• POST (default) - Content-Length header.

Response content type

Overrides content type of response. Select one of the following options from the drop-down list:

• application/EDI-X12
• application/EDIFACT
• application/XML
• text/html
• text/plain

User ID

User ID for Basic Authentication challenges.

Password

Password for Basic Authentication challenges.

Response timeout value in seconds

Seconds to wait for response before signaling error.

IP Interface Host

Local IP Interface from which the outgoing IP socket originates.

IP Interface Port

Local IP Port from which the outgoing IP socket originates.

Relay Inbound Content Type

If set to true, relay headers as received (content type). Select one of the following options from the drop-down list:

• true
• false (default)

Proxy

Proxy

If set to true, emit through proxy server. Select one of the following options from the drop-down list:

• true
• false (default)

Proxy URL

URL of the proxy server.

Proxy User ID

User ID for proxy challenges.

Proxy Password

Password to access the proxy server.

HTTPS

Secure Connection

Use a secure connection. You may need to configure the Keystore under HTTPS section of the system properties if client authentication is required. Note, if keystore is configured in system properties make sure it has the CA certificate or the client certificate of the server you're connecting to. If keystore is not configured in system properties default truststore located under JRE_HOME/lib/security/cacerts will be used. Select one of the following options from the drop-down list:

• true
• false (default)

Use 128-bit Encryption

Enforces the use of 128-bit encryption. Select one of the following options from the drop-down list:

• true
• false (default)

Security Protocol

Select one of the following security protocols from the drop-down list:

• SSL - Supports some version of SSL; may support other versions.
• SSLv2 - Supports SSL version 2 or higher.
• SSLv3 - Supports SSL version 3; may support other versions.
• TLS (default) - Supports some version of TLS; may support other versions.
• TLSv1 - Supports TLS version 1; may support other versions.

Agent Specific Parameters

Return *

Return from this agent. Select one of the following options from the drop-down list:

• input
• response (default)
• status

Use Preemitters

If set to true, preemitters will be used for this emit. Select one of the following options from the drop-down list:

• true (default)
• false

Response Wrapper Tag

The tag name with which to wrap the response if the response is non-XML and must be XML

Response Base64 Encoded

Determines whether the response should be Base64 encoded. Select one of the following options from the drop-down list:

• true
• false (default)

URL Tag Name *

Tag name is the input document containing the URL.

Inflated Format *

Determines the format of the inflated output. Select one of the following options from the drop-down list:

• bytes (default)
• xml

If xml is selected, the output will be parsed.

success

Successful operation.

fail_operation

The decompression could not be performed. The data is probably not deflated.

fail_parse

The compressed data could not be accessed.

XML Namespace Provider

Provider for the mapping between XML namespace prefix and namespace URI. If left blank, Elements in the security token will use the default namespace.

Create Parent Element

Determines whether the parent element is created if it is missing. Select true or false (default) from the drop-down list.

Security Token Parent Element

Path to the element where the security token will be inserted. The default value is:

/soapenv:Envelope/soapenv:Header/wsse:Security

If the Create Parent Element parameter is set to true, the XPATH expression must be of the form /comp1/comp2/... where each path component has the following form:

ns:elem[@ns1:attrib="attribValue"]

The ns: and ns1: namespace prefixes are optional, but if they are present they must be declared in the XML Namespace Provider parameter. The selector in square brackets is optional. If no element with a matching attribute is found, then both the element and the attribute will be created.

WSSE Security Token Reference Id

The value of the SecurityTokenReference ID Attribute. Subsequent agents can retrieve this value in the saml_token_id special register.

SAML Assertion Id

The value of the SAML Assertion ID Attribute. Subsequent agents can retrieve this value in the saml_assertion_id special register.

SAML Issue Instant

The value of the SAML IssueInstant attribute. Subsequent agents can retrieve this value in the saml_issue_instant special register.

SAML Issuer

The value of the SAML Issuer attribute.

SAML Major Version

The value of the SAML MajorVersion attribute. The default value is 1.

SAML Minor Version

The value of the SAML MinorVersion attribute. The default value is 1.

SAML Authentication Instant

The value of the SAML AuthenticationInstant attribute

SAML Authentication Method

The value of the SAML AuthenticationMethod attribute.

SAML Name Identifier Format

The value of the SAML NameIdentifier Format attribute.

SAML Name Identifier

The value of the SAML NameIdentifier element.

SAML Subject Confirmation Method

The value of the SAML ConfirmationMethod element.

XML Namespace Provider

Provider for the mapping between XML namespace prefix and namespace URI. If left blank, the XPATH expression for the Timestamp Parent Element cannot contain namespaces.

Create Parent Element

Determines whether the parent element is created if it is missing. Select true or false (default) from the drop-down list.

Timestamp Parent Element

Path to the element where the timestamp will be inserted. The default value is:

/soapenv:Envelope/soapenv:Header/wsse:Security

If the Create Parent Element parameter is set to true, the XPATH expression must be of the form /comp1/comp2/... where each path component has the following form:

ns:elem[@ns1:attrib="attribValue"]

The ns: and ns1: namespace prefixes are optional, but if present, they must also be declared in the XML Namespace Provider parameter. The selector in square brackets is optional. If no element with a matching attribute is found, then both the element and the attribute will be created.

WSSE Timestamp Id

The value of the Timestamp ID attribute. Subsequent agents can retrieve this value in the wsse_timestamp_id special register.

Expiration Period

The time period after which the timestamp will expire. If left blank, the timestamp will never expire.

Use the following format:

[xxh][xxm]xx[s] 

For example, 1m30s is 90 seconds.

KeyStore Provider

Provider for the keystore containing the key.

Key Alias

Alias for the key to insert into the security token.

XML Namespace Provider

Provider for the mapping between XML namespace prefix and namespace URI. If left blank, Elements in the security token will use the default namespace.

Create Parent Element

Determines whether the parent element is created if it is missing. Select true or false (default) from the drop-down list.

Security Token Parent Element

Path to the element where the security token will be inserted. The default value is:

/soapenv:Envelope/soapenv:Header/wsse:Security

If the Create Parent Element parameter is set to true, the XPATH expression must be of the form /comp1/comp2/... where each path component has the following form:

ns:elem[@ns1:attrib="attribValue"]

The ns: and ns1: namespace prefixes are optional, but if they are present they must be declared in the XML Namespace Provider parameter. The selector in square brackets is optional. If no element with a matching attribute is found, then both the element and the attribute will be created.

WSSE Security Token Id

The value of the BinarySecurityToken ID attribute. If left blank, the default value is x509_signer. Subsequent agents can retrieve this value in the wsse_token_id special register.

Queue Name *

Name of the internal queue to post messages.

Avoid Preemitter

Determines whether any preemitter should be avoided. Select one of the following options from the drop-down list:

• true (default)
• false

Return *

Select one of the following options from the drop-down list:

• status (default) - status document will be the output document.
• input - input document will become the output document.

Call at EOS?

In a streaming environment, EOS (End of Stream) is the short message that is sent after the last document, which signifies the EOS. This parameter determines whether this service should be called for the EOS message? The default value is false.

Host *

Host to be checked for reachability.

Timeout *

A timeout period to attempt to reach the host. The default value is 3 seconds.

OnSuccess

The host is reachable.

fail_unreachable

The host is not reachable.

fail_partner

The host is not known. For example, the host is not identifiable in the DNS.

iBSP URL *

Select an available iBSP URL from the drop-down list or type a URL using the following format:

http://host:port

where:

host

Is the name of the machine where iWay Service Manager is installed.

port

Is the port on which iBSP listens for SOAP requests. The default port is 9000.

The iBSP URL allows you to access targets defined in the iBSP repository.

Adapter *

The name of the configured adapter you are working with, for example, RDBMS.

Target *

The name of the user-defined target that is associated with the configured adapter, for example, Oracle11.

Class

The name of the Java class that implements the adapter associated with the service. This field is populated by iWay Service Manager when you create the Adapter service and should not be modified.

Descriptor

Key used by iWay Service Manager to locate the adapter target parameters to associate with the service. This field is populated by iWay Service Manager when you create the Adapter service and should not be modified.

Keys

Key used by iWay Service Manager to locate the adapter persistence keys associated with the service. This field is populated by iWay Service Manager when you create the Adapter service and should not be modified.

Create Error Document

Select one of the following options from the drop-down list:

• false

  The service will throw an exception when the adapter throws an exception.

• true

  The service will capture exceptions that occur when the adapter is invoked and returns an XML document encapsulating the error message.

Persist Connection

Select one of the following options from the drop-down list:

• false

  Each invocation of the agent will create a new instance of the adapter, activate it, use it, passivate it, and throw it away.

• true

  When an instance of the agent is created, it will create a new instance of the adapter and activate it. This adapter is reused by subsequent invocations of the agent.

• pooled

  iWay Service Manager maintains an adapter cache keys by adapter class, target, and agent parameters. When invoked, the Adapter service will check the cache for the required adapter. If there is one, that adapter will be used and if not one will be created and added to the cache. The cache maintains only one adapter for each key combination and access to that adapter is synchronized.

success

Successful operation of the adapter.

fail_operation

The adapter failed and did not report the direct cause.

fail_security

The adapter has returned a security violation.

fail_partner

The adapter reports that it cannot reach the needed external system or that system has returned an error.

cancelled

The operation has been cancelled due to a timeout or other cause.

Output Format *

The format of the result.

Transaction Isolation Level

Transaction isolation level to be set if possible.

User ID

The user ID if it is not specified in the document.

Password

The password if it is not specified in the document.

JNDI name *

JNDI name for the requested data source.

Connection factory *

The object store name.

Receiver queue *

The name of the receiver queue.

Messaging type

The message type.

JNDI URL *

The JNDI URL.

JNDI factory *

The JNDI factory class name.

Correlation ID

The correlation ID.

Correlation ID tag

The correlation ID tag.

User ID

A valid user ID for challenges.

Password

A valid password for challenges.

Acknowledgement

Acknowledgement mode, or transactional.

Preemitter

Should any preemitter be avoided?

Return document

Select one of the following options from the drop-down list:

• status - status document will be the output document.
• input - input document will become the output document.

Output message type

Select an output message type.

JMS Reply-to

Queue or Topic (used for JNDI lookup).

Name

Name of the defined local master (channel) to be called.

Call at EOS?

In a streaming environment, EOS (End of Stream) is the short message that is sent after the last document, which signifies the EOS. This parameter determines whether this service should be called for the EOS message? The default value is false.

Attachment Tag *

Tag used to identify an attachment (attachment is the default).

Encode

If set to true, everything is base64 encoded, if false only non-txt is encoded.

Target

Target of attachments.

Output Directory

The target output directory.

Output File Name

The output file name, which can contain an asterisk character (*) and is expanded to a timestamp, if an empty attachment name is used.

Note: If you want to preserve the original name of the attachment, do not specify a value for this parameter.

Delete Mail Object

If no other component needs the mail object, it should be deleted.

Attachment Name

Name for this attachment, usually the file name.

Attachment Type

Mime type; if omitted one is generated based on the data format.

Body Result *

Determines how to handle the body of the document.

correlid

The correlation ID.

queuemanager

The queue manager name.

queuename

The queue name.

host

The email host.

subject

The subject of the message.

to

The intended recipient as an email address.

Operation

Select the specific operation to perform from the drop-down list. Available options include:

• Reconstruct the original message
• Create an MTOM package
• Add an Include

Delete Attachments

If the Reconstruct the original message option is selected for the Operation parameter, the Delete Attachments parameter specifies whether to delete the attachments that have replaced xop:Include elements.

Element Path

If the Create an MTOM package option is selected for the Operation parameter, you must specify an XPATH expression for the Element Path parameter that returns the set of base64binary nodes to extract.

If the Add an Include option is selected for the Operation parameter, you must specify an XPATH expression that returns the element where the xop:Include element will be added.

XML Namespace Provider

A provider for the mapping between XML namespace prefix and namespace URI in the Element Path.

Attachment Content-Type

If the Create an MTOM package option is selected for the Operation parameter, this is the Content-Type set on a new attachment when the xmlmime:contentType attribute is absent on the extracted element.

Attachment Content-ID

If the Add an Include option is selected for the Operation parameter, this value is the Content-ID of the existing attachment being referred to.

If the Create an MTOM package option is selected for the Operation parameter, the Content-ID of the new attachments will be the prefix specified here followed by a numeric suffix.

XPATH Expression *

The XPATH expression which represents the node set.

Root name

Optional root for multiple children.

Name of the PFLOW *

The name of the process flow to run. This value could be a string value or a SREG reference for dynamic process flow invocation. In order for the service to be successful, the referenced process flow must be deployed as a service during run time.

Called at EOS?

In a streaming environment, EOS (End of Stream) is the short message that is sent after the last document, which signifies the EOS. This parameter determines whether this service should be called for the EOS message? The default value is false.

Operation *

Command to execute when service goes active.

File (from) *

Originating file to be operated on. Relative or absolute file paths are supported explicitly or through a SREG or XPATH expression evaluated using the incoming document.

File (to)

Destination file to be operated on. Wild cards accepted. Required except for delete, size, exists.

Size

Special register designated to hold size. Required for size.

Out Document *

Document returned by operation (bad input defaults to result)

Action on Failure *

Determines whether input document or status document is returned on failure.

Retry

If non-zero, will retry the operation n times at one-second intervals.

Name of File *

File to be read. Relative or absolute file paths are supported explicitly or through a SREG or XPATH expression evaluated using the incoming document.

Delete after read *

Determines whether to delete the file read on a successful read.

Format *

Format of the input data.

Tag

Name of the XML tag to wrap the data read in. Required if data is flat.

Character Set Encoding

Character set encoding of the document to be read in. Default system encoding will be used if left blank.

Embed *

Determines whether to embed the data from the read operation into the input document.

Base64 Encode *

Base64 encode the read in document when embedding.

Parent Tag

Where in the input document the input data should be embedded.

Retry

If non-zero, will retry the operation n times at one-second intervals.

Operation *

Command to execute when service goes active.

File (from) *

Originating file to be operated on. Relative or absolute file paths are supported explicitly or through a SREG or XPATH expression evaluated using the incoming document.

File (to)

Destination file to be operated on. Wild cards accepted. Required except for delete, size, exists.

Host name *

DNS name (or IP address) of the FTP server that you want to connect to.

Password *

Valid password for the FTP server.

User Name *

Valid user ID on the FTP server.

Port *

Port to connect to on the FTP site.

Size

Special register designated to hold size. Required for size.

Out Document *

Document returned by operation (bad input defaults to result).

Action on Failure *

Determines whether input document or status document returned on failure.

Retry

If non-zero, will retry the operation n times at one-second intervals.

Name of File *

File to be read. Relative or absolute file paths are supported explicitly or through a SREG or XPATH expression evaluated using the incoming document.

Delete after read *

Determines whether to delete the file read on a successful read.

Host name *

DNS name (or IP address) of the FTP server that you want to connect to.

Password *

Valid password for the FTP server.

User Name *

Valid user ID on the FTP server.

Port *

Port to connect to on the FTP site.

Format

Format of the input data.

Tag

Name of the XML tag to wrap the data read in. Required if data is flat.

Character Set Encoding *

Character set encoding of the document to be read in. Default system encoding will be used if left blank.

Embed *

Determines whether to embed the data from the read operation into the input document.

Parent Tag

Determines where in the input document the input data should be embedded.

Action on Failure *

Determines whether input document or status document returned on failure.

Retry

If non-zero, will retry the operation n times at one-second intervals.

Preemitter

Name of the defined preemitter to run. If blank, standard selection is used.

return*

Output is the preemit result. If the preemitter fails, 'status' - status document will be the out document. 'input' - in document will become the out document.

Call at EOS? *

In a streaming environment, EOS (End of Stream) is the short message that is sent after the last document, which signifies the EOS. This parameter determines whether this service should be called for the EOS message? The default value is false.

Printer URL *

The URL for the printer.

Server Name *

Name of the printer at the URL.

Copies

Number of copies.

Retries

Number of retries if print server down.

Print format

Print format.

Secure

If enabled, secure connection will be used.

Secure 128-bit

If enabled, use of 128-bit encryption will be enforced.

Proxy Server

If enabled, emit through proxy server.

Proxy URL

The URL of the proxy server.

User ID

User ID for challenges.

Password

Password for challenges.

Preemitter

Should any preemitter be avoided?

success

Standard success edge.

fail_parse

Could not parse the XPATH expression or other entered function.

fail_operation

File write failure occurred.

notfound

No information meeting the source criteria was located.

Where *

File pattern to receive trace file.

When

Determines when to emit the information.

Name

Identifier name to mark emitted trace document.

Emit input

Location (file pattern} to which to emit actual input document. If omitted or empty, the incoming document is not emitted.

Base64 Decode

If set, the value is assumed to be in base64 notation. Only applicable is a specific write value is specified.

Format *

Format of result.

Property Name

Name of properties group (if none, DSN is used).

Transaction level

Transaction isolation level to be set if possible.

URL

URL to reach the data source.

JDBC driver

JDBC driver to use.

User ID

User ID if not in the document.

Password

Default password if not in the document.

JNDI name

JNDI name for the registered data source.

Datasource type

Type of data source.

Routing Rules *

Name of rules section to be used as basis of routing.

Special Register Name *

Name of special register to set from selected destination.

Output Type

Type of output from this service.

Error Location *

The error output directory.

Error Mask *

The error file name with possible wild cards.

Valid Location

The valid output directory.

Valid Mask

The valid file name with possible wild cards.

Ack Location

The acknowledgement output directory.

Ack Mask

The acknowledgement file name with possible wild cards.

Original Location

The original data output directory.

Original Mask

The original data file name with possible wild cards.

Status Location *

The status document output directory.

Status Mask *

The status document file name with possible wild cards.

Action*

Initialization

Action to be performed by agent. Select one of the following options from the drop-down list:

• Authenticate (auth) - The user is authenticated against the realm, but the principal is not changed.
• Impersonate (push) - The user is authenticated and the principal is pushed.
• Pop (pop) - The current principal is popped (deleted). You cannot pop past the base principal. Managing the relationship between impersonation push and the pop is the responsibility of the process designer.

Realm*

Initialization

Authentication realm provider to use. The authentication realm must be configured at the time the service is used.

User

Per Message

The user to be authenticated.

Credential

Per Message

The credential used to authenticate the user.

success

The user is authenticated.

fail_security

The user is not authenticated.

Target *

The name of the node of the desired subtree.

Type *

Type of target node.

Queue Name *

The name of the receiver queue.

Broker URL *

URL (address) used by the listener to connect to the Sonic broker. The format of the URL is Protocol://host:port. If Service Manager is listening on a Sonic broker configured to listen on TCP, the format of the URL is tcp://host:port. The default TCP port on which Sonic listens is 2506. This value is configured in the Sonic broker.ini file. When Service Manager listens to Sonic, the URL is in the form of http://host:port where the HTTP port is defined in the Sonic broker.ini file.

The Sonic listener supports fail over if unable to reach a particular broker. You must provide a comma-separated list of broker URLs. The client attempts to connect to brokers in the list, for example, tcp://host:port, tcp://host:port.

User ID

User ID for challenges.

Password

Password for challenges.

Messaging type

The messaging type. Select one of the following options from the drop-down list:

• queue
• topic

Output Message Type

The output message type. Select one of the following options from the drop-down list:

• bytes
• text
• dynamic

Ackmode

The acknowledgement mode, or transactional. Select one of the following options from the drop-down list:

• auto
• dupsok
• client
• trans

Send Persistently

Support for persistent and non-persistent messages. In the event of a network or system failure, the persistent option prevents messages from being lost.

In the event of a broker or Service Manager failure, non-persistent messages are volatile. Persistent messages are saved to disk.

Load balance

Determines whether to load balance among brokers. Select true or false.

Duplicates Detect

Determines whether to detect for duplicates. Select true or false.

Priority

Priority of the message, which can also be specified using XPATH(). The default is 3.

Correlation ID

Correlation ID of the message, which can also be specified using XPATH().

Preserve undelivered

Determines whether to preserve undelivered documents. Select true or false.

Notify undelivered

Determines whether to notify if documents are undelivered. Select true or false.

Preemitter

Should any preemitter be avoided?

Fault Tolerant

Determines whether the listener is connecting to the Sonic Broker as a fault tolerant client or not. The default value is false, that is, the listener is not connecting as a fault tolerant client.

This feature is supported only when the Sonic Broker is installed with a Sonic Fault Tolerance license code.

Sequential

When multiple brokers listed, this parameter determines whether they are used sequentially or randomly. Select true or false.

Reconnect Fault Timeout

Determines how long to wait (in seconds) before trying to reconnect.

Initial Connect Timeout

Determines how long to wait (in seconds) after failing initially, before trying to reconnect.

Return document

Select one of the following options from the drop-down list:

• status - status document will be the output document.
• input - input document will become the output document.

prefix

The path to prepend to an agent (service) name.

Directory *

Path pattern for the split files.

Transform *

XSLT file name and location.

Manager *

Name of the local MQ Series queue manager to be used.

Queue name *

Queue on which request documents are received.

Correlation ID

The correlation ID linking messages.

Correlation ID tag

The XML tag at which the correlation ID is located.

MQ host

The MQ host, which is needed if you are using MQ client.

MQ port

The MQ port, which is needed if you are using MQ client. The default is 1414.

Channel

The MQ server channel, which is needed if you are using MQ client.

Delivery

Request confirmation of delivery.

Arrival

Request confirmation of arrival.

Report Queue

The name of the report queue; required if COA or COD is requested or msgtype is response.

Priority

Priority of message, which can be specified using XPATH(). The default is 3.

Format

Name of MQ message format. The default is STRING.

Type

Name of MQ message type.

Message persistence

Message persistence. Default is as defined for the queue.

Expiry

An expiry time expressed in tenths of a second. The default is unlimited.

MQ Character set

MQ Character set, default as per queue manager.

Attributes

Include user attributes in the emitted document.

Preemitter

Should any preemitter be avoided?

SSL CipherSpec

The SSL Cipher Specification being used.

Return document

Select one of the following options from the drop-down list:

• status - status document will be the output document.
• input - input document will become the output document.

Join Local Transaction?

If the listener is a transaction manager, should this emit be rolled back if the transaction fails?

Call at EOS?

In a streaming environment, EOS (End of Stream) is the short message that is sent after the last document, which signifies the EOS. This parameter determines whether this service should be called for the EOS message? The default value is false.

SQL DML *

The SQL statement, which can also evaluate an iFL expression to build an SQL statement dynamically. For example, inserting SREG(value) into the text of your query.

Evaluate SQL

If set to true, an attempt is made to treat the SQL as an expression. This may not be appropriate to all SQL. For example, quotes in evaluated strings must be escaped by doubling.

Output Format *

The format of the result.

Transaction Isolation Level

Transaction isolation level to be set if possible.

Pool Connections

If set to true, connections are pooled.

Validate Pooled Connection?

If set to true, an attempt to execute the specified SQL statement is made before reusing a pooled connection.

Validation Statement

SQL statement to execute when testing a pooled connection before use. The default value is recommended for most DBMS.

Attempt Read Only

For select set JDBC 'read only' flag. Some drivers cannot handle this optimization and can give security failures.

Connection Properties

Properties to apply to a connection.

Need Commit

Should a commit be performed on completion? If yes, pools will be built accordingly.

Timeout

Number of seconds this service will wait for an operation to complete. A value of 0 means no timeout check.

Max Rows

Maximum rows if query DML (0 is all).

Make Siblings

If set to true, sibling documents are created for each Max Rows group.

Max Siblings

Maximum siblings of maximum rows (if siblings selected).

Emit No Empty

If set to true, empty documents are not emitted.

Issuance Strategy

Issuance strategy: via SQL construction or via SQL bind.

Reply Node Name

If entered, response is put at this fully qualified named node.

Base 64 if Needed

If set to true, all fields are checked for base64.

Call at EOS?

In streaming a last call is made AFTER the last document. Does this Service want to be called?

Connection

JDBC Driver *

The JDBC driver to use.

Data Source URL *

The URL to reach the data source.

User ID

Default user ID for the connection.

Password

Default password for the connection.

Type of variable

Type of variable (headers appear in emitted documents as header values). Select one of the following options from the drop-down list:

• User

  This variable is part of the process flow logic and is the most commonly used type.

• Document

  This variable is specific to the incoming document, such as the name of the input document.

• Header

  This variable is part of the document routing information, such as an HTTP header or an IBM MQSeries descriptor.

• Delete

  This variable indicates the removal of the register set that is used in a process flow.

Scope of variable

For process flows, scope can be for all nodes or only nodes forward on this edge. Select one of the following options from the drop-down list:

• Message
• Flow
• Thread

Flow- and message-scoped variables have one shared copy for the entire process flow. Therefore, a change made to the variable will be seen on all parallel paths. Unless various points of the parallel process flows are synchronized, the results that are written to a global variable may leave the variable with an unpredictable value.

Flow-scoped variables are deleted at the termination of the process flow (or sub-flow) in which they are declared. If you need a variable to be available to the calling process flow (parent flow) or to subsequent components, such as outlets and emitters, select Message as the scope.

Thread-scoped variables are duplicated for each parallel document path, allowing independent manipulation of each copy. After parallel paths converge at a Join object, the value of the thread is undefined.

Automatic evaluation

Causes contents to be evaluated to hold functions. Select one of the following options from the drop-down list:

• true

  Evaluates an SREG every time it is retrieved.

• false (default)

  Evaluates an SREG only once, as the value is stored.

To summarize, if you select false, the expression is not evaluated upon storage into the SREG. If you select true, the contents of the SREG are evaluated every time it is retrieved.

For expressions that have different results at different times, this offers more functionality than storing the result once (for example, an expression that formats a timestamp saved to an SREG).

However, if the Automatic evaluation parameter is set to true for _flatof(), XPATH, or other operations that pertain to the document itself, the result will always be NULL because access to “the document” is not available.

Call at EOS?

In a streaming environment, EOS (End of Stream) is the short message that is sent after the last document, which signifies the EOS. This parameter determines whether this service should be called for the EOS message? The default value is false.