The file PageRegistration\registration,json
contains a list of composite paths/regions to register automatically with the composite shell.
The full models for each are available in confluence:
The following are examples of how to register common items
To register a page, you can add the following to the json file:
{
"Path": "pathName",
"TopNavigationText": "path Title",
"TopNavigationOrder": 400,
"Layout": 1,
"OfflineHtml": "<div class=\"govuk-width-container\"><H2>Job Profile Service Unavailable</H2></div>",
"PhaseBannerHtml": "<div class=\"govuk-phase-banner\">banner html</div>",
"SitemapUrl": "<url to sitemap>",
"RobotsUrl": "<url to robots.txt>",
"Regions": [
{
"PageRegion": 1,
"RegionEndpoint": "regionEndpoint"
},
{
"PageRegion": 4,
"RegionEndpoint": "regionEndpoint"
}
]
}
To register an external path, you can use the following example:
{
"Path": "externalPathName",
"TopNavigationText": "Path Title",
"TopNavigationOrder": 705,
"Layout": 0,
"OfflineHtml": "<div class=\"govuk-width-container\"><H2>External App is Unavailable</H2></div>",
"ExternalUrl": "external path url"
}