FAQs
This is a BETA feature and, as such, is currently under active development. Pay attention using this section.
Components
How can I add a new page to and show it in the navigation menu?
The information regarding the menu are valid only if you are using the
bk-layout
component.
The first step to add a new page to your Backoffice is to create it the Pages tab of the Configurator.
Once the page has been spawned, you can move to the Layout tab to connect it to the navigation menu. In the left drawer select the component named Layout, and in the right form locate the Menu Items property.
Click the Edit property button and in the modal that pops up click the Add item button to insert a new voice in the menu. The click will spawn a new Edit item button.
One clicked, a code editor will appear in the modal for you to write the item configuration. Remember that the id must match the identifier of your newly created page.
Once you have done, click the Save button. The modal will close, and the new item will appear in the menu.
How can I add a new column to a table?
This information are valid only if you are using the
bk-table
component.
Columns of the table are defined by it's
dataSchema
property. To edit
it you first need to open the configuration of the compose page of your choice. Now you need to select the Table
component in the left menu (if you are starting from a template, it usually located under the Main component) and click the Edit property button of the Data schema property in the right menu.
A modal will open with a code editor you can use to edit the property. Now you just need to add a new entry to the
properties
object as explained in the
official documentation.
Once you have done, click the Save button. The modal will close, and the table will display the new column.
Infrastructure
How can I change the route under which the Backoffice is exposed?
When starting from the application (whether it is the
classic one or the
on prem one), the Backoffice is exposed
under /backoffice
. The steps to change this endpoint are the following.
- Delete
/backoffice
endpoint and create the new one, which must have Rewrite Base Path set to/public
. - Open the Configurator, and navigate to the Webserver Configuration tab.
- Under Entry point section you need to modify
index.html
<base>
tag setting thehref
attribute to the newly created endpoint. Remember to always put a trailing/
(i.e.,/my-new-endpoint/
). - Under Headers section, change the
/backoffice/assets/style.css
link (and any other preload link you might have added) substituting/backoffice
with your new endpoint.
- Under Entry point section you need to modify
How can I change the route under which Backoffice configurations are exposed?
When starting from the application (whether it is the
classic one or the
on prem one), Backoffice configuration
files are exposed under /micro-lc-configurations
. The steps to change this endpoint are the following.
- Delete
/micro-lc-configurations
endpoint and create the new one, which must have Rewrite Base Path set to/configurations
. - Open the Configurator, and navigate to the Webserver Configuration tab.
- Under Entry point section you need to modify the value of
config-src
attribute ofmicro-lc
web component substituting/micro-lc-configurations
with your new endpoint. - Under Headers section, change the
/micro-lc-configurations/config.json
link (and any other preload link you might have added) substituting/micro-lc-configurations
with your new endpoint.
- Under Entry point section you need to modify the value of
How can I serve a static file through the Backoffice webserver?
When starting from the application (whether it is the
classic one or the
on prem one), all the Backoffice related
resources are served by a single service, called micro-lc
.
This service comes with four config maps, three of which are readonly and editable only thought the Configurator. The
fourth one, micro-lc-assets
, instead is open and it's content is exposed under /backoffice/assets
(unless you
have changed the endpoint), which means the the
service will serve any file you mount in this directory.
Content types and response headers can be controlled in the Webserver Configuration section of the Configurator (read the full documentation).
How can I improve Backoffice loading performance?
Backoffice loading performance can be improved (al least on some browsers) setting
the right preload
and
modulepreload
links in the headers
of the entrypoint.
This can be done in the Headers section of the Webserver Configuration tab of the Configurator (read the full documentation). When starting from an application, some useful links are already in place, but you can always add more to cover the specific static resources used by your Backoffice implementation.