Configurar os serviços web de saída

Este artigo contém os seguintes tópicos:

O serviço web de saída permite que o ServiceAide Cloud Service Management interaja com sistemas externos, usando chamadas de serviços web SOAP ou RESTful. A operação de serviço web de saída está vinculada a uma ação do fluxo de trabalho. Quando um analista executa a ação do fluxo de trabalho em um ticket, a operação de serviço web de saída é iniciada. Se o aplicativo externo retorna uma resposta para a chamada de serviço web, o produto aceita a resposta e atualiza o ticket.

Como administrador, você pode configurar adaptadores de serviço web e definir o mapeamento do campo para permitir a troca de dados com aplicativos externos.

Ao configurar serviços web de saída, aplicativos externos podem trocar dados com o produto sem a criação de um mecanismo de pesquisa. Você pode configurar a troca de dados para atualizar os campos do aplicativo externo e no aplicativo. A troca de dados ocorre em resposta a uma chamada iniciada pelo produto.

Conclua as seguintes tarefas para configurar os serviços web de saída.

Coletar informações sobre os pré-requisitos

Para configurar serviços web de saída para um aplicativo externo, adquira conhecimento básico sobre os serviços web que ele suporta. Identifique também os campos no aplicativo externo e os campos correspondentes no produto.

Colete as credenciais necessárias para configurar as chamadas de serviço web de saída. As credenciais variam, dependendo se o aplicativo externo usa serviços web SOAP ou RESTful.

Chamadas de serviço web com base em SOAP

O ServiceAide Cloud Service Management usa WSDL (Web Service Description Language - Linguagem de Descrição de Serviço Web) para se comunicar com aplicativos com base em SOAP. O arquivo WSDL do aplicativo externo contém as informações que são necessárias para configurar as operações de serviço web. O documento WSDL contém informações tais como métodos, mapeamento de campo e muito mais.

Para acessar um serviço web, localize sua entrada da WSDL. Normalmente, a entrada da WSDL é um URL na web. As empresas controlam o acesso a seus arquivos da WSDL para níveis diferentes. Para acesso, entre em contato com o administrador do aplicativo externo.

Chamadas de serviços web RESTful

As chamadas de serviço web RESTful não estão definidas em um documento formal. No entanto, alguns aplicativos externos definem os serviços web com suporte. Você pode encontrar as operações suportadas no arquivo WADL (Web Application Description Language) do aplicativo.

Geralmente, as chamadas de serviços web RESTful não exigem autenticação. Entre em contato com o administrador do aplicativo externo se o aplicativo requer autenticação.

Colete as seguintes informações sobre os pré-requisitos para planejar os serviços web de saída:

1. Verifique se o aplicativo externo oferece serviços web. Você não pode continuar se o aplicativo externo não oferecer serviços web.
2. Verifique se o aplicativo externo oferece suporte a chamadas de serviço web com base em SOAP ou em RESTful.
   • Para um aplicativo que oferece suporte a chamadas com base em SOAP, determine o caminho para a entrada da WSDL e o nível de autenticação. Colete informações que podem ser usadas para configurar as credenciais.
   • Para um aplicativo que suporta chamadas de serviço web RESTful, determine se os serviços web suportados foram definidos. Quando os serviços web tiverem sido definidos, colete informações sobre o caminho para a entrada da WADL. Você pode continuar sem especificar o caminho WADL para serviços web não definidos.
3. Verifique se você consegue conectar o produto ao aplicativo externo. Execute ping no servidor do aplicativo externo pelo servidor web do ServiceAide Cloud Service Management. Verifique se há erros no resultado. Você não pode continuar se o servidor web do ServiceAide Cloud Service Management não for capaz de estabelecer conexão com o aplicativo externo.
4. Identifica o URL que é chamado para acessar a entrada de WSDL/WADL para o aplicativo externo. Quando identificar o URL, confirme os seguintes requisitos:
   • O acesso e a autenticação necessários para chamar o serviço web.
   • Confirme se o aplicativo externo requer autenticação básica. Obtenha o nome de usuário e a senha do aplicativo externo.
   • Confirme se o aplicativo usa controle com base na sessão. Você pode obter essas informações do WSDL.
5. Identifica o mapeamento do campo que você deseja configurar. Confirme se os campos que você deseja mapear estão disponíveis no produto. Identifique todos os campos adicionais que você precisa para a configuração que planeja.
6. Identifique o tipo de operação que deseja configurar. Você pode configurar as operações de serviços web e as ações de fluxo de trabalho relacionadas de acordo com este plano.

Configurar atributos e modelos de campo personalizado para o mapeamento de campo

Durante o processo de planejamento, é possível identificar os requisitos de mapeamento de campo. Quando os campos de ticket padrão e os campos personalizados existentes não bastarem, você pode configurar os atributos personalizados. Em seguida, é possível relacionar os atributos aos modelos de campo personalizado. Você pode identificar o nome do atributo e o tipo de dados e, em seguida, configurar os atributos. Ao relacionar os campos personalizados aos modelos de campo personalizado, os atributos se tornam disponíveis para mapeamento do campo.

Observação: o mapeamento de campo personalizado para o campo Data não conta com suporte.

Para obter mais informações sobre a criação de atributos, consulte Criar e gerenciar atributos.

Para obter mais informações sobre a criação de modelos de campo personalizado, consulte Criar e gerenciar modelos de campo personalizado.

Ativar invocação de serviço web

Siga estas etapas:

1. Vá para ESPAÇOS DE TRABALHO, ADMINISTRAÇÃO, Ferramentas, Parâmetros de configuração.
2. No campo Pesquisa, procure o parâmetro ATIVAR_INVOCACAO_SERVICOS_WEB_EXTERNOS.
3. Clique no nome de parâmetro na lista para exibir os detalhes do parâmetro.
4. Defina o valor do parâmetro como Sim.

O produto agora oferece suporte à troca de dados usando chamadas de serviço web de saída.

Configurar as credenciais do serviço web

O ServiceAide Cloud Service Management usa as credenciais de serviços web para estabelecer conexão com o aplicativo externo para troca de dados. Você pode criar e gerenciar as credenciais necessárias para chamar os serviços web externos para a troca de dados. As mesmas credenciais de serviço web externo podem ser usadas para todos os métodos de autenticação que o aplicativo externo suporta.

Siga estas etapas:

1. Vá para ESPAÇOS DE TRABALHO, ADMINISTRAÇÃO, Ferramentas, Credenciais de serviços web.
   A guia Credenciais do serviço web é exibida. Você pode filtrar a lista para ver as credenciais ativas ou inativas. Você pode modificar uma credencial existente ou criar credenciais aqui. Você pode fornecer credenciais de serviço web para o aplicativo externo aqui.
2. Forneça as informações necessárias e clique em Salvar.

Quando você clica em Salvar, as seções Resumo e Operações relacionadas aparecem.

Configurar operações de serviços web para chamadas com base em SOAP

As operações de serviços web permitem a troca de dados entre o produto e o aplicativo externo. Depois de configurar as credenciais de serviço web, é possível configurar várias operações usando os métodos que o aplicativo externo suporta.

Siga estas etapas:

1. Vá para ESPAÇOS DE TRABALHO, ADMINISTRAÇÃO, Ferramentas e selecione Operações de serviços web.
2. Forneça o nome, a descrição e as credenciais para o aplicativo externo.
3. Digite os detalhes do mapeamento de campo para a operação de serviço web. Especifique informações como:
   • O tipo de associação de serviço web usado para a operação.
   • O método usado para a operação.
   • Duração de tempo limite da operação.
   • O tipo de ticket para o qual essa operação está disponível.

4. (Opcional) Especifica o mapeamento de saída. O valor do campo do ticket que você especifica aqui preenche o campo correspondente do aplicativo externo.
   É possível mapear os campos por meio do arquivo XML ou pelos campos suspensos.

   1. Para usar o arquivo XML, marque a caixa de seleção Configuração avançada. O conteúdo do XML é exibido. Você pode fornecer o mapeamento do campo de saída, especificando os valores em nós relevantes. Quando você usa as Configurações Avançadas, pode ver todo o XML da solicitação SOAP e usar o mesmo na solicitação de chamada SOAP. A configuração avançada inclui uma área de texto de crescimento automático. Você pode usar o ícone de pesquisa para abrir a pesquisa de entidade e selecionar os tokens de entidade. Os tokens de entidade que você selecionar são substituídos como valores de campo externo. No XML de solicitação SOAP, os tokens podem ser inseridos, colocando o cursor sobre ou selecionando o texto que precisa ser substituído pelo token. Os tokens de entidade que você selecionar são substituídos como valores de campo externo quando a solicitação é enviada para o aplicativo externo.

   2. Para especificar o mapeamento de campo usando as opções do menu suspenso, forneça as informações a seguir e clique no ícone + para adicionar o mapeamento:
      Campo externo
      Selecione um campo externo no menu suspenso. O menu suspenso processa dinamicamente com base no método que você escolher no campo Selecionar método.
      Campo do ticket
      Especifique os tokens de campo do ticket do ServiceAide Cloud Service Management para mapear o campo do ticket que é atualizado quando a operação de serviço web é executada no ticket. Você pode usar campos de ticket padrão, campos personalizados ou tokens de usuário que você configura.
      Exemplo: campo do ticket padrão ${description_long}
      Observação: os campos que são exibidos como campos obrigatórios no documento do WSDL são exibidos na lista Campo externo por padrão.

5. (Opcional) Especifica o mapeamento de entrada. O valor do aplicativo externo é atualizado no campo de ticket correspondente no aplicativo. Mencione o campo do ticket e o xpath para o campo do aplicativo externo. Você também pode mapear até dez exibir campos de entidade. Os campos de entidade de exibição fornecem informações adicionais para fins de referência, mas não são salvos no ticket. É possível exibir os campos de entidade de exibição na página de detalhes do ticket, no tipo de atributo Pesquisa de serviço web.
   
6. Clique em Salvar.

A operação de serviço web é configurada.

Agora, é possível relacionar a operação de serviço web a uma ação do fluxo de trabalho.

Configurar as operações de serviços web para chamadas RESTful

As operações de serviços web permitem a troca de dados entre o produto e o aplicativo externo. Depois de configurar as credenciais de serviço web, é possível configurar várias operações usando os métodos que o aplicativo externo suporta.

Siga estas etapas:

1. Vá para ESPAÇOS DE TRABALHO, ADMINISTRAÇÃO, Ferramentas e selecione Operações dos serviços web.
2. Forneça o nome, a descrição e as credenciais do serviço web para o aplicativo externo.
3. Especifique os detalhes do mapeamento de campo para a operação de serviço web. Especifique informações como:
   • Tipo de entidade da operação ou o tipo de ticket aplicável.
   • Endereço do terminal do serviço web.
   • Método usado para a operação.
   • Duração de tempo limite da operação.
4. (Opcional) Especifica o mapeamento de saída. O valor do campo do ticket que você especifica aqui preenche o campo correspondente do aplicativo externo. Quando uma WADL é configurada para o serviço web, os valores de aplicativo externo são processados em um menu suspenso. Os valores que são processados dependem do método que você seleciona no campo Selecionar método. Você pode selecionar um valor no menu suspenso para configurar o mapeamento de saída. Quando uma WADL não está configurada, os campos são exibidos como áreas de texto. Você pode inserir manualmente os valores válidos. Os campos que são exibidos como campos obrigatórios na exibição de documento da WADL nos campos externos por padrão.
5. (Opcional) Para usar o arquivo XML ou JSON, marque a caixa de seleção Configuração avançada. Você pode fornecer o mapeamento do campo de saída, especificando os valores em nós relevantes. Quando você usa as Configurações avançadas, é exibida uma caixa de texto para inserir o conteúdo XML ou JSON. Você pode usar o ícone de pesquisa para abrir a pesquisa de entidade e selecionar os tokens de entidade. Os tokens de entidade que você selecionar são substituídos como valores de campo externo. No XML ou JSON da solicitação REST, os tokens são inseridos, colocando o cursor sobre ou selecionando o texto que precisa ser substituído pelo token. Os tokens de entidade que você selecionar são substituídos como valores de campo externo quando a solicitação é enviada para o aplicativo externo.
6. (Opcional) Especifica o mapeamento de entrada. O valor do aplicativo externo é atualizado no campo de ticket correspondente no produto. Mencione o campo do ticket e o caminho para o campo do aplicativo externo.
   Observação:
   • Não use caracteres curinga ou operadores no caminho de pesquisa do XML para mapeamentos de entrada.

   • Verifique se que você mapeou apenas o nó obrigatório do arquivo de resposta para configurar o valor de entrada do mapeamento. Por exemplo, no seguinte trecho de código, se você deseja preencher a ID do atributo, então, digite o nó como employees.employee.id. Especificar o nó como employees.employee não preenche nenhum atributo.

     
7. Clique em Salvar.

A operação de serviço web é configurada.

Agora, é possível relacionar a operação de serviço web a uma ação do fluxo de trabalho.

Relacionar as configurações de serviço web às ações de fluxo de trabalho

Depois de configurar a operação do serviço web, é possível relacionar a operação a uma ação do fluxo de trabalho. O aplicativo chama a operação de serviço web quando o analista executa a ação do fluxo de trabalho correspondente em um ticket.

É possível relacionar uma operação de serviço web a uma ação do fluxo de trabalho na página ESPAÇOS DE TRABALHO, ADMINISTRAÇÃO, Ferramentas, Ações do fluxo de trabalho. Use o campo Operações dos serviços web de uma ação do fluxo de trabalho para relacionar a ação a uma configuração de serviço web.

Você pode configurar ações de fluxo de trabalho usando chamadas de serviço web SOAP e RESTful.

Para obter informações sobre as ações de fluxo de trabalho, consulte Criar e gerenciar ações do fluxo de trabalho.

Verificar as configurações

Para verificar a configuração, é necessário ter acesso ao produto e ao aplicativo externo.

Considere o exemplo a seguir. Você pode configurar o serviço web de saída para se comunicar com o CA Service Desk Manager. Você quer que a criação de uma solicitação de serviço no ServiceAide Cloud Service Management resulte na criação de um incidente no CA Service Desk Manager. Para ativar a comunicação, configure as credenciais de serviço web para o CA Service Desk Manager. Em seguida, configure a operação de serviço web para criar um incidente no CA Service Desk Manager. Configure o mapeamento de saída para fazer com que o campo de detalhes do ticket atualize o campo de detalhes de ticket correspondente no CA Service Desk Manager.

Configure o mapeamento do campo para atualizar os campos personalizados no produto com os detalhes do ticket no CA Service Desk Manager. Em seguida, configure uma ação do fluxo de trabalho CASD_Create Ticket e relacione-a com a operação de serviço web. Atribua a permissão de grupo de suporte L1 à ação do fluxo de trabalho.

Para verificar as configurações, envie um ticket e use a ação de trabalho para mover o ticket pelo fluxo de trabalho. Todas as operações de serviço web são registradas no painel do ticket. Você pode ver a operação de serviço web, a hora de início e a hora de término e o status da operação. Quando a operação de serviço web falha, a mensagem de log de rastreamento fornece mais informações sobre a causa da falha.

Siga estas etapas:

1. Efetue logon no aplicativo como analista.
2. Clique em ESPAÇOS DE TRABALHO, CENTRAL DE ATENDIMENTO, Central de tickets.
3. Clique em Ações, Criar solicitação.
4. Fornece informações básicas, como detalhes e descrição na seção Sobre do ticket.
5. Clique em Ações, CASD_Create Ticket (essa ação é a ação do fluxo de trabalho que você criou).
6. Faça logon no CA Service Desk Manager usando as credenciais apropriadas.
7. Vá para a lista de tickets e pesquise por tickets recentemente criados.

Se a lista de tickets exibir o ticket de incidente correspondente, isso indicará que a chamada de serviços web de saída foi bem-sucedida. Você pode ir até o ticket no produto para verificar se há mais detalhes no painel do ticket.