Using Deactivate Normal Subscriptions Run Definitions

Owned by Persia Xenopoulou (Deactivated)
Last updated: Apr 21, 2017
6 min read

Back to Subscriptions Main Page

AVAILABLE FROM CRM.COM R11.0.0 - For a description of the Normal Subscription Deactivation Process for releases before CRM.COM R11.0.0 visit Using Deactivate Unsettled Subscriptions Run Definitions

Table of Contents

Navigating to Deactivate Normal Subscriptions Definitions

BILLING > SUBSCRIPTIONS > DEACTIVATE NORMAL SUBSCRIPTIONS

What are Deactivate Normal Subscriptions Definitions?

Deactivate Normal Subscriptions Definitions are used to set the rules for executing Runs that deactivate Subscriptions. The decision for deactivating Subscriptions is based on criteria set in the Definitions including Accounts Receivable Classification, Subscription Type and Frequency.  It can also be defined whether deactivation occurs based on the Outstanding Amount of the Accounts Receivable and/or its Credit Limit.

Run Definitions must be submitted once created and are executed once or on a recurring basis, based on the defined scheduling settings. Once a Definition is executed, a Process Run is logged and once the Run is completed, the information is available in the respective section (Process Runs).

The user has the option to delete the specific run as long as it is not yet executed (still in a 'Draft' state).
A Definition must be in an 'Effective' Life Cycle State to be submitted. The Life Cycle State can be toggled between 'Effective' and 'Not Effective' using the dedicated action.

  • Navigate to Deactivate Normal Subscriptions 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, or submit the Definition. 

  • 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.

Check the Validations & Restrictions Table below for a list of available Actions when working with Deactivate Normal Subscriptions, including each Action's related validations, restrictions, additional information and a description of its system process.  View the Attributes Table for a comprehensive description of the Deactivate Normal Subscriptions fields.

The Deactivate Normal Subscription batch process handles the deactivation of all Normal Subscriptions, including Subscriptions coming out of Grace, Resting and Short Term Deactivation, formerly handled by dedicated batch processes (before CRM.COM R11.0.0).

The Definition should be scheduled for execution on a daily basis, in order to identify and deactivate Subscriptions activated following Short Term Deactivation, Grace and Resting Life Cycle States, which were unqualified as their activation criteria did not meet those set by the Deactivation Definition.

 

Deactivate Normal Subscriptions Run Definitions

Validations & Restrictions

ActionValidationsRestrictionsAdditional InformationSystem Processing
Create
  • Mandatory Fields must be defined.
  • Name and Alternative Code must be unique.
  • Not Applicable
  • NotApplicable
  • Not Applicable
Edit
  • Mandatory Fields must be defined.
  • Name and Alternative Code must be unique.
  • Not Applicable
  • If there is one or more scheduled Run using the same Definition, then a new Run Definition instance is created.  The new Definition will have the same values and Unified Code as the first one, an augmented version number and all the modified information.
  • Not Applicable
Delete
  • Not Applicable
  • Run Definitions cannot be deleted if there exists at least one scheduled or completed Run for that Definition.
  • Not Applicable
  • Not Applicable
Submit
  • Not Applicable
  • The deactivation can only be applied on:
    • Subscriptions with an 'Effective' Life Cycle State which have at least one Subscription Service in an 'Effective' Life Cycle State'.
    • Subscriptions with a Normal Billing Term Scheme.
  • Not Applicable
  • Once completed
    • All the Subscription Services of the included Subscriptions are deactivated using the Deactivation Action and their Life Cycle State is set to 'Not Effective'.
    • Each deactivated Subscription has its Life Cycle State set to 'Not Effective'

 

Attributes

An * indicates a field is mandatory 

NameDescription
Name*The name of the Process Run Definition.
Alternative code*The alternative code of the Process Run Definition. Unless otherwise specified, the Alternative Codes for new entries default to the Name initials in capital letters.
DescriptionA description of the Process Run Definition.
Life Cycle State

The Life Cycle State of the Process Run Definition which can be:

  • 'Effective'
  • 'Not effective'

Only 'Effective' Process Run Definitions can be submitted.

Unified Code

An auto-generated code which is used to group the various instances of the Process Run Definitions.

Version

An auto-generated number which is used to specify the version of each Run Definition. If the version number is already in use by a Run, a new Run Definition version is created each time the Definition is edited. 

The VIEW PREVIOUS VERSIONS link allows the user to search and view previous versions of the Definition.

Scheduled DateA Read-only field which is available once a Run is scheduled and designates the latest date that the Run was executed or is scheduled to be executed on.
Deactivation Method *

The method that will be used to deactivate Normal Subscriptions, which can be selected from the following:

  • Based on Credit Limit
    Deactivates Subscriptions owned by an Accounts Receivable which has exceeded its Credit Limit, regardless of its Outstanding Amount.
  • Based on Outstanding Amount
    Deactivates Subscriptions owned by an Accounts Receivable with an Outstanding Amount which is more than or equal to the specified Outstanding Amount Threshold
  • Based on Credit Limit or Outstanding Amount
    Deactivates Subscriptions owned by an Accounts Receivable which has exceeded its Credit Limit, regardless of its Outstanding Amount
    OR 
    owned by an Accounts Receivable with an Outstanding Amount which is more than or equal to the specified Outstanding Amount Threshold.

  • Based on Credit Limit and Outstanding Amount
    Deactivates Subscriptions owned by an Accounts Receivable which has exceeded its Credit Limit, regardless of its Outstanding Amount
    AND
    owned by an Accounts Receivable with an Outstanding Amount which is more than or equal to the specified Outstanding Amount Threshold.

The Accounts Receivable Outstanding Amount is calculated based on Invoices that are past their due date. 

Outstanding Amount Threshold (Inclusive)

The Outstanding Amount Threshold used if one of the following deactivation method options is selected:

  • Based on Outstanding Amount.
  • Based on Credit Limit or Outstanding Amount.
  • Based on Credit Limit and Outstanding Amount (default option).

The specified amount is inclusive and is calculated based on the Invoices that are past their due date.
It is mandatory only if one of the Deactivation Methods listed above is selected.

Deactivation Type *

AVAILABLE FROM CRM.COM R12.0.0

Defines whether the Subscription will be deactivated (along with all its Services) or only the Subscription's Services will be deactivated. The following options are available:

  • Deactivate Subscriptions: The deactivation process is applied to the whole Subscription

  • Deactivate Services: The deactivation process is applied only to Subscription's Services

    Deactivate Services option is useful when you have services that you do not want to disconnect at no expense.
    To achieve this, make sure you set up in the Allowed Services of the Billing Term Schemes the services that you would not like to deactivate, thus when the Deactivation Process is executed, the defined services will be ignored.
    However, note that when calculating the outstanding amount or the account balance of Subscriptions, these services are taken into consideration.

Logging Method

AVAILABLE FROM CRM.COM R12.0.0

Defines the method to be used for logging process run's results. Two options are available:

  • Log Processed Successfully and Processed with Errors: If selected, both entities successfully processed and failed ones will be logged in the Process Run Log.
  • Log Only Processed with Errors: If selected then only entities which failed to be processed will be logged in the Process Run Log.

Input Settings

If no Subscription Action Types or Sub-Action Types are configured in the System for Deactivation, nothing needs to be defined

 

Subscription Action Type

The Subscription Action Type that will be used to classify each Deactivate Subscription action that will be applied

Subscription Sub-Action TypeThe Subscription Sub-Action type That will be used to classify each Deactivate Subscription  action that will be applied
Criteria
Subscription Criteria

 

If nothing is specified, all Subscription Types and Frequencies are considered

 

Subscription TypesDefines the Subscription Types that are necessary for Subscriptions to be considered for Deactivation.
Billing FrequenciesDefines the Billing Frequencies that are necessary for Subscriptions to be considered for Deactivation.

Accounts Receivable Criteria

If nothing is specified, all Accounts Receivable Classifications are considered

 

Accounts Receivable Classification

Defines the Accounts Receivable Classifications that are to be considered for Deactivation.

Scheduling Settings
Scheduling Settings*

Method - The following options are available:

  • Run Now
  • Run on Specific Date / Time
  • Run Repeatedly
  • Advanced Scheduling

Refer to Scheduler Task for configuration guidelines.

Throttling Settings
ThrottlingDetermines the maximum number of processed entries that should be affected per Run and the interval between each Run. This is available only if the Repeat and Advanced Repeat options are selected. Throttling settings include:
  • Maximum Batch Size
  • Start Again After X UOT (seconds, minutes, hours, days)

Throttling Settings can be configured only if Logging Method is set to 'Log Processed Successfully and Processed with Errors'.

Process Runs
Deactivation Run InformationDisplays the Runs that were executed for the specific Definition. Each Run includes the Subscriptions that were processed. In case of an error, the error code and description is displayed.
Log Information
Log DetailsThe standard set of Log Details information available in all entities.

Related Areas

Helpful Links