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}}

Service Bulletins

Service Manager provides the ability to create and publish Bulletins to the subscribers of Services.

  • Bulletins are created and managed from the Service records in the Service Portfolio
  • Each Service can have it’s own Bulletins which are relevant to it’s purpose
  • Bulletins can be viewed by the subscribers of a service via both the Customer, Service, and Employee Portals
  • Bulletins will be visible on the My Services Landing Page of the Portals, and on the Service Specific Pages on the Portal
  • Where more than one Bulletin exists either on the Same Service or Across Multiple Services, the Bulletins will be displayed in a Carousel, transitioning automatically between each Bulletin every 5 seconds, unless paused or manually progressed.

Creating a Bulletin

From the Service form, navigate to the Bulletin Tab, and select +Add Bulletin Item.

  • Specify a title for the Bulletin
    This acts as a heading on the bulletin.
  • Add a Description
    This will be displayed immediately beneath the title. The text editor can be used to format the text and create hyperlinks to other resources or more detailed content. The description cannot exceed 400 Characters.
  • Upload a background image
    The recommended image dimensions are 1000px x 300px.
  • Configuration Options
    • Display Bulletins Text - This allows you to hide the bulletin title and description text. This is desirable if your background image contains the message you wish to display meaning additional text is not necessary. This configuration option is “ON” by default.
    • Display Bulletins Text Shadow - This option determines whether the title and description text have a shadow. The shadow may affect how the text can be seen against your chosen background image and so the state of this setting will depend on that.
  • Bulletin Visibility
    This feature allows you to control the date and time that a Bulletin becomes visible or hidden on the Bulletin Slideshow component.
    • If the Start is left blank, the Bulletin will be immediately visible when the Bulletin is published
    • If the End is left blank, the Bulletin will remain visible until the Bulletin has been retired
  • Employee Portal Link
    Adding a link here will make the entire bulletin a clickable hyperlink when displayed in the Employee Portal.
  • Create the Bulletin in multiple Languages
    If your subscribed users work in multiple languages, define the Bulletin in the required languages. The users will see the appropriate language Bulletin on the Customer, Service, and Employee Portals based on the language set in their regional settings (by default an English version is created).
  • Status
    A bulletin can be in one of three states:
    • Draft - The Bulletin will not be visible on the Customer, Service, and Employee Portals
    • Published - The Bulletin will be visible on the Customer, Service, and Employee Portals
    • Retired - When retired, the Bulletin will not be visible on the Customer, Service, or Employee Portals.

Viewing Bulletins

When Bulletins are marked as published, any subscribed user of the Service against which the Bulletin has been published will be able to view the Bulletin on the Customer and Service Portals in two locations:

  • My Services View
    If multiple Bulletins have been published from either the same or different Services a User is subscribed to, they will view the Bulletins in a carousel at the top of the My Services view.
    • Click on the Bulletin details, or the Service Name to be taken to the Service View which the Bulletin relates too.
    • Clicking on any hyper-link in the Bulletin text will open the link in a new browser tab.
  • Service Specific Details View
    If one or multiple bulletins have been published from the same Service, they will appear in Service Specific View. Again if there are multiple Bulletins these will appear in a carousel.
  • Clicking on any hyper-link in the Bulletin text will open the link in a new browser tab.

If multiple Bulletins are published they will automatically transition every 5 seconds, if not manually progressed using the Arrow controls on the Carousel.

Bulletins are displayed in the Employee Portal using the corresponding Bulletins Widget, and are also shown in the specific service view.

Managing Bulletins

Bulletin’s can be created and viewed from the Bulletins tab on each service record.

  • The list shows each Bulletin with various attributes including:
    • Status
    • Title
  • Filter the List by Active or Retired Bulletins’s
  • Reorder the sequence in which the Bulletins will appear on the self service portals by dragging and dropping the Bulletins into the required order in the list.
  • Edit or change the status of an Bulletin by clicking through into the Bulletins details from the Cog Icon
  • Delete the Bulletin by clicking on the Trash Can Icon.
  • Bulletin text will not display on the Bulletin in the list, if the bulletin has the Display Bulletin Text set to off
In This Document