Loading...
Area: Episerver Commerce

Collecting data for reports

Recommendations [hide]

This topic describes how to collect and access data for order reports in Episerver Commerce.

How it works

The collect data feature provides raw data for created orders and includes:

  • Ability to specify time periods for which you want the data (for example, all orders created in the past 90 days) in the web.config.
  • Ability to collect data when an order is placed or an existing order is modified.
  • A scheduled job that collects the order raw data then exports it to a compressed zip file, which contains a csv file with order data.
  • The Reports menu, which displays links for downloading exported zip files.
  • Permissions that control access to the Reports menu.

The collected data is also used by the Sales by Day report in Commerce Manager.

Selecting time periods

You determine the time range for the reports in the web.config file, under <appSettings>.

<add key="episerver:commerce.ReportingTimeRanges" value="30;60;90;120"/>

Values are numbers of days prior to the date that you run the "Collect Report Data" scheduled job. Begin and end dates are included in the order dates. For each value, the job creates one corresponding csv file.

The above example means that the Collect Report Data scheduled job generates 4 csv files: one for all orders created within the last 30 days, another for orders created within the last 60 days, and so on.

Each csv file is compressed in a .zip file.

In the example below, the report compiles one report containing order data for the past year (365 days).

<add key="episerver:commerce.ReportingTimeRanges" value="365" />

 Note: If the web.config has no settings for episerver:commerce.ReportingTimeRanges, the default value is 90.

Collecting report data

Using a scheduled job

The scheduled job Collect Report Data collects order data in the background. Like other scheduled jobs, you can run this manually or at predetermined time intervals.

CommerceReport1.png

Using order events

Order data can also be collected whenever an order is placed or an existing order is modified by adding, updating, or removing line items. Use the following web.config setting, which occurs under <appSettings>, to determine whether to collect order data when these order events occur.

<add key="episerver:commerce.EnableEventDrivenOrderReporting" value="true"/>

 Note: If no value is set for episerver:commerce.EnableEventDrivenOrderReporting, order data is collected. In other words, the default value is True.

Order data

This version provides the following information for each order created during the specified time range in LineItem level.

  • LineItemID
  • LineItemCode
  • DisplayName
  • PlacedPrice
  • Quantity
  • ExtendedPrice
  • EntryDiscountAmount: The line item's discount amount
  • SalesTax
  • Currency
  • OrderGroupId
  • OrderNumber
  • CustomerID
  • CustomerName
  • MarketId
  • OrderCreated: The order creation date
  • AdditionalValues - see Add properties to your Order data.

Add properties to order data

If default values do not meet your requirements, you can add properties by overriding the GetAdditionalData() method of ReportingAdditionalDataHandler.

public override IEnumerable<string> GetAdditionalData(ILineItem lineItem, IPurchaseOrder order)
    {
       return new string[] { order.MarketId.Value, order.OrderStatus.ToString(), lineItem.InventoryTrackingStatus.ToString() };
    }

The extension point in DefaultReportingService.ExportOrderDataAsCsv() calls to GetAdditionalData() to assign value for AdditionalValues, then exports AdditionalValues like other default values to the csv file.

Permissions

Only users with following roles can access the Reports menu.

  • CommerceAdmins
  • ReportManagers

Accessing collected data

After collecting the report data, a link to the exported .zip files appears under Reports. Click the link to download the data.

CommerceReport2.png

Data format

Collected report data is presented in a comma-separated value (CSV) format.
Open full-size image in new window 

exportCSV.png

Related topics

Do you find this information helpful? Please log in to provide feedback.

Last updated: Oct 27, 2020

Recommendations [hide]