O uso dos Add-ons por clientes Sankhya são controladas a partir de licenças que devem ser criadas e vinculadas aos Add-ons no momento de sua geração.

A licença garante somente que clientes autorizados pelo autor do Add-on consigam utilizá-lo. A jornada de criação da licença será demonstrada a seguir, incluindo a geração automática da App Key, que é a chave de identificação do add-on e sua autoria.

Requisitos

• Possuir um cadastro de parceiro ativo junto à matriz da Sankhya;
• Possuir um usuário vinculado ao parceiro acima;
• Possuir permissão de acesso na tela “Cadastro Licença de Addons”;
• Caso não possua acesso ao SankhyaOM, preencha o formulário disponível em Sankhya - Parceiros, para solicitar a sua avaliação de parceiro e cadastro.

Clique nas imagens e gifs mencionados no processo para visualizá-los com mais clareza.

Instrução passo a passo

1. Acessar a tela “Cadastro Licença de Add-ons”, incluir um novo registro e preencher os dados solicitados.

A tabela abaixo detalha os campos apresentados no gif.

2. Salvar o registro, então o código da licença será gerado e apresentado no campo de mesmo nome.

❗️

Atenção

É possível visualizar apenas os registros de licença cujos códigos do parceiro responsável são correspondentes, ou seja, iguais, ao usuário logado na tela pertencente.

Uma vez criado o código da licença e a App Key, o usuário pode seguir para o processo de geração do Add-on., explicado a seguir:

Gerando Add-ons

O Add-on é gerado com a ferramenta Sankhya Extension Tool. Ao executar a ferramenta é necessário informar qual o diretório do Add-on na pasta BuidExts.

Faça o download da ferramenta Sankhya Extension Tool no botão a seguir:

❗️

Uso da Appkey

É um código utilizado para identificar o parceiro responsável pela
extensão, bem como a própria extensão. Toda extensão deve ter sua appkey
única criada e informada para que seja possível gerar o arquivo .exts. A
appkey é gerada mediante solicitação através do formulário disponível neste
link.

Observação importante: Se os arquivos não foram extraídos no diretório recomendado C:/sk-java, altere o local nas configurações do workspace. Navegue até "diretorio/workspace”, diretório onde os arquivos foram extraídos, abra o arquivo mainconf e altere as tags defaultJbossPath, buildDir, exportDir, indicando o diretório correto.

<defaultJbossPath>C:\sk-java\AS\jboss-4.0.5.GA\server\default</defaultJbossPath>
<buildDir>C:\sk-jav\wks_sample</buildDir>
<exportDir>C:\sk-java\SkWExtensionTool</exportDir>

Tela Inicial

Tela onde se faz a seleção do Workspace/Add-on para ser utilizado(a).

É possível ainda pular esta etapa e utilizar um Add-on como padrão. Basta marcar a opção Usar este Workspace como padrão e não me perguntar mais.

Tela Configurações

A tela Configurações contém os seguintes campos:

• Workspace: Campo para informar o workspace em que se encontra o Add-on. Esse campo já é preenchido após a escolha do workspace na primeira tela do Sankhya-W Extension Tool.
• JBoss Default: Campo onde deverá ser informado a pasta default do servidor de aplicação.
• Export Dir.: Campo para informar a pasta do Sankhya-W Extension Tool para onde o Add-on será exportado.

Os campos referentes a Base de Dados de Desenvolvimento são preenchidos de acordo com a base de dados utilizada.

Tela DataSource

Conforme os padrões do framework Sankhya, as conexões com o banco são obtidas através das informações de um data source. O Sistema busca pelo data source definido no arquivo “mge-ds.xml”. Na tela é DataSource é possível criar, gerenciar dados de conexão com a base e efetuar o deploy do “mge-ds.xml”. Isto é útil quando há bases diferentes, por exemplo, desenvolvimento, teste, homologação.

Tela Scripts

Modo Grid

Modo Formulário

A grande maioria dos Add-ons precisarão definir objetos próprios de banco de dados (tabelas, colunas, constraints, etc.) e os scritps para criação destes objetos poderão ser definidos nesta seção.

No modo Grid é possível visualizar os scripts cadastrados e editar a ordem conforme definido pela coluna "ordem”. Esta ordenação define a sequência em que os scripts serão executados no momento da instalação do Add-on. Já a edição do script é feita apenas no modo Formulário . Ao clicar no botão para criar um novo script ou dar um duplo clique em uma linha do grid, a tela mudará para o modo formulário. Há também um botão para alternar entre os dois modos.

O cadastro de um script consiste no preenchimento de 3 campos obrigatórios:

• nome
• tabela
• instrução SQL
• observação (campo opcional)

O campo de texto para digitar a instrução sql possui duas abas, possibilitando a instrução adequada para Oracle e MS SQL Server. Pelo menos uma das instruções é obrigatória, se a instrução MS SQL Server for omitida ao exportar o Add-on, o arquivo mssqlserver.sql será gerado sem este script.

As chaves de um script são o nome e a tabela por isso não é permitido cadastrar dois objetos com o mesmo nome para a mesma tabela, se isso acontecer o registro será sobrescrito (não se preocupe você será avisado). É possível determinar uma condição de execução para o script, isto é feito através do combo Executar, cujo os valores são:

• Se existir: o script será executado se o objeto existir.
• Se não existir: o script será executado se o objeto não existir
• Sempre: o script será executado sempre.

A existência do script é considerada pelas informações nome, tabela e tipo que são utilizadas para a busca no metadados do banco de dados. Caso o tipo de objeto seja uma tabela, o campo nome e o campo tabela deverão ter o mesmo valor.

No exemplo abaixo o script será executado apenas se a tabela "TPROCESSO” não tiver a coluna "DESCRICAO”.

Tela UI Mashups

A nova versão do Sankhya-W Extension Tool permite a inserção de Mashups nos Add-ons

É necessário preencher os campos URL do Mashup e Descrição do Mashup

Tela Exportação

A tela Exportação possui campos que serão utilizados para a criação do descritor do Add-on (arquivo extension.xml que é empacotado no arquivo do Add-on). A tabela, após a imagem abaixo, detalha os campos utilizados.

Para o campo Módulo Padrão, caso haja necessidade de uma restrição de licença mais específica para algum controle, clique sobre o botão +, insira o identificador do controle e o código de licença necessário para que este item de menu seja exibido. É possível ainda determinar um opcional na lista à direita do grid de identificadores.

Serão exportados os itens de licença apenas que possuírem módulo ou opcional. Caso exista apenas opcional será utilizado o módulo padrão. Como identificador, deve ser utilizado o código de registro gerado conforme a tela Cadastro Licença de Addon, conforme destacado na imagem abaixo:

Finalmente após as configurações serem feitas já é possível gerar o Add-on clicando no botão Gerar Add-on e o arquivo .exts será criado na pasta do Sankhya-W Extension Tool.

❗️

Atenção

1. Caso necessário, realize a atualização de versão do seu SKW Extension Tools para realizar a geração de Add-ons no formato .exts. Os Add-ons no formato .ext não são instaláveis em ambientes de clientes que possuem data de início de contrato maior que março de 2023.
2. Se atente ao informar a App Key, a mesma será validada no momento em que um cliente adquirir e realizar a instalação do seu Add-on.
3. App Keys inválidas ou inativas acarretaram na não instalação de Add-ons

Como tirar dúvidas?

Para tirar dúvidas e compartilhar informações, use a sala Extension Tools da comunidade Sankhya Developer.