Custom Reports
      Back to home
      1. INTERNAL - Bepoz Help Guides
      2. End-User | Reporting, Data Analysis & Security
      3. Custom Reports

      1 | Introduction to Custom Reports

      This article covers a basic overview of the Custom Reports component and its features within BackOffice. Custom Reports are powered by SQL server which is why the report cannot be run by everyone. Operators should have a proper understanding of SQL command before they are able to set up a custom report. SQL commands are required to create a custom report.

      This article covers a basic overview of the Custom Reports component and its features within BackOffice.

      Custom Reports are powered by SQL server which is why the report cannot be run by everyone.

      Operators should have a proper understanding of SQL command before they are able to set up a custom report.

      SQL commands are required to create a custom report.

      Prerequisites
      • For an Operator to be able to access and run Custom Reports within BackOffice, the Allow Custom Reports flag within the Reporting tab of Operator Maintenance must first be enabled
      • If this flag is not enabled, an Operator cannot access Custom Reports



      Accessing Custom Reports
      • Complete the following steps to access Custom Reports:
        1. Log in to BackOffice
        2. From the side menu, Select "Other Reports" to expand the list of Available Reports
        3. Select Custom Reports which will open a new Custom Report Window

      Toolbar Options

      Button

      Description
      Exit Custom Reports
      • Allows Exiting the Custom reports
      Add Custom Report
      • Allows Adding a new Custom report
      Edit Custom Report
      • Allows Editing custom reports 
      Delete Custom Report
      • Allows Deleting custom reports
      Run Custom Report
      • Allows Running custom reports
      Print List
      • Allows Printing the list
      Save to Disk
      • Allows Saving the list to a disk
      Restore from Disk
      • Allows restoring the report from the disk

       

       

       

      Adding Custom Report
      • To Add a new Custom report; Click on the 'Add Custom Report' button which will open a new Custom Report Editor page

       

      • Unique Key
        • Allows operator to set a character as the unique key
        • The unique key is a custom user-defined field
      • Report Name
        • Sets a Name for the report
      • SQL Command
        • Allows operators to enter SQL commands to display the report
        • Only selected SQL statements are allowed.
      • Column Definitions
        • there are 4 column definitions - Column Name, Format, total and lookup
          • Column Name is user-defined name for Items
          • Format is a drop-down selection box that shows the item format
          • Total is a flag option - when flagged on it will show the total of line selection
          • Lookup is a drop-down selection box 

      Flags & Options

      • Field List
        • SQL Field list options to add in the SQL command box
        • The field list provides all the available fields; however operators can only add the relevant ones in the SQL box otherwise the system will show an error message
      • Add Field
        • This button will add a field from the field list
      • Allow GroupBy
        • If this is on, the operator can drag report columns to the group by area for reporting groupings
      • Allow Filtering
        • If this is on, the operator can filter through the custom report
      • Chart Available
        • If this is on, the operator can chart reports
       
      SQL Commands
      • To add a new custom report, operators need to Add SQL commands in SQL Command box 
      • This will prompt the system to display the given Items
      • The following example creates a new report called Sample Report

      SQL command in Sample Report

       

      • This SQL command will list all the products that have Product ID more than or equal to 206
      • The column definition is not mandatory but the operator can add Column Name to change its settings

      • Since the Custom Report requires adding SQL commands, it is more complex than other types of reports and requires Operators with SQL knowledge to start configuration