|
|
|
Specifies how many log files to keep. Each saved old log file name has a number (from 1 to the FILE_COUNT minus 1) suffixed to it. For example, if FILE_NAME is specified as FPLOG, and FILE_COUNT is set to 5, four log files are saved, named FPLOG1 through FPLOG4, with FPLOG4 being the earliest (or oldest) file.
|
|
|
|
|
|
Specifies whether to send the trace log messages to standard output (STDOUT) when set to true. This setting is in addition to the trace log file specified with FILE_NAME. If the adapter jobs are submitted to batch, STDOUT appears in the QPRINT printer file. If QSHELL is used to submit the adapter jobs, STDOUT appears on screen.
|
|
•
|
Trace level 2 generates level 1 messages plus all the values loaded from the config file as below:
|
•
|
Trace level 3 generates level 1 and 2 messages plus the following field-related messages:
|
•
|
Trace level 4 for detailed tracing. Usually used only at the request of TIBCO Support.
|
•
|
Trace level 5 for detailed tracing. Usually used only at the request of TIBCO Support.
|
|
|
•
|
Trace Level 6 generates level 1 through 5 messages. Usually used only at the request of TIBCO Support.
|
•
|
Trace Level 10 generates Level 1 through 6 messages. Usually used only at the request of TIBCO Support.
|
•
|
Trace Level 15 generates Level 1 through 10 messages. Usually used only at the request of TIBCO Support.
|
|
|
|
|
|
|
•
|
Used to set the heartbeat subject or destination (for EMS) to _FILEADAPTER.<adapter name>.HEARTBEAT. This is used by FilePublisher to send heartbeat messages, but does not mean that heartbeats are always published. To publish (send) heartbeats, see PUBLISH_HEARTBEAT. For terminate messages, the default destination type is QUEUE. For heartbeat messages, the default destination type is TOPIC.
|
|
|
Specifies whether to abend the adapter when it encounters an initialization error for any FileType section. If set to true, and if a configuration error is found for a file, the publisher generates a message to the log and goes on to the next file. If set to false, abend the adapter.
Valid values: true, false. The default value is false.
|
|
•
|
none—do not remove the progress file.
|
•
|
single—remove the progress file when it is a 1:1 relationship between the publisher and subscriber.
|
|
|
The valid values are true, false. The default value is false.
|
|
|
|
Valid values: 4, 8. The default value is 8.
|
|
|
|
Note: Specify this field at the end of the Options section. Since the Rendezvous transport or EMS connection is not created until the end of the Options section, any error that occurs can't be published.
|
|
If set to true, additional file type information is also published in the heartbeat message. For example, file prefix, file extension, and number of messages published are included.
Valid values: true, false. The default value is true.
|
|
The default value is 60000 milliseconds, or 60 seconds.
|
|
Specifies the translation table to use on the IBM i mainframe side. Defaults to the CCSID of the job in which the Publisher or Subscriber is running and which is usually tied to the profile of the user who initiated the job.
|
|
Default library data set to search for publishing files.
|
|
If set to true, enables a publisher to shut down when the Rendezvous daemon shuts down.
If not specified, defaults to false, which means that the publisher continues to run even if the Rendezvous daemon shuts down.
Note: This functionality is provided by default in TIBCO EMS. Whenever an exception occurs in a client connection to an EMS server, it is handled by default.
|
|
|
|
|
|
|
|
|
|
|
|
A setting to true for this element enables publishing of heartbeat messages. If not specified it defaults to false, meaning heartbeat messages are not published.
|
|
•
|
name — A unique alphanumeric name identifying the TIBCO Rendezvous session
|
•
|
service — The service group for this session
|
•
|
network — Network to initialize a TIBCO Rendezvous session
|
•
|
daemon — The name of the TIBCO Rendezvous daemon for this session
|
|
|
•
|
ledgerFile — The name of the file-based ledger for Certified Messaging. This file is created in the Integrated File System.
|
•
|
requireOldMessages — Indicates whether a persistent correspondent requires delivery of messages sent to a previous session with the same name for which delivery was not confirmed. A setting to true enables delivery of old unacknowledged messages; a setting to false does not.
|
•
|
defaultTimeLimit — Sets the default message time limit for all outbound certified messages. The time is specified in seconds and the default value is 60.
|
•
|
syncLedger — If you want to use a synchronous ledger file, set this parameter to true. The default value for this is false, meaning an asynchronous ledger file is used.
|
|
|
|
|
Specifies that the adapter abends if it cannot successfully call the tibrvsend API. This flag is only applicable to record mode processing. If the file is in block mode, the flag is ignored and the adapter is abended. Upon recovery, the adapter re-syncs to the last check point. In the case of standard block mode, the entire file is retransmitted. In ECM, retransmission begins with the last block that was successfully acknowledged. Valid values: true, false. The default value is false.
|
|
If true, major checkpoint log messages are sent to QSYSOPR *MSGQ. Each message includes date and time information. Valid values: true, false. The default value is false.
|
|
The EOL_CHARACTER is specified as a two-character literal that represents the EBCDIC hexadecimal value.
|
Use the FILE_OPTIONS element to specify the following options:
The FILE_OPTIONS element is also used to identify those files you want to be published in certified mode if you have started a certified FilePublisher session. A config file can have multiple [FILE OPTIONS] definitions in a single file. See the File PublisherExamples section for details.
|
|
|
Used to select files from the input library data set for publishing. While polling, any files with a name that starts with this file prefix are selected for publishing. This prefix can be up to 5 characters.
When set to the string NULL, and if trigger mode is used, and the full path of the file is specified, then the publisher cannot be ignore this file type. It generates the temporary file without using the file prefix.
|
|
|
|
|
|
Valid values: TOPIC, QUEUE. The default value is TOPIC.
|
|
Valid values: PERSISTENT, NON_PERSISTENT, RELIABLE_DELIVERY.
|
|
|
|
Valid values are TIBEMS_AUTO_ACKNOWLEDGE, TIBEMS_CLIENT_ACKNOWLEDGE, TIBEMS_DUPS_OK_ACKNOWLEDGE, TIBEMS_EXPLICIT_CLIENT_ACKNOWLEDGE, TIBEMS_EXPLICIT_CLIENT_DUPS_OK_ACKNOWLEDGE, TIBEMS_NO_ACKNOWLEDGE.
The default value is TIBEMS_AUTO_ACKNOWLEDGE.
|
|
|
Specifies whether a GUID-like transaction id is to be used. If the file is configured as needing one, and if no trackingId string is received as part of the trigger message, then the publisher automatically generates a GUID-like string for the trackingId. If the trackingId string comes with the trigger message, the id is forwarded to the subscriber. This information is sent after the publisher receives the final EOF message from the subscriber.
Valid values: true, false (default). If true, the following fields are attached to the message that is published on the subject specified by trackinIdSubject:
|
|
|
|
|
If set to true, FilePublisher polls for file names to publish from INPUT_LIBRARY whose names begin with the filePrefix value. A setting to false disables file polling. The default value is false.
|
|
|
|
|
|
|
|
|
|
|
For ECM, this parameter is used for an additional purpose in conjunction with retransmissionDelayTicks. In this case, the publisher checks for any pending confirmations and re-transmit any unacknowledged data messages. See retransmissionDelayTicks. Also used to set up the Admin Timeout timer for resending startup messages to the subscribers.
|
|
|
|
The durable subscribers in EMS require that endPublishSubject equal publishSubject (or endPublishDestinationName equal publishDestinationName).
Note that publishing an end-of-file indication on a different subject than publishSubject in RV might not maintain the correct sequence of messages.
|
|
Most usages of generateFileSubjectName require that it match the subscribeSubjectName.
The adapter uses the generateFileFieldName parameter as a message differentiator. A message arriving on a subject name can be checked to see whether it is a regular “Data” message, or whether it is a “Generate File” trigger.
When an incoming message has a field matching the value specified in the generateFileFieldName parameter, then the message is assumed to be a “Generate File” trigger message, and the subscriber generates the final target output file.
|
|
|
|
|
|
|
|
|
|
Use ECM mode. Valid values: true, false (default). If true, block mode is used automatically.
|
|
For the Publisher, this parameter represents the number of times the transactionDelay timer must pop before checking for any unacknowledged Message Blocks. The default value for the Publisher is ( retransmissionDelayTicks*transactionDelay) sec.
Also, this represents the number of times the transactionDelaytimer pops before the Publisher attempts to re-synchronize with the Subscriber.
|
|
Specifies how a publisher proceeds upon receiving all the acknowledgements from all the ECM subscribers. If set to true, the next transaction is processed immediately after FilePublisher receives all the confirmations. If set to false, it uses the normal transactionDelay parameter to process transactions.
Valid values: true (default), false. Set to true for ECM publishers to speed up delivery.
|
|
Warning: You cannot specify both an ECMSubscriberName and a confirmationSubject.
|
|
Warning: You cannot specify both a confirmationSubject and an ECMSubscriberName.
|
|
|
|
|
Name of the input library. The default value is the INPUT_LIBRARY specified in the Options section. This overrides the value specified in INPUT_LIBRARY.
|
|
Name of the process library for this file type. The default value is the PROCESS_LIBRARY specified in the Options section. This overrides the value specified in PROCESS_LIBRARY.
|
|
Name of the output library for this file type. The default value is the OUTPUT_LIBRARY specified in the Options section. This is used in conjunction with polling. This overrides the value specified in OUTPUT_LIBRARY.
|
|
Record length of the file being published. If lineLength is not specified, the adapter uses the catalog service to obtain the file attributes.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Applies to STRING fields. Set this parameter to true to have FilePublisher strip leading blanks from a STRING.
|
|
Applies to STRING fields. Set this parameter to true to have FilePublisher strip trailing blanks.
|
|
|
|
|
|
|
|
|
|
When set to true, specifies that the file data is in binary format. Binary data includes zoned decimal, binary, packed decimal, and floating point data types.
|
|
If the values are set to true, these parameters specify that a log file have to be created to contain a copy of all the input records which were either matched or unmatched respectively according to the constraint definitions for multi-record-format data.
|
|
Use the MESSAGE_FIELDS element of the FileType section to configure any messages that are to be published.
The MESSAGE_FIELDS element describes the format of the message to be published. It can be formed by using one or more of the following parameters.
The messageItem parameter can identify a field with a constant value, a field from a fixed-width input record, or a field from a delimited input record. In any case, it uses the following tags:
|
|
|
|
|
Valid values: STRING, INTEGER, UNSIGNED INTEGER, SHORT, UNSIGNED SHORT, FLOAT, DOUBLE, BOOLEAN, and TIME. The default value is STRING.
Valid values for EMS: STRING, INTEGER, SHORT, FLOAT, DOUBLE, BOOLEAN.
Note: When you specify TIME as the data type, FilePublisher gets the current system time and adds it to the TIBCO message. When FileSubscriber receives the message, it converts the time to a string that represents the time of the publishing system.
Specify OPAQUE to send a field untranslated. See Sending Data Untranslated (OPAQUE).
For COBOL numeric datatypes only, specify one of ZONED, BINARY, PACKED, COMP, COMP-1, COMP-2, COMP-3, or COMP-4 for numeric data. See Sending Numeric Data Types.
Note: Make sure isBinary is set to true for both OPAQUE and COBOL numeric data.
|
|
|
|
The default value is false, meaning the input numeric field is published as a FLOAT or INTEGER value depending on the type of the field. The datatypes COMP-1, COMP-2, and COMP-3 are published as FLOAT and COMP, COMP-4 as INTEGERs.
For a more accurate conversion, specify true, meaning a STRING data type is published.
|
|
LOW-VALUES -- Sets field’s value to binary zeros.
HIGH-VALUES -- Sets field’s value to binary X’FFFFFFFF’.
|
For a field from a fixed-width input record, add the following tags along with label and
type to specify the field’s position within the record and the length of the field.
You can group message items into containers to form a nested message using the messageContainer parameter. Include the following tags along with the
messageItem or other
messageContainer that you want to group together.
As an example of how to use the constraint parameter, suppose a file contains both header and detail records that must be combined into one output TIBCO Rendezvous message, but the records have different formats. You could create a TIBCO Rendezvous message as follows:
This example is for publishing a file using ECM. In Record Mode ECM, you have to specify endPublishSubject to signal the end of file publishing to FileSubscriber. The
generateFileSubjectName parameter in FileSubscriber must be the same as
endPublishSubject.
where dytsth is the name defined for the container name in the CONSTRAINT.