OpenAthens LA support ended on 31 March 2020

Search

Skip to end of metadata
Go to start of metadata

OpenAthens LA provides default styles for all the pages that end-users of the application see.

  • login page – where users are required to authenticate.
  • logout page – the landing page which users see after logging out.
  • sso page – this is the page that will be visited after login. It is normally transitional and the user will be forwarded to the Service Provider. If there is a problem, e.g. there is no Service Provider to respond to, a message will be displayed.
  • sso-debug page – a debug page which displays attribute information.

It is possible to fully customise the look-and-feel of these pages to integrate with other applications. The default pages use standard Apache Server-side includes (SSI). This method is used because it will work on any Apache server, without additional modules however login pages can easily be adapted to work with PHP or other scripting languages.

The pages can be found on the runtime server in:

/var/openathens/www/idp/oala

For each of these pages, a number of variables are written to the Apache environment. These are available to template/scripting languages (e.g. SSI, PHP etc) for customisation of the user interface.

All pages

The following variables are available to all pages

Variable Name

Description

OA_PRODUCT_NAME

The name and version of the OpenAthens LA product

OA_ORGANISATION_NAME

The organisation name, as defined in the configuration in the Administration Console

OA_APP_PATH

The prefix for the application path (default: /oala)

OA_ERROR_MESSAGE

A human-readable error message, if an error occurred (may be empty)

OA_ERROR_CODE

A short error-code, if an error occurred (may be empty)

There are also some standard variables associated with SSI and Apache that are available.

Login page

The following additional variables are available to the login page

Variable Name

Description

OA_ERROR_USER

The last username entered by the user in the case of a failed login (may be empty)

Single Sign-On page

The following additional variables are available to the Single Sign-On page after login.

Variable Name

Description

OA_USER

The username of the logged in user

OA_SP_DISPLAY_NAME

A human-readable name of the Service Provider that the response is intended for

OA_DESTINATION

The URL of the Service Provider that the response is to be sent to

OA_DISPLAY_ATTRIBUTES

A formatted list of attribute names and values to be sent to the Service Provider

The following attributes are necessary for the operation of OpenAthens LA. They should be used as defined in the standard templates. Any customised page, should include them.

Variable Name

Description

OA_RESPONSE

The value of the response document to be sent to the Service Provider (may be empty)

OA_ARTIFACT

The value of the SAML artifact to be sent to the Service Provider (may be empty)

OA_RELAYSTATE

The value of the SAML relay-state in the request from the Service Provider (may be empty)

Favicons

If you want to add a favicon to your login / logout / sso pages, upload a suitably sized icon as:

/var/openathens/www/idp/favicon.ico

The service desk can only support our product and not any code you add or modify yourself