Skip to main content

 

Planview Customer Success Center

GetTotalFinancialSummaryForGivenPeriod Function

GetTotalFinancialSummaryForGivenPeriod(work item as ObjectIdentifier, field as String, from as DateTime, to as DateTime)

Category: Financial Planning
Description: Returns a Currency value indicating the aggregated financial value of a specific financial resource time-phase field, for the specified Non-Labor Resource in a date range between 2 specific dates for a specified project.
Example business questions:
1. Calculate Budget Cost from today until the end of the current year
2. Calculate Forecast Cost from next month until the end of the project
3. Calculate Budget Revenue for next fiscal year
Supported Context: Business Rules
Parameters:  
workitem as ObjectIdentifier(workitem) Represents a reference to a work item. Normally this will be a project.
field as string The API name of the field in 'quotes' that you want to summarize for the time period.
Note: because the currency fields you will be referencing may not be directly referenceable using the Formula Options helper, you will need to manually input the field’s API name in the formula. The field API name can be seen in the Configure screen
Examples: “PlannedBudget”, “ForecastRevenue”.
Full example below.
dateTime1 Represents a reference to a “from” date as DateTime(year,month,day,hour,minute,second) e.g. DateTime(Year(Today()),1,1,08,00,00) or field that returns a date value e.g. Start Date
dateTime2 Represents a reference to a “to” date as DateTime(year,month,day,hour,minute,second) e.g. DateTime(Year(Today()),12,31,08,00,00) or field that returns a date value e.g. Due Date
Example #1

isNew() || isChanged($PlannedBudget)

ProjectGetTotalFinancialSummaryForGivenPeriod ($RelatedLink.WorkItem.Project, 'PlannedBudget', $RelatedLink.WorkItem.Project.StartDate, $RelatedLink.WorkItem.Project.DueDate) * 0.25

Tips The API name of the field you want to summarize should be in Quotes and without "$".