Use the Format Text component

  • Release version: Xanadu
  • Updated January 30, 2025
  • 1 minute to read

    • Format the text by using variable placeholders and line and tab variables with the Format Text component in RPA Desktop Design Studio. You can update the text and their positions easily by just updating the variable placeholders and the line and tab variables.

    Before you begin

    Role required: none

    About this task

    You can configure the properties for the Format Text component. For more information about these properties, see Properties of the General components.

    Procedure

    1. In the Toolbox pane, navigate to General > Format Text.
    2. Drag the Format Text component to the Design surface.
    3. To set the text placeholder variable, do the following steps.
      1. Click the add variable icon (Add variable icon.).
        A Data In port is added for each variable you add.
      2. To configure the variable value, see Configure port properties.
      3. Optional: Repeat the steps to add more variables and values.
    4. Click the component settings icon (Component settings icon.).
    5. Insert the text in the TEXT FORMAT EDITOR.
    6. Insert the text.
    7. Optional: Insert the line separator \n or tab separator \t variable at appropriate places within the text.
    8. Insert the text variable placeholders within the text body, wherever appropriate.
      Tip:
      To update the text, update the placeholder value.
    9. Connect the data and control ports of the Format Text component to the corresponding ports of the other component as described in the following table.
      Port type Purpose of connection Mandatory?
      Data In (Variable) Takes the variable value from a previously executed component. Yes
      Data Out (Formatted Output) Returns the formatted text and passes to the next component. Yes.

      To view the output, right-click the Return field and click Preview Data.
      Control In Passes the control from the previously executed component. Yes
      Control Out Passes the control to the next component. No. Connecting the port is optional.
    10. Optional: To test the component, under the DESIGN tab, click Run.