Preparação para recuperar entrada de serviços web REST
- Saiba os requisitos de comunicação com o serviço web REST para o aplicativo:
- Os valores para autenticação com o aplicativo
- Os valores para solicitar dados do serviço web REST
- O formato dos dados fornecidos na resposta
Consulte a documentação do aplicativo ou consulte a empresa que hospeda o aplicativo.
- Para preparar RICOH ProcessDirector para se comunicar com o aplicativo, execute as seguintes tarefas:
- Se o aplicativo exigir um certificado de segurança, instale o certificado no computador primário de RICOH ProcessDirector.
- Se o seu ambiente exigir um servidor proxy para se comunicar com serviços web, configure o sistema para usá-lo.
Para obter mais informações, consulte as tarefas relacionadas.
- Execute um teste manual que autentique com o aplicativo e que solicita uma resposta
do serviço web REST. Verifique se o serviço web retorna a resposta que você deseja.Muitos navegadores possuem plug-ins, como Boomerang para Google Chrome, que testam chamadas de serviço web clientes REST.
- Decida como deseja que o dispositivo de entrada de serviço web REST crie trabalhos
dos dados na resposta retornada pelo serviço web.
- Sempre que o dispositivo de entrada receber uma resposta, ele poderá criar uma tarefa que contém todos os dados XML ou JSON na resposta.
- O dispositivo de entrada pode examinar a resposta usando uma expressão XPath ou JSONPath.
Se o dispositivo de entrada encontrar elementos XML ou objetos JSON especificados pela expressão, criará uma tarefa para cada elemento ou objeto correspondente. Cada tarefa contém o elemento ou objeto correspondente e todos os elementos ou objetos aninhados nela. Se o dispositivo de entrada encontrar dois ou mais elementos ou objetos, poderá criar tarefas independentes ou tarefas filhas.
Se o dispositivo de entrada não encontrar elementos correspondente, não criará uma tarefa.
- Defina um dispositivo de entrada do serviço web REST:
- Clique na guia Administração.
- Na área de janela à esquerda, clique em .
- Clique em .
Ou então, copie o dispositivo de entrada de serviço web REST RestfulWebServiceSample fornecido. - Na guia Geral:
- Digite um nome para o dispositivo de entrada.
- Defina a propriedade Polling interval para o tempo que deseja que o dispositivo de entrada aguarde entre chamadas de serviço web.
- Depois de definir um fluxo de trabalho para processar tarefas XML ou JSON, defina a propriedade Child workflow para o nome desse fluxo de trabalho.
- Digite valores para as outras propriedades que deseja definir.
- Na guia Solicitação:
- Defina a propriedade Request URL para a URL do serviço web que retorna dados que RICOH ProcessDirector utiliza para criar uma ou mais tarefas.
- Defina as propriedades Request method e Request content type para os valores exigidos pelo serviço web.
- Para o valor da propriedade Request payload, especifique o corpo da solicitação dos serviços web que o dispositivo de entrada
envia para o aplicativo.Para especificar uma credencial ou token e um intervalo de tempo que corresponda ao valor da propriedade Polling interval, use símbolos para essas propriedades:
Nome do banco de dados da propriedade Nome da interface com o usuário da propriedade Observações WebService.Credential Nenhum RICOH ProcessDirector armazena a credencial ou o token do serviço web nessa propriedade. WebService.CurrentRequestTime Nenhum RICOH ProcessDirector configura o valor dessa propriedade no início do intervalo de varredura. WebService.LastSuccessRequestTime Guia Status: Hora da última solicitação bem-sucedida Quando o dispositivo de entrada se comunica com êxito com o aplicativo, RICOH ProcessDirector configura o valor dessa propriedade para corresponder ao valor da propriedade WebService.CurrentRequestTime. Uma comunicação bem-sucedida resulta em um código de resposta 200, mesmo se não houver dados recebidos que RICOH ProcessDirector possa usar para criar tarefas. - Obs.:
- Essas três propriedades da tarefa são usadas como XML valores de exemplo para a propriedade Request payload e como valores JSON de exemplo para a propriedade Parâmetros da solicitação. Os requisitos do serviço web determinam quais propriedades você usa para enviar esses e outros valores.
Nesse exemplo XML, a carga inclui estes elementos: <Token>, <TimeRange>, <Start> e <End>. Os valores dos três elementos são símbolos:
<Token>${WebService.Credential}</Token><TimeRange> <Start>${WebService.LastSuccessRequestTime}</Start> <End>${WebService.CurrentRequestTime}</End></TimeRange>
O dispositivo de entrada resolve os símbolos quando executa varredura para entrada.
- Defina os valores para as propriedades Cabeçalho da solicitação e Parâmetros da solicitação conforme necessário.Cada campo de cabeçalho ou parâmetro é um par palavra-chave/valor. Cada par deve aparecer em uma linha separada e deve ser separado usando sinais de dois pontos (:) ou de igual (=).
A palavra-chave e o valor podem ser várias palavras. RICOH ProcessDirector usa o primeiro sinal de dois pontos ou de igual em cada linha para dividir as palavras em par palavra-chave/valor.
Este exemplo contém três parâmetros: token, start e end. O valor de cada palavra-chave é um símbolo RICOH ProcessDirector. Cada símbolo contém uma destas propriedades: WebService.Credential, WebService.LastSuccessRequestTime e WebService.CurrentRequestTime.
token:${WebService.Credential}start:${WebService.LastSuccessRequestTime}end:${WebService.CurrentRequestTime}
O dispositivo de entrada resolve os símbolos quando executa varredura para entrada.
- Selecione um valor para a propriedade Create job from response para especificar como o dispositivo de entrada cria tarefas a partir da entrada:
- Para criar uma tarefa sempre que o dispositivo de entrada receber uma resposta, selecione Always.
- Para examinar o XML ou JSON na resposta e criar uma tarefa sempre que um elemento XML ou objeto JSON for encontrado, selecione Only when response pattern matches.
- Se você tiver selecionado Only when response pattern matches:
- Defina a propriedade Response pattern to match para a expressão XPath que identifica o elemento XML ou para a expressão JSONPath que identifica o objeto JSON.
- Defina a propriedade Create child jobs para Yes se desejar criar tarefas filhas quando o dispositivo de entrada encontrar duas ou mais correspondências. O dispositivo de entrada também cria uma tarefa pai sem nenhum dado. Se o dispositivo de entrada encontrar uma correspondência, criará uma tarefa independente.
- Defina a propriedade Create child jobs para No se desejar criar tarefas independentes, independentemente de quantas correspondências o dispositivo de entrada encontrar.
- Se o seu ambiente exigir um servidor proxy para se comunicar com serviços web, configure a propriedade Use proxy para o servidor proxy correto.
- Defina a propriedade Time zone offset para o deslocamento em horas entre Coordinated Universal Time (UTC) e o fuso horário
usado pelo serviço web.Por exemplo, se o serviço web usar Pacific Standard Time, defina a propriedade para -8.
- Obs.:
- Certifique-se de alterar essa propriedade quando um local que hospeda o serviço web alternar entre horário padrão e de verão. Caso contrário, ao perder ou ganhar uma hora, você poderá perder os dados que RICOH ProcessDirector usa para criar tarefas.
- Se o serviço web usar UTC, insira 0 ou deixe o campo em branco.
- Na guia Autenticação, especifique os valores necessários para autenticar com o aplicativo.Para obter mais informações, consulte a tarefa relacionada sobre como autenticar com um serviço web REST.
Se o aplicativo não exigir autenticação, deixe todas as propriedades da autenticação em branco.
- Opcional: Na guia Avançado, especifique todas as propriedades opcionais para o seu ambiente.
- Quando terminar, clique em OK.
Ao concluir a configuração de seus dispositivos de entrada, notificações e fluxos de trabalho, teste a troca de dados entre RICOH ProcessDirector e o aplicativo.
Examine o dispositivo de entrada do serviço web REST RestfulWebServiceSample fornecido.