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

Transcription

1 TIBCO ActiveMatrix BusinessWorks Plug-in for Microsoft SharePoint User s Guide Software Release 1.0 Feburary 2013 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, 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

3 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 Overview of Microsoft SharePoint Overview of the Plug-in Chapter 2 SharePoint Get Metadata Tool Overview of SharePoint Get Metadata Tool Getting Metadata Chapter 3 SharePoint Palette Palette Overview SharePoint Shared Connection Configuration SharePoint Notification Listener Configuration Misc Output Error Output SharePoint Add ListItem Configuration

4 iv Contents Input Output Error Output SharePoint Update ListItem Configuration Input Output Error Output SharePoint Delete ListItem Configuration Input Output Error Output SharePoint Select ListItem Configuration Input Output Error Output SharePoint Query Configuration Input Output Error Output Input Guidelines Chapter 4 Notification Configuration Management Overview of the Notification Configuration Management Tool JMS Configuration JMS Destination Configuration Event Handler Configuration Chapter 5 Getting Started Overview Creating a Project Configuring SharePoint Shared Connection Getting Metadata from Microsoft SharePoint Server Creating a Process Adding Activities to a Process Testing a Process Deploying a Project

5 Contents v Appendix A Configuring Log Files Configuring Plug-in Installation Log Files Configuring Server Installation Log Files Index

6 vi Contents

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

8 viii Figures

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

10 x Tables Table 29 Add JMS Configuration Information Table 30 JMS Destination Configuration Table 31 Event Handler Configuration Table 32 Log Parameters Plug-in Installation

11 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

12 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:

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

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

15 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 How to Access TIBCO Documentation You can access TIBCO documentation here: 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: If you already have a valid maintenance or support contract, visit this site: Entry to this site requires a user name and password. If you do not have a user name, you can request one.

16 xvi Connecting with TIBCO Resources

17 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

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

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

20 4 Chapter 1 Introduction

21 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

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

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

24 8 Chapter 2 SharePoint Get Metadata Tool

25 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

26 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

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

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

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

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

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

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

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

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

35 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

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

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

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

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

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

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

42 26 Chapter 3 SharePoint Palette

43 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