Definición y despliegue de un plantilla dinámica para XML de salida

Si desea utilizar una plantilla que contiene un subconjunto de los elementos en la plantilla de salida estándar, cree una plantilla de salida dinámica.

Acerca de esta tarea

Si desea la posibilidad de eliminar algunos elementos de la plantilla estándar y quizás añadir sus propios elementos, hágalo pasando los datos XML o un nombre de archivo al objeto YFSEnvironment.

Para definir y desplegar una plantilla dinámica:

1. Copie la plantilla de salida estándar para la API que desea modificar desde el archivo <runtime_sandbox>/repository/xapi/template/merged/api/FileName.xml como <runtime_sandbox>/extensions/global/template/api/FileName.xml.

   Al nombrar el nuevo archivo de plantilla, utilice el mismo nombre que la plantilla estándar.

   El nombre de la plantilla de salida corresponde al nombre de la API o suceso asociado. Por ejemplo, la API getOrderDetails( ) toma el archivo de plantilla de salida getOrderDetails.xml.

2. Modifique la plantilla copiada en el directorio /extensions/global/template/api según sea necesario, teniendo en cuenta las prácticas recomendadas para crear plantillas XML de salida personalizadas.
3. Durante la extensibilidad de la interfaz de usuario, llame a la función setApiTemplate() en el objeto YFSEnvironment. Esto le permite especificar una plantilla de salida antes de llamar a una API, utilizando una de las funciones siguientes:
   • Datos XML como variable - como en el ejemplo siguiente:

     YFSEnvironment env = createEnv();
     Document doc = getTemplateDocument();
     env.setApiTemplate("getOrderDetails", doc);
     private YFSEnvironment createEnv() {
     //create new environment by passing the user id, program id, etc.
     }
     private Document getTemplateDocument() {
     //create a Document object containing the desired template XML.
     }
     

   • archivo XML como variable - como en el ejemplo siguiente:

     YFSEnvironment env = createEnv();
     env.clearApiTemplates();
     env.setApiTemplate("getOrderDetails", "myOrderDetails");
     private YFSEnvironment createEnv() {
     //create new environment by passing the user id, program id, etc.
     }

     A continuación, la API utiliza la plantilla pasada a través de YFSEnvironment para producir el documento XML de salida. Para obtener detalles sobre la interfaz YFSEnvironment, consulte el Javadoc.