Skip to main content

Data Exporter

Create custom report templates for Sales and Purchase Orders to export and share with 3PLs.

Heather Worthington avatar
Written by Heather Worthington
Updated over a week ago

The Data Exporter allows you to create custom report templates for Sales Orders, Sales Shipments, and Purchase Orders. These templates can be exported, emailed, or shared with your teams and third-party logistics (3PLs) providers for streamlined operations.

Data Exporter role permissions

Before using Data Exporter, ensure your user's role has the appropriate permissions granted:

  1. Navigate to Settings > Security > Role Permissions.

  2. Select the appropriate role from the dropdown.

  3. Expand the "Data Exporter" section by clicking the triangle icon.

  4. Enable access by clicking the padlock icon next to "Data Exporter". When the padlock is green, permission is granted.

  5. Allow the role to make updates to Data Exporter templates by clicking on the "Can Edit" checkbox. When the box and pen icon is green, edit permission is granted.

  6. Expand the "Data Exporter" subsection and click each padlock to grant access for the appropriate data sources:

    • Assembly

    • Purchase Order

    • Sales Order

    • Sales Shipment

    • Warehouse Transfer


Tutorial Video

Making templates for your 3PL


Managing Data Exporter templates

To access, manage, and create Data Exporter templates, navigate from the main menu to Integration > Data Exporter.

The View Templates page displays all available Data Exporter templates with the following information:

  • Template Name: The custom name for the template.

  • Data Source: The data source from which the template will populate its results.

  • Export Format: The document format that the template will be generated in.

  • Email Address: The default email address for the template.

  • Created By: The email address of the user who created the template.

  • Last Modified: The date the template was last edited.

  • Action: Click on the Clone option to create a new template as a replica of this template. Click on the Delete option to remove the Data Export template from your account.

๐Ÿ“Œ Note: When a Data Exporter template is deleted, it cannot be restored.

Use the following filter fields, displayed at the top of the View Templates page, to refine this view and locate the Data Exporter template you're looking for:

  • Export Template: A free-text field to filter the view by Template Name.

  • Data Source: A drop-down menu to filter the templates by the Data Source they're created for. The options available are:

    • All

    • Sales Order

    • Sales Shipment

    • Purchase Order

  • Export Format: A drop-down menu to filter the templates by their exportable format. The available options are:

    • All

    • CSV

    • TSV

Create a Data Exporter template

To create a new Data Exporter template :

  1. From the main menu, go to Integration > Data Exporter.

  2. Click Add Template, in the top right corner.

  3. Enter a unique Template Name (required).

  4. Use the drop-down menu to select a Data Source for the template (required):

    • Sales Order

    • Sales Shipment

    • Purchase Order

  5. Use the drop-down menu to select an Export Format for the template (required):

    • CSV

    • TSV

  6. Enter a default email address, subject and message to apply when the template is emailed.

  7. Use the drop-down and date selector fields displayed in the "Filters to apply" section to set default filters for the template.

  8. Search and Add the data fields that should be included on the template, based on the Data Source, in the "Fields to be exported" section.

  9. Click on Save.

After a new template has been created, it can be exported and edited at any time.

๐Ÿ“Œ Note: The Data Source selected in a Data Exporter template cannot be changed.

Edit a Data Exporter template

To update or edit a Data Exporter template:

  1. โ€‹From the main menu, go to Integration > Data Exporter.

  2. In the View Templates page, click on the template's name.

  3. Click Edit Template in the top right corner.

  4. Make the necessary updates to the template's default filters, selected fields, and default email details.

  5. Click Update.

Changes made to a Data Exporter template will only affect future reports generated from the template, not previously generated ones.

Default email details

You can set a default email address, and plain text subject and message per Data Exporter template, which will auto-populate whenever the template is emailed or exported to a 3PL.

๐Ÿ“Œ Note: Variables are not supported in Data Exporter templates.

Preview Data Exporter templates

The preview feature in the Data Exporter template allows you to review the template's current layout and data structure. When selected, an example report will be generated in the selected format: CSV or TSV, populating the selected fields using the template's filters.

๐Ÿ“Œ Note: The Data Exporter's preview will only include up to one row of data.

To preview a Data Exporter template:

  1. From the main menu, go to Integration > Data Exporter.

  2. In the View Templates page, click on the template's name.

  3. Click Download Preview.

  4. Go to the taskbar icon in your account's banner.

  5. Select "Preview Data {Template name}".

  6. Click Download.


Filters to apply by Data Source

The filter fields available to apply to Data Exporter templates vary depending on the Data Source selected.

Sales Orders

When Sales Orders is selected as the template's data source, the following filters are available in the "Filters to apply" section.

Sales Order's Data Exporter filter

Description

Filter Date Range By

Use the drop-down menu to select which Sales Order date the template will be filtered by:

  • Order Date

  • Created Date

  • Required Date

  • Completed Date

  • Payment Due Date

Date Range

Use the From and To date selectors to set a date range, for a maximum 3-month period, to filter the Sales Orders by.

Order Status

Use the multi-select drop-down menu to filter Sales Orders by their current status:

  • Parked (includes all custom sales order statuses)

  • Deleted

  • Completed

  • Backordered

  • Placed

Sales Order Group

Use the multi-select drop-down menu to filter Sales Orders by their Sales Order Group.

Warehouse

Use the multi-select drop-down menu to filter Sales Orders by their Order Warehouse.

Delivery Country

Use the multi-select drop-down menu to filter Sales Orders by their Delivery Address's Country.

Currency

Use the multi-select drop-down menu to filter by the Sales Order customer's currency.

Sales Person

Use the multi-select drop-down menu to filter Sales Orders by their assigned Sales Person.

Delivery City

A free text field to filter by the Sales Order's Delivery Address's city.

Delivery Method

Use the multi-select drop-down menu to filter by the Sales Order's Delivery Method.

Sales Shipments

When Sales Shipments is selected as the template's data source, the following filters are available in the "Filters to apply" section.

Sales Shipment Data Exporter filters

Description

Filter Date Range By

Use the drop-down menu to select which Sales Shipment date the template will be filtered by:

  • Created Date

  • Shipment Dispatch Date

Date Range

Use the From and To date selectors to set a date range, for a maximum 3-month period, to filter the Sales Shipments.

Shipment Status

Use the multi-select drop-down menu to filter Sales Shipments by their current status:

  • Parked

  • Placed

  • Picking

  • Picked

  • Packed

  • Dispatched

Warehouse

Use the multi-select drop-down menu to filter Sales Shipments by their Shipping Warehouse.

Delivery Country

Use the multi-select drop-down menu to filter Sales Shipments by their Sales Order's Delivery Address's Country.

Delivery City

A free text field to filter Sales Shipments by their Sales Order's Delivery Address's city.

Delivery Method

Use the multi-select drop-down menu to filter Sales Shipments by their Sales Order's Delivery Method.

Shipping Company

Use the multi-select drop-down menu to filter by the Sales Shipment's Shipping Company.

Purchase Orders

When Purchase Orders is selected as the template's data source, the following filters are available in the "Filters to apply" section.

Purchase Order's Data Exporter filters

Description

Filter Date Range By

Use the drop-down menu to select which Purchase Order date the template will be filtered by:

  • Order Date

  • Delivery Date

  • Completed Date

  • Received Date

  • Supplier Invoice Date

Date Range

Use the From and To date selectors to set a date range, for a maximum 3-month period, to filter the Purchase Orders.

Order Status

Use the multi-select drop-down menu to filter Purchase Orders by their current status:

  • Unapproved

  • Parked (includes all custom purchase order statuses)

  • Paced

  • Costed

  • Receipted

  • Complete

Supplier

Use the multi-select drop-down menu to filter by the Purchase Order's supplier.

Warehouse

Use the multi-select drop-down menu to filter by the Purchase Order's warehouse.

Currency

Use the multi-select drop-down menu to filter by the Sales Order supplier's currency.


Fields to be exported

The fields selected in a Data Exporter's template determine which details from the selected data source's transactions will be populated in the reports it generates. The fields available to include are fixed, and vary depending on the data source selected in the template.

To add a field to a Data Exporter template that is being created or updated:

  1. In the Data Exporter template, go to the "Fields to be exported" section.

  2. In Available Fields, search and select the data field to be included.

  3. Click Add.

  4. The added field will then be listed in Selected Fields.

To remove a field from a Data Exporter template that is being created or updated:

  1. In the Data Exporter template, go to the "Fields to be exported" section.

  2. In Selected Fields, select the data field to be removed.

  3. Click Remove.

  4. The field will then be listed in Available Fields.

๐Ÿค“ Tip: Hold the Shift or Ctrl key on your keyboard to select multiple fields to add or remove.

Click on the Add All and Remove All buttons in the Fields to be exported section to include or remove all fields from the Data Exporter's template, respectively.

Managing selected fields

You can customise the names and order of your template's selected fields using the buttons available in the Fields to be exported section. After making changes, click Save or Update on the template to save them.

To edit the selected field's name:

  1. In the Data Exporter template, go to the "Fields to be exported" section.

  2. Select a field in the Selected Fields list.

  3. Click Edit Field.

  4. In the Export Name field, enter the name the field will have when the template is used.

  5. Click Save.

  6. The Export Name will replace the field's default name in the Selected Fields list.

When the template is used to generate a report, the field's Export Name will be populated in the header row.

To sort the column order your selected fields will be displayed in:

  1. In the Data Exporter template, go to the "Fields to be exported" section.

  2. Select a field in the Selected Fields list.

  3. Click either:

    • To Top

    • Up

    • Down

    • To Bottom


Using Data Exporter templates

After a Data Exporter template has been created, it can be shared either internally or with a 3PL by email or export.

When the template has a default email, subject, or message, they will automatically populate when generating an email.

Export a template

  1. Go to Integration > Data Exporter.

  2. Click on the template name.

  3. Adjust "Filters to apply" as needed.

  4. Click Export in the top right corner.

  5. Go to the taskbar icon in your account's banner.

  6. Select "Preview Data {Template name}".

  7. Click Download.

Email a template

  1. Go to Integration > Data Exporter.

  2. Click on the template name.

  3. Adjust "Filters to apply" as needed.

  4. Click Email at the bottom right.

  5. In the To field confirm or enter a recipient email address (required).

  6. Add and update Cc, Subject, and Message details if needed.

  7. Click Send.

Export to 3PL (Third-Party Logistics)

The Export to 3PL function in the View Sales Orders and Sales Order pages generates a report, using a selected Data Exporter template, and emails it to your preferred recipients.

To export multiple Sales Orders to a 3PL, using a Data Exporter template:

  1. Navigate to Sales > Orders > View Sales Orders.

  2. Filter to find the relevant orders.

  3. Select orders using checkboxes.

  4. Hover over the header's Action Cog and select "Export to 3PL".

  5. Choose your Data Exporter template from the dropdown.

  6. Confirm or update the recipient email in the To field.

  7. Confirm or update the email's subject and message.

  8. Click Send.

To export a Sales Order to a 3PL, using a Data Exporter template:

  1. Open the Sales Order.

  2. At the bottom of the page click the dropdown arrow on the Email button.

  3. Select "Export to 3PL"

  4. Choose your Data Exporter template from the dropdown.

  5. Confirm or update the recipient email in the To field.

  6. Confirm or update the email's subject and message.

  7. Click Send.

๐Ÿ“Œ Note: Doc Designer templates cannot be exported to a 3PL.

Email logs for Data Exporter templates

Track the Data Exporter reports that have been emailed from your account either from the Data Exporter template or via Settings > Security > Email Logs.

To view the Email Log per Data Exporter template:

  1. Go to Integration > Data Exporter.

  2. Click on the template name.

  3. At the bottom of the template, click View Email Log.

Did this answer your question?