---
title: "Onboarding configuration"
slug: "configuring-onboarding-settings"
updated: 2025-02-26T18:40:31Z
published: 2025-02-26T18:40:31Z
canonical: "docs.agilenow.io/configuring-onboarding-settings"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agilenow.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Onboarding configuration

The **Onboarding Configuration** in **Agile.Now** allows you to set up new **Workspace environments** by defining **subscription plans, mandatory fields, and company information**. The onboarding process enables new customers to register and configure their accounts based on **predefined product and subscription settings**.

This guide provides step-by-step instructions on how to configure **Onboarding settings** in Agile.Now.

For more details on managing product offerings, refer to the [Managing Product Offering Documentation](https://docs.agilenow.io/docs/managing-product-offering){target=`_blank`}.

## **Access Rights Information**
To modify onboarding settings, you need the **`Configuration Onboarding`** role with read and update permissions.

- **Ensure you have the `Configuration Onboarding` role with create and update permissions.**
- **If tenants need to manage their onboarding settings, grant them `Configuration Onboarding` access.**

## **Configuring Onboarding Settings**
Follow these steps to configure the **Onboarding Configuration** correctly.

### **1. Access the Onboarding Configuration Settings**
- Navigate to **Settings** → **Configuration**.
- Locate the **Onboarding Configuration** section.
![Onboarding configuration](https://cdn.document360.io/06417a5c-658f-4a8a-ad57-27f6e06c9e0d/Images/Documentation/Onboarding%20configuration.PNG){height="" width=""}

### **2. Define the Subscription Plan**
- Select a **Default Plan for Subscription** from the dropdown.
- This defines which plan will be **automatically applied** when users onboard.
- The **onboarding form** can be accessed using the following URL format:

  ```
  https://<server_url>/onboarding/?PlanId=<Plan_ID>
  ```

  - The `PlanId` parameter corresponds to any of the **plans** available in your **product portfolio**.
  - If no `PlanId` is provided, the onboarding process will use the **default subscription plan**.

## **3. Set Privacy & Help URLs**
- **Terms and Privacy Policy URL** → Enter a URL that points to your organization’s **privacy policy** (e.g., `https://www.domain.com/privacy`).
- **Need Help URL** → Enter a URL for customer support or helpdesk resources (e.g., `https://www.domain.com/helpdesk`).

## **4. Configure Company Information Visibility**
You can control whether **company details** appear on the registration form:
- Toggle **"The company’s information appears on the registration form"** to **ON** to include company details.
- Define visibility and mandatory status for the following fields:

| **Field**          | **Enabled** | **Mandatory** |
|-------------------|------------|--------------|
| `Business ID`    | ☐ Yes / ☑ No | ☐ Yes / ☑ No |
| `VAT Number`     | ☐ Yes / ☑ No | ☐ Yes / ☑ No |
| `Website`        | ☐ Yes / ☑ No | ☐ Yes / ☑ No |
| `Country & Timezone` | ☑ Yes | ☑ Yes |

> **Note:** Only fields marked as **enabled** will appear in the onboarding form. If marked **mandatory**, users must fill in the field before proceeding.

## **5. Prerequisites for Setting Up Onboarding**
Before configuring onboarding, **you must set up at least one active product and subscription plan**.

### **Minimum Requirements:**
1. **Create a New Product**
   - Navigate to:  `https://<server_url>/Products/`
   - Add a new product with a **default currency**.
   - The product must be **set to active**.

2. **Add a Subscription Plan**
   - The product must include **at least one active plan**.
   - The plan should have a **Free Trial** feature enabled.

3. **Add Applications & Module Features**
   - Ensure that applications and required features/modules are added to the plan.

## **6. Saving and Applying Configuration**
Once all required fields are configured:
- Click **Save** to apply the settings.
- The onboarding form will now reflect the selected **subscription plan, privacy policies, and field visibility settings**.

## **7. Tenant-Specific Onboarding Configuration**
- If you grant tenants access to **`Configuration Onboarding`**, they can modify their **own onboarding settings** for custom registration processes.

## **Troubleshooting Onboarding Issues**
If onboarding is not working as expected, review the following common issues:

| **Issue**                          | **Possible Cause**                                      | **Solution** |
|------------------------------------|--------------------------------------------------------|--------------|
| Onboarding form does not load.    | The `PlanId` parameter is missing or incorrect.       | Ensure the correct **Plan ID** is provided. |
| Subscription plan is not applied.  | The default subscription plan is not set.             | Select a **default plan** in **Onboarding Configuration**. |
| Required fields are missing.      | Mandatory fields are not enabled.                     | Ensure fields are **enabled and marked mandatory**. |
| Free Trial option is not available. | No product plan includes **Free Trial**.             | Ensure at least **one active plan** has Free Trial enabled. |

For additional assistance, refer to the [Agile.Now Documentation](https://docs.agilenow.io/docs/managing-product-offering){target=`_blank`}.

---

## **Conclusion**
Setting up **Onboarding Configuration** correctly ensures a smooth **registration process, subscription management, and workspace setup** in Agile.Now. If tenants require **custom onboarding flows**, they can be granted **`Configuration Onboarding`** permissions.