18. Onde configurar as integrações com terceiros e a instalação

Este capítulo é um guia de consulta rápida: para cada integração com terceiros, mostra onde fica cada configuração, na ordem em que deve ser feita, no formato Menu › Tela › campo. O detalhe de cada tela, as mensagens de erro e as regras de uso estão nos capítulos do hub de integrações e de mensageria; aqui o foco é o caminho.

O roteiro se repete em todas as integrações: cadastrar a integração no hub com o endereço e a credencial, pedir ao administrador do sistema a aprovação do servidor na lista de saída, Testar, e só então ligar a integração ao que a usa (canais de área, alertas, mensagens ou conectores).

A última seção reúne os arquivos e as variáveis da instalação do Bússola/BSC no modo interno (Docker Compose) e em nuvem (Kubernetes). Valores secretos nunca aparecem neste manual: onde houver um segredo, ele está indicado como <valor>.

ID BSC-CFG-01

O WhatsApp leva os alertas pessoais do Bússola/BSC ao celular de cada pessoa que confirmou o número. O envio é feito pelo provedor contratado, em nome da Empresa Exemplo S.A., e a configuração passa por seis telas: o cadastro da conta no hub, a lista de saída, o endereço dos avisos entregue ao provedor, a mensagem com o modelo aprovado, a regra de alertas e, por fim, o consentimento de cada pessoa.

Só pode haver uma integração de WhatsApp ativa por ambiente.

Quem usa: Analista de Integração de Dados; Administrador do sistema; Gestor de Desempenho (escritório de estratégia); Responsável por ação/área.

Figura 196 — Integrações › Nova integração › WhatsApp: endereço do provedor, identificadores do número e da conta, token, App Secret e token de verificação.

Figura 197 — Início › Lista de saída das integrações › Aprovar destino: servidor, protocolo, porta e justificativa.

Figura 198 — Integrações › Canais de área › WhatsApp da empresa: o endereço dos avisos a entregar ao provedor contratado.

Figura 199 — Início › Mensagens institucionais: o modelo da mensagem, com as variantes por canal.

Figura 200 — Gestão por indicadores › Alertas e mensagens: marcar WhatsApp em cada família de aviso.

Figura 201 — Início › Preferências de notificação › Meu WhatsApp: cada pessoa confirma o número e o consentimento.

ID BSC-CFG-02

O Microsoft Teams e o Discord recebem os avisos do Bússola/BSC num canal compartilhado de cada área. Cada canal é uma integração do hub com a URL do webhook gerada no próprio Teams (fluxo do Workflows) ou no Discord (webhook do canal); depois de testada, a integração é ligada a uma unidade em Canais de área e escolhida nas regras de Alertas e mensagens.

Quem usa: Analista de Integração de Dados; Administrador do sistema; Diretoria de Estratégia (patrocinador/aprovador); Gestor de Desempenho (escritório de estratégia).

Figura 202 — Integrações › Nova integração › Microsoft Teams: a URL do webhook do fluxo do canal.

Figura 203 — Integrações › Nova integração › Discord: a URL do webhook do canal.

Figura 204 — Início › Lista de saída das integrações › Aprovar destino para o servidor do webhook.

Figura 205 — Integrações › Canais de área › Ligar canal: a integração de Teams ou Discord e a unidade que recebe os avisos.

Figura 206 — Gestão por indicadores › Alertas e mensagens: publicar o aviso no canal da área.

ID BSC-CFG-03

SEI, SIAFI, Portal da Transparência e Tesouro Gerencial são cadastrados como integrações do hub e usados pelos conectores do BSC. O SEI acompanha e abre processos; o tipo SIAFI traz a execução do orçamento por um de seus canais (API Dados SIAFI (STA), dados abertos do Portal da Transparência, relatório extraído do Tesouro Gerencial ou web services do SIAFI). O De-Para traduz o dado capturado nos objetos do BSC, e cada execução fica registrada no Monitor de integrações.

Para treinar usuários e homologar o lado do Bússola/BSC antes de os acessos reais serem entregues, há um ambiente de simulação para treinamento e homologação que responde como o SEI, o STA e o Portal da Transparência; as integrações de simulação levam o selo Simulador e não existem em produção.

Quem usa: Analista de Integração de Dados; Administrador do sistema; Gestor de Desempenho (escritório de estratégia).

Figura 207 — Integrações › Nova integração › SEI: interface, endereço, caminho da API, versão, usuário de serviço e operações habilitadas.

Figura 208 — Integrações › Nova integração › SIAFI e dados abertos de orçamento: o canal (API de dados do SIAFI, Portal da Transparência, Tesouro Gerencial, web services) e os campos de cada um.

Figura 209 — Início › Lista de saída das integrações: os servidores aprovados para as integrações.

Figura 210 — A integração aberta: Testar, Pré-visualizar e o resultado do último teste.

Figura 211 — Gestão por indicadores › Configuração de conectores: a paleta, com os componentes SEI e SIAFI.

Figura 212 — O De-Para do conector de captura: de que campo do dado capturado vem cada valor do Bússola/BSC.

Figura 213 — Integrações › Tabelas de equivalência: o código da origem e o objeto do Bússola/BSC que ele representa.

ID BSC-CFG-04

Reúne os arquivos e as variáveis que configuram a instalação do Bússola/BSC: no modo interno, com Docker Compose num servidor da empresa; no modo nuvem, com Kubernetes. A configuração da aplicação é a mesma nos dois modos. O procedimento completo de instalação e de backup está nas seções BSC-INS-01 e BSC-INS-02.

Os segredos (senhas, chave de cifragem, chaves do destino do backup) são gerados pela empresa e preenchidos só nos arquivos de segredo, nunca em manual, chamado ou mensagem; aqui eles aparecem como <valor>.

Quem usa: Administrador do sistema.