Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 2.42 KB

Usage-Guide.md

File metadata and controls

42 lines (26 loc) · 2.42 KB

Usage Guide

When you run the application, you will see 3 available tabs:

To begin, you must first register 1 or more instances which are stored in a local JSON file.

Managing instances

The Instances tab allows you to create and delete instances, and choose which instance is currently connected. An instance must be connected in order to run reports and actions.

Click the New instance button to add a new Kentico instance. You must supply the following parameters:

  • Name: An arbitrary name for the instance
  • Administration path: The full path to the CMS folder of the Kentico administration, e.g. "C:\inetpub\wwwroot\MySite\CMS"
  • Administration URL: The URL of the Kentico administration website

The application should automatically detect the connection string from the web.config at the root of the administration path. If not, you will need to provide details to connect to the Kentico database.

Reports

Reports provide detailed information about the Kentico instance and potential issues, without modifying any data. After you click the "Run" button to run the report, the status bar will change to a color indicating the status:

  • 📗 Success: There are no issues in the results
  • 📘 Information: The results contain information for your review
  • 📙 Warning: The results contain issues that can be reviewed, but don't necessarily need resolving
  • 📕 Error: The results contain issues that should be resolved, either manually or by running an action

You can click the Results tab to view the detailed information provided by the report.

Actions

⚠️ Actions modify the database and should be used with caution! Always make a backup of your database before running an action.

Clicking the "Run" button without providing options will display a list of the data that can be modified by the action. After reviewing the data on the Results tab, switch to the Options tab and add the action parameters. When you click "Run" again, the data will be modified and the status bar will change to a color indicating the status:

  • 📗 Success: There data was modified successfully
  • 📘 Information: Options were not set and data can be reviewed on the Results tab
  • 📕 Error: One or more of the options are invalid, or an exception occurred