Manual de Administração - PDF
Download "Manual de Administração"
Eugénio Coimbra Garrau
1 Manual de Administração Produto: n-gpclient Plugin Versão: Versão do Doc.: 1.0 Autor: Aline Della Justina Data: 06/07/2011 Público-alvo: Clientes e Parceiros Alterado por: Release Note: Detalhamento de Alteração do Documento Data:
2 1. Introdução O n-gpclient Plugin é o módulo responsável por monitorar, coletar, gerenciar e enviar as notificações do parque de impressoras para o n-server. Estes eventos poderão ser visualizados, alterados e resolvidos através do portal Global Partner ( Os eventos ou notificações consistem em informações sobre erros, avisos ou o status em que cada impressora encontra-se no momento, por exemplo: impressora desligada, sem papel, sem toner, com papel atolado, etc. Este manual visa auxiliar no processo de configuração e administração, com intuito de mostrar passo a passo as características para o funcionamento adequado do plugin n-gpclient. 2. Habilitar o Plugin Após instalar o plugin, é necessário habilitar o seu funcionamento na interface do n-host. Uma nova opção será exibida no n-host Administração, em Gerenciar Plugins, chamada n-gpclient. (Dúvidas sobre o n-host, consultar Manual de Administração n-host). Para habilitar o n-gpclient, deve-se abrir a interface inicial do n-host Administração, na aba Ferramentas, clicar em Gerenciar Plugins. Importante: É necessário que o n-inventory esteja previamente ativado, pois o n-gpclient irá monitorar as mesmas impressoras que estiverem cadastradas no n-inventory. Após isso, será apresentada a interface de gerenciamento dos plugins, deve-se marcar a opção do n- Inventory (se esta não estiver marcada), em seguida marcar a opção n-gpclient e clicar em OK. Aparecerá a mensagem abaixo: 2
3 Após clicar em OK, deve-se ir até o menu Ferramentas> Configurações e verificar se a aba n- GP Client foi criada. Nesta aba, é necessário configurar os dados da empresa (nome e chave de identificação), para a qual serão enviados os arquivos contendo os dados dos eventos, podendo escolher entre utilizar a configuração padrão ou definir configurações específicas manualmente. Na configuração padrão, os dados dos eventos serão enviados para a mesma empresa onde o n-host e n-inventory enviam seus arquivos, neste caso não é preciso alterar nenhuma configuração, pois já virá automático, sendo necessário apenas clicar em OK para confirmar as configurações. Se a empresa para onde os dados dos eventos serão enviados for diferente da empresa do n-host, deve-se marcar a opção Utilizar configurações específicas para o envio de dados ao servidor n- Billing e então configurar o nome da empresa e sua respectiva chave de identificação. Após isso, clique em OK para confirmar as configurações. Importante: O instalador irá instalar o serviço do plugin com o status Parado e tipo de inicialização Manual. Após habilitar o plugin, irá alterar para Automático, porém o serviço continuará Parado. Para iniciá-lo, é necessário confirmar as configurações de envio dos dados na aba n-gpclient, somente após este procedimento o serviço ficará com status Iniciado. 3
4 3. Configurações 3.1. Diretório de Trabalho O plugin n-gpclient irá utilizar o mesmo diretório de trabalho do n-host (o padrão é: C:\WINDOWS\Temp\NDDigital\n-Billing) e dentro deste diretório será criado um novo diretório, chamado GPClient. Dentro de GPClient, estarão os diretórios onde serão criados os arquivos contendo os eventos das impressoras. Depois de criados, o plugin irá enviá-los diretamente ao n-server. Dentro do diretório GPClient, existem os diretórios EventsFiles, HistoricFiles e TempFiles. Mais detalhes sobre a função de cada um deles no Tópico 4 deste manual. Observação: Caso o diretório de trabalho do n-host seja alterado, é necessário reiniciar o serviço do n-host e também do n-gpclient, para que ele também identifique a nova configuração. 4
5 3.2. Ativação do Trace Para identificar possíveis problemas na monitoração de eventos, existe a opção de ativar o registro de erros (Trace) do serviço n-gpclient. Para isso, deve-se acessar o registro do Windows e ir até a chave HKEY_LOCAL_MACHINE\SOFTWARE\NDDigital\n-Billing\n-Host\Plugins\NDDigital n-host n-gpclient (plugin): Após isso, deve-se criar um novo valor de sequência chamado debug, com valor true. Após este procedimento, os arquivos de trace começarão a ser gerados no diretório de trabalho do plugin, dentro do diretório Traces. É recomendado desativar o trace assim que o problema tenha sido simulado, pois os arquivos de trace monitoram todas as ações do serviço e podem ocupar muito espaço em disco, dependendo do tempo em que ficarem ativos. Para desativar, basta alterar o valor da chave Debug para False, ou excluí-la. A partir deste momento os arquivos não serão mais gerados. 4. Funcionamento De maneira geral, o plugin n-gpclient funciona da seguinte forma: todas as impressoras cadastradas no n-inventory (e consequentemente no arquivo NetworkPrinters.xml) serão monitoradas pelo plugin, que irá capturar o status e os alertas de cada uma delas. Cada evento que ocorrer na impressora será capturado pelo plugin, que irá guardar esta informação em seu banco de dados. Quando determinado evento persistir por mais de dez minutos, uma impressora que ficou sem papel, por exemplo, o plugin irá gerar um arquivo.npa no diretório EventsFiles, contendo estas informações e o enviará diretamente ao n-server, que processará este arquivo, fazendo com que este evento seja aberto e exibido no portal do Global Partner (GP). Quando o evento for resolvido, ou seja, quando for colocado papel na impressora, o plugin irá realizar o mesmo procedimento, enviando ao n-server o arquivo.npa contendo os dados de fechamento deste evento, assim ele não aparecerá mais na lista de eventos pendentes no GP. Os eventos e alertas que persistirem no intervalo de cinco e dez minutos ficarão gravados no banco de dados do plugin e a cada quatro horas será criado um arquivo de histórico com estas informações. O arquivo de histórico será criado no diretório HistoricFiles e diretamente enviado ao n-server, que processará este arquivo e armazenará no banco de dados da empresa correspondente. Eventos e alertas que não persistam por mais de cinco minutos, ficarão armazenados no banco de dados do plugin e após quatro horas será criado um arquivo de histórico com a extensão.nph no diretório TempFiles. Estes arquivos contêm eventos que não são considerados relevantes, portanto não serão enviados ao n-server. Arquivos.NPH com mais de trinta dias serão apagados. 5
6 5. Rotinas de Sincronização O n-gpclient realiza algumas rotinas de sincronização para verificar eventos e impressoras: A cada duas horas, as impressoras monitoradas pelo plugin serão sincronizadas com o n- Inventory, para que seja verificada a existência de novas impressoras, bem como a remoção daquelas que não serão mais monitoradas. A cada 24 horas cada equipamento terá seus eventos sincronizados com o servidor. O serviço do n-gpclient enviará um arquivo.npa com o campo IsSync = True. Esta sincronia irá evitar que eventos fiquem abertos no Global Partner mesmo que já estejam fechados na impressora, caso o servidor do n-gpclient tenha sido desligado ou alguma falha de comunicação tenha impedido de fechar o evento na hora correta. Quando existir alguma impressora que esteja sem comunicação por mais de 7 dias, o n- GPClient irá enviar um arquivo de sincronia desconsiderando qualquer outro evento que esteja em aberto e considerando apenas como impressora sem comunicação ou desligada. 6. Arquivo.NPA Um arquivo.npa (NDDigital Printer Alert) é um XML que contém os eventos e as informações da impressora a qual ele pertence, além de informações sobre a estação de trabalho que o gerou. Este arquivo é compactado e criptografado antes de ser enviado ao n-server. A seguir será apresentado um detalhamento da estrutura e das informações presentes neste arquivo Nomenclatura A definição do nome do arquivo físico segue o seguinte modelo: VV-IO-YYYYMMDDHHmmss-IP-NNN.npa Ex: AAA.npa Sendo: VV: Versão do arquivo; I: Indica se o arquivo está compactado; O: Indica se o arquivo está criptografado; YYYYMMDDHHmmss: Data de geração do arquivo; IP:Endereço IP de onde o arquivo foi gerado; NNN: Caracteres aleatórios para evitar duplicação Estrutura A estrutura do arquivo.npa é a seguinte: Dados do equipamento gerador Version: Versão do arquivo, padrão: 2; EnterpriseKey: Chave da empresa dos quais esses dados pertencem; CreatedDate: Data em que este arquivo foi gerado; 6
7 IsSync: Esta propriedade indica se o arquivo é de sincronia ou não; Operational System: Sistema operacional do computador; StrongName: Chave de identificação localizada em: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Print\Printers ComputerName: Nome do computador; IP: Contém o IP do computador que gerou o arquivo; Mask: Contém a máscara de sub-rede do computador que gerou o arquivo; MacAddress: Contém o MacAddress do computador que gerou o arquivo. Dados do Produto ProductName: Nome do produto, neste caso GPClient; ProductVersion: Versão do produto, neste caso Dados das impressoras PrinterName: Indica o nome da impressora. Esse nome pode ter sido dado pelo usuário no momento do cadastro ou ser uma sugestão composta por Fabricante + Modelo; ModelName: Modelo da impressora, retornado pela MIB; Manufacturer: Nome do fabricante da impressora; SerialNumber: Contém o número de série da impressora; AddressName: Indica o IP ou DNS da impressora na rede; AddressPort: Indica qual porta a impressora está respondendo (Ex: 9100); AddressMac: Indica o MACAddress da impressora. Dados dos eventos RFCCode: Indica o código do RFC (baseado na RFC 1759); RFCName: Indica o nome do RFC a que pertence o código, por exemplo: o 3 = coveropen (Tampa Aberta); o 801 = inputmediatraymissing (Bandeja ausente); o 1115 = markertonercartridgemissing (Cartucho ausente). StartedDateTime: Indica a data e hora que ocorreu o evento. Deve vir com o horário que ocorreu no Brasil e no seguinte formato: yyyy-mm-dd HH:mm:ss ; ResolvedDateTime: Indica a data e hora que o evento foi resolvido. Deve vir com o horário que ocorreu no Brasil e no seguinte formato: yyyy-mm-dd HH:mm:ss ; EventStatus: Indica o estado do evento: o 0 = Closed; o 1 = Open; o 2 = Historic. TrainingLevel: O valor desta propriedade especifica o nível de informação e formação que é necessário para resolver o alerta da impressora. Exemplos: o 3 = Untrained (Usuário sem treinamento); o 4 = Trained (Usuário treinado); SeverityLevel: O valor desta propriedade especifica o nivel crítico de cada alerta. Exemplos: o 1 = Other; o 3 = Critical; o 4 = Warning. Unit: O valor desta propriedade representa o tipo de subunidade dentro do modelo de impressora que o alerta está relacionado. Exemplos: o 8 = Input; o 9 = Output; o 10 = Marker. AdditionalInfo: Indica informações adicionais do evento, caso necessário; ErrorResourceString: Contém a descrição de erro de processamento, caso tenha ocorrido algum; DataEx: Indica um conjunto de propriedades que podem ser inseridas ao evento, caso necessário. Estas propriedades geralmente são capturadas quando existem eventos de problemas desconhecidos e variam conforme a impressora, pois representam códigos específicos. Os horários de abertura e resolução do evento (StartedDateTime e ResolvedDateTime), serão enviados no horário do Brasil, então o n-server irá processar estes arquivos e quando um usuário com horário diferente acessar o Global Partner (GP), o cálculo será feito para mostrar o horário correto para quem está acessando. O detalhamento dos itens citados neste documento visa guiar ao método correto de utilização do produto. Para atendimento de dúvidas e incidentes das soluções entre em contato com o Suporte NDDigital. Endereço: Rua Dr. Walmor Ribeiro, 431 Coral Lages SC CEP: Fone: (49)