Custom Reports Editor

There is a specials Custom Report Editor with which you can  edit (create / build) your own Custom Report.

Opening the Custom Report Editor

To create a new report:

• Open the Custom reports Main Menu.

• Select Reports from the drop down.

• Click +.

• Then follow the instructions below to create your report.

To edit an existing report:

• Find the applicable report in the list.

• Click the Edit button.

Note

Custom Reports owned by the CSA User are considered System Reports and cannot be edited by users without the CSA Role.

If you are a user without the CSA Role and want to edit a System Report, select the report from the Grid List and select Copy to create a new copy of the report.

General Section (top)

The top part of the Editor form is reserved for general information about the report, like the Report Name. The below fields can all be recorded for your report.   

• Report Name - You always need to enter the name of your report (this is mandatory). 

• Report Description - Use this to describe the report and its intended usage.

• Folder Name - You can select a folder where your report will be stored in.

• Private - When marked as private only the user that created it and Corp Adm can access it.

• Title - The title usually appears in the report header or footer.

• Subtitle - The subtitle also usually appears in the report header or footer.

Report Editor - Sections Menu & Canvas

Below the general section you will find the actual Custom Report Editor. This is used for putting the report together. On the left hand side there is a menu with Report Sections. The right hand side is the report canvas, which is used for creating / editing the actual report out of the available Report Sections.

There are two buttons to control the main section. The trash bin button removes all Sections from the main Section, while the other button expands and shows the sub-Section frame.

Deleting All Sections

Click the trash bin button to remove all Sections from the main Section.

Showing Sub-Sections

Click the sub-Section button to show / hide the sub-Sections.

Adding Sections

There are two ways to add Sections to the report:

1. Drag the Section from the list on the left, to the report canvas on the right (see below); or

2. Select the appropriate frame to which the Section should be added. Then double click on the desired Section (see below). Adding Sections by double clicking. 

Adding Titles to Sections

Multipurpose Title Sections can be used for adding extra titles if needed for structural purposes. But in most cases you can just use the H button to add a title to any Section (and choose a style for it).  

Line/Page Break Sections

The Line/Page Break Section is also a multipurpose Section. When used as a line Section, it leaves one line space between Sections. Often this is used together with the break option in the Section's toolbar. Enabling the break option on any Section adds a page break after that Section. However, by default IMS will not show Sections without data, and most of the time data cannot be guaranteed for a Section. A safer option is thus to use the Line/Page Break Section, as this will always ensure a page break when needed.

Example: If we want every Equipment to start on a new page, we would use the section as shown below:

Wrapper Sections

Wrapper Sections makes it easy to add Sections, like Attachments, that require an Id field from a parent Section.

Example: If we want to show Attachments from all Corrosion Loops for a FLOC we would use the Corrosion Loop Wrapper with the Attachment List Section, on a Floc level like this:

Hiding Sections

The Hide button (the eye icon) can be used to hide a Sections from the report, while still keeping it available it for future use.

Ordering Section Fields

Sections that have the Order by option enabled can be ordered by one or more fields (ascending or descending) via the Order by button in the Section's toolbar.

Deleting Single Sections

A single Section can also be deleted.

Front Page and TOC Sections

There are different kinds of special Sections for representing different data. Two of the more commonly used are Frontpage and Table of Content. Below we show how to add these:

Section Hierarchy Organization

When creating a report you need to keep in mind what your report structure should be, i.e., what Sections should be included and what the relationship between them are.

For example, if your report should contain Floc General Info, Equipment Details, a Schedule List, the ECH details, an ECH Credited Schedule List and the ECH Created Schedules List Sections, then if you set your Equipment Details Section to be under the Floc General Info section, then when u generate the report from Unit level, you will get the report with each FLOC from the selected Unit containing all its Equipment, while if you put them on the same level, you will first get all the FLOCSs on the unit and then all the Equipment from all the FLOCs on the Unit .

If we add the rest of the Sections, and we keep in mind that Schedules and ECHs are both linked directly to Equipment, then we realize we should add them both on the same level under Equipment Details, and since we want to see specifically the Schedules Credited and Created per ECH, we need to put the ECH Credited Schedule List and ECH Created Schedules List Sections on the same level under the ECH Details Section. This way we will produce a report with every FLOC having only its own Equipment with each Equipment containing a list of its Schedules followed by each ECH on the Equipment with only the Schedules credited and created by that ECH.