ARQ - Manual de Procedimentos e Operações do Sistema

Os manuais de sistema faz com que os usuários tenha uma visão abrangente e detalhada dos produtos da Cebi.

Analytics

ARQ -Manual de Procedimentos e Operações.

Analytics

Sobre o sistema

Objetivo do sistema

O Analytics foi criado com o objetivo de extrair e exibir dados gerenciais de nossas bases de dados para uso de nossos clientes, informações que poderiam auxiliar o trabalho deles ou fornecer insights cruciais para a melhoria de sua prestação de serviço.

Sistemas auxiliares

O Analytics possui um sistema auxiliar atualmente, chamado de Analytics Designer. Sua função é ser a área de elaboração e manutenção de relatórios, usando a plataforma Stimulsoft.

É importante frisar que a função do Analytics é relacionada às consultas, e apenas atrelar os relatórios a elas. Todo tipo de ação relacionada a relatórios é de responsabilidade do Analytics Designer ou das bibliotecas de configuração.

Analytics

Home do sistema - Usabilidade geral

Funções

Atualmente, a home do sistema tem duas funções: direcionar o usuário através dos menus e dos acessos rápidos às consultas ou a outra funcionalidade, e permitir visualização das dashboards.

Dashboards

A exibição de dashboards segue a configuração permitida para o usuário. Caso haja alguma dashboards para o usuário logado, exibirá um seletor de categoria, que diz qual o tipo de dashboard (Sistema, Perfil e Usuário). Ao selecionar uma delas, um segundo seletor aparecerá, para que o usuário selecione qual dashboard ele gostaria de ver.

Clique aqui para ver mais sobre a configuração de dashboards (incluir link para a página do manual)

Acessos rápidos

A exibição de acessos rápidos segue a configuração permitida para o usuário. Caso haja algum acesso para o usuário logado, exibira um seletor de acessos, para que ele escolha qual o tipo que ele gostaria de ver (Todos, Sistema, Perfil e Usuário). Ao selecionar um deles, serão exibidos os acessos rápidos daquele tipo.

Analytics

Manual do Cebi Analytics

ACESSANDO O SISTEMA

Tela Inicial

Passo a passo:

1. Ao acessar o endereço informado do sistema, informe seu 1Usuário1 e Senha e clique em Entrar.

2. Sistema apresenta a tela inicial.

3. Ao final da Tela, na opção “Acesso Rápido”, sistema permite selecionar as consultas que estão no acesso rápido.

4. Entre as opções, Usuário; Perfil; Sistema e Todos. Selecione uma opção: Todos.

5. Ao selecionar uma das opções, o sistema exibe as consultas de acesso rápido configuradas para a opção selecionada.

Exemplo: Após ter selecionado Todos. irá aparecer: -Almoxarifado.Materiais.Grupos.Subgrupos
-Consulta relatório.
-Relatório de Detalhe de faturamento
-Portaria Cat56
-Leituras Registradas Ate3ndimento

6..Clique em uma das consultas exibidas e o sistema direciona para a tela de execução da consulta selecionada.Onde você irá enxergar o arquivo e os botões (IMPRIMIR; VOLTAR; EXECUTAR)

7..Sistema permite a impressão da consulta por pdf.

Dashboard

Passo a passo:

1. No menu lateral, clique em “Analytics”, “Configurações”, e selecione a opção “Dashboard”.

2. O sistema apresenta as consultas Dashboard existentes que estão apresentadas em 3 abas: Sistema, Perfil e Usuário.

“Sistema”

“Perfil”

Importante: Os perfis atrelados ao usuário são exibidos na combo, e o usuário só poderá visualizar as dashboards configuradas aos perfis que ele possui.

“Usuário”

Editando uma Dashboard

Passo a passo:

1. Na tela Detalhes da Dashboard, clique no botão “Editar” .

2. O sistema permite a editar o dashboard. Selecione o Tipo do dashboard que deseja, sendo: Carrossel, Carrossel e Quadro, Carrossel e Dois Quadros ou Tabela com Detalhes.

Carrossel: Modelo simples que exibe apenas o carrossel com as tabelas e gráficos configurados.
Carrossel e Quadro: Modelo que contém um carrossel à esquerda e um quadro à direita** para uma pequena tabela ou gráfico fixo.
Carrossel e Dois Quadros: Modelo que contém um carrossel central e dois quadros abaixo para tabelas e gráficos fixos.
Tabela com Detalhes: Modelo que contém uma tabela à esquerda, que ao ser clicada, abre detalhes da linha selecionada em um gráfico à direita e em outro abaixo.

No botão escrito "excluir selecionadas" - Exclui todas as dashboards selecionados. No botão escrito "limpar seleção""- Limpa todas as dashboards. No botão escrito "Selecionar Todas" - Seleciona todas as dashboards. No botão com ícone "anotação" - Habilita os campos da dashboard selecionada para edição. No botão com ícone X - Apaga a dashboard selecionada.

ACESSO RÁPIDO

Passo a Passo:

1. No menu lateral, clique em “Analytics”, “Configurações”, e selecione a opção “Acessos Rápidos”.

2. O sistema apresenta as consultas configuradas para Acesso Rápido existentes, as que são apresentadas na página principal, divididas em 3 abas:

Aba “Sistema”
Aba “Perfil”**

Importante: Os perfis atrelados ao usuário são exibidos na combo, e o usuário só poderá visualizar as consultas configuradas aos perfis que ele possui.

“Usuário”**

EDITANDO UM ACESSO RÁPIDO

Passo a Passo:

1. Na tela Detalhes do Acesso Rápido, clique no botão “Editar”.

2. O sistema exibirá a tela de edição, onde ela está separada com as mesmas 3 abas descritas na tela de detalhes. (SISTEMA, PERFIL, USUÁRIO)

Importante: As consultas configuradas para “Sistema” só poderão ser alteradas por um usuário que possui a permissão para tal. Caso o usuário não tenha a permissão, a aba não será exibida na tela de edição.**

- Botão representado pela seta dupla- Altera o status de “Inativo” do acesso rápido da consulta.
- Botão ícone X - Apaga a consulta selecionada

3. Para adicionar um novo acesso rápido, selecione a aba referente a qual tipo de configuração você deseja que sua consulta em acesso rápido seja atrelada e clique no botão “Adicionar Consulta”.

Importante: Caso o tipo de configuração escolhido seja a de perfil, selecione a partir da combobox, em qual perfil deseja atrelar a nova consulta em acesso rápido.

4. O sistema apresenta um modal com uma listagem das consultas cadastradas no sistema.

5. Selecione quais e quantas consultas você deseja adicionar.

6. Marque “Inativo” para inativar as consultas que serão adicionadas

`7. Após selecionar as consultas desejadas, clique no botão “Adicionar”.

8. Para gravar as alterações, clique em “Gravar”.

Consultas

Criando consultas

Passo a passo:

**1.**Para adicionar uma nova dashboard, selecione a aba referente a qual tipo de configuração você deseja que sua dahsboard seja atrelada e clique no botão “Adicionar Consulta”.

Importante: Caso o tipo de configuração escolhido seja a de perfil, selecione a partir da combobox, em qual perfil deseja atrelar a nova dashboard.

2. O sistema apresenta um modal com o formulário a ser preenchido sobre a dashboard.

3. No campo “Consulta”, selecione a consulta que deseja implementar a dashboard.

4..No campo “Tipo Exibição”, escolha o tipo de exibição da dashboard.

5. No campo “Tipo Renderização”, selecione se a dashboard será renderizada como “Tabela” ou “Gráfico”.

6. Marque “Inativo” para inativar a dashboard.

7. Após preencher todos os campos corretamente, clique no botão “Salvar”.

8. Para gravar as alterações, clique em “Gravar”.

CRIANDO CAMPOS

Passo a passo:

1. Na aba “Campos”, clique em “Adicionar Campo”.

2. Preencha os campos obrigatórios.

3. No campo “Legenda”, informe o nome do campo.

4 No campo “Nome”, informe o nome do campo conforme o SQL.

5. No campo “Ordem do Campo”, informe a sequência na qual o campo será apresentado.

6. No campo “Tipo de Formatação”, selecione o tipo de dado do campo.

7. No campo “Alinhamento”, selecione o alinhamento em que o campo será exibido.

8. No campo “Tamanho Coluna”, informe o tamanho em que a coluna será exibida (Opcional).

9. Caso deseje realizar alterações em determinado campo, basta clicar no ícone (anotação), realizar a a lteração e clique no ícone (salvar). Caso queira descartar as alterações, clicar no ícone (seta invertida) .

10. Caso deseje apagar um ou mais campos, clique no ícone X para apagar o campo, ou selecione os campos que deseja apagar de uma vez clicando no ícone quadrado e depois clicando no botão quadrado “Excluir selecionados”. (Quando o campos estiver selecionado o ícone de seleção estará "ticado ).

BOTÃO SELECIONAR TODOS- Seleciona todos os campos<BR> BOTÃO LIMPAR SELEÇÃO -Desseleciona todos os campos.<P>

IMPORTANDO CAMPOS DO SQL

Passo a Passo:

1. Caso você já tenha preenchido corretamente sua query SQL no campo de “SQL” da consulta, clique no botão “Importar campo do SQL”.

2. O sistema irá apresentar um modal com algumas opções sobre como os campos serão importados. Para importar clique no botão “Importar”.

3. Sistema apresenta lista de campos importados.<P>

CRIANDO FILTROS

Passo a passo:

1. Na aba “Filtros”, clique em “Adicionar filtro”.

2. Preencha os campos obrigatórios.

3. No campo “Legenda”, informe o nome do campo para realizar a consulta.

4. No campo “Nome”, informe o nome do campo conforme o SQL.

5. No campo “Tipo”, selecione o tipo de dados do filtro.

6. Para campos do tipo “Combo Pré-Carregado”, informe a consulta SQL que irá gerar as opções do filtro.

7. Para campos do tipo “Combo Pesquisável”, informe a consulta SQL que irá gerar as opções do filtro.

1 select chaveCampo as Key, valorCampo as value
2 from tabela
3 where valorCampo like ´%{value}%

Importante: O campo “value” precisa ser informado no SQL para que a pesquisa possa ser feita.

8. Para os tipos de filtro “pesquisável” e “pré carregado” é possível selecionar um filtro Mestre. Isso faz com que o filtro selecionado nesse campo faça parte da composição dos valores na consulta do combo. Utilize “masterValue” no SQL para captar o valor do filtro mestre.

1 select filtro_id as Key, nome as value
2 from cd_filtros f
3 where f.consulta_id =masterValue}

9. Marque quando o filtro for “Opcional”, “Conjunto de Valores”, ou “Valores Similares”.

Importante:
“Conjunto de Valores”: Permite selecionar mais de um valor de um combo. Na interface o filtro aparecerá com um botão "+" ao lado do filtro, permitindo que adicione os valores selecionados numa lista.

Exemplo do SQL:   Where campo in({filtro})

“Valores Similares”: Faz com que o filtro no SQL busque v alores aproximados ao informado no filtro.

Exemplo do SQL:   Where campo like ´%{filtro}%

10. No campo “Ordem do Campo”, informe a sequência na qual o campo será apresentado.

11. Clique em “Salvar”.

12. Sistema apresenta a lista de filtros criados.

13. Caso deseje realizar alterações em determinado filtro, basta clicar no ícone "editar" realizar alteração e clicar no ícone "salvar", realizar a alteração e clique no ícone ** **"salvar" . Caso queira descartar as alterações, clicar no ícone "voltar."

14. Caso deseje apagar um ou mais filtros, clique no ícone "X" para apagar o filtro, ou selecione os filtros que deseja apagar de uma vez clicando no ícone "quadrado" e depois clicando no botão “Excluir selecionados”. (Quando o filtro estiver selecionado o ícone de seleção estará assim "ticado").

BOTÃO "SELECIONAR TODOS - Seleciona todos os filtros BOTÃO "LIMPAR SELEÇÃO" - Desseleciona todos os filtros<P>

Criando agrupamento

Os agrupamentos são usados para compor os agrupamentos das tabelas e dos gráficos.

Passo a passo:

1. Na aba “Agrupamentos”, clique em “Adicionar Agrupamento”

2. Preencha os campos obrigatórios.

3. No campo “Nome”, informe o nome do agrupamento.

4. No campo “Nível do Agrupamento”, informe a sequência na qual o agrupamento será apresentado.

5. No campo “Campo de Plotagem”, selecione o campo que será usado pela tabela e pelo gráfico.

6. No campo “Tipo de Gráfico”, selecione o modelo que deseja apresentar o agrupamento.

7. Caso deseje realizar alterações em determinado filtro, basta clicar no ícone "editar" realizar alteração e clicar no ícone "salvar", realizar a alteração e clique no ícone ** **"salvar" . Caso queira descartar as alterações, clicar no ícone "voltar."

8. Caso deseje apagar um ou mais agrupamentos, clique no ícone "X" para apagar o filtro, ou selecione os filtros que deseja apagar de uma vez clicando no ícone "quadrado" e depois clicando no botão “Excluir selecionados”. (Quando o filtro estiver selecionado o ícone de seleção estará assim "ticado").

BOTÃO "SELECIONAR TODOS - Seleciona todos os agrupamentos
BOTÃO "LIMPAR SELEÇÃO" - Desseleciona todos os agrupamentos

CRIANDO TOTALIZAÇÕES

Passo a passo:

1. Clique na aba “Totalizações”, clique em “Adicionar Totalização”.

2. Preencha os campos obrigatórios.

3. Em “Campo de Totalização”, selecione o campo que será usado para totalização dos gráficos.

4. Clique em “Salvar”.

5. Sistema apresenta a lista das totalizações criadas.

Importante: Para permitir que um gráfico seja renderizado, é necessário o uso de, pelo menos, um agrupamento e uma totalização.

CRIANDO COMANDOS

Passo a passo:

1. Em “Opções Adicionais”, clique na aba “Comandos” e depois clique em “Adicionar Comando”.

2. Preencha os campos obrigatórios.

3. No campo “Nome”, informe o nome do comando.

4. No campo “Momento de Execução”, selecione em que momento o comando deve ser executado: antes ou depois do SQL da consulta.

5. No campo “Ordem de Comando”, informe a sequência em que o comando será realizado.

6. No campo “SQL do Comando”, cole o código SQL do comando.

Importante: Você pode ter apenas uma chamada SQL por comando.

7. Clique em “Salvar”.

8. O sistema apresenta a lista dos comandos criados.

ADICIONANDO RELATÓRIOS

Passo a passo:

1. Em “Opções Adicionais”, clique na aba “Relatórios”, e clique em “Adicionar Relatório”.

2. Selecione o relatório que será usado para imprimir a consulta e clique em “Adicionar”.

3. O sistema apresenta a lista dos relatórios selecionados.<P>

CRIANDO ASSINATURAS ELETRÔNICAS

Webhook Docusign

Serve para executar uma chamada API a algum outro sistema, informando que foi feito um envio.

Passo a Passo:

1. Em “Opções Adicionais”, clique na aba “Assinatura Eletrônica”, e clique em “Adicionar Webhooks Docusign”.

2. Preencha os campos obrigatórios.

3. No campo “Sistema”, selecione o sistema que a chamada API se refere.

4. No campo “Rota API”, informe a rota do sistema selecionado.

5. No campo “Comando SQL pós envio”, cole o código SQL do comando.

6. Clique em “Salvar”.

7. O sistema apresenta a lista de webhooks criados.

Recebedor Docusign

Serve para adicionar quem irá assinar ou quem irá apenas ler o documento docusign.

Passo a Passo:

1. Clique em “Adicionar Recebedor Docusign”.

2. Preencha os campos obrigatórios.

3. No campo “Apenas Visualização”, selecione caso o recebedor apenas irá ler o documento docusign (Opcional).

4. No campo “Nome Signatário”, informe o nome do recebedor.

5..No campo “Email Signatário”, informe o email do recebedor.

6. No campo “Máscara Assinatura”, informe o texto incluído no documento que será substipela assinatura eletrônica.

7..No campo “Ordem de Recebimento”, informe a sequência em que os recebedores serão adicionados.

8..Clique em “Salvar”.

9. O sistema apresenta a lista de recebedores criados.

CADASTRO DE MODELO CAMPOS

Passo a Passo:

1. No menu lateral, clique em “Analytics”, “Configurações”, “Modelos”, e selecione a opção “Campos”.

2. Clique em “Ações” e selecione a opção “Novo Registro”.

3. Preencha os campos obrigatórios.

4. Informe uma pequena “Descrição” do modelo que está sendo criada.

5. No campo “Legenda”, informe o nome do campo.

6. No campo “Nome”, informe o nome do campo conforme o SQL.

7. No campo “Ordem do Campo”, informe a sequência na qual o campo será apresentado.**

8. No campo “Tipo de Formatação”, selecione o tipo de dado do campo.

9. No campo “Alinhamento”, selecione o alinhamento em que o campo será exibido.

10. Clique em “Salvar Campo”.

11. Clique em “Gravar Modelo”.

CADASTRO DE MODELO FILTROS

Passo a Passo:

1. No menu lateral, clique em “Analytics”, “Configurações”, “Modelos”, e selecione a opção “Filtros”.

2. Clique em “Ações” e selecione a opção “Novo Registro”.

3. Preencha os campos obrigatórios.

4. Informe uma pequena “Descrição” do modelo que está sendo criada.

1. No campo “Legenda”, informe o nome do campo para realizar a consulta.

2. No campo “Nome”, informe o nome do campo conforme o SQL.

3. No campo “Tipo”, selecione o tipo de dados do filtro.

4.Para campos do tipo “Combo Pré-Carregado”, informe a consulta SQL que irá gerar as opções do filtro.

5. Para campos do tipo “Combo Pesquisável”, informe a consulta SQL que irá gerar as opções do filtro.

Importante: O campo “value” precisa ser informado no SQL para que a pesquisa possa ser feita.

6. Marque quando o filtro for “Opcional”, “Conjunto de Valores”, ou “Valores Similares”.

Importante: “Conjunto de Valores”: Permite selecionar mais de um valor de um combo. Na interface o filtro aparecerá com um botão "+" ao lado do filtro, permitindo que adicione os valores selecionados numa lista.

Exemplo do SQL:   where campo in ({filtro})

“Valores Similares”: Faz com que o filtro no SQL busque valores aproximados ao informado no filtro.

Exemplo do SQL:   where campo in '%{filtro}%'

7. No campo “Ordem do Campo”, informe a sequência na qual o campo será apresentado.

8. Clique em “Salvar Filtro”.

9. Clique em “Gravar Modelo”.

MENU AÇÕES EM CRIAR E EDITAR CONSULTAS

Passo a passo:

1. Na tela de criação ou edição de consultas, clique em “Ações” e selecione a opção que deseja.

Importar Campo de Modelo

Passo a passo:

1. Selecione a opção “Importar Campos de Modelos”.

2. Selecione o modelo de onde deseja importar os campos.

3. Clique em “Importar”.

4. O sistema informará uma mensagem dizendo se a importação foi feita com sucesso ou não. Em caso de sucesso, ele apresentará os campos importados na aba “Campos”.

Importar Filtros de Modelos

Passo a passo:

1. Selecione a opção “Importar Filtros de Modelos”.

2. Selecione o modelo de onde deseja importar os filtros.

3. Clique em “Importar” .

4. O sistema informará uma mensagem dizendo se a importação foi feita com sucesso ou não. Em caso de sucesso, ele apresentará os filtros importados na aba “Filtros”.

Importar Campos de uma Tabela

1. Selecione a opção “Importar Campos de uma Tabela”.

2. No campo “Tabela”, informe o nome da tabela da qual deseja importar os campos.

3. Clique em “Importar”.

4. O sistema informará uma mensagem dizendo se a importação foi feita com sucesso ou não. Em caso de sucesso, ele apresentará os campos importados na aba “Campos”.

Importar Campos de uma Consulta

Passo a passo:

1. Selecione a opção “Importar Campos de uma Consulta”.

2. No campo “Consulta”, insira a consulta SQL da qual deseja importar os campos.

3. Clique em “Importar”.

4. O sistema informará uma mensagem dizendo se a importação foi feita com sucesso ou não. Em caso de sucesso, ele apresentará os campos importados na aba “Campos”.

LISTAR CONSULTAS

Passo a passo:

1. Na página principal do sistema, clique em “Listar Consultas” ou no menu lateral, clique em “Analytics” “Consultas, e selecione a opção “Lista”.

2. Selecione o sistema da consulta.

3. Selecione o grupo da consulta.

4. Selecione a consulta que deseja, informe os filtros e clique em ”Executar”.

5. O sistema apresenta o resultado em gráfico ou em Tabela.

6. Em “Gráficos”, sistema possibilita, ao passar o mouse, a apresentação dos valores.

7. O sistema apresenta informações dos valores. Para isso, basta clicar com o se no ponto que deseja pesquisar.

Dica: Para voltar no gráfico, clique em “Subir Nível”.

8. Em “Tabela”, sistema apresenta todos os valores da consulta em tabela.

Editando uma Tabela

Passo a passo:

1. Na página principal do sistema, clique em “Listar Consultas” ou no menu lateral, clique em “Analytics”, e então “Consultas”, e selecione a opção “Lista”.

2. Selecione o sistema da consulta.

3. Selecione o grupo da consulta.

4. Ao selecionar a consulta, clique em “Configurar Consulta”, ícone “chave combinada” para visualizar os detalhes da consulta.

5. Clique em “Editar” para editar, incluir ou excluir dados/campos.

6. Realize a alteração, clique em “Gravar Campo” e clique em “Gravar Consulta”.

PERMISSÃO DE ACESSO

Passo a passo:

1. Na página principal do sistema, clique em “Listar Consultas” ou no menu lateral, clique em “Analytics”, e então “Consultas”, e selecione a opção “Lista”.

2. Selecione o sistema de consulta.

3. Selecione o grupo da consulta.

4. Ao selecionar a consulta, clique em Configurar Consulta”, ícone “chave combinada” para visualizar os detalhes da consulta.

5. Coloque o mouse sobre o menu “Ações” e selecione “Permissão Acesso”.

6. O sistema apresenta os dados da consulta e a lista de usuários associados à esta consulta.

7. Em “Perfis do Usuário”, selecione o usuário.

8. Clique em “Incluir”.

Dica: Para remover as permissões de acesso de um usuário, clique no ícone lixeira ao lado do nome daquele usuário.

9. Caso não seja selecionado nenhum “Perfil do Usuário”, todos os perfis estarão permitidos à acessar a consulta, caso um ou mais perfis forem selecionados, a permissão de acesso será concedida apenas para eles.

IMPRIMINDO UMA CONSULTA

Passo a passo:

1. Na página inicial do sistema, clique em “Listar Consultas” ou no menu lateral, clique em “Analytics”, e então “Consultas”, e selecione a opção “Lista”.

2. Selecione o sistema da consulta.

3. Selecione o grupo da consulta.

4. Selecione a consulta, preencha os campos obrigatórios e clique em “Imprimir”.

5. Selecione a opção que deseja visualizar a impressão e clique em “OK”.

6.O sistema Gera um arquivo PDF para impressão.

EXPORTANDO UMA CONSULTA

Passo a passo:

1. Na página inicial do sistema, clique em **“Listar Consultas”**ou no menu lateral, clique em “Analytics”, e então “Consultas”, e selecione a opção “Lista”.

2. Selecione o sistema da consulta.

3. Selecione o grupo da consulta.

4. Na aba “Tabela”, o sistema permite a exportação dos valores apresentado no gráfico para um editor excel (.xls). Basta clicar no botão

5. Selecione a opção que deseja e clique em “OK”.

6. O sistema exporta valores da consulta realizada.

CONSULTAS E RELATÓRIOS

Passo a passo:

1. Na página inicial do sistema, clique em “Consultas e Relatórios”.

2. O sistema apresenta a tela Grupos de Analytics.

DISTRIBUIÇÃO DE CONSULTAS

EXPORTAÇÃO

Passo a Passo:

1. Na página inicial do sistema, no menu lateral, clique em “Analytics”, “Distribuição de Consultas” e selecione a opção “Exportação”.

2. Selecione qual ou quais consultas deseja exportar.

3. Clique em “Exportar”

4. Selecione a opção que deseja e clique em “Ok”

IMPORTAÇÃO

O arquivo a ser importado precisa ser, necessariamente, o mesmo arquivo que foi exportado previamente no analytics.

Passo a Passo:

1. Na página inicial do sistema, no menu lateral, clique em “Analytics”, “Distribuição de Consultas” e selecione a opção “Importação”.

2. Clique no botão “Procurar”.

3. Selecione o arquivo em que estão as consultas que deseja importar e dê um duplo clique no arquivo ou selecione o botão “Abrir”.

4. Clique no botão “Importar”.

Analytics

Adicionar filtros da consulta no Relatório

1. Objetivo/Justificativa:

Os relatórios do STM, por padrão, devem possuir no seu cabeçalho as informações de seleção do usuário quando da sua geração. Isso ocorre devido à complexidade dos relatórios, para orientar o usuário, atendimento e partes interessadas acerca dos filtros, seleções, escolhas que levaram à disposição das informações ali apresentadas.

Nos demais sistemas, ainda que não seja obrigatório, constitui uma boa prática a inserção da informação.

Este documento visa orientar os passos a serem dados, utilizando o Analytics e Analytics Designer para obter, no relatório, as informações de filtro selecionadas.

Importante: O procedimento aqui descrito utiliza a definição de Documento e Relatório, onde a expressão "Documento" refere-se a um report (relatório) desenvolvido que tem como objetivo atender uma demanda documental do cliente (sendo, portanto, um serviço disponibilizado de responsabilidade intelectual do cliente) e a expressão "Relatório" refere-se à disponibilização de informações da base de dados (e consequente interpretação do sistema) que é de resposnabilidade intelectual do Sistema em utilização.

2. Procedimento:

1. Como adicionar o filtro utilizado na visualização do relatório

  1. Quando adicionar a query de filtro no relatório, é necessário inserir a mesma expressão na parte de select (seleção) da consulta.

No exemplo:

Adicione no select os filtros solicitados (com alias):

  1. É necessário adicionar os campos criados no select, para uso posterior no relatório impresso, conforme exemplo:

Nota: Essa inserção vai afetar a apresentação dos dados na consulta, criando colunas com as informações de filtro replicadas.

  1. No Analytics Designer é necessário inserir, na base de dados, os campos relacionados à pesquisa, conforme exemplo:

  1. Já na confecção do report/relatório, basta incluir as querys criadas, conforme exemplo:

A dimensão utilizada para a exibição dos filtros deve ser a menor possível, respeitando a legibilidade do relatório (deve ser possível LER os filtros selecionados no caso de uma eventual impressão).

As informações devem ser dispostas no cabeçalho ou no rodapé, conforme design dos relatórios do sistema e respeitando as suas regras.

STM: No STM as informações precisam ser colocadas, obrigatoriamente, no cabeçalho (como forma de respeitar o design dos relatórios do sistema).

Analytics

Stimulsoft Processamento

1. COMPONENTES DO CABEÇALHO

Ícone de Disquete

Botão representado pelo disquete, serve para salvar o relatório. Na primeira vez que for salvar um relatório irá aparecer algumas informações a serem preenchidas sobre a identificação dele.

Desfazer e Refazer

Botões representados pelas setas direita e esquerda, tem a função de desfazer e refazer a última ação. Sendo o da esquerda para desfazer e o da direita para refazer a última ação.

Arquivo

Ao selecionar o botão "Arquivo", uma nova página irá se abrirá e no menu lateral as seguintes opções:

Novo Relatório

Início

Ao clicar em "Relatório Em Branco", clique em "Início", opção serve para abrir a caixa de ferramentas de formatação, na aba contém janelas de fonte, alinhamento, bordas, formato do texto e estilo.

Importante: A maioria das opções vêm desabilitadas por padrão. Para habilitá-las é necessário selecionar um ou mais componentes.

Inserir

Ao clicar em "Inserir", esta opção abre a aba de componentes do sistema. Nesta aba contém todos os objetos necessários para criar o relatório e deixá-lo funcional.

Página

Ao clicar em "Página", esta aba contém todas as configurações relacionada a página, desde margens à alinhamento dos componentes.

Layout

Esta opção serve para configurar o layout do componente selecionado, como alinhamento e ordem.

Pré-visualizar

Esta opção permite pré-visualizar a parte estática do relatório. Todas as informações fixas e seu respectivo layout serão apresentados.

É possível salvar e imprimir essa pré-visualização em diferentes formatos de arquivos.

2 - Dicionário de Dados

Criando um Dicionário

Passo a passo:

  1. Por padrão, ao iniciar o relatório, a aba de dicionário estará a esquerda do relatório. Caso não esteja, clique no botão “Dicionário”.

  1. Com a aba de dicionário aberta, localize a opção “Novo Item” e clique em “Nova Fonte de Dados”.

  2. Sistema abrirá uma janela com todos os tipos de conexões que podemos utilizar no relatório. Basta selecionar a opção que desejar.

Importante: Para a conexão do analytics iremos utilizar uma específica.

  1. Na seção de objetos, selecione a opção “Dados de DataSet, DataTables”. Sistema apresenta a tela Nova Fonte de Dados, onde será configurado o dicionário. Por padrão do analytics, o campo “Nome da Fonte” pode ser preenchido com o texto de escolha do usuário. Os campos “Nome” e “Apelido” deverão ter o nome de “query”.

Importante: se o nome for diferente, pode haver erros ao trazer os dados para o relatório.

  1. Com os nomes informados, é necessário configurar os campos que o dicionário irá receber das consultas.
  2. Para criar uma nova coluna é necessário clicar no botão a esquerda chamado “Nova Coluna”.

  1. Sistema apresenta as configurações para a coluna. Utilize o mesmo nome nos campos: "Nome na Fonte", "Nome" e "Apelido" e informe o Tipo da coluna que irá criar.

Importante: No campo “Tipo” temos os tipos que podem ser nulos e os que não podem ser nulos. Se na sua consulta tiver uma coluna que não traz nenhum dado, é necessário colocar como um tipo que pode ser nulo.

  1. O nome utilizado para preencher a configuração da coluna pode ser encontrado no código sql da consulta e será o mesmo que retorna na coluna quando o código é executado.

  2. Se a consulta estiver finalizada no analytics, na página de detalhes na parte de campos, pode-se copiar o texto localizado na última coluna da tabela.

  1. Após configurar todas as colunas, clique em "OK" e seu dicionário estará criado.

Editando um Dicionário

Passo a passo:

Analytics

Desenvolvimento de Gráficos - Cebi Analytics

Para que serve?

Demonstrar visualmente de forma que seja facilmente compreensível as informações de um certo conjunto de valores.

Onde utilizar?

Qualquer base (Desenvolvimento / Release / Master ou Produção) que tenha a publicação do Analytics.

Como utilizar?

1º Passo: A consulta

Para que se tenha um conjunto de valores para a montagem do gráfico, é necessário que uma consulta exista e que a mesma esteja funcionando totalmente. No nosso exemplo utilizaremos uma consulta de contas existentes entre 01/2020 e 10/2020 e exibiremos os valores totais de cada mês. Ex. consulta:


SELECT LPAD(C.CTA_MES_REF_CTA, 2, '0') || '/' || C.CTA_ANO_REF_CTA AS referencia_conta,
        SUM(C.CTA_VLR_AGU + C.CTA_VLR_ESG) AS total_conta,
        DECODE(C.CTA_DTA_PGT, NULL, 'Conta não paga', 'Conta paga') AS conta_paga
  FROM SSB.CONTAS C
 WHERE C.CTA_MES_REF_CTA BETWEEN 1 AND 10
AND C.CTA_ANO_REF_CTA = 2020 
GROUP BY LPAD(C.CTA_MES_REF_CTA, 2, '0') || '/' || C.CTA_ANO_REF_CTA,
DECODE(C.CTA_DTA_PGT, NULL, 'Conta não paga', 'Conta paga')
ORDER BY LPAD(C.CTA_MES_REF_CTA, 2, '0') || '/' || C.CTA_ANO_REF_CTA DESC

Tradução consulta Obtenha (SELECT) os campos “referencia_conta”, “total_conta” e “conta_paga” da tabela de (FROM) “CONTAS” onde (WHERE) o mês da conta esteja entre (BETWEEN) 1 e (AND) 10 e (AND) o ano da conta seja igual a 2020. Agrupe o resultado pelos campos (GROUP BY) “referencia_conta” e “conta_paga” e ordene o resultado pelo campo (ORDER BY) “referencia_conta” de forma decrescente (DESC).

Obs: A palavra AS na consulta serve para dar nome aos campos, ou seja, ao invés de trazer o nome “LPAD(C.CTA_MES_REF_CTA, 2, '0') || '/' || C.CTA_ANO_REF_CTA” no retorno da consulta, o nome do campo vem como “referencia_conta”, facilitando o entendimento e a manipulação futura dos campos.

Obs 2: A palavra DECODE na consulta é utilizado com a mesma finalidade de um operador lógico IF da programação, podendo ser lido da seguinte maneira: Se o campo “CTA_DTA_PGT” (Data de pagamento da conta) estiver vazio no banco (NULL) traga a seguinte descrição no retorno: “Conta não paga”,se não, traga a descrição: “Conta paga”.]

Obs 3: A palavra LPAD na consulta é utilizada para realizar o preenchimento do campo mês com 2 caracteres tendo 0s a esquerda (LPAD é uma função do PL/SQL e foi parametrizada para retornar essa configuração neste caso), ou seja, se no retorno o mês vier igual a 1 (Janeiro) ele será exibido como 01.

Obs 4: A palavra SUM na consulta é utilizada para realizar o somatório dos registros retornados, ou seja, se na referência 01/2020 vier duas contas pagas de valor R$ 25,00, na tela será exibido o valor de R$ 50,00 somados pela função SUM.

Importante: Obs 5: Para o total funcionamento do gráfico, os nomes configurados depois do AS devem vir com o seguinte padrão: todas as letras em minúsculo e com underline (_) separando cada palavra. Exemplo: Total da conta --> TotalConta --> total_conta.

Exemplo da execução dessa consulta no PL/SQL na base Dev01:

image-1710788305439.png

2º Passo: Configuração Básica Analytics

Após a montagem da consulta desejada é necessário realizar a configuração da mesma no sistema do Analytics. Nesse ponto iremos criar uma consulta básica, sem relatório (designer) e sem filtros, apenas importando os campos básicos do retorno (atentar-se com os tipos de formatação dos campos).

Ela será criada no sistema “Balcão SSB” e será colocada o grupo “Teste”:

Entrando na criação da consulta

  1. Ao entrar no Balcão SSB, sistema apresenta tela do Cebi Analytics. Clique na opção "Listar Consulta"*

  1. Selecione o sistema "Balcão SSB".

  1. No botão "Ações", clique em "Novo Registro".

  1. Preencha os campos obrigatórios com as informações básicas da consulta.

3º Passo: Configuração Gráfico

Para que a consulta plote (monte e exiba) um gráfico, é necessário realizar algumas configurações específicas dentro do Analytics.

  1. Primeiro configuraremos o nosso “Tipo de Renderização” para o valor “Tabela e Gráfico”, dessa forma o Analytics entenderá que a consulta em si não será apenas para exibição em tabela do resultado final, mas também, da exibição de um gráfico.

  1. Após a configuração do “Tipo de Renderização” nós iremos configurar a aba “Agrupamentos”.

Para que serve a aba “Agrupamentos”?

Os Gráficos nada mais são que um conjunto de valores agrupados por uma informação específica, um tipo específico. Nessa aba de agrupamentos nós iremos juntar as informações com o que é desejado para que o gráfico funcione como o esperado.

Como nós queremos exibir no nosso gráfico o total das contas separadas por referência, ou seja, o total das contas de 01/2020, depois o total de 02/2020 e assim por diante, o retorno da nossa consulta deve estar agrupado por referência.

Para isso, entraremos na aba “Agrupamentos” e adicionaremos um novo agrupamento clicando no botão “Adicionar Agrupamento”:

Preencha os campos obrigatórios, onde:

Nome --> Nome do agrupamento;

Nível do Agrupamento --> É possível ter mais de um gráfico dentro da consulta. Os níveis nada mais são do que a posição desses gráficos referente a consulta, ou seja, qual é exibido primeiro, qual está dentro de qual e assim por diante;

Campo de Plotagem --> Qual o campo que será utilizado para realizar o agrupamento do gráfico, nesse primeiro instante utilizaremos o campo “Referência”;

Tipo de Gráfico --> Como estamos criando um gráfico, esse campo é obrigatório para preenchimento e deve ser parametrizado conforme a necessidade de exibição. Nesse campo nós informamos o estilo visual do gráfico, se ele será de barras, linhas.

  1. Na tela "Incluir novo agrupamento", clique no botão "Salvar".

  1. Após a configuração dos “Agrupamentos” nós iremos configurar a aba “Totalizações”.

Para que serve a aba "Totalizações"?

As totalizações servem para indicar qual será o resultado exibido dos agrupamentos, ou seja, quais os totais exibidos no gráfico.

No nosso exemplo, nós queremos exibir o valor total das contas por referência, logo, o nosso campo de totalização deverá ser o “total_conta”.

  1. Na tela "Campos e Filtros", clicar na aba “Totalizações” e adicionar uma nova totalização. clique no botão “Adicionar Totalização”.

  1. Preencha os campos obrigatórios, onde:

Campo de Totalização --> Resultado que será exibido no gráfico após a realização dos agrupamentos.

Importante: Até a versão utilizada para a criação deste documento, só são aceitas totalizações de campos de tipo “Numérico”, outros tipos de campos farão com que o gráfico não apareça.

  1. Após a configuração das “Totalizações”, na tela "Opções Adicionais", finalize a criação da consulta clicando em “Gravar Consulta”:

4º Passo: Testar o Gráfico

  1. Após realizar os passos anteriores, nós teremos a consulta inteiramente configurada e pronta para a sua execução. Selecionaremos ela na lista de consultas do grupo criado (Teste) e a executaremos para ver se tudo ocorreu como esperado. Na tela "Consultas", clique na consulta desejada.

  1. Clique no botão "Executar" para executar o desenvolvimento do gráfico.

  1. Sistema apresenta o resultado do gráfico.

Importante:

Obs: Fazendo o gráfico dessa forma não fará com que ele seja impresso no relatório (designer) caso exista um. Os gráficos impressos nos relatórios são colocados dentro do próprio designer e têm um outro estilo de configuração totalmente diferente desse.

Obs 2: É possível criar outros gráficos baseados em gráficos existentes na mesma consulta.

Além de exibir um gráfico com o total das contas divididas por referência, exibir também quais contas dessas referências estão pagas ou não.

  1. Para criar um novo nível de agrupamento na consulta já existente, fazendo com que as contas além de serem agrupadas por referência, sejam agrupadas também por “**Conta não paga” e “**Conta paga”.

  1. Na tela "Campos e Filtros", clique na aba "Agrupamentos" e clique no botão "Adicionar Agrupaentos".

  1. Na tela "Incluir novo Agrupamento", preencha os campos obrigatórios e clique em "Salvar".

  1. Sistema apresenta as consultas do agrupamento. Clique em "Gravar Consulta".

  1. Sistema apresenta o resultado da consulta. Ao clicar sobre uma coluna de qualquer referência, teremos discriminados os valores totais de contas pagas e de contas não pagas.

Desenvolvido por: João Lorente (JP)

Versão utilizada: 2024.2.19.0

Base utilizada: Dev 01

Data: 10/03/2024

Analytics

Cadastro de consultas - Inclusão e edição de consulta

Introdução

A criação de nova consulta é o primeiro passo para iniciar o uso do sistema. Sem consultas, não é possível utilizar outra funcionalidade do Analytics. Para acessar, use o menu lateral (Consultas -> Criar) ou navegue pela lista de consultas, selecione um sistema ou grupo, clique no menu "Ações" e em "Novo Registro"

Importar consultas (inserir link para a importação de consultas) é uma alternativa, mas requer que consultas já tenham sido criadas em outro ambiente.

Já a edição de consulta é acessada ao selecionar uma consulta, e no canto direito superior do quadro azul, clicar no botão de edição.

Como incluir uma consulta

O mínimo necessário para incluir uma consulta é preencher os campos obrigatórios e incluir ao menos um campo de exibição na consulta.

Dados da consulta

Esta seção se refere aos dados básicos da consulta. Abaixo um detalhamento do que é cada campo:

Campos, filtros, agrupamentos e totalizações

Esta seção se refere aos cadastros auxiliares à consulta. Apenas o cadastro de campos é obrigatório, é preciso pelo menos um registro.

Campos

O cadastro de campos se refere ao que será exibido na tabela após a execução da consulta. Abaixo um detalhamento do que significa cada propriedade do campo:

Para criar um campo manualmente, clique em "Adicionar campo". Para importar os campos baseado no SQL informado, clique no botão "Importar campos do SQL". Ao selecionar a importação, aparecerão algumas opções. Abaixo um detalhamento do que significam:

Para editar um campo, selecione o botão de edição (amarelo) na lista de campos. A edição é feita na própria tabela, alterando as informações do campo.

Para excluir um campo, aperte de exclusão (vermelho) na lista de campos e confirme a operação. Alternativamente, é possível selecionar múltiplos campos para uma exclusão em conjunto.

Analytics

Cadastro de consultas - Listagem de consultas

Introdução

A listagem de consultas é o principal caminho para acessar qualquer consulta cadastrada no Analytics. É possível acessar através da página principal, pelo botão "Listar Consultas" ou através do menu do sistema (Consultas -> Lista).

Acessos rápidos é uma alternativa mais rápida para acessar diretamente uma consulta. Leia mais a respeito clicando aqui (inserir link para acesso rápido)

Lista de sistemas

Primeiramente, selecione o sistema a qual a consulta pertence. Nesta lista, aparecerão apenas os sistemas que tenham ao menos uma consulta cadastrada, portanto é normal que um sistema sem consultas não apareça aqui.

Lista de grupos

Após selecionar um sistema, será exibida a lista de grupos do sistema. Este grupo é determinado no cadastro da consulta, no campo "Grupo". As consultas serão agrupadas de acordo com o nome informado no cadastro, então selecione o grupo a qual sua consulta pertence.

Também é possível criar uma nova consulta a partir desta página, acessando o menu "Ações" no canto direito superior. Usando este caminho, a nova consulta virá com o campo "Sistema" preenchido por padrão com a informação selecionada na listagem anterior.

Lista de consultas

Com o sistema e o grupo selecionados, será exibida a lista de consultas relacionadas. Basta selecionar uma para poder executar ou editar.

Também é possível criar uma nova consulta a partir desta página, acessando o menu "Ações" no canto direito superior. Usando este caminho, a nova consulta virá com os campos "Sistema" e "Grupo" preenchidos por padrão com as informações selecionadas nas listagens anteriores.

Login ID Server

ARQ - Manual de Procedimentos e Operações.

Login ID Server

Manual de autenticação de sistema - Interno

Introdução

Este documento tem o objetivo de descrever os passos necessários para possibilitar a autenticação de uma aplicação externa ao “Cebi.Login”, sendo este a estratégia oficial da Cebi para autenticação única, apoiada na aplicação open source chamada IdentityServer.

Importante: este manual é apenas para uso interno e NÃO deve ser distribuido a clientes. Existe um manual a parte, mais enxuto e que pode ser distribuido a clientes para uso externo.

Grant Types

Existem alguns tipos de concessão de acesso que são suportados pelo IdentityServer, entre eles: Implicit, Resource Owner Password e Client Credentials. As duas primeiras são úteis para obter acesso à uma aplicação em nome de um usuário, porém, obviamente neste caso seria necessário informar o login e senha no momento de solicitar um token de acesso.

Considerando um cenário onde não há uma tela de autenticação, como por exemplo numa chamada via aplicação console ou até mesmo via PL/SQL, o tipo de concessão mais recomendado é o Client Credentials pois permite solicitar um token de acesso em nome de um cliente (aplicação) e não de um usuário. Portanto, esse será o tipo de concessão utilizado neste tipo de situação.

Criação do Cliente no IdentityServer

A primeira coisa a ser feita é a criação do cliente que será utilizado na autorização. Quando o token for solicitado, o IdentityServer tentará localizar um cliente com o nome informado no parâmetro ‘client_id’.

Para criar um novo cliente, utilize o programa Cebi.Util.GerenciamentoIntegracoesApi (localizado no BitBucket) ou fale com a equipe de arquitetura.

O programa vai solicitar alguns dados, o nome do usuário do cliente (recomendamos o padrão camelCase) e o nome amigável do cliente. Ele retornará o usuário e senha gerados, assim como o script de criação do mesmo, para execução na base de testes e na base do cliente.

Importante: O programa indicado ou a equipe de arquitetura NÃO mantém um controle dos usuários, senhas e SQLs criados pelo programa. Cada equipe é responsável pelo seu próprio controle

Criação manual do cliente no IdentityServer

Abaixo um exemplo de um registro criado na tabela ID_CLIENTS:

Campo Valor
ID (AUTO)
ENABLED 1
CLIENT_ID oracle.plsql (exemplo)
CLIENT_NAME Oracle PL/SQL (exemplo)
CLIENT_URI (NULL)
REQUIRE_CONSENT 0
ALLOW_REMEMBER_CONSENT 1
ALLOW_ACCESS_TOKENS_VIA_BROWSE 1
FLOW 3
ALLOW_CLIENT_CREDENTIALS_ONLY 0
LOGOUT_SESSION_REQUIRED 0
REQUIRE_SIGN_OUT_PROMPT 0
ALLOW_ACCESS_TO_ALL_SCOPES 1
IDENTITY_TOKEN_LIFETIME 3600
ACCESS_TOKEN_LIFETIME 3600
AUTHORIZATION_CODE_LIFETIME 3600
ABSOLUTE_REFRESH_TOKEN_LIFETIM 0
SLIDING_REFRESH_TOKEN_LIFETIME 3600
REFRESH_TOKEN_USAGE 0
UPDATE_ACCESS_TOKEN_ON_REFRESH 0
REFRESH_TOKEN_EXPIRATION 1
ACCESS_TOKEN_TYPE 0
ENABLE_LOCAL_LOGIN 1
INCLUDE_JWT_ID 0
ALWAYS_SEND_CLIENT_CLAIMS 1
PREFIX_CLIENT_CLAIMS 0
ALLOW_ACCESS_TO_ALL_GRANT_TYPE 0

Criação manual das senhas do cliente

Deve-se criar uma ou mais senhas para o cliente cadastrado no passo anterior. Segue abaixo exemplo de registro a ser criado na tabela:

Campo Valor
ID (AUTO)
VALUE K7gNU3sdo...
TYPE SharedSecret
Client_Id (ID do registro criado anteriormente)

A senha deve ser gerada usando criptografia SHA256 + BASE64. No exemplo acima, a senha ‘secret’ foi transformada para ‘K7gNU3sdo+OL0wNhqoVWhr3g6s1xYv72ol/pe/Unols=’. Para gerar senhas diferentes, você pode usar o site: https://approsto.com/sha-generator.

A senha deve terminar em "=".

Criação manual dos escopos

Neste passo, deve-se criar o escopo relacionado ao recurso que desejado. Em tese, este item já deverá existir pois do contrário, este recurso não estaria disponível para os usuários que acessam o recurso via aplicação web. De qualquer maneira, estará aqui para que faça sentido a sua utilização na requisição do token que virá a seguir. Segue abaixo exemplo de registro da tabela ID_SCOPES:

Campo Valor
ENABLED 1
NAME Cebi.Api
DISPLAY_NAME Api's CEBI Informática
DESCRIPTION Permite o acesso às API's da CEBI Informática
REQUIRED 0
EMPHASIZE 0
TYPE 1
INCLUDE_ALL_CLAIMS_FOR_USER 1
CLAIMS_RULE (NULL)
SHOW_IN_DISCOVERY_DOCUMENT 1
ALLOW_UNRESTRICTED_INTROSPECTI 0

Requisição do token

Após a criação dos registros necessários na base de dados do IdentityServer, podemos então fazer a requisição do token. Segue abaixo um modelo de chamada HTTP.

Ou, num formato mais técnico:

POST /login/connect/token HTTP/1.1
Host: win13.cebisist:20003
User-Agent: PostmanRuntime/7.16.3
Accept: */*
Cache-Control: no-cache
Content-Type: application/x-www-form-urlencoded
Accept-Encoding: gzip, deflate
Content-Length: 90
Connection: keep-alive
cache-control: no-cache
grant_type=client_credentials&client_id=oracle.plsql&client
_secret=secret&scope=Cebi.Api

Resultado

Requisição de serviço

Uma vez que o token de autenticação tenha sido recebido, basta fazer a requisição ao serviço desejado, informando o token no cabeçalho de autorização (Authorization: Bearer ). Veja exemplo de requisição:

GET /usuarios/api/appinfo HTTP/1.1
Host: win13.cebisist:20003
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUz...
User-Agent: PostmanRuntime/7.16.3
Accept: */*
Cache-Control: no-cache
Accept-Encoding: gzip, deflate
Connection: keep-alive
cache-control: no-cache

Observação: Não será colocado um exemplo de resposta pois ela varia de acordo com o serviço solicitado.

Observações finais

Ausência de dados do usuário

Vale lembrar que neste modo de autenticação, estamos fazendo um acesso em nome de um cliente (aplicação) e não de um usuário. Portanto, dados como “login” ou “usuário_id” não estão disponíveis no token. Portanto, o serviço (API) deve considerar essa situação e atuar de acordo com a requisição.

Autorização do cliente

A versão 1.2.6 ou inferior, possuía um filtro chamado CebiPerfilAuthorize que verificava se o usuário possuía privilégio para acessar o recurso desejado (rota). No entanto, para o cenário em que a requisição é feita por uma aplicação externa, usando um token que não possui dados de usuário, o filtro retornava o erro “Não foi possível identificar o usuário”. Por esta razão, foi feita uma modificação no filtro para verificar se o cliente que possui o token tem acesso à aplicação requisitada. Para que isso funcione corretamente, é necessário atualizar o pacote Cebi.Util.WebApi para a versão 1.2.7 e tornar explícito a autorização de acesso para o cliente desejado. Segue abaixo exemplo de como isso pode ser feito:

using Cebi.Permissoes.Dal;
using Cebi.Permissoes.Domain.Services;
.
.
namespace Cebi.Usuarios.Api.Services
{
    public class ConfiguradorFuncionalidadesUsuariosService : IConfiguradorFuncionalidades
    {
        public void CarregarFuncionalidades()
        {
        // <Código necessário para carregar as funcionalidades>
        }

        public void MapearPermissoes()
        {
            var unit = new PermissoesUnitOfWork();
            var mapearPermissoesService = new MapearPermissoesService(unit);
            var permissoes = mapearPermissoesService.Executar();

            CebiPerfilAuthorizeAttribute.FuncionalidadesAutorizadas = permissoes;

            // Aqui vai o código para autorizar os clientes desejados.
            CebiPerfilAuthorizeAttribute.ClientesAutorizados = new List<string>
            {
                "oracle.plsql"
            };
        }

        public List<string> ObterPermissoes()
        {
            // <Código necessário para listar as permissões>
        }
    }
}
Login ID Server

Manual de autenticação de sistema - Externo

Introdução

Este manual contém as instruções necessárias para um cliente externo se autenticar no ambiente Cebi, obtendo um token para uso nas demais aplicações de nosso ERP.

Requisição

A requisição HTTP de autenticação deve ter o seguinte formato:

Resultado

Com o token em mãos, ele poderá ser usado para acessar outras requisições no ambiente Cebi.

Requisitos para recebimento de pedidos externos

Neste capítulo são descritos os requisitos mínimos para o recebimento de Prestações de Serviços, Requisições de Mudança e Incidentes originais de outras equipes para o desenvolvimento da arquitetura.

Requisitos para recebimento de pedidos externos

Prestações de serviço

Introdução

Serão descritos aqui os requisitos para prestações de serviço, separados por produtos. Os produtos denominados "Sistemas Web" agrupam os requisitos genéricos que são válidos para o grupo todo. Produtos com requisitos específicos serão descritos separadamente.

Qualquer PS que falhe em ter estes requisitos deve ser imediatamente devolvida e corrigida por parte do remetente.

Este documento contém um glossário. Consulte-o para conhecer as terminologias utilizadas (quando em itálico, constará no glossário).

Importante: Algumas prestações de serviço podem ter mais de um serviço solicitado ao mesmo tempo, desde que todos os requisitos mínimos de todos os serviços solicitados estejam adequados.

Toma-se como base para todos os produtos abaixo as seguintes regras:

Abaixo constam algumas regras específicas para determinados produtos e serviços. Os exemplos mencionados podem ser usados como embasamento para casos que não constem neste documento.

DevOps

Bitbucket

Jenkins

Importante: para casos de verificação de erro de build a PS deve, necessariamente, ter passado por um desenvolvedor responsável e o mesmo deve incluir na solicitação o que ele já verificou/fez, pois muitas vezes, o erro é de compilação.

ProGet

Bibliotecas

Importante: para casos de verificação de erro em bibliotecas a PS deve, necessariamente, ter passado por um desenvolvedor responsável e o mesmo deve incluir na solicitação o que ele já verificou/fez, pois muitas vezes o erro é mau uso ou configuração incorreta.

Padronizações e procedimentos

Criação/alteração de documentação

Estudo de novo plugin

Design de aplicações

Suporte ao design

Sistemas Web da Arquitetura

Este tópico é válido para os seguintes sistemas: Administração; Analytics; Analytics Designer; Gerador de códigos; Login Identity Server; Login OpenIddict; Cadastro de pessoas Cebi (novo cadastro de pessoas); Usuários;

Requisições fora do escopo da equipe

Analytics

Glossário

Requisitos para recebimento de pedidos externos

Requisições de mudança

Serão descritos aqui os requisitos para requisições de mudanças, separados por produtos. Os produtos denominados "Sistemas Web" agrupam os requisitos genéricos que são válidos para o grupo todo. Produtos com requisitos específicos serão descritos separadamente.

Qualquer RM que falhe em ter estes requisitos deve ser imediatamente devolvida e corrigida por parte do remetente.

Este documento contém um glossário. Consulte-o para conhecer as terminologias utilizadas (quando em itálido, constará no glossário).

Toma-se como base para todos os produtos abaixo as seguintes regras:

Requisitos para recebimento de pedidos externos

Incidentes

Introdução

Serão descritos aqui os requisitos para incidentes, separados por produtos. Os produtos denominados "Sistemas Web" agrupam os requisitos genéricos que são válidos para o grupo todo. Produtos com requisitos específicos serão descritos separadamente.

Qualquer IC que falhe em ter estes requisitos deve ser imediatamente devolvido e corrigido por parte do remetente.

Este documento contém um glossário. Consulte-o para conhecer as terminologias utilizadas (quando em itálico, constará no glossário).

Toma-se como base para todos os produtos abaixo as seguintes regras:

Abaixo constam algumas regras específicas para determinados produtos e serviços. Os exemplos mencionados podem ser usados como embasamento para casos que não constem neste documento.

Bibliotecas

Login OpenIddict



ARQ - Manual de Procedimentos e Operações.

Login OpenIddict

Manual de autenticação de sistema - Externo

Introdução

Este manual contém as instruções necessárias para um cliente externo se autenticar no ambiente Cebi, obtendo um token para uso nas demais aplicações de nosso ERP.

Requisição

A requisição HTTP de autenticação deve ter o seguinte formato:

Resultado

Com o token em mãos, ele poderá ser usado para acessar outras requisições no ambiente Cebi.

Usuários

ARQ - Manual de Procedimentos e Operações.

Usuários

Como criar um usuário interno

Introdução

O objetivo desse documento é explicar como é criado um usuário no sistema Usuários da CEBI. Faz-se necessário para uso de tarefas do dia a dia do cliente no que agrega a incluir um usuário novo e dar permissões específicas para que o mesmo faça uso dos sistemas web. O interessado desse documento são todos aqueles cuja necessidade seja criar sob demanda do seu cliente.

Pré-requisitos

Para criar via interface é necessário que:

Com todas os requisitos prontos podemos iniciar o tutorial.

Passo a Passo

1. Acessando o sistema;

Utilizando do sufixo /usuarios após a URL do cliente em questão

Exemplo:

2. Navegando até a seção de usuários;

OBS.: Existem duas possibilidades de menu lateral para acessar:

2.1 Menus do usuário:

a. Clique em "Geral"

b. Clique em "Controle de Usuários"

c. Clique em "Usuários Internos"

A tela acima foi censurada para proteger os dados dos nossos clientes.

Ao clicar em usuários internos será direcionada para uma tela semelhante a mostrada acima.

d. No canto superior direito temos o botão "Ações" e ao passar o mouse em cima temos a opção "Novo Registro"

Resultado: A tela que aparecerá é a tela de inclusão de usuários;

2.2 Menus do sistema;

Nesse caso é mais simples, ele estará direto no passo b em diante;

Menu do sistema acima;

3. Inserindo as informações do usuário;

Os campos a serem preenchidos com as informações solicitadas no requisito.

Clicando na lupa azul no canto direito do campo

Com os campos preenchidos:

Clique em "Gravar

4. Primeiro acesso;

Ao gravar, um e-mail é enviado para o usuário para a ativação da conta.

O usuário vai criar sua senha

Obs.: Por questão de segurança do usuário o primeiro acesso é preferível ser feita pelo mesmo, podendo ser identificado se o mesmo o fez ou não pelo sistema. Para saber se foi feito ou até mesmo para solução de problemas caso o email não tenha chegado na caixa de entrada é possível verificar pelo caminho:

Na lista de usuários internos

Busque o usuário recém-criado na caixa "Pesquisar" que fica no canto superior direito da lista de usuários

Localize o mesmo e clique no link em azul no campo "login"

A tela que abrirá será das configurações do usuário.

Na aba de "Detalhes do Usuário" existe a informação "primeiro acesso" e nela indica se o usuário já acessou a primeira vez. A flag ficará "Primeiro acesso: Sim" depois do processo anterior de criar a senha.

Caso o e-mail não foi para a caixa de entrada do usuário por algum motivo como estar digitado errado, é possível reenviar o e-mail do primeiro acesso.