- Getting Started
- Dynamic Planning
- Dynamic Planning Overview
- Write Back
- Aggregation Process
- User Security
- Direct Access to PCR Model
- Frequently Asked Questions
- Download & Installation
- SpotlightXL
- Analyze
- Report
- Excel Report
- Spotlight for Office
- Model
- Manage
- Token Management
- Write Back
- Dynamic Planning How to Load an External Data Source into a Master Model (Legacy)
- Spotlight Web
- Spotlight for Google Sheets
- Breakback
- Dynamic Planning API Library
- Base URL
- List of APIs
- Append Attributes (Master and Analytic Models)
- Sample Payload for Creating or Appending Attributes and Specifying the Member-Attribute Mapping
- Sample Payload for Updating the Member-Attribute Mapping for Previously Saved Attributes
- Response
- Parameters
- Sample Payload for Creating or Appending Attributes (Without Display Labels, Without Specifying the Member-Attribute Mapping)
- Sample Payload for Creating or Appending Attributes With Display Labels (Without Specifying the Member-Attribute Mapping)
- Append Dimension Members (Master and Analytic Models)
- Calculation Run (Master and Analytic Models)
- Calculation Status (Master and Analytic Models)
- Clear Data (Master and Analytic Models)
- Clear Leaf Data (Master and Analytic Models)
- Export Dimension / Attribute Hierarchy (Master and Analytic Models)
- Export Leaf-Level Data (Scoped) (Master and Analytic Models)
- Load Data (Master and Analytic Models)
- Clear Data (External Source Models)
- Clear Dimension Members (Metadata) (External Source Models)
- Export Leaf-Level Data (Scoped) (External Source Models)
- Load Data (External Source Models)
- Load Dimension Members (Metadata) (External Source Models)
- Create Users and Groups (User Management)
- List Users and Groups (User Management)
- Dynamic Planning: Group Access API
- How-Tos
- Dynamic Planning: How to Create a Report Based Off Multiple Models
- Dynamic Planning: How to Create a Report Based Off an Existing Report
- Dynamic Planning: How to Configure the Number of Invalid Login Attempts
- How to Open a Second Instance of SpotlightXL
- Dynamic Planning: How to Update a Dimension Hierarchy Without Clearing a Model
- Dynamic Planning How to Use Variables in Views and Reports
- Dynamic Planning How to Use the Metadata Viewer
- Dynamic Planning How to Use Excel Based Formulas
- Dynamic Planning How to Use Drag, Drop, Pivot, and Zoom Actions to Analyze Data
- Dynamic Planning How to Use Currency Exchange Rates
- Dynamic Planning How to Unlock a Locked User
- Dynamic Planning How to Use Change Data Tracking
- Dynamic Planning How to Specify Match Criteria
- Dynamic Planning How to Share a POV Dimension Across Models in a Report
- Dynamic Planning How to Set up a Power User with Access to Everything
- Dynamic Planning How to Select Data and Member Design Manager Options to Populate Report Values
- Dynamic Planning How to Save Data on Attributes for Views and Reports
- Dynamic Planning How to Restore a Model
- Dynamic Planning How to Perform Multi-Tab Analysis
- Dynamic Planning How to Lock Members in a View or Report to Prevent Modification
- Dynamic Planning How to Lock and Unlock Scaling
- Dynamic Planning How to Lock a Model to Prevent Modification or Clearing
- Dynamic Planning How to Lock a User and Prevent Sign On
- Dynamic Planning How to Generate a Model
- Dynamic Planning How to Filter Members Using Design Manager
- Dynamic Planning How to Download Data from the Structured Planning, Consolidation, and Reporting Applications into Dynamic Planning
- Dynamic Planning How to Delete a Model
- Dynamic Planning How to Define Multiple Number Formats for Dimension Members in Views
- Dynamic Planning How to Define Dimension Security
- Dynamic Planning How to Create Dimensions as Attributes
- Dynamic Planning How to Create and Load External Source Models
- Dynamic Planning How to Create a View and Specify Properties
- Dynamic Planning How to Create a Report off a Model and a View
- Dynamic Planning How to Create a Map
- Dynamic Planning: How to Clear a Model
- Dynamic Planning How to Cascade a Report
- Dynamic Planning How to Apply Scope to a Model
- Dynamic Planning How to Add or Delete Dimensions from a Model
- Dynamic Planning How to Add a Leaf Level Member to a Hierarchy
- Dynamic Planning How to Add a Chart to a Report
- Dynamic Planning How to Work with Model, View, and Report Folder and Organization Functionality
- Dynamic Planning How to Lock Dimension Members
- Dynamic Planning How to Find Data Cells Quickly
- Dynamic Planning How to Define Substitution Variables
- Dynamic Planning How to Backup a Model
- Dynamic Planning How to Add a Group and User Group
- Refrences
- Ref1
- Dynamic Planning Publishing and Opening Excel Reports, Word Reports, and PowerPoint Reports
- Purpose of Breakback
- Breakback Types
- Example Substitution Variable Expressions
- Prerequisites
- Install Planful Spotlight Add-on for Google Sheets
- Log in to Planful Spotlight Add-on
- Single Sign-On (SSO) for Planful Spotlight on Google Sheets
- Reports
- Using Breakback Summary
- Breakback and Data Locking
- Limitations
- Running Breakback from a Calculation
- Account Details
- Dynamic Planning User Groups
- Dynamic Planning Model Validation
- Dynamic Planning: Calculation Scheduler Option in Spotlight Web
- Spotlight User Summary
- Dynamic Planning Spotlight User Guide Supported Chart Types and Formatting on the Web
- Dynamic Planning Spotlight User Guide Report Task
- Dynamic Planning Spotlight User Guide Model Task
- Dynamic Planning Spotlight User Guide Analyze Task
- Creating and Formatting a Chart in PowerPoint or Word with Spotlight for Office
- Copying Spotlight Formulas from an Excel View or Report to PowerPoint
- Username and Password Security
- To launch Spotlight independently from a web browser:
- To launch Spotlight from the Planful application
- Supported Browsers
- Model
- Report
- Analyze
- Overview
- Dynamic Planning: Group Access
- About Dynamic Planning
- Spotlight versus SpotlightXL
- User Roles
- User Role Permission, Access, and Security
- User Types
- Unified Tenant
- Quick Summary of How to Assign or Restrict Access
- User Roles, Access, and Security
- Introduction to SpotlightXL
- Username and Password Security
- Accessing SpotlightXL
- Manage
- Model
- Report
- Analyze
- Overview
- Dynamic Planning Analyze Task
- SpotlightXL User Summary
- Dynamic Planning: SpotlightXL and Spotlight for Office Installation
- Using Dynamic Commentary in Excel Reports
- Dynamic Planning Global Settings for View and Report Properties
- Dynamic Planning SpotlightXL User Guide Function Support
- Dynamic Planning View and Report Permissions
- Dynamic Planning Using Substitution Variables and Expressions with Excel Reports
- Dynamic Planning SpotlightXL User Guide Chart Formatting and Types
- Dynamic Planning Sharing Excel Reports with People without a Dynamic Planning License Using Snapshots
- Dynamic Planning Setting Up Excel Reporting Security
- Dynamic Planning Setting Up Excel Reporting
- Dynamic Planning Setting Up an Assumptions Worksheet
- Dynamic Planning Report Design Using Substitution Variables and Expressions
- Dynamic Planning Repeat Headers Across Multiple Pages
- Dynamic Planning Refreshing and Formatting Excel Reports
- Dynamic Planning Overview of Excel Reporting
- Dynamic Planning Negative Amounts in Reports
- Dynamic Planning Navigation Access
- Dynamic Planning Multi-Tab Reporting
- Dynamic Planning Model Task in Excel
- Dynamic Planning Report Task
- Dynamic Planning Cascade Reporting
- Dynamic Planning Application Administration
- Creating Formulas in the External Source Model using Model Manager
- Creating Fields in the External Source Model using Model Manager
- Creating an External Source Model using Model Manager
- External Source Model Process
- List of Key External Source Model Features
- External Source Model Overview
- External Source Model Benefits
- Guard Rails
- Model Manager in Spotlight Honors User Group Security for all ESM Artifacts
- Drill Through in Views Accessed Via SpotlightXL or Spotlight Honor Group Access for ESMs
- Calculations in SpotlightXL Honor Group Access for ESMs
- Group Access to ESM Views
- Model Permissions for ESM Models
- Managing Group Access
- External Source Model DLR- Calculations tab Introduced
- Arabic and Chinese character support for ESM Data Load
- Examples of Include in Clear Data Loads
- Example of Creating a Data Load Rule for an External Source Model
- Using External Source Models in the Data Load Rule Definition Screens
- Best Practice Recommendations
- Details and Limitations
- Quick Summary
- Loading Data into the External Source Model
- External Source Model Field Types, Expressions, and Formulas
- Dynamic Planning External Source Model
- Dynamic Planning Export Data
- Transferring Data from One External Source Model to Another External Source Model
- Transferring Data from Analytical Model to ESM Model
- External Source Model Best Practices
- Backup and Restore of External Source Models
- Using Views to Input Future Opportunities into the Source Model
- Viewing the Data in the Master Model
- Using a Calculation to Load Data into the Master Model
- Defining a Map from Source Model to Master Model
- Creating a Master Model
- Loading Data into the Opportunity Data External Source Model
- Explanation of the DaysFactor Function
- Explanation of the Lookup Function
- Defining the External Source Model
- Viewing the Source Data
- Online Help, Support, Community, and Solution Hub
- Supported Browsers for SpotlightXL and Spotlight
- Automatic Signout
- Unique URLs for Artifacts
- Overview
- Where to Download SpotlightXL and Version Information
- What Version of SpotlightXL Am I Using?
- Incompatible SpotlightXL Error
- System Requirements
- Installing SpotlightXL and Spotlight for Office
- How to Use the ClickOnce Installer for Automatic Upgrades
- How to Use the InstallShield MSI Installer
- Upgrading SpotlightXL and Spotlight for Office
- Troubleshooting Tips
- ClickOnce Flexible Deployment
- Installation Best Practices
- User Roles
- View Formula in External Source Model
- Loading Data into External Source Models using PCR Data Load Rules
- Access to ESMs
- Step-by-Step Use Case for Forecasting Revenue Spread Over Time
- Dynamic Planning Data Locking
- Dynamic Planning Model Substitution Variables
- Dynamic Planning Model Lookup
- Dynamic Planning Groups
- Accessing Spotlight
- Dynamic Planning: Spotlight for Office User Guide
- Dynamic Planning: Admin Guides
- Dynamic Planning: Integration Admin Guide
- Overview
- Definitions
- Model Design - Connecting to the Structured Planning, Consolidation, and Reporting Applications
- Model Design - Setting up the Source Model in Dynamic Planning
- Model Design - Validation Report for Duplicate Members
- Model Design - Setting up the Target/Master Model using a Map
- Model Design - Target Model Design
- Populating the Source Model - Data Download
- Clearing the Source Model
- Populating the Target Model
- Viewing the Default Calculation
- Model Statistics
- Maintaining and Refreshing the Model
- Dynamic Planning: New Improved Aggregation Process
- Using Drill-Through
- Views and Reports
- Ability to Automatically Add Members When Writing Data Back From Dynamic Planning to Structured Planning, Consolidation, and Reporting
- Integration Admin Options
- Dynamic Planning: User Setup and Security Guide
- Overview
- Assign User Group Access to Models, Reports, and Views
- Quick Summary of How to Assign or Restrict Access
- Set up a Contributor User with Access to Specific Models
- Definition of Security Levels
- Set up a Reviewer User with Access to Specific Models, Views, Reports, and Dimension Members
- Set up a Power User with Access to Everything
- Dynamic Planning: Model Manager, Setup in Planful Applications
- Dynamic Planning: Best Practices for Model Building, Model Refresh, and Model Restructure
- Dynamic Planning: Integration Admin Guide
- Dynamic Planning: Subject Matter Guides
- Report Collection for Dynamic Planning
- Dynamic Planning: Best Practices for Model Building, Model Refresh, and Model Restructure
- ESM (External Source Models) Canvas
- Analyze
- Dynamic Planning: Using Direct Access (aka Direct Connect) to PCR Financial Reporting
- Key Benefits of Direct Access Models
- Setting Up the Connection to PCR
- Creating Users
- Creating a Direct Access to PCR Model
- Metadata Dimension Security for the Scenario Dimension
- Support for PCR Attributes, Attribute Hierarchies, and Alternate Hierarchies
- Adding Attributes, Attribute Hierarchies, or Alternate Hierarchies to Existing Direct Access Models
- Creating a Direct Access Model with Attributes, Attribute Hierarchies, or Alternate Hierarchies
- Viewing Attributes, Attribute Hierarchies, or Alternate Hierarchies in Spotlight Model Manager
- Viewing Attributes, Attribute Hierarchies, or Alternate Hierarchies in SpotlightXL Model Setup
- Support for _Attribute_Default in Direct Access to PCR Models
- Support for PCR Substitution Variables and Derived Variables
- Viewing PCR Substitution Variables and Derived Variables in SpotlightXL
- Using PCR Substitution Variables and Derived Variables in Reports at Runtime
- Adding Substitution Variables and Derived Variables to Existing Direct Access Models
- Creating a Direct Access Model with PCR Substitution Variables and Derived Variables
- Adding PCR Substitution Variables, Derived Variables, and Expressions to Reports
- Reporting and Analysis Primer
- Multiple POV Selections in SpotlightXL and Spotlight for Direct Connect Models
- Reporting Dimension Custom Labels Displayed in Direct Connect Models
- Support for PCR Cube Default Members for System-Defined Dimensions in New Views, Formatted Reports, and Excel Reports
- Support for Drill Through in Direct Connect Models in Both SpotlightXL and Spotlight
- Maintenance Options
- Information for Experienced Power and Contributor Users
- Converting a Master Model into a Direct Access to PCR Model
- Dynamic Planning Converting a Master Model into a Direct Access to PCR Model
- Using Direct Access (aka Direct Connect) to PCR Financial Reporting
- Dynamic Planning: Predict Signals
- Dynamic Planning: How To Tasks
- Dynamic Planning How to Add a User
- Dynamic Planning Manage Task
- Ref1
- Structured Planning
- Tasks to Configure for the Planning Module
- Planning Control Panel Intro
- Template Input and View Modes
- Entity Workflow
- Dynamic Commentary in Planning Template
- Working with Reports
- Workforce Planning - Classic UI
- MyPlan Guides
- MyPlan User Guide
- Accessing MyPlan
- Dissecting the MyPlan Interface
- Retained In-Memory Actions
- How Actions Are Calculated
- Adjusting, Updating, Adding, and Editing Accounts in MyPlan
- How to Add New Headcount
- How to Edit a Headcount
- How to Add Multiple Employees at Once
- How to Edit Multiple New Hires at Once
- How to Add a Headcount Based on an Existing Headcount and Edit Details
- How to Add an Asset
- How to Delete a Headcount
- How to Add an Asset Not Yet Budgeted
- How to Add An Asset for a Budget Entity When the Asset Definition Does Not Exist
- How to Edit an Asset
- How to Update an Account
- Working with Templates in MyPlan
- Activity Manager
- How to Submit a Budget/Forecast
- Template Locking
- Limitations
- MyPlan User Options
- MyPlan Admin Guide
- MyPlan User Guide
- Capital Planning
- Initiative Planning
- Workforce Planning
- References
- Structured Planning Admin Guide
- Configuration
- Security Administration
- Currency
- Hierarchies and Entities
- Overview
- Why Hierarchies Are Needed
- Types of Hierarchies You Can Create
- Accessing the Hierarchy Management Interface
- Working in the Hierarchy Management Interface
- Setup Entity Type Hierarchies
- Financial Hierarchy Overview
- Setup Finance Hierarchies
- Understanding Calculated Members
- Calculated Member Example - Creating a Member and Including it in a Dynamic Report
- Load Data to Planful
- Scenario Setup
- Overview
- Description of Fields on the Scenario List Page
- Performing Scenario / Template Maintenance
- Scenario Types
- Creating a Budget Scenario
- Creating a Forecast Scenario
- Creating a Plan Scenario
- Creating a Preloaded Budget Scenario
- How to Delete a Scenario
- Global Fields
- Refreshing Actuals (Closed Period Data)
- Mapping Templates to Scenarios
- Securing Scenarios
- Why Secure Scenarios
- When to Secure Scenarios
- How to Secure Scenarios
- How to Provide a User with Edit and View Access to Scenarios
- How to Automatically Have Access to all Future Scenarios You Create
- How to Provide Scenario Access to Multiple Users at Once
- How to Set Up Scenario Security for Reporting Purposes
- Clear Data
- Additional Scenario Topics
- Compare Scenarios
- Intelligent Data Seeding with the Plan Scenario
- Data Seeding Without the Plan Scenario
- Reporting Area Admin
- Dimension Security
- Standard Reports
- Planning Templates
- What are Templates and Why are They Needed
- Template Types
- Template List Application Page
- Time Sets - Everything You Need to Know
- How to Add a Block Template Type
- How to Add a Global Template - Single Copy Template Type
- How to Add a Global Template - Entity Copy Template Type
- How to Add an Allocation Template Type
- How to Add a Capital Template Type
- How to Add an Workforce Planning Template Type
- How to Add an HR Template Type
- How to Add a Line Item Template Type
- How to Add an Initiative Template
- Template Setup
- Understanding Template Setup
- Understanding the Template Setup Application Page
- Template Line Types and Column Types
- Understanding Line Item Template Setup
- Understanding Capital Template Setup
- Understanding Initiative Template Setup
- Template Start and End Dates
- Avoiding Line Discrepancies Between Sub and Main Templates
- Reference Cube
- Setting Up and Applying Global Fields to Templates (Optional)
- Apply Global Fields to Template Lines Accessed from the Planning Control Panel
- What are Global Fields and Why are They Used
- Add a Global Field
- Map the Global Field to Another Scenario and Budget Entities
- Mass Upload Global Fields
- Map Global Fields to Templates for Budget Entity and Scenario
- Global Fields in the Planning Control Panel
- Input Global Field Data
- Setting Up and Using Spreads in Templates (Optional)
- Attributes
- Template Setup Examples
- What To Do Once Template Setup is Complete
- Simulation Engine
- User Management
- Loading Users to Planful
- Security Cheat Sheet
- User Groups
- Navigation Role and Access
- Two Step Verification
- Web Service Access
- SSO Users
- Locking Users Out of Planful
- Copying Users
- Approval Roles
- Approval Roles - What Are They and How Are They Used
- Example of a Typical Approval Role Configuration
- How to Add and Edit Approval Roles
- How to Bulk Export Approval Roles and Budget Entity Permissions for a Single User/All Users
- How to Bulk Import Approval Roles
- Understanding Operating Budget Template Actions for Approval Roles
- Understanding Initiative Budgeting Approval Actions
- Scenario Access
- Security for Add-Ins
- Data Integration Security
- Cloud Scheduler
- What is Cloud Scheduler and How Does It Benefit Me?
- Providing Users with Access to Cloud Scheduler
- Understanding Process Flow and Job Manager
- Description of Fields on the Process Flow Page
- How to Add A Process Flow
- Auditing Process Flows
- Overriding Substitution Variables for Report Collections and Financial Package When Running a Process Flow
- Description of Fields on the Job Manager Page
- Initiative Workflow
- Adding Assets to Initiatives
- Add an Initiative to the Initiative Template and Start Budgeting for that Initiative
- Open the Template in the Planning Control Panel
- Map the Initiative Template to a Scenario(s)
- Map Attributes to Initiatives
- Add Attributes
- Set up Attributes to Map to Initiatives
- Setup/Design the Initiative Template
- Set Up Categories
- References
- Workforce Planning Admin Guide
- Workforce Planning
- Define Compensation Items for Workforce Planning
- Description of Fields on the Compensation Item Page
- Compensation Basis Examples
- Add Compensation Items Overview
- Description of Fields on the Add Compensation Item Page
- How to Define Compensation Groups for Workforce Planning
- How to Define Workforce Attributes for Workforce Planning
- How to Define Employee Types for Workforce Planning
- Overview of Pay Plans - Workforce Planning
- How to Set Up Pay Plans - Workforce Planning
- What is Pays Setup and What is the Purpose of It
- How to Complete Pays Setup - Workforce Planning?
- Employees Application Page - Workforce Planning
- Personalize the Employee list page - Workforce Planning
- Description of Fields on Employee Add Page
- Automated Employee Processing
- How to Extract Allocated Employee Information
- Security Administration
- Workforce Defaults
- Add Employees & Details
- Templates
- Template Mapping
- User Access
- Reporting
- Employee Type
- Advance Search in Workforce Planning
- Workforce Planning
- Workforce Planning - Enhanced UI
- How-Tos
- Subject Matter Guides
- Workforce Planning Admin Guide
- Set Up Approval Roles for the New Template
- Add an Initiative Template
- Overview of Steps to Set Up Initiative Planning
- Inputting Data via the Planning Control Panel
- User Security
- Scenario and Entity Mapping
- Adding Capital Templates
- Setting Up Finance Mode Templates and Mapping Capital Budget Lines to Your General Ledger
- Adding Finance Modes
- Adding Assets
- Adding Asset Categories
- Configuring Time Sets
- Configuring Capital Planning Attributes
- Configuring Time Sets
- Reporting
- Structured Planning User Guide
- Snapshot introduced in Planning Control Panel
- Performing Template Input
- Template View Mode
- Template Notifications
- View User History of Any Template
- Global Templates
- Block Templates
- Workforce Planning Templates
- Capital Templates
- Initiative Templates
- Line Item Template
- Allocation Template
- Approvers
- Workforce Planning UI
- Snapshot Restore Guidelines
- Structured Planning Admin Guide
- Consolidation
- Prerequisites
- Consolidation Control Panel
- How-tos?
- How to Configure Retained Earnings Roll Forward?
- How to Setup for Enhanced Retained Earnings Roll Forward?
- How to Close with Consolidation?
- How to Process Consolidation With Configurable Steps?
- How to Unlock Multiple Periods in Consolidation Process?
- How to Lock Multiple Periods in Consolidation Process?
- How to Provide Security for Centralized Consolidation Users?
- How to Provide Security for Decentralized Consolidation Users?
- How to Disable Display of Security Option from the Consolidation Control Panel?
- References
- Consolidation Accounts Setup Explained
- Intro to Consolidation
- Standard Journals
- Reporting
- Recurring Journals
- Dynamic Journals
- Non Controlling Interest
- Reclassifications
- Eliminations
- Validations
- Performing Entry Actions on Multiple Entries
- Consolidation Security
- Interim Currency
- How to Add Members to Sibling Hierarchies
- How to Create a Sibling Hierarchy Using a Sibling Hierarchy as the Source
- How to Create a Sibling Hierarchy Using the Main Company Hierarchy as the Source
- Source Hierarchies Used to Create Sibling Hierarchies
- What are Sibling Hierarchies and Why Do I Need to Create Them
- How to Provide Users with Access to Hierarchies
- What is the Hierarchy Usage Report
- Disallowed Strings for Attributes and Dimensions
- Dimension Locking
- Auditing Hierarchies
- Entity Currency
- Security and Accounts
- Configuration Tasks
- When Consolidation Is Needed
- Security Administration
- User Management
- Non Controlling Interest
- Centralized Security
- Cloud Scheduler for Consolidation Admin
- Set Up Currency
- Difference Between Common Currency, Local Currency, and Interim Currency
- Currency Use Case - Common Currency vs. Local Currency
- How to Set Up Currency and Currency Type
- What are Currency and Currency Type Exceptions and When Do I Need Them
- How to Delist Currency Types
- Currency Exchange Rate
- Hyperinflationary Economy
- Calculation Exceptions
- CTA
- Reporting Currency
- Entity Currency
- Load Data to Planful
- What Are Currency Exceptions and Do I Need to Set Them Up
- How to Setup and View Currency Exceptions
- Consolidation - Income Statement Retained Earnings Account & Retained Earnings Roll Forward
- Journals
- Reclassifications
- Standard Reports
- Security Overview
- Eliminations
- Validation
- Setting Up Hierarchies
- Report Categories
- Hierarchy - Reporting, Entity, & Interim Currency
- What is Org by Period, How to Access Org by Period, and How to Configure It
- How to Create an Alternate Hierarchy
- Dated Hierarchies FAQs
- Org By Period Report Generation
- How to Add a Dated Hierarchy
- How to Create an Alternate Hierarchy Using the Copy Functionality
- Calculated Member Example - Creating a Member and Including it in a Dynamic Report
- What are Calculated Members and Why Do I Need to Create Them
- Setup for Finance Type Hierarchies
- Overview
- What are Reporting Members and Why Do I Need to Create Them
- Why Hierarchies Are Needed
- Types of Hierarchies Explained
- Accessing the Hierarchy Management Interface
- Exploring the Hierarchy Management Interface Panes
- Exploring the Top Ribbon
- Exploring the Right Pane - Member Properties
- Exploring the Right Pane - Default Properties
- Exploring the Right Pane - Segment Properties
- Exploring the Right Pane - Interim Currencies
- Exploring the Right Pane - User-Defined Attributes
- Setting Up Hierarchies Summary
- Scenario Setup
- Overview
- Description of Fields on the Scenario List Page
- How to Provide Scenario Access to Multiple Users at Once
- Performing Scenario / Template Maintenance
- Why do I Need to Lock a Scenario
- How to Lock a Scenario
- How to Unlock a Scenario
- Scenario Types
- How, Why and When to Refresh Actuals (Closed Period Data)
- How, Why, and When to Refresh Preloaded Data for Preloaded Scenarios
- How, Why, and When to Secure Scenarios
- How to Provide a User with Edit and View Access to Scenarios
- How to Automatically Have Access to all Future Scenarios You Create
- How to Set Up Scenario Security for Reporting Purposes
- How to Create a Scenario Based on Two Existing Scenarios
- Data Seeding
- Processing Consolidations - What Happens During the Consolidation Process
- Override Workflow Actions for the Locking Period
- Review Consolidation Setup
- Consolidation Process Summary
- Copying Journal Entry Data
- What Is Validation Functionality and How to Enable It for Users
- How to Delete a Template from a Locked Scenario
- How to Add a Report Category
- What are Alternate Hierarchies and How are They Used
- What are Dated Hierarchies and How are They Used
- How to Add a Calculated Member to an Account Dimension
- How to Use Cloud Processing for Consolidation Hierarchies
- What is Two Step Verification, How Does It Work, and How Do I Enable It
- How to Add a User Group
- What Is Elimination Functionality
- How to Set Up an Elimination Company
- Reports
- Reports Prerequisites
- Reports Configurations
- Reports Home Page
- Report Folder
- Report Document
- Report Sets
- Report Collection
- Financial Package
- Dynamic Reports
- Working with Dynamic Reports
- Build and Run a Dynamic Report
- Example of Building a Dynamic Report
- Enhanced Drill Through in Dynamic Reports
- Template Notes in Dynamic Reports
- Dynamic Commentary
- Currency Display in Dynamic Reports
- Automatic Data Refresh
- Print Dynamic Report
- Exporting Dynamic Reports Output in Unprotected View
- View History from Reports
- Dynamic Reports Use Case
- Best Practices
- Dynamic Report Limitations
- Workforce Reporting
- Reports - References
- Dynamic Reports
- Overview
- Composition of a Dynamic Report
- Modify the Look and Feel of Dynamic Report Output
- How to Access the Format Pane
- An Explanation of Standard Formatting Functionality
- Cell Level Formatting Explained
- How to Reset Formatting Selections
- Situations When Formatting is Disabled or Can't be Applied
- How to Resize and Save Groups of Columns in a Dynamic Report
- Template Notes in Dynamic Reports
- How to Post a Comment
- Dynamic Reports Mapped to Planning Templates
- Dynamic Reports Mapped to Planning Templates Overview
- Copying Dynamic Reports
- How to Create and Modify Dynamic Reports
- Setting Up and Using Substitution Variables
- Limitations
- Overview
- How to Set Up Substitution Variables
- How to Use Substitution Variables in Dynamic Reports
- Dynamic Reports Options
- Best Practices and Tips
- References - Report Set
- Report Collection
- Financial Package
- Build and Run a Financial Package
- Reports User Guide
- File Cabinet
- Spotlight for Office
- Overview
- How to Log Into Spotlight for Office
- Copying Spotlight Formulas from an Excel View or Report to PowerPoint
- Copying Spotlight Formulas from an Excel View or Report to Word
- Copying Spotlight Formulas to PowerPoint using Copy Formulas
- Copying Spotlight Formulas to PowerPoint using Design PowerPoint Report
- Using Spotlight for Office
- Reports Administration Guide
- Dynamic Reports
- Dashboards
- Dashboards User Guide
- What are Dashboards
- Why Use Dashboards
- When to Use Dashboards
- How to Use Dashboards
- Dashboard Designer
- Using Consider Absolute Value Denominator Option for KPI Chart
- Using Dynamic Planning Data in a Dashboard
- Dynamic Report Chart
- Dashboard Read
- Saving Dashboards
- Refreshing Dashboards
- Using Filters
- Custom Color Schemes
- How to Build a Workforce Dashboard
- Setting Dashboards as Your Homepage
- View History from Dashboards
- Best Practices
- Dashboards User Options
- Dashboards Administration Guide
- Providing Users with Navigation Access to Dashboards
- Dashboards Reporting Area
- Use Dynamic Planning Data in Dashboards
- Dashboards Dimension Security
- Dashboards Scenario Security
- Dashboards Budget Entity Security
- Substitution Variables
- Pre-Defined Custom Members/Formulas
- Dashboard Sharing
- Edit Versus View Access to Dashboards
- Dashboards Versus Dynamic Reports
- Dashboard Updates
- Recommended Dashboards Screen Resolution
- Auditing Dashboards
- Best Practices
- Dashboards Administration
- Dashboards User Guide
- Planful AI
- Predict
- Budget Manager Experience
- Set Up Budget Managers
- Getting Started with Budget Manager Experience
- Sharing Templates with Budget Managers
- Manage Account Settings
- Track the Shared Templates
- Share Reports Via Link
- Predict in Budget Manager Experience
- Dashboards in Budget Manager Experience
- Workforce Planning Templates in Budget Manager Experience
- Maintenance
- Administration
- User & Role Management
- Scenario Setup
- Security Administration
- Configuration Tasks
- Workdays Setup
- Cloud Scheduler
- Customize Branding
- MyPlan Configuration
- Comments Manager
- Multi-Currency
- Hierarchy Management Overview
- Hierarchy Management Interface Overview
- Creating and Managing Additional Finance Hierarchies
- Adding Report Categories
- How-Tos
- Setting Up Attributes for Attribute Hierarchies
- Understanding Best Practices - Finance Hierarchies
- Understanding Reporting Members and Calculated Members
- Setting Up an Attribute Hierarchy
- Configuring OLAP Cube
- Understanding Example of How to Use Attributes
- Adding Another Level to Your Attribute Hierarchy
- Reflecting New Attribute Levels in Reports
- Setting Up An Attribute Used in Reporting and Enabling Drill Down to Dimension Member
- Mapping and Unmapping Workforce Planning Default Measures for Reporting Purposes
- Understanding Best Practices - Attribute Hierarchies
- Setting Up an Alternate Hierarchy
- Setting Up a Dated Hierarchy
- Entity Hierarchy Overview
- Sibling Hierarchies - Multiple Set of Books Overview
- Versioned Hierarchy Management in Dynamic Planning
- Exploring Additional Hierarchy Topics
- How-Tos
- Exploring the Frequently Asked Questions (FAQs) for Hierarchies
- FAQs for Hierarchies
- Planning Templates
- Global Fields
- Attributes
- Line Item Category
- Template Setup
- Template List
- Add Template
- Attribute Columns
- Deleting Attribute Columns
- Avoiding Mismatched Lines Between Sub and Main Templates
- Initiative Template Setup
- Time Sets
- Template Types
- How to Add a Global Template - Single Copy Template Type?
- How to Add a Global Template- Entity Copy?
- How to Add a Block Template Type?
- How to Add HR - Workforce Planning Template?
- How to Add an HR Template Type?
- How to Add an Allocation Template Type?
- How to Add a Capital Template Type?
- How to Add a Line Item Template Type?
- How to Add an Initiative Template?
- Template Examples
- Add Template
- Template Setup
- Mappings
- Spreads Set Up
- What To Do Once Template Setup is Complete?
- Template List
- Additional Template Information
- References
- What Are Time Sets?
- How to Configure Time Sets
- How to Create an Approval Role and Provide Users with Approval Role Access
- How to Provide Users with Scenario Access
- Attributes
- Applying Spreads to a Template Accessed via the Planning Control Panel
- Rules for Template RC Lines
- What are Spreads and How are They Used
- Initiative Template Setup
- Capital Template Setup
- How to Set Up a Line Item Template
- How to Set Up Line Item Categories
- How to Define a Time Set
- How to Set the Default Time Set
- Understanding the Template Setup Application Page
- What is Template Setup
- Template Column Types
- How to Map a Template to a Scenario
- How to Map a Template to an Entity
- What are Templates and Why are They Needed
- Template Types
- Description of Fields on the Template List Page
- Line Item Template Setup
- Spreads
- Template Setup Examples
- How to Access the Template List Page
- Opt In Features
- Publishing Templates
- Workforce
- Workforce Planning Setup
- Employees
- Adding Employees
- Add a Profile Picture to Employee Profile
- Reports Option for Employees
- Mass Update
- Using Customize Roster to Add Compensation Items
- Changing Budget Raise Percentage
- Employee Positions Outside of the Current Budget Cycle
- Automated Employee Processing
- Performance Statistics - Workforce Planning Employee Page
- Calculating Budget Review Date and Current Review Date
- Pop-up Message Introduced across all the windows in Workforce Planning Setup
- Create a Duplicate Employee
- Copy Employees
- Use Cases on How to Update Several Employees at Once
- How-Tos
- Compensation Groups
- Compensation Items
- Compensation Basis
- Marginal Benefit Calculation Setup Examples
- Situations When You Can't Edit a Compensation Item
- Understanding Pre-built Calculation Basis
- Linking to Global Fields
- How-Tos
- How to View Compensation Items in a Workforce Planning Budget Report?
- How to Set up 401k Match?
- How to Copy all Compensation Items and Rates from One Scenario to Another?
- How to Input Data Using the Direct Data Input Compensation Item?
- How to Lock Compensation Items to Prevent Modification?
- How Changes to Compensation Items Affect Running Scenarios?
- How to Update Compensation Items Loaded via Data Load Rules?
- How to Make the Bonus Expense Calculation Variable?
- How to Select Compensation Items for Calculating Wages?
- Employee Types
- Pay Plans
- Workforce Attributes
- User Access
- Employees
- Export Employee Data
- References
- Workforce Planning Admin Guide
- Configuring Workforce Planning
- Security Administration
- Workforce Defaults
- Add Employees & Details
- Templates
- Template Mapping
- User Access
- Reporting
- Workforce Planning Admin Options
- Understanding Tiers on Employee Attribute - Value in Hours per Period with Annual Cap
- Understanding Tiers on Employee Attribute - Value in Hours per Period
- Understanding Tiers on Employee Attribute - Value in Wages with Varying Annual Cap
- Understanding Rate x Hour
- Workforce Planning Admin Guide
- Workforce Planning Setup
- Capital Planning
- References
- Capital Planning Admin Guide
- Reporting
- Adding Assets
- Adding Finance Modes
- Adding Capital Templates
- Setting Up Finance Mode Templates and Mapping Capital Budget Lines to Your General Ledger
- User Security
- Configuring Time Sets
- Scenario and Entity Mapping
- Adding Asset Categories
- Configuring Capital Planning Attributes
- Inputting Data via the Planning Control Panel
- Capital Planning Admin Guide
- References
- Rules
- Data Integration
- Actual Data Templates
- Translations Setup
- Export Data
- Transaction Details
- Data Load Rules
- Integration Services
- Clear Data
- Data Calculation Exceptions
- Additional Topics
- API Library
- Introduction
- Data Import
- Data Export
- Structured Planning REST APIs
- Workiva Integration
- Objects Overview
- API Compliance
- Client Application Platforms
- API Access Keys
- API Calls - Overview
- Core API Calls
- Utility Calls
- Objects
- API Methods
- Clear_Data API
- Load_Data API
- Transfer_Data API
- Segment APIs
- GLData_Retrieve API
- Login API
- GetSessionId API
- GetVersion API
- GetAllCurrencies API
- GetAllCurrencyTypes API
- GetAllSegments API
- Logout API
- Employee APIs
- Approval Role Setup APIs
- Scenario Access APIs
- Dimension Member Name Update API
- Bulk User and User Group Extract API
- Dimension Security APIs
- Dimension Security Update API
- MapEntity API
- Refresh Preloaded Data API
- Best Practices and Tips
- Enumerations
- Validate Source Segment API
- Transaction Data Extract APIs
- Planful API Library
- Source Segment API
- Report Administration
- Application Audit
- Application Audit Details - Audit Area
- References
- User & Role Management
- How to Access the User and Role Management Application Page
- Navigation Role and Access
- Manually Add a User to Planful
- Exporting Navigation Role Summary and Detailed Reports
- Locking Users and Preventing Sign On to Planful
- Copy An Existing User
- Approval Roles
- Consolidation Security
- User Groups
- Scenario Access
- Add-In Security (Optional)
- Data Integration Security
- Dimension Security Configuration
- Workforce Reporting Security
- Understanding the User Management Interface - Approval Role
- Understanding the User Management Interface - User Add Page
- Understanding the User Management Interface
- Understanding the User Management Interface - Navigation Role
- Purpose of User and Role Management
- Scenario Setup
- Security Administration
- Configuration Tasks
- Workdays Setup
- Auditing the Application
- Rules - References
- Simulation Engine Guide
- What is Simulation Engine?
- When to Use Simulation Engine
- Why Simulation Engine is Needed
- How to Create a Simulation Engine Process
- How to Add Template - Entity Combinations to a Simulation Engine Process
- How to Schedule a Simulation Engine Process via Cloud Scheduler
- Copying Simulation Engine Processes From the Default Scenario to Other Scenarios
- Additional Features Available for Simulation Engine
- Simulation Engine Guide Summary
- FAQs
- Simulation Engine Guide
- Data Integration - References
- Data Load Rules
- Web Services / Boomi
- Actual Data Templates
- Integration Services
- Working with Custom Parameters for Integration Service Processes
- Adding an Integration Service Process
- Completing the Integration Services Configuration Task
- Providing Navigation Access to the Integration Services Application Page
- Editing, Deleting and Copying Integration Service Processes
- Introduction
- Cloud Services
- Transaction Details
- Google Drive
- NetSuite Integration
- FTP/SFTP Connector
- Cloud Services
- Data Integration Admin Guide
- Admin Guide to Loading Data to Planful
- Cloud Scheduler Ref.
- What is Cloud Scheduler
- How to Provide Users with Access to Cloud Scheduler
- How to Add A Process Flow
- Understanding Process Flow and Job Manager
- Description of Fields on the Process Flow Page
- Auditing Process Flows
- Overriding Substitution Variables for Report Collections and Financial Package When Running a Process Flow
- Description of Fields on the Job Manager Page
- Currency-Ref
- Difference Between Common Currency, Local Currency, and Interim Currency
- Currency Use Case - Common Currency vs. Local Currency
- Decision Hub Summary
- Interim Currency
- Currency Setup
- Currency Type Setup
- Currency Type and Currency Type Exceptions
- Mass Loading Currency Exceptions
- Loading Exchange Rates Using Data Load Rules
- Cube Settings
- Report Administration Guide
- MyPlan Admin Guide
- User & Role Management
- Administration
- Release Updates
- Release Notes
- 2025 Release Notes
- 2024 Release Notes
- 2023 Release Notes
- 2022 Release Notes
- 2021 Release Notes
- 2020 Release Notes
- 2019 Release Notes
- 2018 Release Notes
- 2017 Release Notes
- December 17 Maintenance Release
- 2.3.1 Modeling Release Notes, December
- Fall 17 Release Notes
- 2.3 Modeling Release Notes, November
- October 17 Maintenance Release
- 2.2.2 Modeling Release Notes, October
- September 17 Maintenance Release
- Summer 17 Release Notes
- 2.1.2.2 Modeling Release Notes, July/August
- July 17 Release Notes
- 2.1.2 Modeling Release Notes, July
- June 17 Release Notes
- 2.1.1 Modeling Release Notes, June
- Spring 17 Release Notes
- 2.1 Modeling Release Notes, May
- April 17 Release Notes
- 2.0.2 Modeling Release Notes, April
- March 17 Release Notes
- 2.0.1 Modeling Release Notes, March
- Winter 17 Release Notes
- 2.0 Modeling Release Notes, February
- January 17 Release Notes
- 1.9.2 Modeling Release Notes, January
- 2016 Release Notes
- Planning/Consolidation/Reporting December 16 Release Notes
- 1.9.1 Modeling Release Notes, December
- Planning/Consolidation/Reporting Fall 16 Release Notes
- 1.9 Modeling Release Notes, November
- Planning/Consolidation/Reporting October 16 Release Notes
- 1.8.2 Modeling Release Notes, October
- Planning/Consolidation/Reporting September 16 Release Notes
- 1.8.1 Modeling Release Notes, September
- Planning/Consolidation/Reporting Summer 16 Release Notes
- 1.8 Modeling Release Notes, August
- Planning/Consolidation/Reporting July 16 Maintenance Release
- 1.7.2 Modeling Release Notes, July
- Planning/Consolidation/Reporting June 16 Maintenance Release
- 1.7.1 Modeling Release Notes, June
- Planning/Consolidation/Reporting Spring 16 Feature Release
- 1.7 Modeling Release Notes, May
- Planning/Consolidation/Reporting April 16 Maintenance Release
- 1.6.2 Modeling Release Notes, April
- Planning/Consolidation/Reporting March 16 Maintenance Release
- 1.6.1 Modeling Release Notes, March
- Planning/Consolidation/Reporting Winter16 Release
- 1.6 Modeling Release Notes, February
- Planning/Consolidation/Reporting January 16 Maintenance Release
- Enhancements to Application Behavior
- 1.5.2 Modeling Release Notes, January
- Release Notes
- Additional Resources
- 23 Minutes to read
- Print
- DarkLight
- PDF
2.1.2 Modeling Release Notes, July
- 23 Minutes to read
- Print
- DarkLight
- PDF
Substitution Variables and Expressions
Substitution variables are used in reports in place of dimension member names. In this release, reports can be defined using substitution variables that can be dynamically modified at runtime by end users, and administrators and designers now have the option to set up reports using substitution variables with expressions.
The substitution variables can be dynamically modified at runtime. Previously, if a report was set up to use a substitution variable, the report would always run with the predefined value of the substitution variable. To change the value, an admin or designer had to change it manually using the Model > Model Administration > Substitution Variables page.
Any level of user can now change the value of substitution variables while running a report. The new value is used during that session, but the report reverts back to the original substitution variable value the next time the report is run. For example, a designer may set up a report with a substitution variable defined as CurMth = January 2017. The end user can change the value to July 2017 when running the report. The next time the report is run, January 2017 is used by default but again can be changed easily at runtime.
Selecting a different dimension member name is available in SpotlightXL and Spotlight.
Administrators and designers can set up substitution variables with expressions. Expressions are added to a substitution to derive another member name from the same dimension.
Substitution variables are most commonly used in the Time and Scenario dimensions.
Here is the overall process:
Admin or designer creates one or more substitution variables in the model.
Admin or designer creates one or more reports that use the substitution variables.
Any user with access to the report can run it and change the value of the substitution variable, provided they have security access to the dimension.
Select from the following topics for more details:
Creating Substitution Variables for Reports
Using Substitution Variables in Reports
Selecting a Different Value for a Substitution Variable at Runtime
Converting Existing Reports with Substitution Variables to Use Expressions
Using Substitution Variables with Excel-based Reporting
Creating Substitution Variables for Reports
To set up formatted reports with substitution variables for use at run-time, an administrator or designer must first create the substitution variables. This functionality was introduced in Release 1.2. As a reminder, here's how:
Select Model > Model Administration > Substitution Variables.
Select the model and dimension name from the list boxes.
Enter the variable name with plain text. Avoid using the symbol @ in the variable name. For example, CurMth or Current Month. Variable names are case sensitive.
Specify the starting value for this variable. This value must be the same as a dimension member name in your model. For example, Jan-17.
Optionally, specify the model that the variable will be used on.
Optionally, specify the dimension that the variable relates to. For example, Time.
Click Save.
If you make a mistake, simply delete the row containing the substitution variable that you created, then click Save to delete it.
Using Substitution Variables in Reports
To set up a report to use one or more substitution variables:
Lay out the report with standard items, such as headings, rows, and columns.
While in Report Design mode, select the cells containing the dimension member to be replaced with a substitution variable.
Click Design Manager. Notice that the current value is a regular dimension member, Jan-2017.
Click the Member Selection icon, then Select Member.
Click Select Member. At the top of the member selection box, notice that Substitution Variables are listed first.
Select @CurMth@ and click Select.
Now the Design Manager reflects the change from the original value (Jan-17) to the Substitution Variable @CurMth@. Also shown in light gray is the predefined value of CurMth.
Click Update. The report now displays @CurMth@ in place of the 4 cells you originally selected.
Now you need to update the data cells to also use the substitution variable.
Select all the data cells. In this example, columns B and C are data cells, while columns D and E contain Excel formulas.
Click Design Manager. Scroll to the Time dimension. Notice that the current value is a regular dimension member, Jan-2017.
Click the Member Selection icon, then Select Member.
Click Select Member. At the top of the member selection box, notice that Substitution Variables are listed first.
Select @CurMth@ and click Select.
Now the Design Manager reflects the change from the original value (Jan-17) to the Substitution Variable @CurMth@. Also shown in light gray is the predefined value of CurMth.
Click Update. The report now displays UPDATED in place of the data cells you originally selected.
Click Save to save your report.
Selecting a Different Value for a Substitution Variable at Runtime
When the end user runs a report, if it contains a substitution variable, a new icon automatically appears on the menu ribbon.
With the cursor anywhere in the report, click Substitution Variables. The Substitution Variables box appears. It shows the name of the variable and the current value.
Click the Member Select icon.
From the member selection box, select the month that you want to see in the report.
Click Select.
Click Refresh to refresh the report.
The report now displays data for Jul-17. Using this method, the user can easily move back and forth between months, quarters, or years, without updating the definition of the report and without the need for the designer or administrator to update the substitution variable value permanently.
Using Substitution Variables with Expressions
Modeling now supports the ability to enhance substitution variables by providing expressions. Expressions point to different members in the dimension in relation to the predefined value of the substitution variable.
Here is a basic annual revenue report. Expressions will make this report easier to maintain in coming years.
Define the following substitution variable:
FirstMth = Jan-16
Now go to Report Design to use this variable.
Select all the cells in the worksheet.
Click Design Manager.
Each member in the Time dimension will be replaced with a substitution variable or expression.
Select Jan-16.
Click the Member Selection icon, then Select Member.
Select @FirstMth@ and click Select. Now the Design Manager reflects the change from the original value (Jan-16) to the Substitution Variable @FirstMth@. Also shown in light gray is the predefined value of FirstMth.
Repeat steps 3-5 for Feb-16.
While still on Feb-16, click the Member Selection icon again, then Expression.
The Expression box appears and FirstMth is already selected.
Click Add Function.
Click Lead.
The Expression box now shows the Offset option. By default, the offset is 1. Offset refers to the number of members above or below the current member in the dimension hierarchy. Offset works within the current level and it skips over rollup members.
Lead refers to members below the current member in the hierarchy. For example, Jan-16, Lead(1) points to Feb-16. Lead is equivalent to fetching the next member in the hierarchy within the current level.
Lag refers to members above the current member in the hierarchy. For example, Jan-16, Lag(1) points to Dec-15. Lag is equivalent to fetching the previous member in the hierarchy within the current level.
Click Update to accept Lead(1).
Repeat steps 3-5 and 7-10 for the rest of the months to express all of the months in relation to FirstMth.
For the year 2016, a different expression is needed.
Repeat steps 3-5 for 2016.
While still on 2016, click the Member Selection icon again, then Expression.
The Expression box appears and FirstMth is already selected.
Click Add Function.
Click Parent. The parent of Jan-16 is Q1-16, so we want the parent of the parent to go up 2 levels to 2016. This is done by chaining two expressions together. For more information on chaining expressions, see Expression Chains.
Click Add Function again.
Click Parent. Now you see @FirstMth@.Parent.Parent, and 2016 is displayed to show you what value is returned with this expression.
Click Update.
The Time dimension now reflects all members in relation to the substitution variable FirstMth.
Click Update to save your changes and exit the Design Manager.
The report now displays UPDATED in place of the data cells, and @FirstMth@ and the expressions in place of the monthly headings.
Save the report design by clicking Save or Save As. Consider changing the name to preserve the original report until you are confident that the new report is accurate.
Now when you run the report, you can use the Substitution Variables box to change the starting value to the first month of any year in your hierarchy.
After selecting Jan-17, click Refresh.
Notice that the same report now works for other fiscal years. Users just need to select the first month of the fiscal year and entire report is derived from that substitution variable dynamically. Because of the introduction of expressions, administrators or designers can design reports that are more dynamic in nature. And it will reduce the report maintenance going forward.
Expressions
Consider the following dimension hierarchy for a fiscal year that begins in July each year. Assume that the model contains only these three years.
Time Dimension | ||
---|---|---|
FY2017 | FY2018 | FY2019 |
Q1 2017 | Q1 2018 | Q1 2019 |
|
|
|
|
|
|
|
|
|
Q2 2017 | Q2 2018 | Q2 2019 |
|
|
|
|
|
|
|
|
|
Q3 2017 | Q3 2018 | Q3 2019 |
|
|
|
|
|
|
|
|
|
Q4 2017 | Q4 2018 | Q4 2019 |
|
|
|
|
|
|
|
|
|
Expression Syntax
The following expressions are available for use with substitution variables. Assume that @CurYear@ is FY2018 and @CurMth@ is Jul 2017.
Expression | Offset # Required? | Description | Example Syntax | Resulting Value |
---|---|---|---|---|
FirstChild | No | Returns the first child in the hierarchy. | @CurYear@.FirstChild | Q1 2018. CurYear is FY2018 and its First Child is Q1 2018. |
LastChild | No | Returns the last child in the hierarchy. | @CurYear@.LastChild | Q4 2018. CurYear is FY2018 and its Last Child is Q4 2018. |
FirstSibling | No | Returns the first sibling in the hierarchy, at the same level | @CurYear@.FirstSibling | FY2017. CurYear is FY2018 and its First Sibling is FY2017. |
LastSibling | No | Returns the last sibling in the hierarchy, at the same level | @CurYear@.LastSibling | FY2019. CurYear is FY2018 and its Last Sibling is FY2019. |
|
|
|
|
|
Lead | Yes | Returns the next member in the hierarchy, at the same level; skips over parent or child members | @CurYear@.Lead(1) | FY2019. CurYear is FY2018 and the next member at the same level is FY2019. |
|
|
| @CurYear@.Lead(2) | Member Not Found (There is no FY2020 in the model.) CurYear is FY2018 and skipping ahead 2 years would result in the member that follows FY2019 except there is no such year in the model. |
|
|
| @CurMth@.Lead(4)
| Nov 2017. CurMth is Jul 2017 and skipping ahead 4 months is Nov 2017. |
Lag | Yes | Returns the previous member in the hierarchy, at the same level; skips over parent or child members | @CurYear@.Lag(1) | FY2017. CurYear is FY2018 and going back one year is FY2017. |
|
|
| @CurYear@.Lag(2) | Member Not Found (There is no FY2016 in the model.) CurYear is FY2018 and going back two years would result in the member that preceds FY2017 except there is no such year in the model. |
|
|
| @CurMth@.Lag(4)
| Mar 2017. CurMth is Jul 2017 and 4 months before July is Mar 2017. |
|
|
|
|
|
Parent | No | Returns the parent member in the hierarchy. | @CurYear@.Parent | Time. CurYear is FY2018 and its Parent is the Time dimension. |
|
|
| @CurMth@.Parent.Parent
| FY2018. CurMth is Jul 2017 and its Parent is Q1 2018, and Q1's Parent is FY2018. |
Expression Chains
You can chain expressions together. Each entry in the expression builds on the results of the previous entry, reading from left to right.
@CurMth@.Parent.FirstChild = Jul 2017. CurMth’s Parent is Q1 2018 and the First Child of Q1 2018 is Jul 2017.
@CurMth@.Lag(3).Parent = Q4 2017. CurMth’s 3-month Lag is Apr 2017 and the Parent of Apr 2017 is Q4 2017
@CurMth@.Parent.Lead(2) = Q3 2018. CurMth’s Parent is Q1 2018 and 2 quarters ahead is Q3 2018.
When adding functions to a substitution variable, you may find the need to change the order or to remove one of the expressions. Click the menu button next to the expression to make the changes.
If you want to cancel out from adding expressions, click inside the Design Manager or press Esc.
Converting Existing Reports with Substitution Variables to Use Expressions
Many existing reports are set up with multiple substitution variables. These reports can be converted to use one substitution variable and many expressions for easier maintenance.
Consider the following model and its current list of substitution variables.
These substitution variables are used in all of the company reports that show data by month, quarter, or year. Below is a report of Salaries by Department. You can see the use of 17 substitution variables in the report.
To convert this report and any other reports to use a single substitution variable, first decide which member should be the starting point that you can create expressions from. For example, if you start with the first month of your fiscal year, then you can use Sibling, Lead, or Lag to offset at the same level to other months. Or go back one level with Parent and use Lead or Lag to offset to quarters, or go back two levels with Parent.Parent and use Lead or Lag to offset to years. Or you can start with the year and use Child expressions to get to the quarters and months.
For this example, we will base all the time entries in the report on the first month of the year. A Designer or Admin user must create the substitution variable.
Define the following substitution variable for the model Sample Salaries and the dimension Time:
FirstMth = Jan 2015
Open the report and go into Design mode.
Select all the cells in the worksheet, then click Design Manager. Scroll down to the Time dimension.
Select the @Month1@ variable, which is currently set to Jan 2015.
Click the Member Select button and click Select Member.
Scroll to find the new variable that you created, FirstMth. Select it and click Select.
The New Value column now shows the @FirstMth@ substitution variable. In grey, Jan 2015 is displayed.
Click Update. The report now displays UPDATED in place of the data cells and @FirstMth@ in place of Jan 2015.
With all the cells in the worksheet still select, click Design Manager again.
Scroll down to the Time dimension and select @Month2@.
Repeat steps 5-6 to replace @Month2@ with @FirstMth@.
Click the Member Select button and click Expression.
Click Add Function and select Lead.
Keep the default Offset of 1, and click Update.
The New Value column now shows the @FirstMth@.Lead(1) substitution variable plus expression. In grey, Feb 2015 is displayed.
Repeat steps 5-6 and 11-12 for the rest of the months, adding one more to the Offset for each subsequent month. Now all the months are expressed in relation to FirstMth.
Click Update to insert these changes into the report.
With all the cells in the worksheet still select, click Design Manager again.
Scroll down to the Time dimension and select @Qtr1@.
Repeat steps 5-6 to replace @Qtr1@ with @FirstMth@.
Click the Member Select button and click Expression.
Click Add Function and select Parent.
Click Update.
Select @Qtr2@.
Repeat steps 5-6 to replace @Qtr2@ with @FirstMth@.
Click the Member Select button and click Expression.
Click Add Function and select Parent.
Click Add Function and select Lead with Offset of 1.
Click Update.
Repeat for the remaining quarters, by creating the following chain expressions for them:
@FirstMth@.Parent.Lead(2) = Q3 2015
@FirstMth@.Parent.Lead(3) = Q4 2015
Click Update to insert these changes into the report.
With all the cells in the worksheet still select, click Design Manager again.
Scroll down to the Time dimension and select @Year@.
Repeat steps 5-6 to replace @Year@ with @FirstMth@.
Click the Member Select button and click Expression.
Click Add Function and select Parent.
Again, click Add Function and select Parent.
Click Update
Click Update to insert these changes into the report.
Now save the report design by clicking Save or Save As. Consider changing the name to preserve the original report with multiple substitution variables until you are confident that the new report is accurate.
Compare the data to your original report to ensure it is accurate.
Click Run to go into Run mode.
When running the report, now you can click the Substitution Variables button on the ribbon to change the FirstMth variable to the first month of any year.
Using Substitution Variables with Excel-based Reporting
If you have reports with substitution variables and expressions, you can use them with Excel-based Reporting.
Open a formatted report and click Capture Data.
When the report is first converted to Excel-based Reporting formulas, you see the substitution variables and expressions in place of the dimension members.
Click Refresh.
Notice that there is no Substitution Variables button on the ribbon, so you cannot change the value of the substitution variable from an Excel-based report. In a future release, similar options will be added so that substitution variables can be changed in Excel-based reports.
Best Practices
Define the master list of substitution variables that you expect to use in all of your standard company reports. This should be a fairly short list, such as: CurMth, CurQtr, CurYr, CurBudget, CurForecast, and so on. Then use expressions to access all other necessary members of your dimension hierarchy.
Limit the chain of expressions to two.
Limitations
Substitution variables are not supported in cascaded reports.
Substitution variables cannot be changed at runtime in Excel-based Reports.
Substitution variables cannot be changed at runtime in a Snapshot.
We recommend to chain together only two expressions in this first release of substitution variables with expressions.
Future Options
The following options will be added in future releases:
Ability to synchronize substitution variables between Host Analytics Planning and Host Analytics Modeling applications.
Ability to change substitution variable values at the time of Calculation definition.
Ability to change substitution variable values in Excel-based Reporting.
Additional Application Settings
Administrators can now set several options to be defaults for Views and Reports. Previously you had to set them one by one using View or Report Properties. These settings set the defaults for views and reports. Existing views and reports will not automatically adopt these defaults.
Select Manage, Application Administration, Application Settings. After making changes, click Save. Then logoff and login again to see the effect of the changes.
View Settings
Suppress Rows and Suppress Columns are options that determine whether rows and columns containing all zeros, all blanks, or a combination of zeros and blanks will be displayed in a view. Use the drop-down to select the types of data to suppress. The default is None.
None
Zero
Blank
Both - Zero & Blank
Additionally, you can specify Yes or No to allow or disallow Designers and Reviewers from making changes to the Suppress Rows and Suppress Columns settings in the properties of individual views. The default is Yes.
When done making changes to Application Settings, click Save. Then logoff and login again to see the effect of the changes.
Report Settings
Suppress Rows, Suppress Columns, and Refresh on POV Change can be set for all formatted reports.
For Refresh on POV Changes, specify Yes or No to automatically refresh the report when the user changes the Point of View. The default is No.
Suppress Rows and Suppress Columns are options that determine whether rows and columns containing all zeros, all blanks, or a combination of zeros and blanks will be displayed in a report. Use the drop-down to select the types of data to suppress. The default is None.
None
Zero
Blank
Both - Zero & Blank
Additionally, you can specify Yes or No to allow or disallow Designers from making changes to these settings in the properties of individual reports. The default is Yes.
When done making changes to Application Settings, click Save. Then logoff and login again to see the effect of the changes.
Audit Log Enhancements
The Audit Log has been enhanced to include additional entries and search with date ranges and paging.
Only administrators have access to the Audit Log. Select Manage, Application Administration, Audit Log.
Additional Entries
The Audit Log now provides log entries for the following activities in the application:
View - Get Data
View - Get Data for All Open Views
Report - Refresh
Report - Refresh All Open Reports
Report - Substitution Variables Refresh
Excel-based Reporting - Refresh
Excel-based Reporting - Refresh All
Date Ranges and Paging in the Audit Log
The Audit Log now has options for viewing entries between two dates, and for paging through large volumes of entries.
The fields highlighted with yellow background are in this release.
From Date - Starting date for which you want to view audit details. The date must be in the format MM/DD/YYYY. By default, From Date shows today's date.
To Date - Ending date for which you want to view audit details. The date must be in the format MM/DD/YYYY. By default, To Date shows today's date.
Total Records - This is a display field only. It shows the number of audit log entries found.
Page Size - This is a display field only. It shows the number of entries shown on each page. The maximum page size is 1000.
Current Page - This is a drop-down list. If there are more than 1000 entries, they are divided into multiple pages. Select which page you want to view then click Refresh. In the example below, page 1 has 1000 entries, and page 2 has 448 entries.
Breakback Changes
The Breakback feature was introduced in Version 2.1.1. As we continue to improve this feature, we are introducing two changes in Version 2.1.2:
Hold is Available for Multiple Dimensions
Breakback on Rollups with Different Operators is Available
Hold is Available for Multiple Dimensions
In Version 2.1.1, Hold was available only for one dimension at a time. For example, you could run Breakback on 2017 and hold one or more members of the Time dimension: Jan-17 and Feb-17, or Q1-2017 and Q2-2017.
In Version 2.1.2, you can hold members from more than one dimension.
In the following example, revenue targets are increased for Mountain Bikes in 2016 but Quarter 1 in International markets is not increased.
Select Cell C10, Mountain Bikes for 2016. Notice that the Q1 value for International is 443,595 and Q1 value for North America is 118,249.
Select the Breakback button on the ribbon.
Select the Current spread.
Under Amount, specify the amount you want to spread. In this case, 2.6M.
Under the Hold box, select Add Dimension Member.
Specify the Time dimension and select Q1 2016. (In Excel, you can also click the Select Range button and simply click on the cell containing the member you want to Hold.)
Select Add Dimension Member again and specify the Department dimension and International member.
Click the Run Calculation button to run the calculation associated with this view after the Breakback is performed.
Click Run Breakback.
Here is the resulting data. Notice that Q1 International remains at 443,595, but Q1 North American has increased to 124,000. Q3 and Q4 also had proportional increases.
Breakback on Rollups with Different Operators Available
In Version 2.1.1, when using Breakback on rollups, all children in the hierarchy must be defined with the plus (+) operator. For example, months roll up to quarters and quarters roll up to a year using the + operator.
In Version 2.1.2, you can use Breakback on rollups with children with any operator, but you must first enable this capability on the Application Settings page. By default, it is disabled.
As a Best Practice, we recommend using Breakback only on rollups with the + operator. Running Breakback will change the data at the leaf level, and if the rollups use any operator other than +, the results of the Aggregation may be unpredictable.
By default, Enable Breakback on other rollup operators is set to No, and Breakback will report an error if you try to use it on rollups with varying operators.
Enabling Breakback on Other Rollup Operators
An administrator must make this change.
Select Manage, Application Administration, Application Settings.
Scroll down to the Model section and look for Enable Breakback on other (~!-) rollup operators.
Select Yes or No from the drop-down.
Click Save.
Logoff and login again to see the effect of the changes.
Known Issues
2975 | Substitution variable and its runtime value should be retained after report is converted to Excel-based Report. |
2974 | User can see substitution variable expression from Excel-based Report but cannot edit it. |
2971 | Breakback does not hold the cells on the report which are locked. |
2873 | Breakback on rollup value from negative to positive may yield weird or incorrect results. |
2778, 2752 | Breakback can be performed on cells that have scaling (i.e. Amount Format) and on cells that are locked from Report. |
2611 | Cascade Reports will not work as expected if the user deletes a Dimension or an Attribute from the Model. |
2492 | If a report which is saved in an excel work book(offline) is renamed then users need to reload that report into the Excel workbook. Best practice is to refresh all reports in the saved workbook before renaming any report. |
2421 | Excel "Compatibility Mode" is Unsupported |
2354 | Snapshot email link will not work for users with SSO integration if they are not logged into the application. As a workaround they should log into the application and then access the Snapshot email link. |
2276 | If user makes any changes to the report (ex:- formatting, adding rows or columns, deleting rows or columns) after running it and then take a Snapshot then user will not see all the changes made to the report and in some cases the snapshot will look weird. We recommend users to take Snapshots without making any changes to changes to the report after its executed |
2113 | Integration between Planning & Modeling applications from web interface is best supported in Google Chrome browser. Users cannot navigate from Planning to Modeling if Internet Explorer compatibility mode is turned on. |
2080 | If users are using Firefox browser, right clicking an item in the Folder structure may display an incorrect menu. |
1845 | If POV member defined is removed or renames, it cannot be fixed in report design mode and error is displayed. |
1492 | Using special characters for the model name results in errors. |
1464 | When suppress rows/columns is enabled, If Dimension Members and Data Intersection are available in same column/row in a report then dimension members will be suppressed along with data intersections. |
1457 | In some cases Suppress blank rows/columns is not working as expected when Groups are expanded in the report. |
1455 | Suppress blank rows/columns is not supported in Spotlight (i.e. Web Interface). |
1454 | In Some cases Suppress blank rows / columns is not working as expected if groups and freeze panes are enabled in the Report. |
1446 | Unable to navigate to Design View after rename or remove HostAnalyze worksheet. |
1406 | Excel 2016 charts containing 3D Clustered Column, 3D Stacked Column, or 3D Stacked Bar are not supported. |
1322 | Unable to cascade with substitution variables. |
1321 | Substitution variables are not working as expected in Cascade Report. |
1273 | Cascade Report has inconsistencies with Filters. |
1144 | Freeze Panes location should not be outside of the sheet viewable range. |
687 | Modified Report definition by removing months column still retain after Refresh. |
The following issues are specific to Excel-based Reporting.
2518 | Reviewer user has no access to Publish Excel-based reports. |
2302 | If there are any Snapshots in the workbook then Convert Entire Workbook option will not convert the workbook. |
2203 | Shared POV status is lost upon changing value of POV in Design Manager / Formatted Report and EBR. |
2199 | Filter member options are not available if only 1 cell from a model exists, in formatted report and EBR. |
2097 | When using Design Manager, Update button is enabled only after entering a valid New Value and hitting enter. |
1887 | It takes over 1 - 3 min to open 22 MB Excel workbook. |
1755 | Locking / Scaling is not applied when converting a Formatted Report to Excel-based Report. |
1699 | It may takes up to couple of hours to Capture Entire Workbook with 30 worksheets and ~7000 data cells or more cells |
1698 | Message shows 'Please contact administrator...' when select Refresh after session timeout. |
1683 | Specifying a relative cell address to a cell in another tab in EBR creates an absolute cell address. |
1672 | Provide an option to reset the Excel workbook so users can upload using a different Report Template. |
1624 | Unable to download the same report as it's being used by another process. |
1550 | Errors when Capture Data as SpotlightXL Formulas with a cascade report. |
Table of contents
- Substitution Variables and Expressions
- Creating Substitution Variables for Reports
- Using Substitution Variables in Reports
- Selecting a Different Value for a Substitution Variable at Runtime
- Using Substitution Variables with Expressions
- Expressions
- Converting Existing Reports with Substitution Variables to Use Expressions
- Using Substitution Variables with Excel-based Reporting
- Best Practices
- Limitations
- Future Options
- Additional Application Settings
- Audit Log Enhancements
- Breakback Changes
- Known Issues