Top
Home »

Additional Fields

Overview

Use 'Additional Fields' in Key Manager Plus to attach any extra information about keys and certificates stored in the repository. There are four types of fields to create: character, numeric, date and email. Once an additional field is created, the default value assigned to it will be applied to all entries in SSH Keys and SSL Certificates tabs and will be visible to all users. Therefore, it is ideal to use additional fields for assigning common attributes such as organization name, or email address. Also, the Column Chooser icon helps you organize columns and additional fields in SSH Keys and SSL Certificates tab views, and in Reports and Dashboard tab views.

Below are the operations you can perform on additional fields:

  1. Creating an additional field
  2. Displaying an additional field
  3. Editing an additional field
  4. Resetting an additional field
  5. How to show/hide fields using the column chooser

1. Creating an Additional Field

Follow the below steps to create additional fields that will apply to both keys and certificates tabs.

  1. Navigate to Settings >> Additional Fields.
  2. Create a new additional field for any of the below mentioned field types:

i. Character: To store text inputs.

ii. Numeric: To store numerical inputs.

iii. Date: To store date and time inputs.

iv. Email: To store relevant email addresses.

3. Add the Field Name, Default Value, Description and select if you want to add it to SSL Keys tab, SSH Certificates tab or Both.

4. Click Save. To view the newly created additional field under the SSH Keys or the SSL tab, click the column chooser icon () from the top bar.

Note: Certificate Expiry Notification emails are sent to the email addresses specified in additional fields of the type Email. These notification emails will be customized according to the format configured for notification emails in the Notification and Schedule tabs.

2. Displaying an Additional Field

When you create an additional field of the type Character/Numeric/Date/Email, the field is added to both the SSH keys and SSL certificates tabs immediately. Follow the below steps to display an additional field:

  1. Navigate to SSH >> SSH Keys or SSL >> Certificates tab.
  2. Click the column chooser icon () from the top bar.

3. In the column chooser pop-up, select the checkbox beside the additional field you added and click Save. Now, the additional field and the default value added during its creation will be displayed among the other fields. The same field value will be applied to all entries in the Keys and Certificate repository but the value can be edited and customized using the Edit option.

3. Editing an Additional Field

Once a default value for the additional field is added, the same value will be applied to all the certificate and key entries in the SSL certificates and SSH Keys tabs respectively. To change the field value for a particular certificate, follow the below steps:

  1. Navigate to SSH >> SSH Keys or SSL >> Certificates tab.
  2. Select a particular certificate and click Edit from the More drop-down in the top bar.
  3. In the Edit Certificate window, edit the value and click Save. This value will be updated for the selected certificate alone.
  4. To edit additional fields in bulk for a number of keys/certificates at a time, select all required keys or certificates and click More >> Edit. In the Edit window, add new values for the additional fields. The same values will be added for all the selected keys/certificates.
  5. To edit additional fields for certificate groups, go to SSL >> Certificate Group. Select the required groups and click Edit Additional Field.

  

4. Resetting an Additional Field

Follow the below steps to reset the additional fields and remove any previously added ones:

  1. Navigate to Settings >> Additional Fields.
  2. Click the Reset option available at the bottom of the page. In the pop-up that opens, confirm the reset by clicking OK. This process will delete the additional fields from both the SSH Keys and SSL Certificates tab.
3. To delete only selected additional fields, remove the field name, default value and description manually and click Save.

5. How to Show/Hide Fields using the Column Chooser

Using the Column Chooser icon (), organize the columns and choose to show or hide both the default and additional fields as per your requirement. The Column Chooser icon helps declutter the columns in the following tabs: SSH Keys, SSL Certificates, Reports and Dashboard.

In the Reports tab, the Column Chooser is available for selected reports, namely the following:

In the Dashboard tab, the Column Chooser is available for the following views: SSH Servers, SSH Keys, and SSL Certificates.

Note: Column chooser customization is unique to an individual user, therefore the changes in arrangement or visibility of columns made by one user will not be applied to another user.

Follow the below steps to show or hide any column from the tab view:

  1. Click the Column Chooser icon to display all the available column names.
  2. Unselect the checkboxes beside the column names that you want to hide from the tab view. You can choose to hide even the default columns in this way.
  3. Apart from the show/hide option, you can change the sort order of the columns. To do so, simply click the column and drag and drop where required.
  4. All the additional fields created will also be listed under Settings >> Privacy Settings >> Export Data Settings along with the default column values. Select the checkboxes beside the column/field names to hide or mask the corresponding data from the exported reports.