Preparación para recuperar entradas de 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 cómo desea que el dispositivo de entrada del servicio web REST cree trabajos
a partir de los datos de la respuesta que ha devuelto el servicio web.
- Cada vez que el dispositivo de entrada recibe una respuesta, se puede crear un trabajo que contenga todos los datos XML o JSON en la respuesta.
- El dispositivo de entrada puede examinar la respuesta utilizando una expresión JSONPath
o XPath.
Si el dispositivo de entrada encuentra elementos XML u objetos JSON especificados por la expresión, este crea un trabajo para cada elemento u objeto coincidente. Cada trabajo contiene el elemento o el objeto coincidente, y todos los elementos u objetos anidados en este. Si el dispositivo de entrada encuentra dos o más elementos u objetos, se pueden crear trabajos independientes o trabajos hijo.
Si el dispositivo de entrada no encuentra elementos coincidentes, no crea ningún trabajo.
- Pulse AñadirServicio web REST.
- Pulse la pestaña Administración.
- En el panel de la izquierda, pulse .
- Pulse .
Como alternativa, puede copiar el dispositivo de entrada del servicio web REST RestfulWebServiceSample proporcionado. - En la pestaña General:
- Escriba un nombre para el dispositivo de entrada.
- Establezca la propiedad Intervalo de sondeo con el tiempo que desea que el dispositivo de entrada espere entre llamadas de servicio web.
- Después de definir un flujo de trabajo para procesar los trabajos XML o JSON, establezca la propiedad Flujo de trabajo hijo con el nombre de ese flujo de trabajo.
- Escriba valores para las otras propiedades que desee establecer.
- En la pestaña Solicitud:
- Establezca la propiedad URL de la solicitud en la URL del servicio web que devuelve datos que RICOH ProcessDirector utiliza para crear uno o más trabajos.
- Establezca las propiedades Método de la solicitud y Tipo de contenido de la solicitud en los valores requeridos 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.Para especificar una credencial o una señal y un intervalo de tiempo que coincida con el valor de la propiedad Intervalo de sondeo, utilice símbolos para estas propiedades:
Nombre de la base de datos de la propiedad Nombre de la interfaz de usuario de la propiedad Observaciones WebService.Credential Ninguno RICOH ProcessDirector almacena la credencial o la señal del servicio web en esta propiedad. WebService.CurrentRequestTime Ninguno RICOH ProcessDirector establece el valor de esta propiedad en el inicio del intervalo de sondeo. WebService.LastSuccessRequestTime Pestaña Estado: Hora de última solicitud satisfactoria Cuando el dispositivo de entrada se comunica correctamente con la aplicación, RICOH ProcessDirector establece el valor de esta propiedad para que coincida con el valor de la propiedad WebService.CurrentRequestTime. Una comunicación correcta tiene como resultado un código de respuesta 200, incluso si no se reciben datos que RICOH ProcessDirector puede utilizar para crear trabajos. - Nota:
- Estas tres propiedades de trabajo se utilizan como valores XML de ejemplo para la propiedad Carga de solicitud y como valores JSON de ejemplo para la propiedad Parámetros de la solicitud. Los requisitos del servicio web determinan las propiedades que utilizará para someter estos y otros valores.
En este ejemplo XML, la carga incluye estos elementos: <Token>, <TimeRange>, <Start> y <End>. Los valores de tres elementos son símbolos:
<Token>${WebService.Credential}</Token> <TimeRange> <Start>${WebService.LastSuccessRequestTime}</Start> <End>${WebService.CurrentRequestTime}</End> </TimeRange>
El dispositivo de entrada resuelve los símbolos cuando sondea la entrada.
- 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, start y end. El valor de cada palabra clave es un símbolo RICOH ProcessDirector. Cada símbolo contiene una de estas propiedades: WebService.Credential, WebService.LastSuccessRequestTime y WebService.CurrentRequestTime.
token:${WebService.Credential} start:${WebService.LastSuccessRequestTime} end:${WebService.CurrentRequestTime}
El dispositivo de entrada resuelve los símbolos cuando sondea la entrada.
- Seleccione un valor para la propiedad Crear trabajo a partir de la respuesta para especificar cómo el dispositivo de entrada crea trabajos a partir de la entrada:
- Para crear un trabajo cada vez que el dispositivo de entrada recibe una respuesta, seleccione Siempre.
- Para examinar XML o JSON en la respuesta y crear un trabajo cada vez que se encuentra un elemento XML o un objeto JSON, seleccione Sólo cuando coincide el patrón de respuesta.
- Si ha seleccionado Sólo cuando coincide el patrón de respuesta:
- Establezca la propiedad Patrón de respuesta para la coincidencia en la expresión XPath que identifica el elemento XML o en la expresión JSONPath que identifica el objeto JSON.
- Establezca la propiedad Crear trabajos hijos en Sí si desea crear trabajos hijos cuando el dispositivo de entrada encuentra dos o más coincidencias. El dispositivo de entrada también crea un trabajo padre sin ningún dato. Si el dispositivo de entrada encuentra una coincidencia, se crea un trabajo independiente.
- Establezca la propiedad Crear trabajos hijos en No si desea crear trabajos independientes, sin tener en cuenta el número de coincidencias que encuentre el dispositivo de entrada.
- 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 Desplazamiento del huso horario en la diferencia en horas entre la Hora universal coordinada (UTC) y el huso horario
que utiliza el servicio web.Por ejemplo, si el servicio web utiliza la hora estándar del Pacífico, establezca la propiedad en -8.
- Nota:
- Asegúrese de que cambia esta propiedad cuando una ubicación que aloja el servicio web cambia entre horario estándar y horario de verano. De lo contrario, durante la hora perdida o ganada, puede perder los datos que RICOH ProcessDirector utiliza para crear trabajos.
- Si el servicio web utiliza UTC, introduzca 0 o deje el campo en blanco.
- 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.
- Opcional: En la pestaña Avanzado, especifique las propiedades opcionales para su entorno.
- 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 el dispositivo de entrada del servicio web REST RestfulWebServiceSample proporcionado.