Profiling API
Profiles are organized into folders and sub-folders containing one or more profile values. You can visualize the resulting structure as a tree of information, with each profile (along with its folders, sub-folders, and allowed values) being a branch of the tree. Each folder, sub-folder, or value is considered to be a node (or profilenode) on the tree. The profile tree is a hierarchical structure containing profilenode objects and branches that link the different profilenodes with each other. Each branch has a top-level root node with sub-folder nodes (if any) and value nodes that represent the leaves of the tree.
The profiling API consists of ACL functions that walk a profile tree and traverse the profilenodes to determine the following information:
• The different properties of each profilenode. (For example, to determine the type of node the profilenodeis.
• Relative location information about the profilenode such as the node's ancestors, children, and so on.
A profilenode can be one of the following types:
• STANDARD_PROFILE, RADIO_PROFILE or FOLDERED_PROFILE — The type assigned to the top-level (root) profilenode.
A profile is of type RADIO_PROFILE if takes on radio choices as allowed values (unique profiles). A profile is of type FOLDERED_PROFILE if it contains folders. Otherwise, the profile is of type STANDARD_PROFILE.
• PROFILE_FOLDER
• ALLOWED_VALUE
The following elements in a profile configuration file are assigned a profilenode value as defined in the following table:
Types of Profilenodes
|
Element
|
Profilenode Type and Value
|
|
<Profile>
|
• STANDARD_PROFILE = 1
• RADIO_PROFILE = 2
• FOLDERED_PROFILE = 3
|
|
<ProfileFolder>
|
PROFILE_FOLDER = 4
|
|
<Allowed>
|
ALLOWED_VALUE = 5
|
|
Unrecognized markup
|
INVALID_PROFILE = 0
|
The following ACL functions support profiling and allow for site-specific customizations of Arbortext Editor profiling capabilities. Refer to the Arbortext Editor online help for detailed descriptions of each function.