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
<?xml version="1.0" encoding="utf-16"?>
<mws type="OBJECT"> 
   <process id="ba56e16a-b7ba-495f-8ab9-158e48df5846"> 
      <object title="COD6773_test_DIPWrite" type="P" name="COD6773_test_DIPWrite" index="12112018-20207-tdc-obatest" reference=""> 
         <object title="COD6773_Simple" type="D" name="COD6773_Simple" index="12112018-20208-tdr-obatest" reference="ED90176C-B7FF-46F8-A1B4-0D00F508B36C" state="1" enabled="1" print_asktime="0" form="COD6773_Html_Body" printer="COD6773" printer_type="OEP" printtime="1" print_changeable="1" copycount="0" copy="0" password="" doctype="1" dataid="Partner_V2" external_doctype_id="2" external_doctype_name="doc" filename="COD6773_Simple_ED90176C-B7FF-46F8-A1B4-0D00F508B36C_O.docx" isprotected="0"/> 
         <object title="COD6773_Simple_2" type="D" name="COD6773_Simple_2" index="12112018-20209-tdr-obatest" reference="19CA3FBB-1BFC-4122-B26D-67A8F503BF83" state="2" enabled="1" print_asktime="0" form="COD6773_Html_Body" printer="COD6773" printer_type="OEP" printtime="1" print_changeable="1" copycount="0" copy="0" password="" doctype="1" dataid="Partner_V2" external_doctype_id="2" external_doctype_name="doc" filename="COD6773_Simple_2_19CA3FBB-1BFC-4122-B26D-67A8F503BF83_O.docx" isprotected="0"/> 
         <object title="COD6773_Simple" type="D" name="COD6773_Simple" index="12112018-20210-tcr-obatest" reference="C4C8FDDB-2D27-4956-A6EA-BA2F08904433" state="1" enabled="1" print_asktime="0" form="COD6773_Html_Body" printer="COD6773" printer_type="OEP" printtime="1" print_changeable="1" copycount="0" copy="1" password="" doctype="1" external_doctype_id="23" external_doctype_name="doc" copytext="" originalid="ED90176C-B7FF-46F8-A1B4-0D00F508B36C"/> 
         <object title="COD6773_Simple_3" type="D" name="COD6773_Simple_3" index="20012020-20414-tdr-obatest" reference="7781B1FE-2F66-4B9D-9F7B-997E9E97424C" state="2" enabled="1" print_asktime="0" form="COD6773_Html_Body" printer="COD6773" printer_type="OEP" printtime="1" print_changeable="0" copycount="0" copy="0" password="" doctype="1" dataid="Partner_V2" filename="COD6773_Simple_3_7781B1FE-2F66-4B9D-9F7B-997E9E97424C_O.docx" isprotected="0"/> 
      </object> 
   </process>
</mws>

Beschreibung der gemeinsamen Attribute des Elements object

Element Beschreibung

title

Titel (Ersatz für den Namen zur Anzeige für den Anwender)

type:

Objekttyp

P = Bündel

D = Dokumentvorlage

B = Textbaustein

name

Objektname

index

Objektindex

reference

Referenz des Dokuments im Bündel. Siehe: Adresse eines Objekts im Bündel

Zusätzliche Attribute bei Dokumenten, Kopien und Bausteinen

Element Beschreibung

state

0: Deactivated (Objekt ist deaktiviert, kann aber aktiviert werden)

1: Required (Objekt ist aktiviert und darf nicht deaktiviert werden)

2: Activated (Objekt ist aktiviert, kann aber deaktiviert werden)

3: Disabled (Objekt ist deaktiviert und darf nicht aktiviert werden)

enabled

0

  • beim Dokument: wenn state gleich deactivated oder disabled ist

  • bei der Dokument-Kopie: wenn das dazugehörige Original nicht aktiviert ist (Original hat den state deactivated oder disabled)

1

  • beim Dokument: wenn das Dokument aktiviert ist (state ist activated oder required)

  • bei der Kopie: wenn Orginal aktiviert ist und Kopie den state activated oder required hat

Zusätzliche Attribute bei Dokumenten / Kopien

Element Beschreibung
print_asktime

0: Abfrage des Druckzeitpunktes soll erfolgen.

1: Abfrage des Druckzeitpunktes soll nicht erfolgen.

form

Formularname

printer

Druckername

printer_type

OEP: Email-Drucker

OP: Online-Drucker

printtime

0: Unbekannt

1: Sofort

2: Versetzt

print_changeable

0: Änderungen der Druckdefinition erlaubt.

1: Änderungen der Druckdefinition nicht erlaubt.
copyCount

Anzahl echter Kopien

copy

0: Original

1: Kopie

password

Kennwort des Dokumentes im Klartext

doctype

1: DynamicWord

2: StaticWord

3: StaticPdf

4: StaticTiff

5: StaticXps

external_doctype_id

ID des OnBase Dokumenttyps (long)

external_doctype_name

Name des OnBase Dokumenttyps (string)

Das folgende Attribut ist nur bei Originalen enthalten

Element Beschreibung

dataid

Name der zugeordneten TextDatenReferenz, die die zu verwendende Selektion referenziert.

Die folgenden Attribute sind nur bei Kopien enthalten

Element Beschreibung

copytext

Text auf Kopie

originalid

ChildId des Originaldokumentes. Der Wert korrespondiert mit dem Wert des Attributes reference des entsprechenden Originaldokumentes.

Folgende Attribute sind nur enthalten, wenn das Dokument bzw. die Kopie bereits erzeugt wurden

Element Beschreibung

filename

Name des erzeugten Dokumentes

isprotected

0: Der Dokumentenschutz ist nicht aktiviert

1: Der Dokumentenschutz ist aktiviert

Zusätzliche Attribute bei Bausteinen

Element Beschreibung

childcount

Anzahl der Kinder des Bausteins

Folgendes Attribut ist bei Dokumenten / Bausteinen nur enthalten, wenn dem Objekt mittels des Clients ein externes Dokument zugeordnet wurde

Element Beschreibung

isexternaldocument

1: Es ist ein externes Dokument zugeordnet.