Deploying AppGrid - best practices

Mar 27, 2025

When deploying AppGrid, we want to ensure that the user experience delivered for new users is optimized for their role and workflows. That experience is governed by 3 factors:

  1. Salesforce metadata and permissions

  2. AppGrid grid permissions

  3. AppGrid preferences

It is important that the user who is deploying AppGrid has a thorough understanding of all the features AppGrid provides and how to use the application.

AppGrid provides a Salesforce permission set that should be assigned to each user prior to deployment. You can use this or create your own permission set if more customization is required. This ensures that the user will have access to the AppGrid custom objects that are required for AppGrid operation. Prior to performing the deployment process described below, assign the permission set to all users that will be using AppGrid.

AppGrid has various grid permissions that control what features are enabled for a given user. We want to tailor these settings for the type of user who will be using AppGrid. If no grid permission preferences have been defined, by default all grid permissions will be enabled.

AppGrid grid permissions allow great flexibility when creating applications. We could create an AppGrid application that we want to provide for customers or partners, and want that app to be simple to use and restricted in what features we provide. Conversely, we may want to enable all AppGrid features for power users or system administrators.

AppGrid preferences are metadata that effect the grid state. As a user interacts with the app, the grid state will be saved into the following preferences:

  • Object Preferences - controls what objects are displayed in the AppGrid object selector

  • Relation Preferences - controls what sub-grids are displayed for a given object

  • View Preferences - controls what predefined views are displayed in the view selector for a given object.

  • Query Preferences - controls what predefined queries are displayed in the query selector

  • Chart Preferences - controls what predefined charts are displayed in the chart selector

  • Flow Preferences - controls what predefined flows will be displayed in the flow selector for a given object

  • Treegrid Preferences - controls the tree grid settings needed for rendering the tree grid

  • Timeseries Preferences - controls the time series grid settings needed for rendering the time series grid

  • GridTemplate Preferences - controls what predefined grid templates are shown in the grid template selector in the deployment panel

By predefining the grid preferences for a given user, we ensure that the initial user experience is optimal and users can execute their workflows immediately without creating any additional preferences.

Deployment Process

Let's assume we are deploying AppGrid for 2 different types of users - Sales and Customer Service. At a high level, what we are going to do is have a system administrator use the app to configure the preferences that a given user type will require, and then create a AppGrid template from those preferences. We will then assign that template to each user of that type. This is analogous to creating a profile in Salesforce.

  1. Using the Salesforce Login-As feature, a System Administrator logs in to a user account for a given user type (note: the default GridType is GridView)

  2. Open the object preferences panel and select one or more object preferences. The object selector will be populated with the selected objects.

Then for each object in the object selector:

  1. Click the create template button in the grid toolbar and create one or more views. We should always have a list view defined, and optionally a grouped view or pivot view.

  2. Click the search button in the grid actions toolbar and create one or more queries

  3. Open the object preferences panel and select one or more relation preferences

  4. Execute one of the queries

  5. Optionally, sort by one or more columns

  6. Optionally, create one or more advanced filters

  7. Optionally, create one or more charts

  8. Optionally, create one or more flows

  9. Expand the subgrids for a given row. For each subgrid:

    1. Create one or more views

    2. Optionally, create one or more charts

    3. Optionally, create one or more grid filters

  10. close the subgrid row

  11. Optionally, select a different grid type (time series or tree grid). Configure the grid type settings as required.


Open the grid permissions panel. Select the permissions appropriate for the given user type.

Close the login-as session

Deploying the preferences

  1. Log back into the app as a system administrator

  2. Open the deployment panel and select the USER CONFIG tab

  3. Search for the user we created

  4. Click the save button to create a AppGrid template and provide a template name.

  5. Click on the TEMPLATE tab in the deployment panel.

  6. Select the template you created

  7. Select the Salesforce profile type. The users assigned to this profile will be displayed

  8. Select one or more users

  9. Click the ASSIGN TEMPLATE button


Rinse and repeat for each type of user.

We recommend deploying AppGrid in a sandbox and having a UAT process where a sample user of each type can try out AppGrid to ensure their configuration meets their needs.