Difference between revisions of "Migrating to the Employee Portal"

From Hornbill
Jump to navigation Jump to search
(Created page with "{{bluebanner|Home > Administration > System > Manage Portals > Manage Employee Portal|Index }} {|s...")
 
 
(136 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{bluebanner|[[Main Page|Home]] > [[Administration]] > [[System Administration|System]] > [[Manage Portals]] > Manage Employee Portal|[[:Category:Administration|Index]] }}
+
This document can now be found at its new location in the [https://docs.hornbill.com/esp-config/customize/employee-portal/employee-portal-configuration Hornbill Document Library].
{|style="width: 100%"
 
|- valign="top"
 
|style="width:73%"|
 
  
==Introduction==
+
[[file:hornbill-document-library.png|Employee Portal|link=https://docs.hornbill.com/esp-config/customize/employee-portal/employee-portal-configuration]]
The ''Manage Employee Portal'' option within Hornbill Administration is the starting point to enable and provide the base settings for your Employee Portal.
+
<!--
|style="width:5%"|
+
 
 +
{{Breadcrumb|[[Main Page|Home]] > [[Applications]] > [[Collaboration]] > [[Employee Portal]] > Migrating to the Employee Portal |Collaboration}}
 +
{{Section|
 +
If you are currently using the '''Service Portal''' or the '''My Services''' Portal, and looking to migrate to the '''Employee Portal''' please follow the steps detailed here.
 +
===Migration Steps at a Glance ===
 +
{{#ev:youtube|_kp-F2VLPpA|500|right}}
 +
These are the main steps that you will be taking to migrate to the Employee Portal
 +
:* [[#Step 1 - Enable the Employee Portal|Step 1 - Enable the Employee Portal]]
 +
:* [[#Step 2 - Configure The Employee Portal|Step 2 - Configure The Employee Portal]]
 +
:* [[#Step 3 - Add Widgets to the Home Page|Step 3 - Add Widgets to the Home Page]]
 +
:* [[#Step 4 - Configure Service Domains|Step 4 - Configure Service Domains]]
 +
:* [[#Step 5 - Enable Domain Pages|Step 5 - Enable Domain Pages]]
 +
:* [[#Step 6 - Map Service Manager Services|Step 6 - Map Service Manager Services]]
 +
:* [[#Step 7 - Customize|Step 7 - Customize]]
 +
:* [[#Step 8  - Switch|Step 8  - Switch]]|
 +
{{RightBox|Related Articles|
 +
* [[Employee Portal]]
 +
* [[Employee Portal Page Configuration]]
 +
* [[Service Domains Administration]]
 +
* [[Roles]]}}
 +
}}
 +
{{section|
 +
==Step 1 - Enable the Employee Portal==
 +
The Employee Portal is ''Off'' by default.  The first step to getting your Employee Portal ready is to give access to those that will be helping to create and test the new Employee Portal and turning it on.  In the admin console, under ''System > Customize > Employee Portal'', select the ''Settings'' tab.
 +
[[file:EPSettingsTab.png|500px|right|link=https://wiki.hornbill.com/images/e/e2/EPSettingsTab.png]]
 +
{{bullet1|Users to preview the Employee Portal|This is an important 1st step to setting up your Employee Portal. This setting allows you to add a list of users you want to have access to the Employee Portal. This gives you the opportunity to have one or more people to test and feedback on the Employee Portal design, before you open it up to all users. Changing this setting will also be one of your last steps. Once you have completed your configuration and you are ready to make it available to all users, simply remove these names. Once the list of names is empty, it becomes available to everyone.}}
 +
{{bullet1|Enable Employee Portal|If you are ready to configure the employee portal, enable this setting, and the users defined above will now have a '''Company Home''' menu option visible to them under the '''Home''' Tile in the navigation menu in the live.hornbill.com/yourcompany domain}}
 +
 
 +
'''Roles'''
 +
{{bullet1|Collaboration|Any user who will need to manage pages on the Employee Portal will need this role (This role alone will not allow them to configure the Home Page or Domain Pages)}}
 +
{{bullet1|Home Page Manager|Any user who needs to manage the landing page on the Employee Portal will need this role}}
 +
{{TOP}}
 
|
 
|
|style="width:22%; border-style: solid; border-width: 1px; border-color:#e6e6e6; background-color:#f2f2f2;"|
+
}}
 +
{{Section|
 +
==Step 2 - Configure The Employee Portal==
 +
This step covers some of the basic configuration to the look and feel of the Employee Portal.  These settings are located in the Admin Console under ''System->Customize->Employee Portal''.
 +
Configure the following for the structure / theme of the pages on the Employee Portal
 +
 
 +
{{bullet1|Header|Configure the top banner of the Employee Portal, including logo, background image, and colours.}}
 +
{{bullet1|Body|Set the background image and the main colours for the body of the Employee Portal.  The colour settings are used as default for the page widgets.}}
 +
{{bullet1|Footer|Add contact information to the bottom section of the Employee Portal page.  By default this contains Hornbill information, so you will want to change this to match your organisation.}} 
 +
{{bullet1|Mobile|Customize the Employee Portal Mobile App name and setup links to logo images.}}
  
== Related Articles ==
+
'''[[Customize_Employee_Portal|Learn How...]]'''
:* [[Employee Portal]]
 
:* [[Employee Portal Page Configuration]]
 
:* [[Service Domains Administration|Service Domains]]
 
:* [https://community.hornbill.com/forum/155-employee-portal/ Employee Portal Feedback]
 
|}
 
  
== Settings ==
+
{{TOP}}|
The Employee Portal Settings offer a number of options to customize the Header, Body, and Footer of the Employee Portal PagesThis includes setting default images, colours, and contact information.
+
}}
 +
{{Section|
 +
==Step 3 - Add Widgets to the Home Page==
 +
The majority of the contents displayed in the Employee Portal is provided by application widgets. The Employee Portal could consist of as little as a single widget or a collection of widgets from different applications.
 +
[[file:eppagedetails.png|right|300px|link=https://wiki.hornbill.com/images/6/61/Eppagedetails.png]]
 +
=== Page Versions ===
 +
Page Versions relate to the type of users and the access that they have to different application widgets.  By Default, the Home Page, provides two out of the box versions.  It is possible to configure different  '''''Home Page''''' versions for your users based on their type and to include different widgets on these pages if desired.
 +
{{bullet1|Users|A page version which will be displayed to users who are of type '''User'''.  Additional widgets will be available to the user page version, based on user subscription.}}
 +
{{bullet1|Basic Users|A version which will be displayed to users who are of type '''Basic'''Widgets are limited to those that can be accessed by basic users.}}
 +
{{bullet1|All Users|You may prefer to have one version of the Home Page which is used by all users, irrespective of their type, and to achieve this, you can add an '''All Users''' version of the Home Page, and it will have priority over any other page versions and will be displayed to all users.  Widgets are limited to those that can be accessed by basic users.}}
  
=== Header ===
+
=== Add Widgets ===
[[File:EmployeePortalHeader.png|right|300px|link=https://wiki.hornbill.com/images/5/55/EmployeePortalHeader.png]]
+
Add the widgets you would like to appear to the users on the Home Page.
{{Bullet1|Logo|Add your company logo to the Employee Portal to give it some branding. Your logo will be displayed on the right side of the header.  Adjust size, background style, and color of your logo to fit in with the Header Background.}}
 
{{Bullet1|Background|The Header Background can can be configured to set the height and the color, or add a background image.}}
 
{{Bullet1|Text|The Text on this page includes the main title of the page and the list of different Service Domains.  These options let you set the text color and the text background color to provide some contrast between the text and a background image.}}
 
  
{{infobox|Images used for the logo and header background require a URL or link to an image that is stored in a location that is accessible by all users, such as a company web server. They cannot be uploaded to Hornbill}}
+
=== Customize ===
 +
Customize the Widgets in terms of content and style, using the options in each widget's configuration settings.  
  
=== Body ===
+
'''[[Employee_Portal_Page_Configuration|Learn How...]]'''
:* '''Background'''
 
:: Options to either set a background or apply an image to the main body of the portal
 
:* '''Section'''
 
:: Sets the default colors for the widgets that are added to the page
 
:* '''Popup'''
 
:: Sets the default colors for popup boxes
 
  
=== Footer ===
+
{{TOP}}|
:* '''Style'''
+
 
:: Set the color and font options to use within the page footer
+
}}
:* '''Social Information'''
+
 
:: This section allow you to specify your social media accounts Twitter, LinkedIn, YouTube, and Facebook. Only the account ID is needed.  We'll take care of the links. These are displayed with the appropriate social media logo.  Any logo that you do not want to display, leave the account name blank.  If you would like to complete remove this section, deselect the check box next to the ''Social Information'' title.
+
{{Section|
:* '''Contact Information'''
+
==Step 4 - Configure Service Domains==
:: Add the contact details to let you users know who to contact if they have questions about the page. Any field that you do not want to display, leave blank. If you would like to complete remove this section, deselect the check box next to the ''Contact Information'' title.
+
Service Domains are provided to allow you to create unique areas within the Employee Portal for different areas of your business, such as IT, HR, and Facilities. The Domain Configuration is located within the Admin Console under '''''Home > Service Catalog > Service Domains'''''.
:* '''About Details'''
+
[[file:epservicedomain.png|right|500px|link=https://wiki.hornbill.com/images/2/2a/Epservicedomain.png]]
:: Add a bit of information for your users to describe this page. If you would like to complete remove this section, deselect the check box next to the ''About Details'' title.
+
=== Role ===
{{infobox|By deselecting all three check boxes, you can completely remove the footer from the page.}}
+
A User will need the '''Service Domain Administrator''' role to be able to manage Service Domains
<br>
 
  
 
=== Settings ===
 
=== Settings ===
These setting can plan a key role in how you first introduce the Employee Portal to your users. '''Make sure you are familiar with these settings and when to use them'''.  
+
Service Domain Configuration options
<br>
+
{{bullet1|Default|}}
:* '''Users to preview the Employee Portal'''
+
{{bullet1|Enabled|}}
:: This is an important 1st step to setting up your Employee Portal. This setting allows you to add a list of comma-separated usernames of people you want to have access to the Employee Portal. This gives you the opportunity to have one or more people to test and feedback on the Employee Portal design, before you open it up to all users. Changing this setting will also be one of your last steps. Once you have completed your configuration and you are ready to make it available to all users, simply remove these names. Once the list of names is empty, it becomes available to everyone.
+
{{bullet1|Public|}}
:* '''Enable Employee Portal'''  
+
{{bullet1|Language|}}
:: Turning this setting to ''On'' will make a new navigation menu item ''My Company'' available in the Home tile live.hornbill.comIf you have provided one or more names in the previous setting, only those users will see the menu item.
+
 
:* '''Hide My Services'''
+
=== Domain Categories ===
:: Turning the Service Portal (service.hornbill.com) off will possibly the last step in your transition to the Employee Portal.
+
Can be used to provide more granular grouping of services linked to the Service Domain, and to filter widgets on Doman Pages on the Employee Portal
<br>
+
 
<br>
+
=== Domain Owners ===
 +
Users who will be able to manage the linked Domain Page on the Employee Portal
 +
 
 +
'''[[Service_Domains_Administration|Learn How...]]'''
 +
 
 +
{{TOP}}|
 +
}}
 +
{{Section|
 +
==Step 5 - Enable Domain Pages==
 +
 
 +
Using the Page Designer, and being a Domain Owner, will enable the option to create a Domain Page on the Employee Portal
 +
 
 +
Here you will be able to consider the following:
 +
 
 +
:* Page or Redirect
 +
:* Page Widgets
 +
:* Versions
 +
:* Domain Filters
 +
:* Language / Translations
 +
 
 +
'''[[Employee_Portal_Page_Configuration#Roles_and_Rights|Learn How...]]'''
 +
 
 +
{{TOP}}|
 +
}}
 +
{{Section|
 +
==Step 6 - Map Service Manager Services ==
 +
 
 +
=== Link To Service Domains & Domain Categories ===
 +
 
 +
:* In Service Manager > Service Portfolio > Service record > Service Details two new settings are enabled which allow for the mapping of each service in Service Manager to a '''Service Domain''' and Optionally a '''Service Domain Category'''.
 +
:* Mapping a Service to a Service Domain, will allow you on domain pages on the Employee Portal to create widgets, which display Domain-specific data (pulled from the services linked to that domain).
 +
 
 +
=== Utilize Your Existing Data ===
 +
The Employee Portal will present all of your existing Service Manager data.
 +
 
 +
:* Catalog Items
 +
:* FAQ’s
 +
:* Bulletins
 +
:* Subscriptions & Visibility Configurations are Carried Forward
 +
 
 +
 
 +
'''The Home Page''' of the Employee Portal will display data on the configured widgets based on the users subscription to services (without the need to associate the Service Manager Services to Service Domains)
 +
 
 +
'''Domain Pages''' on the Employee Portal, will only display data related to Services mapped to that Domain, if the widgets on the Domain Page have applied the '''Domain Filter'''
 +
 
 +
{{TOP}}|
 +
}}
 +
{{Section|
 +
==Step 7 - Customize==
 +
 
 +
Customize your Home Page, and Domain Pages
 +
 
 +
=== Widget Layouts ===
 +
:* Options - Decide on Row and Column layouts
 +
:* Inherited on Employee Mobile - The Pages, and Ordering will be mirrored on the Employee Mobile
 +
===Widgets Configuration===
 +
:* Domain filters inherited - Apply Domain Filters to widgets on Pages to filter the displayed data
 +
:* Configuration Specific to each widget - Each widget will have unique specific configuration options
 +
===Widget Styling===
 +
:* Title / Icons  - Change the titles, icons and colors
 +
:* Override employee portal general theme if desired - By default all widgets will inherit the styling from the '''Section''' configuration on the Body Section of the pages (as set in the admin console > Manage Employee Portal Settings, however, if desired you can change the style of individual widgets.
 +
 
 +
{{TOP}}|
 +
}}
 +
{{Section|
 +
==Step 8  - Switch==
 +
When the Employee Portal configuration is complete, and you are ready for users to start using the Employee Portal some final steps are quired. 
 +
 
 +
=== Re-directs ===
 +
You may have employees who will follow links to take them to the Service or My Services Portals, and you may have links in email templates which employees will click on and these will take them to the Service of My Services Portals.  To ensure all employees are directed to the Employee Portal, you can enable '''re-directs'''. These will automatically pass employees to the corresponding Employee Portal URL when they try to go to a Service Portal or My Services URL. 
 +
 
 +
Under ''Applications > Collaboration > Settings make these setting changes at the point you are ready to switch (they will take effect immediately)
 +
 
 +
{{bullet1|guest.anonymous.portal.redirectServicePortalTarget|Redirect URLs from the old Service Portal page to the new Employee Portal - Ensure the is set to '''Employee Portal'''}}
 +
{{bullet1|guest.anonymous.portal.redirectServicePortalToEmployeePortal|Redirect URLs from the old Service Portal page to the new Employee Portal - Ensure this is set to '''On'''}}
  
== Company ==
+
=== Enable for users ===
When a company is made up from of a number of subsidiary companies, you are able to define this structure within the Hornbill [[Organisation|Organization]] Structure using company Groups. Each defined company group can have its own settings applied in order to provide there own unique brandingOn the top right of the settings form you can select one of the available companies that you have defined in Hornbill.
+
In Step 1, you may have selected individuals that would take part in the setup and preview of the Employee PortalWhen you are ready to give access to everyone, in the Admin Console navigate to the '''''System > Custumize > Employee Portal''''' and select the '''''Settings''''' tab
 +
{{bullet1|Users To Preview the Employee Portal|Clear all users from this field in order to provide access to all users.}}
  
:* '''Primary Company'''
+
=== Turn off the My Services Option ===
:: This is the main configuration for the Employee Portal.  It will also be used as a template for any Company that is defined within the organization structure.  Settings here will be automatically applied to all other companies, unless a company has specified a different setting from the Primary Company.   
+
This step will remove the ''My Services'' Option from the Collaboration menu in Hornbill.  It will also move the Employee Portal menu item '''Company Home''' to the top of the Menu options, and therefore will be the default view all basic users see when they login.
 +
:# In the Admin Console navigate to ''System > Customize > Employee Portal'' and select the ''Settings'' tab
 +
:# Tick the '''Disable Old Portals''' option
  
{{infobox|A new attribute called ''Home Organisation'' has been added to the [[User Account]] which can be set on the ''Organisations'' tab for that user. Setting the ''Home Organisation'' for a user will have them directed to the appropriately branded page for their company. When a Home Organisation is not configured for a user, the ''Primary Company'' settings will be used. User imports can also be changed to automatically set the Home Organisation}}
+
=== Turn off the Link to the Service Portal from the Menu in the User App ===
<br>
 
  
 +
:# In the Admin Console navigate to ''Applications > Collaboration > Settings''
 +
:# Search for the setting '''webapp.ui.showServicePortalLink'''
 +
:# Turn this setting to ''Off'' to remove a link from the menu in the user app.
  
[[Category:Administration]]
+
{{TOP}}|
 +
}}
 +
[[Category:Configuration]]
 +
-->
 +
[[Category:HDOC]]

Latest revision as of 22:11, 9 May 2024

This document can now be found at its new location in the Hornbill Document Library.

Employee Portal