/
ApplicationXtender - Admin - Add/Modify Index Fields

ApplicationXtender - Admin - Add/Modify Index Fields

You will learn how to add, modify, and delete index fields within an Application.

Table of Contents

Getting Started

This article was written for ApplicationXtender 8 and newer. The Administration console was moved to a website known as “AppXtenderAdmin”. The experience is nearly the same when managing an application and working with the index fields.

Requirements

  • You will need access rights to modify applications.

Access the Application Editor

If you plan to modify an existing application, ensure that there are no open sessions or PID’s against the application otherwise you will get an error. Review ApplicationXtender - Admin - Clear PID Table .

Log into your administration console. For this case, we’ll be using the new ApplicationXtender Admin console.

image-20250114-163514.png
  1. Select Application Management

  2. Select your datasource (AppEnhancerDEMO for this demonstration)

  3. Select Applications

  4. Find and click the name of the application to go to the editor.

Application Field Editor

Select the Fields tab of the Application editor and you will be presented with the list of index fields for the application.

image-20250114-163633.png

Adding a field

  1. To the right pane of the editor, you can fill in the following details:

    1. Field Name - Displayed on the UI and search criteria.

    2. Data Type - the type of the field

      1. Learn more about the data types below.

    3. Length - Specify the field length of maximum amount of characters or digits.

    4. Format - Only applies to specific data types such as date, currency, SSN, etc.

Modifying a field

  1. Click the field name on the Field Name column.

  2. Make changes to the field.

  3. Click “Modify” once you’re finished.

Deleting a field

  1. Click the checkbox to the left of the column ID in the list of fields and then click “DELETE” to the right pane.

  2. Confirm the dialog.

  3. Click “Save”.

Saving Changes

Once you’ve made all the changes, click “SAVE” at the bottom of the page to apply your updates.

Field Data Types

Data type

Available conversions

Data type

Available conversions

Currency

Decimal/Numeric, Integer, or Text

Date

Time Stamp or Text

Decimal/Numeric

Integer, Currency, or Text

Integer

Decimal/Numeric, Currency, or Text

SSN

Integer or Text

Telephone

Text

Text

Anything but Boolean Choice or User-defined

Time

Time Stamp or Text

Time Stamp

This field becomes read-only and is populated with the date and time the document was imaged.

Zip Code

Integer or Text

User-Defined List

A list of choices/items that are configured by the administrator.

Learn more about User-Defined lists below.

Field Flags

You can apply flags to the field to change the beheavior and functionality of that field.

Flag

Description

Flag

Description

Required

Requires a user to enter data in this field.

Search

Enables this field for searching.

Read-Only

Protects this field from being modified.

Doc Level Security

Enables or disables user access based on the contents of this field.

Part of Unique Key

Requires unique data in this field for each document.

Dual Data Entry

Requires a user to enter this data twice as a validation measure.

Key Reference

Used for key reference file indexing. If you set this field, you must also define at least one Data Reference field. If you select this, a new tab Key Reference File appears. After you have created an application with this Key Reference flag, you cannot clear it while modifying an application.

Data Reference

Used for key reference file indexing. If you set this field, you must also define a Key Reference field. If you select this flag and if there is no Key Reference File tab, a new tab Key Reference File appears. When an application is created, you cannot clear the Data Reference flag while modifying an application.

Auto Index

Populates the index of document from imported data. If you select this, a new tab Auto Index File appears.

Validation Mask

Creates and sets a template format for this field. If you enable Validation Mask for a text field when defining your index fields, the Format text box is enabled so that you can create a mask. AppEnhancer supports input validation and field display masks.

Leading Zeroes

Preserve leading zero characters in an integer field.

Hidden

Designates a field as hidden. You cannot apply the RequiredDoc Level SecurityPart of Unique KeyDual Data EntryKey Reference, or Auto Index flags to any hidden fields.

Validation Masks

To enable only this format

Enter this in the field validation mask dialog box

To enable only this format

Enter this in the field validation mask dialog box

Any two alphabetic characters and four numbers

aannnn

A plus or minus sign, two numbers, a space, and three numbers

xnnznnn

Letter A followed by five numbers

Annnnn

Two numbers, a hyphen and an alphabetic character

nnxa

User-Defined Lists

Performance Impact

A large number of items (more than 400) in a user-defined list adversely affects performance. For example, if an application has three user-defined list fields, each of which has 200 items, then the effect is equivalent to having one user-defined list field with 600 items.

You can add an unlimited number of items to the list of choices that can be picked when indexing or searching a document within the application.

When you click “ADD” on the new index field, you will be presented with the dialog below.

Adding Items

  1. Enter the name of the item.

  2. Click “ADD”.

  3. Repeat for each additional item you wish to add.

  4. When finished, click “Ok”.

Importing

To import text from a file for use as a list item:

  1. click IMPORT

  2. click Choose File to browse and select a file for import.

Re-Ordering

  1. Select the item in the list.

  2. Click the corresponding button that’ll move the item.

    1. Move to Top - Moves item to the top of the list.

    2. Move Up - Moves item up the list.

    3. Move Down - Moves item down the list.

    4. Move to Bottom - Moves item to the end of the list.

Sorting List

  1. Click “SORT” button next to the search field on top of the list table.

  2. Select Ascending, Descending or original ordering.

  3. Click “Ok”.

Related content

ImageSilo - Modifying an existing index field
ImageSilo - Modifying an existing index field
More like this
Kofax-Adding New Index Fields to a Batch Class
Kofax-Adding New Index Fields to a Batch Class
More like this
ApplicationXtender - 8 - Data Dictionary
ApplicationXtender - 8 - Data Dictionary
More like this
Index Fields
More like this
ECMToolbox - Workflow Fields
ECMToolbox - Workflow Fields
More like this
PVC - Add/modify index fields
PVC - Add/modify index fields
More like this

Copyright © CASO Document Management

All product names, logos, brands, and trademarks featured or referred to on this page are the property of their respective trademark holders. These trademark holders are not affiliated with, nor do they sponsor or endorse this website or the products/services offered unless explicitly stated otherwise.