X4 Produktdokumentation

Defining Configuration Options

The Configuration tab contains several areas where you can set configuration options for your Web App.

Area

Description

image-20260211-074449.png


Path:

Here, you can enter a path that appears as part of the URL in the browser.

image-20260211-074525.png


Display name:

Enter the display name of the Web App in this field. The display name of the Web App is displayed in the browser tab or title bar.


Favicon:

Path to the graphics file (.gif, .ico, .png, or .svg) used as the favicon of the Web App. The file must be in the Resources folder just below the Web App project.


Logo:

Path to a graphics file (.gif, .png or .svg) or a material icon that is used as the logo of the Web App. To do this, select the appropriate radio button.

Note:

  • The material icon must be specified with the prefix icon, e.g. icon:<MaterialIconName>.

  • The graphic file must be located in the Resources folder just below the Web App Project.

  • The logo is always displayed with a height of 45 pixels. The image file used as the logo is scaled automatically.


Logo color:

Using this field, you can only change the color of a logo that you have added via logoURL with a Material Icon. You can enter a hexadecimal color value (e.g. ff5a00) or a color code from the Web App color palette (see Theming), e.g. A200. To do this, select the appropriate radio button.

You cannot set the color for image files.

Note:

  • This setting overrides the default color of the color scheme!

  • Do not use a hash before the color value, and do not use a shortened notation for the color value!


Show header:

Select/clear this checkbox to show or hide the header of the Web App. By default, the checkbox is selected.


Show footer:

Select/clear this checkbox to show or hide the footer of the Web App. By default, the checkbox is selected.

Note:

If actions are available in the displayed component, the footer is displayed in mobile view independent of the checkbox value.


Blurred overlay background:

Select/clear this checkbox to make the background blurry or clear when displaying overlay structure elements.

By default, the checkbox is selected. This means that the part of the Web App that is still visible in the background when opening an overlay becomes blurry.


Show cookie consent pop-up:

With this checkbox, you define whether the pop-up message for cookie consent is displayed. By default, the checkbox is selected.

image-20260211-074632.png


Authorization Flow:

With this drop-down list, you define which authorization flow is used.

Available options:

Public:
With this option, you define that no login is required. Users who access the Web App without logging in are identified as anonymous users. Anonymous users cannot receive special rights.

Authenticated:
With this option, you define that users must log in to the Web App. The user's rights and roles are configured in the identity provider used.

Note:

To use the single-sign-on functionality, you need to use the Authenticated authorization flow.

Note:

If you have opened Web Apps and have been inactive for a while, the refresh token for your session expires.

In this case, the following message is displayed:

image-20250206-093139.png



Auth Config Name:

This field is only active if you select Authorization Flow Authenticated. Here you enter a configuration that you have defined in the authentication_config.xml file. For more information, see Authentication with OpenID Connect (OIDC).


Access right:

With this field, you define which role can access the Web App. You can enter the name of a previously defined role.

Note:

The roles are managed in the identity provider used.


⚠️ Deprecated

  • Realm

  • Client

  • Client Secret

Note:

Previously, in X4 BPMS, it was possible to specify the Realm, Client ID and Secret parameters in .wsinc and .wad files in order to use a different realm in the standard Keycloak system for individual HTTP endpoints or Web Apps. As of X4 BPMS 7.5.0, this function is considered obsolete (deprecated).

The current implementation supports the use of multiple identity providers (IdP) at the same time. Each secured Web App is protected by default with an authentication configuration marked as the default.

If an endpoint or Web App is to be secured with another IdP or another realm of the same IdP, the desired authentication configuration is now specified instead of dynamically overwriting the realm, client ID, and secret per call.


Access right:

With this field, you define which role can access the Web App. You can enter the name of a previously defined role.

Note:

The roles are managed in the identity provider used.


Local Only:

With this checkbox, you define whether the project is only to be deployed locally. By default, the checkbox is cleared.

Note:

If this option is enabled, the web application can only be viewed in the browser on the local system.


image-20260211-075539.png


Data protection:

This field allows you to link external pages as a privacy statement.


Imprint:

This field allows you to link external pages as imprint.


Logout redirect:

This field allows you to redirect users to the specified URL after logging out. You can enter any valid URL with any valid protocol (http://, https:// etc.) , e.g. https://www.softproject.de/.


Map API key:

If Google Maps is used as the map provider, the following APIs must be enabled:

  • Maps JS API

  • Locations (for search and route calculation)

  • Directions (for route calculation)


Project is active:

With this checkbox, you define whether the project is activated. By default, the checkbox is cleared.

Note:

If the project is not active, the web application cannot be displayed in the browser.


Enable URL Parameters:

With this checkbox, you define whether data is to be transmitted to a Web App when it is called.

image-20260211-075614.png


X-Frame Options:

With this drop-down list, you define whether a browser calling the target page is allowed to embed the page in a <frame>, <iframe>, <embed>, or <object>.

Available options:

  • DENY: The target page must not be embedded.

  • SAMEORIGIN: The target page can be embedded.


Max Age

In this field, you define the time in seconds the browser is supposed to remember that the Web App can only be accessed via HTTPS.


HTTP Strict Transport Security Header is enabled

Specifies whether the HTTP Strict Transport Security Response Header is enabled or disabled.


HTTP Strict Transport Security Header is preloaded

Specifies whether the HTTP Strict Transport Security Response Header is preloaded.


Strict Transport Security is applied to subdomains

Determines whether the HTTP Strict Transport Security Response Header settings also apply to the subdomains of the Web App.