Substitution Variables for Financial Consolidation and Close

The following table is a summary of the Substitution Variables available for Financial Consolidation and Close. For details, see the topic link in the Variable Description.

To add a Substitution Variable, see Creating and Assigning Values to Substitution Variables.

To enable the variable: Set the Cube to Consol unless otherwise noted, and set the Value to True.

Table 6-3 Available Substitution Variables

Category	Variable Name	Default Value	Description
Configurable Calculation Rules	CONFCALC_FCCS XX_DisableCalcDim, for example: CONFCALC_FCCS10_DisableCalcDim	False	If set to True, the system does not generate CALC DIM Logic for specified insertion points in Configurable Calculation scripts. See Configurable Calculation Rules.
Configurable Calculation Rules	CONFCALC_Enable_Rate_Amount_Override	False	If set to True, enables you to use FCCS_Amount Override or FCCS_Rate Override for Consolidation dimension members in FIX statement in Configurable Calculations. See Configurable Calculation Rules.
Configurable Calculation Rules (Partner Eliminations)	EnablePelimNewLogic	False	If you are using Partner Eliminations (PElim) logic in your Configurable Consolidation rules and are experiencing performance degradation as a result, you can use a substitution variable named EnablePelimNewLogic to improve performance. Add this substitution variable and set the value to True. Note that if you are using PELIM where the entity and partner are the same member, your data values may change. See Creating Consolidation Rules.
Configurable Calculation Rules (Partner Eliminations)	OptimizePelimCalculation	False	This substitution variable improves Partner Eliminations (PElim) performance. If there is a consolidation performance degradation when deploying a user-created Partner Eliminations Configurable Consolidation Rule that has an account re-direction, adding this variable can provide significant performance improvement. See Creating Consolidation Rules.
Configurable Consolidation Rules	OptimizeConfigConsol	False	After you deploy configurable consolidation rules, if you need to diagnose performance issues, you can diagnose them manually, or use an automated approach. To enable the automated approach to resolve performance issues, set the value of the OptimizeConfigConsol substitution variable to True. See Creating Consolidation Rules.
Consolidation Process	EnableNewAcqDisp	False	Starting from release 23.04, if the variable is set to True, the System Ownership Adjustments and Eliminations (Acquisitions, Disposals, Entity Proportion Adjustments and Entity Elimination Adjustments) will be written to FCCS_AcquisitionsDisposals under FCCS_TotalInputandAdjusted in the Data Source Dimension. If set to False or does not exist, the System Ownership Adjustments and Eliminations will be written to FCCS_Intercompany Eliminations. Note: this variable is a temporary variable and when removed, the new FCCS_AcquisitionsDisposals member will be used. See Data Source.
Consolidation Process	EnableYearlyConsol	False	This substitution variable can be enabled to improve performance for multi-period consolidations in applications that use the Dense/Sparse Optimization option (where Period and Movement are the Dense dimensions). This substitution variable is applicable if the application meets all of these conditions: The application uses the Dense/Sparse Optimization option (Period and Movement are Dense dimensions) You have two or more dirty periods, and two or more hierarchy levels The dirty entities are identical across periods Equity Pickup sequence is not enabled See Troubleshooting Financial Consolidation and Close Retrieval Performance.
Consolidation Process	OBOC_BEFORE_CONFIG_CONSOL	True	During the consolidation process, the OBOC (Acquisition and Disposal Movement members) are populated before the Configurable Consolidation rules are run. To disable this behavior, set the value of this substitution variable to False.
Consolidation Process	OptimizeConcurrency	False	Create and enable this substitution variable and set its value to True to take advantage of higher concurrency during Consolidations. The Consolidate and Translate business rules in Financial Consolidation and Close execute on multiple entities. Essbase can execute business rules calculations concurrently using multi-threading. Using the OptimizeConcurrency variable forces Financial Consolidation and Close calculations to make judicious use of multiple Essbase process threads so that calculations run faster. See Consolidation and Translation Rules.
Consolidation Process	ParallelCustomDimDSO ParallelCustomDimTranslation	False	These substitution variables improve the performance of the consolidation process in applications with Dense/Sparse Optimization, where the Period and Movement dimensions are Dense dimensions. To see performance improvements, you should set both of these substitution variables to True. See Troubleshooting Financial Consolidation and Close Retrieval Performance. Financial Consolidation and Close uses this algorithm to decide which should be the task dimension for FIXPARALLEL: There are at least two custom dimensions in the application. Financial Consolidation and Close uses the second custom dimension from the bottom. If the dimension has more than 40 members, then it can be a candidate custom dimension. Otherwise, the system does not parallelize on the custom dimension.
Consolidation System Rules	CalcMvmtsPostFCCS10	False	This substitution variable controls the sequence of the Calculate Movements system rule. If the variable is set to True, the Calculate Movements system rule will run after the FCCS_10 rule. If this substitution variable does not exist, or exists but is not set to True, then the Calculate Movements system rule will run before the FCCS_10 rule. See Calculate Movements (from Closing Balance Input).
Currency	ApplicationCurrency ApplicationCurrencyFrom ApplicationCurrencyReporting	True	When you create a multi-currency application, substitution variables are added for the currency that you select as the application currency. The substitution variables allow you to see what the default currency is after the application is created. See Currency.
Data Flow	ProportionalizeTopEntityMembers	False	Data is not translated to parent currency or consolidated to Contribution / Contribution Total for the top entities in the Entity dimension. To change this behavior, add this substitution variable and set the value to True. See Data Flow.
Data Load	DataLoadConsolMember	False	If this substitution variable is set to True, enables you to include members from the Consolidation dimension when clearing data during the Data Load process with the Replace mode enabled. See Data Load Methods.
Data Load	DoNotReverseRFAccountsForCBILoad	False	You can load a data file that contains only the Closing Balance Input data to reverse the prior period non-zero Closing Balance amounts. If reversal of the Roll Forward and CTA accounts is not required, you can set this substitution variable to True before loading data in Replace mode. See Example: Data Import File - Closing Balance Input and Replace Mode.
Data Load	NewLoadYTDClosingBalanceInput	False	When this substitution variable is set to True, Financial Consolidation and Close reverses the YTD closing balance from the prior period, and does not reverse the FCCS_Net Income/FCCS_Owner’s Income in the first period. This allows you to be able to load to Closing Balance Input for both Balance Sheet and Income accounts. See Data Load Methods.
Dimension Member Order Customization	isExportDimEnabled	False	If you have customized the order of seeded members, or made changes to the seeded Account hierarchy, you can retain your changes after each update or Enable Features process. To retain your customized changes, add the isExportDimEnabled substitution variable and set the value to True. See Seeded Dimension Members.
Intercompany Eliminations	DecimalPrecision	False	To ensure that Intercompany Eliminations do not exceed Proportionalization, you can add this substitution variable. Then enter the required number of decimals to consider to achieve decimal precision. The substitution variable value must be an integer (zero or a positive or negative whole number). See Intercompany Eliminations.
Intercompany Eliminations	StrictElimCondition	True	The system applies validations for Intercompany eliminations to be processed only when the correct conditions are met for a partner that is a sibling or a descendant of a sibling of the current entity. If you want to disable this functionality, you can add the StrictElimCondition substitution variable and set it to False. This will allow Intercompany data where the entity and partner are the same to continue to eliminate. See Intercompany Eliminations.
Managing Ownership	LinkOwnershipandDataLocking	True	Changes to Ownership Management are only allowed for Unlocked entities to ensure that changes cannot be made that impact Entity data for which the Approval Unit is already Locked. If you want to disable this functionality, you can add the LinkOwnershipandDataLocking substitution variable and set it to False. When set to False, locking and unlocking requirements will not be applied. See Managing Ownership.
Metadata Solve Order	EnableSolveOrderInput	True	This substitution variable enables you to retain customized Solve Order values for seeded members during application import, upgrade, or an incremental Enable Features process. It is automatically enabled. See Applying SolveOrder for Metadata.
Movement Dimension Members	ExtendMovementScope	True	This substitution variable enables you to include Movement dimension members that are created outside of the FCCS_Movements hierarchy in translation and consolidation calculations. It is automatically enabled. To disable this behavior, set this substitution variable to False. See Translating Data.
On-Demand Rules	ODR_Enable_Rate_Amount_Override	False	If this substitution variable is set to True, it enables you to use FCCS_Amount Override or FCCS_Rate Override for Consolidation dimension members in Run-Time Prompts in On-Demand rules. See Guidelines for On-Demand Rules.
On-Demand Rules	<RuleName>_FP	False	In On-Demand Rules, to run the rule in a FIX, you can add this substitution variable and set the value to False. See Guidelines for On-Demand Rules.
Predicting Consolidation Time	EnablePredictConsolidate	False	If you want the Predict Consolidation Time rule to automatically run whenever the Consolidation rule is run, add this substitution variable and set the value to True. The prediction routine will then be automatically run during Consolidation and you can view the predicted time in the Consolidation rule job log. See Viewing Predicted Consolidation Time.
Refreshing the Database	DeltaDBRefresh	True	Improves database refresh performance by performing only the necessary actions based on metadata changes. This substitution variable is enabled (True) by default. To disable this behavior, set the substitution variable to False. Note: This option is only available for Extended Dimension applications. See Refreshing the Database and Recomputing Ownership Data.
Refreshing the Database	OLURatesLoad	True	This substitution variable is used to improve refresh database performance. It is automatically enabled. See Refreshing the Database.
Reports	EnableExcelNumberFormat	False	For Reports saved as Excel type reports, the EnableExcelNumberFormat substitution variable allows you to automatically display report values in numeric format instead of cell text. See Working with Reports.
Rules	DisableImpactStatusConsolValidation	True	When you use the @FCCSImpactStatus function in Configurable Calculations, by default the DisableImpactStatusConsolValidation substitution variable is enabled, which allows the rule validator to ignore errors and continue with rule execution. To change this behavior and have the rule validator display Impact Status errors, set the value of this substitution variable to False. See FCCSImpact Status Function.
Security	DisableSeededSecurity	False	Default security groups are assigned for some seeded members, and occur during the upgrade, even after you may have previously removed them. To disable this behavior so that security assignments won’t happen after you have removed them, add this substitution variable and set the value to True. See Enabling or Disabling Security for Dimensions.
Smart Lists	IncludeSmartListId	True	By default, the export file contains the ID attribute in the Ownership.Data.xml file. When you perform the migration process, it imports the IDs to be used as Smart List entry IDs internally. To disable this behavior, set the value of this substitution variable to False.
Translation Process	DisableRateThreshold	False	For the historical account default translation, the system checks if the calculated Effective rate is in the scope of (0.1, 10), otherwise it will use the Average rate. When you add and set this variable to True, the system removes the Effective rate threshold for the default translation. See Translating Data.
Translation Process	ExtendAccountScope	True	By default, accounts (Asset, Liability, Equity, Revenue and Expense account type) that reside outside of the Balance Sheet hierarchy will be translated and consolidated in the same manner as those accounts inside the Balance Sheet hierarchy. If you need to disable this translation behavior, use this variable and set the value to False. See Translating Data.
Translation Process	ReportingTransEPAEEA	True	This substitution variable is automatically enabled, so that the FCCS_Entity Proportion Adj and FCCS_Entity Elimination Adj members are translated to Reporting Currency, using the same process that occurs for Entity Input and Entity Consolidation translation. To disable this behavior, set the substitution variable to False. See Translation Process.
Translation Process	TranslateOBOCAcqDispAtPriorER	True	The translation behavior for Acquisition and Disposal Movement dimension members uses the prior period Ending Rate for translation. If you need to disable this translation behavior, use this variable and set the value to False. See Translating Data.
Translation - Default Translation Method	YTDFXCalculation	False	You can select an option to enable the Year-to-Date calculation of FX Opening and FX Movements. This option can be applied when the default Translation Method for Flow accounts is Year-to-Date. To enable the YTD calculation, add the YTDFXCalculation substitution variable and set the value to True. See Specifying Default Translation Settings.
Translation - Default Translation Method	YTDFXRatioThreshold	False	In an application with YTD FX Variance Translation Calculations enabled, in some circumstances, extremely large numbers may occur in OBFXCTA/OBFXCICTA members. To resolve this issue, add the YTDFXRatioThreshold substitution variable and set the value to True. See Specifying Default Translation Settings.
Translation - FX Method	FXTranslationFix	False	In a non-DSO application, when YTD Translation is enabled while FX Method is Periodic, the FX_Movement member is translated using YTD instead of Periodic when the FCCS_Mvmts_Subtotal member is missing. To change this behavior, add the FXTranslationFix substitution variable and set it to True. See Specifying Default Translation Settings
Translation Sequence	skipTransRulesIfOverrideRatesExist	True	In the translation process, Translation Override rules are executed before Translation Override entries. If you do not want override rules to be processed before Amount / Rate override entries, add this variable and set it to False. See Translating Data.