Action Script Parameters

The parameters used by each action in each flat file column are as follows:

Table 13. Action Script Parameters

Action Name

Param1

Param2

Param3

Param4

Param5

Param6

Param7

Activate

Activates the specified node in the hierarchy

Version

Hierarchy

Node

    

Add

Adds the specified node (or domain node) to the specified hierarchy (This action can only be used for a node that does not already exist within the specified version)

Version

Hierarchy

Node

Parent node

Leaf property

Description

Required if adding a domain node

Domain

Required if adding a domain node

AddDomainToVersion

Adds a domain to a version

Version

Domain

     

AddHier

Adds a hierarchy to a version

Version

Hierarchy

Description

Top Node

   

AddInsert

Adds the specified node (or domain node) if it does not already exist in the specified version, otherwise the node is inserted

Version

Hierarchy

Node

Parent node

Leaf property

Required only if adding a node

Description

Required if adding a domain node

Domain

Required if adding a domain node

AddOrphan

Adds an orphan node (or domain node) to a version

Version

Node

Leaf Property

Description

Required if adding a domain node

Domain

Required if adding a domain node

  

Annul

Annuls the specified node

Version

Hierarchy

Node

    

AnnulAllBelow

Annuls all nodes following the specified node

Version

Hierarchy

Node

    

AssignHierValidations

Assigns validations at the hierarchy level

Version

Hierarchy

Validation

    

AssignNodeToDomain

Assigns node to domain

Version

Node

Domain

    

AssignVersionValidations

Assigns validations at the version level

Version

Validation

     

ChangeHierTopNode

Changes the top node for a specified hierarchy

Version

Hierarchy

New Top Node

    

ChangeProp

Updates the value of the specified property of the specified node

Version

Hierarchy

Node

Property label or name

Controlled by the Property References By Label option.

Value

  

ClearPropsBelow

Clears the values of the specified property in all of specified node’s children (Corresponds to the Clear All Below command that is available to users within Data Relationship Management)

Version

Hierarchy

Node

Property label

   

Delete

Deletes the specified node from the version, and merges it with the merge node if one is specified

Version

Hierarchy

Node

(Merge node)

   

DeleteHier

Deletes a hierarchy from a version

Version

Hierarchy

     

DeleteOrphan

Deletes an orphan node

Version

Node

     

Destroy

Destroys the specified node from the version

Version

Hierarchy

Node

    

Inactivate

Inactivates the specified node in the hierarchy, and merges it with the merge node if one is specified

Version

Hierarchy

Node

(Merge node)

(Domain Node Inactive Date)

  

Insert

Inserts the specified node into the specified hierarchy (This action can only be used for nodes that already exist in another hierarchy within the specified version)

Version

Hierarchy

Node

Parent node

   

LockProp

Locks or unlocks the specified property of the specified node

Version

Hierarchy

Node

Property label

Is Locked (0=false, 1=true)

  

Move

Moves the specified node within the hierarchy

Version

Hierarchy

Node

Destination parent node

   

NodeExists

Returns True if the specified node exists in the specified version, otherwise returns False

Version

Node

     

NodeExistsInHier

Returns True if the specified node exists in the specified hierarchy, otherwise returns False

Version

Hierarchy

Node

    

NodeHasAsParent

Returns True if the specified parent node is the parent of the specified node, otherwise returns False

Version

Hierarchy

Node

Parent node

   

PropCompare

Returns True if the value of the specified property of the specified node equals the value listed in the flat file, otherwise returns False

Version

Hierarchy

Node

Property label

Value

  

PropQuery

Returns the value of the specified property of the specified node in the Action Script result set

Version

Hierarchy

Node

Property label

   

Rem

Indicates a remark/comment row in the flat file (Any arbitrary text can be entered on other columns of this row for documentation purposes—it is ignored by the Action Script process)

Remark

Remark

Remark

Remark

Remark

  

Remove

Removes the specified node from the hierarchy

Version

Hierarchy

Node

    

RemoveDomainFromVersion

Removes a domain from a version

Version

Domain

     

RemoveDupProps

Removes (clears) duplicate properties for the specified node (Corresponds to the Remove Duplicates command that is available to users within Data Relationship Management)

Version

Hierarchy

Node

Property label

   

RemoveHierPropValue

Removes (clears) the value of a hierarchy property

Version

Hierarchy

Property label

    

RemoveProp

Removes (clears) the value of the specified property of the specified node (The property itself is not deleted because many other nodes may be utilizing this property)

Version

Hierarchy

Node

Property label

   

RemoveVersionPropValue

Removes (clears) the value of a version property.

Version

Property label

     

SetControlledProperties

Sets the controlling hierarchy for one or more properties.

Version

Hierarchy

Property List

    

UpdateHierPropValue

Updates the value of a hierarchy property

Version

Hierarchy

Property label

Value

   

UpdateVersionPropValue

Updates the value of a version property

Version

Property label

Value