Preparazione per il recupero dell'input dei servizi Web REST
- 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.
- 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.
- 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.
- Decidere come si desidera che il dispositivo di input del servizio Web REST crei lavori
dai dati nella risposta inviata dal servizio Web.
- Ogni volta che riceve una risposta, il dispositivo di input può creare un lavoro contenente tutti i dati XML o JSON nella risposta.
- Il dispositivo di input può esaminare la risposta utilizzando un'espressione XPath
o JSONPath.
Se rileva elementi XML od oggetti JSON specificati dall'espressione, il dispositivo di input crea un lavoro per ogni elemento od oggetto corrispondente. Ogni lavoro contiene l'elemento o l'oggetto corrispondente nonché tutti gli elementi e gli oggetti in esso nidificati. Se rileva due o più elementi od oggetti, il dispositivo di input può creare lavori indipendenti o lavori secondari.
Se non rileva elementi corrispondenti, il dispositivo di input non crea alcun lavoro.
- Identificare un dispositivo di input del servizio Web REST:
- Fare clic sulla scheda Amministrazione .
- Nel pannello a sinistra, fare clic su .
- Fare clic su .
Come alternativa, è possibile copiare il dispositivo di input del servizio Web REST RestfulWebServiceSample. - Sulla scheda Generale:
- Inserire un nome per il dispositivo di input.
- Impostare la proprietà Intervallo di polling con il periodo di attesa del dispositivo di input tra le chiamate al servizio Web.
- Dopo aver identificato un flusso di lavoro per elaborare i lavori XML o JSON, impostare la proprietà Flusso di lavoro secondario con il nome del flusso di lavoro scelto.
- Inserire i valori per le altre proprietà che si desidera impostare.
- Sulla scheda Richiesta:
- Impostare la proprietà URL richiesta con l'URL del servizio Web che restituisce i dati utilizzati da RICOH ProcessDirector per creare uno o più lavori.
- Impostare le proprietà Metodo richiesta e Tipo contenuto richiesta con i valori richiesti dal servizio Web.
- Per il valore della proprietà Payload richiesta, specificare il corpo della richiesta dei servizi Web che il dispositivo di input
trasmette all'applicazione.Per specificare credenziali o token e l'intervallo di tempo che corrisponde al valore della proprietà Intervallo di polling, utilizzare i simboli per queste proprietà:
Nome database della proprietà Nome della proprietà dell0interfaccia utente Osservazioni WebService.Credenziali Nessuno RICOH ProcessDirector archivia le credenziali o il token del servizio Web in questa proprietà. WebService.OraRichiestaCorrente Nessuno RICOH ProcessDirector imposta il valore di questa proprietà all'inizio dell'intervallo di polling. WebService.LastSuccessRequestTime Scheda stato: Ora ultima richiesta successo Quando il dispositivo di input comunica con successo con l'applicazione, RICOH ProcessDirector imposta il valore di questa proprietà in modo che corrisponda al valore della proprietà WebService.OraRichiestaCorrente. Una comunicazione di successo comporta un codice di risposta 200, anche se non sono stati ricevuti dati che RICOH ProcessDirector possa utilizzare per creare lavori. - Nota:
- Queste tre proprietà di lavoro vengono utilizzate come valori XML di esempio per la proprietà Payload richiesta e come valori JSON di esempio per la proprietà Parametri richiesta. I requisiti del servizio Web determinano quali proprietà utilizzare per trasmettere questi e altri valori.
In questo esempio XML, il payload include questi elementi: <Token>, <TimeRange>, <Start> e <End>. I valori di tre elementi sono simboli:
<Token>${WebService.Credential}</Token> <TimeRange> <Start>${WebService.LastSuccessRequestTime}</Start> <End>${WebService.CurrentRequestTime}</End> </TimeRange>
Il dispositivo di input risolve i simboli quando esegue il polling per l'input.
- 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, start e end. Il valore di ciascuna parola chiave è un simbolo RICOH ProcessDirector. Ciascun simbolo contiene una di queste proprietà: WebService.Credenziali, WebService.OraUltimaRichiestaSuccesso e WebService.OraRichiestaCorrente.
token:${WebService.Credential} start:${WebService.LastSuccessRequestTime} end:${WebService.CurrentRequestTime}
Il dispositivo di input risolve i simboli quando esegue il polling per l'input.
- Selezionare un valore per la proprietà Crea lavoro da risposta per specificare come il dispositivo di input crea lavori dall'input:
- Per creare un lavoro ogni volta che il dispositivo di input riceve una risposta, selezionare Sempre.
- Per esaminare XML o JSON nella risposta e creare un lavoro ogni volta che un elemento XML o un oggetto JSON viene rilevato, selezionare Solo quando il modello risposta corrisponde.
- Se è stato selezionato Solo quando il modello risposta corrisponde:
- Impostare la proprietà Modello risposta da corrispondere con l'espressione XPath che identifica l'elemento XML o l'espressione JSONPath che identifica l'oggetto JSON.
- Impostare la proprietà Crea lavori secondari con Sì se si desidera creare lavori secondari quando il dispositivo di input rileva due o più corrispondenze. Il dispositivo di input crea inoltre un lavoro principale senza dati. Se rileva una corrispondenza, il dispositivo di input crea un lavoro indipendente.
- Impostare la proprietà Crea lavori secondari con No se si desidera creare lavori indipendenti a prescindere da quante corrispondenze trova il dispositivo di input.
- Se l'ambiente richiede un server proxy per comunicare con i servizi Web, impostare la proprietà Usare il proxy con il server proxy corretto.
- Impostare la proprietà Offset fuso orario con l'offset in ore tra UTC (Universal Time Coordinated) e il fuso orario utilizzato
dal servizio Web.Ad esempio, se il servizio Web utilizza il fuso orario del Pacifico, impostare la proprietà con -8.
- Nota:
- Assicurarsi di modificare questa proprietà quando la posizione che ospita il servizio Web passa da standard a ora legale e viceversa. Altrimenti, durante l'ora persa o guadagnata è possibile perdere i dati che RICOH ProcessDirector utilizza per creare lavori.
- Se il servizio Web utilizza l'UTC, inserire 0 o lasciare il campo vuoto.
- 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.
- Opzionale: Sulla scheda Avanzate, specificare eventuali proprietà opzionali per l'ambiente.
- 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.
Esaminare il dispositivo di input del servizio Web REST RestfulWebServiceSample fornito.