Skip to content

Database Instance

Purpose

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

Database Instance 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 Instance record has no field that links it to a device, a host or its databases. The nearest values are text: the instance's own Fqdn column, and the Instance Name and Host Name columns on Database records. Links between CIs are records of their own CI type, Relationship. A Database Instance record also has no Move Group field.

Where to find it

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

What you see

Columns

Shown by default:

  • Name
  • Ci Class
  • Ci Type
  • Managed By
  • Integration
  • Clarity Tags
  • Critical
  • Edition
  • Fqdn
  • Ha Status
  • Instance Name
  • Instance State
  • Is Clustered
  • Is Ha Enabled
  • Is Single User Mode
  • Product Name
  • Product Version
  • Tags
  • Last Seen

Hidden by default, and shown with Toggle columns: Platform Created On · Version · 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.

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.

Actions

The Database Instance 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.
  • 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. The Ci Class list on Field Validations does not include Database Instance.
  • Row height: changes the height of the grid's rows.

The toolbar differs between CI types: the CMDB page lists the differences. The Database Instance grid has no Display all scopes... and no Import CSV button.

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 is given.

  • Database Instance Details: Name, Instance Name, Fqdn, Version, Edition, Product Name, Product Version, Critical.
  • High Availability:
    • Is Clustered: a checkbox, unchecked by default.
    • Is Ha Enabled: a checkbox, unchecked by default.
    • Ha Status
    • Instance State
    • Is Single User Mode: a checkbox, unchecked by default.
  • Custom Fields: the custom fields defined for database instances, if any.
  • Engine Metadata: no fields of its own. On a new instance it reads "Engine metadata will appear after the first discovery run for this record." On an existing instance 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 instance

  1. Go to Discover → CMDB and select the Database Instance 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 Instance Name, Fqdn and Version.
  4. Select Save, or select Cancel to close the form without saving.

Edit a database instance

  1. On the Database Instance grid, select the instance'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 instance's values.
  3. Change the fields you need, then select Save.

Find a database instance

  1. Go to Discover → CMDB.
  2. Select the Database Instance card.
  3. Type in the Search: box, or enter a value in the filter row of a column such as Instance Name or Fqdn.

View a database instance's details

  1. On the Database Instance 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 Instance grid, select Toggle columns in the toolbar.
  2. Find the column, for example Version, with the Search columns box, and select it.
  3. To keep the layout, select Save columns.

Export database instances

  1. On the Database Instance grid, open the download menu.
  2. Select Export Visible Fields or Export All Fields.
  • CMDB: the CMDB screen and its card strip.
  • Database: the separate CI type for databases, with the Instance Name and Host Name columns.
  • SQL Server: the integration that collects databases and database instances.
  • Custom Fields: custom fields can be added to the database_instance table.
  • Tag Extraction: Database Instance is one of the asset tables whose JSON tags can be mapped to columns.