Difference between revisions of "Writeback Formatting, Cell Locking and Data Validation"

(Created page with "Once writeback has been enabled for a grid, it is possible to use the Formatting_Grids#Format_sheet and additional Custom Format Areas to format or lock some grid cell...")
 
m (Text replacement - "XLCubed" to "FluenceXL")
 
(70 intermediate revisions by one other user not shown)
Line 1: Line 1:
Once [[writeback]] has been enabled for a grid, it is possible to use the [[Formatting_Grids#Format_sheet]] and additional Custom Format Areas to format or lock some grid cells.  
+
When [[writeback]] is enabled for a grid, it is possible to use the [[Formatting_Grids#Format_sheet|format sheet]] as well as additional Custom Format Areas to format and lock the grid cells.  
 +
==Enabling writeback for a grid==
  
 +
In an FluenceXL grid, data entry mode is turned on by ticking the ‘Enable Writeback’ box in the Grid Properties window.
 +
[[Image:01_WBFformattingLocking.png|500px|centre]]
  
====
 
  
 +
If you’re using FluenceXL, you also need to enable data entry mode at the workbook level from the FluenceXL\Options\Workbook Options menu item.
 +
[[File:02 WBFformattingLocking.png|500px|center]]
  
Writeback allows you to either permanently edit values in the Cube (if the administrator has allowed it), or to do simple what-if analysis in Excel.
+
Please refer to the [[writeback]] page for further details.
  
XLCubed Excel Edition supports writeback in a number of ways through [[Grid Reporting Overview|Grids]], Formula-based and relational writeback. In both cases the cube itself must be write enabled.
+
==Basic data entry formatting==
  
==Writeback in XLCubed Grids==
+
===Highlighting cells===
 +
You can highlight writeable data cells by:
  
To enable writeback on an XLCubed Grid, select {{Menu|XLCubed|Properties...}} from the Grid right-click menu, then select the Enable Writeback option from the '''Writeback''' tab. On this tab you can also adjust a few other options, described below.
+
1. Ticking ‘Highlight Data’ box in the Grid Properties window:
 +
[[File:03 WBFformattingLocking.png|400px|center]]
  
===Online Entry Mode===
+
2. Defining a format for the ‘Writeable Member’ data cell in the FluenceXLFormats sheet:
 +
[[File:04 WBFformattingLocking.png|400px|center]]
  
Using Online mode, each value is submitted to the cube when typed: the value will be written and the data optionally re-retrieved (so that any aggregated data is updated straight away on the report).
+
Here is the result:
 +
[[File:05 WBFformattingLocking.png|800px|center]]
  
By default, entry is allowed only at the leaf level of the data, as this is the most common environment.
 
  
===Offline Entry Mode===
+
You can also provide visual feedback for the user during the data entry process by highlighting the cells that were changed and the ones that were impacted:
  
In Offline mode, you can enter multiple updates at once, then submit them in one batch. To view the updates that are ready to be sent to the server, select the {{Menu|XLCubed|Writeback|Manage Offline Writeback}} right-click menu option, and to upload the changes, select {{Menu|XLCubed|Writeback|Submit Outstanding Writes}}.
+
1. Select ‘Show Updates’ under refresh type after writeback
 +
[[File:06 WBFformattingLocking.png|400px|center]]
  
===Non-Leaf Level Writeback===
+
2. Define a format for the changed cells (‘Written Cell’) and the impacted ones (‘Summary written cell’)
 +
[[File:07 WBFformattingLocking.png|400px|center]]
  
When not entering data at leaf level, you must choose from the four Analysis Services spreading methods:
+
Here is the result:
 +
[[File:08 WBFformattingLocking.png|700px|center]]
  
{| class="wikitable"
+
===Using offline data entry mode===
! Method !! Description
+
Using the offline data entry mode is recommended for performance reasons. When this mode is activated, the journal of pending changes can be viewed by clicking the ‘Manage…’ button in the grid's properties window.
|-
+
[[File:09 WBFformattingLocking.png|800px|center]]
| Equal allocation || Each constituent cell is assigned an equal value
 
|-
 
| Equal increment || Every constituent cell will be changed according to an incremental value
 
|-
 
| Weighted allocation || Each constituent cell will be assigned an equal value that is weighted against a formula
 
|-
 
| Weighted increment || Every constituent cell is changed incrementally according to a weighting formula
 
|}
 
  
Data can then be entered for aggregate levels in the cube, and will be spread according to the rule specified.
 
  
Note that non-leaf Writeback in the Analysis Services environment should be used with caution since it can be time-consuming, depending on cube size and dimensionality.
+
All changes can then be saved or discarded at once by using the buttons in the ‘Editing’ ribbon.
 +
[[File:10 WBFformattingLocking.png|800px|center]]
  
==Formula Writeback==
 
  
There are two XLCubed formulae which handle Analysis Services writeback:[[XL3DoWriteback|XL3DoWriteback formula]] and [[XL3LookupRW|XL3LookupRW formula]].
+
Note that you still need to be connected to the underlying cube / model to use the offline data entry mode.
  
XL3DoWriteback allows a value held in another cell to be written back to the cube whereas with XL3LookupRW the formula itself is overwritten directly.
+
==Formatting and locking cells==
  
In most cases XL3DoWriteback offers more flexibility and control.
+
When writeback is enabled for a grid, any cell can be changed which means that data entry permissions are based on the security defined in the source cube/model.
 +
You can change this default behaviour and control which cells should be allowed at the grid level by ticking the ‘Cells must be unlocked’ box in the Grid Properties window.
 +
[[File:11 WBFformattingLocking.png|600px|center]]
  
  
There is also [[XL3RunSQL|XL3RunSQL formula]] which is available for relational SQL updates.
+
As cells grid cells are by default locked in the format sheet, any writeback is then prevented in the grid.
 +
[[File:12 WBFformattingLocking.png|600px|center]]
  
==Relational Writeback==
 
  
In {{Menu|XLCubed|Options|Workbook Options}}, you can specify whether to use Standard (Analysis Services) or Relational writeback. Relational writeback requires certain cube customisations, and is typically a consultancy-led process to provide additional flexibility or performance over the standard writeback processing.
+
[[File:13 WBFformattingLocking.png|600px|center]]
  
Please see the main article for more information: [[Relational Writeback]]
+
===Formatting/Locking scenarios using the format sheet===
 +
The locking of specific slices of data follows the same rules as the standard FluenceXL formatting ones defined in the ‘FluenceXLFormats’ sheet. Please read the [[Formatting_Grids|Formatting Grids]] page for more details.
 +
 
 +
The following examples illustrate different cell locking scenarios.
 +
 
 +
====Unlocking all the lowest level accounts====
 +
[[File:14 WBFformattingLocking.png|600px|center]]
 +
 
 +
 
 +
[[File:15 WBFformattingLocking.png|600px|center]]
 +
Please refer to the [[Level_based_formatting|Level based formatting]] page for more details.
 +
 
 +
====Locking all the years====
 +
Note that you should define a white background for these cells to overwrite the yellow one defined for the leaf accounts.
 +
[[File:16 WBFformattingLocking.png|600px|center]]
 +
 
 +
 
 +
[[File:17 WBFformattingLocking.png|600px|center]]
 +
Please refer to the [[Level_based_formatting|Level based formatting]] page for more details.
 +
 
 +
====Unlocking a specific column / month====
 +
[[File:35 WBFformattingLocking.png|600px|center]]
 +
 
 +
 
 +
[[File:34 WBFformattingLocking.png|600px|center]]
 +
 
 +
 
 +
====Locking a specific cell====
 +
[[File:18 WBFformattingLocking.png|600px|center]]
 +
 
 +
 
 +
[[File:19 WBFformattingLocking.png|600px|center]]
 +
 
 +
===Dynamic Formatting/Locking of cells using custom formatting areas===
 +
You can define additional ranges of cells to control the formatting and locking. These ranges use the same rules as the format sheet (Dimension /Member / data cell) '''but don’t have spacer cells between each cell'''.
 +
 
 +
These additional rules will be applied to the grid after the ones of the format sheet. Any change in these will be tracked by the grid independently of its refresh status. The highlighting and locking of cells can thus be dynamically driven from Excel formulae or from an external data source such as a SQL query.
 +
 
 +
You can add custom formatting areas from the Appearance tab of the grid's properties window.
 +
 
 +
[[File:20 WBFformattingLocking.png|500px|center]]
 +
 
 +
 
 +
[[File:21 WBFformattingLocking.png|400px|center]]
 +
 
 +
 
 +
[[File:22 WBFformattingLocking.png|600px|center]]
 +
 
 +
 
 +
In the below example, all the periods (*) are locked from the format sheet...
 +
[[File:23 WBFformattingLocking.png|600px|center]]
 +
 
 +
 
 +
...while the current and future ones are unlocked in the custom formatting range thanks to Excel logic. 
 +
[[File:24 WBFformattingLocking.png|600px|center]]
 +
 
 +
 
 +
[[File:25 WBFformattingLocking.png|800px|center]]
 +
 
 +
==Validating data entry==
 +
If you’re using FluenceXL and the offline data entry mode, you can add validation rules to restrict the values allowed.
 +
You can set up hard and soft validation rules from the FluenceXL\Options\Workbook Options menu item:
 +
 
 +
* A hard validation rule prevents from saving unvalid changes to the database
 +
* A soft validation rule alerts the user but lets him decide whether the changed values should be saved
 +
 
 +
Whatever its type, a validation rule is based on a boolean cell and a message. Data entry can only be saved when the value of the Boolean cell returns TRUE.
 +
===Hard Validation===
 +
In the following example, cascading Excel formulae are used to build a logic preventing the user from entering negative values for revenue accounts:
 +
 
 +
$G$5 counts the number of negative values
 +
[[File:26 WBFformattingLocking.png|400px|center]]
 +
 
 +
$H$5 returns FALSE if there is at least one negative value, TRUE otherwise
 +
[[File:27 WBFformattingLocking.png|700px|center]]
 +
 
 +
and $I$5 contains the message that is displayed if $H$5 returns FALSE.
 +
[[File:28 WBFformattingLocking.png|600px|center]]
 +
 
 +
 
 +
[[File:29 WBFformattingLocking.png|400px|center]]
 +
 
 +
 
 +
===Soft Validation===
 +
In the following example, cascading Excel formulae are used to build a logic alerting the user than forecast revenue is lower than 80% of the previous year.
 +
[[File:30 WBFformattingLocking.png|900px|center]]
 +
 
 +
 
 +
[[File:31 WBFformattingLocking.png|600px|center]]
 +
 
 +
 
 +
[[File:32 WBFformattingLocking.png|700px|center]]
 +
 
 +
 
 +
[[File:33 WBFformattingLocking.png|400px|center]]
 +
 
 +
==See Also==
 +
*[[Writeback]]
 +
*[[Formatting Grids]]
 +
*[[Format Sheet]]
 +
*[[Level based formatting]]
  
  
[[Category:OLAP Operations]]
 
 
[[Category:Writeback]]
 
[[Category:Writeback]]
 +
[[Category:Formatting]]

Latest revision as of 09:50, 4 July 2023

When writeback is enabled for a grid, it is possible to use the format sheet as well as additional Custom Format Areas to format and lock the grid cells.

Enabling writeback for a grid

In an FluenceXL grid, data entry mode is turned on by ticking the ‘Enable Writeback’ box in the Grid Properties window.

01 WBFformattingLocking.png


If you’re using FluenceXL, you also need to enable data entry mode at the workbook level from the FluenceXL\Options\Workbook Options menu item.

02 WBFformattingLocking.png

Please refer to the writeback page for further details.

Basic data entry formatting

Highlighting cells

You can highlight writeable data cells by:

1. Ticking ‘Highlight Data’ box in the Grid Properties window:

03 WBFformattingLocking.png

2. Defining a format for the ‘Writeable Member’ data cell in the FluenceXLFormats sheet:

04 WBFformattingLocking.png

Here is the result:

05 WBFformattingLocking.png


You can also provide visual feedback for the user during the data entry process by highlighting the cells that were changed and the ones that were impacted:

1. Select ‘Show Updates’ under refresh type after writeback

06 WBFformattingLocking.png

2. Define a format for the changed cells (‘Written Cell’) and the impacted ones (‘Summary written cell’)

07 WBFformattingLocking.png

Here is the result:

08 WBFformattingLocking.png

Using offline data entry mode

Using the offline data entry mode is recommended for performance reasons. When this mode is activated, the journal of pending changes can be viewed by clicking the ‘Manage…’ button in the grid's properties window.

09 WBFformattingLocking.png


All changes can then be saved or discarded at once by using the buttons in the ‘Editing’ ribbon.

10 WBFformattingLocking.png


Note that you still need to be connected to the underlying cube / model to use the offline data entry mode.

Formatting and locking cells

When writeback is enabled for a grid, any cell can be changed which means that data entry permissions are based on the security defined in the source cube/model. You can change this default behaviour and control which cells should be allowed at the grid level by ticking the ‘Cells must be unlocked’ box in the Grid Properties window.

11 WBFformattingLocking.png


As cells grid cells are by default locked in the format sheet, any writeback is then prevented in the grid.

12 WBFformattingLocking.png


13 WBFformattingLocking.png

Formatting/Locking scenarios using the format sheet

The locking of specific slices of data follows the same rules as the standard FluenceXL formatting ones defined in the ‘FluenceXLFormats’ sheet. Please read the Formatting Grids page for more details.

The following examples illustrate different cell locking scenarios.

Unlocking all the lowest level accounts

14 WBFformattingLocking.png


15 WBFformattingLocking.png

Please refer to the Level based formatting page for more details.

Locking all the years

Note that you should define a white background for these cells to overwrite the yellow one defined for the leaf accounts.

16 WBFformattingLocking.png


17 WBFformattingLocking.png

Please refer to the Level based formatting page for more details.

Unlocking a specific column / month

35 WBFformattingLocking.png


34 WBFformattingLocking.png


Locking a specific cell

18 WBFformattingLocking.png


19 WBFformattingLocking.png

Dynamic Formatting/Locking of cells using custom formatting areas

You can define additional ranges of cells to control the formatting and locking. These ranges use the same rules as the format sheet (Dimension /Member / data cell) but don’t have spacer cells between each cell.

These additional rules will be applied to the grid after the ones of the format sheet. Any change in these will be tracked by the grid independently of its refresh status. The highlighting and locking of cells can thus be dynamically driven from Excel formulae or from an external data source such as a SQL query.

You can add custom formatting areas from the Appearance tab of the grid's properties window.

20 WBFformattingLocking.png


21 WBFformattingLocking.png


22 WBFformattingLocking.png


In the below example, all the periods (*) are locked from the format sheet...

23 WBFformattingLocking.png


...while the current and future ones are unlocked in the custom formatting range thanks to Excel logic.

24 WBFformattingLocking.png


25 WBFformattingLocking.png

Validating data entry

If you’re using FluenceXL and the offline data entry mode, you can add validation rules to restrict the values allowed. You can set up hard and soft validation rules from the FluenceXL\Options\Workbook Options menu item:

  • A hard validation rule prevents from saving unvalid changes to the database
  • A soft validation rule alerts the user but lets him decide whether the changed values should be saved

Whatever its type, a validation rule is based on a boolean cell and a message. Data entry can only be saved when the value of the Boolean cell returns TRUE.

Hard Validation

In the following example, cascading Excel formulae are used to build a logic preventing the user from entering negative values for revenue accounts:

$G$5 counts the number of negative values

26 WBFformattingLocking.png

$H$5 returns FALSE if there is at least one negative value, TRUE otherwise

27 WBFformattingLocking.png

and $I$5 contains the message that is displayed if $H$5 returns FALSE.

28 WBFformattingLocking.png


29 WBFformattingLocking.png


Soft Validation

In the following example, cascading Excel formulae are used to build a logic alerting the user than forecast revenue is lower than 80% of the previous year.

30 WBFformattingLocking.png


31 WBFformattingLocking.png


32 WBFformattingLocking.png


33 WBFformattingLocking.png

See Also