1124 - How to modify an Enterprise Report template

An Enterprise Report template contains two types of content:

• static content – controlled through the report template
• dynamic content – controlled through sub-templates

You can modify the content of an existing Enterprise Report template by editing the report template HTML file in the AccountServer’s report category folder. 

You can modify the properties of an existing Enterprise Report template by editing the XML file that accompanies the report template HTML file in the AccountServer’s report category folder. 

How to modify a template's static content

1. In the Storage Platform Console, locate the template you want to modify, noting its name and the category to which it belongs (as displayed on the Report Templates tab).

2. On the AccountServer, recreate the relevant template category folder that is located in C:\Program Files\{Product Folder}\Storage Platform\Reports\ in C:\ProgramData\{Product Folder}\AS_Service\Reports. For example, C:\Program Files\Attix5 Pro\Storage Platform\Reports\Audit produces C:\ProgramData\Attix5 Pro\AS_Service\Reports\Audit. 

3. Copy the relevant template's HTML file to the new folder.

4. Open the copied template in an HTML or text editor. Redstor Pro Enterprise Reports are typically structured as follows:

• The report title is defined in the head element.
• The header and footer are positioned within a div element, and sub-templates (which reference a CSS style sheet) define their style.
• Static content is arranged in a table and styled using CSS style classes.
• Dynamic content is referenced using sub-template placeholders.

Modify these properties by changing the HTML as desired. 

5. Save the file. Once the message “<timestamp> Info: Updating report: <report name>” is logged in the Console's AccountServer Diagnostics window, the changes will be reflected in the next report that is run.

How to modify a template's dynamic content

1. In the Storage Platform Console, locate the template you want to modify, noting its name and the category to which it belongs (as displayed on the Report Templates tab).

2. On the AccountServer, in the folder where the report templates are located (by default C:\ProgramData\Attix5 Pro\AS_Service\Reports\<Category>), create a separate folder that will house your custom sub-templates (for example C:\ProgramData\Attix5 Pro\AS_Service\ReportTemplates).

3. Copy the relevant report template's HTML file (which is, for this example, now located in C:\ProgramData\Attix5 Pro\AS_Service\Reports\Audit) to the ReportTemplates folder. Rename this copied HTML file based on the sub-template it will contain, e.g. AuditTrailGroups.html. Whenever another template now references this sub-template, its name should appear between question marks, e.g. <?AuditTrailGroups?>. Whenever a SQL identifier is referenced, in turn, its name should be flanked by dollar signs, e.g. ($:LogDateTime$).

3. You can now change the display properties of the data by changing the HTML or reordering the identifiers. You can even change the SQL query/ies altogether by making changes to the SQL sub-template/s.

How to modify a template's properties

1. In the Storage Platform Console, locate the template you want to modify, noting its name and the category to which it belongs (as displayed on the Report Templates tab).

2. On the AccountServer, recreate the relevant template category folder that is located in C:\Program Files\{Product Folder}\Storage Platform\Reports\ in C:\ProgramData\{Product Folder}\AS_Service\Reports. For example, C:\Program Files\Attix5 Pro\Storage Platform\Reports\Audit produces C:\ProgramData\Attix5 Pro\AS_Service\Reports\Audit.

3. Copy the relevant template's XML file to the new folder.

4. Open the copied template in an XML or text editor. Redstor Pro Enterprise Reports typically have the following properties defined in XML:

• Report name and description
• Admin-only access (true/false)
• Report template filename
• Optional parameters

Example:

<report name="AuditTrailGroups" admin="true">
<desc>Audit trail on changes to all Backup Groups.</desc>
<reportFilename>AuditTrailGroups.html</reportFilename>
</report>

Modify these properties by changing the XML as desired. 

Note: If you specify parameters, you need to define those parameters in the corresponding SQL file. The XML file only instructs the Console to prompt the user for the information. The SQL file sends those parameters to the database, along with the query.

5. Save your changes.