Use settings to provide customized app experiences

Article
03/13/2023

Settings are solution components that enable makers and administrators to quickly configure apps to provide a customized experience. Settings can be used to enable or disable features or configure feature behavior for a single app or all apps within an environment.

Settings are made up of three subcomponents: Setting definition, setting environment value, and setting app value.

Subcomponent	Description
Setting definition	Application authors, administrators, or partners can create a setting definition that includes properties such as name, description, data type, default value, and more. They can then, via code, use the setting’s value to enable or disable or configure the feature they are delivering. They can include the setting definition in the solution that is used to deliver the feature to their customers. Example: The Async save handler for model-driven apps is a feature from Power Apps that uses settings. The setting is of type Yes/No and the default value of this setting is No. Therefore, by default, the Async save handler feature will be disabled for all model-driven apps.
Setting environment value	A setting environment value can be used to override the default value, as specified in the setting definition. Example: Extending the example above, an environment administrator in a customer’s organization can add a setting environment value for the Async save handler setting and set it to Yes. This setting environment value will override the default value and will apply to all apps in that environment. This will enable the Async save handler feature for all model-driven apps in that environment.
Setting app value	A setting app value can be used to override the default value, as specified in the setting definition, and the setting environment value (if one exists). Example: Once again, extending the example above, an application author in the same environment above, can add a setting app value for the Async save handler setting for an app they are authoring and set it to No This setting app value will override the setting environment value and apply only to that single app. This will enable the Async save handler feature for that single app.

Note

To follow the steps listed below you need to have Solution preview on. From the Solutions area in Power Apps, on the command bar, ensure you have Solution preview on. If Solution preview off is displayed, select the option to enable the preview. More information: Solution view

Setting definition

A setting definition specifies the base properties of a setting. The full list of properties that can be configured on a setting definition are listed below. Some of these properties can't be changed after the setting is created.

Property	Description
Display name	The name displayed to consumers of the setting in all user interfaces where settings are displayed.
Name	The unique name of the setting in an environment. Name is automatically generated based on the display name provided but can be changed before the setting is created. Once a setting is created, the Name can't be changed as it may be referenced in applications or code. Name has a prefix that corresponds to the solution publisher. This prefix is intended to give the setting a unique name if you want to import them into another solution or environment in the future (which would have a different prefix).
Description	The description helps others understand what the setting is used for in all user interfaces where settings are displayed.
Data type	The data type of a setting controls how the setting’s value is stored. Data type can be set to Number, String, or Yes/No. Data type can't be changed after the setting is created.
Default value	The default value becomes available after you select a Data type. It specifies the setting's value that will be used unless it is overridden by a setting environment value or a setting app value.
Value can be changed for	A setting can be overridden at one of the following levels : Environment and app, allows both the setting environment value and setting app values to override the default value. Environment only, allows only the setting environment value to override the default value. App only, allows only setting app values to override the default value. None, the setting can’t be overridden.
Release level	Release level is used to inform the framework and other consumers of the setting about the state of the feature that the setting is used with. Release level can be set to Generally available or Preview.
Information Url	A link to documentation to help consumers of the setting understand the purpose of the setting. Will be used as a Learn more link in all user interfaces where settings are displayed.

Adding a new setting definition

Sign in to Power Apps.
In the navigation pane, select Solutions. If the item isn’t in the side panel pane, select …More and then select the item you want.
From the list of solutions, open the solution you want to add the setting to.
In the command bar, select New > More > Setting > Setting definition.
In the New setting dialog, provide values for each of the properties based on your requirements. For information about setting definition properties, go to: Setting definition
When you are done providing values for the properties, select Save.

Adding an existing setting definition

Sign in to Power Apps.
In the navigation pane, select Solutions. If the item isn’t in the side panel pane, select …More and then select the item you want.
From the list of solutions, open the solution you want to add the setting to.
In the command bar, select Add existing > More > Setting.
In the Add existing setting definition dialog, select one or more settings that you want to add.
When you are done selecting settings, select Next
In the Selected setting definition dialog, for each setting you have selected, you will have the option to Include setting definition. You can also Include setting environment value for each setting, if one exists.
Select Add to add the setting definition and/or setting environment values.

Updating a setting definition

Sign in to Power Apps.
In the navigation pane, select Solutions. If the item isn’t in the side panel pane, select …More and then select the item you want.
From the list of solutions, open the solution you created the setting in.
In the tree view, select Settings > Setting definitions.
Select the setting definition that you want to update.
In the Edit setting dialog, update values for any of the properties you want to change.
Note that some properties can't be updated after a setting has been created. Additionally, in most cases you will not be able to update settings definitions that you don't own.
When you are done updating the values for the properties, select Save.

Removing a setting definition

Sign in to Power Apps.
In the navigation pane, select Solutions. If the item isn’t in the side panel pane, select …More and then select the item you want.
From the list of solutions, open the solution you created or added the setting to.
In the tree view, select Settings > Setting definitions.
Select the setting definition you want to remove.
In the command bar, select Remove > Remove from this solution.
Remove from this solution removes the setting definition from the current solution, but it will continue to be a part of the default solution or any other solution it was added to.

Deleting a setting definition

Sign in to Power Apps.
In the navigation pane, select Solutions. If the item isn’t in the side panel pane, select …More and then select the item you want.
From the list of solutions, open the solution you created or added the setting to.
In the tree view, select Settings > Setting definitions.
Select the setting definition you want to delete.
In the command bar, select Remove > Delete from this environment.
Delete from this environment deletes the setting definition from the current environment and it will no longer be a part of any solutions in that environment. You can only delete setting definitions that you own.

Setting environment value

A setting environment value is used to override the setting's default value for all apps in an environment. Use a setting environment value when the setting's default value is not what you want to be used for apps in your environment.

Adding a new setting environment value

Sign in to Power Apps.
In the navigation pane, select Solutions. If the item isn’t in the side panel pane, select …More and then select the item you want.
From the list of solutions, open the solution you want to add the setting environment value to.
If the setting definition is available in the solution:
1. Select the setting definition.
2. In the Edit setting value dialog, in the Setting environment value section, select New value.
3. Provide the value, and then select Save.
If the setting definition is not available in the solution:
1. On the command bar, select New > More > Setting > Setting environment value.
2. Select the setting you want to add the setting environment value for, and then select Add.
3. In the New setting environment value dialog, in the Setting environment value section, select New value.
4. Provide the value, and then select Save.

Adding an existing setting environment value

Sign in to Power Apps.
In the navigation pane, select Solutions. If the item isn’t in the side panel pane, select …More and then select the item you want.
From the list of solutions, open the solution you want to add the setting environment value to.
If the setting definition is available in the solution:
1. Select the setting definition.
2. In the Edit setting value dialog, in the Setting environment value section, select Add existing value.
3. Update the value if needed, and then select Save.
If the setting definition is not available in the solution:
1. On the command bar, select Add existing > More > Setting.
2. In the Add existing setting definition dialog, select one or more settings that you want to add setting environment values for.
3. When you are done selecting settings, select Next
4. In the Selected setting definition dialog, for each setting you have selected, you will have the option to Include setting environment value, if one exists. You can also Include setting definition for each setting if you want.
5. Select Add to add the setting environment values and/or setting definitions.

Updating a setting environment value

Sign in to Power Apps.
In the navigation pane, select Solutions. If the item isn’t in the side panel pane, select …More and then select the item you want.
From the list of solutions, open the solution you added the settings environment value to.
In the tree view, select Settings > Setting environment values.
Select the setting environment value that you want to update.
In the Edit setting dialog, in the Setting environment value section, update the value, and then select Save.

Removing a setting environment value

Sign in to Power Apps.
In the navigation pane, select Solutions. If the item isn’t in the side panel pane, select …More and then select the item you want.
From the list of solutions, open the solution you created or added the setting to.
In the tree view, select Settings > Setting environment values.
Select the setting environment value you want to remove.
On the command bar, select Remove > Remove from this solution.
Remove from this solution removes the setting environment value from the current solution but it will continue to be a part of the default solution or any other solution it was added to.

Deleting a setting environment value

Sign in to Power Apps.
In the navigation pane, select Solutions. If the item isn’t in the side panel pane, select …More and then select the item you want.
From the list of solutions, open the solution you created or added the setting to.
In the tree view, select Settings > Setting environment values.
Select the setting environment value you want to delete.
On the command bar, select Remove > Delete from this environment.
Delete from this environment deletes the setting environment value from the current environment and it will no longer be a part of any solutions in that environment.

Setting app value

Setting app value is used to override the setting's default value and any setting environment value for a single app. Use a setting app value when the setting environment value is not what you want to be used for your app. If a setting environment value does not exist, use a setting app value when the setting's default value is not what you want to be used for your app.

Note

To follow the steps listed below you need to use the new app designer. Currently the app designer only displays Power Apps platform settings. For non-platform settings please use the solution explorer as outlined below.

Adding or updating a setting app value using the app designer

Open the app you want to add the setting app value for in the app designer.
On the command bar, select Settings.
In the Settings dialog, select the Features or Upcoming tab.
The Features tab displays all settings that have release level set to Generally available. The Upcoming tab displays all settings that have release level set to Preview.
Add or update an app value for the setting you want.
Save and publish the app.

Deleting a setting app value using the app designer

Open the app you want to remove the setting app value for in the app designer.
On the command bar, select Settings.
In the Settings dialog, select the Features or Upcoming tab.
Select Reset to environment value next to the setting app value you want to delete. This makes the setting value fall back to the setting environment value if one exists. If no setting environment value exists, it will fall back to the setting's default value.
Note that the option to Reset to environment value is only displayed if a setting app value was previously added for that setting.
Save and publish the app.

Adding or updating a setting app value using the solution explorer

Sign in to Power Apps.
In the navigation pane, select Solutions. If the item isn’t in the side panel pane, select …More and then select the item you want.
From the list of solutions, open the solution you want to add the setting app value to.
If the setting definition or setting environment value is not available in the solution, add one of them. Go to Adding an existing setting definition or Adding an existing setting environment value.
Select the setting definition or setting environment value.
In the Edit setting value dialog, in the Setting app values section, find the app that you want to add the setting app value for. Note that using the solution explorer you can only add setting app values for apps that are in the current solution.
Provide the value and select Save.
For the setting app value to take effect you will have to republish the app using the app designer or solution explorer.

Deleting a setting app value using the solution explorer

Sign in to Power Apps.
In the navigation pane, select Solutions. If the item isn’t in the side panel pane, select …More and then select the item you want.
From the list of solutions, open the solution you want to delete the setting app value from.
If the setting definition or setting environment value is not available in the solution, add one of them. More information: Adding an existing setting definition or Adding an existing setting environment value.
Select the setting definition or setting environment value.
In the Edit setting value dialog, in the Setting app values section, find the app that you want to delete the setting app value for. Note that using the solution explorer you can only remove setting app values for apps that are in the current solution.
Select ... next to the setting app value, and then select Reset to environment.
Select Save.
For the deletion of the setting app value to take effect you will have to republish the app using the app designer or solution explorer.

Getting or updating a setting value via code

For the methods available, go to Get or update a setting value using client API.