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

コード化されたワークフローはローコードワークフローと同じですが、唯一の違いは、別々のインターフェイスを使用して構築することです。

ワークフローでは、視覚的なデザインインターフェイスを使用できます。
コード化されたワークフローでは、コードベースのインターフェイスを使用できます。

さらに、コード化されたワークフローをローコードのアクティビティやワークフローと統合し、ハイブリッドオートメーションアプローチを使用することもできます。これにより、コードベースのオートメーションのメリットとローコードコンポーネントの視覚的なデザインを組み合わせて利用することができます。

構造

コード化されたオートメーションは、名前空間、ヘルパークラス、およびエントリポイントのメソッドを使用した構造化されたデザインを特徴とします。コード化されたオートメーションのフレームワークを使用すると、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 メソッドの説明を確認してください。

メソッド	説明
`serviceContainer(ICodedWorkflowServiceContainer)`	現在のコード化されたワークフローに固有の依存関係インジェクションコンテナーにアクセスできるようにします。このコンテナーは、サービスコンテナーと呼ばれ、コンテナー内に登録されているサービスのインスタンスを取得できるようにします。
`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() メソッドによりエントリポイントとして簡単に識別されるようになります。