Difference between revisions of "Scheduled Report Export"

From SmartWiki
Jump to: navigation, search
(Scheduled Export)
(Configuration - Essentials)
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 +
__TOC__
 +
 
=Overview=
 
=Overview=
 
* [[System Administrator]]s can schedule report export to run periodically (daily, weekly, monthly, quarterly, yearly).
 
* [[System Administrator]]s 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 [[SmartFolders_Overview|SmartFolder]], or 2.) a sub-directory of a SSH File Transfer Protocol (SFTP) server.
 
* Scheduled report export can be configured to export a file to 1.) a [[SmartFolders_Overview|SmartFolder]], or 2.) a sub-directory of a SSH File Transfer Protocol (SFTP) server.
  
=Configuration=
+
=Configuration - Essentials=
 
''Scheduled Report Export'' is built using SmartSimple's [[Reports|integrated reporting subsystem]]. The settings for ''scheduled report export'' is available on the '''File Export''' tab of the Edit Reports page.
 
''Scheduled Report Export'' is built using SmartSimple's [[Reports|integrated reporting subsystem]]. The settings for ''scheduled report export'' is available on the '''File Export''' tab of the Edit Reports page.
  
===Scheduled Export===
+
'''Scheduled Export'''
 
On the '''Edit Report''' page, go to '''Scheduled Export''' tab.<br />
 
On the '''Edit Report''' page, go to '''Scheduled Export''' tab.<br />
 
To configure a scheduled report, the following settings are found from the '''Scheduled Export''' tab:
 
To configure a scheduled report, the following settings are found from the '''Scheduled Export''' tab:
Line 41: Line 43:
 
:** '''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.
+
'''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]
* '''Last Exported''' - date of the last export.
+
:* '''Last Exported''' - date of the last export.
 +
 
 +
=Configuration - Advanced=
 +
 
 
[[Category:Reports]]
 
[[Category:Reports]]

Revision as of 13:44, 13 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:2222
    • 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

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.
  • 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]
  • Last Exported - date of the last export.

Configuration - Advanced