Introduction
A Form is used to show the data in a Model. Forms can be used as read-only reports, or as input forms to capture data. A Form in Kepion is composed of four sections: Rows, Columns, Filters, and Data. The rows, columns, and Filters are driven directly by the Dimensions, while the data exists in their intersections.
Forms Hub
1. Go to the Modeler.
2. Expand All Models and your target Model, then select Forms.
You should land on the Forms hub:
Along with a list of all the Forms within the Model, you have the following options:
Add : Add a new Form.
Remove: Delete the selected Form(s).
Import: Import a Form.
Export: Export the selected Form(s).
Add a New Form
1. Click Add to create a new Form.
2. Enter a name for the Form and click Save. The new Form will open automatically.
Tip: You can save time by copying the pages from existing Forms to your new Form. Select a configured Form from the Copy From drop-down.
If you leave the Form, you can return to it from the navigation pane or double-click it in the Forms hub.
Import
1. Select Import.
2. Locate your Form (.json file).
3. Either double-click it, or select it and click Open.
Export
1. Select the target Form and click Export.
2. Enter a file name and click Save. All Forms are saved as .json files.
Configure Forms
New Forms start as blank canvases. To begin making changes, select Edit .
Main
In the Main tab, users will be able to view the Form.
Once you are in the Editor mode, you will have the following options on all the tabs:
| Action | Function |
|---|---|
| Revert |
Delete all changes since the editing session started. |
| Save |
Save changes. |
| Export |
Export the Form as an Excel Workbook (.xlsx). |
| Refresh | Refreshes the page. |
| Post | Posts the data to the database. |
General
In the General tab, there are several options for styling Forms:
Paste: Paste values into cells.
Cut: Remove and get ready to paste value into cells.
Copy: Copy values to cells.
Text Styling Options: Includes text size, color, alignment, and text type.
Undo: Undo most recent action.
Redo: Redo most recent action.
Clear: Clear the selected cell(s) formatting.
Sort: Sorts selected values alphabetically or numerically.
Filter: Filter row or columns by selected values when the Filter icon is selected for that row or column.
- The dropdown includes Managed Data Filter, which allows you to filter data by columns. For more information, refer to Configure Data Filter.
Find All: Find all items that are equal to the value you are looking for.
Settings: Displays the Advanced Settings menu which controls the rendering and behavior of the Form.
: Displays additional options.
The additional setting drop-down has the following options:
| Action | Function |
|---|---|
| Hide Empty Rows | Hides all rows without data. |
| Hide Empty Columns | Hides all columns without data. |
| Allow All Input | Overrides default input settings to allow input on all Dimension Members. |
| Managed Formula | (Advanced option) Translates formulas from spreadsheet coordinate space into MDX tuples. |
| Advanced Settings |
Displays the Advanced Settings menu which controls the rendering and behavior of the Form. |
Layout
The Layout tab enables users to configure the Form's rows, columns, and filters.
| Action | Function |
|---|---|
| Structure Mode |
Two display or structure modes exist: Form (Kepion default) and Spreadsheet (Excel-like format). |
| Row | Add this item to rows. |
| Column | Add this item to the columns. |
| Filter | Add this item to the filters. |
| Hide | Hides members on the Form, while still using them to define the Form’s structure. |
| Reverse |
Moves the parent members from the top of their child members to the bottom. This is particularly useful for financial Forms with aggregations shown at the bottom. |
| Filter Variable |
Enable Filter Variable when a hierarchy is used on a row or column axis, and provides a method of injecting members into the axis based on filter selection. |
Row and Column
After mapping the hierarchies to the axes, you can then select the Row and Column tabs to define the specific members to include on the Form.
Note: In order for the Form to appear in the Main/General tabs, you must select at least one item for the Row and at least one item for the Column. You cannot select the same items for the Row and Column.
In the Row and Column tabs, the following options are available:
Single: Brings in only the selected Member.
All: Brings in all Members of the Hierarchy below the selected Member.
Children: Brings in all the Members on the next level of the Hierarchy.
Leaves: Brings in all the Members on the lowest level of the Hierarchy.
To organize the members along the axis, check each member’s checkbox and use the following actions:
| Action | Function |
|---|---|
| Range |
Add a range of Members for the selected item. Range is useful for defining a time span by specifying a start and end period. |
| Variable |
Add a variable for the selected item. For more information, refer to Configure Application Variables. |
| Set | Add a set to the selected item. The set can contain one or more Members in the order of selection. For more information, check out Configure a Defined Set. |
| Headers | Add custom headers for display. |
| Axis | Add Members from an existing Form's axis definition. This is useful when you want to apply a definition from an existing Form to your new Form. |
| Action | Function |
|---|---|
| Copy |
Copy the checked items and add them to the bottom of the axis definition. |
| Remove |
Remove the checked items from the axis definition. |
| Move Up | Move the checked items up. |
| Move Down | Move the checked items down. |
| Cross Join | When selecting member across multiple dimensions on the axis, it is important to observe the members that sit along the same row as this will determine how the axis will render when cross join is turned on. |
Filter
After mapping the hierarchies to the axes, you can go to the Filter tab to configure the default Filter behavior.
You can specify which Dimension Member is selected by default in the Default Member drop-down. We have covered all the features of the Filter tab in Advanced Form Filter Settings.
Properties
The Properties tab allows you to configure the display properties of the Form's components. The tab has separate Add, Remove, and Move options for row, columns, and Filters, so make sure you are working in the appropriate sub-tab.
Tip: To learn how to configure properties, refer to Row and Column Display Properties and Filter Display Properties
Advanced
The Advanced tab is used to configure drop-down menus, relationships, and native MDX.
Drop-Down
Allows you to create drop-down menu with members or calendar values. For more information, check out Add Drop-Down to Form.
Relationship
Configure Form relationships using the Measure from a Linked Model. For more information, refer to Configure Valid Relationships.
Native MDX
The Native MDX sub-tab shows the MDX code driving the Form. You can use additional MDX to define your Form once you have the layout and display properties specified. Ensure the layout and display properties match any custom MDX used to define an axis.
To define your own custom MDX, select the checkbox next to the target section (i.e., With, Column, or Row) and enter your code.
Tip: For more information on how to use the advanced MDX section, read the Customize Form Axis using Native MDX article, as well as MDX Training - Basics I.