Kitchen Planner URL Parameters

The application can be configured with the help of URL parameters. These parameters can be in the form of query parameters, added to the application's frame URL.

This section describes about the different supported URL parameters.

 

Foreword

Additional to the application distribution settings, the kitchen planner can be configured with some URL parameters that will take the form of query parameters to be added in the planner frame URL (See how to embed the Kitchen planner 🔗 to know what that is).

Example: https://kitchenUrl.by.me/Kitchen/?param1=value1&booleanParam&param3=value3

Note:
These parameters are added in the embedded planner URL.
i.e The iframe src attribute.

Supported Parameters

ln

This parameter will override the default locale set-up in the application distribution parameters.
It must be one of the locales defined in the locales application distribution parameter.

Example: {plannerURL}?ln=en-US

projectId

This parameter is used to load a project, instead of loading the default project.

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 is only used with the projectId, provided in the planner URL(ignored otherwise).

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

kitchenBeta (Pre-Released features)

This parameter is used to launch the planner in beta mode in order to test the pre-released features. The planner will then include 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}?kitchenBeta

disableRecovery

This parameter controls if the recovery feature is active or not, for "not logged-in" users.

When a user is not logged-in and launches the planner, if the local storage contains a backup project (meaning the planner was closed without saving last time), the planner will display a pop-in that proposes to recover the project in cache.

However, if the disableRecovery parameter is given, this pop-in will not be displayed.
For more information, refer recover project.

It is a boolean parameter, no value required.

Example: {plannerURL}?disableRecovery

Note:
This parameter only controls the recovery feature for "not logged-in" users.
If a user launches the planner and is already logged in, the recovery pop-in will always be displayed, if applicable, even if the disableRecovery parameter is provided in the URL.

Afterword

Choosing between several Application Distributions is not performed in the URL, but by Iframe message. The selection is performed by setting the proper distributionID in the Authentication message.