Changes

Jump to: navigation, search

Exporting Reports

169 bytes added, 16:12, 19 February 2021
Custom Export
=File Export=
[[Image:ReportExport.PNG]]
 
 
* '''Export Format''' - a dropdown list of different file format you can export the report to.
* '''Folder Type''' - can be exported to either a [[SmartFolders_Overview|SmartFolder]] or a [[SmartFolders_Overview#Configuration_-_Advanced|Configuration Folder]]
* '''Folder''' - choose the subfolder where you want to export the file to.
* '''Data Position''' -  determines the starting position of your list view results (the "data").
* '''Meta Data Position''' - determines the starting position of the report criteria (the "metadata"). If your report does not utilize [wiki/Criteria criteria], the Meta Data will be blank.
* '''Export File Name''' - set a filename that is applied when the report is exported. If left empty then the default name for exported file is "Book".
 
<pre>
Note: The syntax for both the "Data Position" and "Meta Data Position" fields is ''worksheet'';''column'';''row''
The default setting is 0;0;0 for both fields. This means that your list view results will be exported, with the topmost, leftmost value appearing in the first worksheet, in cell A1.
The numbering begins at zero, so the first worksheet, first column or first row would be referenced with a 0, as opposed to 1.<br /> Therefore, if you wanted either the list view results or the metadata to be placed in the<br /> third worksheet of your Excel file, starting in cell B4, you would enter ''2;1;3''<br /> The syntax for the first worksheet, cell A1 would be ''0;0;0''
</pre>
==File Extension==
'''IMPORTANT:''' In order to support '''special characters''' such as French accented letters, euro symbols etc [[SmartSimple]] uses UTF-8 encoding. When opening exported files Microsoft Excel always imports using ASCII, so special characters do not appear correctly. This is a flaw with Excel. In order to export data containing special characters to Excel use one of the procedures outlined on the [[Exporting Reports with Special Characters to Excel]] article.
'''Note:''' If the report has sub reports attached then you must set up the Custom Export settings for each of the sub report attached.
'''Note===CSV Data Security===When exporting data into a CSV format, files can become vulnerable to [https:''' If //owasp.org/www-community/attacks/CSV_Injection malicious CSV injection attacks]. As a precautionary measure, an additional space will be added at the report has sub reports attached then beginning of any values starting with at signs ( @ ), plus signs ( + ), minus signs ( - ), piping symbols ( | ), or equals signs ( = ). Therefore, when you must set up export a file from Platform3 into a CSV format and later need to import that file into another system, please ensure you trim the Custom Export settings for each additional space in front of the sub report attachedany values.
==Export to XML==
=Custom Export=
* Click the '''The Custom Export''' tab (formerly Advanced Export Settings)settings allows users to configure the information they wish to export from SmartSimple to external applications such as MS Word, MS Excel or Quickbooks.
The '''Custom Export''' window is displayed. [[Image:Reps200.png|800px]]
This window consists of the following settings:
** '''COUNT''' - count the total rows per report. '''''@COUNT('''''column_name''''')@'''''
** '''SUM''' - sum of a column in the report. '''''@SUM('''''column_name''''')@ '''''
** '''Current Date''' - add current date using standard format YYYY, YY, MM, DD, HH, mm** [[Sscalculation|sscalculation]] can also be used in the header or footer<!--Ticket# 56482 - Ability to Sum and Count in report custom export header--><!--Ticket# 122241 - To add current date in the header for custom export report-->
* Please refer to '''[[Exporting Reports with Total Group By]]''' when exporting reports when [[Using Total Group Options in Report Builder]]
 ==Using Custom Export to export in Excel==
1. Click the '''Reports''' tab.
<!--67965 - Extend schedule report export to custom template-->
 
=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
* '''File''' - filename of the exported file.
* '''File Size''' - file size of the exported file in kb.
* '''File Export''' - status of the exported file.
** '''''Success''''' - the file was successfully exported
** '''''SFTP Failed''''' - file was not exported to the sftp
** '''''Save to Folder Failed''''' - file was not exported to the [[SmartFolders_Overview|SmartFolder]]/[[SmartFolders_Overview#Configuration_-_Advanced|Configuration Folder]]
** '''''Saved to Folder; SFTP Failed''''' - file was exported to the [[SmartFolders_Overview|SmartFolder]]/[[SmartFolders_Overview#Configuration_-_Advanced|Configuration Folder]] but was not sent to the sftp
** '''''Save to Folder Failed; SFTP Failed''''' - file was not exported to 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 the [[SmartFolders_Overview|SmartFolder]]/[[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
* '''Status''' - status of the scheduled report export
** '''''Started''''' - when the file is being created
** '''''Completed''''' - the file was exported
** '''''Failed''''' - the file failed to be exported
** '''''Interrupted''''' - the process was terminated i.e. [[GORT|GORT]] was terminated abruptly (someone restarted the server)
* '''Run By''' - name of the user who uploaded the file
* '''Error''' - displays error i.e. sftp error:#Error: Permission denied
* '''Process ID''' - unique identifier of the process
=See Also=
Smartstaff
1,385
edits

Navigation menu