Create and add diagnostic features

  • Release version: Xanadu
  • Updated August 1, 2024
  • 1 minute to read
  • Create and add diagnostic features, which consist of single or multiple diagnostic scans that execute mapped scripts to detect data corruption or invalid data.

    Before you begin

    Role required: adt_admin

    Procedure

    1. Navigate to All > Application Diagnostics Tool > Features.
    2. Click New.
    3. On the form, fill in the fields.
      Table 1. Diagnostics Feature form
      Field Description
      Name Name of the diagnostic feature. This name appears in the application to which the diagnostic feature belongs.Diagnostic feature name in application
      Active Option for activating the diagnostic feature.
      Application Search for and select the application with which you want to associate this diagnostic feature.
      Roles User roles that allow access to the diagnostic feature.
      Description Details of the scans in the diagnostic feature. The description is displayed in the application to which the diagnostic feature belongs.Diagnostics feature description on the application page
    4. Define the fields available to users for specifying filter conditions in the Diagnostics Inputs section.
      Table 2. Diagnostics Input fields
      Field Description
      Label Name of the label for the input fields.
      Field Type The Reference field type.
      Table Name of the table on which the query specified in the condition should run.
      Key An identifier for the user input condition. If a user specifies multiple conditions, this key acts as a unique identifier for each condition. You can use this key as the input for the scanContext section of the diagnostic script.

      For example, if you specify projectFilter as a key, the scanContext section of the diagnostic script would appear as follows: var encodedQuery = scanContext.input.projectFilter;

      The fields that you configure in the Diagnostics Inputs section appear in the Feature Inputs section of the Application Diagnostics Tool page, as shown in the following example.
      User input fields in application
    5. Click Submit.

    What to do next

    Create diagnostic scripts and add fix scripts to use with the diagnostic feature. For more information, see Add diagnostic and fix scripts.