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 / Update

  • Article
  • 5 minutes to read

Operation Information

Updates 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
Work Order Reference reference string The reference number of your Maximo Work Order Yes None provided
Estimate Appropriate labor Hours estatapproutlabhrs number None provided No None provided
Location location string None provided No None provided
Work Order Number wonum string None provided No 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
Is A Task istask boolean None provided No None provided
Estimated Duration estdur number None provided No None provided
Appointment Required apptrequired boolean None provided No None provided
Work Order Accepts Charges woacceptscharges boolean None provided No None provided
Actual Cool Cost acttoolcost number None provided No None provided
New Child Class newchildclass string None provided No None provided
Phone phone string None provided No None provided
Disabled disabled boolean None provided No None provided
Actual Output labor Cost actoutlabcost number None provided No None provided
Estimate Tool Cost esttoolcost number None provided No None provided
Work Order Has Children haschildren boolean None provided No None provided
Status Description status_description string None provided No None provided
Reported By reportedby string None provided No None provided
Estatimate Outout labor Cost estatapproutlabcost number None provided No None provided
Estimate Service Cost estatapprservcost number None provided No None provided
Work Type worktype string None provided No None provided
Charge Store chargestore boolean None provided No None provided
Organization ID orgid string None provided No None provided
Actual labor Hours actintlabhrs number None provided No None provided
FLow Action Assist flowactionassist boolean None provided No None provided
Interruptible interruptible boolean None provided No None provided
Output labor Lost outlabcost number None provided No None provided
Estimate Output labor Cost estoutlabcost number None provided No None provided
Output Tool Cost outtoolcost number None provided No None provided
Status Date statusdate string Please use the following format: YYYY/MM/DDTHH:MM:SS-05:00 No None provided
Actual labor Hours actoutlabhrs number None provided No None provided
Estatimated Tool Cost estatapprtoolcost number None provided No None provided
Has Follow Up Work hasfollowupwork boolean None provided No None provided
Change Date changedate string Please use the following format: YYYY/MM/DDTHH:MM:SS-05:00 No None provided
Actual Service Cost actservcost number None provided No None provided
Calculated Priority calcpriority number None provided No None provided
Asset Priority assetlocpriority number None provided No None provided
Work Order Id workorderid number None provided No None provided
Parent Change Status parentchgsstatus boolean None provided No None provided
Calendar calendar string None provided No None provided
Flow Controlled flowcontrolled boolean None provided No None provided
Estimate Service Cost estservcost number None provided No None provided
Asset Number assetnum string None provided No None provided
Owner owner string None provided No None provided
Work Order Group wogroup string None provided No None provided
Site siteid string None provided No None provided
Flag History historyflag boolean None provided No None provided
Milestone milestone boolean None provided No None provided
Work Order Class Description woclass_description string None provided No None provided
Failure Code failurecode string None provided No None provided
Request Asstisted Downtime reqasstdwntime boolean None provided No None provided
Actual labor Cost actlabcost number None provided No None provided
Estimated Laborur Cost estlabcost number None provided No None provided
Status status string None provided No None provided
Change By changeby string None provided No None provided
Description description string None provided No None provided
Downtime downtime boolean None provided No None provided
Include Task In Scheduled Time inctasksinsched boolean None provided No None provided
Estimated Cost estmatcost number None provided No None provided
Suspend Flow suspendflow boolean 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