dms.XMLDelete

Dieser Job löscht das angegebene Objekt. Es können Ordner, Register oder Dokumente gelöscht werden. Grundsätzlich wird zwischen zwei Arten zu löschen durch die Option HARDDELETE unterschieden:

'Physikalisch löschen': Das Objekt wird vollständig gelöscht, also nicht den Papierkorb verschoben. Im Falle, dass das Objekt ein Dokument ist, werden auch alle seine Dateien vom Server entfernt.
'In den Papierkorb löschen': Das Objekt wird nicht physikalisch entfernt, sondern befindet sich anschließend im Papierkorb und kann von dort aus wiederhergestellt werden.

Ein Objekt kann Unterobjekte besitzen (z.B ein Ordner enthält Dokumente). Dieses Objekt kann nicht gelöscht werden, wenn nicht alle seine Unterobjekte gelöscht werden. Dieses wird durch die Option DELETECASCADING gesteuert.

Das Löschen von Objekten, die einem Workflowprozess zugeordnet sind, ist nicht möglich. Für den Fall, dass ein Dokument mehrere Standorte besitzt, wird der Job im Allgemeinen das Dokument von allen seinen Standorten löschen. Es ist jedoch auch möglich, das Dokument von genau einem solchen Standort zu entfernen. Dazu sind im Objekt-Element die Eltern-Attribute (Registerid, Register-Typ oder Ordnerid) zu setzen. Dieses stellt nun den Standort des zu entfernenden Dokuments dar.

1. Eingabeparameter

Name Typ Pflicht Beschreibung

Name	Typ	Pflicht	Beschreibung
`Flags`	INT	Ja	allgemeine Optionen für den Job (siehe Flags)
`Options`	STRING	Ja	Semikolon-separierte Job-Optionen (z. B. HARDDELETE=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)

Flags

INT

allgemeine Optionen für den Job (siehe Flags)

Options

STRING

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

XML

BASE64

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

JobUserGUID

STRING

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.

XML für das Löschen eines Ordners

<?xml version="1.0" encoding="UTF-8"?>
<DMSData>
  <Archive id="-1" internal_name="press_archive">
    <ObjectType internal_name="press_archive_folder" type="FOLDER" id="-1">
      <Object object_id="214"/>
    </ObjectType>
  </Archive>
</DMSData>

XML für das Löschen 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="229"/>
    </ObjectType>
  </Archive>
</DMSData>

XML für das Löschen eines Dokuments

<?xml version="1.0" encoding="UTF-8"?>
<DMSData>
  <Archive internal_name="press_archive" id="-1">
    <ObjectType internal_name="word_documents" maintype="4" cotype="0" type="DOCUMENT" id="-1">
      <Object object_id="214" variantparent_id="-1"/>
    </ObjectType>
  </Archive>
</DMSData>