Integração de Documentos - View Banco de Dados

O sistema Valesoft permite a integração de documentos através da consulta de uma view, com campos pré-definidos, em um banco de dados externo.

Para isso é necessário configurar dentro do sistema Valesoft, a url do banco de dados, o usuário de autenticação, a senha de autenticação, o nome do banco de dados e o seu tipo, além do nome View.

A consulta à View ocorre ordenando-se pela campo de documentDate e seu retorno é paginado com lotes de 250 registros.

É possível integrar todos os items da view ou apenas um em específico baseado no código informado na hora da integração. Nessa consulta por código, o campo de referência será adicionado como um parâmetro na condição da consulta da view: WHERE documentReference='123/1234'

O comportamento do sistema Valesoft ao receber os dados é de criar os novos registro ou atualizar os mesmo caso já existam, baseando-se nos campos de referências do documento, produto, cor e fornecedor.

Exemplo dummy de view a ser consumida:

CREATE OR REPLACE VIEW documentviewtest
AS SELECT 
    '1234' AS "documentReference",
    'Documento' AS "documentDescription",
    CURRENT_DATE AS "documentDate",
    'LOTE' AS "documentBatch",
    'MANUFACTURE' AS "documentType",
    '789' AS "productReference",
    'RAW' AS "productType",
    'Produto 2' AS "productDescription",
    '9876543210' AS barcode,
    'Un' AS "measureUnit",
    '12' AS "size",
    'Verde' AS "color",
    '123456/123' AS batch,
    '789001' AS "productGridReference",
    'DEP01' AS "placeReference",
    'Depósito 1' AS "placeName",
    'WAREHOUSE' AS "placeType",
    '87654' AS "customerReference",
    'Consumidor 87654' AS "customerName",
    '123457' AS "supplierReference",
    'Fornecedor 123457' AS "supplierName",
    123.4 AS fraction,
    2 AS quantity,
    'ABC45678901234567890123' AS epc,
    'asdf' AS campoCustom1,
    '1234' AS campoCustom2;

Resposta esperada pela integração Banco de Dados

documentReference	documentDescription	documentDate	documentBatch	documentType	productReference	productType	productDescription	barcode	measureUnit	size	color	batch	productGridReference	placeReference	placeName	placeType	costumerReference	costumerName	supplierReference	supplierName	fraction	quantity
11746 - new	Nota Teste 11746 - new	2024-03-14	LOTE	MANUFACTURE	1000501717302	RAW	1000501717302 - MEIA MALHA 30/1 PA 37%PES 63%ALG MESCLA COLMEIAPRE LAVADO - PRE LAVADO - 000002.010				PRE LAVADO - 000002.010	123456	1000501717302			WAREHOUSE			Valesoft	Valesoft	2.2	12

Obs.: A descrição dos parâmetros está no final da página

Tipos de Integrações

• Integração por Tipo de Documento:

Na integração por Tipo de Documento, o sistema fará a consulta baseado no tipo de documento selecionado na hora da integração. Retornando apenas documentos deste tipo e seus produtos.

Na consulta do banco de dados o campo de tipo do documento será adicionado como um parâmetro na condição da consulta:  WHERE documentType='ENTRY'

• Integração por Referência:

Na integração por referência, o sistema fará a consulta baseado no código informado na hora da integração. Retornando apenas esse documento e seus produtos.

Na consulta do banco de dados o campo de referência do documento será adicionado como um parâmetro na condição da consulta:  WHERE documentReference='123456'

• Integração periódica:

Na integração periódica, o sistema fará uma consulta de periodicamente, informando uma data inicial e final.
Assim, o sistema externo ou o banco de dados retornará a lista de documentos cuja data de emissão atenda a esse intervalo de datas, juntamente com os dados de produtos e quantidades.

Na consulta do banco de dados o campo de data do documento será adicionado como um parâmetro na condição da consulta:  WHERE documentDate BETWEEN '2023-09-28' and '2023-09-29'

Definições dos campos do corpo da requisição:

• items - OBRIGATÓRIO

  • Lista de registros a serem criados/atualizados

• documentReference - OBRIGATÓRIO

  • Alfanumérico
  • Código do documento
  • Chave Primaria - Utilizado para criação ou alteração do registro

• documentDescription - OBRIGATÓRIO

  • Texto
  • Descrição do documento

• documentDate - OBRIGATÓRIO

  • Data no formato AAAA-MM-DD
  • Data de Emissão do documento
    • Ex 2023-11-01

• documentBatch

  • Texto
  • Lote do documento

• documentType - OBRIGATÓRIO

  • Texto Predefinido - Maiúsculo
  • Tipo do documento
  • Valores aceitos:
    • PROCESSING - Ordem de Beneficiamento
    • MANUFACTURE - Ordem de produção
    • ENTRY - Nota de Entrada
    • OUTGOING - Nota de Saída
    • SALES - Pedido de venda
    • SHIPPING - Remessa

• placeReference - OBRIGATÓRIO quando informado o placeName

  • Alfanumérico
  • Código do Local
  • Chave Primaria - Utilizado para criação ou alteração do registro

• placeName

  • Texto -Nome do Local

• placeType - OBRIGATÓRIO quando informado o placeName

  • Texto Predefinido - Maiúsculo
  • Tipo do local
  • Valores aceitos:
    • SITE - Planta/Empresa
    • WAREHOUSE - Depósito
    • SECTOR - Setor/Prateleira
    • CONTAINER - Armazenagem de localização

• customerReference - OBRIGATÓRIO quando informado o customerName

  • Alfanumérico
  • Código do Cliente
  • Chave Primaria - Utilizado para criação ou alteração do registro

• customerName

  • Texto
  • Nome do Cliente

• supplierReference - OBRIGATÓRIO quando informado o supplierName

  • Código do fornecedor
  • Chave Primaria - Utilizado para criação ou alteração do registro

• supplierName

  • Nome do fornecedor

• productReference - OBRIGATÓRIO

  • Alfanumérico
  • Código/SKU Único do produto
  • Chave Primaria - Utilizado para criação ou alteração do registro

• productType - OBRIGATÓRIO

  • Texto Predefinido - Maiúsculo
  • Tipo do produto
  • Valores aceitos:
    • RAW - Matéria-prima
    • PRODUCED - Produto acabado
    • CONTAINER - Armazenagem
    • FIXED_ASSET - Ativo Imobilizado

• productDescription - OBRIGATÓRIO

  • Alfanumérico
  • Descrição do produto

• barcode

  • Numérico Inteiro
  • Código de barras EAN-13 ou um sequencial numérico único do produto, utilizado para a criação da etiqueta EPC no padrão GS1-SGTIN

• measureUnit

  • Texto
  • Unidade de medida do produto
    • Ex. M², Un, KG

• productGridReference

  • Alfanumérico
  • Código/SKU Único da grade do produto
  • Chave Primaria - Utilizado para criação ou alteração do registro

• size

  • Alfanumérico
  • Código do tamanho do produto
  • Chave Primaria - Utilizado para criação ou alteração do registro

• color

  • Alfanumérico
  • Código da cor do produto
  • Chave Primaria - Utilizado para criação ou alteração do registro

• batch

  • Alfanumérico
  • Lote do item no documento/epc

• fraction

  • Numérico Decimal
  • Quantidade fracionada do produto/epc
    • Ex. Peso, Metragem, etc

• quantity - OBRIGATÓRIO

  • Numérico Inteiro
  • Quantidade de etiquetas desse produto no documento

• epc

  • Alfanumérico com restrição(A-F0-9)
  • Código EPC da etiqueta a ser cadastrada no sistema.

• campoCustom1 e campoCustom2

  • Quaisquer nomes de campos personalizados desde que os mesmos estejam devidamente configurados nas configurações de campos personalizados do sistema.