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

/ data / entityBrowseRecords2

Description

This method should be used instead of entityBrowseRecords. This method is used to browse or search for a list of entity records within the specified entity.

API Details

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

Request Parameters

The entityBrowseRecords2 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
application appNameType Optional Specify the name of the application this operation relates to. If not specified then “system” is assumed.
entity simpleIdType Required The name of the entity you want to query.
matchScope searchJoinType Optional This can be either ‘all’ or ‘any’. This determines if all fields in the search filter must match or if any field will match a result. Multiple values for the same column are always treated as a separate sub-criteria and ‘any’ value will match regardless of this setting. The default behavior if this is not specified is ‘all’
searchFilter searchColumnType Optional
Array (0/∞)
Specify one or more values as search criteria. You can only specify columns that are defined by the entity as searchable. Invoke data::entityGetBrowseMetaData operation to get the list of searchable columns and it’s metadata.
orderBy orderByColumnType Optional
Array (0/∞)
One or more items to describe the order of the result set. If not specified then the order of the data will be dictated by the natural order of the underlying database.
formatValues xs:boolean Optional
Default=false
This is an optional parameter, the default value is ‘false’. If you do not specify this parameter or specify false, the result set will be returned with the data values in their raw format. If you specify true, then the values will be formatted according to the application level format settings.
returnMeta xs:boolean Optional
Default=false
This is an optional parameter, the default value is ‘false’. If you do not specify this parameter or specify false, the result set will be returned but will not include any meta data. If you specify true, then the meta data that describes the result set will be returned.
returnRawValues xs:boolean Optional
Default=false
This is an optional parameter, the default value is ‘false’. If you specify true, then the result data will include raw values for columns that have been formatted. The raw values are returned as an attribute in the corresponding column value called “raw”. The raw value will only be present if: -

- The value has been formatted and is now different to the raw value
- The column is not a TEXT or BLOB data type.
maxResults xs:integer Optional
Default=0
This is an optional parameter, the default value is ZERO (0). If you wish to limit the results returned from your query you can set this value to the maximum number of records you want to get back. If you specify ZERO (0) then all records will be returned. If you do not want any data back you can specify -1, this is useful for obtaining just the meta data that would result from the query

Response Parameters

Name Type Attributes Description
metaData anyDataType Optional If the returnMeta input parameter is set to ‘true’, then the <metaData> element will be returned with a data structure describing the database column attributes associated with each column in the result set.

Example:

   <metaData>     <res_column_name         type=“VARCHAR”          column=“the_column_name”         table=“the_table”          size=“20”          scale=“0”          precision=“0”          primaryKey="yes
rowData anyDataType Optional The data returned from this operation is dependant on the result of the SQL query. The result set is formatted in a standard way and consists of (optional) meta data as well as zero or more rows of data.

Example:

   <rowData>     <row>       <res_column_name>the_column_value</column_name>       <res_column_name>the_column_value</column_name>       …     </row>     <row>       <res_column_name>the_column_value</column_name>       <res_column_name>the_column_value</column_name>       …     </row> 	…   </rowData> 
queryExecTime xs:unsignedInt Optional The amount of time in microseconds that it took the database server to execute the query and return the results
queryResultsTime xs:unsignedInt Optional The amount of time in microseconds it took to process the results and serialize to XML/JSON (excluding any transmission time back to the caller)
In This Document