OpenWGA 7.10 - OpenWGA Concepts and Features

Design and development » Design configuration » Tab "Design Configuration"

Section "General"

The readonly setting Directory shows the path of the currently opened OpenWGA design directory.
This is followed by three settings which identify some TMLScript scripts that are to be run at special events. All three may address individual TMLScript module files contained in the design directory:

  • The "Initialisation script" is a script that is only called when the design gets connected to an empty OpenWGA Content Store. That is the case when a content stores does contain no Website areas, content types or language definitions. It is one alternative for initializing a new OpenWGA content store which also can be done using schema definitions or an initial content store dump
  • The "Connection script" is a script that is called each time an OpenWGA application using this design gets connected to an OpenWGA server
  • The "Disconnection script" (only available to designs at least developed for OpenWGA 5.1) is a script that is called each time an OpenWGA application using this design gets disconnected from an OpenWGA server (assuming that the OpenWGA server is given the opportunity to actively close the application, which is of course not the case on a hard system shutdown)

All these scripts are executed under master session rights as "non-web" scripts, i.e. they have no access to the WebTML environment. The usable TMLScript functionality matches the one documented for "TMLScript Jobs". It is run under a "dummy context" of the connected application.

Note that all scripts are executed before/after the OpenWGA application gets online. The WebTML context of the application database itself therefor is only only available as default context of the script. Fetching the regarded application by other functionalities, for example via database key, will fail here.

This is followed by two settings which are used to initialize the access control list (ACL) of a connected OpenWGA content store if it is empty (i.e. there are no entries yet). Both may contain an access level for the individual entry to create or "Do not set" to not create this ACL entry.

  • The field "Default access level" creates an entry for name "*" in the ACL, which matches all users of the application without a better matching ACL entry. 
  • The field "Anonymous access level" creates an entry "anonymous" in the ACL, which matches all non-authenticated users.

The setting here called "Version compliance" configures the compliance of this design with OpenWGA versions. The compliance let the OpenWGA server emulate the behaviour of the specified OpenWGA version for your design, no matter what the actual OpenWGA server version is. That way newer OpenWGA versions can provide improved behavious for newer designs while still keeping the old behaviour for old designs and therefor ensuring their functionality. When developing a new design you should always choose the compliance of the current OpenWGA server version that you intend to use for your design.

This setting is followed by another setting "Minimum WGA version", whose effect may not be completely distinguishable from the compliance at first sight. But instead of emulating behaviours this setting directly determines a minimum OpenWGA server version that this design needs to work correctly and therefor influences the features that are available for your design. You can set it to a higher version than the compliance to a) ensure the behaviour for which your design was originally developed but b) allow usage of features from newer OpenWGA versions to which you may have updated your OpenWGA live server. However, this field is disabled if the compliance is lower than "7.0", as older OpenWGA servers do not respect this setting. In that case either the version compliance or the optional plugin configuration determine the minimum WGA version, which is shown in this field for reference.

For plugins this field obsoletes the same "Minimum WGA version" field on the plugin configuration, which is disabled in situations where this new field is in enabled.

The following table shows the implications of the available version compliances and minimun WGA versions in detail. Every documented version includes the implications of earlier versions:

OpenWGA Version As compliance As minimum version
3.x
  • Emulates old WGA 3 behaviours when retrieving nonexistent items and other fields, which frequently returned empty strings
 
4.0
  • New behaviour for retrieving nonexistent items, consistently returning null for single values and empty lists for multiple ones
 
4.1
  • Apps using this design need a content store of at least version 4.1 (optimized file handling)
  • Design shortcuts are available in design configuration
5.0 - 5.1
  • Apps using this design need a content store of version 5
  • HDB API is available on demand, therefor the HDB interface flag in design configuration is implicitly enabled
  • A disconnection script can be defined in design configuration
  • The Java classpath of a libraries can be marked "static" in design configuration, preventing it from being discarded and rebuilt on reconnects
5.2 - 5.5  
  • Design schema is available in design configuration
6.0
  • New handling of files on WebTML forms: Uploaded files survive further POST requests, document file attachments and form files are synchronized
  • New portlet context behaviour: portlet context is cleared on portlet mode change
  • URL parameters are always kept on WebTML action calls
 
6.1
  • URL parameters given to client-side JavaScript functions WGA.action() and WGA.ajax.action() are automatically encoded
 
6.2 - 6.3
  • Uses OpenWGA 6.2 WebTML portlet handling (i.e. "transient portlets") by default
  • Parameters of portlet events can also be of type number/date/boolean, are also transferred to clientside JavaScript in that type
  • WebTML encoder "html" also encodes single quotes
  • WebTML label parameters are also encoded in WebTML default encoding
 
7.0
  • The field "Minimum WGA version" is enabled on the design configuration, allowing to determine the OpenWGA server version needed to use this design separately from the compliance. The same field on the plugin configuration is obsolete and disabled.
  • Encoder mappings, element mappings, media key mappings, job definitions and design shortcuts are additionally available on the design configuration of customization directories
7.1  
  • The flag "Does not need a content store" is available on plugin configuration