Difference between revisions of "Scheduled Report Export"

From SmartWiki
Jump to: navigation, search
(Scheduled Export Settings)
(Scheduled Export Settings)
Line 10: Line 10:
 
::* File Export - export file based on settings from [[File_Export|'''File Export''']] tab
 
::* 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''']]
 
::* Custom Export - export file based on settings from [[Custom_Export|'''Custom Export''']]
:*'''Frequency''' - How often should the report be exported.
+
'''Frequency''' - How often should the report be exported.
:: ''Options:''
+
::: ''Options:''
::* Disabled
+
:::* Disabled
::* Daily
+
:::* Daily
::* Weekly
+
:::* Weekly
::* Monthly
+
:::* Monthly
::* Quarterly
+
:::* Quarterly
::* Yearly
+
:::* Yearly
:* '''Starting''' - specify the start date for the scheduled export
+
'''Starting''' - specify the start date for the scheduled export
::* '''Export to''' - select where you want to export the file to  
+
::* '''Export to''' - select where you want to export the file to
:: ''Options:''
+
''Options:''
::* SmartFolder  
+
:::* SmartFolder
:::* '''SmartFolder''' - Select a SmartFolder where you would like the file to be saved.
+
:::** '''SmartFolder''' - Select a 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 mft.myurl.com:2222 or sftp.myurl.com
+
:::** '''URL''' - enter the url of the sftp site i.e. ''34.234.21.159'' or mft.myurl.com:2222 or sftp.myurl.com
:::* '''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.
+
::'''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]

Revision as of 16:26, 10 April 2019

Overview

A report can be exported based on a schedule specified in the Report Settings. Scheduled Export feature will export a file from the report to 1.) a SmartFolder, or 2.) a sub-directory of a SSH File Transfer Protocol (SFTP) server.

Configuration

On the Edit Report page, go to Scheduled Export tab.

Scheduled Export Settings

  • 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

Starting - specify the start date for the scheduled export

  • Export to - select where you want to export the file to

Options:

  • SmartFolder
    • 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 mft.myurl.com:2222 or sftp.myurl.com
    • 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.

Export via SFTP

  • Frequency - How often should the report be exported.
Options:
  • Disabled
  • Daily
  • Weekly
  • Monthly
  • Export to - Select SFTP in order to transfer the file to another server.
  • URL - Enter the URL of the remote server.
  • Username - Used for authentication on the remote server.
  • Password - Used for authentication on the remote server.
  • Path - Default path on the remote server to transfer the file to.
  • Start Date - The file export will start from this date.
  • Time of Export - The file export will happen at this hour and minute.
  • Last Exported - Indicates when this report export ran last.