{"id":116,"date":"2018-01-19T19:47:11","date_gmt":"2018-01-19T19:47:11","guid":{"rendered":"http:\/\/servoycomponents.dreamhosters.com\/?p=116"},"modified":"2024-03-14T15:42:50","modified_gmt":"2024-03-14T15:42:50","slug":"data-plugin","status":"publish","type":"post","link":"https:\/\/servoycomponents.com\/components\/plugins\/data-plugin","title":{"rendered":"Data Plugin"},"content":{"rendered":"<div class=\"wpb-content-wrapper\"><p>[vc_row][vc_column][vc_text_separator title=&#8221;OVERVIEW&#8221; i_icon_fontawesome=&#8221;fa fa-home&#8221; i_color=&#8221;custom&#8221; add_icon=&#8221;true&#8221; el_id=&#8221;overview&#8221; i_custom_color=&#8221;#126790&#8243;][vc_column_text]The Data Plugin enables you to\u00a0<strong>read, write and manipulate MS Excel\u00ae workbooks and sheets\u00a0<\/strong>from within your Servoy solution without the need to have MS Excel\u00ae installed.<\/p>\n<p>Exporting data can be done using a 2D array (vArray[][]), a dataset or a foundset<\/p>\n<p>The header can be retrieved from the input dataset or set separately via an array so you can create logical headers to the user or use i18n headers.<\/p>\n<p>Importing data returns a 2D array or a (again) a regular dataset.<\/p>\n<p>When using the readWorkBook and writeWorkBook methods it is possible to read and write a single cell, without touching\/removing the available formatting and functions.<br \/>\nSince version 3.3 it is also possible to create a new\u00a0<strong>Excel\u00a0<\/strong>sheet with\u00a0<strong>formatting\u00a0<\/strong>properties.<\/p>\n<p>To enable adding formatting options and functions we created a formatted dataset based on a &#8216;normal&#8217; dataset.<\/p>\n<p>With a the called\u00a0<strong>&#8216;FormattedDataset&#8217;\u00a0<\/strong>you can:<\/p>\n<ul class=\"square\">\n<li>set cell formatting<\/li>\n<li>set column formatting<\/li>\n<li>set borders<\/li>\n<li>add formula&#8217;s<\/li>\n<li>etc.<\/li>\n<\/ul>\n<p>[\/vc_column_text][vc_column_text css=&#8221;.vc_custom_1516394577462{border-left-width: 2px !important;padding-left: 10px !important;border-left-color: #1e73be !important;border-left-style: solid !important;border-radius: 1px !important;}&#8221;]The Data Plugin can\u00a0<strong>output\u00a0<\/strong>the following\u00a0<strong>formats\u00a0<\/strong>:<\/p>\n<ul>\n<li><i class=\"fa fa-file-excel-o\"><\/i>\u00a0\u00a0\u00a0<strong>XLS, XLSX, XLSM\u00a0<\/strong>MS Excel\u00ae<\/li>\n<li><i class=\"fa fa-file-pdf-o\"><\/i>\u00a0\u00a0\u00a0<strong>PDF\u00a0<\/strong>Portable Document Format<\/li>\n<li><i class=\"fa fa-file-text-o\"><\/i>\u00a0\u00a0\u00a0<strong>CSV\u00a0<\/strong>Tab or comma delimited<\/li>\n<li><i class=\"fa fa-file-text-o\"><\/i>\u00a0\u00a0\u00a0<strong>ODF\u00a0<\/strong>Open Document Format<\/li>\n<li><i class=\"fa fa-file-code-o\"><\/i>\u00a0\u00a0\u00a0<strong>HTML\u00a0<\/strong>HyperText Markup Language<\/li>\n<\/ul>\n<p>Next to outputting MS Excel\u00ae there are classes\/methods to direct\u00a0<strong>output\u00a0<\/strong>:<\/p>\n<ul>\n<li><i class=\"fa fa-file-text-o\"><\/i>\u00a0\u00a0\u00a0<strong>CSV\u00a0<\/strong>Tab or comma delimited files<\/li>\n<li><i class=\"fa fa-file-text-o\"><\/i>\u00a0\u00a0\u00a0<strong>DBF\u00a0<\/strong>DataBase File files<\/li>\n<li><i class=\"fa fa-file-code-o\"><\/i>\u00a0\u00a0\u00a0<strong>XML\u00a0<\/strong>EXtensible Markup Language files<\/li>\n<li><i class=\"fa fa-file-text-o\"><\/i>\u00a0\u00a0\u00a0<strong>TXT\u00a0<\/strong>Text files<\/li>\n<\/ul>\n<p>[\/vc_column_text][vc_text_separator title=&#8221;BENEFITS&#8221; i_icon_fontawesome=&#8221;fa fa-lightbulb-o&#8221; i_color=&#8221;custom&#8221; add_icon=&#8221;true&#8221; el_id=&#8221;benefits&#8221; i_custom_color=&#8221;#126790&#8243;][vc_column_text]<\/p>\n<ul class=\"square\">\n<li>To read, write and update\u00a0<strong>MS Excel\u00ae\u00a0<\/strong>files.<\/li>\n<li>To script the\u00a0<strong>import\u00a0<\/strong>of data.<\/li>\n<li>To script the\u00a0<strong>export\u00a0<\/strong>of data.<\/li>\n<li>To automatically type cast (convert the import &amp; export) data.<\/li>\n<\/ul>\n<p>In fact whenever working with MS Excel\u00ae is necessary the Data Plugin will be your Plugin of choice.[\/vc_column_text][vc_text_separator title=&#8221;COMPATIBILITY&#8221; i_icon_fontawesome=&#8221;fa fa-chain-broken&#8221; i_color=&#8221;custom&#8221; add_icon=&#8221;true&#8221; el_id=&#8221;compatibility&#8221; i_custom_color=&#8221;#126790&#8243;][vc_column_text]<\/p>\n<div>\n<div id=\"compatibility\" class=\"section scrollspy\">\n<div class=\"content\">\n<table class=\"compatibilityt\">\n<thead>\n<tr>\n<th><img loading=\"lazy\" decoding=\"async\" src=\"\/wp-content\/uploads\/2018\/01\/servoy.gif\" width=\"16\" height=\"16\" \/><\/th>\n<th><img loading=\"lazy\" decoding=\"async\" src=\"\/wp-content\/uploads\/2018\/01\/javavm.gif\" width=\"16\" height=\"16\" \/><\/th>\n<th>Smart client<\/th>\n<th>Headless client<\/th>\n<th>Web client<\/th>\n<th>Mobile client<\/th>\n<th>NG client<\/th>\n<th id=\"mac\"><\/th>\n<th id=\"windows\"><\/th>\n<th id=\"linux\"><\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>8.0+<\/td>\n<td>1.6+<\/td>\n<td class=\"compat_check\"><\/td>\n<td class=\"compat_check\"><\/td>\n<td class=\"compat_check\"><\/td>\n<td>&#8211;<\/td>\n<td class=\"compat_check\"><\/td>\n<td class=\"compat_check\"><\/td>\n<td class=\"compat_check\"><\/td>\n<td class=\"compat_check\"><\/td>\n<\/tr>\n<tr>\n<td>7.0+<\/td>\n<td>1.6+<\/td>\n<td class=\"compat_check\"><\/td>\n<td class=\"compat_check\"><\/td>\n<td class=\"compat_check\"><\/td>\n<td>&#8211;<\/td>\n<td>n\/a<\/td>\n<td class=\"compat_check\"><\/td>\n<td class=\"compat_check\"><\/td>\n<td class=\"compat_check\"><\/td>\n<\/tr>\n<tr>\n<td>6.1+<\/td>\n<td>1.6+<\/td>\n<td class=\"compat_check\"><\/td>\n<td class=\"compat_check\"><\/td>\n<td class=\"compat_check\"><\/td>\n<td>n\/a<\/td>\n<td>n\/a<\/td>\n<td class=\"compat_check\"><\/td>\n<td class=\"compat_check\"><\/td>\n<td class=\"compat_check\"><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n<\/div>\n<p>[\/vc_column_text][vc_text_separator title=&#8221;DOCUMENTATION&#8221; i_icon_fontawesome=&#8221;fa fa-code&#8221; i_color=&#8221;custom&#8221; add_icon=&#8221;true&#8221; el_id=&#8221;documentation&#8221; i_custom_color=&#8221;#126790&#8243;][vc_column_text]We\u00a0<strong>published\u00a0<\/strong>our\u00a0<strong><a href=\"http:\/\/software.servoycomponents.com\/documentation\/data\/data.html\">API Specifications\u00a0<\/a><\/strong>for the Data Plug-in as a future and current reference.<\/p>\n<p>After downloading the Data Plug-in using our Components Manager a sample solution {servoy_root}\/solutions\/it2be-examples\/it2be-data.servoy is installed.<br \/>\nYou can import the sample solution into Servoy Developer and you will have some (basic) code examples of how to use the Data Plug-in.[\/vc_column_text][vc_text_separator title=&#8221;FAQ&#8221; i_icon_fontawesome=&#8221;fa fa-question-circle&#8221; i_color=&#8221;custom&#8221; add_icon=&#8221;true&#8221; el_id=&#8221;faq&#8221; i_custom_color=&#8221;#126790&#8243;][vc_toggle title=&#8221;I use the Data Plugin in a webclient but need a local copy of the output file.&#8221;]In the below example I make use of the Tools Plugin to save the file in a &#8216;safe&#8217; location on the webserver.<br \/>\nBut you can of course use your own method for that.<\/p>\n<p>By using the Servoy File Plugin as shown in the code example you can save (download) the resulting byte[] to the browser default &#8216;downloads&#8217; folder.<br \/>\nThis should do the trick!<\/p>\n<p><pre class=\"mfn-code\">vOutputFile = vExcel.write(plugins.it2be_tools.server().userHome + &quot;\/report.xls&quot;, null, vDataSet);&lt;\/p&gt;\n&lt;p&gt;application.output(vOutputFile, LOGGINGLEVEL.INFO);&lt;\/p&gt;\n&lt;p&gt;vData = plugins.file.readFile(vOutputFile);&lt;\/p&gt;\n&lt;p&gt;vResult = plugins.file.writeFile(&quot;report.xls&quot;, vData);&lt;\/p&gt;\n&lt;p&gt;application.output(vResult, LOGGINGLEVEL.INFO); <\/pre>\n[\/vc_toggle][vc_text_separator title=&#8221;RELEASE NOTES&#8221; i_icon_fontawesome=&#8221;fa fa-code-fork&#8221; add_icon=&#8221;true&#8221; el_id=&#8221;release_notes&#8221;]<pre class=\"mfn-code\">\n<!-- iframe plugin v.5.0 wordpress.org\/plugins\/iframe\/ -->\n<iframe loading=\"lazy\" src=\"https:\/\/servoycomponents.com\/update\/data.v5.release.notes\" width=\"100%\" height=\"300\" scrolling=\"yes\" class=\"iframe-class\" frameborder=\"0\"><\/iframe>\n<\/pre>\n[vc_text_separator title=&#8221;Free Trial&#8221; i_icon_fontawesome=&#8221;fa fa-credit-card&#8221; i_color=&#8221;custom&#8221; add_icon=&#8221;true&#8221; el_id=&#8221;buynow&#8221; i_custom_color=&#8221;#126790&#8243;][vc_row_inner][vc_column_inner width=&#8221;1\/3&#8243;]<div class=\"pricing-box  pricing-box-box\"><div class=\"plan-header\"><h2 class=\"title\">Developer<\/h2><div class=\"price\"><sup class=\"currency\">$<\/sup><span>500<\/span><sup class=\"period\"><\/sup><\/div><hr class=\"hr_color\" \/><p class=\"subtitle\"><big>One developer &amp; unlimited deployment<\/big><\/p><\/div><div class=\"plan-inside\"><span class=\"pi-content\"><\/p>\n<ul>\n<li><b>+50% p\/y<\/b><br \/>\nmaintenance fee<\/li>\n<\/ul>\n<p><\/span><\/div><div class=\"plan-footer\"><a href=\"https:\/\/subscriptions.zoho.com\/subscribe\/ecd30e00d022efa2293b765c8525987479bc88ff48c14354ad482bf477cf719e\/data-plugin-developer\" class=\"button button_theme has-icon\"  title=\"Free Trial\"><span class=\"button_icon\"><i class=\"icon-credit-card\" aria-hidden=\"true\"><\/i><\/span><span class=\"button_label\">Free Trial<\/span><\/a><\/div><\/div>\n[\/vc_column_inner][vc_column_inner width=&#8221;1\/3&#8243;]<div class=\"pricing-box  pricing-box-box\"><div class=\"plan-header\"><h2 class=\"title\">Site<\/h2><div class=\"price\"><sup class=\"currency\">$<\/sup><span>900<\/span><sup class=\"period\"><\/sup><\/div><hr class=\"hr_color\" \/><p class=\"subtitle\"><big>Team of developers &amp; unlimited deployment<\/big><\/p><\/div><div class=\"plan-inside\"><span class=\"pi-content\"><\/p>\n<ul>\n<li><b>+50% p\/y<\/b><br \/>\nmaintenance fee<\/li>\n<\/ul>\n<p><\/span><\/div><div class=\"plan-footer\"><a href=\"https:\/\/subscriptions.zoho.com\/subscribe\/ecd30e00d022efa2293b765c8525987479bc88ff48c14354ad482bf477cf719e\/data-plugin-site\" class=\"button button_theme has-icon\"  title=\"Free Trial\"><span class=\"button_icon\"><i class=\"icon-credit-card\" aria-hidden=\"true\"><\/i><\/span><span class=\"button_label\">Free Trial<\/span><\/a><\/div><\/div>\n[\/vc_column_inner][\/vc_row_inner][\/vc_column][\/vc_row]<\/p>\n<\/div>","protected":false},"excerpt":{"rendered":"<p>Read, Write and Update MS Excel\u00ae files.  Supports working with sheets as well as formatted data.<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[6],"tags":[],"_links":{"self":[{"href":"https:\/\/servoycomponents.com\/wp-json\/wp\/v2\/posts\/116"}],"collection":[{"href":"https:\/\/servoycomponents.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/servoycomponents.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/servoycomponents.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/servoycomponents.com\/wp-json\/wp\/v2\/comments?post=116"}],"version-history":[{"count":10,"href":"https:\/\/servoycomponents.com\/wp-json\/wp\/v2\/posts\/116\/revisions"}],"predecessor-version":[{"id":704,"href":"https:\/\/servoycomponents.com\/wp-json\/wp\/v2\/posts\/116\/revisions\/704"}],"wp:attachment":[{"href":"https:\/\/servoycomponents.com\/wp-json\/wp\/v2\/media?parent=116"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/servoycomponents.com\/wp-json\/wp\/v2\/categories?post=116"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/servoycomponents.com\/wp-json\/wp\/v2\/tags?post=116"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}