Class ExcelConversionClient

Inheritance
System.Object
ExcelConversionClient
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 ExcelConversionClient

Constructors

| Improve this Doc View Source

ExcelConversionClient(String, HttpClient)

Declaration
public ExcelConversionClient(string baseUrl, HttpClient httpClient)
Parameters
Type Name Description
System.String baseUrl
System.Net.Http.HttpClient httpClient

Properties

| Improve this Doc View Source

BaseUrl

Declaration
public string BaseUrl { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

JsonSerializerSettings

Declaration
protected JsonSerializerSettings JsonSerializerSettings { get; }
Property Value
Type Description
Newtonsoft.Json.JsonSerializerSettings
| Improve this Doc View Source

ReadResponseAsString

Declaration
public bool ReadResponseAsString { get; set; }
Property Value
Type Description
System.Boolean

Methods

| Improve this Doc View Source

ConvertToAvaAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)

Converts Excel files to Dangl.AVA projects.

Declaration
public virtual Task<ProjectDto> ConvertToAvaAsync(FileParameter excelFile, bool? readNewElements, bool? rebuildItemNumberSchema, bool? removePlainTextLongTexts, bool? removeHtmlLongTexts)
Parameters
Type Name Description
FileParameter excelFile

The input file
System.Nullable<System.Boolean> readNewElements

Defaults to false
System.Nullable<System.Boolean> rebuildItemNumberSchema

When importing new elements from Excel, sometimes the ItemNumberSchema in the file
is not in compliance with the GAEB requirements. Enabling this option tries to repair
the ItemNumberSchema. Defaults to false.
System.Nullable<System.Boolean> removePlainTextLongTexts

If set to true, plain text long texts will be removed from the output to reduce response sizes
System.Nullable<System.Boolean> removeHtmlLongTexts

If set to true, html long texts will be removed from the output to reduce response sizes
Returns
Type Description
System.Threading.Tasks.Task<Dangl.AVA.IO.Dto.v1.ProjectDto>
Exceptions
Type Condition
SwaggerException

A server side error occurred.
| Improve this Doc View Source

ConvertToAvaAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)

Converts Excel files to Dangl.AVA projects.

Declaration
public virtual async Task<ProjectDto> ConvertToAvaAsync(FileParameter excelFile, bool? readNewElements, bool? rebuildItemNumberSchema, bool? removePlainTextLongTexts, bool? removeHtmlLongTexts, CancellationToken cancellationToken)
Parameters
Type Name Description
FileParameter excelFile

The input file
System.Nullable<System.Boolean> readNewElements

Defaults to false
System.Nullable<System.Boolean> rebuildItemNumberSchema

When importing new elements from Excel, sometimes the ItemNumberSchema in the file
is not in compliance with the GAEB requirements. Enabling this option tries to repair
the ItemNumberSchema. Defaults to false.
System.Nullable<System.Boolean> removePlainTextLongTexts

If set to true, plain text long texts will be removed from the output to reduce response sizes
System.Nullable<System.Boolean> removeHtmlLongTexts

If set to true, html long texts will be removed from the output to reduce response sizes
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Type Description
System.Threading.Tasks.Task<Dangl.AVA.IO.Dto.v1.ProjectDto>
Exceptions
Type Condition
SwaggerException

A server side error occurred.
| Improve this Doc View Source

ConvertToExcelAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, Nullable<Boolean>, Nullable<Boolean>)

Converts Excel files to Excel files. Used, for example, when elements
were added in excel to generate or modify a project. The Excel file can then
be shared containing the full project with all formattings, formulas and styles applied.

Declaration
public virtual Task<FileResponse> ConvertToExcelAsync(FileParameter excelFile, bool? readNewElements, bool? rebuildItemNumberSchema, bool? writePrices, bool? writeLongTexts, string conversionCulture, bool? includeArticleNumbers, bool? lockAllCellsButPrices)
Parameters
Type Name Description
FileParameter excelFile

The input file
System.Nullable<System.Boolean> readNewElements

Defaults to false
System.Nullable<System.Boolean> rebuildItemNumberSchema

When importing new elements from Excel, sometimes the ItemNumberSchema in the file
is not in compliance with the GAEB requirements. Enabling this option tries to repair
the ItemNumberSchema. Defaults to false.
System.Nullable<System.Boolean> writePrices

Defaults to true
System.Nullable<System.Boolean> writeLongTexts

Defaults to true
System.String conversionCulture

The culture that should be used for the conversion process, to have
localized Excel files. The following conversion cultures are available: 'en' for English, 'de' for German, 'fr' for French, ' it' for Italian and ' es' for Spanish. If the culture is not supported, 'en' will be used.
System.Nullable<System.Boolean> includeArticleNumbers

If this is enabled, then a new column will be created in the overview worksheet
that contains the article numbers for positions. Article numbers will be read from
'position.commerceProperties.articleNumber'
System.Nullable<System.Boolean> lockAllCellsButPrices

If this is enabled, then all cells except the unit price cells will
be locked, so users can not accidentally modify other fields.
Returns
Type Description
System.Threading.Tasks.Task<FileResponse>
Exceptions
Type Condition
SwaggerException

A server side error occurred.
| Improve this Doc View Source

ConvertToExcelAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)

Converts Excel files to Excel files. Used, for example, when elements
were added in excel to generate or modify a project. The Excel file can then
be shared containing the full project with all formattings, formulas and styles applied.

Declaration
public virtual async Task<FileResponse> ConvertToExcelAsync(FileParameter excelFile, bool? readNewElements, bool? rebuildItemNumberSchema, bool? writePrices, bool? writeLongTexts, string conversionCulture, bool? includeArticleNumbers, bool? lockAllCellsButPrices, CancellationToken cancellationToken)
Parameters
Type Name Description
FileParameter excelFile

The input file
System.Nullable<System.Boolean> readNewElements

Defaults to false
System.Nullable<System.Boolean> rebuildItemNumberSchema

When importing new elements from Excel, sometimes the ItemNumberSchema in the file
is not in compliance with the GAEB requirements. Enabling this option tries to repair
the ItemNumberSchema. Defaults to false.
System.Nullable<System.Boolean> writePrices

Defaults to true
System.Nullable<System.Boolean> writeLongTexts

Defaults to true
System.String conversionCulture

The culture that should be used for the conversion process, to have
localized Excel files. The following conversion cultures are available: 'en' for English, 'de' for German, 'fr' for French, ' it' for Italian and ' es' for Spanish. If the culture is not supported, 'en' will be used.
System.Nullable<System.Boolean> includeArticleNumbers

If this is enabled, then a new column will be created in the overview worksheet
that contains the article numbers for positions. Article numbers will be read from
'position.commerceProperties.articleNumber'
System.Nullable<System.Boolean> lockAllCellsButPrices

If this is enabled, then all cells except the unit price cells will
be locked, so users can not accidentally modify other fields.
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Type Description
System.Threading.Tasks.Task<FileResponse>
Exceptions
Type Condition
SwaggerException

A server side error occurred.
| Improve this Doc View Source

ConvertToFlatAvaAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>)

Converts Excel files to Dangl.AVA projects.

Declaration
public virtual Task<FlatAvaProject> ConvertToFlatAvaAsync(FileParameter excelFile, bool? readNewElements, bool? rebuildItemNumberSchema)
Parameters
Type Name Description
FileParameter excelFile

The input file
System.Nullable<System.Boolean> readNewElements

Defaults to false
System.Nullable<System.Boolean> rebuildItemNumberSchema

When importing new elements from Excel, sometimes the ItemNumberSchema in the file
is not in compliance with the GAEB requirements. Enabling this option tries to repair
the ItemNumberSchema. Defaults to false.
Returns
Type Description
System.Threading.Tasks.Task<FlatAvaProject>
Exceptions
Type Condition
SwaggerException

A server side error occurred.
| Improve this Doc View Source

ConvertToFlatAvaAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)

Converts Excel files to Dangl.AVA projects.

Declaration
public virtual async Task<FlatAvaProject> ConvertToFlatAvaAsync(FileParameter excelFile, bool? readNewElements, bool? rebuildItemNumberSchema, CancellationToken cancellationToken)
Parameters
Type Name Description
FileParameter excelFile

The input file
System.Nullable<System.Boolean> readNewElements

Defaults to false
System.Nullable<System.Boolean> rebuildItemNumberSchema

When importing new elements from Excel, sometimes the ItemNumberSchema in the file
is not in compliance with the GAEB requirements. Enabling this option tries to repair
the ItemNumberSchema. Defaults to false.
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Type Description
System.Threading.Tasks.Task<FlatAvaProject>
Exceptions
Type Condition
SwaggerException

A server side error occurred.
| Improve this Doc View Source

ConvertToGaebAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, Nullable<DestinationGaebType>, Nullable<DestinationGaebExchangePhase>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)

Converts Excel files to GAEB files.

Declaration
public virtual Task<FileResponse> ConvertToGaebAsync(FileParameter excelFile, bool? readNewElements, bool? rebuildItemNumberSchema, DestinationGaebType? destinationGaebType, DestinationGaebExchangePhase? targetExchangePhaseTransform, bool? enforceStrictOfferPhaseLongTextOutput, bool? exportQuantityDetermination, bool? removeUnprintableCharactersFromTexts, bool? forceIncludeDescriptions, bool? treatNullItemNumberSchemaAsInvalid)
Parameters
Type Name Description
FileParameter excelFile

The input file
System.Nullable<System.Boolean> readNewElements

Defaults to false
System.Nullable<System.Boolean> rebuildItemNumberSchema

When importing new elements from Excel, sometimes the ItemNumberSchema in the file
is not in compliance with the GAEB requirements. Enabling this option tries to repair
the ItemNumberSchema. Defaults to false.
System.Nullable<DestinationGaebType> destinationGaebType

Defaults to GAEB XML V3.2
System.Nullable<DestinationGaebExchangePhase> 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
System.Nullable<System.Boolean> 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.
System.Nullable<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.
System.Nullable<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.
System.Nullable<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.
System.Nullable<System.Boolean> 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.
Returns
Type Description
System.Threading.Tasks.Task<FileResponse>
Exceptions
Type Condition
SwaggerException

A server side error occurred.
| Improve this Doc View Source

ConvertToGaebAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, Nullable<DestinationGaebType>, Nullable<DestinationGaebExchangePhase>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)

Converts Excel files to GAEB files.

Declaration
public virtual async Task<FileResponse> ConvertToGaebAsync(FileParameter excelFile, bool? readNewElements, bool? rebuildItemNumberSchema, DestinationGaebType? destinationGaebType, DestinationGaebExchangePhase? targetExchangePhaseTransform, bool? enforceStrictOfferPhaseLongTextOutput, bool? exportQuantityDetermination, bool? removeUnprintableCharactersFromTexts, bool? forceIncludeDescriptions, bool? treatNullItemNumberSchemaAsInvalid, CancellationToken cancellationToken)
Parameters
Type Name Description
FileParameter excelFile

The input file
System.Nullable<System.Boolean> readNewElements

Defaults to false
System.Nullable<System.Boolean> rebuildItemNumberSchema

When importing new elements from Excel, sometimes the ItemNumberSchema in the file
is not in compliance with the GAEB requirements. Enabling this option tries to repair
the ItemNumberSchema. Defaults to false.
System.Nullable<DestinationGaebType> destinationGaebType

Defaults to GAEB XML V3.2
System.Nullable<DestinationGaebExchangePhase> 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
System.Nullable<System.Boolean> 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.
System.Nullable<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.
System.Nullable<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.
System.Nullable<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.
System.Nullable<System.Boolean> 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.
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Type Description
System.Threading.Tasks.Task<FileResponse>
Exceptions
Type Condition
SwaggerException

A server side error occurred.
| Improve this Doc View Source

ConvertToOenormAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, Nullable<DestinationOenormType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)

Converts Excel files to Oenorm files.

Declaration
public virtual Task<FileResponse> ConvertToOenormAsync(FileParameter excelFile, bool? readNewElements, bool? rebuildItemNumberSchema, DestinationOenormType? destinationOenormType, bool? tryRepairProjectStructure, bool? skipTryEnforceSchemaCompliantXmlOutput, bool? removeUnprintableCharactersFromTexts)
Parameters
Type Name Description
FileParameter excelFile

The input file
System.Nullable<System.Boolean> readNewElements

Defaults to false
System.Nullable<System.Boolean> rebuildItemNumberSchema

When importing new elements from Excel, sometimes the ItemNumberSchema in the file
is not in compliance with the GAEB requirements. Enabling this option tries to repair
the ItemNumberSchema. Defaults to false.
System.Nullable<DestinationOenormType> destinationOenormType

Defaults to Lv2015
System.Nullable<System.Boolean> tryRepairProjectStructure

Defaults to false. If this is enabled, the converter will try to ensure that the project structure
can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target
System.Nullable<System.Boolean> skipTryEnforceSchemaCompliantXmlOutput

If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml
based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior
can be disabled with this option.
System.Nullable<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.
Returns
Type Description
System.Threading.Tasks.Task<FileResponse>
Exceptions
Type Condition
SwaggerException

A server side error occurred.
| Improve this Doc View Source

ConvertToOenormAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, Nullable<DestinationOenormType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)

Converts Excel files to Oenorm files.

Declaration
public virtual async Task<FileResponse> ConvertToOenormAsync(FileParameter excelFile, bool? readNewElements, bool? rebuildItemNumberSchema, DestinationOenormType? destinationOenormType, bool? tryRepairProjectStructure, bool? skipTryEnforceSchemaCompliantXmlOutput, bool? removeUnprintableCharactersFromTexts, CancellationToken cancellationToken)
Parameters
Type Name Description
FileParameter excelFile

The input file
System.Nullable<System.Boolean> readNewElements

Defaults to false
System.Nullable<System.Boolean> rebuildItemNumberSchema

When importing new elements from Excel, sometimes the ItemNumberSchema in the file
is not in compliance with the GAEB requirements. Enabling this option tries to repair
the ItemNumberSchema. Defaults to false.
System.Nullable<DestinationOenormType> destinationOenormType

Defaults to Lv2015
System.Nullable<System.Boolean> tryRepairProjectStructure

Defaults to false. If this is enabled, the converter will try to ensure that the project structure
can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target
System.Nullable<System.Boolean> skipTryEnforceSchemaCompliantXmlOutput

If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml
based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior
can be disabled with this option.
System.Nullable<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.
System.Threading.CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Type Description
System.Threading.Tasks.Task<FileResponse>
Exceptions
Type Condition
SwaggerException

A server side error occurred.
| Improve this Doc View Source

ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<String, IEnumerable<String>>, CancellationToken)

Declaration
protected virtual async Task<ExcelConversionClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)
Parameters
Type Name Description
System.Net.Http.HttpResponseMessage response
System.Collections.Generic.IReadOnlyDictionary<System.String, System.Collections.Generic.IEnumerable<System.String>> headers
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<ExcelConversionClient.ObjectResponseResult<T>>
Type Parameters
Name Description
T