Go to main content
1/596
Contents
Title and Copyright Information
Documentation Accessibility
Documentation Feedback
1
Overview of
Calculation Manager
About
Calculation Manager
How Roles Affect What You Can Do in
Calculation Manager
Launching
Calculation Manager
Viewing Objects in
Calculation Manager
Customizing the Columns in a View
Filtering Objects
Using Queries to Filter Objects
Looking at a Graphical Picture of a Rule, Component, or Template
2
Designing Business Rules
About Business Rules
Creating a Business Rule
Selecting Execution Variables to Use as Parameters
Using Parameters as a Business Rule
Opening a Business Rule
Editing a Business Rule
Editing a Business Rule in Script Mode
Saving Business Rules
Saving a Business Rule
Saving a Business Rule with a Different Name
Running a Business Rule
Copying Business Rules
Searching in Business Rules
Searching for a Text String in a Business Rule Script
Searching for and Replacing Text in a Graphical Business Rule
Printing a Business Rule
Deleting a Business Rule
Defining Common Dimensions In Business Rule Components
Analyzing and Debugging Business Rules
Analyzing Business Rules
Hiding Members of Tracked Dimensions
Capturing Statistical Information
Analyzing the Script of a Business Rule
Comparing the Scripts of Business Rules
Comparing a Changed Business Rule to a Saved Business Rule
Debugging Business Rules
Disabling a Component in a Business Rule
Loading Predefined
Workforce Planning
,
Capital Asset Planning
, and
Human Capital Management
Business Rules
Creating a Shortcut to a Business Rule
Refreshing Business Rules or Business Rulesets
Showing the Usages of a Business Rule or Ruleset
Changing the Owner of an Object
3
Designing Business Rule Sets
About Business Rulesets
Creating a Business Ruleset
Opening a Business Ruleset
Opening a Business Rule Within a Business Ruleset
Adding a Business Rule to a Business Ruleset
Removing a Business Rule from a Business Ruleset
Copying a Business Ruleset to Another Application
Savings Business Rulesets
Deleting a Business Ruleset
4
Working with System Templates
About System Templates
Using System Templates
Using the Clear Data Template
Using the Copy Data Template
Using the Amount-Unit-Rate Template
Using the Allocate - Level to Level Template
Using the Allocation Template
Using the Aggregation Template
Using the SET Commands Template
Using the Currency Conversion Template
Currency Conversion Template Example
Using the Export-Import Data Template
Showing the Template Flow
Saving a System Template as a Custom Template
Removing a System Template from a Business Rule
5
Working with Custom Templates
About Custom Templates
Creating a Custom Template
Creating a Graphical Custom Template
Example of Creating a Graphical Template that Uses an UpperPOV Design-Time Prompt
Creating a Script Custom Template
Creating Design-Time Prompts for Custom Templates
Attribute DTP
Boolean DTP
Cross Dimension DTP
Condition DTP
Dimension DTP
Dimensions DTP
Member DTP
Members DTP
Member Range DTP
Numeric DTP
Password DTP
Restricted List DTP
Separator DTP
String DTP
Creating Steps for Design-Time Prompts
Defining Dependencies for Design-Time Prompts
Defining Dimension Limits for Cross Dimension, Dimension, Dimensions, Member, and Member Range Design-time Prompts
Finding and Replacing Text in Design-Time Prompts
Opening a Custom Template
Refreshing Custom Templates
Showing the Usages of a Custom Template
Copying and Pasting a Custom Template
Deleting a Custom Template
Finding and Replacing Text in Graphical Custom Templates
6
Using Components to Design Business Rules and Templates
About Components
Formula Components
About Formula Components
Creating a Formula Component
Designing a Formula Component
Using the Condition Builder to Create Conditional Statements
Entering Logging Information for Formula Statements (Financial Management Users Only)
Entering Comments for Formula Statements
Opening a Formula Component
Editing a Formula Component
Deleting a Formula Component
Copying and Pasting a Formula Component
Script Components
Creating a Script Component
Designing a Script Component
Opening a Script Component
Editing a Script Component
Deleting a Script Component
Copying and Pasting a Script Component
Condition Components
About Condition Components
Creating a Condition Component
Opening a Condition Component
Editing a Condition Component
Deleting a Condition Component
Copying and Pasting a Condition Component
Member Block Components
About Member Block Components
Creating a Member Block Component
Opening a Member Block Component
Editing a Member Block Component
Deleting a Member Block Component
Copying and Pasting a Member Block Component
Member Range Components
About Member Range Components
Creating a Member Range Component
Opening a Member Range Component
Editing a Member Range Component
Deleting a Member Range Component
Copying and Pasting a Member Range Component
Data Range Components (
Financial Management
Users Only)
About Data Range Components (
Financial Management
Users Only)
Creating a Data Range Component (
Financial Management
Users Only)
Opening a Data Range Component (
Financial Management
Users Only)
Editing a Data Range Component (
Financial Management
Users Only)
Deleting a Data Range Component (
Financial Management
Users Only)
Copying and Pasting a Data Range Component (
Financial Management
Users Only)
Cell Text Range Components (
Financial Management
Users Only)
About Cell Text Range Components (
Financial Management
Users Only)
Creating Cell Text Range Components (
Financial Management
Users Only)
Opening Cell Text Range Components (
Financial Management
Users Only)
Editing Cell Text Range Components (
Financial Management
Users Only)
Deleting Cell Text Range Components (
Financial Management
Users Only)
Copying and Pasting Cell Text Range Components (
Financial Management
Users Only)
Fixed Loop Components
About Fixed Loop Components
Creating a Fixed Loop Component
Opening a Fixed Loop Component
Editing a Fixed Loop Component
Deleting a Fixed Loop Component
Copying and Pasting a Fixed Loop Component
Metadata Loop Components
About Metadata Loop Components
Creating Metadata Loop Components
Opening Metadata Loop Components
Deleting Metadata Loop Components
Copying and Pasting Metadata Loop Components
DTP Assignment Components
About DTP Assignment Components
Creating DTP Assignment Components
Opening DTP Assignment Components
Editing DTP Assignment Components
Deleting DTP Assignment Components
Copying and Pasting DTP Assignment Components
Using Design-Time Prompt Functions in DTP Assignment Components
About Design-Time Prompt Functions
@AvailDimCount
@OpenDimCount
@ValueDimCount
@Compare
@Compliment
@Concat
@DenseMember
@Dependency
@DimAttribute
@DimMember
@DimName
@DimType
@DimUDA
@EndsWith
@Evaluate
@FindFirst
@FindLast
@GetData
@Integer
@Intersect
@IsSandBoxed
@IsDataMissing
@IsVariable
@Length
@Matches
@Member
@MemberGeneration
@MemberLevel
@MsgFormat
@Notin
@Plandim
@PlanDimMember
@Quote
@RemoveQuote
@ReplaceAll
@ReplaceFirst
@SmartListFromIndex
@SmartListFromValue
@SparseMember
@StartsWith
@SubString
@ToLowerCase
@ToUpperCase
@ToMDX
@Trim
@Union
Sharing Script and Formula Components
Changing Formula and Script Components from Shared to Not Shared
Changing Formula and Script Components from Not Shared to Shared
Copying Components
Copying and Pasting the Children of a Business Rule Component
Copying and Pasting the Reference to a Business Rule Formula or Script Component
Saving Components
Saving a Component
Saving Formula and Script Components with a Different Name
Refreshing Formula and Script Components
Showing the Usages of Formula and Script Components
Working with Components in a Flow Chart
Collapsing and Expanding a Component in a Flow Chart
Removing a Component from a Flow Chart
Copying and Pasting a Component in a Flow Chart
Copying and Pasting a Reference to a Component in a Flow Chart
Copying and Pasting a Component Group in a Flow Chart
7
Using Aggregate Storage Components to Design Business Rules
Working with Point of View Components
Creating a Point of View Component
Editing a Point of View Component
Working with Allocation Components
Creating an Allocation Component
Editing an Allocation Component
Opening a Point of View or Allocation Component
Deleting a Point of View or Allocation Component
Copying and Pasting a Point of View or Allocation Component
Saving a Point of View or Allocation Component
Working with Aggregate Storage Formula Components
Creating an Aggregate Storage Formula Component
Opening an Aggregate Storage Formula Component
Editing an Aggregate Storage Formula Component
Deleting an Aggregate Storage Formula Component
Copying and Pasting an Aggregate Storage Formula Component
Copying an Aggregate Storage Formula Component to Another Application or Database
Showing an Aggregate Storage Formula Component's Usages
8
Using Member Selection, Variables, Functions, Smart Lists, and Planning Formula Expressions to Design Components
About Member Selection, Variables, Functions, and Smart Lists
Working with Members
About Adding Members and Functions to a Component
Adding One Member or Function from One or More Dimensions to a Component
Adding Multiple Members or Functions from One or More Dimensions to a Component
Removing Members and Functions from a Component
Searching for Members within the Member Selector
Searching for Members in the Member Selector by Name, Alias, or Property
Working with Variables
About Variables
Creating a Variable
Entering Variable Values for a Numeric Variable
Entering Variable Values for a String Variable
Entering Values for an Array Variable
Entering Values for a Member Range Variable
Entering Variable Values for a Cross Dimension Variable
Entering Variable Values for a Dimension Variable
Entering Variable Values for a Member or Members Variable
Entering Variable Values for Percent Variables
Entering Values for Integer Variables
Entering Variable Values for String as Number Variables
Entering Variable Values for Date as Number Variables
Entering Values for a Data Range Variable (
Financial Management
Users Only)
Entering Values for a Boolean Variable (
Financial Management
Users Only)
Entering Values for a Log Information Variable (
Financial Management
Users Only)
Entering Runtime Prompt Variables
Selecting a Variable
Editing a Variable
Deleting a Variable
Refreshing Variables
Copying a Variable
Finding and Replacing Text in the Variable Designer
Showing the Usages of a Variable
Loading Predefined System Variables into
Financial Management
Applications (
Financial Management
Users Only)
Working with Functions
Working with Custom Functions
About Custom Functions
Bitwise Functions
@CalcMgrBitAnd
@CalcMgrBitOR
@CalcMgrBitExOR
@CalcMgrBitExBoolOR
@CalcMgrBitCompliment
@CalcMgrBitShiftLeft
@CalcMgrBitShiftRight
@CalcMgrBitUnsignedShiftRight
Counter Functions
@CalcMgrCounterAddNumber
@CalcMgrCounterAddText
@CalcMgrCounterClear
@CalcMgrCounterClearAll
@CalcMgrCounterClearKey
@CalcMgrCounterDecrement
@CalcMgrCounterDecrementKey
@CalcMgrCounterGetKeyNumber
@CalcMgrCounterGetKeyText
@CalcMgrCounterGetNumber
@CalcMgrCounterGetText
@CalcMgrCounterIncrement
@CalcMgrCounterIncrementKey
@CalcMgrCounterUpdate
@CalcMgrCounterUpdateNumber
@CalcMgrCounterUpdateNumberText
@CalcMgrCounterUpdateText
Date/Time Functions
@CalcMgrAddDate
@CalcMgrAddDatePart
@CalcMgrAddDays
@CalcMgrAddMonths
@CalcMgrAddWeeks
@CalcMgrAddYears
@CalcMgrDateDiff
@CalcMgrDateTimeToExcel
@CalcMgrDateToExcel
@CalcMgrDateToString
@CalcMgrDaysBetween
@CalcMgrDaysDiff
@CalcMgrDiffDate
@CalcMgrExcelADD
@CalcMgrExcelDATE
@CalcMgrExcelDATEDIF
@CalcMgrExcelDAYOFYEAR
@CalcMgrExcelDAYS360
@CalcMgrExcelDAYSINMONTH
@CalcMgrExcelEDATE
@CalcMgrExcelEOMONTH
@CalcMgrExcelHOUR
@CalcMgrExcelMINUTE
@CalcMgrExcelMONTH
@CalcMgrExcelNETWORKDAYS
@CalcMgrExcelSECOND
@CalcMgrExcelToDate
@CalcMgrExcelToDateTime
@CalcMgrExcelWEEKNUM
@CalcMgrExcelWEEKDAY
@CalcMgrExcelWORKDAY
@CalcMgrExcelYEAR
@CalcMgrExcelYEARFRAC
@CalcMgrGetCurrentDate
@CalcMgrGetCurrentDateTime
@CalcMgrGetCustomDateTime
@CalcMgrGetCustomDate
@CalcMgrGetDatePart
@CalcMgrGetDateTimePart
@CalcMgrGetDay
@CalcMgrGetDayOfYear
@CalcMgrGetFormattedDate
@CalcMgrGetMaxDaysInMonth
@CalcMgrGetMonth
@CalcMgrGetStringFormattedDateTime
@CalcMgrGetWeekOfMonth
@CalcMgrGetWeekOfYear
@CalcMgrGetYear
@CalcMgrIsLeapYear
@CalcMgrMonthsBetween
@CalcMgrMonthsDiff
@CalcMgrRollDate
@CalcMgrRollDay
@CalcMgrRollMonth
@CalcMgrRollYear
@CalcMgrWeeksBetween
@CalcMgrWeeksDiff
@CalcMgrYearsBetween
@CalcMgrYearsDiff
Financial Functions
@CalcMgrExcelACCRINT
@CalcMgrExcelACCRINTM
@CalcMgrExcelAMORDEGRC
@CalcMgrExcelAMORLINC
@CalcMgrExcelCOUPDAYBS
@CalcMgrExcelCOUPDAYS
@CalcMgrExcelCOUPDAYSNC
@CalcMgrExcelCOUPNCD
@CalcMgrExcelCOUPNUM
@CalcMgrExcelCOUPPCD
@CalcMgrExcelCUMIPMT
@CalcMgrExcelCUMPRINC
@CalcMgrExcelDB
@CalcMgrExcelDDB
@CalcMgrExcelDISC
@CalcMgrExcelDOLLARDE
@CalcMgrExcelDOLLARFR
@CalcMgrExcelDURATION
@CalcMgrExcelEFFECT
@CalcMgrExcelFV
@CalcMgrExcelFVSCHEDULE
@CalcMgrExcelMDURATION
@CalcMgrExcelINTRATE
@CalcMgrExcelIPMT
@CalcMgrExcelIRR
@CalcMgrExcelISPMT
@CalcMgrExcelMIRR
@CalcMgrExcelNPER
@CalcMgrExcelNPV
@CalcMgrExcelPMT
@CalcMgrExcelPPMT
@CalcMgrExcelPRICE
@CalcMgrExcelPRICEDISC
@CalcMgrExcelPRICEMAT
@CalcMgrExcelPV
@CalcMgrExcelRATE
@CalcMgrExcelRECEIVED
@CalcMgrExcelSYD
@CalcMgrExcelSLN
@CalcMgrExcelTBILLEQ
@CalcMgrExcelTBILLPRICE
@CalcMgrExcelTBILLYIELD
@CalcMgrExcelXIRR
@CalcMgrExcelXNPV
@CalcMgrExcelYIELD
@CalcMgrExcelYIELDDISC
@CalcMgrExcelYIELDMAT
Log Functions
@CalcMgrLog
@CalcMgrLogText
Math Functions
@CalcMgrExcelCEILING
@CalcMgrExcelCOMBIN
@CalcMgrExcelEVEN
@CalcMgrExcelFACT
@CalcMgrExcelFLOOR
@CalcMgrExcelGCD
@CalcMgrExcelLCM
@CalcMgrExcelMROUND
@CalcMgrExcelMULTINOMIAL
@CalcMgrExcelODD
@CalcMgrExcelPOWER
@CalcMgrExcelPRODUCT
@CalcMgrExcelROUNDDOWN
@CalcMgrExcelROUNDUP
@CalcMgrExcelSQRT
@CalcMgrExcelSQRTPI
@CalcMgrExcelSUMPRODUCT
@CalcMgrExcelSUMSQ
MaxL Functions
@CalcMgrExecuteEncryptMaxLFile
@CalcMgrExecuteMaxLScript
Using MaxL Encryption
Executing a MaxL Script File Using @CalcMgrExecuteEncryptMaxLFile
Executing a MaxL Script Using the @CalcMgrExecuteMaxLScript
MDX Functions
@CalcMgrMDXDataCopy
@CalcMgrMDXDataCopyRTP
@CalcMgrMDXDataCopyServer
@CalcMgrMDXExport
@CalcMgrMDXExportRTP
Statistical Functions
@CalcMgrExcelAVEDEV
@CalcMgrExcelDEVSQ
@CalcMgrExcelLARGE
@CalcMgrExcelMEDIAN
@CalcMgrExcelSMALL
@CalcMgrExcelSTDEV
@CalcMgrExcelVAR
@CalcMgrExcelVARP
String Functions
@CalcMgrCompare
@CalcMgrConcat
@CalcMgrDecimalFormat
@CalcMgrDoubleFromString
@CalcMgrDoubleToString
@CalcMgrDQuote
@CalcMgrEndsWith
@CalcMgrFindFirst
@CalcMgrFindLast
@CalcMgrFormatDouble
@CalcMgrGetListCount
@CalcMgrGetListItem
@CalcMgrIndexOf
@CalcMgrIntegerToString
@CalcMgrLastIndexOf
@CalcMgrLowercase
@CalcMgrMatches
@CalcMgrMessageFormat
@CalcMgrPadText
@CalcMgrUppercase
@CalcMgrRemoveQuotes
@CalcMgrRemoveDQuotes
@CalcMgrRemoveSQuotes
@CalcMgrReplaceAll
@CalcMgrReplaceFirst
@CalcMgrSortAndReturn
@CalcMgrSortList
@CalcMgrSortValues
@CalcMgrSplit
@CalcMgrSQuote
@CalcMgrStartsWith
@CalcMgrStringsToString
@CalcMgrSubstring
@CalcMgrTextLength
@CalcMgrTrim
Inserting Functions into Components
Working with Smart Lists
Inserting Smart Lists
Working with Planning Formula Expressions
SmartLists
Dimensions
Planning User Variables
Periods
Period(periodName)
NumberofPeriodsinYear and NumberofYears
Scenarios
Cross-References
CrossRef(accountName)
CrossRef(accountName, prefix)
CrossRef(accountName, prefix, true)
Workforce Cube Year to Date
CYTD(memberName)
CYTD(memberName, calTpIndexName, fiscalTPIndexName)
Get ID for String
9
Validating and Deploying
Validating Business Rules, Business Rulesets, and Formula and Script Components from the System View
Validating a Business Rule from the Rule Designer
Deploying Business Rules and Business Rulesets
Making Business Rules and Business Rulesets Deployable and Not Deployable
Deploying Business Rules and Business Rulesets from the Deployment View
Deploying a Business Rule or Business Ruleset from the Rule or Ruleset Designer
Deploying Business Rules with Shortcuts
10
Launching Business Rules
About Launching Business Rules
Launching
Essbase
Business Rules from the System View and the Rules Designer
Launching
Essbase
Business Rules with the Command Line Launcher
Command Line Launcher Example and Arguments
Using a Bat File in Windows to Run the Command Line Launcher
Launching
Planning
Business Rules and Viewing Logs from the Rule Designer
11
Exporting and Importing Business Rules, Business Rulesets, Templates, and Formula and Script Components
About Exporting and Importing
Exporting Business Rules, Business Rulesets, Templates, and Formula and Script Components
Exporting Applications
Exporting Log Messages to a File
Importing Rules, Rulesets, Templates, Formulas, and Scripts
Importing
Essbase
Calc Scripts as Graphical Business Rules
12
Administering
Essbase
Servers, Applications, and Databases for
Planning
Applications
Working with Database Properties
Viewing and Editing Database Properties
General Database Properties
Dimension Properties
Statistics Properties
Statistics for Aggregate Storage Applications
Statistics for Block Storage Applications
Transactions Properties
Modifications Properties
Currency Properties
Cache Properties
Writing and Launching MaxL Scripts
Removing Locks from Database Objects
Starting and Stopping Applications
Starting and Stopping Databases
Deleting Application Log Files
Restructuring a Database
Creating Simulations to Help Optimize Database Settings
Clearing Data from the Database
Clearing Data From Aggregate Storage Applications
Clearing Blocks of Data From Block Storage Applications
Working With Location Aliases for Block Storage Applications
Displaying a List of Location Aliases
Exporting a Location Alias
Creating a Location Alias
Deleting a Location Alias
Using Query Tracking on Aggregate Storage Databases
Compacting Aggregate Storage Database Outlines
Exporting and Importing Level Zero Data From an ASO Cube
Merging Incremental Data Slices
Aggregating Data
Executing the Aggregation Process
Merge Incremental Data Slices and Remove Zero Value Cells
Enable Query Tracking
Perform Actions to Create Queries
Execute Aggregation Using Query Tracking
Managing Requests
Adding
Planning
Drill Through Definitions
A
Using Administrator Features
Transitioning to
Calculation Manager
Scripting on this page enhances content navigation, but does not change the content in any way.