IMS Documentation

User-Defined Reports

User-Defined Reports are reports created through the IMS Custom Reports module and made available to authorized users. The report definition controls which columns, formats, calculations, grouping and sorting are used; the User-Defined Reports screen is where users select and run those reports.

Report sourceCustom Reports are built on Custom Views. The underlying base database view is created and maintained by the database administrator first, then registered in Tools → Custom Views.
Open the reportReports → User-Defined Reports
IMS Reports menu with User-Defined Reports selected
Path: Reports → User-Defined Reports.

How User-Defined Reports fit into IMS

The feature is split into three parts:

1 · Define

Custom Reports

Administrators or authorized users build reusable report definitions from approved IMS Custom Views.

2 · Run

User-Defined Reports

Authorized users select an available report, apply the supported basic criteria and generate the result.

3 · Automate

Reporting Scheduler

Custom reports can be scheduled for automatic delivery, including email delivery or copying report output to FTP.

IMS Tools menu showing Custom Views, Custom Reports and Reporting Scheduler
The report definitions and scheduling tools are under Tools → Custom Views / Custom Reports / Reporting Scheduler.
More documentation comingThis page covers running User-Defined Reports. The Custom Views, Custom Reports and Reporting Scheduler pages will document how report definitions and scheduled delivery are configured.

Which reports can a user see?

IMS shows active custom reports that are assigned to the logged-in user or marked for all users. If no report is available, IMS tells the user that a custom report must be created first.

When a report is selected, IMS shows its Created By user, Creation Date and report Description.

Available criteria depend on the report

Unlike fixed IMS reports, a User-Defined Report does not always use the same criteria. IMS checks the underlying Custom View and automatically enables only the basic filters supported by that report:

Basic fieldWhen it is available
SuppliersEnabled when the Custom View exposes a Supplier ID field.
StoreEnabled when the Custom View exposes a Store ID field.
Date From / ToEnabled when the Custom View exposes a transaction-date field.

If one of these fields is not supported by the selected report, IMS disables that criterion automatically.

Using IMS multi-selection fields

Some IMS criteria fields open a compact multi-selection list instead of a normal drop-down. You can select several values without holding Ctrl.

  1. Click the criteria field to open the selection list.
  2. Click an item to select or deselect it. Continue clicking until the required combination is selected.
  3. Click Close, double-click an item, or click outside the list to apply the selection.
Field displayMeaning
AllAll available values are included.
One nameExactly one value is selected.
Multi SelectedTwo or more values are selected.
No Ctrl key requiredThe IMS list uses simple multi-selection: click each required item to toggle it on or off.

Generate a User-Defined Report

  1. Select the required report from the Report list.
  2. Read the report description to confirm that you selected the intended report.
  3. If available, select one or more Suppliers.
  4. If available, select one or more Stores.
  5. If available, set the Date From and To range.
  6. Click Generate.
  7. Review the result grid.

While the report is running, the button changes to Cancel. Click it to stop the current report request.

What controls the report columns?

The columns are not hard-coded into the User-Defined Reports screen. They come from the selected Custom Report definition. A report can define:

DefinitionEffect in the generated report
FieldsControls which data columns appear.
HeaderControls the column caption shown to users.
FunctionCan apply supported aggregation such as a configured report function instead of returning the raw field.
Group ByControls how report data is consolidated.
Order ByControls the default row order.
Custom FormatControls how numbers, currency, percentages and dates are displayed.
Supplier / Store attributesAllows configured custom attributes to appear with report data when the selected Custom View supports the corresponding supplier or store field.

Automatic formatting

IMS applies the format saved with the Custom Report. Numeric values, local currency, percentages, dates and times are displayed according to the report definition and the user's IMS formatting settings.

Duplicate source fieldsA custom report can include the same source field more than once. IMS keeps each requested column as a separate report column so different functions, headers or formats can be used.

Export, email and Save As

ActionBehavior
Export To ExcelExports the generated User-Defined Report to Excel, preserving text-column handling based on the report's configured formats.
Send By EmailSends the generated report by email. The email subject uses the custom report name and, when applicable, the selected date range.
Save AsSaves the generated report. Generate the report first.

Scheduled User-Defined Reports

A Custom Report can also be used by Tools → Reporting Scheduler. This allows recurring report jobs to run without a user manually opening the User-Defined Reports screen.

The Reporting Scheduler can be used to distribute custom-report output automatically, including:

Email

Scheduled email delivery

Generate and send a configured report automatically according to its schedule.

FTP

Scheduled FTP copy

Generate the report and copy the resulting file to the configured FTP destination.

Report definitions are created and maintained through Tools → Custom Reports. Scheduled delivery and destination settings, including FTP where configured, are managed through Tools → Reporting Scheduler.

Permissions

User-Defined Reports respect IMS report assignment and user permissions. A user sees only active reports assigned to that user or reports made available to all users. Export To Excel and Send By Email also follow the user's IMS access policy.

Common uses

Management

Reusable management reports

Create a report once in Custom Reports and make it available to selected IMS users.

Operations

Store or supplier reporting

Use Custom Views that expose Store ID or Supplier ID so users can apply those filters when running the report.

Automation

Recurring distribution

Use Reporting Scheduler when a report must be sent repeatedly or copied to an FTP destination.

Integration

Purpose-built datasets

Use Custom Views and Custom Reports to expose approved IMS data in a repeatable format without adding another fixed report screen.

Supplier master data and Custom Attributes

When a Custom View exposes supplier information, User-Defined Reports can use supplier criteria from Manage → Suppliers. Supplier Custom Attributes maintained there can also be included by a Custom Report definition when the underlying Custom View supports supplier attributes.