GAS 3.21 upgrade guide

These topics describe product changes you must be aware of when upgrading to version 3.21.

Important:

This incremental upgrade guide covers only topics related to the Genero Application Server (GAS) version specified in the page title. Check prior upgrade guides if you migrate from an earlier version, and complete the migration tasks for all versions between your existing version and the target version, in order. Make sure to also read about the new features for this version.

Corresponding new features page: GAS 3.21 new features.

Previous upgrade guide: GAS 3.20 upgrade guide

Required GAS versions for GDC 5.01.02 and later

Important:

Starting with GDC 5.01.02, GDC may send HTTP headers in any letter case (for example: X-Custom-Header, x-custom-header, X-CUSTOM-HEADER).

  • To ensure correct header handling, you must run one of the following GAS releases when using GDC 5.01.02 or newer:
    • GAS 3.21.03
    • GAS 4.01.07
    • GAS 5.01.03
  • If you do not upgrade to one of the versions above, header processing may fail, causing unexpected behavior in applications that rely on HTTP headers.

Argument added to gasadmin gar --list-archives command

Starting from GAS 3.21.02, GAS 4.01.07, and GAS 5.00.02, the gasadmin gar --list-archives command is enhanced to take an argument with options to display information for the deployed archives you specify. Previous to this, the command displayed information for all archives deployed on the GAS.

For more information see gasadmin.

Argument added to gasadmin gar --clean-archives command

Starting from GAS 3.21.02, GAS 4.01.07, and GAS 5.00.02, the gasadmin gar --clean-archives command is enhanced to take an argument with options to specify the undeployed archives you want removed. Previous to this, the command cleaned/removed all undeployed archives on the GAS.

For more information see gasadmin.

Changes to gasadmin gar --list-archives command output

Starting from GAS 3.21.02, GAS 4.01.07, and GAS 5.00.02, the gasadmin gar --list-archives command has enhancements to the output listing applications and services available in the GAS. The layout of the display has been improved for better readability.

For more information, go to List deployed archives.

Changes to the OpenIDConnect service configuration

Starting from GAS and FGLGWS versions 3.21.02, 4.01.07, and 5.00.02, two parameters of the Genero OpenIDConnect service configuration ($FGLDIR\web_utilities\services\openid-connect\res\configuration) have changes:

  • The oidc.logout.id_token_hint parameter, used in the logout request sent to the provider, has been replaced by oidc.logout.identifier. The new parameter supports the values "id_token_hint", "client_id", or an empty (" ") value. The default value is "id_token_hint".
  • The oidc.logout.post_redirect parameter, used to send the post redirect uri in the logout request, now needs a string value instead of the boolean value true/false on previous versions. The default value is now "post_logout_redirect_uri".

No action needs to be taken on your part, but if you have previously used a custom OpenIDConnect configuration file and you want to use it when upgrading FGLGWS version, ensure that you review your configuration for these parameters.

For more information on OpenID Connect Single sign-on, go to OpenID Connect/OAuth2 SSO.

New option to list session ids in the gasadmin session command

Starting from GAS 3.21.02, GAS 4.01.07, and GAS 5.00.02, the gasadmin session command has been enhanced with an option, --list-session-ids, to output just a list of identifiers of the active sessions. No proxy details are output, such as the names of the applications or services, as in the output from the gasadmin session --list-sessions command.

For more information on gasadmin session commands and examples, go to gasadmin.

New option to count sessions in the gasadmin session command

Starting from GAS 3.21.02, GAS 4.01.07, and GAS 5.00.02, the gasadmin session command has been enhanced with an option, --count-sessions, to return a count of the number of active sessions (applications and services).

For more information on gasadmin session commands and examples, go to gasadmin.

New option in the gasadmin gar command to return the deployment path of an archive

Starting from GAS 3.21.02, GAS 4.01.07, and GAS 5.00.02, the gasadmin gar command has been enhanced with an option, --archive-deployment-path, to return the deployment path of a gar file deployed on the GAS.

For more information on gasadmin gar commands and examples, go to gasadmin.

Changes to the IIS server configuration for authentication

Starting from GAS 3.21.02, GAS 4.01.07, and GAS 5.00.02, it is recommended that you set the Manage Pipeline mode application pool setting to "Integrated" instead of "Classic". Where previously you used "classic", and now your application relies on an authentication token passed from IIS to the runtime, you may find this process breaks your application. This is due to the new architecture in IIS (introduced in IIS 7), which works in an integrated way with different IIS modules.

By setting to "Integrated", now the IIS will switch context to whatever IIS and ASP.NET modules it needs to call to handle application requests. However, be sure to test your existing applications for compatibility in Integrated mode before upgrading application pools in a production environment to Integrated mode.

For more information on IIS configuration, go to Create application pool. For more information on Microsoft® recommendations for use of integrated mode, refer to Learn IIS.

Autologout timeout resource

Starting with GAS 3.21.02, GAS 4.01.07, and GAS 5.01.02, the app.timeout.autologout resource lets you set the autologout timeout based on when the GAS detects that there has been no user activity in the application, right up until the application receives a logout message.

By default, the app.timeout.autologout value is set to "0", which means that auto logout is disabled and applications will continue to run.

In the past, you might have set the TIMEOUT directly, but now you can use this resource in the as.xcf file to set the timeout or to override the default value from the command line when starting the dispatcher.

For more information and examples setting the TIMEOUT, go to TIMEOUT (for auto logout).

New resource added for GIP StarterApp access

Starting with FGLGWS versions 3.21.04, 4.01.10, and 5.01.06, you can update the res.gip.access.control resource from NOBODY to ALL to grant access to the StarterApp. This resource is defined in the GAS configuration file (as.xcf).

After setting up the GIP, remember to reset the resource back to NOBODY to restrict access and prevent users from running the StarterApp. In production, ensure that the resource is also set to NOBODY for the same reason.

For more details about methods to configure access for the StarterApp, go to Setting up the Genero Identity Provider. For more information on using the resource, refer to the ACCESS_CONTROLpage.

Changes in earlier versions

Make sure to check the upgrade notes of earlier versions, to not miss changes introduced in maintenance releases. For more details, see GAS 3.20 upgrade guide.