Changes

A report * [[System Administrator]]s can be exported based on a schedule specified in the Report Settingsreport export to run periodically (daily, weekly, monthly, quarterly, yearly). '''* Scheduled Export''' feature will report export can be configured to export a file from the report 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. On the '''Edit Report''' page, go to '''Export''' on the left hand side menu, and then to the '''Scheduled Export''' tab. [[File:ScheduledExport.PNG|800px]] '''The following settings are found from the <strong>Scheduled Export''' tab:</strong>

=Configuration=On the * '''Edit Report''' page, go to '''Scheduled ExportType''' tab.<br /><br /> - specify the type of export for the scheduled export

:* 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 * '''Frequency''' - How often should the report be exported. 

:* 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 File Name''' - file name of the file can be specified including stamp date. It is recommended toappend 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]- Select SmartFolder [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 order the [[Custom_Export|'''Custom Export''']] tab for custom export reports.<span style="color: #ff0000;">Settings below are available after the March 2020 upgrade.</span> * '''Export to save Folder''' - the file can be exported to ** '''Folder Type''' - select a folder type where the file therewill be exported to.:*** '''Configuration Folder'''*** '''SmartFolder''' ** '''Folder''' - - Look up select the SmartFolder, subfolder where you would like the files file to be saved.:* '''Start DateExport 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.** '''Path''' - The file export sftp folder location where the files will start be pushed i.e. /in or /out or /Payments/inbound* '''Process On Every Record After Export'''** '''Update Status''' - 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 datechange 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 triggered.:* * '''Send Email Notification On Completion'Time '' - 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''' - The select an email 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 export will happen at this hour and minuteon 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** '''Scheduled Export Status'''*** '''Last Scheduled Exported''' - Indicates when this report time and date of the last scheduled export ran .*** '''Last Run''' - time and date of the last run.*** '''Ad-Hoc Run''' - time and date of the lastAd-Hoc run '''Example to configure schedule''' * 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 via SFTP''' 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]]* '''#''' - item number* '''FrequencyFile'''  - How often should filename of the report be exportedfile.:: * '''File Size'Options:'' - file size of the exported file in kb.::* Disabled'''File Export''' - status of the exported file.::* Daily* '''''Success''''' - the file was successfully exported::* Weekly* '''''SFTP Failed''''' - file was not exported to the sftp::* Monthly* '''''Save to Folder Failed''''' - file was not exported to the [[SmartFolders_Overview|SmartFolder]]/[[SmartFolders_Overview#Configuration_-_Advanced|Configuration Folder]]::** '''Export ''Saved toFolder; SFTP Failed''' '' - file was exported to the [[SmartFolders_Overview|SmartFolder]]/[[SmartFolders_Overview#Configuration_- Select _Advanced|Configuration Folder]] but was not sent to the sftp** '''''Save to Folder Failed; SFTP in order Failed''''' - file was not exported to transfer the sftp and 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** '''''Saved to Folder Failed; SFTP Sent''''' - file was exported to the sftp but was not sent to another server.the [[SmartFolders_Overview|SmartFolder]]/[[SmartFolders_Overview#Configuration_-_Advanced|Configuration Folder]]* '''Start Time''' - date and time the file was processed for export::* '''URLEnd Time'''  - Enter date and time the URL file export was completed* '''Status''' - status of the remote server.scheduled report export::* * '''''Started''Username'''  - Used for authentication on when the remote server.file is being created::* * '''''Completed''Password'''  - Used for authentication on the remote server.file was exported::** '''Path''Failed'''''  - Default path on the remote server file failed to transfer be exported** '''''Interrupted''''' - the file toprocess was terminated i.e.[[What_Is_Gort%3F|GORT]] was terminated abruptly (someone restarted the server)::* '''Start DateRun By'''  - The name of the user who uploaded the file export will start from this date* '''Error''' - displays error i.e.sftp error:#Error:Permission denied* '''Time of ExportProcess ID'''  - The file export unique identifier of the 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 happen at this hour and minuteeither not be exported, or have no data when exported, or maybe some other unpredictable result.::* To reset/change the schedule, '''Disabled'''the ''Last Exported'Frequency''' - Indicates when this report export ran lastthen save it. This will delete the current setting configurations from the database. Then, enter new schedule settings and save.