Maintaining Trees

This chapter discusses how to:

• Maintain trees.

• Maintain tree structures.

• Subscribe to TREE_CHANGE service operations.

Maintaining Trees

This section discusses how to:

• Perform audits and delete trees.

• Copy trees.

• View trees.

Pages Used to Maintain Trees

Performing Audits and Deleting Trees

Access the Tree Maintenance page by selecting Tree Manager, Tree Utilities, Copy/Delete Tree.

This is an example of the Tree Maintenance page:

Key Type	Displays the key type associated with this tree. SetID: The tree is identified by tree name and setID. Business Unit: The tree is identified by a business unit. User Defined Node Key: The tree is identified by a user-defined key. None: The tree does not contain an additional key. It is keyed only by tree name and effective date.
User Key	Displays the key value. This field is blank if the key type is None.
Valid Tree	Displays the status of the tree.
Perform Audits	To audit a tree, select its check box and click this button. The Last Audit field for the tree changes to Valid Tree if the tree passes the audit. If the tree fails the audit, the Last Audit field changes to Draft Tree. Note. You can get a detail listing of audit errors by running the Repair Tree batch program.
Copy	To access the Tree Definition and Properties page and copy a tree, select a tree check box and click this button.
Delete	To delete a tree, select its check box and click this button.
View	To access the Tree Viewer page and view a tree, select a tree check box and click this button.

Note. Trees secured by PeopleSoft Object Security for anything but full access are not listed and cannot be updated or deleted from the Tree Maintenance page.

See Also

Using the Repair Tree Program

Copying Trees

Use these steps to access the Copy Tree page:

1. Select Tree Manager, Tree Utilities, Copy/Delete Tree.

2. On the Tree Maintenance page, select a tree and click the Copy button.

   The Copy Tree page appears.

This is an example of the Copy Tree page:

Make any necessary changes and click the Copy button.

Viewing Trees

Use these steps to access the Tree Viewer page:

1. Select Tree Manager, Tree Utilities, Copy/Delete Tree.

2. On the Tree Maintenance page, select a tree and click the View button.

   The Tree Viewer page appears.

This is an example of the Tree Viewer page:

After viewing the tree information, click the Close button to return to the Tree Maintenance page.

Note. Trees displayed in view mode do not differentiate between standard nodes and branches. All nodes expand and collapse so that you can view the whole tree. Use the Expand Node Hierarchy icon to expand all child nodes.

If the multiuser environment is enabled, users will not be able to delete a tree if any branch of the tree – or the tree itself – is checked out by any user.

Maintaining Tree Structures

This section discusses how to:

• Delete tree structures.

• Copy tree structures.

• View and edit tree structures.

Pages Used to Maintain Tree Structures

Deleting Tree Structures

Use these steps to access the Tree Structure Maintenance page:

1. Select Tree Manager, Tree Utilities, Copy/Delete Tree.

2. Select the Tree Structure Maintenance tab.

   The Tree Structure Maintenance page appears.

This is an example of the Tree Structure Maintenance page:

Node Record Name	Displays the name of the record that stores information about the tree nodes.
Detail Record Name	Displays the name of the record definition that corresponds to the kind of detail value in the structure.
Copy	To access the Copy Tree Structure page and copy a structure, select a structure check box, and click this button.
Delete	To delete a tree structure, select its check box and click this button. You cannot delete a structure that is currently being used by a tree.
View	To access the Tree Structure Properties page and view a structure, select a structure check box and click this button.

Note. Tree structures secured by PeopleSoft Object Security for anything but full access are not listed and cannot be updated or deleted from the Tree Structure Maintenance page.

Copying Tree Structures

Use these steps to access the Copy Tree Structure page:

1. Select Tree Manager, Tree Utilities, Copy/Delete Tree.

2. Select the Tree Structure Maintenance tab.

3. Select a tree structure and click the Copy button on the Tree Structure Maintenance page.

   The Copy Tree Structure page appears.

This is an example of the Copy Tree Structure page.

To copy a tree structure:

1. In the Copy Tree Structure page, enter a new tree structure ID.

2. Change the description in the New Description field.

3. Click the Copy button.

   You return to the Tree Structure Maintenance page. The new tree structure is listed.

Viewing and Editing Tree Structures

Use these steps to access the Tree Structure Properties page:

1. Select Tree Manager, Tree Utilities, Copy/Delete Tree.

2. Select the Tree Structure Maintenance tab.

3. Select a tree structure and click the View button on the Tree Structure Maintenance page.

   The Tree Structure Properties page appears.

This is an example of the Tree Structure Properties page:

Select the Levels, Nodes, and Details tabs to view additional information.

Click the OK or Cancel button to return to the Tree Structure Maintenance page.

See Also

Understanding Steps to Create Trees

Subscribing to TREE_CHANGE Service Operations

This section provides an overview of TREE_CHANGE service operations and discusses how to:

• Create a notification PeopleCode.

• Configure Integration Broker.

• Create a service operation handler.

• Set full access to the corresponding permissions list.

• Test a subscription process.

Understanding TREE_CHANGE Service Operations

Every time you perform an action in PeopleSoft Tree Manager to change a tree definition (such as delete, any kind of save, copy, branch, or unbranch), a TREE_CHANGE service operation is published based on the Tree Key information using the PSTREEPUBSUB record.

Note. From PeopleTools 8.48, sending a TREE_CHANGE service operation every time tree changes are made is optional. To improve performance, you can select not to send a TREE_CHANGE service operation whenever you change a tree definition. The default setting is sending a TREE_CHANGE service operation. This service operation is not saved to the database.

If applications want to use TREE_CHANGE service operation, they must create a service operation handler. The service operation handler runs every time this service operation is published.

Note. The field EVENT_ID is defined in the Financials database as a Char,20 field, and is used by a number of applications. In PeopleTools PSTREEPUBSUB, the field was defined as a Number,6. To avoid conflicts, EVENT_ID has been removed from PSTREEPUBSUB and replaced with TREE_EVENT_ID.

This change may affect applications who subscribe to the TREE_CHANGE event, and check for EVENT_ID in PeopleCode using field name.

Creating a Notification PeopleCode

To create a notification PeopleCode:

1. Select Go, PeopleTools, Application Designer.

2. Create an application package and an application class that implements PS_PT: Integration: INotificationHandler interface.

   For a subscription, you use the INotificationHandler application class and the OnNotify method, and optionally use the OnError method for error handling.

   Note. This application package PeopleCode is tied to the TREE_CHANGE service operation through a service operation handler.

The following example shows an application class that is used to subscribe to TREE_CHANGE service operation:

In the above example, TREE_CHANGE_SUB_TEST application class has three methods. The constructor, TREE_CHANGE_SUB_TEST and the event handler, OnNotify are required. TREE_CHANGE_SUB_TEST application class has an extra method LogToFile that is used for testing purposes only. This message records a data retrieved from a message being received.

See Also

Sending and Receiving Messages

Configuring Integration Broker

To configure Integration Broker in PIA:

1. Select PeopleTools, Integration Broker, Integration Setup, Services Operations.

   The search page appears.

2. Select TREE_CHANGE service operation name, and click the Search button.

3. Click the TREE_CHANGE link.

   The General page appears.

4. On the General page, select the Generate Local-to-Local option.

   Local-to-local routing is auto-generated.

This is an example of the General page:

See Also

Managing Service Operations

Creating a Service Operation Handler

Access the Handlers page (in the General page, select the Handlers tab).

To create a service operation handler:

1. Select PeopleTools, Integration Broker, Integration Setup, Services Operations.

2. Select TREE_CHANGE service operation name, and click the Search button.

3. Click the TREE_CHANGE link.

   The General page appears.

4. On the Handlers page, enter a handler name.

5. Select the On Notify option from the Type drop-down list box.

6. Select the Application Class option from the Implementation drop-down list box.

7. Click the Details link.

   The Handler Details page appears.

8. Populate the required fields with data from the application package that you created.

The following example shows the Handler Details page populated with data from the application package.

Note. There is a colon in the Path edit box.

See Also

Adding Handlers to Service Operations

Setting Full Access to the Permissions List

To set full access to the corresponding permission list:

1. Select PeopleTools, Integration Broker, Integration Setup, Services Operations.

2. Select TREE_CHANGE service operation name, and click the Search button.

3. Click the TREE_CHANGE link.

4. In the General page, click the Service Operation Security link.

   The Web Service Access page appears.

5. Set full access to corresponding permissions list, and click the Save button.

   Note. For additional security setting, check whether the permission list used for your user includes TREE_MAINT queue. Also, check whether TREE_MAINT queue has full access rights.

This is an example of the Web Service Access page:

Testing a Subscription Process

To test a TREE_CHANGE subscription process:

1. Select Tree Manager, Tree Manager.

2. Search for an existing tree and open it in the Tree Manager page.

3. Change any tree and save it.

   Note. You can also use Save As functionality to create a new tree.

4. Select PeopleTools, Integration Broker, Service Operations Monitor, Monitoring, Asynchronous Services.

5. Select the Subscription Contracts tab.

   The Subscription Contracts page appears.

6. Select a node in the Node Names field.

7. Select the TREE_CHANGE option from the Service Operation drop-down list box.

8. Select the TREE_MAINT option from the Queue Name drop-down list box.

9. Click the Refresh button.

   A list of service operations are displayed under your test subscription.

The following examples show the list of service operations received under test subscription.

When you click the Details link in the Results section of the Subscription Contracts page, the Asynchronous Details page appears.

This is an example of the Asynchronous Details page:

Note. If a subscription PeopleCode test program shown above is used, you can view the file being generated (Windows OS) as a part of a test subscription class at e:\temp\subscription.txt.