tibco activematrix businessworks plug-in for files for ... · important information some tibco...

TIBCO ActiveMatrix BusinessWorks™ Plug-infor Files for Unix and WindowsUser's GuideSoftware Release 8.1April 2018

Two-Second Advantage®

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCHEMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (ORPROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THEEMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANYOTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS ANDCONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTEDSOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THECLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOADOR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE)OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USERLICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THESOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, ANDYOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BEBOUND BY THE SAME.

ANY SOFTWARE ITEM IDENTIFIED AS THIRD PARTY LIBRARY IS AVAILABLE UNDERSEPARATE SOFTWARE LICENSE TERMS AND IS NOT PART OF A TIBCO PRODUCT. AS SUCH,THESE SOFTWARE ITEMS ARE NOT COVERED BY THE TERMS OF YOUR AGREEMENT WITHTIBCO, INCLUDING ANY TERMS CONCERNING SUPPORT, MAINTENANCE, WARRANTIES,AND INDEMNITIES. DOWNLOAD AND USE THESE ITEMS IS SOLELY AT YOUR OWNDISCRETION AND SUBJECT TO THE LICENSE TERMS APPLICABLE TO THEM. BY PROCEEDINGTO DOWNLOAD, INSTALL OR USE ANY OF THESE ITEMS, YOU ACKNOWLEDGE THEFOREGOING DISTINCTIONS BETWEEN THESE ITEMS AND TIBCO PRODUCTS.

This document contains confidential information that is subject to U.S. and international copyright lawsand treaties. No part of this document may be reproduced in any form without the writtenauthorization of TIBCO Software Inc.

TIBCO, Two-Second Advantage, The Power of Now, TIB, Information Bus, Rendezvous, TIBCORendezvous, and Messaging Appliance are either registered trademarks or trademarks of TIBCOSoftware Inc. in the United States and/or other countries.

Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform EnterpriseEdition (J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks ofOracle Corporation in the U.S. and other countries.

All other product and company names and marks mentioned in this document are the property of theirrespective owners and are mentioned for identification purposes only.

THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOTALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASEDAT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWAREVERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.

THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSOR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICALERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESECHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCOSOFTWARE 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 ORINDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE,INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.

2

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Files for Unix and Windows User's Guide

Copyright © 1999-2018 TIBCO Software Inc. All rights reserved.

3


Contents

TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Comparison between Adapter and Plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

TIBCO Business Studio Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12

Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Creating a Files for Unix and Windows Resource Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

Configuring a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Testing a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

Deploying an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Files for Unix and Windows Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

File Parser Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

FileSerializer Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29

Files for Unix and Windows Resource Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36

Defining Schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38

Defining Input Schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38

Creating Input Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38

Defining Relationships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Configuring Delimited Input Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39

Delimited Input Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40

Configuring Positional Input Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41

Positional Input Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Defining Output Schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Creating Output Schema (Classic) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Creating a Output Schema (Manual) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43

Defining Relationship . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Configuring an Output Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44

Output Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Advanced Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47

Pre and Post Processing Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

File Recognition Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47

Data Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

File Content Encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Syntax for Specifying User-defined Date and Time Patterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Locales Supported for Date and Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Fault Tolerance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

4


Load Balancing Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55

Delta Publishing Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

CheckPoint Restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56

Migrating Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58

Migrating projects from Adapter to Plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58

Migrating projects with Adapter Subscriber activity and Publication Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Publication Service fields not supported for migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Migrating projects with Publish to Adapter activity and Subscription Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61

Subscription Service fields not supported for Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61

Working with Preference File (JSON format) for migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62

Sample Project Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64

Importing Sample Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65

DateTime Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66

Setting Up the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66

Running the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67

MultiDelimiter Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Setting Up the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Running the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Positional Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70



FileSerializer Manual Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Setting Up the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72


ParserAndSerializer Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74



Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Log Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77

Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77

Setting up Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Exporting Logs to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78

Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

5


TIBCO Documentation and Support Services

How to Access TIBCO Documentation

Documentation for TIBCO products is available on the TIBCO Product Documentation website, mainlyin HTML and PDF formats.

The TIBCO Product Documentation website is updated frequently and is more current than any otherdocumentation included with the product. To access the latest documentation, visit https://docs.tibco.com.

Product-Specific Documentation

The following documents for this product can be found on the TIBCO Documentation site:

● TIBCO ActiveMatrix BusinessWorks Plug-in for Files for Unix and Windows Installation

● TIBCO ActiveMatrix BusinessWorks Plug-in for Files for Unix and Windows User's Guide

● TIBCO ActiveMatrix BusinessWorks Plug-in for Files for Unix and Windows Release Notes

How to Contact TIBCO Support

You can contact TIBCO Support in the following ways:

● For an overview of TIBCO Support, visit http://www.tibco.com/services/support.

● For accessing the Support Knowledge Base and getting personalized content about products you areinterested in, visit the TIBCO Support portal at https://support.tibco.com.

● For creating a Support case, you must have a valid maintenance or support contract with TIBCO.You also need a user name and password to log in to https://support.tibco.com. If you do not have auser name, you can request one by clicking Register on the website.

How to Join TIBCO Community

TIBCO Community is the official channel for TIBCO customers, partners, and employee subject matterexperts to share and access their collective experience. TIBCO Community offers access to Q&A forums,product wikis, and best practices. It also offers access to extensions, adapters, solution accelerators, andtools that extend and enable customers to gain full value from TIBCO products. In addition, users cansubmit and vote on feature requests from within the TIBCO Ideas Portal. For a free registration, go to https://community.tibco.com.

6


https://docs.tibco.com

https://docs.tibco.com

http://www.tibco.com/services/support

https://support.tibco.com

https://support.tibco.com

https://ideas.tibco.com/

https://community.tibco.com

Product Overview

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Files for Unix and Windows to automate fileoperations on the TIBCO ActiveMatrix BusinessWorks™ platform. TIBCO ActiveMatrixBusinessWorks™ Plug-in for Files for Unix and Windows processes data from text files and outputsXML data. The plug-in also processes XML data and creates text files.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Files for Unix and Windows contains a Files for Unixand Windows Palette and a Files for Unix and Windows Resource Configuration.

The following activities are available in the Files for Unix and Windows Palette.

● File Parser Activity

You can use this activity to parse data from text files and process the contents to an XML output.

● File Serializer Activity

You can use this activity to take input data from users or from File Parser activity and write it to afile as per the schema specified

For more information, see Files for Unix and Windows Palette

You can define the schemas for the File Parser and File Serializer activity by using the resourceconfiguration. For more information about the resource configuration, see Files for Unix and WindowsResource Configuration

Plug-in Features

The Plug-in provides the following features:

● Support for Defining Schema

Schemas capture the rules and relations that are used by the runtime component to process thecontents of a file during parsing or writing. For more information, see Defining Input Schemas and Defining Output Schemas.

● Support for Existing Schemas

The plug-in provides capability to load XSDs for generating schema avoiding the need to createschema manually.

● File Recognition

The plug-in provides options to selectively recognize files that need to be processed for parsing. Formore information, see Files for Unix and Windows Palette Advanced tab.

● Support for Invoking External Scripts

You can run external scripts on the files that are being processed or written in the plug-in. For moreinformation, see Files for Unix and Windows Palatte in Advanced Tab.

● Restart Capability

The plug-in provides restart capabilities when parsing files. For more information, see CheckPointRestart.

● Support for Globalization

The plug-in supports data containing date and time as date and time type. It also provides supportfor various locales. For more information, see Locales Supported for Date and Time.

● ICU Regular Expression File Matching

7


You can use this feature to find matching input files using ICU Regular Expression in filenames.Also, you can use the ICU regular expressions in File Parer Activity in General tab.

● Data Field Wrapped In Double Quotes

Parser activity treats data fields that are wrapped in a pair of double quotes as one single field. Formore information, see Input Schema (Delimited).

● Additional Checking When Validating A Record

When validating a delimited record, the parser activity checks the field count in addition to theconstant field value. When validating a positional record, the parser activity checks the recordlength in addition to the constant field value. For more information, see Input Schema (Delimited)and Input Schema (Positional).

● Delta Publishing

The parser activity checks the input file on a preconfigured time interval, copies any new data to awork file in the WIP directory, and then processes and parsers the data. For more information, see Delta Publishing Mode.

● Load Balancing

You can run multiple instances of the same parser activity to process separate files in parallel. Formore information, see Load Balancing Mode .

● Output Classic Schema

The plug-in allows users to create an output schema from existing input schema or output manualschema from all the shared resources within the current project and within the shared modules.

● File Writing Mode

The File Serializer activity provides two writing modes: timer based and job based.The file is movedto output directory once timer expires (timer based) or job is completed (job based). For moreinformation, see WIP Creation Mode of General tab for File Serializer Activity.

● Toggle child record ordering

The plug-in allows users to reverse the sequence of child records of the root parent in the output file.For more information, see Processing Script section of Advanced tab for File Serializer Activity

● Support for Encoding

The plug-in supports different encoding formats like ASCII, ISO8859-1, UTF-8, etc. For moreinformation, see File Content Encoding

● Rearranging child records at same level in Output Schema:

The plug-in allows users to arrange child records in Output Schema by using 'Move Up' and 'MoveDown' functionality.

8


Comparison between Adapter and Plug-in

This section is useful for users that have previously used the TIBCO ActiveMatrix ® Adapter for Filesfor (Unix/Win) to help understand differences in the plug-in where supported features have overlapwith adapter.

Feature

TIBCO ActiveMatrix®

Adapter for Files forUnix/Win

TIBCO ActiveMatrixBusinessWorks™ Plug-in forFiles for Unix and Windows

Services Provided Publication service andSubscription service

The plug-in is a replacement ofthe File Adapter and AE Paletteavailable in TIBCOActiveMatrix BusinessWorks™.The file parser activity isequivalent to File AdaptersPublication service with anAdapter Subscriber activity.

The file serializer activity isequivalent to File AdaptersSubscription Service withPublish to Adapter activity.

Lifecycle for Reading File Publication AdapterService supports bothOnce-Only and Repeating

File Parser Activity onlysupports Repeating.

Support for sFTP transfer Supported Not Supported. If sFTP isrequired by using BW6, thenuse TIBCO ActiveMatrixBusinessWorks™ Plug-in forsFTP.

Transport Type JMS and RV The plug-in is native to TIBCOBusinessWorks and no longerrequires messaging.

Error Directory in PublicationService

When the transfer mode isSimple File Transfer, thisfield is mandatory. Whenthe transfer mode is RecordTransfer, this field is notmandatory. Whenspecified, an XML filecontaining the name of theinput file and the errordetails is created indirectory.

Since the plug-in is native toTIBCO BusinessWorks, theError Directory is no longerapplicable. If thecorresponding error scenariooccurs in plug-in, the detailswill be shown in console or log.

Add timestamp to filename Default format is in 12 hr Default format is in 24hr.

Checkpoint Restart Optional Default

9


Feature




Mbusiness Document Supported Not Supported

Message Format The File Adapter isdeveloped using AdapterSDK libraries and outputsthe message using aSchema

The plug-in is native to TIBCOBusinessWorks and outputs themessage as XML based on aXSD.

Input Buffer Max Size Configurable Default to 32KB

Support for Load Balancing Configurable It is supported by default whenPost Processing is Move to orDelete.

TRA Properties TRA properties aremaintained in TIBCOAdministrator and-oradfilesagent.tra file

TRA properties are notapplicable in plug-in.

TRA Property :adfiles.PublishEmptyField

Configurable and defaultON

Default is add NULL for emptyfields.

TRA Property :adfiles.NullNumberFieldAsZero

Configurable and defaultON

Default is add 0 for emptyfields.

TRA Property : adfiles.quotedField Configurable and defaultON

Default is if field is enclosedwith double quotes, delimiteris considered as actualcharacter.

TRA Property :adfiles.matchFieldCountAndRecordLength

Configurable and defaultOFF

Default is if Input line mapswith schema and a warningmessage is displayed as extrafields, then the input line hasbeen discarded in OutputXML.

Base Record Supported Not Supported

Container Record Supported Not Supported

Business Document Supported Not Supported

Position from header Position from header isconfigurable for childrecords such as Begin orEnd.

No such field is displayed inthe Files for Unix andWindows ResourceConfiguration of the plug-inand the default value is Begin.

10


Feature




WIP creation mode - Close file onRV message, JMS message, businessdocument lot end

Supported Not supported as transport(RV, JMS) is removed in plug-in.

WIP creation mode - One messageper file

Supported Not supported in plug-in.Instead plug-in supports WIPcreation mode - One Job per file

File name selection Supported Not supported as SFT transfermode is not supported in plug-in.

Message time out (minutes) field Supported Not supported as transport(RV, JMS) is removed in plug-in.

Closing Subscriber field Supported Not supported as transport(RV, JMS) is removed in plug-in.

Promote / Demote child records Supported Not Supported.

TRA property :adfiles.toggleChildRecordsOrdering

Configurable and default isOFF

The Toggle Child RecordsOrdering field is provided inAdvanced tab of the FileSerializer activity, underProcessing section.

TRA property :adfiles.subscriber.ignoreEmptyRecord

Configurable and default isON

Default is OFF. Empty recordsare written to output file

TRA property :adfiles.io.sub.flusheverymsg


Default is OFF for WIP creationmode, as Close is ON for Timerand Default is ON for One Jobper file.

TRA property :adfiles.io.sub.disableWipMoveOnShutdown


Default is ON so that whenevera running process is stopped inbetween, WIP file will not bemoved to output directory. Itwill remain in workingdirectory. The above behaviorwill not work if stop appnodecommand is used in bwadminutility. It will only work if stopapplication command is usedin bwadmin.

11


Getting Started

This tutorial is designed to get users started with TIBCO ActiveMatrix BusinessWorks™ Plug-in forFiles for Unix and Windows in TIBCO Business Studio™.

By using TIBCO ActiveMatrix BusinessWorks™ Plug-in for Files for Unix and Windows, you can createservices and integrate applications, and deploy them at run time. All the operations are performed inTIBCO Business Studio. Refer to TIBCO ActiveMatrix BusinessWorks™ Concepts Guide to get familiar withTIBCO Business Studio™.

Complete the following tasks to design a process and deploy it at run time:

1. TIBCO Business Studio Overview

2. Creating a Project

3. Creating a Files for Unix and Windows Resource Configuration

4. Configuring a Process

5. Testing a Process

6. Deploying an Application

TIBCO Business Studio OverviewTIBCO Business Studio is an Eclipse-based integration development environment that is used todesign, develop, and test ActiveMatrix BusinessWorks applications.

TIBCO Business Studio provides a workbench in which you can create, manage, and navigate resourcesin your workspace. A workspace is the central location on your machine where all data files are stored.

The following table introduces the workbench UI elements highlighted in the image:

12


Sl. No. UI Element Description

1. Menu Contains menu items such as File, Edit, Diagram,Navigate, Search, Project, Run, Window, and Help.

2. Toolbar Contains buttons for frequently used commands such as

New , Save , Enable/Disable Business Studio

Capabilities , Create a new BusinessWorks

Application Module , Create a new BusinessWorks

Shared Module , Debug , and Run .

3. Perspective Contains an initial set and layout of views that arerequired to perform a certain task. TIBCO BusinessStudio launches the Modeling perspective by default.You can change the perspective from Window > OpenPerspective > Perspective_Name.

4. View Displays resources. For example, the Project Explorerview displays the ActiveMatrix BusinessWorksapplications, modules, and other resources in yourworkspace, and the Properties view displays theproperties for the selected resource. You can open aview from the menu Window > Show View >View_Name.

5. Editor Provides a canvas to configure, edit, or browse aresource. Double-click a resource in a view to open theappropriate editor for the selected resource. Forexample, double-click an ActiveMatrix BusinessWorksprocess MortgageAppConsumer.bwp in the ProjectExplorer view to open the process in the editor.

6. Palette Contains a set of widgets and a palette library. A palettegroups activities that perform similar tasks, andprovides quick access to activities when configuring aprocess.

Creating a ProjectThe first task of using the plug-in is creating a project. After creating a project, you can add resourcesand processes.An Eclipse project is an application module configured for TIBCO ActiveMatrix BusinessWorks. Anapplication module is a resource unit that is named, versioned, and packaged as part of an application.

Procedure

1. Start TIBCO Business Studio by using one of the following ways:

● Microsoft Windows: click Start > All Programs > TIBCO > TIBCO_HOME > TIBCO BusinessStudio version number > Studio for Designers.

● Linux: run the TIBCO Business Studio executable file located in the TIBCO_HOME/studio/version_number/eclipse directory

13


2. From the menu, click File > New > BusinessWorks Resources to open the BusinessWorks Resourcewizard.

3. In the Select a wizard dialog box, click BusinessWorks Application Module and click Next to openthe New BusinessWorks Application Module wizard.

4. In the Project dialog box, configure the project you want to create:a) In the Project name field, enter a project name.b) By default, the created project is located in the workspace currently in use. If you do not want to

use the default location for the project, clear the Use default location check box and click Browseto select a new location.

c) Use the default version of the application module, or enter a new version in the Version field.d) Keep the Create empty process and Create Application check boxes selected to automatically

create an empty process and an application when creating a project.e) Select the Use Java configuration check box if you want to create a Java module.

A Java module provides the Java tooling capabilities.f) Click Finish to create the project.

Result

The project with the specified settings is displayed in the Project Explorer view.

Creating a Files for Unix and Windows Resource ConfigurationAfter creating a project, you have to create a Files for Unix and Windows resource configuration.

Prerequisites

Before creating the Files for Unix and Windows resource configuration ensure that a project is created.For more information see, Creating a Project.

Procedure

1. Expand an existing project in the Project Explorer view.

2. Right-click the Resources folder, and click New > Files Configuration.

3. In the Files for Unix and Windows Resource Configuration wizard, the resource folder, packagename, and resource name of the Files configuration are provided by default. If you do not want touse the default configurations, change them accordingly. Click Finish.The Files for Unix and Windows Resource Configuration is created with extension .filesResource

14


4. In the Files for Unix and Windows Resource Configuration dialog box configure the details on boththe tabs. The Files for Unix and Windows Resource Configuration has two tabs, General tab andSchema tab. For more information, see Files for Unix and Windows Resource Configuration section.

Configuring a ProcessAfter creating a project, an empty process is created. You can add activities to the empty process tocomplete a task.

Prerequisites

Ensure that you have created an empty process when creating a project. See Creating a Project for moreinformation.

Procedure

1. In the Project Explorer view, click the created project and open the empty process from theProcesses folder

2. Select activities from the palatte view and drop them in the Process editor.For example, select and drop the Log activity from the General Activities palette, and the FileParseractivity from the Files for Unix and Windows Palette library.

3. Click an activity in the Process editor and drag the icon to create a transition between theadded activities.

4. Configure the added FileParser activities, as described in FileParser Activity.

5. Click File > Save to save the process.

Testing a ProcessAfter configuring, you might debug or test a process.

Prerequisites

Ensure that you have configured a process as described in Configuring a Process.

Procedure

1. Open the process you have configured in the TIBCO Business Studio.

2. On the toolbar, click Debug > Debug Configurations.

3. Click BusinessWorks Application > BWApplication in the left panel.By default, all the applications in the current workspace are selected in the Applications tab. Ensurethat only the application you want to debug is selected in the Applications tab in the right panel.

15


4. Click Debug to test the process in the selected application.TIBCO Business Studio changes to the Debug perspective. The debug information is displayed inthe Console view.

5. In the Debug tab, expand the debugged process and click an activity.

6. In the upper-right panel, click Job Data view, and then click the Output tab to check the activityoutput.

Result

Deploying an ApplicationAfter deploying applications, you can manage BusinessWorks applications by using TIBCO EnterpriseAdministrator.After testing, you can deploy the application that contains the configured process into a runtimeenvironment, and then use the bwadmin utility to manage the deployed application.

Prerequisites

Before deploying an application, generate an application archive, which is an enterprise archive (EAR)file created in TIBCO Business Studio.

A complete workflow of deployment includes:

Procedure

1. Uploading an application archive.

2. Deploying an application archive.

3. Starting an application.

16


See TIBCO ActiveMatrix BusinessWorks Administration for more details on how to deploy anapplication.

17


https://docs.tibco.com/pub/activematrix_businessworks/6.3.5/doc/pdf/TIB_BW_6.3.5_administration.pdf

Files for Unix and Windows Palette

The Files for Unix and Windows Palette contains activities that can be added to your businessprocesses. You can design a certain workflow with the Files for Unix and Windows palette.

The Files for Unix and Windows Palette contains the following activities:

● File Parser Activity

● File Serializer Activity

File Parser ActivityThe File Parser activity is a process starter activity which processes data from text files to XML output.

The File Parser activity consists of the General, Description, Advanced, Output, and Fault tabs.

General Tab

On the General tab, you can specify the required parameters before you use this activity.

The following table lists the configurations in the General tab of the File Parser activity:

Field

LiteralValue/ModuleProperty? Description

Name No The name to be displayed as the label for the activity in theprocess.

ConfigurationResource

Yes The reference to the Files for Unix and Windows ResourceConfiguration.

Schema No Schema is based on the XSD generated by the File for Unix andWindows Resource Configuration selected in ConfigurationResource field . Out of multiple schemas listed, only one schemais processed at run time.

Delta PublishingMode

No When Delta Publishing mode is enabled, the file parser activitychecks the input file on a preconfigured timer interval, andcopies any new data to a work file, and then processes andparses the new data.

When this check box is selected, several fields are greyed out,they are:

● Recognition Method- The default value is By file name● Post Processing- The default value is Leave as is● Pre Processing Script File

● Pre Processing Arguments

● Post Processing Script File

● Post Processing Arguments

18


Field


Delta FlushInterval

Yes This field is available only when the Delta Publishing Mode isselected. The default value is set to 3.

In Delta Publishing mode, when there is no new data appendedto an input file after a specified amount of polling, the dataremaining in memory is considered as complete data andparsed.

Process File Mode No The criteria for creation of jobs. In this field, the followingrecords ae avaliable when the Delta Publishing Mode is notselected:

● Record By Record

In Record By Record, entire record is processed in one job.

● File Based

In Files Based, entire file is processed in one job. Whenmultiple files are present, one job is processed for one file.

● Number of Records

In Number of Records, user can specify the number ofrecords to be outputted in the output job and it processesthose many number of records per job.

When the Delta Publishing Mode is selected the followingrecords are available:

● Record By Record

In Record By Record, entire record is processed in one job.

● Number of Records

In Number of Records, user can specify the number ofrecords to be outputted in the output job and it processesthose many number of records per job.

When the Process File Mode field is selected toNumber of Records or File Based, if number ofrecords is set to total records in a file which meansonly one job output is created, the entire output isstored in memory. Therefore users might consider theheap size while managing big files. Hence users musttake care while processing big files and allocatingmemory accordingly.

Number ofRecords

Yes This field is available only when the Number of Records field isselected in the Process File Mode list. In this field, the user canspecify the number of records to be outputted in the output joband it processes those many number of records per job.

19


Field


PollingIntervals(seconds)

Yes The amount of time in seconds until the next file scan isrepeated.

Input Directory Yes The File Parser activity searches and processes the files in thisdirectory, and then parses the files.

The directories used by the plug-in cannot be sharedwith TIBCO ActiveMatrix® Adapter for Files forUnix/Win

This directory is different from the directories specified for theWorking Directory and Completion Directory fields. The inputdirectory can have an absolute path name or a relative pathname. When a relative path name is used, it is relative to thestarting directory of the runtime plug-in.

On UNIX, the processing directories such as the input,working, and completion are specified on the samefile system. Only the input directory is scanned forfiles that match the criteria. The files maintained insub folders inside the input directory would beignored.

20


Field


RecognitionMethod

No Tthe mechanism for finding the desired input file(s). Thefollowing options are available:

● By file name

Processes the file that exactly matches the value given in the FileName field.

● By Wildcard via ICU Regular Expressions

Processes the file that matches the ICU regular expressionspecified in the File Name field.

● By prefix + extension

Processes the files that match the criteria that you have definedin the File Prefix and File Extension fields.

● By trigger

Processes the files that match the criteria that you have definedin the File Prefix, File Extension, and Trigger File Extensionfields.

● When selecting the By trigger option, the activityprocesses the input files only after they are ready.Without this, the activity might process the files inthe input directory before files are created, written,or closed by the third-party applications.

● The file name or file prefix cannot contain pathinformation. For details about the recognitionmethod, see File Recognition Methods.

21


Field


File Name Yes This field is available in the following cases:

● When you select By file name from the Recognition Methodlist, the activity processes the file that exactly matches thevalue given in this field.

● When you select By Wildcard via ICU Regular Expressionsfrom the Recognition Method list. ICU regular expressionscan be used in the File Name field.

Examples of using ICU regular expressions:

● Prepare the following files in the input directory: text0.txt,text1.txt,..., to text10.txt.

If the input filename is text\d\.txt, the input files namedfrom text0.txt, text1.txt,..., to text9.txt are parsed.

Prepare the following files in the 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 filesnamed A6.0.0.txt, A6.1.0.txt, A6.0.0.log, and A6.1.0.log areparsed.

Wildcard is different from regular expressions andis not supported. For example, *.txt must bespecified as .*\.txt in the regular expressionsformat.

File Prefix Yes This prefix is used to locate the input file in the input directory.Any file matching the specified criteria is processed. To activatethe file prefix, select By prefix + extension or By trigger from theRecognition Method list.

File Extension Yes This field is available only when you select By prefix + extensionor By trigger from the Recognition Method list.

Trigger FileExtension

Yes This field is available only when you select By trigger from theRecognition Method list.

Description Tab

On the Description tab, you can enter a short description for the File Parser activity.

Advanced Tab

The Advanced tab contains the following sections:

● Processing● Processing Script

22


● Encoding

The following table describes the fields in the Advanced tab of the FileParser activity.

Field

Literal Value/ProcessProperty/ModuleProperty? Description

SequenceKey

No This field can contain an XPath expression that specifies whichprocesses must run in order. Process instances with sequencingkeys that evaluate to the same value are executed sequentiallyin the order the process instance was created.

Custom JobId

No This field can contain an XPath expression that specifies acustom ID for the process instance.

The following table describes the fields in the Processing section of the Advanced tab for the File Parseractivity.

Field


WorkingDirectory

Yes The File Parser activity uses this directory to process files thatmatch the criteria. Based on the option selected in the PostProcessing field, the file is either copied or moved into thisdirectory.

If you select Leave as is from the Post Processing list, the file iscopied. If you select Delete or Move to, the file is deleted ormoved to the completion directory.

● For plug-in configurations, if the files processedby the parser activity are independent of eachother, parser activity can share the input,working, and completion directories. Otherwise,these directories must be unique.

● On Unix, the processing directories such as theinput, working, and completion are specified onthe same file system. Only the input directory isscanned for files that match the criteria. The filesmaintained in sub folders inside the inputdirectory would be ignored.

● The directories used by the plug-in cannot beshared with TIBCO ActiveMatrix® Adapter forFiles for Unix/Win.

23


Field


CompletionDirectory

Yes This field is available only when you select Move to in the PostProcessing list. After the file in the working directory isprocessed, it is moved to this directory.

● On Unix, the processing directories such as theinput, working, and completion are specified onthe same file system. Only the input directory isscanned for files that match the criteria. The filesmaintained in sub folders inside the inputdirectory would be ignored.

● The directories used by the plug-in cannot beshared with TIBCO ActiveMatrix® Adapter forFiles for Unix/Win.

ProgressDirectory

Yes The progress file is written in this directory. If no directory isspecified in this field, the progress file is created in thedirectory where the plug-in is started.

PostProcessing

No Specifies an action to apply to the file that is currently in theworking directory after File Parser has processed the file. Theavailable postprocessing actions are:

● Move to

Move the file from the Working directory to the Completiondirectory.

● Delete

Deletes the file from the Working directory.

● Leave as is

Deletes the file from the Working directory (since the file inthe Working directory is a copy. The corresponding file inthe Input directory is left as is).

Load Balancing feature does not work if Leave asis, is selected in Post Processing field. For moreinformation see Load Balancing feature.

AddTimeStamp toFile Name

No This is an option to append date and time to the file that ismoved to the completion directory. The format of the date andtime is YYYYMMDDHHMMSSmm.

The following table describes the fields in the Processing Script section of the Advanced tab for theFileParser activity.

24


Field


PreProcessingScript File

Yes The name of the script that must be executed before the inputfile is processed. You can make changes to the input file beforeit is processed. Click Browse to locate the script file.

For parser activity, when using a pre-processing script that didnot resolve to the associated program or executable, the fileparser activity was unable to invoke successfully the pre-processing script. To avoid this issue, perform the followingconvention to specify the preprocessing script:command::command_exec,command_file Example:

command::C:\perl\bin\perl.exe,c:\temp\script.pl

In the command_exec and command_file arguments, you mustspecify the absolute path.

For more information, see Pre and Post Processing Scripts.

25


Field


PreProcessingArguments

Yes Arguments that need to be passed to the preprocessing scriptfile. Arguments are strings and are (Optional).

Syntax: Script_filename Pre Processing Arguments

Example:

script.tcl inputFile0364.txt argument1 argument2...

The variables in the file are defined as follows:

● script.tcl is the script filename

● inputFile0364.txt is the name of the reprocessed file

● argument1 is the first argument, and is followed by otherarguments.

The preprocessing script file reads the input file, renames thefile, makes required modifications, and writes to the originalfilename.

If five files are in the input directory, the plug-in runs the scriptfive times, once for each file. The plug-in processes the files inascending order based on their names. The plug-in sorts thefiles according to their names alphanumerically in ascendingorder. It is case sensitive, and the upper case is followed by thelower case.

For example, if the following files exist in the input directory:1.csv11.csv111a.csv22.csv11a.csv11b.csv22b.csv

The plug-in processes the files in the following order:1.csv11.csv111a.csv11a.csv11b.csv22.csv22b.csv

During preprocessing, when the preprocessing script finds thefile unsuitable for processing, the plug-in does not process thefile. The plug-in logs feedback from the preprocessing script.

26


Field


PostProcessingScript File

Yes The name of the script that must be executed after the input fileis processed by the plug-in. Click Browse to locate and load thescript.

For parser activity, when using a post-processing script that didnot resolve to the associated program or executable, the fileparser activity was unable to invoke successfully the post-processing script. To avoid this issue, perform the followingconvention to specify the post processing script:command::command_exec,command_file Example:


In the command_exec and command_file arguments, you mustspecify the absolute path.For more information, see Pre and Post Processing Scripts

PostProcessingArguments

Yes Arguments you want to pass to the postprocessing script.Arguments are strings and are optional. The sequence ofarguments passed to the postprocessing script is determined asfollows:

● The argument sequence contains the name of the file, thearguments specified in the postprocessing arguments, andthe status. The status succeeds if the parser processes thefile successfully. The status fails if the parser has problems(for example, parsing) processing the file.

The following table describes the fields in the Encoding section of the Advanced tab for the FileParseractivity.

Field


File ContentEncoding

No Provides aliases for the following commonly used encoding forfile contents:

ASCII, ISO8859-1, UTF16_BigEndian, UTF16_LittleEndian,UTF-8, Shift JIS(CP943), Shift JIS (TIBCO), EUC-JP, Big5, andOther.

When an invalid or unsupported encoding stringvalue is specified, an error is displayed at run time.

27


Field


File ContentEncodingOther

Yes This field is available only when you select Other in the FileContent Encoding list. For more information, see File ContentEncoding

End of Line No Select the method according to how the lines in the input fileare separated.

● System

Uses a carriage return (new line) to mark the end of a line.

● User Defined

Uses custom end of line characters to mark the end of a line.

Currently, no facility is provided to distinguishcustom end of line characters that are not actualcharacters.

● System and User Defined

Uses a combination of carriage returns and customcharacters to mark the end of a line.

User DefinedEOL

Yes This field is available only when the End of Line field is notSystem. Enter the characters to mark the end of a line.

When the Delimiter and the User Defined EOLfields are same, the parser activity does notdifferentiate between the fields. Therefore, theDelimiter and User Defined EOL fields must alwaysbe different.

Output Tab

The following table describes the fields in the Output tab of the SendMessage activity.

Output Item Data Type Description

FileParser complex The complete output of the FileParser activity.

Fault

On the Fault tab the following exceptions are available for selection:

● FileParserException● RecordParserException

FileParserException generates an error and cause the activity to stop. It contains the following fields:

28


Field Type Description

msg string The error message description returned by the plug-in.

msgCode string The error code returned by the plug-in.

errorMessage string The error message returned by the plug-in.

RecordParserException generates an error and still allow the activity to continue. The fault is generatedonly when the entire record in the input file is incorrect. This is applicable only for Record By Recordfield in Process File Mode. It contains the following fields:




errorRecords string The error records returned by the plug-in.

FileSerializer ActivityThe File Serializer activity takes input data from users or File Parser activity and writes it to a fileaccording to the specified schema.

The File Serializer activity consists of the General, Description, Advanced, Input, and Fault tabs.

General Tab

On the General tab, you can specify the required parameters before you use this activity. The Generaltab contains the following fields:

Field

Literal Value/ModuleProperty? Description

Name No The name to be displayed as the label for the activity in theprocess.

ConfigurationResource

Yes The reference to the Files for Unix and Windows ResourceConfiguration.

Schema No Schema is based on the XSD generated by the Files for Unixand Windows Resource Configuration selected inConfiguration Resource field . Out of multiple schemas listed,only one schema is picked and processed at runtime.

29


Field

Literal Value/ModuleProperty? Description

Wip CreationMode

No The creation mode of the file in the working directory. The FileSerializer activity uses the working directory to create the file.Based on the semantics of Wip Creation mode options, the fileis moved to the output directory with the following options:

● Append messages to file, close on Timer

Input records from multiple jobs are appended to a filecreated in the working directory. The file is closed andmoved to the output directory on receiving the timer eventspecified in the Elapsed field. And then a new file is createdin the working directory.

● One job per file

Input records that are present in each job are written to afile and then moved to the output directory.

OutputCreationMode

No Two options are available:

● Overwrite (always creates new file)

Overwrites the file, when moving a file from the workingdirectory to the output directory.

● Append (if same file name exists)

Appends the text, when moving a file from the workingdirectory to the output directory.

File Name No The name of the output file that is to be created.

The filename cannot contain path information.

Close file aftertime elapsed(minutes)

Yes The amount of time before the file is closed in the workingdirectory. You can type a specific time in this field or use amodule property. This field is available only when you selectAppend messages to file, Close on timer in the Wip CreationMode list.

Description Tab

On the Description tab, you can enter a short description for the activity.

Advanced Tab

The Advanced tab contains the following sections:

● Processing● Processing Script● Options for modifying output Filename● Encoding

30


The following table describes the fields in the Processing section of the Advanced tab for the FileSerializer activity.

Field


WorkingDirectory

Yes Specifies the directory where contents for the actual output fileare composed from input records.

When the files generated by File Serializer activity areindependent of each other, the activities share the working,output and error directories. Otherwise, the directories must beunique.

On Unix, the processing directories such as theworking directory, and the done or output directoryare required to be on the same file system.

OutputDirectory

Yes Specifies the directory where files in the working directory aremoved to.

ErrorDirectory

Yes When an error occurs while moving a file from workingdirectory to output directory, file in the working directory ismoved to the error directory. For One job per file in WIPCreation Mode, if the file is already present in the workingdirectory, it is moved to error directory with timestamp addedin the file name.

ProgressDirectory

Yes Specifies the directory where the progress file is written to. Ifno directory is specified in this field, the progress file is createdin the directory where the plug-in is started.

Toggle ChildRecordsOrdering

No When it is set to TRUE, the sequence of the child order isreversed in the generated file. When it is set to FALSE, thesequence of the child orders does not change.

Users can only reverse the order of the root parent'schildren. Order of the children of child record cannotbe reversed.

The following table describes the fields in the Options for modifying output Filename section of theAdvanced tab for the File Serializer activity.

31


Field


Append No Three options are available:

● None

Does not append anything to the filename.

● Timestamp

Appends a timestamp to the filename. The format isYYYYMMDDHHMMSSmm. Selecting this option activatesthe Location field.

● Sequence Number

Appends a sequence number to the filename. Selecting thisoption activates the Location and Sequence Number Widthfields.

Location No Two options are available:

● Prefix

Appends the timestamp or sequence number to thefilename as a prefix.

● Suffix

Appends the timestamp or sequence number to thefilename as a suffix.

A period (.) is assumed to be a separator between the prefixand suffix.

SequenceNumberWidth

No Specifies the width of the sequence number. For example, whenyou select 4 as the width of the sequence number, the numberthat is appended to the file is 0000. The sequence numberbegins with 0 and is incremented for each file that is moved tothe output directory. Upon reaching the maximum value for agiven width, the sequence number rolls over.

When the plug-in is restarted, File Serializer activityremembers the previous sequence number and continues fromthere. Sequence Number is stored in Progress File

The following table describes the fields in the Processing Script section of the Advanced tab for the FileSerializer activity.

32


Field


PostProcessingScript File

Yes Specify the name of the script that needs to be executed afterthe input file is processed by the plug-in. Click Browse tolocate and load the script.

For file serializer activity, when using a post-processing scriptthat did not resolve to the associated program or executable,the activity is unable to invoke successfully the post-processingscript. To avoid this issue, when specifying the post-processingscript please follow the convention,command::command_exec,command_file Example:


When specifying the command_exec and command_filearguments, you must specify the absolute path.For more information see Pre and Post Processing Scripts

PostProcessingArguments

Yes Arguments you want to pass to the postprocessing script.Arguments are strings and are optional. The sequence ofarguments passed to the postprocessing script is determined asfollows:

● The argument sequence contains the name of the file, thearguments specified in the postprocessing arguments, andthe status. The status succeeds if the serializer processes thefile successfully. The status fails if the serializer hasproblems (for example, parsing) processing the file.

The following table describes the fields in the Encoding section of the Advanced tab for the FileSerializer activity.

Field


File ContentEncoding

No Provides aliases for the following commonly used encoding forfile contents:

ASCII, ISO8859-1, UTF16_BigEndian, UTF16_LittleEndian,UTF-8, Shift JIS(CP943), Shift JIS (TIBCO), EUC-JP, Big5, andOther.

When an invalid or unsupported encoding stringvalue is specified, an error is displayed at run time.

33


Field


File ContentEncodingOther

Yes This field is available only when you select Other in the FileContent Encoding list. For more information, see File ContentEncoding

End of Line No Specifies the line separator to be used in the output file

● System

The separator is runtime dependent. It follows the DOSconvention on Microsoft platforms or the UNIX conventionon 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.

User DefinedEOL

Yes This field is available only when you select the User Definedoption from the End of Line field. Enter the characters to markthe end of a line.

Input Tab

On the Input tab, you can view the input data for the File Serializer activity. The values in the Input tabare populated based on the schema selected in the Schema field.

Fault Tab

The Fault tab, has the following exceptions:

FileSerializerException

FileSerializerException will throw an error and cause the activity to stop. It contains the followingfields:




34



errorMessage string The error message returned by the plug-in.

35


Files for Unix and Windows Resource Configuration

The Files for Unix and Windows Resource Configuration is used to define schemas for the File Parserand File Serializer activity.

The Files for Unix and Windows Resource Configuration has two tabs, General and Schema. On theGeneral tab you can choose an option to create schema. There are two options available:

● Manual● Upload XSD

On the Schema tab, you can create input or output schemas manually, or update the existing schemas.

General Tab

On the General tab you can choose an option to create schema. There are two options available:Manual and Upload XSD

The General Tab contains the following fields:

General

On the General panel, you can specify the package that stores the Files Configuration shared resourceand the shared resource name.

The General panel contains the following fields:

FieldModuleProperty? Description

Package No The name of the package where the new shared resource isadded.

Name No The name to be displayed as the label for the shared resourcein the process.

The default is FilesConfiguration.

Description No A short description of the shared resource.

Schema Creation

The Schema Creation panel supports two ways of creating schemas:

● Manual

Input Delimited Record, Input Positional Record, Output Record (Classic) and Output Record(Manual) are created using Manual creation mode.

● Upload XSD

In Upload XSD the schemas are picked from the file system and are uploaded as input delimitedrecords.

In the current release, Uploaded XSD only supports input delimited records.

Schema Tab

36


The schemas available in Files for Unix and Windows Resource Configuration are : Input DelimitedRecord, Input Positional Record, Output Record (Classic) and Output Record (Manual). For moreinformation on schemas, see Defining Schemas

37


Defining Schemas

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Files for Unix and Windows provides the followingtypes of schema: Input and Output. The input schema includes Input Delimited Schema and InputPositional Schema and output schema includes Output Schema (Classic) and Output Schema (Manual).You can define the input schemas and output schemas in the Files for Unix and Windows ResourceConfiguration.

A typical workflow of defining schema includes creating a schema, defining the relationship betweenfile schemas, and configuring the schema.

Defining Input SchemasThe schemas available in Files for Unix and Windows Resource Configuration are : Delimited InputRecords, Positional Input Records, and Mixed Records (includes both delimited and positional records)

Procedure

To define an input schema, complete the following tasks:

1. Creating Input Schema

2. Defining Relationships

3. Configuring the input schemaSee Configuring Delimited Input Schema or Configuring Positional Input Schema.

Creating Input SchemaYou can create an input schema in Files for Unix and Windows Resource Configuration.

Procedure

1. Expand the created project in the Project Explorer view.

2. Right-click the Resource folder and click New > Files Configuration.

3. In the Files for Unix and Windows Resource Configuration wizard, complete the configuration andclick Finish. The resource folder, package name, and resource name of the Files configuration areprovided by default. However, you can change the default values if required.The Files for Unix and Windows Resource Configuration is created.

4. After the Files for Unix and Windows Configuration is created, in the Schema Creation panel, selectthe mode: Manual or Upload XSD.

The Upload XSD processes only Input Delimited Records.

When you are switching from the Manual to the Upload XSD mode a warning messagewill be displayed stating: Data will be lost after switching. The message is displayed onlyfor the first time when the switching happens after the resource configuration is opened orcreated. If you switch between the modes more than once the message is not be displayed.

5. On the Schema tab, click Add Input Delimited Record or Add Input Positional Record andconfigure the record added in Step 5.

For detailed information about configuration, see Configuring a Delimited Input Schema or Configuring a Positional Input Schema.

Optionally, you can specify a new name for the schema and provide a description.

38


Defining RelationshipsAn input schema can contain a combination of delimited file records or positional file records. You cancreate file records and define relationships among them.

When you create the first file record for a input schema, and then create additional records for the sameinput schema, these records form a relationship automatically. The relationship depends on how youcreate file records. The first file record created in a input schema is referred to as the root record. Aninput schema can have multiple root records but one input record has only one root element. Bydefault, all the other records created after the first file record become child records.

A root record can have many child records, and each child record can further have child records.

For example, if an input schema is defined as follows:Order Customer Item

The data file contains the following records.Order, ID41678, 20May2000Customer, Hopkins Associates, ID26490Item, GigaWidget, 60, $75Item, MegaBucket, 48, $125Order, ID41680, 20May2000Customer, Jersey WebInovaters, ID46786Item, Rt.Clopper, 40, $100Item, Lt.Clopper, 50, $100

Configuring Delimited Input SchemaYou can configure a delimited input schema using Files for Unix and Windows Resource Configuration.

Procedure

1. Configure attributes in the Input Delimited Record.For detailed information about these attributes, see Delimited Input Schema.

2. In the Attributes panel, click Add to add some fields.The name of the field is generated automatically as field, field1, field2 and so on. You can edit thefield names. With the Add, Remove, Up and Down buttons, you can add or remove attributes,move attributes up and down.

3. For each field that you add, define the Type, Constant, and Use columns for the added fields.

● Type

The data type in the corresponding field in the file is converted before parsing.

If you select the type as dateTime, specify the pattern and locale: right-click the field name, clickSet locale and pattern, and then select a supported Locale and Pattern from the list.

● Constant

Enter a constant value for the appropriate field.

● Use

By default the Use column is selected. If the Use column is cleared, the selected field is notdisplayed in the output schema

39


Delimited Input Schema

The following table explains the attributes and corresponding description available in a delimited inputschema:

Attribute Name Description

Name The file record names have alphanumeric characters only. Each name is uniquewithin the plug-in configuration.

Description (Optional) A short description for the delimited file record.

Strip Blanks Select this check box to remove the blank spaces for each field identified for arecord in a data file.

RepeatingDelimiter

Specifies whether to ignore repeated delimiters. Select this check box totranslate any repeated delimiters between fields as only one field separator.Clear this check box to translate repeated delimiters as empty fields.

Delimiter Specifies the separator between fields within each line of a file for the line thatis parsed. Space, Tab, and Other are the available options. If you select Other,the Delimiter Other field becomes available.

Delimiter Other This field is available only if you select Other from the Delimiter field.Specifies the delimiter to be used. You can specify single or multiple charactersas a delimiter.

To distinguish delimiter characters from actual field values, you can enclosedata fields including the delimiter characters in double quotes.

For example, a John, "3301 Hillview Ave, Palo Alto CA" comma delimitedrecord is treated as two fields because of the double quotes.

Quoted field is supported with regular records only. End-of-linecannot be enclosed in double quotes.

Identifier Type Specifies the method to identify a record. Field Value (constant field value) andNumber of Fields are the available options.

When the Identifier Type field is set to Field Value, the constant attribute forone of the fields needs to be specified when defining the fields for the records.If the constant field matches but the count exceeds the expected field count,then line is parsed successfully and a warning message is displayed: The line{0} has been mapped with class {1}, extra fields of the input line has beendiscarded in Output XML.

For example, a input schema defines a record to contain three String fields withthe first field containing a constant string "Order". A record, such as"Order,ID1234,Aug20" is accepted by parser activity. However, a record with avalid constant "Order" but contains four fields, such as"Order,ID1234,Aug20,CA" is parsed successfully but "CA" will not be a part ofthe output XML. The following warning message is displayed: The line[Order,ID1234,Aug20,CA] has been mapped with class [Order], extra

fields of the input line has been discarded in Output XML.

40


Configuring Positional Input SchemaYou can configure a positional input schema using File for Unix and Windows Resource Configuration.

Procedure

1. Configure attributes in the Input Positional Record.For detailed information about these attributes, see Positional Input Schema.

2. In the Attributes Panel Click Add to add some fields.The name of the field is generated automatically as field, field1, field2 and so on. You can edit thefield names. With the Add, Remove, Up and Down buttons, you can add or remove attributes,move attributes up and down.

3. Configure the Type, Start, Length, Constant, and Use columns for the added fields.

● Type

The data type in the corresponding field in the file is converted to before parsing.

When you use the dateTime type, you must specify the pattern and locale: right-click the fieldname and select Set locale and pattern, and then select a supported locale and pattern from thelist.

The parser that matches the pattern specified with the actual date and time is not astrict parser. Even if the pattern and the actual date and time do not match, you mightnot receive an error. To ensure that the pattern used is correct, you have to verify thedate and time actually published 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

Enter a constant value for the appropriate field.

● Use

By default the use column is checked. If the Use column is unchecked, the selected field will notbe a part of the output schema.

Positional Input Schema

The positional input schema has some attributes, you can check the following table for the attributesand the corresponding description:


Name The file record names have alphanumeric characters only. Each name isunique within the plugin configuration.

Description (Optional) A short description for the positional file record.

Strip Blanks Select this check box to remove the blank spaces for each field identified forthe record in data file.

41



Identifier Type Specifies the method to identify a record. Field Value (constant field value)and Record Length are available options.

When the Identifier Type field is set to Field Value, the constant attributefor one of the fields is specified when defining the fields for the records. Ifthe constant field matches but the count exceeds the expected field count,then line is parsed successfully and a warning message is displayed: Theline {0} has been mapped with class {1}, extra fields of the input line hasbeen discarded in Output XML.

For example, an input schema defines a record to contain three String fieldswith the first field containing a constant string "Order". A record, such as"Order,ID1234,Aug20" is accepted by parser activity. However, a record witha valid constant 'Order" but contains four fields, such as"Order,ID1234,Aug20,CA" is parsed successfully but "CA" will not be a partof the output XML. The following warning message is displayed: The line[Order,ID1234,Aug20,CA] has been mapped with class [Order],

extra fields of the input line has been discarded in Output

XML

Length This field is available only if you have selected Record Length in theIdentifier Type field.

Defining Output SchemasThe schemas available in Files for Unix and Windows Resource Configuration are : Output Record(Classic) and Output Record (Manual)

To define a output schema, complete the following tasks:

Procedure

1. Create an output schemaSee Creating an Output Schema (Classic) or Creating an Output Schema (Manual).

2. Defining Relationships

3. Configuring an Output Schema

Creating Output Schema (Classic)

Prerequisites

Before clicking Add Output Record (Classic), you have to add input schema or output schema(manual) to the resource configuration, otherwise no schemas will be available in the Select Schemawindow. For more information, see Creating an Input Schema or Creating an Output Schema (Manual)

To create Output Schema (Classic), complete the following steps:

Procedure

1. Expand the created project in the Project Explorer view.

2. Right-click the Resource folder and click New > Files Configuration

42


3. In the Files for Unix and Windows Resource Configuration wizard, complete the configuration andclick Finish. The resource folder, package name, and resource name of the Files configuration areprovided by default. However, you can change the default values if required.The Files for Unix and Windows Resource Configuration is created.

4. After the Files for Unix and Windows Configuration is created, in the Schema Creation panel, selectthe mode: Manual or Upload XSD.



5. On the Schema tab, click Add Output Record (Classic).6. In the Select Schema wizard, select the name of the schema to be associated to output record

(classic). You can search for the schema name from the type filter text field. This field accepts onlyregular expressions as a part of the search key. Schemas from all the shared resource within thecurrent project and within the shared modules are displayed in the wizard.

Creating a Output Schema (Manual)If you want to create a write schema manually, you can click Add Output Record (Manual).

An Output Schema (Manual) has only one root record. A root record can have many child records, andeach child record can have many child records.

To create Output Schema (Manual), complete the following steps:

Procedure

1. Expand the created project in the Project Explorer view.2. Right-click the Resource folder and click New > Files Configuration3. In the Files for Unix and Windows Resource Configuration wizard, complete the configuration and

click Finish. The resource folder, package name, and resource name of the Files configuration areprovided by default. However, you can change the default values if required.The Files for Unix and Windows Resource Configuration is created.

4. After the Files for Unix and Windows Configuration is created, in the Schema Creation panel, selectthe mode: Manual and Upload XSD .



5. On the Schema tab, click Add Output Record (Manual) and configure the record added in Step 5.

For detailed information about configuration, see Configuring an Output Schema.

Optionally, you can specify a new name for the schema and provide a description.

Defining RelationshipThe output schema reflects the relationship of the file records. The relationship in the output schemadetermines the sequence of lines that are generated in the output file.

The first file record generated or created for the output schema is referred to as root record. All theother records created after the first file record are referred to as child records of the root record.

43


A root record can have many child records, and each child record can further have child records.

For example, if an output schema is defined as follows:

Order Cutomer Item

The data file contains the following records.

OrderCutomerItemItemOrderCustomerItem

Configuring an Output SchemaYou can configure an output schema using Files for Unix and Windows Resource Configuration.

Procedure

1. Configure attributes in the Output Record.For detailed information about these attributes, see Output Schema

2. In the attributes panel, click Add to add some fields.

The name of the field is generated automatically as field, field1, field2 and so on. You can edit thefield names. With the Add, Remove, Up and Down buttons, you can add or remove attributes,move attributes up and down.Attributes are editable. You can change the fields of the attributes or change the number ofattributes.

● To edit an attribute, click the attribute.● To add an attribute, click Add.● To remove a field, click Remove.● To shuffle fields, click Up or Down.● To set default value for an attribute, right-click the attribute.

3. Configure the Name, Type, Width, Alignment, Padding, Sign, Precision, Sc.Notation and UpperCase for the added fields.

● Name

By default the name of the first attribute is field. You can change the name of the attribute,according to your requirenments.

● Type

The data type of the attribute.

If the dateTime type is used, you must specify the pattern and locale: right-click the field nameand select Set locale and pattern, and then select a supported Locale and Pattern from the list.

● Width

The number of characters used to represent the field. Zero (0) signifies that the field is notincluded in the output line. Negative one (-1) signifies that as many characters as needed(without padding) are used. Negative one (-1) is the default width selected for the field and it isalso the default value for lines that use delimiters. Lines using the Positional method cannotspecify -1.

44


● Alignment

Specifies whether the data is aligned to the left or the right.

● Padding

The character added to this field pads the field to the specified width.

● Sign

This attribute is used for numeric fields only. It is used to add a prefix to the positive signbefore positive numbers in the output. If you want to display the sign in the output, set it toTrue; 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 as follows:

● Scientific notation: 3.142e+1

● Non-scientific 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 ofthis field. To use the scientific notation, set it to True.

● Upper Case

Valid only when the Sc. Notation is set to True. When this field is set to True, the E in thescientific notation is in uppercase. When this field is set to False, the e in the scientific notationis in lowercase.

4. Modify the relationship of file records in a output schema.The output schema reflects the relationship of the file records. The relationship in the outputschema determines the sequence of lines that are generated in the output file.

For example, if the output schema is defined as follows:WriteSchema FileRecord_Parent FileRecord_Child_1 FileRecord_Child_2 ... ...

The sequence of the 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 output schema. Select the child record youwant to move and select Move Up or Move Down from the File Schemas panel or right-click thechild record, and select Move Up or Move Down in the pop-up menu to change the order.

Once you change the order of the child records of a output schema, the child records are written to afile in the exact same order as you have configured for the output schema at design time.

45


Output Schema

A output schema has some attributes, you can check the following table for the attributes andcorresponding description.


Name The file record names have alphanumeric characters only. Each name isunique within the plug-in configuration.

Write Schema Type Classic and Manual are the two available types. A value is set when youcreate the output schema.

Parse Specifies whether the generated output line uses a delimiter to separatefields or whether it uses absolute line positions. Delimited and Positionalare the available choices.

● Delimited

Select the choices specified in the Delimiter configuration item toseparate fields within each generated output line.

● Positional

Use the line position to separate fields. That is, each field begins at afixed position (offset from the start of the line).

Delimiter Specifies the separator between fields within each line of a file for the linethat is processed. Space, Tab and Other are available choices. If you selectOther, the Delimiter Other field becomes available.

Delimiter Other This field is available only if you select Other in the Delimiter list. Specifiesthe delimiter to be used. You can specify single or multiple characters as adelimiter.

46


Advanced Topics

When you use TIBCO ActiveMatrix BusinessWorks™ Plug-in for Files for Unix and Windows, you canuse advanced configuration and deployment.

Pre and Post Processing ScriptsPreprocessing and postprocessing scripts return a processing status message back to the activity. Theactivity writes the processing status message to the log (Info role, 300010 for preprocessing statusmessage and 300011 for postprocessing status message).

Additionally, the preprocessing script informs the activity to skip processing the input file, byappending the string "Skip the input file" to the status message. And then the parser activityskips the input file and proceeds to process the next file.

To turn on this feature, the string %ScriptStatusFile% is specified as the last argument in the PreProcessing Arguments or Post Processing Arguments field.

At run time, the parser activity substitutes a valid temporary file name to this argument automatically.The script writes the status message, if any, into this file. The parser activity reads the temporary file,and logs the status message to the registered sinks.

File Recognition MethodsParser Activity has various configuration setting combinations, you can check the listed configurationsetting combinations and the results. Each of the first four columns indicates a field value. An emptycolumn indicates no value is specified in the corresponding field.

RecognitionMethod

FilePrefix

FileExtension

Trigger FileExtension Result

By prefix +extension

All files in the input directory areprocessed. This option is similar to usingthe *.* command.

delimited Only files in the input directory thatcontain delimited in the file prefix areprocessed. This option is similar to using adelimited.* command. For example,delimited.txt, delimited123.txt,delimited456.csv.

delimited txt Only files in the input directory thatcontain delimited in the file prefix andhave a .txt extension are processed.

txt Only files in the input directory with .txtfile extensions are processed. This optionis similar to using a *.txt command. Forexample, abc.txt, 123.txt.

47


RecognitionMethod

FilePrefix

FileExtension

Trigger FileExtension Result

By Trigger trg This is equivalent to specifying that whena prefix.trg trigger file is created in theinput directory, the plug-in searches for afile named prefix, since the file extension isempty.

For example, if a file nameddelimited.trg is created in the inputdirectory, the plug-in only parses files fora file named delimited. If a file namedpayments.trg is created, the plug-insearches for a file named payments.

delimited trg When a delimited.trg trigger file iscreated, the plug-in searches for a filenamed delimited. Similarly, if adelimited2.trg file is created, the plug-in searches for a file named delimited2.

In this example, a file namedpayments.trg is ignored by the plug-in.

delimited txt trg When a delimited.trg trigger file iscreated, the plug-in searches for a filenamed delimited.txt.

If a delimited2.txt file is present, it isnot processed. The file is processed whendelimited2.trg is created.

In general, when the prefix name of thetrigger file matches the prefix name of thefile extension, the plug-in processes thefile.

txt trg When a prefix.trg trigger file is created,the plug-in searches for a file namedprefix.txt.

Similarly, when a payments.trg triggerfile is created, the plug-in searches for afile named payments.txt.

Data ValidationThe file parser activity performs data validation. You can check the following table for the valid formatand range of each data type. When a field contains data that does not conform to the format or datawhose value is beyond the valid range, the entire record is discarded and an error message is logged.

Data Type Format Valid Range

i1 [whitespace][{+|-}][digits] <-128,127>


48


Data Type Format Valid Range



ui1 [whitespace][+][digits] <0,127>




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>

DateTime A list of predefined patterns and anoption to specify user-definedpatterns are available. If the user-defined pattern option is enabled,you can use User-Defined Pattern tospecify the pattern. For syntax andsemantics for specifying the pattern,see Synatx for Specifying User-defined Date and Time Patterns .

File Content EncodingTo interoperate with other TIBCO ActiveEnterprise applications, you have to set plug-in configurationencoding for the repository correctly.

Content Encodings

The plug-in processes file contents with various encodings. This is provided as a configurationparameter for the file parser and file serializer activity.

The standard that TIBCO ActiveEnterprise uses is LATIN_1 or ISO-8859-1 for exchanging LATIN_1 orASCII data, and UTF-8 for other encoding such as SHIFT_JIS.

Depending on the file encoding setting for the plug-in configuration, the repository instance encodinghas to be correctly set. The repository instance encoding determines whether the data is exchanged inLATIN_1 or UTF-8. The default repository encoding for local or the remote repository is LATIN_1 orISO-8859-1. This confirms to the file encodings LATIN_1 and ASCII.

When processing other encoding such as SHIFT_JIS, the repository instance encoding must be set toUTF-8.

49


Syntax for Specifying User-defined Date and Time PatternsThe date and time symbols are used as patterns to interpret and generate date and time in variousformats.

Symbol Meaning Presentation Example

G era designator (Text) AD

y year (Number) 1996

Y year/week of year (Number) 1996

M month in year (Text or Number) July or 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

z time zone (Text) Pacific Standard Time

' escape for text

'' single quote '

50


Locales Supported for Date and TimeThe country and language codes supported by the plug-in are listed with corresponding abbreviations.

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

ca_ES Catalan Spain

ca_ES_EURO Catalan Spain

cs_CZ Czech Republic

da_DK Danish Denmark

de_AT German Austria

51



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

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

52



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

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

53



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

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

54



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

Fault ToleranceFault Tolerance allows multiple application nodes to substitute for each other. When the primaryapplication node terminates unexpectedly, the token held by the primary application node can be takenover by an application node in the standby state. In the process of replacement, the standby applicationnode is promoted to the primary application node.

To apply Fault Tolerance, you can select one of the following methods:

● In the process designer, right-click and select Show Properties View. Navigate to the Advanced tab.Select Activation as Single AppNode.

● Setup ActiveMatrix BusinessWorks Administrator in a Fault Tolerance group.

For more information on fault tolerance in BusinessWorks, refer to the TIBCO ActiveMatrixBusinessWorks™ Administration guide.

In case of file serializer activity Fault Tolerance is supported for only Wip Creation Mode as one jobper file.

Load Balancing ModeIn TIBCO ActiveMatrix BusinessWorks™ Plug-in for Files for Unix and Windows, you can deploy theapplications containing the file parser activity accross multiple appnodes allowing multiple files to beprocessed in parallel.

Before file parser activity in plug-in configuration processes an input file, the plug-in configurationlocks the file by creating a .lck file. Therefore other plug-in configurations ignore this input file andfind other input files to parse.

● In file parser activity, Load Balancing feature is not applicable when Leave as is, is selected in PostProcessing field.

● In file parser activity, Load Balancing mode cannot be used together with Delta Publishing mode asDelta Publishing Mode works with Leave as is.

● In case of file serializer activity, Load Balancing is not supported.

Delta Publishing ModeWhen Delta Publishing mode is enabled, the parser activity checks the input file on a preconfiguredtimer interval, and copies any new data to a work file, and then processes and parses it.

To better explain the mechanism of Delta Publishing mode, the following example is used.

55


The input file is shown as follows:Order, ID41678, 20May2000Item, GigaWidget, 60, $75Item, MegaBucket, 48, $125Customer, Hopkins Associates, ID26490Order, ID41680, 20May2000Item, Rt.Clopper, 40, $100Item, Lt.Clopper, 50, $100Customer, Jersey WebInovaters, ID46786

When using Delta Publishing mode, you have to consider the following two conditions:

● Each line

Each line might be processed in the input file by another application at intervals. The intervals areset at three times of the polling interval that you have set in the Delta Flush Interval tab. When aline is parsed as one message in Delta Publishing mode, the intervals are reset.

● Each complete message

A complete message is processed in the input file at intervals. The intervals are set at three times ofthe polling interval you have set in the Delta Flush Interval tab. In this example, according to InputSchema, Order is the root record, so the first 4 lines form a complete message, and the last 4 linesform another complete message.

In Delta Publishing mode, the plug-in cannot recognize where the next complete message starts,and the data is processed in the input file by another application continuously. If no data isprocessed in the input file at the specified intervals (3 times of the polling interval), the last 4 linesare parsed as a complete message.

After the last 4 lines are parsed as a complete message in Delta Publishing mode, other dataappended to the last line is not allowed. For example, after parsing the last 4 lines as a completemessage, it is not allowed to append data to line 8 as follows: Customer, Jersey WebInovaters,ID46786 fdsfdsfds

CheckPoint RestartFile Parser activity by default supports CheckPoint Restart.

CheckPoint Restart stores records in a progress file when the process crashes. If the process crasheswhen the file is processing, the file parser activity will continue to process the file from where it crashesupon restart. The restart information is stored in a progress file in the directory.

For uniqueness, progress file name includes application name, appnode name, and appspace name, andprocess name.

For example,__CheckPointRestart_test123_BWEclipseAppNode_BWEclipseAppSpace_test.Process.prg. In this,

● test123 is application name

● BWEclipseAppNode is AppNode name

● BWEclipseAppSpace is AppSpace name

● test.Process is process name

When the plug-in exits abnormally, the following situations occasionally occur:

● Duplicate Messages

File parser occasionally writes a duplicate message after a checkpoint restart.

● Missing File in the Working Directory

56


Missing file in the working directory occurs when the postprocessing on the working file iscompleted but the progress file is not updated. Upon restart, the plug-in prompts that the file in theworking directory is missing.

TIBCO recommends that you set the progress directory if you want to enable the CheckPoint Restartfeature.

57


Migrating Projects

You can migrate an adapter project created in TIBCO ActiveMatrix Business 5.x designer to TIBCOActiveMatrix BusinessWorks 6.x or TIBCO BusinessWorks™ Container Edition studio by using themigration tool in TIBCO Business Studio.

You can migrate a TIBCO ActiveMatrix BusinessWorks 5.x project to a TIBCO ActiveMatrixBusinessWorks 6.x project but migration in other direction is not supported.

There are some files in the project that gets migrated from TIBCO ActiveMatrix BusinessWorks 5.xproject but are not used in TIBCO ActiveMatrix BusinessWorks 6.x. Such files should be ignored. Forexample, - ae folder and ae2xsd.xsd under Schemas folder, AESchemas folder, etc.

Migrating projects from Adapter to Plug-inYou can migrate TIBCO ActiveMatrix® Adapter for Files Unix/Win projects created in TIBCOActiveMatrix BusinessWork 5.x designer to TIBCO ActiveMatrix BusinessWorks™ Plug-in for FilesUnix and Windows in the following manner

Procedure

1. Start TIBCO Business Studio.

2. Click Project tab and select Migrate BW Projects.

3. In the Project Migration Wizard, click Browse in the Select Project(s) to be Migrated field and selectthe project you want to migrate.The default selection is Migrate Single BusinessWorks 5.x Project. Click Migrate MultipleBusinessWorks 5.x Projects to migrate mutliple 5.x projects.

4. Click Migrate Project.

5. Click Start Migration.

6. Click Finish after the migration is complete.

Migrating projects with Adapter Subscriber activity and Publication ServiceYou can migrate your projects that use the Adapter Subscriber from ActiveEnterprise Adapter paletteand Publication Service of TIBCO ActiveMatrix® Adapter for Files Unix/Win to File Parser Activity inTIBCO ActiveMatrix BusinessWorks™ Plug-in for Files Unix and Windows in the following manner

Procedure



3. In the Project Migration Wizard, the default selection is Migrate Single BusinessWorks 5.x Projectin the Migration Project Type section. Click Migrate Multiple BusinessWorks 5.x Projects tomigrate mutliple 5.x projects.

4. In the Select Project Location section, click Browse in the Select Project(s) to be Migrated field andselect the project you want to migrate.



7. Click Finish after the migration is complete.All the migrated projects are displayed in the Project Explorer view at the parent level.

58


All the schemas defined under File Schemas folder of File Adapter Configuration is migrated toschemas under a shared resource. Name of the migrated shared resource is the name of FileAdapter Configuration and the extension of the shared resource. For example,FileAdapterConfiguration.filesResource. All the properties of the schemas that areconfigured in the file adapter is also migrated.

All the configurations of the Publication Service is migrated to respective fields of File Parseractivity under General and Advanced tab. In the General tab of the migrated File Parser activity,the migrated shared resource will be mapped to Configuration resource field. The schema selectedin the Publication Service is mapped to schema picker of migrated File Parser activity.

In the migrated activity, the fields that are not present in the Publication Service but in theFile Parser will have default values. These fields can be configured through JSONpreference file. For more information, see Working with Preference File (JSON) formigration.

8. To run the migrated project, from the menu bar click Run > Debug Configurations.

9. In the Debug Configurations windows, click Debug.

Publication Service fields not supported for migrationWhile migrating projects from TIBCO ActiveMatrix® Adapter for Files for Unix/Win to TIBCOActiveMatrix BusinessWorks™ Plug-in for Files for Unix and Windows there are some fields in theadapter services and the schemas of the File Adapter Configuration that may default or do not supportmigration as listed in the following tables.

Configuration tab of the Publication Service in TIBCO ActiveMatrix® Adapter for Files for Unix/Win

Field Migration

Name Not Supported

Description Not Supported

Transport Type Not Supported

Transport Mode Not Supported

Preserve Undelivered Not Supported

Lifecycle > Repeating Default (The default value for lifecycle field isrepeating)

Polling Method > Timer Default (The default value for Polling Methodfield is timer )

Polling Method > RV Message Not Supported

Polling Subject Not Supported

Processing tab of the Publication Service in TIBCO ActiveMatrix® Adapter for Files for Unix/Win

Field Migration

Error Directory Not Supported

Schema tab of the Publication Service in TIBCO ActiveMatrix® Adapter for Files for Unix/Win

59


● During migration, if multiple schemas are selected in the Schema tab of the Publication Service,only one schema is migrated because File Parser activity supports selection of only one schema.

● During migration, in the Schema tab the schema and attribute names that contain underscore (_) isnot supported.

Field Migration

is Base Record Not Supported

Container Record Not Supported

Attribute > Data Type > Record Not Supported

Position from Header > Begin Default

Position from Header > End Not Supported

Delimited Schema > Sample Value Not Supported

Positional Schema > Sample Value Not Supported

Delimited Schema > Display Wizard Not Supported

Positional Schema > Display Wizard Not Supported

Transport tab of the Publication Service is not supported for migration.

Encoding tab of the Publication Service in TIBCO ActiveMatrix® Adapter for Files for Unix/Win

Field Migration

File System Encoding Not Supported

File System Encoding Other Not Supported

Advanced tab of the Publication Service in TIBCO ActiveMatrix® Adapter for Files for Unix/Win

Field Migration

Document Delay Not Supported

Business Document Support Not Supported

Input Buffer Max Size Not Supported

Check point Restart Default

Only Publish an identified object whoseassociations, if defined, have no errors

Not Supported

60


Migrating projects with Publish to Adapter activity and SubscriptionService

You can migrate your projects that use the Publish to Adapter from ActiveEnterprise Adapter paletteand Subscription Service in TIBCO ActiveMatrix® Adapter for Files Unix/Win to File Serializer Activityin TIBCO ActiveMatrix BusinessWorks™ Plug-in for Files Unix and Windows in the following manner

Procedure



3. In the Project Migration Wizard, the default selection is Migrate Single BusinessWorks 5.x Projectin the Migration Project Type section. Click Migrate Multiple BusinessWorks 5.x Projects tomigrate mutliple 5.x projects.

4. In the Select Project Location section, click Browse in the Select Project(s) to be Migrated field andselect the project you want to migrate.



7. Click Finish after the migration is complete.All the migrated projects are displayed in the Project Explorer view at the parent level.

All the schemas defined under File Schemas folder of File Adapter Configuration is migrated toschemas under a shared resource. Name of the migrated shared resource is the name of FileAdapter Configuration and the extension of the shared resource. For example,FileAdapterConfiguration.filesResource. All the properties of the schemas that areconfigured in the file adapter is also migrated.

All the configurations of the Subscription service is migrated to respective fields of File Serializeractivity under General and Advanced tab. In the General tab of the migrated File Serializer activity,the migrated shared resource will be mapped to Configuration resource field. The schema selectedin the Subscription service is mapped to schema picker of migrated File Serializer activity.

In the migrated activity, the fields that are not present in the Subscription Service but inthe File Serializer will have default values. These fields can be configured through JSONpreference file. For more information, see Working with Preference File (JSON) formigration.

8. To run the migrated project, from the menu bar click Run > Debug Configurations.

9. In the Debug Configurations windows, click Debug.

Subscription Service fields not supported for MigrationWhile migrating projects from TIBCO ActiveMatrix® Adapter for Files for Unix/Win to TIBCOActiveMatrix BusinessWorks™ Plug-in for Files for Unix and Windows there are some fields in theadapter services and the schemas of the File Adapter configuration that do not support migration.

Configuration tab of the Subscription Service in TIBCO ActiveMatrix® Adapter for Files for Unix/Win

Field Migration

Name Not Supported

Description Not Supported

61


Field Migration

Transport Type Not Supported

Transport Mode Not Supported

WIP Creation Mode > Append messages to file,Close on rvMessage

Default values will be set- WIP Creation Modeas Append messages to file, Closer on Timer,and Close File after elapsed (minutes) as 1.

WIP Creation Mode > Append messages to file,Close on jmsMessage


WIP Creation Mode > Append messages to file,Close on Business Document Lot End


File Name Selection Not Supported

Message Time Out (Minutes) Not Supported

Closing Subscriber Not Supported

Schema tab of the Subscription Service in TIBCO ActiveMatrix® Adapter for Files for Unix/Win

● During migration, if multiple schemas are selected in the Schema tab of the Subscription Service,only one schema is migrated because File Serializer activity supports selection of only one schema.

● During migration, in the Schema tab the schema and atrribute names that contain underscore (_) isnot supported.

Field Migration

Wire Schema Path Not Supported

The fields in the Transport tab of the Subscription Service is not supported for migration.

Encoding tab of the Subscription Service in TIBCO ActiveMatrix® Adapter for Files for Unix/Win

Field Migration

File System Encoding Not Supported

File System Encoding Other Not Supported

Advanced tab of the Subscription Service in TIBCO ActiveMatrix® Adapter for Files for Unix/Win

Field Migration

User Exit Endpoint Reference Not Supported

Working with Preference File (JSON format) for migrationWhen a user wants to migrate a TIBCO ActiveMatrix BusinessWorks 5.x project to a TIBCOActiveMatrix BusinessWorks 6.x project or TIBCO BusinessWorks™ Container Edition project and if

62


they want to use the feature of preferences then a adapter2plugin.json file would need to be createdin the root folder of TIBCO ActiveMatrix BusinessWorks 5.x project.

A template of the preference file would be installed in the tools folder of the plug-in in the followinglocation:

$TIBCO_HOME/bw/palettes/files/version/tools/adapter2plugin.json_template

A Preference file (JSON format) can be used in the following manner:

● To override configuration defined in the TIBCO ActiveMatrix BusinessWorks 5.x project and theadapter services carried over to the plug-in.

● To provide the configuration available in the plug-in but not available in TIBCO ActiveMatrixBusinessWorks 5.x project.

● Users should not copy and use the JSON preference file as it is, as this file is only provided forreference. If user wants to use this file, then they need to similarly create a JSON file and mentionthe properties which are needed in the file.

● The file created under the root folder of the TIBCO ActiveMatrix BusinessWorks™ 5.x projects willnot just contain Files but also other plug-ins that supports adapter migration.

In terms of values, the values could either be literals or references to module properties which wouldpertain to global variables from TIBCO ActiveMatrix BusinessWorks 5.x project.

To configure as a Literal Value:

To set the working directory of File Parser activity to D:\\work using JSON file, set the value as

"workingDirectory" : "D:\\work"

To configure as a Module Property:

To use a global variable in JSON file, the user needs to have a same global variable declared with avalue in the corresponding TIBCO ActiveMatrix BusinessWorks™ 5.x project. Then the user can add theglobal variable in JSON file. To set a working directory of File Parser activity to D:\\work using JSONfile as a global variable, add a global variable in TIBCO ActiveMatrix BusinessWorks™ 5.x project aswork_dir and set the value as D:\\work. Now in JSON file, set the value as

"workingDirectory": "%%work_dir%%"

● The location and filename of the preference file is not configurable.

● The usage of the preference file does not support the creation of module properties in migratedprojects.

● The usage of preference file is applicable to all adapter configurations in the TIBCO ActiveMatrixBusinessWorks 5.x project during migration.

● Since the module properties in TIBCO ActiveMatrix BusinessWorks 6.x project is case sensitive, themodule properties in the preference file should have the same case as the TIBCO ActiveMatrixBusinessWorks 5.x project.

● When any value is applied from the preference file , the MigrationReport.log contains logs withkey and value in uppercase.

● All directory paths mentioned in the preference file should be defined using escape characters ifvalue follows convention C:\temp. Value in preference file would be C:\\temp.

63


Sample Project Overview

The sample projects help to understand how TIBCO ActiveMatrix BusinessWorks™ Plug-in for Files forUnix and Windows operates.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Files for Unix and Windows is packaged with sampleprojects. After installing the plug-in, the following sample projects can be found in the TIBCO_HOME\bw\palettes\files\version_number\samples\Examples directory.

● DateTime Project

● MultiDelimiter Project

● Positional Project

● FileSerializer Manual Project

● ParserAndSerializer Project

64


Importing Sample Projects

Before running a sample project, you have to import it to TIBCO Business Studio™.

Procedure


2. From the menu bar, click File > Import.

3. In the Import dialog, expand the General folder, and then click Existing Studio Projects intoWorkspace. Click Next.

4. In the Import Projects dialog, click Select archive file, and then click Browse next to it to locate asample project. For example, select the DateTime.zip file, and then click Open.

The sample projects are located in the TIBCO_HOME/bw/palettes/files/version_number/samples/Examples directory.

5. Click Finish.

Result

The DateTime project is imported to TIBCO Business Studio™.

65


DateTime Project

The DateTime project contains one process: date.time process. The sample project shows how the plug-in handles date and time.

DateTime Process

In this example, the file parser activity parses the time.txt file which has the second field set to the longdate and time format. The file parser activity is configured to parse a record that has different dateformats.

The following figure describes the DateTime process:

Setting Up the ProjectBefore running the project, you have to set it up.

Prerequisites

You have to import the DateTime project before setting it up. For more information, see ImportingSample Projects.

Procedure

1. Expand the imported project in the Project Explorer view.

2. Expand the Module Descriptors resource, and then double-click Module Properties.

3. In the Module Properties panel, complete the following tasks:a) Set the value of the INPUT_DIR field to the path where the input directory is located in your local

machine.For example, D:\BW6\bw\palettes\files\8.0\samples\Input.

b) Set the value of the WORK_DIR field to the path where the work directory is located in your localmachine.For example, D:\BW6\bw\palettes\files\8.0\samples\Work.

c) Set the value of the PROGRESS_DIR field to the path where the progress directory is located inyour local machine.For example, D:\BW6\bw\palettes\files\8.0\samples\Progress.

4. From the menu bar, click File > Save to save the project.

66


Running the ProjectAfter setting up the project, you can run it.

Procedure

1. In the Project Explorer view, expand the Module Descriptors resource, and then double-clickComponents.

2. In the Components editor, click and select the process that you want to run.

3. On the toolbar, click the icon to save your changes.

4. From the menu bar, click Run > Debug Configurations to run the selected process.

5. In the Debug Configurations dialog, expand BusinessWorks Application, and then clickBWApplication.

6. In the right panel, click the Applications tab, and then select the check box next toDateTime.application.

7. Click Debug to run the process.

8. Click the icon to stop the process.

Result

When the datetime process runs successfully, the OUTPUT directory contains the following file:

● timeOutput.txt

67


MultiDelimiter Project

The MultiDelimiter project contains one process: multidelimiter.process. The sample project shows howthe plug-in handles files with multiple delimiters.

MutliDelimiter Process

In this example, the file parser activity parses the multidelim.txt file and parses each line with a pair ofcommas as multiple delimiters. To enable the file parser activity to parse the multidelim.txt file, theinput schema defines three file records: Customer, Business and Contact. The Customer record isconfigured with a comma as the delimiter between fields. The Business record is configured with twopercentage characters (%%) and the Contact record is configured with two hyphens and two asterisks (-**-) as the delimiters between each field.

The following figure describes the multidelimiter process:


Prerequisites

You have to import the DateTime project before setting it up. For more information, see ImportingSample Projects.

Procedure







68




Procedure






6. In the right panel, click the Applications tab, and then select the check box next toMultiDelimiter.application.



Result

When the multidelimiter process runs sucessfully, the OUTPUT folder contains the following file:

● multidelimOut.txt

69


Positional Project

The Positional project contains one process: positional.process. The sample project shows how the fileparser activity processes file based on postitional schema.

Positional Process

In this example, the file parser activity parses the positional.txt file and creates a record for each orderID, item and customer that it finds in the input file. File parser sends each record in a separate job. Afterprocessing all lines in the input file, parser exits.

The following figure describes the Positional process:


Prerequisites

You have to import the Positional project before setting it up. For more information, see ImportingSample Projects.

Procedure








70



Procedure






6. In the right panel, click the Applications tab, and then select the check box next toPositional.application.



Result

When the positional process runs sucessfully, the OUTPUT folder contains the following file:

● positionalOut.txt

71


FileSerializer Manual Project

The FileSerializer Manual project contains one process: outputrecordmanual.Process. The sampleproject shows how the file serializer activity reads a xml file and parses the xml file to the output filebased on output schema.

OutputRecordManual Process

In this example, the ReadFile activity reads the output.xml file , and its output is given as input toParseXml activity. The ParseXML activity parses the output.xml file and its output is given as input toFileSerializer activity. The FileSerializer activity processes the xml input based schema on the outputschema selected and writes data to output.txt file .

The following figure describes the OutputRecordManual process:


Prerequisites

You have to import the FileSerializerManual project before setting it up. For more information, see Importing Sample Projects.

Procedure



3. In the Module Properties panel, complete the following tasks:a) Set the value of the outputDirectory field to the path where the input directory is located in

your local machine.For example, D:\BW6\bw\palettes\files\8.0\samples\Output.

72


b) Set the value of the workingDirectory field to the path where the work directory is located inyour local machine.For example, D:\BW6\bw\palettes\files\8.0\samples\Work.

c) Set the value of the progressDirectory field to the path where the progress directory is locatedin your local machine.For example, D:\BW6\bw\palettes\files\8.0\samples\Progress.

d) Set the value of the errorDirectory field to the path where the error directory is located in yourlocal machine.For example, D:\BW6\bw\palettes\files\8.0\samples\Error.

e) Set the value of the examplePath field to the path where the example is located in your localmachine.For example, C:\Users\ndivecha\File1\FileSerializerManual.



Procedure









Result

When the process runs sucessfully, the OUTPUT folder contains the following file:

● output.txt

73


ParserAndSerializer Project

The ParserandSerializer project contains one process: parserandserializer.process. The sample projectshows how the file parser activity processes the input file based on the picked input schema and howthe file serializer processes the output of the file parser activity based on the output schema picked andwrites it to a text file.

ParserandSerializer Process

In this example, the file parser activity parses the ParserandSerializer.txt input file. The ouput from thefile parser activity is given as an input to the file serializer activity. The file serializer activity then writesthe output to the ParserandSerializerOutput.txt output file.

Depending on the option selected in the Append field of the Options for modifying output Filenamein the Advanced Tab of the File Serializer activity, the output file name is generated.

● If Timestamp option is selected for the Append field, the timestamp will be appended to the outputfile name. For example, ParserAndSerializerOutput.txt20180306181146935.

● If Sequence Number option is selected for the Append field, the sequence number will beappended to the output file name. For example, ParserAndSerializerOutput.txt0000

The following figure describes the ParserandSerializer process:


Prerequisites

You have to import the ParserAndSerializer project before setting it up. For more information, see Importing Sample Projects.

Procedure



3. In the Module Properties panel, complete the following tasks:

74


a) Set the value of the inputDirectory field to the path where the input directory is located inyour local machine.For example, D:\BW6\bw\palettes\files\8.0\samples\Input.

b) Set the value of the workingDirectory field to the path where the work directory is located inyour local machine.For example, D:\BW6\bw\palettes\files\8.0\samples\Work.

c) Set the value of the progressDirectory field to the path where the progress directory is locatedin your local machine.For example, D:\BW6\bw\palettes\files\8.0\samples\Progress.

d) Set the value of the outputDirectory field to the path where the progress directory is located inyour local machine.For example, D:\BW6\bw\palettes\files\8.0\samples\Output.

e) Set the value of the errorDirectory field to the path where the progress directory is located inyour local machine.For example, D:\BW6\bw\palettes\files\8.0\samples\Error.



Procedure









Result

When the parserandserializer process runs sucessfully, the OUTPUT folder contains the following file:

● ParserAndSerializerOutput.txt20180306181146935

75


Troubleshooting

When you encounter problems with the project, ensure that you have cleaned up the project.If errors occur when you run a process in TIBCO Business Studio, you can do a cleaning first. Cleaningdeletes all the old files and reorganizes the project.

Procedure

1. Right-click the project in the Project Explorer view and click Refresh.

2. Select Project > Clean to start the cleaning.

If the plug-in fails to connect to the application on the Files server, please check thefirewall settings accordingly.

76


Log Management

When an error occurs, you can check logs to trace and troubleshoot the plug-in exceptions.

By default, error logs are displayed in the Console view when you run a process in the debug mode.You can change the log level of the plug-in to trace different messages and export logs to a file. Differentlog levels correspond to different messages, as described in Log Levels.

Log LevelsDifferent log levels include different information.

The plug-in supports the following log levels:

Log Level Description

Trace Includes all information regarding the running process.

Debug Indicates a developer-defined tracing message.

Info Indicates normal plug-in operations. No action is required. A tracing messagetagged with Info indicates that a significant processing step is reached, andlogged for tracking or auditing purposes. Only info messages preceding atracking identifier are considered as significant steps.

Warn Indicates that an abnormal condition occurred. Processing continues, butspecial attention from an administrator is recommended.

Error Indicates that an unrecoverable error occurred. Depending on the severity ofthe error, the plug-in might continue with the next operation or might stop.

Setting up Log LevelsYou can configure different log levels for the plug-in and plug-in activities to trace different messages.By default, the plug-in uses the log level configured for TIBCO ActiveMatrix BusinessWorks. Thedefault log level of TIBCO ActiveMatrix BusinessWorks is Error.

Procedure

1. Navigate to the TIBCO_HOME\bw\version_number\config\design\logback directory and openthe logback.xml file.

2. Add the following node in the BusinessWorks Palette and Activity logger area to specify a log levelfor the plug-in:<logger name="com.tibco.bw.palette.fileplugin.runtime"><level value="TRACE"/></logger>

The value of the level element can be Trace, Debug, Info, or Error.

If you set the log level to Debug, the input and output for the plug-in activities are alsodisplayed in the Console view. See Log Levels for more details regarding each log level.

3. Optional. Add one of the following nodes in the BusinessWorks Palette and Activity loggers’ areato control a log level for the activity.

77


● To control the debug log level for the FileParser activity, set the following parameters:<logger name="com.tibco.bw.palette.fileplugin.runtime.fileparser"><level value="TRACE"/></logger>

● To control the debug log level for the FileSerializer activity, set the following parameters:<logger name="com.tibco.bw.palette.fileplugin.runtime.fileserializer"><level value="TRACE"/></logger>

● The activities that are not configured with specific log levels use the log levelconfigured for the plug-in.

4. Save the file.

Exporting Logs to a FileYou can update the logback.xml file to export plug-in logs to a file.

Procedure

1. In Windows system, navigate to TIBCO_HOME\bw\version_number\config\design\logbackdirectory and open the logback.xml file.

After deploying an application in TIBCO Enterprise Administrator, navigate to theTIBCO_HOME\bw\version_number\domains\domain_name\appnodes\space_name

\node_name directory to find the logback.xml file.

2. Add the following node to specify the file where the log is exported:<appender name="FILE" class="ch.qos.logback.core.FileAppender"><file>c:/bw6-files.log</file><encoder><pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36}-%msg%n</pattern></encoder></appender>

The value of the file element is the absolute path of the file that stores the exported log.

3. Add the following node to the root node at the end of the logback.xml file:<root level="DEBUG"><appender-ref ref="STDOUT"/><appender-ref ref="FILE"/></root>

4. Save the file.

78


Error Codes

The following table lists error codes, detailed explanation of each error, where applicable, and ways tosolve different errors.

Error Code and ErrorMessage Role Category Description Solution

TIBCO-BW-PALETTE-FILES FOR UNIX ANDWINDOWS-100002

{0}

trace BW-Plug-in

Occurs during parsing ofdetailed messages.

This is a tracemessage andresolution is notapplicable


{0}

trace BW-Plug-in

This error code isdisplayed while printingevents for File Serializeractivity.

This is a tracemessage andresolution is notapplicable


File {0} has been

parsed. Total: {1}

lines, Error: {2}

lines, {3} bytes.

debug BW-Plug-in

Occurs when status ofparsed file.

This is a debugmessage andresolution is notapplicable


{0}

debug BW-Plug-in

This error code isdisplayed while printingactivity data for FileSerializer activity.



Input : \n

debug BW-Plug-in

This error code isdisplayed while printinginput data for FileSerializer activity.



File Parser Output :

\n

{0}

debug BW-Plug-in

Occurs when File Parseroutput is generated



{0}

debug BW-Plug-in

File Parser UI Input andschema defined isdisplayed


79




Scanning Input

Directory {0}.

info BW-Plug-in

Occurs when scanning ofinput directory {0}.

This is an infomessage andresolution is notapplicable


Matched file {0},

with timely file

size {1} bytes.

info BW-Plug-in

Occurs when thematching criteria of theinput file is met.



Processing input

file {0} in Input

Directory {1}.

info BW-Plug-in

Occurs when input file ispicked for processing.



Parsing of file {0}

is finished.

info BW-Plug-in

Occurs when parsing ofinput file is finished.



Notice: {0}.

info BW-Plug-in

Notifications like, currentinstance will run withdelta and delta roundfinished appear.



{0}.

info BW-Plug-in

Occurs when file ispicked up by file parserinstance with LB mode.



File {0} has been

processed, all lines

were interpreted.

info BW-Plug-in

Occurs when input fileprocessing is finished.



Invoke preprocessing

script \"{0}\".

info BW-Plug-in

Occurs when invokingpre processing script {0}.


80




Invoke

postprocessing

script \"{0}\".

info BW-Plug-in

Occurs when invokingpost processing script {0}.



Pre Processing

Script {0} returned

message {1}.

info BW-Plug-in

Occurs when preprocessing script {0}returnd message {1}.



Post Processing

Script {0} returned

message {1}.

info BW-Plug-in

Occurs when postprocessing script {0}returnes message {1}.



{0}

warn BW-Plug-in

Occurs when the line hasbeen mapped to schemaand extra fields of theinput line has beendiscarded in OutputXML.

This is a warningmessage andresolution is notapplicable


The line \"{0}\"

contains an invalid

field.

warn BW-Plug-in

Occurs when the datatypedoes not match.



{0} couldn't be

parsed.

warn BW-Plug-in

Occurs when line doesnot match.



File {0} has been

parsed, {1} lines

couldn't be

interpreted.

warn BW-Plug-in

Occurs when input filehas error lines.


81




File Parser instance

running on AppNode

{0} encountered

error - {1}.

warn BW-Plug-in

Occurs when working filealready exists.



Pre processing

script {0} returned

error code {1}.

warn BW-Plug-in

Occurs when the preprocessing scriptexecution hasencountered an error.



Post Processing

script {0} returned

error code {1}.

warn BW-Plug-in

Occurs when postprocessing scriptexecution hasencountered an error.



Script file is not

existed.

warn BW-Plug-in

Runtime error: Script fileis not existed.



{0}

error BW-Plug-in

Errors like, IOException. Check errors listedin the errormessage, and takean appropriateaction.


File Parser error.

File Parser

encountered error

{0}.

error BW-Plug-in

Errors like, not able todelete trigger file or notable to find input filematching trigger file.

Check errors listedin the errormessage, and takean appropriateaction.


{0} The input

parameter {1} is

invalid {2}.

error BW-Plug-in

Occurs when there areinvalid inputs in FileParser activity.


82




{0}

error BW-Plug-in

Occurs when there is noaccess to ProgressDirectory.



Could not create

simple datetime

class_ Received

error code {0}.

error BW-Plug-in

Occurs when parsingdateTime field, if one ofthe two arguments ofSimpleDateFormat isspecified as null.



Failed to parse the

datetime string {0}

for the pattern

specified {1}.

Received error code

{2}.

error BW-Plug-in

Occurs when dateTimefield input is not able toparse.



{0}

error BW-Plug-in

This error code isdisplayed when internalactivity related erroroccurrs. e.g. Whilereading inputs from inputtab, shared resource orwhile processing inputs



Activity {0} failed

due to unknown error

in the process {1}

error BW-Plug-in

This error code displayedwhen an unidentifiederror is occurred whileexecuting activity



error BW-Plug-in

This error code displayedwhen validation fails forinput fields


83




No access to

Directory :

{directory specified

by user}

error BW-Plug-in

This error code isdisplayed when there isno access to particulardirectory. e.g. : workingdirectory, error directoryetc



Error occurred while

starting timer

error BW-Plug-in

This error code isdisplayed whenever antimer related error occurs.



{0}

error BW-Plug-in

This error code isdisplayed wheneverprogress file related erroroccurs.



{0}

error BW-Plug-in

This error code isdisplayed wheneverpadding related erroroccurs.



{0}

error BW-Plug-in

This error code isdisplayed whenever dataformatting related erroroccurs. e.g. Suppose userenters alphanumericcharacter for numericdata or enters invalid datefor datetime field



{0}

error BW-Plug-in

This error code isdisplayed whenever fileoperation related erroroccurs. e.g. file renamefailure, file moveoperation, file writeoperation etc



Error occurred while

executing post

processing script

error BW-Plug-in

This error code isdisplayed whenever postprocessing related erroroccurs.


84




{0}

error BW-Plug-in

Occurs when the entirerecord has not beenparsed and is part of faulttab.

This is an errormessage, fix theinput line so that itgets parsedsuccessfully

85


tibco activematrix businessworks plug-in for files for ... · important information some tibco...

Documents