Padrão ix. Manual do Usuário Q-Ware Command Processor

Transcrição

1 Padrão ix Manual do Usuário Q-Ware Command Processor

2 Copyright Padrão ix Sistemas Abertos. Todos os direitos reservados. As informações contidas neste manual estão sujeitas a alteração sem aviso prévio. Os nomes e dados fornecidos nos exemplos são fictícios, exceto quando especificado o contrário. Q-Ware e Q-Ware Command Processor são marcas registradas da Padrão ix. Windows 95, Windows 98, Windows NT, Windows XP, Windows Vista, Windows 2000 e Windows 2003 são marcas registradas da Microsoft Corporation. Todas as demais marcas e marcas registradas são propriedades de seus respectivos donos. Padrão ix Sistemas Abertos. SIA Sul Trecho 4 Lotes 420/430 Brasília, DF Telefone: Fax: info@pix.com.br Impresso no Brasil: 2008

3 Índice Analítico Índice Analítico...iii Índice de Figuras...vi Prefácio...1 Audiência... 1 Pré-requisitos... 1 Capítulo Introdução...3 Definição... 3 Plataformas suportadas... 3 Funcionalidades... 4 Execução de comandos através de filas... 4 Segurança... 4 Registro das transferências e auditoria... 4 Interface de linha de comando... 5 Capítulo Conceitos...6 Alias... 6 Aplicação Q-Ware... 7 Cliente Q-Ware... 7 Fila de processamento... 7 Histórico... 7 Log... 7 Plugins Q-Ware... 8 Serviço Q-Ware... 8 iii

4 Command Processor Manager...9 Capítulo Administração visual...10 Janela da fila de processamento Janela de histórico de processamento Modos de visualização Alterando o modo de visualização Atualizando a exibição de informações Menus Menu Conexão Menu Comandos Menu Serviço Menu Visualização Menu Ajuda Barra de ferramentas Capítulo Controlando as filas de execução de comandos...19 Configurando o acesso a um servidor Q-Ware Incluindo um servidor Q-Ware na interface Caixa de diálogo cadastro de Servidor Conectando a um servidor Q-Ware Criação de um serviço Ativando e desativando serviços Removendo serviços Configurando serviços Salvando a configuração de serviços Monitorando serviços Histórico Capítulo Segurança...30 iv

5 Capítulo Criando uma fila de processamento de comandos...31 Caixa de diálogo Criação de Serviço de execução de comandos Aba Identificação Aba Comando Aba Controle Aba Regras Aba Plugins Capítulo Gerenciamento da execução de comandos...44 Enfileirando parâmetros de comando Removendo elementos de uma fila Apêndice A Tabela de eventos Índice Analítico v

6 Índice de Figuras Figura 1 - Janela principal do Command Processor Manager Figura 2 - Janela da fila de processamento Figura 3 - Janela de histórico de processamento Figura 4 - Selecionando modo de visualização Figura 5 - Menu Conexão Figura 6 - Menu Comandos Figura 7 - Menu Serviço Figura 8 - Menu Ajuda Tabela 1 - Lista de ícones da barra de ferramentas Figura 9 - Caixa de diálogo de conexão Figura 10 - Cadastra servidor Q-Ware na lista de servidores Figura 11 - Menu Serviço Figura 12 - Histórico de uma fila de processamento de comandos Figura 13 - Caixa de diálogo Pesquisa no Histórico Figura 14 - Criação de uma fila (serviço) de execução de comandos Figura 15 Criação de serviço Identificação Figura 16 Criação de serviço Comando Figura 17 Criação de Serviço Controle Figura 18 Criação de Serviço Regras Figura 19 - Criação de Serviço Plugins Figura 20 Enfileiramento de Comandos vi

7 Prefácio Audiência Pré-requisitos Administradores de sistema, responsáveis pela instalação, gerência e utilização das funcionalidades. Este manual pressupõe que os usuários do sistema estejam completamente familiarizados com os conceitos e a operação dos sistemas operacionais onde o Q-Ware Command Processor funciona, principalmente o Microsoft Windows. Também é importante ter bons conhecimentos sobre o Q-Ware. Para obter mais informações sobre o Q-Ware, consulte o Manual do usuário do Q-Ware. Os conhecimentos necessários para a administração do Q-Ware Command Processor são: Gerais: Conhecimentos sobre arquitetura cliente/servidor; Familiaridade com redes TCP/IP; Familiaridade com execução de processos (scripts e executáveis). Em ambiente Windows: Inicialização do sistema; Utilitários básicos de administração, como Windows Explorer, Painel de Controle, etc.; Conceito e utilização de serviços; Conhecimento de programação em BATCH. 1

8 Em ambiente UNIX: Inicialização do sistema; Utilitários básicos de administração como ls, rm, ps, kill, grep, etc.; Inicialização/finalização de processos; Conceitos de processos residentes e não-residentes; Shell scripts. 2 Manual do Usuário do Q-Ware / FDS

9 CAPÍTULO 1 Introdução O Q-Ware Command Processor (QWCMDPROC) é um serviço do Q-Ware destinado à execução controlada de processos. Isto significa que o sistema pode executar processos de forma controlada, capturar a saída ou o código de retorno dos processos e em função deles tomar as ações devidas, reiniciar a execução em casos de erro e registrar todos os eventos ocorridos durante os processos. Toda a parte de controle é realizada pelo Q-Ware, um produto que oferece recursos de fila, logs e controle de acesso. Para obter mais informações sobre o Q-Ware, consulte o Manual do usuário do Q-Ware. Definição O Q-Ware Command Processor (QWCMDPROC) é um sistema de execução controlada de comandos, desenvolvido sobre o Q-Ware. A execução dos comandos é feita através de filas do Q-Ware. Ele pode (e deve) ser utilizado quando se deseja ter um controle apurado sobre a execução de um determinado comando e é especialmente valioso quando integrado ao Q-Ware FDS em complemento aos comandos remotos e locais, pré e pós-transferência. Plataformas suportadas Os módulos do QWCMDPROC estão disponíveis em uma variedade de plataformas Windows e Unix, possibilitando a configuração de soluções integradas para realizar a automação de processos desejada. A interface de gerência do produto está disponível apenas para as plataformas Windows. O serviço do Q-Ware, no entanto, está disponível para todas as plataformas no qual o Q-Ware funciona. 3

10 Funcionalidades Execução de comandos através de filas Segurança A execução de comandos (scripts ou executáveis) se dá a partir de filas do Q-Ware. Isso permite a execução em lote de um conjunto de processos, garantindo que um novo comando somente será executado depois do sucesso do outro. Múltiplas filas podem ser usadas para processos distintos ao mesmo tempo. As filas permitem controle mais apurado sobre os processos provendo: Organização: filas diferentes para processos diferentes. Por exemplo, você pode ter uma fila para processar ordens de compra e outra fila para processar cargas de um banco de dados da extranet. Segurança: determinadas filas podem ser acessadas apenas por usuários específicos. Controle do processamento: filas podem ser ativadas nos momentos certos. Controle de carga: o processamento em filas permite a serialização de processos liberando o processador. Mais filas ativadas de forma simultânea permite adequar a carga à sua capacidade de processamento. O QWCMDPROC usa o Q-Ware para autenticar e autorizar os usuários nas filas. Registro das transferências e auditoria Utilizando o subsistema de logs do Q-Ware, o QWCMDPROC registra todas as execuções realizadas, incluindo a data e a hora de cada evento (início, fim, erros, etc.). Isto permite controle total sobre as operações realizadas. O acesso ao log é feito pela aplicação de gerência do FDS, o FDS Monitor, ou do Command Processor Manager. 4 Manual do Usuário do Q-Ware / FDSCommand Processor

11 Interface de linha de comando Como qualquer aplicação Q-Ware, o QWCMDPROC pode se beneficiar das funcionalidades dos comandos de linha do Q-Ware. Estes comandos auxiliam a integração de aplicações ao QWCMDPROC. As ferramentas de linha de comando do Q-Ware permitem iniciar e parar manualmente ou em lote (através de scripts de controle) os serviços de execução do QWCMDPROC. O uso dos comandos de linha é particularmente útil em ambiente UNIX, onde o uso de scripts é muito difundido. Para obter mais informações sobre os comandos de linha do Q-Ware, consulte o Manual do usuário do Q-Ware. Capítulo 1 5

12 CAPÍTULO 2 Conceitos Alias Termo utilizado para identificação de elementos como filas, servidores, etc. Um alias (ou apelido) válido deve seguir as regras de formação abaixo: São válidos todos os caracteres alfabéticos não acentuados (Ç, ç, Ñ e ñ são considerados caracteres acentuados); Não é permitido o uso de espaços em branco; O primeiro caracter tem que ser alfabético; Números e o caracter _ (sublinhado) são admitidos; Um alias também não diferencia os caracteres quanto ao uso de maiúsculas e minúsculas. Portanto o alias SERVIDOR_2 é o mesmo que servidor_2 ; Um alias pode ter no máximo 16 caracteres. Portanto, são aliases válidos: FILA36 Equivale a Fila36, ou fila36, etc. FILA_36 Equivale a Fila_36, ou fila_36, etc. São aliases inválidos: FILA#36 O caracter # é inválido. FILA-36 O caracter é inválido. 36FILA Iniciado com um caracter numérico. _FILA_36 Iniciado com o caracter _ (sublinha). 6 Manual do Usuário do Q-Ware / FDSCommand Processor

13 Aplicação Q-Ware É qualquer aplicação cliente Q-Ware desenvolvida especificamente para ser controlada pelo Q-Ware. Isso significa que elas podem ser cadastradas no Q-Ware Server para serem executadas e encerradas por comando do Q-Ware Server. Aplicações Q-Ware são as únicas que podem consumir objetos de uma fila do Q-Ware Server. O QWCMDPROC é uma aplicação Q-Ware. Cliente Q-Ware É qualquer aplicação desenvolvida sobre a API do Q-Ware, e que faça uso de qualquer uma das funcionalidades do Q-Ware Server. O Q-Ware Command Processor Manager é um cliente Q-Ware. Fila de processamento Histórico Uma fila de processamento é uma instância do Q-Ware Command Processor. Também pode ser denominado como serviço. Consiste de um tipo especial de log, onde os eventos relevantes são os momentos de início e término do processamento de um objeto qualquer, realizado por uma aplicação Q-Ware. O histórico contém também outros dados específicos do objeto processado. No caso do QWCMDPROC, o objeto é o comando a ser executado com seus devidos parâmetros. Log Conjunto de linhas de informações onde cada linha é um registro de ocorrência de um fato ou evento relevante, em relação a qualquer operação realizada. Capítulo 2 7

14 Plugins Q-Ware São aplicações especialmente desenvolvidas para serem acionadas pelo Q-Ware na ocorrência de eventos específicos determinados pelo usuário. Tais aplicações precisam ser desenvolvidas especificamente para cada tipo de evento (ou conjunto de eventos) tratado. Serviço Q-Ware Quando uma aplicação Q-Ware é executada, ela passa a ser um Serviço Q-Ware, ou seja, uma instância de uma aplicação é um serviço. Uma mesma aplicação pode ser instanciada por mais de um serviço com parâmetros de configuração diferentes. Também pode ser referenciada como fila de execução (QWCMDPROC) ou fila de transferência (FDS). 8 Manual do Usuário do Q-Ware / FDSCommand Processor

15 PARTE II Command Processor Manager O Command Processor Manager (ou CMDPROCMNGR) é a ferramenta de administração visual do Q-Ware Command Processor. Desenvolvido para ambiente Windows, o CMDPROCMNGR permite configurar e gerenciar os serviços (ou filas) de execução de comandos. Lembrete: A interface de gerência Command Processor Manager funciona apenas em ambiente Windows. 9

16 CAPÍTULO 3 Administração visual O Command Processor Manager (CMDPROCMNGR) é a interface gráfica para administração e monitoração dos serviços do Q-Ware Command Processor. A Figura 1 mostra a janela principal do CMDPROCMNGR e seus componentes. Figura 1 - Janela principal do Command Processor Manager A janela principal está dividida em três partes. Acima, ficam os menus e a barra de ferramentas. No meio está a janela que apresenta a fila de processamento. Mais abaixo está a janela que apresenta o histórico do processamento dos comandos. Janela da fila de processamento A janela da fila de processamento apresenta os comandos (lista de parâmetros) enfileirados para processamento. 10 Manual do Usuário do Q-Ware / FDSCommand Processor

17 A Figura 2 mostra uma fila com dois elementos. Observe que cada elemento da fila é formado por: Lista de parâmetros; Regras para saída padrão; Dono; Data de enfileiramento; Identificador do elemento da fila. Veja o capítulo 4 deste manual para maiores detalhes sobre o significado de cada um desses itens. Figura 2 - Janela da fila de processamento Janela de histórico de processamento A janela de histórico exibe informações relativas ao processamento dos elementos da fila. Para cada elemento da fila, uma entrada é gerada no histórico indicando: ERRO Ok Removido Erro no processamento Processamento com sucesso Elemento excluído A Figura 3 apresenta um exemplo da janela de histórico na qual é exibido o resultado do processamento de três comandos. Capítulo 3 11

18 Figura 3 - Janela de histórico de processamento Modos de visualização O Q-Ware Command Processor Manager permite que o usuário configure três modos de visualização. Os modos permitem alternar entre: visualizar apenas a fila de processamento, visualizar apenas o histórico de processamento, visualizar tanto a fila como o histórico. Alterando o modo de visualização Para alterar o modo de visualização acesse o menu Visualização e selecione o modo desejado conforme a Figura 4, a seguir. Figura 4 - Selecionando modo de visualização Atualizando a exibição de informações Como o Command Processor Manager é um aplicativo cliente de gerência remota dos serviços Q-Ware Command Processor executados em um servidor Q-Ware, as informações exibidas pelo mesmo são, na verdade, uma fotografia do estado do servidor em um dado momento. 12 Manual do Usuário do Q-Ware / FDSCommand Processor

19 Para atualizar as informações do servidor conectado, no menu Visualização, selecione Atualizar servidor. O Command Processor Manager solicitará ao Q-Ware todas as informações sobre todos os serviços do servidor selecionado. Para atualizar apenas as informações do serviço corrente e visível na janela de informações, no menu Visualização selecione Atualiza. Você também pode configurar o Command Processor Manager para atualizar periodicamente estas informações. Para fazer isto, especifique a freqüência da atualização (em segundos) na caixa de texto ao lado do botão de atualização automática da barra de ferramentas. Depois, pressione o botão de atualização periódica ou selecione no menu Visualização o item Atualiza periodicamente. Para obter mais informações sobre os botões do Command Processor Manager, consulte a seção Barra de ferramentas deste manual. Não é recomendável definir esta freqüência de atualização com um número muito baixo. Se a freqüência for zero, as informações serão constantemente atualizadas, gerando uma quantidade elevada de tráfego na rede, além de muitas consultas aos bancos de dados de controle do Q-Ware. Toda esta atividade pode prejudicar o desempenho dos processos. Menus Esta seção do manual apresenta as opções de todos os menus do Command Processor Manager bem como as funcionalidades que podem ser acessadas. Algumas das funções existentes nos menus do Command Processor Manager também podem ser acessadas por meio do menu de contexto. Este menu é exibido quando se clica com o botão direito do mouse sobre um elemento na janela da fila de processamento ou na janela de histórico. Os comandos disponíveis dependem do elemento clicado (Linha de histórico ou elemento da fila). Capítulo 3 13

20 Menu Conexão O menu Conexão contém os comandos que permitem a conexão e desconexão do servidor Q-Ware. Figura 5 - Menu Conexão Conectar Abre a caixa de diálogo que permite a conexão com um Q-Ware Server. Nessa caixa de diálogo é possível selecionar o servidor a partir de uma lista ou cadastrar novos servidores. Desconectar Desconecta o Command Processor Manager do servidor Q-Ware corrente. Sair Encerra a execução do Command Processor Manager. Menu Comandos O menu Comandos contém os comandos de acesso às ações e funcionalidades relacionadas à fila e ao histórico do serviço selecionado. Figura 6 - Menu Comandos 14 Manual do Usuário do Q-Ware / FDSCommand Processor

21 Novo Enfileira um novo comando na fila. Remove Remove o(s) comando(s) selecionado(s) na janela da fila de comandos. Reenfileira Reenfileira o comando selecionado no histórico para novo processamento. Pesquisa no histórico Abre a caixa de diálogo de pesquisa no histórico, permitindo filtros de busca como data ou estado final do processamento. Menu Serviço O menu Serviço contém os comandos de acesso às ações e funcionalidades relacionadas à configuração e ao gerenciamento de serviços de transferência. Figura 7 - Menu Serviço Capítulo 3 15

22 Cria serviço Abre a caixa de diálogo de criação de uma fila de processamento de comandos (serviço). Para obter mais informações sobre como criar filas de processamento de comandos, consulte o Capítulo 6, Criando uma fila de processamento de comandos. Configura o serviço Abre a caixa de diálogo de configuração do serviço selecionado. Remove serviço Remove o serviço selecionado. Grava configuração Salva a configuração do serviço selecionado no servidor, armazenando todas as alterações feitas na configuração do mesmo. Grava todas as configurações Salva no servidor, a configuração de todos os serviços modificados, armazenando todas as alterações feitas na configuração dos mesmos. Desativa Desativa o serviço selecionado. Ativa Ativa o serviço selecionado. Reativa Desativa e ativa novamente o serviço selecionado. Menu Visualização Veja detalhes sobre este menu e os modos de visualização disponíveis no início deste capítulo. 16 Manual do Usuário do Q-Ware / FDSCommand Processor

23 Menu Ajuda Figura 8 - Menu Ajuda Sobre Exibe uma janela com informações sobre o Q-Ware Command Processor Manager. Barra de ferramentas A barra de ferramentas é um conjunto de botões de atalho para os principais comandos dos menus do Q-Ware Command Processor Manager. A tabela a seguir lista e descreve todos os botões das barras de ferramentas do Command Processor Manager. Botão Descrição Abre a caixa de diálogo de conexão com o servidor Q-Ware. Seleciona a fila de processamento de comandos a ser visualizada. Abre a caixa de diálogo para enfileirar um novo conjunto de parâmetros na fila de comandos visualizada. Remove os comandos selecionados da fila de comandos visualizada. Abre a caixa de diálogo de criação de uma fila de processamento de comandos (serviço). Abre a caixa de diálogo de configuração do serviço selecionado. Remove o serviço visualizado. Salva a configuração do serviço selecionado no servidor, armazenando todas as alterações feitas na configuração do mesmo. Salva no servidor, a configuração de todos os serviços modificados, armazenando todas as alterações feitas na configuração dos mesmos. Capítulo 3 17

24 Botão Descrição Atualiza as informações exibidas na janela de informações referentes ao serviço visualizado. Botão do tipo liga/desliga para definir a atualização periódica da janela de informações, de acordo com o intervalo de tempo (em segundos) especificado na caixa de texto ao lado. Caixa de texto para especificar o número de linhas exibidas ou recuperadas sempre que as informações forem atualizadas. Altera a data a partir do qual as informações de histórico são apresentadas. Por default, o histórico apresenta as informações do dia corrente. Serve como um filtro de pesquisa no histórico. Desativa o serviço selecionado. Ativa o serviço selecionado. Desativa e ativa novamente o serviço selecionado. Tabela 1 - Lista de ícones da barra de ferramentas 18 Manual do Usuário do Q-Ware / FDSCommand Processor

25 CAPÍTULO 4 Controlando as filas de execução de comandos Este capítulo apresenta os recursos do Q-Ware Command Processor Manager para o gerenciamento dos serviços. Este gerenciamento envolve atividades relacionadas à criação, configuração, ativação, monitoração, desativação e remoção de serviços. Por ser uma aplicação Q-Ware, todo serviço de execução de comandos é executado em um servidor Q-Ware. Portanto, o primeiro passo no gerenciamento de serviços é configurar o acesso ao servidor Q-Ware no qual tais serviços serão executados. Configurando o acesso a um servidor Q-Ware Incluindo um servidor Q-Ware na interface Para incluir um novo servidor Q-Ware na lista de seleção exibida na janela principal, no menu Conexão, selecione a opção Conecta. Alternativamente, pode-se clicar no botão correspondente na barra de ferramentas. Uma janela como a da Figura 9 será apresentada. Clique no botão que aparece logo ao lado da lista de servidores. Uma janela como a da Figura 10 será apresentada para inserir os dados do servidor Q-Ware. Preencha os campos conforme solicitado. 19

26 Figura 9 - Caixa de diálogo de conexão Para alterar a configuração de um servidor, na lista da caixa de diálogo de conexão (Figura 9), selecione o servidor desejado e, em seguida, clique no botão (edita servidor). Uma janela como a da Figura 10 será apresentada já preenchida com os dados do servidor selecionado. Altere esses dados com os novos valores e pressione o botão Grava. Figura 10 - Cadastra servidor Q-Ware na lista de servidores 20 Manual do Usuário do Q-Ware / FDSCommand Processor

27 Para remover um servidor da lista de servidores cadastrados o procedimento é o mesmo usado para alterar a configuração. Neste caso, você deve pressionar o botão Remove. Caixa de diálogo cadastro de Servidor Endereço do servidor Este campo deve ser preenchido com o nome de rede ou o endereço IP do servidor Q-Ware a ser incluído. Porta O valor deste campo corresponde à porta através da qual o Command Processor Manager se conectará ao servidor Q-Ware. O valor padrão da instalação do servidor Q-Ware é Em caso de dúvida, consulte o administrador do servidor Q-Ware para saber qual a porta utilizada. Descrição O valor fornecido para este campo será utilizado para exibição do servidor na lista da janela de servidores. Conectando a um servidor Q-Ware Depois de incluído o servidor, é preciso conectar-se ao mesmo para poder criar e configurar os serviços do Q-Ware Command Processor. Para conectar-se ao servidor Q-Ware, selecione o servidor no qual irá trabalhar. No menu Conexão, escolha Conecta. Alternativamente, você pode clicar sobre o ícone da barra de ferramentas. Clique sobre o servidor desejado. Será exibida a caixa de diálogo da Figura 9. Selecione o servidor da lista e informe o nome e a senha do usuário com o qual irá se conectar ao mesmo. O ícone do servidor na janela da esquerda indica se a conexão foi feita. A janela da direita exibe os serviços já configurados nesse servidor, se houver algum. Capítulo 4 21

28 Criação de um serviço Agora é preciso criar serviços para que o Command Processor esteja pronto para executar comandos. A criação de um serviço significa estabelecer todos os parâmetros operacionais que definem o comportamento do serviço durante sua operação. Por exemplo, é possível utilizar parâmetros para definir quais os códigos de retorno e que parâmetros os comandos irão receber. Para criar um novo serviço, clique no menu Serviços/Cria serviço (Figura 11). Figura 11 - Menu Serviço Para mais informações sobre como criar e configurar serviços, consulte a seção pertinente no capítulo 6. Ativando e desativando serviços Depois de criar um serviço, é preciso torná-lo operacional, ou seja, ativá-lo. Só depois de ativado, o serviço poderá executar as funções para as quais foi desenvolvido. Para ativar um serviço configurado, selecione o serviço e, no menu Serviço, selecione Ativa. Para desativar um serviço, selecione o serviço e, no menu Serviço, selecione Desativa. Também é possível ativar e desativar através do item de menu Reativa. 22 Manual do Usuário do Q-Ware / FDSCommand Processor

29 Removendo serviços Para remover um serviço configurado em um servidor Q-Ware, selecione o serviço que será removido. No menu Serviço, selecione Remove. Será exibida uma caixa de diálogo solicitando a confirmação da remoção do serviço. Configurando serviços O processo de configuração de um serviço é idêntico ao de criação, sendo que neste caso o serviço precisa ter sido criado anteriormente. Para configurar um serviço, no menu Serviço, selecione Configura o serviço... Salvando a configuração de serviços Após terem sido feitas as configurações necessárias você deve salvar essas configurações em definitivo no servidor Q-Ware. Para salvar essas configurações, no menu Serviço, selecione a opção Grava configuração. Alternativamente você pode fazer uso da opção Grava todas as configurações. Essa opção salvará as configurações de todos os serviços que por ventura tenham sido alterados. Monitorando serviços Uma das atividades envolvidas no gerenciamento dos serviços com Q-Ware Command Processor é a monitoração das funções dos mesmos através do log e histórico dos serviços. Para tanto, o Command Processor Manager disponibiliza funcionalidades que permitem o rápido acesso a tais informações, assim como a realização de pesquisas nos históricos para recuperação das informações desejadas. Esta sessão apresenta todos os recursos disponíveis para exibir as informações de histórico de serviços do Q-Ware Command Processor. Capítulo 4 23

30 Observação: As logs textuais devem ser monitoradas através da interface do FDS Monitor. Os serviços do Q-Ware Command Processor aparecerão no FDS Monitor como serviços genéricos. Veja o manual do FDS Monitor para maiores detalhes de como acessar a log de serviços. Histórico O histórico é um tipo especial de log, e existe apenas para os serviços que gerarem esse tipo de informação. Os módulos do FDS (serviço cliente TCP/IP, o serviço servidor TCP/IP), bem como o Q-Ware Command Processor são serviços que geram essa informação. O histórico é um repositório transacional de informações sobre todas as ocorrências do processamento de um objeto, a partir do momento que o serviço tomou conhecimento do objeto até a finalização do processamento. O histórico de um objeto só existe após o seu processamento e conterá o resultado conforme registrado pela aplicação que o processou. O histórico é armazenado no banco de dados de controle do servidor Q-Ware. Assim como o log, o histórico do Command Processor é formado por um conjunto de linhas que contêm informações sobre o processamento dos objetos (um por linha). O histórico é um tipo de log de sucessos e insucessos dos processamentos, contendo as informações sobre os eventos ocorridos para cada objeto processado ou não, conforme descrito a seguir. Formato do histórico O formato do histórico muda de acordo com a aplicação. Por exemplo, no caso do monitorador de diretórios, apenas o nome e tamanho do arquivo estão relacionados. Já no caso do Q-Ware Command Processor, as informações presentes no histórico dizem respeito aos parâmetros enfileirados conforme lista a seguir: Parâmetros Lista dos parâmetros do comando enfileirados. Estado Indicativo do resultado do processamento. Os valores possíveis são: 24 Manual do Usuário do Q-Ware / FDSCommand Processor

31 Ok Erro Removido Indica que o comando da fila foi processado com sucesso. Indica que houve um erro durante o processamento. Indica que o elemento foi cancelado, ou seja, retirado da fila. Código Se Estado indicar um erro, então este campo conterá o código do erro detectado indicando o código de retorno do comando. Regras para saída padrão Um arquivo externo contendo as regras de tratamento da saída padrão para esse elemento processado. Esse conjunto de regras se sobrepõe caso definido, àquele salvo na configuração do serviço. Regras para retorno Um arquivo externo contendo as regras de tratamento do código de retorno (return code) do comando referente ao elemento processado. Esse conjunto de regras se sobrepõe caso definido, àquele salvo na configuração do serviço. Enfileiramento Contém a data e a hora em que o objeto (parâmetros do comando) foi enfileirado. Início Contém a data e a hora do início do processamento do comando da fila. Término Contém a data e a hora em que o processamento foi concluído. De acordo com o Estado, este término pode ter um significado diferente. Se o objeto foi cancelado, indica o momento do cancelamento. Se ocorrer um erro durante o processamento, então, este campo contém o momento em que o arquivo foi retirado da fila devido ao erro. Capítulo 4 25

32 Identificador Contém o identificador do objeto (parâmetros do comando) processado, como atribuído no momento em que o mesmo foi enfileirado. Este identificador é a chave de recuperação de informações sobre o objeto a ser utilizada por aplicações que façam interface com o servidor Q-Ware via API. Acessando o histórico Para acessar o histórico de um serviço, selecione o serviço na lista de filas de processamento de comando conforme indicado na Tabela 1 ( ). Isto exibirá o histórico do serviço selecionado, gerado no dia corrente, na janela de informações de histórico. Também é possível selecionar o histórico de um dia qualquer pressionando o botão correspondente na barra de ferramentas conforme a Tabela 1: Se o número de linhas do histórico for muito grande, o Command Processor Manager limita o número de linhas recuperadas de acordo com o valor especificado na caixa de texto da barra de ferramentas de navegação: Por padrão, o Command Processor Manager é configurado para exibir 500 linhas de histórico. É possível modificar este número de acordo com a necessidade. Para alterá-lo, clique com o mouse dentro da caixa, digite o valor desejado e, em seguida, pressione Enter. A Figura 12 mostra um exemplo de histórico de um serviço de transferência. Figura 12 - Histórico de uma fila de processamento de comandos Na parte superior da janela de histórico, a barra de status mostra o número de linhas exibidas na janela de informações, o número de linhas disponíveis para navegação igual ou menor que número definido na caixa de texto da navegação, e o número de linhas total do histórico (3 de 3 conforme a Figura 12). 26 Manual do Usuário do Q-Ware / FDSCommand Processor

33 Pesquisa no histórico Para fazer uma pesquisa no histórico de um serviço, selecione o serviço na lista de filas de processamento de comando conforme indicado na Tabela 1 ( ). Depois, no menu Comandos, escolha Pesquisa no Histórico. Será exibida a caixa de diálogo Pesquisa no Histórico, como mostra a Figura 13. Nesta caixa de diálogo, defina apenas os critérios desejados. Pressione Ok para confirmar a pesquisa ou Cancela para fechar a caixa de diálogo sem fazer a pesquisa. Figura 13 - Caixa de diálogo Pesquisa no Histórico A pesquisa será realizada e só serão exibidos os registros do histórico que corresponder exatamente aos critérios especificados na caixa de diálogo Pesquisa no Histórico. Observe que o número de linhas recuperadas e exibidas na janela também está limitado ao número informado na barra de ferramentas. Para atualizar a exibição dos registros recuperados, selecione no menu Visualização a opção Atualiza, ou pressione o botão de atualização na barra de ferramentas ou ainda a tecla F5. Para obter mais informações sobre as opções disponíveis na barra de ferramentas, consulte o Capítulo 3, Administração visual. Capítulo 4 27

34 Caixa de diálogo Pesquisa no Histórico Estado final Define o estado final dos arquivos a serem pesquisados, ou seja, se a transferência/processamento foi bem sucedida, cancelada ou se ocorreu erro. Apenas os registros cujo estado final corresponda ao valor informado neste campo serão exibidos. Seleção de data/hora Restringe a exibição de acordo com a data de enfileiramento, data de término, ou data de início. Da data Indica a data inicial, se estiver com a opção selecionada, de busca da informação de histórico. Caso não queira usar este parâmetro na busca simplesmente desmarque a opção. Até a data Indica a data final, se estiver com a opção selecionada, de busca da informação de histórico. Caso não queira usar este parâmetro na busca simplesmente desmarque a opção. Da hora Indica a hora inicial, se estiver com a opção selecionada, de busca da informação de histórico. Caso não queira usar este parâmetro na busca simplesmente desmarque a opção. Até a hora Indica a hora final, se estiver com a opção selecionada, de busca da informação de histórico. Caso não queira usar este parâmetro na busca simplesmente desmarque a opção. 28 Manual do Usuário do Q-Ware / FDSCommand Processor

35 Exemplo: Para restringir a exibição do histórico somente aos comandos enfileirados entre 08:00 e 09:00 h, do dia 22/06/2007, selecione Enfileiramento no campo Seleção de data/hora, selecione a data 22/06/2007 no campo Data, desmarque a opção do campo Até a data ou selecione a mesma data (22/06/2007), selecione a hora 08:00 no campo Da hora e a 09:00 no campo Até a hora. Dinâmica da pesquisa Independentemente do serviço selecionado no momento da definição, a pesquisa configurada será aplicada a todo serviço selecionado posteriormente. Capítulo 4 29

36 CAPÍTULO 5 Segurança O Q-Ware possui um rigoroso sistema de segurança que controla o acesso e processamento de serviços. Este sistema de segurança utiliza perfis de usuário para definir se uma ação de acesso ou manipulação de um determinado serviço pode ou não ser realizada por um usuário. Toda a administração dos perfis é feita através da interface do FDS Monitor. Para maiores detalhes sobre como administrar a segurança através do FDS Monitor, leia o Manual do FDS, capítulo Manual do Usuário do Q-Ware / FDSCommand Processor

37 CAPÍTULO 6 Criando uma fila de processamento de comandos As filas de processamento de comandos são na realidade filas de parâmetros de um determinado comando, sendo que o próprio comando pode ser um dos parâmetros da fila. Neste documento, quando nos referirmos a comando, estamos indicando qualquer módulo executável, seja ele um script, um job batch, um executável, um procedimento ou uma rotina. Como o Q-Ware considera uma fila de processamento de comandos como um serviço, freqüentemente utilizaremos o termo serviço de processamento de comandos (ou simplesmente serviço ) como sinônimo de fila de processamento de comandos. Este capítulo trata da criação e configuração de serviços de processamento de comandos. Para obter informações sobre como utilizar filas de processamento de comandos, consulte o Capítulo 7, Gerenciamento da execução de comandos. Para criar um serviço de processamento de comandos, conecte-se no servidor Q-Ware em que deseja criar o serviço. Em seguida, no menu Serviço, escolha Criar serviço. Será exibida a caixa de diálogo Criação de serviço de execução de comandos. Preencha os campos desta caixa conforme sua necessidade. Clique em Ok para efetivar a criação do serviço ou Cancela para fechar a caixa de diálogo sem criar o serviço. 31

38 Figura 14 - Criação de uma fila (serviço) de execução de comandos Caixa de diálogo Criação de Serviço de execução de comandos Aba Identificação Esta caixa de diálogo permite criar e configurar um serviço de execução de comandos que opera sobre uma fila. Assim, é comum dizer criar uma fila. Esta caixa de diálogo é dividida em abas de informações. As outras abas contêm informações opcionais ou valores preestabelecidos. Cada aba é explicada a seguir. O preenchimento desta aba é obrigatório. Nesta aba são definidos o nome do serviço (fila) e sua descrição. A seguir, estão descritos cada um dos campos da aba. 32 Manual do Usuário do Q-Ware / FDSCommand Processor

39 Figura 15 Criação de serviço Identificação Alias Campo obrigatório. Deve ser preenchido com o alias, ou seja, o nome de referência do serviço para o Q-Ware, que será utilizado para identificar o serviço em mensagens do log, funções da API, comandos de linha, etc. Deve-se especificar um nome que seja exclusivo a este cliente de transferência. Não pode haver no mesmo servidor, mais de um serviço com o mesmo alias. Descrição Um texto descritivo da fila. A descrição é exibida pelo Q-Ware Command Processor ou pelo FDS Monitor. Aba Comando Esta aba contém a definição do comando a ser executado. A Figura 16 mostra os campos desta aba. A seguir estão descritos cada um dos campos da página. Capítulo 6 33

40 Figura 16 Criação de serviço Comando Comando Especifica os parâmetros (ou o próprio) do comando a ser executado. Os parâmetros são identificados numericamente Onde N significa a posição do parâmetro na linha de comando. Por exemplo, ao definirmos como comando estamos indicando que essa fila executará o comando del para todo parâmetro que for enfileirado na mesma. Um comando também pode especificar uma chamada a uma rotina em linguagem CSL ( Para tanto, basta usar o comando especial QWCSLCALL. O QWCSLCALL é um comando interno que ativa rotinas definidas no campo Script. O mesmo deve ser seguido do nome da função a ser chamada e dos parâmetros da mesma, que podem ser fixos ou oriundos da fila etc.). 34 Manual do Usuário do Q-Ware / FDSCommand Processor

41 Exemplos de comandos: copy c:\arquivos @3 Script Define diretamente as rotinas de um script escrito em linguagem CSL ( que podem ser executadas pelo Command Processor através do comando QWCSLCALL (veja item anterior). Diferentemente da execução de scripts através de comandos externos como o shell (/bin/sh) ou mesmo o interpretador CSL (csl), a execução das rotinas escritas neste campo, através do comando interno QWCSLCALL, se dará no mesmo espaço de endereçamento do Q-Ware Command Processor, evitando assim a execução de um comando externo e funcionando como uma linguagem embarcada. Caso as rotinas sejam muito extensas recomendamos que as mesmas sejam escritas em arquivos externos. Exemplo de rotina: #loadlibrary 'ZcSysLib' #loadlibrary 'ZcFileLb' ChegouArquivo( const DirArquivo, const NomeArquivo ); ChegouArquivo( const DirArquivo, const NomeArquivo ) { var FullPath; var fh; FullPath = DirArquivo '\\' NomeArquivo; try { fh = fileopen( FullPath, fileopenread+fileopenold ); } catch ( const xx[] ) { syslog( 'Nao consegui encontrar o arquivo: ' FullPath ); return -1; } syslog( 'Arquivo encontrado: ' FullPath ); fileclose( fh ); return 0; } Capítulo 6 35

42 Aba Controle Nesta aba se define como o comando será executado e seu comportamento em relação a possíveis erros. Figura 17 Criação de Serviço Controle Tentativas Indica o número de vezes que o comando será executado antes de sinalizar um erro ou parar a fila caso a ação para o erro seja de RETRY (tentar novamente). Se for preenchido com o valor 0 (zero), o sistema fará infinitas tentativas de execução. Se for especificado um valor maior que zero e o número de tentativas atingir este limite, o sistema poderá, dependendo das regras definidas para a fila: 1. Parar o processamento da fila; 2. Registrar no histórico e no log o erro ocorrido, retirar o elemento da fila e iniciar o processamento do próximo item. 36 Manual do Usuário do Q-Ware / FDSCommand Processor

43 Dormência (s) Especifica o tempo (em segundos) que o sistema deve aguardar para realizar uma nova tentativa de execução do processo, se a tentativa anterior tiver falhado. O valor padrão deste campo é cinco. Tempo máximo (seg.) Tempo máximo que será usado na execução do processo antes do sistema sinalizar isso como uma ocorrência de erro. Caso o valor seja 0 (zero), o tempo será considerado infinito. Esta opção não está ainda em operação. Toda a execução será considerada com tempo igual a zero (infinito). Sinaliza um erro após todas as tentativas e pega o próximo elemento da fila Este campo trabalha em sincronia com o campo Tentativas. Se selecionada, esta opção indica que, se todas as tentativas de execução falharem, o sistema sinalizará um erro no log/histórico e processará o próximo elemento na fila. Quando desmarcada, o processamento da fila será interrompido ao término da última tentativa. Toda execução de processos é registrada no histórico ao sair da fila, independentemente da condição de sua saída da fila (sucesso, erro ou cancelamento/remoção). Captura o código de retorno da execução do comando Indica que o Command Processor deve proceder à captura do código de retorno (return code) do comando executado. Isso permite que regras sejam definidas para tratar esse código de retorno. Este campo trabalha em conjunto com o campo Código de retorno da aba Regras. Captura a saída padrão do comando e armazena no log Capítulo 6 37

44 Esta opção faz com que a saída da execução do comando seja registrada no log do Q-Ware. Para tanto, o comando deve produzir sua saída na saída padrão (stdout). Comandos que executam aplicações com interface gráfica não produzirão saída no log porque não possuem saída padrão. Se desejar registrar em log também a saída padrão de erros (stderr), a mesma deverá ser redirecionada para a saída padrão através do comando 2>&1. Este campo pode trabalhar em conjunto com o campo Saída Padrão da aba Regras. Dados de entrada Este campo é opcional e indica o nome de um arquivo cujo conteúdo será usado como entrada padrão do comando sendo executado. Em outras palavras, a entrada padrão do comando será redirecionada para o arquivo definido neste campo. Aba Regras Esta aba contém a definição das regras que regerão a execução do comando, indicando o sucesso ou o erro na execução do mesmo. São definidas regras tanto para a saída padrão do comando executado quanto para o código de retorno do mesmo. 38 Manual do Usuário do Q-Ware / FDSCommand Processor

45 Figura 18 Criação de Serviço Regras Saída padrão O conjunto de regras para saída padrão é na realidade um conjunto de linhas no formato: PADRÃO, AÇÃO. Este campo trabalha em conjunto com o campo Captura a saída padrão do comando e armazena no log da aba Controle, sendo que não faz sentido criar estas regras se o citado campo não estiver marcado. PADRÃO indica um ou mais padrões de busca usados para identificar a regra e separados pelo operador boleano & (E). Exemplos de padrões válidos: teste, teste & do & q-ware, teste do q-ware. O Caractere especial # pode ser colocado no começo da palavra para indicar busca pelo padrão independente de caixa. Por exemplo, o padrão #teste pode indicar a palavra teste, ou Teste, ou TESTE, ou teste ou testemunho. Capítulo 6 39

46 AÇÃO pode ser: SUCCESS: comando executado com sucesso. STOP: erro na execução do comando. Pare o serviço. CANCEL: erro na execução do comando. Sinalize o erro e tire o elemento da fila passando para o próximo. RETRY: erro na execução do comando. Tente executar novamente até o limite imposto pelo campo Tentativas da aba Controle. Na Figura 18 acima podemos ver um exemplo de um conjunto de regras válido para o comando ftp do Windows. Código de retorno O conjunto de regras para o código de retorno é na realidade um conjunto de linhas no formato: CÓDIGO, AÇÃO. Este campo trabalha em conjunto com o campo Captura o código de retorno da execução do comando da aba Controle, sendo que não faz sentido criar estas regras se o citado campo não estiver marcado. CÓDIGO pode ser definido por apenas um número (5), por um conjunto de números separados por ; (1;5;10;12) ou por uma faixa de números no formato [N1:N2] ([1:100]) ou por uma combinação deles (1;2;[3:5]). AÇÃO pode ser: SUCCESS: comando executado com sucesso. STOP: erro na execução do comando. Pare o serviço. CANCEL: erro na execução do comando. Sinalize o erro e tire o elemento da fila passando para o próximo. RETRY: erro na execução do comando. Tente executar novamente até o limite imposto pelo campo Tentativas da aba Controle. Na Figura 18 mais acima, podemos ver um exemplo de um conjunto de regras válido para um comando. 40 Manual do Usuário do Q-Ware / FDSCommand Processor

47 Aba Plugins O preenchimento desta página é opcional. Nesta página é possível configurar os plugins que devem ser executados na ocorrência de eventos específicos no Q-Ware. Só será possível associar plugins a eventos se houverem plugins cadastrados no Q-Ware para o serviço. O Q-Ware reconhece os seguintes eventos: Evento de log ocorre quando um determinado alias de evento é registrado no log. Mensagem de log ocorre quando, ao registrar uma mensagem no log, é detectado um determinado termo no texto de descrição da mensagem. Pré-fila ocorre imediatamente antes do enfileiramento de um conjunto de parâmetros para um comando. Pós-fila ocorre imediatamente após a retirada de um elemento (parâmetros de um comando) de uma fila por sucesso, insucesso ou cancelamento. Erro ocorre sempre que um serviço relata que a execução de um comando com os parâmetros dados foi efetuada com erro de acordo com as regras fornecidas. Observar que este plugin específico só será ativado caso a opção Sinalizar falhas de envio como erro e continuar da aba Controle esteja selecionada e o número máximo de tentativas seja atingido, ou ainda, se a regra definida na aba Regras determinar a ocorrência de um erro. Para obter mais informações sobre plugins, consulte o Manual do usuário do Q-Ware. A Figura 19 mostra os campos desta página. A seguir estão descritos cada um dos campos da página. Capítulo 6 41

48 Figura 19 - Criação de Serviço Plugins Evento Permite selecionar o plugin cadastrado que deve ser ativado na ocorrência de eventos de log específicos. O campo Parâmetros deve ser preenchido com os aliases (separados por vírgula) que determinam a ativação do plugin. Mensagem Especifica o plugin que deve ser ativado quando ocorrer uma mensagem de log (descrição de evento) específica. O campo Parâmetros deve ser preenchido com o texto de mensagem que determinará o disparo da execução do plugin. 42 Manual do Usuário do Q-Ware / FDSCommand Processor

49 Pré-fila Nesta lista, pode-se selecionar um plugin a ser executado antes do enfileiramento de um conjunto de parâmetros para um comando. Pós-fila Nesta lista, pode-se selecionar um plugin a ser executado no momento do desenfileiramento do conjunto de parâmetros para um comando. Esta lista contém apenas os plugins cadastrados no sistema. Erro Nesta lista, pode-se selecionar um plugin a ser executado quando houver erro na execução de um comando com os parâmetros dados e de acordo com as regras fornecidas. Esta lista contém apenas os plugins cadastrados no sistema. Lembrar que o erro só será determinado se a opção Sinaliza um erro após todas as tentativas e pega o próximo elemento da fila estiver selecionada e o número máximo de tentativas for atingido, ou ainda, se a regra definida na aba Regras determinar a ocorrência de um erro. Servidor Caso o plugin associado a um evento ou mensagem precisar se comunicar com um servidor de monitoração de eventos, informe neste campo o endereço de rede onde está sendo executado o servidor. Porta Complementa a informação do servidor de monitoração de eventos. Observar que os parâmetros Servidor e Porta somente serão utilizados por plugins que tenham sido registrados para comunicação via socket TCP/IP. Capítulo 6 43

50 CAPÍTULO 7 Gerenciamento da execução de comandos O gerenciamento da execução de comandos envolve a remoção ou enfileiramento de elementos (parâmetros) de uma fila. Este capítulo mostra como essas atividades podem ser desempenhadas utilizando as funcionalidades do Q-Ware Command Processor Manager. Para executar estas tarefas, no entanto, o usuário precisa ter as devidas permissões. Para obter informações sobre permissões, consulte o Manual do usuário do Q-Ware e o capítulo correspondente à segurança do Manual do FDS Monitor Todas estas operações também podem ser integradas em aplicações através de chamadas de funções da API. Para obter informações sobre a utilização da API para integração com aplicações, consulte o Manual de desenvolvimento de aplicações Q-Ware. Enfileirando parâmetros de comando Para inserir um conjunto de parâmetros para um determinado comando, selecione a fila de comandos desejada. No menu Comandos, selecione Novo. Será exibida a caixa de diálogo Enfileiramento de comandos, como mostra a Figura 20. Alternativamente, pode-se clicar com o botão direito do mouse sobre janela da fila, e selecionar a opção Novo no menu de contexto. Preencha os campos da configuração do enfileiramento e pressione Ok para confirmar o enfileiramento ou Cancela para fechar a caixa de diálogo sem enfileirar os parâmetros do comando. 44 Manual do Usuário do Q-Ware / FDSCommand Processor

51 Figura 20 Enfileiramento de Comandos Parâmetros do comando Especifica os parâmetros do comando de acordo com o que foi definido na configuração do serviço. Cada parâmetro passado será posteriormente utilizado no lugar da macro arroba correspondente A separação dos parâmetros será feita pelo caractere espaço, e caso o espaço seja necessário para o parâmetro, o mesmo deve estar integralmente entre aspas duplas. A ordem dos parâmetros indica o cardinal da macro arroba. Desta forma, o primeiro parâmetro representa o segundo parâmetro representa e assim sucessivamente. A Figura 20 acima apresenta um exemplo de enfileiramento de dois parâmetros para um comando. Arquivo de regras para tratamento de saída padrão O preenchimento deste campo é opcional. Define um arquivo texto contendo um conjunto de regras para o tratamento da saída padrão do comando, que se sobreporá ao que foi definido para o serviço. Esta sobreposição se dará apenas para o elemento da fila em questão. O arquivo deverá ser em formato texto com uma regra por linha. Capítulo 7 45

52 Arquivo de regras para tratamento de código de retorno O preenchimento deste campo é opcional. Define um arquivo texto contendo um conjunto de regras para o tratamento do código de retorno do comando, que se sobreporá ao que foi definido para o serviço. Esta sobreposição se dará apenas para o elemento da fila em questão. O arquivo deverá ser em formato texto com uma regra por linha. Removendo elementos de uma fila Para remover elementos de uma fila, na janela da fila de processamento, selecione os elementos a serem excluídos. No menu Comandos, escolha Remove ou pressione a tecla DEL. Alternativamente pode-se clicar sobre o(s) elemento(s) selecionado(s) com o botão direito do mouse e selecionar a opção Remove no menu de contexto. Depois de remover os elementos desejados, a fila será devidamente reorganizada para exibir os mesmos na ordem em que foram enfileirados. Apenas usuários com a devida permissão podem remover elementos de uma fila. Para obter informações sobre como configurar permissões de usuários, consulte o Manual do usuário do Q-Ware e o capítulo correspondente à segurança do Manual do FDS Monitor. 46 Manual do Usuário do Q-Ware / FDSCommand Processor