InformationEndpoint

Introduction

The InformationEndpoint module serves branded information or error pages from local web roots. Each configured endpoint can render a template and publish its related static files.

Configuration

Note

Module name: InformationEndpoint

Properties

Name	Description	Default	Mandatory
http_context	Base HTTP context shared by the configured endpoints.	"/infoendpoint"
endpoint	Array of endpoint configuration objects.	[]
endpoint[].context_path	Route mounted below http_context.	""
endpoint[].template	Template rendered at the endpoint root. A relative path is resolved below webroot_dir.	""
endpoint[].webroot_dir	Directory containing the template and static files.	"web/infoendpoint"
endpoint[].overlay_dir	Single overlay directory whose files take precedence over webroot_dir.	""
endpoint[].overlay_dirs	Ordered array of additional overlay directories.	[]

Example

{
  "name": "InformationEndpoint",
  "config": {
    "http_context": "/userinfo",
    "endpoint": [
      {
        "context_path": "/generic",
        "template": "generic_error.html",
        "webroot_dir": "web/infoendpoint",
        "overlay_dir": "web/customer-overlay"
      }
    ]
  }
}

This example redirects /userinfo/generic to /userinfo/generic/, renders web/infoendpoint/generic_error.html at the endpoint root, and serves other files from the web root or overlay.

Caution

Each endpoint must have a unique route. If webroot_dir does not exist, the endpoint is ignored during startup.

Trace ID in templates

Use {{traceid}} in the template to include the request trace ID. The module resolves it in this order:

1. The trace_id query parameter.
2. The current HTTP session's trace ID.
3. The literal value Unknown.

The value is HTML-escaped before it is inserted into the template. Query parameters are preserved when a request is redirected to the trailing-slash URL.

<p>Reference: {{traceid}}</p>

Template responses use Content-Type: text/html; charset=UTF-8 and headers that prevent caching. Files requested directly from the web root are served without template expansion.