TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft ... · A basic procedure of using TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint includes: 1. Creating a

TIBCO ActiveMatrix BusinessWorks™ Plug-infor Microsoft SharePointUser's Guide Software Release 6.1 January 2016Document Update: January 2017

Two-Second Advantage®

Important Information

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

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

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 ActiveMatrixBusinessWorks Plug-in for Microsoft SharePoint, TIBCO Business Studio, and TIBCO EnterpriseAdministrator are either registered trademarks or trademarks of TIBCO Software Inc. in the UnitedStates and/or other countries.

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

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

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

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

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICALERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESECHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCOSOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S)AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY ORINDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE,INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.

Copyright © 2013-2017 TIBCO Software Inc. All rights reserved.

TIBCO Software Inc. Confidential Information

2

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

Contents

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

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

Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8

Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Creating a SharePoint Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Getting Metadata from the Microsoft SharePoint Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Configuring a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Testing a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Deploying an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

TIBCO Business Studio Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

SharePoint Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

SharePoint Get Metadata Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

SharePoint Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

SharePoint Notification Listener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

SharePoint Add ListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

SharePoint Update ListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29

SharePoint Delete ListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

SharePoint Select ListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36

SharePoint Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Input Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

SharePoint Notification Configuration Management Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

SharePoint Notification Configuration Management Tool Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

JMS Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45

JMS Destination Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49

Event Handler Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Configuring SSL for TIBCO Enterprise Message Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Configuring SSL on the TIBCO Enterprise Message Service Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Configuring SSL on the Microsoft SharePoint Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Configuring SSL for the SharePoint Notification Listener Activity in the Plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Working with the Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Importing the Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Running the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Managing Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Setting Up Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Exporting Logs to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

3


Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

4


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, 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. To directly access documentation for this product, double-click thefollowing file:

TIBCO_HOME\release_notes\TIB_bwpluginsharepoint_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. On UNIX systems, the default TIBCO_HOMEis /opt/tibco.

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

● TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint Installation

● TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint User's Guide

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

The following documents provide additional information and can be found on the TIBCODocumentation site:

● TIBCO ActiveMatrix BusinessWorks Documentation

● TIBCO Enterprise Administrator User's Guide

● TIBCO Enterprise Message Service Installation

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 TIBCOmmunity

TIBCOmmunity 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. TIBCOmmunity offersforums, blogs, and access to a variety of resources. To register, go to the following web address:

https://www.tibcommunity.com

5


https://docs.tibco.com

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

https://support.tibco.com

https://www.tibcommunity.com

Product Overview

TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint plugs into TIBCO ActiveMatrixBusinessWorks™. You can use the plug-in to add, delete, update, and query data in the MicrosoftSharePoint server and listen to events that are triggered in the Microsoft SharePoint server.

TIBCO ActiveMatrix BusinessWorks is a leading integration platform that can integrate a wide varietyof technologies and systems within enterprise and on cloud. TIBCO ActiveMatrix BusinessWorksincludes an Eclipse-based graphical user interface (GUI) provided by TIBCO Business Studio™ fordesign, testing, and deployment. If you are not familiar with TIBCO ActiveMatrix BusinessWorks, seethe TIBCO ActiveMatrix BusinessWorks documentation for more details.

TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint plugs into TIBCO ActiveMatrixBusinessWorks and adds a SharePoint palette to TIBCO Business Studio. You can create a connectionbetween the plug-in and Microsoft SharePoint server, and then configure a process using the activitiesin the SharePoint palette to manage and query data in the Microsoft SharePoint server, and publishevents and refresh data from external systems.

Communication between the Plug-in and Microsoft SharePoint Server

The plug-in communicates with the Microsoft SharePoint server in the following ways:

● Through web service or Windows Communication Foundation (WCF) over HTTP or HTTPS

● Through a JMS server

When the plug-in queries metadata from the Microsoft SharePoint server, the plug-in communicateswith the Microsoft SharePoint server through WCF over HTTP or HTTPS.

When the plug-in manages data, such as adding, deleting, updating, and deleted list items in theMicrosoft SharePoint server, the plug-in communicates with the Microsoft SharePoint server throughweb services over HTTP or HTTPS.

When the plug-in listens to events occurring in the Microsoft SharePoint server, the plug-incommunicates with the Microsoft SharePoint server through the JMS server. The plug-in and MicrosoftSharePoint server support using JNDI or SSL to communicate with the JMS server.

6


Only the SharePoint Notification Listener activity depends on JMS to transfer messages between theplug-in and Microsoft SharePoint server.

Main Functions of the Plug-in

The plug-in mainly provides the following functions:

● The SharePoint Connection shared resource can be reused for the SharePoint Get Metadata tool anddifferent activities.

● You can use the SharePoint Get Metadata tool to get or review Microsoft SharePoint metadata,which is used to configure various Microsoft SharePoint activities at design time.

● You can use the SharePoint Notification Listener activity to listen to the events triggered on theMicrosoft SharePoint server, such as added, updated, deleted, or deleting a list item. You can alsouse the activity to work with other activities to fetch data and populate the custom list with the datafrom an external source.

● You can use the SharePoint Add ListItem, SharePoint Delete ListItem, and SharePoint UpdateListItem activities to add, delete, and update list items in the Microsoft SharePoint servers. Theseactivities also support batch operations, which mean that you can manage multiple list items at atime. Additionally, you can manage list items across Microsoft SharePoint sites on the condition thateach list has the same name and the same column names with the same sequence order.

● You can use different query conditions to select list items that belong to a specific list type from theMicrosoft SharePoint server through the SharePoint Select ListItem activity.

● You can use the SharePoint Query activity to query list items across different Microsoft SharePointlists and websites in a specific site collection.

● The SharePoint Notification Configuration Management tool is used to support the SharePointNotification Listener activity. The tool is deployed on the Microsoft SharePoint server after youinstall the .NET solution components packaged within the TIBCO ActiveMatrix BusinessWorksPlug-in for Microsoft SharePoint installer. You can use the SharePoint Notification ConfigurationManagement tool to configure JMS and destination information, set notification types, configureevent handlers, and refresh data information.

TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint has four installation types: AllPlugin Components, Runtime, SharePoint 2010 Server Installation, and SharePoint 2013 ServerInstallation. See TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint Installation fordetails.

7


Getting Started

This tutorial is designed for the beginners who want to use TIBCO ActiveMatrix BusinessWorks Plug-infor Microsoft SharePoint 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 SharePointincludes:

1. Creating a Project

2. Creating a SharePoint Connection

3. Getting Metadata from the Microsoft SharePoint Server

4. Configuring a Process

5. Testing a Process

6. Deploying an Application

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.

8


Result

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

Creating a SharePoint ConnectionAfter creating a project, you can add a SharePoint Connection shared resource to create a connectionbetween the plug-in and Microsoft SharePoint server.

Prerequisites

The SharePoint Connection shared resource is available at the Resources level. Ensure that you havecreated a project, as described in Creating a Project.

Procedure

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

2. Right-click the Resources folder and click New > SharePoint Connection to open the SharePointConnection wizard.

3. The resource folder, package name, and resource name of the SharePoint connection are providedby default. If you do not want to use the default configurations, change them accordingly. ClickFinish to open the sharepointconnection Editor.

9


4. Configure the SharePoint connection in the sharepointconnection Editor.See SharePoint Connection regarding the configuration fields.

5. Click Test SharePoint Connection to test whether the specified configuration fields result in a validconnection to the Microsoft SharePoint server using the runtime and design-time credentials.

6. Optional: Click Get JMS Configuration to retrieve JMS configuration information from theMicrosoft SharePoint server if you have configured the JMS configuration information using theSharePoint Notification Configuration Management tool, which is installed on the MicrosoftSharePoint server.

7. Optional: Click Test JMS Connection to test whether the specified configuration fields result in avalid connection to the JMS server.

Getting Metadata from the Microsoft SharePoint ServerThe Microsoft SharePoint metadata is required when configuring various activities at design time.

Prerequisites

Ensure that the design-time credentials are provided in the SharePoint Connection shared resourcewhen getting the metadata. Before getting the metadata from the Microsoft SharePoint server, you haveto create a SharePoint connection. See Creating a SharePoint Connection.

See SharePoint Get Metadata Tool for more details about the description for each filed.

Procedure

1. Right-click the root directory of the created project, and then click SharePoint Tools > GetMetadata.

The Get Metadata window is displayed.

10


2. Click Browse in the Get Metadata window, and select a SharePoint connection in the SelectSharePoint Connection window. Click OK.

3. Click Get Web to get available websites.

4. Click Get Metadata to get metadata from the Microsoft SharePoint server.

5. Click Close to exit the Get Metadata tool.

Configuring a ProcessAfter creating a project, an empty process is created. You can add activities to the empty process tocomplete a task. For example, add a document item from the Microsoft SharePoint Shared Documentslibrary.

Prerequisites

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

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 theSharePoint Add ListItem activity from the SharePoint palette.

11


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

4. Configure the added SharePoint activities, as described in SharePoint Palette.

A SharePoint connection is required when configuring the SharePoint activities. See Creating a SharePoint Connection for more details about how to create a SharePointconnection.

5. Click File > Save to save the project.

Testing a ProcessAfter configuring a process, you can test the process to check if the process completes your task.

Prerequisites

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

Procedure

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

2. 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.

3. 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.

12


4. In the Debug tab, expand the running process and click an activity.

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

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 about how to deploy anapplication.

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.

13


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 provides quick access to activities when configuring a process.

14


SharePoint Connection

The SharePoint Connection shared resource contains all necessary parameters to establish connectionsamong the Microsoft SharePoint plug-in, JMS server, and Microsoft SharePoint server.

This shared resource can be reused for the SharePoint Get Metadata tool and different activities of theplug-in.

General

In the General panel, you can specify the package that stores the SharePoint Connection sharedresource and the shared resource name.

The following table lists the configurations in the General panel of the SharePoint Connection sharedresource:

FieldModuleProperty? Description

Package No (Optional) The name of the package where the newshared resource is added.

Name No (Required) The name to be displayed as the label for theSharePoint shared resource in the process.

Description No (Optional) A short description for this shared resource.

Shared Connection Configuration

In the Shared Connection Configuration panel, you can provide the information of the MicrosoftSharePoint server that the plug-in connects to.

The following table lists the configurations in the Shared Connection Configuration panel of theSharePoint Connection shared resource:

Field

ModuleProperty? Description

SharePoint Server Connection Configuration

15


Field


SharePointSiteCollection

Yes (Required) The URL of the SharePoint site collection that you want toaccess. It is the top-level website.

The address format must be consistent with the one set on theMicrosoft SharePoint server. For example, if the public URL set onthe Microsoft SharePoint server is an IP address, the value on theSharePoint Website Address must use an IP address.

The plug-in supports HTTPS communication betweenTIBCO ActiveMatrix BusinessWorks Plug-in for MicrosoftSharePoint and Microsoft SharePoint server. If you want touse HTTPS, you have to configure IIS for the MicrosoftSharePoint server to support HTTP over SSL, and thentype the HTTPS URL in this field. For example: https://host_name:Https_Port_Number.

The plug-in automatically selects HTTP or HTTPS basedon the prefix of the URL, such as http and https duringrun time and design time.

AuthenticationMethod

No (Required) The supported Windows authentication methods that areused to validate the credentials of connecting users.

The plug-in supports BASIC, NTLM, and KERBEROSauthentication methods in Claims-Based Authentication forMicrosoft SharePoint 2010/2013. The plug-in supports BASIC,NTLM, and KERBEROS authentication methods in Classic ModeAuthentication for Microsoft SharePoint 2010.

After you set the authentication method on the MicrosoftSharePoint server in the central administration website,you can select the corresponding authentication method inthe plug-in.

KerberosKRB5ConfigurationFile

No (Required when the KERBEROS authentication method is used.)

Click the icon to locate the Kerberos KRB5 configuration file.

The Kerberos configuration file contains Kerberos configurationinformation, including the locations of Key Distribution Centers(KDCs) and admin servers for the Kerberos realms of interest,defaults for the current realm and for Kerberos applications, andmappings of hostnames onto Kerberos realms.

KerberosLoginConfigurationFile

No (Required when the KERBEROS authentication method is used.)

Click the icon to locate the Kerberos Login configuration file.

The file contains the configuration information of the loginproperties in Java Authentication Authorization Service (JAAS).

16


Field


RuntimeUsername

Yes (Required) The runtime user name that the plug-in activities can useto authenticate against and run.

If you have a domain account, you must provide the domain namein this field. The format is domainName\username. If not, you candirectly enter your user name.

RuntimePassword

Yes (Required) The runtime password that the plug-in activities can useto authenticate against and run.

Design-timeUsername

Yes (Required) The design-time user name that is used when gettingmetadata by using the SharePoint Get Metadata tool, and to retrievea Destination topic in the SharePoint Notification Listener activity.

If you have a domain account, you must provide the domain namein this field. The format is domainName\username. If not, you candirectly enter your user name.

Design-timePassword

Yes (Required) The design-time password that is used when gettingmetadata by using the SharePoint Get Metadata tool, and to retrievea Destination topic in the SharePoint Notification Listener activity.

JMS Server Connection Configuration

JMS Username Yes (Required only when authorization is enabled on the JMS server.)The user name used to access a JMS server.

JMS Password Yes (Required only when authorization is enabled on the JMS server.)The password used to access a JMS server.

Auto-generated JMSClient ID

No (Required) Whether you want to automatically generate a client IDfor the connection to a JMS server. The automatically generatedstring is in GUID format.

If this check box is not selected, the value specified in the Client IDfield is used for the connection.

Client ID Yes (Optional) The client ID of the JMS connection. Each connectionmust use a unique client ID.

See documentation of your JMS provider for more information aboutclient IDs.

If the value specified in the Client ID field is already inuse, an error occurs when messages are triggered on theMicrosoft SharePoint server.

Use JNDI forConnectionFactory

No (Optional) Whether you want to use JNDI (Java Naming andDirectory Interface) to query the factory object from the JMS server.

17


Field


JMS ProviderURL

Yes (Required) The URL to JMS service provider. The general syntax isprotocol://hostname:port. To take TIBCO Enterprise MessageService™ as an example, the URL is tcp://localhost:7222.

JNDI Configuration

The JNDI Context Factory, JNDI Context URL, Topic Connection Factory, Queue ConnectionFactory, JNDI Username, and JNDI Password fields are displayed after you select the Use JNDI forConnection Factory check box.

JNDI ContextFactory

No (Required for using JNDI) The initial context factory class foraccessing JNDI. The default context factory for TIBCO EnterpriseMessage Service iscom.tibco.tibjms.naming.TibjmsInitialContextFactory.

JNDI ContextURL

Yes (Required for using JNDI) The URL to the JMS service provider. Thegeneral syntax is protocol://hostname:port. To take TIBCOEnterprise Message Service as an example, the URL istibjmsnaming://localhost:7222.

TopicConnectionFactory

Yes (Required for using JNDI) The topic connection factory used tocreate connections for publishing or subscribing messaging. Thedefault value is TopicConnectionFactory.

QueueConnectionFactory

Yes (Required for using JNDI) The queue connection factory used tocreate connections for point-to-point messaging. The default value isQueueConnectionFactory.

JNDIUsername

Yes (Required for using JNDI if authorization is enabled on the JMSserver.) The user name used to access the JMS server.

JNDIPassword

Yes (Required for using JNDI if authorization is enabled on the JMSserver.) The password used to access the JMS server.

ConnectionFactory SSLPassword

Yes (Required for using Secure Sockets Layer (SSL)) The password usedto access the JMS server.

Use SSL forJMS

No (Optional) Whether you want to use SSL to support clientauthentication for the JMS server.

SSL Configuration

The Trusted Certificates Path, Identity File, Identity Password, Connection Factory SSL Password,and Target Host Name fields are displayed after you select the Use SSL for JMS check box. See Configuring SSL for TIBCO Enterprise Message Service for details about how to enable SSL.

TrustedCertificatesPath

No (Required for using SSL) The path of the certificates where thecertificates are available.

18


Field


Identity File No The identity file used for two-way SSL authentication for the plug-in.

● If you want to use one-way SSL authentication, you do not haveto provide the identity file and identity password.

● If you want to use two-way SSL authentication, you have toprovide the identity file and identity password.

IdentityPassword

Yes The password used to access the identity file.

Target HostName

Yes (Optional for using SSL) The common name of the JMS servercertificate. If you type a value in this field, the plug-in can verify thetarget host name.

Test SharePoint Connection

You can click Test SharePoint Connection to test whether the specified configuration fields result in avalid connection to the Microsoft SharePoint server by using the runtime and design-time credentials.

Get JMS Configuration

You can click Get JMS Configuration to retrieve the JMS configuration information from the MicrosoftSharePoint server automatically if you have configured the JMS configuration information by using theSharePoint Notification Configuration Management tool, which is installed on the Microsoft SharePointserver. See SharePoint Notification Configuration Management Tool for details about this tool.

The following parameters cannot be automatically retrieved from the Microsoft SharePoint server:

● Client ID. You have to type the value manually or select the Auto-generated JMS Client ID checkbox to generate a client ID.

● JMS Password, JNDI Password, Connection Factory SSL Password, and Identity Password.To protect the privacy of users, you have to type the values manually.

● Trusted Certificates Path and Identity File. The values of these two parameters might bedifferent from those on the Microsoft SharePoint server. You have to type the values manually.

Test JMS Connection

You can click Test JMS Connection to test whether the specified configuration fields result in a validconnection to the JMS server.

19


SharePoint Get Metadata Tool

The SharePoint Get Metadata tool is deployed on your machine after installing TIBCO ActiveMatrixBusinessWorks Plug-in for Microsoft SharePoint. It is used to get metadata from the MicrosoftSharePoint server.

The length of the web name, list name, and content type name defined in Microsoft SharePoint must beless than 200 characters. If not, an error occurs when getting metadata from the Microsoft SharePointserver.

The SharePoint Get Metadata tool window contains the following configurations:

Field Description

SharePointConnection

(Required) Specify a SharePoint Connection shared resource.

Click Browse to locate the SharePoint Connection shared resources.

Web Name (Required) Specify the site where metadata is saved.

Click Get Web to get all the available sites from the site collection which hasbeen defined in the selected shared resource.

Get Metadata Click Get Metadata to get metadata.

View Metadata Click View Metadata to view metadata.

Clear Click Clear to remove the selected SharePoint Connection shared resources.

Close Click Close to exit the SharePoint Get Metadata tool.

20


SharePoint Palette

A palette groups the activities that connect the same external applications together. A SharePointpalette is added after installing TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint.

The SharePoint palette contains the following activities to manage Microsoft SharePoint entries andmonitor a connected Microsoft SharePoint server:

● SharePoint Notification Listener

● SharePoint Add ListItem

● SharePoint Update ListItem

● SharePoint Delete ListItem

● SharePoint Select ListItem

● SharePoint Query

SharePoint Notification ListenerThe SharePoint Notification Listener activity not only supports listening to the events occurring on theMicrosoft SharePoint server but also refreshing data from an external enterprise system in a custom list.

Before you can use the SharePoint Notification Listener activity, a user with administrative privilegesmust deploy .NET Solutions on the Microsoft SharePoint server. See TIBCO ActiveMatrix BusinessWorksPlug-in for Microsoft SharePoint Installation for details.

The following list shows the event handling and data refresh functions provided by the activity:

● Event Handler: The activity responds to the events triggered on the Microsoft SharePoint server.The event types supported in this activity include the added, updated, deleting, and deleted a listitem.

To enable this function, you must use the SharePoint Notification Configuration Management tool tobind the selected list to the event handler first. See SharePoint Notification ConfigurationManagement Tool for more details.

When an add operation is triggered in the Microsoft SharePoint Picture library and WikiPage library, or when you use the SharePoint Add ListItem activity to add the same listitem to the Microsoft SharePoint Document list, the SharePoint Notification Listeneractivity can be triggered more than once.

● Refresh Data: The activity is triggered by clicking the TIBCO Refresh Data custom web part that isinserted into a custom Microsoft SharePoint list. After successfully installing the custom web partsolution on the Microsoft SharePoint server and inserting the custom web part into a customMicrosoft SharePoint list, the Refresh Data From External Application button is displayed on theweb page that renders the custom list. You can use the activity to work with other activities, such asRequest-Response Service of TIBCO ActiveMatrix® Adapter for Siebel, to fetch data and populatethe custom list with the data from an external source.

To enable this function, you must use the SharePoint Notification Configuration Management tool tobind custom lists with the Refresh Data notification type, set the destination information and deploythe custom web part in the Microsoft SharePoint custom list.

When you log on to the Microsoft SharePoint portal with read-only access and try to usethe TIBCORefreshData custom web part, the Refresh Data From External Applicationbutton is disabled. To use this web part and fetch the data from an external application,you must have read/write access privileges.

21


General

In the General tab, you can establish a connection to a Microsoft SharePoint server and specify the listitem that you want to listen to.

The following table lists the configurations in the General tab of the SharePoint Notification Listeneractivity:


Name No (Required) Specify the name to be displayed as the label for theactivity in the process. The default value isSharePointNotificationListener.


Yes(Required) Click the icon to select a SharePoint Connectionshared resource. The SharePoint Connection shared resourcecreates a connection between the plug-in and a MicrosoftSharePoint server.

If no matching SharePoint Connection shared resources are found,click Create Shared Resource to create one. See Creating aSharePoint Connection for more details.

Web Name No (Required) Get the target website.

Click Fetch Webs to get available websites from the site collectionspecified in the SharePoint shared resource.

List Name No (Required) Get the list that you want to operate on.

Click Fetch Lists to get available lists from the website selected inthe Web Name field.

Notification Type No (Required) Get the notification type. The following options of thenotification type are available:

● Event Handler: it can be used to capture events, such asadded, updated, deleting, and deleted that are triggered inMicrosoft SharePoint lists.

● Refresh Data: it can be used to refresh the data, generatedfrom an external application in a Microsoft SharePoint customlist representation.

22



SharePoint Event No (Required) Specify which kind of events that the activity respondsto. This field is displayed only when the Event Handlernotification type is selected.

The following options of the SharePoint event are available:

● Select All: it is triggered when any events occur in a list inMicrosoft SharePoint.

● ItemAdded: it is triggered when a new list item is added to alist in Microsoft SharePoint.

● ItemUpdated: it is triggered when an existing item in aMicrosoft SharePoint list is updated.

● ItemDeleting: it is triggered when an existing list item is aboutto be deleted from a list in Microsoft SharePoint server.

● ItemDeleted: it is triggered when an existing list item isdeleted from a Microsoft SharePoint list.

DestinationName

Yes (Required) Specify the destination name.

Click Get Destination Configuration to get the destination nameand its connection factory type.

Ensure that you have configured the appropriatedestination name for the selected list and selected theconnection factory type by using the SharePointNotification Configuration Management tool deployedon the Microsoft SharePoint server. See SharePointNotification Configuration Management Tool for detailsabout how to create a topic or queue destination.

ConnectionFactory Type

No (Required) Specify the connection factory type.

The following options of the connection factory type are available:

● Topic: it is used to create connections for publishing orsubscribing messaging when the SharePoint NotificationListener activity communicates with the JMS server.

● Queue: it is used to create connections for point-to-pointmessaging when the SharePoint Notification Listener activitycommunicates with the JMS server.

The activity supports the durable subscribers for topics.The durable subscriber ensures that the messages sentfrom the Microsoft SharePoint server cannot be lostwhen the activity subscribes to the topic, even if theactivity is not currently running.

DurableSubscription

No (Optional) Specify whether you want to create the durablesubscription for the topic. This check box is displayed when youselect the Topic connection factory. If it is selected, you have toconfigure the Durable Name field.

23



Durable Name Yes (Required) The name used to access the durable subscription forthe topic. This field is displayed when you select the DurableSubscription check box.

Description

In the Description tab, you can enter a short description for the SharePoint Notification Listeneractivity.

Advanced

In the Advanced tab, you can specify the running sequence of processes and custom job ID for theprocess instance.

The following table lists the configurations in the Advanced tab of the SharePoint Notification Listeneractivity:


SequenceKey

No This field contains an XPath expression that specifies which processesrun in order. Process instances with sequencing keys that evaluate tothe same value are performed sequentially in the order the processinstance was created.

Custom JobID

No This field contains an XPath expression that specifies a custom job IDfor the process instance. This ID is displayed in the TIBCOAdministrator View Service dialog, and it is also available in the$_processContext process variable.

Output

In the Output tab, you can find the event that is triggered results.

The following table lists the output elements in the Output tab of the SharePoint Notification Listeneractivity:

Output Item Data Type Description

EventType String The type of the event. The event type values containsRefresh Data , ItemAdded, ItemUpdated, ItemDeleting,and ItemDeleted.

TriggerDateTime String The date and time when the event is triggered.

CurrentUserId String The ID of the user who initializes the event in MicrosoftSharePoint.

CurrentUserName String The name of the user who initializes the event in MicrosoftSharePoint.

WebSiteID String The ID of the site, which the selected list belongs to.

24



WebSiteURL String The URL of the site, which the selected list belongs to.

ListId String The ID of the list, which the list item belongs to.

ListTitle String The title of the list, which the list item belongs to.

Event Handler Notification Type Only

The following output items are displayed only when you select the Event Handler notification type.

ListItemId String The ID of the list item where the event is triggered.

ListItemDisplayName String The name of the list item where the event is triggered.

ListItemData N/A The attributes of the list item where the event occurs. Itvaries with different content types. For the meaning of eachattribute, see the Microsoft SharePoint documentation formore details.

This field is not available for the ItemDeletedevent.

Fault

In the Fault tab, you can find the error code and error message of the SharePoint Notification Listeneractivity. See Error Codes for more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the SharePoint Notification Listeneractivity:

ErrorSchemaElement Data Type Description

SharePointPluginException

msg String Displays the error message returned by the plug-in.

msgCode String Displays the error code returned by the plug-in.

SharePoint Add ListItemThe SharePoint Add ListItem activity not only supports adding one or more list items to an existingMicrosoft SharePoint list but also adds list items across Microsoft SharePoint sites if each list has thesame name and column names with the same sequence order.

This activity supports the following functions:

● Adding a data item or a folder in a generic list.

● Adding a document library item, a document link, or a folder in a document library.

● Batch operations. You can add multiple list items at a time. If you want to add the data collection tothe Microsoft SharePoint list in batch, you can use the For-Each statement to map the data collectionto the input fields in the SharePoint Add ListItem activity.

25


Supported functionality of the activity is determined by the list and the content type selected at designtime.

The SharePoint Add ListItem activity does not support adding a file to the Meeting workspace libraryin Microsoft SharePoint.

General

In the General tab, you can establish a connection to a Microsoft SharePoint server, specify the list itemthat you want to add, and set the Timeout time for calling the process.

The following table lists the configurations in the General tab of the SharePoint Add ListItem activity:

FieldModuleProperty ? Description

Name No (Required) Specify the name to be displayed as the label for theactivity in the process. The default value isSharePointAddListItem.


Yes(Required) Click the icon to select a SharePoint connection.

If no matching SharePoint Connection shared resources arefound, click Create Shared Resource to create one. See Creatinga SharePoint Connection for more details.


Click Fetch Webs to get available websites from the sitecollection specified in the SharePoint Connection sharedresource.


Click Fetch Lists to get available lists from the site selected in theWeb Name field.

Content Type No (Required) Specify the content type used to define the list item.

Click Fetch Content Types to get available content types of theselected list.

Timeout(sec) Yes (Required) Specify how long the plug-in waits for the process toperform the add operation. The default value is 120.

The add operation might fail or succeed if it times outwhen started at run time. The result is undefined. Youhave to provide enough time for the add operation toperform.

Description

In the Description tab, you can enter a short description for the SharePoint Add ListItem activity.

Input

In the Input tab, you can specify the list item that you want to add.

26


The following table lists the input elements in the Input tab of the SharePoint Add ListItem activity:

Input ItemDataType Description

WebName String The target website. You can use the activity to add list itemsacross Microsoft SharePoint sites. You can add a group to thisactivity, and get the website from a previously performedactivity in the current process.

The value specified in this parameter takesprecedence over the one set in the General tab.

RootFolder String The folder used to store the new list item in the MicrosoftSharePoint server.

The following examples list the string format:

● Absolute path to the list: //host:port/sites/web/LibraryName/folderpath/

● Relative path to the list: /parent-Folder/folder

If you leave this parameter empty, the root folder is used asthe default storage.

Ensure that the folder provided exists in theMicrosoft SharePoint list.

Item N/A The output of each attribute of the new item. The attributesvary with different content types. For the meaning of eachattribute, see the Microsoft SharePoint documentation formore details.

Upload Document to Document Library

The following parameters are displayed when you upload a document to a Microsoft SharePointdocument library.

FileName String The file name given to the file when it is uploaded to theMicrosoft SharePoint server.

LocalFileLocation String The complete path of the source file.

You must specify a value either in the input item orin the FileContent input item. Ensure that the sizeof the file is less than 25 MB.

FileContent binary The binary content of a file, which is transferred from aprevious activity in a process.

The size of the file has to be less than 25 MB.

27


Input ItemDataType Description

OverwriteExistFile Boolean Whether you want to overwrite the existing file.

● The value of true() indicates the existing file isoverwritten.

● The value of false() indicates the existing file is notoverwritten and a failure is returned.

If you leave the field empty, the value of true() is kept as thedefault value.

Output

In the Output tab, the Success node lists the status of all the operations, and the Results node lists thestatus of the current operation.

The following table lists the output elements in the Output tab of the SharePoint Add ListItem activity:

OutputItem Data Type Description

Success Boolean This property indicates the status of all of the operations. If no erroroccurs when adding one or more records, the status true is returned.

Results

Result The Result element contains the following elements:

● Success (a Boolean value): this property indicates the status of thecurrent operation. If no error occurs when adding a record, the statustrue is returned.

● ErrorMessage (a String value): the message returned from theMicrosoft SharePoint system.

● Item: the output of each attribute of the new item. The attributes varywith different content types. For the meaning of each attribute, seethe Microsoft SharePoint documentation for more details.

Fault

In the Fault tab, you can find the error code and error messages of the SharePoint Add ListItem activity.See Error Codes for more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the SharePoint Add ListItem activity:

Error SchemaElement Data Type Description




28



SharePointRemoteException

msg String Displays the error message of the Microsoft SharePoint system whenprocessing a request from the plug-in.

msgcode String Displays the error code of the Microsoft SharePoint system whenprocessing a request from the plug-in.

encoding String Displays the error encoding of the Microsoft SharePoint system whenprocessing a request from the plug-in.

ActiveTimedOutException

msg String Displays the error message when the Add ListItem operation timesout.

msgcode String Displays the error code when the Add ListItem operation times out.

SharePoint Update ListItemThe SharePoint Update ListItem activity not only supports updating one or more list items in a specificMicrosoft SharePoint list but also updates list items across Microsoft SharePoint sites that each list hasthe same name and column names with the same sequence order.


● Updating a data item or a folder in a generic list.

● Updating a document library item, a document link, or a folder in a document library.

● Batch operations. You can update multiple list items at a time. You can also use the For-Eachstatement to map the collection of list items to the current activity.

The activity only supports using the list item ID to update list items. If you want to use other queryconditions, you have to use the SharePoint Select ListItem activity to select the list item first, and thenuse the SharePoint Update ListItem activity to update the list item.

The SharePoint Updated ListItem activity does not support batch operations when you upload adocument. And it does not support uploading a file to the Meeting workspace library in MicrosoftSharePoint.

General

In the General tab, you can establish a connection to a Microsoft SharePoint server, specify the list itemthat you want to update in Microsoft SharePoint, and set the Timeout time for calling the process.

The following table lists the configurations in the General tab of the SharePoint Update ListItemactivity:

29



Name No (Required) Specify the name to be displayed as the labelfor the activity in the process. The default value isSharePointUpdateListItem.


Yes(Required) Click the icon to select a SharePointconnection.

If no matching SharePoint Connection shared resourcesare found, click Create Shared Resource to create one. See Creating a SharePoint Connection for more details.




Click Fetch Lists to get available lists from the siteselected in the Web Name field.

Content Type No (Required) Specify the content type used to define the listitem.

Click Fetch Content Types to get available content typesof the selected list.

The list item that you want to update, which isspecified in the Input tab, has the same contenttype selected as in this list. If the content type ismismatched, the plug-in cannot report errors,but you will get an unexpected result.

UploadDocument

No (Required) Specify whether to upload a document.

This field is displayed when you select a Documentcontent type.

Timeout(sec) Yes (Required) Specify how long the plug-in waits for theprocess to perform the update operation. The defaultvalue is 120.

The update operation might fail or succeed if ittimes out when started at run time. The result isundefined. You have to provide enough time forthe update operation to perform.

Description

In the Description tab, you can enter a short description for the SharePoint Update ListItem activity.

30


Input

In the Input tab, you can specify the list item that you want to update.

The following table lists the input elements in the Input tab of the SharePoint Update ListItem activity:

Input Item Data Type Description

WebName String The target website. You can update list items by using theactivity across Microsoft SharePoint sites. You can add agroup to this activity, and get the site from a previouslyperformed activity in the current process.

The value specified in this input item takesprecedence over the one set in the General tab.

Items N/A The attributes of the new item. The attributes vary withdifferent content types. See Input Guidelines for details abouthow to provide a valid input.

You must provide a value for the ID attribute. Ifyou leave other attributes empty, the value of theattribute is not updated on the MicrosoftSharePoint server.

Upload Document to Document Library

The following input items are displayed when you update a document in the Microsoft SharePointdocument library.

LocalFileLocation String The location of the source file.

You must specify a value in this input item or in theFileContent input item.

FileContent Binary The binary content of a file, which is transferred from aprevious activity in a process.

The size of the file must be less than 25 MB.

Output


The following table lists the output elements in the Output tab of the SharePoint Update ListItemactivity:


Success Boolean This property indicates the status of all of the operations. If no erroroccurs when updating one or more records, the status true is returned.

Results

31




● Success (a Boolean value): this property indicates the status of thecurrent operation. If no error occurs when updating a record, thestatus true is returned.


● Item: the output of each attribute of the new item. It varies withdifferent content types. For the meaning of each attribute, see theMicrosoft SharePoint documentation for more details.

Fault

In the Fault tab, you can find the error code and error messages of the SharePoint Update ListItemactivity. See Error Codes for more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the SharePoint Update ListItemactivity:






msg String Displays the error message of the Microsoft SharePoint systemwhen processing a request from the plug-in.


encoding String Displays the error encoding of the Microsoft SharePoint systemwhen processing a request from the plug-in.


msg String Displays the error message when the Update ListItem operationtimes out.

msgcode String Displays the error code when the Update ListItem operation timesout.

32


SharePoint Delete ListItemThe SharePoint Delete ListItem activity not only supports deleting one or more list items fromMicrosoft SharePoint lists but also deletes list items across Microsoft SharePoint sites if each list has thesame name and column names with the same sequence order.


● Deleting a data item or a folder from a generic list.

● Deleting a document library item, a document link, or a folder from a document library.

● Batch operations. You can delete multiple list items at a time. You can type all the IDs of the listitems that you want to delete in the activity. If the amount of list items are unknown, you can usethe For-Each statement to map the ID collection to the current activity.

The activity only supports using the list item ID to delete list items. If you want to use other queryconditions, you have to use the SharePoint Select ListItem activity to select the list item first, and thenuse the SharePoint Delete ListItem activity to delete the list item.

General

In the General tab, you can establish a connection to a Microsoft SharePoint server, specify the list itemthat you want to delete, and set the Timeout time for calling the process.

The following table lists the configurations in the General tab of the SharePoint Delete ListItem activity:


Name No (Required) Specify the name to be displayed as the label forthe activity in the process. The default value isSharePointDeleteListItem.



If no matching SharePoint Connection shared resources arefound, click Create Shared Resource to create one. See Creating a SharePoint Connection for more details.




Click Fetch Lists to get available lists from the websiteselected in the Web Name field.

33



Timeout(sec) Yes (Required) Specify how long the plug-in waits for theprocess to perform the delete operation. The default value is120.

The delete operation might fail or succeed if ittimes out when started at run time. The result isundefined. You have to provide enough time forthe delete operation to perform.

Description

In the Description tab, you can enter a short description for the SharePoint Delete ListItem activity.

Input

In the Input tab, you can specify the list item that you want to delete.

The following table lists the input elements in the Input tab of the SharePoint Delete ListItem activity:


WebName String The target website. You can delete list items across MicrosoftSharePoint sites by using the activity. You can add a group to thisactivity, and get the website from a previously performed activity inthe current process.

The value specified in this input item takes precedence overthe one set in the General tab.

ID Integer The list item ID.

Output


The following table lists the output elements in the Output tab of the SharePoint Delete ListItemactivity:


Success Boolean This property indicates the status of all of the operations. If no erroroccurs when deleting one or more records, the status true is returned.

Results

34




● Success (a Boolean value): this property indicates the status of thecurrent operation. If no error occurs when deleting a record, thestatus true is returned.


● Item: the output of each attribute of the new item. It varies withdifferent content types. For the meaning of each attribute, see theMicrosoft SharePoint documentation for more details.

Fault

In the Fault tab, you can find the error code and error messages of the SharePoint Delete ListItemactivity. See Error Codes for more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the SharePoint Delete ListItemactivity:










msg String Displays the error message when the Delete ListItem operation timesout.

msgcode String Displays the error code when the Delete ListItem operation times out.

35


SharePoint Select ListItemThe SharePoint Select ListItem activity not only supports selecting list items from a specific MicrosoftSharePoint list using different query conditions but also supports for paging.

The paging feature is always used when the numbers of the queried list items are large. You can usethis feature to define the maximum number of list items that the activity gets from the MicrosoftSharePoint list each time, and then use the group to query all the list items iteratively. See TIBCOActiveMatrix BusinessWorks Process Design Guide for details about the group.

The SharePoint Select ListItem activity is always used with the SharePoint Update ListItem activity andthe SharePoint Delete ListItem activity. The purpose of the SharePoint Select ListItem activity is to serveas a helper for the update and delete operations when you do not know the ID of the item that youwant to update or delete.

The SharePoint Select ListItem activity can also be used to look up the format of the input value whenyou use the SharePoint Add ListItem and SharePoint Update ListItem activities to add or update listitems.

This activity does not support selecting list items across different SharePoint lists. Additionally, youcannot select list items by using content types for the following Microsoft SharePoint lists: Agenda,Objectives, Decisions, Categories, Directions, Things to Bring, and Survey List.

To select list items across different Microsoft SharePoint lists, you can use the SharePoint Query activity.

General

In the General tab, you can establish a connection to a Microsoft SharePoint server, specify the list itemthat you want to select, and set the Timeout time for calling the process.

The following table lists the configurations in the General tab of the SharePoint Select ListItem activity:


Name No (Required) Specify the name to be displayed as the labelfor the activity in the process. The default value isSharePointSelectListItem.







Click Fetch Lists to get available lists from the site selectedin the Web Name field.

36



CAML Source No (Required) Specify the query schema of CollaborativeApplication Markup Language (CAML). The followingoptions of the CAML source are available:

● Simple CAML: supports the Contains and Eq queries.After you provide values for the list item in the Inputtab, the activity uses the non-empty values to do thesearching.

If the input value is Text, Note, URL, Choice, or Multichoice data Type, the query are generated as aContains query. Others are generated as an Eq query.See Input Guidelines for more details about theseMicrosoft SharePoint data types.

● Input CAML: supports typing a CAML query directlyin the CAMLText field in the Input tab. The root nodeof the query must be Query.

CAML is an XML-based language that is used inMicrosoft SharePoint Foundation to define thefields and views that are used in sites and lists.See http://msdn.microsoft.com/en-us/library/ms426449.aspx for details about CAML.

Page Size Yes (Required) Specify the maximum numbers of list items thatcan be queried at once. The default value is 0 , whichreturns all the results. The recommended value is from 100to 5000.

Timeout(sec) Yes (Required) Specify how long the plug-in waits for theprocess to perform the select operation. The default valueis 120.

The select operation might fail or succeed if ittimes out when started at run time. The result isundefined. You have to provide enough time forthe select operation to perform.

Description

In the Description tab, you can enter a short description for the SharePoint Select ListItem activity.

Input

In the Input tab, you can specify the list item that you want to select.

The following table lists the input elements in the Input tab of the SharePoint Select ListItem activity:

37


http://msdn.microsoft.com/en-us/library/ms426449.aspx

http://msdn.microsoft.com/en-us/library/ms426449.aspx


Page String The page parameter returned by Microsoft SharePoint in the lastselection operation. You can use this input item to enable the pagingfeature. This feature is used to define the maximum number of listitems that the activity gets from the Microsoft SharePoint list eachtime. You can use the group to select all the list items iteratively.

FieldValues N/A The attributes of the selected item. It varies depending on the list. See Input Guidelines for details about how to provide a valid input. Theinput item only is displayed when you select Simple CAML as theCAML source.

When the activity uses the recipient field to select a listitem, the activity only supports typing a single value in thisinput item each time.

CAMLText String The CAML query. You can manually type in a query or you can usethe generated query from the previous activity in the current process.The input item only is displayed when you select Input CAML as theCAML source.

The root node of the CAML query must be Query.

Output

In the Output tab, you can view all returned query results.

The following table lists the output elements in the Output tab of the SharePoint Select ListItemactivity:


ResultCount Integer The number of results returned by the query.

NextPage String The value of the NextPage returned by Microsoft SharePoint forselecting the next page. If the number of the queried result is biggerthan the value defined in the Page Size field, the value of theNextPage output indicates the ID of the next list item. This input itemonly has a value when using the paging feature.

CAMLSource String The mode of the query.

Results

Item N/A The attributes of the queried item. It varies depending on differentcontent types. For the meaning of each attribute, see the MicrosoftSharePoint documentation for more details.

Fault

In the Fault tab, you can find the error code and error messages of the SharePoint Select ListItemactivity. See Error Codes for more detailed explanation of errors.

38


The following table lists error schema elements in the Fault tab of the SharePoint Select ListItemactivity:






msg String Displays the error message of the Microsoft SharePoint systemwhen processing a request from the plug-in.


encoding String Displays the error encoding of the Microsoft SharePoint systemwhen processing a request from the plug-in.

ActivityTimedOutException

msg String Displays the error message when the Select ListItem operationtimes out.

msgcode String Displays the error code when the Select ListItem operation timesout.

SharePoint QueryThe SharePoint Query activity supports querying list items across different Microsoft SharePoint listsand websites in a specific site collection.

Before you can use the SharePoint Query activity, a user with administrative privileges mustdeploy .NET Solutions on the Microsoft SharePoint server. See TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint Installation for details.

General

In the General tab, you can establish a connection to a Microsoft SharePoint server, and set the querycondition for the process.

The following table lists the configurations in the General tab of the SharePoint Query activity:


Name No (Required) Specify the name to be displayed as the label forthe activity in the process. The default value isSharePointQuery.

39






Query Scope No (Required) Specify the scope that the query operationcovers. The following options of the query scope areavailable:

● AllWebs: if this option is selected, the query operationcovers the current site collection.

● SubWebs: if this option is selected, the query operationonly covers a selected website and it is sub-website.



List Template No (Required) Choose a list to be used as the template togenerate the CAML query.

Click Fetch Lists to get available lists from the site selectedin the Web Name field.

CAML Source No (Required) Specify the query schema of CollaborativeApplication Markup Language (CAML). The followingoptions of the CMAL source are available:

● Simple CAML: if you select this option, the Containsand EQ queries are supported. After you provide valuesfor the input item in the Input tab, the activity uses thenon-empty values to do the searching.

If the input value is Text, Note, URL, Choice, or Multichoice data type, the query is generated as a Containsquery. Others are generated as an Eq query. See InputGuidelines for more details about these MicrosoftSharePoint data types.

● Input CAML: if this option is selected, inputting aCAML query directly in the CAMLText field in the Inputtab is supported. The root node of the query must beWhere.

40



Max Size Yes (Required) Specify the maximum numbers of list items thatare returned by the query. The default value is 2000.

If a large number of records that match the queryconditions display in the field, you can use thisproperty to limit the total numbers of list itemsthat are returned by the query.

Timeout(sec) Yes (Required) Specify how long the plug-in waits for theprocess to perform the query operation. The default value is120.

The query operation might fail or succeed if ittimes out when started at run time. The result isundefined. You have to provide enough time forthe query operation to perform.

Description

In the Description tab, you can enter a short description for the SharePoint Query activity.

Input

In the Input tab, you can specify the list item that you want to query.

The following table lists the input elements in the Input tab of the SharePoint Query activity:


FieldValues N/A The attributes of the selected item. It varies with different list types.See Input Guidelines for details about how to provide a valid input.

This field only is displayed when you select Simple CAML as theCAML source.

CAMLText String The CAML query. You can manually type in a query or you can usethe generated query from the previous activity in the currentprocess.

This field only is displayed when you select Input CAML as theCAML source.

The root node of the CAML query must be Where.

Output

In the Output tab, you can view all results that match the query condition.

The following table lists the output elements in the Output tab of the SharePoint Query activity:


ResultCount Integer The number of results returned by the query.

41



QueryScope String The scope that the query operation covers.

QueryMode String The mode of the query. The possible values are SimpleCAML andInputCAML.

Results—include all the items that match the query condition.

Item N/A The attributes of the queried item. It varies with different listtypes. For the meaning of each attribute, see the MicrosoftSharePoint documentation for more details.

Fault

In the Fault tab, you can find the error code and error messages of the SharePoint Query activity. See Error Codes for more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the SharePoint Query activity:









ActivityTimedOutException

msg String Displays the error message when the Query operation times out.

msgcode String Displays the error code when the Query operation times out.

Input GuidelinesWhen specifying a value for the list item attributes, you can follow certain input format guidelines toavoid an invalid input.

The following table lists all the data types in Microsoft SharePoint and its corresponding data types inthe plug-in. It also provides an example of the input format for each data type.

42


Data Type inMicrosoftSharePoint

Data Typein the Plug-in Description Example

Text String Specifies a single line of text. abc

Note String Specifies a field that can containmultiple lines of text.

abc

Number Double Specifies floating point numbers.Number (1, 1.0, 100).

123.1

Integer Integer Specifies an integer number. 123

Currency Double Specifies currency values formattedbased on a specific locale.

123.45

DateTime DateTime Specifies date and time values. 2013-01-16T16:44:20Z

Lookup String Specifies references to values inother lists.

1

Boolean Boolean Specifies Boolean values that arestored in the database as 1 or 0.

0

User String Specifies a user or group of aSharePoint site.

1

URL URL(DescriptionString)

Specifies hyperlinks. http://sharepoint.microsoft.com/en-us/Pages/default.aspx

Calculated String Specifies calculated values. abc

External Data Notsupported

N/A N/A

ManagedMetadata

Notsupported

N/A N/A

Choice String Specifies a predetermined set ofvalues that can be used to enterdata into the field.

choice

MultiChoice String Specifies multiple values per listitem.

choice1;#choice2;#

LookupMulti String Specifies multiple lookups. 1;#2;#3;#

AllDayEvent Boolean Specifies an all-day event. 0 or 1

Attachments Notsupported

N/A N/A

43


http://sharepoint.microsoft.com/en-us/Pages/default.aspx



Data Type inMicrosoftSharePoint

Data Typein the Plug-in Description Example

Computed String Specifies an abstract field type thatdepends on other fields for itscontent and definition.

abc

ContentTypeId String Specifies a content type ID. 0x0102

Counter Integer Specifies an integer used forinternal ID fields.

123

CrossProjectLink String Specifies a link between projects ina Meetings Workspace site.

1

File String Specifies files. abc.ext

GridChoice Notsupported

N/A N/A

Guid String Specifies GUIDs. 28c7d0fa-c3da-4b71-9eaf-471bc42edf47

MaxItems Integer Specifies the maximum number ofitems.

1000

ModStat Notsupported

N/A N/A

Recurrence Notsupported

N/A N/A

UserMulti String Specifies multiple users of aSharePoint site.

1;#name1;#2;#name2

44


SharePoint Notification Configuration Management Tool

The SharePoint Notification Configuration Management tool is used to configure JMS and destinationinformation, bind or unbind event handlers with Microsoft SharePoint lists.

SharePoint Notification Configuration Management Tool OverviewThe SharePoint Notification Configuration Management tool is deployed on the Microsoft SharePointserver when you install the .NET solution components packaged with the TIBCO ActiveMatrixBusinessWorks Plug-in for Microsoft SharePoint installer.

This tool is used to set up and manage event handler bindings, configure the JMS connection anddestination information, and set the notification types on the Microsoft SharePoint server. After theconfiguration, the SharePoint Notification Listener activity is triggered when the Microsoft SharePointoperations, such as adding, deleting, updating, and refreshing data occur on the Microsoft SharePointserver.

This tool includes the following tabs:

● JMS Configuration

● JMS Destination Configuration

● Event Handler Configuration

JMS ConfigurationIn the JMS Configuration tab, you can add, modify, or delete the JMS connection information. You canalso delete all the JMS configuration data.

The following table lists the GUI elements in the JMS Configuration tab:

45


GUIElement Description

Add Click this button to add a new JMS connection. After you click this button, the AddJMS Configuration Information window is displayed. See Adding JMS ConfigurationInformation for details about the description for each field.

Modify Click this button to update the existing JMS connection. After you click this button,the Modify JMS Configuration Information window is displayed. See Modifying JMSConfiguration Information for details about the description for each field.

You have to select an entry in the table before modifying the JMSconfiguration.

Delete Click this button to delete the existing JMS connection after you select the entry inthe table.

After you delete the JMS connection, the corresponding cascaded JMSdestination and registered event handler are all removed.

Purge All Click this button to purge all JMS configuration data by using the SharePointNotification Configuration Management tool.

Adding JMS Configuration Information

In the JMS Configuration tab, click Add to add a new JMS connection.

In the Add JMS Configuration Information window, you can configure the JMS connection information.After you complete the JMS connection configuration, the corresponding JMS and SSL configurationsare stored in the Microsoft SharePoint server.

The following table lists the GUI elements in the Add JMS Configuration Information window:

46


GUI Element Description

SharePoint WebApplication

(Required) Specify the web application.

All the web applications on Microsoft SharePoint Farm aredisplayed in this list.

SharePoint SiteCollection

(Required) Specify the site collection. If you select the Select All item, theconfigured JMS information are applied to all site collections in theselected web application.

JMS Server Connection Configuration

JMS Username (Required when authorization is enabled on the JMS server) Specify theuser name used to access the JMS server.

JMS Password (Required when authorization is enabled on the JMS server) Specify thepassword used to access the JMS server.

Client ID (Optional) Specify the client ID of the JMS connection. Each connectionmust use a unique client ID.

If the value specified in the Client ID field is already in use, anerror occurs when messages are triggered on the MicrosoftSharePoint server.

Auto-generated JMSClient ID

(Required) Specify whether you want to automatically generate a clientID for the connection to a JMS server. The automatically generated stringis in GUID format.

If this check box is not selected, the value specified in theClient ID field is used for the connection.

JMS Provider URL (Required) Specify the URL to the JMS service provider. The generalsyntax is protocol://hostname:port. To take TIBCO EnterpriseMessage Service as an example, the URL is tcp://localhost:7222.

Use JNDI forConnection Factory

(Required) Specify whether you want to use Java Naming and DirectoryInterface (JNDI) to query the factory object from the JMS server. Ifselected, you have to configure JNDI Context Factory, Topic ConnectionFactory, JNDI Context URL, Queue Connection Factory, JNDIUsername, and JNDI Password fields.

JNDI Configuration

JNDI Context Factory (Required for using JNDI) Specify the initial context factory class foraccessing JNDI. The default context factory for TIBCO EnterpriseMessage Service iscom.tibco.tibjms.naming.TibjmsInitialContextFactory.

Topic ConnectionFactory

(Required for using JNDI) Specify the topic connection factory used tocreate connections for publishing or subscribing messaging. The defaultvalue is TopicConnectionFactory.

47



JNDI Context URL (Required for using JNDI) Specify the URL to the JMS service provider.The general syntax is protocol://hostname: port. To take TIBCOEnterprise Message Service as an example, the URL is tibjmsnaming://localhost:7222.

Queue ConnectionFactory

(Required for using JNDI) Specify the queue connection factory used tocreate connections for point-to-point messaging. The default value isQueueConnectionFactory.

JNDI Username (Required for using JNDI when authorization is enabled on the JMSserver) Specify the user name used to access a JNDI server.

JNDI Password (Required for using JNDI when authorization is enabled on the JMSserver) Specify the password used to access a JNDI server.

Use SSL for JMS (Optional) Specify whether you want to use SSL to support clientauthentication for the JMS server. If selected, you have to configureTrusted Certificates Path, Identity File, Identity Password, and TargetHost Name fields.

SSL Configuration

See Configuring SSL for TIBCO Enterprise Message Service for details about how to use SSL.

Trusted CertificatesFiles

(Required for using SSL) Specify the full paths and names to thecertificates.

Click Add Certificates or Remove Certificates to add or remove thecertificates used to verify the identities of servers and clients. You canselect more than one certificate at a time.

Target Host Name (Required for using SSL) Specify the common name of the JMS servercertificate.

Identity File (Required for using two-way SSL authentication) Specify the full pathand name to the identity file. Click Browser to locate the identity files.

Identity Password (Required for using two-way SSL authentication) Specify the passwordused to access the identity file.

Save Click this button to save the JMS configuration.

Cancel Click this button to exit the JMS configuration.

Test JMS Connection Click this button to test whether the specified JMS configuration fieldsresult in a valid connection to the JMS server.

Modifying JMS Configuration Information

You can update the JMS information, and then click Modify to save the configuration. The fields in theModify JMS Configuration Information window are similar to the fields in the Add JMS ConfigurationInformation window. See Adding JMS Configuration Information for more details about the descriptionof each field.

48


JMS Destination ConfigurationIn the JMS Destination Configuration tab, you can specify the notification type, bind a JMS topic orqueue to one or more Microsoft SharePoint lists, and manage destinations.

Before configuring JMS destinations, you have to select one JMS connection entry in the JMSConfiguration tab.

The following table lists the GUI elements in the JMS Destination Configuration tab:



This field is not configurable. The value is taken from the JMSConfiguration tab.


This field is not configurable. The value is taken from the JMSConfiguration tab.

Web Name (Required) Specify the target website in the site collection.

List Name (Optional) Specify the list that you want to monitor.

If you do not specify a list, the destination name isautomatically added to all the lists in the selected website whenyou add a destination name.

Notification Type (Required) Specify the notification type. The following options of thenotification type are available:

● Event Handler: captures the events triggered in the monitoredMicrosoft SharePoint list.

● Refresh Data: refresh the data, generated from an external application,in a Microsoft SharePoint custom list representation.

49



Connection FactoryType

(Required) Specify the connection factory type. The following options ofthe connection factory type are available:

● Topic: it is used to create connections for publishing or subscribingmessaging when the SharePoint Notification Listener activitycommunicates with the JMS server.

● Queue: it is used to create connections for point-to-point messagingwhen the SharePoint Notification Listener activity communicates withthe JMS server.

Add Click this button to name the destination. After you click this button, theAdd JMS Destination Name window is displayed. You can set the topic orqueue destination in the Destination Name field, and then save theconfiguration.

Modify Click this button to update the destination and the connection factorytype. After you click this button, the Modify JMS Destination Namewindow is displayed. Then, you can modify the connection factory typeand the destination, and then save the configuration.

You have to select an entry in the table under this button before modifyingthe destination.

Each list supports either the topic or the queue connectionfactory type. You cannot add a topic and a queue connectionfactory type to a list at a time.

Delete Click this button to delete existing JMS destinations.

You have to select one or multiple entries in the table under thisbutton before deleting destinations. You can also select all theentries by clicking Select All.

Select All Click this button to select all the entries in the table under this button.

Select None Click this button to deselect all the entries in the table under this button.

Event Handler ConfigurationIn the Event Handler Configuration tab, you can bind or unbind the event handler with one or moreMicrosoft SharePoint lists.

Before configuring event handlers, you have to select one JMS connection entry in the JMSConfiguration tab.

50


The following table lists the GUI elements in the Event Handler Configuration tab:



This field is not configurable. The value is taken from the JMS Configurationtab.


This field is not configurable. The value is taken from the JMS Configurationtab.

Web Name (Required) Specify the target website in the site collection.

List Name (Required) Specify the list that you want to monitor.

Event Type (Required) Specify the event type. The following options of the event typeare available:

● Select All: the event handler is triggered when any events occur on thelist you have specified.

● ItemAdded: the event handler is triggered when a new list item is addedto the list you have specified.

● ItemUpdated: the event handler is triggered when an existing list item isupdated from the list you have specified.

● ItemDeleting: the event handler is triggered when an existing list item isabout to be deleted from the list you have specified.

● ItemDeleted: the event handler is triggered when an existing list item isdeleted from the list you have specified.

Register Click this button to bind the event handler to the selected lists. If you selectthe Select All item in the List Name list, the event handlers are bound to allthe lists after clicking this button.

Unregister Click this button to unbind the event handler from the selected lists. If youselect the Select All item from the List Name list, and check all the entriesfrom the table, the event handlers are unbound from all the lists after clickingthis button.

51


Configuring SSL for TIBCO Enterprise Message Service

SSL is a protocol that provides secure authentication and transmits encrypted data over the Internet oran internal network. The plug-in supports using SSL to secure the data exchange between the plug-inand an Microsoft SharePoint server.

TIBCO Enterprise Message Service is used to publish data from the Microsoft SharePoint server toplug-in. If you want to use an SSL connection for TIBCO Enterprise Message Service, you have toperform the following tasks:

1. Configuring SSL on the TIBCO Enterprise Message Service Server

2. Configuring SSL on the Microsoft SharePoint Server

3. Configuring SSL for the SharePoint Notification Listener Activity in the Plug-in

Configuring SSL on the TIBCO Enterprise Message Service ServerTo enable SSL, each instance of tibemsd must have a digital certificate and a private key. The server canoptionally require a certificate chain or trusted certificate.

You can set the SSL server parameters in the tibemsd.conf file on the TIBCO Enterprise Service server.An example of the tibemsd.conf file is located in the TIBCO_HOME\ems\version_number orTIBCO_HOME\ems\version_number\bin directory.

Procedure

1. Go to the TIBCO_HOME\ems\version_number directory, and open the tibemsd.conf file with a texteditor.

2. Set the server to listen to SSL connections from clients by using the listen parameter. For example:listen = ssl://7243.

This port number must be consistent with the SSL Connection Factory URL set in thefactories.conf configuration file.

3. Set the ssl_server_identity, ssl_server_key, and ssl_password parameters to specify thedigital certificate of the server, private key and the password for the private key.

ssl_server_identity = C:\tibco\ems\8.2\samples\certs\server.cert.pem

ssl_server_key = C:\tibco\ems\8.2\samples\certs\server.key.pem

ssl_password = password

ssl_server_trusted =C:\tibco\ems\8.2\samples\certs\client_root.cert.pem

Leave other parameters as defaults, and then restart the TIBCO Enterprise MessageService server after you configure the previous parameters.

4. On a command line, navigate to the TIBCO_HOME\ems\version_number directory.

5. Enter the tibemsd –config tibems.conf command or directly enter the tibemsd command onthe command line to start SSL for the server.

52


See TIBCO Enterprise Message Service User’s Guide for details about how to configure SSL in aTIBCO Enterprise Message Service server.

If the SSL listerner port is modified in the tibemsd.conf file, you must configure thefactories.conf file to keep them consistent when you use JNDI and SSL.

For example:[SSLQueueConnectionFactory]

type = queue

url = ssl://7243

ssl_verify_host = disabled

ssl_trusted = C:\tibco\ems\8.2\samples\certs\server_root.cert.pem

ssl_expected_hostname = server

ssl_identity = C:\tibco\ems\8.2\samples\certs\client_identity.p12

[SSLTopicConnectionFactory]

type = topic

url = ssl://7243

ssl_verify_host = disabled

ssl_trusted = C:\tibco\ems\8.2\samples\certs\server_root.cert.pem

ssl_expected_hostname = server

ssl_identity = C:\tibco\ems\8.2\samples\certs\client_identity.p12

Configuring SSL on the Microsoft SharePoint ServerTo use an SSL connection, you have to enable SSL to an existing JMS connection by using theSharePoint Notification Configuration Management tool after configuring a TIBCO Enterprise MessageService server.

Prerequisites

Before configuring SSL on the Microsoft SharePoint server, you have to configure SSL on the TIBCOEnterprise Message Service server.

Procedure

1. If you use a self-signed certificate in your environment, you have to import the JMS server rootcertificate to the trusted root certification authorities.

2. Start the SharePoint Notification Configuration Management tool.

3. In the JMS Configuration tab, select one JMS connection entry and click Modify.

4. In the Modify JMS Configuration Information window, select the Use SSL for JMS check box.

5. Click Add Certificates to locate the trusted certificates files and specify the target host name to useone-way SSL authentication.

If you want to use two-way SSL authentication, you have to also provide the identity fileand identity password.

6. Click Save to save the configuration.

53


Configuring SSL for the SharePoint Notification Listener Activity in thePlug-in

You can configure SSL settings for the SharePoint Notification Listener activity in the plug-in to securethe data exchange.

Prerequisites

Before configuring SSL for the SharePoint Notification Listener Activity, you have to configure SSL onthe TIBCO Enterprise Message Service server.

TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint supports both one-way and two-way SSL authentication:

● In one-way SSL authentication mode, the client verifies the identity of the server.

● In two-way SSL authentication mode, the client verifies the identity of the server and passes itsidentity to the connected server. The connected server then validates the identity of the client.

Procedure

1. Start TIBCO Business Studio.

2. Open the project that you have created.

If no project exists, see Creating a Project for details about how to create a new project.

3. Select a SharePoint Connection shared resource that you have created.

4. Enter the URL in the SharePoint SiteCollection field.For example: https://192.168.80.253:8443/sites/doc or http://192.168.80.253:8443/sites/doc

5. Select the Use SSL for JMS check box in the Shared Connection Configuration tab to enable SSL.

6. Locate the trusted certificates files and specify the target host name to use one-way SSLauthentication in the SSL Configuration field.

If you want to use the two-way SSL authentication, you have to also provide the identityfile and identity password.

7. Select the SharePoint Notification Listener activity that you have created. In the General tab, selectthe shared resource in the SharePoint Connection field.

8. Save the project.

54


Working with the Sample Project

TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint packages a sample project withthe installer. The sample project shows how the plug-in works.

After installing the plug-in, you can locate the sample project in the TIBCO_HOME/bw/palettes/sharePoint/version_number/samples directory.

This sample project contains the following processes:

● Add_Select_Update_Delete_Document.bwp

The process shows how to use TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePointto add, select, update, and delete a document item from the Microsoft SharePoint SharedDocuments library.

● Add_Update_Query_Delete_Link.bwp

The process shows how to use TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePointto add, update, query, and delete an item from the Microsoft SharePoint Links list.

● EventHandler.bwp

The process shows how to use TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePointto listen to and respond to the ItemDeleting event triggered when an existing document item is to bedeleted from the Microsoft SharePoint Documents Library.

● RefreshData.bwp

The process shows how to use TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePointto refresh items in the Microsoft SharePoint Custom list.

Importing the Sample ProjectBefore running the project, you must import the sample 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 dialog, 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 locate the sample project. Click Finish.The sample project is located in the TIBCO_HOME/bw/palettes/sharepoint/version_number/samples directory.

Result

The sample project is imported to TIBCO Business Studio.

55


Running the ProjectYou can run the sample project to see how TIBCO ActiveMatrix BusinessWorks Plug-in for MicrosoftSharePoint works.

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 the Resource folder, and then expand the example sharedresource.

2. Double-click SharePoint-Shared-Connection.sharepointconnectionResource to edit the SharePointconnection, and then click Test SharePoint Connection to validate your connection.

3. After successfully connecting to the Microsoft SharePoint server, you have to get metadata from theserver.See Getting Metadata from the Microsoft SharePoint Server for more details about how to getmetadata from the server.

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

5. By default, all the processes are listed in the Components editor. In the Components editor, select

the process that you do not want to run and click .

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

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

8. In the Run Configurations dialog, expand BusinessWorks Application , and click BWApplication.

9. In the right panel, click the Applications tab, select the check box next to Example.application.

10. Click Run to run the process.

11. Click the icon to stop the process.

56


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

Trace Includes all the information regarding the running process.

If the Trace log level is selected, logs in all the levels, Error, Warn,Info, Debug, and Trace are captured.

Debug Indicates a developer-defined tracing message.

If the Debug log level is selected, logs in the Error, Warn, Info, andDebug levels are captured.

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.

If the Info log level is selected, logs in the Error, Warn, and Info levelscan be captured.

Warn Indicates that an abnormal condition occurred. Processing continues, but forbest practice, you can contact the administrator to investigate it.

If the Warn log level is selected, logs in the Error and Warn levels arecaptured.

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.

If the Error log level is selected, logs only in the Error level arecaptured.

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.

57


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.sharepoint.runtime"> <level value="DEBUG"/></logger>

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

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 tospecify a log level for an activity:<logger name="com.tibco.bw.palette.sharepoint.runtime.ActivityNameActivity"> <level value="DEBUG"/></logger>

For example, add the following node to set the log level of the each activity to Debug:<logger name="com.tibco.bw.palette.sharepoint.runtime.AddListItemActivity"> <level value="DEBUG"/></logger><logger name="com.tibco.bw.palette.sharepoint.runtime.DeleteListItemActivity"> <level value="DEBUG"/></logger><logger name="com.tibco.bw.palette.sharepoint.runtime.SelectListItemActivity"> <level value="DEBUG"/></logger><logger name="com.tibco.bw.palette.sharepoint.runtime.UpdateListItemActivity"> <level value="DEBUG"/></logger><logger name="com.tibco.bw.palette.sharepoint.runtime.SharePointQueryActivity"> <level value="DEBUG"/></logger><logger name="com.tibco.bw.palette.sharepoint.runtime.NotificationListenerEventSource"> <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-sharepoint.log</file> <encoder>

58


<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.

59


Error Codes

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

Error Code and ErrorMessage Role Category Description Solution

BW-SharePoint-505000

Activity input

error: {0}.

errorRole BW-Plug-in

An error occurs whenrunning an activity if anerror is displayed in theInput tab.

Check errors listedin the error messageand takeappropriate actions.


Remote Error: {0}.


An error might occurwhen calling a remotemethod.



Unknown Error: {0}.


An unknown error. Check errors listedin the error messageand takeappropriate actions.


Activity ran into

failure: {0}.


An error occurs whenthe plug-in activity runsinto failure.



Input data

validation error:

{0}.


An error occurs whenyou type an invalidinput for the plug-inactivity.

Correct the inputdata according tothe error message.


Unsupported

Encoding.


An error occurs whenan unsupportedencoding is in use.



Read Template

Error:{0}.


An error occurs whenthe SharePoint AddListItem activity isparsing a document orWiki page template.



Create form has

error: {0}.


An error occurs whencreating a SPForminstance.


60




Stop Listener

encounter error:

{0}.


An error occurs whenthe SharePointNotification Listeneractivity stops listeningto a JMS Queue orTopic.



Please select the

SharePoint Shared

Connection for {0}.


An error occurs whenrunning an activitywithout selecting aSharePoint Connectionshared resource.

Click the iconin the General tabto select aSharePointConnection sharedresource. If noSharePointConnection sharedresource matches,create one.


The invocation to

the server has

timeout,the

configured timeout

value is {0} ms.


An error occurs whenthe invocation to theMicrosoft SharePointserver times out.

Check whether thenetwork is in agood condition, orprovide anappropriate timeoutvalue.


Please select the

Web Name for {0}.


An error occurs whenrunning an activitywith the Web Namefield in the General tabunspecified.

Click Fetch Webs toget available sitesfrom the sitecollection specifiedin the SharePointConnection sharedresource.


Please select the

List Name for {0}.


An error occurs whenrunning an activitywith the List Namefield in the General tabunspecified.

Specify a list namefor the activity.


Please select the

Content Type Name

for {0}.


An error occurs whenrunning an activitywith the Content Typefield in the General tabunspecified.

Specify a contenttype for the activity.

61




JMS error. Please

check JMS

configuration.error

detail: {0}.


An error occurs whenthe plug-in activity triesto connect to the JMSserver if the JMSconfigurationinformation in theSharePoint Connectionshared resource is notcorrectly specified.

Check whether theJMS configurationinformationspecified in theSharePointConnection sharedresource are correct.


Can't find

connection to

server, Please

check the

configuration.


An error occurs whenthe plug-in activity triesto connect to theMicrosoft SharePointserver if the MicrosoftSharePoint serverconfigurationinformation in theSharePoint Connectionshared resource is notcorrectly specified.

Check whether theconfigurationinformation toconnect to theMicrosoftSharePoint serverspecified in theSharePointConnection sharedresource is correct.


Please select the

connection factory

Type.


An error occurs whenrunning the SharePointNotification Listeneractivity with theConnection FactoryType field unspecifiedin the General tab.

Specify aconnection factorytype for theSharePointNotificationListener activity.


Please input

durable topic

subscriber name.


An error occurs whenrunning the SharePointNotification Listeneractivity with theDurable Subscriptioncheck box selected andthe Durable Name fieldunspecified in theGeneral.

Specify a durablename for theSharePointNotificationListener activity.


Can't get the JMS

message text.


An error occurs whenthe plug-in activitycannot get the JMSmessages from the JMSserver.



The configured

timeout value for

activity [{0}] can

not be 0!


An error occurs whenrunning an activitywith the value of theTimeout(sec) field is setto 0 in the General tab.

Specify anappropriate timeoutvalue for theactivity.

62




Please select query

Type for {0}.


An error occurs whenrunning the SharePointSelect ListItem orSharePoint Queryactivity with the CAMLSource field in theGeneral tabunspecified.

Specify a CAMLsource for theSharePoint SelectListItem or Queryactivity.

BW-SharePoint- 505021

File Check in

failed with

exception: {0}.


An error occurs whenuploading a documentitem to a MicrosoftSharePoint documentlibrary.



Error happens when

deserializing

output of activity

{0}.


An error occurs whenbuilding output data foran activity.



Exception happens:

\n{0}.


An error occurs whenan exception is thrownby this activity.


BW-SharePoint- 505024

Failed to

authenticate,

please confirm your

User Name,Password

and Permission!


An authentication erroroccurs when the plug-inactivity fails toauthenticate against therun time user name andpassword.

Check whether theuser name andpassword which areused to log in theMicrosoftSharePoint serverare correctlyspecified in theSharePointConnection sharedresource.


Can not connect to

SharePoint Server,

error message:{0}.


An error occurs whenthe connection to theMicrosoft SharePointserver is broken down.

Check whether theMicrosoftSharePoint server isavailable or the IPaddress to connectthe MicrosoftSharePoint server isspecified correctly.

63




Failed to {0}

SharePoint JMS

Connection resource

[{1}].


An error occurs whenthe connection to theJMS server is brokendown.

Check whether theJMS server isavailable or the JMSconfigurationinformationspecified in theSharePointConnection sharedresource is correct.


Failed to Fetch

List: {0}, error

message: {1}


An error occurs whenan activity tries to fetcha specified list from theMicrosoft SharePointserver at run time.



Creating Shared

Resource {0}

failed.


An error occurs whencreating a SharePointConnection sharedresource.



Decrypt {0} has

exception: {1}


An error occurs whendecrypting a passwordin the SharePointConnection sharedresource.


64
