documentum connector for microsoft sharepoint 7.0 configuration guide

EMC® Documentum® Connector for

Microsoft SharePoint

Version 7.0

Configuration Guide

EMC Corporation Corporate Headquarters:

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

Copyright ©2013 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.

3

Table of Contents

OVERVIEW ............................................................................................................................................... 5

POINTS OF CONFIGURATION .................................................................................................................... 6

THE DCTM.CONFIG FILE .................................................................................................................................... 6 CONFIGURING DISPLAY OF CUSTOM ATTRIBUTES ................................................................................................... 6 ADDING WORKFLOWS TO THE MENU .................................................................................................................. 8 LIMITING THE LIST OF FOLDER TYPES ON THE NEW FOLDER PAGE ............................................................................... 8 LIMITING THE LIST OF DOCUMENT TYPES ON THE UPLOAD PAGE ................................................................................ 8 HIDING CABINETS............................................................................................................................................ 8 SEARCH WEBPART ........................................................................................................................................... 9 UPLOAD PROFILE ............................................................................................................................................ 9 CHECK IN ....................................................................................................................................................... 9 CONTENT PROFILE URL RETURN POLICY .............................................................................................................. 9 LIMITING THE LIST OF OBJECT TYPES BASED ON USER GROUP MEMBERSHIP ................................................................ 10 TASK DETAILS PAGE ....................................................................................................................................... 10 CONTROLLING THE ACTIONS AVAILABLE ON THE MOVE/COPY/LINK PAGE ................................................................. 11 PROPERTIES PAGE ......................................................................................................................................... 11 DISPLAY OF COLUMN WIDTHS, FILTERS, ITEM COUNT ............................................................................................ 11 DETERMINING THE LIST OF DATE FORMATS AVAILABLE TO CHOOSE FROM IN THE BROWSE WEBPART ............................... 11 SETTING THE WEB SERVICES TIMEOUTS .............................................................................................................. 12 SETTING THE OBJECT TYPES FOR SIMPLE SEARCH .................................................................................................. 12 SHOWING/HIDING THE DATA GRID CHECKBOXES .................................................................................................. 12 SETTING THE CONNECTOR FOR SHAREPOINT CONTENT CACHE TIMEOUT.................................................................. 13 DATA SERVICES SETTINGS ............................................................................................................................... 13 FEDERATED SEARCH WEBPART SETTINGS ........................................................................................................... 13

CONFIGURING THE CONNECTOR FOR SHAREPOINT MENU .................................................................... 14

CONTEXT MENUS .......................................................................................................................................... 14 MENU QUALIFIERS ........................................................................................................................................ 15

Sub Menus ........................................................................................................................................... 16 Dynamic Menus ................................................................................................................................... 16

CONNECTOR FOR SHAREPOINT ACTIONS ............................................................................................... 16

CREATING A CUSTOM ACTION ......................................................................................................................... 17 Sample Component Action ................................................................................................................... 17 Sample Page Action ............................................................................................................................. 18 Connecting a Custom Action to a Menu .............................................................................................. 19

CONNECTOR FOR SHAREPOINT CACHING .............................................................................................. 20

OVERRIDING PROPERTY CONTROLS ....................................................................................................... 21

SETTING A DYNAMIC STARTING POINT FOR THE BROWSE WEB PART .................................................... 22

SETTING A CONFIGURATION BASED ON THE SHAREPOINT SITE ............................................................. 24

ENCRYPTING PASSWORDS FOR THE CONFIG FILE ................................................................................... 26

SETTING DEFAULT LOCATION FOR ATTACHMENTS ................................................................................. 27

DATA SERVICES CONFIGURATION .......................................................................................................... 28

4

POINTS OF CONFIGURATION ............................................................................................................................ 28 THE DCTM.CONFIG FILE .................................................................................................................................. 28 LIMITING DOCUMENT TYPES ON CHECKIN TO DOCUMENTUM ................................................................................ 28

Controlling the actions available on the Move/Copy/Link page .......................................................... 28 Setting the web services timeouts ....................................................................................................... 29

THE MAPPING FILE ........................................................................................................................................ 29 CONFIGURE AUTOMATED MOVE/COPY/LINK ..................................................................................................... 30

CONFIGURATION WEBPART ................................................................................................................... 33

RIBBON CONFIGURATION ...................................................................................................................... 36

CONFIGURE INDIVIDUAL WEB PARTS ..................................................................................................... 39

REPOSITORIES............................................................................................................................................... 39 CONFIGURING THE DOCUMENTUM BROWSE WEB PART ....................................................................................... 39

Repository Configuration ..................................................................................................................... 39 Display Configuration .......................................................................................................................... 39 Maximum Number of Rows to Display ................................................................................................ 40 Display a Row for the Home Cabinet ................................................................................................... 40 Display a Row for Subscriptions ........................................................................................................... 40 Default Document Type to Display ...................................................................................................... 41 Columns to Display .............................................................................................................................. 41 Adding an Attribute to the Display ...................................................................................................... 41 Removing an Attribute from the Display ............................................................................................. 41 Changing the Order of Displayed Attributes ........................................................................................ 42

5

Overview

This manual is for system administrators and developers who want to configure the behavior and appearance of the EMC Documentum Connector for Microsoft SharePoint (Connector for SharePoint).

6

Points of Configuration

The Connector for SharePoint solution can be configured in a number of ways.

1. The configuration file dctm.config contains general settings for the solution components, such as

a. Setting the DFS connection parameters b. Available columns for the browsing c. Which workflows are available to be started from the browse web part d. Base group for selection of users for workflow delegation e. Document type filters for upload f. Document type filters for Advanced Search g. Formats available for rendition requests

2. Workflow configuration via XML files. This is described in the separate document called xCP Forms Configuration Guide.

3. Menu and action configuration through server side XML files. 4. Overriding property controls on forms. 5. Configure individual Web Parts.

The dctm.config File The Connector for SharePoint solution can be configured through XML file dctm.config which is located in the TEMPLATE\LAYOUTS\Documentum directory of the Solution Pack folder. And will be stored in the folder

(common files)\Microsoft Shared\web server extensions\12\template\layouts\Documentum when the solution is deployed. The root XML tag of the file is called configuration with several sub tags to control the behavior of different components of the system.

Configuring Display of Custom Attributes Before a property can be added to the display columns of the grid view, it must be added to the DmGridViewColumns tag under the BrowseWebPart section of the configuration file. The default values are shown below. Once added to the configuration file, the web part configuration will show the new column in the list of available columns to be displayed whilst in Edit mode.

<BrowseWebPart> <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" />

7

<column columntext="Version" attributename="r_version_label" width="" datatype="string" isrepeating="true" isreadonly="false" />

<column columntext="Title" attributename="title" width="" datatype="string"

isrepeating="false" isreadonly="false" /> <column columntext="Subject" attributename="subject" width=""

datatype="string" isrepeating="false" isreadonly="false" /> <column columntext="Object ID" attributename="r_object_id" width=""

datatype="string" isrepeating="false" isreadonly="false" /> </DmGridViewColumns>

You can also choose the columns to display by modifying the webpart after deployment. You can pick the document type and attribute and add it to be displayed on the modify web part screen without having to add them to the configuration file.

8

Adding Workflows to the Menu The system administrator can add a number of workflows to the context menu of the Browse web part. These are specified under a tag called WorkflowTemplates. When the menu is shown, the user will only see the workflow templates to which they have the permission required to launch. i.e they have relate permission to. This section is contained under the BrowseWebPart tag.

<WorkflowTemplates> <template name="Sample Workflow" /> </WorkflowTemplates>

Limiting the list of folder types on the new folder page If you add a folder type to the new folder filter only the type(s) listed will be displayed.

<NewFolderFilter> <FolderType value='dm_folder' /> </NewFolderFilter>

Limiting the list of document types on the upload page If you add a document type to the new document filter only the type(s) listed will be displayed.

<NewDocumentFilter> <DocumentType value='dm_document' /> </NewDocumentFilter>

Hiding Cabinets In the BrowseWebPart tag you can use the below section to hide cabinets from being displayed in the browse web part’s cabinet list. This will hide the cabinet for all users.

 <HiddenCabinets>  </HiddenCabinets>

9

Search Webpart In the SearchWebPart tag you can set if the options for fulltext searching, searching all versions, or searching on hidden objects are visible for the user to select.

<SearchWebPart> <show_fulltext value="true" /> <show_versions value="true" /> <show_hidden value="true" /> </SearchWebPart>

Upload Profile In the UploadProfile tag you can determine if the ‘multi’ upload link will be visible on the upload page, or if the permissions will be shown on the properties page during a document upload.

<UploadProfile> <ShowMultiUpload value="false"/> <ShowPermsOnUpload value="true"/> </UploadProfile>

Check In In the CheckIn tag you can set if the user will have the option on the check in page to check in a document as current. If false this option is disabled and ALWAYS checked (so the document is always checked in as CURRENT).

<CheckIn> <EnableNonCurrentCheckIn value="false"/> </CheckIn>

Content Profile URL Return Policy You can determine if the CONNECTOR FOR SHAREPOINT will attempt to use ACS for content transfer or not using this setting. The valid values are (default is NEVER, which means all content is transferred via the SOAP package):

• NEVER – Always transfer content in the SOAP message. Doesn’t use ACS • ALWAYS – Always transfer content via ACS. Throw an exception if this cannot be done • ONLY - Always transfer content via ACS. Return no content in the web services call if

this cannot be done. • PREFER – Use ACS if ACS is available, otherwise transfer content in SOAP message.

Note that if ACS is configured on the Documentum Content Server it will be used unless NEVER is set. To use ACS the SharePoint server and Documentum Content Server need to be able to communicate over the ACS port (even for PREFER).

<ContentProfileUrlReturnPolicy value="NEVER" />

10

Limiting the list of object types based on user group membership In addition to the other object filtering, you can limit the object type lists based on user group membership. The SelectionLists node is used to setup the lists. The Folders node affects the New Folder page. The Documents node affects Upload, Multi-upload, and New Document. The Search node affects the Advanced Search page. For each list, a user_group attribute is required. The user must be a member of the group for the list to be activated. For Folders and Documents, an optional folder_path can be set. This will add an additional check so the list can be set according to user group membership, but limited to certain folders only. For folder_path, use the full text path of the folder, in the following format: /cabinet/folder. Multiple lists with the same user_group can be set if the folder_path attribute is set. If no folder_path is set, and multiple user_groups exist with the same group name, then the first one will be used. The Search list only requires a user_group, so adding a folder_path will not have any affect. The SelectionLists filtering is evaluated first, before any other lists. So if you’ve set NewDocumentFilter, NewFolderFilter, or AdvancedSearchTypeFilter, then these lists will get evaluated last, and will affect the results of SelectionLists.

<SelectionLists> <Folders> <list user_group="admingroup" folder_path="/Administrator/PBKWF1"> <item label_text="FolderA" type_name="dm_folder"/> <item label_text="Test FolderA" type_name="dm_testfolder" /> </list> <list user_group="admingroup" folder_path="/Administrator"> <folder label_text="FolderB" type_name="dm_folder" /> <folder label_text="Test FolderB" type_name="dm_testfolder" /> </list> </Folders> <Documents> <list user_group="admingroup" 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="admingroup" folder_path="/Administrator"> <item label_text="DocumentB" type_name="dm_document" /> <item label_text="Test DocB" type_name="dm_testdoc" /> </list> </Documents> <Search> <list user_group="admingroup"> <item label_text="SearchDocumentA" type_name="dm_document"/> <item label_text="SearchFolderA" type_name="dm_folder" /> </list> </Search>

</SelectionLists>

Task Details Page In the task details page you can configure the following options. UseCustonButtonNames will allow you to either have the task details page buttons indicate the name of the next activity they will move the task to, or use the generic ‘forward’ and ‘reject’ labels. Setting this to true enables the use of the custom names. ShowAttachments will turn on or off the ability to add attachments to the task on the details page. Setting this to false turns this option off. This is an overall setting but can be overridden by the workflow specific configuration as detailed in the xCP Forms Configuration Guide.

11

<WorkflowTaskDetailsPage> <UseCustonButtonNames value="false"/> <ShowAttachments value="false"/>

</WorkflowTaskDetailsPage>

Controlling the actions available on the Move/Copy/Link page When you click on the ‘add to clipboard’ action you will be taken to a page where you can pick either move, copy, or link as the action to execute and the location where to move, copy, or link the selected document to. You can use the below settings to show/hide each action and set which action will be the default. Setting the value = “true” will show the action. For the default action to be selected you can provide the values ‘copy’, ‘move’, or ‘link’ to indicate which action to make the default. By default ‘copy’ is the default action and ALL the actions will be visible.

<MoveCopyLinkPage> <ShowCopy value="true"/> <ShowMove value="true"/> <ShowLink value="true"/> <DefaultSelection value="copy"/> </MoveCopyLinkPage>

Properties Page In the PropertiesPage tag you can determine if the permissions will be shown on the properties page and if the properties page will be shown with all the properties read only.

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

Display of column widths, filters, item count The following setting needs to be set to true to enable the user to be able to set the column width, filter by any of the columns, and display of the resulting item count.

<show_filter_results value="true" />

Determining the list of date formats available to choose from in the browse webpart In the browse webpart user’s can select the format to use when displaying custom date values. The values available in the lists are set in the dctm.config file as described below.

 <DateFormats> <format value="mm\dd\yyyy hh:mi:ss" /> <format value="mm\dd\yyyy" /> <format value="mm/dd/yyyy hh:mi:ss" />

12

<format value="mm/dd/yyyy" /> <format value="mm-dd-yyyy hh:mi:ss" /> <format value="mm-dd-yyyy" /> </DateFormats>

Setting the web services timeouts

The Connector for SharePoint uses the DFS web services to communicate to Documentum. These web services can be configured with the below timeout settings. You can modify these timeouts using the below settings in the dctm.config.

<ServiceBindings> <SendTimeoutHours value="0"/> <SendTimeoutMins value="5"/> <SendTimeoutSecs value="0"/> <ReceiveTimeoutHours value="0"/> <ReceiveTimeoutMins value="5"/> <ReceiveTimeoutSecs value="0"/> </ServiceBindings>

Setting the object types for simple search For simple searches you can pick the object type to use when searching. This setting controls the list of choices the users will be able to see. When <SimpleSearchTypeFilter> tags are left without specifying any object types dm_sysobject will be shown in a text box and will be used for searching.

 <SimpleSearchTypeFilter> <SearchType value="dm_document" label="dm_document" /> <SearchType value="pbk_document" label="pbk_document" /> </SimpleSearchTypeFilter>

Showing/Hiding the data grid checkboxes The data grid now can display checkboxes which can be used to select multiple items in the grid for running actions that can be run on multiple items (like the start workflow button). Set to ‘true’ to make the checkboxes visible.

 <show_checkboxes value="false" />

13

Setting the Connector for SharePoint Content Cache Timeout The Connector for SharePoint can cache the browsing data for cabinets, folders, documents, and subscriptions that a user will see in the Connector for SharePoint data grid (when browsing, etc.). The timeout will determine how long data will be cached and when the cache will automatically be refreshed. The timeout time is in minutes. If set to ‘0’ caching will not be used.

 <contentCacheTimeout value="10" />

Data Services Settings The Connector for SharePoint data services component is now included with the base Connector for SharePoint install and the configuration settings in the same dctm.config file. You use the ‘NewDocumentFilter’ to control which types are visible to pick from the list when the users click the ‘CheckInToDocumentum’ action from a document library. The show move, copy, link options will show/hide those options when the user is on the checkin to Documentum page.

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

Federated Search Webpart Settings New in the Connector for SharePoint is the Federated Search Webpart. This webpart exposes the Federated Search Services when installed and configured (separately from the Connector for SharePoint). For the Federated Search Webpart to search against a source the source needs to be added in the dctm.config. The ‘value’ should match the name of the source configured in the FSS configuration and the ‘type’ should be either ‘external’ for an external source, like google, or ‘docbase’ for searching against a docbase.

  <ECIS> <Sources> <source value="general/Google" type="external" />

14

<source value="docbase" type="docbase" /> </Sources> </ECIS>

Configuring the Connector for SharePoint Menu

The menu within the browse web part is built dynamically from an xml file called dc4m_menu.xml which is located in the TEMPLATE\LAYOUTS\Documentum directory of the Solution Pack folder. And will be stored in the folder

(common files)\Microsoft Shared\web server extensions\12\template\layouts\Documentum when the solution is deployed. This xml file conforms to a defined schema called dc4m_menu.xsd, which is supplied with the solution package. It is useful to check your xml files against the schema as you edit them.

Context Menus

When the user right clicks on object within the browse web part, they are presented with a number of available actions to perform on that object. This is termed a “Content Menu” and the options are dependent on the context of the object that is selected. The menu fragment below shows a context menu for dm_document, defined by the XML attribute objectType. When an object is encountered in the list view, the menu builder will look through the XML file until it finds a match on the object type. If no match is found, then it will use the default menu for a document or folder depending on the type of object. Currently, only exact matches are supported, you have to define a custom menu for each distinct custom type or it will default to the standard. Each ContentMenu entry must have a unique name and all menu items must have a unique ID throughout the entire menu structure. It is a good idea to use the object type in the ID. Failure to do so will result in a SharePoint exception. There follows a sample menu fragment.

<ContextMenu name="_DmDocumentMenu" objectType="dm_document" > <MenuItem label= "Open" id="_docMenuItemView" actionName="open”/> <MenuItem label= "Edit Document" id="_docMenuItemEdit" actionName="editdoc"/> <Separator /> <MenuItem label= "Check Out" id="_docMenuItemCheckout" actionName="checkout"

qualifiers="isCheckedout=false" /> <MenuItem label= "Check In" id="_docMenuItemCheckin" actionName="checkin"

qualifiers="isCheckedoutToMe" /> <MenuItem label= "Cancel Check Out" id="_docMenuItemCancelCheckout"

actionName="cancelcheckout" qualifiers="isCheckedoutToMe" /> <Separator />

15

As we can see from the example above, a menu consists of MenuItem elements which define an individual entry in the menu. Each menu item is linked to an Action which will be described in a following section. The visibility of individual menu items are controlled via a MenuQualifier which, based on certain criteria relating to the user or object, will determine if the menu item should be shown. The menu qualifiers are defined in the Qualifiers section of the XML file and referenced by the menu entries. In the example above we can see that the entry “Cancel Check Out” is qualified by the condition “isCheckedOutToMe”. These conditions can be combined with a “+” for a “AND” operator and a “|” for an “OR” operator. Currently these cannot be combined, i.e. the expression has to contain just AND or OR. If it is required that the negative of the condition is true, then we can use the form “isCheckedOut=false”. Menu items can have an image attribute which tells the menu builder which image to apply to the menu item. This can be a relative URL or the name of a standard image.

Menu Qualifiers Before a menu condition can be established, the qualifier must be declared in the qualifiers section. These qualifiers use a plug-in architect and the intention is that these qualifiers can be extended by the third parties.

<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" /> </Qualifiers>

The standard qualifiers are described below. Name Description Examples

isSubscribed Determines if the user is currently subscribed to that object

isSubscribed=false

isCheckedoutToMe Is the Document checked out to the current user?

isCheckedout Is the Document checked out to any user?

isCheckedOut=false

hasRole Is the user a member of a specific group?

hasRole(record_manager)

16

Sub Menus Sub menus can be defined using the XML tag <SubMenu label =”xx” > which can contain all the same elements of the normal menu with an additional option called a Dynamic Menu.

Dynamic Menus Dynamic menus are built at runtime and are considered to be variable. I.e. The number of entries can vary. In the example below, the start workflow menu is generated based on a query of available workflows to the user. If no results are returned then the sub menu will not be shown.

<SubMenu label ="Start Workflow" > <DynamicMenu name ="workflows" id="_docMenuItemWorkflow"/> </SubMenu>

Again these are based on a plug-in architecture and are defined in the section called DynamicMenuProviders

<DynamicMenuProviders > <DynamicMenuProvider name ="workflows"

classname="EMC.Documentum.SharePoint.Menus.WorkflowDynamicMenuGenerator"/> <DynamicMenuProvider name ="renditionFormats"

classname="EMC.Documentum.SharePoint.Menus.RenditionFormatsProvider"/> </DynamicMenuProviders >

Connector for SharePoint Actions

As stated before, actions are called from menu entries. The actions are defined in an XML file called dc4m_actions.xml which is located in the TEMPLATE\LAYOUTS\Documentum directory of the Solution Pack folder. And will be stored in the folder

(common files)\Microsoft Shared\web server extensions\12\template\layouts\Documentum once the solution is deployed. This xml file conforms to a defined schema called dc4m_actions.xsd, which is supplied with the solution package. There are two types of Action. A component based action and a page based action. Component actions are used when the action does not require any interaction from the user. An example would be creating a subscription. Once it has been requested, it will run and the user will be returned to the current view. A page action, however, will redirect the browser to a different ASPX page which allows the developer to create an interactive component. An example of this could be the properties page or the start workflow page. There follows an example of the dc4m_actions.xml.

17

<Actions> <Action name = "subscribe" > <Component class = "EMC.Documentum.SharePoint.Actions.SubscribeAction" /> </Action> <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> <Action name ="customproperties" > <Page url= "/_layouts/Documentum/CustomPage.aspx?caller={0}&objectId={1}" > <Argument name = "callerId" /> <Argument name = "objectId" /> </Page> </Action> </Actions>

If the developer creates an action that has the same name as the standard Connector for SharePoint action, then their action will be called in preference to the standard action.

Creating a Custom Action Sample custom actions can be found in the Dc4mSamples Visual Studio project supplied with the solution. The project requires Visual Studio 2008 and uses the add-in WSPbuilder from codeplex which can be obtained from the following location http://wspbuilder.codeplex.com/Wikipage.

Sample Component Action The following code fragment shows a very simple example of an action that simply sets the title property an object. It implements the interface IDc4mAction which is contained within the assembly EMC.Documentum.DC4MOSS.WebParts which 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"); 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"; } }

http://wspbuilder.codeplex.com/Wikipage

18

The code sample uses a utility class called DFS which 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. Refer to the DFS Development Guide and the DFS SDK for more details. When the class has been compiled and packaged into an assembly, it must be placed in the GAC (Global Assembly Cache) and then can be referenced from the dc4m_actions.xml

<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 used must be the full name of the assembly and not just the DLL name.

Sample Page Action The alterative mechanism for the 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. Again, an example is supplied in the project Dc4mSamples. If we look at the sample class.

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(); 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);

19

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(); }

Connecting a Custom Action to a Menu In order for the custom action to be invoked by the user, we need to call it from a menu. So we add the following entry to the ContextMenu for documents.

<MenuItem label= "My Custom Properties" id="_docMenuItemCustomProperties" actionName="customproperties" />

20

Connector for SharePoint Caching

Action and menu definitions are cached in memory within the DC4m solution. If a change is made to the deployed configuration file, it will not take effect until the Application pools are recycled, the application is redeployed or IIS has been reset. As a convenience, a page has been provided to clear the cache without restarting. The URL is http://server/_layouts/Documentum/ClearCache.aspx

http://server/_layouts/Documentum/ClearCache.aspx

21

Overriding Property Controls

In order to give better control over the display of properties, the default control settings can be overridden through the configuration file “dc4m_controloverrides.xml” which is located in the TEMPLATE\LAYOUTS\Documentum directory of the Solution Pack folder. And will be stored in the folder

(common files)\Microsoft Shared\web server extensions\12\template\layouts\Documentum once the solution is deployed. This xml file conforms to a schema called dc4m_ controloverrides.xsd, which is supplied with the solution package. For each type, the configuration file contains a number of control definitions. When displaying the properties of an object, the properties component will check this file for an entry that matches the object type of the document (exact match only) and the property name. It will then use the parameters specified within the Parameter tags to control the layout of the final control. An example file is shown below. In the example, the subject and object_name properties of dm_document are displayed in multiline text boxes. <?xml version="1.0" encoding="utf-8" ?> <ControlOverrides> <TypeOverrides> <ObjectType typeName ="dm_document"> <Control propertyName="subject" controlType="TextBox"> <Parameter name="Rows" value="5" /> <Parameter name="TextMode" value="MultiLine" /> </Control> <Control propertyName="object_name" controlType="TextBox"> <Parameter name="Rows" value="2" /> <Parameter name="TextMode" value="MultiLine" /> </Control> </ObjectType> <ObjectType typeName ="dm_cabinet"> <Control propertyName="subject" controlType="TextBox"> <Parameter name="Rows" value="5" /> <Parameter name="TextMode" value="MultiLine" /> </Control> </ObjectType> </TypeOverrides> </ControlOverrides>

Currently only text boxes have configurable parameters. The available parameters are Name Description Rows Number of rows to display in the text

box TextMode The type of text box to show. Can be

MultiLine, Password or SingleLine MaxLength Maximum length of the string to accept CssClass The CssClass to apply to the control

22

Setting a Dynamic Starting Point for the Browse Web Part

You can configure the Browse Web Part to dynamically determine either a location to use as a starting point for browsing or display the results of a query. Using the configuration screen (below) you can enter in an object type and attribute to use in determining this. Then in the URL to launch the browser page include as part of the query string ‘startingPointValue’ and a value(s) to use with the type and attribute to query for the starting point or results. If you have more than 1 attribute configured you separate the values for each attribute using ‘|’ as the separator. (ex http://<host>/default.aspx?startingPointValue=<value>, or http://<host>/default.aspx?startingPointValue=<value>|<value2>)

Figure 1 Browse Web Part configuration screen

23

Object Type This is the object type to use when building

the starting point query Attribute(s) This is the attribute(s) separated by ‘|’ to use

when building the starting point query. Use ‘any’ before a repeating attribute.

These settings combine to build a DQL query select < Connector for SharePoint required attributes> from <object type> where <attribute> = <value> and adding each attribute configured with each value (separated by ‘|’). If the result is a cabinet or folder the browse web part will use that as a starting point for browsing. If it is not a cabinet or folder then the result(s) is treated as a set of search results and the result(s) is loaded in the browse webpart. If you want to use repeating attributes just add the keyword any before the attribute name (for example ‘title| any keywords’) to let the Connector for SharePoint build the DQL correctly and use the repeating attribute to determine the starting point.

24

Setting a Configuration Based on the SharePoint Site

You can configure the Connector for SharePoint to use various configuration files based on which site the webpart(s) are deployed in. By default, it no settings are found or an error is received the Connector for SharePoint will look for the standard dctm.config file. Each site specific configuration file is another FULL copy of the dctm.config file with that site’s specific settings. The first step to enabling the use of the site based configuration is to use the sdf_config_site_mapping.config file. This file will contain the list of site(s) titles, names, or URLs, and their specific configuration files. The Connector for SharePoint will search for a matching site title that matches the exact site hierarchy for the current site first. Then it will look for a hierarchy that matches the parent site(s), etc. (using a starts width string matching search). This means that you can configure a set of sub-sites by designating a configuration for just the parent site. Note that the search for the parent pattern will take the first result found. This means that if you have a site several levels deep with configurations on multiple parent levels the first parent level found will be the configuration used. The Connector for SharePoint will look at the title field for each site, so use the title, name, or URLs, in the mapping file to indicate which configuration file to use. Note that you cannot use some special characters in the XML configuration that can be used in a SharePoint site title (‘<’ and ‘>’ for example). To designate which parameter to use to determine the site mapping, set the searchtype value to either:

• sitetitle – Use the title of the site • sitename - Use the name of the site. This is the name as set by SharePoint • siteurl – Use the URL extension for the site

The menu, actions, and property override XML configuration files are also site based. The Connector for SharePoint will look for these files in the same folder location as the site’s configuration file. So if you want to use site based configuration for these files, use subfolders for each site’s configuration file. Otherwise the base level configuration XML files are used. Here is an example of the sdf_config_site_mapping.config file. Note that you can use subfolders as well to organize the configuration files. A subfolder is not required. If you use a subfolder do NOT start the location string with a ‘/’ but just start with the name of the folder (as in the example below). <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <configuration>

25

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

26

Encrypting Passwords for the Config File

To encrypt passwords for use by the Connector for SharePoint you use the sdf_encrypt_password.exe utility that comes in the Connector for SharePoint’s base solution pack. Using this utility you enter in your password to encrypt and copy the entire result into the dctm.config file. Make sure to include the SDF_ENCR_PASS= portion of the encrypted string as this tells the Connector for SharePoint to decrypt this password.

27

Setting Default Location for Attachments

Set the DefaultAttachmentSaveLocation to set the default location where workflow attachments will be saved when uploaded. “” will save the attachments is in the user’s home cabinet. <WorkflowTaskDetailsPage>     <UseCustomButtonNames value="true"/> <ShowAttachments value="true"/> <ShowRemovePackages value="true"/> <EnableUserSelectionForAttachmentSaveLocation value="true" /> <DefaultAttachmentSaveLocation value="" /> </WorkflowTaskDetailsPage>

28

Data Services Configuration

Points of Configuration The Data Services can be configured in a number of ways.

1. The configuration file dctm.config contains general settings for the solution components, such as

a. Setting the DFS connection parameters b. Document type filters for content transfer

2. Migration configuration via the mossdctmap.xml file

The dctm.config file The Data Services can be configured through XML file dctm.config which is located in the TEMPLATE\LAYOUTS\Documentum\DataServices

Limiting Document Types on Checkin to Documentum You need to configure the types below that will appear in the drop down in the page.

<CheckinToDocumentum>  <NewDocumentFilter>  </NewDocumentFilter> </CheckinToDocumentum>

Controlling the actions available on the Move/Copy/Link page When you click on the ‘check in to documentum’ action you will be taken to a page where you can pick either move, copy, or link as the action to execute and the location where to move, copy, or link the selected document to. You can use the below settings to show/hide each action and set which action will be the default. Setting the value = “true” will show the action. For the default action to be selected you can provide the values ‘copy’, ‘move’, or ‘link’ to indicate which action to make the default. By default ‘copy’ is the default action and ALL the actions will be visible.

<show_move value="true" /> <show_copy value="true" /> <show_link value="true" />

29

Setting the web services timeouts

The Connector for SharePoint uses the DFS web services to communicate to Documentum. These web services can be configured with the below timeout settings. You can modify these timeouts using the below settings in the dctm.config.

<ServiceBindings> <SendTimeoutHours value="0"/> <SendTimeoutMins value="5"/> <SendTimeoutSecs value="0"/> <ReceiveTimeoutHours value="0"/> <ReceiveTimeoutMins value="5"/> <ReceiveTimeoutSecs value="0"/> </ServiceBindings>

The Mapping File The data services uses a mapping file to control its configuration and how data is handled when moving from SharePoint to DCTM. This file, mossdctmap.xml, is installed with template data initially. When using the data services ‘Check In to Documentum’ page the following settings are the minimal settings needed for the page to function. The mossdctmmap needs the following settings at minimal to work.

<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> Also note that is the ‘canoverride’ setting = false then the tree to select a folder is hidden and the path provided will be used to check in the document. If ‘canoverride’ = true then the tree is visible and you need to choose a location to check in the document to.

30

Configure Automated Move/Copy/Link The Data Services solution can be configured through XML file mossdctmap.xml which is located in the TEMPLATE\LAYOUTS\Documentum\DataServices\DocMaps. This file determines what will happen when a file is migrated to Documentum via the event pages or property based automated migration site features. The following tags can be used to configure the Connector for SharePoint’s data services behavior

• Repository – Sets the repository to be used using the name attribute. Surround all the settings for a particular repository with this tag.

• Doctype Map – This tag maps the SharePoint types to the Documentum types • Mosstype – This is the SharePoint object type

• Dctmtype – This is the Documentum object type

• Acl – Lets you set a specific ACL (otherwise the user’s default ACL is used)

• Variabledelimiter – the delimiter used to indicate the use of a variable in the mapping

file (for example the target path).

• Eventaction – The type of action to execute (move, copy, or link)

• Condition – Use when using the property change site feature. • Mossattribute – the attribute to check the value of. • Value – The value to compare against, if it matches then the action is taken

• Attributemap – a mapping of attribute data to migrate. Surround the attributes with

this tag Rules for Attribute mapping Connector for SharePoint evaluates the value inside attribute node as: If the value has variabledelimiter at the begining then its a Sharepoint attribute else its a constant value

Attribute – the attributes to migrate. The value of the data in the tag is the Documentum attribute to use

Mossattribute – the SharePoint attribute to migrate

Examples <attribute documentumattribute="moss_creation_date">$$Created</attribute> <attribute documentumattribute="moss_modification_date">$$Modified</attribute> <attribute documentumattribute="source_author">$$Author</attribute> <attribute documentumattribute="title">$$Title</attribute> <attribute documentumattribute="documentsource">sharepoint</attribute> <attribute documentumattribute="prodno">$$productno</attribute>

31

Targetpathexpr - the target folder’s path. This can be constant, variable, or a mix.

Rules for Targetpathexpr a. Parts should be separated by / b. Expression shouldn't start or end with "/" c. Four constant variables sitetitle, sourcefolder, documentsetname, libraryname should

have the same delimiter as variabledelimiter at the beginning. d. Attribute names should have variabledelimiter at the beginning. e. Non-existing attributes will be rejected in the path evaluation. The error message will be

logged. f. canoverride allows the manual check in page to let the user pick the target location and

override this setting.

Examples: <targetpathexpr canoverride="false" createfolder-if-notexists="true">$$sitetitle/$$sourcefolder</targetpathexpr> <targetpathexpr>$$libraryname/$$author/SDF Data</targetpathexpr> <targetpathexpr>$$documentsetname/SDF Data</targetpathexpr> <targetpathexpr>$$author/SDF Data</targetpathexpr>

Below is an example of the mossdctmap.xml file. <?xml version='1.0' ?> <mossdctmmap> <repository name="Docbase01"> <doctypemap mosstype="Document"> <dctmtype>dm_document</dctmtype> <variabledelimiter>$$</variabledelimiter>  <targetpathexpr canoverride="false" createfolder-if-notexists="true" createfolder-type="dm_folder">$$sitetitle/$$sourcefolder</targetpathexpr>    <eventaction value="move" /> <condition mossattribute="title" value="publish" /> <attributemap> <!-- Rules for Attribute mapping Evaluates the value inside attribute node as: If the value has variabledelimiter at the begining then its a Sharepoint attribute else its a constant value

32

--> <attribute documentumattribute="moss_creation_date">$$Created</attribute> <attribute documentumattribute="moss_modification_date">$$Modified</attribute> <attribute documentumattribute="source_author">$$Author</attribute> <attribute documentumattribute="title">$$Title</attribute> <attribute documentumattribute="documentsource">sharepoint</attribute> <attribute documentumattribute="prodno">$$productno</attribute> </attributemap> </doctypemap> <doctypemap mosstype="sharepointdocument"> <dctmtype>dm_document</dctmtype> <variabledelimiter>$$</variabledelimiter> <targetpathexpr canoverride="false" createfolder-if-notexists="true" createfolder-type="dm_folder">$$sitetitle/$$sourcefolder</targetpathexpr> <acl domain="user_login_name" name="acl_name"/> <eventaction value="link" /> <condition mossattribute="title" value="publish" /> <attributemap> <attribute documentumattribute="moss_creation_date">$$Created</attribute> <attribute documentumattribute="moss_modification_date">$$Modified</attribute> </attributemap> </doctypemap> </repository> <repository name="TemplateRepository"> <doctypemap mosstype="Enter a SharePoint Type"> <dctmtype>dm_document</dctmtype> <variabledelimiter>$$</variabledelimiter> <targetpathexpr canoverride="false" createfolder-if-notexists="true" createfolder-type="dm_folder">$$sitetitle/$$sourcefolder</targetpathexpr> <acl domain="" name=""/> <eventaction value="move" /> <condition mossattribute="" value="" /> <attributemap> <attribute documentumattribute="spdoc_creation_date">$$Created</attribute> </attributemap> </doctypemap> </repository> </mossdctmmap>

You can also configure the mapping file using the configuration webpart

33

Configuration Webpart

The Connector for SharePoint includes a configuration webpart to allow SharePoint users to modify the mapping file (above) from SharePoint. To use the configuration webpart you:

1. Deploy the webpart to a page. 2. Enter in the data for the XML above into the webpart fields. The fields read and write

the data to the XML, so the same possible values for the tags as described above. Here is an example of the webpart with settings filled in:

The Configuration Web Part’s UI is driven by an XML file located in the Connector for SharePoint installation folder at: LAYOUTS\Documentum\Forms\DataServicesConfig\DataServicesConfig_config.xml. This file can be edited to alter the UI. Some common changes will be with the labels, help text, and layout. Each UI element contains a <Label> and a <HelpText> node. These can be altered as needed. The UI element layout on the form is directly related to the elements layout in the XML file, so it is possible to move elements around on the form by simply moving them in the XML file. Note that it is very important that the <Name> node for each element not be changed. The Configuration web part reads and writes settings from the LAYOUTS/Documentum/DataServices/DocMaps/mossdctmmap.xml file. Note that this file is supported by the site-based mapping, and could be in a different location. The Configuration web part will find the correct mossdctmmap.xml file based on the site that the web part is located in.

34

The following table describes each setting on the form: Setting Description

“1. Select a Documentum Repository”

This contains a list of every repository that is listed in the LAYOUTS/Documentum/DataServices/DocMaps/mossdctmmap.xml file. When a repository is selected the dropdown list below it should fill with all of the mappings that exist for the repository.

“2. Select a SharePoint Type”

This contains a list of all mappings that exist for the selected repository. When one of these item is selected, the rest of the form is filled with the values for this mapping.

“SharePoint Type Name” This is the name of the SharePoint document type that is to be mapped.

“Documentum Type” This is the Documentum type to map the SharePoint document to. “SharePoint Property Condition”

This is used to trigger a Documentum import via a property update on the SharePoint document. Set Property Name field to the name of the SharePoint document property to be examined. Set the Value field to the value of the property that will initiate the import. For example, if the Property Name is title, and Value is “publish”, then the Connector for SharePoint will attempt to import the document from the SharePoint library when the title of the document is set to “publish”.

“Documentum Acl” This is the domain and name of an existing Documentum ACL that will be applied to the document upon import into Documentum.

“Event Action” This is the type of import operation to perform during an event-based import. An event-based import is one that is triggered silently by altering a property of a SharePoint document. The options are Move, Copy, and Link.

“Variable Delimiter” Many of the settings contain dynamic properties whose values are retrieved from the SharePoint document or site. This delimiter value is used to determine if a property is dynamic and should be retrieve directly from SharePoint. The value of the delimiter can be a single character, or a unique string.

“Documentum Import Folder”

This is the path of a Documentum folder to use for the import. It can be a static path, or one that’s built dynamically, based on the SharePoint site and/or document settings. For all paths, the value of this setting should always be: Cabinet/folder/folder … There should be no leading or trailing slash in this string. There are four reserved words that can be used to dynamically build this path. They are as follows: sitetitle – This will be replaced by the title of the current site. sourcefolder – This will be replaced by the folder name that the SharePoint document is contained in. documentsetname – If the document being imported is from a

35

SharePoint documentset, this value will be replaced by the name of the documentset. libraryname – This will be replaced by the name of the SharePoint document library that contains the document being imported. The reserved words must be prefixed with the Variable Delimiter, which indicates that the value is to be retrieved from SharePoint. For example, if the Variable Delimiter is $$, then the above four reserved words should be used in the path like this: $$sitetitle, $$sourcefolder, $$documentsetname, or $$libraryname. An example path is: $$sitetitle/$$libraryname/$$sourcefolder Upon import, these values will be replaced with the real values from SharePoint. You can also add static cabinet/folder names to the path, e.g. MyCabinet/MyDocuments/$$sourcefolder/SharedDocs

“Create folder if it doesn’t exist”

This is a checkbox indicating whether or not the Documentum folder specified in the above setting should be created if it doesn’t exist.

“Folder Type to create” This is the Documentum folder type to use when a folder is created. “Can Override” During a manual checkin of content from SharePoint, this indicates

whether the user can manually select the target Documentum folder, or if it is determined by the value of “Documentum Import Folder”. Checking this box will cause the Documentum folder selection tree to show up on the manual checkin page, meaning the user can override the “Documentum Import Folder” setting.

“Property Map” This is a list of SharePoint to Documentum property mappings that are used during an import operation. This allows property values to be imported into Documentum along with the content. The Documentum Property Name is the name of the Documentum property to set the value to. The SharePoint Property Name is the name of the SharePoint property to retrieve the value from. Every SharePoint Property Name should be prefixed with the Variable Delimiter. The number of property map rows can be set in the DataServicesConfig_config.xml file, in the <RowCount> node of the element named “attributemap”.

A new document mapping can be added to a repository by clicking “Add New Map” button on the ribbon toolbar. Default values for the fields can be set in the mossdctmmap.xml file. In this file is a repository named “TemplateRepository”: “<repository name="TemplateRepository">” Values in this section will be automatically filled in when a new mapping is added.

36

Ribbon Configuration

The Browse Web part ribbons are defined in configuration files on the SharePoint server where the Connector for SharePoint is installed. The configuration files are located in _layouts/Documentum/Ribbons. The configuration files define the ribbon buttons, commands, and UI elements, such as titles, text, and ribbon tab color. The following table describes some common customizations that can be performed on the ribbon: *IMPORTANT: Before attempting any of the following customizations, be sure to create a backup of the configuration files. Customization Instructions How to change the color of the ribbon tab

In _layouts/Documentum/Ribbons/BrowseWebPart_RibbonControls.xml, the color is defined in the top <ContextualGroup> node in the Color attribute. The default color is “Green”. Other supported colors are: None DarkBlue LightBlue Teal Orange Green Magenta Yellow Purple More information can be found here: http://msdn.microsoft.com/en-us/library/ff458415.aspx

How to change the text (title) of the ribbon tab

In _layouts/Documentum/Ribbons/BrowseWebPart_RibbonControls.xml, the Title is defined in the top <ContextualGroup> node in the Title attribute. More information can be found here: http://msdn.microsoft.com/en-us/library/ff458415.aspx

How to change the text and help text of a ribbon button

In _layouts/Documentum/Ribbons/BrowseWebPart_RibbonControls.xml, search for <Button> nodes. These define each button on the ribbon. The LabelText attribute defines the button text. The ToolTipTitle and ToolTipDescription define the help text that is displayed when the mouse cursor is hovered over the button.

How to permanently disable a ribbon button

In _layouts/Documentum/Ribbons/BrowseWebPart_RibbonScript.js, the ribbon button command, and state handlers are defined. The following block of code defines the enabled state of each button:

37

canHandleCommand: function BrowseWebPart_PageComponent$canHandleCommand(commandId) { //Contextual Tab commands if ((commandId === 'BrowseWebPartTab.EnableBrowseTab') || (commandId === 'BrowseWebPartTab.EnableBrowseTabGroup') || (commandId === 'BrowseWebPartTab.EnableNewTabGroup') || (commandId === 'BrowseWebPartTab.EnableManageTabGroup') || (commandId === 'BrowseWebPartTab.EnableCheckoutTabGroup') || (commandId === 'BrowseWebPartTab.NewDocumentCommand') || (commandId === 'BrowseWebPartTab.UploadDocumentCommand') || (commandId === 'BrowseWebPartTab.NewFolderCommand') || (commandId === 'BrowseWebPartTab.EditCommand') || (commandId === 'BrowseWebPartTab.CheckinCommand') || (commandId === 'BrowseWebPartTab.CheckoutCommand') || (commandId === 'BrowseWebPartTab.CancelCheckoutCommand') || (commandId === 'BrowseWebPartTab.ViewPropertiesCommand') || (commandId === 'BrowseWebPartTab.DeleteCommand')) { return true; } }, To disable a button, locate the above block of code, located the button that you wish to disable and remove or comment it. For example, to disable the Edit Document button, comment the line with a // as follows: canHandleCommand: function BrowseWebPart_PageComponent$canHandleCommand(commandId) { //Contextual Tab commands if ((commandId === 'BrowseWebPartTab.EnableBrowseTab') || (commandId === 'BrowseWebPartTab.EnableBrowseTabGroup') || (commandId === 'BrowseWebPartTab.EnableNewTabGroup') || (commandId === 'BrowseWebPartTab.EnableManageTabGroup') || (commandId === 'BrowseWebPartTab.EnableCheckoutTabGroup') || (commandId === 'BrowseWebPartTab.NewDocumentCommand')

38

|| (commandId === 'BrowseWebPartTab.UploadDocumentCommand') || (commandId === 'BrowseWebPartTab.NewFolderCommand') //|| (commandId === 'BrowseWebPartTab.EditCommand') || (commandId === 'BrowseWebPartTab.CheckinCommand') || (commandId === 'BrowseWebPartTab.CheckoutCommand') || (commandId === 'BrowseWebPartTab.CancelCheckoutCommand') || (commandId === 'BrowseWebPartTab.ViewPropertiesCommand') || (commandId === 'BrowseWebPartTab.DeleteCommand')) { return true; } }, Note that because this is a Javascript file, the file will likely be cached on the end-users workstation, so the changes will not take effect until the user clears their browser cache.

39

Configure Individual Web Parts

Repositories

Users can access Documentum repositories using a set of web parts - Browse, Home Cabinet, and Subscriptions for example. The Browse web part can be added to a site page to allow users to perform content management functions on a repository directly from the SharePoint user interface. Each Browse web part is configured to access one Documentum repository. To access more than one repository, multiple Browse web parts should be added to the site page and configured accordingly. The Home Cabinet web part can be added to a site page to quickly access the contents of the user’s home cabinet in Documentum. The Subscriptions web part can be added to a site page to quickly access the user’s subscriptions.

Configuring the Documentum Browse Web Part The Documentum Browse web part provides configuration options for accessing and displaying content of a Documentum repository. The configuration options include repository selection and display settings. These configuration options are described below.

Repository Configuration When the Browse web part is first added to a page, it prompts you to modify the web part to provide a repository selection.

To provide a repository selection:

1. Open the web part settings. 2. Under Documentum Properties, select a repository from the Repository list. 3. Apply the changes to the web part.

Multiple web parts can be added to a page to access different repositories. The credentials used to login to the selected repository are based on the username and password of the user currently logged in. If single-sign-on (SSO) is used, you will only see a Repository selector. If SSO is not used, you will see a Login Name and Password field used to set your credentials.

Display Configuration The Browse web part provides configuration options that determine what and how items are displayed in the web part. Descriptions of these options are given below.

40

Maximum Number of Rows to Display The number of rows displayed in the web part is configurable. By default, the number of rows to display is 10. To change the maximum number of rows to display in the web part :

1. Open the web part settings. 2. Under Documentum Properties, enter the maximum number of rows to display at one

time. 3. Apply the changes to the web part.

Display a Row for the Home Cabinet The web part can be configured to display a row for the Home Cabinet. You can view the contents of the Home Cabinet directly by clicking the Home Cabinet row. The Home Cabinet

row is designated by the home cabinet icon ( ).

To display a row for the Home Cabinet in the web part

1. Open the web part settings. 2. Under Documentum Properties, select Yes to display a row for the Home Cabinet. 3. Apply the changes to the web part.

The Home Cabinet can also be accessed directly through the Home Cabinet web part.

Display a Row for Subscriptions Subscriptions provide quick access to frequently accessed cabinets, folders and documents. The web part can be configured to display a row for subscription access. By clicking on the subscriptions row, you can view all your subscriptions. The Subscriptions row is designated by

the subscription icon ( ).

To display a row for Subscriptions in the web part:

1. Open the web part settings. 2. Under Documentum Properties, select Yes to display a row for Subscriptions. 3. Apply the changes to the web part.

Subscriptions can also be accessed directly through the Subscriptions web part. For more information on the Subscriptions web part, see Viewing Subscriptions on page 27.

41

Default Document Type to Display By default, the web part displays all documents that are a type or sub-type of dm_document. A user can further restrict the types of documents displayed in the web part to a sub-type (and its sub-types) of dm_document.

To restrict the types of documents to display

1. Open the web part settings. 2. Under Documentum Properties, select the default document type to be used as the highest

level document type to display. All sub-types of the chosen type are also displayed. 3. Apply the changes to the web part.

Columns to Display A user can configure which attribute columns are displayed and in which order they are displayed.

Adding an Attribute to the Display

To add an attribute to the display:

1. Open the web part settings. 2. Under Documentum Properties, select the column name to add to the display. 3. Click Add.

To select an attribute to add:

1. Pick the type from the drop down 2. Pick the attribute from the list of attributes once the list populates 3. Click ‘Add’

Removing an Attribute from the Display

To remove an attribute from the display

1. Open the web part settings. 2. Under Documentum Properties, select the name of the column to remove from the list

of display attributes. 3. Click Remove.

The column name is removed from the list of displayed attributes.

42

Changing the Order of Displayed Attributes

To change the order of the displayed attributes

1. Open the web part settings. 2. Under Documentum Properties, select the name of the column to move. 3. Click Move Up to display the attribute earlier in the column order, or click Move Down

to display the attribute later in the column order.