Manual Operacional da Customização - LIB DN

Nome do cliente: Confederação Nacional da Indústria

Objetivo

A customização LIB DN possui algumas funcionalidades que podem ser compartilhadas entre as diversas customizações disponibilizadas pelo Departamento Nacional. A instalação desta customização permite que as outras customizações funcionem corretamente mediante a utilização das funções presentes nesta customização.

Esse manual tem a função de detalhar, de forma operacional, como é a utilização das rotinas disponibilizadas nesta customização.

Expandir

title	Parâmetros

Pré-requisitos/Parametrizações

Não se aplica.

Descrição do processo

Tela de parâmetros para que o usuário defina o Token necessário para validar o acesso à Web Services disponibilizados pela TOTVS e também definir qual o número da Coligada SESI, SENAI e SENAI IEL no Departamento Regional.

Detalhamento do processo

No TOTVS Educacional, por meio da opção “Parâmetros Gerais”, disponível no menu "Customização", o usuário administrador efetua as parametrizações necessárias para as customizações do Departamento Nacional.

Nota
A partir da versão 12.1.22, a opção "Parâmetros Gerais" está disponível no menu TOTVS Educacional \| Sistema Indústria.

Image Removed

Table Excerpt

name	ParamGerais

Para acessar os Parâmetros Gerais siga o caminho módulo Educacional | Sistema Indústria | Parâmetros Gerais;

Image Added

Devem ser parametrizadas as seguintes informações:

Token Basic Auth

Token necessário para validar acesso aos Web Services da TOTVS nas customizações disponibilizadas pelo Departamento Nacional. Este Token é a informação de algum Usuário do SGE e sua senha criptografados de acordo com o modelo de autenticação disponível.

O código criptografado deve ser enviado toda vez que for acionado algum Web Service disponibilizado pela TOTVS para as Customizações do Departamento Nacional. A customização será capaz de descriptografar o código enviado para então realizar uma tentativa de login no SGE com o Usuário e Senha utilizados para a criptografia.

Para gerar o Token é necessário executar o processo "Gerar Token" acessível pela opção "Processos" da tela de Parâmetros.

Image Modified

Deck of Cards

id	GerarToken

Card

deck	1passo
id	1passo
label	1° passo
title	1° passo
card	1° passo

Na primeira tela do processo o usuário visualiza as opções de autenticação disponíveis (até o momento é somente BasicAuth).

Image Modified

Card

deck	2passo
id	2passo
label	2° passo
title	2° passo
card	2° passo

Na segunda etapa o usuário deve definir qual usuário e senha serão criptografados mediante o modelo de autenticação.

Image Modified

Card

deck	3passo
id	3passo
label	3° passo
title	3° passo
card	3° passo

Em seguida o usuário deve clicar em Executar.

Image Modified

Card

deck	4
id	4passo
label	4° passo
title	4° passo
card	4° passo

Por fim, é apresentado o log de execução do processo.

Image Modified

O Token gerado pode ser visualizado no parâmetro "Token Basic Auth".
Image Modified

- Coligada SENAI
  Usuário deve determinar entre as Coligadas existentes na base de dados qual dela corresponde à Coligada SENAI.
  Image Modified
- Coligada IEL (Exclusivo para a FIEP - Até o momento)

Usuário deve determinar entre as Coligadas existentes na base de dados qual dela corresponde à Coligada IEL.

Image Added

As customizações só funcionaram para coligada IEL, caso o Regional tenha implementado a coligada no sistema.

- Coligada SESI
  Usuário deve determinar entre as Coligadas existentes na base de dados qual dela corresponde à Coligada SENAI.
  Image Modified

Expandir

title	Controles de Customizações Ativas

Pré-requisitos/Parametrizações

Não se aplica.

Descrição do processo

Tela de parâmetros para que o usuário defina qual customização ele quer utilizar ou não em seu ambiente.

Detalhamento do processo

No TOTVS Serviços Globais, por meio da opção “Controle de Customizações Ativas”, disponível no menu "Customização", o usuário administrador efetua a ativação ou desativação para as customizações do Departamento Nacional ou específicas que deseja utilizar em seu ambiente.

Nota
Por padrão todos os projetos virão ativos no parametro "Controle de customizações ativas", mesmo os projetos que não estão instalados no ambiente.

Para ativar ou desativar uma customização

deverá

para todas as coligadas deve ser realizados os seguintes passos:

Selecione o projeto que deseja realizar a ação pelo nome, clique em Editar marque ou desmarque a opção

Ativada

Image Removed

Ativa

Image Added

Para ativar ou desativar uma customização em alguma coligada especifica deve ser realizados os seguintes passos:

Selecione o projeto que deseja realizar a ação pelo nome, clique em Anexo → Controle de Customização Invativas Por Coligada;
No anexo insira um novo registro clicando no botão Novo;

Image Added

Nota
Apos ativar/desativar uma customização deve-se reiniciar o RM.Host das maquinas do servidor.

Parâmetros para Geração do Token

requisitos:

Liberar a permissão do perfil de usuário, no Monitor de log (Moodle), opção Editar Registro - Monitor de log, conforme imagem:

Image Added

Descrição do processo

O objetivo do Processo de Alteração dos Status dos Logs com Erro é permitir alterar os status dos logs com erro para cancelado.

A funcionalidade estará disponível na tela de Monitor de Logs, menu Processos | Altera Status dos Logs

Image Added

Deverão ser selecionados apenas os registros com status de "Erro", deverá também selecionar ao menos 1(um) registro para alteração do mesmo.

Ao iniciar o processo será aberto uma tela para escolha de status "Cancelado" :

Image Added

Executando o processo, todos os registros selecionados terão seu status mudados para o escolhido.

Expandir

Web Service Consulta SQL

title		Alteração Status Logs com Erro

Novo!

Pré-

Requisitos / Parametrizações

Âncora

WSConsulta

Expandir

title	Token - Consumo do WebService

Expandir

title	Exclusão de Logs

Novo!

Pré-requisitos:

Liberar a permissão do perfil de usuário, no Monitor de log (Moodle), opção Excluir Registro - Monitor de log, conforme imagem:

Image Added

Descrição do processo

O objetivo do Processo de Exclusão dos Logs é permitir a exclusão de logs antigos com a diferença de 3(três) meses da data atual .

A funcionalidade estará disponível na tela de Monitor de Logs, menu Processos | Excluir Registro de Log

Image Added

Ao abrir o processo serão listados todas as funcionalidades para aquele modulo do sistema.

Com isso o usuário deverá preencher os campos de acordo com :

Image Added

Data inicio: Data que será considerada para data mínima para exclusão.
Data Fim: Data que será considerada para data limite para exclusão.
Status: Status que os Logs deverão conter para exclusão.
Funcionalidades: Funcionalidades do sistema que o log deve abranger para ser excluído.

Novo!

Foi disponibilizado mais uma nova etapa na interface customizada do Processo Excluir Registro de Log, para exibir ao usuário os itens que serão excluídos a partir da funcionalidade, status e datas selecionadas, com opção de marcar ou desmarcar registros de log para exclusão.

A etapa adicionada exibirá um grid que servirá para o usuário visualizar todos os registros que atendam a seleção da funcionalidade e status no período solicitado. Será permitido selecionar um ou vários registros antes de executar a exclusão dos registros. Por padrão, todos os registros estarão marcados.

Image Added

Para o carregamento dos registros da segunda etapa é necessário a seleção de funcionalidade, período e status. Não foram alteradas as validações anteriores que existiam em tela de processamento. Por padrão, os registros já vêm selecionados na segunda etapa.

Nota

title	Importante:

Ao acessar o processo de exclusão de log, não pode haver nenhum registro de monitor de log selecionado, já que o usuário deverá filtrar na interface do processo os registros que serão excluídos.

Após o preenchimentos de todos os campos de forma correta, e o processo executado os registros que abrangerem os parâmetros passados serão excluídos dos sistemas.

Exemplo de uma requisição enviada para o WebService

Consulta SQL cadastrada no RM, com o código "CstTesteFiltros".

Como podemos ver na imagem abaixo, ela retorna os dados do município e tem um parâmetro (MUNICIPIO).

Image Removed

Exemplo do envio da requisição via Postman:

Image Removed

Código da requisição em HTTP

GET /rm/api/TOTVSCustomizacao/ConsultasSQL/ExecutaConsultaSQL?codColigada=0&codSentenca=CstTesteFiltros&parameters=MUNICIPIO=Belo Horizonte HTTP/1.1
Host: localhost:8080
Authorization: Basic bWVzdHJlOnRvdHZz

Lista Códigos dos Sistemas

Y

Image Added

Registro na base de dados:

Image Added

Expandir

title	API de Log Genérico

Novo!

Pré-requisitos:

Liberar a permissão do perfil de usuário, na API Monitor de Log, conforme imagem:

Image Added

Gerar/Recuperar o Token Basic Auth para consumo da API (consulte o item Parâmetros desta página).

Descrição do recurso

A API de Log tem como objetivo a inserção e atualização de log de qualquer integração de forma genérica.

Informações para o consumo da API:

Requisição POST na URL: "http://<servidor>:<apiPort>/api/cst/v1/lib-dn/log" passando a autorização Token Basic Auth no cabeçalho.
JSON informado no body da requisição com os dados para inserção do log como exemplo abaixo:

{
"codColigada": 2,
"status": 1,
"codUsuario": "mestre",
"funcionalidade": 1,
"camposChaves": "CODCOLIGADA|RA",
"valorChave": "1|0012348",
"mensagem": "Mensagem do log",
"dadosEnviados": "Dados enviados",
"dadosRecebidos": "Dados recebidos",
"modulo": "NOMEMODULO",
"actionName": "NomeDaAction",
"dataServer": "DataServer",
"numeroTentativas": 0
}

No TOTVS Educacional, por meio do menu Transparência | Parâmetros disponível no menu "Customização", o usuário administrador efetuará a geração do Token para consumo do WebService de Consultas.

Image Removed

* Alguns regionais ainda utilizam a versão 1 do Portal da Transparência e por isso o parâmetro Token permanece na lista.

Deverão ser parametrizadas as seguintes informações:

Usuário: Usuário do SGE que será utilizado para geração do Token que fará autenticação no RM.

Senha: Senha do usuário do SGE que será utilizado para geração do Token que fará autenticação no RM.

Token Portal Transparência V2:
Token necessário para validar acesso aos Web Services da TOTVS nas customizações disponibilizadas pelo Departamento Nacional. Este Token é a informação do Usuário do SGE e sua senha criptografados de acordo com o modelo de autenticação disponível.
O código criptografado deverá ser enviado toda vez que for acionado algum Web Service disponibilizado pela TOTVS para as Customizações do Departamento Nacional. A customização será capaz de descriptografar o código enviado para então realizar uma tentativa de login no SGE com o Usuário e Senha utilizados para a criptografia.
Para gerar o Token é necessário executar o processo "Gerar Token" acessível pela opção "Processos" da tela de Parâmetros. O Token gerado poderá ser visualizado no parâmetro "Token Portal Transparência V2".

Image Removed

Detalhamento do Processo

Foi desenvolvido um Web Service destinado a executar consultas SQL's cadastradas no RM.

Ao realizar a instalação da customização, ele estará disponível para acesso através do serviço do RM.

Swagger

Todos os serviços disponíveis no RM são agrupados e listados nessa ferramenta, que visa auxiliar na manutenção e documentação de APIs REST.

Para acessar o Swagger, é necessário acessar o link no seguinte formato "http://<servidor>:<portaFrameHTML>/swagger/ui/index" (Exemplo: http://localhost:8080/swagger/ui/index).

Para verificar a porta, acesse, através do IIS, o Website "FrameHTML", que é gerado quando realizada a instalação do Portal RM:

Image Removed

Após isso, basta clicar com o botão direito do mouse no Website "FrameHTML" e clicar na opção "Editar ligações...". Conforme imagem abaixo, a porta seria a 8080, e o link ficaria da seguinte forma "http://localhost:8080/swagger/ui/index".

Image Removed

Ao acessar o Swagger, serão listados todos os serviços disponíveis, com a descrição do serviço, parâmetros e urls:

Image Removed

O webservice de consultas SQL é o "CstExecSQL", método "ExecutaConsultaSQL".

Segurança

Para a autenticação no Web Service, é utilizado um Token, gerado pela tela de parametrização da customização.

Para isso, o usuário deverá acessar a tela de Parâmetros, no menu "TOTVS Educacional→Customização→Parâmetros".

Após acessar a tela, preencher os campos Usuário e Senha com dados válidos para realizar um login no RM. Em seguida, executar o processo "Gerar Token".

O Token gerado no campo "Token Portal Transparência V2" deverá ser enviado em todas as requisições, no header "Authorization", da seguinte forma: Basic token_gerado.

Para maiores detalhes, acesse aqui o manual da Lib DN.

Parâmetros do Web Service

O web service possui 3 parâmetros, sendo dois deles obrigatórios e todos enviados via GET:

Parâmetro

Conteúdo esperado

CodColigada (Obrigatório)

A coligada da consulta SQL cadastrada no RM.

CodSentenca (Obrigatório)

O Código da sentença SQL.

Parametros (Opcional)

Os parâmetros da consulta SQL. Devem ser passados da seguinte forma:

param1=value;param2=value.

Exemplo:

codColigada=0;codArea=1

Se a consulta que será executada não possuir parâmetros, o campo será enviado sem nenhum valor.

CodSistema (Obrigatório)

O Código do Sistema ao qual a Consulta SQL pertence. (Para consultar a lista com os códigos dos sistemas, clique aqui.)

Âncora

_CodSistema

Nome

Código do Sistema

RM Custos

0

RM Chronus

A

RM Testis

B

RM Saldus

C

RM Liber

D

RM Classis - E

E

RM Fluxus

F

RM Bis

G

RM Agilis

H

RM Bonum

I

RM Factor

K

RM Biblios

L

RM Solum

M

RM Officina

N

RM Saude/Janus

O

RM Labore

P

RM SSO

R

RM Classis Net

S

RM Nucleus

T

RM Classis - U

U

RM Vitae

V

RM Portal

W

RM SGI

X

RM Acesso

Web Service Consulta SQL

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 12

Nova versão Atual

Chave

Manual Operacional da Customização - LIB DN