Configurando serviços para APIs hang-off e customizadas

As APIs geradas para entidades customizadas e hang-off pelo aplicativo podem ser chamadas como um serviço e por meio de um componente wrapper multiAPI.

Para obter mais informações sobre como chamar as APIs por meio de um componente multiAPI , consulte o Javadoc A interface com o usuário de configuração de serviço deve estar ativada para configurar essas APIs

Interface de Configuração de Serviço para as propriedades da API

Para incluir APIs customizadas, é possível criar uma definição de serviço como a mostrada na figura. Os campos de configuração são explicados na tabela a seguir.

Nome do Campo	Descrição
Guia geral
API Padrão	Selecione essa opção se uma API de aplicativo padrão será chamada. Se selecionada, a lista suspensa Nome da API padrão é exibida. Para cada API, o Nome de Classe e o Nome do Método são fornecidos e não podem ser editados.
API Estendida	Selecione esta opção se um código Java™ customizado deve ser chamado.
API de Banco de Dados Estendido	Selecione esse opção se o serviço chamar uma API customizada ou hang-off. Se selecionada, uma lista suspensa Nome da API customizada é exibida. Para cada API, o Nome de Classe e o Nome do Método são fornecidos e não podem ser editados. Nota: se desejar bloquear um registro em uma tabela customizada, passe o atributo SelectMethod como parte do XML de entrada para a API da entidade customizada. O bloqueio acontece dentro do limite de transação da chamada de API customizada. O atributo SelectMethod pode assumir os seguintes valores: AGUARDAR NO_WAIT NENHUM Nota: o atributo SelectMethod é suportado apenas para getAPI. Assegure-se de verificar a entrada xml de getAPI se o atributo SelectMethod estiver exposto.
Nome da API	Selecione ou insira a API a ser chamada.
Nome de Classe	Especifica a classe a ser chamada.
Nome do Método	Especifica o método a ser chamado.
Requer Compatibilidade com Versões Anteriores	Selecione esse campo para indicar que os dados de entrada que chegam por meio da API são de uma versão anterior (somente aplicável a APIs do sistema).
Version	Se você escolher Requer Compatibilidade com Versões Anteriores, selecione a versão de aplicativo como a API deve se comportar. Somente as versões aplicáveis para a API individual são exibidas.
Guia Argumentos
Nome do Argumento	É possível transmitir pares nome/valor para a API inserindo os valores na Guia Argumentos. Para que as APIs customizadas acessem valores customizados, a API deve implementar a interface com.yantra.interop.japi.YIFCustomApi. Se inseridos, esses pares de nome/valor são passados para o CustomApi como um objeto de Propriedades.
Valor do Argumento	Insira o valor do argumento.
Guia Modelo
	Quando APIs do sistema são chamadas, é possível especificar um modelo de saída para ser usado pela API. É possível especificar o modelo nas propriedades de configuração da Definição de Serviço, a Definição de Recurso na árvore de Hierarquia de Recursos, ou ambos. Porém, se o modelo tiver sido especificado em ambos os níveis de definição, o modelo especificado na Definição de Serviço é usado.
Modelo XML	Selecione esse botão de opções para construir o XML a ser usado para a saída da API. Insira o nome do elemento raiz do modelo e clique em OK. É possível, então, construir o XML.
Nome do arquivo	Selecione este botão de opções para inserir o nome do arquivo XML a ser usado como o modelo de saída da API. Este arquivo também deve existir em seu caminho de classe.
Guia Fatos
	Um Fato é um atributo que é usado por uma API ou por um agente para identificar a qual colônia se conectar e da qual recuperar dados. Baseado no nome fático e no valor do fato inserido, a colônia correspondente é determinada.
Nome do Fato	Insira o nome do fato do atributo XML.
Valor do Fato	Insira o valor fático do atributo XML.