Versions Compared

Key

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

Learn how you can configure and execute Deactivate Unsettled Subscriptions Run

What does this section cover?

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 Validations & Restrictions

ActionValidationsRestrictionsAdditional Information
Create
  • Mandatory Fields
    • Name
    • Alternative Code
    fields must be provided
  • If Custom Subscription Actions of Behaviour Code - Deactivate Subscription exist in the system then
    • INPUT SETTINGS:
      • Subscription Action Type
      • Subscription Sub-Action Type must be selected
 
  • Not Applicable
 
  • Not Applicable
Edit
  • Mandatory Fields
  • Name
  • Alternative Codefields must be provided
  • If Custom Subscription Actions of Behaviour Code - Activate Subscription exist in the system then
    • 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.
Delete 
  • Not Applicable
  • Runs cannot be deleted
 
  • Not Applicable

Deactivate Unsettled Subscriptions Run attributes 

NameDescription
Name*The name of the process run definition
Alternative code*The alternative code of the process run definition
DescriptionA description of the process run definition
Life cycle stateThe life cycle state of the process run definition. The supported values are effective and not effective. Only effective process run definitions can be used
Unified CodeAn auto generated code which is used to group the various instances of the process run definitions
VersionAn 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 runs
Log InformationIncludes the standard log information
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

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)
Subscription Criteria
Subscription TypesA selection of subscription types. Only subscriptions of that type will be retrieved for processing
Price PlansA selection of price plan. Only subscriptions having effective billing terms with one of the selected price plan will be retrieved for processing. If no price plans are specified then all price plans are considered as applicable
Binding StateA selection of binding states which includes three options, any, in binding and out of binding. Only subscriptions having effective billing terms with binding states equal to the selected stated will be retrieved for processing
Binding PeriodsA selection of binding periods. Only subscriptions having effective billing terms in binding, having one of the selected binding will be retrieved for processing. If no binding periods are specified then all binding periods are considered as applicable. Specifying binding periods is not allowed if the binding state option is set to any or out of binding
Billing FrequenciesA selection of billing frequencies. Only subscriptions having effective billing terms with one of the selected billing frequencies will be retrieved for processing. If no billing frequencies are specified then all billing frequencies are considered as applicable
Billing Term SchemesA selection of billing term schemes . Only subscriptions having effective billing terms of that scheme will be retrieved for processing. If no billing term schemes are specified then all billing term schemes are considered as applicable
Accounts Receivable Criteria
Accounts Receivable ClassificationA selection of accounts receivable classification. Only subscriptions owned by accounts receivable classified by one of the selected classifications will be retrieved for processing
Accounts Receivable Credit Rating A A selection of accounts receivable credit rating. Only subscriptions owned by 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 owned by 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 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

Process 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" Run tailored to your company's needs

 

  1. Navigate to BILLING > SUBSCRIPTIONS > DEACTIVATE UNSETTLED SUBSCRIPTIONS
  2. Either search for an existing one or from the Top Menu click on NEW
    DEACTIVATE UNSETLED SUBSCRIPTIONS
  3. MAIN INFORMATION

    1. Provide the following information

      1. Name
      2. Alternative Code
      3. Description
  4. 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
  5. 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
          DEACTIVATE UNSETTLED SUBSCRIPTIONS
    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 UNSETTLED SUBSCRIPTIONS
  6. SCHEDULING SETTINGS

    Include Page
    Scheduler Task - Global
    Scheduler Task - Global
     

  7. THROTTLING SETTINGS

    1. Provide the required information
      1. Maximum batch size
      2. Start again after X UOT (seconds, minutes, days)
  8. From the Top Menu click on SAVE
  9. LOG INFORMATION

    Include Page
    WIP:Log Information - GlobalWIP:
    Log Information - Global

    From the Top Menu click on SAVE

Executing a Deactivate Unsettled Subscriptions Run

Include Page
Executing Runs - Global
Executing Runs - Global

Modifying a Deactivate Unsettled Subscriptions Run

Include Page
Versioning
Versioning

Deleting a Deactivate Unsettled Subscriptions Run

You are not allowed to delete Runs

Deleting a scheduled job of the specific Run

Include Page
Deleting a run- Global
Deleting a run- Global

Reading Deactivate Unsettled Subscriptions Run Logs

Include Page
Reading Run Logs - Global
Reading Run Logs - Global


Note

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

Panel
namegrey

Related Areas

Filter by label (Content by label)
showLabelsfalse
spacesV4Manual
showSpacefalse
excerpttrue
labelssubsriptions-basics-r7,subsriptions-advanced-r7,subsriptions-admin-r7

Panel
namegrey

Popular Labels

Popular Labels
spaceKeyV4Manual
styleheatmap