12. REPORTS & PROCESSES MODULE
i. This module is responsible for handling all the reporting requirements of the Organisation as well as all Backend data processing functionality. All such Background processes are defined and configured here and can also be run from here.
B. DEFINE REPORT/PROCESS
i. Go to the REPORT CREATOR TAB
ii. Click on ADD
iii. Provide a Name and Description for your Background Process/Report
iv. Indicate the main Module this Report/Process relates with (Purely Informational)
v. Indicate the Process Type whether an SQL Report(Output file May be Generated) or a Database Function (Purely for Data Processing-May not Generate any Output File)
vi. Col Nos. to Group or Width & Height for Charts: – As the name implies specifies the comma separated column indices (Zero based) to Group during the report output file Generation and if the report Output Type is Chart then this is rather the width and height of the Chart.
vii. Col Nos. to Count or Use in Charts: – Comma Separated indices of the Columns in the SQL Statement to be counted are specified here. If the report Output is Chart the it is the columns whose data is to be used in the Chart
viii. Process Runner: – The name of the Background Report/Process Runner to act on this Report or Process when it is submitted for running.
ix. Col Nos. to Format Numerically: – i.e. Comma Separated Column indices to be formatted as numbers
x. Col Nos. To Sum: – i.e. Comma Separated Column indices whose row values are to be totaled.
xi. Col Nos. To Average: – i.e. Comma Separated Column indices whose average values are to be calculated
xii. Output Type: – i.e. HTML, STANDARD, EXCEL, WORD, PDF, CSV, CHARTS
xiii. Orientation: – i.e. Portrait or Landscape
xiv. Layout: – i.e. whether output is a tabular display or detail layout.
xv. Delimiter: – where output is CSV (Character Separated Version File).
xvi. Detail Report Image Col Numbers: – The columns to be treated as Images (i.e. the Images specified by the path is to be shown rather that the path data itself) in a Detail Report
xvii. Check the Is Enabled? Checkbox to enable this Report/Process.
xviii. Provide the SQL Statement Behind this Process/Report.
xix. If the Report Layout is DETAIL then specify the Groupings for the Detail Report
• Click on ADD button on top at the Report Groupings for Detail Report Section
• Group Title: – Title of the Group
• Display Type: – Whether Detail or Tabular
• Comma Separated Column Numbers: – The indices of the Columns whose data is to be displayed within this group
• Group Page Width: – The Page width of this group whether full or half.
• Indicate the Minimum Height of the Group
• Number of Vertical Divisions within the Group:- either 1, 2 or 4
• Order: – Indicated the position of the Group within a record display relative to other Groups
• Data Label Max-Width: – In Percentage Terms the Width to be given to a label against a Record Data/Value
• Group Border:- indicates whether to Show or hide the Border and/or Caption
• If Group Layout is Tabular then provide the Column names separated by commas
• Also indicate the row and column delimiters
xx. If this Report or Process must run other reports/processes in Addition then indicate those reports & processes under the Program Units Section. They will all be run after the main program has been run.
xxi. Report Parameters and their default values must be provided in the REPORT PARAMETERS Section. NB: It is important to right-click on the Listview here and click on Refresh to Synchronize all Attached List of Values for the Seeded Reports that were imported.
xxii. Indicate the Role sets allowed to View/Run this report in the REPORT ALLOWED ROLE SETS SECTION
xxiii. Click EDIT to edit a report
xxiv. Click DELETE to delete a report after all dependents have been deleted.
xxv. Click on DUPLICATE to make a complete copy of an existing report/process to edit afterwards
xxvi. Click SETUP PROCESS RUNNERS to define new process runners or to START/STOP the REQUESTS LISTENER PROGRAM
xxvii. The REQUESTS LISTENER PROGRAM is responsible for Generating all scheduled runs and running them as and when required as well as running user initiated runs which are not running.
C. RUN REPORTS/PROCESSES
i. Search for and select the report/process to be run
ii. Click on RUN PROGRAM Button on top of the List of Reports/Processes
iii. Click on Yes to confirm the run
iv. A Dialog Pops up with all the Parameters for this report/process already populated with the default value.
v. Provide new values if necessary and click on OK.
vi. Alternatively you can also click on COPY PREVIOUS VALUES to select a previous run and populate its values before clicking on OK to start running the report/process.
vii. Click on the REFRESH Button directly under the REPORT RUNS TAB to see the status of the run.
viii. Click on OPEN OUTPUT FILE Button when the run status changes to COMPLETED! Or 100%
ix. You can also click on VIEW LOGS Button to see what went on BACK END whiles the run was going on.
x. RUNS can also be scheduled by clicking on SCHEDULE RUNS Button on top of the List of Reports/Processes.