A integração entre o BackOffice Datasul e a Plataforma e-Commerce da Ciashop tem como objetivo realizar a comunicação da loja de comércio eletrônico com o ERP Datasul.
Ciashop
Sistema vertical desenvolvido pela Ciashpp, empresa do ecossistema TOTVS, que dispõe de módulos e aplicativos voltados para o e-commerce. Com a plataforma Framework Ciashop é possível montar sua própria loja de comércio eletrônico, integrando esta loja, com os principais marketplaces disponíveis no mercado.
ERP Datasul
Sistema de BackOffice para gestão de empresas com ênfase no segmento de Manufatura. Disponibiliza módulos de gestão e controle da distribuição com foco nos requisitos comerciais, fiscais e tributários, entre eles: Pedidos de Venda, Faturamento e Embarques.
A forma de comunicação entre ERP e Ciashop se dará por meio de mensagens enviadas e recebidas de um Web service RESTfull. Os Web services RESTful são serviços construídos com o estilo de arquitetura RESTful. A construção de Web services com a abordagem RESTful está surgindo como uma alternativa popular ao uso de tecnologias baseadas em SOAP para implantação de serviços na Internet, por ser mais leve e ter a capacidade de transmitir dados diretamente via HTTP.
A plataforma Framework Ciashop é uma plataforma em que o cliente pode montar sua própria loja de comércio eletrônico.
O Ciashop permite que o cliente monte sua própria loja virtual. Para estabelecer a estrutura da loja virtual com seus departamentos e itens postos a venda o ERP deverá fornecer tais informações. A loja virtual estará integrada com o ERP transmitindo para este os clientes e pedidos cadastrados na loja virtual.
A forma de comunicação entre ERP e Ciashop se dará por meio de mensagens enviadas e recebidas de um Web service RESTfull. Os Web services RESTful são serviços construídos com o estilo de arquitetura RESTful. A construção de Web services com a abordagem RESTful está surgindo como uma alternativa popular ao uso de tecnologias baseadas em SOAP para implantação de serviços na Internet, por ser mais leve e ter a capacidade de transmitir dados diretamente via HTTP.
O conceito de Marketplace (MP), no comércio eletrônico, é a utilização de uma loja virtual de terceiros para vender os seus produtos.Sales Hub é um aplicativo disponível para Lojas Framework da Ciashop que concentra diversos marketplaces, tais como Extra e Walmart. Através deste aplicativo é possível ofertar os produtos da loja nestes marketplaces e gerenciar os pedidos gerados nestes canais em sua própria loja.
O objetivo da integração é possibilitar a integração dos Cadastros de Famílias Comerciais, Itens, Tabela de Preço e Saldo em Estoque disponível do Datasul para o Ciashop. Assim como, a integração do recebimento de pedidos de venda oriundos do Ciashop e a atualização do status destes pedidos.
Versão\release 12.1.17
Parâmetros de integração ativo: Cadastros Gerais -> Cadastros Gerais -> Cadastros -> Funçâo: Manutenção Cadastros Gerais Parâmetro Global (CD0101 - Aba Integr II)
Parâmetros de configuração da integração ativo: Menu -> Logística -> Pedidos -> Cadastros -> Função: Parâmetros Integração Ciashop
Vide tópico Pré-requisitos instalação/implantação/utilização.
Vide tópico Pré-requisitos instalação/implantação/utilização.
O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução das mensagens de integração e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.
Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.
O suporte aos recursos da Integração será de responsabilidade de todas as linhas, sendo assim as equipes de suporte dos produtos Ciashop e Backoffice Datasul estarão aptas a fazer a primeira análise e, quando necessário, repassar para a equipe mais adequada em cada caso.
Observação: Este modelo de suporte está sendo revisado pela TOTVS.
Método | ID | Descrição | Origem | Destino | Web Services |
Cadastros | 01 | Família Comercial | Datasul | Ciashop | Departments |
02 | Itens | Datasul | Ciashop | Products | |
03 | Preço Item | Datasul | Ciashop | Prices | |
04 | Saldo Estoque | Datasul | Ciashop | Variants | |
Processos | 05 | Receber pedidos | Ciashop | Datasul | Orders |
06 | Atualizar status dos pedidos | Ciashop | Datasul | Orders | |
07 | Cancelar Pedido | Datasul | Ciashop | Orderstatuses | |
08 | Atualizar NF-e | Datasul | Ciashop | Invoices |
Os cadastros devem ser realizados no Datasul e integrados para o Ciashop, a ativação da integração, no entanto, não impede a inclusão, alteração e exclusão de registros no Ciashop, mas esse procedimento não é recomendado, pois as operações realizadas sobre os cadastros no Ciashop, não são replicadas para os respectivos cadastros no Datasul.
Para realizar uma operação de inclusão ou alteração, é necessário que seja disparado o programa de carga/atualização no Datasul, para que estes dados sejam considerados na integração e a atualização seja efetuada no Ciashop. A operação de eliminação sobre os registros de cadastros não é integrada, pois não é possível verificar a integridade referencial no sistema de destino para considerá-la como restrição de eliminação dos registros no Datasul.
O sucesso das operações de inclusão e alteração de registros pode ser verificado acessando o programa Monitor Integração Ciashop (PD0625). Por meio deste programa, é possível realizar a consulta do envio dos registros referente aos cadastros de Família Comercial, Itens, Preço Item,Saldo em Estoque, recepção dos pedidos e atualização dos status dos pedidos.
Através do programa Integração Batch Ciashop (PD0624) é possível realizar a carga/atualização dos registros em lote, ele pode ser acessado pelo menu do Datasul em: Logistica -> Pedidos -> Tarefas.
No programa Manutenção Categoria Item (PD0623) é possível definir todas as famílias comercias (Categoria) e seus respectivos itens (Produtos) que serão enviados ao Ciashop. Importante ressaltar que os itens que serão enviados para o Ciashop precisam obrigatoriamente estarem cadastrados no programa Tabela Preço (CD1508), este cadastro é necessário pois o preço do produto no Ciashop, é o valor informado no campo Preço FOB do programa CD1508. Para que o saldo disponível em estoque do item, seja enviado ao Ciashop, é necessário que este possua saldo em estoque disponível, caso o item não possua saldo, é possível realizar o cadastro por meio do programa Transações Diversas Estoque (CE0220).
Para o envio das informações de saldo e preço do item, serão considerados o depósito e a tabela de preço padrão informados no programa Parâmetros Integração Ciashop (PD0310). Obrigatoriamente todos os itens enviados para o Ciashop, deverão estar cadastrados na tabela de preço informada no programa PD0310, assim como deverão estar cadastrados com saldo em estoque para o depósito informado no PD0310.
Cadastros
A seguir o diagrama de fluxo de informações relacionando os cadastros integrados entre BackOffice Datasul e Ciashop. Após o diagrama serão descritos os detalhes da integração de cada cadastro.
FAMÍLIA COMERCIAL
Para que a integração do cadastro de Família Comercial seja realizada é obrigatório:
Além disso é necessário cadastrar esta família comercial no programa Manutenção Categoria Item (PD0623):
Ao cadastrar uma família comercial, todos os itens vinculados a esta família serão automaticamente apresentados em tela
As famílias comerciais (no contexto Ciashop possuem a descrição de categorias), enviadas do BackOffice Datasul para o Ciashop, poderão ser consultadas no manager do Ciashop, por meio do menu: Categorias e Produtos -> Gerenciar Categorias:
ITEM
Para que a integração do cadastro de itens seja realizada é obrigatório marcar o parâmetro "Item" no programa Integração Batch Ciashop (PD0624), aba parâmetro:
Além disso é necessário definir que este item será considerado na integração com o Ciashop por meio do programa Manutenção Categoria Item (PD0623):
Os itens enviados do BackOffice Datasul para o Ciashop, poderão ser consultados no manager do Ciashop, por meio do menu: Categorias e Produtos -> Catálogos de Produtos:
Preço/Tabela de Preço
Para que a integração da atualização do preço do item seja realizado é obrigatório:
Além disso é necessário cadastrar os preços para todos os itens que serão enviados para o Ciashop por meio do programa Tabela Preço (CD1508):
Os preços enviados do BackOffice Datasul para o Ciashop, poderão ser consultados no manager do Ciashop, por meio do menu: Categorias e Produtos -> Catálogos de Produtos -> Cadastros de Produtos -> Preço e Estoque:
Saldo em Estoque
Para que a integração da atualização do saldo em estoque disponível dos itens seja realizado é obrigatório:
O cadastro de saldo em estoque poderá ser realizado por meio do programa Transações Diversas Estoque (CE0220):
O saldo em estoque enviado do BackOffice Datasul para o Ciashop, poderá ser consultado no manager do Ciashop, por meio do menu: Categorias e Produtos -> Catálogos de Produtos -> Cadastros de Produtos -> Preço e Estoque:
Através do programa Monitor Integração Ciashop (PD0625), é possível realizar a consulta do envio dos registros referente aos cadastros de Família Comercial, Itens, Preço Item,Saldo em Estoque, recepção dos pedidos e atualização dos status dos pedidos:
Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.
Sempre que existir (a sugestão é sempre criar) e for agregador ao documento acrescentar aqui os diagramas/imagens ou até mesmo colocar tais diagramas diretamente na especificação dos processos
Em seguida faça uma descrição para cada um dos fluxos para cada entidade
<Transação/Entidade>
Identificador da Mensagem: <mensagem>
Versão: <versão>
Módulo <marca 1>: <BackOffice – Gestão xxxxxxx>
Módulo <marca 2>: <SIGAXXX>
Tipo de Envio: <Assíncrona/Síncrona>
Mensagem Padrão | PROTHEUS | RM | ||
Tabela | Campo | Tabela | Campo | |
Code | CTO990 | CTO_SIMB | GMOEDA | SIMBOLO * |
Description | CTO990 | CTO_DESC | GMOEDA | DESCRICAO |
Symbol | CTO990 | CTO_SIMB | GMOEDA | SIMBOLO |
Notas:
Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela
A seguir descrever as variações, particularidades da mensagem e processos (integração) de acordo com cada marca
Limitações/Restrições
Descreva limitações e restrições para a integração que está sendo descrita.
Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.
Sempre que existir (a sugestão é sempre criar) e for agregador ao documento acrescentar aqui os diagramas/imagens ou até mesmo colocar tais diagramas diretamente na especificação dos processos
Em seguida faça uma descrição para cada um dos fluxos para cada entidade
<Transação/Processo>
Tipo de Fluxo: Protheus -> RM
Mensagem: Request_1_000
Versão: 1.000
Descrição de todo o comportamento e funcionamento do processo. Breve contexto, origem, regras, integração (geração da mensagem, envio, recebimento no destino), o quê supostamente irá ocorrer no destino, retorno, impacto, consequências, o que foi afetado, como conferir, validar, etc o retorno.
Acrescentar um diagrama do processo.
A seguir descrever as variações, particularidades da mensagem e processos (desta integração) de acordo com cada marca
Notas:
Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela
Limitações/Restrições
Descreva limitações e restrições para a integração que está sendo descrita.
Descreva limitações e restrições para cada fluxo descrito no tópico anterior. Exemplo:
ERP1 somente enviará o ITEM se este estiver em uma das famílias cadastradas no parâmetro FAMILIA_INTEGRACAO.
Se o tipo de valorização do estoque for FIFO.
O pedido recebido no ERP1 vindo do ERP2 estará bloqueado para alteração.
Descreva os passos que viabilizem a integração.
Exemplo:
Os passos para viabilizar a integração são:
Descreva situações problemáticas comuns que podem ocorrer durante o funcionamento da integração e como solucioná-los. Neste ponto também é importante dar instruções de como reconhecer e investigar problemas que podem vir a ocorrer durante a integração. Se houver, apresente tabelas de códigos e descrições de erros que a integração poderá apresentar.
Este tópico possivelmente será alimentado com as experiências durante o desenvolvimento da integração e poderá ser realimentado durante o uso da integração no cliente.
Exemplo 1:
Tratamento de erros de integração (Produto A)
Erro | Mensagem | Solução |
Código do erro | Mensagem exibida | Ação a ser tomada para resolução do erro. |
Tratamento de erros de integração (Produto B)
Erro | Mensagem | Solução |
Código do erro | Mensagem exibida | Ação a ser tomada para resolução do erro. |
Exemplo 2:
Quando uma mensagem é enviada do Logix para o Protheus, podem ocorrer situações em que o WebService não estará totalmente funcional. Nestes casos uma mensagem de erro genérica irá aparecer na tela:
Exemplo:
Erro ao enviar a mensagem de Cidade via Integração
Se o arquivo de log for analisado, poderemos ver a falha na comunicação com o sistema destino:
-------------------------------------------------------------------------------
WSCERR044 / Não foi possível POST : URL http://172.16.31.57:8011/ws/FWWSEAI.apw
ADVPL WSDL Client 1.080707 / tst on 20120315 08:49:51
-------------------------------------------------------------------------------
Para resolver este problema, verifique as configurações do sistema de destino, analisando o funcionamento do servidor utilizado para esta comunicação e a habilitação do endereço do WebService.
Crie um check-list de verificação de alguns pontos importantes para o funcionamento e atendimento da integração.
Instalação/Configuração
Relacione itens de verificação para garantir que a integração está corretamente instalada e configurada. Isto não pode ser uma cópia do procedimento de instalação/configuração, mas verificações pontuais que podem remeter aos itens da instalação.
Checklist de Verificações:
Relacione itens de verificações para que o atendente possa: