PeopleSoft Analytic Calculation Engine ComponentsThis chapter discusses:
PeopleSoft Analytic Calculation Engine components.
PeopleSoft Analytic Calculation Engine architecture.
PeopleSoft Analytic Calculation Engine development process.
PeopleSoft Analytic Calculation Engine security.
PeopleSoft Analytic Calculation Engine ComponentsThis section discusses these PeopleSoft Analytic Calculation Engine components:
Analytic model.
Analytic type.
Analytic instances.
Analytic calculation engines.
Analytic server instances.
Analytic Calculation Engine classes.
Analytic Calculation Engine Metadata classes.
AnalyticType classes.
AnalyticGrid classes.
PeopleSoft Pure Internet Architecture pages with analytic grids.
Analytic Model Viewer.
Analytic Instance Capture Utility.
PeopleSoft Performance Monitor.
Analytic Model
Use PeopleSoft Application Designer to create an analytic model. When you create an analytic model, you:
Define data cubes, dimensions, cube collections, and other parts that are used to organize and calculate individual fields of data.
Map records to cube collections within the analytic model.
Map individual record fields to data cubes and dimensions within the cube collections.
Both PeopleSoft Analytic Calculation Engine and PeopleSoft Optimization Framework use analytic types. Use PeopleSoft Application Designer to create an analytic type definition, which defines the caching behavior of the records that the analytic model uses, specifies the records that are accessible by all end users, and specifies the records that are only accessible by certain users for what-if scenario forecasting.
See Purpose of Analytic Type Definitions, Designing Analytic Type Definitions.
Analytic instances are runtime instances of analytic types that are loaded into analytic server instances by means of the AnalyticInstance class Load method. The AnalyticInstance class is one of the Analytic Calculation Engine classes. To view and edit analytic model data, an end user selects an analytic instance ID within an application's PeopleSoft Pure Internet Architecture pages.
Analytic calculation engines run inside analytic server instances. They calculate analytic instance data by using the relationships and rules that are defined in the analytic model.
When used with PeopleSoft Analytic Calculation Engine, analytic server instances are processes in the application server domain that contain and run analytic instances and analytic calculation engines. When a user selects an analytic instance ID within an application, the system generates one analytic calculation engine and one analytic server instance. One analytic server instance can contain one and only one analytic instance, and one and only one analytic calculation engine. All three of these components—plus the application server—exist in one application server domain. An application server can only communicate with analytic server instances that exist in the same application server domain as the application server. For this reason, a PeopleSoft application that exists in one application server domain cannot communicate with an analytic model that exists in a different application server domain.
The PSANALYTICSRV table contains a row that provides information about each analytic server instance that is running within an application server domain. You administer analytic server instances by using the Summary and Servers pages that display the data from the PSANALYTICSRV table.
See Administering Analytic Servers.
Analytic Calculation Engine Classes
You use the Analytic Calculation Engine classes for all runtime operations between PeopleSoft applications and analytic calculation engines. Use the Analytic Calculation Engine classes to either retrieve or specify data in an instance of an analytic model loaded into the system, and also to calculate (or recalculate) data cube values. The Analytic Calculation Engine classes run on the application server and use Tuxedo service requests to communicate with analytic server instances.
The Analytic Calculation Engine classes contain the AnalyticInstance classes, which are used by PeopleSoft Analytic Calculation Engine and PeopleSoft Optimization Framework to manipulate analytic instance definitions with PeopleCode. Use the AnalyticInstance classes to manipulate analytic instance definitions at runtime.
See Analytic Calculation Engine Classes.
Analytic Calculation Engine Metadata Classes
The Analytic Calculation Engine Metadata classes are application classes that PeopleSoft applications use to create and change analytic model metadata. For example, using the Analytic Calculation Engine Metadata classes you could modify a calculation rule. Applications can use the Analytic Calculation Engine Metadata classes to perform all of the analytic model-related actions that are available in PeopleSoft Application Designer.
See Analytic Calculation Engine Metadata Classes.
The AnalyticType classes are PeopleCode application classes that PeopleSoft applications use to manipulate analytic type definitions. Use the AnalyticType classes at runtime to perform all of the analytic type definition-related actions that are available in PeopleSoft Application Designer.
See Analytic Calculation Engine Metadata Classes.
PeopleSoft Analytic Calculation Engine uses the AnalyticGrid classes to manipulate analytic grids using PeopleCode. Use the AnalyticGrid classes to manipulate the display or data of analytic grids at runtime.
PeopleSoft Pure Internet Architecture Pages with Analytic Grids
Use PeopleSoft Application Designer to create PeopleSoft Pure Internet Architecture pages with analytic grids. Pages with analytic grids display PeopleSoft Analytic Calculation Engine data and application data within PeopleSoft applications. Within the application, a PeopleSoft Pure Internet Architecture page with an analytic grid may be referred to as an interactive report. Analytic grids provide drag and drop functionality so end users can view their data in different ways.
Analytic Model Viewer
The Analytic Model Viewer helps developers debug and analyze analytic models by enabling them to view an analytic model's parts and to view and edit an analytic model's application data.
See Viewing and Debugging Analytic Models.
Analytic Instance Capture Utility
When experiencing problems with an application that uses an analytic model, customers can use the Analytic Instance Capture Utility to package analytic model data and metadata to send to PeopleSoft support for analysis.
See Capturing Analytic Instances.
PeopleSoft Performance Monitor
PeopleSoft Performance Monitor enables you to monitor PeopleSoft Analytic Calculation Engine and view real-time and historical performance data. PeopleSoft Performance Monitor provides the information that you need to solve immediate performance issues as well as analyze trends in system performance.
PeopleSoft Analytic Calculation Engine ArchitectureThis diagram illustrates how the various PeopleSoft Analytic Calculation Engine architecture components work together:
PeopleSoft Analytic Calculation Engine architecture
PeopleSoft Analytic Calculation Engine Development ProcessYou should follow the development process outlined here for your PeopleSoft application to correctly employ the features of PeopleSoft Analytic Calculation Engine.
Development Process Without Existing Record StructuresIf you do not have existing record structures on which to base your analytic model, perform this iterative process:
Create the record definitions while creating the analytic model's cube collections.
Create the rest of the analytic model.
Define application data security.
Create an analytic type definition.
At the appropriate step in this process, you must attach the analytic type to the analytic model.
Attach the analytic type to the analytic model.
See Creating Analytic Type Definitions, Creating Analytic Model Definitions.
Create PeopleSoft Pure Internet Architecture pages with analytic grids.
Note. Within the application, a PeopleSoft Pure Internet Architecture page with an analytic grid may be referred to as an interactive report.
As needed, create pages and any required PeopleCode to administer analytic instances.
As needed, write PeopleCode programs using the appropriate classes (Analytic Calculation Engine, Analytic Calculation Engine Metadata, AnalyticGrid, AnalyticType) to manipulate the analytic model, its data, and its display as necessary for your application.
See Enterprise PeopleTools 8.49 PeopleBook: PeopleCode API Reference.
As needed, write Application Engine programs for batch calculations.
As needed, write application pages that enable end users to load analytic instances.
Note. You can also embed analytic instance loading functionality into PeopleSoft Pure Internet Architecture pages with analytic grids.
Development Process Using Existing Record StructuresIf you have existing record structures on which the analytic model should be based, perform this iterative process:
Create a new analytic model.
At the appropriate step in this process, create the analytic model's cube collections to retrieve data from the records.
Create an analytic type definition.
Attach the analytic type to the analytic model.
See Creating Analytic Type Definitions, Creating Analytic Model Definitions.
Create PeopleSoft Pure Internet Architecture pages with analytic grids.
Note. Within the application, a PeopleSoft Pure Internet Architecture page with an analytic grid may be referred to as an interactive report.
As needed, create pages and any required PeopleCode to administer analytic instances.
As needed, write PeopleCode programs using the appropriate classes (Analytic Calculation Engine, Analytic Calculation Engine Metadata, AnalyticGrid, AnalyticType) to manipulate the analytic model, its data, and its display as necessary for the application.
As needed, write Application Engine programs for batch calculations.
As needed, write application pages that enable end users to load analytic instances.
Note. You can also embed this functionality into PeopleSoft Pure Internet Architecture pages with analytic grids.
PeopleSoft Analytic Calculation Engine SecurityPeopleSoft Analytic Calculation Engine does not provide additional data security features beyond what is already available in PeopleTools. You define analytic model data security within the application that uses the analytic model by creating a view for each read/write cube collection . Additionally, you can:
Create filter functions to restrict the data that appears in the analytic grid.
Create filter functions that filter data by userID.
See OPRID.