API de Consolas de aplicación

El recuadro de diálogo Detalles de recursos de la API de Consolas de aplicación le permite especificar si se debe o no llamara una API y cómo se debe llamar a la API.

Los permisos no pueden mantenerse para los recursos de la API. Un recurso API puede llamar a una API estándar de Sterling™ Order Management System o invocar un servicio que se haya configurado.

Nota: Aunque puede crear cualquier número de recursos de API bajo una entidad, debe crear sólo una lista y una API de detalle.

Tabla 1. Recuadro de diálogo de recurso de API.
Descripciones de valores de campos de recursos de API
controlar	Descripción
Llamar a servicio	Especifica que se invoca un servicio en la interfaz de usuario para este recurso.
Nombre de servicio	Sólo se aplica a servicios. Se habilita a través del botón de selección Llamar a servicio. Proporciona una lista desplegable de servicios disponibles que se han configurado anteriormente en Servicios del Gestor de aplicaciones.
Plantillas	Sólo se aplica a servicios. Se habilita a través del botón de selección Llamar a servicio. Proporciona una forma de añadir, modificar y suprimir una lista de plantillas. Puede especificar un nombre de API y una plantilla para cada fila de la tabla. De este modo puede especificar plantillas de todas las API a las que se llama dentro del servicio. Importante: tenga en cuenta que un servicio no debe ejecutar la misma API dos veces porque no puede configurar varios elementos de plantilla para la misma API.
Llamar a API	Especifica que se invoca una API estándar de Sterling Order Management System en la interfaz de usuario para este recurso. Cuando se selecciona, habilita la lista desplegable Nombre de API y la Plantilla de API.
Nombre de API	Solamente se aplica a las API. Se habilita mediante el botón de selección Llamar a API. Proporciona una lista desplegable de las API estándar o ampliadas disponibles mediante la infraestructura de definición de servicios. Si la API que selecciona es compatible con versiones anteriores, el recuadro de selección Requiere compatibilidad con versiones anteriores está habilitado.
Requiere compatibilidad con versiones anteriores	Solamente se aplica a las API que pueden llamarse en modalidad de compatibilidad con versiones anteriores. Le permite especificar si la API debe ejecutarse en modalidad de compatibilidad con versiones anteriores. Cuando se selecciona, también debe proporcionarse la versión.
Versión	Solamente se aplica a las API que se ejecutan en modalidad de compatibilidad con versiones anteriores. Proporciona una lista desplegable de las versiones para las que una API es compatible con versiones anteriores.
Espacio de nombres de entrada	Espacio de nombres que corresponde al recuadro de texto que pasa entrada a Guardar API. Solamente se aplica a una vista de detalles, ya que pueden tener varios recuadros de texto que están enlazados a distintos espacios de nombres XML. Sin embargo, sólo uno de los recuadros de texto puede pasar entrada a la API.
Espacio de nombres de salida	La salida de la API se guarda en este espacio de nombres. El espacio de nombres es opcional, pero si no se ha especificado, toma el valor predeterminado del nombre de nodo raíz del XML bajo consideración. Por lo tanto, al referirse a la salida de la API, aunque no se haya especificado aquí el espacio de nombres, se presupone que es igual que el nombre de nodo raíz de la salida. Un espacio de nombres es una código que se puede utilizar para identificar un XML específico. Presentation Framework le permite llamar a varias API y almacenar las salidas en distintos espacios de nombres. En el JSP o en la entrada a una API, puede hacer referencia a valores desde cualquier espacio de nombres que esté disponible en este punto.
Ignorar excepción	Si esta API genera una excepción que no se visualiza al usuario. Esta opción no está disponible para recursos de API que se crean directamente bajo un recurso de entidad.
Omitir ejecución automática	Cuando esta opción está seleccionada, la API no se invoca automáticamente cuando se visualiza la vista. Entonces podrá llamar a esta API dentro de la JSP utilizando el taglib `callAPI`. Esta opción no está disponible para los recursos de API que se crean directamente bajo un recurso de entidad.
Llamada en modo de sólo retrotracción	Marque este recuadro cuando desee llamar a esta API en modalidad de sólo retrotracción para retrotraer los cambios realizados en la base de datos. De forma predeterminada, este recuadro de selección está inhabilitado para todas las API de Sterling Order Management System . Nota: Sin embargo, para ejecutar esta operación de sólo retrotracción, es necesario crear una acción personalizada. Para obtener información sobre la creación de acciones personalizadas en una pantalla, consulte IBM Sterling Order Management: Personalización de la interfaz JSP de la consola para el usuario final .
Tipo de API	Especifique el tipo de vista desde la que se puede invocar la API. Esta opción solo está disponible para recursos de API que se crean directamente bajo un recurso de entidad. Estos tipos de recursos son: Lista: invoca la API desde una vista de lista Detalle: invoca la API desde una vista de detalle
Entrada	Proporciona una estructura XML que puede utilizarse para pasar entrada específica a la API. Aquí puede especificar atributos dinámicos.
Plantilla	Proporcione aquí un XML de plantilla. Este XML de plantilla se pasa a la API mediante la clase `YFSEnvironment`. Aunque la clase `YFSEnvironment` da soporte a pasar un XML completo o simplemente un nombre de archivo XML, solamente puede proporcionar un XML completo en este campo.