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

/ admin / userCreate

Description

Invoke this method to create a user.

API Details

  • Status:
  • The required privilege level to invoke this method is user
  • The supported database role for this method is none
  • Transactional database functions are used during this method when supported by the target database.
System Rights Database Rights Mail Rights Calendar Rights
sys.a.manageUsers
sys.a.createUser
--- --- ---

Request Parameters

The userCreate method takes the following input parameters. It is important to note that the parameters must be passed to the method in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
userId accountIdType Required The ID of the user to create.
loginId loginIdType Optional The Login ID for this user, will use userId if not specified
employeeId accountIdType Optional The Employee ID for this user
name nameType Required The display name of the user.
password passwordType Required The password to set for the user. This password must be BASE64 encoded to ensure that no plain text passwords are transmitted over the wire. If you provide an empty string here, the password will not be set, in this case, direct login will not be allowed for this account
userType accountUserType Optional
Default=user
The type of user to create, either ‘user’ or ‘basic’.
enable2fa twofaMethodType Optional
Default=disabled
Set this to use two-factor authentication method for this account.
nonUserAccount xs:boolean Optional If set to ‘true’ the account will not be visible in user browse/search lists.
firstName nameType Optional The first name of the user.
lastName xs:string Optional The last name of the user.
jobTitle xs:string Optional The job title of the user.
homeOrganization groupIdType Optional The home organization of the user.
site xs:string Optional The site where this co-worker is based.
phone xs:string Optional The direct dial telephone number for the user.
email rfc822AddressType Optional The email for the user.
mobile xs:string Optional The cell phone number for the user (used for SMS notification).
availabilityStatus numberType Optional
Default=1
The availability status currently set for this user. If not specified, then the default will be 1.
absenceMessage xs:string Optional The absence message set for this 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. The default value will be picked up from this setting i.e security.user.autoProvisioning.default.timeZone
language xs:language Optional The assigned language of the user. The default value will be picked up from this setting i.e security.user.autoProvisioning.default.language
dateTimeFormat xs:string Optional The default date/time format of the user. The default value will be picked up from this setting i.e security.user.autoProvisioning.default.dateTimeFormat
dateFormat xs:string Optional The default date format of the user. The default value will be picked up from this setting i.e security.user.autoProvisioning.default.dateFormat
timeFormat xs:string Optional The default time format of the user. The default value will be picked up from this setting i.e security.user.autoProvisioning.default.timeFormat
currencySymbol xs:string Optional The default currency symbol of the user. The default value will be picked up from this setting i.e security.user.autoProvisioning.default.currencySymbol
countryCode countryCodeType Optional The default country code of the user. The default value will be picked up from this setting i.e security.user.autoProvisioning.default.countryCode
securityOptions userAccountSecurityOptionsType Optional Security related account options.
notifyEmail xs:boolean Optional Enables/Disables notifications to this users e-mail address.
notifyTextMessage xs:boolean Optional Enables/Disables notifications to this users mobile phone via SMS text messaging.
personalMailRights mailboxRightsType Optional The rights to grant on this users personal mailbox. If not specified - all rights are granted. This is ignored when creating a basic user
userProfile userExtendedProfileData Optional When creating a full user, this property can be used to set the extended user profile properties.

Response Parameters

This method returns no response parameters.

In This Document