TIBCO ActiveMatrix Adapter for Files for Unix/Win Configuration and Deployment

TIBCO ActiveMatrix Adapter for Files for Unix/Win Configuration and Deployment
TIBCO ActiveMatrix® Adapter for
Files for Unix/Win
Configuration and Deployment
Software Release 7.0
November 2014
Document Updated: December 2014
Two-Second Advantage®
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED
OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED
ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED
SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR
ANY OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A
LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE
AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER
LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE
SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE
LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED
IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS
AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN
AGREEMENT TO BE BOUND BY THE SAME.
This document contains confidential information that is subject to U.S. and international copyright laws and
treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO
Software Inc.
TIBCO, Two-Second Advantage, TIBCO ActiveMatrix Binding Type for Adapter, TIBCO ActiveMatrix
BusinessWorks, TIBCO ActiveMatrix Implementation Type for TIBCO Adapters, TIBCO Adapter SDK, TIBCO
Administrator, TIBCO Business Studio, TIBCO Designer, TIBCO Enterprise Message Service, TIBCO Hawk,
TIBCO Rendezvous, and TIBCO Runtime Agent are either registered trademarks or trademarks of TIBCO
Software Inc. in the United States and/or other countries.
Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform Enterprise Edition
(J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle Corporation
in the U.S. and other countries.
All other product and company names and marks mentioned in this document are the property of their
respective owners and are mentioned for identification purposes only.
THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL
OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME
TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC
OPERATING SYSTEM PLATFORM.
THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS.
CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE
INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE
IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN
THIS DOCUMENT AT ANY TIME.
THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR
INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING
BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.
Copyright © 1999-2014 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
| iii
Contents
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vii
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Changes from the Previous Release of this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
Changes in the Document Updated: December 2014 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
TIBCO ActiveMatrix Adapter for Files for Unix/Win Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
How to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
How to Access TIBCO Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
How to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
Chapter 1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Adapter Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Version Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
TIBCO Administration Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
TIBCO Administration Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
TIBCO Administrator GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Adapter Project Life Cycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Chapter 2 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Required Platform and Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Creating and Configuring the Adapter Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Creating a TIBCO Designer Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Creating an Adapter Instance and Configuring It with a Publication Service . . . . . . . . . . . . . . . . . . . . . . . . . 18
Creating an Adapter Instance and Configuring it with a Subscription Service . . . . . . . . . . . . . . . . . . . . . . . . 21
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
iv
| Contents
Deploying the Runtime Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Deploying the Runtime Adapter Using Adapter Tester . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Deploying the Runtime Adapter Using the Command Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Chapter 3 Adapter Configuration Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration Task Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Operation Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Saving a Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Testing the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
28
28
28
29
29
30
Adapter Instance Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Logging Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Startup Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Monitoring Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
31
31
32
33
34
35
Publication Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Processing Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SFT Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transport Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Encoding Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
37
37
42
46
46
47
50
53
Subscription Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Processing Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SFT Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transport Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Encoding Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
56
56
59
60
60
61
64
67
Defining Schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Defining Read Schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Defining Write Schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Chapter 4 Deploying and Starting an Adapter Using TIBCO Administrator . . . . . . . . . . . . . . . 83
Creating an EAR File in TIBCO Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Deploying the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Starting or Stopping the Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Monitoring the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Contents v
|
Chapter 5 Advanced Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89
Using the Adapter with a Revision Control System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Using Error Handling in the Record Transfer Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Using Error Handling in the Simple File Transfer Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Using Global Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Predefined Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
File Recognition Methods of Publication Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Data Validation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Base Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Container Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Syntax for Specifying User-defined Date and Time Patterns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Locales Supported for Date and Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Using Trigger Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Usage Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Using Selective Routing Over JMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Dynamically Changing Output File Names at Runtime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
File and Content Encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
File and Directory Encodings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Content Encodings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Business Event Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Simple File Transfer Status Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Load Balancing Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Delta Publishing Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Handling Big Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
CheckPoint Restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Using Log4J for Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Fault Tolerance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Chapter 6 Monitoring the Adapter Using TIBCO Hawk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .135
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Starting TIBCO Hawk Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
The Auto-discovery Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Invoking Microagent Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Standard and Class Microagents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
vi
| Contents
Custom Microagents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
activateTraceRole() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
deactivateTraceRole() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getActivityStatisticsByOperation(Operation) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getActivityStatisticsBySchema(SchemaName) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getActivityStatisticsByService(ServiceName) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getAdapterServicesInformation() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getComponents() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getConfig() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getConfigProperties(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getDocumentDelay() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getHostInformation() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getPollingInterval() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getQueueStatistics() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getRvConfig(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getStatus() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getTraceSinks() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
getVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
_onUnsolictedMsg() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
preRegisterListener() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
resetActivityStatistics(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
reviewLedger() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
setDocumentDelay() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
setPollingInterval() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
setTraceSinks() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
stopApplicationInstance(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
unRegisterListener() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
refreshExtendedLogging() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
145
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
169
170
171
172
173
174
Appendix A Trace Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Trace Message Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Status Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
General Status Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Deprecated Status Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Appendix B Adapter Properties File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Properties File Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Predefined Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Figures vii
|
Figures
Figure 1
TIBCO ActiveMatrix Adapter for Files for Unix/Win in Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Figure 2
TIBCO Designer Panels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Figure 3
Create a TIBCO Designer Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Figure 4
Define a Delimited File Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Figure 5
The Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Figure 6
Associate the ReadSchema to Publication Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Figure 7
Wire the Write Schema and the Read Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Figure 8
Define a Layout File Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Figure 9
Delimited File Record Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Figure 10
Layout File Record Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Figure 11
Using TIBCO Designer to Specify JMS Message Selector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Figure 12
Log4J Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Figure 13
Fault Tolerance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
viii
| Figures
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Tables ix
|
Tables
Table 1
TIBCO Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Table 2
General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
Table 3
Syntax Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii
Table 4
Greyed Fields in Delta Publishing Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Table 5
Predefined Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Table 6
Configuration Settings for Publication Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Table 7
Data Validation Formats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Table 8
Unsupported Variations of the Container Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Table 9
Date and Time Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Table 10
Country and Language Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Table 11
Information for the Status Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Table 12
Standard and Class Microagent Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Table 13
Performance Statistics Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Table 14
Tracing Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Table 15
Status Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Table 16
Deprecated Status Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Table 17
Predefined Properties for TIBCO ActiveMatrix Adapter for Files for Unix/Win. . . . . . . . . . . . . . . 210
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
x
| Tables
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
| xi
Preface
TIBCO ActiveMatrix Adapter for Files for Unix/Win processes data from text files
and publishes the contents to the TIBCO environment. The adapter also listens for
messages in the TIBCO environment and writes the contents to a file.
Topics
•
Changes from the Previous Release of this Guide, page xii
•
Related Documentation, page xiii
•
Typographical Conventions, page xv
•
Connecting with TIBCO Resources, page xviii
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
xii
| Changes from the Previous Release of this Guide
Changes from the Previous Release of this Guide
This section itemizes the major changes from the previous release of this guide.
Changes in the Document Updated: December 2014
IO Errors Handling for MBusinessDocument
A note has been added on how Subscription Service handles an IO error when the
data format is Business document (MBusinessDocument). For details, see Error
Handling on page 92.
Delta Publishing Mode
A new section has been added to explain the mechanism of the Delta Publishing
mode. For details, see Delta Publishing Mode on page 125.
Limitations on Handling Big Files
Limitations on how to set the adfile.pub.multithreadCount property have
been added. For details, see Handling Big Files on page 127.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Preface xiii
|
Related Documentation
This section lists documentation resources you may find useful.
TIBCO ActiveMatrix Adapter for Files for Unix/Win Documentation
The following documents form the TIBCO ActiveMatrix Adapter for Files for
Unix/Win documentation set:
•
TIBCO ActiveMatrix Adapter for Files for Unix/Win Concepts Read this manual
to gain an understanding of adapters in general, which you can apply to the
various tasks you may undertake.
•
TIBCO ActiveMatrix Adapter for Files for Unix/Win Installation Read this
manual for instructions on site preparation and installation.
•
TIBCO ActiveMatrix Adapter for Files for Unix/Win Configuration and
Deployment This manual explains how to create and configure adapter
projects. Information on deploying adapter projects is also included.
•
TIBCO ActiveMatrix Adapter for Files for Unix/Win Examples Read this manual
to work through the examples provided with the adapter.
•
TIBCO ActiveMatrix Adapter for Files for Unix/Win Release Notes Read this
document for information about new features, deprecated features, and open
and closed issues.
Other TIBCO Product Documentation
You may find it useful to read the documentation for the following TIBCO
products:
Table 1 TIBCO Products
TIBCO Product
Description
®
TIBCO ActiveMatrix Binding Type for
Adapters
This product is an ActiveMatrix binding that integrates
the TIBCO Adapters with the ActiveMatrix
environment.
TIBCO ActiveMatrix BusinessWorks™
This product provides an integration platform that
enables companies to rapidly integrate systems and
automate business processes.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
xiv
| Related Documentation
Table 1 TIBCO Products (Cont’d)
TIBCO Product
Description
TIBCO®
This product provides a class library that helps
developers to implement an adapter with minimal
effort.
Adapter SDK
TIBCO Designer™
This product provides a graphical user interface to
create TIBCO ActiveMatrix BusinessWorks process
definitions, or create or modify TIBCO Adapter
configurations.
TIBCO Administrator™
This product is designed to manage users, monitor
machines and deploy applications that use TIBCO
products.
TIBCO Enterprise Message Service™
This product sends messages from your applications in
a format that conforms to the Java Messaging Service
(JMS) specification.
TIBCO Hawk®
This product is used to monitor and manage
distributed applications and systems throughout the
enterprise.
TIBCO Rendezvous®
This product uses messages to enable distributed
application programs to communicate across a wide
variety of hardware platforms and programming
languages.
TIBCO Runtime Agent™
This product is a bundle of TIBCO software and
third-party software that is required to run many
TIBCO applications such as TIBCO ActiveMatrix
BusinessWorks, TIBCO Adapters, and so on.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Preface xv
|
Typographical Conventions
The following typographical conventions are used in this manual.
Table 2 General Typographical Conventions
Convention
Use
ENV_NAME
TIBCO products are installed into an installation environment. A product
installed into an installation environment does not access components in other
installation environments. Incompatible products and multiple instances of the
same product must be installed into different installation environments.
TIBCO_HOME
An installation environment consists of the following properties:
•
Name Identifies the installation environment. This name is referenced in
documentation as ENV_NAME. The default value is TIBCO_HOME.
•
Directory The folder into which the product is installed. This folder is
referenced in documentation as TIBCO_HOME.
TIB_ADFILES_
HOME
TIBCO ActiveMatrix Adapter for Files for Unix/Win is installed into a directory
within a TIBCO_HOME directory. This directory is referenced in documentation
as TIB_ADFILES_HOME. The default value of TIB_ADFILES_HOME depends on the
operating system. For example, on Windows systems, the default value is
C:\tibco\adapter\adfiles\ReleaseNumber.
code font
Code font identifies commands, code examples, filenames, pathnames, and
output displayed on a command line. For example:
Use MyCommand to start the foo process.
bold code
font
Bold code font is used in the following ways:
•
In procedures, to indicate what a user types. For example: Type admin.
•
In large code samples, to indicate the parts of the sample that are of
particular interest.
•
In command syntax, to indicate the default parameter for a command. For
example, if no parameter is specified, MyCommand is enabled:
MyCommand [enable | disable]
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
xvi
| Typographical Conventions
Table 2 General Typographical Conventions (Cont’d)
Convention
Use
italic font
Italic font is used in the following ways:
Key
combinations
•
To indicate a document title. For example: See TIBCO ActiveMatrix Adapter for
Files for Unix/Win User’s Guide.
•
To introduce new terms. For example: A portal page may contain several
portlets. Portlets are mini-applications that run in a portal.
•
To indicate a property in a command or code syntax that you must replace.
For example: MyCommand PathName.
Key name separated by a plus sign indicate keys pressed simultaneously. For
example: Ctrl+C.
Key names separated by a comma and space indicate keys pressed one after the
other. For example: Esc, Ctrl+Q.
The note icon indicates information that is of special interest or importance, for
example, an additional action required only in certain circumstances.
The tip icon indicates an idea that could be useful, for example, a way to apply
the information provided in the current section to achieve a specific result.
The warning icon indicates the potential for a damaging situation, for example,
data loss or corruption if certain steps are taken or not taken.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Preface xvii
|
Table 3 Syntax Typographical Conventions
Convention
Use
[ ]
An optional item in a command or code syntax.
For example:
MyCommand [optional_parameter] required_parameter
|
A logical OR that separates multiple items of which only one may be chosen.
For example, you can select only one of the following parameters:
MyCommand param1 | param2 | param3
{ }
A logical group of items in a command. Other syntax notations may appear
within each logical group.
For example, the following command requires two parameters, which can be
either the pair param1 and param2, or the pair param3 and param4.
MyCommand {param1 param2} | {param3 param4}
In the next example, the command requires two parameters. The first parameter
can be either param1 or param2 and the second can be either param3 or param4:
MyCommand {param1 | param2} {param3 | param4}
In the next example, the command can accept either two or three parameters.
The first parameter must be param1. You can optionally include param2 as the
second parameter. And the last parameter is either param3 or param4.
MyCommand param1 [param2] {param3 | param4}
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
xviii Connecting with TIBCO Resources
|
Connecting with TIBCO Resources
How to Join TIBCOmmunity
TIBCOmmunity is an online destination for TIBCO customers, partners, and
resident experts. It is a place to share and access the collective experience of the
TIBCO community. TIBCOmmunity offers forums, blogs, and access to a variety
of resources. To register, go to http://www.tibcommunity.com.
How to Access TIBCO Documentation
You can access TIBCO documentation here:
https://docs.tibco.com
How to Contact TIBCO Support
For comments or problems with this manual or the software it addresses, contact
TIBCO Support as follows:
•
For an overview of TIBCO Support, and information about getting started
with TIBCO Support, visit this site:
http://www.tibco.com/services/support
•
If you already have a valid maintenance or support contract, visit this site:
https://support.tibco.com
Entry to this site requires a user name and password. If you do not have a user
name, you can request one.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
|1
Chapter 1
Introduction
This chapter provides an introduction to TIBCO ActiveMatrix Adapter for Files
for Unix/Win.
Topics
•
Overview, page 2
•
Configuration, page 5
•
Deployment, page 10
•
Adapter Project Life Cycle, page 12
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
2
| Chapter 1
Introduction
Overview
TIBCO ActiveMatrix Adapter for Files for Unix/Win processes data from text files
and publishes the contents in real-time to the TIBCO environment. The adapter
listens for messages in the TIBCO environment and writes the contents to a file.
The adapter is compliant with the TIBCO ActiveEnterprise environment, and is
used in conjunction with adapters and products that are compliant with this
environment, such as TIBCO ActiveMatrix Adapter for Database, and TIBCO
ActiveMatrix Adapter for Siebel. A business process defined in TIBCO
ActiveMatrix BusinessWorks allows the adapters to exchange messages.
Figure 1 TIBCO ActiveMatrix Adapter for Files for Unix/Win in Operation
TIBCO ActiveMatrix
Adapter for Files for
Unix/Win Publication
Service
TIBCO ActiveEnterprisecompliant products and
adapters
File System
TIBCO ActiveEnterprise
File System
TIBCO ActiveMatrix
Adapter for Files for
Unix/Win
Subscription Service
ActiveEnterprise
compliant
Third-party Adapters
Adapter Features
The adapter provides the following features:
•
An Easy-to-use GUI for Configuring the Adapter The adapter provides its own
design-time component, namely, the adapter palette, which seamlessly
integrates with TIBCO Designer. This easy-to-use interface allows you to
configure adapter-specific features quickly. It also validates some
configurations.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Overview 3
|
•
Support for Defining Schema An important palette operation is to define
schema. Schemas capture the rules and relations that are used by the runtime
component to process the contents of a file during publication or write data
into a file during subscription. For more information, see Defining Schemas
on page 68.
•
Support for Dual Message Transport The adapter supports two popular
message transports: TIBCO Rendezvous and JMS.
•
File Recognition The adapter provides options to selectively recognize files
that need to be processed for publication. For more information, see
Recognition Method on page 40.
•
Support for Invoking External Scripts You can run external scripts on the files
that are being processed in the adapter. For more information on Publication
Service, see Processing Tab on page 42, and for more information on
Subscription Service, see Processing Tab on page 59.
•
Restart Capability The adapter provides restart capabilities when publishing
files. For more information, see CheckPoint Restart on page 128.
•
Performance Tuning The adapter provides configuration options for
performance tuning. When more Publication Services or Subscription Services
are defined in an adapter configuration, or if a Publication Service is expected
to deal with large files, options are provided to tune the configuration to
perform optimally.
•
Flow Control The adapter supports flow control so that Publication Service
caters to slower consumers. For more information, see Advanced Tab on
page 53.
•
Adapter-specific Microagent In addition to the standard microagents that are
available with any ActiveEnterprise-compliant adapter, the adapter provides
its own microagent. This microagent provides methods of getting basic
processing-related statistics, as well as methods of getting and setting some
configuration parameters at runtime. For more information, see Chapter 6 on
page 135.
•
Support for Globalization The adapter supports data containing date and time
as date and time type. It also provides support for various locales. For more
information, see Locales Supported for Date and Time on page 110.
•
Enhanced JMS Selective Routing This enables you to dynamically send files to
the selected subscribers by sending a JMS trigger message to the publisher
and specifying the JMS message selector for each subscribers. For more
information, see Using Selective Routing Over JMS on page 118.
•
ICU Regular Expression File Matching This enables you to find matching input
files using ICU Regular Expression in filenames. You can use the ICU regular
expressions in File Name.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
4
| Chapter 1
Introduction
•
Data Field Wrapped In Double Quotes Publication Service treats data fields that
are wrapped in a pair of double quotes as one single field. For more
information, see Delimited File Record Options on page 69.
•
Additional Checking When Validating A Record When validating a delimited
record, Publication Service checks the field count in addition to the constant
field value. When validating a positional record, Publication Service checks
the record length in addition to the constant field value. For more information,
see Delimited File Record Options on page 69.
•
Delta Publishing Publication Service checks the input file on a preconfigured
time interval, copies any new data to a work file in the WIP directory, and
then processes and publishes the data. For more information, see Delta
Publishing Mode on page 38.
•
Load Balancing You can run multiple instances of the same Publication
Service to process separate files in parallel. For more information, see Load
Balancing Mode on page 124.
•
Support for Handling Big Files You can handle a big file with multi-thread. For
more information, see Handling Big Files on page 127.
•
Enable Log4J log You can view Log4J log in the adapter. For more
information, see Using Log4J for Logging on page 130.
•
Fault Tolerance SDK fault tolerance features enable multiple adapter
instances to substitute for each other. For more information, see Fault
Tolerance on page 131.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Configuration 5
|
Configuration
TIBCO Designer, the design-time component, is an easy-to-use graphic user
interface. The TIBCO ActiveMatrix Adapter for Files for Unix/Win palette in
TIBCO Designer is used to create adapter instances, configure adapter services,
and save the resulting configuration in a project.
Before using TIBCO Designer, make sure you read the TIBCO Designer product
documentation. The following figure shows the TIBCO Designer interface.
Figure 2 TIBCO Designer Panels
Project panel
Design panel
Palettes panel
Configuration
panel
Project Panel
Each TIBCO Designer window contains only one project, which is represented as
the root folder on the panel.
Projects are the key organizational principle of the configuration information you
specify. A project is a collection of all configured resources. Resources are the
components of a project. For example, an adapter Publication Service is a
resource. Resources can be complex and contain other resources, much like a
folder contains other folders on your computer file system. Together, these
resources make up your integration project. The top-level (root) folder in the
project tree panel represents a project. The top-level folder is initially named
Untitled and is renamed to the name of the project when you save the project for
the first time.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
6
| Chapter 1
Introduction
Most adapter resources have context-sensitive help available for the configuration
of that resource. Right-click on the resource and click What Is This from the
pop-up menu for more information on configuring the resource.
An adapter project contains the following folders:
•
AESchemas Folder
The AESchemas folder is the default location for all TIBCO ActiveEnterprise
schema files. Each schema file contains a collection of classes, scalars,
associations, unions, and sequences.
•
Adapter Services Folder
The Adapter Services folder contains services available to the adapter. Most
adapters include the Publication, Subscription, Request-Response, and
Request-Response Invocation services.
•
Advanced Folder
The Advanced folder contains resources created by TIBCO Designer while the
adapter is being configured. For example, each time you add a service to an
adapter, a session and an endpoint are created and stored in the Advanced
folder. Other resources such as advanced logging resources are accessed
directly from the folder. Adapter developers typically do not access resources
in this folder. Most of the adapter configuration is done by changing resources
that are available from the Adapter Services folder.
Palettes Panel
Palettes is used to organize resources. You can use palettes to add resources into
your project. Palettes are available from the Palettes panel in TIBCO Designer.
Resources are visible components in a palette. To add resources to your project,
you can select resources in the Palettes panel, drag and drop them to the Design
panel.
Each adapter you install adds one or more palettes during installation. The palette
displayed depends on the resource selected in the project tree and your
preferences. In the default view, the current selection in the project tree
determines which palettes are displayed in the Palettes panel.
Design Panel
The Design panel displays the current resource selected in the project tree panel.
For resources that contain other resources, the contents of the selected resource
are shown in the Design panel. For example, if you select a folder, its contents are
displayed.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Configuration 7
|
Configuration Panel
You can specify configuration options for the selected resource in the
Configuration panel. The type and the purpose of the resource determine the
contents of the Configuration panel. There are usually one or more tabs in the
Configuration panel, so you can access various configuration options. The tabs
provide an organization to the options for the resource.
You can click the question mark icon (?) in the top right corner of the
Configuration panel for online help on the current selection.
For each tab, you must click Apply after you have specified configuration
information before you select another tab. If you do not want to add the
configuration information, click Reset before you apply any changes to return to
the previous values for each field in the tab.
Projects
A project is a collection of data, usually schema data, and configuration data that
is persistently stored. Each project is opened and saved in multi-file format, which
allows the project to be used with a version control system. It allows different
developers to collaborate on a project and merge changes as needed.
When a project is ready to be deployed, it is created or exported in the following
formats:
•
Enterprise Archive File
•
Local Repository
•
Server Repository
•
ZIP Archive
Enterprise Archive File
An Enterprise Archive file contains information about the adapter instances and
processes you want to deploy. The format is used by TIBCO Administrator. The
EAR file is imported into Administrator where you can deploy, start, and manage
the adapter instance.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
8
| Chapter 1
Introduction
Local Repository
A project exported to a local repository is saved in DAT format. Projects saved in
DAT format should only be used for development and testing. The format is used
where data is not shared by more than one adapter. It is possible to have a few
local adapters accessing a local project in read-only mode. It is, however, not
possible to have more than one local adapter accessing a local project in read and
write mode.
Data are loaded at startup for local projects, so a local project has higher memory
requirements.
Server Repository
A project exported to a server repository is managed by a TIBCO Administration
Server running in a separate process, typically elsewhere on the network. One or
more adapters communicate with a project managed by an Administration
Server. Each supports multiple projects.
An Administration Server is identified by a unique name on a network. The
server-based mode of operation is scalable and generally recommended for
production situations. Server repositories allow multiple simultaneous write
operations with locking, automatic updates of clients, and notification.
Data are loaded on demand for server-based projects.
ZIP Archive
A project exported to a ZIP archive is written to the location as a read-only ZIP
file. A project exported as a ZIP archive can be imported into TIBCO Designer.
Version Control
TIBCO Designer allows multiple developers to work on the same project and to
use file sharing (locking) or a version control system so that the same resource is
not changed by two developers at the same time. And then different users can
add resources to the project and lock the parts of the project they are working on.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Configuration 9
|
TIBCO Designer creates a file that is shared and locked for each top-level
resource, such as an adapter configuration. It does not create a file for each
resource. As a result, you can lock an adapter configuration but cannot lock
individual adapter services.
When an adapter service is configured, the adapter creates a corresponding set of
schema files. A warning is displayed when the files are created advising you to
add the files to your version control system. You must add the files to your
version control system and ensure they are checked-in; otherwise your project
will not be managed correctly by the version control system.
TIBCO Designer also creates folders for folders you create in your project. You can
lock each folder as needed.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
10
| Chapter 1
Introduction
Deployment
After an integration project is developed and tested, it is necessary to deploy the
runtime components to the machines on which they will ultimately run in a
production environment. An adapter instance can be deployed, started and
managed in TIBCO Administrator from the Administrator web browser.
Using TIBCO Administrator, you can upload the EAR, deploy the adapter on a
machine, and set runtime options before deployment. Additionally you can start
and stop the adapter using TIBCO Administrator.
TIBCO Administrator also provides built-in tools to monitor and manage the
adapter.
TIBCO Administrator provides user, resource, and application management
modules for adapters.
•
User Management
This module allows you to set permissions for adapter users. You define
authentication, users and groups, and assign access control lists to users. This
includes security for server-based projects at design-time and for deployed
applications at runtime.
•
Resource Management
This module allows you to monitor machines and all running applications in a
TIBCO administration domain. For example, alerts are created to notify an
administrator if the number of processes or disk usage exceeds a certain
number.
•
Application Management
This module allows you to upload Enterprise Archive (EAR) files, create,
configure, and deploy adapters. This console is also used to start and stop
adapters.
TIBCO Administration Domain
A TIBCO administration domain is installed only if you have also installed the
User Management module.
A TIBCO administration domain is a collection of users, machines, and components
that an administration server manages. There is only one Administration Server
for each administration domain. Components within an administration domain
can communicate with systems outside of the domain, but the domain is the
administrative boundary of your enterprise integration project.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Deployment 11
|
See the TIBCO Administrator product documentation for more information.
TIBCO Administration Server
The TIBCO Administrator Server provides a central storage and distribution
point for configuration data and schema data needed by an adapter. The server is
included in both Administrator editions.
Each administration domain has only one TIBCO Administration Server. The
TIBCO Administration Server is the machine process that handles the stored project
and requests to manage the TIBCO administration domain.
The TIBCO Administrator Server contains its own web server (Apache Tomcat)
that can be accessed via the TIBCO Administrator GUI for configuration and
monitoring information.
TIBCO Administrator GUI
You can access the TIBCO Administration Server using the web-based TIBCO
Administrator GUI. The GUI allows you to create users and assign access to
projects managed by the Administration Server. You can invoke the GUI from any
machine in a TIBCO administration domain.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
12
| Chapter 1
Introduction
Adapter Project Life Cycle
This section describes the high-level steps required to configure and deploy an
adapter. Each step is described in details in subsequent chapters. Adapter projects
are configured in TIBCO Designer.
Configuration
Task A Define an Adapter Project
When starting TIBCO Designer, you can create or select a project. A project
contains adapter configuration information, such as the service and messaging
transport to use, logging options, and other specific settings. A project is opened
and saved in multi-file format, which allows a version control system to manage
the files associated with the project.
Task B Set Global Variables
By default each project you create in TIBCO Designer includes several global
variables. Global variables provide an easy way to set defaults for use throughout
your project. Default values are predefined for some variables. You can define
additional variables and, optionally, set their values when configuring your
adapter.
When the project is deployed and the configured adapters are running, all
occurrences where the global variables are used take effect.
A global variable value set in TIBCO Designer is overridden at run-time by
redefining the value in TIBCO Administrator.
For more information, see Using Global Variables on page 97.
Task C Define Schemas
When using the Record Transfer mode, you need to define and use schemas.
For more information about defining schemas, see Defining Schemas on page 68.
Task D Configure an Adapter Service
The adapter supports Publication Service and Subscription Service.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Adapter Project Life Cycle 13
|
Deployment
Save the design to a project during development, and generate an Enterprise
archive file (EAR file) from TIBCO Designer when you deploy the project to a
machine. The EAR file contains information for deployment.
Task E Generate and Import an Enterprise Archive File
An Enterprise Archive file contains adapter instance configuration information,
which is used by a run-time adapter. An Enterprise Archive file is generated from
TIBCO Designer and imported into TIBCO Administrator.
For more information, see Creating an EAR File in TIBCO Designer.
Task F Specify Deployment Information
After importing an Enterprise Archive file, you can deploy the adapter. This
involves:
•
Assigning adapter services to the machines in the administration domain.
•
Specifying startup options for each process engine and adapter service.
For more information, see Deploying the Project.
Task G Specify Monitoring Options
Before starting the adapter, you can specify monitoring options, which include:
•
Specifying alerts or TIBCO Hawk rulebases for each machine.
•
Specifying alerts and TIBCO Hawk rulebases for an adapter service.
Setting log file properties for an adapter service instance.
Task H Start the Adapter
The adapter is started and stopped in the TIBCO Administrator GUI.
For more information, see Starting or Stopping the Adapter.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
14
| Chapter 1
Introduction
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
| 15
Chapter 2
Getting Started
This chapter describes the basic steps that are required to configure and run the
adapter by presenting an example.
Topics
•
Overview, page 16
•
Creating and Configuring the Adapter Components, page 17
•
Deploying the Runtime Adapter, page 25
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
16
| Chapter 2
Getting Started
Overview
In this example, create an adapter project first, and then create two adapter
instances. One adapter instance is configured with a Publication Service and the
other is configured with a Subscription Service. Subscription Service listens to the
messages that are published by Publication Service. The Record Transfer mode is
used in this example. The process involves the following steps:
1. Create and design a ReadSchema and associate the ReadSchema with
Publication Service.
2. Create a WriteSchema and wire it up to the ReadSchema.
3. Associate the WriteSchema with Subscription Service.
Required Platform and Software
This exercise is performed on a Windows 7 operating system, using adapters
provided with TIBCO ActiveMatrix Adapter for Files for Unix/Win. The example
uses TIBCO Rendezvous as the transport.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Creating and Configuring the Adapter Components 17
|
Creating and Configuring the Adapter Components
A typical sequence of creating an adapter project and configuring an adapter
instance and related services is described as follows:
1. Creating a TIBCO Designer Project
2. Creating an Adapter Instance and Configuring It with a Publication Service
3. Creating an Adapter Instance and Configuring it with a Subscription Service
Creating a TIBCO Designer Project
TIBCO Designer is used to create projects and configure adapter instances. You
need to create or select a project when starting TIBCO Designer.
To create a project, complete the following steps:
1. Start TIBCO Designer.
2. Click New empty project in the TIBCO Designer panel.
Figure 3 Create a TIBCO Designer Project
3. On the Save Project page, click Browse to select the location of the project, in
this example E:\MyProject, and then click OK. A project is created.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
18
| Chapter 2
Getting Started
Creating an Adapter Instance and Configuring It with a Publication Service
To create an adapter instance and configure it with a Publication Service,
complete the following steps:
1. Select the project created in the Project Explorer.
2. Drag and drop the FileAdapterConfiguration icon from the Palettes panel to
the Design panel.
3. In the Configuration tab, rename Instance Name to PubSerivceAdapter, and
then click Apply.
4. Create and design a read schema.
a. In the Project Explorer, expand the PubSerivceAdapter folder, and then
select the FileSchemas folder.
b. Drag and drop the ReadSchema icon from the Palettes panel to the Design
panel.
c. Double-click the ReadSchema icon.
d. Drag and drop the DelimitedFileRecord icon from the Palettes panel to
the Design panel.
e. Double-click the DelimitedFileRecord icon.
f.
In the Configuration tab, change the Delimited File Record name or use
the default name. In this example, change the name to Order.
g. Add attributes by clicking Add, and specify their types. In this example,
three attributes are added and their types are String, as shown in the
following figure. Click Apply. For more details, see Defining Read
Schemas.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Creating and Configuring the Adapter Components 19
|
Figure 4 Define a Delimited File Record
5. In the Project panel, expand the PubSerivceAdapter folder, and select the
AdapterServices folder.
6. Drag and drop the PublicationService icon from the Palettes panel to the
Design panel.
7. In the Configuration tab, specify the Input Directory field, in this example,
type E:\data\reader\input, the Transport Type is Rendezvous, the Transfer
mode is Record Transfer, and the Recognition Method is By File Name.
Publication Service scans the input directory for files to be processed once
every minute.
8. Specify the file name, in this example, type text.txt in the File Name field as
shown in the following figure. For details, see Configuration Tab.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
20
| Chapter 2
Getting Started
Figure 5 The Configuration Tab
9. In the Processing tab, specify the Working Directory field as
E:\data\reader\wip, select Leave as is from the Post Processing list.
10. In the Schema tab, associate the ReadSchema with Publication Service by
clicking
, click OK, and then click Apply as shown in Figure 6.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Creating and Configuring the Adapter Components 21
|
Figure 6 Associate the ReadSchema to Publication Service
11. In the Transport tab, specify the subject name in the Message Subject field as
fa. The name must be the same with the subject name that the adapter listens
to.
12. Click Apply.
Creating an Adapter Instance and Configuring it with a Subscription Service
To create an adapter instance and configure it with a Subscription Service,
complete the following steps:
1. Select the project created in the Project Explorer.
2. Drag and drop the FileAdapterConfiguration icon from the Palettes panel to
the Design panel.
3. Rename the adapter instance to SubServiceAdapter, and then click Apply.
Go to step 4 to create and define WriteSchema(Classic), or go to step 5 to
create and define WriteSchema(Manual).
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
22
| Chapter 2
Getting Started
4. Create and define WriteSchema(Classic).
To create and define WriteSchema(Classic), complete the following steps:
a. In the Project Explorer, expand the SubServiceAdapter tree, and then
select the File Schema folder.
b. Drag and drop the WriteSchema(Classic) icon from the Palettes panel to
the Design panel.
c. Wire the write schema and the read schema created in step 4 by clicking
the browser icon
as shown in Figure 7, click Save, and then click
Apply.
Figure 7 Wire the Write Schema and the Read Schema
5. Create and define
WriteSchema(Manual).
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Creating and Configuring the Adapter Components 23
|
To create and define WriteSchema(Manual), complete the following steps:
a. In the Project Explorer, expand the SubServiceAdapter tree, and then
select the File Schema folder.
b. Drag and drop the WriteSchema(Manual) icon from the Palettes panel to
the Design panel.
c. Double-click the WriteSchema(Manual) icon, drag and drop the Layout
File Record icon from the Palettes panel to the Design panel.
d. In the Configuration tab, change the Writer File Record name or use the
default name. In this example, rename it as Order.
e. Add attributes by clicking Add and specify their types. In this example,
three attributes are added and their types are String as shown in Figure 8.
Click Apply. For details, see Defining Write Schemas.
Figure 8 Define a Layout File Record
6. Go back to the project tree and select the Adapter Services folder.
7. Drag and drop Subscription Service icon from the Palettes panel to the Design
panel.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
24
| Chapter 2
Getting Started
8. Associate the WriteSchema to Subscription Service by clicking
Schema tab.
in the
9. In the Transport tab, specify the subject name as fa.
10. In the Processing tab, specify the working and output directories as
E:\data\writer\wip and E:\data\writer\output respectively. For details,
see Processing Tab on page 59.
11. In the Configuration tab, specify the file name as output.txt.
12. Click Apply.
Two operation modes are available for Publication Service and Subscription
Service. The steps required for configuring Publication Service or Subscription
Service depend on the operation mode. For details, see Operation Mode.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Deploying the Runtime Adapter 25
|
Deploying the Runtime Adapter
This section introduces how to deploy the runtime adapter using Adapter Tester
and on the command line.
Deploying the Runtime Adapter Using Adapter Tester
The adapter tester is a tool used to test runtime adapters. To deploy the two
adapter instances, complete the following steps:
1. From the Tools menu, select Show Adapter Tester.
2. Specify the working directories for the two adapter instances in the Run
Settings tab separately, as E:\temp.
3. Start the two adapter instances.
The progress of the Publication and Subscription Services is displayed in the
console.
Deploying the Runtime Adapter Using the Command Line
1. Convert the project to a .dat file.
a. From the Project menu, select Export Full Project.
b. Browse and select the location of the directory where you want to save the
.dat file on the Export Project page, for example E:\temp.
c. Specify a name for the .dat file in the Project Name field on the Export
Project page as, for example, test.
d. Click OK.
The test.dat file is generated and saved in E:\temp.
2. Create a TIBCO Runtime Agent file.
The TIBCO Runtime Agent file is a runtime configuration file with the tra suffix.
The installation program generates an adfilesagent.tra file for the TIBCO
ActiveMatrix Adapter for Files for Unix/Win. On Windows, when the TIBCO
Runtime Agent file generated by the installation program is copied and used by
the runtime adapter (with the appropriate modifications), it sets the required
environment for the adapter to run. However, on Unix, you need set the
adfilesagent_env.csh (or adfilesagent_env.sh) environment variable
before running the adapter.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
26
| Chapter 2
Getting Started
You can make a copy of the .tra file and update the related variables.
a. Navigate to the TIBCO_HOME\tibco\adapter\version_num\bin\ directory.
Make a copy of the adfilesagent.tra file, and rename it as, for example
test.tra.
b. Update the related variables.
The following variables must be provided:
tibco.repourl:
pathname of the TIBCO Designer project
tibco.configurl:
name of the adapter configuration
application.args:
properties file to pass to the application
In this example, if you want to deploy the adapter instance that is
configured with Subscription Service, update the variables as follows:
tibco.repourl E:/temp/test.dat
tibco.configurl FileAdapterConfiguration1
application.args adfilesagent -system:propFile
%TIB_ADFILES_HOME%/bin/test.tra
On Windows, when the TIBCO Runtime Agent file created by the installation
program is used as the template, it sets the environment required for the adapter
to run automatically.
On UNIX, although most of the environment variables are set by the generated
TIBCO Runtime Agent, you need to set some additional environment variables
before running the adapter.
The installation program generates the adfilesagent_env.csh (or
file in the TIB_ADFILES_HOME/bin. You need to set the
environment variables that cannot be set by the TIBCO Runtime Agent, and to
facilitate TIBCO Administrator to deploy the adapter on UNIX platforms. When
running the adapter using the command line, the TIBCO Runtime Agent file is
sourced.
adfilesagent_env.sh)
3. Deploy the adapter instance using the command line.
a. Navigate to the TIBCO_HOME\tibco\adapter\version_num\bin\ directory
on a command line.
b. Type adfilesagent.exe
--propFile
filename.tra to start the instance.
4. Repeat step 1,2, and 3 to deploy the adapter instance that is configured with
the Publication instance.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
| 27
Chapter 3
Adapter Configuration Options
This chapter explains how to create an adapter instance and add services by
configuring standard settings. All configuration tasks are performed in TIBCO
Designer, and the information is stored in a project that is used later by the
runtime adapter.
Topics
•
Overview, page 28
•
Adapter Instance Options, page 31
•
Publication Service Options, page 37
•
Subscription Service Options, page 56
•
Defining Schemas, page 68
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
28
| Chapter 3
Adapter Configuration Options
Overview
Before configuring an adapter, read the following sections.
•
Configuration Task Sequence on page 28
•
Operation Mode on page 28
•
Repository on page 29
•
Saving a Project on page 29
•
Testing the Adapter on page 30
Configuration Task Sequence
A typical sequence of creating and configuring an adapter is as follows:
1. Create a project in TIBCO Designer. Alternatively, you can work with an
existing project. See the TIBCO Designer documentation for details.
2. Drag and drop the Files Adapter Configuration icon from the Palettes panel
to the Design panel. This creates an adapter instance, and the default name is
FileAdapterConfiguration.
3. Configure the adapter instance. See Adapter Instance Options on page 31.
4. Add one or more services to the adapter instance by dragging and dropping a
service icon from the Palettes panel to the Design panel. See Publication
Service Options on page 37 and Subscription Service Options on page 56 for
details.
5. Define read and write schemas when using Record Transfer Mode. See
Defining Schemas on page 68 for details.
6. Save the project.
Operation Mode
The Record Transfer mode and the Simple File Transfer mode are available for
Publication Service and Subscription Service. The steps required for configuring
Publication Service or Subscription Service depend on the operation mode.
In the Record Transfer mode, you need to define and use schemas.
In the Simple File Transfer mode, you need to set the file transfer configuration in
the SFT tab before configuring a Publication Service or a Subscription Service,
and then define various options for file transfer. However, you do not need to
define a schema.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Overview 29
|
For details about the concept of operation mode, see TIBCO ActiveMatrix Adapter
for Files for Unix/Win Concepts.
Repository
You can use an existing repository to configure an adapter or create a new
repository. For details about repository, see Projects.
Using an Existing Repository to Configure an Adapter
1. Start TIBCO Designer, click the Administration tab, and then click Convert
DAT to Files.
The Convert DAT To File-Based Project window opens.
2. Enter the required information and click OK. TIBCO Designer converts the
DAT file to a project.
3. In the Project tab, click Open existing project. The Open Project window
opens.
4. Browse to the location you specified in step 2 and select the project. Click OK.
The repository opens.
Creating a New Repository
1. Start TIBCO Designer and click New empty project. A new repository opens.
2. Click Project > Save. The Save Project window opens.
3. Enter the appropriate information and click OK.
A new repository is created.
The runtime adapter can work with a local or remote repository. However, if you
have selected the Multi-File repository at design time, it needs to be converted
into either a local or remote repository.
Saving a Project
Configuration information for an adapter and all other parameter settings related
to the adapter are saved as a project. You can save the associated project at any
time while configuring the adapter. Each time you save a project, any information
you have configured is saved as a project.
For detailed steps and information about exporting or importing projects to
different formats, see TIBCO Designer User’s Guide.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
30
| Chapter 3
Adapter Configuration Options
Testing the Adapter
You can use the Adapter Tester to verify whether an adapter instance is
configured correctly. You can invoke the tester from the TIBCO Designer Tools
menu. For details, see TIBCO Designer Palette Reference.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Adapter Instance Options 31
|
Adapter Instance Options
The following tabs are used to define an adapter instance:
•
Configuration Tab on page 31
•
General Tab on page 32
•
Logging Tab on page 33
•
Startup Tab on page 34
•
Monitoring Tab on page 35
Configuration Tab
Instance Name
Use the default name or specify a new name.
•
An instance name must use alphanumeric characters. An underscore (_)
character can be used. The entire instance name must be less than 80
characters. Space characters cannot be used in an instance name.
•
An instance name cannot use global variables.
•
An instance name must be unique with respect to other adapter instances for
the same adapter in the project. The same instance name can be used to name
an adapter instance for a different adapter in the same project. For example,
an R/3 adapter instance named TEST and a Siebel adapter instance named
TEST can coexist in the same project.
•
Each adapter instance name must be unique within a project even if each
instance is defined in a different folder. That is, configuring same-named
adapter instances in different folders will not make their names unique.
When you create an adapter instance, the palette creates several resources for it
automatically. These resources names derive from their instance name. Changing
the adapter instance name results in an automatic regeneration of the resources
names. If you modify any resource name manually, that particular name will not
be automatically regenerated next time when you rename the adapter instance.
Description
Provide information about the adapter instance that you want to store in the
project. The field is optional.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
32
| Chapter 3
Adapter Configuration Options
Version
The version string indicates the ActiveEnterprise (AE) format in which the
adapter instance is saved. An adapter instance is saved in AE 4.0 or AE 5.0 format.
When a new adapter instance is created in TIBCO Designer 5.x, the Version field
is set to AE Version 5.1. When a 4.x adapter instance is opened in Designer 5.x,
the Version field is AE Version 4.0.
•
If a 4.x adapter instance runs against a 4.x runtime adapter, the instance must
be saved with the Version field set to AE Version 4.0.
If you are using TIBCO Designer 5.x to modify 4.x adapter instances, change
features supported by the 4.x runtime adapter only and use the validation
utility to verify the instance before deploying the project. The validation
utility scans the project and returns warnings if any 5.x features are defined
for 4.x adapter instances. Invoke the utility from the Project > Validate Project
for Deployment menu in TIBCO Designer.
•
If a 4.x adapter instance runs against a 5.x runtime adapter, the Version field is
set to AE Version 5.x.
To change versions, click Change Version.
Message Filter
Specify a transformation plug-in if you have configured a transformation plug-in
resource with the adapter. The plug-in allows you to manipulate incoming and
outgoing data before sending it on the network or handing it to the target
application. Plug-ins are written using TIBCO ActiveMatrix Adapter SDK. For
information about writing a transformation plug-in, see TIBCO ActiveMatrix
Adapter SDK Programmer’s Guide.
Show All Tabs
When you select this check box, the General tab is displayed to configure
advanced options.
General Tab
This tab displays only when the Show All Tabs check box is selected in the
Configuration tab.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Adapter Instance Options 33
|
Termination Subject or Topic
A message sent on the termination subject (if TIBCO Rendezvous is the transport)
or topic (if JMS is the transport) stops the adapter. In most cases, you are required
to use the default value.
For information about specifying subject name, see TIBCO Rendezvous Concepts.
For information about publishing on a topic, see TIBCO Enterprise Message Service
User’s Guide.
Logging Tab
Use Advanced Logging
When the Use Advanced Logging check box is cleared (the default), you can set
two standard output destinations (sinks) for trace messages and set the tracing
level for the selected roles.
When the Use Advanced Logging check box is selected, you have full control on
selecting the destinations and associating desired roles with each destination.
To create and configure the sinks, complete the following steps:
1. Click Advanced > Log Sinks in the Project panel.
2. Drag and drop the Generic log sink icon from the Palettes panel to the Design
panel.
3. From the Configuration panel, select the sink type. The following are the
available sink types:
— File You can specify the file limit, file count, and the option to append or
overwrite. By default, this is set to 30,000 bytes, 3, and append mode
respectively.
— Hawk The Hawk sink uses the hawk session to send tracing messages to
the TIBCO Hawk monitor or Display. The hawk session is created and used
by the adapter for monitoring purposes. The configuration for the Hawk
sink involves specifying MicroAgent Name. The MicroAgent Name must be
specified in the Configuration panel.
— Network Publishes tracing messages on TIBCO Rendezvous. The
configuration for the network sink involves specifying the session and the
subject on which the trace messages need to be published.
— STDIO You can write to stdout or stderr. The default is stdout.
When File and STDIO sinks are created from Generic log sink, further
configuration options are available.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
34
| Chapter 3
Adapter Configuration Options
For all sinks, the name and description fields are optional.
Log to Standard I/O
(STDIO Sink) When this check box is selected, trace messages are displayed on the
command line where the adapter is started. When this check box is cleared, trace
messages are not displayed in the window.
Log File
Specify the name of the log file (log sink) to which trace messages are written.
Global variables are used to specify the location of the log file. For more
information, see Using Global Variables on page 97.
The available roles are Info, Debug, Warning, and Error messages. The trace
message depends on the selected roles. Turning on the roles affects the
performance of the adapter. Therefore, it is recommended that you turn on the
required roles only.
Log Info/Debug/Warning/Error Messages
Trace messages of the selected level(s) are collected in the named log sink. You can
configure trace messages levels and logging location. There are three types of logs
(log sinks) that you can configure to hold trace messages, corresponding to three
levels (roles) of trace messages, Information, Warning and Error. A fourth level of
trace messages, Debug, is reserved and should not be enabled unless requested by
the TIBCO Product Support Group. This option writes a lot of information to the
log file and reduces the speed of the adapter significantly.
Startup Tab
Show Startup Banner
The startup banner displays the runtime adapter version, the infrastructure
version on which the adapter is built, and copyright information in the console
window when the adapter is started.
Metadata Search URL
This field is not used by the adapter.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Adapter Instance Options 35
|
Monitoring Tab
Many of the following fields make use of global variables. Click the Global
Variables tab in the Project panel to enter a value for a global variable.
Enable Standard MicroAgent
Allows you to turn on or off the standard TIBCO Hawk Microagent. The way to
turn it on or off is configurable. To turn the standard microagent on or off, you can
select or clear the check box, or specify true or false by clicking the
icon.
Standard MicroAgent Name
This is the name for the standard microagent to be registered with the TIBCO
Hawk system. In most cases, the default value is used. You do not need to set the
InstanceId variable because it is automatically set at runtime by the runtime
adapter.
Standard MicroAgent Timeout(ms):
The default value is 10000 milliseconds. TIBCO Hawk waits for feedback from
the standard microagent for the specified time.
Enable Class MicroAgent
Allows you to turn on or off the instance or class specific standard TIBCO Hawk
Microagent. The way to turn it on or off is configurable. To turn the class
microagent on or off, you can select or clear the check box, or specify true or
false by clicking the
icon.
Class MicroAgent Name
This is the name for the class microagent that is registered with the TIBCO Hawk
system.
Class MicroAgent Timeout(ms):
The default value is 10000 milliseconds. TIBCO Hawk waits for feedback from
the class microagent for the amount of time that you specified.
Default MicroAgent Session
Specify the name of the TIBCO Rendezvous session that is used by the standard,
class, and custom microagents.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
36
| Chapter 3
Adapter Configuration Options
The session name and the corresponding session is generated by TIBCO Designer
automatically. However, you can modify the session parameters if required.
Navigate to the Advanced > Sessions folder to modify the session parameters.
Make sure you have set the correct parameter value for the global variables that
correspond to the TIBCO Hawk configuration. If the session parameters are not
set properly, the microagents will not display in the TIBCO Hawk Display.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Publication Service Options 37
|
Publication Service Options
The following tabs can be used to define a Publication Service:
•
Configuration Tab on page 37
•
Processing Tab on page 42
•
Schema Tab on page 46
•
SFT Tab on page 46
•
Transport Tab on page 47
•
Encoding Tab on page 50
•
Advanced Tab on page 53
Configuration Tab
This tab is available for both the Record Transfer mode and the Simple File
Transfer mode.
Name
The name of Publication Service. The name is unique among all publishers in the
adapter configuration. The name only contains alphanumeric characters,
including the underscore (_) character, and has 80 characters at most. The name
cannot contain space character, or use global variables.
Description
The description of Publication Service. This field is optional.
Transport Type
Select the transport to be used by the runtime adapter, JMS or TIBCO
Rendezvous. After selecting the transport, the transport-specific configuration
fields are displayed in the Transport Tab.
When JMS is used, you can set the adfiles.JMSCompress property to ON to
enable JMS transport level compression in the adapter TRA file. For more
information, see Appendix B, Adapter Properties File, on page 207.
You can configure the transport to use a trusted store and identity resource in SSL
(Secure Sockets Layer) configurations. TIBCO Rendezvous sessions and JMS
topics have an SSL configuration field to perform SSL configuration.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
38
| Chapter 3
Adapter Configuration Options
To enable and configure SSL, you need to expand the Advanced folder in the
Project panel, and then expand the Sessions folder. Select the TIBCO Rendezvous
session or JMS topic and click Use SSL?. The SSL configuration options are
explained in the online help associated with the session.
Transfer Mode
This determines the operation for Publication Service. Select Record Transfer or
Simple File Transfer from the Transfer Mode list. For details about transfer
mode, see TIBCO ActiveMatrix Adapter for Files for Unix/Win Concepts.
Preserve Undelivered
This check box determines whether an undelivered JMS message is preserved in
the system queue.
Delta Publishing Mode
Delta Publishing mode only supports the Timer polling method. When the Delta
Publishing is enabled, Publication Service checks the input file on a preconfigured
timer interval, and copies any new data to a work file in the WIP directory, and
then processes and publishes the new data.
When this check box is selected, several fields are grayed out, as shown in Table 4.
Table 4 Greyed Fields in Delta Publishing Mode
Field/check box
Read-only?
Default
Value/Status
Tab
Life Cycle
Yes
Repeating
Configuration
Polling Method
Yes
Timer
Configuration
Recognition Method
Yes
By file name
Configuration
Pre Processing Script File
Yes
None
Processing
Pre Processing
Arguments
Yes
None
Processing
Post Processing
Yes
Leave as is
Processing
Post Processing Script
File
Yes
None
Processing
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Publication Service Options 39
|
Table 4 Greyed Fields in Delta Publishing Mode (Cont’d)
Field/check box
Read-only?
Default
Value/Status
Tab
Post Processing
Arguments
Yes
None
Processing
CheckPoint Restart
Yes
Selected
Advanced
Delta Publishing mode supports the CheckPoint Restart feature and the
Document Delay feature.
The adfiles.DeltaFlushInterval property in the TRA file can be set for Delta
Publishing mode. If you want to stop publishing a file in the Delta Publishing
Mode, you need to manually delete, or rename the file after at least one polling
interval.
Delta Publishing mode cannot be used together with Load Balancing mode.
Life Cycle
Specify if Publication Service needs to operate continuously (Repeating) or just
one time (Once-only). Once-only means starts, processes the files, and then exits.
I
If more than one service is defined for the adapter instance, the first service
cannot use the Once-only life cycle.
Polling Method
When selecting Repeating from the Life Cycle list, the polling method specifies
how Publication Service is triggered to start processing the files. Publication
Service is triggered using a timer or a message. The timer triggering method is
available for both transport types. The message triggering method depends on
the transport type.
If the transport type is Rendezvous, a TIBCO Rendezvous message is used to
trigger Publication Service. If the transport type is JMS, a JMS message sent on a
topic is used to trigger Publication Service.
Polling Interval
The amount of time in seconds until the next file scan is repeated. This is active
when selecting Timer from the Polling Method list.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
40
| Chapter 3
Adapter Configuration Options
In the Delta Publishing Mode, when the adapter detects new data in the input file
at each polling, the adapter picks the new data, moves it to the wip directory, and
then continue to process other data.
Polling Subject or Polling Destination
If the transport type is TIBCO Rendezvous, the field name is Polling Subject. If
the transport type is JMS, the field name is Polling Destination.
It is the subject or topic name on which the TIBCO Rendezvous message or the
JMS message is sent to trigger Publication Service.
In the Simple File Transfer mode, special types of messages are defined. For the
syntax and semantics of the special message, see Using Trigger Messages on
page 115.
Input Directory
Publication Service searches and processes the files in this directory, and then
publishes the files.
This directory is different from the directories specified for the Working
Directory and Completion Directory fields. Input, working, and completion
directories have an absolute path name or a relative path name. When a relative
path name is used, it is relative to the starting directory of the runtime adapter.
On Unix, the processing directories such as the input, the working, and the done
or output directories need to be specified on the same file system.
Only the input directory is scanned for files that match the criteria. It is not
recursively traversed.
Recognition Method
Specify the mechanism for finding the desired input file(s). This is done in one of
the following methods:
•
By File Name Process the file that exactly matches the value given in the File
Name field.
•
By Wildcard via ICU Regular Expressions Process the file that matches the
ICU regular expression specified in the File Name field.
•
By Prefix + Extension Process the files that match the criteria that you
defined in the File Prefix and File Extension fields.
•
By Trigger Process the files that match the criteria that you have defined in
the File Prefix, File Extension, and Trigger File Extension fields.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Publication Service Options 41
|
This allows the adapter to process the input files only after they are ready.
Without this, the adapter might process the files in the input directory before
the third-party applications creates, writes, and closes the files. The trigger file
recognition method helps to avoid this situations. Using the trigger
recognition method, the adapter processes the input files only after the trigger
files are created.
The filename or file prefix cannot contain path information.
For details about the recognition method, see File Recognition Methods of
Publication Service on page 101.
File Name
This field is enabled in the following cases:
•
When you select By file name from the Recognition Method list, the adapter
processes the file that matches the value given in this field exactly.
•
When you select By Wildcard via ICU Regular Expressions from the
Recognition Method list, ICU regular expressions can be used in the File
Name field.
The following are examples of ICU regular expressions.
— Prepare following files in the input directory: text0.txt, text1.txt,..., to
text10.txt.
If the input filename is text\d\.txt, the input files named from
text0.txt, text1.txt,..., to text9.txt are published.
— Prepare following files in input directory: A6.0.0.txt, A6.1.0.txt,
A6.2.0.txt, A6.8.0.txt, A6.0.0.log, and A6.1.0.log.
If the input filename is A6\.[01]\.0\.(txt|log), the input files named
and A6.1.0.log are published.
A6.0.0.txt, A6.1.0.txt, A6.0.0.log,
Wildcard, which is different from regular expressions, is not supported. For
example, *.txt must be specified as .*\.txt in regular expressions format.
File Prefix
This prefix is used to locate the input file in the input directory. Any file matching
the specified criteria is processed. To activate the File Prefix, select By prefix +
extension or By trigger from the Recognition Method list.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
42
| Chapter 3
Adapter Configuration Options
File Extension
To activate the File Extension, select By prefix + extension or By trigger from the
Recognition Method list.
Trigger File Extension
To activate the Trigger File Extension, select By trigger from the Recognition
Method list.
Processing Tab
This tab is available for both the Record Transfer Mode and the Simple File
Transfer mode.
Pre Processing Script File
Name of the script that needs to be executed before the input file is processed by
the adapter. This allows you to perform processing on the input file before it is
processed by the adapter. Click Browse to locate the script file.
Pre Processing Arguments
Arguments that need to be passed to the preprocessing script file. The arguments
are strings and are optional.
The command line syntax of the arguments that is passed to the script is:
Script_filename Pre Processing Arguments
For example,
script.tcl inputFile0364.txt argument1 argument2 ...
where
script.tcl
is the script filename
inputFile0364.txt
argument1
is the name of the preprocessed file
is the first argument, and is followed by other arguments.
The preprocessing script file reads the input file, renames it, makes required
modifications, and writes to the original filename.
If there are five files in the input directory, the adapter runs the script five times,
once for each file. The adapter processes the files in ascending order of file names.
The adapter sorts the files according to the number and alphabet of their names in
ascending order. It is case sensitive, and the upper case is followed by the lower
case.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Publication Service Options 43
|
For example, if the following files exist in the input directory:
1.csv
11.csv
111a.csv
22.csv
11a.csv
11b.csv
22b.csv
the adapter processes the files in the following order:
1.csv
11.csv
111a.csv
11a.csv
11b.csv
22.csv
22b.csv
During preprocessing, if the preprocessing script finds the file unsuitable for
processing, the adapter will not process the file. The adapter logs the feedbacks
from the preprocessing script.
Pre and Post Processing Scripts
Preprocessing and postprocessing scripts return a processing status message back
to the runtime adapter. The runtime adapter writes the processing status message
to the log (Info role, AEFA-000081 for preprocessing status message and
AEFA-000082 for postprocessing status message).
Additionally, the preprocessing script informs the runtime adapter to skip
processing the input file, by appending the string "Skip the input file" to the
status message. And then the runtime adapter skips the input file and proceeds to
process the next file. When the error directory is specified, the runtime adapter
moves the skipped file to the error directory.
To turn on this feature, the string %ScriptStatusFile% is specified as the last
argument in the Pre Processing Arguments or Post Processing Arguments field.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
44
| Chapter 3
Adapter Configuration Options
At run time, the adapter substitutes a valid temporary file name to this argument
automatically. The script writes the status message, if any, into this file. The
adapter reads the temporary file, and logs the status message to the registered
sinks.
When processing the unicode files, if the content is marked with BOM, for example,
the file content encoding is UTF-8, UTF-16 big endian or UTF-16 little
endian, the adapter provides a tool named UTFHelper to remove BOM from those
files, so the adapter can correctly obtain and publish the files.
For example, if the File Content Encoding is UTF-8, you can offer the following
content in the UTF.bat file:
java -jar C:\tibco\adapter\adfiles\7.0\bin\UTFHelper.jar -encoding
UTF8 -input %1
And specify the Pre Processing Script File field in the Processing tab in TIBCO
Designer as:
C:\tibco\adapter\adfiles\7.0\bin\UTF.bat
Working Directory
Publication Service uses this directory to process the files that match the criteria.
Based on the postprocessing option that is selected, the file is either copied or
moved into this directory.
If you select Leave as is from the Post Processing list, the file is copied. If you
select Delete or Move to, the file is deleted or moved.
For adapter instances, if the files processed by Publication Service are
independent of each other, Publication Service shares the Input, Working,
Completion, and Error directories. Otherwise, the values for these directories
must be unique.
Completion Directory
This is active only when you select Move to in the Post Processing list. After the
file in the working directory is processed, it is moved to this directory.
Error Directory
When the transfer mode is Simple File Transfer, this field is mandatory. When the
transfer mode is Record Transfer, this field is not mandatory. When specified, an
XML file containing the name of the input file and the error details is created in
this directory. For details about the usage and contents of this directory, see Error
Handling on page 92.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Publication Service Options 45
|
Progress Directory
This is the directory where the progress file is written to. It applies to both the
Record transfer mode and the Simple File transfer mode. When no directory is
specified in this field, a progress file is created in the directory where the adapter
is started.
Post Processing
Specify an action to apply to the file that is currently in the working directory
after Publication Service has processed the file. The available postprocessing
actions are:
•
Move to Move the file from the working directory to the completion
directory.
•
Delete Delete the file from the working directory.
•
Leave as is Delete the file from the working directory (since the file in the
working directory is a copy. The corresponding file in the input directory is
left as is).
Add TimeStamp to File Name
This is an option to append date and time to the file that is moved to the
completion directory. The format of the date and time is YYYYMMDDHHMMSSmm.
Post Processing Script File
Specify the name of the script that needs to be executed after the input file is
processed by the adapter. Click Browse to locate and load the script.
Post Processing Arguments
Arguments you want to pass to the postprocessing script. They are strings and are
optional. The sequence of arguments passed to the postprocessing script is
determined as follows:
•
If the Transfer Mode is Record Transfer, the argument sequence contains the
name of the file, the arguments specified in the postprocessing arguments,
and the status. The status succeeds if the publisher processes the file
successfully. The status fails if the publisher has problems (for example,
parsing) with processing the file.
•
If the Transfer Mode is Simple File Transfer, the argument sequence contains
the name of the file and is followed by the arguments specified in the
postprocessing arguments.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
46
| Chapter 3
Adapter Configuration Options
Schema Tab
The tab is available only for the Record Transfer Mode of the adapter.
Associate the ReadSchema(s) created for Publication Service by clicking
and
selecting the read schema from the pop-up window. Repeat this to associate more
ReadSchemas.
You can specify the option for filtering the fields in the file records. This is done by
expanding the ReadSchema tree and the subsequent file record and deselecting
the fields from the file records. A check box under the Use? column is provided
for each field for this purpose.
When the fields are filtered, it alters the wire schema.
Since TIBCO ActiveEnterprise applications use wire schema to exchange data, it
is a good practice to inform the other adapter users about the change.
SFT Tab
This tab is available only for the Simple File Transfer mode.
Transmission Buffer Size
The buffer size to use for each data message chunk. The default value is 32.
Progress File Name
This parameter is optional. When the progress filename is blank, Publication
Service does not restart from where it is suspended. When the progress filename
is specified, Publication Service continues to process from where it is suspended.
The default progress filename is:
__InstanceNameServiceName.prg
When a path name is not specified as part of the progress filename, the progress
file is created in the directory, which is specified in the Progress Directory field of
the Processing tab.
The progress filename is specified in the LATIN_1 or ASCII character set only.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Publication Service Options 47
|
File Transfer Mode
Select one of the following methods of transferring files:
•
Binary This mode is used for opaquely transferring files and is used for any
type of file where the file contents must not be altered during file transfer.
•
Text This mode is used to transfer text files. When transferring files across
platforms, the file created on the receiving platform may be altered to reflect
the platform characteristics. For example, if a text file is transferred from
Windows NT to Unix, the \r\n is replaced by \n and vice versa.
Transport Tab
This tab is available for both the Record Transfer Mode and the Simple File
Transfer mode.
Message Subject (TIBCO Rendezvous Transport Only)
By default, a service uses a message subject that is generated using the Domain
and Deployment global variables, the adapter acronym, the adapter instance
name and the service name. If you use this default subject, make sure the values
for Domain and Deployment are not empty. You can type a TIBCO Rendezvous
subject name different from the default in this field.
Reply Message Subject (TIBCO Rendezvous Transport Only)
Not used currently.
Quality of Service (TIBCO Rendezvous Transport Only)
Any of the following options can be specified:
•
Certified (Certified Message Delivery) guarantees that every certified message
reaches its intended recipient in the order that it is sent. The message can be
sent across network boundaries and, if a network fails, the service attempts to
deliver until delivery succeeds or the message's time limit expires. This is
often called guaranteed delivery. When this quality of service is selected, an
RVCM session is used.
•
Reliable (Reliable Message Delivery) ensures that each multicast or broadcast
message is received as long as the physical network and packet recipients are
working, and that the loss of a message is detected. This option can
compensate for brief network failures because it can retransmit a message on
request if the first attempt failed. This option is appropriate when message
delivery is expected but some loss is tolerated. When this quality of service is
selected, a Rendezvous session is used.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
48
| Chapter 3
Adapter Configuration Options
Wire Format
Select one of the following wire formats to send messages. Publishers and
subscribers send and receive data only when they agree on a specific wire format.
This field is only enabled in the Record Transfer mode.
In the Simple File Transfer mode, this field is read-only. By default, it is
Rendezvous Message for the Rendezvous transport type and XML Message for
the JMS transport type.
In the Record Transfer mode, you can select Rendezvous Message,
ActiveEnterprise Message, or XML Message for the Rendezvous transport type,
and you can only select XML Message for the JMS transport type.
•
Rendezvous Message Control information for validation is not sent in the
message. For TIBCO Rendezvous wire format, an RVMSG_RVMSG or
TIBRVMSG_MSG message type is always sent when this format is selected. If a
publisher sends a simple RVMSG_STRING or TIBRVMSG_STRING message, an
exception is passed to the subscriber. This option is not available for the
Record Transfer mode of the adapter. It is only available for the Simple File
Transfer mode.
•
ActiveEnterprise Message Control information for validation is sent in the
message. If no control information is included, an exception is returned to the
subscriber. ActiveEnterprise standard wire format provides class information
and packing rules for the TIBCO ActiveMatrix Adapter SDK set of data types.
This format allows ActiveEnterprise components to perform extra validation
on messages sent or received.
This option is not available for the Simple File Transfer mode. It is available
only for the Record Transfer Mode.
•
XML Message The XML Message wire format conforms to specifically
constructed and fully compliant XML Schema (XSD) based on the existing
definition of the ActiveEnterprise schema.
For details about the control information generated and sent with
ActiveEnterprise messages, see TIBCO ActiveMatrix Adapter SDK Concepts.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Publication Service Options 49
|
Destination (JMS Transport Only)
By default, a service uses a dynamic destination that is generated using the
Domain and Deployment global variables, the adapter acronym, the adapter
instance name, and the service name. If you use this default dynamic destination,
make sure the values for Domain and Deployment are not empty. You can override
the default dynamic destination by specifying the static destination in this field.
The static destination must be defined on the JMS server before it can be used by
the runtime adapter.
Connection Factory Type (JMS Transport Only)
A message is published to a topic or sent to a queue.
•
Topic A message published to a topic is broadcast to one or more subscribers.
All messages published to the topic are received by all services that have
subscribed to the topic. This messaging model is known as publish-subscribe.
•
Queue A message sent to a queue is accessed by one and only one receiver.
Each message has only one receiver though multiple receivers can connect to
the queue. The first receiver to access the queue gets the message. The other
receivers do not. This messaging model is known as point-to-point.
Delivery Mode (JMS Transport Only)
For a Publication Service, a message is marked as persistent or non persistent.
•
Persistent In general, a message marked persistent is available to a JMS client
even if the JMS server crashes.
•
Non Persistent A message marked non persistent is not be available to a JMS
client if the JMS server crashes.
Messages with the persistent delivery mode are always written to persistent
storage, except when they are published to a topic that has no durable
subscribers. When a topic has no durable subscribers, there are no subscribers
that need messages resent in the event of a server crash. Therefore, messages do
not need to be saved, and performance is improved because disk I/O is not
required.
The semantics for these fields are somewhat more complex than the explanation
given here. For more information, see TIBCO Enterprise Message Service User’s
Guide.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
50
| Chapter 3
Adapter Configuration Options
Session Reference
Each adapter instance has one or more sessions configured for it. Sessions
encapsulate stateful connections to TIBCO Rendezvous and other messaging
sources. The session object shown in this field is initially supplied by the adapter,
depending on the selected Quality of Service. You can change the session by
browsing for it in the Project panel.
Endpoint Reference
You can drag a different endpoint, browse for another endpoint resource, go to
the referenced endpoint to edit its properties, or delete the endpoint. Endpoint
reference objects are explained in TIBCO Designer Palette Reference.
Encoding Tab
This tab is available for both the Record Transfer mode and the Simple File
Transfer mode.
By default, the repository encoding is ISO-8859-1. When the file system or file
content encoding is set to any encoding other than ASCII or ISO-8859-1, the
repository encoding needs to be set to UTF-8. If the repository encoding field is
not set correctly, messages may be corrupted. For details, see File and Content
Encoding on page 121.
File System Encoding
Provides aliases for the following commonly used encoding for file and directory
names:
•
ASCII
•
ISO8859-1
•
UTF-8
•
Shift JIS (CP943)
•
Shift JIS (TIBCO)
•
EUC-JP
•
Big5
•
Other
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Publication Service Options 51
|
When selecting Other, you can enter an encoding string that is not present in the
list. For a list of encoding strings, see TIBCO ActiveMatrix Adapter for Files for
Unix/Win Concepts.
When an invalid or unsupported encoding value is specified, an error occurs at
runtime.
The default value is UTF-8, and only the default value is supported.
File System Encoding Other
This is only active when selecting Other in the File System Encoding list. Enter
an encoding string that is not present in the list. For a list of encoding strings, see
TIBCO ActiveMatrix Adapter for Files for Unix/Win Concepts.
The supported value of the File System Encoding field is UTF-8, so you cannot
enter value for this field.
File Content Encoding
Provides aliases for the following commonly used encoding for file contents:
•
ASCII
•
ISO8859-1
•
UTF16_BigEndian
•
UTF16_LittleEndian
•
UTF-8
•
Shift JIS (CP943)
•
Shift JIS (TIBCO)
•
EUC-JP
•
Big5
•
Other
If you want to transfer a file in ASCII encoding between open systems in the
Simple File Transfer mode, set the File Content Encoding to ASCII.
If you want to transfer a file in ASCII encoding between an open system and a
mainframe system in the Simple File Transfer mode, set the File Content Encoding
to ISO8859-1.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
52
| Chapter 3
Adapter Configuration Options
When selecting Other, you can enter an encoding string that is not present in the
list. For a list of encoding strings, see TIBCO ActiveMatrix Adapter for Files for
Unix/Win Concepts.
The File Content Encoding option is not available when you select Simple File
Transfer mode in the Configuration tab and select Binary from the File Transfer
Mode list in the SFT tab.
When an invalid or unsupported encoding string value is specified, the adapter
displays an error at runtime.
File Content Encoding Other
This is active only when selecting Other in the File Content Encoding list.
By default, the repository encoding is set to ISO-8859-1. When the system or file
encoding is set to any encoding other than ASCII or LATIN_1, the repository
encoding needs to be set to UTF-8. If the repository encoding is not set correctly,
messages may get corrupted. For details, see File and Content Encoding on
page 121.
End of Line
Select the method according to how the lines in the input file are separated.
•
System Use a carriage return (new line) to mark the end of a line.
•
User Defined Use custom end of line characters to mark the end of a line.
Currently, no facility is provided to distinguish custom end of line characters that
are not actual characters.
•
System and User Defined Use a combination of carriage returns and custom
characters to mark the end of a line.
User Defined EOL
It is active when the End of Line field is not System. Enter the characters to mark
the end of a line.
The End of Line and User Defined EOL fields are not available when the transfer
mode is Simple File Transfer.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Publication Service Options 53
|
Advanced Tab
This tab is only available for the Record Transfer mode.
User Exit Endpoint Reference
Select the UserExitClient (endpoint) for the callout or the user exit operation.
Using callouts or user exits is not supported by TIBCO ActiveMatrix Adapter for
Files for Unix/Win.
Document Delay
Publication Service sometimes overwhelms the underlying messaging
infrastructure by publishing messages faster than they are received. Under these
circumstances, Publication Service uses the flow control. Specify the document
delay in milliseconds, and the delay is applied when publishing a message. The
message is either Object (MInstance) or Business Document
(MBusinessDocument).
Publication Service publishes an MInstance or MBusiness Document every time a
delay timer triggers.
Grouping Factor
Specify how many objects are grouped when publishing a business document.
You can group multiple file records into one business document message.
Objects belonging to the same file are grouped together.
Data Format
Select the format of data or message that to be published. You can select Object
(MInstance) or Business document (MBusinessDocument) from the Data
Format list.
When selecting Business document, MInstances are batched before sending. For
a given size of MInstance, the number of MInstances per business document
varies to achieve the desired throughput.
The performance of Subscription Service improves when it receives an
MBusinessDocument.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
54
| Chapter 3
Adapter Configuration Options
Business Document Name
Active only when the data format is Business document
It is the name of the Business document that to be
published, and is a required attribute for the MBusinessDocument format of
messages.
(MBusinessDocument).
Input Buffer Max Size
Specifies the amount of data. Publication Service reads the data from the input file
every time it reads the file. Usually, this field uses the default value.
Synchronous Mode
Select this check box if Publication Service operates in the synchronous mode.
Clear this check box if Publication Service operates in the asynchronous mode.
Each Publication Service works on its own thread, so operation in synchronous
mode or asynchronous mode makes no difference.
Checkpoint Restart
Select this check box to enable checkpoint restart capability for Publication
Service. If the adapter crashes when processing a file, Publication Service will
continue to process the file from where it crashes upon restart. Clearing the check
box means a higher throughput is possible, but you need to restart the service
manually.
For more information, see CheckPoint Restart on page 128.
Publication Semantics
When selected, Publication Service publishes an object only if all its associations
have no errors. For example, if a ReadSchema is defined as follows:
H
D
where H and D are delimited file records (identified by a constant) with the
following fields and types:
H
field_1
field_2
String
ui4
(Header)
field_1
field_2
String
ui4
(Detail)
D
and the input.txt input filename contains:
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Publication Service Options 55
|
Header,
Detail,
10
-20
Since Detail, -20 has a validation issue, the entire object is not be published
when this option is enabled. If this option is disabled, and the object containing
only Header, 10 is published.
Therefore, if you want to publish an object only if all the associations (children)
have no issues, select the Only publish an identified object whose associations,
if defined, have no errors check box under the Publication Semantics field in the
Advanced tab of Publication Service.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
56
| Chapter 3
Adapter Configuration Options
Subscription Service Options
The following tabs are used to define a Subscription Service:
•
Configuration Tab, page 56
•
Processing Tab, page 59
•
Schema Tab, page 60
•
Advanced Tab, page 67
•
Transport Tab, page 61
•
Encoding Tab, page 64
•
Advanced Tab, page 67
Configuration Tab
This tab is available for both the Record Transfer mode and the Simple File
Transfer mode.
Name
The name of Subscription Service. The name is unique among other subscribers
assigned to this adapter configuration. The name contains only alphanumeric
characters, including the underscore (_) character, and is 80 characters long at
most. The space character cannot be used in a name, and configuration names
cannot use global variables.
Description
Optionally used to describe Subscription Service that you are configuring.
Transport Type
Select the transport to be used by the runtime adapter, JMS or TIBCO
Rendezvous. After selecting the transport, the transport-specific configuration
fields are displayed on the Transport Tab.
The transport is configured to use a trusted store and identity resource in SSL
(Secure Sockets Layer) configurations. TIBCO Rendezvous sessions and JMS
topics have an SSL configuration field to perform SSL configuration.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Subscription Service Options 57
|
To enable and configure SSL, expand the Advanced > Sessions folder in the
Project panel. Select the TIBCO Rendezvous session or JMS topic, and select the
Use SSL? check box. The SSL configuration options are explained in the online
help associated with the session.
Transfer Mode
The transfer mode determines the operation mode for Publication Service. Record
Transfer and Simple File Transfer are available options.
Wip Creation Mode
The Wip creation mode specifies the creation mode of the file in the working
directory. This option is inactive when you select the Simple File Transfer mode.
Subscription Service uses the working directory to create the file. Based on the
semantics of the Wip Creation mode options, the file is moved to the output
directory with the following options:
•
Append messages to file, Close on Timer The received messages are appended
to a file created in the working directory. The file is closed and moved to the
output directory on receiving the timer event specified in the Elapsed field.
And then a new file is created in the working directory.
•
Append messages to file, Close on rvMessage The received messages are
appended to the file created in the working directory. The file is closed and
moved to the output directory on receiving a TIBCO Rendezvous message on
the subject specified in the Closing Subscriber field. And then a new file is
created in the working directory.
•
Append messages to file, Close on jmsMessage The received messages are
appended to the file created in the working directory. The file is closed and
moved to the output directory on receiving a JMS message. And then a new
file is created in the working directory.
•
Append messages to file, Close on Business Document Lot End Close the
working file of Subscription Service when the LotEnd field is set to true and a
business document is received. And then a new file is created in the output
directory. You can use this option when transferring files. For more
information, see the transferReader and transferWriter example in TIBCO
ActiveMatrix Adapter for Files for Unix/Win Examples.
•
One message per file Each received message is written to a file and then
moved to the output directory.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
58
| Chapter 3
Adapter Configuration Options
Output Creation Mode
•
Overwrite (always create a new file) When moving a file from the working
directory to the output directory, overwrite the file.
•
Append (if same file name exits) When moving a file from the working
directory to the output directory, append the text that received from
Publication Service to the file in the output directory.
File Name
Name of the output file that needs to be created. This is active only when you
select From Configuration in the File Name Selection list.
The filename cannot contain path information.
File Name Selection
When using the Record Transfer mode, only the From Configuration option is
available. You must specify a name in the File Name field. Subscription Service
uses the name that you specify in the File Name field as the output filename.
For the Simple File Transfer mode, you can select From Configuration or From
Message. When you select From Message, Subscription Service uses the same
filename that is available in the message as the output filename.
Close file after time elapsed (minutes)
The time before the file is closed in the working directory. You can type a specific
time in this field or use a global variable. This field is active only when you select
Append messages to file, Close on timer in the Wip Creation Mode list.
Message Time Out (minutes)
It is active only if you select Append messages to file, Close on timer in the Wip
Creation Mode list. It specifies the time to wait for incoming messages. After a
message is received, the next message must be received within the timeout that
you have specified, or Subscription Service closes the work-in-progress file and
transfers it to the output directory. The default value 0 indicates no timeout.
Closing Subscriber
It is active only if you select Append messages to file, Close on rvMessage or
Append messages to file, Close on jmsMessage in the Wip Creation Mode list.
The subscriber used to receive and signify the output file is closed.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Subscription Service Options 59
|
Processing Tab
This tab is available for both the Record Transfer mode and the Simple File
Transfer mode.
Working Directory
Directory where contents for the actual output file is composed from the received
messages.
When the files generated by Subscription Services are independent of each other,
the services share the Working, Output and Error directories. Otherwise, the
directories must be unique.
On UNIX, the processing directories such as the working directory, and the done
or output directory are required to be on the same file system.
Output Directory
The directory where files in the working directory are moved to.
Error Directory
For details about the contents of this directory, see Error Handling on page 92.
Progress Directory
The directory where progress file is written to. It applies to both the Record
Transfer mode and the Simple File Transfer mode. If no directory is specified in
this field, the progress file is created in the directory where the adapter is started.
Post Processing Script File
Specifies the name of the script that needs to be executed after the file is moved to
the output directory. Click Browser to locate and load the script.
Post Processing Arguments
Passes the arguments to the postprocessing script. The sequence of arguments
contains the name of the file that is followed by the arguments specified in the
Post Processing Arguments field.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
60
| Chapter 3
Adapter Configuration Options
Options for modifying output Filename
Provides options to modify the name of the generated output file by appending a
timestamp or sequence number.
•
Append
Select any one of the following from the list:
— None Do not append anything to the filename.
— Timestamp Append a timestamp to the filename. The format is
YYYYMMDDHHMMSSmm. Selecting this option activates the Location field.
— Sequence Number Append a sequence number to the filename. Selecting
this option activates the Location and Sequence Number Width fields.
•
Location
— Prefix Append the timestamp or sequence number to the filename as a
prefix.
— Suffix Append the timestamp or sequence number to the filename as a
suffix.
The separator between the prefix and suffix is assumed to be a period (.).
•
Sequence Number Width
You can specify the width of the sequence number. For example, when you
select 4 as the width of the sequence number, the number that is appended to
the file is 0000. The sequence number begins with 0 and is incremented for
each file that is moved to the output directory. Upon reaching the maximum
value for a given width, the sequence number rolls over.
When the adapter is restarted, Subscription Service remembers the previous
sequence number and continues from there.
Schema Tab
This tab is available only for the Record Transfer mode.
Associate the WriteSchema(s) that have been created to Subscription Service by
clicking the
icon and selecting the write schema from the pop-up window.
Repeat this to associate more WriteSchemas.
SFT Tab
This tab is available only for the Simple File Transfer mode.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Subscription Service Options 61
|
File Transfer Mode
The followings are available options:
•
Binary This mode is used to transfer files, and the file contents must not be
altered during file transfer.
•
Text This mode is used to transfer text files. When transferring files across
platforms, the file created on the receiving platform is altered to reflect the
platform characteristics. For example, if a text file is transferred from
Windows NT to Unix, the \r\n is replaced by \n and vice versa.
This mode reflects the setting made for Publication Service. The subscriber is
associated with Publication Service.
Transport Tab
This tab is available for the Record Transfer mode and the Simple File Transfer
mode.
Message Subject (TIBCO Rendezvous Transport only)
By default, a service uses a message subject that is generated using the Domain
and Deployment global variables, the adapter acronym, the adapter instance
name, and the service name. If you use this default subject, make sure the values
for Domain and Deployment are not empty. You can type a different TIBCO
Rendezvous subject name rather than using the default name.
Quality of Service (TIBCO Rendezvous Transport only)
You can select one of the following options:
•
Certified Guarantees that every certified message reaches its intended
recipient in the order that it is sent. The message can be sent across network
boundaries, and if a network fails, delivery attempts continue until delivery
succeeds or until the message's time limit expires. This is often called
guaranteed delivery. When you select this quality of service, an RVCM session
is used.
•
Reliable Ensures that each multicast or broadcast message is received as long
as the physical network and packet recipients are working, and that the loss of
a message is detected. This option compensates for brief network failures
because it can retransmit a message on request if the first attempt fails. This
option is appropriate when message delivery is expected but some loss is
tolerated. When you select this quality of service, a Rendezvous session is
used.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
62
| Chapter 3
Adapter Configuration Options
•
Distributed Queue A distributed queue is a group of cooperating transport
objects, each in a separate process. To obtain load balancing among servers,
the adapter uses distributed queues for one-of-n delivery of messages to a
group of servers. Each member of a distributed queue listens for the same
subject using the TIBCO Rendezvous Distributed Queue listener objects. Even
though many members listen for each inbound message (or task), only one
member processes the message. For details on distributed queues, see TIBCO
Rendezvous Concepts.
Distributed Queue is supported only when Subscription Service uses the Record
Transfer Mode.
Wire Format
Select the expected wire format for arriving messages. Publishers and subscribers
send and receive data only when they agree on a specific wire format.
This field is only enabled in the Record Transfer mode.
In the Simple File Transfer mode, this field is read-only. By default, the value is
Rendezvous Message for the Rendezvous transport type, and XML Message for
the JMS transport type.
In the Record Transfer mode, you can select Rendezvous Message,
ActiveEnterprise Message, or XML Message for the Rendezvous transport type,
and you can only select XML Message for the JMS transport type.
•
Rendezvous Message Control information for validation is not expected in the
message. For TIBCO Rendezvous wire format, an RVMSG_RVMSG (TIBCO
Rendezvous 5.x) or TIBRVMSG_MSG (TIBCO Rendezvous 6.x) is always
expected when this format is selected. If a publisher sends an RVMSG_STRING
or TIBRVMSG_STRING message, an exception is passed to the subscriber. This
option is not available for the Record Transfer mode. It is only available for the
Simple File Transfer mode.
•
ActiveEnterprise Message Control information for validation is expected in
the message. If no control information is included, an exception is returned to
the subscriber. ActiveEnterprise standard wire format provides class
information and packing rules for the TIBCO ActiveMatrix Adapter SDK set
of data types. This format allows ActiveEnterprise components to perform
extra validation on messages sent or received. This option is not available for
the Simple File Transfer mode. It is available only for the Record Transfer
mode.
•
XML Message It is a text message which contains XML data that is validated
against an XSD. This option is available only for the Record Transfer mode.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Subscription Service Options 63
|
For details about the control information generated and sent with
ActiveEnterprise messages, see the TIBCO ActiveMatrix Adapter for SDK
documentation.
Destination (JMS Transport only)
By default, a service uses a dynamic destination that is generated using the
Domain and Deployment global variables, the adapter acronym, the adapter
instance name and the service name. If you use this default dynamic destination,
make sure the values for Domain and Deployment are not empty. You can override
the default dynamic destination by specifying the static destination in this field.
The static destination must be defined on the JMS server before it is used by the
runtime adapter.
Connection Factory Type (JMS Transport only)
A subscriber gets messages that have been published to a topic or placed in a
queue.
•
Topic A message published to a topic is broadcast to one or more subscribers.
All messages published to the topic are received by all services that have
subscribed to the topic. This messaging model is known as publish-subscribe.
•
Queue A message sent to a queue is retrieved by one and only one receiver.
Each message has only one receiver though multiple receivers can connect to
the queue. The first receiver to access the queue gets the message. The other
receivers do not. This messaging model is known as point-to-point. A
Subscription Service that receives messages from a queue is always a durable
subscriber.
Delivery Mode (JMS Transport only)
An adapter Subscription Service is durable or nondurable.
•
Durable A durable service is registered with the JMS server. Messages sent to
a durable service are held by the JMS server until they are received by the
service. If Subscription Service crashes, messages will be received when the
service resumes.
•
Non Durable Messages sent to a nondurable service are not held by the JMS
server. If Subscription Service crashes, messages arrived on the JMS server
will not be received when the service resumes.
The semantics for these fields are more complex than the explanation given here.
For more information, see the TIBCO Enterprise Message Service documentation.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
64
| Chapter 3
Adapter Configuration Options
Session Reference
Every adapter instance has one or more sessions configured for it. Sessions
encapsulate stateful connections to TIBCO Rendezvous and other messaging
sources. The session object shown in this field is initially supplied by the adapter,
depending on the Quality of Service selected. You can change the session by
browsing for it in the Project panel.
Endpoint Reference
You can drag a different endpoint, browse for another endpoint resource, and go
to the referenced endpoint to edit its properties or delete the endpoint. Endpoint
reference objects are explained in the TIBCO Designer Palette Reference.
Encoding Tab
This tab is available for both the Record Transfer mode and the Simple File
Transfer mode.
By default, the repository encoding is ISO-8859-1. When the file system or file
content encoding is set to any encoding other than ASCII or ISO-8859-1, the
repository encoding needs to be set to UTF-8. If the repository encoding field is
not set correctly, messages might be corrupted. See File and Content Encoding on
page 121.
File System Encoding
Provides aliases for the following commonly used encoding for file and directory
names:
•
ASCII
•
ISO8859-1
•
UTF-8
•
Shift JIS (CP943)
•
Shift JIS (TIBCO)
•
EUC-JP
•
Big5
•
Other
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Subscription Service Options 65
|
When selecting Other, you can type an encoding string that is not present in the
list. For a list of encoding strings, seeTIBCO ActiveMatrix Adapter for Files for
Unix/Win Concepts.
When an invalid or unsupported encoding value is specified, the adapter displays
an error at runtime.
The default value is UTF-8, and only the default value is supported.
File System Encoding Other
This is active only when you select Other in the File System Encoding list. Type
an encoding string that is not present in the list. For a list of encoding strings, see
TIBCO ActiveMatrix Adapter for Files for Unix/Win Concepts.
The supported value of the File System Encoding field is UTF-8, so you cannot
enter a value for this field.
File Content Encoding
The File Content Encoding option is not available if you have selected Simple
File Transfer from the Transfer Mode list (in the Configuration tab) and selected
Binary from the File Transfer Mode list (in the SFT tab).
Provides aliases for the following commonly used encoding for file contents:
•
ASCII
•
ISO8859-1
•
UTF16_BigEndian
•
UTF_LittleEndian
•
UTF-8
•
Shift JIS (CP943)
•
Shift JIS (TIBCO)
•
EUC-JP
•
Big5
•
Other
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
66
| Chapter 3
Adapter Configuration Options
When selecting Other, you can type an encoding value that is not present in the
list. This value reflects the setting that is made for Subscription Service. The
subscriber is associated with Publication Service. For a list of encoding strings, see
TIBCO ActiveMatrix Adapter for Files for Unix/Win Concepts.
When an invalid or unsupported encoding string value is specified, an error
occurs at runtime.
File Content Encoding Other
This is active only when you select Other in the File Content Encoding list.
End of Line
Specify the line separator to be used in the output file:
•
System The separator is runtime dependent. It follows the DOS convention
on Microsoft platforms or the UNIX convention on UNIX platforms.
•
DOS A carriage return and line feed.
•
UNIX A line feed.
•
Unicode Unicode Line Separator. Use only in conjunction with UTF8,
UTF16BE, or UTF16LE file encoding.
•
User Defined You can define the characters to mark the end of line. Specify the
characters in the User Defined EOL field.
The End of Line option is not available when the transfer mode is Simple File
Transfer.
User Defined EOL
It is active when you select User Defined in the End of Line list. Enter the
characters to mark the end of a line.
The End of Line and User Defined EOL fields are not available when the transfer
mode is Simple File Transfer.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Subscription Service Options 67
|
Byte Order Mark
It applies to UTF8, UTF16BE or UTF16LE file encoding. It is not selected by
default. When this check box is cleared, a byte order mark is not inserted. When
this check box is selected, a byte order mark is inserted at the beginning of an
output file.
The option is not supported in Java.
Advanced Tab
This tab is available only for the Record Transfer mode.
User Exit Endpoint Reference
Select UserExitClient (endpoint) that needs to be used to perform the callout or
the user exit operation. Using callouts or user exits is not supported by TIBCO
ActiveMatrix Adapter for Files for Unix/Win.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
68
| Chapter 3
Adapter Configuration Options
Defining Schemas
Defining schemas is relevant when the adapter operates in the Record Transfer
mode. This section discusses the mechanics of creating read schemas and write
schemas.
Defining or generating the read schema or write schema is done at the instance
level. Therefore, the defined read schemas are shared across Publication Services
of that instance, and the generated or created write schemas are shared across
Subscription Services of that instance.
In the Record Transfer mode, each input data record must not exceed 256KB in
size.
Defining Read Schemas
In the project tree panel, click the File Schemas folder. In the Palettes panel, select
and drag a Read Schema to the Design panel. Optionally, you can specify a new
name for the schema and provide a description. Select the Show Base Records
Folder check box if you create a file record that contains a Record data type for
Container records. For information on Container Records and Base Records, see
TIBCO ActiveMatrix Adapter for Files for Unix/Win Concepts.
For a read schema, you can create file records and define relations among them.
The read schema can contain a combination of delimited file records or positional
file records.
Defining Relations
After creating the first file record for the read schema, defining additional records
for the read schema forms a relation automatically. The relationship depends on
how you create the file records. The first file record created in the read schema is
referred to as the root record. A read schema has only one root record. All the
other records created after the first file record are referred to as child records.
A root record has one or more child records, and each child record can further
have child records. The child file records defined immediately in the root record
have a special attribute called Position from Header. Therefore the immediate
child records of the root record in the actual data file appear before or after the
root record.
The Position from Header attribute is only available for child records defined in
the root record.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Defining Schemas 69
|
For example, if a read schema is defined as follows:
Order
Customer
Item
If the data file contains the following records, the Position from Header attribute
for the Customer file record and the Item file record is defined as Begin.
Order
Customer
Item
Item
Order
Customer
Item
If the data file contains the following records, the Position from Header attribute
for the Customer file record and the Item file record is defined as End.
Customer
Item
Item
Order
Customer
Item
Order
The Position from Header attribute setting for the child records is either begin or
end, and it cannot be in combination. For example, you cannot set begin for the
Customer file record and end for the Item file record.
Delimited File Record Options
Figure 9 shows the layout file record options.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
70
| Chapter 3
Adapter Configuration Options
Figure 9 Delimited File Record Options
Name File record names have alphanumeric characters only and have 80
characters at most. Each name is unique within the adapter instance.
Position from Header The option is available only for records that are defined as
immediate child record of the root record. Select Begin or End based on the
structure of the actual records in the data file. See Defining Relations on page 68.
Strip Blanks Selecting this check box removes blank spaces for each field
identified for the record in data file.
Repeating Specifies whether to ignore repeated delimiters. Selecting this check
box translates any repeated delimiters between fields as only one field separator.
Clearing the check box translates the repeated delimiters as empty fields.
Delimiter Specifies the separator between fields within each line of the file for the
line processed. Space, Tab or Other are available options. If you select Other, the
Delimiter Other field becomes active.
Delimiter Other Active only when Other is assigned to the Delimiter field. You
can specify the delimiter using single or multiple characters.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Defining Schemas 71
|
To distinguish delimiter characters from actual field values, you can enclose data
fields including the delimiter characters in double quotes and set the
adfiles.quotedField property to ON in the your_runtime.tra file.
For example, the comma-delimited record John, "3301 Hillview
is regarded as two fields because of the double quotes.
Ave, Palo
Alto CA"
The quoted field is supported with regular records only. Container records and
End-of-line can not be enclosed in the double quotes.
Identifier Type Specifies the method to identify a record. Field Value (constant
field value) and Record Length are available options. If the Identifier Type field
is set to Field Value, the constant attribute for one of the fields needs to be
specified when defining the fields for the records.
When the Identifier Type field is set to Field Value, you can configure
Publication Service to check the field count and the constant field value in
validating a delimited record.
For example, if a read schema defines a record to contain three String fields with
the first field containing a constant string "Order", a record, such as
"Order,ID1234,Aug20" will be accepted by Publication Service. However, a
record with a valid constant Order but contains four fields, such as
"Order,ID1234,Aug20,CA" will be rejected. The following error will be logged: "1
lines couldn't be interpreted."
To use this feature, you need to set the
adfiles.matchFieldCountAndRecordLength
property to ON in the
your_runtime.tra file.
Currently, only one constant field value can be used to identify the record.
Display Wizard When selecting this check box, a wizard text panel displays. The
wizard text panel presents the content of the file for which the record is being
created.
If you do not use this feature, you can create files for the record by clicking Add.
Attributes
Name The name of the filed that is generated automatically as field, field1, field2
and so on when clicking Add. The field names are editable.
Type The type that the actual data in the corresponding field in the file are
converted to before publication.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
72
| Chapter 3
Adapter Configuration Options
If using the dateTime type, you must specify the pattern and locale. This can be
done by right-clicking the field name and selecting Set locale and pattern. You
can select a supported locale and pattern in the list.
The record type is used to interpret a delimited record embedded within another
delimited record. Currently, delimited records that are identified by a constant
field value support this feature. When selected, a pop-up window opens and
displays the defined base records. For more information on data validation, see
Data Validation on page 103.
When using the record data type, TIBCO recommends that you define the base
records first.
Constant Active only when the Identify Type field is set to Field Value. Enter
the constant value for the appropriate field.
Sample Value The value is set to <unknown> if the Display Wizard check box is
cleared. It shows the actual value if the Display Wizard check box is selected and
the line in the file is highlighted. You can remove and shuffle the fields. If the
Display Wizard check box is selected, it is easier to create fields and specify the
names of the fields (in some cases).
To create a file record in the Wizard panel, complete the following steps:
1. Select the correct encoding of the file content.
2. Navigate to the file by clicking Browse. After identifying the desired file, click
Open. The file content is displayed in the Display Wizard window.
3. Highlight the line you want to create a file record and click Create.
This creates fields corresponding to the line using the specified delimiter as
the reference. By default, the generated fields are named as field, field1, field2,
and so on.
The Generate Names feature is used when the records in the file are actually
headers or structural representations of the actual data record. When it is
used, the actual field names specified in the structural representation is
generated and used.
Positional File Record Options
Name File record names have alphanumeric characters only and 80 characters at
most. Each name is unique within the adapter instance.
Position from Header The option is available only for records that are defined as
immediate child record of the root record. Select Begin or End based on the
structure of the actual records in the data file. For details, see Defining Relations
on page 68.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Defining Schemas 73
|
Strip Blanks Selecting this check box removes blank spaces for each field
identified for the record in data file.
Identifier Type Specifies the method to identify a record. Field Value (constant
field value) and Record Length are available options. If the Identifier Type field
is set to Field Value, you need to specify the constant attribute for one of the
fields when defining the fields for the records.
Currently, only one constant field value is used to identify the record.
In addition to checking only the constant field value in validating a record, you
can configure a Publication Service to check the record length.
For example, when a read schema defines a record to contain two string fields: the
first field contains a constant string "Order", and the second field contains the
value 5, representing the length(The record length is 10). And then a record, for
example, Order12345, will be accepted without error, while a record, for
example, Order12345678, will be rejected because the record length is 13. The
following error will be logged: "1 lines couldn’t be interpreted. "
To use this feature, you need to set the
adfiles.matchFieldCountAndRecordLength
property to ON in the
your_runtime.tra file.
Length Active only if the Identifier Type field is set to Record length.
Display Wizard Selecting the check box brings up a wizard text box, it is used to
display the contents of the file for the record being created. This allows you to
specify the start and length of each field.
If you do not use the feature, you can create fields for the record by clicking Add.
Attributes for the Fields
Name The name of the filed that is generated automatically as field, field1, field2
and so on when clicking Add. The field names are editable.
Type The type that the actual data in the corresponding field in the file are
converted to before publication.
If using the dateTime type, you must specify the pattern and locale. This can be
done by right-clicking the field name and selecting Set locale and pattern. Select a
supported locale and pattern from the list.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
74
| Chapter 3
Adapter Configuration Options
The record type is used to interpret a delimited record embedded within another
delimited record. Currently, delimited records that are identified by a constant
field value support this feature. When this is selected, a pop-up window displays
the defined base records. For more information on data validation, see Data
Validation on page 103.
The parser that matches the pattern specified with the actual date and time is not
a strict parser. Even if the pattern and the actual date and time do not match, no
error is prompted.
To ensure that the pattern is correct, it is recommended that the date and time
published be verified with the actual date and time in the data file.
Start The starting position for the field in the record.
Length The length of the field.
Constant Active only if the Identifier Type field is set to Field
constant value for the appropriate field.
Value.
Enter the
Sample Value The value is set to <unknown> if the Display Wizard check box is
cleared. It shows the actual value if the Display Wizard check box is selected and
the line in the file is highlighted. You can remove and shuffle the fields.
If the Display Wizard check box is selected, it is easier to create the fields and
specify the names of the fields (in some cases).
To create a file record in the Wizard panel, complete the following steps:
1. Select the correct encoding of the file content.
2. Navigate to the file by clicking Browse. After identifying the desired file, click
Open. The file is displayed in the Wizard panel.
3. Highlight the line you want to create a file record. It shows the line in the
Sample Line box.
4. Click Add to add a field.
5. Select the text in the sample line. This sets the start and the length for the
fields.
6. Repeat step 5 and 6 to create other fields.
After creating all the fields for the record, if the Identifier Type field is set to
Record length, you can click Update length to update the Length configuration
parameter.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Defining Schemas 75
|
Defining Write Schemas
There are two types of write schemas since 6.2.0 release: WriteSchema(Classic)
and WriteSchema(Manual). This section describes how to define the two types of
write schemas:
•
Defining WriteSchema(Classic)
•
Defining WriteSchema(Manual)
•
Defining Relations
•
Layout File Record Options
•
Editing the File Record
Copying and pasting write schemas is not supported.
Defining WriteSchema(Classic)
To define WriteSchema(Classic), complete the following steps:
1. Add WriteSchema(Classic) to a Subscription Service.
a. In the project tree panel, click the File Schemas folder.
b. In the Palettes panel, select and drag the WriteSchema(Classic) icon to the
design palette.
c. Optionally specify a new name for the write schema and click Apply.
2. Wire WriteSchema(Classic) to an existing schema.
a. In the Configuration tab, click the
opens.
icon. The Select a Resource window
b. Select the wire schema or the canonical schema from which
WriteSchema(Classic) will be generated. Click OK to generate the write
schema.
The read schema defined by the adapter creates the wire schema or the
canonical schema in the AESchmeas/ae/FileAdapter/wire/adapter
configuration_name folder.
c. Click Apply.
3. Optionally provide a description about the write schema.
4. The Write Schema Type field is displayed with read-only value Classic.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
76
| Chapter 3
Adapter Configuration Options
5. Optionally edit the configuration options of the generated write schema. For
more information, see Layout File Record Options.
•
WriteSchema(Classic)
cannot be created from a wire schema that is created
by a Publication Service in the same adapter instance.
•
A WriteSchema(Classic) can only have one root record.
•
A root record has one or more child records, and each child record has one or
more child records.
Defining WriteSchema(Manual)
To define WriteSchema(Manual), complete the following steps:
1. Add WriteSchema(Manual) to a Subscription Service.
a. In the project tree panel, click the File Schemas folder.
b. In the Palettes panel, select and drag the WriteSchema(Manual) icon to
the design palette.
c. Optionally specify a new name for the write schema, and add a
description about the write schema.
d. The Write Schema Type field is displayed with read-only value Manual.
e. Click Apply.
2. Create a root file record of the write schema.
a. Double-click the WriteSchema(Manual) icon in the design palette.
b. In the Palettes panel, select and drag the Layout File Record icon to the
design palette.
c. Specify the configuration options (see Layout File Record Options), and
click Apply.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Defining Schemas 77
|
3. Create the child file record(s) of the root file record.
a. In the design palette, double-click the root file record icon.
b. In the Palettes panel, select and drag the Layout File Record icon to the
design palette.
c. Specify the configuration options (see Layout File Record Options), and
click Apply.
d. Repeat step a, b, and c to create more child file records for the root file
record.
•
The WriteSchema(Manual) has only one root record.
•
The root record can have any number of child records and each child record
can have any number of child records.
Defining Relations
To view the write schema, navigate to the Project panel and expand the write
schema. This shows the file records and the corresponding relations as it was
defined in the wire schema or the canonical schema, or WriteSchema(Manual).
The first file record generated or created for the write schema is referred to as root
record. All the other records created after the first file record are referred to as
child records of the root record.
A root record can have many child records, and each child record can have many
child records. The child file records that are defined immediately for the root
record have a special field called Position from Header. This field allows the
immediate child records of the root record in the actual data file to be generated
before or after the root record.
The Position from Header field is only available for child records that are defined
in the root record.
If a write schema is defined as follows:
Order
Customer
Item
When the Position from Header field for the Customer file record and Item file
record is specified as Begin, the contents of the generated data file appears as
follows:
Order
Customer
Item
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
78
| Chapter 3
Adapter Configuration Options
Item
Order
Customer
Item
When the Position from Header field for the Customer file record and Item file
record is specified as End, the contents of the generated data file appears as
follows:
Customer
Item
Item
Order
Customer
Item
Order
The Position from Header field setting for the child records is either Begin or
End, and it cannot be in combination. For example, you cannot set Begin for the
Customer file record and End for the Item file record.
Layout File Record Options
Figure 10 shows the layout file record options.
Figure 10 Layout File Record Options
UI Display Name Displays the name of the file record as given in the wire schema
by default.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Defining Schemas 79
|
Name Displays the name of the file record as given in the wire schema by default.
You can modify it when necessary. File record names have alphanumeric
characters only and 80 characters at most. Each name is unique within the
adapter.
Position from Header The option is available only for records that are defined as
immediate child records of the root record. Select Begin or End based on the
structure of the output file.
Wire Schema Path Wire schema that is used to create this write schema.
Parse Specifies whether the generated output line uses a delimiter to separate
fields or uses absolute line positions. The following are available options:
— Delimited Select the options specified in the Delimiter configuration
item to separate fields within each generated output line.
— Positional Use the line position to separate fields. That is, each field begins
at a fixed position (offset from the start of the line).
Delimiter Specifies the separator between fields within each line of the file for the
line processed. Options include Space, Tab, or Other. If you select Other, the
Delimiter Other field becomes available.
Delimiter Other Active only if the Delimiter field is set to Other. Specify the
delimiter character(s) to be used.
Attributes
Name Attribute name of the object from the incoming message. The value of this
field is assigned automatically when generating the WireSchema for
WriteSchema(Classic).
Type Data type of the attribute. The value of this field is assigned automatically
when generating the WireSchema for WriteSchema(Classic).
When using the dateTime type, you must specify the pattern and locale.
Right-click the field name and select Set locale and pattern, and then you can
select a supported locale and pattern in the list.
The record type is not seen for WriteSchema(Classic) after generating the write
schema from the wire schema. However, you can promote a child record by rightclicking the child record and clicking Promote. The promoted child record is an
attribute of its parent and the type is Record. You can demote a child record by
right-clicking the child record in the Attributes table and selecting Demote.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
80
| Chapter 3
Adapter Configuration Options
Width Number of characters used to represent the field. Zero (0) signifies that the
field should not be included in the output line. Negative one (-1) signifies that as
many characters as needed (without padding) should be used (this is the default
value for lines that use delimiters. Lines using the Positional method cannot
specify -1).
Alignment Specifies whether the data should be aligned to the left or the right.
Padding The character added to this field pads the field to the specified width.
Sign For numeric fields only, used to prepend the positive sign before positive
numbers in the output. Set it to True if the sign is used in the output. Otherwise,
set it to False.
Precision Specifies the number of digits after the decimal place. For example,
with a precision of 3, the number 3.14159 is displayed in the following ways:
Scientific notation: 3.142e+1
Nonscientific notation: 3.142
A value of -1 indicates that the entire precision provided by the operating system
is used.
Sc. Notation For real numbers only, used to determine whether scientific notation
is used for the output of this field. To use the scientific notation, set to True.
Upper Case Valid only when the Sc. Notation is set to True. When this field is set
to True, the E in the scientific notation is in uppercase. When this field is set to
False, the E in the scientific notation is in lowercase.
Editing the File Record
You can change the fields of the attributes or change the number of the attributes
when needed.
To edit an attribute, click the attribute.
To add an attribute, click Add.
To remove a field, click Remove, and to shuffle fields, use the Up and Down
buttons.
If you need to make significant changes to WriteSchema(Classic), it is highly
recommended to regenerate the write schema rather than edit it.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Defining Schemas 81
|
Modifying the Relationship of File Records in a Write Schema
The write schema reflects the relationship of the file records. The relationship in
the write schema determines the sequence of lines that are generated in the
output file. For example,
WriteSchema
FileRecord_Parent
FileRecord_Child_1
FileRecord_Child_2
...
...
The sequence of lines in the output file is:
FileRecord_Parent
FileRecord_Child_1
FileRecord_Child_1
...
FileRecord_Child_2
...
...
You can rearrange the order of the child records of a write schema. Right-click the
child record you want to change, select Move Up or Move Down in the pop-up
menu to change the order.
When you change the order of the child records of a write schema, the runtime
writes the child records to a file in the exact same order as you have configured
for the write schema at design time.
•
•
When you rearrange the order of the child records in TIBCO Designer and set
the adfiles.toggleChildRecordsOrdering property in the TRA file, the
property setting has no effect.
You can run projects that are created in earlier versions of 6.2.0 with the
property enabled in this release.
adfiles.toggleChildRecordsOrdering
In some situations, the child records need to be written as part of the parent
record. This can be achieved by promoting a child record. A promoted child
becomes a field of type record in the parent.
Conversely, a promoted child record can be demoted.
Promoting and Demoting a Child Record
To promote a child record, right-click the child record and select Promote. A
promoted child record is displayed as an attribute of its parent. The Type of the
promoted child is Record.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
82
| Chapter 3
Adapter Configuration Options
To demote a child record, identify and select the attribute in the parent record
which needs to be demoted. Right-click the attribute and select Demote. The
attribute is removed from the parent record and appends to the end of the child
records.
Restrictions on Promoting Child Records
•
A child record can only be promoted to its immediate parent. For example,
FileRecord_Parent
FileRecord_Child_1
FileRecord_Child_2
FileRecord_Child_2
can only be promoted to FileRecord_Child_1 as
follows:
FileRecord_Parent
FileRecord_Child_1 [FileRecord_Child_2]
FileRecord_Child_2
cannot be promoted to FileRecord_Parent like this:
FileRecord_Parent [FileRecord_Child_2]
FileRecord_Child_1
•
Only a leaf child record can be promoted. For example,
FileRecord_Parent
FileRecord_Child_1 [FileRecord_Child_2]
However, you can do the following:
FileRecord_Parent FileRecord_Child_1 [FileRecord_Child_2]
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
| 83
Chapter 4
Deploying and Starting an Adapter Using
TIBCO Administrator
This chapter provides an overview about deploying, starting, stopping, and
monitoring adapter services using the TIBCO Administrator.
Topics
•
Creating an EAR File in TIBCO Designer, page 84
•
Deploying the Project, page 85
•
Starting or Stopping the Adapter, page 86
•
Monitoring the Adapter, page 87
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
84
| Chapter 4
Deploying and Starting an Adapter Using TIBCO Administrator
Creating an EAR File in TIBCO Designer
Generate an Enterprise Archive file (EAR) that contains information on what you
want to deploy. The information includes adapter services, TIBCO ActiveMatrix
BusinessWorks process engines, or both.
After generating an EAR file, you can deploy it in TIBCO Administrator. If you
make changes to the business processes or adapter services, you need to
regenerate the EAR file. Saving the project does not affect the EAR file.
To generate an EAR file in TIBCO Designer, complete the following steps:
1. Configure the adapter services.
2. In the Project panel, select the project.
3. Drag the Enterprise Archive resource from the Palettes panel to the Design
panel.
4. Double-click the Enterprise Archive resource you have created.
5. Drag the Process Archive resource from the Palettes panel to the Design
panel. If there are any processes in your project, configure them using the
Browse Resources button.
6. If there are any configured adapter services in your project, an Adapter
Archive resource becomes available in the Palettes panel. Drag the Adapter
Archive resource to the Design panel and specify information in the
Configuration tab, and then click Apply.
7. Go to the Enterprise Archive resource, and click Build Archive in the
Configuration tab to create the EAR file.
See Also
For more information about this procedure, see the TIBCO Designer
documentation.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Deploying the Project 85
|
Deploying the Project
Before deploying a project, the machine on which the adapter is installed must be
part of a TIBCO Administration domain. After you have installed the TIBCO
Administration Server, any machine on which you install TIBCO Runtime Agent
(required by an adapter) is automatically added to the TIBCO Administration
domain. And then the TIBCO software installed on the machine is visible and
accessible via the TIBCO Administrator GUI.
When you deploy a project, startup scripts and other information about different
components are sent to the machines to which the components were assigned.
The project data store and TIBCO Administration Server are updated with the
deployed components.
To deploy a project, complete the following steps:
1. Start TIBCO Administrator Enterprise Edition and import an EAR file.
2. Assign adapter archives to adapters installed in the administration domain,
and assign process archives to process engines.
3. Specify startup options for each adapter service.
See Also
For an introduction to the TIBCO administration domain and detailed
information about the above steps, see the TIBCO Administrator documentation.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
86
| Chapter 4
Deploying and Starting an Adapter Using TIBCO Administrator
Starting or Stopping the Adapter
You can start and stop deployed applications using the TIBCO Administrator
Application Management module.
To start an adapter service from the module, complete the following steps:
1. In the Administrator GUI panel, expand Application Management >
Application-Name > Service Instances.
2. In the Service Instances panel, select the check box next to the adapter service.
3. Click Start Selected.
The status changes from Stopped to Starting
Up
to running.
4. To stop the adapter service, select it and click Stop Selected.
The adapter does not start if it is deployed in a cluster and it is configured to
access a file in a mapped drive. If the mapped drive is changed to a local drive or
a cluster shared drive, the adapter starts successfully.
See Also
See the TIBCO Administrator documentation.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Monitoring the Adapter 87
|
Monitoring the Adapter
TIBCO Administrator offers a number of monitoring options.
•
Specify alerts and TIBCO Hawk rulebases for each machine in the domain.
•
Specify alerts and Hawk rulebases for each adapter service.
•
View the log for each adapter service.
See Also
For information about configuring the monitoring options, see the TIBCO
Administrator documentation.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
88
| Chapter 4
Deploying and Starting an Adapter Using TIBCO Administrator
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
| 89
Chapter 5
Advanced Topics
Topics
•
Using the Adapter with a Revision Control System, page 90
•
Error Handling, page 92
•
Using Global Variables, page 97
•
File Recognition Methods of Publication Service, page 101
•
Data Validation, page 103
•
Syntax for Specifying User-defined Date and Time Patterns, page 108
•
Locales Supported for Date and Time, page 110
•
Using Trigger Messages, page 115
•
Using Selective Routing Over JMS, page 118
•
Dynamically Changing Output File Names at Runtime, page 120
•
File and Content Encoding, page 121
•
Business Event Messages, page 122
•
Simple File Transfer Status Message, page 123
•
Load Balancing Mode, page 124
•
Handling Big Files, page 127
•
CheckPoint Restart, page 128
•
Using Log4J for Logging, page 130
•
Fault Tolerance, page 131
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
90
| Chapter 5
Advanced Topics
Using the Adapter with a Revision Control System
TIBCO Designer supports revision control systems such as MicroSoft Visual
SourceSafe, CVS, and Perforce. If you are using a revision control system, you
must manually add some configured resources to the revision control system and
check in the resources when completing the instance configuration.
As part of service configuration, the adapter creates schema files in
root/AESchemas/ae/FileAdapter. For example, if you configure a service in an
adapter configuration FileAdapterConfiguration, the following files are
created:
Project_root/AESchemas/ae/FileAdapter/
FileAdapterConfiguration.aeschema
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Using the Adapter with a Revision Control System 91
|
When the project is saved and a revision control system is specified, the adapter
displays a warning that additional files are created and should be added to the
revision control system. This warning is displayed only when the files are created
for the first time. The warning displays a Go To Resource button that helps in
navigating to the resource. You can click Multi-User > Add Resources to RCS to
add these files to the revision control system.
For information about how to use the Multi-User feature in TIBCO Designer, see
TIBCO Designer User Guide.
Copy, Cut, Paste, and Move Operations
To successfully copy and paste a service from adapter FileAdapterConfiguration to
FileAdapterConfiguration1, the adapter configuration and schema files for the
FileAdapterConfiguration1 must be checked out.
To successfully cut and paste a service from adapter FileAdapterConfiguration to
FileAdapterConfiguration1, the adapter configuration and schema files for both
FileAdapterConfiguration and FileAdapterConfiguration1 must be checked out.
To successfully move a service from adapter FileAdapterConfiguration to
FileAdapterConfiguration1, the adapter configuration and schema files for both
FileAdapterConfiguration and FileAdapterConfiguration1 must be checked out.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
92
| Chapter 5
Advanced Topics
Error Handling
Error Handling provides a convenient way of analyzing parsing errors. It is used
in both the Record Transfer mode and the Simple File Transfer mode.
When IO errors occur, Publication Service exits; Subscription Service does not
confirm messages and exits by default. When you set the
adfiles.io.sub.exit4issue property to OFF, Subscription Service confirms
messages and continues to process other messages regardless of the IO errors.
Using Error Handling in the Record Transfer Mode
This section introduces how the adapter handles errors for the Publication and
Subscription Service in the Record Transfer mode.
Publication Service
When Publication Service detects a parsing error that violates the predefined
schema, an XML file containing the name of the input file and the error details are
created. To use this feature, you must specify a valid directory in the Error
Directory field in the Processing tab.
For example:
If a ReadSchema is defined as follows:
H
D
where H and D are delimited file records (identified by a constant) with the
following fields and types:
H
field_1
field_2
String
ui4
field_1
field_2
String
ui4
(Header)
D
(Detail)
For example, when Publication Service parses an input.txt input file, which
contains the following records, the line Header -10 is not validated.
Header,
Detail,
Header,
Detail,
Header,
Detail,
-10
20
30
40
50
60
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Error Handling 93
|
The XML file that is created is named input.txt20030917151048000.xml is
shown as follows:
<?xml version="1.0" encoding="UTF-8" ?>
- <file name="input.txt20030917151048000">
- <errorObjects>
- <object>
<contents>Header, -10 </contents>
<location startLine="1" endLine="1" startOffset="0"
endOffset="11" />
<error>Header record contains invalid data field: Header,
[-10]</error>
</object>
</errorObjects>
</file>
-10
The XML file contains the name of the input file and an object element for each
error. Each object element contains details such as the entire identified object,
location of the object in the file, and error details. The input file that has parsing
errors is kept for analysis. The location and name is dependent on the
postprocessing option specified in the Processing tab. When the input file is
abc.txt, the following describes the name and location based on the various
postprocessing options:
Leave as is
1.
abc.txt
2.
abc.txt.timestamp
3.
abc.txt.timestamp.xml
is retained in the input directory;
is created in the error directory;
is created in the error directory.
Delete
1.
abc.txt
2.
abc.txt.timestamp
3.
abc.txt.timestamp.xml
is deleted from the input directory;
is also created in the error directory;
is created in the error directory.
Move to (without timestamp)
1.
abc.txt
2.
abc.txt.timestamp.xml
is moved to the done directory;
is created in the error directory;
3. No copy of the input file is created in the error directory.
For easy identification, the timestamp on the XML file and the corresponding
input file is the same.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
94
| Chapter 5
Advanced Topics
Subscription Service
If error occurs when processing a file transfer, Subscription Service has the
following scenarios:
•
If error occurs when Subscription Service writes the file in the wip directory,
Subscription Service does not confirm the message, it prints the error log and
exits by default. When you set the adfiles.io.sub.exit4issue property to
OFF, Subscription Service prints the error log, confirms the message, and then
continues to receive other messages.
•
If error occurs when Subscription Service moves the transfer file from the
working directory to the output directory, and the error directory is specified,
the adapter moves the file to the error directory and Subscription Service exits
by default. When you set the adfiles.io.sub.exit4issue property to OFF,
Subscription Service does not exit.
•
When IO errors occur in Subscription Service, Subscription Service exits by
default. If Publication Service continues to send messages using the Durable
EMS transport or the Certified RV transport, Subscription Service resubscribes
the remaining messages from the transport when restarted.
•
To save messages on the Certified RV transport, you have to select Repeating
in the Life Cycle field in Publication Service.
•
When an IO error occurs, whether the data format of a message is Business
document (MBusinessDocument) or Object (MInstance), Subscription
Service handles the IO error in the same way.
Diagnostics File
When the invalid records violate the schema and contain invalid characters, all
the invalid records and their line numbers are created in a file in the specified
error directory. The diagnostics file provides useful information for users to
correct the invalid records and then republish them.
The following is an example of an input file that contains invalid records (marked
in bold).
OrderX, ID41678, <10Apr2000
Item, GigaWidget, 60, $75
Item, MegaBucket, 48, $60
Customer, Hopkins Associates, ID36800
Order, ID41680, 20May2000
ItemX, Rt.Clopper, >40, $50
Item, Lt.Clopper, 50, $100
Customer, JerseyWebInovaters, ID46786
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Error Handling 95
|
The schema diagnostics file has the format of an XML file and has a .xml
extension, so you can open and view it in a text editor and in an Internet browser.
When invalid records contain special XML characters, error occurs and you
cannot open the XML file in an Internet browser.
The XML specification states that characters ‘&’, ‘<’, and ‘>’ are special characters .
When these special characters appear in an XML fie, they are replaced with
“&amp;”, “&lt;”, and “&gt;” respectively.
When invalid records containing special XML characters are written to the
diagnostics file without proper conversion, the adapter provides three different
formats for users to select from for the diagnostics file:
•
Plain text file
•
XML file without special character conversion
•
XML file with special character conversion
If you use TIBCO Administrator to deploy and run the adapter, you can create an
global variable and use it to specify
the format for the diagnostics file. The three valid values for the global variable
are xml (default), xmlconv, and text for the XML without special character
conversion, XML with special character conversion, and plain text
diagnostics files.
adfiles.schemaDiagnosticsFileFormat
For users who run the adapter by configuring or using the TRA file directly, they
can add the adfiles.schemaDiagnosticsFileFormat property to the TRA file
to specify the custom format for the diagnostics file. The three valid values for the
global variable are xml (default), xmlconv, and text for the XML without
special character conversion, XML with special character conversion,
and plain text diagnostics files.
Using Error Handling in the Simple File Transfer Mode
This section introduces how the adapter handles errors for the Publication and
Subscription Service when using the Simple File Transfer mode.
Publication Service
For every Subscription Service that is marked inactive, or if an active Subscription
Service returns a checksum error for a given file transfer, Publication Service
maintains a Subscription Service specific log file (_.txt) in the error directory
specified during configuration. This file contains information that points to the
file Subscription Service had an issue with.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
96
| Chapter 5
Advanced Topics
Based on the selected postprocessing option, files are moved to the appropriate
place for future use.
•
If the postprocessing option is set to Leave as is or Delete, and Publication
Service has detected an issue with a Subscription Service, the file is moved to
the error directory with the date and timestamp appended to it.
•
If the postprocessing option is set to Move to, and Publication Service has
detected an issue with a Subscription Service, the file is moved to the
completion directory. Depending on the option to add date and time, the date
and timestamp are appended to the file.
Subscription Service
If error occurs when processing a file transfer, Subscription Service prints the
error log and exits by default. When you set the adfiles.io.sub.exit4issue
property to OFF, Subscription Service prints the error log and does not exit.
When IO errors occur in Subscription Service, Subscription Service exits by
default. If Publication Service continues to send messages using the Durable EMS
transport or the Certified RV transport, Subscription Service resubscribes the
remaining messages from the transport when restarted.
To save messages on the Certified RV transport, you need to select Repeating in
the Life Cycle field in Publication Service.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Using Global Variables 97
|
Using Global Variables
The variable substitution mechanism overrides global variables predefined in the
project in a restricted manner. Predefined variables are viewed and set in TIBCO
Designer. Variables are specified as %%VARNAME%% and cannot contain any white
space.
Variable substitution enables you to do the following things:
•
Substitute string variables specified in the project at startup time.
•
Locally define the value for a variable for a specific project. The local value
takes precedence over any global value.
•
Specify the value for a variable in a properties file. This overrides the project
repository and values set in code, but not variables set on the command line.
•
Enforce the predefined variables listed in Predefined Global Variables on
page 98.
You can use variables in the configuration. The variables will be replaced by
values specified in the adapter instance directly.
Specifying Variables Using TIBCO Designer
Global variables provide an easy way to set defaults throughout your project.
Followings are availabe ways:
•
Define a variable using TIBCO Designer, and override the value for individual
applications at deployment time using TIBCO Administrator. You can also
override values for predefined variables unless the GUI does not allow you to
make them settable later.
•
Predefine a variable using TIBCO Designer, and override the value for
individual services (for example, Publication Service or TIBCO ActiveMatrix
BusinessWorks process) at deployment time using TIBCO Administrator. The
values you specify are used at runtime. You can also override values for
predefined variables unless the GUI does not allow you to make them settable
later.
For example, you could assign the value 7474 to the predefined global variable
RvDaemon. And then you can use the variable in different sessions in your adapter.
If you want to change the TIBCO Rendezvous daemon for your adapter, you can
globally set it to a different value or override it on the command line.
You can also add and define global variables in the TRA file. The global variable
follows the convention: adfiles.instance-name_service-name_UserId.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
98
| Chapter 5
Advanced Topics
To use global variables in your project, complete the following steps:
1. In the Project panel, click the Global Variables tab and then click Open
Advanced Editor.
The following options are available:
— To assign or change a variable value, select that region and triple-click the
variable. The variable expands so you can change either the variable name
or the variable value. Press Enter when you’re done.
— To add a new global variable group, click
. Specify the name of the
group, and then press Enter. After selecting the group icon, you can click
to add variables to the group.
— To add a global variable, click.
. A new global variable item is added to
the bottom of the list. Specify the variable name and the value. Press Enter
when you’re done.
The global variable is now displayed in the global variables list.
2. When you want to use the global variable in the fields of a resource, enter the
variable name surrounded by %% on both sides.
When the project is deployed and the configured components are running, all
occurrences of the global variable name are replaced with the global variable
value (unless it was overridden in a way that had higher precedence).
A number of global variables are predefined. See Predefined Global Variables on
page 98. You can add definitions of any variables to the predefined variables.
Predefined Global Variables
Table 5 lists and explains the predefined global variables. Some global variables
are automatically used within the system when an adapter instance is configured.
Table 5 Predefined Global Variables (Sheet 1 of 3)
Variable
Description
Deployment
Defaults to the TIBCO Designer project name. The value
type is string. This global variable is used by the system to
partially define the subject name of a service.
DirLedger
Specifies the path name of the TIBCO Rendezvous
certified messaging ledger file. The default is the root
installation directory.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Using Global Variables 99
|
Table 5 Predefined Global Variables (Sheet 2 of 3)
Variable
Description
DirTrace
Specifies the path name for log file used by the adapter.
The default is the root installation directory.
Domain
The default value for file-based local projects is MyDomain.
The value for server-based projects is the domain to which
the project is saved.
HawkEnabled
Indicates whether TIBCO Hawk is used to monitor the
adapter. True indicates that a Hawk microagent is defined
for the adapter. False indicates the microagent is not to be
used.
JmsProviderUrl
Specifies where the JMS server is located. Setting this value
takes effect in early stages of a project, when only one JMS
server is used.
RemoteRvDaemon
TIBCO Rendezvous routing daemon (rvrd) to be used. For
details about setting up a domain using rvrd, see TIBCO
Administrator Server Configuration Guide.
RvDaemon
TIBCO Rendezvous daemon. Sessions use this daemon to
establish communication. The default value is 7500.
RvNetwork
TIBCO Rendezvous network. You need to set the variable
on computers with more than one network interface.
When specified, the TIBCO Rendezvous daemon uses that
network for all outbound messages.
In most cases, you can use the default network.
RvService
TIBCO Rendezvous service. The TIBCO Rendezvous
daemon divides the network into logical partitions. Each
transport communicates with a single service. A transport
communicates only with the same service with other
transports.
The default value is 7500. If you are using the default
TIBCO Rendezvous configuration, you can use the default
value.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
100
| Chapter 5
Advanced Topics
Table 5 Predefined Global Variables (Sheet 3 of 3)
Variable
Description
RvaHost
Computer on which the TIBCO Rendezvous agent runs.
This variable is only relevant if you are using the TIBCO
Rendezvous Agent (rva) instead of the TIBCO
Rendezvous daemon, and if you have configured a
non-default setup. For details about specifying the rva
parameters, see TIBCO Rendezvous Administration.
RvaPort
TCP port where the TIBCO Rendezvous agent (rva) listens
for client connection requests. For details about specifying
the rva parameters, see TIBCO Rendezvous Administration.
The default value is 7501.
TIBHawkDaemon
TIBCO Rendezvous daemon used in the TIBCO Hawk
session. For details about this parameter, see TIBCO Hawk
Installation and Configuration.
TIBHawkNetwork
TIBCO Rendezvous network used by the TIBCO Hawk
session. For details about this parameter, see TIBCO Hawk
Installation and Configuration.
TIBHawkService
TIBCO Rendezvous service used by the TIBCO Hawk
session. For details about this parameter, see TIBCO Hawk
Installation and Configuration.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
File Recognition Methods of Publication Service 101
|
File Recognition Methods of Publication Service
Table 6 shows various configuration setting combinations for a Publication
Service and explains the results. Each of the first four columns indicates a field
value. Note that an empty column indicates no value is specified in the
corresponding field.
Table 6 Configuration Settings for Publication Service
Recognition
Method
File
Prefix
File
Extension
By prefix +
extension
Trigger
File
Extension
Result
All files in the input directory are
processed. This option is similar to using
the wildcard with the *.* as ICU regular
expression.
Only files in the input directory that
contain delimited in their file prefix are
processed. This option is similar to using
the wildcard with the delimited.* as ICU
regular expression. For example,
delimited.txt, delimited123.txt, delimited456.csv.
delimited
delimited
txt
Only files in the input directory that
contain delimited in their file prefix and
have a .txt extension are processed.
txt
Only files in the input directory with a .txt
extension are processed. This option is
similar to using the wildcard with the *.txt
as ICU regular expression. For example,
abc.txt, 123.txt.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
102
| Chapter 5
Advanced Topics
Table 6 Configuration Settings for Publication Service (Cont’d)
Recognition
Method
File
Prefix
File
Extension
Trigger
File
Extension
trg
By Trigger
Result
This is equivalent to specifying that when
a trigger file named anyprefix.trg is created
in the input directory, the adapter searches
for a file named anyprefix, since the file
extension is empty.
For example, if a file named delimited.trg is
created in the input directory, the adapter
will only parse files for a file named
delimited. If a file named payments.trg is
created, the adapter will search for a file
named payments.
delimited
trg
When a trigger file named delimited.trg is
created, the adapter searches for a file
named delimited. Similarly if a file named
delimited2.trg is created, the adapter will
search for a file named delimited2.
In this example, a file named payments.trg is
ignored by the adapter.
delimited
txt
trg
When a trigger file named delimited.trg is
created, the adapter searches for a file
named delimited.txt.
When a file named delimited2.txt is present,
it is not processed. The file will be
processed if delimited2.trg is created.
In general, only when the prefix name of
the trigger file matches the prefix name of
the file extension, the adapter will process
the file.
txt
trg
When a trigger file named anyprefix.trg is
created, the adapter searches for a file
named anyprefix.txt.
Similarly, when a trigger file named
payments.trg is created, the adapter searches
for a file named payments.txt.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Data Validation 103
|
Data Validation
The runtime adapter performs data validation. Table 7 lists the valid format and
range of each data type. When a field contains data that does not conform to the
format or data whose value is beyond the valid range, the entire record is
discarded and an error message is logged.
Table 7 Data Validation Formats
Data Type
Format
Valid Range
i1
[whitespace][{+|-}][digits]
<-128,127>
i2
[whitespace][{+|-}][digits]
<-32768,32767>
i4
[whitespace][{+|-}][digits]
<-2147483648,2147483647>
i8
[whitespace][{+|-}][digits]
<-9223372036854775808,9223372036854775807>
ui1
[whitespace][+][digits]
<0,127>
ui2
[whitespace][+][digits]
<0,32767>
ui4
[whitespace][+][digits]
<0,2147483647>
ui8
[whitespace][+][digits]
<0,9223372036854775807>
r4
[whitespace][sign][digits][.
digits][{e|E}[sign]digits]
<1.175494351e-38,3.402823466e+38>
r8
[whitespace][sign][digits][.
digits][{e|E}[sign]digits]
<2.2250738585072014e-308,1.7976931348623158e+308>
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
104
| Chapter 5
Advanced Topics
Table 7 Data Validation Formats (Cont’d)
Data Type
Format
Valid Range
DataTime
A list of predefined
patterns and an option to
specify user-defined
patterns are available.
If the user-defined pattern
option is enabled, you can
use User-Defined Pattern
to specify the pattern. For
syntax and semantics for
specifying the pattern, see
the Syntax for Specifying
User-defined Date and
Time Patterns on page 108.
Base Record
A base record is a record with fields that can only be of scalar type. To define base
records, complete the following steps:
1. Select the Show Base Records Folder check box in the Configuration panel of
the ReadSchema. A Base Records folder for the ReadSchema is created.
2. Drag and drop the DelimitedFileRecord icon from the Palettes panel to the
Design panel.
3. Configure the DelimitedFileRecord.
If you need more base records, repeat step 2 and 3.
Container Record
A container record is a record with fields that can be of scalar or record type. The
following is an example of a container record.
Department, Engineering, Employee, ID0005, Mary, Employee, ID0006,
David, Employee, ID0008, John
In this example, Employee is a base record that contains fields of String type
(Employee, ID00005, Mary), the Department record contains fields of string
type and records. Fields of string type are Department and Engineering. Fields
of record type are the Employee record.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Data Validation 105
|
The base and the container records are delimited by commas, and are identified
using constant field values Employee and Department.
A container record can contain multiple types of base record.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
106
| Chapter 5
Advanced Topics
Unsupported Variations of the Container Record
Table 8 lists some container record variations that are not supported by the
adapter in this release.
Table 8 Unsupported Variations of the Container Record
Record Description
Example
Container record
consisting of repeating
substructures cannot be
defined as a base record.
It is called a shadow
container record.
Order, ID1010, pencil, 10, eraser, 6, note pad, 12
Although pencil, 10, eraser, 6, and note pad,
12 are repeating substructures, they has no
common constant identifier that can be used as a
record identifier.
Container record
consisting of a base
record that appears any
number of times
anywhere within a
container record. It is
called a floating base
record.
Department, Finance, <<Employee, ID0003,
Mike>>
<<Employee, ID0003, Mike>>, Department,
Finance, <<Employee, ID0005, Mary>>
Department, <<Employee, ID0003, Mike>>,
Finance
Container record
consisting of nested
container records.
Order, Id2002, Item, Monitor, Customer,
John, Address, Madison Ave, NY, Item,
Keyboard, Customer, Joe, Address, Pike
Ave, NJ
The Employee base record appears at different
places within the Department container record.
If Address is a base record for Customer, it is
considered a nested base record.
Positional container
records.
Container record
consisting of base
records that are partially
formed.
If the original schema definition corresponds to the
following structure, with Item and Customer as
the base records:
Order, Id2002, Item, Monitor, Customer,
John
And then the following line in the file is not
supported.
Order, Id2002, Item, Customer, John
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Data Validation 107
|
Table 8 Unsupported Variations of the Container Record (Cont’d)
Record Description
Example
A container record which
contains a base record
that is not contiguous.
Order, Id2002, Item, Monitor, Customer,
John, Item, Keyboard, Customer, Joe
The above container record is ordered and the base
records are Customer and Item. In this example,
the Item record repetition is not contiguous.
The representation of the the record type fields on the wire schema is similar to
that of a file record that is a child. They are both represented as a sequence.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
108
| Chapter 5
Advanced Topics
Syntax for Specifying User-defined Date and Time Patterns
Table 9 lists the date and time symbols that used as patterns to interpret and
generate date and time in various formats.
Table 9 Date and Time Symbols
Symbol
Meaning
Presentation
G
era designator
Text)
AD
y
year
(Number)
1996
Y
year/week of year
(Number)
1996
M
month in year
(Text & Number)
July & 07
d
day in month
(Number)
10
h
hour in am/pm (1~12)
(Number)
12
H
hour in day (0~23)
(Number)
0
m
minute in hour
(Number)
30
s
second in minute
(Number)
55
S
millisecond
(Number)
978
E
day of week
(Text)
Tuesday
e
day of week/local
(1~7)
(Number)
2
D
day of year
(Number)
189
F
day of week in month
(Number)
2 (2nd Wed in July)
w
week in year
(Number)
27
W
week in month
(Number)
2
a
am/pm marker
(Text)
PM
k
hour in day (1~24)
(Number)
24
K
hour in am/pm (0~11)
(Number)
0
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Example
Syntax for Specifying User-defined Date and Time Patterns 109
|
Table 9 Date and Time Symbols (Cont’d)
Symbol
Meaning
Presentation
z
time zone
(Text)
'
escape for text
''
single quote
Example
Pacific Standard
Time
'
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
110
| Chapter 5
Advanced Topics
Locales Supported for Date and Time
Table 10 lists the abbreviation for the country and language that used by the
adapter.
Table 10 Country and Language Codes (Sheet 1 of 5)
Abbreviation
Country/Language
ar_AE
Arabic United Arab Emirates
ar_BH
Arabic Bahrain
ar_DZ
Arabic Algeria
ar_EG
Arabic Egypt
ar_IQ
Arabic Iraq
ar_JO
Arabic Jordan
ar_KW
Arabic Kuwait
ar_LB
Arabic Lebanon
ar_LY
Arabic Libya
ar_MA
Arabic Morocco
ar_OM
Arabic Oman
ar_QA
Arabic Qatar
ar_SA
Arabic Saudi Arabia
ar_SD
Arabic Sudan
ar_SY
Arabic Syria
ar_TN
Arabic Tunisia
ar_YE
Arabic Yemen
be_BY
Byelorussian Byelorussia
bg_BG
Bulgarian Bulgaria
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Locales Supported for Date and Time 111
|
Table 10 Country and Language Codes (Sheet 2 of 5)
Abbreviation
Country/Language
ca_ES
Catalan Spain
ca_ES_EURO
Catalan Spain
cs_CZ
Czech Republic
da_DK
Danish Denmark
de_AT
German Austria
de_AT_EURO
German Austria
de_CH
German Switzerland
de_DE
German Germany
de_DE_EURO
German Germany
de_LU
German Luxembourg
de_LU_EURO
German Luxembourg
el_GR
Greek Greece
en_AU
English Australia
en_BE
English Belgium
en_CA
English Canada
en_GB
English United Kingdom
en_IE
English Ireland
en_IE_EURO
English Ireland
en_NZ
English New Zealand
en_US
English United States
en_ZA
English South Africa
es_AR
Spanish Argentina
es_BO
Spanish Bolivia
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
112
| Chapter 5
Advanced Topics
Table 10 Country and Language Codes (Sheet 3 of 5)
Abbreviation
Country/Language
es_CL
Spanish Chile
es_CO
Spanish Colombia
es_CR
Spanish Costa Rica
es_DO
Spanish Dominican Republic
es_EC
Spanish Ecuador
es_ES
Spanish Spain
es_ES_EURO
Spanish Spain
es_GT
Spanish Guatemala
es_HN
Spanish Honduras
es_MX
Spanish Mexico
es_NI
Spanish Nicaragua
es_PA
Spanish Panama
es_PE
Spanish Peru
es_PR
Spanish Puerto Rico
es_PY
Spanish Paraguay
es_SV
Spanish El Salvador
es_UY
Spanish Uruguay
es_VE
Spanish Venezuela
et_EE
Estonian Estonia
fi_FI
Finnish Finland
fi_FI_EURO
Finnish Finland
fr_BE
French Belgium
fr_BE_EURO
French Belgium
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Locales Supported for Date and Time 113
|
Table 10 Country and Language Codes (Sheet 4 of 5)
Abbreviation
Country/Language
fr_CA
French Canada
fr_CH
French Switzerland
fr_FR
French France
fr_FR_EURO
French France
fr_LU
French Luxembourg
fr_LU_EURO
French Luxembourg
hr_HR
Croatian Croatia
hu_HU
Hungarian Hungary
is_IS
Icelandic Iceland
it_CH
Italian Switzerland
it_IT
Italian Italy
it_IT_EURO
Italian Italy
iw_IL
Hebrew Israel
ja_JP
Japanese Japan
ko_KR
Korean Korea
lt_LT
Lithuanian Lithuania
lv_LV
Latvian Latvia
mk_MK
Macedonian Macedonia
nl_BE
Dutch Belgium
nl_BE_EURO
Dutch Belgium
nl_NL
Dutch Netherlands
nl_NL_EURO
Dutch Netherlands
no_NO
Norwegian (Nynorsk) Norway
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
114
| Chapter 5
Advanced Topics
Table 10 Country and Language Codes (Sheet 5 of 5)
Abbreviation
Country/Language
no_NO_NY
Norwegian (Bokmål) Norway
pl_PL
Polish Poland
pt_BR
Portuguese Brazil
pt_PT
Portuguese Portugal
pt_PT_EURO
Portuguese Portugal
ro_RO
Romanian Romania
ru_RU
Russian Russia
sh_YU
Serbo-Croatian Yugoslavia
sk_SK
Slovakian Slovakia
sl_SI
Slovenian Slovenia
sq_AL
Albanian Albania
sr_YU
Serbian (Cyrillic) Yugoslavia
sv_SE
Swedish Sweden
th_TH
Thai Thailand
tr_TR
Turkish Turkey
uk_UA
Ukranian Ukraine
vi_VN
Vietnamese Vietnam
zh_CN
Chinese (Simplified) China
zh_HK
Chinese Hong Kong
zh_TW
Chinese (Traditional) Taiwan
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Using Trigger Messages 115
|
Using Trigger Messages
A Rendezvous or JMS trigger message contains the USERID, inputDirectory,
fileName, filePrefix, and fileExtension properties. When triggering a
Publication Service using a message that has these properties, the JMS trigger
message properties override the corresponding properties that you have set at
design time. The changes made during runtime do not change the configuration
in the repository.
If By File Name is selected from the Recognition Method list, the fileName
property contains filename and no ICU regular expressions.
When an ICU regular expression is used in trigger messages, if the ICU regular
expression contains a comma, the comma is escaped.
For example, the trigger message “fileName=go{1,5}gle\.txt” contains a
comma. This comma is not a property separator, so an "escaping" comma in front
of the comma needs to be added, for example, "fileName=go{1,,5}gle\.txt".
You can send multiple trigger messages at one time, and each message has
properties. After Publication Service receives the trigger messages, the messages
are queued up, and then Publication Service processes them one by one.
When you send multiple trigger messages, ensure that the number of the
messages does not exceed the reasonable numbers that your system resource
supports.
TIBCO ActiveMatrix Adapter for Files for Unix/Win tries its best to to persist the
trigger messages, but does not guarantee.
Syntax
Follow these rules when using Rendezvous or JMS trigger messages:
•
Only the String property is supported.
•
The properties must be enclosed in double quotation marks.
•
The properties are separated by commas. There are no spaces between
properties.
For example, "inputDirectory=reader/input,fileName=foo.txt".
•
The property value is String or Integer. It cannot contain a comma. Other date
types are not supported.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
116
| Chapter 5
Advanced Topics
Usage Scenarios
Rendezvous and JMS trigger messages are used in the following scenarios:
•
If the trigger message is empty, Publication Service uses the properties that
have been defined at design time.
•
The input directory of Publication Service can be changed at runtime by
sending the following trigger messages.
— Rendezvous message:
{
RVMSG_STRING 6 inputDirectory
"/home"
}
— JMS message:
"inputDirectory=reader/input"
The input directory is changed. The change remains in effect until another
trigger message with the above format is received.
•
If you select By file name from the Recognition Method list for Publication
Service, it can be changed at runtime by sending the following messages.
— Rendezvous message:
{
RVMSG_STRING 8 fileName
"abc.txt"
}
{
RVMSG_STRING 8 DATA
"abc.txt"
}
In this example, 8 is the length of the "abc.txt" filename plus one.
— JMS message:
"fileName=abc.txt"
If a JMS trigger message contains no file name property, Publication Service
will use the file name specified in the last JMS trigger message, or the file
name configured in TIBCO Designer if no file name is specified in previous
trigger messages. The following error message is logged:
The trigger message does not mention the input filename
therefore use the input filename currently in-effect File_name.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Using Trigger Messages 117
|
•
If you select By prefix + extension from the Recognition Method list for
Publication Service, it can be changed at runtime by sending the following
messages:
— Rendezvous message:
{
RVMSG_STRING 4 filePrefix
"abc"
RVMSG_STRING 4 fileExtension
"txt"
}
Additionally the following special fields are also recognized
{
RVMSG_STRING 1 USERID
""
}
{
RVMSG_STRING 1 TRACKINGID
""
}
— JMS message:
"filePrefix=abc, fileExtension=txt"
•
When Publication Service gets an invalid trigger message, for example
“fileName=foo.txt,=John” or “reader/input,fileName=foo.txt”,
Publication Service discards the message.
•
Publication Service can receive many trigger messages at a time; however, it
processes them one by one. Trigger messages waiting to be processed are
saved. If Publication Service stops and then restarts, it will continue to process
the saved trigger messages.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
118
| Chapter 5
Advanced Topics
Using Selective Routing Over JMS
When using JMS trigger messages to trigger a Publication Service, you can send
different files to the selected subscribers dynamically using Selective Routing.
Syntax
Follow these rules when using Selective Routing over JMS:
•
The trigger message must be a JMS Text message. The text must be in the
"Prop=Val" format.
•
Only string and numeric message selector properties are supported.
•
Multiple message selector properties can be entered, and they must be
separated by a comma. The value of properties must be enclosed in double
quotes. For example: "Prop1=Val1,Prop2=Val2".
The USERID, inputDirectory, fileName, filePrefix, and fileExtension
properties are reserved for TIBCO ActiveMatrix Adapter for Files for Unix/Win.
The message selector properties that you define must not use the same names. All
the properties that you define are included in the properties section of every
outgoing JMS data message.
Configuration
To use selective routing, you need to specify the JMS message selector on the
subscribers that you send messages to. You can specify message selectors in
TIBCO Designer.
Setting JMS Message Selectors in TIBCO Designer
To do this, complete the following steps:
1. Start the EMS server.
2. Open the project containing Subscription Services in TIBCO Designer.
3. Specify JMS message selectors.
a. In the Sessions folder of your Subscription Service, for example, mysub1,
expand the DefaultJMSTopicSession tree and select mysub1EndPoint.
b. In the Configuration tab of Subscription Service endpoint, specify the
selector in the Message Selector field. For example, type
(Branch='Boston' OR Branch='East Coast' OR Branch='ALL') AND
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Using Selective Routing Over JMS 119
|
((SalesUpper>=62 AND SalesLower<=62) OR SalesVolume='ALL'), as
shown in Figure 11.
c. Repeat step a and step b to specify a JMS selector for another Subscription
Service.
For example, type (Branch='New
York' OR Branch='East Coast' OR
Branch='ALL') AND ((SalesUpper>=90 AND SalesLower<=90) OR
SalesVolume='ALL') in the Message Selector field for a Subscription
Service named mysub2.
Figure 11 Using TIBCO Designer to Specify JMS Message Selector
4. Select Simple File Transfer from the Transfer Mode list for Subscription
Services.
5. Start Subscription Service and connect to the EMS server.
6. Start a Publication Service and connect to the EMS server. Publication Service
uses the Simple File Transfer. The polling method is JMS (topic) message.
7. Send a JMS trigger message to Publication Service. For example, send the
following JMS message: "fileName=File_name1,Branch='East
Coast',SalesUpper=70,SalesLower=50".
After receiving the trigger message, Publication Service starts transferring the
files to Subscription Services specified in the JMS message selectors in step 3.
The fileName, Branch, SalesUpper, and SalesLower properties are included
in the outgoing data messages. In this example, mysub1 matches the
conditions in the JMS message. Publication Service routes the messages to
mysub1.
For details about configuring EMS servers, creating EMS routes, constructing JMS
messages, and specifying JMS message selectors, see the TIBCO Enterprise
Message documentation.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
120
| Chapter 5
Advanced Topics
Dynamically Changing Output File Names at Runtime
In the Record Transfer mode, Subscription Service by default uses the filenames
configured at the design time when creating the output files to store the incoming
messages. However, sometimes Subscription Service uses different filenames
dynamically from what's configured at the design time when creating the output
file. This can be achieved using the Business Document data format and
embedding the new filenames in the data messages. This occurs when
Subscription Service creates the output file using the exact same filenames when
files are being published.
To do this, complete the following steps:
1. Select Business document from the Data Format list in the Advanced tab of
Publication Service.
2. Type the name of the Business Document in the Business Document Name
field.
3. Select Append messages to file, Close on Business Document Lot End from
the Wip Creation Mode list in the Configuration tab of Subscription Service.
4. Set the adfiles.useBDEmbeddedFileName property to ON in the
your_runtime.tra file (for Subscription Service), or create an
adfiles.useBDEmbeddedFileName global variable, and set its value to ON.
If using TIBCO Administrator to deploy and run the adapter, create an
adfiles.useBDEmbeddedFileName global variable and set the value to ON. Select
the Service check box in the global variable window. When creating the EAR file,
you must select the Include all service level global variable check box.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
File and Content Encoding 121
|
File and Content Encoding
You need to set instance encoding for the repository correctly, so the adapter can
interoperate with other TIBCO ActiveEnterprise applications.
File and Directory Encodings
The adapter provides support at the service level to set the encoding of the file
and the directories that it processes. It is a configuration parameter for the service.
Based on the platform on which the runtime adapter runs, you need to set the
parameter appropriately.
Content Encodings
The adapter processes file contents with various encodings.
The standard that TIBCO ActiveEnterprise uses is LATIN_1 or ISO-8859-1 for
exchanging LATIN_1 or ASCII data, and UTF-8 for other encodings such as
SHIFT_JIS.
Depending on the file encoding setting for the adapter configuration, you need to
set the correct repository instance encoding. The repository instance encoding
determines whether the data is exchanged in LATIN_1 or UTF-8. The default
repository encoding for local or the remote repository is LATIN_1 or ISO-8859-1.
This conforms to the file encodings LATIN_1 and ASCII.
When processing other encoding such as SHIFT_JIS, the repository instance
encoding is set to UTF-8.
Changing the instance encoding
•
For Remote Repository:
Use the remote repository initialization file (tibcoadmin<domain>.tra) and
set the repo.encoding property to UTF-8 or Latin-1.
•
For Local Repository:
If an adapter configuration is saved in a local project, the inter-communication
encoding is determined by the encoding property of the local project file. To
communicate with other adapters using the same encoding, all adapters and
applications must set their local project file encoding property to be identical.
The encoding value is set on the root project folder in the Project Settings tab.
Select the appropriate repository instance encoding (ISO-8859-1 or UTF-8),
and click Apply to save the settings.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
122
| Chapter 5
Advanced Topics
Business Event Messages
TIBCO ActiveMatrix Adapter for Files for Unix/Win provides business-event
level notifications for TIBCO Business Events.
To create business-event messages, complete the following steps:
1. Create a Network Sink in TIBCO Designer:
a. Drag the Network Sink object from the Adapter Resources palette.
b. Assign the EEMEvent role to the network sink.
For detailed information about creating a network sink, see TIBCO Designer
User Guide.
2. Configure the adfiles.EEMEnabled property:
— If you are using TIBCO Administrator, in the Global Variables tab, add an
adfiles.EEMEnabled global variable and set the value to ON.
— If you are not using TIBCO Administrator, add the adfiles.EEMEnabled
property to the adfilesagent.tra file and set the value to ON.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Simple File Transfer Status Message 123
|
Simple File Transfer Status Message
At the end of each file transfer, Publication Service sends or logs a status message
based on the log roles. Similarly, at the end of each file transfer, Subscription
Service sends or logs a status message based on the log roles. The status message
contains the following information:
Table 11 Information for the Status Message
Name
Description
fileName
The name of the file that is being transferred.
hostName
The name of the host on which Publication Service is running.
instanceName
The name of the adapter configuration.
serviceName
The name of Publication Service.
trackingId
The unique tracking ID generated for that polling instance every time the polling
trigger activates the publisher.
Note: You can set the tracking ID if you have selected TIBCO Rendezvous
message as the polling method. For details, see Using Trigger Messages on
page 115.
fileTransfer
Duration
The time needed to transfer the file.
currentDateT
ime
The date and time at the end of the file transfer.
status
The status of the file transfer. The value is set to n/a, or not applicable.
You can configure the status message as a TIBCO Rendezvous status message or
to be logged to the appropriate sinks.
To send the status message as an exclusive TIBCO Rendezvous message on a
user-defined subject, create a network sink, create a role named ecmPubStatus for
a Publication Service or create a role named ecmSubStatus for a Subscription
Service, and then associate the role with the network sink. For details about
creating a network sink, see the TIBCO Designer documentation.
To create user-defined roles such as ecmPubStatus or ecmSubStatus and to use
network sink, advanced logging options for the adapter configuration are enabled
in TIBCO Designer. Otherwise, enable debug for the sinks to log the status
message.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
124
| Chapter 5
Advanced Topics
Load Balancing Mode
In previous releases, you can only start one instance of a particular Publication
Service. From 6.2.0 release, you can run multiple instances of a Publication Service
to process separate files in parallel.
To enable Load Balancing mode, you need to set the adfiles.LBEnabled
property to ON in the TRA file.
Before a Publication Service instance processes an input file, Publication Service
instance locks the file by creating a .lck file. Therefore other Publication Service
instances ignore this input file and find other input files to publish.
•
In the Post Processing field, you cannot select Leave as is for Load Balancing
mode. When Leave as is is selected, the following error message displays after
starting Publication Service:
Notice: Load Balance not support the post processing mode
leave-as-is, please correct it
•
Each Publication Service instance has one unique message subject.
•
Load Balancing mode cannot be used with Delta Publishing mode together.
•
Load Balancing mode supports the Checkpoint Restart feature. For more
information, see CheckPoint Restart on page 128.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Delta Publishing Mode 125
|
Delta Publishing Mode
The Delta Publishing mode only supports the Timer polling method. When the
Delta Publishing mode is enabled, Publication Service checks the input file on a
preconfigured timer interval, and copies any new data to a work file in the WIP
directory, and then processes and publishes it.
To better explain the mechanism of the Delta Publishing mode, this section uses
the delimitedReader example. The example is located in the SimpleRecord.zip
file in the TIB_ADFILES_HOME\examples\samples\BusinessWorks5 directory.
In the delimitedReader example, the delimited.txt input file is shown as
follows:
Order, ID41678, 20May2000
Item, GigaWidget, 60, $75
Item, MegaBucket, 48, $125
Customer, Hopkins Associates, ID26490
Order, ID41680, 20May2000
Item, Rt.Clopper, 40, $100
Item, Lt.Clopper, 50, $100
Customer, Jersey WebInovaters, ID46786
When using the Delta Publishing mode, you have to consider the following two
conditions:
•
Each line
Each line might be written in the input file by another application at intervals.
The intervals are set at three times of the polling interval that you have set in
the Configuration tab. The adapter can handle all kinds of writing rates for
each line when you set a proper polling interval.
When a line is published as one message in the Delta Publishing mode, the
intervals are reset. When setting the polling interval, you have to consider the
writing rate of the application.
•
Each complete message
A complete message is written in the input file at intervals. The intervals are
set at three times of the polling interval you have set in the Configuration tab.
In this example, according to Read Schema, Order is the root record, so the
first 4 lines form a complete message, and the last 4 lines form another
complete message.
In the Delta Publishing mode, the adapter cannot recognize where the next
complete message starts, and the data is written in the input file by another
application continuously. If no data is written in the input file at the specified
intervals (3 times of the polling interval), the last 4 lines are published as a
complete message.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
126
| Chapter 5
Advanced Topics
After the last 4 lines are published as a complete message in the Delta
Publishing mode, other data appended to the last line is not allowed. For
example, after publishing the last 4 lines as a complete message, it is not
allowed to append data to line 8 as follows:
Customer, Jersey WebInovaters, ID46786 fdsfdsfds
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Handling Big Files 127
|
Handling Big Files
This function is used to handle big files. When
adfiles.pub.multithread4Bigfile is enabled, you can handle a big file with
multi-thread, and then you can set the adfiles.pub.multithreadCount
property to 2, 3, 4, or 5.
This function is not supported when:
•
the Position from Header of a child positional record is End
•
the Delta Publishing mode is enabled
•
the Data Format is Business
•
the Life Cycle is repeating
•
the big file contains base records
document
When you assign a value to the adfiles.pub.multithreadCount property, you
have to consider the following factors:
•
Performance of the machine
•
File size
•
Size and schema of each message
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
128
| Chapter 5
Advanced Topics
CheckPoint Restart
CheckPoint Restart stores records in a progress file when the adapter crashes. If
the adapter crashes when processing a file, Publication Service will continue to
process the file from where it crashes upon restart. The restart information is
stored in a progress file in the directory where the runtime adapter is executed.
To enable this functionality for Publication Service:
•
In the Record Transfer mode, select the CheckPoint Restart check box in the
Advanced tab.
•
In the Simple File Transfer mode, specify the progress file name in the SFT
tab. The name of the progress file is __InstanceNamePublicationServiceName.prg.
If Load Balancing mode is enabled, the subject or destination name is added to the
progress file name. For example:
__InstanceNamePublicationServiceNameSubjectName.prg
Since Publication Service does not update the progress file or perform
postprocessing on the file automatically, when the adapter exits abnormally, the
following situations occasionally occur:
•
Duplicate Messages
Since Publication Service does not publish messages or update the progress
files automatically, duplicate files are possibly to be created when Publication
Service resumes. The CheckPoint Restart function is used only if duplicated
messages are tolerant in the project.
When using Object (MInstance) or the grouping size of the Business document
is one, only one duplicate file is generated. When using Business document,
and the grouping size is greater than one, multiple duplicate files are
generated.
When you use the MInstance message format, the subscriber occasionally
writes a duplicate message after a checkpoint restart.
The MBusiness Doc format uses sequence numbers to prevent duplicate
messages. This preventative feature is only effective if the Document Delay
parameter is set to 0 (zero).
•
Missing File in the Working Directory
Missing file in the working directory occurs when the postprocessing on the
working file is completed but the progress file is not updated. Upon restart,
the adapter prompts that the file in the working directory is missing.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
CheckPoint Restart 129
|
•
Enabling the CheckPoint Restart feature results in lower performance.
Disabling this feature means a higher throughput is possible, but you need to
restart the service manually.
•
When CheckPoint Restart is enabled, Publication Service sends duplicate
messages, and Subscription Service might output duplicate messages even
though Publication Service does not resend them.
•
TIBCO recommends that you set the progress directory if you want to enable
the CheckPoint Restart feature.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
130
| Chapter 5
Advanced Topics
Using Log4J for Logging
Two log types are available: SDK log and Log4J log. By default, SDK log is used. If
you want to use Log4J log, you need to set the adfiles.trace.extended
property to ON in the adfilesagent.tra file.
TIBCO ActiveMatrix Adapter for Files for Unix/Win provides a default
file, which is sample for configuring Log4J
properties. The properties file is located in the TIB_ADFILES_HOME/bin directory
and contains the following lines, shown in Figure 12.
adfiles.log4j.properties
Figure 12 Log4J Properties
To enable the Log4J log, complete the following steps in the adfilesagent.tra
file:
1. Set the adfiles.trace.extended property to ON.
This is to enable Log4J log.
2. Specify a path for the adfiles.trace.log4j.properties property, the
default path is %TIB_ADFILES_HOME%/bin/adfiles.log4j.properties.
This is to specify the path for the Log4J configuration file.
3. Configure the adfilesagent.tra file, and invoke the
refreshExtendedLogging() method in Hawk.
This is to refresh the Log4J log without restarting the adapter whenever
changes are made to the Log4J properties file.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Fault Tolerance 131
|
Fault Tolerance
Fault Tolerance allows multiple adapter instances to substitute for each other.
When the primary adapter instance terminates unexpectedly, the token held by
the primary instance can be taken over by an adapter instance in the standby
state. In the process of replacement, the standby adapter instance is promoted to
the primary adapter instance.
•
When a standby adapter instance becomes a primary adapter instance, it does
not take the instance ID of the original primary adapter instance that
terminated unexpectedly and still has its own instance ID.
•
When running JMS topic as durable, durable names exist on EMS server for
each receiver, regardless if adapter instance is primary or standby.
•
To detect broken connections more quickly, you can add the
client_heartbeat_server=3 property to the tibemsd.conf files of all the
primary servers and standby servers.
Fault Tolerance is based on the JMS queue. Before enabling Fault Tolerance, you
need to define a JMS queue, set the prefetch parameter of the JMS queue to
none, and then put several JMS messages in the JMS queue as tokens. The number
of tokens corresponds to the number of primary adapter instances.
The following diagram shows how Fault Tolerance works. At first, instance 1 and
instance 2 fetch one of the two tokens in the JMS queue respectively. They hold
the tokens and process messages as primary instances. Instance 3 does not fetch
tokens and runs in standby state. If instance 2 terminates unexpectedly, it releases
the fetched token. Instance 3 fetches the token released by instance 2 and
continues to process messages as primary instance.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
132
| Chapter 5
Advanced Topics
Figure 13 Fault Tolerance
When Fault Tolerance is enabled, the following two issues occur:
•
If the number of tokens is more than 1, an exception is thrown in any of the
following conditions:
— The transport type is RVCM.
— The transport type is JMS. The primary instance and standby instance have
the same client ID.
— The delivery mode is Durable in Subscription Service and
Request-Response Service.
•
If a primary EMS server switches to the standby state, all primary adapter
instances that fetch tokens from the primary EMS server restart.
Enabling Fault Tolerance
To enable the fault tolerance features, set the
property to ON in the
file, and set SDK fault tolerance properties accordingly. For
details on the SDK fault tolerance properties, see Table 17, Predefined Properties
for TIBCO ActiveMatrix Adapter for Files for Unix/Win.
tibco.sdk.faultTolerance.ems.enabled
adfilesagent.tra
You can also configure fault tolerance properties in TIBCO Designer and in
TIBCO Administrator.
For information on JMS session configuration in TIBCO Designer, see TIBCO
Designer Palette Reference.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Fault Tolerance 133
|
To enable SDK fault tolerance in Files Adapter, conform to the following
configurations:
•
In Publication Service:
— In the Record Transfer mode, select the CheckPoint Restart check box in
the Advanced tab.
— In the Simple Transfer mode, specify the progress file name in the SFT tab.
•
In Subscription Service, do not select One message per file from the Wip
Creation Mode list when the transfer mode is Record Transfer.
•
Make sure only one primary instance is running.
•
When the transport type is JMS, make sure that the delivery mode is
for Publication Service, and Durable for Subscription Service.
Persistent
•
When the transport type is RVCM, you cannot use the Once-only life cycle for
Publication Service.
•
When the SDK fault tolerance and CheckPoint Restart features are enabled,
Load Balancing mode or Delta Publishing mode is not supported.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
134
| Chapter 5
Advanced Topics
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
| 135
Chapter 6
Monitoring the Adapter Using TIBCO Hawk
This chapter explains how to use TIBCO Hawk microagents to monitor and
manage the adapter.
Topics
•
Overview, page 136
•
Starting TIBCO Hawk Software, page 137
•
The Auto-discovery Process, page 138
•
Invoking Microagent Methods, page 139
•
Standard and Class Microagents, page 142
•
Custom Microagents, page 145
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
136
| Chapter 6
Monitoring the Adapter Using TIBCO Hawk
Overview
TIBCO Hawk is a sophisticated tool for enterprise-wide monitoring and
managing of all distributed applications and systems. System administrators uses
it to monitor adapters in a wide area network of any size. TIBCO Hawk is
configured to monitor system and adapter parameters and to take actions when
predefined conditions occur. The actions include: sending alarms that are
graphically displayed in the TIBCO Hawk display, sending email, paging,
running executables, or modifying the behavior of a managed adapter.
Unlike other monitoring applications, TIBCO Hawk relies on a purely distributed
intelligent agent architecture using publish or subscribe to distribute alerts.
TIBCO Hawk uses TIBCO Rendezvous for all messaging and thus gains the
benefits and scalability of the TIBCO Rendezvous features of publish or subscribe,
subject name addressing, interest-based routing, and reliable multicast.
TIBCO Hawk is a purely event-based system that uses alerts. The agents are
configured with rules that instruct them on what and how to monitor, what
actions to take when discovering problems. Therefore, the workload is fully
distributed throughout the enterprise. Each agent is independent in performing
its functions.
The TIBCO Hawk Enterprise Monitor consists of these components:
•
Display A GUI that displays alarms, provides editors to create rule bases and
tests, view messages, and invoke microagents to request information or
initiate an action.
•
Agents Intelligent processes that perform monitoring and take actions as
defined in rules.
•
Rulebases Rules that are loaded by agents to determine agent behavior.
•
Application Management Interface (AMI) Manages network applications by
TIBCO Rendezvous and supports communication between a network
application and TIBCO Hawk agents, which includes the ability to examine
application variables, invoke methods, and monitor system performance.
•
Microagents Returns information back to TIBCO Hawk and exposes methods
to rulebases.
For more information, see the TIBCO Hawk documentation.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Starting TIBCO Hawk Software 137
|
Starting TIBCO Hawk Software
You can configure the TIBCO Hawk agent to start automatically during the
system boot cycle. For information about starting TIBCO Hawk and how to start
the TIBCO Hawk Display, see the TIBCO Hawk documentation.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
138
| Chapter 6
Monitoring the Adapter Using TIBCO Hawk
The Auto-discovery Process
After you start an instance of TIBCO Hawk Display, it continually discovers
machines running TIBCO Hawk agents on your network. Container icons are
created for each agent, and arranged hierarchically in clusters. By default, agent
icons are clustered according to subnets.
At first, the Agents container is empty. Its counter displays a value of zero. On the
right, the Discovered counter is also zero. Both icons are initially green in color to
show that no alerts or warning messages are in effect. When agents are
discovered, the counters increment to reflect the current number of discovered
agents, as shown in the following figure:
Monitored network nodes are arranged in a hierarchical tree of containers.
Clicking a container in the left panel displays nested items on the right.
Icon colors change to reflect the highest level of alert found on discovered agents.
For explanations of icon elements and characteristics, see TIBCO Hawk
Administrator’s Guide.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Invoking Microagent Methods 139
|
Invoking Microagent Methods
A set of default microagents, platform-specific and platform-independent, is
loaded when a TIBCO Hawk agent is started. When you install and start the
TIBCO ActiveMatrix Adapter for Files for Unix/Win, microagents for the adapter
are dynamically added to the local agent.
The following steps describe how to invoke a microagent method by specifying a
microagent, method name, and optional method arguments.
To invoke a microagent method on a TIBCO Hawk agent, complete the following
steps:
1. In the TIBCO Hawk Display, right-click the agent icon and select Get
Microagents.
If TIBCO Hawk security is implemented on your system and you do not have
access to microagents on this agent, an error window opens. Select another
agent, or contact your system administrator to obtain access authority.
2. Select Invoke or Subscribe mode on the "Microagents, Methods and
Arguments" window. Microagents that you can access on the current agent are
listed on the upper left.
The Invoke mode enables to return a single set of current results. The
Subscribe mode provides updates of current results at regular intervals. You
can switch the two modes using the radio buttons at the bottom of the
window.
3. Click a microagent name, such as Self. A list of associated methods and their
description is displayed.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
140
| Chapter 6
Monitoring the Adapter Using TIBCO Hawk
4. Click the name of the method, such as getComponentInfo.
If the method accepts arguments, fields for each argument display in the
upper right panel. Detailed information is displayed at the bottom of the
panel.
5. Specify any arguments for the method.
6. Select the Invoke mode.
7. Click the Invoke button to invoke the selected method.
The Invocation Results window displays the results returned by the method.
8. Click Done to close the window.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Invoking Microagent Methods 141
|
These steps describe how to interactively invoke a microagent method and
receive a single set of results in TIBCO Hawk Display. You can use a microagent
method as the data source of a TIBCO Hawk rule. Rules receive method results,
apply tests to evaluate them, and then take action if necessary. For more
information on building TIBCO Hawk rules and rule bases, see TIBCO Hawk
Administrator’s Guide.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
142
| Chapter 6
Monitoring the Adapter Using TIBCO Hawk
Standard and Class Microagents
Table 12 lists each standard and class microagent method available for the adapter
and the page on which the method is explained.
Table 12 Standard and Class Microagent Methods (Sheet 1 of 3)
Method
Description
Page
activateTraceRole()
Activates a mapping of a role to a sink at
runtime.
147
deactivateTraceRole()
Deactivates a mapping of a role to sinks
at runtime.
148
getActivityStatisticsB
Returns statistics for one operation.
149
Returns statistics for any activities on a
particular object or schema.
150
Returns statistics related to the data
handled by a particular adapter service
since it started.
151
Returns information about the services
implemented by this adapter.
152
getComponents()
Returns information about the publisher,
subscriber and IODescriptor.
153
getConfig()
Returns basic configuration information.
More specific information is accessed by
using more specific methods.
154
getConfigProperties()
Returns all attributes and elements for
the given repository object.
155
getDocumentDelay()
Returns the document delay setting for a
given Publication Service.
156
getHostInformation()
Returns standard and extended
application information.
157
getPollingInterval()
Returns the current polling interval
setting.
158
yOperation(Operation)
getActivityStatisticsB
ySchema(SchemaName)
getActivityStatisticsB
yService(ServiceName)
getAdapterServicesInfo
rmation()
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Standard and Class Microagents 143
|
Table 12 Standard and Class Microagent Methods (Sheet 2 of 3)
Method (Cont’d)
Description (Cont’d)
Page
getQueueStatistics()
Returns the current count of elements in
any internal queue used by the adapter.
159
getRvConfig()
Returns information about all defined
TIBCO Rendezvous sessions.
160
getStatus()
Returns general status information, such
as the number of TIBCO Rendezvous
messages received and published, the
number of errors that have occurred
since the last call, the PID of the
application, and so on.
161
getTraceSinks()
Returns information about sinks to
which traces currently go.
162
getVersion()
Returns the configuration ID, application
name, version, and date for this adapter
instance.
163
_onUnsolictedMsg()
Displays alert messages sent to the
current adapter.
164
preRegisterListener()
Preregisters an anticipated listener.
165
resetActivityStatistic
Resets all the counts for the activity
statistics.
166
reviewLedger()
Returns information retrieved from the
ledger file of a certified messaging
session for a publisher adapter.
167
setDocumentDelay()
Sets the document delay for a
Publication Service.
169
setPollingInterval()
Sets the polling interval for Publication
Service.
170
setTraceSinks()
Adds a role or changes the file limit of a
previously specified sink.
171
stopApplicationInstanc
Stops the running adapter instance.
172
s()
e()
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
144
| Chapter 6
Monitoring the Adapter Using TIBCO Hawk
Table 12 Standard and Class Microagent Methods (Sheet 3 of 3)
Method (Cont’d)
Description (Cont’d)
Page
unRegisterListener()
Unregisters a currently preregistered
listener.
173
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Custom Microagents 145
|
Custom Microagents
Table 13 lists each custom microagent method that is available for the adapter,
and the page on which the method is explained.
The getActivityStatisticsBySchema(SchemaName),
getActivityStatisticsByOperation(Operation),
getActivityStatisticsByService(ServiceName), and
resetActivityStatistics() methods are now deprecated. You must use the
standard microagent to get equivalent methods. When the value of
adfiles.addCustomHawkMethodsToStdMAgent is set to ON in the TRA file, these
methods are added to the standard microagent.
Table 13 Performance Statistics Methods
Method
Description
Page
getDocumentDelay()
Returns the document delay setting for
a given Publication Service.
156
setDocumentDelay()
Sets the document delay for a
Publication Service.
169
getPollingInterval()
Returns the current polling interval
setting.
158
setPollingInterval()
Sets the polling interval for Publication
Service.
170
getActivityStatisticsB
Returns statistics for one operation.
149
Returns statistics for any activities on a
particular object or schema.
150
Returns information about the services
implemented by this adapter.
151
Resets all the counts for the activity
statistics.
166
yOperation(Operation)
getActivityStatisticsB
ySchema(SchemaName)
getActivityStatisticsB
yService(ServiceName)
resetActivityStatistic
s()
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
146
| Chapter 6
Monitoring the Adapter Using TIBCO Hawk
Table 13 Performance Statistics Methods (Cont’d)
Method (Cont’d)
Description (Cont’d)
Page
refreshExtendedLogging
Refreshes the Log4J log without
restarting the adapter whenever
changes are made to the Log4J
properties file.
174
()
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
activateTraceRole() 147
|
activateTraceRole()
Activates a mapping of a role to a sink at runtime. This replaces the deprecated
setTraceSink() TIBCO Hawk method.
Input
Parameters
Type
Description
Role Name
string
Name of the role to activate.
Sink Name
string
Name of the sink for which to activate the role.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
148
| Chapter 6
Monitoring the Adapter Using TIBCO Hawk
deactivateTraceRole()
Deactivates a mapping of a roles to sinks at runtime.
Input
Parameters
Type
Description
Role Name
string
Name of the role to activate.
Sink Name
string
Name of the sink for which to activate the role.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
getActivityStatisticsByOperation(Operation) 149
|
getActivityStatisticsByOperation(Operation)
Returns the total number of objects processed for all the schemas by each service
that is associated with a specified operation, and returns the number of success
and error objects.
Parameter
Type
Description
Operation
string
Type of operation: read or write.
Returns
Type
Description
Service Name
string
Name of the service that is associated with the
specified operation.
Total
string
Total number of objects processed for this schema
for a Publication Service.
Total number of objects received for this schema
for a Subscription Service.
Success
string
The number of objects that are successfully
identified for this schema, and are to be published
or written to a file.
Error
string
The number of objects that are identified for this
schema but are not published. This reason is that
the header of the schema fails in the validation for
Publication Service, or is written to a file because
the schema is not associated with the subscriber
for a Subscription Service.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
150
| Chapter 6
Monitoring the Adapter Using TIBCO Hawk
getActivityStatisticsBySchema(SchemaName)
Returns the total number of objects processed for the given schema by each
service that uses the schema. Also, returns the number of success and error
objects.
Parameter
Type
Description
Schema Name
string
Name of the schema.
Returns
Type
Description
Service Name
string
Name of the service that is associated with the
specified schema.
Total
string
Total number of objects processed for this schema
for a Publication Service.
Total number of objects received for this schema
for a Subscription Service.
Success
string
The number of objects that are successfully
identified for this schema, and are to be published
or written to a file.
Error
string
The number of objects that are identified for this
schema but are not published. This reason is that
the header of the schema fails in the validation for
Publication Service, or is written to a file because
the schema is not associated with the subscriber
for a Subscription Service.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
getActivityStatisticsByService(ServiceName) 151
|
getActivityStatisticsByService(ServiceName)
Returns the total number of objects processed for each of the schemas associated
with the specified service. Also, returns the number of success and error objects.
Parameter
Type
Description
Service Name
string
Name of the service.
Returns
Type
Description
Operation
string
Type of operation that the service performs.
Schema Name
string
Name of the schema that is associated with the
service.
Total
string
Number of objects processed for this schema for a
Publication Service.
Number of objects received for this schema for a
Subscription Service.
Success
string
The number of objects that are successfully
identified for this schema, and are to be published
or written to a file.
Error
string
The number of objects that are identified for this
schema but are not published. This reason is that
the header of the schema fails in the validation for
Publication Service, or is written to a file because
the schema is not associated with the subscriber
for a Subscription Service.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
152
| Chapter 6
Monitoring the Adapter Using TIBCO Hawk
getAdapterServicesInformation()
Returns information about the services implemented by this adapter. The
information is a summary of available adapter services.
Parameter
Type
Description
Service Name
string
Name of the service from which to get
information. Default is ALL.
Returns
Type
Description
Line
integer
Sequential row number.
Service Name
string
Name of the service defined at design-time.
Endpoint Name
string
Name of the endpoint used for this service.
Type
string
Type of the endpoint, for example, publisher or
subscriber.
Quality of
Service
string
Quality of service for the endpoint. For example,
RVCM or JMS Persistent.
Subject
string
Subject defined for this endpoint.
Class
string
Class associated with the endpoint.
Number of
Messages
integer
Number of messages processed for this endpoint.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
getComponents() 153
|
getComponents()
Returns information about the currently active TIBCO Hawk components such as
publishers, subscribers, or timers.
Input Parameters
Type
Description
Component Name
string
Name of the component. If no value is enter, all
components are displayed.
Component Type
string
Any of Publisher, Subscriber, Timer, or
The default value is All.
IODescriptor.
Returns
Type
Description
Instance ID
string
Name of this adapter instance defined at
design-time.
Adapter Name
string
Name of the adapter.
Component Name
string
Name of the component.
Component Type
string
The name of the TIBCO Adapter SDK class for
this component, such as Publisher,
Subscriber, or IODescriptorSource. For
more information about the class, see the
TIBCO Adapter SDK documentation.
Session Name
string
Name of the session.
Description
string
Information about this component, for
example, time interval, signal type, and
validating the publisher or subscriber.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
154
| Chapter 6
Monitoring the Adapter Using TIBCO Hawk
getConfig()
Retrieves generic configuration information. More specific configuration
information is accessed through separate methods.
Returns
Type
Description
Instance ID
string
Configuration ID of this adapter.
Adapter Name
string
Name of the adapter.
Repository
Connection
string
URL of the repository used for adapter instance.
Configuration
URL
string
Location of the adapter project. It is either a
filename or configuration URL.
Command
string
Command line arguments used to start the
adapter.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
getConfigProperties() 155
|
getConfigProperties()
Returns all attributes and elements for the given repository object.
Input Parameter
Type
Description
Property
string
Name of the property for which elements (tags)
and attributes are used. For example,
agentone/startup.
If no value is entered, all properties are
returned.
Returns
Type
Description
Element Name
string
Repository directory for the property.
Attribute Name
string
Name of the repository object attribute.
Attribute Value
string
Value of the repository object attribute.
Line
integer
Line number in which this property is defined
in the project file.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
156
| Chapter 6
Monitoring the Adapter Using TIBCO Hawk
getDocumentDelay()
Returns the document delay setting for a given Publication Service. If Publication
Service is not given, a list of Publication Services is returned with their
corresponding polling interval.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
getHostInformation() 157
|
getHostInformation()
Returns standard and extended application information set. It returns the
following information.
Returns
Type
Description
Name
string
Name of the property.
Value
string
Value of the property.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
158
| Chapter 6
Monitoring the Adapter Using TIBCO Hawk
getPollingInterval()
Returns the current polling interval setting.
Returns
Type
Description
PollingInterval
integer
Polling interval in milliseconds.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
getQueueStatistics() 159
|
getQueueStatistics()
Returns the current count of elements in any internal queue used by the adapter.
This includes the TIBCO Rendezvous event queues automatically spawned by
Rendezvous for each adapter.
Returns
Type
Description
QueueID
string
A unique identification of a particular queue.
QueueType
string
A type or key that matches this queue to a
thread or connection.
QueueCount
integer
Current number of elements in the queue.
MaxQueueSize
integer
Maximum number of elements in the queue.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
160
| Chapter 6
Monitoring the Adapter Using TIBCO Hawk
getRvConfig()
Returns information about the TIBCO Rendezvous session defined by this
adapter. Information about all currently defined sessions is returned if no
sessionName is provided.
Input
Parameter
Type
Description
Session Name
string
Name of the TIBCO Rendezvous session for
which configuration is required. If not given,
information about all sessions is returned. The
default value is All.
Returns
Type
Description
Instance ID
string
Configuration ID of this adapter.
Adapter Name
string
Name of the adapter.
Session Name
string
Name of the session.
Service
string
Service parameter for this session.
Daemon
string
Daemon parameter for this session.
Network
string
Network parameter for this session.
Synchronous?
boolean
Returns 1 if this is a synchronous session,
Returns 0 if this is an asynchronous session.
Session Type
string
Type of session; one of M_RV, M_RVCM, or
M_RVCMQ.
Certified Name
string
Name of the certified session.
Ledger File
string
Ledger file for the certified messaging session.
Returns the empty string for sessions that are
not certified messaging sessions.
CM Timeout
string
Timeout for the certified messaging session.
Returns the empty string for sessions that are
not certified messaging sessions.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
getStatus() 161
|
getStatus()
Retrieves basic status information about the adapter.
This information is fairly limited; for additional methods, see getConfig() on
page 154 and getRvConfig() on page 160.
Returns
Type
Description
Instance ID
string
Configuration ID for the adapter instance.
Adapter Name
string
Name of the adapter.
Uptime
integer
Time in seconds since startup.
Messages Received
integer
Number of TIBCO Rendezvous messages
received.
Messages Sent
integer
Number of TIBCO Rendezvous messages
published.
New Errors
integer
Number of errors since the last call to this
method.
Total Errors
integer
Total number of errors since startup.
Process ID
integer
Process ID of the application.
Host
string
Name of host machine on which the adapter is
running.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
162
| Chapter 6
Monitoring the Adapter Using TIBCO Hawk
getTraceSinks()
Returns information about sinks to which traces currently go.
Input
Parameters
Type
Description
Sink Name
string
Name of the sink for which you need information.
If no name is specified, information about all sinks
is returned. The default value is all.
Role Name
string
Name of the role for which you need information
for the specified sink or sinks. The default value is
all.
Returns
Type
Description
Instance ID
string
Name of this adapter instance.
Adapter Name
string
Name of the application for this sink.
Sink Name
string
Name of the sink.
Sink Type
string
The type of this sink. It is fileSink, rvSink,
or stderrSink.
hawkSink,
Roles
string
Roles supported by the sink. For example,
warning, error, or debug.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
getVersion() 163
|
getVersion()
Retrieves version information for the current application. Two lines are returned:
one for the TIBCO Adapter SDK, one for the adapter.
Returns
Type
Description
Instance ID
string
Configuration ID, for example, SDK.
Adapter Name
string
Name of the adapter, for example, agentone.
Version
string
Version number, for example, 5.5.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
164
| Chapter 6
Monitoring the Adapter Using TIBCO Hawk
_onUnsolictedMsg()
Displays all alert messages sent from the adapter or an error if not successful.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
preRegisterListener() 165
|
preRegisterListener()
Preregister an anticipated Subscription Service. Some applications anticipate
requests for certified delivery even before the listening applications start running.
In such situations, Publication Service preregisters Subscription Services, so
TIBCO Rendezvous software begins storing outbound messages in Publication
Service ledger. If the listening correspondent requires old messages, it receives the
backlogged messages when it requests certified deliver.
Input
Parameters
Type
Description
Session Name
string
Name of the session that anticipates the
listener.
Publisher Name
string
Name of the component for which the
listener are preregistered.
Listener Session
Name
string
Name of Subscription Service to preregister.
Returns OK if Subscription Service is preregistered successfully; otherwise, returns
false.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
166
| Chapter 6
Monitoring the Adapter Using TIBCO Hawk
resetActivityStatistics()
Resets all the counts for the activity statistics.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
reviewLedger() 167
|
reviewLedger()
Returns information retrieved from the ledger file of a TIBCO Rendezvous
certified messaging session.
Before invoking this method, ensure that the certified messaging publisher
adapter has established a certified delivery agreement with its subscriber agents.
Input
Parameters
Type
Description
Session Name
string
Name of the TIBCO Rendezvous session for
which ledger information is needed. The default
value is all.
Subject
string
Name of the subject for which ledger
information is needed.
Returns
Type
Description
Session Name
string
Name of the TIBCO Rendezvous CM session
to which this information applies.
Subject
string
Subject name for this session.
Last Sent Message
integer
Sequence number of the most recently sent
message with this subject name.
Total Messages
string
Total number of pending messages with this
subject name.
Total Size
integer
Total storage (in bytes) occupied by all
pending messages with this subject name.
If the ledger contains ten messages with this
subject name, this field sums the storage space
over all of them.
Listener Session
Name
string
Within each listener submessage, the Listener
Session Name field contains the name of the
delivery-tracking listener session.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
168
| Chapter 6
Monitoring the Adapter Using TIBCO Hawk
Returns (Cont’d)
Type
Description
Last Confirmed
string
Within each listener submessage, the Last
Confirmed field contains the sequence
number of the last message for which this
listener session confirmed delivery.
Line
integer
Row number in ledger file.
Unacknowledged
Messages
integer
Number of RVCM messages pending for this
listener. The value is computed by subtracting
the last sent sequence number from the last
acknowledged sequence number.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
setDocumentDelay() 169
|
setDocumentDelay()
Set the document delay for a Publication Service.
Input
Parameters
Type
Description
DocumentDelay
integer
Document delay time in milliseconds.
ServiceName
string
Name of Publication Service.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
170
| Chapter 6
Monitoring the Adapter Using TIBCO Hawk
setPollingInterval()
Set the polling interval for Publication Service.
Input
Parameters
Type
Description
PollingInterval
integer
Polling interval in milliseconds.
ServiceName
string
Name of service where the polling interval is
set.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
setTraceSinks() 171
|
setTraceSinks()
Adds a role or changes the file limit of a previously specified sink.
Input
Parameters
Type
Description
Sink Name
string
Name of the sink for which you want to add a
role or change the file limit.
Role Name
string
Name of the role you want to add to this sink
(warning, error, debug, or user defined). The
default value is all.
File Size
integer
Maximum file size for the sink.
This parameter is ignored if the sink specified
by sinkName is not a file sink.
Returns OK if successful; returns an error if not successful.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
172
| Chapter 6
Monitoring the Adapter Using TIBCO Hawk
stopApplicationInstance()
Stops the specified adapter by calling the internal stop() method. This method
returns OK if successful, and returns an error if not successful.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
unRegisterListener() 173
|
unRegisterListener()
Unregister a currently preregistered Subscription Service.
Input
Parameters
Type
Description
Session Name
string
Name of the session that anticipates
Subscription Service.
Publisher Name
string
Name of Publication Service, to which
Subscription Service is preregistered.
Listener Session
Name
string
Name of Subscription Service to be
unregistered.
This method returns true if Subscription Service is unregistered successfully.
Otherwise, it returns false.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
174
| Chapter 6
Monitoring the Adapter Using TIBCO Hawk
refreshExtendedLogging()
Refresh the Log4J log without restarting the adapter whenever changes are made
to the Log4J properties file.
Two log types are available: SDK log and Log4J log. By default, SDK log is used. If
you want to use Log4J log, you need to set properties to enable it.
To enable Log4J log, complete the following steps:
1. Set the adfiles.trace.extended property to ON.
This is to enable Log4J log.
2. Specify a path for the adfiles.trace.log4j.properties property, the
default path is %TIB_ADFILES_HOME%/bin/adfiles.log4j.properties.
This is to specify the path for the Log4J configuration file.
3. (Optional) Set the adfiles.trace.thread property to ON.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
| 175
Appendix A
Trace Messages
This appendix explains the trace messages that are logged to a location specified
at configuration time.
Topics
•
Overview, page 176
•
Trace Message Fields, page 178
•
Status Messages, page 180
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
176
| Appendix A
Trace Messages
Overview
Trace messages provide information about adapter activities. The messages are
logged to the console where the runtime adapter starts and to a log file. Trace
messages can also be redirected to the TIBCO Hawk Display application, or sent
to other applications using the TIBCO Rendezvous transport.
Each trace message includes the following fields:
<Timestamp> <Adapter Identifier> <Role> <Category> <Status Code>
<Tracking Identifier>
The above fields are explained in the Trace Message Fields on page 178. The
following diagram shows an example of trace message.
Timestamp
2014 Aug 01 15:14:30:706 GMT +800
Adapter Identifier
FileAdapter.FileAdapterConfiguration
Role Category
Info [Configuration]
Status Code
AEFA-000058 TIBCO Adapter for Files for Unix/Win sucessfully initialized
Tracking Identifier
tracking=#hwlgLn11Y4iND-Ba4dOcfbuUcZM#
Example of Trace Messages
The following trace messages are written during a session when TIBCO
ActiveMatrix Adapter for Files for Unix/Win publishes container messages.
The first message indicates that TIBCO ActiveMatrix Adapter for Files for
Unix/Win has started. The timestamp indicates when the adapter starts, and the
role indicates that the trace message is informational, which means the activity is
normal for the adapter. The category is identified, and the corresponding status
code is displayed. The status code indicates that the adapter started successfully.
2014 Aug 01 15:14:30:706 GMT +0800
FileAdapter.FileAdapterConfiguration Info [Configuration]
AEFA-000058 TIBCO Adapter for Files for Unix/Win successfully
initialized
The next set of trace messages indicates the adapter received a subject and wrote
it into the working directory. The #hwlgLnI1Y4iND-Ba4dQcfbuUcZM# tracking
identifier included in the trace message uniquely identifies the message.
2014 Aug 01 15:14:36:509 GMT +0800
FileAdapter.FileAdapterConfiguration Info [Adapter]
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Overview 177
|
AEFA-000067 Message containing class
/tibco/public/class/ae/FileAdapter/wire/FileAdapterConfiguration1/
Order received on subject ADFILE
tracking=#hwlgLnI1Y4iND-Ba4dQcfbuUcZM#FileAdapter#FileAdapterConfi
guration1#D:\adfile\reader\wip\delimited.txt#
2014 Aug 01 15:14:36:513 GMT +0800
FileAdapter.FileAdapterConfiguration Info [Adapter]
AEFA-000068 Message containing class
/tibco/public/class/ae/FileAdapter/wire/FileAdapterConfiguration1/
Order written to working file test.txt in Working Directory
D:\adfile\writer\wip
tracking=#hwlgLnI1Y4iND-Ba4dQcfbuUcZM#FileAdapter#FileAdapterConfi
guration1#D:\adfile\reader\wip\delimited.txt#
The final trace message indicates the adapter moved the received file to the
output directory. Because the trace message is the termination point, the tracking
identifier is not displayed.
2014 Aug 01 17065:15:30:733 GMT +0800
FileAdapter.FileAdapterConfiguration Info [Adapter]
AEFA-000070 File test.txt is moved to the Output Directory
D:\adfile\writer\output
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
178
| Appendix A
Trace Messages
Trace Message Fields
Each trace message includes the following fields:
Table 14 Tracing Fields
Field Name
Timestamp
Description
Timestamp of occurrence. For example, 2014
Aug 01 15:14:30:706 GMT
+800.
Adapter
Identifier
Name of the adapter that writes the trace message. This is a combination of the
adapter acronym and adapter configuration name. For example, the
application identifier, ADFILES.publisher1 identifies a TIBCO ActiveMatrix
Adapter for Files for Unix/Win service named publisher1.
Role
Trace messages can be one of the following roles:
•
Info Indicates normal adapter operation. No action is necessary. A trace
message tagged with info indicates that a significant processing step has
reached and been logged for tracking or auditing purposes. Only info
messages preceding a tracking identifier are considered significant steps.
•
Warn Indicates an abnormal condition is found. Processing will continue,
but special attention from an administrator is recommended.
•
Error Indicates an unrecoverable error occurs. Depending on the error
severity, the adapter continues with the next operation or stops.
•
Debug Indicates a developer defined trace message. In normal operating
conditions, debug messages are not displayed.
When configuring the adapter, you define the roles to be logged. For example,
to increase performance, you can decide not to log Info roles.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Trace Message Fields 179
|
Table 14 Tracing Fields (Cont’d)
Field Name
Description
Category
Trace message is grouped in one of the following categories:
•
Adapter The adapter is processing an event.
•
Configuration The adapter is reading configuration information.
•
Palette The adapter is interacting with the palette.
•
Publication Publication Service is reporting this trace message.
•
Shutdown The adapter is shutting down.
•
Startup The adapter is starting.
•
Subscription Subscription Service is reporting this trace message.
•
System This category is not linked to a specific event process. The trace
message is related to a Windows Service related messages, memory
allocation, file system error, and so on.
•
TibRvComm The adapter is communicating with TIBCO Rendezvous.
Status Code
Unique code for the message and description. Status codes are identified by a
unique number and description. If a trace message includes an error or warn
role, the status code documentation includes a resolution. See Status Messages
on page 180.
Tracking
Identifier
A unique identifier that is stamped on each message by the originating
adapter. The tracking identifier remains in effect from a message’s beginning
to its completion as it is exchanged by TIBCO applications. If the adapter is the
termination point of the message, the tracking identifier is not displayed in the
trace message.
You cannot modify the tracking identifier format or configure what
information is displayed.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
180
| Appendix A
Trace Messages
Status Messages
This section lists status messages of TIBCO ActiveMatrix Adapter for Files for
Unix/Win, which includes:
•
General Status Messages
•
Deprecated Status Messages
Any use of a deprecated status message should be discontinued as it may be
removed in a future release. You should avoid becoming dependent on
deprecated status messages.
General Status Messages
Table 15 lists the general status messages thrown by TIBCO ActiveMatrix Adapter
for Files for Unix/Win, with corresponding descriptions and resolutions.
Table 15 Status Messages (Sheet 1 of 21)
Status Code
Role
AEFA-000002
Out of memory
error
AEFA-000003
Check the system to find why it has run out of
memory.
Configuration
Find information on class definition in the
documentation. If that does not help, contact
TIBCO support.
Missing attribute for <attribute name> in the configuration
error
AEFA-000005
System
Resolution
Missing class definition for <class name> in the configuration
error
AEFA-000004
Category
Configuration
Find information on the missing attribute in
the documentation. If that does not help,
contact TIBCO support.
Attribute <attribute name> in the configuration has the wrong value
<attribute name>
error
Configuration
Enter a correct value for the attribute. If that
does not help, contact TIBCO support.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Status Messages 181
|
Table 15 Status Messages (Sheet 2 of 21)
Status Code
Role
AEFA-000007
Couldn’t open file <filename>
error
AEFA-000008
Check the file and the file system to find out
why the error occurred.
Configuration
Check whether the directory exists. If the
directory exists, modify the configuration to
point to the correct directory for the
Preprocessing Script File.
Configuration
Check whether the file exists. If the file exists,
modify the configuration to point to the correct
file and directory names for the Preprocessing
Script.
Configuration
Correct the configuration to point to the correct
file and directory names for the Postprocessing
Script of Publication Service.
No access to Input Directory <directory name>
error
AEFA-000015
System
Post-processing script file <filename> couldn’t be found
error
AEFA-000014
Check the file system to find why the file is not
closed.
Pre Processing Script File <filename> couldn’t be found
error
AEFA-000013
System
Pre Processing Script File directory <directory name> couldn’t be found
error
AEFA-000012
Check the file system to ensure that all of the
files exist and can be opened.
Couldn’t read file <filename>
error
AEFA-000011
System
Resolution
Couldn’t close file <filename>
error
AEFA-000009
Category
Configuration
Create the Input Directory or allow access to it.
No access to Working Directory <directory name>
error
Configuration
Create the Working Directory or allow access
to it.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
182
| Appendix A
Trace Messages
Table 15 Status Messages (Sheet 3 of 21)
Status Code
Role
AEFA-000016
No access to Completion Directory <directory name>
error
AEFA-000017
Check the file system to find out why the error
occurs.
System
Check the Trigger File rights and the file
system state to find out why the error occurs.
System
Check the working data file rights and the file
system state to find out why the error occurs.
Adapter
Check the existence of the input data file and
the input data file rights.
Cannot open input data file <filename> on CheckPoint Restart
error
AEFA-000026
System
Cannot find input data file <filename> matching Trigger File <filename> in
Input Directory <directory name>
error
AEFA-000025
Remove the duplicate file from the Working
Directory.
Cannot open data file <filename> in Working Directory <directory name>
error
AEFA-000024
Adapter
Cannot remove Trigger File <filename> from Input Directory <directory
name>
error
AEFA-000023
Create the Completion Directory or allow
access to it.
Cannot remove file <filename> from Working Directory <directory name>
warn
AEFA-000022
Configuration
Resolution
Working file <filename> already exists
error
AEFA-000019
Category
Adapter
Check the existence of the input data file, the
input data file rights, and the content of the
CheckPoint Restart file.
User exit failed for Publication Service <service name> Input file =
<filename>; Message = <data message>
error
Adapter
Check the User exit server to find out why the
error occurs.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Status Messages 183
|
Table 15 Status Messages (Sheet 4 of 21)
Status Code
Role
AEFA-000027
User exit timed out for Publication Service <service name>
error
AEFA-000028
Configuration
Check if the publisher is sending an MInstance.
Adapter
Check whether the schema of Subscription
Service matches the incoming message.
Metadata
Configure the class in your Subscription
Service or change its subject address.
System
Check the file system to find out why the error
occurs.
No access to Working Directory <directory name>
error
AEFA-000036
Check whether the User exit server is running.
Received message couldn’t be written to a file
error
AEFA-000035
Adapter
No formatting defined for class <class name>
error
AEFA-000034
Check the User exit server to find out why the
error occurs.
Deserialisation failed for Subscription Service <service name>
error
AEFA-000033
Adapter
Deserialisation failed for Subscription Service <service name>
error
AEFA-000032
Check whether the User exit server is running.
User exit timed out for Subscription Service <service name>
error
AEFA-000030
Adapter
Resolution
User exit failed for Subscription Service <service name>
error
AEFA-000029
Category
Configuration
Create the Working Directory or allow access
to it.
No access to Completion Directory <directory name>
error
Configuration
Create the Completion Directory or allow
access to it.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
184
| Appendix A
Trace Messages
Table 15 Status Messages (Sheet 5 of 21)
Status Code
Role
AEFA-000037
No access to Error Directory <directory name>
error
AEFA-000038
System
Check the file system state to find out why the
error occurs.
System
Check the file system state to find out why the
error occurs.
System
Check the file system state to find out why the
error occurs.
Configuration
Check whether the directory of the
Postrocessing Script File for Subscription
Service exists and is readable.
Post Processing Script file <filename> couldn’t be found
error
AEFA-000045
Check the file system state to find out why the
error occurs.
Post Processing Script file directory <directory name> couldn’t be found
error
AEFA-000044
System
Cannot add TimeStamp to file <filename> in directory <directory name>
error
AEFA-000043
Check the file system state to find out why the
error occurs.
Cannot move file <filename> to Error Directory <directory name>
error
AEFA-000042
System
Cannot move file <filename> to Output Directory <directory name>
error
AEFA-000041
Create the Error Directory or allow access to it.
Cannot create file <filename> in Working Directory <directory name>
error
AEFA-000040
Configuration
Resolution
Cannot write file <filename> in Working Directory <directory name>
error
AEFA-000039
Category
Configuration
Check whether the Postprocessing Script File
of Subscription Service exists and is readable.
Pre Processing Script <command string> returned error code <status string>
warn
System
Check the Preprocessing script.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Status Messages 185
|
Table 15 Status Messages (Sheet 6 of 21)
Status Code
Role
AEFA-000046
Post Processing script <command string> returned error code <status string>
warn
AEFA-000047
Either modify an existing File Record to match
this input line or create a new one. Make sure
that the File Record is linked to a Read Schema.
Adapter
Check if the input line is valid. If valid, modify
the File Record to interpret it correctly.
TibRvComm
Check the format of data sent by other
applications on the subject that this
Subscription Service is listening on.
Metadata
Check for any discrepancy between the
incoming class and the Write Schema.
Attribute <attribute name> of class <class name> is of an unsupported type
warn
AEFA-000054
Adapter
Attribute <attribute name> of class <class name> is of an unsupported type
warn
AEFA-000053
Assign a Read Schema to the File Record.
Subscription Service <service name> received an unexpected message. Type
<event type>. Data <event data>.
warn
AEFA-000052
Configuration
File <filename> has been parsed, <number of error records> lines couldn’t
be interpreted
warn
AEFA-000051
Check the Postprocessing Script of Publication
Service.
<input record> couldn’t be parsed
warn
AEFA-000049
System
Resolution
<class name> will not be published since no Publication Service could be
found
warn
AEFA-000048
Category
Metadata
Change the input class and ensure that it only
includes supported types.
File <filename> already exists in Working Directory <directory name>
warn
Adapter
Remove the file from the Input Directory.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
186
| Appendix A
Trace Messages
Table 15 Status Messages (Sheet 7 of 21)
Status Code
Role
AEFA-000055
File <filename> has been created in Output Directory <directory name> due
to an input message time out
warn
AEFA-000056
Configuration
No action.
Adapter
No action.
Adapter
No action.
Adapter
No action.
Invoke postprocessing script \"[%1]\"
info
AEFA-000063
Check the content of your input and output
data, check your logs for unsent data, and
check if only one publisher is sending data.
Invoke preprocessing script \"[%1]\"
info
AEFA-000062
Adapter
Processing input file <filename> in Input Directory <directory name>
info
AEFA-000061
Check the Postprocessing Script File to make
sure that it is valid and returned an error
correctly.
Scanning Input Directory <directory name>
info
AEFA-000060
System
TIBCO Adapter for Files for Unix/Win successfully initialized
info
AEFA-000059
If Subscription Service is not supposed to have
timed out, you need to check your publisher to
find out why the publications are delayed.
<number of messages> messages have been published from file <filename>
while <number of messages> have been written
warn
AEFA-000058
Adapter
Resolution
Post Processing script <command string> returned error code <status string>
warn
AEFA-000057
Category
Adapter
No action.
Publication of file <filename> is finished.
info
Adapter
No action.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Status Messages 187
|
Table 15 Status Messages (Sheet 8 of 21)
Status Code
Role
AEFA-000064
File <filename> has been processed, all lines were interpreted
info
AEFA-000065
No action.
Adapter
No action.
Adapter
No action.
Adapter
No action.
Configuration
Contact TIBCO support if you encounter any
problem due to migration.
Subscription Service <service name> received an MBusinessDocument in
which the DataSection attribute was not set.
info
AEFA-000074
Adapter
Multiple publisher mode used
warn
AEFA-000073
No action.
Invoke postprocessing script \"[%1]\"
info
AEFA-000072
Adapter
File <filename> is moved to the Output Directory <directory name>
info
AEFA-000071
No action.
<number of messages> messages have been published and received from
file <filename>
info
AEFA-000070
Adapter
Message containing class <class name> written to working file <filename>
in Working Directory <directory name>
info
AEFA-000069
No action.
Message containing class <class name> received on subject <subject name>
info
AEFA-000068
Adapter
Resolution
Message containing class <class name> published on subject <subject
name> (message is from file <filename>)
info
AEFA-000067
Category
Adapter
No action.
The line "<input record>" contains an invalid field
error
Adapter
Correct the invalid field.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
188
| Appendix A
Trace Messages
Table 15 Status Messages (Sheet 9 of 21)
Status Code
Role
AEFA-000075
Could not create simple datetime class. Received error code <error code>
error
AEFA-000076
Adapter
No action.
Adapter
No action.
Adapter
No action.
Adapter
No action.
Post Processing Script <command string> returned message <status string>
info
AEFA-000084
Invalid pattern or locale mismatch is the main
cause for this error.
Post Processing Script <command string> returned message <status string>
info
AEFA-000083
Adapter
Pre Processing Script <command string> returned message <status string>
info
AEFA-000082
Invalid pattern or locale mismatch is the main
cause for this error.
Processing file <filename>...
info
AEFA-000081
Adapter
File <filename> has been parsed. Total: <number of total records> lines,
Error: <number of error records> lines, <file size>bytes
info
AEFA-000080
Unsupported location is the main cause for this
error.
Failed to format the datetime value to the specified pattern <datetime
pattern>. Received error code <error code>
error
AEFA-000079
Adapter
Resolution
Failed to parse the datetime string <datetime string> for the pattern
specified <datetime pattern>. Received error code <error code>
error
AEFA-000077
Category
Adapter
No action.
Skip processing file <filename> at the request of the preprocessing script.
info
Adapter
No action.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Status Messages 189
|
Table 15 Status Messages (Sheet 10 of 21)
Status Code
Role
AEFA-000085
Subscriber name = <subscriber name>, subscriber status = <subscriber
status>
debug
AEFA-000086
Adapter
No action.
Adapter
No action.
Adapter
No action.
Adapter
No action.
Adapter
No action.
IO error detected
error
AEFA-000103
No action.
Checksum mismatch with the published file
warn
AEFA-000102
Adapter
[%1]: expected sequence [%2] does not match incoming data’s [%3]
warn
AEFA-000100
No action.
[%1]: expected sequence [%2] matches incoming data
debug
AEFA-000099
Adapter
Subscriber is in restart mode and is using [%1] progress file
debug
AEFA-000098
No action.
[%1] is publishing data on subj [%2]
debug
AEFA-000097
Adapter
[%1] is preparing data to be published
debug
AEFA-000089
No action.
Simple file transfer is running in ECM mode
debug
AEFA-000088
Adapter
Resolution
Publisher is in restart mode and is using [%1] progress file
debug
AEFA-000087
Category
Adapter
No action.
[%1]: beginning transfer of new file
debug
Adapter
No action.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
190
| Appendix A
Trace Messages
Table 15 Status Messages (Sheet 11 of 21)
Status Code
Role
AEFA-000104
[%1] received message
debug
AEFA-000116
Adapter
No action.
Adapter
No action.
Configuration
Create the Input Directory or allow access to it.
Configuration
No action.
Configuration
No action.
File prefix to process is reset to <file prefix>
info
AEFA-000129
Create the Error Directory or allow access to it.
filename to process is reset to <filename>
info
AEFA-000128
Configuration
Input directory is successfully changed to <directory name>
info
AEFA-000127
No action.
Cannot reset input directory to <directory name>. The directory does not
exist or cannot be accessed
error
AEFA-000126
Adapter
[%1] is discarding duplicate message
debug
AEFA-000125
No action.
[%1] completed publishing data
debug
AEFA-000124
Adapter
No access to Error Directory <directory name>
error
AEFA-000121
No action.
Cannot process messages due to version mismatch. Product version =
<version number>. Received message version = <version number>
error
AEFA-000118
Adapter
Resolution
File <filename> is moved to the Error Directory <directory name>
info
AEFA-000117
Category
Configuration
No action.
File extension to process is reset to <file extension>
info
Configuration
No action.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Status Messages 191
|
Table 15 Status Messages (Sheet 12 of 21)
Status Code
Role
AEFA-000130
The message contains no data field as this may be the last packet for the file
being transfered
debug
AEFA-000132
No action.
Configuration
Remove the progress file and restart the
adapter.
Adapter
Check the advisory message.
System
Check the file system state to find out why the
error occurs.
Polling subscriber endpoint is not defined
error
AEFA-000138
Configuration
Cannot add sequence number to file <filename> in directory <directory
name>
error
AEFA-000137
No action.
Received advisory message. Role: <role name>, Subject: <subject name>,
Message: <message string>
error
AEFA-000136
Configuration
The progress file <filename> is corrupt
error
AEFA-000135
No action.
Publisher is started Simple File Transfer mode
info
AEFA-000134
Configuration
Resolution
Subscriber is started Simple File Transfer mode
info
AEFA-000133
Category
Adapter
The file palette generates the polling subscriber
endpoint. The name of the endpoint is
FAPollingSubscriberServiceName.
Subscriber <Subscription Service name> is experiencing IO Error. The
publisher will deactivate the subscriber for the current file transfer and will
reactivate the subscriber on a new file transfer
error
Adapter
If the IO error is temporary, the subscriber will
automatically come back up; if the IO error is
permanent, stop the subscriber, resolve the IO
error, and restart the subscriber.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
192
| Appendix A
Trace Messages
Table 15 Status Messages (Sheet 13 of 21)
Status Code
Role
AEFA-000139
Progress filename is empty. Verify configuration and set a valid progress
filename
error
AEFA-000140
Adapter
No action.
Adapter
Check the existence of the data file, the data file
rights, and the content of the progress file.
Adapter
Check the file system and find out the reason.
Configuration
Check whether the schema is missing in the
configuration.
Starting offset [%1] is greater than the actual file size!
error
AEFA-000150
No action.
Service contains no schema.
error
AEFA-000149
Adapter
[1%]
error
AEFA-000148
Set a valid progress filename using the
designer and restart the publisher. Only
LATIN_1 encoded filenames are valid.
Cannot open the data file <filename> specified in the progress file on
publisher restart
error
AEFA-000147
Adapter
[%1]: message details: [%2]
debug
AEFA-000143
Set a valid progress filename using the
designer and restart the publisher.
The message is rejected as the subscriber is waiting on a new file boundary
debug
AEFA-000142
Adapter
Resolution
IOError received when accessing progress file. Verify if progress filename is
valid
error
AEFA-000141
Category
Adapter
No action.
Processing script [%1] not found.
warn
Adapter
Check the file system and find out the reason.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Status Messages 193
|
Table 15 Status Messages (Sheet 14 of 21)
Status Code
Role
AEFA-000151
Received trigger message, but no file was found.
warn
AEFA-000153
No action.
Adapter
No action.
Adapter
No action.
Adapter
No action.
Adapter
No action.
Adapter
No action.
Adapter
No action.
[%1]
warn
AEFA-000161
Adapter
[%1]
info
AEFA-000160
No action.
[%1]
debug
AEFA-000159
Adapter
[%1] The input parameter [%2] is wrongly field [%3]
error
AEFA-000158
No action.
The trigger message [%s] was invalid and was discarded.
info
AEFA-000157
Adapter
The trigger message contained invalid input directory [%1]. The message
was discarded.
info
AEFA-000156
Check the file system and find out the reason.
The trigger message does not mention the input file name therefore use the
input file name currently in-effect \"[%1]\" .
info
AEFA-000155
Adapter
Resolution
The trigger message does not mention the input directory therefore use the
input directory currently in-effect \"[%1]\" .
info
AEFA-000154
Category
[%1]
error
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
194
| Appendix A
Trace Messages
Table 15 Status Messages (Sheet 15 of 21)
Status Code
Role
AEFA-000162
File [%1] has been parsed. Total: [%2] bytes.
info
AEADFILES_920
001
Subscription
Check the configuration of the application that
is publishing the event and make sure that it
matches the inbound event definition for the
above Subscription Service. For details on the
configuration of Subscription Service, see
TIBCO ActiveMatrix Adapter for Files for
Unix/Win User’s Guide.
Subscription
Check the configuration of the application that
is publishing the event and make sure that it
matches the inbound event definition for the
above Subscription Service. For details on the
configuration of Subscription Service, see
TIBCO ActiveMatrix Adapter for Files for
Unix/Win User’s Guide.
Subscription error. <service name, subject name, repourl, configurl>
received inbound event with null data.
error
AEADFILES_920
004
No action.
[1%] failed to deserialize the received event. SDK exception thrown is [%2]
error
AEADFILES_920
003
Adapter
Resolution
Subscription error. <service name, subject name, repourl, configurl>
received an invalid event.
error
AEADFILES_920
002
Category
Subscription
Check the configuration of the application that
is publishing the event and make sure that it
matches the inbound event definition for the
above Subscription Service. For details on the
configuration of Subscription Service, see
TIBCO ActiveMatrix Adapter for Files for
Unix/Win User’s Guide.
Subscription Service <Subscription Service name> received an
MBusinessDocument <business document> in which the DataSection
attribute was not set.
info
Subscription
No action.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Status Messages 195
|
Table 15 Status Messages (Sheet 16 of 21)
Status Code
Role
AEADFILES_920
005
Subscription error. <error message> could not deserialize the inbound event
to MBusinessDocument <name of the business document>
error
AEADFILES_920
007
Subscription
Resolution
Check the configuration of the application that
is publishing the event and make sure that it
matches the inbound event definition for the
above Subscription Service. For details on the
configuration of Subscription Service, see
TIBCO ActiveMatrix Adapter for Files for
Unix/Win User's Guide.
Subscription error. Subscription Service <service name> listening on subject
<subject name> could not get the class description of <class name>.
<repoUrl and configUrl parameters>.
error
AEADFILES_920
009
Category
Subscription
Check the repository configuration for this
service. For details on how to configure, run
and test Subscription Service, see TIBCO
ActiveMatrix Adapter for Files for Unix/Win
User’s Guide.
Subscription error. <service name, subject name, repourl, configurl>
received event with invalid value <attribute value> for property <attribute
name> in class <class name>.
error
Subscription
Check the configuration of the application that
is publishing the event and make sure that it
matches the inbound event definition for the
above Subscription Service. For details on the
configuration of Subscription Service, see
TIBCO ActiveMatrix Adapter for Files for
Unix/Win User’s Guide.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
196
| Appendix A
Trace Messages
Table 15 Status Messages (Sheet 17 of 21)
Status Code
Role
AEADFILES_920
010
Subscription error. <service name, subject name, repourl, configurl>
received event with missing attribute <attribute name> in class <class
name>.
error
AEADFILES_920
012
Check the configuration of the application that
is publishing the event and make sure that it
matches the inbound event definition for the
above Subscription Service. For details on the
configuration of Subscription Service, see
TIBCO ActiveMatrix Adapter for Files for
Unix/Win User’s Guide.
Subscription
Check the configuration of the application that
is publishing the event and make sure that it
matches the inbound event definition for the
above Subscription Service. For details on the
configuration of Subscription Service, see
TIBCO ActiveMatrix Adapter for Files for
Unix/Win User’s Guide.
Subscription error. Subscription Service <service name> listening on subject
<subject name> failed due to target application invocation error <error
description>. Target application is FILES. The target application specific
commands and parameters are <command name>
error
AEADFILES_920
020
Subscription
Resolution
Subscription error. <service name, subject name, repourl, configurl>
received MBusinessDocument <business document name> with NULL
value for attribute <attribute name>.
error
AEADFILES_920
015
Category
Subscription
Check whether the directory or file exists and
that the permission is set properly.
Subscription error. <service name, subject name, repourl, configurl>
received an event from the wire but encountered error <error description> in
pre-processing user exit invocation. The User exit is <userexit client name>.
The event details are <class name>.
error
Subscription
Check whether the parameters passed to the
UserExit are valid and whether the User Exit
can be invoked by the adapter.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Status Messages 197
|
Table 15 Status Messages (Sheet 18 of 21)
Status Code
Role
AEADFILES_920
021
[%1] set JMS Message Selector \"[%2]\"
error
AEADFILES_930
002
No action.
Publication
Check whether the directory or file exists and
whether the permission is set correctly.
Publication error. Publication Service <service name> with publishing
subject as <subject name> received from target application FILES. It failed
while converting event to MInstance as it could not get the class description
for <class name>. <repourl, configurl>.
error
AEADFILES_930
004
Subscription
Resolution
Publication error. Publication Service <service name> with publication
subject <subject name> encountered error <error description>.
error
AEADFILES_930
003
Category
Publication
Verify the configuration of Publication Service
and check that the schema/class definitions are
present in the repository. For details on how to
configure a Publication Service, see TIBCO
ActiveMatrix Adapter for Files for Unix/Win
User’s Guide.
Publication error. <service name, subject name, repourl, configurl> received
event from target application FILES. It failed while converting event to
MInstance as it could not find property <attribute name> in class <class
name>.
error
Publication
Verify the configuration of Publication Service
and check that the schema definitions are
present in the repository. For details on how to
configure a Publication Service, see TIBCO
ActiveMatrix Adapter for Files for Unix/Win
User’s Guide.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
198
| Appendix A
Trace Messages
Table 15 Status Messages (Sheet 19 of 21)
Status Code
Role
AEADFILES_930
005
Publication error. <service name, subject name, repourl, configurl> received
event from target application FILES. It failed while converting event to
MInstance as property <attribute name> of class <class name> has invalid
value <attribute value>.
error
AEADFILES_930
006
Publication
Resolution
Verify the configuration of Publication Service
and check that the schema definitions are
present in the repository. For details on how to
configure a Publication Service, see TIBCO
ActiveMatrix Adapter for Files for Unix/Win
User’s Guide.
Publication error. <service name, subject name, repourl, configurl> It failed
while converting event to MInstance. Attribute <attribute name> of class
<class name> is missing.
error
AEADFILES_930
007
Category
Publication
Verify the configuration of Publication Service
and check that the schema definitions are
present in the repository. For details on how to
configure a Publication Service, see TIBCO
ActiveMatrix Adapter for Files for Unix/Win
User’s Guide.
Publication error. <service name, subject name, repourl, configurl> received
event from target application but could not create the business document
<business document name>. The target application details are <class name>.
error
Publication
Verify the configuration of Publication Service
and check that the schema definitions for the
MBusinessDocument maps properly to the
event received from the target application. For
details on how to configure a Publication
Service, see TIBCO ActiveMatrix Adapter for
Files for Unix/Win User’s Guide.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Status Messages 199
|
Table 15 Status Messages (Sheet 20 of 21)
Status Code
Role
AEADFILES_930
008
Publication error. <service name, subject name, repourl, configurl> received
SDK Exception <error description> while converting the event received
from target application to BusinessDocument. The exception occurred while
setting the attribute <attribute name>. The target application details are
<class name>.
error
AEADFILES_930
009
Publication
Resolution
Verify the configuration of Publication Service
and check that the schema definitions for the
MBusinessDocument maps properly to the
event received from the target application. For
details on how to configure a Publication
Service, see TIBCO ActiveMatrix Adapter for
Files for Unix/Win User’s Guide.
Publication error. <service name, subject name, repourl, configurl> received
an event from the target application but encountered error <error
description> in pre-processing user exit invocation. The User exit is
<userexit client name>. The target application details are <class name>.
error
AEADFILES_930
014
Category
Publication
Check whether the parameters passed to the
UserExit are valid and the User Exit can be
invoked by the adapter.
Publication error. <service name, subject name, repourl, configurl> received
error while sending event over the wire. The Publish endpoint details are
<error description>
error
Publication
Check whether the repository settings for the
configuration of the publish endpoint is valid
for the service. For details on setting up a
Publication Service and a publish endpoint, see
TIBCO ActiveMatrix Adapter for Files for
Unix/Win User’s Guide.
AEADFILES_930
016
Publication", "[%1] cannot create RegEx matcher for pattern [%2]
AEADFILES_930
017
Notice: [%1]
error
info
Publication
Check whether the configured pattern is valid.
Publication
No acton.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
200
| Appendix A
Trace Messages
Table 15 Status Messages (Sheet 21 of 21)
Status Code
Role
AEADFILES_930
018
matched file <file name>, with timely file size <size value> bytes.
info
AEADFILES_980
001
No action.
System
Check the system memory usage.
Shutdown error. SDK cleanup exception = <error description>
error
AEADFILES_990
003
Publication
Resolution
<function name> Running out of memory when trying to create a new
object. Shutting down...
error
AEADFILES_990
002
Category
Shutdown
Check the system resource.
Shutdown error. Failed to cleanup Hawk microagent. SDK exception =
<error description>
error
Shutdown
Check the system resource.
Deprecated Status Messages
Table 16 lists deprecated status messages in TIBCO ActiveMatrix Adapter for
Files for Unix/Win 7.0.
Table 16 Deprecated Status Messages (Sheet 1 of 7)
Status Code
Role
AEFA-000002
Out of memory
error
AEFA-000007
System
Resolution
Check the system to find why it has run out of
memory.
Couldn’t open file <filename>
error
AEFA-000008
Category
System
Check the file system to ensure that all of the
files exist and can be opened.
Couldn’t close file <filename>
error
System
Check the file system to find why the file has
not closed.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Status Messages 201
|
Table 16 Deprecated Status Messages (Sheet 2 of 7)
Status Code
Role
AEFA-000009
Couldn’t read file <filename>
error
AEFA-000011
Check whether the file exists. If the file exists,
modify the configuration to point to the correct
file and directory names for the Preprocessing
Script.
Configuration
Correct the configuration to point to the correct
file and directory names for the Postprocessing
Script of Publication Service.
Configuration
Create the Input Directory or allow access to it.
Configuration
Create the Working Directory or allow access to
it.
No access to Completion Directory <directory name>
error
AEFA-000026
Configuration
No access to Working Directory <directory name>
error
AEFA-000016
Check whether the directory exists. If the
directory exists, modify the configuration to
point to the correct directory for the
Preprocessing Script File.
No access to Input Directory <directory name>
error
AEFA-000015
Configuration
Post-processing script file <filename> couldn’t be found
error
AEFA-000014
Check the file and the file system to find out
why the error occurred.
Pre Processing Script File <filename> couldn’t be found
error
AEFA-000013
System
Resolution
Pre Processing Script File directory <directory name> couldn’t be found
error
AEFA-000012
Category
Configuration
Create the Completion Directory or allow
access to it.
User exit failed for Publication Service <service name> Input file =
<filename>; Message = <data message>
error
Adapter
Check the User exit server to find out why the
error occurs.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
202
| Appendix A
Trace Messages
Table 16 Deprecated Status Messages (Sheet 3 of 7)
Status Code
Role
AEFA-000027
User exit timed out for Publication Service [%1]. Input file = [%2]; Message =
[%3]
error
AEFA-000028
System
Check the file system to find out why the error
occurs.
Configuration
Check whether the directory of the
Postrocessing Script File for Subscription
Service exists and is readable.
Configuration
Assign a Read Schema to the File Record.
Configuration
Contact TIBCO support if you encounter any
problem due to migration.
Failed to format the datetime value to the specified pattern <datetime
pattern>. Received error code <error code>
error
AEFA-000080
Check whether the User exit server is running.
Multiple publisher mode used
warn
AEFA-000077
Adapter
<class name> will not be published since no Publication Service could be
found
warn
AEFA-000072
Check the User exit server to find out why the
error occurs.
Post Processing Script file directory <directory name> couldn’t be found
error
AEFA-000047
Adapter
Received message couldn’t be written to a file
error
AEFA-000043
Check whether the User exit server is running.
User exit timed out for Subscription Service <service name>
error
AEFA-000034
Adapter
Resolution
User exit failed for Subscription Service <service name>
error
AEFA-000029
Category
Adapter
Invalid pattern or location mismatch is the
main cause for this error.
Processing file <filename>...
info
Adapter
No action.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Status Messages 203
|
Table 16 Deprecated Status Messages (Sheet 4 of 7)
Status Code
Role
AEFA-000085
Subscriber name = [%1], subscriber status = [%2]
debug
AEFA-000087
Adapter
No action.
Adapter
No action.
Adapter
No action.
Adapter
No action.
Configuration
Create the Error Directory or allow access to it.
[%1] is discarding duplicate message
debug
AEFA-000130
No action.
No access to Error Directory <directory name>
error
AEFA-000124
Adapter
[%1] received message
debug
AEFA-000118
No action.
[%1]: beginning transfer of new file
debug
AEFA-000104
Adapter
Checksum mismatch with the published file
warn
AEFA-000103
No action.
[%1]: expected sequence [%2] does not match incoming data's [%3]
warn
AEFA-000100
Adapter
[%1]: expected sequence [%2] matches incoming data
debug
AEFA-000099
No action.
Subscriber is in restart mode and is using [%1] progress file
debug
AEFA-000098
Adapter
Resolution
Simple file transfer is running in ECM mode.
debug
AEFA-000097
Category
Adapter
No action.
The message contains no data field as this may be the last packet for the file
being transfered
debug
Configuration
No action.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
204
| Appendix A
Trace Messages
Table 16 Deprecated Status Messages (Sheet 5 of 7)
Status Code
Role
AEFA-000134
The progress file <filename> is corrupt
error
AEFA-000138
Adapter
Set a valid progress filename using the designer
and restart the publisher.
Adapter
Set a valid progress filename using the designer
and restart the publisher. Only LATIN_1
encoded filenames are valid.
Adapter
Check the existence of the data file, the data file
rights, and the content of the progress file.
Processing script [%1] not found.
warn
AEFA-000156
If the IO error is temporary, the subscriber will
automatically come back up; if the IO error is
permanent, stop the subscriber, resolve the IO
error, and restart the subscriber.
Cannot open the data file <filename> specified in the progress file on
publisher restart
error
AEFA-000150
Adapter
IOError received when accessing progress file. Verify if progress filename is
valid
error
AEFA-000143
Remove the progress file and restart the
adapter.
Progress filename is empty. Verify configuration and set a valid progress
filename
error
AEFA-000140
Configuration
Resolution
Subscriber <Subscription Service name> is experiencing IO Error. The
publisher will deactivate the subscriber for the current file transfer and will
reactivate the subscriber on a new file transfer
error
AEFA-000139
Category
Adapter
Check the file system and find out the reason.
The trigger message [%s] was invalid and was discarded.
info
Adapter
No action.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Status Messages 205
|
Table 16 Deprecated Status Messages (Sheet 6 of 7)
Status Code
Role
AEADFILES_92
0010
Subscription error. <service name, subject name, repourl, configurl> received
event with missing attribute <attribute name> in class <class name>.
error
AEADFILES_92
0020
Check the configuration of the application that
is publishing the event and make sure that it
matches the inbound event definition for the
above Subscription Service. For details on the
configuration of Subscription Service, see
TIBCO ActiveMatrix Adapter for Files for
Unix/Win User’s Guide.
Subscription
Check whether the parameters passed to the
UserExit are valid and whether the User Exit
can be invoked by the adapter.
[%1] set JMS Message Selector \"[%2]\"
error
AEADFILES_93
0004
Subscription
Resolution
Subscription error. <service name, subject name, repourl, configurl> received
an event from the wire but encountered error <error description> in
pre-processing user exit invocation. The User exit is <userexit client name>.
The event details are <class name>.
error
AEADFILES_92
0021
Category
Subscription
No action.
Publication error. <service name, subject name, repourl, configurl> received
event from target application FILES. It failed while converting event to
MInstance as it could not find property <attribute name> in class <class
name>.
error
Publication
Verify the configuration of Publication Service
and check that the schema definitions are
present in the repository. For details on how to
configure a Publication Service, see TIBCO
ActiveMatrix Adapter for Files for Unix/Win User’s
Guide.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
206
| Appendix A
Trace Messages
Table 16 Deprecated Status Messages (Sheet 7 of 7)
Status Code
Role
AEADFILES_93
0005
Publication error. <service name, subject name, repourl, configurl> received
event from target application FILES. It failed while converting event to
MInstance as property <attribute name> of class <class name> has invalid
value <attribute value>.
error
AEADFILES_93
0009
Verify the configuration of Publication Service
and check that the schema definitions are
present in the repository. For details on how to
configure a Publication Service, see TIBCO
ActiveMatrix Adapter for Files for Unix/Win User’s
Guide.
Publication
Check whether the parameters passed to the
UserExit are valid and whether the User Exit
can be invoked by the adapter.
Publication", "[%1] cannot create RegEx matcher for pattern [%2]
error
AEADFILES_98
0001
Publication
Resolution
Publication error. <service name, subject name, repourl, configurl> received
an event from the target application but encountered error <error
description> in pre-processing user exit invocation. The User exit is <userexit
client name>. The target application details are <class name>.
error
AEADFILES_93
0016
Category
Publication
Check whether the configured pattern is valid.
<function name> Running out of memory when trying to create a new object.
Shutting down...
error
System
Check the system memory usage.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
| 207
Appendix B
Adapter Properties File
This appendix introduces the adapter TRA file.
Topics
•
Overview, page 208
•
Properties File Format, page 209
•
Predefined Properties, page 210
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
208
| Appendix B
Adapter Properties File
Overview
The runtime adapter parses a properties file at startup. The default runtime
adapter properties file is named adfilesagent.tra.
The default properties file is located in the TIB_ADFILES_HOME\bin directory.
Each line in a properties file is a single property. Each property consists of a key
and a value. The key starts with the first non-whites pace character and ends with
the first "=", ":", or whites space character.
Properties defined in the properties file override the same properties defined in
the project.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Properties File Format 209
|
Properties File Format
The following restrictions apply to properties:
•
The "!" character is not used as a comment line indicator. Only the "#"
character is recognized.
•
The line continuation character is ignored (a value must fit on a line).
•
The key does not contain any of the termination characters. The adapter does
not support this syntax.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
210
| Appendix B
Adapter Properties File
Predefined Properties
Table 17 lists the predefined properties for TIBCO ActiveMatrix Adapter for Files
for Unix/Win.
All paths inside a properties file, including Microsoft Windows directory names,
must use forward slashes.
Table 17 Predefined Properties for TIBCO ActiveMatrix Adapter for Files for Unix/Win (Sheet 1 of 6)
Property
Description
adfiles.traceOldMessages
Either ON or OFF. The default value is OFF.
When it is set to ON, it enables 4.x style log messages and
disables 5.x style log messages.
adfiles.EEMEnabled
Either ON or OFF. The default value is OFF.
It enables or disables Business Event Messages. On how to
use this property, see Business Event Messages on page 122.
adfiles.perfMon
Either ON or OFF. The default value is OFF.
When it is set to ON, it enables to collect various statistics for
the adapter at runtime.
adfiles.addCustomHawkMethodsT
oClassMAgent
adfiles.SFTUseJMSMapMsg
Either ON or OFF. The default value is OFF.
When it is set to ON, it allows to add specfic methods to the
standard microagent of the adapter.
Either ON or OFF. The default value is OFF.
When it is set to ON, it enables to exchange JMS map
messages in the SFT mode.
adfiles.trace.devdebug
Either ON or OFF. The default value is OFF.
When it is set to ON, debug log is enabled for issue
investigation for the adapter at runtime.
adfiles.trace.extended
Either ON or OFF. The default value is OFF.
When it is set to ON, the Log4J log is enabled.
adfiles.trace.thread
Either ON or OFF. The default value is OFF.
When it is set to ON, the thread ID is traced in the Log4J log.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Predefined Properties 211
|
Table 17 Predefined Properties for TIBCO ActiveMatrix Adapter for Files for Unix/Win (Sheet 2 of 6)
Property
Description
adfiles.trace.log4j.propertie
Specifies the path for the Log4J properties. The default path
is %TIB_ADFILES_HOME%/bin/adfiles.log4j.properties.
s
The Following Properties Are for Publication Services Only.
adfiles.logSftProgressEveryNB
locks
The default value is not to log progress status.
The value is integer. If you set the value to 10, the adapter
will print a progress status every 10 messages.
adfiles.sendLotEndWithDataMsg
Either ON or OFF. The default value is OFF.
When it is set to ON and the Data Format is
MBusinessDocument, this property invokes Publication
Service to send the LotEnd attribute with the last data
message of a file, or in a separate message.
For more information on the LotEnd attribute, see TIBCO
ActiveMatrix Adapter for Files for Unix/Win Concepts.
adfiles.schemaDiagnosticsFile
Format
When a Publication Service finds records that do not match
the schemas, it writes them to a file. This property instructs
Publication Service to write records to an XML file or a plain
text file.
adfiles.matchFieldCountAndRec
ordLength
adfiles.quotedField
Either text or xml. The default value is xml.
Either ON or OFF. The default value is OFF.
When it is set to ON, it checks field count and record length
when validating a record.
Either ON or OFF. The default value is OFF.
When it is set to ON, the fields in double quotes are treated
and processed as one field.
adfiles.JMSCompress
Either ON or OFF. The default value is OFF.
When it is set to ON, Publication Service compresses JMS
messages before sending them to the EMS server.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
212
| Appendix B
Adapter Properties File
Table 17 Predefined Properties for TIBCO ActiveMatrix Adapter for Files for Unix/Win (Sheet 3 of 6)
Property
Description
adfiles.DeltaFlushInterval
The default value is 3.
In Delta Publishing mode, when there is no new data
appended to an input file after a specified amount of polling,
the data remaining in memory is considered as complete
data and published.
adfiles.LBEnabled
Either ON or OFF. The default value is OFF.
When it is set to ON, Load Balancing mode is enabled to allow
multiple instances of the same Publication Service to process
separate files in parallel. See Load Balancing Mode.
adfiles.NullNumberFieldAsZero
Either ON or OFF. The default value is OFF.
When it is set to ON, it enables treating null fields of integer
type as zero.
adfiles.PublishEmptyField
Either ON or OFF. The default value is OFF.
When it is set to ON, the empty fields are published. When it
is set to OFF, the empty fields are skipped and not published.
adfiles.BDGroupingFactor
At runtime, this value overrides the Grouping Factor value
specified at design time. This property only applies to
Business Document data format.
adfiles.pub.multithread4Bigfi
le
Either ON or OFF. The default value is OFF.
When it is set to ON, multiple threads are used to process a
file. Subscription Service writes messages randomly.
This property is valid only for the Record Transfer mode.
adfiles.pub.multithreadCount
Defines the number of threads that will be used to process a
file.
The Following Properties Are for Subscription Services Only.
adfiles.startSubscriberOnNewF
ileBoundary
Either ON or OFF. The default value is ON.
When it is set to ON, a subscriber discards partial files upon
restart and starts processing only from the beginning of a
new file. This property only applies to the Simple File
Transfer mode, JMS transport, and Durable Delivery Mode.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Predefined Properties 213
|
Table 17 Predefined Properties for TIBCO ActiveMatrix Adapter for Files for Unix/Win (Sheet 4 of 6)
Property
Description
adfiles.dontAddEOLToFinalReco
Either ON or OFF. The default value is OFF.
rd
When it is set to ON, the EOL is not added to the final record
of a file. This property only applies to the Simple File
Transfer mode with TEXT File Transfer Mode, and File
Content Encoding being anything other than ASCII.
adfiles.toggleChildRecordsOrd
ering
Either ON or OFF. The default value is OFF.
When it is set to ON, the sequence of the child orders is
reversed in the generated file. When it is set to OFF, the
sequence of the child orders does not change.
This property takes effect only when no reordering of child
records is done in TIBCO Designer.
adfiles.sub.discardDuplicateM
essages
Either ON or OFF. The default value is OFF.
When it is set to ON, this property prevents a Subscription
Service from writing duplicate messages to the output file.
The prevention is caused by restarting a Publication Service.
This property only applies to Business Document data
format.
adfiles.useBDEmbeddedFileName
Either ON or OFF. The default value is OFF.
When it is set to ON, this property instructs Subscription
Service to use the filename embedded in the LotId attribute
in the incoming Business Document message when creating
the output file instead of using the filename specified in
TIBCO Designer. This property only applies to the Business
Document data format.
See TIBCO ActiveMatrix Adapter for Files for Unix/Win
Concepts about the LotId attribute.
adfiles.io.sub.exit4issue
Either ON or OFF. The default value is ON.
When it is set to ON, Subscription Service does not confirm
messages and exits when an IO error occurs. When it is set to
OFF, Subscription Service confirms messages, ignores IO
errors, and continues to process other messages.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
214
| Appendix B
Adapter Properties File
Table 17 Predefined Properties for TIBCO ActiveMatrix Adapter for Files for Unix/Win (Sheet 5 of 6)
Property
Description
The Following Properties Are for SDK Fault Tolerance Feature Only.
tibco.sdk.faultTolerance.ems.
enabled
Either ON or OFF. The default value is OFF.
When it is set to ON, the fault tolerance is enabled; otherwise,
it is disabled.
tibco.sdk.faultTolerance.ems.
queueName
Specifies the queue name that stores the tokens in the EMS
server.
tibco.sdk.faultTolerance.ems.
sessionName
Specifies the session name that is used for fault tolerance.
The specified session must be a JMS queue session.
tibco.sdk.faultTolerance.ems.
providerUrl
Specifies the URL of the EMS provider that is used for the
EMS, JNDI, or SSL server. If the EMS server communicates
over SSL, the prefix of the URL is ssl://. Otherwise, the
prefix is tcp://.
tibco.sdk.faultTolerance.ems.
factoryName
Specifies the factory name used when SDK creates the JMS
connection factory for fault tolerance.
tibco.sdk.faultTolerance.ems.
userName
(Optional) Specifies the username for the EMS connection.
The default value is null.
tibco.sdk.faultTolerance.ems.
password
(Optional) Specifies the password for the EMS connection.
The default value is null.
tibco.sdk.faultTolerance.ems.
ackTokenOnStop
(Optional) Specifies whether the primary instance
acknowledges its token when the adapter stops normally. A
value of on indicates the token held by the primary instance
is acknowledged, which means a token in the specifies EMS
queue is deleted. The default value is OFF.
After enabling this property, the number of primary
instances decreases when the adapter stops normally.
tibco.sdk.faultTolerance.ems.
isUsingJNDI
(Optional) Specifies whether the JNDI is used. A value of on
indicates JNDI is used for looking up the JMS factory. The
default value is OFF.
tibco.sdk.faultTolerance.ems.
jndi.providerContextFactory
(Optional) Specifies the JNDI context factory. The default
context factory is
com.tibco.tibjms.naming.TibjmsInitalContextFactor
y.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Predefined Properties 215
|
Table 17 Predefined Properties for TIBCO ActiveMatrix Adapter for Files for Unix/Win (Sheet 6 of 6)
Property
Description
tibco.sdk.faultTolerance.ems.
jndi.userName
(Optional) Specifies the username of the JNDI connection.
The default value is null.
tibco.sdk.faultTolerance.ems.
jndi.password
(Optional) Specifies the password of the JNDI connection.
The default value is null.
tibco.sdk.faultTolerance.ems.
isUsingSSL
(Optional) Specifies whether the adapter connects to the JMS
server using SSL. A value of on indicates that adapter
connects to the JMS server using SSL. The default value is
OFF.
tibco.sdk.faultTolerance.ems.
ssl.enableTrace
(Optional) Specifies whether the SSL enables the tracing of
the loaded certificates. The default value is OFF.
tibco.sdk.faultTolerance.ems.
ssl.enableDebugTrace
(Optional) Specifies whether the SSL enables more detailed
SSL tracing, ON or OFF. The default value is OFF.
tibco.sdk.faultTolerance.ems.
ssl.enableVerifyHostName
(Optional) Specifies whether the SSL client verifies the name
in the server certificate. The default value is OFF.
tibco.sdk.faultTolerance.ems.
ssl.enableVerifyHost
(Optional) Specifies whether the SSL client verifies the server
certificate, ON or OFF. The default value is OFF.
tibco.sdk.faultTolerance.ems.
ssl.expectedHostName
Specifies the name in the server certificate. Required when
the enableVerifyHostName and enableVerifyHost are
both set to ON.
tibco.sdk.faultTolerance.ems.
ssl.isStrongCipherSuites
(Optional) Specifies whether only the strong cipher suites are
allowed, ON or OFF. The default value is OFF.
tibco.sdk.faultTolerance.ems.
ssl.trustedDir
Specifies the full path of the folder where the required
certificates are located. Required when the connection
between the EMS client and EMS server is over SSL.
tibco.sdk.faultTolerance.ems.
ssl.identity
(Optional) Specifies the path of the client identity.
tibco.sdk.faultTolerance.ems.
ssl.password
Specifies the password of the client identity. Required when
the identity is specified.
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
216
| Appendix B
Adapter Properties File
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
| 217
Index
A
activeenterprise (AE) 32
adapter
configuration tab 31
configuring 31
monitoring tab 35
startup tab 34
adapter features 2
adapter project life cycle 12
adapter services folder 6
adapter, configuration 5
adapter, deployment 10
adapter, monitor 87
adapter, start 86
adapter, stop 86
add timestamp to file name, publication 45
adfiles.addCustomHawkMethodsToClassMAgent 21
0
adfiles.BDGroupingFactor 212
adfiles.DeltaFlushInterval 212
adfiles.dontAddEOLToFinalRecord 213
adfiles.EEMEnabled 210, 211
adfiles.JMSCompress 211
adfiles.LBEnabled 212
adfiles.logSftProgressEveryNBlocks 211
adfiles.matchFieldCountAndRecordLength 211
adfiles.NullNumberFieldAsZero 212
adfiles.perfMon 210
adfiles.PublishEmptyField 212
adfiles.quotedField 211
adfiles.schemaDiagnosticsFileFormat 211
adfiles.sendLotEndWithDataMsg 211
adfiles.SFTUseJMSMapMsg 210
adfiles.startSubscriberOnNewFileBoundary 212, 214,
215
adfiles.sub.discardDuplicateMessages 213
adfiles.toggleChildRecordsOrdering 213
adfiles.traceOldMessages 210
adfiles.useBDEmbeddedFileName 213
adfilesagent.tra 208
advanced folder 6
advanced tab, publication 53
advanced tab, subscription 67
AESchemas 6
agents 136
alerts 136
auto-discovery process 138
B
base record 104
business document name, publication 54
business event messages 122
byte order mark, subscription 67
C
child record, promoting and demoting 81
child record, promotion restrictions 82
class microagent name field, adapter 35
close file after time elapsed, subscription 58
closing subscriber, subscription 58
command line arguments 154
completion directory, publication 44
configuration properties, retrieving through TIBCO
Hawk 154
configuration tab
adapter 31
configuration tab, publication 37
configuration tab, subscription 56
configuration task, adapter 28
configuring an adapter 31
connection factory type, JMS, publication 49
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
218
| Index
connection factory type, JMS, subscription 63
container record 104
content encodings 121
creation mode, subscription 57
custom microagents 145
ENV_NAME xv
error codes, list 200
error directory, publication 44
error directory, subscription 59
error handling 92
D
F
data format, publication 53
data validation 103
date and time symbols 108
defining
publication service 37
subscription service 56
defining schema 3
delimited record
attributes 71
delimiter 70
delimiter other 70
display wizard 71
identifier type 71
name 70
position from header 70
repeating 70
strip blanks 70
delimited record type 69
delivery mode, JMS, publication 49
delivery mode, JMS, subscription 63
delta publishing, publication 38
destination, JMS, publication 49
destination, JMS, subscription 63
document delay, publication 53
file and content encoding 121
file and directory encodings 121
file content encoding, subscription 65, 66
file encoding, publication 51, 52
file extension, publication 42
file name selection, subscription 58
file name, publication 41
file name, subscription 58
file prefix, publication 41
file recognition 3
file recognition methods 101
file records, modify the relationship 81
file transfer mode, subscription 61
flow control 3
getting started 15
global variables 97, 97, 97, 98
global variables, specify 97
globalization 3
grouping factor, publication 53
E
I
ear 84
encoding tab, publication 50
encoding Tab, subscription 64
end of Line, publication 52
end of Line, subscription 66
endpoint reference, publication 50
ICU regular expression 3
input buffer max size, publication 54
input directory, publication 40
invoking microagent methods 139
G
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Index 219
|
J
N
JMS selective routing 3
name field
adapter 31
name, subscription 56
L
layout file record 78
ledger files
retrieving information through TIBCO Hawk 167
life cycle, publication 39
locales supported for date and time 110
log file 34
log file field, adapter 34
log info field, adapter 34
log sink type
file 33
hawk 33
network 33
stdio 33
log to standard field, adapter 34
log,standard I/O 34
logging tab, adapter 33
M
message filter 32
message subject, publication 47
message subject, subscription 61
message time out field, subscription 58
message time out, subscription 58
metadata 7
metadata search url 34
microagent 3
microagent methods 139
microagent methods supported 142
microagent session field, adapter 35
microagents
invoking 139
microagents list 142
monitoring tab, adapter 35
O
operation mode 28
output creation mode, subscription 58
output directory, subscription 59
output file names 120
output filename, append, subscription 60
output filename, location, subscription 60
output filename, sequence number width,
subscription 60
output filename, subscription 60
P
palettes 6
polling interval, publication 39
polling method, publication 39
polling, subject or destination, publication 40
positional record type 72
attributes 73
display wizard 73
identifier type 73
length 73
name 72
position from header 72
strip blanks 73
post processing arguments, publication 45
post processing arguments, subscription 59
post processing script file, publication 45
post processing script, subscription 59
post processing, publication 45
pre processing arguments, publication 42
pre processing script file, publication 42
predefined global variables 98
preserve undelivered, publication 38
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
220
| Index
processing tab, publication 42
processing Tab, subscription 59
progress directory, publication 45
progress directory, subscription 59
project 5
enterprise archive file 7
local repository 7
server repository 7
zip archive 7
project, deploy 85
properties
adfiles.BDGroupingFactor 212
adfiles.DeltaFlushInterval 212
adfiles.dontAddEOLToFinalRecord 213
adfiles.EEMEnabled 210, 211
adfiles.JMSCompress 211
adfiles.LBEnabled 212
adfiles.logSftProgressEveryNBlocks 211
adfiles.matchFieldCountAndRecordLength 211
adfiles.NullNumberFieldAsZero 212
adfiles.PublishEmptyField 212
adfiles.quotedField 211
adfiles.schemaDiagnosticsFileFormat 211
adfiles.sendLotEndWithDataMsg 211
adfiles.SFTUseJMSMapMsg 210
adfiles.startSubscriberOnNewFileBoundary 212,
214, 215
adfiles.sub.discardDuplicateMessages 213
adfiles.toggleChildRecordsOrdering 213
adfiles.traceOldMessages 210
adfiles.useBDEmbeddedFileName 213
publication service
advanced tab 53
defining 37
Q
quality of service, certified 47
quality of service, distributed queue, subscription 62
quality of service, publication 47
quality of service, reliable 47
quality of service, reliable, subscription 61
quality of service, subscription 61
R
read schema 68
recognition method, publication 40
record transfer mode 92
record, edit 80
related documentation xiii
reply message subject, publication 47
repository instance 7
reviewLedger, TIBCO Hawk method 167
revision control systems 90
S
schema data 7
schema tab
subscription service 64
schema tab, subscription 60
selective routing 118
syntax 118
session reference, publication 50
session reference, subscription 64
SFT tab, subscription 67
simple file transfer 45, 95
simple file transfer, status message 123
simple transfer mode 3
sinks, creating 33
standard and class microagents 142
standard microagent 35
standard microagent name field, adapter 35
startup banner 34
startup tab
adapter 34
subscriber endpoint reference, subscription 64
subscriber name, subscription 61
subscription service
schema tab 64
subscription service, defining 56
substitution 97
synchronous mode, publication 54
system encoding, publication 50, 51
system encoding, subscription 64, 65
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Index 221
|
T
termination subject, topic 33
TIBCO administration domain 10
TIBCO administrator
application management 10
resource management 10
TIBCO administrator GUI 11
TIBCO administrator server 11
TIBCO administratoru
user management 10
TIBCO Designer 5
configuration panel 7
design panel 6
palette panel 6
project panel 5
TIBCO Hawk 136
background information 136
enterprise monitor components 136
TIBCO Hawk methods
_onUnsolictedMsg() 164
activateTraceRole() 147
deactivateTraceRole() 148
getActivityStatisticsByOperation(Operation) 149
getActivityStatisticsBySchema(SchemaName) 150
getActivityStatisticsByService(ServiceName) 151
getAdapterServicesInformation() 152
getConfig() 154
getConfigProperties() 155
getDocumentDelay() 156
getHostInformation() 157
getPollingInterval() 158
getQueueStatistics() 159
getRvConfig() 160
getStatus() 161
getTraceSinks() 162
getVersion() 163
preRegisterListener() 165
resetActivityStatistics() 166
reviewLedger() 167
setDocumentDelay() 169
setPollingInterval() 170
setTraceSinks() 171
stopApplicationInstance() 172
unRegisterListener() 173
TIBCO Rendezvous, retrieving configuration through
TIBCO Hawk 160
TIBCO support
contacting xviii
TIBCO documentation xviii
TIBCOmmunity xviii
TIBCO_HOME xv
tra file 207
trace message fields 178
trace messages 175
trace messages, example 176
trace messages, list 200
trace messages, status messages 180
tracing levels and fields 178
transfer mode, publication 38
transfer mode, subscription 57
transport tab, subscription 61
transport type, publication 37
transport type, subscription 56
trigger file extension, publication 42
trigger messages 115
syntax 115
usage scenarios 116
typographical conventions xv
U
use advanced logging field, adapter 33
user defined EOL, subscription 66
user exit endpoint reference, publication 53
user exit endpoint reference, subscription 67
V
variable substitution 97
variables 97
version control 8
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
222
| Index
W
wire format, publication 48
wire format, subscription 62
working directory, publication 44
working directory, subscription 59
write schemas 75
writer record
attributes 79
delimiter 79
delimiter other 79
name 79
parse 79
position from header 79
UI display name 78
wire schema path 79
TIBCO ActiveMatrix® Adapter for Files for Unix/Win Configuration and Deployment
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement