- リリース ノート
- 基本情報
- 管理者向け
- RPA ワークフロー プロジェクト
- アプリ プロジェクト
- エージェンティック プロセス
- Agents
- ソリューション
- API ワークフロー - プレビュー
Studio Web ガイド
CXコンパニオンは、そのまま使用することも、ビジネスニーズに合わせてカスタマイズすることもできます。このセクションでは、 サンプル アプリ を使用して CX コンパニオンを設定する方法をいくつか示します。
- CX Companion を使用するには、デプロイされたフォルダーにサーバーレス ロボットまたは Unattended ロボットを設定する必要があります。
- CX Companionは外部イベントモードで使用することをお勧めしますが、使いやすさのために、クエリパラメータモードはデフォルトで有効になっています。詳しくは、以下の「 データ入力モードを設定する 」のセクションをご覧ください。外部イベントを使用する場合:
- Salesforce と統合するには、 Salesforce に CX Companion SF プラグインをインストールして設定します。
- 別のホスト プラットフォームと連携するには、 ホスト アプリケーションに UiPath Communication Driver をインストールして構成します。
- CX Companion でアクションを有人モードで実行するには、UiPath Assistant のバージョン 2025.0.167 以降が必要です。
- CX Companionから他のアプリを起動する場合は、Integration Serviceの Appsコネクタ を使用する必要があります。組織のガバナンス ポリシーが、このコネクタの使用を許可するように設定されていることを確認します。
- このコネクタは現在プレビュー版であるため、組織にデプロイされている Studio Web のガバナンス ポリシーで [ プレビュー パッケージとアクティビティを有効化 ] オプションを選択する必要があります。これにより、[ デプロイ済みのアプリのリストを取得 ] アクティビティをワークフローで利用できるようになります。詳しくは、『Automation Ops ガイド』の「 Studio Web のポリシーの設定 」をご覧ください。
- Integration Service ポリシーで Apps コネクタが有効化されていることを確認します。詳しくは、『Automation Ops ガイド』の 「Integration Service ポリシーの設定 」をご覧ください。
アプリでは、次のいずれかのデータ入力モードを使用できます。
-
クエリパラメーター - CX Companionをスタンドアロンとして展開する場合は、このオプションを使用します。CXコンパニオンアプリをすばやくテストできるように、このオプションはテンプレートでデフォルトで有効になっています。クエリ パラメーターを使用するための最初のワークフローは
MainPage_Load_Initiate_Request_QueryParam.xamlです。 - 外部イベント - Salesforce などのホスト アプリケーションに CX コンパニオンを埋め込む場合は、このオプションを使用します。外部イベントを使用するための開始ワークフローは
MainPage_Initiate_Request.xamlです。これは推奨されるオプションですが、テンプレートでは既定で有効化されていません。このオプションを使用するには、以下の手順を実行します。-
CXコンパニオンアプリデザイナー - [アプリの プロパティ ]パネルで、[ 外部イベント ]が有効になっていることを確認し、[ 許可されたオリジン ]テキストボックスにホストアプリケーションのドメインを追加します。外部イベントの有効化の詳細については、「 外部イベントを使用して外部コンテキストを設定する」をご覧ください。
-
CX コンパニオン アプリ デザイナー - ワークフロー ファイルで データ マネージャー を開いて、クエリ パラメーター モードを無効にします
MainPage_Load_Initiate_Request_QueryParam.xaml変数ConfigEnableQueryParamModeをFalseに設定します。既定値は [Trueです。 - ホストアプリケーション - Salesforce の場合、 CX Companion SF プラグインをインストールして設定します。他のすべてのホスト アプリケーションには、 UiPath Communication Driver をインストールして構成します。
-
モック 360 プロセスがソリューションに含まれており、ホスト アプリケーションから顧客データを取得するためにアプリによって呼び出されます。このプロセスは、必要に応じてカスタマイズしたり、別のプロセスを作成して Orchestrator にパブリッシュし、開始ワークフローの [プロセスを呼び出し: 360 度プロセスを開始 ] アクティビティから選択し、必要に応じて必要な引数を設定して、CX コンパニオンで設定することができます。
アクションとは、Orchestrator にパブリッシュされた、ユーザーが実行できるオートメーション、アプリ、エージェントを指します。CX Companionは、入力オブジェクトタイプに基づいてアクション用の異なるフォルダを持つように構成されています。たとえば、 サンプル アプリ では、 Case と Account の 2 種類が定義されています。Orchestrator のフォルダー構造がアプリの設定と一致している限り、特定の種類のレコードがアプリに読み込まれると、その種類に対して定義されたフォルダー内のアクションが [アクション] パネルに入力されます。
- データ入力モード用の開始ワークフローで データ マネージャー を開きます。
ConfigAutomationsRootFolderPath変数の [値] フィールドにオートメーションのルート フォルダー パスを入力します。たとえば、サンプル アプリでは CXCompanionAutomations/AllActions です。ConfigAutomationFoldersByType変数でオートメーションの種類を設定します。このディクショナリ変数では、各キーはオブジェクトの種類であり、その値は、そのオブジェクトの種類のオートメーションが格納されている Orchestrator サブフォルダーの名前です。サンプル アプリでは、変数は次のように設定されています。
キー 値 (Value) ケース (Case) ケースの自動化 アカウント アカウントの自動化 これは、Orchestrator の次のフォルダー構造に対応しています。
アプリの [アクション] パネルには、そのオブジェクトの種類のアクションが表示され、その種類のフォルダー内にある各サブフォルダーを表すタブが表示されます。
- 利用可能なアクションにデプロイ済みのアプリを含めるかどうかを設定します。
- クエリ パラメーター モードを使用していて、デプロイ済みのアプリも起動する場合は、UiPath Apps のコネクションを追加して、
MainPage_Load_Initiate_Request_QueryParam.xamlとMainPage_Initiate_Request.xamlの両方で [デプロイ済みのアプリのリストを表示] アクティビティを設定します。 - 外部イベント モードを使用していて、アプリもデプロイする場合は、UiPath Apps のコネクションを追加して
MainPage_Initiate_Request.xamlで [デプロイ済みのアプリのリストを取得] アクティビティを設定します。次の条件分岐 (条件分岐 時):MainPage_Load_Initiate_Request_QueryParam.xamlで有効化されている場合は、アプリのリストを読み込みます。 - CX Companionからアプリをデプロイしない場合は、アクティビティを削除または無効にします If: 両方の開始ワークフロー で有効になっている場合は、アプリリストを読み込み ます。
- クエリ パラメーター モードを使用していて、デプロイ済みのアプリも起動する場合は、UiPath Apps のコネクションを追加して、
-
ソリューションがデプロイされたら、以下に進みます。
- アプリがデプロイされているフォルダーに移動して編集します。
- [ パッケージ要件 ] ページでコネクション設定を選択します。
- すべてのユーザーに同じコネクションを使用させたい場合は、そのコネクションを選択します。アプリ ユーザーが独自のコネクションを作成できるようにする場合は、[ ユーザーが設定可能 ] を選択すると、ユーザーが初めてアプリを読み込むときにコネクションを作成するよう求めることができます。
CX Companion を使用するには、デプロイされたフォルダーにサーバーレス ロボットまたは Unattended ロボットを設定する必要があります。
アクションを無人モードまたはサーバーレス モードで実行する場合は、アプリのデプロイ後にホスト環境でこの URL を使用できます。追加の設定は必要ありません。
一部のアクションを有人モードで実行する必要がある場合は、アプリの URL にクエリ パラメーターを追加して、アプリを有人モードで実行する必要があります。
- Salesforce 内で CX コンパニオンを使用する場合は、
attendedMode=enabledWithRobotJSHandlerを付加します。 - 別のサードパーティシステム内でCXコンパニオンを使用する場合は、
attendedMode=enabledを追加します。
Assistant が実行されていて、アプリがデプロイされているテナントに接続されていることを確認します。CX Companion を使用するには、Assistant のバージョン 2025.0.167 以降が必要です。
Attended を追加します。
さまざまなオブジェクトの種類 (例:case と account) では、単一のオブジェクトの種類を使用するように構成できます。
-
開始ワークフローで
ConfigInputDataObjectTypeKeyName変数の既定値を削除します。 -
開始ワークフローの
ConfigRequiredInputProperties変数からTypeを削除します。 -
開始ワークフローで
ConfigQueryParameterNameMap変数からキーと値のペアをリモートTypeします。 -
開始ワークフローの
ConfigAutomationsRootFolder変数にルート フォルダー名を設定します。 -
ルート フォルダーが最上位レベルにある場合は、
ConfigAutomationsRootFolderPathの値を削除できます。ネストされたレベルにある場合は、この変数にルート フォルダー パスを設定します。 -
必要に応じて 360 パネルをカスタマイズします。詳しくは、以下の「 その他のカスタマイズ 」セクションの 「360度パネルに表示されるデータ 」をご覧ください。[大文字と小文字を切り替え] ブロックを削除して、[値を代入] アクティビティのセットを保持できます。さらに、該当する場合は、[360 パネル] コンテナの hidden プロパティを、タイプではなく
show360Spinnerのみに基づいて更新します。
入力フォームは、入力引数に基づいて動的に作成されます。現在、このフォームでサポートされているプリミティブ型は、Text、Number、Boolean、DateOnly のみです。他の型の引数を渡すと、テキスト ボックスが表示されます。日付ベースの入力の場合は、DateTime を使用する代わりに DateOnly を使用して日付ピッカー コントロールを取得します。
アクションの出力引数はすべて、タイトルとして引数名で Automation Tracker に表示されます。出力引数の値は、プレーン テキストまたは HTML です。その他の複合型のデータは、文字列形式で表示されます。
Automation Tracker はクリップボードへのコピーをサポートしています。次の 3 つのオプションのいずれかを要素に追加すると、要素にコピー アイコンが表示されます。
-
data-copyable="true"- 要素のテキスト コンテンツをコピーします。 -
class="copyable"- 要素のテキスト コンテンツをコピーします。 -
data-copy-text="custom text"- 指定したカスタム テキストをコピーします。
デプロイ プロセスの最後に表示されるダイアログから、アプリの URL をコピーできます。または、アプリをデプロイした後に、 Orchestrator > [オートメーション] > [[アプリ] >folder_name] に移動し、アプリの横にある [ その他のオプション ] をクリックして [ URL をコピー] を選択します。
詳しくは 、「アプリ プロジェクトをパブリッシュ、デプロイ、アップグレード する」および 「アプリを管理する」をご覧ください。
embed_ を含めて、ポップアップからログインできるようにします。外部イベント モードの場合は、クエリ パラメーター target を含め、ドメイン名を値として設定します (例:&target=https://www.example.com。例: https://cloud.uipath.com/embed_/appsdev/apps_/default/run/production/22986e36-8b04-4593-b82f-aae4c14bb2dc/bd8c8ef5-a94a-43f5-9a5b-6df73d8f7aa6/IDc0b72c47295b49abaea6b701cfa5b730?el=VB&uts=true&target=https://www.example.comConfig で始まる変数を変更して、アプリをカスタマイズできます。一部のシナリオでは、アクティビティも更新する必要があります。
- 一意のキー名 - 外部イベント モードでは、入力要求オブジェクトに複数のプロパティを含めることができますが、クエリ パラメーター モードでは、複数のクエリ パラメーターが入力として送信される場合があります。一意の識別子を保持するプロパティは、開始ワークフローの
ConfigInputDataObjectUniqueKeyName変数で設定する必要があります。サンプル アプリでは、Idは現在の要求を一意に識別するために使用されるプロパティ名です。この一意の値は、アクションの実行結果を保持するためにも使用されます。 - 入力の型のキー名 - 要求の種類に基づいて複数のルート フォルダーを構成できるようにするには、オブジェクトの型を保持するプロパティ名をアプリが把握している必要があります。一意の識別子を保持するプロパティは、開始ワークフローの
ConfigInputDataObjectTypeKeyName変数で設定する必要があります。サンプル アプリでは、Typeがプロパティ名です。異なる種類のオブジェクトがない場合は、この変数の値を削除します。 - 開始に必要なプロパティ - 360 度プロセスの開始に必須入力が必要な場合は、開始ワークフローの
ConfigRequiredInputProperties変数でそれらのプロパティを指定します。定義されている必須プロパティに値がない場合、実行時にエラー メッセージがスローされ、後続のアクティビティは実行されません。この変数を設定するときは、次の点を考慮してください。- コレクションに一意のキー名を追加する必要があります。
- 異なる型のオブジェクトがない場合は、 コレクションに Input 型のキー名 を含めないでください。
- コレクションに必要なプロパティを追加します。
- クエリ パラメーターを設定します。 - クエリ パラメーター モードでは、
MainPage_Load_Initiate_Request_QueryParam.xamlのConfigQueryParameterNameMap変数のパラメーターの値が取得され、入力オブジェクトに設定されます。このディクショナリでは、キーは入力オブジェクトのプロパティ名、値はクエリ パラメーター名です。 - 360度パネルに表示されるデータ - 各項目の値を直接設定して設定します。サンプルアプリケーションでは、 ケース タイプ用と アカウント タイプ用の 2 つのセットが利用可能です。一方のセットが表示されている場合、もう一方のセットはタイプに基づいて非表示になります。ラベルは静的であり、必要に応じて変更できます。
- アクティビティでそれぞれのコントロールの値を設定します。 [ トライ キャッチ]: 開始ワークフローの 360 パネルで入力データを設定します 。このブロック内では、スイッチを使用してタイプに基づいて構成します。このブロックを使用して、入力オブジェクト データに基づいて値を設定します。
- 360 プロセスのデータを [360] パネルに表示するよう設定するには、開始ワークフローの [360 度パネル] で [トライ キャッチ: プロセスの 360 度データ] を設定し、必要に応じて値を設定します。
- 360 パネルを非表示にする - アプリで 360 パネルを非表示にするには、開始ワークフローで変数
ConfigHide360PanelをTrueに設定します。パネルが非表示になっても、360 度プロセスは引き続き実行され、アクションの実行時にフォーム内の入力引数の事前入力に値が使用されます。 - 入力プロパティをアクションの入力引数にマップ する - 外部イベント、クエリ パラメーター、360 度プロセスから取得される値を使用して、アクションの実行前に表示される入力フォームに事前に入力できます。デフォルトでは、アクションの引数名が入力オブジェクトプロパティ名または 360 度出力プロパティ名のいずれかと一致する場合、値が事前に入力されます。
ActionListPage_StartActionButton_click.xamlワークフローで以下の変数を使用して、追加の値を設定できます。ConfigInputArgumentsInputObjectPropertyMap- ディクショナリです。キーはアクションの入力引数名、値は入力オブジェクトのプロパティ名です。入力オブジェクトは、クエリ パラメーターまたは外部イベントからのメッセージから作成されます。ConfigInputArgumentsDat360ObjectPropertyMap- キーはアクション入力引数名、値は 360 度出力引数名であるディクショナリです。
- アクションのコンテキストベースのフィルター処理を有効化する - 既定では、すべての要求の種類に対してすべてのアクションが常にリスト表示されます。このオプションを使用すると、現在の要求のコンテキストに基づいて関連するアクションを表示できます。有効化するには、以下の手順を実行します。
MainPage_Action_Folder_Change.xamlワークフローで、ConfigEnableContextFiltering変数をTrueに設定します。ConfigContextFilteringPropertyName値を、アクション ラベルと一致させる必要がある 360 度プロセス オブジェクトのプロパティ名に設定します。- Orchestrator でデプロイ済みのアクションにタグを追加します。アクションの種類に関係なく常に使用できるようにするアクションにラベル
Commonを追加します。 - 特定のリクエストの種類でのみ利用可能にするその他のアクションについては、必要に応じてタグを追加します。タグ値が手順 2 で設定したプロパティの値と一致すると、アクションが表示されます。1 つのアクションに複数のタグを追加して、複数のリクエストの種類のアクションを一覧表示できます。
- クエリ パラメーター モードを使用している場合は、
MainPage_Load_Initiate_Request_QueryParam.xamlワークフローの手順 1 と 2 で説明した変数も設定します。
