Procure Wizard Export Overview
This document will contain information specific to the Procure Wizard export template. For general information about the Data Extraction Service and it's API please see the general purpose documentation
Job Run Parameters
This template supports filtering against the DBGen range OR the TradingDate of finalised SalesTransactions/ZReports.
EITHER DBGen filtering OR trading date filtering must be used. Filtering on both is not supported.
Parameter Definitions
| Parameter | Type | Description |
|---|---|---|
| DBGenFrom | Number (optional) | The (inclusive) start of the DBGen range which will be used to filter data. (required if using DBGen filtering) |
| DBGenTo | Number (optional) | The (inclusive) end of the DBGen range which will be used to filter data. If unspecified the current latest DBGen from the server will be used. |
| TradingDateFrom | DateTime (optional) | The (inclusive) start of the TradingDate range which will be used to filter data. Please note that the time will reference the time the order/zreport was closed/finalised (required if TradingDateTo is set) |
| TradingDateTo | DateTime (optional) | The (inclusive) end of the TradingDate range which will be used to filter data. Please note that the time will reference the time the order/zreport was closed/finalised (required if TradingDateFrom is set) |
When configuring a schedule, you should only use DBGenFrom and use it in Auto Value mode to ensure all data is sent to ProcureWizard. Doing this will also mean that you need to configure ProcureWizard to operate in "Combine Data" mode, which means the data can arrive late / out of order and will combine safely with previously imported data.
You should also initialise the period to export from using the "Reset to Trading Date" button.
WARNING: You should be very careful when using the TradingDateFrom/To options as there is no safety to ensure that ProcureWizard doesnt already have the sales you are re-exporting, and when received they will merge without duplicate detection.
Auto Value Considerations
DBGenFrom supports auto values which (when executing an auto value job run) will update to the value supplied at DBGenTo (or the latest DBGen from the sales data). When DBGenFrom is set to use an auto value it will use the value of the auto value + 1 to ensure that repeated executions will never export already exported sales data.
Output Files
CSV exports will generate a single output file:
| File | Format | Description |
|---|---|---|
| items.csv | CSV | All matching ProcureWizardTransactionItem entities encoded as CSV |
These files will then be optionally transferred via SFTP to a designated server. The file name is formatted yyyyMMddHHmmss-[unique guid].zip. SFTP details, when used, will be provided by ProcureWizard and are specific to each customer.
Special Considerations
You will need to ensure that the OutletName_TerminalDisplayID mappings are pre-configured within ProcureWizard. You will need to ensure that all sale items have a unique PLU number in PowerEPOS You will need to ensure that all those same PLU numbers have been entered into ProcureWizard, are are maintained moving forward.