Desenvolvendo utilizando Add-on Studio

No desenvolvimento de add-ons para o Sankhya Om, é essencial garantir que os dados sejam armazenados e manipulados de forma estruturada e eficiente. Para isso, o Add-on Studio oferece suporte a scripts de migração, um dicionário de dados bem definido, a configuração de parâmetros e exemplos práticos de código.

Dicionário de Dados

Para que o add-on siga as diretrizes do Dicionário de Dados, cada tabela, view ou script deve ser mapeado em arquivos XML, garantindo documentação e estruturação adequadas. Para isso os arquivos do Dicionário de Dados devem ser criados dentro do diretório datadictionary no projeto do add-on como no exemplo a seguir:

<?xml version="1.0" encoding="ISO-8859-1"?>
<metadados xmlns="../.gradle/metadados.xsd">
   <table name="" sequenceType="">
      <description></description>
      <primaryKey>
         <field/>
      </primaryKey>
      <fields>
         <field name="" dataType="">
            <description></description>
         </field>
      </fields>
   </table>
</metadados>

Criação de Scripts

Os scripts são responsáveis por criar, modificar e atualizar estruturas no banco de dados do Sankhya Om. Eles garantem que todas as alterações sejam aplicadas de forma controlada e buscando a compatibilidade com versões anteriores.

Boas práticas

✅ Evite modificar tabelas críticas/nativas diretamente, pois alterações inadequadas podem comprometer o desempenho e a estabilidade do sistema. Sempre valide os impactos antes de aplicar mudanças.

✅ Use prefixos exclusivos para tabelas e colunas do add-on, evitando conflitos com estruturas existentes no banco de dados do cliente e garantindo maior organização.

✅ Execute testes rigorosos antes de publicar um add-on com scripts de migração, assegurando que todas as alterações sejam aplicadas corretamente e sem efeitos colaterais.

✅ Mantenha um histórico detalhado de todas as alterações realizadas, permitindo que futuras atualizações sejam implementadas com segurança e previsibilidade.

✅ Garanta compatibilidade com diferentes bancos de dados, criando scripts específicos para Oracle e MSSQL, conforme necessário.

Parâmetros

Os parâmetros são valores configuráveis amplamente utilizados na Sankhya para ajustar o comportamento do sistema sem necessidade de alteração no código-fonte. Os parâmetros criados via Add-on, podem ser configurados através da tela Preferências no Sankhya OM.

O Gradle cria automaticamente a configuração de parâmetros necessária durante o processo de build. Para configurar seus parâmetros, basta acessar o arquivo de configuração conforme caminho:

*-model/src/main/resources/META-INF/parameters/parameter.xml

Assim, você pode adicionar e ajustar os parâmetros diretamente nesse arquivo para personalizar a configuração conforme necessário.

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE parameters >
<parameters group-name="mge.:name"
data-source="br.com.sankhya.modelcore.util.MGECoreParameter"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="../../../../../../.gradle/parameters.xsd">
  
  </parameters>

Exemplos de código

Neste projeto, você encontrará exemplos de como criar:

• SPBean: Similar a um endpoint do Spring Boot, um SPBean é um serviço que pode ser chamado via HTTP.
• Job: Uma rotina que será executada periodicamente.
• Listener: Um Listener escuta eventos (inserção, edição, exclusão) de uma entidade.

Cada classe contém dois tipos de documentação: uma que explica o que deve ser feito e outra que é obrigatória. A documentação também indica quais arquivos precisam ser editados, como service-providers.xml ou mgeschedule.xml. O caminho sempre começa com model ou vc, referindo-se ao nome do projeto. Por exemplo, "model" corresponde ao diretório addon-template-model.

🚧

Importante

Para fazer uma requisição HTTP ao serviço disponível no exemplo, é necessário realizar login, pois o serviço utiliza autenticação.