Layouts

Layouts are web-based coding forms that give you the ability to view and edit document fields. You can use layouts to develop workflows specific to the needs of your case. You can develop layouts that contain only the fields required to complete specific review tasks, making the review process clean and intuitive. You can also use object-level permissions to turn layouts on and off as necessary.

This page contains the following sections:

See these related pages:

Layouts permissions

The following permissions are needed to use layouts:

Object Security Tab Visibility Other Settings
  • Layout - View, Edit, Delete, Add

  • Relativity Application - View

 

 

  • Workspace Admin
    • Layouts
 

Creating and editing layouts

To create a new layout or edit an existing one:

  1. Navigate to the Layouts tab.
  2. Click New Layout. To edit a layout, click the Edit link next to the layout's name. The Layout Information details layout opens.
  3. Complete the required fields on the Layout Information layout. An orange bar to the right of the field name indicates that it is required. See Layout Information fields
  4. Click Save.
  5. From the Layout console, click Build Layout to open the layout builder. See Using the layout builder.

Layout Information fields

The Layout Information layout contains the following fields:

Layout Information

  • Owner drop-down—determines which users can view the layout. Select from the following options:
    • Public—all users can see the layout. This is the default selection.
    • Specific User—limits the visibility of the layout to the selected user in the drop-down.
    • Me—limits visibility to the logged in user.

      Note: System admins can view layouts and other securable items that users have made private.

  • Object Type—the object type that the layout uses to modify or code. For example, select Document as the object type if you were creating a layout for coding documents.

    Note: The Document layout is the only layout that contains the Enable Copy From Previous field. See Copy from Previous.

  • Name—the name of the layout. There is a 50-character limit for this field.
  • Order—the number that represents the position of the layout in relation to the other layouts. The lower the number, the higher the position on the list. Layout order can be any positive or negative integer, but you can't use decimals.
    • View Order—click to open up a pop-up window displaying the order of existing views.
  • Overwrite Protection—prevents a user from saving changes to an item that another process has modified since the user opened or edited the layout. By default, this field is set to Enabled.
    • You can edit this field only when the instance setting AllowChangesToOverwriteProtection is set to True in the instance setting table in SQL. By default, this value is False. Contact Relativity Support if you would like to edit this instance setting in your environment.
    • If you disable Overwrite Protection, we recommend that you avoid using Save & Next while coding documents because there is a possibility that your coding decisions may not be saved if another user is editing the same document at the same time. Instead, as a best practice, we recommend clicking Save and then carefully reviewing the layout to ensure your coding selections have been saved before navigating to the next document.
  • Relativity Applications—associates the layout with an application created in the Relativity Applications tab. Click Select to display the Select Items pop-up, and choose an application. To set this option, you must have the permission Manage Relativity Applications, available under Admin Operations on the Security page.

    If users have many layouts that they use during document review, you can add a new layout with dashes in the Name field, (-----------) and an appropriate order number to serve as a separator. This assists in organizing layouts and building the workflow.

Other

  • Keywords—include any key words to associate with the layout.
  • Notes—contains any notes regarding the layout.

Changing layouts

The layout with the lowest order number displays by default when a user opens a document. Depending on your screen resolution and the length of the current layout's name, it may appear truncated in the layouts drop-down menu. To display a tool-tip with the layout's full name, hover your cursor over the layouts drop-down menu.

You can change layouts before or while you are reviewing documents by doing the following:

  1. Click on the layouts drop-down menu.
  2. Select the desired layout.

    Note: If you have entered a coding decision and have not saved it before selecting a new layout, a pop-up will display. Click Cancel to go back and save the coding decision before changing layouts or click OK to discard the coding decision and proceed to the new layout.

Using the layout builder

The layout builder is a customizable screen where users can create a layout. The layout console exists within the layout builder, which is available once you save a layout or when you select an existing layout from the Layout List page.

To build a layout, click Build Layout in the Layout console. The layout builder appears.

The layout builder contains the following components:

Layout Options console

Use the Layout Options console to build your layout. Clicking an item to the left of the console displays that item's properties for you to interact with.

The Layout Options console contains the following items:

  • Properties—depending on the selected item in the layout, that item's properties appear here. See Field properties or Object list properties.

    Note: From the Properties section, click to collapse the properties or click to expand an item's properties.

  • Add Category/Add Object List drop-down—use these buttons to add a category or an object list to the layout.
  • Fields—drag and drop available fields onto the layout category or object list. See Adding fields and text.

    Note: You cannot add fields stored in Data Grid to layouts.

Creating and editing a layout group

A layout group consists of one or more categories or object lists that display in a tabular format to maximize screen space and eliminate scrolling in the layout. Use layout groups on the Document or RDO layout.

Note: A layout group may consist of both categories and objects.

To create a layout group:

  1. From the layout builder, click and drag a category/object list over another category/object list, then let go of your cursor click. A plus sign appears to the right of the category that you're dragging the other category onto.

    drag and drop category

    The category/object list appears in a new tab.

    new tab in layout group

  2. Click add icon or drag another existing category/object list onto the layout group to add more items to the group.
  3. Click Save or Save and Close.

To delete a category/object list, click next to the item. If the category/object list contains fields, a warning appears before deletion.

delete a category

To move a category/object list outside of a layout group, click and drag that item out of the group and place anywhere on the layout.

Layout Group properties

When you select a layout group, the Layout group properties appear in the Layout Options console.

Note: From the Properties section, click to collapse the properties or click to expand an item's properties.

layout group properties

The layout group properties contain the following items:

  • Name—the name of the layout group property.
  • Tabbed Display—this option determines when to render the layout group as tabs. When the layout group does not display as tabs, it displays in a sequential, vertical list.
    • Edit—displays the tabbed layout group only when a user is in edit mode. Once the user saves and views the layout, the categories render in a list.
    • View—displays the tabbed layout group only when a user is in view mode. When the user is editing the layout, the categories render in a list.
    • View & Edit—displays the tabbed layout group when a user is in view and edit mode.

Saving the layout

Changes made to a layout are applied when you click Save. The next time a user loads the layout when editing or selecting to go to the next document, the changes are visible.

If a user is in the process of editing a document when a change is made to the layout, the Overwrite Protection setting determines whether the user can successfully save those edits, or if they need to re-open the layout and make their selections again before saving.

By default, Overwrite Protection is enabled and stops a user from saving edits made to a document before reloading the layout after changes have been made to that layout.

Adding a choice to a layout

To add a choice to a layout in edit mode:

  1. Click the Manage link on a single choice or multiple choice field on the layout. The Choice editor modal opens.
  2. Click Add Choice,Add Many Choices, or Click to add a choice.
  3. Enter a name for the choice or many choices.
  4. (Optional) Click Details to further customize the choice.
  5. Modify the details of the choice. See Choice detail fields.
  6. Click Close.

New choices appear at the bottom of the list of choices. New choices also appear in the Choices tab and Field forms. See Accessing the Choice editor.

Note: If you have edit permissions, you can reorder the choice.

Pop-ups on the layout

In most instances, choices and objects appear as check boxes and radio buttons. Occasionally there are too many options to reasonably display on the layout, such as in a large list of issues. In these cases, you can display the choices in a pop-up picker. To add a field with a pop-up display, select Popup Picker on the Display Type field on the Add or Edit Field to Layout form.

To access the pop-up display for a field, click Select. You can filter the choices in the pop-up to locate the desired one.