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

TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint User's Guide
TIBCO ActiveMatrix BusinessWorks™ Plug-in
for Microsoft SharePoint
User's Guide
Software Release 6.1
January 2016
Two-Second Advantage®
2
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH
EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY
(OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE
EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY
OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND
CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED
SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE
CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD
OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE)
OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER
LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE
SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND
YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE
BOUND BY THE SAME.
This document contains confidential information that is subject to U.S. and international copyright laws
and treaties. No part of this document may be reproduced in any form without the written
authorization of TIBCO Software Inc.
TIBCO, Two-Second Advantage, TIBCO ActiveMatrix BusinessWorks, TIBCO ActiveMatrix
BusinessWorks Plug-in for Microsoft SharePoint, TIBCO Business Studio, and TIBCO Enterprise
Administrator are either registered trademarks or trademarks of TIBCO Software Inc. in the United
States and/or other countries.
Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform Enterprise
Edition (J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks of
Oracle Corporation in the U.S. and other countries.
All other product and company names and marks mentioned in this document are the property of their
respective owners and are mentioned for identification purposes only.
THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT
ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED
AT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE
VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.
THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL
ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE
CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO
SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S)
AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.
THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR
INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE,
INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.
Copyright © 2013-2016 TIBCO Software Inc. All rights reserved.
TIBCO Software Inc. Confidential Information
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
3
Contents
TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4
Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Creating a SharePoint Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Getting Metadata from the Microsoft SharePoint Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Configuring a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Testing a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Deploying an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
TIBCO Business Studio Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
SharePoint Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
SharePoint Get Metadata Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
SharePoint Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
SharePoint Notification Listener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
SharePoint Add ListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
SharePoint Update ListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
SharePoint Delete ListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
SharePoint Select ListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
SharePoint Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Input Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
SharePoint Notification Configuration Management Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44
SharePoint Notification Configuration Management Tool Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
JMS Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
JMS Destination Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Event Handler Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Configuring SSL for TIBCO Enterprise Message Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Configuring SSL on the TIBCO Enterprise Message Service Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Configuring SSL on the Microsoft SharePoint Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Configuring SSL for the SharePoint Notification Listener Activity in the Plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Working with the Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Importing the Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Running the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Managing Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Setting Up Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Exporting Logs to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
4
TIBCO Documentation and Support Services
Documentation for this and other TIBCO products is available on the TIBCO Documentation site. This
site is updated more frequently than any documentation that might be included with the product. To
ensure that you are accessing the latest available help topics, please visit:
https://docs.tibco.com
Product-Specific Documentation
Documentation for TIBCO products is not bundled with the software. Instead, it is available on the
TIBCO Documentation site. To directly access documentation for this product, double-click the
following 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_HOME
is /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 TIBCO
Documentation 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 can
request one.
How to Join TIBCOmmunity
TIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts. It is a
place to share and access the collective experience of the TIBCO community. TIBCOmmunity offers
forums, blogs, and access to a variety of resources. To register, go to the following web address:
https://www.tibcommunity.com
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
5
Product Overview
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint plugs into TIBCO ActiveMatrix
BusinessWorks™. You can use the plug-in to add, delete, update, and query data in the Microsoft
SharePoint 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 variety
of technologies and systems within enterprise and on cloud. TIBCO ActiveMatrix BusinessWorks
includes an Eclipse-based graphical user interface (GUI) provided by TIBCO Business Studio™ for
design, testing, and deployment. If you are not familiar with TIBCO ActiveMatrix BusinessWorks, see
the TIBCO ActiveMatrix BusinessWorks documentation for more details.
TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint plugs into TIBCO ActiveMatrix
BusinessWorks and adds a SharePoint palette to TIBCO Business Studio. You can create a connection
between the plug-in and Microsoft SharePoint server, and then configure a process using the activities
in the SharePoint palette to manage and query data in the Microsoft SharePoint server, and publish
events 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 communicates
with 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 the
Microsoft SharePoint server, the plug-in communicates with the Microsoft SharePoint server through
web services over HTTP or HTTPS.
When the plug-in listens to events occurring in the Microsoft SharePoint server, the plug-in
communicates with the Microsoft SharePoint server through the JMS server. The plug-in and Microsoft
SharePoint server support using JNDI or SSL to communicate with the JMS server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
6
Only the SharePoint Notification Listener activity depends on JMS to transfer messages between the
plug-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 and
different 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 the
Microsoft SharePoint server, such as added, updated, deleted, or deleting a list item. You can also
use the activity to work with other activities to fetch data and populate the custom list with the data
from an external source.
●
You can use the SharePoint Add ListItem, SharePoint Delete ListItem, and SharePoint Update
ListItem activities to add, delete, and update list items in the Microsoft SharePoint servers. These
activities also support batch operations, which mean that you can manage multiple list items at a
time. Additionally, you can manage list items across Microsoft SharePoint sites on the condition that
each 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 the
Microsoft SharePoint server through the SharePoint Select ListItem activity.
●
You can use the SharePoint Query activity to query list items across different Microsoft SharePoint
lists and websites in a specific site collection.
●
The SharePoint Notification Configuration Management tool is used to support the SharePoint
Notification Listener activity. The tool is deployed on the Microsoft SharePoint server after you
install the .NET solution components packaged within the TIBCO ActiveMatrix BusinessWorks
Plug-in for Microsoft SharePoint installer. You can use the SharePoint Notification Configuration
Management tool to configure JMS and destination information, set notification types, configure
event handlers, and refresh data information.
TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint has four installation types: All
Plugin Components, Runtime, SharePoint 2010 Server Installation, and SharePoint 2013 Server
Installation. See TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint Installation for
details.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
7
Getting Started
This tutorial is designed for the beginners who want to use TIBCO ActiveMatrix BusinessWorks Plugin for Microsoft SharePoint in TIBCO Business Studio.
All the operations are performed in TIBCO Business Studio. See TIBCO Business Studio Overview to
get familiar with TIBCO Business Studio.
A basic procedure of using TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint
includes:
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 Project
The first task using the plug-in is creating a project. After creating a project, you can add resources and
processes.
An Eclipse project is an application module configured for TIBCO ActiveMatrix BusinessWorks. An
application module is the smallest unit of resources that is named, versioned, and packaged as part of
an application.
Procedure
1. Start TIBCO Business Studio using one of the following ways:
●
Microsoft Windows: click Start > All Programs > TIBCO > TIBCO_HOME > TIBCO Business
Studio 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 Resource
wizard.
3. In the "Select a wizard" dialog, click BusinessWorks Application Module and click Next to open
the 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 Browse
to 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.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
8
Result
The project with the specified settings is displayed in the Project Explorer view.
Creating a SharePoint Connection
After creating a project, you can add a SharePoint Connection shared resource to create a connection
between the plug-in and Microsoft SharePoint server.
Prerequisites
The SharePoint Connection shared resource is available at the Resources level. Ensure that you have
created 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 SharePoint
Connection wizard.
3. The resource folder, package name, and resource name of the SharePoint connection are provided
by default. If you do not want to use the default configurations, change them accordingly. Click
Finish to open the sharepointconnection Editor.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
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 valid
connection to the Microsoft SharePoint server using the runtime and design-time credentials.
6. Optional: Click Get JMS Configuration to retrieve JMS configuration information from the
Microsoft SharePoint server if you have configured the JMS configuration information using the
SharePoint Notification Configuration Management tool, which is installed on the Microsoft
SharePoint server.
7. Optional: Click Test JMS Connection to test whether the specified configuration fields result in a
valid connection to the JMS server.
Getting Metadata from the Microsoft SharePoint Server
The 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 resource
when getting the metadata. Before getting the metadata from the Microsoft SharePoint server, you have
to 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 > Get
Metadata.
The Get Metadata window is displayed.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
10
2. Click Browse in the Get Metadata window, and select a SharePoint connection in the Select
SharePoint 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 Process
After creating a project, an empty process is created. You can add activities to the empty process to
complete a task. For example, add a document item from the Microsoft SharePoint Shared Documents
library.
Prerequisites
Ensure that you have created an empty process when creating a project. See Creating a Project for more
details.
Procedure
1. In the Project Explorer view, click the created project and open the empty process from the
Processes 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 the
SharePoint Add ListItem activity from the SharePoint palette.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
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 SharePoint
connection.
5. Click File > Save to save the project.
Testing a Process
After 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. Ensure
that 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 in
the Console view.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
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 activity
output.
Deploying an Application
After testing, if the configured process works as expected, you can deploy the application that contains
the configured process into a runtime environment, and then use the bwadmin utility to manage the
deployed application.
Before deploying an application, you must generate an application archive, which is an enterprise
archive (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 an
application.
TIBCO Business Studio Overview
TIBCO Business Studio is an Eclipse-based integration development environment that is used to
design, develop, and test ActiveMatrix BusinessWorks applications.
TIBCO Business Studio provides a workbench in which you can create, manage, and navigate resources
in your workspace. A workspace is the central location on your machine where all data files are stored.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
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
Disable Business Studio Capabilities
, Save
, Enable/
, 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 the
perspective from the menu Window > Open Perspective > Perspective_Name.
4. View: displays resources. For example, the Project Explorer view displays the ActiveMatrix
BusinessWorks applications, modules, and other resources in your workspace, and the Properties
view 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 view
to open the appropriate editor for the selected resource. For example, double-click an ActiveMatrix
BusinessWorks process (MortgageAppConsumer.bwp) in the Project Explorer view to open the
process in the editor.
6. Palette: contains a set of widgets and a palette library. A palette groups activities that perform
similar tasks, and provides quick access to activities when configuring a process.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
14
SharePoint Connection
The SharePoint Connection shared resource contains all necessary parameters to establish connections
among 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 the
plug-in.
General
In the General panel, you can specify the package that stores the SharePoint Connection shared
resource and the shared resource name.
The following table lists the configurations in the General panel of the SharePoint Connection shared
resource:
Field
Module
Property?
Package
No
(Optional) The name of the package where the new
shared resource is added.
Name
No
(Required) The name to be displayed as the label for the
SharePoint shared resource in the process.
Description
No
(Optional) A short description for this shared resource.
Description
Shared Connection Configuration
In the Shared Connection Configuration panel, you can provide the information of the Microsoft
SharePoint server that the plug-in connects to.
The following table lists the configurations in the Shared Connection Configuration panel of the
SharePoint Connection shared resource:
Field
Module
Property
?
Description
SharePoint Server Connection Configuration
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
15
Field
SharePoint
SiteCollection
Module
Property
?
Yes
Description
(Required) The URL of the SharePoint site collection that you want
to access. It is the top-level website.
The address format must be consistent with the one set on the
Microsoft SharePoint server. For example, if the public URL set on
the Microsoft SharePoint server is an IP address, the value on the
SharePoint Website Address must use an IP address.
The plug-in supports HTTPS communication between
TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft
SharePoint and Microsoft SharePoint server. If you want
to use HTTPS, you have to configure IIS for the Microsoft
SharePoint server to support HTTP over SSL, and then
type the HTTPS URL in this field. For example: https://
host_name:Https_Port_Number.
The plug-in automatically selects HTTP or HTTPS based
on the prefix of the URL, such as http and https during
run time and design time.
Authentication
Method
No
(Required) The supported Windows authentication methods that are
used to validate the credentials of connecting users.
The plug-in supports BASIC, NTLM, and KERBEROS
authentication methods in Claims-Based Authentication for
Microsoft SharePoint 2010/2013. The plug-in supports BASIC,
NTLM, and KERBEROS authentication methods in Classic Mode
Authentication for Microsoft SharePoint 2010.
After you set the authentication method on the Microsoft
SharePoint server in the central administration website,
you can select the corresponding authentication method in
the plug-in.
Kerberos
KRB5
Configuration
File
No
Kerberos
Login
Configuration
File
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 configuration
information, 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, and
mappings of hostnames onto Kerberos realms.
(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 login
properties in Java Authentication Authorization Service (JAAS).
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
16
Field
Runtime
Username
Module
Property
?
Yes
Description
(Required) The runtime user name that the plug-in activities can use
to authenticate against and run.
If you have a domain account, you must provide the domain name
in this field. The format is domainName\username. If not, you can
directly enter your user name.
Runtime
Password
Yes
(Required) The runtime password that the plug-in activities can use
to authenticate against and run.
Design-time
Username
Yes
(Required) The design-time user name that is used when getting
metadata by using the SharePoint Get Metadata tool, and to retrieve
a Destination topic in the SharePoint Notification Listener activity.
If you have a domain account, you must provide the domain name
in this field. The format is domainName\username. If not, you can
directly enter your user name.
Design-time
Password
Yes
(Required) The design-time password that is used when getting
metadata by using the SharePoint Get Metadata tool, and to retrieve
a 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.
Autogenerated JMS
Client ID
No
(Required) Whether you want to automatically generate a client ID
for the connection to a JMS server. The automatically generated
string is in GUID format.
If this check box is not selected, the value specified in the Client ID
field is used for the connection.
Client ID
Yes
(Optional) The client ID of the JMS connection. Each connection
must use a unique client ID.
See documentation of your JMS provider for more information about
client IDs.
If the value specified in the Client ID field is already in
use, an error occurs when messages are triggered on the
Microsoft SharePoint server.
Use JNDI for
Connection
Factory
No
(Optional) Whether you want to use JNDI (Java Naming and
Directory Interface) to query the factory object from the JMS server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
17
Field
JMS Provider
URL
Module
Property
?
Yes
Description
(Required) The URL to JMS service provider. The general syntax is
To take TIBCO Enterprise Message
Service™ as an example, the URL is tcp://localhost:7222.
protocol://hostname:port.
JNDI Configuration
The JNDI Context Factory, JNDI Context URL, Topic Connection Factory, Queue Connection
Factory, JNDI Username, and JNDI Password fields are displayed after you select the Use JNDI for
Connection Factory check box.
JNDI Context
Factory
No
(Required for using JNDI) The initial context factory class for
accessing JNDI. The default context factory for TIBCO Enterprise
Message Service is
com.tibco.tibjms.naming.TibjmsInitialContextFactory.
JNDI Context
URL
Yes
(Required for using JNDI) The URL to the JMS service provider. The
general syntax is protocol://hostname:port. To take TIBCO
Enterprise Message Service as an example, the URL is
tibjmsnaming://localhost:7222.
Topic
Connection
Factory
Yes
(Required for using JNDI) The topic connection factory used to
create connections for publishing or subscribing messaging. The
default value is TopicConnectionFactory.
Queue
Connection
Factory
Yes
(Required for using JNDI) The queue connection factory used to
create connections for point-to-point messaging. The default value is
QueueConnectionFactory.
JNDI
Username
Yes
(Required for using JNDI if authorization is enabled on the JMS
server.) The user name used to access the JMS server.
JNDI
Password
Yes
(Required for using JNDI if authorization is enabled on the JMS
server.) The password used to access the JMS server.
Connection
Factory SSL
Password
Yes
(Required for using Secure Sockets Layer (SSL)) The password used
to access the JMS server.
Use SSL for
JMS
No
(Optional) Whether you want to use SSL to support client
authentication 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.
Trusted
Certificates
Path
No
(Required for using SSL) The path of the certificates where the
certificates are available.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
18
Field
Module
Property
?
Description
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 have
to provide the identity file and identity password.
●
If you want to use two-way SSL authentication, you have to
provide the identity file and identity password.
Identity
Password
Yes
The password used to access the identity file.
Target Host
Name
Yes
(Optional for using SSL) The common name of the JMS server
certificate. If you type a value in this field, the plug-in can verify the
target host name.
Test SharePoint Connection
You can click Test SharePoint Connection to test whether the specified configuration fields result in a
valid 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 Microsoft
SharePoint server automatically if you have configured the JMS configuration information by using the
SharePoint Notification Configuration Management tool, which is installed on the Microsoft SharePoint
server. 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 check
box to generate a client ID.
●
JMS Password, JNDI Password, Connection Factory SSL Password,
To protect the privacy of users, you have to type the values manually.
●
and Identity
Password.
and Identity File. The values of these two parameters might be
different from those on the Microsoft SharePoint server. You have to type the values manually.
Trusted Certificates Path
Test JMS Connection
You can click Test JMS Connection to test whether the specified configuration fields result in a valid
connection to the JMS server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
19
SharePoint Get Metadata Tool
The SharePoint Get Metadata tool is deployed on your machine after installing TIBCO ActiveMatrix
BusinessWorks Plug-in for Microsoft SharePoint. It is used to get metadata from the Microsoft
SharePoint server.
The length of the web name, list name, and content type name defined in Microsoft SharePoint must be
less than 200 characters. If not, an error occurs when getting metadata from the Microsoft SharePoint
server.
The SharePoint Get Metadata tool window contains the following configurations:
Field
Description
SharePoint
Connection
(Required) Specify a SharePoint Connection shared resource.
Web Name
(Required) Specify the site where metadata is saved.
Click Browse to locate the SharePoint Connection shared resources.
Click Get Web to get all the available sites from the site collection which has
been 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.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
20
SharePoint Palette
A palette groups the activities that connect the same external applications together. A SharePoint
palette is added after installing TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint.
The SharePoint palette contains the following activities to manage Microsoft SharePoint entries and
monitor a connected Microsoft SharePoint server:
●
SharePoint Notification Listener
●
SharePoint Add ListItem
●
SharePoint Update ListItem
●
SharePoint Delete ListItem
●
SharePoint Select ListItem
●
SharePoint Query
SharePoint Notification Listener
The SharePoint Notification Listener activity not only supports listening to the events occurring on the
Microsoft SharePoint server but also refreshing data from an external enterprise system in a custom list.
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 list
item.
To enable this function, you must use the SharePoint Notification Configuration Management tool
to bind the selected list to the event handler first. See SharePoint Notification Configuration
Management Tool for more details.
When an add operation is triggered in the Microsoft SharePoint Picture library and Wiki
Page library, or when you use the SharePoint Add ListItem activity to add the same list
item to the Microsoft SharePoint Document list, the SharePoint Notification Listener
activity can be triggered more than once.
●
Refresh Data: The activity is triggered by clicking the TIBCO Refresh Data custom web part that is
inserted into a custom Microsoft SharePoint list. After successfully installing the custom web part
solution on the Microsoft SharePoint server and inserting the custom web part into a custom
Microsoft SharePoint list, the Refresh Data From External Application button is displayed on the
web page that renders the custom list. You can use the activity to work with other activities, such as
Request-Response Service of TIBCO ActiveMatrix® Adapter for Siebel, to fetch data and populate
the custom list with the data from an external source.
To enable this function, you must use the SharePoint Notification Configuration Management tool
to bind custom lists with the Refresh Data notification type, set the destination information and
deploy the 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 use
the TIBCORefreshData custom web part, the Refresh Data From External Application
button is disabled. To use this web part and fetch the data from an external application,
you must have read/write access privileges.
General
In the General tab, you can establish a connection to a Microsoft SharePoint server and specify the list
item that you want to listen to.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
21
The following table lists the configurations in the General tab of the SharePoint Notification Listener
activity:
Field
Module
Property?
Name
No
SharePoint
Connection
Yes
Description
(Required) Specify the name to be displayed as the label for the
activity in the process. The default value is
SharePointNotificationListener.
(Required) Click the
icon to select a SharePoint Connection
shared resource. The SharePoint Connection shared resource
creates a connection between the plug-in and a Microsoft
SharePoint server.
If no matching SharePoint Connection shared resources are found,
click Create Shared Resource to create one. See Creating a
SharePoint Connection for more details.
Web Name
No
(Required) Get the target website.
Click Fetch Webs to get available websites from the site collection
specified 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 in
the Web Name field.
Notification
Type
No
(Required) Get the notification type. The following options of the
notification type are available:
●
Event Handler: it can be used to capture events, such as
added, updated, deleting, and deleted that are triggered in
Microsoft SharePoint lists.
●
Refresh Data: it can be used to refresh the data, generated
from an external application in a Microsoft SharePoint custom
list representation.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
22
Field
Module
Property?
SharePoint Event
No
Description
(Required) Specify which kind of events that the activity responds
to. This field is displayed only when the Event Handler
notification type is selected.
The following options of the SharePoint event are available:
Destination
Name
Yes
●
Select All: it is triggered when any events occur in a list in
Microsoft SharePoint.
●
ItemAdded: it is triggered when a new list item is added to a
list in Microsoft SharePoint.
●
ItemUpdated: it is triggered when an existing item in a
Microsoft SharePoint list is updated.
●
ItemDeleting: it is triggered when an existing list item is about
to be deleted from a list in Microsoft SharePoint server.
●
ItemDeleted: it is triggered when an existing list item is
deleted from a Microsoft SharePoint list.
(Required) Specify the destination name.
Click Get Destination Configuration to get the destination name
and its connection factory type.
Ensure that you have configured the appropriate
destination name for the selected list and selected the
connection factory type by using the SharePoint
Notification Configuration Management tool deployed
on the Microsoft SharePoint server. See SharePoint
Notification Configuration Management Tool for details
about how to create a topic or queue destination.
Connection
Factory 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 or
subscribing messaging when the SharePoint Notification
Listener activity communicates with the JMS server.
●
Queue: it is used to create connections for point-to-point
messaging when the SharePoint Notification Listener activity
communicates with the JMS server.
The activity supports the durable subscribers for topics.
The durable subscriber ensures that the messages sent
from the Microsoft SharePoint server cannot be lost
when the activity subscribes to the topic, even if the
activity is not currently running.
Durable
Subscription
No
(Optional) Specify whether you want to create the durable
subscription for the topic. This check box is displayed when you
select the Topic connection factory. If it is selected, you have to
configure the Durable Name field.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
23
Field
Module
Property?
Durable Name
Yes
Description
(Required) The name used to access the durable subscription for
the topic. This field is displayed when you select the Durable
Subscription check box.
Description
In the Description tab, you can enter a short description for the SharePoint Notification Listener
activity.
Advanced
In the Advanced tab, you can specify the running sequence of processes and custom job ID for the
process instance.
The following table lists the configurations in the Advanced tab of the SharePoint Notification Listener
activity:
Field
Module
Property?
Description
Sequence
Key
No
This field contains an XPath expression that specifies which processes
run in order. Process instances with sequencing keys that evaluate to
the same value are performed sequentially in the order the process
instance was created.
Custom Job
ID
No
This field contains an XPath expression that specifies a custom job ID
for the process instance. This ID is displayed in the TIBCO
Administrator 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 Listener
activity:
Output Item
Data Type
Description
EventType
String
The type of the event. The event type values contains
Refresh 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 Microsoft
SharePoint.
CurrentUserName
String
The name of the user who initializes the event in Microsoft
SharePoint.
WebSiteID
String
The ID of the site, which the selected list belongs to.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
24
Output Item
Data Type
Description
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. It
varies with different content types. For the meaning of each
attribute, see the Microsoft SharePoint documentation for
more details.
This field is not available for the ItemDeleted
event.
Fault
In the Fault tab, you can find the error code and error message of the SharePoint Notification Listener
activity. See Error Codes for more detailed explanation of errors.
The following table lists error schema elements in the Fault tab of the SharePoint Notification Listener
activity:
Error
Schema
Element
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 ListItem
The SharePoint Add ListItem activity not only supports adding one or more list items to an existing
Microsoft SharePoint list but also adding list items across Microsoft SharePoint sites if each list has the
same 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 to
the Microsoft SharePoint list in batch, you can use the For-Each statement to map the data collection
to the input fields in the SharePoint Add ListItem activity.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
25
Supported functionality of the activity is determined by the list and the content type selected at design
time.
The SharePoint Add ListItem activity does not support adding a file to the Meeting workspace library
in Microsoft SharePoint.
General
In the General tab, you can establish a connection to a Microsoft SharePoint server, specify the list item
that 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:
Field
Module
Property ?
Name
No
SharePoint
Connection
Yes
Description
(Required) Specify the name to be displayed as the label for the
activity in the process. The default value is
SharePointAddListItem.
(Required) Click the
icon to select a SharePoint connection.
If no matching SharePoint Connection shared resources are
found, click Create Shared Resource to create one. See Creating
a SharePoint Connection for more details.
Web Name
No
(Required) Get the target website.
Click Fetch Webs to get available websites from the site
collection specified in the SharePoint Connection shared
resource.
List Name
No
(Required) Get the list that you want to operate on.
Click Fetch Lists to get available lists from the site selected in the
Web 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 the
selected list.
Timeout(sec)
Yes
(Required) Specify how long the plug-in waits for the process to
perform the add operation. The default value is 120.
The add operation might fail or succeed if it times out
when started at run time. The result is undefined. You
have to provide enough time for the add operation to
perform.
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.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
26
The following table lists the input elements in the Input tab of the SharePoint Add ListItem activity:
Input Item
Data
Type
WebName
String
Description
The target website. You can use the activity to add list items
across Microsoft SharePoint sites. You can add a group to this
activity, and get the website from a previously performed
activity in the current process.
The value specified in this parameter takes
precedence over the one set in the General tab.
String
RootFolder
The folder used to store the new list item in the Microsoft
SharePoint 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 as
the default storage.
Ensure that the folder provided exists in the
Microsoft SharePoint list.
N/A
Item
The output of each attribute of the new item. The attributes
vary with different content types. For the meaning of each
attribute, see the Microsoft SharePoint documentation for
more details.
Upload Document to Document Library
The following parameters are displayed when you upload a document to a Microsoft SharePoint
document library.
FileName
String
The file name given to the file when it is uploaded to the
Microsoft SharePoint server.
LocalFileLocation
String
The complete path of the source file.
You must specify a value either in the input item or
in the FileContent input item. Ensure that the size
of the file is less than 25 MB.
FileContent
binary
The binary content of a file, which is transferred from a
previous activity in a process.
The size of the file has to be less than 25 MB.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
27
Input Item
Data
Type
Description
OverwriteExistFile
Boolean
Whether you want to overwrite the existing file.
●
The value of true() indicates the existing file is
overwritten.
●
The value of false() indicates the existing file is not
overwritten and a failure is returned.
If you leave the field empty, the value of true() is kept as the
default value.
Output
In the Output tab, the Success node lists the status of all the operations, and the Results node lists the
status of the current operation.
The following table lists the output elements in the Output tab of the SharePoint Add ListItem activity:
Output
Item
Data Type
Description
Success
Boolean
This property indicates the status of all of the operations. If no error
occurs when adding one or more records, the status true is returned.
Results
The Result element contains the following elements:
Result
●
Success (a Boolean value): this property indicates the status of the
current operation. If no error occurs when adding a record, the status
true is returned.
●
ErrorMessage (a String value): the message returned from the
Microsoft SharePoint system.
●
Item:
the output of each attribute of the new item. The attributes vary
with different content types. For the meaning of each attribute, see
the 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 Schema
Element
Data
Type
Description
SharePointPluginException
msg
String
Displays the error message returned by the plug-in.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
28
Error Schema
Element
Data
Type
Description
msgCode
String
Displays the error code returned by the plug-in.
SharePointRemoteException
msg
String
Displays the error message of the Microsoft SharePoint system when
processing a request from the plug-in.
msgcode
String
Displays the error code of the Microsoft SharePoint system when
processing a request from the plug-in.
encoding
String
Displays the error encoding of the Microsoft SharePoint system when
processing a request from the plug-in.
ActiveTimedOutException
msg
String
Displays the error message when the Add ListItem operation times
out.
msgcode
String
Displays the error code when the Add ListItem operation times out.
SharePoint Update ListItem
The SharePoint Update ListItem activity not only supports updating one or more list items in a specific
Microsoft SharePoint list but also updating list items across Microsoft SharePoint sites that each list has
the same name and column names with the same sequence order.
This activity supports the following functions:
●
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-Each
statement 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 query
conditions, you have to use the SharePoint Select ListItem activity to select the list item first, and then
use the SharePoint Update ListItem activity to update the list item.
The SharePoint Updated ListItem activity does not support batch operations when you upload a
document. And it does not support uploading a file to the Meeting workspace library in Microsoft
SharePoint.
General
In the General tab, you can establish a connection to a Microsoft SharePoint server, specify the list item
that 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 ListItem
activity:
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
29
Field
Module
Property?
Name
No
SharePoint
Connection
Yes
Description
(Required) Specify the name to be displayed as the label
for the activity in the process. The default value is
SharePointUpdateListItem.
(Required) Click the
connection.
icon to select a SharePoint
If no matching SharePoint Connection shared resources
are found, click Create Shared Resource to create one. See
Creating a SharePoint Connection for more details.
Web Name
No
(Required) Get the target website.
Click Fetch Webs to get available websites from the site
collection specified in the SharePoint Connection shared
resource.
List Name
No
(Required) Get the list that you want to operate on.
Click Fetch Lists to get available lists from the site
selected in the Web 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 the selected list.
The list item that you want to update, which is
specified in the Input tab, has the same content
type selected as in this list. If the content type is
mismatched, the plug-in cannot report errors,
but you will get an unexpected result.
Upload
Document
No
Timeout(sec)
Yes
(Required) Specify whether to upload a document.
This field is displayed when you select a Document
content type.
(Required) Specify how long the plug-in waits for the
process to perform the update operation. The default
value is 120.
The update operation might fail or succeed if it
times out when started at run time. The result is
undefined. You have to provide enough time
for the update operation to perform.
Description
In the Description tab, you can enter a short description for the SharePoint Update ListItem activity.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
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 the
activity across Microsoft SharePoint sites. You can add a
group to this activity, and get the site from a previously
performed activity in the current process.
The value specified in this input item takes
precedence over the one set in the General tab.
N/A
Items
The attributes of the new item. The attributes vary with
different content types. See Input Guidelines for details about
how to provide a valid input.
You must provide a value for the ID attribute. If
you leave other attributes empty, the value of the
attribute is not updated on the Microsoft
SharePoint server.
Upload Document to Document Library
The following input items are displayed when you update a document in the Microsoft SharePoint
document library.
LocalFileLocation
String
The location of the source file.
You must specify a value in this input item or in
the FileContent input item.
Binary
FileContent
The binary content of a file, which is transferred from a
previous activity in a process.
The size of the file must be less than 25 MB.
Output
In the Output tab, the Success node lists the status of all the operations, and the Results node lists the
status of the current operation.
The following table lists the output elements in the Output tab of the SharePoint Update ListItem
activity:
Output
Item
Data Type
Description
Success
Boolean
This property indicates the status of all of the operations. If no error
occurs when updating one or more records, the status true is returned.
Results
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
31
Output
Item
Data Type
Description
The Result element contains the following elements:
Result
●
Success (a Boolean value): this property indicates the status of the
current operation. If no error occurs when updating a record, the
status true is returned.
●
ErrorMessage (a String value): the message returned from the
Microsoft SharePoint system.
●
Item:
the output of each attribute of the new item. It varies with
different content types. For the meaning of each attribute, see the
Microsoft SharePoint documentation for more details.
Fault
In the Fault tab, you can find the error code and error messages of the SharePoint Update 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 Update ListItem
activity:
Error Schema
Element
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.
SharePointRemoteException
msg
String
Displays the error message of the Microsoft SharePoint system
when processing a request from the plug-in.
msgcode
String
Displays the error code of the Microsoft SharePoint system when
processing a request from the plug-in.
encoding
String
Displays the error encoding of the Microsoft SharePoint system
when processing a request from the plug-in.
ActiveTimedOutException
msg
String
Displays the error message when the Update ListItem operation
times out.
msgcode
String
Displays the error code when the Update ListItem operation times
out.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
32
SharePoint Delete ListItem
The SharePoint Delete ListItem activity not only supports deleting one or more list items from
Microsoft SharePoint lists but also deleting list items across Microsoft SharePoint sites if each list has
the same name and column names with the same sequence order.
This activity supports the following functions:
●
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 list
items that you want to delete in the activity. If the amount of list items are unknown, you can use
the 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 query
conditions, you have to use the SharePoint Select ListItem activity to select the list item first, and then
use 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 item
that 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:
Field
Module
Property?
Name
No
SharePoint
Connection
Yes
Description
(Required) Specify the name to be displayed as the label for
the activity in the process. The default value is
SharePointDeleteListItem.
(Required) Click the
connection.
icon to select a SharePoint
If no matching SharePoint Connection shared resources are
found, click Create Shared Resource to create one. See
Creating a SharePoint Connection for more details.
Web Name
No
(Required) Get the target website.
Click Fetch Webs to get available websites from the site
collection specified in the SharePoint Connection 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 in the Web Name field.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
33
Field
Module
Property?
Timeout(sec)
Yes
Description
(Required) Specify how long the plug-in waits for the
process to perform the delete operation. The default value is
120.
The delete operation might fail or succeed if it
times out when started at run time. The result is
undefined. You have to provide enough time for
the 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:
Input Item
Data Type
Description
WebName
String
The target website. You can delete list items across Microsoft
SharePoint sites by using the activity. You can add a group to this
activity, and get the website from a previously performed activity in
the current process.
The value specified in this input item takes precedence over
the one set in the General tab.
ID
Integer
The list item ID.
Output
In the Output tab, the Success node lists the status of all the operations, and the Results node lists the
status of the current operation.
The following table lists the output elements in the Output tab of the SharePoint Delete ListItem
activity:
Output
Item
Data Type
Description
Success
Boolean
This property indicates the status of all of the operations. If no error
occurs when deleting one or more records, the status true is returned.
Results
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
34
Output
Item
Data Type
Description
The Result element contains the following elements:
Result
●
Success (a Boolean value): this property indicates the status of the
current operation. If no error occurs when deleting a record, the
status true is returned.
●
ErrorMessage (a String value): the message returned from the
Microsoft SharePoint system.
●
Item:
the output of each attribute of the new item. It varies with
different content types. For the meaning of each attribute, see the
Microsoft SharePoint documentation for more details.
Fault
In the Fault tab, you can find the error code and error messages of the SharePoint Delete 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 Delete ListItem
activity:
Error
Schema
Element
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.
SharePointRemoteException
msg
String
Displays the error message of the Microsoft SharePoint system when
processing a request from the plug-in.
msgcode
String
Displays the error code of the Microsoft SharePoint system when
processing a request from the plug-in.
encoding
String
Displays the error encoding of the Microsoft SharePoint system when
processing a request from the plug-in.
ActiveTimedOutException
msg
String
Displays the error message when the Delete ListItem operation times
out.
msgcode
String
Displays the error code when the Delete ListItem operation times out.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
35
SharePoint Select ListItem
The SharePoint Select ListItem activity not only supports selecting list items from a specific Microsoft
SharePoint 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 use
this feature to define the maximum number of list items that the activity gets from the Microsoft
SharePoint list each time, and then use the group to query all the list items iteratively. See TIBCO
ActiveMatrix BusinessWorks Process Design Guide for details about the group.
The SharePoint Select ListItem activity is always used with the SharePoint Update ListItem activity and
the SharePoint Delete ListItem activity. The purpose of the SharePoint Select ListItem activity is to serve
as a helper for the update and delete operations when you do not know the ID of the item that you
want to update or delete.
The SharePoint Select ListItem activity can also be used to look up the format of the input value when
you use the SharePoint Add ListItem and SharePoint Update ListItem activities to add or update list
items.
This activity does not support selecting list items across different SharePoint lists. Additionally, you
cannot 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 item
that 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:
Field
Module
Property?
Name
No
SharePoint
Connection
Yes
Description
(Required) Specify the name to be displayed as the label
for the activity in the process. The default value is
SharePointSelectListItem.
(Required) Click the
connection.
icon to select a SharePoint
If no matching SharePoint Connection shared resources are
found, click Create Shared Resource to create one. See
Creating a SharePoint Connection for more details.
Web Name
No
(Required) Get the target website.
Click Fetch Webs to get available websites from the site
collection specified in the SharePoint Connection shared
resource.
List Name
No
(Required) Get the list that you want to operate on.
Click Fetch Lists to get available lists from the site selected
in the Web Name field.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
36
Field
Module
Property?
CAML Source
No
Description
(Required) Specify the query schema of Collaborative
Application Markup Language (CAML). The following
options of the CAML source are available:
●
Simple CAML: supports the Contains and Eq queries.
After you provide values for the list item in the Input
tab, the activity uses the non-empty values to do the
searching.
If the input value is Text, Note, URL, Choice, or Multi
choice data Type, the query are generated as a
Contains query. Others are generated as an Eq query.
See Input Guidelines for more details about these
Microsoft SharePoint data types.
●
Input CAML: supports typing a CAML query directly
in the CAMLText field in the Input tab. The root node
of the query must be Query.
CAML is an XML-based language that is used in
Microsoft SharePoint Foundation to define the
fields 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 that
can be queried at once. The default value is 0 , which
returns all the results. The recommended value is from 100
to 5000.
Timeout(sec)
Yes
(Required) Specify how long the plug-in waits for the
process to perform the select operation. The default value
is 120.
The select operation might fail or succeed if it
times out when started at run time. The result is
undefined. You have to provide enough time for
the 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:
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
37
Input Item
Data Type
Description
Page
String
The page parameter returned by Microsoft SharePoint in the last
selection operation. You can use this input item to enable the paging
feature. This feature is used to define the maximum number of list
items that the activity gets from the Microsoft SharePoint list each
time. 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. The
input item only is displayed when you select Simple CAML as the
CAML source.
When the activity uses the recipient field to select a list
item, the activity only supports typing a single value in this
input item each time.
CAMLText
String
The CAML query. You can manually type in a query or you can use
the generated query from the previous activity in the current process.
The input item only is displayed when you select Input CAML as the
CAML 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 ListItem
activity:
Output Item
Data Type
Description
ResultCount
Integer
The number of results returned by the query.
NextPage
String
The value of the NextPage returned by Microsoft SharePoint for
selecting the next page. If the number of the queried result is bigger
than the value defined in the Page Size field, the value of the
NextPage output indicates the ID of the next list item. This input
item only has a value when using the paging feature.
CAMLSource
String
The mode of the query.
N/A
The attributes of the queried item. It varies depending on different
content types. For the meaning of each attribute, see the Microsoft
SharePoint documentation for more details.
Results
Item
Fault
In the Fault tab, you can find the error code and error messages of the SharePoint Select ListItem
activity. See Error Codes for more detailed explanation of errors.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
38
The following table lists error schema elements in the Fault tab of the SharePoint Select ListItem
activity:
Error Schema
Element
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.
SharePointRemoteException
msg
String
Displays the error message of the Microsoft SharePoint system
when processing a request from the plug-in.
msgcode
String
Displays the error code of the Microsoft SharePoint system when
processing a request from the plug-in.
encoding
String
Displays the error encoding of the Microsoft SharePoint system
when processing a request from the plug-in.
ActivityTimedOutException
msg
String
Displays the error message when the Select ListItem operation
times out.
msgcode
String
Displays the error code when the Select ListItem operation times
out.
SharePoint Query
The SharePoint Query activity supports querying list items across different Microsoft SharePoint lists
and websites in a specific site collection.
General
In the General tab, you can establish a connection to a Microsoft SharePoint server, and set the query
condition for the process.
The following table lists the configurations in the General tab of the SharePoint Query activity:
Field
Module
Property?
Name
No
Description
(Required) Specify the name to be displayed as the label for
the activity in the process. The default value is
SharePointQuery.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
39
Field
SharePoint
Connection
Module
Property?
Yes
Description
(Required) Click the
connection.
icon to select a SharePoint
If no matching SharePoint Connection shared resources are
found, click Create Shared Resource to create one. See
Creating a SharePoint Connection for more details.
Query Scope
Web Name
No
No
(Required) Specify the scope that the query operation
covers. The following options of the query scope are
available:
●
AllWebs: if this option is selected, the query operation
covers the current site collection.
●
SubWebs: if this option is selected, the query operation
only covers a selected website and it is sub-website.
(Required) Get the target website.
Click Fetch Webs to get available websites from the site
collection specified in the SharePoint Connection shared
resource.
List Template
No
(Required) Choose a list to be used as the template to
generate the CAML query.
Click Fetch Lists to get available lists from the site selected
in the Web Name field.
CAML Source
No
(Required) Specify the query schema of Collaborative
Application Markup Language (CAML). The following
options of the CMAL source are available:
●
Simple CAML: if you select this option, the Contains
and EQ queries are supported. After you provide values
for the input item in the Input tab, the activity uses the
non-empty values to do the searching.
If the input value is Text, Note, URL, Choice, or Multi
choice data type, the query is generated as a Contains
query. Others are generated as an Eq query. See Input
Guidelines for more details about these Microsoft
SharePoint data types.
●
Input CAML: if this option is selected, inputting a
CAML query directly in the CAMLText field in the
Input tab is supported. The root node of the query must
be Where.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
40
Field
Module
Property?
Max Size
Yes
Description
(Required) Specify the maximum numbers of list items that
are returned by the query. The default value is 2000.
If a large number of records that match the query
conditions display in the field, you can use this
property to limit the total numbers of list items
that are returned by the query.
Timeout(sec)
Yes
(Required) Specify how long the plug-in waits for the
process to perform the query operation. The default value is
120.
The query operation might fail or succeed if it
times out when started at run time. The result is
undefined. You have to provide enough time for
the 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:
Input Item
Data Type
Description
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 the
CAML source.
CAMLText
String
The CAML query. You can manually type in a query or you can use
the generated query from the previous activity in the current
process.
This field only is displayed when you select Input CAML as the
CAML 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:
Output Item
Data Type
Description
ResultCount
Integer
The number of results returned by the query.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
41
Output Item
Data Type
Description
QueryScope
String
The scope that the query operation covers.
QueryMode
String
The mode of the query. The possible values are SimpleCAML and
InputCAML.
Results—include
Item
all the items that match the query condition.
N/A
The attributes of the queried item. It varies with different list
types. For the meaning of each attribute, see the Microsoft
SharePoint 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:
Error
Schema
Element
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.
SharePointRemoteException
msg
String
Displays the error message of the Microsoft SharePoint system when
processing a request from the plug-in.
msgcode
String
Displays the error code of the Microsoft SharePoint system when
processing a request from the plug-in.
encoding
String
Displays the error encoding of the Microsoft SharePoint system when
processing a request from the plug-in.
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 Guidelines
When specifying a value for the list item attributes, you can follow certain input format guidelines to
avoid an invalid input.
The following table lists all the data types in Microsoft SharePoint and its corresponding data types in
the plug-in. It also provides an example of the input format for each data type.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
42
Data Type in
Microsoft
SharePoint
Data Type
in the Plugin
Description
Example
Text
String
Specifies a single line of text.
abc
Note
String
Specifies a field that can contain
multiple 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 formatted
based on a specific locale.
123.45
DateTime
DateTime
Specifies date and time values.
2013-01-16T16:44:20Z
Lookup
String
Specifies references to values in
other lists.
1
Boolean
Boolean
Specifies Boolean values that are
stored in the database as 1 or 0.
0
User
String
Specifies a user or group of a
SharePoint site.
1
URL
URL
(Description
String)
Specifies hyperlinks.
http://
sharepoint.microsoft.com/
en-us/Pages/default.aspx
Calculated
String
Specifies calculated values.
abc
External Data
Not
supported
N/A
N/A
Managed
Metadata
Not
supported
N/A
N/A
Choice
String
Specifies a predetermined set of
values that can be used to enter
data into the field.
choice
MultiChoice
String
Specifies multiple values per list
item.
choice1;#choice2;#
LookupMulti
String
Specifies multiple lookups.
1;#2;#3;#
AllDayEvent
Boolean
Specifies an all-day event.
0 or 1
Attachments
Not
supported
N/A
N/A
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
43
Data Type in
Microsoft
SharePoint
Data Type
in the Plugin
Computed
Description
Example
String
Specifies an abstract field type that
depends on other fields for its
content and definition.
abc
ContentTypeId
String
Specifies a content type ID.
0x0102
Counter
Integer
Specifies an integer used for
internal ID fields.
123
CrossProjectLink
String
Specifies a link between projects in
a Meetings Workspace site.
1
File
String
Specifies files.
abc.ext
GridChoice
Not
supported
N/A
N/A
Guid
String
Specifies GUIDs.
28c7d0fac3da-4b71-9eaf-471bc42ed
f47
MaxItems
Integer
Specifies the maximum number of
items.
1000
ModStat
Not
supported
N/A
N/A
Recurrence
Not
supported
N/A
N/A
UserMulti
String
Specifies multiple users of a
SharePoint site.
1;#name1;#2;#name2
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
44
SharePoint Notification Configuration Management Tool
The SharePoint Notification Configuration Management tool is used to configure JMS and destination
information, bind or unbind event handlers with Microsoft SharePoint lists.
SharePoint Notification Configuration Management Tool Overview
The SharePoint Notification Configuration Management tool is deployed on the Microsoft SharePoint
server when you install the .NET solution components packaged with the TIBCO ActiveMatrix
BusinessWorks Plug-in for Microsoft SharePoint installer.
This tool is used to set up and manage event handler bindings, configure the JMS connection and
destination information, and set the notification types on the Microsoft SharePoint server. After the
configuration, the SharePoint Notification Listener activity is triggered when the Microsoft SharePoint
operations, such as adding, deleting, updating, and refreshing data occur on the Microsoft SharePoint
server.
This tool includes the following tabs:
●
JMS Configuration
●
JMS Destination Configuration
●
Event Handler Configuration
JMS Configuration
In the JMS Configuration tab, you can add, modify, or delete the JMS connection information. You can
also delete all the JMS configuration data.
The following table lists the GUI elements in the JMS Configuration tab:
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
45
GUI
Element
Description
Add
Click this button to add a new JMS connection. After you click this button, the Add
JMS Configuration Information window is displayed. See Adding JMS Configuration
Information 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 JMS
Configuration Information for details about the description for each field.
You have to select an entry in the table before modifying the JMS
configuration.
Delete
Click this button to delete the existing JMS connection after you select the entry in
the table.
After you delete the JMS connection, the corresponding cascaded JMS
destination and registered event handler are all removed.
Purge All
Click this button to purge all JMS configuration data by using the SharePoint
Notification 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 configurations
are stored in the Microsoft SharePoint server.
The following table lists the GUI elements in the Add JMS Configuration Information window:
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
46
GUI Element
Description
SharePoint Web
Application
(Required) Specify the web application.
SharePoint Site
Collection
(Required) Specify the site collection. If you select the Select All item, the
configured JMS information are applied to all site collections in the
selected web application.
All the web applications on Microsoft SharePoint Farm are
displayed in this list.
JMS Server Connection Configuration
JMS Username
(Required when authorization is enabled on the JMS server) Specify the
user name used to access the JMS server.
JMS Password
(Required when authorization is enabled on the JMS server) Specify the
password used to access the JMS server.
Client ID
(Optional) Specify the client ID of the JMS connection. Each connection
must use a unique client ID.
If the value specified in the Client ID field is already in use, an
error occurs when messages are triggered on the Microsoft
SharePoint server.
Auto-generated JMS
Client ID
(Required) Specify whether you want to automatically generate a client
ID for the connection to a JMS server. The automatically generated string
is in GUID format.
If this check box is not selected, the value specified in the
Client ID field is used for the connection.
JMS Provider URL
(Required) Specify the URL to the JMS service provider. The general
syntax is protocol://hostname:port. To take TIBCO Enterprise
Message Service as an example, the URL is tcp://localhost:7222.
Use JNDI for
Connection Factory
(Required) Specify whether you want to use Java Naming and Directory
Interface (JNDI) to query the factory object from the JMS server. If
selected, you have to configure JNDI Context Factory, Topic Connection
Factory, JNDI Context URL, Queue Connection Factory, JNDI
Username, and JNDI Password fields.
JNDI Configuration
JNDI Context Factory
(Required for using JNDI) Specify the initial context factory class for
accessing JNDI. The default context factory for TIBCO Enterprise
Message Service is
com.tibco.tibjms.naming.TibjmsInitialContextFactory.
Topic Connection
Factory
(Required for using JNDI) Specify the topic connection factory used to
create connections for publishing or subscribing messaging. The default
value is TopicConnectionFactory.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
47
GUI Element
Description
JNDI Context URL
(Required for using JNDI) Specify the URL to the JMS service provider.
The general syntax is protocol://hostname: port. To take TIBCO
Enterprise Message Service as an example, the URL is tibjmsnaming://
localhost:7222.
Queue Connection
Factory
(Required for using JNDI) Specify the queue connection factory used to
create connections for point-to-point messaging. The default value is
QueueConnectionFactory.
JNDI Username
(Required for using JNDI when authorization is enabled on the JMS
server) Specify the user name used to access a JNDI server.
JNDI Password
(Required for using JNDI when authorization is enabled on the JMS
server) Specify the password used to access a JNDI server.
Use SSL for JMS
(Optional) Specify whether you want to use SSL to support client
authentication for the JMS server. If selected, you have to configure
Trusted Certificates Path, Identity File, Identity Password, and Target
Host Name fields.
SSL Configuration
See Configuring SSL for TIBCO Enterprise Message Service for details about how to use SSL.
Trusted Certificates
Files
(Required for using SSL) Specify the full paths and names to the
certificates.
Click Add Certificates or Remove Certificates to add or remove the
certificates used to verify the identities of servers and clients. You can
select more than one certificate at a time.
Target Host Name
(Required for using SSL) Specify the common name of the JMS server
certificate.
Identity File
(Required for using two-way SSL authentication) Specify the full path
and name to the identity file. Click Browser to locate the identity files.
Identity Password
(Required for using two-way SSL authentication) Specify the password
used 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 fields
result 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 the
Modify JMS Configuration Information window are similar to the fields in the Add JMS Configuration
Information window. See Adding JMS Configuration Information for more details about the
description of each field.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
48
JMS Destination Configuration
In the JMS Destination Configuration tab, you can specify the notification type, bind a JMS topic or
queue to one or more Microsoft SharePoint lists, and manage destinations.
Before configuring JMS destinations, you have to select one JMS connection entry in the JMS
Configuration tab.
The following table lists the GUI elements in the JMS Destination Configuration tab:
GUI Element
Description
SharePoint Web
Application
This field is not configurable. The value is taken from the JMS
Configuration tab.
SharePoint Site
Collection
This field is not configurable. The value is taken from the JMS
Configuration 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 is
automatically added to all the lists in the selected website when
you add a destination name.
Notification Type
(Required) Specify the notification type. The following options of the
notification type are available:
●
Event Handler: captures the events triggered in the monitored
Microsoft SharePoint list.
●
Refresh Data: refresh the data, generated from an external application,
in a Microsoft SharePoint custom list representation.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
49
GUI Element
Description
Connection Factory
Type
(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 or subscribing
messaging when the SharePoint Notification Listener activity
communicates with the JMS server.
●
Queue: it is used to create connections for point-to-point messaging
when the SharePoint Notification Listener activity communicates with
the JMS server.
Add
Click this button to name the destination. After you click this button, the
Add JMS Destination Name window is displayed. You can set the topic or
queue destination in the Destination Name field, and then save the
configuration.
Modify
Click this button to update the destination and the connection factory
type. After you click this button, the Modify JMS Destination Name
window is displayed. Then, you can modify the connection factory type
and the destination, and then save the configuration.
You have to select an entry in the table under this button before
modifying the destination.
Each list supports either the topic or the queue connection
factory type. You cannot add a topic and a queue connection
factory 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 this
button before deleting destinations. You can also select all the
entries 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 Configuration
In the Event Handler Configuration tab, you can bind or unbind the event handler with one or more
Microsoft SharePoint lists.
Before configuring event handlers, you have to select one JMS connection entry in the JMS
Configuration tab.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
50
The following table lists the GUI elements in the Event Handler Configuration tab:
GUI Element
Description
SharePoint Web
Application
This field is not configurable. The value is taken from the JMS
Configuration tab.
SharePoint Site
Collection
This field is not configurable. The value is taken from the JMS
Configuration tab.
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 type
are available:
●
Select All: the event handler is triggered when any events occur on the
list you have specified.
●
ItemAdded: the event handler is triggered when a new list item is added
to the list you have specified.
●
ItemUpdated: the event handler is triggered when an existing list item is
updated from the list you have specified.
●
ItemDeleting: the event handler is triggered when an existing list item is
about to be deleted from the list you have specified.
●
ItemDeleted: the event handler is triggered when an existing list item is
deleted from the list you have specified.
Register
Click this button to bind the event handler to the selected lists. If you select
the Select All item in the List Name list, the event handlers are bound to all
the lists after clicking this button.
Unregister
Click this button to unbind the event handler from the selected lists. If you
select the Select All item from the List Name list, and check all the entries
from the table, the event handlers are unbound from all the lists after
clicking this button.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
51
Configuring SSL for TIBCO Enterprise Message Service
SSL is a protocol that provides secure authentication and transmits encrypted data over the Internet or
an internal network. The plug-in supports using SSL to secure the data exchange between the plug-in
and an Microsoft SharePoint server.
TIBCO Enterprise Message Service is used to publish data from the Microsoft SharePoint server to
plug-in. If you want to use an SSL connection for TIBCO Enterprise Message Service, you have to
perform 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 Server
To enable SSL, each instance of tibemsd must have a digital certificate and a private key. The server
can optionally 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 or
TIBCO_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 text
editor.
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 the
configuration file.
factories.conf
3. Set the ssl_server_identity, ssl_server_key, and ssl_password parameters to specify the
digital 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 Message
Service 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 on
the command line to start SSL for the server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
52
See TIBCO Enterprise Message Service User’s Guide for details about how to configure SSL in a
TIBCO Enterprise Message Service server.
If the SSL listerner port is modified in the tibemsd.conf file, you must configure the
factories.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 Server
To use an SSL connection, you have to enable SSL to an existing JMS connection by using the
SharePoint Notification Configuration Management tool after configuring a TIBCO Enterprise Message
Service server.
Prerequisites
Before configuring SSL on the Microsoft SharePoint server, you have to configure SSL on the TIBCO
Enterprise Message Service server.
Procedure
1. If you use a self-signed certificate in your environment, you have to import the JMS server root
certificate 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 use
one-way SSL authentication.
If you want to use two-way SSL authentication, you have to also provide the identity file
and identity password.
6. Click Save to save the configuration.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
53
Configuring SSL for the SharePoint Notification Listener Activity in the
Plug-in
You can configure SSL settings for the SharePoint Notification Listener activity in the plug-in to secure
the data exchange.
Prerequisites
Before configuring SSL for the SharePoint Notification Listener Activity, you have to configure SSL on
the TIBCO Enterprise Message Service server.
TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint supports both one-way and twoway 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 its
identity 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 SSL
authentication in the SSL Configuration field.
If you want to use the two-way SSL authentication, you have to also provide the identity
file and identity password.
7. Select the SharePoint Notification Listener activity that you have created. In the General tab, select
the shared resource in the SharePoint Connection field.
8. Save the project.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
54
Working with the Sample Project
TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint packages a sample project with
the 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/
directory.
sharePoint/version_number/samples
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
SharePoint to add, select, update, and delete a document item from the Microsoft SharePoint Shared
Documents library.
●
Add_Update_Query_Delete_Link.bwp
The process shows how to use TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft
SharePoint to 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
SharePoint to listen to and respond to the ItemDeleting event triggered when an existing document
item is to be deleted from the Microsoft SharePoint Documents Library.
●
RefreshData.bwp
The process shows how to use TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft
SharePoint to refresh items in the Microsoft SharePoint Custom list.
Importing the Sample Project
Before 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 Business
Studio 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 into
Workspace 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.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
55
Running the Project
You can run the sample project to see how TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft
SharePoint works.
Prerequisites
Ensure that you have imported the sample project to TIBCO Business Studio, as described in Importing
the Sample Project.
Procedure
1. In the Project Explorer view, expand the Resource folder, and then expand the example shared
resource.
2. Double-click SharePoint-Shared-Connection.sharepointconnectionResource to edit the SharePoint
connection, 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 the
server.
See Getting Metadata from the Microsoft SharePoint Server for more details about how to get
metadata from the server.
4. In the Project Explorer view, expand the Module Descriptors resource, and then double-click
Components.
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.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
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. You
can change the log level of the plug-in to trace different messages and export logs to a file. Different log
levels correspond to different messages, as described in Log Levels.
Log Levels
Different 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, and
Debug levels are captured.
Info
Indicates normal plug-in operations. No action is required. A tracing message
tagged with Info indicates that a significant processing step is reached, and
logged for tracking or auditing purposes. Only info messages preceding a
tracking identifier are considered as significant steps.
If the Info log level is selected, logs in the Error, Warn, and Info levels
can be captured.
Warn
Indicates that an abnormal condition occurred. Processing continues, but for
best practice, you can contact the administrator to investigate it.
If the Warn log level is selected, logs in the Error and Warn levels are
captured.
Error
Indicates that an unrecoverable error occurred. Depending on the severity of
the 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 are
captured.
Setting Up Log Levels
You 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 ActiveMatrix
BusinessWorks. The default log level is Error.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
57
Procedure
1. Navigate to the TIBCO_HOME/bw/version_number/config/design/logback directory and open
the logback.xml file.
2. Add the following node in the BusinessWorks Palette and Activity loggers area to specify a log
level 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 also
displayed 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 to
specify 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 configured
for the plug-in.
4. Save the file.
Exporting Logs to a File
You 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 open
the logback.xml file.
After deploying an application in TIBCO Enterprise Administrator, navigate to the
TIBCO_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>
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
58
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36}-%msg%n</pattern>
</encoder>
</appender>
The value of the file element is the absolute path of the file that stores the exported log.
3. Add the following node to the root node at the bottom of the logback.xml file.
<root level="DEBUG">
<appender-ref ref="STDOUT" />
<appender-ref ref="FILE" />
</root>
4. Save the file.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
59
Error Codes
The following table lists error codes, detailed explanation of each error, and where applicable, ways to
solve different errors.
Error Code and Error
Message
Role
Category
Description
Solution
BW-SharePoint-505000
errorRole
BW-Plugin
An error occurs when
running an activity if an
error is displayed in the
Input tab.
Check errors listed
in the error message
and take
appropriate actions.
errorRole
BW-Plugin
An error might occur
when calling a remote
method.
Check errors listed
in the error message
and take
appropriate actions.
errorRole
BW-Plugin
An unknown error.
Check errors listed
in the error message
and take
appropriate actions.
errorRole
BW-Plugin
An error occurs when
the plug-in activity runs
into failure.
Check errors listed
in the error message
and take
appropriate actions.
errorRole
BW-Plugin
An error occurs when
you type an invalid
input for the plug-in
activity.
Correct the input
data according to
the error message.
errorRole
BW-Plugin
An error occurs when
an unsupported
encoding is in use.
Check errors listed
in the error message
and take
appropriate actions.
errorRole
BW-Plugin
An error occurs when
the SharePoint Add
ListItem activity is
parsing a document or
Wiki page template.
Check errors listed
in the error message
and take
appropriate actions.
errorRole
BW-Plugin
An error occurs when
creating a SPForm
instance.
Check errors listed
in the error message
and take
appropriate actions.
Activity input
error: {0}.
BW-SharePoint-505001
Remote Error: {0}.
BW-SharePoint-505002
Unknown Error: {0}.
BW-SharePoint-505003
Activity ran into
failure: {0}.
BW-SharePoint-505004
Input data
validation error:
{0}.
BW-SharePoint-505005
Unsupported
Encoding.
BW-SharePoint-505006
Read Template
Error:{0}.
BW-SharePoint-505007
Create form has
error: {0}.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
60
Error Code and Error
Message
Role
Category
Description
Solution
BW-SharePoint-505008
errorRole
BW-Plugin
An error occurs when
the SharePoint
Notification Listener
activity stops listening
to a JMS Queue or
Topic.
Check errors listed
in the error message
and take
appropriate actions.
errorRole
BW-Plugin
An error occurs when
running an activity
without selecting a
SharePoint Connection
shared resource.
errorRole
BW-Plugin
An error occurs when
the invocation to the
Microsoft SharePoint
server times out.
Check whether the
network is in a
good condition, or
provide an
appropriate timeout
value.
errorRole
BW-Plugin
An error occurs when
running an activity
with the Web Name
field in the General tab
unspecified.
Click Fetch Webs to
get available sites
from the site
collection specified
in the SharePoint
Connection shared
resource.
errorRole
BW-Plugin
An error occurs when
running an activity
with the List Name
field in the General tab
unspecified.
Specify a list name
for the activity.
errorRole
BW-Plugin
An error occurs when
running an activity
with the Content Type
field in the General tab
unspecified.
Specify a content
type for the activity.
Stop Listener
encounter error:
{0}.
BW-SharePoint-505009
Please select the
SharePoint Shared
Connection for {0}.
BW-SharePoint-505010
The invocation to
the server has
timeout,the
configured timeout
value is {0} ms.
BW-SharePoint-505011
Please select the
Web Name for {0}.
BW-SharePoint-505012
Please select the
List Name for {0}.
BW-SharePoint-505013
Please select the
Content Type Name
for {0}.
Click the
icon
in the General tab
to select a
SharePoint
Connection shared
resource. If no
SharePoint
Connection shared
resource matches,
create one.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
61
Error Code and Error
Message
Role
Category
Description
Solution
BW-SharePoint-505014
errorRole
BW-Plugin
An error occurs when
the plug-in activity tries
to connect to the JMS
server if the JMS
configuration
information in the
SharePoint Connection
shared resource is not
correctly specified.
Check whether the
JMS configuration
information
specified in the
SharePoint
Connection shared
resource are correct.
errorRole
BW-Plugin
An error occurs when
the plug-in activity tries
to connect to the
Microsoft SharePoint
server if the Microsoft
SharePoint server
configuration
information in the
SharePoint Connection
shared resource is not
correctly specified.
Check whether the
configuration
information to
connect to the
Microsoft
SharePoint server
specified in the
SharePoint
Connection shared
resource is correct.
errorRole
BW-Plugin
An error occurs when
running the SharePoint
Notification Listener
activity with the
Connection Factory
Type field unspecified
in the General tab.
Specify a
connection factory
type for the
SharePoint
Notification
Listener activity.
errorRole
BW-Plugin
An error occurs when
running the SharePoint
Notification Listener
activity with the
Durable Subscription
check box selected and
the Durable Name field
unspecified in the
General.
Specify a durable
name for the
SharePoint
Notification
Listener activity.
errorRole
BW-Plugin
An error occurs when
the plug-in activity
cannot get the JMS
messages from the JMS
server.
Check errors listed
in the error message
and take
appropriate actions.
errorRole
BW-Plugin
An error occurs when
running an activity
with the value of the
Timeout(sec) field is set
to 0 in the General tab.
Specify an
appropriate timeout
value for the
activity.
JMS error. Please
check JMS
configuration.error
detail: {0}.
BW-SharePoint-505015
Can't find
connection to
server, Please
check the
configuration.
BW-SharePoint-505016
Please select the
connection factory
Type.
BW-SharePoint-505017
Please input
durable topic
subscriber name.
BW-SharePoint-505018
Can't get the JMS
message text.
BW-SharePoint-505019
The configured
timeout value for
activity [{0}] can
not be 0!
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
62
Error Code and Error
Message
Role
Category
Description
Solution
BW-SharePoint-505020
errorRole
BW-Plugin
An error occurs when
running the SharePoint
Select ListItem or
SharePoint Query
activity with the CAML
Source field in the
General tab
unspecified.
Specify a CAML
source for the
SharePoint Select
ListItem or Query
activity.
errorRole
BW-Plugin
An error occurs when
uploading a document
item to a Microsoft
SharePoint document
library.
Check errors listed
in the error message
and take
appropriate actions.
errorRole
BW-Plugin
An error occurs when
building output data for
an activity.
Check errors listed
in the error message
and take
appropriate actions.
errorRole
BW-Plugin
An error occurs when
an exception is thrown
by this activity.
Check errors listed
in the error message
and take
appropriate actions.
errorRole
BW-Plugin
An authentication error
occurs when the plug-in
activity fails to
authenticate against the
run time user name and
password.
Check whether the
user name and
password which are
used to log in the
Microsoft
SharePoint server
are correctly
specified in the
SharePoint
Connection shared
resource.
errorRole
BW-Plugin
An error occurs when
the connection to the
Microsoft SharePoint
server is broken down.
Check whether the
Microsoft
SharePoint server is
available or the IP
address to connect
the Microsoft
SharePoint server is
specified correctly.
Please select query
Type for {0}.
BW-SharePoint- 505021
File Check in
failed with
exception: {0}.
BW-SharePoint-505022
Error happens when
deserializing
output of activity
{0}.
BW-SharePoint-505023
Exception happens:
\n{0}.
BW-SharePoint- 505024
Failed to
authenticate,
please confirm your
User Name,Password
and Permission!
BW-SharePoint-505025
Can not connect to
SharePoint Server,
error message:{0}.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
63
Error Code and Error
Message
Role
Category
Description
Solution
BW-SharePoint-505026
errorRole
BW-Plugin
An error occurs when
the connection to the
JMS server is broken
down.
Check whether the
JMS server is
available or the JMS
configuration
information
specified in the
SharePoint
Connection shared
resource is correct.
errorRole
BW-Plugin
An error occurs when
an activity tries to fetch
a specified list from the
Microsoft SharePoint
server at run time.
Check errors listed
in the error message
and take
appropriate actions.
errorRole
BW-Plugin
An error occurs when
creating a SharePoint
Connection shared
resource.
Check errors listed
in the error message
and take
appropriate actions.
errorRole
BW-Plugin
An error occurs when
decrypting a password
in the SharePoint
Connection shared
resource.
Check errors listed
in the error message
and take
appropriate actions.
Failed to {0}
SharePoint JMS
Connection resource
[{1}].
BW-SharePoint-505027
Failed to Fetch
List: {0}, error
message: {1}
BW-SharePoint-502028
Creating Shared
Resource {0}
failed.
BW-SharePoint-502029
Decrypt {0} has
exception: {1}
TIBCO ActiveMatrix BusinessWorks™ Plug-in for Microsoft SharePoint User's Guide
Was this manual useful for you? yes no
Thank you for your participation!

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

Download PDF

advertisement