Edit Reports List and Edit Views

Custom reports are created and edited with SQL in Edit Reports, on the Setup menu, and viewed in Custom Reports. This page explains the Edit Reports list view and edit view: the buttons, the header, the Fields tab, and the filters and drilldown sections.

List View

Buttons Explained

Edit Reports List View, listing the custom reports
Edit (Custom) Reports List View
Button Description
ViewDisplays a list of reports.
NewCreates a custom report.
MenuLayout

Fields Explained

Field Description
Field Chooser (*)Add or remove columns.
IDThe system-generated number allocated to the entry.
DescriptionThe name of the report.
CodeThe abbreviated name of the report.
Chart TypeThe chart that the mobile app can show.
NoteAny note for the report.
CreatedThe date on which the entry was created.
UpdatedThe date on which the entry was last updated.
Updated ByThe user who last updated the entry.
Widget

A submenu with these options:

  • Edit Report: Lets you make changes to the report.
  • Edit User Access: Sets the user access for the report.
  • Copy Report: Copies the report, with its SQL, fields, filters, drilldowns and user access. The copy has the same description with “- Copy” added at the end, and opens for editing.
  • Delete Report Ctrl + Delete: Deletes the report.

Edit Views

Edit Reports Edit View, showing a custom report’s header and Fields tab
Edit (Custom) Reports Edit View

Buttons Explained

Button Description
ArrowsNavigates to the next or previous entry.
EditAllows the entry to be edited.
NewCreates a custom report.
SaveSaves any changes.
Actions
  • Edit SQL: Opens an SQL interface for editing.
  • Copy Report: Copies the report that is open on screen and opens the copy for editing.
  • Delete Report: Deletes the report that is open on screen.
Menu

Settings

Layout


Header Explained

Field Description
DescriptionEnter a description (name) for the report.
CodeEnter a brief description for the report.
Chart Type

Select a chart type from this list:

  • Area diagram
  • Bar diagram
  • Column diagram
  • Line diagram
  • Pie diagram
  • Stacked Area diagram
  • Stacked Bars diagram
  • Stacked Columns diagram
NoteEnter a note (optional).

Fields (tab)

Info
  • The fields are automatically generated based on the report’s SQL query.
  • Fields marked in blue (✎) can be edited.

Fields Explained

Field Description
Field Chooser (*)Add or remove columns.
IDThe system-generated number allocated to the entry.
NameThe field’s name from the SQL query.
Data TypeThe type of data (e.g. text, numerical, date).
Caption

The field’s name in the database.

You can change it to a more descriptive label.

Editor

The type of data in the database.

A different option can be selected from this list:

  • Text
  • Formatted Text
  • Number
  • Memo
  • Date
  • Time
Alignment

Choose the text alignment from this list:

  • Left
  • Right
  • Centre
Summary

Choose a calculation option from this list:

  • None
  • Sum
  • Count
  • Average
  • Min
  • Max
Visible

Checkbox. If checked, the field is visible in the report.

Should be checked for fields that contain the data shown in the report.

Should be unchecked for fields that contain the functions being used in other fields (e.g. custom captions or colour changes).

May be unchecked for fields that contain the database or entry ID.

DecimalsSets the number of decimal places for numerical fields.
Fieldname ColourA dropdown list of all the field names for you to choose which fields should have a colour filter applied.
Fieldname CaptionA dropdown list of all the field names, to select as captions for the fields.
CreatedThe date on which the entry was created.
UpdatedThe date on which the entry was last updated.
Updated ByThe user who last updated the entry.
Chart Category

Checkbox.

Check one entry that groups the data into categories (for example, Customer, Rep or Period). Each category is one bar, point or slice.

Chart Series

Checkbox.

Multiple entries can be checked. Each one is plotted as a series of values (for example, Amount).


Filters Section Explained

Info
  • The fields are automatically generated based on the report’s SQL query.
  • Filters refine the data shown under Fields.
  • Fields marked in blue (✎) can be edited.
Filters and Drilldown sections of a custom report in the Edit Reports Edit View
Edit (Custom) Reports: Filters & Drilldown

Field Description
Field Chooser (*)Add or remove columns.
IDThe system-generated number for the entry.
Type

The type of filter. The default is Fixed ID. The options are:

  • Date: Filters on a specific date.
  • Period (Date Start and Date End): Filters the records based on a period.
  • Text List: Creates a lookup list to filter the data on.
  • Key Value Pairs (Comma separated): Replaces a certain lookup field (as entered) with a different value (as entered).
  • SQL (Returns: filter_key, filter_value): Replaces a certain lookup field with a different value (as determined by an SQL query).
  • Fixed ID: Uses a fixed ID that you enter.

A report can have only one Date filter and one Period filter. If you add a second one, it is removed when you save, and the message “The selected Filter has already been added.” appears.

Information for the selected Type (e.g. Text List, SQL) can be entered in the respective columns or by accessing the context menu (right-click).

NameThe parameter name used in the SQL query.
CaptionThe displayed name of the filter.
CreatedThe date on which the entry was created.
UpdatedThe date on which the entry was last updated.
Updated ByThe user who last updated the entry.
Fixed IDThe value if Type = Fixed ID (e.g. the ID of the Transaction Type).
Value List

Checkbox.

Checked automatically once a key-value list is defined.

The key list is defined via the context menu.

SQL

Checkbox.

Checked automatically once the SQL query is written.

Use the context menu to open the SQL interface.

Widget

A submenu that changes depending on the type of entry. It contains one or more of these options:

  • View/Edit Lists: Creates lookup lists where the Type is Text List or Key Value Pair.
    • Text List: Enter a list, one entry per line.
    • Key Value Pair: Enter a comma-separated list, one pair per line (e.g. if you enter “1,Name”, the system assigns the integer 1 to fields that contain the word “Name”).
  • View/Edit SQL: Opens the same SQL interface as under Fields, to enter custom SQL where the Type is SQL. The SQL must generate two columns (that is, a key-value pair).
  • Delete Filter: Removes the filter.

Drilldown Section Explained

Info
  • The drilldown function is optional.
  • You can define actions that are available from the context menu (e.g. open the customer account).
  • You can include multiple drilldown options.
  • The available drilldown modules are:
    • Contact
    • Item
    • Asset
    • Service
    • Transaction
  • Fields marked in blue (✎) can be edited.
Field Description
Field Chooser (*)Add or remove columns.
IDThe system-generated number for the entry.
Type

Select a type from this list:

  • Module: Select a module to navigate to (as a context menu option on the report).
  • Attachment: Select a URL to navigate to (as a context menu option on the report).
Module

A dropdown list of the available modules:

  • Contact
  • Item
  • Asset
  • Service
  • Transaction

Applies if Type = Module.

Fieldname

Select a field name for the drilldown function from the list of all the field names.

The selected field name must be the primary key (ID) for that module.

Menu CaptionThe label that appears in the report’s context menu.
CreatedThe date on which the entry was created.
UpdatedThe date on which the entry was last updated.
Updated ByThe user who last updated the entry.
Widget

A submenu with this option:

  • Delete Drilldown: Deletes the drilldown entry.

Report an issue with this page

For more useful feedback, select the text on the page you are reporting on, then click Feedback again — or continue without selecting anything.