[Index]

Model: relation/HcsHierarchyNodeREL

Hierarchy

An administrator can view the portion of the hierarchy that the administrator has access to. The provider administrator can view the complete hierarchy, while a customer administrator can view only the customer, any intermediate nodes beneath the customer, and customer sites.

Procedure

  1. To view the hierarchy, choose Hierarchy Management > Hierarchy.

    A table containing the hierarchy nodes visible to the administrator is displayed:

    Field Description
    Name Node name
    Description Node description
    Hierarchy Node Type Indicates Provider, Reseller, Customer, or Site. Is blank for an intermediate node.
    Hierarchy Shows the node location in the hierarchy in dot notation.
  2. To view a subset of the visible hierarchy, you can adjust the hierarchy path.

    Example: For instance, if a provider administrator, sets the path to point to a particular customer they can see only the hierarchy nodes for that customer.

  3. The hierarchy nodes can be sorted by clicking on the field headers.

    The hierarchy nodes can be searched by clicking the search icon on the field headers.

Model Details

Title Description Details
Name * The name by which this hierarchy node will be known.
  • Field Name: name
  • Type: String
  • Pattern: ^([A-Za-z0-9_\-][A-Za-z0-9_\ -]*[A-Za-z0-9_\-]|[A-Za-z0-9_\-])$
Description A general description for the hierarchy node.
  • Field Name: description
  • Type: String
Hierarchy node type A type label for this node which refers to a Hierarchy Node Type.
  • Field Name: node_type
  • Type: String
  • Target: data/HierarchyNodeType
  • Target attr: name
  • Format: uri
Shadow
  • Field Name: shadow.[n]
  • Type: Array
  • Cardinality: [0..1]
Name *
  • Field Name: shadow.[n].name
  • Type: String
  • MaxLength: 1024
API reference for relation/HcsHierarchyNodeREL