Kitchen Planner URL Parameters
The application can be configured for a specific runtime experience using URL query parameters added.
This section lists all supported URL parameters.
Foreword
Additional to the application distribution settings, the kitchen planner can be configured with URL query parameters to be added in the planner frame URL (See how to embed the Kitchen planner 🔗).
Example: https://kitchenUrl.by.me/Kitchen/?param1=value1&booleanParam¶m3=value3
Note: these parameters have to be added to the embedded planner URL, i.e the iframe src attribute.
Supported Parameters
ln
This parameter overrides the default locale set-up in the application distribution parameters (See the locales Application Distribution parameter 🔗).
If this URL parameter is not set, the planner uses the default locale set-up in the application distribution parameters.
Note: the
ln
parameter must correspond to thename
of one of the defined locales from thelocales
application distribution parameter.
Example: {plannerURL}?ln=en-US
currency
This parameter defines the currency to use in the application. If set, it must be one of the currency codes defined in the application distribution parameters (See the currencies Application Distribution parameter 🔗).
If this URL parameter is not set, the planner uses the locale-currency configuration to determine which currency to use (see GET /applications/{id}/currencylocales/{locale} 🔗).
Example: {plannerURL}?currency=EUR
projectId
This parameter is used to load a project, instead of loading the default project.
If this URL parameter is not set, the planner loads the default project instead.
Example: {plannerURL}?projectId=xxxx-yyyy-zzzz
HQRDbID
This parameter is used to open the planner with the point of view of an HQ rendering when its project is loaded. It must be used along with the projectId
URL parameter (ignored otherwise).
Note: the
HQRDbID
parameter must correspond to a valid HQ rendering ID that belongs to theprojectId
used.
Example: {plannerURL}?projectId=xxxx-yyyy-zzzz&HQRDbID=12345
mode
This parameter is used to launch the planner in a particular mode. Here is the list of supported modes.
Mode | Description |
---|---|
DefaultProjectCreation | Use this mode to create and configure default projects |
For more information, refer create default project 🔗.
Example: {plannerURL}?mode=DefaultProjectCreation
appBeta
This parameter is used to launch the planner in beta mode in order to test the pre-released features. In this mode, the planner includes additional features that are ready for test before their integration in the Kitchen standard product.
This is a boolean parameter, no value required.
Example: {plannerURL}?appBeta
disableRecovery
This parameter controls if the recovery feature is active or not, for "not logged-in" users.
By default, the planner displays a pop-in at startup that proposes to recover the project from the cache if it finds one (meaning the planner was closed without saving last time).
However if the disableRecovery
parameter is set, this pop-in is not displayed in the case of not logged-in users only.
Note: if an already logged-in user launches the planner and the planner finds an unsaved project in cache, the recovery pop-in will always be displayed, even if the
disableRecovery
parameter is provided in the URL. This parameter only controls the workflow for not logged-in users.
For more information, refer recover project.
It is a boolean parameter, no value required.
Example: {plannerURL}?disableRecovery