Configuration of Index Data Display

enaio® appconnector • 11.0 »

Showing Index Data

enaio® appconnector has two types of result output. First the verbose mode, which is activated at many endpoints via the query parameter verbose=true, and second the classic title/subtitle output. The latter output format creates a title and subtitle field in JSON from the index data fields of an object. The first mandatory field is selected as the title and the second and third mandatory fields as subtitles using the tab order. If the exact mandatory fields do not exist, further normal index data fields of the object are used.

The Configuration File OSMetadata.xml

If this automatic operation is not desired, the OSMetadata.xml configuration file in the configuration\schema program directory can be used by the administrator to specify a fixed schema for all users for the desired object types. The title and subtitle outputs are used by the enaio® apps to display hit lists.

The OSMetadata.xml file is installed by the setup and can be found in the configuration\schema directory. You will need to adjust the file as the OSMetadata.xml configuration file contains sample data by default.

<?xml version="1.0" encoding="UTF-8"?>
        <archive>
        	<model>
			<property name="title"/>
			<property name="info"/>
		</model><cabinet name="Customer">
         <object name="Miscellaneous">
             <property name="title" field="Type"/>
             <property name="info" field="Short text"/>
         </object>
         <object name="Support call">
             <property name="title" field="Call_no + ' ' 
+ Status"/>
             <property name="info" field="Problem"/>
         </object>
         <object name="Sales">
             <property name="title" field="Type"/>
             <property name="info" field="Short text"/>
         </object>
         <object name="Customer">
             <property name="title" field="Company name"/>
             <property name="info" field="Street + ' ' 
+ ZIP + ' ' + City"/>
         </object>
         <object name="E-mail">
             <property name="title" field="'E-mail from: '
 + MAIL_FROM"/>
             <property name="info" field="MAIL_SUBJECT"/>
         </object>
         <object name="Person">
             <property name="title" field="First name + ' ' + Name"/>
             <property name="info" field="Classification"/>
         </object>
         <object name="Incoming invoice">
             <property name="title" field="'Invoice '
 + Invoice number"/>
             <property name="info" field="'From ' 
+ Invoice date + ', ' + Status"/>
         </object>
         <object name="Document">
             <property name="title" field="Type"/>
             <property name="info" field="empty(description) ? 
'empty' : description"/>
         </object>
         <object name="History">
             <property name="title" field="Type"/>
             <property name="info" field="Topic"/>
         </object>
     </cabinet>
     <typeless>
         <property name="title" field="if (OBJECT_MAIN == 3)
 { y= 'Image'; } else { y = 'File'; y }"/>
         <property name="info" field="'Created on: ' + 
OBJECT_CRDATE"/>
     </typeless>
     <notification>
         <workflow>
             <property name="title" field="ActivityName"/>
             <property name="info" field="ActivitySubject"/>
         </workflow>
     </notification>
 </archive>

The fields 'title' and 'info' are defined in the <model> area and shown in the enaio® apps and can be filled with the index data of enaio® object types.

The tag <cabinet name="Name of the cabinet"> is then entered for every cabinet in the configuration file. Within this tag, index data fields are mapped for the individual object types (<object name="Name of the object">). For this purpose, the name of the field is defined in the <property> tag in the name attribute, and the index data from enaio® are referenced in the field attribute. It is possible to freely configure the values of different index data fields using a special script language (see 'Configuration Scripts').

Typeless documents are defined by the <typeless> tag. In this tag, the main type of the object (OBJECT_MAIN) and the creation date (OBJECT_CRDATE) are assigned to app fields.

Please note that only internal object type names of the object definition can be used to assign enaio® index data.