Ir para o conteúdo

Cadastro de Respostas Padrão para Integrações via XML (FIST0100)

Para que Serve?

Este programa tem como finalidade permitir cadastrar respostas padrões para processos de importação e exportação definidos para a integração Insight. É utilizado como uma espécie de De/Para, possibilitando informar dados obrigatórios que não seriam recebidos por uma importação de terceiro ou definir atributos padrões que serão exportados para alguns processos.

As respostas cadastradas serão incluídas na importação ou exportação da integração selecionada, quando é realizada a requisição.

Na aba de “Exportação” é possível realizar exportação e importação de registros através de um JSON, com o intuito de agilizar parametrizações e cadastros das respostas padrão de atributos entre ambientes e bases.

Como Utilizar?

Este programa pode ser acessado através do menu do FoccoERP, no módulo Insight.

O programa é dividido em duas abas, "Exportação" e "Importação", ambas com a funcionalidade de visualizar e cadastrar os atributos e respostas padrão que irão compor o XML de exportação de dados para o Insight.

Aba Exportação

Ao acessar o programa, é possível visualizar as informações das tags que possuem atributos padrão de XML cadastrados para Exportação. É possível cadastrar uma nova tag com seus atributos através do botão "Novo Registro".

Na tela de cadastro de atributos padrão de exportação, é necessário primeiramente preencher todas as informações da tag que são as seguintes: Integração, Caminho (Informar o caminho completo do XML até a tag onde se deseja adicionar os atributos), Descrição (Descrição da tag) e o Indicador "Cria Tag" (Indica se a tag será criada independente se já exista uma com o mesmo nome no XML.). Para salvar a tag é necessário cadastrar ao menos um atributo através do botão "Novo Atributo". Ao adicionar um atributo o mesmo poderá ser visualizado na grade de consulta dos Atributos logo abaixo das informações da tag.

Durante o cadastro de atributos é importante estar atento a alguns detalhes: - Respostas padrão de atributos do tipo data: devem seguir o seguinte formato: yyyy-mm-dd. Ex.: 2022-01-31.

  • Tags e atributos de exportação: devem ser cadastrados na convenção de nomenclatura em que a primeira letra de cada palavra em uma palavra composta seja maiúscula (PascalCase) Ex.: TaxCode; LocationName, PaymentTermsCode

  • No cadastro de exportação é possível inserir uma resposta dinâmica de acordo com um select. A resposta do select será buscada através da execução do mesmo durante a exportação.

  • No caso da resposta dinâmica é possível inserir informações do XML como parâmetros do SQL, para isso deve-se informar o caminho do abributo dentro dos carcterers ‘<’ e ‘>’, bem como utilizar o símbolo ‘@’ antes do nome do atributo. Ex.: “WHERE cod_item = root/Items/Item/@ItemNumber”.

  • Em casos em que a resposta dinâmica se refere a um atributo do Insight o cadastro deverá seguir o seguinte padrão:

Integração Caminho Descrição Cria Tag Atributo Resposta
Envio de Itens root/Items/Item/Attribute Atributo da Classificação do Item true AttributeCode FOCCO_CLA
Envio de Itens root/Items/Item/Attribute Atributo da Classificação do Item true Value <"SELECT DINAMICO">

Observação: Uma tag "Attribute" obrigatoriamente deve possuir dois atributos, AttributeCode e Value (conforme tabela acima) para que tenha suas informações exportadas corretamente de acordo com a estrutura do Insight.

Para completar o cadastro dos atributos padrão de exportação é necessário pressionar o botão "Salvar" no rodapé da página.

Ainda na tela inicial também é possível Exportar ou Importar repostas padrão de atributos via JSON.

Através do botão “Exportar Registros”, localizado acima da grade de registros, é possível gerar um JSON das respostas padrão de atributos cadastradas para posteriormente realizar a migração destes registros para outra base ou ambiente.

Através do botão “Importar Registros”, localizado ao lado do botão "Exportar Registros", é possível realizar a importação das respostas padrão de atributos através de um JSON. Para isto basta informar o JSON na área de texto.

Observação

Ao realizar a importação, os registros anteriormente cadastrados serão deletados ou substítuídos, somente os registros que estão sendo importados no JSON ficarão cadastrados.

Aba Importação

  • Ao entrar na aba de Importação, será possível visualizar os cadastrados dos atributos padrão do XML de importação.

Para realizar um novo cadastro é necessário pressionar o botão "Nova Resposta Padrão"

Observações da tela de cadastro: - Campos de importação que possuírem níveis hierárquicos devem ser informadsos com todos os níveis de hierarquia.

Por exemplo: na model/schema “ItemSaveDTO” do Swagger do contexto “FOCCOERP - FOCCOINTEGRADOR V1”, caso se queira informar uma resposta padrão para o campo modificador da pasta Pdm do Item, deve-se informar a hierarquia “Item.Pdm.Modificador.