Skip to end of banner
Go to start of banner

Configuring and Executing Price Plan Adjustment Runs

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

« Previous Version 3 Next »

What does this section cover?

What are Price Plan Adjustment Runs?

Price Plan Adjustment Runs runs are used to adjust price plan rates whenever the VAT Rate of at least one of the product included in the Price Plan changes (either increased or decreased).  The price of each price plan is replaced and the new base 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

 

ActionValidationsAdditional Information
General
  • Multiple Price Plan Adjustment Run Definitions can exist in the system, but each one should have a unique name and 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 

Name

Description

 NumberAn auto generated number that uniquely identifies the accounts receivable definitions
 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 specified
DescriptionA description for 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
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
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
VAT Rate change as of dateDefines the date on which the VAT Rate changes through 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. 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 Plan adjustment will be applied only on the specified Price Plans. 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 adjusting their base rate amounts.
Include Products Criteria
ProductsA selection of Products. The base rate of the specified products in various Price Plans will 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 be adjusted only. If no Product Types 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

  1. Navigate to BILLING > PRICE PLANS - PERFORM PRICE PLANS ADJUSTMENT RUNS
  2. Either search for an existing one or from the Top Menu click on NEW
    PRICE PLAN ADJUSTMENT RUN DEFINITION
  3. 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

  4. 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
  5. 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 
     

  6. LOG INFORMATION

    Unable to render {include} The included page could not be found.

  7. From the Top Menu click on SAVE

Executing a Price Plan Adjustment Runs

  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 Price Plan Adjustment Runs

 

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 Price Plan Adjustment 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 

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

Definitions Life Cycle State can be changed between Effective and Not Effective by following the steps below 

  1. Go to the data entry page of the definition'
  2. If the definition's Life Cycle State is set to "Effective"
    1. From the Actions Menu click ACTIONS > SET AS NOT EFFECTIVE
  3. If the definition's Life Cycle State is set to "Not Effective"
    1. From the Actions Menu click ACTIONS > SET AS EFFECTIVE
      RUN DEFINITIONS - LIFE CYCLE STATE ACTIONS 

 

Reading Price Plan Adjustment Runs 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.

 

Related Areas

Filter by label

There are no items with the selected labels at this time.

Popular Labels

  • No labels