Free cookie consent management tool by TermsFeed

Health Check

On This Page

Purpose

Note:  To set up Health Check in a self-managed environment using Kubernetes, refer to these instructions.

The Health Check page in the Admin Console allows you to set up, schedule, and pull Health Check reports on your Appian environment.

Switching from the Plug-in to the Admin Console Health Check

If you are using the Appian Health Check plug-in, Appian will automatically uninstall the Health Check plug-in when you set up Health Check in the Admin Console.

If you want to pull Health Check reports using a Continuous Integration (CI) tool, such as Jenkins, you will need to create a web API that uses a!latestHealthCheck().

Access

To access the Health Check page, go to the Admin Console. Then, in the left navigation menu, under DevOps, click Health Check.

Health Check Settings are grouped into three sections:

A. General
B. Automatic Upload
C. Scheduling

images/hc_settings_page.png

Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to closeimages/hc_settings_page.png

A - General

To help Health Check establish the correct risk level for various findings, specify whether your environment is a production environment.

The Health Check Viewers system group allows users to access the Health Check report from a News post and via email notifications. System administrators will always have access to the report from the Admin Console.

Note:  Health Check reports generated when automatic upload is disabled will not be available from the Admin Console and News. Instead, the report will be emailed directly to the system administrator who uploaded the Health Check data to Community. For more information, see the Automatic Upload section below.

B - Automatic upload

Appian recommends enabling automatic upload to make your Health Check process more efficient. Automatic upload allows your environment to directly submit the data collection ZIP file to Appian Community when it is ready for analysis.

To enable automatic upload, Health Check credentials for Appian Community are required. The same credentials can be used across multiple environments within your organization. An authorized support contact can obtain Health Check credentials or reset the Health Check password in MyAppian.

To obtain credentials or reset the password:

  1. Go to MyAppian.
  2. Go to the HEALTH tab.
  3. Click CREDENTIALS.

Once you have your Health Check credentials, enter them in the Automatic Upload section.

If you previously configured third-party credentials for the Health Check plug-in, they are automatically detected and transferred over as Health Check credentials for the Settings page.

If you enable automatic upload, a data review will be required for the first Health Check run in each environment. During that review step, you will have the option to select Autoapprove this step for future runs and skip data reviews for future runs.

/hc enable autoapprove checkmark step2

System administrators can disable autoapprove from the Automatic Upload section at any time after their first Health Check run.

images/hc_settings_page_with_data_review.png

Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to closeimages/hc_settings_page_with_data_review.png

If automatic upload is not enabled, a system administrator will need to manually download the data collection ZIP file, and upload it to MyAppian for analysis during each run.

C - Scheduling

After enabling scheduling, you will be asked to provide the date and time of your first run, as well as how frequently you would like Health Check to run.

Appian recommends regularly scheduling Health Check, and running it during non-business hours in a production or active environment, as it may increase system load and degrade performance. You should also take into consideration the time zones of your primary Appian users when scheduling Health Check.

Health Check will run within a 10 minute window of the scheduled time. For example, if you schedule Health Check to run at 12:00 AM, it could start as late as 12:09 AM.

Landing page

images/hc_landing_page.png

Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to closeimages/hc_landing_page.png

  1. Settings button: Returns you to the Settings page.
  2. Run Now button: Immediately starts a Health Check run.
  3. History section: Displays information about your previous 50 Health Check runs.
    • Each run will show:
      • When the run started and how it was kicked off.
      • How long data collection took, in minutes.
      • Whether or not it was a scheduled run.
      • The final status of the run (completed, canceled, or failed).
    • For runs when automatic upload was enabled, you will see additional details such as:
      • When the data review was approved and who approved it.
      • The number of days in the analysis period (the period of time covered by the report).
      • A link to download the resulting Health Check report. Reports are only available for the most recent 25 runs.
    • For runs when automatic upload was disabled, reports will not be available for download from within the grid.
  4. Download Last Run's ZIP button: Downloads the data collection ZIP file that Health Check generated for your latest run. Any edits that you may have made to the ZIP file before submitting it for analysis will not be reflected in this download. This option is disabled when the latest run is canceled or encounters an error.

Feedback