Primeiro commit da parte da documentação do sistema da verita

README.md

@@ -0,0 +1,131 @@
+# PABX-pesquisa
+
+Sistema de pesquisa com discador usado pela Veritá <br>
+**Índice**<br>
+
+- [PABX-pesquisa](#pabx-pesquisa)
+  - [Fluxo do Sistema Macro](#fluxo-do-sistema-macro)
+    - [Saída Campanha](#saída-campanha)
+    - [Entrada Campanha](#entrada-campanha)
+  - [Subir uma capanha para o discador](#subir-uma-capanha-para-o-discador)
+    - [Página lista Discador](#página-lista-discador)
+    - [1 Selecionar tipo para visualizar](#1-selecionar-tipo-para-visualizar)
+    - [2. Upload os número da próxima pesquisa.](#2-upload-os-número-da-próxima-pesquisa)
+    - [3. Configuração de campanha](#3-configuração-de-campanha)
+    - [4. Configurações do banco do discador](#4-configurações-do-banco-do-discador)
+    - [5. Números em ligações](#5-números-em-ligações)
+    - [6. Informações da lista no discador](#6-informações-da-lista-no-discador)
+  - [Cadastrar uma pesquisa](#cadastrar-uma-pesquisa)
+    - [Tela cadastro de pesquisa](#tela-cadastro-de-pesquisa)
+
+## Fluxo do Sistema Macro
+
+![Fluxo de pesquisa](doc/context-pabx-pesquisa.png)
+
+### Saída Campanha
+
+1. Pabx-Simples IP faz upload com lista de números para Discador (Menu: Discador -> Lista Discador -> NOVO ARQUIVO)
+2. O discador recebe o a lista (com id das pesquisas) e a permissão para começar a ligações através do AMI com um número de um RAMAL que está fazendo a ligação.
+3. Isabel recebe esses comandos e executa fazendo a ligação para o número (celular e etc) que discador mandou via AMI com número do ramal.
+4. O ligação sai para chegar ao número externo através da operadora.
+5. Verifica o numero do ramal para conecta-lo a chamada
+
+### Entrada Campanha
+
+1. O isabel recebe o número do ramal(Que o discador informou) e tenta conecta-lo a chamada
+2. No Isabel está definida a rota 9XXX para o tronco no pabx
+3. isabel redireciona para esse tronco que será para entrada do pabx
+4. Verifica se esse número é válido para entrada
+5. PABX envia para ação (Integração ativa -> PESQUISA-GATEWAY-GATEWAY)
+6. PABX recebe a ligação que o discador fez e executa todos as operações da chamada para pesquisa
+
+---
+
+## Subir uma capanha para o discador
+
+Menu para acessar a tela do discador.<br />
+![menu discador](doc/menu_discador.jpg)
+
+### Página lista Discador
+
+![menu discador](doc/lista_discador.png)
+
+### 1 Selecionar tipo para visualizar
+
+- Ativos - Campanhas que o discador está ativa. Ela pode estar ativa mesmo que todos os números já tenham sido discado.
+- Inativos - Campanhas que estão no discador, mas inativas. Pausadas.
+- Pesquisa - Querer ver uma pesquisa específica
+
+### 2. Upload os número da próxima pesquisa.
+
+![menu discador](doc/novo_arquivo_camapanha.png)<br>
+Selecione para a Verita, informe a separação do arquivo;
+Exemplo de arquivo:
+
+```
+999000028,330|CUIABA|MT|BAIRRO
+992000017,330|CUIABA|MT|BAIRRO
+```
+
+330 é o número da campanha.
+
+### 3. Configuração de campanha
+
+![menu discador](doc/conf_campanha.png)
+
+- Login - Não deve ser modificado o login no discador
+- Ramal 9000 o Isabel tem uma rota 9XXX
+- Máximo de chamadas - Máximo de chamadas em simultanea o king irá fazer
+- Tempo Ring - tempo de ring sem resposta
+- Iniciar Pausa - Inciar a chamada logo que o arquivo seja enviado. Cao esteja desmarcado, a capanha começara pelo grupo inativo
+- Fluxo - Não especificado (?)
+- Qtd. Rediscagem - quantidade de vezes que o king vai rediscar a campanh para números não sucesso, naço atendidas.
+- Intervalo Chamadas - Ainda não verificado
+- Chamadas Agentes - ainde não verificado
+
+### 4. Configurações do banco do discador
+
+![menu discador](doc/banco_king.png)<br>
+Configurações do banco de dados king
+
+### 5. Números em ligações
+
+![menu discador](doc/numero_discados.jpg)
+
+Números que estão em ligação neste momento.
+
+- Agente - Não especificado(?)
+- Ramal - número que o isabel está integrado para pabx na rota entrada
+- camapnha - número da pesquisa
+- número - número que o king está discando da campanha
+- Nome - nome informado do número
+- código - não especificado (?)
+- Duração - Tempo que a ligação está ocorrendo
+- Discagem - Número de vezes que aquele número foi discado
+
+### 6. Informações da lista no discador
+
+![informações da lista no king](doc/info_lista_discador.jpg)
+
+Informação da lista de números no discador:
+
+- ID - Informação de banco
+- RAMAL - Ramal que discador vai usar AMI para dizer qual número está ligando. No isabel tem uma rota 9XXX
+- NOME - Nome da campanha
+- PENDENTE - Quais número de telefone o discador ainda fez a chamada pelo AMI
+- PROCESSANDO - Os números que estão sendo processados na ligação
+- SUCESSO - Quantidade de números de telefone que conseguiu antender (pode ter caixa postal)
+- SEM SUCESSO - Números que não foi possível receber resposta (não conseguiu ligar, não atendeu, ocupado e etc)
+- TOTAL - Quantidade de números totais processados
+- AÇÃO - 1ª ícone pausar ou play na campanha. 2ª configuração de campanha [link](#3-configuração-de-campanha) e a liberação é semelhante ao título liberação.
+
+---
+
+## Cadastrar uma pesquisa
+
+Menu de Pesquisa <br>
+![menu-pesquisa](doc/menu-pesquisa.png)
+
+### Tela cadastro de pesquisa
+
+![tela-cadastro](doc/tela-cadastro-pesquisa.png)

doc/context-pabx-pesquisa.puml

@@ -0,0 +1,28 @@
+@startuml context-pabx-pesquisa
+!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
+HIDE_STEREOTYPE()
+
+AddRelTag("teste_raoriginada pelo Simples Simples IP", $textColor="red", $lineColor="red")
+AddRelTag("api", $textColor="green", $lineColor="green")
+AddRelTag("campanha", $textColor="blue", $lineColor="blue")
+AddElementTag("Inicio_fluxo", $fontColor="yellow", $borderColor="#999000")
+
+Person(ligação_externa,"Receber a ligação")
+System(pabx, "PABX Simples IP", "Servidor: 192.168.115.67", $tags="Inicio_fluxo")
+System_Boundary(c1, "Servidor 192.168.115.98"){
+    System(isabel, "PABX Isabel", "")
+    System(king, "Discador King Dialer", "Ligação através do manager (AMI)")
+}
+System(servidor_2, "Operadora", "")
+
+
+Rel_L(isabel, pabx, "Entrega chamada - rota 9XXX (isabel)", "Entrada", $tags="teste_ramal")
+BiRel(isabel, servidor_2, "", "Saida EXTERNA")
+BiRel_U(servidor_2, ligação_externa, "", "Saida EXTERNA")
+Rel(king, isabel, "faz  as  ligação  pelo  Manager (AMI)", "manager", $tags="campanha")
+Rel_U(pabx, king, "API  subir  campanha", "Menu: Discador -> Lista Discador", $tags="api")
+
+
+SHOW_LEGEND()
+
+@endumlP