A script manager for IBM Maximo / Maximo Application Suite. 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. see here This adds the following four actions to vs code.
- Update Script from Server
- Compare Script with Server
- Upload Script to Server
- Download All Scripts from Server
On command palette search and select this option
You must have a saved file opened for this to work. This downloads the updated script from server for the opened tab.
On command palette search and select this option
You must have a saved file open for this to work. This downloaded the updated script for the opened tab.
On command palette search and select this option
You must have a saved file opened for this to work. This uploads the script from the opened tab to the server.
On command palette search and select this option
This downloads all the scripts from Maximo server to the folder you selected.
You should have access to an instance of IBM Maximo to manage scripts.
You must have rights to use an object structure having AUTOSCRIPT as its base object.
There is an object structure
MXAPIAUTOSCRIPTcreated by default. Do NOT use it. This will cause issues when uploading scripts to server
If somehow your installation does not have this OS then follow the following steps to create an object structure.
- Goto Object Strcutures
- Click on
New Object Structure - Give it any name e.g.
MXSCRIPT. In Consumed by field enterINTEGRATION - In the source object table click on New Row. Then in that new row select
AUTOSCRIPTin object field. - Save
It should be something like below
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
Before using this extension you need to add a few settings.
Now the extensions allow you add multiple environments and switch between them.
Under the explorer webview there is a section for Maximo Environments
You can easily add multiple environments
Using the buttons displayed over these environments you can activate, edit and delete them as well
There are two types of environments, global or workspace. Global are always available in vscode while the workspace level are only available to the workspace it was created in. They have their own icons.
- Active Environment: Uses the $(radio-tower) icon.
- Global Environment: Uses the $(globe) icon.
- Workspace Environment: Uses the $(symbol-folder) icon.
It's also possible to edit these settings in Setting UI. This only support a single environment
Other than that you can also edit them in settings.json of your project.
This extension contributes the following settings:
| Property Name | Type | Default | Description |
|---|---|---|---|
mxscript.serverSettings.hostname |
string | Hostname / IP of Maximo server (e.g. 10.10.12.12 or www.xyz.com) | |
mxscript.serverSettings.port |
number | Maximo port | |
mxscript.authentication.username |
string | maxadmin | Username for Maximo Authentication |
mxscript.authentication.password |
string | maxadmin | Password for Maximo Authentication |
mxscript.authentication.apikey |
string | API key Maximo Authentication | |
mxscript.authentication.authenticationType |
string | internal | Type of Authentication (internal, ldap, apikey) |
mxscript.serverSettings.objectStructure |
string | MXSCRIPT | Object Structure to be used for scripts uploading / downloading |
mxscript.serverSettings.httpProtocol |
string | http | Http protocol (http or https) |
mxscript.scriptSettings.createPythonFileForJythonScripts |
boolean | true | Create Jython script in Maximo even if the file in editor is .py |
mxscript.scriptSettings.logLevel |
string | The log level to set with scripts when creating / updating them (DEBUG, INFO, WARN, ERROR, FATAL) | |
mxscript.scriptSettings.ignoresslerrors |
boolean | false | Ignore SSL errors |
Using the built in Object Structure MXAPIAUTOSCRIPT will delete the launch points when uploading the script to server. Instead create a new OS with only AUTOSCRIPT as source object. No child objects in it.
Double check the authentication type, user/pass or the api key provided If you encounter any bug then please open an issue at github repository
Added option to add multiple environments using UI
Added option to ignore SSL based errors
Added support for API key
Initial release added upload, download, download all and compare with server functions.
Contact Feel free to reach me at linkedin or Maximomize or wordpress. I would love to meet fellow maximo consultants
Note: This is work of third party and not an IBM official extension