Developer Resources
Object Model
Nue Object Model - Revenue Lifecycle Intelligence
10 min
this article contains the object model used to generate the arr momentum and other arr metrics arr by period overview the arr by period table is a time series table, storing the opening and closing arr values for each fiscal month, of each active order product, constituting a substantial dataset this information serves as the foundation for generating various reports on arr trends and other essential booking metrics the arr by period table operates on a strictly incremental basis once generated, the records within this table remain static and are not subject to updates when a new change order is initiated and activated, fresh arr by period records are generated specifically for this newly activated order example vroom inc follows a fiscal period aligned with the calendar year, with quarters beginning on 01/01, 04/01, 07/01, and 10/01 our account executive chloe landed customer a on 01/01/2023 with a 12 month subscription s 001, starting 01/15/2023, and a $1000 mrr this results in order o 1 containing order product op 001 chloe then landed customer b on 01/23/2023 with a 3 month subscription s 002 starting 02/01/2023, and a $2000 mrr this results in order o 2 containing order product op 002 chloe later upsold customer a on 02/01/2023, starting 04/01/2023 co termed with the original subscription s 001, and a $600 additional mrr this results in order o 3, containing order product op 003 given this scenario, what are chloe's contributions to the opening and closing arr from customer a and customer b for each quarter in fiscal year 2023? to answer this question, let's first take a look at all the 3 orders chloe created order order prduct customer subscription start date end date delta mrr delta arr o 1 op 001 customer a s 001 01/15/2023 01/14/2024 $1000 $12000 o 2 op 002 customer b s 002 02/01/2023 04/30/2024 $2000 $24000 o 3 op 003 customer a s 001 04/01/2023 01/14/2024 (co term with op 001) $600 $7200 upon the activation of every order, nue generates arr by period records for each product within the order on a monthly basis, aligning with the company's fiscal year therefore, the following arr by period records are generated (a full description of the object can be found later in this article) order order prduct customer user subscription change category start date end date opening cmrr closing cmrr order o 1 for customer a, subscription s 001 o 1 op 001 customer a chloe s 001 new business 01/01/2023 01/31/2023 $0 $1000 o 1 op 001 customer a chloe s 001 new business 02/01/2023 02/282023 $1000 $1000 o 1 op 001 customer a chloe s 001 new business 03/01/2023 03/31/2023 $1000 $1000 o 1 op 001 customer a chloe s 001 new business 04/01/2023 04/30/2023 $1000 $1000 o 1 op 001 customer a chloe s 001 new business 05/01/2023 05/31/2023 $1000 $1000 o 1 op 001 customer a chloe s 001 new business 06/01/2023 06/30/2023 $1000 $1000 o 1 op 001 customer a chloe s 001 new business 07/01/2023 07/31/2023 $1000 $1000 o 1 op 001 customer a chloe s 001 new business 08/01/2023 08/31/2023 $1000 $1000 o 1 op 001 customer a chloe s 001 new business 09/01/2023 09/30/2023 $1000 $1000 o 1 op 001 customer a chloe s 001 new business 10/01/2023 10/31/2023 $1000 $1000 o 1 op 001 customer a chloe s 001 new business 11/01/2023 11/30/2023 $1000 $1000 o 1 op 001 customer a chloe s 001 new business 12/01/2023 12/31/2023 $1000 $1000 o 1 op 001 customer a chloe s 001 new business 01/01/2024 01/31/2024 $1000 $0 order o 2 for customer b, subscription s 002 o 2 op 002 customer b chloe s 002 new business 02/01/2023 02/282023 $0 $2000 o 2 op 002 customer b chloe s 002 new business 03/01/2023 03/31/2023 $2000 $2000 o 2 op 002 customer b chloe s 002 new business 04/01/2023 04/30/2023 $2000 0 change order o 3 for customer a, subscription s 001 o 3 op 003 customer a chloe s 003 upsell/expansion 04/01/2023 04/30/2023 $0 $600 o 3 op 003 customer a chloe s 003 upsell/expansion 04/01/2023 04/30/2023 $600 $600 o 3 op 003 customer a chloe s 003 upsell/expansion 05/01/2023 05/31/2023 $600 $600 o 3 op 003 customer a chloe s 003 upsell/expansion 06/01/2023 06/30/2023 $600 $600 o 3 op 003 customer a chloe s 003 upsell/expansion 07/01/2023 07/31/2023 $600 $600 o 3 op 003 customer a chloe s 003 upsell/expansion 08/01/2023 08/31/2023 $600 $600 o 3 op 003 customer a chloe s 003 upsell/expansion 09/01/2023 09/30/2023 $600 $600 o 3 op 003 customer a chloe s 003 upsell/expansion 10/01/2023 10/31/2023 $600 $600 o 3 op 003 customer a chloe s 003 upsell/expansion 11/01/2023 11/30/2023 $600 $600 o 3 op 003 customer a chloe s 003 upsell/expansion 12/01/2023 12/31/2023 $600 $600 o 3 op 003 customer a chloe s 003 upsell/expansion 01/01/2024 01/31/2024 $600 $0 the table above provided displays the opening cmrr, closing cmrr, opening arr, and closing arr generated by each order product on a monthly basis throughout the entire subscription term this detailed breakdown enables us to analyze and manipulate the data in various ways, facilitating comprehensive aggregation and analysis for the above example, if i want to calcualted the opening and closing arr contributed by chloe for each fiscal quarter, i can simply find the arr by period records with start date on the following start dates of each quarter 01/01/2023 04/01/2023 07/01/2023 10/01/2023 the records retrieved are as follows order order prduct customer user subscription change category start date end date opening cmrr closing cmrr o 1 op 001 customer a chloe s 001 new business 01/01/2023 01/31/2023 $0 $1000 o 1 op 002 customer a chloe s 001 new business 04/01/2023 04/30/2023 $1000 $1000 o 2 op 002 customer b chloe s 002 new business 04/01/2023 04/30/2023 $2000 0 o 3 op 003 customer a chloe s 003 upsell/expansion 04/01/2023 04/30/2023 $0 $600 o 1 op 001 customer a chloe s 001 new business 07/01/2023 07/31/2023 $1000 $1000 o 3 op 003 customer a chloe s 003 upsell/expansion 07/01/2023 07/31/2023 $600 $600 o 1 op 001 customer a chloe s 001 new business 10/01/2023 10/31/2023 $1000 $1000 o 3 op 003 customer a chloe s 003 upsell/expansion 10/01/2023 10/31/2023 $600 $600 now we can do a simple aggregation, and get the following results quarter opening cmrr closing cmrr q1 $0 $3000 q2 $3000 $1600 q3 $1600 $1600 q4 $1600 $1600 to accommodate the potential volume of data, we utilize the arr by period big object within salesforce salesforce permits storage of up to 1 million records for each big object if your organization maintains a significant number of subscriptions (for instance, if the average subscription term spans 12 months, surpassing 83,333 subscriptions would likely exceed the big object storage limit), please contact salesforce https //help salesforce com/s/articleview?id=000380434\&type=1 to raise the limit of the storage capacity in addition to arr by period big object table, we also provide arr by period by customer big object table the field definitions for these two big objects are identical, with the only distinction lying in their indexes the arr by period table is tailored for efficient querying by start date, while the arr by period by customer table is optimized for queries based on customer and subscription parameters nue also generates an arr by period view within our snowflake data warehouse, enabling the creation of more sophisticated metrics and analytics for further insights into analytics within revenue lifecycle intelligence, please refer to revenue lifecycle intelligence docid 5pxskh5mnivwng540ziut field definitions object name arr by period api name arrbyperiod (salesforce ruby arrbyperiod b) field name data type description asset order product lookup (asset order product) references the https //docs nue io/docs/developer resource/developer resource object model/nue object model lifecycle manager/#credit flow asset order product https //docs nue io/docs/developer resource/developer resource object model/nue object model lifecycle manager/#credit flow object https //docs nue io/docs/developer resource/developer resource object model/nue object model lifecycle manager/#credit flow change category text available values are new business upsell/expansion cross sell downsell/contraction cancel/churn renewal change in arr decimal currency added and lost arr occurred any day in a fiscal period change in cmrr decimal currency added and lost cmrr occurred any day in a fiscal period closing arr decimal currency arr as of the closing of this period, not including the arr lost on the last day of this period closing cmrr decimal currency cmrr as of the closing of this period, not including the cmrr lost on the last day of this period currency code text associated currency iso code customer lookup(account) the reference to customer customer name text the name of the customer end date date the end date of this period id id the record id opening arr decimal currency arr as of the opening of this period, not including the arr added on the first day of this period opening cmrr decimal currency cmrr as of the opening of this period, not including the arr added on the first day of this period order product lookup(order product) the reference to order product product lookup(product) the reference to product product name text the name of the product quantity number(15,3) the quantity of the order product start date date the start date of this period subscription lookup(subscription) the reference to the subscription subscription number text the subscription number user lookup(user) owner of the order # arr by period data generation define fiscal periods in salesforce arr by period records are generated in real time when orders are activated before creating your first active order, either on ui or via order imports, you need to have fiscal periods created in salesforce please refer to this salesforce article https //help salesforce com/s/articleview?id=sf setting the fiscal year htm\&type=5 for creating fiscal periods in salesforce, or consult your salesforce consultant regenerate arr by period data in certain cases, when there are updates to fiscal periods or the creation of older ones to synchronize with historical data, you must regenerate arr by period data please follow the steps below login to nue app https //app nue io , and navigate to settings in the search bar, enter the keyword 'regenerate', then choose the 'generate or regenerate monthly delta arr for active orders' option click on the 'run now' button located next to the selected option please be aware that it might require a few minutes for the arr regeneration process to finish entirely
🤔
Have a question?
Get answers fast with Nue’s intelligent AI, expert support team, and a growing community of users - all here to help you succeed.
To ask a question or participate in discussions, you'll need to authenticate first.