Parameterelemente für den inkrementellen Export

Um zu spezifizieren welche Eigenschaften des inkrementellen Exports ausgelesen oder gesetzt werden sollen, verwendet man Parameterelemente. Im Folgenden werden die Parameterelemente für den inkrementellen Export aufgeführt.

mode
Bedeutung: Liefert den Modus des inkrementellen Exports, on oder off. on: sämtliche Änderungen werden zur Template Engine übertragen. off: Änderungen werden nicht protokolliert. Der Modus kann mit dem Systemkonfigurationseintrag export.incrementalUpdate.isActive eingestellt werden.

Definition:

<!ELEMENT mode (%cm.atom;)>
getKeys
Bedeutung: Liste der mit incrExport-get abfragbaren Parameter.

Definition:

<!ELEMENT getKeys (listitem)*>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>
updateRecordCount
Bedeutung: Liefert im Modus active die Anzahl der Update-Records, die zur Übertragung zur Template Engine anstehen. Im Modus suspended liefert updateRecordsCount den Wert 0 und im Modus off wird eine Fehlermeldung erzeugt.

Definition:

<!ELEMENT updateRecordsCount (%cm.atom;)>
updateRecords
Bedeutung: Liefert im Modus (mode) active eine Liste mit Update-Records. Jeder Update-Record ist selbst eine Liste, die aus zwei Elementen besteht, updateRecordId und updateType. Im Modus suspended liefert updateRecords die leere Liste und im Modus off den Fehlertext "incremental Export is turned off". Die zurück gegebenen Update-Records werden nicht aus der Liste der Update-Records gestrichen. Dies muss explizit mit dem Befehl incrExport removeUpdateRecords ausgelöst werden.

Definition:

<!ELEMENT updateRecords (%cm.atom;)>