SPKEY
= mandatory in combination with another parameter
Parameter | Mandatory/Optional | Value (example) | Occurrence in row 1 | Comment | |
---|---|---|---|---|---|
FORMS | REPORT | ||||
SPKEY | N/A | EVEN | x number of times | Column in which the spread key should be entered. Can occur several times in row 1. Mandatory in combination with SPVAL and need to be linked to a SPGROUP. |
Important: In v1 templates, SPKEY has been replaced by spreadkey_id and SPVAL has been replaced by spreadvalue from the Data View selected in the template.
SPKEY is a FORM specific parameter, which is mandatory in combination with SPGROUP and SPVAL (SPLIM is optional). In the SPKEY column(s), the end-user should enter a spread key which defines how the spread value (SPVAL) should be allocated in the CVAL columns. In the SPKEY column, the end-user can enter a predefined (case-sensitive) spreadkey in the cell or click on the icon to view existing spreadkeys and select one from the list.
There can be several SPKEY parameters in row 1, however, each SPKEY needs to be connected to different spread groups (SPGROUP). The spread group defines in which columns the spread value (SPVAL) should be allocated and the spread key (SPKEY) defines how the spread value should be allocated in these columns.
Mandatory parameters for SPKEY:
Below is an example of the SPKEY parameter in a v0 template:
In the SPKEY column, an icon will automatically appear in all DATA rows. The end-user can click on the icon to view and select from existing spreadkeys.
The first section (the gray chart) shows the current spreadkey for the selected data row. The sections below show the predefined spread key that can be selected:
Below is an example of the spreadkey_id from Data View in a v1 template:
Preview Available Spreadkeys
When a user clicks the Spreadkeys tab in a Form, the right panel open with a default message.
Select the appropriate spreadkey cell to view the distribution of spread weights in the Form. If you select a cell other than the cells in the spreadkey column, the spreadkeys tab on the right panel displays a default message, as shown below:
To view the Spread Weight Visualization option for a spreadkey:
Double-click the spreadkey cell, to view the Spread Weights Visualization option.
Click the Spread Weights Visualization option.
The spreadkeys tab opens on the right panel, as shown below:
Select the pop-up icon in the upper-right corner to open the spreadkey visuals in a new window.
All spreadkeys available in the drop-down appear as bar charts on the right panel under Available Spreadkeys tab in the same sequence as shown in the drop-down in the Form.
For a selected spreadkey, the respective bar chart appears first in sequence on the right panel.
Alternatively, you can select the bar graph radio button directly to change the spreadkey for a specific data row. The values of the corresponding spreadkey and period cells for the selected data row are updated accordingly in real time in the Form.
A search bar, shown below, was also introduced on the right panel to locate the desired spreadkey distribution. Enter the relevant spreadkey ID or description to display the distribution of that particular spreadkey.