Skip to content
English
  • There are no suggestions because the search field is empty.

Custom Report Builder: Overview & Setup

The TMS custom report builder offers users flexibility in data analysis. By providing access to a wide array of data points, users can create customized reports tailored to their specific needs.

Related articles

How to access it

Navigate to Back Office → Reports → Custom Reports.

Report list

The main Custom Reports page shows all saved reports. Use the search fields to filter the list:

  • Name — partial match on report name
  • Report Type — filter by data type (Shipment, Customer, Carrier, Report)
  • Report For — filter by the organization or user the report is assigned to
Column Description
Name Clickable link to open the report editor.
Link The report's unique code (GUID); click to copy the shareable link to clipboard.
Report Type The data category the report is built on.
Report For The organization or user the report is assigned to.
Last Modified Date of the most recent change.

Row actions available from the list:

Icon Action
✏️ Edit Open the report in edit mode.
📋 View Run and view the report output.
🔗 Copy Link Copy the shareable link to clipboard.
📄 Duplicate Create a copy of the report.
🗑️ Delete Permanently delete the report.

Click Add New Report in the top-right corner to start building a new report.

Report types

Type Description
Shipment Shipment-level data including pricing, carriers, dates, stops, invoices, bills, and more.
Carrier Carrier profile data including contact info, scorecard, and shipping activity.
Customer Customer company data including contacts, addresses, margins, and AR aging.
Report Pre-built standard reports filtered to specific accounting or operational views.

Creating a report

Click Add New Report. The editor opens with a settings card at the top and the column builder below.

Field Description
Name Required. The label shown in the report list.
Anyone in my organization can edit When checked, all users in your organization can edit this report.
Who is this report for? Me, Organization (select a customer company), or Staff (select a specific user).

After saving, the report info card also shows: Delivery Schedule, Author, Last Modified, and Report Code (the report's unique GUID, used for sharing).

Building columns

The column builder has two panels:

  • Left panel — tree of all available columns organized by category. Click a category to expand it, then click any column name to add it. Use the search box to find columns by name.
  • Right panel — the columns you have selected, in the order they will appear in the report output.

Settings available per column in the right panel:

Setting Description
Column Name System field name (read-only).
Header Name Custom label for the exported column. Click to edit; click ✕ to revert to the default.
Precision For date/time fields — controls granularity (Year, Month, Day, Hour, etc.).
Format For date/time fields — customize date and/or time display format.
Filter Restrict output to rows matching a condition.
Sort Order Numeric priority (1 = primary sort).
Sort Direction Ascending or Descending.

Drag the handle to reorder columns. The order in this table matches the column order in the export.



Date columns can be added more than once — useful for showing a date at both Month and full Date precision in the same report.

Filters

Each column can have a filter to limit which rows appear in the output. At least one date column with a filter is required on every report. If none is configured, the system automatically adds Created Date & Time as the default.

Data type Available filter options
Text Equals, Contains, Starts With, Ends With, Does Not Contain, Between
Number Equals, Greater Than, Less Than, Between
Date Relative ranges (Last 7 Days, Last 30 Days, This Month, etc.) or custom Start/End date range
Status / List Multi-select from available values for that field

If the same date column appears more than once in the report, filter and sort can only be configured on one instance. The other displays: "Filtering and sorting are configured on another instance of this field."

Saving and viewing

Button Action
Save Saves the report and stays in the editor.
Save & View Saves and immediately opens the report output.
Cancel Discards changes and returns to the list.

Delivery schedules

Delivery schedules automatically send the report output to an email address or FTP/SFTP location on a recurring basis. This option becomes available after the report has been saved at least once.

On the report editor, click the ✏️ icon next to Delivery Schedule to open the schedule manager. A report can have multiple delivery schedules.

Field Options / Notes
Frequency Weekly or Monthly
Deliver On Weekly: select one or more days. Monthly: select the day of the month.
Time of Day Time the report runs.
Time Zone Time zone for the delivery time.
Export Format CSV, HTML, JSON, Excel
Status Active or Inactive.
Delivery Method Email or FTP/SFTP.

Email delivery fields

Field Description
Recipient Emails One or more addresses (comma-separated).
Subject Email subject line.
Body Email body text.

FTP / SFTP delivery fields

Field Description
Host Server IP or hostname.
Path File path on the server.
Port Connection port.
Username Login credential.
Password Password credential.

Sharing a report

Each saved report has a Report Code (GUID). Click it or the 🔗 icon from the list to copy a shareable link to your clipboard. Anyone with access to the TMS can use that link to view the report output directly. The available formats are HTML, CSV, Excel and JSON.

To invalidate previously shared links and generate a new code, click the refresh icon next to the Report Code field on the report editor.

Duplicating a report

Click the 📄 icon on any report in the list. The copy opens in edit mode with all the same columns and filters. Give it a new name and save.

Tips

  • At least one date filter is required. If none is added, Created Date & Time is added automatically with a default range.
  • Header Names are optional but useful when you want the export label to differ from the system field name.
  • Delivery schedules are not available until after the first save.
  • The same date column can be added more than once — useful for showing a date at both Month and full Date precision in th