|
|
|
|
|
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, then there are four saved log files, named FPLOG1 through FPLOG4, with FPLOG4 being the earliest (or oldest) file.
|
|
|
|
|
|
|
|
|
Specifies whether to send the trace log messages to standard output (STDOUT) of the job in addition to the FILE_NAME specified when set to true. If set to false, trace messages are written only to a log file. 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.
|
|
|
|
−
|
TIBCO EMS/Rendezvous sessions created
|
|
•
|
Trace level 2 generates level 1 messages plus all the following values loaded from the configuration file:
|
|
•
|
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 terminate subject or destination (for EMS) to _FILEADAPTER.<adapter name>.TERMINATE. Sending a message to this subject either stops FileSubscriber or FilePublisher depending on the value of <ADAPTER_NAME>.
|
|
•
|
Used to set the heartbeat subject or destination (for EMS) to _FILEADAPTER.<adapter name>.HEARTBEAT. This is used to send heartbeat messages, but does not mean that heartbeats are published. To publish (or 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 first encounters an initialization error for any FileType section. If set to true and, if a configuration error is found for a file, generate a message to the log and go on to the next file. If set to false, abend the adapter. Valid values: true, false (default).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Specifies where the error message publish to. If this is not blank, all traceErr and FatalErr messages are copied and sent to that subject. Valid values: blank, string. The default value is blank.
|
|
|
|
|
|
The default value is 60000 milliseconds, or 60 seconds.
|
|
|
Works with the codepage support in TIBCO Rendezvous 7.1 and above or EMS 4.2 and above. 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.
|
|
|
Works with the codepage support in TIBCO Rendezvous 7.1 and above/EMS 4.2 and above. Specifies the expected codepage sent by any remote subscribers.
|
|
|
Specifies the default output library data set to be used for all files any file type. This is suffixed appropriately for the actual output data sets.
|
|
|
|
|
|
Enables publishing of heartbeat messages. Valid values: true, false (default). For EMS, heartbeat messages are sent to EMS TOPIC by default.
|
|
|
Warning: QUEUE_LIMIT only can be used in ECM or RVCM transport mode. The data might be lost if you use it in RV transport mode.
|
|
|
|
•
|
name — Unique alphanumeric name identifying the TIBCO Rendezvous session
|
|
•
|
service — Service group for this session
|
|
•
|
network — Network to initialize a TIBCO Rendezvous session
|
|
•
|
daemon — Name of the TIBCO Rendezvous daemon for this session
|
|
|
|
|
•
|
ledgerFile — 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. Setting this parameter to true enables delivery of old unacknowledged messages; setting it 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 is false, meaning an asynchronous ledger file is used.
|
|
|
|
Valid values: true, false. The default value is false.
|
|
|
If true, major checkpoint log messages are sent to QSYSOPR *MSGQ z/OS errors are written to SYSLOG. Each message includes date and time information. The format is standard IBM-style message format such as an SXFnnnnn header followed by message text. Valid values: true, false. The default value is false.
|
This section describes the parameters in the FILE_OPTIONS element. A configuration file can have multiple [FILE_OPTIONS] definitions in a single file.
|
|
|
|
|
Used to construct the name of the file that is written to the output library data set. Specify a value of up to 5 characters. Also used for deriving the names of the progress file and the work file.
|
|
|
|
|
|
|
|
Specifies that a trackingId message is to be sent by the subscriber. This message is created after the subscriber finishes writing the file and receiving the EOF acknowledgement from the publisher. Valid values: true, false (default). If true, the following additional fields are attached to the message published to trackingIdSubject:
|
|
|
|
|
|
|
|
Specifies that only sequentially organized data is allowed. Specify SEQ. Specifies the type of data set for this file type. This can be SEQ for sequential data sets, GDG for Generation Dataset Groups,PDS for partitioned datasets, or VSAM for Virtual Storage Access Method.
|
|
|
|
|
Name of the output library data set for this file type. The default value is what is specified in the OUTPUT_LIBRARYDATASET element of the Options section. This overrides the value specified in OUTPUT_LIBRARY.
Note: VSAM and GDG file types must be preallocated before subscribing to them.
|
|
|
|
|
|
Note: lineLength cannot be larger than 32764 bytes.
|
|
|
|
•
|
wrap—wrap around the rest of the record to a new line.
|
|
•
|
discard—truncate the record and do not generate an error file
|
|
•
|
error—truncate the record and rename the working file (WK-prefixed fileCWK) to the error file (ERRnn-prefixed file.ERR) at EOF (default).
|
|
|
|
Only used for sequential data sets. If true, FileSubscriber appends the system time to the filePrefix parameter when constructing the name of the file to be written. That is, the generated output data set name has the format:
|
|
|
|
|
If true (default), enables automatic output file creation based on a timer (see the next parameter, saveFileInterval). If false, output files are not generated based on a timer. This value must be explicitly turned off if not required.
If autoGenerateFile is set to false, then the saveFileInterval parameter and generateFileOnNumberOfMessages are ignored. When set to false, the file cannot be generated until an End-Of-File indication is received from the Publisher.
|
|
|
Note that the saveFileInterval and generateFileOnNumberOfMessages parameters are mutually exclusive.
|
|
|
|
|
|
|
|
|
If value of the noOfRetries parameter is greater than 0, then the value of the retryInterval parameter must be also greater than 0.
|
|
|
If true, specifies that if an output file already exists, the data received is appended to the existing file. Otherwise, FileSubscriber overwrites existing data. In the case of sequential dataset output, this option is effective only when appendDateTime is set to false.
Warning: If the subscriber is configured with appendToExistingFile="false" and if there is an I/O error in writing to the output file, then the adapter removes the output file first and then renames the work file to error file.
|
|
|
Valid values: true, false. The default value is true.There are two variations of out-of-space situations:
|
|
|
|
|
|
|
|
|
|
|
|
If this flag is set to true, the output file is named the same as the file being published. Specifically, the output file is named the same as the filename contained in the EOF message.
|
1.
|
the filePrefix must be specified.
|
|
2.
|
generateFileSubjectName must be specified and must match the endPublishSubject as specified in the Publisher's configuration file.
|
Valid values: true, false. The default value is false.
|
|
|
|
|
|
|
|
The subject name to subscribe to for generating the output file for this file type. If autoGenerateFile is set to false, then the saveFileInterval parameter and generateFileOnNumberOfMessages are ignored. When set to false, the file cannot be generated until an EOF indication is received from the Publisher.
|
|
|
Most usages of generateFileSubjectName require that it match the subscribeSubjectName.
The generateFileFieldName is used to act as a message differentiator, so that the message being sent to a Subscriber can be identified as being a “Generate File” trigger message. It is only required if the subscriber is using the generateFileSubjectName for the associated FileType.
|
|
|
Note: If you specify a certified session, then all files are published in certified mode unless you specify false for the isCertified parameter.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
If included and set to true, specifies that data fields are to be delimited and not padded.
If false, data fields are padded with characters specified by the padCharacter parameter and are fixed width.
|
|
|
If skipPadding is false, this alphanumeric character is used as the pad character.
|
|
|
Specifies which direction to pad the data field, left or right. The default value is right, which means that the pad characters are added to the right side of the field (that is, left-justified).
|
|
|
An alphanumeric character used to separate the fields in a line. This parameter is valid only if skipPadding is true. This parameter does not have a default value, which means that if this parameter is not specified, there is no separator between fields.
|
|
|
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.
|
|
|
|
|
|
|
|
The adapter writes the data to the file in blocks. The publisher determines the block size. Valid values: true, false (default).
|
|
|
|
|
|
Warning: You cannot specify both an ECMSubscriberName and a confirmationSubject.
|
|
|
|
|
|
Warning: You cannot specify both a confirmationSubject and an ECMSubscriberName.
|
|
|
For the Publisher, this parameter represents the number of times the transactionDelay timer must pop before checking for any unacknowledged Message Blocks (retransmissionDelayTicks * transactionDelay). The default value for the Publisher is 2 sec.
|
Use the FILE_LINE element in the FileType section to format the output record. If output records are in a different format, you can include multiple
FILE_LINE elements in a single FileType section. The
FILE_LINE element contains parameters that are defined using the following tags. These tags are optional unless specified otherwise.
The FILE_LINE element describes the format of the message to be published. It can be formed by using one or more of the following parameters.
The FILE_LINE element’s field parameter has the following tags.
|
|
|
|
|
|
|
|
A setting of true flags this field as being generated from a data item in the incoming TIBCO Rendezvous message. A setting of false means that this field is a constant field. The default value is false.
|
|
|
|
|
|
|
|
|
|
|
|
Data type of this field. 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.
|
|
|
|
|
|
Use this tag to override the padCharacter specified in the FILE_OPTIONS section. If required, specify an alphanumeric character.
|
|
|
Use this tag to override the padDirection specified in the FILE_OPTIONS section. If required, specify either left or right.
|
|
|
The TIBCO Rendezvous numeric data types INTEGER, UNSIGNED INTEGER, SHORT, UNSIGNED SHORT, and FLOAT can be converted to PACKED, ZONED, BINARY, or Floating Point. STRING values that are in numeric format can also be converted to PACKED, ZONED, BINARY, or Floating Point output.
|
|
|
|
FileSubscriber supports multiple line formats from different sections of a TIBCO message. To support this, you have to include multiple FILE_LINE elements in the FileType section. When multiple
FILE_LINE elements are used, a
constraint parameter must be supplied for each
FILE_LINE element to indicate when to use that definition.
The FILE_LINE element’s constraint parameter contains the following tags:
This example shows how to configure FileSubscriber to support ECM. In Record Mode ECM you have to specify endPublishSubject to signal the end of file publishing to FileSubscriber. The
generateFileSubjectName parameter in FileSubscriber have to be same as
endPublishSubject.
