Component definition
This component creates a collection of strings by splitting a given string at a given delimiter. For example, the string "a,b,c,d,e" becomes a string collection with the following entries: "a", "b", "c", "d", "e".
Component icon
Definition of component input value or values
Configuration
Input Value Name |
Input Value Data Type |
Req'd |
Example Format |
Explanation |
Text To Split |
String |
Yes |
"a,b,c,d,e" |
This is the text that will be split up. It can be a process variable, a constant value, a dynamic value or the output from an embedded dynamic model. |
Delimiter |
TextDelimiter |
Yes |
NewLine |
What delimiter should be used when breaking the "Text To Split" into multiple strings. The possible values are "Other", "Space", "Tab" or "NewLine". If "Other" is chosen, then the delimiter text parameter becomes available/required |
Delimiter Text |
Char |
* |
, |
A single character to look for when breaking the "Text To Split" into multple strings. The final result will NOT contain this character in the resulting strings. It is not possible to split on a multiple character delimiter. |
Output Variable Name |
String |
Yes |
ItemList |
This is the name of the variable that will receive the list of strings split from the "Text To Split". |
Remove Empty Values |
Boolean |
Yes |
True |
Indicates whether to keep empty strings that result when two instances of the delimiter occur next to each other. For example, if set to true, "a,,b" will return just two values, "a" and "b", in the "Output Variable Name". If false, there would be three "a", "", "b". |
*When this field is required is described in the explanation field.
Definition of component output value or values
A variable with the name specified in "Output Variable Name" containing a collection of strings derived from "Text To Split". It's length will be one more than the number of delimiters in the original string unless "Remove Empty Values" is set to true.
Connection information
None
Component settings
None
Use case
Separate tags into separate values.
One way to use this component would be for processing a comma-delimited list of tags entered by the user. Perhaps as part of a ticket triaging process, the person doing the triage would be able to enter one or more tags into a field to help subsequent people in the resolution process more quickly see the nature of the ticket. In this case, the variable holding the list would be passed to this component. Parameters would be set as follows:
- Text To Split: userTags
- Delimiter: Other
- Delimiter Text: ','
- Output Variable Name: TicketTags
- Remove Empty Values: True
Remove Empty Values would likely be set to true in this case as empty tags are of no value.
One further note, this component will not remove trailing spaces so if the user types "connectivity, user account, password reset" as the tags, there will be a space before " user account" and " password reset". To correct this, loop through the resulting collection of strings and use the "Trim String" component to remove leading and trailing spaces.
[Example 2]
[Describe the use case. Insert screen shots or package files. Insert a description of how the settings are configured. Insert additional information about the use case that you are submitting.]