h6. Contents
This page reviews the various tools used to assist administrators in understand system authentication levels for system access, managing system users, portal pages, and GroundWork Monitor components.
{toc:minLevel=4|maxLevel=4|printable=false}
h4. 1.0 About Group, Site Editor, and GroundWork Administration
Group, Site Editor, and GroundWork Administration make up the various areas the GroundWork Monitor portal is administered. The *Group* option is used to manage the organization including user accounts, groups, memberships (roles) and also to manage portal permissions, *Site Editor* is where portal pages are managed, and *GroundWork Administration* is where administrators can manage GroundWork Monitor components such as the Foundation database, Custom Groups, and GroundWork CloudHub. It's important to note that Group options are available to only *GWRoot* and *GWAdmin* memberships, Site Editor options to only *GWRoot*, and GroundWork Administration options to *GWRoot* and *GWAdmin* (with the exception that Foundation that is only accessible to *GWAdmin*).
\\
\\
Figure: Group, Site Editor, and GroundWork Administration
!about_administration_1.jpg|border=1!
h4. 2.0 System Authentication Levels
The default portal installation defines system users, groups, and memberships which are outlined in the following table. User is the name used to log into the system. Group is the group name that a user name is associated with, and Membership is the role that is defined for the group. Each membership (or role) indicates the system access and privileges. You can control which host groups and service groups are visible to specific roles and their membership. These membership / user restrictions extend within the Status, Event Console, Dashboards (including Dashboard), and the Advanced Reports applications. Administrators can set restrictions for dashboard links to the Status application. All other roles that are created by an administrator will be assigned permissions that match the *GWUser* membership.
Memberships (roles) determine system privileges such as Portal Page access (e.g. GroundWork Administration, Event Console, Reports) and command execution permissions. A membership is used to grant different permission levels to different portlets, pages, or portal instances. Additionally, with membership management you can control which host groups and service groups are visible to specific memberships and their users. These member/user restrictions extend within the Status, Event Console, Dashboards (including My GroundWork), and the Advanced Reports applications. Administrators can also set restrictions for dashboard links to the Status application.
\\
\\
Figure: System Authentication Levels
!about_administration_2.jpg!
h4. 3.0 Managing Users and Permissions using Group
The *Group* link located in the top toolbar has two sub pages, _Organization_ and _Portal Administration_. The _Organization_ option is accessible to the memberships *GWAdmin* and *GWRoot*. The Portal Administration option is accessible to the membership *GWroot*.
h5. 3.1 Organization
This option allows administrators to register new GroundWork Monitor portal user accounts, and manage users (e.g. admin, user), groups (e.g. GroundWork Administrators, Users), and memberships (e.g. GWAdmin, GWUser).
The default system users _root_ and _admin_ have access to register new GroundWork Monitor portal user accounts.
Users are associated with groups and memberships (roles) which determine system access privileges. GroundWork Monitor does not prevent multiple users from simultaneously modifying the same data element such as Configuration, Reports, Hosts, Host Groups, and Services.
h5. 3.2 Portal Administration
This option enables an administrator to manage the Application Registry where you can set access permissions for categories and portlets, Page Management for adding and editing pages, Site Export/Import, and Services Management.
For Portal Administration reference see [JBoss Portal Platform 6.1 Administration and Configuration Guide|https://access.redhat.com/site/documentation/en-US/JBoss_Portal_Platform/6.1/html/Administration_and_Configuration_Guide/].
h4. 4.0 Managing Portal Pages and Layout using Site and Group Editor
The *Site Editor* link located in the top toolbar has three sub pages, _Add New Page, Edit Page,_ and _Edit Layout._ The Site Editor is accessible to the membership *GWRoot*.
This navigation appears as either *Site Editor* or *Group Editor* depending on the administrator's location within the portal. When in areas of the portal displaying content, the navigation shows as Site Editor and in areas of the portal pertaining to users, the navigation shows as Group Editor. This navigation contains links to add a new pages to the portal, to edit a page or to change the portal's layout.
For Portal Administration reference see [JBoss Portal Platform 6.1 Administration and Configuration Guide|https://access.redhat.com/site/documentation/en-US/JBoss_Portal_Platform/6.1/html/Administration_and_Configuration_Guide/].
h4. 5.0 Managing GroundWork Components using GroundWork Administration
The *GroundWork Administration* option located on the main toolbar offers administration for Foundation, CustomGroups, CloudHub, and GroundWork License. The GroundWork Administration options are accessible to the membership *GWRoot* and *GWAdmin* (with the exception that Foundation that is only accessible to *GWAdmin*).
h5. 5.1 Foundation
GroundWork Foundation is a data integration framework. The back end data model allows the integration of any state, event, and performance data, independent of the monitoring application that produces it. The datastore can be accessed through a Web Service interface. Only an administrator login can administer Foundation. The administration options include;
* Manage Configuration - View or edit Foundation configuration files.
* Manage Applications Types - Add a new application type to the Foundation data model.
* Manage Properties - Add properties to the Foundation data model or assign existing properties to an application type/entity type.
* Manage Host Groups - Add new host groups to the Foundation data model.
* Manage Performance Data - Update performance data entries to the performance data label table.
* Manage Consolidation Criteria - Update consolidation criteria entries to the consolidation criteria table.
h5. 5.2 Custom Groups
A Custom Group is a collection of host group or service group objects at the user interface level. You can see that the current monitor status gets bubbled-up to the top from the host groups and service groups. Custom Groups allow for more freedom to group business functions, locations, or infrastructure setup (e.g. workstations, servers, services) and make them more user accessible. This is very useful if you have a certain batch of servers attached to an array of servers. And, custom group are more useful from the system manager perspective too, as the administrator does not have to worry about the problem on the segment he doesn't administer. A host group or service group can be a member of multiple custom groups.
Custom groups are managed, through an administrator (GWAdmin), using the GroundWork Administration page. These groups are integrated into the Status and Event Console applications and are available to all users independent of their role membership. View restrictions by membership for host and service groups will be honored by the custom groups. If a custom group includes only host groups that are not visible through a user then the custom group won't be displayed in Status. When creating custom groups you should always use the bottom up approach as shown in the figure below.
\\
\\
Figure: Custom Groups Bottom Up Approach and Custom Group View in Status
!about_administration_3.jpg!
h5. 5.3 GroundWork CloudHub
Administration for the GroundWork CloudHub, a data collector agent specialized in gathering metrics from a variety of virtual environments and integrating them seamlessly into the GroundWork Monitor Enterprise system. See [GroundWork CloudHub|GROUNDWORK CLOUD HUB] for detailed information.
h5. 5.4 GroundWork License Key
The location for entry of the GroundWork Monitor license key is through *GroundWork Administration* > *GroundWork License*. Each installation of GroundWork Monitor Enterprise Edition (GWMEE) requires a license key. For new installations, a license key is emailed to you following purchase and for existing installations, you will need to input a new license key if your existing key has reached the subscription expiration date or you have exceeded the number of devices purchased. Please contact {html}<a href="mailto:support@gwos.com">support@gwos.com</a>{html} for assistance.
\\
\\
Figure: GroundWork License Key
!about_administration_4.jpg|border=1!
This page reviews the various tools used to assist administrators in understand system authentication levels for system access, managing system users, portal pages, and GroundWork Monitor components.
{toc:minLevel=4|maxLevel=4|printable=false}
h4. 1.0 About Group, Site Editor, and GroundWork Administration
Group, Site Editor, and GroundWork Administration make up the various areas the GroundWork Monitor portal is administered. The *Group* option is used to manage the organization including user accounts, groups, memberships (roles) and also to manage portal permissions, *Site Editor* is where portal pages are managed, and *GroundWork Administration* is where administrators can manage GroundWork Monitor components such as the Foundation database, Custom Groups, and GroundWork CloudHub. It's important to note that Group options are available to only *GWRoot* and *GWAdmin* memberships, Site Editor options to only *GWRoot*, and GroundWork Administration options to *GWRoot* and *GWAdmin* (with the exception that Foundation that is only accessible to *GWAdmin*).
\\
\\
Figure: Group, Site Editor, and GroundWork Administration
!about_administration_1.jpg|border=1!
h4. 2.0 System Authentication Levels
The default portal installation defines system users, groups, and memberships which are outlined in the following table. User is the name used to log into the system. Group is the group name that a user name is associated with, and Membership is the role that is defined for the group. Each membership (or role) indicates the system access and privileges. You can control which host groups and service groups are visible to specific roles and their membership. These membership / user restrictions extend within the Status, Event Console, Dashboards (including Dashboard), and the Advanced Reports applications. Administrators can set restrictions for dashboard links to the Status application. All other roles that are created by an administrator will be assigned permissions that match the *GWUser* membership.
Memberships (roles) determine system privileges such as Portal Page access (e.g. GroundWork Administration, Event Console, Reports) and command execution permissions. A membership is used to grant different permission levels to different portlets, pages, or portal instances. Additionally, with membership management you can control which host groups and service groups are visible to specific memberships and their users. These member/user restrictions extend within the Status, Event Console, Dashboards (including My GroundWork), and the Advanced Reports applications. Administrators can also set restrictions for dashboard links to the Status application.
\\
\\
Figure: System Authentication Levels
!about_administration_2.jpg!
h4. 3.0 Managing Users and Permissions using Group
The *Group* link located in the top toolbar has two sub pages, _Organization_ and _Portal Administration_. The _Organization_ option is accessible to the memberships *GWAdmin* and *GWRoot*. The Portal Administration option is accessible to the membership *GWroot*.
h5. 3.1 Organization
This option allows administrators to register new GroundWork Monitor portal user accounts, and manage users (e.g. admin, user), groups (e.g. GroundWork Administrators, Users), and memberships (e.g. GWAdmin, GWUser).
The default system users _root_ and _admin_ have access to register new GroundWork Monitor portal user accounts.
Users are associated with groups and memberships (roles) which determine system access privileges. GroundWork Monitor does not prevent multiple users from simultaneously modifying the same data element such as Configuration, Reports, Hosts, Host Groups, and Services.
h5. 3.2 Portal Administration
This option enables an administrator to manage the Application Registry where you can set access permissions for categories and portlets, Page Management for adding and editing pages, Site Export/Import, and Services Management.
For Portal Administration reference see [JBoss Portal Platform 6.1 Administration and Configuration Guide|https://access.redhat.com/site/documentation/en-US/JBoss_Portal_Platform/6.1/html/Administration_and_Configuration_Guide/].
h4. 4.0 Managing Portal Pages and Layout using Site and Group Editor
The *Site Editor* link located in the top toolbar has three sub pages, _Add New Page, Edit Page,_ and _Edit Layout._ The Site Editor is accessible to the membership *GWRoot*.
This navigation appears as either *Site Editor* or *Group Editor* depending on the administrator's location within the portal. When in areas of the portal displaying content, the navigation shows as Site Editor and in areas of the portal pertaining to users, the navigation shows as Group Editor. This navigation contains links to add a new pages to the portal, to edit a page or to change the portal's layout.
For Portal Administration reference see [JBoss Portal Platform 6.1 Administration and Configuration Guide|https://access.redhat.com/site/documentation/en-US/JBoss_Portal_Platform/6.1/html/Administration_and_Configuration_Guide/].
h4. 5.0 Managing GroundWork Components using GroundWork Administration
The *GroundWork Administration* option located on the main toolbar offers administration for Foundation, CustomGroups, CloudHub, and GroundWork License. The GroundWork Administration options are accessible to the membership *GWRoot* and *GWAdmin* (with the exception that Foundation that is only accessible to *GWAdmin*).
h5. 5.1 Foundation
GroundWork Foundation is a data integration framework. The back end data model allows the integration of any state, event, and performance data, independent of the monitoring application that produces it. The datastore can be accessed through a Web Service interface. Only an administrator login can administer Foundation. The administration options include;
* Manage Configuration - View or edit Foundation configuration files.
* Manage Applications Types - Add a new application type to the Foundation data model.
* Manage Properties - Add properties to the Foundation data model or assign existing properties to an application type/entity type.
* Manage Host Groups - Add new host groups to the Foundation data model.
* Manage Performance Data - Update performance data entries to the performance data label table.
* Manage Consolidation Criteria - Update consolidation criteria entries to the consolidation criteria table.
h5. 5.2 Custom Groups
A Custom Group is a collection of host group or service group objects at the user interface level. You can see that the current monitor status gets bubbled-up to the top from the host groups and service groups. Custom Groups allow for more freedom to group business functions, locations, or infrastructure setup (e.g. workstations, servers, services) and make them more user accessible. This is very useful if you have a certain batch of servers attached to an array of servers. And, custom group are more useful from the system manager perspective too, as the administrator does not have to worry about the problem on the segment he doesn't administer. A host group or service group can be a member of multiple custom groups.
Custom groups are managed, through an administrator (GWAdmin), using the GroundWork Administration page. These groups are integrated into the Status and Event Console applications and are available to all users independent of their role membership. View restrictions by membership for host and service groups will be honored by the custom groups. If a custom group includes only host groups that are not visible through a user then the custom group won't be displayed in Status. When creating custom groups you should always use the bottom up approach as shown in the figure below.
\\
\\
Figure: Custom Groups Bottom Up Approach and Custom Group View in Status
!about_administration_3.jpg!
h5. 5.3 GroundWork CloudHub
Administration for the GroundWork CloudHub, a data collector agent specialized in gathering metrics from a variety of virtual environments and integrating them seamlessly into the GroundWork Monitor Enterprise system. See [GroundWork CloudHub|GROUNDWORK CLOUD HUB] for detailed information.
h5. 5.4 GroundWork License Key
The location for entry of the GroundWork Monitor license key is through *GroundWork Administration* > *GroundWork License*. Each installation of GroundWork Monitor Enterprise Edition (GWMEE) requires a license key. For new installations, a license key is emailed to you following purchase and for existing installations, you will need to input a new license key if your existing key has reached the subscription expiration date or you have exceeded the number of devices purchased. Please contact {html}<a href="mailto:support@gwos.com">support@gwos.com</a>{html} for assistance.
\\
\\
Figure: GroundWork License Key
!about_administration_4.jpg|border=1!