Create a custom report template

You can create a new template to customize the look of your reports.

Users can create and generate reports based on queries performed in IXIASOFT CCMS. A default XSL template for reports (report2html.xsl) is available in the Repository. If it does not meet your needs, you can create an alternative.

Important: Make configuration changes in a test environment and confirm they work before copying them to a production environment. For dedicated SaaS deployments, test the changes and then ask IXIASOFT Customer Support to copy the changes to your production environment.

If you define parameters in the report template, they act as editable key-value pairs when a user creates a report. The values you set in the template serve as default values for the report, overwritten in the report by the values specified by the user.

For example, the report2html.xsl file in the /system/xsl/report folder contains two parameters called CompanyName and Department. If you create a report using the report2html.xsl file as the XSL template, CompanyName and Department are displayed as keys in the Parameters pane along with the values specified in the template. If the user modifies values, the new values appear in the generated report, but do not impact the template itself.

Figure: Example of a fragment of the report2html.xsl file:
<?xml version="1.0"?>				
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:output method="html"/>					
		<xsl:param name="CompanyName">IxiaSoft Technologie Inc.</xsl:param> 
		<xsl:param name="Department">Development team</xsl:param>
		
		. . . 
Figure: Example of the report
Image of the report tab showing General Information and Parameters panes

To create a custom report template:

  1. Open the TEXTML Administration perspective by clicking the TEXTML Administration shortcut on the tool bar. If the shortcut is not displayed, follow these steps:
    1. Select Window > Perspective > Open Perspective > Other
    2. Click TEXTML Administration.
    3. Click Open.
  2. In the TEXTML Administration view, double-click the server.
  3. If your server is not displayed in the view, add it by doing the following:
    1. To find the server name, click Window > Preferences and select IXIASOFT CCMS.
      In the TEXTML Server Connection section, the server name is the Hostname.
    2. Copy the Hostname and close the Preferences window.
    3. In the TEXTML Administration view, right-click and select Add Server.
    4. In the Server field, enter the server name.
      The Port field should fill automatically. If you need the port number, you can find it in the same place as the server name in the Preferences window.
    5. Click OK.
  4. When the Connect as dialog opens, type your username and password and click OK.
  5. Double-click the name of your Content Store to open a connection to it.
  6. Expand the Repository folder and find the report2html.xsl file in the /system/xsl/report folder.
  7. Double-click the file to open it in the editor.
  8. In the main menu, click File > Export.
  9. In the Export dialog box, click General > File System.
  10. Click Next.
  11. In the To directory box, type the path to where you want to save the template on your local machine or click Browse to choose a location.
  12. Click Finish.
  13. Customize the template.
    1. Open the exported template in a text or XML editor.
    2. Modify the template as required.
    3. Save the file.
    4. Rename the file so you do not overwrite the existing default template in the Content Store when you import it.
  14. In the TEXTML Administration view, right-click the /system/xsl/report folder and click Insert Documents.
    The Insert Documents Dialog opens.
  15. Click the Add File button, choose your template, and click OK.
    Your template is checked in under the report folder in the Content Store.
  16. Inform users of the changes and request that they close and reopen their CCMS Desktop to apply the changes.
  17. Edit existing reports to use the new template or create new reports.
The custom report template you created is active and available for use.