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

Entity Details: Contact

Description

This defines a basic contact entity

Details

  • Application Reference: com.hornbill.core
  • Table: h_sys_contact

Entity Options

  • Enable Webhooks: true (default)
  • Visible To Reporting: false (default)
  • Enable Business Rules: false (default)
  • Disable Direct Access: false (default)

Entity Name List

  • ID Column: h_pk_id
  • Filter: No filter
  • Columns:
    • h_firstname
    • h_lastname

Access Control

Update Access

 (function(){
    function parseBoolean(val){
        if(typeof val==="string"){
            return val == "true";
        } else {
            return !!val;
        }
    }
    var isGuestSession = parseBoolean(&[session.isGuestSession]);
    return isGuestSession === false || (&[field.h_logon_id] === &[session.userId] && isGuestSession === true);
    }()) 

Delete Access

 (function(){
    function parseBoolean(val){
        if(typeof val==="string"){
            return val == "true";
        } else {
            return !!val;
        }
    }
    var isGuestSession = parseBoolean(&[session.isGuestSession]);
    return isGuestSession === false || (&[field.h_logon_id] === &[session.userId] && isGuestSession === true);
    }()) 

Entity Access Control

  • Privilege Level: none

Search

app.a.canViewContacts

Update

app.a.canEditContacts

Delete Record

app.a.canDeleteContacts

Search and Browse Control

Filter

No search filter has been defined.

Searchable Columns

  • h_pk_id
  • h_firstname
  • h_lastname
  • h_company
  • h_email_1
  • h_tel_1
  • h_jobtitle
  • h_description
  • h_logon_id
  • h_contact_status

Result Columns

  • h_pk_id
  • h_firstname
  • h_lastname
  • h_tel_1
  • h_email_1
  • h_icon_ref
  • h_jobtitle
  • h_description
  • h_logon_id
  • h_contact_status
  • h_organization_id

Free Text Index

  • Index Storage: entity
  • Index Document Reference Column: h_idx_ref

Indexed Columns

Name Tokenized Search Key
h_email_1 false
h_firstname false
h_lastname false
h_company false

Result Columns

  • h_pk_id
  • h_email_1
  • h_firstname
  • h_lastname
  • h_company
  • h_organization_id
  • h_tel_1

File Attachment Store

  • Store ID: fs_entity
  • Timeout: PT10S
  • Key Expression: Not specified

Activity Stream

This entity has no activity stream defined.

Data Change Log

  • Data Change Log Table: h_sys_audit_trail

Data Change Log Columns

  • h_private
  • h_logon_id
  • h_country
  • h_language
  • h_timezone
  • h_email_1
  • h_email_2
  • h_email_3
  • h_tel_1
  • h_tel_2
  • h_tel_3
  • h_firstname
  • h_lastname
  • h_jobtitle
  • h_description
  • h_notes
  • h_contact_status
  • h_custom_1
  • h_custom_2
  • h_custom_3
  • h_custom_4
  • h_custom_5
  • h_custom_6

Entity Relationships

One-to-Many

Name Related Entity Reference Key Foreign Key Mandatory Managed
organizationsRel OrganizationContacts h_contact_id h_pk_id false false

Many-to-One

Name Related Entity Reference Key Foreign Key Mandatory Managed Mapped Values
Organization Organizations h_organization_id h_organization_id false false
TargetExpression
h_companyh_organization_name
In This Document