IDOL Oracle UCM Connecter™ Administration Guide

Version 7.5 Document Revision 0 14 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.

11 October 2011 Contents

Preface...... 13 Version...... 13 Notational Conventions ...... 14 Command-line Syntax Conventions ...... 15 Notices...... 16 Related Documentation...... 16 Support and Contact Information...... 17 Download the Latest Documentation ...... 17 Contact Autonomy Technical Support ...... 18 Contact Autonomy ...... 18

Part 1 Getting Started

Chapter 1  Introduction ...... 23 Overview ...... 23 About Connector Framework Server ...... 24 System Architecture ...... 25 Import Process...... 26

Chapter 2  Installation...... 27 System Requirements...... 27 Supported Platforms ...... 27 Minimum Server Requirements ...... 28 Install Oracle UCM Connecter on Windows ...... 28 Directory Structure ...... 30 Connector Framework Server Directory Structure ...... 30

• • • Oracle UCM Connecter Administration Guide • 3 • • Contents

Oracle UCM Connecter Directory Structure ...... 32 Install Oracle UCM Connecter on Linux ...... 33 Directory Structure—Linux ...... 35 Connector Framework Server Directory Structure ...... 35 Oracle UCM Connecter Directory Structure ...... 38

Chapter 3  Configure Oracle UCM Connecter...... 41 Oracle UCM Connecter Configuration File...... 42 Modify Parameters ...... 42 Enter Boolean Values ...... 42 Enter String Values ...... 42 Configuration File Sections...... 43 License Section ...... 43 Server Section ...... 43 Service Section ...... 44 Ingestion Section ...... 44 Logging Section ...... 44 Connector Section ...... 45 FetchTasks Section ...... 46 TaskName Section ...... 46 Example Configuration File ...... 47 Start and Stop the Connector ...... 50 Start the Connector ...... 50 Stop the Connector ...... 50 Encrypt Passwords ...... 51 Set Up Log Streams ...... 53 Set Up Secure Socket Layer Connections ...... 54

Chapter 4  Configure Connector Framework Server...... 57 Connector Framework Server Configuration File...... 57 Modify Parameters ...... 58 Enter Boolean Values ...... 58 Enter String Values ...... 58 Configure Connector Framework Server ...... 59 Example Configuration File...... 59

• • • 4 • Oracle UCM Connecter Administration Guide • • Contents

Chapter 5  Use Lua Scripts ...... 63 Use Lua Scripts within the CFS ...... 63 Configure a Lua Script ...... 64 Write a Lua Script ...... 64 Method Reference ...... 65 Document Objects Methods ...... 68 addField ...... 68 appendContent ...... 69 copyField ...... 69 deleteField ...... 69 getContent ...... 69 getFieldNames ...... 70 getFieldValue ...... 70 getFieldValues ...... 70 getNextSection ...... 71 hasField ...... 71 renameField ...... 71 setContent ...... 72 setFieldValue ...... 72 writeStubIdx ...... 72 XMLDocument Methods ...... 73 root ...... 73 XPathExecute ...... 73 XPathRegisterNs ...... 73 XPathValue ...... 74 XPathValues ...... 74 XmlNodeSet Methods ...... 75 at ...... 75 size ...... 75 XmlNode Methods ...... 75 attr ...... 75 content ...... 75 firstChild ...... 76 lastChild ...... 76 name ...... 76 next ...... 76 nodePath ...... 77 parent ...... 77 prev ...... 77

• • • Oracle UCM Connecter Administration Guide • 5 • • Contents

type ...... 77 XmlAttr Methods ...... 78 name ...... 78 next ...... 78 prev ...... 78 type ...... 78 value ...... 79 ACI Methods ...... 79 send_aci_action ...... 79 send_aci_command ...... 80 Config Methods ...... 80 get_config ...... 80 getEncryptedValue ...... 81 getValue ...... 81 getValues ...... 82 String Methods ...... 82 gobble_whitespace ...... 82 hash_string ...... 83 parse_csv ...... 83 parse_xml ...... 84 Document Methods ...... 84 create_uuid ...... 84 encrypt_security_field ...... 84 hash_file ...... 85 Date Methods ...... 85 convert_date_time ...... 85 File System Methods ...... 86 abs_path ...... 86 copy_file ...... 87 create_path ...... 87 delete_file ...... 87 file_setdates ...... 88 getcwd ...... 88 is_dir ...... 89 move_file ...... 89 unzip_file ...... 89 zip_file ...... 90 Miscellaneous Methods ...... 90 log ...... 90

• • • 6 • Oracle UCM Connecter Administration Guide • • Contents

sleep ...... 91 Change the Value of a Field ...... 91 Example Script ...... 92 Use Lua Scripts Within the Connector ...... 93 Introduction ...... 93 Example Lua Script ...... 93

Part 2 Parameter and Command Reference

Chapter 6  Oracle UCM Connecter Configuration Parameters ...... 99 Service Parameters ...... 99 Server Parameters ...... 100 Port ...... 100 License Parameters ...... 101 Logging Parameters ...... 101 Connector Parameters ...... 101 Ingestion Parameters ...... 101 FetchTasks/TaskName Parameters ...... 102 EncryptSecurityEntries ...... 102 IndexDatabase ...... 103 MappedSecurity ...... 103 MappedSecurityField ...... 103 MaxWaitTime ...... 104 Password ...... 104 QueryText ...... 105 ResultCount ...... 105 SecurityType ...... 106 SynchronizeThreads ...... 106 ucmMetaFieldPrefix ...... 106 UCMWebPort ...... 107 UCMWebServer ...... 107 URI ...... 108 UserName ...... 108

Chapter 7  Parameters Common to CFS Connectors...... 109 ACI Server Configuration ...... 110 LibraryName ...... 110

• • • Oracle UCM Connecter Administration Guide • 7 • • Contents

MaximumThreads ...... 110 MaxQueueSize ...... 111 MaxScheduledSize ...... 111 OnError ...... 112 OnErrorReport ...... 113 OnFinish ...... 113 OnStart ...... 113 Url ...... 114 Import Service ...... 114 KeyviewDirectory ...... 115 Distributed Connector ...... 115 ConnectorGroup ...... 115 Host ...... 116 Port ...... 116 RegisterConnector ...... 116 SharedPath ...... 117 View Server ...... 118 EnableViewServer ...... 118 Host ...... 118 Port ...... 119 SharedPath ...... 119 General Connector Parameters ...... 120 CleanOnStart ...... 120 DatastoreFile ...... 120 EnableExtraction ...... 121 EnableExtractionCopy ...... 121 EnableScheduledTasks ...... 122 EncryptACLEntries ...... 122 InsertFailedDirectory ...... 123 SynchronizeKeepDatastore ...... 123 SynchronizeThreads ...... 123 TaskMaxAdds ...... 124 TaskMaxDuration ...... 124 TaskThreads ...... 125 TempDirectory ...... 125 XsltDLL ...... 126 Fetch Task Configuration ...... 126 N ...... 126 Number ...... 127 ScheduleCycles ...... 127

• • • 8 • Oracle UCM Connecter Administration Guide • • Contents

ScheduleRepeatSecs ...... 128 ScheduleStartTime ...... 128 Ingestion ...... 129 EnableIngestion ...... 129 IndexDatabase ...... 129 IngestActions ...... 130 IngestAddAsUpdate ...... 130 IngestBatchSize ...... 131 IngestCheckFinished ...... 131 IngestDelayMS ...... 132 IngestEnableAdds ...... 132 IngestEnableDeletes ...... 132 IngestEnableUpdates ...... 133 IngesterType ...... 133 IngestHost ...... 134 IngestKeepFiles ...... 134 IngestPort ...... 135 IngestSendByType ...... 135 IngestSharedPath ...... 135 IngestSSLConfig ...... 136 IngestWriteIDX ...... 136

Chapter 8  Parameters Common to CFS Connectors Using Java ...... 137 JavaClassPath ...... 137 JavaConnectorClass ...... 138 JavaLibraryPath ...... 138 JavaMaxMemoryMB ...... 139 JVMLibraryPath ...... 139 JavaVerboseGC ...... 140

Chapter 9  CFS Connector Actions ...... 141 Synchronous Versus Asynchronous Actions ...... 142 QueueInfo Fetch Action...... 142 Synchronize Fetch Action...... 144 Collect Fetch Action ...... 146 Identifiers Fetch Action...... 149 Insert Fetch Action ...... 151

• • • Oracle UCM Connecter Administration Guide • 9 • • Contents

Delete/Remove Fetch Action ...... 154 Hold and ReleaseHold Fetch Actions ...... 155 Update Action...... 157 View Action...... 158 StopFetch Action ...... 159

Chapter 10  Connector Framework Server Parameters...... 161 Service Parameters ...... 162 Server Parameters ...... 162 AdminClients ...... 162 Port ...... 163 QueryClients ...... 163 Actions Parameters ...... 164 MaxQueueSize ...... 164 MaximumThreads ...... 164 Import Tasks and their Parameters ...... 165 PostN ...... 165 PreN ...... 166 HashN ...... 166 DeleteN ...... 167 UpdateN ...... 167 Additional Task Types ...... 168 SectionerMaxBytes ...... 168 SectionerMinBytes ...... 169 SectionerSeparatorsN ...... 169 Import Service Parameters ...... 170 ExtractDirectory ...... 170 ImportFamilyRootExcludeFmtCSV ...... 170 ImportHashFamilies ...... 171 ImportInheritFieldsCSV ...... 172 ImportMergeMails ...... 172 KeyviewDirectory ...... 172 MaxImportQueueSize ...... 173 RevisionMarks ...... 173 ThreadCount ...... 174 XsltDLL ...... 174 Indexing Parameters ...... 175 ACIPort ...... 175 CompressIndexFiles ...... 175

• • • 10 • Oracle UCM Connecter Administration Guide • • Contents

DREHost ...... 176 IndexBatchSize ...... 176 IndexTimeInterval ...... 176 KillDuplicates ...... 177

Chapter 11  License Configuration Parameters...... 179 Full ...... 180 Holder ...... 180 Key ...... 180 LicenseServerACIPort ...... 181 LicenseServerHost ...... 182 LicenseServerTimeout ...... 182 LicenseServerRetries ...... 183 Operation ...... 183

Chapter 12  Logging Configuration Parameters ...... 185 LogArchiveDirectory ...... 186 LogCompressionMode ...... 187 LogDirectory ...... 187 LogEcho ...... 188 LogExpireAction ...... 188 LogFile ...... 189 LogHistorySize ...... 190 LogLevel ...... 190 LogLevelMatch ...... 191 LogMaxLineLength ...... 193 LogMaxOldFiles ...... 193 LogMaxSizeKBs ...... 194 LogOldAction ...... 195 LogOutputLogLevel ...... 196 LogSysLog ...... 196 LogTime ...... 197 LogTypeCSVs ...... 197

Chapter 13  Secure Socket Layer Parameters ...... 201 SSLConfig ...... 202 SSLCACertificate ...... 204 SSLCACertificatesPath ...... 204

• • • Oracle UCM Connecter Administration Guide • 11 • • Contents

SSLCertificate ...... 206 SSLCheckCertificate ...... 206 SSLCheckCommonName ...... 207 SSLMethod ...... 207 SSLPrivateKey ...... 208 SSLPrivateKeyPassword ...... 209

Chapter 14  Service Configuration Parameters ...... 211 ServiceACIMode ...... 212 ServiceControlClients ...... 212 ServiceHost ...... 213 ServicePort ...... 213 ServiceStatusClients ...... 214

Chapter 15  Service Actions...... 215 Action Syntax ...... 215 GetConfig ...... 216 GetLogStream ...... 216 GetLogStreamNames ...... 217 GetStatistics ...... 217 GetStatus ...... 224 GetStatusInfo ...... 224 Stop ...... 225 Service Action Parameters ...... 225

Appendixes

Appendix A KeyView Format Codes ...... 229 KeyView Classes ...... 230 KeyView Formats ...... 231

Glossary ...... 249

Index ...... 253

• • • 12 • Oracle UCM Connecter Administration Guide • • Preface

This guide is for readers who need to configure and install the Oracle UCM Connecter™. It is intended for readers who have installed IDOL and are familiar with concepts related to administering a multi-part distributed application. This preface contains the following sections:  Version

 Notational Conventions

 Command-line Syntax Conventions

 Notices

 Related Documentation

 Support and Contact Information

Version

The information in this guide is current as of Oracle UCM Connecter version 7.5. The content was last modified 14 October 2011. Corrections or updates to this information may be available through the Autonomy Support site; see “Support and Contact Information” on page 17.

• • • Oracle UCM Connecter Administration Guide • 13 • • Preface

Notational Conventions

This guide 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:\Autonomy\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

• • • 14 • Oracle UCM Connecter Administration Guide • • Command-line Syntax Conventions

This guide 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: -merge filename1 (In some documents, angle brackets are used to denote these items.)

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

• • • Oracle UCM Connecter Administration Guide • 15 • • Preface

Notices

This guide 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.

Related Documentation

The following documents provide more details on Oracle UCM Connecter:  IDOL Administration User 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.

• • • 16 • Oracle UCM Connecter Administration Guide • •  Distributed Index Handler (DIH) Administration Guide This guide provides 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 provides 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 provides details on how you can use a DiSH server to administer and control multiple Autonomy services.

Support and Contact Information

Read this section to obtain the latest product documentation, request technical support, or contact Autonomy.

Download the Latest Documentation

You can retrieve the latest available product documentation from Autonomy’s Knowledge Base on the Customer Support site.

To download the latest document revisions 1. Type this URL in your Web browser's address field: https://customers.autonomy.com

IMPORTANT Access to the contents of the Customer Support site requires a user name and password. To obtain a user name and password, follow the sign-up instructions on the home page.

2. Click Log In and type your e-mail address and password. 3. Click Sign in. 4. Click Knowledge Base. 5. Type query text or select a category to filter your search for documentation. The most recently added documents display at the top of the results list.

• • • Oracle UCM Connecter Administration Guide • 17 • • Preface

The version number associated with a document (for example, version 7.5) is the product version that the document describes. If a document has a revision number (for example, Revision 5), the document has been revised since it was first released with the specified product version. The Knowledge Base contains the latest available revision of any document.

Contact Autonomy Technical Support

Autonomy Technical Support exists to provide you with prompt and accurate resolutions to difficulties relating to using Autonomy software products. You can contact Technical Support using any of the following methods:  Call or e-mail the support group at the location that is nearest to you:

Europe and Worldwide North and South America

E-mail: [email protected] E-mail: [email protected] Telephone:  Telephone:  00 800 4837 4890 (UK, Germany, Spain, 1 877 333 7744 Netherlands, France)  1 403 294 1107 (Canada direct) +44 (0) 800 0 282 858 (UK only) Hours: 07:00 to 18:00 MST (GMT-7) Hours: 09:00 to 17:00 (GMT+1)

 Access the Customer Support site at: https://customers.autonomy.com Access to the contents of the Customer Support site requires a user name and password. To obtain a user name and password, follow the sign-up instructions on the home page.

Contact Autonomy

Contact the location that is nearest to you for general information about Autonomy:

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, Spear Tower, Suite 1900 Cowley Road, Cambridge, CB4 0WZ, UK San Francisco, CA. 94105, US

• • • 18 • Oracle UCM Connecter Administration Guide • • • • • Oracle UCM Connecter Administration Guide • 19 • • Preface

• • • 20 • Oracle UCM Connecter Administration Guide • • PART 1 Getting Started

This section provides an overview of the Oracle UCM Connecter, installation procedures, and configuration information for the connector and the Connector Framework server. It includes the following chapters:

 Introduction

 Installation

 Configure Oracle UCM Connecter

 Configure Connector Framework Server

 Use Lua Scripts Part 1 Getting Started

• • • 22 • Oracle UCM Connecter Administration Guide • • CHAPTER 1  Introduction

This chapter provides an overview of the Oracle UCM Connecter. It contains the following sections:

 Overview

 About Connector Framework Server

 System Architecture

 Import Process

Overview

Oracle UCM Connecter is an Autonomy connector that automatically aggregates documents from an eRoom server containing the data for your eRoom users using HTTP requests. The files are then sent to Connector Framework server (CFS) which then processes the information and indexes it into an Autonomy IDOL server. 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:

• • • Oracle UCM Connecter Administration Guide • 23 • • Chapter 1 Introduction

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

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

• • • 24 • Oracle UCM Connecter Administration Guide • • System Architecture

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

• • • Oracle UCM Connecter Administration Guide • 25 • • 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.

• • • 26 • Oracle UCM Connecter Administration Guide • • CHAPTER 2  Installation

This section provides information that is required to install the Oracle UCM Connecter. It includes the following topics:

 System Requirements

 Install Oracle UCM Connecter on Windows

 Install Oracle UCM Connecter on Linux

System Requirements

Oracle UCM Connecter should be installed by a system administrator as part of a larger Autonomy system that includes an Autonomy IDOL server and an interface for the information stored in the IDOL server.

Supported Platforms

Oracle UCM Connecter runs on a variety of platforms. For a detailed list of supported platforms, see the IDOL Release Notes.

NOTE The documented platforms are the recommended and most fully tested platforms for IDOL. Autonomy can provide support for other platforms on request.

• • • Oracle UCM Connecter Administration Guide • 27 • • Chapter 2 Installation

Minimum Server Requirements

 2 GHz Pentium4 processor

 2 GB RAM

 20 GB hard disk recommended

 The Connector Framework server, which must be running before the Oracle UCM Connecter is started.

Install Oracle UCM Connecter on Windows

To install the Oracle UCM Connecter and Connector Framework server (CFS) on Windows, double-click ConnectorName_Version_platform.exe.

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.

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 Oracle UCM Connecter. By default, Oracle UCM Connecter is installed in C:\Autonomy\ConnectorName, but you can click the Choose 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.

• • • 28 • Oracle UCM Connecter Administration Guide • • Install Oracle UCM Connecter on Windows

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.

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.

• • • Oracle UCM Connecter Administration Guide • 29 • • Chapter 2 Installation

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 Oracle UCM Connecter 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 Oracle UCM Connecter service immediately after installation, and click Next. 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 Oracle UCM Connecter and Connector Framework server configuration files and start the Oracle UCM Connecter service if you did not start the service in Step 11.

Directory Structure

Once the installation of Oracle UCM Connecter 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 Oracle UCM Connecter 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.

• • • 30 • Oracle UCM Connecter Administration Guide • • Install Oracle UCM Connecter on Windows

File Description

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.

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.

• • • Oracle UCM Connecter Administration Guide • 31 • • Chapter 2 Installation

Oracle UCM Connecter Directory Structure

By default, the Oracle UCM Connecter is installed to the C:\Autonomy\ ConnectorName directory. The Oracle UCM Connecter installation directory contains the following files and subdirectories (note that bold font indicates folders).

File Description

jre Java Runtime Environment.

lib Contains JAR files.

Uninstall_ConnectorName Files required for uninstalling Oracle UCM Connecter.

autpassword.exe Autonomy Password Encryption Utility executable, which allows you to encrypt the passwords.

ConnectorName.cfg Oracle UCM Connecter configuration file.

ConnectorName.exe Oracle UCM Connecter executable.

lua5.1.dll Lua library.

ConnectorName_InstallLog.log Installation log file that lists the details of the installation process.

license.html HTML file containing license information.

license.txt Text file containing license information.

version.txt Text file containing version information.

When you start Oracle UCM Connecter for the first time, the following files and subdirectories are created:

File Description

license Contains license information.

logs Contains Oracle UCM Connecter log files. By default, this includes application.log, action.log, collect.log, synchronize.log, view.log. uid Contains document tracking files.

autn_ntres.dll NT resource library.

license.log License log file.

• • • 32 • Oracle UCM Connecter Administration Guide • • Install Oracle UCM Connecter on Linux

File Description

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 211

Install Oracle UCM Connecter on Linux

Oracle UCM Connecter 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 Oracle UCM Connecter on Linux 1. Run the Oracle UCM Connecter 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=. Specify a list of installer properties.

• • • Oracle UCM Connecter Administration Guide • 33 • • Chapter 2 Installation

2. Read and accept the License Agreement. 3. Enter the absolute path to the directory in which you want to install Oracle UCM Connecter, or accept the default. By default, Oracle UCM Connecter is installed in /opt/Autonomy/ConnectorName. 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 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.

• • • 34 • Oracle UCM Connecter Administration Guide • • Install Oracle UCM Connecter on Linux

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. 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 Oracle UCM Connecter 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 Oracle UCM Connecter configuration files located in the main installation directory.

Directory Structure—Linux

Once the installation of Oracle UCM Connecter 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 Oracle UCM Connecter installation directory. The ConnectorFramework installation directory contains the following files and subdirectories (note that bold font indicates directories).

• • • Oracle UCM Connecter Administration Guide • 35 • • Chapter 2 Installation

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.

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.

• • • 36 • Oracle UCM Connecter Administration Guide • • Install Oracle UCM Connecter on Linux

File Description

ConnectorFramework.str CFS structured configuration file.

license.log License log file.

service.log Service actions log file.

The Connector Framework server (CFS) is installed to the ConnectorFramework directory which is at the same level as the Oracle UCM Connecter 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.

• • • Oracle UCM Connecter 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.

Oracle UCM Connecter Directory Structure

By default, the Oracle UCM Connecter is installed to the C:\Autonomy\ ConnectorName directory. The Oracle UCM Connecter installation directory contains the following files and subdirectories (note that bold font indicates folders).

File Description

jre Java Runtime Environment.

lib Contains JAR files.

Uninstall_ConnectorName Files required for uninstalling Oracle UCM Connecter.

autpassword.exe Autonomy Password Encryption Utility executable, which allows you to encrypt the passwords.

ConnectorName.cfg Oracle UCM Connecter configuration file.

ConnectorName.exe Oracle UCM Connecter executable.

lua5.1.dll Lua library.

• • • 38 • Oracle UCM Connecter Administration Guide • • Install Oracle UCM Connecter on Linux

File Description

ConnectorName_InstallLog.log Installation log file that lists the details of the installation process.

license.html HTML file containing license information.

license.txt Text file containing license information.

version.txt Text file containing version information.

When you start Oracle UCM Connecter for the first time, the following files and subdirectories are created:

File Description

license Contains license information.

logs Contains Oracle UCM Connecter log files. By default, this includes application.log, action.log, collect.log, synchronize.log, view.log. uid Contains document tracking files.

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.

• • • Oracle UCM Connecter Administration Guide • 39 • • Chapter 2 Installation

• • • 40 • Oracle UCM Connecter Administration Guide • • CHAPTER 3  Configure Oracle UCM Connecter

This chapter describes how to configure the parameters that determine how the Oracle UCM Connecter operates. The configuration settings are stored in the connector configuration file located in the Oracle UCM Connecter installation directory. You can modify the parameters directly in the configuration file using a text editor. This section includes the following topics:  Oracle UCM Connecter Configuration File

 Modify Parameters

 Configuration File Sections

 Example Configuration File

 Start and Stop the Connector

 Encrypt Passwords

 Set Up Log Streams

 Set Up Secure Socket Layer Connections

• • • Oracle UCM Connecter Administration Guide • 41 • • Chapter 3 Configure Oracle UCM Connecter

Oracle UCM Connecter Configuration File

The configuration options for the connector are, as is the standard for connectors, defined in the configuration file of the same name as the connector service executable: ConnectorName.cfg. This configuration file is located in the same folder as the connector service executable (default C:\Autonomy\ ConnectorName). You can modify these parameters to customize Oracle UCM Connecter 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.

• • • 42 • Oracle UCM Connecter Administration Guide • • Configuration File Sections

For example: ParameterName="",dog,bird,"wing,beak",turtle

Configuration File Sections

The Oracle UCM Connecter indexes the messages and conferences stored in an OCS audit database (LCSLog). It assumes that a conversation is complete when a configurable period of time has passed (ChatExpirySeconds). Each synchronize task will process the messages and conferences for a given time slot where there are no later updates (IntervalSeconds). The Oracle UCM Connecter configuration file contains the following sections: [License] [Service] [Server] [Logging] [Connector] [Ingestion] [FetchTasks] [TaskName]

License Section

The [License] section contains details about the License server (the server on which your Oracle UCM Connecter license file is located).

[License] LicenseServerHost=127.0.0.1 LicenseServerACIPort=20000 LicenseServerTimeout=600000 LicenseServerRetries=1

Related Topics  “License Configuration Parameters” on page 179

Server Section

This section contains general server parameters. For example: [server] Port=12345

• • • Oracle UCM Connecter Administration Guide • 43 • • Chapter 3 Configure Oracle UCM Connecter

Service Section

The [Service] section contains parameters that determine which machines are permitted to use and control the Oracle UCM Connecter service. For example: [Service] ServicePort=5768 ServiceStatusClients=*.*.*.* ServiceControlClients=*.*.*.*

Related Topics  “Service Configuration Parameters” on page 211

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] Host=localhost Port=7000 BatchSize=20 IngesterType=AsyncPiranha IngestPort=7000 IndexDatabase=OracleUCM

Related Topics  “Parameters Common to CFS Connectors” on page 109

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=NORMAL LogDirectory=logs LogEcho=TRUE 0=ApplicationLogStream 1=ActionLogStream

• • • 44 • Oracle UCM Connecter Administration Guide • • Configuration File Sections

2=SynchronizeLogStream 3=CollectLogStream 4=ViewLogStream

[ApplicationLogStream] LogFile=application.log LogTypeCSVs=application

[ActionLogStream] LogFile=action.log LogTypeCSVs=action

[SynchronizeLogStream] LogFile=synchronize.log LogTypeCSVs=synchronize

[CollectLogStream] LogFile=collect.log LogTypeCSVs=collect

[ViewLogStream] LogFile=view.log LogTypeCSVs=view

Related Topics  “Set Up Log Streams” on page 53

 “Logging Configuration Parameters” on page 185

Connector Section

These parameters enable features, set temporary directories, and so on. Also, the parameters in this section specify details related to the CFS connectors’ .NET files. These parameters must be set for the Oracle UCM Connecter to work, and should never need to be changed.

[Connector] EnableIngestion=TRUE EnableExtraction=FALSE TempDirectory=Temp EnableScheduledTasks=TRUE ScheduleCycles=0 //ScheduleRepeatSecs=0 JavaMaxMemoryMB=64 JavaConnectorClass=com.autonomy.connector.UCM.UCMConnector JVMLibraryPath=.\jre\bin\client

• • • Oracle UCM Connecter Administration Guide • 45 • • Chapter 3 Configure Oracle UCM Connecter

JavaClasspath=.;lib/oracle.ucm.ridc-11.1.1.jar;lib/UCM.jar;lib/ JavaConnector.jar;lib/commons-codec-1.4.jar;lib/ commons-logging-1.0.4.jar;lib/commons-logging-1.1.1.jar;lib/ commons-httpclient-3.1.jar;lib/httpclient-4.1.1.jar;lib/ httpclient-cache-4.1.1.jar;lib/httpcore-4.1.jar;lib/ httpmime-4.1.1.jar;

Related Topics  “Parameters Common to CFS Connectors” on page 109

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

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.

NOTE A parameter specified in a [TaskName] section overrides the same parameter defined in the [FetchTasks] section which in turn overries the same parameter specified in the [Default] section.

For example:

[UCM] // used in DataBinder, MUST be of VERITY search condition, // e.g. dDocName`IDC000001` //QueryText=dDocName`IDC000001`

// Used in DataBinder, means "results per page", // consult with Autonomy TS to change ResultCount=20000

//define prefix for DREFIELD name of UCM meta data // extracted from UCM sever for file, default to "UCM" ucmMetaFieldPrefix=UCM1_

• • • 46 • Oracle UCM Connecter Administration Guide • • Example Configuration File

SynchronizeThreads=1

// URI to UCM server URI=http://localhost:16200/cs/idcplg

// Name of the UCM user UserName=weblogic

// The password (should be encrypted) for the UCM user. Password=webl0gic

// Web server parameters will be used to create the DREREFERENCE UCMWebServer=localhost UCMWebPort=16200

// The name of the IDOL Server database // in which aggregated documents are to be stored IndexDatabase=TEST

// Maximum time in MilliSeconds for a document to be downloaded MaxWaitTime=600000

// Set MappedSecurity=TRUE if you want the fetch // to index Access Control List (ACL) information MappedSecurity=TRUE

// Specify the security type (must set MappedSecurity=TRUE) SecurityType=UCM

// Set EncryptSecurityEntries=TRUE if you want the extracted ACLs // to be encrypted (must set MappedSecurity=TRUE) EncryptSecurityEntries=TRUE

Example Configuration File

[License] LicenseServerHost=127.0.0.1 LicenseServerACIPort=20000 LicenseServerTimeout=600000 LicenseServerRetries=1

[Server] Port=12345

[Service] ServicePort=5768

• • • Oracle UCM Connecter Administration Guide • 47 • • Chapter 3 Configure Oracle UCM Connecter

ServiceStatusClients=*.*.*.* ServiceControlClients=*.*.*.*

[Ingestion] Host=localhost Port=7000 BatchSize=20 IngesterType=AsyncPiranha IngestPort=7000 IndexDatabase=OracleUCM

[Logging] LogLevel=NORMAL LogDirectory=logs LogEcho=TRUE 0=ApplicationLogStream 1=ActionLogStream 2=SynchronizeLogStream 3=CollectLogStream 4=ViewLogStream

[ApplicationLogStream] LogFile=application.log LogTypeCSVs=application

[ActionLogStream] LogFile=action.log LogTypeCSVs=action

[SynchronizeLogStream] LogFile=synchronize.log LogTypeCSVs=synchronize

[CollectLogStream] LogFile=collect.log LogTypeCSVs=collect

[ViewLogStream] LogFile=view.log LogTypeCSVs=view

[Connector] EnableIngestion=TRUE EnableExtraction=FALSE TempDirectory=Temp EnableScheduledTasks=TRUE ScheduleCycles=0 //ScheduleRepeatSecs=0 JavaMaxMemoryMB=64

• • • 48 • Oracle UCM Connecter Administration Guide • • Example Configuration File

JavaConnectorClass=com.autonomy.connector.UCM.UCMConnector JVMLibraryPath=.\jre\bin\client JavaClasspath=.;lib/oracle.ucm.ridc-11.1.1.jar;lib/UCM.jar;lib/ JavaConnector.jar;lib/commons-codec-1.4.jar;lib/ commons-logging-1.0.4.jar;lib/commons-logging-1.1.1.jar;lib/ commons-httpclient-3.1.jar;lib/httpclient-4.1.1.jar;lib/ httpclient-cache-4.1.1.jar;lib/httpcore-4.1.jar;lib/ httpmime-4.1.1.jar;

[FetchTasks] Number=1 0=UCM

[UCM] // used in DataBinder, MUST be of VERITY search condition, // e.g. dDocName`IDC000001` //QueryText=dDocName`IDC000001`

// Used in DataBinder, means "results per page", // consult with Autonomy TS to change ResultCount=20000

//define prefix for DREFIELD name of UCM meta data // extracted from UCM sever for file, default to "UCM" ucmMetaFieldPrefix=UCM1_

SynchronizeThreads=1

// URI to UCM server URI=http://localhost:16200/cs/idcplg

// Name of the UCM user UserName=weblogic

// The password (should be encrypted) for the UCM user. Password=webl0gic

// Web server parameters will be used to create the DREREFERENCE UCMWebServer=localhost UCMWebPort=16200

// The name of the IDOL Server database // in which aggregated documents are to be stored IndexDatabase=TEST

// Maximum time in MilliSeconds for a document to be downloaded MaxWaitTime=600000

// Set MappedSecurity=TRUE if you want the fetch

• • • Oracle UCM Connecter Administration Guide • 49 • • Chapter 3 Configure Oracle UCM Connecter

// to index Access Control List (ACL) information MappedSecurity=TRUE

// Specify the security type (must set MappedSecurity=TRUE) SecurityType=UCM

// Set EncryptSecurityEntries=TRUE if you want the extracted ACLs // to be encrypted (must set MappedSecurity=TRUE) EncryptSecurityEntries=TRUE

Start and Stop the Connector

The following section describes how to start and stop the connector.

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.

Stop the 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.

• • • 50 • Oracle UCM Connecter Administration Guide • • Encrypt Passwords

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 Oracle UCM Connecter is running.

ServicePort The Oracle UCM Connecter service port (specified in the [Service] section of the Oracle UCM Connecter 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] where,

Option Description

-e Encrypts the password.

-d Decrypts the password.

-x Performs the operation specified by the -o option. See Options.

• • • Oracle UCM Connecter Administration Guide • 51 • • Chapter 3 Configure Oracle UCM Connecter

Option Description

-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

• • • 52 • Oracle UCM Connecter 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

• • • Oracle UCM Connecter Administration Guide • 53 • • Chapter 3 Configure Oracle UCM Connecter

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.

Set Up Secure Socket Layer Connections

You can configure Secure Socket Layer (SSL) connections between the connector and other servers.

Set the SSLConfig parameter in:  The Server section if connections to the connector on the port specified in the Server section should be over SSL.  the DistributedConnector section if connections to the distributed connector should be over SSL (if applicable).

 The ViewServer section if connections to the view server should be over SSL (if applicable).

Set IngestSSLConfig in the TaskName or Ingestion section if connections to the ingester should be over SSL.

To configure an incoming SSL connection 1. Open the Oracle UCM Connecter configuration file in a text editor.

• • • 54 • Oracle UCM Connecter Administration Guide • • Set Up Secure Socket Layer Connections

2. Find the [Default] section. 3. Add the SSLConfig parameter to specify the section in which you have set the SSL details for the connection, usually SSLOptionN. For example: [Default] ... SSLConfig=SSLOption0 4. Create a corresponding [SSLOptionN] section. The SSLOption entry must contain the SSLMethod, SSLCertificate, and SSLPrivateKey parameters. For example: [SSLOption0] SSLMethod=SSLV23 SSLCertificate=host1.crt SSLPrivateKey=host1.key 5. Save and close the configuration file. 6. Restart Oracle UCM Connecter to execute your changes.

To configure outgoing SSL connections 1. Open the Oracle UCM Connecter configuration file in a text editor. 2. Find the job section. 3. Add the SSLConfig parameter to specify the section in which you have set the SSL details for the connection, usually SSLOptionN. For example: [Job] ... SSLConfig=SSLOption1 4. Create a corresponding [SSLOptionN] section. The SSLOption entry must contain the SSLMethod, SSLCertificate, and SSLPrivateKey parameters. For example: [SSLOption1] SSLMethod=SSLV23 SSLCertificate=host2.crt SSLPrivateKey=host2.key 5. Save and close the configuration file. 6. Restart Oracle UCM Connecter to execute your changes.

• • • Oracle UCM Connecter Administration Guide • 55 • • Chapter 3 Configure Oracle UCM Connecter

• • • 56 • Oracle UCM Connecter 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.

• • • Oracle UCM Connecter Administration Guide • 57 • • 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

• • • 58 • Oracle UCM Connecter 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=*.*.*.*

• • • Oracle UCM Connecter Administration Guide • 59 • • 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

• • • 60 • Oracle UCM Connecter Administration Guide • • Example Configuration File

[ImportTasks] //Post0=lua: Post0=IdxWriter:C:\Documents and Settings\dquatman\My Documents\ ConnectorFrameworkServers\IDXArchive\output.idx

• • • Oracle UCM Connecter Administration Guide • 61 • • Chapter 4 Configure Connector Framework Server

• • • 62 • Oracle UCM Connecter 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.

• • • Oracle UCM Connecter Administration Guide • 63 • • 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.

• • • 64 • Oracle UCM Connecter 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

• • • Oracle UCM Connecter Administration Guide • 65 • • 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.

• • • 66 • Oracle UCM Connecter 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.

• • • Oracle UCM Connecter Administration Guide • 67 • • 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.

• • • 68 • Oracle UCM Connecter 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.

• • • Oracle UCM Connecter Administration Guide • 69 • • 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.

• • • 70 • Oracle UCM Connecter 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.

• • • Oracle UCM Connecter Administration Guide • 71 • • 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 )

• • • 72 • Oracle UCM Connecter 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 )

• • • Oracle UCM Connecter Administration Guide • 73 • • 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.

• • • 74 • Oracle UCM Connecter 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.

• • • Oracle UCM Connecter Administration Guide • 75 • • 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.

• • • 76 • Oracle UCM Connecter 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

• • • Oracle UCM Connecter Administration Guide • 77 • • 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.

• • • 78 • Oracle UCM Connecter 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.

• • • Oracle UCM Connecter Administration Guide • 79 • • 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 )

• • • 80 • Oracle UCM Connecter 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 )

• • • Oracle UCM Connecter Administration Guide • 81 • • 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)

• • • 82 • Oracle UCM Connecter 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.

• • • Oracle UCM Connecter Administration Guide • 83 • • 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)

• • • 84 • Oracle UCM Connecter 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])

• • • Oracle UCM Connecter Administration Guide • 85 • • 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.

• • • 86 • Oracle UCM Connecter 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 )

• • • Oracle UCM Connecter Administration Guide • 87 • • 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.

• • • 88 • Oracle UCM Connecter 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 )

• • • Oracle UCM Connecter Administration Guide • 89 • • 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 )

• • • 90 • Oracle UCM Connecter 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)

• • • Oracle UCM Connecter Administration Guide • 91 • • 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

• • • 92 • Oracle UCM Connecter 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.

• • • Oracle UCM Connecter Administration Guide • 93 • • 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)

• • • 94 • Oracle UCM Connecter 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.

• • • Oracle UCM Connecter Administration Guide • 95 • • Chapter 5 Use Lua Scripts

• • • 96 • Oracle UCM Connecter Administration Guide • • PART 2 Parameter and Command Reference

This section describes some of the configuration parameters and action commands used by the Oracle UCM Connecter and Connector Framework server and includes the following chapters:

 Oracle UCM Connecter Configuration Parameters

 Parameters Common to CFS Connectors

 Parameters Common to CFS Connectors Using Java

 CFS Connector Actions

 Connector Framework Server Parameters

 License Configuration Parameters

 Logging Configuration Parameters

 Secure Socket Layer Parameters

 Service Configuration Parameters

 Service Actions Part 2 Parameter and Command Reference

• • • 98 • Oracle UCM Connecter Administration Guide • • CHAPTER 6  Oracle UCM Connecter Configuration Parameters

This chapter describes the parameters that determine how Oracle UCM Connecter operates. You can modify these parameters to customize Oracle UCM Connecter to your needs.

 Service Parameters

 Server Parameters

 Service Parameters

 Logging Parameters

 Connector Parameters

 Ingestion Parameters

 FetchTasks/TaskName Parameters

 FetchTasks/TaskName Parameters

Service Parameters

This section contains parameters that determine which machines are permitted to use and control the Oracle UCM Connecter service.

• • • Oracle UCM Connecter Administration Guide • 99 • • Chapter 6 Oracle UCM Connecter Configuration Parameters

Related Topics  “Service Configuration Parameters” on page 211

Server Parameters

This section contains general parameters for indexing and querying.

Port

Specify the ACI port by which action commands are sent to the connector.

Type: Long

Default:

Required: Yes

Allowed Minimum: 1 Range: Maximum: 65535

Recommended Minimum: 1 Range: Maximum: 65535

Configuration Server Section:

Example: Port=7008 See Also:

Related Topics  “Connector Framework Server Parameters” on page 161

• • • 100 • Oracle UCM Connecter Administration Guide • • License Parameters

License Parameters

This section contains parameters that determine licensing details.

Related Topics  “License Configuration Parameters” on page 179

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 185

Connector Parameters

These parameters enable features, set temporary directories, and so on.

Related Topics  “Parameters Common to CFS Connectors” on page 109

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 109

• • • Oracle UCM Connecter Administration Guide • 101 • • Chapter 6 Oracle UCM Connecter Configuration Parameters

FetchTasks/TaskName Parameters

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 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] DbConnectionString=Server=localhost;DataBase=Database1;UID=;PWD= IntervalSeconds=6000 ChatExpirySeconds=1800 XmlTransformXslFilename= IndexConversationQuoteTemplate={0} says: {1} SqlCommandTimeout=30

EncryptSecurityEntries

Set this parameter value to True if you want the extracted ACLs to be encrypted. (In this case, you must also set the value of the MappedSecurity parameter to True.)

Type: Boolean

Default: True

Required:

Configuration TaskName or FetchTasks Section:

Example: EncryptSecurityEntries=False See Also: “MappedSecurity” on page 103

• • • 102 • Oracle UCM Connecter Administration Guide • • FetchTasks/TaskName Parameters

IndexDatabase

Use this parameter to specify the name of the IDOL server database in which aggregated documents are to be stored.

Type: String

Default:

Required: Yes

Configuration TaskName or FetchTasks Section:

Example: IndexDatabase=OracleUCM See Also:

MappedSecurity

When the value of this parameter is set to True, the connector will extract security information.

Type: Boolean

Default: False

Required:

Configuration TaskName or FetchTasks Section:

Example: MappedSecurity=True See Also: “EncryptSecurityEntries” on page 102

MappedSecurityField

Use this parameter to specify the name of the field containing security information.

Type: String

Default: AUTONOMYMETADATA

Required:

• • • Oracle UCM Connecter Administration Guide • 103 • • Chapter 6 Oracle UCM Connecter Configuration Parameters

Configuration TaskName or FetchTasks Section:

Example: MappedSecurityField=AUTONOMYMETADATA See Also:

MaxWaitTime

Use this parameter to specify the connection timeout value in milliseconds. This value is set when the connector creates a connection to the UCM server. When the search result set is large, the search time can be very long. The timeout value should be set to a large value. The current default is 600000 (10 minutes).

Type: Integer

Default: 600000

Required:

Configuration TaskName or FetchTasks Section:

Example: MaxWaitTime=600000 See Also:

Password

Use this parameter to specify the password for the UCM user. This password should be encrypted. This is currently in clear text.

Type: String

Default:

Required: Yes

Configuration TaskName or FetchTasks Section:

Example: Password=78YU0ls See Also: “UserName” on page 108

• • • 104 • Oracle UCM Connecter Administration Guide • • FetchTasks/TaskName Parameters

QueryText

Use this parameter to specify the Verity VDK query syntax for document filtering. This is used in DataBinder. It must be a VERITY search condition: for example, dDocName’IDC000001’. The default is “” for all documents.

Type: String

Default: “”

Required:

Configuration TaskName or FetchTasks Section:

Example: QueryText=dDocName’IDC000001’ See Also:

ResultCount

Use this parameter to specify the number of results per page. This is used in DataBinder.

NOTE Consult with Autonomy Technical Services before you change the value of this parameter.

Type: Integer

Default: 20000

Required:

Configuration TaskName or FetchTasks Section:

Example: ResultCount=20000 See Also:

• • • Oracle UCM Connecter Administration Guide • 105 • • Chapter 6 Oracle UCM Connecter Configuration Parameters

SecurityType

Use this parameter to specify the security type. (In this case, you must also set the value of the MappedSecurity parameter to True.)

Type: String

Default: UCM

Required:

Configuration TaskName or FetchTasks Section:

Example: SecurityType=UCM See Also:

SynchronizeThreads

Use this parameter to specify the number of download threads for the synchronize action.

Type: Integer

Default: 5

Required:

Configuration TaskName or FetchTasks Section:

Example: SynchronizeThreads=1 See Also:

ucmMetaFieldPrefix

Use this parameter to specify the prefix for the DREFIELD name of the UCM metadata extracted from the UCM server.

Type: String

Default: UCM

Required:

• • • 106 • Oracle UCM Connecter Administration Guide • • FetchTasks/TaskName Parameters

Configuration TaskName or FetchTasks Section:

Example: ucmMetaFieldPrefix=UCM1_ See Also:

UCMWebPort

Use this parameter to specify the UCM content server Web access port. This is used to create the doc reference and DREREFERENCE. The value should be in the form: http://UCMWebServer:UCMWebPort + docRelative URL.

Type: String

Default:

Required: Yes

Configuration TaskName or FetchTasks Section:

Example: UCMWebPort=16200 See Also:

UCMWebServer

Use this parameter to specify the UCM Web server. This is used to create the doc reference and DREREFERENCE. The value should be in the form: http:// UCMWebServer:UCMWebPort + docRelative URL. Use an IP address or localhost.

Type: String

Default:

Required: Yes

Configuration TaskName or FetchTasks Section:

Example: UCMWebServer=localhost See Also:

• • • Oracle UCM Connecter Administration Guide • 107 • • Chapter 6 Oracle UCM Connecter Configuration Parameters

URI

Use this parameter to specify the URI for creating the client connection to the UCM content server.

Type: String

Default:

Required: Yes

Configuration TaskName or FetchTasks Section:

Example: URI=http://localhost:16200/cs/idcplg See Also:

UserName

Use this parameter to specify the user name for the UCM user. This user name should be encrypted.

Type: String

Default:

Required: Yes

Configuration TaskName or FetchTasks Section:

Example: UserName=admin See Also: “Password” on page 104

• • • 108 • Oracle UCM Connecter 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

• • • Oracle UCM Connecter Administration Guide • 109 • • 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.

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 112 “OnFinish” on page 113 “OnStart” on page 113

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

• • • 110 • Oracle UCM Connecter Administration Guide • • ACI Server Configuration

Configuration Actions or Server Section:

Example: MaximumThreads=4 See Also:

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 111

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

• • • Oracle UCM Connecter Administration Guide • 111 • • Chapter 7 Parameters Common to CFS Connectors

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

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:

• • • 112 • Oracle UCM Connecter Administration Guide • • ACI Server Configuration

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:

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:

• • • Oracle UCM Connecter Administration Guide • 113 • • Chapter 7 Parameters Common to CFS Connectors

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

• • • 114 • Oracle UCM Connecter Administration Guide • • Distributed Connector

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

Configuration ImportService Section:

Example: KeyviewDirectory=./filters See Also: “EnableExtraction” on page 121

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 116

• • • Oracle UCM Connecter Administration Guide • 115 • • Chapter 7 Parameters Common to CFS Connectors

Host Use this parameter to specify the hostname or IP address of the Distributed Connector. This parameter is used only if the RegisterConnector parameter is set to True.

Type: String

Default: localhost

Required: No

Configuration DistributedConnector Section:

Example: Host=localhost See Also: “RegisterConnector” on page 116

Port Use this parameter to specify the port number of the Distributed Connector. This parameter is used only if the RegisterConnector parameter is set to True.

Type: Integer

Default: 10000

Required: No

Configuration DistributedConnector Section:

Example: Port=10000 See Also: “RegisterConnector” on page 116

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.

• • • 116 • Oracle UCM Connecter Administration Guide • • Distributed Connector

Type: Boolean

Default: False

Required: No

Configuration DistributedConnector Section:

Example: RegisterConnector=False See Also:

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 116

• • • Oracle UCM Connecter Administration Guide • 117 • • 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 118

• • • 118 • Oracle UCM Connecter 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 118

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 118

• • • Oracle UCM Connecter Administration Guide • 119 • • 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 Section:

Example: DatastoreFile=./Datastore/Datastore.db See Also: “SynchronizeKeepDatastore” on page 123

• • • 120 • Oracle UCM Connecter Administration Guide • • General Connector Parameters

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 115

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

• • • Oracle UCM Connecter Administration Guide • 121 • • Chapter 7 Parameters Common to CFS Connectors

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:

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:

• • • 122 • Oracle UCM Connecter 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.

• • • Oracle UCM Connecter Administration Guide • 123 • • 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:

• • • 124 • Oracle UCM Connecter 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:

• • • Oracle UCM Connecter Administration Guide • 125 • • 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.

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

• • • 126 • Oracle UCM Connecter Administration Guide • • Fetch Task Configuration

Configuration FetchTasks or Connector Section:

Example: Number=2 0=Task1 1=Task2 See Also: “Number” on page 127

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

Configuration FetchTasks or Connector Section:

Example: Number=2 0=Task1 1=Task2 See Also: “N” on page 126

ScheduleCycles Use this parameter to specify the number of scheduled synchronize actions to perform.

• • • Oracle UCM Connecter Administration Guide • 127 • • Chapter 7 Parameters Common to CFS Connectors

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 122

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 122

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

• • • 128 • Oracle UCM Connecter Administration Guide • • Ingestion

Configuration TaskName or FetchTasks or Connector Section:

Example: ScheduleStartTime=14:30:00 See Also: “EnableScheduledTasks” on page 122

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:

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:

• • • Oracle UCM Connecter Administration Guide • 129 • • Chapter 7 Parameters Common to CFS Connectors

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 63

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:

• • • 130 • Oracle UCM Connecter Administration Guide • • Ingestion

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 129

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. 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 129 “IngesterType” on page 133

• • • Oracle UCM Connecter Administration Guide • 131 • • Chapter 7 Parameters Common to CFS Connectors

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

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:

• • • 132 • Oracle UCM Connecter Administration Guide • • Ingestion

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:

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

• • • Oracle UCM Connecter Administration Guide • 133 • • Chapter 7 Parameters Common to CFS Connectors

Configuration TaskName or Ingestion Section:

Example: IngesterType=AsyncPiranha See Also: “EnableIngestion” on page 129 “IngestActions” on page 130 “IngestHost” on page 134 “IngestPort” on page 135

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 129

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 129

• • • 134 • Oracle UCM Connecter 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 129

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

• • • Oracle UCM Connecter Administration Guide • 135 • • Chapter 7 Parameters Common to CFS Connectors

Configuration TaskName or Ingestion Section:

Example: IngestSharedPath=./TempDirectory See Also: “EnableIngestion” on page 129

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

Type: String

Default:

Required: No

Configuration TaskName or Ingestion Section:

Example: IngestSSLConfig=SSLSettings See Also: “EnableIngestion” on page 129

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 129

• • • 136 • Oracle UCM Connecter 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.

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 com.autonomy.connector.ConnectorBase -configfile

Type: String

Default: None

Required: Yes

• • • Oracle UCM Connecter Administration Guide • 137 • • Chapter 8 Parameters Common to CFS Connectors Using Java

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 138

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

Type: String

Default: None

Required: Yes

Configuration Connector Section:

Example: JavaConnectorClass=com.autonomy.connector.example .FileSystemConnector

See Also: “JavaClassPath” on page 137

JavaLibraryPath

Set this parameter to the location of any additional native libraries required by and of the connector classes or dependencies.

Type: String

Default: ““

Required: No

• • • 138 • Oracle UCM Connecter Administration Guide • • Configuration Connector Section:

Example: JavaLibraryPath=./lib See Also: “JavaClassPath” on page 137

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 137

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)

Type: String

Default: None

Required: No, however, the connector will not start if the jvm library cannot be found or loaded.

• • • Oracle UCM Connecter Administration Guide • 139 • • Chapter 8 Parameters Common to CFS Connectors Using Java

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:

• • • 140 • Oracle UCM Connecter 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 Fetch Action

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

• • • Oracle UCM Connecter Administration Guide • 141 • • 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 FETCH SUCCESS MTAuMi4xMDUuMzQ6MTIzNDpGRVRDSDoxNzUyNTc4MDc0

QueueInfo Fetch 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]

• • • 142 • Oracle UCM Connecter Administration Guide • • QueueInfo Fetch 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 tags. This example shows a single synchronize action on the queue. This has finished and the response is included between the action tags. QUEUEINFO SUCCESS SYNCHRONIZE

• • • Oracle UCM Connecter Administration Guide • 143 • • Chapter 9 CFS Connector Actions

DIR1 DIR2 MTAuMi4xMDUuMzQ6MTIzNDpGRVRDSDoxNDAyOTU3MzY4 Finished 2009-Oct-15 14:44:32 0 2009-Oct-15 14:44:32 3 2009-Oct-15 14:44:35

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.

• • • 144 • Oracle UCM Connecter 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. SYNCHRONIZE DIR1 DIR2 MTAuMi4xMDUuMzQ6MTIzNDpGRVRDSDoxNDAyOTU3MzY4

• • • Oracle UCM Connecter Administration Guide • 145 • • Chapter 9 CFS Connector Actions

Finished 2009-Oct-15 14:44:32 0 2009-Oct-15 14:44:32 3 2009-Oct-15 14:44:35

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.

• • • 146 • Oracle UCM Connecter Administration Guide • • Collect Fetch Action

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 within the string. To add an identifier field value as part of the destination use the tag within the string. Example: destination=\\server\share\\ Where a field can have multiple values or is a CSV, multiple destinations are created and each gets a copy of the document. A CSV can be specified by preceding the colon with the CSV separator character. Example: .

• • • Oracle UCM Connecter Administration Guide • 147 • • Chapter 9 CFS Connector Actions

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 tags showing that they were collected successfully. The documents were output to C:\ Autonomy\collected along with stub files containing their metadata.

• • • 148 • Oracle UCM Connecter Administration Guide • • Identifiers Fetch Action

COLLECT PGlkIHM9IkRJUjEiIHI9IkM6XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZWN0b3J DRlNcZGlyMVxmaWxlOC50eHQiLz4= PGlkIHM9IkRJUjEiIHI9IkM6XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZWN0b3J DRlNcZGlyMVxmaWxlOS50eHQiLz4= MTAuMi4xMDUuMzQ6MTIzNDpGRVRDSDotMTI2NTE0MTI5NA== Finished 2009-Oct-15 16:02:53 0 2009-Oct-15 16:02:53 0 2009-Oct-15 16:02:53

 “Synchronize Fetch Action” on page 144

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]

• • • Oracle UCM Connecter Administration Guide • 149 • • Chapter 9 CFS Connector 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.

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 tags. IDENTIFIERS PGlkIHM9IkRJUjEiIHI9IkM6XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZWN0b3J DRlNcZGlyMVxuZXdmaWxlLnR4dCIvPg== MTAuMi4xMDUuMzQ6MTIzNDpGRVRDSDotMTc4NTQ1MTYwOQ==

• • • 150 • Oracle UCM Connecter Administration Guide • • Insert Fetch Action

Finished 2009-Oct-15 16:36:32 0 2009-Oct-15 16:36:32 0 2009-Oct-15 16:36:32

Related Topics  “Synchronize Fetch Action” on page 144

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.

• • • Oracle UCM Connecter Administration Guide • 151 • • Chapter 9 CFS Connector Actions

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: reference true/false true/false filename/base64file Most of the tags are optional.  ownfile. If ownfile is true, this file is deleted after it has been inserted. By default, this is false.  isfilename. If isfilename is true, the content tag contains the full path to the file. If isfilename is false, the content tag contains the entire file base64 encoded. The ownfile tag is ignored in this case.  insert. The insert tag can be omitted if a single document is being inserted.  reference, property, metadata. The usage of these tags depends on the connector used.

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: C:\Autonomy\FileSystemConnectorCFS\dir1\newfile.txt

• • • 152 • Oracle UCM Connecter Administration Guide • • Insert Fetch Action

false VGhpcyBpcyBteSBmaWxl Note that the content This is my file is base64 encoded. The XML is then escaped and used in the Insert action.

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. INSERT PGlkIHM9IkRJUjEiIHI9IkM6XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZWN0b3J DRlNcZGlyMVxuZXdmaWxlLnR4dCIvPg== MTAuMi4xMDUuMzQ6MTIzNDpGRVRDSDotMTc4NTQ1MTYwOQ== Finished 2009-Oct-15 16:36:32 0 2009-Oct-15 16:36:32 0 2009-Oct-15 16:36:32

• • • Oracle UCM Connecter Administration Guide • 153 • • Chapter 9 CFS Connector Actions

Related Topics  “Synchronize Fetch Action” on page 144

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.

• • • 154 • Oracle UCM Connecter Administration Guide • • Hold and ReleaseHold Fetch 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"/> DELETE PGlkIHM9IkRJUjEiIHI9IkM6XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZWN0b3J DRlNcZGlyMVxuZXdmaWxlLnR4dCIvPg== MTAuMi4xMDUuMzQ6MTIzNDpGRVRDSDotMTgwNDU4NzIxMQ== Finished 2009-Oct-15 16:43:17 0 2009-Oct-15 16:43:17 0 2009-Oct-15 16:43:17

Related Topics  “Synchronize Fetch Action” on page 144

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

• • • Oracle UCM Connecter Administration Guide • 155 • • Chapter 9 CFS Connector 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. HOLD PGlkIHM9IkRJUjEiIHI9IkM6XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZWN0b3J DRlNcZGlyMVxuZXdmaWxlLnR4dCIvPg== MTAuMi4xMDUuMzQ6MTIzNDpGRVRDSDotMTgwNDU4NzIxMQ== Finished 2009-Oct-15 16:43:17 0 2009-Oct-15 16:43:17

• • • 156 • Oracle UCM Connecter Administration Guide • • Update Action

0 2009-Oct-15 16:43:17

 “Synchronize Fetch Action” on page 144

Update Action

The Update action updates metadata for documents given by their identifier in a repository.

Request /action=fetch&fetchaction=Update [&parenttoken=] [&config=] [&identifiersXML=] [&]

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 UPDATE [IDENTIFIER1]

• • • Oracle UCM Connecter Administration Guide • 157 • • Chapter 9 CFS Connector Actions

[IDENTIFIER2] [IDENTIFIER3]

Related Topics  “Synchronize Fetch Action” on page 144

View Action

The View action retrieves a single document and returns it. http://host:port/action=View [&Config=] [&NoACI=True/False] &Identifier=Identifier

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 118

• • • 158 • Oracle UCM Connecter Administration Guide • • StopFetch Action

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

• • • Oracle UCM Connecter Administration Guide • 159 • • Chapter 9 CFS Connector Actions

• • • 160 • Oracle UCM Connecter 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.

• • • Oracle UCM Connecter Administration Guide • 161 • • 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 163  “QueryClients” on page 163

• • • 162 • Oracle UCM Connecter 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 163  “AdminClients” on page 162

• • • Oracle UCM Connecter Administration Guide • 163 • • 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

• • • 164 • Oracle UCM Connecter 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 166 “HashN” on page 166 “DeleteN” on page 167 “UpdateN” on page 167

• • • Oracle UCM Connecter Administration Guide • 165 • • 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 165 “HashN” on page 166 “DeleteN” on page 167 “UpdateN” on page 167

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

• • • 166 • Oracle UCM Connecter 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 171 “ImportFamilyRootExcludeFmtCSV” on page 170

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 165 “PreN” on page 166 “HashN” on page 166 “UpdateN” on page 167

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.

• • • Oracle UCM Connecter Administration Guide • 167 • • 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 165 “PreN” on page 166 “HashN” on page 166 “DeleteN” on page 167

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.

• • • 168 • Oracle UCM Connecter 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 “\,”.

• • • Oracle UCM Connecter Administration Guide • 169 • • 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

• • • 170 • Oracle UCM Connecter 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 229.

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 166 “ImportHashFamilies” on page 171

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 166 “ImportFamilyRootExcludeFmtCSV” on page 170 “ImportMergeMails” on page 172

• • • Oracle UCM Connecter Administration Guide • 171 • • 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 171

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

• • • 172 • Oracle UCM Connecter 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

• • • Oracle UCM Connecter Administration Guide • 173 • • 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:

• • • 174 • Oracle UCM Connecter 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 175

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:

• • • Oracle UCM Connecter Administration Guide • 175 • • 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 175

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.

• • • 176 • Oracle UCM Connecter Administration Guide • • Indexing Parameters

Type: Integer

Default: 300

Required No

Configuration Indexing Section:

Example: IndexTimeInterval=100 See Also: “IndexBatchSize” on page 176

Related Topics  “Secure Socket Layer Parameters” on page 201

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:

• • • Oracle UCM Connecter Administration Guide • 177 • • Chapter 10 Connector Framework Server Parameters

• • • 178 • Oracle UCM Connecter 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

• • • Oracle UCM Connecter Administration Guide • 179 • • 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

• • • 180 • Oracle UCM Connecter 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 182 “LicenseServerTimeout” on page 182 “LicenseServerRetries” on page 183

• • • Oracle UCM Connecter Administration Guide • 181 • • 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 181 “LicenseServerTimeout” on page 182 “LicenseServerRetries” on page 183

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 181 “LicenseServerHost” on page 182 “LicenseServerRetries” on page 183

• • • 182 • Oracle UCM Connecter 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 181 “LicenseServerHost” on page 182 “LicenseServerTimeout” on page 182

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

• • • Oracle UCM Connecter Administration Guide • 183 • • Chapter 11 License Configuration Parameters

• • • 184 • Oracle UCM Connecter Administration Guide • • CHAPTER 12  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

• • • Oracle UCM Connecter Administration Guide • 185 • • Chapter 12 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 195

• • • 186 • Oracle UCM Connecter 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 188

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 186 “LogFile” on page 189

• • • Oracle UCM Connecter Administration Guide • 187 • • Chapter 12 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 186

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.

• • • 188 • Oracle UCM Connecter 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 187 “LogFile” on page 189 “LogMaxSizeKBs” on page 194

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

• • • Oracle UCM Connecter Administration Guide • 189 • • Chapter 12 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 187

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 188

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.

• • • 190 • Oracle UCM Connecter 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 189 “LogLevelMatch” on page 191

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

• • • Oracle UCM Connecter Administration Guide • 191 • • Chapter 12 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 189 “LogLevel” on page 190 “LogOutputLogLevel” on page 196

• • • 192 • Oracle UCM Connecter 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 189

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

• • • Oracle UCM Connecter Administration Guide • 193 • • Chapter 12 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 187 “LogOldAction” on page 195

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 188

• • • 194 • Oracle UCM Connecter 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 186 “LogDirectory” on page 187 “LogMaxOldFiles” on page 193

• • • Oracle UCM Connecter Administration Guide • 195 • • Chapter 12 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 190

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

• • • 196 • Oracle UCM Connecter 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 189

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.

• • • Oracle UCM Connecter Administration Guide • 197 • • Chapter 12 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.

• • • 198 • Oracle UCM Connecter 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 189

• • • Oracle UCM Connecter Administration Guide • 199 • • Chapter 12 Logging Configuration Parameters

• • • 200 • Oracle UCM Connecter Administration Guide • • CHAPTER 13  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

• • • Oracle UCM Connecter Administration Guide • 201 • • Chapter 13 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

• • • 202 • Oracle UCM Connecter 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 204 “SSLCertificate” on page 206 “SSLCheckCertificate” on page 206 “SSLCheckCommonName” on page 207 “SSLMethod” on page 207 “SSLPrivateKey” on page 208 “SSLPrivateKeyPassword” on page 209

• • • Oracle UCM Connecter Administration Guide • 203 • • Chapter 13 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 202

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.

• • • 204 • Oracle UCM Connecter 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 202

• • • Oracle UCM Connecter Administration Guide • 205 • • Chapter 13 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 202 “SSLPrivateKey” on page 208

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 202

• • • 206 • Oracle UCM Connecter 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 202

SSLMethod

Specifies which SSL protocol is used. The options are:  SSLV2

 SSLV3

 SSLV23

 TLSV1

• • • Oracle UCM Connecter Administration Guide • 207 • • Chapter 13 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 202

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 202 “SSLCertificate” on page 206 “SSLPrivateKeyPassword” on page 209

• • • 208 • Oracle UCM Connecter 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 202 “SSLPrivateKey” on page 208

• • • Oracle UCM Connecter Administration Guide • 209 • • Chapter 13 Secure Socket Layer Parameters

• • • 210 • Oracle UCM Connecter Administration Guide • • CHAPTER 14  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 215.

• • • Oracle UCM Connecter Administration Guide • 211 • • Chapter 14 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 212 “ServiceHost” on page 213 “ServicePort” on page 213 “ServiceStatusClients” on page 214

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 212 “ServiceHost” on page 213 “ServicePort” on page 213 “ServiceStatusClients” on page 214

• • • 212 • Oracle UCM Connecter 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 212 “ServiceControlClients” on page 212 “ServicePort” on page 213 “ServiceStatusClients” on page 214

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 212 “ServiceControlClients” on page 212 “ServiceHost” on page 213 “ServiceStatusClients” on page 214

• • • Oracle UCM Connecter Administration Guide • 213 • • Chapter 14 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 212 “ServiceControlClients” on page 212 “ServiceHost” on page 213 “ServicePort” on page 213

• • • 214 • Oracle UCM Connecter 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]

• • • Oracle UCM Connecter Administration Guide • 215 • • 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 215

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.

• • • 216 • Oracle UCM Connecter 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.

• • • Oracle UCM Connecter Administration Guide • 217 • • 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.

• • • 218 • Oracle UCM Connecter 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.

• • • Oracle UCM Connecter Administration Guide • 219 • • 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.

• • • 220 • Oracle UCM Connecter 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.

• • • Oracle UCM Connecter Administration Guide • 221 • • 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]

• • • 222 • Oracle UCM Connecter 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.

• • • Oracle UCM Connecter Administration Guide • 223 • • 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).

• • • 224 • Oracle UCM Connecter 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

• • • Oracle UCM Connecter Administration Guide • 225 • • 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:

• • • 226 • Oracle UCM Connecter Administration Guide • • Appendixes

This section includes the following appendixes:

 KeyView Format Codes Appendixes

• • • 228 • Oracle UCM Connecter 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 170.

• • • Oracle UCM Connecter Administration Guide • 229 • • 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

• • • 230 • Oracle UCM Connecter 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

• • • Oracle UCM Connecter Administration Guide • 231 • • 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)

• • • 232 • Oracle UCM Connecter 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

• • • Oracle UCM Connecter Administration Guide • 233 • • 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

• • • 234 • Oracle UCM Connecter 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

• • • Oracle UCM Connecter Administration Guide • 235 • • 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

• • • 236 • Oracle UCM Connecter 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)

• • • Oracle UCM Connecter Administration Guide • 237 • • 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

• • • 238 • Oracle UCM Connecter 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

• • • Oracle UCM Connecter Administration Guide • 239 • • 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

• • • 240 • Oracle UCM Connecter 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

• • • Oracle UCM Connecter Administration Guide • 241 • • 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

• • • 242 • Oracle UCM Connecter 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

• • • Oracle UCM Connecter Administration Guide • 243 • • 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)

• • • 244 • Oracle UCM Connecter 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

• • • Oracle UCM Connecter Administration Guide • 245 • • 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

• • • 246 • Oracle UCM Connecter 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

• • • Oracle UCM Connecter Administration Guide • 247 • • Appendix A KeyView Format Codes

• • • 248 • Oracle UCM Connecter 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.

• • • Oracle UCM Connecter Administration Guide • 249 • • 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.”

• • • 250 • Oracle UCM Connecter 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.

• • • Oracle UCM Connecter Administration Guide • 251 • • Glossary

• • • 252 • Oracle UCM Connecter Administration Guide • • Index

A example 47 JobName section 46 abs_path method 86 Logging section 44 access control list (ACL) 249 Service section 44 AciPort configuration parameter 175 configuration parameters actions AciPort 175 GetConfig 216 AdminClients (CFS) 162 GetLogStream 216 ArchiveId 103 GetLogStreamNames 217 CleanOnStart 120 GetStatistics 217 CompressIndexFiles 175 GetStatus 224 ConnectorGroup 115 GetStatusInfo 224 DatastoreFile 120 Stop 225 DeleteN 167 addField method 68 DREHost 176 AdminClients (CFS) configuration parameter 162 EnableExtraction 121 appendContent method 69 EnableExtractionCopy 121 ArchiveId configuration parameter 103 EnableIngestion 129 at method 75 EnableScheduledTasks 122 attr method 75 EnableViewServer 118 Autonomy Content Infrastructure (ACI) 249 EncryptACLEntries 122 EncryptSecurityEntries 102 B ExtractDirectory 170 boolean Full 180 values 42, 58 HashN 166 Holder 180 C Host 116, 118 ImportFamilyRootExcludeFmtCSV 170 CleanOnStart configuration parameter 120 ImportHashFamilies 171 CompressIndexfiles configuration parameter 175 ImportInheritFieldsCSV 172 configuration 41 ImportMergeMails 172 boolean values 42, 58 IndexBatchSize 176 example configuration file 47 IndexDatabase 103, 129 file sections 43 IndexTimeInterval 176 string values 42, 58 IngestActions 130 configuration file IngestAddAsupdate 130

• • • Oracle UCM Connecter Administration Guide • 253 • • Index C

IngestBatchSize 131 LogTime 197 IngestCheckFinished 131 LogTypeCSVs 197 IngestDelayMS 132 MappedSecurityField 103 IngestEnableAdds 132 MaxImportQueueSize 173 IngestEnableDeletes 132 MaximumThreads 110, 164 IngestEnableUpdates 133 MaxQueueSize 111, 164 IngesterType 133 MaxScheduledSize 111 IngestHost 134 MaxWaitTime 104 IngestKeepFiles 134 N 126 IngestPort 135 Number 127 IngestSendByType 135 OnError 112 IngestSSLConfig 136 OnErrorReport 113 IngestWriteIDX 136 OnFinish 113 InsertFailedDirectory 123 OnStart 113 JavaClasspath 137 Operation 183 JavaConnectorClass 138, 139 Password 104 JavaLibraryPath 138 Port 100, 116, 119, 135 JavaVerboseGC 140 Port (CFS) 163 JVMLibraryPath 139 PostN 165 Key 180 PreN 166 KeyviewDirectory 115, 172 QueryClients (CFS) 163 KillDuplicates 177 QueryText 105 LibraryName 110 RegisterConnector 116 LicenseServerACIPort 181 ResultCount 105 LicenseServerHost 182 RevisionMarks 173 LicenseServerRetries 183 ScheduleCycles 127 LicenseServerTimeout 182 ScheduleRepeatSecs 128 LogArchiveDirectory 186 ScheduleStartTime 128 LogCompressionMode 187 SectionerMaxBytes 168 LogDirectory 187 SectionerMinBytes 169 LogEcho 188 SectionerSeparatorsN 169 LogExpireAction 188 SecurityType 106 LogFile 189 ServiceACIMode 212 LogHistorySize 190 ServiceControlClients 212 LogLevel 190 ServiceHost 213 LogLevelMatch 191 ServicePort 213 LogMaxLineLength 193 ServiceStatusClients 214 LogMaxOldFiles 193 SharedPath 117, 119 LogMaxSizeKBs 194 SSLCACertificate 204 LogOldAction 195 SSLCACertificatessPath 204 LogOutputLogLevel 196 SSLCertificate 206 LogSysLog 196 SSLCheckCertificate 206

• • • 254 • Oracle UCM Connecter Administration Guide • • D Index

SSLCheckCommonName 207 RevisionMarks 173 SSLConfig 202 SectionerMaxBytes 168 SSLMethod 207 SectionerMinBytes 169 SSLPrivateKey 208 SectionerSeparatorsN 169 SSLPrivateKeyPassword 209 ThreadCount 174 SynchronizeKeepDatastore 123 UpdateN 167 SynchronizeThreads 106, 123, 125 ConnectorGroup configuration parameter 115 TaskMaxAdds 124 content method 75 TaskMaxDuration 124 convert_date_time method 85 TempDirectory 125 copy_file method 87 ThreadCount 174 copyField method 69 ucmMetaFieldPrefix 106 create_path method 87 UCMWebPort 107 create_uuid method 84 UCMWebServer 107 UpdateN 167 D URI 108 database 249 Url 114 DatastoreFile configuration parameter 120 UserName 108 delete_file method 87 XsltDLL 126, 174 deleteField method 69 connector 249 DeleteN configuration parameter 167 Connector Framework server 44, 101 directory structure configure 59 installation 30 IDX Writer 165 UNIX 35 parameters Distributed Action Handler (DIH) 249 AciPort 175 Distributed Service Handler (DiSH) 250 CompressIndexFiles 175 Document Objects methods DeleteN 167 addField 68 DREHost 176 appendContent 69 ExtractDirectory 170 copyField 69 HashN 166 deleteField 69 ImportFamilyRootExcludeFmtCSV 170 getContent 69, 72 ImportHashFamilies 171 getFieldNames 70 ImportInheritFieldsCSV 172 getFieldValue 70 ImportMergeMails 172 getFieldValues 70 IndexBatchSize 176 getNextSection 71 IndexTimeInterval 176 hasfield 71 KeyviewDirectory 172 renamefield 71 KillDuplicates 177 setFieldValue 72 MaxImportQueueSize 173 writeStubIdx 72 MaximumThreads 164 DREHost configuration parameter 176 PostN 165 PreN 166

• • • Oracle UCM Connecter Administration Guide • 255 • • Index E

E H

EnableExtraction configuration parameter 121 hasField method 71 EnableExtractionCopy configuration parameter 121 hash_file method 85 EnableIngestion configuration parameter 129 hash_string method 83 EnableScheduledTasks configuration parameter 122 HashN configuration parameter 166 EnableViewServer configuration parameter 118 Holder configuration parameter 180 encrypt_security_field method 84 Host configuration parameter 116, 118 EncryptACLEntries configuration parameter 122 EncryptSecurityEntries configuration parameter 102 I example configuration file 47 IDOL Server 250 ExtractDirectory configuration parameter 170 IDX 250 Import Module Advanced F C methods 65 fetch 250 ImportFamilyRootExcludeFmtCSV configuration fieldGetValue method 91 parameter 170 fieldSetValue method 91 ImportHashFamilies configuration parameter 171 file_setdates method 88 importing 250 findField method 91 ImportInheritFieldsCSV configuration parameter 172 firstChild method 76 ImportMergeMails configuration parameter 172 Full configuration parameter 180 Index fields 250 IndexBatchSize configuration parameter 176 G IndexDatabase configuration parameter 103, 129 indexing 250 get_config method 80 IndexTimeInterval configuration parameter 176 GetConfig service action 216 IngestActions configuration parameter 130 getContent method 69, 72 IngestAddAsUpdate configuration parameter 130 getcwd method 88 IngestBatchSize configuration parameter 131 getEncryptedValue method 81 IngestCheckFinished configuration parameter 131 getFieldNames method 70 IngestDelayMS configuration parameter 132 getFieldValue method 70, 91 IngestEnableAdds configuration parameter 132 getFieldValues method 70 IngestEnableDeletes configuration parameter 132 GetLogStream service action 216 IngestEnableUpdates configuration parameter 133 GetLogStreamNames service action 217 IngesterType configuration parameter 133 getNextSection method 71 IngestHost configuration parameter 134 GetStatistics service action 217 Ingestion server 44, 101 GetStatus service action 224 IngestKeepFiles configuration parameter 134 GetStatusInfo service action 224 IngestPort configuration parameter 135 getValue method 81 IngestSendByType configuration parameter 135 getValues method 82 IngestSSLConfig configuration parameter 136 gobble_whitespace method 82 IngestWriteIDX configuration parameter 136 InsertFailedDirectory configuration parameter 123

• • • 256 • Oracle UCM Connecter Administration Guide • • P Index

installation 27 LogHistorySize configuration parameter 190 directory structure 30 LogLevel configuration parameter 190 standalone 33 LogLevelMatch configuration parameter 191 Windows 28 LogMaxLineLength configuration parameter 193 Intellectual Asset Protection System (IAS) 250 LogMaxOldFiles configuration parameter 193 Introduction 23 LogMaxSizeKBs configuration parameter 194 is_dir method 89 LogOldAction configuration parameter 195 LogOutputLogLevel configuration parameter 196 J LogSysLog configuration parameter 196 LogTime configuration parameter 197 JavaClasspath configuration parameter 137 LogTypeCSVs configuration parameter 197 JavaConnectorClass configuration parameter 138, 139 JavaLibraryPath configuration parameter 138 M JavaVerboseGC configuration parameter 140, 46 MappedSecurityField configuration parameter 103 JVMLibraryPath configuration parameter 139 MaximumThreads configuration parameter 110, 164 MaxQueueSize configuration parameter 111, 164 K MaxScheduledSize configuration parameter 111 MaxWaitTime configuration parameter 104 Key configuration parameter 180 move_file method 89 KeyView formats 229 KeyviewDirectory configuration parameter 115, 172, N 173 N configuration parameter 126 KillDuplicates configuration parameter 177 name method 76, 78 next method 76, 78 L nodePath method 77 lastChild method 76 Number configuration parameter 127 LibraryName configuration parameter 110 LicenseServerACIPort configuration parameter 181 O LicenseServerHost configuration parameter 182 OnError configuration parameter 112 LicenseServerRetries configuration parameter 183 OnErrorReport configuration parameter 113 LicenseServerTimeout configuration parameter 182 OnFinish configuration parameter 113 log method 90 OnStart configuration parameter 113 LogArchiveDirectory configuration parameter 186 Operation configuration parameter 183 LogCompressionMode configuration parameter 187 LogDirectory configuration parameter 187 P LogEcho configuration parameter 188 LogExpireAction configuration parameter 188 parent method 77 LogFile configuration parameter 189 parse_csv method 83 logging parse_xml method 84 set up log streams 53 password Logging section (configuration file) 44 encrypt 51

• • • Oracle UCM Connecter Administration Guide • 257 • • Index Q

Password configuration parameter 104 Service section (configuration file) 44 Port (CFS) configuration parameter 163 ServiceACIMode configuration parameter 212 Port configuration parameter 100, 116, 119, 135 ServiceControlClients configuration parameter 212 PostN configuration parameter 165 ServiceHost configuration parameter 213 PreN configuration parameter 166 ServicePort configuration parameter 213 prev method 77, 78 ServiceStatusClients configuration parameter 214 set up Q Log streams 53 setFieldValue method 72, 91 query 251 SharedPath configuration parameter 117, 119 QueryClients (CFS) configuration parameter 163 SharePoint Connector QueryText configuration parameter 105 Introduction 23 size method 75 R sleep method 91 RegisterConnector configuration parameter 116 SSLCACertificate configuration parameter 204 renameField method 71 SSLCACertificatesPath configuration parameter 204 requirements SSLCertificate configuration parameter 206 system 27 SSLCheckCertificate configuration parameter 206 ResultCount configuration parameter 105 SSLCheckCommonName configuration parameter RevisionMarks configuration parameter 173 207 root method 73 SSLConfig configuration parameter 202 SSLMethod configuration parameter 207 S SSLPrivateKey configuration parameter 208 SSLPrivateKeyPassword configuration parameter 209 ScheduleCycles configuration parameter 127 start a connector 50 ScheduleRepeatSecs configuration parameter 128 stop a connector 50 ScheduleStartTime configuration parameter 128 Stop service action 225 Search 251 string values 42, 58 SectionerMaxBytes configuration parameter 168 SynchronizeKeepDatastore configuration parameter SectionerMinBytes configuration parameter 169 123 SectionerSeparatorsN configuration parameter 169 SynchronizeThreads configuration parameter 106, Secure Socket Layer connections 201 123, 125 SecurityType configuration parameter 106 system send_aci_action method 79 requirements 27 send_aci_command method 80 system architecture 25 service actions GetConfig 216 T GetLogStream 216 TaskMaxAdds configuration parameter 124 GetLogStreamNames 217 TaskMaxDuration configuration parameter 124 GetStatistics 217 TempDirectory configuration parameter 125 GetStatus 224 ThreadCount configuration parameter 174 GetStatusInfo 224 type method 77, 78 Stop 225

• • • 258 • Oracle UCM Connecter Administration Guide • • X Index

U getcwd 88 getEncryptedValue 81 ucmMetaFieldPrefix configuration parameter 106 getFieldValue 91 UCMWebPort configuration parameter 107 getValue 81 UCMWebServer configuration parameter 107 getValues 82 UNIX gobble_whitespace 82 system requirements 28 hash_file 85 unzip_file method 89 hash_string 83 UpdateN configuration parameter 167 is_dir 89 URI configuration parameter 108 log 90 Url configuration parameter 114 move_file 89 UserName configuration parameter 108 name 78 next 78 V parse_csv 83 value method 79 parse_xml 84 prev 78 W send_aci_action 79 send_aci_command 80 Windows setFieldValue 91 installation 28 sleep 91 writeStubIdx method 72 type 78 unzip_file 89 X value 79 XML document methods zip_file 90 root 73 XmlNode methods 75 XPathExecute 73 attr 75 XPathRegisterNs 73 content 75 XPathValue 74 firstChild 76 XPathValues 74 lastChild 76 XmlAttr methods 78 name 76 abs_path 86 next 76 convert_date_time 85 nodePath 77 copy_file 87 parent 77 create_path 87 prev 77 create_uuid 84 type 77 delete_file 87 XmlNodeSet Methods 75 encrypt_security_field 84 XmlNodeSet methods fieldGetValue 91 at 75 fieldSetValue 91 size 75 file_setdates 88 XPathExecute method 73 findField 91 XPathRegisterNs method 73 get_config 80 XPathValue method 74

• • • Oracle UCM Connecter Administration Guide • 259 • • Index Z

XPathValues method 74 XsltDLL configuration parameter 126, 174

Z

zip_file method 90

• • • 260 • Oracle UCM Connecter Administration Guide • •