Documentation Navigation Help

The Keyfactor documentation includes:

Home Page and Portal Navigation

To navigate to Keyfactor Command documentation:

1. From the Keyfactor Command Management Portal, select Help > Documentation, or click a help icon within the portal. TheKeyfactor Software & Documentation Portal (https://software.keyfactor.com) opens at the documentation home page when you select Documentation and opens directly to the relevant topic when you click a help icon.You will receive a prompt indicating:

   You are being redirected to an external website. Would you like to proceed?

2. From the Keyfactor Client Portal (https://keyfactor.zendesk.com), search for a topic using the search bar on the home page. Select a documentation result to open the corresponding page in the Keyfactor Software & Documentation Portal.

3. From the Keyfactor Software & Documentation Portal, use the search feature to search the on-premises documentation, or select On-Premises Documentation or Managed Services Documentation to browse the available documentation.

See Navigating the Keyfactor Documentation Home Page and Documentation Navigation Features below for more information.

Navigating the Keyfactor Documentation Home Page

The Home Page features include:

1. Click the Keyfactor logo anywhere in the documentation to return to the Keyfactor Software & Documentation Portal.
2. Click the links in the header to open the Keyfactor Website, Service Catalog, and Keyfactor Support resources in new browser tabs.
3. Use the search bar to search the Keyfactor Command Documentation Suite and optionally filter results.
4. Click Documentation Help to view navigation and feature instructions.
5. Click Select Version to choose the documentation version to view.
6. Click a section button to open the corresponding area of the Keyfactor Command Documentation Suite.
7. Click Compatibility Matrix to open the Keyfactor product compatibility matrix in a new browser tab.

Active Tables

Some tables include interactive features that improve readability and make it easier to work with large amounts of information. These features help accommodate wide tables on different screen sizes and allow you to view and copy long values (for example -DatabaseManagementAuthCredentials) more easily.

Active tables are identified by their thicker light-lavender column dividers, compared to the thinner white dividers used in standard tables.

To improve readability, long values may be truncated with ellipses (...) when the page loads. You can interact with active tables in several ways:

View and copy values

• Hover over a truncated value to display the full value in a tooltip.

• Click Copy in the tooltip to copy the value to your clipboard.

Resize columns

Drag a light-lavender column divider to increase or decrease the width of a column.

Resize the table

Drag the right edge of the table to adjust the table width and display more content without horizontal scrolling.

If you find a table that would benefit from these features, let us know by using the Provide Feedback link.

Documentation Navigation Features

1. Click the Keyfactor logo to return to the Keyfactor Software & Documentation Portal.
2. Click Home to return to the documentation home page.
3. Click Navigate Previous and Navigate Next to move to the previous or next topic in table-of-contents order.
4. Click Expand All/Collapse All to expand or collapse all drop-down sections on the page.
5. Click Print to print the current page without navigation or side content.
6. Click the links in the header to open the Keyfactor Website, Service Catalog, and Keyfactor Support resources in new browser tabs.
7. Use Search tofind words or phrases in the documentation.

8. Use Filter to limit search results by guide or content type. Available filters are:

   • Just the Keyfactor AnyCAGateway DCOM Installation and Configuration Guide
   • Just the Keyfactor AnyCAGateway REST Installation and Configuration Guide
   • Just the Keyfactor CA Connector Client Installation and Configuration Guide
   • Just the Keyfactor Cloud Gateway Installation and Configuration Guide
   • Just the Keyfactor Command Reference Guide

   • Just the Keyfactor Installing & Configuring Orchestrators Guide
   • Just the Keyfactor Command, CA Connector Client, and Gateway Release Notes
   • Just the Keyfactor Command Upgrade Overview
   • Just the Keyfactor Windows Enrollment Gateway Installation and Configuration Guide
   • Just the Keyfactor API
   • Exclude the Keyfactor API (include others)
9. Open the Documentation Navigation Help page under Supporting Information for navigation and feature instructions.
10. Use the side navigation menu to browse guides and topics.
11. Use the arrows in the side navigation menu to expand or collapse sections. Drag the divider to resize the navigation pane.
12. Use the breadcrumb trail to navigate to previously visited sections in the documentation hierarchy.
13. Use the Version selector to switch to a different version of the current topic. If the current topic is not available in the selected version, a notification is displayed.
14. The On this Page panel provides links to major sections of the current page. The current section is shown in bold.
15. Click Previous and Next at the bottom of the page to move through topics in order.
16. View your current position within the guide.
17. Click Provide Feedback to submit feedback about the current topic or other documentation content. Authentication is required.

Hidden links to , , (linked document is not in XML format), (linked document is not in XML format), Command Software and Product Documentation, Oops! Page Not Found, , Documentation Help, Search Results, (linked document is not in XML format) so that they will pull into the project.