Difference between revisions of "Customize Customer Portal"
Jump to navigation
Jump to search
| (18 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | This document can now be found at its new location in the [https://docs.hornbill.com/esp-config/customize/customer-portal-setup/ Hornbill Document Library]. |
| − | {{ | + | |
| − | + | [[file:hornbill-document-library.png|Hornbill Cloud|link=https://docs.hornbill.com/esp-config/customize/customer-portal-setup/]] | |
| − | + | <!-- | |
| − | }} | + | |
| + | {{DISPLAYTITLE:Customer Portal}} | ||
| + | {{breadcrumb|[[Main Page|Home]] > [[Configuration]] > [[Platform Configuration]] > Customer Portal|Configuration}} | ||
| + | {{Section| | ||
| + | ==Introduction== | ||
| + | The Customer Portal provides options to apply images and colours to the design and layout. | ||
| + | ==Details== | ||
| + | ===Basic Information=== | ||
| + | This displays some general information about the portal. This information is mostly relevant to the Hornbill Enterprise Edition where multiple portals can be created. | ||
| + | {{bullet1|Portal ID|This ID is used as part of the URL for accessing the portal. For the customer portal the URL is '''customer'''.hornbill.com/<yourinstance>}} | ||
| + | {{bullet1|Name|This name is used to identify this portal within a list of portals when using the Enterprise Edition}} | ||
| + | {{bullet1|Application|The main application that the portal runs under the context of}} | ||
| + | {{bullet1|Description|This description is used to identify this portal within a list of portals when using the Enterprise Edition}} | ||
| + | ===Regional Settings=== | ||
| + | The Regional Settings are the defaults for the Customer Portal on the login page and when contacts do not have any regional information set against their contact record. | ||
| + | {{bullet1|Language|The default language that is displayed to users when accessing the login page and subsequent pages if a language has not been set against their contact record}} | ||
| + | {{bullet1|Time Zone|The default time zone for contacts. All visible date and time fields will be displayed based on this setting. The default is set to (GMT) Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London}} | ||
| + | {{bullet1|Date Time Format|The format of fields that contain both a date and a time. The default is set to 2020-02-21 16:10:30}} | ||
| + | {{bullet1|Date Format|The format of fields that contain just a date. The default is set to 2020-02-21}} | ||
| + | {{bullet1|Currency|This is not currently used}} | ||
| + | {{bullet1|Time Format|The format of fields that contain just a time. The default is set to 23:30:35}} | ||
| + | ===Security Settings=== | ||
| + | {{bullet1|[[Single Sign On Profiles|Single Sign On Profile]]|The Customer Portal by default uses basic authentication provided by Hornbill. It is possible to enable the use of a third-party identity provider. See [[Single Sign On Profiles]] for more information on creating SSO profiles.}} | ||
| + | {{bullet1|Anonymous Role|In most cases, the role called Anonymous Guest will be used and recommended. It is possible to create your own [[roles|role]]. Any role used here must have a privilege level of guest. Individual contact records do not maintain their own individual roles. All contacts that log in to the customer portal will use the role applied here.}} | ||
| + | {{bullet1|Authorised Role|There are several apps in Hornbill that can extend out the available features in the Customer Portal. Each of those apps supplies guest privilege roles that can be granted to the Customer Portal.}} | ||
| − | == Settings == | + | ===Options=== |
| + | {{bullet1|Session Timeout|The number of seconds until a user's session automatically ends after no activity}} | ||
| + | {{bullet1|Permissions|}} | ||
| + | {{bullet2|Allows contacts to register themselves on this portal|A new visitor to the customer portal will be able to register themselves and have immediate access to the Customer Portal}} | ||
| + | {{bullet2|Allow contacts to select their organisation as part of online registration|Organisation records have the option to allow the organisation name to be available during the registration where the new contact can select from a list of organisations.}} | ||
| + | {{bullet2|Allow contacts to reset their password|Following registration, a temporary generated password may be provided to the contact. Enabling this will allow the contact to change this password.}} | ||
| + | {{bullet2|New guest registrations require authorization before they can log on|Select this option if you require any registration to be authorized before allowing them to log in.}} | ||
| + | ==Customise== | ||
| + | ===Settings=== | ||
{{bullet1|Allow Profile Update|Turning this option ON will allow a contact to view and update their profile information}} | {{bullet1|Allow Profile Update|Turning this option ON will allow a contact to view and update their profile information}} | ||
| − | {{bullet1|Logo|Add your company logo to the top banner of the Customer Portal. This field | + | {{bullet1|Logo|Add your company logo to the top banner of the Customer Portal. This field needs to contain a secure URL (https) to the image, which must be either a .png or .jpg.}} |
{{bullet1|Logo Height|Adjust the height of your logo for a perfect fit in the top banner}} | {{bullet1|Logo Height|Adjust the height of your logo for a perfect fit in the top banner}} | ||
| − | {{bullet1|Home Page Image|Using a URL, include Home Page image. This URL must be public facing in order for external contacts to see this image. This field | + | {{bullet1|Home Page Image|Using a URL, include a Home Page image. This URL must be public facing in order for external contacts to see this image. This field needs to contain a secure URL (https) to the image, which must be either a .png or .jpg. For best fit, the size of the image should be around 1024 x 768}} |
{{bullet1|Home Page Image background Colour|Can be used in either in place of an image or the background for a transparent image}} | {{bullet1|Home Page Image background Colour|Can be used in either in place of an image or the background for a transparent image}} | ||
{{bullet1|Header Colour|The colour of the top navigation bar}} | {{bullet1|Header Colour|The colour of the top navigation bar}} | ||
| Line 16: | Line 48: | ||
{{bullet1|Home Page Background Colour|This applies to the middle section of the page, below the image.}} | {{bullet1|Home Page Background Colour|This applies to the middle section of the page, below the image.}} | ||
| − | == Home Page Text == | + | ===Home Page Text=== |
{{bullet1|Main Image Text||}} | {{bullet1|Main Image Text||}} | ||
{{bullet1|Section Title (When not logged in)|Set to 0 (zero) if you do not wish to include this title}} | {{bullet1|Section Title (When not logged in)|Set to 0 (zero) if you do not wish to include this title}} | ||
| Line 22: | Line 54: | ||
{{bullet1|Section Text|Set to 0 (zero) if you do not wish to include this title}} | {{bullet1|Section Text|Set to 0 (zero) if you do not wish to include this title}} | ||
| − | == Social Information == | + | ===Social Information=== |
| − | This section lets you include links to your company's social media sites. Each included entry will be represented on the portal by is associated logo . | + | This section lets you include links to your company's social media sites. Each included entry will be represented on the portal by is associated logo. |
[[File:PortalSocialInformation.png|right|link=]] | [[File:PortalSocialInformation.png|right|link=]] | ||
{{bullet1|Twitter ID|Add your company's Twitter ID. Enter 0 (zero) to hide}} | {{bullet1|Twitter ID|Add your company's Twitter ID. Enter 0 (zero) to hide}} | ||
| Line 34: | Line 66: | ||
{{infobox|If all Social Information Fields contain a 0 (zero), this section will be completely removed}} | {{infobox|If all Social Information Fields contain a 0 (zero), this section will be completely removed}} | ||
| − | == Contact Information == | + | ===Contact Information=== |
Add contact information for your users on how to contact your Service Desk. Set any field to 0 (zero) in order to hide it from view. Added 0 (zero) to all fields will hide this entire section. | Add contact information for your users on how to contact your Service Desk. Set any field to 0 (zero) in order to hide it from view. Added 0 (zero) to all fields will hide this entire section. | ||
[[File:PortalContactUS.png|right|link=]] | [[File:PortalContactUS.png|right|link=]] | ||
| Line 42: | Line 74: | ||
{{bullet1|Address|Hornbill, Apollo - Odyssey Business Park, West End Road, Ruislip, HA4 6QD, United Kingdom}} | {{bullet1|Address|Hornbill, Apollo - Odyssey Business Park, West End Road, Ruislip, HA4 6QD, United Kingdom}} | ||
| − | == About Details == | + | ===About Details=== |
{{bullet1|About Title|Hornbill Customer Portal}} | {{bullet1|About Title|Hornbill Customer Portal}} | ||
{{bullet1|About Text|The Customer Portal can be used to view and update requests.}} | {{bullet1|About Text|The Customer Portal can be used to view and update requests.}} | ||
| − | == Login Details == | + | ===Login Details=== |
{{bullet1|Auto Login|If you have SSO configured for the Customer Portal, this will bypass the login screen and automatically log the customer into the portal}} | {{bullet1|Auto Login|If you have SSO configured for the Customer Portal, this will bypass the login screen and automatically log the customer into the portal}} | ||
{{bullet1|Terms and Conditions|}} | {{bullet1|Terms and Conditions|}} | ||
| Line 52: | Line 84: | ||
{{bullet2|Show|This will display the Terms and Conditions on the Login screen. When selected, a field is available to enter or edit the terms and conditions text}} | {{bullet2|Show|This will display the Terms and Conditions on the Login screen. When selected, a field is available to enter or edit the terms and conditions text}} | ||
{{bullet2|Show and make mandatory|This will display the Terms and Conditions on the Login Screen. The customer must select the option, agreeing to these conditions before proceeding. When selected, a field is available to enter or edit the terms and conditions text}} | {{bullet2|Show and make mandatory|This will display the Terms and Conditions on the Login Screen. The customer must select the option, agreeing to these conditions before proceeding. When selected, a field is available to enter or edit the terms and conditions text}} | ||
| − | + | ==Translations== | |
| − | [[Category: | + | ==Contact Access== |
| + | === Contact Access === | ||
| + | The Contact Access list shows the contacts or Guest Accounts that have been associated with the Customer Portal. | ||
| + | {{bullet1|Add Contact|Add an existing contact to the Customer Portal Account}} | ||
| + | {{bullet1|Set Access|Change the access a contact has to the Customer Portal}} | ||
| + | {{bullet2|Remove Access|Selecting this will remove the contact from the Customer Portal Account}} | ||
| + | {{bullet2|Approved|Set the contact to be approved for access to the Customer Portal. This is automatically set when a contact is manually added to the Customer Portal Account}} | ||
| + | {{bullet2|Suspended|Temporarily suspend a contact's access to the Customer Portal. A contact can be automatically set to ''suspended'' after multiple failed password attempts.}} | ||
| + | | | ||
| + | {{rightBox|Related articles| | ||
| + | * [[Guest Accounts]] | ||
| + | * [[Service Manager Settings#Portal Settings|Service Manager Portal Settings]] | ||
| + | }} | ||
| + | }} | ||
| + | [[Category:Configuration]] | ||
| + | --> | ||
| + | [[Category:HDOC]] | ||
Latest revision as of 18:38, 11 April 2024
This document can now be found at its new location in the Hornbill Document Library.
