Skip to main content

How to create and use App Settings

Distributor guide to App Settings in Encompass: what they are, how to add one to an app in App Manager, and how to use {setting_####} in Fusion Reports. Requires v23.02+.

B
Written by Bailey Naas-Thornton

Minimum Version Required: 23.02

Steps

What is an App Setting?
​
​

An App Setting is a value attached to an app that can be set independently for each site and dynamically referenced. They allow the user who is installing an app on their site to customize certain values that the app will use.
​
​

For example, the Security Automation: Deactivate Users After Inactivity app has an App Setting for "number of days inactive before users are deactivated". When a user installs the app, they will be asked to fill in this value. Then, the App Setting is used in reports and dynamically pulls the value for each site and inactivate users accordinly.

How does it work?
​
​

- App Settings are created under an app.
​
​

- When a user installs the app, they will enter in values for each required App Setting.
​
​

- Once installed, the values are stored in the site's Settings table.

How to create an App Setting:


1. Go to App Manager dashboard by searching "App Manager" in the Universal search bar.
​
2. Search for the app.
​
3. Select the App Settings tab.
​
4. Click the Add button

How to reference an App Setting in a Fusion Report:


1. To use Application Settings in Fusion Reports, enter the following: {setting_####} where #### is the Application Setting ID
​
Note:
Users do NOT need to join in the Settings Table. This is very similar to how variables are used, the system will automatically replace the syntax above with the value of the Setting.

Did this answer your question?