GUIA DE INSTALAÇÃO E CONFIGURAÇÃO

CTFCLIENT JAVA
09/11/2021
Índice
ÍNDICE ................................................................................................................................................................... 2

Instalação do CTFClient no Windows ......................................................................................... 3

Instalação do CTFClient no Linux ................................................................................................ 4
Configuração do CTFClient .......................................................................................................... 5
Configuração do tipo de integração ....................................................................................... 5
Configuração do terminal ....................................................................................................... 6
Configuração automática do terminal .................................................................................... 7
Configuração de pinpad .......................................................................................................... 8
Configuração de variáveis de ambiente ................................................................................. 8
Outras configurações do CTFClient....................................................................................... 11

Guia de Instalação e Configuração do CTFClient Java.docx 2/11

Instalação do CTFClient no Windows
A instalação do CTFClient no Windows pode ser realizada através do pacote ctfclient-<versão>-
windows-installshield-x86. Exemplo:

• ctfclient-4.3.6-6-windows-installshield-x86

Opcionalmente, ainda existem as opções de pacotes Windows ctfclient-<versão>-windows-

portable-x86 e ctfclient-<versão>-windows-portable-x64, para serem instaladas manualmente. Estes
pacotes não instalam o Java. Exemplos:

• ctfclient-4.4.3-0-windows-portable-x86
• ctfclient-4.4.3-0-windows-portable-x64

O instalador Windows possui um assistente de configuração para os tipos de integração:

• dll
• websocket
• tef-ip

A instalação do CTFClient no Windows oferece a opção de configuração do CTFClient no

SystemTray do Windows.

Opcionalmente, a janela de configuração do CTFClient pode ser chamada pela Automação

Comercial através da operação 800 - Configuração do CTFClient.

Exemplo de menu de Configuração do CTFClient:

CONFIGURACAO
1-INICIALIZACAO
2-TERMINAL
3-CTF-SERVER
4-PINPAD
5-CARGA DE TABELAS
6-SAIR

Após a instalação e configuração do CTFClient, o terminal deve ser reiniciado.

Guia de Instalação e Configuração do CTFClient Java.docx 3/11

Instalação do CTFClient no Linux
A instalação do CTFClient no Linux pode ser realizada através dos pacotes ctfclient-
<versão>.i386.rpm e ctfclient-<versão>.x86_64.rpm. Exemplos:

• ctfclient-4.4.3-0.i386.rpm
• ctfclient-4.4.3-0.x86_64.rpm

Opcionalmente, ainda existem as opções de pacotes Linux ctfclient-<versão>-linux-portable-i386

e ctfclient-<versão>-linux-portable-x86_64, para serem instaladas manualmente. Estes pacotes não
instalam o Java. Exemplos:

• ctfclient-4.4.3-0-linux-portable-i386
• ctfclient-4.4.3-0-linux-portable-x86_64

O instalador Linux não possui um assistente de configuração. Por isso, toda a configuração deve
ser feita de forma manual; ou, opcionalmente, a aplicação da AC pode integrar-se com o
CTFClient através da operação 800 - Configuração do CTFClient.

A instalação do CTFClient no Linux não oferece a opção de configuração do CTFClient através de

um equivalente ao SystemTray do Windows, mas esta configuração está disponível através da
operação 800 - Configuração do CTFClient.

Exemplo de menu de Configuração do CTFClient que a operação 800 apresenta:

CONFIGURACAO
1-INICIALIZACAO
2-TERMINAL
3-CTF-SERVER
4-PINPAD
5-CARGA DE TABELAS
6-SAIR

Por padrão, a instalação do CTFClient no Linux é pré-configurada para o tipo de integração dll:

%CTFCLIENT_HOME%/bin/configCTFClient.xml
<Parameter name="tipointegracao">dll</Parameter>

Após a instalação e configuração do CTFClient, o terminal deve ser reiniciado.

Guia de Instalação e Configuração do CTFClient Java.docx 4/11

Configuração do CTFClient
Os parâmetros de configuração do CTFClient podem ser editados no arquivo configCTFClient.xml,
localizado na pasta onde o CTFClient é instalado:

• Linux: /opt/AUTTAR/bin
• Windows: C:\Arquivos de Programas (x86)\Auttar

Configuração do tipo de integração

A configuração do tipo de integração do CTFClient é feita através do parâmetro tipointegracao do

arquivo configCTFClient.xml.

%CTFCLIENT_HOME%\bin\configCTFClient.xml
<Parameter name="tipointegracao">dll</Parameter>

O CTFClient disponibiliza vários de tipos de integração com a aplicação da Automação Comercial

(AC).

Parâmetro Tipo de
Status Descrição
tipointegracao integração
Integração padrão do CTFClient.

A AC carrega a
biblioteca \Auttar\CTFClient\bin\ctfclient.dll
(/opt/AUTTAR/CTFClient/lib/libctfclient.so) que
implementa a comunicação com o CTFClient.
Integração
dll SUPORTADA Através da integração com a biblioteca ctfclient.dll
DLL
(libctfclient.so), a AC pode usar as suas próprias
interfaces de display e de teclado durante a
execução da transação no CTFClient.

Recomendações importantes para o integrador

da AC:

Guia de Instalação e Configuração do CTFClient Java.docx 5/11

 Parâmetro Tipo de
Status Descrição
tipointegracao integração
1. Não manter cópias locais da biblioteca
ctfclient.dll (ou libctfclient.so do Linux) ou
cópias na pasta do Windows (ou /lib do
Linux).
2. Executar a ctfclient.dll (libctfclient.so) da
pasta onde o CTFClient foi instalado, para
que a versão da biblioteca esteja
compatível com a versão do CTFClient,
sempre que esta for atualizada.

Integração A AC envia requisições para o CTFClient através

websocket SUPORTADA
Websocket de uma porta websocket.
A AC escreve arquivos com uma formatação
específica em uma pasta específica para
Integração USAR comunicar-se com o CTFClient.
tefip
TEF-IP INSTALADOR
Para essa modalidade, recomenda-se fortemente
o uso do pacote InstallShield do CTFClient.
A AC envia requisições para o CTFClient através
de uma porta socket, usando estruturas de dados
Integração
standalone DEPRECIADA POSENTRA e POSSAIDA.
padrão
Dar preferência para o uso da Integração DLL.
A AC carrega o CTFClient como uma biblioteca e
executa requisições usando as APIs internas do
Integração
standalone DEPRECIADA CTFClient.
P2K/Storex
Dar preferência para o uso da Integração DLL.

Configuração do terminal

Para habilitar o fluxo transacional do CTFClient, devem ser configurados minimamente os

parâmetros de identificação do terminal e de conexão conexão com o CTF.

• Para configurar o número do terminal CTF:

Guia de Instalação e Configuração do CTFClient Java.docx 6/11

 %CTFCLIENT_HOME%\bin\configCTFClient.xml (ambiente de homologação ou CTF Fast via
VPN)
<Parameter name="estabelecimento"></Parameter> <!-- Código do estabelecimento -->
<Parameter name="loja"></Parameter> <!-- Código da loja -->
<Parameter name="terminal"></Parameter> <!-- Código do terminal -->

• Para configurar a conexão do tipo TCP com o CTF de Homologação:

%CTFCLIENT_HOME%\bin\configCTFClient.xml (ambiente de homologação ou CTF Fast via

VPN)
<ParameterSet name="ips">
<ParameterSet name="ip"> <!-- Ajustar os parâmetros abaixo quando for Produção -->
<Parameter name="host">201.87.167.97</Parameter> <!-- Endereço IP -->
<Parameter name="port">1996</Parameter> <!-- Porta de conexão IP -->
<Parameter name="protocolo">TCP</Parameter> <!-- Protocolo de comunicação -->
</ParameterSet>
</ParameterSet>

Configuração automática do terminal

Opcionalmente, através da comunicação HTTPS com o CTF, o número do terminal é configurado

automaticamente após a Autenticação Https do terminal com o CTF.

• Para habilitar a comunicação do tipo https:

%CTFCLIENT_HOME%\bin\configCTFClient.xml (ambiente de homologação ou CTF Fast)

<Parameter name="suporteHttps">true</Parameter>

• Para habilitar a comunicação do tipo https no ambiente de Homologação do CTF:

%CTFCLIENT_HOME%\bin\configCTFClient.xml (ambiente de homologação)

<Parameter name="homologacao">true</Parameter>

• Para autenticar o terminal, há duas formas disponíveis:

1. Através da integração da operação 800 - Configuração do CTFClient, opção

INICIALIZACAO.
2. Através do menu "Configurar CTFClient", situado no SystemTrayCTFClient, opção
INICIALIZACAO (disponível na instalação Windows com Install Shield).

Guia de Instalação e Configuração do CTFClient Java.docx 7/11

 • Para ativar o terminar autenticado no CTF:

1. Acessar o Portal Auttar / TEF / Cadastro / Terminal Loja:

2. Alterar o status do terminal de "Aguardando ativação" para "Ativo".

Configuração de pinpad

Existem duas formas de configurar o pinpad.

• Caso a porta do pinpad seja conhecida:

%CTFCLIENT_HOME%\bin\configCTFClient.xml
<ParameterSet name="CONFIG_PINPAD">
<Parameter name="msgAguardo">PROCESSANDO...</Parameter>
<Parameter name="msgCartao">PASSE O CARTAO</Parameter>
<Parameter name="msgPrompt">AUTTAR</Parameter> <!-- Adicionar texto do display idle do pinpad
(quando não estiver sendo usado) -->
<Parameter name="msgSenha">DIGITE A SENHA</Parameter>
<Parameter name="portaSerial">COM3</Parameter> <!-- Adicionar aqui a porta serial onde o pinpad
está conectado -->
<Parameter name="tentativasConexao">3</Parameter>
</ParameterSet>

• Caso a porta do pinpad não seja conhecida, o pinpad pode ser configurado
automaticamente de duas formas:

1. Através da integração da operação 800 - Configuração do CTFClient, opção PINPAD

→ AUTOMATICA.
2. Através do menu de "Configurar CTFClient", situado no SystemTrayCTFClient, opção
PINPAD → AUTOMATICA (disponível na instalação Windows com Install Shield).

Configuração de variáveis de ambiente

CTFCLIENT_HOME

O CTFClient Java tem como pré-condição, para ser executado corretamente, a definição da
variável de ambiente CTFCLIENT_HOME.

O pacote de instalação installshield do Windows configura a variável de ambiente do CTFClient.

Guia de Instalação e Configuração do CTFClient Java.docx 8/11

Os pacotes de instalação rpm do Linux, opcionalmente, permitem a configuração das variáveis
de ambiente do CTFClient.

A configuração manual da variável CTFCLIENT_HOME é importante, principalmente para os

pacotes portable do CTFClient (ver Tipos de pacote do CTFClient), e pode ser feita de várias
formas.

1 - Configuração através das definições do ambiente:

• Linux: adiciona-se a variável de ambiente nos scripts de inicialização do shell,

como ~/.bashrc ou /etc/profile :

~/.bashrc ou /etc/profile
export CTFCLIENT_HOME=<Caminho de instalação do CTFClient Java Linux>

• Windows: adiciona-se a variável de ambiente nas variáveis de ambiente do processo,

usuário ou sistema.

2 - Através de definições programáticas da aplicação da Automação Comercial:

• C#

Environment.SetEnvironmentVariable("CTFCLIENT_HOME", caminho_ctfclient);

• C (Windows)

Guia de Instalação e Configuração do CTFClient Java.docx 9/11

 char ctfclient_home[MAX_PATH] = {'\0'};
strcat(ctfclient_home, "CTFCLIENT_HOME=");
strcat(ctfclient_home, caminho_ctfclient);
res = _putenv(ctfclient_home);

• C (Linux)

char ctfclient_home[MAX_PATH] = {'\0'};

strcat(ctfclient_home, "CTFCLIENT_HOME=");
strcat(ctfclient_home, caminho_ctfclient);
res = putenv(ctfclient_home);

• No caso de a variável de ambiente ser definida na AC, a AC também deve se

responsabilizar por chamar o script de execução do CTFClient proceduralmente.

No caso de configuração manual, garantir que o CTFClient já não está em execução. Isso pode ser
feito avaliando se o processo do Java está em execução.

LD_LIBRARY_PATH (apenas Linux)

Essa variável é usada apenas no Linux e deve ser expandida para incluir:

• as bibliotecas de tempo de execução do CTFClient;

• as bibliotecas do JRE (porque algumas bibliotecas do CTFClient dependem das bibliotecas
JNI do JRE).

Um exemplo para o valor dessa variável é:

~/.bashrc ou /etc/profile
export LD_LIBRARY_PATH=<Caminho do CTFCLIENT_HOME sem a pasta bin>/lib:$JAVA_HOME/lib

Caso a variável de ambiente CTFCLIENT_HOME esteja definida no mesmo script que o

LD_LIBRARY_PATH , o seguinte pode ser feito:

~/.bashrc ou /etc/profile
export CTFCLIENT_HOME=<Caminho de instalação do CTFClient Java Linux>
export LD_LIBRARY_PATH=$CTFCLIENT_HOME/lib:$JAVA_HOME/lib

Guia de Instalação e Configuração do CTFClient Java.docx 10/11

Para o código acima funcionar, a declaração de LD_LIBRARY_PATH deve estar depois da declaração
de CTFCLIENT_HOME.

Outras configurações do CTFClient

Atualização automática do CTFClient

O parâmetro habilitaAtualizador do arquivo configCTFClient.xml, disponível a partir do CTFClient versão

4.3.4, permite desabilitar a atualização automática do CTFClient na instalação Windows.

Caso o parâmetro não esteja disponível no arquivo configCTFClient.xml, considerar como valor
"true", isto é, a atualização automática do CTFClient está habilitada.

Para desabilitar a atualização automática do CTFClient, o valor do parâmetro habilitaAtualizador

deve ser alterado para false após a instalação.

• Caso o parâmetro habilitaAtualizador não exista no arquivo configCTFClient.xml, inserir a linha

abaixo no arquivo com o valor false:

%CTFCLIENT_HOME%\bin\configCTFClient.xml (instalação Windows)

<Parameter name="habilitaAtualizador">false</Parameter>

A configuração deste parâmetro durante a instalação via Install Shield será resolvida
futuramente.

Guia de Instalação e Configuração do CTFClient Java.docx 11/11