Database

Purpose

In Clarity Transform, Database is one of the CI types on the CMDB screen. Each record is a database. Database instances are a separate CI type, Database Instance, with its own card.

Database records can come from the SQL Server integration, whose description reads: "The MSSQL integration enables seamless data collection from Microsoft SQL Server. It retrieves information on databases and database instances." Records can also be added on the grid with Create New.

A Database record has no field that links it to a device or an application. Links between CIs are records of their own CI type, Relationship.

Where to find it

Go to Discover → CMDB, then select the Database card in the card strip. Clarity loads the Database grid on the same page. There is no separate menu item or page for databases.

What you see

Columns

Shown by default:

• Name
• Ci Class
• Ci Type
• Managed By
• Integration
• Rejection Reason
• Creation Date
• Host Name
• Instance Name
• Instance Type
• Is Clustered
• Is Encrypted
• Is Read Only
• Last Backup Date
• Migration Contact
• Migration Date
• Migration Plan
• Migration Readiness
• Migration Status
• Scope
• Size In Mb
• State
• Tags
• Clarity Tags
• Last Seen

Hidden by default, and shown with Toggle columns: App Shutdown Contact · App Shutdown Required · Approval Status · Business Unit · Comms Sent Date · Communication Date · Communication Status · Criticality · Database Owner · Environment · In Scope · Migration Notes · Migration Sequence · Migration Sequence Required · Migration Testing By · Migration Testing Required · Move Group · PeriodEnd · PeriodStart · Plan · Plan Status · Platform Created On · Region · Replica · Created On · Created By · Last Updated By · Integration Priority · Last Updated

The Id, Provider Id, Is Deleted and Deleted On columns are not offered in Toggle columns; Export All Fields includes them.

Custom fields added under Settings → Field Management → Custom Fields appear as extra columns.

Filters

Every column has a filter row, and the grid has a Search: box and a page-size selector (10, 25, 50 or All entries per page).

The grid does not keep its Search: text, column filters, sort order or page size: each time you select the card, it opens sorted by Name (A to Z), 25 rows per page, with no search or filters. If the grid shows fewer rows than you expect, clear the Search: box and the filter row.

By default the grid hides databases whose Scope is Out of scope. To list them, select Display all scopes... in the toolbar. The filter is on again each time you open the grid.

Actions

The Database grid toolbar has:

• Create New, Edit, Remove selected, Clear selection and Reload table data. Create New opens the Create new entry form. Edit opens the Edit entry form for the row you have selected.
• Enable spreadsheet editing: turns on editing in the grid itself, one cell at a time. Each change is saved as soon as you press Enter or leave the cell. See Edit records in the grid. There is no bulk-edit button.
• Download menu: Export Visible Fields or Export All Fields. Exports are CSV.
• Display all scopes...: lists databases of every scope, including Out of scope. The button then reads Display in scope only..., which turns the filter back on.
• Save columns: saves which columns are shown, under a name you choose. It does not save the search, filters or sort order. See Save and reload a column layout.
• Load columns: shows a saved set of columns again, or the default set (Default (as configured)).
• Toggle columns: shows or hides columns, with a Search columns box.
• Validations: turns highlighting of the Mandatory and Suggested fields (set under Field Validations) on or off.
• Row height: changes the height of the grid's rows.

The toolbar differs between CI types: the CMDB page lists the differences. The Database grid has no Import CSV button. To load databases from a file, use the CSV Import integration, whose Ci Class offers Database.

Each row has a View Details action. It opens a read-only side panel, titled with the CI type, that lists the record's populated fields, followed by Created By, Created On, Last Updated By and Last Updated. Only fields whose columns are shown by default are listed, whatever columns you have turned on. Select the action again, or the panel's close button, to close it.

Form

The Create new entry form and the Edit entry form have the same fields; the edit form opens filled in. A Search... box at the top of the form finds a field. The fields are grouped in section cards, in this order. Fields are text unless a type or a list is given.

• Database Details:
  • Name
  • Host Name
  • Instance Name
  • Instance Type
  • Environment
  • Region
  • Is Clustered: a checkbox, unchecked by default.
  • Scope: In scope or Out of scope.
  • Criticality
  • Tags
  • Clarity Tags
• Ownership: Business Unit, Database Owner.
• Database Properties:
  • Size In Mb
  • State
  • Is Read Only: a checkbox, unchecked by default.
  • Replica
  • Creation Date: a date.
  • Last Backup Date: a date.
• Migration Status:
  • Move Group: a list of the move groups. A move group is greyed out and cannot be selected if it belongs to a locked event (marked "(event locked)"), or, when you edit an existing database, if the database breaks its guard-rail rules (marked "(guard rails)"; the hover text says "This device breaks this move group’s guard rails:", even for a database). See Place a device in a move group, which works the same way, including the prompt to override guard rails on Save.
  • Approval Status
  • Migration Status
  • Migration Contact
  • Migration Readiness
  • Migration Date: a date.
  • Migration Plan
  • Migration Notes: a multi-line text box.
• Testing and Sequencing: Migration Testing Required, Migration Sequence Required, Migration Testing By, Migration Sequence.
• Shutdown and Communication: App Shutdown Required, Communication Status, App Shutdown Contact, Communication Date (a date).
• Custom Fields: the custom fields defined for databases, if any.
• Engine Metadata: no fields of its own. On a new database it reads "Engine metadata will appear after the first discovery run for this record." On an existing database it shows "Loading engine metadata..." and then the metadata that discovery collected; if that fails it reads "Engine metadata could not be loaded."

The footer has Cancel and Save.

How to

Add a database

1. Go to Discover → CMDB and select the Database card.
2. In the toolbar, select Create New. The Create new entry form opens.
3. Enter a Name, and fill in the other fields you need, for example Host Name, Instance Name and Move Group.
4. Select Save, or select Cancel to close the form without saving.

Edit a database

1. On the Database grid, select the database's row. Select any cell except Name: selecting the Name opens that record's edit form at once.
2. In the toolbar, select Edit. The Edit entry form opens with the database's values.
3. Change the fields you need, then select Save.

Find a database

1. Go to Discover → CMDB.
2. Select the Database card.
3. Type in the Search: box, or enter a value in the filter row of a column such as Instance Name or Host Name.
4. If the database is not listed, select Display all scopes... to include Out of scope databases.

View a database's details

1. On the Database grid, select View Details on the row.
2. A side panel opens and lists the record's populated fields.

Show a hidden column

1. On the Database grid, select Toggle columns in the toolbar.
2. Find the column, for example Database Owner, with the Search columns box, and select it.
3. To keep the layout, select Save columns.

Export databases

1. On the Database grid, open the download menu.
2. Select Export Visible Fields or Export All Fields.

Related pages

• CMDB: the CMDB screen and its card strip.
• Database Instance: the separate CI type for database instances.
• SQL Server: the integration that collects databases and database instances.
• CSV Import: loads databases from a CSV file.
• Field Validations: sets the Mandatory and Suggested fields that Validations highlights.