Documentation

{{docApp.title}}

{{docApp.description}}

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?


What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

Security Role - Service Manager Authorised Guest

Description

This role is for guests accessing the Hornbill Customer Portal.

Role Information

  • Application Reference: com.hornbill.servicemanager
  • Type: Security - Roles of this type are shipped by Hornbill for the purpose of assigning platform and application rights to user sessions.
  • Privilege Level: Guest - The privilege level applied to any anonymous or authenticated guest on the system.

Role Rights

Application Rights

The following are the application rights assigned to the Service Manager Authorised Guest role.

Group A - Service Desk and Self Service

ID Description
viewRequests View Requests
viewCustomerRecords View Customer Records
manageBoards Manage Boards

Group B - Problem Management

There are no Group B application rights assigned to this role.

Group C - Change and Release Management

There are no Group C application rights assigned to this role.

Group D - Asset Management

There are no Group D application rights assigned to this role.

Group E - Service Level Management

There are no Group E application rights assigned to this role.

Group F - Service Management

There are no Group F application rights assigned to this role.

Group G - Self Service

ID Description
viewIncidents View Incidents
viewServiceRequests View Service Requests
viewChangeRequests View Change Requests
createIncidents Create Incidents
createServiceRequests Create Service Requests
createChangeRequests Create Change Requests
updateIncidents Update Incidents
updateServiceRequests Update Service Requests
updateChangeRequests Update Change Requests
closeIncidents Close Incidents
closeServiceRequests Close Service Requests
closeChangeRequests Close Change Requests
reopenIncidents Reopen Incidents
reopenServiceRequests Reopen Service Requests
reopenChangeRequests Reopen Change Requests

Group H - Entities Access Control

There are no Group H application rights assigned to this role.

System Rights

The following are the system rights assigned to the Service Manager Authorised Guest role.

Group A - systemRightsAType

ID Description
manageNotifications Can manage notifications
registerChannel Can register an event channel
deregisterChannel Can de-register an event channel
manageSlcs Can manage service level calendars
createSlc Can create service level calendar
updateSlc Can update service level calendar
deleteSlc Can delete service level calendar
manageTimers Can manage timer instances
createTimer Can create timer instance
updateTimer Can update timer instance
deleteTimer Can delete timer instance
executeStoredQuery Can execute stored query
canSpawnProcess Can spawn business process

Group B - systemRightsBType

ID Description
manageTasks Can manage tasks
createTask Can create task
updateTask Can update task
deleteTask Can delete task
addDocument Can add indexer document
updateDocument Can update indexer document
deleteDocument Can delete indexer document
manageIndexer Can manage indexer

Group C - systemRightsCType

There are no Group C system rights assigned to this role.

Group D - systemRightsDType

ID Description
refreshApplication Can reload application
addRecord Can add record
getRecord Can get record
updateRecord Can update record
deleteRecord Can delete record

Group E - systemRightsEType

ID Description
postMessage Can post activity message
deregisterActivityStream Can deregister activity stream
followActivityStream Can follow activity stream
unfollowActivityStream Can unfollow activity stream
likeActivity Can like activity or comment
unlikeActivity Can unlike activity or comment
queryActivityStream Can query activity streams
postComment Can post activity comment
editComment Can edit activity comment
deleteComment Can delete activity comment
createWorkspace Can create workspace
getWorkspace Can get workspace
joinWorkspace Can join workspace
leaveWorkspace Can leave workspace
addWorkspaceMember Can add members to workspace
removeWorkspaceMember Can manage timer instances
updateWorkspace Can update workspace
changeWorkspaceOwner Can change workspace owner
deleteWorkspace Can delete workspace
startConversation Can start conversation
getConversation Can get conversation
postConversation Can post a message to a conversation
searchConversation Can search conversations
addConversationMember Can add participants for a conversation
deleteConversation Can delete conversation
removeConversationMember Can remove participants for a conversation
manageProfileImages Can manage social objects profile images
searchActivity Can search activity streams

Group F - systemRightsFType

There are no Group F system rights assigned to this role.

Group G - systemRightsGType

There are no Group G system rights assigned to this role.

Group H - systemRightsHType

There are no Group H system rights assigned to this role.

In This Document