Fábrica de Software TOTVS BH

Atalhos

Páginas filhas
  • Manual Operacional da Customização - Integração Itinerário - FS007523

Versões comparadas

Versão antiga 2

changes.mady.by.user Usuário desconhecido (thiago.chagas)

Gravado em

comparado com

Nova versão 3

changes.mady.by.user Usuário desconhecido (thiago.chagas)

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Expandir
titleReq. 03 – Cadastro Customizado de Capacidades Técnicas

Pré-Requisitos / Parametrizações

Nenhum.


Detalhamento do Processo

Foi desenvolvido no menu Customizado do TOTVS Educacional o cadastro de Capacidades Técnicas.

O usuário poderá inserir, editar e excluir os registros dessa entidade. Os seguintes campos estarão disponíveis para edição:

  • Código (obrigatório): será gravado o código da Capacidade Técnica.
  • Descrição (obrigatório): será gravado a descrição da Capacidade Técnica.

Na tela de visualização dos dados, o usuário poderá consultar ainda se o registro foi inserido manualmente ou via Integração, através da coluna Origem Registro.


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&amp

no menu Customizado do TOTVS Educacional o cadastro de Capacidades de Gestão.

O usuário poderá inserir, editar e excluir os registros dessa entidade. Os seguintes campos estarão disponíveis para edição:

  • Código (obrigatório): será gravado o código da Capacidade de Gestão.
  • Descrição (obrigatório): será gravado a descrição da Capacidade de Gestão.
  • Tipo (obrigatório): O tipo da capacidade de Gestão poderá ser Metodológica, Organizativa ou Social.

Na tela de visualização dos dados, o usuário poderá consultar ainda se o registro foi inserido manualmente ou via Integração, através da coluna Origem Registro.


Image Added

Image Added

Expandir
titleWeb Service Consulta SQLReq. 04 – Cadastro Customizado de Capacidades de Gestão

Pré-Requisitos / Parametrizações

Nenhum.


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.

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.

Parâmetros do Web Service

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

ParâmetroConteú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.

Expandir
titleReq. 05 – Cadastro Customizado de Conhecimentos

Pré-Requisitos / Parametrizações

Nenhum.


Detalhamento do Processo

Foi desenvolvido no menu Customizado do TOTVS Educacional o cadastro de Conhecimentos.

O usuário poderá inserir, editar e excluir os registros dessa entidade. Os seguintes campos estarão disponíveis para edição:

  • Código (obrigatório): será gerado automaticamente um código do Conhecimento.
  • Descrição Conhecimento Nível 1 (obrigatório): será gravado a descrição do primeiro nível do Conhecimento.
  • Descrição Conhecimento Nível 2: será gravado a descrição do segundo nível do Conhecimento.
  • Descrição Conhecimento Nível 3: será gravado a descrição do terceiro nível do Conhecimento.


Image Added


Na tela de visualização dos dados, o usuário poderá consultar ainda se o registro foi inserido manualmente ou via Integração, através da coluna Origem Registro.

Image Added

Expandir
titleReq. 06 – Cadastro Customizado de Ambientes Pedagógicos

Pré-Requisitos / Parametrizações

Nenhum.


Detalhamento do Processo

Foi desenvolvido no menu Customizado do TOTVS Educacional o cadastro de Ambientes Pedagógicos.

O usuário poderá inserir, editar e excluir os registros dessa entidade. Os seguintes campos estarão disponíveis para edição:

  • Código (obrigatório): será gravado o código do Conhecimento.
  • Descrição (obrigatório): será gravado a descrição do Conhecimento.
  • Tipo (obrigatório): O tipo do Ambiente Pedagógico poderá ser:

Máquinas

Equipamentos

Ambientes Pedagógicos

Material Didático

Máquinas, Equipamentos, Instrumentos e Ferramentas

Ferramentas e Suprimentos

Instrumentos

Materiais

Equipamentos, Ferramentas e Instrumentos

Recursos Didáticos

Mobiliário

Observações/Recomendações


Na tela de visualização dos dados, o usuário poderá consultar ainda se o registro foi inserido manualmente ou via Integração, através da coluna Origem Registro.

Image Added

Image Added

;parameters=MUNICIPIO=Belo Horizonte HTTP/1.1
Host: localhost:8080
Authorization: Basic bWVzdHJlOnRvdHZz

Histórico de atualização do documento

...