Configure Custom Reports

Authorised Users shall design custom reports in Asset Application.

This section describes how to design a Custom Report:

Path Settings icon on the Asset Dashboard --> 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: Enter Report Settings

   1. On the Report Settings tab, in the Report ID box type the name of the report.

   2. In the Date Format box, select the date format.

   3. In the Time Format box, select the relevant time format.

   4. Select the Currency Format and Time zone.

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 the data source.

   3. Select the Base Object. (e.g. If the report is on Assets, select Assets as the Base Object). A Base Object contains its related Fields. (e.g. If the Base Object is Assets, it will have its related fields such as Asset, Asset Category etc.)

   4. Click Add. You will see the new data source automatically added and selected in the Data Source box.

5. Select the required Fields

   1. Under Fields click the Select a field link. A window 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 Asset Category ID along with Asset Category ID Count, you need to add Asset Category ID field twice (Asset Category ID, Asset Category ID1) as the second field is used to calculate the Asset Category ID 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 preview the selected Data Source and its added Field, click button.

12. Filter Conditions

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

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

    3. Select the Filtering Field from the list. (e.g. Operational Status)

    4. Select the filtering condition from the given box. (e.g. Equals)

    5. A third field will appear based on the filtering condition you select. Then type the value which is required to satisfy your filter condition. (e.g. Operational Status Equals ‘Operational’)

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

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

15. Grouping

    1. Grouping the data in the report

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

    3. Click on the list box of the required field (e.g. AssetCategoryID1) and select the field’s property (e.g. Count) that you want to group by. e.g. Field: AssetCategoryID1 Group By: Count à This will show the count of each Asset Category.

16. Sorting

    1. Sorting the data in the report

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

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

17. Layout & Widget

    1. Specify Layout and Widget settings.

    2. Click the Layout and Widget tab.

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

       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. In the Report Layout list, select the layout of the report you want. (e.g. Simple Layout, Two widgets). Add a Widget link appears.

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

    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 on the widget 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 “Asset Category”, in the Section By list, select the field “Asset Category ID”. 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.

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

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

Move Widget

To move a widget, complete the following:

1. On the Layout & Widget tab, click the icon of the widget (e.g. widget in section 2) you want to move.

2. For example, to move the widget in the section 2 to section 1, click Move this widget to section 1 link.

Delete a Widget

Delete a 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.

Customise the Report View

Figure 3: Customising the report view- Layouts & Widget Tab

You can customise the report view by changing the properties in the design. Above 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 “Installed Date” field on the reports, change the format to Date. To display the Time along with the Date, select the Include Time check box.

Format of the Field	Description
Default	This shows the default value from the database.
Currency	Used to display report data in currency format
Integer	Used to display report data in integer format. This will help to calculate the Total of the integers in the same field.
Number	Used to display numbers even with decimals
Date	Used to display a Date in report. Selecting the Include Time check box will display the Time along with the Date
Custom	This can be customised by the user according to the requirements.

Editing Custom Format

• Click the respective box under Format column and select Custom. Note that #{row.<FieldName>} is the field name of the underlying Data Source of the software application frame work and 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: Asset ID Format: <Prefix>#{row.AssetID}<Suffix>

Figure 4: Editing Custom Format of the report

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

Tip– After doing the changes in the report layout and widget, preview the report to verify the outcome.

Figure 5: Preview of the report

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.

Tip– To view key details of the report created user, click their User ID corresponding to that report on the Custom Reports search page.