AcuGIS
/
Jasper-Publisher
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs/components/run/index.rst

This commit is contained in:
AcuGIS 2024-06-06 12:19:31 +00:00
parent 83b539ad6a
commit aca4e73642
1 changed files with 8 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
docs/components/run/index.rst
View File

@ -6,90 +6,28 @@ Run
Overview
==================
Click the Reports tab to open the Reports Dashboard.
Click the Report menu
.. image:: _static/reports-tab.png
.. image:: report-1.png
This will open the screen below.
The Report page looks as below
.. image:: _static/report-dashboard.png
As we can see above, the creation of our NewReports Directory has been added to the directory structure. This is true for all directories and sub directories added.
Dashboard Layout
Run Report
================
Expanding the NewReports directory, we see below:
To run a report, click the run button as shown below:
.. image:: _static/report-dashboard-item.png
.. image:: report-2.png
Dashboard Functions
===================
**Name**::
Clicking on the report name will open the .jrxml file for editing, as shown below:
.. image:: _static/reports-edit-jrxml.png
**Actions**::
Run: Runs the report on demand.
.. image:: _static/reports-actions.gif
Clean: Opens a new window to delete any reports you may wish to delete
.. image:: _static/reports-cleaner.png
Download: Opens a new window to download selected report(s) in .zip or .bgz format.
.. image:: _static/reports-downloader.png
**SchID**::
Link to edit the Schedule for the report
**Cron**::
Displays the cron in use for the Schedule
**Format**::
Displays the report format (e.g. pdf, csv, etc...)
**Data Source**::
Displays report Data Source
**Output**::
Clicking the Browse button will open the report directory in the File Manager as shown below:
.. image:: _static/reports-browse.png
**Email**::
Displays report email recipient(s).
**Optional Params**::
Displays any URL Parameters the report is using.
No Schedule
===========
.. note::
Any report that does not have a schedule will show the Scheduler icon in the Actions menu. To add a Schedule, click the icon as shown below.
The report will be emailed if job includes emailing report. The output either way can be accessed via File as shown below
.. image:: _static/reports-no-schedule.png
.. image:: files.png