SankhyaJX

Descrição

A classe JX é uma coleção de métodos estáticos para facilitar a manipulação de requisições HTTP, manipulação de dados de banco de dados, interação com páginas web e gerenciamento de parâmetros e cookies em aplicações web. Ela oferece funcionalidades como realizar requisições POST e GET, consultar dados de banco, salvar e deletar registros, manipular elementos de páginas web, entre outras.

---

Instalação

A instalação pode ser feita baixando o arquivo jx.js (Homologação e Debug) ou jx.min.js (Produção) e importando-o no seu projeto. Por exemplo:

<script src="jx.js"></script> <!-- Homologação e Debug -->
<script src="jx.min.js"></script> <!-- Produção -->

Contudo, a forma mais prática é pegar a ultima versão atualizada do arquivo direto do repositorio do GitHub, usando o cdn do jsDelivr. Obs.: A atualização do cache do CDN da jsDelivr pode demorar até 24 horas, ou seja, implementações recentes podem não estar disponíveis imediatamente.

<script src="https://cdn.jsdelivr.net/gh/wansleynery/SankhyaJX@main/jx.js"></script>
<script src="https://cdn.jsdelivr.net/gh/wansleynery/SankhyaJX@main/jx.min.js"></script>

---

Uso e Exemplos

Banco de Dados

• consultar(query): Realiza consultas SQL. Retorna uma promessa com os resultados da consulta.

/* Consulta ao banco com resposta formatada em JS */
JX.consultar ('SELECT * FROM TGFMAR').then (console.log);

• salvar(dados, instancia, chavesPrimarias): Salva registros no banco com a service auxiliar (CRUDServiceProvider.saveRecord). Aceita um objeto com os dados, o nome da tabela e as chaves primárias.

/* Criar multiplos NOVOS registros (deixar as chaves primarias vazias) */
JX.salvar ({ DESCRICAO: 'Qualquer Marca' }, 'MarcaProduto', [{}, {}, {}]).then (console.log);

/* Atualizar multiplos registros (informar as chaves primarias de cada registro) */
/* Repare que, intencionalmente, estou forcando o erro em apenas um dos salvamentos, */
/* mas por nao ser blocante, ele continuara realizando os outros salvamentos com sucesso */
JX.salvar ({ DESCRICAO: 'Outro produto' }, 'MarcaProduto', [{ CODIGO: 'asd' }, { CODIGO: 9998 }, { CODIGO: 9999 }]).then (console.log);

• novoSalvar(dados, instancia, chavesPrimarias): (BETA) Salva registros no banco com a service oficial das telas nativas (DatasetSP.save). Aceita um objeto com os dados, o nome da tabela e as chaves primárias.

/* Criar multiplos NOVOS registros (deixar as chaves primarias vazias) */
JX.salvar ({ DESCRICAO: 'Qualquer Marca' }, 'MarcaProduto').then (console.log);

/* Atualizar multiplos registros (informar as chaves primarias de cada registro) */
/* Repare que, intencionalmente, estou forcando o erro em apenas um dos salvamentos, */
/* mas por nao ser blocante, ele continuara realizando os outros salvamentos com sucesso */
JX.salvar ({ DESCRICAO: 'Outro produto' }, 'MarcaProduto', { CODIGO: 'asd', OUTRA_PK: 9999 }).then (console.log);

• deletar(instancia, chavesPrimarias): Deleta registros. Requer o nome da tabela e as chaves primárias dos registros a serem excluídos.

/* Apaga multiplos registros (informar as chaves primarias de cada registro) */
/* O primeiro registro nao existe (PK 9997), o que gerarara um erro nessa requisicao */
/* mas por nao ser blocante, ele continuara realizando as outras delecoes com sucesso */
JX.deletar ('MarcaProduto', [{ CODIGO: 9997 }, { CODIGO: 9998 }, { CODIGO: 9999 }]).then (console.log);

Manipulação de Página

• acionarBotao(parametros, configuracoes): Aciona botões de ação remotamente. Parâmetros incluem os dados do botão e as configurações como tipo e ID.

JX.acionarBotao (
    {
        PARAMETRO_A: 'Valor',
        Parametro_B: 'false',    // Enviar valores booleanos como string
        pARameTRo_c: 2           // Validar o nome do parametro a ser recebido
    },
    {
        tipo         : 'JS',         // Tipo do botao de acao (JS, JAVA e SQL)
        idBotao      : 30,           // ID do botao de acao (JS, JAVA e SQL)
        entidade     : 'TELA_TAL',   // Nome da Entidade que possui o botao de acao (apenas SQL)
        nomeProcedure: 'AD_PROC_TAL' // Nome da Procedure a ser executada (apenas SQL)
    }
).then (console.log);

• removerFrame(configuracoes): Remove o frame de uma página de BI. Configurações incluem a instância e a página inicial.

JX.removerFrame ({ instancia: 'TELA_HTML5', paginaInicial: 'paginas/entidade/index.jsp' });

• novaGuia(forcado): Abre a página atual em uma nova aba. Opcionalmente, pode forçar a abertura da nova aba mesmo em contextos restritos.

JX.novaGuia ();

• abrirPagina(resourceID, chavesPrimarias): Abre uma página específica dentro do sistema, usando o ID do recurso e as chaves primárias para localização.

JX.abrirPagina ('br.com.sankhya.core.cad.marcas', { CODIGO: 999 });

• fecharPagina(): Fecha a página atual. Útil em contextos onde a página está integrada a um sistema maior.

JX.fecharPagina ();

Retorno de Valores

• getUrl(path): Retorna a URL atual da página, permitindo adicionar um caminho específico se necessário.

/* Busca a URL origem (URL base) do local atual */
console.log (JX.getUrl ())                                      // http://localhost/mge
console.log (JX.getUrl ('js/dashboardGrid/dashboardGrid.css')); // http://localhost/mge/js/dashboardGrid/dashboardGrid.css

• getCookie(nome): Retorna o valor de um cookie especificado pelo nome.

/* Busca do conteudo de um cookie */
let valorCookie = JX.getCookie ('nomeCookie');
console.log (valorCookie);

• getArquivo(caminhoArquivo): Busca o conteúdo de um arquivo localizado no caminho especificado.

/* Busca do conteudo de arquivos internos */
JX.getArquivo ('/caminho/do/arquivo.txt')
   .then (conteudo => console.log (conteudo))
   .catch (erro => console.error (erro));

• getParametro(nomesParametros): Retorna valores de parâmetros específicos, baseados em seus nomes ou chaves.

// {PERCSTCAT137SP: 90, mgearmazem.gerar.nf.impureza.codImpureza: 0, BASESNKPADRAO: 'IkRBVEFDUklBQ0FPOjA0LzA1LzIwMjMuQkFTRTpQQURSQU8uQkFOQ086T1JBQ0xFIg==', ASD: null}
JX.getParametro (['PERCSTCAT137SP', 'mgearmazem.gerar.nf.impureza.codImpureza', 'BASESNKPADRAO', 'ASD']).then (console.log);

// {123: null}
JX.getParametro ('123').then (console.log);

// {BALANCASP2600R: false, BL-SBR140-RS232: false, BALANCASATURNO: false, MODELOCPASEMENT: 0, TOPSCPASEMENTE: null, …}
JX.getParametro ().then (console.log);

// ERRO: Forneça o nome dos parametros a serem buscados como Texto ou Array de Textos!
JX.getParametro (5).then (console.log);

// ERRO: Os parametros informados devem ser Textos não vazios!
JX.getParametro (['']).then (console.log);

// ERRO: Os parametros informados devem ser Textos não vazios!
JX.getParametro (['ASD', 7]).then (console.log);

// ERRO: Forneça o nome dos parametros a serem buscados como Texto ou Array de Textos!
JX.getParametro (false).then (console.log);

Chamada de Serviço

• chamarServico(nomeServico, dados, dadosAdicionais): Permite a chamada de serviços web específicos, facilitando a interação com diferentes módulos e funcionalidades do sistema.

JX.chamarServico ("mgecom@admin.getVersao").then (console.log); // Sem corpo de envio
JX.chamarServico ('WorkspaceSP.getStartupData', '<serviceRequest serviceName="WorkspaceSP.getStartupData"><requestBody><resourceIDs/><clientEventList/></requestBody></serviceRequest>');

---

Considerações

• Muitos métodos da JX são assíncronos e retornam Promises.
• Implemente tratamento de erros para assegurar a robustez da aplicação.
• A biblioteca JX é desenhada para ser versátil e fácil de usar, adequada para uma variedade de cenários em aplicações web.