This topic explains the functional behavior of various binding types.

Poll Request Wizard

The Poll Request Wizard is as shown:

The table describes the various attributes.

Poll Request : Properties

Attribute Name	Description
Message Repository	The Message Repository path pointing to a directory on the remote FTP server where messages will be processed and archived. For more information, see Appendix B - Message Repository Directories
Message Name	Message Name is the filename where a message is put into, usually in the form of a name pattern. Pattern is a string containing special characters preceded by a percentage sign. For more information, see Appendix C - Java Timestamp Patterns 1    UUID %u, will be substituted by a UUID value compliant with Java 1.5 UUID. 2    sequence number reference %0, %1, %2, %3, %4, %5, %6, %7, %8, %9, this symbol will be replaced by the current value of sequence number which is an integer count that increment after each reference.
Message Name Prefix	Prefix for outbound (OB) message name.
Enable Overwrite Protect	Indicate if overwrite protection is required for message send, when true, existing message will be moved to dedicated directory before the current message is put to the target, otherwise, current message overwrites existing message. The checkbox is selected, by default.
Enable Staging When Put Message	Indicate if staging is enabled for message transfer. The check box is selected, by default.
Payload Processing	1    text: Text Data        This radio button is selected, by default. 2    xml: XML Data        Click ellipses (...) to select an Element or Type. 3    encoded data: Encoded Data        Click ellipses (...) to select an Element or Type.

Top

Poll Request Message and Put Response

Poll Request Message : Properties

Attribute Name	Description
Message Name Prefix	Prefix for inbound (IB) message name.
Poll Interval in milli-seconds	Polling interval in milliseconds when message is polled from a remote target.

Put Response : Properties

Attribute Name	Description
Message Name Prefix	Prefix for outbound (OB) message name.

Top

Put Request Message and Poll Response

Put Request Message : Properties

Attribute Name	Description
Message Name Prefix	Prefix for outbound (OB) message name.

Poll Response : Properties

Attribute Name	Description
Message Name Prefix	Prefix for inbound (IB) message name.
Poll Interval in milli-seconds	Polling interval in milliseconds when message is polled from a remote target.

Top

On Demand Get Message

On Demand Get Message : Properties

Attribute Name	Description
Message Name Prefix	Prefix for inbound (IB) message name.
Enable Archive Polled Message	Indicates if archive is required for processed message. If true, processed message is archived, otherwise, it is removed.

Top

Receive Request

Poll Request : Properties

Attribute Name	Description
Receive Source (From)	Path pointing to a file on remote FTP server where the transferred data will be read (receiveFrom), the path components could be literals or regular expressions.
Receive From Has Regular Expression	Indicates if 'receiveFrom' has regular expressions. When 'receiveFrom' contains regular expressions, these are used as filters to filter out those directory/file entries that match the corresponding regular expressions. For example, if 'receiveFromHasRegexs' = FTP_IN_BOX/archive200<1-6>/invoice_<0-1><1-9>.bak At runtime, FTP BC gets a directory listing from FTP_IN_BOX, iterate through each one of them and finds the first match for regular expression 'archive200<1-6>'. For example, archive2001, get a directory listing from FTP_IN_BOX/archive2001, iterate through each one of them and find the first match for regular expression 'invoice_<0-1><1-9>.bak', say, invoice_01.bak, now FTP_IN_BOX/archive2001/invoice_01.bak is found as the first match, and it will be used as the resolved value for 'receiveFrom', otherwise, if no match found for regular expression 'invoice_<0-1><1-9>.bak', FTP BC will go back to the parent level, and try the next match of 'archive200<1-6>', and repeat the above process until found a path matching all the regular expressions as corresponding path components or no matching path found after exhausted all paths under FTP_IN_BOX.
Pre Receive Operation (Command)	Operation performed before receiving starts. *    NONE - No operation is performed before receiving starts. *    COPY - Make a copy of the target file (specified by 'receiveFrom') to a file specified by 'preReceiveLocation' before receiving starts. *    RENAME - Move the target file (specified by 'receiveFrom') to a file specified by 'preReceiveLocation' before receiving starts.
Pre Receive Operation Location	Destination file for operation to be performed before receiving starts.
Pre Receive Location Has Patterns	Indicate if 'preReceiveLocation' contains patterns:, where 'pattern' is a string containing special characters escaped by percentage sign, the following are all the symbols supported: i     directory/file name replacement (%p/%f), usually used in pre/post operation's 'receiveFrom'/'sendTo' path.        For example, when 'sendTo' is my_in_box/invoice.dat, then a pattern like %p_backup/%f.bak will be my_in_box_backup/invoice.dat.bak after expansion. ii     UUID %u, will be substituted by a UUID value compliant with Java 1.5 UUID. iii    sequence number reference %0, %1, %2, %3, %4, %5, %6, %7, %8, %9, this symbol will be replaced by the current value of sequence number, which is an integer count that increments after each reference. For more information, see Appendix C - Java Timestamp Patterns.
Post Receive Operation (Command)	Operation performed after receiving completes: *    NONE - no operation performed after receiving completes. *    DELETE - delete the target file (specified by 'receiveFrom') after receiving completes. *    RENAME - move the target file (specified by 'receiveFrom') to a file specified by 'postReceiveLocation' after receiving completes.
Post Receive Operation Location	Destination file for operation to be performed after receiving completes.
Post Receive Location Has Patterns	Indicates if 'postReceiveLocation' contains patterns, where 'pattern' is a string containing special characters escaped by percentage sign. The symbols supported are similar to Pre Receive Location Has Patterns.
Poll Interval	Polling interval in milliseconds when data is polled from a location specified by 'receiveFrom'.

Top

Receive Request and Send Response

Send Response (Put Response) : Properties

Attribute Name	Description
Send Destination (To)	Path pointing to a file on remote FTP server, where the transferred data will be stored (sendTo), the path components could be literal or patterns, see 'sendTohasPatterns' for a detailed definition of pattern.
Send Destination (To) Has Patterns	See Pre Receive Location Has Patterns.
Pre Send Operation (Command)	Operation performed before sending starts. *    NONE - No operation performed before sending starts. *    COPY - Make a copy of the target file (specified by 'sendTo') to a file specified by 'preSendLocation' before sending starts. *    RENAME - Move the target file (specified by 'sendTo') to a file specified by 'preSendLocation' before sending starts.
Pre Send Operation Location	Destination file for operation to be performed before sending starts.
Pre Send Location Has Patterns	Indicate if 'preSendLocation' contains patterns, where 'pattern' is a string containing special characters escaped by percentage sign. The supported symbols are similar to Pre Receive Location Has Patterns
Post Send Operation (Command)	Operation performed after sending completes: *    NONE - No operation is performed after sending completes. *    DELETE - Delete the target file (specified by 'sendTo') after sending completes. *    RENAME - Move the target file (specified by 'sendTo') to a file specified by 'postSendLocation' after sending completes.
Post Send Location (Command)	Destination file for operation to be performed after sending completes.
Post Send Location Has Patterns	Indicates if 'postSendLocation' contains patterns, where 'pattern' is a string containing special characters escaped by percentage sign. The symbols supported are similar to Pre Receive Location Has Patterns.
Append Payload To Target File	Indicates if the message will be appended at the end of the target file.

Top

Next
Appendix B - Message Repository Directories

Return to Working With the FTP Binding Component

This page (revision-30) was last changed on 01-Jan-09 10:34 AM, -0800 by PRABHAMS.
This page was created on 26-Dec-08 07:23 AM, -0800 by PRABHAMS.

More info...