ImageNow

Requirements and Installation

Perceptive Enterprise Search 32 or 64 bit version 10
ImageNow with Message Agent version 6.6 or 6.7.
The connector is implemented in ISYS.Federator.DLL and the WebFederator\ImageNow.xml configuration file.

Basic Configuration

This document will guide a user through the process of creating a Federated Connection on the Perceptive Enterprise Search Server to the Message Agent. When users perform a search using Perceptive Enterprise Search, this connection forwards the searches to ImageNow and displays the results.

• Open a browser and login to the Perceptive Enterprise Search's administration site at http://localhost:8700.
• In the navigation pane on the left side of the screen click Indexes.
• Click New Index.
• Select Federated source in the Indexing Wizard and click Next.
• Select ImageNow connector from the list and click Next.
• Enter the URL of the Message Agent component of your ImageNow Server.
• Enter the credentials of a user that can login to ImageNow.
  Note: You can leave Username blank to use the credentials of the user that is currently logged in to Perceptive Enterprise Search. In this case the username and the password must match the ImageNow username and password. See "User Mapping" below.
• Click Next.
• The wizard will attempt to connect to ImageNow. If unsuccessful, an error message will appear.
• Ensure you are using the correct URL and credentials and click Next.
• Choose from the following options:
• Include custom properties as metadata
  Custom properties will appear as metadata in the search results.
• Include workflow queue as metadata
  Workflow queue items will appear as metadata with names "Workflow N" where N is a number. The metadata values are constructed using a template. See "Templates" below.
• Full-text searches in all document keys
  Standalone search terms (i.e. not fielded, see "Query Language" below) will be searched in the document keys. All documents that have at least one of the standalone search terms in any of the document keys will be included in the result. The join operators AND/OR are ignored when you choose this option.
• Full-text searches in document content (requires ImageNow Content Server)
  The result will contain only the documents that contain the standalone search terms in the ImageNow content index. The join operators AND/OR are ignored when you choose this option. This option is ignored if an ImageNow View is selected.
• Session expire (in hours)
  Login sessions will be cached for the specified number of hours to boost the performance of the connector.
• Max results from a document search
  Limits the number of the result items returned. Default is 500. This option is ignored if an ImgageNow view is selected.
• View
  Choose an ImageNow view to be searched.
• Additional criteria for all searches
  This option allows you to specify predefined criteria to be included with every query performed. For example in a multi-drawer environment you may wish to have one connector instance per drawer. Create one connector instance with additional criteria "AND (HR in Drawer)" and a second instance with "AND (Sales IN Drawer)". Searching the first index will only return documents from the HR drawer and searching the second index will return only documents from the Sales drawer. See "Query Syntax" and "Advanced Connector Instance Configuration" below for more details.
• Click Next.
• Enter a search term and click Test on the Test Federated Connection page to ensure the connector is properly configured.
• Click Next.
• Enter a name for the index and click Finish.

The newly created index is ready and will appear in the list of indexes

Searching and Viewing the Results

• Open a browser and navigate to an Perceptive Enterprise Search search site, for example, the Default search site at http://localhost:8080.
• Choose the ImageNow source and click Search.
• If the search is successful, the results are shown.
• For each result item you can do the following:
• Click the green link to download the source document.
• Click Details to view the document metadata.
• Click the title (next to the icon) to view a rendition of the document

Query Language

• Term
  A Term is a single word contained in the query. Terms can represent operators, ImageNow field names, or values to be searched for.
• Phrase
  A Phrase is a set of consecutive value-terms in the query.
• Expression
  An Expression is a set of terms starting with an open parentheses operator-term "(" and ending with a close parentheses operator-term ")".
• Quote
  Text that is enclosed in double quotes (") is treated as a single value-term. Use quotes when an operator-term needs to be searched for, or when you need to use a phrase as a term.
• Join
  Phrases, value-terms and expressions can be joined together with operators "AND" and "OR" (in any alphabetic case). The join operator is ignored for phrases and value-terms when using full-text search in the document content or when searching in a set of more than one document key.
• Fielded Search
  Two terms are joined by a fielded operator. One of the terms is an ImageNow field and the other is a value to be matched.
  
  Syntax: TERM1 OPERATOR TERM2
  Operators:
  
• IN - Contains or matches. TERM1 is the value to be searched for in the field TERM2. TERM1 can be an expression that contains joined terms and phrases. Depending on the field type the operation performed is either exact match or contains. For example "acme in drawer" will perform contains while "1 in pages" will search for exact match.
• GE - Greater or equal. Resolves to TERM1 >= TERM2.
• LE - Lesser or equal. Resolves to TERM1 <= TERM2.
• AFTER - Greater. Resolves to TERM1 > TERM2.
• BEFORE - Lesser. Resolves to TERM1 < TERM2.
• Filter
  Operator followed by a term.
  
  Syntax: OPERATOR TERM
  Operators:
  
• FILEDATEAFTER - return documents that are modified since the date specified in TERM
• FILEDATEBEFORE - return documents that are modified before the date specified in TERM
• Keywords
  Keywords are value-terms and phrases that are not part of a fielded search or a filter. Depending on the connector configuration, the keywords will be searched for in the document keys and/or document content.
  When full-text search in the document keys is allowed, the corresponding search clauses are joined with "OR" and are implemented in the same way as for the fielded search operator "IN".
  If full-text search in the document content is allowed, the result will contain only documents that have the terms and phrases in the keywords index.
• NOT Operator
  NOT reverses the condition of the expression that follows.
  If the connector configuration allows full-text search in the document keys, the expression can consist of keywords. This operator has no effect on document content search.
  Syntax: NOT EXPRESSION

Field Names and Display Labels Mapping

Two tables are used in ImageNow.xml to map between ImageNow internal field names and the corresponding labels that are used when searching in Perceptive Enterprise Search.

Labels to Fields mapping

The first table contains properties with names starting with "Map1.". It maps the names used in Perceptive Enterprise Search to their corresponding ImageNow internal field names. The spaces and dashes in the labels must be replaced with an underscore character. For example, the mapping for the label that is used in the following search performed in Perceptive Enterprise Search.

john in "Checked-out By"
is mapped under name "Map1.checked_out_by" with a value of "CHECK_OUT_USER_NAME".
Multiple labels can be mapped to the same ImageNow field, which allows using aliases. For example the following two searches are the same:

• acme in Drawer
  
• acme in "Drawer Name"
  

since both "Map1.drawer" and "Map1.drawer_name" have the value of "DRAWER_NAME".

Fields to Labels mapping

The second table contains properties with names starting with "Map2.". This table maps the internal ImageNow field names to the corresponding display labels to be used in Perceptive Enterprise Search. This one-to-one mapping is used to present the fields from an ImageNow document as metadata names in Perceptive Enterprise Search.

If the map does not contain a mapping for some document field, the field will be omitted from the result.

When a view is used for searching and the view definition contains a custom label for a document field, the label will be used instead of the one defined in the map.

Metadata Templates

Some of the metadata values that are shown in Perceptive Enterprise Search allow for customized templates to be used when building the metadata value. The template definition is included in ImageNow.xml under the property names ending with "Template". These are for the Title, Filename, Summary and Workflow item metadata values. Two additional templates are also available to prepare all workflow items and all the custom properties as a single metadata value respectively.

The template can contain static text and operators with the following syntax:

• Label - %#FIELD% will be replaced with the label of a field as the value found for the name "Map2.FIELD" or defined as a custom label in the view definition
• Value - %$FIELD% will be replaced with the value of the ImageNow field
• Conditional Output -
  %?FIELD% output1 %!FIELD%
  %?FIELD% output1 %*FIELD% output2 %!FIELD%
  If the value of the ImageNow field is not empty, output1 will be included in the result. If the second form is used and the value is empty, output2 will be included in the result.
• Fields - The FIELD in the operators above can be replaced with one of the following names that match ImageNow fields:
• DOCUMENT_TYPE_NAME
• DRAWER_NAME
• FOLDER
• TAB
• FIELD3
• FIELD4
• FIELD5
• DOCUMENT_ID
• SCAN_USER_NAME
• SCAN_TIME
• MOD_USER_NAME
• MODIFICATION_TIME
• LAST_VIEWED_USER_NAME
• LAST_VIEWED_TIME
• VERSION_COMMENTS
• CHECK_OUT_USER_NAME
• CHECK_OUT_TIME
• CHECK_OUT_NOTES
• CHECK_IN_USER_NAME
• CHECK_IN_TIME
• PRIVATE_USER_NAME
• FILE_TYPE
• TASK_DATE
• TOTAL_PAGES
• IS_UNDER_VERSION_CONTROL
• VERSION_NUMBER
• IS_CHECKED_OUT
• IS_VERSION_PRIVATE
• TASK_COUNT_ACTIVE
• TASK_COUNT_INACTIVE
• TASK_STATE
• IS_IN_PROJECT
• VERSION_DIGITAL_SIGNATURE_STATUS
• The following names do not directly match ImageNow fields:
• WORKFLOW_QUEUE_INFO_COUNT - Number of workflow items
• CUSTOM_PROPERTY_COUNT - Number of custom properties
• WORKFLOW_QUEUE_INFO - All the workflow items, each one built using the WorkflowInfoTemplate. This template can contain only the following field operators: USER, NAME, ID, STATUS and N, where N will be replaced with the next sequential number, starting form 1.
• CUSTOM_PROPERTY - All the custom properties, each one built using the CustomPropertyTemplate. This template can contain only the following field operators: ID, NAME, ACTIVE, TYPE, TYPE, VALUE and N, where N will be replaced with the next sequential number, starting form 1.
• CUSTOM.NAME_OR_INDEX - Using this, with NAME_OR_INDEX replaced by the name or 1 based index of a custom property, will return its value.

Additional Options

The following additional options are available in the ImageNow.xml:

YES and NO

Map the labels to be used when representing Boolean values, such as the value "Is In Project" ImageNow field.

APP_CONTEXT

This parameter will be used when logging to the ImageNow server.

LogFilePath

The full path (including the filename) to a log file that will be used by the connector for tracing and debugging purposes.

LogOptions

Space-separated list of events to be logged. Currently defined are "debug" and "info".

FullTextKeys

Space-separated list of ImageNow field names to be used for full-text search when the "Full text searches in all document keys " (FullTextAllKeys) option is not selected in the wizard.

SortOrder

Space-separated list of ImageNow field names to be used as the default sorting order for the results. Use properties that start with "MapS." to define custom sort order, based on a space-separated list of ImageNow field names. For example, a property that is defined as "MapS.author" with a value of "CREATION_USER_NAME" will sort the results by the ImageNow field CREATION_USER_NAME when sort by author is selected in the results page of the Perceptive Enterprise Search search site. The sorting orders "date" and "datetime" are internally mapped to "MOD_TIME CREATION_TIME".

Columns

Space-separated list of ImageNow field names to be requested from the server. If empty, all fields will be requested. Only applies for connector instances that do not use an ImageNow view.

User Mapping

If Username is not specified in the wizard, the following ImageNow.xml properties can be used to map between the name of the current user and the corresponding username to be used when connecting to ImageNow:

• MapU.domain_username - Properties that start with "MapU." form a static map that converts the login user that matches "domain_username" to the ImageNow username. The username and underscore character (_) are required; domain is optional.
• UserMapping.Match - The value of this property can be a regular expression that will match the name of the user, constructed in the form of "domain_username". For example the name ".\john" will be "_john" while "acme\john" and "john@acme" will be "acme_john". This property can be used in conjunction with "UserMapping.Replace".
• UserMapping.Replace - The value of this property can be a regular expression that will replace the result of the match that was performed using "UserMapping.Match".

Advanced Connector Instance Configuration

When a connector instance is created using the wizard in the Perceptive Enterprise Search Administration site, the instance properties are written to the ISYSWEB.CFG configuration file in the Perceptive Enterprise Search program folder. Connector instance properties override the global connector properties that are defined in the ImageNow.xml configuration file. To modify instance properties, open ISYSWEB.CFG in a text editor and find the ISYSweb/Indexes/Index node that has the name you used for the index when you created the connector in the wizard. The options that are selected in the wizard will be included as attributes to this node along with other general index attributes. To override the ImageNow.xml property for this instance, use an attribute with a name that matches the name of a property from ImageNow.xml. For example, if you wish to add an alias for the CREATION_USER_NAME ImageNow field to be known also as author, add the following attribute (See "Field Names and Display Labels Mapping" for more details):

Map1.author="CREATION_USER_NAME"

Below is an excerpt of the ISYSWEB.CFG file, showing the modified node:

<ISYSweb>
	<Indexes>
		<Index Name="ImageNow" Online="1" Driver="Federated" Source="WebFederator\ImageNow.xml" URL="http://IMAGENOW:6070/imagenow/services/1.0/" value="ImageNow" Map1.author="CREATION_USER_NAME"/>
	</Indexes>
</ISYSweb>