Records

Owned by Stonebranch
Last updated: May 30, 2024
4 min read

Introduction

A record is an entry in the UDMG database. Most records are created by the user via the user interface, but others (such as Transfer or History records) are created by the UDMG.

All system-supplied and/or user-supplied information about a record is contained in the record Details.

Naming Tips

Many functions within UDMG are executed against one or more records.

For example, you can assign a user permission to:

  • Sort by record name.
  • Filter a server list to display only certain servers.

The following method is available to help you organize your records to facilitate the use of these functions.
 

Method

Develop a naming scheme for records.
 
For example, when naming Rules, you could append with receive on all tasks related to receive operations, or you could prepend with REPT on all report-related rules. The naming scheme allows you to sort and filter lists by selecting records, for example, that contain "receive".

Note

Specifically for Rules, the rule name is passed in the Universal Event for UDMG transfers and then available as a variable for the related task that may be triggered by a Universal Monitor. By implementing a rule naming scheme, you are able to catch the Universal Events and monitor the tasks more efficiently.   

Step 1

Select a record type from the appropriate navigation pane of the Services. The records list for that record type displays.

Step 2

Either:

  • Enter / select information for a new record in the empty Details that display below the list.
  • Click the New button that displays above the list to display an empty Details pop-up and enter / select information for a new record.

Step 3

Click the Save button to save the record.

Note

The Name field is usually the main identifier of a record and must be unique per category, it has the following restrictions:

  • Maximum 100 characters.
  • Name can consist of: alphabetics (a-z, A-Z), numerics (0-9), _ (underscore), . (dot), (space), ~ (squiggle or wavy line).
  • Spaces are only permitted inside the name.
  • Names are case-sensitive.

Note

Copying and renaming an existing record is not possible.

Opening a Record

Opening a record refers to the displaying of a record Details.

Step 1

Select a record type from the appropriate navigation pane of the Services. The records list for that record type displays.

Step 2

Click a record in the list to display its record Details below the list.

Record Details

When a record type from the Services is selected, a list of records for that type are displayed. Next to the list, an empty record Details for a new record of that type displays.

For example:

Record Details Tabs

The record Details for every record contains one or more tabs, including the default <record type> tab, that provides detailed information about the record.

For example, Details for Rules provide four tabs in addition to the <record type> tab. The currently selected tab is highlighted white. All other tabs display grey.

Each tab displays a list of records or configuration parameters that have been user-defined to be associated with the record. For example, the Post-Tasks tab for a rule would list any UDMG task that is configured for this rule.

As appropriate for the type of record listed for a tab, the following also is provided:

  • New button that allows you to create a new record of that type.

When you click a tab to display a list of records associated with the current record, you can:

  • View details about each record on the list.
  • Create a new record of that type.

Color-Coding of Tabs

Tabs are color-coded:

  • Current tab is highlighted white.
  • Tabs that contain records or non-default configuration display a green icon.
  • Tabs that do not contain records or any specific configuration display a gray icon.
  • Tabs that are disabled have a greyed-out label.

For example, this Server record Details shows that the Rules tab has one (1) or more records, the Business Services tab has one (1) or more records, the Accounts tab has no records, and the Certificates tab is disabled because it is not available for this protocol:

Performing Actions on a Record

The following actions can be performed for all user-defined records:

  • Updating
  • Deleting

Updating a Record

Step 1

Open the record that you want to update.

Step 2

Make any desired updates to the record and click the Update button.

Step 3On the Confirmation pop-up that displays, click Confirm.

Do not use the Update button to copy a record; the Update button overwrites the existing record.

Deleting a Record

Deleting a record removes it from the UDMG database.

Step 1

Open the record that you want to delete.

Step 2

Click the Delete button.

Step 3

On the Confirmation pop-up that displays, click Confirm.