Preparación para enviar el estado a servicios web REST
- 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.
- Decida en el caso en que desea que se desencadenen la notificación y las condiciones
que determinan cuándo llama la notificación al servicio web.Si desea enviar una notificación para un evento que sólo se produce cuando un flujo de trabajo específico procesa un trabajo, especifique ese flujo de trabajo como una condición.
- Defina una notificación del servicio web REST:
- Pulse la pestaña Administración.
- En el panel de la izquierda, pulse .
- Pulse .
Como alternativa, puede copiar la notificación del servicio web REST RestfulWebServiceSampleNotify proporcionada. - En la pestaña General, escriba un nombre para la notificación.
- En la pestaña Solicitud:
- Establezca la propiedad URL de la solicitud en la URL del servicio web al que desea enviar la notificación.
- Establezca la propiedad Método de la solicitud en el valor requerido por el servicio web.
- Para el valor de la propiedad Carga de solicitud, especifique el cuerpo de la solicitud de servicios web que el dispositivo de entrada
somete a la aplicación.En este ejemplo XML, la carga incluye dos elementos XML: <Token> y <OrderNumber>.
<Token>${WSNotification.WebService.Credential}</Token> <OrderNumber>${Job.Info.Attr1}</OrderNumber>
El valor de cada elemento es un símbolo RICOH ProcessDirector que contiene una propiedad. Si está utilizando un servicio web para autenticarlo en la aplicación, incluya la propiedad WSNotification.WebService.Credential en un símbolo. Sustituya el otro elemento y la propiedad con los elementos y las propiedades que desea enviar a la aplicación. La notificación resuelve los símbolos cuando envía el estado 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 tres parámetros: token, orderNumber y customerName. El valor de cada palabra clave es un símbolo RICOH ProcessDirector. Cada símbolo contiene una de estas propiedades: WSNotification.WebService.Credential, Job.Info.Attr1 y Job.CustomerName.
token:${WSNotification.WebService.Credential} orderNumber:${Job.Info.Attr1} customerName:${Job.CustomerName}
El dispositivo de entrada resuelve los símbolos cuando envía el estado 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.
- En la pestaña Autenticación, especifique los valores necesarios para autenticarse con la aplicación.Para obtener más información, consulte la tarea relacionada acerca de la autenticación con un servicio web REST.
Si la aplicación no requiere autenticación, deje todas las propiedades de autenticación en blanco.
- En la pestaña Evento:
- Seleccione el tipo de objeto que desee supervisar.
- Seleccione la propiedad, la acción y el valor que desee supervisar.
- Para definir otro evento, pulse el signo + situado a la derecha de cualquier evento.
- Para eliminar un evento, haga clic en el signo - situado a la derecha del evento que desea eliminar.
Por ejemplo, para enviar una notificación cuando el estado de un trabajo cambia a Retenido, seleccione Estado de trabajo actual, Cambia a y Retenido. - En la pestaña Condiciones:
- Seleccione la propiedad y el valor que deben cumplirse para que se envíen las notificaciones.
- Para definir otra condición, pulse el signo + situado a la derecha de cualquier evento.Para especificar cómo se combinarán las condiciones, seleccione Cualquiera, Todo o Personalizado.
- Para eliminar una condición, pulse en el signo - situado a la derecha de la condición que desea eliminar.
Por ejemplo, para enviar una notificación sólo cuando un trabajo hijo se encuentra en el flujo de trabajo ProcessWebOrders, especifique dos condiciones:- Workflow = ProcessWebOrders
- Job number like*.*
Para aplicar las condiciones sólo cuando un trabajo cumple las dos, seleccione Todo.
- Cuando haya terminado, pulse Aceptar.
Cuando haya terminado de configurar los dispositivos de entrada, las notificaciones y los flujos de trabajo, pruebe el intercambio de datos entre RICOH ProcessDirector y la aplicación.
Examine la notificación del servicio web REST RestfulWebServiceSampleNotify proporcionada.