Reveal Help Center

Custom Relational Fields

You can create custom relations between documents in the review pane by using metadata values in relational fields. Whether you have some custom clustering algorithm or just want to see all documents having the same import folder, relational fields provides you the ability to create custom links between documents to tie them together. To do so, you will need to create a field and enable the relational flag to tie these documents together.

6064ae1f393e5.png
  • In Project Admin, open Fields.

  • Choose Add Field from the tabs at the left.

  • Create a unique Field Name and Display Name for the field. These are required.

  • Set Is Relational Field to Yes.

  • Click Add.

  • Next, open Field Profiles from the tab at the left.

    603d31227cc2e.png
  • Select the first profile to which you want to add the new relational field. Here, Default is selected.

  • Select Assign Fields from the right end of the Field Profiles toolbar.

  • Scroll down and select to Include the new relational field Cluster ID and make it Initially Visible in the Default profile.

    603d31245900d.png
  • Click Assign.

    603d312647523.png
  • Next go to the Permissions screen under Project Admin to enable viewing of related documents.

    • Under Permissions open Roles from the tab at the left.

    • Select the Role for which you will assign the permission to view related documents.

    • Click Assign Permissions at the right end of the Roles toolbar.

    • Enable the View permission View Related Documents.

    • Click Assign.

  • You will need to log out and back in to see this change.

    603d3128033a6.png

You will then be able to either overlay the custom related value to your new field or, if you make the field updateable, you can add this value manually.

When you view documents in the review pane, any documents that share a value with the current document will be displayed as a related document. In the following example a relational field named Cluster ID has been created. The document has a related value of ABACAB01 in the Cluster ID field, as do two other documents. When you look at the related documents pane, you will see the two documents related to the primary document under a Cluster ID label in the Related Documents pane.

603d3129d4c2a.png

The original document is displayed in boldface. These panes may be expanded or collapsed as needed. These panes only appear when a document has a relational field link with other documents.

By way of background, a load file was created containing two fields, Begin Number and the Relational field Cluster ID, with records for every document to be updated and the Cluster ID values assigned to each. This DAT file was overlaid using the Import > Documents > Update function in Reveal Review Manager.