Histórico da Página
| Índice |
|---|
O que é o Review da Solução?
...
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, ele é seu selo de garantia: Ele existe paraassegurar 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.
Por que o Review da Solução é importante para o
...
parceiro?
...
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:
- Ecossistema
...
- confiável: Construir um ambiente de soluções seguras, onde os clientes se sintam à vontade para adotar
...
- a sua solução com total confiança.
Valor para o Clientecliente: 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 Marcamarca: A qualidade da sua solução reflete na reputação da TOTVS, fortalecendo a confiança na marca líder de mercado.
O que define uma
...
solução completa?
...
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 prontos para Usouso: O software A solução deve estar funcional e pronto para ser utilizado imediatamente pelo cliente.
Documentação Claraclara: É fundamental que haja um material de apoio e uso bem detalhado e fácil de entender.
Canal de Suportesuporte: Deve haver um canal de atendimento dedicado para garantir o suporte adequado aos usuários.
...
A qual parceiro o Review da Solução se aplica?
...
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 |
Soluções que utilizam diretamente a infraestrutura e os recursos nativos do TOTVS Fluig.
Elas são construídas para rodar dentro do ambiente Fluig, acessando funcionalidades como a criação de widgets.
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 |
Soluções que usam a infraestrutura do TOTVS Fluig como base, mas atuam como uma plataforma white label (com marca própria ou identidade visual diferente). Elas rodam dentro do ambiente Fluig e se conectam à plataforma.
...
É 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. |
|
Time de Ecossistemas: Review da Solução
...
Anderson Henrique da Costa Simões
...
O Time time de Ecossistemas é o responsável por realizar o pelo 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 Durante a avaliação, esse time garantirá que sua solução atenda aos a todos os critérios estabelecidos de Segurança e Qualidade.
...
.
...
Paula Ferreira Lopes
...
Leonardo David Galleas Levandoski
...
Luís Felipe de Andrade Rossi
...
William Cano Bizon
...
Time de Ecossistemas:
...
quem contatar para
...
ajudar
...
O Time time de Ecossistemas está aqui para apoiar você durante o Review da Solução.
Suporte ao Processo
...
O seu ponto de contato para a parte de Qualidade do processo:
de Review da Solução
...
Para questões específicas sobre o Review de Solução, oferecemos suporte nos seguintes pilares:
Orientação de Processo: O
Analista de Qualidade: Leonardo David Galleas LevandoskiGuia no Processo: Orientação sobre o processo de Review da Solução e oque esperar em cada fase do Review da Solução.
Caminho da Entrega:
Garante que você saibaSuporte sobre onde e como submeter sua solução no
portal de parceirosPortal.
- Materiais de Apoio: É responsável por criar as documentações técnicas que ajudam no seu desenvolvimento.
Suporte Técnico e Código
O seu ponto de contato são a parte de desenvolvimento que vão ajudar você a construir a solução corretamente:
- Desenvolvedores: Luís Felipe de Andrade Rossi e William Cano Bizon
- Dúvidas de Código: Eles fornecem os requisitos e esclarecem todas as suas dúvidas técnicas enquanto você estiver desenvolvendo.
- Validação Técnica: São os responsáveis por validar tecnicamente se a sua solução atende a todos os requisitos fundamentais.
Entendendo os Requisitos e o Processo de Avaliação
Documentação: Disponibilização de materiais técnicos e manuais de apoio.
Dúvidas de Código: Esclarecimento de requisitos e suporte técnico durante o desenvolvimento.
Validação Técnica: Avaliação final para garantir que a solução atenda a todos os requisitos fundamentais do ecossistema.
Canais de atendimento
...
Para interagir com nosso time, utilize os canais abaixo:
Portal do Parceiro: A comunicação principal ocorre diretamente pelo Portal de parceiros a ferramenta de submissão.
Chat Exclusivo: Utilize o grupo de chat criado pela TOTVS no Google Chat para interações rápidas.
E-mail de Apoio: [email protected].
| Dica | ||
|---|---|---|
| ||
Ao enviar um e-mail, sempre coloque no assunto o nome da sua empresa e o motivo (ex: "Dúvida Técnica - [Nome da sua Empresa] - [Nome da sua Solução]" ou "Solicitação de Acesso - [Nome da sua Empresa]") para agilizar o atendimento. |
Entendendo os requisitos e o processo de avaliação
...
A seguir, veja os detalhes sobre o processo de avaliação da sua solução.
Por que existem os requisitos
...
?
...
Os requisitos do Review da Solução são as regras que garantem a Qualidade e a Segurança da sua soluçãoSoluçã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.
Tipos de
...
requisitos:
...
o que o Review da Solução
...
avalia
...
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.
| Informações | ||
|---|---|---|
| ||
Para consultar a descrição completa de cada requisito, Clique clique aqui. |
| Categoria | O que o Review da Solução Avaliaavalia | Exemplo de Verificação |
| Documentação de Usouso | 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. | Confirma se o manual descreve a matriz de compatibilidade (navegadores, idiomas) e canais de suporte. |
| 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.Analisa o uso adequado de SuperWidget, datasets e APIs públicas, garantindo a codificação UTF-8 e a rastreabilidade em logs. | |
| 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. | Testes para garantir que não haja falhas que permitam acesso indevido (como recuperação de dados de autenticação ou execução de serviços sem autenticação). |
| Distribuição | Confirma se a solução segue as diretrizes para ser empacotado e publicado.Verifica o uso adequado de nome e marca (sem referências à TOTVS/Fluig), compatibilidade com releases suportadas e a presença de imagens/descrições completas na Store. | |
| Privacidade | Garante que a solução tenha Termos de Uso uso e Política de Privacidade privacidade adequados à legislação, com transparência sobre a coleta e tratamento de dados. | Verifica a clareza sobre o uso de serviços externos e assegura a conformidade legal para o usuário. |
| Técnico | Garante que o parceiro envie o código-fonte completo e o artefato compilado devidamente.Confirma a presença dos arquivos necessários para que o Review da Solução possa rodar o processo de validação. | |
| 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.Tenta instalar a solução no ambiente de teste e confere se todas as etapas (criação de registros, arquivos) foram concluídas com sucesso. | |
| 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.Verifica se a solução está pronta para uso imediato após o processo de instalação, sem depender de ajustes técnicos manuais. | |
| Uso | Garante que a solução funcione sem travamentos ou erros, oferecendo boa usabilidade, interface responsiva, mensagens claras e conteúdo sem erros gramaticais.Verifica a facilidade de configuração, feedback das ações, orientação de campos obrigatórios e o alinhamento do padrão visual do TOTVS Fluig. | |
| Processos | Garante que a solução Flow Flows esteja configurado corretamente, sem inconsistências.Confirma se a Central de Diagnóstico não exibe erros ou alertas relacionados a nenhuma solução Flow. | |
| Configuração | Garante que a solução permita ao administrador controlar o acesso e a disponibilidade do app no ambiente.Verifica se a solução permite definir quais usuários ou grupos podem utilizá-lo, seguindo as regras de permissões do TOTVS Fluig. | |
| 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. | Confirma a validade e funcionalidade da licença fornecida para que o time de Ecossistemas possa testar todas as funcionalidades. |
Classificação dos
...
requisitos (
...
obrigatório x
...
recomendado)
...
Nem todos os requisitos têm o mesmo peso! É crucial que você, parceiro, entenda a diferença para garantir a aprovação:
Requisito Obrigatórioobrigatório: Se a sua solução não atender a este requisito, ela não será aprovadoaprovada.
Requisito Recomendadorecomendado: 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.
| Informações | ||
|---|---|---|
| ||
Todos os requisitos são mapeados por um código (ex: QA-101, QA-203) e estão definidos na planilha oficial do processo. |
Boas práticas antes do envio para o Review da Solução
...
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
...
- Organização e estrutura
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.).
- Gerenciamento de dependências
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.
- Diretrizes técnicas
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 Review da Solução, O componente deve seguir os padrões demonstrados no exemplo (sample component), atendendo aos requisitos abaixo:
| Aviso | ||
|---|---|---|
| ||
Este exemplo sample-component é destinado a Solução Aplicativo. Como os requisitos de desenvolvimento podem variar, oferecemos apoio para ajustar os critérios às necessidades específicas da sua solução. |
- Estrutura e empacotamento
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.earcorretamente.
- Identificação da solução (
component.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.
- Apresentação e experiência
Página dedicada: Utilize o arquivo
pages.xmlpara 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.
Boas práticas gerais
...
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.
- Estratégia de testes e QA
Roteiro de testes: Não teste de forma aleatória. Elabore e formalize um roteiro de testes que cubra os principais recursos.
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.
...
- Validação de ambiente
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.
- Processos e colaboração
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.
Processo de avaliação
...
Após finalizar sua solução e seguir as boas práticas citadas acima, ela passará por estas etapas de avaliação: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. |