.. _automate-role-based-access:

Automate - Role Based Access
----------------------------





Management of admin users and related settings




.. raw:: latex


   \sphinxstylestrong{Counters}

   \begin{itemize}
   
    
    \item {\hyperref[\detokenize{src/user/role-based-access-admins:role-based-access-admins}]{\sphinxcrossref{\DUrole{std,std-ref}{Admins}}}}
    
    
    \item {\hyperref[\detokenize{src/user/role-management:role-management}]{\sphinxcrossref{\DUrole{std,std-ref}{Roles}}}}
       
   \end{itemize}


  


   \sphinxstylestrong{Links}

   \begin{itemize}
    
    \item \sphinxstylestrong{ Roles and Admins }
    
    \begin{itemize}
    
    \item \sphinxstylestrong{Link Text:} Admins
    \item \sphinxstylestrong{Type:} relation/User
    \item \sphinxstylestrong{Display:} list
    
    \item \sphinxstylestrong{Filter Options:} [{'filter_by': 'user_type', 'operation': 'equals', 'filterValue': 'Admin[OR]End User + Admin'}]
    
    
    \item \sphinxstylestrong{Field Display Policy:} AdminUser
    
    
    
    
    \item \sphinxstylestrong{Description:} List of users with an Admin role
    
    \item \sphinxstylestrong{Link Text:} Role Management
    \item \sphinxstylestrong{Type:} data/Role
    \item \sphinxstylestrong{Display:} list
    
    
    
    
    
    \item \sphinxstylestrong{Description:} Settings and Configuration of Roles
    
    \item \sphinxstylestrong{Link Text:} Authorized Admin Hierarchy Roles
    \item \sphinxstylestrong{Type:} data/AuthorizedAdminHierarchy
    \item \sphinxstylestrong{Display:} list
    
    
    
    
    
    \item \sphinxstylestrong{Description:} Manage the Authorized Admin Hierarchy Roles used for assigning admin privileges to end users
       
    \end{itemize}
    \item \sphinxstylestrong{ Role Configuration }
    
    \begin{itemize}
    
    \item \sphinxstylestrong{Link Text:} Dashboards
    \item \sphinxstylestrong{Type:} data/Dashboard
    \item \sphinxstylestrong{Display:} list
    
    
    
    
    
    \item \sphinxstylestrong{Description:} Manage and configure Dashboards
    
    \item \sphinxstylestrong{Link Text:} Dashboards Permission Groups
    \item \sphinxstylestrong{Type:} data/DashboardPermissionGroup
    \item \sphinxstylestrong{Display:} list
    
    
    
    
    
    \item \sphinxstylestrong{Link Text:} Menu Layouts
    \item \sphinxstylestrong{Type:} data/MenuLayout
    \item \sphinxstylestrong{Display:} list
    
    
    
    
    
    \item \sphinxstylestrong{Description:} Manipulate menus structure
    
    \item \sphinxstylestrong{Link Text:} Field Display Policies
    \item \sphinxstylestrong{Type:} data/FieldDisplayPolicy
    \item \sphinxstylestrong{Display:} list
    
    
    
    
    
    \item \sphinxstylestrong{Description:} Field level visibility and allowed actions per model
    
    \item \sphinxstylestrong{Link Text:} Themes
    \item \sphinxstylestrong{Type:} tool/Theme
    \item \sphinxstylestrong{Display:} list
    
    
    
    
    
    \item \sphinxstylestrong{Description:} Management of themes
    
    \item \sphinxstylestrong{Link Text:} Upload Theme
    \item \sphinxstylestrong{Type:} view/ThemeUpload
    \item \sphinxstylestrong{Display:} form
    
    
    
    
    
    \item \sphinxstylestrong{Description:} Upload a new theme zip file
    
    \item \sphinxstylestrong{Link Text:} Access Profiles
    \item \sphinxstylestrong{Type:} data/AccessProfile
    \item \sphinxstylestrong{Display:} list
    
    
    
    
    
    \item \sphinxstylestrong{Description:} Manage and configure access rights for models available in menus and dashboards
    
    \item \sphinxstylestrong{Link Text:} Menu Diff Tool
    \item \sphinxstylestrong{Type:} view/MenuDiff
    \item \sphinxstylestrong{Display:} form
    
    
    
    
    
    \item \sphinxstylestrong{Description:} Compare and update target menu with entries set up in source menu
    
    \item \sphinxstylestrong{Link Text:} Menu Merge Tool
    \item \sphinxstylestrong{Type:} view/MenuTool
    \item \sphinxstylestrong{Display:} form
    
    
    
    
    
    \item \sphinxstylestrong{Description:} Merge multiple menus into one
       
    \end{itemize}
    \item \sphinxstylestrong{ Privacy and Login Control }
    
    \begin{itemize}
    
    \item \sphinxstylestrong{Link Text:} Credential Policy
    \item \sphinxstylestrong{Type:} data/CredentialPolicy
    \item \sphinxstylestrong{Display:} list
    
    
    
    
    
    \item \sphinxstylestrong{Description:} Manage and control password and login rules
    
    \item \sphinxstylestrong{Link Text:} Hierarchy Default Credential Policy
    \item \sphinxstylestrong{Type:} data/HierarchyDefault
    \item \sphinxstylestrong{Display:} list
    
    
    
    
    
    \item \sphinxstylestrong{Description:} Setting of one policy as a default per hierarchy
    
    \item \sphinxstylestrong{Link Text:} Privacy Policy Configuration
    \item \sphinxstylestrong{Type:} data/PrivacyPolicy
    \item \sphinxstylestrong{Display:} list
    
    
    
    
    
    \item \sphinxstylestrong{Description:} Optional injected menu entry with privacy policy link. GDPR compliance  
    
    \item \sphinxstylestrong{Link Text:} Login Notification Banner
    \item \sphinxstylestrong{Type:} data/LoginBanner
    \item \sphinxstylestrong{Display:} list
    
    
    
    
    
    \item \sphinxstylestrong{Description:} Set up of a message user needs to aknowledge before finishing the login step. Can be configured per hierarchy
    
    \item \sphinxstylestrong{Link Text:} Configure SSO IDP
    \item \sphinxstylestrong{Type:} relation/HcsSsoIdpREL
    \item \sphinxstylestrong{Display:} list
    
    
    
    
    
    \item \sphinxstylestrong{Link Text:} Upload SSO IDP Metadata
    \item \sphinxstylestrong{Type:} data/File
    \item \sphinxstylestrong{Display:} list
    
    
    
    
       
    \end{itemize}
    \item \sphinxstylestrong{ Dashboard Configuration }
    
    \begin{itemize}
    
    \item \sphinxstylestrong{Link Text:} Color Mappings
    \item \sphinxstylestrong{Type:} data/DashboardColorMapping
    \item \sphinxstylestrong{Display:} list
    
    
    
    
    
    \item \sphinxstylestrong{Link Text:} Value Mappings
    \item \sphinxstylestrong{Type:} data/DashboardValueMapping
    \item \sphinxstylestrong{Display:} list
    
    
    
    
    
    \item \sphinxstylestrong{Link Text:} Field Groupings
    \item \sphinxstylestrong{Type:} data/DashboardFieldGrouping
    \item \sphinxstylestrong{Display:} list
    
    
    
    
    
    \item \sphinxstylestrong{Link Text:} Permission Groups
    \item \sphinxstylestrong{Type:} data/DashboardPermissionGroup
    \item \sphinxstylestrong{Display:} list
    
    
    
    
    
    \item \sphinxstylestrong{Link Text:} Dashboards
    \item \sphinxstylestrong{Type:} data/Dashboard
    \item \sphinxstylestrong{Display:} list
    
    
    
    
       
    \end{itemize}   
   \end{itemize}



   \sphinxstylestrong{Charts}
   \begin{itemize}
   
   
   \item \sphinxstylestrong{ Top 10 Active Admins (Number of Transactions) }
   \begin{itemize}
   \item \sphinxstylestrong{Description:} Shows the 10 most active admins
   \item \sphinxstylestrong{Type:} chart-pie 
    \item \sphinxstylestrong{Resource:} Transactions
    
    \end{itemize}
   
   \item \sphinxstylestrong{ Number of Admins by Customer }
   \begin{itemize}
   \item \sphinxstylestrong{Description:} 
   \item \sphinxstylestrong{Type:} chart-pie 
    \item \sphinxstylestrong{Resource:} User
    
    \end{itemize}  
 
   \end{itemize}






  


   

.. raw:: html


   <h3>Counters</h3>

   <table class="panel-table"><tbody>
     <tr>
     <th style="text-align:center">COUNTERS</th>
     </tr>
  
     <tr>
     
     
     <td>
     <p style="border-radius: 6px;background-color: #e1dbdb;">
     
     <i class="material-icons">person_pin_circle</i>
     
     
     
     <a href="../role-based-access-admins.html">Admins</a>
     
     
     
      <br>relation/User
      
      </p>
     </td>
     
     <td>
     <p style="border-radius: 6px;background-color: #e1dbdb;">
     
     <i class="material-icons">assignment_ind</i>
     
     
     
     <a href="../role-management.html">Roles</a>
     
     
     
      <br>data/Role
      
      </p>
     </td>   
     </tr>
   </tbody></table>

  
  



.. raw:: html

   
    <h3>Links</h3>

      
    <table class="panel-table"><tbody>
       <tr>
       <th colspan=8 style="text-align:center">Roles and Admins</th>
       </tr>
       <tr>
       <th>Link Text</th><th>Type</th><th>Display</th><th>Filter Options</th><th>Field Display Policy</th><th>Configuration Template</th><th>Condition</th><th>Description</th>
       </tr>
       
       <tr>
       <td>
       
       <a href="../role-based-access-admins.html">Admins</a>
       
       </td>
       <td>relation/User</td>
       <td>list</td>
       <td>[{'filter_by': 'user_type', 'operation': 'equals', 'filterValue': 'Admin[OR]End User + Admin'}]</td>
       <td>AdminUser</td>
       <td></td>
       <td></td>
       <td>List of users with an Admin role</td>
       </tr>
       <tr>
       <td>
       
       <a href="../role-management.html">Role Management</a>
       
       </td>
       <td>data/Role</td>
       <td>list</td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       <td>Settings and Configuration of Roles</td>
       </tr>
       <tr>
       <td>
       
       <a href="../concepts-authorized-admin-hierarchies.html">Authorized Admin Hierarchy Roles</a>
       
       </td>
       <td>data/AuthorizedAdminHierarchy</td>
       <td>list</td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       <td>Manage the Authorized Admin Hierarchy Roles used for assigning admin privileges to end users</td>
       </tr>   
    </tbody></table>
    <table class="panel-table"><tbody>
       <tr>
       <th colspan=8 style="text-align:center">Role Configuration</th>
       </tr>
       <tr>
       <th>Link Text</th><th>Type</th><th>Display</th><th>Filter Options</th><th>Field Display Policy</th><th>Configuration Template</th><th>Condition</th><th>Description</th>
       </tr>
       
       <tr>
       <td>
       
       Dashboards
       
       </td>
       <td>data/Dashboard</td>
       <td>list</td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       <td>Manage and configure Dashboards</td>
       </tr>
       <tr>
       <td>
       
       <a href="../concepts-access-profile-operations.html">Dashboards Permission Groups</a>
       
       </td>
       <td>data/DashboardPermissionGroup</td>
       <td>list</td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       </tr>
       <tr>
       <td>
       
       <a href="../concepts-menu-layout.html">Menu Layouts</a>
       
       </td>
       <td>data/MenuLayout</td>
       <td>list</td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       <td>Manipulate menus structure</td>
       </tr>
       <tr>
       <td>
       
       <a href="../field-display-policies.html">Field Display Policies</a>
       
       </td>
       <td>data/FieldDisplayPolicy</td>
       <td>list</td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       <td>Field level visibility and allowed actions per model</td>
       </tr>
       <tr>
       <td>
       
       <a href="../concepts-themes.html">Themes</a>
       
       </td>
       <td>tool/Theme</td>
       <td>list</td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       <td>Management of themes</td>
       </tr>
       <tr>
       <td>
       
       Upload Theme
       
       </td>
       <td>view/ThemeUpload</td>
       <td>form</td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       <td>Upload a new theme zip file</td>
       </tr>
       <tr>
       <td>
       
       <a href="../access-profiles.html">Access Profiles</a>
       
       </td>
       <td>data/AccessProfile</td>
       <td>list</td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       <td>Manage and configure access rights for models available in menus and dashboards</td>
       </tr>
       <tr>
       <td>
       
       Menu Diff Tool
       
       </td>
       <td>view/MenuDiff</td>
       <td>form</td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       <td>Compare and update target menu with entries set up in source menu</td>
       </tr>
       <tr>
       <td>
       
       Menu Merge Tool
       
       </td>
       <td>view/MenuTool</td>
       <td>form</td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       <td>Merge multiple menus into one</td>
       </tr>   
    </tbody></table>
    <table class="panel-table"><tbody>
       <tr>
       <th colspan=8 style="text-align:center">Privacy and Login Control</th>
       </tr>
       <tr>
       <th>Link Text</th><th>Type</th><th>Display</th><th>Filter Options</th><th>Field Display Policy</th><th>Configuration Template</th><th>Condition</th><th>Description</th>
       </tr>
       
       <tr>
       <td>
       
       <a href="../credential-policies.html">Credential Policy</a>
       
       </td>
       <td>data/CredentialPolicy</td>
       <td>list</td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       <td>Manage and control password and login rules</td>
       </tr>
       <tr>
       <td>
       
       <a href="../credential-policies.html">Hierarchy Default Credential Policy</a>
       
       </td>
       <td>data/HierarchyDefault</td>
       <td>list</td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       <td>Setting of one policy as a default per hierarchy</td>
       </tr>
       <tr>
       <td>
       
       Privacy Policy Configuration
       
       </td>
       <td>data/PrivacyPolicy</td>
       <td>list</td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       <td>Optional injected menu entry with privacy policy link. GDPR compliance  </td>
       </tr>
       <tr>
       <td>
       
       <a href="../concepts-login-banner.html">Login Notification Banner</a>
       
       </td>
       <td>data/LoginBanner</td>
       <td>list</td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       <td>Set up of a message user needs to aknowledge before finishing the login step. Can be configured per hierarchy</td>
       </tr>
       <tr>
       <td>
       
       <a href="../configure-sso-idp.html">Configure SSO IDP</a>
       
       </td>
       <td>relation/HcsSsoIdpREL</td>
       <td>list</td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       </tr>
       <tr>
       <td>
       
       <a href="../file-management.html">Upload SSO IDP Metadata</a>
       
       </td>
       <td>data/File</td>
       <td>list</td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       </tr>   
    </tbody></table>
    <table class="panel-table"><tbody>
       <tr>
       <th colspan=8 style="text-align:center">Dashboard Configuration</th>
       </tr>
       <tr>
       <th>Link Text</th><th>Type</th><th>Display</th><th>Filter Options</th><th>Field Display Policy</th><th>Configuration Template</th><th>Condition</th><th>Description</th>
       </tr>
       
       <tr>
       <td>
       
       <a href="../automate-dashboards-managing.html">Color Mappings</a>
       
       </td>
       <td>data/DashboardColorMapping</td>
       <td>list</td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       </tr>
       <tr>
       <td>
       
       <a href="../automate-dashboards-managing.html">Value Mappings</a>
       
       </td>
       <td>data/DashboardValueMapping</td>
       <td>list</td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       </tr>
       <tr>
       <td>
       
       <a href="../automate-dashboards-managing.html">Field Groupings</a>
       
       </td>
       <td>data/DashboardFieldGrouping</td>
       <td>list</td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       </tr>
       <tr>
       <td>
       
       <a href="../concepts-access-profile-operations.html">Permission Groups</a>
       
       </td>
       <td>data/DashboardPermissionGroup</td>
       <td>list</td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       </tr>
       <tr>
       <td>
       
       Dashboards
       
       </td>
       <td>data/Dashboard</td>
       <td>list</td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       <td></td>
       </tr>   
    </tbody></table>   

  



.. raw:: html


   <h3>Charts</h3>

   <table class="panel-table">
     <thead>
     <tr>
     <th colspan=4  style="text-align:center">CHARTS</th>
     </tr>
     <tr>
     <th>Title</th><th>Type</th><th>Resource</th><th>Description</th>
     </tr>
     </thead>
     <tbody>
     <tr>
     
     
     <tr> 
          <td>Top 10 Active Admins (Number of Transactions)</td>
          <td>chart-pie</td>
	  
	  
	  <td><a href="../concepts-transaction-logging-audit.html">Transactions</a></td>
	  
	  
           <td>Shows the 10 most active admins</td>
      
     </tr>
     
     <tr> 
          <td>Number of Admins by Customer</td>
          <td>chart-pie</td>
	  
	  
	  <td><a href="../user-management-overview.html">User</a></td>
	  
	  
           <td></td>
      
     </tr>   
   </tbody></table>