Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

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

{{book.title}}
More...

Human Resources / Change Home Contact Information

  • Article
  • 4 minutes to read

Operation Information

Hornbill Integration method for updating the contact details for an employee in Workday. Invokes the following API in Workday: https://community.workday.com/sites/default/files/file-hosting/productionapi/Human_Resources/v31.0/Change_Home_Contact_Information.html.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type Workday.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose Workday in the Type pick list;
  • Give the Workday KeySafe key a Title (this is the name / identifier for the Workday account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
Username string Authentication Username
Password string Authentication Password
Tenant Name string Tenant Name for your Workday instance
Instance ID string Instance ID for your Workday instance

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked Workday account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Auto Complete Auto_Complete string Auto Complete No None provided
Run Now Run_Now string Run Now No None provided
Comment Comment string Comment No None provided
Person Reference ID Person_Reference_ID string Person Reference ID No None provided
Person Reference Type Person_Reference_Type string Person Reference Type No None provided
Universal ID Reference Universal_ID_Reference string Universal ID Reference No None provided
Universal ID Type Universal_ID_Type string Universal ID Type No None provided
Event Effective Date Event_Effective_Date string Event Effective Date No None provided
Country Reference ID Country_Reference_ID string Country Reference ID No None provided
Country Reference Type Country_Reference_Type string Country Reference Type No None provided
Country Region Reference ID Country_Region_Reference_ID string Country Region Reference ID No None provided
Country Region Reference Type Country_Region_Reference_Type string Country Region Reference Type No None provided
Country Region Descriptor Country_Region_Descriptor string Country Region Descriptor No None provided
Address Line Data Address_Line_Data array None provided No None provided
Subregion Data Subregion_Data array None provided No None provided
Postal Code Postal_Code string Postal Code No None provided
Municipality Municipality string Municipality No None provided
Municipality Local Municipality_Local string Municipality Local No None provided
Country City Reference ID Country_City_Reference_ID string Country City Reference ID No None provided
Country City Reference Type Country_City_Reference_Type string Country City Reference Type No None provided
Country City Reference Parent ID Country_City_Reference_Parent_ID string Country City Reference Parent ID No None provided
Country City Reference Parent Type Country_City_Reference_Parent_Type string Country City Reference Parent Type No None provided
Number of Days Number_of_Days string The number of days a week this address will be used as a Work from Home address No None provided
Effective Date Effective_Date string Effective Date No None provided
Formatted Phone Formatted_Phone string Formatted Phone No None provided
Device Type Reference ID Device_Type_Reference_ID string Device Type Reference ID No None provided
Device Type Reference Type Device_Type_Reference_Type string Device Type Reference Type No None provided
Country Code Reference ID Country_Code_Reference_ID string Country Code Reference ID No None provided
Country Code Reference Type Country_Code_Reference_Type string Country Code Reference Type No None provided
Complete Phone Number Complete_Phone_Number string Complete Phone Number No None provided
Extension Extension string Extension No None provided
Phone Reference ID Phone_Reference_ID string Phone Reference ID No None provided
Phone Reference Type Phone_Reference_Type string Phone Reference Type No None provided
Phone ID Phone_ID string Phone ID No None provided
Email Addresses Email_Address array None provided No None provided
Email Reference ID Email_Reference_ID string Email Reference ID No None provided
Email Reference Type Email_Reference_Type string Email Reference Type No None provided
Email ID Email_ID string Email ID No None provided

Output Parameters

Display Name ID Type Description
Event ID Event_ID string Event ID of the Legal Name Change Event
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document