Reporter

The Reporter tool provides a detailed report of data in the eCandidus™ Server

A report is built by dragging field definitions from any object being viewed into the reporter screen. For each field used you can set the following options:

The options are displayed by selecting on a cell and then right-clicking on the cell.

OptionSubMeaning
Title Edit the column title.
Definition Edit the field definition.
Hidden Hide the column in the actual report.
SortNoneNo sort.
 A to ZSort ascending.
 Z to ASort descending.
If Set the selection criteria.
Calc Values... Displays a list of calculated fields.
Break On Generates a subtotal break for each entry.
Sum Subtotal column.
Delete Remove the column from the report.

 

Editing the column title

When you select Title from option menu, you are asked to enter the new title:

Note that if you enter a title that is in use by another column, the system will automatically rename the column by adding an instance number.

The default column name uses the label for the field, plus the internal names of the fields that you double-click on to get to the field.

 

Editing the column definition

The field definition is the merge code to use to get the information.

Just like any other merge code, you can use merge code options to format the field. For instance if you wanted to display the applicant column in a sortable format, you could change the coumn definition as follows:

Adding the option code...

which changes the column to:

 

Hiding columns

You can hide/show columns by selecting the Hide option. Hidden columns do not display when the report is run after being defined. Columns always show while in definition mode.

Hiding columns is useful when you want to create reports that are limited to a subset of the work product (i.e. all Worker Comp cases that are active) but do not wish to display the columns.

 

Sorting columns

You can sort the report by one column. Simply select the type of sort A to Z (ascending) or Z to A (descending). Note that the column is sorted alphabetical unless it is a numeric or date column.

 

Selecting the data to include in the report

You can select which data is to be included in the rport by using the If option. The screen displayed differs according to the type of data contained in the column.

We will use this sample to illustrate the selection options:

Alphabetic

Alphabetic columns display the following options for the selection criteria:

The default is None, which we will change to Like and enter Workers to select the Workers Comp cases.

Note that once we clicked on the like option, an input area opened up for us to enter the criteria. We also have the option to have the system ask us for the criteria at run time by clicking on the Ask check box.

We will now repeat the selection using the Status field to select the Active cases:

This produces the selection that we will need to show grouping and totaling later on:

Numeric

Numeric columns display the following options for the selection criteria:

Numeric options differ from alphabetic ones in two wyas. There is no Like option and the labels used are appropriate for the type.

Shown in the Between option which, just as the alphabetic counterpart, asks for the starting and ending values.

Date

Date columns display the following options for the selection criteria:

Date selection is different for the others in that you can select in one of three modes:

  • Day - Selects a specific date
  • Month - Selects an entire month (this is the default)
  • Year - Selects an entire year

You also have an extra option, the Span which gives you a date range based on the date that the report runs on:

The span option displays the date range wanted. It can be as simple as a single day, as shown above, to a date range to a date offset:

Which results in the selection of two months worth of data, starting on the same day last year.

 

Calculations

You can create columns that are derived from other columns to compute it's value. Here we see a simple report that displays the plaintiff's age:

Let's add a new numeric column:

A column named Untitled is added:

Now lets set the age field to be a data source:

Note the @=val1 added to the end of the definition.

This tells the system to store the age as val1. Now Lets set the definition of the new column:

This tells the system to take val1 and multiply it by 1.8 and display the result:

You can use any number of variables in your calculated column, aswell as formatting options. For example to compute the percent of column val1 to column val2 you could use the definition of:

[#val1/val2@fp]

Or to get the average of three values you could use:

[#(x1+x2+x3)/3]

 

Grouping rows

You can group data rows by using the Break On option:

This is the result of applying the Break On on the Ins Co field.

This option is usually used in conjunction with the Sort option, which is set to A to Z to produce the following:

Note how the data is grouped by the value in the column, which must match exactly for it to be grouped. In this case, there is a mispelling in the word State and a missing period in the first SCIF entry.

 

Creating totals

The Sum option, along with the Break On option allows you to display totals for each group in the report:

This is the resultant report, where the Type and Status columns have been hidden and the Due column was set to Sum.

Note the two extra "columns headers" 1 and *. The first displays only the total lines, and the second displays all of the detail lines. You can also manually open and close by clicking on the + sign in any total line.

 

Filters

You can also select using the Filter line. The only limitation is that you are not allowed to enter a filter for a column that is also flagged as hidden.

The difference between If and Filter selection is that If selections are only allowed for those fields where the Quick Find option has been enabled, and Filter selection can be done in any field (except hidden fields). The advantage of the If selection is that it is done before any data is read and makes the report generation faster. Filter selections require the data to be read in before being selected.

Note that in either case, further filtering is available once the report is generated.

 

Commands

The following commands are available in the reporter:

ComamndMeaning
PrintPrint the report.
Print ScreenPrint the screen.
ExportExports the report in a variety of formats.
Clear fieldsRemoves all of the fields from the report (only in definition mode).
Partial databaseCancels the current rebuild and displays the first 25 rows of the report.
Entire databaseDisplays the entire selection.
WindowsControls the window size.
CancelCancels the report.
SaveSaves the report definition (only in definition mode).