Documentum Content Distribution Services TM Administration Guide

Transcription

1 Documentum Content Distribution Services TM Administration Guide Version 5.3 SP5 August 2007

2 Copyright EMC Corporation. All rights reserved.

3 Table of Contents Preface... 7 Chapter 1 Introducing Documentum Content Distribution Services... 9 Understanding content distribution Making content available: offers and packages Preparing content for delivery: Templates Receiving content: subscribers and subscriptions Scheduling delivery Understanding the CDS Server What the CDS Server does? What the CDS Server retrieves from the repository? What the CDS Server delivers to subscribers? Using CDS Administrator tasks Subscriber tasks Chapter 2 Using CDS Administrator Logging in Navigating in the application Using list pages Using attributes pages Using selection pages Scheduling offers and subscriptions Deleting schedules Sending notifications Chapter 3 Offering Content Before you begin Creating offers Specifying the offer query Creating templates Chapter 4 Registering subscribers Creating subscriber user accounts Creating groups Chapter 5 Subscribing to Offers Before you begin Creating subscriptions Chapter 6 Using the Content Distribution Services Client Application Logging in Documentum Content Distribution ServicesTM Administration Guide 3

4 Table of Contents Configuring subscriptions Reading notifications Chapter 7 Monitoring Server Processing Reading the CDS Server log files Configuring the CDS Server Modifying notification messages Managing content cache storage Resolving delivery issues Modified offers and subscriptions Retrieving content by reference Modifying templates Appendix A Content Distribution Services Custom JSP Tag Reference applyformat formatdate formatnumber replacetext stripimages striptables striptags track truncatetext writedocument Appendix B Attribute File XML Format Documentum Content Distribution ServicesTM Administration Guide

5 Table of Contents List of Figures Figure 1 1. Basic Documentum Content Distribution Services architecture Figure 1 2. Offers and packages Figure 1 3. Applying templates to offer content Figure 1 4. Subscriber access to offers Figure 1 5. Server scheduling Figure 2 1. Parts of the CDS Administrator screen Figure 2 2. List Page Figure 2 3. Attributes page Figure 2 4. Selection page Figure 2 5. Schedule page Figure 2 6. Schedule property page Documentum Content Distribution ServicesTM Administration Guide 5

6 Table of Contents List of Tables Table 7 1. Commonly updated cxflog.xml settings Table 7 2. Commonly updated cds.xml settings Table A 1. Content Distribution Services JSP Tags Documentum Content Distribution ServicesTM Administration Guide

7 Preface This manual provides system administrators with the information necessary to implement an automated distribution network using Documentum Content Distribution Services (CDS). It provides an overview of the concepts of distribution, the architecture of the Documentum solution, and detailed instructions for creating the necessary objects. The manual also covers the CDS Client, which is software that distributors can provide to their subscribers. Intended audience This manual is intended primarily for system administrators who need to set up the Content Distribution Services Server and maintain the system. It also includes information that is relevant for subscribers who want to receive the content distributed by the CDS Server. Revision history The following changes have been made to this document. Revision history Revision date August 2007 Description Initial publication Documentum Content Distribution ServicesTM Administration Guide 7

8 Preface 8 Documentum Content Distribution ServicesTM Administration Guide

9 Introducing Documentum Content Distribution Services Chapter 1 Documentum Content Distribution Services provides a framework for distributing content to people both inside and outside of your company s firewall. People subscribe to the content you offer, much as they subscribe to magazines. With this product, you can automatically inform interested parties about updates to a repository and forward them the new or the updated documents. The prototype example of content distribution is a news feed. When a news service posts a story, or an industry analyst updates a research report, or a corporation issues a press release, there are a number of people who want to receive the document. Content Distribution Services enables the distributor to maintain a list of subscribers who are interested in receiving updates and to forward them the updates automatically. A common business scenario for Content Distribution Services is distributing up-to-the-minute information about your company s products and services to partners and customers. For example, suppose your partners maintain a version of your product catalog on their web sites. Content Distribution Services enables you to distribute updates to the catalog and enables the partners to automatically incorporate the updates on their sites. Content Distribution Services delivers content using standard internet protocols, which means that subscribers need not be part of the same company network as the distributor nor have access to secure areas of the distributor s network. This chapter provides an overview of content distribution, both the basic concepts and the architecture of Documentum Content Distribution Services. The major sections are: Understanding content distribution, page 10 Understanding the CDS Server, page 16 Using CDS, page 20 Documentum Content Distribution ServicesTM Administration Guide 9

10 Introducing Documentum Content Distribution Services Understanding content distribution Documentum Content Distribution Services has two major components: a Content Distribution Services server (CDS Server) and multiple subscribers. The CDS Server monitors one or more content repositories for updates, packages the new or updated content, and distributes it to subscribers. The server also manages the list of subscribers: their privileges, which content each subscriber is interested in, and how and where to deliver the updates. The subscriber accepts content packages from the CDS Server and updates its local content repository as appropriate. 10 Documentum Content Distribution ServicesTM Administration Guide

11 Introducing Documentum Content Distribution Services Figure 1-1. Basic Documentum Content Distribution Services architecture A CDS Server serves any number of subscribers. The server can offer content from Documentum repositories or Site Caching Services repositories, from relational databases, or from file-based repositories. Subscribers can receive content using one of three delivery protocols: Information and Content Exchange (ICE), an industry-standard message protocol for content distribution File Transfer Protocol (FTP), the internet standard for simple file transfers using internet standard Simple Mail Transfer Protocol (SMTP) Documentum Content Distribution ServicesTM Administration Guide 11

12 Introducing Documentum Content Distribution Services The protocols are listed in descending order of sophistication. ICE subscribers have software that coordinates the exchange with the CDS Server and writes the delivered content to the target repository. For FTP subscribers, the CDS Server writes the content directly to the target repository using the FTP protocol. subscribers receive the content through their software and must develop their own way of transferring the content from the message to the repository. Documentum Content Distribution Services includes ICE-compliant CDS Client software that a distributor can distribute to its subscribers. However, subscribers need not use the CDS Client software to receive the content through FTP or . The Documentum Content Distribution Services Release Notes contains details about the system requirements. The following sections provide an overview of the key tasks involved in distributing content and introduce the Content Distribution Services object types involved in the tasks: Making content available: offers and packages, page 12 Preparing content for delivery: Templates, page 13 Receiving content: subscribers and subscriptions, page 14 Scheduling delivery, page 15 Making content available: offers and packages To make content available to subscribers, a distributor defines offers. An offer is a collection of documents for distribution. The offer consists of a query that retrieves the relevant documents from the source repository and a schedule for when the CDS Server runs the query. For the first time, when the CDS Server runs the offer query, it creates a package consisting of all the documents returned by that query. The package represents the contents of the offer at a particular time and is the object that the server actually delivers to subscribers. Each subsequent time that the server runs the offer, it compares the results to the previous package and creates a new package consisting of just the updates. The server keeps track of which package each subscriber last received. Each time it runs the subscription, the server creates a delivery package consisting of only the changes to the offer since the last delivery; that is, it delivers the cumulative content of the new packages. The Chapter 3, Offering Content contains more information on creating offers. 12 Documentum Content Distribution ServicesTM Administration Guide

13 Introducing Documentum Content Distribution Services Figure 1-2. Offers and packages Preparing content for delivery: Templates When the CDS Server creates an offer package, the content and format of each document in the package is the same as it is in the source repository. The content distributor may want to modify or enhance the content before delivering it to subscribers. For example, they might add a header to each document with their company logo or a date stamp. Content Distribution Services enable you to modify the content of an offer using templates. A template contains instructions for manipulating offer content, which the CDS Server performs before sending the content to a subscriber. Content Distribution Services support three types of templates: JavaServer Page (JSP) templates that process document content, such as by adding information or modifying the format XSL stylesheets that process the content of XML documents Documentum Content Distribution ServicesTM Administration Guide 13

14 Introducing Documentum Content Distribution Services ZIP templates that create compressed versions of the documents The CDS Server can apply templates to each document individually, to all documents in an offer package collectively, or to a subscription package as a whole. Most commonly, JSP and XML templates apply to each document individually and ZIP templates apply to the offer or subscription package. The Creating templates, page 52 contains more information on creating templates. When you define an offer, you specify which templates are available for that offer. When a subscriber creates a subscription, he or she can choose whether to apply one or more of the available templates. The Chapter 3, Offering Content and Chapter 5, Subscribing to Offers contain more information. Figure 1-3. Applying templates to offer content Receiving content: subscribers and subscriptions To receive content from a CDS Server, a person must be registered on the server as a subscriber. The subscriber user account identifies which offers are available to the subscriber. 14 Documentum Content Distribution ServicesTM Administration Guide

15 Introducing Documentum Content Distribution Services Figure 1-4. Subscriber access to offers Once subscribers have accounts on the CDS Server, they can subscribe to any offers linked to their accounts. To actually receive the contents of an offer, the subscriber creates a subscription (or the content provider creates a subscription on behalf of that subscriber). With a subscription, the subscriber signs up for one or more offers as they exists now and for any subsequent updates. The subscription specifies: Which offers the subscriber is subscribing to Which of the available protocols to use for delivering the content (ICE, FTP, or ) Where to send the content How often to check for updates to the offers; that is, when to check for new packages When the CDS Server runs the subscription, it delivers the content of the latest packages to the address in the subscription, using the specified protocol. The subscriber updates the target repository. The Chapter 4, Registering subscribers contains more information on creating user accounts for subscribers. The Chapter 5, Subscribing to Offers contains more information on creating subscriptions. Scheduling delivery Each offer and each subscription has a schedule associated with it. These schedules are independent of each other. For example, suppose an offer runs every four hours, and a subscription to that offer runs twice a day (every 12 hours). The server may create as many as three new packages between sending updates to the subscriber. When the subscription runs, the server delivers to the subscriber the content of all packages created since the last time the subscription ran. Documentum Content Distribution ServicesTM Administration Guide 15

16 Introducing Documentum Content Distribution Services Figure 1-5. Server scheduling Understanding the CDS Server This section gives an overview of how the CDS Server distributes content based on the elements described in the previous sections. It provides a more technically oriented view of: What the CDS Server does?, page 17 What the CDS Server retrieves from the repository?, page 18 What the CDS Server delivers to subscribers?, page Documentum Content Distribution ServicesTM Administration Guide

17 Introducing Documentum Content Distribution Services What the CDS Server does? Once you have created and scheduled offers and subscriptions, the CDS Server manages content distribution automatically. When the CDS Server is running, it monitors its internal schedule to determine when to run offers and subscriptions. When the time comes to run an offer, the server performs these steps: 1. Checks that the offer is active. 2. Connects to the source repository defined for the offer. 3. Submits the selection query defined for the offer. 4. Receives the results back from the source repository. 5. Compares the returned results to the current state of the offer. 6. If necessary, creates a new package reflecting the changes to the offer contents. 7. Saves the latest results as the current state of the offer. 8. Disconnects from the source repository. By default, the CDS Server creates a package consisting of the new or updated documents returned by the offer query and copies the documents into a cache directory on the CDS Server. When a subscription is run for that offer, the CDS Server sends the documents from its cache. For Documentum repository or file-system repositories, you can create offers for which the offer query retrieves references to documents in the source repository instead of the documents themselves. When the CDS Server runs the offer query, it creates a package consisting of document identifiers rather than documents. When a subscription is run for that offer, the CDS Server retrieves the identified documents from the repository and sends them to the subscriber. This option, called retrieve content by reference, reduces the amount of space required in the CDS Server cache directory but increases the time required to fill a subscription. When the time comes to run a subscription, the server performs these steps: 1. Identifies the subscriber and the offers from the subscription. 2. Verifies that the subscriber still has access to the offers and that the offers have not expired. For any expired offers, the CDS Server notifies the subscriber that the offer s content will not be included. 3. For ICE subscriptions, checks whether the subscriber confirmed delivery of all previous packages. If any confirmations are outstanding, the CDS Server waits for the amount of time specified in its configuration file, then checks again. If the Documentum Content Distribution ServicesTM Administration Guide 17

18 Introducing Documentum Content Distribution Services confirmation has not been received, the CDS Server stops the subscription and notifies the subscriber. 4. Checks the subscription to determine which package the subscriber last received for each subscribed offer. 5. For each offer in the subscription, compares the historical package number to the current package number for the offer. If there are no new packages, no further action is necessary and the server skips the remaining steps. 6. Creates a delivery package consisting of the changes to the offers since the last packages received by the subscriber. For offers that retrieve content by reference, the CDS Server connects to the source repository and retrieves the documents; for other offers, the documents are retrieved from the CDS Server cache. 7. Prepares the delivery package by applying any associated templates. 8. Attempts to deliver the package to the subscriber using the protocol and address from the subscription. 9. If delivery fails, the server logs the error. The subscriber will not receive any updates until the next time the subscription runs. 10. When delivery succeeds, the server updates the subscription to record delivery of the package. What the CDS Server retrieves from the repository? The selection query for an offer returns a list of the documents that make up the offer. By default, the CDS Server retrieves the documents from the repository and copies them into a cache directory. For each document, the CDS Server attempts to retrieve: A content file A set of attributes describing the content file, such as its name and revision date The content file is the primary file that the CDS Server delivers to subscribers. The attributes provide metadata that the CDS Server uses to control the distribution process. For example, it uses the revision date attribute to determine whether a given document has changed since the last time the offer was run. The CDS Server creates an XML file for each content file containing its attribute information. The XML file may or may not be sent to subscribers as part of the offer, depending on whether the subscription requests the metadata. Note: The What the CDS Server delivers to subscribers?, page 20 contains information on Documentum repositories, Site Caching Services repositories, and relational databases, the selection query may also return additional user-defined attributes, which are added to the XML file. 18 Documentum Content Distribution ServicesTM Administration Guide

19 Introducing Documentum Content Distribution Services For file-based repositories, the content file is the file as it exists in the file system. The file system also supplies the attribute values for the file, such as its filename and last modified date. For Documentum repository offers, the content file is one rendition of a specific version of the Documentum repository object. By default, the CDS Server retrieves the primary rendition of the current version, but the offer can specify a different rendition or version. The attributes retrieved from the repository are the ones for the selected rendition and version. The CDS Server determines whether the file has changed since the last time the offer was run by comparing the value of the r_modify_date attribute to its previous value. For Site Caching Services repositories, the content file is the file as it exists in the Site Caching Services target root directory. The CDS Server uses the last modified date on the file to determine whether a given document has changed. File attributes are retrieved from the Site Caching Services property tables. The selection query for a database offer is a SQL statement. The CDS Server identifies the content file and attributes by looking for specially named columns in the result set: The value in the CONTENT column is the content file. The value in the FILENAME column is the name to use for the content file. The value in the VERSION column is used to determine whether the content file has changed since the last time the offer was run. The value in the ID column is used as the unique identifier for the document. Note: The result set needs to use these column names. If the column names in the relational database are different, use the SQL AS command to use these names as aliases. If the SQL result set does not include one or more of these columns, or if the value for that column is missing, the CDS Server uses these defaults: If a CONTENT value is missing, the content file is empty. If a FILENAME value is missing, the filename is null. If a VERSION value is missing, the CDS Server sets the attribute value to INITIAL. The CDS Server will not recognize new versions unless the VERSION is updated. If a ID value is missing, the CDS Server assigns a system-generated identifier. The identifier may be different each time the offer is run, causing the CDS Server to resend the same document multiple times. If the SQL selection query returns any additional columns, the column/value pairs are stored as user-defined attributes. Documentum Content Distribution ServicesTM Administration Guide 19

20 Introducing Documentum Content Distribution Services What the CDS Server delivers to subscribers? When a subscriber receives a package from the CDS Server, it contains the content files retrieved from the source repository. If the subscription includes one or more templates, the CDS Server applies them before delivering the package. The filenames of the delivered files are determined by the file s FILENAME attribute, whose value the CDS Server sets on the basis of the offer selection query (The What the CDS Server retrieves from the repository?, page 18 contains more information). For files from a repository, Content Server adds the standard DOS extension if the file s object name does not already include it. If the subscription includes applying one or more templates to the content files, the template may change the filename; the Creating templates, page 52 contains more information on this. If the subscription has the Send metadata option selected, the package sent to the subscriber also includes the XML files containing attribute information for each content file. The Creating offers, page 36 contains more information on how to select which attributes to deliver, and the Appendix B, Attribute File XML Format contains more information on the structure of the file. The XML file names match the corresponding content files except for their extension. The attribute files appear in a.cxf subdirectory of the directory containing the content files. Once a subscriber has received the initial package for an offer, subsequent packages may contain instructions to delete items the subscriber has already received. Only ICE subscribers receive deletion instructions; FTP and subscribers do not. Using CDS Content Distribution Services recognizes two types of users: Administrators, who represent the content distributor or provider Subscribers, who receive content from the distributor Every distributor has at least one administrator. Administrators are responsible for defining what content is available and which subscribers have access to it. Using Content Distribution Services Administrator (CDS Administrator), they create offers, templates, and subscriber accounts. Administrators also maintain and troubleshoot the CDS Server. The Administrator tasks, page 21 contains more information. Subscribers are responsible for maintaining their local repositories, which includes making sure that the repository is correctly updated with the content they receive from the distributor. Depending on the policies of the distributor, subscribers may log in to CDS Administrator to create their own subscriptions, or the distributor may have an administrator create subscriptions on their behalf. The Subscriber tasks, page 21 contains more information. 20 Documentum Content Distribution ServicesTM Administration Guide

21 Introducing Documentum Content Distribution Services Administrator tasks The tasks required to administer Content Distribution Services fall into two major categories: those you perform at installation time to set up the initial distribution framework, and those you perform on an on-going basis to maintain the system. You need to perform the initial setup tasks for Content Distribution Services in order. 1. Install and configure the software by following the instructions in Installing Documentum Content Distribution Services. 2. Define the content that is available for distribution by creating offers and templates in CDS Administrator. The Chapter 3, Offering Content contains more information. 3. Register subscribers using CDS Administrator. In many cases, you also need to deliver the CDS Client software to the subscriber. The Chapter 4, Registering subscribers contains more information. 4. Create subscriptions or provide your subscribers with instructions for creating their own. The Chapter 5, Subscribing to Offers contains more information. You may perform ongoing maintenance tasks as needed. Register new subscribers by creating their user accounts. The Chapter 4, Registering subscribers contains more information. Create subscriptions for new and existing subscribers, unless you allow subscribers to create their own subscriptions. The Chapter 5, Subscribing to Offers contains more information. Create new offers and inform subscribers about their availability. TheChapter 3, Offering Content contains more information. Monitor the CDS Server processing. The Chapter 7, Monitoring Server Processing contains more information. Subscriber tasks The tasks required for a subscriber depend on the policies of the content distributor and on the protocol in which the subscriber receives content. The major steps involved in subscribing to an offer are described below. 1. Contact the distributor to learn what content is available to you and identify which offer you want to subscribe to. 2. Determine whether you need to install and configure the Documentum CDS Client. The CDS Client enables you to receive content using the ICE protocol and update Documentum Content Distribution ServicesTM Administration Guide 21

22 Introducing Documentum Content Distribution Services your target repository automatically. If you will use the CDS Client, install it according to instructions provided by the content distributor or from Installing Documentum Content Distribution Services. 3. Collect the information the distributor needs in order to deliver the content. The necessary information depends on the delivery protocol. ICE subscribers need the URL for the CDS Client. For details about the CDS Client, the Chapter 6, Using the Content Distribution Services Client Application contains more information. FTP subscribers need the URL for the FTP server and directory as well as the login information for a user account the CDS Server can use to log in to the FTP server. subscribers need the address to which the CDS Server sends the offer content. 4. Create a subscription to the offer. Depending on the policies of the distributor, you may create your own subscriptions or provide the relevant information to the distributor. The Chapter 5, Subscribing to Offers contains more information on creating your own subscriptions. 5. If you are an ICE subscriber, configure the subscription using CDS Client. The subscription is not complete until you perform this step. The Chapter 6, Using the Content Distribution Services Client Application contains more information. 6. If necessary, develop a process for post-processing the delivered content. If you receive the content in zipped format, you may need to unzip it to make it available in the target repository. 22 Documentum Content Distribution ServicesTM Administration Guide

23 Chapter 2 Using CDS Administrator Content Distribution Services Administrator (CDS Administrator) is a Web-based application that runs on the CDS Server. You use it to define the objects that make up your distribution scheme. This chapter describes the basic mechanics of using CDS Administrator: Logging in, page 23 Navigating in the application, page 24 Scheduling offers and subscriptions, page 29 Sending notifications, page 33 Logging in To log into CDS Administrator: 1. Point your browser to the URL <web_server> is the name of the Web server hosting the application and <port_number> is the port that CDS Administrator monitors. 2. Enter your Content Distribution Services login name and password. When you enter the password, asterisks display in place of the characters you type for security purposes. 3. Click Login. The main screen appears. The menu along the left displays the object types you have security access to: all types if you are designated as an administrator, or just your subscriptions and user information if you are not. If the login is unsuccessful, a message appears beneath the Login name and Password fields indicating the problem. Correct the problem and try again. If the problem persists, consult your system administrator. Documentum Content Distribution ServicesTM Administration Guide 23

24 Using CDS Administrator Navigating in the application The main menu for CDS Administrator always appears on the left. If you are logged in as an administrator, the menu lists the major object types that you create: Subscribers Groups Offers Templates Subscriptions If you are logged in as a subscriber who is not part of the administration group, you can only create and modify your own subscriptions and user information; you can access only Subscriber Info, Subscriptions and a read-only list of the Offers available to you. Across the top of the screen is a header that identifies the application, shows your user name, and gives access to the online help. Across the bottom of the screen is a message area where CDS Administrator displays status messages. Error messages, should they occur, appear in the area just below the page name. The pages in CDS Administrator are organized into sets based on which object type they relate to. The structure of each set of pages is similar: When you select an object type from the menu, the list page for that object type appears. You use this page to select the object you want to work with or to create a new one. For details about using the list page, the Using list pages, page 25 contains more information. When you select or create an item from the list page, the application displays the first property page for that object. You use this page to enter details about the object. The property pages differ for each object type. Most Content Distribution Services objects have a series of property pages. The names of the pages appear, in the order that you should complete them, in the tab list between the menu and the current property page. Tabs for pages that are optional appear in italics. Click the page name in the tab list to move to that page. At the bottom of property pages is a button bar with buttons for moving back and forth between the property pages and for saving your changes. The Finish button saves the object and returns you to the list page. If the Finish button does not appear, it means you have not yet entered all required information. Note: It is important that you click the Finish button. If you proceed without clicking the Finish button, your changes will not be saved. Use the Display Help checkbox in the upper right to decide whether to display onscreen help text that gives tips for using the controls. When the box is selected, the help text appears on the right; when the box is not selected, the help text does not appear, freeing up some screen space. 24 Documentum Content Distribution ServicesTM Administration Guide

25 Using CDS Administrator Figure 2-1. Parts of the CDS Administrator screen CDS Administrator considers all property pages associated with a particular object as a single unit of work. When you click the Finish button, the application saves the changes from all the property pages for this object, not just the current one. Similarly, the Cancel button cancels all changes. Note: It is important to click the Finish button to save the changes you have made. Without clicking the Finish button, if you move to a different page, your changes will not be saved. Using list pages When you select an object type from the main menu, the first page that appears is the list page for that object type. The list page provides a variety of options for displaying the available objects as well as buttons for creating and deleting objects. Documentum Content Distribution ServicesTM Administration Guide 25

26 Using CDS Administrator Figure 2-2. List Page By default, the list page displays up to the first 10 items, sorted alphabetically by name. You can change the number of items displayed on the page at one time by selecting a number from the Show Items dropdown list. You can change the sort order by clicking the column name for the column you want to sort by; click once to sort in ascending order, then again to sort in descending order. The text next to the Show Items box shows how many items can be displayed on the page. If there are more items than can show on one page, click to view the next set of items or to view the previous set. The and buttons take you to the beginning and end of the list respectively. To move to a specific set of items, enter a page number in the Page box. To jump directly to an item whose name you know, enter the initial letters of the name into the box on the right, then click Go. To add a new item, click the Create Object button, where Object is the object type listed on this screen. A blank property page for this object type appears. To modify an existing item, click the name of the item you want or the Info icon next to it. The first property page for the selected object appears. To delete one or more items, select the checkbox next to the items, then click the Delete Object button. CDS Administrator asks you to confirm that you want to remove the items from the system. The message also reminds you that deleting these objects may result in deleting other dependent objects; for example, deleting an offer deletes all associated subscriptions. Click Delete to continue or Cancel to stop the deletion. 26 Documentum Content Distribution ServicesTM Administration Guide

27 Using CDS Administrator Other buttons may appear as well, depending on which object type is listed. For Subscribers, Groups, and Offers, the Notify Object button takes you to the Send Notification page so that you can send a message. Select the checkbox next to the names of the subscribers or groups you want to send the message to, or the offers whose subscribers you want, then click the Notify Object button. For information about sending notifications, the Sending notifications, page 33 contains more information. For Offers and Subscriptions, the Run Object button executes the selected offer or subscription immediately, regardless of its schedule. CDS Administrator displays a page asking you to confirm that you want to run the offer or subscription. Click Start to run it or Cancel to return to the list page without running it. For Offers, the Create Subscription button provides a shortcut to the property pages for subscribing to the offers selected in the list. The Preview Subscription button displays a list of the documents that would be included in a subscription to the selected offers. Using attributes pages Each of the objects you create in CDS Administrator has a property page called Attributes, which you use to specify a category for the object. You also have the option to assign additional user-defined attribute values to the object. Figure 2-3. Attributes page Documentum Content Distribution ServicesTM Administration Guide 27

28 Using CDS Administrator An object s category appears on the list page and on selection pages. Clicking on the Category column sorts the objects on the list page into groups based on their category; selecting a category on a selection page displays only objects of that category. If you add other attributes to the object, their values are stored with the object definition in the CDS database, but they do not appear on the list page or any other place in the user interface. When you create a new object, the category is set to a default value specified in the CDS Server configuration file cds.xml unless you enter a different value in the Category box. As delivered, the default category is DEFAULT. To add an attribute, enter the name of the attribute in the Attribute box and its value in the Value box, then click Add. To remove an attribute, highlight it in the Attributes box and click Remove. Using selection pages Most of the objects you create in CDS Administrator have at least one property page that requires you to select one or more related objects of another type. For example, when you create a subscriber, you select which offers the subscriber can subscribe to, and when you create an offer, you select which templates are available for the offer. The figure below shows the page you use to select the offers that a subscriber can subscribe to, but the available options are the same regardless of what type of object you are selecting. Figure 2-4. Selection page 28 Documentum Content Distribution ServicesTM Administration Guide

29 Using CDS Administrator The Available listbox on the left shows the objects that are available; the Selected listbox on the right shows the objects already selected. The Category box above the Available list enables you to control which objects appear in the Available list. To select an object, you move it from the Available box to the Selected box. You can do that in these ways: Double-click the object name in the Available list. Highlight the name in the Available list, then click Add >. Click Add All >> to select all available objects. To deselect an object, you move it from the Selected box to the Available box. You can do that in these ways: Double-click the object name in the Selected list. Highlight the name in the Selected list, then click < Remove. Click << Remove All to deselect all selected objects. Scheduling offers and subscriptions When you create offers and subscriptions, you specify a schedule on which the CDS Server runs them. The schedules are independent of each other. For example, suppose you schedule an offer to run every four hours, and a subscription to that offer runs twice a day (every twelve hours). The server may create as many as three new packages between sending updates to the subscriber. When the subscription runs, the server delivers to the subscriber all packages created since the last time the subscription ran. Note: When creating schedules, it is mandatory to fill in the details on Info and Query screens, while editing/creating offer before you create schedules. When editing subscription, it is mandatory to fill in the details on Info and Destination screens before you create schedules for subscriptions. Documentum Content Distribution ServicesTM Administration Guide 29

30 Using CDS Administrator Figure 2-5. Schedule page Clicking on Schedule, lists all the schedules you have created. Click on the type of schedule to view the Schedule property page. The Schedule property pages for offers and subscriptions present the same scheduling options, which are described in the procedure below. 30 Documentum Content Distribution ServicesTM Administration Guide

31 Using CDS Administrator Figure 2-6. Schedule property page This procedure assumes you are on the Schedule property page for an offer or a subscription. For information about getting to this page as part of defining the object, the Chapter 3, Offering Content or Chapter 5, Subscribing to Offers contains more information. To schedule an offer or subscription: 1. Select the base schedule frequency. The value you choose from the Run box determines what controls appear on this page and how many steps of this procedure you need to complete. The options are: One Time Weekly Monthly The server runs the offer or subscription once, at a specified date and time. The One Time option is appropriate for static offers whose contents do not change over time. The server runs the offer or subscription on specified days of the week, one or more times each day. The server runs the offer or subscription on specified dates each month, one or more times each day. 2. Enter a start date when the server first runs the offer or subscription. Documentum Content Distribution ServicesTM Administration Guide 31

32 Using CDS Administrator To start the schedule immediately, select Now. The Now option is the default for Weekly and Monthly schedules, and is not available for One Time schedules. To start the schedule later, select Specify and enter a future date and time. Click the calendar icon to select the date, or type it using the format MM/DD/YY. The format for the time is HH:MM, followed by AM or PM. If you omit the time, the schedule starts at midnight. If you selected One Time, the schedule is complete. You do not need to complete the rest of this procedure. The server will run the offer or subscription at the specified time. 3. Enter the stop date when the server stops running the offer or subscription. To keep the schedule active until someone changes it, select Never. To stop the schedule after a limited time, select Specify and enter a date and time. The date and time must be later than the start date and time. 4. Identify the days on which to run the offer or subscription. For a Weekly schedule, select each day of the week when the CDS Server should run the offer or subscription. For a Monthly schedule, enter the day number for each date when the CDS Server should run the offer or subscription. Separate the numbers with commas. For example, to run an offer on the 15th and 30th of each month, enter 15, Identify how often to run the offer or subscription on each scheduled day. To run once a day, select Once and enter the time. The format for the time is HH:MM, followed by AM or PM. If you omit the time, the schedule starts at midnight. To run multiple times per day, select Repeat every and indicate how often to repeat. Enter a number in the text box and select minutes or hours. Also select a starting and ending time for each day; the default is 9 AM to 5 PM. If you select minutes, the offer or subscription runs every specified number of minutes, starting at the top of the hour and repeating each time that number of minutes passes within a single hour. For example, if you repeat every 15 minutes, the offer or subscription runs each hour at 15, 30, and 45 minutes past the hour (but not at the top of the next hour). If you select hours, the offer or subscription runs every specified number of hours at the top of the hour. 6. Click Finish to save the changes. Note: After clicking the Finish button on Schedule properties page, it is important that you click the Finish button on the offer/subscription screen. If you proceed without clicking the Finish button on the offer/subscription screen, your changes will not be saved. 32 Documentum Content Distribution ServicesTM Administration Guide

33 Using CDS Administrator Deleting schedules The Delete Schedules button is available on the schedule list page. To delete schedules: 1. Select the checkbox against the schedule. 2. Click Delete to delete the schedule. 3. The system prompts you to confirm the schedules to be deleted. 4. Click OK to confirm. 5. Click Finish button on the offer/subscription page to delete the schedule. Note: After clicking the Finish button on Schedule properties page, it is important that you click the Finish button on the offer/subscription screen. If you proceed without clicking the Finish button on the offer/subscription screen, your changes will not be saved. Sending noti cations CDS Administrator provides a facility for sending messages to subscribers, enabling administrators to keep them informed about new offers or administrative bulletins. When you send notifications from the Offers list page, the CDS Server delivers the notifications differently for subscribers who receive offer content using the ICE protocol: the server sends these notifications to the subscriber s CDS Client application as well as to their address. FTP and subscribers receive the notifications through only. Administrators use this page to send personally composed messages to subscribers. In addition to these messages, subscribers receive automatic notification from the CDS Server when updates are made that affect their subscriptions. For example, the CDS Server notifies subscribers when an offer they subscribe to is deleted or removed from the list of offers they can access. Administrators can reach the notification page from the list pages for Subscribers, Groups, and Offers. To send a noti cation: 1. Select the users you want to send the message to. On the Subscribers list page, click the checkbox next to the individual subscribers who should receive the message. Documentum Content Distribution ServicesTM Administration Guide 33

34 Using CDS Administrator On the Groups list page, click the checkbox next to the groups whose subscribers should receive the message. On the Offers list page, click the checkbox next to the offers whose subscribers should receive the message. 2. Click the Notify Object button. The Send Notification page appears. The text in the upper left indicates who this message will be sent to. 3. Enter a subject line for the message. The subject line is the text that appears in the recipient s inbox. 4. Select a message priority for ICE notifications. The Priority setting has no effect for notifications. 5. Enter the body of the message in the Message box. 6. Click Notify to send notification to the subscribers. 34 Documentum Content Distribution ServicesTM Administration Guide

35 Chapter 3 Offering Content The core of Documentum Content Distribution Services is the offer. An offer is a collection of documents or other content that you are making available to subscribers. In other words, the offer is the content you are distributing. In addition to distributing the content, Content Distribution Services enables you to modify the raw content before distributing it to subscriber. The CDS Server can apply templates to the content of an offer. This chapter explains how to create the two content-related object types from the main menu of CDS Administrator: Before you begin, page 35 Creating offers, page 36 Creating templates, page 52 Before you begin Before you can create an offer, you must perform these preparatory tasks: Make sure the CDS Server can locate the source repository and connect to it. For repositories, you specify the connection information when you create the offer. You also need to provide the login information for the user account the CDS Server uses to log in to the repository. The user must have at least Read access to the items it retrieves from the repository. For relational databases and Site Caching Services repositories, you must configure a data source on the application server. The Installing Documentum Content Distribution Services contains more information. The Site Caching Services target root directory must be accessible from the CDS Server host machine. Identify the selection criteria to use to select which documents the offer includes. Documentum Content Distribution ServicesTM Administration Guide 35

36 Offering Content For Documentum repositories, the selection criteria include which folders contain the documents and what attribute values to verify against. For Site Caching Services repositories, the selection criteria are what attribute values to verify against. For file-system repositories, the selection criteria are which folders contain the documents and what pattern the filenames must match. For databases, the selection criteria are captured in a SQL statement that selects the appropriate data. For Documentum repositories, determine which versions, renditions, and attributes to include in the offer. Decide whether to put an upper limit on the number of documents in the offer. Decide how often to run the offer, based on how often updates are expected. Decide whether to enter a value in Max delete limit text box in the offer. For Documentum repositories or file-system repositories, decide whether the documents in an offer should be retrieved from the repository when the offer is run or when the subscription is run. The What the CDS Server does?, page 17 contains more information on retrieving content by reference option. Create any templates that apply to the offer contents. The Creating templates, page 52 contains more information. Creating offers Once you have completed the preparatory tasks, you are ready to create the offer. To create an offer, you specify: Where the content comes from (the source repository)? What content comprises the offer (the offer query)? When and how often the CDS Server runs the offer (the offer schedule)? What templates to make available for transforming the content of the offer? The procedure below explains how to create a new offer or modify an existing offer. The steps are the same in either case. When creating a new offer, you must follow the steps in the order they appear. When modifying an offer, you can generally skip directly to the step that relates to the item you want to change. You must be logged in as an administrator to create or modify offers. If you are logged in as a subscriber, you can view the list of offers available to you but cannot modify them. To create or modify an offer: 1. Select Offers from the menu. 36 Documentum Content Distribution ServicesTM Administration Guide