Use the Format component

  • Release version: Australia
  • Updated March 12, 2026
  • 1 minute to read

    • Provide a placeholder and a value in a body of text by using the Format component in RPA Desktop Design Studio.

    Before you begin

    Role required: none

    About this task

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

    Procedure

    1. In the Toolbox pane, navigate to Utilities > String Utilities.
    2. Drag the Format component to the Design surface.
    3. To configure the input fields, see Configure port properties.
      You must insert is {0} as the placeholder.
    4. Connect the data and control ports of the Format component to the corresponding ports of the other components as described in the following table.
      Port type Purpose of connection
      Data In (_Format) Passes the text body and the placeholder from a previously executed component.

      Used to specify the format.

      Data type: String
      Data In (Input) Used to specify the input string that is replaced in given format.

      Data type: String
      Data Out (Return) Returns the text body with the placeholder value inserted in the placeholder.

      This method returns a string that represents formatted text.

      Data type: String
      Control In Connects to the Control Out port of one or more components.
      Control Out Connects to the Control In port of another component or the default end component.
    5. Optional: To test the component, under the DESIGN tab, click Run.