- Overview
- Custom activities
- Migrating activities to .NET 6
- Release notes
- Building workflow analyzer rules
- Building activities project settings
- Creating custom wizards
- Prioritize activities by scope
- UiPath.Activities.Api.Base
- UiPath.Studio.Activities.Api
- UiPath.Studio.Activities.Api.Activities
- IAnalyzerConfigurationService
- UiPath.Studio.Activities.Api.Analyzer.Rules
- UiPath.Studio.Analyzer.Models
- UiPath.Studio.Activities.Api.BusyService
- UiPath.Studio.Activities.Api.ExpressionEditor
- UiPath.Studio.Activities.Api.Expressions
- UiPath.Studio.Activities.Api.Licensing
- UiPath.Studio.Activities.Api.Mocking
- UiPath.Studio.Activities.Api.ObjectLibrary
- UiPath.Studio.Activities.Api.PackageBindings
- UiPath.Studio.Activities.Api.ProjectProperties
- UiPath.Studio.Activities.Api.ScopedActivities
- UiPath.Studio.Activities.Api.Settings
- UiPath.Studio.Activities.Api.Wizards
- UiPath.Studio.Activities.Api.Workflow
- UiPath.Studio.Api.Controls
- UiPath.Studio.Api.Telemetry
- UiPath.Studio.Api.Theme
- Robot JavaScript SDK
- Triggers SDK
- Agents SDKs
Developer guide
UiPath.Studio.Analyzer.Models
In this section you can find more information on how to build activities using UiPath.Studio.Analyzer.Models.
ArgumentDirection
Represents an enumeration of the direction of an argument.
Properties
| Value | Description |
|---|---|
| Unset | Default value. |
| In | An argument that represents the flow of data into an activity or project. |
| Out | An Argument that represents the flow of data out of an activity or project. |
| InOut | An Argument that represents the flow of data into and out of an activity or project. |
| Property | Currently not used. |
IActivityContext
Represents the context of any activity inside the workflow.
Properties
| Type | Name | Description |
|---|---|---|
IReadOnlyCollection<IVariableModel> | Variables | The variables that are visible to this activity. |
IReadOnlyCollection<IArgumentModel> | DelegateArguments | The delegate arguments in that are visible to this activity. Requires Studio 2020.4 or later. |
IReadOnlyCollection<IArgumentModel> | WorkflowArguments | The arguments that are visible to this activity. |
| IProjectSummary | Project | Information about the project that contains this activity. |
IActivityModel
Represents an activity inside the workflow.
Inheritance
IInspectionObject > IActivityModel
Properties
| Type | Name | Description |
|---|---|---|
| string | Type | The assembly qualified type name of the activity. |
IReadOnlyCollection<IVariableModel> | Variables | The variables that are defined in this activity. |
IReadOnlyCollection<IArgumentModel> | DelegateArguments | The delegate arguments that are defined in this activity. Requires Studio 2020.4 or later. |
IReadOnlyCollection<IArgumentModel> | Arguments | The arguments that are defined in this activity. |
IReadOnlyCollection<IArgumentModel> | InternalArguments | The non-browsable arguments that are defined in this activity (BrowsableAttribute is set to false). |
IReadOnlyCollection<IPropertyModel> | Properties | The properties of this activity. |
IReadOnlyCollection<IPropertyModel> | InternalProperties | The non-browsable properties of this activity (BrowsableAttribute is set to false). |
IReadOnlyCollection<IActivityModel> | Children | The collection of child activities of this activity. |
| IActivityModel | Parent | The parent activity of this activity. |
| IActivityContext | Context | The context of this activity. |
IReadOnlyCollection<string> | ObjectReferences | The references in the object library that are used by this activity. |
| bool | SupportsObjectReferences | If set to True, this activity supports using the objects library. |
| string | ToolboxName | Activity name as registered in toolbox. Requires Studio 2020.10 or later. |
| string | AnnotationText | The text of the annotation. Requires Studio 2021.4 or later. |
| IPackageBindingModel | PackageBinding | Associated package binding for this activity. |
IArgumentModel
Represents an argument.
Inheritance
IMemberModel > IVariableModel > IArgumentModel
Properties
| Type | Name | Description |
|---|---|---|
| ArgumentDirection | Direction | The direction of this argument. |
ICaseModel
Represents a case activity inside a Switch activity.
Inheritance
IInspectionObject > ICaseModel
Properties
| Type | Name | Description |
|---|---|---|
| IActivityModel | Activity | The activity associated with this case. |
| string | CaseExpression | The expression that triggers this case. |
IReadOnlyCollection<IVariableModel> | Variables | The variables that are defined in this activity. |
IReadOnlyCollection<IArgumentModel> | Arguments | The arguments that are defined in this activity. |
IReadOnlyCollection<IPropertyModel> | Properties | The properties of this activity. |
IReadOnlyCollection<IActivityModel> | Children | The collection of child activities of this activity. |
| IActivityModel | Parent | The parent activity of this activity. |
| IActivityContext | Context | The context of this activity. |
IConnection
Represents a connection between two flowchart nodes.
Properties
| Type | Name | Description |
|---|---|---|
| string | KeyType | The assembly qualified name of the connection key. |
| string | KeyExpression | The key value of this connection. |
| IFlowNodeModel | Node | The source or destination of this connection. |
IDependency
Represents a project dependency.
Inheritance
Properties
| Type | Name | Description |
|---|---|---|
| string | Name | The name of the dependency. |
IReadOnlyCollection<string> | Assemblies | The list of referenced assemblies. |
IExpressionContainer
This feature was introduced in UiPath.Studio.Activities.Api v21.4.
Represents a workflow element containing expressions.
Inheritance
IInspectionObject > IWorkflowElement > IExpressionContainer
Properties
| Type | Name | Description |
|---|---|---|
| IEnumerable | GetExpressions() | Returns all expression models from this workflow element, for example variable default values, argument default values, property arguments expressions, conditions etc. |
| IEnumerable | GetChildExpressionContainers() | Returns all children that can be expression containers, for example activities, nodes, states, transitions. |
IExpressionModel
This feature was introduced in UiPath.Studio.Activities.Api v21.4.
Represents an expression model populated depending on the expression type (DefaultValue for variable and workflow argument or DefinedExpression for activity argument).
Inheritance
IMemberModel > IExpressionModel
Properties
| Type | Name | Description |
|---|---|---|
| string | DefaultValue | The default value of this variable or argument. |
IFileModel
Represents a file.
Inheritance
IInspectionObject > IFileModel
Properties
| Type | Name | Description |
|---|---|---|
| string | RelativePath | Relative path of the file, including extension. |
IFlowchartModel
Represents a Flowchart.
Inheritance
IInspectionObject > IActivityModel > IFlowchartModel
Properties
| Type | Name | Description |
|---|---|---|
IReadOnlyCollection<IFlowNodeModel> | Nodes | The collection of IFlowNodeModel in this flowchart. |
| IFlowNodeModel | StartNode | The start node in this flowchart. |
IFlowNodeModel
Represents a node in a flowchart.
Inheritance
IInspectionObject > IWorkflowElement > IExpressionContainer > IFlowNodeModel
Properties
| Type | Name | Description |
|---|---|---|
| IActivityModel | ChildActivity | The activity defined in this node. |
IReadOnlyCollection<IConnection> | OutConnections | The outgoing connections from this node. |
IReadOnlyCollection<IConnection> | InConnections | The incoming connections to this node. |
| IMemberModel | Expression | The expression that is evaluated to decide the next step. |
| IFlowChartModel | Owner | The flowchart owner of this node. |
IIfElseModel
Represents an If activity.
Inheritance
IInspectionObject > IActivityModel > IIfElseModel
Properties
| Type | Name | Description |
|---|---|---|
| IActivityModel | ThenBlock | The activity defined in the Then block. |
| IActivityModel | ElseBlock | The activity defined in the Else block. |
IInspectionObject
Represents an object that is inspected by the Workflow Analyzer.
Properties
| Type | Name | Description |
|---|---|---|
| string | DisplayName | The name of the object as it's shown to the user. |
IMemberModel
Represents a member of another model.
Properties
| Type | Name | Description |
|---|---|---|
| string | DisplayName | The name of the member as shown to the user. |
| string | Type | The assembly qualified name of this user. |
| string | DefinedExpression | The expression or value of this member. |
| bool? | HasLiteralExpression | Returns true if the defined expression is a Literal<string>. Requires Studio 2022.4 or later. |
Remarks
If the expression is a Literal<string> it will be escaped with double quotes, for example ""This is a plain string"".
IObjectBrowserSummary
This feature was introduced in UiPath.Studio.Activities.Api v22.4.
Information about Object Repository integration in the project.
Properties
| Type | Name | Description |
|---|---|---|
IReadOnlyCollection<IDependency> | ClientDependencies | Project dependencies that register for Object Repository features. |
| bool | HasObjectsInLocalSource | Returns true if at least one object is defined in the project local objects repository. |
IPackageReference
Represents a project package reference.
Inheritance
IInspectionObject > IFileModel > IDependency > IPackageReference
Properties
| Type | Name | Description |
|---|---|---|
| string | Version | The version of the package. |
IPickBranchModel
Represents a branch of a IPickModel activity.
Inheritance
IVariableContainer, IExpressionContainer > IPickBranchModel
Properties
| Type | Name | Description |
|---|---|---|
| IActivityModel | Trigger | The activity that triggers this branch. |
| IActivityModel | Action | The activity that executes in this branch. |
| IActivityModel | Parent | The parent Pick activity. |
Remarks
If the expression is a Literal<string> it will be escaped with double quotes, for example ""This is a plain string"".
IPickModel
Represents a Pick Branch activity.
Inheritance
IInspectionModel > IActivityModel > IPickModel
Properties
| Type | Name | Description |
|---|---|---|
| IEnumerable | PickBranches | The collection of IPickBranchModel defined in this Pick Branch activity. |
IProjectModel
Represents the complete project representation, including contained workflows parsing models. Project analysis is run against this model.
Inheritance
IInspectionObject > IProjectSummary > IProjectModel
Properties
| Type | Name | Description |
|---|---|---|
| IWorkflowModel | EntryPoint | The entry point workflow of the project. |
| IWorkflowModel | ExceptionHandlerWorkflow | The exception-handling workflow in the project. |
IReadOnlyCollection<IWorkflowModel> | Workflows | The workflows in the project. |
IProjectSummary
Represents partial information about a project. Unlike IProjectModel, an IProjectSummary only holds information available before the contained workflow files are being parsed. It is useful for workflow analysis and project definition analysis.
Inheritance
IInspectionObject > IProjectSummary
Properties
| Type | Name | Description |
|---|---|---|
| string | Directory | The project directory. Requires Studio 2021.4 or later. |
IReadOnlyCollection<string> | FileNames | The names of the workflow files in this project. |
IReadOnlyCollection<IDependency> | Dependencies | The dependencies of this project. |
| string | ProjectOutputType | The output type of this project.. |
| string | ProjectProfileType | The profile type of this project. |
| string | ExpressionLanguage | The expression language of this project |
| bool | RequiresUserInteraction | Indicates whether the project requires user interaction. |
| bool | SupportsPersistence | Indicates if project supports persistence. |
| bool | HasModernBehavior | Indicates if the project uses the modern design experience. Requires Studio 2022.4 or later. |
| string | EntryPointName | The entry point workflow name of the project. |
| string | ProjectFilePath | The file path to the project.json file. |
| string | ExceptionHandlerWorkflowName | The exception-handling workflow name of this project. |
IReadOnlyCollection<string> | EntryPoints | The list of entry points in the project. Requires Studio 2020.10 or later. |
IReadOnlyCollection<string> | IgnoredFiles | The list of files in the project that are ignored from publish. Requires Studio 2020.10 or later. |
IReadOnlyCollection<string> | TestCases | The list of test cases in the project. Requires Studio 2021.4 or later. |
IReadOnlyCollection<string> | FileTemplates | The list of file templates in the project. Requires Studio 2021.10 or later. Note: This property is deprecated. Use Templates instead. |
IReadOnlyCollection<string> | Templates | The list of all templates in the project. Requires Studio 2022.4 or later. |
| IObjectBrowserSummary | ObjectBrowserSummary | A summary of Object Repository information in the project. Requires Studio 2022.4 or later. |
IPropertyModel
Represents a property of a model.
Inheritance
IMemberModel > IPropertyModel
Properties
| Type | Name | Description |
|---|---|---|
IReadOnlyCollection<IPropertyModel> | Properties | The properties of this property. |
IReadOnlyCollection<IPropertyModel> | InternalProperties | The collection of non-browsable properties of this property (BrowsableAttribute set to false). Non-browsable properties are not parsed in depth. |
IReadOnlyCollection<IArgumentModel> | Arguments | The arguments of this property. |
IReadOnlyCollection<IArgumentModel> | InternalArguments | The collection of non-browsable arguments of this property (BrowsableAttribute set to false). |
IStateMachineModel
Represents a State Machine activity.
Inheritance
IInspectionObject > IActivityModel > IStateMachineModel
Properties
| Type | Name | Description |
|---|---|---|
| IReadOnlyCollection | States | The collection of IStateModel in this State Machine activity. |
| IStateModel | InitialState | The start point of this State Machine activity. |
IStateModel
Represents a State in a IStateMachineModel activity.
Inheritance
IInspectionObject, IVariableContainer, IExpressionContainer > IStateModel
Properties
| Type | Name | Description |
|---|---|---|
| IActivityContext | Context | The inherited context of this State. |
| IReadOnlyCollection | Transitions | The outgoing transitions available from this State. |
| IActivityModel | Entry | Entry action of the State. |
| IActivityModel | Exit | Exit action of the State. |
| IStateMachineModel | Owner | The State Machine activity containing this State. |
| bool | IsFinal | If true, indicates that this State is final. |
IReadOnlyCollection<IVariableModel> | Variables | The collection of variables defined in this State. |
ISwitchModel
Represents a Switch activity.
Inheritance
IInspectionObject > IActivityModel > ISwitchModel
Properties
| Type | Name | Description |
|---|---|---|
| IActivityModel | Default | The activity associated with the Default block of this activity. Value can be null. |
| IEnumerable | Cases | The collection of ICaseModel in this activity. |
ITemplateModel
This feature was introduced in UiPath.Studio.Activities.Api v22.4.
Contains information about a specific file template.
Properties
| Type | Name | Description |
|---|---|---|
| string | Path | The path of the template. |
| TemplateType | Type | The type of the template (execution, testCase, generic). |
| string | DataVariation | The path of the data variation. |
ITransition
Represents a transition from a IStateModel in a State Machine.
Inheritance
IInspectionObject, IVariableContainer, IExpressionContainer > ITransition
Properties
| Type | Name | Description |
|---|---|---|
| IStateModel | From | The state that this transition comes from. |
| IStateModel | To | The state that this transition leads to. |
| IActivityModel | Action | Activity to execute when the transition is taken. |
| IActivityModel | Condition | The condition to decide whether to take the transition after the Trigger activity is completed. |
| IActivityModel | Trigger | Trigger activity of this transition. |
ITryCatchModel
Represents a Try Catch activity.
Inheritance
IInspectionObject > IActivityModel > ITryCatchModel
Properties
| Type | Name | Description |
|---|---|---|
| IActivityModel | TryBlock | The activity associated with the Try block of this activity. Value can be null. |
| IEnumerable | Catches | The collection of in this activity. |
| IActivityModel | FinallyBlock | The activity associated with the Finally block. |
IVariableContainer
This feature was introduced in UiPath.Studio.Activities.Api v21.4.
Represents a workflow element containing variables.
Inheritance
IInspectionObject > IWorkflowElement > IVariableContainer
Properties
| Type | Name | Description |
|---|---|---|
IReadOnlyCollection<IVariableModel> | Variables | The collection of variables. |
| IEnumerable | GetChildVariableContainers() | Get the children that support a list o variables. |
IVariableModel
Represents a variable.
Inheritance
IMemberModel > IVariableModel
Properties
| Type | Name | Description |
|---|---|---|
| string | DefaultValue | The default value of this variable. |
IWebServiceRerefence
Represents a web service reference in the project.
Inheritance
IInspectionObject > IFileModel > IDependency > IWebServiceRerefence
Properties
| Type | Name | Description |
|---|---|---|
| string | WebDocumentUri | The web document address. |
| string | WebServiceType | The type of web service. |
IWorkflowElement
This feature was introduced in UiPath.Studio.Activities.Api v21.4.
Represents a workflow element.
Inheritance
IInspectionObject > IWorkflowElement
Properties
| Type | Name | Description |
|---|---|---|
| string | Id | The generated workflow ID. Can be null. |
| string | Type | The type of the workflow element |
| IWorkflowElement | ImmediateParent | The immediate parent of the workflow element. It can be a IFlowNodeModel, IStateModel, IPickBranchModel, ITransition, IActivityModel. |
| IEnumerable | GetChildren() | The immediate first level children (not only IActivityModel). |
IWorkflowModel
Represents a workflow file inside the project.
Inheritance
IInspectionObject > IFileModel > IWorkflowModel
Properties
| Type | Name | Description |
|---|---|---|
| IActivityModel | Root | The root activity of the workflow. Value can be null. |
IReadOnlyCollection<IArgumentModel> | Arguments | The arguments of the workflow. |
IReadOnlyCollection<string> | ImportedNamespaces | The imported namespaces of the workflow. |
| IProjectSummary | Project | The project this workflow belongs to. |
IReadOnlyCollection<string> | Assemblies | The assemblies of the workflow. Requires Studio 2021.4 or later. |
- ArgumentDirection
- Properties
- IActivityContext
- Properties
- IActivityModel
- Inheritance
- Properties
- IArgumentModel
- Inheritance
- Properties
- ICaseModel
- Inheritance
- Properties
- IConnection
- Properties
- IDependency
- Inheritance
- Properties
- IExpressionContainer
- Inheritance
- Properties
- IExpressionModel
- Inheritance
- Properties
- IFileModel
- Inheritance
- Properties
- IFlowchartModel
- Inheritance
- Properties
- IFlowNodeModel
- Inheritance
- Properties
- IIfElseModel
- Inheritance
- Properties
- IInspectionObject
- Properties
- IMemberModel
- Properties
- Remarks
- IObjectBrowserSummary
- Properties
- IPackageReference
- Inheritance
- Properties
- IPickBranchModel
- Inheritance
- Properties
- Remarks
- IPickModel
- Inheritance
- Properties
- IProjectModel
- Inheritance
- Properties
- IProjectSummary
- Inheritance
- Properties
- IPropertyModel
- Inheritance
- Properties
- IStateMachineModel
- Inheritance
- Properties
- IStateModel
- Inheritance
- Properties
- ISwitchModel
- Inheritance
- Properties
- ITemplateModel
- Properties
- ITransition
- Inheritance
- Properties
- ITryCatchModel
- Inheritance
- Properties
- IVariableContainer
- Inheritance
- Properties
- IVariableModel
- Inheritance
- Properties
- IWebServiceRerefence
- Inheritance
- Properties
- IWorkflowElement
- Inheritance
- Properties
- IWorkflowModel
- Inheritance
- Properties