INDEX
Documentation Library
Search for information on Hornbill Documentation.
{{docApp.searchError}}
{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}
-
{{resultItem.title}}
{{resultItem.url}}
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}}
{{group.title || group.id}}
{{group.description}}
Description
No description provided
Properties
Name | Type | Occurrence | Description |
---|---|---|---|
attrib1 |
xs:string |
Optional Nillable |
The custom attrib1 for the user |
attrib2 |
xs:string |
Optional Nillable |
The custom attrib2 for the user |
attrib3 |
xs:string |
Optional Nillable |
The custom attrib3 for the user |
attrib4 |
xs:string |
Optional Nillable |
The custom attrib4 for the user |
attrib5 |
xs:string |
Optional Nillable |
The custom attrib5 for the user |
attrib6 |
xs:string |
Optional Nillable |
The custom attrib6 for the user |
attrib7 |
xs:string |
Optional Nillable |
The custom attrib7 for the user |
attrib8 |
xs:string |
Optional Nillable |
The custom attrib8 for the user |
country |
xs:string |
Optional | The country that the user is based in. |
dateFormat |
xs:string |
Optional | The default date format of the user. |
dateTimeFormat |
xs:string |
Optional | The default date/time format of the user. |
department |
xs:string |
Optional Nillable |
The department of the user |
dob |
xs:dateTime |
Optional Nillable |
The date of the birth of the user |
email |
xs:string |
Optional | The work email id of the user |
employeeId |
accountIdType | Optional | The employee id of the user (Not applicable for update) |
expertise |
xs:string |
Optional Nillable |
The work skills and expertise of the user |
firstName |
nameType | Optional Nillable |
The first name of the user |
gender |
xs:string |
Optional Nillable |
The gender of the user |
group |
accountGroupListType | Optional Array (0/∞) |
The groups to which user belong. (Not applicable for update) |
handle |
nameType | Optional Nillable |
The display handle of the user |
homeAddress |
xs:string |
Optional Nillable |
The home address of the user. |
homeTelephone |
xs:string |
Optional | The home telephone number of the user |
interests |
xs:string |
Optional Nillable |
The work related interests of the user |
jobDescription |
xs:string |
Optional Nillable |
The job description |
jobTitle |
xs:string |
Optional Nillable |
The job title of the user |
language |
xs:language |
Optional | Specify the language for the user. Language code as defined in RFC 3066 and ISO 639-1. Some example values for this datatype are: “en-GB”, “fr-FR”. Use utility::spellGetLanguageList operation to get all available languages. |
lastLogon |
xs:dateTime |
Optional | The last logon time of the user. (Not applicable for update) |
lastName |
nameType | Optional Nillable |
The last name of the user |
manager |
xs:string |
Optional Nillable |
The manager of the user |
managerName |
xs:string |
Optional Nillable |
The display name of the user’s manager (Not applicable for update) |
middleName |
nameType | Optional Nillable |
The middle name of the user |
nationality |
xs:string |
Optional Nillable |
The nationality of the user |
personalBlog |
xs:anyURI |
Optional Nillable |
The personal blog of the user. |
personalInterests |
xs:string |
Optional | The personal interests of the user. |
qualifications |
xs:string |
Optional Nillable |
The qualifications and the trainings of the user |
religion |
xs:string |
Optional Nillable |
The religion of the user |
securityOptions |
userAccountSecurityOptionsType | Optional | Security options. |
siteId |
xs:integer |
Optional | The site identifier where user is based |
siteName |
xs:string |
Optional Nillable |
The site name where user is based. (Not applicable for update) |
socialNetworkA |
xs:anyURI |
Optional | Social network identifier of the user.(e.g twitter) |
socialNetworkB |
xs:anyURI |
Optional | Social network identifier of the user. |
socialNetworkC |
xs:anyURI |
Optional | Social network identifier of the user.(e.g. Facebook) |
socialNetworkD |
xs:anyURI |
Optional | Social network identifier of the user.(e.g. Professional blog) |
socialNetworkE |
xs:anyURI |
Optional | Social network identifier of the user. |
socialNetworkF |
xs:anyURI |
Optional | Social network identifier of the user. |
socialNetworkG |
xs:anyURI |
Optional | Social network identifier of the user. |
socialNetworkH |
xs:anyURI |
Optional | Social network identifier of the user. |
timeFormat |
xs:string |
Optional | The default time format of the user. |
timezone |
xs:string |
Optional | The default Time Zone applied to this user. If you want to get a list of timezones, please see the time::getTimezoneList operation. |
twofaMethod |
twofaMethodType | Optional | the currently selected two-factor authentication method. |
twofaTotpRegistered |
xs:boolean |
Optional | Set to true if a TOTP authenticator is already registered. |
user |
accountBasicDetailsType | Optional | The basic info of the user.(Not applicable for update) |
userId |
accountIdType | Optional | User Id. If not specified, then logged-in user’s Id will be assumed. |
userType |
accountUserType | Optional | The type of the user account. (Not applicable for update) |
workMobile |
xs:string |
Optional Nillable |
The work mobile phone number of the user |
workPhone |
xs:string |
Optional Nillable |
The work phone number of the user |
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document