Konfigurieren der CX-Companion-App

Der CX-Companion kann so verwendet werden, wie er ist, oder entsprechend Ihren geschäftlichen Anforderungen angepasst werden. In diesem Abschnitt wird dokumentiert, wie Sie CX Companion konfigurieren können, indem Sie die Beispiel-App verwenden, um einige der Einstellungen zu veranschaulichen.

Voraussetzungen

• CX-Companion erfordert, dass ein serverloser oder unbeaufsichtigter Roboter im bereitgestellten Ordner eingerichtet wird.
• Wir empfehlen die Verwendung von CX Companion im Modus für externe Ereignisse, aber bitte beachten Sie, dass der Abfrageparametermodus zur Benutzerfreundlichkeit standardmäßig aktiviert ist. Weitere Informationen finden Sie im Abschnitt Konfigurieren des Dateneingabemodus weiter unten. Bei Verwendung externer Ereignisse:
  • Für die Integration mit Salesforce installieren und konfigurieren Sie das CX Companion SF-Plugin in Salesforce.
  • Für die Integration in eine andere Hostplattform installieren und konfigurieren Sie den UiPath Communication Driver in der Hostanwendung.
• Um Aktionen im Attended-Modus auszuführen, benötigt CX Companion die UiPath Assistant-Version 2025.0.167 oder höher.
• Wenn Sie andere Apps aus CX Companion starten möchten, müssen Sie den Apps-Connector im Integration Service verwenden. Stellen Sie sicher, dass die Governance-Richtlinien Ihrer Organisation so konfiguriert sind, dass die Verwendung dieses Connectors zugelassen wird:
  • Da dieser Connector derzeit in der Vorschau verfügbar ist, muss die Option Vorschau auf Pakete und Aktivitäten aktivieren in der in Ihrer Organisation bereitgestellten Studio Web-Governance-Richtlinie ausgewählt sein. Dadurch wird die Aktivität List Deployed Apps in Workflows verfügbar. Weitere Informationen finden Sie unter Einstellungen für Studio Web-Richtlinien im Automation Ops-Handbuch.
  • Stellen Sie sicher, dass der Apps-Connector in Ihrer Integration Service-Richtlinie aktiviert ist. Weitere Informationen finden Sie unter Einstellungen für Integration Service-Richtlinien in der Automation Ops-Anleitung.

Konfigurieren Sie den Dateneingabemodus

Die App kann einen der folgenden Dateneingabemodi verwenden:

• Abfrageparameter – Verwenden Sie diese Option, wenn CX Companion eigenständig bereitgestellt wird. Damit Sie die CX-Companion-App schnell testen können, ist diese Option in der Vorlage standardmäßig aktiviert. Der Workflow zum Initiieren für die Verwendung von Abfrageparametern ist MainPage_Load_Initiate_Request_QueryParam.xaml.
• Externe Ereignisse – Verwenden Sie diese Option, wenn Sie CX Companion in eine Hostanwendung wie Salesforce einbetten möchten. Der Workflow „Initial“ für die Verwendung externer Ereignisse ist MainPage_Initiate_Request.xaml. Dies ist die empfohlene Option, ist aber in der Vorlage standardmäßig nicht aktiviert. So verwenden Sie diese Option:

  • App-Designer für CX-Companion : Stellen Sie im Bereich App -Eigenschaften sicher, dass Externe Ereignisse aktiviert sind, und fügen Sie die Domäne Ihrer Hostanwendung in das Textfeld Zulässige Quellen ein. Weitere Informationen zum Aktivieren externer Ereignisse finden Sie unter Festlegen eines externen Kontexts mithilfe externer Ereignisse.

    

  • Im App-Designer für die CX-Companion – Deaktivieren Sie den Abfrageparametermodus, indem Sie den Data Manager in der Workflowdatei öffnen

    MainPage_Load_Initiate_Request_QueryParam.xaml und die Variable ConfigEnableQueryParamMode auf False festlegen. Der Standardwert ist True.
  • In der Hostanwendung – Installieren und konfigurieren Sie für Salesforce das CX Companion SF-Plugin. Installieren und konfigurieren Sie für alle anderen Hostanwendungen den UiPath Communication Driver.

360-Prozess konfigurieren (Optional)

Ein nachgebildeter 360-Prozess ist in der Lösung enthalten und wird von der App aufgerufen, um Kundendaten aus der Hostanwendung abzurufen. Sie können diesen Prozess nach Bedarf anpassen oder einen anderen Prozess erstellen, ihn im Orchestrator veröffentlichen und den CX-Companion für die Verwendung konfigurieren, indem Sie ihn aus der Aktivität Invoke Process: Start 360 Process im Initiation-Workflow auswählen und die erforderlichen Argumente nach Bedarf konfigurieren.

Konfigurieren Sie den Ordner für Aktionen

Aktionen beziehen sich auf die Automatisierungen, Apps und Agenten, die in Orchestrator veröffentlicht wurden und die Benutzer ausführen können. CX- Companion ist so konfiguriert, dass unterschiedliche Ordner für Aktionen basierend auf dem Eingabeobjekttyp vorhanden sind. In der Beispiel-App sind beispielsweise zwei Typen definiert: Case und Account. Solange die Ordnerstruktur im Orchestrator mit der Konfiguration in der App übereinstimmt, wird beim Laden eines Datensatzes eines bestimmten Typs in der App der Aktionen-Bereich mit den Aktionen im Ordner aufgefüllt, die für diesen Typ definiert sind.

1. Öffnen Sie den Data Manager im Initiationsworkflow für den Dateneingabemodus.
2. Geben Sie den Pfad des Automatisierungsstammordners in das Wertfeld der Variablen ConfigAutomationsRootFolderPath ein. Zum Beispiel CXCompanionAutomations/AllActions in der Beispiel-App.
3. Konfigurieren Sie die Automatisierungstypen in der Variablen ConfigAutomationFoldersByType . In dieser Wörterbuchvariable ist jeder Schlüssel ein Objekttyp und sein Wert ist der Name des Orchestrator-Unterordners, der die Automatisierungen für diesen Objekttyp enthält.

   In der Beispiel-App ist die Variable wie folgt konfiguriert:

   Schlüssel	Wert
   Fall	Fallautomatisierungen
   Konto	Kontoautomatisierungen

   Dies entspricht der folgenden Ordnerstruktur im Orchestrator.

   

   Im Bereich Aktionen der App werden die Aktionen für den Objekttyp angezeigt, wobei eine Registerkarte jeden Unterordner darstellt, der im Ordner für diesen Typ gefunden wird.

   
4. Konfigurieren Sie, ob bereitgestellte Apps in verfügbaren Aktionen eingeschlossen werden sollen:
   • Wenn Sie den Abfrageparametermodus verwenden und auch bereitgestellte Apps starten möchten, konfigurieren Sie die Aktivität List Deployed Apps sowohl in MainPage_Load_Initiate_Request_QueryParam.xaml als auch in MainPage_Initiate_Request.xaml , indem Sie eine UiPath Apps-Verbindung hinzufügen.
   • Wenn Sie den externen Ereignismodus verwenden und auch Apps bereitstellen möchten, konfigurieren Sie die Aktivität List Deployed Apps in MainPage_Initiate_Request.xaml , indem Sie eine UiPath Apps-Verbindung hinzufügen, und löschen oder deaktivieren Sie die Aktivität If: Apps-Liste laden, wenn sie in MainPage_Load_Initiate_Request_QueryParam.xaml aktiviert ist.
   • Wenn Sie nicht beabsichtigen, Apps aus CX Companion bereitzustellen, löschen oder deaktivieren Sie die Aktivität If: Load Apps list, wenn sie in beiden Initiation-Workflows aktiviert ist .

5. Nach der Bereitstellung der Lösung:

   1. Wechseln Sie zum Ordner, in dem die App bereitgestellt wird, und bearbeiten Sie ihn.
   2. Wählen Sie auf der Seite Paketanforderungen die Verbindungskonfiguration aus.
   3. Wenn Sie möchten, dass dieselbe Verbindung von allen Benutzern verwendet wird, wählen Sie diese Verbindung aus. Wenn Sie App-Benutzern erlauben möchten, ihre eigene Verbindung zu erstellen, wählen Sie Von Benutzern konfigurierbar aus, um die Benutzer beim ersten Laden der App aufzufordern, eine Verbindung zu erstellen.

Hinweis: Sie können die App mithilfe von Beispiel-Automatisierungen testen.

Ausführung im beaufsichtigten oder unbeaufsichtigten Modus

CX-Companion erfordert, dass ein serverloser oder unbeaufsichtigter Roboter im bereitgestellten Ordner eingerichtet wird.

Um Aktionen im Unattended- oder serverlosen Modus auszuführen, können Sie nach der Bereitstellung der App die URL in Ihrer Hostumgebung ohne zusätzliche Konfiguration verwenden.

Wenn Sie einige Aktionen im Attended-Modus ausführen möchten, müssen Sie die App im Attended-Modus ausführen, indem Sie einen Abfrageparameter an die App-URL anfügen:

• Wenn Sie CX-Companion in Salesforce verwenden, fügen Sie attendedMode=enabledWithRobotJSHandler an.
• Wenn Sie CX-Companion in einem anderen Drittanbietersystem verwenden, hängen Sie attendedMode=enabled an .

Stellen Sie sicher, dass der Assistant ausgeführt wird und mit demselben Mandanten verbunden ist, auf dem die App bereitgestellt wird. CX-Companion erfordert die Assistant-Version 2025.0.167 oder höher.

Standardmäßig werden alle Aktionen nur im Unattended-Modus ausgeführt, auch wenn die App im Attended-Modus ausgeführt wird. Um Aktionen im Attended-Modus auszuführen, markieren Sie die Aktion als Attended, oder fügen Sie dem in Orchestrator bereitgestellten Prozess die Beschriftung Attended hinzu.

Konfigurieren Sie die App für die Verwendung eines einzelnen Objekttyps

Wenn Sie nicht möchten, dass Aktionen basierend auf verschiedenen Objekttypen angezeigt werden (z. B und Konto) können Sie ihn so konfigurieren, dass ein einzelner Objekttyp verwendet wird:

1. Entfernen Sie den Standardwert der Variablen ConfigInputDataObjectTypeKeyName im Workflow Initiieren.
2. Entfernen Sie Type aus der Variablen ConfigRequiredInputProperties im Initiate-Workflow.
3. Remote-Schlüssel-Wert-Paar Type aus der ConfigQueryParameterNameMap -Variablen im Initiate-Workflow.
4. Legen Sie den Namen des Stammordners in der Variablen ConfigAutomationsRootFolder im Initiierungsworkflow fest.
5. Wenn sich der Stammordner auf der obersten Ebene befindet, können Sie den Wert in der ConfigAutomationsRootFolderPath entfernen. Wenn er sich auf einer verschachtelten Ebene befindet, legen Sie den Pfad des Stammordners in dieser Variablen fest.
6. Passen Sie das 360-Panel nach Bedarf an. Weitere Informationen finden Sie unter Im 360-Panel angezeigte Daten im Abschnitt Zusätzliche Anpassungen unten. Die Wechselfallblöcke können entfernt werden und Sie können den Satz von Wert zuweisen -Aktivitäten beibehalten. Aktualisieren Sie außerdem ggf. die ausgeblendete Eigenschaft des 360-Bereichs-Containers, sodass sie nur auf show360Spinner und nicht auf dem Typ basiert.

Aktionseingaben

Das Eingabeformular wird dynamisch basierend auf Eingabeargumenten erstellt. Das Formular unterstützt derzeit nur die folgenden primitiven Typen: Text, Zahl, Boolean, DateOnly. Wenn ein anderes Typargument übergeben wird, wird ein Textfeld angezeigt. Verwenden Sie für datumsbasierte Eingaben anstelle von DateTime DateOnly, um ein Datumsauswahlsteuerelement zu erhalten.

Aktionsausgaben

Alle Aktionsausgabeargumente werden im Automation Tracker mit dem Argumentnamen als Titel angezeigt. Die Werte von Ausgabeargumenten können Nur-Text oder HTML sein. Alle anderen empfangenen komplexen Daten werden im Zeichenfolgenformat angezeigt.

Automation Tracker unterstützt das Kopieren in die Zwischenablage. Eine der folgenden drei Optionen kann einem Element hinzugefügt werden, und das Element erhält ein Kopiersymbol:

• data-copyable="true" – Kopiert den Textinhalt des Elements.
• class="copyable" – Kopiert den Textinhalt des Elements.
• data-copy-text="custom text" – Kopiert den angegebenen benutzerdefinierten Text.

Einbetten der App

Sie können die App-URL aus einem Dialogfeld kopieren, das am Ende des Bereitstellungsprozesses angezeigt wird. Alternativ können Sie nach der Bereitstellung der App zu Orchestrator > Automatisierungen > [folder_name] > Apps navigieren, dann auf Weitere Optionen neben der App klicken und URL kopieren auswählen.

Weitere Informationen finden Sie unter Veröffentlichen, Bereitstellen und Aktualisieren von App-Projekten und Verwalten von Apps.

Wenn Sie die App in IFrames der Hostanwendung einbetten, fügen Sie embed_ in die URL ein, um die Anmeldung über ein Popup zu ermöglichen. Für den externen Ereignismodus schließen Sie den Abfrageparameter target ein und legen den Domänennamen als Wert fest, z. B &target=https://www.example.com. Zum Beispiel: 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.com

Zusätzliche Anpassungen

Die meisten Anpassungen können durch Bearbeiten von Variablen in den App-Workflow-Dateien vorgenommen werden. Die Variablen mit einem Namen, der mit Config beginnt, können geändert werden, um die App anzupassen. In einigen Szenarien müssen auch Aktivitäten aktualisiert werden.

• Eindeutiger Schlüsselname – Im Modus für externe Ereignisse kann das Eingabeanforderungsobjekt mehrere Eigenschaften haben, während im Modus mit den Abfrageparametern mehrere Abfrageparameter als Eingaben gesendet werden können. Die Eigenschaft, die den eindeutigen Bezeichner enthält, muss in der ConfigInputDataObjectUniqueKeyName -Variablen im Initiate-Workflow konfiguriert werden. In der Beispiel-App ist Id der Eigenschaftsname, der zum eindeutigen Identifizieren der aktuellen Anforderung verwendet wird. Dieser eindeutige Wert wird verwendet, um auch die Ergebnisse der Aktionsausführung beizubehalten.
• Schlüsselname des Eingabetyps – Um die Konfiguration verschiedener Stammordner basierend auf dem Anforderungstyp zu ermöglichen, muss die App den Eigenschaftsnamen kennen, der den Objekttyp enthält. Die Eigenschaft, die den eindeutigen Bezeichner enthält, muss in der ConfigInputDataObjectTypeKeyName -Variablen im Initiate-Workflow konfiguriert werden. In der Beispiel-App ist Type der Eigenschaftsname. Wenn Sie keine unterschiedlichen Objekttypen haben, entfernen Sie den Wert in dieser Variablen.
• Erforderliche Eigenschaften zum Starten – Wenn zum Starten des 360-Prozesses obligatorische Eingaben erforderlich sind, geben Sie diese Eigenschaften in der Variablen ConfigRequiredInputProperties im Initiieren-Workflow an. Wenn die definierten erforderlichen Eigenschaften keine Werte haben, wird zur Laufzeit eine Fehlermeldung ausgegeben und nachfolgende Aktivitäten werden nicht ausgeführt. Beachten Sie beim Konfigurieren dieser Variablen Folgendes:
  • Es ist obligatorisch, den eindeutigen Schlüsselnamen zur Sammlung hinzuzufügen.
  • Wenn Sie keine unterschiedlichen Objekttypen haben, sollten Sie den Schlüsselnamen des Eingabetyps nicht in die Sammlung aufnehmen.
  • Fügen Sie der Sammlung alle zusätzlichen erforderlichen Eigenschaften hinzu.
• Abfrageparameter konfigurieren: – Im Abfrageparametermodus werden die Werte der Parameter in der ConfigQueryParameterNameMap -Variablen in MainPage_Load_Initiate_Request_QueryParam.xaml abgerufen und auf das Eingabeobjekt festgelegt. In diesem Wörterbuch sind die Schlüssel die Eigenschaftsnamen im Eingabeobjekt und die Werte die Namen der Abfrageparameter.
• Im 360-Bereich angezeigte Daten – Dies wird konfiguriert, indem der Wert für jedes Element direkt festgelegt wird. In der Beispiel-App stehen zwei Sätze zur Verfügung, einer für den Falltyp und ein anderer für den Kontotyp . Wenn ein Satz angezeigt wird, wird der andere je nach Typ ausgeblendet. Beschriftungen sind statisch und können nach Bedarf geändert werden.
  • Legen Sie die jeweiligen Steuerelementwerte in der Aktivität Abfangen versuchen: Eingabedaten im Panel 360 im Workflow Initiate fest . Innerhalb dieses Blocks wird ein Schalter verwendet, um basierend auf dem Typ zu konfigurieren. Verwenden Sie diesen Block, um Werte basierend auf den Eingabeobjektdaten festzulegen.
  • Um festzulegen, dass Daten aus dem 360-Prozess im 360-Bereich angezeigt werden sollen, verwenden Sie die Aktivität Try Catch: Set 360 data from process in 360 Panel im Initiative-Workflow und konfigurieren Sie Werte nach Bedarf.
• Ausblenden des 360-Bereichs – Um den 360-Bereich in der App auszublenden, legen Sie die Variable ConfigHide360Panel im Initiative-Workflow auf True fest. Obwohl das Panel ausgeblendet ist, wird der 360-Prozess dennoch ausgeführt und die Werte werden verwendet, um Eingabeargumente im Formular vorab auszufüllen, wenn eine Aktion ausgeführt wird.
• Ordnen Sie Eingabeeigenschaften zu Aktionseingabeargumenten zu – Die Werte, die von einem externen Ereignis, Abfrageparameter und dem 360-Prozess stammen, können verwendet werden, um das vor dem Ausführen einer Aktion angezeigte Eingabeformular vorab auszufüllen. Wenn die Aktionsargumentnamen mit einem der Eigenschaftsnamen des Eingabeobjekts oder mit den Namen der 360-Ausgabeeigenschaft übereinstimmen, werden die Werte standardmäßig vorab aufgefüllt. Sie können zusätzliche Werte mit den folgenden Variablen im ActionListPage_StartActionButton_click.xaml -Workflow konfigurieren:
  • ConfigInputArgumentsInputObjectPropertyMap – Wörterbuch, bei dem die Schlüssel Namen der Aktionseingabeargumente und die Werte Eingabeobjekteigenschaftsnamen sind. Die Eingabeobjekte werden aus Abfrageparametern oder Meldungen von externen Ereignissen erstellt.
  • ConfigInputArgumentsDat360ObjectPropertyMap – Wörterbuch, bei dem die Schlüssel Namen von Aktionseingabeargumenten und die Werte Namen von 360-Ausgabeargumenten sind.
• Kontextbasierte Filterung von Aktionen aktivieren – Standardmäßig werden alle Aktionen immer für alle Anforderungstypen aufgelistet. Mit dieser Option können Sie verwandte Aktionen basierend auf dem aktuellen Anforderungskontext anzeigen. Um es zu aktivieren:
  1. Legen Sie im Workflow MainPage_Action_Folder_Change.xaml die Variable ConfigEnableContextFiltering auf True fest.
  2. Legen Sie den ConfigContextFilteringPropertyName -Wert auf den Eigenschaftsnamen aus dem 360-Prozessobjekt fest, der mit Aktionsbeschriftungen abgeglichen werden muss.
  3. Fügen Sie Tags zu bereitgestellten Aktionen im Orchestrator hinzu. Fügen Sie die Beschriftung Common zu Aktionen hinzu, die unabhängig vom Aktionstyp immer verfügbar sein sollen.
  4. Für andere Aktionen, die nur für bestimmte Anforderungstypen verfügbar sein sollten, fügen Sie nach Bedarf Tags hinzu. Aktionen werden angezeigt, wenn der Tag-Wert mit dem Wert der in Schritt 2 konfigurierten Eigenschaft übereinstimmt. Mehrere Tags können einer einzelnen Aktion hinzugefügt werden, um die Aktion für mehrere Anforderungstypen aufzulisten.
  5. Wenn Sie den Abfrageparametermodus verwenden, konfigurieren Sie auch die in den Schritten 1 und 2 erwähnten Variablen im MainPage_Load_Initiate_Request_QueryParam.xaml -Workflow.

Einschränkungen und Problemumgehungen

• Das benutzerdefinierte Listensteuerelement, das zum Anzeigen der Liste der Aktionen verwendet wird, kann nicht basierend auf dem verfügbaren Speicherplatz erweitert werden. Konfigurieren Sie die Höhe dieses Steuerelements so, dass es der am häufigsten verwendeten Bildschirmgröße entspricht.

  
• Jede Zeile in der benutzerdefinierten Liste hat eine feste Höhe. Wenn der Aktionsname oder die Beschreibung lang ist, wird sie möglicherweise abgeschnitten. Verwenden Sie einen kürzeren Namen und eine Beschreibung für eine bessere Ausrichtung.
• Der Workflow für externe Ereignisse kann nicht mit der Debugoption getestet werden. Zum Testen müssen Sie die App in einer Hostumgebung bereitstellen und integrieren.