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 075f3c7 Documentation updated to bb960e8
075f3c7 is described below
commit 075f3c740f6e4551a85f32019b1616de3e6468b1
Author: jenkins <[email protected]>
AuthorDate: Thu Apr 15 10:48:54 2021 +0000
Documentation updated to bb960e8
---
.../pages/pipeline/transforms/mapping-input.adoc | 28 ++++++++++++++++
.../pages/pipeline/transforms/mapping-output.adoc | 25 ++++++++++++++
.../pages/pipeline/transforms/simple-mapping.adoc | 39 ++++++++++++++++++++++
3 files changed, 92 insertions(+)
diff --git
a/hop-user-manual/modules/ROOT/pages/pipeline/transforms/mapping-input.adoc
b/hop-user-manual/modules/ROOT/pages/pipeline/transforms/mapping-input.adoc
new file mode 100644
index 0000000..5cf67b7
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/pages/pipeline/transforms/mapping-input.adoc
@@ -0,0 +1,28 @@
+////
+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/plugins/transforms/mapping/src/main/doc/mapping-input.adoc
+= Mapping Input
+
+== Description
+
+This transform is not just a place-holder in a Mapping pipeline (referred to
as a Mapping), it represents and describes its input. The data of this input
will be provided for by the parent pipeline calling the mapping.
+
+== Options
+
+The fields described in this transform are those that you want to refer to in
this pipeline. When you use the mapping you can map input to these field names
to arrive at a re-usable part of a pipeline.
diff --git
a/hop-user-manual/modules/ROOT/pages/pipeline/transforms/mapping-output.adoc
b/hop-user-manual/modules/ROOT/pages/pipeline/transforms/mapping-output.adoc
new file mode 100644
index 0000000..0f8febf
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/pages/pipeline/transforms/mapping-output.adoc
@@ -0,0 +1,25 @@
+////
+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/plugins/transforms/mapping/src/main/doc/mapping-output.adoc
+= Mapping Output
+
+== Description
+
+This transform serves as a way to tell the parent pipeline that data can be
retrieved in this specific location.
+In other words, it represents and describes the output of the mapping
pipeline. The data entering this transform will be streamed to the parent
pipeline calling the mapping.
diff --git
a/hop-user-manual/modules/ROOT/pages/pipeline/transforms/simple-mapping.adoc
b/hop-user-manual/modules/ROOT/pages/pipeline/transforms/simple-mapping.adoc
new file mode 100644
index 0000000..2802464
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/pages/pipeline/transforms/simple-mapping.adoc
@@ -0,0 +1,39 @@
+////
+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/plugins/transforms/mapping/src/main/doc/simple-mapping.adoc
+= = Simple Mapping
+
+== Description
+
+A Mapping transform allows you to re-use a series of transforms in the form of
a "re-usable pipeline" also known as a "Mapping". In the "Simple Mapping"
transform you can specify one xref:mapping-input.adoc[Mapping Input] transform
to pass data to and one xref:mapping-output.adoc[Mapping Output] transform to
retrieve rows of data from.
+
+== Options
+
+The options are fairly self-explanatory:
+
+* Transform name: a unique name in your pipeline
+* Pipeline: The name of the mapping (sub-) pipeline to embed. This pipeline
is executed separately and is considered a separate entity. It is always
executed with a standard local Hop pipeline run configuration since that is
currently the only one capable of streaming data into and out of transforms.
+* Parameters tab: specify the parameters you want to pass to the mapping
pipeline
+* Input tab: specify which fields to pass to the
xref:mapping-input.adoc[Mapping Input] transform in the mapping. You can map
(hence the name) field names.
+* Output tab: specify how to rename output fields retrieved from the
xref:mapping-output.adoc[Mapping Output] transform.
+
+== Sample
+
+In the samples project you can find a small example of the Simple Mapping
transform called `mapping-use.hpl'.
+
