# Installation & Setup

This guide walks ServiceNow administrators through getting the ins-pi applications from the ServiceNow Store, installing it on an instance, and assigning the right roles to users.

## 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

> If you do not have a Now Support account, ask your organization's **Customer Administrator** to add your email address to the company's Now Support profile.

## Step 1 -- Find the app on the ServiceNow Store

1. Go to [store.servicenow.com](https://store.servicenow.com)
2. Use the search bar to search for for any ins-pi application e.g. **YouDesign Blueprints**
3. Select the app from the results to open the product page

> **Tip:** You can also filter the Store by provider, release version, category, or price using the left-side filter panel.

## Step 2 -- Request the app

On the product page:

1. Click the **Request App** button on the right side of the page
2. The request is sent to the app vendor for review
3. You receive an approval notification email, typically within one business day

> **What happens behind the scenes:** The vendor reviews the request and confirms your organization's access. This is a one-time step per organization.

## Step 3 -- Get the app entitlement

After your request is approved:

1. Return to the application e.g. YouDesign Blueprints product page on the ServiceNow Store
2. The button now shows **Get** instead of Request App
3. Click **Get**
4. A dialog appears asking you to choose an entitlement scope:
   * **All instances** -- entitles every ServiceNow instance in your organization (recommended)
   * **Selected instances** -- entitles only the instances you choose
5. Click **OK** to confirm
6. Accept the ServiceNow Store agreement if prompted

## Step 4 -- 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 the application e.g. **YouDesign Blueprints**
4. Click **Install**

The app installs automatically. Once complete, it is ready to configure.

> **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 5 -- Verify the installation

After installation, confirm that:

* [ ] The application module is accessible under its scoped route
* [ ] The scoped application tables are present (e.g. `x_inpi_ydbp_templates`, `x_inpi_ydbp_blueprints`)
* [ ] The Scripted REST API endpoints are active under e.g. `/api/x_inpi_ydbp/`

## Step 6 -- Assign roles to users

### 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 the application scope e.g.  `x_inpi_ydbp`
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 the application scope e.g. `x_inpi_ydbp`
6. Select the role and move it to the Roles list
7. Click **Save**, then **Update** the user record

## Updating the app

When a new version of ins-pi applications e.g. YouDesign Blueprints 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 Blueprints and click **Update**

> **Tip:** Always test updates on a sub-production instance before applying them to production.

## Troubleshooting

| 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_ydbp` role is assigned to the user or their group            |
| Install button is greyed out                  | Check that you have the admin role and that your instance is entitled                     |
| Users see wrong actions                       | Review the role assignment -- missing or extra permissions usually explain UI differences |


---

# 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/getting-started/quickstart.md?ask=<question>
```

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.