IDOL Documentum Connector CFS™ Administration Guide
Version 7.5 Document Revision 3 17 October 2011 Copyright Notice
Notice
This documentation is a proprietary product of Autonomy and is protected by copyright laws and international treaty. Information in this documentation is subject to change without notice and does not represent a commitment on the part of Autonomy. While reasonable efforts have been made to ensure the accuracy of the information contained herein, Autonomy assumes no liability for errors or omissions. No liability is assumed for direct, incidental, or consequential damages resulting from the use of the information contained in this documentation. The copyrighted software that accompanies this documentation is licensed to the End User for use only in strict accordance with the End User License Agreement, which the Licensee should read carefully before commencing use of the software. No part of this publication may be reproduced, transmitted, stored in a retrieval system, nor translated into any human or computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual or otherwise, without the prior written permission of the copyright owner. This documentation may use fictitious names for purposes of demonstration; references to actual persons, companies, or organizations are strictly coincidental. Trademarks and Copyrights
Copyright 2011 Autonomy Corporation plc and all its affiliates. All rights reserved. ACI API, Alfresco Connector, Arcpliance, Autonomy Process Automation, Autonomy Fetch for Siebel eBusiness Applications, Autonomy, Business Objects Connector, Cognos Connector, Confluence Connector, ControlPoint, DAH, Digital Safe Connector, DIH, DiSH, DLH, Documentum Connector, DOH, EAS Connector, Ektron Connector, Enterprise AWE, eRoom Connector, Exchange Connector, FatWire Connector, File System Connector for Netware, File System Connector, FileNet Connector, FileNet P8 Connector, FTP Fetch, HTTP Connector, Hummingbird DM Connector, IAS, IBM Content Manager Connector, IBM Seedlist Connector, IBM Workplace Fetch, IDOL Server, IDOL, IDOLme, iManage Fetch, IMAP Connector, Import Module, iPlanet Connector, KeyView, KVS Connector, Legato Connector, LiquidOffice, LiquidPDF, LiveLink Web Content Management Connector, MCMS Connector, MediClaim, Meridio Connector, Meridio, Moreover Fetch, NNTP Connector, Notes Connector, Objective Connector, OCS Connector, ODBC Connector, Omni Fetch SDK, Open Text Connector, Oracle Connector, PCDocs Fetch, PLC Connector, POP3 Fetch, Portal-in-a-Box, RecoFlex, Retina, SAP Fetch, Schlumberger Fetch, SharePoint 2003 Connector, SharePoint 2007 Connector, SharePoint 2010 Connector, SharePoint Fetch, SpeechPlugin, Stellent Fetch, TeleForm, Tri-CR, Ultraseek, Verity Profiler, Verity, VersiForm, WebDAV Connector, WorkSite Connector, and all related titles and logos are trademarks of Autonomy Corporation plc and its affiliates, which may be registered in certain jurisdictions. Microsoft is a registered trademark, and MS-DOS, Windows, Windows 95, Windows NT, SharePoint, and other Microsoft products referenced herein are trademarks of Microsoft Corporation. UNIX is a registered trademark of The Open Group. AvantGo is a trademark of AvantGo, Inc. Epicentric Foundation Server is a trademark of Epicentric, Inc. Documentum and eRoom are trademarks of Documentum, a division of EMC Corp. FileNet is a trademark of FileNet Corporation. Lotus Notes is a trademark of Lotus Development Corporation. mySAP Enterprise Portal is a trademark of SAP AG. Oracle is a trademark of Oracle Corporation. Adobe is a trademark of Adobe Systems Incorporated. Novell is a trademark of Novell, Inc. Stellent is a trademark of Stellent, Inc. All other trademarks are the property of their respective owners. Notice to Government End Users
If this product is acquired under the terms of a DoD contract: Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of 252.227-7013. Civilian agency contract: Use, reproduction or disclosure is subject to 52.227-19 (a) through (d) and restrictions set forth in the accompanying end user agreement. Unpublished-rights reserved under the copyright laws of the United States. Autonomy, Inc., One Market Plaza, Spear Tower, Suite 1900, San Francisco, CA. 94105, US.
17 October 2011 Contents
About this Document ...... 15 Documentation Updates...... 15 Related Documentation...... 16 Conventions ...... 18 Notational Conventions ...... 18 Command-line Syntax Conventions ...... 19 Notices ...... 20 AutonomyProduct References ...... 20 Autonomy Customer Support ...... 21 Contact Autonomy...... 21
Part 1 Getting Started
Chapter 1 Introduction ...... 25 Documentum Connector CFS ...... 25 Documentum Connector CFS Operation...... 26 About Connector Framework Server ...... 27 Autonomy’s IDOL Platform...... 27 Documentum Connector CFS Architecture ...... 28 Import Process...... 30 Documentum Connector CFS Components ...... 30
Chapter 2 Installation...... 33 System Requirements...... 33 Supported Platforms ...... 33 Minimum Server Requirements ...... 34
• • • Documentum Connector CFS Administration Guide • 3 • • Contents
Environmental Requirements ...... 34 Install Documentum Connector CFS on Windows ...... 35 Directory Structure—Windows ...... 37 Connector Framework Server Directory Structure ...... 37 Documentum Connector CFS Directory Structure ...... 38 Install Documentum Connector CFS on Linux ...... 40 Directory Structure—Linux ...... 42 Connector Framework Server Directory Structure ...... 42 Documentum Connector CFS Directory Structure ...... 43
Chapter 3 Configure Documentum Connector CFS...... 45 Documentum Connector CFS Configuration File...... 46 Modify Parameters ...... 46 Enter Boolean Values ...... 46 Enter String Values ...... 46 Configuration File Sections...... 47 License Section ...... 47 Service Section ...... 47 Server Section ...... 47 Logging Section ...... 48 DistributedConnector Section ...... 49 ViewServer Section ...... 49 Connector Section ...... 50 Ingestion Section ...... 50 FetchTasks Section ...... 50 TaskName Section ...... 51 Example Configuration File ...... 51 Start and Stop the Connector ...... 54 Start the Connector ...... 54 Stop a Connector ...... 55 Encrypt Passwords ...... 55 Set Up Log Streams ...... 57
Chapter 4 Configure Connector Framework Server...... 59 Connector Framework Server Configuration File...... 59 Modify Parameters ...... 60 Enter Boolean Values ...... 60 Enter String Values ...... 60
• • • 4 • Documentum Connector CFS Administration Guide • • Contents
Configure Connector Framework Server ...... 61 Example Configuration File ...... 61
Chapter 5 Use Lua Scripts ...... 65 Use Lua Scripts within the CFS ...... 65 Configure a Lua Script ...... 66 Write a Lua Script ...... 66 Method Reference ...... 67 Document Objects Methods ...... 70 addField ...... 70 appendContent ...... 71 copyField ...... 71 deleteField ...... 71 getContent ...... 71 getFieldNames ...... 72 getFieldValue ...... 72 getFieldValues ...... 72 getNextSection ...... 73 hasField ...... 73 renameField ...... 73 setContent ...... 74 setFieldValue ...... 74 writeStubIdx ...... 74 XMLDocument Methods ...... 75 root ...... 75 XPathExecute ...... 75 XPathRegisterNs ...... 75 XPathValue ...... 76 XPathValues ...... 76 XmlNodeSet Methods ...... 77 at ...... 77 size ...... 77 XmlNode Methods ...... 77 attr ...... 77 content ...... 77 firstChild ...... 78 lastChild ...... 78 name ...... 78 next ...... 78
• • • Documentum Connector CFS Administration Guide • 5 • • Contents
nodePath ...... 79 parent ...... 79 prev ...... 79 type ...... 79 XmlAttr Methods ...... 80 name ...... 80 next ...... 80 prev ...... 80 type ...... 80 value ...... 81 ACI Methods ...... 81 send_aci_action ...... 81 send_aci_command ...... 82 Config Methods ...... 82 get_config ...... 82 getEncryptedValue ...... 83 getValue ...... 83 getValues ...... 84 String Methods ...... 84 gobble_whitespace ...... 84 hash_string ...... 85 parse_csv ...... 85 parse_xml ...... 86 Document Methods ...... 86 create_uuid ...... 86 encrypt_security_field ...... 86 hash_file ...... 87 Date Methods ...... 87 convert_date_time ...... 87 File System Methods ...... 88 abs_path ...... 88 copy_file ...... 89 create_path ...... 89 delete_file ...... 89 file_setdates ...... 90 getcwd ...... 90 is_dir ...... 91 move_file ...... 91 unzip_file ...... 91
• • • 6 • Documentum Connector CFS Administration Guide • • Contents
zip_file ...... 92 Miscellaneous Methods ...... 92 log ...... 92 sleep ...... 93 Change the Value of a Field ...... 93 Example Script ...... 94 Use Lua Scripts Within the Connector ...... 95 Introduction ...... 95 Example Lua Script ...... 95
Part 2 Parameter and Command Reference
Chapter 6 Documentum Connector CFS Configuration Parameters ...... 101 License Parameters ...... 102 Service Parameters ...... 102 Server Parameters ...... 102 Logging Parameters ...... 102 DistributedConnector Section ...... 103 ViewServer Section ...... 103 Connector Parameters ...... 103 Ingestion Parameters ...... 103 FetchTasks/TaskName Parameters ...... 104 ACLUsernameField ...... 104 BrowseSecurity ...... 104 BrowseSecurityField ...... 105 ContentFormatPreferenceCSV ...... 105 CustomFieldExtractNameN ...... 105 CustomFieldExtractToNameN ...... 106 CustomFieldSelectStatement ...... 106 DeleteSelectStatement ...... 107 Docbase ...... 107 DocumentType ...... 108 Domain ...... 108 ExtensionCSVs ...... 108 FieldQueryN ...... 109 FieldQueryNameN ...... 109 FieldQueryValueN ...... 110 FolderCSVs ...... 110
• • • Documentum Connector CFS Administration Guide • 7 • • Contents
FolderNegation ...... 111 FolderRecursion ...... 111 GetChildOfVirtualDoc ...... 112 HoldRetentionPolicy ...... 112 IgnoreContentCSVs ...... 112 Incremental ...... 113 MappedSecurity ...... 114 MappedSecurityField ...... 115 Password ...... 115 PreAppendDocBase ...... 115 SelectStatement ...... 116 UpdateCheckFields ...... 116 UseGlobalUids ...... 117 Username ...... 117
Chapter 7 Parameters Common to CFS Connectors ...... 119 ACI Server Configuration ...... 120 FilePath ...... 120 LibraryName ...... 120 LuaScript ...... 121 MaximumThreads ...... 121 MaxQueueSize ...... 122 MaxScheduledSize ...... 122 OnError ...... 123 OnErrorReport ...... 123 OnFinish ...... 124 OnStart ...... 124 Url ...... 124 Import Service ...... 125 KeyviewDirectory ...... 125 Distributed Connector ...... 126 ConnectorGroup ...... 126 ConnectorPriority ...... 126 DataPortN ...... 127 HostN ...... 127 PortN ...... 128 RegisterConnector ...... 128 SharedPath ...... 129 SSLConfigN ...... 129
• • • 8 • Documentum Connector CFS Administration Guide • • Contents
View Server ...... 130 EnableViewServer ...... 130 Host ...... 130 Port ...... 131 SharedPath ...... 131 General Connector Parameters ...... 132 CleanOnStart ...... 132 DatastoreFile ...... 132 DatastoreDirectory ...... 133 EnableExtraction ...... 133 EnableExtractionCopy ...... 133 EnableScheduledTasks ...... 134 EncryptACLEntries ...... 135 HashedDestinationDirectory ...... 135 HashedTempDirectory ...... 136 InsertActions ...... 136 InsertFailedDirectory ...... 137 SynchronizeKeepDatastore ...... 137 SynchronizeThreads ...... 137 TaskMaxAdds ...... 138 TaskMaxDuration ...... 138 TaskThreads ...... 139 TempDirectory ...... 139 XsltDLL ...... 140 Fetch Task Configuration ...... 140 IngestConfigSection ...... 140 N ...... 141 Number ...... 141 ScheduleCycles ...... 142 ScheduleRepeatSecs ...... 142 ScheduleStartTime ...... 143 Ingestion ...... 143 EnableIngestion ...... 143 IndexDatabase ...... 144 IngestActions ...... 144 IngestAddAsUpdate ...... 145 IngestBatchSize ...... 145 IngestCheckFinished ...... 145 IngestConnectorConfigSection ...... 146 IngestDataPort ...... 147
• • • Documentum Connector CFS Administration Guide • 9 • • Contents
IngestDelayMS ...... 147 IngestEnableAdds ...... 147 IngestEnableDeletes ...... 148 IngestEnableUpdates ...... 148 IngestHashedSharedPath ...... 148 IngesterType ...... 149 IngestHost ...... 150 IngestKeepFiles ...... 150 IngestPort ...... 151 IngestSendByType ...... 151 IngestSharedPath ...... 151 IngestSSLConfig ...... 152 IngestWriteIDX ...... 152 GroupServer ...... 153 GroupServerHost ...... 153 GroupServerPort ...... 153 GroupServerRepository ...... 154 GroupServerSSLConfig ...... 154
Chapter 8 Parameters Common to CFS Connectors Using Java ...... 155 JavaClassPath ...... 155 JavaConnectorClass ...... 156 JavaLibraryPath ...... 156 JavaMaxMemoryMB ...... 157 JVMLibraryPath ...... 157 JavaVerboseGC ...... 158
Chapter 9 CFS Connector Actions...... 159 Synchronous Versus Asynchronous Actions ...... 160 QueueInfo Action...... 160 Synchronize Fetch Action ...... 162 Synchronize Groups Fetch Action ...... 164 Collect Fetch Action...... 165 Identifiers Fetch Action ...... 168 Insert Fetch Action...... 170 Delete/Remove Fetch Action ...... 173 Hold and ReleaseHold Fetch Actions ...... 174
• • • 10 • Documentum Connector CFS Administration Guide • • Contents
Update Action...... 176 View Action ...... 177 StopFetch Action...... 178
Chapter 10 Connector Framework Server Parameters ...... 179 Service Parameters ...... 180 Server Parameters ...... 180 AdminClients ...... 180 Port ...... 181 QueryClients ...... 181 Actions Parameters ...... 182 MaxQueueSize ...... 182 MaximumThreads ...... 182 Import Tasks and their Parameters ...... 183 PostN ...... 183 PreN ...... 184 HashN ...... 184 DeleteN ...... 185 UpdateN ...... 185 Additional Task Types ...... 186 SectionerMaxBytes ...... 186 SectionerMinBytes ...... 187 SectionerSeparatorsN ...... 187 Import Service Parameters ...... 188 ExtractDirectory ...... 188 ImportFamilyRootExcludeFmtCSV ...... 188 ImportHashFamilies ...... 189 ImportInheritFieldsCSV ...... 190 ImportMergeMails ...... 190 KeyviewDirectory ...... 190 MaxImportQueueSize ...... 191 RevisionMarks ...... 191 ThreadCount ...... 192 XsltDLL ...... 192 Indexing Parameters ...... 193 ACIPort ...... 193 CompressIndexFiles ...... 193 DREHost ...... 194 IndexBatchSize ...... 194
• • • Documentum Connector CFS Administration Guide • 11 • • Contents
IndexTimeInterval ...... 194 KillDuplicates ...... 195
Chapter 11 License Configuration Parameters ...... 197 Full ...... 198 Holder ...... 198 Key ...... 198 LicenseServerACIPort ...... 199 LicenseServerHost ...... 200 LicenseServerTimeout ...... 200 LicenseServerRetries ...... 201 Operation ...... 201
Chapter 12 Server Parameters ...... 203 AdminClients ...... 203 DataPort ...... 204 DataPortClients ...... 205 DataPortThreads ...... 205 Port ...... 205 QueryClients ...... 206
Chapter 13 Logging Configuration Parameters ...... 207 LogArchiveDirectory ...... 208 LogCompressionMode ...... 209 LogDirectory ...... 209 LogEcho ...... 210 LogExpireAction ...... 210 LogFile ...... 211 LogHistorySize ...... 212 LogLevel ...... 212 LogLevelMatch ...... 213 LogMaxLineLength ...... 215 LogMaxOldFiles ...... 215 LogMaxSizeKBs ...... 216 LogOldAction ...... 217 LogOutputLogLevel ...... 218 LogSysLog ...... 218 LogTime ...... 219
• • • 12 • Documentum Connector CFS Administration Guide • • Contents
LogTypeCSVs ...... 219
Chapter 14 Secure Socket Layer Parameters ...... 223 SSLConfig ...... 224 SSLCACertificate ...... 226 SSLCACertificatesPath ...... 226 SSLCertificate ...... 228 SSLCheckCertificate ...... 228 SSLCheckCommonName ...... 229 SSLMethod ...... 229 SSLPrivateKey ...... 230 SSLPrivateKeyPassword ...... 231
Chapter 15 Service Actions ...... 233 Action Syntax ...... 233 GetConfig ...... 234 GetLogStream ...... 234 GetLogStreamNames ...... 235 GetStatistics ...... 235 GetStatus ...... 242 GetStatusInfo ...... 242 Stop ...... 243 Service Action Parameters ...... 243
Chapter 16 Service Configuration Parameters...... 245 ServiceACIMode ...... 246 ServiceControlClients ...... 246 ServiceHost ...... 247 ServicePort ...... 247 ServiceStatusClients ...... 248
Appendixes
Appendix A KeyView Format Codes...... 251 KeyView Classes ...... 251
• • • Documentum Connector CFS Administration Guide • 13 • • Contents
KeyView Formats ...... 253
Glossary ...... 271
Index ...... 275
• • • 14 • Documentum Connector CFS Administration Guide • • About this Document
This document is for readers who need to configure Documentum Connector CFS™. It is intended for readers who have installed IDOL and are familiar with concepts related to administering a multi-part distributed application.
Documentation Updates
Related Documentation
Conventions
AutonomyProduct References
Autonomy Customer Support
Contact Autonomy
Documentation Updates
The information in this document is current as of Documentum Connector CFS version 7.5. The content was last modified 17 October 2011. You can retrieve the most current product documentation from Autonomy’s Knowledge Base on the Customer Support Site. A document in the Knowledge Base displays a version number in its name, such as IDOL Server 7.5 Administration Guide. The version number applies to the product that the document describes. The document may also have a revision number in its name, such as IDOL Server 7.5 Administration Guide Revision 6. The revision number applies to the document and indicates that there were revisions to the document since its original release. It is recommended that you periodically check the Knowledge Base for revisions to documents for the products your enterprise is using.
• • • Documentum Connector CFS Administration Guide • 15 • • About this Document
To access Autonomy documentation 1. Go to the Autonomy Customer Support site at https://customers.autonomy.com 2. Click Login. 3. Enter the login credentials that were given to you, and then click Submit. The Knowledge Base Search page opens. 4. In the Search box, type a search term or phrase. To browse the Knowledge Base using a navigation tree only, leave the Search box empty. 5. Ensure the Documentation check box is selected. 6. Click Search. Documents that match the query display in a results list. 7. To refine the results list, select one or more of the categories in the Filter By pane. You can restrict results by Product Group. Filters the list by product suite or division. For example, you could retrieve documents related to the iManage, IDOL, Virage or KeyView product suites. Product. Filters the list by product. For example, you could retrieve documents related to IDOL Server, Virage Videologger, or KeyView Filter. Component. Filters the list by a product’s components. For example, you could retrieve documents related to the Content or Category component in IDOL. Version. Filters the list by product or component version number. Type. Filters the list by document format. For example, you could retrieve documents in PDF or HTML format. Guides are typically provided in both PDF and HTML format. 8. To open a document, click its title in the results list. To download a PDF version of a guide, open the PDF version, click the Save icon in the PDF reader, and save the PDF to another location.
Related Documentation
The following documents provide more details on Documentum Connector CFS: IDOL Administration User Guide
• • • 16 • Documentum Connector CFS Administration Guide • • IDOL Administration provides a distributed, Web-based infrastructure for managing IDOL components and services. The IDOL Administration manual describes how to administer IDOL through the IDOL Administration Dashboard and Dashboard console. IDOL Server Administration Guide IDOL server lies at the center of an Autonomy infrastructure, storing and processing the data that connectors index into it. The IDOL Server Administration Guide describes the operations that IDOL server can perform with detailed descriptions of how to set them up. Distributed Index Handler (DIH) Administration Guide This guide contains details on how you can use a DIH to distribute aggregated documents across multiple IDOL servers. Intellectual Asset Protection System (IAS) Administration Guide This guide contains details on how you can use Autonomy’s Intelligent Asset Protection System (IAS) to ensure secure access through authentication and role permissions. Distributed Service Handler (DiSH) Administration Guide This guide contains details on how you can use a DiSH server to administer and control multiple Autonomy services.
• • • Documentum Connector CFS Administration Guide • 17 • • About this Document
Conventions
The following conventions are used in this document.
Notational Conventions This document uses the following conventions.
Convention Usage
Bold User-interface elements such as a menu item or button. For example: Click Cancel to halt the operation.
Italics Document titles and new terms. For example: For more information, see the IDOL Server Administration Guide. An action command is a request, such as a query or indexing instruction, sent to IDOL Server.
monospace font File names, paths, and code. For example: The FileSystemConnector.cfg file is installed in C:\Program Files\FileSystemConnector\.
monospace bold Data typed by the user. For example: Type run at the command prompt. In the User Name field, type Admin.
monospace italics Replaceable strings in file paths and code. For example: user UserName
• • • 18 • Documentum Connector CFS Administration Guide • • Command-line Syntax Conventions This document uses the following command-line syntax conventions.
Convention Usage
[ optional ] Brackets describe optional syntax. For example: [ -create ]
| Bars indicate “either | or” choices. For example: [ option1 ] | [ option2 ] In this example, you must choose between option1 and option2.
{ required } Braces describe required syntax in which you have a choice and that at least one choice is required. For example: { [ option1 ] [ option2 ] } In this example, you must choose option1, option2, or both options.
required Absence of braces or brackets indicates required syntax in which there is no choice; you must type the required syntax element.
variable Italics specify items to be replaced by actual values. For example:
... Ellipses indicate repetition of the same pattern. For example: -merge filename1, filename2 [, filename3 ... ] where the ellipses specify, filename4, and so on.
The use of punctuation—such as single and double quotes, commas, periods—indicates actual syntax; it is not part of the syntax definition.
• • • Documentum Connector CFS Administration Guide • 19 • • About this Document
Notices This document uses the following notices:
CAUTION A caution indicates an action can result in the loss of data.
IMPORTANT An important note provides information that is essential to completing a task.
NOTE A note provides information that emphasizes or supplements important points of the main text. A note supplies information that may apply only in special cases—for example, memory limitations, equipment configurations, or details that apply to specific versions of the software.
TIP A tip provides additional information that makes a task easier or more productive.
AutonomyProduct References
This document references the following Autonomy products:
Autonomy Documentum CFS Connector
Autonomy IDOL server
Autonomy Distributed Action Handler (DAH)
Autonomy Distributed Service Handler (DiSH)
• • • 20 • Documentum Connector CFS Administration Guide • • Autonomy Customer Support
Autonomy Customer Support provides prompt and accurate support to help you quickly and effectively resolve any issue you may encounter while using Autonomy products. Support services include access to the Customer Support Site (CSS) for online answers, expertise-based service by Autonomy support engineers, and software maintenance to ensure you have the most up-to-date technology. To access the Customer Support Site, go to https://customers.autonomy.com The Customer Support Site includes: Knowledge Base: The CSS contains an extensive library of end user documentation, FAQs, and technical articles that is easy to navigate and search.
Case Center: The Case Center is a central location to create, monitor, and manage all your cases that are open with technical support.
Download Center: Products and product updates can be downloaded and requested from the Download Center.
Resource Center: Other helpful resources appropriate for your product. To contact Autonomy Customer Support by e-mail or phone, go to http://www.autonomy.com/content/Services/Support/index.en.html
Contact Autonomy
For general information about Autonomy, contact one of the following locations:
Europe and Worldwide North and South America
E-mail: [email protected] E-mail: [email protected] Telephone: +44 (0) 1223 448 000 Telephone: 1 415 243 9955 Fax: +44 (0) 1223 448 001 Fax: 1 415 243 9984 Autonomy Corporation plc Autonomy, Inc. Cambridge Business Park One Market Plaza Cowley Rd Spear Tower, Suite 1900 Cambridge CB4 0WZ San Francisco CA 94105 United Kingdom USA
• • • Documentum Connector CFS Administration Guide • 21 • • About this Document
• • • 22 • Documentum Connector CFS Administration Guide • • PART 1 Getting Started
This section provides an overview of the Documentum Connector CFS, installation procedures, and configuration information for the connector and the Connector Framework server. It includes the following chapters:
Introduction
Installation
Configure Documentum Connector CFS
Configure Connector Framework Server
Use Lua Scripts Part 1 Getting Started
• • • 24 • Documentum Connector CFS Administration Guide • • CHAPTER 1 Introduction
This chapter provides an overview of the Documentum Connector CFS. It contains the following sections:
Documentum Connector CFS
Autonomy’s IDOL Platform
Documentum Connector CFS Architecture
Documentum Connector CFS Components
Documentum Connector CFS
Documentum Connector CFS can be configured to poll a set of Documentum repositories accessible using the Documentum Foundation Classes to download documents stored within the repositories’ cabinets and folders. The files are then sent to Connector Framework server (CFS), which then processes the information and indexes it into an Autonomy IDOL server.
• • • Documentum Connector CFS Administration Guide • 25 • • Chapter 1 Introduction
Once IDOL server receives the lists, documents, and user profiles, it automatically processes them, performing a number of intelligent operations in real time, such as:
Agents Hyperlinking
Alerting Mailing
Categorization Profiling
Channels Retrieval
Clustering Spelling Correction
Collaboration Summarization
Dynamic Thesaurus Taxonomy Generation
Expertise
See your IDOL server’s manual for further details.
Related Topics “Configure Connector Framework Server” on page 59
Documentum Connector CFS Operation
The basic Documentum Connector CFS operation follows these steps: 1. Request a list of documents matching query criteria. 2. Download the documents returned in the list. 3. Extract Documentum metadata associated with the downloaded documents. 4. Import and index downloaded documents in conjunction with an IDOL server. The administrator configuring Documentum Connector CFS is able to specify a number of query criteria with which to limit which documents are actually retrieved by the fetch process. Standard criteria include details such as document extensions, locations by folders and cabinets, and modification dates. However, any number of extra criteria may be added by defining wildcard matches of document attributes, which must be satisfied for documents to be retrieved. Once a document has been found that matches the query criteria, the file is downloaded from the repository and saved to disk using the internal Documentum ID of the document, and its standard file extension, in combination, to generate a filename.
• • • 26 • Documentum Connector CFS Administration Guide • • About Connector Framework Server
Documentum Connector CFS also retrieves a standard set of document attributes from the repository for each document. As well as these standard attributes, any number of additional custom attributes may be specified for extraction. The import process uses the Connector Framework server to convert downloaded documents into a format that an IDOL server can interpret. The Connector Framework server also merges extracted metadata from the original document and stores the metadata together with the document in IDOL server. This allows document searching to be carried out across general document content as well as specific (structured) document attributes. The index process is responsible for sending data generated by the import process to one or more IDOL servers so that the data can be added to a specific database repository.
About Connector Framework Server
The Connector Framework server (CFS) receives information from various connectors, which it then processes and indexes into an IDOL server. A single CFS can be configured to work with multiple connectors and send documents to multiple IDOL servers or Distributed Index Handlers (DIH). In addition, the server can execute predefined tasks on documents just before they are imported, after they are imported, or if errors occur. CFS filters text from a variety of document types with KeyView filters, which are document-specific readers used for text extraction. Users generally do not access KeyView directly; however, the parameter ImportFamilyRootExcludeFmtCSV requires that you identify the desired KeyView document formats.
ImportFamilyRootExcludeFmtCSV
KeyView Format Codes
Autonomy’s IDOL Platform
At the core of Documentum Connector CFS is Autonomy’s Intelligent Data Operating Layer (IDOL). IDOL gathers and processes unstructured, semi-structured, and structured information in any format from multiple repositories using IDOL connectors and a global relational index. It can automatically form a contextual understanding of the information in real time, linking disparate data sources together based on the concepts contained within them. For example, IDOL can automatically link concepts contained in an e-mail message to a recorded phone conversation,
• • • Documentum Connector CFS Administration Guide • 27 • • Chapter 1 Introduction
which can be associated with a stock trade. This information is then imported into a format that is easily searchable, adding advanced retrieval, collaboration, and personalization to an application that integrates the technology. For more information on IDOL, refer to the IDOL Getting Started Guide.
Documentum Connector CFS Architecture
There are several ways to install the Connector Framework server. The simplest installation consists of a single CFS, single connector, and single IDOL server.
It is also possible to have more complex configurations, consisting of more than one connector, a Distributed Index Handler (DIH), multiple IDOL servers, or some combination of these options.
• • • 28 • Documentum Connector CFS Administration Guide • • Documentum Connector CFS Architecture
• • • Documentum Connector CFS Administration Guide • 29 • • Chapter 1 Introduction
Import Process
The import process consists of the following basic steps:
1. The connector sends documents from the data repository to the CFS. 2. Pre-import tasks are performed, which are typically defined in Lua scripts. 3. KeyView filters the document content. 4. Post-import tasks are performed, as defined in the PostN parameters. 5. Optionally, a backup IDX or XML file is created. 6. The data is indexed into IDOL server, or sent to a DIH.
Documentum Connector CFS Components
Documentum Connector CFS includes the following components: IDOL server
• • • 30 • Documentum Connector CFS Administration Guide • • Documentum Connector CFS Components
IDOL server lies at the center of an Autonomy infrastructure, storing and processing the data that connectors index into it. Distributed Index Handler (DIH) The DIH distributes aggregated documents across multiple IDOL servers. Intelligent Asset Protection System (IAS) The Intelligent Asset Protection System (IAS) ensures secure access through authentication and role permissions. Distributed Service Handler (DiSH) The DiSH server administers and controls multiple Autonomy services.
• • • Documentum Connector CFS Administration Guide • 31 • • Chapter 1 Introduction
• • • 32 • Documentum Connector CFS Administration Guide • • CHAPTER 2 Installation
This chapter provides information on installing the Documentum Connector CFS. It includes the following sections:
System Requirements
Install Documentum Connector CFS on Windows
Install Documentum Connector CFS on Linux
System Requirements
Documentum Connector CFS should be installed by the system administrator as part of a larger Autonomy system. That is, a system that includes an Autonomy IDOL server and an interface for the information stored in this IDOL server.
Supported Platforms The Documentum Connector CFS runs on Windows, Linux, and Solaris platforms.
NOTE The documented platforms are the recommended and most fully tested platforms for IDOL. Autonomy can provide support for other platforms on request.
• • • Documentum Connector CFS Administration Guide • 33 • • Chapter 2 Installation
Minimum Server Requirements Windows 2 GHz Pentium4 processor
2 GB RAM
20 GB hard disk recommended
Connection to a Documentum repository with a valid username and password.
The Connector Framework server, which must be running before the Documentum Connector CFS is started. Linux 2 GB RAM
3 GB hard disk recommended
Connection to a Documentum repository with a valid username and password.
The Connector Framework server, which must be running before the Documentum Connector CFS is started.
Environmental Requirements The following information includes options to assist Documentum Connector CFS to run in your environment.
The root of the DFC installation includes a dctm.jar file that includes everything required. It may also be necessary to configure the location of some native libraries using JavaLibraryPath. The configuration on Windows resembles:
JavaClassPath=.;JavaConnector.jar;DocumentumConnector.jar;
given the dfc.properties file is located in the connector working directory. If installing a DFC is not an option, the connector requires only the JavaConnector.jar, DocumentumConnector.jar, dfc.jar, dfcbase.jar, log4j.jar and dfc.properties files for normal usage. Holds also require the DmcRecords.jar file. (This example uses libraries from Documentum 5.3.)
For Documentum 6.5, the dependencies are: JavaConnector.jar, DocumentumConnector.jar, dfc.jar, aspectjrt.jar, certjFIPS.jar, fsafeFIPS.jar, and dfc.properties. (These dependencies could
• • • 34 • Documentum Connector CFS Administration Guide • • Install Documentum Connector CFS on Windows
potentially depend on the connector or server configuration, but copying all the libraries from an existing DFC installation will provide all the dependencies that could be required.)
Install Documentum Connector CFS on Windows
To install the Documentum Connector CFS and Connector Framework server (CFS) on Windows, double-click ConnectorName_Version_platform.exe. Read and follow all installation instructions on the screen carefully. 1. The installation opens with the Introduction dialog box. Read the text, and click Next. The License agreement dialog box opens. 2. Read the license agreement and if you agree to its terms, select I accept the terms of the License Agreement and click Next. The Choose Install Folder dialog box opens. 3. Choose an installation folder for Documentum Connector CFS. By default, Documentum Connector CFS is installed in C:\Autonomy\ ConnectorName, but you can click the Browse button to choose another location. After you choose an installation folder, click Next. The License Server Configuration dialog box opens. 4. Enter the IP address or the hostname as well as the ACI Port of the license server and click Next. The Choose CFS Install Folder dialog box opens. 5. Enter the path name where you want the Connector Framework Server to be installed and click Next. The Enter Connector Framework Installation Name dialog box opens. 6. Enter a unique name for the Connector Framework installation. This name is used for the Connector Framework installation directory and various files. The name you choose must not contain any spaces. After you select a name, click Next. The Connector Framework Service Settings dialog box opens. 7. Enter the following details, and click Next.
Service Port The port number that Connector Framework Server uses to communicate with the license server. This port must not be used by any other service.
• • • Documentum Connector CFS Administration Guide • 35 • • Chapter 2 Installation
Service Status The IP addresses of computers that are permitted to access Clients the Connector Framework service status, but are not permitted to control the status. If you want to permit a number of machines to access the Connector Framework service status, use a wildcard. For example, enter 187.*.*.* to permit any machine with an IP address that begins with 187 to access the Connector Framework service status.
Service Control The IP addresses of computers that are permitted to control Clients the Connector Framework service. If you want to permit a number of machines to control the Connector Framework service, use a wildcard. For example, enter 187.*.*.* to permit any machine with an IP address that begins with 187 to control the Connector Framework service.
The DRE Settings dialog box opens. 8. Enter the following details and click Next.
IDOL Server The IP address of the IDOL server to which you want to add Hostname documents.
ACI Port The port number the connector uses to query IDOL server.
Database Name The name of the IDOL server database into which you want the connector to index the information.
The Connector Framework Server ACI Port dialog box opens. 9. Enter the number of the port you wish the Connector Framework to listen on and click Next. The Pre-Installation Summary dialog box opens. 10. Review the installation settings, and click Previous to reverse through the installation configuration dialog boxes to change any settings if necessary. If you are satisfied with the settings, click Install. The Installing Documentum Connector CFS dialog box opens. The progress of the installation process is indicated. If you want to abort the installation process, click Cancel. The Start Service dialog box opens. 11. Choose whether or not you want to start the Documentum Connector CFS service immediately after installation, and click Next.
• • • 36 • Documentum Connector CFS Administration Guide • • Install Documentum Connector CFS on Windows
12. Choose whether or not you want to start the Connector Framework service immediately after installation, and click Next. 13. When the installation process completes, click Done. You can now edit the Documentum Connector CFS and Connector Framework server configuration files and start the Documentum Connector CFS service if you did not start the service in Step 11.
Directory Structure—Windows Once the installation of Documentum Connector CFS is completed, your installation directory contains the following files and subdirectories.
Connector Framework Server Directory Structure The Connector Framework server (CFS) is installed to the ConnectorFramework directory which is at the same level as the Documentum Connector CFS installation directory. The ConnectorFramework installation directory contains the following files and subdirectories (note that bold font indicates directories).
File Description
convtables Contains various text files used during the importing process.
filters Contains executables used during the importing process.
jre Contains Java Runtime Environment for the uninstaller.
scripts Contains Lua scripts.
Uninstall_ConnectorFramework Files required for uninstalling Connector Framework server.
ConnectorFramework.cfg Connector Framework server configuration file.
ConnectorFramework.exe Connector Framework server executable.
ConnectorFramework_InstallLog.log Installation log file that lists the details of the installation process.
lua.dll Lua library.
version.txt Text file containing version information.
• • • Documentum Connector CFS Administration Guide • 37 • • Chapter 2 Installation
When you start the Connector Framework server for the first time, the following files are created:
File Description
logs Contains CFS log files. By default, this includes action.log, import.log, indexer.log. actions Contains queued asynchronous actions so that, if the server should go down, the actions will not be lost. When the server comes back up, the queued actions will be processed.
uid Contains document tracking files.
autn_ntres.dll NT resource library.
ConnectorFramework.lck Lock file which prevents multiple instances of CFS running simultaneously.
license.log License log file.
licensekey.txt License information text document.
portinfo.dat File that lists the ports that the connector is using.
service.log Service actions log file.
Documentum Connector CFS Directory Structure By default, the Documentum Connector CFS is installed to the C:\Autonomy\ ConnectorName directory. The Documentum Connector CFS installation directory contains the following files and subdirectories (note that bold font indicates directories).
File Description
jre Java Runtime Environment.
lib Required Jar files.
logs Various log files.
Uninstall_ConnectorName Files required for uninstalling Documentum Connector CFS.
autpassword.exe Autonomy Password Encryption Utility executable, which allows you to encrypt the passwords.
connectorlibjava.dll Java library
DocumentumConnector.cfg Documentum Connector CFS configuration file.
• • • 38 • Documentum Connector CFS Administration Guide • • Install Documentum Connector CFS on Windows
File Description
DocumentumConnector.exe Documentum Connector CFS executable.
DocumentumConnectorJava_In Installation log file that lists the details of the stallLog.log installation process.
license.html HTML file containing license information.
license.txt Text file containing license information.
lua5.1.dll Lua library.
version.txt Text file containing version information.
When you start Documentum Connector CFS for the first time, the following files and subdirectories are created:
File Description
logs Contains Documentum Connector CFS log files. By default, this includes application.log, action.log, collect.log, synchronize.log, view.log. license Folder containing license information.
uid Folder containing document tracking files.
api.log This file is created by the Documentum API and contains error messages.
autn_ntres.dll NT resource library.
license.log License log file.
licensekey.txt License information text document.
portinfo.dat File that lists the ports that the connector is using.
service.log Service actions log file.
Related Topics “Service Configuration Parameters” on page 245
• • • Documentum Connector CFS Administration Guide • 39 • • Chapter 2 Installation
Install Documentum Connector CFS on Linux
Documentum Connector CFS should be installed by the system administrator.
NOTE While performing the following installation procedure, keep in mind that it is recommended that the Connector Framework server be started before the connector is started.
To install the standalone version of Documentum Connector CFS on Linux 1. Run the Documentum Connector CFS installer for the appropriate platform. For example: ConnectorName_VersionNumber_Platform_.bin [-f InstallPropsFile | -options] where, InstallPropsFile (optional) is the absolute or relative path to a properties file that specifies the parameter values that must be set during installation. If an installer properties file is specified and exists, all other command-line options are ignored. If a properties file named either installer.properties or NameOfInstaller.properties resides in the same directory as the installer, it is automatically used. options is one of the following: -i [swing | console | silent]. Specify the user interface mode for the installer. -D
• • • 40 • Documentum Connector CFS Administration Guide • • Install Documentum Connector CFS on Linux
6. Enter a unique name for the Connector Framework installation. This name is used for the Connector Framework installation directory and various files. The name you choose must not contain any spaces. After you select a name, click Next. The Connector Framework Service Settings dialog box opens. 7. Enter the following details and click Next.
Service Port The port number that Connector Framework service uses to communicate with the license server. This port must not be used by any other service.
Service Status The IP addresses of computers that are permitted to access Clients the Connector Framework service status, but are not permitted to control the status. If you want to permit a number of machines to access the Connector Framework service status, use a wildcard. For example, enter 187.*.*.* to permit any machine with an IP address that begins with 187 to access the Connector Framework service status.
Service Control The IP addresses of computers that are permitted to control Clients the Connector Framework service. If you want to permit a number of machines to control the Connector Framework service, use a wildcard. For example, enter 187.*.*.* to permit any machine with an IP address that begins with 187 to control the Connector Framework service.
The DRE Settings dialog box opens. 8. Enter the following details and click Next.
IDOL Server The IP address of the IDOL Server to which you want to add Hostname documents.
Index Port The port number the Connector Framework Server uses to index documents.
ACI Port The port number the Connector Framework Server uses to query IDOL Server.
Database Name The name of the IDOL Server database into which you want the Connector Framework Server to index the information.
The Connector Framework Server ACI Port dialog box opens.
• • • Documentum Connector CFS Administration Guide • 41 • • Chapter 2 Installation
9. Enter the number of the port you wish the Connector Framework to listen on and click Next. The Pre-Installation Summary dialog box opens. 10. Review the installation settings, and click Previous to reverse through the installation configuration dialog boxes to change any settings if necessary. If you are satisfied with the settings, press Enter. The Installing Documentum Connector CFS dialog box opens. The progress of the installation process is indicated. If you want to abort the installation process, click Cancel. 11. When the installation process completes, click Done. You can now edit the Documentum Connector CFS configuration files located in the main installation directory.
Directory Structure—Linux Once the installation of Documentum Connector CFS is completed, your installation directory contains the following files and subdirectories (note that bold font indicates directories):
Connector Framework Server Directory Structure The Connector Framework server (CFS) is installed to the ConnectorFramework directory which is at the same level as the Documentum Connector CFS installation directory. The ConnectorFramework installation directory contains the following files and subdirectories (note that bold font indicates directories).
File Description
convtables Contains various text files used during the importing process.
filters Contains executables used during the importing process.
kvoop.exe Executable that runs KeyView filters out of process.
various .dat files Files used by binslave.
various .dll files File format filters used by KeyView.
Scripts Contains import_ops.lua. Uninstall_ConnectorFramewo Files required for uninstalling Connector Framework rk server.
• • • 42 • Documentum Connector CFS Administration Guide • • Install Documentum Connector CFS on Linux
File Description
ConnectorFramework.cfg Connector Framework server configuration file.
ConnectorFramework.exe Connector Framework server executable.
ConnectorFramework_InstallLog Installation log file that lists the details of the .log installation process.
startconnectorFramework.sh Start script for CFS.
stopconnectorFramework.sh Stop script for CFS.
When you start the Connector Framework server for the first time, the following files are created:
File Description
actions Contains files that record the actions performed on the CFS. These actions are also written to the actionlogstream.log. logs Contains CFS log files. By default, this includes action.log, import.log, indexer.log. uid Contains containing document tracking files.
ConnectorFramework.lck Lock file which prevents multiple instances of CFS running simultaneously.
ConnectorFrameworkcfg.log CFS configuration log file.
ConnectorFramework.pid Process identification file for CFS.
ConnectorFramework.str CFS structured configuration file.
license.log License log file.
service.log Service actions log file.
Documentum Connector CFS Directory Structure By default, the Documentum Connector CFS is installed to /opt/Autonomy/ DocumentumConnectorJava. The Documentum Connector CFS installation directory contains the following files and subdirectories (note that bold font indicates directories).
• • • Documentum Connector CFS Administration Guide • 43 • • Chapter 2 Installation
File Description
jre Contains Java Runtime Environment files.
lib Contains Java jar packages.
license Contains license information.
logs If logging is enabled, contains the action.log, collect.log, synchronize.log, and view.log. uid Contains document tracking files.
autpassword Autonomy Password Encryption Utility executable, which allows you to encrypt the passwords.
InstallName.cfg Documentum Connector CFS configuration file.
InstallName.exe Documentum Connector CFS executable.
InstallName.lck Internally used lock file for Documentum Connector CFS.
InstallName.log Documentum Connector CFS log file.
InstallName.str Documentum Connector CFS structured configuration file.
InstallNamecfg.log Documentum Connector CFS configuration log file.
startconnector.sh Start script for Documentum Connector CFS.
stopconnector.sh Stop script for Documentum Connector CFS.
Uninstall_DocumentumCon Contains the uninstall script. nector
• • • 44 • Documentum Connector CFS Administration Guide • • CHAPTER 3 Configure Documentum Connector CFS
This chapter describes how to configure the parameters that determine how the Documentum Connector CFS operates. The configuration settings are stored in the connector configuration file located in the Documentum Connector CFS installation directory. You can modify the parameters directly in the configuration file using a text editor. This chapter includes the following sections: Documentum Connector CFS Configuration File
Modify Parameters
Configuration File Sections
Example Configuration File
Start and Stop the Connector
Encrypt Passwords
Set Up Log Streams
• • • Documentum Connector CFS Administration Guide • 45 • • Chapter 3 Configure Documentum Connector CFS
Documentum Connector CFS Configuration File
The parameters that determine how Documentum Connector CFS operates appear in the InstallationName configuration file, located in your installation directory. You can modify these parameters to customize Documentum Connector CFS according to your requirements.
Modify Parameters
The following section describes how to enter parameter values in the configuration file.
Enter Boolean Values The following settings for Boolean parameters are interchangeable: TRUE = true = ON = on = Y = y = 1 FALSE = false = OFF = off = N = n =0
Enter String Values Some parameters require string values that contain quotation marks. Escape each quotation mark by inserting a backslash before it. For example: FIELDSTART0="" Here, the beginning and end of the string are indicated by quotation marks, while all quotation marks that are contained in the string are escaped. If you want to enter a comma-separated list of strings for a parameter, and one of the strings contains a comma, you must indicate the start and the end of this string with quotation marks. For example: ParameterName=cat,dog,bird,"wing,beak",turtle If any string in a comma-separated list contains quotation marks, you must put this string into quotation marks and escape each quotation mark in the string by inserting a backslash before it. For example: ParameterName="",dog,bird,"wing,beak",turtle
• • • 46 • Documentum Connector CFS Administration Guide • • Configuration File Sections
Configuration File Sections
The Documentum Connector CFS configuration file contains the following sections: [License] [Service] [Server] [Logging] [DistributedConnector] [ViewServer] [Connector] [Ingestion] [FetchTasks] [TaskName]
License Section The [License] section contains details about the License server (the server on which your Documentum Connector CFS license file is located).
[License] LicenseServerHost=127.0.0.1 LicenseServerACIPort=20000 LicenseServerTimeout=600000 LicenseServerRetries=1
Related Topics “License Configuration Parameters” on page 197
Service Section The [Service] section contains parameters that determine which machines are permitted to use and control the Documentum Connector CFS service. For example: [Service] ServicePort=7003 ServiceStatusClients=* ServiceControlClients=*
Server Section This section contains general server parameters. For example: [Server] Port=7002 QueryClients=*
• • • Documentum Connector CFS Administration Guide • 47 • • Chapter 3 Configure Documentum Connector CFS
AdminClients=*
Logging Section The [Logging] section lists the logging streams you want to set up to create separate log files for different log message types (application, action, and synchronize). It also contains a subsection for each of the listed logging streams, in which you can configure the parameters that determine how each stream is logged. For example: [Logging] LogLevel=FULL LogEcho=TRUE 0=ApplicationLogStream 1=ActionLogStream 2=JavaLogStream 3=SynchronizeLogStream 4=CollectLogStream 5=DeleteLogStream 6=InsertLogStream 7=HoldLogStream 8=ViewLogStream
[ApplicationLogStream] LogFile=application.log LogTypeCSVs=application
[ActionLogStream] LogFile=action.log LogTypeCSVs=action
[JavaLogStream] LogFile=java.log LogTypeCSVs=java
[SynchronizeLogStream] LogFile=synchronize.log LogTypeCSVs=synchronize
[CollectLogStream] LogFile=collect.log LogTypeCSVs=collect [DeleteLogStream] LogFile=delete.log LogTypeCSVs=delete
[InsertLogStream] LogFile=insert.log LogTypeCSVs=insert
• • • 48 • Documentum Connector CFS Administration Guide • • Configuration File Sections
[HoldLogStream] LogFile=hold.log LogTypeCSVs=hold
[ViewLogStream] LogFile=view.log LogTypeCSVs=view
DistributedConnector Section This section is only required only if the connector (or multiple connectors) is used with the Distributed Connector (DC) component. The DC is used to distribute the actions (synchronize/collect and so forth) between a number of connectors. The DC then receives actions from the user for a particular task to be performed by one of the connectors in a specific ConnectorGroup. The DC distributes these to any connectors in that ConnectorGroup.
For example, to allow the Documentum Connector CFS collect actions to be distributed: 1. Configure multiple Documentum Connector CFS connectors by setting the RegisterConnector parameter to True, using the same DC host and port and the same ConnectorGroup=Documentum setting. 2. Start the DC and then the connectors (the connectors will wait at startup until they are successfully able to register with the DC). 3. Send the collect action to the DC, specifying that the action should be distributed to a connector in the Documentum ConnectorGroup. Only one of the Documentum Connector CFS connectors receives the collect action to process.
[DistributedConnector] RegisterConnector=FALSE Host=localhost Port=10000 ConnectorGroup=Documentum
ViewServer Section The parameters in this section allow the connector’s view action to use a View Server.
[ViewServer] EnableViewServer=FALSE Host=localhost Port=14000
• • • Documentum Connector CFS Administration Guide • 49 • • Chapter 3 Configure Documentum Connector CFS
Connector Section [Connector] EnableIngestion=TRUE EnableExtraction=FALSE TempDirectory=Temp EnableScheduledTasks=TRUE ScheduleCycles=0 ScheduleRepeatSecs=86400
JavaConnectorClass=com.autonomy.connector.documentum.DocumentumCon nector JavaClassPath=.;lib\JavaConnector.jar;lib\ DocumentumConnector.jar;lib\dctm.jar JavaLibraryPath=lib\shared JavaMaxMemoryMB=256
Ingestion Section The [Ingestion] section contains parameters that specify details for the Connector Framework server (also known as the Ingestion server). The server accepts data from the connector, generates an IDX or XML file, and sends the file to IDOL server for indexing. [Ingestion] IngesterType=CFS IngestHost=localhost IngestPort=7000 IngestBatchSize=100 IndexDatabase=DocumentumConnector
FetchTasks Section The [FetchTasks] section lists the accounts you want to poll. In this section, you enter the total number of jobs in the Number parameter and then list the accounts in consecutive order starting from 0 (zero). For example: [FetchTasks] Number=1 0=MyTask1
• • • 50 • Documentum Connector CFS Administration Guide • • Example Configuration File
TaskName Section The [TaskName] section contains configuration parameters that only apply to the specified job. There must be a [TaskName] section for every job listed in the [FetchTasks] section. A parameter specified in a [TaskName] section overrides the same parameter defined in the [FetchTasks] section. For example: [MyTask1] docbase= username= password= //incremental=true //getchildofvirtualdoc=true //trackpermissions=false //mappedsecurity=true //folderCSVs=/documentum //customfieldselectstatement=SELECT object_name FROM dm_document WHERE r_object_id='@r_object_id' //customfieldextractname0=object_name //customfieldextracttoname0=OBJECTNAME
Related Topics “Set Up Log Streams” on page 57
Example Configuration File
[License] LicenseServerHost=127.0.0.1 LicenseServerACIPort=20000 LicenseServerTimeout=600000 LicenseServerRetries=1
[Service] ServicePort=7003 ServiceStatusClients=* ServiceControlClients=*
[Server] Port=7002 QueryClients=* AdminClients=*
[Logging] LogLevel=FULL LogEcho=TRUE 0=ApplicationLogStream
• • • Documentum Connector CFS Administration Guide • 51 • • Chapter 3 Configure Documentum Connector CFS
1=ActionLogStream 2=JavaLogStream 3=SynchronizeLogStream 4=CollectLogStream 5=DeleteLogStream 6=InsertLogStream 7=HoldLogStream 8=ViewLogStream
[ApplicationLogStream] LogFile=application.log LogTypeCSVs=application
[ActionLogStream] LogFile=action.log LogTypeCSVs=action
[JavaLogStream] LogFile=java.log LogTypeCSVs=java
[SynchronizeLogStream] LogFile=synchronize.log LogTypeCSVs=synchronize
[CollectLogStream] LogFile=collect.log LogTypeCSVs=collect
[DeleteLogStream] LogFile=delete.log LogTypeCSVs=delete
[InsertLogStream] LogFile=insert.log LogTypeCSVs=insert
[HoldLogStream] LogFile=hold.log LogTypeCSVs=hold
[ViewLogStream] LogFile=view.log LogTypeCSVs=view
[DistributedConnector] RegisterConnector=FALSE Host=localhost Port=10000
• • • 52 • Documentum Connector CFS Administration Guide • • Example Configuration File
ConnectorGroup=Documentum
[ViewServer] EnableViewServer=FALSE Host=localhost Port=14000
[Connector] EnableIngestion=TRUE EnableExtraction=FALSE TempDirectory=Temp EnableScheduledTasks=TRUE ScheduleCycles=0 ScheduleRepeatSecs=86400 JavaConnectorClass=com.autonomy.connector.documentum.DocumentumCon nector JavaClassPath=.;lib\JavaConnector.jar;lib\ DocumentumConnector.jar;lib\dctm.jar JavaLibraryPath=lib\shared JavaMaxMemoryMB=256
[Ingestion] IngesterType=CFS IngestHost=localhost IngestPort=7000 IngestBatchSize=100 IndexDatabase=DocumentumConnector
[FetchTasks] Number=1 0=MyTask1
[MyTask1] docbase= username= password= //incremental=true //getchildofvirtualdoc=true //trackpermissions=false //mappedsecurity=true //folderCSVs=/documentum //customfieldselectstatement=SELECT object_name FROM dm_document WHERE r_object_id='@r_object_id' //customfieldextractname0=object_name //customfieldextracttoname0=OBJECTNAME
• • • Documentum Connector CFS Administration Guide • 53 • • Chapter 3 Configure Documentum Connector CFS
Start and Stop the Connector
Use the following information to start and stop the Documentum Connector CFS.
NOTE You must start and stop the Connector Framework server separately from the Documentum Connector CFS.
Start the Connector Once you have installed a connector, you are ready to run it. Start the connector using one of the following methods.
To start the connector using Windows Services 1. Open the Windows Services dialog box. 2. Select the ConnectorInstallName service, and click Start. 3. Close the Windows Services dialog box.
To start the connector by running the executable 1. In the connector installation directory, locate the connector executable called ConnectorInstallName.exe. 2. On a command line, enter ConnectorInstallName.exe -run.
To start the connector by running through Java using the ConnectorInstallName.dll 1. On a command line, enter: java [java_args] com.autonomy.connector.ConnectorBase ConnectorInstallName [server_args]
For a Documentum Connector CFS specific example (with DocumentumConnector.dll): java -cp
NOTE When running the connector through Java, most of the Java settings configurable in the configuration file have no effect, with the exception of the JavaConnectorClass parameter. In this case, the other settings can be set using standard Java command arguments.
• • • 54 • Documentum Connector CFS Administration Guide • • Encrypt Passwords
Stop a Connector Stop a connector from running by using one of the following methods.
To stop the connector using Windows Services 1. Open the Windows Services dialog box. 2. Select the ConnectorInstallName service, and click Stop. 3. Close the Windows Services dialog box.
To stop the connector service by sending a command to the service port Type the following command in the address bar of your browser:
http://host:ServicePort/action=stop where,
host The IP address (or name) of the machine on which the Documentum Connector CFS is running.
ServicePort The Documentum Connector CFS service port (specified in the [Service] section of the Documentum Connector CFS configuration file).
Encrypt Passwords
For added security, it is recommended all passwords be encrypted before they are entered into a configuration field. To encrypt passwords, follow the steps relevant to your operating system.
To encrypt passwords 1. At a command prompt, change directories to InstallDir\ ConnectorName. 2. Enter one of the following strings: autpassword -e -tEncryptionType [options] PasswordString autpassword -d PasswordString autpassword -x -tEncryptionType [options]
• • • Documentum Connector CFS Administration Guide • 55 • • Chapter 3 Configure Documentum Connector CFS
where,
Option Description
-e Encrypts the password.
-d Decrypts the password.
-x Performs the operation specified by the -o option. See Options.
-tEncryptionType The type of encryption used. The following options are available: Basic AES You may use either form of encryption. However, AES is a more secure type of encryption than basic encryption.
PasswordString The password to encrypt or decrypt.
Options Options can be one of the following: -oOptionName=OptionValue. OptionName can be: KeyFile. Specifies the path and filename of a keyfile. It should contain 64 hexadecimal characters. This option is only available with the AES encryption type and the -x option. -c. The configuration filename in which to write the encrypted password. This option is only available with the -e argument. -s. The name of the section in the configuration file in which to write the password. This option is only available with the -e argument. -p. The parameter name in which to write the encrypted password. This option is only available with the -e argument. When writing the password to a configuration file, you must specify all related options: -c, -s, and -p.
Example: autpassword -e -tBASIC -c./Config.cfg -sDefault -pPassword passw0r autpassword -d passw0r autpassword -x -tAES -oKeyFile=./MyKeyFile.ky
• • • 56 • Documentum Connector CFS Administration Guide • • Set Up Log Streams
Set Up Log Streams
If the default logging does not suit your environment, you can set up your own log streams. Each log stream creates a separate log file in which specific log message types (for example, action, index, application, or import) are logged.
NOTE The individual connector determines the log streams that can be set up for it. Not all log streams listed below are appropriate for all connectors.
To set up log streams 1. Open the configuration file in a text editor. 2. Find the [Logging] section. (If the configuration file does not contain a [Logging] section, create one.) 3. Under the [Logging] section's heading, create a list of the log streams you want to set up using the format N=LogStreamName. For example: [Logging] LogLevel=FULL LogDirectory=logs 0=ApplicationLogStream 1=ActionLogStream 2=SynchronizeLogStream 3=InsertLogStream 4=CollectLogStream 5=ViewLogStream 6=DeleteLogStream 7=IdentifiersLogStream Note the log streams are listed in consecutive order, starting from 0 (zero). 4. Create a new section for each of the log streams you defined. Each section must have the same name as the log stream. For example: [ApplicationLogStream] [ActionLogStream] [SynchronizeLogStream] [InsertLogStream] [CollectLogStream] [ViewLogStream] [DeleteLogStream] [IdentifiersLogStream] 5. Specify the settings you want to apply to each log stream in the appropriate log stream's section. You can specify the type of logging that should be
• • • Documentum Connector CFS Administration Guide • 57 • • Chapter 3 Configure Documentum Connector CFS
performed (for example, full logging), whether log messages should be displayed on the console, the maximum size of log files, and so on. For example: [ApplicationLogStream] logfile=application.log loghistorysize=50 logtime=true logecho=false logmaxsizekbs=1024 logtypecsvs=application loglevel=full [ActionLogStream] logfile=logs/action.log loghistorysize=50 logtime=true logecho=false logmaxsizekbs=1024 logtypecsvs=action loglevel=full 6. Save and close the configuration file. 7. Restart the service to execute your changes.
• • • 58 • Documentum Connector CFS Administration Guide • • CHAPTER 4 Configure Connector Framework Server
This chapter describes how to configure the parameters that determine how the Connector Framework server (CFS) operates. This chapter contains the following sections:
Connector Framework Server Configuration File
Modify Parameters
Configure Connector Framework Server
Example Configuration File
Connector Framework Server Configuration File
The parameters that determine how Connector Framework server operates are in the ConnectorFramework.cfg file, located in the CFS installation directory. You can modify these parameters to customize the CFS according to your requirements. The CFS supports all standard Server, Service, Logging, and License parameters. Most of the specific import tasks are defined in Lua scripts; therefore, the Connector Framework server configuration requirements are quite minimal.
• • • Documentum Connector CFS Administration Guide • 59 • • Chapter 4 Configure Connector Framework Server
Related Topics Connector Framework Server Parameters
Example Configuration File
Modify Parameters
The following section describes how to enter parameter values in the configuration file.
Enter Boolean Values The following settings for Boolean parameters are interchangeable: TRUE = true = ON = on = Y = y = 1 FALSE = false = OFF = off = N = n =0
Enter String Values Some parameters require string values that contain quotation marks. Escape each quotation mark by inserting a backslash before it. For example: FIELDSTART0="" Here, the beginning and end of the string are indicated by quotation marks, while all quotation marks that are contained in the string are escaped. If you want to enter a comma-separated list of strings for a parameter, and one of the strings contains a comma, you must indicate the start and the end of this string with quotation marks. For example: ParameterName=cat,dog,bird,"wing,beak",turtle If any string in a comma-separated list contains quotation marks, you must put this string into quotation marks and escape each quotation mark in the string by inserting a backslash before it. For example: ParameterName="",dog,bird,"wing,beak",turtle
• • • 60 • Documentum Connector CFS Administration Guide • • Configure Connector Framework Server
Configure Connector Framework Server
This section describes how to configure the basic Connector Framework server parameters.
To configure CFS 1. Open the CFS configuration file. 2. In the [Service] section, specify the service information. 3. In the [Server] section, specify server information. 4. In the [ImportTasks] section, configure how data is imported to IDX or XML before it is indexed into IDOL Server. 5. In the [ImportService] section, specify details for Keyview and the service that imports documents into IDX or XML. 6. In the [Indexing] section, specify the details for the IDOL Server(s) to which the CFS will send documents for indexing. 7. In the [Actions] section, configure how actions are sent to the CFS. 8. Save the configuration file.
Related Topics Service Parameters
Server Parameters
Import Tasks and their Parameters
Import Service Parameters
Indexing Parameters
Actions Parameters
Secure Socket Layer Parameters
Example Configuration File
This section contains a basic example configuration file, which meets the minimum configuration requirements. [Service] Port=40030 ServiceStatusClients=*.*.*.*
• • • Documentum Connector CFS Administration Guide • 61 • • Chapter 4 Configure Connector Framework Server
ServiceControlClients=*.*.*.*
[Server] Port=7000 QueryClients=* AdminClients=* MaxInputString=-1 MAXFILEUPLOADSIZE=-1
[Logging] LogLevel=NORMAL 0=ApplicationLogStream 1=ActionLogStream 2=ImportLogStream 3=IndexLogStream
[actions] MaxQueueSize=100
[ApplicationLogStream] LogTypeCSVs=application LogFile=application.log
[ActionLogStream] LogTypeCSVs=action LogFile=action.log
[ImportLogStream] LogTypeCSVs=import LogFile=import.log
[IndexLogStream] LogTypeCSVs=indexer LogFile=indexer.log
[Indexing] DREHost=127.0.0.1 ACIPort=9000 IndexBatchSize=1000 IndexTimeInterval=300
[ImportService] KeyviewDirectory=C:\Documents and Settings\dquatman\My Documents\ ConnectorFrameworkServers\filters ExtractDirectory=C:\Documents and Settings\dquatman\My Documents\ ConnectorFrameworkServers\Temp ThreadCount=3 ImportInheritFieldsCSV=AUTN_GROUP,AUTN_IDENTIFIER,DREDBNAME
• • • 62 • Documentum Connector CFS Administration Guide • • Example Configuration File
[ImportTasks] //Post0=lua:
• • • Documentum Connector CFS Administration Guide • 63 • • Chapter 4 Configure Connector Framework Server
• • • 64 • Documentum Connector CFS Administration Guide • • CHAPTER 5 Use Lua Scripts
This chapter contains the following topics: Use Lua Scripts within the CFS
Method Reference
Use Lua Scripts Within the Connector
Use Lua Scripts within the CFS
Connector Framework server can import or process data using Lua, an embedded scripting language. A Lua script allows CFS to: Call out to an external service, for example to alert a user.
Modify and insert document fields.
Interface with other libraries. When data is imported, the script is run for each document. For more information on Lua, see:
http://www.lua.org/ CFS supports all standard Lua functions.
• • • Documentum Connector CFS Administration Guide • 65 • • Chapter 5 Use Lua Scripts
Configure a Lua Script You can execute four types of script: pre-Lua or post-Lua, Delete, and Update. Pre-Lua scripts are run after the document data is extracted but before it is filtered, so the document contains metadata. Post-Lua scripts are run after the document data is filtered, so the document also contains the document content. Delete is run when a document is deleted. Update is run when a document is updated. Update and Delete are configured in the same way as Pre and Post, but they appear in the [IndexTasks] section. Use this procedure to specify the location of the Lua script file.
To configure a Lua script 1. Stop the Connector Framework server. 2. Open the Connector Framework server configuration file in a text editor. 3. Locate the [ImportTasks] section, and enter a different value of PreN (for pre-Lua scripts) or PostN (for post-Lua scripts) for each script file. For example: [ImportTasks] ... Pre0=Lua:script1.lua Pre1=Lua:script2.lua Post0=Lua:script3.lua 4. To enable family hashing, set the HashN parameter. True indicates that the Lua calculated the hash; False indicates that the hash should be calculated. 5. Save the configuration file.
Write a Lua Script The script should have this structure: function handler(document) ... end The handler function is called for each document and is passed a document object. This is an internal representation of the document being processed. Modifying this object will change the document.
Return true if you want to continue processing the document and return false if you want to stop.
• • • 66 • Documentum Connector CFS Administration Guide • • Method Reference
NOTE You can write a library of useful functions to share between multiple scripts, which you can then include in the scripts by adding dofile(“library.lua”) to the top of the lua script outside of the handler function.
Method Reference
The Connector Framework server supports several methods, which are listed in Table 1.
Table 1 Supported methods Method Description
Document Objects Methods
addField Creates a new field when passed a name and value.
appendContent Appends content to the existing content of the document. copyField Creates a new named field with the same value as an existing named field.
deleteField Removes a field from the document.
getContent Gets the content for a document.
getFieldNames Gets all the field names for the document.
getFieldValue Gets a field value.
getFieldValues Gets all values of a multi-valued field.
getNextSection Gets the next section in a document, allowing you to perform find or add operations on every section.
hasField Checks whether the document has a particular named field.
renameField Moves an existing field from one name to another.
setContent Sets the content for a document.
setFieldValue Sets a field value.
writeStubIdx Writes out a stub IDX document.
XMLDocument Methods
• • • Documentum Connector CFS Administration Guide • 67 • • Chapter 5 Use Lua Scripts
Table 1 Supported methods Method Description
root Returns an XMLNode that is the root node of the XML document.
XPathExecute Returns XMLNodeSet that is the result of supplied XPath query.
XPathRegisterNs Register a namespace with the XML parser. Returns an integer detailing the error code.
XPathValue Returns the first occurance of the value matching the the xpath query.
XPathValues Returns a table of Strings contain th values according to the XPath query.
XMLNodeSet Methods
at Returns XMLNode at position pos in the array. size Returns size of node set.
XMLNode Methods
attr Returns first XMLAttr attribute object for this element. content Returns the content (text element) of the xml node.
firstChild Returns XMLNode that is the first child of this node.
lastChild Returns XMLNode that is the last child of this node. name Returns the name of the xml node.
next Returns XmlNode that is the next sibling of this node. nodePath Returns the Xml path to the node that can be used in another XPath query.
parent Returns the parent XmlNode of the node.
prev Returns XmlNode that is the previous sibling of this node.
type Returns the type of the node as a string.
XmlAttr Methods
name Returns the name of this attribute.
next Returns XmlAttr object for the next attribute in the parent element.
• • • 68 • Documentum Connector CFS Administration Guide • • Method Reference
Table 1 Supported methods Method Description
prev Returns XmlAttr object for the previous attribute in the parent element.
type Returns the type of this attribute node.
value Returns the value of this attribute.
ACI Methods
send_aci_action Takes the action parameters as a table instead of the full action as a string to avoid issues with parameter values containing “&”.
send_aci_command Sends the given query to the ACI server.
Config Methods
get_config Loads a configuration file.
getEncryptedValue Returns the unencrypted value from the config of an encrypted value.
getValue Returns the value of the configuration parameter key in a given section.
getValues Returns a table of strings if you have multiple values for a key (for example, a CSV or numbered like keyN).
String Methods
gobble_whitespace Reduces multiple adjacent while spaces.
hash_string Hashes specified string.
parse_csv Parse the given separated values string into a collection of individual strings.
parse_xml Parse the given XML string to an XMLDocument.
Document Methods
create_uuid Creates a universally unique identifier.
encrypt_security_field Encrypts the ACL.
hash_file Hashes specified file using the SH1 or MDA5 algorithm, or both.
Date Methods
convert_date_time Converts date and time formats using standard Autonomy syntax.
• • • Documentum Connector CFS Administration Guide • 69 • • Chapter 5 Use Lua Scripts
Table 1 Supported methods Method Description
File System Methods
abs_path Returns the supplied path as an absolute path.
copy_file Copies the source file to the destination path.
create_path Creates the specified directory tree.
delete_file Deletes the file specified by path.
file_setdates Sets the given file times on the file specified by path. getcwd Returns the current working directory of the application.
is_dir Checks if the supplied path is a directory.
move_file Moves the source file to the destination path.
unzip_file Extracts the zip file specified by path to the location specified by dest. zip_file Zips the supplied path (file or directory).
Miscellaneous Methods
log Appends log messages to the specified file.
sleep Pauses the executing thread for a number of milliseconds.
Document Objects Methods
addField Adds a new field to the document.
Syntax addField ( String fieldname, String fieldvalue )
Arguments
Arguments Type/Description
fieldname The name of the field to add.
fieldvalue The value to set for the field.
• • • 70 • Documentum Connector CFS Administration Guide • • Method Reference
appendContent Appends content to the existing content of the document.
Syntax appendContent ( String content )
Arguments
Arguments Type/Description
content The content to append to the document content.
copyField Copies a field to a certain name.
Syntax copyField ( String sourcename, String targetname )
Arguments
Arguments Type/Description
sourcename The name of the field to copy.
targetname The destination field name.
deleteField Deletes a field from a document.
Syntax deleteField ( String fieldname )
Arguments
Arguments Type/Description
fieldname The name of the field to delete.
getContent Gets the content for a document.
• • • Documentum Connector CFS Administration Guide • 71 • • Chapter 5 Use Lua Scripts
Syntax String ( getContent )
Returns The document content.
getFieldNames Gets all the field names for the document.
Syntax getFieldNames ( )
Returns A table of all the field names.
getFieldValue Gets the value of a field on a document.
Syntax getFieldValue( String fieldname )
Arguments
Arguments Type/Description
fieldname The name of the field who’s value is to be retrieved.
Returns A string containing the value.
getFieldValues Gets all values from all fields that have the same name.
Syntax getFieldValues( String fieldname )
Arguments
Arguments Type/Description
fieldname The name of the field to match.
• • • 72 • Documentum Connector CFS Administration Guide • • Method Reference
Returns A table of all the field values.
getNextSection The document object passed to the script's handler function in fact represents the first section of the document. This means the functions previously detailed only read and modify the first section. This method returns the next section in the document when sectioned.
Syntax LuaDocument getNextSection ()
Example To perform operations on every section, for example: local section = document while section do -- Manipulate section section = section:getNextSection() end
Returns A document object that contains the next DRE section.
hasField Checks to see if a field exists for a document.
Syntax hasField ( String fieldname )
Arguments
Arguments Type/Description
fieldname The name of the field for who’s existence you are checking.
Returns A Boolean: true if the field exists, false otherwise.
renameField Changes the name of a field from one name to another.
• • • Documentum Connector CFS Administration Guide • 73 • • Chapter 5 Use Lua Scripts
Syntax renameField ( String currentname, String newname )
Arguments
Arguments Type/Description
currentname The name of the field to rename.
newname The new name of the field.
setContent Sets the content for a document.
Syntax setContent ( String content )
Arguments
Arguments Type/Description
content The content to set for the document.
setFieldValue Sets the value of a field on a document.
Syntax setFieldValue( String fieldname, String newvalue )
Arguments
Arguments Type/Description
fieldname The name of the field to set.
newvalue The value to set for the field. If the field already exists, it will be overwritten.
writeStubIdx Writes out a stub idx document (a metadata file used by IDOL applications).
Syntax writeStubIdx( String filename )
• • • 74 • Documentum Connector CFS Administration Guide • • Method Reference
Arguments
Arguments Type/Description
filename The name of the file to create.
Returns A Boolean: true if written, false otherwise.
XMLDocument Methods
root Returns an XmlNode which is the root node of the XML document.
Syntax root()
Returns An XmlNode.
XPathExecute Returns XmlNodeSet which is the result of supplied XPath query.
Syntax XPathExecute( String xpathQuery )
Arguments
Arguments Type/Description
xpathQuery The xpath query to execute.
Returns An XmlNodeSet node set.
XPathRegisterNs Register a namespace with the XML parser. Returns an integer detailing the error code.
Syntax XPathRegisterNs( String prefix, String URI )
• • • Documentum Connector CFS Administration Guide • 75 • • Chapter 5 Use Lua Scripts
Arguments
Arguments Type/Description
prefix The namespace prefix.
URI The namespace location.
Returns 0 in case of success, -1 in case of error.
XPathValue Returns the first occurance of the value matching the XPath query.
Syntax String XPathValue(String query)
Arguments
Arguments Type/Description
query The XPath query to use.
Returns A string of the value.
XPathValues Returns a table of strings containing the values according to the XPath query.
Syntax Table XPathValues(String query)
Arguments
Arguments Type/Description
query The XPath query to use.
Returns A table of strings of the values.
• • • 76 • Documentum Connector CFS Administration Guide • • Method Reference
XmlNodeSet Methods
at Returns XmlNode at position pos in the array.
Syntax at( pos )
Arguments
Arguments Type/Description
pos The index of the item in the array to get.
Returns An XmlNode.
size Returns size of node set.
Syntax size()
Returns An integer of the size of the node set.
XmlNode Methods
attr Returns first XmlAttr attribute object for this element.
Syntax attr()
Returns An XmlAttr object.
content Returns the content (text element) of the xml node.
• • • Documentum Connector CFS Administration Guide • 77 • • Chapter 5 Use Lua Scripts
Syntax content()
Returns A string containing the content.
firstChild Returns XmlNode which is the first child of this node.
Syntax firstChild()
Returns An xmlNode.
lastChild Returns XmlNode which is the last child of this node.
Syntax lastChild()
Returns An xmlNode.
name Returns the name of the xml node.
Syntax name()
Returns A string containing the name.
next Returns XmlNode which is the next sibling of this node.
Syntax next()
Returns An xmlNode.
• • • 78 • Documentum Connector CFS Administration Guide • • Method Reference
nodePath Returns the Xml path to the node which can be used in another XPath query.
Syntax nodePath()
Returns A string containing the path.
parent Returns the parent XmlNode of the node.
Syntax parent()
Returns An xmlNode.
prev Returns XmlNode which is the previous sibling of this node.
Syntax prev()
Returns An xmlNode.
type Returns the type of the node as a string.
Syntax type()
Returns A string containing the type. Possible values are:
element_node comment_node element_decl attribute_node document_node attribute_decl text_node document_type_node entity_decl cdata_section_node document_frag_node namespace_decl entity_ref_node notation_node xinclude_start entity_node html_document_node xinclude_end
• • • Documentum Connector CFS Administration Guide • 79 • • Chapter 5 Use Lua Scripts
pi_node dtd_node docb_document_node
XmlAttr Methods
name Returns the name of this attribute.
Syntax name()
Returns A String containing the name of the attribute.
next Returns XmlAttr object for the next attribute in the parent element.
Syntax next()
Returns An XmlAttr.
prev Returns XmlAttr object for the previous attribute in the parent object.
Syntax prev()
Returns An XmlAttr.
type Returns the type of this attribute node.
Syntax type()
Returns A String containing "attribute_node" if the node is valid, or "null" if the node is invalid.
• • • 80 • Documentum Connector CFS Administration Guide • • Method Reference
value Returns the value of this attribute.
Syntax value()
Returns A String containing the value of the attribute.
ACI Methods
send_aci_action Sends the given query to the ACI server at host:port with optional time-out (ms) and retries settings. Takes the action parameters as a table instead of the full action as a string, as with send_aci_command, to avoid issues with parameter values containing “&”.
Syntax send_aci_action( host, port, action [, parameters][, timeout] [, retries] )
Example send_aci_action( “localhost”, 9000, “query”, {text = “*”, print = “all”} );
Arguments
Arguments Type/Description
host The ACI host to send the query to.
port The port to send the query to.
action The action to perform (for example, query).
parameters This takes a Lua table containing the action parameters, for example, { param1=”foo”, param2=”bar” }
timeout The number of milliseconds to wait before timing out. The default is 3000.
retries The number of times to retry if the request fails. The default is 3.
• • • Documentum Connector CFS Administration Guide • 81 • • Chapter 5 Use Lua Scripts
Returns If the application has been configured with an XSLT dll (autnxslt.dll/ libautnxslt.so) then the response is returned as an XMLDocument. Otherwise, the xml response is returned as a string. If the request has failed, then nil is returned.
send_aci_command Sends the given query to the ACI server at host:port with optional time-out (ms) and retries settings.
Syntax send_aci_command( host, port, query [, timeout] [, retries] )
Arguments
Arguments Type/Description
host The ACI host to send the query to.
port The port to send the query to.
query The query to send (for example, action=getstatus)
timeout The number of milliseconds to wait before timing out. The default is 3000.
retries The number of times to retry if the request fails. The default is 3.
Returns If the application has been configured with an XSLT dll (autnxslt.dll/ libautnxslt.so) then the response is returned as an XMLDocument. Otherwise, the xml response is returned as a string. If the request has failed, then nil is returned.
Config Methods
get_config Load a configuration file.
Syntax get_config( path )
• • • 82 • Documentum Connector CFS Administration Guide • • Method Reference
Arguments
Arguments Type/Description
path The path of the configuration file to load.
Discussion Config files are cached after the first call to get_config, to avoid unnecessary disk I/O in the likely event that the same config is accessed frequently by subsequent invocations of the Lua script. One cache is maintained per Lua state, so the maximum number of reads for a config file is equal to the number of threads which are running Lua scripts An error is raised if the configuration file does not exist.
Returns A Config object.
getEncryptedValue Returns the unencrypted value from the configuration file of an encrypted value.
Syntax String getEncryptedValue(String section, String key)
Arguments
Arguments Type/Description
section The section in the configuration file.
key The key in the configuration file to get the value for.
Returns The unencrypted value.
getValue Returns the value of the configuration parameter key in a given section. If the key does not exist in the section, then the default value is returned.
Syntax getValue( String section, String key, String default )
• • • Documentum Connector CFS Administration Guide • 83 • • Chapter 5 Use Lua Scripts
Arguments
Arguments Type/Description
section The section name in the configuration file.
key The name of the key from which to read.
default The default value to use if no key is found.
Returns A string containing the value read from the configuration file.
getValues Returns a table of strings if you have multiple values for a key (for example, a CSV or numbered like keyN).
Syntax Table getValues(String section, String key)
Arguments
Arguments Type/Description
section The section in the configuration file.
key The key in the configuration file to get the value for.
Returns A table of strings of the values.
String Methods
gobble_whitespace Reduces multiple adjacent white spaces (tab, carriage return, space, and so on) in the specified field to a single space.
Syntax String gobble_whitespace (String Input)
• • • 84 • Documentum Connector CFS Administration Guide • • Method Reference
Arguments
Arguments Type/Description
Input An input string.
Returns A string without adjacent white spaces.
hash_string Hashes the specified string using the SHA1 or MDA5 algorithm.
Syntax String hash_string (String StringToHash, String Algorithm)
Arguments
Arguments Type/Description
StringToHash The string to be hashed. Algorithm The algorithm to use. Must be either SHA1 or MDA5.
Returns The hashed input string.
parse_csv Parse the given separated values string into a collection of individual strings.
Syntax parse_csv( csv_string [, delimiter])
Arguments
Arguments Type/Description
csv_string The string to parse.
delimiter The delimiter to use (defaults to ",").
Discussion The method understands quoted values (such that parsing 'foot, "leg, torso", elbow' produces three values) and ignores white space around delimiters.
• • • Documentum Connector CFS Administration Guide • 85 • • Chapter 5 Use Lua Scripts
Returns The elements are returned as multiple return values. You may wish to put them in a table like this:
local results = { parse_csv("cat,tree,house", ",") };
parse_xml Parse the given XML string to an XMLDocument.
Syntax parse_xml( xml_string )
Arguments
Arguments Type/Description
xml_string XML data as a string.
Discussion This requires the XSLT dll (autnxslt.dll/libautnxslt.so).
Returns An XMLDocument containing the parsed data, or nil if the string could not be parsed.
Document Methods
create_uuid Creates a universally unique identifier.
Syntax String create_uuid()
Returns A universally unique identifier.
encrypt_security_field Encrypts the ACL.
Syntax String encrypt_security_field (String ACL)
• • • 86 • Documentum Connector CFS Administration Guide • • Method Reference
Arguments
Arguments Type/Description
ACL An Access Control List string.
Returns An encrypted string.
hash_file Hashes the specified file using the SHA1 or MDA5 algorithm, or both.
Syntax String, [String] hash_file (String FileName, String Algorithm1, [String Algorithm2])
Arguments
Arguments Type/Description
FileName The name of the file to be specified. Algorithm1 The type of algorithm to use. Must be either SHA1 or MDA5.
Algorithm2 The optional second type of algorithm to use. Must be whichever algorithm was not used in Algorithm1.
Returns The hashed file.
Date Methods
convert_date_time Converts date and time formats using standard Autonomy syntax.
Syntax String convert_date_time (String InputDateTime, String InputFormatCSV, String OutputFormat, [Boolean OutputGMT = false])
• • • Documentum Connector CFS Administration Guide • 87 • • Chapter 5 Use Lua Scripts
Arguments
Arguments Type/Description
InputDateTime The date and time to be converted.
InputFormatCSV A comma-separated list of the possible date and time formats of the input.
OutputFormat The format of the date and time to be output.
OutputGMT Specifies whether to treat the date and time output as Greenwich Mean Time. Default is false.
Discussion All date and time input is treated as local time unless it contains explicit time zone information.
Returns Date and time in the desired format.
File System Methods
abs_path Returns the supplied path as an absolute path.
Syntax abs_path( String path )
Arguments
Arguments Type/Description
path The relative path.
Returns Returns a string of the supplied path as an absolute path.
• • • 88 • Documentum Connector CFS Administration Guide • • Method Reference
copy_file Copy the source file to the destination path. The copy will fail if the destination file already exists. This can be overridden by providing the optional overwrite argument which forces the copy if the destination exists.
Syntax copy_file( String src, String dest [, Boolean overwrite] )
Arguments
Arguments Type/Description
src The source file.
dest The destination file.
overwrite Forces the copy if the destination exists.
Returns Returns a Boolean indicating success/failure.
create_path Creates the specified directory tree.
Syntax void create_path (String Path)
Arguments
Arguments Type/Description
Path The path to be created.
delete_file Delete the file specified by path.
Syntax delete_file( String path )
• • • Documentum Connector CFS Administration Guide • 89 • • Chapter 5 Use Lua Scripts
Arguments
Arguments Type/Description
path The path and filename of the file to be deleted.
Returns Returns a Boolean indicating success/failure.
file_setdates Sets the given file times on the file specified by path. If the format parameter is not specified, it is assumed that the dates are provided as seconds since the epoch (1st January 1970).
Syntax file_setdates( String path, String created, String modified, String accessed [, String format] )
Arguments
Arguments Type/Description
path The path or filename of the file to be deleted.
created The date created.
modified The date modified.
accessed The last date accessed.
format Used to format the strings coming in at system time. The format parameter is the same as for other Autonomy products.
getcwd Returns the current working directory of the application.
Syntax getcwd()
Returns Returns a string of the current working directory.
• • • 90 • Documentum Connector CFS Administration Guide • • Method Reference
is_dir Check if the supplied path is a directory.
Syntax is_dir( String path )
Arguments
Arguments Type/Description
path The path to check.
Returns Returns a Boolean indicating if the supplied path is a directory.
move_file Move the source file to the destination path. The move will fail if the destination file already exists. This can be overridden by providing the optional overwrite argument which forces the move if the destination exists.
Syntax move_file( String src, String dest [, Boolean overwrite] )
Arguments
Arguments Type/Description
src The source file.
dest The destination file.
overwrite Forces the move if the destination exists.
Returns Returns a boolean indicating success/failure.
unzip_file Extracts the zip file specified by path to the location specified by dest.
Syntax unzip_file( String path, String dest )
• • • Documentum Connector CFS Administration Guide • 91 • • Chapter 5 Use Lua Scripts
Arguments
Arguments Type/Description
path The path or filename of the file to be unzipped.
dest The destination path where the files are to be extracted.
Returns Returns a boolean indicating success/failure.
zip_file Zip the supplied path (file or directory). The output file will only be overwritten if true is supplied for the optional overwrite argument.
Syntax zip_file( String path [, Boolean overwrite] )
Arguments
Arguments Type/Description
path The path or filename of the file to be zipped.
overwrite Forces the creation of the zip file if an output file already exists.
Returns The output path is written to path.zip. Returns Boolean indicating success or failure.
Miscellaneous Methods
log Appends log messages to the specified file.
Syntax log( String file, String message )
• • • 92 • Documentum Connector CFS Administration Guide • • Method Reference
Arguments
Arguments Type/Description
file The file to which log messages will be appended.
message The message to print to the file.
Returns Nothing.
sleep Pause the executing thread for a number of milliseconds.
Syntax sleep( Integer milliseconds )
Arguments
Arguments Type/Description
milliseconds The number of milliseconds for which to pause the current thread.
Returns Nothing.
Change the Value of a Field The functions getFieldValue, fieldGetValue and setFieldValue, fieldSetValue allow you to modify the contents of a field directly. For example: local content_field = document:findField("CONTENT") local content = document:fieldGetValue(content_field) local content = document:getFieldValue("CONTENT") content = content .. "\nCopyright MyCorp\n" document:setFieldValue("CONTENT", content) document:fieldSetValue(content_field, content)
• • • Documentum Connector CFS Administration Guide • 93 • • Chapter 5 Use Lua Scripts
Example Script For each document, this Lua script adds a COUNT field, a total sections count to the title, and replaces the content of each section with the section number.
NOTE The COUNT is 1 for the first document and increases as long as the job is running.
doc_count = 0 function handler(document) doc_count = doc_count + 1 document:addField("COUNT",doc_count);
local section_count = 0 local section = document
while section do section_count = section_count + 1 section:setFieldValue("CONTENT", "Section "..section_count); section = section:getNextSection() end local field = section:findField("DRECONTENT") if field then section:fieldSetValue(field, "Section "..section_count); end section = section:getNextSection() end
document:setFieldValue("TITLE", document:getFieldValue("TITLE").." Total Sections " ..section_count) return true; local field = document:findField("DRETITLE") if field then document:fieldSetValue(field, document:fieldGetValue(field).." Total Sections "..section_count) end end
• • • 94 • Documentum Connector CFS Administration Guide • • Use Lua Scripts Within the Connector
Use Lua Scripts Within the Connector
This section describes how to use CFS connector actions in Lua scripts to transform documents. It includes the following sections:
Introduction
Example Lua Script
Introduction There are occasions when documents are not to be sent to the Connector Framework Server (CFS). For example, you may use the Collect action to retrieve documents from one repository and then insert them into another. In doing so, you may need to transform the documents from the first repository before they can be accepted by the second repository. You can use a Lua script to do this. Some CFS connector configuration options and actions take a Lua script as a parameter. The information in this chapter discusses the requirements for any Lua script that is used in this way.
Example Lua Script You can use the CollectActions parameter of the Collect action, the IngestActions parameter of the Synchronize action and the IngestActions parameter in the configuration file to specify a Lua script that runs on each document. The Lua script takes the following parameters:
Parameter Description
config A configuration file object.
document A document object that represents the document.
params A table containing additional parameters provided by the connector. For example: TYPE. The type of the command being performed. This can be ADD, UPDATE, DELETE, or COLLECT. SECTION. The configuration section for the task. FILENAME. The document filename. The Lua script may modify this file, but should not delete it.
• • • Documentum Connector CFS Administration Guide • 95 • • Chapter 5 Use Lua Scripts
The configuration file object provides the following methods: getValue(section, parameter, default) The document object provides the following methods: addField(fieldname, value) appendContent(additionalContent) setFieldValue(fieldname, value) writeStubIdx(outputFilename) getFieldValue(fieldname) hasField(fieldname) renameField(oldFieldName, newFieldName) copyField(sourceFieldName, targetFieldName) deleteField(fieldname) getFieldValues(fieldname) An example Lua script appears below: method handler( config, document, params ) -- If these lines are uncommented, and the connector is running -- from the console, all the parameters in params will be output -- to the console. -- for k,v in pairs(params) do -- print(k,v) -- end -- Sets local variables from the parameters passed in. local type = params["TYPE"] local section = params["SECTION"] local filename = params["FILENAME"] -- Read a config setting from the config file. local val = config:getValue(section, "ConfigSettingName", "Value") -- If the document is not being deleted, set the field FieldName -- to the value read from the config file. if type ~= "DELETE" then document:setFieldValue("FieldName", val) end -- If this document has a file (that is, not just metadata), -- copy the file to a new location and write a stub idx -- containing the metadata with it. if filename ~= "" then copytofilename = "OutputPath/"..create_uuid(filename)
• • • 96 • Documentum Connector CFS Administration Guide • • Use Lua Scripts Within the Connector
copy_file(filename, copytofilename) document:writeStubIdx(copytofilename..".idx") end return true end
NOTE The Lua script should return true normally, but can return false to reject the document when used as an Ingest action.
• • • Documentum Connector CFS Administration Guide • 97 • • Chapter 5 Use Lua Scripts
• • • 98 • Documentum Connector CFS Administration Guide • • PART 2 Parameter and Command Reference
This section describes some of the configuration parameters and action commands used by the Documentum Connector CFS and Connector Framework server and includes the following chapters:
Documentum Connector CFS Configuration Parameters
Parameters Common to CFS Connectors
Parameters Common to CFS Connectors Using Java
CFS Connector Actions
Connector Framework Server Parameters
License Configuration Parameters
Server Parameters
Logging Configuration Parameters
Secure Socket Layer Parameters
Service Actions
Service Configuration Parameters Part 2 Parameter and Command Reference
• • • 100 • Documentum Connector CFS Administration Guide • • CHAPTER 6 Documentum Connector CFS Configuration Parameters
This chapter describes the parameters that determine how Documentum Connector CFS operates. You can modify these parameters to customize Documentum Connector CFS to your needs.
License Parameters
Service Parameters
Server Parameters
Logging Parameters
DistributedConnector Section
ViewServer Section
Connector Parameters
Ingestion Parameters
FetchTasks/TaskName Parameters
• • • Documentum Connector CFS Administration Guide • 101 • • Chapter 6 Documentum Connector CFS Configuration Parameters
License Parameters
This section contains parameters that determine licensing details.
Related Topics “License Configuration Parameters” on page 197
Service Parameters
This section contains parameters that determine which machines are permitted to use and control the Documentum Connector CFS service.
Related Topics “Service Configuration Parameters” on page 245
Server Parameters
This section contains general parameters for indexing and querying.
Related Topics “Server Parameters” on page 203
Logging Parameters
This section contains the configuration parameters used to create separate log files for different log message types (such as, application, action, and synchronize) and to determine how each stream is logged.
Related Topics “Logging Configuration Parameters” on page 207
• • • 102 • Documentum Connector CFS Administration Guide • • DistributedConnector Section
DistributedConnector Section
This section is only required only if the connector (or multiple connectors) is used with the Distributed Connector (DC) component. The DC is used to distribute the actions (synchronize/collect and so forth) between a number of connectors.
Related Topics “Parameters Common to CFS Connectors” on page 119
ViewServer Section
The parameters in this section allow the connector’s view action to use a View Server.
Related Topics “Parameters Common to CFS Connectors” on page 119
Connector Parameters
These parameters enable features, set temporary directories, and so on. This section also contains Java settings.
Related Topics “Parameters Common to CFS Connectors” on page 119
Ingestion Parameters
The parameters in this section specify details for the Connector Framework server (also known as the Ingestion server). The server accepts data from the connector, generates an IDX or XML file, and sends the file to IDOL for indexing.
Related Topics “Parameters Common to CFS Connectors” on page 119
• • • Documentum Connector CFS Administration Guide • 103 • • Chapter 6 Documentum Connector CFS Configuration Parameters
FetchTasks/TaskName Parameters
These sections define the URL and accounts from which you want to retrieve data. In the [FetchTasks] section, you enter the total number of tasks in the Number parameter and then list the tasks in consecutive order starting from 0 (zero). You then create a TaskName section for each task listed. For example:
ACLUsernameField Use this parameter to specify the Documentum field name to use when extracting the user name.
Type: String
Default: user_login_name
Required: No
Configuration FetchTasks and TaskName Section:
Example: ACLUsernameField=user_login_name
See Also:
BrowseSecurity Set to true to enable the extraction of ACLs to the field specified by the BrowseSecurityField parameter.
Type: Boolean
Default: False
Required: No
Configuration FetchTasks and TaskName Section:
Example: BrowseSecurity=true See Also: “BrowseSecurityField” on page 105
• • • 104 • Documentum Connector CFS Administration Guide • • FetchTasks/TaskName Parameters
BrowseSecurityField The field to which ACLs are extracted.
Type: String
Default: AutonomyMetadata_Browse
Required: No
Configuration FetchTasks and TaskName Section:
Example: BrowseSecurityField=AutonomyMetadata_Browse See Also: “BrowseSecurity” on page 104
ContentFormatPreferenceCSV Use this parameter to specify a preferred comma-separated-values (CSV) list of formats to download in order of preference (if the formats are available). If none of the configured formats is available, the default format for the document is returned.
Type: String
Default:
Required: No
Configuration FetchTasks and TaskName Section:
Example: ContentFormatPreferenceCSV=
See Also:
CustomFieldExtractNameN The custom field that should be extracted during document download.
The CustomFieldExtractToNameN parameter specifies the IDOL server fields into which the value of CustomFieldExtractNameN is extracted. CustomFieldExtractNameN and CustomFieldExtractToNameN entries must occur in pairs with the value of N being a number common to individual pairs and starting at 0 (zero).
• • • Documentum Connector CFS Administration Guide • 105 • • Chapter 6 Documentum Connector CFS Configuration Parameters
Type: String
Default: None
Required: No
Configuration FetchTasks and TaskName Section:
Example: CustomFieldExtractName0=r_modify_date See Also: “CustomFieldSelectStatement” on page 106 “CustomFieldExtractToNameN” on page 106
CustomFieldExtractToNameN The IDOL server field into which the value of the field specified by CustomFieldExtractNameN should be extracted.
Type: String
Default: None
Required: No
Configuration FetchTasks and TaskName Section:
Example: CustomFieldExtractToName0=CUSTOM_R_MODIFY_DATE See Also: “CustomFieldSelectStatement” on page 106 “CustomFieldExtractNameN” on page 105
CustomFieldSelectStatement Allows a custom SELECT statement field to be extracted during document download. Specify a complete SELECT statement including the SELECT, FROM, ORDERBY, and WHERE clauses.
The SELECT statement should include the special string ‘@r_object_id’ to represent the r_object_id for the document. This setting can also be configured as a numbered setting, CustomFieldExtractNameN, if multiple statements are required to extract the above fields. The non-numbered setting can still be used.
• • • 106 • Documentum Connector CFS Administration Guide • • FetchTasks/TaskName Parameters
Type: String
Default: None
Required: No
Configuration FetchTasks and TaskName Section: Example: CustomFieldSelectStatement=SELECT r_modify_date FROM dm_document WHERE r_object_id='@r_object_id' See Also: “CustomFieldExtractNameN” on page 105 “CustomFieldExtractToNameN” on page 106
DeleteSelectStatement Use this parameter value to allow overriding of the default statement that uses the audit trail. The parameter value defaults to blank.
Type: String
Default: (blank)
Required: No
Configuration FetchTasks and TaskName Section:
Example: DeleteSelectStatement=
See Also:
Docbase Use this parameter to specify the name of the repository you want Documentum Connector CFS to retrieve.
Type: String
Default: None
Required: Yes
Configuration FetchTasks and TaskName Section:
Example: Docbase=repository_name
See Also:
• • • Documentum Connector CFS Administration Guide • 107 • • Chapter 6 Documentum Connector CFS Configuration Parameters
DocumentType Use this parameter to enable the document types brought back to be configurable.
Type: String
Default: dm_document
Required: No
Configuration FetchTasks and TaskName Section:
Example: DocumentType=dm_document
See Also:
Domain Use this parameter to specify the domain used to log into the docbase.
Type: String
Default: None
Required: No
Configuration FetchTasks and TaskName Section:
Example: Domain=mydomain
See Also:
ExtensionCSVs Use this parameter to filter against the object_name field in the Documentum Connector CFS using a comma separated list of file extensions or * and ? as wildcards. This field typically holds the filename. This setting is not applied if using custom SELECT statements or custom SELECT clauses.
Type: String
Default: None
Required: No
• • • 108 • Documentum Connector CFS Administration Guide • • FetchTasks/TaskName Parameters
Configuration FetchTasks and TaskName Section:
Example: ExtensionCSVs=*
See Also:
FieldQueryN Use this parameter to allow for select criteria using operators other than LIKE (used by the FieldQueryNameN and FieldQueryValueN parameters.
Type: String
Default: None
Required: No
Configuration FetchTasks and TaskName Section:
Example: FieldQuery0=r_content_size>0 See Also: “FieldQueryValueN” on page 110 “FieldQueryNameN” on page 109
FieldQueryNameN Use this parameter to specify the name of the field that will be used to filter. This setting is not applied if using custom SELECT statements or custom SELECT clauses.
Type: String
Default: None
Required: No
Configuration FetchTasks and TaskName Section:
Example: FieldQueryName0=object_name See Also: “FieldQueryValueN” on page 110 “ExtensionCSVs” on page 108 “FolderCSVs” on page 110 “FolderNegation” on page 111 “FolderRecursion” on page 111
• • • Documentum Connector CFS Administration Guide • 109 • • Chapter 6 Documentum Connector CFS Configuration Parameters
FieldQueryValueN Use this parameter to specify the filter text for the field specified by the matching FieldQueryNameN parameter. You may use wildcard characters * and ? as part of the value. This setting is not applied if using custom SELECT statements or custom SELECT clauses.
Type: String
Default: None
Required: No
Configuration FetchTasks and TaskName Section:
Example: FieldQueryValue0=*doc* See Also: “FieldQueryN” on page 109 “ExtensionCSVs” on page 108 “FolderCSVs” on page 110 “FolderNegation” on page 111 “FolderRecursion” on page 111
FolderCSVs Specify a comma-separated list of folders from which documents are retrieved. Leave this blank to retrieve documents from all folders. This setting is not applied if using custom SELECT statements or custom SELECT clauses.
Type: String
Default: None
Required: No
Configuration FetchTasks and TaskName Section:
Example: FolderCSVs=/documentum/docs See Also: “FieldQueryN” on page 109 “FieldQueryValueN” on page 110 “ExtensionCSVs” on page 108 “FolderNegation” on page 111 “FolderRecursion” on page 111
• • • 110 • Documentum Connector CFS Administration Guide • • FetchTasks/TaskName Parameters
FolderNegation If the value of this parameter is set to True, process only the folders that are not specified using the FolderCSVs parameter. This setting is not applied if using custom SELECT statements or custom SELECT clauses.
Type: Boolean
Default: False
Required: No
Configuration FetchTasks and TaskName Section:
Example: FolderNegation=False See Also: “FieldQueryN” on page 109 “FieldQueryValueN” on page 110 “ExtensionCSVs” on page 108 “FolderCSVs” on page 110 “FolderRecursion” on page 111
FolderRecursion Use this parameter to specify folder recursion from the specified folders.
This setting is not applied if using custom SELECT statements or custom SELECT clauses.
Type: Boolean
Default: True
Required: No
Configuration FetchTasks and TaskName Section:
Example: FolderRecursion=True See Also: “FieldQueryN” on page 109 “FieldQueryValueN” on page 110 “ExtensionCSVs” on page 108 “FolderCSVs” on page 110 “FolderNegation” on page 111
• • • Documentum Connector CFS Administration Guide • 111 • • Chapter 6 Documentum Connector CFS Configuration Parameters
GetChildOfVirtualDoc Set this parameter to true to retrieve children of virtual documents. (Multiple levels of virtual are retrieved.)
Type: Boolean
Default: True
Required: No
Configuration FetchTasks and TaskName Section:
Example: GetChildOfVirtualDoc=True
See Also:
HoldRetentionPolicy When using the Hold and ReleaseHold actions and using the Documentum Retention Policy Services (DRPS), this parameter specifies the name or ID of the retention policy used when performing a hold.
Type: String
Default: No
Required: No
Configuration FetchTasks and TaskName Section:
Example: HoldRetentionPolicy=MyPolicy HoldRetentionPolicy=06de75d1800019e1
See Also:
IgnoreContentCSVs Allows you to index the metadata of files rather than their content. This is useful when you want to index graphic files. Enter one or more file extensions to specify which files you want to index as metadata. To specify multiple file extensions, separate them with commas. There must be no space before or after a comma.
• • • 112 • Documentum Connector CFS Administration Guide • • FetchTasks/TaskName Parameters
Type: String
Default: None
Required: No
Configuration FetchTasks and TaskName Section:
Example: IgnoreContentCSVs=jpg,gif In this example, any file with the extension .jpg or .gif is indexed as metadata.
Incremental Enter false to fetch all documents every time the connector runs. Enter true to fetch only documents that are new or have been modified since the last connector cycle.
If you enter true, the connector behaves as though Incremental=false for the initial run.
For new and modified documents, it queries the dm_audittrail table for entries with event_name 'dm_checkin' or 'dm_save' (or dm_audittrail_acl table entries with event_name 'dm_save') restricted by time_stamp read from time file.
For deletions, it queries the audit trail table for entries with event_name 'dm_destroy' or 'dm_prune' restricted by time_stamp read from time file. The DQL query for new/modified object IDs appears below as an example:
SELECT DISTINCT(dm_document.r_object_id) FROM dm_document WHERE ( dm_document.r_object_id IN ( SELECT dm_audittrail.audited_obj_id FROM dm_audittrail WHERE ((dm_audittrail.event_name = 'dm_checkin') OR (dm_audittrail.event_name = 'dm_save')) AND (dm_audittrail.time_stamp > date('
• • • Documentum Connector CFS Administration Guide • 113 • • Chapter 6 Documentum Connector CFS Configuration Parameters
> date('
Type: Boolean
Default: False
Required: No
Configuration FetchTasks and TaskName Section:
Example: Incremental=true
See Also:
MappedSecurity Enter true if you want the fetch to index Access Control List (ACL) information into IDOL server. The MappedSecurityTable parameter specifies where the security information is stored, and the MappedSecurityField parameter specifies where the security information is written in the IDX file.
Enter false if you do not want the fetch to index Access Control List (ACL) information.
Type: Boolean
Default: False
Required: No
Configuration FetchTasks and TaskName Section:
Example: MappedSecurity=true
See Also:
• • • 114 • Documentum Connector CFS Administration Guide • • FetchTasks/TaskName Parameters
MappedSecurityField Enter the name of the structured field in IDOL server where the Access Control List (ACL) is stored.
Type: String
Default: AUTONOMYMETADATA
Required: No
Configuration FetchTasks and TaskName Section:
Example: MappedSecurityField=ACLLIST See Also: “MappedSecurity” on page 114
Password The password for the repository. This should be an encrypted version of the password. An encrypted version of the password can be generated using the autpassword.exe utility.
Type: String
Default: None
Required: Yes
Configuration FetchTasks and TaskName Section:
Example: Password=h20dl38ahvl35srq See Also: “Username” on page 117
PreAppendDocBase If enabled, this parameter allows Documentum Connector CFS to prepend the repository name to the global UID of a group when querying security information (ACL) from the repository.
Type: Boolean
Default: False
Required: No
• • • Documentum Connector CFS Administration Guide • 115 • • Chapter 6 Documentum Connector CFS Configuration Parameters
Configuration FetchTasks and TaskName Section:
Example: PreAppendDocBase=true
See Also:
SelectStatement If SpecifySelectStatement is set to true, you can use this parameter to specify a complete SELECT statement, including the SELECT, FROM, ORDERBY, and WHERE clauses.
NOTE When using a custom SELECT statement, you can use @lastruntime to represent the last run time in the format dd/mm/yyyy hh:mi:ss. @lastruntime is case-insensitive.
Type: String
Default: None
Required: No
Configuration FetchTasks and TaskName Section:
Example: SelectStatement=SELECT AUDIT_ID, DOC_OBJECT_ID as r_object_id FROM documntm.AUDIT_TRAIL WHERE AUDIT_ID>@last_audit_id order by AUDIT_ID DESC See Also: “SelectStatement” on page 116
UpdateCheckFields Use this parameter to specify a preferred comma-separated-values (CSV) list of document attributes to be checked for changes. The security fields are always added to this list.
Type: String
Default:
Required: No
• • • 116 • Documentum Connector CFS Administration Guide • • FetchTasks/TaskName Parameters
Configuration FetchTasks and TaskName Section:
Example: UpdateCheckFields=
See Also:
UseGlobalUids If set to true, this parameter allows Documentum Connector CFS to use global UIDs for the user and group name when querying security information (ACL) from the repository.
Type: Boolean
Default: False
Required: No
Configuration FetchTasks and TaskName Section:
Example: UseGlobalUids=true
See Also:
Username The user name for the repository.
Type: String
Default: None
Required: Yes
Configuration FetchTasks and TaskName Section:
Example: Username=cpoo2
See Also:
• • • Documentum Connector CFS Administration Guide • 117 • • Chapter 6 Documentum Connector CFS Configuration Parameters
• • • 118 • Documentum Connector CFS Administration Guide • • CHAPTER 7 Parameters Common to CFS Connectors
This chapter describes the parameters that are common to all connectors that use the Connector Framework Service (CFS). If more than one configuration file-section is specified for a configuration parameter, the value of the parameter located in the left-most section will override the values of the parameters contained in the other sections mentioned.
Using the Configuration Section example, “TaskName or FetchTasks or Default,” parameter values in the TaskName section will override corresponding values in the FetchTasks section, which will, in turn, override those corresponding in the Default section. ACI Server Configuration
Import Service
Distributed Connector
View Server
General Connector Parameters
Fetch Task Configuration
Ingestion
GroupServer
• • • Documentum Connector CFS Administration Guide • 119 • • Chapter 7 Parameters Common to CFS Connectors
ACI Server Configuration
The parameters in this section control the way the connector handles the load caused by incoming ACI requests.
FilePath Use this parameter to specify the location of the file to receive event data. Set the value as TextFileHandler to use an internal text file handler.
Type: String
Default:
Required: No
Configuration EventHandler Section:
Example: FilePath=./EventData See Also: “LibraryName” on page 120
LibraryName Use this parameter to specify the name of the library to use as the event handler. Set as HttpHandler to use as internal HTTP handler. Specifying the .dll or .so extension is optional.
Type: String
Default:
Required: No
Configuration EventHandler Section:
Example: LibraryName=./luaHandler See Also: “OnError” on page 123 “OnFinish” on page 124 “OnStart” on page 124
LuaScript Use this parameter to specify the Lua script to execute on the event.
• • • 120 • Documentum Connector CFS Administration Guide • • ACI Server Configuration
Type: String
Default:
Required: No
Configuration EventHandler Section:
Example: LuaScript=./finished_handler.lua See Also: “LibraryName” on page 120
MaximumThreads Use this parameter to specify the maximum number of simultaneous ACI actions to process.
The number of synchronous actions (for example, getstatus or view) that should be processed simultaneously: [Server] MaximumThreads=4 The number os asynchronous actions (for example, fetch) that should be processed simultaneously: [Actions] MaximumThreads=4
Type: Integer
Default: 2
Required: No
Configuration Actions or Server Section:
Example: MaximumThreads=4 See Also:
• • • Documentum Connector CFS Administration Guide • 121 • • Chapter 7 Parameters Common to CFS Connectors
MaxQueueSize Use this parameter to specify the maximum number of asynchronous fetch action commands that will be queued by the connector. No further fetch actions will be accepted once the queue size has been reached (until the queue diminishes).
Type: Integer
Default: The default is the maximum integer value (no limit).
Required: No
Configuration Actions Section:
Example: MaxQueueSize=4 See Also: “MaxScheduledSize” on page 122
MaxScheduledSize Use this parameter to limit the number of Processing+Finished+Error tasks that are stored by the connector. All actions and response data are stored in a file, actions/fetch/fetch.queue. If the MaxScheduledSize parameter value is not specified, this file will continue to grow with each action - eventually a resource limit would be reached that will cause unhandled failures to occur.
If this limit is exceeded, the oldest Finished or Error action is disposed of and so will no longer be accessible through the queueinfo action. The MaxScheduledSize and MaxQueueSize parameters together give the total actions that will be stored (Queued, Processing, Finished, or Error). (Note that Queued, Processing, Finished, and Error are the action statuses reported by the queueinfo action.
Type: Integer
Default: The default is the maximum integer value (no limit).
Required: No
Configuration Actions Section:
Example: MaxScheduledSize=100 See Also: “MaxQueueSize” on page 122
• • • 122 • Documentum Connector CFS Administration Guide • • ACI Server Configuration
OnError Use this parameter to specify the handler for the Fetch action error event.
This is the section name that will contain the LibraryName and any other settings for the event handler.
Typical configuration is (using OnFinish):
[Actions] OnFinish=HttpHandler [HttpHandler] LibraryName=HttpHandler Url=http://localhost/dosomething?
Type: String
Default:
Required: No
Configuration Actions Section:
Example: OnError=EventHandler See Also:
OnErrorReport Use this parameter to specify the handler for the Fetch action error report event.
Type: String
Default:
Required: No
Configuration Actions Section:
Example: OnErrorReport=EventHandler See Also:
• • • Documentum Connector CFS Administration Guide • 123 • • Chapter 7 Parameters Common to CFS Connectors
OnFinish Use this parameter to specify the handler for the Fetch action finish event.
Type: String
Default:
Required: No
Configuration Actions Section:
Example: OnFinish=EventHandler See Also:
OnStart Use this parameter to specify the handler for the Fetch action start event.
Type: String
Default:
Required: No
Configuration Actions Section:
Example: OnStart=EventHandler See Also:
Url Use this parameter to specify the URL to receive event data (when configured to use LibraryName=HttpHandler only). Each handler type will have specific configuration settings. For HttpHandler, the available settings are: Url SSLConfig ProxyHost ProxyPort ProxyUser ProxyPassword BasicUser BasicPassword
• • • 124 • Documentum Connector CFS Administration Guide • • Import Service
If the Library parameter is set to Luahandler, the available parameter is LuaScript, which takes the path of the Lua script that handles the events. Lua script event handlers should be of the form:
function handler(request, xml) ... end request is a table holding the request parameters. xml is a string holding the response to the request.
Type: String
Default:
Required: No
Configuration Actions Section:
Example: Url=http://localhost/dosomething?param=value Url=http://localhost:1234/?action=dosomething See Also:
Import Service
The parameters in this section control the way the connector interfaces with Keyview to extract document sub-files in response to collect or view actions.
KeyviewDirectory Use this parameter to specify the location of Keyview filters used for sub-file extraction. Doing so is an alternative to specifying this in the KEYVIEW_DIRECTORY environment variable. This parameter is used only if Keyview is required (if the EnableExtraction parameter is set to True).
Type: String
Default:
Required: No
• • • Documentum Connector CFS Administration Guide • 125 • • Chapter 7 Parameters Common to CFS Connectors
Configuration ImportService Section:
Example: KeyviewDirectory=./filters See Also: “EnableExtraction” on page 133
Distributed Connector
The parameters in this section control the way the connector behaves when used with the Distributed Connector.
ConnectorGroup Use this parameter to specify the name of the connector group to which this connector belongs. The ConnectorGroup parameter can take any value - it is only configured in the individual connectors, and is passed to the Distributed Connector when registering.
This parameter is used only if the RegisterConnector parameter is set to True.
Type: String
Default: Connector
Required: No
Configuration DistributedConnector Section:
Example: ConnectorGroup=Connector See Also: “RegisterConnector” on page 128
ConnectorPriority Use this parameter to specify the priority value used to distribute actions to higher priority connectors.
• • • 126 • Documentum Connector CFS Administration Guide • • Distributed Connector
This parameter is used only if the RegisterConnector parameter is set to True.
Type: Integer
Default: 0
Required: No
Configuration DistributedConnector Section:
Example: ConnectorPriority=1 See Also: “RegisterConnector” on page 128
DataPortN Use this parameter to specify the dataport number(s) of the Distributed Connector(s). This parameter is used only if the RegisterConnector parameter is set to True.
Type: Integer
Default:
Required: No
Configuration DistributedConnector Section:
Example: DataPort0=9876 See Also: “RegisterConnector” on page 128
HostN Use this parameter to specify the hostname(s) or IP address(es) of the Distributed Connector(s). This parameter is used only if the RegisterConnector parameter is set to True.
Type: String
Default: localhost
Required: No
• • • Documentum Connector CFS Administration Guide • 127 • • Chapter 7 Parameters Common to CFS Connectors
Configuration DistributedConnector Section:
Example: Host0=localhost See Also: “RegisterConnector” on page 128
PortN Use this parameter to specify the port number(s) of the Distributed Connector(s). This parameter is used only if the RegisterConnector parameter is set to True.
Type: Integer
Default: 10000
Required: No
Configuration DistributedConnector Section:
Example: Port0=10000 See Also: “RegisterConnector” on page 128
RegisterConnector Use this parameter to register with the Distributed Connector. The connector will wait at startup for registration to be successful.
If the action=fetch parameter synchronizestate is assigned, then this will hold the locations of the datastore files that will be used for the tasks. In this case, the DatastoreFile is ignored. The synchronizestate parameter is assigned when using the connector through the Distributed Connector.
Type: Boolean
Default: False
Required: No
Configuration DistributedConnector Section:
Example: RegisterConnector=False See Also:
• • • 128 • Documentum Connector CFS Administration Guide • • Distributed Connector
SharedPath Use this parameter to specify the path to a location common to all connectors in the Connector Group. This location is used to store the compressed datastore files used by the connectors. This parameter is used only if the RegisterConnector parameter is set to True.
Type: String
Default: The value of the TempDirectory parameter. Required: No
Configuration DistributedConnector Section:
Example: SharedPath=./temp See Also: “RegisterConnector” on page 128
SSLConfigN Use this parameter to specify the section(s) containing SSL settings for the Distributed Connector(s). This parameter is used only if the RegisterConnector parameter is set to True.
Type: String
Default:
Required: No
Configuration DistributedConnector Section:
Example: SSLConfig0= See Also: “RegisterConnector” on page 128
• • • Documentum Connector CFS Administration Guide • 129 • • Chapter 7 Parameters Common to CFS Connectors
View Server
The parameters in this section allow the connector’s view action to use a View Server.
EnableViewServer If this parameter is set to True, documents retrieved by a view action are processed by the View Server before being returned. If set to False, the original documents are returned.
Type: Boolean
Default: False
Required: No
Configuration Connector and ViewServer Section:
Example: EnableViewServer=False See Also:
Host Use this parameter to specify the hostname or IP address of the View Server. This parameter is used only if the EnableViewServer parameter is set to True.
Type: String
Default: localhost
Required: No
Configuration ViewServer Section:
Example: Host=localhost See Also: “EnableViewServer” on page 130
• • • 130 • Documentum Connector CFS Administration Guide • • View Server
Port Use this parameter to specify the port number of the View Server. This parameter is used only if the EnableViewServer parameter is set to True.
Type: Integer
Default: 9000
Required: No
Configuration ViewServer Section:
Example: Port=9000 See Also: “EnableViewServer” on page 130
SharedPath Use this parameter to specify the path to a location accessible by both the connector and the View Server. Intermediate files are stored here. This parameter is used only if the EnableViewServer parameter is set to True.
Type: String
Default: The value of the TempDirectory parameter.
Required: No
Configuration ViewServer Section:
Example: SharedPath=./temp See Also: “EnableViewServer” on page 130
• • • Documentum Connector CFS Administration Guide • 131 • • Chapter 7 Parameters Common to CFS Connectors
General Connector Parameters
CleanOnStart Set this parameter to True to delete actions and the temp directory on start. Any action data stored in the actions folder is deleted - including all Queued actions.
Type: Boolean
Default: False
Required: No
Configuration Connector Section:
Example: CleanOnStart=True See Also:
DatastoreFile Use this parameter to override the name of the datastore file used by synchronize actions. Normally, you should use the default value for this parameter.
Type: String
Default: connector_TaskName_datastore.db
Required: No
Configuration TaskName or FetchTasks Section:
Example: DatastoreFile=./Datastore/Datastore.db See Also: “SynchronizeKeepDatastore” on page 137
• • • 132 • Documentum Connector CFS Administration Guide • • General Connector Parameters
DatastoreDirectory Use this parameter to specify the directory where datastore files are stored (except when using the DistributedConnector section or have specified the DatastoreFile parameter.
Type: String
Default: .
Required: No
Configuration Connector Section:
Example: DatastoreDirectory=./Datastore/ See Also: “DatastoreFile” on page 132
EnableExtraction Use this parameter to enable the extraction of sub-files for collect and view actions. This requires keyview filters to be present and for their location to be specified in the KeyviewDirectory parameter or KEYVIEW_DIRECTORY environment variable.
Type: Boolean
Default: False
Required: No
Configuration Connector Section:
Example: EnableExtraction=False See Also: “KeyviewDirectory” on page 125
EnableExtractionCopy Generally, this parameter is only relevant to the File System Connector, that is acting on the original documents instead of temporary copies. When performing extraction from certain file types, KeyView has side-effects that mean that the document is updated. This specifically causes the modified date to be updated and will thus cause the connector to re-ingest the document on the next synchronize action.
• • • Documentum Connector CFS Administration Guide • 133 • • Chapter 7 Parameters Common to CFS Connectors
To avoid these modifications, the solution is to make a copy of the original document (by setting this parameter to True) and perform the extraction on the copy. For other connectors, enabling this setting will have no effect, since the connectors will be downloading temporary copies and will have ownership of the files.
Type: Boolean
Default: False
Required: No
Configuration Connector Section:
Example: EnableExtractionCopy=False See Also: “KeyviewDirectory” on page 125
EnableScheduledTasks Use this parameter to enable internal scheduling of synchronize actions. When this is set to True, the numbered tasks configured in the FetchTasks section will be performed according to their schedules. If this is set to False, synchronize actions will be performed only in response to an ACI request.
Type: Boolean
Default: True
Required: No
Configuration Connector Section:
Example: EnableScheduledTasks=False See Also:
• • • 134 • Documentum Connector CFS Administration Guide • • General Connector Parameters
EncryptACLEntries If this parameter is set to False, the entries in ACLs will not be encrypted. This should be used only for troubleshooting.
NOTE Some connectors allow this parameter to be set in the Task section. Not all connectors that have security necessarily must support this parameter.
Type: Boolean
Default: True
Required: No
Configuration Connector Section:
Example: EncryptACLEntries=True See Also:
HashedDestinationDirectory Set this parameter to True to use sub-directories within Collect Destination directory. The collect destination is a location on the filesystem specified by the destination parameter to the Collect fetch action: /action=fetch&fetchaction=collect&identifiers=<...>&destination=\\ foo\bar
Type: Boolean
Default: False
Required: No
Configuration Connector Section:
Example: HashedDestinationDirectory=True See Also: “TempDirectory” on page 139
• • • Documentum Connector CFS Administration Guide • 135 • • Chapter 7 Parameters Common to CFS Connectors
HashedTempDirectory Set this parameter to True to use sub-directories within TempDirectory.
Type: Boolean
Default: False
Required: No
Configuration Connector Section:
Example: HashedTempDirectory=True See Also: “TempDirectory” on page 139
InsertActions Use this parameter to perform some actions on each document before insertion. Each action is in the form: ‘ACTIONNAME:ACTIONPARAMETERS’ Possible actions are:
Action Parameters Example
META field=value IngestActions=META:MyField=MyValue
LUA lua_script_filename IngestActions=LUA:myLuaScript.lua
Type: String
Default:
Required: No
Configuration Connector Section:
Example: InsertActions=META:MyField=MyValue See Also:
• • • 136 • Documentum Connector CFS Administration Guide • • General Connector Parameters
InsertFailedDirectory Use this parameter to specify the directory where failed insert commands are written.
Type: String
Default: ./insertfailed
Required: No
Configuration Connector Section:
Example: InsertFailedDirectory=./insertfailed See Also:
SynchronizeKeepDatastore When this parameter is set to True, a datastore file (.db) will remain on the disk after a synchronize action has been performed. When the synchronize action is next performed, this file will be checked by the connector so that it can index only documents that have changed since the last synchronize and can delete documents that have been deleted since the last synchronize.
If this parameter is set to False, the datastore file is deleted at the end of each synchronize action. The next synchronize action will fetch all documents and will not delete old documents.
Type: Boolean
Default: True
Required: No
Configuration Connector Section:
Example: SynchronizeKeepDatastore=False See Also:
SynchronizeThreads Use this parameter to specify the number of threads to use for synchronization if the connector supports multi-threading. This parameter will not have an effect if the connector does not support multi-threading.
• • • Documentum Connector CFS Administration Guide • 137 • • Chapter 7 Parameters Common to CFS Connectors
In cases where this method is not supported by the connector, multiple tasks can be executed using the alternative TaskThreads setting.
Type: Integer
Default: 5
Required: No
Configuration Connector Section:
Example: SynchronizeThreads=4 See Also:
TaskMaxAdds Use this parameter to specify the maximum number of Adds to be processed by the task. The value 0 indicates an infinite number.
Type: Integer
Default: 0
Required: No
Configuration TaskName Section:
Example: TaskMaxAdds=0 See Also:
TaskMaxDuration Use this parameter to specify the maximum duration of the task in the format H[H][:MM][:SS].
Type: String
Default:
Required: No
Configuration TaskName Section:
Example: TaskMaxDuration=12:30:00 See Also:
• • • 138 • Documentum Connector CFS Administration Guide • • General Connector Parameters
TaskThreads Use this parameter to specify the number of simultaneous tasks that can be performed for an action. Each action=fetch action results potentially in a number of tasks. Each task generally consists of performing a subset of the action using a particular configuration section. For example, a single synchronize action can actually mean performing a synchronize action for multiple configured tasks. For collect and other actions where identifiers are provided, the identifiers are tied to particular configuration sections, so the whole action can span across several configuration sections. Generally, a single task is for a particular configuration section. Each would be processed on a separate thread.
Type: Integer
Default: 1
Required: No
Configuration Connector Section:
Example: TaskThreads=1 See Also:
TempDirectory Use this parameter to specify the directory used to store temporary documents and files.
Type: String
Default: ./temp
Required: No
Configuration Connector Section:
Example: TempDirectory=./TempFiles See Also:
• • • Documentum Connector CFS Administration Guide • 139 • • Chapter 7 Parameters Common to CFS Connectors
XsltDLL Use this parameter to specify the location of the autnxslt library.
Type: String
Default: autnxslt.dll (if present)
Required: No
Configuration Connector Section:
Example: XsltDLL=autnxslt.dll See Also:
Fetch Task Configuration
Each action the connector performs consists of one or more tasks. Each task is associated with a section in the configuration file. The section to use is either specified in an action parameter or encoded in each document identifier supplied to the action. The parameters below let you specify a numbered list of tasks. This is the set of tasks that will be performed when the connector performs a synchronize action whose parameters do not specify which tasks should be performed. The connector will also run synchronize actions for these tasks automatically according to the configured schedules.
IngestConfigSection Use this parameter to specify to read ingest settings from an alternative configuration section in preference.
Type: String
Default: task name
Required: No
Configuration TaskName or FetchTasks or Connector Section:
Example: IngestConfigSection=MyTask1 See Also:
• • • 140 • Documentum Connector CFS Administration Guide • • Fetch Task Configuration
N Use this parameter to specify the name of the task section containing the parameters for the synchronize task to be performed. The task will only be performed if N is less than Number and greater than or equal to 0.
Type: String
Default:
Required: No
Configuration FetchTasks or Connector Section:
Example: Number=2 0=Task1 1=Task2 See Also: “Number” on page 141
Number The connector will schedule the tasks with the names specified by the numbered parameters 0 through Number -1. Numbers may be missing from the sequence. An alternative configuration method is to give the Number parameter the default value of -1. In this case, the tasks configured from 0 until the first missing parameter are used.
For example, this configuration executes Task0 and Task2: [FetchTasks] Number=3 0=Task0 2=Task2 This executes only Task0: [FetchTasks] 0=Task0 2=Task2
Type: Integer
Default: -1
Required: No
• • • Documentum Connector CFS Administration Guide • 141 • • Chapter 7 Parameters Common to CFS Connectors
Configuration FetchTasks or Connector Section:
Example: Number=2 0=Task1 1=Task2 See Also: “N” on page 141
ScheduleCycles Use this parameter to specify the number of scheduled synchronize actions to perform.
The value -1 specifies to repeat forever. The value 0 specifies to perform the task once. Any other positive value specifies the number of times to perform the task. This parameter has an effect only if the EnableScheduledTasks parameter is set to True.
Type: Integer
Default: -1
Required: No
Configuration TaskName or FetchTasks or Connector Section:
Example: ScheduleCycles=3 See Also: “EnableScheduledTasks” on page 134
ScheduleRepeatSecs Use this parameter to specify the interval (in seconds) between scheduled synchronize actions. This parameter has an effect only if the EnableScheduledTasks parameter is set to True.
Type: Integer
Default: 86400
Required: No
Configuration TaskName or FetchTasks or Connector Section:
Example: ScheduleRepeatSecs=3600 See Also: “EnableScheduledTasks” on page 134
• • • 142 • Documentum Connector CFS Administration Guide • • Ingestion
ScheduleStartTime Use this parameter to specify the start time of the first scheduled synchronize action in the format H[H][:MM][:SS]. This parameter has an effect only if the EnableScheduledTasks parameter is set to True.
Type: String
Default:
Required: No
Configuration TaskName or FetchTasks or Connector Section:
Example: ScheduleStartTime=14:30:00 See Also: “EnableScheduledTasks” on page 134
Ingestion
The parameters in this section specify where the documents fetched by the synchronize action should be sent.
EnableIngestion Set this parameter to True if documents fetched by the synchronize action should be sent to the CFS or to another connector.
Type: Boolean
Default: True
Required: No
Configuration TaskName or Ingestion or Connector Section:
Example: EnableIngestion=False See Also:
• • • Documentum Connector CFS Administration Guide • 143 • • Chapter 7 Parameters Common to CFS Connectors
IndexDatabase Use this parameter to specify the value assigned to the DREDBNAME field for all documents.
Type: String
Default:
Required: No
Configuration TaskName or Ingestion Section:
Example: IndexDatabase=News See Also:
IngestActions The actions specified in this CSV will be performed on each document before it is sent to the CFS. Each action is in the form: ‘ACTIONNAME:ACTIONPARAMETERS’ Possible actions are:
Action Parameters Example
META field=value IngestActions=META:MyField=MyValue
LUA lua_script_filename IngestActions=LUA:myLuaScript.lua
Type: String
Default:
Required: No
Configuration TaskName or Ingestion Section:
Example: IngestActions=META:MyField=MyValue See Also:
Related Topics “Use Lua Scripts” on page 65
• • • 144 • Documentum Connector CFS Administration Guide • • Ingestion
IngestAddAsUpdate If you set this parameter to True, Add commands are treated as Updates for full metadata updating.
Type: Boolean
Default: False
Required: No
Configuration TaskName or Ingestion Section:
Example: IngestAddAsUpdate=False See Also:
IngestBatchSize Use this parameter to specify the number of documents that are sent to the CFS in a single batch.
This parameter has an effect only if the EnableIngestion parameter is set to True.
Type: Integer
Default: 100
Required: No
Configuration TaskName or Ingestion Section:
Example: IngestBatchSize=200 See Also: “EnableIngestion” on page 143
IngestCheckFinished If the IngesterType parameter is set to CFS, setting the IngestCheckFinished parameter to True will cause the connector to wait until documents have been added to the import queue before returning success. If sending to another connector, this connector will wait until the action completes. More specifically, the task is held in a queue, and each time the connector attempts to send more data to the destination connector, it will check the status of the previous actions sent and will only mark those tasks as complete once the status returns Finished.
• • • Documentum Connector CFS Administration Guide • 145 • • Chapter 7 Parameters Common to CFS Connectors
This parameter has an effect only if the EnableIngestion parameter is set to True.
Type: Boolean
Default: False
Required: No
Configuration TaskName or Ingestion Section:
Example: IngestCheckFinished=True See Also: “EnableIngestion” on page 143 “IngesterType” on page 149
IngestConnectorConfigSection Use this parameter to specify the section to use for the destination connector. This is specifically for when IngesterType=Connector Normally when a document is sent to another connector for insertion, the destination connector must use the same configuration section name (as the source connector task name) for any settings required for the insertion of the document. This setting allows the default config section for the task to be overridden. So Connector1 performs task Task1 that retrieves a document. Connector2 would normally be forced to configure the insertion task from the Task1 section of it's own config file. This setting allows it to be changed to a different section specifically for the insertion.
Type: String
Default: IngestConfigSection
Required: No
Configuration TaskName or Ingestion Section:
Example: IngestConnectorConfigSection=IngestConfigSection See Also: “IngesterType” on page 149
• • • 146 • Documentum Connector CFS Administration Guide • • Ingestion
IngestDataPort Use this parameter to specify the DataPort number of the destination server.
This parameter has an effect only if the EnableIngestion parameter is set to True.
Type: Integer
Default:
Required: No
Configuration TaskName or Ingestion Section:
Example: IngestDataPort=7051 See Also: “EnableIngestion” on page 143
IngestDelayMS Use this parameter to specify the number of milliseconds to pause between adding individual documents to the ingest queue.
Type: Integer
Default: 0
Required: No
Configuration Ingestion or TaskName Section:
Example: IngestDelayMS=0 See Also:
IngestEnableAdds Use this parameter to specify whether or not Add commands should be sent.
Type: Boolean
Default: True
Required: No
• • • Documentum Connector CFS Administration Guide • 147 • • Chapter 7 Parameters Common to CFS Connectors
Configuration Ingestion or TaskName Section:
Example: IngestEnableAdds=True See Also:
IngestEnableDeletes Use this parameter to specify whether or not Delete commands should be sent.
Type: Boolean
Default: True
Required: No
Configuration Ingestion or TaskName Section:
Example: IngestEnableDeletes=True See Also:
IngestEnableUpdates Use this parameter to specify whether or not Update commands should be sent.
Type: Boolean
Default: True
Required: No
Configuration Ingestion or TaskName Section:
Example: IngestEnableUpdates=True See Also:
IngestHashedSharedPath Use this parameter to specify to use sub-directories within IngestSharedPath.
• • • 148 • Documentum Connector CFS Administration Guide • • Ingestion
Type: String
Default: HashedTempDirectory
Required: No
Configuration TaskName or Ingestion Section:
Example: IngestHashedSharedPath=HashedTempDirectory See Also: “IngestSharedPath” on page 151
IngesterType Use this parameter to specify the type of ingestion process. The only allowed values are CFS, AsyncPiranha (alias for CFS), Connector, and ConnectorInsert (alias for Connector). If this parameter is set to CFS, the IngestHost and IngestPort parameters point to a Connector Framework Server (CFS) (which can be used to import the documents and index them).
If this parameter is set to Connector, the IngestHost and IngestPort parameters point to another connector. Documents fetched from this repository by the synchronize action will be inserted into another repository using the connector specified. If this option is used, you will probably need to use the IngestActions parameter to convert the document into a form that can be handled by the other connector.
Note that the synchronize action can result in Add, Update and Delete ingest commands. Adds result in insert actions, Updates result in update actions, and Deletes result in delete actions being sent to the destination connector. This parameter has an effect only if the EnableIngestion parameter is set to True.
Type: String
Default: AsyncPiranha
Required: No
• • • Documentum Connector CFS Administration Guide • 149 • • Chapter 7 Parameters Common to CFS Connectors
Configuration TaskName or Ingestion Section:
Example: IngesterType=AsyncPiranha See Also: “EnableIngestion” on page 143 “IngestActions” on page 144 “IngestHost” on page 150 “IngestPort” on page 151
IngestHost Use this parameter to specify the hostname or IP address of the destination server.
This parameter has an effect only if the EnableIngestion parameter is set to True.
Type: String
Default: localhost
Required: No
Configuration TaskName or Ingestion Section:
Example: IngestHost=localhost See Also: “EnableIngestion” on page 143
IngestKeepFiles If this parameter is set to True, downloaded documents will not be deleted after they have been ingested.
Type: Boolean
Default: False
Required: No
Configuration TaskName or Ingestion Section:
Example: IngestKeepFiles=True See Also: “EnableIngestion” on page 143
• • • 150 • Documentum Connector CFS Administration Guide • • Ingestion
IngestPort Use this parameter to specify the port number of the destination server.
This parameter has an effect only if the EnableIngestion parameter is set to True.
Type: Integer
Default: 7000
Required: No
Configuration TaskName or Ingestion Section:
Example: IngestPort=7050 See Also: “EnableIngestion” on page 143
IngestSendByType Use this parameter to specify whether or not to send Add, Update, and Delete commands separately.
Type: Boolean
Default: False
Required: No
Configuration TaskName or Ingestion Section:
Example: IngestSendByType=False See Also:
IngestSharedPath Use this parameter to specify the location to which documents are saved before ingestion. This should be a path accessible by both the connector and the ingest server.
Type: String
Default: The value of the TempDirectory parameter.
Required: No
• • • Documentum Connector CFS Administration Guide • 151 • • Chapter 7 Parameters Common to CFS Connectors
Configuration TaskName or Ingestion Section:
Example: IngestSharedPath=./TempDirectory See Also: “EnableIngestion” on page 143
IngestSSLConfig Use this parameter to specify the configuration file section containing the SSL settings that should be used when communicating with the CFS. For more information on the contents of this section, refer to “Secure Socket Layer Parameters” on page 223.
Type: String
Default:
Required: No
Configuration TaskName or Ingestion Section:
Example: IngestSSLConfig=SSLSettings See Also: “EnableIngestion” on page 143
IngestWriteIDX If the IngestKeepFiles parameter is set to True, setting the IngestWr iteIDX parameter to True causes the connector to write document metadata in a stub IDX file alongside the document.
Type: Boolean
Default: False
Required: No
Configuration TaskName or Ingestion Section:
Example: IngestWriteIDX=False See Also: “EnableIngestion” on page 143
• • • 152 • Documentum Connector CFS Administration Guide • • GroupServer
GroupServer
The parameters in this section are used when performing an update to an instance of OmniGroupServer using the SynchronizeGroups fetch action.
GroupServerHost Use this parameter to specify the host name or IP address of the group server.
Type: String
Default: localhost
Required: Yes
Configuration TaskName or GroupServer Section:
Example: GroupServerHost=localhost See Also:
GroupServerPort Use this parameter to specify the port number of the group server.
Type: Integer
Default: 3057
Required: Yes
Configuration TaskName or GroupServer Section:
Example: GroupServerPort=3057 See Also:
• • • Documentum Connector CFS Administration Guide • 153 • • Chapter 7 Parameters Common to CFS Connectors
GroupServerRepository Use this parameter to specify the group server repository name. This is the name of any repository section in an OmniGroupServer configuration file. It is named based on the name of the repository the connector is retrieving from.
Type: String
Default:
Required: Yes
Configuration TaskName or GroupServer Section:
Example: GroupServerRepository=RepositoryGroups See Also:
GroupServerSSLConfig Use this parameter to specify the section containing SSL settings for the group server.
Type: String
Default:
Required:
Configuration TaskName or GroupServer Section:
Example: GroupServerSSLConfig=SSLConfig1 See Also:
Related Topics “Synchronize Groups Fetch Action” on page 164
• • • 154 • Documentum Connector CFS Administration Guide • • CHAPTER 8 Parameters Common to CFS Connectors Using Java
This chapter describes the parameters that specify details related to the CFS connectors’ Java files. These parameters are found in the [Connector] section.
JavaClassPath Specify the class path to use, including all dependencies of the connector. This must include the class specified by the JavaConnectorClass parameter. The Java class path must point to all the jar files found in the lib directory when installed. This must include the JavaConnector.jar and will usually include one other connector jar (ConnectorName.jar) file plus any number of dependencies and properties files or other resources required by the libraries. For the Documentum Connector CFS, this requires only: JavaConnector.jar
DocumentumConnector.jar
dctm.jar (found in the DFC installation directory)
If the connector is run through Java directly (using the ConnectorLibJava library), the CLASSPATH should be set on the command line. For example:
java -classpath
• • • Documentum Connector CFS Administration Guide • 155 • • Chapter 8 Parameters Common to CFS Connectors Using Java
Type: String
Default: None
Required: Yes
Configuration Connector Section:
Example: JavaClasspath=./lib/javaConnector.jar;./lib/ MyConnector.jar
or
JavaClassPath0=./lib/JavaConnector.jar JavaClassPath1=./lib/MyConnector.jar See Also: “JavaConnectorClass” on page 156
JavaConnectorClass Specify the full class name of the Java class that contains the implementation of the connector. Package separators can be either slash (/) or dot (.).
For Documentum Connector CFS, this is com/autonomy/connector/ documentum/DocumentumConnector.
Type: String
Default: None
Required: Yes
Configuration Connector Section:
Example: JavaConnectorClass=com.autonomy.connector.example .FileSystemConnector
See Also: “JavaClassPath” on page 155
JavaLibraryPath Set this parameter to the location of any additional native libraries required by and of the connector classes or dependencies. For Documentum Connector CFS, this should usually be set to DFC_Install_Dir/Shared.
• • • 156 • Documentum Connector CFS Administration Guide • • Type: String
Default: ““
Required: No
Configuration Connector Section:
Example: JavaLibraryPath=./lib See Also: “JavaClassPath” on page 155
JavaMaxMemoryMB Set this parameter to the maximum memory (in megabytes) to be allocated to the Java virtual machine.
Type: Integer
Default: 64
Required: No
Configuration Connector Section:
Example: JavaMaxMemoryMB=256 See Also: “JavaClassPath” on page 155
JVMLibraryPath Use this parameter to specify the location of the jvm library (for example, jvm.dll or libjvm.so). The connector will look for the library in various locations specified by the following: JVMLibraryPath parameter Location set in the Windows registry
JAVA_HOME environment variable System library path (PATH, LD_LIBRARY_PATH, and so forth)
• • • Documentum Connector CFS Administration Guide • 157 • • Chapter 8 Parameters Common to CFS Connectors Using Java
Type: String
Default: None
Required: No, however, the connector will not start if the jvm library cannot be found or loaded.
Configuration Connector Section:
Example: JVMLibraryPath=./jre/bin/client See Also:
JavaVerboseGC Set this parameter to True to enable verbose garbage collection (for debugging purposes only).
Type: Boolean
Default: False
Required: No
Configuration Connector Section:
Example: JavaVerboseGC=False See Also:
• • • 158 • Documentum Connector CFS Administration Guide • • CHAPTER 9 CFS Connector Actions
CFS connectors may provide one or more of the ACI actions described here. Not all connectors support all the actions. The sample HTTP requests in this section are split across multiple lines for readability. When using these requests, the whole request should be on one line and contain no spaces. Brackets ([]) enclosing a parameter indicate that the parameter is optional.
Synchronous Versus Asynchronous Actions
QueueInfo Action
Synchronize Fetch Action
Synchronize Groups Fetch Action
Collect Fetch Action
Identifiers Fetch Action
Insert Fetch Action
Delete/Remove Fetch Action
Hold and ReleaseHold Fetch Actions
Update Action
View Action
StopFetch Action
• • • Documentum Connector CFS Administration Guide • 159 • • Chapter 9 CFS Connector Actions
Synchronous Versus Asynchronous Actions
Some of the actions described here are synchronous and others are asynchronous. The connector does not respond to a synchronous action until it has completed the request. The result of the action is in the response to the request. An asynchronous action responds immediately; the request is added to a queue of actions to be performed. The response to the request contains a token. You can use this token to determine whether the request has finished and the results of the action. You can do this using the QueueInfo action.
Example http://localhost:1234/action=Fetch&FetchAction=Synchronize
Response
QueueInfo Action
The QueueInfo action provides information about the asynchronous actions the connector is processing or has processed. Use this action to determine whether a task has completed and the results of the task. http://host:port/action=QueueInfo &QueueName=QueueName &QueueAction=QueueAction [&Token=Token]
• • • 160 • Documentum Connector CFS Administration Guide • • QueueInfo Action
Type: Synchronous
Parameter Name Description
QueueName The name of the queue you wish to retrieve information about. There is one queue per asynchronous action. Most of the connector’s functionality is accessed through action=Fetch, so usually you should specify Fetch.
QueueAction The action you wish to perform on the queue. Possible actions are: GetStatus. The response provides information about the action currently on the queue.
Token This restricts the response to information about the action identified by the token.
Example
http://localhost:1234/ action=QueueInfo&QueueName=Fetch&QueueAction=GetStatus
Response A sample response appears below. Each action in the queue appears between
• • • Documentum Connector CFS Administration Guide • 161 • • Chapter 9 CFS Connector Actions
Synchronize Fetch Action
This action is used to search a repository for document updates and send these updates to an Ingestion module. http://host:port/action=Fetch&FetchAction=Synchronize [&Config=Base64_Config] [&TaskSections=Section_CSV] [&IngestActions=Document_Action_CSV]
Type: Asynchronous
Parameter Name Description
Config Optional Base64 encoded configuration file. If this parameter is specified, then the encoded configuration options is used instead of the options in the connector configuration file.
TaskSections The names of the task sections to use to perform synchronization. If this parameter is unspecified, all configured task sections are used.
• • • 162 • Documentum Connector CFS Administration Guide • • Synchronize Fetch Action
Parameter Name Description
IngestActions This parameter specifies actions to perform on documents prior to being ingested. This can be a list of document actions of the form action:parameters processed from left to right. The available documents actions are: META. Add a custom field to the document, specified as META:Fieldname=FieldValue LUA. Execute a Lua script on the document, specified as LUA:Luascript.
Example: To add a field CATEGORY=FILESYSTEM to every document, specify the ingest action as: IngestActions=META:CATEGORY=FILESYSTEM Any commas in the action parameters should be escaped with a backslash (\).
Example http://host:port/action=Fetch&FetchAction=Synchronize
Response A sample response appears below. In this example, two tasks were performed as part of the synchronize (DIR1 and DIR2). Both of these found 10 new documents, but ingestion failed for all 20 documents.
• • • Documentum Connector CFS Administration Guide • 163 • • Chapter 9 CFS Connector Actions
Synchronize Groups Fetch Action
This action is used to search a repository for document updates and send these updates to an Ingestion module. http://host:port/action=Fetch&FetchAction=SynchronizeGroups [&Config=Base64_Config] [&TaskSections=Section_CSV]
Type: Asynchronous
Parameter Name Description
Config Optional Base64 encoded configuration file. If this parameter is specified, then the encoded configuration options is used instead of the options in the connector configuration file.
TaskSections The names of the task sections to use to perform synchronization. If this parameter is unspecified, all configured task sections are used. The sections should include the GroupServerHost and GroupServerPort parameters as a minimum in addition to any connector-specifc parameters.
Example http://host:port/action=Fetch&FetchAction=SynchronizeGroups
Response A sample response appears below. In this example, two tasks were performed as part of the synchronize groups (GROUPS1 and GROUPS2).
• • • 164 • Documentum Connector CFS Administration Guide • • Collect Fetch Action
Collect Fetch Action
This action is used to retrieve documents and metadata by their Identifiers from a repository and send the documents to be ingested to a specified location. http://host:port/action=Fetch&FetchAction=Collect [&Config=Base64_Config] [&Identifiers=Identifier_CSV] [&IdentifiersXML=Identifier_XML] [&Collectactions=Document_Action_CSV] [&Destination=UNC_Path]
Type: Asynchronous
Parameter Name Description
Config Optional Base64 encoded configuration file. If this parameter is specified, then the encoded configuration options are used instead of the options in the connector configuration file.
failedDirectory The directory in which the action will report failures.
Identifiers A CSV of the identifiers of the documents to be collected.
• • • Documentum Connector CFS Administration Guide • 165 • • Chapter 9 CFS Connector Actions
Parameter Name Description
IdentifiersXML This parameter can be specified in addition to the Identifiers parameter and specifies additional identifiers to collect along with a set of custom metadata to be associated with each collected document. This data should be provided in XML format as below:
Destination Output destination as UNC Path. If this is blank, the documents are added to the ingest queue. The parameter can use fields from the document or identifier to construct the resulting destination for each document. To add a document field value as part of the destination, use the tag
• • • 166 • Documentum Connector CFS Administration Guide • • Collect Fetch Action
Parameter Name Description
CollectActions This parameter specifies actions to perform on documents prior to transferring them to their destination. This can be a list of document actions of the form action:parameters processed from left to right. The available document actions are: META. Add a custom field to the document, specified as META:Fieldname=FieldValue ZIP. Add the document to a zip file, specified as ZIP:Filename[:Password] LUA. Execute a Lua script on the document, specified as LUA:Luascript.
Example: To add a field CATEGORY=FILESYSTEM to every document, zip all documents with a password and add a field COLLECTTIME=1234567890 to the zip, specify the collect action as: CollectActions=META:CATEGORY=FILESYSTEM,ZIP:Output.zi p:password,META:COLLECTTIME=1234567890 Any commas in the action parameters should be escaped with a ‘\’.
Example http://localhost:1234/ action=Fetch&FetchAction=Collect&Identifiers=PGlkIHM9IkRJUjEiIHI9I kM6XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZWN0b3JDRlNcZGlyMVxmaWxlOS50eHQ iLz4%3D,PGlkIHM9IkRJUjEiIHI9IkM6XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZW N0b3JDRlNcZGlyMVxmaWxlOC50eHQiLz4%3D&Destination=C:\Autonomy\ collected
Response As this is an asynchronous action, you receive a token in response to the request. A sample response to the action (as retrieved using the QueueInfo action) appears below.
In this example the tokens for both documents appear between
• • • Documentum Connector CFS Administration Guide • 167 • • Chapter 9 CFS Connector Actions
“Synchronize Fetch Action” on page 162
Identifiers Fetch Action
This action is used to retrieve a list of document identifiers and optionally perform an action on them (currently only the collect action is available). It should not be used to perform queries that could be more efficiently performed through IDOL Server.
http://host:port/action=Fetch&FetchAction=Identifiers [&Config=Base64_Config] &ConfigSection=Section_Name [&Identifiersaction=Collect &Destination=UNC_Path [&CollectActions=Document_Action_CSV] [&Connector-specific_Parameters]
• • • 168 • Documentum Connector CFS Administration Guide • • Identifiers Fetch Action
Type: Asynchronous
Parameter Name Description
Config Optional Base64 encoded configuration file. If this parameter is specified, then the encoded configuration options is used instead of the options in the connector configuration file.
ConfigSection The name of the configuration file section containing the task settings.
IdentifiersAction The name of the action to perform on the returned identifiers. If this action should be passed additional parameters, you should specify them as parameters to this action.
Connector-specific_ Additional parameters that are connector-specific and Parameters determine which identifiers to return.
Example http://localhost:1234/ action=Fetch&FetchAction=Identifiers&ConfigSection=DIR1
Response As this is an asynchronous action, you receive a token in response to the request. A sample response to the action (as retrieved using the QueueInfo action) appears below. This shows that the action has completed. The identifiers are listed in between the
• • • Documentum Connector CFS Administration Guide • 169 • • Chapter 9 CFS Connector Actions
Related Topics “Synchronize Fetch Action” on page 162
Insert Fetch Action
This action is used to insert a document or documents into a repository. http://host:port/action=Fetch&FetchAction=Insert [&Config=Base64_Config] &ConfigSection=Section_Name &InsertXML=Insert_XML
Type: Asynchronous
Parameter Name Description
Config Optional Base64 encoded configuration file. If this parameter is specified, then the encoded configuration options is used instead of the options in the connector configuration file.
• • • 170 • Documentum Connector CFS Administration Guide • • Insert Fetch Action
Parameter Name Description
ConfigSection The name of the configuration file section containing the task settings. failedDirectory The directory in which the action will report failures.
InsertXML XML containing all the properties to determine how and where to add each document, all the metadata, and optionally, a file to insert for each document. Some connectors expect a file to be provided. The data should be provided in XML format as below:
Example In this example, the object is to insert a file with the reference C:\Autonomy\ FileSystemConnectorCFS\dir1\newfile.txt with the content This is my file. First, construct the InsertXML:
• • • Documentum Connector CFS Administration Guide • 171 • • Chapter 9 CFS Connector Actions
http://localhost:1234/ action=Fetch&FetchAction=Insert&ConfigSection=DIR1&InsertXML=%3Cin sertXML%3E%3Cinsert%3E%3Creference%3EC%3A%5CAutonomy%5CFileSystemC onnectorCFS%5Cdir1%5Cnewfile.txt%3C%2Freference%3E%3Cfile%3E%3Cisf ilename%3Efalse%3C%2Fisfilename%3E%3Ccontent%3EVGhpcyBpcyBteSBmaWx l%3C%2Fcontent%3E%3C%2Ffile%3E%3C%2Finsert%3E%3C%2FinsertXML%3E
Response As this is an asynchronous action, you receive a token in response to the request. A sample response to the action (as retrieved using the queueinfo action) appears below. This action shows that the action has completed and that one document has been inserted, and gives the identifier of the new document.
• • • 172 • Documentum Connector CFS Administration Guide • • Delete/Remove Fetch Action
Related Topics “Synchronize Fetch Action” on page 162
Delete/Remove Fetch Action
This action is used to delete documents from a repository by their identifiers. Remove and delete are different names for the same action.
http://host:port/action=Fetch&FetchAction=Delete [&Config=Base64_Config] &Identifiers=Identifier_CSV http://host:port/action=Fetch&FetchAction=Remove [&Config=Base64_Config] &Identifiers=Identifier_CSV
Type: Asynchronous
Parameter Name Description
Config Optional Base64 encoded configuration file. If this parameter is specified, then the encoded configuration options is used instead of the options in the connector configuration file.
Identifiers A CSV of document Identifiers. The documents with these identifiers are removed from the repository.
Example http://localhost:1234/ action=Fetch&FetchAction=Delete&Identifiers=PGlkIHM9IkRJUjEiIHI9Ik M6XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZWN0b3JDRlNcZGlyMVxuZXdmaWxlLnR4 dCIvPg%3D%3D
Response As this is an asynchronous action, you receive a token in response to the request. A sample response to the action (as retrieved using the QueueInfo action) appears below. This response shows that one document was deleted successfully. • • • Documentum Connector CFS Administration Guide • 173 • • Chapter 9 CFS Connector Actions errors="0" holds="0" ingestadded="0" ingestdeleted="0" ingestfailed="0" ingestupdated="0" inserted="0" releasedholds="0" seen="0" task="DIR1" unchanged="0" updated="0"/>
Related Topics “Synchronize Fetch Action” on page 162
Hold and ReleaseHold Fetch Actions
The Hold action places a hold on a document or documents in the repository by their identifier. When a document has been placed on hold, it cannot be deleted by a regular user.
The ReleaseHold action releases a document that has been placed on hold. http://host:port/action=Fetch&FetchAction=Hold [&Config=Base64_Config] &Identifiers=Identifier_CSV http://host:port/action=Fetch&FetchAction=ReleaseHold [&Config=Base64_Config] &Identifiers=Identifier_CSV
• • • 174 • Documentum Connector CFS Administration Guide • • Hold and ReleaseHold Fetch Actions
Type: Asynchronous
Parameter Name Description
Config Optional Base64 encoded configuration file. If this parameter is specified, then the encoded configuration options is used instead of the options in the connector configuration file.
Identifiers A CSV of document Identifiers. The documents with these identifiers is placed on hold or released from hold depending on whether you used the Hold or Release Hold action.
Example http://localhost:1234/ action=Fetch&FetchAction=Hold&Identifiers=PGlkIHM9IkRJUjEiIHI9IkM6 XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZWN0b3JDRlNcZGlyMVxuZXdmaWxlLnR4dC IvPg%3D%3D
Response As this is an asynchronous action, you receive a token in response to the request. A sample response to the action (as retrieved using the queueinfo action) appears below. This response shows that one document was successfully put on hold.
• • • Documentum Connector CFS Administration Guide • 175 • • Chapter 9 CFS Connector Actions
“Synchronize Fetch Action” on page 162
Update Action
The Update action updates metadata for documents given by their identifier in a repository.
Request /action=fetch&fetchaction=Update [&parenttoken=
IdentifiersXML The IdentifiersXML parameter specifies identifiers that require metadata updates along with a set of the metadata to be updated for each document. The data should be provided in XML format as below:
Asynchronous Response
• • • 176 • Documentum Connector CFS Administration Guide • • View Action
Related Topics “Synchronize Fetch Action” on page 162
View Action
The View action retrieves a single document and returns it. http://host:port/action=View [&Config=
Type: Synchronous
Parameter Name Description
Config Optional Base64 encoded configuration file. If this parameter is specified, then the encoded configuration options is used instead of the options in the connector configuration file.
NoACI Specify whether to return the document using a normal ACI response with a Base64 encoded file tag (false), or just return binary content (true). This defaults to true.
Identifiers The identifier of the document to be returned.
Example http://localhost:1234/ action=View&Identifier=PGlkIHM9IkRJUjEiIHI9IkM6XEF1dG9ub215XEZpbGV TeXN0ZW1Db25uZWN0b3JDRlNcZGlyMVxmaWxlOC50eHQiLz4%3D
Response The response is the binary content of the file, unless you have specified NoACI=false.
Related Topics “EnableViewServer” on page 130
• • • Documentum Connector CFS Administration Guide • 177 • • Chapter 9 CFS Connector Actions
StopFetch Action
This action requests all active asynchronous fetch actions or a particular asynchronous fetch action to stop.
http://host:port/action=StopFetch [&Token=Fetch_Action_Token]
Type: Synchronous
Parameter Name Description
Token The token of the asynchronous Fetch action to request to stop. If this is not specified, then the connector requests all asynchronous fetch actions to stop. Doing so does not clear the action queue.
Example http://localhost:1234/action=StopFetch
Response
• • • 178 • Documentum Connector CFS Administration Guide • • CHAPTER 10 Connector Framework Server Parameters
This chapter describes the Connector Framework server (CFS) configuration parameters.
Service Parameters
Server Parameters
Actions Parameters
Import Tasks and their Parameters
Import Service Parameters
Indexing Parameters Connector Framework server supports standard service parameters, logging parameters and log streams. For more information, see the IDOL Server Administration Guide. This section lists the Connector Framework server configuration parameters.
• • • Documentum Connector CFS Administration Guide • 179 • • Chapter 10 Connector Framework Server Parameters
Service Parameters
The parameters in this section determine which machines are permitted to use and control the Connector Framework service.
Related Topics Service Configuration Parameters
Server Parameters
The parameters in this section specify details for the Connector Framework server.
AdminClients Specify the IP addresses or names of clients that can issue administrative commands to the ACI Port. To enter multiple addresses, separate the individual addresses with commas (there must be no space before or after the comma). Alternatively, you can use wildcards in the IP address. Enter for example 187.*.*.* to permit any machine whose IP address begins with 187 to control the connector.
Type: String
Default: *.*.*.*
Required: No
Configuration Server Section:
Example: AdminClients=localhost,196.172.87.11 See Also: “Port” on page 181 “QueryClients” on page 181
• • • 180 • Documentum Connector CFS Administration Guide • • Server Parameters
Port Specify the ACI port by which actions are sent to the Connector Framework server.
Type: Long
Default:
Required: Yes
Allowed Minimum: 0 Range: Maximum: 65535
Recommended Minimum: 1024 Range: Maximum: 49151
Configuration Server Section:
Example: Port=7008 See Also:
QueryClients Specify the IP addresses or names of clients that can query the connector. To enter multiple addresses, separate the individual addresses with commas (there must be no space before or after the comma). Alternatively, you can use wildcards in the IP address. Enter for example 187.*.*.* to permit any machine whose IP address begins with 187 to control the connector.
Type: String
Default: *.*.*.*
Required: No
Configuration Server Section:
Example: QueryClients=10.1.1.*,127.0.0.1 See Also: “Port” on page 181 “AdminClients” on page 180
• • • Documentum Connector CFS Administration Guide • 181 • • Chapter 10 Connector Framework Server Parameters
Actions Parameters
The parameters in this section control how actions are sent to Connector Framework server.
MaxQueueSize Use this parameter to specify the maximum number of asynchronous ingest action commands that will be queued by the server. No further ingest actions will be accepted once the queue size has been reached (until the queue diminishes).
Type: Integer
Default: The largest size possible.
Required: No
Configuration Actions Section:
Example: MaxQueueSize=4 See Also:
MaximumThreads Specify the number of actions that the CFS can process in parallel at any one time. The optimal value for this parameter is dependant on the load of the server. The default is generally sufficient for most loads.
Type: Integer
Default: 2
Required No
Configuration Actions Section:
Example: MaximumThreads=10
• • • 182 • Documentum Connector CFS Administration Guide • • Import Tasks and their Parameters
Import Tasks and their Parameters
The parameters in this section control the way documents are imported to IDX or XML before they are indexed into IDOL Server. These task types are Lua and IDXWriter. These task types are available for PreN, PostN, UpdateN and DeleteN.
PostN Identify a task to call after documents are imported but before they are indexed into IDOL Server. Tasks must be numbered starting from zero (0). You can specify a Lua script or the IDX Writer. The IDX Writer is included in the Connector Framework server and generates an IDX file. You must specify the task using the following format: PostN=TaskType:Path_to_Script or MyTaskSection where TaskType could be Lua to specify a Lua script, or IdxWriter to specify the CFS IDX Writer. Parameters that should be passed to the task can be specified in a corresponding configuration section. This is optional. For example:
Post0=IdxWriter:IdxWriting [IdxWriting] IdxWriterFilename=Job0.idx IdxWriterMaxSizeKBs=100 IdxWriterArchiveDirectory=./IDXArchive In this example, the Post0 task creates a backup IDX file (Job0.idx) in the IDXArchive directory using the IDX Writer.
Type: String
Default: None
Required No
Configuration ImportTasks Section:
Example: Post0=Lua:C:\Scripts\posttask1.lua See Also: “PreN” on page 184 “HashN” on page 184 “DeleteN” on page 185 “UpdateN” on page 185
• • • Documentum Connector CFS Administration Guide • 183 • • Chapter 10 Connector Framework Server Parameters
PreN Identify a task to call before documents are imported and indexed into IDOL Server. Tasks must be numbered starting from zero (0). You can specify a Lua script or the IDX Writer. The IDX Writer is included in the Connector Framework server and generates an IDX file. You must specify the task using the following format: PreN=TaskType:Path_to_Script or MyTaskSection where TaskType could be Lua to specify a Lua script, or IdxWriter to specify the CFS IDX Writer. Parameters that should be passed to the task can be specified in a corresponding configuration section. This is optional. For example: Post0=IdxWriter:IdxWriting [IdxWriting] IdxWriterFilename=Job0.idx IdxWriterMaxSizeKBs=100 IdxWriterArchiveDirectory=./IDXArchive In this example, the Pre0 task creates a backup IDX file (Job0.idx) in the IDXArchive directory using the IDX Writer.
Type: String
Default: None
Required: No
Configuration ImportTasks Section:
Example: Pre0=C:\Scripts\pretask1.lua See Also “PostN” on page 183 “HashN” on page 184 “DeleteN” on page 185 “UpdateN” on page 185
HashN Specify a file containing a Lua script to use for family hashing. The script inserts an MD5 field into the document, which is a hash of the document’s unique fields. In the example below, hash.lua should be (as this uses the file contents):
function handler(document) return false end
• • • 184 • Documentum Connector CFS Administration Guide • • Import Tasks and their Parameters
The hash is calculated from the whole document and it does not matter whether it is text or binary, the hash is calculated from the actual original imported file.
Type: String
Default: None
Required: No
Configuration ImportTasks Section:
Example: Hash0=hash.lua See Also “ImportHashFamilies” on page 189 “ImportFamilyRootExcludeFmtCSV” on page 188
DeleteN This index task appears in the [IndexTasks] section. Identify a task to call when CFS is about to delete a document from IDOL Server. Tasks must be numbered.
In the example below, Delete0 runs a Lua script when a document is about to be deleted.
Type: String
Default: None
Required: No
Configuration IndexTasks Section:
Example: Delete0=Lua:onDelete.lua See Also “PostN” on page 183 “PreN” on page 184 “HashN” on page 184 “UpdateN” on page 185
UpdateN This index task appears in the [IndexTasks] section. Identify a task to call when CFS is about to update fields in a document in IDOL Server. This is called when a connector updates the metadata for a document but not the content. Tasks must be numbered.
• • • Documentum Connector CFS Administration Guide • 185 • • Chapter 10 Connector Framework Server Parameters
In the example below, Update0 runs a Lua script when a document is about to be updated.
Type: String
Default: None
Required: No
Configuration IndexTasks Section:
Example: Update0=Lua:onUpdate.lua See Also “PostN” on page 183 “PreN” on page 184 “HashN” on page 184 “DeleteN” on page 185
Additional Task Types
The following task types are also available: ImportFile:fieldName Sectioner:sectionName ImportFile:fieldName imports the file specified in the field fieldName and adds its content to the document being processed.
Sectioner:sectionName is generally specified as a Post task. You can use it to split a large document into smaller sections. sectionName gives the name of the configuration file section containing the settings for the sectioner. If :sectionName is not specified , the [Sectioning] section is assumed. The following configuration settings control sectioning:
SectionerMaxBytes Use this parameter to specify the maximum number of bytes recommended for a section. This is not a hard limit, but the Sectioner will try to keep section sizes below this.
• • • 186 • Documentum Connector CFS Administration Guide • • Additional Task Types
Type: Integer
Default: 3000
Required No
Configuration The configured section or Sectioning Section:
Example: SectionerMaxBytes=3000
SectionerMinBytes Use this parameter to specify the minimum number of bytes recommended for a section. This is not a hard limit, but the Sectioner will try to keep section sizes above this.
Type: Integer
Default: SectionerMaxBytes/2
Required No
Configuration The configured section or Sectioning Section:
Example: SectionerMinBytes=1500
SectionerSeparatorsN Use this parameter to specify the fixed strings or regular expressions that can be used by the sectioner to identify a suitable location in the content for inserting a section break. For example, you may prefer content to split on paragraph breaks “%0A%0A”. If a large bit of content has no paragraph breaks, the Sectioner could then revert to splitting on punctuation. A separator string can either be specified as a fixed string or a regular expression. A separator is treated as a regular expression if it begins with an open parenthesis “(“ and ends with closed parenthesis “)”. Fixed strings and regular expressions specified in the configuration are URL unescaped before use; this allows you to specify multi-byte and special characters.
Each SectionerSeparatorsN is a CSV of possibly URL escaped separators. Separators in an earlier SectionSeparators list have priority over those later. Separators towards the left of a CSV have priority over those toward the right.
Backslashes in a regular expression should appear in the configuration as “\\”. Commas in separators should be URL escaped as “%2C” or escaped as “\,”.
• • • Documentum Connector CFS Administration Guide • 187 • • Chapter 10 Connector Framework Server Parameters
SectionSeparators 0, 1, and 2 are set by default if none are specified in the configuration. If any SectionerSeparators are specified in the configuration, the defaults no longer apply.
Type: String
Default: SectionerSeparators0=%0A%0A SectionerSeparators1=([!?.]\\s+),([:;]\\ s+),(%EF%BC%81|%EF%BC%9F|%E3%80%82|%EF%BC%8E|[! ?]),(%EF%BC%9A|%EF%BC%9B|[:;]) SectionerSeparators2=((%2C|%E3%80%81|%EF%BC%8C)\\ s*),((%E3%80%80|\\s)+)
Required No
Configuration The configured section or Sectioning Section:
Example: SectionerSeparators0=%0A%0A
Import Service Parameters
The parameters in this section specify details for KeyView and the service that imports documents into IDX or XML.
ExtractDirectory Specify the directory to which to files are extracted. Use this parameter only when you want to keep copies of all extracted files.
Type: String
Default: Current directory
Required No
Configuration ImportService Section:
Example: ExtractDirectory=C:\temp
ImportFamilyRootExcludeFmtCSV Specify which KeyView formats not to designate as family roots if family hashing is enabled. For example, if you exclude the PST format (KeyView value 356), when Import Module Advanced hashes a PST file, it does not consider PST
• • • 188 • Documentum Connector CFS Administration Guide • • Import Service Parameters
container as the root format. Instead, it searches for a deeper format that is not listed as a CSV: in this case, it would find the MAIL format, which would then be considered the root of the family. For a complete list of KeyView formats, see “KeyView Format Codes” on page 251.
Type: String
Default:
Required No
Configuration ImportService Section:
Example: ImportFamilyRootExcludeFmtCSV=356,157,233,345 In this example, the numeric values correspond to the following formats: 356=PST 157=ZIP 233=EML 345=MSG
See Also: “HashN” on page 184 “ImportHashFamilies” on page 189
ImportHashFamilies Specify whether to enable family hashing, which is used for de-duplication.
Type: Boolean
Default: false
Required No
Configuration ImportService Section:
Example: ImportHashFamilies=true See Also: “HashN” on page 184 “ImportFamilyRootExcludeFmtCSV” on page 188 “ImportMergeMails” on page 190
• • • Documentum Connector CFS Administration Guide • 189 • • Chapter 10 Connector Framework Server Parameters
ImportInheritFieldsCSV Specify a comma-separated list of fields that should be inherited from parent files by their children. For example, if you specify SUBJECT in this parameter, all the child attachments in a parent MSG file will contain a Subject field.
Type: String
Default: None
Required No
Configuration ImportService Section:
Example: ImportInheritFieldsCSV=AUTN_IDENTIFIER See Also:
ImportMergeMails Specify whether to merge the two files created by KeyView (the empty MSG or EML container file, and the MAIL file that contains the actual message content) when importing MSG or EML files. Set this to true to merge the two files.
Type: Boolean
Default: false
Required No. Recommended if ImportHashFamilies=true. Configuration ImportService Section:
Example: ImportMergeMails=true See Also: “ImportHashFamilies” on page 189
KeyviewDirectory Specify the location of the KeyView filters that Connector Framework Server uses to process documents. Enter the full path to the filters directory.
Type: String
Default: None
• • • 190 • Documentum Connector CFS Administration Guide • • Import Service Parameters
Required Yes
Configuration ImportService Section:
Example: KeyviewDirectory=C:\Autonomy\ConnectorFramework\ filters\
MaxImportQueueSize Specify the size of an internal queue where documents are buffered before they are imported.
NOTE It is recommended that this parameter not be changed without consultation with Autonomy support personnel.
Type: Integer
Default: Ten times the size specified by the IndexBatchSize parameter. Required No
Configuration ImportService or Server Section:
Example: MaxImportQueueSize=1000
RevisionMarks Specify whether revision mark information (such as deleted text) is extracted from Microsoft Word documents. If Microsoft Word’s revision tracking feature was enabled when changes were made to a document, the CFS can extract the tracked information and include it in the index. Set to true to extract revision mark information.
Type: Boolean
Default: false
Required No
Configuration ImportService Section:
Example: RevisionMarks=true
• • • Documentum Connector CFS Administration Guide • 191 • • Chapter 10 Connector Framework Server Parameters
ThreadCount Specify the number of threads to run. This parameter is only used for importing.
Type: Integer
Default: 1
Required No
Configuration ImportService Section:
Example: ThreadCount=3
XsltDLL Use this parameter to specify the location of the autnxslt library.
Type: String
Default: autnxslt.dll (if present)
Required: No
Configuration Paths or ImportService or Server Section:
Example: XsltDLL=autnxslt.dll See Also:
• • • 192 • Documentum Connector CFS Administration Guide • • Indexing Parameters
Indexing Parameters
The parameters in this section specify the details for the IDOL Server(s) to which the Connector Framework server will send documents for indexing.
ACIPort Specify the ACI port of each IDOL Server with which Connector Framework server communicates. There should be the same number of values in the ACIPort CSV as in the DREHost CSV.
Type: CSV (comma-separated values)
Default: None
Required At least one entry is required.
Configuration Indexing Section:
Example: ACIPort=9000,9012 See Also: “CompressIndexFiles” on page 193
CompressIndexFiles Set this parameter to True to compress all index files sent to IDOL. (IDOL will need to be at a relevant version to understand them.)
Type: Boolean
Default: False
Required No
Configuration Indexing Section:
Example: CompressIndexFiles=True See Also:
• • • Documentum Connector CFS Administration Guide • 193 • • Chapter 10 Connector Framework Server Parameters
DREHost Specify the IP address or host name of each IDOL Server with which Connector Framework server communicates. There should be the same number of values in the DREHost CSV as in the ACIPort CSV.
Type: CSV (comma-separated values)
Default: None
Required At least one entry is required.
Configuration Indexing Section:
Example: DREHost=hostmachine0,hostmachine1 See Also: “ACIPort” on page 193
IndexBatchSize Specify the maximum number of files that are included each batch that is indexed into IDOL Server.
Type: Integer
Default: 100
Required No
Configuration Indexing Section:
Example: IndexBatchSize=100
IndexTimeInterval Specify the timeout value in seconds for the index queue. This is the maximum amount of time a document will wait in the index queue before an attempt is made to index it. If no documents were indexed in the specified interval, any documents in the queue (up to the number specified in IndexBatchSize) are indexed.
NOTE Communication between CFS and the indexer can be over SSL.
• • • 194 • Documentum Connector CFS Administration Guide • • Indexing Parameters
Type: Integer
Default: 300
Required No
Configuration Indexing Section:
Example: IndexTimeInterval=100 See Also: “IndexBatchSize” on page 194
Related Topics “Secure Socket Layer Parameters” on page 223
KillDuplicates Use this parameter to specify the string that gets used as the KillDuplicates parameter value when sending an index command to IDOL server. The following options are available for this parameter: REFERENCE - Replaces an existing document with the new document if the document to index has the same value in its DREREFERENCE field. The default is to leave the value blank, in which case nothing is appended to the command sent to IDOL. This allows duplicate documents in IDOL server - IDOL server does not replace nor delete documents. For more information, refer to the IDOL Server Administration Guide.
Type: String
Default:
Required No
Configuration Indexing Section:
Example: KillDuplicates=REFERENCE See Also:
• • • Documentum Connector CFS Administration Guide • 195 • • Chapter 10 Connector Framework Server Parameters
• • • 196 • Documentum Connector CFS Administration Guide • • CHAPTER 11 License Configuration Parameters
This chapter describes the license configuration parameters that specify licensing details.
Full
Holder
Key
LicenseServerACIPort
LicenseServerHost
LicenseServerTimeout
LicenseServerRetries
Operation
• • • Documentum Connector CFS Administration Guide • 197 • • Chapter 11 License Configuration Parameters
Full
Indicates whether you have a full or an evaluation license.
Type: Boolean
Default: False
Required: Yes
Configuration License Section:
Example: Full=on In this example, the service is fully licensed.
Holder
The name of the license holder.
Type: String
Default: None
Required: Yes
Configuration License Section:
Example: Holder=Company
Key
The license key.
Type: String
Default: None
• • • 198 • Documentum Connector CFS Administration Guide • • LicenseServerACIPort
Required: Yes
Configuration License Section:
Example: Key=01234567890
LicenseServerACIPort
ACI port of DiSH license server. This must be the Port specified in the DiSH configuration file's [Server] section. This port is used to request licensing from DiSH. This parameter is used in IDOL with Administration.
Type: Long
Default: None
Required: Yes
Allowed range: Minimum: 0 Maximum: 65536
Recommended Minimum: 1025 range: Maximum: 65536
Configuration License Section:
Example: LicenseServerACIPort=20000 See Also: “LicenseServerHost” on page 200 “LicenseServerTimeout” on page 200 “LicenseServerRetries” on page 201
• • • Documentum Connector CFS Administration Guide • 199 • • Chapter 11 License Configuration Parameters
LicenseServerHost
Address of DiSH host. The IP address (or name) of the machine that hosts the DiSH license server. This parameter is used in IDOL with Administration.
Type: String
Default: None
Required: Yes
Configuration License Section:
Example: LicenseServerHost=1.23.45.6 See Also: “LicenseServerACIPort” on page 199 “LicenseServerTimeout” on page 200 “LicenseServerRetries” on page 201
LicenseServerTimeout
Seconds to timeout when connecting to DiSH. Type the number of seconds after which requests that have been sent to the DiSH license server time out if it does not respond. This parameter is used in IDOL with Administration.
Type: Long
Default: 120000
Required: No
Configuration License Section:
Example: LicenseServerTimeout=600000 See Also: “LicenseServerACIPort” on page 199 “LicenseServerHost” on page 200 “LicenseServerRetries” on page 201
• • • 200 • Documentum Connector CFS Administration Guide • • LicenseServerRetries
LicenseServerRetries
Number of retries when connecting to the DiSH license server. This parameter is used in IDOL with Administration.
Type: Integer
Default: 5
Required: No
Configuration License Section:
Example: LicenseServerRetries=1 See Also: “LicenseServerACIPort” on page 199 “LicenseServerHost” on page 200 “LicenseServerTimeout” on page 200
Operation
Licensed Operations key to allow additional ACI server operations to be licensed.
Type: String
Default: None
Required: Yes
Configuration License Section:
Example: Operations=803|87sdhsdf9n94nmsf7oasda987w4yriasunfa asd==
• • • Documentum Connector CFS Administration Guide • 201 • • Chapter 11 License Configuration Parameters
• • • 202 • Documentum Connector CFS Administration Guide • • CHAPTER 12 Server Parameters
This section describes the Server configuration parameters. It includes the following topics:
AdminClients
DataPort
DataPortClients
DataPortThreads
Port
QueryClients
AdminClients
Specify the IP addresses or names of clients that can send administrative commands to the ACI Port. To enter multiple addresses, separate the individual addresses with commas (there must be no space before or after the comma). Alternatively, you can use wildcards in the IP address. Enter for example 187.*.*.* to permit any machine whose IP address begins with 187 to control the connector.
• • • Documentum Connector CFS Administration Guide • 203 • • Chapter 12 Server Parameters
Type: String
Default: localhost
Required: No
Configuration Server Section:
Example: AdminClients=localhost,196.172.87.11 See Also: “DataPort” on page 204 “QueryClients” on page 206
DataPort
Use this parameter to specify the port number to use for transfering files if configured when using the DistributedConnector or Ingestion sections.
Type: Long
Default:
Required: No
Allowed Minimum: 1 Range: Maximum: 65535
Recommended Minimum: 1 Range: Maximum: 65535
Configuration Server Section:
Example: DataPort=7011 See Also:
• • • 204 • Documentum Connector CFS Administration Guide • • DataPortClients
DataPortClients
Use this parameter to specify a comma-separated values (CSV) list of client IP addresses and hostnames from which to accept requests.
Type: String
Default: *
Required: No
Configuration Server Section:
Example: DataPortClients=* See Also:
DataPortThreads
Use this parameter to specify the number of server threads for DataPort.
Type: Integer
Default: 2
Required: No
Configuration Server Section:
Example: DataPortThreads=2 See Also: “DataPort” on page 204
Port
Specify the ACI port by which action commands are sent to the connector.
Type: Long
Default:
Required: No
• • • Documentum Connector CFS Administration Guide • 205 • • Chapter 12 Server Parameters
Allowed Minimum: 1 Range: Maximum: 65535
Recommended Minimum: 1 Range: Maximum: 65535
Configuration Server Section:
Example: Port=7008 See Also:
QueryClients
Specify the IP addresses or names of clients that can send actions to the server. To enter multiple addresses, separate the individual addresses with commas (there must be no space before or after the comma). Alternatively, you can use wildcards in the IP address. Enter for example 187.*.*.* to permit any machine whose IP address begins with 187 to control the connector.
Type: String
Default: *
Required: No
Configuration Server Section:
Example: QueryClients=10.1.1.*,127.0.0.1 See Also: “DataPort” on page 204 “AdminClients” on page 203
• • • 206 • Documentum Connector CFS Administration Guide • • CHAPTER 13 Logging Configuration Parameters
This section describes the configuration parameters used to create separate log files for different log message types (such as query, index, and application) and to determine how each stream is logged.
LogArchiveDirectory
LogCompressionMode
LogDirectory
LogEcho
LogExpireAction
LogFile
LogHistorySize
LogLevel
LogLevelMatch
LogMaxLineLength
LogMaxOldFiles
LogMaxSizeKBs
LogOldAction
• • • Documentum Connector CFS Administration Guide • 207 • • Chapter 13 Logging Configuration Parameters
LogOutputLogLevel
LogSysLog
LogTime
LogTypeCSVs
LogArchiveDirectory
Path to log archive directory. Type the directory in which you want the application to archive old log files when LogOldAction is set to Move.
Type: String
Default: ./archive
Required: No
Configuration Logging and/or LogStream or TaskName Section: If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream.
Example: LogArchiveDirectory=./archive See Also: “LogOldAction” on page 217
• • • 208 • Documentum Connector CFS Administration Guide • • LogCompressionMode
LogCompressionMode
Specifies how old log files are compressed when the LogExpireAction parameter is set to Compress. This can be set to either zip or gz.
Type: String
Default: zip
Required: No
Configuration Logging and/or LogStream Section: If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream.
Example: LogCompressionMode=gz See Also: “LogExpireAction” on page 210
LogDirectory
Path to log directory. Type the directory in which you want the application to store the log files it creates.
Type: String
Default: ./logs
Required: No
Configuration Logging Section:
Example: LogDirectory=./logs See Also: “LogArchiveDirectory” on page 208 “LogFile” on page 211
• • • Documentum Connector CFS Administration Guide • 209 • • Chapter 13 Logging Configuration Parameters
LogEcho
Display logging messages on the console. Enable this parameter to display logging messages on the console.
NOTE This setting has no effect if you are running the application as a Windows service.
Type: Boolean
Default: False
Required: No
Configuration Logging and/or LogStream Section: If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream.
Example: LogEcho=true See Also: “LogArchiveDirectory” on page 208
LogExpireAction
Determines how log files are handled when they exceed the maximum size. Type one of the following to determine how log files are handled when they exceed the MaxLogSizeKBs size:
Option Description
Compress The log file's name is appended with a time stamp, compressed and saved in the log directory. By default, this is a Zip file. Use the LogCompressionMode parameter to specify another compression format.
Consecutive The log file's name is appended with a number and saved in the log directory. When the next log file reaches its LogMaxSizeKBs size, it is appended with the next consecutive number.
• • • 210 • Documentum Connector CFS Administration Guide • • LogFile
Option Description
Datestamp The log file's name is appended with a time stamp and saved in the log directory.
Previous The log file's name is appended with .previous and saved in the log directory. Every time a log file reaches its LogMaxSizeKBs size, it is given the same postfix so it overwrites the old log file.
Day Only one log file is created per day and is appended with the current time stamp. Log files are archived after they reach the LogMaxSizeKBs size. NOTE The LogMaxSizeKBs parameter takes precedence over the LogExpireAction parameter. Therefore, if you set LogExpireAction to Day, and the value for LogMaxSizeKBs results in more than one log file, multiple log files is generated per day.
Type: String
Default: Datestamp
Required: No
Configuration Logging and/or LogStream or TaskName Section: If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream.
Example: LogExpireAction=Compress See Also: “LogCompressionMode” on page 209 “LogFile” on page 211 “LogMaxSizeKBs” on page 216
LogFile
Name of the log file. The name of the log file the application creates in the specified LogDirectory.
Type: String
Default: None
Required: Yes
• • • Documentum Connector CFS Administration Guide • 211 • • Chapter 13 Logging Configuration Parameters
Configuration Logging and/or LogStream Section: If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream.
Example: LogFile=query.log See Also: “LogDirectory” on page 209
LogHistorySize
The number of log messages to store in memory.
Type: String
Default: 100
Required: Yes
Allowed Minimum: 1 Range: Maximum: 520
Configuration LogStream Section:
Example: LogHistorySize=50 See Also: “LogExpireAction” on page 210
LogLevel
The type of messages that are logged. Type one of the following to determine the type of messages that are logged:
Option Description
Always Basic processes are logged. NOTE This produces only minimal logging and no errors are logged.
Error Errors are logged.
• • • 212 • Documentum Connector CFS Administration Guide • • LogLevelMatch
Option Description
Warning Errors and warnings are logged.
Normal Errors, warnings and basic processes are logged.
Full Every occurrence is logged. NOTE This produces a large log file and can affect performance.
The log levels are hierarchical from least logging to most logging. You can use the LogLevelMatch parameter to specify which messages are reported relative to the specified LogLevel. For example, if LogLevelMatch=LessThan and LogLevel=Warning, "Normal" and "Full" message types are reported. Use the LogOutputLogLevel parameter to report the log level in the log.
Type: String
Default: Normal
Required: No
Configuration Logging and/or LogStream Section: If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream.
Example: LogLevel=Warning See Also: “LogFile” on page 211 “LogLevelMatch” on page 213
LogLevelMatch
The messages reported relative to the specified LogLevel. The LogLevelMatch parameter specifies the messages that are reported relative to the log-level hierarchy: Always
Error
Warning
Normal
Full
• • • Documentum Connector CFS Administration Guide • 213 • • Chapter 13 Logging Configuration Parameters
Type one of the following values for LogLevelMatch:
Option Description
Equal Only the message type specified by LogLevel is reported. For example, if LogLevel=warning, only warning messages are reported.
LessThan The message types below the LogLevel setting are reported. For example, if LogLevel=warning, "Normal" and "Full" message types are reported.
LessThanOrEqual The message type specified by LogLevel and any message type below that are reported. For example, if LogLevel=warning, "Normal", "Full", and "Warning" message types are reported.
GreaterThan The message types above the LogLevel setting are reported. For example, if LogLevel=warning, "Error" and "Always" message types are reported.
GreaterThanOrEqual The message type specified by LogLevel and any message type above that are reported. For example, if LogLevel=warning, "Error", "Always", and "Warning" message types are reported.
Type: String
Default: GreaterThanOrEqual
Required: No
Configuration Logging and/or LogStream Section: If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream.
Example: LogLevelMatch=GreaterThanOrEqual See Also: “LogFile” on page 211 “LogLevel” on page 212 “LogOutputLogLevel” on page 218
• • • 214 • Documentum Connector CFS Administration Guide • • LogMaxLineLength
LogMaxLineLength
Maximum characters in a log entry. The number of characters a log entry can include before it is truncated. Increase this value when you want long actions to be logged in full.
Type: Long
Default: 16384
Required: No
Allowed Minimum: 0 Range: Maximum: 2000000000
Recommended Minimum: 100 Range: Maximum: 1000000
Configuration Logging and/or LogStream Section: If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream.
Example: LogMaxLineLength=24000 See Also: “LogFile” on page 211
LogMaxOldFiles
Maximum number of log files in the log directory. The maximum number of log files the specified LogDirectory can store before the application runs the specified LogOldAction. If you do not want to restrict how many log files the LogDirectory can store, type -1.
Type: Long
Default: -1 (unlimited)
Required: No
• • • Documentum Connector CFS Administration Guide • 215 • • Chapter 13 Logging Configuration Parameters
Configuration Logging and/or LogStream or TaskName Section: If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream.
Example: LogMaxOldFiles=1000 See Also: “LogDirectory” on page 209 “LogOldAction” on page 217
LogMaxSizeKBs
Maximum log file size (in KB). If you do not want to restrict the log file size, type -1. The LogExpireAction parameter determines how a log file is handled after it has reached its maximum size. This parameter is used for standard logging streams.
Type: Long
Default: 1024
Required: No
Configuration Logging and/or LogStream or TaskName Section: If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream.
Example: LogMaxSizeKBs=1000 See Also: “LogExpireAction” on page 210
• • • 216 • Documentum Connector CFS Administration Guide • • LogOldAction
LogOldAction
Determines how log files are handled when the maximum number of log files is exceeded. Type one of the following to determine how log files are handled when the LogDirectory has reached the maximum number of log files, as determined by the LogMaxOldFiles parameter:
Option Description
Delete The log files are deleted.
Move The log files are moved to the specified LogArchiveDirectory.
Type: String
Default: Delete
Required: No
Configuration Logging and/or LogStream Section: If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream.
Example: LogOldAction=Move See Also: “LogArchiveDirectory” on page 208 “LogDirectory” on page 209 “LogMaxOldFiles” on page 215
• • • Documentum Connector CFS Administration Guide • 217 • • Chapter 13 Logging Configuration Parameters
LogOutputLogLevel
Determines whether the log level is reported in the log. Enable this parameter to include the log level of a message in the log entry.
Type: Boolean
Default: False
Required: No
Configuration Logging and/or LogStream Section: If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream.
Example: LogLevel=Always LogOutputLogLevel=true
In this example, Always is added to the log message: 21/12/2006 12:34:56 [10] Always: ACI Server attached to port 1622 See Also: “LogLevel” on page 212
LogSysLog
Write messages to Windows/Linux system log. Enable this parameter to write messages to the Linux Syslog or the Windows Event Log.
Type: Boolean
Default: False
Required: No
Configuration Logging and/or LogStream Section: If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream.
Example: LogSysLog=true
• • • 218 • Documentum Connector CFS Administration Guide • • LogTime
LogTime
Display time with each log entry. Enable this parameter to display the current time next to each log entry in the log file.
Type: Boolean
Default: True
Required: No
Configuration Logging and/or LogStream Section: If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream.
Example: LogTime=false See Also: “LogFile” on page 211
LogTypeCSVs
List of message types to log. Type one or more of the following message types to specify the type of messages written to the associated log file. If you want to type multiple message types, separate them with commas (there must be no space before or after a comma):
Option Description
All Components
Action Logs actions and related messages.
Application Logs application-related occurrences.
IDOL Server
Agent Logs agent actions and related messages.
Category Logs category actions and related messages.
Cluster Logs cluster actions and related messages.
Community Logs community actions and related messages.
ExtendedIndex Logs index actions as well as index actions that are sent after IDOL Server has routed incoming data through other processes.
• • • Documentum Connector CFS Administration Guide • 219 • • Chapter 13 Logging Configuration Parameters
Option Description
Index Logs index actions and related messages.
Mailer Logs mailer actions and related messages.
Profile Logs profile actions and related messages.
Query Logs query actions and related messages.
QueryTerms Logs each query term, after stemming, conversion to UTF8, capitalization and punctuation removal. This is mainly used by the Autonomy DiSH server for statistical reports.
Role Logs role actions and related messages.
Schedule Logs schedule actions and related messages.
Taxonomy Logs taxonomy actions and related messages.
User Logs user actions and related messages.
User_Audit Logs UserAdd and UserDelete actions and related messages. UserTerm Logs terms that IDOL Server uses to form a user's agents and profiles.
DIH
Index Logs index actions and related messages.
Query Logs query actions and related messages.
DAH
Security Logs security action results.
DiSH
Alert Logs alert actions and related messages.
AlertResults Logs alert action results.
Audit Logs audit actions and related messages.
Schedule Logs schedule actions and related messages.
ScheduleResults Logs schedule action results.
Connectors
FailureList Logs details of files that were not imported successfully.
Import Logs import actions and related messages.
Index Logs index actions and related messages.
• • • 220 • Documentum Connector CFS Administration Guide • • LogTypeCSVs
Option Description
Spider Logs spider actions and related messages. (HTTP Connector only)
CFS
Import Logs import actions and related messages.
Indexer Logs the status of Indexing into IDOL.
CFS Connectors
Collect Logs document collection for use in Legal Hold applications.
Delete Logs the deletion of documents from the repository.
Hold Logs details of documents that are put on hold in Legal Hold applications.
Identifiers Logs details of requests for document lists from repositories.
Insert Logs the insertion of documents into the repository.
Synchronize Logs data synchronization when ingesting into IDOL.
Update Logs details of documents whose metadata is updated in the repository.
View Logs details of documents that are viewed from the repository.
Transcode Server
Transcode Logs details of transcoding.
Type: String
Default: None
Required: Yes
Configuration LogStream Section:
Example: LogTypeCSVs=Application,Index See Also: “LogFile” on page 211
• • • Documentum Connector CFS Administration Guide • 221 • • Chapter 13 Logging Configuration Parameters
• • • 222 • Documentum Connector CFS Administration Guide • • CHAPTER 14 Secure Socket Layer Parameters
This section describes the configuration parameters used to configure Secure Socket Layer (SSL) connections between components.
NOTE These parameters usually appear in the [SSLOptions] section of the configuration file.
SSLConfig
SSLCACertificate
SSLCACertificatesPath
SSLCertificate
SSLCheckCertificate
SSLCheckCommonName
SSLMethod
SSLPrivateKey
SSLPrivateKeyPassword
• • • Documentum Connector CFS Administration Guide • 223 • • Chapter 14 Secure Socket Layer Parameters
SSLConfig
Identifies the configuration section in which the SSL configuration details are specified, usually SSLOptionN. You must set this parameter if you are using SSL connections between components. To control incoming ACI calls, set this parameter in the [Server] or [Default] section. To control outgoing ACI calls, set this parameter in another component section, such as [DataDRE], [CatDRE], or a connector Job section. The section in which you set SSLConfig depends on whether you are using a distributed architecture and on which component you are configuring. For example, in a standalone Category configuration, you can set SSLConfig in the [Server], [DataDRE], [CatDRE], and [CommunityServer] sections. See each component’s documentation for more information.
Type: String
Default: None
Required: No
• • • 224 • Documentum Connector CFS Administration Guide • • SSLConfig
Configuration Server or Default, or other section for outgoing communications Section:
Example: [Server] SSLConfig=SSLOptions1 ...
[AgentDRE] SSLConfig=SSLOptions2 ...
[DataDRE] SSLConfig=SSLOptions2 ...
// For Omni Group Servers:
[Note] GroupServerHost=... GroupServerPort=... SSLConfig=SSLOptions2
[SSLOptions1] //SSL options for incoming connections SSLMethod=SSLV23 SSLCertificate=host1.crt SSLPrivateKey=host1.key SSLCACertificate=trusted.crt
[SSLOptions2] //SSL options for outgoing connections SSLMethod= SSLV23 SSLCertificate=host2.crt SSLPrivateKey=9s7BxMjD2d3M3t7awt/J8A SSLCACertificate=trusted.crt See Also: “SSLCACertificate” on page 226 “SSLCertificate” on page 228 “SSLCheckCertificate” on page 228 “SSLCheckCommonName” on page 229 “SSLMethod” on page 229 “SSLPrivateKey” on page 230 “SSLPrivateKeyPassword” on page 231
• • • Documentum Connector CFS Administration Guide • 225 • • Chapter 14 Secure Socket Layer Parameters
SSLCACertificate
Certificate Authority (CA) certificate file of a trusted authority. The component only trusts communication with a peer that provides a certificate signed by the specified CAs.
Type: String
Default: None
Required: No
Configuration SSLOptionN Section:
Example: SSLCACertificate=trusted.crt See Also: “SSLConfig” on page 224
SSLCACertificatesPath
Use this parameter to specify the path to a directory containing multiple CA certificates in PEM format to check against. Each file must contain one CA certificate. The files are looked up by the CA subject name hash value, which must be available. If more than one CA certificate with the same name hash value exists, the extension must be different (for example, 9dd6633f0.0, 9dd6633f0.1, and so on). The search is performed in the order of the extension number, regardless of other properties of the certificates. As an alternative, you can specify the path to a file containing multiple CA certificates in PEM format. The file can contain certificates identified by sequences like the following example:
----BEGIN CERTIFICATE---- ... (CA certificate in base64 encoding) ... ----END CERTIFICATE----
You can insert text before, between and after the certificates to be used as descriptions of the certificates.
• • • 226 • Documentum Connector CFS Administration Guide • • SSLCACertificatesPath
CAUTION If several CA certificates matching the name, key identifier, and serial number condition are available, only the first one is examined. This might lead to unexpected results if the same CA certificate is available with different expiration dates. If a “certificate expired” verification error occurs, no other certificate is searched. Make sure to not have expired certificates mixed with valid ones.
For more information, refer to: http://www.openssl.org/docs/ssl/ SSL_CTX_load_verify_locations.html.
Type: String
Default: None
Required: No
Configuration SSLOptionN Section:
Example: SSLCACertificatesPath=C:\Autonomy\HTTPConnector\ CACERTS\
See Also: “SSLConfig” on page 224
• • • Documentum Connector CFS Administration Guide • 227 • • Chapter 14 Secure Socket Layer Parameters
SSLCertificate
SSL Certificate file to use to identify this component to a peer. It can be either ASN1 or PEM format. This parameter requires a matching SSLPrivateKey value.
Type: String
Default: None
Required: Yes
Configuration SSLOptionN Section:
Example: SSLCertificate=host1.crt SSLPrivateKey=host1.key See Also: “SSLConfig” on page 224 “SSLPrivateKey” on page 230
SSLCheckCertificate
Specifies whether a certificate signed by a trusted authority is requested from peers.
Setting SSLCACertificate implicitly sets SSLCheckCertificate to true. If SSLCACertificate is set to false, communications are encrypted, but certificates are not requested from peers.
Type: Boolean
Default: True if SSLCACertificate is set. False if SSLCACertificate is not set. Required: No
Configuration SSLOptionN Section:
Example: SSLCheckCertificate=true See Also: “SSLConfig” on page 224
• • • 228 • Documentum Connector CFS Administration Guide • • SSLCheckCommonName
SSLCheckCommonName
Verifies the identity of the peer. Specifies whether the host name listed in the peer's certificate (that is, the CommonName or "CN" attribute) resolves to the same IP address as the peer itself, as determined by the network connection.
For example, if the host name in a certificate is eip.autonomy.com and resolves to an IP address of 12.3.4.56, then the peer must share the same IP address.
Type: Boolean
Default: False
Required: No
Configuration SSLOptionN Section:
Example: SSLCheckCommonName=true See Also: “SSLConfig” on page 224
SSLMethod
Specifies which SSL protocol is used. The options are: SSLV2
SSLV3
SSLV23
TLSV1
• • • Documentum Connector CFS Administration Guide • 229 • • Chapter 14 Secure Socket Layer Parameters
SSLV23 is used in most cases.
Type: String
Default: None
Required: Yes
Configuration SSLOptionN Section:
Example: SSLMethod=SSLV23 See Also: “SSLConfig” on page 224
SSLPrivateKey
The private security key for the SSL certificate. It can be either ASN1 or PEM format. This parameter requires a matching SSLCertificate value.
Type: String
Default: None
Required: Yes
Configuration SSLOptionN Section:
Example: SSLCertificate=host1.crt SSLPrivateKey=host1.key See Also: “SSLConfig” on page 224 “SSLCertificate” on page 228 “SSLPrivateKeyPassword” on page 231
• • • 230 • Documentum Connector CFS Administration Guide • • SSLPrivateKeyPassword
SSLPrivateKeyPassword
The password for the file defined in SSLPrivateKey. The password might be in plain text, or basic or AES encryption format.
Type: String
Default: None
Required: No
Configuration SSLOptionN Section:
Example: [SSLOption0] SSLCertificate=host1.crt SSLPrivateKey=host1.key SSLPrivateKeyPassword=PvKey1559
In this example, the private key password to the file host1.key is written in plain text. ... [SSLOption0] SSLCertificate=host1.crt SSLPrivateKey=host1.key SSLPrivateKeyPassword=9s7BxMjD2d3M3t7awt/J8A
In this example, the private key password to the file host1.key has basic encryption.
See Also: “SSLConfig” on page 224 “SSLPrivateKey” on page 230
• • • Documentum Connector CFS Administration Guide • 231 • • Chapter 14 Secure Socket Layer Parameters
• • • 232 • Documentum Connector CFS Administration Guide • • CHAPTER 15 Service Actions
This section describes the Service actions.
Action Syntax
GetConfig
GetLogStream
GetLogStreamNames
GetStatistics
GetStatus
GetStatusInfo
Stop
Service Action Parameters If the ServicePort, ServiceStatusClients and ServiceControlClients configuration parameters are specified, the service port is enabled and accepts the status and control actions described in this section.
Action Syntax
The actions use the following format: http://Host:Port/action=ActionName&[Parameters]
• • • Documentum Connector CFS Administration Guide • 233 • • Chapter 15 Service Actions
where,
Host The IP address (or name) of the machine hosting the service.
Port The ServicePort specified in the Service section of the service’s configuration.
ActionName One of the actions described in this section.
Parameters One or more parameters that might be required by an action.
For example: http://12.3.4.56:40010/action=GetConfig This action uses port 40010 to request the service’s configuration file settings.
Related Topics “Service Actions” on page 233
GetConfig
The GetConfig action returns the service’s configuration file settings.
Example action=GetConfig
Parameters None.
GetLogStream
The GetLogStream action returns a specific log stream for the service.
Example action=GetLogStream&Name=ApplicationLogStream&FromDisk=true&Tail=1 0 This action displays the first ten entries of the ApplicationLogStream log.
• • • 234 • Documentum Connector CFS Administration Guide • • GetLogStreamNames
Parameters The action has the following optional parameters:
Parameter Description Required
FromDiskFr Specifies whether the log stream is read from disk or omDisk memory.
Name The name of the log stream you want to return.
Tail The number of lines from the log stream to return.
GetLogStreamNames
The GetLogStreamNames action returns the names of the log streams defined for the service.
Example
action=GetLogStreamNames
Parameters None.
GetStatistics
The GetStatistics action returns statistics for the service. The following statistics return for all servers:
Class Statistic Description
[Service] Class
[Statistics]
ServiceDuration The number of seconds the service has been running.
10SecondResponseAverage The average service response time (in milliseconds) measured over the last 10 seconds.
10SecondRequestsPerSecond The number of requests to the service per second within the last 10 seconds.
• • • Documentum Connector CFS Administration Guide • 235 • • Chapter 15 Service Actions
10SecondRequests The number of requests to the service in the last 60 seconds.
60SecondResponseAverage The average service response time (in milliseconds) measured over the last 60 seconds.
60SecondRequestsPerSecond The number of requests to the service per second within the last 60 seconds.
60SecondPeakRequestsPerSecond The highest number of requests to the service over any 60 second period.
60SecondRequests The number of requests to the service in the last 60 seconds.
1HourResponseAverage The average service response time (in milliseconds) measured over the last hour.
1HourRequestsPerSecond The number of requests to the service per second within the last hour.
1HourPeakRequestsPerSecond The highest number of requests to the service over any 1 hour period.
1HourRequests The number of requests to the service in the last hour.
24HourResponseAverage The average service response time (in milliseconds) measured over the last 24 hours.
24HourRequestsPerSecond The number of requests to the service per second within the last 24 hours.
24HourPeakRequestsPerSecond The highest number of requests to the service over any 24 hour period.
24HourRequests The number of requests to the service in the last 24 hours.
RecentResponseAverage The average service response time (in milliseconds) from the time the last 10 second period finished to the current time.
RecentRequestsPerSecond The number of requests to the service per second from the time the last 10 second period finished to the current time.
RecentPeakRequestsPerSecond The highest number of requests to the service from the time the last 10 second period finished to the current time.
RecentRequests The number of requests to the service from the time the last 10 second period finished to the current time.
TotalRequests The total number of requests that were made to the service.
• • • 236 • Documentum Connector CFS Administration Guide • • GetStatistics
The following statistics return for specific components:
Class Statistic Description
[Service] Class
[Statistics]
TruncatedQueries The number of queries that timed out.
[Documents]
Total The total number of documents that this IDOL Server contains.
Sections The number of document sections that this IDOL Server contains.
TotalSlots The total number of document sections that the IDOL Server contains including document sections that have been deleted.
[Databases]
Number The total number of databases including empty databases and databases that have been deleted.
Active The number of active databases (databases that are empty or contain data).
[ACI] Class
[Action:ActionName]
Count The total number of ActionName actions that were sent to the service.
Avg.Duration The average duration (in ms) of ActionName actions.
Shortest The shortest duration (in ms) of ActionName actions.
Longest The longest duration (in ms) of ActionName actions. [Indexer] Class
[Connections]
Total The number of socket connections to the index port.
Unauthorized The number of index actions that IDOL Server received from unauthorized clients.
Paused The number of connections that were rejected because the service was paused.
• • • Documentum Connector CFS Administration Guide • 237 • • Chapter 15 Service Actions
Class Statistic Description
InsufficientDiskSpace The number of connections that were rejected because there was insufficient disk space.
InvalidIndexCode The number of connections that were rejected because they contained an invalid index code.
[Commands]
Invalid The number of actions that the service received to the index port that were not valid index actions.
TuncatedData The number of index actions that were received that had truncated data.
CommandName The number of CommandName index actions that were run.
[Command:CommandName]
Avg.Duration The average duration (in ms) of CommandName index actions.
Shortest The shortest duration (in ms) of CommandName index actions.
Longest The longest duration (in ms) of CommandName index actions.
CommandsRejectedDiskFull The number of index actions that were rejected because the disk was full.
CommandsRejectedInvalidIndexCode The number of index actions that were rejected because their index code was invalid.
[Streaming]
BytesStreamedToDisk The number of bytes of data that the service has streamed to disk.
TimeSpentStreaming The amount of time in seconds that the service has spent streaming data.
[Queue]
Received The number of index actions that have been received.
Completed The number of index actions that have been completed.
Queued The number of index actions that are in the index queue.
[Rejected Commands]
Invalid The number of index actions that were rejected because they were not recognized actions.
• • • 238 • Documentum Connector CFS Administration Guide • • GetStatistics
Class Statistic Description
RejectedInvalidDatabase The number of index actions that were rejected because they contained an invalid database.
ReadOnlyDatabase The number of index actions that were rejected because they contained a read-only database.
FileNotFound The number of index actions that were rejected because the file was not found.
DocLimitExceeded The number of index actions that were rejected because the document limit was exceeded.
IndexSizeExceeded The number of index actions that were rejected because the maximum index size was exceeded.
UserConfIndexLimitExceeded The number of index actions that were rejected because the configured maximum allowed index size was exceeded.
OutOfMemory The number of index actions that were rejected because IDOL server was out of memory.
BadParameter The number of index actions that were rejected because they contained an invalid parameter or parameter value.
InsufficientFileHandles The number of index actions that were rejected because there were insufficient file handles.
InsufficientDiskSpace The number of index actions that were rejected because there was not enough disk space.
TruncatedData The number of POST index actions that were rejected because their data termination was incorrect.
SuccessfullyProcessed The number of successfully run index actions.
OndiskComponent The number of index actions that have data stored on disk.
[Documents]
ReplacedReindex The number of documents that were re-indexed because an ACLType or Index field had changed.
ReplacedDocsTotal The number of documents that have been replaced.
InvalidDatabaseDocs The number of documents that were not indexed because their database was invalid.
[Database] Class
[DatabaseName]
Documents The number of documents that this database contains.
• • • Documentum Connector CFS Administration Guide • 239 • • Chapter 15 Service Actions
Class Statistic Description
Sections The number of document sections that this database contains.
[Server] Class
[Tasks]
Number The number of tasks set up in the configuration file.
StartTask The first task that is performed.
IndexCommands The number of index actions that have been processed (the number displayed includes any index action that is currently being processed).
Documents The number of documents that have been processed (the number displayed includes any document that is currently being processed).
DocumentSuccesses The number of documents that have been processed successfully.
DocumentFailures The number of times that document processing has failed.
Sections The number of document sections processed.
[Tasks] Class
[TaskName] Requests The number of requests sent to a specific task.
Successes The number of requests processed successfully by a specific task.
Failures The number of request-processing failures for a specific task.
[Licensing] Class
[Users]
Maximum The maximum number of users that can be set up for this service.
[Statistics] Class
[Users]
Users The number of users that has been set up for this service.
[CHILDSTAT] Class
[AllChildren]
• • • 240 • Documentum Connector CFS Administration Guide • • GetStatistics
Class Statistic Description
TotalUpEvents The number of times a DIH child server was marked up
TotalDownEvents The number of times a DIH child server was marked down.
[Engine N] UpEvents The number of times this DIH child server was marked down.
DownEvents The number of times this DIH child server was marked up.
CommandsSent The number of actions that were sent to this DIH child server.
Retries The number of times actions to this DIH child server were retried.
TotalBytesSent The total number of bytes of data that were sent to this DIH child server.
AvgSendCommandRate The average rate that actions were sent to this DIH child server.
MinResponseTime The smallest time that DAH took to respond to a request.
AvgResponseTime The average time that DAH took to respond to requests.
MaxResponseTime The largest time that DAH took to respond to requests.
SuccessfulActions The number of actions that were successfully completed.
FailedActions The number of actions that failed.
Timeouts The number of actions that timed out.
Example action=GetStatistics
Parameters None.
• • • Documentum Connector CFS Administration Guide • 241 • • Chapter 15 Service Actions
GetStatus
The GetStatus action returns the service’s status (running or stopped) and some current configuration settings.
Example action=GetStatus
Action Parameters None.
GetStatusInfo
The GetStatusInfo action returns status information for the service (for example, the service’s product name, version number and so on). The following status information for the service are returned:
Statistics Description
[StatusInfo]
ServiceStartTime The time the service started running (epochseconds).
ServiceUtilsVersion The version of the service utilities.
ServiceName The name of the service.
ProductName The product name of the service.
ProductVersion The version of the product.
ProductBuild The build of the product.
ServicePID The process ID of the service.
ProductUID The user identifier of the service.
ServiceStatus The status of the service (running or stopped).
[Job]
FlowRate The amount of data (in kilobytes) being aggregated per second.
Status The status of the connector job (running or stopped).
• • • 242 • Documentum Connector CFS Administration Guide • • Stop
Example action=GetStatusInfo
Parameters None.
Stop
The Stop action stops the service.
Example action=Stop
Parameters None.
Service Action Parameters
This section describes the parameters for service actions.
FromDisk
Name
Tail
FromDisk Specifies whether the log stream is read from disk or memory. Type true if you want the log stream to be read from disk rather than from memory.
Action GetLogStream
Type: Boolean
Default: false
• • • Documentum Connector CFS Administration Guide • 243 • • Chapter 15 Service Actions
Required: No
Example: action=GetLogStream&Name=ApplicationLogStream&Fro mDisk=true&Tail=10 See Also:
Name Type the name of the log stream you want to return.
Action GetLogStream
Type: String
Default: false
Required: Yes
Example: action=GetLogStream&Name=ApplicationLogStream&Fro mDisk=true&Tail=10 See Also:
Tail Type the number of lines from the log stream to return. The lines are read from the top (that is the most recent lines are retuned). Type -1 to return all entries.
Action GetLogStream
Type: Long
Default: -1
Required: No
Example: action=GetLogStream&Name=ApplicationLogStream&Tai l=10 See Also:
• • • 244 • Documentum Connector CFS Administration Guide • • CHAPTER 16 Service Configuration Parameters
This section describes the Service configuration parameters that determine which machines are permitted to use and control a service.
ServiceACIMode
ServiceControlClients
ServiceHost
ServicePort
ServiceStatusClients If the ServicePort, ServiceStatusClients and ServiceControlClients configuration parameters are specified, the service port is enabled and accepts the standard status and control actions described in “Service Actions” on page 233.
• • • Documentum Connector CFS Administration Guide • 245 • • Chapter 16 Service Configuration Parameters
ServiceACIMode
Generate ACI-compatible XML.
Type: Boolean
Default: False
Required: No
Configuration Service Section:
Example: ServiceACIMode=false See Also: “ServiceControlClients” on page 246 “ServiceHost” on page 247 “ServicePort” on page 247 “ServiceStatusClients” on page 248
ServiceControlClients
IP addresses or names of clients that can send service control actions to the service. To type multiple addresses, separate the individual addresses with commas (there must be no space before or after the comma). Alternatively, you can use wildcards in the IP address. Type for example 187.*.*.* to permit any machine whose IP address begins with 187 to control the connector.
Type: String
Default: None
Required: Yes
Configuration Service Section:
Example: ServiceControlClients=localhost,127.0.0.1 See Also: “ServiceACIMode” on page 246 “ServiceHost” on page 247 “ServicePort” on page 247 “ServiceStatusClients” on page 248
• • • 246 • Documentum Connector CFS Administration Guide • • ServiceHost
ServiceHost
The host server on which the service is running.
Type: String
Default: *.*.*.*
Required: Yes
Configuration Service Section:
Example: ServiceHost=127.0.0.1 See Also: “ServiceACIMode” on page 246 “ServiceControlClients” on page 246 “ServicePort” on page 247 “ServiceStatusClients” on page 248
ServicePort
The port on the host server on which the service listens for service status and control requests.
Type: Long
Default: 40010
Required: Yes
Allowed Minimum: 1 Range: Maximum: 65535
Recommended Minimum: 1024 Range: Maximum: 65535
Configuration Service Section:
Example: ServicePort=40010 See Also: “ServiceACIMode” on page 246 “ServiceControlClients” on page 246 “ServiceHost” on page 247 “ServiceStatusClients” on page 248
• • • Documentum Connector CFS Administration Guide • 247 • • Chapter 16 Service Configuration Parameters
ServiceStatusClients
The IP addresses or names of clients that can request status information from a service. These clients cannot control the service. To type multiple addresses, separate the individual addresses with commas (there must be no space before or after the comma). Alternatively, you can use wildcards in the IP address. Type for example 187.*.*.* to permit any machine whose IP address begins with 187 to access the service's status.
Type: String
Default: None
Required: Yes
Configuration Service Section:
Example: ServiceStatusClients=localhost,127.0.0.1 See Also: “ServiceACIMode” on page 246 “ServiceControlClients” on page 246 “ServiceHost” on page 247 “ServicePort” on page 247
• • • 248 • Documentum Connector CFS Administration Guide • • Appendixes
This section includes the following appendixes:
KeyView Format Codes Appendixes
• • • 250 • Documentum Connector CFS Administration Guide • • APPENDIX A KeyView Format Codes
This chapter lists the KeyView format classes and codes used with Connector Framework server. It includes the following section:
KeyView Classes
KeyView Formats Table 1 lists KeyView file classes. The numbers are reported in the DocumentClass field in IDX files generated by Import Module. Consult the table to determine the file class that was imported.
Table 2 lists all KeyView formats. The numbers are reported in the DocumentType field in IDX files generated by Import Module. Consult the table to determine the file type that was imported. You can use any of the format numbers from Table 2 in conjunction with the ImportFamilyRootExcludeFmtCSV parameter. For more information, see “ImportFamilyRootExcludeFmtCSV” on page 188.
• • • Documentum Connector CFS Administration Guide • 251 • • Appendix A KeyView Format Codes
KeyView Classes
Table 1 KeyView Classes Attribute Number File Class
0 No file class
01 Word processor
02 Spreadsheet
03 Database
04 Raster image
05 Vector graphic
06 Presentation
07 Executable
08 Encapsulation
09 Sound
10 Desktop publishing
11 Outline/planning
12 Miscellaneous
13 Mixed format
14 Font
15 Time scheduling
16 Communications
17 Object module
18 Library module
19 Fax
20 Movie
21 Animation
• • • 252 • Documentum Connector CFS Administration Guide • • KeyView Formats
KeyView Formats
Table 2 KeyView Formats
Format Name Format Number Format Description AES_Multiplus_Comm_Fmt 1 Multiplus (AES)
ASCII_Text_Fmt 2 Text
MSDOS_Batch_File_Fmt 3 MS-DOS Batch File
Applix_Alis_Fmt 4 APPLIX ASTERIX
BMP_Fmt 5 Windows Bitmap
CT_DEF_Fmt 6 Convergent Technologies DEF Comm. Format
Corel_Draw_Fmt 7 Corel Draw
CGM_ClearText_Fmt 8 Computer Graphics Metafile (CGM)
CGM_Binary_Fmt 9 Computer Graphics Metafile (CGM)
CGM_Character_Fmt 10 Computer Graphics Metafile (CGM)
Word_Connection_Fmt 11 Word Connection
COMET_TOP_Word_Fmt 12 COMET TOP
CEOwrite_Fmt 13 CEOwrite
DSA101_Fmt 14 DSA101 (Honeywell Bull)
DCA_RFT_Fmt 15 DCA-RFT (IBM Revisable Form)
CDA_DDIF_Fmt 16 CDA / DDIF
DG_CDS_Fmt 17 DG Common Data Stream (CDS)
Micrografx_Draw_Fmt 18 Windows Draw (Micrografx)
Data_Point_VistaWord_Fmt 19 Vistaword
DECdx_Fmt 20 DECdx
Enable_WP_Fmt 21 Enable Word Processing
EPSF_Fmt 22 Encapsulated PostScript
Preview_EPSF_Fmt 23 Encapsulated PostScript
MS_Executable_Fmt 24 MSDOS/Windows Program
G31D_Fmt 25 CCITT G3 1D
• • • Documentum Connector CFS Administration Guide • 253 • • Appendix A KeyView Format Codes
Table 2 KeyView Formats (continued)
Format Name Format Number Format Description GIF_87a_Fmt 26 Graphics Interchange Format (GIF87a)
GIF_89a_Fmt 27 Graphics Interchange Format (GIF89a)
HP_Word_PC_Fmt 28 HP Word PC
IBM_1403_LinePrinter_Fmt 29 IBM 1403 Line Printer
IBM_DCF_Script_Fmt 30 DCF Script
IBM_DCA_FFT_Fmt 31 DCA-FFT (IBM Final Form)
Interleaf_Fmt 32 Interleaf
GEM_Image_Fmt 33 GEM Bit Image
IBM_Display_Write_Fmt 34 Display Write
Sun_Raster_Fmt 35 Sun Raster
Ami_Pro_Fmt 36 Lotus Ami Pro
Ami_Pro_StyleSheet_Fmt 37 Lotus Ami Pro Style Sheet
MORE_Fmt 38 MORE Database MAC
Lyrix_Fmt 39 Lyrix Word Processing
MASS_11_Fmt 40 MASS-11
MacPaint_Fmt 41 MacPaint
MS_Word_Mac_Fmt 42 Microsoft Word for Macintosh
SmartWare_II_Comm_Fmt 43 SmartWare II
MS_Word_Win_Fmt 44 Microsoft Word for Windows
Multimate_Fmt 45 MultiMate
Multimate_Fnote_Fmt 46 MultiMate Footnote File
Multimate_Adv_Fmt 47 MultiMate Advantage
Multimate_Adv_Fnote_Fmt 48 MultiMate Advantage Footnote File
Multimate_Adv_II_Fmt 49 MultiMate Advantage II
Multimate_Adv_II_Fnote_Fmt 50 MultiMate Advantage II Footnote File
Multiplan_PC_Fmt 51 Multiplan (PC)
Multiplan_Mac_Fmt 52 Multiplan (Mac)
MS_RTF_Fmt 53 Rich Text Format (RTF)
• • • 254 • Documentum Connector CFS Administration Guide • • KeyView Formats
Table 2 KeyView Formats (continued)
Format Name Format Number Format Description MS_Word_PC_Fmt 54 Microsoft Word for PC
MS_Word_PC_StyleSheet_Fmt 55 Microsoft Word for PC Style Sheet
MS_Word_PC_Glossary_Fmt 56 Microsoft Word for PC Glossary
MS_Word_PC_Driver_Fmt 57 Microsoft Word for PC Driver
MS_Word_PC_Misc_Fmt 58 Microsoft Word for PC Miscellaneous File
NBI_Async_Archive_Fmt 59 NBI Async Archive Format
Navy_DIF_Fmt 60 Navy DIF
NBI_Net_Archive_Fmt 61 NBI Net Archive Format
NIOS_TOP_Fmt 62 NIOS TOP
FileMaker_Mac_Fmt 63 Filemaker MAC
ODA_Q1_11_Fmt 64 ODA / ODIF
ODA_Q1_12_Fmt 65 ODA / ODIF
OLIDIF_Fmt 66 OLIDIF (Olivetti)
Office_Writer_Fmt 67 Office Writer
PC_Paintbrush_Fmt 68 PC Paintbrush Graphics (PCX)
CPT_Comm_Fmt 69 CPT
Lotus_PIC_Fmt 70 Lotus PIC
Mac_PICT_Fmt 71 QuickDraw Picture
Philips_Script_Word_Fmt 72 Philips Script
PostScript_Fmt 73 PostScript
PRIMEWORD_Fmt 74 PRIMEWORD
Quadratron_Q_One_v1_Fmt 75 Q-One V1.93J
Quadratron_Q_One_v2_Fmt 76 Q-One V2.0
SAMNA_Word_IV_Fmt 77 SAMNA Word
Ami_Pro_Draw_Fmt 78 Lotus Ami Pro Draw
SYLK_Spreadsheet_Fmt 79 SYLK
SmartWare_II_WP_Fmt 80 SmartWare II
Symphony_Fmt 81 Symphony
• • • Documentum Connector CFS Administration Guide • 255 • • Appendix A KeyView Format Codes
Table 2 KeyView Formats (continued)
Format Name Format Number Format Description Targa_Fmt 82 Targa
TIFF_Fmt 83 TIFF
Targon_Word_Fmt 84 Targon Word
Uniplex_Ucalc_Fmt 85 Uniplex Ucalc
Uniplex_WP_Fmt 86 Uniplex
MS_Word_UNIX_Fmt 87 Microsoft Word UNIX
WANG_PC_Fmt 88 WANG PC
WordERA_Fmt 89 WordERA
WANG_WPS_Comm_Fmt 90 WANG WPS
WordPerfect_Mac_Fmt 91 WordPerfect MAC
WordPerfect_Fmt 92 WordPerfect
WordPerfect_VAX_Fmt 93 WordPerfect VAX
WordPerfect_Macro_Fmt 94 WordPerfect Macro
WordPerfect_Dictionary_Fmt 95 WordPerfect Spelling Dictionary
WordPerfect_Thesaurus_Fmt 96 WordPerfect Thesaurus
WordPerfect_Resource_Fmt 97 WordPerfect Resource File
WordPerfect_Driver_Fmt 98 WordPerfect Driver
WordPerfect_Cfg_Fmt 99 WordPerfect Configuration File
WordPerfect_Hyphenation_Fmt 100 WordPerfect Hyphenation Dictionary
WordPerfect_Misc_Fmt 101 WordPerfect Miscellaneous File
WordMARC_Fmt 102 WordMARC
Windows_Metafile_Fmt 103 Windows Metafile
Windows_Metafile_NoHdr_Fmt 104 Windows Metafile (no header)
SmartWare_II_DB_Fmt 105 SmartWare II
WordPerfect_Graphics_Fmt 106 WordPerfect Graphics
WordStar_Fmt 107 WordStar
WANG_WITA_Fmt 108 WANG WITA
Xerox_860_Comm_Fmt 109 Xerox 860
• • • 256 • Documentum Connector CFS Administration Guide • • KeyView Formats
Table 2 KeyView Formats (continued)
Format Name Format Number Format Description Xerox_Writer_Fmt 110 Xerox Writer
DIF_SpreadSheet_Fmt 111 Data Interchange Format (DIF)
Enable_Spreadsheet_Fmt 112 Enable Spreadsheet
SuperCalc_Fmt 113 Supercalc
UltraCalc_Fmt 114 UltraCalc
SmartWare_II_SS_Fmt 115 SmartWare II
SOF_Encapsulation_Fmt 116 Serialized Object Format (SOF)
PowerPoint_Win_Fmt 117 PowerPoint PC
PowerPoint_Mac_Fmt 118 PowerPoint MAC
PowerPoint_95_Fmt 119 PowerPoint 95
PowerPoint_97_Fmt 120 PowerPoint 97
PageMaker_Mac_Fmt 121 PageMaker for Macintosh
PageMaker_Win_Fmt 122 PageMaker for Windows
MS_Works_Mac_WP_Fmt 123 Microsoft Works for MAC
MS_Works_Mac_DB_Fmt 124 Microsoft Works for MAC
MS_Works_Mac_SS_Fmt 125 Microsoft Works for MAC
MS_Works_Mac_Comm_Fmt 126 Microsoft Works for MAC
MS_Works_DOS_WP_Fmt 127 Microsoft Works for DOS
MS_Works_DOS_DB_Fmt 128 Microsoft Works for DOS
MS_Works_DOS_SS_Fmt 129 Microsoft Works for DOS
MS_Works_Win_WP_Fmt 130 Microsoft Works for Windows
MS_Works_Win_DB_Fmt 131 Microsoft Works for Windows
MS_Works_Win_SS_Fmt 132 Microsoft Works for Windows
PC_Library_Fmt 133 DOS/Windows Object Library
MacWrite_Fmt 134 MacWrite
MacWrite_II_Fmt 135 MacWrite II
Freehand_Fmt 136 Freehand MAC
Disk_Doubler_Fmt 137 Disk Doubler
• • • Documentum Connector CFS Administration Guide • 257 • • Appendix A KeyView Format Codes
Table 2 KeyView Formats (continued)
Format Name Format Number Format Description HP_GL_Fmt 138 HP Graphics Language
FrameMaker_Fmt 139 FrameMaker
FrameMaker_Book_Fmt 140 FrameMaker
Maker_Markup_Language_Fmt 141 Maker Markup Language
Maker_Interchange_Fmt 142 Maker Interchange Format (MIF)
JPEG_File_Interchange_Fmt 143 Interchange Format
Reflex_Fmt 144 Reflex
Framework_Fmt 145 Framework
Framework_II_Fmt 146 Framework II
Paradox_Fmt 147 Paradox
MS_Windows_Write_Fmt 148 Windows Write
Quattro_Pro_DOS_Fmt 149 Quattro Pro for DOS
Quattro_Pro_Win_Fmt 150 Quattro Pro for Windows
Persuasion_Fmt 151 Persuasion
Windows_Icon_Fmt 152 Windows Icon Format
Windows_Cursor_Fmt 153 Windows Cursor
MS_Project_Activity_Fmt 154 Microsoft Project
MS_Project_Resource_Fmt 155 Microsoft Project
MS_Project_Calc_Fmt 156 Microsoft Project
PKZIP_Fmt 157 ZIP Archive
Quark_Xpress_Fmt 158 Quark Xpress MAC
ARC_PAK_Archive_Fmt 159 PAK/ARC Archive
MS_Publisher_Fmt 160 Microsoft Publisher
PlanPerfect_Fmt 161 PlanPerfect
WordPerfect_Auxiliary_Fmt 162 WordPerfect auxiliary file
MS_WAVE_Audio_Fmt 163 Microsoft Wave
MIDI_Audio_Fmt 164 MIDI
AutoCAD_DXF_Binary_Fmt 165 AutoCAD DXF
• • • 258 • Documentum Connector CFS Administration Guide • • KeyView Formats
Table 2 KeyView Formats (continued)
Format Name Format Number Format Description AutoCAD_DXF_Text_Fmt 166 AutoCAD DXF
dBase_Fmt 167 dBase
OS_2_PM_Metafile_Fmt 168 OS/2 PM Metafile
Lasergraphics_Language_Fmt 169 Lasergraphics Language
AutoShade_Rendering_Fmt 170 AutoShade Rendering
GEM_VDI_Fmt 171 GEM VDI
Windows_Help_Fmt 172 Windows Help File
Volkswriter_Fmt 173 Volkswriter
Ability_WP_Fmt 174 Ability
Ability_DB_Fmt 175 Ability
Ability_SS_Fmt 176 Ability
Ability_Comm_Fmt 177 Ability
Ability_Image_Fmt 178 Ability
XyWrite_Fmt 179 XYWrite / Nota Bene
CSV_Fmt 180 CSV (Comma Separated Values)
IBM_Writing_Assistant_Fmt 181 IBM Writing Assistant
WordStar_2000_Fmt 182 WordStar 2000
HP_PCL_Fmt 183 HP Printer Control Language
UNIX_Exe_PreSysV_VAX_Fmt 184 Unix Executable (PDP-11/pre-System V VAX)
UNIX_Exe_Basic_16_Fmt 185 Unix Executable (Basic-16)
UNIX_Exe_x86_Fmt 186 Unix Executable (x86)
UNIX_Exe_iAPX_286_Fmt 187 Unix Executable (iAPX 286)
UNIX_Exe_MC68k_Fmt 188 Unix Executable (MC680x0)
UNIX_Exe_3B20_Fmt 189 Unix Executable (3B20)
UNIX_Exe_WE32000_Fmt 190 Unix Executable (WE32000)
UNIX_Exe_VAX_Fmt 191 Unix Executable (VAX)
UNIX_Exe_Bell_5_Fmt 192 Unix Executable (Bell 5.0)
UNIX_Obj_VAX_Demand_Fmt 193 Unix Object Module (VAX Demand)
• • • Documentum Connector CFS Administration Guide • 259 • • Appendix A KeyView Format Codes
Table 2 KeyView Formats (continued)
Format Name Format Number Format Description UNIX_Obj_MS8086_Fmt 194 Unix Object Module (old MS 8086)
UNIX_Obj_Z8000_Fmt 195 Unix Object Module (Z8000)
AU_Audio_Fmt 196 NeXT/Sun Audio Data
NeWS_Font_Fmt 197 NeWS bitmap font
cpio_Archive_CRChdr_Fmt 198 cpio archive (CRC Header)
cpio_Archive_CHRhdr_Fmt 199 cpio archive (CHR Header)
PEX_Binary_Archive_Fmt 200 SUN PEX Binary Archive
Sun_vfont_Fmt 201 SUN vfont Definition
Curses_Screen_Fmt 202 Curses Screen Image
UUEncoded_Fmt 203 UU encoded
WriteNow_Fmt 204 WriteNow MAC
PC_Obj_Fmt 205 DOS/Windows Object Module
Windows_Group_Fmt 206 Windows Group
TrueType_Font_Fmt 207 TrueType Font
Windows_PIF_Fmt 208 Program Information File (PIF)
MS_COM_Executable_Fmt 209 PC (.COM)
StuffIt_Fmt 210 StuffIt (MAC)
PeachCalc_Fmt 211 PeachCalc
Wang_GDL_Fmt 212 WANG Office GDL Header
Q_A_DOS_Fmt 213 Q & A for DOS
Q_A_Win_Fmt 214 Q & A for Windows
WPS_PLUS_Fmt 215 WPS-PLUS
DCX_Fmt 216 DCX FAX Format (PCX images)
OLE_Fmt 217 OLE Compound Document
EBCDIC_Fmt 218 EBCDIC Text
DCS_Fmt 219 DCS
UNIX_SHAR_Fmt 220 SHAR
Lotus_Notes_BitMap_Fmt 221 Lotus Notes Bitmap
• • • 260 • Documentum Connector CFS Administration Guide • • KeyView Formats
Table 2 KeyView Formats (continued)
Format Name Format Number Format Description Lotus_Notes_CDF_Fmt 222 Lotus Notes CDF
Compress_Fmt 223 Unix Compress
GZ_Compress_Fmt 224 GZ Compress
TAR_Fmt 225 TAR
ODIF_FOD26_Fmt 226 ODA / ODIF
ODIF_FOD36_Fmt 227 ODA / ODIF
ALIS_Fmt 228 ALIS
Envoy_Fmt 229 Envoy
PDF_Fmt 230 Portable Document Format
BinHex_Fmt 231 BinHex
SMTP_Fmt 232 SMTP
MIME_Fmt 233 MIME
USENET_Fmt 234 USENET
SGML_Fmt 235 SGML
HTML_Fmt 236 HTML
ACT_Fmt 237 ACT
PNG_Fmt 238 Portable Network Graphics (PNG)
MS_Video_Fmt 239 Video for Windows (AVI)
Windows_Animated_Cursor_Fmt 240 Windows Animated Cursor
Windows_CPP_Obj_Storage_Fmt 241 Windows C++ Object Storage
Windows_Palette_Fmt 242 Windows Palette
RIFF_DIB_Fmt 243 RIFF Device Independent Bitmap
RIFF_MIDI_Fmt 244 RIFF MIDI
RIFF_Multimedia_Movie_Fmt 245 RIFF Multimedia Movie
MPEG_Fmt 246 MPEG Movie
QuickTime_Fmt 247 QuickTime Movie
AIFF_Fmt 248 Audio Interchange File Format (AIFF)
Amiga_MOD_Fmt 249 Amiga MOD
• • • Documentum Connector CFS Administration Guide • 261 • • Appendix A KeyView Format Codes
Table 2 KeyView Formats (continued)
Format Name Format Number Format Description Amiga_IFF_8SVX_Fmt 250 Amiga IFF (8SVX) Sound
Creative_Voice_Audio_Fmt 251 Creative Voice (VOC)
AutoDesk_Animator_FLI_Fmt 252 AutoDesk Animator FLIC
AutoDesk_AnimatorPro_FLC_Fmt 253 AutoDesk Animator Pro FLIC
Compactor_Archive_Fmt 254 Compactor / Compact Pro
VRML_Fmt 255 VRML
QuickDraw_3D_Metafile_Fmt 256 QuickDraw 3D Metafile
PGP_Secret_Keyring_Fmt 257 PGP Secret Keyring
PGP_Public_Keyring_Fmt 258 PGP Public Keyring
PGP_Encrypted_Data_Fmt 259 PGP Encrypted Data
PGP_Signed_Data_Fmt 260 PGP Signed Data
PGP_SignedEncrypted_Data_Fmt 261 PGP Signed and Encrypted Data
PGP_Sign_Certificate_Fmt 262 PGP Signature Certificate
PGP_Compressed_Data_Fmt 263 PGP Compressed Data
PGP_ASCII_Public_Keyring_Fmt 264 ASCII-armored PGP Public Keyring
PGP_ASCII_Encoded_Fmt 265 ASCII-armored PGP encoded
PGP_ASCII_Signed_Fmt 266 ASCII-armored PGP encoded
OLE_DIB_Fmt 267 OLE DIB object
SGI_Image_Fmt 268 SGI Image
Lotus_ScreenCam_Fmt 269 Lotus ScreenCam
MPEG_Audio_Fmt 270 MPEG Audio
FTP_Software_Session_Fmt 271 FTP Session Data
Netscape_Bookmark_File_Fmt 272 Netscape Bookmark File
Corel_Draw_CMX_Fmt 273 Corel CMX
AutoDesk_DWG_Fmt 274 AutoDesk Drawing (DWG)
AutoDesk_WHIP_Fmt 275 AutoDesk WHIP
Macromedia_Director_Fmt 276 Macromedia Director
Real_Audio_Fmt 277 Real Audio
• • • 262 • Documentum Connector CFS Administration Guide • • KeyView Formats
Table 2 KeyView Formats (continued)
Format Name Format Number Format Description MSDOS_Device_Driver_Fmt 278 MSDOS Device Driver
Micrografx_Designer_Fmt 279 Micrografx Designer
SVF_Fmt 280 Simple Vector Format (SVF)
Applix_Words_Fmt 281 Applix Words
Applix_Graphics_Fmt 282 Applix Graphics
MS_Access_Fmt 283 Microsoft Access
MS_Access_95_Fmt 284 Microsoft Access 95
MS_Access_97_Fmt 285 Microsoft Access 97
MacBinary_Fmt 286 MacBinary
Apple_Single_Fmt 287 Apple Single
Apple_Double_Fmt 288 Apple Double
Enhanced_Metafile_Fmt 289 Enhanced Metafile
MS_Office_Drawing_Fmt 290 Microsoft Office Drawing
XML_Fmt 291 XML
DeVice_Independent_Fmt 292 DeVice Independent file (DVI)
Unicode_Fmt 293 Unicode
Lotus_123_Worksheet_Fmt 294 Lotus 1-2-3
Lotus_123_Format_Fmt 295 Lotus 1-2-3 Formatting
Lotus_123_97_Fmt 296 Lotus 1-2-3 97
Lotus_Word_Pro_96_Fmt 297 Lotus Word Pro 96
Lotus_Word_Pro_97_Fmt 298 Lotus Word Pro 97
Freelance_DOS_Fmt 299 Lotus Freelance for DOS
Freelance_Win_Fmt 300 Lotus Freelance for Windows
Freelance_OS2_Fmt 301 Lotus Freelance for OS/2
Freelance_96_Fmt 302 Lotus Freelance 96
Freelance_97_Fmt 303 Lotus Freelance 97
MS_Word_95_Fmt 304 Microsoft Word 95
MS_Word_97_Fmt 305 Microsoft Word 97
• • • Documentum Connector CFS Administration Guide • 263 • • Appendix A KeyView Format Codes
Table 2 KeyView Formats (continued)
Format Name Format Number Format Description Excel_Fmt 306 Microsoft Excel
Excel_Chart_Fmt 307 Microsoft Excel
Excel_Macro_Fmt 308 Microsoft Excel
Excel_95_Fmt 309 Microsoft Excel 95
Excel_97_Fmt 310 Microsoft Excel 97
Corel_Presentations_Fmt 311 Corel Presentations
Harvard_Graphics_Fmt 312 Harvard Graphics
Harvard_Graphics_Chart_Fmt 313 Harvard Graphics Chart
Harvard_Graphics_Symbol_Fmt 314 Harvard Graphics Symbol File
Harvard_Graphics_Cfg_Fmt 315 Harvard Graphics Configuration File
Harvard_Graphics_Palette_Fmt 316 Harvard Graphics Palette
Lotus_123_R9_Fmt 317 Lotus 1-2-3 Release 9
Applix_Spreadsheets_Fmt 318 Applix Spreadsheets
MS_Pocket_Word_Fmt 319 Microsoft Pocket Word
MS_DIB_Fmt 320 MS Windows Device Independent Bitmap
MS_Word_2000_Fmt 321 Microsoft Word 2000
Excel_2000_Fmt 322 Microsoft Excel 2000
PowerPoint_2000_Fmt 323 Microsoft PowerPoint 2000
MS_Access_2000_Fmt 324 Microsoft Access 2000
MS_Project_4_Fmt 325 Microsoft Project 4
MS_Project_41_Fmt 326 Microsoft Project 4.1
MS_Project_98_Fmt 327 Microsoft Project 98
Folio_Flat_Fmt 328 Folio Flat File
HWP_Fmt 329 HWP(Arae-Ah Hangul)
ICHITARO_Fmt 330 ICHITARO V4-10
IS_XML_Fmt 331 Extended or Custom XML
Oasys_Fmt 332 Oasys format
PBM_ASC_Fmt 333 Portable Bitmap Utilities ASCII Format
• • • 264 • Documentum Connector CFS Administration Guide • • KeyView Formats
Table 2 KeyView Formats (continued)
Format Name Format Number Format Description PBM_BIN_Fmt 334 Portable Bitmap Utilities Binary Format
PGM_ASC_Fmt 335 Portable Greymap Utilities ASCII Format
PGM_BIN_Fmt 336 Portable Greymap Utilities Binary Format
PPM_ASC_Fmt 337 Portable Pixmap Utilities ASCII Format
PPM_BIN_Fmt 338 Portable Pixmap Utilities Binary Format
XBM_Fmt 339 X Bitmap Format
XPM_Fmt 340 X Pixmap Format
FPX_Fmt 341 FPX Format
PCD_Fmt 342 PCD Format
MS_Visio_Fmt 343 Microsoft Visio
MS_Project_2000_Fmt 344 Microsoft Project 2000
MS_Outlook_Fmt 345 Microsoft Outlook
ELF_Relocatable_Fmt 346 ELF Relocatable
ELF_Executable_Fmt 347 ELF Executable
ELF_Dynamic_Lib_Fmt 348 ELF Dynamic Library
MS_Word_XML_Fmt 349 Microsoft Word 2003 XML
MS_Excel_XML_Fmt 350 Microsoft Excel 2003 XML
MS_Visio_XML_Fmt 351 Microsoft Visio 2003 XML
SO_Text_XML_Fmt 352 StarOffice Text XML
SO_Spreadsheet_XML_Fmt 353 StarOffice Spreadsheet XML
SO_Presentation_XML_Fmt 354 StarOffice Presentation XML
XHTML_Fmt 355 XHTML
MS_OutlookPST_Fmt 356 Microsoft Outlook PST
RAR_Fmt 357 RAR
Lotus_Notes_NSF_Fmt 358 IBM Lotus Notes Database NSF/NTF
Macromedia_Flash_Fmt 359 SWF
MS_Word_2007_Fmt 360 Microsoft Word 2007 XML
MS_Excel_2007_Fmt 361 Microsoft Excel 2007 XML
• • • Documentum Connector CFS Administration Guide • 265 • • Appendix A KeyView Format Codes
Table 2 KeyView Formats (continued)
Format Name Format Number Format Description MS_PPT_2007_Fmt 362 Microsoft PPT 2007 XML
OpenPGP_Fmt 363 OpenPGP Message Format (with new packet format)
Intergraph_V7_DGN_Fmt 364 Intergraph Standard File Format (ISFF) V7 DGN (non-OLE)
MicroStation_V8_DGN_Fmt 365 MicroStation V8 DGN (OLE)
MS_Word_Macro_2007_Fmt 366 Microsoft Word Macro 2007 XML
MS_Excel_Macro_2007_Fmt 367 Microsoft Excel Macro 2007 XML
MS_PPT_Macro_2007_Fmt 368 Microsoft PPT Macro 2007 XML
LZH_Fmt 369 LHA Archive
Office_2007_Fmt 370 Office 2007 document
MS_XPS_Fmt 371 Microsoft XML Paper Specification (XPS)
Lotus_Domino_DXL_Fmt 372 IBM Lotus representation of Domino design elements in XML format
ODF_Text_Fmt 373 ODF Text
ODF_Spreadsheet_Fmt 374 ODF Spreadsheet
ODF_Presentation_Fmt 375 ODF Presentation
Legato_Extender_ONM_Fmt 376 Legato Extender Native Message ONM
bin_Unknown_Fmt 377 n/a
TNEF_Fmt 378 Transport Neutral Encapsulation Format (TNEF)
CADAM_Drawing_Fmt 379 CADAM Drawing
CADAM_Drawing_Overlay_Fmt 380 CADAM Drawing Overlay
NURSTOR_Drawing_Fmt 381 NURSTOR Drawing
HP_GLP_Fmt 382 HP Graphics Language (Plotter)
ASF_Fmt 383 Advanced Systems Format (ASF)
WMA_Fmt 384 Window Media Audio Format (WMA)
WMV_Fmt 385 Window Media Video Format (WMV)
EMX_Fmt 386 Legato EMailXtender Archives Format (EMX)
Z7Z_Fmt 387 7 Zip Format (7z)
• • • 266 • Documentum Connector CFS Administration Guide • • KeyView Formats
Table 2 KeyView Formats (continued)
Format Name Format Number Format Description MS_Excel_Binary_2007_Fmt 388 Microsoft Excel Binary 2007
CAB_Fmt 389 Microsoft Cabinet File (CAB)
CATIA_Fmt 390 CATIA Formats (CAT*)
YIM_Fmt 391 Yahoo Instant Messenger History
ODF_Drawing_Fmt 392 ODF Drawing
Founder_CEB_Fmt 393 Founder Chinese E-paper Basic (CEB)
QPW_Fmt 394 Quattro Pro 9+ for Windows
MHT_Fmt 395 MHT format
MDI_Fmt 396 Microsoft Document Imaging Format
GRV_Fmt 397 Microsoft Office Groove Format
IWWP_Fmt 398 Apple iWork Pages format
IWSS_Fmt 399 Apple iWork Numbers format
IWPG_Fmt 400 Apple iWork Keynote format
BKF_Fmt 401 Windows Backup File
MS_Access_2007_Fmt 402 Microsoft Access 2007
ENT_Fmt 403 Microsoft Entourage Database Format
DMG_Fmt 404 Mac Disk Copy Disk Image File
CWK_Fmt 405 AppleWorks File
OO3_Fmt 406 Omni Outliner File
OPML_Fmt 407 Omni Outliner File
Omni_Graffle_XML_File 408 Omni Graffle XML File
PSD_Fmt 409 Photoshop Document
Apple_Binary_PList_Fmt 410 Apple Binary Property List format
Apple_iChat_Fmt 411 Apple iChat format
OOUTLINE_Fmt 412 OOutliner File
BZIP2_Fmt 413 Bzip 2 Compressed File
ISO_Fmt 414 ISO-9660 CD Disc Image Format
DocuWorks_Fmt 415 DocuWorks Format
• • • Documentum Connector CFS Administration Guide • 267 • • Appendix A KeyView Format Codes
Table 2 KeyView Formats (continued)
Format Name Format Number Format Description RealMedia_Fmt 416 RealMedia Streaming Media
AC3Audio_Fmt 417 AC3 Audio File Format
NEF_Fmt 418 Nero Encrypted File
SolidWorks_Fmt 419 SolidWorks Format Files
XFDL_Fmt 420 Extensible Forms Description Language
Apple_XML_PList_Fmt 421 Apple XML Property List format
OneNote_Fmt 422 OneNote Note Format
Dicom_Fmt 424 Digital Imaging and Communications in Medicine
EnCase_Fmt 425 Expert Witness Compression Format (EnCase)
Scrap_Fmt 426 Shell Scrap Object File
MS_Project_2007_Fmt 427 Microsoft Project 2007
MS_Publisher_98_Fmt 428 Microsoft Publisher 98/2000/2002/2003/2007
Skype_Fmt 429 Skype Log File
Hl7_Fmt 430 Health level7 message
MS_OutlookOST 431 Microsoft Outlook OST
Epub_Fmt 432 Electronic Publication
MS_OEDBX_Fmt 433 Microsoft Outlook Express DBX
BB_Activ_Fmt 434 BlackBerry Activation File
DiskImage_Fmt 435 Disk Image
Milestone_Fmt 436 Milestone Document
E_Transcript_Fmt 437 RealLegal E-Transcript File
PostScript_Font_Fmt 438 PostScript Type 1 Font
Ghost_DiskImage_Fmt 439 Ghost Disk Image File
JPEG_2000_JP2_File_Fmt 440 JPEG-2000 JP2 File Format Syntax (ISO/IEC 15444-1)
Unicode_HTML_Fmt 441 Unicode HTML
CHM_Fmt 442 Microsoft Compiled HTML Help
EMCMF_Fmt 443 Documentum EMCMF format
• • • 268 • Documentum Connector CFS Administration Guide • • KeyView Formats
Table 2 KeyView Formats (continued)
Format Name Format Number Format Description MS_Access_2007_Tmpl_Fmt 444 Microsoft Access 2007 Template
Jungum_Fmt 445 Samsung Electronics Jungum Global document
JBIG2 446 JBIG2 File Format
• • • Documentum Connector CFS Administration Guide • 269 • • Appendix A KeyView Format Codes
• • • 270 • Documentum Connector CFS Administration Guide • • Glossary
A
ACI (Autonomy Content The Autonomy Content Infrastructure is a technology layer that automates Infrastructure) operations on unstructured information for cross-enterprise applications, thus enabling an automated and compatible business-to-business, peer-to-peer infrastructure. The ACI allows enterprise applications to understand and process content that exists in unstructured formats, such as e-mail, Web pages, office documents, and Lotus Notes.
ACL (access control list) An ACL is a set of data associated with a document that defines which users, groups, and roles are permitted to access a document or data source (for example, an Oracle database or Windows file system).
C
connector A connector is an Autonomy fetching solution (such as HTTP Connector, Oracle Connector, Exchange Connector, and so on) that allows you to retrieve information from any type of local or remote repository such as a database or Web site. It imports the fetched documents into IDX or XML file format and indexes them into IDOL Server, from where you can retrieve them (for example by sending queries to IDOL Server).
D
database An Autonomy database is an IDOL Server data pool that stores indexed information. The administrator can set up one or more databases and specify how data is fed to the databases. You can retrieve information that is indexed in the IDOL Server database by sending a query to the IDOL Server.
DIH (Distributed Action The Distributed Index Handler allows you to efficiently split and index Handler) extremely large quantities of data into multiple IDOL Servers to create a completely scalable solution that delivers high performance and high availability. It provides a flexible way of transparently batching, routing, and categorizing the indexing of internal and external content into the IDOL Server.
• • • Documentum Connector CFS Administration Guide • 271 • • Glossary
DiSH (Distributed The Distributed Service Handler provides a unified way to communicate with Service Handler) all Autonomy services from a centralized location. It also facilitates the licensing that enables you to run Autonomy solutions. You must have an Autonomy DiSH server running on a machine with a static known IP address.
F
fetch The process of downloading documents from the repository in which they are stored (such as a local folder, Web site, database, Lotus Domino server, and so on), importing them to IDX format, and indexing them into an IDOL Server.
I
IAS (Intellectual Asset The Intellectual Asset Protection System provides an integrated security Protection System) solution to protect your data. At the front end, authentication checks users are allowed to access the system on which result data is displayed. At the back end, entitlement checking and authentication combine to ensure query results only contain documents the user is allowed to see from repositories the user is allowed to access.
IDOL Server Using Autonomy connectors, Autonomy's Intelligent Data Operating Layer (IDOL) server integrates unstructured, semi-structured, and structured information from multiple repositories through an understanding of the content, delivering a real-time environment in which operations across applications and content are automated, removing all the manual processes involved in getting the right information to the right people at the right time.
IDX Apart from XML files, only files in IDX format can be indexed into IDOL Server. You can use a connector to import files into this format or manually create IDX files.
importing After a document has been downloaded from the repository in which it is stored, it is imported to an IDX or XML file format. This process is called “importing.”
Index fields Store fields containing text which you want to query frequently as index fields. Index fields are processed linguistically when they are stored in IDOL Server. This means stemming and stop lists are applied to text in index fields before they are stored, which allows IDOL Server to process queries for these fields more quickly. Typically, the fields DRETITLE and DRECONTENT are set up as index fields.
indexing After documents have been imported to IDX file format, their content (or links to the original documents) is stored in an IDOL Server. This process is called “indexing.”
• • • 272 • Documentum Connector CFS Administration Guide • • Q
query You can submit a natural language query to IDOL Server which analyzes the concept of the query and returns documents that are conceptually similar to the query. You can also submit other query and search types to IDOL Server, such as Boolean, bracketed Boolean, and keyword searches.
S
Search Unlike ordinary searches that look for keywords, the Autonomy Search allows you to enter a natural language query. The concept of the query is analyzed and documents relevant to this concept are returned to you.
• • • Documentum Connector CFS Administration Guide • 273 • • Glossary
• • • 274 • Documentum Connector CFS Administration Guide • • Index
A file sections 47 string values 46, 60 abs_path method 88 configuration file access control list (ACL) 271 example 51 AciPort configuration parameter 193 JobName section 51 ACLUsernameField (configuration setting) 104, 108 Logging section 48 actions Server section 47 GetConfig 234 Service section 47 GetLogStream 234 configuration parameters GetLogStreamNames 235 AciPort 193 GetStatistics 235 AdminClients (CFS) 180, 203 GetStatus 242 CleanOnStart 132 GetStatusInfo 242 CompressIndexFiles 193 Stop 243 ConnectorGroup 126 addField method 70 ConnectorPriority 126 AdminClients (CFS) configuration parameter 180, DataPort 204 203 DataPortClients 205 appendContent method 71 DataPortN 127 at method 77 DataPortThreads 205 attr method 77 DatastoreDirectory 133 Autonomy Content Infrastructure (ACI) 271 DatastoreFile 132 autpassw.exe 115 DeleteN 185 DREHost 194 B EnableExtraction 133 boolean EnableExtractionCopy 133 values 46, 60 EnableIngestion 143 BrowseSecurity (configuration setting) 104 EnableScheduledTasks 134 BrowseSecurityField (configuration setting) 105 EnableViewServer 130 EncryptACLEntries 135 C ExtractDirectory 188 FilePath 120 CleanOnStart configuration parameter 132 Full 198 CompressIndexfiles configuration parameter 193 GroupServerHost 153 configuration 45 GroupServerPort 153 boolean values 46, 60 GroupServerRepository 154 example configuration file 51
• • • Documentum Connector CFS Administration Guide • 275 • • Index
GroupServerSSLConfig 154 LibraryName 120 HashedDestinationDirectory 135 LicenseServerACIPort 199 HashedTempDirectory 136 LicenseServerHost 200 HashN 184 LicenseServerRetries 201 Holder 198 LicenseServerTimeout 200 Host 130 LogArchiveDirectory 208 HostN 127 LogCompressionMode 209 ImportFamilyRootExcludeFmtCSV 188 LogDirectory 209 ImportHashFamilies 189 LogEcho 210 ImportInheritFieldsCSV 190 LogExpireAction 210 ImportMergeMails 190 LogFile 211 IndexBatchSize 194 LogHistorySize 212 IndexDatabase 144 LogLevel 212 IndexTimeInterval 194 LogLevelMatch 213 IngestActions 144 LogMaxLineLength 215 IngestAddAsupdate 145 LogMaxOldFiles 215 IngestBatchSize 145 LogMaxSizeKBs 216 IngestCheckFinished 145 LogOldAction 217 IngestConfigSection 140 LogOutputLogLevel 218 IngestConnectorConfigSection 146 LogSysLog 218 IngestDelayMS 147 LogTime 219 IngestEnableAdds 147 LogTypeCSVs 219 IngestEnableDeletes 148 LuaScript 121 IngestEnableUpdates 148 MaxImportQueueSize 191 IngesterType 149 MaximumThreads 121, 182 IngestHashedSharedPath 148 MaxQueueSize 122, 182 IngestHost 150 MaxScheduledSize 122 IngestKeepFiles 150 N 141 IngestPort 147, 151 Number 141 IngestSendByType 151 OnError 123 IngestSSLConfig 152 OnErrorReport 123 IngestWriteIDX 152 OnFinish 124 InsertActions 136 OnStart 124 InsertFailedDirectory 137 Operation 201 JavaClasspath 155 Port 131, 151, 205 JavaConnectorClass 156, 157 Port (CFS) 181 JavaLibraryPath 156 PortN 128 JavaVerboseGC 158 PostN 183 JVMLibraryPath 157 PreN 184 Key 198 QueryClients (CFS) 181, 206 KeyviewDirectory 125, 190 RegisterConnector 128 KillDuplicates 195 RevisionMarks 191
• • • 276 • Documentum Connector CFS Administration Guide • • ScheduleCycles 142 ExtensionCSVs 108 ScheduleRepeatSecs 142 FieldQueryN 109 ScheduleStartTime 143 FieldQueryNameN 109 SectionerMaxBytes 186 FieldQueryValueN 110 SectionerMinBytes 187 FolderCSVs 110 SectionerSeparatorsN 187 FolderNegation 111 ServiceACIMode 246 FolderRecursion 111 ServiceControlClients 246 GetChildOfVirtualDoc 112 ServiceHost 247 IgnoreContentCSVs 112 ServicePort 247 Incremental 113 ServiceStatusClients 248 MappedSecurity 114 SharedPath 129, 131 MappedSecurityField 115 SSLCACertificate 226 Password 115 SSLCACertificatessPath 226 PreAppendDocBase 115 SSLCertificate 228 SelectStatement 116 SSLCheckCertificate 228 UseGlobalUids 117 SSLCheckCommonName 229 Username 117 SSLConfig 224 connector 271 SSLConfigN 129 Connector Framework server 25, 50, 103 SSLMethod 229 configure 61 SSLPrivateKey 230 IDX Writer 183 SSLPrivateKeyPassword 231 parameters SynchronizeKeepDatastore 137 AciPort 193 SynchronizeThreads 137, 139 CompressIndexFiles 193 TaskMaxAdds 138 DeleteN 185 TaskMaxDuration 138 DREHost 194 TempDirectory 139 ExtractDirectory 188 ThreadCount 192 HashN 184 UpdateN 185 ImportFamilyRootExcludeFmtCSV 188 Url 124 ImportHashFamilies 189 XsltDLL 140, 192 ImportInheritFieldsCSV 190 Configuration setting ImportMergeMails 190 ACLUsernameField 104, 108 IndexBatchSize 194 BrowseSecurity 104 IndexTimeInterval 194 BrowseSecurityField 105 KeyviewDirectory 190 ContentFormatPreferenceCSV 105, 116 KillDuplicates 195 CustomFieldExtractNameN 105 MaxImportQueueSize 191 CustomFieldExtractToNameN 106 MaximumThreads 182 CustomFieldSelectStatement 106 PostN 183 DeleteSelectStatement 107 PreN 184 Docbase 107 RevisionMarks 191 Domain 108 SectionerMaxBytes 186
• • • Documentum Connector CFS Administration Guide • 277 • • Index
SectionerMinBytes 187 copyField 71 SectionerSeparatorsN 187 deleteField 71 ThreadCount 192 getContent 71, 74 UpdateN 185 getFieldNames 72 ConnectorGroup configuration parameter 126 getFieldValue 72 ConnectorPriority configuration parameter 126 getFieldValues 72 content method 77 getNextSection 73 ContentFormatPreferenceCSV (configuration hasfield 73 setting) 105, 116 renamefield 73 convert_date_time method 87 setFieldValue 74 copy_file method 89 writeStubIdx 74 copyField method 71 Documentum Foundation Classes 25 create_path method 89 Documentum ID 26 create_uuid method 86 Documentum repository 26 CustomFieldExtractNameN (configuration setting) Domain (configuration setting) 108 105 DREHost configuration parameter 194 CustomFieldExtractToNameN (configuration setting) 106 E CustomFieldSelectStatement (configuration setting) 106 EnableExtraction configuration parameter 133 EnableExtractionCopy configuration parameter 133 D EnableIngestion configuration parameter 143 EnableScheduledTasks configuration parameter database 271 134 DataPort configuration parameter 204 EnableViewServer configuration parameter 130 DataPortClients configuration parameter 205 encrypt_security_field method 86 DataPortN configuration parameter 127 EncryptACLEntries configuration parameter 135 DataPortThreads configuration parameter 205 example configuration file 51 DatastoreDirectory configuration parameter 133 ExtensionCSVs (configuration setting) 108 DatastoreFile configuration parameter 132 ExtractDirectory configuration parameter 188 delete_file method 89 deleteField method 71 F DeleteN configuration parameter 185 DeleteSelectStatement (configuration setting) 107 fetch 272 directory structure fieldGetValue method 93 UNIX 42 FieldQueryN (configuration setting) 109 Windows 37 FieldQueryNameN (configuration setting) 109 Distributed Action Handler (DIH) 271 FieldQueryValueN (configuration setting) 110 Distributed Service Handler (DiSH) 272 fieldSetValue method 93 Docbase (configuration setting) 107 file_setdates method 90 Document Objects methods FilePath configuration parameter 120 addField 70 findField method 93 appendContent 71 firstChild method 78
• • • 278 • Documentum Connector CFS Administration Guide • • FolderCSVs (configuration setting) 110 I FolderNegation (configuration setting) 111 IDOL 27 FolderRecursion (configuration setting) 111 IDOL Server 272 Full configuration parameter 198 IDOL server 26 IDX 272 G IgnoreContentCSVs (configuration setting) 112 get_config method 82 Import Module Advanced GetChildOfVirtualDoc (configuration setting) 112 C methods 67 GetConfig service action 234 ImportFamilyRootExcludeFmtCSV configuration getContent method 71, 74 parameter 188 getcwd method 90 ImportHashFamilies configuration parameter 189 getEncryptedValue method 83 importing 272 getFieldNames method 72 ImportInheritFieldsCSV configuration parameter getFieldValue method 72, 93 190 getFieldValues method 72 ImportMergeMails configuration parameter 190 GetLogStream service action 234 Incremental (configuration setting) 113 GetLogStreamNames service action 235 Index fields 272 getNextSection method 73 IndexBatchSize configuration parameter 194 GetStatistics service action 235 IndexDatabase configuration parameter 144 GetStatus service action 242 indexing 272 GetStatusInfo service action 242 IndexTimeInterval configuration parameter 194 getValue method 83 IngestActions configuration parameter 144 getValues method 84 IngestAddAsUpdate configuration parameter 145 gobble_whitespace method 84 IngestBatchSize configuration parameter 145 GroupServerHost configuration parameter 153 IngestCheckFinished configuration parameter 145 GroupServerPort configuration parameter 153 IngestConfigSectionTime configuration parameter 140 GroupServerRepository configuration parameter 154 IngestConnectorConfigSection configuration parameter 146 GroupServerSSLConfig configuration parameter 154 IngestDelayMS configuration parameter 147 IngestEnableAdds configuration parameter 147 H IngestEnableDeletes configuration parameter 148 IngestEnableUpdates configuration parameter 148 hasField method 73 IngesterType configuration parameter 149 hash_file method 87 IngestHashedSharedPath configuration parameter hash_string method 85 148 HashedDestinationDirectory configuration parameter IngestHost configuration parameter 150 135 Ingestion server 50, 103 HashedTempDirectory configuration parameter 136 IngestKeepFiles configuration parameter 150 HashN configuration parameter 184 IngestPort configuration parameter 147, 151 Holder configuration parameter 198 IngestSendByType configuration parameter 151 Host configuration parameter 130 IngestSSLConfig configuration parameter 152 HostN configuration parameter 127
• • • Documentum Connector CFS Administration Guide • 279 • • Index
IngestWriteIDX configuration parameter 152 Logging section (configuration file) 48 InsertActions configuration parameter 136 LogHistorySize configuration parameter 212 InsertFailedDirectory configuration parameter 137 LogLevel configuration parameter 212 installation 33 LogLevelMatch configuration parameter 213 standalone 40 LogMaxLineLength configuration parameter 215 Windows 35 LogMaxOldFiles configuration parameter 215 Intellectual Asset Protection System (IAS) 272 LogMaxSizeKBs configuration parameter 216 is_dir method 91 LogOldAction configuration parameter 217 LogOutputLogLevel configuration parameter 218 J LogSysLog configuration parameter 218 LogTime configuration parameter 219 JavaClasspath configuration parameter 155 LogTypeCSVs configuration parameter 219 JavaConnectorClass configuration parameter 156, LuaScript configuration parameter 121 157 JavaLibraryPath configuration parameter 156 JavaVerboseGC configuration parameter 158, 51 M JVMLibraryPath configuration parameter 157 MappedSecurity (configuration setting) 114 MappedSecurityField (configuration setting) 115 K MaximumThreads configuration parameter 121, 182 MaxQueueSize configuration parameter 122, 182 Key configuration parameter 198 MaxScheduledSize configuration parameter 122 KeyView move_file method 91 formats 251 KeyviewDirectory configuration parameter 125, 190, 191 N KillDuplicates configuration parameter 195 N configuration parameter 141 name method 78, 80 L next method 78, 80 lastChild method 78 nodePath method 79 LibraryName configuration parameter 120 Number configuration parameter 141 LicenseServerACIPort configuration parameter 199 LicenseServerHost configuration parameter 200 O LicenseServerRetries configuration parameter 201 OnError configuration parameter 123 LicenseServerTimeout configuration parameter 200 OnErrorReport configuration parameter 123 log method 92 OnFinish configuration parameter 124 LogArchiveDirectory configuration parameter 208 OnStart configuration parameter 124 LogCompressionMode configuration parameter 209 Operation configuration parameter 201 LogDirectory configuration parameter 209 LogEcho configuration parameter 210 P LogExpireAction configuration parameter 210 LogFile configuration parameter 211 parent method 79 logging parse_csv method 85 set up log streams 57 parse_xml method 86
• • • 280 • Documentum Connector CFS Administration Guide • • password GetStatusInfo 242 encrypt 55 Stop 243 Password (configuration setting) 115 Service section (configuration file) 47 Port (CFS) configuration parameter 181 ServiceACIMode configuration parameter 246 Port configuration parameter 131, 151, 205 ServiceControlClients configuration parameter 246 PortN configuration parameter 128 ServiceHost configuration parameter 247 PostN configuration parameter 183 ServicePort configuration parameter 247 PreAppendDocBase (configuration setting) 115 ServiceStatusClients configuration parameter 248 PreN configuration parameter 184 set up prev method 79, 80 Log streams 57 setFieldValue method 74, 93 Q SharedPath configuration parameter 129, 131 size method 77 query 273 sleep method 93 QueryClients (CFS) configuration parameter 181, SSLCACertificate configuration parameter 226 206 SSLCACertificatesPath configuration parameter 226 R SSLCertificate configuration parameter 228 RegisterConnector configuration parameter 128 SSLCheckCertificate configuration parameter 228 renameField method 73 SSLCheckCommonName configuration parameter RevisionMarks configuration parameter 191 229 root method 75 SSLConfig configuration parameter 224 SSLConfigN configuration parameter 129 S SSLMethod configuration parameter 229 SSLPrivateKey configuration parameter 230 ScheduleCycles configuration parameter 142 SSLPrivateKeyPassword configuration parameter ScheduleRepeatSecs configuration parameter 142 231 ScheduleStartTime configuration parameter 143 stop a connector 55 Search 273 Stop service action 243 SectionerMaxBytes configuration parameter 186 string values 46, 60 SectionerMinBytes configuration parameter 187 SynchronizeKeepDatastore configuration parameter SectionerSeparatorsN configuration parameter 187 137 Secure Socket Layer connections 223 SynchronizeThreads configuration parameter 137, SelectStatement (configuration setting) 116 139 send_aci_action method 81 system requirements 33 send_aci_command method 82 Server section (configuration file) 47 T service actions TaskMaxAdds configuration parameter 138 GetConfig 234 TaskMaxDuration configuration parameter 138 GetLogStream 234 TempDirectory configuration parameter 139 GetLogStreamNames 235 ThreadCount configuration parameter 192 GetStatistics 235 type method 79, 80 GetStatus 242
• • • Documentum Connector CFS Administration Guide • 281 • • Index
U getEncryptedValue 83 getFieldValue 93 UNIX getValue 83 system requirements 35 getValues 84 unzip_file method 91 gobble_whitespace 84 UpdateN configuration parameter 185 hash_file 87 Url configuration parameter 124 hash_string 85 UseGlobalUids (configuration setting) 117 is_dir 91 Username (configuration setting) 117 log 92 move_file 91 V name 80 value method 81 next 80 parse_csv 85 W parse_xml 86 prev 80 Windows send_aci_action 81 directory structure 37 send_aci_command 82 installation 35 setFieldValue 93 system requirements 34 sleep 93 writeStubIdx method 74 type 80 unzip_file 91 X value 81 XML document methods zip_file 92 root 75 XmlNode methods 77 XPathExecute 75 attr 77 XPathRegisterNs 75 content 77 XPathValue 76 firstChild 78 XPathValues 76 lastChild 78 XmlAttr methods 80 name 78 abs_path 88 next 78 convert_date_time 87 nodePath 79 copy_file 89 parent 79 create_path 89 prev 79 create_uuid 86 type 79 delete_file 89 XmlNodeSet Methods 77 encrypt_security_field 86 XmlNodeSet methods fieldGetValue 93 at 77 fieldSetValue 93 size 77 file_setdates 90 XPathExecute method 75 findField 93 XPathRegisterNs method 75 get_config 82 XPathValue method 76 getcwd 90 XPathValues method 76
• • • 282 • Documentum Connector CFS Administration Guide • • XsltDLL configuration parameter 140, 192
Z zip_file method 92
• • • Documentum Connector CFS Administration Guide • 283 • • Index
• • • 284 • Documentum Connector CFS Administration Guide • •