Defining a Template

Procedure

To define a template:

  1. Click the Admin link in the Application toolbar.
    A list appears.
  2. From the Admin menu, select T and then click Template.
    A sub-menu appears.
  3. Click the Add option from the Template sub-menu.

    The Template screen appears. It consists of the following sections:

    • Main - Used to specify basic details about the template.

    • Characteristics - Used to define the characteristics for the template.

    The Main section contains the following fields:

    Field Name Field Description Mandatory (Yes or No)
    Template Used to indicate the template name. Not applicable
    Description Used to specify the description for the template. Yes
    Detailed Description Used to specify additional information about the template. No
    Purpose Used to indicate the purpose of the template. The valid values are:

    • Account Selection - Used to select a set of usage accounts based on the criteria.

    • Adjustment Selection - Used to select a set of adjustments based on the criteria.

    • Billable Charge Selection - Used to select a set of billable charges based on the criteria.

    • Usage Account Selection - Used to select a set of usage accounts based on the criteria.

    • Usage and Invoice Account Selection - Used to select a set of usage and invoice accounts based on the criteria.

    		 Yes
    Status Used to indicate the status of the template. The valid values are:

    • Active

    • Inactive

    		 Yes
    Select Used to specify the column name. It indicates the data that you want to retrieve using the SELECT statement.

    The default value appears in this field when you select the purpose of the template. However, the default value changes depending on the purpose of template. You can edit the column name whenever required.

    If you have set the purpose of the template to.... Then, the default value is...
    Account Selection ACCT_​ID
    Adjustment Selection ADJ_​ID
    Billable Charge Selection BILLABLE_​CHG_​ID
    		Yes
    From Used to specify the table or view name. It indicates the table or view from which you want to retrieve the data. Yes
    Where Used to specify the condition based on which you want to retrieve the data from the table or view. You can use the bind variables in the where clause using the following syntax:

    {column_​name}{operator}:{bind_​variable}

    The bind variables must be alphanumeric and prefixed with the colon (:). There should not be any space between the column name, operator, and the bind variable. For example, CURRENCY_​CD=:CURRENCY. All bind variables used in the where clause must be defined in the Bind Variables section.

    		 No

    In addition, this tab contains the Bind Variables section where you can define the bind variables which are used in the where clause. The Bind Variables section contains the following fields:

    Field Name Field Description Mandatory (Yes or No)
    Bind Variable Used to specify the bind variable (which is used in the where clause). Yes (Conditional)
    Note: This field is required when you are defining a bind variable.
    Data Type Used to indicate the type of data that you want to store in the bind variable. The valid values are:

    • Date

    • Numeric

    • String

    		 Yes (Conditional)
    Note: This field is required when you are defining a bind variable.
    Label Used to specify the business label for the bind variable. The business label appears when you define and edit the criteria for selecting a set of usage accounts, adjustments, or billable charges. Yes (Conditional)
    Note: This field is required when you are defining a bind variable.
    Zone Used to specify the zone for the template.
    Note: The Search (The Search Icon) icon appears corresponding to this field. On clicking the Search icon, the Zone/Code Description window appears.
    		 Yes (Conditional)
    Note: This field is required when you are defining a bind variable.
    Tip: Alternatively you can access the Template screen by clicking the Add button on the top-right of the Template screen.
  4. Enter the required details in the Main tab.
  5. If you want to define more than one bind variable, click the Add (The Add Icon) icon in the Bind Variables section and then enter the required details.
    Note: However, if you want to remove a bind variable from the Bind Variables section, click the Delete (The Delete Icon) icon corresponding to the bind variable.
  6. If required, click Validate to validate the syntax of the SELECT statement.
    Note: If the syntax of the SELECT statement is correct, a message appears indicating that the SQL statement was validated successfully. However, if the syntax of the SELECT statement is incorrect, an error message occurs. You need to then correct the SELECT statement accordingly. Otherwise, the system will not allow you to save the template.
  7. Define characteristics for the template, if required.
  8. Click Validate and Save.
    The system validates the syntax of the SELECT statement and then accordingly saves the template.

Related Topics

For more information on... See...
Template screen Template
Search Template zone Search Template
How to define a characteristic for a template Defining a Characteristic for a Template