foreach

Mit foreach führen Sie eine Sequenz für jedes Element einer Liste aus (siehe Abschnitt „list"). Für jedes Element der selektierten Liste werden die Kind-Elemente von foreach als Sequenz ausgeführt.

Sie können festlegen, ob die Sequenzen nacheinander (in der Reihenfolge der Listenelemente) oder parallel ausgeführt werden.

Format

 <foreach listRef="ID" contextObject="ID" execute?=
 "parallel|sequential"
          selectType="file|partner|directory" direction?=
 "forward|reverse" >
   comment?
   context?
   Aktivität+
 </foreach

Attribute

Name	Wert	Bedeutung
listRef	string	Name eines gültigen Kontextobjekts vom Typ list.
contextObject	string	Name des foreach Kontextobjekts, das den Wert des aktuellen Listenelements annimmt. Dies darf im foreach Kontext nicht definiert sein. Es wird implizit definiert. Der Typ des Kontextobjekts entspricht dem im Attribut selectType eingestellten Typ.
execute?	parallel | sequential	Der Standardwert ist sequential. Die Sequenzen werden nacheinander ausgeführt. Bei Angabe von parallel werden die Sequenzen parallel gestartet.
selectType	partner | file | directory	Filtert die Elemente des angegebenen Typs aus der Liste. Es wird nur über die gefilterten Elemente iteriert.
direction?	forward | reverse	Der Standardwert ist forward. Die Liste wird vorwärts abgearbeitet. Bei Angabe von reverse wird die Liste rückwärts abgearbeitet.

 

Beispiele

1. Dateien verteilen

 <?xml version="1.0" encoding="UTF-8"?>
 <ftscript version="1">
   <context>
     <list id="FileList">
       <file name="bin.mp3"/>
       <file name="text.txt"/>
     </list>
     <list id="HostList">
       <partner name="UnixP_1" systemType="unix">
         <transferAdmission>
           <ftacAdmission ftacAdmission="FTACADM1"/>
         </transferAdmission>
       </partner>
       <partner name="WindowsP_1" systemType="windows">
         <transferAdmission>
           <ftacAdmission ftacAdmission="FTACADM2"/>
         </transferAdmission>
       </partner>
     </list>
   </context>
   <foreach listRef="HostList" selectType="partner"
            contextObject="partner" execute="parallel">
     <foreach listRef="FileList" selectType="file"
              contextObject="file" execute="parallel">
       <transferFile>
         <fromLocalFile ref="file">
           <directory name="W:/openFT/ftscript/Test/data/large"/>
           <autoDataSpec binPattern="*.mp3" charPattern="*.txt"/>
         </fromLocalFile>
         <toRemoteFile ref="file">
           <partner ref="partner"/>
           <directory name="frg_eis_09"/>
         </toRemoteFile>
       </transferFile>
     </foreach>
   </foreach>
 </ftscript>

Es werden die Dateien bin.mp3 und text.txt auf zwei Rechner kopiert.

Die Datei- und Rechnerlisten werden im Beispiel als Kontextobjekte definiert.
Die Dateiliste kann auch z.B. durch ein listDirectory definiert werden (siehe Abschnitt „listDirectory").

Es wird eine doppelte foreach Sequenz verwendet. Die äußere Sequenz durchläuft alle Rechner, die innere Sequenz durchläuft alle Dateien. Die Verbindung zu den Rechnern findet parallel statt, die Dateien werden ebenfalls parallel zu jedem Rechner übertragen.

autoDataSpec unterscheidet zwischen Text- und Binärdateien (siehe Abschnitt „autoDataSpec").

Wenn das Script ausgeführt ist, sind die Dateien auf alle Rechner verteilt.
Da im Beispiel kein faulthandler verwendet wurde, bricht das Script bei einem Fehler ab.

2. Dateibaum kopieren

 <?xml version="1.0" encoding="UTF-8"?>
 <ftscript version="1">
   <context>
     <partner id="remote" name="UnixP_1">
       <transferAdmission>
         <ftacAdmission ftacAdmission="FTACADM1"/>
       </transferAdmission>
     </partner>
   </context>
   <listDirectory name="*//*" listObject="Flist">
     <partner ref="remote"/>
     <baseDir name="frg_eis_11"/>
   </listDirectory>
   <foreach listRef="Flist" selectType="directory"
            contextObject="creDir" execute="sequential">
     <createDirectory ref="creDir">
       <baseDir name="frg_eis_11"/>
     </createDirectory>
   </foreach>
   <foreach listRef="Flist" selectType="file"
            contextObject="file" execute="parallel">
     <transferFile>
       <fromRemoteFile ref="file">
         <partner ref="remote"/>
         <directory name="frg_eis_11"/>
       </fromRemoteFile>
       <toLocalFile ref="file">
         <directory name="frg_eis_11"/>
       </toLocalFile>
     </transferFile>
   </foreach>
 </ftscript>

Im Verzeichnis frg_eis_11 des Rechners UnixP_1 wird der Dateibaum *//* in das Verzeichnis frg_eis_11 der lokalen Kennung kopiert.

In der ersten foreach Sequenz werden alle (notwendigen) Verzeichnisse sequentiell mit createDirectory angelegt.
listDirectory liefert für das Verzeichnis frg_eis_11/a/b/c der Reihe nach die Verzeichnisse a, a/b und a/b/c (frg_eis_11 selbst ist mit baseDir als Basisverzeichnis definiert). Ein Verzeichnis kann erst angelegt werden, wenn das Eltern-Verzeichnis existiert.

In der zweiten foreach Sequenz werden die Dateien parallel kopiert, da nun alle Zielverzeichnisse vorhanden sind.

3. Dateibaum löschen

 <?xml version="1.0" encoding="UTF-8"?>
 <ftscript version="1">
   <context>
     <partner id="remote" name="UnixP_1">
       <transferAdmission>
         <ftacAdmission ftacAdmission="FTACADM1"/>
       </transferAdmission>
     </partner>
   </context>
   <listDirectory name="frg_eis_10/*//*" listObject="Flist">
     <partner ref="remote"/>
   </listDirectory>
   <foreach listRef="Flist" selectType="file"
            contextObject="delFile" execute="parallel">
     <deleteFile ref="delFile">
       <partner ref="remote"/>
     </deleteFile>
   </foreach>
   <foreach listRef="Flist" selectType="directory"
            contextObject="delDir" execute="sequential"
                           direction="reverse">
     <deleteDirectory ref="delDir">
       <partner ref="remote"/>
     </deleteDirectory>
   </foreach>
 </ftscript>

Im Beispiel wird unter der FTAC-Zugangsberechtigung FTACADM1 auf dem Rechner UnixP_1 alles im Verzeichnis frg_eis_10 gelöscht.
Mit listDirectory (siehe Abschnitt „listDirectory") werden durch das Suchmuster *//* alle Dateien und Verzeichnisse rekursiv ermittelt. Die Reihenfolge in der die Verzeichnisse aufgelistet werden, entspricht der zu deren Erzeugung notwendigen Reihenfolge (d.h. die umgekehrte Reihenfolge ist zum Löschen notwendig).
In der ersten foreach Sequenz werden alle Dateien parallel gelöscht. Nicht existierende Dateien werden ignoriert. Fehler beim Löschen einer Datei führen zum Abbruch des Scripts.
In der zweiten foreach Sequenz werden die leeren Verzeichnisse rückwärts gelöscht, weil die Verzeichnisse zum Löschen mit deleteDirectory leer sein müssen (siehe Abschnitt „deleteDirectory"). Nicht existierende Verzeichnisse werden ignoriert. Andere Fehler führen zum Abbruch des Scripts.
Wenn das Script ausgeführt ist, ist das Verzeichnis frg_eis_10 auf dem Rechner UnixP_1 leer.