EMC Documentum ConnectorforMicrosoftSharePoint Add-in · EMC®Documentum®...

EMC® Documentum®

Connector for Microsoft SharePointAdd-inVersion 7.2

Configuration Guide

EMC CorporationCorporate Headquarters

Hopkinton, MA 01748-91031-508-435-1000www.EMC.com

Legal Notice

Copyright © 2013–2016 EMC Corporation. All Rights Reserved.

EMC believes the information in this publication is accurate as of its publication date. The information is subject to changewithout notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” EMC CORPORATIONMAKES NO REPRESENTATIONSOR WARRANTIES OF ANY KINDWITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLYDISCLAIMS 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 PDFLibrary are trademarks or registered trademarks of Adobe Systems Inc. in the U.S. and other countries. All other trademarksused 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 feedbackabout how we can make our documentation better or easier to use, please send us your feedback directly [email protected]

Table of Contents

Preface ................................................................................................................................ 5

Chapter 1 Configuring the dctm.config File .............................................................. 7Configuring Content Transfer Modes of Connector for SharePoint ....................... 7Configuring Connector for SharePoint to Support the ClickOnceUCF Client ................................................................................................... 7Configuring Connector for SharePoint to Support the WebDirectClient........................................................................................................... 8Configuring Connector for SharePoint to Support the Mtom Client.................. 8

Enabling Ajax................................................................................................... 8Configuring Display of Custom Attributes ......................................................... 8Limiting the List of Folder Types on the New Folder Page ................................... 9Limiting the List of Document Types on the New Document Page ....................... 9Limiting the List of Object Types on the Advanced Search Page ........................... 10Hiding Cabinets ............................................................................................... 10Setting Object Types for Simple Search............................................................... 10Configuring the Search App Part ....................................................................... 10Faceted Search.............................................................................................. 11

Enabling Multiple Files Upload ......................................................................... 12Uploading Large File .................................................................................... 12

Configuring Version Options for Document Checkin .......................................... 13Setting ACS for Content Transfer ....................................................................... 13Limiting the List of Object Types Based on User Group Membership ................... 14Controlling Actions Available on the Move/Copy/Link Page................................ 15Configuring the Properties Page ........................................................................ 15Setting Column Widths, Filters, and Item Count ................................................. 16Caching Data ................................................................................................... 16Clearing Cache ............................................................................................. 17

Encrypting Passwords for the Configuration File ................................................ 17

Chapter 2 Configuring Menus ...................................................................................... 19Menu Qualifiers ............................................................................................... 19Context Menus ................................................................................................. 20Dynamic Menus ............................................................................................... 21

Chapter 3 Configuring Actions .................................................................................... 23Creating a Custom Action ................................................................................. 23Sample Component Action............................................................................ 23Sample Page Action ...................................................................................... 24

3

Table of Contents

Chapter 4 Setting Site-Based Configuration Files ....................................................... 27Upgrading to Site-Based Configurations ............................................................ 28

Chapter 5 Configuring Data Services .......................................................................... 29Data Services Settings ....................................................................................... 29Configuring the Version Settings for New Files for Check in toDocumentum .............................................................................................. 30Configuring the Version Settings for Checked Out Files for Checkin to Documentum ....................................................................................... 30

Limiting Folders and Cabinets for Uploading Documents ................................... 31Configuring Automatic Data Services ................................................................ 31Configuring Automated Move/Copy/Link...................................................... 31

4

Preface

Intended AudienceThis document is intended for system administrators who are responsible for configuring EMCDocumentum Connector for Microsoft SharePoint Add-in. You must have the working knowledge ofEMC Documentum Content Server and Microsoft SharePoint to use this document.

Revision History

Revision Date Description

February 2016 • Added section Configuring Content Transfer Modes of Connectorfor SharePoint, page 7 .

• Added a note in the section Configuring AutomatedMove/Copy/Link, page 31.

December 2015 Initial publication.

5

Preface

6

Chapter 1Configuring the dctm.config File

To configure the general settings of Connector for SharePoint Add-in, edit the dctm.config filelocated at: C:\inetpub\wwwroot\<yoursite>\_layouts\Documentum.

Configuring Content Transfer Modes ofConnector for SharePointThere are three content transfer modes that can be configured to the connectors of Sharepoint.

Configuring Connector for SharePoint to Support theClickOnce 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 transfermode 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, usehttp://<server-name>:<port>/7.0/UcfWinClient.application

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 checkoutstatus between the ClickOnce UCF Client and the Connector for SharePoint application.

• maxretrycount: Indicates the maximum times that Connector for SharePoint synchronizes thedocument checkout status.

7

Configuring the dctm.config File

Configuring Connector for SharePoint to Support theWebDirect 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 theMtom Client

To configure the content transfer mode to Mtom Client, follow the below steps:

For Mtom Client:<content_transfer_mode value="mtom"/>

Enabling AjaxAjax is a web development technique for creating asynchronous web applications. Ajax allows a webpage to exchange data with a server asynchronously, that is, parts of the web page are updatedwithout reloading the whole page. Enabling Ajax enhances the user experience of the Connector forSharePoint 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 pagethat 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 propertiespage 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 AttributesThe DmGridViewColumns tag contains properties that allows you to add to the display columns ofthe 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


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 displaysthe new column in the list of available columns.

The columns to be displayed can be selected by modifying the App Part after deployment, withoutupdating the configuration file.

To add a new column, in the App Part configuration, select the document type and attribute, andclick Add.

Limiting the List of Folder Types on the NewFolder PageTo specify the list of folder types available for the user to select, use the <NewFolderFilter> tag onthe New Folder page. For example, the following <NewFolderFilter> tag specifies that you canprovide 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 theNew Document PageTo 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 specifiesthat 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

Limiting the List of Object Types on theAdvanced Search PageYou can use the <AdvancedSearchTypeFilter> tag to specify the list of object types for users toselect 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 CabinetsTo hide a list of cabinets when users browse a Documentum repository, perform the following :

<HiddenCabinets>

</HiddenCabinets>

Setting Object Types for Simple SearchYou can use the <SimpleSearchTypeFilter> tag to specify object types to list in the simplesearch 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 simplesearch returns results for the object type and all its subtypes. You can use the excludesubtypesattribute to exclude certain subtypes from an object type. List the subtypes you want toexclude separated by commas. For example, to exclude subtype1 and subtype2, useexcludesubtypes=“subtype1,subtype2”. You can also use negative exclusion by addinga - 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 listsdm_sysobject as the object type.

Configuring the Search App PartIn the <SearchWebPart> tag, you can set whether the options for full-text search, searching allversions, and searching hidden objects are visible for users to select.

10


<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 itemin 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 canexport 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 defaultvalue 1000 is used.

Faceted Search

If you have EMC Documentum xPlore installed on the Content Server, you can set whether to usexPlore 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 configurethe search facets:

Tags/Attributes Values Description

show_facetedsearch true | false Specifies whether to use xPlore tosearch and show the xPlore searchfacets in the results of the simplesearch and advanced search.

attribute attribute xPath Specifies the xPath to the facet.

displayname string Sets the facet name to display insearch results.

11


Tags/Attributes Values Description

type number | string | date Specifies the facet type, whichmust be the same with the settingin Documentum xPlore.

sortorder FREQUENCY (default) |VALUE_ASCENDING |VALUE_DESCENDING |NONE

Sets the sorting order in the facet.

dategrouping day, week, month, quarter,year, relative date in MicrosoftOutlook style

Sets the facet type date.

initialsize string Specifies the number of facetvalues 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 theobject type in Connector for SharePoint. The EMC Documentum xPlore Administration and DevelopmentGuide provides information about enabling index for an object type.

Enabling Multiple Files UploadThe Browse App Part and Home Cabinet App Part provide the Multiple Files Upload control thatenables uploading multiple documents to a Documentum repository at the same time. The MultipleFiles Upload control appears as a link after users click Upload in the Browse App Part or HomeCabinet App Part. The <ShowMultiUpload> element under <UploadProfile> determines if youcan 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 = “4194303”

• In the command prompt run:

%windir%\system32\inetsrv\appcmd set config "SDFOnline" -section:requestFiltering

12


-requestLimits.maxAllowedContentLength:4294967295

• To verify the changes, in IIS Manager > navigate to Sites > click on your Provider Host site > selectRequest Filtering > click the Rules tab > click Edit Feature settings and verify theMaximumallowed content length (Bytes) is set as per the configuration done previously.

Configuring Version Options for DocumentCheckinWhen you check in a document to a Documentum repository, Connector for SharePoint providesthe 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 anon-current version. If you set the value to false, theMake this the current version option isdisabled 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 sameversion of the existing document. If you set the value to false, the same version checkbox isdisabled and documents must be checked in as the next version.

Setting ACS for Content TransferYou 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 ACSserver is a lightweight server that is automatically created during a Content Server installation. TheACS server reads and writes content for web-based client applications using HTTP and HTTPSprotocols.

Use the <ContentProfileUrlReturnPolicy> element to configure settings for ACS contenttransfer.

<ContentProfileUrlReturnPolicy value="PREFER" />

13


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, Connectorfor SharePoint returns an exception.

• ONLY: Only transfer content using ACS. If the content cannot be transferred using ACS, Connectorfor SharePoint returns no content in the web services call.

• PREFER: Use ACS if ACS is available. If ACS is not available, Connector for SharePoint transferscontent in a SOAP message.

If the Documentum Content Server is configured to use ACS, Connector for SharePoint always usesACS unless you set the value to NEVER. To use ACS, Documentum Content Server and the SharePointserver must be able to communicate over the ACS port.

If you see corrupted files when you download documents, it is possible that Connector for SharePointis unable to transfer content using the current setting. For example, some default installations ofSharePoint 2010 have issues with content transfer in SOAP messages. You can try values otherthan NEVER.

If you see corrupted files when using ACS content transfer, ensure that the ports ACS that uses areopen between the SharePoint server and ACS servers, which is typically 9080 in a default installation.

Limiting the List of Object Types Based onUser Group MembershipUse 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></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


</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,MultiFile 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 thelist to be activated. You can set an optional folder_path attribute for the Folders and Documentstags, which adds an additional check so the list can be set according to user group memberships, butlimited to certain folders only. For folder_path, use the full text path of the folder in the followingformat: /cabinet/folder. If the folder_path attribute is set, you can set multiple lists withthe same user_group. If no folder_path attribute is set and multiple user_group attributesexist with the same group name, Connector for SharePoint uses the first user_group attribute. TheSearch tag only requires the user_group attribute.

Connector for SharePoint evaluates the <SelectionLists> filtering before evaluatingany 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 theMove/Copy/Link PageWhen you right-click a document and select Add To Clipboard, theMove/Copy/Link page appearsand 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 PageIn the PropertiesPage tag, you can determine whether to display the permissions on theProperties page and whether to display all the properties as read-only.

<PropertiesPage><ShowPerms value="true"/><ReadOnlyProperties value="false" />

15


</PropertiesPage>

Setting Column Widths, Filters, and Item CountUse 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 DataConnector 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 Description

<UseAuthenticationCache> Caches the authentication information. If you use ticketedlogin, Connector for SharePoint caches the ticket and theusername from Documentum for the current SharePointuser.

<UseTypeCache> Caches the object types and their hierarchy from therepository.

<UseLookupQueryCache> Caches DQL query results. Not every DQL query iscached.

<UseContentCache> Caches the browsing data for cabinets, folders, documents,and subscriptions. If you enable <UseContentCache>,some of the configuration changes you make might nottake effect until the cache reaches the timeout value.

16


The timeout attribute determines the amount of time before the expiration of the cached data. Thetimeout 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 http://<yourserver>/_layouts/Documentum/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 regularbasis using various methods, for example, the Windows Task Scheduler.

• Running iisreset on SharePoint servers

Encrypting Passwords for the ConfigurationFileUse the sdf_encrypt_password.exe utility to encrypt passwords for use by Connectorfor 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 resultinto 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

Chapter 2Configuring Menus

When a user right-clicks an object in a Connector for SharePoint App Part, the context menu appearsand provides available actions. The dc4m_menu.xml file controls the action items that appear whenyou right-click an object in Connector for SharePoint App Parts. You can find the dc4m_menu.xmlfile in the following location:

• The C:\inetpub\wwwroot\<yoursite>\_layouts\Documentum directory after you installConnector for SharePoint

Menu QualifiersYou must define menu qualifiers in the <Qualifiers> tag before you create menu conditions. Menuqualifiers 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 Determines whether the user iscurrently subscribed to an object.

isSubscribed=false

isCheckedoutToMe Determines whether a documentis checked out by the current user.

isCheckedoutToMe=false

isCheckedout Determines whether a documentis checked out.

isCheckedOut=false

19

Configuring Menus

Name Description Example

hasRole Specifies that a user is a memberof a specific group.

hasRole(record_manager)

canEdit Determines whether a user canedit a document.

canEdit=false

Context MenusThe <ContextMenus> tag in the dc4m_menu.xml file defines the menu items for different objecttypes. The following example shows some of the menu items defined for the dm_document objecttype:

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

<ContextMenu> 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 youwant to define menu items. When a user right-clicks an object, themenu builder starts to search for an exact match of the object typein the dc4m_menu.xml file. If the menu builder does not find anexact match, it uses the default context menu for the object.

<MenuItem> Defines a menu item. You must specify a unique ID for each<MenuItem> tag.

actionName Defines the action for a menu item. Chapter 3, ConfiguringActions, provides details on configuring actions.

20

Configuring Menus

Tag/Attribute Description

qualifiers References a menu qualifier defined in the <Qualifiers> tag.

You can combine qualifier references with a + as the ANDoperator and a | as the OR operator. However, you cannot usethe AND and OR operators at the same time. Use a value likeisCheckedOut=false to specify that the negative of a conditionis true.

image Specifies the image to apply to a menu item. The value of theimage attribute can be a relative URL or the name of a standardimage.

Dynamic MenusDynamic menus are built at runtime and the menu items vary according to different conditions. Youcreate dynamic menus within the <SubMenu> tag. The following is an example of dynamic menudefined 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> tagdefines that the Workflowmenu is generated based on a query of available workflows for the user. Ifno results are returned, then the Workflow menu is not generated.

Use the <DynamicMenuProviders> tag to define the conditions that the <DynamicMenu> tag canreference 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

Configuring Menus

22

Chapter 3Configuring Actions

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 thefollowing location:


There are two types of actions: component actions and page actions. Component actions do notrequire 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 browserto a .aspx page that requires the user to create an interactive component. Examples of page actionsare 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 actionsdefined in the dc4m_menu.xml file, the action is called in preference to the standard action.

Creating a Custom ActionYou can find sample actions in the DC4SP Sample Customization Project supplied with Connectorfor SharePoint. The project requires Microsoft Visual Studio 2008. You also need to download andinstall the WSPBuilder tool.

Sample Component Action

The following code fragment shows an example of an action that sets the title property of anobject. The code implements the IDc4mAction interface, which is contained within the assemblyEMC.Documentum.DC4MOSS.WebParts. This assembly must be referenced by any extensionproject.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

http://wspbuilder.codeplex.com/

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 callcan be made by using the dfs.GetServiceContext to retrieve the DFS service context and thenfollowing the standard DFS methodology. The EMC Documentum Documentum Foundation ServicesDevelopment 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 GlobalAssembly 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=1.0.0.0,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 acode 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

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 placeholderPlaceHolderMain, which corresponds to the inherited _mainPH property. In this example, the codeadds a table containing the object name of the document and a button to return the calling page. TheDocumentum object ID is retrieved from the member GetObjectId, which is passed automatically bythe framework.

When the button is pressed, the browser is redirected back to the calling page using the functionReturnToCallingPage.void closeBtn_Click(object sender, EventArgs e)

{ReturnToCallingPage();

}

25

Configuring Actions

26

Chapter 4Setting 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-baseddctm.config file specified, Connector for SharePoint uses the default dctm.config file, locatedat: C:\inetpub\wwwroot\<yoursite>\_layouts\Documentum. To create a site-baseddctm.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 atthe 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. Thesdf_config_site_mapping.config file is available at:


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. Thefollowing table lists the attributes you can use with the <site> tag:

Attribute Description

searchtype Specifies the attribute that Connector for SharePoint uses to search forthe 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

Setting Site-Based Configuration Files

Attribute Description

path Specifies the search path that corresponds to the search type you define.

configfile 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 exactmatch available, Connector for SharePoint searches for a hierarchy that matches the parent site. If youdefine 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. Connectorfor SharePoint searches for these configuration files in the same folder where the site-baseddctm.config file is saved.

Upgrading to Site-Based ConfigurationsYou can use the site-based configuration feature with an existing deployment of Connector forSharePoint. However, some settings that are affected by the configuration file for the Connector forSharePoint site are cached and therefore, you might not see the behavior of Connector for SharePointchange in your deployment. This behavior primarily impacts saved settings for App Parts in theApp Part configuration in SharePoint.

For non-ticketed login settings, Connector for SharePoint creates a cache file in the cache directory ofthe installation folder for each user. You can delete these files to remove the cached data. If you deletethe 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. Ifthe new configuration offers new options, you will still need to modify the App Part to select thoseoptions and then take the advantage of the site-based settings.

28

Chapter 5Configuring Data Services

Connector for SharePoint provides data services for you to perform automatic or manual documentoperations between SharePoint libraries and Documentum. You must activate the followingConnector for SharePoint features in a SharePoint site to enable data services:

• Check In to Documentum – Allows you to check in documents manually from a SharePointlibrary to Documentum.

Note: Check In to Documentum checks in the latest version and leaves the older checked-outversions of the document in checked-out state

• Transfer to Documentum by property update – Automatically transfers documents toDocumentum 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, Cancelcheckout operation will be applied to the document object which already has been checked outautomatically when current file to be checked out has the same file name as the checked out file.

Data Services SettingsUse the <CheckinToDocumentum> tag to configure the data services setting in the dctm.configfile.

<CheckinToDocumentum><NewDocumentFilter><visible value="dm_document"/></NewDocumentFilter><show_move value="true" /><show_copy value="true" /><show_link value="true" /><allowForCollaborationCheckIn value="false" />

</CheckinToDocumentum>

29

Configuring Data Services

The <NewDocumentFilter> tag controls the document types that are available on the Check In toDocumentum 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 documentthat is not checked out by this user. If the value is true, a user can check in a document that is notchecked out by this user as long as the user has the permission.

Configuring the Version Settings for New Files forCheck in to Documentum

The <sameobjectnamecheckin overrideexisting="false" versionnumber="2"versionlabel="new Version" makecurrent="true”/> tag can be used to control the versionof new files being checked into Documentum. Ensure that the new file exists before checking inthe file into Documentum.

• In case of manual check in, set the overrideexisting attribute to true to display theoverrideexisting 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 theexisting 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 threeattributes 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 Filesfor 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 bechecked in back to Documentum. The version value can be configured before performing CheckInto Documentum. When using the Manual CheckIn option, you can override the default set valuein the CheckIn UI page. In the case of Auto CheckIn, you can check in the file by specifying therequired 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


Limiting Folders and Cabinets for UploadingDocumentsBy 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 areallowed to upload documents.

<CabinetQuery value="" />

The value must be a DQL query. For example, the following setting specifies that you can uploaddocuments 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 ServicesThe data services use a mapping file to control the configuration and how data is handled whenmoving 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 servicesCheck 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 tocheck in the document. If canoverride is set to true, the tree is visible and you must choose alocation to check in the document.

Configuring Automated Move/Copy/Link

The mossdctmmap.xml file determines what happens when a file is migrated to Documentum viathe event pages or property-based automated migration site features.

31


Use the following tags and attributes to configure the data services behavior of Connector forSharePoint:

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

— variabledelimiter: Specifies the delimiter used to indicate the use of a variable in themapping 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 thebeginning, 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, librarynamemust 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 locationand override this setting.

Note: For Data Services auto check in operation, the logged in client machine user should have accessto share point and the Documentum repositories.

32

EMC Documentum ConnectorforMicrosoftSharePoint Add-in · EMC®Documentum®...

Documents

Transcript of EMC Documentum ConnectorforMicrosoftSharePoint Add-in · EMC®Documentum®...