Studio ガイド

最終更新日時 2024年12月17日

はじめに

コード化されたオートメーションを使用すると、ドラッグアンドドロップアクティビティの代わりにコードを使用してオートメーションを作成できるため、複雑なプロジェクトでの共同作業が可能になります。コード化されたワークフローおよびテストケースでは、UiPath サービス (アクティビティパッケージと同一)、API (アクティビティに類似)、外部 .NET NuGet パッケージ、およびカスタム C# クラスを UiPath Studio で使用できます。これにより、外部システム、データベース、API、その他のサービスとの統合が容易になります。

コード化されたワークフローは標準ワークフローと同じように動作します。つまり、[ワークフローファイルを呼び出し] アクティビティを使用して標準の UiPath ワークフローから呼び出すことも、その逆も可能です。

さらに、コードで定義された型 (列挙型など) は、標準の UiPath ワークフローの入力として使用できます。

コード化されたオートメーションには、以下の 3 種類があります。

コード化されたワークフロー – コードを使用してワークフローを設計するために使用します。
コード化されたテストケース – テストケースの設計に使用されます。
コードソースファイル – 他の種類のコード化されたファイルで後から呼び出すことのできるコードを作成するために使用します。

コード化されたオートメーションを使用する

プロジェクトでコード化されたオートメーションを作成するために、通常、UiPath.CodedWorkflows パッケージがあらかじめインストールされています。パッケージには、CodedWorkflowBase 基本クラスと CodedWorkflow 部分クラスが付属しています。

パッケージは、次の場合に事前インストールされます。

v23.10 以降の System.Activities、Testing.Activities、UIAutomation.Activities、またはコード化されたワークフローがサポートされているその他のアクティビティパッケージを使用して、新しいプロジェクトを作成する場合
プロジェクトで、コード化されたワークフロー、コード化されたテストケース、または コードソースファイルを新規作成する場合

指定したシナリオでコード化されたオートメーションを使用できない場合は、[パッケージを管理] メニューからパッケージをダウンロードします。

メリット

コード化されたオートメーションを使用するメリットをいくつか以下に示します。

生産性の向上 – コーディングやスクリプティングに精通している場合は、そのスキルを活かして生産性を向上させることができます。慣れ親しんだコーディング環境で作業することで、より効率的なオートメーションを開発できます。
複雑さの管理 – コード化されたオートメーションは、複雑なオートメーションシナリオを管理するための柔軟なソリューションを提供します。コードを使用して、カスタムロジックの実装、例外の管理、および再利用可能な関数の作成が可能です。
ハイブリッドオートメーション – コード化されたオートメーションは、ローコードのオートメーションと同様に使用できます。これにより、2 つのアプローチがシームレスに統合され、柔軟なオートメーションソリューションを作成できるようになります。
パフォーマンスの向上 – コード化されたオートメーションを使用すると、オートメーションワークフローを最適化してパフォーマンスを向上させることができます。コードを使用することで、特定のアルゴリズムを実装してオートメーションの実行を高速化できます。
読みやすさ – コード化されたオートメーションを使用すると、構造化されたコードを作成できるため、コードが読みやすくなります。コードを整理して文書化すると、管理や他の共同作業者への共有がしやすくなります。

構造

コード化されたオートメーションは、名前空間、ヘルパークラス、およびエントリポイントのメソッドを使用した構造化されたデザインを特徴とします。コード化されたオートメーションのフレームワークを使用すると、C# プログラミング言語を使用してオートメーションを記述できます。

コード化されたオートメーションの詳細な構造は、以下のセクションに記載されています。

名前空間

コード化されたオートメーションを作成すると、Studio プロジェクトの名前を使用して名前空間が自動的に生成されます。たとえば、Studio プロジェクトの名前が「My project」である場合、コード化されたすべてのオートメーションの名前空間は「Myproject」になります。

また、Studio プロジェクトのフォルダー内にコード化されたオートメーションを作成した場合、名前空間はプロジェクトの名前とフォルダーの名前の組み合わせになります。たとえば、Studio プロジェクトの名前が「My project」でフォルダーの名前が「place」である場合、名前空間は「Myproject.place」になります。

基本クラス

コード化されたワークフローとコード化されたテストケースのオートメーションはどちらも、UiPath.CodedWorkflows パッケージの CodedWorkflow 部分クラスを使用します。このクラスは、プロジェクトにインストールされているアクティビティパッケージに基づいて、サービスに必要なインターフェイス (アクティビティパッケージと同じ) へのアクセス権をオートメーションに付与します。

注: UiPath.System.Activities 23.10 以降などの、コード化されたオートメーションをサポートするアクティビティパッケージをインポートするときには、UiPath.CodedWorkflows パッケージが自動的に含まれます。

`コード化されたワークフロー`

コード化されたオートメーションは、部分クラス CodedWorkflow を継承し、CodedAutomationExample : CodedWorkflow 型のリレーションシップを作成します。つまり、クラス CodedAutomationExample は、クラス CodedWorkflow から属性、メソッド、および機能を継承します。これにより、コード化されたオートメーションの基盤となるクラス CodedWorkflow で定義されている機能にアクセスして利用できるため、オートメーションの動作が構築・カスタマイズしやすくなります。

CodedWorkflow クラスは部分クラスとして宣言され、コードソースファイルで同じ部分クラス CodedWorkflow を定義することで機能を拡張できます。これにより、新しいフィールドやメソッドを追加して、コード化されたオートメーションの動作をさらにカスタマイズできます。この方法を使用すると、コード化されたテストケースのためのBefore インターフェイスと After インターフェイスを実装できます。

さらに、CodedWorkflow 部分クラスは CodedWorkflowBase クラスを継承します。

`CodedWorkflowBase`

CodedWorkflowBase クラスは、コード化されたオートメーションが継承する組み込み機能を保持します。このクラスには、ワークフローインスタンスの管理、ランタイムアクセス、サービスコンテナーの処理、および環境コンテキストの構成を行うためのメソッドと特定のプロパティが含まれています。CodedWorkflowBase クラスには、ユーザー自身がカスタマイズできるログ用メソッドも別途用意されています。

注: [コードエディターの設定] で、[ソースの逆コンパイルを有効化] を選択して CodedWorkflowBase クラスを表示します。

以下の表の CodedWorkflowBase メソッドの説明を確認してください。

メソッド	説明
`ICodedWorkflowServices services` 注: `Log` メソッド、`BuildClient` メソッド、および `RunWorkflow` メソッドは、すぐに使用可能なスタンドアロンのメソッドとして使用するのではなく、`services` クラスとそれに対応するサービスを介して使用することをお勧めします。	次のような、コード化されたワークフローで利用可能なサービスへのアクセスを提供します。 `OutputLoggerService`: `Log` メソッドを使用してログを出力できます。 `OrchestratorClientService` (`BuildClient` メソッド): `BuildClient` メソッドを介した Orchestrator との対話を有効化できます。 `WorkflowInvocationService`: `RunWorkflow` メソッドを使用して、他のワークフローを呼び出すことができます。 `Container`: すべてのサービスが格納されるコンテナーです。`AutoImportedNamespaces` メソッドと `AutoImportedTypes` メソッドを使用して、名前空間と型の自動インポートを処理し、コード化されたワークフローのリソースを管理できます。さらに、`Resolve` メソッドを使用して、特定のサービスのインスタンスを提供します。
`serviceContainer(ICodedWorkflowServiceContainer)` 注: これは `ICodedWorkflowServices services` で置き換えられました。この構文を引き続き使用する場合は、新しい `services.Container` 構文を使用するように指示する警告が表示されます。	現在のコード化されたワークフローに固有の依存関係インジェクションコンテナーにアクセスできるようにします。このコンテナーは、サービスコンテナーと呼ばれ、コンテナー内に登録されているサービスのインスタンスを取得できるようにします。
`GetRunningJobInformation()`	コード化されたワークフローのコンテキスト内で現在実行中のジョブに関する情報を取得します。このメソッドは、ジョブのステータス、進行状況、パラメーター、およびタイムスタンプに関する情報を保持する `executorRuntime` オブジェクトの `RunningJobInformation` プロパティにアクセスします。
`Log(string message, LogLevel level` `= LogLevel.Info, IDictionary<string, object>additionalLogFields = null)`	指定した属性を持つログメッセージにログフィールドを追加します。
`RunWorkflow(string workflowFilePath,IDictionary<string, object> inputArguments = null,TimeSpan? timeout = null, bool isolated = false,InvokeTargetSession targetSession = InvokeTargetSession.Current)`	特定のワークフローランタイムのコンテキスト内でワークフローを実行するための構造を提供します。パラメーターの設定、潜在的な分離の処理、ワークフローの実行開始が可能です。返されるタスクは、実行されたワークフローの結果 (出力および入力/出力引数を含む) を示します。
`RunWorkflowAsync(string workflowFilePath,IDictionary<string, object> inputArguments = null, TimeSpan?timeout = null, bool isolated = false,InvokeTargetSession targetSession = InvokeTargetSession.Current)`	特定のワークフローランタイムのコンテキスト内でワークフローを非同期的に実行するための構造を提供します。パラメーターの設定、潜在的な分離の処理、ワークフローの実行開始が可能です。返されるタスクは、実行されたワークフローの結果 (出力および入力/出力引数を含む) を示します。
`DelayAsync(TimeSpan time)` と `DelayAsync(int delayMs)`	指定された時間、非同期的に実行を中断します。
`Delay(TimeSpan time)` と `Delay(int delayMs)`	指定した期間、実行を中断します。
`HttpClient BuildClient(string scope = "Orchestrator", bool force = true)`	指定されたスコープとアクセストークンを使用して HTTP クライアントを構築します。
`RegisterServices(ICodedWorkflowsServiceLocator serviceLocator)`	コード化されたワークフローのサービスロケーターにサービス (アクティビティパッケージ) を登録します。これは、カスタムサービスを依存関係インジェクションコンテナーに挿入するときにオーバーライドできます。カスタムサービス (コード化されたアクティビティパッケージ) の作成および使用方法については、こちらをご覧ください。

エントリポイント

コード化されたワークフローとコード化されたテストケースの両方のエントリポイントメソッドの名前は Execute() であり、Workflow または TestCase のいずれかに属性付けされています。メソッドの名前は、Workflow または TestCase のいずれかに属性付けする限り変更できます。

ファイル内で使用できるのは、Coded Workflow クラスを継承する 1 つの Execute() メソッド ([TestCase] または [Workflow]) のみです。

このメソッドでは、入力引数または出力引数を追加できます。これらの引数は、ローコードオートメーションの入力、出力、または入力/出力引数に相当します。コード化されたオートメーションでの引数の使用方法については、「入力引数と出力引数を使用する」のチュートリアルをご覧ください。

このエントリポイントメソッドは、オートメーションを実行するための開始点として機能します。そのため、コード化されたワークフローやテストケースが Execute() メソッドによりエントリポイントとして簡単に識別されるようになります。

プロジェクトの対応 OS

コード化されたオートメーションは、Windows プロジェクトとクロスプラットフォーム プロジェクトでのみ使用できます。

サービス

コード化されたオートメーションの設計には、アクティビティパッケージと同一のサービスを使用できます。たとえば、System.Activities はローコードオートメーションのアクティビティパッケージであるだけでなく、コード化されたオートメーションのサービスでもあります。アクティビティパッケージ内のアクティビティと同様に、サービスにもコード化されたオートメーションの作成に使用できる API があります。

コード化されたオートメーション内で使用できるサービスは次のとおりです。

サービス	バージョン
System.Activities	23.10 以降
UiAutomation.Activities	23.10 以降
Testing.Activities	23.10 以降
MobileAutomation.Activities	23.12-preview 以降
Mail.Activities	1.22.1 以降
Excel.Activities	2.23.2-preview 以降

コード化されたオートメーションでアクティビティパッケージを使用するには、次の手順を実行します。

ローコードのオートメーションの場合と同様に、サービスと同一のアクティビティパッケージをダウンロードします。それにより、コードで使用する API のコレクションが提供されます。
サービス内の API を、サービス.API という形式で呼び出します。たとえば、GetAsset API を使用する場合は、system.GetAsset のように指定して呼び出します。
API には、プロパティの代わりにパラメーターがあります。API を呼び出した後、かっこで囲んだ値を指定して、パラメーターを設定できます。たとえば、接続先の Orchestrator インスタンスに Email Address というアセットがある場合、このアセットの名前を String として API に渡すことができます: system.GetAsset("Email Address")。