Llamada a un servicio web REST desde un flujo de trabajo
- Conozca los requisitos para comunicarse con el servicio web REST para la aplicación:
- Los valores para autenticarse con la aplicación
- Los valores para solicitar datos del servicio web REST
- El formato de los datos proporcionados en la respuesta
Consulte la documentación de la aplicación o consulte a la empresa que aloja la aplicación.
- Para preparar RICOH ProcessDirector para que se comunique con la aplicación, realice las tareas siguientes:
- Si la aplicación requiere un certificado de seguridad, instale el certificado en el equipo primario de RICOH ProcessDirector.
- Si su entorno requiere un servidor proxy para comunicarse con servicios web, configure el sistema para utilizarlo.
Para obtener más información, consulte las tareas relacionadas.
- Ejecute una prueba manual que se autentique en la aplicación y solicite una respuesta
del servicio web REST. Compruebe que el servicio web devuelve la respuesta que desea.Muchos navegadores cuentan con plug-ins, como Boomerang de Google Chrome, que realizan pruebas con llamadas de servicio web a clientes REST.
- Si el servicio web incluye una carga, decida cómo desea proporcionar esa información:
- Puede introducir la carga como el valor de la propiedad Carga de solicitud.
- Puede almacenar la carga en un archivo de texto al que el paso CallRESTService pueda acceder durante el procesamiento del trabajo.
- Pulse la pestaña Flujo de trabajo.
- Pulse el nombre del flujo de trabajo que desea modificar.
- Opcional: Inhabilite el flujo de trabajo pulsando el conmutador que hay a la izquierda del nombre
de flujo de trabajo. Si no inhabilita el flujo de trabajo mientras lo edita, los trabajosa que utilicen este flujo de trabajo seguirán avanzando por los pasos. Al guardar, el flujo de trabajo se inhabilita temporalmente y se vuelve a habilitar. Los trabajos que se están procesando en el flujo de trabajo pueden experimentar un error.
- Revise los pasos incluidos en el flujo de trabajo, junto con los valores por omisión que establecen estos pasos.
- Añada un paso basado en la plantilla de pasos CallRESTService al flujo de trabajo en el lugar adecuado.
- Establezca valores para las propiedades de trabajo.
- Establezca la propiedad URL de la solicitud en la URL del servicio web al que el paso llama.La URL puede utilizar el protocolo HTTP o HTTPS.
- Establezca la propiedad Método de la solicitud en el valor requerido por el servicio web.
- Establezca la propiedad Contraseña en la contraseña que el paso proporciona al servicio web REST para autenticarse con
la aplicación.Introduce la contraseña como el valor de esta propiedad. Para proporcionar la contraseña al servicio web REST, especifique la propiedad Job.WebService.Password como un símbolo en la propiedad Carga de solicitud, Cabecera de la solicitud o Parámetros de la solicitud: ${Job.WebService.Password}. Para determinar la propiedad que desea utilizar, consulte la documentación del servicio web.
- Establezca la propiedad Tipo de carga de solicitud:
- Para especificar el cuerpo de la solicitud de servicios web como el valor de la propiedad Carga de solicitud, seleccione TEXTO.
- Para especificar el cuerpo de la solicitud de servicios web en un archivo de texto al que el paso CallRESTService pueda acceder durante el procesamiento del trabajo, seleccione ARCHIVO.
- Nota:
- Si no especifica una carga, RICOH ProcessDirector ignora el valor de esta propiedad.
- Si el servicio web incluye una carga, establezca la propiedad Carga de solicitud:
- Si establece la propiedad Tipo de carga de solicitud en TEXTO, introduzca la carga como el valor de esta propiedad.
- Si establece la propiedad Tipo de carga de solicitud en ARCHIVO, introduzca la ruta completa al directorio, el nombre y la extensión del archivo
de texto como el valor de esta propiedad.
Introduzca la carga como el contenido del archivo de texto.
Para enviar la contraseña en la carga, especifique la propiedad Job.WebService.Password como un símbolo.
En este ejemplo XML, el ID del pedido se almacena como el valor de la propiedad de trabajo Personalizado 3 ( Job.Info.Attr3). La carga incluye la contraseña como el valor del elemento <Token> y el ID del pedido como el valor del elemento <OrderID>:
<Token>${Job.WebService.Password}</Token><OrderID>${Job.Info.Attr3}</OrderID>
El paso resuelve los símbolos cuando llama al servicio web REST.
- Establezca los valores para las propiedades Cabecera de la solicitud y Parámetros de solicitud, según sea necesario.
Cada campo o parámetro de cabecera es un par palabra clave/valor. Cada par debe aparecer en una línea independiente y debe separarse utilizando dos puntos (:) o un signo igual (=).
La palabra clave y el valor pueden ser varias palabras. RICOH ProcessDirector utiliza el primer signo de dos puntos o de igual de cada línea para dividir las palabras en el par palabra clave/valor.
Este ejemplo contiene dos parámetros: token y orderId. El valor de cada palabra clave es un símbolo RICOH ProcessDirector. Cada símbolo contiene una de estas propiedades: Job.WebService.Password y Job.Info.Attr3.
token:${Job.WebService.Password}orderId:${Job.Info.Attr3}
El paso resuelve los símbolos cuando llama al servicio web REST.
- Si su entorno requiere un servidor proxy para comunicarse con servicios web, establezca la propiedad Utilizar proxy en el servidor proxy adecuado.
- Establezca la propiedad Archivo de respuesta en la ruta completa al directorio y el nombre de archivo que RICOH ProcessDirector utiliza para almacenar la respuesta de la aplicación.Normalmente este valor es ${getFileName(print,json,write)} o ${getFileName(print,xml,write)}, en función del tipo de respuesta que la aplicación devuelva.Una vez almacenada la respuesta en el archivo, el resto de pasos del flujo de trabajo puede procesar la respuesta.
- Establezca la propiedad URL de la solicitud en la URL del servicio web al que el paso llama.
- Cuando haya terminado, pulse Aceptar.
- Guarde y habilite el flujo de trabajo.
Cuando haya terminado de configurar los flujos de trabajo, pruebe el intercambio de datos entre RICOH ProcessDirector y la aplicación.
Ejemplo
La característica Web Services Enablement incluye un flujo de trabajo RestfulWebServiceWF suministrado con un paso CallRESTService.