Dynamic Planning Data Locking
- 7 Minutes to read
- Print
- DarkLight
- PDF
Dynamic Planning Data Locking
- 7 Minutes to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The Data Locking page provides a way to specify data in one or more models that should be locked. Data locks protect data from being overwritten by data entry, Breakback, formulas, and calculations. Data locking differs from dimension security in the following ways:
- Data that is locked is visible to the user but cannot be modified by anyone. Data locking is global.
- Data that is protected with dimension security is not visible to the user and cannot be modified by the user. Dimension security is specific to the users for which it is defined.
Data Locking can be applied to Views, Reports, and Models.
Note:
Data Locking in Models is an opt-in feature. Contact Planful Support if you want to use Model Data Locking. Model Data Locking prevents any map, formula, calculation, data load, or API call from modifying the data that is locked.
Users with Contributor or Power access can use the Data Locking page. To access this page, go to Model > Model Administration > Data Locking.
Data Locking is a two-step process:
- Set up the data locking definitions via Model > Model Administration > Data Locking.
- Turn on or off all data locking in the application on the Manage > Application Administration > Application Settings page. This step must be done by a Power user.
To learn how to turn Data Locking on or off, see:
- Application-Level Data Locking for Views
- Application-Level Data Locking for Reports
- Application-Level Data Locking for Models
Spreadsheet Fields Described on the Data Locking Page
The spreadsheet fields on the Data Locking subtask are described. Navigate to Model > Model Administration > Data Locking.
Model - Select the model to apply data locks to. Select All Models to view all data locking definitions.
Note:
When viewing All Models, you cannot make changes. You must select a particular model to make changes to its data locks.
Data Locking in Views - Indicates whether Data Locking is turned on or off for Views. Application Level data locking globally applies to all the Views and all Models in the Dynamic Planning application and for all users. None indicates that data locking is not enforced in Views. This indicator is read-only. Only Power users can change this setting in Manage > Application Administration > Application Settings.
Data Locking in Reports - Indicates whether Data Locking is turned on or off for Reports. Application Level data locking globally applies to all the Reports and all Models in the Dynamic Planning application and for all users. None indicates that data locking is not enforced in Reports. This indicator is read-only. Only Power users can change this setting in Manage > Application Administration > Application Settings.
Data Locking in Models - Indicates whether Data Locking is turned on or off for Model actions. Application Level data locking globally applies to all model actions that modify data, such as maps, formulas, calculations, data loads, or API calls. This applies to all models in the Dynamic Planning application and for all users. None indicates that data locking is not enforced in Model actions. This indicator is read-only. Only Power users can change this setting in Manage > Application Administration > Application Settings.
Note:
Data Locking in Models is an opt-in feature. You must contact Planful Support if you want to use Model Data Locking.
The Data Locking table lists models with the names of their dimensions as column headings.
Populate the Data Locking table by selecting the member(s) in each dimension that you want to lock. If you select a parent-level member, all leaf level members under that parent will be locked, but the parent-level members will not be locked.
Note:
When viewing data locks for All Models, you cannot make changes. You must select a particular model to make changes to its data locks.
The following example locks all data in member combinations that include any leaf members in the 2021 hierarchy in the Time dimension.
The following example locks all data in member combinations that include any leaf members in the 2021 hierarchy in the Time dimension and locks all data in member combinations that include Actual in the Scenario dimension.
The following example locks all data in member combinations that include any leaf members in the 2021 hierarchy in the Time dimension and Actual in the Scenario dimension.
Data that is locked appears with a gray background in views and reports.
How Data Locking Works
Many different operations in Dynamic Planning can make changes to data. Data Locking lets you specify which data cannot be modified when data locking is enabled. Application Settings let you enable data locking.
Data Locking can be independently applied to:
- Views
- Reports
- Models. This is an opt-in feature. You must contact Planful Support to request this option.
Only leaf dimension members can be locked. However, you can specify to lock a parent-level dimension member as an easy way to automatically lock all of the leaf members under that parent.
| Operation | Which Application Setting Controls This Operation | Description |
|---|---|---|
View, the user saves the data they entered | Application Setting > View Properties > Data Locking | Leaf data intersections that are locked are not saved. Leaf data intersections that are unlocked are saved. |
View, calculation runs after the user clicks Save | Application Setting > Model Properties > Data Locking | See Model Calculation below. |
View, the user runs Breakback | Application Setting > View Properties > Data Locking | Breakback applies a Hold for locked members and member combinations. |
Report, the user saves the data they entered | Application Setting, Report Properties, Data Locking | Leaf data intersections that are locked are not saved. Leaf data intersections that are unlocked are saved. |
Report, calculation runs after the user clicks Save | Application Setting > Model Properties > Data Locking | See Model Calculation below. |
Report, the user runs Breakback | Application Setting > Report Properties > Data Locking | Breakback applies a Hold for locked members and member combinations. |
Model, data is loaded using the Data menu item or an API | Application Setting > Model Properties > Data Locking | Leaf data intersections that are locked are not loaded. Leaf data intersections that are unlocked are loaded. |
Model, data is loaded using the Import menu item or an API | Application Setting > Model Properties > Data Locking | Data intersections that are locked are not loaded. Data intersections that are unlocked are loaded. |
Model, data is loaded from an External Source Model or an API | Application Setting > Model Properties > Data Locking | Leaf data intersections that are locked are not loaded. Leaf data intersections that are unlocked are loaded. |
Model Calculation: | Application Setting, Model Properties, Data Locking | A calculation with multiple steps will run all the steps that it can run successfully. |
| Application Setting, Model Properties > Data Locking | Leaf data intersections that are locked are not cleared. Leaf data intersections that are unlocked are cleared. |
| None. | Since only leaf-level member intersections are locked, Rollup Data will be cleared. |
| Application Setting > Model Properties > Data Locking | Leaf data intersections that are locked are not cleared. Leaf data intersections that are unlocked are cleared. All rollup data is cleared. |
| None. | Since Aggregation does not modify leaf-level data, and only leaf-level member intersections are locked, Aggregation proceeds normally. |
| Application Setting > Model Properties > Data Locking | Breakback applies a Hold for locked members and member combinations. |
| Application Setting > Model Properties > Data Locking | Leaf data intersections that are locked are not modified by the formula. Leaf data intersections that are unlocked are modified by the formula. |
| Application Setting > Model Properties > Data Locking | Leaf data intersections that are locked are not modified by the map. Leaf data intersections that are unlocked are modified by the map. |
Model > Clear Model | None. | Data Locking does not prevent data from being removed with Clear Model. |
Model > Generate Model | None. | Data Locking does not prevent data from being loaded with Generate Model. |
Examples of Data Locking
Lock Closed Periods in a Forecast Scenario
Lock Prior Year Historical Values
Lock the Budget Scenario After Data Input is Complete
Lock Specific Accounts from Data Input
Best Practices with Data Locking
- We recommend to set the data locking property for Views and Report to Application Level.
- For Model tasks, such as running a calculation, loading data from the interface or an API, the recommendation is to set to Application Level based on the need.
- Once data locking is enabled, the leaf combinations defined in the data locking user interface will not be modified.
- Once data locking for Model tasks is enabled, you can run an aggregation for a given year, even though it may contains some leaf members that are locked. When aggregation runs for that year, the locked leaf members are not modified, but it will rollup members will be aggregated in the model. This behavior is the same for other steps in the calculation.
- Users can select the root member for any dimension in the data locking user interface. When the setup is saved, the root member selection is ignored as this is explicit. Selecting a root member or not selecting a root member is the same as selecting all the leaf members for the selected dimension for locking. As an example Scenario: Actual, Time: All Time is defined in the data locking, there is no need to specify the root member ‘All Time’ on the Time dimension because the data is locked for all leaf members combinations for Actual Scenario.
Was this article helpful?