WebSphere Message Broker, Versão 8.0.0.5 Sistemas operacionais: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

Consulte as informações sobre a versão mais recente do produto em IBM Integration Bus, Versão 9.0

FileInput

Utilize o nó FileInput para processar mensagens que são lidas a partir de arquivos.

Propósito

Uma ou mais mensagens podem ser lidas a partir de um único arquivo e cada mensagem é propagada como uma transação de fluxo separada. A parte de um arquivo que gera uma transação do fluxo de mensagens é chamada de registro. Um arquivo pode ser um registro único ou uma série de registros. As propriedades no nó especificam como o nó FileInput determina os registros em um arquivo.

O nó FileInput está contido no repositório Arquivo da paleta e é representado no WebSphere Message Broker Toolkit pelo seguinte ícone:

Ícone do nó FileInput

Estrutura da mensagem

O nó FileInput manipula mensagens nos seguintes domínios de mensagem:
  • DFDL
  • XMLNSC
  • DataObject
  • JSON
  • BLOB
  • MIME
  • MRM
  • JMSMap
  • JMSStream
  • XMLNS

Quando o nó do FileInput propaga uma mensagem, ele armazena informações sobre ela na árvore de mensagens LocalEnvironment.File. Se o arquivo de entrada estiver vazio, a mensagem será propagada (assumindo que ela seja válida). A tabela a seguir lista a estrutura em árvore de mensagens LocalEnvironment.File. Os elementos contêm dados sobre o registro atual.

Nome do Elemento Tipo de Dados do Elemento Descrição
Diretório CHARACTER O caminho de diretório absoluto do diretório de entrada no formato utilizado pelo sistema de arquivos do broker. Por exemplo, em sistemas Windows, ele começa com o prefixo de letra da unidade (como C:).
Nome CHARACTER Nome e extensão do arquivo.
LastModified TIMESTAMP Data e hora da última modificação do arquivo.
TimeStamp CHARACTER Data e hora, na zona Coordinated Universal Time (UTC), que o nó de entrada começou o processamento do arquivo como uma cadeia de caracteres. Esses dados são a cadeia utilizada para criar nomes de archive e de arquivo de restauração, se um registro de data e hora é incluído.
Os seguintes elementos contêm dados sobre o registro atual:
Offset INTEGER O início do registro no arquivo. O primeiro registro inicia no deslocamento 0. Quando o Deslocamento faz parte da árvore de mensagens Fim dos Dados, este valor é o comprimento do arquivo de entrada.
Registro INTEGER O número do registro no arquivo. O primeiro registro é o registro número 1. Quando Registro fizer parte da árvore de mensagens Fim dos Dados, este valor será o número de registros.
Delimitador CHARACTER Os caracteres utilizados para separar esse registro a partir do registro anterior, se Delimitado estiver especificado em Detecção de Registro. O primeiro registro tem um delimitador nulo. Quando o Delimitador fizer parte da árvore de mensagens Fim dos Dados, este valor será o delimitador que seguirá o último registro, se houver.
IsEmpty BOOLEAN Se o registro que é propagado pelo fluxo de mensagens estiver vazio. IsEmpty é configurado como TRUE se o registro atual estiver vazio. Quando IsEmpty fizer parte da árvore de mensagens Fim dos Dados, esta propriedade será sempre configurada como TRUE.

Utilizando este nó em um fluxo de mensagens

O nó FileInput pode ser utilizado em qualquer fluxo de mensagens que deve aceitar mensagens em arquivos. Também é possível consultar as seguintes amostras para ver como utilizar este nó:

Você só pode visualizar informações sobre amostras quando usa o centro de informações que está integrado ao WebSphere Message Broker Toolkit ou o centro de informações on-line. Você só poderá executar amostras quando usar o centro de informações que está integrado ao WebSphere Message Broker Toolkit.

Se você configurar um nó Arquivo para usar FTP, sua rede poderá precisar dele para conectar-se a um servidor proxy FTP, em vez de diretamente com o servidor FTP remoto. A maneira como você configura os nós Arquivo para usar um proxy FTP depende de como esse proxy trata os pedidos. Para alguns proxies FTP, é necessário codificar as informações do servidor FTP de destino nas credenciais de logon que você cria com o comando mqsisetdbparms. Por exemplo, alguns proxies FTP suportam os seguintes valores:
Nome de Usuário: FtpTargetHostUsername@ProxyUserName@TargetFtpHostname 
Senha: TargetFtpUserPassword@ProxyUserPassword
Outros proxies podem requerer uma codificação diferente ou configuração externa ou podem não conseguir usá-las com os nós Arquivo.

Quando tiver colocado uma instância do nó FileInput em um fluxo de mensagens, você poderá configurá-lo; consulte Configurando o Nó FileInput. As propriedades do nó são exibidas na visualização Propriedades. Todas as propriedades obrigatórias para as quais é necessário inserir um valor (as propriedades que não têm um valor-padrão definido) são marcadas com um asterisco.

Terminais e Propriedades

Os terminais do nó FileInput são descritos na tabela a seguir.

Terminal Descrição
Failure O terminal de saída para o qual a mensagem é roteada se ocorrer um erro antes de uma mensagem ser propagada para o terminal de Saída. As mensagens propagadas neste terminal não são validadas, mesmo que você tenha especificado, utilizando a propriedade Validar, que a validação deve ocorrer.
Saída O terminal de saída para o qual uma mensagem será roteada se ela tiver sido extraída com sucesso do arquivo de entrada. Se não ocorrerem erros no nó de entrada, uma mensagem recebida de um recurso externo será sempre enviada para o terminal Out primeiro.
Fim dos Dados O terminal de saída para o qual a mensagem Fim de Dados é roteada depois que todas as mensagens em um arquivo forem processadas. A transação do fluxo de mensagens Fim de Dados será iniciada somente se o terminal estiver anexado.
Catch O terminal de saída para o qual a mensagem será roteada se for emitida uma exceção downstream e capturada por este nó. As exceções serão capturadas somente se o terminal estiver anexado.

As tabelas a seguir descrevem as propriedades do nó. A coluna com cabeçalho M indica se a propriedade é obrigatória (marcada com um asterisco caso seja necessário digitar um valor quando nenhum padrão for definido); a coluna com cabeçalho C indica se a propriedade é configurável (você poderá alterar o valor quando incluir o fluxo de mensagens ao arquivo BAR para implementá-lo).

Propriedades de Descrição:

Propriedade M P Default Descrição
Nome de nó Não Não FileInput O nome do nó.
Short description Não Não Nenhuma Uma breve descrição do nó.
Descrição Longa Não Não Nenhuma Texto que descreve a finalidade do nó no fluxo de mensagens.

Propriedades Básicas:

Propriedade M P Default Descrição Propriedade do Comando mqsiapplybaroverride
Diretório de entrada Sim Sim Nenhuma O caminho do diretório a partir do qual os arquivos de entrada são processados. O diretório deve estar em um sistema de arquivos ao qual o broker tem acesso. Se o diretório de entrada não existir, nenhum arquivo será processado. O nó FileInput verifica se o diretório de entrada existe em intervalos que são definidos pela propriedade Atraso da Varredura. O diretório de entrada deve existir, mesmo se você estiver processando arquivos sobre FTP ou SFTP.

Especifique o diretório como um caminho de diretório absoluto ou relativo. Se o caminho de diretório for relativo, ele será baseado no diretório especificado na variável de ambiente MQSI_FILENODES_ROOT_DIRECTORY. Um exemplo nos sistemas Windows é C:\fileinput. Um exemplo nos sistemas UNIX é /var/fileinput. No Windows, se você especificar um diretório compartilhado, mapeado para seu computador local, especifique o nome de compartilhamento em vez da letra que representa a unidade; por exemplo \\myshare\mydirectory.

O nó FileInput cria um subdiretório mqsitransitin no diretório de entrada especificado. O subdiretório mqsitransitin mantém e bloqueia arquivos de entrada enquanto eles estão sendo processados. Se um grupo de execução que processa arquivos neste diretório de entrada for removido, verifique o subdiretório mqsitransitin para obter arquivos parcialmente processados ou não processados. Mova quaisquer arquivos desse tipo de volta para o diretório de entrada (e remova o prefixo de UUID do grupo de execução dos nomes de arquivo) para que eles possam ser processados por um grupo de execução diferente.

inputDirectory
Incluir subdiretórios locais Sim Sim Falso Determina se todos os subdiretórios no diretório de entrada especificado também devem ser procurados em relação a arquivos a serem processados. Se você selecionar essa propriedade e a propriedade Transferência Remota, apenas o diretório de nível superior especificado no sistema remoto será procurado em relação a arquivos. recursiveDirectories
Nome do arquivo ou padrão Sim Sim * Um nome de arquivo ou cadeia contendo caracteres curinga opcionais (* ou ?) identificando o arquivo, ou os arquivos, para processamento a partir do diretório de entrada. filenamePattern
Padrão de exclusão de arquivo Não Sim Nenhuma Uma sequência simples contendo caracteres curinga opcionais (* e ?) que identificam arquivos a serem excluídos do processamento. excludePattern
Ação no processamento com êxito Sim Não Exclusão A ação executada pelo nó no arquivo após o processamento bem-sucedido do conteúdo. As opções válidas são:
  • Mover para Subdiretório de Archive
  • Incluir Registro de Data e Hora e Mover para Subdiretório de Archive
  • Exclusão
 
Substituir arquivos de archive duplicados Sim Não Não selecionada Esta propriedade controla se o nó substitui os arquivos archive existentes pelo mesmo nome que o arquivo de entrada. Ela se aplica apenas quando a Ação no Processamento Bem-sucedido não é Excluir.  

As propriedades de Análise de Mensagem de Entrada do nó FileInput estão descritas na seguinte tabela:

Propriedade M P Default Descrição
Domínio de mensagem Não Não BLOB O domínio usado para analisar a mensagem. Se o campo estiver em branco, o padrão será BLOB.
Modelo de mensagem Não Não Não selecionada O nome do local do arquivo de esquema do modelo de mensagem no qual a mensagem é definida. Essa lista é preenchida com todos os arquivos de esquema de modelo de mensagem disponível para o domínio de mensagem selecionado.
Message Não Não Não selecionada O nome ou o local de um elemento global que modela um documento de dados inteiro e está contido no arquivo de esquema do modelo de mensagem. Essa lista é preenchida com todas as mensagens disponíveis definidas no modelo de mensagem que você selecionou.
Formato físico Não Não Não selecionada O nome do formato físico da mensagem. Se estiver utilizando o analisador MRM ou IDOC, selecione da lista o formato físico da mensagem que chega. Essa lista inclui todos os formatos físicos que você definiu para o modelo de mensagem selecionado. Se você configurar a propriedade Domínio de Mensagem como DataObject, poderá configurar esta propriedade como XML ou SAP ALE IDoc. Configure esta propriedade como SAP ALE IDoc quando precisar analisar um fluxo de bits a partir de uma origem externa e gere uma árvore de mensagens.
ID do conjunto de caracteres codificados de mensagens Sim Não Sistema Intermediário Padrão O ID do conjunto de caracteres codificados utilizados para interpretar os bytes do arquivo que está sendo lido. A propriedade do comando mqsiapplybaroverride é messageCodedCharSetIdProperty.
Codificação de mensagens Sim Não Sistema Intermediário Determinado O esquema de codificação para números e caracteres grandes utilizado para interpretar bytes do arquivo que está sendo lido. Os valores válidos são Determinado pelo Sistema do Intermediário ou um valor de codificação numérico. Para obter informações adicionais sobre codificação, consulte Conversão de Dados. A propriedade do comando mqsiapplybaroverride é messageEncodingProperty.

Propriedades de Opções do Analisador:

Propriedade M P Default Descrição
Cronometragem de análise (Parse timing) Não Não On Demand Esta propriedade controla quando uma mensagem de entrada é analisada. Os valores válidos são:
  • On Demand
  • Imediato
  • Completo

Para obter uma descrição completa desta propriedade, consulte Analisando On Demand.

Construir árvore utilizando tipos de dados de esquema XML Não Não Não selecionada Esta propriedade controla se os elementos da sintaxe na árvore de mensagens possuem tipos de dados obtidos do Esquema XML.
Utilizar analisador compacto XMLNSC para domínio XMLNS Não Não Não selecionada Especifica se o Analisador Compacto XMLNSC é usado para mensagens no Domínio XMLNS. Se você configurar esta propriedade, os dados da mensagem aparecerão em XMLNSC nos nós que estão conectados ao terminal de saída quando um dos itens a seguir for XMLNS:
  • O cabeçalho MQRFH2 de entrada.
  • A propriedade Análise da Mensagem de Entrada, Domínio de Mensagem.
Reter conteúdo misto Não Não Não selecionada Esta propriedade controla se o analisador XMLNSC cria elementos na árvore de mensagens para texto misto em uma mensagem de entrada. Se você selecionar a caixa de opções, serão criados elementos para texto misto. Se você desmarcar a caixa de opções, texto misto será ignorado e nenhum elemento será criado.
Reter comentários Não Não Não selecionada Especifica se o analisador XMLNSC cria elementos na árvore de mensagens para comentários em uma mensagem de entrada. Se você selecionar a caixa de opções, serão criados elementos para comentários. Se você desmarcar a caixa de opções, comentários serão ignorados e nenhum elemento será criado.
Reter instruções de processamento Não Não Não selecionada Esta propriedade controla se o analisador XMLNSC cria elementos na árvore de mensagens para instruções de processamento em uma mensagem de entrada. Se você selecionar a caixa de opções, serão criados elementos para instruções de processamento. Se você desmarcar a caixa de opções, instruções de processamento serão ignoradas e nenhum elemento será criado.
Elementos opacos Não Não Em branco Essa propriedade é utilizada para especificar uma lista de elementos na mensagem de entrada que devem ser analisados em segundo plano pelo analisador XMLNSC. A análise de ignorados será desempenhada apenas se a validação não estiver ativada (ou seja, se Validar for Nenhum); as entradas especificadas em Elementos Ignorados serão ignoradas se a validação estiver ativada.

Propriedade de Sondagem:

Propriedade M P Default Descrição Propriedade do Comando mqsiapplybaroverride
Intervalo de sondagem (segundos) Sim Sim 5 O intervalo de sondagem em segundos. waitInterval

Propriedades de Nova Tentativa:

Propriedade M P Default Descrição Propriedade do Comando mqsiapplybaroverride
Tentar mecanismo novamente Sim Não Failure Como o nó manipula uma falha de fluxo. As opções válidas são:
  • Failure
  • Repetição Curta
  • Repetição Curta e Longa
 
Tentar limite novamente Sim Sim 0 O número de vezes para tentar a transação do fluxo novamente quando o valor da propriedade Mecanismo de Nova Tentativa é Nova Tentativa Curta. retryThreshold
Intervalo de repetições curtas Não Sim 0 O intervalo, em segundos, entre cada nova tentativa se a propriedade Tentar Limite Novamente não for zero. shortRetryInterval
Intervalo de repetições longas Não Sim 300 O intervalo entre novas tentativas, se a propriedade Tentar Mecanismo Novamente for Nova Tentativa Curta e Longa e o limite de novas tentativas tiver se exaurido. longRetryInterval
Ação no arquivo com falha Sim Sim Mover para o Subdiretório de Restauração A ação que o nó executa com o arquivo de entrada se todas as tentativas de processar o conteúdo do arquivo de entrada falharem. As opções válidas são:
  • Mover para o Subdiretório de Restauração
  • Exclusão
  • Incluir Registro de Data e Hora e Mover para Subdiretório de Restauração
 

Propriedades de Registros e Elementos:

Propriedade M P Default Descrição
Detecção de registro Sim Não Arquivo Inteiro O mecanismo utilizado para identificar registros no arquivo de entrada. As opções válidas são:
  • Arquivo Inteiro

    Ao configurar essa propriedade como Arquivo Inteiro, os arquivos maiores de 2 Gb não são suportados.

  • Comprimento Fixo
  • Delimitado
  • Sequência de Registro Analisado
Comprimento Sim Não 80 O comprimento de cada registro, em bytes, quando a detecção de registroComprimento Fixo está selecionada.
Delimitador Sim Não Final de linha do DOS ou do UNIX O tipo de bytes do delimitador que separa ou finaliza cada registro quando a detecção de registro Delimitado está selecionada. As opções válidas são:
  • Final de linha do DOS ou do UNIX
  • Delimitador Customizado
Delimitador customizado Não Não   Os bytes do delimitador, expressos em hexadecimal, quando a detecção de registro Delimitado e Delimitador Customizado estão selecionados. Esta propriedade é obrigatória somente se a propriedade Delimitador estiver configurada como Delimitador Customizado.
Tipo de delimitador Sim Não Postfix A posição do delimitador quando a detecção de registro Delimitado está selecionada. As opções válidas são:
  • Postfix
  • Infix
Essa propriedade é ignorada, a menos que a propriedade Delimitador seja configurada para Delimitador Customizado.
Ignorar primeiro registro Sim Não FALSE Ignore o primeiro registro no arquivo. O nó FileInput lerá o primeiro registro no arquivo, mas não propagará o registro para o terminal de Saída. Os registros serão propagados normalmente, do segundo registro em diante. Use essa opção quando o primeiro registro for um cabeçalho que não precisa ser processado. Não é válido usar essa opção ao usar o arquivo todo.

Propriedades de Validação:

Para obter uma descrição completa destas propriedades, consulte Propriedades de Validação.

Propriedade M P Default Descrição Propriedade do Comando mqsiapplybaroverride
Validar Não Sim Nenhuma Essa propriedade controla se a validação ocorre. Os valores válidos são:
  • Nenhuma
  • Conteúdo e Valor (Content and Value)
  • Conteúdo
validateMaster
Ação de falha Não Não Exceção Essa propriedade controla o que acontecerá se a validação falhar. Os valores válidos são:
  • Rastreio do Usuário
  • Local Error Log
  • Exceção
  • Lista de Exceções (Exception List)
 

Propriedades de FTP:

Propriedade M P Default Descrição Propriedade do Comando mqsiapplybaroverride
Transferência Remota Não Sim Não selecionada Esta propriedade define se o nó usa as propriedades de transferência de arquivos remota listadas na guia FTP e lê arquivos a partir de um servidor FTP ou SFTP. Se você selecionar essa propriedade e a propriedade Incluir subdiretórios locais, apenas o diretório de nível superior especificado no sistema remoto será procurado em relação a arquivos. fileFtp
Protocolo de Transferência Não Sim FTP Esta propriedade especifica o protocolo a ser usado para transferência remota. Os valores válidos são:
  • FTP
  • SFTP
remoteTransferType
Servidor e Porta Remotos Não Sim Nenhuma Esta propriedade pode ter um dos seguintes valores:
  • O endereço IP ou nome (e, opcionalmente, o número da porta) de um servidor FTP ou SFTP remoto; por exemplo ftp.server.com:21 ou sftp.server.com:22
  • O nome de um serviço configurável do tipo FtpServer
Se um nome de serviço configurável for especificado, qualquer ou todas as outras propriedades de transferência remotas na guia FTP poderão ser substituídas pelo serviço configurável.
fileFtpServer
Identidade de Segurança Não Sim   O nome da identificação do usuário usada para acessar o servidor FTP ou SFTP. Essa propriedade é substituída pela propriedade securityIdentity, se definida, no serviço configurável FtpServer. fileFtpUser
Diretório do servidor Não Sim "." O diretório no servidor FTP ou SFTP a partir do qual transferir arquivos. Se você especificar esta propriedade como um caminho relativo, ele será relativo para o diretório home após o logon. Essa propriedade é substituída pela propriedade remoteDirectory, se definida, no serviço configurável FtpServer. fileFtpDirectory
Modo de transferência Não Não Binário O modo de transferência de FTP para a transferência de dados de arquivo. Esta propriedade é válida somente quando FTP é selecionado como o protocolo para transferência remota. Os valores válidos são:
  • Binário
  • ASCII
Essa propriedade é substituída pela propriedade transferMode, se definida, no serviço configurável FtpServer.

Se você tiver especificado SFTP como o protocolo para transferência remota, a propriedade Modo de Transferência será ignorada e a codificação Binária será usada.

 
Atraso da varredura Não Sim 60 O atraso, em segundos, entre as varreduras de diretórios remotos. Esta propriedade substitui o conjunto de valores para Intervalo de Sondagem quando a propriedade Transferência Remota é selecionada. Essa propriedade é substituída pela propriedade scanDelay, se definida, no serviço configurável FtpServer.  

Propriedades de Transações:

Propriedade M P Default Descrição
Modo de Transação Não Sim Não O modo de transação neste nó de entrada determina se o restante dos nós no fluxo será executado no ponto de sincronização. As opções válidas são:
  • Sim
  • Não
Propriedades de Instâncias. Para obter uma descrição completa destas propriedades, consulte Propriedades Configuráveis do Fluxo de Mensagens.
Propriedade M P Default Descrição Propriedade do Comando mqsiapplybaroverride
Conjunto de instâncias adicionais Não Sim Utilizar Conjunto Associado ao Fluxo de Mensagens O conjunto do qual as instâncias adicionais são obtidas.
  • Se você selecionar Utilizar Conjunto Associado ao Fluxo de Mensagens, as instâncias adicionais serão obtidas a partir do conjunto de fluxos de mensagens.
  • Se você selecionar Usar Conjunto Associado ao Nó, instâncias adicionais serão alocadas a partir das instâncias adicionais do nó com base no número especificado na propriedade Instâncias Adicionais.
componentLevel
Instâncias Adicionais Não Sim 0 O número de instâncias adicionais que o nó pode iniciar se a propriedade do Conjunto de Instâncias Adicionais estiver configurada como Utilizar Conjunto Associado ao Nó. additionalInstances
As propriedades Monitoramento do nó são descritas na tabela a seguir.
Propriedade M P Default Descrição
Eventos Não Não Nenhum Eventos definidos para o nó são exibidos nesta guia. Por padrão, nenhum evento de monitoramento é definido em um nó do fluxo de mensagens. Utilize Incluir, Editar, e Excluir para criar, alterar ou excluir eventos de monitoração no nó; consulte Configurando fontes de eventos de monitoramento utilizando propriedades de monitoramento para detalhes.

É possível ativar e desativar eventos mostrados aqui selecionando ou desmarcando a caixa de opções Ativado.

Avisos | Marcas Registradas | Downloads | Biblioteca | Suporte | Feedback

Copyright IBM Corporation 1999, 2014Copyright IBM Corporation 1999, 2014.

        
        Última atualização:
        
        Última atualização: 2015-02-28 18:28:42


Tópico de ReferênciaTópico de Referência | Versão 8.0.0.5 | ac55150_