Certificate Collection Management

Use the Certificate CollectionClosed The certificate search function allows you to query the Keyfactor Command database for certificates from any available source based on any criteria of the certificates and save the results as a collection that will be available in other places in the Management Portal (for example expiration alerts and certain reports). Management page to view, organize, and manage certificate collections. From this page, you can control collection visibility, access certificates within a collection, and perform collection-level actions.

Tip:  Where to find this in the Management Portal:
Certificates→ Collection Manager

From the Certificate Collection Management page, you can:

Tip:   Certificate collections are automatically monitored by the Keyfactor Command service to detect changes and trigger workflows.

Figure 77: Certificate Collection Management

Searching Certificate Collections

This page supports the standard query format described in Using Search in the Management Portal and includes its own set of query parsers specific to this operation. Use the following parsers to filter and refine results for this page.

  • LastEstimated

    The date on which the Keyfactor service last processed the certificates for the collection. By default this occurs every 10 minutes.

  • Name

    Complete or partial matches with the name of the certificate collection.

  • Query

    Complete or partial matches with the string that makes up the search criteria for the certificate collection. For example:

    (IssuedDate -ge \"%TODAY-7%\" AND TemplateShortName -ne NULL) OR (IssuedDate -ge \"%TODAY-7%\" AND IssuerDN -contains \"keyexample\")

Certificate Collection Management Operations

The following actions are available from the grid header and right-click menu.

View a Collection

The View option displays the certificates that belong to the selected collection by navigating to certificate search, filtered using the collection’s criteria.

To view a collection:

  1. Select a collection in the Certificate Collection Management grid.

  2. Click View at the top of the grid, or choose View from the right-click menu.

The current page updates to show the certificates in the selected collection.

Delete a Collection

The Delete action permanently deletes the selected collection.

To delete a collection, highlight the row in the collection management grid and click Delete at the top of the grid or choose Delete from the right-click menu. When prompted, click OK to confirm.

Show on / Remove from Legacy Dashboard

To change whether or not a collection appears on the legacy dashboard in the Collections panel, highlight the row in the collection management grid and click Show on Legacy Dashboard or Remove from Legacy Dashboard (depending on that collection's current state) at the top of the grid, or choose the action from the right-click menu. You will receive a confirmation message to remind you that only 25 collections can show on the dashboard.

Important:  The legacy dashboard will be removed in a future release.

Figure 78: Show Certificate Collection

Use Navigation Order to control which certificate collections appear in the Navigator and the order in which they are displayed.

Selecting Navigation Order opens the Collection Order in Navigator dialog. This dialog shows the collections currently displayed in the Navigator, pre-populated in their existing order. A maximum of 25 collections can be displayed.

The dialog includes a search select dropdown and a grid with the following columns:

  • Selection: A checkbox to allow selection of a collection to perform an action. Only one row at a time may be selected.

  • Order: An integer indicating the collection’s current position in the Navigator.

  • Collection: Displays the name of the collection.

Add a Collection

Select a certificate collection to add to the Navigator. To narrow the list of results in a search select dropdown, begin typing in the input field. Matching results will appear as you type, and you can scroll to locate a record.

Select a collection, and click Add to include it at the end of the list. If the collection is already displayed in the Navigator, an error message is shown.

Reorder Collections

Select a collection in the grid and use the available actions to change its position:

  • Move Up: Move the collection up one position.

  • Move Down: Move the collection down one position.

  • Move to Top: Move the collection to the first position.

  • Move to Bottom: Move the collection to the last position.

Remove a Collection

Select a collection and click Remove to hide it from the Navigator. Removing a collection from the Navigator does not delete it. The collection remains available for use in reports, alerts, workflows, dashboards, and in Certificate Collection Management.

Save or Discard Changes

Click Save to apply your changes and refresh the Navigator.

Click Close to exit the dialog. If there are unsaved changes, you are prompted to confirm before closing.

Figure 79: Order Certificate Collection

Tip:  If a custom sort order is not defined, the collections display in the order in which they were created.
Note:  The order defined here does not affect the sort order for the collections displayed on the dashboard. That is controlled separately using dashboard settings (see Dashboard: Collections).

Keyfactor Command Auto-Created Collections

Several collections are created automatically when Keyfactor Command is installed.

Important:  The special query options of %TODAY%, %ME%, and %ME-AN% are only supported in uppercase. Lowercase equivalents (for example, %me%) cannot be substituted.
Important:  All automatically created collections are included on the menu by default. They are created for fresh installations of Keyfactor Command only, not upgrades, so as not to overwrite any user-defined collection for existing installations.
Tip:  Click the help icon () next to the Certificate Collection Management page title to open the Keyfactor Software & Documentation Portal to this section. You will receive a prompt indicating:

You are being redirected to an external website ‘software.keyfactor.com'. Would you like to proceed?

You can also find Help in the Navigator. From here you can choose to open either the Keyfactor Software & Documentation Portal at the home page or the Keyfactor API Endpoint Utility.

Keyfactor provides two sets of documentation: the On-Premises Documentation Suite and the Managed Services Documentation Suite. Which documentation set is accessed is determined by the Application Settings: On-Prem Documentation setting (see Application Settings: Console Tab).