Clarity PPM: What does the Rate Matrix Extraction job do and how is it used?

Document ID : KB000025696
Last Modified Date : 25/10/2018
Show Technical Document Details


What does the Rate Matrix Extraction job do and how is it used?



The Rate Matrix Extraction (RME) job takes the resources who are assigned to projects and tasks on those projects, and finds out what the applicable rates and costs are for the duration of their assignment. Since that information is coming from financial rate matrices, you need to run this job if the matrix has changed. The data populated by this job is primarily used by Baselines, the Post Timesheets job and the Update Earned Value Costs Totals job (or 'Update Costs Totals' actions within a project).  You also need to run this job if you have created or updated project dates, team members and task assignments.

Description of RME Job Parameters and different combinations of them for different use cases:

User-added image


  • Extract Cost and Rate Information for the Scheduler
    Specifies extracting cost and rate information for a desktop scheduler. This field is a flag that triggers the job to generate resource rates for an investment that include rates prior to the start and after the finish date of the investment. If not using scheduler it can be left unchecked 
  • Prepare Rate Matrix Data
    Specifies adding the updated rate matrix data to a temporary table NBI_PROJ_RES_RATES_AND_COSTSCP. The data in the NBI_PROJ_RES_RATES_AND_COSTS table stays intact. The rate matrix data is available.
  • Update Rate Matrix Data
    Specifies copying the updated rate matrix data from the temporary table NBI_PROJ_RES_RATES_AND_COSTSCP to the NBI_PROJ_RES_RATES_AND_COSTS table. The rate matrix data is not available.
  • Incremental Update Only
    Specifies rates extraction only for currently updated projects. Running the job takes less time when compared with full run.
  • Team Rates Only
    If this option is NOT selected, then the job populates all the rates pertaining to the team and task assignments. If this option is selected, the job populates the rates related ONLY to the team. It does not extract task assignment rates.
Full RME
User-added image
User-added image

Incremental RME
User-added image

Incremental RME with Team Rates Only
User-added image

As a rule of thumb, we recommend that you run this job at least once a week prior to posting timesheets, but no more than once a day. For a system size with a large dataset, you should expect the job to take a fair amount of time and consume database resources. We recommend scheduling it every few days to run at night when there is not a whole lot of use activity going on. Running the job during business hours can make the system slow for all connected users.

Example: Split up the job with different combinations of options to prepare the data and update the data just in time for posting timesheets or working with project baselines.
  1. Create a scheduled job with the option to incrementally prepare the matrix data for non-peak time.
  2. Create a scheduled job with the options to incrementally update the matrix data for a time just prior to executing the ‘Post Timesheets’ job.
  3. When splitting this up, be sure to advise your users to create or update project baselines only AFTER the incremental update (#2) has completed to ensure the costs are computed as expected.  Once a baseline is created, the snapshot costs cannot be changed.

The 'Datamart Extraction' job utilizes some of the data that the 'Rate Matrix Extraction' job creates. Therefore, it is recommended that the 'Rate Matrix Extraction' job is executed successfully prior to the execution of the 'Datamart Extraction' job and prior to execution of the 'Post Timesheets' job and prior to the execution of the 'Update Earned Value Costs Totals' job.

Regarding the "Extract Cost and Rate Information for the Scheduler " check box in the Job page, it will impact performance of the job. If the flag is checked then the rates for the resources who are assigned to a project are calculated for beyond project start and end date. These calculations add time to the processing for the Rate Matrix job. The additional data beyond the project start and end date is used by the scheduler (OWB & MSP where the user can shift the project start and end dates). 


After the Rate Matrix Extraction job runs, the NBI_PROJ_RES_RATES_AND_COSTS populates with various rows based on resource/project/task details.
For all the Earned Value metrics (baseline values, acwp, etc cost) the row that is used is the -1 row.  This row comes from the team settings.
In this example I have charge code as a column in my rate matrix and a different charge code on my task than the project itself.  The project actually has no charge code.

You see my team record has has Task_ID = -1 and there is no charge code identified.  This has a rate of 20. 
The second row is my task with a specific charge code.  This row has a rate of 10.

nbi rate table

Anything that is used for EV including ACWP, when timesheets post, will use the rate associated with the first row using the TASK_ID = -1.  In this example it will use the 20 rate.

Here is the result on my task:


You will notice that this us using the 20 which is the rate on the -1 row from the matrix table.

NOTE: If the rates are not updated before posting timesheets or creating baselines, the costs may not be what is desired.  If the data in the extraction table does not exist for a date range used in a baseline or timesheet posting, the application will use a $1 rate.  Alternatively, if you have modified rates and modified projects and the extraction table is not updated, an incorrect rate could be used for the baseline or timesheet posting.

Additional Information: 

To ensue there is no conflict between the Rate Matrix Extraction job and other jobs in the application, it is recommended to update the job definition for 'Incompatible Jobs' is updated as per the details described in the following technical article: TEC528729 : Configuring and Scheduling Some of the Main Jobs  

Also, refer to the following articles for more configuration details on this job.   

Reference TEC439203 : On the 'Rate Matrix Extraction' job page, what does the parameter 'Extract Cost and Rate Information for the Scheduler' do?  

Reference TEC439334 : On the 'Rate Matrix Extraction' job page, what do the parameters 'Prepare Rate Matrix Data' and 'Update Rate Matrix Data' do?

Reference TEC551863 : Clarity: How Should I Use The New Incremental Only Option For The Rate Matrix Extraction Job?  

Reference TEC510858 : How often should I run the Investment Allocation Job?  

Reference TEC521284 : Baseline a project populates baseline cost based on $1.00 when the project and ETC starts before the rate matrix actually starts