> For the complete documentation index, see [llms.txt](https://docs.gridmate.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gridmate.io/advanced-guides/user-grid/user-grid-deployment-process.md).

# User Grid - Deployment Process

Move User Grids between orgs with the Admin Cockpit or the SF CLI Plugin.

GridMate offers two deployment options for User Grids: a graphical interface through the **Admin Cockpit** and [**SF CLI Plugin**](/tools/sf-cli-plugin.md). The scenario in this tutorial is to create Accounts and Contacts User Grids and move them from one org to another. User Grids exported in Salesforce metadata like format (JSON), can be easily modified using popular tools like VS Code before importing them back.

## Prerequisites

### Enable GridMate Advanced User

{% stepper %}
{% step %}

#### Find the user

Go to setup, and on the quick find Box search for Users.
{% endstep %}

{% step %}

#### Open the user

Click on the desired **Full Name.**
{% endstep %}

{% step %}

#### Open the permission set assignments

Click on Permission Set Assignments.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FAmA5hcDi66avQFn9Pdbb%2FScreenshot%202023-11-22%20at%2010.52.02.png?alt=media&amp;token=0306a9ac-6fb4-4d29-93d7-4bcc99d4d910" alt=""><figcaption></figcaption></figure>

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2Ffc8Tw3fi3vPlL0xrJCrV%2FScreenshot%202023-11-21%20at%2011.36.22.png?alt=media&amp;token=b84c1a41-10cb-4095-b8be-481bfdde0d00" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Edit the assignments

Click on edit assignments.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FczPNmXmRHo38MXpRxXis%2FScreenshot%202023-11-21%20at%2011.37.32.png?alt=media&amp;token=d2b35e69-4c1c-4848-ab50-38541f666d5b" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Enable the permission set

Enable **GridMate Advanced User**.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FiJwfrFSg1D3tzwbdISkW%2FScreenshot%202023-11-22%20at%2011.02.45.png?alt=media&amp;token=4a5b5288-1434-4d08-8724-d64d1c4fb01d" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

### Enable GridMate Cockpit User

{% stepper %}
{% step %}

#### Find the permission set

Go to setup, and on the quick find Box search for Permission Sets.
{% endstep %}

{% step %}

#### Open the permission set

Click on the **GridMate Cockpit User**.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2F4i7zOH9nHdue9fEOv83x%2FScreenshot%202023-11-21%20at%2011.34.15.png?alt=media&amp;token=ad910684-6c4c-4598-b69e-0a1c9e63059d" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Manage assignments

Click **Manage Assignments**.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FouEfJ9TisFvx0y8Iwo4J%2FScreenshot%202023-11-21%20at%2011.34.57.png?alt=media&amp;token=de0391bc-0cb5-4536-bcdd-37bb35f2b274" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Assign the user

Ensure the existence of desired user, if not, click **Add Assignment** to add it.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2Fegq7zRCScgrULzXuIfBx%2FScreenshot%202023-11-21%20at%2011.35.18.png?alt=media&amp;token=1a51c663-d5c3-4bdc-b91e-c36d40cb0a34" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

### SF CLI Plugin Setup

{% stepper %}
{% step %}

#### Clone the repository

Clone the repository.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FtgDXvWeUGC0NjKBAShUi%2FScreenshot%202023-11-21%20at%2014.52.48.png?alt=media&amp;token=23a36977-d193-43c5-9cb3-e9fa11a6529f" alt=""><figcaption></figcaption></figure>

```
git clone https://github.com/GridMate/gridmate-sf-plugin
```

{% endstep %}

{% step %}

#### Install npm modules

Go to the plugin directory and Install npm modules.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2Ft1Q9jXizxX3cFjl7tJPK%2FScreenshot%202023-11-21%20at%2014.54.17.png?alt=media&amp;token=69b5d18c-623e-4cfe-96e4-c076aa7d1fe3" alt=""><figcaption></figcaption></figure>

```
npm install
```

{% endstep %}

{% step %}

#### Link the plugin

Link the plugin to your cli installation.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2Fi0DIPuR7rh6iczfzDRNo%2FScreenshot%202023-11-23%20at%2001.00.04.png?alt=media&amp;token=4c0a5cf7-ff32-4411-9140-71215209984e" alt=""><figcaption></figcaption></figure>

```
sf plugins link .
```

{% endstep %}
{% endstepper %}

## User Grids Setup

We are now ready to start using the **GridMate User Grid** to create **Accounts** and **Contacts** Grids.

### Accounts User Grid

* On the App Launcher search for **GM - User Grids**.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FnT6aNz9kEcF8PFJN0xj7%2FScreenshot%202023-11-22%20at%2011.06.40.png?alt=media&amp;token=4388a7b9-b048-4b2f-a841-abbf6051e3ed" alt=""><figcaption></figcaption></figure>

* Click New.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FeFJ4CNVlWN4P6DMkeqdt%2FScreenshot%202023-11-21%20at%2012.24.52.png?alt=media&amp;token=de2f9112-1172-4b74-a057-baf957745058" alt=""><figcaption></figcaption></figure>

* Create Accounts User Grid:
  * Object Name: **Account**
  * List View: **All Accounts**
  * Grid Name: **Accounts**

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FyhabA5kjXna3cTni9vgN%2FScreenshot%202023-11-21%20at%2012.25.37.png?alt=media&amp;token=cd7d9aa7-eeca-4d3e-9ad4-1d3964780de8" alt=""><figcaption></figcaption></figure>

### Contacts User Grid

* Create Contacts User Grid:
  * Object Name: **Contact**
  * List View: **All Contacts**
  * Grid Name: **Contacts**

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FSm5RVqy2XoQMEIlyVMAx%2FScreenshot%202023-11-21%20at%2012.26.04.png?alt=media&amp;token=c9b69f6a-e90c-4757-acfe-0a45892b5104" alt=""><figcaption></figcaption></figure>

### Inline Component Setup

* Go to **Config Wiz** on the **Accounts** User Grid.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2Fyuk8Pa5bYZKct9lxovOh%2FScreenshot%202023-11-21%20at%2012.26.43.png?alt=media&amp;token=6e0e6a16-7822-4bbf-aaed-89b0beae4998" alt=""><figcaption></figcaption></figure>

* Select the **inline Components** tab.
* User Grid : **Contacts**.
* Condition :

  ```json
  {
      "and": [
          {
              "AccountId": {
                  "operator": "=",
                  "value": "$recordId"
              }
          }
      ]
  }
  ```

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FNCF68rc4TnIC57ydTMX4%2FScreenshot%202023-11-21%20at%2012.28.08.png?alt=media&amp;token=ea3387b9-f848-4ad0-bdeb-be638c6f12e5" alt=""><figcaption></figcaption></figure>

## User Grids Deployment

### Deployment Using **Admin Cockpit.**

The Accounts and Contacts User Grids are created and the inline component is also configured, we can start the Deployment using **Admin Cockpit**.

#### User Grids Export

* On the App Launcher search for the **GM - Admin Cockpit**.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FMI1NRNBnO18DS4zjnBop%2FScreenshot%202023-11-21%20at%2015.33.04.png?alt=media&amp;token=90d565f3-3f79-43c6-8be1-45ca2612a632" alt=""><figcaption></figcaption></figure>

* Select the **User Grid Maintenance.**
* Select the **Accounts** and **Contacts** User Grids.
* Click **Export** to export them.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FjqYxlEXHeXPHLYlSIWvB%2FScreenshot%202023-11-21%20at%2015.35.09.png?alt=media&amp;token=0bddc723-ecf4-42ce-aa19-9ffa6c80e385" alt=""><figcaption></figcaption></figure>

* Open the **Accounts** User Grid using **Visual Studio Code** for example:

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FE7BpQEqtxiFz9w6P2Zhp%2FScreenshot%202023-11-21%20at%2015.45.34.png?alt=media&amp;token=ddee66a8-f791-4b43-9bfc-549982eea35e" alt=""><figcaption></figcaption></figure>

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FxCxMZlXIaerP3DHyjiFt%2FScreenshot%202023-11-23%20at%2001.25.51.png?alt=media&amp;token=1893b5d3-cc06-4738-826b-452ad0b11f37" alt=""><figcaption></figcaption></figure>

* Change the Owner **Username** to match the target org.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FOg6j7GmhOWYt3uAvwmmL%2FScreenshot%202023-11-23%20at%2014.53.04.png?alt=media&amp;token=9557f0fb-7acc-41cf-8f06-313f82e403c7" alt=""><figcaption></figcaption></figure>

* Open the **Contacts** User Grid using **Visual Studio Code**.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FNWPXeseOxFQwP56yzyOE%2FScreenshot%202023-11-21%20at%2015.45.02.png?alt=media&amp;token=3ce513e6-d6f3-4d3c-987b-7f46e16e11c9" alt=""><figcaption></figcaption></figure>

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FGoOkgE61SXVZ24ggAsnX%2FScreenshot%202023-11-23%20at%2001.31.11.png?alt=media&amp;token=404fb0e1-7ce8-4700-8c47-7f4e754f8f4e" alt=""><figcaption></figcaption></figure>

* Change the Owner **Username** to match the target org.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2Fkn8iV1Hp4pDxKSeFdAZX%2FScreenshot%202023-11-21%20at%2016.10.32.png?alt=media&amp;token=f2ff25f3-0bcb-4f75-81c1-14ef39843d27" alt=""><figcaption></figcaption></figure>

#### User Grids Import

* Moving to the target org (Demo 13 in our example).
* Import the **Accounts** and **Contacts** User Grids using the **GM - Admin Cockpit**

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FrJnDcwroAvfWTXCy1Fz6%2FScreenshot%202023-11-21%20at%2015.49.20.png?alt=media&amp;token=4b0440a8-a301-40d3-9424-d799f0fa00e7" alt=""><figcaption></figcaption></figure>

* First import the **Contacts** User Grid. Inline grids should be always imported first to be able to link them when parent grids are imported.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2Fk50SwQMknwk2CvZ8mPy5%2FScreenshot%202023-11-21%20at%2015.51.38.png?alt=media&amp;token=c5a93765-a248-4614-a950-6a728e4ddce3" alt=""><figcaption></figcaption></figure>

* Second import the Account User Grid.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FKaE7kJRZw9X6d6ptLkJA%2FScreenshot%202023-11-21%20at%2015.52.03.png?alt=media&amp;token=78b39e63-780f-481c-a437-2a7af0ff09ca" alt=""><figcaption></figcaption></figure>

### Deployment Using CLI Plugin

After completing the [SF CLI Plugin Setup](#sf-cli-plugin-setup), we can now **Export/import** the User Grids.

#### User Grids Export

* Export the User Grid Using [SF Cli Plugin](/tools/sf-cli-plugin.md)

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FmY8xex7qIxK052qhKEn2%2FScreenshot%202023-11-23%20at%2000.05.36.png?alt=media&amp;token=839087f4-1d21-4b90-9275-537e064bcf90" alt=""><figcaption></figcaption></figure>

```
sf gmpkg usergrid export -o gmpkg-demo10 --api-version=58.0 -d "./usergrids" -n "Contact_nr9ma,Account_kozsu"
```

#### User Grids Import

* Change the Owner of the User Grids as explained in [Deployment Using Admin Cockpit](#deployment-using-admin-cockpit)
* Import the **Contacts** User Grid Using [SF Cli Plugin](/tools/sf-cli-plugin.md)

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FOgevTeA2fAqYHXSgE80C%2FScreenshot%202023-11-23%20at%2011.46.37.png?alt=media&amp;token=0268761f-92a9-46b6-b8a8-1ba8368bd7d5" alt=""><figcaption></figcaption></figure>

```
sf gmpkg usergrid import -o demoOrg13 --api-version=58.0 -f "./usergrids/Contact_nr9ma.json"  
```

* Import the Account User Grid Using [SF Cli Plugin](/tools/sf-cli-plugin.md)

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2F7a4VGeyFeyEbleP1AARd%2FScreenshot%202023-11-23%20at%2011.50.02.png?alt=media&amp;token=1b4893d2-f126-4edd-8b62-39ef3358307c" alt=""><figcaption></figcaption></figure>

```
sf gmpkg usergrid import -o demoOrg13 --api-version=58.0 -f "./usergrids/Account_kozsu.json"
```

## Final Result

Using either the **Admin Cockpit** or the **SF CLI Plugin** to obtain the desired results, on our target org (**Demo** **13**), locate the **Accounts** User Grid and **Contacts** Grid as an **inline component**.

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2FJhwvDe4Zvkch194YfZws%2FScreenshot%202023-11-21%20at%2016.03.53.png?alt=media&amp;token=c3963a0d-5b38-4b13-a7d4-77110cf27dc3" alt=""><figcaption></figcaption></figure>

<figure><img src="https://4046919449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MEsSbGy_U_OhthKUpxu%2Fuploads%2F0DbWmggp59xOQ3rbY0nj%2FScreenshot%202023-11-21%20at%2016.00.22.png?alt=media&amp;token=f234e028-938a-4408-bbd6-09d66d401af3" alt=""><figcaption></figcaption></figure>

## Next steps

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Grid - Admin Cockpit</strong></td><td>Maintain User Grids and secure field and action access in the GridMate Cockpit.</td><td><a href="/advanced-guides/grid-setup/grid-admin-cockpit.md">Grid - Admin Cockpit</a></td></tr><tr><td><strong>SF Cli Plugin</strong></td><td>Export and import User Grids with the GridMate sf plugin.</td><td><a href="/tools/sf-cli-plugin.md">SF Cli Plugin</a></td></tr><tr><td><strong>User Grid</strong></td><td>Create and configure your own grids from the Config Wiz.</td><td><a href="/product-tour/grids/user-grid.md">User Grid</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.gridmate.io/advanced-guides/user-grid/user-grid-deployment-process.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
