Ir para o conteúdo

Cadastro de Respostas Padrão para Integrações (FIST0103)

Para que Serve?

Este programa tem como finalidade permitir cadastrar objetos e campos adicionais do JSON para processos de importação e exportação definidos para a integração Insight.

Os objetos e campos cadastrados serão incluídos no JSON de importação ou exportação da integração selecionada, quando é realizada uma requisição com o Insight.

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 campos 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 objetos e campos que irão compor o JSON de exportação de dados para o Insight.

Aba Exportação

Ao acessar o programa, é possível visualizar as informações dos objetos que possuem campos de JSON cadastrados para Exportação. É possível cadastrar um novo objeto com seus campos através do botão "Novo Registro".

Na tela de cadastro de campos do JSON de exportação, é necessário primeiramente preencher todas as informações do objeto que são as seguintes: Integração, Caminho (Informar o caminho completo do JSON até o objeto que se deseja incluir ou que se deseja adicionar os campos), Descrição (Descrição do objeto) e o Indicador "Cria Objeto" (Indica se o objeto será criado independente se já exista um com o mesmo nome no JSON.). Para salvar o objeto é necessário cadastrar pelo menos um campo através do botão "Novo Campo". Ao adicionar um campo o mesmo poderá ser visualizado na grade de consulta dos campos, logo abaixo das informações do objeto.

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

  • Objetos e campos de exportação: devem ser cadastrados na convenção de nomenclatura "camelCase" 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 JSON como parâmetros do SQL, para isso deve-se informar o caminho do campo dentro dos caracteres ‘<’ e ‘>’, bem como utilizar o símbolo ‘@’ antes do nome do campo. Ex.: “WHERE cod_item = items.@itemNumber”.

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

Integração Caminho Descrição Cria Objeto Campo Resposta
Envio de Itens items.attribute Atributo da Classificação do Item true attributeCode FOCCO_CLA
Envio de Itens items.attribute Atributo da Classificação do Item true value <"SELECT DINAMICO">

Observação: Um objeto "Attribute" obrigatoriamente deve possuir dois campos, 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 campos 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 os objetos e campos 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 campos 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 campos 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 campos e seus valores padrões do JSON 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 informados 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.