Create method: Tree class
Syntax
Create(SetID, UserKeyValue, TreeName, EffDt, StructureName)Description
The Create method creates a new tree, based on the parameters passed with the method. The specified tree must be a new tree. You receive an error if the tree already exists.
The Create method can be used only with a closed tree, it cannot be used on an open tree. Before you use the Create method, you must explicitly close any open tree objects (with the Close method.) You receive an error if there are any open trees.
After you create a new tree, you don't have to open it with the Open method. The existing tree object points to the new tree.
The tree structure specified with StructureName determines what database fields the new tree is based on, what pages you can use to create tree nodes and detail values, and what record definitions PeopleSoft Tree Manager saves tree-related data in. The tree structure must already exist.
The new tree must be saved (Save, SaveAs, and so on) for this tree to be saved to the database.
Parameters
| Parameter | Description |
|---|---|
|
SetID |
Specify the table indirection key for the tree. This parameter takes a string value. If the tree structure the tree is based on has its IndirectionMethod specified as "S", you must specify a SetID. If the tree structure doesn’t have its IndirectionMethod specified as "S", you must enter a Null string (that is, two quotation marks with no blank space between them ("")) for this parameter. |
|
UserKeyValue |
Specify the User Key Value for the tree. This parameter takes a string value. If the tree structure the tree is based on has its IndirectionMethod specified as "U" or "B", you must specify a User Key Value. If the tree structure doesn’t have its IndirectionMethod specified as "U" or "B", you must enter a Null string (that is, two quotation marks with no blank space between them ("")) for this parameter. |
|
TreeName |
Specify the name for this tree. This parameter takes a string value. |
|
EffDt |
Specify the effective date for this tree. This parameter takes a string value. |
|
StructureID |
Specify the name of the tree structure to use for this tree. This parameter takes a string value. |
Returns
An integer: 0 if created successfully.
Example
&MYTREE.Create("","","PERSONAL_NEW", "05-05-1997", "PERSONAL_DATA");