Versions Compared

Old Version 3

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 configure and execute Deactivate Unsettled Subscriptions Run

What does this section cover?

to configure Deactivate Unsettled Subscriptions Definition that is used to deactivate Normal Subscriptions that have unsettled overdue bills for Releases up to CRM.COM R10

Note

Status
colourGreen
titleApplicable up to CRM.COM R10
- For a description of the Deactivate Unsettled Subscription process for releases after CRM.COM R10 visit Using Deactivate Normal Subscriptions Run Definitions

Tip

The Process is applicable only for Subscriptions following a Normal Billing Scheme

Panel
nameblue

Table of Contents

Table of Contents
minLevel2

What are Deactivate Unsettled Subscriptions Runs?

This process is used to retrieve unsettled subscriptions (i.e. subscriptions that have open/unsettled bills), in order to deactivate them. The process can only be applied on “Effective” subscriptions having at least one subscription service in state “Effective”.

Once completed all the subscription services of the subscriptions included are deactivated. Each deactivated subscription service is set to life cycle state “Not Effective” and each deactivated subscription is set to life cycle state “Not Effective", by applying Deactivate Subscription actions.

Creating, Editing & Deleting

Navigating to Deactivate Unsettled Subscriptions Definitions

Info

BILLING > SUBSCRIPTIONS > DEACTIVATE UNSETTLED SUBSCRIPTIONS

What are Deactivate Unsettled Subscriptions Definitions?

Deactivate Unsettled Subscriptions Definitions, are used to define the rules to be followed when executing Runs to deactivate Subscriptions. The decision on which Subscriptions should be deactivated is based on the criteria set on the Definitions, among which, you can find criteria related to the Accounts Receivable Balance and Outstanding Amount. 

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 Unsettled Subscriptions 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 Unsettled Subscriptions, 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 Unsettled Subscriptions fields.

Deativate Unsettled Subscriptions RunsImage Added

Anchor
validations
validations
Validations & Restrictions

ActionValidationsRestrictionsAdditional InformationSystem Processing
Create
  • Mandatory Fields
    • Name
    • Alternative Code
    If Custom Subscription Actions of Behaviour Code - Activate Subscription exist in the system thenmust be defined
  • Name and alternative code must be unique
  • INPUT SETTINGS:
    • Subscription Action Type
    • Subscription Sub-Action Type must be selected
  • Not Applicable
 
  • Not Applicable
 
  • Not Applicable
Edit
  • Mandatory Fields
    • Name
    • Alternative Code
    If Custom Subscription Actions of Behaviour Code - Activate Subscription exist in the system thenmust be defined
  • Name and alternative code must be unique
  • INPUT SETTINGS:
    • Subscription Action Type
    • Subscription Sub-Action Type must be selected
 When you edit a run the system will create  a new Version of the configured run.
Delete 
  • Runs cannot be deleted
 
Deactivate Unsettled Subscriptions Runs attributes 
  • Not Applicable
  • 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
  • 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 disconnection can only be applied on Subscriptions with Life Cycle State set to 'Effective' and that have at least one Subscription Service in Life Cycle State “Effective”
  • Not Applicable
  • Once completed
    • All the Subscription Services of the Subscriptions included 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'

 

Anchor
attributes
attributes
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
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 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

process run definition. New process run definition versions are created each time they are edited, if they are already been used by any process runsLog InformationIncludes the standard log informationThrottling 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)

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 a Run is scheduled and designates the latest date that the 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 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 Processes
Criteria
Subscription Criteria
Subscription TypesA selection of
subscription
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
Binding States which includes 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
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 Rating
 A
A selection of
accounts receivable credit rating
Accounts Receivable Credit Rating. Only
subscriptions
Subscriptions owned by
accounts receivable
Accounts Receivable classified by one of the selected
credit rating
Credit Rating will be retrieved for processing. If no
credit ratings
Credit Ratings are specified, then all
credit ratings
Credit Ratings are considered as applicable
Accounts Receivable Balance

The range of

balance

Balance amount which is

due

unsettled. Only

subscriptions

Subscriptions owned by

accounts receivable

Accounts Receivable having a

due balance

Balance within that range will be retrieved for processing.

Two options are supported:
  • Fixed Amount: A fixed amount is specified
  • Credit Limit: Retrieves accounts receivable which have exceeded the credit limit specified on the accounts receivable
Accounts Receivable Credit PeriodThe number of days that the account is in debt. Only subscriptions owned by accounts receivable having a debt which is overdue by at least the specified days will be retrieved for processingProcess Runs
Deactivation Run informationIt 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 Unsettled Subscriptions Runs tailored to your company's needs

 

  • Navigate to BILLING > SUBSCRIPTIONS > ACTIVATE SETTLED SUBSCRIPTIONS
  • Either search for an existing one or from the Top Menu click on NEW
    DEACTIVATE UNSETLED SUBSCRIPTIONSImage 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

  • 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 Inbinding and Out of Binding
        DEACTIVATE UNSETTLED SUBSCRIPTIONSImage Removed

    • ACCOUNTS RECEIVABLE CRITERIA

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

    SCHEDULING SETTINGS

    Include PageScheduler Task - GlobalScheduler Task - Global 

    THROTTLING SETTINGS

    Provide the required information

    Executing a Deactivate Unsettled Subscriptions Runs

    Include PageExecuting Runs - GlobalExecuting Runs - Global

    Modifying a Deactivate Unsettled Subscriptions Runs

    Include PageVersioningVersioning

    Deleting a Deactivate Unsettled Subscriptions Runs

    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 Unsettled Subscriptions Runs Logs

    Include PageReading Run Logs - GlobalReading Run Logs - Global
    Note

    Visit /wiki/spaces/WIP/pages/10010220 Subscriptions for business examples related to Deactivate Unsettled Subscriptions Runs

    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 owned by 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

    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)

    LOG INFORMATION

    Include PageWIP:Log Information - GlobalWIP:Log Information - Global
  • 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 Subscriptions that were processed.Incase 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
    showSpacefalse
    excerpttrue
    labelsmodulenamesubsriptions-basics-r7,$modulenamesubsriptions-advanced-r7,modulenamesubsriptions-admin-r7

    Popular Labels

    heatmap
    Panel
    namegrey
    Popular Labels
    spaceKeyV4Manual
    style

    Helpful Links

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