basicweb

This configuration is required when using the plugin Cadenza.

  • Documentation

  • YAML Format

  • XML Format

Fill relevant inputs (blue boxes) and click the blue bars on the left to copy XML configuration snippets.
<basicWebConfiguration
>
required

This is basic configuration for Cadenza Web.

A simple configuration could look like:

<basicWebConfiguration>
  <publicCadenzaUrl>http://localhost:8080/cadenza</publicCadenzaUrl>
  <management>
    <maxConcurrentUsers>10</maxConcurrentUsers>
  </management>
</basicWebConfiguration>
<management
>
required
<maxConcurrentUsers
>
required
int

Defines the maximum number of parallel user sessions in a Cadenza instance. In addition to this configuration, the number of sessions is also limited by the number of concurrent users allowed by your Cadenza license.

</maxConcurrentUsers>
<defaultDatasourceMaxCachingAge
>
optional
duration

ISO 8601 Duration Format

Format: P[n]Y[n]M[n]DT[n]H[n]M[n]S

  • P is the duration designator (period) placed at the start of the duration representation
  • Y is the number of years
  • M is the number of months
  • D is the number of days
  • T is the time designator that precedes the time components
  • H is the number of hours
  • M is the number of minutes
  • S is the number of seconds

Examples:

  • PT5M - 5 minutes
  • PT1H30M - 1 hour and 30 minutes
  • P1D - 1 day
  • P1Y2M3DT4H5M6S - 1 year, 2 months, 3 days, 4 hours, 5 minutes, and 6 seconds

This is the duration that items will be kept in the QueryResultCache for a particular datasource if no specific timeout is defined on the datasource itself.

Default: PT5M

</defaultDatasourceMaxCachingAge>
<maxUploadFileSize
>
optional

Defines the maximum size of the file uploaded. Number with unit, e.g. 10M, 512K

Default: 100M

xs:string
</maxUploadFileSize>
</management>
<layout
>
optional
userSpecific
required
=
boolean
</layout>
<appearance
>
optional
<menuEntries
<menuEntry
id
required
=
xs:string
help
url
keymap
<printNameKey
>
optional

This is the message key that will be used to look up a localized name for this menu entry. The printNameKey will be resolved against the custom message properties that you can customize (see Customizing Message Properties ) to return an appropriately localized name.

xs:string
</printNameKey>
<url
>
optional
anyURI

This is the URL to use for this menu entry. Alternatively you can configure a urlKey if you want to localize your URL.

A URL is required for the URL type menu entries. If you have a HELP type menu entry and no URL is provided, it will default to /help/.

</url>
<urlKey
>
optional

This is the message key that will be used to look up a localized URL for this menu entry. Alternatively you can configure a url directly. The urlKey will be resolved against the custom message properties that you can customize (see Customizing Message Properties ) to return an appropriately localized name.

A URL is required for URL type menu entries. If you have a HELP type menu entry and no URL is provided, it will default to /help/.

xs:string
</urlKey>
>
requiredmax. unbounded

This configures one entry to appear in the "help" menu of Cadenza. We support different types of menu entries (HELP, URL and KEYMAP) and depending on the type certain settings are either required or optional:

  • For HELP menu entries a printNameKey is required

  • For URL menu entries a printNameKey is required as well as a url or urlKey

  • For KEYMAP menu entries neither a printNameKey nor a URL is required. This is a special menu entry that triggers a popup with all the available keyboard shortcuts.

</menuEntry>
>
required
</menuEntries>
</appearance>
<csp
>
optional

This is the Content-Security-Policy configuration for Cadenza. This configuration governs how a set of HTTP headers is sent to the browser to regulate a few security settings.

<frame-ancestors
>
optional

The frame-ancestors configuration allows Cadenza to defend itself against Clickjacking attacks. Cadenza defends itself against this by setting the frame-ancestors directive of the Content-Security-Policy header to self. This prevents Cadenza from being embedded in sites other than itself.

If you want to allow Cadenza to be embedded into a site on another origin, then you need to configure the origin of that site as a frame-ancestors source in this configuration.

enabled
optional
=
boolean

You can enable or disable the `Content-Security-Policy` entirely with this flag. This should *not* be disabled in production.

Default: true

<source
>
optionalmax. unbounded
string

Each source element identifies an origin that is allowed to embed Cadenza. By default, there is one source configured called self to allow Cadenza to embed itself. This source is automatically added to the list and does not need to be set here.

</source>
</frame-ancestors>
</csp>
<publicCadenzaUrl
>
optional
anyURI

Externally reachable base URL of the Cadenza installation (e.g. “https://disy.net/cadenza”), e.g. for notification emails. Mandatory if such functionalities are in use.

With cluster operation, the URL of the load balancer must be specified as the base URL and work with “sticky sessions”. If Cadenza is not called directly, but only via a custom application in which Cadenza is integrated, the URL of the custom application must be specified as the base URL.

For more information see Public Base URL

</publicCadenzaUrl>
<labelSets
>
optional

Defines a set of labels. Example of use: The URL to the Cadenza home page can be parameterized to prefilter the Navigator content according to the specified labels, e.g. http//localhost/cadenza/?labelSet={NAME}. Users can remove or change the filter settings as required.

<labelSet
>
requiredmax. unbounded
name
optional
=
string
<label
>
requiredmax. unbounded
string
</label>
</labelSet>
</labelSets>
</basicWebConfiguration>
This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not. 
cadenzaconfig:
  settings:
    basicweb:
      management:
        maxConcurrentUsers: 15
        defaultDatasourceMaxCachingAge: "P2DT3M"
        maxUploadFileSize: "text"
      layout:
        userSpecific: true
      appearance:
        menuEntries:
        - id: "help"
          printNameKey: "text"
          url: "text"
          urlKey: "text"
        - id: "help"
          printNameKey: "text"
          url: "text"
          urlKey: "text"
      csp:
        frame-ancestors:
          enabled: true
          source:
          - "text"
          - "text"
      publicCadenzaUrl: "text"
      labelSets:
      - name: "text"
        label:
        - "text"
        - "text"
      - name: "text"
        label:
        - "text"
        - "text"

Filename: basicweb-config.xml

This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not. 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<basicWebConfiguration>
  <management>
    <maxConcurrentUsers>15</maxConcurrentUsers>
    <defaultDatasourceMaxCachingAge>P2DT3M</defaultDatasourceMaxCachingAge>
    <maxUploadFileSize>text</maxUploadFileSize>
  </management>
  <layout userSpecific="true"/>
  <appearance>
    <menuEntries>
      <menuEntry id="help">
        <printNameKey>text</printNameKey>
        <url>text</url>
        <urlKey>text</urlKey>
      </menuEntry>
      <menuEntry id="help">
        <printNameKey>text</printNameKey>
        <url>text</url>
        <urlKey>text</urlKey>
      </menuEntry>
    </menuEntries>
  </appearance>
  <csp>
    <frame-ancestors enabled="true">
      <source>text</source>
      <source>text</source>
    </frame-ancestors>
  </csp>
  <publicCadenzaUrl>text</publicCadenzaUrl>
  <labelSets>
    <labelSet name="text">
      <label>text</label>
      <label>text</label>
    </labelSet>
    <labelSet name="text">
      <label>text</label>
      <label>text</label>
    </labelSet>
  </labelSets>
</basicWebConfiguration>