Share Plans Screen

Last verified with: 10.8.6.0

Overview #

Share Plans are used to create a shared pool of usage or shared monetary balance that can be consumed by multiple participating services or packages. A share plan becomes useful only after it has both participating entities and at least one configured share plan bucket.

The screen is used to define the share plan itself, specify how participation works, assign the selling service used to activate the plan, and manage the buckets that provide the shared balance.

The screen supports both Usage share plans and Money share plans:

• Usage share plans share bucketed usage such as data, time, or count.
• Money share plans share a monetary balance and track participation by currency.

Prerequisites #

• Services must be configured so they can participate in share plans. A selling service must also exist so the plan can be activated on accounts.
• Packages must be configured if package-level participation is required.
• Base buckets must be configured before share plan buckets can be created.

Share Plans Panel #

The Share Plans panel on the left displays the share plans that already exist in the system. Select a plan to load its details in the edit panel on the right.he edit share plan panel to the right. Actions are also available 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 share plan if not in use (added to an account)
	Adds a new share plan

Edit Share Plan Panel #

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

Main Fields #

• Name: The name of the share plan.
• Default Service Status Type: Defines the default status type applied to the related selling service when the share plan is activated.
• Share Plan Type: Determines whether the plan is a Usage share plan or a Money share plan.
• Active: Controls whether the share plan can be added to new accounts.
• Description: An optional description of the plan.
• Share Level: Determines whether sharing occurs at the account level or at the usage invoicer level.
• Participating Type: Determines whether the plan is configured around participating Service records or participating Package records.
• Selling Service: The selling service used to activate the share plan on accounts.
• Usage Billing Frequency and Unit: Defines the plan’s usage billing cycle.
• Convert Data To Binary: Controls whether data values are displayed and configured using binary units where supported.

Notes About Field Behavior #

• Share Plan Type becomes fixed after the plan is created.
• The plan cannot be activated until it has both at least one bucket and at least one participating service or package.
• Convert Data To Binary is relevant when the share plan uses data-based buckets.

Buckets Tab #

The Buckets tab is used to manage the share plan buckets attached to the plan.

Each row in the bucket list shows key details such as:

• Name: The name of the share plan bucket.
• Bucket Type: The bucket behavior configured for that share plan bucket, such as the bucket setup style used on the share plan bucket record.
• Recur Type: Indicates whether the bucket is nonrecurring, recurring, or recurring with rollover.
• Recur Frequency or Expire After: Shows the active timing rule for the bucket. Recurring buckets show their refill interval, while nonrecurring buckets show the expiry period.
• Type: Shows the bucket base unit type associated with the bucket, such as data, time, or count.

These columns help you quickly understand how each bucket behaves without opening it. They are especially useful when a single share plan contains multiple buckets with different refill and usage characteristics.

Bucket Actions #

• Add: Opens the share plan bucket flow to add a new bucket.
• Edit: Opens the selected bucket for editing.
• Delete: Removes or restores the selected bucket entry from the share plan.

Bucket Notes #

• Usage share plans can contain multiple buckets, subject to the available base unit types.
• Money share plans are more restrictive and do not support the same bucket mix as usage share plans.
• Bucket-level options such as Recur Type, Expire After, Last Tier Repeats, Prorate, Overage Rate Plan, Tier Calculation Type, Allocation, Notifications, and Return To Share Plan are configured on the share plan bucket screen rather than directly on this parent screen.

Participating Tab #

The Participating tab is used to define which services or packages participate in the share plan.

The available participation controls depend on:

• the selected Participating Type
• whether the plan is a Usage share plan or a Money share plan

Usage Share Plan Participation #

For usage share plans, the participation grid lets you add services or packages and define participating limits by supported usage unit types. Depending on the participating unit, the grid can expose fields such as:

• Participating Limit
• the related usage Unit

This is where values such as data, time, and count participation limits are maintained.

Money Share Plan Participation #

For money share plans, participation is maintained by currency. Each participant can have a monetary participating limit per supported currency.

Participation Controls #

• Service or Package selector: Used to choose the participant to add.
• Add: Adds the selected service or package to the participation list.
• Delete: Removes the participant from the share plan.

Adding Share Plans #

To add a share plan:

1. In the Share Plans panel, click Add.
2. Enter the Name.
3. Select the Default Service Status Type.
4. Select the Share Plan Type.
5. Set Active if the plan should be available for use immediately.
6. Complete Description, Share Level, Participating Type, Selling Service, and Usage Billing Frequency as needed.
7. Save the plan.
8. After saving, add at least one bucket on the Buckets tab.
9. Add the participating services or packages on the Participating tab.

Editing Share Plans #

To edit an existing share plan:

1. Select the share plan in the Share Plans panel.
2. Update the editable plan fields.
3. Maintain the bucket configuration on the Buckets tab.
4. Maintain the participant list on the Participating tab.
5. Save the changes.

Deleting Share Plans #

A share plan cannot be deleted while it is still referenced by account-level share plan data. If the goal is to stop new use of the plan without affecting existing account assignments, clear Active instead of deleting the plan.

To delete a share plan:

1. Select the share plan in the Share Plans panel.
2. Click Delete.
3. Confirm the deletion when prompted.

Adding Buckets To Share Plans #

To add a bucket to an existing share plan:

1. Select the share plan.
2. Open the Buckets tab.
3. Click Add.
4. Complete the bucket configuration on the share plan bucket screen.
5. Save the bucket and return to the share plan.