Dashboard Configuration

Overview

Dashboards provide a high level view of the project. Quick reports can be generated using the dashboard to get an overview of the progress or activities in a project. It gives you an idea of what is going on with your system at that specific time..

See below created dashboard screen

How to create Dashboard ?

See below default screen of Dashboard management , where you can add blocks and dashboard pages.

It allows you to search by Block name , Chart Type and Module name.

It provides dashboard log also. (Dashboard name , logged date).

How to create blocks ?

Add New : allows you to create new block.

Chart Types

Chart Type property :

  1. Pivot
    • Select Pivot if a comparative analysis or trending of data needs to be made.
    • Similar to Pivot Charts of MS Excel.
    • 5 types of pivot charts are there → Pivot Table , Bar Chart , Pie Chart , Horizontal Bar Chart , Donut Chart.
    • Select a default pivot chart. The end user will be able to switch between the charts.
    • Simple Mathematical operations can be performed for pivot charts.
    • Test Case : Average coupons redeemed per coupon category.
  2. Grid List
    • Select Grid List if data needs to be fetched in the form of a list.
    • Test Case : Last 5 logged in users , List of Active Users.
  3. Detail View
    • Select Detail View if record specific details needs to be displayed.
    • You can design your own Detail View using the HTML layout option. Do your own HTML coding!
    • Test Case : Latest health vitals of a patient , Current room details of a patient.

Every chart type has 3 different blocks. Table Fields , Chart Settings (Listing fields), Field specific settings.

  1. Table fields
    • Displays the list of fields of the main table and the relation tables (if any) of the associated module.
    • The fields from here need to be dragged and dropped to “Listing Fields” for settings.
  2. Chart Settings (Listing Fields)
    • Set Listing fields , apply Where condition , Grouping fields , Order by fields.
  3. Specific field wise property settings

Now, We will see chart settings for all 3 types below

Chart Settings for Grid List/Detail View

GRID LIST

DETAIL VIEW

For Grid List and Detail View, the chart settings will have the following sections :

  1. Listing Fields : Drag and drop the fields to be displayed in the list
  2. Where Condition : Apply any extra condition if required. The format to be followed for where condition would be,
    • Single Condition : table_alias.eStatus = 'Active'
    • Multiple Conditions : table_alias.eStatus = 'Active' AND table_alias.dRegDate >= '2012-10-10'
    • Request Parameter : table_alias.eStatus = '{%REQUEST.status%}'
    • Server Parameter : table_alias.vIP = '{%SERVER.REMOTE_ADDR%}'
      Example : REMOTE_ADDR, HTTP_HOST
    • Session Parameter : table_alias.eStatus = '{%SESSION.eStatus%}'
      Example : iAdminId, vName, vUserName, vEmail, iGroupId, vGroupCode, vGroupName, eStatus
    • System Parameter : table_alias.vName = '{%SYSTEM.COMPANY_NAME%}' Example : COMPANY_ADDRESS, COMPANY_NAME, COPYRIGHTED_TEXT, IMAGE_EXTENSION

      Note : don't specify the below values as request parameters "file","iModuleId","parModule","parData", "filters","fields","sidx","sord", "export_type","page","rowlimit".

  3. Grouping Fields :Drag and drop the fields on the basis of which field, the list / view needs to be grouped.
  4. Order By Fields : Drag and drop the fields on the basis of which the list needs to be ordered and select the order type ie, whether ascending or descending.
  5. Hide Paging / Latest : Applicable for Grid List only and not for Detail View. If you wish to display only a specific no of records in the list and not all the records, check the Hide Paging box. Then, specify, the no of record you wish to display in the list. For example : Latest 5 Appointments, Latest 10 Coupons Redeemed

Chart Settings for Pivot  View

For Pivot Charts, the chart settings will have the following sections :

  1. Column Labels : Drag and drop the fields to be used as columns.
  2. Row Labels : Drag and drop the fields to be used as rows.
  3. Values : Drag and drop the field on which the mathematical operation needs to be performed.
    The mathematical operations available are
    • Sum
    • Count
    • Average
    • Max
    • Min.
    Along with it, also specify the column and row headers.
  4. Report Filter : Drag and drop the fields on the basis of which filtration can be done.
  5. Where Condition : Specify any extra condition if required. The format to be followed has be mentioned earlier.

Field wise Property Description for All Chart Types

  1. Display Name : The name as it appears in the Dashboard page in the Admin Panel. By default takes the name of the field, but can be changed
  2. Display in Query : A default format is set but can be changed. Also, SQL Functions like CONCAT, LOWER,UPPER can be can be specified
  3. SQL Function : SQL functions can be specified. For ex : The allowed format is DATE_FORMAT( %q% , '%Y-%m-%d') [%q% will be automatically replaced by the value specified in Display in Query]
  4. PHP Function : Extend the functionality by writing your own PHP functions. The property is Autocomplete and default PHP functions are populated in the list
  5. Width : Specify the width of the column
  6. Sorting : Allows sorting of the list on the basis of this field
  7. Edit Link : Quick links can be set so that user can be directly redirected to the corresponding page. Quick links can be for the same module or any other module or even custom links can be set
  8. Hide : Set a field to hidden if the field is to be used internally only
  9. Alignment : Set the alignment : left, right or center
  10. Display In : Select the preferred option : Grid (implies the field will be displayed in Grid List) or None (implies the field will be hidden)
  11. Image / File : Image / File type fields can also be displayed in the dashboard blocks.
    • Inline -> Check the box if record to be displayed as an image and not as a path File Server -> Local, Custom, Amazon
    • Folder Name -> Name of the folder in which the images to be stored. The name should be the same as mentioned in the Admin module settings
    • Folder (ID Wise) -> Select the field on the basis of whose ID the images are to be stored Image Width / Height → The size of the image to be displayed (By default 50x50)

After adding/ saving block , you will see below screen with created blocks.

We  have created 3 differents blocks for 3 different types of charts.

  • Add Block : Create new blocks.
  • Dashboard Pages : View /Add Dashboard Pages.
  • Save Sequence : Saves the current order in which all the blocks have been arranged.
  • Update Code : Download the code for Dashboard Configuration.
  • Download Code :The individual blocks can be dragged and dropped to any position.

Note :Remember to click on “Save Sequence” after changing the order, else the changes will not be reflected.

Now, block is created , we will create “Dashboard Page” now. Click on “Dashboard Pages → Add dashboard page”.

See below screen for adding dashboard page,

Screen after associating block with dashboard page,

Now, Dashboard page is ready to use. You can use this dashboard page in module OR you can add it in navigation menu also.

How to associate dashboard page with module?

While adding new module / editing exist module, you will see below options to add dashboard page in module.

At admin side , in edit page of specific module section.

How to associate dashboard page in Menu navigation?

Just Go to Menu management and add menu.

Now, you can see “Dashboard” in navigation menu. Just click on that, you will see dashboard page that we have created.