Designing a Custom Defined Template (Financial Management, Planning, and Essbase Block Storage Application Users Only)

You create a custom defined template from the System View. A custom defined template can include scripts, formulas, business rules, and other custom defined templates.

  To create a custom defined template:

  1. In the System View, do one of these tasks:

    • Select File, New, Custom Defined Template.

    • Expand the Financial Management, Planning, or Essbase application type, the application, and the calculation type (for Financial Management), the plan type (for Planning), or the database (for Essbase). Right-click Templates, and select New.

  2. Enter a name, application type, and application to which the custom defined template belongs. Then do one of the following:

    • Financial Management users only: If you are creating a Financial Management template, enter the calculation type.

    • Planning users only: If you are creating a Planning template, enter the plan type.

    • Essbase users only: If you are creating an Essbase template, enter the database.

  3. Click OK.

    The new template is displayed in the Template Designer.

  4. To design the template, from the Template Palette, drag new and existing objects and drop them into the template's flow chart within the Template Designer.

    Note:

    You can also create new objects like formulas and scripts independently of the template, and add them to the template later.

    From New Objects, drag and drop these components to insert a new component into the template's flow chart:

    From Existing Objects, drag existing rules, formulas, scripts, and templates from Financial Management, Planning, or Essbase applications and drop them into the template's flow chart.

    If you drag and drop a formula or script component into the flow chart, by default it becomes a shared object, if it was not already shared. If you do not want the object to be shared, clear the Shared check box on the formula or script component's Properties tab. See Sharing Script and Formula Components (Financial Management, Planning, and Essbase Block Storage Application Users Only).

    Note:

    You cannot use system templates in a custom defined template. If you want to use the properties of a system template in a custom defined template, save the system template as a custom defined template using Save As. See Saving a System Template as a Custom Defined Template (Planning and Essbase Block Storage Application Users Only).

    Tip:

    As you add components to a template, you may want to increase or decrease the size of the component icons and the amount of detail that is displayed in the flow chart. You can use the zoom bar to zoom in and out within the flow chart. You can select a component to view its properties, and edit a component, on the Properties tab.

  5. If you insert a component into the template, and you want to disable the component, select the component in the template flow chart, and select Disabled on the component's Properties tab. (For a Member Range component, the Disabled check box is on the Member Range tab.)

    After you disable a component, and save the template, the component icon becomes gray in the template flow chart.

    You may want to disable a component to exclude it from validation when you want to analyze which components are causing validation errors in the template.

    Note:

    You cannot disable a Condition component.

    If you disable a component that is shared, it is disabled only for the template in which you disable it.

  6. Optional: To enter a design time prompt that prompts users to enter information when they are using the template, use the table below the Template Designer flow chart. See Creating Design Time Prompts for a Custom Defined Template (Financial Management, Planning, and Essbase Block Storage Application Users Only).

    Planning users only: When you open a custom-defined template, by default it contains two system design time prompts:

    • Application: an application design time prompt determines whether the application is a multi-currency application.

    • Upper POV: a member range design time prompt retrieves a list of the members from the upper member ranges used in the business rule.

    Essbase users only: When you open a custom-defined template, by default it contains a password design time prompt. Some Essbase functions require a parameter of the type password.

  7. On Properties, enter properties for the template. As you move amongst components in the template's flow chart, the number and contents of the tabs change. To enter properties and other information for the template's components, select the component in the flow chart. See Using Components to Design Business Rules and Templates (Financial Management, Planning, and Essbase Block Storage Application Users Only).

    • Optional: Edit the template name by entering a new one of up to 50 characters. (The name defaults from the New Template dialog.)

    • Optional: Enter a description of up to 255 characters for the template.

    • Optional: Enter a caption for the template. The caption is displayed beneath the template in flow charts.

    • Optional: Enter comments for the template. For example, you may want to describe what the template is used for.

    • Financial Management users only:

      • Select Enable Logging so if any rules used in the template have log text, the log text is included in the log file when the template is launched. You can enable logging for rules, rulesets, and components. However, you specify what log text to include, if any, with a business rule's formula statements.

        Note:

        If logging is not enabled for a template, but is enabled for a rule and component that belong to the template, no log file is created because the log setting for the template overrides the settings for the rule and component.

      • Select Enable Timer so the time taken to process the template is recorded in the log file. You can enable the timer for rules, rulesets, and components. The process time is included in the log file for every object whose timer is enabled. For example, if you have a template whose timer is enabled and the template contains three rules whose timers are enabled, the time taken to process the template, and each rule in the template, is recorded.

  8. On Usages, you can view the following information about the template:

    • The names of the business rules and templates that are using the template

    • The calculation type, plan type, or database of the business rules and templates that are using the template

    • The application name of the business rules and templates that are using the template

    • Whether the business rules and templates that are using the template are deployed

    • Whether the business rules and templates that are using the template are validated

    • A description of the business rules and templates that are using the template

  9. On Script, you can view the template in its non-graphical format.

    Note:

    You cannot make changes on this tab. To make changes to the template script, save the business rule, then select Edit, Script to convert the business rule, its templates, and its components into a script.

  10. Select File, Save.