Overview
The "Calculate Current Month Benefit" setting controls how WiredUp treats benefit and cash flow values captured during the current month. This setting determines whether current month values are immediately recorded as actual values or treated as forecast values until the month ends.
This FAQ explains what the setting does, where to find it, and how it affects various areas of WiredUp including benefits, cash flows, API responses, reports, and widgets.
What is the 'Calculate Current Month Benefit' Setting?
The "Calculate Current Month Benefit" setting is a configuration option that determines the timing of when current month benefits and cash flows are realized as actual values in the system.
Where Can I Find This Setting?
The setting is activated via a checkbox located in:
- PMO users: Portfolio > Configuration > Settings > Ideas section
- CI users: Administration > Organisational Structure > Configuration > Settings > Ideas section
How Does This Setting Affect Benefits?
When the setting is ENABLED (ON):
- The system captures current month benefits as actual benefits immediately
- Benefits are realized in real-time as they are entered during the current month
When the setting is DISABLED (OFF):
- The system treats current month benefits as forecast values during the month
- Benefits are only realized as actual values once the current month has ended
- Current month values remain as forecasts until the month closes
How Does This Setting Affect Cash Flows?
When the setting is ENABLED (ON):
- Cash flow values entered during the current month are recorded as actual values immediately
- Current month cash flow values are displayed in black font on the Cash Flow table
- These actual values appear on the 'Cash In' or 'Cash Out' rows in the Chart and Grid view of the Benefit ($) page
When the setting is DISABLED (OFF):
- Cash flow values entered during the current month are treated as forecast values
- Cash flows are only realized as actual values at the end of the month
How Does This Setting Affect API Cumulative Benefits?
When the setting is ENABLED (ON):
- The current month benefit is returned in the API response as actual benefits
- Cumulative actual benefits include the current month's values
When the setting is DISABLED (OFF):
- The actual benefit for the current month is returned as 0 in the API response
- Current month benefits are not included in cumulative actual benefits until the month ends
How Does This Setting Affect Reports?
When the setting is ENABLED (ON):
- Current month actual benefits are displayed on the Cumulative Benefit Report
- The report includes current month values in the actual benefits totals
- PDF downloads reflect current month values as actuals
When the setting is DISABLED (OFF):
- Current month benefits are displayed as forecast benefits on the Cumulative Benefit Report
- Actual benefits do not include current month values until the month closes
How Does This Setting Affect Widgets?
The "Calculate Current Month Benefit" setting impacts several benefit-related widgets:
Run Rate Benefits Widget:
- This widget is a copy of the chart on the Financial Benefit page
- When the setting is enabled, the widget displays current month values as actual benefits immediately
- When the setting is disabled, current month values appear as forecasts
Benefit Delivered Widget:
- Located on the Idea Performance, Idea Overview, and Dashboard pages
- Calculates its value by subtracting Forecast value from Actual benefit
- When the setting is enabled, current month values are included in the Actual benefit calculation
- When the setting is disabled, current month values remain in forecasts until month-end
Total Benefits to Date Widget:
- Found on the Dashboard
- When the setting is enabled, includes current month actual benefits in the total
- When the setting is disabled, excludes current month benefits from the actual total until month-end
When Should I Enable This Setting?
Consider enabling this setting if:
- You want real-time visibility of current month benefits as actuals
- Your organization captures benefits throughout the month and needs immediate reporting
- You require current month data to be included in API responses and cumulative reports
- Your reporting processes depend on up-to-date actual benefit values
Consider keeping this setting disabled if:
- You prefer to finalize and validate all benefits at month-end before recording them as actuals
- Your organization follows a month-end close process for benefit realization
- You want to maintain a clear distinction between in-progress (forecast) and finalized (actual) benefits