Skip to main content

Execute Function

UiPath.MicrosoftDynamics.Activities.ExecuteFunction

The Execute Function activity uses the Web API GET operation to execute a function (Function).

After executing the function, the activity outputs action specific field values (if applicable) and the status of the request (success/failure information) in a ResponseStatus object (MicrosoftDynamicsStatus) that you can use in subsequent activities (e.g., conditional logic).

How it works​

The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the Microsoft Dynamics Application Scope activity to your project.
  3. Add the Execute Function activity inside the Microsoft Dynamics Application Scope activity.
  4. Click the Configure button inside the Execute Action activity (this opens the Object Wizard).
  5. Select the Action you want to insert and enter values for the fields returned in the Object Wizard.
  6. Create and enter a ResponseStatus variable for the Output property, as well as, any fields that have a Direction value of Out.

    • Your input property values are sent in the GET operation request.

    • The operation returns the ResponseStatus and any other applicable field values to your output property variable(s).

      docs image

Configure​

To enter your Execute Function property values, you must use the Object Wizard by clicking the Configure button.

When you select a Function using the Object Wizard, the required in/out property fields are displayed for the selected action. Unlike the other activities in this package, you can not add or remove in/out property fields for an Function object.

For a complete list of the available fields for each object, see the Web API EntityType Reference in the Microsoft documentation.

Properties​

Common​

  • DisplayName - The display name of the activity. This field supports only strings or String variables.

Misc​

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Output​

  • ResponseStatus - The status of the request (success/failure information). Enter a ResponseStatus variable (UiPath.BAF.Models.ResponseStatus). The ResponseStatus object includes three properties that you can use in other activities.
    • Success - Boolean - Specifies whether the API request was successful.
    • ErrorCode - String - The response error if the API request is unsuccessful (Success=False).
    • Message - String - The error message.

Example​

The following image shows an example of the activity dependency relationship and input/output property values.

For step-by-step instructions and examples, see the Quickstart guide.

docs image