To support customers with extracting data from Unimarket on a regular basis, there is the ability to generate scheduled report runs.
Users with the Community Administrator, Create Invoices or View Transactions roles can create scheduled reports.
Note: Currently, this feature is only available to run on a specific day. We have not provisioned the ability to select a month-end or once a month type of schedule, yet. |
Watch this short video on how to create a scheduled report or continue reading below:
Create Schedule Reports
To create scheduled reports, go to the Insights module > select Schedules > click More Actions > click +Schedule Report.
The Schedule Report pop-up box will appear.
Each field description and details are listed below.
Schedule Name: Enter the desired name of the scheduled report cycle.
Report Type: Select the desired report type.
Predefined Period:
- Last Month: Uses predefined logic. On the first day of each month, it will generate for the previous month. Example: September 1st will include all data from August 1st - August 31st.
- Last 3 Months: Uses predefined logic. On the first day of each month, it will generate for the previous quarter. Example: April 1st will include data from January 1st - March 31st.
- Last 6 Months: Uses predefined logic. On the first day of each month, it will generate for the previous 6 months. Example: August 1st will include all data from February 1st - July 31st.
Duration: How much data to include in the report from the time it was ran.
Period Type: Select from the available options.
- Hour(s): 1 to 48
- Day(s): 1 to 365
- Week(s): 1 to 52
- Month(s): 1 to 12
Days: Select the day or days of the week that you would like this report to run. You can use this in combination with Run Time, to do something like "Every Monday & Wednesday at 8am."
Run Time: Select the time of day you would like this report to run. If you would like this report to run at multiple times of the day, select to add additional times.
Recipients: Insert the desired recipient's email address(es).
Endpoint: Where to send the completed reports. Contact Unimarket Support for help getting this list updated.
Alternatively, an sFTP endpoint can be chosen to securely submit the data to a folder location on the customer's side.
Filename Template: A filename template for the generated scheduled report. The name can be edited to suit the needs of the user and allows a few variable terms to be used. This means the variable term entered is automatically replaced with the matching piece of data. Please see the examples below:
-
${runDate(PATTERN)} - The date when the scheduled export/report was generated, replace "PATTERN" with a date/time formatting:
-
-
- MM-dd-yyyy_HH_mm_ss - Will be replaced with 06-01-2018_02_22_39
- yyyy-MMM-dd-hhm - Will be replaced with 2018-Jun-01-0225
-
-
- ${scheduleName} - The name of the Scheduled export/report
Example template:
ScheduledReport_${scheduleName}_Date-${runDate(YYYY-MM-dd_hh-mm-ss)} ->
ScheduledReport_ScheduleName_Date-18-06-16_02-46-19.csv
Once completed, select Add. To schedule additional reports, select Add More.