A plan record holds the name, price, capacity limits, active setting, and selected features for a subscription plan.
Overview
Use plan details to review or maintain an existing plan. Its capacity values become limits in the branch, warehouse, team, role, and user administration areas.
| If you need to… | Go to |
|---|---|
| Find an existing plan | Plans page |
| Open a saved plan record | Find and open a plan |
| Locate a field or check its rule | Plan fields |
| Understand feature selection | Feature columns |
| Change plan information or features | Maintain a plan |
| Correct a validation or request message | When loading, saving, or validating goes wrong |
| Configure available features | Features page |
| Review feature-specific details | Company features |
| Check which company is associated with a plan | Subscriber view |
Prerequisites
You need an existing plan identifier. The plan information appears after the saved plan record loads. The feature grid appears only when the feature list contains at least one item.
| Before you begin | What must be available |
|---|---|
| Plan information | The saved plan record must load before the form content appears. |
| Feature selection | The feature list must contain at least one item before the feature grid appears. |
Find and open a plan
The Plans page is the list entry point for an existing plan record.
Prerequisites
- You have an existing plan identifier.
Steps
- Open the Plans list.
- Select the existing plan row.
- Confirm that Plan name appears on the plan details screen.
Result: The existing plan details screen is open. Continue with Understand the plan details screen to review its fields and feature area.
Understand the plan details screen
The plan details screen contains the values that define one existing plan. Its plan-information area contains Plan name, Plan Price, Users count, Branches count, Teams count, Roles count, and Active. Save commits a change.
| Screen area | What it contains | What to use it for |
|---|---|---|
| Plan information | Plan name and Plan Price | Identify the plan and its price. |
| Capacity limits | Users count, Branches count, Teams count, and Roles count | Set the limits used in administration areas. |
| Active setting | Active | Set the plan's active value. |
| Commit control | Save | Commit changed plan information or feature selections. |
| Feature area | The feature grid, when the feature list contains at least one item | Review or select features for the plan. |
Plan fields
Use these rules when reviewing or changing a plan. A required marker is visible for Plan name, Users count, Branches count, Teams count, and Roles count. Plan Price and Active are optional.
| Field | Type | Required marker | Accepted value or rule |
|---|---|---|---|
| Plan name | Text box | Yes | Required and subject to pattern validation. |
| Plan Price | Number box with currency picker | No | Minimum 0; displayed in #,##0.00 format. |
| Users count | Number box | Yes | From 0 through 99. |
| Branches count | Number box | Yes | From 0 through 99. |
| Teams count | Number box | Yes | From 0 through 99. |
| Roles count | Number box | Yes | From 0 through 99. |
| Active | Boolean checkbox | No | Optional boolean setting. |
Feature columns
The feature grid is the plan's feature-selection table. When it appears, its columns are Selected and Feature. Select a Feature row to add or remove that feature. Select Save to commit the selection.
When the feature list has no items, the feature grid has no columns or rows. The grid appears when the feature list contains at least one item.
Note: The feature list controls whether the feature area appears. Review the visible grid before changing feature selections.
Maintain a plan
Change plan information or select a feature on an existing plan.
Prerequisites
- An existing plan details screen is open.
- You know the plan information or feature selection to change.
Steps
-
Enter or change a value in one of the fields listed below.
Change Action Plan identity or price Enter or change a value in Plan name or Plan Price. Capacity limit Enter or change a value in Users count, Branches count, Teams count, or Roles count. Active setting Select or clear Active. Feature selection Select a Feature row when the feature grid is available. -
If Save is disabled, change a plan field or feature selection.
-
Select Save.
Result: The changed plan information or feature selection is submitted through Save. The screen provides no delete action.
When loading, saving, or validating goes wrong
Use the message text on screen to identify the problem, then correct the value or repeat the affected action.
| What you see | Meaning | What to do |
|---|---|---|
This Field Is Required | A required field has no value. | Enter a value in the required field, then review Save. |
Just '_'‘-''.' And '&' Characters Accepted | Plan name does not meet the pattern rule. | Correct Plan name, then review Save. |
An error occurred while processing your request | Loading the plan or its features failed. | Review the request state and repeat the affected action when the screen is available. |
The required rules apply to Plan name, Users count, Branches count, Teams count, and Roles count. The plan-name pattern rule is separate from the required rule.
After maintaining a plan
The capacity values are used as limits in the branch, warehouse, team, role, and user administration areas. Use the related administration pages to work with those limits. Use Company features for related feature configuration and feature-specific details. Use the Features page for the feature list, and Subscriber view to check which company is associated with a plan.
Was this page helpful?