Se desejar usar um gabarito que tenha mais elementos em
adição àqueles no modelo de saída padrão, crie um modelo de saída estático. Esta função permite criar um modelo que
inclui todos os elementos no modelo de saída padrão mais
quaisquer modelos novos que você incluir.
Sobre esta tarefa
Por exemplo, pode ser necessário incluir campos de UI para
quaisquer colunas de banco de dados que você incluiu. Observe que, se você usar esta função,
não poderá remover nenhum elemento que exista no modelo padrão.
Para
definir e implementar um modelo estático:
Procedimento
- Copie o modelo de saída padrão para a API que você deseja modificar do arquivo <runtime_sandbox>/repository/xapi/template/merged/api/FileName.xml como <runtime_sandbox>/extensions/global/template/FileName[.DocType].xml.
- Mantenha o nome do arquivo de seu novo modelo igual ao modelo
padrão.
O nome do modelo de saída corresponde ao nome da
API ou do evento associado a ela. Por exemplo, a API
getOrderDetails() usa o arquivo de modelo de saída
getOrderDetails.xml.
- Se o modelo referencia um tipo de documento, inclua o código
do tipo de documento no nome do arquivo.
Por exemplo, para criar um modelo de saída
para a API getOrderDetails() para um tipo de documento de Pedido (0001), o
nome do XML de modelo será getOrderDetails.0001.xml.
- Modifique o modelo copiado no diretório /extensions/global/template/api/ conforme necessário, tendo em mente as melhores práticas para criar modelos XML de saída customizados.
Nota: Você pode incluir quaisquer elementos desejados, mas não pode remover nenhum dos elementos presentes no modelo de saída padrão.
- Chame a API como típica e ela selecionará automaticamente o
modelo de saída customizado no diretório que contém os modelos customizados.