Verfügbar für: Content Management Server
Aufgabe: Exportiert die Dateihierarchie ab dem angegebenen Ordner.
Syntax:
obj (withId objId) | (withPath path) | root exportSubtree {parameter value}
Funktionsparameter:
parameter spezifiziert den Namen eines
Parameters, mit dessen Wert das Exportergebnis modifiziert werden
kann. Folgende Werte sind für parameter
zulässig:
absoluteFsPathPrefix: gibt an, dass als
Dateipfade exportierte Links als absolute Pfade exportiert werden
sollen und value als deren Präfix verwendet werden soll.
Dieser Parameter hebt im Rahmen dieses Befehls die Werte der
entsprechenden Parameter im Systemkonfigurationseintrag
export auf. Ist dieser nicht angegeben, wird
/ verwendet.
absoluteUrlPrefix: wie
absoluteFsPathPrefix, jedoch für die Pfade in
URLs.
exportCharset: gibt an, dass
value den beim Export für generierte
Dokumente zu verwenden Zeichensatz benennt. Die unterstützten
Werte sind im Systemkonfigurationseintrag
export.charsetMap aufgeführt. Ist dieser Parameter
nicht angegeben, wird der Wert des Systemkonfigurationseintrags
export.charset verwendet. Ist dieser nicht vorhanden,
wird utf-8 verwendet.
filePrefix: gibt an, dass
value einen Prefix enthält, der den
Exportdateinamen voranzustellen ist.
maxDepth: gibt an, dass
value eine ganze Zahl enthält die Anzahl der
zu exportierenden Ordnerebenen spezifiziert. Ist dieser Wert nicht
angegeben, ist die Anzahl nicht begrenzt.
purgeCollections: gibt an, dass
value festlegt, ob die Collections vor dem
Export gelöscht werden sollen (1, Voreinstellung)
oder nicht (0).
templateName: gibt an, dass
value den Namen einer Layoutdatei enthält,
die (statt des benutzerspezifischen Basislayouts) beim Export
verwendet werden soll. Ist dieser Parameter nicht angegeben, wird
der Wert des Benutzerkonfigurationseintrags
defaultTemplate verwendet. Ist dieser nicht
vorhanden, wird mastertemplate verwendet.
value enthält den Wert für den
betreffenden Parameter.
Zusatzinformationen:
Dieser Befehl kann nur auf Ordner angewendet werden.
Beim Export wird eine der Ordnerhierarchie entsprechende
Verzeichnisstruktur erzeugt, in der für jeden Ordner ein eigenes
Verzeichnis erstellt wird. In diesem Verzeichnis wird der Inhalt des
Ordners als Datei index.html abgelegt. Dokumente werden
in dieses Verzeichnis als dokumentname.html
exportiert, Bilder und Ressourcen erhalten die jeweilige
Dateinamenserweiterung.
Mit dem Systemkonfigurationseintrag
export.abortOnError (YES oder
NO) lässt sich steuern, ob der Export bei Fehlern
abgebrochen oder fortgesetzt werden soll.
Läuft der Search Engine Server und wurde in der
Systemkonfiguration des Content Managers der Eintrag
indexing.staticExport.isActive auf true
gesetzt, so werden während des Exports die UTF-8-kodierten
Webdokumente in die konfigurierten Collections indiziert.
Rückgabewert bei Erfolg: keiner.
Erforderliche Rechte (nur CM): der Benutzer muss das Recht permissionGlobalExport für die Datei haben.
Beispiel:
CM>obj withId 4567 exportSubtree filePrefix /tmp