Si desea utilizar una plantilla que tiene más elementos, además de los de la plantilla de salida estándar, cree una plantilla de salida estática. Esta función le permite crear una plantilla que incluye todos los elementos en la plantilla de salida estándar más los nuevos que añada.
Acerca de esta tarea
Por ejemplo, puede que tenga que añadir campos UI para cualquier columna de base de datos que haya añadido. Observe que si utiliza esta función, no puede eliminar ningún elemento que exista en la plantilla estándar.
Para definir y desplegar una plantilla estática:
Procedimiento
- 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/FileName[.DocType].xml.
- Mantenga el nombre de archivo de la nueva plantilla igual que en 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.
- Si la plantilla hace referencia a un tipo de documento, incluya el código de tipo de documento en el nombre de archivo.
Por ejemplo, para crear una plantilla de salida para la API
getOrderDetails() para un tipo de documento Order (0001), el nombre del XML de plantilla es
getOrderDetails.0001.xml.
- 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.
Nota: Puede añadir los elementos que desee, pero no puede eliminar ninguno de los elementos presentes en la plantilla de salida estándar.
- Llame a la API de la forma habitual y recoge automáticamente la plantilla de salida personalizada del directorio que contiene las plantillas personalizadas.