> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# AppDB Admin User Interface

export const InlineImage = ({src, alt = '', height = '1.6em'}) => {
  return <img noZoom src={src} alt={alt} style={{
    display: 'inline',
    verticalAlign: 'start',
    height: height,
    margin: '0'
  }} />;
};

### Intro

AppDB stores JSON documents in Domo like a NoSQL database. You can store data in collections, update documents, update collection schema, add document-level filters, and manage permissions. You can also perform all of these tasks through API calls. For information on using APIs with AppDB, see [AppDB API](https://developer.domo.com/docs/dev-studio-references/appdb) in our developer documentation.

<Warning>
  **Important:**
  AppDB in Domo Bricks is blocked in public embed contexts due to security concerns and trust requirements.
</Warning>

***

### Access AppDB Admin

1. In the navigation header, select
   **More** > **Asset Library**.

   <Frame>
     <img alt="asset library in nav.jpg" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/GZtBW7DeR7whzwbr/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EMVq000000Fvij.jpg?fit=max&auto=format&n=GZtBW7DeR7whzwbr&q=85&s=c5ff64ef7379aba5b93b8a5a0ac33857" style={{width: 402, height: 401}} width="1224" height="1222" data-path="images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EMVq000000Fvij.jpg" />
   </Frame>
2. In the left navigation, select
   <InlineImage src="/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlf.png" /> **AppDB Admin**.

   <Frame>
     <img alt="appdb admin.jpg" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/GZtBW7DeR7whzwbr/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EMVq000000FvpB.jpg?fit=max&auto=format&n=GZtBW7DeR7whzwbr&q=85&s=747eb2283c76bad9df3ae6d3611aece6" style={{width: 401, height: 301}} width="644" height="484" data-path="images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EMVq000000FvpB.jpg" />
   </Frame>

The AppDB Admin interface displays. The default landing page is **My Collections**, and the default Filter is **Owned By: *Your Name***.

In the **Shared with me** section, you can view all the collections that other users have shared with you.

# Searching and Filters

To find a specific collection, enter a keyword in the search bar.

You can select <InlineImage src="/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlS.png" /> **Add Filters** to apply other Filters and narrow down the list of search results.

Remove a Filter by selecting ✖ for that Filter.

<Frame>
  <img alt="appdb_admin_my_collections.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/GZtBW7DeR7whzwbr/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlV.png?fit=max&auto=format&n=GZtBW7DeR7whzwbr&q=85&s=d35c95d77455ab8056a0d3301464512b" style={{width: 900, height: 512}} width="3314" height="1886" data-path="images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlV.png" />
</Frame>

### Create a Collection

1. On the
   [AppDB Admin landing page](#Access), select **Create a Collection**.

   You are prompted to enter a **Collection Name** and an optional **Datastore Name**.

   <Note>
     **Note:**
     If you add a datastore name when creating a collection, a datastore is created in Domo for that collection. This can be helpful because it creates other possible keywords to search for if you remember the datastore name but not the collection name. The datastore name displays in the
     **App Name**
     column of your collection.
   </Note>

   <Frame>
     <img alt="create_a_collection.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/GZtBW7DeR7whzwbr/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlc.png?fit=max&auto=format&n=GZtBW7DeR7whzwbr&q=85&s=4de739427b52dc467ac3f16ac93a6629" style={{width: 800, height: 555}} width="1650" height="1144" data-path="images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlc.png" />
   </Frame>
2. Select
   **Create**.

   The collection details page displays.

### Collection Details

The collection Details page has three tabs: **Data Explorer**, **Configuration**, and **Permissions**. The **Data Explorer** tab is open by default.

This section describes the actions you can perform within each tab.

# Data Explorer

The Data Explorer allows you to create, modify, and query documents in a collection, all of which are described below.

#### Create a Document

1. Select
   **+ New Document**.

   The **New Document** modal displays.

   <Frame>
     <img alt="data_explorer__new_doc.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/GZtBW7DeR7whzwbr/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlR.png?fit=max&auto=format&n=GZtBW7DeR7whzwbr&q=85&s=1595c9fdacf832cc4b8870f5ebc7d810" width="1346" height="526" data-path="images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlR.png" />
   </Frame>
2. Specify the content of your new document in a JSON format.

<Note>
  **Note:**
  If the collection schema has been defined, the modal prepopulates the default value.
</Note>

<Frame>
  <img alt="Screen_Shot_2022-10-13_at_1.45.53_PM.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/GZtBW7DeR7whzwbr/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlM.png?fit=max&auto=format&n=GZtBW7DeR7whzwbr&q=85&s=6ad668e4d7ca334bc63e2de03d430d06" style={{width: 503, height: 418}} width="637" height="491" data-path="images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlM.png" />
</Frame>

3. Select
   **Create**.

#### Modify a Document

1. Select the three-dot menu next to the document.

   The document options display.

   <Frame>
     <img alt="modifying_doc.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/GZtBW7DeR7whzwbr/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlZ.png?fit=max&auto=format&n=GZtBW7DeR7whzwbr&q=85&s=8b96da5e3e8aa6477a06a609ca11ee99" style={{width: 604, height: 619}} width="1024" height="1049" data-path="images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlZ.png" />
   </Frame>
2. Select one of the following document options:

   * **Edit**
     — Allows you to modify the document's content.
   * **Copy**
     — Duplicates the document.
   * **Sync**
     — Displays the most recent version of the document.
   * **Delete**
     — Deletes the document.

#### Querying and Filters

1. To query on a certain item in the data, go to the
   **Filters** section in **Data Explorer** and select **+ Add New**.

   A blank Filter displays.
2. Select a field to filter on from the
   **Select Field** list.
3. Select a logical operator.
4. Enter the query term.
5. Select
   **Apply**.

   <Frame>
     <img alt="applying_a_filter.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/GZtBW7DeR7whzwbr/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlN.png?fit=max&auto=format&n=GZtBW7DeR7whzwbr&q=85&s=4870758a24a8d1455d83a14144b96d76" style={{width: 460, height: 365}} width="1104" height="838" data-path="images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlN.png" />
   </Frame>

The Filter results display on the right side of the screen.

You can delete a Filter by selecting <InlineImage src="/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlX.png" /> **Delete** next to the Filter fields.

#### Sort Results with Aggregations

You can sort the results of your Filter using aggregations, as described below.

1. In the
   **Query Builder** under **Aggregations**, select **+ Add New**.

   The aggregation fields display.
2. Select the aggregation method.
3. Select the Field to sort by.
4. Select the order.

   <Frame>
     <img alt="image.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/GZtBW7DeR7whzwbr/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000006ucJZ.jpg?fit=max&auto=format&n=GZtBW7DeR7whzwbr&q=85&s=f3381135f41b872fb8c4b68cf3aef719" style={{width: 656, height: 284}} width="920" height="398" data-path="images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000006ucJZ.jpg" />
   </Frame>
5. Select
   **Apply** to sort the results by your aggregation.

You can delete an aggregation by selecting <InlineImage src="/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlX.png" /> **Delete** next to the aggregation fields.

<Note>
  **Note:**
  Some aggregations, like
  **average**
  and
  **groupby**
  , support multiple columns.
</Note>

### Configuration

The **Configuration** tab displays all currently defined columns and allows you to add and modify columns.

#### Add a Column

1. Select
   **+ Add Column**.

   A record is added at the bottom of the **Schema Builder**.

   <Frame>
     <img alt="Screen_Shot_2022-10-18_at_9.59.48_AM.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/GZtBW7DeR7whzwbr/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlL.png?fit=max&auto=format&n=GZtBW7DeR7whzwbr&q=85&s=6135134e074a97d1078231dc01a466b6" style={{width: 851, height: 265}} width="1682" height="524" data-path="images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlL.png" />
   </Frame>
2. Enter a
   **Column Name**.
3. Select a
   **Column Type** from the list.

   <Frame>
     <img alt="Screen_Shot_2022-10-18_at_10.04.02_AM.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/GZtBW7DeR7whzwbr/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlO.png?fit=max&auto=format&n=GZtBW7DeR7whzwbr&q=85&s=09a76f7a6bf6546ae5c469e6ee3e85bf" style={{width: 181, height: 605}} width="430" height="826" data-path="images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlO.png" />
   </Frame>

​​When you are ready to save your changes to the **Configuration**, select **Save**.

#### Modify a Column

You can modify a column by editing its name or column type, reordering it, or deleting it, as described below.

* **Edit Name —**
  Hover over the name of the column until the pencil appears, then select it and enter the new column name.

  <Frame>
    <img src="https://mintcdn.com/domoinc-openapi-sync-dataflows/GZtBW7DeR7whzwbr/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlQ.png?fit=max&auto=format&n=GZtBW7DeR7whzwbr&q=85&s=25dc1db33886086fa19ce140c783ac11" width="858" height="84" data-path="images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlQ.png" />
  </Frame>

* **Edit Column Type —**
  Select the <InlineImage src="/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXla.png" /> arrow to show the list and select the new column type.

* **Reorder Columns —**
  Hover over the **<InlineImage src="/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXle.png" /> Reorder Handle** until the cursor becomes a hand, then drag the column record to the correct location.

* **Delete Columns —**
  Hover over the column until <InlineImage src="/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlb.png" /> **Delete** displays and select <InlineImage src="/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlb.png" /> **Delete**.

When you are ready to save your changes to the **Configuration**, select **Save**.

### Permissions

The **Permissions** tab is where you manage your collection's sharing permissions. Use **Document Security Filters** to create specific queries that restrict users to viewing or using only certain data that is stored in the collection. These Filters are like Personalized Data Permissions (PDP) for AppDB.

#### Share Collection Access

At the top of the **Permissions** tab, you can see a list of users who have access to the collection.

1. To add or modify access, select
   <InlineImage src="/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlP.png" />.

   The **Share Access for Collection** modal displays.

   <Frame>
     <img alt="share_access_modal.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/GZtBW7DeR7whzwbr/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlY.png?fit=max&auto=format&n=GZtBW7DeR7whzwbr&q=85&s=285f098c2ba921f00609f59a656bfdd4" style={{width: 421, height: 380}} width="614" height="641" data-path="images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlY.png" />
   </Frame>
2. Enter a person or group in the search bar to find their profile.
3. Next to the person's name, select the access list to choose what level of access that user should have. The options are as follows:
   * Read
   * Write
   * Delete
   * Share
   * Admin
   * Read Content
   * Create Content
   * Update Content
   * Delete Content
   * No Access
4. Select
   **Save**.

#### Connect an App

To connect your collection to an app, follow these steps:

1. Select
   **+ Share With New App**.

   The **Manage Permissions** modal displays.

   <Frame>
     <img alt="share_with_app.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/GZtBW7DeR7whzwbr/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlT.png?fit=max&auto=format&n=GZtBW7DeR7whzwbr&q=85&s=d0d6f86487df465de48855b881798c78" style={{width: 334, height: 374}} width="534" height="654" data-path="images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlT.png" />
   </Frame>
2. Enter the name of an app in the search bar or scroll to find it.
3. Next to the app's name, select the access list to choose what level of access that app should have. The options are as follows:
   * Read
   * Write
   * Delete
   * Share
   * Admin
   * Read Content
   * Create Content
   * Update Content
   * Delete Content
   * No Access
4. Select
   **Save**.

#### Add a Permission

1. Select
   **+ Add Permissions**.

   A blank permission record displays.
2. Enter a
   **Filter Name**.
3. In the
   **Add groups & people** modal that displays, select **Apply To** and add groups and people that the Filter should apply to. Alternatively, you can select **Apply To** and select the **Apply to All** checkbox.
4. Select
   **Apply Changes**.

   The modal closes with the saved changes

   <Frame>
     <img alt="apply_changes.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/GZtBW7DeR7whzwbr/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlg.png?fit=max&auto=format&n=GZtBW7DeR7whzwbr&q=85&s=4a231e4b6b1514dd0a635a9276314162" style={{width: 402, height: 362}} width="705" height="579" data-path="images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlg.png" />
   </Frame>
5. Under
   **Query**, select the **Limit To Owner** checkbox or select **Modify Query** to modify the JSON request.

   <Frame>
     <img alt="Screen_Shot_2022-10-18_at_1.15.51_PM.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/GZtBW7DeR7whzwbr/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXld.png?fit=max&auto=format&n=GZtBW7DeR7whzwbr&q=85&s=bcd643fb48765359babd29d97943f204" width="330" height="92" data-path="images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXld.png" />
   </Frame>
6. In the
   **Apply On** list, select the action to apply the permission to. The options are **Read**, **Update**, and **Delete**.
7. Select
   **Save**.

Select <InlineImage src="/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000005vXlb.png" /> **Delete** to delete a Filter.

#### Export a Collection

On each Collection Details tab, the **Export Collection** option displays near the top of the screen.

Select **Export Collection** to download the current collection as a JSON file.

<Frame>
  <img alt="image.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/GZtBW7DeR7whzwbr/images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000006ucJF.jpg?fit=max&auto=format&n=GZtBW7DeR7whzwbr&q=85&s=30e32af319665d2f040bae9067c2410e" style={{width: 903, height: 262}} width="1503" height="436" data-path="images/kb/ka0Vq0000000RoD-00N5w00000Ri7BU-0EM5w000006ucJF.jpg" />
</Frame>
