Administering the Framework

This chapter discusses how to:

Set logging options for the data library.
Set installation options.
Register trigger types and trigger points.
Define subject areas.
Register operators and operator sets.
Register resolution methods.
Register business domains and categories.
Register action objectives.

Using the Setup Components

This section lists the components used for administering the PeopleSoft Active Analytics Framework.

Pages Used in This Chapter

Page Name	Object Name	Navigation	Usage
Data Library Logging	EOCF_DL_LOG_SET	Enterprise Components, Active Analytics Framework, Setup, Data Library Logging	Used to set Data Library logging options.
Install Options	EOCF_INSTALL	Enterprise Components, Active Analytics Framework, Setup, Install Options	Used to set Active Analytics Framework installation options.
Register Trigger Type	EOCF_EVTYP_DEFN	Enterprise Components, Active Analytics Framework, Setup, Register Trigger Type	Used to define trigger types.
Register Trigger Point	EOCF_EVENT_DEFN	Enterprise Components, Active Analytics Framework, Setup, Register Trigger Point	Used to define trigger points.
Define Subject Area	EOCF_SUBJ_HIER	Enterprise Components, Active Analytics Framework, Setup, Define Subject Area	Used to define subject areas.
Register Operators	EOCF_OPERATOR_DEFN	Enterprise Components, Active Analytics Framework, Setup, Register Operators	Used to define operators.
Register Operator Sets	EOCF_OPERSET_DEFN	Enterprise Components, Active Analytics Framework, Setup, Register Operator Sets	Used to define operator sets.
Register Resolution Method	EOCF_DEF_RESLMTHD	Enterprise Components, Active Analytics Framework, Setup, Register Resolution Method	Used to define the resolution method.
Register Business Domain	EOCF_BUS_DOMAIN	Enterprise Components, Active Analytics Framework, Setup, Register Business Domain	Used to define a business domain, which is used to functionally classify trigger points.
Register Category	EOCF_IACATEGORY	Enterprise Components, Active Analytics Framework, Setup, Register Category	Used to functionally classify policies.
Register Action Objective	EOCF_ACTION_OBJ	Enterprise Components, Active Analytics Framework, Action Framework, Register Action Objective	Used to functionally categorize actions defined in policies.

Setting Log and Installation Options

This section describes the logging and installation options

Setting Data Library Log Options

Access the Data Library Log Settings page.

Log File Name

Enter a name for the log file and select Append to an Existing File, if desired.

Term Resolution

Log technical details of resolution of individual terms.

Context Generation

Log technical details of the generation of contexts.

Bind Substitution

Log technical details of implementation binds substituted with values from the runtime context.

Cache Management

Log technical details of usage of cache.

Object Factory Processing

Log technical details of the loading of framework object definitions.

Installation Options

Access the Install Option page.

Data Source

The product line for this database, for example CRM or HMS.

Default SetID

The setID value to use for a component that does not use set control

% of Trigger Points to Log

When logging for performance monitoring, the impact of logging can be alleviated by only logging a percent of trigger points executed. Specify a percent value between 1 and 100.

Disable Runtime

This option disables all trigger points from running.

Log to Database

Determines if the log will be written to the database, or to a text file.

Log File Name Prefix

If a file is logged instead of the database, this prefix is prepended to each user's log file.

Note. The decision engine log file is created in the default files directory for this application server instance. Typically, the application server uses the directory %PS_HOME%\appserv\<servername>\files. The application server creates this directory as needed; therefore, if no log files have been written, it may not yet exist.

Log Everything

If checked, causes all normal logging options are activated.

Data Library Logging

Includes the data library log entries in the decision engine log.

Log Driver Keys

Log the primary key values driving each trigger point's context (transaction).

Log Messages

Log messages that policies or actions may generate.

Context Bind Values

Log values retrieved directly from the operant context.

Elapsed Trigger Point Time

Log the time required to complete a trigger point.

Elapsed Term Evaluation Time

Log the time required to evaluate a term.

Term Values

Log the values of evaluated data library terms.

Trigger Point Action Count

Log the number of actions created by the execution of a trigger point.

Trigger Point Policy Count

Log the number of policies evaluated for a trigger point.

Trigger Point created Actions

Log the actions created during the evaluation of policy conditions for a trigger point.

Elapsed Policy Time

Log the time required to evaluate the condition portion of a policy.

Policy Fired

Log whether a policy condition was true or false.

Action Counts per Policy

Log the number of actions created by a policy.

Terminal Actions Generated

Log terminal actions created by a policy.

Elapsed Action Time

Log the time it takes an action to complete.

Actions Combined Together

Log actions that were combined during execution.

Ignored Terminal Actions

Log any terminal actions that could not be invoked.

Debug Trace

Log debugging information, not normally used.

Registering Action Objective

Access the Register Action Objective page.

Enter the Action Objective Name and a description.

Registering Trigger Types and Trigger Points

This section describes the components used to register trigger types and trigger points.

Registering Trigger Types

Access the Register Trigger Type page.

Enter details about the trigger type you are defining and select the valid actions.

Registering Trigger Points

Access the Register Trigger Point page.

Trigger Point Name

Unique and descriptive name of the trigger point.

Trigger Type

Used by IT developers to figure out which PeopleSoft event in the component needs to be enabled with this trigger point. Also restricts the list of valid action types that may be used when creating policies for this trigger point.

Code Name

Used to reference the trigger point when programmatically enabling this trigger point for a PeopleSoft component. Changes made to the code name, after enabling this trigger point for a PeopleSoft component, may disrupt the execution of policies for this trigger point at runtime.

Context Name

Defines the context for the trigger point.

Defining Subject Areas

Access the Define Subject Area page.

Subject Area Detail

Enter a Subject Name and Description and click Apply Subject Name. The subject area name may not be unique.

Click Show Associated Terms to display the list of terms associated to this subject area node. Order the terms appearing for a subject area node by specifying display order numbers. The order depicts how the terms are displayed for a subject area node in the term list presented in the condition builder.

Subject Area Tree

The subject area tree displayed on the left-hand side has the following icons:

Expand All. Expands all subject area nodes.

Collapse All. Collapses all subject area nodes.

Add Sibling. Adds a new sibling node under the subject area node currently selected. Enter a subject area name and description on the right hand pane and click Apply Subject Name to apply changes.

Add Child. Adds a new child node for the subject area node currently selected. Enter a subject area name and description on the right-hand side and click Apply Subject Name to apply changes.

Delete Node. Deletes the selected node.

Cut. Cuts the currently selected node.

Paste as Sibling. Pastes the node previously cut as a sibling of the currently selected node.

Paste as Child. Pastes the node previously cut as a child of the currently selected node.

Registering Operators and Operator Sets

This section describes the components used to register operators and operator sets.

Operators within PeopleSoft Active Analytics Framework are defined in text expressions that are used to evaluate a condition at runtime. The operand values in the text expressions must be substituted with an operator definition for integration with policies. The substitution of operand values is ensured by the correct placement of meta-text corresponding to the desired operand or source term.

To refer to the left-hand-side of a condition, use %0 as the value. To refer to right-hand side operands 1–4 , use the text values %1, %2, %3 , and %4, respectively. For example, the following operator expression determines if the numeric term's value is less than a right-hand side value:

%0 < %1

Note. If you edit operators, policies that reference them must be recompiled. Do this by editing and saving the policy.

Registering Operators

Access the Register Operators page.

Register custom operators by defining the left-hand side and right-hand side operand specifications and entering expression text.

Operator Name	Enter the name of the operator you are defining. Operator names may not be unique as long as the expression texts are different.
Number of RHS Parameters	Specify the number of right-hand side parameters that are required to evaluate the boolean value for this operator. The condition builder uses this to display one or more right-hand side fields to enter values. Note. In this release, the condition builder interface supports a maximum of 2 right-hand side parameters for an operator.
Left operand data types	Specify the supported data types for the left-hand side operand of this operator. This data is used to constrain the list of operators in the condition builder.
Right operand specifications	Specify the type for each of the right-hand side parameters. Match LHS Type. Supports the left-hand operand data types. Fixed Type. Specify a fixed data type for this parameter. Multi-Select. Enables selection of multiple values for this parameter at condition building time.
Expression	Specify the technical expression defining how the operator works.

Registering Operator Sets

Access the Register Operator Set page.

Operator sets define the list of valid operators for a term selected on the left-hand side of a condition.

Enter a unique Operator Set Name and description, and add valid operators for this set.

Registering Resolution Methods

This section describes how to register a resolution method.

Resolution methods are used to build implementations. PeopleSoft supports the following resolution methods:

Application class.
PS Query.
SQL Object.
Record.Field.

Access the Register Resolution Method page.

Resolution Method Name

Unique name of the resolution method.

Driver Class

The application class that encapsulates the data retrieval mechanism for this resolution method.

Parameters...

Lists the parameters that an implementation using this method needs to supply.

Datatypes...

Lists the valid data types that can be returned by an implementation using this resolution method.

Registering Business Domain and Category

This section describes how to register a business domain and how to register a category.

Register Business Domain

Access the Register Business Domain page.

Enter the Business Domain name and Description and select the appropriate status.

Register Category

Access the Register Category page

Enter the Category Name and Description and select the appropriate status.

Log File Name	Enter a name for the log file and select Append to an Existing File, if desired.
Term Resolution	Log technical details of resolution of individual terms.
Context Generation	Log technical details of the generation of contexts.
Bind Substitution	Log technical details of implementation binds substituted with values from the runtime context.
Cache Management	Log technical details of usage of cache.
Object Factory Processing	Log technical details of the loading of framework object definitions.

Data Source	The product line for this database, for example CRM or HMS.
Default SetID	The setID value to use for a component that does not use set control
% of Trigger Points to Log	When logging for performance monitoring, the impact of logging can be alleviated by only logging a percent of trigger points executed. Specify a percent value between 1 and 100.
Disable Runtime	This option disables all trigger points from running.
Log to Database	Determines if the log will be written to the database, or to a text file.
Log File Name Prefix	If a file is logged instead of the database, this prefix is prepended to each user's log file. Note. The decision engine log file is created in the default files directory for this application server instance. Typically, the application server uses the directory %PS_HOME%\appserv\<servername>\files. The application server creates this directory as needed; therefore, if no log files have been written, it may not yet exist.
Log Everything	If checked, causes all normal logging options are activated.
Data Library Logging	Includes the data library log entries in the decision engine log.
Log Driver Keys	Log the primary key values driving each trigger point's context (transaction).
Log Messages	Log messages that policies or actions may generate.
Context Bind Values	Log values retrieved directly from the operant context.
Elapsed Trigger Point Time	Log the time required to complete a trigger point.
Elapsed Term Evaluation Time	Log the time required to evaluate a term.
Term Values	Log the values of evaluated data library terms.
Trigger Point Action Count	Log the number of actions created by the execution of a trigger point.
Trigger Point Policy Count	Log the number of policies evaluated for a trigger point.
Trigger Point created Actions	Log the actions created during the evaluation of policy conditions for a trigger point.
Elapsed Policy Time	Log the time required to evaluate the condition portion of a policy.
Policy Fired	Log whether a policy condition was true or false.
Action Counts per Policy	Log the number of actions created by a policy.
Terminal Actions Generated	Log terminal actions created by a policy.
Elapsed Action Time	Log the time it takes an action to complete.
Actions Combined Together	Log actions that were combined during execution.
Ignored Terminal Actions	Log any terminal actions that could not be invoked.
Debug Trace	Log debugging information, not normally used.

Trigger Point Name	Unique and descriptive name of the trigger point.
Trigger Type	Used by IT developers to figure out which PeopleSoft event in the component needs to be enabled with this trigger point. Also restricts the list of valid action types that may be used when creating policies for this trigger point.
Code Name	Used to reference the trigger point when programmatically enabling this trigger point for a PeopleSoft component. Changes made to the code name, after enabling this trigger point for a PeopleSoft component, may disrupt the execution of policies for this trigger point at runtime.
Context Name	Defines the context for the trigger point.

Resolution Method Name	Unique name of the resolution method.
Driver Class	The application class that encapsulates the data retrieval mechanism for this resolution method.
Parameters...	Lists the parameters that an implementation using this method needs to supply.
Datatypes...	Lists the valid data types that can be returned by an implementation using this resolution method.