maximo-gui-connector 0.7.10

Small Library that makes it easier to create scripts to automate IBM Maximo's frontend

Maximo GUI Connector for Python

A small package that uses Selenium to automate the most basic operations you could do on IBM Maximo Asset Management

Installation

1. Install the package by typing pip install maximo-gui-connector
2. Download the chromedriver (see this note) matching your browser version and put it into PATH

You can import the package into your script and use it like this:

import maximo_gui_connector as MGC

YOUR_USERNAME = ""
YOUR_PASSWORD = ""
YOUR_GROUP = ""

if __name__ == "__main__":
	try:
		maximo = MGC.MaximoAutomation({ "debug": False, "headless": False })
		maximo.login(YOUR_USERNAME, YOUR_PASSWORD)

		maximo.goto_section("changes")
		maximo.setFilters({ "status": "!=REVIEW", "owner group": YOUR_GROUP })

		data = maximo.getAllRecordsFromTable()
		print(data)

		maximo.logout()

	except Exception as e:
		print(e)

	finally:
		print()
		input("Press any key to stop the script and close chrome")

		"""
		So that if the error occurs before the `maximo` object is initialized, 
		`maximo.close()` doesn't throw a `NameError` exception
		"""
		try:
			maximo.close()
		except NameError as e:
			pass

(In)complete Reference

This section is still work in progress, so some properties/methods could miss.

Name	Description
MaximoAutomation(CONFIG)	Instantiates the Maximo object. Takes a dictionary as an argument. Possible configuration: Name Description debug If True, the logger will contain more information useful for debugging purposes. Defaults to False headless If True, the browser will start hidden. Defaults to False url The URL of the Login page (where to input username and password) Defaults to ism.italycsc.com's Maximo login page Example: maximo = MGC.MaximoAutomation({ "debug": False, "headless": True })
login(USERNAME, PASSWORD)	Performs the login using the given credentials
logout()	Performs the logout
goto_section(SECTION_NAME)	Uses the Goto button to change section. It needs to be the text without the "(MP)" part...
close()	Closes the browser. Make sure to always call it after logout() to avoid running out of available sessions in Maximo after a while
waitUntilReady()	Pauses the script until Maximo has finished loading. For example you can use it after changing section or clicking on an element to wait until Maximo has finished rendering or retrieving the data
setFilters(FILTERS)	Sets the filters of a table in the form of a dictionary where the key is the filter name (ex. Summary, in red) and the value is the filter value (ex. "Hostname not reachable", in blue) To set multiple filters just add more key/value pairs. Ex: setFilters({ "Summary": "*Test*", "Priority": "1", "Global Issue?": "Y" })
getBrowserInstance()	Returns the selenium.webdriver instance of the browser so you can have more control or implement custom actions (like clicking on a particular element, inserting text somewhere and more...)
goto_tab(TAB_NAME)	Clicks on the specified tab when inside a record detail (ex. inside an Incident/Change, ecc...)
getAllRecordsFromTable()	Returns a dictionary containing all the details of all the records of a list table (ex. when inside Changes open owned by my groups).
waitForInputEditable()
setNamedInput(TARGETS)	Takes a dictionary as argument and searches inputs labelled by the string given as key; if presen, its value is set to the value of the corresponding pair in the dictionary To set the highlighted fields of the image you would have to call the method like this: setNamedInput({ "New Status:": "NEW_STATUS", "New Owner Group:": "MY_GROUP", })
To be continued...

Known Limitations

By default it uses Chrome

To use another browser, or to set custom flags, you can create your own webdriver instance and pass it to MaximoAutomation to use it. For example:

from selenium.webdriver import Firefox
from selenium.webdriver.firefox.options import Options

import maximo_gui_connector as MGC

opts = Options()
opts.set_headless()

assert opts.headless  # Operating in headless mode

my_webdriver_instance = webdriver.Firefox(options=opts)

maximo = MGC.MaximoAutomation({ "driver": my_webdriver_instance })

This method, however, introduces a new problem:

The Webdriver MUST be in the PATH when using custom Webdriver

To prevent having to download manually the right Webdriver the first time and every time the browser update, you can make use of the webdriver-manager package.

What it does is essentially keep a cached version of the Webdriver check every time if the Webdriver version is the same as the installed browser. If not it downloads it.

To use it:

from selenium import webdriver

# Webdriver Manager
from webdriver_manager.firefox import GeckoDriverManager

import maximo_gui_connector as MGC

# If not 'installed' it will download an updated version of the driver
my_webdriver_instance = webdriver.Firefox(executable_path=GeckoDriverManager().install())

maximo = MGC.MaximoAutomation({ "driver": my_webdriver_instance })