Preparação para enviar status para serviços web REST

É possível usar objetos de notificação para enviar status para um serviço web REST de um aplicativo. Por exemplo, você pode criar um objeto de notificação para monitorar quando uma tarefa é enviada para a etapa RetainCompletedJobs em um fluxo de trabalho que processa pedidos. Quando esse evento acontece, o objeto de notificação pode enviar as informações do aplicativo sobre a tarefa, tais como o número do pedido e o nome do cliente.

Para preparar para envio de status para 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 sobre o evento para o qual deseja acionar a notificação e as condições que determinam quando a notificação chama o serviço web.
Caso queira enviar uma notificação para um evento que ocorre somente quando um fluxo de trabalho específico processa uma tarefa, especifique esse fluxo de trabalho como uma condição.
Defina uma notificação de serviço web REST:
1. Clique na guia Administração.
2. No painel esquerdo, clique em Objetos ⇒ Notificações.
3. Clique em Adicionar ⇒ Notificação de Serviço Web REST.
Ou então, copie a notificação de serviço web REST RestfulWebServiceSampleNotify fornecida.
Na guia Geral, insira um nome para a notificação.
Na guia Solicitação:
1. Defina a propriedade Request URL para a URL do serviço web que deseja notificar.
2. Defina a propriedade Request method para o valor exigido pelo serviço web.
3. 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.
  Nesse exemplo XML, a carga contém dois elementos XML: <Token> e <OrderNumber>.
  <Token>${WSNotification.WebService.Credential}</Token> <OrderNumber>${Job.Info.Attr1}</OrderNumber>
  
  O valor de cada elemento é um símbolo RICOH ProcessDirector que contém uma propriedade. Se você estiver usando um serviço web para autenticar com o aplicativo, inclua a propriedade WSNotification.WebService.Credential em um símbolo. Substitua o outro elemento e a propriedade pelos elementos e propriedades que deseja enviar ao aplicativo. A notificação resolve os símbolos quando envia o status para o serviço web REST.
4. 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, orderNumber e customerName. O valor de cada palavra-chave é um símbolo RICOH ProcessDirector. Cada símbolo contém uma destas propriedades: WSNotification.WebService.Credential, Job.Info.Attr1 e Job.CustomerName.
  
  token:${WSNotification.WebService.Credential}orderNumber:${Job.Info.Attr1}customerName:${Job.CustomerName}
  
  O dispositivo de entrada resolve os símbolos quando envia o status para o serviço web REST.
5. 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.
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.
Na guia Evento:
1. Escolha o tipo de objeto a ser monitorado.
2. Selecione a propriedade, a ação e o valor a ser monitorado.
3. Para definir outro evento, clique em + à direita de qualquer evento.
4. Para excluir um evento, clique em - à direita do evento que deseja excluir.
Por exemplo, para enviar uma notificação quando o estado de uma tarefa é alterado para Retained, selecione Current job state, Changes to e Retained.
Na guia Condições:
1. Selecione a propriedade e o valor que devem ser satisfeitos antes de enviar qualquer notificação.
2. Para definir outra condição, clique em + à direita de qualquer evento.
  Para especificar como as condições são combinadas, selecione Any, All ou Custom.
3. Para excluir uma condição, clique em - à direita da condição que você quer excluir.
Por exemplo, para enviar uma notificação somente quando uma tarefa filha está no fluxo de trabalho ProcessWebOrders, especifique duas condições:
- Workflow = ProcessWebOrders
- Número da tarefa como*.*
Para aplicar as condições somente quando uma tarefa satisfizer ambas, selecione All.
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.

Exemplo

Examine a notificação do serviço web REST RestfulWebServiceSampleNotify fornecida.

RICOH ProcessDirector™ para AIX

Preparação para enviar status para serviços web REST

Related information: