Manual de Administração
Produto: n-Client
Versão do produto: 4.7.0
Autor: Bárbara Vieira Souza
Versão do documento: 4
Versão do template: 2
Data: 09/05/2013
Documento destinado a: Parceiros NDDigital, técnicos de suporte, analista de T.I.
Código do Documento
MDS024
Responsável
Analista de Testes
Data Última Revisão
24/08/2011
Versão Última Revisão
2
Histórico de alterações
Data
26/04/2011
12/01/2012
Versão
1
2
Autor
Bruno Nercolini Ceron
Bárbara Vieira Souza
09/01/2013
09/05/2013
3
4
Bárbara Vieira Souza
Bárbara Vieira Souza
Descrição
Elaboração do documento
Adaptação do documento ao novo template e
alteração para a versão 4.5.
Alteração para versão 4.6.
Alteração para versão 4.7.
Página 2 de 9
Código do Documento
MDS024
Responsável
Analista de Testes
Data Última Revisão
24/08/2011
Versão Última Revisão
2
1. Introdução
O n-Client é um módulo da solução n-Billing responsável pela captura das informações de impressão
realizadas pelos usuários, provenientes das filas de impressão do Windows (Spool) e os contadores
físicos das impressoras USB.
Qualquer impressão ocorrida no computador tem todas suas características analisadas e
contabilizadas. São extraídas informações como: Tipo do documento, origem do documento,
configurações das impressões (simplex, duplex, qualidade da impressão), impressora, número de
páginas, quantidades de páginas monocromáticas e coloridas, tamanho do arquivo impresso, horário da
impressão, o domínio e o login do usuário que efetuou a impressão e o nome do documento impresso.
Efetua o envio das informações de contabilização de forma compacta e criptografada para o módulo
n-Host, via DCS pela porta 5656 própria da NDDigital, para que possam ser processados pelo n-Server e
visualizados em forma de relatório.
Este manual visa auxiliar no entendimento do produto e com o intuito de exibir as possíveis
configurações que podem ser realizadas.
2. Impressão sem n-Client
Será exibido a seguir o processo de uma impressão sem o n-Client, através do sistema Windows.
2.1 Processo do Windows
Quando uma impressão é enviada, o Windows procede, colocando este documento na fila da
impressora:
Logo, são gerados dois arquivos no diretório de Spool C:\Windows\system32\spool\PRINTERS.
As extensões dos arquivos são: .SHD e .SPL.
Após o documento ser impresso fisicamente, o Windows exclui o documento da fila de impressão e
exclui esses arquivos .SHD e .SPL do diretório de Spool.
3. Impressão com n-Client
Quando o n-Client é instalado, há uma alteração nas propriedades de cada impressora instalada na
estação de trabalho, na aba Avançado, opção Manter documentos impressos. Com esta opção
marcada, quando uma impressão é realizada o documento é mantido na fila de impressão com o status
de impresso e os arquivos .SHD e .SPL não são excluídos do diretório de Spool do Windows.
Página 3 de 9
Código do Documento
MDS024
Responsável
Analista de Testes
Data Última Revisão
24/08/2011
Versão Última Revisão
2
O serviço chamado nCService é instalado e passa a monitorar os eventos gerados pelo Windows desta
maneira, toda vez que um evento de impressão é gerado, o mesmo captura os arquivos .SHD e .SPL
gerados no diretório de Spool do Windows para um diretório de Spool próprio do n-Client localizado em:
C:\WINDOWS\system32\TPar\Spool para x86 e C:\WINDOWS\SysWOW64\TPar\Spool para
x64, e em seguida, exclui o documento da fila da impressora.
NOTA: Este diretório é oculto e protegido pelo sistema.
No diretório de spool do n-Client, além dos arquivos .SHD e .SPL, é criado um .SPA. Esse arquivo é
gerado pelo serviço do n-Client e contém uma pré-análise do que o trabalho de impressão contém.
Depois que estiverem nesse diretório, o serviço fará a análise completa dos dados contidos neste
arquivo e gerará o .log com os dados da impressão.
3.1 Arquivo Log
O arquivo de extensão .log fica localizado no diretório Tpar:
Página 4 de 9
Código do Documento
MDS024
Responsável
Analista de Testes
Data Última Revisão
24/08/2011
Versão Última Revisão
2
Este arquivo é formado pelos seguintes campos:
















01
o
o
o
o
02
o
o
o
o
o
03
04
05
06
07
08
09
10
11
12
13
14
15
16
– Origem do documento:
1 - Impressão Direta;
2 – DPS;
3 – FORMS;
7 – Bureau.
– Tipo:
1 – Impressão;
2 – Cópia;
3 – Fax Recebido;
4 – Scan;
5 – Fax Enviado.
– Indica se o documento é duplex (valor 1) ou simplex (valor 0);
– Qualidade da impressão;
– Contém a identificação da impressora que realizou a impressão;
– Tipo de papel;
– Número de páginas monocromáticas;
– Número de páginas coloridas;
– Ainda não utilizado;
– Ainda não utilizado;
– Tamanho do arquivo impresso;
– Data da impressão;
– Hora da impressão;
– Domínio do usuário que realizou a impressão;
– Login do usuário que realizou a impressão;
– Nome do documento impresso.
3.2 Envio ao n-Host
Após o arquivo .log ser gerado, ele ficará armazenado no diretório Tpar até o próximo horário de
envio ou até que o serviço seja reiniciado. Então, será gerado um arquivo .NPL que será enviado ao nHost.
O arquivo .NPL contém as mesmas informações do .log, além de informações como:



Versão do n-Client instalado;
IP, máscara, Mac Address e sistema operacional da estação de trabalho;
Informações das impressoras instaladas.
Não é possível a visualização deste arquivo, pois o mesmo é criptografado.
3.3 Chaves de Registro
As chaves de registro para a configuração do produto ficam localizadas em:
Página 5 de 9
Código do Documento
MDS024


Responsável
Analista de Testes
Data Última Revisão
24/08/2011
Versão Última Revisão
2
HKEY_LOCAL_MACHINE\SOFTWARE\NDDigital\n-Billing\n-Client
em
computadores x86;
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\NDDigital\n-Billing\nClient em computadores x64.
Nesta chave são inseridos a maioria dos valores de sequência. Estes valores podem ser alterados
para ajustar o funcionamento do produto conforme o necessário.
Após efetuar qualquer alteração nas chaves de registro do produto é necessário reiniciar o serviço
NDDigital n-Client para que as alterações tenham efeito.
Entradas mais utilizadas:














AcRemotePort: Habilita a contabilização de portas remotas. Valor 1 para ativar;
AcLPDPort: Habilita a contabilização de portas do tipo LPD. Valor 1 para ativar;
CheckPrinted: Funciona juntamente com a TimeLogSpool, se o valor configurado for 1 o
produto fará a checagem se existem arquivos com status impresso e não liberados das
filas das impressoras, em seguida fará a liberação e contabilização destes trabalhos;
DcsServer: Endereço de onde está o DCS Server (n-Host), ou seja, para onde o n-Client
irá enviar os arquivos;
DisableBiDirectional: Desabilita a opção de suporte bidirecional em todas as
impressoras. Valor 1 para ativar;
DisableAccounts: Desabilita a contabilização de todas as impressoras. Valor 1 para
ativar;
EnableMachineName: Insere o nome da estação de trabalho no arquivo de log, junto ao
nome do documento. Valor 1 para ativar;
EnableColorCapable: Por padrão o trabalho de impressão é contabilizado com apenas
uma cor, ou todas coloridas ou todas monocromáticas, com esta opção ativada, o trabalho
de impressão será contabilizado com a quantidade específica de páginas monocromáticas e
coloridas. Valor 1 para ativar;
ForceDomain: Neste valor de sequência deve ser colocado o nome do domínio que os
trabalhos de impressão serão forçadamente atribuídos, não utilizará mais o domínio local
nem o domínio de rede do usuário;
MachineDelimiter: Limita o tamanho do nome da máquina capturado pelo n-Client, os
caracteres configurados aqui serão o limite do nome, caso no nome da estação de trabalho
sejam encontrados esses caracteres, o n-Client utilizará como nome da máquina apenas a
sequência anterior a esses caracteres;
MaxJobsWarning: Define o número máximo de pares de arquivos (.shd e .spl) que serão
armazenados no diretório logs, os arquivos armazenados neste diretório por terem algum
erro de contabilização e não foram contabilizados;
MaxTimeAnalyzeFile: Define o tempo máximo que o n-Client tem para analisar os
arquivos .shd e .spl. Valor padrão 20 minutos;
MaxJobsTimeouts: Define o número máximo de pares de arquivos (.shd e .spl) que serão
armazenados no diretório Timeouts;
MinimumJobSize: Faz com que arquivos com tamanho inferior ao tamanho configurado
na chave não sejam contabilizados. Este valor é configurado em bytes;
Página 6 de 9
Código do Documento
MDS024













3.3.1
Responsável
Analista de Testes
Data Última Revisão
24/08/2011
Versão Última Revisão
2
nClientInventoryEnabled: Este valor de sequência habilita a busca de contadores de
impressoras USB instaladas na estação de trabalho. Serão gerados arquivos .NSL e
enviados para o diretório de trabalho do n-Inventory, no n-Host. Para a busca do contador
de páginas, as impressoras precisam ter suporte à linguagem PJL.
Quando o n-Client é instalado, por padrão a função de captura de contadores está
habilitada (com valor 1). Para desabilitar o recurso deve ser configurada esta chave com
valor 0;
nClientInventoryTimeUpdate: Intervalo em minutos que serão gerados os arquivos
.NSL com as informações de contadores das impressoras USB. Se esta chave for removida,
os arquivos serão gerados em um intervalo padrão de 230 minutos;
OSVersion: Versão do Sistema Operacional, criado pelo instalador;
PathInstall: Diretório de instalação, criado pelo instalador;
PathSetup: Caminho de onde foi executado o instalador;
TimeLogSpool: Intervalo de tempo em minutos para que o nCLogSpool seja executado,
este executável faz as verificações em todas as filas de impressão em busca de arquivos
de impressão presos nas filas com status de impresso. O ncLogSpool fará a limpeza nestes
filas e a contabilização desses trabalhos;
TimeUpdate: Intervalo de tempo em minutos para envio dos arquivos ao n-Host, valor
padrão 240;
TraceLevel: Campo usado para habilitar o registro de erros do n-Client (Trace), valores:
 0 – registro de erros (Trace) desligado;
 10 – registro de erros (Trace) ligado para logar erros;
 20 - registro de erros (Trace) ligado para logar erros e informação;
 30 – registro de erros (Trace) ligado para logar mensagens de Debug.
UserTitleTagStart: Representa o início do delimitador para que o n-Client capture um
nome de usuário específico, baseado no título do documento. Essa chave deve ser utilizada
em conjunto com a UserTitleTagEnd;
UserTitleTagEnd: Representa o final do delimitador para que o n-Client capture um nome
de usuário específico, baseado no título do documento. Essa chave deve ser utilizada em
conjunto com a UserTitleTagStart.
o Exemplo:
Título do documento: IMP_C1027662-teste.pdf.
UserTitleTagStart = IMP_ (Início do delimitador);
UserTitleTagEnd = -teste (Final do delimitador)
Resultado do nome de usuário = C1027662
Version: Versão do produto instalado;
VersionControl: Somente para controle da versão pelo instalador.
Warning: Quando uma contabilização (bilhetagem) ultrapassa o número de páginas
representado neste campo os arquivos são contabilizados com apenas 1 página e são
armazenados no diretório Logs.
Entradas no Registro das Impressoras
Algumas configurações do produto estão localizadas nas chaves de registro das impressoras. As
configurações individuais de cada impressora podem ser encontradas no seguinte caminho:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Print\Printers\<nome_da
_impressora>
3.3.2






Entradas Mais Utilizadas
NDDigitalID: Contém o identificador único da impressora.
NCKeepJobs: Valor de sequência criado para a impressora manter os trabalhos de
impressão com status Printed após a contabilização, possibilitando uma futura
reimpressão. Valor 1 para ativar;
nCDisactivate: Valor de sequência que permite desabilitar a contabilização de
determinada impressora. Valor 1 para ativar a chave.
nCActivate: Funciona juntamente com o valor de sequência DisableAccounts e serve
para ativar a contabilização de determinada impressora. Valor 1 para ativar.
ChangeBiDirectional: Este valor de sequência cancela a regra de desabilitar o suporte
Bidirecional nos equipamentos nos quais ela é criada. Valor 1 para ativar.
Community: Este valor de sequência deve ser criado quando alguma impressora da rede
está com a comunidade SNMP diferente de Public. O valor deve ser igual ao que está
configurado na impressora para a comunicação funcionar normalmente;
Página 7 de 9
Código do Documento
MDS024

Responsável
Analista de Testes
Data Última Revisão
24/08/2011
Versão Última Revisão
2
DisableDuplexAjust: Este valor de sequência desabilita a regra de equipamentos que
contabilizam uma página a mais quando é realizada uma impressão duplex com número de
páginas ímpar. Valor 1 para ativar;
IgnoreMinJobSize: Este valor de sequência faz com que todas as impressões de
determinada impressora sejam contabilizadas, independente do tamanho do spool,
anulando a configuração MinimumJobSize. Valor 1 para ativar;
ncForceColor: Forçar determinada fila de impressora para que contabilize apenas páginas
coloridas ou apenas páginas preto e branco. Valor BW para forçar preto e branco e valor
Color para forçar para colorido;
KeepQueueProperties: Valor para que o n-Client não altere a opção Start Printing
after last page is spooled nas propriedades das impressoras.



3.4 Diretório de Trabalho (Tpar)
O diretório de trabalho do produto é criado em um caminho padrão. Nele, são armazenados os
arquivos de contabilização, traces e informações de erros.
Caminho padrão:


C:\WINDOWS\system32\TPar em computadores x86;
C:\WINDOWS\SysWOW64\TPar em computadores x64.
3.4.1
Subdiretórios da Tpar
O diretório Tpar possui vários subdiretórios com funções específicas.
3.4.1.1
Subdiretório Errors
No subdiretório Errors, serão armazenados arquivos de informações de erros de rede, se o produto
não conseguir efetuar a comunicação com o servidor para o envio dos dados de contabilização.
3.4.1.2
Subdiretório Logs
Neste diretório serão armazenados os arquivos com possível falha de contabilização, pois possuíam
um número de páginas superior ao configurado no valor de sequência Warning.
3.4.1.3
Subdiretório Spool
Possui os arquivos de spool que estão na fila para serem processados e contabilizados.
3.4.1.4
Subdiretório Trace
Neste diretório serão armazenados os arquivos com as informações do funcionamento do produto
quando é criado o valor de sequência Tracelevel.
3.4.1.5
Subdiretório TimeOuts
Neste diretório serão armazenados os arquivos que ultrapassaram o tempo de processamento, pois,
por algum motivo travaram o sistema. O tempo máximo que o n-Client poderá levar para processar o
arquivo é configurado no valor de sequência MaxTimeAnalyzeFile, ultrapassado este tempo, os
arquivos irão para o diretório Timeouts e a contabilização ocorre normalmente para os demais arquivos
na fila de processamento.
4. Serviço do n-Client
O serviço responsável pelo funcionamento do n-Client é o NDDigital n-Client. E, pode ser
visualizado no gerenciador de serviços do Windows.
Página 8 de 9
Código do Documento
MDS024
Responsável
Analista de Testes
Data Última Revisão
24/08/2011
Versão Última Revisão
2
O serviço NDDigital n-Client Control irá controlar o funcionamento do n-Client, iniciando o serviço
caso ocorra uma parada.
5. Contabilização de Documentos no Windows Server 2012
No sistema operacional Windows Server 2012, por padrão, a extensão dos documentos não é
contabilizada. Para que o documento seja contabilizado com sua extensão, uma opção deverá ser
alterada nas configurações do Windows. Para fazê-lo, acesse o Painel de Controle do Windows, em
seguida, clique em Aparência, e, após isto em Opções de pasta. Após abrir esta interface, acesse a
aba Modo de Exibição, e, desmarque a opção Ocultar extensões dos tipos de arquivo conhecidos.
O detalhamento dos itens citados neste documento visa guiar ao método correto de administração e do
produto. Para esclarecimentos de dúvidas e incidentes das soluções entre em contato com o Suporte da
NDDigital.
Endereço: Rua Dr. Walmor Ribeiro, 431 – Coral – Lages – SC – CEP: 88523-060 – Fone: (49) 3251-8000 – www.nddigital.com.br
Página 9 de 9