Changes

Jump to: navigation, search

Scheduled Report Export

5,764 bytes added, 20:46, 9 August 2022
Configuration - Essentials
=Overview=
* [[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]]/[[SmartFolders_Overview#Configuration_-_Advanced|Configuration Folder]], or 2.) a sub-directory of a SSH File Transfer Protocol (SFTP) server.
=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 Export'''On the '''Edit Report''' page, go to to '''Scheduled Export''' tab.<br />To configure a scheduled reporton the left hand side menu, the following settings are found from and then to the '''Scheduled Export''' tab:.
[[File:ScheduledExport.PNG|800px]]
 
'''
The following settings are found from the <strong>Scheduled Export''' tab:</strong>
* '''Export Type''' - specify the type of export for the scheduled export
: ''Options:''
:* File Export - export file based on settings from [[Exporting_Reports|'''File Export''']] tab
:* Custom Export - export file based on settings from [[Custom_Export|'''Custom Export''']]tab * '''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.
* '''Do not export file when no record found  '''-  no file will be exported when this toggle is enabled
* '''Export with Linked Reports '''- this feature can be used to extend the number of columns past the current limit by joining multiple reports. This feature is only available for report exports using File Export format. 
* '''Activate '''- this toggle should be enabled for scheduled/in demand export.
* '''Run Type''' -  choose from the dropdown
** '''On Demand '''- used when the report is linked to an autoloader
** '''Scheduled '''- choose frequency for scheduled export of this report
* '''Frequency''' - How often should the report be exported.
: ''Options:''
:* DisabledEvery Day:* DailyEvery Week:* WeeklyEvery Month:* MonthlyEvery Year:* QuarterlyCustom * '''Hours''' - specify time for the scheduled export* '''Start Date''' - specify the start date for the scheduled export <span style="color:#ff0000;">Settings below are available after the March 2020 upgrade.</span> * Yearly'''Export to Folder''' - the file can be exported to ** '''Folder Type''' - select a folder type where the file will be exported to.*** '''Configuration Folder'''*** '''SmartFolder'''** '''Folder''' - - select the subfolder where you would like the file to be saved.* '''Export to SFTP'''** '''Integration Key''' - select an existing integration key from the [[Integration Key Management]] from the dropdown list or click the "+" icon to create a new integration key.** '''SFTP Folder Path''' - sftp folder location where the files will be pushed i.e. /in or /out or /Payments/inbound* '''Encryption '''- the exported file from this report can now be encrypted by adding the PGP Encryption Key** '''PGP Encryption Key''' - select the key from the dropdown. If the keys are not added, you can add it** '''Encrypt file exported to selected folder''' - enable if you want the file sent to the SmartFolder/Configuration Folder to be encrypted** '''Encrypt file exported to SFTP '''- enable if you want the file sent to the SFTP to be encrypted :* '''Process On Demand Every Record After Export'''** '''Update Status''' - used when updates the status of every record in the report to the selected status from the drop down list. Note that a status change will trigger any workflows associated with the status being changed to. workflows will be triggered with this change of the status** '''Trigger Workflow''' - workflow selected will be triggered to all records after export.Note that '''Update Status''' will be processed first before '''Trigger Workflow''' is linked triggered.* '''Link Report Export''' - select another report that you want to link to this report to be processed after this report has been processed. * '''Send Email Notification On Completion''' - ability to email a list of users and or roles that will be emailed the exported file as an attachment.<!--94110 - Report Export - Scheduled Email Subscriptions-->** '''Email Template''' - select an autoloaderemail template for the emails sent to selected users** '''Roles''' - send emails to users based on their roles** '''Select Users''' - select users to send the email to** '''Attach Exported File in Email''' - option to attach the exported file on to the email sent out. Applicable only when the file is exported to a SmartFolder or a Configuration Folder* '''Send Email Notification When Export Failed''' - select users to send notification to** '''Users''' - select users you want to send failed notification to* '''Scheduled Export Status'''** '''Last Scheduled Exported''' - time and date of the last scheduled export.** '''Last Run''' - time and date of the last run.** '''Ad-Hoc Run''' - time and date of the last Ad-Hoc run  '''Example to configure schedule'''
* Export Every Monday of the week @ 0900** Choose a future date that falls on a Monday for the '''AtStart Date''', '''Weekly''' - specify time for the scheduled export'''Frequency''' and select the '''Time of Export''' dropdown list.* Export Every 15th of the month** Choose '''Starting15th''' - specify (future date) for the start date '''Start Date''' and '''Monthly''' for the scheduled export* '''Export toFrequency''' - and select where you want to export the file to'''Time of Export''' dropdown list.
=History Log=<!--85662 - Enhancement2 to the scheduled export from a report--><!--106718 - Log file size for Payments Integration - add Scheduled report history--><span style="color: #ff0000;">Available after March 2020 upgrade.</span> <br/>A new feature that shows history information tab. [[Image:ReportExportHistoryLog.PNG]]* '''#'Options:'' - item number:* '''Configuration FolderFile'''  - Select a Configuration Folder where you would like filename of the exported file to be saved.:* '''SmartFolderFile Size'''  - Select a [[SmartFolders_Overview|SmartFolder]] where you would like file size of the exported file to be savedin kb.:* '''sftpFile Export''' - status of the exported file.:** '''URL''Success' '''' - enter the url of file was successfully exported** '''''SFTP Failed''''' - file was not exported to the sftp site i.e. ** '''''Save to Folder Failed'''34.234.21.159'' or my.sftp.com or my.sftp.com:2222 - file was not exported to the [[SmartFolders_Overview|SmartFolder]]/[[SmartFolders_Overview#Configuration_-_Advanced|Configuration Folder]]:** '''Username''Saved to Folder; SFTP Failed'''' - username file was exported to allow access the [[SmartFolders_Overview|SmartFolder]]/[[SmartFolders_Overview#Configuration_-_Advanced|Configuration Folder]] but was not sent to the sftp:** '''Password''Save to Folder Failed; SFTP Failed'''''  - password to allow access file was not exported to the sftpand to [[SmartFolders_Overview|SmartFolder]]/[[SmartFolders_Overview#Configuration_-_Advanced|Configuration Folder]]** '''''Empty Report; No File Created''''' - file was created w/o any records or no file was created:** '''Path''Saved to Folder Failed; SFTP Sent' '''' - file was exported to the sftp folder location where but was not sent to the files will be pushed i.e. [[SmartFolders_Overview|SmartFolder]]/in or /out or /Payments/inbound[[SmartFolders_Overview#Configuration_-_Advanced|Configuration Folder]]* '''Start Time''' - date and time the file was processed for export* '''End Time''' - date and time the file export was completed* '''Update Status After Export'''  - status of the records will changed to the selected status after scheduled report export.** '''''Started''Trigger Workflow After Export'''  - workflow selected will be triggered to all records after export.when the file is being created** '''Export File Name''Completed'''''  - the file name of was exported** '''''Failed''''' - the file can failed to be specified including stamp dateexported** '''''Interrupted''''' - the process was terminated i. It is recommended to append a timestampe. To stamp the date, use [YYYY],[YYWhat_Is_Gort%3F|GORT],[MM],[DD],[HH],[mm]. was terminated abruptly (someone restarted the server)* '''Run By''' - name of the user who uploaded the file* '''Error''' - displays error i.e. MyExportedReport_[YYYY]-[MM]-[DD]sftp error:#Error: Permission denied:* '''Last ExportedProcess ID'''  - date unique identifier of the last export.process
=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, ''Example'Disabled''' the '''Frequency''' then save it. This will delete the current setting configurations from the database. Then, enter new schedule settings and save.
:*
:*:* 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.
:*:
:*:* Export Every 15th of the month
:*:: Choose '''15th''' (future date) for the '''Start Date''' and '''Monthly''' for the '''Frequency''' and select the '''Time of Export''' dropdown list.
=Configuration - Advanced=
[[Category:Reports]]
Smartstaff
1,385
edits

Navigation menu