# Installation & Setup > ### Installation and Setup > > You are the admin installing the YouDesign Models application on a ServiceNow instance for the first time. This takes six steps. All of them happen inside ServiceNow. Everything stays inside your ServiceNow instance, and you don't need any new infrastructure. > Native ServiceNow application. All runtime, all data, all APIs stay inside your instance under the exclusive scope `x_inpi_yd`. > #### Before you begin > > You need: > > * a **Now Support (HI) account** linked to your organization > > * the **admin** role on the target ServiceNow instance > > * network access to `store.servicenow.com` from your browser > > * a procured YouDesign Models license, with entitlement received from ServiceNow > > > If you do not have a Now Support account, ask your organization's **ServiceNow Administrator** to add your email address to the company's Now Support profile. > **Always install on non-production first.** Run your initial install on a sandbox, development, test, training, or pre-production instance before promoting to production. > #### Step 1: Find the app on the ServiceNow Store > > 1. Go to the [YouDesign Models product page](https://ins-pi.com/getyoudesign) on the ServiceNow Store > > 2. Or, from [store.servicenow.com](https://store.servicenow.com), search for **YouDesign Models** and open the listing > > > **Tip:** You can also filter the Store by provider, release version, category, or price using the left-side filter panel. > > #### Step 2: Complete entitlement > > On the YouDesign Models product page: > > 1. Log in with your **HI credentials** > 2. Click **Complete Purchase** > 3. Accept the Site Terms of Use by checking the box > 4. Click **Complete Purchase** again to confirm > > YouDesign Models is now entitled for installation on your organization's ServiceNow instances. > **Commercial on-premise customers:** If you run ServiceNow on-premise, follow the [ServiceNow Store on-premise installation instructions](https://store.servicenow.com/sn_appstore_store.do#!/store/help?article=KB0030222) instead of the standard flow. > > #### Step 3: Install on your ServiceNow instance > > 1. Log in to your target ServiceNow instance with **admin** credentials > 2. Navigate to **System Applications > All Available Applications > All** > 3. Search for **YouDesign Models** > 4. Ensure the **Load demo data** checkbox is selected to install with sample boards, shapes, and indicators > 5. Click **Install** > 6. In the installation pop-up, click **Install** to confirm > > The app installs hands-free and typically completes in 10–15 minutes. > > > **Tip for newer instances (Vancouver+):** You can also use the **Application Manager** inside Admin Center for a consolidated view of all available and installed apps. > > #### Step 4: Verify the installation > > After installation, confirm that: > > * [ ] The application module is accessible under its scoped route > * [ ] The scoped application tables are present under the `x_inpi_yd` scope (e.g. `x_inpi_yd_board`, `x_inpi_yd_shape`, `x_inpi_yd_realtime_indicator`) > * [ ] Default board types, shape categories, and import mappings are populated (if you installed with demo data) > * [ ] The Scripted REST API endpoints are active under `/api/x_inpi_yd/` > > #### Step 5: Assign roles to users > > YouDesign Models uses three scoped roles: > > The **Admin** role is pivotal: only admins can create Teamspaces, and Teamspaces are the container that gives Editors and Viewers access to boards. > > **Assign roles to a group (recommended)** > > Assigning roles to groups is more scalable and easier to audit than assigning to individual users. > > 1. Navigate to **User Administration > Groups** > 2. Select the target group or create a new one > 3. Open the group record > 4. Scroll to the **Roles** related list tab > 5. Click **Edit** > 6. In the Collection list, search for `x_inpi_yd` > 7. Select the appropriate role and move it to the Roles list using the arrow button > 8. Click **Save**, then **Update** the group record > > Any user added to this group automatically inherits the assigned roles. > > **Assign a role to an individual user** > > 1. Navigate to **User Administration > Users** > 2. Search for and open the user record > 3. Scroll to the **Roles** related list tab > 4. Click **Edit** > 5. Search for roles starting with `x_inpi_yd` > 6. Select the role and move it to the Roles list > 7. Click **Save**, then **Update** the user record > > #### Step 6: Create your first Teamspace > > Boards live inside Teamspaces. Until at least one Teamspace exists, Editors and Viewers have nowhere to work. > > 1. Sign in as a user with the **YouDesign Models Admin** role > 2. Open YouDesign Models from the application navigator > 3. Create a Teamspace and add the relevant Editor and Viewer groups or users > > Editors assigned to the Teamspace can now create boards. Viewers assigned to the Teamspace can open them in read-only mode. > > #### Role assignment best practices > > > For a detailed breakdown of what each role can do, see Access Rights and Roles. > > #### Post-installation checklist > > Use this checklist to confirm a successful setup: > > * [ ] App is installed and accessible on the instance > * [ ] At least one user has the **YouDesign Models Admin** role > * [ ] At least one Teamspace exists for Editors and Viewers to work in > * [ ] Editors can create and save a test board inside a Teamspace > * [ ] Viewers can open shared boards in read-only mode > * [ ] Default shapes and Realtime Indicators are visible on the canvas (if installed with demo data) > * [ ] Import mappings work end-to-end on a sample dataset > > #### Updating the app > > When a new version of YouDesign Models is available: > > 1. You receive a notification email from the ServiceNow Store > > 2. Log in to your instance as admin > > 3. Navigate to **System Applications > All Available Applications > All** > > 4. Find YouDesign Models and click **Update** > > > **Tip:** Always test updates on a sub-production instance before applying them to production. > > The update behavior of every YouDesign Models table is documented in the Installation content reference below. Tables marked **New Install and Upgrades** are overwritten with each release. > > #### Troubleshooting > > #### Installation content reference > > YouDesign Models uses the exclusive scope `x_inpi_yd`, ensuring all tables remain distinct and do not conflict with existing ServiceNow or third-party tables. > > ServiceNow facilitates three installation options that determine how each table behaves on install and on upgrade: > > * **New Install and Upgrades** — installs new content and overwrites existing data with each upgrade, maintaining the latest version. Customer changes are not retained. > * **New Install** — content installs only during initial setup. Subsequent upgrades do not modify pre-existing content. Customer changes are preserved. > * **New Install with Demo Data** — content installs only when **Load demo data** is selected during installation. > > **Installation tables reference** > > For architecture and data handling details, see ServiceNow Administration and Security and Data Handling. | Table Name | Display Label | Installation Option | Comments | | ------------------------------------ | ------------------------ | ------------------------ | ------------------------------------------------------------------- | | `x_inpi_yd_board` | Board | n/a | No content provided | | `x_inpi_yd_board_content` | Board Content | n/a | No content provided | | `x_inpi_yd_board_lifecycle` | Board Lifecycle | New Install | Default board lifecycle phases | | `x_inpi_yd_board_realtime_indicator` | Board Realtime Indicator | n/a | No content provided | | `x_inpi_yd_board_scope` | Board Scope | n/a | No content provided | | `x_inpi_yd_board_stage` | Board Stage | New Install | Introduced with May 2024 Release | | `x_inpi_yd_board_type` | Board Type | New Install | Default board types provided | | `x_inpi_yd_board_version` | Board Version | n/a | No content provided | | `x_inpi_yd_filter` | Filter | New Install | Introduced with March 2024 Release | | `x_inpi_yd_folder` | Folder | n/a | No content provided | | `x_inpi_yd_mapping` | Mapping | New Install | Default import mappings provided | | `x_inpi_yd_realtime_indicator` | Realtime Indicator | New Install | Example Realtime Indicators provided; contact ins-pi for latest set | | `x_inpi_yd_realtime_indicator_shape` | Realtime Indicator Shape | New Install and Upgrades | YouDesign Models system table; customer changes not allowed | | `x_inpi_yd_realtime_indicator_value` | Realtime Indicator Value | n/a | No content provided | | `x_inpi_yd_shape` | Shape | New Install | Default shapes provided; contact ins-pi for latest set | | `x_inpi_yd_shape_category` | Shape Category | New Install | Default shape categories provided; contact ins-pi for latest set | | `x_inpi_yd_shape_field` | Shape Field | n/a | No content provided | | `x_inpi_yd_shape_relationship` | Shape Relationship | n/a | No content provided | | `x_inpi_yd_visualization` | Visualization | New Install and Upgrades | YouDesign Models system table; customer changes not allowed | | Issue | What to check | | --------------------------------------------- | --------------------------------------------------------------------------------------- | | App not visible in All Available Applications | Confirm the entitlement was completed on the Store and that you are logged in as admin | | Users cannot see the app | Confirm at least one `x_inpi_yd` role is assigned to the user or their group | | Users see the app but cannot find any boards | Confirm they have been added to a Teamspace by a YouDesign Models Admin | | Install button is greyed out | Check that you have the admin role and that your instance is entitled | | Default shapes or indicators are missing | Reinstall with **Load demo data** selected, or contact ins-pi for the latest content | | Users see wrong actions | Review the role assignment. Missing or extra permissions usually explain UI differences | | Practice | Why it matters | | ------------------------------------------- | ------------------------------------------------------------------------------------ | | **Assign roles to groups, not individuals** | Easier to manage, audit, and scale as your team grows | | **Follow least-privilege** | Only give users the minimum role needed for their job | | **Start with Viewer** | For users who only need to review boards, Viewer is the safest starting point | | **Limit the Admin role** | Admins can create and configure Teamspaces. Keep this role to a small, defined group | | Role | Technical name | Purpose | | --------------------------- | ------------------ | ------------------------------------------------------- | | **YouDesign Models Admin** | `x_inpi_yd.admin` | Create Teamspaces and manage global settings | | **YouDesign Models Editor** | `x_inpi_yd.editor` | Create and edit boards within Teamspaces they belong to | | **YouDesign Models Viewer** | `x_inpi_yd.viewer` | Review shared boards in read-only mode | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.ins-pi.com/models/get-the-app/installation.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.