Difference between revisions of "Scheduled Report Export"
From SmartWiki
(→Configuration) |
(→Scheduled Export) |
||
| Line 8: | Line 8: | ||
===Scheduled Export=== | ===Scheduled Export=== | ||
| − | :* '''Export Type''' - specify the type of export for the scheduled export | + | To configure a scheduled report, the following settings are found from the '''Scheduled Export''' tab of the '''Edit Reports''': |
| − | + | ||
| − | : | + | [[File:ScheduledExport.PNG|800px]] |
| − | : | + | |
| − | + | *'''Export Type''' - specify the type of export for the scheduled export | |
| − | + | ||
| − | : | + | ''Options:'' |
| − | : | + | :** File Export - export file based on settings from [[File_Export|'''File Export''']] tab |
| − | : | + | :** Custom Export - export file based on settings from [[Custom_Export|'''Custom Export''']] |
| − | : | + | |
| − | : | + | *'''Frequency''' - How often should the report be exported. |
| − | : | + | ''Options:'' |
| − | + | :** Disabled | |
| − | + | :** Daily | |
| − | + | :** Weekly | |
| − | + | :** Monthly | |
| − | : | + | :** Quarterly |
| − | : | + | :** Yearly |
| − | : | + | |
| − | + | *'''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 [[SmartFolders_Overview|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. | ||
=== === | === === | ||
[[Category:Reports]] | [[Category:Reports]] | ||
Revision as of 12:30, 28 May 2019
Contents
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
Scheduled Report Export is built using SmartSimple's integrated reporting subsystem. The settings for scheduled report export is available on the Custom Export or Scheduled Export tab of the Edit Reports page.
On the Edit Report page, go to Scheduled Export tab.
Scheduled Export
To configure a scheduled report, the following settings are found from the Scheduled Export tab of the Edit Reports:
- 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
- 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.
