2 Administration Object Types

This chapter describes the object types in the Oracle SES Administration API. It contains these topics:

• Alphabetic List of Administration Object Types

• Document Support

• Globalization Support

• Encryption

• XML Description of State Properties

• Partitioning for Parallel Query

Alphabetic List of Administration Object Types

A C D F G I  P Q R S T

A

altWord

C

crawlerSettings

D

docServiceInstance
docServiceManager
docServicePipeline

F

facetTree

G

globalBoundaryRules
globalDocumentTypes

I

identityPlugin
index
indexOptimizer

P

partitionConfig
proxyLogin

Q

queryConfig

R

relevanceRanking

S

schedule
searchAttr
source
sourceGroup
sourceType
storageArea
suggLink

T

thesaurus

Document Support

Table 2-1 identifies the document formats supported by Oracle SES.

Table 2-1 Document Formats

Document Format	MIME Type
Adobe Framemaker Document	application/x-framemaker
Adobe Framemaker Interchange Format (MIF) Document	application/vnd.mif
Corel Presentations Document	application/vnd.corel-presentations
DICOM Image	application/dicom
DocuShare Ichitaro Document	application/x-js-taro
GIF Image	image/gif
GNU ZIP Archive	application/x-gzip
Haansoft HWP Document	application/x-hwp
HTML	text/html
JPEG 2000 Image	image/jp2
JPEG Image	image/jpeg
Lotus 1-2-3 Document	application/x-lotus123 (also represents application/vnd.lotus-1-2-3)
Lotus AMI Pro Document	application/x-ami
Lotus Freelance Document	application/x-freelance (also represents application/vnd.lotus-freelance)
Lotus Word Pro Document	application/vnd.lotus-wordpro
LZH Archive	application/x-lzh-compressed
Microsoft Excel Document	application/x-msexcel (also represents application/vnd.ms-excel and application/ms-excel)
Microsoft Office Project	application/vnd.ms-project
Microsoft PowerPoint Document	application/x-mspowerpoint (also represents application/vnd.ms-powerpoint)
Microsoft Visio	application/vnd.visio
Microsoft Word Document	application/msword
Microsoft Works Word Processor Document	application/x-msworks-wp
MS Write	application/x-mswrite
PDF Document	application/pdf
Plain Text	text/plain
Quattro Pro for Windows Document	application/x-quattro-win
Rich Text Format (RTF) Document	application/rtf
StarOffice Calc Document	application/vnd.stardivision.calc
StarOffice Impress Document	application/vnd.stardivision.impress
Sun XML Writer Document	application/vnd.sun.xml.writer
TIF Image	image/tiff
WordPerfect 5.1 Document	application/wordperfect5.1
WordPerfect 6 Document	application/x-wordperfect6
XML	text/xml
XyWrite Document	application/x-xywrite
ZIP Archive	application/zip

Globalization Support

Oracle SES provides localization support for source documents, metadata translation, and user queries. You can specify this information in the configuration of administration objects.

Product Languages

Oracle SES user interface components are translated into the languages listed in Table 2-2. The locale of the Oracle SES host system sets the default language for error messages, the Administration GUI, and the Search Application. In the Web services interface, you can set the language for error messages in individual operations.

Table 2-2 Product Languages

Language	Code
Chinese, Simplified	zh_CN
Chinese, Traditional	zh_TW
English	en
French	fr
German	de
Italian	it
Japanese	ja
Korean	ko
Portuguese, Brazilian	pt_BR
Spanish	es

Crawlable Documents

For Oracle SES to crawl and index source documents, they must be stored in a supported language and character set.

Table 2-3 lists the codes for languages supported by the crawler.

Table 2-3 Crawlable Languages

Language	Code
Arabic	ar
Chinese	zh
Czech	cs
Danish	da
Dutch	nl
English	en
Finnish	fi
French	fr
German	de
Greek	el
Hebrew	he
Hungarian	hu
Italian	it
Japanese	ja
Korean	ko
Norwegian	no
Polish	pl
Portuguese	pt
Romanian	ro
Russian	ru
Slovak	sk
Spanish	es
Swedish	sv
Turkish	tr

Table 2-4 lists the codes for character sets supported by the crawler.

Table 2-4 Crawlable Character Sets

Character Set	Code
Standard UTF-8	UTF8
16-Bit UCS Transformation Format	UTF-16
Big 5 Traditional Chinese	Big5
CNS 11643 Traditional Chinese	CNS11643
GB 18030 Simplified Chinese	GB18030
GB2312-80 Simplified Chinese	GB2312
GBK Simplified Chinese	GBK
ISO Latin/Arabic	8859-6
ISO Latin/Cyrillic	8859-5
ISO Latin/Greek	8859-7
ISO Latin/Hebrew	8859-8
ISO Latin-1	8859-1
ISO Latin-2	8859-2
ISO Latin-3	8859-3
ISO Latin-4	8859-4
ISO Latin-5	8859-9
Japanese (Auto-Detect)	JISAutoDetect
Japanese (EUC)	EUC_JP
Japanese (JIS)	JIS
Japanese (Shift-JIS)	SJIS
KSC5601 Korean	KSC5601
Macintosh Arabic	MacArabic
Macintosh Croatian	MacCroatian
Macintosh Cyrillic	MacCyrillic
Macintosh Dingbat	MacDingbat
Macintosh Greek	MacGreek
Macintosh Hebrew	MacHebrew
Macintosh Iceland	MacIceland
Macintosh Latin-2	MacCentralEurope
Macintosh Roman	MacRoman
Macintosh Romania	MacRomania
Macintosh Symbol	MacSymbol
Macintosh Thai	MacThai
Macintosh Turkish	MacTurkish
Macintosh Ukraine	MacUkraine
PC Arabic	Cp864
PC Baltic	Cp775
PC Canadian French	Cp863
PC Cyrillic	Cp855
PC Greek	Cp737
PC Hebrew	Cp862
PC Icelandic	Cp861
PC Latin-1	Cp850
PC Latin-2	Cp852
PC Modern Greek	Cp869
PC Nordic	Cp865
PC Original	Cp437
PC Portuguese	Cp860
PC Russian	Cp866
PC Turkish	Cp857
Windows Arabic	Cp1256
Windows Baltic	Cp1257
Windows Cyrillic	Cp1251
Windows Eastern Europe/Latin-2	Cp1250
Windows Greek	Cp1253
Windows Hebrew	Cp1255
Windows Japanese	MS932
Windows Thai	Cp874
Windows Turkish	Cp1254
Windows Vietnamese	Cp1258
Windows Western Europe/Latin-1	Cp1252

Providing Translations of Object Names

The names of some administration objects are displayed to users in the Search interface, such as source and sourceGroup. You can provide a display name in one or more languages by using the <search:translations> element, as shown here:

<search:name>
   <search:translations>
      <search:translation>
         <search:translatedValue>

Element Descriptions 

<search:name>

Name of the administration object.

<search:translations>

Contains one or more <search:translation> elements.

<search:translation>

Contains a <search:translatedValue> element.

Attribute	Value
language	A code identifying the language of the translated value. The codes are not case sensitive. See Table 2-5, "Query Language Codes".

<search:translatedValue>

Contains a description of the object in the translation language. This value is displayed in the Search Application.

Table 2-5 Query Language Codes

Language	Code
Arabic	ar
Catalan	ca
Chinese, Simplified	zh_CN
Chinese, Traditional	zh_TW
Czech	cs
Danish	da
Dutch	nl
English	en
Finnish	fi
French	fr
German	de
Greek	el
Hebrew	iw
Hungarian	hu
Italian	it
Japanese	ja
Korean	ko
Norwegian	no
Polish	pl
Portuguese	pt
Portuguese, Brazilian	pt_BR
Romanian	ro
Russian	ru
Slovak	sk
Spanish	es
Swedish	sv
Thai	th
Turkish	tr

Encryption

The Administration API provides an encryption system to safeguard sensitive information, such as passwords, contained in the XML description of an object.

When you import an XML document using an operation such as create or update, you can indicate in the XML whether a value is encrypted. In this example, the password is in plain text, which either sets it for the first time or changes it to a new value:

<search:password encrypted="false">password</search:password>

Oracle SES stores the password in an encrypted form. The next example shows an encrypted password, which was exported in an XML document from Oracle SES:

<search:password encrypted="true">
128b6b43091659ffa1ff068666b8eb6445dabd361871b6a5b97941f00ee8c842e76bcc1eb3c0806fd0f6ee2e3ab371febcf053255ffd4e46888909cdd553914bfabe99eda51861d7
</search:password>

When exporting an XML document containing a password, Oracle SES requires you to provide an encryption key. If you use this document as input to an operation (encrypted="true"), then you must use the same encryption key as the export operation so that Oracle SES can decrypt the password.

XML Description of State Properties

Both universal and creatable objects can have state properties. The getState, getStateList, and getAllStates commands return an XML document describing the current state of one or more objects.

The <search:state> element describes the current state of an object.

<search:state>
   <search:objectStates>
      <search:objectState>
         <search:objectState>
         <search:objectType>

<!-- For creatable objects -->
            <search:objectKey>
               <search:keyPairs>
                  <search:keyPair>
                     <search:name>
                     <search:value>

<!-- For all objects -->
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:propertyValue>

Element Descriptions 

<search:state>

Contains a <search:objectStates> element.

Attribute	Value
productVersion	Oracle SES product version
xmlns:search	Namespace for the Oracle SES Administration API

<search:objectStates>

Contains one or more <search:objectState> elements.

<search:objectState>

Describes the state properties of a particular object, using these child elements:

<search:objectType>
<search:objectKey>
<search:stateProperties>

<search:objectType>

Contains an object type with one or more state properties:

identityPlugin
index
indexOptimizer
schedule

<search:objectKey>

Contains the object key that identifies a specific instance of a creatable object type. It contains a <search:keyPairs> element.

<search:keyPairs>

Contains one or more <search:keyPair> elements.

<search:keyPair>

Contains these child elements:

<search:name>
<search:value>

<search:name>

Contains a key name for this object type.

<search:value>

Contains the key value for this object.

<search:stateProperties>

Contains one or more <search:stateProperty> elements.

<search:stateProperty>

Contains a <search:propertyName> element.

<search:propertyName>

Contains the name of a property.

<search:propertyValues>

Contains one or more <search:propertyValue> elements.

<search:propertyValue>

Contains a <search:value> element.

Attribute	Value
key	Provides additional context, such as the name of the data source associated with the property for a schedule that crawls multiple sources.

<search:value>

Contains the current value of the property.

Partitioning for Parallel Query

Parallel querying is automatically implemented on Oracle SES when the partitioning option is enabled. You can specify partitioning only during installation.

You can optimize query performance of large document sources by storing the crawler index in partitions distributed across several independent disks. Oracle SES then executes parallel subqueries automatically against the partitions. Both I/O and CPU resources are used in parallel.

The default tablespaces for Oracle SES are SEARCH_DATA, SEARCH_INDEX, and SEARCH_TEMP.

Note:

You must register additional tablespaces before crawling any sources.

To enable partitioning: 

1. Acquire a license for the Oracle Partitioning option.

2. During installation, answer Yes when the Repository Creation Utility (RCU) asks if you have a partitioning license. Then Oracle Database is installed with partitioning, and Oracle SES automatically supports parallel query.

These administrative objects support parallel query:

• storageArea

• partitionConfig

To add partitioned tablespaces for use by Oracle SES: 

1. Create one or more ASSM (Automatic Segment Space Management) tablespaces using a tool such as Enterprise Manager.

2. Open a searchadmin interactive session as described in "Opening an Interactive Session".

3. Update the storageArea object to register the new tablespaces for use by Oracle SES.

4. Update the partitionConfig object to have appropriate rules and to use the new storageArea objects.

5. Create document sources and schedule them for crawling.

See Also:

Oracle Secure Enterprise Search Administrator's Guide

Example: Adding a Tablespace and Using It in a Partition Rule

This example registers a new tablespace for use by Oracle SES:

1. Create a new ASSM tablespace. This example uses SQL to create a tablespace named NEW_ONE:

   CREATE TABLESPACE new_one DATAFILE '/ses_storage/new_one.dbf' 
      SIZE 8G REUSE AUTOEXTEND ON NEXT 2G MAXSIZE UNLIMITED
      EXTENT MANAGEMENT LOCAL SEGMENT SPACE MANAGEMENT AUTO;
   

2. Using searchadmin, activate the partitionConfig object:

   activate partitionConfig
   

3. Export the XML description of the partition configuration to a file named part.xml:

   export partitionConfig --OUTPUT_FILE=part.xml
   

4. Create an XML file named search_data.xml and describe the NEW_ONE tablespace as an Oracle SES storage area, as shown here:

   <?xml version="1.0" encoding="UTF-8"?>
   <search:config xmlns:search="http://xmlns.oracle.com/search" productVersion="11.2.1.0.0">
      <search:storageAreas>
         <search:storageArea>
            <search:name>NEW_ONE</search:name>
            <search:description>Additional storage area</search:description>
            <search:usage>PARTITION</search:usage>
         </search:storageArea>
      </search:storageAreas>
   </search:config>
   

5. Open part.xml in a text editor and edit the <search:ruleType> and <search:storageArea> elements as shown here. This example hashes all documents into two partitions: one partition in the SEARCH_DATA tablespace, and the other partition in the NEW_ONE tablespace.

   <?xml version="1.0" encoding="UTF-8"?>
   <search:config xmlns:search="http://xmlns.oracle.com/search" productVersion="11.2.1.0.0">
      <search:partitionConfig>
         <search:partitionRules>
            <search:partitionRule>
               <search:partitionValue>EQ_DEFAULT</search:partitionValue>
               <search:valueType>META</search:valueType>
               <search:ruleType>HASH</search:ruleType>
               <search:storageArea>SEARCH_DATA,NEW_ONE</search:storageArea>
            </search:partitionRule>
         </search:partitionRules>
      </search:partitionConfig>
   </search:config>
   

6. Using searchadmin, register the new storage area:

   create storageArea --NAME=new_one --INPUT_FILE=search_data.xml
   

7. Update the partition configuration:

   update partitionConfig --INPUT_FILE=part.xml --UPDATE_METHOD=overwrite