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

Work Orders / Create

  • Article
  • 5 minutes to read

Operation Information

Create a Work Order record a IBM Maximo.

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 Username + Password.

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 Username + Password in the Type pick list;
  • Give the Username + Password KeySafe key a Title (this is the name / identifier for the Username + Password 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
API Endpoint string Optional API Endpoint

Tip

Populate the API Endpoint field with your logged in URL, preceding /ui/login. For example: https://your-subdomain.mro.com/maximo.

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 Username + Password account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Site ID siteid string None provided Yes None provided
Report Date reportdate string None provided Yes None provided
Status Date statusdate string None provided Yes None provided
Scheduled Start schedstart string Please use the following format: YYYY/MM/DDTHH:MM:SS-05:00 No None provided
Target Start Date targstartdate string Please use the following format: YYYY/MM/DDTHH:MM:SS-05:00 No None provided
Actual Start Date actstart string Please use the following format: YYYY/MM/DDTHH:MM:SS-05:00 No None provided
Scheduled Finish schedfinish string Please use the following format: YYYY/MM/DDTHH:MM:SS-05:00 No None provided
Target Completion Date targcompdate string Please use the following format: YYYY/MM/DDTHH:MM:SS-05:00 No None provided
Actual Finish actfinish string Please use the following format: YYYY/MM/DDTHH:MM:SS-05:00 No None provided
Parent Work Order Reference parent string None provided No None provided
Affected Phone affectedphone string None provided No None provided
Is This A Task istask boolean None provided No None provided
Task Id taskid string None provided No None provided
Work Order Priority wopriority string None provided No None provided
Commodity Group commoditygroup string None provided No None provided
Owner owner string None provided No None provided
Owner Group ownergroup string None provided No None provided
Asset Site ID assetsiteid string None provided No None provided
Class Structure ID classstructureid string None provided No None provided
Reported Priority Description reportedpriority_description string None provided No None provided
Reported Phone reportedphone string None provided No None provided
Reported Email reportedemail string None provided No None provided
Store Room Status Description storeroommtlstatus_description boolean None provided No None provided
Commodity commodity string None provided No None provided
Has Solution hassolution boolean None provided No None provided
Act Lab Cost actlabcost number None provided No None provided
Status Description status_description string None provided No None provided
Has Children haschildren boolean None provided No None provided
Include Tasks In Schedule inctasksinsched boolean None provided No None provided
Premature Due Date pmduedate string None provided No None provided
Status status string None provided No None provided
Work Order Phone Number phone string None provided No None provided
Internal Priority Description internalpriority_description string None provided No None provided
Work Order Is Flow Controlled flowcontrolled boolean None provided No None provided
Contract contract string None provided No None provided
Org ID orgid string None provided No None provided
Reported By Name reportedbyname string None provided No None provided
Actual Finish actualfinish string None provided No None provided
Is Known Error isknownerror boolean None provided No None provided
Affected Person affectedperson string None provided No None provided
Reported Priority reportedpriority number None provided No None provided
Class class string None provided No None provided
Description description string None provided No None provided
Actual Labor Hours actlabhrs number None provided No None provided
Site Visit sitevisit boolean None provided No None provided
Asset Org ID assetorgid string None provided No None provided
Long Description description_longdescription string None provided No None provided
Reason For Change reasonforchange boolean None provided No None provided
Problem Code problemcode string None provided No None provided
Affected Date affecteddate string None provided No None provided
Asset Number assetnum string None provided No None provided
Title Group persongroup string None provided No None provided
Created On Behalf Of onbehalfof string None provided No None provided
Interruptible interruptible boolean None provided No None provided
Estimated labor Cost estlabcost string None provided No None provided
Downtime downtime boolean None provided No None provided
Who Is This Change For whomischangefor string None provided No None provided
Actual labor Cost actoutlabcost string None provided No None provided
Estimate labor Hours estintlabhrs string None provided No None provided
Inspector inspector string None provided No None provided
Failure Code failurecode string None provided No None provided
Milestone milestone string None provided No None provided

Output Parameters

Display Name ID Type Description
Operation Status opStatus string The status of the iBridge operation (ok/fail)
Error error string Any errors returned from the operation, should the status be fail
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document