MaximomizeMaximomize/
MxScript a vscode extension to manage automation scriptsMxScript a vscode extension to manage automation scripts
Search
MxScript a vscode extension to manage automation scripts

MxScript a vscode extension to manage automation scripts

Created
Dec 7, 2021 01:59 PM
Tags
automation script
Status
Published
Created Date

MxScript

A script manager for IBM Maximo / Control Desk. This allows simple management (upload / download / comparison) of scripts from with in vs code
MxScript - Visual Studio Marketplace
A script manager for IBM Maximo / Control Desk. This allows simple management (upload / download / comparison) of scripts from with in vs code. This was created to help developers using vs code to write scripts extensions for IBM Maximo / ICD. VS code already has excellent support for Java.
MxScript - Visual Studio Marketplace
https://marketplace.visualstudio.com/items?itemName=Rana.mxscript&utm_source=VSCode.pro
MxScript - Visual Studio Marketplace
mxscript/README.md at master · ahmednrana/mxscript
A script manager for IBM Maximo / Control Desk. This allows simple management (upload / download / comparison) of scripts from with in vs code. This was created to help developers using vs code to write scripts extensions for IBM Maximo / ICD. VS code already has excellent support for Java.
mxscript/README.md at master · ahmednrana/mxscript
https://github.com/ahmednrana/mxscript/blob/master/README.md
mxscript/README.md at master · ahmednrana/mxscript

Features

This was created to help developers using vs code to write automation scripts for IBM Maximo / ICD. VS code already has excellent support for Java. See This adds the following four actions to vs code.
  1. Update Script from Server
  1. Compare Script with Server
  1. Upload Script to Server
  1. Download All Scripts from Server

Update Script from Server

Activate

On command palette search and select this option Maximo Scripts: Update Script from Server

Functionality

You must have a saved file opened for this to work. This downloads the updated script from server for the opened tab.
notion image

Compare Script with Server

Activate

On command palette search and select this option Maximo Scripts: Compare Script with Server

Functionality

You must have a saved file open for this to work. This downloaded the updated script for the opened tab.
notion image

Upload Script to Server

Activate

On command palette search and select this option Maximo Scripts: Upload Script to Server

Functionality

You must have a saved file opened for this to work. This uploads the script from the opened tab to the server.
notion image

Download All Scripts from Server

Activate

On command palette search and select this option Maximo Scripts: Download All Scripts from Server

Functionality

This downloads all the scripts from Maximo server to the folder you selected.
notion image

Requirements

You should have access to an instance of IBM Maximo / ICD to manage scripts.

Configuring Object Structure

You must have rights to use an object structure having AUTOSCRIPT as its base object.
ℹ️
There is an object structure MXAPIAUTOSCRIPT created by default. You can use it
If somehow your installation does not have this Object Structure then follow the following steps to create an object structure.
  1. Goto Object Strcutures
  1. Click on New Object Structure
  1. Give it any name e.g. MXAPIAUTOSCRIPT. In Consumed by field enter INTEGRATION
  1. In the source object table click on New Row. Then in that new row select AUTOSCRIPT in object field.
  1. Save
It should be something like below
notion image

Configuring Object Structure Security

See below if your are getting this error
Error 400: BMXAA9301E - The user of the transaction is not authorized for Object Structure {1}. Configure authorization in the object structure application and grant necessary access to the user
You can either turn off authentication for OS Turn Off OS Authorization or grant authorization for that specific OS Grant OS Authorization

Extension Settings

Before using this extension you need to add a few settings. It's easier to edit these settings in Setting UI.
notion image
Other than that you can also edit them in settings.json of your project.
This extension contributes the following settings:
  • mxscript.serverSettings.port: Maximo port. Default is 9080
  • mxscript.serverSettings.httpProtocol: Http protocol. Either http or https
  • mxscript.authentication.username: Username for Maximo Authentication
  • mxscript.authentication.password: Password for Maximo Authentication
  • mxscript.serverSettings.objectStructure: Object Structure to be used scripts uploading / downloading. Default is MXAPIAUTOSCRIPT
  • mxscript.scriptSettings.createPythonFileForJythonScripts: Create Jython script in Maximo even if the file in editor is .py. Helps in intellisense
  • mxscript.scriptSettings.logLevel: The log level to set with scripts when creating / updating them. Possible values are DEBUG,INFO,WARN,ERROR,FATAL. Leave empty to leave them as it is

Known Issues

If you encounter any bug then please open an issue at github repository

Release Notes

First release I have added basic functions to this extension.

0.5.0

Initial release added upload, download, download all and compare with server functions.
Contact Feel free to reach me at linkedin. I would love to connect with fellow Maximo consultants
📢
Note: This is work of third party and not an IBM official extension