dms.XMLMove

Dieser Job verschiebt ein Objekt. Es kann ein Register oder Dokument verschoben werden. Die ElternAttribute (Registerid, Registertyp und Ordnerid) sind die Attribute, die den neuen Standort

bezeichnen. Dabei sollte die Ordnerid auch in dem Fall angegeben werden, dass der neue Standort des Objektes ein Register ist.

Wird ein Register verschoben, so wird es mitsamt seinen Unterobjekten zum neuen Standort verschoben. Darüber hinaus müssen für Verweisdokumente der Standort als Attribut 'sourceparent_id' im Object Tag angegeben werden.

Dokumente können in die Benutzerablage verschoben werden. Dazu brauchen keine Standortbestimmungen im Objekt-Element des XML angegeben werden, aber die Option WFTOUSERTRAY muss dazu aktiviert werden. Das zu verschiebende Dokument muss zuvor in der Workflowablage gelegen haben, Dokumente aus Ordnern und Registern dürfen nicht in die Benutzerablage verschoben werden.

Dokumente können aus der Benutzerablage oder der Workflowablage verschoben werden. Diese Dokumente können dann in ein Register oder einen Ordner verschoben werden. Der Job erkennt dabei automatisch, ob sich das Objekt in einem Register, Ordner, der Workflowablage oder der Benutzerablage befindet.

1. Eingabeparameter

Name Typ Pflicht Beschreibung

Flags

INT

Ja

allgemeine Optionen für den Job (siehe Flags)

Options

STRING

Ja

Semikolon-separierte Job-Optionen (z. B. ARCHIVABLE=1;CHECKACCESS=0) (siehe Parameter Options)

XML

BASE64

Ja

enthält Objektbeschreibung im XML-Format (siehe DMSData XML-Format und Der Parameter XML)

JobUserGUID

STRING

Ja

bestimmt den Benutzerkontext (siehe Der Parameter JobUserGUID)

2. Rückgabe

(INT): 0 = Job erfolgreich, sonst Fehlercode
Vollständige Fehlerliste

Keine jobspezifischen Rückgabewerte.

Die folgenden XML-Beispiele enthalten immer alle Tags und Tag-Attribute, die für die jeweilige Aktion verwendet werden können. Nicht benötigte Tags bzw. Attribute können natürlich weggelassen werden.
Wenn in den Tags wichtige Attribute wie z. B.: id nicht gebraucht werden, sollte man sie entweder ganz weglassen, auf '0' oder auf '-1' setzen, je nach Funktionalität.
XML für das Verschieben eines Registers
<?xml version="1.0" encoding="UTF-8"?>
<DMSData>
  <Archive id="-1" internal_name="press_archive">
    <ObjectType type="REGISTER" internal_name="file_register" id="-1">
      <Object object_id="28" folder_id="58" register_id="-1" register_type="-1"/>
    </ObjectType>
  </Archive>
</DMSData>
XML für das Verschieben eines Dokuments
<?xml version="1.0" encoding="UTF-8"?>
<DMSData>
  <Archive id="-1" internal_name="press_archive">
    <ObjectType type="DOCUMENT" internal_name="word_documents" maintype="4" cotype="0" id="-1">
      <Object object_id="248" register_id="228" register_type="6488064" folder_id="58"/>
    </ObjectType>
  </Archive>
</DMSData>