Working with User Defined Lists (UDLs)
Indexes (like labels on file drawers and file folders) allow easy search and access of Documents stored within an Application, and are the building blocks upon which Applications are built. User Defined Lists are a special category of Index, as they allow you to set an Index as a drop-down or multiple choice list.
TIP
To access the User Defined Listsscreen: from the main header, go to Administrationu CAPTUREuUser Defined Lists.
NOTE
UDLs and Indexes may only be added and edited by Users and via automation with the appropriate permissions.
Tell me about...
User Defined Lists allow for customization of Document Capture and help to ensure consistent and accurate entry of values: avoiding errors such as typos, or accidental variances in Indexing, and speeding up data entry by using a selection instead of typing. In addition, more than one Index field may be associated with the same UDL in the same or different Applications so that the same list of values can be used in associated Index fields. Using common UDL values is also a powerful way to compare and search Documents.
EXAMPLE
If the Document Type Index is a plain text field, rather than a drop-down list, you could enter any number of things that may or may not associate with various Documents. However, if instead, the Document Type is provided as a UDL (i.e., made up of a pre-defined list of options), you can simply select the appropriate option keeping the association, searches, and results consistent.
BEST PRACTICE
Because Indexes and UDLs can be used across multiple Applications, it is a good idea to add a prefix indicator to the name of the UDL so that you know which ones are for specific Applications. For example, generally all Applications have a "Doc Type" or "Document Type." Most Applications have different types of Documents associated with them (e.g., HR Documents are very different than AP/AR Documents). This is where the prefix helps you to differentiate between UDLs when creating an Application.
UDLs provide valuable benefits in indexing efficiency and consistency; however, there are certain requirements that must be observed. UDLs and UDL values:
- can only be altered through the editing features by a User with the required UDL administrative permissions to protect the integrity of UDL definition.
- must be carefully created and maintained since the values selected from UDLs are stored as data in the DocuPhase database.
- should not be changed or deleted as this can prevent Documents (already Indexed using original values) from being accessed or found during a search. If such a change is absolutely necessary, there are specific steps which must be followed (as described below).
In DocuPhase, an Index is similar to a label found on a traditional paper file folder tab. Indexes also provide a varied selection of formatting such as text entries of certain lengths, date formats (presenting a calendar for date selection, numeric, decimal, and some are based on a drop down (created from UDLs as described above). Indexes give you the freedom to easily customize the DocuPhase Platform with language and terminology specific to your business.
Additionally, Indexes (fields):
- help Users find the Documents they’re looking for by enabling fast and precise searching. The storage and retrieval of Documents within DocuPhase relies on Indexes, much the same way as traditional cabinets and folders rely on proper labels to locate information, but in a much slower and less-flexible way than DocuPhase.
- describe a Document's type and status, as well as other information used by all components in the DocuPhase Platform.
- can be customized or System Indexes.
- may include certain fields that must be completed prior to Document capture (i.e., required fields).
System-assigned Index fields are automatically contained within every Application. These Index fields contain values used by the DocuPhase Repository to track events and changes in the status of Documents in DocuPhase. You can specify which (if any) System Index fields are included in Search criteria. Click on the System option in the list of Indexes of any Application to display a list of the selected subset of the available System Index fields.
NOTE
System reports and various system administration Tasks make use of the System Index values.
Index Label | Description |
---|---|
Pages (From) | Allows you to search for a Document with a specific range (number) of pages.
EXAMPLEIf you know a Document you need is definitely more than 1 page, but probably not more than 4, you can search for a page (range) hereby entering 2 to 4, to find all Documents in the selected Application that contain at least 2 and no more than 4 pages. |
CreatedBy | You can use this Index to search for the name of the User who originally submitted the Document to DocuPhase. |
CreateDate | Search for Documents by the date within a range of dates during which it was submitted to DocuPhase. |
ModifiedBy | You can use this Index to search by the name of the User who most recently edited (modified) a Document.
NOTEIn order for a Document to be considered as "modified", it must be opened and edited/changed; simply accessing a Document, without changing it, is not considered a modification. |
ModifiedDate | Search for Documents modified within a range of dates.
NOTEIn order for a Document to be considered as "modified", it must be openED and edited/changed; simply accessing a Document, without changing it, is not considered a modification. |
BatchID | Every time a Document (or set of Documents) is Captured (submitted) into DocuPhase, the transaction processed by the system is tagged with a unique Batch ID code. You can use this identifier to search for a Document within the Repository.
NOTEEvery Document has both an Object ID and a Batch ID. An Object ID is unique to a specific Document; each Document having its own Object ID; while a Batch ID is assigned to a Document or a group of Documents submitted in a group of one or more. EXAMPLEIf four Documents are submitted together, they all have the same Batch ID, but individual Object IDs. If only a single Document is submitted, it will have both unique Batch and Object IDs. |
IsForm | This Index allows you to search specifically for Documents that are Forms (True) or not Forms (False). If no option is set in this field, both form and non-form Documents are returned in the search based on other criteria specified. |
Object Status | In this case, "object" is the same as Document. This Index allows you to select a designated status to include in the search criteria for a Document. |
Checked Out by User | Provides a drop-down list of Users who have permissions to check out a specific Document; you can search if you know the person who last checked out a Document.
EXAMPLEIf you know that Susan checked out a particular Document, you can select her name from the list to display a list of Documents Susan has checked out (depending upon any other criteria you set). |
Records Per Page | Use this option to set the number of results per page you want displayed for any search results. |
Notes | You can use this field to add notes to any Document you are Indexing. Any note that has been added in this field can be reviewed from the Search Results page. Tell me more... |
These Indexes are set up when an Application is created for/by your organization. They can be as varied as the Applications within your system.
There are five common/recommended Indexes used for any Document (or variations of these):
Status | Format |
---|---|
Doc Type | This is created as a UDL - with a list of Documents used in the corresponding Application
EXAMPLES
|
Process Status (Location) | This is best as a UDL. These differ based upon Application, but can indicate any sort of status that relates Documents to any sort of process (i.e., it lets you know where Documents exist within the processes set up by/for your organization).
EXAMPLES
|
Date | You can enter or select a date from a Calendar.
EXAMPLES
|
Name | This is generally a text field into which you can enter the name of an entity.
EXAMPLES
|
Unique Identifier | A text or numerical Index field is usually the format of this kind of field. However, either way, it's a way to give a Document it's own, unique identifier.
EXAMPLES
NOTEThis may be an uneditable, system-generated field set up by/for your organization. |
When a Document is uploaded into the Repository, it must be "Indexed" so that it can later be found when needed. Indexing is the process of adding data to Index fields: making it possible to search for and find specific Documents or sets of Documents.
Once properly Indexed, a Document or file may be submitted for capture to the DocuPhase Platform for storage, management, and protection.
Documents in the DocuPhasesystem ALWAYS have 2 types of statuses: Object and Process as described below.
Object Status Descriptions
The Object Status is automatically assigned by the system, but can be changed in various places if permissions are in place. These are generally one of several statuses:
NOTE
Other Statuses may exist in DocuPhase depending upon the system configuration for your organization.
Status | Indicates that... | |
---|---|---|
E | Entered | the Document "searchable" (i.e., can be found in a search). NOTEThis is the default status. |
P | Pending | auto-Indexing was attempted by the system, but now requires human intervention (i.e., an exception or error has occurred during the auto-Indexing process). |
I | Inbox | the Document has been routed to an individual's inbox.
NOTEThis status is not commonly used in more current DocuPhase solutions, and is not available when Progression/Workflows are in use; it is only used by DocuPhase for Document Management purposes. |
X | Deleted | the Document that has been "soft-deleted." Tell me more... |
C | Corrupt | the Document is somehow corrupt.
NOTEThis status is only used when DocuPhase xTractor is in use. |
Y | Source Copy | the original copy of a large, multi-page file that hasbeen separated into smaller sections. |
A | Xtractor | the Document that is awaiting processing by using DocuPhase xTractor.
NOTEThis status is only used when xTractor is in use. |
R | Data Exchange | The related Document has been routed to Data Exchange.
NOTEThis status is only used when Data Exchange is in use. |
Process Status Descriptions
The Process Status of a Document depends on the Application to which it belongs. Each Application has its own set of Process Statuses. These statuses are applied to a Document as it moves through the DocuPhase Document Management system. The Process Statuses available in an Application depend upon the way the system is being used and has been configured for/by your organization.
NOTE
Because of how and when they may appear in the system, Process Statuses may also be referred to as Process Locations.
EXAMPLES
Some examples of Process Statuses for various Applications, might be as follows:
Claims Application Process Statuses
- Approved
- Boarded
- Closed
- Denied
- Funded
- Missing Info
- Pending
- Rejected
- Reviewed
- Underwriting
Purchase Orders Application Process Statuses
- Back Ordered
- Canceled
- Completed
- Credit Hold
- Hold
- New
- Pending
- Resubmitted
HR Application Process Statuses
- Applicant Accepted
- Declined
- Background Check Failed
- Background Check Passed
- Hired
- In-Person Interview Scheduled
- Pending Acceptance of Offer Letter
- Phone Interview Scheduled
- Send Offer Letter
Tell me how to...
UDLs (User Defined Lists) allow you to set up pre-defined drop-down lists to be used as Indexes in Applications.
BEST PRACTICES
- Create UDLs before you create an Application.
- Add a prefix indicator to the name of the UDL so that you know which ones are for specific Applications. Tell me more...
In the Add List field, on the User Defined Lists screen:
1) Enter the name for the new UDL.
2) Click to display the details fields.
In the Add Item field:
3) Enter an item to be shown in the drop-down.
4) Click to display the new items in the List Items... list.
Repeat steps 4 and 5 above until you have added all the items to the list.
Once all items have been added:
5) Use the following to change the order in which you want the items to appear in the drop-down list.
- Move up/Move Down to move the highlighted item(s) up or down within the list.
- Sort Ascending/Descending to change the order of the entire list.
6) Click to complete and save the UDL: making it available from the Add/Edit Application screens.
Repeat steps 1 through 7 above for every UDL you want to add.
Using extreme caution (see warnings below), you can make changes to, or delete, User Defined Lists.
WARNINGS!!!
BEFORE making changes or deletions to a UDL or its List Items:
- It is recommended that this process be done when no one is currently using the system, if possible.
- It is possible that some Users have the prior UDL list of values in cache memory, and therefore may not immediately see the recent changes . IF this occurs, use the Reset DocuPhase feature to ensure that the latest changes to the UDL are downloaded after the reset. For this reason, it is best to deploy UDL changes during times of little or no production activity.
- If changing or deleting one or more UDL List Items, you must take care to do the following in order to prevent errors and problems in Document Indexing:
a) Add a replacement value to the UDL list before deleting any item.
b) Locate all Documents in the Repository that contain the value(s) you are about to change or delete.
c) Apply the replacement list item value(s) in the UDL (or the default "NULL") to all affected files.
- Removal of an entire UDL also requires similar care once the DocuPhase UDL definitions have been implemented.
In the List of existing UDLs, on the User Defined Lists screen:
1) Find and click on the UDL you want to edit or delete to display the corresponding details.
2) Make changes as needed: making sure to observe the WARNINGS! noted above:
- Add an item to the list.
- Delete an item from the list by highlighting it, then clicking .
- Change/Correct an item by first adding a new UDL with changed/corrected wording, then deleting the original UDL.
- Delete the entire UDL by clicking to display a confirmation prompt, then deleting the entire list.
If you have made changes to the list itself:
3) Click to complete and save the changes.