Defining a Parameter
Prerequisites
To define a parameter, you should have:
-
Validation algorithm defined using the C1_PPARM_VAL algorithm type (in case you want to validate an adhoc parameter value)
-
An algorithm defined using the C1-PPARM-ENT algorithm type (in case you want to use the algorithm while validating the pricing eligibility criteria)
-
The Fetch Type Source (C1-FetchSourceTypeVal) business service defined in the application.
A sample algorithm type named C1_PPARM_VAL is shipped with the product. At present, it allows you to specify any special characters except ampersand (&), comma (,), underscore (_), equal to (=), tilde (~), and semi-colon(;) in the parameter value.
A sample algorithm type named C1-PPARM-ENT is shipped with the product. At present, it returns a boolean value true. You can build custom logic in this algorithm which returns a value. This value can then be compared against the parameter value specified in the pricing eligibility criteria.
Procedure
To define a parameter:
-
Click the Admin link in the Application toolbar.
A list appears.
-
From the Admin menu, select P and then click Parameter.
The Parameter screen appears.
-
Click the Add button available in
the Page Title area of the Parameter screen.
The Parameter screen appears. It contains the following fields:
Field Name Field Description Mandatory (Yes or No) Parameter Used to specify the parameter. Note: You cannot specify any special character except underscore (_) in the parameter name.Yes Source Entity Used to indicate the entity from where the parameter value is derived. The valid values are: -
Account
-
Algorithm
-
Benefit
-
Customer Class
-
Delinquency Event Type
-
Division
-
Health Plan
Note: This option is not applicable for the banking business. -
Health Product
Note: This option is not applicable for the banking business. -
Membership
Note: This option is not applicable for the banking business. -
Membership Person
Note: This option is not applicable for the banking business. -
Person
-
Policy
-
Policy Plan
Note: This option is not applicable for the banking business. -
Product
Note: This option is not applicable for the health insurance business. -
Service Quantity Identifier
-
State
-
Transaction
Yes Description Used to specify the description for the parameter. Yes Source Type Used to indicate the type of source from where the parameter value is derived. The valid values are: -
Characteristic
-
Field
-
Usage Amount
-
Usage Counter
Note:This field appears when the Account, Person, Benefit, Health Plan, Health Product, Membership, Membership Person, Person, Policy, Policy Plan, Product, or State option is selected from the Source Entity list.
The Usage Amount and Usage Counter options do not appear in the Source Type list when the Benefit, Health Plan, Health Product, Membership, Membership Person, Policy, Policy Plan, Product, or State option is selected from the Source Entity list.
This is a read-only field. By default, the Field option is selected when the Customer Class, Delinquency Event Type, and Division option is selected from the list.
Yes Value Type Used to indicate the type of value that you want to store in the parameter. The valid values are: -
Adhoc
-
Predefined
-
Reference
Yes Source Type Code Used to indicate the source, such as field, characteristic, usage amount, usage counter, SQI, or algorithm, from where the parameter value is derived. Note:This field does not appear when the Transaction option is selected from the Source Entity list.
The following table indicates the values that are listed in the Source Type Code field depending on the source entity and source type combination:
Yes Note:Source Entity Source Type Source Type Code Account Characteristic Lists all characteristics where the characteristic entity is set to Account. Account Field Lists all fields of the CI_ACCT table. Account Usage Amount Lists all values defined for the BAL_FLG lookup field. Account Usage Counter Lists all values defined for the CNT_FLG lookup field. Algorithm - Lists all algorithms which are defined using the C1-PPARM-ENT algorithm type. Benefit Characteristic Lists all characteristics where the characteristic entity is set to Benefit. Benefit Field Lists all fields of the C1_BENEFITS table. Customer
Class
Field By default, the Customer Class option is selected. Note: This is a read-only field.Note:Source Entity Source Type Source Type Code Delinquency
Event
Type
Field Lists the source code types from the CI_MD_TBL_FLD table where the source entity is set to Delinquency Event Type. Division Field By default, the Division option is selected. Note: This is a read-only field.Health Plan Characteristic Lists all characteristics where the characteristic entity is set to Health Plan. Note: This option is not applicable for the banking business.Health Plan Field Lists all the fields of the C1_HEALTH_PLAN table. Note: This option is not applicable for the banking business.Health Product Characteristic Lists all characteristics where the characteristic entity is set to Health Product. Note: This option is not applicable for the banking business.Health Product Field Lists all the fields of the C1_PRODUCT_
HC_DTLS table.
Note: This option is not applicable for the banking business.Note:Source Entity Source Type Source Type Code Membership Characteristic Lists all characteristics where the characteristic entity is set to Membership. Note: This option is not applicable for the banking business.Membership Field Lists all fields of the CI_MEMBERSHIP table. Note: This option is not applicable for the banking business.Membership Person Characteristic Lists all characteristics where the characteristic entity is set to Membership Person. Note: This option is not applicable for the banking business.Membership Person Field Lists all fields of the CI_MEMBERSHIP_PER table. Note: This option is not applicable for the banking business.Person Characteristic Lists all characteristics where the characteristic entity is set to Person. Person Field Lists all fields of the CI_PER table. Person Usage Amount Lists all values defined for the BAL_FLG lookup field. Person Usage Counter Lists all values defined for the CNT_FLG lookup field. Note:Source Entity Source Type Source Type Code Policy Characteristic Lists all characteristics where the characteristic entity is set to Policy. Note: This option is not applicable for the banking business.Policy Field Lists all fields of the CI_POLICY table. Note: This option is not applicable for the banking business.Policy Plan Characteristic Lists all characteristics where the characteristic entity is set to Plan. Note: This option is not applicable for the banking business.Policy Plan Field Lists all fields of the CI_POLICY_PLAN table. Note: This option is not applicable for the banking business.Product Characteristic Lists all characteristics where the characteristic entity is set to Product. Note: This option is not applicable for the health insurance business.Product Field Lists all fields of the C1_PRODUCT table. Note: This option is not applicable for the health insurance business.Note:Source Entity Source Type Source Type Code Service
Quantity
Identifier
- Lists all service quantity identifiers available in the CI_SQI table. State Characteristic Lists all characteristics where the characteristic entity is set to State. State Field Lists all fields of the CI_STATE table. Validation Algorithm Used to indicate the algorithm using which you want to validate the adhoc parameter value. Note:This field appears when the Adhoc option is selected from the Value Type list.
The Search () icon appears corresponding to the Validation Algorithm field. On clicking the Search icon, the Algorithm Search window appears where you can search for the required algorithm.
On specifying the algorithm, the description of the algorithm appears corresponding to the Validation Algorithm field.
No Reference Entity Used to indicate the table whose primary key (column) you want to set as the reference entity. Note:This field appears only when the Reference option is selected from the Value Type list.
The Search () icon appears corresponding to the Reference Entity field. On clicking the Search icon, the Reference Table Search window appears where you can search for the required table.
On specifying the entity, the description of the entity appears corresponding to the Reference Entity field.
You can only specify a language table, where the DESCR column is available, in the Reference Entity field.
Yes In addition, this screen contains the following two sections:
-
Parameter Values - Used to define the predefined values for the parameter. It contains the following fields in a grid:
Field Name Field Description Mandatory (Yes or No) Parameter Values Used to specify the value for the parameter. Note: You can specify any special characters except ampersand (&), comma (,), underscore (_), equal to (=), tilde (~), and semi-colon(;) in the predefined parameter value.Yes (Conditional) Note: This field is required while defining the predefined parameter values.Description Used to specify the description for the parameter value. Yes (Conditional) Note: This field is required while defining the predefined parameter values.Note:The Parameter Values section appears only when the Predefined option is selected from the Value Type list. At least one parameter value should be defined for a parameter where the value type is set to Predefined.
If you want to define more than one predefined value for the parameter, click the Add () icon and then specify the details.
However, if you want to remove a predefined value of the parameter, click the Delete () icon corresponding to the parameter value.
-
Parameter Usage - Used to indicate where you want to use the parameter in the system. It contains the following options:
Option Name Option Description Mandatory (Yes or No) Price Item Used to indicate whether the parameter is associated with a price item or price item bundle. If the parameter is associated with a price item or price item bundle, you can use the parameter while defining the price item pricing. Note: This option does not appear when the Algorithm, Health Product, or the Service Quantity Identifier option is selected from the Source Entity list.Yes (Conditional) Note: This option is required while associating the parameter with a price item.Pricing Eligibility Criteria Used to indicate whether the parameter is used for defining the pricing eligibility criteria. Note: This option does not appear when the Transaction option is selected from the Source Entity list.Yes (Conditional) Note: This option is required while defining a pricing eligibility criteria using the parameter.Pricing Rule Eligibility Criteria Used to indicate whether the parameter is used for defining a rule based pricing eligibility criteria. Note: This option appears only when the Membership or the Membership Person option is selected from the Source Entity list.Yes (Conditional) Note: This option is required while using the parameter for defining a rule based pricing eligibility criteria.Business Rule Eligibility Criteria Used to indicate whether the parameter is used for defining a business rule criteria. Note: This option appears only when the Account, Customer Class, Delinquency Event Type, Division, Health Plan, Health Product, Membership, Membership Person, Policy, Policy Plan option is selected from the Source Entity list.Yes (Conditional) Note: This option is required while using the parameter for defining a rule based business eligibility criteria.Price List Eligibility Criteria Used to indicate whether the parameter is used for defining the price list eligibility criteria. Note:This option does not appear when the Health Product or the Transaction option is selected from the Source Entity list.
Yes (Conditional) Note: This option is required while defining a price list eligibility criteria using the parameter.Product Eligibility Criteria Used to indicate whether the parameter is used for defining the product eligibility criteria. Note:This option does not appear when the Algorithm, Health Product, Service Quantity Identifier, or the Transaction option is selected from the Source Entity list.
Yes (Conditional) Note: This option is required while defining a product eligibility criteria using the parameter.Rule Eligibility Criteria Used to indicate whether the parameter is used while defining the parameter based rule type. Note:This option does not appear when the Health Product, Product, Service Quantity Identifier, or the Transaction option is selected from the Source Entity list.
Yes (Conditional) Note: This option is required while defining a parameter based rule type.Note: You must select at least one option in the Parameter Usage section.
-
- Enter the required details in the Parameter screen.
-
Click Save.
The parameter is defined.Note: If a parameter is already defined using the source entity, source type, and source type code combination, the system will not allow you to define another parameter with the same combination.
Related Topics
For more information on... | See... |
---|---|
Parameter screen | Parameter (Used for Searching) |