Documentation

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

Work Orders / Create

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 Site ID Yes None provided
Report Date reportdate string Report Date Yes None provided
Status Date statusdate string Status Date 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 Parent Work Order Reference No None provided
Affected Phone affectedphone string Affected Phone No None provided
Is This A Task istask boolean Is This A Task No None provided
Task Id taskid string Task Id No None provided
Work Order Priority wopriority string Work Order Priority No None provided
Commodity Group commoditygroup string Commodity Group No None provided
Owner owner string Owner No None provided
Owner Group ownergroup string Owner Group No None provided
Asset Site ID assetsiteid string Asset Site ID No None provided
Class Structure ID classstructureid string Class Structure ID No None provided
Reported Priority Description reportedpriority_description string Reported Priority Description No None provided
Reported Phone reportedphone string Reported Phone No None provided
Reported Email reportedemail string Reported Email No None provided
Store Room Status Description storeroommtlstatus_description boolean Store Room Status Description No None provided
Commodity commodity string Commodity No None provided
Has Solution hassolution boolean Has Solution No None provided
Act Lab Cost actlabcost number Act Lab Cost No None provided
Status Description status_description string Status Description No None provided
Has Children haschildren boolean Has Children No None provided
Include Tasks In Schedule inctasksinsched boolean Include Tasks In Schedule No None provided
Premature Due Date pmduedate string Premature Due Date No None provided
Status status string Status No None provided
Work Order Phone Number phone string Work Order Phone Number No None provided
Internal Priority Description internalpriority_description string Internal Priority Description No None provided
Work Order Is Flow Controlled flowcontrolled boolean Work Order Is Flow Controlled No None provided
Contract contract string Contract No None provided
Org ID orgid string Org ID No None provided
Reported By Name reportedbyname string Reported By Name No None provided
Actual Finish actualfinish string Actual Finish No None provided
Is Known Error isknownerror boolean Is Known Error No None provided
Affected Person affectedperson string Affected Person No None provided
Reported Priority reportedpriority number Reported Priority No None provided
Class class string Class No None provided
Description description string Description No None provided
Actual Labor Hours actlabhrs number Actual Labor Hours No None provided
Site Visit sitevisit boolean Site Visit No None provided
Asset Org ID assetorgid string Asset Org ID No None provided
Long Description description_longdescription string Long Description No None provided
Reason For Change reasonforchange boolean Reason For Change No None provided
Problem Code problemcode string Problem Code No None provided
Affected Date affecteddate string Affected Date No None provided
Asset Number assetnum string Asset Number No None provided
Title Group persongroup string Title Group No None provided
Created On Behalf Of onbehalfof string Created On Behalf Of No None provided
Interruptible interruptible boolean Interruptible No None provided
Estimated labor Cost estlabcost string Estimated labor Cost No None provided
Downtime downtime boolean Downtime No None provided
Who Is This Change For whomischangefor string Who Is This Change For No None provided
Actual labor Cost actoutlabcost string Actual labor Cost No None provided
Estimate labor Hours estintlabhrs string Estimate labor Hours No None provided
Inspector inspector string Inspector No None provided
Failure Code failurecode string Failure Code No None provided
Milestone milestone string Milestone 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
In This Document