__TOC__
=Overview=
{{SeqReportPageHeader}}
: See [[:Category:Plug-Ins for Microsoft Office|Plug-Ins for Microsoft Office]] for details
This article explains how to use the 2nd method, which is exporting.
=File Export=
[[Image:ReportExport.PNG]]
==Procedure==
* Click the '''Custom Export''' tab (formerly Advanced Export Settings).
The '''Custom Export''' window is displayed.
[[Image:Reps200.png]]
This window consists of the following settings:
* '''Header''' - Static or variables that you need to display at the top of the export file.
* '''Fields''' - A list of fields taken from the report that is being used to create the report. In addition, you can select two special settings – {tab} – used to add a tab character to the specification and {break} – used to add a line feed to the specification.
* '''Detail''' - You construct the actual record layout for the specification in this area. This section can consist of multiple lines.
* '''Footer''' - Static or variables that you need to display at the bottom of the export file.
* '''File Extension''' - The extension that you wish to associate with the export specifications. By setting this value to any valid Windows file extension, the appropriate [[Application|application]] will be launched when the data is exported.
Each field will be delimited by a tab character ({TAB}), and a line feed ({BREAK}) will be added to the end of each exported record.
* '''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==
By setting A report can be exported into a flat file with the following file extension, you define which program on your computer should be used to process the exported report data. Some common extensions that are useful for exporting data are:
* '''txt''' – Windows Notepad.
* '''csv''' - Comma Separated Values.
* '''xml''' - Extensible Markup Language (can be opened in Notepad).
1. Set the '''Extension''' to '''txt'''.
The report list is displayed and the '''Employee''' list report is now displayed with an '''Export''' button.
[[Image:Advanced export settings3.png|thumb|none|900px]]
5. Click the '''Export''' button.
7. Close the '''Notepad''' [[Application|application]].
==Export to Excel==If you change the extension '''IMPORTANT:''' In order to support '''xlsspecial characters'''such as French accented letters, euro symbols etc [[SmartSimple]] uses UTF-8 encoding. When opening exported files Microsoft Excel always imports using ASCII, then 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 file will be opened procedures outlined on the [[Exporting Reports with MS-Special Characters to Excel]] article.
1. Click the '''ReportsNote:''' tabIf the report has sub reports attached then you must set up the Custom Export settings for each of the sub report attached.
2===CSV Data Security===When exporting data into a CSV format, files can become vulnerable to [https://owasp. Click org/www-community/attacks/CSV_Injection malicious CSV injection attacks]. As a precautionary measure, an additional space will be added at the '''Edit''' button for beginning of any values starting with at signs ( @ ), plus signs ( + ), minus signs ( - ), piping symbols ( | ), or equals signs ( = ). Therefore, when you export a file from Platform3 into a CSV format and later need to import that file into another system, please ensure you trim the '''Employee List''' reportadditional space in front of any values.
3. Click ==Export to XML==If you change the''' Custom ExportFile extension''' to '''xml''' tab.<br />[[image:Advanced export settings, then the report will construct an XML document from the report results.png]]
You can specify 1. In the layout of '''Header''' section enter the report to be exported in XML declaration and open the next screenroot element, ''details'':
[[image:Advanced export settings2<pre><!--?xml version="1.png]]0" encoding="ISO-8859-1"?-->{BREAK}<details>{BREAK}</pre>
2. In the '''HeaderDetail''' section : you specify add the child elements, in the sample below the column headings for your report to be exportedchild is ''employee'' with subchildren ''firstname'', ''lastname'', ''salary'' and ''startdate''.
'''Fields''' drop down The {TAB}s and {BREAK}s will give the XML document proper indentation: gives a list of variables that correspond to the fields selected in the report through report builder.
'''Details''' section : you specify the fields for the report to be exported. The fields that you select will be displayed right to left in exported report so select the field for the last column first.<pre>{TAB}<employee>{BREAK}{TAB}{TAB}<firstname>@Users - First name@</firstname>{BREAK}{TAB}{TAB}<lastname>@Users - Last name@</lastname>{BREAK}{TAB}{TAB}<salary>@Users - Salary@</salary>{BREAK}{TAB}{TAB}<startdate>@Users - Start Date@</startdate>{BREAK}{TAB}</employee>{BREAK}</pre>
43. Change In the '''ExtensionFooter''' to '''XLS''' or '''CSV'''.section, close the root element:
5. Save the '''Layout'''.<pre> </details> </pre>
64. Return to the '''Report''' list and click the '''The Export''' buttonXML document opened in Notepad:<pre><?xml version="1.0" encoding="ISO-8859-1"?>
[[image:Advanced export settings3.png]]<details> <employee> <firstname>Peter</firstname> <lastname>Jahl</lastname> <salary>25000</salary> <startdate>11/05/2003</startdate> </employee> <employee> <firstname>Herry</firstname> <lastname>Lee</lastname> <salary>55000</salary> <startdate>27/02/2005</startdate> </employee> <employee> <firstname>Peter</firstname> <lastname>Manlee</lastname> <salary>75000</salary> <startdate>12/05/2001</startdate> </employee></details></pre>
==Exporting with Subreports==
In order to export a report that contains subreports or merged reports you must define the Advanced Export Settings for the subreports, as well as the main report.
<!--54913 - Ability to store report export to specified SmartFolder-->
<!--67965 - Extend schedule report export to custom template-->
'''Example:'''
* The '''File''' is opened following would export a report and subreport in MS-Excel.Comma Separated Values format (CSV):
[[Image:Excel report.png]]<pre>@Companies/Accounts - Company name@,@Companies/Accounts - Address 1@,@Companies/Accounts - City@,@Companies/Accounts - State@,@Companies/Accounts - Company ID@,@subreport_0@{BREAK}</pre>
=Custom Export=
The Custom Export settings allows users to configure the information they wish to export from SmartSimple to external applications such as MS Word, MS Excel or Quickbooks.
'''IMPORTANT:''' In order to support '''special characters''' such as French accented letters, euro symbols etc [[SmartSimple]] uses UTF-8 encodingImage:Reps200. 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 Excelpng|800px]] article.
This window consists of the following settings:
* '''Note:Header''' If - Static or variables that you need to display at the top of the export file.* '''Fields''' - A list of fields taken from the report that is being used to create the report has sub reports attached then . In addition, you must set up can select two special settings – {tab} – used to add a tab character to the specification and {break} – used to add a line feed to the specification.* '''Detail''' - You construct the Custom Export settings actual record layout for each the specification in this area. This section can consist of multiple lines.* '''Footer''' - Static or variables that you need to display at the bottom of the sub report attachedexport file.* '''File Extension''' - The extension that you wish to associate with the export specifications. By setting this value to any valid Windows file extension, the appropriate [[Application|application]] will be launched when the data is exported.
==Export to XML==
If you change the '''File extension''' to '''xml''', then the report will construct an XML document from the report results.
1. In the '''Header''' section enter the XML declaration and open the root element, ''details''Other settings:
* '''Delimiter''' - tab character ('''''{TAB}'''''), comma, semi-colon, colon* '''Line breaks''' - use either a UNIX line break ('''''{LINEFEED}''''') or a Windows line break ('''''{BREAK}''''')<pre!--56598 - Create custom export with UNIX breaks-->* '''Aggregate Functions in Header or Footer'''** '''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<!--?xml version="1.0" encoding="ISO-8859Ticket# 56482 -1"?Ability to Sum and Count in report custom export header-->{BREAK}</pre!--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]]
<details>{BREAK} </details>
==Using Custom Export to export in Excel==
1. Click the '''Reports''' tab.
2. Click the '''Edit''' button for the '''Employee List''' report.
23. In Click the '''DetailCustom Export''' section add the child elements, in the sample below the child is ''employee'' with subchildren ''firstname'', ''lastname'', ''salary'' and ''startdate''tab.<br />[[image:Advanced export settings.png]]
The {TAB}s and {BREAK}s will give You can specify the XML document proper indentation:layout of the report to be exported in the next screen
<pre>{TAB}{BREAK}{TAB}{TAB}@Users - First name@{BREAK}{TAB}{TAB}@Users - Last name@{BREAK}{TAB}{TAB}@Users - Salary@{BREAK}{TAB}{TAB}@Users - Start Date@{BREAK}{TAB}{BREAK}</pre>[[image:Advanced export settings2.png]]
3. In the '''FooterHeader''' section, close : you specify the root element:column headings for your report to be exported.
<pre> </pre>'''Fields''' drop down : gives a list of variables that correspond to the fields selected in the report through report builder.
4'''Details''' section : you specify the fields for the report to be exported. The Export XML document opened fields that you select will be displayed right to left in Notepad:exported report so select the field for the last column first.
4. Change the '''Extension''' to '''XLS''' or '''CSV'''.
<details> Peter Jahl 25000 11/05/2003 Herry Lee 55000 27/02/2005 Peter Manlee 75000 12/05/2001 </details>5. Save the '''Layout'''.
6. Return to the '''Report''' list and click the '''Export''' button.
[[Image:Advanced export settings3.png|thumb|none|900px]]
==Exporting with Subreports==In order to export a report that contains subreports or merged reports you must define the Advanced Export Settings for the subreports, as well as the main reportThe '''File''' is opened in MS-Excel.
'''Example[[Image:'''Excel report.png]]
* The following would =Export to SmartFolder or SFTP=A report can now be automated to export as report as per schedule on a report and subreport in Comma Separated Values format (CSV):daily, weekly, or monthly basis to a SmartFolder or an external SFTP site.
@Companies/Accounts - Company name@, @Companies/Accounts - Address 1@, @Companies/Accounts - City@, @Companies/Accounts - State@, @Companies/Accounts - Company ID@, @subreport_0@ {BREAK}Go to [[Scheduled Report Export]] on how to configure scheduled report exports.
==Export <!--54913 - Ability to store report export to specified SmartFolder==-->New ability to <!--67965 - Extend schedule and automate report exports to a SmartFolder or external SFTP site. You can now schedule a recurring task on a daily, weekly, or monthly basis to automatically run a report and export the contents. This first release is limited to the file export functionality, e.g. CSV, with support for custom export formatting coming in a future release.template-->
==See Also==
* [[Exporting List View Results to Microsoft Excel]]
* [[Report Variables]]
* [[Exporting Reports with Special Characters to Excel]]
* [[Exporting Multiple Lines Text Fields to HTML]]
* [[Using ReportProperty with a Word Merge Document]]
=See Also=
:* [[Exporting List View Results to Microsoft Excel]]
:* [[Report Variables]]
:* [[Exporting Reports with Special Characters to Excel]]
:* [[Exporting Multiple Lines Text Fields to HTML]]
:* [[Using ReportProperty with a Word Merge Document]]
{{PrevNextStart}} [[Creating a Dashboard to Display a Set of Charts]]
{{PrevNextMid}} Back to [[Reports]] Category {{PrevNextEnd}}
[[Category:Reports]] [[Category:XML]]
