Chiamata di un servizio Web REST da un flusso di lavoro
- 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.
- Se il servizio Web include un payload, decidere in che modalità fornire le informazioni:
- È possibile inserire il payload come valore della proprietà Payload richiesta.
- È possibile archiviare il payload in un file di testo a cui l'operazione CallRESTService può accedere durante l'elaborazione del lavoro.
- Fare clic sulla scheda Flusso di lavoro .
- Fare clic sul nome del flusso di lavoro che si desidera modificare.
- Opzionale: Disabilitare il flusso di lavoro facendo clic sull'interruttore alla sinistra del
nome del flusso di lavoro. Se non si disabilita il flusso di lavoro. Durante la modifica, i lavori che utilizzano questo flusso di lavoro continuano a spostarsi attraverso le operazioni. Quando si salva, il flusso di lavoro viene momentaneamente disabilitato e quindi riabilitato. I lavori attualmente elaborati nel flusso di lavoro potrebbero andare in errore.
- Controllare i passaggi inclusi nel flusso di lavoro e i valori predefiniti impostati.
- Aggiungere al flusso di lavoro un'operazione basata sul modello di operazione ChiamataServizioREST, nell'opportuna posizione.
- Configurare i valori delle proprietà di lavoro.
- Configurare la proprietà URL richiesta con l'URL del servizio Web chiamato dalla procedura.L'URL può utilizzare il protocollo HTTP o il protocollo HTTPS.
- Impostare la proprietà Metodo richiesta con il valore richiesto dal servizio Web.
- Impostare la proprietà Password con la password che l'operazione fornisce al servizio Web REST per autenticarsi con
l'applicazione.Inserire la password come valore per questa proprietà. Per fornire la password al servizio Web REST, specificare la proprietà Lavoro.WebService.Password come simbolo nelle proprietà Payload richiesta, Intestazione richiesta o Parametri richiesta: ${Job.WebService.Password}. Per determinare quale proprietà utilizzare, fare riferimento alla documentazione del servizio Web.
- Impostare la proprietà Tipo di payload richiesta:
- Per specificare il corpo della richiesta dei servizi Web come valore della proprietà Payload richiesta, seleziona TESTO.
- Per specificare il corpo della richiesta dei servizi Web in un file di testo a cui l'operazione CallRESTService può accedere durante l'elaborazione del lavoro, selezionare FILE.
- Nota:
- Se non si specifica un payload, RICOH ProcessDirector ignora il valore di questa proprietà.
- Se il servizio Web include un payload, impostare la proprietà Payload richiesta:
- Se si imposta la proprietà Tipo di payload richiesta su TESTO, inserire il payload come valore di questa proprietà.
- Se si imposta la proprietà Tipo di payload richiesta su FILE, inserire il percorso completo della directory, il nome e l'estensione del file di
testo come valore di questa proprietà.
Inserire il payload come contenuto del file di testo.
Per inviare la password nel payload, specificare la proprietà Lavoro.WebService.Password come simbolo.
In questo esempio XML, l'ID ordine viene archiviato come valore della proprietà del lavoro Personalizzazione 3 ( Lavoro.Info.Attr3). Il payload include la password come valore dell'elemento <Token> e l'ID ordine come valore dell'elemento <OrderID>:
<Token>${Job.WebService.Password}</Token><OrderID>${Job.Info.Attr3}</OrderID>
L'operazione risolve i simboli quando chiama il servizio Web REST.
- 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 due parametri: token e orderId. Il valore di ciascuna parola chiave è un simbolo RICOH ProcessDirector. Ciascun simbolo contiene una di queste proprietà: Lavoro.WebService.Password e Lavoro.Info.Attr3.
token:${Job.WebService.Password}orderId:${Job.Info.Attr3}
L'operazione risolve i simboli quando chiama il servizio Web REST.
- 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à File risposta con il percorso completo della directory e il nome del file che RICOH ProcessDirector utilizza per archiviare la risposta dall'applicazione.Solitamente, questo valore è ${getFileName(print,json,write)} o ${getFileName(print,xml,write)}, in base al tipo di risposta fornita dall'applicazione.Una volta archiviata la risposta nel file, altre operazioni nel flusso di lavoro possono elaborare la risposta.
- Configurare la proprietà URL richiesta con l'URL del servizio Web chiamato dalla procedura.
- Al termine, fare clic su OK.
- Salvare e abilitare il flusso di lavoro.
Una volta terminata l'impostazione dei flussi di lavoro, testare lo scambio di dati tra RICOH ProcessDirector e l'applicazione.
Esempio
La funzione Attivazione servizi Web include un flusso di lavoro RestfulWebServiceWF con un'operazione CallRESTService.