HowTo

This section provides walkthroughs and useful tips to get started with Dangl.AVACloud.

Examples

You can find examples for many different programming languages here.

AVACloud Api

Generally, Dangl.AVACloud has these main endpoints:

  • /conversion/gaeb for GAEB inputs
  • /conversion/excel for Excel uploads
  • /conversion/oenorm for Austrian ÖNorm 2063 uploads
  • /conversion/reb for German REB DA11 uploads
  • /conversion/sia for Swiss SIA 451 uploads
  • /conversion/ava for Dangl.AVA project input

All controllers are capable of transforming to any other format. For example, you can send a GAEB file and have it converted back to a Dangl.AVA project.

Please find out more in the interactive API documentation.

Notice for Older Clients / Supported TLS Versions

For security considerations, no TLS protocols below version 1.1 are supported by the Dangl.AVACloud API endpoints. This means that for some environments, TLS 1.2 support has to be enabled manually. This varies on the client you are using. Please contact DanglIT if you have any questions.

Data Size Considerations

When the conversion target is Dangl.AVA, the result will contain all text properties both as plain text and in html format. Often, you will only need one of the formats. Consider setting the options to remove the not-required text formats to reduce response sizes.

Additionally, all endpoints support response compression, e.g. gzip or brotli. If possible, your client apps should be configured to accept compressed responses.

Branding in Export Files

Some formats, currently GAEB and ÖNorm, do support information about the creating application. For example, GAEB files have a field ProgName to indicate which application created the file. By default, when AVACloud is called from a client, it will use the name of the client for this field. The value can be custom set by specyfing a client claim with the name avacloud_gaeb_prog_name and supplying the desired value. Please contact DanglIT staff for this, since users of the hosted service can not change their own client claims. The client name can also be completely hidden by specyfing the claim with the value false, the AVACloud defaults will be used then.

For self-hosting customers, the name of the OpenID client claim can be configured with the ClientGaebProgNameClaimName setting in AvaCloudSettings.json.

GAEB Certified Exports

Some customers using AVACloud have passed the GAEB certification process. This means that the GAEB files generated by AVACloud are allowed to contain an indicator that tells users that the creating application is certified. For this, please contact DanglIT staff to enable the feature for your client. The feature can be enabled by setting the client claim avacloud_gaeb_certified to the value (or values) of the certified export target, e.g. GaebXml_V3_2. Please contact DanglIT staff for this, since users of the hosted service can not change their own client claims.