Transferências
Seu guia para a integração V5!
A integração de transferências entre o V5 Traceability e o sistema ERP de um cliente permite que detalhes de transferência, itens de linha de transferência e informações de agendamento sejam enviados para o V5 Traceability. Estas transferências podem então ser enviadas e recebidas através do software V5 WMS, após o qual informações como quais lotes foram enviados e recebidos, quanto foi enviado, em que palete estava, etc., podem ser enviadas de volta ao ERP.
O V5 também pode atuar como mestre de dados neste caso, e enviar as transferências criadas dentro do sistema para o ERP.
Mais informações sobre como funciona o módulo de transferências na Rastreabilidade V5, consulte nosso guia do módulo aqui.
Conteúdo
1. Layout do Centro de Controle
Em termos de como podemos nos relacionar ‘Transfers’ e ‘Transfer Lines’ ao que vemos no Control Center, podemos ver que o painel superior aqui é para as Transferências, onde de/para sites, números de referência externos etc., podem ser importados.
O painel inferior esquerdo é onde podemos adicionar nossas Linhas de Transferência, contendo dados relevantes para as mercadorias e quantidades necessárias para a transferência.
Usando o V5 Gateway podemos facilmente preencher ambos os painéis, separadamente ou juntos.
O painel inferior direito contém dados relativos ao local onde os itens da Transferência foram retirados no local “de” e recebidos no local “para”. Esses dados farão parte da exportação que podemos receber do Gateway V5.
2. Links API
Para saber mais sobre as definições dessas classes de banco de dados, consulte os seguintes links:
3. Modelo de Integração
O modelo de integração para Transferências pode ser baixado aqui.
4. Guia de campo de transferências
4.1. Chaves primárias
Chaves primárias são o identificador exclusivo para cada tabela na API V5. Para Transfers, isso é:
reference – O número de referência exclusivo da transferência. Essencialmente, o número da ordem de transferência.
Para a TransferLines, a chave primária é ou:
reference + commodity.code – A referência/número da transferência juntamente com a mercadoria a ser transferida.
or
lineID – Para fins avançados, onde a mesma mercadoria pode aparecer em diversas linhas, você pode especificar um ID de linha como um identificador exclusivo em vez da referência de transferência e do código da mercadoria. Isto é necessário se mais de uma linha da mesma mercadoria estiver na transferência.
4.2. Os campos obrigatórios
Outros campos exigidos pelo SG para preencher uma entrada válida no Control Center são:
Para a TransferLines:
quantityOrdered – a quantidade dessa mercadoria sendo encomendada.
Para a Transfers:
fromLocation.code - o local de onde a transferência será enviada.
toLocation.code - o local para onde a transferência será enviada.
4.3. Campos preferidos
Os campos preferenciais servem para adicionar mais dados à transferência e, embora não sejam obrigatórios, são úteis quando se trata de funcionalidade na Rastreabilidade V5. Estes são:
lineID - se não for usado como chave primária acima, este campo deve ser incluído.
commodity.code – se não for usado como chave primária acima, este campo deverá ser incluído. O código da mercadoria a ser transferida.
transfer.reference - se não for usado como chave primária acima, este campo deve ser incluído.
O acima se aplica a 'transferLines'. Podemos aplicar os mesmos campos a ‘transfers' adicionando ‘transferLine’ para as 2 primeiras entradas e removendo ‘transfer’ do último.
4.4. Campos Adicionais
Campos adicionais também podem ser incluídos, como, para ‘transfer’:
comment – quaisquer comentários adicionais para a transferência.
fromAddress – o endereço de onde a transferência é enviada. Estes são povoados em ‘Site Addresses‘.
toAddress – o endereço em que a transferência é recebida.
directTransfer – se esta transferência deveria ser uma transferência direta ou não.
Semelhante ao acima, se criar um ‘transferLine'arquivo, podemos simplesmente passar para a classe de transferência adicionando ‘transfer’ ao início dos parâmetros acima.
5. Metodologia
Dada a natureza do ‘Transfer’ e ‘TransferLine’, podemos optar por importar dados de 2 maneiras:
- Nós podemos usar o ‘Transfer’ endpoint para importar transferências e, em seguida, como veremos abaixo, vá para o ‘TransferLine’ class para incluir todos os itens de linha do componente em um arquivo. Esta é a maneira mais lógica de importar transferências inteiras, pois requer apenas um conjunto de informações de cabeçalho e, em seguida, os itens de linha subsequentes. Observe que este também é o único endpoint que podemos usar para modificar as informações do cabeçalho da transferência.
- Nós podemos usar o ‘TransferLine’ endpoint para modificar ou adicionar linhas de transferência depois que a transferência for criada. Isso ainda pode ser usado para importar transferências inteiras, mas é menos eficiente, pois cada item de linha de transferência precisaria conter uma referência aninhada ao cabeçalho da transferência (como a referência). Conforme indicado acima, este ponto final não pode ser usado para fazer alterações nas informações do cabeçalho de transferência (referência/de e para locais, etc.).
Qual desses endpoints usaremos dependerá em grande parte se usarmos uma importação JSON ou CSV. Agora podemos olhar para eles abaixo.
5.1. JSON – Importar
Transferência:
‘Transfer’ importar Endpoint/URI –
http://host:port/V5-API/api/integrate/import/transfer
Para esta importação de amostra, usaremos o ‘Transfer’ endpoint e estruturar um arquivo de importação básico de uma transferência com 2 linhas, isso poderia ser algo assim:
Este arquivo JSON de amostra pode ser baixado aqui.
Podemos ver por que usaríamos o ‘Transfer’ endpoint para este formato, dada a capacidade dos arquivos JSON de armazenar dados aninhados, permitindo-nos incluir recuados ‘TransferLines’ listas e posteriormente ‘Commodity’ pontos de dados na importação, que podem ser determinados usando o manual da API SG. Por exemplo, o ‘commodity code’ O ponto de dados pode ser encontrado usando o seguinte caminho no manual da API:
Podemos construir o restante de nossos pontos de dados necessários usando um método de descoberta de caminho semelhante.
Usando o arquivo acima, podemos ver que nossa nova transferência foi criada no Control Center.
Linhas de transferência:
‘TransferLine’ importar Endpoint/URI –
http://host:port/V5-API/api/integrate/import/transfer_line
Como discutido acima, podemos usar o ‘TransferLine’ endpoint para adicionar ou editar linhas de uma transferência existente. Também podemos adicionar transferências usando este endpoint, mas é importante lembrar que só podemos editar um cabeçalho de transferência usando o comando ‘Transfer’ URI acima. Observe também que as informações de transferência teriam que ser aninhadas aqui para cada linha de transferência.
Podemos ver um exemplo de ‘TransferLine’ Arquivo JSON abaixo, onde adicionaremos outra linha para transferir ‘TR-1882’ que criamos acima:
Este arquivo JSON de amostra pode ser baixado aqui.
Assim que esta solicitação for postada, podemos retornar ao Centro de Controle e ver que uma terceira linha foi adicionada a esta transferência.
5.2. JSON – Exportar
Em termos de recebimento de arquivos relativos a transferências de volta da API V5, se verificarmos os resumos dos métodos no ‘IntegrationExport‘ class, então temos algumas opções diferentes aqui:
Transferências:
Exportar endpoint/URI –
http://host:port/V5-API/api/integrate/export/transfers
Este endpoint exportará arquivos JSON de transferência completa usando a classe de banco de dados de transferência e incluirá todas as transferências que ainda não foram marcadas como exportadas pelo sistema ou que foram alteradas desde que foram exportadas pela primeira vez. Isso não incluirá nenhum dado de movimentação de estoque, mas fornecerá um retorno para cada ponto de dados no ‘Transfer’ classe.
Um exemplo deste tipo de arquivo JSON pode ser baixado aqui.
Transferência:
Exportar endpoint/URI –
http://host:port/V5-API/api/integrate/export/transfer/{referenceNumber}
Este endpoint exportará arquivos JSON de transferência completa usando a classe de banco de dados de transferência, mas apenas para a transferência especificada e somente se essa transferência ainda não tiver sido marcada como exportada pelo sistema. Como acima, isso não incluirá nenhum dado de movimentação de estoque, mas fornecerá um retorno para cada ponto de dados no ‘Transfer’ classe.
Um exemplo deste tipo de arquivo JSON pode ser baixado aqui.
Também podemos utilizar endpoints transacionais e de log para recuperar informações mais relevantes sobre mercadorias recebidas em Pedidos de Compra.
Para Transferências, temos 1 Registro do sistema endpoint que podemos usar:
Logs do sistema:
Exportar endpoint/URI –
http://host:port/V5-API/api/integrate/export/system_logs
O uso deste endpoint retornará uma lista completa de eventos de log do sistema que não foram marcados como exportados anteriormente. Mais informações sobre este endpoint podem ser encontradas aqui. Esses resultados podem ser filtrados para procurar transferências específicas descritores, como ‘MOVED OUT/IN’, ‘PALLET MOVED OUT/IN’ e ‘PALLET TRANSFER OUT/IN’.
Um exemplo deste tipo de arquivo JSON pode ser baixado aqui.
5.3. CSV - Importar
Observe que para importações de CSV, normalmente usaríamos apenas o ‘TransferLine’ endpoint, permitindo-nos gerar transferências e seus itens de linha através do uso de uma única importação csv.
Nome do arquivo de definição de cabeçalho/coluna: “transferLine.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: “transferLine-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 transferências:
Para mais informações sobre como estruturamos esses arquivos, consulte o página principal de integração. Este arquivo de cabeçalho de amostra 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.
Aqui podemos ver que pretendemos criar uma transferência semelhante à que criamos usando a metodologia JSON. Este arquivo de importação de amostra pode ser baixado aqui.
Com a importação concluída, podemos ver que esta transferência, juntamente com os itens de linha necessários, foram adicionados ao Control Center. Observe que se o ‘Created Date’ dados não estão incluídos na importação, a data colocada fará referência à data de hoje.
5.4. CSV - Exportar
Ao exportar informações de transferência através deste método, isso faria parte de um ‘SystemLog’ exportar. Podemos ver as definições de classe para este endpoint aqui.
Nome do arquivo de definição de cabeçalho/coluna: “SystemLog.csvh”
Os arquivos de cabeçalho completos devem ser colocados em: “<installdir>\SG Control Center\gateway\export\order”
Exportar nome do arquivo CSV: “SystemLog-datetime.csv”
Os CSVs para exportações serão gerados em: “<installdir>\SG Control Center\gateway\export”
Este endpoint pode ser usado para extrair uma ampla variedade de dados, percorrendo os pontos de dados disponíveis vinculados a ele.
Cabeçalho:
Podemos usar pontos de dados como ‘user’, ‘timestamp’ e ‘quantity’ neste topo ‘System Log’ nível, mas então podemos passar para o ‘TransferLine’ classe para adicionar campos como número de referência e mercadorias que foram solicitadas na transferência, bem como ao ‘Stock’ classe para recuperar informações como os locais de/para onde os itens foram movidos.
Em um nível muito básico, nossa parte do cabeçalho do log do sistema que trata das transferências poderia ser mais ou menos assim:
Este arquivo de cabeçalho de amostra pode ser baixado aqui.
Com este cabeçalho em vigor, devemos também garantir que selecionamos exportar ‘System Logs’ na aba de exportação do Gateway no Control Center.
Com nosso cabeçalho no lugar e a exportação habilitada (não se esqueça de reiniciar o Control Center para aplicar quaisquer alterações feitas no Gateway!), obteremos posteriormente um arquivo de retorno para esta transferência (junto com quaisquer outras transferências não exportadas anteriormente) que se parece com esse:
