# Installation & Setup

YouDesign Processes is a **shape library extension** for YouDesign Models. Installing it registers the full BPMN 2.0 shape set into the Models shape palette — nothing more, nothing less.

There is no separate Processes application, no separate UI, no separate data store. Every process diagram you create lives in YouDesign Models, alongside every other diagram in your enterprise graph.

Installation typically takes **5 minutes** end-to-end and is fully hands-off.

## 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
* [**YouDesign Models**](https://app.gitbook.com/o/C4zZz8JNanDIePyC2CfT/s/OS5XKTz5WlrX4s5rESlH/) installed **and** an active YouDesign Models subscription
* a **supported ServiceNow release** — Washington DC, Xanadu, Yokohama, or Zurich

> ℹ️ 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.

> ⚠️ **YouDesign Models is required.** Processes only delivers BPMN shape definitions. Without Models installed, there is nothing for the shapes to render in.

## Installation & Setup

### 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 **YouDesign Processes**
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 YouDesign Processes 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 **YouDesign Processes**
4. Click **Install**

The shape library registers automatically into the `x_inpi_yd_bpm` scope. Installation usually completes within 2–3 minutes.

> 💡 **Recommended install order:** sub-production (dev or test) → UAT → production.

> 💡 **Tip for recent releases (Washington DC+):** 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, open any YouDesign Models canvas and confirm:

* [ ] &#x20;A **Process** (or **BPMN**) category appears in the Models shape library
* [ ] &#x20;Standard BPMN 2.0 shapes are visible — **Events**, **Activities**, **Gateways**, **Swimlanes**, **Pools**, **Data Objects**, **Annotations**
* [ ] &#x20;Dragging a BPMN shape onto the canvas places it correctly and connects to other Models objects as expected

That's it. No configuration, no role assignment, no metamodel activation — the shapes are ready to use the moment install completes.

### There is nothing else to set up

YouDesign Processes does not introduce:

* **❌ A separate application or module** — all work happens inside YouDesign Models
* **❌ Separate roles or permissions** — Models roles govern access to process diagrams exactly as they govern every other diagram
* **❌ A separate data store** — process diagrams are stored as Models diagrams in the Models scope
* **❌ A separate governance workflow** — your Models approval, versioning, and lifecycle rules apply automatically

If YouDesign Models is configured for your users, YouDesign Processes is ready for those same users. There is no Processes-specific admin work.

## Updating the app

When a new version of YouDesign Processes 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 Processes and click **Update**

Updates typically deliver new or revised BPMN shapes. Existing process diagrams are not affected.

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

## Uninstalling the app

If you need to remove YouDesign Processes:

1. Navigate to **System Applications > All Available Applications > All**
2. Find YouDesign Processes and click **Uninstall**
3. Confirm the uninstall

> ⚠️ **What happens to existing process diagrams:** Diagrams themselves are **not** deleted — they remain in the YouDesign Models scope. However, any BPMN shapes on those diagrams will no longer render correctly, because the shape definitions have been removed. Reinstalling YouDesign Processes restores full rendering with no data loss.

## 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      |
| Install button is greyed out                            | Check that you have the admin role and that your instance is entitled                       |
| BPMN shapes missing from Models canvas                  | Confirm `x_inpi_yd_bpm` is installed under **System Applications > Installed Applications** |
| BPMN shapes on existing diagrams render as placeholders | YouDesign Processes has been uninstalled. Reinstall it to restore shape rendering.          |
| User cannot see or edit process diagrams                | Review the user's **YouDesign Models** role — Processes has no permissions of its own       |
| Installation succeeds but shapes never appear           | Verify that YouDesign Models is installed. Processes requires Models to render.             |


---

# 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/processes/get-the-app/installation.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.
