Zum Hauptinhalt wechseln
Adaptive Planning
Zuletzt aktualisiert: 2023-06-23
importCubeData

importCubeData

Kategorie
Datenübermittlung
Beschreibung
Fügt Daten in ein Cube-Tabellenblatt ein oder ersetzt sie. Diese Methode kann auch verwendet werden, um Daten aus einem Cube-Tabellenblatt zu löschen, indem Nullen in Positionen im Cube-Tabellenblatt importiert werden. Wenn Sie eine 0 in ein Cube-Tabellenblatt importieren, werden die Daten an der Position der 0 gelöscht.
Zum Aufrufen sind Berechtigungen erforderlich
Importieren
Auf Anforderung erforderliche Parameter
Credentials, ImportDataOptions, Version, Sheet, RowData
Die Anforderung dieser Methode enthält die Parameter, mit denen bestimmt wird, welches Tabellenblatt und welche Version die bereitgestellten Datenzeilen erhält. Diese Methode kann auch verwendet werden, um Daten aus einem Cube-Tabellenblatt zu löschen, indem Nullen in Positionen im Cube-Tabellenblatt importiert werden. Wenn Sie eine 0 in ein Cube-Tabellenblatt importieren, werden die Daten an der Position der 0 gelöscht.

Anforderungsformat

<?xml version='1.0' encoding='UTF-8'?> <call method="importCubeData" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/> <importDataOptions planOrActuals="Plan" allowParallel="false" moveBPtr="false"/> <version name="Budget 2014" isDefault="false" /> <sheet name="Sales Cube" isUserAssigned="false" /> <rowData> <header>ProductFurniture|CountryRegion|FabricationMachine|Customer|Account|Level|06/2014|07/2014|08/2014|09/2014|01/2015</header> <rows> <row>Coffee table|Argentina|Do-All 15 Vertical|Aeropostale|Price|Corporate Plan|0|0|0|0|0</row> </rows> </rowData> </call>
Jeder Aufruf dieses API-Aufrufs muss genau ein Element von jeder der aufgeführten Arten enthalten:
  • -Zugangsdaten
  • importDataOptions
  • Version
  • Tabellenblatt
  • rowData
Außerdem muss das Bereichselement angegeben werden, wenn für den Modus ERSETZEN angegeben ist.
Eine Nichtübereinstimmung zwischen der Anzahl der senkrechten Striche (|) im Header und den Daten führt zu einem Fehler bei API v30 oder höher.
Beispielanforderung, die den Ersetzungsmodus mit einem Bereich angibt:
<?xml version='1.0' encoding='UTF-8'?> <call method="importCubeData" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/> <version name="Budget 2022" isDefault="true" /> <sheet name="Expense Cube" isUserAssigned="false" /> <importDataOptions planOrActuals="Plan" allowParallel="false" moveBPtr="false" mode="REPLACE" /> <!-- Scope parameter specifying the import scope.--> <scope> <!-- Specifies the time scope for import. All values will be specified as time codes.--> <time mode="EXPLICIT"> <timeRange start="01/2021" end="10/2021" /> </time> <!-- Specifies list of accounts in the scope. All values will be specified as code field.--> <accounts mode="EXPLICIT"> <account includeDescendants="true">Op_Expense_Inputs</account> <account includeDescendants="true">Op_Expense_Drivers</account> </accounts> <!-- Specifies list of levels in the scope. All values will be specified as code field.--> <levels mode="INPUT"/> </scope> <rowData> <header>ProductFurniture|CountryRegion|FabricationMachine|Customer|Account|Level|01/2022|02/2022|03/2022|04/2022|05/2022|06/2022|07/2022|08/2022|09/2022|10/2022|11/2022|12/2022</header> <rows> <row>Coffee Table|Argentina|Do-All 15 Vertical|Aeropostale|Units|Development|44567.33|21345.77|22341.43|65567.32|298145.12|12641.83|77821.53|7766342.09|211441.21|88712.43|61940.41|662341.03|775420.25|800345.17</row> </rows> </rowData> </call>
Element „Zugangsdaten“.
Tag-Name
-Zugangsdaten
Beschreibung
Alle API-Aufrufe müssen eine einzelne enthaltenElement credentials, um den Benutzer zu identifizieren, der die API aufruft. Der API-Aufruf wird dann als dieser Benutzer ausgeführt (jeder Audit-Trail oder jede Aktionshistorie im System zeigt, dass dieser Benutzer die Aktion ausgeführt hat). Daher muss der Benutzer über die erforderlichen Berechtigungen zum Ausführen der Aktion verfügen, damit der API-Aufruf ausgeführt werden kann erfolgreich ist.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
anmelden
J
Der Anmeldename des Benutzers, der die API-Methode aufruft. Dieser Benutzer muss über die erforderlichen Berechtigungen zum Aufrufen der Methode verfügen.
sampleuser@company.com
Kennwort
J
Das Kennwort des Benutzers, der die API-Methode aufruft.
my_password
Gebietsschema
N
Geben Sie das Gebietsschema an, das verwendet werden soll, um eingehende Zahlen und Datumsangaben zu interpretieren und ausgehende Zahlen und Datumsangaben zu formatieren (mit dem entsprechenden Tausendertrennzeichen).Zeitperiodennamen und Datumsformatierung). Das Gebietsschema wird auch verwendet, um die Sprache anzugeben, in der Systemmeldungen in der Antwort angezeigt werden sollen. Wenn nicht angegeben, wird en_US (amerikanisches Englisch) verwendet.
fr_FR
instanceCode
N
Wenn der in den Zugangsdaten angegebene Benutzer Zugriff auf mehr als eine Instanz von Adaptive Planning hat, kann dieses Attribut verwendet werden, um anzugeben, dass der Benutzer auf eine andere Instanz als seine Standardinstanz zugreifen möchte. Wenn nicht angegeben, wird die Standardinstanz des Benutzers verwendet. Verwenden Sie die exportInstances-API, um die verfügbaren Instanzcodes zu ermitteln.
MYINSTANCE1
Inhalt des Elements
(Keine)
importDataOptions element
Tag-Name
importDataOptions
Beschreibung
Gibt die Optionen an, die beim Ausführen des Imports verwendet werden sollen.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
planOrActuals
J
Legen Sie eines von "Plan" oder "Istzahlen“, um die Art der zu importierenden Daten anzugeben. Wenn diese Einstellung in Konflikt mit der in angegebenen Version stehtVersions-TagDer Wert des Versions-Tags hat Vorrang und diese Einstellung wird ignoriert.
Plan
moveBPtr
N
Wird nur verwendet, wenn dieAttribut planOrActuals ist auf gesetztIst. WennmoveBPtr ist auf gesetztwahr ist, verschiebt der Import den Istzahlen-Verfügbarkeitszeiger in der Istzahlen-Version in die letzte Zeitperiode, die in den importierten Daten gefunden wurde. Wenn aktiviertfalsch: Der Import hat keine Auswirkungen darauf, welche Zeitperioden in welcher Version Istzahlen anzeigen. Dieses Attribut muss auf "false" gesetzt werden, wennplanOrActuals ist auf gesetztPlanen.
false
AllowParallel
J
Wird nur verwendet, wenn dieAttribut planOrActuals ist auf gesetztIst. Wenn aktiviertwahr, dann wird ein Import fortgesetzt, auch wenn für diese Instanz bereits ein anderer Istzahlen- oder Transaktionsimport in Bearbeitung ist. Wenn aktiviertfalsch: Ein Importversuch schlägt fehl, wenn für diese Instanz bereits ein Istzahlen- oder Transaktionsimport verarbeitet wird.
false
useMappings
N
Gibt an, ob Import-Mappings für Konten, Pläne und Dimensionswerte innerhalb der Zeilenelemente verwendet werden sollen. Kommt in Fragestandardmäßig „true“ Wennfalse, dann sollten die internen IDs verwendet werden: Konten werden anhand von Code, Ebenen und Dimensionswerte anhand des Namens identifiziert.
false
includeContext
N
Gibt an, ob Nachrichten den Kontextblock enthalten können. Werte sindfalsch (Kontext nie anzeigen) oderwahr (gegebenenfalls Kontext anzeigen). Falls nicht angegeben„true“ wird angenommen.
false
displayNameEnabled
Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.
N
displayNameEnabled=true gibt an, dass importCubeData erwarten sollte
Account Code
,
Level Code
,
Dimension Code
und
Dimension Name Column
in der Nutzlast, wenn Anzeigename aktivieren für die Instanz auf EIN gesetzt ist.
displayNameEnabled=false gibt an, dass die importCubeData-API weiterhin den API-Vertrag vor v30 einhalten soll, auch wenn "Anzeigenamen aktivieren" für die Instanz auf EIN gesetzt ist. Die importCubeData-API ignoriert die Eigenschaften des Anzeigenamens
Account Code
,
Level Code
,
Dimension Code
und
Dimension Name Column
.
Der Standardwert für displayNameEnabled ist "false".
false
-Modus
Verfügbar in API v32 und höher
N
Gibt den Importmodus an, AppEND oder ERSETZEN.
Append – Vorhandene Fakten werden aktualisiert oder neu eingefügt. Es werden keine Fakten gelöscht.
ERSETZEN: Der Aufrufer muss ein Bereichselement angeben, das die Koordinaten des Cubes darstellt, in dem Daten durch die in der Nutzlast bereitgestellten Daten ersetzt werden. Alle vorhandenen Daten innerhalb des Bereichs werden durch die Daten in der Nutzlast des Aufrufs ersetzt.
Diese Option wird ab API v32 und höher unterstützt. Das Aufrufen der API mit früheren Versionen führt zu einem Fehler.
Der Standardwert für "modus" ist Append, wenn nicht angegeben.
ERSETZEN
Inhalt des Elements
(Keine)
-Versionselement
Tag-Name
Version
Beschreibung
Gibt an, welche Version zum Empfangen der angeforderten Daten verwendet werden soll. Für jeden Aufruf muss eine Version angegeben werden.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Namen
N
Der Name der Version, die zum Empfangen der Daten verwendet werden soll. Mit einem einzigen API-Aufruf kann nur auf eine Version zugegriffen werden. Wenn kein Name angegeben wird, geschieht diesDas Kennzeichen isDefault muss auf gesetzt werdenwahr für dieses Element.
Budget 2012
isDefault
N
Wenn der Aufrufer unabhängig von ihrem Namen auf die aktuelle Standardversion der Instanz zugreifen möchte, kann dieses Attribut auf „true“ gesetzt werden. In diesem Fall wird das Attribut „name“ des Tags (falls vorhanden) ignoriert. Andernfalls, wenn dieser Wert falsch ist oder dieses Attribut nicht vorhanden ist, muss eine Version mit dem angegebenen Namen vorhanden und für den Benutzer zugänglich sein, damit dieser Aufruf erfolgreich ist.
false
Inhalt des Elements
(Keine)
Tabellenblattelement
Tag-Name
Tabellenblatt
Beschreibung
Gibt an, welches Tabellenblatt die importierten Daten erhalten soll. Jeder API-Aufruf kann nur auf die Daten eines Tabellenblatts abzielen.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Namen
J
Der Name des Tabellenblatts, in das die Daten importiert werden.
Personnel
isUserAssigned
N
Gibt an, dass das Tabellenblatt ein Tabellenblatt mit Benutzerzuweisung ist. Wenn nicht angegeben, wird der Standardwert „false“ lautet, was angibt, dass es sich um ein Tabellenblatt mit Ebenenzuweisung handelt.
false
Inhalt des Elements
(Keine)
Bereichselement
Tag-Name
Bereich
Beschreibung
Gibt den Bereich für diesen Import an. Gilt nur, wenn als Modus für den Import ERSETZEN angegeben ist.
Verfügbar in API v32 und höher
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
-Modus
J
Gibt an, ob Zellnotizen im Bereich gelöscht werden sollen oder nicht. Muss einer von drei Aufzählungswerten sein:
  • KEINE – Zellnotizen nicht löschen.
  • ALLE: Löscht alle Zellnotizen innerhalb des Bereichs.
  • modifizierte Version: Löscht die Zellnotizen für Zellen im Bereich, die durch den Import geändert wurden. Dazu gehören zuvor leere Zellen, in die Fakten importiert wurden, und Zellen, deren Fakten gelöscht wurden.
Wenn „eraseCellNotes“ nicht angegeben ist, wird standardmäßig NONE verwendet.
KEINE
Inhalt des Elements
Ein Zeitelement, ein Kontenelement und ein Ebenenelement, die alle obligatorisch sind.
Zeitelement
Tag-Name
Zeit
Beschreibung
Gibt einen oder mehrere Zeitbereiche an, die den Zeitbereich für den Import darstellen.
Verfügbar in API v32 und höher
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
-Modus
J
Gibt den Modus für den Zeitbereich an. Muss eine der folgenden drei Optionen sein:
  • INPUT – Wenn dieser Modus angegeben ist, wird der Zeitbereich durch die Zeitcodes im Element <header> bestimmt. Wenn der Header zwei Monate enthält, sind diese zwei Monate der Bereich für den Import.
  • EXPlicIT: Wenn dieser Modus angegeben ist, werden ein oder mehrere timeRange-Unterelemente erwartet, die den Zeitbereich für den Import bestimmen.
  • VERSION: Wenn dieser Modus angegeben ist, entspricht der Zeitbereich dem Start und Ende der Version einschließlich aller Ausgangssaldoperioden.
Wenn der Modus angegeben ist und entweder INPUT oder VERSION ist, sollte kein timeRange-Element enthalten sein. Falls vorhanden, würde dies als Fehlerbedingung behandelt.
Bei der Angabe von VERSION wird das Versionsstartdatum berücksichtigt, auch wenn das Planstartdatum nach dem Versionsstartdatum liegt.
EINGABE
Inhalt des Elements
Ein oder mehrere timeRange-Elemente, es sei denn, „modus“ ist „INPUT“ oder „VERSION“.
timeRange-Element
Tag-Name
TimeRange
Beschreibung
Gibt einen einzelnen Zeitbereich für den Zeitbereich an.
Verfügbar in API v32 und höher
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
start
J
Die Startperiode für den Importzeitbereich.
07/2021
Ende
J
die Endperiode für den Importzeitbereich.
08/2021
Inhalt des Elements
(Keine)
Kontenelement
Tag-Name
Konten
Beschreibung
Gibt die Kontocodes für den Importbereich an. Wenn hier ein Kontocode vorhanden ist, aber in den Importdaten keine Daten für dieses Konto enthalten sind, werden Daten in diesem Konto für den Zeitbereich und die restlichen Bereichkoordinaten entfernt.
Verfügbar in API v32 und höher
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
-Modus
J
Gibt den Modus für den Kontobereich an. Muss eine der folgenden drei Optionen sein:
  • EXPlicIT: Wenn dieser Modus angegeben ist, werden ein oder mehrere Kontounterelemente erwartet, die den Kontobereich für den Import bestimmen.
  • INPUT: Wenn dieser Modus angegeben ist, wird der Kontobereich durch den eindeutigen Satz von Konten festgelegt, die in den Importdaten vorhanden sind.
  • ALLE: Wenn dieser Modus angegeben ist, umfasst der Kontobereich alle Konten für den Import. Beim Import eines Cube-Tabellenblatts werden alle importierbaren Konten für dieses Cube-Tabellenblatt angezeigt.
Wenn der Modus angegeben ist und entweder INPUT oder ALL lautet, sollte kein Kontounterelement eingeschlossen werden. Falls vorhanden, würde dies als Fehlerbedingung behandelt.
EXPLIZIT
Inhalt des Elements
Ein oder mehrere Kontoelemente, es sei denn, "modus" ist "INPUT" oder "ALL".
Kontoelement
Tag-Name
account
Beschreibung
Gibt den Kontocode an, der in den Importbereich aufgenommen werden soll.
Verfügbar in API v32 und höher
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
includeDescendants
N
Wenn das Konto ein Leaf-Konto ist, hat includeDescendants keine Auswirkungen.
Wenn das Konto ein übergeordnetes Konto ist und dieses Attribut als „Wahr“ angegeben wird, werden alle Leaf-Nachfolger dieses Kontos im Bereich eingeschlossen.
Wenn das Konto ein übergeordnetes Konto ist und includeDescendants falsch ist, wird dieses Kontoelement behandelt, als wäre es nicht angegeben.
Der Grund für diese Behandlung von übergeordneten Konten ist, dass ein Leaf-Konto manchmal zu einem übergeordneten Konto befördert wird und die Importspezifikation möglicherweise nicht rechtzeitig aktualisiert wird, um diese Änderung widerzuspiegeln. Das Ignorieren eines übergeordneten Kontos mit includeDescendants = false verhindert ein unbeabsichtigtes Löschen von Daten.
Dies ist ein optionales Attribut und der Standardwert wird als falsch betrachtet.
wahr
Inhalt des Elements
Gibt den Kontocode des Kontos an, das als Teil des Importbereichs verwendet wird. Beispiel: Operative_Aufwendungen.
Element „Ebenen“.
Tag-Name
Ebene(n)
Beschreibung
Gibt die Ebenencodes für den Importbereich an. Wenn hier ein Ebenencode angegeben ist, die Importdaten jedoch keine Daten für diese Ebene enthalten, werden Daten in dieser Ebene für den Zeitbereich und die restlichen Bereichkoordinaten entfernt.
Verfügbar in API v32 und höher
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
-Modus
J
Gibt den Modus für den Ebenenbereich an. Muss eine der folgenden drei Optionen sein:
  • EXPlicIT: Wenn dieser Modus angegeben ist, werden ein oder mehrere Ebenenunterelemente erwartet, die den Ebenenbereich für den Import bestimmen.
  • INPUT: Wenn dieser Modus angegeben ist, wird der Ebenenbereich durch den eindeutigen Satz von Ebenen festgelegt, die in den Importdaten vorhanden sind.
  • ALLE: Wenn dieser Modus angegeben ist, umfasst der Ebenenbereich alle importierbaren Ebenen.
Wenn der Modus angegeben ist und entweder INPUT oder ALL lautet, sollte kein Ebenenunterelement eingeschlossen werden. Falls vorhanden, würde dies als Fehlerbedingung behandelt.
INPUT
Inhalt des Elements
Ein oder mehrere Ebenenelemente, es sei denn, für "modus" ist "INPUT" oder "ALL" angegeben.
Ebenenelement
Tag-Name
level
Beschreibung
Gibt den Ebenencode an, der für den Import in den Bereich aufgenommen werden soll.
Verfügbar in API v32 und höher
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
includeDescendants
N
Wenn die Ebene eine übergeordnete Ebene ist und dieses Attribut als „true“ angegeben wird, werden alle Leaf-Nachfolger dieser Ebene einschließlich sich selbst (der Knoten „Only“) im Bereich eingeschlossen.
Dies ist ein optionales Attribut.
Wenn das Attribut nicht angegeben wird, ist der Standardwert falsch. Wenn das Attribut nicht oder als „false“ angegeben wird und die angegebene Ebene eine übergeordnete Ebene ist, würde dies bedeuten, dass für den Import der Knoten „Ausschließlich“ (Beispiel: „Nur Engineering“) für diese Ebene als Bereich berücksichtigt wird. Untergeordnete Ebenen werden nicht im Bereich betrachtet, es sei denn, dies ist explizit mit anderen Ebenenelementen angegeben.
wahr
Inhalt des Elements
Gibt den Ebenencode der Ebene als Teil des Importbereichs an. Beispiel: Entwicklung.
rowData-Element
Tag-Name
rowData
Beschreibung
Container für die zu importierenden Datenzeilen.
Attribute des Elements
(Keine)
Inhalt des Elements
Genau eineHeader-Element und genau einsZeilenelement
Header-Element
Tag-Name
-Header
Beschreibung
Gibt die Namen und die Reihenfolge der Spalten der Daten in der entsprechenden anZeilenelement
Attribute des Elements
(Keine)
Inhalt des Elements
Eine Textzeile mit durch vertikale Balken getrennten Spaltennamen. Diese Spaltennamen müssen mit den Namen der Dimensionen oder Felder im Tabellenblatt oder mit Zeitperiodencodes übereinstimmen, die Daten enthalten können. Sie sind identisch mit den Spaltennamen in der Importvorlage für das Tabellenblatt, in das die Daten importiert werden, wobei die einzelnen Spalten-Header durch einen vertikalen Balken oder einen senkrechten Strich vom anderen getrennt sind.
Bei Instanzen, die Anzeigename aktivieren, wird der Header nicht unterstützt
"<dimension>"
in Kombination mit
"<dimension> Name"
oder
"<dimension> Code"
in API v30 oder höher für von Adaptive Planning unterstützte Gebietsschemas.
Zeilenelement
Tag-Name
Zeilen
Beschreibung
Container für einen oder mehrereZeilenelementen.
Attribute des Elements
(Keine)
Inhalt des Elements
Einen oder mehrereZeilenelementen.
Zeilenelement
Tag-Name
Zeile
Beschreibung
Daten für eine einzelne Zeile, die importiert wird.
Attribute des Elements
(Keine)
Inhalt des Elements
Daten für die Felder in einer einzelnen Zeile, die importiert werden, wobei der Wert jedes Felds durch einen vertikalen Balken oder einen senkrechten Strich getrennt ist. Die Datenfelder müssen in derselben Reihenfolge sein wie die Zeile im Header-Element. Wenn Zahlen in den Werten Tausendertrennzeichen verwenden, werden diese als Kommastrennzeichen im Gebietsschema verwendet, das in den Zugangsdaten der Anforderung angegeben wurde.

Antwortformat

Dies sind Beispiele für Antworten für erfolgreichen und nicht erfolgreichen Import von Cube-Daten.

Erfolgreiches Beispiel

<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <messages> <message key="warning-no-data-imported-dimension-unmapped">Warning: Row 3 was not imported because Coffeee table is unmapped.</message> </messages> </response>

Fehlgeschlagen (mit Kontext)

<?xml version='1.0' encoding='UTF-8'?> <response success="false"> <messages> <message key="err-incomplete-cube-row"> <context> <col header="ProductFurniture" value="Coffee table" /> <col header="CountryRegion" value="" /> <col header="Account" value="Do-All 15 Vertical" /> <col header="Level" value="Aeropostale" /> <col header="06/2014" value="Price" /> <col header="07/2014" value="Corporate Plan" /> <col header="08/2014" value="0.0" /> <col header="09/2014" value="0.0" /> <col header="01/2015" value="0.0" /> </context> Row 1 is missing a value. </message> <message key="err-no-rows">You must import at least one row of data.</message> </messages> </response>

Fehlgeschlagen (kein Kontext)

<?xml version='1.0' encoding='UTF-8'?> <response success="false"> <messages> <message key="err-incomplete-cube-row">Row 1 is missing a value.</message> <message key="err-no-rows">You must import at least one row of data.</message> </messages> </response>
Antwortelement
Tag-Name
-Antwort
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Erfolg haben
J
Beideswahr oderfalsch: Gibt an, ob der API-Aufruf erfolgreich war oder nicht. Selbst erfolgreiche Aufrufe können in ihrer Antwort Warnmeldungen enthalten.
true
Inhalt des Elements
Einzelne optionaleNachrichtenelement
Nachrichtenelement
Tag-Name
-Nachrichten
Beschreibung
Container für einen oder mehrere-Nachrichtenelemente.
Attribute des Elements
(Keine)
Inhalt des Elements
Einen oder mehrere-Nachrichtenelemente.
Nachrichtenelement
Tag-Name
Nachricht
Beschreibung
Stellt eine Nachricht dar, die vom System an den Aufrufer zurückgesendet wird. Nachrichten werden für Fehlermeldungen verwendet, wenn Anforderungen nicht erfolgreich sind, als Warnmeldungen, wenn Anforderungen erfolgreich sind, und als Bestätigungsmeldungen bei Erfolgreich.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
-Schlüssel
N
Wenn ein Schlüssel angegeben wird, kann eine bestimmte Meldung oder eine bestimmte Meldungsart identifiziert werden. Dies ist für eine automatische Fehlerprotokollierung und Wiederherstellung in Client-Programmen hilfreich. Schlüssel ändern sich nicht unter verschiedenen Gebietsschemas von Anforderungen, auch wenn sich die Sprache der Nachricht ändert. Es ist auch fehlgeschlagen, dass sich Schlüssel in Zukunft aufgrund von Wording-Anpassungen oder Änderungen der Terminologie ändern.
invalid-attributevalueid
Inhalt des Elements
  • Der Text der Nachricht. Dieser Text ist in der Sprache des in der Anforderung angegebenen Gebietsschemas (vorausgesetzt, das Gebietsschema wird unterstützt). Der Text kann auch variable Informationen enthalten, z. B. die Anzahl der verarbeiteten Zeilen oder die bestimmte Spalte oder den Wert, die einen Fehler verursacht haben.
  • Ein optionales Kontextelement.
-Kontextelement
Tag-Name
context
Beschreibung
Container für ein oder mehrere Spaltenelemente.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Keine
Inhalt des Elements
Ein oder mehrere Spaltenelemente
Element col
Tag-Name
col
Beschreibung
Stellt den Kontext für die Nachricht dar. Gibt ein Header/Wert-Paar an, damit die Zeile identifiziert werden kann, die die Meldung generiert.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
-Header
J
Der Header der Spalte.
"Konto"
Wert
J
Der Wert in der Spalte.
"GL-29482-38233"
Inhalt des Elements
(Keine)