Product Documentation

Create custom reports

Jun 15, 2016

Custom report naming rules

Custom report names and algorithm group and algorithm identifiers must follow these rules:

  • The first character must be a Latin letter (a through z, A through Z).
  • Subsequent characters can be Latin letters or numbers (digits 0 through 9).
  • The name or identifier must not be a SQL Server reserved word. For the full list of these, see http://msdn.microsoft.com/en-us/library/aa238507(SQL.80).aspx.
  • The name or identifier can be a maximum of 40 characters.

Additionally:

  • Custom report names can contain spaces.
  • Algorithm or algorithm group identifiers can contain the underscore (_) character.

Create a custom report

  1. From the AppDNA menus, choose Configure > Custom Reports.
  2. On the toolbar in the Custom Reports Manager screen, click New.
  3. In the New Custom Report dialog box, enter a Name and Description for the new custom report.

    The name must conform to the custom report naming rules described earlier. Citrix recommends that the name makes it clear whether the custom report is targeted at desktop or web applications.

  4. Click OK.

    This closes the dialog box and adds the new custom report to the left side of the screen.

  5. Create algorithm groups and algorithms in the custom report as described below.
  6. Click Save on the toolbar to preserve your changes.

Create an algorithm group in a custom report

Before you can create an algorithm group, the custom report must already exist.

To create an algorithm group based on an existing algorithm group:

  1. In the tree view on the right side of the Custom Reports Manager screen, locate the algorithm group on which you want to base the new algorithm group.
  2. Drag the algorithm group to your custom report on the left side of the screen. This adds the algorithm group and all of its algorithms to the custom report.
  3. If you want to change the name of the group, right-click it in the tree view, and from the shortcut menu, choose Properties.
  4. In the Properties dialog box, enter the new name and click OK.
  5. Click Save on the toolbar to preserve your changes.

To create a new algorithm group that you define yourself:

  1. Locate your new custom report on the left side of the Custom Reports Manager screen.
  2. Right-click the custom report and from the shortcut menu, choose New Group.
  3. In the New Custom Report Group dialog box, enter a unique Identifier for the algorithm group and a Name and Description. The identifier must conform to the custom report naming rules described above.
  4. Click OK to close the dialog box.
  5. Add algorithms to the group as described below.
  6. Click Save on the toolbar to preserve your changes.

Create an algorithm in a custom report

Before you can create an algorithm in a custom report, the algorithm group must already exist.

To create an algorithm in a custom report based on an existing algorithm:

  1. In the tree view on the right side of the Custom Reports Manager screen, locate the algorithm you want to add to the algorithm group in your custom report.
  2. Drag the algorithm to the required algorithm group in your custom report on the left side of the screen.
  3. Click Save on the toolbar to preserve your changes.

To create a new algorithm that you define yourself:

  1. On the left side of the Custom Reports Manager screen, locate the algorithm group to which you want to add the new algorithm.
  2. Right-click the algorithm group, and from the shortcut menu, choose New Algorithm.
  3. On the first page of the New Algorithm wizard, enter a unique Identifier and Name for the algorithm.

    The identifier must conform to the custom report naming rules described above. The convention is to use an identifier of the following form: XXX_nnn, where XXX is a three letter code and nnn is a three digit number.

  4. Click Next to move to the next page in the wizard.
  5. On the second page of the wizard, enter a Manifestation, which should explain what will make this algorithm trigger, and a Remediation, which should explain how to resolve the issue. Then click Next.
  6. On the third page of the wizard, select the RAG status to be applied to applications that trigger this algorithm. Red means that the application will fail, amber means that the application may work but with some issues, and green means that the application is ready for UAT testing. Then click Next.
  7. On the fourth page of the wizard, select the Action and Action Detail that will remediate the problem identified by the algorithm. (If the drop-down lists do not include a suitable action and action detail, select the closest available options and then add new actions later in the Algorithm Groups screen.)
  8. Click Next.
  9. On the fifth page of the wizard, define the logic for the algorithm. There are two ways of doing this:
    • The recommended way is to select the option that describes the issue from the drop-down list and then enter the appropriate value in the associated text box.
    • Advanced users can choose to edit the raw query. This opens the Create or edit the SQL query for an algorithm.
  10. Click Save to preserve your changes.