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 Ele existe paraassegurar a segurança, a qualidade e a conformidade de sua Solução 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 Construir um ambiente de soluções seguras, onde os clientes se sintam à vontade para adotar a sua Solução solução com total confiança.

• Valor para o cliente: garantir Garantir que a sua Solução solução traga benefícios claros, realmente resolvendo problemas e melhorando os processos do cliente.

• Inovação: estimular 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 A qualidade da sua Solução 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 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 A solução 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 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çãosolução. O Review da Solução contempla as seguintes categorias:

...

Time de Ecossistemas: Review da Solução

...

...

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 solução atenda aos a todos os critérios estabelecidos de Segurança e Qualidade.

...

...

...

...

...

.

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

...

O  seu ponto de contato para a parte de Qualidade do processo:

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 o

  que esperar em cada fase do Review da Solução.

• Caminho da

  entrega: garante que você saiba

  Entrega: Suporte sobre onde e como submeter sua

  Solução no portal de parceiros.
• 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 para a parte de desenvolvimento que vai ajudar você a construir a Solução corretamente:

...

• solução no Portal.

• 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].

...

Entendendo os requisitos e o processo de avaliação

...

A seguir, veja os detalhes sobre o processo de avaliação da sua Soluçãosoluçã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çã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 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çãosolução. O processo verifica desde a experiência do usuário até a segurança.

...

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ório: se Se a sua Solução solução não atender a este requisito, ela não será aprovada.

• Requisito recomendado: atender 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çãosolução.

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

  • Internacionalização (i18n): Todos os textos visíveis (títulos, labels, avisos) devem utilizar chaves de tradução, e não texto fixo no código.

  • 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: 

• 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 .ear corretamente.

• 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.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.

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çãosoluçã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.