Class PostGaebDestinationOptions

Options for conversions to GAEB

Inheritance

System.Object

PostGaebDestinationOptions

Implements

System.ComponentModel.INotifyPropertyChanged

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Dangl.AVACloud.Client

Assembly: Dangl.AVACloud.Client.dll

Syntax

public class PostGaebDestinationOptions : INotifyPropertyChanged

Properties

DestinationGaebType

Defaults to GAEB XML V3.2

Declaration

[JsonProperty("destinationGaebType", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
[Required(AllowEmptyStrings = true)]
[JsonConverter(typeof(StringEnumConverter))]
public DestinationGaebType DestinationGaebType { get; set; }

Property Value

Type	Description
DestinationGaebType

EnforceStrictOfferPhaseLongTextOutput

Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will
be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition
is exported in full to ensure that incorrectly used text additions are still preserved in the export.

Declaration

[JsonProperty("enforceStrictOfferPhaseLongTextOutput", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool EnforceStrictOfferPhaseLongTextOutput { get; set; }

Property Value

Type	Description
System.Boolean

ExportQuantityDetermination

Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the
'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom
quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for
'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling
this might export data that was not intended to be exported, like internal quantity calculation details,
depending on what data you put in the 'QuantityComponents' property.

Declaration

[JsonProperty("exportQuantityDetermination", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool ExportQuantityDetermination { get; set; }

Property Value

Type	Description
System.Boolean

ForceIncludeDescriptions

If this is enabled, all description elements like texts and execution descriptions will be output
to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does
typically not include descriptions.

Declaration

[JsonProperty("forceIncludeDescriptions", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool ForceIncludeDescriptions { get; set; }

Property Value

Type	Description
System.Boolean

RemoveUnprintableCharactersFromTexts

If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion
might fail in case some text content contains characters that are not allowed in XML output formats.
Defaults to true.

Declaration

[JsonProperty("removeUnprintableCharactersFromTexts", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool RemoveUnprintableCharactersFromTexts { get; set; }

Property Value

Type	Description
System.Boolean

TargetExchangePhaseTransform

Defaults to none, meaning no transformation will be done. The phases are:
Base = 81
CostEstimate = 82
OfferRequest = 83
Offer = 84
SideOffer = 85
Grant = 86

Declaration

[JsonProperty("targetExchangePhaseTransform", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
[Required(AllowEmptyStrings = true)]
[JsonConverter(typeof(StringEnumConverter))]
public DestinationGaebExchangePhase TargetExchangePhaseTransform { get; set; }

Property Value

Type	Description
DestinationGaebExchangePhase

TreatNullItemNumberSchemaAsInvalid

When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas.
With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored
and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility
reasons.

Declaration

[JsonProperty("treatNullItemNumberSchemaAsInvalid", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool TreatNullItemNumberSchemaAsInvalid { get; set; }

Property Value

Type	Description
System.Boolean

Methods

FromJson(String)

Declaration

public static PostGaebDestinationOptions FromJson(string data)

Parameters

Type	Name	Description
System.String	data

Returns

Type	Description
PostGaebDestinationOptions

RaisePropertyChanged(String)

Declaration

protected virtual void RaisePropertyChanged(string propertyName = null)

Parameters

Type	Name	Description
System.String	propertyName

ToJson()

Declaration

public string ToJson()

Returns

Type	Description
System.String

Events

PropertyChanged

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type	Description
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged