Configurando ações externas para automatizar scripts no Tactium IP URA

---

Objetivo

Este documento visa explicar sobre as configurações de ações externas dentro do Tactium IP – IVR Manager, destacando as particularidades de cada tipo de ação externa.

Visão geral

As ações externas são programas ou funções que são executadas por programas de terceiros de forma a integrar o resultado de suas execuções ao Tactium IP URA e dessa forma realizar ações que não são nativas da ferramenta.

Para realizar o cadastro de ações externas é necessário compreender o funcionamento da mesma e saber quais os parâmetros são necessários para ela possa realizar um troca de informações com o Tactium IP URA, enviando (Entrada) e recebendo dados (Saída).

Toda ação externa terá um meio de conexão seja via web (Web Services) ou banco de dados (Procedures/Selects), o primeiro passo será identificar o meio de comunicação com os métodos disponíveis que deverão ser consumidos pelo Tactium IP URA.

Depois é necessário saber quais os paramentos (variáveis) deverão ser enviados (Entrada) e recebidos (Saída), para que a ação externa funcione corretamente.

Gerenciar configurações (Conexões)

Para realizar o cadastro de uma ação externa é necessário primeiramente realizar o cadastro de configurações de conexão, para que a chamada de programas externos e suas respectivas variáveis funcionem. Este cadastro é realizado conforme ilustrado na imagem abaixo:

Campos do cadastro de configurações (Conexões da ações externas)

Abaixo está uma tabela sintese dos campos e descrições do cadastro de configurações (conexão das ações externas).

Campo	Descrição
Nome	Nome da conexão
URL	Url que possibilitará estabelecer a conexão com banco de dados ou com o método de uma web service para excusão de uma ação externa
Tipo	Sample Text	Texto livre como string de conexão
	WebSevices	Conexão com Web Services para consumir métodos de integração. No campo URL deverá ser cadastrada a URL do método do Web Service que será consumido durante a execução da ação externa
	dbConnection	Estabelece a conexão entre Tactium IP URA com o banco de dados para executar ações externas, como selects e procedures
Tipo Servidor	O campo tipo servidor somente será habilitado quando o tipo de conexão foi DbConnection, este paramentro serve para definir qual o tipo de banco de dados se é “SQL Server” ou “Oracle”

Detalhamento dos tipos de conexões

Web Service

Web Service é uma solução utilizada na integração de sistemas e na comunicação entre aplicações diferentes. Com esta tecnologia é possível que novas aplicações possam interagir com aquelas que já existem e que sistemas desenvolvidos em plataformas diferentes sejam compatíveis.

Geralmente a URL do método do Web Service fica antes do sinal de interrogação conforme exemplo abaixo:

• URL Completa:
  http://ip_servidor/enviarSMS?telefone=859…&msg=Msg%20de%20teste

• URL método de envio de SMS:
  http://ip_servidor/enviarSMS?

Mas não é uma regra seguida por padrão em todos os Web Services. Então você deverá a se atentar à essa questão, veja mais detalhes em Realizando testes em Web Services em formato JSON.

DbConnection

No campo URL deverá ser cadastrada uma string de conexão com o banco de dados desejado.

Tipo servidor

O campo Tipo Servidor é habilitado somente para conexões do tipo DbConnection.

Este campo serve para definir se o servidor de banco de dados é do tipo “Oracle” ou “SQL Server”.

Para estabelecer a conexão com um banco de dados SQL server utilize o exemplo de URL a seguir:

user id=Usuário;Server=IP_Servidor;persist security info=False;initial catalog=Banco;Password=Senha;

Cadastros de variáveis

Uma variável é um espaço na memória do computador destinado a um dado que é alterado durante a execução do algoritmo. Para funcionar corretamente, as variáveis precisam ser definidas por nomes e tipos.

Campos do cadastro de variáveis

Nome:	Nome da variável.
Alias:	Alias da variável.
Tipo de vocalização:	Define como o texto da variável deve ser lido. Saiba mais sobre os Tipos de vocalização
Tipo da mensagem:	Text para utilizar TTS e File para utilizar arquivos de áudios em formato wav.
Publicar informações na transferência da chamada:	Ao transferir a chamada essa variável irá aparecer no contexto da ligação da transferência no e na Web API do Tactium IP.
Dados confidenciais:	Não grava informações inseridas nesta variável no banco de dados, mantendo a mesma apenas no contexto da chamada em memória, quando há um solicita cifras na URA as informações da variável de destino são gravadas no campo DS_HSI_CIPHER da tabela T_HSI, porém parâmetro estiver marcado isso não irá acontecer.
Compor nome do arquivo de gravação:	O valor desta variável estará presente no nome do arquivo de áudio da gravação da ligação.
Gravar valor da variável no banco:	Quando este parâmetro está marcado os valores das variáveis utilizadas como retorno de uma ação externa são registrados no campo NM_HVR_VALUE da tabela T_HVR.

Tipo de Vocalização

As vocalizações possíveis do campo “tipo de vocalização” estão na tabela abaixo, cada um dos tipos apresenta uma particularidade de como será lida a variável e o formato suportado:

Nome	Vocalização	Formatos Suportados
Data	Irá vocalizar datas por extenso	DD/MM/AAAA, DD/MM/AA, DDMMAAAA e DDMMAA
Hora	Irá vocalizar horários por extenso	HH:MM, HH:MM:SS, HHMMSS, HHMM e HHhMMmin
Nome	Irá vocalizar nome próprios é recomendado utilizar apenas o primeiro nome	Texto / File
Número pausado	Irá vocalizar números de forma pausada	1234567890
Número extenso	Irá vocalizar números por extenso	1234567890
Número telefone	Irá vocalizar números de forma pausada	1234567890
Texto	Irá vocalizar o texto é recomendado que o texto seja exatamente igual ao nome do arquivo de áudio	Texto / File
Valor monetário	Irá vocalizar valores monetários	R$324.67, $324.67 e 324.67

Cadastros de ações externas

Para realizar o cadastro de uma ação externa siga o caminho ilustrado na imagem abaixo:

Campos do cadastro de ações externas

Dados dos formulários modelados, isto é, das fichas de atendimento. Esses dados são específicos por cliente de acordo com o que foi modelado em suas telas e fichas.

Nome	Campo do nome da ação externa.
Tipo de Ação	Builtin	São ações que seguem modelos de requisições/retornos padrões do Tactium IP
	Externa	São ações que seguem modelos de requisições/retornos externos, sendo necessário definir uma DLL no campo “Assembly” no qual o Tactium IP irá carregar e assumir o padrão dessa DLL
Nome do Método	Escolha de um procedimento organizado para realizar a requisição ou verificação junto ao servidor. Saiba mais os métodos neste tópico.
Configuração padrão	Define o método Web Service ou qual a string de conexão com o banco de dados será utilizada na ação externa.
Parâmetros de entrada	São os parâmetros coletados e inseridos para processamento que podem ser utilizados para requisições ou validações. Saiba mais sobre os parâmetros de entrada neste tópico.
Parâmetros de saída	São os parâmetros variáveis que retornam do processamento da ação externa que pode ser vocalizado ou usado para decisões envolvendo o fluxo de navegação.

Tipos de Ação

Os Tipos de Ação são configuráveis como Built-in e Externas, sendo a primeira ações já integradas no sistema Tactium IP, não sendo necessário criar ou alterar dados, pois são ações que seguem modelos de requisições/retornos padrões. Já as ações externas seguem modelos de requisições/retornos externos, sendo necessário definir uma DLL no campo “Assembly” no qual o Tactium IP irá carregar e assumir o padrão dessa DLL.

Para mais informações acesse Tipos de ações externas para automatizar scripts no Tactium IP URA.

Tipos de Métodos

Os métodos permitem executar um organizado para realizar a requisição ou verificação junto ao servidor. Cada método tem sua particularidade na execução e no retorno, verifique abaixo:

Nome	Descrição
Executar consulta	São métodos que possibilitam executar selects no banco de dados. (porém, este select deve retornar apenas uma linha e uma coluna)
Executar procedure	São métodos que possibilitam executar procedures no banco de dados.
Requisição HTTP/XML	São métodos que possibilitam executar Web Services com retorno em JSON.
Validar CNPJ	Verifica se o CNPJ é válido através da validação do dígito verificador
Validar CPF	Verifica se o CPF é válido através da validação do dígito verificador
Web Services	São métodos que possibilitam executar Web Services SOAP com retorno em XML.

Tipos de Parâmetros de entrada

Os parâmetros são coletados e inseridos para processamento que podem ser utilizados para requisições ou validações, verifique abaixo:

Nome	Descrição
Variável	Associamos a outra variável já cadastrada. Para mais informações acesse o tópico Cadastro de Variáveis
Valor fixo	O valor desse tipo de parâmetros pode ser inserido manualmente, no caso de nulo, será sempre utilizado “empty”
Numero de A	Telefone que originou chamada
Número de B	Quem está recebendo chamada
ID de Ligação	Identificador de chamada
ID do Serviço	Por qual serviço chamada entrou
ID do Tronco	Qual tronco onde houve atendimento da chamada
Path gravação	Caminho para a gravação do áudio, este item é exclusivo para PA Virtual, visto que a URA Convencional não possui gravação da ligação.
Hora da chamada	Retorna a hora da chamada

Requisições

Nome	Descrição
Header	O Request Header é o cabeçalho da requisição, portanto, enviamos algumas informações referentes àquela requisição, como informações do host, cookies, codificação, tipo de resposta aceita, cache.
Body	O Request Body, ou corpo da requisição, é onde geralmente enviamos dados que queremos gravar no servidor. Não é muito utilizado em requisições do tipo GET, mas sim nas do tipo POST e PUT.
URL	A URL é o meio a qual passamos o endereço de destino e parâmetros que serão trabalhados no servidor.

Ferramentas de testes

Se você procura por uma ferramenta que ofereça uma interface de usuário prática e que permita realizar solicitações HTTP sem a necessidade de escrever um monte de códigos e testar a funcionalidade de uma API, então acesse a nossa base de conhecimento utilizando o link a seguir, nela vamos dar algumas dicas de ferramentas úteis para realizar testes no dia à dia.

• Web Services ou Web APIs em Formato JSON.