Skip to end of banner
Go to start of banner

Take Subscriptions out of Short Term Deactivation

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

What does this section cover?

What are Take Subscriptions Out of Resting 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 based on the Activation Conditions set in the active Billing Term Definition


Note that the process will need to be executed before the Resting End date has been reached, because, if a subscription with unsettled balance, comes out of resting and becomes effective, before the process is executed, then it will only be disconnected once the actual deactivation run is executed.

To avoid this, you have the option to define the number of days the system should go back and retrieve subscriptions that their resting had ended; however, the disconnection will be applied at the date of execution and not the date that it came out of resting.

Creating, Editing & Deleting Validations & Restrictions

ActionValidationsRestrictionsAdditional Information
Create
  • Mandatory 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 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
  • 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

 

Take Subscriptions Out of Resting 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.
NameDescription
Name*The name of the process run definition
Alternative codeThe 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
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
Activation Runs
Process 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 Resting" Run tailored to your company's needs

  1. Navigate to BILLING > SUBSCRIPTIONS > TAKE SUBSCRIPTIONS OUT OF RESTING
  2. Either search for an existing one or from the Top Menu click on NEW
    TAKING SUBSCRIPTIONS OUT OF RESTING

  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
      7. Resting Period: Proide an integer value for the days
        TAKING SUBSCRIPTIONS OUT OF RESTING- CRITERIA

  6. SCHEDULING SETTINGS

    1. Select from the available options according to what you would like to achieve
      1. RUN NOW: Will be executed once, now 
      2. RUN ON SPECIFIC DATE/TIME: Will be executed once, at the date defined
      3. RUN REPEATEDLY: Will be executed, starting and ending at a defined date/time and will be repeated every X UOT where UOT can be from seconds to Years
      4. ADVANCED SCHEDULING: Will be executed, starting and ending at a defined date with powerful repetition options from daily to yearly

    2. Run Now

      SCHEDULING SETTINGS - RUN NOW
       

    3. Run On Specific Date / Time

      1. Start Process
        1. Click on the calendar select the date and time the run should start being executed. 
          DATE AND TIME SELECTION
        2. Once selected click on "DONE"
          RUN ON SPECIFIC DATE TIME

    4. Run Repeatedly

      1. Start Process - On a Specific Date
        1. Click on the calendar select the date and time the run should start being executed. 
        2. Once selected click on "DONE"
      2. OR Start process - After a period of time
        1. Provide how long after current date/time the process should begin
          START PROCESS - AFTER A PERIOD OF TIME 
      3. Repeat Process
        1. EVERY: Type a number (INTEGER)
        2. UOT: Select between
          1. Seconds
          2. Minutes
          3. Hours
          4. Days
          5. Weeks
          6. Months
          7. Years
            REPEAT - UOT
      4. End Process
        1. Select between
          1. Never End
          2. On a specific date (define the date)
          3. After a period of time (define period of time)
            END PROCESS 

    5. Advance Scheduling

      1. Start Process
        1. Click on the calendar select the date and time the run should start being executed. 
        2. Once selected click on "DONE"
          ADVANCED SCHEDULING 
      2. Repeat Process
        1. Select between
          1. Daily : Define every how many days 
          2. Weekly: Select specific days of the week 
          3. Monthly:Define every how many months or on a specific day of the month
          4. Yearly: Define a specific date/month or a specific day of a month, such as the 1st Sunday of every January
            ADVANCED SCHEDULING - REPEAT PROCESS
      3. End Process
        1. Select between
          1. Never End
          2. On a specific date (define the date)
            ADVANCED - END PROCESS 
     

  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

    Log information section keeps all the logging information related to the specific record

    • Basic set of information available in all entities
      • Created By User: The user that created the entity
      • Created By Unit: The unit of the user that created the entity
      • Updated By User: The user that last updated the entity
      • Updated by Unit: The unit of the user that last updated the entity
      • Date Created: The date the account was entity
      • Date Updated: The date the account was last entity
        LOG DETAILS

Executing a Take Subscriptions Out of Resting Run

  1. Navigate to the definition
  2. Search for the definition you would like to execute
  3. Click on the number of the definition to go to the data entry page
  4. Confirm that SCHEDULING SETTINGS are correctly configured
  5. From the Actions Menu click on ACTIONS > "SUBMIT"
    RUNS - SUBMIT
  6. The job will be submitted to the scheduler and will become available under PROCESS RUNS
    1. Once completed the Life Cycle State will be changed from Draft to Completed
    2. If the Run fails then the Life Cycle State will be updated to Failed
      PROCESS RUN
    3. Check Process Successfully and Processed with Errors for a closer look of individual results 

 

Modifying a Take Subscriptions Out of Resting Run

When you edit a definition that already has completed or scheduled runs then the system will automatically update the Version of the definition, by increasing its number by 1. Essentially, the system will create a new definition and will carry over all the information and configuration, apart from the Version number.

Accessing a definition with multiple versions, you will always see the latest version, while you have the option to View configuration and Runs of Previous versions by using th "VIEW PREVIOUS VERSIONS" link found in the Main Information tab

  1.  Click on the VIEW PREVIOUS VERSIONS link
    VERSIONING 
  2. Search from the modal for the version you would like to see
  3. Select the version
    1. The system will now show the configuration and the process runs of the version you have selected.
  4. To go back to the current version click on the CURRENT VERSION link under Main Information
    CURRENT VERSION 

 

Deleting a Take Subscriptions Out of Resting Run

You are not allowed to delete any runs

Deleting a scheduled job of the specific Run

If you have scheduled (submitted) a Run by mistake or you want to change the definition before execution, you have the option to delete the current job that was sent to the scheduler, given that it has not been executed yet. i.e., Life Cycle State is still Draft.

In order to delete the job follow the steps below:

  1. Navigate to the definition, for which you have scheduled a job
  2. Click on the number of the definition to move in the data entry page
  3. Go to Process Runs tab
  4. Find the job and check the left box next to the Run
  5. Click on "DELETE"


  6. A modal will open with the job information
  7. Click on "DELETE"
  8. Click "OK" on the confirmation message
  9. Close the modal
    The job will be removed from the Process Runs 

Reading Take Subscriptions Out of Resting Run Logs

The following information regarding the Process Runs is available:

  1. Number: An auto generated number that uniquely identifies each process run.
  2. Version: The version of the process run's related process run definition.
  3. Life Cycle State: The life cycle state of the process run which can be pending, in progress or completed.
  4. Start Date: The date that the process run started.
  5. End Date: The date that the process run ended.
  6. Process Successfully: Drill down including the entities processed successfully. 

  7. Processed With Errors: Drill down including the entities that were not successfully processed.


Visit Understanding Subscriptions for business examples related to Take Subscriptions Out of Resting Run

Related Areas

Popular Labels

  • No labels