INDEX
Documentation Library
Search for information on Hornbill Documentation.
{{docApp.searchError}}
{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}
-
{{resultItem.title}}
{{resultItem.url}}
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}}
{{group.title || group.id}}
{{group.description}}
Operation Information
Updates a ServiceNow Change record.
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 ServiceNow Authentication.
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 ServiceNow Authentication in the Type pick list;
- Give the ServiceNow Authentication KeySafe key a Title (this is the name / identifier for the ServiceNow Authentication 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 |
|---|---|---|
| Instance Name | string |
ServiceNow Instance Name |
| Username | string |
Authentication Username |
| Password | string |
Authentication Password |
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 ServiceNow Authentication account, so you will need to manage these workflows accordingly.
Input Parameters
| Display Name | ID | Type | Description | Required | Supported Values |
|---|---|---|---|---|---|
| Approval | approval |
string |
Approval Status | No | None provided |
| Owner | assigned_to |
string |
Assigned Owner System ID | No | None provided |
| Group | assignment_group |
string |
Assignment Group System ID | No | None provided |
| Backout Plan | backout_plan |
string |
Backout Plan | No | None provided |
| CAB Delegate | cab_delegate |
string |
CAB Delegate System ID | No | None provided |
| Category | category |
string |
Category ID | No | None provided |
| Closure Code | close_code |
string |
Closure Code - mandatory when resolving or closing ServiceNow Change Requests | No | None provided |
| Closure Notes | close_notes |
string |
Closure Notes - mandatory when resolving or closing ServiceNow Change Requests | No | None provided |
| Configuration Item | cmdb_ci |
string |
Configuration Item System ID | No | None provided |
| Comments | comments |
string |
Update Comments | No | None provided |
| Description | description |
string |
Request Description | No | None provided |
| Scheduled End Date | end_date |
string |
Scheduled End Date | No | None provided |
| Impact | impact |
integer |
Impact ID | No | None provided |
| Implementation Plan | implementation_plan |
string |
Implementation Plan | No | None provided |
| Justification | justification |
string |
Change Justification | No | None provided |
| On Hold Reason | on_hold_reason |
string |
On Hold Reason | No | None provided |
| Priority | priority |
integer |
Priority ID | No | None provided |
| Requested By | requested_by |
string |
Requested By System ID | No | None provided |
| Risk | risk |
string |
Risk ID | No | None provided |
| Risk Impact Analysis | risk_impact_analysis |
string |
Risk Impact Analysis | No | None provided |
| Short Description | short_description |
string |
Short Description | No | None provided |
| Scheduled Start Date | start_date |
string |
Scheduled Start Date/Time | No | None provided |
| State | state |
integer |
Request State | No | None provided |
| System ID | sys_id |
string |
Request System ID | Yes | None provided |
| Test Plan | test_plan |
string |
Test Plan | No | None provided |
| Type | type |
string |
Change Type | No | None provided |
| Actual End Date | work_end |
string |
Actual End Date/Time | No | None provided |
| Work Notes | work_notes |
string |
Work Notes | No | None provided |
| Actual Start Date | work_start |
string |
Actual Start Date/Time | No | None provided |
| Additional Fields | additionalFields |
array |
Any additional fields you wish to populate against the ServiceNow Change Request | No | None provided |
Output Parameters
| Display Name | ID | Type | Description |
|---|---|---|---|
| Reference | reference |
string |
ID of the request that was generated |
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document