A criação de plugins no Cronapp é de forma high code no momento atual e , através da seleção de modelos, é possível criar plugins do tipo servidor, cliente e componente.

Novo plugin

Ao clicar no ícone novo (seta da Figura 1), será aberta a janela de criação de projeto. Para criar um plugin, selecione a opção plugin (1 da Figura 1) na aba high-code, devendo informar um nome para esse plugin  (2 da Figura 1) e selecionar uma fonte (destaque 3 da Figura 1). Ao clicar em finalizar, será aberta as janelas de configuração conforme o tipo da fonte selecionada.

Figura 1 - Criar plugin na IDE Cronapp

Projeto está sob controle de versão?

Se o projeto do tipo plugin já foi criado e está versionado, deve-se marcar esta opção para abrir a janela controle de versão (Figura 1.1) que importará o projeto.

Figura 1.1 - Janela de controle de versão

• Protocolo: seleciona o protocolo de controle de versão, nesse caso o GIT;
• URL do Repositório: informa a URI do repositório que contém o projeto do tipo plugin;
• Anônimo: ao marcar essa caixa, é possível importar projetos que estejam como públicos sem informar o usuário e a senha;
• Usuário: informa o usuário do serviço do protocolo, nesse caso o serviço GIT;
• Senha: informa a senha do serviço do protocolo, nesse caso o serviço GIT;
• Nome do autor: preenchido automaticamente com os dados cadastrados no Cronapp, é o nome que será informado ao realizar uma atualização no arquivo;
• Email do autor: preenchido automaticamente com os dados cadastrados no Cronapp, é o e-mail que será informado ao realizar uma atualização no arquivo;
• Branch: seleciona a branch desejada do projeto.

Baseado em modelo existente

Se o projeto é novo, deve-se marcar esta opção. Será aberta a janela de modelos (Figura 1.2) existentes na IDE para projetos do tipo plugin, podendo ser do tipo componente, cliente para bloco de programação e servidor para bloco de programação.

Figura 1.2 - Modelos da IDE para criar plugins

• Componente visual: modelo utilizado para criar plugins que servirão como componentes visuais, podendo ser tanto web quanto mobile;
• Plugin cliente para bloco de programação: modelo utilizado para criar plugins que serão utilizados nos blocos de programação do tipo cliente da IDE, podendo ser tanto web quanto mobile;
• Plugin servidor para bloco de pogramação: modelo utilizado para criar plugins que serão utilizados no bloco de programação do tipo servidor da IDE.

O projeto está em um arquivo ZIP?

Permite importar projetos do tipo plugin compactados. Será aberta uma janela para selecionar o arquivo no computador do usuário (Figura 1.3).

Figura 1.3 - Selecionar projeto compactado

Modelos da IDE

Existe três modelos para criar plugins que são componente visual, cliente para bloco de programação e servidor para bloco de programação e cada um desses modelos tem suas particularidades.

Plugin de componente visual

Ao selecionar o modelo componente visual, será direcionado para a janela de informe dos campos no qual deve ser informado um nome tanto para ID do componente quanto para o nome do componente (Figura 2.1.1).

Figura 2.1.1 - Campos para criar componente

Ao finalizar, a estrutura do projeto será mostrada na árvore de arquivos e é criada tanto para mobile quanto para web (Figura 2.1.2). Se o plugin vai ser somente web - basta somente excluir a pasta mobile (mobileapp) e vice versa.

Figura 2.1.2 - Estrutura do plugin do tipo componente visual

Por padrão, ambas as pastas apresentam os seguintes arquivos são criados:

• id_do_componente.template.html: é o arquivo usado para criar o template do componente, que é um HTML;
• id_do_componente.components.json: é o arquivo usado para definir as propriedades e eventos do componente, em um JSON;
• id_do_componente.js: é o arquivo usado para desenvolver a lógica do componente, em JavaScript.

Âncora
componente-template-html componente-template-html

Arquivo .template.html

O .template.html, seja ele web ou mobile, deve conter toda estrutura HTML do componente a ser criado (Figura 2.1.3). Ele precisa seguir a nomenclatura padrão: id_do_componente.template.html e também precisa estar contida na pasta que também vem por padrão (nesse caso, a pasta template).

Figura 2.1.3 - Arquivo .template.html

Arquivo .components.json

O .components.json, seja ele web ou mobile, deve conter todas as propriedades e eventos necessários para o componente a ser criado (Figura 2.1.4). Ele precisa seguir a nomenclatura padrão: id_do_componente.components.json e também precisa estar contida na pasta que também vem por padrão (nesse caso, a pasta components).

Figura 2.1.4 - Arquivo .components.json

Arquivo .js

O arquivo JavaScript, seja ele web ou mobile, onde deve conter toda a parte lógica para o componente a ser criado (Figura 2.1.5). Ele precisa seguir a nomenclatura padrão: id_do_componente.js e também precisa estar contida na pasta que também vem por padrão (nesse caso, a pasta js).

Figura 2.1.5 - Arquivo JavaScript do componente

Plugin para bloco cliente

Ao selecionar o modelo plugin cliente para bloco de programação, será direcionado para a janela de informe dos campos (Figura 2.2.1) no qual deve ser preenchido os seguintes campos:

• Nome do arquivo: campo para informar o nome do arquivo JavaScript a ser criado;
• Nome da função: campo para informar o nome da função do arquivo JavaScript a ser criado e que será exibido no bloco quando utilizar o plugin;
• Nome reduzido da função: campo para informar o nome reduzido da função do arquivo JavaScript;
• Descrição da função: campo para descrever a finalidade da função;
• Categoria: campo para criar a categoria em que esse bloco se encontrará quando o plugin for utilizado.

Figura 2.2.1 - Campos para criar bloco cliente

Ao finalizar, a estrutura do projeto será mostrada na árvore de arquivos e contém as pastas web e mobile com seus respectivos arquivos JavaScript como também contém os arquivos properties (Figura 2.2.2). Se o plugin vai ser somente para web - basta somente remover a pasta mobile (mobileapp) e vice versa.

Figura 2.2.2 - Estrutura do plugin do tipo bloco cliente

Arquivo cronapi.js

O arquivo JavaScript criado, tanto para web quanto para mobile, precisa seguir a nomenclatura padrão: nome_do_arquivo.cronapi.js e também precisa estar contida na pasta que também vem por padrão (a pasta cronapi). O código base do arquivo criado vem com alguns parâmetros (anotações) tidos como padrão e eles podem ser modificados a depender da necessidade, mas eles são essenciais para garantir a funcionalidade.

Figura 2.2.3 - Arquivo JavaScript

• @type: define o tipo da função, nesse caso function;
• @name: nome da função;
• @description: descrição sobre a funcionalidade da função;
• @multilayer: define se o componente criado estará disponível tanto no bloco cliente quanto no servidor (true) ou somente no bloco cliente (false);
• @param: define o tipo do parâmetro de entrada da função, podendo ser LIST, JSON, DOUBLE, DATETIME, DATASET, BOOLEAN, BLOCK ou class;
• @returns: define qual o tipo de retorno da função, podendo ser LIST, JSON, DOUBLE, DATETIME, DATASET, BOOLEAN, BLOCK ou class.

Plugin para bloco servidor

Ao selecionar o modelo plugin servidor para bloco de programação, será direcionado para a janela de informe dos campos (Figura 2.3.1) no qual deve ser preenchido os seguintes campos:

• ID do plugin:
• Nome da classe: campo para informar o nome da classe Java a ser criada;
• Nome da função: campo para informar o nome da função da classe Java a ser criada e que será exibida no bloco quando utilizar o plugin;
• Nome da função reduzida: campo para informar o nome reduzido da função da classe Java;
• Descrição da função: campo para descrever a finalidade da função;
• Categoria: campo para criar a categoria em que esse bloco se encontrará quando o plugin for utilizado.

Figura 2.3.1 - Campos para criar bloco servidor

Ao finalizar, a estrutura do projeto será mostrada na árvore de arquivos. Além da classe Java criada, a estrutura também apresenta o arquivo Maven (pom.xml) e os arquivos properties (Figura 2.3.2).

Figura 2.3.2 - Estrutura do plugin do tipo bloco servidor

Arquivo .java

O arquivo Java criado precisa seguir a nomenclatura padrão: nome_da_classe.java e também precisa estar contida na pasta que também vem por padrão (a pasta cronapi). O código base da classe vem com alguns parâmetros (anotações) tidos como padrão e eles devem estar incluidos pois garantem a funcionalidade, principalmente a anotação @CronapiMetaData que deve aparecer acima da classe e também acima de cada função (Figura 2.3.3) existente na classe.

Figura 2.2.3 - Arquivo Java

Arquivo pom.xml

É o arquivo XML que contém todas as configurações necessárias para que o Maven interaja corretamente com o projeto (Figura 2.2.4).

Figura 2.2.4 - Arquivo pom.xml

Arquivo template.properties

Qualquer seja o modelo escolhido, ele apresenta o arquivo template.properties que possui informações que podem ajudar no momento da instalação do plugin. O que conteúdo do arquivo pode variar conforme o modelo selecionado, como é o caso do modelo componente visual e plugin cliente para bloco de programação que apresentam informações das modificações que ocorrerão nas páginas index.html (web e/ou mobile) do projeto que o plugin for instalado.

Basicamente, esses modelos tem em seu conteúdo template.properties no arquivo ele informa o caminho dos arquivos do plugin (src) que serão incluidos no index.html, passando o caminho (resource) dele e eles devem seguir uma ordem (definida pela numeração) e são em pares - ou seja, para cada arquivo no plugin (src) tem que ter seu próprio meio específicado para o index (resource) do projeto que o plugin será instalado (Figura 2.4.1).

Figura 2.4.1 - Arquivo template.properties

Adicionando parâmetros

É também no arquivo properties que podem ser adicionados parâmetros (destaque da Figura 2.4.2) para que eles sejam exibidos no momento da instalação do plugin no projeto. Por exemplo, um parâmetro que pede a licença. Além de adicionar o parâmetro, é possível paginar e definir a página (ex: .page.1, .page.2.), o tipo do parâmetro (string, boolean, etc) e sua ordem (0, 1, 2).

Por exemplo: 

parameter.page.1.string.0.license=License

parameter.page.1.string.0.license.value=<type your license>

Figura 2.4.2 - Adicionando parâmetros

Arquivos dinâmicos (.ftl)

Caso os parâmetros sejam utilizados em arquivos, é preciso que eles sejam dinâmicos e, para isso, deve-se transformá-los em arquivos dinâmicos adicionando a extensão .ftl ao final da extensão original do arquivo - ou seja, se o arquivo que vai utilizar o parâmetro é um .txt então deve adicionara extensão .ftl após o .txt ficando então como .txt.ftl (Figura 2.4.3).

Figura 2.4.3 - Arquivo .txt dinâmico (.ftl)

Quando o plugin for instalado ao projeto, o arquivo não irá mostrar a extensão .ftl.

Arquivos de internacionalização

Por padrão, são criados dois arquivos de internacionalização para tanto os parâmetros inseridos no template.properties quanto para os parâmetros existentes nos blocos de programação, um em português (template_pt.properties) e outro em inglês (template_en.properties) (Figura 2.4.4), mas podem ser adicionados outros, desde que siga a nomenclatura: template_sigla_do_idioma.properties ou template_sigla_do_idioma_sigla_do_país.properties (especificando o país do idioma) - ou seja, caso seja adicionado um arquivo para internacionalização do idioma francês, ele poderia ser template_fr.properties ou template_fr_FR.properties (nesse caso, especificando que o francês é o da França).

Figura 2.4.4 - Arquivo de internacionalização para o idioma português