An administrator should designate a directory on an internal file-share for storing Lucity Web custom reports. Remember that Lucity Web reports are different from Lucity Desktop reports; therefore, they require separate directories. Also, make sure the report-share is located in a place that is easy for your report writers to access.
Configure Lucity System Settings To Point to the File-Share Location
Enter the shared location in which you want to store the reports.
\\<Servername>\Shared\WebReports\
Organizing Your Current Custom Reports
An agency may wish to create a directory structure in this location to separate reports by system; however, this is optional:
\\<Servername>\Shared\WebReports\Work\<reports for the work program go here>
\\<Servername>\Shared\WebReports\Sewer\<reports for the sewer program go here>
If an agency has any custom reports, they should be moved over so that reports are centralized and report editors can easily access them. Copy any custom reports from their current location (wwwroot\LucityWeb\Reports) to this new report location.
Note: Do not copy Lucity standard reports. Only copy your agency's custom reports (from the web server) into the new WebReports folder (on the file-share).
After you've created your custom report share and moved your report files the next step is to update the report paths in the Lucity Administration Tool. To make the changes, open the Report Manager and verify the path of each of the custom reports by clicking on the custom report and selecting Edit. Fix any reports that require a path adjustment.
Note: It's possible to configure the pathsdirectly in the XXWEBRPTS tables, but doing so requires expertise in working with SQL Server database tables.
In the Lucity Administration Tool, go to Reports > Reports Manager.
Highlight a custom report listed in the Report Manager grid.
Click the Edit button at the bottom of the dialog. The following window appears:
Edit the desired fields.
Report Name - The unique name that will identify the report in Lucity Web.
Report File Name - The location of the report in the Custom Report folder.
Note: Above the field, the system identifies the location of the Custom report folder. To put the report in a subfolder, add the subfolder as part of the name. In the example above, the MyCustomWODetailWeb.rpt is in the Work subfolder of the Custom report folder.
Report Description - A general description of the report.
Save changes.
Managing New Custom Reports and Updates to Existing Custom Reports
Going forward, when adding new custom reports, upload the report using Lucity Web. The system will place the report in the report-share automatically.
In Lucity Web, openthe module you would like to add the report to.
Click the button on the toolbar. The Report tool opens.
To add a new report, click the Add button . The following dialog appears:
Enter the Report Name and Report Description.
In the Report File Path, enter the name of the folder to which you want to upload the report file.
Note: Reports are automatically uploaded to the location specified in the Lucity Administration Tool's Path where Reports are stored setting, which may be found in the System > Settings > Documents tab.
Note: If the folder name entered does not exist, the system will create a folder with that name within the folder to which the reports are uploaded.
Under Choose File to Upload, click ... and select the .rpt file you would like to upload to the web server.
Note: The name of the .rpt file being uploaded cannot match any other .rpt files.
Assign the report to a Group (optional).
Choose or change the Type of report:
Standard Report - The report is generated when the user clicks the Report tool, selects the report and chooses how to run it.
Quick Report - All Records - Adds the report to the Quick Report drop-down list, located next to the Report tool. The report always runs against all records.
Quick Report - Filtered Set - Adds the report to the Quick Report drop-down list, located next to the Report tool. The report always runs against the current filter set.
Quick Report - Current Record Only - Adds the report to the Quick Report drop-down list, located next to the Report tool. The report always runs against the current record.
Click Save.
When editing a report, the Save button is replaced with an Update button.
If you are editing the .rpt file in the share, you can edit it and save the changes Lucity Web will refresh the copy of the report when it runs overnight.
OR
If you need to push the change out immediately, or, if you are editing the report on your machine, make the edits and save it.
Open Lucity Web and go to the module associated with the report.
Click the on the toolbar. The Report tool opens.
Select the report to update from the list and click the button.
Click the ... button and select your updated .rpt file.
Click Update.
The new copy of the report will be uploaded and will replace the existing report file.
Note: The reports that Lucity provides with the software cannot be updated.