Skip to content
D
Documentation

Plan details

reference
5 min readUpdated

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 planPlans page
Open a saved plan recordFind and open a plan
Locate a field or check its rulePlan fields
Understand feature selectionFeature columns
Change plan information or featuresMaintain a plan
Correct a validation or request messageWhen loading, saving, or validating goes wrong
Configure available featuresFeatures page
Review feature-specific detailsCompany features
Check which company is associated with a planSubscriber 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 beginWhat must be available
Plan informationThe saved plan record must load before the form content appears.
Feature selectionThe 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

  1. Open the Plans list.
  2. Select the existing plan row.
  3. 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 areaWhat it containsWhat to use it for
Plan informationPlan name and Plan PriceIdentify the plan and its price.
Capacity limitsUsers count, Branches count, Teams count, and Roles countSet the limits used in administration areas.
Active settingActiveSet the plan's active value.
Commit controlSaveCommit changed plan information or feature selections.
Feature areaThe feature grid, when the feature list contains at least one itemReview or select features for the plan.
The plan-information fields, including Plan name and Plan Price

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.

FieldTypeRequired markerAccepted value or rule
Plan nameText boxYesRequired and subject to pattern validation.
Plan PriceNumber box with currency pickerNoMinimum 0; displayed in #,##0.00 format.
Users countNumber boxYesFrom 0 through 99.
Branches countNumber boxYesFrom 0 through 99.
Teams countNumber boxYesFrom 0 through 99.
Roles countNumber boxYesFrom 0 through 99.
ActiveBoolean checkboxNoOptional 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

  1. Enter or change a value in one of the fields listed below.

    ChangeAction
    Plan identity or priceEnter or change a value in Plan name or Plan Price.
    Capacity limitEnter or change a value in Users count, Branches count, Teams count, or Roles count.
    Active settingSelect or clear Active.
    Feature selectionSelect a Feature row when the feature grid is available.
  2. If Save is disabled, change a plan field or feature selection.

  3. Select Save.

The Save control on the plan details screen

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 seeMeaningWhat to do
This Field Is RequiredA required field has no value.Enter a value in the required field, then review Save.
Just '_'‘-''.' And '&' Characters AcceptedPlan name does not meet the pattern rule.Correct Plan name, then review Save.
An error occurred while processing your requestLoading 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?

Need help using the product?