Você está aqui:

Início
API
Fórmulas

Fórmulas

Seu guia para a integração V5!

A integração de fórmulas entre o V5 Traceability e o sistema ERP do cliente permite a importação de fórmulas/receitas/listas de materiais, que podem então ser programadas por meio de ordens de produção para fabricar lotes ou produtos usando o Terminal V5.

Para obter mais informações sobre como funciona o módulo de formulação no V5 Traceability, consulte nosso guia do módulo aqui.

1. Layout do Centro de Controle

Em termos de como podemos relacionar os detalhes da Fórmula com o que vemos no Control Center, usaremos a API V5 e o Gateway para preencher a parte superior ‘Formula’ painel para inserir dados do cabeçalho da fórmula, bem como o inferior ‘Formula Step’ painel para preencher os detalhes da etapa da fórmula.

Dependendo do nosso método de integração, estaremos fazendo uso do ‘Formula’ e ‘FormulaStep’ endpoints para preencher esses dois painéis e concluir nossa configuração de fórmula.

2. Links API

Para saber mais sobre as definições dessas classes de banco de dados, consulte os seguintes links:

Fórmula

FórmulaEtapa

3. Modelo de Integração

O modelo de integração para Fórmulas pode ser baixado aqui.

4. Guia de Campo de Fórmulas

4.1. Chaves primárias

Chaves primárias são o identificador exclusivo para cada tabela na API V5. Para Formula, isso é:

commodity.code – O código da mercadoria subjacente da fórmula. O número da fórmula/receita.

Para FormulaStep, as chaves primárias são:

formula.commodity.code – O mesmo código de mercadoria para a própria fórmula descrita acima.

sequence – Usado para determinar a ordem das etapas individuais da fórmula dentro de uma configuração de fórmula, ou seja, 1, 2, 3 etc.

4.2. Os campos obrigatórios

Outros campos exigidos pelo SG para preencher uma linha de fórmula válida no Control Center são:

Para Formula:

type - O tipo de fórmula. Deve ser 0 (para uma fórmula de lote) ou 1 (para uma fórmula de produto).

defaultSize - a 'Tamanho Base’ da fórmula em questão.

commodity.units.code – A unidade de peso na qual a fórmula será produzida. Se não for indicada, isso criará a fórmula na unidade de medida padrão do banco de dados.

Para FormulaStep:

type - a fórmula passo tipo.

Os tipos de etapas são os seguintes:

0 – Pesar
1 – Entrada chave
2 – Pergunta
3 - Mensagem
4 – Mudança de Contêiner
5 – Componente do Produto
6 – Embalagem do Produto
7 – Submixagem
8 – Agrupamento
9 - Dispense a granel
10 - opcional
11 – Digitalizar
12 - Rever
13 – Suspender

4.3. Campos preferidos

Os campos preferenciais servem para adicionar mais informações à fórmula em questão e, embora não sejam obrigatórios, são úteis quando se trata de funcionalidade adicional na Rastreabilidade V5.

Para Formula esses campos são:

commodity.units.code – A unidade de peso na qual a fórmula será produzida. Se não for indicada, isso criará a fórmula na unidade de medida padrão do banco de dados.

minimumProducts - O tamanho mínimo do lote que pode ser produzido

maximumProducts – O tamanho máximo do lote que pode ser produzido.

Para FormulaStep esses campos são:

sequence – a sequência da etapa da fórmula, ou seja, a ordem em que ela deve ser processada durante a produção.

commodity.code – o produto/ingrediente a ser usado para a etapa específica

targetQty – o peso alvo para a etapa específica

unit.code – a UM dessa etapa específica

question.question– Se esta etapa for uma pergunta ou mensagem, ela poderá ser inserida usando este campo.

Podemos, como vimos nas seções de chaves primárias e campos obrigatórios, percorrer entre esses 2 'formula'E'formulaStep' classes e, portanto, podemos incluir os pontos de dados acima para uso com qualquer uma das classes, desde que possamos passar para essa classe com sucesso.

4.4. Campos Adicionais

Campos adicionais também podem ser incluídos, como, para FormulaStep:

upperTol - A tolerância superior para essa etapa específica, ou seja, o máximo que o peso pode estar acima da quantidade alvo para ser aceitável quando a fórmula estiver sendo produzida.

lowerTol – A tolerância mais baixa para essa etapa específica, ou seja, o máximo que o peso pode estar abaixo da quantidade alvo para ser aceitável quando a fórmula estiver sendo produzida.

schedule – Se a etapa deve ser agendada quando a fórmula é produzida. Útil para etapas que são submixagens e precisam ser produzidas ao mesmo tempo que uma fórmula mestre.

Conforme discutido acima, ainda poderíamos fazer uso desses pontos de dados ao usar o ‘formula’ ponto final, simplesmente atravessando até o ‘formulaStep’ classe adicionando ‘formulaStep’ para cada um dos itens acima.

5. Metodologia

Dependendo da nossa metodologia de integração para fórmulas, geralmente usaríamos diferentes pontos finais; Para integração de API, geralmente usaríamos ‘Formula’e para CSV ‘FormulaStep’. Podemos dar uma olhada em ambos agora e ver por que isso acontece.

5.1. JSON – Importar

Fórmula:

Podemos fazer uso do ‘Formula’ endpoint para criar novas fórmulas para produção na rastreabilidade V5. Como veremos, usar esse endpoint nos permite capturar facilmente o cabeçalho da fórmula e as informações da etapa em um arquivo.

‘Formula’ importar Endpoint/URI –

http://host:port/V5-API/api/integrate/import/formula

Descrição do terminal

Para esta importação de amostra usando o ‘Formula’ endpoint, podemos estruturar um arquivo de importação básico para uma única fórmula com 2 etapas de fórmula conforme abaixo:

Este arquivo JSON de exemplo pode ser baixado aqui.

Usando o manual da API, podemos traçar os caminhos que estamos usando para percorrer as diversas classes que precisamos usar para esta importação. No ‘Formula’ classe, podemos ver que tudo o que estamos usando aqui é o ‘type’ e ‘productionLocation’. A partir daqui, precisamos definir nossa fórmula de informações sobre commodities, o que podemos fazer percorrendo de ‘Formula’ para ‘Commodity’. Aqui podemos inserir as informações da mercadoria para a própria fórmula (seu código, descrição etc.).

Para então definir as etapas da fórmula, primeiro precisamos ir até o ‘FormulaStep’ classe, onde podemos definir o tipo de etapa, quantidade alvo, tolerâncias, etc. A partir daqui, passaríamos novamente para a ‘Commodity’ classe, exceto que aqui, devido ao caminho que tomamos para a classe, estaremos definindo as informações da mercadoria para o ingrediente a ser usado em uma etapa específica da fórmula, em vez das informações do cabeçalho que já definimos acima.

A partir daqui, passaríamos de ambos os ‘Commodity’ aulas para chegar ao ‘WeightUnit’ classe, onde podemos definir a UM tanto para a fórmula em si, quanto para cada etapa individual. Portanto, embora estejamos usando a mesma classe para isso, chegamos a isso de 2 maneiras diferentes, o que se reflete nas definições que podemos ver (commodity.units.code vs formulaStep.commodity.units.code), permitindo-nos usar diferentes UMs, se desejado.

Podemos ver um resumo do pathfinding necessário para produzir o arquivo JSON acima aqui:

Podemos construir o restante de nossos pontos de dados necessários usando um método de descoberta de caminho semelhante.

Se executarmos o arquivo JSON acima, veremos que esta nova fórmula, junto com suas etapas, agora está visível na aba ‘Fórmulas’ do Control Center.

FórmulaEtapa:

‘FormulaStep’ importar Endpoint/URI –

http://host:port/V5-API/api/integrate/import/formula_step

Descrição do terminal

Para esta importação de amostra usando o ‘FormulaStep’ endpoint, veremos como importar a mesma fórmula que fizemos acima, mas apenas alteraremos seu nome. Usando este endpoint, podemos estruturar este arquivo conforme abaixo:

Também podemos fazer uso do ‘FormulaStep’ endpoint para criar novas fórmulas para produção em Rastreabilidade V5. Isso funcionaria basicamente da mesma maneira que usar ‘Formula’ acima, mas teríamos efetivamente que percorrer as classes do banco de dados ao contrário, então, em vez de ir de ‘Formula’ para ‘FormulaStep’, iríamos de ‘FormulaStep’ para ‘Formula’. Podemos ver como isso funcionaria abaixo:

Este arquivo JSON de exemplo pode ser baixado aqui.

Como podemos ver aqui, estamos inserindo as mesmas informações em termos das etapas, e apenas alterando o nome da fórmula. Observe aqui a travessia do ‘formulaStep’ classe para o ‘formula’ classe e o fato de que essas informações devem ser aninhadas para cada etapa da fórmula.

Se agora executarmos este arquivo JSON de exemplo, nossa fórmula duplicada será criada com as mesmas configurações que vimos ao usar o ‘Formula’ ponto final.

5.2. JSON – Exportar

Em termos de recebimento de arquivos relacionados a fórmulas/receitas da API V5, não estamos realmente rastreando nenhum dado de consumo aqui, então, em vez disso, estaremos simplesmente exportando a configuração/configuração de uma fórmula. Ainda existem algumas opções para isso se verificarmos os disponíveis ‘IntegrationExport’ Serviços:

Fórmula:

Exportar endpoint/URI –

http://host:port/V5-API/api/integrate/export/formula/{code}

Descrição do terminal

Este endpoint exportará um arquivo JSON com todas as informações relacionadas a uma fórmula específica. Se executarmos esta solicitação GET para a fórmula que criamos por meio do ‘Formula’ endpoint, obteremos um arquivo de retorno parecido com este:

Um exemplo de arquivo JSON pode ser baixado aqui.

All Formulas:

Exportar endpoint/URI –

http://host:port/V5-API/api/integrate/export/formulas

Descrição do terminal

Este endpoint exportará um arquivo JSON que inclui uma lista de todas as fórmulas contidas no sistema. Observe que isso retornará apenas os dados do cabeçalho de cada fórmula. Para recuperar as etapas da fórmula, veja abaixo.

Arquivos JSON de exemplo deste tipo podem ser baixados aqui.

Etapa da fórmula:

Exportar endpoint/URI –

http://host:port/V5-API/api/integrate/export/formula_step/{code}/{sequence}

Descrição do terminal

Este endpoint pode ser configurado para retornar dados de uma etapa específica de uma fórmula específica. Especificaríamos qual etapa queremos recuperar usando seu número de sequência. Se atingirmos esse ponto final para recuperar a etapa 1 da primeira fórmula de exemplo que criamos acima, obteremos um retorno semelhante a este:

Este arquivo JSON de exemplo pode ser baixado aqui.

Etapas da fórmula:

Exportar endpoint/URI –

http://host:port/V5-API/api/integrate/export/formula_steps/{all}

Descrição do terminal

Este endpoint fornece uma lista de todas as etapas da fórmula no sistema. Podemos alterar o retorno usando ‘/true’ or ‘/false’ em lugar de ‘/{all}’ no URI acima. ‘True’ exportará uma lista de todas as etapas do sistema, enquanto ‘false’ retornará uma lista de etapas não marcadas como já exportadas.

O layout seria muito semelhante ao exemplo acima, apenas com mais etapas presentes. Um exemplo de ‘true’ exportação deste tipo pode ser baixada aqui..

5.3. CSV - Importar

Observação: Depois de importadas, as fórmulas podem ser protegidas contra alterações marcando a caixa "Isenção de importação" no cabeçalho da fórmula no Centro de Controle . Isso se aplica somente ao formato CSV.

Vimos nos exemplos JSON acima que podemos usar tanto o ‘formula’ e ‘formulaStep’ pontos finais para essa metodologia específica. No entanto, para importações de CSV usaremos apenas o ‘formulaStep’ ponto final.

Nome do arquivo de definição de cabeçalho/coluna: “formulaStep.csvh”

Os arquivos de cabeçalho completos devem ser colocados em: “<installdir>\SG Control Center\gateway\import\column_defs”

Nome do arquivo CSV de importação: “formulaStep-datetime.csv”

Os CSVs para importação devem ser colocados em: “<installdir>\SG Control Center\gateway\import”

Arquivo de cabeçalho:

Os arquivos de cabeçalho geralmente serão compilados pela SG Systems antes da realização das integrações CSV, mas podemos ver abaixo um exemplo básico de um que podemos usar para trabalhos:

Para obter mais informações sobre como estruturamos esses arquivos, consulte a página principal de integração . Este arquivo de cabeçalho de exemplo pode ser baixado aqui.

Arquivo de importação CSV:

Podemos então usar a ordem definida de pontos de dados no cabeçalho para estruturar nosso arquivo de importação. A SG Systems pode fornecer um arquivo de modelo para isso, listando o ponto de dados para cada coluna para tornar as coisas mais claras ao preencher a lista. Observe que esta primeira linha pode ser ignorada pelo Centro de Controle e, portanto, pode ser mantida no arquivo ao enviar para importação.

Novamente criaremos uma fórmula duplicada das 2 que criamos através do método JSON acima. Um exemplo de arquivo de importação csv para uma fórmula poderia ser algo assim:

Este arquivo de importação de exemplo pode ser baixado aqui.

Com a importação concluída, podemos ver que esta fórmula adicional foi adicionada ao Control Center com as mesmas etapas das fórmulas que criamos usando as importações JSON acima.

5.4. CSV - Exportar

Para nossas exportações de CSV, usaremos apenas o mesmo ‘formulaStep’ arquivo de cabeçalho/endpoint como acima para as importações. Isso pode ser baixado aqui..

Nome do arquivo de definição de cabeçalho/coluna: “formulaStep.csvh”

Os arquivos de cabeçalho completos devem ser colocados em: “<installdir>\SG Control Center\gateway\export\order”

Exportar nome do arquivo CSV: “FormulaStep-datetime.csv”

Os CSVs para exportações serão gerados em: “<installdir>\SG Control Center\gateway\export”

Esta é a única maneira de recuperar os dados da fórmula da Rastreabilidade V5 na forma de um CSV.

Esta exportação também precisaria ser habilitada na seção Gateway do Control Center. Podemos escolher aqui exportar ‘Formulas’.

Arquivo de cabeçalho:

Para este exemplo, podemos usar o cabeçalho usado anteriormente para importação para a exportação. Pontos de dados adicionais podem ser adicionados a isso, se desejado.

Arquivo de exportação CSV:

Habilitar esta exportação usando o cabeçalho usado anteriormente forneceria um arquivo de exportação para nossas 3 novas fórmulas que ficaria assim: