Configurando o aplicativo CX Companion

O CX Companion pode ser usado como está ou personalizado de acordo com as necessidades do seu negócio. Esta seção documenta como você pode configurar o CX Companion, usando o aplicativo de exemplo para exemplificar algumas das configurações.

Pré-requisitos

• O CX Companion requer que um Serverless ou Unattended Robot seja configurado na pasta implantada.
• Recomendamos usar o CX Companion no modo de eventos externos, mas observe que, para facilitar o uso, o modo de parâmetros de consulta está habilitado por padrão. Consulte a seção Configurar o modo de entrada de dados abaixo para obter mais detalhes. Ao usar eventos externos:
  • Para se integrar com o Salesforce, instale e configure o plug-in CX Companion SF no Salesforce.
  • Para fazer a integração com uma plataforma de host diferente, instale e configure o UiPath Communication Driver no aplicativo de host.
• Para executar ações no modo Attended, o CX Companion requer o UiPath Assistant versão 2025.0.167 ou posterior.
• Se quiser iniciar outros aplicativos a partir do CX Companion, você deve usar o conector do Apps no Integration Service. Certifique-se de que as políticas de governança de sua organização estejam configuradas para permitir o uso deste conector:
  • Como esse conector está atualmente disponível em versão prévia, a opção Habilitar pacotes e atividades de visualização deve ser selecionada na política de governança do Studio Web implantada em sua organização. Isso disponibiliza a atividade List Deployed Apps em fluxos de trabalho. Para obter mais informações, consulte Configurações para políticas do Studio Web no guia do Automation Ops.
  • Certifique-se de que o conector do Apps esteja habilitado na sua política do Integration Service. Para obter mais informações, consulte Configurações para políticas do Integration Service no guia do Automation Ops.

Configure o modo de entrada de dados

O aplicativo pode usar um dos seguintes modos de entrada de dados:

• Parâmetros de consulta - Use essa opção se o CX Companion for implantado como independente. Para permitir que você teste rapidamente o aplicativo CX Companion, essa opção é habilitada por padrão no modelo. O fluxo de trabalho iniciar para usar parâmetros de consulta é MainPage_Load_Initiate_Request_QueryParam.xaml.
• Eventos externos - Use essa opção se você quiser incorporar o CX Companion a um aplicativo de host, como o Salesforce. O fluxo de trabalho iniciar para usar eventos externos é MainPage_Initiate_Request.xaml. Essa é a opção recomendada, mas não está habilitada por padrão no modelo. Para usar essa opção:

  • No designer de aplicativos CX Companion - No painel Propriedades do aplicativo, certifique-se de que Eventos externos esteja habilitado e adicione o domínio do seu aplicativo host na caixa de texto Origens permitidas . Para obter mais informações sobre como habilitar eventos externos, consulte Definir um contexto externo usando eventos externos.

    

  • No designer de aplicativos CX Companion - Desabilite o modo de parâmetros de consulta abrindo o Data Manager no arquivo de fluxo de trabalho

    MainPage_Load_Initiate_Request_QueryParam.xaml e definindo a variável ConfigEnableQueryParamMode como False. O valor padrão é True.
  • No aplicativo host - Para Salesforce, instale e configure o plug-in CX Companion SF. Para todos os outros aplicativos de host, instale e configure o Driver de comunicação da UiPath.

Configure um processo do 360 (opcional)

Um processo simulado do 360 é incluído na solução e invocado pelo aplicativo para recuperar dados do cliente do aplicativo host. Você pode personalizar esse processo conforme necessário ou criar outro processo, publicá-lo no Orchestrator e configurar o CX Companion para usá-lo selecionando-o na atividade Invoke Process: Start 360 Process no fluxo de trabalho iniciar e configurando os argumentos necessários conforme necessário.

Configurar a pasta para ações

As ações se referem às automações, aplicativos e agentes publicados no Orchestrator que os usuários podem executar. O CX Companion é configurado para ter diferentes pastas para ações com base no tipo de objeto de entrada. Por exemplo, no aplicativo de exemplo, dois tipos são definidos, Caso e Conta. Desde que a estrutura da pasta no Orchestrator corresponda à configuração no aplicativo, quando um registro de um determinado tipo for carregado no aplicativo, o painel Ações é preenchido com as ações na pasta definida para aquele tipo.

1. Abra o Data Manager no fluxo de trabalho iniciar para o modo de entrada de dados.
2. Insira o caminho da pasta raiz de automações no campo de valor da variável ConfigAutomationsRootFolderPath . Por exemplo, CXCompanionAutomation/AllActions no aplicativo de exemplo.
3. Configure os tipos de automação na variável ConfigAutomationFoldersByType . Nesta variável de dicionário, cada chave é um tipo de objeto e seu valor é o nome da subpasta do Orchestrator que contém as automações para esse tipo de objeto.

   No aplicativo de exemplo, a variável é configurada da seguinte forma:

   Chave	Valor
   Caso	Automações de caso
   Conta	Automações de conta

   Isso corresponde à seguinte estrutura de pastas no Orchestrator.

   

   No painel Ações do aplicativo, as ações para o tipo de objeto são exibidas, com uma aba representando cada subpasta encontrada na pasta para esse tipo.

   
4. Configure se os aplicativos implantados serão incluídos nas ações disponíveis:
   • Se você estiver usando o modo de parâmetros de consulta e também quiser iniciar aplicativos implantados, configure a atividade List Deployed Apps em MainPage_Load_Initiate_Request_QueryParam.xaml e em MainPage_Initiate_Request.xaml adicionando uma conexão ao UiPath Apps.
   • Se você estiver usando o modo de eventos externos e quiser também implantar aplicativos, configure a atividade List Deployed Apps em MainPage_Initiate_Request.xaml adicionando uma conexão UiPath Apps, e exclua ou desabilite a atividade If: Load Apps list se estiver habilitada em MainPage_Load_Initiate_Request_QueryParam.xaml.
   • Se você não pretende implantar aplicativos do CX Companion, exclua ou desabilite a atividade Se: Carregar lista de aplicativos se estiver habilitada em ambos os fluxos de trabalho de inicialização.

5. Após a solução ser implantada:

   1. Acesse a pasta em que o aplicativo está implantado e edite-o.
   2. Na página Requisitos do pacote , selecione a configuração de conexão.
   3. Se você quiser que a mesma conexão seja usada por todos os usuários, selecione essa conexão. Se você quiser permitir que usuários de aplicativos criem suas próprias conexões, selecione Configurável por usuários para solicitar que os usuários criem uma conexão na primeira vez que carregarem o aplicativo.

Observação: você pode testar o aplicativo usando automações simuladas de amostra.

Execução no modo Attended ou Unattended

O CX Companion requer que um Serverless ou Unattended Robot seja configurado na pasta implantada.

Para executar ações no modo não assistido ou sem servidor, depois de implantar o aplicativo, você pode usar o URL em seu ambiente de host sem necessidade de nenhuma configuração adicional.

Se você precisar executar algumas ações no modo Attended, você deve executar o aplicativo no modo Attended anexando um parâmetro de consulta à URL do aplicativo:

• Ao usar o CX Companion dentro do Salesforce, anexe attendedMode=enabledWithRobotJSHandler.
• Ao usar o CX Companion dentro de outro sistema de terceiros, anexe attendedMode=enabled.

Certifique-se de que o Assistant esteja em execução e conectado ao mesmo tenant no qual o aplicativo está implantado. O CX Companion requer o Assistant versão 2025.0.167 ou posterior.

Por padrão, todas as ações serão executadas apenas no modo não assistido, mesmo que o aplicativo esteja sendo executado no modo assistido. Para executar ações no modo assistido, marque a ação como assistida ou adicione o rótulo Attended ao processo implantado no Orchestrator.

Configurar o aplicativo para usar um único tipo de objeto

Se você não quiser que as ações sejam exibidas com base em diferentes tipos de objetos (por exemplo caso e conta), é possível configurá-lo para usar um único tipo de objeto:

1. Remova o valor padrão da variável ConfigInputDataObjectTypeKeyName no fluxo de trabalho iniciado.
2. Remova Type da variável ConfigRequiredInputProperties no fluxo de trabalho iniciado.
3. Par de chave-valor remoto Type da variável ConfigQueryParameterNameMap no fluxo de trabalho iniciado.
4. Defina o nome da pasta raiz na variável ConfigAutomationsRootFolder ao iniciar o fluxo de trabalho.
5. Se a pasta raiz estiver no nível superior, você poderá remover o valor no ConfigAutomationsRootFolderPath. Se estiver em um nível aninhado, defina o caminho da pasta raiz nesta variável.
6. Personalize o painel 360 conforme necessário. Para obter detalhes, consulte Dados exibidos no painel 360 na seção Personalizações adicionais abaixo. Os blocos Switch Case podem ser removidos e você pode manter o conjunto de atividades Assign Value. Além disso, se aplicável, atualize a propriedade oculta do contêiner do painel 360 para ser baseado apenas em show360Spinner e não no tipo.

Entradas de ação

O formulário de entrada é criado dinamicamente com base em argumentos de entrada. Atualmente, o formulário é compatível apenas com os seguintes tipos primitivos: Text, Number, Boolean, DateOnly. Se qualquer outro argumento de tipo for passado, uma caixa de texto será exibida. Para entradas baseadas em data, em vez de usar DateTime, use DateOnly para obter um controle de seletor de data.

Saídas de ação

Todos os argumentos de saída da ação são mostrados no Automation Tracker com o nome do argumento como título. Os valores dos argumentos de saída podem ser texto simples ou HTML. Quaisquer outros dados de tipo complexo recebidos são exibidos em formato de string.

O Automation Tracker é compatível com cópia para a área de transferência. Uma das três opções a seguir pode ser adicionada a um elemento e o elemento receberá um ícone de cópia:

• data-copyable="true" - Copia o conteúdo de texto do elemento.
• class="copyable" - Copia o conteúdo de texto do elemento.
• data-copy-text="custom text" - Copia o texto personalizado especificado.

Incorporando o aplicativo

Você pode copiar o URL do aplicativo de uma caixa de diálogo exibida no final do processo de implantação. Como alternativa, depois de implantar o aplicativo, navegue até Orchestrator > Automations > [folder_name] > Apps e, em seguida, clique em Mais opções ao lado do aplicativo e selecione Copiar URL.

Para obter mais informações, consulte Publicação, implantação e atualização de projetos de aplicativos e Gerenciamento de aplicativos.

Ao incorporar o aplicativo em friames do aplicativo host, inclua embed_ na URL para permitir o login por meio de um pop-up. Para o modo de eventos externos, inclua o parâmetro de consulta target e defina o nome de domínio como o valor, por exemplo &target=https://www.example.com. Por exemplo: 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

Personalizações adicionais

A maioria das personalizações pode ser feita editando variáveis nos arquivos de fluxo de trabalho do aplicativo. As variáveis com nome que começa com Config podem ser alteradas para personalizar o aplicativo. Em alguns cenários, as atividades também devem ser atualizadas.

• Nome de chave exclusivo – No modo de eventos externos, o objeto de solicitação de entrada pode ter várias propriedades, enquanto que, no modo de parâmetros de consulta, vários parâmetros de consulta podem ser enviados como entradas. A propriedade que contém o identificador exclusivo deve ser configurada na variável ConfigInputDataObjectUniqueKeyName no fluxo de trabalho iniciar. No aplicativo de exemplo, Id é o nome da propriedade usado para identificar exclusivamente a solicitação atual. Esse valor exclusivo também é usado para manter os resultados de execução da ação.
• Tipo de entrada nome da chave — para permitir configurar diferentes pastas raiz com base no tipo de solicitação, o aplicativo precisa saber o nome da propriedade que contém o tipo de objeto. A propriedade que contém o identificador exclusivo deve ser configurada na variável ConfigInputDataObjectTypeKeyName no fluxo de trabalho iniciar. No aplicativo de exemplo, Type é o nome da propriedade. Se você não tiver tipos diferentes de objetos, remova o valor nesta variável.
• Propriedades necessárias para iniciar - Se quaisquer entradas obrigatórias forem necessárias para iniciar o processo do 360, especifique essas propriedades na variável ConfigRequiredInputProperties no fluxo de trabalho iniciar. Se as propriedades obrigatórias definidas não tiverem valores, uma mensagem de erro será exibida no runtime e as atividades subsequentes não serão executadas. Ao configurar essa variável, considere que:
  • É obrigatório adicionar um Nome de chave exclusivo à coleção.
  • Se você não tiver tipos diferentes de objetos, você não deve incluir o nome da chave do tipo Entrada na coleção.
  • Adicione quaisquer propriedades necessárias adicionais à coleção.
• Configurar parâmetros de consulta: - No modo de parâmetro de consulta, os valores dos parâmetros na variável ConfigQueryParameterNameMap em MainPage_Load_Initiate_Request_QueryParam.xaml serão buscados e definidos como o objeto de entrada. Neste dicionário, as chaves são os nomes das propriedades no objeto de entrada e os valores são os nomes dos parâmetros de consulta.
• Dados exibidos no painel 360 — isso é configurado definindo diretamente o valor para cada item. No aplicativo de exemplo, dois conjuntos estão disponíveis, um para o tipo de caso e outro para o tipo de conta . Quando um conjunto é exibido, o outro fica oculto com base no tipo. Os rótulos são estáticos e podem ser alterados conforme necessário.
  • Defina os respectivos valores de controle na atividade Try Catch: defina os dados de entrada no Painel 360 ao iniciar o fluxo de trabalho. Dentro desse bloco, um Switch é usado para configurar com base no tipo. Use esse bloco para definir valores com base nos dados do objeto de entrada.
  • Para definir dados do processo 360 para serem exibidos no painel 360, use a atividade Try Catch: definir dados 360 do processo no Painel 360 no início do fluxo de trabalho e configure os valores conforme necessário.
• Ocultando o painel 360 — Para ocultar o painel 360 do aplicativo, defina a variável ConfigHide360Panel como True ao iniciar o fluxo de trabalho. Mesmo que o painel esteja oculto, o processo 360 ainda é executado e os valores são usados para preencher previamente os argumentos de entrada no formulário quando uma ação é executada.
• Mapear propriedades de entrada para argumentos de entrada de ação - Os valores provenientes de um evento externo, parâmetro de consulta e o processo 360 podem ser usados para preencher previamente o formulário de entrada mostrado antes de executar uma ação. Por padrão, se os nomes dos argumentos da ação corresponderem a qualquer um dos nomes de propriedades do objeto de entrada ou de saída, os valores serão pré-preenchidos. Você pode configurar valores adicionais usando as seguintes variáveis no fluxo de trabalho ActionListPage_StartActionButton_click.xaml :
  • ConfigInputArgumentsInputObjectPropertyMap — dicionário em que as chaves são nomes de argumentos de entrada de ação e os valores são nomes de propriedades de objeto de entrada. Os objetos de entrada são criados a partir de parâmetros de consulta ou mensagens de eventos externos.
  • ConfigInputArgumentsDat360ObjectPropertyMap - Dicionário em que as chaves são nomes de argumentos de entrada de ação e os valores são nomes de argumentos de saída 360.
• Habilitar a filtragem baseada em contexto de ações — por padrão, todas as ações estão sempre listadas para todos os tipos de solicitação. Usando essa opção, você pode exibir ações relacionadas com base no contexto da solicitação atual. Para habilitá-lo:
  1. No fluxo de trabalho MainPage_Action_Folder_Change.xaml , defina a variável ConfigEnableContextFiltering como True.
  2. Defina o valor ConfigContextFilteringPropertyName como o nome da propriedade a partir do objeto de processo do 360 que deve corresponder aos rótulos de ação.
  3. Adicione tags a ações implantadas no Orchestrator. Adicione o rótulo Common às ações que você deseja que estejam sempre disponíveis, independentemente do tipo de ação.
  4. Para outras ações que devem estar disponíveis apenas para tipos de solicitação específicos, adicione tags conforme a necessidade. As ações serão exibidas quando o valor da tag corresponder ao valor da propriedade configurada na etapa 2. É possível adicionar várias tags a uma única ação para listar a ação para vários tipos de solicitação.
  5. Se você estiver usando o modo de parâmetro de consulta, configure também as variáveis mencionadas nas etapas 1 e 2 no fluxo de trabalho MainPage_Load_Initiate_Request_QueryParam.xaml .

Limitações e soluções alternativas

• O controle da lista personalizada que é usado para mostrar a lista de ações não pode ser expandido com base no espaço disponível. Configure a altura desse controle para que ele se adeque ao tamanho de tela mais usado.

  
• Cada linha na lista personalizada tem uma altura fixa. Se o nome ou a descrição da ação for longo, ele pode ficar truncado. Use um nome mais curto e uma descrição para um melhor alinhamento.
• O fluxo de trabalho de eventos externos não pode ser testado usando a opção de depuração. Para testar, você deve implantar e integrar o aplicativo em um ambiente de host.