tibco activematrix businessworks plug-in for microsoft ...€¦ · 4. configure the added excel...

51
TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft Excel User's Guide Software Release 6.1 August 2016 Two-Second Advantage ®

Upload: others

Post on 12-Jul-2020

6 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

TIBCO ActiveMatrix BusinessWorks™

Plug-in for Microsoft ExcelUser's GuideSoftware Release 6.1August 2016

Two-Second Advantage®

Page 2: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

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.

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, TIBCO ActiveMatrix BusinessWorks, TIBCO Enterprise Administrator,TIBCO Business Studio, and TIBCO ActiveMatrixBusinessWorks Plug-in for Microsoft Excel are eitherregistered trademarks or trademarks of TIBCO Software Inc. in the United States and/or othercountries.

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.

Copyright © 2014-2016 TIBCO Software Inc. All rights reserved.

TIBCO Software Inc. Confidential Information

2

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 3: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Contents

TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5

Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Configuring a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Testing a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

Deploying an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

TIBCO Business Studio Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10

Excel Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12

ExcelData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12

Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

Create_Sheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Delete_Sheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Create_Rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

Delete_Rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23

Read_Rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Update_Rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Create_Sheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Delete_Sheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Create_Rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27

Delete_Rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27

Read_Rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Update_Rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Fault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28

ExcelMetaData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28

Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29

Get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29

Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

3

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 4: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Fault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

Using the Excel Custom XPath Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Excel Custom XPath Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Working with the Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Importing the Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Configuring Module Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36

Running the Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Managing Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Setting Up Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Exporting Logs to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

4

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 5: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

TIBCO Documentation and Support Services

Documentation for this and other TIBCO products is available on the TIBCO Documentation site. Thissite is updated more frequently than any documentation that might be included with the product. Toensure that you are accessing the latest available help topics, please visit:

https://docs.tibco.com

Product-Specific Documentation

Documentation for TIBCO products is not bundled with the software. Instead, it is available on theTIBCO Documentation site at https://docs.tibco.com/products/tibco-activematrix-businessworks-plug-in-for-microsoft-excel. To directly access documentation for this product from the file system, double-click the following file:

TIBCO_HOME/release_notes/TIB_bwpluginexcel_version_docinfo.html

where TIBCO_HOME is the top-level directory in which TIBCO products are installed. On Windows,the default TIBCO_HOME is C:\Program Files\tibco\bw6. On UNIX systems, the defaultTIBCO_HOME is /opt/tibco/bw6.

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

● TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft Excel Installation

● TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft Excel User’s Guide

● TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft Excel Release Notes

How to Contact TIBCO Support

For comments or problems with this manual or the software it addresses, contact TIBCO Support:

● For an overview of TIBCO Support, and information about getting started with TIBCO Support,visit this site:

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

● If you already have a valid maintenance or support contract, visit this site:

https://support.tibco.com

Entry to this site requires a user name and password. If you do not have a user name, you canrequest one.

How to Join TIBCO Community

TIBCO Community is an online destination for TIBCO customers, partners, and resident experts. It is aplace to share and access the collective experience of the TIBCO community. TIBCO Community offersforums, blogs, and access to a variety of resources. To register, go to the following web address:

https://community.tibco.com

5

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 6: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Product Overview

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel provides the services of creating anddeleting rows and sheets, reading and updating cell values, formatting cells with specified rules orconditions, and also drawing charts in Excel files. In addition, with this plug-in you can set metadatafor Excel files and get metadata from Excel files.

The following lists describe each item and their relationships in the above figure.

● Excel files consist of worksheets on which you can use TIBCO ActiveMatrix BusinessWorks Plug-infor Microsoft Excel to perform some actions.

● TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft Excel is plugged into TIBCOActiveMatrix BusinessWorks™ and is connected to Excel files.

● TIBCO ActiveMatrix BusinessWorks is an easy-to-use integration product suite for enterpriseapplications.

● TIBCO Business Studio™ is the graphical user interface (GUI) used by TIBCO ActiveMatrixBusinessWorks and the plug-in to design business processes, and the process engine used to executethem.

● TIBCO® Enterprise Administrator provides a centralized administrative interface to manage andmonitor the plug-in applications deployed in an enterprise.

6

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 7: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Getting Started

This tutorial is designed for the beginners who want to use TIBCO ActiveMatrix BusinessWorks Plug-infor Microsoft Excel in TIBCO Business Studio.

All the operations are performed in TIBCO Business Studio. See TIBCO Business Studio Overview toget familiar with TIBCO Business Studio.

A basic procedure of using TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft Excel includes:

1. Creating a Project

2. Configuring a Process

3. Testing a Process

4. Deploying an Application

Before using the plug-in, convert your .xls files to .xlsx files.

Creating a ProjectThe first task using the plug-in is creating a project. After creating a project, you can add resources andprocesses.

An Eclipse project is an application module configured for TIBCO ActiveMatrix BusinessWorks. Anapplication module is the smallest unit of resources that is named, versioned, and packaged as part ofan application.

Procedure

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

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

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

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

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

4. In the Project dialog, configure the project that 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 current 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 the 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.

7

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 8: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

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

Prerequisites

Ensure that you have created an empty process when Creating a Project.

Procedure

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

2. Select an activity from the Palette view and drop it in the Process editor.For example, select and drop the Timer activity from the General Activities palette and theExcelData activity from the Excel palette.

3. Drag the icon to create a transition between the added activities.

8

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 9: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

4. Configure the added Excel activity, as described in Excel Palette.

5. Click File > Save to save the project.

Testing a ProcessAfter configuring a process, you can test the process to check whether the task is completed.

Prerequisites

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

Procedure

1. Open the process you have configured in 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.

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 running process and click an activity, such as the ExcelData activity.

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

9

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 10: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Deploying an ApplicationAfter testing, if the configured process works as expected, you can deploy the application that containsthe configured process into a runtime environment, and then use the bwadmin utility to manage thedeployed application.

Before deploying an application, you must generate an application archive, which is an enterprisearchive (EAR) file that is created in TIBCO Business Studio.

Deploying an application involves the following tasks:

1. Uploading an application archive

2. Deploying an application archive

3. Starting an application

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

● Before running the application that contains the ExcelData activity and is deployed in the Mac OSplatform, you have to complete the following steps:1. Open the bwappnode-nodename.tra file, which is located in the TIBCO_HOME\bw

\version_number\domains\domain_name\appnodes\space_name\node_name\bin directory.

2. In the bwappnode-nodename.tra file, change #java.extended.properties=-Xmx1024m -Xms128m -XX:PermSize=27m -XX:MaxPermSize=128m -XX:-HeapDumpOnOutOfMemoryError

intojava.extended.properties=-Xmx1024m -Xms128m -XX:PermSize=27m -

XX:MaxPermSize=128m -XX:-HeapDumpOnOutOfMemoryError -Djava.awt.headless=true.

3. Save the file and restart the current application node.

● Before running the application that contains the XPath functions, complete the following steps:1. Open the bwappnode-nodename.tra file, which is located in the TIBCO_HOME\bw

\version_number\domains\domain_name\appnodes\space_name\node_name\bin directory.

2. In the bwappnode-nodename.tra file, change #java.extended.properties=-Xmx1024m -Xms128m -XX:PermSize=27m -XX:MaxPermSize=128m -XX:-HeapDumpOnOutOfMemoryError

intojava.extended.properties=-Xmx1024m -Xms128m -XX:PermSize=27m -

XX:MaxPermSize=128m -XX:-HeapDumpOnOutOfMemoryError -

Djavax.xml.parsers.SAXParserFactory=com.sun.org.apache.xerces.internal.jaxp.SA

XParserFactoryImpl.

3. Save the file and restart the current application node.

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.

10

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 11: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

The workbench consists of:

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 , Run , and so on.

3. Perspective: contains an initial set and layout of views that are required to perform a certain task.TIBCO Business Studio launches the Modeling perspective by default. You can change theperspective from the menu Window > Open Perspective > Perspective_Name.

4. View: displays resources. For example, the Project Explorer view displays the ActiveMatrixBusinessWorks applications, modules, and other resources in your workspace, and the Propertiesview displays the properties for the selected resource. You can open a view from the menu Window> Show View > View_Name.

5. Editor: provides a canvas to configure, edit, or browse a resource. Double-click a resource in a viewto open the appropriate editor for the selected resource. For example, double-click an ActiveMatrixBusinessWorks process (MortgageAppConsumer.bwp) in the Project Explorer view to open theprocess in the editor.

6. Palette: contains a set of widgets and a palette library. A palette groups activities that perform similartasks and provide quick access to activities when you configure a process.

11

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 12: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Excel Palette

A palette groups the activities that connect the same external applications together. The Excel palette isadded to TIBCO Business Studio after installing TIBCO ActiveMatrix BusinessWorks Plug-in forMicrosoft Excel.

The Excel palette contains the following activities that can be used to create and delete rows and sheets,read and update cell values, format cells with specified rules and conditions, and also draw charts inExcel files. In addition, with these activities you can get metadata from Excel files and set metadata forExcel files.

● ExcelData

● ExcelMetaData

ExcelDataYou can use the ExcelData activity to create and delete rows and sheets, and also read and update cellvalues in Excel files. Besides, you can use the ExcelData activity to set attributes for cells, format cellswith specified rules or conditions, and draw charts in Excel files.

GeneralIn the General tab, you can select different actions to complete different tasks.

The following table describes the items in the General tab of the ExcelData activity.

Item Description

Name The name of the activity displayed in the process. The defaultvalue is ExcelData.

Actions You can select the following actions:

● Create_Sheets● Delete_Sheets● Create_Rows● Delete_Rows● Read_Rows● Update_Rows

Modes You can select the following modes:

● Basic

You can use Basic mode to complete basic functions of theExcelData activity.

● Advanced

You can use Advanced mode to complete basic and advancedfunctions of the ExcelData activity.

Available only when the Create_Rows, Read_Rows, orUpdate_Rows action is selected.

12

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 13: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Item Description

Create New File Select the check box if you want to create a new Excel file.Available only when the Create_Sheets, or Create_Rows action isselected.

Choose Output Directory Choose the output directory for the newly created Excel file by

clicking the Choose a resource icon. Available only when theCreate New File check box is selected.

Output File Name Prefix Enter a prefix name for the output Excel file. Available only whenthe Create New File check box is selected.

Formula You can select the following methods:

● An empty cell represents the default value to read theevaluated value of the formula.

● Evaluate

You can use the Evaluate method to read the evaluated valueof the formula.

● Keep

You can use the Keep method to read the formula string.

Available only when the Read_Rows action is selected.

DescriptionIn the Description tab, you can add a short description for the ExcelData activity.

InputThe input varies depending on the actions you select in the General tab.

Check the input for the activity for the following actions:

● Create_Sheets

● Delete_Sheets

● Create_Rows

● Delete_Rows

● Read_Rows

● Update_Rows

Create_Sheets

When Create_Sheets is selected in the General tab, the input for the activity is as follows.

Input Item Data Type Description

FilePath String Enter the absolute path for the Excel file with double quotationmarks, where the newly created sheets are added.

13

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 14: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Input Item Data Type Description

SheetName String Enter a name for the sheet with double quotation marks. Thiselement supports duplication.

You can right-click the SheetName node and click Duplicate tocreate multiple sheets.

● Ensure that the name of each sheet is different.Otherwise, only one sheet is created.

● If the maximum length of the sheet name is morethan 31 characters, the process can run successfully,and only the first 31 characters of the sheet name areused.

Delete_Sheets

When Delete_Sheets is selected in the General tab, the input for the activity is as follows.

Input Item Data Type Description

FilePath String Enter the absolute path for the Excel file with doublequotation marks, where one or multiple sheets aredeleted.

Sheet None This node supports duplication.

You can right-click the SheetName node and clickDuplicate to delete multiple sheets.

SheetName|

SheetPointer

None Select SheetName or SheetPointer to delete a sheetfrom the Excel file.

Before selecting SheetName orSheetPointer, complete the following steps:1. Drag SheetName|SheetPointer under

the Sheet node in the XPath Expressionview to the Data Source view. The Dropwindow opens.

2. In the Drop window, select SheetNameor SheetPointer from the list. ClickFinish.

SheetName String Enter the name of the sheet to be deleted with doublequotation marks.

If the maximum length of the sheet name ismore than 31 characters, the process can runsuccessfully, and only the first 31 charactersof the sheet name are used.

SheetPointer Positiveinteger

Enter the index number of the sheet to be deleted.

14

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 15: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Create_Rows

When Create_Rows is selected in the General tab, the input for the activity is as follows.

Input ItemDataType Mode Description

FilePath String Basic andAdvanced

Enter the absolute path for the Excel file withdouble quotation marks, where the newly createdrows are added.

SheetName String Basic andAdvanced

Enter the name of the sheet with double quotationmarks, where the newly created rows are added.

If the maximum length of the sheetname is more than 31 characters, theprocess can run successfully, and onlythe first 31 characters of the sheet nameare used.

StartingRowPoint

er

positiveinteger

Advanced Enter the starting row index number, where onerow or multiple rows start to be created.

Row None Basic andAdvanced

This node supports duplication.

You can right-click the SheetName node and clickDuplicate to create multiple rows.

Cells None Basic andAdvanced

Set attributes for one or multiple cells under thisnode. This node supports duplication.

You can right-click the Cells node and clickDuplicate to set attributes for multiple cells.

Value String Basic andAdvanced

Enter a value for the cell with double quotationmarks.

IsFormulaCell Boolean Basic andAdvanced

Enter true() into this field if the cell containsExcel formula. Otherwise, enter false() into thisfield or leave this field blank.

TagName String Basic andAdvanced

Enter a tag name for the cell with doublequotation marks. This tag name can be used forfurther operations, such as drawing charts orsetting conditional formatting rules.

CellComments None Advanced Set attributes for cell comments under this node.

Value String Advanced Enter a value for the cell comment with doublequotation marks.

FontStyle None Advanced Set font style for cell comments under this node.

15

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 16: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Input ItemDataType Mode Description

FontName String Advanced Enter a font name for the cell comment withdouble quotation marks.

The font name entered in this field mustbe supported by the Excel file.

StandardColor|

RGBValues

None Advanced Select StandardColor or RGBValues for cellcomments.

Before selecting StandardColor orRGBValues, complete the followingsteps:1. Drag SheetName|SheetPointer

under the Sheet node in the XPathExpression view to the Data Sourceview. The Drop window opens.

2. In the Drop window, selectStandardColor or RGBValues fromthe list. Click Finish.

StandardColor String Advanced Enter the name of the color with double quotationmarks, such as "GREEN". Select a standard colorfrom the following list:

● BLACK

● BLUE

● GRAY

● GREEN

● ORANGE

● PINK

● RED

● WHITE

● YELLOW

The name of the color entered in thisfield must be supported by the Excelfile.

RGBValues None Advanced Enter RGB values under this node. In the Red,Green, and Blue fields, enter an integer valuewithin the range of 0 - 255 for each field.

FontSize Positiveinteger

Advanced Enter a value for the font size of the cell comment.

Bold Boolean Advanced Enter true() into this field if the cell commentmust be in bold. Otherwise, enter false() intothis field or leave this field blank.

16

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 17: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Input ItemDataType Mode Description

Italic Boolean Advanced Enter true() into this field if the cell commentmust be in italic. Otherwise, enter false() intothis field or leave this field blank.

StrikeThrough Boolean Advanced Enter true() into this field if the cell commentmust be struck through. Otherwise, enter false()into this field or leave this field blank.

Underline String Advanced Enter an underline type with quotation marks,such as "U_SINGLE". Select an underline type fromthe following list:

● U_DOUBLE

● U_DOUBLEACCOUNTING

● U_NONE

● U_SINGLE

● U_SINGLEACCOUNTING

The underline type entered in this fieldmust be supported by the Excel file.

CellStyle None Advanced Set attributes for cell style under this node. Referto attributes setting in the fields under theCellComments node.

Alignment String Advanced Enter an alignment type with double quotationmarks, such as "ALIGN_LEFT". Select an alignmenttype from the following list:

● ALIGN_CENTER

● ALIGN_CENTER_SELECTION

● ALIGN_FILL

● ALIGN_GENERAL

● ALIGN_JUSTIFY

● ALIGN_LEFT

● ALIGN_RIGHT

The alignment type entered in this fieldmust be supported by the Excel file.

BackgroundColor None Advanced Set background color for cells under this node.

17

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 18: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Input ItemDataType Mode Description

FillPattern String Advanced Enter a fill pattern type with double quotationmarks, such as "FINE_DOTS". Select a fill patterntype from the following list:

● BIG_SPOTS

● BRICKS

● DIAMONDS

● FINE_DOTS

● NO_FILL

● SOLID_FOREGROUND

● SPARSE_DOTS

● SQUARES

● THICK_BACKWARD_DIAG

● THICK_FORWARD_DIAG

● THICK_HORZ_BANDS

● THICK_VERT_BANDS

● THIN_BACKWARD_DIAG

● THIN_FORWARD_DIAG

● THIN_HORZ_BANDS

● THIN_VERT_BANDS

The fill pattern type entered in this fieldmust be supported by the Excel file.

WrapText Boolean Advanced Enter true() into this field if the cell value mustbe text wrapped. Otherwise, enter false() intothis field or leave this field blank.

Chart None Advanced This node supports duplication.

You can right-click the Chart node and clickDuplicate to create charts.

ChartLocation None Advanced Specify the location for the chart under this node.

FirstCellColumn Positiveinteger

Advanced Enter a numeral that indicates the column locationfor the first cell that the chart is drawn upon.

FirstCellRow Positiveinteger

Advanced Enter a numeral that indicates the row location forthe first cell that the chart is drawn upon.

SecondCellColumn Positiveinteger

Advanced Enter a numeral that indicates the column locationfor the second cell that the chart is drawn upon.

SecondCellRow Positiveinteger

Advanced Enter a numeral that indicates the row location forthe second cell that the chart is drawn upon.

18

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 19: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Input ItemDataType Mode Description

ChartDataSourceC

ellRangeAddress

None Advanced Specify the start and end cell addresses of therequired data for drawing the chart under thisnode.

● The horizontal axis is plotted by thecell values in the first column of therequired data area.

● The cell values in the first row of therequired data area serve as thelegend names, which are displayedin the legend area of the chart.

● If each cell in the selected data areais filled with a value, the first cellvalue is not taken when you draw achart.

StartTag String Advanced Enter the start tag name of the required datasource for drawing the chart, or enter the start celladdress of the required data source for drawingthe chart with double quotation marks, such as"A1".

EndTag String Advanced Enter the end tag name of the required data sourcefor drawing the chart, or enter the end cell addressof the required data source for drawing the chartwith double quotation marks, such as "D5".

ConditionalForma

ttingRules

None Advanced Set conditional formatting rules for cells underthis node. This node supports duplication.

You can right-click theConditionalFormattingRules node and clickDuplicate to set conditional formatting rules forcells in multiple areas.

Condition None Advanced Set conditions for cells that are applied withconditional formatting rules under this node.

19

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 20: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Input ItemDataType Mode Description

Comparator String Advanced Enter a comparator value with double quotationmarks, such as "LT", which means less than. Selecta comparator type from the following list:

● BETWEEN

● EQUAL

● GE

● GT

● LE

● LT

● NO_COMPARISON

● NOT_BETWEEN

● NOT_EQUAL

The comparator value entered in thisfield decides the values in the Operand1and Operand2 fields.

Operand1 String Advanced Enter a proper operand value in this field.

Operand2 String Advanced Enter a proper operand value in this field.

FontFormat None Advanced Set font format for the cells within the specifiedcell range under this node.

Italic Boolean Advanced Enter true() into this field if the cell commentmust be in italic. Otherwise, enter false() intothis field.

Bold Boolean Advanced Enter true() into this field if the cell commentmust be in bold. Otherwise, enter false() intothis field.

20

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 21: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Input ItemDataType Mode Description

StandardColor String Advanced Enter the name of the color with double quotationmarks, such as "GREEN". Select a standard colorfrom the following list:

● BLACK

● BLUE

● GRAY

● GREEN

● ORANGE

● PINK

● RED

● WHITE

● YELLOW

The name of the color entered in thisfield must be supported by the Excelfile.

Underline String Advanced Enter an underline type with double quotationmarks, such as "U_SINGLE". Select an underlinetype from the following list:

● U_DOUBLE

● U_NONE

● U_SINGLE

The underline type entered in this fieldmust be supported by the Excel file.

PatternFormat None Advanced Set pattern format for the cells within the specifiedcell range under this node.

21

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 22: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Input ItemDataType Mode Description

BackgroundColor String Advanced Enter the name of the color with double quotationmarks, such as "GREEN". Select a background colorfrom the following list:

● BLACK

● BLUE

● GRAY

● GREEN

● ORANGE

● PINK

● RED

● WHITE

● YELLOW

The name of the color entered in thisfield must be supported by the Excelfile.

FillPattern String Advanced Enter a fill pattern type with double quotationmarks, such as "FINE_DOTS".

● BIG_SPOTS

● BRICKS

● DIAMONDS

● FINE_DOTS

● SOLID_FOREGROUND

● SPARSE_DOTS

● SQUARES

● THICK_BACKWARD_DIAG

● THICK_FORWARD_DIAG

● THICK_HORZ_BANDS

● THICK_VERT_BANDS

● THIN_BACKWARD_DIAG

● THIN_FORWARD_DIAG

● THIN_HORZ_BANDS

● THIN_VERT_BANDS

The fill pattern type entered in this fieldmust be supported by the Excel file.

22

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 23: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Input ItemDataType Mode Description

CellRange None Advanced Set the cell range that the conditional formattingrules applies to. This node supports duplication.

You can right-click the CellRange node and clickDuplicate to set conditional formatting rules inmultiple areas.

StartTag String Advanced Enter the start tag name for the specified cellrange, or enter the start cell address for thespecified cell range with double quotation marks,such as "A1".

EndTag String Advanced Enter the end tag name for the specified cell range,or enter the end cell address for the specified cellrange with quotation marks, such as "D5".

Delete_Rows

When Delete_Rows is selected in the General tab, the input for the activity is as follows.

Input Item Data Type Description

FilePath String Enter the absolute path for the Excel file with doublequotation marks, where the specified rows in a sheetare deleted.

SheetName|SheetPointer None Select SheetName or SheetPointer to delete rows inthe Excel file.

Before selecting SheetName orSheetPointer, complete the followingsteps:1. Drag SheetName|SheetPointer under

the Sheet node in the XPath Expressionview to the Data Source view. The Dropwindow opens.

2. In the Drop window, select SheetNameor SheetPointer from the list. ClickFinish.

SheetName String Enter the name of the sheet with double quotationmarks, where the rows are deleted.

If the maximum length of the sheet name ismore than 31 characters, the process canrun successfully and only the first 31characters of the sheet name are used.

SheetPointer Positiveinteger

Enter the index number of the sheet, where the rowsare deleted.

23

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 24: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Input Item Data Type Description

StartingRowPointerToDele

te

Positiveinteger

Specify the starting row pointer, where the rows startto be deleted.

The value entered in this field must begreater than zero.

EndingRowPointerToDelete Integer Specify the ending row pointer, where the rows stopto be deleted.

If the value in this field is -1, rows aredeleted from the specified starting row tothe last row in the sheet.

Read_Rows

When Read_Rows is selected in the General tab, the input for the activity is as follows.

Input Item Data Type Mode Description

FilePath String Basic andAdvanced

Enter the absolute path for the Excel filewith double quotation marks, where thecell values in specified rows are read.

SheetName|

SheetPointer

None Basic andAdvanced

Select SheetName or SheetPointer toread the cell values in specified rows inthe Excel file.

Before selecting SheetName orSheetPointer, complete thefollowing steps:1. Drag SheetName|

SheetPointer under theSheet node in the XPathExpression view to the DataSource view. The Dropwindow opens.

2. In the Drop window, selectSheetName orSheetPointer from the list.Click Finish.

SheetName String Basic andAdvanced

Enter the name of the sheet with doublequotation marks, where the rows areread.

If the maximum length of thesheet name is more than 31characters, the process can runsuccessfully and only the first31 characters of the sheet nameare used.

24

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 25: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Input Item Data Type Mode Description

SheetPointer Positiveinteger

Basic andAdvanced

Enter the index number of the sheet,where the rows are read.

StartingRowPointer Positiveinteger

Advanced Specify the starting row pointer, wherethe rows start to be read.

RowChunkSizeToRead Positiveinteger

Advanced Specify the amount of rows to be read.

Update_Rows

When Update_Rows is selected in the General tab, the input for the activity is as follows.

Input Item Data Type Mode Description

FilePath String Basic andAdvanced

Enter the absolute path for the Excel file withdouble quotation marks, where the values inone or multiple cells are updated.

SheetName String Basic andAdvanced

Enter the name of the sheet with doublequotation marks.

If the maximum length of the sheetname is more than 31 characters, theprocess can run successfully andonly the first 31 characters of thesheet name are used.

Row None Basic andAdvanced

This node supports duplication.

You can right-click the Row node and clickDuplicate to update the cell values in multiplerows.

RowToUpdate Positiveinteger

Basic andAdvanced

Specify the row number, where the cell valuein the row is updated.

Cells None Basic andAdvanced

Set attributes for a cell under this node. Thisnode supports duplication.

You can right-click the Cells node and clickDuplicate to set attributes for multiple cells.

ColumnToUpdate Positiveinteger

Basic andAdvanced

Specify the column number, where the cellvalue in the column is updated.

Value String Basic andAdvanced

Enter a value for the cell to be updated withdouble quotation marks.

IsFormulaCell Boolean Basic andAdvanced

Enter true() into this field if the cell containsExcel formula. Otherwise, enter false() intothis field or leave this field blank.

25

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 26: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Input Item Data Type Mode Description

TagName String Basic andAdvanced

Enter a tag name for the cell with doublequotation marks.

CellComments None Advanced Set attributes for cell comments under thisnode. See the table in Create_Rows for details.

CellStyle None Advanced Set attributes for cell style under this node. Seethe table in Create_Rows for details.

OutputThe output varies depending on the actions you select in the General tab.

Check the output for the activity for the following actions:

● Create_Sheets

● Delete_Sheets

● Create_Rows

● Delete_Rows

● Read_Rows

● Update_Rows

Create_Sheets

When Create_Sheets is selected in the General tab, the output for the activity is as follows.

Output Item Data Type Description

FilePath String The location of the Excel file that the created sheets are addedto.

TotalSheetsCreat

ed

Positiveinteger

The number of successfully created sheets.

SheetName String The names of created sheets displayed by sequence.

Delete_Sheets

When Delete_Sheets is selected in the General tab, the output for the activity is as follows.

Output Item Data Type Description

FilePath String The location of the Excel file that contains the sheets that youwant to delete.

TotalSheetsDelet

ed

Positiveinteger

The number of successfully deleted sheets.

SheetName String The names of deleted sheets displayed by sequence.

26

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 27: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Create_Rows

When Create_Rows is selected in the General tab, the output for the activity is as follows.

Output Item Data Type Description

FilePath String The location of the Excel file that the created rows are addedto.

TotalRowsCreated Positiveinteger

The number of successfully created rows.

Delete_Rows

When Delete_Rows is selected in the General tab, the output for the activity is as follows.

Output Item Data Type Description

FilePath String The location of the Excel file that contains the rows that youwant to delete.

TotalRowsDeleted Positiveinteger

The number of successfully deleted rows.

Read_Rows

When Read_Rows is selected in the General tab, the output for the activity is as follows.

Output Item Data Type Mode Description

FilePath String Basic andAdvanced

The location of the Excel file that youwant to read.

SheetName String Basic andAdvanced

The name of the read sheet.

Value String Basic andAdvanced

The value of the cell in the read row.

IsFormulaCell Boolean Basic andAdvanced

A value of true indicates the cell containsExcel formula, whereas a value of falseindicates the cell does not contain Excelformula.

CellComments None Advanced The attributes for a cell comments. Thefollowing fields are displayed: Value andAuthor.

CellStyle None Advanced The attributes for a cell style. Thefollowing fields are displayed: FontStyle,Alignment, BackgroundColor,FillPattern, and WrapText.

27

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 28: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Output Item Data Type Mode Description

TotalCellsReadInRow Positiveinteger

Advanced The number of cells in the read row.

NextRowPointer Positiveinteger

Advanced The number of the row that is next to thelast read row.

TotalRowsInSheet Positiveinteger

Advanced The number of rows in the read sheet.

NextSheetPointer Positiveinteger

Advanced The number of the sheet that is next tothe read sheet.

TotalSheetsInFile Positiveinteger

Advanced The number of sheets in the Excel file.

Update_Rows

When Update_Rows is selected in the General tab, the output for the activity is as follows.

Output Item Data Type Description

FilePath String The location of the Excel file that you want to update.

TotalRowsUpdated Positiveinteger

The number of successfully updated rows.

FaultThe following table describes the exception in the Fault tab of the ExcelData activity.

Error Schema Element Data Type Description

msg String Displays the error message.

msgCode String Displays the error code.

ExcelMetaDataYou can use the ExcelMetaData activity to set metadata into Excel files or get metadata from Excel files.This activity contains two actions that you can select to complete different tasks.

GeneralIn the General tab, you can select the Get or Set action to complete a task.

The following table describes the items in the General tab of the ExcelMetaData activity.

Item Description

Name The name of the activity displayed in the process. The default name isExcelMetaData.

28

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 29: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Item Description

Actions You can select the following actions:

● Set

You can use the Set action to set metadata for Excel files.

● Get

You can use the Get action to get metadata from Excel files.

DescriptionIn the Description tab, you can add a short description for the ExcelMetaData activity.

InputThe input varies depending on the actions you select in the General tab.

Check the input for the activity for the following actions:

● Get

● Set

Get

When Get is selected in the General tab, the input for the activity is as follows.

Input Item Data Type Description

FilePath String Enter the absolute path for the Excel file with doublequotation marks, where the metadata of the Excel file isextracted.

Set

When Set is selected in the General tab, the input for the activity is as follows.

Input Item Data Type Description

FilePath String Enter the absolute path for the Excel file with doublequotation marks, where the metadata of the Excel file is set.

WorkbookDetails None A list of attribute fields for the Excel file is provided whereyou can set values.

categories String Set the category for the Excel file with double quotationmarks.

status String Set the status for the Excel file with double quotationmarks.

author String Set the author for the Excel file with double quotationmarks.

29

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 30: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Input Item Data Type Description

comments String Set the comment for the Excel file with double quotationmarks.

revision Integer Set the revision number for the Excel file.

subject String Set the subject for the Excel file with double quotationmarks.

title String Set the title for the Excel file with double quotation marks.

tags String Set the tag for the Excel file with double quotation marks.

company String Set the company for the Excel file with double quotationmarks.

manager String Set the manager for the Excel file with double quotationmarks.

OutputThe output varies depending on the actions you select in the General tab.

Check the output for the activity for the following actions:

● Get

● Set

Get

When Get is selected in the General tab, the output for the activity is as follows.

Input Item Data Type Description

sheetName String The sheet name of the Excel file that the metadata is set for.

noOfRows Positive Integer The number of rows that contain values.

noOfColumns Positive Integer The number of columns that contain values.

FilePath String The location of the Excel file that the metadata is set for.

WorkbookMetaData

Details

None A list of attribute fields for the Excel file. The followingfields are displayed: categories, status, created, author,comments, lastModified, lastModifiedBy, revision,subject, title, tags, company, manager, and template.

30

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 31: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Set

When Set is selected in the General tab, the output for the activity is as follows.

Input Item Data Type Description

Result Boolean A value of true indicates that setting of metadata wassuccessful, whereas a value of false indicates that settingof metadata was failed.

FaultThe following table describes the exception in the Fault tab of the ExcelMetaData activity.

Error Schema Element Data Type Description

msg String Displays the error message.

msgCode String Displays the error code.

31

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 32: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Using the Excel Custom XPath Function

You can use the Excel Custom XPath function instead of the ExcelData and the ExcelMetaData activitiesto complete the same tasks, without having to create a separate process each time.

The Excel Custom XPath function can work with any activities in the Palette view. For example, if youwant to delete a sheet by the sheet name of the Excel file, you can debug a process with the Timeractivity and Log activity.

Procedure

1. Open a process if you have created one, or create a new project if you have not.See Creating a Project or Configuring a Process for details.

2. Select the Timer activity and another activity, such as the Log activity, from the General Activitiespalette and drag them to the Process editor.

3. Drag the icon to create a transition between the added activities.

4. Click the Log activity in the Process editor, and then click Functions view in the Input tab.A list of folders is displayed.

5. Expand the Excel Functions folder, drag the d_deleteSheetBySheetName item to the messageelement in the XPath Expression view.

6. Configure the parameters in the message element.

7. Debug the configured process, as described in Testing a Process.

32

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 33: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

If you want to complete other functions of the ExcelData and the ExcelMetaData activities,repeat Step 5, Step 6, and Step 7. See Excel Custom XPath Function for more details.

Excel Custom XPath FunctionThe Excel Custom XPath function is designed to help users complete most functions of the ExcelDataand the ExcelMetaData activities in a simplified way.

The following table describes the items in the Excel Custom XPath function.

Item Description

d_cloneSheetBySheetName Clones a sheet based on the sheet name.

d_cloneSheetBySheetPointer Clones a sheet based on the sheet pointer.

d_createSheets Creates sheets for an Excel file.

d_deleteRowsBySheetName Deletes rows based on the sheet name.

d_deleteRowsBySheetPointer Deletes rows based on the sheet pointer.

d_deleteSheetBySheetName Deletes a sheet based on the sheet name.

d_deleteSheetBySheetPointer Deletes a sheet based on the sheet pointer.

d_deleteSingleRowBySheetName Deletes a single row based on the sheet name.

d_deleteSingleRowBySheetPointer Deletes a single row based on the sheet pointer.

d_searchCellCommentBySheetName Searches a cell comment in an Excel sheet based on thesheet name.

d_searchCellCommentBySheetPointer Searches a cell comment in an Excel sheet based on thesheet pointer.

d_searchCellValueBySheetName Searches a cell value in an Excel sheet by the sheet name.

d_searchCellValueBySheetPointer Searches a cell value in an Excel sheet by the sheetpointer.

md_getAuthor Gets the author of an Excel file.

md_getCategories Gets the category of an Excel file.

md_getComments Gets the comments of an Excel file.

md_getCompany Gets the company of an Excel file.

md_getCreatedDate Gets the created date of an Excel file.

md_getLastModifiedBy Gets information about who last modified the Excel file.

md_getLastModifiedDate Gets the last modified date of an Excel file.

33

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 34: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Item Description

md_getManager Gets the manager of an Excel file.

md_getRevision Gets the revision number of an Excel file.

md_getStatus Gets the status of an Excel file.

md_getSubject Gets the subject of an Excel file.

md_getTags Gets the tags of an Excel file.

md_getTemplate Gets the template of an Excel file.

md_getTitle Gets the title of an Excel file.

md_setAuthor Sets the author for an Excel file.

md_setCategories Sets the category for an Excel file.

md_setComments Sets comments for an Excel file.

md_setCompany Sets the company for an Excel file.

md_setManager Sets the manager for an Excel file.

md_setRevision Sets the revision number for an Excel file.

md_setStatus Sets the status for an Excel file.

md_setSubject Sets the subject for an Excel file.

md_setTags Sets tags for an Excel file.

md_setTitle Sets the title for an Excel file.

Items with initial d in the Excel Functions folder indicate corresponding functions in the ExcelDataactivity. Items with initial md in the Excel Functions folder indicate corresponding functions in theExcelMetaData activity.

34

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 35: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Working with the Sample Project

Working through the sample project helps you understand how TIBCO ActiveMatrix BusinessWorksPlug-in for Microsoft Excel operates.

After installing the plug-in, you can find the sample project that is located in the TIBCO_HOME\bw\palettes\excel\version\samples directory. This sample project contains six processes, eachprocess corresponds to a task.

● CSVConvertToExcel.bwp

This process demonstrates how to use the plug-in to convert a CSV file into an Excel file.

● BatchingWriteExcel.bwp

This process demonstrates how to use the plug-in to write values into multiple Excel files.

● CRUDExcelData.bwp

This process demonstrates how to use the plug-in to complete all functions of the ExcelData activity.

● ReadExcelGroup.bwp

This process demonstrates how to use the plug-in to read values from a batch of Excel files.

● ExcelFunction.bwp

This process demonstrates how to use the functions of the plug-in.

● SetGetExcelMetaData.bwp

This process demonstrates how to use the plug-in to get metadata from or set metadata for an Excelfile.

Importing the Sample ProjectBefore running the project, you must import the project to TIBCO Business Studio.

Procedure

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

● Microsoft Windows: click Start > All Programs > TIBCO > TIBCO_HOME > TIBCO BusinessStudio version_number > Studio for Designers

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

2. From the menu, click File > Import.

3. In the Import window, expand the General folder and select the Existing Studio Projects intoWorkspace item. Click Next.

4. Click Browse next to the Select archive file field to select the example.zip file. Click Finish.The example.zip file is located in the TIBCO_HOME/bw/palettes/excel/version/samplesdirectory.

Result

The sample project is imported to TIBCO Business Studio.

35

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 36: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Configuring Module PropertiesAfter importing the example.zip file, configure Module Properties before running the processes.Module Properties are used to select directories when you configure the processes.

Prerequisites

Ensure that you have imported the sample project to TIBCO Business Studio, as described in Importingthe Sample Project.

Procedure

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

2. In the Module Properties panel, expand the ExcelExample folder, and configure the moduleproperty values according to your own directories in the default column.

36

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 37: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

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

Running the Sample ProjectThe sample project shows how to use the plug-in to convert CSV files to Excel files, read values from orwrite values into Excel files in batches, set metadata for or get metadata from Excel files, and how to useExcel functions.

Prerequisites

Ensure that you have configured Module Properties, as described in Configuring Module Properties.

Procedure

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

2. By default, all the processes are listed in the Components editor. Select the process that you do not

want to run and click the remove selected component icon.

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

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

5. In the Run Configuration dialog, expand BusinessWorks Application, and then clickBWApplication.

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

7. Click Run to run the selected process.

8. Click the Terminate icon to stop the process.

37

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 38: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Managing Logs

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 debug mode. Youcan change the log level of the plug-in to trace different messages and export logs to a file. Different loglevels 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

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.

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.

If you do not configure any log levels, the plug-in uses the default log level of TIBCO ActiveMatrixBusinessWorks. The default log level 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 loggers area to specify a loglevel for the plug-in:<logger name="com.tibco.bw.palette.excel.runtime"> <level value="DEBUG"/></logger>

The value of the level element can be 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 the following node in the BusinessWorks Palette and Activity loggers area tocontrol a log level for the activity:

● For example, to control the debug log level for the ExcelData activity, set the followingparameters:<logger name="com.tibco.bw.palette.excel.runtime.ExcelDataSynchronousActivity"> <level value="DEBUG"/></logger>

38

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 39: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

● For example, to control the debug log level for the ExcelMetadata activity, set the followingparameters:<logger name="com.tibco.bw.palette.excel.runtime.WorkbookMetaDataSynchronousActivity"> <level value="DEBUG"/></logger>

The activities that are not configured with specific log levels use the log level configuredfor 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. Navigate to the TIBCO_HOME/bw/version_number/config/design/logback directory and openthe 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-excel.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 bottom of the logback.xml file:<root level="DEBUG"> <appender-ref ref="STDOUT"/> <appender-ref ref="FILE"/></root>

4. Save the file.

39

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 40: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Error Codes

The exceptions that are thrown by the plug-in are listed with their corresponding descriptions andsolutions.

Error Code and ErrorMessage Role Category Description Solutions

TIBCO-BW-PALETTE-EXCEL-210001

\nStart of the

Activity {0} +

\nInput received:\n

{1} \n

debug BW-Plug-in Occurs when the plug-in activities start to runin a process.

None.

TIBCO-BW-PALETTE-EXCEL-210002

\nActivity {0}

Output data:\n {1}

\n Exit of Activity

{2}

debug BW-Plug-in Occurs when the plug-in activities finishperforming a logic in aprocess.

None.

TIBCO-BW-PALETTE-EXCEL-210003

\nExcel File {0}

opened for

operation [{1}] in

activity [{2}]

debug BW-Plug-in Occurs when the plug-in activities open anExcel file by using oneof their actions.

None.

TIBCO-BW-PALETTE-EXCEL-210004

\nChanges to excel

file {0} is saved

and the file is

closed for

operation [{1}] in

activity [{2}]

debug BW-Plug-in Occurs when the plug-in activities have madesome changes to anExcel file and thechanges have beensaved in the Excel file.

None.

TIBCO-BW-PALETTE-EXCEL-210005

\nInput file not

found:{0} for

operation {1} in

activity {2}

debug BW-Plug-in Occurs when thespecified Excel file isnot found.

None.

TIBCO-BW-PALETTE-EXCEL-210006

\nNew excel file

created at location

{0} for operation

{1} in activity {2}

debug BW-Plug-in Occurs when the plug-in activity is used tocreate a new Excel filein a specified directory.

None.

40

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 41: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Error Code and ErrorMessage Role Category Description Solutions

TIBCO-BW-PALETTE-EXCEL-210007

\nFormula for cell

located at column

{0} of row {1} in

sheet {2} will be

set as {3}

debug BW-Plug-in Occurs when you fill aformula in a cell in anExcel sheet.

None.

TIBCO-BW-PALETTE-EXCEL-210008

\nA row already

exists at the

starting row number

{0} of sheet {1}.

Shifting down the

existing row to

create a new row at

row number {2}

debug BW-Plug-in Occurs when youcreate a new row in aspecified row number,where a row has beenexisted, and the existedrow moves down.

None.

TIBCO-BW-PALETTE-EXCEL-210009

\nNo sheets present

in file and user

has not given any

sheet names to add.

Creating default

sheet with name {0}

for operation {1}

in activity {2}

debug BW-Plug-in Occurs when youcreate a sheet withoutspecifying its name,and a default name isgiven to the sheet.

None.

TIBCO-BW-PALETTE-EXCEL-211002

\nTotal sheets

created in file {0}

for operation {1}

in activity {2} is

{3}

debug BW-Plug-in Occurs when theCreate_Rows action inthe ExcelData activitycompletes an operation.

None.

TIBCO-BW-PALETTE-EXCEL-212001

\nDeleted sheet {0}

from file {1}

debug BW-Plug-in Occurs when theDelete_Sheets action inthe ExcelData activity isselected to delete sheetsfrom an Excel file.

None.

TIBCO-BW-PALETTE-EXCEL-212002

\nTotal number of

sheets deleted from

file {0} is {1}

debug BW-Plug-in Occurs when the resultof the deleted sheetsfrom an Excel file iscollected.

None.

41

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 42: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Error Code and ErrorMessage Role Category Description Solutions

TIBCO-BW-PALETTE-EXCEL-213001

\nA new sheet {0}

has been created in

excel file {1}

debug BW-Plug-in Occurs when thespecified sheet is notpresent in the Excel file,and the specified sheetmust be created beforecreating rows.

None.

TIBCO-BW-PALETTE-EXCEL-213002

\nA new row has

been created at row

number {0} of sheet

{1} in excel file

{2}

debug BW-Plug-in Occurs when a newrow has been created inan Excel file.

None.

TIBCO-BW-PALETTE-EXCEL-213003

\nNo starting row

is specified. Will

create a new row in

the next available

empty row {0} in

the sheet {1} of

excel file {2}

debug BW-Plug-in Occurs when youcreate a new rowwithout specifying therow number, and therow is created from thelast row in the specifiedsheet.

None.

TIBCO-BW-PALETTE-EXCEL-214002

\nRow {0} of sheet

{1} in file {2} has

been deleted

debug BW-Plug-in Occurs when a row hasbeen deleted from anExcel file.

None.

TIBCO-BW-PALETTE-EXCEL-214003

\nTotally {0} rows

deleted from sheet

{1} of file {2}

debug BW-Plug-in Occurs when the resultof the rows deleted bythe ExcelData activityhas been collected.

None.

TIBCO-BW-PALETTE-EXCEL-215002

\nTotal cells read

in row {0} of sheet

{1} is {2}

debug BW-Plug-in Occurs when the resultof the cells read by theExcelData activity hasbeen collected.

None.

TIBCO-BW-PALETTE-EXCEL-215003

\nNext row number

to read in sheet

{0} of file {1} is

{2}

debug BW-Plug-in Occurs when thecurrent row has beenread and the next rowis to be read.

None.

42

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 43: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Error Code and ErrorMessage Role Category Description Solutions

TIBCO-BW-PALETTE-EXCEL-215004

\nNext sheet number

to read in file {0}

is {1}

debug BW-Plug-in Occurs when thespecified sheet is read,the information of thenext sheet is providedto the followingactivity.

None.

TIBCO-BW-PALETTE-EXCEL-221001

Retrieved Meta Data

value for {0} is

{1} for file: {2}

operation [{3}] in

activity [{4}]

debug BW-Plug-in Occurs when theExcelMetadata activityis used to get metadatafrom an Excel file.

None.

TIBCO-BW-PALETTE-EXCEL-510001

Activity Name:{0},

Operation Name:

{1};-- Exception

occurred while

open/locked excel

file at {2}, close/

unlock it and

perform the action

error BW-Plug-in Occurs when the plug-in is used to performsome operations on theopened Excel file.

Close the openedExcel file.

TIBCO-BW-PALETTE-EXCEL-510002

Activity Name:{0},

Operation Name:

{1};-- Workbook

could not be

retrieved for file

{2}

error BW-Plug-in Occurs when aworkbook object in anExcel file fails to beretrieved, which mightbe caused by the Excelfile being damaged orabnormal.

Enter the correctdirectory for thevalid Excel file inthe FilePathelement in theInput tab.

TIBCO-BW-PALETTE-EXCEL-510003

Activity Name:{0},

Operation Name:

{1};-- Input file:

{2}not found

error BW-Plug-in Occurs when the inputExcel file is not presentin the specifieddirectory.

Provide a validExcel file that ispresent in thespecifieddirectory.

43

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 44: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Error Code and ErrorMessage Role Category Description Solutions

TIBCO-BW-PALETTE-EXCEL-510004

Activity Name:{0},

Operation Name:

{1};-- No such

sheet in workbook

file {2} for given

sheet {3} {4}

error BW-Plug-in Occurs when a givensheet is not present inthe Excel file.

Ensure that thegiven sheet in theExcel file ispresent.

TIBCO-BW-PALETTE-EXCEL-510005

Activity Name:{0},

Operation Name:

{1};-- No such

directory {2} is

present in the file

system while

creating new file

error BW-Plug-in Occurs when the inputdirectory is not presentin the file system.

Provide adirectory that ispresent in the filesystem.

TIBCO-BW-PALETTE-EXCEL-510006

Activity Name:{0},

Operation Name:

{1};-- Invalid file

extension in user

input data {2}

error BW-Plug-in Occurs when theformat of the inputExcel file is incorrect.

Provide a correctformat for theinput Excel file.At present, onlythe .xlsx formatis supported.

TIBCO-BW-PALETTE-EXCEL-510007

Activity Name:{0},

Operation Name:

{1};--

StartingRowPointer

should be greater

than 0

error BW-Plug-in Occurs when the valuein theStartingRowPointerelement in the Inputtab is equal to or lessthan zero.

Ensure that thevalue in theStartingRowPointer element in theInput tab isgreater than zero.

TIBCO-BW-PALETTE-EXCEL-510008

Activity Name:{0},

Operation Name:

{1};-- No such row

{2} is present in

sheet {3} for file

{4}

error BW-Plug-in Occurs when the plug-in is used for carryingout operations, such asreading cell valuesfrom a row, which isnot present in the Excelfile.

Ensure that therow whereoperations arecarried out ispresent in theExcel file.

44

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 45: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Error Code and ErrorMessage Role Category Description Solutions

TIBCO-BW-PALETTE-EXCEL-510009

Activity Name:{0},

Operation Name:

{1};-- No such cell

{2} is present in

row {3} in sheet

{4} for file {5}

error BW-Plug-in Occurs when the plug-in is used for carryingout operations, such asreading cell valuesfrom a column that isnot present in the Excelfile.

Ensure that thecolumn whereoperations arecarried out ispresent in theExcel file.

TIBCO-BW-PALETTE-EXCEL-510010

Activity Name:{0},

Operation Name:

{1};-- The tag name

{2} for cell in Row

{3}: Column {4} is

duplicated in sheet

{5} for file {6}

error BW-Plug-in Occurs in the process ofcreating and updatingrows when the sametag name is entered indifferent TagNameelements underdifferent Cell nodes inthe Input tab.

Ensure that thetag name is notused more thanonce.

TIBCO-BW-PALETTE-EXCEL-510011

Activity Name:{0},

Operation Name:

{1};-- Input file

could not be

created:{2}

error BW-Plug-in Occurs when the inputfile path is incorrectand the input filecannot be created.

Ensure that thecorrect file path isentered.

TIBCO-BW-PALETTE-EXCEL-510013

Activity Name:{0},

Operation Name:

{1} ;-- Starting

Sheet Pointer

cannot be less than

zero or empty

error BW-Plug-in Occurs when the valueentered in theStartingSheetPointerelement is less than orequal to zero.

Ensure that thevalue entered intheStartingSheetPointer element isgreater than zero.

TIBCO-BW-PALETTE-EXCEL-510014

Activity Name:{0},

Operation Name:

{1};-- Error while

plotting X-Axis in

sheet {2} for file

{3}

error BW-Plug-in Occurs in the process ofdrawing a chart whenone or multiple cells ina column of the givenrange required fordrawing the chart arenot present.

Ensure that eachcell in the givenrange requiredfor drawing thechart is filledwith anappropriatevalue.

45

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 46: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Error Code and ErrorMessage Role Category Description Solutions

TIBCO-BW-PALETTE-EXCEL-510016

Activity Name:{0},

Operation Name:

{1};-- Unexpected

error occurred

while plotting

chart in sheet {2}

for file {3}

error BW-Plug-in Occurs when the plug-in fails to draw a plotchart in the Excel filebecause the Excel filemight be damaged orabnormal.

Provide a validExcel file.

TIBCO-BW-PALETTE-EXCEL-510017

Activity Name:{0},

Operation Name:

{1};-- Cell Address

for X Axis cannot

be less than zero

for sheet {2} for

file {3}

error BW-Plug-in Occurs in the process ofdrawing a chart whenthe value of the givencell column is less thanzero.

Ensure that thevalue of the cellcolumn is equalto or greater thanzero.

TIBCO-BW-PALETTE-EXCEL-510018

Activity Name:{0},

Operation Name:

{1};-- Error while

retrieving core

properties of file

{2}

error BW-Plug-in Occurs when the ExcelMetaData activity failsto get CorePropertiesfrom the Excel filebecause the Excel file isdamaged or abnormal.

Provide a validExcel file.

TIBCO-BW-PALETTE-EXCEL-510019

Activity Name:{0},

Operation Name:

{1};-- Error while

retrieving extended

properties of file

{2}

error BW-Plug-in Occurs when the ExcelMetaData activity failsto getExtendedPropertiesfrom the Excel filebecause the Excel file isdamaged or abnormal.

Provide a validExcel file.

TIBCO-BW-PALETTE-EXCEL-510020

Activity Name:{0},

Operation Name:

{1};-- The value is

not conformity with

the rule in

specified formula

"{2}" in sheet {3}

for file {4}

error BW-Plug-in Occurs when the valuein the cell that usesformula does notconform to formularules.

Ensure that thevalue in the cellconforms toformula rules.

46

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 47: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Error Code and ErrorMessage Role Category Description Solutions

TIBCO-BW-PALETTE-EXCEL-510021

Activity Name:{0},

Operation Name:

{1};-- The font

name "{2}" that is

specified is

invalid in current

system

error BW-Plug-in Occurs when the fontname entered is notsupported by thecurrent system.

Enter a font namethat is supportedby your currentsystem.

TIBCO-BW-PALETTE-EXCEL-510022

Activity Name:{0},

Operation Name:

{1};-- Excel file

name is absent in

user input data

error BW-Plug-in Occurs when the inputExcel file is not presentin the specifieddirectory.

Provide an Excelfile that is presentin the specifieddirectory.

TIBCO-BW-PALETTE-EXCEL-510023

Activity Name:{0},

Operation Name:

{1};-- No Rows

found in sheet {2}

for file {3}

error BW-Plug-in Occurs when the givenparameters for a row inthe Input tab cannot beused for locating thecorresponding row inthe Excel file.

Ensure that theparameters forthe row can beused for locatingthe row in theExcel file.

TIBCO-BW-PALETTE-EXCEL-510024

Activity Name:{0},

Operation Name:

{1};--No sheet

input for file {2}

error BW-Plug-in Occurs in the process ofreading values fromrows in an Excel filewhen the sheet name isempty.

Enter a validsheet name.

TIBCO-BW-PALETTE-EXCEL-510025

ERROR occurs when

rename the file {0}

to {1}

error BW-Plug-in Occurs in the process ofcreating or updatingrows when the plug-infails to rename theExcel file that isoccupied by anotherapplication.

Ensure that theExcel file is notoccupied byanotherapplication.

TIBCO-BW-PALETTE-EXCEL-510026

Activity Name: {0},

Operation Name:

{1} ;--Excel File

Name in input

schema is null or

empty

error BW-Plug-in Occurs in the process ofusing the plug-in tocreate rows or sheets,set metadata for or getmetadata from an Excelfile when the file pathin the Input tab is notspecified or empty.

Specify a validfile path in theInput tab.

47

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 48: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Error Code and ErrorMessage Role Category Description Solutions

TIBCO-BW-PALETTE-EXCEL-511001

Activity Name:{0},

Operation Name:

{1};-- Directory to

create output excel

file has not been

specified

error BW-Plug-in Occurs in the process ofcreating sheets, whenyou select the CreateNew File check boxwithout configuring theChoose OutputDirectory field in theGeneral tab and theFilePath element in theInput tab.

Ensure that theChoose OutputDirectory fieldand the FilePathelement areconfigured whenthe Create NewFile check box isselected.

TIBCO-BW-PALETTE-EXCEL-511002

Activity Name:{0},

Operation Name:

{1};-- Sheet by

Name {2} already

exists in file {3},

sheet names must be

unique

error BW-Plug-in Occurs in the process ofcreating sheets whenthe sheet name isalready present in theExcel file.

Enter a sheetname that is notpresent in theExcel file whencreating a sheet.

TIBCO-BW-PALETTE-EXCEL-511003

Activity Name:{0},

Operation Name:

{1};--Invalid

sheetName:{2}is in

user input data

error BW-Plug-in Occurs in the process ofcreating sheets whenthe sheet name enteredin the SheetNameelement is invalid.

Ensure that thesheet nameentered in theSheetNameelement is valid.

TIBCO-BW-PALETTE-EXCEL-512001

Activity Name:

{0},Operation Name:

{1};-- Unexpected

error while

deleting sheets in

workbook file {2}.

Aborting delete

sheets activity.

error BW-Plug-in Occurs in the process ofdeleting sheets whenthe plug-in fails toretrieve a sheet fromthe Excel file becausethe sheet has beendeleted and replacedby another sheet in theExcel file.

None.

48

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 49: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Error Code and ErrorMessage Role Category Description Solutions

TIBCO-BW-PALETTE-EXCEL-512002

Activity Name:

{0},Operation Name:

{1};--Cannot delete

sheets because

total sheets

entered to delete

[{2}] equals total

number of sheets in

excel file {3}

error BW-Plug-in Occurs in the process ofdeleting all sheetswhen not all the sheetsare deleted from theExcel file.

Ensure that atleast one sheet isleft in an Excelfile whendeleting sheets.

TIBCO-BW-PALETTE-EXCEL-512003

Activity Name:

{0},Operation Name:

{1};-- Cannot

delete any sheet

from excel file {2}

because the file

has only one sheet.

error BW-Plug-in Occurs in the process ofdeleting sheets whenthe Excel file has onlyone sheet left.

Ensure that theExcel file hasmore than onesheet whendeleting sheets.

TIBCO-BW-PALETTE-EXCEL-512004

Activity Name:

{0},Operation Name:

{1};-- Sheet

pointer to delete a

sheet cannot be

zero or lesser.

Value can be

ranging from 1 to

total number of

sheets in excel

file {2}

error BW-Plug-in Occurs in the process ofdeleting sheets basedon sheet pointer whenthe value in theSheetPointer elementis less than or equal tozero.

Ensure that thevalue in theSheetPointerelement is withinthe range of sheetnumber of theExcel file.

TIBCO-BW-PALETTE-EXCEL-512005

Activity Name:

{0},Operation Name:

{1};-- Sheet

pointer to delete

cannot be more than

the total sheets in

workbook. Value can

be ranging from 1

to total number of

sheets in excel

file {2}

error BW-Plug-in Occurs in the process ofdeleting sheets basedon sheet pointer whenthe value in theSheetPointer elementis greater than the totalsheet number in theExcel file.

Ensure that thevalue in theSheetPointerelement is withinthe range of sheetnumber of theExcel file.

49

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 50: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

Error Code and ErrorMessage Role Category Description Solutions

TIBCO-BW-PALETTE-EXCEL-513001

Activity Name:

{0},Operation Name:

{1};-- Input sheet

name could not be

created:{2}

error BW-Plug-in Occurs in the process ofcreating rows when theplug-in fails to create asheet because the sheetname is illegal or theExcel file is damaged.

Enter values of avalid Excel filewith a valid sheetname.

TIBCO-BW-PALETTE-EXCEL-514001

Activity Name:

{0},Operation Name:

{1};--

EndRowPointer

should be greater

than 0

error BW-Plug-in Occurs in the process ofdeleting rows when thevalue in theEndingRowPointerToDelete element is lessthan zero.

Ensure that thevalue in theEndingRowPointerToDeleteelement is greaterthan zero.

TIBCO-BW-PALETTE-EXCEL-514002

Activity Name:

{0},Operation Name:

{1};-- Start Row

pointer cannot be

greater than end

Row pointer for

sheet: {2}

error BW-Plug-in Occurs in the process ofdeleting rows when thevalue in theStartingRowPointerToDelete element isgreater than the valuein theEndingRowPointerToDelete element.

Ensure that thevalue in theStartingRowPointerToDeleteelement is equalto or less than thevalue in theEndingRowPointerToDeleteelement.

TIBCO-BW-PALETTE-EXCEL-514003

Activity Name:

{0},Operation Name:

{1};-- Entered

sheet pointer {2}

is more than total

sheets in workbook.

Value can be

ranging from 1 to

total number of

sheets in excel

file {3}

error BW-Plug-in Occurs in the process ofreading or deletingrows when the value ofthe sheet pointer isgreater than the totalsheet number in theExcel file.

Ensure that thevalue of the sheetpointer is equalto or less than thetotal sheetnumber in theExcel file.

TIBCO-BW-PALETTE-EXCEL-515001

Activity Name:

{0},Operation Name:

{1};--

RowChunckSizeToRead

should be greater

than 0

error BW-Plug-in Occurs in the process ofreading cell valuesfrom rows when thevalue in theRowChunckSizeToRead element in the Inputtab is equal to or lessthan zero.

Ensure that thevalue in theRowChunckSizeToRead elementin the Input tabis greater thanzero.

50

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide

Page 51: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ...€¦ · 4. Configure the added Excel activity, as described in Excel Palette. 5. Click File > Save to save the project

51

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft Excel User's Guide