O Review da Solução é um processo de avaliação criado para as soluções e aplicativos que você desenvolve usando a plataforma TOTVS Fluig. Em resumo, é seu selo de garantia: Ele existe para assegurar a segurança, a qualidade e a conformidade de sua solução com os padrões técnicos e de uso da plataforma TOTVS Fluig.
Passar pelo Review da Solução é uma forma de gerar valor e confiança para você e para o cliente.
Seus objetivos principais são:
Valor para o cliente: Garantir que a sua Solução traga benefícios claros, realmente resolvendo problemas e melhorando os processos do cliente.
Inovação: Estimular você a explorar e usar ao máximo os recursos da plataforma TOTVS Fluig para criar soluções eficientes e inovadoras.
Reputação da marca: A qualidade da sua Solução reflete na reputação da TOTVS, fortalecendo a confiança na marca líder de mercado.
As Soluções que passam pelo processo do Review da Solução são mais do que um software simples. Elas devem oferecer uma experiência completa ao cliente, com três elementos essenciais:
Recursos prontos para uso: O software deve estar funcional e pronto para ser utilizado imediatamente pelo cliente.
Documentação clara: É fundamental que haja um material de apoio e uso bem detalhado e fácil de entender.
Canal de suporte: Deve haver um canal de atendimento dedicado para garantir o suporte adequado aos usuários.
O processo de avaliação do Review da Solução é para as soluções desenvolvidas que estão associadas à plataforma TOTVS Fluig. O processo de avaliação será ajustado de acordo com a natureza da sua Solução. O Review da Solução contempla as seguintes categorias:
| Categoria da Solução | Descrição | Observações |
|---|---|---|
| Solução Aplicativo | Aplicações robustas que rodam dentro do TOTVS Fluig, utilizando recursos nativos da plataforma (widgets, datasets, processos, layouts, formulários, APIs etc.). São instaladas no ambiente do cliente TOTVS Fluig. |
|
| Solução Flows | Soluções compostas por processos e formulários prontos, focadas em implantação rápida. Não são aplicativos completos, mas processos prontos para serem instalados e usados com configurações mínimas. |
|
| Solução Runner | É uma solução aplicativo, porém entregue em uma arquitetura SaaS hospedada na nuvem, comercializada como serviço. O cliente não precisa ter um ambiente TOTVS Fluig, pois o aplicativo utiliza o TOTVS Fluig apenas como motor (engine) nos bastidores. |
|
O Time de Ecossistemas é o responsável por realizar o Review da Solução do parceiro. Para sua referência, esta é a composição do time e os papéis que eles desempenham na avaliação. Esse time garantirá que sua Solução atenda aos critérios de Segurança e Qualidade.
| Nome | Papel no time | Função no Review da Solução |
|---|---|---|
| Processos Ágeis | Responsável por apoiar o processo de Review da Solução. |
| Líder de Processos | Responsável por apoiar o processo de Review da Solução. |
| Analista de Qualidade | Focado em assegurar a qualidade e a conformidade da sua Solução com os padrões. |
| Desenvolvedor | Responsável pela análise técnica e estrutural do código e da integração. |
| Desenvolvedor | Responsável pela análise técnica e estrutural do código e da integração. |
O Time de Ecossistemas está aqui para apoiar você durante o Review da Solução.
O seu ponto de contato para a parte de Qualidade do processo:
O seu ponto de contato para a parte de desenvolvimento que vai ajudar você a construir a Solução corretamente:
A seguir, veja os detalhes sobre o processo de avaliação da sua Solução.
Os requisitos do Review da Solução são as regras que garantem a Qualidade e a Segurança da sua Solução. Eles precisam ser incorporados desde o início do seu desenvolvimento.
É essencial que você observe a classificação de cada requisito para priorizar o que é obrigatório. Seguir essas regras e respeitar o prazo garantirá que sua Solução seja aprovada mais rapidamente.
Os requisitos do Review da Solução são divididos em categorias para cobrir todos os aspectos da sua Solução. O processo verifica desde a experiência do usuário até a segurança.
A tabela a seguir apresenta um resumo dos requisitos por categoria.
Para consultar a descrição completa de cada requisito, clique aqui. |
| Categoria | O que o Review da Solução avalia |
| Documentação de uso | Garante que a documentação (recursos, regras, instalação, pré-requisitos, etc.) seja completa, acessível e atualizada para o usuário final e administrador. |
| Desenvolvimento | Verifica se o código segue as boas práticas do TOTVS Fluig e evita variações técnicas, consultas diretas ao banco, bibliotecas desatualizadas, códigos duplicados e configurações fixas. |
| Segurança | Assegura que a Solução não exponha vulnerabilidades e que as informações sejam protegidas. Exige o uso de conexões seguras (SSL/TLS) em serviços externos. |
| Distribuição | Confirma se a Solução segue as diretrizes para ser empacotado e publicado. |
| Privacidade | Garante que a Solução tenha Termos de uso e Política de privacidade adequados à legislação, com transparência sobre a coleta e tratamento de dados. |
| Técnico | Garante que o parceiro envie o código-fonte completo e o artefato compilado devidamente. |
| Instalação | Verifica se a instalação é isenta de erros. O instalador deve executar todos os procedimentos (deploy, criação de registros, etc.) e validar permissões/pré-requisitos automaticamente. |
| Onboarding | Assegura que a Solução proporcione um Onboarding rápido e simples, sem exigir configurações manuais ou processos adicionais após a instalação. |
| Uso | Garante que a Solução funcione sem travamentos ou erros, oferecendo boa usabilidade, interface responsiva, mensagens claras e conteúdo sem erros gramaticais. |
| Processos | Garante que a Solução Flow esteja configurado corretamente, sem inconsistências. |
| Configuração | Garante que a Solução permita ao administrador controlar o acesso e a disponibilidade do app no ambiente. |
| QA | Garante que o parceiro forneça uma licença válida para testes, caso a Solução possua licenciamento adicional, para validação completa. |
Nem todos os requisitos têm o mesmo peso! É crucial que você, parceiro, entenda a diferença para garantir a aprovação:
Requisito obrigatório: Se a sua Solução não atender a este requisito, ela não será aprovada.
Requisito recomendado: Atender a este requisito não impede a aprovação, mas é considerado uma boa prática e pode ser exigido em futuras versões da sua Solução.
Todos os requisitos são mapeados por um código (ex: QA-101, QA-203) e estão definidos na planilha oficial do processo. |
Antes de enviar sua solução para o Review da Solução, é essencial validar se ela está totalmente alinhada aos requisitos. Certifique-se de que todos os critérios obrigatórios foram atendidos e que a solução está tecnicamente adequada. Além de cumprir todos os requisitos do Review, recomenda-se seguir também as boas práticas descritas abaixo, garantindo maior qualidade, organização e assertividade no processo de aprovação.
Adequação Técnica e Clean Code
Respeite o padrão: Mantenha a estrutura do TOTVS Fluig padrão com pastas pré-definidas (css, js, images) para Widgets, Layouts e outros componentes.
Limpeza: Antes de submeter para o Review da Solução, remova qualquer arquivo que não esteja sendo utilizado no componente (arquivos de teste, backups, etc.).
Registro: Todas as bibliotecas JavaScript externas devem ser referenciadas no arquivo application.info.
Evite redundância: O TOTVS Fluig já carrega nativamente bibliotecas como jQuery, jQuery UI e o Fluig Style Guide. Não as adicione novamente ao seu projeto para evitar conflitos e peso desnecessário.
Licenciamento: Implemente a verificação de licença utilizando a API de Licença oficial.
Componente adaptado para a Store
Para a Store no TOTVS Fluig, padronizamos a estrutura que o componente deve ser desenvolvido, cujo objetivo também é acelerar o processo de de review da solução, O componente deve seguir os padrões demonstrados no exemplo Sample Component, atendendo aos requisitos abaixo:
Artefato Final: O arquivo a ser submetido deve, obrigatoriamente, ter a extensão .ear.
Geração do Pacote: Utilize o pacote pack (disponível na estrutura do projeto) para compilar e gerar o arquivo .ear corretamente.
Anderson Henrique da Costa Simões 
Paula Ferreira Lopes
Leonardo David Galleas Levandoski
Luís Felipe de Andrade Rossi
William Cano Bizoncomponent.xml)Arquivo mandatório: A presença do arquivo component.xml é essencial para o reconhecimento do componente.
Código único (component code): Este campo define a identidade da sua solução. Ele deve ser exclusivo em toda a Store (global). Certifique-se de que o código escolhido não entra em conflito com nenhuma outra solução já existente.
Página dedicada: Utilize o arquivo pages.xml para configurar uma página exclusiva para sua solução dentro do TOTVS Fluig.
Identidade visual: Inclua um ícone personalizado. Isso profissionaliza a entrega e facilita a identificação do app pelo usuário final.
Para garantir o sucesso e a agilidade na aprovação da sua solução, recomendamos a adoção das seguintes práticas de qualidade e gestão.
Roteiro de testes: Não teste de forma aleatória. Elabore e formalize um roteiro de testes que cubra as principais funcionalidades.
Evite o "Viés de Desenvolvimento": Desenvolvedores tendem a seguir o "caminho feliz" (o fluxo que sabem que funciona). Peça para uma pessoa externa ao desenvolvimento realizar os testes para identificar falhas não previstas.
Testes Fim-a-Fim (E2E): Valide todo o ciclo da jornada do usuário, desde a ação inicial até a conclusão do processo. Repita esse ciclo sempre que houver alterações no código.
Instalação limpa (Clean Install): Efetue a instalação da solução em um ambiente TOTVS Fluig "zerado" (sem configurações prévias). Isso garante que sua solução não dependa de arquivos ou configurações residuais da sua máquina de desenvolvimento.
Feedback contínuo (Metodologia Ágil): Caso utilize Sprints, agende demonstrações com o time de Ecossistemas ao final de cada ciclo. Apresentar a evolução, mesmo que parcial, permite receber sugestões antecipadas e evitar retrabalho.
Revisão de código (Code Review): Se utilizar controle de versão (como Git), adote o fluxo de Pull Requests. Permitir que outro desenvolvedor avalie o código antes da integração reduz drasticamente a incidência de bugs e erros lógicos.
Após finalizar sua solução e seguir as boas práticas citadas acima, ela passará pelas etapas descritas a seguir, que compõem o processo oficial de avaliação - Review da Solução. Cada etapa foi estruturada para garantir qualidade, segurança e conformidade com os padrões da plataforma TOTVS Fluig.
| Etapa | Descrição das etapas | Objetivo |
| 1. Envio da Solução | Parceiro: Realiza o envio da solução completa, incluindo todos os artefatos necessários e a documentação técnica obrigatória. Conforme orientações em Enviando sua solução para Review. | Iniciar oficialmente o processo de avaliação do Review da Solução. |
| 2. Validação técnica | Time Ecossistemas: Realiza os testes do Review da Solução, executando uma validação técnica completa, composta por verificações automáticas e manuais, focadas nos requisitos e na segurança e qualidade. Durante esse processo, é possível acompanhar o status e o progresso da validação. | Garantir que a solução atenda plenamente aos requisitos técnicos e de segurança antes de ser aprovada. |
| 3. Registro do relatório | Time Ecossistemas: Elabora e envia o relatório | Elaborar o relatório de avaliação, detalhando todos os itens identificados durante os testes da solução. |
| 4. Feedback ao Parceiro | Parceiro: Recebe o relatório no Portal do Parceiro, contendo o resultado final da avaliação e todas as recomendações necessárias. | Saber o resultado final (se a sua solução foi aprovada ou não) e receber o feedback necessário para correção, se for o caso. |