How to Manage Fields

This article provides both visual and written instructions for managing field properties and creating search profiles.


Video Tutorial

HubSpot Video

Fields are discrete items of data (including metadata) which taken together constitute a record; in Reveal these fields store information about the project's documents and are managed from the Fields tab under Project Admin. To manage fields:

  1. Login to Reveal as an Administrator.
  2. Click Admin in the toolbar at left.
  3. Project Admin will open in a new window.
  4. Select Fields. This will open to the Field Profiles tab.
  5. The other tabs - Search ProfilesModify Fields and Add Fields - are discussed below.

Field Profiles

02 - 01 - Field Profile Window

Field Profiles individually define a list of fields and their display and sort order for assignment to Teams. When a project is first created, a Default Field Profile is automatically created to include a set of standard fields available in the database. 

This Field Profile is assigned to all users unless a different profile is explicitly assigned. A project may only have one Default Field Profile, and the project manager can specify which fields should be present (and their order of presentation) in the Default Field Profile. Other field profiles might be used for second level review, privilege review, contract reviewers, or any level of review that would need to see different fields displayed. 

To create a field profile:

  1. In the Field Profiles tab under Fields, click +Add.
  2. In Add Field Profile, you may first elect to set this profile as the default.
  3. Enter a readily-understandable Name.
  4. You may enter an optional Description of the intended purpose of this profile.
  5. Assign Teams which will be able to access this field profile.
  6. Assign Fields is where fields are assigned in specified order to the profile and the Sort Order is set.
    1. In the Display Order tab, either drag and drop or select and right arrow [>] fields from the list of all available fields at left to the Profile Fields at right. (Clicking the [>>] button will move all fields to the profile list and is not recommended.) Fields may also be removed from the profile by dragging and dropping from right to left or clicking the left arrow [<] button.
    2. Once fields are in the profile list, they may be positioned in order by grabbing the handle at left of the field label and dragging up or down.
    3. Click the 'eye' icon to set whether the field is displayed (blue eye) or hidden (grey eye with slash) by default in the profile.
    4. Sort Order is the second tab under Assign Fields where a field or fields in the profile is place to the right side to determine the default sort order of the profile. The first field listed is the primary sort, and the second field if specified is a secondary sort in case of a primary sort field that could yield a tie (such as a date field). 02 - 03 - Add Field Profile - Sort Order
  7. The Overwrite User Profiles checkbox forces the current profile and all fields removed or added to this profile to all assigned team members.
  8. Click SAVE.

Metadata Search Profiles

In the screen of the Search Profiles tab you can define custom metadata search profiles which provide options to limit and fine-tune the metadata fields that are queried when running full-text metadata searches.

Using a search profile for searching can potentially perform faster than a standard search broken out with the same metadata criteria. This is because the search profile will only hit the index once while the standard search broken out will hit it once for each criterion used in the query.

  1. Click Add to create a metadata field profile. 
    02 - 04 - Add Search Profile
    1. Enter a Name for the Search Profile (required).
    2. Add a Description (optional).
    3. Check Enabled to be able to use this profile.
    4. Click ADD to save.
    5. If any changes are required, select the search profile in the table and click Edit.
  2. Highlight the Search Profile and click Assign Fields to select the metadata fields to be included in searches using this profile; click ASSIGN when done. 02 - 05 - Search Profile Field assignments
  3. Then Assign Teams to provide access to all Teams that will use this profile.02 - 06 - Search Profile Team assignments
  4. Now this metadata search profile is ready for use in reviewing and filtering documents. 02 - 07 - Search Profile table
  5. For more details on using Search Profiles, see How to Create and Use Search Profiles.

Manage Fields

This area is used to view and modify a field’s attributes in the coding form. For example, Manage Fields can be used to make a field updatable. Fields are managed at the profile level, which allows the project manager or administrator to set field attributes appropriate to the team or teams assigned to a field profile. 02 - 08 - Manage Fields (update)
The following properties may be set for each field, as selected in the Field Profile and Field drop-down menus:
  1. Name: Is the field name as stored in the back end of the database. It is also known as field table name, and cannot be changed.

  2. Description: Allows the Administrator to optionally type in a more detailed description of the specified field.

  3. Field Display Names: Is the column header that the users can see in the Grid list. It too cannot be edited, and by default will display the name only in the language or languages currently active for the Reveal system.

  4. Effective Data Type: Change how data is displayed within the tool. This is most common in dealing with date fields. This can also be used to set a field to work with a drop-down list using the List type. The available options are:

    • Boolean - logical 0/1 or Yes/No.
    • Date
    • Date time
    • Decimal
    • Float 
    • Integer
    • List
    • Numeric
    • Text
    • Time
  5. Display Lines: Set the number of display lines for a field.

  6. Max Length: Is the value for how many characters can fit within a field. This can only be edited within the Reveal Review Manager, and is only active for field types where length may be configured (such as Decimal, Integer, Numeric and Text).
  7. Native Document Field: Denotes whether field specifies a native document location.
  8. Document Number Field: Marks this field as an identifier to allow the field to be displayed in the Production Database Update screen and for use as a key Field in image loading. Enables searching for the field content as a Document ID in search functions.
  9. Required: Is a Boolean value that determines whether the field is required in the database. This will affect Validation settings.
  10. Initially Visible: Is a Boolean value that determines whether a field will be visible to users when they first log in to the project. Default is usually Yes.
  11. Updatable: Allows a field to be edited in the review module, used where a project specifies the coding of certain document fields directly within Reveal. There are required and system fields that cannot be set to updatable. Administrators should carefully consider making a field editable as it will allow users to directly alter the data in the database. It is strongly encouraged that only custom or user-added fields permit updating (see Add Fields below).
  12. Multi-Value: Is for fields containing multiple values within the field. 
  13. Is Relational Field: This is used to create a custom relationship field for linking specific data. Documents having the same value entered into a defined Relational Field will show an additional relational panel to Duplicates, Near Duplicates, Family Members and Email Threads in the Viewer screen. Note the 450 character limitation on maximum length for this field type.
  14. List Type: If the Effective Data Type is set at List, select from Automatic or Managed List Type, and determine whether or not values in the list should be Appendable.02 - 09 - Manage Fields - Lists

  15. Linked List: Select a set of values available for fields that have List as their Effective Data Type and a List Type of Manual. Lists are created and specified in Review Manager.

  16. Click UPDATE when done.

Add Fields

An Administrator may add custom fields of any type here, entering information similar to that presented by Modify Fields (see above). The option to Import Field will be discussed below.02 - 10 - Add Field

  1. Field Name: Is the field name as stored in the back end of the database. This name may contain underscore characters but no spaces. The greyed-out drop-down arrow is used for the Import Field option discussed in item 14.d below.

  2. Field Display Name: Is the column header that the users can see in the Grid list. This name should match the Field Name except that it may contain spaces.
  3. Field Data Type: As noted above, this setting effects what data may be entered in a field and how data will be displayed; note that List is not an initial option but may be added using Modify Fields. The available options are:

    • Boolean - logical 0/1 or Yes/No.
    • Date
    • Date time
    • Decimal
    • Float 
    • Integer
    • Numeric
    • Text
    • Time
  4. Max Length: Specifies the value for how many characters can fit within a field. Once the field is added, this value can only be edited within the Reveal Review Manager, and is only active for field types where length may be configured (such as Decimal, Integer, Numeric and Text).
  5. Decimal Scale: Combines with Max Length to specify how many decimal places will be allotted to a Decimal Field Data Type.
  6. Native Document Field: Denotes whether field specifies a native document location.
  7. Document Number Field: Marks this field as an identifier to allow the field to be displayed in the Production Database Update screen and for use as a key Field in image loading. Enables searching for the field content as a Document ID in search functions.
  8. Is Searchable: Indexes this custom data field for search. Default is Yes.
  9. Updatable: Allows a field to be edited in the review module, used where a project specifies the coding of certain document fields directly within Reveal, usually only for custom or user-added fields.
  10. Multi-Value: Is for fields containing multiple values within the field. 
  11. Is Transcript Lookup: Field used to store location vectors for transcripts.

  12. Is Relational Field: This is used to create a custom relationship field for linking specific data. Documents having the same value entered into a defined Relational Field will show an additional relational panel to Duplicates, Near Duplicates, Family Members and Email Threads in the Viewer screen. Note the 450 character limitation on maximum length for this field type. 
  13. Description: Allows the Administrator to optionally type in a more detailed description of this custom field.
  14. Import Field: This button at the top of the Add Fields form opens a pop-up window where you may specify adding one or more fields from a delimited file:
    1. Import Profile: Specify the delimited file format, whether Concordance DAT or CSV as a standard (see Review Manager discussion of Importing Documents). 
    2. Import Data File: Browse to the file containing the delimited field values to be added.
    3. Click CLOSE when done.
    4. Once the file is located, the Field or Fields can be created using the drop-down menu in Field Name. As you create the fields, the fields that were already imported will no longer be available in the list.

    5. Continue the set up for the field based on the desired settings for Field Type, Max Length, etc.

  15. Click ADD when done.

 

Last Updated 9/07/2022