Versions Compared

Old Version 15

changes.mady.by.user Persia Xenopoulou

Saved on

compared with

New Version Current

changes.mady.by.user Persia Xenopoulou

Saved on

Key

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

Back to Subscriptions Main Page

Excerpt
hiddentrue

Learn how you can to configure and execute Deactivate Subscriptions in Grace Runs

What does this section cover?

Definition that is used to deactivate Subscriptions with not enough funds, coming out of Grace for Releases up to CRM.COM R10

Note

Status
colourGreen
titleApplicable up to CRM.COM R10
- The process is available for releases up to CRM.COM R10.
For a description of the Deactivation Process for releases after CRM.COM R10 visit Using Deactivate Normal Subscriptions Run Definitions (for Normal Subscriptions) and Using Deactivate Prepaid Subscription Run Definitions (for Prepaid Subscriptions)

Panel
nameblue

Table of Contents

Table of Contents
minLevel2

Navigating to Deactivate Subscriptions in Grace Definitions

What are Deactivate Subscriptions in Grace Runs?

This process is responsible for the deactivation of subscriptions in grace period
Info

BILLING > SUBSCRIPTIONS > DEACTIVATE SUBSCRIPTIONS IN GRACE

What are Deactivate Subscriptions in Grace Definitions?

Deactivate Subscriptions in Grace Definitions, are used to define the rules to be followed,  for the deactivation of Subscriptions in Grace Period which are about to end and they have unsettled debts. The process retrieves all subscriptions Subscriptions in grace period having grace period Grace Period having Grace Period end date equal or past the date that the batch process is performed, and deactivates themdeactivates them, if required.

Each deactivated subscription Subscription is set to life cycle state Life Cycle State “Not Effective", by applying Deactivate Subscription actions, if:

  • Grace End Date ends the day the process is executed
    AND 
  • Criteria defined in the run are met
Note:
Note

If the process is not executed on a daily basis then

you should make use of the

the Grace Period end Date criterion

. Using this criterion the system  will retrieve subscriptions whose Grace period

is used in order for theSystemtol retrieve Subscriptions whose Grace Period ended between the date the

rule

run was executed and the calculated date set by the criterion.

Creating, Editing & Deleting

Run Definitions, must be submitted once created and will be 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 log information will be available in the respective section.

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

  • Navigate to Deactivate Subscriptions in Grace Definitions and explore existing records via the Summary page. 

  • Click on the link (name or number) of the record 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 Subscriptions in Grace, including each Action's related validations, restrictions, and a description of its system process.  View the Attributes Table for a comprehensive description of the Deactivate Subscriptions in Grace fields.

DEACTIVATE SUBSCRIPTIONS IN GRACEImage Added

Anchor
validations
validations
Validations & Restrictions

ActionValidationsRestrictionsAdditional Information
Create
  • Mandatory Fields must be
providedIf Custom Subscription Actions of Behaviour Code - Deactivate Subscription exist in the system then
  • defined
  • Name and alternative code must be unique
  • INPUT SETTINGS:
    • Subscription Action Type
    • Subscription Sub-Action Type must be selected
  • Not Applicable
  • Not Applicable
Edit
  • Mandatory Fields must be
providedIf Custom Subscription Actions of Behaviour Code - Activate Subscription exist in the system then
  • defined
  • Name and alternative code must be unique
  • INPUT SETTINGS:
    • Subscription Action Type
    • Subscription Sub-Action Type must be selected
  • Not Applicable
When you edit a run the system will create  a new Version of the configured run
  • If there is at least one 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.
Delete
  • Not Applicable
  • Run Definitions cannot be deleted
  • Runs can be deleted as long as they ahve not been executed.
    • if there exists at least one scheduled or completed run for that Definition
    • Not Applicable

     

    Deactivate Subscriptions in Grace Runs attributes 

    Anchor
    attributes
    attributes
    Attributes

    An * indicates a field is mandatory 

    NameDescription
    Main Information
    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
    Cycle State

    The

    life cycle state

    Life Cycle State of the process run definition

    . The supported values are effective and not effective.

    which can be

    • Effective
    • Not effective

    Only effective process run definitions can be used

    Unified CodeAn
    auto generated
    autogenerated 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

    process run definition. New process run definition versions are created each time they are edited, if they are already been used by any process runsScheduled DateThis is a read

    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 you to search and view previous versions of the Definition.

    Scheduled DateA Read-only field which is available once
    you schedule
    a Run
    . The date provided shows
    is scheduled and designates the latest date that the
    run
    Run was executed or is scheduled to be executed on.
    Input Settings
    Subscription Action TypeThe action type that will be used to classify each Deactivate Subscription action that will be applied
    Subscription Sub-Action TypeThe action type that will be used to classify each Deactivate Subscription  action that will be applied
    Scheduling Settings

    Determines when the process run definition should be applied. Process run definitions can be applied ad hoc or on a recurring basis. Scheduling settings hold the following information:

    Throttling Settings

    It determines the maximum number of processed records that should be affected per each run and the interval between each iteration. This is available only if the repeat and advanced repeat options are selected. Throttling settings include the following

      • Maximum batch size
      • Start again after X UOT (seconds, minutes,hours, days)
    Criteria
    Subscription Criteria
    Subscription TypesA selection of
    subscription types
    Subscription Types. Only
    subscriptions
    Subscriptions of that type will be retrieved for processing
    Price PlansA selection of
    price plan
    Price Plan. Only
    subscriptions
    Subscriptions having effective billing terms with one of the selected
    price plan
    Price Plan will be retrieved for processing. If no
    price plans
    Price Plans are specified then all
    price plans
    Price Plans are considered as applicable
    Binding StateA selection
    of binding states which includes
    ofBindingStateswhichincludes three options, any, in binding and out of binding. Only
    subscriptions
    Subscriptions having effective billing terms
    with binding states equal to
    withBindingStatesequalto the selected stated will be retrieved for processing
    Binding PeriodsA selection of
    binding periods
    Binding Periods. Only
    subscriptions
    Subscriptions having effective billing terms in binding, having one of the selected binding will be retrieved for processing. If no
    binding periods
    Binding Periods are specified then all
    binding periods
    Binding Periods are considered as applicable. Specifying
    binding periods
    Binding Periods is not allowed if the
    binding state
    Binding State option is set to any or out of binding
    Billing FrequenciesA selection of
    billing frequencies
    Billing Frequencies. Only
    subscriptions
    Subscriptions having effective billing terms with one of the selected
    billing frequencies
    Billing Frequencies will be retrieved for processing. If no
    billing frequencies
    Billing Frequencies are specified then all
    billing frequencies
    Billing Frequencies are considered as applicable
    Billing Term SchemesA selection of
    billing term schemes
    Billing Term Schemes. Only
    subscriptions
    Subscriptions having effective billing terms of that scheme will be retrieved for processing. If no
    billing term schemes
    Billing Term Schemes are specified then all
    billing term schemes
    Billing Term Schemes are considered as applicable
    Grace Period end DateDetermines the
    grace period
    Grace Period end date in relation to the date of execution, measured in days. If specified then the process will retrieve
    subscriptions
    Subscriptions having a
    grace period
    Grace Period within the date of execution and date of execution minus the specified number of days. This criterion is optional
    Accounts Receivable Criteria
    Accounts Receivable ClassificationA selection of
    accounts receivable classification
    Accounts Receivable Classification. Only
    subscriptions
    Subscriptions owned by
    accounts receivable
    Accounts Receivable classified by one of the selected
    classifications
    Classifications will be retrieved for processing
    Accounts Receivable Credit RatingA selection of
    accounts receivable
    Accounts Receivable credit rating. Only
    subscriptions
    Subscriptions owned by
    accounts receivable
    Accounts Receivable classified by one of the selected credit rating will be retrieved for processing. If no credit ratings are specified then all credit ratings are considered as applicable
    Accounts Receivable Balance

    The range of balance amount which is unsettled. Only

    subscriptions

    Subscriptions owned by

    accounts receivable

    Accounts Receivable having a balance within that range will be retrieved for processing. This amount refers to the Unsettled Amount of all invoices of the account. (Regardless of the Due Date)

    More Than = More than or Equal

    Less Than = Less than

    Accounts Receivable Outstanding Amount

    The range of balance amount which is due. Only

    subscriptions

    Subscriptions owned by

    accounts receivable

    Accounts Receivable having a due balance within that range will be retrieved for processing. This amount refers to the Unsettled Amount of all invoices of the account which are due.

    • Due date is calculated based on the number set at:
      • Due in X Days
      • Due X Days Ago

    If no date is specified then the current date is considered to be the Due date, thus the system will retrieve all unsettled invoices that their due date is before current date

    Deactivation RunsProcess RunsIt displays all the deactivation runs which were performed based on the specific activation run definition and displays all the activation run information as described in the section below

    Configuring a "Deactivate Subscriptions in Grace" Run tailored to your company's needs

  • Navigate to BILLING > SUBSCRIPTIONS > DEACTIVATE SUBSCRIPTIONS IN GRACE
  • Either search for an existing one or from the Top Menu click on NEW
    DEACTIVATE SUBSCRIPTIONS IN GRACEImage Removed

  • MAIN INFORMATION

    1. Provide the following information:

      1. Name
      2. Alternative Code
      3. Description

  • INPUT SETTINGS

    1. Subscription Action Type: Select from the drop down list, if available the subscription action that will be logged for the subscriptions to be deactivated
    2. Subscription Sub-Action Type: Select from the drop down list, if available the subscription sub-action that will be logged for the subscriptions to be deactivated

  • CRITERIA

    1. SUBSCRIPTION CRITERIA

      1. Subscription Types: Click on ADD and search and select the subscription type using the search modal
      2. Billing Term Schemes: Click on ADD and search and select search for the billing term scheme using the search modal
      3. Price Plans: Click on ADD and search and select the price plan using the search modal
      4. Billing Frequencies: Click on ADD and select from the drop down list the required frequencies
      5. Binding Periods: Click on ADD and select from the drop down list the required periods
      6. Binding States: Check the box under the sate you would like to include
        1. Choose between In binding and Out of Binding
      7. Grace Period: Provide an integer value for days
        DEACTIVATE SUBSCRIPTIONS IN GRACE - CRITERIAImage Removed

    2. ACCOUNTS RECEIVABLE CRITERIA

      1. Accounts Receivable Balance: 
        1. More Than: Provide a decimal value for the amount
        2. Less Than: Provide a decimal value for the amount
      2. Accounts Receivable Outstanding Amount: 
        1. More Than: Provide a decimal value for the amount
        2. Less Than: Provide a decimal value for the amount
        3. Due in X days: Provide an integer value for the days
        4. Due X days Ago: Provide an integer value for the days
      3. Accounts Receivable Calssifications: Click on ADD and search and select the required classifications using the search modal
      4. Accounts Receivable Credit Rating: Click on ADD and select from the drop down list the required Credit Ratings
      DEACTIVATE SUBSCRIPTIONS IN GRACE - CRITERIAImage Removed

    • SCHEDULING SETTINGS

    Include PageScheduler Task - GlobalScheduler Task - Global 

    THROTTLING SETTINGS

    Provide the required information

    LOG INFORMATION

    Include PageLog Information - GlobalLog Information - Global

    Executing a Deactivate Subscriptions in Grace Run

    Include PageExecuting Runs - GlobalExecuting Runs - Global

    Modifying a Deactivate Subscriptions in Grace Run

    Include PageVersioningVersioning

    Deleting a Deactivate Subscriptions in Grace Run

    You are not allowed to delete Runs.

    Deleting a scheduled job of the specific Run

    Include PageDeleting a Run- GlobalDeleting a Run- Global

    Reading Deactivate Subscriptions in Grace Run Logs

    Include PageReading Run Logs - GlobalReading Run Logs - Global

     

    NoteVisit Understanding Subscriptions for business examples related to Deactivate Subscriptions in Grace Runs
    Scheduling Setting  
    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 
    Throttling Settings

    It determines the maximum number of processed records that should be affected per each run and the interval between each iteration. This is available only if the repeat and advanced repeat options are selected. Throttling settings include the following

    • Maximum batch size
    • Start again after X UOT (seconds, minutes,hours, days)
  • From the Top Menu click on Save
    • Process Runs
    Process RunsDisplays the Runs  that were executed for this Definition. Each Run includes the Bills that were processed. In case of an error, the error code and description are displayed
    Log Information
    Log DetailsThe standard set of Log Details information available in all entities
    Panel
    namegrey

    Related Areas

    Filter by label (Content by label)
    excerpt
    showLabelsfalse
    spacesV4Manual
    showSpacefalsetrue
    labelssubscriptions-basics-r7,subscriptions-advanced-r7,subscriptions-admin-r7

    Popular Labels

    spaceKey
    Panel
    namegrey
    Popular Labels

    Helpful Links

    Filter by label (Content by label)
    heatmap
    showLabelsfalse
    spacesV4Manualstyle
    showSpacefalse
    labelsglobal