Skip to content
D
Documentation

Plan details

reference
5 min readUpdated

Overview

A plan is a configuration record that names a plan, sets its price and capacity limits, marks it active, and assigns features. Use this page to review or maintain those values.

If you need to…Go to
Check the values held by a planUnderstand the plan details screen
Open a saved planFind and open a plan
Change plan values or feature assignmentsMaintain a plan
Resolve a validation or request errorWhen loading, saving, or validating goes wrong
Return to the list of plansPlans
Maintain company featuresCompany features

The record contains the plan name, price, counts for users, branches, teams, and roles, an Active checkbox, and a feature list with Selected and Feature columns.

Start with the prerequisites when you need to open a record, or use the screen reference when you are checking fields.

Prerequisites

Open an existing plan to load its details, or open a new plan record to enter new values.

The form appears when the plan record is available. The feature list appears when the list contains at least one feature. Save is enabled when the current plan differs from its original values and disabled when there are no unsaved changes.

Before you startWhat to check
Existing planOpen the plan from the plans list.
New planOpen a new plan record.
Record formConfirm that the plan details form is visible.
Feature listConfirm that the feature grid is present before selecting a feature.
Save stateChange a value before selecting Save.

When these checks are complete, find and open the plan.

Find and open a plan

Select a plan in the plans list to open its details.

Prerequisites

  • You are on the plans list.
  • The plan you want to open appears as a row.

Steps

  1. Select the plan row in the list.
    Review the plans list headers before opening a plan

Result: The selected plan opens on its plan details form. Continue to Understand the plan details screen to identify its fields and feature grid.

Understand the plan details screen

The plan details screen is the form where you review the plan's identity, pricing, capacity limits, activity, and feature assignments before you maintain it.

The form displays these fields:

FieldTypeRequiredRule or format
Plan nameText boxYesRequired; the name uses the no-special-character pattern validation.
Plan PriceNumber box with a currency pickerNoMinimum 0; format #,##0.00.
Users countNumber boxYesMinimum 0; maximum 99; format #,##0.00.
Branches countNumber boxYesMinimum 0; maximum 99; format #,##0.00.
Teams countNumber boxYesMinimum 0; maximum 99; format #,##0.00.
Roles countNumber boxYesMinimum 0; maximum 99; format #,##0.00.
ActiveCheckboxNoSelect it to mark the plan active.

The feature grid appears when the feature list contains rows. Its visible columns are:

ColumnWhat it represents
SelectedWhether the feature is selected for the plan.
FeatureThe feature name.

After identifying the fields and grid, maintain the plan values.

Maintain a plan

Use this procedure to change plan values and feature assignments, then save the changes.

Prerequisites

  • The plan details form is visible.
  • You know the plan name, price, and capacity limits to enter.
  • The feature grid is visible if you need to change feature assignments.

Steps

  1. Enter the applicable values in the plan fields.

    FieldValue to enter
    Plan nameEnter a value that meets the required and pattern rules.
    Plan PriceEnter a value from 0 upward.
    Users countEnter a value from 0 through 99.
    Branches countEnter a value from 0 through 99.
    Teams countEnter a value from 0 through 99.
    Roles countEnter a value from 0 through 99.
  2. Select Active when the plan must be active.

  3. Select a feature row in the feature grid to change its selection.

  4. Select Save.

The numeric fields accept values from 0 through 99 where the field defines both bounds. Plan Price accepts values from 0 upward. A change makes Save available; restoring the original values makes Save unavailable again.

Result: The plan is saved with the entered values, and the returned plan replaces the values currently held on the screen.

When loading, saving, or validating goes wrong

Use the message text to identify the condition and the corrective action.

MessageWhen it appearsWhat to do
This Field Is RequiredA required field is empty when validation runs.Enter a value in Plan name, Users count, Branches count, Teams count, or Roles count.
Just '_'‘-''.' And '&' Characters AcceptedPlan name contains a character outside the accepted pattern.Replace the unsupported character in Plan name.
An error occurred while processing your requestLoading the plan, saving the plan, or loading the feature list returns an error.Check the request and retry the operation.

After maintaining a plan

After Save completes, the returned plan replaces the values held on the screen. Use Plans to return to the plans list, or use Company features when the feature definitions themselves need maintenance.

Continue with the plans list after saving, or remain on the record to review the returned values.

Was this page helpful?

Download as PDF
Plan details — PAMS Fresh Generation