Activity Creator を使用する

アクティビティは、プロセス オートメーションの構成要素です。それぞれが、他のアクティビティとともにスタックされたアトミック アクションを含み、ワークフローを構成しています。

UiPath Studio には、 パッケージ マネージャー を使用してインストールできる ビルド済みのアクティビティ が多数用意されています。

さらに、UiPath の Visual Studio 用 Activity Creator 拡張機能を使用すると、ユーザーのニーズに最も合った独自のカスタム アクティビティを作成することもできます。以下のステップを実行することで、カスタム アクティビティを構築するための基盤を 5 分で得られます。このセクションでは、アクティビティ パッケージを作成してから、そのアクティビティ パッケージに、正常に機能するアクティビティを追加します。

必要なもの

• Visual Studio Community/Professional/Enterprise 2022 と *.NET デスクトップ開発
• インストールされたワークロード
• Visual Studio でパッケージ ソースとしての UiPath の Marketplace フィード (https://gallery.uipath.com/api/v3/index.json)。パッケージ ソースを追加する手順については、こちらをご覧ください。
• .NET 6
• UiPath Studio

重要:

Activity Creator のバージョン 4.0 は、Visual Studio 2022 でのみ機能しますのでご注意ください。 同様に、このアクティビティによってターゲットの .NET 6 の Windows プロジェクトが生成されました。 Visual Studio または .NET の古いバージョンに対応したアクティビティを作成するには、拡張機能のバージョン 3 を使用してください。

また、この拡張機能で作成されるアクティビティは、Marketplace フィード (https://gallery.uipath.com/api/v3/index.json) で現在利用可能な UiPath 製のライブラリに依存しています。このフィードは、開発中に Visual Studio で利用可能である必要があります。利用可能でないと、アクティビティが正常にビルドされません。

手順 1: UiPath Activity Creator 拡張機能を Visual Studio に追加する

Open Visual Studio and click Extensions > Manage Extensions.

ウィザードが開くので、[オンライン] をクリックし、UiPath を [検索] (Ctrl+E) します。UiPath Activity Creator 拡張機能をダウンロードします。

Visual Studio を閉じ、VSIX インストーラーが表示されたら、インストールを完了します。

手順 2: UiPath プロジェクトを作成する

Reopen Visual Studio and double-click Create a new project on the home screen.

On the Create a new project screen, type "uipath" in the search bar, select UiPath Standard Activity Project, and click Next.

Give your project a name. The UiPath convention is <Your company's name>.<Your product's name> (e.g. UiPath.Orchestrator). Then click Create.

[ソリューション エクスプローラー] に移動し、3 つのプロジェクト、共有フォルダー、多数のファイルがソリューションに追加されていることに注目します。これが、すべてのアクティビティ パッケージの基礎です。最初のアクティビティを追加するためのシンプルなアクティビティ 。

The Simple Activity

パッケージが作成できたので、アクティビティを追加しましょう。この例では上に示すアクティビティを作成します。2 つの数を合計した単純なアクティビティです。

必要なもの

• Visual Studio Community/Professional/Enterprise (2019 が必須)
• UiPath Studio
• Using The Activity Creator

ステップ 1: アクティビティ作成者を開く

まず、前のセクションで作成した Visual Studio ソリューションを開き、ソリューション エクスプローラーでメイン プロジェクト (MyCompany.MyProduct... というラベルの付いたプロジェクト) のいずれかを選択します。次に、ツールバーで [ Extensions] > UiPath > [アクティビティを追加 ] に移動します。このメニューは、いずれかのプロジェクトが選択されるまで無効化されることに注意してください。

手順 2: アクティビティを構築する

Activity Creator のウィンドウが新たに開きます。最初の画面に 2 つのオプションが表示されます。

1. 作成: 1 つまたは複数のアクティビティをゼロから作成します。
2. インポート: 標準形式で保存されている事前定義のアクティビティのリストをインポートします。

[作成] を選択します。

手順 3: アクティビティを定義する

以下に示すように、[追加] ボタンをクリックし、各フィールドを設定します。これにより、いつでも Activity Creator で [追加] という名前のアクティビティを構築できるようになります。準備ができたら、[編集] ボタンをクリックして [追加] アクティビティにプロパティを追加します。

手順 4: プロパティを追加する

これにより、新しい [プロパティを定義 ] ウィンドウが開きます。以下に示すように、[ 追加 ] ボタンを使用して 3 つのプロパティを作成します。

最初の 2 つが入力で、最後が出力であることを確認します。これらのプロパティは、2 つの数値とその合計値を表します。

手順 5: アクティビティを生成する

[プロパティ] ウィンドウで [ OK ] をクリックし、アクティビティ ウィンドウで [ 完了] をクリックします。その後、プロジェクトに追加されたいくつかの新しいファイルが表示されます。

手順 6: 機能を追加する

作成したばかりの Addition.cs ファイルを開き、その中で Protected Methods リージョンを展開してアクティビティの ExecuteAsync メソッドを明らかにします。これは、UiPath Studio 内でアクティビティが実行されるときに常に呼び出されるメソッドです。

このメソッドには、ステップ 4 で作成した 2 つの入力 (1 つ目の数字と 2 つ目の数字) および 1 つの出力 (合計) が既に追加されています。最後のステップでは、コメント ブロックをコードに置き換えます。このコードによって 2 つの入力が追加され、その結果が合計に設定されることで、入力値と出力値の差が解消されます。以下をご覧ください。

手順 7: パッケージをビルドする

ソリューション エクスプローラーでデザイン プロジェクトを右クリックし、[ パブリッシュ] を選択します。このオプションでは、プロジェクトを構築してパッケージ化し、目的の場所にパッケージを送信します。

次の画面で、アクティビティ パッケージを保存するフォルダーを入力します。UiPath Studio からパッケージ ソースの 1 つを選択して (Studio のホームページの [設定] > [パッケージ ソースを管理 ] で確認できます)、Visual Studio から UiPath Studio に直接パブリッシュできるようにすることをお勧めします。

[ プロファイルの作成 ] をクリックして続行します。

次のページで、パッケージ ソースの名前を UiPath パッケージ (または任意の名前) に変更し、設定を デバッグ に変更します。次に、[ パブリッシュ] をクリックします。

デバッグ構成とリリース構成の詳細については、「 パッケージ メタデータ」を参照してください。

すると、3 つのプロジェクトすべてが正常に構築され、得られたパッケージがパブリッシュされたことが出力されます。 これで、実用的なアクティビティ パッケージが追加されました。

手順 8: UiPath Studio でアクティビティを使用する

UiPath Studio を開き、パッケージ マネージャーに移動して、アクティビティ セットをワークフローに追加します。

[アクティビティ] パネルに新しいカテゴリが追加されます。

以上です。新しいアクティビティをお試しください。

パッケージ メタデータ

このチュートリアルに組み込まれたアクティビティ パッケージには、作成者、ライセンス、アイコンなどの情報が保存される複数のプレースホルダーがあります。それらのプレースホルダーを実際の情報に置き換えることで、パッケージをパーソナライズしましょう。

このセクションで重点的に扱っているのは、パッケージの情報をすべて保持するデザイン プロジェクトです。

必要なもの

• Visual Studio Community/Professional/Enterprise (2019 が必須)
• UiPath Studio
• Using The Activity Creator

手順 1: デザイン プロジェクトを開く

MyCompany.MyProduct.Activities.Design プロジェクトをダブルクリックして開くと、ラベルが付いたセクションが 3 つあることがわかります。

• パッケージのメタデータ
• パッケージ バージョン
• パッケージのアイコン

パッケージ メタデータ

フィールド	説明
PackageLicenseExpression	使用するライセンスの SPDX 識別子 です。デフォルトは Apache 2.0 です。
Description	UiPath Studio パッケージ マネージャーに表示されるアクティビティの簡単な説明です。
Authors and Company	パッケージの作成者と所有者をそれぞれ示します。
Copyright	標準的な著作権表示。
PackageTags	ユーザーがパッケージを検索するための用語のリストです。
PackageProjectUrl	アクティビティのドキュメントまたは企業のホームページへのリンクです。
PackageIconUrl	パッケージ アイコンとして使用する画像ファイルへのリンクです。 PackageIcon タグは現在 UiPath Studio でサポートされていません。

<PropertyGroup>
    <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
    <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
    <Description>A package used to perform simple arithmetic operations in UiPath Studio.</Description>
    <Authors>My Company</Authors>
    <Company>My Company</Company>
    <Copyright>@ 2020 My Company</Copyright>
    <PackageTags>UiPath Activity MyCompany MyProduct Math Addition Arithmetic</PackageTags>
    <PackageProjectUrl>https://docs.uipath.com/integrations/docs/how-to-create-activities</PackageProjectUrl>
    <PackageIconUrl>https://raw.githubusercontent.com/NuGet/Samples/master/PackageIconNuspecExample/icon.png</PackageIconUrl>
    ...
</PropertyGroup>

パッケージのバージョン

ここには 2 つの PackageVersion タグがあり、パッケージをビルド -デバッグとリリースの 2 つのモードに対応している点に注意してください。

• デバッグは 開発中に役立ちます。バージョンはビルドごとにインクリメントされるため、UiPath Studio で更新してすぐにテストできます。
• リリース は、公開準備が整った最終パッケージを作成するために使用されます。開発が完了したら、ここで目的のバージョンを設定できます。

  <PropertyGroup Condition="'$(Configuration)' == 'Debug'">
      <PackageVersion>0.2.0.$([System.DateTime]::UtcNow.ToString(MMddHmmss)) Version</PackageVersion>
  </PropertyGroup>
    
  <PropertyGroup Condition="'$(Configuration)' == 'Release'">
      <PackageVersion>0.2.0</PackageVersion>
  </PropertyGroup>
  

パッケージのアイコン

PackageIconUrl タグを使用して、アクティビティ パッケージにアイコンを追加します。この例では、 サンプル アイコン が使用されています。

手順 2: パッケージを再構築する

前のセクションと同様にパッケージをリビルドし、UiPath Studio 内にインポートします。パッケージ マネージャーを開き、パッケージのアイコン、説明、メタデータがどのように更新されているのかを確認します。