Nome do cliente: Confederação Nacional da Indústria
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 e SENAI 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.
Devem ser parametrizadas as seguintes informações:
|
Expandir | ||||
---|---|---|---|---|
| ||||
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 que deseja utilizar em seu ambiente.
Para ativar ou desativar uma customização deverá ser realizados os seguintes passos:
|
Expandir | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Pré-Requisitos / Parametrizações
| WSConsulta | WSConsultaTeste
Expandir | ||
---|---|---|
| ||
Parâmetros para Geração do TokenNo 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. * 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:
|
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.
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:
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".
Ao acessar o Swagger, serão listados todos os serviços disponíveis, com a descrição do serviço, parâmetros e urls:
O webservice de consultas SQL é o "CstExecSQL", método "ExecutaConsultaSQL".
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.
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.) |
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).
Exemplo do envio da requisição via Postman:
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
Âncora | ||||
---|---|---|---|---|
|
Lista Códigos dos Sistemas
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 | Y |