Versions Compared

Old Version 5

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 Take Subscriptions Out of Short Term Deactivation Run

What does this section cover?

Take Subscription Out of Resting Definition that is used to disconnect Subscriptions that are about to come out of Resting but have unsettled balance 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

What are Take Subscriptions Out of Short Term Deactivation Runs?

When a Subscription is in Short Term Deactivation then it will be automatically activated at the short term deactivation end date.

This process is responsible to retrieve any subscriptions that are about to come out of Short Term Deactivation and should be disconnected 

Navigating to Take Subscription Out of Resting Definitions

Info

BILLING > SUBSCRIPTIONS > TAKE SUBSCRIPTIONS OUT OF RESTING

What are Take Subscription Out of Resting Definitions?

Take Subscription Out of Resting Definitions, are used to define the rules to be followed when a Subscription which is still in Resting, should be disconnected once coming out of Resting instead of activated based on the Activation Conditions set in the active Billing Term Definition

The process retrieves:

  • All subscriptions in Short Term Not Effective state 
  • Short term deactivation end date equal or past the date that the batch process is performed, 
  • Life cycle state period not ended by an end short term deactivation action
    • Any additional criteria defined in the batch process
    Note that the process will need to
    Info
    Note

    The run must be executed before the

    Short Term Deactivation

    Resting End date has been reached, because, if a

    subscription

    Subscription with unsettled balance, comes out of

    short term deactivation

    resting and becomes

    effective

    Effective,before the process is executed, then it will only be disconnected once the

    actual

    deactivation run is executed.

    To

    avoid this

    handle cases weretheabove scenario happened, you have the option to define the number of

    days

    days (

    Short term deactivation

    Resting end X days ago)

    the system

     the System should go back and retrieve

    subscriptions that their Short Term Deactivation had

    Subscription that their Resting had ended; (the

    system

    System will find any

    subscriptions

    Subscription between current date and the calculated date and will check for any

    subscriptions

    Subscription that came out of

    Short Term Deactivation date

    Resting within those days) 

    Note: The disconnection will be applied at the date of execution and not the date that it came out of

    Short Term Deactivation

    Resting.

    Note: If you do not set the above criterion the

    system

    System will retrieve

    subscriptions whose Short Term Deactivation date

    Subscription whose Resting ends the day that the process is executed

    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

    Creating, Editing & Deleting

    (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 Take Subscription Out of Resting 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 Take Subscription Out of Resting, including each Action's related validations, restrictions, and a description of its System process.  View the Attributes Table for a comprehensive description of the Take Subscription Out of Resting fields.

    Take Subscriptions out of Resting RunsImage Added

    Anchor
    validations
    validations
    Validations & Restrictions

    NameDescription fields providedIf Custom Subscription Actions of Behaviour Code - Deactivate Subscription exist in the system thenNot Not fields providedIf Custom Subscription Actions of Behaviour Code - Deactivate Subscription exist in the system then
    ActionValidationsRestrictionsAdditional InformationSystem Processing
    Create
    • Mandatory
    • Fields must be
    • defined
    • Name and alternative code must be unique
    • INPUT SETTINGS:
      • Subscription Action Type
      • Subscription Sub-Action Type must be selected
    • Resting Period only takes Integer values
    •  Not Applicable
    •  Not Applicable
    Edit
    • Mandatory
    • Fields must be
    • 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.
    • Resting Period only takes Integer values
    • 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.
    •  Not Applicable
    Delete
    • Not Applicable
    • Runs Run Definitions cannot be deleted if there exists at least one scheduled or completed run for that Definition
    • Not Applicable
    •  Not Applicable

     

    Take Subscriptions Out of Short Term Deactivation Run attributes

    Short term deactivation end X days agoDetermines the short term deactivation period end date in relation to the date of execution, measured in days. If specified then the process will retrieve subscriptions having a short term deactivation period end date within the date of execution and date of execution minus the specified number of days. This criterion is optional.

    Submit
    • Not Applicable
    • Subscription to be considered by the run are:
      • Subscription in Resting Life Cycle State
      • Having Resting End date equal or past the date, that the batch process is performed, and no applied resting end action
      • Any additional criteria defined in the batch process
    • Not Applicable
    • Deactivate Subscription actions will be applied to the Subscription that should be disconnected on coming out of their Resting Period

     

    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
    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. The supported values are effective and not effective. Only effective process run

    Life Cycle State of the process run definition which can be

    • Effective
    • Not effective

    Only effective process run definitions can be used

    Unified Code
    An auto generated code which
    Anautogeneratedcodewhich 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 Type
    SubscriptionSub ActionTypeThe action type that will be used to classify each  Deactivate Subscription action that will be applied
    Scheduling SettingsDetermines when the process run definition should be applied. Process run definitions can be applied ad hoc or on a recurring basis. Made up from the 4 standard ProcessesThrottling 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
    Subscription of that type will be retrieved for processing
    Price PlansA selection of
    price plan
    Price Plan. Only
    subscriptions
    Subscription 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
    Subscription having effective billing terms with
    binding states
    Binding States equal to the selected stated will be retrieved for processing
    Binding PeriodsA selection of
    binding periods
    Binding Periods. Only
    subscriptions
    Subscription 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
    Subscription 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
    Subscription 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
    Short term deactivation end
    Resting ended X days agoDetermines the
    short term deactivation period
    Resting Period end date in relation to the date of execution, measured in days. If specified then the process will retrieve
    subscriptions
    Subscription having a
    short term deactivation period end date
    Resting Period within the date of execution and date of execution minus the specified number of days. This criterion is optional
    .
    Activation RunsProcess RunsIt displays all the activation 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 "Take Subscriptions Out of Short Term Deactivation" Run tailored to your company's needs

  • Navigate to BILLING > SUBSCRIPTIONS > TAKE SUBSCRIPTIONS OUT OF Short Term Deactivation
  • Either search for an existing one or from the Top Menu click on NEW
    Take Subscriptions out of Short Term DeactivationImage 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. Short Term Deactivation Period: Proide an integer value for the days
        Image 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 Take Subscriptions Out of Short Term Deactivation Run

    Include PageExecuting Runs - GlobalExecuting Runs - Global

    Modifying a Take Subscriptions Out of Short Term Deactivation Run

    Include PageVersioningVersioning

    Deleting a Take Subscriptions Out of Short Term Deactivation Run

    You are not allowed to delete any runs

    Deleting a scheduled job of the specific Run

    Include PageDeleting a Run- GlobalDeleting a Run- Global

    Reading Take Subscriptions Out of Short Term Deactivation Run Logs

    Include PageReading Run Logs - GlobalReading Run Logs - Global
    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
    ThrottlingThrottling:  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
    Deactivation Run informationDisplays the Runs that were executed for the specific Definition. Each Run includes the Subscriptionthatwere 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 
    Panel
    namegrey

    Related Areas

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

    Popular Labels

    heatmap
    Panel
    namegrey
    Popular Labels
    spaceKeyV4Manual
    style

    Helpful Links

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