hop-user-manual/modules/ROOT/pages/plugins/transforms/stringcut.adoc

////
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/stringcut/src/main/doc/stringcut.adoc
= Strings cut

== Description

The Strings cut transform allows you to cut a portion of a substring. If the designated field is out of range, it returns blank.

== Options

[width="90%", options="header"]
|===
|Option|Description
|Transform name|Name of the transform.
|In stream field|Name of the field whose substring to cut.
|Out stream field|When a field name is given here, the transform creates a new field with the substring. Otherwise the original field gets replaced by the substring.
|Cut from|Designate where to begin cutting the substring. This value is 0-based, thus the first character in a string is 0.
|Cut to|Designate where to end cutting the substring. This value is exclusive (1-based), so using a 1 includes the first character. The maximum length of the new string is Cut to minus Cut from.
|===

== Metadata Injection Support

All fields of this transform support metadata injection. You can use this transform with ETL Metadata Injection to pass metadata to your pipeline at runtime.