Configuración de servicios para API personalizadas y descolgadas

Las API generadas para entidades personalizadas o descolgadas por la aplicación pueden invocarse como un servicio y mediante un componente derivador multiAPI.

Para obtener más información sobre cómo invocar las API a través de un componente multiAPI , consulte el Javadoc. La interfaz de usuario de configuración de servicio debe estar habilitada para configurar estas API.

Interfaz de configuración de servicio para propiedades de API.

Para incluir API personalizadas, puede crear una definición de servicio como se muestra en la figura. Los campos de configuración se explican en la tabla siguiente.

Nombre de campo	Descripción
Ficha General
API estándar	Seleccione esta opción si se va a invocar una API estándar de la aplicación. Si se selecciona, aparece la lista desplegable Nombre de API estándar. Para cada API, se proporciona el Nombre de clase y el Nombre de método y no se pueden editar.
API ampliada	Seleccione esta opción si se va a invocar un código Java™ personalizado.
API de base de datos ampliada	Seleccione esta opción si el servicio invoca una API personalizada o descolgada. Si se selecciona, aparece la lista desplegable Nombre de API personalizada. Para cada API, se proporciona el Nombre de clase y el Nombre de método y no se pueden editar. Nota: Si desea bloquear un registro en una tabla personalizada, pase el atributo SelectMethod como parte del XML de entrada a la API de entidad personalizada. El bloqueo se produce dentro del límite de transacción de la llamada de API personalizada. El atributo SelectMethod puede tener los siguientes valores: ESPERAR NO_WAIT Ninguna Nota: El atributo SelectMethod sólo está soportado para getAPI. Asegúrese de verificar el xml de entrada de getAPI si el atributo SelectMethod está expuesto.
Nombre de API	Seleccione o especifique la API que se va a llamar.
Nombre de clase	Especifica la clase que se va a llamar.
Nombre de método	Especifica el método que se va a llamar.
Requiere compatibilidad con versiones anteriores	Seleccione este campo para indicar que los datos de entrada que llegan a través de la API son de una versión anterior (sólo es aplicable a las API del sistema).
Versión	Si escoge Requiere compatibilidad con versiones anteriores, seleccione la versión de la aplicación según la cual se ha de comportar la API. Sólo aparecen las versiones válidas para cada API concreta.
Ficha Argumentos
Nombre de argumento	Puede pasar pares de nombre/valor a la API especificando los valores en la ficha Argumentos. Para que las API personalizadas puedan acceder a valores personalizados, la API debe implementar la interfaz com.yantra.interop.japi.YIFCustomApi. Si se indica, estos pares de nombre/valor se le pasan a CustomApi como un objeto de propiedades.
Valor de argumento	Especifique el valor del valor de argumento.
Ficha Plantilla
	Cuando se invocan las API del sistema, puede especificar una plantilla de salida para que la utilice la API. Puede especificar la plantilla en las propiedades de configuración de la definición de servicio, de la definición de recurso en el árbol de la jerarquía de recursos, o de ambas. Sin embargo, si la plantilla se ha especificado en ambos niveles de definición, se utilizará la plantilla especificada en la definición de servicio.
Plantilla XML	Seleccione este botón para construir el XML que se utilizará para la salida de la API. Especifique el nombre de elemento raíz de plantilla y pulse Aceptar. A continuación, podrá construir el XML.
Nombre de archivo	Seleccione este botón para especificar el nombre del archivo XML que se utilizará como plantilla de salida de la API. Este archivo también debe existir en la CLASSPATH.
Ficha Hechos
	Un hecho es un atributo que utiliza una API o un agente para identificar con qué colonia conectarse para recuperar datos. En función del nombre y el valor de hecho especificados, se determina la colonia correspondiente.
Nombre de hecho	Escriba el nombre de hecho del atributo XML.
Valor de hecho	Escriba el valor de hecho del atributo XML.