Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

The Report Builder menu in Paradigm allows you to extract information stored within the system and generate reports designed to meet your business or institution’s requirements. Reports can be produced in multiple formats (e.g. HTML, CSV, XLS, JSON) to address your reporting needs. Data or information can also be accessed by external software or application via API. To increase the efficiency of some of your processes as a business or institution (e.g. enrol, update information, email communications), this menu will also allow you to generate bulk targeted sets of information depending on your required bulk actions.

Complexity:

Status
colourBlue
titleMEDIUM
to
Status
colourRed
titleHIGH


Expand
titleReport Builder Introduction

How does Report Builder work?

All data in Paradigm are stored in tables, and the collection of tables (organised and structured) is called a database. Report Builder allows you to extract data from the database and generate the required data for you to make meaning and analysis. Knowing what data or information to extract is key in building a report. Report Builder is built on SQL (Structured Query Language), however, you don’t need to be able to write in SQL to create reports. It has a friendly user interface to help you create your reports.

The following are the sections you can see under the Report Builder menu in Paradigm. All the form’s functionalities, fields, and buttons are explained in detail, which will serve as your reference and will set your expectations on what you can and cannot do when you get to the point of following the workflow on how you can generate your report.

Page Tree
rootReport Builder (draft 2)
startDepth1

  1. The first thing to consider when using the Report Builder menu in Paradigm is to identify the needs and requirements of generating the report. The question as to why the report is needed, what are the data or information required to address your business or institution needs, and how you want it generated.

  2. After you’ve identified your needs, the next thing to do is to check and find the closest base or saved reports currently available in Paradigm which contains all the possible data you need for your report.

    Basic pre-defined reports – start your search in the BASE REPORT DESCRIPTIONSsection.

    Previously customised or requested saved reports by someone in your business or institution or from one of our Support Team – start your search in the SAVED REPORT DESCRIPTIONSsection.

  3. Once your chosen base or saved report is loaded, you can check all the available data or information to be extracted of that report name under the REPORT COLUMNS section. You can add, remove, or updates the fields you want included here. However, if you wanted an output to be the same as your selected report, proceed to the FORMAT REPORT section where you can immediately generate or produce the report without making any changes.

back to top

Expand
titleAPI

Expand
titleBulk Communication

Expand
titleOutput Formats for Reports


Workflow

Status
titleworkflow 1 >>>
Basic Report Builder (Building) / Report Builder – Basis

Expand

NOTE: This workflow section will guide you on how to generate reports in Paradigm using existing base or saved reports. This is applicable if the report that you want to produce has (exactly) the same data or information you want.

1️⃣ Base Report or Saved Report >>> 2️⃣ Format Report

Status
colourGreen
title1
Choose the report you want to generate:

Base Report – start your search in the BASE REPORT DESCRIPTIONSsection.

Saved Report – start your search in the SAVED REPORT DESCRIPTIONSsection.

Status
colourGreen
title2
Select your report output format: (see FORMAT REPORTsection for more details.)

Status
titleworkflow 2 >>>
Advanced Report Builder (Building) / Report Builder – Extended

Expand

NOTE: This workflow section will guide you on how to generate customised reports in Paradigm. This is applicable if the report that you want to produce has some data or information from existing base or saved reports, filter the data with operators and conditions.

1️⃣ Base Report or Saved Report >>> 2️⃣ Customise (Report Columns, Filter Clauses, User Defined Parameters, Order By Clauses, Generic Report Query, Summarise Data, Save Report) >>> 3️⃣ Format Report

Status
colourGreen
title1
Choose the report you want to generate:

Base Report – start your search in the BASE REPORT DESCRIPTIONSsection.

Saved Report – start your search in the SAVED REPORT DESCRIPTIONSsection.

Status
colourGreen
title2
Customise your report:

Page Tree
rootCustomise Report
startDepth1

Status
colourGreen
title3
Select your report output format: (see FORMAT REPORTsection for more details.)

Base Reports | Saved Reports >>> Report Columns >>> Filter Clauses >>> User Defined Parameters >>> Order By Clauses >>> Generic Report Query >>> Summarise Data >>> Save Report >>> Format Report



Expand
titleHow to generate a report using Report Builder?

How to generate a report using Report Builder?


What data or information are needed for my report?

The first thing to consider when using the Report Builder menu in Paradigm is to identify the needs and requirements of generating the report. The question as to why the report is needed, what are the data or information required to address your business or institution needs, and how you want it generated.


Are the data or report output I want close or the same to existing Base Reports or Saved Reports?

After you’ve identified your needs, the next thing to do is to check and find the closest base or saved reports currently available in Paradigm which contains all the possible data you need for your report.

Basic pre-defined reports – start finding in the BASE REPORT DESCRIPTIONSsection.

Previously customised or requested saved reports by someone in your business or institution or from one of our Support Team – start finding in the SAVED REPORT DESCRIPTIONSsection.


Do I need to update the columns or the data or information currently available in my chosen existing (Base or Saved) report?

Once your chosen base or saved report is loaded, you can check all the available data or information to be extracted of that report name under the Report Columns section. You can add, remove, or updates the fields you want included here. However, if you wanted an output to be the same as your selected report, proceed to the Format Report section where you can immediately generate or produce the report without making any changes.

YES – proceed to the REPORT COLUMNSsection.

NO – proceed to the FORMAT REPORT section.

back to top

What data or information are needed for my report?

The first thing to consider when using the Report Builder menu in Paradigm is to identify the needs and requirements of generating the report. The question as to why the report is needed, what are the data or information required to address your business or institution needs, and how you want it generated.

Are the data or report output I want close or the same to existing Base Reports or Saved Reports?

After you’ve identified your needs, the next thing to do is to check and find the closest base or saved reports currently available in Paradigm which contains all the possible data you need for your report.

Basic pre-defined reports – start finding in the BASE REPORT DESCRIPTIONSsection.

Previously customised or requested saved reports by someone in your business or institution or from one of our Support Team – start finding in the SAVED REPORT DESCRIPTIONSsection.

Do I need to update the columns or the data or information currently available in my chosen existing (Base or Saved) report?

Once your chosen base or saved report is loaded, you can check all the available data or information to be extracted of that report name under the Report Columns section. You can add, remove, or updates the fields you want included here. However, if you wanted an output to be the same as your selected report, proceed to the Format Report section where you can immediately generate or produce the report without making any changes.

YES – proceed to the REPORT COLUMNSsection.

NO – proceed to the FORMAT REPORT section.