Histórico da Página
Índice |
---|
CONTEÚDO
- Visão Geral
- Configuração passo a passo
- Assistente de ativação / desativação do processo
- Como Funciona
- Visualização de Log
01. VISÃO GERAL
A partir da versão 12.1.28 é possível realizar a integração do RM com o TOTVS App (Carol).
...
Informações | ||
---|---|---|
| ||
Para a ativação da integração funcionar corretamente em bases Oracle é necessário ter a versão igual ou superior ao Oracle12.2. É necessário que o ambiente possua ao menos um JobServer no ambiente para que a integração seja habilitada. TDN : https://tdn.totvs.com/x/Gy8ZE |
02. CONFIGURAÇÃO PASSO A PASSO
Existem 2 formas de integrar o RM ambiente com o TOTVS App.
Primeira: Com a ativação baseada no Client Id e Client Secret do RAC. Dessa forma é necessário um ambiente provisionado (RAC ou Carol). Esta é a opção indicada para novas integrações.
Os endereços do TotvsApp devem ser recuperados pelos links abaixo:
- Ambiente Dev = https://endpoint-registry.dev.totvs.app/api/v1/services
- Ambiente Staging = https://endpoint-registry.staging.totvs.app/api/v1/services
- Ambiente Produção = https://endpoint-registry.totvs.app/api/v1/services
...
Nos arquivos de configuração do host (RM.Host.exe.config, RM.Host.Service.exe.config), adicione a TAG “FileServerPath”. Essa deverá apontar para um caminho compartilhado na rede, conforme abaixo:
Obs: Em ambiente 3 camadas, essa configuração deve ser realizada nas máquinas JobServer.
...
Aviso | ||
---|---|---|
| ||
A partir dos patches 12.1.28.221 e 12.1.29.151 não é necessário deixar os conceitos nesse diretório, pois serão obtidos automaticamente pelo sistema. |
.222Arquivo Arquivo de configuração do projeto
Aviso | ||
---|---|---|
| ||
A partir da versão 12.1.34, a rotina de agendamento(ScheduleInfo), somente irá realizar o download dos arquivos de configurações quando houver alteração em pelo ao menos um arquivo de conceito. Essa nova funcionalidade visa economizar download desnecessário, quando não há mudanças. |
Será disponibilizado um modelo de arquivo de configuração json Json do projeto. Esse arquivo deve ter obrigatoriamente o nome de “totvsAppConfig“totvsAppConfig.json”json”. Ele deve ser copiado para o mesmo caminho de rede descrito acima.
...
Arquivo exemplo: totvsAppConfig.json.
a) RMVersion: versão do RM (essa opção ainda não está sendo usada pelo processo);
...
a) ConceptID: guid contendo a identificação única do conceito. Com esse atributo, poderemos resolver a situação de um conceito ser utilizado por várias integrações (businessDomain). Daí ele será executado apenas uma única vez. Ex: conceito para exportação de dados da GColigada/GFilial.
b) ConceptFileName: Nome físico do arquivo de conceito “*.concept” gravado no caminho de rede compartilhado. Esse nome tem que ser exatamente igual, contendo a extensão.
ex: "ConceptFileName": "ExportacaoFuncionarios.concept",
c) ConceptVersion: guid representando a versão do arquivo de conceito. Se o conceito sofrer alguma alteração que necessita do mesmo ser baixado novamente, esse guid deverá ser modificado. (essa opção ainda não está sendo usada pelo processo)
d) ProcessingDependency: Ordem de dependência de execução dos conceito. Ou seja, o processo não poderá executar o conceito “A” se o conceito “B” não for executado com sucesso. (essa opção ainda não está sendo usada pelo processo)
03. ASSISTENTE DE ATIVAÇÃO / DESATIVAÇÃO DO PROCESSO
Permissão no item de menu
No RM, acesse a opção “Serviços globais / Perfis / Integração” e forneça as permissões para o perfil do usuário em questão.
Selecione o sistema “Integração / Totvs App / Ativação Totvs App” e verifique se o item de menu está habilitado.
Processo de ativação
Nos patches mais recentes são desmobilizadas disponibilizados duas formas de autenticação no ambiente: Credenciais do RAC ou credenciais da Carol. Apenas 1 mecanismo de autenticação deve ser utilizado.
...
Na versão 12.1.28 está disponível apenas a integração com o "Consignado". A partir da versão 12.1.29 está disponível também o "Antecipa".
Informações | ||
---|---|---|
| ||
A partir da versão 12.1.33.295 também estará disponível a integração com o Painel Financeiro. |
Para configuração das credenciais da Carol:
- Informe o endereço da Carol:
ex: https://totvstechfindev.carol.ai/ - Informe o Id do Connector da Carol:
ex: 09ddb0e29e604e599a1356dab2f89df9 - Informe o token da Carol: Esse token, deverá ser recuperado do ambiente Carol, conforme este link.
Para configuração das credenciais do RAC, os dados da Carol não precisam ser preenchidos, pois o sistema usará a autenticação RAC para buscar as credenciais da Carol.
...
- Os conceitos serão executados e os dados serão enviados para Carol conforme definido nos conceitos;
- Será gravada uma linha na tabela “GTOTVSAPPCONCEITOHST” conforme informações de execução de cada conceito (sucesso ou erro e mensagem de erro);
- Em caso de sucesso, a coluna “GTOTVSAPPCONCEITOHST.DATAULTEXEC” será atualizada para a data de início da execução do processo.
- O status da execução pode ser consultado também na coluna “GTOTVSAPPCONCEITOHST.STATUS” (1 - sucesso, 2 - falha, 0 - não executado). E na coluna "GTOTVSAPPCONCEITOHST.MENSAGEM" a mensagem do erro ou de sucesso.
12.1.33
A partir da versão 12.1.33, estará disponível apenas autenticação com as Credenciais do RAC.
Além disso, o processo de ativação irá ativar ou desativar a integração com todos os aplicativos disponíveis. Será necessário clicar no botão "Buscar Apps" antes de avançar com o processo, e será retornado todos os Apps disponíveis na Carol para a integração com ambiente RM.
Caso a integração já esteja ativa e um novo App for disponibilizado (Exemplo: SGDP), não será necessário refazer o processo de ativação.
Aviso | ||
---|---|---|
| ||
Ao clicar para Buscar Apps, serão retornados somente os Apps disponíveis em cada Client Id e Client Secret. |
Aviso | ||
---|---|---|
| ||
Após ativar a integração um serviço de monitoramento da saúde do processo será disparado com o intuito de manter o processo da integração executando de acordo com a configuração de periodicidade. Ver mais em: Serviço De Monitoração Da Saúde Da Integração RM x TOTVS App |
Processo de desativação
Após ativado, o usuário poderá a qualquer momento desativar o processo conforme opção abaixo:
O processo de desativação executará os seguintes procedimentos:
- As informações das tabelas “GTOTVSAPP, GTOTVSAPPCONCEITO, GTOTVSAPPCONCEITOHST e GTOTVSAPPLOG " serão excluídas da base;
- O Job Executor do processo será finalizado e excluído;
- As tabelas de softDelete não serão mais alimentadas com informações de deleção.
Aviso | ||
---|---|---|
| ||
|
04. Como Funciona
Através da ferramenta de Conceito o RM envia para a Carol (Inteligência artificial da TOTVS) informações chaves baseadas nas configurações dos conceitos de cada integração.
...
Aviso | ||
---|---|---|
| ||
Pelo fato da integração ser executada através de processos, os processos ConTotvsAppActivatorProcess e ConTotvsAppExecutorProcess NÃO podem ser manipulados pelo usuário. Os menus Iniciar / Parar / Desabilitar / Reiniciar da visão de gerenciamento de Job's foram desativados. Os WebServices que Executam / Agendam processos também foram bloqueados. A atividade ExecutarProcesso da Fórmula Visual também foi bloqueada para não permitir a execução dos processos citados. |
Caso o ambiente utilizado seja um ambiente 3 Camadas, o O processo será recorrente de acordo com a configuração de periodicidade utilizada no arquivo totvsAppConfig.json.
Caso o ambiente utilizado seja um ambiente Local, o processo não será recorrente porém o serviço de monitoramento da saúde do processo irá executar o processo em horários bem próximo da configuração de periodicidade.
Informações | ||
---|---|---|
| ||
Para entender como funciona o serviço de Monitoramento da saúde do processo acesse : https://tdn.totvs.com/x/27EMIg |
05. VISUALIZAÇÃO DE LOG
Na tabela GTOTVSAPPLOG é armazenado o log detalhado de cada execução dos conceitos e envios cadastrados na tabela GTOTVSAPPCONCEITOHST.
...
Para analisar os registros da tabela de log, é importante filtrar a busca pela chave GTOTVSAPPLOG.IDTOTVSAPPCONCEITOHST, relacionada a coluna GTOTVSAPPCONCEITOHST.ID
06. HABILITAR TLS
Em alguns casos é necessário ajustar o TLS do servidor.
Para ajustar basta criar um arquivo com a extensão .Reg e escrever o comando abaixo. Após criar o arquivo basta executar.
Importante que todos os servidores que processam Jobs estejam com essa configuração.
Aviso | ||
---|---|---|
| ||
Antes de Executar é importante fazer o backup das todas as chaves descritas no bloco de código. |
Bloco de código |
---|
Windows Registry Editor Version 5.00 ; 0x00000008 Habilitar o SSL 2.0 por padrão ; 0x00000020 Habilitar SSL 3.0 por padrão ; 0x00000080 Habilitar TLS 1.0 por padrão ; 0x00000200 Habilita o TLS 1.1 por padrão ; 0x00000800 Habilitar TLS 1.2 por padrão [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Internet Settings\WinHttp] "DefaultSecureProtocols"=dword:0x00000800 [HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Windows\CurrentVersion\Internet Settings\WinHttp] "DefaultSecureProtocols"=dword:0x00000800 [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\SecurityProviders\SCHANNEL\Protocols\TLS 1.2\Client] "DisabledByDefault"=dword:00000000 [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\SecurityProviders\SCHANNEL\Protocols\TLS 1.2\Server] "DisabledByDefault"=dword:00000000 |
07. MECANISMO DE EXECUÇÃO DA INTERGRAÇÃO COM O TLC
O campo "IDJOB" já existente na tabela "GTOTVSAPP" é responsável em fazer a subida dos dados para Carol (busca do RM e envia para Carol).
Com a nova implantação do TLC, após realizar a ativação do TotvsApp, será criado um novo IDJOB na tabela "GTOTVSAPP", mas que estará disponível no novo campo "JOIBIDTLC". Ele é o responsável por enviar mensagens localizadas na tabela "GTOTVSLINKMESSAGE" para o TotvsLinkClient.
A cada exportação realizada com sucesso, o dado das métricas será localizado na tabela "GTOTVSLINKMESSAGE", após o envio das métricas serem realizados com sucesso, os dados serão enviados para a tabela "GTOTVSLINKMESSAGEEXEC" e excluído na tabela "GTOTVSLINKMESSAGE".
Aviso | ||
---|---|---|
| ||
Os dois Jobs criados "IDJOB" e "JOIBIDTLC" não poderão ser desabilitados na tela "Gerenciamento de Jobs" localizado no RM.exe, visto que são Jobs de integração. Os mesmo somente serão desabilitados pelo processo de "Desativação da integração". |
Na tabela "GJOBXEXECUCAO", deve existir dois Jobs recorrentes (de acordo com a configuração de periodicidade utilizada), referentes aos Ids criados no campos "JOBID" e "JOIBIDTLC" da tabela "GTOTVSAPP".
E ao realizar a desativação do processo, o Jobs devem ser desabilitados (status = 8).
As métricas, estão sendo enviadas para o Grafana (Uma aplicação web de análise, onde são fornecidos tabelas, gráficos, etc).
A execução do "JOBIDTLC", fará uma leitura na tabela "GTOTVSLINKMESSAGE" e realizará o envio das métrica para o Grafana.
Segue abaixo o exemplo da visualização das métricas dentro da aplicação: