Modules are powerful and flexible, with many features that enable you to solve common but complex business problems.
There are three kinds of modules:
- input modules, used to capture data entry
- driver modules, used to calculate values
- output modules, used for reporting purposes
The Modules option in Model Settings enables you to:
- insert, copy, delete and reorder the modules and functional areas in a model, and
- see an overview of all the line items in a model and make amendments to those line items.
Each module has a role to play in the processing of data in a model: data input, export, mapping, or staging. Think about these purposes when developing a naming convention that will ensure your modules are unique and easily identifiable — Good Practice: Naming Conventions provides more information.
Select a module and click:
- Open to open the module in a new tab
- Insert Module to add a new module
- Copy to copy an existing module
- Delete to remove a module
- Reorder to organize and sort your modules
- Refresh to update the data from the server
- to search for a module contained in your model
The columns in the Modules tab enable you to view and amend attributes for each module.
|Functional Area||Select a functional area for the module.|
|Applies To||Select the lists that will be the dimensions of the module.|
Set the timescale for the module:
Note that changing the dimensionality of a module may lead to data loss.
Select the time range for the module. Time ranges are set up in the Model Settings > Time > Time Ranges tab. Select an individual time range or the Model Calendar, or Not Applicable. The module will adopt the time range settings.
Note: Time ranges are not supported by the Calendar Type: Weeks General.
Select to have the model versions apply or not apply to the module.
If you change the applicability of versions to the module, this does not automatically change the applicability of versions to the line items in the module.
|Breakback||Select the default breakback setting for new line items added to the module (toggle between On or Off).|
If the module has the Users list as one of its dimensions, controls whether the full contents of the Users list is visible to workspace administrators.
Show All Users: On: The full contents of the Users list—all users with access to the model—is visible to workspace administrators. This is the default setting.
Show All Users: Off: Only the current user is visible to workspace administrators in the Users list.
|Cell Count||The number of cells contained in the module.|
|Notes||Shows any notes added to the module by workspace administrators. To add a note, double-click the Notes field and then enter some text.|
|Read Access Driver||Controls read-only access to cell data in the module. Access drivers are a component of Dynamic Cell Access.|
|Write Access Driver||Controls write access to cell data in the module. Access drivers are a component of Dynamic Cell Access.|
|Data Tags||Shows any data tags applied to the module. To apply a data tag, click the ellipsis … and then select one or more data tags.|
|Managed By||Reserved for future use.|
|Referenced By||Other modules that reference the module.|
|Used in Dashboards||Shows the dashboards that include this module|
|Line Items||The line items the module contains. (More details for line items are displayed on the Line Items tab.)|
The Functional Areas tab allows you to insert or delete functional areas.
You can select a functional area and click:
- Open to open all modules associated with that functional area
- Insert to add a new functional area
- Delete to delete the functional area
- Reorder to move and sort your functional areas
You can also assign a category to a functional area by selecting an option from the Category list.
The Line Items tab shows a list of all line items organized by module. From here you can:
- click the module name and click Open to open it.
- click Export to export the grid to .csv, .txt, or pdf format.
- add a formula, choose a parent, set the Is Summary flag and more.
Blueprint has greater detail about each option in the grid. You can use amend various attributes for individual line items and view information about each line item.
Note that some of the key settings at the module level are also shown on this tab, which you can use to ensure that the settings for these module attributes complement the settings you have made at the level of a module's line items:
- Applies To
- Time Scale
- Users List (set at module level only)
- Data Tags
You can use the tab columns to set various attributes for individual line items and to view key information relevant to each line item:
|Formula||The line item formula. To enter a formula or edit an existing formula, double-click in the cell.|
|Parent||For number formatted line items, select another line item in the module as its parent.|
Select the checkbox to make the line item the summary for other line items in the module.
|Format||Select and configure the line item formatting — number, boolean, date, text, time period, list, no data.|
Select the lists that will be the dimensions for the line item. Note that:
The dimensionality of the module is also shown and can be changed from this tab.
Set the timescale for a line item. Note that:
The timescale of the module is also shown and can be changed from this tab.
Note: we recommended you don't use this method to change the module Time Scale, because line items within the module then have to be changed individually.
Set the time range for the line item. Select an individual time range or the Model Calendar, or Not Applicable. Line items added to an existing module use the Model Calendar Time Range by default; you must assign a time range. For more, see Search.
Select to have the model versions apply or not apply to a line item. Note that:
The versions setting for the module is also shown and can be changed from this tab.
|Start of Section||
Select the checkbox for a line item to change the default dimensionality for any line items after this in the module.
Any line items with a dash under Applies To and that follows the Start of Section line item in the order of line items will pick-up their dimensionality from the Start of Section line item.
Make sure the order of line items in your module is correct when you use this setting — that you want only those line items after the Start of Section line item to inherit their dimensionality from it.
Select the checkbox if you want to carry forward balances from a previous period for a line item, an extra time period is added to the time scale for the line item.
If the line item contains a formula, you won't be able to edit the cell for this extra period.
Select a summary method for the line item. Where the dimensionality includes both a list and time, you can set one summary method for the list values and a different summary method for time.
Select which versions you want a line item's formula to apply to:
Select the checkbox if you want the switchover date defined for model versions to be applied to a line item. A line item must have versions applied for the checkbox to be enabled. The list of available time periods depends on other settings in your model; see Time Period Selection.
You can set the switchover date for versions in Model Settings > Versions.
Switchover does not apply to the Actual version.
|Breakback||Select to switch Breakback on for a line item.|
|Users List||Refer to the table for the Modules tab.|
If you want to use a line item as a heading or summary line item in your module structure, select a style to distinguish it visually in the grid from normal line items.
|Code||Assign a code for a line item. You can click in the code column and manually enter a code for a line item.|
|Read Access Driver||Controls read-only access to line item data. Access drivers are a component of Dynamic Cell Access.|
|Write Access Driver||Controls write access to line item data. Access drivers are a component of Dynamic Cell Access.|
|Data Tags||Shows any data tags applied to the line item. To apply a data tag, click the ellipsis … and then select one or more data tags.|
|Cell Count||The number of cells used for the line item.|
|Notes||Shows any notes added to the line item by workspace administrators. To add a note, double-click the Notes field and then enter some text.|
|Referenced By||Other line items or list properties that reference the line item.|