About

Module for custom information messages to end user where UI customisations are desired. Typically used un logout and error messages.

InformationEndpoint module acts a simple http endpoint. Basic configuration is inherited by common http module properties.

When trace id is desired in information to end user, template is required. By using ${trace_id} in template it will expand to the session trace id.

Module name: InformationEndpoint

Properties

Name	Description	Mandatory	Default
http_context	First part of the url exposed.		/infoendpoint
http_port	HTTP server port		8080
endpoint	Array of custom endpoints
endpoint.context_path	Last part of the URI exposed.
template	Name of template to use when accessing http_context+endpoint.context_path. If omitted 404 will be returned.
webroot_dir	Where to look for files other than template. js, html etc.		web/infoendpoint
overlay_dir	Location for additional overlay files.		N/A

Example

{
    "name": "InformationEndpoint",
    "config": {
        "http_context": "/userinfo",
        "http_port": "8090",
        "endpoint": [
            {
                "context_path": "/generic",
                "template": "generic_error.template",
                "overlay_dir": "web/overlay_test"
            }
        ]
    }
}

Example config is accessible on /userinfo/generic. This will render configured template. Files located in the webroot_dir is accessed by name.

Sharing http_context with other modules is mandatory for expanding shared trace_id.

Configuring identical paths as other module will render non deterministic behaviour.