Health Check Data FAQ

Overview

This page explains the types of data that are collected by Health Check and how Appian stores and uses this data.

Health Check provides insights into application design patterns and performance risks in your environment. The findings are summarized in a report that links to suggestions for mitigating any identified risks.

Health Check is a three step process made up of data collection, data review, and data analysis. During data collection, Health Check examines applications and objects in your Appian environment and collects system logs. This collected information is packaged together into a zip file that will be used for data review. During data review, system administrators have the opportunity to review the generated data collection zip file and remove any files that they do not want analyzed by Appian. Then the zip file is sent to Appian Community for analysis, and a Health Check report is generated and shared with system administrators.

Collected Data

What data does Health Check collect?

Health Check collects system logs and object information to provide you with meaningful feedback about your applications’ design patterns and performance risks. During data collection, the logs collected include, but are not limited to:

  • Audit
  • Data metrics
  • Data server
  • Performance
  • Troubleshooting (including application server)

During data collection, a series of Health Check-specific logs are also generated and collected. These logs primarily contain information about applications and their objects.

The types of data that Health Check can collect in log files may include, but are not limited to:

  • Design object properties, including:
    • Name
    • Description
    • Security
    • Visibility expressions
    • URLs and URL stubs
  • Usernames
  • User agents
  • Integration details
    • Systems being integrated with
    • Frequency of integration calls
    • Endpoints
  • Error messages (which may include user-entered data)
    • Design errors
    • K error logs
  • Server details, including hostnames, IP addresses, etc.

How can this data be reviewed?

System administrators are responsible for reviewing the generated zip file during the data review step of their Health Check runs. During data review, system administrators have the option to download and review the data collection zip file that Health Check has generated before the zip file is uploaded to Appian Community for analysis. Any files that system administrators do not want to share with Appian can be removed from the zip file during this step, and they can then optionally upload a new version of the zip file for analysis. Appian will use the zip file that has been submitted during data review to generate your Health Check report.

System administrators can opt to auto-approve the data review step during Health Check runs. Enabling this option will skip over the data review step during Health Checks and directly upload the data collection zip file to Appian Community for analysis. Learn more about how to enable autoapproval here.

Data Storage and Retention

What data does Appian store?

For each Health Check run, Appian stores metadata about the run, a copy of the data collection zip file (including the raw log files), and a copy of the generated Health Check report.

Where is the data stored?

All customer Health Check data is stored in Appian Cloud's Northern Virginia region and is subject to the same security controls as all production Appian Cloud environments.

How long is the data stored?

For production environments, data collection zip files are retained for one year after the date of the Health Check run. For non-production environments, Appian retains only the latest zip file for a maximum of one year.

Health Check reports and run metadata are stored indefinitely for both production and non-production environments.

Data Access and Use

Who at Appian has access to the data?

Data collection zip files are only accessible by Professional Services Architects, and members of Appian Technical Support and Cloud Engineering.

Health Check reports and run metadata are available for general use within Appian. This includes the Engineering, Professional Services, Customer Success, and other departments.

Is the data shared with third parties?

Appian does not share any Health Check data externally with third parties However, Appian may share a customer’s Health Check report with contractors previously approved to work on projects for that specific customer.

How does Appian use the data?

The data is used for several purposes within Appian including, but not limited to:

  • To generate Health Check reports for customers
  • To evaluate customer environment health
  • To aggregate Health Check metadata across customers and analyze usage and adoption
  • To inform business decisions and improve our product

Can I have my data removed?

If you would like Appian to remove your Health Check data, please contact Appian Technical Support.

Open in Github Built: Mon, Oct 18, 2021 (03:00:16 PM)

On This Page

FEEDBACK