Custom Reports

Custom Reports

Two custom reports are included with BOS Enterprise: 

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.

Edit Reports: List View

Buttons Explained

• View: Displays a list of custom reports.

• New: Creates a new custom report.

• Load: Loads an external report (.qer) into BOS Enterprise.

Fields Explained

• ID: The system-generated number for the report.

• Report:  The name of the report.

• Code: The report's short name or code.

• Template/s:  The number of linked templates.

• Email/s: The number of times the report was emailed.

• Transaction: The drilldown field selected for Transactions.

• Customer Summary: The drilldown field selected for Customers.

• Supplier Summary: The drilldown field selected for Suppliers.

• Item Summary: The drilldown field selected for Items.

• Account Summary: The drilldown field selected for Ledger Accounts.

• Workflow: The drilldown field selected for Workflow.

• Filename: The drilldown field selected for the Filename.

• Auto Refresh: A field to type a value in minutes for how often the report should be refreshed to include changes made since the report was opened. 

  • Used when the report is displayed (e.g. if a report is opened on a second monitor and left open).

  • Reports that are not open, are not refreshed.

• Menu (...): A sub-menu with the following functions:

  • View/Edit User Access

  • Save to File

  • Edit Report

  • Copy Report

  • Delete Report

Edit Reports: Edit View

Buttons Explained

• Arrows: Scrolls through the custom reports.

• Edit SQL: Opens an interface to write the report using SQL.

• Delete: Deletes the custom report.

• New: Creates a new custom report.

• Save: Saves any changes.

Header Explained

• Name: A field to type a name for the report.

• Description: A field to describe the report.

• Code: A field to provide a short name for the report.

• Settings:

  • Column Auto Width: A checkbox. If checked the column widths are automatically adjusted.

  • Auto Refresh (min): A field to enter the number of minutes after which the report should be refreshed. Only applicable if the report is being viewed.

• Drilldown: The drilldown fields (listed below) allow users to 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

Tabs Explained: Fields

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

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

• Field Chooser (*): Allows users to add or remove columns.

• Field Name: The name of the selected data field.

• Data Type: The type of data field (e.g. Text, Integer).

• Caption: The caption for the data field. This caption becomes the column header.

• Editor: The type of editor function.

• Alignment: The alignment of the field on the report.

• Summary: Any options for a summary field.

• Decimals: The number of decimals to include.

• Visible: A checkbox. If checked, the field is visible.

• Pivot Grid: Users 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), users 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.

• Drilldown: An option to drilldown 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): Allows users to 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.

Tabs Explained: Actions

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

• ID: The system-generated number for the action.

• Description: The action's description.

• Confirmation

• Note: Any note about the action.

• Menu (...): 

  • Edit SQL: Opens the SQL editor to create SQL for the action.

  • Copy Action: Copies the action to create a new action.

  • Delete Action: Deletes the action.

Tabs Explained: Output

ℹ️ Output allows users to link a template to print, preview, or email the report. Output is not required for reports that will only be viewed on screen.

• Field Chooser (*): Allows users to add or remove columns.

• ID: The system generated number for the entry.

• Name: The name that should appear under the Output button.

• Type: Option 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.

• Output: Option to select a type of Output from this list:

  • Print Only

  • E-mail Only

  • Print & E-mail 

• Template: A checkbox which is checked once a template is added. Templates are added by right-clicking the line item and selecting Load Reportbuilder (.rtm) file from the context menu.

• HTML: A checkbox which is checked once HTML is added. HTML is added by right-clicking the line item and selecting Edit HTML from the context menu.

• Menu (...): A sub-menu 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

  • Edit Email Subject: Allows users to create a custom Email Subject.

  • Delete: Deletes the action.