Strategy Configuration – Reports

Report Uploader – Overview

The Report Uploader Facility allows users to upload their own Crystal or SSRS reports to Camms.Strategy®. This can be achieved by:

Uploading a new report
Editing an existing report and uploading

Note: Live hosted clients will need to host a copy of their database on a local server in order to access the database backend and design reports. Please contact the CAMMS Helpdesk if you need any assistance with this.

Please contact CAMMS if you are interested to purchase this solution, as it does not come with the standard suite.

IMPORTANT NOTES

The Report Uploader feature must be activated by CAMMS before it can be used.
Report uploader does not allow to ‘Edit’ (does not allow to add new Parameters) or ‘Remove’ CAMMS Standard Reports OR any client specific reports developed and deployed by CAMMS for the client. This will only allow the client to Add/Edit/Remove custom reports designed and uploaded by the clients themselves.
Any client specific developed report from client end - if any issues are found CAMMS are able to provide support on this, however if the issue is with the crystal report/SSRS report development, developed by the client then this work will be chargeable. Time taken can be used through clients’ customer care hours to fix this, or else we will send invoice at a rate of $225 per hour (our standard helpdesk support rate).
These reports are developed by the client either from scratch or using our standard reports with our existing procedures/functions to develop the report. However, since CAMMS owns the IP of the product we may modify the database schema and procedures based on our requirements i.e. Enhancements, roadmap, custom modification, in line with our releases. This could impact on the standard database schema which clients have used on their custom reports and it is therefore expected that the client will have adequate report development skills to analyse the Database level changes and modify their custom report to adopt the changes, or alternatively, if the clients do not have the expertise CAMMS can do this for them however that will come with a cost.
If a report is running and shows the data consistent from Crystal reports, however shows a mismatch from within Camms.Strategy® itself, this means that the client has given the wrong report parameters in the report uploader, that is why it works in Crystal IDE but not in Camms.Strategy®. (i.e.; if customer gives wrong report parameter type(s) in the uploader that affects the output of the report, when you run from Crystal IDE user gives the correct ID values for parameters.)

Adding a new report

This can only be done by an Administrator.

STEP 1: To navigate to the Report Uploader page go to Administration > Configuration > Reports.
STEP 2: Select the area of reporting that you wish to upload to i.e.; ‘Strategic community planning'. Any reports you have already uploaded are displayed along the left. Click NEW.

STEP 3: To Upload a new report click on the Icon to the right on the reports title.

STEP 4: Now select the type of report that you wish to upload. (Navigate to these hyperlink pages for the next steps based on the report type you are using).
- Crystal Report – This option is selected if you have designed a Crystal report.
- Microsoft SRS – This option is selected if you have designed a SSRS report.

Adding a Crystal Report

STEP 1: Select 'Crystal Report' as the report type and fill in the required fields.

Field	Selection	Mandatory/Optional
Report Type	Select type as ‘Crystal Report’.	Mandatory
Title	Define a name for the report (This will be displayed in the reports area).	Mandatory
Sequence	Input a number to define the order of the new report among the existing report list visible in Sycle > Reporting > Relevant reporting area.	Mandatory
Visible	Tick the box to make the new report visible in Sycle > Reporting > Relevant reporting area. Note: This is ticked by default. If un-ticked reports will be invisible.	Optional
Report Version	Define a report version for the report. For example, if it is a 2^nd version to an existing report, the user can enter either 1.1 or 2 as the version number. Note: This value is only visible within the application.	Optional
Report File	Browse and select the new report file to be uploaded. Notes: Maximum file upload size should not exceed 10MB Crystal Report file should be in .rpt format	Mandatory
Location	This will display the server location where the report is saved. Notes: The location value will only be displayed in the screen once the user clicks on ‘Save’. Crystal reports will be saved in a default location within the Application server itself.

STEP 2: Click 'Save' to upload the report.

Adding a Microsoft SRS report

STEP 1: Select “Microsoft SRS” as report type and fill in the required fields.

Field	Selection	Mandatory/Optional
Report Type	Select type as ‘Microsoft SRS Report’.	Mandatory
Title	Define a name for the report (This will be displayed in the reports area).	Mandatory
Sequence	Input a number to define the order of the new report among the existing report list visible in Reporting > Relevant reporting area.	Mandatory
Visible	Tick the box to make the new report visible in Sycle > Reporting > Relevant reporting area. Notes: This is ticked by default. If un-ticked reports will be invisible.	Optional
Report Version	Define a report version for the report. For example, if it is a 2^nd version to an existing report, the user can enter either 1.1 or 2 as the version number. Notes: This value is only visible within the application.	Optional
Report File	Browse and select the new report file to be uploaded. Notes: Maximum file upload size should not exceed 10MB. As SSRS reports can contain Master report and sub-reports separately, all relevant report files must be zipped into one [.zip] file before uploading. Make sure that the zip file does not contain any folders. If there is only one file for the SSRS report, it can be uploaded as .rdl file.	Mandatory
Folder Name	User has to define a folder name. Notes: Once the report is uploaded and saved, 2 folders with this name will be created within the Report server to keep/extract the SSRS report files and to refer to the necessary Data sources. If a user adds an already existing folder name, the new report will override the existing report files.	Mandatory
Location	This will display the server location where the report is saved. Notes: This location will only be displayed in the screen once the user clicks on ‘Save’. SSRS reports will be saved in the Report Server.	-

*‘Report Category Group’ tree – This hierarchy tree lists the report categories, which a report can be uploaded against. User is allowed to change the respective category through this selection tree.

STEP 2: Click 'Save' to upload the report.

Note: When the user clicks on ‘Save’ and if it is an SSRS report with multiple reports, the user will be prompted with another screen listing all the .rdl files of your new SSRS report (see below). User must select the specific .rdl file which should be used as the Master report for the new report. If the SSRS report only contains one report file, this prompt will not appear.

Database Diagrams

The CAMMS SQL Database contains some overview database diagrams, which are available within the Microsoft SQL Server Management Studio.

Please contact CAMMS for further information regarding this.

Adding Parameters

Once you have uploaded your new report, the "Add New Parameter" button will appear below the details of the report.

Preconditions

A report file (Crystal/SSRS) should already be uploaded.
The report file must NOT be a standard report in Sycle.

Once a new report has been uploaded, the ‘Add New Parameter’ button will be displayed.

STEP 1: Click the "Add New Parameter" button and add new parameters to the report. These new parameters are the filters which would be displayed within the report filter section.
STEP 2: Update the relevant fields within the parameter table and click 'update'.

For SSRS report only, make sure you 'save' once you are done updating. If you are uploading SSRS report, do not click save.

STEP 3: Add the Sort order number and check the "Show all" tick box if you need the "Show All" option to be available for the parameter.
STEP 4: Once you have entered all information click Add.

Parameter Table:

Field	Selection	Mandatory/Optional
Name	Select the parameter name from the existing list of parameters within the system. For example, if your reports need a ‘Business Unit’ filter you can select the name ‘Business Unit’ from the drop-down. Note: This drop-down menu only lists the existing list of parameters which are being used in the system. If the user requires a completely new parameter, it should be notified to CAMMS.	Mandatory
Parameters	Enter the same parameter name used within the ‘Parameter Fields’ of your Crystal/SSRS report, for the selected parameter. Notes: Multiple parameters can be added as comma separated values. i.e. Date From, Date To.	Mandatory
Parameter Name	Enter the parameter name which needs to be displayed within the report filter page (report preview area of the application). The report parameter field names should be entered into the parameters field with no spaces. A space is added automatically when the parameter is added, however ensure that you remove this. Note: If this field is left blank, the ‘Name’ value of the parameter would be used by default within the report filter page.	Optional
Default Values	Select a default value to be loaded for the parameter, when being displayed within the report filter page. Notes: The user must save the parameter prior to using this option and then click on ‘Edit’ to enable editing of this field. User will be presented with a pop-up which loads the parameter and its respective values. User can select a preferred default value and ‘Save’. The ‘Clear Default Values’ tick box available within this pop-up window allows to reset the value.	Optional
Hide	If ticked, the parameter will be hidden within the report filter page. If un-ticked, the parameter will be displayed within the report filter page. Note: This will only be applicable if a ‘Default Value’ has been set for the parameter. Else the user will be requested to set a ‘Default Value’ prior to hiding the parameter.	Optional
Sort Order	Enter the order of the display of parameters within the report filter page.	Mandatory
Show All	Tick the box, if the parameter is a drop-down list and if you require the ‘Show All’ option to be available.	Optional

Note: The System Period and User ID parameters are automatically passed from the system to the reports. Therefore they do not need to be added manually.

Tip: A parameter quick reference sheet is available here.

The System Period parameter is automatically filtered by the application and therefore it does not need to be added manually.

Adding Parameters to Crystal Reports

This should be done by a Crystal Report writer or by someone who has a good knowledge in coding Crystal Reports.

CAMMS will not be responsible for any modifications made to new and existing reports.

STEP 1: Open the Crystal Reports application and load the required report.
STEP 2: Navigate to the field explorer and select the new parameter field.

Creating a new parameter

STEP 1: Enter a descriptive name for the Parameter name.
STEP 2: Select the Data Type.
STEP 3: Select the List of Values.
STEP 4: Select the Value Field.

STEP 5: Click 'OK' to save the information.
STEP 6: Open the formula workshop by navigating to Selection Formulas > Record.

STEP 7: Once the Formula workshop is open, add your selection code by starting with AND or OR.

STEP 8: Add the parameter description as it is exactly in the report.
STEP 9: Click 'Save' once you have added all the parameter information.

The report can now be tested within the Reporting menu.

Ensure you take a backup of the "CustomReports" folder when upgrading Camms.Strategy^®. The default location is C:\Inetpub\wwwroot\cammsstrategy\CustomReports. After the upgrade is complete please restore this folder CustomReports from your backup.

Previewing the Report

STEP 1: Navigate to Camms.Strategy® Reporting section.
STEP 2: Select the relevant reporting area (i.e. Corporate Business Reporting, Strategic Reporting etc.) to where the new report is added. Check whether the new report is appearing within that area and then click on it.
STEP 3: Select the respective parameter values to filter the report content (from the respective list of parameters), and click on ‘preview’ to generate the report.

Note: Check whether all the parameters added to the report through the report uploader parameter grid are being displayed here.

Existing Report

Editing a standard report

STEP 1: Navigate to Report Uploader screen and select the reporting area under which the report is placed.
STEP 2: Select the report which you require to edit and click on the Edit button.
STEP 3: For Standard Report or a Custom report developed and deployed by CAMMS, the user will only be allowed to edit the following fields within the Parameter table.
- Default Values
- Hide
- Sort Order
- Show All

Editing a custom report

STEP 1: Navigate to Report Uploader screen and select the reporting area under which the report is placed.
STEP 2: Select the report which you require to edit and click on the Edit button.

For a Standard Report or a Custom report developed and deployed by CAMMS, the user will only be allowed to edit the following fields within the Parameter table:

Name
Parameters
Parameter Name
Default Values
Hide
Sort Order
Show All

Note: For a custom report as such, the ‘Add New Parameter’ button will be also displayed for a user allowing them to add a new parameter to the report as required. This button is not available when trying to edit a Standard report.