| //// |
| 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: /plugins/transforms/ |
| :language: en_US |
| :page-alternativeEditUrl: https://github.com/apache/incubator-hop/edit/master/plugins/transforms/setvariable/src/main/doc/setvariable.adoc |
| = Set Variables |
| |
| == Description |
| |
| This transform allows you to set variables in a workflow or in the virtual machine. It accepts one (and only one) row of data to set the value of a variable. |
| |
| == Options |
| |
| [width="90%", options="header"] |
| |=== |
| |Option|Description |
| |Transform name|Name of the transform. |
| |Apply formatting|When this option is set, it formats the value (date, numbers etc.) according to the format options. Otherwise no formatting is done. |
| |Field Name|Name of the field that is used |
| |Variable Name|Name of the variable to set (without ${...} or %%...%% sigils) |
| |Variable scope type a|Define the scope of the variable, possible options are: |
| |
| * Valid in the virtual machine: the complete virtual machine will know about this variable. |
| * Valid in the parent workflow: the variable is only valid in the parent workflow. |
| * Valid in the grand-parent workflow: the variable is valid in the grand-parent workflow and all the child workflows and pipelines. |
| * Valid in the root workflow: the variable is valid in the root workflow and all the child workflows and pipelines. |
| |
| |Default value|Name of the variable to set |
| |=== |
