Skip to content

Format Text

The FormatText component enables users to insert specified values (called Bookmarks) into preconfigured text templates. For instance, FormatText component can be used to replace Recipient Names, Email Addresses, Sender Names, etc. within email templates.

Screenshot

Supported Functions

To use the FormatText Editor:

  1. New bookmarks can be created by clicking on the icon.
  2. Each new bookmark is created using the flower brackets, with a number or index in the middle. For instance {0},{1}.
  3. Double-click the FormatText component title bar.
    The TextFormatEditor window is displayed.

    Screenshot

  4. Enter a common letter format to be displayed.

  5. In the FormatText Editor, place the bookmarks where users want the text to be replaced.

Ports

The FormatText component exposes Control In, Control Out, dynamic Data In, and Data Out ports by default.

Port Description
Control In Must be connected to the Control Out port of one or more components.
Control Out Must be connected to the Control In port of any other component.
Dynamic Data In Must be connected to the Data Out port of another component from where data is to be collected. Additional ports can be created by clicking on the icon on the component title bar.
Data Out Must be connected to the Data In port of another component where data is to be displayed. (String)

Properties

To edit the properties of the FormatText component, in the Properties window, change the required property. Users can edit the following properties:

Property Description
Search Search for the respective property.
Delay After Execution Specifies the wait time (in seconds) after the action is executed.
Delay Before Execution Specifies the wait time (in seconds) before the action is executed

Example

Lets consider an example of formatting a letter in FormatText component and then by replacing variables with various inputs.

Screenshot

To use the Format Text component:

  1. In the Toolbox, expand General.
  2. Drag the FormatText component and drop it on the design surface.
  3. Double-click the FormatText component title bar.
    The TextFormatEditor window is displayed.

    Screenshot

  4. Enter a common letter format to be displayed.

  5. In the letter, add parameters to the fields which is to be formatted. In this example, lets format the name and the company name.

    Screenshot

  6. Click OK.

  7. To define the parameters, in the title bar of the FormatText component, click . In this example, two fields in the letter are formatted, so two parameters are defined.

    Note

    Users can also override the existing data source for the parameter Data In port.
    To override the existing data source:
    a. Right-click the required Data In port.
    b. Click Override and change the data source.

    To learn more about overriding the data source of the data port, refer the override section.

  8. Add a Variable component to provide input to the variables in the FormatText component.

  9. To add the Variable component:

    • In the Toolbox, expand General.
    • Drag the Variable component and drop it on the design surface.
    • Click on the + icon , to add variables.
    • In the Variable_1 message box, enter the input for the first variable in the FormatText component.
    • Similarly, add more variables to provide inputs for the variables in the FormatText component.

  10. Add a MessageBox component to display output of the FormatText component.

  11. To add the MessageBox component:

    • In the Toolbox, expand General.
    • Expand the MessageBox component, drag Show component and drop it on the design surface.
  12. Connect:
    • The Control Ports of all components.
    • The Data Out ports of the Variable component to the Data In ports of the FormatText component.
    • The Data Out ports of the FormatText component to the Data In ports of the MessageBox component.
  13. In the toolbar, click Run.

    The output of the text written in the FormatText component with value from the Variable component is displayed.

    Screenshot