Preparazione per l'invio di uno stato ai servizi Web REST

È possibile utilizzare oggetti notifica per inviare uno stato a un servizio Web REST per un'applicazione. Ad esempio, è possibile creare un oggetto notifica per monitorare quando un lavoro entra nella procedura ConservaLavoroCompletato in un flusso di lavoro che elabora gli ordini. Quando si verifica questo evento, l'oggetto notifica può inviare all'applicazione informazioni sul lavoro, ad esempio il numero d'ordine e il nome del cliente.
Per preparare l'invio di uno stato ai servizi Web REST:
  1. Reperire informazioni sui requisiti di comunicazione con il servizio Web REST per l'applicazione:
    • I valori per potersi autenticare con l'applicazione
    • I valori per poter richiedere i dati dal servizio Web REST
    • Il formato dei dati forniti nella risposta

    Fare riferimento alla documentazione dell'applicazione o consultare la compagnia che ospita l'applicazione.

  2. Per preparare RICOH ProcessDirector a comunicare con l'applicazione, eseguire le seguenti attività:
    • Se l'applicazione richiede un certificato di sicurezza, installare il certificato sul RICOH ProcessDirector computer principale.
    • Se l'ambiente richiede un server proxy per comunicare con i servizi Web, impostare il sistema in modo da poterlo utilizzare.

    Per maggiori informazioni, vedere le attività correlate.

  3. Eseguire un test manuale che si autentichi con l'applicazione e che richieda una risposta dal servizio Web REST. Verificare che il servizio Web restituisca la risposta desiderata.
    Molti browser dispongono di plugin, ad esempio Boomerang per Google Chrome, che testano le chiamate del servizio Web ai clienti REST.
  4. Decidere l'evento per cui si desidera attivare la notifica e le condizioni che determinano il momento in cui la notifica chiama il servizio Web.
    Se si vuole inviare una notifica per un evento che si verifica solo quando uno specifico flusso di lavoro elabora un lavoro, specificare il flusso di lavoro come condizione.
  5. Definire una notifica del servizio Web REST:
    1. Fare clic sulla scheda Amministrazione .
    2. Nel riquadro a sinistra, fare clic su Oggetti Notifiche.
    3. Fare clic su Aggiungi Notifica servizio Web REST.
    Come alternativa, è possibile copiare la notifica del servizio Web REST RestfulWebServiceSampleNotify fornita.
  6. Sulla scheda Generale, inserire un nome per la notifica.
  7. Sulla scheda Richiesta:
    1. Impostare la proprietà URL richiesta con l'URL del servizio Web che si desidera notificare.
    2. Impostare la proprietà Metodo richiesta con il valore richiesto dal servizio Web.
    3. Per il valore della proprietà Payload richiesta, specificare il corpo della richiesta dei servizi Web che il dispositivo di input trasmette all'applicazione.
      In questo esempio XML, il payload contiene due elementi XML: <Token> e <OrderNumber>.

      <Token>${WSNotification.WebService.Credential}</Token> <OrderNumber>${Job.Info.Attr1}</OrderNumber>

      Il valore per ciascun elemento è un simbolo RICOH ProcessDirector che contiene una proprietà. Se si sta utilizzando un servizio Web per autenticarsi con l'applicazione, includere la proprietà WSNotifica.WebService.Credenziali in un simbolo. Sostituite l'altro elemento e la proprietà con gli elementi e le proprietà che si desidera inviare all'applicazione. La notifica risolve i simboli quando invia lo stato al servizio Web REST.

    4. Impostare i valori per le proprietà Intestazione richiesta e Parametri richiesta, come richiesto.
      Ciascun campo intestazione o parametro è una coppia parola chiave/valore. Ciascuna coppia deve figurare su una riga distinta e deve essere separata da due punti (:) o il segno uguale (=).

      La parola chiave e il valore possono essere composti da più parole. RICOH ProcessDirector utilizza i primi due punti o il primo segno uguale su ciascuna riga per separare le parole nella coppia parola chiave/valore.

      Questo esempio contiene tre parametri: token, orderNumber e customerName. Il valore di ciascuna parola chiave è un simbolo RICOH ProcessDirector. Ciascun simbolo contiene una di queste proprietà: WSNotifica.WebService.Credenziali, Lavoro.Info.Attr1 e Lavoro.NomeCliente.

      token:${WSNotification.WebService.Credential} orderNumber:${Job.Info.Attr1} customerName:${Job.CustomerName}

      Il dispositivo di input risolve i simboli quando invia lo stato al servizio Web REST.

    5. Se l'ambiente richiede un server proxy per comunicare con i servizi Web, impostare la proprietà Usare il proxy con il server proxy corretto.
  8. Sulla scheda Autenticazione, specificare i valori richiesti per autenticarsi con l'applicazione.
    Per maggiori informazioni, vedere l'attività correlata inerente all'autenticazione con un servizio Web REST.

    Se l'applicazione non richiede l'autenticazione, lasciare tutte le proprietà Autenticazione vuote.

  9. Nella scheda Evento:
    1. Scegliere il tipo di oggetto da monitorare.
    2. Selezionare la proprietà, l'azione e il valore da monitorare.
    3. Per definire un altro evento, fare clic sul simbolo + situato a destra dell'evento.
    4. Per eliminare un evento, fare clic sul simbolo - a destra dell'evento da eliminare.
    Ad esempio, per inviare una notifica quando lo stato di un lavoro cambia in Conservato, selezionare Stato lavoro attuale, Cambia in e Conservato.
  10. Nella scheda Condizioni:
    1. Selezionare la proprietà e il valore da rispettare prima dell'invio di qualsiasi notifica.
    2. Per definire un'altra condizione, fare clic sul simbolo + situato a destra dell'evento.
      Per specificare come sono associate le condizioni, selezionare Qualsiasi, Tutte o Personalizzazione.
    3. Per eliminare una condizione, fare clic su - a destra della condizione da eliminare.
    Ad esempio, per inviare una notifica solo quando un lavoro secondario è nel flusso di lavoro ElaboraOrdiniWeb, specificare due condizioni:
    • Flusso di lavoro = ProcessWebOrders
    • Numero lavoro come*.*

    Per applicare le condizioni solo quando un lavoro le rispetta entrambe, selezionare Tutte.

  11. Al termine, fare clic su OK.

Una volta terminata l'impostazione di dispositivi di input, notifiche e flussi di lavoro, testare lo scambio di dati tra RICOH ProcessDirector e l'applicazione.

Esempio

Esaminare la notifica del servizio Web REST RestfulWebServiceSampleNotify fornita.