Formato da mensagem de solicitação para transferência de arquivos

As transferências de arquivos são iniciadas por mensagens XML que chegam em uma fila de comando do agente, geralmente como resultado de um usuário emitir um comando de transferência de arquivos ou usando o plug-in do Explorer do WebSphere® MQ O XML de solicitação da transferência deve estar em conformidade com o esquema FileTransfer.xsd e ter o elemento < request> como o elemento-raiz O documento de esquema FileTransfer.xsd está localizado no diretório MQ_INSTALLATION_PATH/mqft/samples/schema. O esquema FileTransfer.xsd importa fteutils.xsd, que está no mesmo diretório.

As mensagens de transferência de arquivos podem ter um dos três elementos-raiz a seguir:
  • <request> - para novas solicitações de transferência de arquivos, solicitações de chamada gerenciadas ou exclusão de transferências planejadas que estão pendentes
  • <cancel> - para cancelamento de transferências de arquivos em andamento
  • <transferSpecifications>-para especificar diversos grupos de arquivos de transferência, usados pelo comando fteCreateTransfer

Para obter informações sobre como especificar diversos grupos de transferência usando o elemento <transferSpecifications>, consulte Usando arquivos de definição de transferência

Esquema

O esquema a seguir descreve quais elementos são válidos em uma mensagem XML de solicitação de transferência.

<xsd:schema xmlns:xsd="https://www.w3.org/2001/XMLSchema">

<xsd:include schemaLocation="fteutils.xsd"/>

    <!--
        Defines the request of a managed transfer and version number
        <request version="1.00" ...
            <managedTransfer>
                ...
            </managedTransfer>
        </request>
     -->
    <xsd:element name="request">
        <xsd:complexType>
            <xsd:choice>
                <xsd:element name="managedTransfer" type="managedTransferType"/>
                <xsd:element name="deleteScheduledTransfer" type="deleteScheduledTransferType"/>
                <xsd:element name="managedCall" type="managedCallType"/>
            </xsd:choice>
            <xsd:attribute name="version" type="versionType" use="required"/>
        </xsd:complexType>
    </xsd:element>

    <!--
        Defines the cancel request of a managed transfer and version number
        <cancel version="1.00"
                  xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
                  xsi:noNamespaceSchemaLocation="FileTransfer.xsd">
            <originator>
                <hostName>myMachine</hostName>
                <userID>myUserId</userID>
            </originator>     - Delete a scheduled transfer.
            
            <transfer>
               Transfer ID to Cancel
            </transfer>
        </cancel>
     -->
    <xsd:element name="cancel">
        <xsd:complexType>
            <xsd:sequence>
                <xsd:element name="originator" type="hostUserIDType" maxOccurs="1" minOccurs="1"/>
                <xsd:choice> 
                    <xsd:element name="transfer" type="IDType" maxOccurs="1" minOccurs="1"/>
                    <xsd:element name="call"     type="IDType" maxOccurs="1" minOccurs="1"/>
                </xsd:choice>
                <xsd:element name="reply"      type="replyType"      maxOccurs="1" minOccurs="0"/>
            </xsd:sequence>
            <xsd:attribute name="version" type="versionType" use="required"/>
        </xsd:complexType>
    </xsd:element>

    <!--
        Defines the transfer definition element structure.
        <transferSpecifications>
            <item ...
            <item ...
        </transferSpecifications>
     -->
    <xsd:element name="transferSpecifications">
        <xsd:complexType>
            <xsd:sequence>
                <xsd:element name="item" type="itemType" minOccurs="1" maxOccurs="unbounded"/>
            </xsd:sequence>
        </xsd:complexType>
    </xsd:element>

    <!--
        Define a managed transfer of an instigator and request
        <managedTransfer>

            <originator>
                ...
            </originator>

            <schedule>
                <submit timebase="source"|"UTC">2008-12-07T16:07"</submit>
                <repeat>
                    <frequency interval="hours">2</frequency>
                    <expireTime>2008-12-0816:07</expireTime>
                </repeat>
            </schedule>

            <sourceAgent agent="here" QMgr="near"/>
            <destinationAgent agent="there" QMgr="far"/>

            <trigger>
            ...
            </trigger>

            <transferSet>
                ...
            </transferSet>
        </managedTransfer>
     -->

     <xsd:complexType name="managedTransferType">
         <xsd:sequence>
            <xsd:element name="originator"       type="origTransferRequestType"  maxOccurs="1" minOccurs="1"/>
            <xsd:element name="schedule"         type="scheduleType"     maxOccurs="1" minOccurs="0"/>
            <xsd:element name="sourceAgent"      type="agentType"        maxOccurs="1" minOccurs="1"/>
            <xsd:element name="destinationAgent" type="agentClientType"  maxOccurs="1" minOccurs="1"/>
            <xsd:element name="trigger"          type="triggerType"      maxOccurs="1" minOccurs="0"/>
            <xsd:element name="reply"            type="replyType"        maxOccurs="1" minOccurs="0"/>
            <xsd:element name="transferSet"      type="transferSetType"  maxOccurs="1" minOccurs="1"/>
            <xsd:element name="job"              type="jobType"          maxOccurs="1" minOccurs="0"/>
        </xsd:sequence>
    </xsd:complexType>

    <!--
         This is a modified form of origRequestType which is used on a managed transfer request.
         The hostName and userID are mandatory attributes in this case.
     -->
    <xsd:complexType name="origTransferRequestType">
        <xsd:sequence>
            <xsd:element name="hostName" type="xsd:string" minOccurs="1" maxOccurs="1"/>
            <xsd:element name="userID" type="xsd:string" minOccurs="1" maxOccurs="1"/>
            <xsd:element name="mqmdUserID" type="xsd:string" minOccurs="0" maxOccurs="1"/>
            <xsd:element name="webBrowser" type="xsd:string" minOccurs="0" maxOccurs="1"/>
            <xsd:element name="webUserID" type="xsd:string" minOccurs="0" maxOccurs="1"/>
        </xsd:sequence>
    </xsd:complexType>

    <!--
        Defines the transferset of source and destination agent and one or more files
        <transferset priority="1">
            <metaDataSet>
                <metaData key="keyname">keyvalue</metaData>
                <metaData key="keyname">keyvalue</metaData>
            </metaDataSet>

            <item>
                ...
            </item>
        </transferset>
     -->
    <xsd:complexType name="transferSetType">
        <xsd:sequence>
            <xsd:element name="metaDataSet"         type="metaDataSetType" maxOccurs="1" minOccurs="0"/>
            <xsd:element name="preSourceCall"       type="commandActionType" maxOccurs="1" minOccurs="0"/>
            <xsd:element name="postSourceCall"      type="commandActionType" maxOccurs="1" minOccurs="0"/>
            <xsd:element name="preDestinationCall"  type="commandActionType" maxOccurs="1" minOccurs="0"/>
            <xsd:element name="postDestinationCall" type="commandActionType" maxOccurs="1" minOccurs="0"/>
            <xsd:element name="item" type="itemType" maxOccurs="unbounded" minOccurs="0"/>
        </xsd:sequence>
        <xsd:attribute name="priority" type="priorityType" use="optional"/>
    </xsd:complexType>


    <!--
        Define a file pair with source and destination
        <item mode=[binary|text]>
            <source recursive="false" disposition="leave">
                <file>filename</file>
            </source>

            <destination type="file" exist="error">
                <file>filename</file>
            </destination>

        </item>
    -->
    <xsd:complexType name="itemType">
        <xsd:sequence>
            <xsd:element name="source"      type="fileSourceType"       maxOccurs="1" minOccurs="1"/>
            <xsd:element name="destination" type="fileDestinationType"  maxOccurs="1" minOccurs="1"/>
        </xsd:sequence>
        <xsd:attribute name="mode" type="modeType" use="required"/>
        <xsd:attribute name="checksumMethod" type="checkSumMethod" use="required"/>
    </xsd:complexType>

    <!--
        Defines the request to delete scheduled file transfer.
        <deleteScheduledTransfer>
            <originator>
                <delete>
                    <hostName>myMachine</hostName>
                    <userID>myUserId</userID>
                </delete>
            </originator>
            <ID>56</ID>
        </deleteScheduledTransfer>
     -->
    <xsd:complexType name ="deleteScheduledTransferType">
        <xsd:sequence>
            <xsd:element name="originator" type="origDeleteType" maxOccurs="1" minOccurs="1"/>
            <xsd:element name="ID"         type="idType"         maxOccurs="1" minOccurs="1"/>
            <xsd:element name="reply"      type="replyType"      maxOccurs="1" minOccurs="0"/>
        </xsd:sequence>
    </xsd:complexType>


    <xsd:complexType name="managedCallType">
        <xsd:sequence>
            <xsd:element name="originator"  type="origRequestType"  maxOccurs="1" minOccurs="1"/>
            <xsd:element name="agent"       type="agentType"        maxOccurs="1" minOccurs="1"/>
            <xsd:element name="reply"       type="replyType"        maxOccurs="1" minOccurs="0"/>
            <xsd:element name="transferSet" type="callTransferSetType"  maxOccurs="1" minOccurs="1"/>
            <xsd:element name="job"         type="jobType"          maxOccurs="1" minOccurs="0"/>
        </xsd:sequence>
    </xsd:complexType>

    <xsd:complexType name="callTransferSetType">
        <xsd:sequence>
            <xsd:element name="metaDataSet" type="metaDataSetType" maxOccurs="1" minOccurs="0"/>
            <xsd:element name="call" type="commandActionType" maxOccurs="1" minOccurs="1"/>
        </xsd:sequence>
        <xsd:attribute name="priority" type="priorityType" use="optional"/>
    </xsd:complexType>
</xsd:schema>

Entendendo a Mensagem de Pedido de Transferência

Os elementos e atributos utilizados nas mensagens de pedido de transferência são descritos na seguinte lista:

Descrições dos Elementos

<request>
Elemento do grupo contendo todos os elementos necessários para especificar um pedido de transferência de arquivos.
Atributo Descrição
versão Especifica a versão desse elemento, conforme fornecido pelo IBM® MQ Managed File Transfer
<managedTransfer>
Elemento do grupo que contém todos os elementos necessários para uma única transferência de arquivos ou um único grupo de transferências de arquivos.

<deleteScheduledTransfer>
Elemento do grupo que contém informações sobre o originador e o ID para cancelar uma transferência de planejamento.

<managedCall>
Elemento do grupo que contém todos os elementos necessários para uma única chamada gerenciada de um programa ou executável.

<ID>
Identificador exclusivo que especifica o pedido de transferência a ser excluído da lista de transferências planejadas pendentes.

<originator>
Elemento do grupo que contém os elementos que especificam o originador do pedido.

<hostName>
O nome do host do sistema em que o arquivo de origem está localizado.

<userID>
O ID do usuário que originou a transferência de arquivos.

<mqmdUserID>
Opcional. O ID do usuário do WebSphere MQ que foi fornecido no descritor de mensagens (MQMD).

<schedule>
Elemento do grupo que descreve o horário planejado para a transferência de arquivos, o comportamento de repetição e o vencimento da próxima ocorrência.

<submit>
Especifica a data e o horário em que a transferência planejada deve ser iniciada.
Atributo Descrição
timebase Especifica qual Fuso Horário deve ser utilizado. Esse atributo pode ter um dos seguintes valores:
  • source - utilize o Fuso Horário do agente de origem
  • admin - utilize o fuso horário do administrador que está emitindo o comando
  • UTC - use o Horário Universal Coordenado
fuso horário A descrição do Fuso Horário de acordo com o valor de timebase
<repeat>
Elemento do grupo que contém detalhes sobre com que frequência uma transferência planejada se repete, quantas vezes uma transferência planejada se repete e quando uma transferência planejada para a repetição.

<frequency>
O período de tempo que deve decorrer antes da transferência se repetir.
Atributo Descrição
interval As unidades de intervalo, que devem ser um dos seguintes valores:
  • minutos
  • horas
  • dias
  • weeks
  • months
  • years
<expireTime>
Elemento opcional que especifica a data e o horário da parada de uma transferência planejada. Esse elemento e o elemento <expireCount > são mutuamente exclusivos.

<expireCount>
Elemento opcional que especifica o número de vezes que a transferência de arquivos planejada ocorre antes de parar. Esse elemento e o <expireTime> são mutuamente exclusivos.

<sourceAgent>
Especifica o nome do agente no sistema em que o arquivo de origem está localizado.
Atributo Descrição
agent Especifica o nome do agente.
QMgr O nome do gerenciador de filas do agente.
<destinationAgent>
Especifica o nome do agente no sistema para o qual você deseja transferir o arquivo.
Atributo Descrição
agent Especifica o nome do agente.
QMgr O nome do gerenciador de filas do agente.
hostName O nome do host ou endereço IP do gerenciador de filas do agente.
portNumber O número da porta usado para conexões do cliente com o gerenciador de filas do agente de destino.
channel O nome do canal usado para conectar-se ao gerenciador de filas do agente de destino.
<trigger>
Elemento opcional que especifica uma condição que deve ser verdadeira para que a transferência de arquivos ocorra.
Atributo Descrição
log Um sinalizador que indica se as falhas do acionador serão registradas. Os valores válidos são os seguintes:
  • yes - as entradas de log são criadas para transferências acionadas com falha
  • no - as entradas de log não são criadas para transferências acionadas com falha
<fileExist>
Especifica uma lista separada por vírgula de nomes de arquivos localizados no mesmo sistema que o agente de origem. Se um arquivo nessa lista de nomes atender à condição do acionador, a transferência ocorrerá. Esse elemento e o elemento <fileSize > são mutuamente exclusivos.
Atributo Descrição
comparison Indica como avaliar nomes de arquivos de origem com a lista de nomes. Os valores válidos são os seguintes:
  • = pelo menos um nome de arquivo na lista de arquivos deve corresponder
  • != no mínimo um dos arquivos não existe na lista de nomes
Value Indica o tipo de comparação:
  • exist: o arquivo deve existir
<fileSize>
Especifica uma lista separada por vírgula de nomes de arquivos localizados no mesmo sistema que o agente de origem. Se um arquivo nessa lista de nomes atender à condição do acionador, a transferência ocorrerá. Esse elemento e o elemento <fileExist > são mutuamente exclusivos.
Atributo Descrição
comparison Indica como avaliar nomes de arquivos de origem com a lista de nomes. O valor válido é o seguinte:
  • >= um dos nomes de arquivos na lista de nomes já existe e tem um tamanho mínimo conforme especificado no atributo de valor
Value O tamanho do arquivo especificado como um valor de número inteiro com unidades especificadas como uma das seguintes:
  • B - bytes
  • KB - kilobytes
  • MB - megabytes
  • GB - gigabytes
(o valor das unidades não distingue entre maiúsculas e minúsculas)
<reply>
Especifica o nome da fila de respostas temporária gerada para transferências de arquivos síncronas (especificadas com o parâmetro -w na linha de comandos). O nome da fila é definido pela chave dynamicQueuePrefix no arquivo de configuração command.properties ou o padrão de WMQFTE.* Se não for especificado,
Atributo Descrição
detalhado Se as informações detalhadas do resultado da transferência forem necessárias na mensagem de resposta. Várias mensagens de resposta para cada transferência podem ser geradas. Os valores válidos são os seguintes:
  • true - as informações detalhadas de resposta são necessárias. O formato das informações é o mesmo que o publicado para o log de transferência nas mensagens em andamento, ou seja, o elemento <transferSet>. Para obter mais informações, consulte Formatos de mensagens de log de transferência de arquivos As informações detalhadas de resposta estarão presentes somente quando o agente de origem de transferência tiver a propriedade enableDetailedReplyMessages configurada como true.
  • false - as informações detalhadas de resposta não são necessárias.
O valor padrão é falso.
QMGR O nome do gerenciador de filas de comando no qual a fila dinâmica temporária é gerada para receber respostas.
persistente Se a mensagem gravada na fila de resposta for persistente. Os valores válidos são os seguintes:
  • true - a mensagem é persistente.
  • false - a mensagem não é persistente.
  • qdef - a persistência da mensagem é definida pela propriedades da fila de resposta.
O valor padrão é falso.
<transferSet>
Especifica um grupo de transferências de arquivos que você deseja executar em conjunto ou um grupo de chamadas gerenciadas que você deseja executar em conjunto. Durante a transmissão <transferSet> é um elemento de grupo que contém <item>.
Atributo Descrição
priority Nível de prioridade da transferência. A prioridade é um valor de 0-9, onde 0 é o nível mais baixo. O nível de propriedade padrão é 0 e, por padrão, a transferência usa o nível de prioridade do agente de origem.
<metaDataSet>
Elemento do grupo opcional que contém um ou mais itens de metadados.

<metaData>
Especifica os metadados definidos pelo usuário que são transmitidos para os pontos de saída chamados pelo agente. O elemento contém o valor de metadado como uma cadeia.
Atributo Descrição
Chave Nome de metadado como uma cadeia
<call>
Elemento do grupo que contém elementos <command> que especificam o programa ou o executável a ser chamado.

<command>
Especifica o programa ou executável a ser chamado. O comando deve estar localizado no caminho de comando do agente. Para obter mais informações, consulte Tabela 2. Esse elemento pode conter elementos <argument> opcionais.
Atributo Descrição
nome O nome do comando.
successRC O código de retorno bem-sucedido retornado por este comando. O padrão é 0.
retryCount O número de vezes que o comando deve ser tentado novamente, se falhar.
retryWait O tempo, em segundos, a aguardar entre novas tentativas do comando.
Tipo O tipo de programa a ser chamado. Os valores válidos são antscript, jcl ou executable.
<argument>
Especifica um argumento a ser transmitido para o comando.

<item>
Elemento de grupo que contém elementos especificando os nomes de arquivo e locais de origem e destino.
Atributo Descrição
modo Especifica o modo de transferência como binário ou texto.
checksumMethod Especifica o tipo de algoritmo hash que gera a compilação da mensagem para criar a assinatura digital. Os valores válidos são MD5 ou none.
<source>
Elemento do grupo que especifica arquivos no sistema de origem e se eles serão movidos após a conclusão da transferência
Atributo Descrição
recursivo Especifica que os arquivos são transferidos recursivamente em subdiretórios quando o elemento <source> é um diretório ou contém caracteres curinga.
disposição Especifica a ação que será executada no elemento <source> quando <source> for transferido com êxito para seu destino. Os valores válidos são os seguintes:
  • abandonar - Os arquivos de origem são deixados inalterados.
  • excluir - Os arquivos de origem são excluídos do sistema de origem depois que o arquivo de origem for transferido com êxito.
<file>
Especifica a origem de transferência Para plataformas distribuídas e IBMi, a origem de transferência pode ser um nome de arquivo ou diretório.Para a plataforma z/OS, a origem de transferência pode ser um arquivo, um diretório, um conjunto de dados ou um nome PDS. Use o caminho completo no formato consistente com o sistema operacional, por exemplo, C:/from/here.txt. Não utilize os URIs de arquivo.
Atributo Descrição
alias Especifica um alias para o arquivo de origem. Esse alias é o nome do arquivo de origem, excluindo qualquer caminho de diretório especificado para a transferência.
EOL Especifica o final do marcador de linha para transferências de texto. Os valores válidos são:
  • LF - apenas caractere de avanço de linha
  • CRLF - sequência de caracteres de retorno de linha e de avanço de linha
codificação A codificação do arquivo de origem para uma transferência de arquivos de texto.
delimiter Especifica o delimitador que é incluído entre registros em arquivos de origem orientados a registros, por exemplo z/OS® conjuntos. Especifique o valor do delimitador como dois dígitos hexadecimais no intervalo 00-FF, prefixados por x. Por exemplo, x12 ou x03,x7F.

delimiterType Especifica o tipo de delimitador que é incluído no arquivo de destino após os dados da mensagem individual. Os valores válidos são os seguintes:
  • binário - um delimitador hexadecimal

Este atributo estará disponível apenas se você tiver ativado a função da V7.0.4.1.

delimiterPosition Especifica a posição para inserir delimitadores ao gravar registros de arquivos de origem orientados a registros em um arquivo normal. Os valores válidos são os seguintes:
  • prefix - o delimitador é inserido no arquivo de destino antes dos dados de cada registro de arquivo de origem orientado a registros.
  • postfix - o delimitador é inserido no arquivo de destino após os dados de cada registro de arquivo de origem orientado a registros.

includeDelimiterInFile Especifica se será incluído um delimitador entre registros em arquivos de origem orientados a registros.

keepTrailingSpaces Especifica se os espaços à direita devem ser mantidos em registros de origem lidos a partir de um conjunto de dados de formato de comprimento fixo como parte de um modo de transferência de texto. O padrão é que os espaços à direita sejam removidos. Os valores válidos são os seguintes:
  • true - os espaços à direita são mantidos em registros de origem lidos a partir de um conjunto de dados de formato de comprimento fixo
  • false - os espaços à direita são removidos de registros de origem lidos a partir de um conjunto de dados de formato de comprimento fixo

<queue>
Quando utilizado com o elemento <source>, especifica o nome da a fila da qual transferir, que deve estar localizada no gerenciador de filas do agente de origem. Use o formato QUEUE. Não inclua o nome do gerenciador de filas, a fila deve estar presente no gerenciador de filas do agente de origem. Não será possível usar o elemento <queue> dentro do elemento <source> se você o tiver usado dentro do elemento <destination>.
Atributo Descrição
useGroups
Especifica se somente o primeiro grupo completo de mensagens será transferido da fila de origem. Os valores válidos são os seguintes:
  • true - transfere somente o primeiro grupo completo de mensagens
  • false - transfere todas as mensagens na fila de origem
groupId

Especifica o grupo de mensagens a serem lidas a partir da fila de origem. Este atributo é válido apenas quando o valor do atributo useGroups é true.

delimiterType
Especifica o tipo de delimitador que é incluído no arquivo de destino após os dados da mensagem individual. Os valores válidos são os seguintes:
  • text-um texto ou delimitador literal Java
  • binário - um delimitador hexadecimal
delimiter

Especifica o delimitador que está incluído no arquivo de destino entre dados da mensagem individual.

delimiterPosition
Especifica se o delimitador será incluído no arquivo de destino antes ou após os dados da mensagem individual. Os valores válidos são os seguintes:
  • prefix - o delimitador será incluído antes dos dados
  • postfix - o delimitador será incluído após os dados
codificação

Especifica a codificação da fila de origem.

waitTime
Especifica o tempo, em segundos, que o agente de origem aguardará para:
  • uma mensagem aparecer na fila de origem, se a fila estiver vazia ou se tornou vazia
  • um grupo completo apareça na fila de origem, se o atributo useGroups foi definido para true
Para obter informações sobre como configurar o valor waitTime , consulte Orientação para especificar um tempo de espera em uma transferência de mensagem para arquivo.
<destination>
Elemento do grupo que especifica o destino e o comportamento se existirem arquivos no agente de destino.

É possível especificar apenas um de <file> e <queue> como um elemento-filho de destino.

Atributo Descrição
Tipo
O tipo de destino. Os valores válidos são os seguintes:
  • arquivo - especifica um arquivo como o destino
  • diretório - especifica um diretório como o destino
  • dataset-especifica um conjunto de dados z/OS como o destino
  • pds-especifica um conjunto de dados particionados do z/OS como o destino
  • queue-especifica uma fila do WebSphere MQ como o destino
  • espaço no arquivo - especifica um espaço no arquivo como o destino

O valor queue é válido somente quando o elemento < destination> possui um elemento filho de < queue>.

O valor filesespace é válido apenas quando o elemento < destination> possui um elemento filho de < filespace>.

Os outros valores são válidos apenas quando o elemento < destination> possui um elemento filho de < file>

existente
Especifica a ação que será tomada se um arquivo de destino já existir no sistema de destino. Os valores válidos são os seguintes:
  • erro - reporta um erro e o arquivo não é transferido.
  • sobrescrever - sobrescreve o arquivo de destino existente.

Esse atributo não será válido se o elemento < destination> tiver um elemento filho de < queue> ou < filespace>..

<file>
Especifica as configurações adicionais para o elemento < destination> descrito anteriormente Use o caminho completo no formato consistente com o sistema operacional, por exemplo, C:/from/here.txt. Use o caminho completo no formato consistente com o sistema operacional, por exemplo, C:/from/here.txt. Não utilize os URIs de arquivo.
Atributo Descrição
alias Especifica um alias para o arquivo de destino. Esse alias é o nome do arquivo de origem, excluindo qualquer caminho de diretório especificado para a transferência.
codificação A codificação do arquivo de destino para uma transferência de arquivos de texto.
EOL Especifica o final do marcador de linha para transferências de texto. Os valores válidos são:
  • LF - apenas caractere de avanço de linha
  • CRLF - sequência de caracteres de retorno de linha e de avanço de linha

truncateRecords

Opcional. Especifica que os registros de destino maiores que o atributo do conjunto de dados LRECL serão truncados.
  • True – os registros serão truncados
  • False – os registros serão agrupados
A configuração padrão é false.
<queue>
Quando usado com o elemento <destination>, especifica o nome da fila para a qual transferir, que pode estar localizada em qualquer gerenciador de filas que esteja conectado ao gerenciador de filas do agente de destino. Use o formato QUEUE@QM em que QUEUE é o nome da fila na qual colocar as mensagens e QM é o gerenciador de filas no qual a fila está localizada. Não será possível usar o elemento <queue> dentro do elemento <destination> se você o tiver usado dentro do elemento <source>.
Atributo Descrição
delimiter O delimitador para dividir o arquivo em várias mensagens.
delimiterType Especifica o tipo de delimitador. Os valores válidos são os seguintes:
  • text-uma expressão regular Java
  • binário - uma sequência de bytes hexadecimais
  • tamanho - um número de bytes, kibibytes ou mebibytes. Por exemplo, 1 B, 1 K ou 1 M.
delimiterPosition
Especifica se a inclusão do delimitador é esperada antes ou após os dados em mensagens individuais. As opções válidas são:
  • prefix - o delimitador é esperado antes dos dados
  • postfix - o delimitador é esperado após os dados
includeDelimiterInMessage Um booleano que especifica se incluirá os delimitadores que foram usados para dividir o arquivo em várias mensagens no final das mensagens.
codificação Especifica a codificação da fila de destino.
persistente Especifica se as mensagens são persistentes. Os valores válidos são os seguintes:
  • true - as mensagens são persistentes
  • false - as mensagens não são persistentes
  • qdef - o valor de persistência das mensagens é definido pelas configurações na fila de destino
setMqProps Um booleano que especifica se as propriedades de mensagem do WebSphere MQ são configuradas na primeira mensagem em um arquivo e quaisquer mensagens gravadas na fila quando ocorre um erro
unrecognisedCodePage Especifica se uma transferência no modo de texto falhou ou se a conversão foi realizada, se a página de códigos dos dados não foi reconhecida pelo gerenciador da fila de destino. Os valores válidos são os seguintes:
  • fail - a transferência relata uma falha
  • binary-os dados são convertidos na página de códigos de destino e o cabeçalho da mensagem do WebSphere MQ que descreve o formato dos dados é configurado como MQFMT_NONE.
O comportamento padrão é fail.
<filespace>
Elemento do grupo que especifica o nome do espaço no arquivo para o qual transferir.
<name>
Quando utilizado com o elemento <filespace>, o valor desse elemento especifica o nome do espaço no arquivo.

<attributes>
Elemento de grupo opcional que contém um ou mais elementos < attribute> para especificar informações de atributo de distribuição se você estiver transferindo arquivos para um controlador de armazenamento do IBM 4690
<attribute>
Elemento opcional que especifica os atributos de distribuição de arquivo. Especifique o valor simbólico ou numérico.
Tabela 1. Valores válidos para atributos de distribuição de arquivos no IBM MQ Managed File Transfer
Valor simbólico Valor numérico Descrição
DIST(LOCAL) DIST(1) Arquivo local
DIST(MIRRORED,UPDATE) DIST(2) Arquivo espelhado, distribuir na atualização
DIST(MIRRORED, CLOSE) DIST(3) Arquivo espelhado, distribuir no encerramento
DIST(COMPOUND,UPDATE) DIST(4) Arquivo composto, distribuir na atualização
DIST(COMPOUND,CLOSE DIST(5) Arquivo composto, distribuir no encerramento
Para obter mais informações sobre atributos de distribuição para IBM MQ Managed File Transfer no IBM 4690, consulte Atributos de distribuição de arquivo.
<preSourceCall>
Elemento do grupo que especifica um comando para chamar na origem da transferência, antes do início da transferência.
<postSourceCall>
Elemento do grupo que especifica um comando para chamar na origem da transferência, após a conclusão da transferência.
<preDestinationCall>
Elemento do grupo que especifica um comando para chamar no destino da transferência, antes do início da transferência.
<postDestinationCall>
Elemento do grupo que especifica um comando para chamar no destino da transferência, após a conclusão da transferência.
<command>
Quando usado com o elemento <preSourceCall>, <postSourceCall>, <preDestinationCall> ou <postDestinationCall>, esse elemento especifica o comando a ser chamado. O comando deve estar localizado no caminho de comando do agente. Para obter mais informações, consulte Tabela 2.
Atributo Descrição
nome O nome do comando a executar.
successRC O código de retorno é esperado se o comando executar com êxito.
<argument>
Quando usado com o elemento <command>, esse elemento especifica um argumento a ser transmitido para o comando. É possível ter qualquer número de elementos <argument> dentro de um elemento <command>.
<job>
Elemento de grupo opcional que contém informações da tarefa para a especificação de transferência inteira < job> é um identificador de nome da tarefa definido pelo usuário que é incluído na mensagem de log quando a transferência foi iniciada.. Esse elemento < job> é o mesmo que o elemento < job> que aparece na mensagem de log de transferência, que é descrito no tópico a seguir: Formatos de mensagem de log de transferência de arquivos...
<name>
Quando utilizado com o elemento <job>, o valor desse elemento especifica o nome da tarefa.

<transferSpecifications>
Elemento de grupo que contém elementos <item> para múltiplos grupos de transferência. Consulte Usando Arquivos de Definição de Transferência para obter detalhes adicionais sobre como usar esse elemento

<cancel>
Elemento do grupo que contém todos os elementos necessários para cancelar uma transferência de arquivos em progresso.
Atributo Descrição
versão Especifica a versão desse elemento, conforme fornecido pelo IBM MQ Managed File Transfer
<transfer>
Quando utilizado com o elemento <cancel>, o valor desse elemento especifica o ID da solicitação de transferência a ser cancelado.

<job>
Elemento de grupo contendo informações da tarefa.

<jobName>
Especifica o identificador lógico da tarefa.

Formato da mensagem de cancelamento da transferência de arquivos

Um pedido de transferência de arquivos retorna um ID de 48 caracteres que identifica a transferência para um agente específico. Esse ID é utilizado para cancelar transferências.

Entendendo a mensagem de cancelamento de transferência

Os elementos e atributos utilizados nas mensagens de cancelamento de transferência são descritos:
<cancel>
Elemento do grupo que contém todos os elementos necessários para cancelar uma transferência de arquivos em progresso.
Atributo Descrição
versão Especifica a versão desse elemento, conforme fornecido pelo IBM MQ Managed File Transfer
<originator>
Elemento do grupo que contém os elementos que especificam o originador do pedido.

<hostName>
O nome do host do sistema em que o arquivo de origem está localizado.

<userID>
O ID do usuário que originou a transferência de arquivos.

<mqmdUserID>
Opcional. O ID do usuário do WebSphere MQ que foi fornecido no descritor de mensagens (MQMD).

<transfer>
Quando utilizado com o elemento <cancel>, o valor desse elemento especifica o ID da solicitação de transferência a ser cancelado.

<job>
Opcional. Elemento de grupo contendo informações da tarefa.

<jobName>
Especifica o identificador lógico da tarefa.