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

Asset Details

The Asset record will display the configured asset attributes for the given asset type, users with the appropriate rights can edit the attributes of the asset. It is possible to link assets to other assets, services and documents, and add attachments. In conjuction with Configuration Manager, it is also possible to schedule activities against the asset, collaborate on the asset timeline, follow the asset and graphically view the relationships the asset has to other entities.

Asset Actions

  • Update
    The update action will be visible if Configuration Manager has been installed on your instance and the asset is marked as In Policy. Use the update action to post to the asset’s timeline, and collaborate on the asset with other users.
  • Link
    This Action Item lets you search and link this asset with an existing request within Service Manager.
  • Assets
    Link this asset to other related or connected assets.
  • Attachments
    Upload files and documents from your local file system.
  • Service
    Link to a service that is supported by this asset. Associating which services an asset supports or underpins can support quicker Incident and or Problem resolutions by making it quick and easy to understand what infrastructure is directly used to provide each service. Change management can benefit from visualizing which Services will be impacted when implementing changes to an asset, where the asset is linked to and supports/underpins one or multiple services.
  • Documents
    Link to documents that are stored in Hornbill Document Manager.

Asset History

View all changes to the asset’s attributes by clicking on the History icon.

The asset’s Audit History will list actions, including who performed the action.

  • Search
    Search on field, from, and to columns.
  • Relationships
    Show changes in relationships between this asset and other entities within Hornbill.
  • Generate PDF
    Create a PDF document of the audit history. This will automatically be downloaded to your local computer. The document is split into sections for details and relationships.
  • Print
    Print the contents of the audit history to a printer.

Summary

A Summary section maybe visible on the right-hand side of the asset details view. The attributes displayed in the summary section are configurable per asset type and can be managed by the asset administrator, alongside deciding which asset attributes to make visible per asset type, and which asset attributes are mandatory. This is covered in more detail under Asset Types

Asset Details

View the assets attributes.

The Assets are broken down into logical groupings, which will be specific to the asset type and asset class the asset belongs to.

Updating/Editing an Asset

To edit an asset’s attributes or asset image, select Edit, Make the changes you need and then select the Save button to confirm the changes.

  • Asset Attribute Lookups
    Certain Attribute fields will be free text, others will be lookup fields, guidance is given on the key lookup fields below:
    • Used by
      An asset can either be used by a single active user (not contacts), or if the Enable Sharing option is enabled, the used by will display as Shared and a new Shared With option will appear allowing the asset to be shared with multiple users, contacts, internal groupings and external organizations. If an asset is shared, it will appear as a selectable asset on requests and progressive capture asset forms for those it has been shared with.
    • Owned by
      User look up based on active user accounts (not contacts). The users returned in the Owned By look-up will be based on the Company Group specified in the Company field if this is already populated.
    • Site
      The list of sites defined in the Configuration. The list will be filtered by sites linked to a Company Group, if the Company field is already populated.
    • Company
      List of defined Company Groups set up in the Configuration console, under Organization Data.
    • Vendor
      Software Class specific, lookup is defined from Vendors created from the Manage Asset Types and Manage Vendors, Products, Versions button on the Software Asset Class.
    • Product
      Software Class specific, lookup is filtered based on the previously chosen Vendor field. Products are created from the Manage Asset Types and Manage Vendors, Products, Versions button on the Software Asset Class.
    • Version
      Software Class specific, lookup is filtered based on the previously chosen Product field. Versions are created from the Manage Asset Types and Manage Vendors, Products, Versions button on the Software Asset Class.

Attachments

View, edit the description of, or remove any attachments associated to the asset

Linked Entities

If the asset has been linked to other entities in Hornbill, they will be visible in the linked entities section

  • Linked Requests
    View all requests the asset has been linked too
  • Assets
    View any other linked assets (launch a graphical view if configuration manager is installed)
  • Services
    View any services the asset is linked too
  • Documents
    View, Download or unlink any documents the asset is linked too

Timeline

Collaborate on and follow assets. The Timeline will be visible on an asset view if Configuration Manager is installed and the asset is marked as under policy.

Tags

Tags provide a way to specify key words or attributes on an Asset for easy searching for this asset and any other asset using the same tag.

  • Adding a Tag
    To add a tag, simply start typing the tag that you wish to add. As you type, existing tags that match will be displayed and can be selected. There are two modes available that control if a user can add their own tags or if the predefined tags must be used.
  • Conditions
    Within both the Advanced Filter and the View Criteria on the Asset List, you can add a condition to filter your asset list based on one or more tags
  • Global Search
    The Global Search contains two search options. Search by Name and Description (default) or by Tags. Selecting the Tag search will provide a list of results based on the tags provided.

Activities

Schedule and Manage asset activities such as reviews and PAT testing. The Activities option will be visible if Configuration Manager is installed and the asset is marked as under policy.

Custom Buttons

It maybe useful to link to external content, or launch 3rd party solutions from asset forms. Custom buttons can be added to asset forms to facilitate this by the asset administrators.

Add, Edit or Remove custom Buttons on the Asset form by using the Custom Buttons option.

  • Add a New Custom Button by giving the Custom Button a name, invoke an iBridge option or define a URL to launch from the button by adding an asset attribute field as a variable you want to pass to the the URL.
  • Example uses for Asset Custom Buttons may include launching a 3rd party online remote control application, or viewing further asset information held in a 3rd party discovery tool, or simply a link to the vendor’s website for more information on the asset.
  • Custom Buttons can be set to only show if certain conditions are met i.e. if the asset form being viewed is of a certain type or class, or if an attribute of the asset manages the given condition.
In This Document