Configure Custom Reports

Authorised Users shall design custom reports in Organization Application.

This section describes how to design a Custom Report.

Path

Settings icon -> Configure section -> Custom Reports

Design a Custom Report

1. Click the Settings icon and select Custom Reports under Configure. Custom Reports search page will appear.

2. Click the Design New Report link. Report configuration page will appear with three tabs on it namely Report Settings, Data Sources and Layout & Widget.

3. Report Settings: Add necessary details under the Report Settings tab.

   Field

   Description

   Report ID

   Identification name of the report

   Date Format

   Format of the dates to be displayed on the report.

   Time Format

   Format of the time to be displayed on the report.

   Currency Format

   Format/ Type of the currency to be displayed on the report.

   Time Zone

   Time zone to be considered with the report generation.

4. Data Source: Configure Data Sources.

   1. To add a new Data Source, on the Data Source tab, click the Add icon . (Initially the Data Source box is empty).

   2. In the New Data Source window, in the Name box, type a name for data source.

   3. Select the Base Object. (E.g. If the report is on Member, select Member as the Base Object). A Base Object contains its related Fields. (E.g. If the Base Object is Member, it will have its related fields such as UserID, Name, DepartmentName etc.)

   4. Click Add. The new data source will be automatically added and selected in the Data Source box. Repeat 3 to add more data sources if necessary.

5. Fields: Select the required Fields:

   1. Under Fields click the Select a field link. A box with fields that can be added to the report will be displayed.

   2. Click on required fields to add.

   Note –

   Select a Field: The prefixes that appear in front of the fields denote the type of values accepted by the fields.

   e.g. T: Text

   N: Numeric D: Date/Time

   Depending on the report you want, you may need to add the same Field more than once. e.g. To show Department Name along with Member Count (under each Department), you need to add DepartmentName field twice (DepartmentName, DepartmentName1) as the second field is used to calculate the Count.

6. Repeat the step 5 to add more fields.

7. To edit an added field, click the respective icon and in the Enter a new alias box, enter the new name. Then click Ok.

8. To delete an added field, click the respective icon.

9. To take a copy of the selected Data Source, click button.

10. To delete the selected Data Source, click the button.

11. To delete an added field, click the respective icon.

12. To preview the selected Data Source and its added Fields with sample data, click button.

13. Filter Conditions: Add Filter Condition. (This is used to filter the records in the report using the field and filtering condition)

    1. Under Filter Conditions section, click the Add link.

    2. Select the Filtering Field from the list, e.g. Branch Name.

    3. Select the filtering condition from the given box, e.g. Exists.

    4. A third field will appear based on the filtering condition you select, e.g. Equals/ Greater Than. Then type the value which is required to satisfy your filter condition, e.g. BranchName Equals Singapore.

14. Repeat the step 13 to add more filter conditions.

15. To remove a filtering condition, click the respective icon.

16. Grouping: Grouping the data in the report

    1. To group the data, select the Group Data check box. All the fields will appear.

    2. Click on the list box of the required field (e.g. DepartmentName1) and select the field’s property (e.g. Count) that you want to group by. E.g. Field: DepartmentName1 Group By: Count à this will show the count of Staff Users under each Department.

17. Sorting: Sorting the data in the report

    1. To sort the data in the report, select the field that you want to sort by.

    2. If you want to sort the data in ascending order, select the Ascending check box.

18. Layout & Widget: Specify Layout and Widget settings.

    1. Click the Layout and Widget tab.

    2. In the Report Title box, type a relevant title for the report.

    3. In the Report Layout list, select the layout of the report you want. (E.g. Simple Layout, Two widgets). Add a Widget link appears. Note – Report Layouts Simple Layout: This can show only one type of widget (Table or Pie Chart or Bar Chart) in the report.

       Two -Widget Layout: This layout type can be used to display two types of widgets in the same report.

    4. Under the Section 1, click the Add a Widget link. A screen to add the new widget appears.

    5. In the Widget list, select the widget you want. (E.g. Bar chart, Pie Chart, Table).

    6. In the Data Source list, select the required data source for the selected widget.

    7. Click Add. Depending on the selected widget, modify the default values displayed as the widget data, if and as required.

    8. Select the Split into Sections check box to split the report into sections based on field selected on the Data Source.

    9. Modify the default values for the Section By and Section Name fields, if required. E.g. If you want to split the report into sections by “Branch Name”, in the Section By list, select the field “OrgBranchName”. In the Section Name box, type the name of the section you want to display on the report.

    Note: Split into Sections, Section By and Section Name functionalities are available only for Table widgets.

19. If you have selected ‘Two widgets’ as the Report Layout, repeat the steps 18-d - 18-i for a widget in the Section 2.

    (In Two-Widget Layout click icon under a section and click the Move this widget to Section 1/ Section 2 links to swap widgets between Section 1 and Section 2).

20. After specifying all the required settings, click Save to save the Report design configurations.

Delete a Widget

To delete the widget:

1. On the Layout & Widget tab, click the icon. Delete this widget link appears.

2. Click the Delete this widget link.

Preview Designed Report

To preview the designed report in the web browser with information, click the icon on top right corner.

Customise the Report View

You can customise the report view by changing the properties in the design. Illustration shows the report properties explained below.

Label: Label displays the name of the respective field in the report. You can edit the label accordingly.

Order: Click Up arrow once to move the respective field before the next field on top of it. Click the Down arrow once to move the respective field one field below. You can click the Up or Down arrow multiple times according to the place that you want to display the respective field on the report. This helps to arrange the order of the fields that appear on report. Show: To select the fields that you want to appear on report, select the respective check boxes under Show column.

Format: To change the format of the field, as you want, select the required format by clicking the respective list box. By default, it will show the default value.

E.g., to show Created Date Time field on the reports, change the format to Date. To display the Time along with the Date, select the Include Time check box.

Editing Custom Format

• Click the respective box under Format column and select Custom. #{row.<FieldName>} is the field name of the underlying Data Source of the software application frame work hence it should not be changed. However, you could add textual prefixes and suffixes which would be repeated along the data for each row.

E.g. Label: Address Format : <Prefix> #{row. Address} <Suffix>

Total: This is used to display the total of all the numeric values/numbers in a row that belong to a selected Field.

Above illustration shows the preview report of the Figure 3 Report design.

Edit Report Design

To edit a report that is already designed, complete the following:

1. Click the Settings icon and select Custom Reports under Configure. On the Custom Reports search page, reports that have been already designed will be displayed.

2. To view the report, click the Report name that you want. Your report will open in a new window.

3. Edit the Report

   1. On the Custom Reports search page, Click the Edit icon. Report configuration page will be opened.

   2. Do all the required configuration changes.

   3. Click Save.

Delete a Report

Delete an existing custom report as follows:

1. To delete an existing report, click the Settings icon and select Custom Reports under Configure.

2. Click the Report name that you want to delete.

3. Click the Edit icon . Report configuration page will be opened.

4. Click the Delete this Report link on the sidebar. A confirmation message displays. Click Delete to confirm deletion.