.. _automate-hierarchy-management: Automate - Hierarchy Management ------------------------------- Hierarchy Management Dashboard .. raw:: latex \sphinxstylestrong{Counters} \begin{itemize} \item {\hyperref[\detokenize{src/user/create-reseller:create-a-reseller}]{\sphinxcrossref{\DUrole{std,std-ref}{Resellers}}}} \item {\hyperref[\detokenize{src/user/create-customer:create-a-customer}]{\sphinxcrossref{\DUrole{std,std-ref}{Customers}}}} \item {\hyperref[\detokenize{src/user/hierarchy:view-the-hierarchy}]{\sphinxcrossref{\DUrole{std,std-ref}{Intermediate Nodes}}}} \item {\hyperref[\detokenize{src/user/create-site:create-a-site}]{\sphinxcrossref{\DUrole{std,std-ref}{Sites}}}} \end{itemize} \sphinxstylestrong{Links} \begin{itemize} \item \sphinxstylestrong{ Hierarchy Management } \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_CUSTOMER_MANAGEMENT }}\end{verbatim} \begin{itemize} \item \sphinxstylestrong{Link Text:} Reseller \item \sphinxstylestrong{Type:} relation/HcsResellerREL \item \sphinxstylestrong{Display:} list \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_RESELLER_MANAGEMENT }}\end{verbatim} \item \sphinxstylestrong{Description:} Manage Reseller nodes in the system \item \sphinxstylestrong{Link Text:} Delete Reseller \item \sphinxstylestrong{Type:} view/HcsDeleteResellerVIEW \item \sphinxstylestrong{Display:} form \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_RESELLER_MANAGEMENT }}\end{verbatim} \item \sphinxstylestrong{Description:} Delete Reseller nodes in the system \item \sphinxstylestrong{Link Text:} Customer \item \sphinxstylestrong{Type:} relation/HcsCustomerREL \item \sphinxstylestrong{Display:} list \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_CUSTOMER_MANAGEMENT }}\end{verbatim} \item \sphinxstylestrong{Description:} Manage Customer nodes in the system \item \sphinxstylestrong{Link Text:} Delete Customer \item \sphinxstylestrong{Type:} view/HcsDeleteCustomerVIEW \item \sphinxstylestrong{Display:} form \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_CUSTOMER_MANAGEMENT }}\end{verbatim} \item \sphinxstylestrong{Description:} Delete Customer nodes in the system \item \sphinxstylestrong{Link Text:} Intermediate Node \item \sphinxstylestrong{Type:} relation/HcsHierarchyNodeREL \item \sphinxstylestrong{Display:} list \item \sphinxstylestrong{Filter Options:} [{'filterValue': 'IntermediateNode', 'filter_by': 'node_type', 'operation': 'equals'}] \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_INTERMEDIATENODE_MANAGEMENT }}\end{verbatim} \item \sphinxstylestrong{Description:} Manage Intermediate nodes in the system \item \sphinxstylestrong{Link Text:} Delete Intermediate Node \item \sphinxstylestrong{Type:} view/HcsDeleteIntermediateNodeVIEW \item \sphinxstylestrong{Display:} form \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_INTERMEDIATENODE_MANAGEMENT }}\end{verbatim} \item \sphinxstylestrong{Description:} Delete Intermediate nodes in the system \item \sphinxstylestrong{Link Text:} Site \item \sphinxstylestrong{Type:} relation/HcsSiteREL \item \sphinxstylestrong{Display:} list \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_SITE_MANAGEMENT }}\end{verbatim} \item \sphinxstylestrong{Description:} Manage Sites in the system \item \sphinxstylestrong{Link Text:} Delete Site \item \sphinxstylestrong{Type:} view/HcsDeleteSiteVIEW \item \sphinxstylestrong{Display:} form \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_SITE_MANAGEMENT }}\end{verbatim} \item \sphinxstylestrong{Description:} Delete Sites in the system \item \sphinxstylestrong{Link Text:} Site Defaults \item \sphinxstylestrong{Type:} data/SiteDefaultsDoc \item \sphinxstylestrong{Display:} list \item \sphinxstylestrong{Field Display Policy:} default \item \sphinxstylestrong{Description:} View site default settings \item \sphinxstylestrong{Link Text:} Site Defaults Templates \item \sphinxstylestrong{Type:} data/SiteDefaultsDoc \item \sphinxstylestrong{Display:} list \item \sphinxstylestrong{Filter Options:} [{'filterValue': '_TEMPLATE', 'filter_by': 'name', 'operation': 'contains'}] \item \sphinxstylestrong{Field Display Policy:} default \item \sphinxstylestrong{Description:} Site defaults templates to drive the site specific site defaults creation \item \sphinxstylestrong{Link Text:} Customer Build \item \sphinxstylestrong{Type:} relation/CustomerBuild_CustomerData_REL \item \sphinxstylestrong{Display:} list \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_CUSTOMER_MANAGEMENT }}\end{verbatim} \item \sphinxstylestrong{Description:} Orchestrated feature to build customer and related configuration based on templates setup and selected \item \sphinxstylestrong{Link Text:} Run Hierarchy Model Reports \item \sphinxstylestrong{Type:} view/ModelReportVIEW \item \sphinxstylestrong{Display:} list \item \sphinxstylestrong{Link Text:} Hierarchy Model Report Results \item \sphinxstylestrong{Type:} data/ModelReport \item \sphinxstylestrong{Display:} list \end{itemize} \item \sphinxstylestrong{ Hierarchy Management } \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_CUSTOMER_HIERARCHY_TYPE }}\end{verbatim} \begin{itemize} \item \sphinxstylestrong{Link Text:} Intermediate Node \item \sphinxstylestrong{Type:} relation/HcsHierarchyNodeREL \item \sphinxstylestrong{Display:} list \item \sphinxstylestrong{Filter Options:} [{'filterValue': 'IntermediateNode', 'filter_by': 'node_type', 'operation': 'equals'}] \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_INTERMEDIATENODE_MANAGEMENT }}\end{verbatim} \item \sphinxstylestrong{Description:} Manage Intermediate nodes in the system \item \sphinxstylestrong{Link Text:} Delete Intermediate Node \item \sphinxstylestrong{Type:} view/HcsDeleteIntermediateNodeVIEW \item \sphinxstylestrong{Display:} form \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_INTERMEDIATENODE_MANAGEMENT }}\end{verbatim} \item \sphinxstylestrong{Description:} Delete Intermediate nodes in the system \item \sphinxstylestrong{Link Text:} Site \item \sphinxstylestrong{Type:} relation/HcsSiteREL \item \sphinxstylestrong{Display:} list \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_SITE_MANAGEMENT }}\end{verbatim} \item \sphinxstylestrong{Description:} Manage Sites in the system \item \sphinxstylestrong{Link Text:} Delete Site \item \sphinxstylestrong{Type:} view/HcsDeleteSiteVIEW \item \sphinxstylestrong{Display:} form \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_SITE_MANAGEMENT }}\end{verbatim} \item \sphinxstylestrong{Description:} Delete Sites in the system \item \sphinxstylestrong{Link Text:} Site Defaults \item \sphinxstylestrong{Type:} data/SiteDefaultsDoc \item \sphinxstylestrong{Display:} list \item \sphinxstylestrong{Field Display Policy:} default \item \sphinxstylestrong{Description:} View site default settings \item \sphinxstylestrong{Link Text:} Site Defaults Templates \item \sphinxstylestrong{Type:} data/SiteDefaultsDoc \item \sphinxstylestrong{Display:} list \item \sphinxstylestrong{Filter Options:} [{'filterValue': '_TEMPLATE', 'filter_by': 'name', 'operation': 'contains'}] \item \sphinxstylestrong{Field Display Policy:} default \item \sphinxstylestrong{Description:} Site defaults templates to drive the site specific site defaults creation \item \sphinxstylestrong{Link Text:} Run Hierarchy Model Reports \item \sphinxstylestrong{Type:} view/ModelReportVIEW \item \sphinxstylestrong{Display:} list \item \sphinxstylestrong{Link Text:} Hierarchy Model Report Results \item \sphinxstylestrong{Type:} data/ModelReport \item \sphinxstylestrong{Display:} list \end{itemize} \item \sphinxstylestrong{ Hierarchy Management } \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_INTERMEDIATENODE_HIERARCHY_TYPE }}\end{verbatim} \begin{itemize} \item \sphinxstylestrong{Link Text:} Site \item \sphinxstylestrong{Type:} relation/HcsSiteREL \item \sphinxstylestrong{Display:} list \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_SITE_MANAGEMENT }}\end{verbatim} \item \sphinxstylestrong{Description:} Manage Sites in the system \item \sphinxstylestrong{Link Text:} Delete Site \item \sphinxstylestrong{Type:} view/HcsDeleteSiteVIEW \item \sphinxstylestrong{Display:} form \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_SITE_MANAGEMENT }}\end{verbatim} \item \sphinxstylestrong{Description:} Delete Sites in the system \item \sphinxstylestrong{Link Text:} Site Defaults \item \sphinxstylestrong{Type:} data/SiteDefaultsDoc \item \sphinxstylestrong{Display:} list \item \sphinxstylestrong{Field Display Policy:} default \item \sphinxstylestrong{Description:} View site default settings \item \sphinxstylestrong{Link Text:} Site Defaults Templates \item \sphinxstylestrong{Type:} data/SiteDefaultsDoc \item \sphinxstylestrong{Display:} list \item \sphinxstylestrong{Filter Options:} [{'filterValue': '_TEMPLATE', 'filter_by': 'name', 'operation': 'contains'}] \item \sphinxstylestrong{Field Display Policy:} default \item \sphinxstylestrong{Description:} Site defaults templates to drive the site specific site defaults creation \end{itemize} \end{itemize} \sphinxstylestrong{Charts} \begin{itemize} \item \sphinxstylestrong{ Sites by Customer (Top 10) } \begin{itemize} \item \sphinxstylestrong{Description:} Number of Site for the top 10 customers \item \sphinxstylestrong{Type:} chart-pie \item \sphinxstylestrong{Resource:} Site \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_CUSTOMER_MANAGEMENT }}\end{verbatim} \end{itemize} \item \sphinxstylestrong{ End Users by Customer - Top 5 } \begin{itemize} \item \sphinxstylestrong{Description:} Number of Site for the top 10 customers \item \sphinxstylestrong{Type:} chart-column \item \sphinxstylestrong{Resource:} Multivendor Subscriber View \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_CUSTOMER_MANAGEMENT }}\end{verbatim} \end{itemize} \item \sphinxstylestrong{ Sites by Intermediate Node } \begin{itemize} \item \sphinxstylestrong{Description:} Number of Site by Intermediate Node \item \sphinxstylestrong{Type:} chart-pie \item \sphinxstylestrong{Resource:} Site \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_CUSTOMER_HIERARCHY_TYPE }}\end{verbatim} \end{itemize} \item \sphinxstylestrong{ End Users by Intermediate Node } \begin{itemize} \item \sphinxstylestrong{Description:} Number of End Users by Intermediate Node \item \sphinxstylestrong{Type:} chart-column \item \sphinxstylestrong{Resource:} Multivendor Subscriber View \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_CUSTOMER_HIERARCHY_TYPE }}\end{verbatim} \end{itemize} \item \sphinxstylestrong{ End Users by Site } \begin{itemize} \item \sphinxstylestrong{Description:} Number of End Users by Site \item \sphinxstylestrong{Type:} chart-column \item \sphinxstylestrong{Resource:} Multivendor Subscriber View \item \sphinxstylestrong{Condition:} \begin{verbatim}{{ macro.ALLOW_INTERMEDIATENODE_HIERARCHY_TYPE }}\end{verbatim} \end{itemize} \item \sphinxstylestrong{ Site Count Trend (Weekly) } \begin{itemize} \item \sphinxstylestrong{Description:} Trend on the number of sites in the system on a weekly basis \item \sphinxstylestrong{Type:} chart-line \item \sphinxstylestrong{Resource:} Site Trend Metrics \end{itemize} \end{itemize} .. raw:: html
| COUNTERS | |||
|---|---|---|---|
|
autorenew
Resellers
|
business
Customers
|
assessment
Intermediate Nodes
|
add_location
Sites
|
| Hierarchy Management | |||||||
|---|---|---|---|---|---|---|---|
| Link Text | Type | Display | Filter Options | Field Display Policy | Configuration Template | Condition | Description |
| Reseller | relation/HcsResellerREL | list | {{ macro.ALLOW_RESELLER_MANAGEMENT }} |
Manage Reseller nodes in the system | |||
| Delete Reseller | view/HcsDeleteResellerVIEW | form | {{ macro.ALLOW_RESELLER_MANAGEMENT }} |
Delete Reseller nodes in the system | |||
| Customer | relation/HcsCustomerREL | list | {{ macro.ALLOW_CUSTOMER_MANAGEMENT }} |
Manage Customer nodes in the system | |||
| Delete Customer | view/HcsDeleteCustomerVIEW | form | {{ macro.ALLOW_CUSTOMER_MANAGEMENT }} |
Delete Customer nodes in the system | |||
| Intermediate Node | relation/HcsHierarchyNodeREL | list | [{'filterValue': 'IntermediateNode', 'filter_by': 'node_type', 'operation': 'equals'}] | {{ macro.ALLOW_INTERMEDIATENODE_MANAGEMENT }} |
Manage Intermediate nodes in the system | ||
| Delete Intermediate Node | view/HcsDeleteIntermediateNodeVIEW | form | {{ macro.ALLOW_INTERMEDIATENODE_MANAGEMENT }} |
Delete Intermediate nodes in the system | |||
| Site | relation/HcsSiteREL | list | {{ macro.ALLOW_SITE_MANAGEMENT }} |
Manage Sites in the system | |||
| Delete Site | view/HcsDeleteSiteVIEW | form | {{ macro.ALLOW_SITE_MANAGEMENT }} |
Delete Sites in the system | |||
| Site Defaults | data/SiteDefaultsDoc | list | default | View site default settings | |||
| Site Defaults Templates | data/SiteDefaultsDoc | list | [{'filterValue': '_TEMPLATE', 'filter_by': 'name', 'operation': 'contains'}] | default | Site defaults templates to drive the site specific site defaults creation | ||
| Customer Build | relation/CustomerBuild_CustomerData_REL | list | {{ macro.ALLOW_CUSTOMER_MANAGEMENT }} |
Orchestrated feature to build customer and related configuration based on templates setup and selected | |||
| Run Hierarchy Model Reports | view/ModelReportVIEW | list | |||||
| Hierarchy Model Report Results | data/ModelReport | list | |||||
| Hierarchy Management | |||||||
|---|---|---|---|---|---|---|---|
| Link Text | Type | Display | Filter Options | Field Display Policy | Configuration Template | Condition | Description |
| Intermediate Node | relation/HcsHierarchyNodeREL | list | [{'filterValue': 'IntermediateNode', 'filter_by': 'node_type', 'operation': 'equals'}] | {{ macro.ALLOW_INTERMEDIATENODE_MANAGEMENT }} |
Manage Intermediate nodes in the system | ||
| Delete Intermediate Node | view/HcsDeleteIntermediateNodeVIEW | form | {{ macro.ALLOW_INTERMEDIATENODE_MANAGEMENT }} |
Delete Intermediate nodes in the system | |||
| Site | relation/HcsSiteREL | list | {{ macro.ALLOW_SITE_MANAGEMENT }} |
Manage Sites in the system | |||
| Delete Site | view/HcsDeleteSiteVIEW | form | {{ macro.ALLOW_SITE_MANAGEMENT }} |
Delete Sites in the system | |||
| Site Defaults | data/SiteDefaultsDoc | list | default | View site default settings | |||
| Site Defaults Templates | data/SiteDefaultsDoc | list | [{'filterValue': '_TEMPLATE', 'filter_by': 'name', 'operation': 'contains'}] | default | Site defaults templates to drive the site specific site defaults creation | ||
| Run Hierarchy Model Reports | view/ModelReportVIEW | list | |||||
| Hierarchy Model Report Results | data/ModelReport | list | |||||
| Hierarchy Management | |||||||
|---|---|---|---|---|---|---|---|
| Link Text | Type | Display | Filter Options | Field Display Policy | Configuration Template | Condition | Description |
| Site | relation/HcsSiteREL | list | {{ macro.ALLOW_SITE_MANAGEMENT }} |
Manage Sites in the system | |||
| Delete Site | view/HcsDeleteSiteVIEW | form | {{ macro.ALLOW_SITE_MANAGEMENT }} |
Delete Sites in the system | |||
| Site Defaults | data/SiteDefaultsDoc | list | default | View site default settings | |||
| Site Defaults Templates | data/SiteDefaultsDoc | list | [{'filterValue': '_TEMPLATE', 'filter_by': 'name', 'operation': 'contains'}] | default | Site defaults templates to drive the site specific site defaults creation | ||
| CHARTS | ||||
|---|---|---|---|---|
| Title | Type | Resource | Description | |
| Sites by Customer (Top 10) | chart-pie | Site | Number of Site for the top 10 customers | {{ macro.ALLOW_CUSTOMER_MANAGEMENT }} |
| End Users by Customer - Top 5 | chart-column | Multivendor Subscriber View | Number of Site for the top 10 customers | {{ macro.ALLOW_CUSTOMER_MANAGEMENT }} |
| Sites by Intermediate Node | chart-pie | Site | Number of Site by Intermediate Node | {{ macro.ALLOW_CUSTOMER_HIERARCHY_TYPE }} |
| End Users by Intermediate Node | chart-column | Multivendor Subscriber View | Number of End Users by Intermediate Node | {{ macro.ALLOW_CUSTOMER_HIERARCHY_TYPE }} |
| End Users by Site | chart-column | Multivendor Subscriber View | Number of End Users by Site | {{ macro.ALLOW_INTERMEDIATENODE_HIERARCHY_TYPE }} |
| Site Count Trend (Weekly) | chart-line | Site Trend Metrics | Trend on the number of sites in the system on a weekly basis | |