Data Exporter
FollowPage Contents
Making templates for your 3PL with Data Exporter Tutorial Video
Making templates for your 3PL with Data Exporter Tutorial Video
Data Exporter
Use Unleashed's "Data Exporter" to create custom report templates for Sales Orders, Sales Shipments or Purchase Orders. Once a template's been created it will be available to run and export and share with your teams or third-party logistics providers.
Data Exporter Role Permissions
To access, create and use Data Exporter templates ensure the "Data Exporter" and "Data Source" permissions for the appropriate User Roles have been enabled for access and/or editing.
Users that have the ability to manage Role Permissions can do so by following the below steps:
- From Unleashed's main menu, go to Settings, Security, Role Permissions.
- Select the role from the Role drop-down list.
- Click on the triangle icon in front of the "Data Exporter" section
- To enable access and use of the Data Exporter page click on the padlock icon displayed along the "Data Exporter" subsection.
-
Select the triangle icon displayed in the "Data Exporter" subsection and this will display a list of "Data Sources" for the Data Exporter module, the data sources available are:
- Assembly
- Purchase Order
- Sales Order
- Sales Shipment
- Warehouse Transfer
- Click on the padlock icon for each data source to manage the role's access to them via the Data Exporter.
To manage and create report templates with the Data Exporter, navigate to "Integration" from Unleashed's main menu and select "Data Exporter".
View Templates
Within the Data Exporter you'll be shown the "View Templates" page, which will display all currently available Data Exporter templates available to use and manage.
Filter descriptions
At the top of the Data Exporter's View Templates page there are three filter fields available that help you to refine your search for an existing template:
- Export Template: A free text field that will filter the templates displayed with at least a partial match to the Template Name.
-
Data Source: A drop down menu that will filter the templates by their Data Source. The Data Sources available are:
- All
- Sales Order
- Sales Shipment
- Purchase Order
-
Export Format: A drop down menu that will filter the templates by their selected Export Format. The Export Formats available are:
- All
- CSV
- TSV
Header Descriptions
Below the View Templates' filter fields the existing Data Exporter templates will be populated, displaying the following details:
- Template Name
- Data Source
- Export Format
- Email Address
- Created By
- Last Modified
In the final column, under Action, an action cog icon is displayed. Hover over the action cog for the following options:
- Edit: Opens the template for editing.
- Clone: Duplicates the template.
- Delete: Removes the template from your Unleashed account (this action cannot be undone).
Add Template
To create a new template with the Data Exporter:
- From the main menu, go to Integration, Data Exporter.
- In the top right corner, select Add Template.
- In the Create Template page, specify details for the required fields:
-
Template Name: Unique to the template.
- Data Source: Use the dropdown menu to select either Sales Order, Sales Shipment or Purchase Order. Once a Data Source is selected the page will update to display further template options.
-
Export Format: Use the dropdown menu to select either CSV or TSV.
-
- You can also specify the following optional details which will populate anytime the template is emailed from Unleashed (variables are not supported):
- Default Email Recipient
- Email Subject
- Default Email Message
- Use the "Filters to apply" section to set default filters the template will apply each time a report's generated.
- Use the "Fields to be exported" section to determine which details from the Sales Order, Sales Shipment or Purchase Order data source should be included when the template is used to generate a report. To include a field, select it in the "Available field" list, then click "Add". The field will then be listed in the "Selected Fields" list.
NOTE: Use the "Add All" and "Remove All" buttons to include or remove all available fields in the selected fields' list.
- Manage the order in which the "Selected Fields" will be populated using the following action buttons available:
- To Top
- Up
- Down
- To Bottom
- Use the "Edit Fields" button to customise the Selected Field's export name.
- Click "Save" in the top right corner of the "Create Template" page to save the template.
Filters to apply
The options available in the "Filters to apply" section per Data Source are detailed in the below table.
Sales Order | Sales Shipment | Purchase Order |
---|---|---|
Filter Date Range By Use the drop down menu to select the appropriate date type the template should filter by:
|
Filter Date Range By Use the drop down menu to select the appropriate date type the template should filter by:
|
Filter Date Range By Use the drop down menu to select the appropriate date type the template should filter by:
|
From Date Use the date field to set a start date for the template to apply. NOTE: Maximum date range is three months. |
From Date Use the date field to set a start date for the template to apply. NOTE: Maximum date range is three months. |
From Date Use the date field to set a start date for the template to apply. NOTE: Maximum date range is three months. |
To Date Use the date field to set a start date for the template to apply. NOTE: Maximum date range is three months. |
To Date Use the date field to set a start date for the template to apply. NOTE: Maximum date range is three months. |
To Date Use the date field to set a start date for the template to apply. NOTE: Maximum date range is three months. |
Order Status Use the multi-select dropdown menu to filter the template based on the Sales Order's current status. |
Shipment Status Use the multi-select dropdown menu to filter the template based on the Sales Shipment's current status. |
Order Status Use the multi-select dropdown menu to filter the template based on the Purchase Order's current status. |
Sales Order Group Use the multi-select dropdown menu to filter the template based on the Sales Order's current Sales Order Group. |
N/A |
Supplier Use the multi-select dropdown menu to filter the template based on the Purchase Order's Supplier |
Warehouse Use the multi-select dropdown menu to filter the template based on the Sales Order's current Order Warehouse. |
Warehouse Use the multi-select dropdown menu to filter the template based on the Sales Shipment's current Shipping Warehouse. |
Warehouse Use the multi-select dropdown menu to filter the template based on the Purchase Order's current Warehouse. |
Delivery Country Use the multi-select dropdown menu to filter the template based on the Sales Order's current Delivery Country. |
Delivery Country Use the multi-select dropdown menu to filter the template based on the Sales Shipment's current Delivery Country. |
N/A |
Currency Use the multi-select dropdown menu to filter the template based on the Customer's currency. |
N/A |
Currency Use the multi-select dropdown menu to filter the template based on the Supplier's currency. |
Delivery City Use the free text field to filter the template by the Sales Order's Delivery City. |
Delivery City Use the free text field to filter the template by the Sales Order's Delivery City. |
N/A |
Delivery Method Use the multi-select dropdown menu to filter the template based on the Sales Order's current Delivery Method. |
Delivery Method Use the multi-select dropdown menu to filter the template based on the Sales Order's current Delivery Method. |
N/A |
Sales Person Use the multi-select dropdown menu to filter the template based on the Sales Order's current Sales Person. |
Shipping Company Use the multi-select dropdown menu to filter the template based on the Sales Shipment's current Shipping Company. |
N/A |
It is not possible to add any further custom filters to a template in Data Exporter, so any further required filtering should be processed after the report's been generated.
Edit a template
Once a template has been created and saved in Data Exporter it can be edited at any time. To edit a Data Exporter template:
- From the main menu, go to Integration, Data Exporter.
- From the View Templates page open the template by either clicking on the "Template Name" and selecting "Edit Template" or select "Edit" in the template row's action cog.
- Make any required changes to the template, filters or selected fields.
- Click "Update" to apply the changes with immediate effect.
NOTE: The changes will not apply to any reports already generated.
Download Preview
Use the "Download Preview" button in a Data Exporter template to review the current layout and data to be included. When selected an example report will be generated based on the template's current filters and fields. A notification will be displayed burger icon in the top right corner of your Unleashed page and the example report will be available to download once it's been generated successfully. The preview will only include up to one row of data, based on the fields and filters applied.
Using Data Exporter templates
Export a template
Use the Data Exporter's "Export" function to generate and download a report from the template you've chosen:
- From Unleashed's main menu, go to Integration, Data Exporter.
- From the "View Templates" page, click on a template name to open it.
- Update the "Filters to apply" section to align with your requirements.
- In the top right corner of the template's page, click on "Export".
- A notification will be displayed in the notification bar on Unleashed's banner. Once the report is generated the notification will display a link to download it to your device.
Email a template
Use the Data Exporter's "Email" function to generate and send a report from the template you've chosen:
- From Unleashed's main menu, go to Integration, Data Exporter.
- From the "View Templates" page, click on a template name to open it.
- Update the "Filters to apply" section to align with your requirements.
- At the bottom right of the template, click on "Email".
- Fill in the required "To" field with the recipient's email address and provide any further detail in the Cc, Subject and Message fields.
NOTE: If the template has a default email recipient or email details set they will automatically populate here.
- Click "Send" and the recipient will receive the Data Exporter generated report via email attachment.
Export to 3PL
Use the "Export to 3PL" action in the View Sales Orders page to email a Data Exporter template report populated from a select range of Sales Orders. This function's ideal for providing third party logistics and shipping providers with the necessary details required to deliver specific orders to your customers accurately.
- From Unleashed's main menu, go to Sales, Orders and select View Sales Orders.
- Use the filter fields available to populate the appropriate Sales Orders in the View Sales Order's grid.
- Use the checkboxes available to select the Sales Orders that should be included in the report. Alternatively, hover over the Action Cog icon in the header and click "Select All" to check all Sales Orders on the current page.
- Hover over the Action Cog icon in the header and click on "Export to 3PL".
- In the "Export to 3PL" pop-up window, select the Data Exporter template needed using the "Template" drop down menu.
- Fill in the required "To" field with the recipient's email address and provide any further detail in the Cc, Subject and Message fields.
NOTE: If the template has a default email recipient or email details set they will automatically populate here.
- Click "Send" and the recipient will receive the Data Exporter generated report via email attachment.
NOTE: Doc Designer templates are not available in the "Export to 3PL" option.
Export to 3PL from a transaction
Use a Sales Order's "Email" function to send a Data Exporter template report generated only for the chosen Sales Order:
- Open a Sales Order and click dropdown arrow on the "Email" button at the bottom of the order's page.
- Select "Export to 3PL".
- In the "Export to 3PL" pop-up window, select the Data Exporter template needed using the "Template" drop down menu.
- Fill in the required "To" field with the recipient's email address and provide any further detail in the Cc, Subject and Message fields.
NOTE: If the template has a default email recipient or email details set they will automatically populate here.
- Click "Send" and the recipient will receive the Data Exporter generated report via email attachment.
Email logs for Data Exporter templates
Use either the "View Email Log" button at the bottom of a Data Exporter Template or the Email Logs page (found in Settings, Security, Email Logs) to review when Data Exporter template reports have been sent and who they've been sent to.