Versions Compared

Key

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

Back to   Main Page

Excerpt
hiddentrue

Learn to configure Subscription Maintenance Utilities Definition that will dictate overall behavior behaviour of Subscription Maintenance Utilities

Panel
nameblue

Table of Contents

Table of Contents
minLevel2

Navigating to Subscription Maintenance Utilities Definitions

Info

BILLING > SUBSCRIPTIONS > SUBSCRIPTION MAINTENANCE UTILITIES

What are Subscription Maintenance Utilities Definitions?

Use  to configure Subscription Maintenance Utilities Definitions that when executed will 

The Subscription Maintenance Utilities Definition provides a set of utility batch processes that can be used to maintain subscriptionsSubscriptions. The subscription maintenance utilities definition Utilities Definition is a transient entity and it basically consists of two Subscription Batch Processes Definitions:

  • Activate Settles SubscriptionsExecute Scheduled ActionsSettled Subscriptions
    Activates 'Not Effective' Normal Subscriptions that belong to Accounts Receivable that have not exceeded their Credit Limit and that had their balance changed within a specified timeframe
  • Execute Scheduled Actions
    Executes all Scheduled Subscription Actions whose Scheduled Execution date is equal or before the current date.

Only one instance of the Subscription Maintenance Utilities Definition can exist in the System, therefore you cannot create a New Definition or Delete an existing one

  • Navigate to Subscription Maintenance Utilities Definitions and modify (EDIT) the Definition as required
  • Use CANCEL to revert any unwanted changes made to the Definition.

  • Use VIEW PROCESS RUNSRuns available in the section of each process to view all the Runs executed for the specific Process

Check the Validations & Restrictions Table below for a list of available Actions when working with Subscription Maintenance Utilities, including each Action's related validations, restrictions, and a description of its system process.  View the Attributes Table for a comprehensive description of the Subscription Maintenance Utilities fields.

ubscription Maintenance Utilities Run DefinitionImage Added

Anchor
validations
validations
Validations & Restrictions

Multiple Subscription Maintenance Utilities Definitions can exist in the system, but each one should have a unique name and alternative code
ActionValidationsRestrictionsAdditional InformationGeneralSystem Processing
Create
  • Not Applicable
 Create
  • Mandatory Fields must be defined
  • Name and alternative code must be unique
  • You cannot create a new definition
  • Not Applicable
  • Not Applicable
 
Edit
  • Mandatory Fields must be defined
  • Name and alternative code must be unique
  • 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
 Submit   
  • Run for that Definition
  • Not Applicable
  • Not Applicable
Process Settled Subscriptions
  • Not Applicable
  • Not Applicable
  • The process retrieves only Not Effective Subscriptions following a Normal Billing Term Scheme which have not exceeded their /wiki/spaces/WIP/pages/10010224 and had a balance change within the specified timeframe
  • Subscriptions that meet the conditions are activated
  • If the Definition is still enabled then
    • A Run is rescheduled after a period of time, based on the frequency defined on the Definition
  • If the Definition is not enabled then
    • The processing ends, and no Run is rescheduled
Process Subscriptions with Scheduled Processes
  • Not Applicable
  • Not Applicable
  • The process retrieves all Scheduled Subscription Actions whose Scheduled Execution Date is equal or before the current date.
  • Subscription Actions that meet the conditions are activated
  • If the Definition is still enabled then
    • A Run is rescheduled after a period of time, based on the frequency defined on the Definition
  • If the Definition is not enabled then
    • The processing ends, and no Run is rescheduled

 

Anchor
attributes
attributes
Attributes

An * indicates a field is mandatory 

Name

Description

Process Settled Subscriptions Settings

It defines the settings that will be applied while processing settled subscriptionsSubscriptions

Activate Normal Subscriptions

It defines the settings that will be The Settings that are used while performing "Activate Normal Subscription" runsRuns, which are applied in order to activate not effective normal subscriptions Normal Subscriptions which are already settled 
(i.e. they don't exceed their credit limit status). Note that this sub section reflects to an effective "Activate Normal Subscription Run Definition". Only one effective definition can exist, and is created / updated automatically whenever the settings are specified

Enabled *

It defines Defines if the process is enabled 'Enabled' or not. By default this process is disabled.
If enabled and  the the process is not already submitted to the scheduler then, the "Batch processes health monitoring utility" will submit Scheduler, the 'Batch Processes Health Monitoring Utility' submits this process to the scheduler Scheduler in order to execute it. 

Note

If disabled and the process is already submitted then

the process will be

it is executed and

will

not

be

resubmitted to the

scheduler again

Scheduler.

Frequency *It defines Defines the recurrence frequency Frequency measured in secondsSeconds, minutesMinutes, hours Hours or daysDays
Hours Since Latest
Accounts Receivable Balance Change
If specified then only accounts receivable that had a balance change within the specified time frame will be processes

Applies an additional filter on the retrieved Subscriptions so that only Subscriptions owned by Accounts Receivable having Financial Transactions which were posted within the last X hours are retrieved.

Only Integer numbers accented

Subscription Action Type

The

subscription action type that will be used to activate the settled subscriptions. Only subscription action types having a behavior code equal to "Activate Subscription" can be selected. This information is visible, applicable and mandatory only if any subscription action types with that behavior code exist in the system

Subscription Sub Action Type

The subscription sub action type that will be used to activate the settled subscriptions. Only subscription sub action types related with the already specified subscription action type can be selected. This information is visible, applicable and mandatory only if any subscription action types with that behavior code exist in the system
View Process RunsA link that can be used to display the already executed process runs related with that specific process. This information is displayed through a modal window, which also provides the ability to filter the results by the date of execution

Subscription Action Type that is used to classify each Activate Subscription action that will be applied

Note

If no Subscription Action Types or Sub-Action Types are configured in the System for Activate Subscription, you don't need to define anything

Subscription Sub-Action Type

The Subscription Sub-Action Type that is used to classify each Activate Subscription  action that will be applied

Note

If no Subscription Action Types or Sub-Action Types are configured in the System for Activate Subscription, you don't need to define anything

View Process RunsDisplays the Runs that were executed for the specific Definition. Each Run includes the Subscriptions that were activated.
In case of an error, the error code and description is displayed.

Process Subscriptions with Scheduled Changes

It defines the settings that will be applied while processing subscriptions Subscriptions having scheduled changes

Execute Scheduled Subscription Actions

It defines the The settings that will be are used while performing the "Execute Scheduled Subscription Actions" runs. Note that this subsection reflects to an effective "Execute Scheduled Subscription Actions Run Definition". Only one effective definition can exist, and is created / updated automatically whenever the settings are specifiedRuns.

Enabled

Defines if the process is 'Enabled' or not.
If enabled and the process is not already submitted to the Scheduler, the 'Batch Processes Health Monitoring Utility' submits this process to the Scheduler in order to execute it.

Note

If disabled and the process is already submitted then it is executed and not resubmitted to the Scheduler.

Frequency*Defines the recurrence Frequency measured in Seconds, Minutes, Hours or Days
View Process RunsDisplays the Runs that were executed for the specific Definition. Each Run includes the Subscriptions Subscription Actions that were processed.
In case of an error, the error code and description is displayed.
note

Visit Understanding Subscription Maintenance Utilities for business examples related to Subscription Maintenance Utilities

Panel
namegrey

Related Areas

Filter by label (Content by label)
showLabelsfalse
spacesV4Manual
showSpacefalse
labelsmodulenamesubscriptions-basics-r7,modulenamesubscriptions-advanced-r7,modulenamesubscriptions-admin-r7

Panel
namegrey

Helpful Links

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