Understanding TreeMover

TreeMover enables you to move PeopleSoft trees between different PeopleSoft application databases. It enables you to export a tree to a flat file and to import a tree from a flat file. TreeMover moves all types of tree data, including the tree definition, tree structure, tree nodes, tree leaves, tree node data, and tree level data.

TreeMover does not support branched trees. If you import a branched tree, the branches become regular tree nodes.

Advantages of using TreeMover instead of other methods of moving trees, such as Data Mover or custom SQR, include:

• TreeMover can move trees between different versions of PeopleSoft databases, for example, from a PeopleSoft Financials 7.5 database to a PeopleSoft EPM 8 database.

• Tree Mover can move tree node data (description, setID, effective date, and effective status) for trees that have node data stored in the PS_TREE_NODE_TBL (the table that stores the tree node data is specified as part of the tree structure).

• Tree Mover can move tree level data (long description, short description, setID, effective date, and effective status) for trees that have level data stored in the PS_TREE_LEVEL_TBL—the table that stores the tree level data is specified as part of the tree structure.

• TreeMover uses the tree APIs, which means the same logic used for the PeopleSoft Tree Manager application is used to load and unload trees using TreeMover.

All the same edit checks are performed on a tree created with TreeMover as are performed on a tree created manually with PeopleSoft Tree Manager because both use the same functionality to create the tree. Because TreeMover processes are initiated from standard PeopleSoft pages, the ability to import and export tree data can be restricted by using PeopleSoft standard security mechanisms for limiting access to pages. If a source tree uses branches, you need to recreate them after TreeMover finishes its import operation.

Here are some example tasks that you can use with TreeMover:

• Load a winter tree with nodes from a legacy financial database quickly and easily into PeopleSoft 8 databases.

• Automatically replace an account tree every month with a new tree based on current information.

TreeMover consists of three parts: a utility to export a tree from a PeopleSoft 8 database, a utility to import a tree into a PeopleSoft 8 database, and a utility to export a tree from a PeopleSoft 7.x database. The import and export functionality for a PeopleSoft 8 database is implemented as a PeopleSoft Application Engine application process. As with other Application Engine processes, they can be scheduled to run automatically from the Process Scheduler. The Application Engine process uses PeopleCode Tree APIs, PeopleCode File APIs, and file layout definitions. The utility that enables you to export trees from a PeopleSoft 7.x database is implemented as an SQR program (TMDOWNLD.SQR).

TreeMover uses the following PeopleTools system tables for trees during both the tree import and tree export processes:

• PSTREEDEFN

• PSTREENODE

• PSTREELEAF

• PSTREESTRCT

• PSTREELEVEL

• PS_TREE_LEVEL_TBL

• PS_TREE_NODE_TBL

TreeMover also reads the PSSTATUS table during the tree export process to identify the version of the tree data exported.

As delivered, TreeMover uses seven different file layouts. All the data for an exported tree is contained in a single file. Prior to a change in the file layout used for the export file, TreeMover writes a header record to the file to indicate what the next file layout is. The following table lists the standard file formats, along with their actual file layout name and the text of the header record that precedes a given layout data.

The TreeMover export program processes the data in the order listed in the preceding table.

If you write your own export file, then you must adhere to the following rules:

• The Tree Structure record, if present, must always come first in the file.

  If it is not present, the TreeMover import program defaults to the record layouts used prior to release 8.1.

• The Tree Definition record, if present, must come after the Tree Structure record.

• The Tree Level records—only for trees with levels—must come before the Tree Node and Leaf records.

• The Tree Node and Leaf records are required for any export file.

• Prior to the change in the record layout, you must precede the next data record with the appropriate header record for that file format.

The TreeMover file formats and contents are:

• 999TREE_VERSION

  Tree Version Data

• 999TREE_STRCT

  Tree Structure Data

• 999TREE_DEFN

  Tree Definition Data

• 999TREE_USERLVL

  Tree Level Data 1

  Tree Level Data 2

• Tree Level Data N

• 999TREE_LEVEL

  Tree Level 1

  Tree Level 2

• Tree Level N

• 999TREE_USERND

  Tree Node Data 1

  Tree Node Data 2

• Tree Node Data N

• 999TREE_NODE

  Tree Node 1

  Tree Node 2

• Tree Detail 1

• Tree Detail 2

• Tree Node 3

• Tree Node 4

• Tree Node N

• Tree Detail 5

• Tree Detail N

Image: Example of TreeMover

This is an example of TreeMover.

TreeMover reads these records in the following strict order during an import:

1. PeopleTools Version (optional).

   This record is needed only if loading data from an 8.1 or later PeopleSoft database.

2. Tree Structure (optional).

   This record is needed only if the structures do not already exist. One or more structure records can be loaded.

3. Tree Definition (required).

   The information needed to create a tree. Only one tree definition record can exist in the input file.

4. Tree Level Data (optional).

   The detailed level data for a tree. One or more level data records can exist in the input file.

5. Tree Levels (required for leveled trees).

   The levels defined for the tree. Must include enough to define all the nodes. One or more level records can exist in the input file.

6. Tree Node Data (optional).

   The detailed tree node information: description, effective date, and so on.

7. Tree nodes and leaves (required).

   Tree node and detail information. Each node must contain either a parent node or a previous sibling node. The referenced node—parent or sibling—must precede the node that references it in the input file.

   Detail values for a tree must exist in the database before importing the tree.

   One or more node records listed in level plus sibling order—that is, the root node on the first level, nodes on the second level, and so on—can exist in the input file.

Each record starts with a unique identifier for that record type, followed by the associated column data. All data is in a fixed format.