Configurações do Add-on Studio

O Add-on Studio é a ferramenta ideal para os desenvolvedores que desejam criar, configurar e publicar add-ons no ecossistema Sankhya de forma prática e eficiente. Este artigo apresenta ajustes que devem ser realizado nos arquivos settings.gradle e build.gradle, e como realizar gestão de dependências e boas práticas para a construção de um add-on funcional e otimizado.

Para um passo a passo detalhado sobre como configurar seu ambiente de desenvolvimento e iniciar o projeto do Add-on Studio, consulte a documentação disponível aqui.

Configurar os arquivos settings.gradle e build.gradle

Ao desenvolver um add-on no Add-on Studio, é essencial ajustar alguns arquivos de configuração para garantir que o projeto seja reconhecido corretamente pelo Gradle e esteja compatível com o ambiente Sankhya.

• settings.gradle: Esse arquivo define o nome do projeto e os módulos que ele contém. Sem essa configuração, o Gradle não conseguirá estruturar corretamente os componentes do add-on, o que pode gerar erros durante a compilação e execução no ambiente local e do cliente, para configurar o nome do projeto e os módulos, altere os valores conforme o exemplo abaixo:

> rootProject.name = 'addonexemplo'  
> include 'addonexemplo-model'  
> include 'addonexemplo-vc'

Na sequência renomeie as patas "model" e "vc" para o nome do projeto, conforme definido no arquivo settings.gradle.

addon-template-model -> addonexemplo-model  
addon-template-vc -> addonexemplo-vc

---

• build.gradle: Responsável por definir as principais configurações do build, incluindo:

- Identificação do projeto (group): Seguir um padrão de nomenclatura evita conflitos e facilita a organização dos pacotes. Por convenção utiliza-se o seu domínio ao contrário seguido do nome da aplicação, conforme exemplo abaixo:

 - group = 'br.com.fabricante.addonexemplo'

- snkmodule: Para configurar o snkmodule siga o exemplo abaixo:

snkmodule  {
   serverFolder = '${wildfly.home}' // /home/user/wildfly/
   plataformaMinima = "4.28"
}

Pasta do servidor (serverFolder): Definir corretamente essa variável evita problemas de compatibilidade entre diferentes sistemas operacionais.

Versão mínima do Sankhya Om (plataformaMinima): Assegura que o add-on será compatível com a versão adequada do sistema.

- Configurações do addon (addon): Nessa estrutura é onde conseguiremos identificar a referencia do add-on na área do desenvolvedor para isso utilizamos a AppKey e nome do parceiro para declarar esses itens siga o modelo a seguir:

addon {
    appKey="sua_appkey"
    parceiroNome ="seu_nome_de_parceiro"
}

Gestão de dependências.

O gradle já inclui as seguintes dependências por padrão:

Para utilizar novas dependências fornecidas pelo Sankhya Om, use a diretiva implementation. Para adicionar novas bibliotecas ao add-on, use a diretiva moduleLib. O Gradle importa bibliotecas de forma hierárquica, conforme especificado no POM ou no módulo. Revise as bibliotecas para manter o addon o mais enxuto possível. As dependências e bibliotecas podem ser alteradas no arquivo build.gradle dentro dos módulos "model" e "vc" do projeto.

dependencies{  
   //Sistema irá remover essa dependencia do SkOm e incluir ela no addon, dessa forma pode-se usar uma versão diferente da do monolito  
    moduleLib('br.com.sankhya:skw-environment:1.8.2')

   //Não será adicionado no addon e usará a lib do monolito  
    implementation('br.com.sankhya:bsh-1.3.0:master')  
}