Eingebettete Aktionen im Object XML - Web Services - Foundation 23.2 - Foundation 23.2 - Ready - Content Composer - external

Content Composer Web Services
Platform
Content Composer
Product
Web Services
Release
Foundation 23.2
License

Werden mit Set_Structure bestimmte Objekteigenschaften gesetzt, können auch Aktionen auf das Bündel oder Dokument durchgeführt werden.

Anmerkung: Für dynamisch eingefügte Dokumente und Bausteine entspricht der automatisch beim Einfügen vergebene Referenzstring einer negativen Zahl.

Attributbeschreibung

Attribut Beschreibung

Action

includeDoc: Neues Dokument dem Bündel hinzufügen. (Sachbearbeiter Dokument)

includeBlock: Dynamisches Baustein- Einfügen in Dokument des Bündels

move: Vorhandenes Objekt (Sachbearbeiter-Dokumente und Bausteine) verschieben.

delete: Eingefügtes Objekt (Sachbearbeiter-Dokumente und Bausteine) löschen.

loadexternaldocument: Laden / entfernen des externen Dokuments

target_reference

Referenzindex des Objektes im Baum, der die Einfügeposition bestimmt.

Wird dieser Wert nicht angegeben, wird das Objekt am Ende eingefügt.

position

after: Objekt wird nach der target_reference eingefügt.

before: Objekt wird vor der target_reference eingefügt.

name

Name des Objektes das eingefügt werden soll, bzw. bei loadexternaldocument eindeutiger Name der Datei, die bereits zuvor hochgeladen wurde oder Leerstring, um das externe Dokument wieder zu lösen.

reference

Für die Aktionen Move/Delete die Referenz des Objektes das verschoben/gelöscht werden soll. Für die Aktion loadexternaldocument die Referenz des Objektes, bei dem das externe Dokument zugeordnet/gelöst werden soll.

doc_reference

Referenz des Dokumentes, in das ein Baustein dynamisch eingefügt werden soll.

Hinweise

  • Stellen Sie clientseitig sicher, dass die bei der Action loadexternaldocument mit dem Attribut name angegebene Datei zuvor vom Client mit der Methode Doc_SetFile_Mime auf den Server hochgeladen wurde.
  • Der Client muss einen eindeutigen Namen für die Datei setzen, um Dateiüberschreibungen durch Namensgleichheit zu vermeiden.
  • Soll eine externe Datei wieder gelöst werden, so muss bei der Aktion loadexternaldocument ein Leerstring als Wert des Attributs name verwendet werden.

Beispiele für die Verwendung von Aktionen

Einfügen eines Dokuments 

<mws type="OBJECT">
   <process>
      <object action="includedoc" name="TestDocument" target_reference="" position="after"/>
   </process>
</mws>

Verschieben eines Dokuments 

<mws type="OBJECT">
   <process>
      <object action="move" reference="-3" target_reference="-1" position="before"/>
   </process>
</mws>

Löschen eines Dokuments 

<mws type="OBJECT">
   <process>
      <object action="delete" reference="-1"/>
   </process>
</mws>

Einfügen eines Bausteins (ohne Zielobjekt) 

<mws type="OBJECT">
   <process>
      <object action="includeblock" name="DynBst1" doc_reference="-1" target_reference="-1" position="unknown" />
   </process>
</mws>

Einfügen eines Bausteins (vor Zielobjekt) 

<mws type="OBJECT">
   <process>
      <object action="includeblock" name="DynBlock1" doc_reference="-1" target_reference="-1" position="unknown" />
   </process>
</mws>

Verschieben eines Bausteins 

<mws type="OBJECT">
   <process>
      <object action="move" reference="-1:-2" target_reference="-1:-1" position="after"/>
   </process>
</mws>

Löschen eines Bausteins 

<mws type="OBJECT">
   <process>
      <object action="delete" reference="-1:-2"/>
   </process>
</mws>

Setzen eines externen Dokuments für einen Baustein

Die angegebene Datei muss zuvor vom Client zum Server hochgeladen worden sein (Methode: Doc_SetFile_Mime). 

<mws type="OBJECT">
  <process>
     <object action="loadexternaldocument" name="MyExternalBlockDocument.docx" reference="9BD927E4-39CC-4217-90D1-38C3B15F4CED:35E5A161-D291-4244-84FF-6CB30F14D1A0" />
  </process>
</mws>

Lösen eines externen Dokuments bei einem Baustein 

<mws type="OBJECT">
   <process>
      <object action="loadexternaldocument" name="" reference="9BD927E4-39CC-4217-90D1-38C3B15F4CED:35E5A161-D291-4244-84FF-6CB30F14D1A0" />
   </process>
</mws>

Lösen eines externen Dokuments bei einem Dokument

Die angegebene Datei muss zuvor vom Client zum Server hochgeladen worden sein (Methode: Doc_SetFile_Mime). 

<mws type="OBJECT">
   <process>
      <object action="loadexternaldocument" name=”MyExternalStaticDocument.pdf" reference="C6D5FD76-516C-482E-AAA6-9E51BE8BD2E2" />
   </process>
</mws>

Lösen eines externen Dokuments bei einem Dokument 

<mws type="OBJECT">
   <process>
      <object action="loadexternaldocument" name=”" reference="C6D5FD76-516C-482E-AAA6-9E51BE8BD2E2" />
   </process>
</mws>