Custom Reports

Overview

Note

This page explains Custom Reports only. The other reporting modules below have their own pages.

Multiple Reporting modules exist in BOS Enterprise.

Module Description
Custom Reports
  • You can draft your own reports using SQL.
  • You have access to the data that is stored in your Database.
  • Custom reports can be added to Menu Groups by clicking the Report radio button and selecting one or more of the reports from the list of custom reports.
Inventory
  • Multiple inventory reports are available under the heading Inventory.
  • Once added, the various reports can be accessed from the Menu button.
  • Inventory reports can be added to Menu Groups by clicking the Fixed radio button and selecting Inventory from the dropdown list.
Cost of Sales
  • Summarises Sales Order and Work Order transactions and displays the profit and margins for each transaction.
  • This report can be added to Menu Groups by clicking the Fixed radio button and selecting Cost of Sales from the dropdown list.
AccountingFinancial Statements are available and can be added to Menu Groups by clicking the Fixed radio button and selecting Accounting from the dropdown list.

Settings

Navigation Example

Main Menu > Setup > Settings > General (tab)

Setting Description Default
Reports > Reports: Show company name in headerCheckbox. If checked, your company name is printed in the header of printed data grids, pivot grids and charts, and of charts printed from the Summary.Unchecked

Custom Reports

Info

Certain custom reports are included with BOS Enterprise. For example:

  1. Customer Summary which is similar to the age analysis but includes a Pivot Grid. Customers can be Activated or Suspended using Actions (button). The Menu button provides options to Edit the report and its presentation.
  2. Item QR Codes provides a list of items and Output (button) to print or preview QR Codes to use with the Tracker App. The codes can be printed on label paper and affixed to the items or shelves. The Menu button provides options to Edit the report and its presentation.

Custom Reports: List View

Navigation Example

Main Menu > Reports > Custom Reports

Buttons Explained

Button Description
ViewGenerates the report selected from the dropdown list.
OutputProvides output features if the report includes templates.
ActionsProvides actions if they are included with the report. For example, the Customer Summary includes features to Activate or Suspend the customer.
Menu
  • Reset Data Filter: Resets the report's data filters if any were included.
  • Data Grid Options >
    • Date grouping: Select a grouping option from the dropdown list (e.g. by Date).
    • Automatic Row Height (toggle).
    • Column Auto Width (toggle).
  • Pivot Grid Options:
    • Active if the Pivot tab is open.
    • Select a grouping option from the dropdown list (e.g. by Date).
  • Print Data Grid: Prints the data grid.
  • Print Pivot Grid: Prints the pivot grid.
  • Print Chart: Prints the chart.
  • Email PDF: Creates an email with the report attached in .pdf format. The email is placed in the Outbox.
  • Email Excel: Creates an email with the report attached in Excel format. The email is placed in the Outbox.
  • Email CSV: Creates an email with the report attached in .csv format. The email is placed in the Outbox.
  • Export Data Grid: Exports the report in Excel format. Select a save location.
  • Export Pivot Grid: Exports the pivot grid in Excel format. Select a save location.
  • Edit Reports: Switches to the interface from which custom reports are created.
  • Layout & Grid
iProvides detailed information about the custom report if such information was included in the report. The button turns blue when there is information, else it is greyed out.

Edit Reports: List View

Navigation Example

Main Menu > Reports > Custom Reports > Menu (button) > Edit Reports

Buttons Explained

Button Description
ViewDisplays a list of custom reports.
NewCreates a custom report.
LoadLoads an external report (.qer) into BOS Enterprise.

Fields Explained

Field Description
IDThe system-generated number for the report.
ReportThe name of the report.
CodeThe report's short name or code.
Template/sThe number of linked templates.
Email/sThe number of times the report was emailed.
TransactionThe drilldown field selected for transactions.
Customer SummaryThe drilldown field selected for customers.
Supplier SummaryThe drilldown field selected for suppliers.
Item SummaryThe drilldown field selected for items.
Account SummaryThe drilldown field selected for ledger accounts.
WorkflowThe drilldown field selected for workflow.
FilenameThe drilldown field selected for the filename.
Auto RefreshEnter a value in minutes for how often to refresh the report to include changes made since the report was opened.
  • Used while the report is open (e.g. if a report is opened on a second monitor and left open).
  • Reports that are not open, are not refreshed.
Menu (...)A submenu with the following functions:
  • View/Edit User Access
  • Save to File
  • Edit Report
  • Copy Report
  • Delete Report

Edit Reports: Edit View

Buttons Explained

Button Description
ArrowsScrolls through the custom reports.
Edit SQLOpens an interface to write the report using SQL.
DeleteDeletes the custom report.
NewCreates a custom report.
SaveSaves any changes.

Header Explained

Field Description
NameEnter a name for the report.
DescriptionEnter a description of the report.
CodeEnter a short name for the report.
Settings
  • Column Auto Width: A checkbox. If checked, the column widths are automatically adjusted.
  • Auto Refresh (min): Enter the number of minutes after which the report refreshes. Only applies if the report is being viewed.
DrilldownThe drilldown fields (listed below) let you select the ID for the respective modules linked to the drilldown function selected on the Fields tab.
  • Transaction
  • Customer
  • Supplier
  • Item
  • Detailed Ledger
  • Workflow
  • Filename

Fields Tab Explained

Info

This tab is populated by the field names selected by the SQL query.

Fields can be cleared using the backspace key on the keyboard.

Fields marked in blue (✎) can be edited.

Field Description
Field Chooser (*)Add or remove columns.
Field NameThe name of the selected data field.
Data TypeThe type of data field (e.g. Text, Integer).
CaptionThe caption for the data field. This caption becomes the column header.
EditorThe type of editor function.
AlignmentThe alignment of the field on the report.
SummaryAny options for a summary field.
DecimalsThe number of decimals to include.
VisibleA checkbox. If checked, the field is visible.
Pivot GridYou may select one of these options for the pivot grid:
  • Filter
  • Data
  • Row
  • Column
Colour (Fieldname)
  • If a field is colour-coded based on certain criteria (similar to conditional formatting in Excel), you may select which data field is used for the calculation in this column.
  • Usually, the background is coloured, not the text.
Search (Fieldname)A dropdown list of the data fields to select which one is used for search.
DrilldownDrills down to a different module. This column provides a dropdown list of the available modules.
Drilldown (Fieldname)The name of the data field linked to the drilldown. The field should contain the ID for the drilldown (e.g. TRANSID for transactions, CUSID for customers).
Caption (Fieldname)Create a custom caption for the fieldname which is used as a column heading. This feature is ideal for reports where columns represent different periods based on the current date.

Actions Tab Explained

Info

Actions are optional and are inserted as context menu (right-click) options for the report and / or under the Actions button.

Fields marked in blue (✎) can be edited.

Field Description
IDThe system-generated number for the action.
DescriptionThe action's description.
Confirmation
NoteAny note about the action.
Menu (...)
  • Edit SQL: Opens the SQL editor to create SQL for the action.
  • Copy Action: Copies the action to create an action.
  • Delete Action: Deletes the action.

Output Tab Explained

Info

Output lets you link a template to print, preview or email the report. Output is not required for reports that are only viewed on screen.

Fields marked in blue (✎) can be edited.

Field Description
Field Chooser (*)Add or remove columns.
IDThe system-generated number for the entry.
NameThe name that should appear under the Output button.
TypeOption to select an Output type from this list:
  • Template (PDF & HTML Email body).
  • Email (HTML body & Attachment/s).
  • Plain Text.
  • The name of the report is also inserted as a Type option.
OutputOption to select a type of Output from this list:
  • Print Only
  • Email Only
  • Print & Email
Attachment NameThe name of the attached file.
TemplateChecked once a template is added. Templates are added by right-clicking the line item and selecting Load Reportbuilder (.rtm) file.
HTMLChecked once HTML is added. HTML is added by right-clicking the line item and selecting Edit HTML.
Menu (...)A submenu with the following options:
  • Load Reportbuilder (.rtm) file: Loads a Reportbuilder file (template created using Form Designer).
  • Edit HTML: Edits the HTML that is used for output. When Use WYSIWYG HTML Editor is checked, you can edit it on the Editor tab the way it will look to the recipient.
  • Edit Email Subject: Create a custom Email Subject.
  • View/Edit User Access: Sets user access for the output.
  • Delete: Deletes the action.

Report an issue with this page

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