Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Back to Subscription Main Page 

Excerpt
hiddentrue

Learn how you can to configure Subscription Business Definition that Definitions that will dictate determine the overall behavior of Subscription

What does this section cover?

behaviour of Subscriptions

Panel
nameblue

Table of Contents

Table of Contents
minLevel2

Navigating to Subscription  Definitions

What are Subscription  Definitions
Info

CONFIGURATION > BILLING APPLICATION > SUBSCRIPTIONS > SET UP BUSINESS DEFINITIONS

What are Subscription Definitions?

A Subscription Definition is a set of business rules and conditions which are used

in order

to create and maintain

subscriptions

Subscriptions throughout their

whole life cycle

Life Cycle. For example, through the Subscription Definitions, you can define the maximum number of

subscriptions

Subscriptions you can have per account

,

or the maximum number of Main

services

Services and Physical products that can be added

on

to a

subscription

Subscription

In addition, through

Subscription Definitions

you can define dependencies on your products

provide a number of restrictions and controls and can be used to define product dependencies. For example

you

, a rule can be set

rules,

where additional channels

will not be allowed to

cannot be added unless one of the Main channels

are

is added first.


In general, Subscription Definitions provide a number of restrictions and controls that will be applied on every subscription from the beginning till the end of its Life Cycle, and which should be met at any stage. 
Multiple Subscription Definitions can be configured in the system but only one can be active at any given time. Subscription Definitions are mandatory and if an active Subscription Definition doesn't exist then no subscription can be created or amended.

A Subscription Definition can be applied on all subscriptions or on specific subscription types.

Creating, Editing & Deleting

 
 

Subscription  Definitions can be edited, deleted and have their Life Cycle State changed.

  • Navigate to Subscription  Definitions and explore existing entries via the Summary page
  • Click on the link (Name or Number) of the entry of your interest to access the Data Entry page and see more detail.

  • Use the Actions Menu to create a NEW Definition, modify (EDIT), or DELETE an existing one.  

  • Use BACK to return to the Summary page and CANCEL to revert any unwanted changes made to the Definition. 

  • Click on the Audit Log button to view a log of changes performed on the displayed Subscription  Definition.

Check the Validations & Restrictions Table below for a list of available Actions when working with Subscriptions, including each Action's related validations and restrictions.View the Attributes Table for a comprehensive description of the Subscription Definition fields.

SUBSCRIPTION DEFINITIONSImage Added

Anchor
validations
validations
Validations & Restrictions

ActionValidationsRestrictions
General
  • Multiple Subscription definitions can exist in the system, but each one should have a unique name and alternative code
  • Only one active Subscription  definition can exist at any given time
  • If no active Subscription definition exists, then no Subscription can be created
Create
  • Mandatory Fields must be defined
  • Name and alternative code must be uniqueAlternative Code must beunique
  • Not Applicable
Edit
  • Mandatory Fields must be defined
  • Name and alternative code must be uniqueAlternative Code must beunique
  • Not Applicable
Delete
  • Not Applicable
  • Cannot be deleted if its the active definition
Subscription  Definition attributes 
  • 'Active' Definition

Anchor
attributes
attributes
Attributes

An * indicates a field is mandatory 

 

Name

Description

Main Information
 Name*
 The
The name of the
definition
Definition.
Description
 A
A description of the
definition
Definition.
 Alternative
Alternative Code*
 The
The alternative code of the
definition State The
Definition. Unless otherwise specified, the Alternative Codes for new entries default to the Name initials in capital letters.
StateThe state of the
definition
Definition which can be
active or inactive
'Active' or 'Inactive'. Only one
definition
Definition can be
active
'Active' at any given time.
Subscription Rules
Restrictions

Subscription

restrictions

Restrictions control the number of

subscriptions

Subscriptions that can be owned by the same

account

Accounts Receivable, based on a set of rules. The criteria that can be used to build each rule include the following:

The
  • Subscription Criteria
    • Subscription Type
The
    • Subscription Life Cycle State
  • Criteria for each Accounts Receivable
    • The Accounts Receivable Classification
    • The Accounts Receivable Credit rating
  • Maximum Number of Subscriptions: The maximum number of Subscriptions meeting the Subscription Criteria, allowed to be created per Accounts Receivable meeting the Accounts Receivable Criteria

 

In the following example the System is set to allow:

  • 1 Subscription per Accounts Receivable with Employee Classification
  • 3 Subscriptions per Accounts Receivable with Residential Classification
  • 5 Subscriptions per Accounts Receivable regardless of the account's Classification


Subscription RestrictionsImage Added

Service Rules
Restrictions
Service Restrictions

Service

restrictions

Restrictions control the number of

services

Services that can be added either

on a subscription

to one or

on

all

subscriptions

Subscriptions owned by the same

accounts receivable. Service restrictions are a set of rules which are build based on the following criteria:
  • Scope which can be "Subscription" or "Accounts Receivable"
  • Minimum number of mandatory services

    Accounts Receivable.

    • Scope: The scope by which the conditions will be set.
      • "Subscription": The rule will apply to the Services of a single Subscription.
        or
      • "Accounts Receivable":  The rule will apply to the sum of the Services of all the Subscriptions owned by the Accounts Receivable.
    • Restrictions:
      • Minimum number of mandatory Services that should exist
      • Maximum number of mandatory
    services
      • Services that should exist.
      • Minimum number of optional
    services
      • Services that should exist.
      • Maximum number of optional
    services
      • Services that should exist

    Only termed, usage and expense services are allowed to be added in that list
      • .
    Dependencies
    Service Dependencies

    Service

    dependencies

    Dependencies control the

    type

    Type of

    services

    Services that can co-exist either on a

    subscription

    Subscription or

    on subscriptions

    Subscriptions owned by the same

    accounts receivable. Service dependencies are a set of rules which are build based on the following criteria: 
  • Scope which can be "Subscription" or "Accounts Receivable"
  • The Services having prerequisites
  • The Service Types having prerequisites
  • The Prerequisites, which is a set of either ten services, ten service types, ten traceable physical goods or ten traceable physical good types. The prerequisites definition includes an option to specify if all the specified values should exists

    Accounts Receivable.

    • Product or Product Type: Must be either Termed Services or Expenses.
    • Scope: The scope by which the conditions will be set.
      • "Subscription": The rule will apply to Services of a single Subscription.
        or
      • "Accounts Receivable": The rule will apply to the Services of all the Subscriptions owned by the Accounts Receivable.
    • Type of Prerequisites, can be one of the following:
      • Services (Only Termed Services and Expense are allowed to be added to the list).
      • Service Types (Only Termed Services and Expense are allowed to be added to the list).
      • Traceable Physical Goods.
      • Traceable Physical Good Types.
    • Prerequisites: Up to 10 Prerequisites can be added from the same Type. There is also the option to define whether all the specified values or if at least one of the
    specified
    • values should
    exist
    Only termed, usage and expense services are allowed to be added in that list
    • be present.
    Restrictions Per Distributor
    Service Restrictions Per Distributor

    Service

    restrictions

    Restrictions per

    distributor

    Distributor control the number of

    services

    Services that can be distributed

    per

    by each

    provisioning distributor. Service restrictions per distributor are a set of rules which are build based on the following criteria

    Provisioning Distributor.

    • Provisioning Distributor: The Provisioning Distributor on which the restrictions should be applied.
    • Restrictions:
      • Minimum number of mandatory
    services
      • Services that should exist.
      • Maximum number of mandatory
    services
      • Services that should exist.
      • Minimum number of optional
    services
      • Services that should exist.
      • Maximum number of optional
    services
      • Services that should exist
  • Provisioning distributor on which the rule will apply to
  • Only termed, usage and expense services are allowed to be added in that list

      • .
    Dependencies Per Distributor
    Service Dependencies Per Distributor

    Service

    dependencies per distributor

    Dependencies Per Distributor control the

    type of services

    Services that can be distributed on the same

    provisioning distributor. Service dependencies per distributor are a set of rules which are build based on the following criteria: 
    • The provisioning distributor having prerequisites
    • The Prerequisites, which is a set of either ten services or ten service types. The prerequisites definition includes an option to specify if all the specified values should exists or if at least one of the specified values should exist

    Only termed, usage and expense services are allowed to be added in that list

    Installed Item Restrictions

    Installed Item restrictions control the number of installed items that can be added either on a subscription or on all subscriptions owned by the same accounts receivable. Service restrictions are a set of rules which are build based on the following criteria:

    • Minimum number of installed items that should exist per traceable physical good type
    • Maximum number of installed items that should exist per traceable physical good type
    • Scope which can be "Subscription" or "Accounts Receivable"
    Installed Item Dependencies

    Installed Item dependencies control the type of Installed Item that can co-exist either on a subscription or on subscriptions owned by the same accounts receivable. Installed Item dependencies are a set of rules which are build based on the following criteria:

  • The physical good having prerequisites
  • The physical good type having prerequisites
  • The Prerequisites, which is a set of ten traceable physical goods or ten traceable physical good types. The prerequisites definition includes an option to specify if all the specified values should exists

    Provisioning Distributor.

    • Provisioning Distributor: The Distributor on which the dependency rules should be applied.
    • Type of Prerequisites, can be one of the following:
      • Services (Only Termed Services and Expense are allowed to be added to the list).
      • Service Types (Only Termed Services and Expense are allowed to be added to the list).
    • Prerequisites: Up to 10 Prerequisites can be added from the same Type. There is also the option to define whether all the specified values or if at least one of the
    specified
    • values should
    exist
  • Scope which can be "Subscription" or "Accounts Receivable"
  • Installed Item Restrictions Per Distributor

    Installed Item restrictions per distributor control the number of Installed Items that can be distributed per each provisioning distributor. Installed Item restrictions per distributor are a set of rules which are build based on the following criteria:

    • Minimum number of installed items that should exist per traceable physical good type
    • Maximum number of installed items that should exist per traceable physical good type
    • Provisioning distributor on which the rule will apply to
    Installed Item Dependencies Per Distributor

    Installed Item dependencies per distributor control the type of Installed Items that can be distributed on the same provisioning distributor. Installed Item dependencies per distributor are a set of rules which are build based on the following criteria: 

    • The provisioning distributor having prerequisites
    • The Prerequisites, which is a set of either ten traceable physical goods or ten traceable physical good types. The prerequisites definition includes an option to specify if all the specified values should exists or if at least one of the specified values should exist
    TiersDefines the allowed swaps between subscription services and provides information about the type of the change
    • be present.
    Tiers
    Tiers

    Tiers are directly related to the Subscription Action 'Swap Services' and determine the swaps that can take place between Subscription Services and provides information on the Type of modification (i.e. if it

    is

    constitutes an upgrade

    /

    or downgrade

    etc

    ).

      Subscription services tiers are two dimensional,


    Subscription Service Tiers aretwo dimensional; the first dimension is the

    tier level

    Tier Level and the second dimension is the

    tier path

    Tier Path.

    • The
    path
    • Path defines a set of
    subscription services
    • Subscription Services, which can replace each other. Subscription
    services
    • Services can be replaced only by
    subscription services
    • other Services under the same
    path
    • Path.
    • The
    level characterizes
    • Level characterises the
    applied
    • replacement (i.e. if it
    is
    • constitutes an upgrade or downgrade)
    ,
    • and
    it
    • is defined within each
    tier path
    • Tier Path.

    Tier

    paths

    Paths can be related to a single root

    path. In that case the system will automatically apply replacements or removals of subscription services

    Path, in which case, the System will suggest replacements of Subscription Services belonging to a child

    path

    Path, whenever a

    subscription service, belonging to the root path and having the same level, is replaced or removed

    Subscription Service of the same Level is replaced.

    Example

     

    Level

    Path 1

    Not following any

    path

    Path

    Root Path of Path 2

    Path 2

    Following: Path 1

    Child Path of Path1

    Path 3

    Not following any

    path

    Path

    Level 1

    10

    A1

    B1

    C1

    Level 2

    20

    A2

    B2

    C2

    Level 3

    30

    A3

    B3

     

    Level 4

    40

     

    B4

     

    40 B5 

     

    Based on the

    subscription service tiers

    Subscription Service Tiers specified above the following

    scenarios are supported

    events can take place:

    • A1, A2, A3 can replace each other.
    • B1, B2, B3, B4 can replace each other.
    • C1, C2 can replace each other.
    • Going from A1 to A2 or A3 is considered as a downgrade.
    • Going from A3 to A2 or A1 is considered as an upgrade.
    • Going from B4 to B5 and vice versa is considered a swap.
    • If a
    subscription
    • Subscription has A1, B1 and C1 then a change from A1 to A2 will
    trigger
    • suggest a change from B1 to B2, but it will not
    trigger
    • suggest a change from C1 to C2
  • If a subscription has A1, B1 and C1 then removing A1 will trigger the removal of B1, but it will not trigger the removal of C1
  • Based on the subscription service tiers
    • .

    Based on the Subscription Service Tiers specified above the following

    scenarios are not supported

    events cannot take place:

    • Subscription
    services
    • Services belonging to
    path
    • Path 1 cannot replace or be replaced by
    subscription service
    • a Subscription Service belonging to
    path
    • Path 2 or
    path
    • Path 3
    • Subscription
    services
    • Services belonging to
    path
    • Path 2 cannot replace or be replaced by
    subscription service
    • a Subscription Service belonging to
    path
    • Path 1 or
    path
    • Path 3
    • Subscription
    services
    • Services belonging to
    path
    • Path 3 cannot replace or be replaced by
    subscription service
    • a Subscription Service belonging to
    path
    • Path 1 or
    path 2

    Defining your own Subscription  Definition tailored to your company's needs

     

  • Navigate to CONFIGURATION > BILLING APPLICATION > SUBSCRIPTIONS > SET UP BUSINESS DEFINITIONS
  • Either search for an existing one or from the Top Menu click on NEW
    SUBSCRIPTION DEFINITIONSImage Removed
  • MAIN INFORMATION 

    1. Provide information for the following fields

      1. Name
      2. Description
      3. Alternative Code
  • SUBSCRIPTION RULES

    RESTRICTIONS

  • Click on ADD and provide restrictions.
    You have the option to create multiple restrictions. Each row/record is not related with the other records. i.e. Whenever a subscription is created, each of the records will be validated separately. If the subscription does not meet the conditions defined in at least one record then you will not be allowed to create the definition. If a condition is not selected at all then all are taken into consideration.

  • For each record you must define at least one condition and define the maximum number of subscriptions allowed per combination
  • Subscription Type: Select from the drop down list a subscripton type
  • Subscription Life Cycle State: Select from the drop down list a Life Cycle State
  • Accounts Receivable Classification: Select from the drop down list an account classification
  • Accounts Receivable Credit Rating: Select from the drop down list a
  • Maximum Number of Subscriptions: Define the number of subscriptions allowed by a contact for the specified combinations
  • SERVICE RULES

    1. RESTRICTIONS

    2. DEPENDENCIES

    3. RESTRICTIONS PER DISTRIBUTOR

    4. DEPENDENCIES PER DISTRIBUTOR

    5. TIERS

  • INSTALLED ITEM RULES

  • LOG INFORMATION

    Include PageLog Information - GlobalLog Information - Global
  • From the Top Menu click on Save
  • Deleting Subscription  Definitions

    Include PageDeleting a record - GlobalDeleting a record - Global

    Changing the Life Cycle State of Subscription  Definition

    Include PageChanging the Life Cycle State of a Definition - GlobalChanging the Life Cycle State of a Definition - Global

     

    NoteVisit /wiki/spaces/WIP/pages/10010220 Subscription for business examples related to
    • Path 2
    Installed Item Rules 
    Restrictions
    Installed Item Restrictions

    Installed Item Restrictions control the number of Installed Items that can be added either to one or all Subscriptions owned by the same Accounts Receivable.

    • Scope: The scope by which the conditions will be set.
      • "Subscription": The rule will apply to Installed Items of a single Subscription.
        or
      • "Accounts Receivable": The rule will apply to the sum of the Installed Items of all the Subscriptions owned by the Accounts Receivable.
    • Physical Good Type: The Traceable Physical Good Type on which the restrictions for the number of the Installed Items will be applied.
    • Restrictions:
      • Minimum number of Installed Items that should exist per traceable Physical Good Type.
      • Maximum number of Installed Items that should exist per traceable Physical Good Type.
    Dependencies
    Installed Item Dependencies

    Installed Item Dependencies control the Type of Installed Item that can co-exist either on a Subscription or Subscriptions owned by the same Accounts Receivable.

    • Product or Product Type: can only be Traceable Physical Goods.
    • Scope: The scope by which the conditions for the selected Product or Product Type will be set.
      • "Subscription": The rule will apply to Physical Goods of a single Subscription.
        or
      • "Accounts Receivable": The rule will apply to the Physical Goods of all the Subscriptions owned by the Accounts Receivable
    • Type of Prerequisites, can be one of the following:
      • Traceable Physical Goods
      • Traceable Physical Good Types
    • Prerequisites: Up to 10 Prerequisites can be added from the same Type. There is also the option to define whether all the specified values or if at least one of the values should be present.
    Restrictions Per Distributor
    Installed Item Restrictions Per Distributor

    Installed Item Restrictions per Distributor control the number of Installed Items that can be distributed by each Provisioning Distributor.

    • Provisioning Distributor: The Provisioning Distributor on which the restrictions should be applied.
    • Physical Good Type: The Traceable Physical Good Type on which the restrictions for the number of the Installed Items will be applied.
    • Restrictions:
        • Minimum number of Installed Items that should exist per traceable Physical Good Type
        • Maximum number of Installed Items that should exist per traceable Physical Good Type
    Dependencies Per Distributor
    Installed Item Dependencies Per Distributor

    Installed Item dependencies per Distributor control the type of Installed Items that can be distributed on the same Provisioning Distributor.

    • Provisioning Distributor: The Distributor on which dependency rules should be applied.
    • Type of Prerequisites can be one of the following
      • Traceable Physical Goods
      • Traceable Physical Good Types
    • Prerequisites: Up to 10 Prerequisites can be added from the same Type. There is also the option to define whether all the specified values or if at least one of the values should be present.
    Log Information
    Log DetailsThe standard set of Log Details information available in all entities.
    Panel
    namegrey

    Related Areas

    Filter by label (Content by label)
    showLabelsfalse
    spacesV4Manual
    showSpacefalseexcerpttrue
    labelsmodulenamesubscriptions-basics-r7,modulenamesubscriptions-advanced-r7,modulenamesubscriptions-admin-r7

     

    Popular Labels

    heatmap
    Panel
    namegrey
    Popular Labels
    spaceKeyV4Manual
    style

    Helpful Links

    Filter by label (Content by label)
    showLabelsfalse
    spacesV4Manual
    showSpacefalse
    labelsglobal