UI Builder header, menu and footer JSON documentation (Washington DC)?
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
09-18-2024 12:14 PM
I'm looking into ways to customize a portal created in UI Builder, but I can't find any documentation on how to configure the JSON objects I have to pass. To be clear, I'm talking about these settings:
For example, the header must be a register named chrome_header in the table sys_ux_page_property which is referenced in the experience register at sys_ux_page_registry. The chrome_header register accepts a JSON like this:
{
"privatePage": {
"searchEnabled": true,
"userPrefsEnabled": true,
"currentScreenLinkConfiguration": {
"roles": [
"admin"
],
"position": 250
},
"globalTools": {
"collapsingMenuId": 0,
"primaryItems": [
{
"label": "UserMenu",
"icon": "user",
"type": "menu",
"primaryDisplay": "icon",
"value": {
"children": [
{
"label": {
"translatable": true,
"message": "Settings"
},
"position": 100,
"type": "navigation",
"value": {
"type": "route",
"value": {
"route": "settings",
"fields": {}
}
}
},
{
"condition": {
"roles": [
"admin",
"ui_builder_admin"
]
},
"label": {
"translatable": true,
"message": "Configure"
},
"type": "navigation",
"position": 200,
"primaryDisplay": "none",
"value": {
"type": "external",
"opensWindow": "true",
"value": {
"href": "/nav_to.do?uri=/sys_ux_app_config.do?sys_id=c902e86583a01210961971a6feaad329"
}
}
},
{
"label": {
"translatable": true,
"message": "Logout"
},
"position": 500,
"type": "navigation",
"value": {
"type": "AUTH_ROUTE_BINDING",
"binding": {
"address": [
"logout"
],
"params": {
"reload": true
},
"default": "/logout.do"
}
}
}
]
}
}
],
"secondaryItems": []
}
},
"publicPage": {
"menuEnabled": true,
"logoRoute": {
"type": "route",
"value": {
"route": "landing",
"fields": {}
}
}
}
}
I can't find any documention about what properties belong to this JSON nor what kind of values each property accepts. There's no documentation on any one of the elements, header, menu or footer. Also, there seems to be other UX Page Properties that fly completely under the radar like the ones highlighted below:
How many of these UX Page Properties are there? What are their functions on a UI Builder page? How do I configure them?