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 process flow rolls back. To achieve transactional recording, the channel must be declared to control the local transaction.

Message

The text message to be logged.

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:

• emit {emit}
• security {security} (default)
• emit {signature}
• crypto {crypto}
• user {user}

You can also type an arbitrary, user-defined value in the Event field that must be greater than 1000.

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}
• verify {verify}

You can also type an arbitrary, user-defined value in the Code field that 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.

fail_unreachable

Neither host nor alternate can be reached.

Queue Name *

Name of the input queue to be monitored.

Host

Host of the server connection.

SID *

SID of the server connection.

Port

Port to use for the server connection.

Driver *

Driver to use for the server connection.

User *

User login ID at the broker machine.

Password *

User password at the broker machine.

Table Owner/Schema *

Usually the same as the login.

Table Name

Table in which the queue resides.

Connection Type *

Connection to Oracle JMS or Oracle AQ.

• aq
• jms

AQ

Message Type

Select one of the following message type formats to send or create (when creating a dynamic queue on the listener):

• clob
• raw

Payload Class

When using custom defined objects, specify a class that is in the classpath.

Payload Object

When using custom defined objects, specify the Oracle object that the class will map to. The owner of the schema will be prepended.

Object Owner

Name of the input queue to be monitored.

RAC

RAC Hosts

Enter additional hosts for RAC failover/load balancing (host1:port, host2:port, host3:port).

RAC Load balance

Use the RAC connection for load balancing.

• false
• true

RAC Failover

Use the RAC connection for failover.

• false
• true

ONS Hosts

Hosts emitting ONS information, for example host:port, host:port.

Cache Minimum

The minimum number of connections to the queue to be held in the cache.

Cache Maximum

The maximum number of connections to the queue to be held in the cache.

Cache Initial

The initial number of connections to create in the cache.

Cache Inactive Timeout

The maximum time a cached physical connection can remain idle.

Cache Abandoned Timeout

The maximum time that a connection can remain unused before the connection is closed and returned to the cache.

Cache Maximum Statements

The maximum number of statements that a connection keeps open.

Cache Property Interval

Sets the time interval at which the cache manager inspects and enforces all specified cache properties.

JMS

Message Priority

The outgoing message priority. If no value is specified, the incoming message priority is used.

Message Type

Select one of the following message type formats to send or create (when creating a dynamic queue on the listener):

• bytes
• text

Set Reply Correlation ID

If set to a value, this is used as the correlation ID of the response.

Delivery Mode

Retention of a message at the destination until its receipt is acknowledged is not guaranteed by a PERSISTENT delivery mode.

JMSReplyTO

Queue or Topic (used for JNDI lookup).

Time to Live

The lifetime of a message (in milliseconds). The default is the message will live forever.

Agent Specific Parameters

Return *

Return from this agent.

• response
• status

Preemitter

Determines if any preemitter be avoided.

• true
• false

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.

Subject of Msg

Subject for messages.

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 *

• status. A status document will become the output document.

• input. Input document will become the output document.

Avoid Preemitter

Checks to see if any preemitter should 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, for example, 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, for example, 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 are 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.

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.

Although the specification of the Content-ID header requires the value to be enclosed in angle brackets, you must not use the angle brackets in this property.

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.

Method

Select one of the following options to remove blank spaces:

• All. Trims leading and trailing whitespaces from all element text values. This option is selected by default.
• Empty. Trims whitespace-only element values; does not trim other element text values.

fail_format

The input document was not in XML format.

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

The path to the schema file.

Fail on error *

If fail, schema errors will cause failures. Mark sets bad document.

badschema

The schema fails the schema check.

Schema File

The source of the schema to be applied to the incoming document. You can specify a file path directly in this field, or select one of the following values from the drop-down list:

• route {$route}. A schema published to the selected route that is currently managing the channel.
• start node {$start}. A schema specified on the Start object of the process flow.

Schema Name

If the schema is packaged in a .zip archive file, which is specified in the Schema File field, then the name of the schema file (for example, xyz.xsd) must be provided.

Strictness *

Determines the level of schema testing that should be applied. Select one of the following values from the drop-down list:

• strict (default). The document must validate. Failure to validate results in a fail_parse result.
• optional. If the schema is located, then the document must validate. If the schema cannot be located, then the document validation is ignored.

success

Successful.

fail_parse

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

fail_missingschema

The schema could not be found.

fail_format

The format of the input document was not compatible (for example, not in XML format).

success

The operation completed.

fail_operation

An error was reported in attempting to commit or roll back the transaction.

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.

Exit

The name of the Activity Facility exit to be controlled. This exit must be available.

Action

Determines the action to be taken. Select one of the following actions from the drop-down list:

• start
• 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.

success

The requested action has been initiated. The operation of the server is generally asynchronous, so this only means that the start activity has been initiated.

fail_parse

The configuration parameters can not be understood.

fail_notfound

The named exit can not be located in the set of deployed exits.

fail_operation

The requested action failed for some other reason.

Listener

Specify the name of a listener to control. This value can also be a 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 and 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).

Document Assembly Instructions

A comma-separated field used to describe how the document is assembled. The build text is evaluated from left to right; iFL functions (for example, _SREG and _CONCAT) are evaluated at document build time. The following special text values are also used:

DS0 - document at time of build, DS#

where:

#

Represents one of the four data sources.

DS1

Data source 1, which is evaluated when the component is called. This field may contain any iFL functions (for example, _SREG and _CONCAT) and text. This field is represented in the Document Assembly Instructions parameter as DS1.

DS2

Data source 2, which is evaluated when the component is called. This field may contain any iFL functions (for example, _SREG and _CONCAT) and text. This field is represented in the Document Assembly Instructions parameter as DS2.

DS3

Data source 3, which is evaluated when the component is called. This field may contain any iFL functions (for example, _SREG and _CONCAT) and text. This field is represented in the Document Assembly Instructions parameter as DS3.

DS4

Data source 4, which is evaluated when the component is called. This field may contain any iFL functions (for example, _SREG and _CONCAT) and text. This field is represented in the Document Assembly Instructions parameter as DS4.

Find/Replace

Search

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.

Note: As of iWay Service Manager Version 5.6, 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.

EX_SUCCESS

The service generated a successful output. Either a flat document was generated by the service (if Process to Flat text was selected), or a well formed XML document (if Process to XML was selected).

EX_FAIL_PARSE

Returned by the service if any of the following fields contain an invalid iFL statement:

• Document Assembly Instructions
• DS1
• DS2
• DS3
• DS4
• Search
• Replace

If Process to XML was selected and the document created is not a well formed XML document.

EX_FAIL_OPERATION

An unexpected error occurred while processing the document or the parameters of the service. Check the iSM logs for further details.

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 email (add :port for non-standard port).

To *

Message recipient as an email address. Use a semicolon (;) 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 a semicolon (;) to delimit multiple addresses.

Blind Copy To

Blind Carbon copy recipient of this email. Use a semicolon (;) to delimit multiple addresses.

Reply-to

Address to replyto for this email. Use semicolon (;) 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.

Bypass Error Message

Indicates not to trace at the error level when this service terminates the process. This is useful for cases where the trace log is being monitored by an external program for errors. The termination will be traced at the debug level.

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

Determines how the data is located. If this parameter is omitted, the content of the current input document is used.

Target Directory

Directory to which the file is written.

File Pattern

Standard iWay file pattern. If the file exists when the agent begins the operation, the new data is appended to the existing file.

Return

Determines what is placed on the outgoing document. Can be status (status document) or input (input document).

Base64 Decode

If set to true, the incoming value is presumed to be in the Base64 encoding. By default, this parameter is set to false.

Append CRLF

If set to true, a line termination sequence is written after the 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.

success

The item was added to the file. If the file did not exist, it was created.

fail_operation

Write could not be completed.

fail_parse

The configuration could not be performed. Often this is generated by an invalid iFL statement.

fail_notfound

The file to be written could not be located. This may be a path issue.

Directory

The directory to be listed. This service does not descend directories.

Include

Determines what items should be included in the listing. Select one of the following options from the drop-down list:

• Files (default)
• Subdirectories
• All

Selection Expression

If present, this is a Java regular expression used for selection of the file or subdirectory. For example, to select only .xml files, you might use ".*\.xml" as the pattern (the quotes are not included in the pattern) .

Note: The expression, .*\.xml is deconstructed as follows. The leading dot means any character, and the asterisk means any number of them, until a suffix of .xml is reached. The problem with the .xml is that the dot would mean any character, so it is escaped. Because this is not iFL syntax, the backslash does not need to be escaped.

Pattern Type

If the Selection Expression is supplied, indicate whether it should be interpreted as a regular expression (regex) or a DOS style wildcard (wildcard).

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.

type

Identifies whether this is a file or a directory entry.

lastmod

An integer value of the time the file was last modified. This is the last-modified time, measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970).

lastmodstr

The last modified time as a string.

success

The directory document was produced.

fail_notfound

The directory to be listed was not found

fail_operation

The directory to be listed was not reachable. This can come about if a relative directory cannot be resolved or the directory was not specified.

Source of Data

Determines the source of data to emit. If you require a document to be emitted, then enter the corresponding system path for this document. If no value is specified, then the current document is used by default. You can also specify an iWay expression, including the xpath() function to specify a data source location (for example, if an XML document is used).

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 if 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

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.

Queue Name *

The name of the internal queue that is serviced by an internal queue listener. The queue is created when the channel is started and exists as long as the server is running.

Want User Registers

If set to true, user-type registers are passed to the destination queue. DOC and HDR registers are always transferred with the message. By default, this parameter is set to false.

Priority

Determines the relative priority of the message. Use this parameter to reorder the execution of messages. Only the relative numbers matter. Higher numbers do not execute messages faster, only the acquisition order by the internal channel is affected. By default, this parameter is set to 4.

Put Timeout

Determines the amount of time that the emit will wait for the internal channel to accept the message. If the destination queue is inhibited, the emit is paused until the message can be accepted. If the timeout period expires, a status message is sent down the timeout edge, where your application might chose to pend the message. For more information on using inhibition to provide cascading flow congestion management, see Chapter 1, Introducing iWay Service Manager in the iWay Service Manager User's Guide.

Request Context Namespace

By specifying a namespace, registers in that namespace will be sent to the destination queue. This is used to limit the registers to those of interest to the message process.

Response Context Namespace

This parameter is used only for synchronous emits. If set, registers returned from the internal channel are placed into this namespace.

Return *

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

• status (default). A status document is returned showing the success of the queuing operation.
• input. The input document that originally came into the emit service is returned.
• response. The response from the execution through the internal channel is returned. When response is set, the emitter waits for the response from the internal channel, making this a synchronous call.

Avoid Preemitter

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

• true (default)
• false

Respect Transactionality

Determines whether this emitter should post messages regardless of the commit/rollback state of the transaction. For example, you may not want to respect transactionality when passing messages that reflect the progress of an application or errors within the application. By default, this parameter is set to true.

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. By default, this parameter is set to false.

Timeout

Determines how many seconds to wait for a synchronous response. Set to 0 or leave blank to wait indefinitely.

success

The message was enqueued for execution by the listener and channel that is servicing the destination queue.

fail_parse

The iFL used to configure this service contained an error.

fail_notfound

The queue was not available.

timeout

The message could not be placed onto the destination queue in the time period specified in the Put Timeout parameter. This signifies that the queue was inhibited and could not receive messages.

cancelled

A cancel order was received while the service was in operation.

fail_operation

The message could not be marshaled or could not be enqueued for some other reason.

notfound

The queue was not available. In some applications this may not be considered an error, so this edge is provided along with the fail_notfound edge.

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.

Persist Connection

If enabled, the adapter connection is reused between execution attempts. Select one of the following options from the drop-down list:

• none (false). Each invocation of this service will create a new instance of the adapter. Thus, for simple processing, one instance of the adapter is used for each requested operation. When streaming, one adapter instance will be reused for all messages in the stream. In a transaction, each created adapter instance receives the commit or rollback.
• persist (true). This refers to persistence at the process flow instance level. When an instance of the adapter is first encountered for a target, the service creates a new instance of the adapter that is specific to that target.

  This adapter instance is reused by subsequent invocations of the service, within an iterator loop and across invocations of the worker, including use within a streaming preparser situation.

  At the end of the process flow, the adapter instance is no longer available.

• pool. An adapter with a specific set of parameters and a specific target will be cached at the worker (sub-channel) level. This means that multiple services within a process flow will share an adapter and that multiple invocations of the process flow or a different process flow requiring the same adapter or target will reuse that adapter. If you have a threading count of n, then there will be n instances of the cached adapter.

  Note: The term target refers to an evaluated target in which any iFL has been replaced with the value of that iFL. For example, a target with a port in a special register will be treated as the port value after the register value is obtained.

Promote OnFailure

If set to false, failure edges, such as fail_connect, are promoted to OnError. This is used for upward compatibility purposes.

Emit OnFailure

If the Promote OnFailure parameter is set to false, this parameter determines the type of document to emit on failures. Select one of the following options from the drop-down list:

• status. A status document will become the output document. This option is selected by default.
• input. The input document will become the output document.

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.