EMC Documentum Connector for Microsoft SharePoint Add-in

Transcription

1 EMC Documentum Connector for Microsoft SharePoint Add-in Version 7.2 Configuration Guide EMC Corporation Corporate Headquarters Hopkinton, MA

2 Legal Notice Copyright EMC Corporation. All Rights Reserved. EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. Adobe and Adobe PDF Library are trademarks or registered trademarks of Adobe Systems Inc. in the U.S. and other countries. All other trademarks used herein are the property of their respective owners. Documentation Feedback Your opinion matters. We want to hear from you regarding our product documentation. If you have feedback about how we can make our documentation better or easier to use, please send us your feedback directly at ECD.Documentation.Feedback@emc.com

3 Table of Contents Preface... 5 Chapter 1 Configuring the dctm.config File... 7 Configuring Content Transfer Modes of Connector for SharePoint... 7 Configuring Connector for SharePoint to Support the ClickOnce UCF Client... 7 Configuring Connector for SharePoint to Support the WebDirect Client... 8 Configuring Connector for SharePoint to Support the Mtom Client... 8 Enabling Ajax... 8 Configuring Display of Custom Attributes... 8 Limiting the List of Folder Types on the New Folder Page... 9 Limiting the List of Document Types on the New Document Page... 9 Limiting the List of Object Types on the Advanced Search Page Hiding Cabinets Setting Object Types for Simple Search Configuring the Search App Part Faceted Search Enabling Multiple Files Upload Uploading Large File Configuring Version Options for Document Checkin Setting ACS for Content Transfer Limiting the List of Object Types Based on User Group Membership Controlling Actions Available on the Move/Copy/Link Page Configuring the Properties Page Setting Column Widths, Filters, and Item Count Caching Data Clearing Cache Encrypting Passwords for the Configuration File Chapter 2 Configuring Menus Menu Qualifiers Context Menus Dynamic Menus Chapter 3 Configuring Actions Creating a Custom Action Sample Component Action Sample Page Action

4 Table of Contents Chapter 4 Setting Site-Based Configuration Files Upgrading to Site-Based Configurations Chapter 5 Configuring Data Services Data Services Settings Configuring the Version Settings for New Files for Check in to Documentum Configuring the Version Settings for Checked Out Files for Check in to Documentum Limiting Folders and Cabinets for Uploading Documents Configuring Automatic Data Services Configuring Automated Move/Copy/Link

5 Preface Intended Audience This document is intended for system administrators who are responsible for configuring EMC Documentum Connector for Microsoft SharePoint Add-in. You must have the working knowledge of EMC Documentum Content Server and Microsoft SharePoint to use this document. Revision History Revision Date February 2016 December 2015 Description Added section Configuring Content Transfer Modes of Connector for SharePoint, page 7. Added a note in the section Configuring Automated Move/Copy/Link, page 31. Initial publication. 5

6 Preface 6

7 Chapter 1 Configuring the dctm.config File To configure the general settings of Connector for SharePoint Add-in, edit the dctm.config file located at: C:\inetpub\wwwroot\<yoursite>\_layouts\Documentum. Configuring Content Transfer Modes of Connector for SharePoint There are three content transfer modes that can be configured to the connectors of Sharepoint. Configuring Connector for SharePoint to Support the ClickOnce UCF Client To configure the content transfer mode to ClickOnce UCF Client, follow the below steps: For ClickOnce UCF Client 7.0: <content_transfer_mode value="clickonce" statussynctimespan="1" maxretrycount="60" /> If you deployed the ClickOnce UCF Client to a standalone website, configure the content transfer mode as the following: <content_transfer_mode value="clickonce" clickoncehost="<clickonce package access uri>" statussynctimespan="1" maxretrycount="60"/> The following are the details about the attributes: clickoncehost: The full URI string to access the ClickOnce UCF Client package. For DFS 7.0 or later, use Check the physical path setting in IIS Manager if you are not sure about the URI string. statussynctimespan: The time span interval, in seconds, to synchronize the document checkout status between the ClickOnce UCF Client and the Connector for SharePoint application. maxretrycount: Indicates the maximum times that Connector for SharePoint synchronizes the document checkout status. 7

8 Configuring the dctm.config File Configuring Connector for SharePoint to Support the WebDirect Client To configure the content transfer mode to WebDirect Client, follow the below steps: For WebDirect Client: <content_transfer_mode value=" WebDirect" statussynctimespan="1" maxretrycount="60"/> Configuring Connector for SharePoint to Support the Mtom Client To configure the content transfer mode to Mtom Client, follow the below steps: For Mtom Client: <content_transfer_mode value="mtom"/> Enabling Ajax Ajax is a web development technique for creating asynchronous web applications. Ajax allows a web page to exchange data with a server asynchronously, that is, parts of the web page are updated without reloading the whole page. Enabling Ajax enhances the user experience of the Connector for SharePoint App Parts, especially, when you add multiple App Parts to a page. When Ajax is enabled, most operations use a partial page reload, hence, the operations update only those parts of a page that require updates. When Ajax is disabled, most operations use a full page reload. The properties page also uses Ajax to display the properties in tabs. If Ajax is disabled, the properties page lists all the properties in a table format. To enable or disable Ajax, modify the value of the <enableajax> element. <enableajax value="true"/> Configuring Display of Custom Attributes The DmGridViewColumns tag contains properties that allows you to add to the display columns of the grid view. The following are the default values of the DmGridViewColumns tag: <DmGridViewColumns> <column columntext="name" attributename="object_name" width="" datatype="string" isrepeating="false" isreadonly="true" /> <column columntext="created" attributename="r_creation_date" width="" datatype="date" isrepeating="false" isreadonly="false" /> <column columntext="locked By" attributename="r_lock_owner" width="" datatype="string" isrepeating="false" isreadonly="false" /> <column columntext="version" attributename="r_version_label" width="" 8

9 Configuring the dctm.config File datatype="string" isrepeating="true" isreadonly="false" /> <column columntext="title" attributename="title" width="" datatype="string" isrepeating="false" isreadonly="false" /> <column columntext="type" attributename="r_object_type" width="" datatype="string" isrepeating="false" isreadonly="false" /> </DmGridViewColumns> After you add a new property to the DmGridViewColumns tag, the App Part configuration displays the new column in the list of available columns. The columns to be displayed can be selected by modifying the App Part after deployment, without updating the configuration file. To add a new column, in the App Part configuration, select the document type and attribute, and click Add. Limiting the List of Folder Types on the New Folder Page To specify the list of folder types available for the user to select, use the <NewFolderFilter> tag on the New Folder page. For example, the following <NewFolderFilter> tag specifies that you can provide only the dm_folder folder type on the New Folder page: <NewFolderFilter> <FolderType value='dm_folder' /> </NewFolderFilter> To display all the folder types, leave the <NewFolderFilter> tag empty. Limiting the List of Document Types on the New Document Page To specify the list of document types available for the user to select, use the <NewDocumentFilter> tag on the New Document page. For example, the following <NewDocumentFilter> tag specifies that you provide only the dm_document document type on the New Document page: <NewDocumentFilter> <DocumentType value='dm_document' /> </NewDocumentFilter> To display all the document types, leave the <NewDocumentFilter> tag empty. 9

10 Configuring the dctm.config File Limiting the List of Object Types on the Advanced Search Page You can use the <AdvancedSearchTypeFilter> tag to specify the list of object types for users to select on the Advanced Search page. For example, the following <AdvancedSearchTypeFilter> tag specifies to list only the dm_document object type on the Advanced Search page. <AdvancedSearchTypeFilter> <SearchType value="dm_document" label="document" /> </AdvancedSearchTypeFilter> Hiding Cabinets To hide a list of cabinets when users browse a Documentum repository, perform the following : <HiddenCabinets> <!-- cabinet name="hideme" /--> </HiddenCabinets> Setting Object Types for Simple Search You can use the <SimpleSearchTypeFilter> tag to specify object types to list in the simple search page. <SimpleSearchTypeFilter> <SearchType value="dm_document" label="dm_document" /> </SimpleSearchTypeFilter> The <SearchType> tag specifies the value and label of an object type. By default, the simple search returns results for the object type and all its subtypes. You can use the excludesubtypes attribute to exclude certain subtypes from an object type. List the subtypes you want to exclude separated by commas. For example, to exclude subtype1 and subtype2, use excludesubtypes= subtype1,subtype2. You can also use negative exclusion by adding a - before the name of a subtype. For example, the value excludesubtypes="-subtype1, -subtype2" excludes everything that is not subtype1 or subtype2. If you leave the <SimpleSearchTypeFilter> tag empty, the simple search page lists dm_sysobject as the object type. Configuring the Search App Part In the <SearchWebPart> tag, you can set whether the options for full-text search, searching all versions, and searching hidden objects are visible for users to select. 10

11 Configuring the dctm.config File <show_fulltext value="true" /> <show_versions value="true" /> <show_hidden value ="true" /> Use the <show_checkboxes> tag to set wether to display a checkbox next to each search result item in basic search. If you set to show checkboxes, users can select multiple items to run actions. <show_checkboxes value="true" /> Use the <max_export_count> tag to set the maximum number of search result items a user can export to a Microsoft Excel file. <max_export_count value="1000" /> The valid range of the value is from 1 to 4,294,967,295. If you enter an invalid value, the default value 1000 is used. Faceted Search If you have EMC Documentum xplore installed on the Content Server, you can set whether to use xplore to search and show xplore search facets in the results of the simple search and advanced search. <show_facetedsearch value="false" /> <facets> <facet attribute="dmftmetadata//r_full_content_size" displayname="file Size" type="number" sortorder="frequency" dategrouping="" initialsize="1" > <ranges> <range label="0~999" min="0" max="999" /> <range label="1000~10000" min="1000" max="10000" /> </ranges> </facet > <facet attribute="dmftmetadata//r_modify_date" displayname="modify Date" type="date" sortorder="frequency" dategrouping="month" initialsize="1" /> <facet attribute="dmftmetadata//r_modifier " displayname="modifier " type="string" sortorder="" dategrouping="" initialsize="1" /> </facets> The following table provides description about the tags and attributes you can use to configure the search facets: Tags/Attributes Values Description show_facetedsearch true false Specifies whether to use xplore to search and show the xplore search facets in the results of the simple search and advanced search. attribute attribute xpath Specifies the xpath to the facet. displayname string Sets the facet name to display in search results. 11

12 Configuring the dctm.config File Tags/Attributes Values Description type number string date Specifies the facet type, which must be the same with the setting in Documentum xplore. sortorder FREQUENCY (default) VALUE_ASCENDING VALUE_DESCENDING NONE dategrouping day, week, month, quarter, year, relative date in Microsoft Outlook style Sets the sorting order in the facet. Sets the facet type date. initialsize string Specifies the number of facet values to display. ranges/range number Specifies the facet type number. Enable indexing for an object type in xplore before you enable full-text search or faceted search for the object type in Connector for SharePoint. The EMC Documentum xplore Administration and Development Guide provides information about enabling index for an object type. Enabling Multiple Files Upload The Browse App Part and Home Cabinet App Part provide the Multiple Files Upload control that enables uploading multiple documents to a Documentum repository at the same time. The Multiple Files Upload control appears as a link after users click Upload in the Browse App Part or Home Cabinet App Part. The <ShowMultiUpload> element under <UploadProfile> determines if you can enable the Multiple Files Upload control: <UploadProfile> <ShowMultiUpload value="true"/> </UploadProfile> Uploading Large File For uploading large files, ensure that you configure the following: In the web.config file locate the node <httpruntime targetframework = 4.5 maxrequestlength = In the command prompt run: %windir%\system32\inetsrv\appcmd set config "SDFOnline" -section:requestfiltering 12

13 Configuring the dctm.config File -requestlimits.maxallowedcontentlength: To verify the changes, in IIS Manager > navigate to Sites > click on your Provider Host site > select Request Filtering > click the Rules tab > click Edit Feature settings and verify the Maximum allowed content length (Bytes) is set as per the configuration done previously. Configuring Version Options for Document Checkin When you check in a document to a Documentum repository, Connector for SharePoint provides the following options for saving the document: Same version Next minor version Next major version You can also convert the new version to the current version. Use the <CheckIn> tag to configure version options for document checkin: <CheckIn> <EnableNonCurrentCheckIn value="true"/> <EnableSameVersion value="true" /> </CheckIn> The <EnableNonCurrentCheckIn> tag specifies if you can enable a new document version as a non-current version. If you set the value to false, the Make this the current version option is disabled and Connector for SharePoint always makes the new version as the current version. The <EnableSameVersion> tag specifies if you can enable checking in a document as the same version of the existing document. If you set the value to false, the same version checkbox is disabled and documents must be checked in as the next version. Setting ACS for Content Transfer You can choose to configure Connector for SharePoint to use the Accelerated Content Services (ACS) server to transfer content between Documentum Content Server and the SharePoint server. An ACS server is a lightweight server that is automatically created during a Content Server installation. The ACS server reads and writes content for web-based client applications using HTTP and HTTPS protocols. Use the <ContentProfileUrlReturnPolicy> element to configure settings for ACS content transfer. <ContentProfileUrlReturnPolicy value="prefer" /> 13

14 Configuring the dctm.config File The <ContentProfileUrlReturnPolicy> element accepts the following values: NEVER: Never use ACS. Connector for SharePoint always transfers content in a SOAP message. ALWAYS: Always transfer content using ACS. If the content cannot transfer using ACS, Connector for SharePoint returns an exception. ONLY: Only transfer content using ACS. If the content cannot be transferred using ACS, Connector for SharePoint returns no content in the web services call. PREFER: Use ACS if ACS is available. If ACS is not available, Connector for SharePoint transfers content in a SOAP message. If the Documentum Content Server is configured to use ACS, Connector for SharePoint always uses ACS unless you set the value to NEVER. To use ACS, Documentum Content Server and the SharePoint server must be able to communicate over the ACS port. If you see corrupted files when you download documents, it is possible that Connector for SharePoint is unable to transfer content using the current setting. For example, some default installations of SharePoint 2010 have issues with content transfer in SOAP messages. You can try values other than NEVER. If you see corrupted files when using ACS content transfer, ensure that the ports ACS that uses are open between the SharePoint server and ACS servers, which is typically 9080 in a default installation. Limiting the List of Object Types Based on User Group Membership Use the <SelectionLists> tag to set the object type lists based on the user group membership. <SelectionLists> <Folders> <list user_group="admingroup2" folder_path="/administrator/pbkwf1"> <item label_text="folder" type_name="dm_folder"/> <item label_text="test Folder" type_name="dm_testfolder" /> </list> <list user_group="admingroup2" folder_path="/administrator"> <folder label_text="folder1a" type_name="dm_folder" /> <folder label_text="test Folder1B" type_name="dm_testfolder" /> </list> <list user_group="admingroup2" folder_path="/administrator"> <folder label_text="folder2a" type_name="dm_folder" /> <folder label_text="test Folder2B" type_name="dm_testfolder" /> </list> <list user_group="admingroup3" folder_path="/administrator"> <folder label_text="folder3a" type_name="dm_folder" /> <folder label_text="test Folder3B" type_name="dm_testfolder" /> </list> </Folders> <Documents> <list user_group="admingroup2" folder_path="/administrator/pbkwf1"> <item label_text="documenta" type_name="dm_document"/> <item label_text="test DocA" type_name="dm_testdoc" /> </list> <list user_group="admingroup2" folder_path="/administrator"> <item label_text="documentb" type_name="dm_document" /> <item label_text="test DocB" type_name="dm_testdoc" /> 14

15 Configuring the dctm.config File </list> </Documents> <Search> <list user_group="admingroup2"> <item label_text="searchdocumenta" type_name="dm_document"/> <item label_text="searchfoldera" type_name="dm_folder" /> </list> </Search> </SelectionLists> The Folders tag affects the New Folder page. The Documents tag affects the File Upload, Multi File Upload, and New Document pages. The Search tag affects the Advanced Search page. The user_group attribute is required for each list. The user must be a member of the group for the list to be activated. You can set an optional folder_path attribute for the Folders and Documents tags, which adds an additional check so the list can be set according to user group memberships, but limited to certain folders only. For folder_path, use the full text path of the folder in the following format: /cabinet/folder. If the folder_path attribute is set, you can set multiple lists with the same user_group. If no folder_path attribute is set and multiple user_group attributes exist with the same group name, Connector for SharePoint uses the first user_group attribute. The Search tag only requires the user_group attribute. Connector for SharePoint evaluates the <SelectionLists> filtering before evaluating any other filtering. If you also set <NewDocumentFilter>, <NewFolderFilter>, or <AdvancedSearchTypeFilter>, Connector for SharePoint evaluates these lists after <SelectionLists> and the results affect the configuration of <SelectionLists>. Controlling Actions Available on the Move/Copy/Link Page When you right-click a document and select Add To Clipboard, the Move/Copy/Link page appears and you can select to move, copy, or link the document. Use the MoveCopyLinkPage tag to show or hide each action and set the default action. <MoveCopyLinkPage> <ShowCopy value="true"/> <ShowMove value="true"/> <ShowLink value="true"/> <DefaultSelection value="copy"/> </MoveCopyLinkPage> Configuring the Properties Page In the PropertiesPage tag, you can determine whether to display the permissions on the Properties page and whether to display all the properties as read-only. <PropertiesPage> <ShowPerms value="true"/> <ReadOnlyProperties value="false" /> 15

16 Configuring the dctm.config File </PropertiesPage> Setting Column Widths, Filters, and Item Count Use the <show_filter_results> tag to enable users to set the column width, filter by columns, and display the resulting item count. <show_filter_results value="true" /> Caching Data Connector for SharePoint caches the following data: Authentication information Object type information Menus and actions configuration Browsing data The <Cache> element defines the cache configuration and cache timeout. <Cache> <UseAuthenticationCache value="true" timeout="30"/> <UseTypeCache value="true" timeout="30"/> <UseLookupQueryCache value="true" timeout="30"/> <UseContentCache value="true" timeout="30"/> </Cache> The following table lists the details about the elements you can use for caching data: Tag <UseAuthenticationCache> <UseTypeCache> <UseLookupQueryCache> <UseContentCache> Description Caches the authentication information. If you use ticketed login, Connector for SharePoint caches the ticket and the username from Documentum for the current SharePoint user. Caches the object types and their hierarchy from the repository. Caches DQL query results. Not every DQL query is cached. Caches the browsing data for cabinets, folders, documents, and subscriptions. If you enable <UseContentCache>, some of the configuration changes you make might not take effect until the cache reaches the timeout value. 16

17 Configuring the dctm.config File The timeout attribute determines the amount of time before the expiration of the cached data. The timeout value must be in minutes. Setting the timeout value to zero disables the cache. Clearing Cache Use one of the following methods to manually clear the cached data: Executing the cache clear page by entering /ClearCache.aspx in a web browser Running the Cache_Cleanup_Tool.exe command located in C:\inetpub\wwwroot \<yoursite>\_layouts\documentum. Use the <username> <password> <url> arguments to call the cache clean page. You can schedule a task to run this command on a regular basis using various methods, for example, the Windows Task Scheduler. Running iisreset on SharePoint servers Encrypting Passwords for the Configuration File Use the sdf_encrypt_password.exe utility to encrypt passwords for use by Connector for SharePoint. You can find this utility in C:\inetpub\wwwroot\<yoursite>\_layouts \Documentum. After you run this utility, enter your password to encrypt and copy the entire result into the dctm.config file. You must include the SDF_ENCR_PASS= portion of the encrypted string, which tells Connector for SharePoint to decrypt the password. 17

18 Configuring the dctm.config File 18

19 Configuring Menus Chapter 2 When a user right-clicks an object in a Connector for SharePoint App Part, the context menu appears and provides available actions. The dc4m_menu.xml file controls the action items that appear when you right-click an object in Connector for SharePoint App Parts. You can find the dc4m_menu.xml file in the following location: The C:\inetpub\wwwroot\<yoursite>\_layouts\Documentum directory after you install Connector for SharePoint Menu Qualifiers You must define menu qualifiers in the <Qualifiers> tag before you create menu conditions. Menu qualifiers determine when a menu item appears based on the user or object properties. The following are the default menu qualifiers defined in the dc4m_menu.xml file: <Qualifiers> <Qualifier name ="issubscribed" classname="emc.documentum.sharepoint.menus.subscriptionsmenuqualifier" /> <Qualifier name ="ischeckedouttome" classname="emc.documentum.sharepoint.menus.checkedtomequalifier" /> <Qualifier name ="ischeckedout" classname="emc.documentum.sharepoint.menus.checkedoutqualifier" /> <Qualifier name ="hasrole" classname="emc.documentum.sharepoint.menus.rolebasequalifier" /> <Qualifier name ="canedit" classname="emc.documentum.sharepoint.menus.caneditqualifier" /> </Qualifiers> The following table contains detailed description about the default menu qualifiers: Name Description Example issuscribed ischeckedouttome ischeckedout Determines whether the user is currently subscribed to an object. Determines whether a document is checked out by the current user. Determines whether a document is checked out. issubscribed=false ischeckedouttome=false ischeckedout=false 19

20 Configuring Menus Name Description Example hasrole canedit Specifies that a user is a member of a specific group. Determines whether a user can edit a document. hasrole(record_manager) canedit=false Context Menus The <ContextMenus> tag in the dc4m_menu.xml file defines the menu items for different object types. The following example shows some of the menu items defined for the dm_document object type: <ContextMenu name="_dmdocumentmenu" objecttype="dm_document" > <MenuItem labelnlsid= "ContextMenu_Open" id="_docmenuitemview" actionname="viewdoc" image="blank" /> <MenuItem labelnlsid= "ContextMenu_EditDocument" id="_docmenuitemedit" actionname="editdoc" image="edit_document"/> <Separator /> <MenuItem labelnlsid= "ContextMenu_CheckOut" id="_docmenuitemcheckout" actionname="checkout" qualifiers="ischeckedout=false" image="checkout" />... </ContextMenu> The following table describes the tags and attributes you can use to define menu items: Tag/Attribute <ContextMenu> <MenuItem> actionname Description Defines menu items for an object type in Documentum. Each <ContextMenu> tag must have a unique name. The objecttype attribute specifies the object type for which you want to define menu items. When a user right-clicks an object, the menu builder starts to search for an exact match of the object type in the dc4m_menu.xml file. If the menu builder does not find an exact match, it uses the default context menu for the object. Defines a menu item. You must specify a unique ID for each <MenuItem> tag. Defines the action for a menu item. Chapter 3, Configuring Actions, provides details on configuring actions. 20

21 Configuring Menus Tag/Attribute qualifiers image Description References a menu qualifier defined in the <Qualifiers> tag. You can combine qualifier references with a + as the AND operator and a as the OR operator. However, you cannot use the AND and OR operators at the same time. Use a value like ischeckedout=false to specify that the negative of a condition is true. Specifies the image to apply to a menu item. The value of the image attribute can be a relative URL or the name of a standard image. Dynamic Menus Dynamic menus are built at runtime and the menu items vary according to different conditions. You create dynamic menus within the <SubMenu> tag. The following is an example of dynamic menu defined in the dc4m_menu.xml file: <SubMenu labelnlsid ="ContextMenu_WorkflowSubMenu" > <DynamicMenu name ="workflows" id="_docmenuitemworkflow"/> </SubMenu> The <SubMenu> tag can use the same attributes as the <MenuItem> tag. The <DynamicMenu> tag defines that the Workflow menu is generated based on a query of available workflows for the user. If no results are returned, then the Workflow menu is not generated. Use the <DynamicMenuProviders> tag to define the conditions that the <DynamicMenu> tag can reference to build dynamic menus. <DynamicMenuProviders> <DynamicMenuProvider name ="workflows" classname="emc.documentum.sharepoint.menus.workflowdynamicmenugenerator"/> <DynamicMenuProvider name ="renditionformats" classname="emc.documentum.sharepoint.menus.renditionformatsprovider"/> </DynamicMenuProviders > 21

22 Configuring Menus 22

23 Configuring Actions Chapter 3 When you create a context menu item, you must define an action upon which the menu item calls. Use the dc4m_actions.xml file to define actions. You can find the dc4m_menu.xml file in the following location: The C:\inetpub\wwwroot\<yoursite>\_layouts\Documentum directory after you install Connector for SharePoint There are two types of actions: component actions and page actions. Component actions do not require any interaction from the user. One example of component actions is creating a subscription. When the action is completed, the user returns to the current view. Page actions redirect the browser to a.aspx page that requires the user to create an interactive component. Examples of page actions are the properties page and the start workflow page. If you create an action that has the same name as one of the standard Connector for SharePoint actions defined in the dc4m_menu.xml file, the action is called in preference to the standard action. Creating a Custom Action You can find sample actions in the DC4SP Sample Customization Project supplied with Connector for SharePoint. The project requires Microsoft Visual Studio You also need to download and install the WSPBuilder tool. Sample Component Action The following code fragment shows an example of an action that sets the title property of an object. The code implements the IDc4mAction interface, which is contained within the assembly EMC.Documentum.DC4MOSS.WebParts. This assembly must be referenced by any extension project. public class MyCustomAction : IDc4mAction { public bool Execute(Dfs dfsconnection, IDictionary<string, string> arguments) { try { PropertySet props = new PropertySet(); props.set("title", "My Custom Action did this"); 23

24 Configuring Actions dfsconnection.updateproperties(arguments["objectid"], props); } catch (Exception ex) { dfsconnection.logger.error("failed to set property",ex); return false; } } return true; public string GetMessage() { return "Action Succeeded"; } } The code sample uses a utility class called DFS that provides some simplified actions, but any DFS call can be made by using the dfs.getservicecontext to retrieve the DFS service context and then following the standard DFS methodology. The EMC Documentum Documentum Foundation Services Development Guide and the DFS SDK provide details about DFS services. When the class has been compiled and packaged into an assembly, it must be placed in the Global Assembly Cache (GAC) and then can be referenced from the dc4m_actions.xml file. <Action name = "custom" > <Component class = "EMC.Documentum.SharePoint.Samples.MyCustomAction" assembly ="EMC.Sharepoint.DC4MOSS.Sample.Actions, Version= , Culture=neutral, PublicKeyToken=14d0b18508fb4038" /> </Action> Note: The assembly name must be the full name of the assembly instead of just the DLL name. Sample Page Action An alterative mechanism for extending the actions is to provide a custom page. This page must use a code behind module with a class that is derived from the base class Dc4mPageBase. The DC4SP Sample Customization Project provides the following example: public class CustomPage : Dc4mPageBase { public override void SetMainContent() { if (!ConnectToDocbase()) { throw new DC4MException (ResourceManager.GetLocalString("General_Connection_failure")); } List<String> propertiesrequested = new List<string>(); DataPackage objdp = dfs.getsysobject(getobjectid()); //get the DataObject from the DataPackage DataObject document = objdp.dataobjects[0]; Table demotable = new Table(); 24

25 Configuring Actions TableRow headerrow = new TableRow(); TableCell headercell = new TableCell(); Label label = new Label(); label.text = "Custom page called for document " + document.properties.get("object_name").getvalueasstring(); headercell.controls.add(label); headerrow.cells.add(headercell); TableRow buttonrow = new TableRow(); TableCell buttoncell = new TableCell(); Button closebtn = new Button(); closebtn.text = "Close"; closebtn.click += new EventHandler(closeBtn_Click); buttoncell.controls.add(closebtn); buttonrow.cells.add(buttoncell); demotable.rows.add(headerrow); demotable.rows.add(buttonrow); } _mainph.controls.add(demotable); The class implements the abstract member SetMainContent. The standard.aspx file has placeholder PlaceHolderMain, which corresponds to the inherited _mainph property. In this example, the code adds a table containing the object name of the document and a button to return the calling page. The Documentum object ID is retrieved from the member GetObjectId, which is passed automatically by the framework. When the button is pressed, the browser is redirected back to the calling page using the function ReturnToCallingPage. void closebtn_click(object sender, EventArgs e) { ReturnToCallingPage(); } 25

26 Configuring Actions 26

27 Chapter 4 Setting Site-Based Configuration Files You can configure Connector for SharePoint to use site-based dctm.config files, hence, each SharePoint site can have its own dctm.config file. When you open a SharePoint site, Connector for SharePoint first searches for a site-based dctm.config file. If there is no site-based dctm.config file specified, Connector for SharePoint uses the default dctm.config file, located at: C:\inetpub\wwwroot\<yoursite>\_layouts\Documentum. To create a site-based dctm.config file, copy the default dctm.config file and add the site-based settings. For configuring site specific logs, configuration file DC4SP.LogConfig.xml should be placed at the same location as the location of site specific dctm.config. Use the sdf_config_site_mapping.config file to configure site-based dctm.config files. The sdf_config_site_mapping.config file is available at: The C:\inetpub\wwwroot\<yoursite>\_layouts\Documentum directory after you install Connector for SharePoint The following example shows the default settings in the sdf_config_site_mapping.config file: <configuration> <SiteConfigurations> <site searchtype="sitetitle" path="/mysite" configfile="siteconfigs/mysite/dctm.config"/> <site searchtype="sitetitle" path="/sitea/subsitea/subsiteab" configfile="siteconfigs/subsiteab/dctm.config"/> <site searchtype="sitetitle" path="/sitea/subsitea" configfile="siteconfigs/subsitea/dctm.config"/> <site searchtype="sitetitle" path="/sitea" configfile="siteconfigs/sitea/dctm.config"/> </SiteConfigurations> </configuration> Each <site> tag defines a SharePoint site and the location of the site-based dctm.config file. The following table lists the attributes you can use with the <site> tag: Attribute searchtype Description Specifies the attribute that Connector for SharePoint uses to search for the SharePoint site. You can use one of the following values: sitetitle Use the title of the site. siteurl Use the URL of the site. 27

28 Setting Site-Based Configuration Files Attribute path configfile Description Specifies the search path that corresponds to the search type you define. Specifies the location of the site-based dctm.config file. When you open a SharePoint site, Connector for SharePoint searches for an exact match of site title, name, or URL that you define in the sdf_config_site_mapping.config file. If there is no exact match available, Connector for SharePoint searches for a hierarchy that matches the parent site. If you define a site-based dctm.config file for the parent site, all the subsites use the same file. You can also use site-based menu, action, and property overriding configuration files. Connector for SharePoint searches for these configuration files in the same folder where the site-based dctm.config file is saved. Upgrading to Site-Based Configurations You can use the site-based configuration feature with an existing deployment of Connector for SharePoint. However, some settings that are affected by the configuration file for the Connector for SharePoint site are cached and therefore, you might not see the behavior of Connector for SharePoint change in your deployment. This behavior primarily impacts saved settings for App Parts in the App Part configuration in SharePoint. For non-ticketed login settings, Connector for SharePoint creates a cache file in the cache directory of the installation folder for each user. You can delete these files to remove the cached data. If you delete the files, you are required to enter the authentication data again. Other settings like the repository selection, when using the ticketed login are cached by SharePoint. If the new configuration offers new options, you will still need to modify the App Part to select those options and then take the advantage of the site-based settings. 28

29 Configuring Data Services Chapter 5 Connector for SharePoint provides data services for you to perform automatic or manual document operations between SharePoint libraries and Documentum. You must activate the following Connector for SharePoint features in a SharePoint site to enable data services: Check In to Documentum Allows you to check in documents manually from a SharePoint library to Documentum. Note: Check In to Documentum checks in the latest version and leaves the older checked-out versions of the document in checked-out state Transfer to Documentum by property update Automatically transfers documents to Documentum from a SharePoint library when users update a property. You can configure data services in the following ways: Configuring the dctm.config file for general settings: Setting the DFS connection parameters Setting document type filters for content transfer Configuring migration using the mossdctmmap.xml file To perform Checkout to SharePoint operation with Overwrite existing document selected, Cancel checkout operation will be applied to the document object which already has been checked out automatically when current file to be checked out has the same file name as the checked out file. Data Services Settings Use the <CheckinToDocumentum> tag to configure the data services setting in the dctm.config file. <CheckinToDocumentum> <NewDocumentFilter> <visible value="dm_document"/> </NewDocumentFilter> <show_move value="true" /> <show_copy value="true" /> <show_link value="true" /> <allowforcollaborationcheckin value="false" /> </CheckinToDocumentum> 29

30 Configuring Data Services The <NewDocumentFilter> tag controls the document types that are available on the Check In to Documentum page when you select Check In to Documentum from a document library. The <show_move>, <show_copy>, and <show_link> tags define whether to show the move, copy, link options on the Check In to Documentum page. The <allowforcollaborationcheckin> tag determines whether a user can check in a document that is not checked out by this user. If the value is true, a user can check in a document that is not checked out by this user as long as the user has the permission. Configuring the Version Settings for New Files for Check in to Documentum The <sameobjectnamecheckin overrideexisting="false" versionnumber="2" versionlabel="new Version" makecurrent="true /> tag can be used to control the version of new files being checked into Documentum. Ensure that the new file exists before checking in the file into Documentum. In case of manual check in, set the overrideexisting attribute to true to display the overrideexisting check box, else set it to false. By default, it is set to false. In case of auto check in, if override existing attribute is set to true it will allow to Version the existing object in Documentum if an object with the same name already exists. Set the versionnumber attribute to 1, 2 or 3. Both auto and manual check in use these three attributes to set the default value: 1 indicates same version, 2 indicates next minor, and 3 indicates next major. Configuring the Version Settings for Checked Out Files for Check in to Documentum You can use the < checkedoutfiles versionnumber="3" versionlabel="check" makecurrent="true"/ > tag to control the versioning of files being checked out and to be checked in back to Documentum. The version value can be configured before performing CheckIn to Documentum. When using the Manual CheckIn option, you can override the default set value in the CheckIn UI page. In the case of Auto CheckIn, you can check in the file by specifying the required the version in the configuration element. Set the versionnumber attribute to 1, 2 or 3. 1 indicates same version, 2 indicates next minor, and 3 indicates next major. 30

31 Configuring Data Services Limiting Folders and Cabinets for Uploading Documents By default, you can upload documents to all the folders and cabinets in a Documentum repository. You can use the <CabinetQuery> element to define a list of folders and cabinets to which users are allowed to upload documents. <CabinetQuery value="" /> The value must be a DQL query. For example, the following setting specifies that you can upload documents to only cabinets with sdf in the name. <CabinetQuery value="select object_name, r_version_label, r_lock_owner, r_creation_date, r_object_id, r_object_type, i_chronicle_id, a_content_type, r_is_virtual_doc from dm_cabinet where (UPPER(object_name) LIKE '%SDF%') order by object_name" /> Configuring Automatic Data Services The data services use a mapping file to control the configuration and how data is handled when moving from SharePoint to Documentum. The mapping file is available at: C:\inetpub\wwwroot \<yoursite>\_layouts\documentum\dataservices\docmaps\mossdctmmap.xml. The following are the minimal settings in the mossdctmmap.xml file to enable the data services Check In to Documentum page: <repository name="enter DOCBASE NAME HERE"> <doctypemap mosstype="enter MOSS CONTENT TYPE HERE (ex Document)"> <dctmtype>enter DOCUMENTUM DOCUMENT TYPE HERE (ex dm_document)</dctmtype> <variabledelimiter>$$</variabledelimiter> <targetpathexpr canoverride="false" createfolder-if-notexists="true" createfolder-type="dm_folder">enter LOCATION HERE</targetpathexpr> </doctypemap> </repository> If canoverride is set to false, the tree to select a folder is hidden and the path provided is used to check in the document. If canoverride is set to true, the tree is visible and you must choose a location to check in the document. Configuring Automated Move/Copy/Link The mossdctmmap.xml file determines what happens when a file is migrated to Documentum via the event pages or property-based automated migration site features. 31

32 Configuring Data Services Use the following tags and attributes to configure the data services behavior of Connector for SharePoint: repository: Sets the repository to use. doctypemap: Maps SharePoint object types to Documentum types. mosstype: Specifies the SharePoint object type. dctmtype: Specifies the Documentum object type. acl: Sets a specific ACL. If there is no <acl> tag specified, the data services use the default ACL. variabledelimiter: Specifies the delimiter used to indicate the use of a variable in the mapping file, for example, the target path. eventaction: Specifies the type of action to execute, such as move, copy, and link. condition: Specifies when to use the property change site feature. mossattribute: Specifies the attribute to check. value: Specifies the condition value. If the values match, then the action is taken. attributemap: Specifies a mapping of attribute data to migrate. attribute: Specifies the attribute data. If the value has variable delimiter at the beginning, then it is a SharePoint attribute. Otherwise, it is a constant value. documentumattribute: Specifies the Documentum attribute to migrate. mossattribute: Specifies the SharePoint attribute to migrate. targetpathexpr: Specifies the path of the target folder. The value can be a constant, a variable, or a mix. The following are the rules for setting the <targetpathexpr> tag: Separate parts using /. Do not start or end an expression with /. Four constant variables sitetitle, sourcefolder, documentsetname, libraryname must have the same delimiter as variabledelimiter at the beginning. Attribute names must have variabledelimiter at the beginning. Non-existing attributes is rejected in the path evaluation. The error message is logged. canoverride allows the manual checkin page to let the user pick the target location and override this setting. Note: For Data Services auto check in operation, the logged in client machine user should have access to share point and the Documentum repositories. 32