Versions Compared

Key

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

 Back to to Subscriptions Main Page  Main Page

Excerpt
hiddentrue

Learn to configure Subscription Maintenance Utilities Definition that will dictate overall behavior of Subscription Maintenance UtilitiesDefinitions that determine the behaviour of Runs for activating settled Subscriptions and executing scheduled Subscription Actions, for CRM.COM R11 onwards.

Note

Status
colourYellow
titleAvailable from CRM.COM R11.0.0
-

For a description of the Normal Subscription Activation Process for releases before CRM.COM R11.0.0 refer to Using Activate Settled Subscriptions Run Definitions

For a description of the Execution of Scheduled Actions for releases before CRM.COM R11.0.0 refer to Using Execute Scheduled Subscription Actions Run Definitions

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

Utilities Definition?

Use  to configure Subscription Maintenance Utilities Definitions that when executed will 

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

Activate Settles Subscriptions

Subscriptions.

  • Activate Settled Subscriptions
    Activates 'Not Effective' Normal Subscriptions of Accounts Receivable(s) that have not exceeded their Credit Limit and that had changes in their Balance within a specified time-frame.
  • Execute Scheduled Actions
    Executes all Scheduled Subscription Actions whose Scheduled Execution Date is equal to or before the current date.

Only one instance of the Subscription Maintenance Utilities Definition can exist in the System therefore you cannot , so it is not possible to 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 RUNS RUNS 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 validationsrelated validations, restrictions, and  restrictions, additional information and a description of its system process.   View the Attributes Table for a comprehensive description of the Subscription Maintenance Utilities fields.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
  • A new Definition cannot be created.
  • Not Applicable
 
  • Not Applicable
CreateEdit
  • Mandatory Fields must be definedName and alternative code must be unique.
  • Not Applicable
  • NotApplicable
  • Not Applicable
 
Delete
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.
Delete
  • Not Applicable
  • Run Definitions cannot be deleted if there exists at least one scheduled or completed run for that Definition
 
Submit  
  • Not Applicable
  • A Subscription Maintenance Definition cannot be created.
  • Not Applicable
  • Not Applicable
Process Settled Subscriptions
  • Not Applicable
  • Not Applicable
  • The process retrieves only the 'Not Effective' Subscriptions that follow a Normal Billing Term Scheme and which have not exceeded their Credit Limit or had a change of Balance within the specified time-frame.
  • Subscriptions that meet the conditions are activated.
  • If the Definition is still enabled, then a Run is rescheduled after a period, based on the frequency set in 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 to 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, based on the frequency set in 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 Defines the settings that will be applied while processing settled subscriptionsSubscriptions

Activate Normal Subscriptions

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

Enabled*

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

Note

If disabled and

the process is

already submitted

then

, the process

will be

is executed and

will

not

be

resubmitted to the

scheduler again

Scheduler.

Frequency*It defines Defines the recurrence frequency of the process 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 an Accounts Receivable having Financial Transactions posted within the last X hours are retrieved.

Only Integer numbers are accepted.

Subscription Action Type

The

subscription action type

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

classify each applied Activate Subscription Action.

Note

If no Subscription Action Types or Sub-Action Types are configured in the System for Activate Subscription, then nothing needs to be to defined.

Subscription Sub-Action Type

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

Note

If no Subscription Action Types or Sub-Action Types are configured in the System for Activate Subscription, then nothing needs to be to defined.

Logging Method

Status
colourBlue
titleAvailable from CRM.COM R12.0.0

Defines the method to be used for logging process run's results. Two options are available:

  • Log Processed Successfully and Processed with Errors: If selected, both entities successfully processed and failed ones will be logged in the Process Run Log.
  • Log Only Processed with Errors: If selected then only entities which failed to be processed will be logged in the Process Run Log.
View Process RunsDisplays the Runs that were executed for the specific Definition. Each Run includes the Subscriptions that were activated.
Incase of an error, the error code and description are displayed.

Process Subscriptions with Scheduled Changes

It defines 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 Determines whether or not the process is 'Enabled' or not.
If enabled and the process is 'Enabled' and not already submitted to the the Scheduler, the 'Batch Processes Health Monitoring Utility' submits this the process to the Scheduler in order to execute it.

Note

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

Frequency*Defines the recurrence Frequency of the process measured in Seconds, Minutes, Hours or Days.

Logging Method

Status
colourBlue
titleAvailable from CRM.COM R12.0.0

Defines the method to be used for logging process run's results. Two options are available:

  • Log Processed Successfully and Processed with Errors: If selected, both entities successfully processed and failed ones will be logged in the Process Run Log.
  • Log Only Processed with Errors: If selected then only entities which failed to be processed will be logged in the Process Run Log.
View Process RunsDisplays the Runs that were executed for the specific Definition. Each Run includes the Subscriptions Subscription Actions that were processed. In case
Incase of an error, the error code and description is descriptionis displayed.
NoteVisit 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