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

Configuration Example - Nexthink

The following is an example of the SourceConfig, AssetTypes and data mapping configuration that could be used to import computer-type assets from Nexthink.

Important

The configuration example is provided as-is, and may not be suitable to import your organization’s Nexthink asset data. We highly recommend that a Nexthink administrator review the query and mapping against your Nexthink account before using this in a production environment.

{
  "KeysafeKeyID": 0,
  "LogSizeBytes": 1000000,
  "HornbillUserIDColumn": "h_user_id",
  "SourceConfig": {
    "Source": "nexthink"
  },
  "AssetTypes": [
    {
      "AssetType": "Server",
      "OperationType": "Both",
      "PreserveShared": false,
      "Query": "(select (id name device_manufacturer device_model last_logon_time last_logged_on_user mac_addresses ip_addresses total_ram os_version_and_architecture os_build system_drive_capacity device_serial_number cpu_model cpu_frequency number_of_cores logical_cpu_number bios_serial_number distinguished_name) (from device (where device (eq os_version_and_architecture (pattern 'Windows*Server*')))))",
      "NexthinkPlatform": "windows",
      "AssetIdentifier": {
        "SourceColumn": "name",
        "Entity": "Asset",
        "EntityColumn": "h_name"
      },
      "SoftwareInventory": {
        "AssetIDColumn": "name",
        "Query": "(select ((package (id publisher first_installation name program version)))(from (device package) (with package(where device (eq id (identifier {{AssetID}})))(where package(eq type (enum 'program'))(eq status (enum 'installed')))))(limit 20000))",
        "Mapping": {
          "h_app_id": "{{.publisher}}{{.name}}{{.version}}",
          "h_app_name": "{{.name}}",
          "h_app_vendor": "{{.publisher}}",
          "h_app_version": "{{.version}}",
          "h_app_install_date": "{{.first_installation}}"
        }
      }
    }
  ],
  "AssetGenericFieldMapping": {
    "h_name": "{{.name}}",
    "h_asset_tag": "{{.name}}",
    "h_description": "From Nexthink: {{.name}} ({{.device_model}})",
    "h_notes": "System Drive Capacity: {{.system_drive_capacity}}\nRAM: {{.total_ram}}",
    "h_used_by": "{{.last_logged_on_user}}"
  },
  "AssetTypeFieldMapping": {
    "h_name": "{{.name}}",
    "h_mac_address": "{{.mac_addresses}}",
    "h_net_ip_address": "{{.ip_addresses}}",
    "h_net_computer_name": "{{.name}}",
    "h_model": "{{.device_model}}",
    "h_manufacturer": "{{.device_manufacturer}}",
    "h_description": "{{.device_manufacturer .device_model}}",
    "h_last_logged_on": "{{.last_logon_time}}",
    "h_last_logged_on_user": "{{.last_logged_on_user}}",
    "h_memory_info": "{{.total_ram}}",
    "h_os_description": "{{.os_version_and_architecture}}",
    "h_os_version": "{{.os_build}}",
    "h_physical_disk_size": "{{.system_drive_capacity}}",
    "h_serial_number": "{{.device_serial_number}}",
    "h_cpu_info": "{{.cpu_model}}",
    "h_cpu_clock_speed": "{{.cpu_frequency}}",
    "h_physical_cpus": "{{.number_of_cores}}",
    "h_logical_cpus": "{{.logical_cpu_number}}",
    "h_bios_serial_number": "{{.bios_serial_number}}",
    "h_net_name": "{{.distinguished_name}}"
  }
}
In This Document