ServiceNow

Contact Center AI Platform (plataforma CCAI) oferece integração com o CRM do ServiceNow.

Configurações do desenvolvedor do ServiceNow

Requisitos mínimos preferenciais da versão do ServiceNow: Tokyo patch 1

Configurar um usuário de autenticação básica

É provável que a conta de administrador do ServiceNow tenha a verificação em duas etapas ativada e associada a esse usuário. Como resultado, ela não pode ser usada para receber acesso de administrador na plataforma CCAI. Para isso, crie uma conta de usuário no ServiceNow.

Crie um usuário básico com credenciais:

  1. Acesse Usuário > Novo.

  2. Preencha os detalhes e selecione "Acesso somente ao serviço da Web".

  3. Anote o ID do usuário e a senha.

Papéis necessários no ServiceNow

Os papéis padrão no ServiceNow são pré-configurados para fornecer acesso e permissões específicos na plataforma. Os administradores podem criar e configurar funções que concedem permissões específicas, que controlam o que os usuários e grupos com essa função podem fazer.

Para realizar essa integração, você precisa ter os seguintes papéis no ServiceNow:

  • user_admin: esse papel é destinado a administradores que precisam gerenciar usuários, grupos, locais e empresas na instância do ServiceNow.

  • sn_incident_read: esse papel fornece acesso somente leitura ao aplicativo de gerenciamento de incidentes e às funções relacionadas. Ele permite que os usuários visualizem registros de incidentes.

  • sn_incident_write: esse papel concede acesso de gravação ao aplicativo de gerenciamento de incidentes e às funções relacionadas, permitindo que os usuários criem e modifiquem registros de incidentes.

  • personalize_dictionary: esse papel permite personalizar entradas e rótulos de dicionário para atender a requisitos de negócios específicos.

  • function_field_admin: essa função é destinada a usuários que precisam criar, editar e visualizar campos de função especificamente no designer de relatórios. Ele não permite criar ou excluir campos de função da lista ou do formulário da plataforma.

Configurar visualizações de instância

As seções a seguir descrevem as mudanças de configuração necessárias para instanciar visualizações.

(Opcional) Adicionar favoritos

Os Favoritos são uma maneira rápida de encontrar os links usados com frequência na instância do ServiceNow. Para adicionar um favorito, selecione o ícone de estrela ao lado de um campo no painel "Navegador". Se você quiser filtrar o painel do navegador para ver apenas seus favoritos, selecione o ícone de estrela diretamente abaixo do campo do navegador de filtro no painel do navegador.

Exemplos de favoritos úteis:

  • Incidentes: associações a registros para CRM personalizado.

  • Usuários: associações a contas para CRM personalizado.

  • APIs Explorer: uma boa maneira de testar a API.

Adicionar campos personalizados manualmente

Selecione o ícone de expansão (três linhas horizontais) no canto superior esquerdo da visualização de objeto que você quer mudar. Isso pode ser feito na visualização de autoatendimento ou na visualização padrão.

  1. No menu, selecione Configure > Form Design para abrir o Form Designer.

  2. Na coluna à esquerda, selecione a guia Tipos de campo.

  3. Arraste o tipo de campo personalizado que você quer adicionar.

  4. Depois de soltar o tipo de campo na seção desejada, selecione o ícone de engrenagem para ver as Configurações.

  5. Dentro da janela, mude o rótulo e anote o nome. O nome é o que você usa nas configurações do app da plataforma CCAI.

  6. Selecione Salvar no canto superior direito da tela.

Mapear dados da sessão para o CRM

É preciso mapear os dados de sessão apropriados do CCAIP usando o Dialogflow e os seguintes parâmetros:

Dados do agente virtual

{
  "ujet": {
    "session_variable": {
      "capture_target": "payload",
      "payload": {
        "value_one": "$session.params.payload_value_one"
      };
      "capture_type": [ "comment", "field" ] // optional, default of ["comment"]
    }
  }
}

Metadados

https://INSTANCE.service-now.com/api/now/table/sys_dictionary?sysparm_query=name%3Dsys_user https://INSTANCE.service-now.com/api/now/table/sys_dictionary?sysparm_query=name%3Dincident

Rótulo: column_label

Chave de API: element

Os campos personalizados estão no mesmo nível dos campos padrão na resposta de sys_user ou incident.

Fazer upload de um arquivo da CCAI Platform para o CRM

https://INSTANCE_URL.service-now.com/api/now/attachment/upload

Método: POST

Formato de dados da solicitação: property

Localizador de dados de resposta: data.result

Tipo: Multi-part form

Tipo de anexo: Attachment Url

URL do anexo: download_link

Parâmetros: table below

Exemplo de solicitação:

{
    file: FILE_DATA,
    table_name: incident,
    table_sys_id: RECORD_ID
}

Integrar adaptadores de agente (formulários personalizados)

As etapas a seguir mostram como ativar os adaptadores de agente e a função de clique para ligar na instância do ServiceNow.

Instalar e configurar o OpenFrame

  1. Acesse Todos > Aplicativos do sistema > Todos os aplicativos disponíveis > Todos.

  2. Pesquise por OpenFrame.

  3. Instale o OpenFrame.

  4. Após a instalação, acesse All > OpenFrame > Configurations.

  5. Criar configuração com um URL. Se você tiver várias configurações em uma instância do ServiceNow, talvez o usuário não tenha acesso a uma configuração recém-criada. Verifique seus grupos e a lista de pedidos de configuração do OpenFrame para determinar qual configuração o usuário está usando.

  6. Digite sys_properties.list na pesquisa.

  7. Editar glide.ui.concourse.onmessage_enforce_same_origin_whitelist.

  8. Adicione o novo URL à lista de valores.

  9. Editar sn_openframe.cross.origin.access.

  10. Adicione autoplay à lista de valores.

Ativar a experiência da Next UI para os usuários

  1. Digite sys_properties.list na barra de navegação e clique em Enter.

  2. Defina a propriedade do sistema glide.ui.polaris.experience como true.

  3. Defina a preferência do usuário glide.ui.polaris.use como false para o sistema.

  4. Defina a preferência do usuário glide.ui.polaris.use como true para um usuário. Você pode criar uma linha de preferência do usuário.

Atualizar propriedades do sistema

  1. Digite sys_properties.list na barra de navegação e pressione Enter.

  2. Editar glide.ui.concourse.onmessage_enforce_same_origin_whitelist.

  3. Adicione o URL à lista de valores. Vários valores precisam ser separados por vírgulas.

  4. Editar sn_openframe.cross.origin.access.

  5. Adicione autoplay à lista de valores.

  6. Editar glide.ui.polaris.experience.

  7. Mude para false, porque alguns recursos não funcionam se estiverem ativados.

Adicionar o recurso de clique para ligar na parte de cima do formulário

  1. Acesse IU do sistema > Ações da IU.

  2. Selecione Criar nova ação.

  3. No formulário, selecione a tabela em que esse clique para ligar será incluído.

  4. Para formulários com uma referência a um contato ou usuário, use a API g_form.getReference para acessar o número de telefone do usuário. Para tabelas personalizadas, o ID de referência e os atributos resultantes podem ser diferentes. A comunicação com a CCAI Platform será a mesma, então o payload e a estrutura de dados precisam permanecer idênticos ao seguinte:

    function clickToDial() {
      var user = g_form.getReference('caller_id',function(res) {
        var phone = res.phone || res.mobile_phone;
        var payload = {"name": "clicktodial", "number": phone};
        var data = {"payload": payload, "method": "openframe_communication" };
        CustomEvent.fireAll("openframe_request", data);
      });
    }
    
  5. Para formulários com um número para ligar, use a API g_form.getValue para recuperar os valores relevantes. Este é um exemplo da ação UI para a tabela "Usuários". Para tabelas personalizadas, os nomes dos campos do formulário podem ser diferentes. A comunicação com a CCAI Platform será a mesma, então o payload e a estrutura de dados precisam permanecer idênticos ao seguinte:

    function clickToDial() {
      var phone = g_form.getValue('phone') || g_form.getValue('mobile_phone');
      var payload = {"name": "clicktodial", "number": phone};
      var context = {"payload": payload, "method" : "openframe_communication" };
      CustomEvent.fireAll("openframe_request", context);
    }
    

Adicionar o recurso de clique para ligar ao lado das referências

  1. O botão de chamada ao lado das referências aos contatos precisa ser editado no formulário. Clique com o botão direito do mouse no campo e acesse Configure Dictionary. Para atributos, adicione o valor show_phone ou show_phone_customer_service ao valor ref_contributions.

  2. Em "UI Macros", edite show_phone e show_phone_customer_service.

  3. Substitua:

Anterior:

var task =    {"entity": p.attr('data-task-table'), "query" :"sys_id="+p.attr('data-task-id')+"$[AMP]sysparm_view="+p.attr('data-task-view'),"value":p.attr('data-task-value'),"label":p.attr('data-task-label')};
                                        var company = {"entity": p.attr('data-company-table'),"query":"sys_id="+p.attr('data-company-id')+"$[AMP]sysparm_view="+p.attr('data-task-view'),"value":p.attr('data-company-value'),"label":p.attr('data-company-label')};
                                        var caller = {"entity": p.attr('data-caller-table'),"query": "sys_id="+p.attr('data-caller-id')+"$[AMP]sysparm_view="+p.attr('data-task-view'),"value":p.attr('data-caller-value'),"label":p.attr('data-caller-label')};

                                        var callContext = [];
                                        callContext.push(task);
                                        callContext.push(company);
                                        callContext.push(caller);

                                        var metaData = {"phoneNumber":p.attr('data-caller-phone'),"taskId":p.attr('data-task-id')};

                                        var data =    {"metaData":metaData , "data": callContext};
                                        var payload = {"type": "OUTGOING_CALL", "data" : data};
                                        var createInteractionData ={};
                                        createInteractionData.interactionSysId = -1;
                                        createInteractionData.direction = 'outbound';
                                        createInteractionData.context_document = p.attr('data-task-id');
                                        createInteractionData.context_table = p.attr('data-task-table');
                                        createInteractionData.account = p.attr('data-company-id');
                                        if(p.attr('data-caller-table') === 'customer_contact')
                                                createInteractionData.contact = p.attr('data-caller-id');
                                        createInteractionData.opened_for = p.attr('data-caller-id');

                                        var ga = new GlideAjax('sn_openframe.OpenFrameAjaxUtility');
                                        ga.addParam('sysparm_name', 'createInteractionWithPropertyCheck');
                                        ga.addParam('context', JSON.stringify(createInteractionData));
                                        ga.getXML(function(serverResponse) {
                                                var result = serverResponse.responseXML.getElementsByTagName("result");
                                                var output = JSON.parse(result[0].getAttribute("data"));
                                                if(output.status == "success"){
                                                        var interaction = {"entity": "interaction", "query" :"sys_id="+output.fields.interactionSysId, "value":output.fields.number, "label":"Interaction", "display":false};
                                                        payload.data.data.push(interaction);
                                                }
                                                var context = {"payload": payload, "method" : "openframe_communication" };
                                                jslog("context with interaction : "+ JSON.stringify(context));
                                                CustomEvent.fireAll("openframe_request", context);
                                        });

Novo:

var phone = p.attr('data-caller-phone')
                   var payload = {"name": "clicktodial", "number": phone};
                   var data = {"payload": payload, "method": "openframe_communication" };
                   CustomEvent.fireAll("openframe_request", data);

Configurações de CRM

As etapas a seguir mostram como conectar a API ao ServiceNow usando o portal da CCAI Platform.

  1. No portal da plataforma CCAI, acesse Configurações > Configurações do desenvolvedor > CRM.

  2. Na seção "Plataforma de Agentes", selecione ServiceNow.

  3. Insira as informações do domínio do ServiceNow no campo Domínio do ServiceNow. Pode ser uma instância de desenvolvedor ou de fornecedor, conforme necessário, mas é uma correlação direta com a instância e é a primeira parte do URL no endereço da Web do portal do ServiceNow: https://{your instance}.servicenow.com.

  4. No campo Seleção de nuvem do ServiceNow, selecione Incident para um tipo de tíquete básico. Se você selecionar Custom, outras opções vão aparecer. Os incidentes são extensões da tabela de tarefas. Os objetos personalizados precisam ser extensões de incidentes.

  5. Nos campos Credenciais de autenticação, insira seu nome de usuário e senha.

  6. Se você tiver selecionado Incident para o tipo de campo de seleção de nuvem, os seguintes campos serão exibidos:

    • O objeto de conta de pesquisa inclui três campos suspensos: Object Type, Phone Number lookup fields e Phone number primary field.
  7. Se você tiver selecionado Custom para o tipo de campo de seleção de nuvem, os seguintes campos serão exibidos:

    • Objeto de registro de pesquisa:

      • Tipo de objeto de registro base: selecione um tipo de tabela task ou incident.

      • Tipo de objeto de registro: esse campo será preenchido com dados se uma tabela de incidentes tiver sido estendida. Você poderá selecioná-lo, se necessário.

      • O objeto de conta de pesquisa inclui três campos suspensos: Object Type, Phone Number lookup fields e Phone number primary field.

  8. Campos de ID do usuário personalizados: marque esta caixa se quiser ativar campos de pesquisa de usuário personalizados para sessões do SDK para Web ou para dispositivos móveis ou da API Apps (Chat).

  9. Formato do número de telefone: permite selecionar o formato que você quer usar para exibir números de telefone.

  10. Arquivo de metadados de sessão: marque esta caixa para anexar metadados de sessão aos registros do CRM.

  11. Clique em Salvar para salvar as opções selecionadas.

Campos personalizados para registros

Esses são os campos personalizados que já foram criados para a instância do ServiceNow no Form Designer e podem ser usados na CCAI Platform. Também é possível criar outros campos personalizados selecionando Criar na seção "Campos personalizados para registros" no menu.

Campo Tipo Definição
u_ujet_custom_field_after_call_work String Duração do trabalho após a ligação
u_ujet_custom_field_call_duration String Duração da chamada
u_ujet_custom_field_comm_id Inteiro ID de chamada ou chat, dependendo do tipo de contato
u_ujet_custom_field_rating Inteiro Pontuação de CSAT
u_ujet_custom_field_email_via_web String E-mail enviado pela Web
u_ujet_custom_field_feedback String Feedback
u_ujet_custom_field_from_phone_number String Número de telefone do autor da chamada
u_ujet_custom_field_hold_duration String Tempo total de espera
u_ujet_custom_field_menu_path String Seleção de menu
u_ujet_custom_field_queue_name String Nome da fila
u_ujet_custom_field_session_type String Tipo de sessão
u_ujet_custom_field_verification Verdadeiro/falso Confirmar que a verificação foi concluída
u_ujet_custom_field_wait_time String Tempo de espera total

Configurar o OAuth

Para configurar o OAuth, siga as etapas para criar um aplicativo OAuth no ServiceNow. Em seguida, insira as credenciais (ID e chave secreta do cliente OAuth) em Configurações do desenvolvedor > CRM > Método de autenticação.

Criar um aplicativo OAuth no ServiceNow

  1. Na sua conta do ServiceNow, acesse Todos > OAuth do sistema > Registro de aplicativos.

  2. Crie um aplicativo OAuth e selecione Criar um endpoint de API OAuth para clientes externos.

  3. Configure os seguintes campos:

    • Nome: insira um nome exclusivo.

    • ID do cliente: o ID do cliente é gerado automaticamente pelo servidor OAuth do ServiceNow.

    • Chave secreta do cliente: é a chave secreta do cliente para o aplicativo OAuth. Deixe em branco para gerar automaticamente.

    • Vida útil do token de atualização: o tempo, em segundos, em que o token de atualização será válido.

    • Ciclo de vida do token de acesso: o tempo, em segundos, em que o token de acesso será válido.

    • URL de redirecionamento: insira o URL do seu ambiente e o subdiretório. Por exemplo: https://servicenow.yourcompany.co/v1/servicenow/oauth_callback

    • Aplicar restrição de token: restringe o uso do token de acesso às APIs definidas nas políticas de acesso da API REST encontradas na documentação do ServiceNow. Se você desmarcar essa opção, o token de acesso poderá ser usado em outras APIs REST.

  4. Clique em Enviar.

  5. Depois de criar o aplicativo, volte ao registro e recupere o ID do cliente e a chave secreta do cliente recém-criada.

Atualizar as configurações de desenvolvedor

  1. Acesse Configurações do desenvolvedor > CRM.

  2. Verifique se as configurações foram inseridas e definidas de acordo com as etapas anteriores.

  3. Em "Método de autenticação", clique em OAuth.

  4. Insira o ID do cliente OAuth e a chave secreta do cliente OAuth. Consulte a etapa 5 acima.

  5. Clique em Salvar.

  6. Clique em vincular credenciais.

Mapeamento de campos personalizados para o agente virtual

Se estiver usando o Agente Virtual, configure esse campo na tela Mapeamentos de campos personalizados. Isso permite que as variáveis do agente virtual sejam transferidas do payload da sessão do agente virtual para o ServiceNow. Os nomes das variáveis podem ser qualquer string. Os rótulos de campo listados aqui são um exemplo.

Na tela Mapeamentos de campos personalizados, configure a conexão entre as variáveis criadas pelas definições de payload usadas na configuração inicial do agente virtual e a variável relevante no ServiceNow.

Título do mapeamento de campo Rótulo do campo do CRM Rótulo do campo de dados personalizado
Feedback sobre o agente virtual ccaip_custom_field_incident_feedback va_feedback

Adicionar mapeamento de campos do CRM

  1. Acesse Configurações > Gerenciamento de operações.

  2. Acesse a seção Mapeamento de campos personalizados do CRM > clique em Ver tudo.

  3. Clique no link + Adicionar mapeamento de campo do CRM.

    • Título do mapeamento de campos: nome da CCAI Platform para esse mapeamento de campos personalizados usado no portal da CCAI Platform.

    • Rótulo do campo do CRM: rótulo no CRM do campo do CRM que você está mapeando.

    • Rótulo do campo de dados do cliente (chave de dados do cliente): o nome da chave de nível superior no payload de dados do cliente da Plataforma CCAI que você quer mapear (por exemplo, device para payloads do SDK ou orderId para payloads de chat da API Apps). Essa chave precisa ser enviada pelos SDKs da Web ou para dispositivos móveis da CCAI Platform ou (para interações de chat) usando o endpoint Send custom data in a chat da API Apps. A chave precisa ser exatamente igual (incluindo letras maiúsculas e minúsculas).

  4. Clique em Salvar.

Definir outras configurações

Você vai encontrar as outras configurações que permitem integrar corretamente a CCAI Platform à sua instância do ServiceNow no menu suspenso Configurações. Consulte os links na lista a seguir para mais informações sobre como configurar cada seção.

Resultados do teste

Agora é possível verificar a funcionalidade dos fluxos de chamada e chat clicando nos botões relevantes na parte de cima da tela do portal da CCAI Platform. É importante garantir que o bloqueador de pop-ups esteja desativado ao realizar esse teste.

Um Incidente será criado no ServiceNow, com o contato de chamada ou chat listado na seção Atividades do incidente. Isso precisa aparecer como uma Nota de trabalho, em vez de um comentário de incidente, para que essa atividade de back-end não fique visível para os clientes.

A descrição do caso será preenchida automaticamente com "Ligar usando a plataforma CCAI" ou "Conversar usando a plataforma CCAI" e talvez precise ser atualizada pelos agentes.

Quando estiver satisfeito com os resultados da chamada ou do chat, insira um código e uma observação de resolução (se os campos de código e observações de resolução do ServiceNow tiverem sido configurados) e feche o caso.

Para verificar se o caso foi encerrado, talvez seja necessário clicar no botão de navegação back no navegador. É esperado que, na instância do ServiceNow, depois de resolver o caso, ele seja fechado automaticamente e você seja direcionado para uma página de registro do cliente.