To support Customers with extracting data from Unimarket on a regular basis, there is the ability to generate reports to run on a schedule.
From your Insights Module > Schedules, roles of Community Administrators & View Transactions are able to create reporting schedules.
Note, this feature is only available to run on a specific day at the moment - we have not yet provisioned the ability to select a month-end or once a month type of schedule.
Click on Schedules from the left side menu and then click +Schedule Report from the More Actions Menu in the top right.
A Schedule Report pop up will appear where you will select Reports and you can enter the necessary information that is needed to schedule your report.
Schedule Name - Enter in a name for your Scheduled Report cycle.
Report Type - Select the Report Type you would like to run on a schedule from the drop down.
Run Report Duration - Duration is how much data to include in the report from the time it was run. For example, if you select 1 week, it will show all data for the last week
Run Report Period Type - Select Hour(s), Day(s), Week(s), or Month(s) as the period type.
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 during the day, you can press the + next to the drop down box to add additional times.
Recipients - Once the report has run, an email notification will be send to the specified email address to advise the report is now available (the report is not sent via email for size and security reasons).
Alternatively, an sFTP Endpoint can be chosen to securely submit the data to a folder location on the customer side.
If you need to add or edit your Endpoint list, please contact Unimarket Support.
Filename Template - The output file can have a specific naming convention to meet parameters you may require. There is a default loaded using the naming convention and date of the report run.
You can update these parameters as below:
- ${scheduleName} - if you need to name the output file something different to your schedule name
-
${runDate(PATTERN)} - if you need an alternate date pattern, replace "PATTERN" with a date/time formatting.
- MM-dd-yyyy_HH_mm_ss -> 06-01-2018_02_22_39
- yyyy-MMM-dd-hhm -> 2018-Jun-01-0225
Example template:
ScheduledReport_${scheduleName}_Date-${runDate(YYYY-MM-dd_hh-mm-ss)} ->
ScheduledReport_ScheduleName_Date-18-06-16_02-46-19.csv