Use the SetProperty component

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 1 minute to read

    • Set a property within a JSON object by using the SetProperty component in the RPA Desktop Design Studio. You can also override a property within the JSON object.

    Before you begin

    Role required: none

    About this task

    To configure the properties of the SetProperty component, see Properties of the JSON utilities.

    Procedure

    1. In the Toolbox pane, navigate to Utilities > JSON.
    2. Drag the SetProperty component to the Design surface.
    3. To configure the input fields, see Configure port properties.
    4. Optional: Connect the data and control ports of the SetProperty component to the corresponding ports of the other components as described in the following table.
      Port type Port name Data type Purpose of connection Default value Mandatory? Notes
      Data In JsonObject Object Takes a JSON object. No default value No The property that you set in this component is added to the JSON object.
      Data In PropertyName String Takes the name of the property. No default value Yes
      Data In PropertyValue String Takes the value of the property. No default value Yes
      Data In Override Boolean If True, the component overrides an existing property in the JSON object with the property that you specify. Else, if False, it doesn't override any property. No default value No
      Data Out Return Object Returns the JSON object. Not applicable Not applicable
    5. Optional: To test the component, right-click the component bar and then click Run From Here.