CM4D Reports are a special type of report stored in a CM4D site database that contains information about pre-generated reports (PDF files) that can be found on the specified depository (network location). The database and network configuration for these searches is stored in a CM4D reporting source.
To add a CM4D reporting source:
Open ATS Configuration Manager and navigate to the Reporting card.
Press Add source.
The New reporting source pane is loaded. Fill in the fields presented as follows:
Name: Enter a name for the reporting source. This name must be unique.
Description: Enter a description for the reporting source.
CM4D Scheduler Hostname: Enter the CM4D scheduler hostname.
Database Server Name: Enter the name of the database server.
Database Name: Enter the name of the database.
User: Enter a valid a user name that has access to the database.
Password: Enter the password for the user name specified.
Domain: Enter the depository domain name.
User: Enter a valid user name that has access to the depository.
Password: Enter the password for the depository user name specified.
Max Sample Count Default: Enter the maximum number of samples to include in the report. E.g. 100.
Max Days Out Default: Enter the maximum number of days to include in the report. E.g. 30.
Check connection: Check the connection using the details entered above by pressing the Check connection button.
Press Save or Save and close.
Every CM4D type of reporting source added has these reports:
Generated reports
Report templates
Managed reports
All managed reports are shown under the report templates.
To create or add a CM4D report in the Reports menu drag & drop the Generated reports report, Report templates report folder or Managed report from the selected source to the reports menu in the Organize reports menu blade.
To add a CM4D report to the reports menu:
Select a CM4D reporting source from the Source select list in the source section of the Organize reports menu blade
The reports from the selected source are loaded in the source section in a source reports tree. For a CM4D reporting source there are always these reports: Generated reports and Report templates, containing all Managed reports as nodes under the Report templates.
Drag the selected report or report folder from the source tree to the desired position in the reports menu on the right (menu section of the blade).
The target position will be marked as drop area (or the target folder will be "highlighted").
Drop the selected report or report folder to the target position/folder in the reports menu.
A success notification appears and the new report menu item is added to the selected position in the reports menu.
The CM4D reports are very similar to the reports (report instances) created from other types of reporting sources. The only difference is that the report parameters are the same for each CM4D report and they are used as filters to search for pre-generated PDF files in the CM4D system.
To edit a CM4D report, click on the report name in the menu structure or select the Open option from the report item's context menu. The Report instance details blade is loaded on the right.
The report instance details blade has four tabs: Properties, Parameters, Time periods and Security. The Properties blade is pre-selected.
Edit the report name and/or description.
Click on the Save or Save and close option in the report details blade.
When clicking the Save option all entered data is saved and the user is redirected to the Edit source blade.
When clicking the Save and close option all the entered data is saved, the blade is closed, and the user is redirected to the All Reporting sources blade.
Each CM4D report has the following parameters:
Depository: Select list, filter.
Generated from: Date selector, filter.
Generated to: Date selector, filter.
Template: Text field, filter.
Tags: One text field per each available tab in the database, filter.
Each filter parameter can be set to a value and this will be the pre-selected or pre-set value loaded in the matching parameter in the Parameters panel in ATS Reporting Portal. When a filter value is not set the filter parameter in the Parameters panel will not be set or selected.
When a filter parameter is marked as read-only that the search will be made based on the set value and the user in ATS Reporting Portal will not be able to change the value.
When a filter parameter is marked as hidden then the search will be made based on the set value and the user in ATS Reporting Portal will not be able to see this filter parameter in the Parameters panel.
The filter parameters are not mandatory to execute a search against the CM4D database. This is why hidden or read-only parameters can be configured with no default value for a CM4D report.
The tag filter parameters enable search based on tags applied to a PDF reports. To disable search by certain tag type mark the respective tag parameter as hidden. This way to user in ATS Reporting Portal will not be able to "narrow" the search results based on the value for that tag.
The search results for CM4D reports in ATS Reporting Portal can be presented using Tiles.
The same rules apply as when editing report time periods for other report instances.
Can we improve this topic?