Parameters and Action Templates

Parameters

Parameters are governed by the Rule Template schemas located at:

CustomPolicies/schemas/RuleTemplate_base.xsd

CustomPolicies/schemas/RuleTemplate.xsd

  • Parameters extract the user-configurable portion out of the configuration. Also, it carries the information needed for the UI to complete the job of collecting a valid value for the parameter.
  • Parameter has an attribute type that can be used to indicate the type of the parameter. It can be used to trigger some special processing on the parameter when needed. The type could also be used for value validation. Parameter values are always stored as a string. It is up to the validation method to validate the value. The following is a list of all supported types:
    • INTEGER
    • STRING
    • COMPLEX
    • DOUBLE
    • BOOLEAN
    • RESOURCE_INSTANCE
    • OBJECT_GROUP
  • Parameters could have default values. Parameters could be configured as hidden. For a hidden parameter, the default value must exist and is used as the value of the parameter.
  • Parameter can be set to optional. If a parameter is not optional (the default is false), its value must be set when the instance is created.
  • Parameter can have valueChoices and if it does, the parameter value must be set with a value in the valueChoices list unless the flag "openChoice" is set on the parameter. For this type of 'choice' parameter, if it is unbounded it is multiple choice and otherwise, it is single choice. These kinds of parameters are presented on the UI as check boxes or pull-down menu. Each value choice for a parameter has an optional 'label' that can be used by the UI to be presented to the users instead of the actual parameter value if the value is too internal. If the label is not set then, the value is used.
  • A parameter value type could be COMPLEX where the parameter value must be a list of "PropertyVal". Each PropertyVal has a name, type, and optional shared resource association, similar to a regular parameter.
  • Parameters can be organized in groups. Parameters in a group could have values collected together and can be presented on the UI, for example, as a feature tab. By default, each template has a 'Default' parameter group. Normally, it is used for holding general configuration parameters. However, if a template does not need to separate parameters into multiple groups, all the parameters can be contained in the "Default" group.

    Valid object groups can be created with object of Types:

    • RestHttpServiceBindingInstance
    • RestHttpReferenceBindingInstance
    • SoapHttpServiceBindingInstance
    • WebAppComponentInstance
    • SoapServiceBindingInstance
    • SoapJmsServiceBindingInstance
    • SoapHttpReferenceBindingInstance
    • SoapReferenceBindingInstance
    • VirtualizationServiceBindingInstance
    • VirtualizationReferenceBindingInstance

Action Fragment

The action template could have a "template for transformation" stored in "configFragment". The configFragment is an XML fragment with some transformation directives in it, based on parameters. A typical transformation includes substituting substitution variables or optionally ruling out some fragments based on a parameter value.

Policy Enforcement Placement

The action template defines policy enforcement placements which actually inform the agent on where the policies are to be enforced. A policy can be applied at various stages and phases.

For more information, refer to the Concepts guide.

All the currently supported Policy Enforcement Points are listed in:

CustomPolicies/PolicyConfigurationData.xlsx

The CustomPolicies folder is located at:

TIBCO_HOME/pd/1.2/samples/CustomPolicies