runBusinessRule
Launches a business rule.
Applies to
Planning, Planning Modules, FreeForm, Financial Consolidation and Close, Tax Reporting, Enterprise Profitability and Cost Management, Sales Planning, and Strategic Workforce Planning.Required Roles
- Service Administrator
- Power User (if Launch access to rule is granted)
Usage
epmautomate runBusinessRule RULE_NAME [PARAMETER=VALUE]
where:
RULE_NAME
is the name of a business rule exactly as it is defined in the environment.PARAMETER=VALUE
indicates optional runtime parameters and their values required to execute the business rule.Note:
- This command can execute a single business rule only. To execute a ruleset, use the runRuleSet command.
- The rule is executed against the plan type to which it was deployed.
- Default values are used if you do not provide values for runtime parameters. The command ignores runtime prompts that are not exact matches to those defined in the rule.
- Use
PARAMETER=VALUE
pairing to specify as many runtime prompts as the business rule requires. The following example uses two runtime prompts (Period
andEntity
) and their values (Q1
andUSA
).See Specifying Multiple Values for a Parameter for information on entering multiple values for a parameter.
Example
epmautomate runBusinessRule RollupUSSales Period=Q1 Entity=USA