You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hop.apache.org by gi...@apache.org on 2021/03/16 16:06:18 UTC
[incubator-hop-docs] branch asf-site updated: Documentation updated
to 7064072
This is an automated email from the ASF dual-hosted git repository.
git-site-role pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-hop-docs.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 633b789 Documentation updated to 7064072
633b789 is described below
commit 633b7896f1fcf4bcecc52e16c0e52e4f26f30f2b
Author: jenkins <bu...@apache.org>
AuthorDate: Tue Mar 16 16:06:15 2021 +0000
Documentation updated to 7064072
---
.../pipeline/transforms/google-sheets-input.adoc | 41 +++++++++++++++++
.../pipeline/transforms/google-sheets-output.adoc | 51 ++++++++++++++++++++++
.../workflow/actions/deleteresultfilenames.adoc | 6 +--
3 files changed, 95 insertions(+), 3 deletions(-)
diff --git a/hop-user-manual/modules/ROOT/pages/pipeline/transforms/google-sheets-input.adoc b/hop-user-manual/modules/ROOT/pages/pipeline/transforms/google-sheets-input.adoc
new file mode 100644
index 0000000..c4c2ce8
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/pages/pipeline/transforms/google-sheets-input.adoc
@@ -0,0 +1,41 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+:documentationPath: /pipeline/transforms/
+:language: en_US
+:page-alternativeEditUrl: https://github.com/apache/incubator-hop/edit/master/pipeline/transforms/googlesheets/src/main/doc/google-sheets-input.adoc
+
+= Google Sheets Input
+
+== Service Account Tab
+
+Lets you pick your Google service account client secret json file. The `Test` button Lets you test your access to the API. On success, you should see a success message.
+
+=== How to get a key file?
+
+First, make sure to enable the https://console.cloud.google.com/marketplace/product/google/sheets.googleapis.com[Sheets API]. Then create a service account. Go to your https://console.cloud.google.com/projectselector2/iam-admin/serviceaccounts[Google Cloud Platform console] and create a service account. Once that is done you can export a credentials JSON key file for the service account of your choice.
+
+
+== Spreadsheet tab
+
+This lets you specify or browse for spreadsheets existing in the service account drive or for the ones that are shared with the service account email.
+
+== Fields tab
+
+Lets you select from the fields of the sheet. Fields name are always defined in the first line of the Google spreadsheet.
+
+`Get Fields` lets you get fields and guess their types, format, precision, decimal and group delimiter as well as trim type.
+
diff --git a/hop-user-manual/modules/ROOT/pages/pipeline/transforms/google-sheets-output.adoc b/hop-user-manual/modules/ROOT/pages/pipeline/transforms/google-sheets-output.adoc
new file mode 100644
index 0000000..401fc7b
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/pages/pipeline/transforms/google-sheets-output.adoc
@@ -0,0 +1,51 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+:documentationPath: /pipeline/transforms/
+:language: en_US
+:page-alternativeEditUrl: https://github.com/apache/incubator-hop/edit/master/pipeline/transforms/googlesheets/src/main/doc/google-sheets-output.adoc
+
+= Google Sheets Output
+
+== Description
+
+Lets you write data into a sheet (existing or not) IMPORTANT NOTE : The API writes data in a "user entered mode" as if you were typing in the cells. That means the cells are interpreted by google after insert. Notice that it is better to transmit STRINGS to the transform to make it work reliably. Especially numbers can cause issues. Use a `Select Values` transform to convert to String values.
+
+**IMPORTANT** Make sure to specify an option to give RW (read/write) rights or domain wise rights. See below for the options. The easiest way is to specify an email address to share rights with.
+
+=== How to get a key file?
+
+First, make sure to enable the https://console.cloud.google.com/marketplace/product/google/sheets.googleapis.com[Sheets API]. Then create a service account. Go to your https://console.cloud.google.com/projectselector2/iam-admin/serviceaccounts[Google Cloud Platform console] and create a service account. Once that is done you can export a credentials JSON key file for the service account of your choice.
+
+== Service Account Tab
+
+Lets you pick your Google service account client secret json file. Lets you test your access to the API. On success, you should see the following screen
+
+== Spreadsheet tab
+
+* Spreadsheet key : Lets you specify or browse for spreadsheets existing in the service account drive or for the ones that are shared with the service account email. If you type in a sheet name (that does not exist in the drive) it will attempt to create a sheet it the `create` checkbox is ticked.
+
+* Worksheet Id : Should be browsed form the selected spreadsheet key. If you want to create a new file, type in any key that will become the name of the worksheet in the created spreadsheet
+
+* Append checkbox : Appends the lines without the header to an existing spreadsheet. This is incompatible with the create option below.
+
+* Create a sheet if it does not exist checkbox : If this checkbox is checked then if the Spreadsheet Key specified in the field Spreadsheet key does not exist it will create a new spreadsheet within the service account drive (note that this account has no UI)
+
+* Share with email : That is why the Share with user email field lets you specify the email of a user who will get full rights on the freshly created file.
+
+* Domain Wise Permission : Enables to share with your whole domain (if configured in Google Drive). For security concerns we share only with READ rights.
+
+**All the input fields of the transform are written to the output file.**
diff --git a/hop-user-manual/modules/ROOT/pages/workflow/actions/deleteresultfilenames.adoc b/hop-user-manual/modules/ROOT/pages/workflow/actions/deleteresultfilenames.adoc
index 748ab56..1998da3 100644
--- a/hop-user-manual/modules/ROOT/pages/workflow/actions/deleteresultfilenames.adoc
+++ b/hop-user-manual/modules/ROOT/pages/workflow/actions/deleteresultfilenames.adoc
@@ -28,8 +28,8 @@ Use this action to delete all the filenames that are in the result files list of
[width="90%", options="header"]
|===
|Option|Description
-|Workflow action name|The name of the workflow action. *Note*: This name has to be unique in a single workflow. A workflow action can be placed several times on the canvas, however it will be the same workflow action.
-|Limit action to| Enable this feature if you want to limit the deletion to certain filenames in the result file list.
+|Workflow action name|The name of the workflow action.
+|Limit action to|Enable this feature if you want to limit the deletion to certain filenames in the result file list.
|Wildcard|The regular expression to limit the files to delete
-|Exclude wildcard|The regular expression to exclude certain files from being deleted.
+|Exclude wildcard|The regular expression to exclude certain files from being deleted.
|===
\ No newline at end of file