Index Field Settings: Difference between revisions

From Simple Wiki
(Created page with "== Index Field Settings == File:SimpleIndex Simple Setup Configuration Index Field Steps.png|300px|thumb|alt=SimpleIndex Simple Setup Configuration Index Field Steps|Si...")
 
No edit summary
Line 1: Line 1:
== [[Index Field Settings]] ==
[[File:SimpleIndex Simple Setup Configuration Index Field Steps.png|300px|thumb|alt=SimpleIndex Simple Setup Configuration Index Field Steps|SimpleIndex Simple Setup Configuration Index Field Steps]]
[[File:SimpleIndex Simple Setup Configuration Index Field Steps.png|300px|thumb|alt=SimpleIndex Simple Setup Configuration Index Field Steps|SimpleIndex Simple Setup Configuration Index Field Steps]]


Line 11: Line 9:
If a data source has been configured, the [[Database]] Mapping options will be displayed. Select the corresponding field in the database to use for data export.
If a data source has been configured, the [[Database]] Mapping options will be displayed. Select the corresponding field in the database to use for data export.


=== Required ===
== Required ==


When this option is selected, the user will not be able to finalize a batch unless all images have been saved with a value for this field.
When this option is selected, the user will not be able to finalize a batch unless all images have been saved with a value for this field.


=== Folder ===
== Folder ==


Adds this field to the [[File Naming Schema]] as a subfolder.  
Adds this field to the [[File Naming Schema]] as a subfolder.  
Line 23: Line 21:
If multiple folder fields are selected, nested subfolders are created in order from top to bottom.
If multiple folder fields are selected, nested subfolders are created in order from top to bottom.


=== Filename ===
== Filename ==


Adds this field to the [[File Naming Schema]] as a filename part.  
Adds this field to the [[File Naming Schema]] as a filename part.  
Line 31: Line 29:
If multiple fields have this option checked, the filename will contain all the values in top to bottom order, separated by the [[Field Separator]] character.
If multiple fields have this option checked, the filename will contain all the values in top to bottom order, separated by the [[Field Separator]] character.


=== Forward ===
== Forward ==


This option “carries forward” the field value to subsequent images until a new saved value is encountered. Use this to index multi-page documents without having to re-type the index data for each page.  
This option “carries forward” the field value to subsequent images until a new saved value is encountered. Use this to index multi-page documents without having to re-type the index data for each page.  
Line 39: Line 37:
When using coversheets created with [[SimpleCoversheet]] or another [[barcode]] application, the forward option will automatically apply the [[barcode]] values to all the pages between the coversheets.
When using coversheets created with [[SimpleCoversheet]] or another [[barcode]] application, the forward option will automatically apply the [[barcode]] values to all the pages between the coversheets.


=== Database Mapping ===
== Database Mapping ==


Use these settings to map the index field to a field in your database. Depending on the selected [[Database Mode]], records will be added, modified or searched, and [[List fields]] will be populated with unique records from this field.
Use these settings to map the index field to a field in your database. Depending on the selected [[Database Mode]], records will be added, modified or searched, and [[List fields]] will be populated with unique records from this field.


=== Database Field Name ===
== Database Field Name ==
Select the database fields that correspond to the fields you define under the Index tab. If there is no corresponding database field, then leave this value blank.
Select the database fields that correspond to the fields you define under the Index tab. If there is no corresponding database field, then leave this value blank.


=== Editable ===
== Editable ==
This option is only used in [[Update mode]]. For each field, select this option if you want to allow the user to edit the values in this field. Leave it unchecked if you want to use the existing values for reference or file naming only and not allow the user to modify its value.
This option is only used in [[Update mode]]. For each field, select this option if you want to allow the user to edit the values in this field. Leave it unchecked if you want to use the existing values for reference or file naming only and not allow the user to modify its value.


=== Filter ===
== Filter ==


This option allows you to define default search criteria for [[Retrieval]] and [[Update]] modes. Whenever the search screen is displayed, the value(s) entered here is displayed in the search criteria for that field. This makes it possible to add default filters to automatically search a certain subset of documents or make it easier to perform searches by partially filling search fields.
This option allows you to define default search criteria for [[Retrieval]] and [[Update]] modes. Whenever the search screen is displayed, the value(s) entered here is displayed in the search criteria for that field. This makes it possible to add default filters to automatically search a certain subset of documents or make it easier to perform searches by partially filling search fields.

Revision as of 21:57, 14 January 2022

SimpleIndex Simple Setup Configuration Index Field Steps
SimpleIndex Simple Setup Configuration Index Field Steps

Enter the name or label to use to identify the field. File naming options can be selected here, but these options are more easily configured from the Index & File Naming screen so you can see how they interact with the other index fields.

For OCR and Barcode fields, the Text Matching Type option will be displayed. Select the desired option to display the corresponding Index Field Wizard page in the following step.

When you select Both, the template will be matched first and then the dictionary list is matched against the template match result. This can prevent false positives when dictionary terms can appear in other places on the document.

If a data source has been configured, the Database Mapping options will be displayed. Select the corresponding field in the database to use for data export.

Required[edit | edit source]

When this option is selected, the user will not be able to finalize a batch unless all images have been saved with a value for this field.

Folder[edit | edit source]

Adds this field to the File Naming Schema as a subfolder.

This option uses the index values to create subfolders in the Output folder.

If multiple folder fields are selected, nested subfolders are created in order from top to bottom.

Filename[edit | edit source]

Adds this field to the File Naming Schema as a filename part.

When this option is selected, the image files are exported using this index field value.

If multiple fields have this option checked, the filename will contain all the values in top to bottom order, separated by the Field Separator character.

Forward[edit | edit source]

This option “carries forward” the field value to subsequent images until a new saved value is encountered. Use this to index multi-page documents without having to re-type the index data for each page.

When unchecked, each page must be indexed individually.

When using coversheets created with SimpleCoversheet or another barcode application, the forward option will automatically apply the barcode values to all the pages between the coversheets.

Database Mapping[edit | edit source]

Use these settings to map the index field to a field in your database. Depending on the selected Database Mode, records will be added, modified or searched, and List fields will be populated with unique records from this field.

Database Field Name[edit | edit source]

Select the database fields that correspond to the fields you define under the Index tab. If there is no corresponding database field, then leave this value blank.

Editable[edit | edit source]

This option is only used in Update mode. For each field, select this option if you want to allow the user to edit the values in this field. Leave it unchecked if you want to use the existing values for reference or file naming only and not allow the user to modify its value.

Filter[edit | edit source]

This option allows you to define default search criteria for Retrieval and Update modes. Whenever the search screen is displayed, the value(s) entered here is displayed in the search criteria for that field. This makes it possible to add default filters to automatically search a certain subset of documents or make it easier to perform searches by partially filling search fields.