CasewareDocs

Report Plug-in

A Report Plug-in selects the audit test results and saves them in the formats PDF, RTF, HTML, DOCX or DOC. The developer has to make sure, that all components which are needed to create the report, are available on the customer machine where the report will be created.

To built a Report Plug-in in SmartAnalyzer App SDK you need to create an assembly. For more information see structure of .NET assembly.

Step-by-Step

  1. To create a Report Plug-in select New in the File tab. Alternatively, you can click the New icon in the Quick Access Toolbar.
  2. In the New SmartAnalyzer App SDK Project dialog box select Report Plug-in.
  3. Enter a name for the SmartAnalyzer App SDK project. The name has to comply with the Windows guidelines for file and folder names.
  4. Select the location of the file to be created by clicking the Browse button.
  5. Click OK. A new document box is opened.
  6. In the General area the name, the author and the version number are shown. You can change them. The name is the content item name in SmartAnalyzer, the maximum length is 128 characters. You do not have to consider any Windows guidelines when entering the name, any character is allowed.
  7. Enter the minimum version of IDEA which supports the audit test in the field Minimum IDEA Version. By default, the lowest version number for which an app definition could be created is shown. If you enter a lower number it will be changed automatically.
  8. Select a report template by clicking the corresponding Browse button. The dialog box Select Report Templates opens.
  9. The fields in the Localization area only serve as information. They show the language settings that were made in the Options dialog box.
  10. In the .NET Project Or Assembly field click the Browse button to select the project representing the current implementation of the Report Plug-in.
  11. In the Properties area you can set a property. This property can be used to assign the Report Plug-in to a workflow. If a new value is added the current list separator selected for your computer have to be added after it.
    In the Compatibility Indicator field you can enter a group of string values used later to enable the merging of app workflows. App workflows can be merged if they have at least one compatible indicator value in common