eBiss 3

Abhängig von Klasse eBiss.Api.

Dieser Text erlaubt die Dokumentation von Schnittstellen, der Text zwischen den Klammern wird im Mapping Designer unter dem Feldnamen angezeigt.

Dieses Attribut erlaubt die Definition eines Standardwertes für ein Feld. Der Wert wird nur verwendet, falls ein geladenes Dokument keinen Wert für das attributierte Feld bereitstellt. Ist der Wert im Dokument explizit „leer“ bzw. <NULL> gesetzt so wird der gesetzte Standardwert ebenfalls überschrieben. (Dieses Attribut dient in erster Linie der Definition eines abweichenden Standardwertes im Typ-Editor.)

Falls der Field-Name unzulässige Sonderzeichen enthält, kann dieser als MapExternalName angegeben werden.
Als Field -Name kann ein Alias-Name ohne Sonderzeichen angegeben werden.

¹⁾|Speichert das gelesene Dokumentendatum als FrameValue²⁾

³⁾|Speichert die gelesene Dokumentnummer als FrameValue.⁴⁾

⁵⁾|Speichert die gelesene Dokumentempfänger-Daten als FrameValue.⁶⁾

⁷⁾|Speichert die gelesenen Dokumentsender-Daten als FrameValue.⁸⁾

⁹⁾|Speichert die gelesenen Interchangeempfänger-Daten als FrameValue,
damit dieses beim Analysieren eines Dokuments abgerufen und von eBiss ausgewertet werden können.

¹⁰⁾ Speichert die gelesene Interchange-Referenznummer als FrameValue.¹¹⁾

¹²⁾ Speichert die gelesenen Interchangesender-Daten als FrameValue.¹³⁾

Formatiert ein NullableNumeric oder DateTime Feld für die Ausgabe.

Parameter:

1. mandatory: string formatString : Formatierung wie z.B. „#.00“.
2. optional: MapFormatScope.Read od. .Write od. .ReadWrite : Deklariert wann formatiert werden soll.
3. optional:bool InvariantCulture : true erzwingt die Formatierung gemäß der InvariantCulture, unabhängig von den lokalen Formatierungseinstellungen, false oder Weglassen des Parameters verwendet die lokalen Formatierungseinstellungen des Computers, auf dem eBiss läuft.

Beispiele:

[MapFormat("###.000", MapFormatScope.Write, true)]

formatiert den NullableNumeric-Wert 102.50 in dem Feld beim Schreiben zu „102.500“.

[MapFormat("###.000", MapFormatScope.Write)]

Formatiert den NullableNumeric-Wert 102.50 in dem Feld beim Schreiben zu „102,500“.

[MapFormat("###.000", MapFormatScope.Read)]

formatiert den NullableNumeric-Wert 102.50 in dem Feld beim Einlesen zu „102,500“.

[MapFormat("{0,-20:0.000}")]

Ausgabe des numerischen Wertes in einer Breite von 20 Zeichen, linksbündig, mit 3 Nachkommastellen (Verwendung u.a. für den FixedLengthWriter).

[MapFormat("{0,20:0.0}")]

Ausgabe des numerischen Wertes in einer Breite von 20 Zeichen, rechtsbündig, mit einer Nachkommastelle (verwendung u.a. für den FixedLengthWriter).

[MapFormat("dd.MM.YY")]

Formatiert den Datumswert.

Hinweis: Soll der Wert eines String-Feldes im Zielobjekt formatiert werden, muss dies im Mapping durch die Funktion FormatNumber oder CustomNumberFormat erfolgen.

Field wird beim Lesen eines Dokuments nicht mit Daten gefüllt, oder wird beim Erzeugen von Dokumenten nicht geschrieben.

MapIgnore(MapIgnoreScope.OnRead)

Basisklasse ignorieren. Wird kein Parameter ( bool b ) angegeben, so ist der Defaultwert auf true gesetzt.

Wird benötigt, falls Dokumente mehrfach Werte des gleichen Datenelements enthalten¹⁴⁾.

MapMinOccurs(1) ist per default auf 1 gesetzt wenn kein Parameter angegeben wird und bedeutet, daß diese Liste mind. einmal im Order-Objekt enthalten ist.

Feld muss beim Lesen eines Dokuments mit Daten gefüllt werden, sonst wird eine Fehlermeldung angezeigt. Beim Schreiben muss das Zielfeld zwingend bedient werden.

MapSize gibt die Länge in Zeichen (Fixed Length in Byte) an.

Wird z.Bsp. bei CSV Dateien ohne Zeilentypen angewendet.

Hilfsattribut, um den Anfang des nächsten Dokuments zu triggern.
Hinweis: Wird benötigt, wenn mehrere Dokumenten innerhalb eines Anhangs enthalten sind.

Attribut zum Steuern des XmlWriters.

• HandlingType.AsAttribute : Felder innerhalb einer Klasse als Attribute innerhalb des Xml-Tags ausgeben¹⁵⁾.¹⁶⁾
• HandlingType.AsText : Felder innerhalb einer Klasse als Text zwischen zwei Xml-Tags ausgeben.
• HandlingType.AsTextDefault : Felder innerhalb einer Klasse nur als Text ausgeben und den Datenelementname als TAG unterdrücken.¹⁷⁾
• HandlingType.MapXmlHandlingSupress: Feld nicht ausgeben.

Beispiel:

[MapIgnore(MapIgnoreScope.OnRead), MapXmlHandling(MapXmlHandlingAttribute.HandlingType.AsAttribute)]
        public string xmlns = "http://schemas.microsoft.com/dynamics/2011/01/documents/Message";

Erlaubt das Abbilden eines .NET Namensraums auf einen XML Namensraum. Wird eine Klasse mit dem Attribut versehen, so werden alle Felder im Namensraum dieser Klasse (beim Lesen und Schreiben) mit dem zugehörigen Präfix versehen. Standardmäßig werden nur Elemente (Tags) voll qualifiziert, dieses Verhalten kann aber über die verschiedenen Konstruktoren des MapXmlNamespaceAttributes beeinflusst werden.

Die o.g. Funktionalität des MapXmlNamespaceAttributes wird für das mit diesem Attribut markierten Feld ausgesetzt.

Alernativ zu der o.g. Funktionalität des MapXmlNamespaceAttributes können mit diesem Attribut individuelle Felder mit einem XML Namensraum-Präfix versehen werden.

Ein so markiertes Feld wird über den X-Path Ausdruck befüllt und sollte im Zusammenhang mit MapIgnore(MapIgnoreScope.OnReadWrite) verwendet werden.

Beispiel:

        [MapIgnore(MapIgnoreScope.OnReadWrite), MapXPathExpression("Addresses[@Kind='RCPT']/@ILN"), MapFrameDocumentRecipient]
        public string Sender{get; set; }
 
        public List<MapXPathExpressionSampleAddress> Addresses { get; set; }

Hinweis: Wird nur vom XML- und FlatFile Analyzer ausgewertet.

Ein mit diesem Attribut ausgestattetes Datenelement steht im Mapping nicht zur Verfügung und wird auch nicht im DbAdapter verwendet.