Biblioteca Angular

Conteúdo

Visão Geral

Esta biblioteca tem como objetivo auxiliar na implementação de notificação de uso de rotinas e métricas adicionais ao License Server Cloud

Como utilizar

Adicione o registry da totvs no seu npm:

npm set registry https://npm.totvs.io

Instale a biblioteca no seu projeto:

npm install @totvs-supply/agro-license-server-lib --save

Importe o módulo da biblioteca no seu AppModule:

...

import {AgroLicenseServerLibModule} from '@totvs-supply/agro-license-server-lib';

....

imports: [
    AgroLicenseServerLibModule.forRoot(
        {
            enderecoBackend: 'http://sua-aplicacao.totvs.app',
            endpointNotificacaoUso: '/license-server/notificacao'
        }
    )
]

Em cada rota das suas telas, adicione um Guard, que será o responsável de notificar a abertura da tela:

...

import {NotificacaoUsoRotinaGuard} from '@totvs-supply/agro-license-server-lib';

...

export const rotas = [
    {
        path: '',
        component: MinhaTelaComponent,
        canActivate: [NotificacaoUsoRotinaGuard],
        data: {
            modulo: '5680',
            rotina: 'CAD001'
        }
    }
];

Pronto, sua aplicação já está pronta para notificar o License Server Cloud.

Mais informações

AgroLicenseServerLibModule

Ao importar o módulo da biblioteca, é obrigatório passar um objeto como parâmetro, é o ILicenseServerConfig.

Esse objeto possui dois atributos, enderecoBackend e endpointNotificacaoUso.

O enderecoBackend é o endereço da sua aplicação backend, geralmente essa informação fica no environment. Exemplos:

O endpointNotificacaoUso é opcional, se não for informado, será usado o path /api/v1/licenseServer/notificacaoUso

NotificacaoUsoRotinaGuard

Ao utilizar o Guard, é obrigatório informar a rotina, através da propriedade data da rota. Ela pode ser um descritivo da tela ou um código já pré-estabelecido pelo time do produto.

Já o modulo é opcional, se não for informado, o backend precisa informar este valor para a biblioteca license-server-java-lib.

Outras situações

Caso a tela não possua uma rota, ou é renderizada de outra forma, é possível chamar o LicenseServerService diretamente, informando a rotina e o modulo opcionalmente.

Páginas filhas