Utilizzo di Servizi Web
Preparazione di RICOH ProcessDirector per ricevere le richieste di servizio Web
Prima di poter inviare le richieste di servizi Web, è necessario creare un utente e una password RICOH ProcessDirector per i servizi Web da utilizzare. Assicurarsi che l'ID utente disponga del livello appropriato di autorità in RICOH ProcessDirector per eseguire le azioni fornite nel servizio Web. Per gli esempi riportati in questo capitolo, è sufficiente l'autorità Operatore. Se si utilizza il Lightweight Directory Access Protocol (LDAP) per l'autenticazione, creare un utente in LDAP per i servizi Web da utilizzare. L'utente LDAP deve appartenere a un gruppo con il livello di autorità appropriato in RICOH ProcessDirector.
Dato che tutti gli utenti devono cambiare le loro password dopo il primo accesso, accedere all'interfaccia utente RICOH ProcessDirector utilizzando l'ID utente creato e modificare la password. Se le password sono impostate per scadere dopo un determinato periodo di tempo, è necessario accedere e cambiare la password, se necessario.
Preparazione delle richieste di servizi Web
Quando si creano richieste, tenere a mente questi punti:
- L'utente dei servizi Web deve accedere prima di effettuare qualsiasi azione.
Per inviare le richieste di servizi Web, è necessario innanzitutto utilizzare il servizio Web GET /users/login per accedere a RICOH ProcessDirector come utente del servizio Web e ricevere un token di credenziali. Questo token deve essere incluso nell'intestazione di tutte le richieste di servizi Web inviate fino all'invio del servizio Web POST /users/logout/{name}.
- I nomi della proprietà devono essere espressi nel formato di database, non nel formato
dell'interfaccia utente.
Quando si include un nome della proprietà in una richiesta, è necessario utilizzare il nome della proprietà del database. Ad esempio, se si desidera utilizzare GET /objects/{objectType} per recuperare il valore Class di un lavoro, inserire nella richiesta Job.Class come valore attribute. I nomi delle proprietà del database sono disponibili nella guida campo per ogni proprietà, nella guida del prodotto, nei risultati ricevuti da alcuni servizi Web e in Nomi proprietà database.
- I valori della proprietà devono essere espressi nel formato di database, non nel formato
dell'interfaccia utente.
Quando si include un valore in una query, è necessario assicurarsi che si tratti di un valore valido. Di solito, i campi numerici richiedono valori numerici e i campi di testo richiedono valori di testo. Tuttavia, alcune proprietà hanno elenchi limitati di valori.
Qualsiasi proprietà che fornisca un elenco a discesa può accettare solo determinati valori. Inoltre, i valori che appaiono in tali elenchi non sono sempre gli stessi valori memorizzati nel database. Ad esempio, nell'interfaccia utente, i valori per la proprietà Staple includono:
- 2 a sinistra
- 2 a destra
- In alto a sinistra
- Verticale in alto a sinistra
- In basso a sinistra
- 2_at_left
- 2_at_right
- Top_left
- Top_left_vertical
- Bottom_left
Nelle richieste di servizi Web, è necessario utilizzare il valore del database. I valori del database per le proprietà sono disponibili nel sistema di supporto del prodotto e in Nomi proprietà database.
-
Le proprietà del lavoro devono includere i nomi della fase, dell'operazione e del flusso di lavoro in tale ordine e seguire il nome della proprietà. Racchiudere tutti e tre i nomi tra parentesi.
Questa stringa JSON di esempio specifica un file di controllo in un sistema Linux come valore della proprietà del lavoro Identifica file di controllo PDF (nome del database Job.IdentifyPDFControlFile):
"Job.IdentifyPDFControlFile[Prepare][IdentifyPDFDocuments][PullPDFSample]":"/aiw/aiw1/testfiles/PullPDF.ctl"
La proprietà del lavoro si trova nell'operazione IdentifyPDFDocuments nella fase Prepara del flusso di lavoro PullPDFSample.