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

TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint User s Guide Software Release 1.0 Feburary 2013 Two-Second Advantage

Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE. USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE LICENSE FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME. This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc. TIBCO, Two-Second Advantage, TIBCO, The Power of Now, TIBCO ActiveMatrix BusinessWorks, TIBCO Designer, TIBCO Administrator, TIBCO Rendezvous, TIBCO Runtime Agent, TIBCO Hawk, and TIBCO Enterprise Message Service are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries. EJB, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. 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 TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information

iii Contents Figures........................................................................vii Tables......................................................................... ix Preface........................................................................ xi Related Documentation..................................................................... xii TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint Documentation................. xii Other TIBCO Product Documentation...................................................... xii Third-party Documentation............................................................... xii Typographical Conventions..................................................................xiii Connecting with TIBCO Resources............................................................ xv How to Join TIBCOmmunity.............................................................. xv How to Access TIBCO Documentation...................................................... xv How to Contact TIBCO Support........................................................... xv Chapter 1 Introduction...........................................................1 Overview of Microsoft SharePoint.............................................................. 2 Overview of the Plug-in...................................................................... 3 Chapter 2 SharePoint Get Metadata Tool.............................................5 Overview of SharePoint Get Metadata Tool....................................................... 6 Getting Metadata........................................................................... 7 Chapter 3 SharePoint Palette......................................................9 Palette Overview.......................................................................... 10 SharePoint Shared Connection............................................................. 11 Configuration......................................................................... 11 SharePoint Notification Listener............................................................. 15 Configuration......................................................................... 16 Misc................................................................................ 17 Output............................................................................... 17 Error Output.......................................................................... 18 SharePoint Add ListItem................................................................... 19 Configuration......................................................................... 19

iv Contents Input................................................................................ 20 Output.............................................................................. 21 Error Output.......................................................................... 22 SharePoint Update ListItem................................................................. 23 Configuration......................................................................... 23 Input................................................................................ 24 Output.............................................................................. 25 Error Output.......................................................................... 26 SharePoint Delete ListItem................................................................. 27 Configuration......................................................................... 27 Input................................................................................ 28 Output.............................................................................. 28 Error Output.......................................................................... 29 SharePoint Select ListItem.................................................................. 30 Configuration......................................................................... 30 Input................................................................................ 32 Output.............................................................................. 32 Error Output.......................................................................... 33 SharePoint Query......................................................................... 34 Configuration......................................................................... 34 Input................................................................................ 36 Output.............................................................................. 36 Error Output.......................................................................... 37 Input Guidelines.......................................................................... 38 Chapter 4 Notification Configuration Management................................... 41 Overview of the Notification Configuration Management Tool....................................... 42 JMS Configuration......................................................................... 43 JMS Destination Configuration............................................................... 46 Event Handler Configuration................................................................. 47 Chapter 5 Getting Started....................................................... 49 Overview................................................................................ 50 Creating a Project......................................................................... 51 Configuring SharePoint Shared Connection..................................................... 53 Getting Metadata from Microsoft SharePoint Server.............................................. 54 Creating a Process........................................................................ 55 Adding Activities to a Process................................................................ 56 Testing a Process......................................................................... 57 Deploying a Project........................................................................ 58

Contents v Appendix A Configuring Log Files................................................59 Configuring Plug-in Installation Log Files........................................................ 60 Configuring Server Installation Log Files........................................................ 62 Index..........................................................................63

vi Contents

Figures vii Figures Figure 1 Get Metadata Tool............................................................... 7 Figure 2 SharePoint Plug-in Palette........................................................ 10 Figure 3 TIBCO Designer Start Screen..................................................... 51 Figure 4 TIBCO Designer Save Project Screen............................................... 52

viii Figures

Tables ix Tables Table 1 General Typographical Conventions............................................... xiii Table 2 SharePoint Get Metadata Tool..................................................... 6 Table 3 SharePoint Shared Connection Configuration........................................ 11 Table 4 SharePoint Notification Listener Configuration........................................ 16 Table 5 SharePoint Notification Listener Output............................................. 17 Table 6 SharePoint Notification Listener Exceptions......................................... 18 Table 7 SharePoint Add ListItem Configuration............................................. 19 Table 8 SharePoint Add ListItem Input.................................................... 20 Table 9 SharePoint Add ListItem Output................................................... 21 Table 10 SharePoint Add ListItem Exceptions............................................... 22 Table 11 SharePoint Update ListItem Configuration........................................... 23 Table 12 SharePoint Update ListItem Input................................................. 24 Table 13 SharePoint Update ListItem Output................................................ 25 Table 14 SharePoint Update ListItem Exceptions............................................. 26 Table 15 SharePoint Delete ListItem Configuration........................................... 27 Table 16 SharePoint Delete ListItem Input.................................................. 28 Table 17 SharePoint Delete ListItem Output................................................. 28 Table 18 SharePoint Delete ListItem Exceptions............................................. 29 Table 19 SharePoint Select ListItem Configuration........................................... 30 Table 20 SharePoint Select ListItem Input.................................................. 32 Table 21 SharePoint Select ListItem Output................................................. 32 Table 22 SharePoint Select ListItem Exceptions............................................. 33 Table 23 SharePoint Query Configuration.................................................. 34 Table 24 SharePoint Query Input......................................................... 36 Table 25 SharePoint Query Output........................................................ 36 Table 26 SharePoint Query Exceptions.................................................... 37 Table 27 Input Guidelines............................................................... 38 Table 28 JMS Configuration............................................................. 43

x Tables Table 29 Add JMS Configuration Information................................................. 44 Table 30 JMS Destination Configuration.................................................... 46 Table 31 Event Handler Configuration...................................................... 47 Table 32 Log Parameters Plug-in Installation................................................. 60

xi Preface TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint, integrated with TIBCO ActiveMatrix BusinessWorks, addresses the needs of the TIBCO ActiveMatrix BusinessWorks customer who wants a user-friendly way to make use of Microsoft SharePoint. It is assumed that you are familiar with the basic concepts of the TIBCO environment and Microsoft SharePoint. Topics Related Documentation, page xii Typographical Conventions, page xiii Connecting with TIBCO Resources, page xv

xii Related Documentation Related Documentation This section lists documentation resources you may find useful. TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint Documentation The following documents form the TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint documentation set: TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint Installation Read this manual for instructions on how to install and uninstall the plug-in. TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint User s Guide Read this manual for instructions on using the product. TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint Release Notes Read the release notes for a list of new and changed features. This document also contains lists of known issues and closed issues for this release. Other TIBCO Product Documentation You may find it useful to read the documentation for the following TIBCO products: TIBCO Designer TIBCO Administrator TIBCO ActiveMatrix BusinessWorks TIBCO Rendezvous TIBCO Enterprise Message Service TIBCO Hawk TIBCO Runtime Agent Third-party Documentation You may also find it useful to read the Microsoft SharePoint product documentation available on Microsoft website: http://sharepoint.microsoft.com/en-us/pages/default.aspx

Preface xiii Typographical Conventions The following typographical conventions are used in this manual. Table 1 General Typographical Conventions Convention ENV_NAME TIBCO_HOME SharePointPlugin_HOME SharePointServer_HOME code font Use TIBCO products are installed into an installation environment. A product installed into an installation environment does not access components in other installation environments. Incompatible products and multiple instances of the same product must be installed into different installation environments. An installation environment consists of the following properties: Name Identifies the installation environment. This name is referenced in documentation as ENV_NAME. On Microsoft Windows, the name is appended to the name of Windows services created by the installer and is a component of the path to the product shortcut in the Windows Start > All Programs menu. Path The folder into which the product is installed. This folder is referenced in documentation as TIBCO_HOME. The product is installed into a directory within a TIBCO_HOME. The Plug-in Installation installs the product in the directory is referenced in documentation as SharePointPlugin_HOME. The default value depends on the operating system. For example on Windows systems, the default value is C:\tibco\bw\plugins\sharepoint. The Server Installation installs the product in the directory is referenced in documentation as SharePointServer_HOME. The default value depends on the operating system. For example on Windows systems, the default value is C:\tibco\bwpluginsharepoint\version. Code font identifies commands, code examples, filenames, pathnames, and output displayed in a command window. For example: Use MyCommand to start the foo process.

xiv Typographical Conventions Table 1 General Typographical Conventions (Cont d) Convention bold code font Use Bold code font is used in the following ways: In procedures, to indicate what a user types. For example: Type admin. In large code samples, to indicate the parts of the sample that are of particular interest. In command syntax, to indicate the default parameter for a command. For example, if no parameter is specified, MyCommand is enabled: MyCommand [enable disable] italic font Italic font is used in the following ways: To indicate a document title. For example: See TIBCO ActiveMatrix BusinessWorks Concepts. To introduce new terms For example: A portal page may contain several portlets. Portlets are mini-applications that run in a portal. To indicate a variable in a command or code syntax that you must replace. For example: MyCommand PathName Key combinations Key name separated by a plus sign indicate keys pressed simultaneously. For example: Ctrl+C. Key names separated by a comma and space indicate keys pressed one after the other. For example: Esc, Ctrl+Q. The note icon indicates information that is of special interest or importance, for example, an additional action required only in certain circumstances. The tip icon indicates an idea that could be useful, for example, a way to apply the information provided in the current section to achieve a specific result. The warning icon indicates the potential for a damaging situation, for example, data loss or corruption if certain steps are taken or not taken.

Preface xv Connecting with TIBCO Resources How to Join TIBCOmmunity TIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts. It is a place to share and access the collective experience of the TIBCO community. TIBCOmmunity offers forums, blogs, and access to a variety of resources. To register, go to http://www.tibcommunity.com. How to Access TIBCO Documentation You can access TIBCO documentation here: http://docs.tibco.com How to Contact TIBCO Support For comments or problems with this manual or the software it addresses, contact TIBCO Support as follows: For an overview of TIBCO Support, and information about getting started with TIBCO Support, visit this site: http://www.tibco.com/services/support If you already have a valid maintenance or support contract, visit this site: https://support.tibco.com Entry to this site requires a user name and password. If you do not have a user name, you can request one.

xvi Connecting with TIBCO Resources

1 Chapter 1 Introduction This chapter gives an overview of Microsoft SharePoint and TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint. Topics Overview of Microsoft SharePoint, page 2 Overview of the Plug-in, page 3

2 Chapter 1 Introduction Overview of Microsoft SharePoint Microsoft SharePoint is a business collaboration platform that offers efficiency and productivity for users to communicate across enterprises. It enables users to share information and expertise effectively regardless of location. If you are not familiar with Microsoft SharePoint, you can refer to Microsoft SharePoint product documentation available on Microsoft s website.

Overview of the Plug-in 3 Overview of the Plug-in TIBCO BusinessWorks is an easy-to-use integration software that provides world-class integration technology in a rapidly deployable solution that manages the entire lifecycle of integration projects. TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint integrated with TIBCO BusinessWorks provides a user-friendly environment that allows you to add, update, delete, and query data in Microsoft SharePoint server. It also allows you to publish events and refresh data from external system. SharePoint Shared Connection shared resource can be reused for the SharePoint Get Metadata tool and different activities. The SharePoint Get Metadata tool allows you to retrieve Microsoft SharePoint metadata which will be used to configure various Microsoft SharePoint activities at design time. The SharePoint Notification Listener activity allows you to listen the events triggered in Microsoft SharePoint server, such as add, update, or delete a list item. The activity also allows you to work with other activities to fetch data and populate the custom list with the data from an external source. The SharePoint Add ListItem, SharePoint Delete ListItem, and SharePoint Update ListItem activities allow you to add, delete, and update list items in Microsoft SharePoint servers. The SharePoint Select ListItem activity allows you to use different query conditions to select list items that belong to a specific list type from the Microsoft SharePoint server. The SharePoint Query activity allows you to query list items across different Microsoft SharePoint lists and websites in a specific site collection. The Notification Configuration Management tool, which is deployed on a Microsoft SharePoint server after you install the Server Installation, is used to support the SharePoint Notification Listener activity. It allows you to configure JMS and destination information, set notification types, configure event handler, and refresh data information. TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint has three installation types: Plug-in Installation, Server Installation, and Customize Installation. See TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint Installation for details.

4 Chapter 1 Introduction

5 Chapter 2 SharePoint Get Metadata Tool This chapter specifies how to use the SharePoint Get Metadata tool to retrieve Microsoft SharePoint metadata which is used to configure various activities at design time. Topics Overview of SharePoint Get Metadata Tool, page 6 Getting Metadata, page 7

6 Chapter 2 SharePoint Get Metadata Tool Overview of SharePoint Get Metadata Tool Table 2 SharePoint Get Metadata Tool The SharePoint Get Metadata tool is deployed on your machine after installing TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint. The SharePoint Get Metadata tool is used to retrieve Microsoft SharePoint metadata which is used to configure various activities at design time. The length of the web name, list name, and content type name defined in Microsoft SharePoint should be less than 200 characters and should not include special characters, such as *,?, #, and so on. Otherwise, an error occurs when getting metadata. The SharePoint Get Metadata tool dialog includes the following GUI elements. GUI Element SharePoint Connection Web Name Get Metadata View Metadata Cancel Close Description (Required) Specifies a shared connection resource. Click the button to open the Select A Resource dialog. All usable SharePoint Connection shared resources are listed in the dialog. (Required) Specifies the site where metadata is saved. Click the button to get all the available sites from the site collection which has been defined in the selected shared resource. Click this button to get metadata. Click this button to view metadata. Click this button to cancel metadata retrieval process. Click this button to exit the SharePoint Get Metadata tool.

Getting Metadata 7 Getting Metadata Before running any TIBCO Designer processes related to TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint, you need to get metadata from a Microsoft SharePoint server and save it to your project. Getting metadata needs the design-time credentials provided in the SharePoint Shared Connection resource. Therefore, you need to create and configure the SharePoint Shared Connection resource before using the Get Metadata tool. To get metadata from a Microsoft SharePoint server, follow these steps: 1. Start TIBCO Designer. 2. Select Tools > SharePoint Tools > Get Metadata from the menu bar. The Get Metadata tool dialog is displayed, as shown in Figure 1. Figure 1 Get Metadata Tool 3. Click the button besides the SharePoint Connection field to open the Select A Resource dialog. 4. Select a SharePoint shared resource in the Select A Resource dialog, and then click the OK button to save the configuration. 5. Click the GetWeb button besides the Web Name field to get available sites. 6. Click the Get Metadata button to get metadata from Microsoft SharePoint. 7. Click the Close button to exit. 8. Click the button on the toolbar to save the configuration.

8 Chapter 2 SharePoint Get Metadata Tool

9 Chapter 3 SharePoint Palette This chapter specifies the SharePoint palette, which includes a shared resource and several activities. After you go through this chapter, you will be familiar with the functions provided by TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint. Topics Palette Overview, page 10 SharePoint Shared Connection, page 11 SharePoint Notification Listener, page 15 SharePoint Add ListItem, page 19 SharePoint Update ListItem, page 23 SharePoint Delete ListItem, page 27 SharePoint Select ListItem, page 30 SharePoint Query, page 34 Input Guidelines, page 38

10 Chapter 3 SharePoint Palette Palette Overview The SharePoint palette is in the Palettes panel. This palette includes one shared resource and six activities, as shown in Figure 2. Figure 2 SharePoint Plug-in Palette

SharePoint Shared Connection 11 SharePoint Shared Connection Shared Resource The SharePoint Shared Connection shared resource describes the connections among the plug-in, JMS server, and Microsoft SharePoint server. It can be reused for the SharePoint Get Metadata tool and different activities of TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint. Configuration The Configuration tab contains the following fields. Table 3 SharePoint Shared Connection Configuration (Sheet 1 of 3) Field Global Var? Description Name No (Required) The name of the resource. The default value is SharePoint Shared Connection. Description No (Optional) A short description of the resource. Click the SharePoint Server Connection Configuration button to add the description in the Description dialog. SharePoint SiteCollection Authentication Method Yes No (Required) The URL address of the SharePoint site collection you want to access. It is the top-level website. The address format should be consistent with the one set in Microsoft SharePoint server. For example, if the public URL set in Microsoft SharePoint server is an IP address, the value in the SharePoint Web Site Address should also use an IP address. Note: Secure Sockets Layer (SSL) encryption is not supported in this release. (Required) The supported Windows authentication methods which are used to validate the credentials of connecting users. BASIC and NTLM authentication methods in Classic Mode Authentication are supported. Note: 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. Additionally, Claims Based Authentication is not supported.

12 Chapter 3 SharePoint Palette Table 3 SharePoint Shared Connection Configuration (Sheet 2 of 3) Field Runtime Username Runtime Password Design-time Username Design-time Password Global Var? Yes Yes Yes Yes Description (Required) The runtime username that the plug-in activities will use to authenticate against and run. The format is domainname\username. If you do not provide the domain name in this field, the name or address of the Microsoft SharePoint server will be used. (Required) The runtime password that the plug-in activities will use to authenticate against and run. (Required) The design-time username is used to fetch metadata using the SharePoint Get Metadata tool, and to retrieve a Destination topic in the SharePoint Notification Listener activity. The format is domainname\username. If you do not provide the domain name in this field, the name or address of the Microsoft SharePoint server will be used. (Required) The design-time password that is used when fetching metadata using the SharePoint Get Metadata tool. JMS Server Connection Configuration JMS Username Yes (Optional) The username used to access a JMS server. JMS Password Yes (Optional) The password used to access a JMS server. Auto-generated JMS Client ID No (Required) Specifies whether or not 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 field is not checked, then the value specified in the Client ID field is used for the connection. If no value is specified in the Client ID field, then no client ID is set. If the value specified in the Client ID field is already in use, an error occurs. 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.

SharePoint Shared Connection 13 Table 3 SharePoint Shared Connection Configuration (Sheet 3 of 3) Field JMS Provider URL Use JNDI for Connection Factory JNDI Context Factory JNDI Context URL Topic Connection Factory Global Var? Yes No No Yes Yes Description (Required) Specifies the URL to the JMS service provider. The general syntax is protocol://hostname:port. Take TIBCO Enterprise Message Service for an example, the URL is tcp://localhost:7222. (Required) Specifies whether or not you want to use JNDI (Java Naming and Directory Interface) to query the topic factory object from the JMS server. If checked, you need to configure JNDI Context URL, Topic Connection Factory, JNDI Username, and JNDI Password fields. (Required) The initial context factory class for accessing JNDI. The default context factory for TIBCO Enterprise Message Service is com.tibco.tibjms.naming.tibjmsinitialcontextfactory. (Required) Specifies the URL to the JMS service provider. The general syntax is protocol://hostname:port. Take TIBCO Enterprise Message Service for example, the URL is tibjmsnaming://localhost:7222. (Required) The topic connection factory used to create connections for publish/subscribe messaging. The default value is TopicConnectionFactory. JNDI Username Yes (Optional) The username used to access the JMS server. JNDI Password Yes (Optional) The password used to access the JMS server. Test SharePoint Connection Button The Test SharePoint Connection button allows you to test whether the specified configuration fields result in a valid connection to the Microsoft SharePoint server using the runtime and design-time credentials. Get JMS Configuration Button If you have configured the JMS configuration information using the Notification Configuration Management tool which is installed on the Microsoft SharePoint server, the Get JMS Configuration button allows you to automatically retrieve the JMS configuration information from the Microsoft SharePoint server. See Notification Configuration Management on page 41 for details about this tool. The client ID cannot be automatically retrieved from the Microsoft SharePoint server. You need to provide the value manually or check the Auto-generated JMS Client ID checkbox to generate a client ID.

14 Chapter 3 SharePoint Palette Test JMS Connection Button The Test JMS Connection button allows you to test whether the specified configuration fields result in a valid connection to the JMS server.

SharePoint Notification Listener 15 SharePoint Notification Listener Activity The SharePoint Notification Listener activity supports the following functions: Event Handling the activity responds to the events triggered in Microsoft SharePoint servers. The event types supported in this activity include the added, updated, deleting, and deleted a list item. To enable this function, you should use the Notification Configuration Management tool to bind the selected list to the event handler first. See documentation for Notification Configuration Management for details. When an add operation operates on 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 will be triggered at least twice. Refresh Data the activity is triggered when using the TIBCORefreshData custom web part in a Microsoft SharePoint custom list. After successfully installing the custom web part provided by TIBCO on the Microsoft SharePoint server, the Refresh Data From External Application button is displayed on the web page. The activity allows you to work with other activities to fetch data and populate the custom list with the data from an external source. To enable this function, you should use the Notification Configuration Management tool to 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 desire to use the TIBCORefreshData custom web part, the Refresh Data From External Application button will be disabled. In order to use this web part and fetch the data from an external application, you should have Read-Write access privileges. See TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint Installation for more details about how to deploy the custom web part. Non-durable subscription in the publish and subscribe messaging model of JMS is used when the SharePoint Notification Listener activity communicates with the JMS server.

16 Chapter 3 SharePoint Palette Configuration The Configuration tab contains the following fields. Table 4 SharePoint Notification Listener Configuration Field Global Var? Description Name No (Required) The name of the activity in the process definition. The default value is SharePoint Notification Listener. Description No (Optional) A short description of the activity. Click the button to add the description in the Description dialog. SharePoint Connection No (Required) Specifies a shared connection resource. Click the button to open the Select A Resource dialog. All usable SharePoint Connection shared resources are listed in the dialog. Select one to apply to your current activity. Web Name No (Required) Specifies the target website. Click the button to get available websites from the site collection specified in the SharePoint shared resource. List Name No (Required) Specifies the list that you want to operate on. Click the Web Name field. button to get available lists from the site selected in the Notification Type Destination Topic No Yes (Required) Specifies the notification type. There are two options: Event Handler is used to capture events, such as add, update, deleting, and delete, triggered on Microsoft SharePoint lists. Refresh Data is used to refresh the data, generated from an external application, in a Microsoft SharePoint custom list representation. (Required) Specifies the topic destination. Click the button to get the topic. Note: Make sure you have created the topic for the selected list in Microsoft SharePoint. See Notification Configuration Management for details about how to create a topic destination.

SharePoint Notification Listener 17 Table 4 SharePoint Notification Listener Configuration (Cont d) Field SharePoint Event Global Var? No Description (Required) Specifies which event the activity responds to. This field only appears when the Event Handler notification type is selected. There are five options: SelectAll triggered when any events occur on a list in Microsoft SharePoint. ItemAdded triggered when a new item is added to a list in Microsoft SharePoint. ItemDeleted triggered when an existing item is deleted from a list in Microsoft SharePoint server. ItemDeleting triggered when an existing item is about to be deleted from a list in Microsoft SharePoint server. ItemUpdated triggered when an existing item in a Microsoft SharePoint list is updated. Misc The Misc tab allows you to configure features that are common to all process starters. See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information about this tab. Output The output for the activity is as follows. Table 5 SharePoint Notification Listener Output Output Item Data Type Description EventType string The type of the event. Possible values are: 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 initiated the event in Microsoft SharePoint.

18 Chapter 3 SharePoint Palette Table 5 SharePoint Notification Listener Output (Cont d) Output Item Data Type Description CurrentUsername string The name of the user who initiated the event in Microsoft SharePoint. WebSiteID string The ID of the site to which the selected list belongs. WebSiteURL string The URL of the site to which the selected list belongs. ListID string The ID of the list to which the list item belongs. ListTitle string The title of the list to which the list item belongs. Event Handler Notification Type Only ListItemID string The ID of the list item on which the event is triggered. ListItemDisplayName string The name of the list item on which 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, refer to the documentation of Microsoft SharePoint. Note: This field is not available for ItemDeleted event. Error Output The Error Output tab lists the exception that can be thrown by this activity. Table 6 SharePoint Notification Listener Exceptions Exception SharePointPluginException Cause Occurs when the plug-in has internal errors.

SharePoint Add ListItem 19 SharePoint Add ListItem Activity The SharePoint Add ListItem activity supports adding one or more list items to an existing Microsoft SharePoint list. This activity can also be used to create new folders and upload files to document libraries. Additionally, this activity supports batch operations, which means you can add multiple list items at a time. If you want to add 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. 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. Configuration The Configuration tab contains the following fields. Table 7 SharePoint Add ListItem Configuration Field Global Var? Description Name No (Required) The name of the activity in the process definition. The default value is SharePoint Add ListItem. Description No (Optional) A short description of the activity. Click the button to add the description in the Description dialog. SharePoint Connection No (Required) Specifies a shared connection resource. Click the button to open the Select A Resource dialog. All usable SharePoint Connection shared resources are listed in the dialog. Select one to apply to your current activity. Web Name No (Required) Specifies the target site. Click the button to get available sites from the site collection specified in the SharePoint shared resource. List Name No (Required) Specifies the list that you want to operate on. Click the Web Name field. button to get available lists from the site selected in the

20 Chapter 3 SharePoint Palette Table 7 SharePoint Add ListItem Configuration (Cont d) Field Global Var? Description Content Type No (Required) Specifies the content type used to define the list item. Click the button to get available content types of the selected list. Timeout (sec) Yes (Required) Specifies how long the plug-in waits for the process to execute the add operation. The default value is 120 seconds. Note: The add operation may either fail or succeed if it times out when started at runtime. The result is undefined. TIBCO recommends that you provide enough time for the add operation to execute. Input The required input of the activity varies with the configurations you have made in the Configuration tab. Table 8 specifies the possible input of the activity. Table 8 SharePoint Add ListItem Input Input Item Data Type Description RootFolder string The folder used to store the new list item in the SharePoint server. The string format should be either the absolute path like http://host:port /sites/web/libraryname/folderpath/ or the relative path to the list like /parent-folder/folder. If you leave this field empty, the root folder is used as the default storage. Note: Make sure that the folder provided exists in the Microsoft SharePoint list. Item N/A The attributes of the new item. It varies with different content types. Refer to Input Guidelines on page 38 for details about how to provide a valid input. Upload Document to Document Library The following fields appear when you upload a document to Microsoft SharePoint document library. FileName string The file name given to the file when it is uploaded to the Microsoft SharePoint server.

SharePoint Add ListItem 21 Table 8 SharePoint Add ListItem Input (Cont d) Input Item Data Type Description LocalFileLocation string The complete path of the source file. Note: You must specify a value either in this field or in the FileContent field. And make sure that the size of the file is less than 25M. FileContent binary The binary content of a file, which is transferred from a previous activity in a process. Note: The size of the file should be less than 25M. OverwriteExistFile boolean Specifies whether you want to overwrite the existing file or not. The value 1 indicates the existing file will be overwritten. The value 0 indicates the existing file will not be overwritten and a failure will be returned. If you leave the field empty, the value 1 will be the default value. Output The output for the activity is as follows. Table 9 SharePoint Add ListItem Output Output Item Data Type Description Success boolean This property indicates the status of the operations on all list items. If no error occurs when adding all list items, the status true is returned. Result Success boolean This property indicates the status of the operation on the list item. If no error occurs when adding the list item, the status true is returned. ErrorMessage string If an error occurs, the error message is returned. Item N/A The output of each attribute of the new item. The attributes vary with different content types. For the meaning of each attribute, refer to the documentation of Microsoft SharePoint.

22 Chapter 3 SharePoint Palette Error Output The Error Output tab lists the exceptions that can be thrown by this activity. Table 10 SharePoint Add ListItem Exceptions Exception SharePointPluginException SharePointRemoteException ActivityTimedOutException Cause Occurs when the plug-in has internal errors. Occurs when the Microsoft SharePoint server encounters errors with processing a request from the plug-in. Occurs when the add operation times out.

SharePoint Update ListItem 23 SharePoint Update ListItem Activity The SharePoint Update ListItem activity supports updating one or more list items in a specific Microsoft SharePoint list. Additionally, this activity supports batch operations, which means you can update multiple list items at a time. You can 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 need 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. Configuration The configuration tab contains the following fields. Table 11 SharePoint Update ListItem Configuration Field Global Var? Description Name No (Required) The name of the activity in the process definition. The default value is SharePoint Update ListItem. Description No (Optional) A short description of the activity. Click the button to add the description in the Description dialog. SharePoint Connection No (Required) Specifies a shared connection resource. Click the button to open the Select A Resource dialog. All usable SharePoint Connection shared resources are listed in the dialog. Select one to apply to your current activity. Web Name No (Required) Specifies the target site. Click the button to get available sites from the site collection specified in the SharePoint shared resource. List Name No (Required) Specifies the list that you want to operate on. Click the button to get available lists from the site selected in the Web Name field.

24 Chapter 3 SharePoint Palette Table 11 SharePoint Update ListItem Configuration Field Global Var? Description Content Type No (Required) Specifies the content type used to define the list item. Click the button to get available content types of the selected list. Note: The list item that you want to update, which is specified in the Input tab, should have the same content type selected as in this dropdown list. If the content type is mismatched, the plug-in will not report errors, but you will get an unexpected result. Upload Document No (Required) Specifies whether to upload a document or not. Timeout (sec) Yes (Required) Specifies how long the plug-in waits for the process to execute the update operation. The default value is 120 seconds. Note: The update operation may either fail or succeed if it times out when started at runtime. The result is undefined. TIBCO recommends that you provide enough time for the update operation to execute. Input The required input of the activity varies with the configurations you have made in the Configuration tab. Table 8 specifies the possible input of the activity. Table 12 SharePoint Update ListItem Input Input Item Data Type Description Item N/A The attributes of the new item. It varies with different content types. Refer to Input Guidelines on page 38 for details about how to provide a valid input. Upload Document to Document Library Note: You must provide a value for the ID attribute. If you leave other attributes empty, the value of the attribute will not be updated on the Microsoft SharePoint server. The following fields appear when you update a document in Microsoft SharePoint document library. LocalFileLocation string The location of the source file. Note: You must specify a value either in this field or in the FileContent field.

SharePoint Update ListItem 25 Table 12 SharePoint Update ListItem Input (Cont d) Input Item Data Type Description FileContent binary The binary content of a file, which is transferred from a previous activity in a process. Note: The size of the file should be less than 25M. Output The output for the activity is as follows. Table 13 SharePoint Update ListItem Output Output Item Data Type Description Success boolean This property indicates the status of the operations on all list items. If no error occurs when updating all list items, the status true is returned. Result Success boolean This property indicates the status of the operation on the list item. If no error occurs when updating the list item, the status true is returned. ErrorMessage string If an error occurs, the error message is returned. Item N/A The output of each attribute of the new item. It varies with different content types. For the meaning of each attribute, refer to the documentation of Microsoft SharePoint. Error Output The Error Output tab lists the exceptions that can be thrown by this activity. Table 14 SharePoint Update ListItem Exceptions Exception SharePointPluginException SharePointRemoteException ActivityTimedOutException Cause Occurs when the plug-in has internal errors. Occurs when the Microsoft SharePoint server encounters errors with processing a request from the plug-in. Occurs when the update operation times out.

26 Chapter 3 SharePoint Palette

SharePoint Delete ListItem 27 SharePoint Delete ListItem Activity The SharePoint Delete ListItem activity supports deleting one or more list items from Microsoft SharePoint lists. The activity only supports using the list item ID to delete list items. If you want to use other query conditions, you need 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. Additionally, this activity supports batch operations, which means you can delete multiple list items at a time. You can input 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. Configuration The Configuration tab contains the following fields. Table 15 SharePoint Delete ListItem Configuration Field Global Var? Description Name No (Required) The name of the activity in the process definition. The default value is SharePoint Delete ListItem. Description No (Optional) A short description of the activity. Click the button to add the description in the Description dialog. SharePoint Connection No (Required) Specifies a shared connection resource. Click the button to open the Select A Resource dialog. All usable SharePoint Connection shared resources are listed in the dialog. Select one to apply to your current activity. Web Name No (Required) Specifies the target site. Click the button to get available sites from the site collection specified in the SharePoint shared resource. List Name No (Required) Specifies the list that you want to operate on. Click the Web Name field. button to get available lists from the site selected in the

28 Chapter 3 SharePoint Palette Table 15 SharePoint Delete ListItem Configuration (Cont d) Field Global Var? Description Timeout (sec) Yes (Required) Specifies how long the plug-in waits for the process to execute the delete operation. The default value is 120 seconds. Note: The delete operation may either fail or succeed if it times out when started at runtime. The result is undefined. TIBCO recommends that you provide enough time for the delete operation to execute. Input The input for the activity is as follows. Table 16 SharePoint Delete ListItem Input Input Item Data Type Description ID integer The list item ID. Output The output for the activity is as follows. Table 17 SharePoint Delete ListItem Output Output Item Data Type Description Success boolean This property indicates the status of the operations on all list items. If no error occurs when deleting all list items, the status true is returned. Result Success boolean This property indicates the status of the operation on the list item. If no error occurs when deleting the list item, the status true is returned. ErrorMessage string If an error occurs, the error message is returned. ID integer The list item ID.

SharePoint Delete ListItem 29 Error Output The Error Output tab lists the exceptions that can be thrown by this activity. Table 18 SharePoint Delete ListItem Exceptions Exception SharePointPluginException SharePointRemoteException ActivityTimedOutException Cause Occurs when the plug-in has internal errors. Occurs when the Microsoft SharePoint server encounters errors with processing a request from the plug-in. Occurs when the delete operation times out.

30 Chapter 3 SharePoint Palette SharePoint Select ListItem Activity The SharePoint Select ListItem activity supports selecting list items from a specific Microsoft SharePoint list using different query conditions. Additionally, this activity provides support for paging. This feature is always used when 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. Refer to 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 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 and selecting list item using content types. To select list items across different Microsoft SharePoint lists, you can use the SharePoint Query activity. Configuration The configuration tab contains the following fields. Table 19 SharePoint Select ListItem Configuration Field Global Var? Description Name No (Required) The name of the activity in the process definition. The default value is SharePoint Select ListItem. Description No (Optional) A short description of the activity. Click the button to add the description in the Description dialog. SharePoint Connection No (Required) Specifies a shared connection resource. Click the button to open the Select A Resource dialog. All usable SharePoint Connection shared resources are listed in the dialog. Select one to apply to your current activity.

SharePoint Select ListItem 31 Table 19 SharePoint Select ListItem Configuration (Cont d) Field Global Var? Description Web Name No (Required) Specifies the target website. Click the button to get available websites from the site collection specified in the SharePoint shared resource. List Name No (Required) Specifies the list that you want to operate on. Click the button to get available lists from the website selected in the Web Name field. CAML Source No (Required) Specifies the query schema of Collaborative Application Markup Language (CAML).There are two options to input query parameters: 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 is Text, Note, URL, Choice, or MultiChoice data type, the query will be generated as a Contains query. Others will be generated as an Eq query. Input CAML supports inputting a CAML query directly in the CAMLText field in the input tab. The root node of the query must be Query. Note: 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) Specifies 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 between 100 and 5000. Timeout (sec) Yes (Required) Specifies how long the plug-in waits for the process to execute the select operation. The default value is 120 seconds. Note: The select operation will fail if it times out when started at runtime. TIBCO recommends that you provide enough time for the select operation to execute.

32 Chapter 3 SharePoint Palette Input The required input of the activity varies with the configurations you have made in the Configuration tab. Table 20 specifies the possible input of the activity. Table 20 SharePoint Select ListItem Input Input Item Data Type Description Page string The page parameter returned by Microsoft SharePoint in the last selection operation. You can use this field 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 query all the list items iteratively. FieldValues N/A The attributes of the selected item. It varies depending on the list. Refer to Input Guidelines on page 38 for details about how to provide a valid input. Note: When the activity using the recipient field to select a list item, the activity only supports inputting a single value in this field 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. Note: The root node of the CAML query must be Query. Output The output for the activity is as follows. Table 21 SharePoint Select ListItem Output Output Item Data Type Description ResultCount integer The number of results returned by the query. NextPage string The parameter 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 will indicate the ID of the next list item. This field only has a value when using the paging feature. CAMLSource string The mode of the query.

SharePoint Select ListItem 33 Table 21 SharePoint Select ListItem Output (Cont d) Output Item Data Type Description Results include all the items that match the query condition. Item N/A The attributes of the queried item. It varies depending on different content type. For the meaning of each attribute, refer to the documentation of Microsoft SharePoint. Error Output The Error Output tab lists the exceptions that can be thrown by this activity. Table 22 SharePoint Select ListItem Exceptions Exception SharePointPluginException SharePointRemoteException ActivityTimedOutException Cause Occurs when the plug-in has internal errors. Occurs when the Microsoft SharePoint server encounters errors with processing a request from the plug-in. Occurs when the select operation times out.

34 Chapter 3 SharePoint Palette SharePoint Query Activity The SharePoint Query activity supports querying list items across different Microsoft SharePoint lists and websites in a specific site collection. Configuration The Configuration tab contains the following fields. Table 23 SharePoint Query Configuration Field Global Var? Description Name No (Required) The name of the activity in the process definition. The default value is SharePoint Query. Description No (Optional) A short description of the activity. Click the button to add the description in the Description dialog. SharePoint Connection No (Required) Specifies a shared connection resource. Click the button to open the Select A Resource dialog. All usable SharePoint Connection shared resources are listed in the dialog. Select one to apply to your current activity. Query Scope No (Required) Specifies the scope that the query operation covers. There are two options: AllWebs the query operation covers the current site collection. SubWebs the query operation only covers a selected website and its sub-website. Web Name No (Required) Specifies the target website. Click the button to get available websites from the site collection specified in the SharePoint shared resource. This field only appears for the SubWebs query.

SharePoint Query 35 Table 23 SharePoint Query Configuration (Cont d) Field Global Var? Description List Template No (Required) Specifies the list which will be used as a template to generate CAML query. Note: The query scope is not limited to the list you selected in this field. CAML Source No (Required) Specifies the query schema of Collaborative Application Markup Language (CAML).There are two options to input query parameters: Simple CAML supports the Contains and Eq queries. After you provide values for the input parameters 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 MultiChoice data type, the query will be generated as a Contains query. Others will be generated as an Eq query. See Input Guidelines on page 38 for details about these Microsoft SharePoint data types. Input CAML supports inputting a CAML query directly in the CAMLText field in the input tab. The root node of the query must be Where. Max Size No (Required) Specifies the maximum numbers of list items that will be returned by the query. The default value is 2000. Note: If there are a large number of records that match the query condition, you can use this property to limit the total numbers of list items that will be returned by the query. Timeout (sec) Yes (Required) Specifies how long the plug-in waits for the process to execute the query operation. The default value is 120 seconds. Note: The query operation will fail if it times out when started at runtime. TIBCO recommends that you provide enough time for the query operation to execute.

36 Chapter 3 SharePoint Palette Input The required input of the activity varies with the configuration you have made in the Configuration tab. Table 20 specifies the possible input of the activity. Table 24 SharePoint Query Input Input Item Data Type Description FieldValues N/A The attributes of the selected item. It varies with different list types. Refer to Input Guidelines on page 38 for details about how to provide a valid input. 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. Note: The root node of the CAML query must be Where. Output The output for the activity is as follows. Table 25 SharePoint Query Output Output Item Data Type Description ResultCount integer The number of results returned by the query. 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 all the items that match the query condition. item N/A The attributes of the queried item. It varies with different list types. For the meaning of each attribute, refer to the documentation of Microsoft SharePoint.

SharePoint Query 37 Error Output The Error Output tab lists the exceptions that can be thrown by this activity. Table 26 SharePoint Query Exceptions Exception SharePointPluginException SharePointRemoteException ActivityTimedOutException Cause Occurs when the plug-in has internal errors. Occurs when the Microsoft SharePoint server encounters errors with processing a request from the plug-in. Occurs when the query operation times out.

38 Chapter 3 SharePoint Palette Input Guidelines Table 27 Input Guidelines (Sheet 1 of 2) Data Type in Microsoft SharePoint In order to provide a valid value for the list item attributes, Table 27 specifies a data type in Microsoft SharePoint and its corresponding data type in the plug-in. The table also provides an example for each data type to give you a better understanding of the input format. Data Type in Plug-in Description Example Text string Specifies a single line of text. "abc" Note string Specifies a field that can contain multiple lines of text. Number double Specifies floating point numbers. Number (1, 1.0, 100) "abc" 123.1 integer integer Specifies 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. boolean boolean Specifies boolean values that are stored in the database as 1 or 0. User string Specifies a user or group of a SharePoint site. "1" 0 "1" URL URL (Description string) Specifies hyperlinks. "http://sharepoint.micro soft.com/en-us/pages/de fault.aspx" Calculated string Specifies calculated values. "abc" External Data Not supported N/A N/A Managed Metadata Not supported N/A N/A

Input Guidelines 39 Table 27 Input Guidelines (Sheet 2 of 2) Data Type in Microsoft SharePoint Data Type in Plug-in Description Choice string Specifies a predetermined set of values that can be used to enter data into the field. MultiChoice string Specifies multiple values per list item. Example "choice" "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 Computed 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. CrossProjectLink string Specifies a link between projects in a Meetings Workspace site. 123 "1" File string Specifies files. "abc.ext" GridChoice Not Supported N/A N/A Guid string Specifies GUIDs. "28c7d0fa-c3da-4b71-9 eaf-471bc42edf47" 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 of users of a SharePoint site. "1;#name1;#2;#name2"

40 Chapter 3 SharePoint Palette

41 Chapter 4 Notification Configuration Management This chapter gives an overview of the Notification Configuration Management tool and specifies how to use this tool to configure JMS and destination information, bind or unbind event handlers with Microsoft SharePoint lists. Topics Overview of the Notification Configuration Management Tool, page 42 JMS Configuration, page 43 JMS Destination Configuration, page 46 Event Handler Configuration, page 47

42 Chapter 4 Notification Configuration Management Overview of the Notification Configuration Management Tool The SharePoint Notification Configuration Management tool is deployed on a Microsoft SharePoint server when you install the Server Installation of TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint. This tool is used to configure JMS connection and destination information, set notification types, and bind or unbind event handlers with Microsoft SharePoint lists. The tool is used to support the SharePoint Notification Listener activity in the plug-in at runtime. This tool includes three tabs: JMS Configuration, page 43 JMS Destination Configuration, page 46 Event Handler Configuration, page 47

JMS Configuration 43 JMS Configuration Table 28 JMS Configuration In the JMS Configuration tab, you can add, modify, or delete the JMS connection information. After configuring the JMS connection information, you can configure the JMS destination and the event handler. The JMS Configuration tab contains the following GUI elements. GUI Element Add Modify Delete Description Click this button to add a new JMS connection. See Add JMS Configuration Information for details. Click this button to update the existing JMS connection. After you click this button, the Modify JMS Configuration Information dialog is displayed. You can update the JMS information and then click the Modify button to save the configuration. See Add JMS Configuration Information for details about the description for each field in the Modify JMS Configuration Information dialog. Note: You need to select an entry in the table before modifying the JMS configuration. Click this button to delete the existing JMS connection after you select the entry in the table. Note: After you delete the JMS connection, the corresponding cascaded JMS destination and registered event handler will be all removed.

44 Chapter 4 Notification Configuration Management Add JMS Configuration Information The Add JMS Configuration Information dialog contains the following GUI elements. Table 29 Add JMS Configuration Information GUI Element SharePoint Web Applications SharePoint Site Collection JMS Username JMS Password Client ID JMS Provider URL Auto-generated JMS Client ID Use JNDI for Connection Factory JNDI Context Factory Topic Connection Factory Description (Required) Specifies the web application. Note: All the web applications created on the Microsoft SharePoint server are displayed in this dropdown list. (Required) Specifies the site collection. If you select the Select All item, the configured JMS information will be applied to all site collections in the selected web application. (Optional) The username used to access a JMS server. (Optional) The password used to access a JMS server. (Optional) The client ID of the JMS connection. Each connection must use a unique Client ID. (Required) Specifies the URL to the JMS service provider. The general syntax is protocol://hostname:port. Take TIBCO Enterprise Message Service for an example, the URL is tcp://localhost:7222. (Required) Specifies whether or not 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 field is not checked, then the value specified in the Client ID field is used for the connection. If no value is specified in the Client ID field, then no client ID is set. If the value specified in the Client ID field is already in use, an error occurs. (Required) Specifies whether or not you want to use JNDI (Java Naming and Directory Interface) to query the topic factory object from the JMS server. If checked, you need to configure JNDI Context Factory and JNDI Context URL fields. (Required) The initial context factory class for accessing JNDI. The default context factory for TIBCO Enterprise Message Service is com.tibco.tibjms.naming.tibjmsinitialcontextfactory. (Required) The topic connection factory used to create connections for publish/subscribe messaging. The default value is TopicConnectionFactory.

JMS Configuration 45 Table 29 Add JMS Configuration Information (Cont d) GUI Element JNDI Context URL JNDI Username JNDI Password Save Cancel Description (Required) Specifies the URL to the JMS service provider. The general syntax is protocol://hostname:port. Take TIBCO Enterprise Message Service for an example, the URL istibjmsnaming://localhost:7222. (Optional) The username used to access a JNDI server. (Optional) The username used to access a JNDI server. Click this button to save the configuration. Click this button to exit the current configuration.

46 Chapter 4 Notification Configuration Management JMS Destination Configuration In the JMS Destination Configuration tab, you can configure the notification type and set JMS destinations. Before configuring JMS destinations, you need to select one JMS connection entry in the JMS Configuration tab. Table 30 JMS Destination Configuration The JMS Destination Configuration tab contains the following GUI elements. GUI Element SharePoint Web Applications SharePoint Site Collection Web Name List Name Notification Type Add Modify Delete Description This field is not configurable. The value is taken from the JMS Configuration tab. This field is not configurable. The value is taken from the JMS Configuration tab. (Required) Specifies the target website in the site collection. (Required) Specifies the list that you want to monitor. (Required) Specifies the notification type. There are two options: Event Handler captures the event triggered on the monitored Microsoft SharePoint list. Refresh Data refresh the data, generated from an external application, in a Microsoft SharePoint custom list representation. Click this button to name the topic destination. After you click this button, the Add JMS Destination Name dialog is displayed. You need to name the topic destination in the Destination Name field, and then save the configuration. Click this button to update the topic destination. After you click this button, the Modify JMS Destination Name dialog is displayed. Then, you can modify the topic destination in the Destination Name field, and then save the configuration. Note: You need to select an entry in the table under this button before modifying the topic destination. Click this button to delete the existing JMS connection. Note: You need to select an entry in the table under this button before deleting the topic destination.

Event Handler Configuration 47 Event Handler Configuration Table 31 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 need to select one JMS connection entry in the JMS Configuration tab and specify the JMS destination topic name in the JMS Destination Configuration tab. The Event Handler Configuration tab contains the following GUI elements. GUI Element SharePoint Web Applications SharePoint Site Collections Web Name List Name Event Type Register Description This field is not configurable. The value is taken from the JMS Configuration tab. This field is not configurable. The value is taken from the JMS Configuration tab. (Required) Specifies the target website in the site collection. (Required) Specifies the list that you want to monitor. (Required) Specifies the event type. There are five options: 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. Click this button to bind the event handler to the selected lists. If you select the Select All item in the List Name dropdown list, the event handler will bind to all the lists after clicking this button.

48 Chapter 4 Notification Configuration Management Table 31 Event Handler Configuration (Cont d) GUI Element Unregister Description Click this button to unbind the event handler from the selected lists. If you select the Select All item in the List Name dropdown list, the event handler will unbind from all the lists after clicking this button.

49 Chapter 5 Getting Started This chapter specifies the basic steps that are required to configure and run TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint in TIBCO Designer. Topics Overview, page 50 Creating a Project, page 51 Configuring SharePoint Shared Connection, page 53 Getting Metadata from Microsoft SharePoint Server, page 54 Creating a Process, page 55 Adding Activities to a Process, page 56 Testing a Process, page 57 Deploying a Project, page 58

50 Chapter 5 Getting Started Overview TIBCO ActiveMatrix BusinessWorks is a scalable, extensible, and easy to use integration platform that allows you to develop and test integration projects. TIBCO ActiveMatrix BusinessWorks includes a graphical user interface, TIBCO Designer for defining business processes, and an engine that executes the processes. For detailed information about how to configure processes, see TIBCO Designer documentation, which can be accessed from the Help > Designer Help menu option in TIBCO Designer. A typical configuration session contains the following steps: 1. Creating a Project, page 51 2. Configuring SharePoint Shared Connection, page 53 3. Getting Metadata from Microsoft SharePoint Server, page 54 4. Creating a Process, page 55 5. Adding Activities to a Process, page 56 6. Testing a Process, page 57 7. Deploying a Project, page 58

Creating a Project 51 Creating a Project The TIBCO Designer GUI is used to configure the plug-in. When starting TIBCO Designer, you must create or select a project. A project contains the configuration files that define options used during runtime. To create a project, complete the following steps: 1. Start TIBCO Designer. Execute one of the following platform-specific commands to open the TIBCO Designer window: On Microsoft Windows Click Start > All Programs > TIBCO > TIBCO Designer version_number > TIBCO Designer. Or From a command window, run TIBCO_HOME\designer\version_number\bin\designer.exe. On UNIX From a command window, run TIBCO_HOME/designer/version_number/bin/designer. 2. Click the New Empty Project button in the TIBCO Designer dialog, as shown in Figure 3. The Save Project dialog appears. Figure 3 TIBCO Designer Start Screen

52 Chapter 5 Getting Started 3. Click the button in the Multi-File Project tab. Navigate to the location where you intend to save the project and specify a name for the project. Click the OK button to continue, as shown in Figure 4. Figure 4 TIBCO Designer Save Project Screen The TIBCO Designer GUI appears with the newly created project.

Configuring SharePoint Shared Connection 53 Configuring SharePoint Shared Connection After creating the project, you need to add a SharePoint Shared Connection shared resource and configure it to set up the connections among the plug-in, JMS server, and Microsoft SharePoint server. After dragging the SharePoint Shared Connection shared resource from the SharePoint Palette panel to the design panel, you need to configure each field in the Configuration tab. See SharePoint Shared Connection on page 11 for details about the shared resource.

54 Chapter 5 Getting Started Getting Metadata from Microsoft SharePoint Server After creating the project and configuring the SharePoint Shared Connection shared resource, you need to get metadata from the Microsoft SharePoint server before you create a process to implement the business logic. See Getting Metadata on page 7 for details.

Creating a Process 55 Creating a Process After getting the metadata in the TIBCO Designer window, you need to create a process to deal with certain workflows. To create a process, complete the following steps: 1. Select the root directory in the project panel. 2. Expand the Process palette in the palette panel and drag the Process Definition icon into the design panel. 3. Configure the process. For more information, see TIBCO Designer User s Guide. 4. Click the Apply button to save the configuration.

56 Chapter 5 Getting Started Adding Activities to a Process After creating the process, you can add the plug-in activities to it. To add an activity to the process, complete the following steps: 1. Click the process that was previously created in Creating a Process on page 55. The Start and End activities appear in the design panel. 2. Expand the SharePoint palette in the palette panel and drag one or more activities to the design panel. You can also add activities from other palettes to the process, for example, File activities. If the SharePoint palette is not shown in the palette panel, select Palettes > Activities > SharePoint from the menu bar to make it visible. 3. Create transitions between activities in the design panel. 4. Configure each activity in the process. For configuration information, see SharePoint Palette on page 9.

Testing a Process 57 Testing a Process After creating and configuring the process, you can test it in TIBCO Designer. This allows you to check if the process works properly before you deploy it. See TIBCO BusinessWorks Process Design Guide for detailed information on using test mode.

58 Chapter 5 Getting Started Deploying a Project To deploy a project that you have configured, you need to generate an Enterprise Archive file (EAR file) that contains configurations for the process definition you want to deploy. You can upload the archive to TIBCO Administrator to deploy the associated application. See TIBCO ActiveMatrix BusinessWorks Administration for more information. The following is the basic procedure: 1. Save the project in TIBCO Designer window. 2. Create an enterprise archive and then create a process archive in it. 3. Add processes defined in the project into the process archive. 4. Add the SharePointResources folder and the SharePoint Shared Connection applied to the process to the shared archive. 5. Build the archive by clicking the Build Archive button under the Enterprise Archive panel. When you click the button, TIBCO Designer generates an enterprise archive (.ear) file that you can then deploy from TIBCO Administrator. 6. Start TIBCO Administrator and create an application related to the project. 7. Deploy the application and start the process.

59 Appendix A Configuring Log Files TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint has two installation types: Plug-in Installation and Server Installation. This appendix describes how to set the log file to update the tracing options on the plug-in side and the server side. Topics Configuring Plug-in Installation Log Files, page 60 Configuring Server Installation Log Files, page 62

60 Appendix A Configuring Log Files Configuring Plug-in Installation Log Files This section specifies how to set the log status when configuring a project in TIBCO Designer, or deploying a project in TIBCO Administrator. Configuring in TIBCO Designer Tracing options are set in TIBCO Designer when configuring a service or process. You can view the tracing options for a process or service instance and set search parameters to display only a subset of a log file. When you configure a project in TIBCO designer, write the following lines of code in your configuration file (.cfg file) to set the log status. You may change the value in the file. Trace.Info.*=true Trace.Error.*=true Trace.Warn.*=true Trace.Debug.*=true com.tibco.plugin.sharepoint.debug=false Deploying in TIBCO Administrator Trace.Info.*, Trace.Error.*, and Trace.Warn.* are three general properties in TIBCO BusinessWorks. They are not added in the default bwengine.xml configuration file located in the TIBCO_HOME\bw\version\lib\com\tibco\deployment directory. If you want to set the log status when deploying a project in TIBCO Administrator, add these properties manually in the bwengine.xml file. See the TIBCO BusinessWorks Administration documentation for details. Table 32 shows the description for each log parameter. Table 32 Log Parameters Plug-in Installation Property Component Description Trace.Info.* Trace.Error.* TIBCO BusinessWorks TIBCO BusinessWorks Whether the general information is shown (true) or not (false) while running the application. The default is true. Whether the error message is shown (true) or not (false) while running the application. The default is true.

Configuring Plug-in Installation Log Files 61 Table 32 Log Parameters Plug-in Installation (Cont d) Property Component Description Trace.Warn.* TIBCO BusinessWorks Whether the warning message is shown (true) or not (false) while running the application. The default is true.

62 Appendix A Configuring Log Files Configuring Server Installation Log Files The Server Installation log file is in the C:/Program Files/SharePointBWPlugin/logs directory. You can set tracing options in the tibcologlevel.ini file. The default log level is INFO. For example: [Tibco.SharePoint2010.Log.Config] LogLevel=INFO The log level can be DEBUG, INFO, WARNING, or ERROR. If you set the log level as DEBUG, the general information, error message, and warning message will be all displayed in the log file. If you set the log level as ERROR, all the information will not be displayed in the log file.

63 Index A authentication method 12 B batch operation add 19 delete 27 update 23 C CAML source 31 input CAML 31, 35 simple CAML 31, 35 customer support xv J JMS configuration 43 JMS destination configuration 46 JNDI Context Factory 13 JNDI Context URL 13 N Notification Configuration Management tool 41 notification type 16 event handler 16 refresh data 16 P paging feature 30 palette overview 10 D delete batch operation 27 Q query scope 34 E event handler configuration 47 event handling 15 R refresh data 15

64 Index S shared resource 11 SharePoint Add ListItem 19 SharePoint Delete ListItem 27 SharePoint event 17 SharePoint metadata tool 6 SharePoint Notification Listener 15 SharePoint Query 34 SharePoint Select ListItem 30 SharePoint shared connection 11 SharePoint Update ListItem 23 support, contacting xv T technical support xv TIBCO ActiveMatrix BusinessWorks 50 TIBCO Designer 50 TIBCO_HOME xiii Topic Connection Factory 13 U update batch operation 23