Richiamo di AEM Forms utilizzando le richieste REST invoking-aem-forms-using-rest-requests

I processi creati in Workbench possono essere configurati in modo da poterli richiamare tramite le richieste di trasferimento dello stato di rappresentanza (REST). Le richieste REST vengono inviate dalle pagine di HTML. In altre parole, puoi richiamare un processo Forms direttamente da una pagina web utilizzando una richiesta REST. Ad esempio, puoi aprire una nuova istanza di una pagina web. È quindi possibile richiamare un processo Forms e caricare un documento PDF di cui è stato eseguito il rendering con i dati inviati in una richiesta HTTP POST.

Esistono due tipi di client HTML. Il primo client HTML è un client AJAX scritto in JavaScript. Il secondo client è un modulo HTML contenente un pulsante di invio. Un’applicazione client basata su HTML non è l’unico client REST possibile. Qualsiasi applicazione client che supporta le richieste HTTP può richiamare un servizio utilizzando una chiamata REST. Ad esempio, è possibile richiamare un servizio utilizzando una chiamata REST da un modulo PDF. (Vedi Richiamo del processo MyApplication/EncryptDocument da Acrobat.)

Quando utilizzi le richieste REST, ti consigliamo di non invocare direttamente i servizi Forms. Richiama invece i processi creati in Workbench. Quando crei un processo destinato alla chiamata REST, utilizza un punto iniziale programmatico. In questa situazione, l’endpoint REST viene aggiunto automaticamente. Per informazioni sulla creazione di processi in Workbench, consulta Utilizzo di Workbench.

Quando si richiama un servizio utilizzando REST, viene richiesto di specificare il nome utente e la password del modulo di AEM. Tuttavia, se non si desidera specificare un nome utente e una password, è possibile disabilitare la sicurezza del servizio.

Per richiamare un servizio Forms (un processo diventa un servizio quando il processo viene attivato) utilizzando REST, configura un endpoint REST. (Consulta "Gestione degli endpoint" in aiuto amministrativo.)

Dopo aver configurato un endpoint REST, è possibile richiamare un servizio Forms utilizzando un metodo HTTP GET o un metodo POST.

 action="https://hiro-xp:8080/rest/services/[ServiceName]/[OperationName]:[ServiceVersion]" method="post" enctype="multipart/form-data"

Obbligatorio ServiceName value è il nome del servizio Forms da richiamare. L'opzione OperationName value è il nome dell'operazione del servizio. Se questo valore non viene specificato, il nome predefinito è invoke, che è il nome dell'operazione che avvia il processo. L'opzione ServiceVersion è la versione codificata in formato X.Y. Se questo valore non viene specificato, viene utilizzata la versione più recente. La enctype può anche essere application/x-www-form-urlencoded.

Tipi di dati supportati supported-data-types

I seguenti tipi di dati sono supportati quando si richiamano i servizi AEM Forms utilizzando le richieste REST:

Chiamate asincrone asynchronous-invocations

Alcuni servizi AEM Forms, come i processi a lunga vita incentrati sull’uomo, richiedono molto tempo per essere completati. Questi servizi possono essere richiamati in modo asincrono senza blocchi. (Vedi Richiamo dei processi a lunga durata incentrati sull'uomo.)

Un servizio AEM Forms può essere richiamato in modo asincrono sostituendo services con async_invoke nell'URL di chiamata, come mostrato nell'esempio seguente.

 http://localhost:8080/rest/async_invoke/SomeService. SomeOperation?integer_input_variable=123&string_input_variable=abc

Questo URL restituisce il valore dell'identificatore (in formato "text/plain") del processo responsabile di questa chiamata.

Lo stato della chiamata asincrona può essere recuperato utilizzando un URL di chiamata con services sostituito con async_status. L’URL deve contenere un job_id parametro che specifica il valore dell'identificatore del processo associato a questa chiamata. Ad esempio:

 http://localhost:8080/rest/async_status/SomeService.SomeOperation?job_id=2345353443366564

Questo URL restituisce un valore intero (in formato "text/plain") che codifica lo stato del processo in base alle specifiche del Job Manager (ad esempio, 2 significa in esecuzione, 3 significa completato, 4 significa non riuscito e così via).

Se il processo è completato, l’URL restituisce lo stesso risultato di come se il servizio fosse stato richiamato in modo sincrono.

Una volta completato il processo e recuperato il risultato, il processo può essere eliminato utilizzando un URL di chiamata con services è sostituito con async_dispose. L’URL deve inoltre contenere un job_id parametro che specifica il valore dell'identificatore del processo. Ad esempio:

 http://localhost:8080/rest/async_dispose/SomeService.SomeOperation?job_id=2345353443366564

Se il processo viene eliminato correttamente, questo URL restituisce un messaggio vuoto.

Segnalazione errori error-reporting

Se non è possibile completare una richiesta di chiamata sincrona o asincrona a causa di un'eccezione lanciata sul server, l'eccezione viene segnalata come parte del messaggio di risposta HTTP. Se l'URL di chiamata (o async_result URL nel caso di una chiamata asincrona) non ha un suffisso .xml, il provider REST restituisce il codice HTTP 500 Internal Server Error seguita da un messaggio di eccezione.

Se l'URL di chiamata (o async_result URL nel caso di una chiamata asincrona) ha un suffisso .xml, il provider REST restituisce il codice HTTP 200 OKseguito da un documento XML che descrive l'eccezione nel seguente formato.

 <exception>
       <exception_class_name>[
       <DSCError>
          <componentUID>component_UUD</componentUID>
         <errorCode>error_code</errorCode>
         <minorCode>minor_code</minorCode>
         <message>error_message</message>
       </DSCError>
 ]
       <message>exception_message</message>
     <stackTrace>exception_stack_trace</stackTrace>
       </exception_class_name>
     <exception>
       </exception>
 </exception>

La DSCError è facoltativo e presente solo se l’eccezione è un’istanza di com.adobe.idp.dsc.DSCException.

Sicurezza e autenticazione security-and-authentication

Per fornire chiamate REST con un trasporto sicuro, un amministratore di moduli AEM può abilitare il protocollo HTTPS sul server dell’applicazione J2EE che ospita AEM Forms. Questa configurazione è specifica per il server applicativo J2EE; non fa parte della configurazione del server dei moduli.

Servizi AEM Forms che supportano la chiamata REST aem-forms-services-that-support-rest-invocation

Sebbene sia consigliato richiamare direttamente i processi creati utilizzando Workbench anziché i servizi, alcuni servizi AEM Forms supportano la chiamata REST. Il motivo per cui si consiglia di richiamare direttamente un processo anziché un servizio è perché è più efficiente richiamare un processo. Considera lo scenario seguente. Supponi di voler creare un criterio da un client REST. In altre parole, desideri che il client REST definisca valori come il nome del criterio e il periodo di lease offline.

Per creare un criterio, è necessario definire tipi di dati complessi, ad esempio PolicyEntry oggetto. A PolicyEntry l'oggetto definisce gli attributi, ad esempio le autorizzazioni associate al criterio. (Vedi Creazione di criteri.)

Invece di inviare una richiesta REST per creare un criterio (che includerebbe la definizione di tipi di dati complessi, ad esempio un PolicyEntry ), creare un processo che consenta di creare un criterio utilizzando Workbench. Definisci il processo per accettare variabili di input primitive, ad esempio un valore stringa che definisce il nome del processo o un numero intero che definisce il periodo di lease offline.

In questo modo, non è necessario creare una richiesta di chiamata REST che includa tipi di dati complessi richiesti dall’operazione. Il processo definisce i tipi di dati complessi e tutto ciò che si fa dal client REST è richiamare il processo e passare i tipi di dati primitivi. Per informazioni sull'avvio di un processo utilizzando REST, vedi Richiamo del processo MyApplication/EncryptDocument tramite REST.

Gli elenchi seguenti specificano i servizi AEM Forms che supportano la chiamata REST diretta.

Esempi di chiamata REST rest-invocation-examples

Vengono forniti i seguenti esempi di chiamata REST:

Trasferimento di valori booleani a un processo

L'esempio di HTML seguente passa due Boolean in un processo AEM Forms denominato RestTest2. Il nome del metodo di chiamata è invoke e la versione è 1.0. Si noti che viene utilizzato il metodo HTML Post.

 <html>
 <body>

 <form name="input" action="http://localhost:9080/rest/services/RestTest2/invoke/1.0" method="post">

 Boolean 1: <input type="text" name="inBooleanList" value="true">
 Boolean 2: <input type="text" name="inBooleanList" value="false">
 <input type="submit" value="Submit">

 </form>

 </body>
 </html>

Trasferimento dei valori di data a un processo

Nell’esempio di HTML seguente viene passato un valore di data a un processo AEM Forms denominato SOAPEchoService. Il nome del metodo di chiamata è echoCalendar. Tieni presente che la HTML Post viene utilizzato.

 <html>
 <body>

 <form name="input" action="http://localhost:9080/rest/services/SOAPEchoService/echoCalendar" method="post">

 Date: <input type="text" name="value-to-echo" value="2009-01-02T12:15:30Z">
 <input type="submit" value="Submit">

 </form>

 </body>
 </html>

Trasferimento di documenti a un processo

L’esempio di HTML seguente richiama un processo AEM Forms denominato MyApplication/EncryptDocument che richiede un documento PDF. Per informazioni su questo processo, consulta Richiamo di AEM Forms tramite MTOM.

 <html>
 <body>

 <form name="input" action="http://localhost:9080/rest/services/MyApplication/EncryptDocument/invoke" method="post"
          enctype="multipart/form-data">

 File: <input type="file" name="value-to-echo">
 <input type="submit" value="Submit"/>

 </form>

 </body>
 </html>

Trasferimento dei valori di documento e testo a un processo

L’esempio di HTML seguente richiama un processo AEM Forms denominato RestTest3 che richiede un documento e due valori di testo. Si noti che viene utilizzato il metodo HTML Post .

 <html>
 <body>

 <form name="input" action="http://localhost:9080/rest/services/RestTest3" method="post"
          enctype="multipart/form-data">

 Doc: <input type="file" name="inDoc">
 String 1: <input type="text" name="inListOfStrings" value="hello">
 String 2: <input type="text" name="inListOfStrings" value="privet">
 <input type="submit" value="Submit"/>

 </form>

 </body>
 </html>

Trasferimento dei valori di enumerazione a un processo

L’esempio di HTML seguente richiama un processo AEM Forms denominato SOAPEchoService che richiede un valore di enumerazione. Si noti che viene utilizzato il metodo HTML Post .

 <html>
 <body>

 <form name="input" action="https://hiro-xp:8080/rest/services/SOAPEchoService/echoEnum" method="post">

 Color Enum Value: <input type="text" name="value-to-echo" value="green">
 <input type="submit" value="Submit">

 </form>

 </body>
 </html>

Richiamo del processo MyApplication/EncryptDocument tramite REST

Puoi richiamare un processo AEM Forms di breve durata denominato MyApplication/EncryptDocument utilizzando REST.

Quando si richiama questo processo, vengono eseguite le azioni seguenti:

Richiamo del processo MyApplication/EncryptDocument da Acrobat

Puoi richiamare un processo Forms da Acrobat utilizzando una richiesta REST. Ad esempio, puoi invocare il MyApplication/EncryptDocument processo. Per richiamare un processo Forms da Acrobat, posizionare un pulsante di invio su un file XDP all’interno di Designer. (Vedi Guida di Designer.)

Specifica l’URL per richiamare il processo all’interno del pulsante Invia a URL , come illustrato nella figura seguente.

L’URL completo per richiamare il processo è https://hiro-xp:8080/rest/services/MyApplication/EncryptDocument.

Se il processo richiede un documento PDF come valore di input, assicurarsi di inviare il modulo come PDF, come illustrato nell’illustrazione precedente. Inoltre, per richiamare correttamente un processo, il processo deve restituire un documento PDF. In caso contrario, Acrobat non può gestire il valore restituito e si verifica un errore. Non è necessario specificare il nome della variabile del processo di input. Ad esempio, il processo* MyApplication/EncryptDocument* ha una variabile di input denominata inDoc. Non è necessario specificare inDoc, purché il modulo venga inviato come PDF.

È inoltre possibile inviare i dati del modulo come XML a un processo Forms. Per inviare i dati XML, assicurarsi che il Submit As L'elenco a discesa specifica XML. Poiché il valore restituito dal processo deve essere un documento PDF, il documento PDF viene visualizzato in Acrobat.