Volume Change

Created by Vijendra Sawant, Modified on Mon, 20 Nov 2023 at 09:40 PM by Vijendra Sawant


/*
Calculation Script name - WhizCalVolumeChange
Description - Volume Change is the alteration in any metric when compared between two time periods.
              It's the difference between current and previous volume.
              Volume Change for TRx = (Sum of TRx in time period 1) - (Sum of TRx in time period 2) 
Product Version - v66
Script Version - 1.0

***Disclaimer - This is proprietary code of Whiz.AI. If you want to build on top of this computation script please make a copy/clone of this script and then alter the script which is copied or cloned. When version upgrade happens there are chances that this script may get modified hence any customization done by customer/partner developer may be overwritten.

Key Functions - 1.Function name : getComputationObj
                purpose : get instance of class present in library script.
              
                2.Function name : compute
                purpose : calculate change in volume.
                input parameters : metadataQuery 
                output parameters : dataframe
                                        
Key variables - query : implicit variable
                WhizCalDynamicPeriodLib : The name of the object present in WhizCalDynamicPeriodLib.js(library script).
                                         execution scripts can call WhizCalDynamicPeriodLib scripts functions using given object.
                WhizCalVolumeLib : The name of the object present in WhizCalVolumeLib.js(library script).
                                         execution scripts can call WhizCalVolumeLib scripts functions using given object.
*/
//**Start of Function code

log.info("******************** WhizCalVolumeChange **********************");
//name for metadata query, this helps logging and identification of query
query.name("WhizCalVolumeChange_Query");

//calling the function from library script 
WhizCalDynamicPeriodLib.getComputationObj().compute(query, WhizCalVolumeLib.getComputationObj());


/*
 ** configuration to be set in Computation metric **

default_filter:In this section's dynamicArgs sub-section, we will have the information related to the necessary aggregations required.
            "operator": Here we specify which type of operation we want to perform
      "subtraction": It is aggregation operation and same as Aggregation.subtraction
**The configuration below should be copied and pasted to calculate volume change. *
*/

"default_filter": {
      "dynamicArgs": {
        "operator": "subtraction"
      }
    }

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article