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

/ session / getSessionInfo

Description

Returns information about your current session, or, with appropriate rights any other active session on the server.

API Details

  • Status:
  • The required privilege level to invoke this method is guest
  • The supported database role for this method is none
System Rights Database Rights Mail Rights Calendar Rights
--- --- --- ---

Request Parameters

The getSessionInfo 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
sessionId xs:string Optional You can specify the session Id that you would like to retrieve information about. If you do not specify any session ID then your current logged in session will be assumed.

Response Parameters

Name Type Attributes Description
now xs:dateTime Required The last activity time related to the session.
sessionId xs:string Required The ID related to the session.
authenticationType authenticationType Optional The authentication type for this session.
instanceId xs:string Required The Instance ID related to the session.
createdOn xs:dateTime Required The date and time the session was established.
isGuestSession xs:boolean Required Whether the session is self service session or not.
remoteIpAddress xs:string Required The client remote IP address that was used to create the session.
sessionVariable sessionVariableType Optional
Array (0/∞)
The session state variables such as “Current User/Current Group”.
userId accountIdType Required The user ID relating to this session (i.e. who is logged in).
firstName nameType Optional User’s first name
lastName nameType Optional User’s last name
userName nameType Required The display name of the user.
jobTitle nameType Optional User’s job title
accountRefUrn xs:anyURI Required The uniform resource name for this account/user.
activityStreamURN xs:anyURI Optional The activity stream URN for this account/users Buzz.
accountClass accountClassType Required The account/login class.
userType accountUserType Required The account/login type.
guestRole guestRoleType Optional If the accountClass = “guest” then this will reflect the role the guest currently has.
guestPortalId accountIdType Optional The ID of the portal account associated with this guest contact.
guestPortalLoginId guestContactIdType Optional The guest contact login id.
guestContactRecordId xs:long Optional The guest contact record ID.
currentLanguage languageInfoType Required The currently selected language for this user.
regionalSettings regionalSettingsType Required The regional settings associated with this user.
currentTimeZoneOffset xs:integer Required The current (at the time of this operation) timezone offset for the sessions timezone expressed in seconds. The number will be positive for eastbound offsets (before GMT) and negative for westbound offsets (after GMT).
groupMembership groupMembershipType Optional
Array (0/∞)
The user’s group membership.
diagnosticLogSeverityLevel severityLevelType Required The log severity level enabled for diagnostics logging on the session.
diagnosticLogMessageGroups logMessageGroupType Required The log diagnostic log message groups enabled for diagnostics on the session.
resultXmlSchemaValidationEnabled xs:boolean Required Indicates if the server is validating the result XML messages against the schema.
databaseSecurityHintingEnabled xs:boolean Required Indicates if the server is proving database security violation hints.
flowCodeTracingEnabled xs:boolean Required Indicates if FlowCode tracing is enabled for this session.
systemRights systemRightsType Required The system rights granted to the session.
assignedRole nameType Required
Array (1/∞)
List of role(s) assigned to the user session.
personalMailRights mailboxRightsInfoType Optional The list of personal mailbox rights associated granted to this account.
sharedMailboxRights mailboxRightsInfoType Optional
Array (0/∞)
The list of shared mailboxes and rights that are accessible to this session.
location geoLocationType Optional The location information of the session
homeOrganization xs:string Optional The home organization of this user
applicationRights propListType Optional
Array (0/∞)
The list of applications and their associated rights granted to the session.
appStateCRC xs:unsignedInt Required A CRC number that represents the application state for this session. The caclulation is derrived from the applications the user has rights so, as well as a the build number, and last app update date.
profileImageRef xs:anyURI Optional The image reference for the profile image relating to the user of this session.
onlineStatus onlineStatusType Required Your currently reported on line status.
In This Document