Model Design Commands

Model design commands include:

Model Commands

Table 14-10 Model Commands

Command What it Does Criteria Sample Prompts See Also
Create Model

Creates a new model with the given name, optional description, and optional context.
  • Model Name (required): Name for the new model
  • Description (optional): Description for the model
  • Context (optional): Dimension and member selections to apply as model context

create model

create model Profit Model description FY25 allocation model context Product.NoProduct and Activity.NoActivity

create model Planning Model description Sandbox for allocations

 Using PCM Agent to Create a Model
Calculate Model Calculates a model and one or more points of view
  • Model: (required if no saved job): Model to calculate; defaults to the current Designer model.
  • Point of View (required): POV to calculate; can be a single POV, the current POV, or a generated range
  • Saved Job (optional): Use a saved calculation job; model and POV can be taken from that job
  • Rule Range (optional): Limit calculation to all rules, a specific rule, a start or stop rule, a ruleset sequence range, or a single rule
  • Ruleset Sequence Range (optional): Start and end sequence numbers for a subset of rulesets
  • Rule Name (optional): Name of the rule when using single‑rule or start/stop options
  • Clear Calculated Data (optional): clear existing calculated data before running; default is "true"
  • Execute Calculation (optional): Run the calculation steps; default is "true"
  • Capture Diagnostic Data (optional): Capture diagnostics if requested; default is "false"
  • Capture Debug Scripts (optional): Capture Essbase debug scripts if requested; default is "false"
  • Optimize for Reporting (optional): optimize reporting data after calculation; default is "true"
  • Comment (optional): Add additional context or notes
  • Save Job (optional): Save this calculation setup as a reusable job name

calculate model

calculate model 10 Actuals Allocation Process

calculate model 10 Actuals Allocation Process for POV FY24::Jan::Actual::Working

calculate model for POV range FY24 Jan to FY24 Mar

calculate only custom rules

calculate rule Activity Costing Assignments

calculate model and clear calculated values first

calculate model and save as job Calculate FY24 Jan

run calculation job Calculate FY24 Jan

 Using PCM Agent to Calculate a Model
Copy Model Copies an existing model into a new model with a new name.
  • Source Model (required): Existing model to copy
  • Target Model (required): Name for the copied model
  • Description (optional): Description for the copied model
  • Confirmation (required): Confirm the copy action before execution

copy model 10 Actuals Allocation Process to 10 Actuals Allocation Process Copy

duplicate model 10 Actuals Allocation Process to 10 Actuals Allocation Process Copies

copy current model to New Copy Model

create a copy of model 10 Actuals Allocation Process

duplicate model Source Model to Target Model

clone model Source Model named Target Model

  
List Models Finds and summarizes models. It can list models, count them, search by name or description, filter by creator or modifier, filter by rule or ruleset counts, sort by model metadata, limit the number of results, and include rule counts or model statistics.
  • List Models (required): Ask to list or show models
  • Name Filter (optional): Return models with names containing the provided text
  • Description Filter (optional): Return models with descriptions containing the provided text
  • User Filter (optional): Return models created or modified by a specified user
  • Count Filter (optional): Return models whose rule count or ruleset count equals, falls between, is at least, or is at most a requested number
  • Sort Order (optional): Sort by name, created time, modified time, created by, or modified by
  • Limit (optional): Maximum number of models to return
  • Statistics (optional): Include rule type counts or model statistics when requested

list models

show model stats

show models with rule count

show models containing Actuals

count models

show model summary

show models with enabled rule count

show models containing allocation process

show model metrics for '10 Actuals Allocation Process'

  
Validate Model Validates your rules before you calculate them against a data POV Model Name

validate model '10 Actuals Allocation Process'

run model validation for '10 Actuals Allocation Process'

 Using PCM Agent to Validate a Model

Rule Set Commands

Table 14-11 Rule Set Commands

Command What it Does Criteria Sample Prompts
Create Rule Set Creates a rule set
  • Ruleset Name (required): Name for the new ruleset
  • Model (optional): Model where the ruleset will be created; if omitted, the current Designer model is used
  • Description (optional): Description for the ruleset.
  • Calculation Mode (optional): Execution mode; valid values are serial, parallel, or iterative
  • Sequence (optional): Sequence number from 1 to 9999
  • Iterations (optional): Number of iterations from 1 to 99
  • Use Model Context (optional): Whether to use model context; defaults to "true"
  • Enabled (optional): Whether the rule set is enabled after creation; defaults to "true"
  • Context (optional): Dimension and member selections to apply as ruleset context.

for model Profit Model create ruleset Product Allocation description Product rules sequence 10 use model context true enable true

In model TestModel, create ruleset RS1

For model TestModel, create rule set RS2
List Rule Sets Finds and reviews rulesets for a model. It can list rulesets, count them, filter by model or name, include rule type counts, and locate rulesets that contain specific rules.
  • List Rulesets (required): Ask to list, count, or search rulesets.
  • Model (optional): Specify the model that contains the rulesets; if omitted, the current Designer model is used
  • Name Filter (optional): Return rulesets whose names contain the provided text
  • Statistics (optional): Include rule type counts or total rule counts when requested
  • Rule Filter (optional): Find rulesets that contain a specified rule

list rulesets in model Forecast Model

list rulesets in model "10 Actuals Allocation Process"

show all rule sets under 20 Forecast What-If Allocation Process

Rule Commands

Table 14-12 Rule Commands

Command What it Does Criteria Sample Prompts
Create Rule Creates an allocation or custom calculation rule in a selected model and rule set
  • Rule Name (required): Name for the new rule
  • Rule Type (required): Type of rule to create. Valid values: allocation or custom.
  • Ruleset (required): Rule set where the rule will be created
  • Model (optional): Model that contains the ruleset. If not specified, the current Designer model is used.
  • Description (optional): Description for the rule
  • Sequence (optional): Rule sequence number from 1 to 9999.
  • Use Ruleset Context (optional): Whether to use the rule set context for the rule. Defaults to "true"
  • Enabled (optional): Whether the rule is enabled after creation. Defaults to "true".
  • Placement (optional): Place the rule after or before another rule

create allocation rule Product Cost in ruleset Product Allocation description Allocate product costs sequence 5 in model Profit Model

create custom rule Driver Rate in ruleset Operating Rules description Unit driver rate use ruleset context true enable true

in model Forecast Model create allocation rule Utility Expense in ruleset Department Allocations before Rent Expense
List Rules Helps you find and review calculation rules. It can list, search, filter, count, and page rules by various criteria.
  • List Rules (required): Ask to list, count, find, or search rules
  • Model (optional): Specify the model containing the rules; defaults to the current Designer model
  • Ruleset (optional): Provide a comma‑separated list of rulesets to search
  • Name Filter (optional): Match rule names that contain, start with, or end with the given text
  • Filter Logic (optional): Use "and" or "or" when combining multiple name or member filters
  • Member Filter (optional): Find rules that include a selected member for a selected dimension
  • Missing Member Filter (optional): Find rules without member selection in a selected component
  • Rule Component (optional): Limit member checks to source, destination, driver, offset, or target
  • Destination Selection (optional): Filter destination behavior such as allocate to parent, allocate to sibling, same as source, or same as source different dimension
  • Formula Members (optional): Find rules that use selected members in formulas

list all rules in ruleset Sales Allocations within model Profit Model

list rules from Occupancy Expense Allocations

list allocation rules where source component contains member Rent Expense from dimension Account within model Planning Model
Enable Rules Allows selected rules in a model to be used in calculations
  • Model (optional): The model that contains the rules; if omitted, the current Designer model is used.
  • Rule Selection (required): Choose all rules, allocation rules, custom rules, or provide a comma‑separated list of rule names.
  • Ruleset (optional): The ruleset that contains the rules.

enable rules

enable rules in ruleset Preprocessing Currency Translation

enable rules in model 10 Actuals Allocation Process
Disable Rules Disables selected rules in a model so they are not used in calculations
  • Rule Selection (required): Choose all rules, allocation rules, custom rules, or provide a comma‑separated list of rule names.
  • Model (optional): The model that contains the rules; if omitted, the current Designer model is used.
  • Ruleset (optional): The ruleset that contains the rules.

disable rules in ruleset Preprocessing Currency Translation

disable rules in model 10 Actuals Allocation Process

disable rules
Copy Rules to Rule Set Copies selected rules from one ruleset to another within the same model
  • Rule Selection (required): Choose all rules, allocation rules, custom rules, or provide a comma‑separated list of rule names.
  • Source Model (optional): Model containing the rules to copy; if omitted, the current Designer model is used.
  • Source Ruleset (optional): Comma‑separated list of rulesets that contain the source rules.
  • Target Ruleset (required): The ruleset that will receive the copied rules.
  • Overwrite Existing Rules (optional): Replace matching rules in the target ruleset; defaults to false.
  • Comment (optional): Additional context or notes.

copy rule Driver Allocation into ruleset Test Rules overwriting existing rules

from model Source Planning copy all allocation rules into ruleset Target Rules

copy all rules from rulesets Product Allocations and Driver Rules into ruleset Reporting Rules
Copy Rules to Model Copies selected rules from one model to another
  • Rule Selection (required): Choose all rules, allocation rules, custom rules, or provide a comma‑separated list of rule names.
  • Target Model (required): Model that will receive the copied rules
  • Source Model (optional): Model that contains the rules to copy; if omitted, the current Designer model is used.
  • Ruleset (optional): Comma‑separated list of rule sets that contain the source rules
  • Overwrite Existing Rules (optional): Replace matching rules in the target model; default is "false".
  • Comment (optional): Additional context or notes.

copy rule Customer Cost Assignment into model Forecast Model overwriting existing rules

source model Source Planning copy all allocation rules into model Target Planning

copy all rules from rulesets Operating Rules and Driver Rules to model Reporting Model
Add Member Adds one or more members to selected rules or rule components in a model
  • Model (optional): Model name; if omitted, the current Designer model is used
  • Member List (required): Comma‑separated list of members to add
  • Dimension (required): Dimension that contains the members
  • Rule Component (required): Component to receive the members – source, destination, driver, offset, or target
  • Rule Scope (optional): All rules or a comma‑separated list of specific rule names
  • Ruleset (optional): Comma‑separated list of rulesets containing the target rules
  • Comment (optional): Additional context or notes for the change

for model Profit Model add members CC300 and CC400 from Entity to Source component for rules all

add members Product100 and Product200 from Product to Driver component for rule Product Allocation in model Planning Model

for model Profit Model add members CC100 and CC200 from Entity to Destination component for rules within ruleset Customer Allocations
Replace Member Replaces a member with another across selected rules or rule components
  • Rule Component (required): Component where the member will be replaced (source, destination, driver, offset, or target)
  • Dimension (required): Dimension that contains the member to replace
  • Existing Member (required): Member to find and replace
  • Replacement Member List (required): Comma‑separated list of replacement members
  • Rule Scope (optional): Apply to all rules or specify a comma‑separated list of rule names
  • Ruleset (optional): Comma‑separated list of rulesets containing the target rules
  • Model (optional: Model name (defaults to the current Designer model)
  • Comment (optional): Additional context or notes for the change

replace source member Old Account with New Account for Account in all rules within model Forecast Model

replace within the source component for dimension Account find member Old Rent with new member New Rent for all rules within model Forecast Model

replace destination member Old Product with New Product in rule Product Allocation for model Planning Model dimension Product