Step Details | |
Introduced in Version | --- |
Modified in Version | 7.12.0 |
Location | Data > Text |
Utilizing the Format Text step (located under Toolbox > DATA > TEXT) allows users to format an Object in Decisions using .NET String.Format methodology. String.Format allows the ability to convert Object values into Strings via the provided Format String. For more information on how to use String.Format see Microsoft: String.Format Method.
Properties
Input
Property | Description | Data Type |
---|---|---|
Input | Represents the Object that will be added to the Format String INPUT. | Object |
Format String | String to manipulate using the Input. | String |
Example
- From Decisions Studio, select the CREATE FLOW button on the Global Action Bar. Then, CREATE a new Flow.
- From the Flow Designer, from Toolbox > FAVORITE STEPS, attach a Create Data step to the Start step.
- From the Create Data step's Properties tab, select SHOW EDITOR.
- Provide a NAME (for this example "YearValue") for the Data to Create, then select Int32 [Number] from the TYPE drop-down, and define the INPUT as "2021". Save the Data then close via X.
- Back in the Flow Designer, under Toolbox > DATA > TEXT, attach a Format Text step to the Done path of the Create Data. Then connect the Format Text step's Done path to the End step.
From the Properties tab of the Format Text step, Select From Flow map YearValue to Input.
More on InputThe Input Object represents the Object that will be converted via the Format String INPUT.Still in the Properties of the Format Text step, Constant map the desired Format String.
Format String ConfigurationInput the following under Format String "The current year is .; "Save the Flow, then if desired close via X.
Debug
- From the Flow Designer, click the Debug link on the top Action Bar, then click START DEBUGGING.
- After the Flow runs, select Format Text 1 > Execution 1 > View Output Data.About Debug ResultsThe resulting Output Data will display in the form of the Format String with the period character being replaced by define Input.
Related Information
Forum Posts:
What Does The Format Text Step Do?