Formato del messaggio di richiesta di trasferimento file

I trasferimenti file vengono avviati dai messaggi XML che arrivano a una coda di comandi dell'agent, di solito come risultato di un utente che immette un comando di trasferimento file o utilizzando il plugin WebSphere® MQ Explorer. L'XML della richiesta di trasferimento deve essere conforme allo schema FileTransfer.xsd e avere l'elemento < request> come elemento root. Il documento dello schema FileTransfer.xsd si trova nella directory MQ_INSTALLATION_PATH/mqft/samples/schema . Lo schema FileTransfer.xsd importa fteutils.xsd, che si trova nella stessa directory.

I messaggi di trasferimento file possono avere uno dei seguenti tre elementi root:

< request> - per le nuove richieste di trasferimento file, le richieste di chiamata gestite o l'eliminazione di trasferimenti pianificati in sospeso
< cancel> - per l'annullamento dei trasferimenti file in corso
<transferSpecifications> - per specificare più gruppi di file di trasferimento, utilizzato dal comando fteCreateTransfer

Per informazioni su come specificare più gruppi di trasferimento usando l'elemento <transferSpecifications>, vedere Uso dei file di definizione dei trasferimenti.

Schema

Il seguente schema descrive gli elementi validi in un messaggio XML di richiesta di trasferimento.

<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>

Comprensione del messaggio di richiesta trasferimento

Gli elementi e gli attributi utilizzati nei messaggi di richiesta di trasferimento sono descritti nel seguente elenco:

Descrizioni degli elementi

<request>

Elemento gruppo contenente tutti gli elementi richiesti per specificare una richiesta di trasferimento file.

Attributo	Descrizione
versione	Specifica la versione di questo elemento come fornita da IBM® MQ Managed File Transfer.

<managedTransfer>

Elemento del gruppo che contiene tutti gli elementi richiesti per un singolo trasferimento file o un singolo gruppo di trasferimenti file.

<deleteScheduledTransfer>

Elemento del gruppo che contiene le informazioni sul mittente e sull'ID per annullare un trasferimento di pianificazione.

<managedCall>

Elemento di gruppo che contiene tutti gli elementi richiesti per una singola chiamata gestita di un programma o di un eseguibile.

<ID>

Identificativo univoco che specifica la richiesta di trasferimento da eliminare dall'elenco di trasferimenti pianificati in sospeso.

<originator>

Elemento del gruppo che contiene gli elementi che specificano il creatore della richiesta.

<hostName>

Il nome host del sistema in cui si trova il file di origine.

<userID>

L'ID utente che ha originato il trasferimento file.

<mqmdUserID>

Facoltativo. L'ID dell'utente WebSphere MQ fornito nel descrittore del messaggio (MQMD).

<schedule>

Elemento di gruppo che descrive l'ora pianificata per il trasferimento file, il comportamento di ripetizione e la scadenza della ricorrenza successiva.

<submit>

Specifica la data e l'orario di inizio del trasferimento pianificato.

Attributo	Descrizione
base temporale	Specifica quale fuso orario utilizzare. Questo attributo può avere uno dei seguenti valori: source - utilizza il fuso orario dell'agente di origine admin - utilizza il fuso orario dell'amministratore immettendo il comando UTC - utilizzare UTC (Coordinated Universal Time)
timezone	La descrizione del fuso orario in base al valore di base temporale

<repeat>

Elemento gruppo che contiene dettagli sulla frequenza con cui si ripete un trasferimento pianificato, quante volte si ripete un trasferimento pianificato e quando un trasferimento pianificato smette di ripetersi.

<frequency>

Il periodo di tempo che deve trascorrere prima che il trasferimento si ripeta.

Attributo	Descrizione
intervallo	Le unità di intervallo, che devono essere uno dei seguenti valori: minuti ore giorni settimane mesi anni

<expireTime>

Elemento facoltativo che specifica la data e l'ora di arresto di un trasferimento pianificato ripetuto. Questo elemento e l'elemento <expireCount> si escludono a vicenda.

<expireCount>

Elemento facoltativo che specifica il numero di volte in cui il trasferimento file pianificato si verifica prima dell'arresto. Questo elemento e l'elemento <expireTime> si escludono a vicenda.

<sourceAgent>

Specifica il nome dell'agent sul sistema in cui si trova il file di origine.

Attributo	Descrizione
agente	Specifica il nome dell'agent.
destinazione	Il nome del gestore code agent.

<destinationAgent>

Specifica il nome dell'agent sul sistema a cui si desidera trasferire il file.

Attributo	Descrizione
agente	Specifica il nome dell'agent.
destinazione	Il nome del gestore code agent.
hostName	Il nome host o l'indirizzo IP del gestore code dell'agent.
portNumber	Il numero di porta utilizzato per le connessioni client al gestore code dell'agente di destinazione.
canale	Il nome canale utilizzato per connettersi al gestore code dell'agent di destinazione.

<trigger>

Elemento facoltativo che specifica una condizione che deve essere true perché il trasferimento file abbia luogo.

Attributo	Descrizione
log	Un indicatore che indica se sono registrati errori di trigger. I valori validi sono i seguenti: yes - le voci di log vengono create per i trasferimenti attivati non riusciti no - le voci di log non vengono create per i trasferimenti attivati non riusciti

<fileExist>

Specifica un elenco separato da virgole di nomi file ubicati sullo stesso sistema dell'agente di origine. Se un file in questo elenco di nomi soddisfa la condizione del trigger, si verifica il trasferimento. Questo elemento e l'elemento <fileSize> si escludono a vicenda.

Attributo	Descrizione
confronto	Indica come valutare i nomi file di origine rispetto all'elenco dei nomi. I valori validi sono i seguenti: = almeno un nome file nell'elenco dei nomi deve corrispondere ! = almeno uno dei file nell'elenco dei nomi non esiste
valore	Indica il tipo di confronto: esiste: il file deve esistere

<fileSize>

Attributo	Descrizione
confronto	Indica come valutare i nomi file di origine rispetto all'elenco dei nomi. Il valore valido è il seguente: > = uno dei nomi file nell'elenco dei nomi esiste e ha una dimensione minima come specificato nell'attributo del valore
valore	Dimensione file specificata come valore intero con unità specificate come una delle seguenti: B - byte KB - kilobyte MB - megabyte GB - gigabyte (il valore delle unità non è sensibile al maiuscolo / minuscolo)

<reply>

Specifica il nome della coda di risposta temporanea generata per trasferimenti di file sincroni (specificato con il parametro -w sulla riga comandi). Il nome della coda è definito dalla chiave dynamicQueuePrefix nel file di configurazione command.properties o dal valore predefinito di WMQFTE.* se non specificato.

Attributo	Descrizione
dettagliato	Indica se le informazioni dettagliate sul risultato del trasferimento sono richieste nel messaggio di risposta. È possibile generare più messaggi di risposta per ogni trasferimento. I valori validi sono i seguenti: true - sono richieste informazioni di risposta dettagliate. Il formato delle informazioni è lo stesso di quello pubblicato nel registro dei trasferimenti nei messaggi di avanzamento, ovvero l'elemento <transferSet>. Per ulteriori informazioni, consultare Formati dei messaggi del log di trasferimento file. Le informazioni dettagliate sulle risposte sono presenti solo quando l'agente di origine del trasferimento ha la proprietà enableDetailedReplyMessages impostata su true. false - non sono richieste informazioni di risposta dettagliate. Il valore predefinito è false.
QMGR	Il nome del gestore code comandi su cui viene generata la coda dinamica temporanea per ricevere le risposte.
permanente	Se il messaggio scritto nella coda di risposta è persistente. I valori validi sono i seguenti: true - il messaggio è persistente false - il messaggio non è persistente qdef - la persistenza del messaggio è definita dalle proprietà della coda di risposte Il valore predefinito è false.

<transferSet>

Specifica un gruppo di trasferimenti di file che si desidera eseguire insieme o un gruppo di chiamate gestite che si desidera eseguire insieme. Durante la trasmissione <transferSet> è un elemento di gruppo contenente elementi <item>.

Attributo	Descrizione
priorità	Livello di priorità del trasferimento. La priorità è un valore compreso tra 0 e 9, dove 0 è la priorità più bassa. Il livello di priorità predefinito è 0 e, per impostazione predefinita, il trasferimento utilizza il livello di priorità dell'agent di origine.

<metaDataSet>

Elemento gruppo facoltativo contenente uno o più elementi metadati.

<metaData>

Specifica i metadati definiti dall'utente passati ai punti di uscita richiamati dall'agente. L'elemento contiene il valore di metadati come stringa.

Attributo	Descrizione
chiave	Nome metadati come stringa

<call>

Elemento gruppo che contiene elementi < command> che specificano il programma o l'eseguibile da chiamare.

<command>

Specifica il programma o l'eseguibile da chiamare. Il comando deve essere ubicato sul percorso del comando dell'agent. Per ulteriori informazioni, consultare la Tabella 2. Questo elemento può contenere elementi facoltativi < argomento>.

Attributo	Descrizione
nome	Il nome del comando.
successRC	Il codice di ritorno corretto restituito da questo comando. Il valore predefinito è 0.
retryCount	Il numero di volte in cui il comando deve essere ritentato se non riesce.
retryWait	Il tempo, in secondi, di attesa tra i tentativi del comando.
tipo	Il tipo di programma da chiamare. I valori validi sono antscript, jcl o eseguibile.

<argument>

Specifica un argomento da passare al comando.

<item>

Elemento del gruppo che contiene elementi che specificano i nomi e le ubicazioni dei file di origine e di destinazione.

Attributo	Descrizione
modo	Specifica la modalità di trasferimento come binaria o di testo.
checksumMethod	Specifica il tipo di algoritmo hash che genera il digest del messaggio per creare la firma digitale. I valori validi sono MD5 o nessuno.

<source>

Elemento del gruppo che specifica i file sul sistema di origine e se vengono rimossi dopo il completamento del trasferimento

Attributo	Descrizione
ricorrente	Specifica che i file vengono trasferiti in modo ricorsivo nelle sottodirectory quando l'elemento < source> è una directory o contiene caratteri jolly.
della modernizzazione	Specifica l'azione eseguita sull'elemento < source> quando < source> è stato trasferito correttamente alla relativa destinazione. I valori validi sono i seguenti: lasciare invariati i file di origine. delete - i file di origine vengono eliminati dal sistema di origine dopo che il file di origine è stato trasferito correttamente.

<file>

Specifica l'origine del trasferimento. Per le piattaforme distribuite e IBMi, l'origine del trasferimento può essere un nome file o directory. Per la piattaforme z/OS , l'origine del trasferimento può essere un file, una directory, un dataset o un nome PDS. Utilizzare il percorso completo nel formato coerente con il proprio sistema operativo, ad esempio C:/from/here.txt. Non utilizzare URI file.

Attributo	Descrizione
alias	Specifica un alias per il file di origine. Questo alias è il nome del file di origine, escluso qualsiasi percorso di directory specificato per il trasferimento.
EOL	Specifica l'indicatore di fine riga per i trasferimenti di testo. I valori validi sono: LF - solo carattere di avanzamento riga CRLF - sequenza di caratteri di ritorno a capo e avanzamento riga
codifica	La codifica del file di origine per il trasferimento di un file di testo.
delimitatore	Specifica il delimitatore incluso tra i record nei file di origine orientati ai record, ad esempio i dataset z/OS® . Specificare il valore del delimitatore come due cifre esadecimali nell'intervallo 00-FF, con prefisso x. Ad esempio, x12 o x03,x7F.
delimiterType	Specifica il tipo di delimitatore incluso nel file di destinazione dopo i singoli dati del messaggio. I valori validi sono i seguenti: binario - un delimitatore esadecimale Questo attributo è disponibile solo se è stata abilitata la funzione V7.0.4.1 .
delimiterPosition	Specifica la posizione in cui inserire i delimitatori quando si scrivono i record del file origine orientati ai record in un file normale. I valori validi sono i seguenti: prefisso - il delimitatore viene inserito nel file di destinazione prima dei dati da ogni record del file orientato ai record di origine. postfix - il delimitatore viene inserito nel file di destinazione dopo i dati da ogni record del file orientato ai record di origine.
includeDelimiterInFile	Specifica se includere un delimitatore tra i record nei file di origine orientati ai record.
keepTrailingSpaces	Specifica se gli spazi finali devono essere conservati sui record di origine letti da un dataset a lunghezza fissa come parte di un trasferimento in modalità testo. Per impostazione predefinita, gli spazi finali vengono eliminati. I valori validi sono i seguenti: true - gli spazi finali vengono conservati sui record di origine letti da un dataset in formato a lunghezza fissa False - gli spazi finali vengono rimossi dai record di origine letti da un dataset in formato a lunghezza fissa

<queue>

Quando viene utilizzato con l'elemento < source>, specifica il nome della coda da cui eseguire il trasferimento, che deve trovarsi sul gestore code dell'agent di origine. Utilizzare il formato QUEUE. Non includere il nome del gestore code, la coda deve trovarsi sul gestore code dell'agente di origine. Non è possibile utilizzare l'elemento < queue> all'interno dell'elemento < source>, se è stato utilizzato all'interno dell'elemento < destination>.

Attributo	Descrizione
useGroups	Specifica se trasferire solo il primo gruppo completo di messaggi dalla coda di origine. I valori validi sono i seguenti: true - trasferisci solo il primo gruppo completo di messaggi false - trasferire tutti i messaggi sulla coda di origine
groupId	Specifica il gruppo di messaggi da leggere dalla coda di origine. Questo attributo è valido solo quando il valore dell'attributo useGroups è true.
delimiterType	Specifica il tipo di delimitatore incluso nel file di destinazione dopo i singoli dati del messaggio. I valori validi sono i seguenti: text - un delimitatore di testo o letterale Java binario - un delimitatore esadecimale
delimitatore	Specifica il delimitatore incluso nel file di destinazione tra i singoli dati del messaggio.
delimiterPosition	Specifica se il delimitatore è incluso nel file di destinazione prima o dopo i singoli dati del messaggio. I valori validi sono i seguenti: prefisso - il delimitatore viene incluso prima dei dati postfix - il delimitatore viene incluso dopo i dati
codifica	Specifica la codifica della coda di origine.
waitTime	Specifica il tempo, in secondi, di attesa dell'agente di origine per: un messaggio da visualizzare nella coda di origine, se la coda è vuota o è diventata vuota un gruppo completo da visualizzare nella coda di origine, se l'attributo useGroups è stato impostato su true Per informazioni sull'impostazione del valore waitTime , consultare Guida per la specifica di un tempo di attesa su un trasferimento da messaggio a file.

<destination>

Elemento gruppo che specifica la destinazione e il comportamento se i file esistono sull'agente di destinazione.

È possibile specificare solo uno tra < file> e < queue> come elemento child della destinazione.

Attributo	Descrizione
tipo	Il tipo di destinazione. I valori validi sono i seguenti: file - specifica un file come destinazione directory - specifica una directory come destinazione dataset - specifica un dataset z/OS come destinazione pds - specifica un dataset partizionato z/OS come destinazione queue - specifica una coda di WebSphere MQ come destinazione spazio file - specifica uno spazio file come destinazione Il valore queue è valido solo quando l'elemento < destination> ha un elemento child < queue>. Il valore filespace è valido solo quando l'elemento < destination> ha come elemento secondario < filespace>. Gli altri valori sono validi solo quando l'elemento < destination> ha un elemento child < file>.
esistono	Specifica l'azione che viene eseguita se un file di destinazione esiste sul sistema di destinazione. I valori validi sono i seguenti: error - riporta un errore e il file non viene trasferito. overwrite - sovrascrive il file di destinazione esistente. Questo attributo non è valido se l'elemento < destination> ha un elemento child di < queue> o < filespace>.

Attributo

Descrizione

tipo

Il tipo di destinazione. I valori validi sono i seguenti:

file - specifica un file come destinazione
directory - specifica una directory come destinazione
dataset - specifica un dataset z/OS come destinazione
pds - specifica un dataset partizionato z/OS come destinazione
queue - specifica una coda di WebSphere MQ come destinazione
spazio file - specifica uno spazio file come destinazione

Il valore queue è valido solo quando l'elemento < destination> ha un elemento child < queue>.

Il valore filespace è valido solo quando l'elemento < destination> ha come elemento secondario < filespace>.

Gli altri valori sono validi solo quando l'elemento < destination> ha un elemento child < file>.

esistono

Specifica l'azione che viene eseguita se un file di destinazione esiste sul sistema di destinazione. I valori validi sono i seguenti:

error - riporta un errore e il file non viene trasferito.
overwrite - sovrascrive il file di destinazione esistente.

Questo attributo non è valido se l'elemento < destination> ha un elemento child di < queue> o < filespace>.

<file>

Specifica ulteriori impostazioni per l'elemento < destinazione> precedentemente descritto. Utilizzare il percorso completo nel formato coerente con il proprio sistema operativo, ad esempio C:/from/here.txt. Utilizzare il percorso completo nel formato coerente con il proprio sistema operativo, ad esempio C:/from/here.txt. Non utilizzare URI file.

Attributo	Descrizione
alias	Specifica un alias per il file di destinazione. Questo alias è il nome del file di origine, escluso qualsiasi percorso di directory specificato per il trasferimento.
codifica	La codifica del file di destinazione per un trasferimento file di testo.
EOL	Specifica l'indicatore di fine riga per i trasferimenti di testo. I valori validi sono: LF - solo carattere di avanzamento riga CRLF - sequenza di caratteri di ritorno a capo e avanzamento riga
truncateRecords	Facoltativo. Specifica che i record di destinazione più lunghi dell'attributo dataset LRECL vengono troncati. True - i record vengono troncati False - i record vengono riportati a capo L'impostazione predefinita è false.

<queue>

Quando viene utilizzato con l'elemento < destination>, specifica il nome della coda a cui trasferire, che può essere ubicato su qualsiasi gestore code connesso al gestore code dell'agent di destinazione. Utilizzare il formato QUEUE@QM dove QUEUE è il nome della coda in cui inserire i messaggi e QM è il gestore code in cui si trova la coda. Non è possibile utilizzare l'elemento < queue> all'interno dell'elemento < destination>, se è stato utilizzato all'interno dell'elemento < source>.

Attributo	Descrizione
delimitatore	Il delimitatore per dividere il file in più messaggi.
delimiterType	Specifica il tipo di delimitatore. I valori validi sono i seguenti: text - un'espressione regolare Java binario - una sequenza di byte esadecimali dimensione - un numero di byte, kibibyte o mebibyte. Ad esempio, 1 B, 1 K o 1 M.
delimiterPosition	Specifica se il delimitatore è previsto prima o dopo i dati da includere nei singoli messaggi. Le opzioni valide sono le seguenti: prefisso - il delimitatore è previsto prima dei dati postfix - il delimitatore è previsto dopo i dati
includeDelimiterInMessage	Un valore booleano che specifica se includere i delimitatori utilizzati per suddividere il file in più messaggi alla fine dei messaggi.
codifica	Specifica la codifica della coda di destinazione.
permanente	Specifica se i messaggi sono persistenti. I valori validi sono i seguenti: true - i messaggi sono persistenti false - i messaggi non sono persistenti qdef - il valore di persistenza dei messaggi è definito dalle impostazioni sulla coda di destinazione
setMqProps	Un valore booleano che specifica se le proprietà del messaggio di WebSphere MQ sono impostate sul primo messaggio in un file e qualsiasi messaggio scritto nella coda quando si verifica un errore.
unrecognisedCodePage	Specifica se un trasferimento in modalità testo non riesce o se viene eseguita la conversione, se la codepage dei dati non è riconosciuta dal gestore code di destinazione. I valori validi sono i seguenti: errore - il trasferimento riporta un malfunzionamento binary - i dati vengono convertiti nella codepage di destinazione e l'intestazione del messaggio WebSphere MQ che descrive il formato dei dati è impostato su MQFMT_NONE. Il comportamento predefinito è fail.

<filespace>

Elemento del gruppo che specifica il nome dello spazio file a cui trasferire.

<name>

Quando utilizzato con l'elemento < filespace>, il valore di questo elemento specifica il nome dello spazio file.

<attributes>

Elemento di gruppo facoltativo che contiene uno o più elementi < attributo> per specificare le informazioni sull'attributo di distribuzione se si stanno trasferendo i file in un controller di archivio IBM 4690 .

<attribute>

Elemento facoltativo che specifica gli attributi di distribuzione file. Specificare il valore simbolico o numerico.

Tabella 1. Valori validi per gli attributi di distribuzione file in IBM MQ Managed File Transfer
Valore simbolico	Valore numerico	Descrizione
DIST (LOCALE)	DIST (1)	File locale
DIST (MIRRORING, UPDATE)	DIST (2)	File con mirroring, distribuisci all'aggiornamento
DIST (MIRRORING, CHIUSURA)	DIST (3)	File con mirroring, distribuisci alla chiusura
DIST (COMPOSTO, UPDATE)	DIST (4)	File composto, distribuisci all'aggiornamento
DIST (COMPOSTO, CHIUSO	DIST (5)	File composto, distribuisci alla chiusura

Per ulteriori informazioni sugli attributi di distribuzione per IBM MQ Managed File Transfer su IBM 4690, consultare Attributi di distribuzione file.

<preSourceCall>

Elemento gruppo che specifica un comando da richiamare all'origine del trasferimento, prima dell'avvio del trasferimento.

<postSourceCall>

Elemento gruppo che specifica un comando da richiamare all'origine del trasferimento, una volta completato il trasferimento.

<preDestinationCall>

Elemento del gruppo che specifica un comando da chiamare nella destinazione del trasferimento, prima dell'avvio del trasferimento.

<postDestinationCall>

Elemento gruppo che specifica un comando da richiamare alla destinazione del trasferimento, una volta completato il trasferimento.

<command>

Se usato con gli elementi <preSourceCall>, <postSourceCall>, <preDestinationCall>, o <postDestinationCall>, questo elemento specifica il comando da richiamare. Il comando deve essere ubicato sul percorso del comando dell'agent. Per ulteriori informazioni, consultare la Tabella 2.

Attributo	Descrizione
nome	Il nome del comando da eseguire.
successRC	Il codice di ritorno previsto se il comando viene eseguito correttamente.

<argument>

Quando viene utilizzato con l'elemento < command>, questo elemento specifica un argomento da passare nel comando. È possibile avere un numero qualsiasi di elementi < argomento> all'interno di un elemento < comando>.

<job>

Elemento gruppo facoltativo contenente informazioni sul lavoro per l'intera specifica di trasferimento. < job> è un identificativo del nome lavoro definito dall'utente che viene aggiunto al messaggio di log quando il trasferimento è avviato. Questo < job> elemento è uguale all'elemento < job> visualizzato nel messaggio del log di trasferimento, descritto nel seguente argomento: Formati del messaggio del log di trasferimento file.

<name>

Se utilizzato con l'elemento < job>, il valore di questo elemento specifica il nome del lavoro.

<transferSpecifications>

Elemento gruppo che contiene < item> elementi per più gruppi di trasferimenti. Consultare Utilizzo dei file di definizione trasferimento per ulteriori dettagli su come utilizzare questo elemento.

<cancel>

Elemento del gruppo contenente tutti gli elementi richiesti per annullare un trasferimento file in corso.

Attributo	Descrizione
versione	Specifica la versione di questo elemento fornita da IBM MQ Managed File Transfer.

<transfer>

Quando viene utilizzato con l'elemento < cancel>, il valore di questo elemento specifica l'ID richiesta di trasferimento da annullare.

<job>

Elemento gruppo contenente le informazioni sul lavoro.

<jobName>

Specifica l'identificativo del lavoro logico.

Formato messaggio di annullamento trasferimento file

Una richiesta di trasferimento file restituisce un ID di 48 caratteri che identifica il trasferimento per uno specifico agente. Questo ID viene utilizzato per annullare trasferimenti.

Comprensione del messaggio di annullamento del trasferimento

Gli elementi e gli attributi utilizzati nei messaggi di annullamento trasferimento sono descritti di seguito:

<cancel>

Elemento del gruppo contenente tutti gli elementi richiesti per annullare un trasferimento file in corso.

Attributo	Descrizione
versione	Specifica la versione di questo elemento fornita da IBM MQ Managed File Transfer.

<originator>

Elemento del gruppo che contiene gli elementi che specificano il creatore della richiesta.

<hostName>

Il nome host del sistema in cui si trova il file di origine.

<userID>

L'ID utente che ha originato il trasferimento file.

<mqmdUserID>

Facoltativo. L'ID dell'utente WebSphere MQ fornito nel descrittore del messaggio (MQMD).

<transfer>

Quando viene utilizzato con l'elemento < cancel>, il valore di questo elemento specifica l'ID richiesta di trasferimento da annullare.

<job>

Facoltativo. Elemento gruppo contenente le informazioni sul lavoro.

<jobName>

Specifica l'identificativo del lavoro logico.

Esempi

Esempi di messaggi XML conformi a questo schema vengono forniti per ciascuna delle richieste seguenti: