Versions Compared

Key

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

Back to Price Plans Main Page 

Excerpt
hiddentrue

Learn to configure Price Plan Adjustment Run Definitions that will dictate the overall behaviour of Price Plan Adjustment Runs

Panel
nameblue

Table of Contents

Table of Contents
minLevel2

Navigating to Price Plan Adjustment Definitions

Info

BILLING > PRICE PLANS - PERFORM PRICE PLANS ADJUSTMENT RUNS

What are Price Plan Adjustment Definitions?

Price Plan Adjustment Run Definitions are used to define rules for runs that will adjust Price Plan Rates whenever the VAT rate of a product included in the Price Plan changes.
Runs will create a new version of each affected Price Plan and calculate the new rate for products whose VAT rate has changed. 

Run Definitions must be submitted as soon as they are created and are executed one time or on a recurring basis, based on the defined scheduling Settings. Once a Definition is executed, a Process Run is logged and after the Run is completed, the log information is available on the respective tab.
The user has the option to delete the specific run as long as it is not yet executed (still in 'Draft' state).
A Definition must be in an 'Effective' Life Cycle State to be submitted. The Life Cycle State can be changed between 'Effective' and 'Not Effective' using the dedicated action.

  • Navigate to Price Plan Adjustment Definitions and explore existing entries via the Summary page
  • Click on the link (name or number) of the entry 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 or modify (EDIT) 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 Price Plan Adjustment, including each Action's related validations, restrictions and additional information.  View the Attributes Table for a comprehensive description of the Price Plan Adjustment fields.
 

Anchor
validations
validations
Validations & Restrictions

ActionValidationsRestrictionsAdditional Information
General
  • Multiple Price Plan Adjustment Definitions can exist in the system, but each one should have a unique Name and Alternative code
  • NotApplicable
  • Not Applicable
Create
  • Mandatory Fields must be defined
  • Name and Alternative Code must beunique
  • NotApplicable
  • Not Applicable
Edit
  • Mandatory Fields must be defined
  • Name and Alternative Code must beunique
  • Not Applicable
  • If there is one or more 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 contain all the modified information.
Delete
  • Not Applicable
  • Cannot be deleted
  • Not Applicable

 

Anchor
attributes
attributes
Attributes

An * indicates a field is mandatory.

Name

Description

Main Information
NumberAn auto-generated number that uniquely identifies the Price Plan Adjustment Run Definition.
Name*The name of the Definition.
Alternative code*An alternative code for the Definition. Unless otherwise specified, the codes for new Definitions default to the Definition's Name initials in capital letters.
DescriptionA description of the 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.
Version

An auto-generated number which is used to specify the version of each 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.

Logging Method

Status
colourBlue
titleAvailable from CRM.COM R12.0.0

Defines the methods that will be used to log the process run's results. Two options are available:

  • Log Processed Successfully and Processed with Errors: This is the default option. If selected then entities successfully processed and failed to be processed will be logged in the Process Run Logs.
  • Log Only Processed with Errors: If selected then only entities which failed to be processed will be logged in the Process Run Logs.
Criteria
VAT Rates
VAT Rate Change as of DateDefines the date on which the VAT Rate changes through to a new Rating Period.
All VAT Rates which have a period start date before or equal to this date will be available for selection.
VAT RatesA selection of VAT Rates. Multiple VAT Rates can be selected in each Definition and at least one should be specified.
Price Plans
Price PlansA selection of Price Plans on which the Price Plan adjustment will be applied exclusively.
Only non-expired Price Plans whose Effective Date is before the 'VAT Rate Change as of Date' will be available for selection. If no Price Plans are specified, then all non-expired Price Plans whose Effective Date is before the 'VAT Rate Change as of Date' will be considered for a Base Rate amount adjustment.
Products
Products to be adjustedA selection of Products and/or Product Types.
Only the rates of the specified products will be adjusted. If no Products are specified, then the rates of all affected Products will be modified.

Products not to be adjusted

A selection of Products and/or Product Types whose rates should NOT be adjusted. If no Products are specified, then the rate of all affected Products will be modified.

Process Runs
Process RunsDisplays the Runs that were executed for the specific Definition. Each Run includes the Price Plans that were processed.In case of an error, the error code and description is displayed.
Scheduling Settings
Settings*Method - The following options are available:
  • Run Now
  • Run on Specific Date / Time
  • Run Repeatedly
    Status
    colourYellow
    titleDeprecated from CRM.COM-R11.0.0 onwards
  • Advanced Scheduling
    Status
    colourYellow
    titleDeprecated from CRM.COM-R11.0.0 onwards

Refer to Scheduler Task - Global for configuration guidelines.

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
labelsprice-plans-basics-r7,price-plans-advanced-r7,price-plans-admin-r7

Panel
namegrey

Helpful Links

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