Relationship of Record Attributes to Data Caching Behavior

When you create an analytic type definition, how you set the record attributes determines the caching behavior of the data that is used in the analytic model. This topic describes analytic type definition record attributes and their effects on data caching.

Read Once

When you map a cube collection to a record that contains a Read Once attribute in the analytic type, the application data is read only once during analytic model load time. Map cube collections to Read Once records to load data that the user should not change during the analytic model's life cycle. You can specify the Read Once attribute for these record types:

  • SQL tables.

  • SQL views.

  • Dynamic views.

  • Query views.

Note: Data cubes that exist in a cube collection that is mapped to a main record with a Read Once attribute cannot exist in any other cube collection that is mapped to a main record with the Read Once attribute.

Readable

When you map a cube collection to a record that contains a Readable attribute in the analytic type, the application data is read during analytic instance load time and is updated with new data after:

  • Each analytic model recalculation.

    You recalculate an analytic model by using the AnalyticModel class Recalculate method. The AnalyticModel class is one of the Analytic Calculation Engine classes.

    See Recalculate.

  • Each Save action that is triggered by a PeopleSoft Pure Internet Architecture page with an analytic grid.

  • Each time data is updated using the CubeCollection class SetData method.

    The CubeCollection class is one of the Analytic Calculation Engine classes.

    See SetData.

Map cube collections to Readable records to load data that should be refreshed more than once during the analytic model's life cycle.

You can specify the Readable attribute for the SQL table record type.

Note: Data cubes that exist in a cube collection that is mapped to a main record with the Readable attribute cannot exist in any other cube collection that is mapped to a main record with the Readable or Read Once attributes.

When a cube collection is mapped to either a Writable-only record or a record with the Readable and Writable attributes, all data cubes in the cube collection should share the same set of dimensions.

Writable

When you map a cube collection to a record that contains a Writable attribute in the analytic type, the data in the cube collection is written back to the application database after:

  • Each analytic model recalculation.

    You recalculate an analytic model by using the AnalyticModel class Recalculate method. The AnalyticModel class is one of the Analytic Calculation Engine classes.

    See Recalculate.

  • Each Save action that is triggered by a PeopleSoft Pure Internet Architecture page with an analytic grid.

  • Each time data is updated using the CubeCollection class SetData method.

    The CubeCollection class is one of the Analytic Calculation Engine classes.

    See SetData.

You can specify the Read Once attribute for the SQL table record type.

If the analytic type contains a writable-only record that uses a primary key field, you must set up the application to clear the data in the database for the writable record before recalculating the analytic instance.

Note: After the data is written back to the database, the data cubes that are mapped to the writable-only record are cleared from the analytic instance, resulting in 0 or empty values in the analytic grid.

When a cube collection is mapped to either a Writable-only record or a record with the Readable and Writable attributes, all data cubes in the cube collection should share the same set of dimensions.

Scen. Mgd (Scenario Managed)

Use the Scenario Managed attribute to indicate that the record pertains to multiple analytic instances. A scenario managed record is read from and written back to the database according to the other attributes that are specified for the record.

Typically, one user views and edits one analytic instance, although Analytic Calculation Engine supports multiple users per analytic instance.

Records that contain the scenario managed attribute must have a PROBINST key field. The PROBINST key field is used to segment the data of scenario managed records, resulting in a different data set loaded for each analytic instance.

The following table provides an example of a record with a PROBINST key field.

PROBINST key field

ACCT field

TRANS_DATE field

REGION field

BUDGET01

100

January

EUROPE

BUDGET01

100

Feb

EUROPE

BUDGET02

110

Feb

ASIA

BUDGET02

110

March

ASIA

BUDGET03

120

March

USA

In this example:

  • The users of the BUDGET01 analytic instance can access only the first and second rows of this record.

  • The users of the BUDGET02 analytic instance can access only the third and fourth rows of this record.

  • The users of the BUDGET03 analytic instance can access only the fifth row of this record.

Note: Data cubes that exist in a cube collection that is mapped to a main record with the Scenario Managed attribute cannot exist in any other cube collection that is mapped to a derived/work main record.

See Scenario Management.

Records based on dynamic views can be Scenario Managed. For these records, the associated SQL must contain a meta string for qualifying the analytic instance.

The following example shows a Dynamic View record:

SELECT PROBINST, QE_BAM_MONTH_FLD, QE_BAM_REGION_FLD, 
			  QE_BAM_PRODUCT_FLD, QE_BAM_UNIT_FLD, 
			  QE_BAM_SALES_FLD, QE_BAM_PRDSALES_FL  
FROM PS_QE_BAM_FACT_TBL
WHERE PROBINST = %ProbInst

If a Union clause is present the WHERE PROBINST= %ProbInst must be added to the individual clauses making up the SQL Union. In addition all the fields that are part of the dynamic view must be selected in the analytic type definition. This is enforced by PeopleSoft Application Designer.