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

Changes / Get Change Details

  • Article
  • 3 minutes to read

Operation Information

Retrieves information about 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
Request System ID sys_id string Request System ID Yes None provided

Output Parameters

Display Name ID Type Description
Change Reason reason string Change Reason
Made SLA? made_sla string Made SLA?
Backout Plan backout_plan string Backout Plan
Change Type type string Change Type
Change Reference number string Change Reference
Test Plan test_plan string Test Plan
CAB Delegate cab_delegate string CAB Delegate
Opened By opened_by string Opened By
Requested By Date requested_by_date string Requested By Date
State state string State
Closed At closed_at string Closed At
Configuration Item cmdb_ci string Configuration Item
Delivery Plan delivery_plan string Delivery Plan
Impact impact string Impact
Review Comments review_comments string Review Comments
Service business_service string Service
Priority priority string Priority
CAB Recommendation cab_recommendation string CAB Recommendation
Expected Start expected_start string Expected Start
Production System? production_system string Production System?
Opened At opened_at string Opened At
Review Date review_date string Review Date
Business Duration business_duration string Business Duration
Requested By requested_by string Requested By
Actual End Date work_end string Actual Work End Date
Change Plan change_plan string Change Plan
Approval Set? approval_set string Approval Set?
CAB Date cab_date string CAB Date
Work Notes work_notes string Work Notes
Implementation Plan implementation_plan string Implementation Plan
Planned End Date end_date string Planned End Date
Summary short_description string Summary
Closure Code close_code string Closure Code
Actual Start Date work_start string Actual Work Start Date
Assignment Group assignment_group string Assignment Group
Outside the maintenance schedule? outside_maintenance_schedul string Outside the maintenance schedule?
Description description string Description
On Hold Reason on_hold_reason string On Hold Reason
Closure Notes close_notes string Closure Notes
Closed By closed_by string Closed By
CAB Required cab_required string CAB Required
Scope scope string Scope
Justification justification string Justification
Assigned To assigned_to string Assigned To
Planned Start Date start_date string Planned Start Date
Approval approval string Approval
Due Date due_date string Due Date
On Hold Status on_hold string On Hold Status
Escalation Status escalation string Escalation Status
Risk risk string Risk
Category category string Category
Risk Impact Analysis risk_impact_analysis string Risk Impact Analysis
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document