Difference between revisions of "Scheduled Report Export"

From SmartWiki
Jump to: navigation, search
(Configuration - Essentials)
(Configuration - Advanced)
(One intermediate revision by the same user not shown)
Line 39: Line 39:
 
:* '''SmartFolder''' - Select a [[SmartFolders_Overview|SmartFolder]] where you would like the file to be saved.
 
:* '''SmartFolder''' - Select a [[SmartFolders_Overview|SmartFolder]] where you would like the file to be saved.
 
:* '''sftp'''
 
:* '''sftp'''
:* '''URL''' - enter the url of the sftp site i.e. ''34.234.21.159'' or my.sftp.com or my.sftp.com:2222
+
:** '''URL''' - enter the url of the sftp site i.e. ''34.234.21.159'' or my.sftp.com or my.sftp.com:2222'''Update Status After Export''' - status of the records will changed to the selected status after export.
::* '''Username''' - username to allow access to the sftp
+
:** '''Username''' - username to allow access to the sftp
::* '''Password''' - password to allow access to the sftp
+
:** '''Password''' - password to allow access to the sftp
::* '''Path''' - sftp folder location where the files will be pushed i.e. /in or /out or /Payments/inbound
+
:** '''Path''' - sftp folder location where the files will be pushed i.e. /in or /out or /Payments/inbound
:* '''Update Status After Export''' - status of the records will changed to the selected status after export.
 
 
:* '''Trigger Workflow After Export''' - workflow selected will be triggered to all records after export.
 
:* '''Trigger Workflow After Export''' - workflow selected will be triggered to all records after export.
:* '''Export File Name''' - file name of the file can be specified including stamp date. It is recommended to append a timestamp. To stamp the date, use [YYYY],[YY],[MM],[DD],[HH],[mm]. i.e. MyExportedReport_[YYYY]-[MM]-[DD]
+
:* '''Export File Name''' - file name of the file can be specified including stamp date. It is recommended to append a timestamp. To stamp the date, use [YYYY],[YY],[MM],[DD],[HH],[mm]. i.e. MyExportedReport_[YYYY]-[MM]-[DD].  Note that the file extension should not be included in this section i.e. '''PaymentDetails_[YYYY]-[MM]_[DD] '''  and NOT "PaymentDetails_[YYYY]-[MM]_[DD].csv"  The extension of the file should be specified in the a.) ''Export Format'' dropdown in the [[Exporting_Reports|'''File Export''']] tab  for standard File Export or b.) ''File Extension'' textbox in the [[Custom_Export|'''Custom Export''']] tab for custom export reports
:* '''Last Exported''' - date of the last export.
+
:* '''Last Exported''' - date of the last export .
  
  
Line 55: Line 54:
 
* Choose '''15th''' (future date) for the '''Start Date''' and '''Monthly''' for the '''Frequency''' and select the '''Time of Export''' dropdown list.
 
* Choose '''15th''' (future date) for the '''Start Date''' and '''Monthly''' for the '''Frequency''' and select the '''Time of Export''' dropdown list.
 
** Export Every 15th of the month
 
** Export Every 15th of the month
 
=Configuration - Advanced=
 
 
  
 
=Troubleshooting=
 
=Troubleshooting=

Revision as of 10:59, 14 February 2020

Overview

  • System Administrators can schedule report export to run periodically (daily, weekly, monthly, quarterly, yearly).
  • Scheduled report export can be configured to export a file to 1.) a SmartFolder, or 2.) a sub-directory of a SSH File Transfer Protocol (SFTP) server.

Configuration - Essentials

Scheduled Report Export is built using SmartSimple's integrated reporting subsystem. The settings for scheduled report export is available on the File Export tab of the Edit Reports page.

Scheduled Export On the Edit Report page, go to Scheduled Export tab.
To configure a scheduled report, the following settings are found from the Scheduled Export tab:

ScheduledExport.PNG

  • Export Type - specify the type of export for the scheduled export
Options:
  • File Export - export file based on settings from File Export tab
  • Custom Export - export file based on settings from Custom Export
  • Frequency - How often should the report be exported.
Options:
  • Disabled
  • Daily
  • Weekly
  • Monthly
  • Quarterly
  • Yearly
  • On Demand - used when report is linked to an autoloader.
  • At - specify time for the scheduled export
  • Starting - specify the start date for the scheduled export
  • Export to - select where you want to export the file to
Options:
  • Configuration Folder - Select a Configuration Folder where you would like the file to be saved.
  • SmartFolder - Select a SmartFolder where you would like the file to be saved.
  • sftp
    • URL - enter the url of the sftp site i.e. 34.234.21.159 or my.sftp.com or my.sftp.com:2222Update Status After Export - status of the records will changed to the selected status after export.
    • Username - username to allow access to the sftp
    • Password - password to allow access to the sftp
    • Path - sftp folder location where the files will be pushed i.e. /in or /out or /Payments/inbound
  • Trigger Workflow After Export - workflow selected will be triggered to all records after export.
  • Export File Name - file name of the file can be specified including stamp date. It is recommended to append a timestamp. To stamp the date, use [YYYY],[YY],[MM],[DD],[HH],[mm]. i.e. MyExportedReport_[YYYY]-[MM]-[DD].  Note that the file extension should not be included in this section i.e. PaymentDetails_[YYYY]-[MM]_[DD]   and NOT "PaymentDetails_[YYYY]-[MM]_[DD].csv"  The extension of the file should be specified in the a.) Export Format dropdown in the File Export tab  for standard File Export or b.) File Extension textbox in the Custom Export tab for custom export reports
  • Last Exported - date of the last export .


Example

  • Export Every Monday of the week @ 0900
    • Choose a future date that falls on a Monday for the Start Date, Weekly for the Frequency and select the Time of Export dropdown list.
  • Choose 15th (future date) for the Start Date and Monthly for the Frequency and select the Time of Export dropdown list.
    • Export Every 15th of the month

Troubleshooting

  • This won't work for reports that have any criteria, or reports with any other variables that require a user session or user input - for instance, the setting that allows you to select a template from a SmartFolder before exporting. Reports violating these will either not be exported, or have no data when exported, or maybe some other unpredictable result.
  • To reset/change the schedule, Disabled the Frequency then save it. This will delete the current setting configurations from the database. Then, enter new schedule settings and save.
  • No option for Custom Export  is currently available