<obj-where> <obj-exportSubtree>

Definition:

<!ENTITY % cm.obj-exportSubtree "
  (absoluteFsPrefix |
  absoluteUrlPrefix |
  exportCharset |
  filePrefix |
  templateName |
  purgeCollections)*
">
<!ELEMENT obj-exportSubtree %cm.obj-exportSubtree;>

Aufgabe: Die mit obj-where ermittelten Ordner und alle darin enthaltenen Dateien werden exportiert.

Zusatzinformationen: obj-exportSubtree 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 der Ordner als index.html abgelegt. Dokumente werden in dieses Verzeichnis als dokumentname.html exportiert, Bilder und Ressourcen erhalten die Dateinamenserweiterung ihres Feldes contentType.

Spezielle Parameter dieses Funktionselements:

  • absoluteFsPathPrefix: gibt an, dass als Dateipfade exportierte Links als absolute Pfade exportiert werden sollen der Wert dieses Elements als deren Präfix verwendet werden soll. Dieser Parameter hebt im Rahmen dieses Befehls die Werte der entsprechenden Parameter im Systemkonfigurationseintrag export auf.
  • absoluteUrlPrefix: wie absoluteFsPathPrefix, jedoch für die Pfade in URLs.
  • exportCharset: gibt den beim Export für generierte Dokumente zu verwendenden Zeichensatz an. Die unterstützten Werte sind im Systemkonfigurationseintrag export.charsetMap aufgeführt.
  • filePrefix: gibt den Prefix an, der den Namen der Exportdateien voranzustellen ist.
  • templateName: gibt den Namen eines Layouts an, das (statt des Basislayouts) beim Export verwendet werden soll.
  • purgeCollections: gibt an, ob die Collections geleert werden sollen, bevor Inhalte exportiert werden (1, Voreinstellung) oder nicht (0).

Verwendung: Zunächst werden mit obj-where Dateien ermittelt. Anschließend wird obj-exportSubtreeverwendet, um diese Dateien und sämtliche darin enthaltenen Dateien zu exportieren.

Rückgabewert bei Erfolg: keiner.

Erforderliche Rechte: Der authentifizierte Benutzer muss das Recht permissionGlobalExport für die mit obj-where ermittelten Dateien haben.

Beispiel:

<cm-request...>
  <obj-where>
    <objClass>newsPublication</objClass>
    <title>sales_week</title>
  </obj-where>
  <obj-exportSubtree>
    <filePrefix>/news</filePrefix>
    <templateName>localtemplate</templateName>
  </obj-exportSubtree>
</cm-request>

<cm-response...>
  <cm-code numeric="0" phrase="ok"/>
</cm-response>