Zum Hauptinhalt springen
Nachfolgend finden Sie eine Liste von Funktionen, die zum Erstellen benutzerdefinierter Skripte zur Verfügung stehen. Um auf Objektinstanzen zuzugreifen, verwenden Sie die Variable commandArgs. Alle Variablen in diesem Abschnitt sind global und im gesamten Programm sichtbar.

getCurrentField()

Gibt einen Link auf das Feldobjekt zurück, das das aktuelle benutzerdefinierte Skript verwendet.

getFieldByName(namesPath) (*)

Gibt einen Link auf das Feld zurück, für das das benutzerdefinierte Skript geöffnet wurde.

Beispiel:
[‘Dokumentabschnitt 1’, ‘Gruppe[10]’,‘Field3’],
wobei [10] die Nummer der Instanz der wiederholbaren Gruppe ist.

  • namesPath ist ein Array mit Feld- und Gruppennamen, die den Pfad zum Feld bilden, oder ein Link zu einem Feldobjekt.

getFieldValue(namesPath) (*)

Gibt zurück:

  • einen string für ein TextField-Feld;
  • einen Häkchenwert für ein Checkmark-Feld;
  • ein string-Array für ein Checkmark Group-Feld.

namesPath | fieldObject:

  • ein Array mit Feld- und Gruppennamen, die den Pfad zum Feld bilden,
  • oder ein Link zum Feldobjekt.

setCurrentFieldValue(value, forced, onSaved)

Ändert den Wert des Felds, für das das benutzerdefinierte Skript geöffnet wurde.

Parameter:

  • value – der Feldwert.
  • forced – aktualisiert den Feldwert und zeichnet neue Daten auf. Dieser Parameter ist optional.
    • false – der Feldwert in der Document Definition wird erst aktualisiert, nachdem die save() Funktion aufgerufen wurde.
    • true – der Feldwert in der Document Definition wird sofort aktualisiert.

      Bei einem benutzerdefinierten Skript erfolgt die Aktualisierung unabhängig vom Modus.
      Standardmäßig ist dieser Parameter auf false gesetzt.
  • onSaved – Callback-Funktion. Wird aufgerufen, wenn der Parameter forced auf true gesetzt ist. Dieser Parameter ist optional.

setFieldValue(namesPath | field, value, forced, onSaved) (*)

Ändert den Wert des Felds.

Parameter:

  • namesPath | fieldObject:
    • ein Array mit Feld- und Gruppennamen, die den Pfad zum Feld bilden,
    • oder ein Verweis auf das Feldobjekt.
  • value – Wert des entsprechenden Felds.
  • forced – aktualisiert den Feldwert und speichert neue Daten. Dieser Parameter ist optional.
    • false – der Feldwert in der Document Definition wird erst aktualisiert, nachdem die Funktion save() aufgerufen wurde.
    • true – der Feldwert in der Document Definition wird sofort aktualisiert.

      Bei einem benutzerdefinierten Skript erfolgt die Aktualisierung unabhängig vom Modus.
      Standardmäßig ist dieser Parameter auf false gesetzt.
  • onSaved – eine Callback-Funktion. Wird aufgerufen, wenn der Parameter forced auf true gesetzt ist. Dieser Parameter ist optional.

save()

Schließt das Fenster, in dem das benutzerdefinierte Skript ausgeführt wird, und speichert die Änderungen.

cancel()

Schließt das Fenster, in dem das benutzerdefinierte Skript ausgeführt wird, ohne die Änderungen zu speichern.

(*) Bei einigen der oben aufgeführten Funktionen wird der Pfad zum Feld als Eingabeparameter angegeben. Er besteht aus dem Feldnamen und den Namen der übergeordneten Elemente (Feldgruppe, Abschnitt). Bei Tabellen, wiederholbaren Tabellen und wiederholbaren Gruppen müssen Sie die Instanznummer angeben, beginnend bei 0 (null).

Beispiel:

wobei [10] die Nummer der Instanz der wiederholbaren Gruppe ist.

addEntity(entityInfo: {cacheName, columns, values}, onResult(newId))

Fügt dem Datensatz einen Eintrag hinzu.

Parameter:

  • entityInfo – ein Objekt:
    • cacheName – ein Name für den Datensatz.
    • columns – Namen für die Spalten, in denen Daten erfasst werden. Array von strings.
    • values – die Werte für die entsprechenden Spalten. Array von strings.
  • onResult – eine Callback-Funktion, die die ID des darin erstellten Datensatzes empfängt.

editEntity(entityInfo: {cacheName, columns, values}, onResult())

Bearbeitet einen Datenbankeintrag.

Parameter:

  • entityInfo – ein Objekt:
    • cacheName – ein Name für den Datensatz.
    • columns – Namen der Spalten, in denen Daten erfasst werden. Array von strings.
    • values – die Werte für die entsprechenden Spalten. Array von strings.
  • onResult – eine Callback-Funktion.

getDict({cacheName, filters: [{FieldName, FieldValue}], cursorPos, allowMultipleColumnResults}, onResult (param: { FieldName, FieldValue, BoldMask}[][]) )

Führt eine Suche in einem Datensatz nach einem angegebenen Wert oder einem Teil davon durch. Gibt die Treffer als Zeichenfolgen im folgenden Format zurück:

[{FieldName
FieldValue
BoldMask}].

Parameter:

  • cacheName – der Name des Datensatzes.
  • filters – Suchparameter:
    • FieldName – der Feldname. Leer lassen, um alle Felder zu durchsuchen.
    • FieldValue – der Feldwert.
  • cursorPos – die Position des Cursors im Eingabefeld.
    • Wenn ein Wert nur teilweise eingegeben wurde und der Cursor hinter den eingegebenen Zeichen steht, werden diese als Präfix des gesuchten Werts betrachtet.
    • Wenn der Cursor vor einem teilweise eingegebenen Wort steht, werden diese Zeichen als Ende des gesuchten Werts betrachtet.

      Wenn Sie zum Beispiel bei der Suche nach einem Firmennamen “ADO” eingeben und der Cursor dahinter steht, wird der Wert “AVOCADO” ausgewählt.
      Wenn Sie “ADO” eingeben und der Cursor davor steht, wird der Wert “ADONIS” ausgewählt.
  • allowMultipleColumnResults – Gibt die Werte der gefundenen Felder zurück.
    Der Datensatz kann Einträge enthalten, bei denen einem Feldnamen (FieldName) mehrere Feldwerte (FieldValue) zugeordnet sind. So können in der Spalte CompanyName zum Beispiel zwei oder mehr Varianten eines Firmennamens angegeben sein.

    In diesem Fall:
    • true – gibt alle Feldwerte zurück und protokolliert sie, die die Suchbedingungen erfüllen,
    • false – gibt ein einzelnes Ergebnis zurück und protokolliert es, das am besten zu den Suchbedingungen passt.
  • onResult – eine Callback-Funktion, die ein Array mit Suchergebnissen zurückgibt. Jedes Ergebnis ist eine einzelne Zeichenfolge aus dem Datensatz, der ein Array von Zeichenfolgen ist. Jede Zeichenfolge besteht aus dem Feldnamen, seinem Wert und dem Parameter BoldMask .

    BoldMask – eine Zeichenfolge aus ‘0’ und ‘1’ mit derselben Länge wie der bei der Suche gefundene Wert. ‘1’ steht für ein Zeichen aus dem gefundenen Wert, das mit dem entsprechenden Zeichen im Suchfeld übereinstimmt, und ‘0’ steht für ein Zeichen, das nicht übereinstimmt.

Wenn sich zum Beispiel Folgendes in einem Datensatz befindet:

CompanyName: ABBYY

Angenommen, es wird nach den Zeichen “ABB” gesucht.

Dann wird Folgendes zurückgegeben:

[

[

{

FieldName: ‘CompanyName’,

FieldValue: ‘ABBYY’,

BoldMask: ‘11100’

},

]

]

Hinweis: Das zurückgegebene Array kann mehrere Werte enthalten, auch solche, die den Suchbedingungen anfangs nicht entsprachen. Die Suchergebnisse im Array werden nach dem BoldMask-Parameterwert in absteigender Reihenfolge sortiert (d. h. beginnend mit den Zeichenfolgen, die am besten zu den Suchbedingungen passen).

getDictAll({cacheName, filters: {FieldName, FieldValue}}, }, onResult (param: { FieldName, FieldValue, BoldMask}[][]))

Führt eine Datenbanksuche für den vollständig angegebenen Wert aus. Gibt die Werte aller gefundenen Felder zurück.

Parameter:

  • cacheName – der Name des Datensatzes.
  • Filters – ein object array:
    • FieldName – der Feldname. Um in allen Feldern zu suchen, sollte dieses Feld leer bleiben.
    • FieldValue – der Feldwert.
  • onResult – eine Callback-Funktion, die ein Array mit Suchergebnissen zurückgibt. Jedes Ergebnis ist ein einzelner string aus dem Datensatz, der selbst ein string-Array ist. Jeder string besteht aus dem Feldnamen, seinem Wert und dem Parameter BoldMask .

    BoldMask – ein string aus „0“ und „1“ mit derselben Länge wie der bei der Suche gefundene Wert. ‘1’ steht für ein Symbol aus dem gefundenen Wert, das mit dem entsprechenden Symbol im Suchfeld übereinstimmt, und ‘0’ steht für ein Symbol, das nicht übereinstimmt.


    Wenn sich zum Beispiel Folgendes in einem Datensatz befindet:

    CompanyName: ABBYY

    Angenommen, es wird nach den Symbolen “ABB” gesucht.

    Dann wird Folgendes zurückgegeben:

[

[

{

FieldName: ‘CompanyName’,

FieldValue: ‘ABBYY’,

BoldMask: ‘11100’

},

]

]

Hinweis: Das zurückgegebene Array kann mehrere Werte enthalten, auch solche, die ursprünglich nicht den Suchbedingungen entsprachen. Die Suchergebnisse im Array werden nach dem Wert des Parameters BoldMask in absteigender Reihenfolge sortiert (d. h. beginnend mit strings, die den Suchbedingungen am besten entsprechen).

Beispielskript für die Datenbanksuche

selectRow(tablePath, rowNumber) (*)

Markiert eine Tabellenzeile als ausgewählt.

  • tablePath | fieldObject:
    • ein Array aus Feld- und Gruppennamen, die den Pfad zum Tabellenfeld bilden,
    • oder ein Verweis auf ein Tabellenobjekt.
  • rowNumber – die Nummer der auszuwählenden Zeile, nullbasiert.

deselectRow(tablePath, rowNumber?) (*)

Hebt die Auswahl einer Tabellenzeile auf.

  • tablePath | fieldObject:
    • ein Array aus Feld- und Gruppennamen, die den Pfad zum Tabellenfeld bilden,
    • oder ein Verweis auf ein Tabellenobjekt.
  • rowNumber – die Nummer der Zeile, deren Auswahl aufgehoben werden soll, nullbasiert. Wenn sie weggelassen wird, wird die Auswahl aus allen Zeilen der Tabelle entfernt.

scrollFormToField(namesPath) (*)

Scrollt den Formular-Editor, sodass das Feld sichtbar wird.

  • namesPath | fieldObject:
    • ein Array aus Feld- und Gruppennamen, die den Pfad zum Tabellenfeld bilden,
    • oder ein Verweis auf ein Tabellenobjekt.

getDomElementPosition(domId, onResult: (result?: {width, height, top, left, right, bottom}))

Ermittelt die Position eines Elements im Fenster des Formular-Editors und übergibt das Ergebnis an eine Callback-Funktion.

  • domId – Element-ID im DOM-Format.
  • onResult – eine Callback-Funktion, die das Objekt mit den DOM-Koordinaten des Elements (width, height, top, left, right, bottom) relativ zur oberen linken Ecke des Browserfensters empfängt.

setStyles(styles, callback)

Fügt dem Fenster des Rahmens für benutzerdefinierte Aktionen CSS-Stile hinzu.

  • styles – ein Objekt mit CSS-Eigenschaftsnamen und -werten.

    Beispiel:
    {
    display: ‘block’,
    position: ‘absolute’,
    top: ‘0px’,
    bottom: ‘0px’,
    left: ‘0px’,
    right: ‘0px’,
    width: ‘100%’,
    height: ‘100%’,
    border: ‘0’,
    overflow: ‘hidden’,
    ‘overflow-x’: ‘hidden’,
    ‘overflow-y’: ‘hidden’,
    ‘z-index’: ‘10000’
    }
  • callback – eine Callback-Funktion.

(*) Bei einigen der oben aufgeführten Funktionen wird der Pfad zum Feld als Eingabeparameter angegeben. Er umfasst den Feldnamen und die Namen der übergeordneten Elemente (Feldgruppe, Abschnitt). Bei Tabellen, wiederholbaren Tabellen und wiederholbaren Gruppen müssen Sie die Instanznummer angeben, beginnend bei null.

Beispiel:

wobei [10] die Nummer der Instanz der wiederholbaren Gruppe ist.

Variablen

commandArgs.params.document

Document

Speichert eine Objektkopie eines geöffneten Dokuments. Diese kann verwendet werden, um auf Fehler, Felder oder Regionen im aktuellen Dokument zuzugreifen.

commandArgs.params.currentField

(Picture | Checkmark | Checkmark Groups | FieldsGroup | Table | TextField)

Gibt einen Verweis auf ein Feldobjekt zurück, das den Status des Felds zu dem Zeitpunkt widerspiegelt, zu dem das Skript aufgerufen wird. Es ist Teil des oben angegebenen Dokuments.

Hinweis: Wenn der Feldwert geändert wurde, nachdem das Skript initialisiert wurde, werden diese Änderungen nicht berücksichtigt.

commandArgs.params.appPath

String

Der Domänenname des Servers.

commandArgs.params.coordinates

Object
[{X1,X2,Y1,Y2}]

Die Koordinaten des DOM-Elements, das das benutzerdefinierte Skript aufgerufen hat.

commandArgs.params.currentElementDomId

String

Die ID des DOM-Elements, das das benutzerdefinierte Skript aufgerufen hat.

Funktionen
FunktionBeschreibung
commandArgs.events.addEventHandlerFügt im globalen Kontext des benutzerdefinierten Skripts einen Ereignishandler hinzu.
commandArgs.events.triggerHandlersLöst im globalen Kontext des benutzerdefinierten Skripts ein Ereignis aus.
commandArgs.events.removeEventHandlerEntfernt im globalen Kontext des benutzerdefinierten Skripts einen Ereignishandler.

Fields

(Picture | Checkmark | Checkmark Groups | FieldsGroup | Table | TextField)[]

Schreibgeschützt

Array von Feldern

HasTableLayout

Boolean

Schreibgeschützt

Gibt an, ob die Feldregion eine Tabelle ist.

Caption

String

Schreibgeschützt

Benutzerdefinierter Feldname, Beschriftung

FieldType

Number

Schreibgeschützt

Feldtyp. Möglicher Wert:

4 – Feldgruppe

Id

Number

Schreibgeschützt

Feld-ID

IsReadOnly

Boolean

Schreibgeschützt

Gibt an, ob Felder nicht bearbeitet werden dürfen.

IsVisible

Boolean

Schreibgeschützt

Gibt an, ob das Feld im Datenformular sichtbar ist.

MaxRegions

Number

Schreibgeschützt

Maximale Anzahl von Feldregionen. Wenn der Wert -1 ist, ist eine beliebige Anzahl von Regionen zulässig.

Name

String

Schreibgeschützt

Service-Name für das Feld.

NamePath

String[]

Schreibgeschützt

Array von Feld- und Gruppennamen, die den Pfad zum Feld bilden.

NeedRecognize

Boolean

Lesen/Schreiben

Gibt an, ob der Feldwert aus der Region abgerufen werden soll, wenn die Regeln erneut geprüft werden.

Regions

{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
[{X1,X2,Y1,Y2}];
}[]

Schreibgeschützt

Array von Regionen.

  • Id – Regions-ID.
  • Status – Status der Region.
    • 0 – Region nicht überlagert (oder Region ist gelöscht)
    • 1 – Region wurde nicht erkannt
    • 2 – der Wert aus der Region wird in das Feld übernommen
  • PageId – ID der Seite, auf der sich die Region befindet.
  • IsNew – Flag zur Kennzeichnung neuer Regionen.
  • Coordinates – Koordinaten der Region im Bild.

Fields

(Picture | Checkmark | Checkmark Groups | FieldsGroup | Table | TextField)[]

Schreibgeschützt

Array von Feldern

Pageids

Number[]

Schreibgeschützt

Bezeichner der Seiten, auf denen sich die Section befindet.

IsFlexible

Boolean

Schreibgeschützt

Gibt an, ob die Section flexibel ist.

Caption

String

Schreibgeschützt

Name bzw. Beschriftung des benutzerdefinierten Felds

FieldType

Number

Schreibgeschützt

Feldtyp. Möglicher Wert:

6 – Section

Id

Number

Schreibgeschützt

Feld-ID

IsReadOnly

Boolean

Schreibgeschützt

Gibt an, ob die Bearbeitung des Felds nicht zulässig ist.

IsVisible

Boolean

Schreibgeschützt

Gibt an, ob das Feld im Datenformular sichtbar ist.

MaxRegions

Number

Schreibgeschützt

Maximale Anzahl von Feldregionen. Wenn der Wert -1 ist, ist eine beliebige Anzahl von Regionen zulässig.

Name

String

Schreibgeschützt

Service-Name des Felds

NamePath

String[]

Schreibgeschützt

Array aus Feld- und Gruppennamen, die den Pfad zum Feld bilden.

NeedRecognize

Boolean

Lesen/Schreiben

Gibt an, ob der Feldwert erneut aus der Region übernommen werden soll, wenn die Regeln noch einmal geprüft werden.

Regions

{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
[{X1,X2,Y1,Y2}];
}[]

Schreibgeschützt

Array von Regionen.

  • Id – Regions-ID.
  • Status – Status der Region.
    • 0 – Region nicht überlagert (oder Region wurde gelöscht)
    • 1 – Region wurde nicht erkannt
    • 2 – der Wert aus der Region wird in das Feld eingesetzt
  • PageId – ID der Seite, auf der sich die Region befindet.
  • IsNew – Flag zur Kennzeichnung neuer Regionen.
  • Coordinates – Koordinaten der Region im Bild.

Zeilen

{
Id: number;
RowNumber: number;
HasColorImage: boolean;
TableBlockID: number[];
Cells: (Picture | Checkmark | CheckmarkGroup | TextField)[];
}[]

Schreibgeschützt

Liste der Tabellenzeilen.

Die Parameter des Zeilenobjekts in der Tabelle:

  • Id – Zeilen-ID.
  • RowNumber – die laufende Nummer der Zeile, beginnend bei null.
  • TableBlockId – Bezeichner von Abschnitten, Tabellen und Tabellenblöcken, die den Pfad zum Tabellenblock bilden.
  • Cells – Felder in Tabellenzellen. Felder können die folgenden Typen haben: Bild, Häkchen, Häkchengruppe, Text.

Beschriftung

String

Schreibgeschützt

Name und Beschriftung des benutzerdefinierten Felds

FieldType

Number

Schreibgeschützt

Feldtyp. Möglicher Wert:

7 – Tabelle

ID

Number

Schreibgeschützt

Feld-ID

IsReadOnly

Boolean

Schreibgeschützt

Gibt an, ob das Feld nicht bearbeitet werden kann.

IsVisible

Boolean

Schreibgeschützt

Gibt an, ob das Feld im Datenformular sichtbar ist.

MaxRegions

Number

Schreibgeschützt

Gibt an, wie viele Regionen für das Feld im Datenformular zulässig sind. -1 bedeutet, dass eine beliebige Anzahl von Regionen zulässig ist.

Name

String

Schreibgeschützt

Servicename des Feldes.

NamePath

String[]

Schreibgeschützt

Array von Feld- und Gruppennamen, die den Pfad zum Feld bilden.

NeedRecognize

Boolean

Lesen/Schreiben

Gibt an, ob der Feldwert bei erneuter Regelprüfung aus der Region abgerufen werden soll.

Regionen

{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
[{X1,X2,Y1,Y2}];
}[]

Schreibgeschützt

Array aus Regionen.

  • Id – ID der Region.
  • Status – Status der Region.
    • 0 – Region ist nicht überlagert (oder die Region wurde gelöscht)
    • 1 – Region wurde nicht erkannt
    • 2 – der Wert aus der Region wird in das Feld übernommen
  • PageId – ID der Seite, auf der sich die Region befindet.
  • IsNew – Flag zur Kennzeichnung neuer Regionen.
  • Coordinates – Koordinaten der Region im Bild.

Flags

Number[]

Lesen/Schreiben

Array mit derselben Länge wie das Feld Value. Enthält 0 und 1.

0 – ein Zeichen in Value, das sich an derselben Position befindet wie die 0 in Flags, muss verifiziert werden.

Vorschläge

String[]

Schreibgeschützt

Liste vorgeschlagener Feldwerte

Value

String

Lesen/Schreiben

Feldwert

TextType

Number

Schreibgeschützt

Typ des Textfelds. Mögliche Werte:

  • 0 – Textfeld.
  • 1 – numerisches Feld.
  • 2 – Felder für Währungsbeträge.
  • 3 – DateTime-Feld.
  • 4 – Datumsfeld.
  • 5 – Zeitfeld.
  • 6 – Codefeld.

Beschriftung

String

Schreibgeschützt

Name/Beschriftung des benutzerdefinierten Felds

FieldType

Number

Schreibgeschützt

Feldtyp. Möglicher Wert:

0 – Textfeld

ID

Number

Schreibgeschützt

Feld-ID

IsReadOnly

Boolean

Schreibgeschützt

Gibt an, ob das Feld nicht bearbeitet werden kann.

IsVisible

Boolean

Schreibgeschützt

Gibt an, ob das Feld im Datenformular sichtbar ist.

MaxRegions

Number

Schreibgeschützt

Maximale Anzahl an Feldregionen. Wenn der Wert -1 ist, sind beliebig viele Regionen zulässig.

Name

String

Schreibgeschützt

Service-Name des Feldes.

NamePath

String[]

Schreibgeschützt

Array von Feld- und Gruppennamen, die den Pfad zum Feld bilden.

NeedRecognize

Boolean

Lese-/Schreibzugriff

Gibt an, ob der Feldwert aus der Region abgerufen werden soll, wenn die Regeln erneut geprüft werden.

Regionen

{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
[{X1,X2,Y1,Y2}];
}[]

Schreibgeschützt

Array von Regionen.

  • Id – ID der Region.
  • Status – Status der Region.
    • 0 – Region ist nicht überlagert (oder die Region wurde gelöscht)
    • 1 – Region wurde nicht erkannt
    • 2 – der Wert aus der Region wird in das Feld übernommen
  • PageId – ID der Seite, auf der sich die Region befindet.
  • IsNew – Kennzeichen für neue Regionen.
  • Coordinates – Koordinaten der Region im Bild.

IsVerified

Boolean

Lese-/Schreibzugriff

Gibt an, ob das Feld verifiziert wurde.

NeedVerification

Boolean

Schreibgeschützt

Gibt an, ob für das Feld eine Verifizierung erforderlich ist.

NeedDoubleVerification

Boolean

Schreibgeschützt

Gibt an, ob für das Feld eine doppelte Verifizierung erforderlich ist

IsSummary

Boolean

Schreibgeschützt

Gibt an, ob das Feld in die Datenzusammenfassung im Datenformular einbezogen wird.

Value

Boolean

Lese-/Schreibzugriff

Feldwert

Beschriftung

String

Schreibgeschützt

Name/Beschriftung eines benutzerdefinierten Felds

FieldType

Number

Schreibgeschützt

Feldtyp. Möglicher Wert:

2 – Häkchen

ID

Number

Schreibgeschützt

Feld-ID

IsReadOnly

Boolean

Schreibgeschützt

Gibt an, ob das Feld schreibgeschützt ist.

IsVisible

Boolean

Schreibgeschützt

Gibt an, ob das Feld im Datenformular sichtbar ist.

MaxRegions

Number

Schreibgeschützt

Maximale Anzahl an Feldregionen. Wenn der Wert -1 ist, ist eine beliebige Anzahl von Regionen erlaubt.

Name

String

Schreibgeschützt

Service-Name des Feldes.

NamePath

String[]

Schreibgeschützt

Array aus Feld- und Gruppennamen, das den Pfad zum Feld bildet.

NeedRecognize

Boolean

Lesen/Schreiben

Gibt an, ob der Feldwert bei erneuter Regelprüfung aus der Region abgerufen werden soll.

Regionen

{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
[{X1,X2,Y1,Y2}];
}[]

Schreibgeschützt

Array von Regionen.

  • Id – Regions-ID.
  • Status – Status der Region.
    • 0 – Region nicht überlagert (oder Region wurde gelöscht)
    • 1 – Region wurde nicht erkannt
    • 2 – der Wert aus der Region wird in das Feld übernommen
  • PageId – ID der Seite, auf der sich die Region befindet.
  • IsNew – Flag zur Kennzeichnung neuer Regionen.
  • Coordinates – Koordinaten der Region im Bild.

IsVerified

Boolean

Lese-/Schreibzugriff

Gibt an, ob das Feld überprüft wurde.

NeedVerification

Boolean

Schreibgeschützt

Gibt an, ob für das Feld eine Verifizierung erforderlich ist.

NeedDoubleVerification

Boolean

Schreibgeschützt

Gibt an, ob für das Feld eine doppelte Verifizierung erforderlich ist.

IsSummary

Boolean

Schreibgeschützt

Legt fest, ob das Feld für die Datenzusammenfassung im Datenformular verwendet wird.

MaxSelectedCount

Number

Schreibgeschützt

Maximale Anzahl der ausgewählten Feldwerte.

MinSelectedCount

Number

Schreibgeschützt

Mindestanzahl ausgewählter Feldwerte.

Werte

Number[]

Lese-/Schreibzugriff

Feldwert. Ein Array von Datensatz-IDs, das die Liste der möglichen Feldwerte (Varianten) enthält.

Varianten

{Id:number, Name:string}[]

Schreibgeschützt

Liste möglicher Feldwerte:

  • Id – Datensatz-ID
  • Name – Name des Datensatzes

Beschriftung

String

Schreibgeschützt

Name und Beschriftung des benutzerdefinierten Feldes

FieldType

Number

Schreibgeschützt

Feldtyp. Möglicher Wert:

3 – Häkchengruppe

ID

Number

Schreibgeschützt

Feld-ID.

IsReadOnly

Boolean

Schreibgeschützt

Gibt an, ob das Feld nicht bearbeitet werden kann.

IsVisible

Boolean

Schreibgeschützt

Gibt an, ob das Feld im Datenformular sichtbar ist.

MaxRegions

Number

Schreibgeschützt

Maximale Anzahl an Feldregionen. Wenn der Wert -1 ist, sind beliebig viele Regionen zulässig.

Name

String

Schreibgeschützt

Service-Name des Feldes.

NamePath

String[]

Schreibgeschützt

Array von Feld- und Gruppennamen, die den Pfad zum Feld bilden.

NeedRecognize

Boolean

Lese-/Schreibzugriff

Gibt an, ob der Feldwert bei einer erneuten Überprüfung der Regeln aus der Region abgerufen werden soll.

Regionen

{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
[{X1,X2,Y1,Y2}];
}[]

Schreibgeschützt

Array von Regionen.

  • Id – ID der Region.
  • Status – Status der Region.
    • 0 – Region wird nicht überlagert (die Region wurde gelöscht)
    • 1 – Region wurde nicht erkannt
    • 2 – der Wert aus der Region wird in das Feld übernommen
  • PageId – ID der Seite, auf der sich die Region befindet.
  • IsNew – Flag zur Kennzeichnung neuer Regionen.
  • Coordinates – Koordinaten der Region im Bild.

IsVerified

Boolean

Lese-/Schreibzugriff

Gibt an, ob das Feld überprüft wurde.

NeedVerification

Boolean

Schreibgeschützt

Gibt an, ob für das Feld eine Verifizierung erforderlich ist.

NeedDoubleVerification

Boolean

Schreibgeschützt

Gibt an, ob für das Feld eine doppelte Verifizierung erforderlich ist.

IsSummary

Boolean

Schreibgeschützt

Gibt an, ob das Feld zur Erstellung der Datenzusammenfassung im Datenformular verwendet wird.

Caption

String

Schreibgeschützt

Name bzw. Beschriftung des benutzerdefinierten Felds

FieldType

Number

Schreibgeschützt

Feldtyp. Möglicher Wert:

1 – Bild

Id

Number

Schreibgeschützt

Feld-ID.

IsReadOnly

Boolean

Schreibgeschützt

Gibt an, ob die Bearbeitung des Felds nicht zulässig ist.

IsVisible

Boolean

Schreibgeschützt

Gibt an, ob das Feld im Datenformular sichtbar ist.

MaxRegions

Number

Schreibgeschützt

Maximale Anzahl von Feldregionen. Wenn der Wert -1 ist, ist eine beliebige Anzahl von Regionen zulässig.

Name

String

Schreibgeschützt

Service-Name des Felds.

NamePath

String[]

Schreibgeschützt

Array aus Feld- und Gruppennamen, die den Pfad zum Feld bilden.

Regions

{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
[{X1,X2,Y1,Y2}];
}[]

Schreibgeschützt

Array von Regionen.

  • Id – Regions-ID.
  • Status – Status der Region.
    • 0 – Region nicht überlagert (oder die Region wurde gelöscht)
    • 1 – Region wurde nicht erkannt
    • 2 – der Wert aus der Region wird in das Feld übernommen
  • PageId – ID der Seite, auf der sich die Region befindet.
  • IsNew – Flag zur Kennzeichnung neuer Regionen.
  • Coordinates – Koordinaten der Region im Bild.

Name

Typ

Rechte

Beschreibung

Id

Number

Schreibgeschützt

Feld-ID

Name

String

Schreibgeschützt

Feldname

Sections

Section[]

Schreibgeschützt

Array aus Feldern des Typs Section

FieldType

Number

Schreibgeschützt

Feldtyp.

Möglicher Wert:

8 – wiederholbare Abschnittsgruppe.

AssemblingErrors

{
DocumentNodeRef: number[][];
Description: string;
SectionName: string[]
}[]

Schreibgeschützt

Erstellungsfehler im Dokument:

  • DocumentNodeRef – Liste von Verweisen als Array von Feld-IDs auf Felder im Formular
  • Description – Fehlerbeschreibung
  • SectionName – Liste der vom Fehler betroffenen Abschnitte

BatchId

Number

Schreibgeschützt

Die Paket-ID

Fehler

{
DocumentNodeRef: number[][];
Severity: number;
Message: string;
RuleName: string;
}[]

Schreibgeschützt

Fehler im Dokument:

  • DocumentNodeRef – Liste von Verweisen in Form eines Arrays von Feld-IDs auf Felder im Formular
  • Severity:
    • 1 – Fehler,
    • 0 – Warnung
  • Message – Fehlertext
  • RuleName – der Name der Regel, die den Fehler verursacht hat

Fields

(Section | SectionsGroup)[]

Schreibgeschützt

Liste der Abschnitte/duplizierten Abschnitte

ID

Number

Schreibgeschützt

Dokumentbezeichner

Index

Number

Schreibgeschützt

Index des Dokuments im Paket

Pages

{
Id: number;
Modification: number;
HasColorImage: boolean;
ImageResolution: number;
KeyValue: string;
SectionTemplateId: number;
SectionTemplateName: string;
FlexibleInstanceId: number;
SectionTemplatePageNumber: number;
Comment: string;
ImageWidth: number;
ImageHeight: number;
}[]

Schreibgeschützt

Liste von Dokumentseiten mit den folgenden Angaben:

  • Id – Seiten-ID
  • Modification – die Revisionsnummer der Seite
  • HasColorImage – gibt an, ob die Seite farbig ist
  • ImageResolution – Bildauflösung
  • KeyValue – der Wert des Schlüsselfelds auf der Seite
  • SectionTemplateId – ID des Seitenabschnitts
  • SectionTemplateName – Name des Seitenabschnitts
  • SectionTemplatePageNumber – die Seitennummer im Abschnitt
  • Comment – Prüfkommentar zur Seite
  • ImageWidth – Breite des Seitenbilds
  • ImageHeight – Höhe des Seitenbilds

ProjectId

Number

Schreibgeschützt

Projektbezeichner

TaskId

Number

Schreibgeschützt

Task-ID

TemplateId

Number

Schreibgeschützt

ID der Dokumentdefinition

TemplateName

String

Schreibgeschützt

Der Name des Definitionsdokuments

TemplateVersion

Number

Schreibgeschützt

Definitionsversion des Dokuments

Version

Number

Schreibgeschützt

Dokumentversion