Configuração (config.ini)

O arquivo de configuração do Client Conecta é um componente essencial para o funcionamento da solução.

Esse arquivo concentra os parâmetros de identificação, comunicação, registro de logs e comportamento operacional da biblioteca, sendo lido durante o processo de inicialização.

Importância da configuração

A configuração correta do arquivo é fundamental para garantir o funcionamento das operações da biblioteca.

Problemas de configuração podem resultar em:

Falha na inicialização;
Erro de associação do terminal;
Impossibilidade de comunicação com a plataforma Cielo Conecta;
Dificuldade de diagnóstico por ausência de logs adequados.

Primeira inicialização

Durante a primeira execução do processo de inicialização, o Client Conecta realiza:

Identificação do terminal junto à plataforma;
Vinculação do ambiente lógico (PDV) ao estabelecimento;
Configuração inicial de comunicação, serviços e periféricos (PINPAD).

Para que esse processo ocorra corretamente, o arquivo .ini deve:

Estar presente no diretório esperado pela biblioteca (mesmo diretório do arquivo da biblioteca — DLL no Windows ou arquivo .so no Linux);
Conter todos os parâmetros obrigatórios;
Possuir valores válidos e previamente definidos, especialmente o ID do terminal com tamanho obrigatório de oito (8) caracteres.

⚠️
Atenção
O arquivo de configuração é obrigatório para a primeira inicialização da biblioteca. Ausência ou inconsistência nos parâmetros impede o funcionamento da solução.

Comportamento após a inicialização

Alterações realizadas no arquivo de configuração após a primeira inicialização podem não refletir na operação da biblioteca, dependendo do parâmetro alterado.

ℹ️
Importante
Alterações no arquivo .ini após a inicialização devem ser realizadas com cautela e, quando necessário, com orientação técnica.

Estrutura do arquivo

Exemplo de arquivo de configuração .ini:

#Config File
[DEFAULT]
RETRY_ATTEMPTS=3
TERMINAL_ID=XXXXXXXX

[LOG]
#APIKEY_DYNATRACE=
LOG_LEVEL=63
LOG_PATH=dlllog.txt

[PPCONECTA]
PPC_SERVICE_STRING=Client Conecta
PPC_LICENSE_STRING=
PPC_LOGPATH=ppclog.txt
PPC_PORTPINPAD=AUTO

O arquivo é composto por seções, cada uma responsável por um conjunto específico de configurações.

Seção [DEFAULT] – Configurações gerais

Define parâmetros básicos de funcionamento da biblioteca.

Chave	Descrição
RETRY_ATTEMPTS	Define a quantidade de tentativas automáticas em caso de falha de comunicação ou operação transitória.
TERMINAL_ID	Identificador lógico do terminal (PDV) utilizado na comunicação com o Cielo Conecta. Deve ter tamanho fixo de 8 caracteres.

Parâmetro obrigatório – TERMINAL_ID

O parâmetro TERMINAL_ID é um dos elementos mais críticos da configuração.

Representa a identificação lógica do PDV;
É usado para vincular o terminal ao estabelecimento;
Deve ser único no escopo da aplicação ou loja.

Uma configuração incorreta pode resultar em:

Falha na inicialização;
Associação indevida do terminal;
Inconsistências operacionais e de conciliação.

⚠️
Atenção
Defina um padrão claro e controlado para o TERMINAL_ID (por exemplo, PDV0001, PDV0002, etc.) e garanta que ele esteja corretamente configurado em cada arquivo .ini antes da primeira inicialização.

Seção [LOG] – Configuração de logs

Define os parâmetros relacionados à geração de logs da biblioteca.

Chave	Descrição
LOG_LEVEL	Define o nível de detalhamento dos logs. Valores maiores indicam maior nível de informação.
LOG_PATH	(Opcional) Caminho e nome do arquivo de log gerado pela DLL do client Conecta.
LOG_PORT	(Opcional) Porta para envio remoto de logs.
APIKEY_DYNATRACE	(Opcional) Chave de integração para monitoramento externo, quando aplicável.

ℹ️
Observações sobre logs
É recomendável manter o log habilitado, principalmente na primeira inicialização;
Os logs auxiliam no diagnóstico, suporte técnico e análise de falhas de comunicação.

Seção [PPCONECTA] – Comunicação e Pinpad

Define os parâmetros de comunicação com o PINPAD e serviços associados.

Chave	Descrição
PPC_SERVICE_STRING	Nome do serviço utilizado pela comunicação com o PINPAD. Valor padrão: Client Conecta.
PPC_LICENSE_STRING	(Opcional) String de licença do módulo PPC, quando aplicável. Deve permanecer em branco conforme o cenário.
PPC_LOGPATH	(Opcional) Caminho do log específico da comunicação com PINPAD. DEVE permanecer em branco conforme o cenário.
PPC_PORTPINPAD	Define a porta de comunicação do PINPAD. Recebe valores XX (ex.:16). O valor AUTO permite que a biblioteca realize a detecção automática da porta de comunicação em que o dispositivo PINPAD está conectado.

📘
Observações sobre logs

O uso de PPC_PORTPINPAD= AUTO é recomendado para facilitar a instalação inicial;

A chave PPC_COMPORT é reconhecida apenas quando o campo “PortPinpad” não é enviado no comando de inicialização;

Os logs do PPC são complementares e opcionais. Este tipo de log’s da biblioteca Client Conecta — DLL (Windows) / SO (Linux) — auxiliam no diagnóstico de problemas de periféricos (PINPAD).