Report Checklist: Context-sensitive reports

Reports that have been designed by a licensed ReportIt user can be made available to other Diligent Entities users.

Report filters can be used to make a report context-sensitive. For example, users can select the Entity that they would like to generate a report for, or the Appointment Type that they want to report on. Report filters can also be used to generate a report from within an entity (i.e. if the link to a report is added to an entity portal). A user with access to Document Templates, User Defined Documents and User Defined Menus options in System Tools, can make the necessary configuration changes.

Design the report

Design, test and save the report with ReportIt.

The RIT configuration file

Using Notepad (or other text editor) create a new text file with the extension RIT (for example, MyReport.RIT).

<?xml version="1.0" ?> <RIT xmlns:dt="urn:schemas-microsoft-com:datatypes"> <TOOL dt:dt="string">RIT</TOOL> </RIT>

Create a link to the report

To make the report available, it is necessary to add the report to a Portal, a Banner, a Toolbar, or a page within an entity portal (for example, Companies, Individuals, Other Entities, etc.), to create the necessary link.

• Create a Menu User Defined Menus: Add Links to the ReportIt Report Portal and ReportIt Model Editor.

Setting report parameters/filters

Report Parameters/Filters for context-specific reports must be specified in the RIT file.

• Copy the XML generated in the Parameters field for the selected report.

• Paste the XML as below:

<?xml version="1.0" ?> <RIT xmlns:dt="urn:schemas-microsoft-com:datatypes"> <TOOL dt:dt="string">RIT</TOOL> <PARAMETERS> <REPORTPARAMETER>[%Company (Code), String%]</REPORTPARAMETER> </PARAMETERS> </RIT>

Update the entry within for each Parameter/Filter to be set, substituting the name of the Parameter from the report with the corresponding context-sensitive variable available in Diligent Entities. In the example above "Company Code" was the name given to the Parameter/Filter in the Report Designer.

<?xml version="1.0" ?> <RIT xmlns:dt="urn:schemas-microsoft-com:datatypes"> <TOOL dt:dt="string">RIT</TOOL> <PARAMETERS> <REPORTPARAMETER>[%Company (Code);xmlstr%]</REPORTPARAMETER> </PARAMETERS> </RIT>

The RIT file is an XML file and must be formatted as such, otherwise the report could fail (for example, text variables inserted should be formatted with the "xmlstr" option).

Importing the RIT file

• Use the Document Templates option of System Tools to import the RIT file. You may import the template to any document, but the All Countries > My Reports group is recommended.

Update the link to the report

Use the User Defined Menu option of System Tools to update the link to use the new template.

• Edit the Link.
• Select the previously imported template.
• Select Finish.

The context-sensitive report will now be available to other users.