View and Manage Realm Nodes

Home > Settings drop-down > System Settings > Provisioning > Realm Nodes
Project > Settings drop-down > System Settings > Provisioning > Realm Nodes

Requires System-level Realm Nodes - View permissions to view the information, Add/Edit permissions to edit/save changes, and Delete permissions to delete a Realm Node.

System Users in a role with the appropriate System-level permissions can view and manage Realm Nodes.

By default, all System roles can view the information. By default, a System User in the System Administrator or System Manager role has permissions to add a Realm Node and edit the Realm Node type, but only a System User in the System Administrator role has permissions by default to delete a Realm Node. For information about System-level permissions, see View and Manage System Role-Based Permissions.

From the Realm Nodes screen, System Users with the appropriate permissions can do the following:

  • View Realm Node information
  • Add a Realm Node (with Add/Edit permissions).
  • Edit the Realm Node type from the Summary (with Add/Edit permissions).
  • Delete a Realm Node (with Delete permissions, by default, System Administrator role only).

Summary List Columns

The columns in the summary display information about the various Organizations. For an unfiltered or filtered list, sorting ascending is available for columns such as Name and Date Created.

  • Name – The name of a Realm Node in the summary. This is the default sort column (ascending order).
  • IP Address – The IP address of the Realm Node.
  • Type – The type of Realm Node. If you have the appropriate Add/Edit permissions, you can change this type.
    • Standard – An Analytic Node designated to run general jobs for all provisioned Services in the Realm, including Low priority jobs. Standard Nodes are available for all tasks in an enterprise. Select this type if you want to make an Analytic Node a Standard Node. For a Service Node (for example, a Full Node configuration in which you only have the Service Node), Standard is the only applicable type.
    • Express –An Analytic Node in a Multi-node configuration that is designated to run High or Normal priority jobs for all provisioned Services in the Realm. Analytic Express Nodes do not run Low priority jobs, which are the jobs that generally take the longest time to complete and use as many Analytic Nodes as possible. These types of jobs include document Imports and Exports. Select this type if you want to make this Node (other than a Service Node) in a Multi-node configuration an Express Node. In a Multi-node configuration, you should configure one of the Realm’s Analytic Nodes as an Analytic Express Node.
    • OCR –An Analytic Node in a Multi-node configuration that is designated to run OCR jobs for all provisioned Services in the Realm. OCR tasks can be long running and resource intensive. OCR Nodes enable these tasks to continue without delaying other tasks. Select this type if you want to make this Node an OCR Node. If you do not configure an OCR Node, Digital Reef software uses Standard Nodes to perform OCR tasks. If one or more OCR Nodes are present, all OCR tasks are assigned to the OCR Nodes. You cannot select this option for a Service Node. An OCR node can also be used for password cracking (that is, when password criteria has been applied in a Project and documents have been submitted for reprocessing).

Note: If you change the Analytic Node Type, be aware that there will be a component state change. For example, going from a Standard Node Type or OCR Node Type to an Express Node Type deactivates the Parsing Manager AE component and activates an additional Index Manager AE component to run searches (since an Express Node uses two Index Managers). Going from an Express Node Type to a Standard Node Type or OCR Node Type deactivates the additional Index Manager AE component and activates the Parsing Manager component. Deactivated components are not available for any Jobs.

  • Status – The current status of the Realm Node.
    • Available – The Node is online and available.
    • Warning – The Node is not operating optimally.
    • Not Licensed – The Node does not comply with the terms of the license (for example, it exceeds the license core limits for the Node type).
    • Critical – The Node is in a Failure state and unavailable (not in service).
  • Temporary Storage Name – The temporary storage name associated with this Realm Node.
  • Temporary Storage Path – The temporary storage name associated with this Realm Node (for example, /opt/digitalreef/tmp).

Note: To control the list of displayed columns, right-click any column title to display the pop-up menu with checkboxes for the columns. The current sort column will have an up arrow after the column name to indicate the sort ascending order.

Realm Node Summary Options

A button at the top of the summary enable you to add a Realm Node, as follows:

  • New Realm Node – Enables a System User with the appropriate permissions to add a Realm Node.

For a selected Realm Node entry, you can select the following option, as long as you have permissions to perform those actions (actions that are not permitted will be grayed out).

  • (Delete) – Enables a System User with appropriate Delete permissions (by default, the System Administrator role is required) to request permanent deletion of a selected Realm Node. A confirmation popup dialog informs you that the Delete action cannot be undone if you proceed. Click Delete Node if you want to proceed with the deletion, or click Cancel to cancel the operation. Before you can delete a Realm node (an Analytic Node), delete the storage that is assigned to that node. You must also ensure that the Realm Node is not currently in use by Organization users. In general, you should approach any Node deletion with caution, and do not attempt to delete the Service Node in your configuration.

Note: Deleting a node deletes all node information from the database and is an irrevocable action. All Organization data on that node is lost, and any Services dependent on that node are rendered unusable.

Realm Nodes: Save or Discard Changes Options

If you do not save your changes (for example, if you changed the Node type) before navigating away, you will be prompted to either save your changes or discard your changes.

  • Save – Saves your changes to Realm Nodes in the Summary.
  • Discard Changes – Discards your changes to Realm Nodes in the Summary.