Using SpotlightXL-Model Setup Subtask

Overview

With the Setup subtask, you can create a new model or redesign an existing model. When you select the Setup subtask, an existing model structure may be displayed. Access the Setup subtask by selecting the Model task and the Setup subtask.

Actions Available

A description of the actions available for the Setup subtask.

- This action moves a model from a Not Generated state to a Generated state, which completes the setup of the model. Once generated, you cannot edit the model structure unless you clear the model first. Generated models are available for analyzing and reporting. Models with a Not Generated state are not available for analyzing or reporting.

• Not Generated - for designing or editing a model.
• Generated - the model is ready for consumption by users (Analyze, Report).

- This action moves an Analytic or Master model from a Generated state to a Not Generated state. This action must be performed before a generated model can be modified or deleted. When a model is cleared, all data is deleted. Dimensions and other artifacts are retained. When you are in the process of designing and testing a new model, you will Clear the Model and Generate the Model frequently. However, once a model is in production, these actions will be done rarely. This action operates on a Source model, such as HACPM_Financial, differently. It deletes all data but does not move the model to a Not Generated state. HACPM_Financial remains as a Generated model.

- This action allows you to add and/or delete dimensions from a model. When you add or delete dimensions associated with a Model, the modification affects ALL dependent artifacts. For example, if you delete a Company dimension from a Model, not only is the Model modified, but your associated reports and views are modified to reflect the deletion of the Company dimension because views and reports are dependent on the Model.

- This action allows you to lock a model to prevent modification or clearing. Analytic and Master models only can be locked. Models must be in a Generated state to be locked. Not Generated models cannot be locked.

See Also: The following information on how to update a dimension hierarchy with data without clearing the model first.

- After a selection is made, click Refresh to view updated data.

- Save a newly defined model structure. Or, save an edited model that has a status of Not Generated. You cannot save a generated model.

- Delete a selected model. You cannot delete a generated model. You can delete models with the status of Not Generated, which are models in the process of being created or edited. This action deletes the model structure and dimension data. All associated formulas, calculations, maps, and reports are deleted along with the model. To delete a generated model, click Clear Model to return the model to a state of Not Generated and then click Delete.

This action is permanent and cannot be undone. Consider making a backup of the model before you delete it. Use Manage > Application Administration > Model Backup/Restore.

Spreadsheet Fields Descriptions

The spreadsheet fields on the Setup page are described below:

• Model: Select a model. To create a new model, select New Model from the Model list box. You can perform a list box search by entering the word, partial word, or the starting letter (for example, New Model, n, or new) in the search field of the list box.
  
• Description: Enter a description of the model. The model does not have to be locked to save the description.
• Type: Select Master or Analytic. The Master model represents model data pulled from the Planful Financial Cube and is the starting point for creating additional models. An Analytic model represents a sub-model that can be used for analysis or Dynamic Planning purposes.
• EnableChange Data Tracking: Enter Yes or No to enable or disable Change Data Tracking. When you enable this feature, Dynamic Planning assumes that all data in the model is clean and up-to-date. Therefore, you should always run a Full Aggregation before enabling this feature. See How to Use Change Data Tracking for more information.
• Enable Direct Access to PCR: Enter Yes or No to enable or disable Direct Access to PCR. This option is available only when you are first creating a model, otherwise it is grayed out. When you enable Direct Access, the model you create will be connected to the Planful Structured Planning, Consolidation, and Reporting (PCR) application data. For information on Direct Access to PCR, see Using Direct Access to PCR Financial Reporting.
  Note:

  HACPM is a special model that takes metadata and data from Planful Applications and then acts as a source for moving that data into a Dynamic Planning model. Enable Change Data Tracking is not available on HACPM.
• Created On: The date the view was created. This cell is populated by the system.
• Created By: The username of the user who created the view. This cell is populated by the system.
• Modified On: The date on which the view was last modified. This cell is populated by the system.
• Modified By: The username of the user who last modified the view. This cell is populated by the system.
• Status: The Status field is system-populated based on the actions you perform. A generated model cannot be deleted. Clear the generated model by clicking Clear Model and then delete the model. Only generated models are available for analyzing and reporting. Do not enter data in this field. Any data entered will be replaced with system data.
• Dimension: Enter dimensions to include in the model.
• Type:Select the cell to enable a list box where you can choose between two types of dimensions; Value and Key. You must have at least one Key and one Value dimension to generate a model. A Key dimension type will most likely change, unlike a Value dimension (for example, Time) that does not normally change. The very first cell under Type provides a list box when the cell is selected. For subsequent cells, type in a value or copy and paste the list box cell to add new types.
  Note:

  The key dimensions will be displayed in bold text and highlighted cells.

Design / Value: System-populated based data that cannot be modified. Information is based on model associations such as maps, calculations, and reports.

• Attributes: Attributes associated with the model.
  • Name: The name of the attribute as defined on the Model > Attribute page.
  • Dimension: The name of the dimension the attribute is associated with.
• Maps: The maps associated with the model where the model is set as a Target model as well as a Source model.
  • Name: The name of the map as defined on the Model Map page.
  • Source Model: The model you want to copy data and/or metadata from.
  • Target Model: The model you want to copy data and/or metadata to.
• Type: The type of data mapped. There are 2 types of data; metadata and data.
  • Metadata: Copy only metadata from the source to the target model. 
  • Data: Copy only data from the source to the target model. Both - copy both metadata and data from the source to the target model. Tip Lookups apply to Metadata.
• Transfer: Applies to dimension members.
  • Leaf: transfer leaf level dimension members only to the target model.
  • All: transfer all dimension members from the source to the target model. 
• Writeback Process: Required to write data back from Dynamic Planning to Planful Structured Planning, Consolidation, and Reporting applications. See: Writing Data From Dynamic Planning Back to Planful Structured Planning, Consolidation, and Reporting Applications.
• Access Token: Required to move data from one Dynamic Planning application to another (within the same environment). For example, you have one application used to manage all corporate finance models and another application to manage all department finance models. Every quarter corporate pulls departmental budgets and forecasts from the department application finance models to the corporate application finance models to generate a consolidated profit and loss statement and balance sheet reports.
• Variables: Displays all variables used. See: Using Variables in Views and Reports
  Formulas: Define formulas on any dimension member within a single dimension. No cross-dimensional formulas are supported at this time. You can have multiple formulas per model. Formulas are the building blocks of calculations. The calculation defines the logical order in which formulas are executed.
• Name: The name of the formula as defined on the Model > Formula page.
• Dimension: The Calculation Description field is limited to 5,000 characters and for each step within the Calculation you can enter up to 1,000 characters. If the limit is exceeded, the application will truncate the text. The Variables column width in the Calculation is currently set to auto-fit.

Scopes: Define filters for a model’s dimension members. Defining a scope for each model improves performance and scalability by allowing you to perform calculations on a block of data versus an entire model.

• Name / Description: The name and description of the scope as defined on the Model > Scope page.
• Variables: You can use both variables and variable expressions.
  Calculations: A Calculation, which identifies the order of execution for aggregations, formulas, maps, and more. Access the Calculation subtask by selecting the Model task and the Calculation subtask.
• Name: The name of the Calculation as defined on the Model > Calculation page.
• Description: A description of the Calculation as defined on the Model > Calculation page.
• Run in Background:
  • Yes - Run processes in the background (for example, an aggregation or calculation that will take a long time to execute). See the Request Status page, accessed by selecting the Manage task and the Request Status subtask, for process details.
  • No - Do not run processes in the background.
• Current Status: This field is updated when No is selected for Run in the background and provides status information on the results of the run (for example, successful).
• Last Run Time: This field is updated when No is selected for Run in the background and provides run time and date information.
• Last Run Status: This field is updated when No is selected for Run in the background and provides information on the time to complete the most recent run. See Also: the Calculation page on how to schedule a Calculation.

Views: A View represents a custom starting layout for interactive query and analysis on a model.

• Name / Description: The name and description of the view as defined on the Analyze > Design View page.
• Enable Save: Yes – Allow users (members of the group that has access) to save changes to the model. This save will write back data to the model in Dynamic Planning. Users enable this option to allow for the execution of Calculations on save (see next option). No – Do not allow other users in the group to save changes to the model. No is the default.
• Calculation on Save: Include a Calculation, which provides the order in which the calculations take place. The calculation will be executed when you click Save. The calculation name should be provided in the available property. This property is dependent upon the Enable Save property. Unless Enable Save is set to Yes, this calculation will not be executed.
• Groups: Groups with access to the views.

Reports

• Name / Description - The name and description of the report as defined on the Report Design page.
• Enable Save - Allow users (members of the group that has access) to save changes to the model report.
• Calculation Model - When Enable Save is set to Calculation Model or All Models in the Report Properties.
• Calculation on Save - Include a Calculation, which provides the order in which the calculations take place. The calculation will be executed when you click Save. The calculation name should be provided in the available property. This property is dependent upon the Enable Save property when creating a model. Enable Save must be set to Yes to execute this calculation.
• Groups - Groups with access to the views.