Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

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

{{book.title}}
More...

Auto Values

The Auto Values feature lets an administrator define how auto-generated values, such as reference IDs, are constructed. In places where more than a sequence number (000001234) is required, an Auto Value can be modified to include dates, time, location, teams, user IDs and more. There are many situations where this type of sequence is much more preferable over a simple numeric sequence.

Some examples include:

  • Shipment numbers
  • Document or Article Reference Numbers
  • Stock Item Codes
  • Asset ID’s
  • Access Code numbers

Auto Value Configuration

  • Description
  • Add Auto Value Component
  • Current Value
  • Daily Increment
  • Monthly Increment
  • Yearly Increment
  • Time last generated

Available Auto Value Component Parts

The following lists of component parts are available to construct an auto value.

Component Description
seq( z, r ) A number starting at 1 when the sequence is first used and incremented by one each time the sequence is used and will never be reset for the entire life of the sequence.
seqd( z, r ) A number starting at 1 at the beginning of each day, and incremented by one each time the sequence is used. This is the daily incremental value for this specific sequence instance.
seqm( z, r ) A number starting at 1 at the beginning of each month, and incremented by one each time the sequence is used. This is the monthly incremental value for this specific sequence instance.
seqy( z, r ) Will be translated into a number starting at 1 at the beginning of each year, and incremented by one each time the sequence is used. This is the yearly incremental value for this specific sequence instance.
date() year - The current four-digit year (e.g. 2008)
year2 - The current two-digit year (e.g. 08)
month - The current two-digit month (01-12)
day - The current two-digit day of the month (01-31)
hour - The current two-digit hour (00-23)
hour12 - The current two-digit hour (01-12)
min - The current two-digit minute (00-59) at the point in time of invocation based on the analysts current time zone settings
sec - The current two-digit second (00-59) at the point in time of invocation based on the analysts current time zone settings
udate() not specified - The current UTC time in ISO8601 date/time format
year - The current four-digit year (e.g. 2008)
year2 - The current two-digit year (e.g. 08)
month - The current two-digit month (01-12)
day - The current two-digit day of the month (01-31)
hour - The current two-digit hour (00-23)
hour12 - The current two-digit hour (01-12)
min- The current two-digit minute (00-59) at the point in time of invocation based on the analysts current time zone settings
sec - The current two-digit second (00-59) at the point in time of invocation based on the analysts current time zone settings
epoch - The UTC time as a unix EPOCH time which is a positive number representing the number of seconds elapsed since the 1st January 1970 at 12:00.
uuid() normal - This generates a UUID that is unique to the system its being generated on
sess( prop_name ) The current user’s session property.
param(param_name) A value passed into the function when invoking the sequence.
rec( column_name ) Use a value that is stored in the database record.

Note

The ‘z’ parameter is optional but if specified indicates the number of leading zero’s to display, if not specified then ZERO is assumed. If the number of digits in the resultant value exceeds the number of places defined here, then the left-most digits will be discarded. The ‘r’ parameter allows you to specify the base to use when converting the numeric value to a string. The default value if not specified is ten (10), any value between 2 and 36 is valid.

  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document