Every deployment has its own configuration, the set of runtime settings that control how the deployment and its component deployments behave. You can view and change the configuration in the Control Hub, without redeploying.
Deployment Configuration Basics
A deployment configuration is stored as JSON and consists of three parts. The configuration editor shows all three, so it is worth knowing them before you edit anything:
Initial holds the values the deployment started from. Each project version ships its own initial deployment configuration. The deployment keeps the configuration of the version it was deployed with. The initial deployment configuration is read-only, you cannot edit it.
Active holds the configuration the deployment runs with. It is the result of combining your custom changes with the initial values. You cannot edit it directly, it changes when you apply your custom changes.
Custom Changes displays the values that you set on top of the initial deployment configuration. This is the only part you can edit.
Each deployment has its own configuration. A change to the configuration of a deployment does not affect other deployments, not even another deployment of the same project.
Your custom changes belong to the deployment, not to the project version. When you deploy a project again, the new deployment starts from the baseline of the version you deploy and contains no custom changes. Changes you made to an earlier deployment are not carried over (refer to Redeploying or Changing the Version).
Editing Configuration
Configuration exists at two levels:
-
Project-level configuration applies to the project deployment.
-
Component-level configuration applies to a single component deployment.
Expert Advice on Configuration
-
You should define references and important values/variables in the code rather than in the Control Hub configuration editor.
-
Use the Control Hub configuration editor if you want to override existing values or set specific new values for a deployment, for example for debugging purposes.
You can edit the configuration of a deployment in the configuration editor. The editor opens in the window on the right of the deployment detail page and works the same way for project-level and component-level configuration.
Adding Custom Changes does not change the active deployment until you apply your changes.
Opening the Configuration Editor
Where you open the editor depends on the level you want to edit:
-
Project deployment configuration: Open the deployment detail page and select Project configuration in the deployment panel. The editor opens in the window on the right.
Expert Advice
Use the project configuration editor to maintain values that are applicable to the entire project. You will then be able to easily reference these values when configuring the individual components with $references.
-
Component deployment configuration: Select the component in the deployment panel, then open its Configuration tab in the component deployment detail view.
For more information on the deployment details, refer to Working With the Deployment Detail Page.
Working With the Configuration Editor
The configuration editor shows all three parts of a deployment configuration in the following order: Custom Changes, Active and Initial (see above).
A toolbar at the top holds the actions, the editor below shows the configuration:
Custom Changes
Custom Changes displays the values that you set on top of the initial deployment configuration. This is the only part you can edit.
Custom changes survive a project update!
When you push a project again, custom changes are always preserved and merged with the new default values.
|
UI Element |
Description |
|---|---|
|
Wrap long values |
Use this option to enable wrapping of long values. Click again to disable soft wrapping. |
|
Format JSON: 2-space indent |
Use this option to apply 2-space indent formatting to the editor’s content. The option is disabled if your content already uses this format. |
|
Discard |
Use this option to discard your edits in the Custom Changes editor. |
|
Apply |
Use this option to apply your changes. Your changes will be merged with the contents in the Initial tab. The result is then displayed in tab Active. If applying fails, the editor shows an error message and keeps your changes, so you can correct them and try again. |
Active and Initial
Active holds the configuration the deployment runs with. It is the result of combining your custom changes with the initial values. You cannot edit it directly, it changes when you apply your custom changes.
Initial holds the values the deployment started from. The initial deployment configuration is read-only, you cannot edit it.
Since the content of both tabs is not editable, you have only two options:
|
UI Element |
Description |
|---|---|
|
Tab toggle |
Use the toggle button to switch between the Active and the Initial view. |
|
Wrap long values |
Use this option to enable wrapping of long values. Click again to disable soft wrapping. |
If the configuration cannot be loaded, both editors are empty and read-only, and the reason is shown below the text, in place of the unsaved-changes status. All three parts are loaded together, so one failure concerns all of them and there is nothing to edit until the configuration loads. Refer to Error Handling Deployments for the error messages and how to resolve them.
Maximizing the Editor
To give yourself more room, select the maximize button in the corner of the editor to expand it to fill the window. Select the button again to restore the editor to its normal size.
