- 概要
- カスタム アクティビティ
- アクティビティを .NET 6 に移行する
- リリース ノート
- ワークフロー アナライザーのルールを構築する
- アクティビティ プロジェクト設定の構成
- カスタム ウィザードの作成
- スコープによるアクティビティの優先度設定
- 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
- トリガー SDK
- エージェント SDK
開発者ガイド
このセクションでは、UiPath.Studio.Analyzer.Models を使用してアクティビティを構築する方法について詳しく説明します。
ArgumentDirection
引数の方向の列挙体を表します。
プロパティ
| 値 (Value) | 説明 |
|---|---|
| 未設定 | 既定値です。 |
| In | アクティビティまたはプロジェクトへのデータ フローを表す引数です。 |
| Out | アクティビティまたはプロジェクト外のデータ フローを表す引数です。 |
| Inout | アクティビティまたはプロジェクトとの間のデータ フローを表す引数です。 |
| プロパティ | 現在使用されていません。 |
IActivityContext
ワークフロー内の任意のアクティビティのコンテキストを表します。
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
IReadOnlyCollection<IVariableModel> | 変数 | このアクティビティに表示される変数です。 |
IReadOnlyCollection<IArgumentModel> | DelegateArguments | このアクティビティに表示される委任引数。 v2020.4 以降の Studio が必要です。 |
IReadOnlyCollection<IArgumentModel> | WorkflowArguments | このアクティビティに表示される引数です。 |
| IProjectSummary | プロジェクト | このアクティビティを含むプロジェクトに関する情報。 |
IActivityModel
ワークフロー内のアクティビティを表します。
継承
IInspectionObject > IActivityModel
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| string | 入力 | アクティビティのアセンブリ修飾型の名前です。 |
IReadOnlyCollection<IVariableModel> | 変数 | このアクティビティで定義されている変数です。 |
IReadOnlyCollection<IArgumentModel> | DelegateArguments | このアクティビティで定義されている委任引数。 v2020.4 以降の Studio が必要です。 |
IReadOnlyCollection<IArgumentModel> | 引数 | このアクティビティで定義されている引数です。 |
IReadOnlyCollection<IArgumentModel> | InternalArguments | このアクティビティで定義されている吹き込み不可の引数 (BrowsableAttribute は false に設定されています)。 |
IReadOnlyCollection<IPropertyModel> | プロパティ | このアクティビティのプロパティです。 |
IReadOnlyCollection<IPropertyModel> | InternalProperties | このアクティビティの browsable プロパティ ([BrowsableAttribute を False に設定]) です。 |
IReadOnlyCollection<IActivityModel> | 子 | このアクティビティの子アクティビティのコレクションです。 |
| IActivityModel | 親 | このアクティビティの親アクティビティです。 |
| IActivityContext | Context | このアクティビティのコンテキストです。 |
IReadOnlyCollection<string> | ObjectReferences | このアクティビティで使用されるオブジェクト ライブラリ内の参照です。 |
| Bool | SupportsObjectReferences | [ Trueに設定すると、このアクティビティでオブジェクト ライブラリの使用がサポートされます。 |
| string | ToolboxName | ツールボックスに登録されているアクティビティ名。 v2020.10 以降の Studio が必要です。 |
| string | AnnotationText | 注釈のテキストです。 v2021.4 以降の Studio が必要です。 |
| IPackageBindingModel | PackageBinding | このアクティビティに関連付けられたパッケージのバインドです。 |
IArgumentModel
引数を表します。
継承
IMemberModel > IVariableModel > IArgumentModel
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| ArgumentDirection | 方向 | この引数の方向です。 |
ICaseModel
[スイッチ] アクティビティ内のケース アクティビティを表します。
継承
IInspectionObject > ICaseModel
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| IActivityModel | アクティビティ | このケースに関連付けられたアクティビティです。 |
| string | CaseExpression | このケースをトリガーする式です。 |
IReadOnlyCollection<IVariableModel> | 変数 | このアクティビティで定義されている変数です。 |
IReadOnlyCollection<IArgumentModel> | 引数 | このアクティビティで定義されている引数です。 |
IReadOnlyCollection<IPropertyModel> | プロパティ | このアクティビティのプロパティです。 |
IReadOnlyCollection<IActivityModel> | 子 | このアクティビティの子アクティビティのコレクションです。 |
| IActivityModel | 親 | このアクティビティの親アクティビティです。 |
| IActivityContext | Context | このアクティビティのコンテキストです。 |
IConnection
2 つのフローチャート ノード間の接続を表します。
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| string | キーの種類 | 接続キーのアセンブリ修飾名です。 |
| string | KeyExpression | このコネクションのキーの値です。 |
| IFlowNodeModel | ノード | この接続のソースまたは宛先です。 |
IDependency
プロジェクトの依存関係を表します。
継承
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| string | 名前 | 依存関係の名前です。 |
IReadOnlyCollection<string> | アセンブリ | 参照アセンブリのリストです。 |
IExpressionContainer
この機能は UiPath.Studio.Activities.Api v21.4 で導入されました。
式を含むワークフロー要素を表します。
継承
IInspectionObject > IWorkflowElement > IExpressionContainer
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| IEnumerable | GetExpressions() | 変数の既定値、引数の既定値、プロパティ引数の式、条件など、このワークフロー要素のすべての式モデルを返します。 |
| IEnumerable | GetChildExpressionContainers() | 式コンテナーにできるすべての子 (アクティビティ、ノード、ステート、トランジションなど) を返します。 |
IExpressionModel
この機能は UiPath.Studio.Activities.Api v21.4 で導入されました。
式の型 (変数およびワークフローの引数の場合はDefaultValue 、アクティビティ引数の場合は DefinedExpression ) に応じて設定される式モデルを表します。
継承
IMemberModel > IExpressionModel
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| string | DefaultValue | この変数または引数の既定値です。 |
IFileModel
ファイルを表します。
継承
IInspectionObject > IFileModel
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| string | RelativePath | 拡張子を含むファイルの相対パスです。 |
IFlowchartModel
フローチャートを表します。
継承
IInspectionObject > IActivityModel > IFlowchartModel
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
IReadOnlyCollection<IFlowNodeModel> | Nodes | このフローチャートの IFlowNodeModel のコレクション。 |
| IFlowNodeModel | StartNode | このフローチャートの開始ノードです。 |
IFlowNodeModel
フローチャート内のノードを表します。
継承
IInspectionObject > IWorkflowElement > IExpressionContainer > IFlowNodeModel
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| IActivityModel | ChildActivity | このノードで定義されたアクティビティです。 |
IReadOnlyCollection<IConnection> | OutConnections | このノードからの発信接続です。 |
IReadOnlyCollection<IConnection> | InConnections | このノードへの受信接続です。 |
| IMemberModel | 式 | 次の手順を決定するために評価される式です。 |
| IFlowChartModel | 所有者 | このノードのフローチャート所有者です。 |
IIfElseModel
[条件分岐 (if)] アクティビティを表します。
継承
IInspectionObject > IActivityModel > IIfElseModel
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| IActivityModel | ThenBlock | [Then] ブロックで定義されたアクティビティです。 |
| IActivityModel | ElseBlock | [Else] ブロックで定義されたアクティビティです。 |
IInspectionObject
ワークフロー アナライザーによって検査されるオブジェクトを表します。
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| string | 表示名 | ユーザーに表示されるオブジェクトの名前です。 |
IMemberModel
別のモデルのメンバーを表します。
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| string | 表示名 | ユーザーに示されたメンバーの名前。 |
| string | 入力 | このユーザーのアセンブリー・修飾名。 |
| string | DefinedExpression | このメンバーの式または値です。 |
| bool? | HasLiteralExpression | 定義された式がLiteral<string>の場合にtrueを返します。v2022.4 以降の Studio が必要です。 |
備考
式が Literal<string> の場合、二重引用符でエスケープされます。例: ""This is a plain string""です。
IObjectBrowserSummary
この機能は UiPath.Studio.Activities.Api v22.4 で導入されました。
プロジェクトでのオブジェクト リポジトリの連携に関する情報。
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
IReadOnlyCollection<IDependency> | ClientDependencies | オブジェクト リポジトリ機能に登録するプロジェクト依存関係です。 |
| Bool | HasObjectsInLocalSource | プロジェクト のローカル オブジェクト リポジトリで少なくとも 1 つのオブジェクトが定義されている場合に true を返します。 |
IPackageReference
プロジェクト パッケージの参照を表します。
継承
IInspectionObject > IFileModel > IDependency > IPackageReference
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| string | バージョン | パッケージのバージョンです。 |
IPickBranchModel
IPickModel アクティビティのブランチを表します。
継承
IVariableContainer、 IExpressionContainer > IPickBranchModel
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| IActivityModel | トリガー | このブランチをトリガーするアクティビティです。 |
| IActivityModel | 操作 | このブランチで実行するアクティビティです。 |
| IActivityModel | 親 | 親 の [Pick] アクティビティです。 |
備考
式が Literal<string> の場合、二重引用符でエスケープされます。例: ""This is a plain string""です。
IPickModel
[分岐] アクティビティを表します。
継承
IInspectionModel > IActivityModel > IPickModel
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| IEnumerable | PickBranches | この [ブランチを選択] アクティビティで定義されている IPickBranchModel のコレクション。 |
IProjectModel
含まれるワークフローの解析モデルを含む、プロジェクトを完全に表します。 このモデルに対してプロジェクト分析が実行されます。
継承
IInspectionObject > IProjectSummary > IProjectModel
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| IWorkflowModel | EntryPoint | プロジェクトのエントリ ポイント ワークフロー。 |
| IWorkflowModel | ExceptionHandlerWorkflow | プロジェクト内の例外処理ワークフローです。 |
IReadOnlyCollection<IWorkflowModel> | ワークフロー | プロジェクト内のワークフローです。 |
IProjectSummary
プロジェクトに関する部分的な情報を表します。IProjectModel とは異なり、IProjectSummary は、含まれるワークフロー ファイルが解析される前に使用可能な情報のみを保持します。ワークフロー分析やプロジェクト定義分析に役立ちます。
継承
IInspectionObject > IProjectSummary
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| string | ディレクトリ | プロジェクト ディレクトリ。 v2021.4 以降の Studio が必要です。 |
IReadOnlyCollection<string> | FileNames | このプロジェクトにあるワークフロー ファイルの名前です。 |
IReadOnlyCollection<IDependency> | 依存関係 | このプロジェクトの依存関係です。 |
| string | ProjectOutputType | このプロジェクトの出力の種類です。 |
| string | ProjectProfileType | このプロジェクトのプロファイルの種類です。 |
| string | ExpressionLanguage | このプロジェクトの式言語です。 |
| Bool | RequiresUserInteraction | プロジェクトにユーザーの操作が必要かどうかを示します。 |
| Bool | 永続性をサポート | プロジェクトで永続性がサポートされているかどうかを示します。 |
| Bool | HasModernBehavior | プロジェクトがモダン デザイン エクスペリエンスを使用するかどうかを示します。 v2022.4 以降の Studio が必要です。 |
| string | EntryPointName | プロジェクトのエントリ ポイントのワークフロー名です。 |
| string | ProjectFilePath | project.json ファイルへのファイル パスです。 |
| string | ExceptionHandlerWorkflowName | このプロジェクトの例外処理ワークフローの名前です。 |
IReadOnlyCollection<string> | エントリ ポイント | プロジェクトのエントリ ポイントのリストです。 v2020.10 以降の Studio が必要です。 |
IReadOnlyCollection<string> | IgnoredFiles | パブリッシュから除外される、プロジェクト内のファイルのリストです。 v2020.10 以降の Studio が必要です。 |
IReadOnlyCollection<string> | テスト ケース | プロジェクト内のテスト ケースのリストです。 v2021.4 以降の Studio が必要です。 |
IReadOnlyCollection<string> | ファイル テンプレート | プロジェクト内のファイル テンプレートのリストです。v2021.10 以降の Studio が必要です。注: このプロパティは非推奨です。代わりに テンプレート を使用してください。 |
IReadOnlyCollection<string> | テンプレート | プロジェクト内のすべてのテンプレートのリストです。 v2022.4 以降の Studio が必要です。 |
| IObjectBrowserSummary | ObjectBrowserSummary | プロジェクト内のオブジェクト リポジトリの情報の概要です。 v2022.4 以降の Studio が必要です。 |
IPropertyModel
モデルのプロパティを表します。
継承
IMemberModel > IPropertyModel
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
IReadOnlyCollection<IPropertyModel> | プロパティ | このプロパティのプロパティです。 |
IReadOnlyCollection<IPropertyModel> | InternalProperties | このプロパティの参照不可プロパティのコレクション (BrowsableAttribute を falseに設定)。参照できないプロパティは詳細に解析されません。 |
IReadOnlyCollection<IArgumentModel> | 引数 | このプロパティの引数です。 |
IReadOnlyCollection<IArgumentModel> | InternalArguments | このプロパティの browsable 引数のコレクションです ([BrowsableAttribute] を [ falseに設定])。 |
IStateMachineModel
ステート マシン アクティビティを表します。
継承
IInspectionObject > IActivityModel > IStateMachineModel
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| IReadOnlyCollection | ステート | このステート マシン アクティビティの IStateModel のコレクション。 |
| IStateModel | InitialState | このステート マシン アクティビティの開始点です。 |
IStateModel
IStateMachineModel アクティビティの [ステート] を表します。
継承
IInspectionObject、 IVariableContainer、 IExpressionContainer > IStateModel
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| IActivityContext | Context | このステートの継承されたコンテキストです。 |
| IReadOnlyCollection | 遷移 | この [ステート] から利用可能な発信トランジションです。 |
| IActivityModel | エントリ | ステートのエントリ アクションです。 |
| IActivityModel | 終了 | [ステート] のアクションを終了します。 |
| IStateMachineModel | 所有者 | このステートを含む [ステート マシン] アクティビティ |
| Bool | IsFinal | true場合は、このステートが確定することを示します。 |
IReadOnlyCollection<IVariableModel> | 変数 | この State で定義された変数のコレクションです。 |
ISwitchModel
[条件分岐 (switch)] アクティビティを表します。
継承
IInspectionObject > IActivityModel > ISwitchModel
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| IActivityModel | 既定 (Default) | このアクティビティの [既定] ブロックに関連付けられたアクティビティです。 値は null にできます。 |
| IEnumerable | ケース | このアクティビティ内の ICaseModel のコレクション。 |
ITemplateModel
この機能は UiPath.Studio.Activities.Api v22.4 で導入されました。
特定のファイル テンプレートに関する情報が含まれます。
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| string | パス | テンプレートのパスです。 |
| TemplateType | 入力 | テンプレートの種類です (実行、testCase、generic)。 |
| string | DataVariation | データ バリエーションのパスです。 |
ITransition
ステート マシンの IStateModel からの遷移を表します。
継承
IInspectionObject、 IVariableContainer、 IExpressionContainer > ITransition
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| IStateModel | 元 | この遷移の由来ステートです。 |
| IStateModel | 先 | この移行の原因となるステートです。 |
| IActivityModel | 操作 | トランジションが実行されたときに実行するアクティビティです。 |
| IActivityModel | 条件 | [トリガー] アクティビティが完了した後に移行を実行するかどうかを決定する条件です。 |
| IActivityModel | トリガー | この移行のトリガー アクティビティです。 |
ITryCatchModel
[トライ キャッチ] アクティビティを表します。
継承
IInspectionObject > IActivityModel > ITryCatchModel
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| IActivityModel | TryBlock | このアクティビティの [Try] ブロックに関連付けられたアクティビティです。 値は null にできます。 |
| IEnumerable | 例外の発生時に実行する処理 (catch) です。 | このアクティビティのコレクションです。 |
| IActivityModel | FinallyBlock | [Finally] ブロックに関連付けられたアクティビティです。 |
IVariableContainer
この機能は UiPath.Studio.Activities.Api v21.4 で導入されました。
変数を含むワークフロー要素を表します。
継承
IInspectionObject > IWorkflowElement > IVariableContainer
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
IReadOnlyCollection<IVariableModel> | 変数 | 変数のコレクションです。 |
| IEnumerable | GetChildVariableContainers() | o 型変数のリストをサポートする子要素を取得します。 |
IVariableModel
変数を表します。
継承
IMemberModel > IVariableModel
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| string | DefaultValue | この変数の既定値です。 |
IWebServiceRerefence
プロジェクトの Web サービスの参照を表します。
継承
IInspectionObject > IFileModel > IDependency > IWebServiceRerefence
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| string | WebDocumentUri | Web ドキュメントのアドレスです。 |
| string | WebServiceType | Web サービスの種類です。 |
IWorkflowElement
この機能は UiPath.Studio.Activities.Api v21.4 で導入されました。
ワークフロー要素を表します。
継承
IWorkflowElement > IInspectionObject
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| string | ID | 生成されたワークフロー ID です。 null を指定できます。 |
| string | 入力 | ワークフロー要素の種類 |
| IWorkflowElement | ImmediateParent | ワークフロー要素の直接の親です。IFlowNodeModel、IStateModel、IPickBranchModel、ITransition、IActivityModel を指定できます。 |
| IEnumerable | GetChildren() | 直属の第 1 レベルの子 (IActivityModel だけでなく)。 |
IWorkflowModel
プロジェクト内のワークフロー ファイルを表します。
継承
IInspectionObject > IFileModel > IWorkflowModel
プロパティ
| 入力 | 名前 | 説明 |
|---|---|---|
| IActivityModel | ルート | ワークフローのルート アクティビティです。値は null にできます。 |
IReadOnlyCollection<IArgumentModel> | 引数 | ワークフローの引数です。 |
IReadOnlyCollection<string> | インポートされた名前空間 | インポートしたワークフローの名前空間です。 |
| IProjectSummary | プロジェクト | このワークフローが属するプロジェクト。 |
IReadOnlyCollection<string> | アセンブリ | ワークフローのアセンブリです。 v2021.4 以降の Studio が必要です。 |
- ArgumentDirection
- プロパティ
- IActivityContext
- プロパティ
- IActivityModel
- 継承
- プロパティ
- IArgumentModel
- 継承
- プロパティ
- ICaseModel
- 継承
- プロパティ
- IConnection
- プロパティ
- IDependency
- 継承
- プロパティ
- IExpressionContainer
- 継承
- プロパティ
- IExpressionModel
- 継承
- プロパティ
- IFileModel
- 継承
- プロパティ
- IFlowchartModel
- 継承
- プロパティ
- IFlowNodeModel
- 継承
- プロパティ
- IIfElseModel
- 継承
- プロパティ
- IInspectionObject
- プロパティ
- IMemberModel
- プロパティ
- 備考
- IObjectBrowserSummary
- プロパティ
- IPackageReference
- 継承
- プロパティ
- IPickBranchModel
- 継承
- プロパティ
- 備考
- IPickModel
- 継承
- プロパティ
- IProjectModel
- 継承
- プロパティ
- IProjectSummary
- 継承
- プロパティ
- IPropertyModel
- 継承
- プロパティ
- IStateMachineModel
- 継承
- プロパティ
- IStateModel
- 継承
- プロパティ
- ISwitchModel
- 継承
- プロパティ
- ITemplateModel
- プロパティ
- ITransition
- 継承
- プロパティ
- ITryCatchModel
- 継承
- プロパティ
- IVariableContainer
- 継承
- プロパティ
- IVariableModel
- 継承
- プロパティ
- IWebServiceRerefence
- 継承
- プロパティ
- IWorkflowElement
- 継承
- プロパティ
- IWorkflowModel
- 継承
- プロパティ