X4 Produktdokumentation

Declaring Configurations in the Design View

The individual areas of the Design view are explained below.

Area

Description


image2023-3-9_9-29-0.png

Path:

Here, you can enter a path that appears as part of the URL in the browser. The first time you open the WAC file, the name of the Web App Project is automatically entered.

Note:

You can change the path at runtime in the X4 Control Center via Administration > X4 API.


image2023-3-9_9-30-14.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.


Logo:

Path to a graphics file (.gif, .png or .svg) or a material icon that is used as the logo of the Web App.

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:

Use this field to define the color of the logo. 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.

Using this field, you can only change the color of a logo that you have added via logoURLwith a material icon. 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!


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.


Display Header Section:

With this checkbox, you define whether the header section of the Web App is displayed. By default, the checkbox is selected.


Display Footer:

With this checkbox, you define whether the footer section of the Web App is displayed. 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.


Overlay Blurred Background:

With this checkbox, you define whether the background should be blurred 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.


Cookie Consent:

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


image-20250627-072553.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).


⚠️ DEPRECATED

  • Realm

  • Client ID

  • 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-20250627-080656.png

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.

Note:

You can change this flag at runtime using the Web App Configuration Management adapter.


Remove Empty Properties:

With this checkbox, you define whether empty property values are sent from the Web App to the X4 process. That is, this option determines whether, for example, uncompleted fields of a form are passed to the process as properties even without values.

Available options:

  • Checkbox cleared (default): Empty property values are sent from the Web App to the X4 process.

    <?xml version="1.0" encoding="UTF-8"?>
    <Action>
    	<Component>Components/Dashboard.detail</Component>
    	<Firstname>John</Firstname>
    	<Lastname>Doe</Lastname>
    	<Postcode></Postcode>
    	<City></City>
    	<Street></Street>
    	<Houseno></Houseno>
    	<boolean>false</boolean>
    </Action>
    
  • Checkbox selected: Empty property values are not sent to the X4 process.

    <?xml version="1.0" encoding="UTF-8"?>
    <Action>
    	<Component>Components/Dashboard.detail</Component>
    	<Firstname>John</Firstname>
    	<Lastname>Doe</Lastname>
    	<boolean>false</boolean>
    </Action>
    

Data Format:

With this drop-down list, you define which data format is used.

Available options:

  • 1.0

  • 2.0 (default)

Note:

This setting cannot be changed during runtime.


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)


Info-banner process:

In this field, you can enter the path to the.wrf file that defines the data to create an info banner in the Web App The Technical Process must be in the Services/Processes folder.

Note:

The content of the info banner is automatically reloaded every 30 minutes. To manually reload the info banner content, update the Projects view.



image2023-3-9_9-33-32.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.


HTTP Strict Transport Security area :

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.


Enabled:

With this checkbox, you define whether the HTTP Strict Transport Security response header is enabled or disabled.


Include SubDomains:

With this checkbox, you define whether the settings for the HTTP Strict Transport Security response header also applies for the subdomains of the Web App.


Pre-Load:

With this checkbox, you define whether the HTTP Strict Transport Security response header is preloaded.


image2023-3-9_9-34-23.png

Here, you can add the path to files in the project. The file contents are inserted into the HTML head as meta elements.

Note:

The file must be in the Resources directory.