UiPath Marketplace

UiPath Marketplace Guide

Business Activity Framework

The Business Activity Framework ("BAF") enables a common, design-time user experience across multiple integrations.

Providing a set of wizards, the BAF gives you the following capabilities while you design and build your automation projects:

  • Connection test
    • Securely enter your user credentials to test your connection to the integrated software application.
  • Object selection
    • Easily select the type of object that you want to interact with from a drop-down list.
  • Data validation
    • Quickly validate your input property values by retrieving test data at design-time.


The BAF provides two wizards, one is to test your connection (Connection Wizard) and the other is to select your object and enter field values (Object Wizard).

Connection Wizard

The Connection Wizard is included in the scope activity. The purpose of the wizard is to validate your user credentials at design-time and enable the Object Wizard in subsequent activities.

The credential values that you enter in the Connection Wizard are DPAPI encrypted before being saved in the project XAML. To eliminate the risk of sharing stored credentials via the project XAML, decryption only works for the user that entered the credentials.

  • For example, if you save a workflow with your credentials and later share that workflow with a colleague, the decryption of your credentials will fail (with an error message) when your colleague tries to edit the workflow. Before your colleague can edit the workflow, they must re-enter credentials at design time.

The Connection Wizard is not intended to be used for runtime purposes. The values that you enter in the wizard do not populate the scope activity's properties. You should populate the scope property values according to the Credential Management guidelines.


To use the connection wizard:

  1. Click Configure (this opens the Connection Wizard).
  2. Enter the required credentials (e.g., Username, Password, and EndpointURL).
    • After all fields are populated the Connect button is enabled.
      • Because the wizard is intended for design-time use only, variables are not accepted.
  3. Click Connect and wait for the Connection Successful window.

Connection Wizard example

Object Wizard

The Object Wizard is included in activities that perform an action against a specific object type (e.g., insert, retrieve, update, and delete records). Not all activities in the package include an Object Wizard.

Unlike the Connection Wizard, the Object WIzard is used to collect your input property values for runtime use. When you select the object that you want to interact with, all of its fields are returned and made available for you to add as input/output properties for the activity. Additionally, the first record from the object table is retrieved with its data shown in the Sample Value column.

The Object Wizard also gives you the ability to validate your input property values using the Sample Value column. When you enter an object identifier, the wizard returns the values for each of the fields that you add as your input/output properties.


To use the object wizard:

  1. Click Configure (this opens the Object Wizard or Connection Wizard if you need to establish a connection).
    • If the Connection Wizard opens, enter the required credentials and click Connect (the Object Wizard automatically opens after the Connection Successful window closes).
  2. Select your Object from the drop-down list.
    • At a minimum, the object identifier field is shown with data in the Sample Value column. If the selected object has additional, mandatory input fields, they are also shown by default.
  3. Enter any additional fields (properties) that you want to include using the Add Single Field text box or Add Multiple Fields selection list.
    • Each field includes two input data fields Value and Sample Value.
    • The Value fields are the activity input/output properties.
      • You can enter an existing variable or create a new one by typing Ctrl + K and then enter your new variable name.
    • The Sample Value fields enable you to test your input property values.
      • To test your values, select the object and enter a record identifier value into the Sample Value and click the icon next to the field to retrieve the record data.
      • If you added additional fields, the values are returned in the Sample Value column.
  4. After entering your input properties in the Value field, click Done.

Object Wizard example - build and design


Object Wizard example - data validation

Updated about a year ago

Business Activity Framework

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.