Launching Business Rules With a Utility

Using the CalcMgrCmdLineLauncher.cmd utility, administrators can launch—from the Command Prompt—business rules or rulesets created with Calculation Manager.

Notes:

  To launch a business rule or ruleset with CalcMgrCmdLineLauncher.cmd:

  1. When launching a business rule (not a ruleset) having runtime prompts, generate a file containing the runtime prompt values by either:

    • Specifying the name of the runtime prompt values file that you generated on the Runtime Prompts page (see the Oracle Hyperion Planning User's Online Help).

    • Creating a runtime prompt ASCII file that contains, on separate lines, each runtime prompt name and its value, separated by a double colon (::). For example:

      CopyDataFrom::Jan

      CopyDataTo::Apr

      This file specifies that the value for the runtime prompt named CopyDataFrom is Jan, and that the value for the runtime prompt named CopyDataTo is Apr.

      Save the file in the planning1 directory (for the full path to planning1, see About EPM Oracle Instance). Alternately, when executing the utility, specify the full path to the runtime prompt file.

  2. From the planning1 directory, enter this command at the Command Prompt, one space, and the parameters, each separated by a space:

    CalcMgrCmdLineLauncher.cmd [-f:passwordFile] /A:appname /U:username /D:database [/R:business rule name | /S:business ruleset name] /F:runtime prompts file [/validate]

    Table 50. CalcMgrCmdLineLauncher Parameters

    ParameterPurposeRequired?

    [-f:passwordFile]

    If an encrypted password file is set up, you can use this option as the first parameter in the command line to run the utility with the full file path and name specified in passwordFile. See Suppressing Password Prompts in Planning Utilities.

    No

    /A:appname

    Specify the Planning

    application from which the business rule is launched

    Yes

    /U:usernameSpecify the administrator's user name

    Yes

    /D:databaseSpecify the name of the plan type against which the calculation is launched

    Yes

    [/R:business rule name |/S:business ruleset name]Specify the name of the business rule or ruleset to be launched

    Yes. Specify either a business rule or a ruleset, but not both.

    /F:runtime prompts fileSpecify the name of the file containing business rule's runtime prompt names and values

    Yes, when launching a business rule having a runtime prompt. When launching a ruleset, default launch values are used. If you specify a runtime prompts file when launching a ruleset, the runtime prompts file is ignored.

    [/validate]

    Checks the command syntax only; does not launch the business rule or ruleset. Any errors are displayed on the console and written to the Calculation Manager log file. If the CalcMgrLog4j.properties file is in the Classpath, the log file is generated in the EPM_ORACLE_INSTANCE/diagnostics/logs/planning directory.

    Each rule in a ruleset is validated.

    No

    /?Print the syntax and options for CalcMgrCmdLineLauncher.cmd

    No

    For example to launch the rule named Depreciate, using runtime prompt values in a file called Values.txt, enter:

    CalcMgrCmdLineLauncher.cmd /A:planapp /U:admin /D:plan1 /R:Depreciate /F:Values.xml

  3. If prompted, enter your password.