Versions Compared

Old Version 4

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Persia Xenopoulou (Deactivated)

Saved on

Key

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

Back to Price Plans Main Page 

titleLearn how you can configure and execute Learn to configure Price Plan Adjustment Run Definitions that will dictate the overall behaviour of Price Plan Adjustment Runs Run

Excerpt
hiddentrue
Status
colourRed

AVAILABLE FROM CRM.COM R9
What does this section cover?

Panel
nameblue

Table of Contents

Table of Contents
minLevel2

What are Price Plan Adjustment Runs

Navigating to Price Plan Adjustment Definitions

Info

BILLING > PRICE PLANS - PERFORM PRICE PLANS ADJUSTMENT RUNS

What are Price Plan Adjustment Definitions?

Price Plan Adjustment Runs runs are Run Definitions are used to adjust price plan rates define rules for runs that will adjust Price Plan Rates whenever the VAT Rate of at least one of the rate of a product included in the Price Plan changes (either increased or decreased).  The price of each price plan is replaced and the new base .
Runs will create a new version of each affected Price Plan and calculate the new rate for products whose VAT Rate has changed is calculated. For each Adjusting Price Plan Runs, the system keeps information about the affected Price Plans and the products with the Price Plan whose base rates have changed.

A new Price Plan Adjustment Run is created each time a recurring Price Plan Adjustment Run Definition is submitted. Whenever a run has been submitted, the Price Plan Adjustment run added to the scheduler to be executed based on the specified run definition scheduling.

In order to modify the scheduling information of a submitted Price Plan Adjustment Run you can Edit the definition

Creating, Editing & Deleting Validations & Restrictions

 

ActionValidations

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.
Image Added 

Anchor
validations
validations
Validations & Restrictions

ActionValidationsRestrictionsAdditional Information
General
  • Multiple Price Plan Adjustment Run Definitions can exist in the system, but each one should have a unique name Name and alternative Alternative code.
N/A
CreateN/A
  • On creating a new Price Plan Adjustment Run, you can select between,
EditN/A
  • If there is at least one scheduled or completed Price Plan Adjustment run using the Price Plan Adjustment run definition latest instance then a new Price Plan Adjustment run definition instance is created
Delete
  • Price Plan Adjustment run definitions cannot be deleted if there at least one scheduled or completed notification run for that definition.
N/A
Save
  • Mandatory Fields:
    • Name
    • VAT Rates Criteria
      • VAT Rate change as of date
      • VAT Rates
    • Scheduling Settings
 

Price Plan Adjustment Runs attributes 

 Alternative

Name

Description

 NumberAn auto generated number that uniquely identifies the accounts receivable definitions
 Name*The name of the definition
  • 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.

VAT Rate change as of date

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. On creating a new definition it defaults to the first letter of each word included in the name (in Capitals), if nothing else is specifiedDefinition. Unless otherwise specified, the codes for new Definitions default to the Definition's Name initials in capital letters.
DescriptionA description for of the definitionDefinition.
Life Cycle StateThe life cycle state of the process run definitionLife Cycle State of the Process Run Definition. The supported values are effective and not effective. Only effective process run definitions '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 definitionsthe Process Run Definitions.
Version

An 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
Scheduling Settings

Determines when the process run definition should be applied. Process run definitions can be applied only on an ad hoc basis. Scheduling settings hold the following information:

  • Method: It provides the following options. For each option different settings are provided:
    • Run now
    • Run on specific Date / Time
      • Specific Date / Time
  • Start at: It determines the date and time that the process run definition should be applied. If the run now option is selected then the date / time is read only and set to 30 seconds after saving the record. Two options are available
    • Specific Date / Time 
  • End by Date / Time: It determines the latest date and time that the process run definition should be applied. This is available only if the repeat option is selected. Three options are available
    • No End Date
    • Specific Date / Time
Criteria
VAT Rates Criteria

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 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.
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 process run and this is mandatory information, i.e. Definition and at least one should be specified. Period Rate changes of the specified VAT Rates will be considered only.
Price Plans Criteria
Price PlansA selection of price plans. The Price Plans on which the Price Plan adjustment will be applied only on the specified Price Plans. exclusively.
Only non-expired Price Plans whose Effective Date is before the 'VAT Rate Change as of date Date' will be available for selection. If no Price Plans are specified, then all non-expired Price Plans whose effective date Effective Date is before the 'VAT Rate change Change as of date Date' will be considered for adjusting their base rate amountsa Base Rate amount adjustment.
Include Products Criteria
Products to be adjustedA selection of Products . The base rate and/or Product Types.
Only the rates of the specified products in various Price Plans will be adjusted only. If no Products are specified, then the base rate rates of all affected Products will be modified.

Product TypesProducts not to be adjusted

A selection of

Product Types. The base rate of products of the specified product type(s) in various Price Plans will be adjusted only. If no Product Types

Products and/or Product Types whose rates should NOT be adjusted. If no Products are specified, then the

base

rate of all affected Products will be modified.

Exclude Products Criteria
ProductsA selection of Products. The base rate of the specified products in various Price Plans will not be adjusted only. If no Products are specified, then the base rate of all affected Products will be modified.
Product TypesA selection of Product Types. The base rate of products of the specified product type(s) in various Price Plans will not be adjusted only. If no Product Types are specified, then the base rate of all affected Products will be modified.

Configuring a Price Plan Adjustment Runs tailored to your company's needs

  • Navigate to BILLING > PRICE PLANS - PERFORM PRICE PLANS ADJUSTMENT RUNS
  • Either search for an existing one or from the Top Menu click on NEW
    PRICE PLAN ADJUSTMENT RUN DEFINITIONImage Removed

  • MAIN INFORMATION

    1. Provide the required information

      • Name

      • Alternative Code

      • Life Cycle State: Is automatically set

      • Version: Is automatically set to 1 (for new runs)

      • Description

  • CRITERIA

    1. Provide the required information

    2. VAT RATES

      • VAT Rate Change as of Date

      • VAT Rates Click on ADD and search and select VAT rates using the Search Modal

    3. PRICE PLANS

      1. Price Plans: Click on ADD and search and select Price Plans using the Search Modal

    4. PRODUCTS

      1. Included Product Criteria: Click on ADD and select between Products and Product Types

        1. Use the Search Modal to add a product or a product type
      2. Excluded Product Criteria: Click on ADD and select between Products and Product Types
        1. Use the Search Modal to add a product or a product type

    • SCHEDULING SETTINGS

    Include PageScheduler Task - GlobalScheduler Task - Global 

    LOG INFORMATION

    Include PageWIP:Log Information - GlobalWIP:Log Information - Global
  • From the Top Menu click on SAVE

    • Executing a Price Plan Adjustment Runs

    Include PageExecuting Runs - GlobalExecuting Runs - Global AnchorModifyingRunDefinitionModifyingRunDefinitionModifying a Price Plan Adjustment Runs

     

    Include PageVersioningVersioning

    Deleting a Price Plan Adjustment Runs

    Deleting a scheduled job of the specific Run

    Include PageDeleting a run- GlobalDeleting a run- Global

    Changing the Life Cycle State of a Price Plan Adjustment Runs definition

    Include PageChange Life Cycle State of a Run definition - GlobalChange Life Cycle State of a Run definition - Global

    Reading Price Plan Adjustment Runs Logs

    Include PageReading Run Logs - GlobalReading Run Logs - Global

     

    Process Runs
    Process RunsDisplays the Runs that were executed for the specific Definition. Each Run includes the Price Plans that were processed.Incase of an error, the error code and descriptionis 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
    showSpacefalseexcerpttrue
    labelsmodulenameprice-plans-basics-r7,$modulenameprice-plans-advanced-r7,modulenameprice-plans-admin-r7

    Popular Labels

    heatmap
    Panel
    namegrey
    Popular Labels
    spaceKeyV4Manual
    style

    Helpful Links

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