Packages Screen

Last verified with: 10.8.6.0

Overview #

The Packages screen is used to define the packages that can be sold from the product catalog. A package is made up of one or more services and can contain multiple package frequencies so the same package can be offered on different billing intervals.

This screen is where you define the package itself, choose its default status, control which currencies it supports, attach services, configure package-level options, review bucket-sharing behavior, and maintain package custom fields.

Prerequisites #

• Services must be configured before packages can be set up.
• Package statuses must be configured before packages can be set up.
• Currencies must be configured so package frequencies can be priced correctly.
• Rate plans are required if package services or frequencies will use usage rate plans.
• Package contracts are required if package frequencies will use contract terms.

Packages Panel #

The Packages panel on the left displays the packages that already exist in the product catalog. Select a package to load its details in the edit panel on the right.ilable in this panel which are shown as icons above the Filter text box. The available actions are described below.

Actions #

Icon	Description
	Deletes the selected package if not in use (added to an account)
	Adds a new package

Packages List #

The package list shows the packages currently configured in the catalog. Selecting a package opens its full configuration on the right.

Edit Package Panel #

The panel on the right displays the selected package and is where you maintain its main configuration.

Main Fields #

• Name: The package name.
• Start Date: The date the package becomes available in the product catalog.
• Expiry Date: The date the package is retired from new use in the product catalog.
• Description: An optional description of the package.
• Default Account Package Status: The status applied by default when the package is added to an account.
• Currencies: The currencies that can be used by package frequencies under this package.

Frequencies Tab #

The Frequencies tab is used to manage the package frequencies that belong to the package.

Each frequency row shows:

• Frequency Name: The name of the package frequency.
• Bill Frequency: The billing interval used by that frequency.

Frequency Actions #

• Add Frequency: Opens the package frequency screen to create a new frequency.
• Edit: Opens the selected frequency.
• Delete Frequency: Removes the selected frequency.

Package frequencies are where service pricing, price books, contracts, transitions, and many detailed billing settings are maintained.

Services Tab #

The Services tab is used to attach services to the package.

Service Selector #

The service search field lets you find an eligible service and add it to the package.

Service List #

Each row in the service list shows key information about the service on the package, including:

• Service: The service name.
• Service Status: The current default service status for the package service.
• Usage Frequency: The service usage interval when applicable.
• Rate Plan: The usage rate plan currently associated with the service, when one is present.
• Optional: Indicates whether the service is optional on the package.

Editing Package Services #

Editing a package service opens additional configuration such as:

• minimum instances
• maximum instances
• default instances
• dynamic usage class group

Options Tab #

The Options tab is used to define package-level billing behavior and add-on behavior.

Billing Options #

• Charge Full Period: Bills the full recurring amount instead of prorating the initial period.
• Charge Recurring Only If Usage: Applies recurring charges only when related usage occurs.
• Post Paid: Bills the package in arrears.
• Allow Quantity: Allows quantity-based multiplication of eligible recurring or one-time service charges.
• Bill On Account Bill Day: Bills the package on the account bill day instead of its own anniversary.
• Billing Activation Service: Assigns a billing activation service when the package is configured for activation-based billing behavior.

Add-On Type Options #

• Share Plan Add-On: Makes the package eligible to be used as a share plan add-on.
• Global Add-On: Makes the package available as a global add-on package.
• Add-On Eligible: Allows global add-on packages to be attached to account packages created from this package.

Notes About Option Behavior #

• Some option combinations are restricted by package category and by whether services are already configured.
• Certain fields become read-only after the package has been created or referenced by account packages.
• Hidden invoicing fields, such as invoice detail, exist in the screen definition but are not currently exposed in the normal visible layout.

Buckets Tab #

The Buckets tab appears when the package contains usage-based services with buckets.

The bucket list is grouped by service and lets you review bucket configuration that affects package behavior.

For each bucket row, the screen can show:

• Name: The bucket name.
• Recur Frequency or related timing label: The bucket timing behavior.
• Overage Rate Plan: The overage rate plan associated with the bucket, when one is present.
• Shared: Whether the bucket is shared across the package.

The notification action on a bucket row opens the configured bucket notifications for review.

Custom Fields Tab #

The Custom Fields tab displays package custom fields that have been configured for the package entity. These fields are used to store additional package data required by your organization.

Adding Packages #

To add a package:

1. In the Packages panel, click Add.
2. Enter the Name and any other main package details.
3. Select the Default Account Package Status.
4. Select the allowed Currencies.
5. Open the Services tab and add the required services.
6. Review the Options tab and configure the package behavior.
7. If buckets are present, review the Buckets tab.
8. Complete any required values on the Custom Fields tab.
9. Save the package.
10. After saving, add package frequencies on the Frequencies tab.

Editing Packages #

To edit an existing package:

1. Select the package in the Packages panel.
2. Update the main package fields as needed.
3. Maintain services on the Services tab.
4. Maintain package options on the Options tab.
5. Review bucket behavior on the Buckets tab when it is present.
6. Update custom fields if needed.
7. Save the changes.

Deleting Packages #

To delete a package:

1. Select the package in the Packages panel.
2. Click Delete Package.
3. Confirm the deletion when prompted.

Adding Package Frequencies #

To add a package frequency:

1. Select the package.
2. Open the Frequencies tab.
3. Click Add Frequency.
4. Complete the package frequency configuration on the package frequency screen.
5. Save the frequency and return to the package.