Custom reports

Custom reports allow you to create tailored reports that meet your specific needs. You can customize the content, choose where to display them, and export the reports as Excel files.

Creating a custom report

1. Access the Reports Configuration
   Navigate to Configuration → Advanced → Reports.
   Click on the three dots (menu icon) and select Add.
    
2. Select the Report Type
   Choose the type of report you want to create. The available areas will depend on the type you select.
   
   Note: If no type is selected, properties will not be available for customization.
    
3. Define Report Details
   • Enter a Name for the report, which will be visible in the user interface.
   • Provide a Description to explain the report’s purpose.
      

4. Decide the Report Placement
   Choose whether the report will appear in the Reports Module or in a specific area within Omnium, such as the product list or the order list. The available areas for the report will depend on the type of report you select.
   
   
   
   This custom report will be accessible in both the order list and the reports module, as both are added to area.
   
   Navigate to Orders -> click the three ellipses, and you will see the report available under Custom Reports after publishing your report.
   
   

   When "Report Order" is selected, the report will be available under Reports -> Orders -> Custom Reports -> Report Type.

   
   
    

5. Select and Configure Properties
   • Use the dropdown menu to select properties to include in the report.
   • For each property, specify the data type. Currently available data types are:
     • String
     • Number
     • Date
     • Formula
   • Optionally, add a prefix for the property.
      
6. Publish the Report
   After configuring the report, publish your changes. The report will now be available in the chosen location(area)

Adding external IDs to a custom report in the order List

To include external IDs in a custom report follow these steps. 

1. Navigate to the reports configuration. Configuration → Advanced → Reports.
2. Create a new report or edit an existing one in the order list.
3. In the field selection dropdown, find and select Order.ExternalIds. Click Add to include it in your report.
   
   
    
4. Specify the external ID key. Example keys: Order.ExternalIds.ReceiptTestId or Order.ExternalIds.TripleTexId
   
   
   
    
5. Save the report and generate it to view the results. If the expected external ID values do not appear, verify that the correct keys are used and that they exist on the orders.