Working with Metadata Utilities

This chapter discusses how to:

• View error messages.

• Audit PeopleSoft EPM objects.

• Perform impact analysis.

• Run Mass Validate.

• Run Mass Compile.

• Work with tree utilities.

• Set up and flatten tree metadata.

Viewing Error Messages

You can view error messages generated by the engines described in this chapter using the Engine Messages component. This component is described in the "Streamlining Processing with Jobstreams" chapter of this PeopleBook.

See Viewing Engine Messages.

Auditing PeopleSoft EPM Objects

This section provides an overview of the Audit utility and discusses how to:

• Run the Audit utility.

• Review metadata audit log error messages.

Understanding the Audit Utility

The PeopleSoft EPM Audit utility is a common process used to identify setup errors in PeopleSoft EPM modules. For instance, you can use the Audit utility to check the validity and existence of metadata objects in PeopleSoft EPM application tables. The Audit utility verifies that your original metadata objects (tablemaps, datamaps, constraints, filters, trees, and so forth) are still intact. The Audit utility also provides audit functionality for row-level security group objects. To remove constraints, value objects, SQL object IDs, and counter objects from the row level group tables, you must fix the security group or the missing object manually.

The Audit utility process does not need to be set up in a jobstream and can be run at any time. The processing time depends on how many selections you make. This utility can affect database performance times. To ensure a successful engine run, PeopleSoft suggests that you run an audit, review results using the Process Monitor and Messages inquiry page, and fix any problems before running a jobstream. Any problems identified by the Audit utility may require assistance from a programmer or warehouse administrator.

Page Used to Audit PeopleSoft EPM Objects

Running the Audit Utility

Access the Audit EPM Objects page (EPM Foundation, Foundation Metadata, Other Metadata Operations, Audit EPM Objects).

	Click the Select All button to run all of the engine options available.
	Click the Clear All button to deselect all check boxes.

Performance Mgmt Warehouse (Performance Management Warehouse)

In this group box the audit options are: Metadata, KPI Manager, Allocation Manager Rule, Row Level Security, Data Manager Rule, and Technical Scenarios.

The metadata objects that are examined by the Audit utility include record metadata, tablemaps, datamaps, constraints, filters, expressions, data sets, engines, jobs, and jobstream rules.

If you select the Data Manager Rule check box, the Audit utility checks for inconsistencies between data manager rules and the metadata.

KPI Manager objects that are examined by the Audit include datamaps, data elements, dimensions, constraints, filters, calculation expressions, calculation cubes, and calculation IDs.

Financial Analytics

Here you can select to run the audit on Risk-Weighted Capital, Funds Transfer Pricing, or Support Modules.

Running the Audit Utitlity

Click the Run button to run this request.

After the audit has run, you can check the Process Monitor to verify the process ran smoothly. Use the Messages inquiry pages to review any errors found by the audit.

Note. You can run the Audit utility at any time. The processing time depends on how many selections you make and depending on your selections, the utility can affect database performance times.

Reviewing Metadata Audit Log Error Messages

All messages can be found and viewed by navigating to PeopleTools, Utilities, Administration, Message Catalog. EPM messages are numbered 9000-9999.

Performing Impact Analysis

Impact Analysis enables you to determine the effects that a change to one PeopleSoft EPM object may have on the other objects related to it. For instance, depending on the type of change you make to a warehouse table, you may have to change the tablemaps and datamaps built on top of the table. Impact Analysis provides a list of the objects that are related to the object that you want to change so that you can determine the impact of the change.

This section discusses how to use Impact Analysis on PeopleSoft EPM objects.

Page Used to Perform Impact Analysis

Using Impact Analysis

Access the Impact Analysis page (EPM Foundation, Foundation Metadata, Other Metadata Operations, Impact Analysis).

Object Type	Select the type of object you want to review. The field below changes based on the object type you select. For example, if you select DataMap, the field label changes to DataMap. Enter the name of the object.
	Click the Related Objects button to populate the grid with all the objects related to the object you specified.

You can download the list of objects using the download button at the top of the grid. Using this list, you decide whether a change is feasible. You can also use the list to update team members when something changes.

Note. This is a display-only page that provides a list of all related objects.

Running Mass Validate

The Mass Validate metadata utility enables you to validate, but not compile, metadata objects. Mass Validate will certify all as of dates created for filters, constraints, and data sets for the specified run date. This utility helps ensure your metadata is valid at run time and increases your chance of a successful engine run.

This section discusses how to validate metadata objects.

Page Used to Run Mass Validate

Validating Metadata Objects

Access the Mass Validate page (EPM Foundation, Foundation Metadata, Other Metadata Operations, Mass Validate).

	Click the Select All button to run all of the engine options available.
	Click the Clear All button to deselect all check boxes.
SetID	Select the setID you want to run validate on.
As Of Date	Specify as of date for this run.
Only Imported Metadata	Select this check box to limit Mass Validate to only those objects which have their SQL counter field set to zero. Use this to validate any metadata imported into the database using the Metadata Migration utility. This metadata will not have a SQL ID when first imported. Also use it to validate any new metadata that has not been compiled. First validate the metadata and then run Mass Compile to compile it.

You can either select all objects, or individually select the objects you want to validate in the Metadata Type, Performance Management Warehouse, KPI Manager, and Workforce Analytics group boxes.

Click Run to run the Mass Validate process.

You can review any errors generated by the Mass Validate process by creating an engine error log.

See Also

Creating Error Log Reports for the Performance Ledger

Running Mass Compile

The Mass Compile metadata utility enables you to either compile individual metadata objects, or all metadata objects.

As discussed in the "Setting Up and Working with Metadata" chapter of this PeopleBook, if you change a table, you must recompile record metadata for that table. For instance, if you add a non-key column to a table, you must recompile the record metadata. If you add a key column, you must recompile both the record metadata and any tablemaps, datamaps, constraints, or other metadata objects associated with it. The advantage of Mass Compile is that you can opt to compile all metadata objects at once. In addition, if you have imported metadata into the database and validated it, you can compile it using Mass Compile.

Note. Mass Compile will not compile allocation manager rules that are period-based or have the multiple business unit option selected. These rules will be skipped and must be compiled from the Allocation Manager Rules component.

This section discusses how to compile metadata objects using Mass Compile.

See Also

Defining Allocation Manager Rules

Page Used to Run Mass Compile

Compiling Metadata Objects using Mass Compile

Access the Compile Metadata Changes page (EPM Foundation, Foundation Metadata, Other Metadata Operations, Compile Metadata Changes).

	Click the Select All button to select all the metadata types listed.
	Click the Clear All button to deselect all check boxes.
SetID	Select the setID to limit the compile to the specified input setID.
Only Imported Metadata	Select this check box to limit the Mass Compile utility to only those objects with zero SQL counter that have been imported into the database and need compiling. You should validate this metadata beforehand using the Mass Validate process.
PATHNAME	Enter the directory location where you would like the output log to be placed.

You can either select all objects, or individually select the objects you want to validate in the Metadata Type, Performance Management Warehouse, Activity-Based Management, Scorecard, and Workforce Analytics group boxes.

Working With Tree Utilities

This section provides an overview of tree utilities and discusses:

• Set up Tree Compare and run the Tree Compare job.

• Review Tree Compare results.

• Set up and run Super Tree.

• Review Super Tree results.

Understanding Tree Utilities

There are two types of tree utilities provided with EPM , Tree Compare and Super Tree.

Tree Compare Utility

The Tree Compare utility enables you to compare effective dates for trees. The results page shows nodes that have been added, deleted, or moved from one parent to another. You may also view the detail objects that have changed. To perform a tree compare, complete the Tree Compare setup page, run the Tree Compare job in a jobstream, and then inquire on the Tree Compare output using the Tree Compare inquiry page.

Super Tree Utility

The Super Tree utility enables you to combine multiple effective dates of a tree into one. This super tree contains all tree changes for a certain period of time enabling you to analyze effective-dated trees more easily.

Pages Used to Work With Tree Utilities

Setting up Tree Compare and Running the Tree Compare Job

Access the Tree Compare page (EPM Foundation, Business Metadata, Tree Metadata, Setup Tree Compare, Tree Compare).

Tree Name	Select the tree you want to compare. A description displays.
Compare Tree	Select this check box to compare the tree. If this check box is not selected, Tree Compare does not include this tree.

You can now run the Tree Compare.

To run the Tree Compare job, include the job PF_TREECOMP job in a jobstream.

Once the job has run, review the results on the Tree Compare inquire page.

Reviewing Tree Compare Results

Access the Tree Compare inquire page (EPM Foundation, Business Metadata, Tree Metadata, Setup Tree Compare, Review Tree Compare, Tree Compare).

Use this page to view nodes and details (leaves) of trees that have been deleted, added, or moved from one parent to another. You may also view all metadata filters affected by the deleted nodes and details.

Note. If you determine that the tree nodes are being used in ledger to resource mappings, run the ABM Model Validation job to find the impact on the mapping rules.

Setting Up and Running Super Tree

Access the Super Tree page (EPM Foundation, Business Metadata, Tree Metadata, Update Super Tree, Super Tree).

SetID	SetID for the tree you want to merge.
Tree Name	Name of the tree to be merged to create a super tree.
Dominant Effective Date	Trees may have the same name and different effective dates. The Super Tree is created using the dominant effective date you enter in this field.
TimeSpan	The timespan determines the begin and end date of the period for which the merge is performed. Trees with effective dates that are between the begin and end dates are included in the super tree.
Super Tree Name	You must select a valid tree name for the super tree.

Warning! If a tree that is part of the super tree has a dead node, the dead node must be removed manually. Otherwise the super tree will not build properly. Dead nodes are created when a leaf or node is deleted. You may add a deleted node or leaf elsewhere on the tree.

Note. Any nodes or details deleted before the dominant effective date and any nodes or details added after the dominant effective date will not be included in the super tree.

Reviewing Super Tree Results

Access the Super Tree inquire page (EPM Foundation, Business Metadata, Tree Metadata, Review Super Tree, Super Tree).

Setting Up and Flattening Tree Metadata

This section provides overviews of trees and tree flattening, and discusses how to:

• Define trees.

• Flatten tree metadata.

Understanding Trees

When you add trees in PeopleTools Tree Manager, you should also create a record on the Tree Metadata page to identify it to the PeopleSoft EPM system. The Tree Manager does not assign a level number to a node unless you specify that the tree either loosely or strictly enforces levels. Levels are assigned by creating a code for each level. In PeopleSoft EPM, for trees that use rules and are processed through the tree level, you must set up your trees using levels. PeopleSoft recommends specifying strictly enforced levels for all your trees.

PeopleSoft trees add a visual layer to show how detail items such as departments, accounts, products, channels, geography, and security fit into your organizational structure.

Trees depict hierarchical structures that represent a group of summarization rules for a particular database field. For example, a tree can specify how your manufacturing locations should be summarized, or rolled up, for reporting purposes. A tree can also represent the reporting relationships within an organization by specifying how the individual department should be summarized into territories, territories into regions, and regions into countries. Similarly, a tree can categorize items in a catalog.

The summarization rules depicted in a tree apply to the detail values of a particular field: vendors, departments, customers, or other values that you define. These detail values are summarized into nodes on a tree. The nodes may also be organized into levels to logically group nodes that represent the same type of information or level of summarization.

By building trees, you give the system a single place to look for summarization rules. Trees enable you to define rules once and then use them throughout the system. Different reports, ledgers, and security profiles might refer to parts of your company's organizational chart; therefore, all of these objects can be referenced in the same predefined tree.

For example, the values of the DEPTID field identify individual departments in your organization. You use Tree Manager to define the organizational hierarchy that specifies how each department relates to the others—departments 10700 and 10800 report to the same manager, department 20200 is part of a different division, and so on.

You create trees using the PeopleSoft Tree Manager. You can use the PeopleSoft Tree Mover to move trees between different versions of PeopleSoft databases, move tree node data, or move tree level data.

See Also

PeopleSoft PeopleTools PeopleBook: PeopleSoft Tree Manager

Understanding Tree Flattening in the OWE

Trees are used in PeopleSoft EPM to represent hierarchies. The trees are stored in a proprietary format that is optimized for the PeopleSoft Tree Manager module. However, this format is not optimized for EPM batch processing. To convert tree structures to a format that is optimized for batch processing, PeopleSoft delivers a tree flattener process.

The Tree Flattener (PF_TREEFLT) application engine processes the hierarchy tree and converts it to a flattened format, which simplifies the structure to retrieve information such as all descendents and immediate descendents from a node with a simple join to the flattened table. The Application engine can then use very simple SQL to access the tree data that it needs. The flattened output from the Tree Flattener (PF_TREEFLT) process is loaded to a temporary table, and you can choose to load the flattened data to a permanent OWE table if you wish. The tree flattener process can flatten detail, node-oriented, and dynamic detail trees.

To flatten dynamic detail trees, the tree flattener process retrieves the dynamic detail value table name from the Tree Structure ID and inserts these values into the flattened table. During this process a static view of the tree is created as of the date and time the flattening occurs. This means that the flattener process gets the current values of the tree detail from the dynamic detail value table and uses these in the flattener table. Because of this fact, you should not use the Persist Permanently check box with dynamic detail trees unless you are sure that the dynamic table will not change.

Note. The OWE uses a different process for flattening trees than the MDW.

For more information on the MDW tree flattening process see the chapter Processing Trees and Recursive Hierarchies in your warehouse specific PeopleBook (for example, the PeopleSoft Campus Solutions Warehouse PeopleBook).

Pages Used to Set Up and Flatten Tree Metadata

Defining Tree Metadata

Access the Tree Metadata page (EPM Foundation, Business Metadata, Tree Metadata, Tree Metadata).

Tree Metadata Information

Tree Tables

Flattening Tree Metadata in the OWE

Access the Tree Flattener page (EPM Foundation, Business Metadata, Tree Metadata, Tree Flattener).

SetID	Select the setID that is associated with the tree being flattened.
Job ID	Displays the job ID that is associated with the run control ID. Because the tree flattener process is not delivered as a standalone process but as a routine that is called within application engine, you must associate the run control ID with a job ID.
Specify Email Parameters	Click to access the Jobstream Email Notification page and specify email details for the email notification.
Tree ID	Enter the tree ID for the tree that you want flattened You can add rows to have multiple trees flattened.