documentum content server 5.2.5 sp2 installation

27
 Content Server Installation Guide Version 5.2.5 SP2  July 2004 All Platforms

Upload: fauxpaws

Post on 04-Nov-2015

44 views

Category:

Documents


0 download

DESCRIPTION

Documentum installation guide

TRANSCRIPT

  • Content Server Installation Guide

    Version 5.2.5 SP2July 2004

    All Platforms

  • Copyright 1994-2004 Documentum, a division of EMC. All Rights Reserved.DOCUMENTUM, NOW YOU KNOW, UNITING THE WORLD THROUGH CONTENT and the Corporate Logo are trademarks or registered trademarks ofDocumentum, a division of EMC, in the United States and throughout the world. All other company and product names are used for identification purposesonly and may be trademarks of their respective owners.

  • Table of Contents

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

    Chapter 1 Planning for Installation ......................................................................... 7About Installation....................................................................................... 7

    Effects of Installation .............................................................................. 7Operating Systems and Databases .............................................................. 8

    Upgrade Paths to Windows Server 2003 Operating System........................ 8Configuration Decisions.............................................................................. 8Making Backups......................................................................................... 9Upgrading DocBrokers ............................................................................... 9

    Chapter 2 Upgrading Content Server ...................................................................... 11Before You Upgrade.................................................................................... 11

    Upgrading Distributed Configurations .................................................... 11Upgrading the Server Software Installation on the Host ................................ 11Upgrading the DocBroker, the Server and the Docbase.................................. 13

    Chapter 3 Postinstallation Tasks ............................................................................. 17WDK Applications ..................................................................................... 17Setting the i_retain_until Attribute............................................................... 17Running Scripts Manually........................................................................... 17

    Apply Formats Script.............................................................................. 17Docbase Tools Script ............................................................................... 18Content Services for EMC Centera Script.................................................. 18Templates Script ..................................................................................... 18DFC Support Script ................................................................................ 19Content Intelligence Services Schema Installation Script............................ 19Email Templates Components Script ........................................................ 19Display Configuration Setup Script.......................................................... 19Data Dictionary Script............................................................................. 19

    Chapter 4 Setting the i_retain_until Attribute ......................................................... 21

    Chapter 5 Uninstalling Content Server ................................................................... 27

    Content Server Installation Guide 3

  • Table of Contents

    List of Tables

    Table 41. UPDATE_RETAIN_UNTIL_DATE Arguments ................................................. 24

    4 Content Server Installation Guide

  • Preface

    Purpose of the ManualThis manual contains information and instructions you need to upgrade DocumentumContent Server on any platform from version 5.2.5 or 5.2.5 SP1 to version 5.2.5 SP2. Itdescribes requirements that must be met before you upgrade the server. It also providesstep-by-step instructions for upgrading.

    Intended AudienceThis manual is intended for the person upgrading Content Server from version 5.2.5 or5.2.5 SP1 to 5.2.5 SP2. Typically, a system administrator upgrades the software.

    Revision HistoryThe following revisions have been made to this document:

    Revision History

    Date Description

    July 2004 First published

    Related DocumentationYou can find additional information about Content Server in the following manuals:

    Content Server Fundamentals contains information on Docbases, DQL (DocumentQuery Language), objects and types, documents, virtual documents, and otherfeatures of the Documentum system.

    Content Server Administrators Guide contains information on configuring aDocumentum installation, managing Content Server, DocBrokers, full-text indexes,Docbase security and many other subjects.

    Documentum Distributed Configuration Guide contains information on implementingand managing single- and multi-Docbase distributed configurations, objectreplication, content replication, Docbase federations, and the architecture ofdistributed configurations.

    Content Server Object Reference Manual contains reference information on objects.

    Content Server Installation Guide 5

  • Preface

    Content Server API Reference Manual contains reference information on server APImethods

    Content Server DQL Reference Manual contains reference information on DocumentQuery Language (DQL)

    Documentum System Migration Guide contains information on migrating yourDocumentum installation from a previous release to Documentum 5.

    These manuals are available on the Documentum download site or the productdistribution CD as PDF files.

    ConventionsThis manual uses the following conventions:

    Typographic Conventions

    Convention Description

    Represents a menu.

    italics Represents a term, or a variable for whichyou must provide a value.

    typewriter Represents code samples, user input, andcomputer output.

    [] square brackets Indicates an optional argument in methodcommand-syntax specifications.

    {} curly braces Indicates an optional argument that canbe repeated in method command-syntaxspecifications.

    Links in Server PDF FilesEach Server book contains many clickable cross-references to the other server books.Cross-references to manuals other than the one you are reading only work if the PDFfiles are all in the same directory on your PC and are named with the file names that theyhave on the release CD and Documentum FTP site.

    6 Content Server Installation Guide

  • Chapter 1

    Planning for Installation

    This chapter contains the following topics:

    About Installation, page 7

    Operating Systems and Databases , page 8

    Configuration Decisions, page 8

    Making Backups, page 9

    Upgrading DocBrokers, page 9

    About InstallationContent Server 5.2.5 Service Pack 2 (SP2) is an incremental maintenance release ofContent Server 5.2.5. SP2 can be installed only to an existing 5.2.5 or 5.2.5 SP1 serverinstallation. You cannot create a new server software installation from the SP2 softwaredistribution package.

    After you install SP2, you can continue to create new Docbases and DocBrokers byrunning the Server Configuration Program. Use the instructions for creating newDocbases and DocBrokers in the Content Server Installation Guide for release 5.2.5.

    You cannot revert to Content Server 5.2.5 or 5.2.5 SP1 after Service Pack 2 is installedexcept by destroying the Docbases and DocBrokers and restoring from a full Docbasebackup. The backup must include the database tables for the Docbase and ContentServer host file system, including the file storage areas.

    Effects of Installation

    Applying SP2 to an existing 5.2.5 or 5.2.5 SP1 Docbase:

    Adds attributes to existing Docbase objects

    Adds new types to the Docbase

    Runs configuration scripts

    For more information on the scripts, refer to Running Scripts Manually, page 17.

    Upgrades the DocBrokers and Docbases on the Content Server host from version5.2.5 or 5.2.5 SP1 to version 5.2.5 SP2

    Content Server Installation Guide 7

  • Planning for Installation

    Backs up the earlier version of all changed files to $DOCUMENTUM/_5.2.5.SP2_backup (UNIX) or %DOCUMENTUM%\_5.2.5.SP2_backup (Windows)

    Writes a log file entry to username.ServerSPInstaller.log for every file copied andevery file backed up and replaced

    Operating Systems and DatabasesService Pack 2 is supported on the same operating systems and databases as ContentServer 5.2.5 and 5.2.5 SP1. Refer to the release notes for 5.2.5 SP2 for completeinformation on supported platforms.

    Upgrade Paths to Windows Server 2003 OperatingSystem

    Content Server 5.2.5 is not supported on Windows Server 2003. However, you mayinstall Content Server 5.2.5 on Windows Server 2003 and then immediately apply ServicePack 2. Three upgrade paths are supported.

    The first upgrade path is:

    1. Install Content Server 5.2.5 on Windows 2000.

    2. Install Service Pack 2.

    3. Upgrade the operating system to Windows 2003.

    The second upgrade path is:

    1. Install Content Server 5.2.5 on Windows 2000.

    2. Upgrade the operating system to Windows 2003.

    3. Immediately install Service Pack 2.

    The third upgrade path is:

    1. Install Content Server 5.2.5 on Windows 2003.

    2. Immediately install Service Pack 2.

    Configuration DecisionsIf Content Services for EMC Centera and Trusted Content Services were not enabledwhen Content Server 5.2.5 was installed, you can optionally enable them when youconfigure the Docbase after installing Service Pack 2.

    8 Content Server Installation Guide

  • Planning for Installation

    Content Server 5.2.5 SP2 introduces a new feature, Content Storage Services (CSS),which requires purchasing a Content Storage Services license. CSS provides tools fordetermining content storage for new documents automatically by object type, format,and other parameters, using assignment policies. Storage for existing documents can bedetermined using migration policies. CSS is enabled during Docbase configuration.

    Making BackupsThe only way to roll back from SP2 to an earlier installation of Content Server 5.2.5 is byrestoring from a backup of the earlier Docbase. Ensure that you create a full Docbasebackup before you install SP2. The backup must include the database tables for theDocbase and Content Server host file system, including the file storage areas.

    Upgrading DocBrokersIf you are upgrading a server installation to SP2, you must upgrade any DocBrokersin that installation.

    You are not required to upgrade DocBrokers on remote hosts.

    Content Server Installation Guide 9

  • Planning for Installation

    10 Content Server Installation Guide

  • Chapter 2

    Upgrading Content Server

    This chapter describes how to upgrade to Content Server 5.2.5 SP2.

    This chapter contains the following topics:

    Before You Upgrade, page 11

    Upgrading Distributed Configurations, page 11

    Upgrading the Server Software Installation on the Host, page 11

    Upgrading the DocBroker, the Server and the Docbase, page 13

    Before You UpgradeReview the Content Server Installation Guide for version 5.2.5 in addition to this document.Ensure that all required settings and parameters are correct.

    On Windows, you must add DFC_install_location\jdk\142_04\bin to the PATH systemenvironment value. On UNIX, ensure that all environment variables are set correctly.

    Upgrading Distributed Configurations

    In multiserver and distributed configurations, upgrade the server software and run theserver configuration program on all of the secondary hosts.

    Upgrading the Server Software Installation onthe Host

    Use these instructions to upgrade the server software installation on the host.

    To upgrade the software installation to SP2:

    1. Log in to the host system using the installation owner account.

    This is the account used to install the existing Content Server and Docbase(s).

    2. Disable all jobs.

    Content Server Installation Guide 11

  • Upgrading Content Server

    On Windows, disable jobs in all Docbases on the host.

    On UNIX, disable jobs in all Docbases in the installation that you are upgrading.

    3. Shut down the Docbases and DocBrokers.

    On Windows, click StartProgramsDocumentumServer Manager, selectthe correct Docbase, and click Stop; click the DocBroker tab, select eachDocBroker, and click Stop.

    Shut down all Docbases and DocBrokers on the host.

    On UNIX, run the dm_shutdown_Docbase script, whereDocbase is the name of theDocbase to be stopped, then stop each DocBroker using the dm_stop_docbrokerutility. (For instructions, refer to Chapter 7, The DocBroker, in the ContentServer Administrators Guide.)

    Shut down all Docbases and DocBrokers in the installation that you areupgrading.

    4. If you have Apache Tomcat or any other application server running as the Javamethod server, shut it down.

    To shut down Tomcat on Windows, stop the service called Documentum JavaMethod Server.

    To shut down Tomcat on UNIX, run the script$DM_HOME/tomcat/bin/shutdown.sh.

    5. Connect to the Documentum download site.

    6. Navigate to the correct product directory.

    7. Navigate to the server version corresponding to your operating system and database.

    8. Copy the compressed distribution file to a temporary directory on the ContentServer host.

    9. Navigate to the files location on the host.

    10. Extract the file.

    On Windows, double-click the file.

    On UNIX, uncompress and untar the file:

    % tar xvf filename

    The following files are extracted from the compressed file:

    ContentServerSP.exe (on Windows) or ContentServerSP_operatingsystem.bin (onUNIX)

    dfcSetup.jar

    server.jar

    suite.jar

    jdkSetup.jar

    11. Start the installation program.

    On Windows, double-click the file named ContentServerSP.exe.

    On UNIX, type

    % ContentServerSP_operatingsystem.bin

    12 Content Server Installation Guide

  • Upgrading Content Server

    and press Enter, where operatingsystem is the operating system on which youare installing.

    A Welcome dialog box is displayed.

    12. Click Next

    The installation program collects information about the host and the Documentuminstallation. The installation program indicates that an earlier version of the serverexists on the host and asks if you want to upgrade.

    13. Click Yes.

    The Documentum Foundation Classes Optional Features dialog box is displayed.

    14. To install the DFC developer documentation, check the checkbox.

    15. On Windows, optionally check the checkbox to install the Primary Interop Assembly

    Check the Primary Interop Assembly Installer checkbox to request installation of aMicrosoft installer package (.msi file) for the DFC primary interop assembly (PIA),or leave the box unchecked if you do not wish to have the package installed. Theinstaller places the installer package for the DFC PIA into the setup subdirectory ofthe program root.

    16. Click Next.

    An informational dialog box is displayed with information about SP2 andinstructions to stop Docbases, DocBrokers, and the Java method server.

    17. Click Ok.

    A dialog box is displayed, listing the products and support components to beinstalled.

    18. Click Next.

    DFC is upgraded and the new server software is installed.

    19. Choose when to configure the server.

    To configure the server immediately, choose Configure server now and clickNext.

    To configure the server at another time, choose Configure server later and clickNext.

    A panel saying that the software has been installed is displayed.

    20. Click Next.

    Upgrading the DocBroker, the Server and theDocbase

    This section provides instructions for upgrading the DocBrokers, Servers, and Docbaseson the host. Perform this part of the upgrade after you upgrade the software installation.On Windows, this part of the upgrade is after the system restarts.

    Content Server Installation Guide 13

  • Upgrading Content Server

    To upgrade the Docbase, Content Server, and the DocBroker:

    1. Start the configuration program.

    On UNIX, type these commands:

    % cd $DM_HOME/install% Server_Configuration_Program.bin

    On Windows, log in to Windows as the Documentum installation owner.

    If the setup process on Windows does not continue automatically, follow these steps:

    a. Restart the host manually.

    b. After the reboot is completed, log in as the Documentum installation owner.

    c. Click StartProgramsDocumentumServer Manager.

    d. On the Utilities tab, click Server Configuration.A Welcome dialog box is displayed.

    2. Click Next.

    3. On Windows, type in the installation owners password and click Next.

    The installer verifies the password.

    4. If you did not enable Trusted Content Services during installation, optionally chooseto enable TCS, type in the license key, and click Next.

    5. If you did not enable Content Services for EMC Centera during installation,optionally choose to enable the feature, type in the license key, and click Next.

    6. Choose Custom Configuration and click Next.

    7. Check both checkboxes.

    It is a requirement that you upgrade the DocBrokers and Docbases in the installation.

    8. Upgrade the DocBrokers.

    a. Choose Upgrade an Existing DocBroker.

    b. Select the DocBroker to upgrade.

    c. Click Next.

    The DocBroker is upgraded.

    d. Choose whether to upgrade additional DocBrokers on the local host or continuewith server configuration.

    e. If you are upgrading additional DocBrokers, perform steps a-d as required.

    f. Click Continue with server configuration and then click Next.The Docbase Configuration dialog box is displayed.

    9. To complete the process of enabling Trusted Content Services:

    a. Choose Enable secure connection in an existing 5.2 Docbase.

    b. Click Next.

    c. Select the connection mode.

    d. Click Next.

    14 Content Server Installation Guide

  • Upgrading Content Server

    The dmcl.ini file is updated.

    e. Click Restart now.

    The Docbase is stopped and restarted.

    f. Click Configure an additional Docbase.

    10. Choose Apply Service Pack 2 to existing Docbase, select the Docbase, and clickNext.

    A dialog box asks if you are sure you want to apply the service pack.

    11. Click Yes.

    12. Choose whether to accept or modify the Docbase configuration scripts.

    In general, you do not need to edit these scripts.

    To accept the scripts, click Next.

    To edit a script, select it and click Edit Script. After you edit and save thescripts, click Next.

    The scripts run and the Docbase is configured.

    13. To install new DocApps for applications that exist in your Docbase, check thecheckboxes and click Next.

    Caution: If Web Publisher 5.2.5 SP1 is installed in the Docbase, do not reinstall theWeb Publisher DocApp or Accelera DocApp.

    14. Optionally choose to enable Content Storage Services (CSS), then type in the licensekey and click Next.

    15. Choose whether to configure additional Docbases on the host.

    To configure additional Docbases, check the checkbox and click Next, then skipback to Step 10.

    To continue, click Exit from server configuration and clickNext.

    A summary dialog box is displayed.

    16. Click Finish.

    The server and Docbase upgrade is complete.

    Content Server Installation Guide 15

  • Upgrading Content Server

    16 Content Server Installation Guide

  • Chapter 3

    Postinstallation Tasks

    This chapter describes any tasks that must be done after the product is installed but before it canbe used.

    This chapter contains the following major topics:

    WDK Applications, page 17

    Setting the i_retain_until Attribute, page 17

    Running Scripts Manually, page 17

    WDK ApplicationsIf you are running any WDK applications against a Docbase that has been upgraded to5.2.5 SP2, restart the application server after the Docbase upgrade.

    Setting the i_retain_until AttributeIf a Docbase is licensed for Content Services for EMC Centera and its storageareas include content-addressed stores using retention dates, execute theUPDATE_RETAIN_UNTIL_DATE apply method after it is upgraded to 5.2.5 SP2. Forinstructions, refer to Chapter 4, Setting the i_retain_until Attribute.

    Running Scripts ManuallyA number of scripts are executed during Docbase configuration. If any do not runcorrectly, run them manually after the upgrade is completed.

    Apply Formats Script

    The dm_apply_formats.ebs script is located in $DM_HOME/bin. It updates the formatobjects that are defined in the formats.cvs file. (The formats.cvs file is located in

    Content Server Installation Guide 17

  • Postinstallation Tasks

    $DM_HOME/install/tools (UNIX) or %DM_HOME%\install\ools (Windows). Thesyntax for running dm_apply_formats.ebs manually is

    dmbasic -f dm_apply_formats.ebs -e testmain -P noreport DocbaseNameUserName Password $DM_HOME/install/tools/formats.csv tracewhere DocbaseName is the name of the Docbase you are upgrading, UserName is the username of a Superuser, and Password is the Superusers password.

    Docbase Tools Script

    The toolset.ebs script is located in $DM_HOME/install/admin (on UNIX) or%DM_HOME\install\admin (Windows). It installs Docbase administration tools. Thesyntax for running toolset.ebs manually is

    dmbasic -f toolset.ebs -e ToolSetup -P DocbaseName$DM_HOME/install/admin ""where DocbaseName is the name of the Docbase you are upgrading. Ensure that youpass in "" as the third argument.

    Content Services for EMC Centera Script

    The csec_plugin_upgrade_525_sp2.ebs script is located in $DM_HOME/install/admin(on UNIX) or %DM_HOME%\install\admin (Windows). It updates the pluginobject required by Content Services for EMC Centera. The syntax for runningcsec_plugin_upgrade_525_sp2.ebs manually is:

    dmbasic -f csec_plugin_upgrade_525_sp2.ebs -e Install -P DocbaseNameUserName Password $DM_HOME OSName

    where DocbaseName is the name of the Docbase you are upgrading, UserName is theuser name of a Superuser, Password is the Superusers password, $DM_HOME is$DOCUMENTUM/product/version_no, and OSName is Windows, Solaris, HPUX, orAIX.

    Templates Script

    The templates.ebs script, located in $DM_HOME/install/admin, creates dm_documentobjects in order to enable creation of new objects with Documentum Desktop. Certainapplications require default template files when opened. The syntax is:

    dmbasic -f templates.ebs -P DocbaseName UserName Password$Documentum $DM_HOME -e Install

    18 Content Server Installation Guide

  • Postinstallation Tasks

    DFC Support Script

    The dfc.ebs script, located in $DM_HOME/install/admin, loads the initial defaultobjects for the Documentum Foundation Classes. The syntax is:

    dmbasic -f dfc.ebs -P DocbaseName UserName Password -eInstall

    Content Intelligence Services Schema InstallationScript

    The ci_schema_install.ebs script, located in $DM_HOME/install/tools, installs all typesnecessary for the Content Intelligence Services application. The syntax is:

    dmbasic -f ci_schema_install.ebs -P DocbaseName UserNamePassword -e EntryPoint

    Email Templates Components Script

    The dm_emailTemplate_install.ebs script creates the objects for the email templatefeature. The script is located in $DM_HOME/install/admin. The syntax is:

    dmbasic -f dm_emailTemplate_install.ebs -P DocbasenameUsername Password -e install

    Display Configuration Setup Script

    The display_config_setup.ebs script is located in $DM_HOME/install/tools. It adds thedefault display configuration objects for Webtop and Desktop. The syntax is

    dmbasic -f display_config_setup.ebs -P DocbasenameUsername Password -e EntryPoint

    Data Dictionary Script

    The dd_populate.ebs script is located in $DM_HOME/bin. It populates the datadictionary with attribute and type information from data files.

    Edit the $DOCUMENTUM/dba/config/Docbase_name/data_dictionary.ini file to add orremove data dictionary language support for the different locales, then run the script.

    The syntax for running dd_populate.ebs manually is

    dmbasic -f dd_populate.ebs -e Entry_Point -P DocbaseName UserNamePassword $DOCUMENTUM/dba/config/docbase_name/data_dictionary.ini

    Content Server Installation Guide 19

  • Postinstallation Tasks

    where DocbaseName is the name of the Docbase you are upgrading, UserName is the username of a Superuser, and Password is the Superusers password.

    20 Content Server Installation Guide

  • Chapter 4Setting the i_retain_until Attribute

    Release 5.2.5 SP2 introduces a new attribute for the dm_sysobject type calledi_retain_until. This attribute records the most restrictive retention date for objects whosecontent is stored in content-addressed storage with a retention date. The most restrictivedate is the retention date farthest in the future, and it may be specified for a primarycontent file or a rendition.

    The attribute value is displayed by Documentum Webtop, so users can view an objectsretention date. Documentum Administrator displays the attribute value also, and userswith appropriate privileges can change its value through Documentum Administrator.

    Upgrading Content Server to 5.2.5 SP2 adds this attribute to the dm_sysobject typedefinition and to all SysObjects in the Docbase. However, upgrading does not set theattribute. After you upgrade, if a Docbase is licensed for Content Services for EMCCentera and its storage areas include content-addressed stores using retention dates,you must execute a new administration method, UPDATE_RETAIN_UNTIL_DATE.This sets the attribute for those objects whose content files have retention dates. Thischapter contains the reference information for executing this method. You must haveSuperuser privileges to execute the method.

    During normal user operations, this attribute is set by:

    Execution of a SET_CONTENT_ATTRS administration method by Content Server

    Execution of a Setcontentattrs API method by the client DMCL.

    Note: The Setcontentattrs method is not atomic. The attribute values set by thismethod are not saved to the Docbase until a Save is issued, either by the DMCL or bythe application (if the transaction is an explicit transaction).

    This attribute is only set if the executing Content Server or client DMCL is at the5.2.5 SP2 level. If you run pre-5.2.5 SP2 Documentum clients, specifically Webtop,against a 5.2.5 SP2 server, the attribute is not updated when users modify contentin content-addressed storage areas. When you do upgrade the client, executingUPDATE_RETAIN_UNTIL_DATE once again, after the upgrade, is recommended, toupdate the i_retain_until attribute for objects that may have been modified using thepre-5.2.5 clients.

    Observe the following guidelines for executing UPDATE_RETAIN_UNTIL_DATE:

    You must have Superuser privileges to execute the method.

    If any affected object is checked out while the method executes, subsequent attemptsto check in the object fail due to a version mismatch error. Consequently, it is

    Content Server Installation Guide 21

  • Setting the i_retain_until Attribute

    strongly recommended that you execute the method in a quiet Docbase and that allobjects are checked in.

    Executing this method does not reset the r_modify_date on the objects. However, itupdates the i_vstamp. Because of this, if objects are part of a replication job, they arere-replicated.

    22 Content Server Installation Guide

  • UPDATE_RETAIN_UNTIL_DATE

    UPDATE_RETAIN_UNTIL_DATE

    Purpose Sets the i_retain_until attribute in SysObjects.

    Syntax

    To update the attribute for a single SysObject:

    EXECUTE update_retain_until_dateFOR sysobject_id

    dmAPIGet("apply,session,sysobject_id,UPDATE_RETAIN_UNTIL_DATE")

    To update the attribute for all objects that satisfy a DQL query:

    EXECUTE update_retain_until_dateWHERE_CLAUSE=qualification[,BATCH_SIZE=integer]

    dmAPIGet("apply,session,NULL,UPDATE_RETAIN_UNTIL_DATE,WHERE_CLAUSE,S,qualification[,BATCH_SIZE,I,integer]")

    Content Server Installation Guide 23

  • UPDATE_RETAIN_UNTIL_DATE

    Arguments

    Table 41. UPDATE_RETAIN_UNTIL_DATE Arguments

    Argument Datatype Value Description

    WHERE_CLAUSE S qualification Specifies a valid DQLWHERE clause qualification.(Refer to the description ofthe SELECT statement in theDQL reference manual for afull description of WHEREclause qualifications.)

    The qualification must beenclosed in single quotes. Allattributes referenced in anexpression of the WHEREclause must belong to thedm_sysobject type. Anyliteral string values in theWHERE clause must beescaped with an additionalsingle quotation mark whenthe method is executed usingdmAPIGet().

    BATCH_SIZE I integer Defines the maximumnumber of SysObjects thatmay be updated in a singletransaction.

    The default is 500.

    Note: If this is set to 0 or anegative number, ContentServer resets it to 500.

    Return ValueThe method returns a collection with one query result object. That object has oneattribute, named result, that records the number of objects modified by the method.

    PermissionsYou must have Superuser privileges to execute this method.

    24 Content Server Installation Guide

  • UPDATE_RETAIN_UNTIL_DATE

    General Notes

    This method affects only objects that have one or more primary content files or renditionsstored in a content-addressed storage area with a retention date. The method sets thei_retain_until attribute of the object to the most restrictive of the retention dates specifiedfor the primary and rendition content files that are stored in the content-addressedstorage areas.

    The most restrictive date is defined as the date that is farthest in the future from thecurrent date.

    Caution: Executing this method updates the i_vstamp attribute of affected objects.Because the method updates i_vstamp, if an affected object is checked out when themethod executes, checking in the object will fail with a version mismatch error. It isstrongly recommended that you execute this method when there is little or no activity inthe Docbase and that all objects that may be affected are checked in before executing themethod.

    The value for the i_retain_until attribute is computed based on information retrievedfrom the content-addressed storage system. Because of this, there may be a smalldifference between the retention date specified when the object was created and thedate for the i_retain_until attribute that is set by the UPDATE_RETAIN_UNTIL_DATEmethod. The retention period in seconds is retrieved from the storage system and isadded to the r_creation_date attribute of the object to compute the retention date.

    The method does not reset the r_modify_date attribute of the affected objects.

    The method logs messages in the server log.

    Related Administration MethodsNone

    ExamplesThe following examples update the attribute for the document identified by090000013573af2c:

    EXECUTE update_retain_until_dateFOR 090000013573af2c

    dmAPIGet("apply,c,090000013573af2c,UPDATE_RETAIN_UNTIL_DATE")

    These examples update 200 SysObjects that store email messages:

    EXECUTE update_retain_until_dateWHERE_CLAUSE=subject=email_msg,BATCH_SIZE=200

    dmAPIGet("apply,c,NULL,UPDATE_RETAIN_UNTIL_DATE,

    Content Server Installation Guide 25

  • UPDATE_RETAIN_UNTIL_DATE

    WHERE_CLAUSE,S,subject=email_msg,BATCH_SIZE,I,200")

    26 Content Server Installation Guide

  • Chapter 5

    Uninstalling Content Server

    You cannot uninstall or back out Service Pack 2 except by restoring from a full Docbase backup,including database tables and the Server host file system.

    To delete a Docbase or DocBroker, or to uninstall the Server software, use the instructions in theContent Server Installation Guide for version 5.2.5.

    Content Server Installation Guide 27

    Content Server Installation GuidePrefacePurpose of the ManualIntended AudienceRevision HistoryRelated DocumentationConventionsLinks in Server PDF Files

    Planning for InstallationAbout InstallationEffects of Installation

    Operating Systems and Databases Upgrade Paths to Windows Server 2003 Operating System

    Configuration DecisionsMaking BackupsUpgrading DocBrokers

    Upgrading Content ServerBefore You UpgradeUpgrading Distributed Configurations

    Upgrading the Server Software Installation on the HostUpgrading the DocBroker, the Server and the Docbase

    Postinstallation TasksWDK ApplicationsSetting the i_retain_until AttributeRunning Scripts ManuallyApply Formats ScriptDocbase Tools ScriptContent Services for EMC Centera ScriptTemplates ScriptDFC Support ScriptContent Intelligence Services Schema Installation ScriptEmail Templates Components ScriptDisplay Configuration Setup ScriptData Dictionary Script

    Setting the i_retain_until AttributeUPDATE_RETAIN_UNTIL_DATE

    Uninstalling Content Server