Appendix C: Setting Up Automatic Indexing and Search Functionality

Using the ImportRendered parameters

These parameters are used for import rendering:

ImportRenderedHTMLMoveToDir
ImportRenderedHTMLFilenameExtensions
ImportRenderedHTMLFieldName

You can also perform any reference replacement necessary to get the right path. These settings are equivalent to those used for the DRE document reference.

ImportRenderedHTMLPathReplaceUpToSlash
ImportRenderedHTMLPathReplaceString
ImportRenderedHTMLPathReplaceCSVs
ImportRenderedHTMLRefReplaceWithCSVs

The keyview and PDF slaves temporarily convert all the various formats (for example, Microsoft Word, PDF, Excel, PPT) into HTML. The rendered HTML is then processed to create data in idx ASCII format. You can store the temporary HTML data in a repository on the Web server.

The tables that follow describe each type of import rendering parameter.

**Table C-14: Parsing parameters**
Key	Default	Value	Description
ImportStripTagsCSVs	None	String	Strips the content between begin and end tags; for example: ImportStripTagCSVs=<B> strips all content between `<B>` and `<\B>`.
ImportStripStringCSVs	None	String	Comma-separated list of strings that when matched in a document are stripped from the idx format.
ImportStripLinks	TRUE	TRUE/ FALSE	Specifies whether to remove hypertext links.

**Table C-15: Delimited parameters**
Key	Default	Value	Description
ImportDelimitedExtns	None	String	Specifies the extension of the files that are to be treated as delimited files; for example, .csv files.
ImportDelimitedDoc Start	None	String	Specifies the beginning of a record when you are importing a delimited file.
ImportDelimitedDoc End	None	String	Specifies the end of a record when you are importing a delimited file.
ImportDelimitedStartn	-1	Integer	Specifies the start string of data to be inserted into the idx field. This idx field is denoted by ImportDelimitedFieldn.
ImportDelimitedEndn	None	String	Specifies the end string of data to be inserted into the idx field. The name of this field is specified by ImportDelimitedFieldn.
ImportDelimitedFieldn	None	String	Specifies the name of the field where data from a delimited file is stored. ImportDelimitedStartn and ImportDelimitedEndn specify the data to include in that field.
ImportDelimitedSkip Charsn	0	Integer	When an idx file is produced, a number of characters are skipped at the beginning of a document. This specifies how many characters to skip.

**Table C-16: XML parameters**
Key	Default	Value	Description
ImportXMLFieldn	None	String	Specifies the field in the DRE from which to take the content from the XML file, as defined by the parameter ImportXMLSearchCSVTagsn; for example, if: ImportXMLSearchCSVTags0=head,title ImportXMLField0=DREREFERENCE and the XML file contains the following strings: <head> XML Example </head> <title> Example 1 </title> the DRE field `DREREFERENCE` gets the value: XML Example 1
ImportXMLSearch CSVTagsn	None	String	Searches for the specified XML tags. This can be a hierarchical level of search tags; for example: ImportSMLSearchTags0=body,head,title extracts the content between these tags: `<body></body>` `<head></head>` `<title></title>`
ImportXMLStripTagsn	FALSE	TRUE/ FALSE	Specifies whether to strip the strings between the specified XML tags when importing a file.
ImportXMLExtns	None	String	A comma-separated list of all XML file extensions; for example: ImportXMLExtns=*.xml
ImportXMLEntryOnlyn	FALSE	TRUE/ FALSE	Specifies whether to import only the content between the searched tags at that level; for example, if you set: ImportXMLSearchCSVTags0=TAG1,TAG2 ImportXMLEntryOnly0=TRUE and the XML file contains the following strings: <TAG1> <TAG3> Some Other Tag3 entry </TAG3> <TAG2> Some data <TAG3> The entry for Tag3 </TAG3> </TAG2> </TAG1> The imported content is: Some data Whereas, if you set: ImportXMLEntryOnly0=FALSE The imported content is: Some data The entry for Tag3

**Table C-17: Logging parameters**
Key	Default	Value	Description
ImportLogFile	None	String	Specifies the name of the file used to record the import process.
ImportLogLevel	Errors	Errors Warnings None Full	Specifies the type of logging to be used.
ImportLogFileAppend	FALSE	TRUE/ FALSE	Specifies whether to append details to an existing import log file.

**Table C-18: Binary content parameters**
Key	Default	Value	Description
ImportFilterBinary Content	FALSE	TRUE/ FALSE	Specifies whether to process binary content.
ImportMaxBinaryChars PerHundred	3	Integer	Maximum number of binary characters allowed per 100 characters. Anything exceeding this number is ignored.
ImportMaxAverage WordLength	25	Integer	Binary words with more than this number of characters are not imported.
ImportMinAllowed ASCIICODE	0	Integer	The minimum ASCII value allowed in characters in the binary content. Anything lower is treated as binary and removed.
ImportMaxAllowed ASCIICODE	175	Integer	The maximum ASCII value allowed in characters in the binary content. Anything higher is treated as binary and removed.

**Table C-19: E-mail parsing parameters**
Key	Default	Value	Description
ImportAttachments	FALSE	TRUE/ FALSE	Specifies whether to import e-mail attachments.
ImportSaveAttachments	FALSE	TRUE/ FALSE	Specifies whether to save e-mail attachments in the directory specified by ImportSaveAttachmentDir.
ImportSaveAttachment Dir	.\	String	Specifies the directory path where e-mail attachments are to be saved.

View this book as PDF