dms.XMLInsert

Dieser Job fügt ein Objekt in enaio® ein. Es kann ein Ordner, Register oder Dokument eingefügt werden. Der Rückgabeparameter 'ObjectID' entspricht der ID des hinzugefügten Objektes oder ist -1, wenn der Job fehlgeschlagen ist. Ist das einzufügende Objekt ein Dokument und soll dieses Dateien besitzen, die auf den Archivserver übertragen werden sollen, so ist die Eingabe Dateiliste mit den entsprechenden Datei-Pfadangaben zu füllen. Dabei können ebenfalls Dias übertragen werden. Sollten mehr als ein Dia übertragen werden, so wird lediglich das erste Dia aus der Liste am Archivserver eingefügt. Der Standort des neuen Objektes muss im Falle eines Dokumentes oder Registers in das XML Objekt Element eingetragen werden. Ist hier nur die Register ID eingetragen, so wird Registertyp und Schrank automatisch ermittelt. Aus Performancegründen sollten diese Angaben jedoch immer getätigt werden.

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. Eingabedateien

Name Beschreibung

[Dateiliste]

Pfad und Name der einzufügenden Dokumente

File_N

(STRING) N-ter Dateipfad als Alternative zur Dateliste

3. Ausgabeparameter

Name Typ Abhängigkeit Beschreibung

ObjectID

INT

—

neue Objektid,wenn Job erfolgreich, ansonsten -1

ObjectType

INT

—

Typ des Objekts, ansonsten -1

4. Ausgabedateien

Name Beschreibung

[Dateiliste]

Pfad und Name der XML-Datei mit den Fehlern (siehe Flags)

5. Rückgabe

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

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.: maintype, register_id, register_type oder system nicht gebraucht werden, sollte man sie entweder ganz weglassen, auf '0' oder auf '-1' setzen, je nach Funktionalität.
Das folgende Beispiel mit den '<TableFields/>' Tags funktionieren nur, wenn sich eine Tabelle in der Verschlagwortungsmaske für den Schrank befindet.
Das folgende Beispiel mit den '<TableFields/>' Tags funktionieren nur, wenn sich eine Tabelle in der Verschlagwortungsmaske für das Register befindet.
Das folgende Beispiel mit den '<TableFields/>' Tags funktionieren nur, wenn sich eine Tabelle in der Verschlagwortungsmaske für das Dokument befindet.
XML für das Einfügen eines Ordners in einen Schrank
<?xml version="1.0" encoding="UTF-8"?>
<DMSData>
  <Archive id="-1" internal_name="press_archive">
    <ObjectType id="-1" internal_name="press_archive_folder" type="FOLDER">
      <Object>
        <Fields>
          <Field internal_name="subject_area">Softwareentwicklung</Field>
          <Field dbname="feld2">Testbenutzer</Field>
        </Fields>
        <TableFields>
          <TableField dbname="Tabelle">
            <Row>
              <Field internal_name="designation">Dokumentation</Field>
            </Row>
          </TableField>
        </TableFields>
        <Remarks>
          <RemarkText action="INSERT" color="WHITE">Hier kann eine Notiz hinterlegt werden.</RemarkText>
          <RemarkObject action="INSERT" object_id="123" object_type="196616">Verknüpfungsnotiz</RemarkObject>
        </Remarks>
      </Object>
    </ObjectType>
  </Archive>
</DMSData>
XML für das Einfügen eines Registers
<?xml version="1.0" encoding="UTF-8"?>
<DMSData>
  <Archive id="-1" internal_name="press_archive">
    <ObjectType id="-1" internal_name="year_2004" type="REGISTER">
      <Object folder_id="228">
        <Fields>
          <Field internal_name="category">Neuentwicklung</Field>
          <Field osguid="BDED8A3C99E64AD2A4ECBFDB586">öffentlich</Field>
        </Fields>
        <TableFields>
          <TableField internal_name="table_topics">
            <Row>
              <Field internal_name="topic">Dokumentenmanagement</Field>
            </Row>
          </TableField>
        </TableFields>
        <Remarks>
          <RemarkText action="INSERT" color="WHITE">Eine Notiz zum Register.</RemarkText>
          <RemarkObject action="INSERT" object_id="234" object_type="196616">Verknüpfungsnotiz</RemarkObject>
        </Remarks>
      </Object>
    </ObjectType>
  </Archive>
</DMSData>
XML für das Einfügen eines Dokuments
<?xml version="1.0" encoding="UTF-8"?>
<DMSData>
  <Archive id="-1" internal_name="press_archive">
    <ObjectType id="-1" maintype="4" cotype="0" internal_name="word_documents" type="DOCUMENT">
      <Object object_id="-1" register_id="78" register_type="0" variantparent_id="-1" maintype="0">
        <Fields>
          <Field system="0" internal_name="author">Testuser</Field>
        </Fields>
        <MultiFields>
          <MultiField system="0" osguid="2AED8A3399EE778DS4ECBFDB582">
            <Page id="1">
              <Value>345</Value>
            </Page>
            <Page id="2">
              <Value>123</Value>
            </Page>
          </MultiField>
        </MultiFields>
        <TableFields>
          <TableField name="Tabelle">
            <Row>
              <Field name="Team">Entwicklung</Field>
              <Field internal_name="feld2">
Status: freigegeben</Field>
            </Row>
          </TableField>
          <TableField osguid="AAED8A3C99EED78DS4ECBFDB586">
            <Row>
              <Field dbname="fd1">Jahr 2004</Field>
            </Row>
          </TableField>
        </TableFields>
        <Remarks>
          <RemarkText action="INSERT" color="BLUE">Eine Notiz zum Dokument.</RemarkText>
          <RemarkObject action="INSERT" object_id="432" object_type="196616">Verknüpfungsnotiz</RemarkObject>
        </Remarks>
      </Object>
    </ObjectType>
  </Archive>
</DMSData>