Skip to content

T
telecom
Commit 9a3fb415 authored by Roque Porchetto's avatar Roque Porchetto
Browse files
Options

erp5_wendelin_telecom_UI: documentation page

parent b5f6aa91
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 838 additions and 16 deletions
bt5/erp5_wendelin_telecom_UI/PathTemplateItem/web_page_module/fif_gadget_erp5_download_html.html
View file @ 9a3fb415
......@@ -15,6 +15,30 @@
</head>
<body>
<div style="max-width: 550px;">
<div class="document_table">
<table class="ui-responsive ui-body-c ui-table-inset">
<thead class="ui-bar-inherit thead">
<tr>
<th class="">EBULK TOOL</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Ebulk tool makes easy to exchange or archive very large data sets. It performs data set ingestions or downloads from different protocols, to Wendelin-IA platform. It also allows to perform local changes in data sets and to upload added and modified files. One key feature of Ebulk is to be able to resume and recover from errors happening with interrupted transfers.
</td>
</tr>
</tbody>
<tfoot>
</tfoot>
</table>
<form name='documentation'>
<input style="border-style:none;color:#2FA2E4;background-color:#FFFFFF;margin-top:0px" type="submit" value="See documentation" />
</form>
</div>
<div style="margin-top:60px" />
</div>
<div style="max-width: 550px;">
<div class="document_table">
<div class="ui-table-header ui-header ui-bar-c ui-corner-all">
......
bt5/erp5_wendelin_telecom_UI/PathTemplateItem/web_page_module/fif_gadget_erp5_download_html.xml
View file @ 9a3fb415
......@@ -232,7 +232,7 @@
</item>
<item>
<key> <string>serial</string> </key>
<value> <string>970.11122.1668.1894</string> </value>
<value> <string>971.50921.7199.13721</string> </value>
</item>
<item>
<key> <string>state</string> </key>
......@@ -250,7 +250,7 @@
</tuple>
<state>
<tuple>
<float>1536580954.4</float>
<float>1542814656.08</float>
<string>UTC</string>
</tuple>
</state>
......
bt5/erp5_wendelin_telecom_UI/PathTemplateItem/web_page_module/fif_gadget_erp5_download_js.js
View file @ 9a3fb415
/*global window, rJS, UriTemplate */
/*jslint indent: 2, maxerr: 3, nomen: true */
(function (window, rJS, UriTemplate) {
(function (window, rJS, UriTemplate, document) {
"use strict";
function documentation(context, evt) {
var link = document.createElement('a');
link.href = window.location.origin + "/erp5/web_site_module/fif_data_runner/#/?page=ebulk_doc";
link.click();
}
function download_linux(context, evt) {
var link = document.createElement('a');
link.download = "ebulk-v1.0.0.tar.gz";
link.download = "ebulk.tar.gz";
link.href = window.location.origin + "/erp5/data_stream_module/embulk_download_script/getData";
link.click();
}
function download_rpm(context, evt) {
var link = document.createElement('a');
link.download = "ebulk-v1.0.0-0.noarch.rpm";
link.download = "ebulk.rpm";
link.href = window.location.origin + "/erp5/data_stream_module/embulk_download_rpm/getData";
link.click();
}
function download_win(context, evt) {
var link = document.createElement('a');
link.download = "ebulk-v1.0.0.zip";
link.download = "ebulk.zip";
link.href = window.location.origin + "/erp5/data_stream_module/embulk_download_script_win/getData";
link.click();
}
......@@ -34,6 +39,9 @@
/////////////////////////////////////////////////////////////////
// declared methods
/////////////////////////////////////////////////////////////////
.declareJob('documentation', function (evt) {
return documentation(this, evt);
})
.declareJob('download_linux', function (evt) {
return download_linux(this, evt);
})
......@@ -54,9 +62,11 @@
return this.download_win(evt);
} else if (evt.target.name === 'download-rpm') {
return this.download_rpm(evt);
} else if (evt.target.name === 'documentation') {
return this.documentation(evt);
} else {
throw new Error('Unknown form');
}
});
}(window, rJS, UriTemplate));
\ No newline at end of file
}(window, rJS, UriTemplate, document));
\ No newline at end of file
bt5/erp5_wendelin_telecom_UI/PathTemplateItem/web_page_module/fif_gadget_erp5_download_js.xml
View file @ 9a3fb415
......@@ -228,7 +228,7 @@
</item>
<item>
<key> <string>serial</string> </key>
<value> <string>970.11125.18608.1365</string> </value>
<value> <string>971.50905.21982.62839</string> </value>
</item>
<item>
<key> <string>state</string> </key>
......@@ -246,7 +246,7 @@
</tuple>
<state>
<tuple>
<float>1536582214.81</float>
<float>1542813689.27</float>
<string>UTC</string>
</tuple>
</state>
......
bt5/erp5_wendelin_telecom_UI/PathTemplateItem/web_page_module/fif_gadget_erp5_ebulk_doc_html.html 0 → 100644
View file @ 9a3fb415
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, user-scalable=no" />
<title>EBULK DOC</title>
<!-- renderjs -->
<script src="rsvp.js" type="text/javascript"></script>
<script src="renderjs.js" type="text/javascript"></script>
<script src="jiodev.js" type="text/javascript"></script>
<!-- custom script -->
<script src="gadget_erp5_page_ebulk_doc.js" type="text/javascript"></script>
</head>
<body>
<h1 style="margin-bottom:15px" >Welcome to Ebulk tool documentation page</h1>
<h1 style="margin-bottom:15px;font-weight:bold" >DESCRIPTION</h1>
<p>Ebulk tool makes easy to exchange or archive very large data sets. It performs data set ingestion or download from different storage inputs, to Wendelin-IA platform (based on stack <a href="https://wendelin.nexedi.com/">Wendelin</a> - <a href="https://neo.nexedi.com/">NEO</a> - <a href="https://erp5.nexedi.com/">ERP5</a>). It also allows to perform local changes in data sets and to upload the added and modified files. One key feature of Ebulk is to be able to resume and recover from errors happening with interrupted transfers.</p>
<p style="margin-bottom:15px" />
<h1 style="margin-bottom:15px;font-weight:bold" >REQUIREMENTS</h1>
<p>Java 8: Ebulk relies on Embulk-v0.9.7 bulk data loader Java application (please see http://www.embulk.org/), so Java 8 is required in order to install Ebulk tool.</p>
<p style="margin-bottom:15px" />
<h1 style="margin-bottom:15px;font-weight:bold" >SYNOPSIS</h1>
<p style="margin-left:60px;"> ebulk [-h|--help] [-r|--readme] [-e|--examples] &lt;command&gt; [&lt;args>]</p>
<p style="margin-left:100px;"> [-d|--directory &lt;path&gt;] [-c|--chunk &lt;size&gt;]</p>
<p style="margin-left:100px;"> [-s|--storage &lt;storage&gt;] [-cs|--custom-storage]</p>
<p style="margin-left:100px;"> [-a|--advanced] [-dc|--discard-changes]</p>
<p style="margin-bottom:15px" />
<h1 style="margin-bottom:15px;font-weight:bold" >COMMANDS</h1>
<p style="font-weight:bold" >-h</p>
<p style="font-weight:bold" >--help</p>
<p>Prints the synopsis and the list of commands and options, with a brief explanation of them.</p>
<p style="margin-bottom:15px" />
<p style="font-weight:bold" >-r</p>
<p style="font-weight:bold" >--readme</p>
<p>Access the README file for a detailed explanation of Ebulk installation and usage.</p>
<p style="margin-bottom:15px" />
<p style="font-weight:bold" >-e</p>
<p style="font-weight:bold" >--example</p>
<p>Prints some basic examples about Ebulk usage.</p>
<p style="margin-bottom:15px" />
<p style="font-weight:bold" >pull [&lt;dataset&gt;]</p>
<p>Download operation: downloads the content of the specified remote data set from the Wendelin-IA site into the target output. By default, the output is a directory named as the data set.</p>
<p>&lt;dataset&gt; argument: unique reference of the remote data set. It is optional because if no data set is specified, the current directory will be used as data set reference and directory.</p>
<p>Data set reference must be one of the available datasets on the Wendelin-IA site.</p>
<p>Data set argument can be a path to a directory, then the directory name will be used as data set reference: e.g. ‘ebulk pull my_directory/sample/’ --&gt; data set reference will be sample. That directory will be linked to the data set reference, so any future operation on it will refer to that data set, no matter if the directory is moved or renamed.</p>
<p>If pull operation is run on a previously downloaded data set, the tool will offer the options to update it or download it from scratch, warning about any conflict with local changes.</p>
<p>pull options: [-d|--directory &lt;path&gt;] [-c|--chunk &lt;size&gt;] [-dc|--discard-changes]</p>
<p style="margin-bottom:15px" />
<p style="font-weight:bold" >push [&lt;dataset&gt;]</p>
<p>Ingestion operation: uploads the content of the specified input data set to the Wendelin-IA site. By default, the input data set is the directory named as the data set.</p>
<p>&lt;dataset&gt; argument: unique reference for the data set. It is optional because if no data set is specified, the current directory will be used as data set reference and directory.</p>
<p>Data set argument can be a path to a directory, then the directory name will be used as data set reference: e.g. ‘ebulk push my_directory/sample/’ --&gt; data set reference will be sample. That directory will be linked to the data set reference, so any future operation on it will refer to that data set, no matter if the directory is moved or renamed.</p>
<p>- New data set ingestion: an ingestion with a new data set reference will create a new data set on the site.</p>
<p>- Data set contribution: ingestion of local changes made on a previously downloaded data set. If no local changes were marked as ready for ingestion (see add/remove commands below), then by default the push command will use all the available local changes.</p>
<p>- Partial ingestion: allows to perform ingestions to a data set without downloading it previously, warning about any file conflict. This feature allows to upload portions of a very large dataset in parallel from different locations/computers.</p>
<p>push options: [-d|--directory &lt;path&gt;] [-c|--chunk &lt;size&gt;] [-s|--storage &lt;storage&gt;] [-cs|--custom-storage] [-a|--advanced]</p>
<p style="margin-bottom:15px" />
<p style="font-weight:bold" >status [&lt;dataset-path&gt;]</p>
<p>Lists the local changes in data set path. If no data set path is specified, the current directory will be used as data set directory. Lists any new, modified or deleted file in the local data set, indicating if they were marked for ingestion or not.</p>
<p style="margin-bottom:15px" />
<p style="font-weight:bold" >add &lt;path&gt;</p>
<p>Marks new or modified files in path as ready for ingestion. The path can be a specific file or a directory. Any file in path that has been added or modified will be set as ready, then a future push operation will use the marked files for the ingestion.</p>
<p style="margin-bottom:15px" />
<p style="font-weight:bold" >remove &lt;path&gt;</p>
<p>Marks the files in path for removal. The path can be a specific file or a directory. Any file in path (deleted or not) will be removed. Then a future push operation will delete from remote data set the files marked as removed. Note: if an existing file (not deleted) is marked for removal, the push operation will also delete it from local data set.</p>
<p style="margin-bottom:15px" />
<p style="font-weight:bold" >reset &lt;path&gt;</p>
<p>Resets marked files in path. The path can be a specific file or a directory. Any file previously marked for ingestion (add or remove) will be reset.</p>
<p style="margin-bottom:15px" />
<p style="margin-bottom:15px" />
<h1 style="margin-bottom:15px;font-weight:bold" >OPTIONS</h1>
<p style="margin-bottom:15px" />
<p style="font-weight:bold" >-d &lt;path&gt;</p>
<p style="font-weight:bold" >--directory &lt;path&gt;</p>
<p>Allows to use a custom location as data set directory. That directory will be linked to the data set reference, so any future operation on it will refer to that data set, no matter if the directory is moved or renamed.</p>
<p style="margin-bottom:15px" />
<p style="font-weight:bold" >-c &lt;size&gt;</p>
<p style="font-weight:bold" >--chunk &lt;size&gt;</p>
<p>Operations on large files are split into smaller chunks; by default, the size of the chunks is 50Mb. This command allows to set the size (in Megabytes) of the chunks in case is needed.</p>
<p style="margin-bottom:15px" />
<p style="font-weight:bold" >-dc</p>
<p style="font-weight:bold" >--discard-changes</p>
<p>Discards all the changes made in the local data set by downloading the corresponding original files from the remote data set.</p>
<p style="margin-bottom:15px" />
<p style="font-weight:bold" >-s &lt;storage&gt;</p>
<p style="font-weight:bold" >--storage &lt;storage&gt;</p>
<p>Uses the specified storage as input for data set ingestion. The storage must be one of the storages available in the installed Ebulk tool version. The tool will ask the corresponding inputs needed for that storage (like authentication, urls, etc.) and it will perform the ingestion of its content to the remote data set on the site. e.g. the command 'ebulk push my-dataset --storage ftp' allows to ingest the contents of a remote located dataset via ftp.</p>
<p style="margin-bottom:15px" />
<p style="font-weight:bold" >-a</p>
<p style="font-weight:bold" >--advanced</p>
<p>When using -s|--storage option, it allows to configure more advanced aspects of the specified storage, by editing the corresponding configuration file.</p>
<p style="margin-bottom:15px" />
<p style="font-weight:bold" >-cs</p>
<p style="font-weight:bold" >--custom-storage</p>
<p>Allows to use a custom storage as input that is not available yet in the tool. The storage must be one of the available in embulk site: 'http://www.embulk.org/plugins/#input'. The tool will attempt to automatically install the plugin and it will request the user to edit the corresponding configuration file.</p>
</body>
</html>
\ No newline at end of file
bt5/erp5_wendelin_telecom_UI/PathTemplateItem/web_page_module/fif_gadget_erp5_ebulk_doc_js.js 0 → 100644
View file @ 9a3fb415
/*global window, rJS, UriTemplate */
/*jslint indent: 2, maxerr: 3, nomen: true */
(function (window, rJS, UriTemplate) {
"use strict";
rJS(window)
/////////////////////////////////////////////////////////////////
// handle acquisition
/////////////////////////////////////////////////////////////////
.declareAcquiredMethod("redirect", "redirect")
.declareAcquiredMethod("getUrlFor", "getUrlFor")
.declareAcquiredMethod("jio_getAttachment", "jio_getAttachment")
.declareAcquiredMethod("translateHtml", "translateHtml")
.declareAcquiredMethod("updateHeader", "updateHeader")
/////////////////////////////////////////////////////////////////
// declared methods
/////////////////////////////////////////////////////////////////
.declareMethod("render", function () {
var gadget = this;
return gadget.updateHeader({page_title: 'Ebulk Documentation'});
});
}(window, rJS, UriTemplate));
\ No newline at end of file
bt5/erp5_wendelin_telecom_UI/PathTemplateItem/web_page_module/fif_gadget_erp5_panel_html.html
View file @ 9a3fb415
......@@ -29,7 +29,7 @@
<ul data-role="listview" class="ui-listview" data-enhanced="true">
<li class="ui-first-child"><a href="#" class="ui-btn ui-btn-icon-left ui-icon-home" data-i18n="Home">Home</a></li>
<li><a href="{{download_href}}" class="ui-btn ui-btn-icon-left ui-icon-download" data-i18n="Download">Download</a></li>
<!-- <li><a href="{{preference_href}}" class="ui-btn ui-btn-icon-left ui-icon-gear" data-i18n="Preferences">Preferences</a></li> -->
<li><a href="{{documentation_href}}" class="ui-btn ui-btn-icon-left ui-icon-file" data-i18n="Documentation">Documentation</a></li>
<li><a href="{{about_info_href}}" class="ui-btn ui-btn-icon-left ui-icon-user" data-i18n="About us">About us</a></li>
<li class="ui-last-child"><a href="{{logout_href}}" class="ui-btn ui-btn-icon-left ui-icon-power-off" data-i18n="Logout">Logout</a></li>
</ul>
......
bt5/erp5_wendelin_telecom_UI/PathTemplateItem/web_page_module/fif_gadget_erp5_panel_html.xml
View file @ 9a3fb415
......@@ -234,7 +234,7 @@
</item>
<item>
<key> <string>serial</string> </key>
<value> <string>970.10939.52629.39901</string> </value>
<value> <string>971.50940.53244.21196</string> </value>
</item>
<item>
<key> <string>state</string> </key>
......@@ -252,7 +252,7 @@
</tuple>
<state>
<tuple>
<float>1536570297.59</float>
<float>1542815894.62</float>
<string>UTC</string>
</tuple>
</state>
......
bt5/erp5_wendelin_telecom_UI/PathTemplateItem/web_page_module/fif_gadget_erp5_panel_js.js
View file @ 9a3fb415
......@@ -48,6 +48,7 @@
return RSVP.all([
g.getUrlFor({command: 'display', options: {page: "preference"}}),
g.getUrlFor({command: 'display', options: {page: "download"}}),
g.getUrlFor({command: 'display', options: {page: "ebulk_doc"}}),
g.getUrlFor({command: 'display', options: {page: "about"}}),
g.getUrlFor({command: 'display', options: {page: "logout"}})
]);
......@@ -59,8 +60,9 @@
panel_template_body({
"preference_href": all_result[0],
"download_href": all_result[1],
"about_info_href": all_result[2],
"logout_href": all_result[3]
"documentation_href": all_result[2],
"about_info_href": all_result[3],
"logout_href": all_result[4]
})
);
})
......
bt5/erp5_wendelin_telecom_UI/PathTemplateItem/web_page_module/fif_gadget_erp5_panel_js.xml
View file @ 9a3fb415
......@@ -230,7 +230,7 @@
</item>
<item>
<key> <string>serial</string> </key>
<value> <string>970.10971.34786.14882</string> </value>
<value> <string>970.10973.6487.62856</string> </value>
</item>
<item>
<key> <string>state</string> </key>
......@@ -248,7 +248,7 @@
</tuple>
<state>
<tuple>
<float>1536571985.93</float>
<float>1542814794.77</float>
<string>UTC</string>
</tuple>
</state>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7