====== Hub Admin ======

  * [[#introduction|Introduction]]
  *  [[#applications|Applications]]
      *  [[#about_module|About module]]
        * [[#application_groups|Application groups]]
        * [[#roles|Roles]]
        * [[#example|Example]]
      *  [[#user_guide|User guide]]
        *  [[#application_groups1|Application groups]]
          * [[#create_application_group|Create application group]]
          * [[#edit_application_group|Edit application group]]
          * [[#delete_application_group|Delete application group]]
        *  [[#applications1|Applications]]
          * [[#create_application|Create application]]
          * [[#edit_application|Edit application]]
          * [[#add_application_to_application_group|Add application to application group]]
          * [[#remove_application_from_application_group|Remove application from application group]]
          * [[#delete_application|Delete application]]
          * [[#setting_up_roles_to_use_in_idstoryhub|Setting up roles to use in IdStoryHub]]
            * [[#creating_role_in_idm|Creating role in IdM]]
            * [[#setting_up_role_in_idstoryhub|Setting up role in IdStoryHub]]
  *  [[#settings|Settings]]
      * [[#about_module1|About module]]
      *  [[#user_guide1|User guide]]
        *  [[#theme|Theme]]
          * [[#update_logo|Update logo]]
          * [[#update_palette|Update palette]]
        *  [[#language|Language]]
          * [[#change_default_language|Change default language]]

====== Introduction ======

Hub Admin is an application for managing the Hub. Here, you can adjust the Hub's appearance, default language, applications for the app launcher, their current state, which IdM roles are allowed to see them, and group applications into application groups.

Hub Admin is organized into modules. Each module is accessible by its item in main menu. There are two modules now, Applications and Settings.

**:!: In the case the UI doesn't look as expected after performing some action or you cannot find something described in this guide, please try to reload the app (F5). :!: **

====== Applications ======

===== About module =====

Applications for the app launcher can be managed in the module "Applications" accessible via main menu item "Applications":

{{.:hub_admin:menu_applications.png?nolink&200x157}}

This module serves to organize applications in app launcher and to manage their access rights. To achieve these goals, there are two entities: application groups and roles.

==== Application groups ====

Application groups are a way to display related applications together (e.g. office apps, accounting apps, IT development apps). They don't define who can see them, so by creating for instance a "management apps" group you just create a list of management related apps but it doesn't mean only managers will see them. Which user can see each application is defined by **roles**.

Application group is displayed to a Hub user in case there is at least one application in it, that the user has access to.

Application groups are ordered by name, applications within application group are ordered by priority and then by name.

==== Roles ====

Every application has one or more IdM roles which allow user to see it in the app launcher. In case there are more roles defined, user with any of these roles can see the application in any application group the application belongs to and in the "All apps" "group" too.

There is a default role ''user''  which every Hub user has, so an application with the role ''user''  is visible to everyone.

==== Example ====

Let's create an application group called "Office apps". It will have the applications Excel, Outlook, PowerPoint and Word accessible with the role ''user''  and Visio accessible with the role ''manager''.

Hub user with ''manager''  role will see all the apps, because he has the ''manager''  role set explicitly and also has the ''user''  role which every Hub user has by default:

{{.:hub_admin:office_apps_manager.png?nolink&734x174}}

Hub user without the ''manager''  role will see just applications with the role ''user'':

{{.:hub_admin:office_apps_user.png?nolink&582x171}}

===== User guide =====

==== Application groups ====

An application group allows you to group related applications. It has only one attribute - name, which is required.

=== Create application group ===

To create a new application group, click the button "App group" located in the top right corner of the Applications module page:

{{.:hub_admin:app_group_button.png?nolink&134x51}}

Dialog appears where you define app group name:

{{.:hub_admin:app_group_create.png?nolink&600x202}}

After filling the required app group name, the Create button activates and by clicking on it, you confirm app group creation.

=== Edit application group ===

To get the "update app group dialog", click on the Edit link next to the application group name:

{{.:hub_admin:app_group_edit_button.png?nolink&295x37}}

Update app group name and confirm the change by clicking the Update button (the dialog will be closed automatically):

{{.:hub_admin:app_group_edit_dialog.png?nolink&791x216}}

=== Delete application group ===

To completely remove an application group, click on the Delete link next to the application group name. \\ **{{.:hub_admin:app_group_delete.png?nolink&276x41}}**

Confirm the removal by "Delete the application group" button.

{{.:hub_admin:app_group_delete_modal_confirm.png?nolink&350x144}}

You can cancel the removal by Cancel button, X button or clicking anywhere outside the dialog.

{{.:hub_admin:app_group_delete_modal_cancel.png?nolink&350x144}}

App group is removed without its apps, these can be still found in "All apps" "group".

==== Applications ====

For an application you can define several attributes:

^Attribute^Description^Required|
|Allowed roles|IdM roles allowed to see the application in app launcher, default value user means everybody can see the app|Yes|
|Description|Short application description|No|
|Fallback URL|Application URL in case of shutdown state|No|
|Logo|Application logo displayed on the app card in app launcher. The default is the IdStory logo, which is used if no user-defined logo is provided.|No|
|Name|Application name displayed on the app card in app launcher|Yes|
|Priority|Application priority, apps within app group are sorted by priority (apps with higher priority are displayed before apps with lower priority) and then by name|Yes|
|State|Application state, possible values in the table below|Yes|
|URL|Application URL in case of active state|Yes|

Application states:

^State^Meaning|
|Active|App is displayed in app launcher and clicking it redirects to app URL|
|Hidden|App is not displayed in app launcher, it's visible only in administration|
|Inactive|App is displayed in app launcher but is not clickable|
|Shutdown|App is displayed in app launcher and clicking on it redirects to the app Fallback URL|

=== Create application ===

To create a new application, click the App button located in the top right corner of the Applications module page:

{{:devel:documentation:hub:admin:app_button.png?nolink&89x50}}

A dialog appears where you can fill in the app attributes and confirm it by clicking on the Create button:

{{.:hub_admin:app_create.png?nolink&600x368}}

The logo can be drag&dropped into the logo placeholder area or chosen from disk after clicking in that area.

=== Edit application ===

To get the "update app dialog", click on the detail icon on the app card:

{{.:hub_admin:app_detail.png?nolink&150x155}}

or select the Details menu item in the app card action menu:

{{.:hub_admin:app_menu_detail.png?nolink&180x335}}

Update app attributes as needed, confirm changes by clicking the Update button and close the dialog by using the X button (or you can just click anywhere outside the dialog).

{{.:hub_admin:app_edit.png?nolink&600x369}}

=== Add an application to a group ===

To add an application to a group, click on the desired group in the "Add to group" section of the app card action menu:

{{.:hub_admin:app_add_to_group.png?nolink&180x335}}

=== Remove an application from a group ===

To remove an application from a group, click on the desired group in the "Remove from group" section of the app card action menu:

{{.:hub_admin:app_remove_from_group.png?nolink&180x364}}

=== Delete an application ===

To completely remove an application, click on the Delete app item in the app card action menu.

{{.:hub_admin:app_delete.png?nolink&180x335}}

Confirm the removal by "Delete the application" button.

{{.:hub_admin:app_delete_modal_confirm.png?nolink&350x144}}

You can cancel the removal by Cancel button, X button or clicking anywhere outside the dialog.

{{.:hub_admin:app_delete_modal_cancel.png?nolink&350x144}}

=== Setting up roles to use in IdStoryHub ===

IdStory HUB uses roles In order to limit access to certain appliactions to specific user groups. This guide walks you through the process of such configuration.

== Creating role in IdM ==

First, you need to create role, that would be assigned to all users, who should have access to a given app in HUB. Lets say, we want to limit access to Google drive application.

  - Create a role
      - Go to IdStory IdM and log in as user, who can create and assign roles
      - Go to “Roles” \\ {{:hub:roles_menu.png?200|}}
      - Click to “ADD” \\ {{:hub:add_button.png?200|}}
      - Fill out “Code” and “Name” attributes and click “SAVE AND CONTINUE” \\ {{:hub:idm_role_form.png?600|}}
  - Make newly created role provision data to LDAP
      - On a detail of our newly created role, click on “Systems” \\ {{:hub:idm_systems.png?200|}}
      - Click “ADD” \\ {{:hub:add_button.png?200|}}
      - Fill the displayed form according to picture bellow and click “SAVE” \\ {{:hub:idm_sysform.png?600|}}
      - Now the empty table with mapped attributes is displayed. Click “ADD” \\ {{:hub:idm_attrs.png?600|}}
      - Now set mapping for iamUserRole attribute according to image bellow \\ {{:hub:idm_attr.png?600|}}
      - Click “SAVE”
  - Assign role to users
      - Now you need to assign role to users, who should be able to see Google drive app in IdStory HUB
      - There are many ways to do so. You can read about it here: [[https://wiki.czechidm.com/devel/documentation/roles#automatically_assigned_roles_by_organization_structure|https://wiki.czechidm.com/devel/documentation/roles#automatically_assigned_roles_by_organization_structure]]


== Setting up role in IdStoryHub ==
  - Log in to admin interface of IdStory HUB
      - Go to URL/hub/admin and log in
  - Add / Google Drive application
      - Click “+ App” or “…” and then “Details” \\ {{:hub:hub_add_app.png?600|}}
      - Type “gdrive” into “Allowed roles” field \\ {{:hub:hub_drive1.png?600|}}
      - Click “+ gdrive” \\ {{:hub:hub_drive2.png?600|}}
      - Click “Create” or “Update”

From now on, the Google Drive app will be shown only to admin and users with “gdrive” role

======  ======

====== Settings ======

===== About module =====

In this module you can adjust the Hub appearance.

{{.:hub_admin:menu_settings.png?nolink&200x212}}

===== User guide =====

==== Theme ====

In this section you can change the Hub logo and color palette.

{{.:hub_admin:menu_settings_theme.png?nolink&200x212}}

=== Update logo ===

Drag the new logo onto the logo image area or click on that area to select a logo from your HDD. Then confirm the change by clicking on the "Save logo" button:

{{.:hub_admin:logo_update.png?nolink&300x235}}

If you upload a wrong image and want to take this action back, you can do it by clicking on the "Cancel" button (it is possible only before the logo change is confirmed):

{{.:hub_admin:logo_update_cancel.png?nolink&300x238}}

=== Update palette ===

Here you can customize the color palette used in the Hub. The easiest way to do it to select the base color and confirm your choice by "Save palette" button, colors used in application will be derived from the base color:

{{.:hub_admin:palette_update.png?nolink&248x243}}

You can adjust the palette by setting the base color index under Advanced settings. Slider start "Auto" means the position of the base color will be set automatically based on its lightness, other positions define its position explicitly so the palette will be overall lighter/darker:

{{.:hub_admin:palette_update_advanced.png?nolink&378x301}}

You can cancel any change by clicking the "Cancel" button (it is possible only before the palette change is confirmed):

{{.:hub_admin:palette_update_cancel.png?nolink&378x301}}

===== Language =====

In this section you can change the default language.

{{.:hub_admin:menu_settings_language.png?nolink&200x226}}

=== Change default language ===

There are two options for user default language. The first and default one is to detect it from browser settings (with a fallback to english in case the detected language isn't supported by the Hub). The second one is to force it by explicitly selecting it here. You can find both options in the Default language select list:

{{.:hub_admin:default_language_select_list.png?nolink&200x288}}

You can confirm your selection by clicking the Save default language button:

{{.:hub_admin:save_default_language.png?nolink&200x149}}

This is the way to set the default language for all users. Every user can override this setting by selecting another supported language from the select list located in the bottom left corner:

{{.:hub_admin:language_selector.png?nolink&120x127}}