Telerik Standalone Report Designer
Not compatible with the cloud version
Overview
Gimmal makes a report designer tool available for creating custom reports with Gimmal Records. It is for use only with the Gimmal Records SQL Server database. The Standalone Report Designer, including reporting engine, user interface, and designer, are licensed to you from Telerik, a third-party. You are free to use the designer on the server. You may make a copy of the designer executable for use on client machines, but the reports can only used by Gimmal Records copying the custom reports to the appropriate server location defined in this documentation. See Reporting Licensing for more information.
While this section outlines the usage of the reporting tool, Telerik provides complete documentation on their reporting tool at:
In addition to the ability to create custom reports, there are 20+ standard reports that are included. Any user with the appropriate permission can run the standard reports or the custom reports. There are two report formats:
Report Format | Description |
|---|---|
Compiled | These reports are built-in and will always show in the Reports section. These are pre-defined reports that are created with Visual Studio, compiled and DLL-based. They cannot be edited. There are 20+ compiled reports included with Gimmal Records. |
Custom | These are reports that are created with the Report Designer Tool and are considered Declared Reports. They are XML-based (.trdx extension) and can be edited. No custom reports are included with Gimmal Records by default. |
Reporting Licensing
In conformance with the End User License Agreement for Gimmal Records, you are also licensed to use the Standalone Report Designer (part of Progress© Telerik© Report Designer) as part of Gimmal Records. You can use the Report Designer with the following restrictions:
You may not distribute or use the software for any purpose other than using the Gimmal Records database as the data source.
Users may only view reports using the Gimmal Records web application; you may not disassemble the code, or attempt in any manner to reconstruct, discover, reuse or modify any source code or underlying algorithms of the Software.
For avoidance of doubt, you are not permitted to use the Telerik Standalone Report Designer, or any portions thereof, for software development or application development purposes unless you also purchase a separate commercial license from Telerik for each of the users.
Report Life Cycle
Understanding the report life cycle is crucial to effectively using Telerik Standalone Report Designer. See the link below for a detailed explanation on the life cycle.
http://docs.telerik.com/reporting/designing-reports-life-cycle
Report Deployment
To view a custom report within Records Management, the report needs to be deployed.
Deploy the report by copying the .trdx files to all Gimmal Records servers in the farm. They should be deployed to the same location as the Telerik Report Designer executables, typically:
%program files%/gimmal/information lifecycle/web/reports
Deploy the Report Descriptor File (Optional). By default, the report will display as the same name as the .trdx file. As this may not be user friendly, Gimmal Records provides the ability to create a Report Descriptor File with additional report information. This is not part of the Telerik product; this is an added feature provided by Gimmal Records.
The Report Descriptor File should have the same name as the .trdx file, except it will have an .xml extension.
It should be copied to the same location at the .trdx file.
The format of the Report Descriptor File is shown below:
<report>
<name> Custom Report Name </name>
<description> Sample Custom Report created with the Standalone Report Designer </description>
</report>
Database Schema for Reporting
When creating a custom report, you will need to define queries that go directly against the Information Lifecycle database in the Gimmal Records database.
If assistance is needed in writing a custom report, please contact Gimmal to discuss a Premier Services engagement.