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

Troubleshooting LDAP User Imports

Logs

All logs are saved in the log folder, which can be found in the same location as the executable. The log file names contain the date and time the import was run, for example: LDAP_User_Import_2023-08-30T16-19-51+01-00.log.

Common Errors

Below are some common errors that you may encounter in the user imports log file and what they mean:

  • Error processing authentication details: Decryption of authentication data failed: Key not valid for use in specified state.
    • This error can occur for either of the below states and can be resolved by either running the import as the same session user and on the same computer that the original import authentication took place, or by resetting the encrypted credentials:
      • When the user who runs the import is not the same user who first ran the import;
      • When the import is run on a different computer from the one that originally performed the authentication details encryption.
  • Get https://api.github.com/repos/hornbill/user-import-ldap/tags: dial tcp xx.xx.xx.xx:xxx: ...
    • This most likely indicates that you have an HTTP proxy server on your network between the host running the executable and your Hornbill API endpoint. Ensure the HTTPS_PROXY environment variable is set, and that the proxy is configured to allow this communication. See the HTTP Proxies content from the Network section of the Overview article for more information.
  • panic: runtime error: invalid memory address or nil pointer deference [recovered]...
    • This error suggests an incorrectly specified attribute in the conf file. Where information is being obtained from a directory attribute, the attribute must be in the following format: {{.directoryAttributeName}}
  • Unable to Create User: Invalid value for parameter '[parameter name]': The text size provided (31 characters) is greater than the maximum allowable size of 20 characters for column [column name]
    • The contents of your directory attribute exceed the maximum number of characters that can be placed in the Hornbill database column.
  • Unable to Create User: The value in element <userId> did not meet the required input pattern constraints. at location '/methodCall/params/userId'
  • Unable to Create User: [usedID] Error: The specified handle [Display Name] is already in use
    • By default, the “Handle” (Hornbill Display Name) must be unique. This error suggests a user account already exists in Hornbill which is using this handle. The duplicate-handle validation can be disabled via a setting found in Hornbill Configuration, under Home > System > Advanced Settings and filtering for api.xmlmc.uniqueUserHandle.enable
  • Unable to Update User: Invalid value for parameter '[parameter name]': Error setting value for column '[column name]'. bad lexical cast: source type value could not be interpreted as target
    • This error indicates that the contents of your directory attribute are in a format that is not compatible with the type of the Hornbill database column. For example, you will get this when trying to place text into a database field that is of type “INT” (accepts integer values only).
  • Unable to Load Attribute: '[attribute name]' For Input Param: '[Hornbill Parameter name]'
    • When the import utility is unable to load a particular record attribute from your data source, this means that the attribute field in your directory does not contain a value. This error will not prevent the user account from being created or updated in Hornbill and can be considered more as a warning rather than an outright failure or problem.
  • Unable to Set User Status [status name]: You have reached your user subscription limit of [xx], you will need to expand your subscription level if you wish to add more users
    • The utility is trying to update the user status of an existing user account from an inactive status (i.e. “archived” or “suspended”) to “active”. However, for this to be successful you must have some subscriptions available.
  • Unable to run import, a previous import is still running
    • This can occur if the previous import has failed to complete. Perform a manual (non-scheduled) run of the import from the command line including the argument -forcerun=true. Future imports should now run without issue.
In This Document