IBM Maximo Developement

Run automation script as cron task in Maximo 7.6+

noreply@blogger.com (Swaroop) — Mon, 20 Apr 2020 04:47:00 +0000

You can use a script to run the cron task by using a Java Class com.ibm.tivoli.maximo.script.ScriptContask in the cron task definition and then attach the automation script to the cron task in parameters. For this script, we don't need a launch point.

Create a script in Automation Scripts application.
Select Action > Create Script
Since it is not having any launch point, you cannot specify bindings to a Maximo Business Object. You can only specify LITERAL, MAXVARS and SYSPROP bindings.
Enter the source code and click on Create.
Go to > System Configuration > Platform Configuration > Cron Task Setup application and search for cron task with class com.ibm.tivoli.maximo.script.ScriptCrontask.
If there is no cron task exists, create a New Cron Task and specify the class as com.ibm.tivoli.maximo.script.ScriptCrontask.
Add a new row in Cron Task Instance section and specify a name, schedule and run as user.
In the Parameters Section specify the SCRIPTNAME, which you have created in Automation Scripts application and SCRIPTARG, which is the argument you want to pass to the script.
SCRIPTNAME is a mandatory field and SCRIPTARG is optional. SCRIPTNAME will be passed to the automation script as scriptName implicit variable.
In the Cron Task Instances section, click on ACTIVE check box and save the record.

Variable in Automation Script for Cron Tasks

Below are the variables that are available in the Automation Script.

scriptName: scriptName refers to the name of the script that is run as Cron Task.
qName: qName refers to the name of the Cron Task instance that is running the Automation Script.
runAsUserInfo: runAsUserInfo returns the psdi.security.UserInfo java object. You can use this variable to get additional information about the user that is associated with the Cron Task Instance.

Maximo search operators

noreply@blogger.com (Swaroop) — Fri, 17 Apr 2020 07:30:00 +0000

Maximo search features are quite advanced but often neglected. By using the advanced search techniques described in this post it is possible to find relevant records easier and faster.

Equal

The equal '=' operator can be used to find only records that match that a word or number exactly. In other words '=' means "exact match".
Example: Enter =123 to find any records with the exact characters 123 in the field. (Search results would not include numbers such as 0123 or 1234AB. If you enter just 123, without the =, search results would include 0123 and 1234AB.)

Not Equal

To search for all values that are not equal to a specific value enter '!='.
For example, typing !=WAPPR in the status field will retrieve all records that are not in WAPPR status.

Greater/Less

The '<' and '>' characters can also be used to search for records that are bigger or smaller than a specific value.

Greater than '>': searches for any date after or number/word greater than the specified value.
Example: Enter >1172 finds records of occurrences that have work order number greater than 1172.
Less than '<': searches for any date before or number/word smaller than the specified value.
Example: Enter <1172 finds records of occurrences that have work order number smaller than 1172.

List of values

You can use comma ',' operator to list the records that match with either of the values specified. It basically acts as the OR operator.
For example, typing WAPPR,COMP in the status field will retrieve all records that are in WAPPR or COMP status .

Wildcards

You can use a "wildcard" characters with letters or numbers to indicate you want to find records that begin with, end with, or contain those letters/numbers.
There are four characters you can use as a wildcard:

Asterisk '*' or percent sign '%': stand for any number of characters (zero, one, or multiple) in the specified position.
Example: Enter 123* to find records that start with 123, such as 123, 12345, 123ABC.
Example: Enter *123 to find records that end in 123, such as 123, 5123, PUMP123.
Example: Enter *123* to find records that contain 123, such as 123, 1234, PUMP123xy.
Underscore '_' or question mark '?': stand for a single character in the specified position.
Example: Enter 123_ to find any four character records that start with 123, such as 1234, 1230, 123g.
Example: Enter or _18 to find any three character records that end with 18, such as 418, J18.

NULL Values

You can search for null and not null values by entering the following values into a search field on the Find tab:

To search for a null value enter: ~null~
To search for not null values enter: != ~null~

If your keyboard does not have the tilde '~' character you may type enter this character by typing 126 on your numeric keypad while pressing the 'Alt' key.

Dates

A small additional tip for searching dates in the current month.
If you want to search for WO's with scheduled start date less than today, you don't need to type or select the whole date into the search field because Maximo automatically appends the current month and year in the where clause.
For example, if you search with <15, system will return all WO's where scheduled start date before the 15th of the current month.

Types of Automation Script

noreply@blogger.com (Swaroop) — Thu, 16 Apr 2020 03:40:00 +0000

Below are the Scripts with events you can create in Maximo 7.6+

Type of Automation Scripts		Events
Script with Standard Launch Point	Object Launch Point	Initialize Value	Validate Application	Allow Object Creation	Allow Object Deletion	Save
						Before Save After Save After Commit
	Attribute Launch Point	Initialize Access Restriction	Initialize Value	Validate	Retrieve List	Run Action
	Action Launch Point
	Custom Condition Launch Point
Integration Script	Object Structure	Inbound Processing	Outbound Processing		Query Clause	Action Processing
	Publish Channel	External Exit		User Exit		Event Filter
	Enterprise Services	Request			Response
		External Exit	User Exit		External Exit	User Exit
			Before External Exit	After External Exit		Before External Exit	After External Exit
	Invocation Channel	Request			Response
		External Exit	User Exit		External Exit	User Exit
			Before External Exit	After External Exit		Before External Exit	After External Exit
Script without Launch Point	Cron Task
	End Point Script
	Script for web services
	Reusable Library Scripts

Automation Script Implicit Variables Explained

noreply@blogger.com (Swaroop) — Tue, 14 Apr 2020 14:04:00 +0000

There are certain variables provided by the framework. These variables are not necessary to be declared before using. Some of these variables are valid only for specific launch point or a particular event. For example: user is valid for all the launch point where as mboset is valid only for Object launch point allow object creation event.

There are two types of implicit variables. Those which are not associated with any other variables and are used directly in the script and those which has to be associated with the variables. Lets get into the details.

i. Implicit variables which are not associated with any other variables.

mbo	evalresult	listWhere	onadd
user	launchPoint	listOrder	onupdate
mboname	scriptName	listErrorGroup	ondelete
mbovalue	errorgroup	listErrorKey	domainid
app	errorkey	relationObject	srcKeys
thisvalue	params	relationWhere	targetKeys
user	service	requestData	wfinstance
userinfo	action	responseBody	request
interactive	scriptHome	runAsUserInfo	qName

mbo

Type: psdi.mbo.Mbo

Launch point: All Launch Point

Event: All

Script: Scripts associated with launch point/event mentioned above.

Details: mbo refers to the Mbo that is being worked on.

Exception: mbo does not work with an object launch point for a non-persistent object.

mboset

Type: psdi.mbo.MboSet

Launch point: Object Launch point

Event: Allow Object Creation / Allow Object Deletion

Script: Scripts associated with launch point/event mentioned above.

Details: mboset refers to MboSet to which the Mbo will be added to. We can also get the set by using mbo.getThisMboSet()

Example: If we create a launch point for PRLINE on Object Creation, when adding a new line in the PR, mboset will get the MboSet for that PR only.

mboname

Type: String

Launch Point: All Launch Points

Event: All

Script: Scripts associated with launch point/event mentioned above.

Details: mboname indicates the name of the current Mbo that is being worked on. We can also get the name by using mbo.getName(). This will be useful when we are writing multiple launch points with the same script.

mbovalue

Type: psdi.mbo.MboValue

Launch Point: Attribute Launch Point

Event: All

Script: Scripts associated with launch point/event mentioned above.

Details: mbovalue indicates the instance of the Mbo Attribute for the attribute launch point.

Example: If the Launch point is on an attribute of type ALN then the type of mbovalue will be psdi.mbo.MboALNValue, similarly if the attribute is DATETIME then mbovalue will be psdi.mbo.MboDATETIMEValue.

app

Type: String

Launch Point: All Launch Points

Event: All

Script: Scripts associated with launch point/event mentioned above.

Details: app indicates the name of the application the script is running against.

Condition: app only works if the object of the launch point is the main object of the application. If the launch point object is a child of main object, app will return null value.

Alternative: To get the app name you have the get the main object of the application and use the getApp() on the mbo as mbo.getApp().

Example: If the launch point is on WOACTIVITY then you need to use mbo.getOwner().getApp(). Here getOwner method on the mbo will return the WORKORDER object and getApp on the WORKORDER will return WOTRACK if the application is Work Order Tracking. If getApp() is used on WOACTIVITY in the WOTRACK Application it will return null value.

thisvalue

Type: Mbo Attribute for attribute launch point

Launch Point: Attribute Launch Point

Event: init value and init access restriction

Script: Scripts associated with launch point/event mentioned above.

Details: thisvalue represents current attribute in the Launch Point. Used to set the value in the init value event and can be used together with explicit variables for use access restriction such as hidden, read-only, required

user

Type: String

Launch point: All Launch Point

Event: All

Script: Scripts associated with launch point/event mentioned above.

Details: user refers to the user id who is logged in. We can get the value for the user logged in but cannot modify the value.

userinfo

Type: psdi.security.UserInfo

Launch point: All Launch Point

Event: All

Script: Scripts associated with launch point/event mentioned above.

Details: userinfo provides the UserInfo object for the current context.

Example: You may use this variable to get the person information etc.

Alternative: To get the UserInfo you may use mbo.getUserInfo().

interactive

Type: Boolean

Launch point: All Launch Point

Event: All

Script: Scripts associated with launch point/event mentioned above.

Details: interactive indicates whether is script is running in an active user session or a background session such as integration, cron task etc.

evalresult

Type: Boolean

Launch point: Custom Condition Launch Point

Event: NA

Script: Scripts associated with launch point/event mentioned above.

Details: Set the value of evalresult to True or False. Condition script will return this value when executed.

Example: Once you create a custom condition launch point you can create a condition in condition expression manager. This condition can be used in many places in Maximo such as Conditional UI properties in Application designer, Workflows, Domain conditions etc.

launchPoint

Type: String

Launch point: All Launch Points

Event: All

Script: Scripts associated with launch point/event mentioned above.

Details: launchPoint indicates the name of the launch point in which the script is run.

scriptName

Type: String

Launch point: All Launch Points

Event: All

Script: Scripts associated with launch point/event mentioned above. This can also be used in script for Cron Task.

Details: scriptName indicates the name of the script that is running.

errorgroup

Type: String

Launch point: All Launch Points

Event: All

Script: Scripts associated with launch point/event mentioned above.

Details: errorgroup defines the message group defined in the database configuration application. Together with errorkey variable it identifies the message that has to be displayed. You can also use the implicit variable params if the message requires and parameters to be passed.

Alternative: service.error() can be used instead of errorgroup and errorkey variable to display error message.

errorkey

Type: String

Launch point: All Launch Points

Event: All

Script: Scripts associated with launch point/event mentioned above.

Details: errorkey defines the message key defined in the database configuration application. Together with errorgroup variable it identifies the message that has to be displayed. You can also use the implicit variable params if the message requires and parameters to be passed.

Alternative: service.error() can be used instead of errorgroup and errorkey variable to display error message.

params

Type: String[]

Launch point: All Launch Points

Event: All

Script: Scripts associated with launch point/event mentioned above.

Details: params holds the parameters to be applied for the message that is posted in the script. params is used together with the errorgroup and errorkey to prepare the error message that is posted in the script. params is a string array and is set in the script.

Alternative: service.error(<message_group>,<message_key>,<parameter_array>) can be instead of errorgroup, errorkey and params.

service

Type: com.ibm.tivoli.maximo.script.ScriptService

Launch point: All Launch Points

Event: All

Script: Scripts associated with launch point/event mentioned above.

Details: Added to the script by the framework during run-time.

action

Type: String

Launch point: Action Launch Point

Event: NA

Script: Scripts associated with launch point/event mentioned above.

Details: action indicates name of the action that is calling the script.

scriptHome

Type: psdi.mbo.Mbo

Launch point: Action Launch Point

Event: NA

Script: Scripts associated with launch point/event mentioned above.

Details: References the Mbo that is worked on. Preference is to use mbo in the script instead of scriptHome

onadd

Type: Boolean

Launch point: All Launch Points (Ideally used in Object launch point where the script applied to multiple events such as add, update, delete)

Event: All

Script: Scripts associated with launch point/event mentioned above.

Details: onadd indicates whether the script is running against the Mbo that is to be added. onadd can be used to perform conditional validation or action that is based on the state of Mbo.

Alternative: mbo.toBeAdded() can be used instead of onadd. Preference is to use onadd.

onupdate

Type: Boolean

Launch point: All Launch Points (Ideally used in Object launch point where the script applied to multiple events such as add, update, delete)

Event: All

Script: Scripts associated with launch point/event mentioned above.

Details: onupdate indicates whether the script is running against the Mbo that is being updated. onudpate can be used to perform conditional validation or action that is based on the state of Mbo.

Alternative: mbo.toBeUpdated() can be used instead of onupdate. Preference is to use onupdate.

ondelete

Type: Boolean

Launch point: All Launch Points (Ideally used in Object launch point where the script applied to multiple events such as add, update, delete)

Event: All

Script: Scripts associated with launch point/event mentioned above.

Details: ondelete indicates whether the script is running against the Mbo that is being deleted. ondelete can be used to perform conditional validation or action that is based on the state of Mbo.

Alternative: mbo.toBeDeleted() can be used instead of ondelete. Preference is to use ondelete.

domainid

Type: String

Launch point: Attribute Launch Point

Event: Retrieve List

Script: Scripts associated with launch point/event mentioned above.

Details: domainid specifies the domain that is used to provide the list of values to be shown for the attribute.

listWhere

Type: String

Launch point: Attribute Launch Point

Event: Retrieve List

Script: Scripts associated with launch point/event mentioned above.

Details: listWhere specifies the where filter that is set before the result are shown.

listOrder

Type: String

Launch point: Attribute Launch Point

Event: Retrieve List

Script: Scripts associated with launch point/event mentioned above.

Details: Set to any ORDER BY attribute names that are used to order the results of the retrieve list event.

listErrorGroup

Type: String

Launch point: Attribute Launch Point

Event: Retrieve List

Script: Scripts associated with launch point/event mentioned above.

Details: listErrorGroup identifies message group created in the database configuration application. The error will be displayed when the retrieve list event fails. listErrorGroup should be used together with listErrorKey.

listErrorKey

Type: String

Launch point: Attribute Launch Point

Event: Retrieve List

Script: Scripts associated with launch point/event mentioned above.

Details: listErrorKey identifies message key created in the database configuration application. The error will be displayed when the retrieve list event fails. listErrorKey should be used together with listErrorGroup.

relationObject

Type: String

Launch point: Attribute Launch Point

Event: Retrieve List

Script: Scripts associated with launch point/event mentioned above.

Details: relationObject refers to the Mbo that is being searched from the current Mbo. Typically used together with srcKeys and targetKeys implicit variables.

relationWhere

Type: String

Launch point: Attribute Launch Point

Event: Retrieve List

Script: Scripts associated with launch point/event mentioned above.

Details: relationWhere is the where clause applied to the Mbo that is being searched from the current Mbo to perform retrieve list event. Typically used together with srcKeys and targetKeys implicit variables.

srcKeys

Type: String[]

Launch point: Attribute Launch Point

Event: Retrieve List

Script: Scripts associated with launch point/event mentioned above.

Details: Applies to the set of attribute names from the current MBO that is used to lookup a related record in another related or target MBO. For example, the set of attribute names from the current MBO might be used to look up that FAILURECODES field from the ASSET business object.

targetKeys

Type: String[]

Launch point: Attribute Launch Point

Event: Retrieve List

Script: Scripts associated with launch point/event mentioned above.

Details: Applies to the set of attribute names in the target MBO that is looked up from the current MBO on which the attribute launch point is defined.

wfinstance

Type: psdi.workflow.WFInstance

Launch point: Action Launch Point

Event: Action started from a workflow

Script: Scripts associated with launch point/event mentioned above.

Details: wfinstance indicates the workflow instance from which the current action was started.

qName

Type: String

Launch point: NA

Event: NA

Script: Scripts that are running as Cron Task.

Details: qName returns the name of the Cron Task Instance that is running the script.

runAsUserInfo

Type: String

Launch point: NA

Event: NA

Script: Scripts that are running as Cron Task.

Details: runAsUserInfo returns the psdi.security.UserInfo java object. You can use this variable to get additional information about the user that is associated with the Cron Task Instance.

Show the Username and Default Insert Site in the Maximo header

noreply@blogger.com (Swaroop) — Sat, 01 Feb 2020 13:25:00 +0000

Goal:
To show the logged-in user information such as name and default insert site in the header of the Maximo 7.5.x application.

Problem:
When working in multi site environment the user must have the Default Insert site set to the site he wants to create a new record for some site level Maximo applications (e.g. assets, location, workorder etc.).

User can find this information through a menu, It would good and reduce time if this information is displayed in the header always.

Solution:

Step 1 - Locate the file (titlebar.jsp)

We need to modify titelbar.jsp

We can find this file in the below path

\IBM\SMP\maximo\applications\maximo\maximouiweb\webmodule\webclient\components

Note: Make a copy of this file (just in case something goes wrong)

Modify the titlebar.jsp

String userFullName = control.getWebClientSession().getUserInfo().getDisplayName();

Enter the following lines:

String defSite= "";

try
{
defSite= control.getWebClientSession().getUserInfo().getInsertSite();
}
catch(Exception ex)
{
defSite="Unknown";
}

In essention I create a variable that is empty. I try to get the user his InsertSite and put that in the variable. If no InsertSite exists I fill the variable with the text "Unknown"

Here a picture of the first change:

Then find the following block of code(original line number 130) :

<td style="vertical-align:<%if(useHomeButton){%>middle<%}else{%>top<%}%>;white-space: nowrap;">

homeButton<%}%>txtappname">

<%=apptitle%>

</td>

Enter the following code after the code found above:

User: <%=userFullName%>

Insert Site: <%=defSite%>

</td>

Here I add the code to set the new variable on the screen, I also show the userFullName variable here in order to show the user his full name.

Here is a picture of the modification:

Next rebuild the maximo.ear and redeploy the Maximo application.

After loggin in to Maximo you should see the username and default insert site in the header. Could be that your browser has cached some headerinformation, always try a hard refresh (CTRL + F5) if nothing shows up.

It should end up looking like this (I changed the name for privacy reasons):

It looks like itis show twice, but that is only on the start screen. When opening the Workorders application for example you will see the second mention of the name is useful:

Find attachments in DOCLINKS for each record

noreply@blogger.com (Swaroop) — Tue, 18 Sep 2018 00:30:00 +0000

This post explains how to extract the list of attachments attached to a record.

Unfortunately, from the file names you cannot understand to which records each file is linked to. In order to do this you have to run an SQL query. In this example I'm showing how to get all the file names of work orders attachments.

SELECT
    wo.wonum,
    di.document,
    di.description,
    di.urlname
FROM
    docinfo di
    JOIN doclinks dl ON dl.docinfoid = di.docinfoid
    JOIN workorder wo ON wo.workorderid = dl.ownerid
WHERE
    dl.ownertable = 'WORKORDER'
    AND   wo.wonum =:wonum;

From the above query you will get the file path in urlname column. You can extract the file from the server in those path.

Note: The files will be there in the server where the webserver is installed. If there are more than one webserver and a load balancer is used to redirect to these webservers, there should be a shared folder shared between the webservers.

How to get current month records since first date in database query?

noreply@blogger.com (Swaroop) — Mon, 17 Sep 2018 16:46:00 +0000

To get the records for the current month since day one of current month you may use the below where clause.

DB2:

WHERE ENTERED_DATE BETWEEN CURRENT DATE - (DAY(CURRENT DATE) - 1) DAYS AND CURRENT DATE;

WHERE ENTERED_DATE BETWEEN SYSDATE - (DAY(SYSDATE) - 1) DAYS AND SYSDATE;

Oracle:

WHERE ENTERED_DATE BETWEEN TRUNC(SYSDATE, 'mm') AND SYSDATE;

WHERE ENTERED_DATE BETWEEN TRUNC(SYSDATE, 'month') AND SYSDATE;

How to create a custom Auto-Number for attribute in Maximo

noreply@blogger.com (Swaroop) — Thu, 13 Sep 2018 00:50:00 +0000

Follow the below steps to add autonumber for the attribute and add seed and key to the autonumber.

Create Auto-Number for the Attribute:

Open the Database configuration from GO TO > System configuration > Platform configuration and select the object you want to use automatic numbering.
Select the Attributes tab, click the new line, and specify a unique attribute name.

Please check Can Autonumber? checkbox. And confirm that the Autonumber field becomes editable.

Please specify the name of existing autonumber or new autonumber. If you specify a name for a new autonumber, you will be asked that the autonumber does not exist, would you like to create it?, select OK and save the record.

You will now be able to use this Autonumber.

To Default the autonumber for the attribute, use the default value in the attribute as &AUTOKEY& and save the record.

Adding Seed and Prefix for the attribute:

In the organization application, this Autonumber can be selected and add seeds and prefixes as necessary.

Please select your organization.

From the Select Action Menu, select "Autonumber Setup" and select the level for which automatic numbering is to be set.

Select the corresponding aAutonumber, or select "New line" to set automatic numbering to the corresponding level.

Please add a seed or prefix and save.

Deleting a user-created application in Maximo

noreply@blogger.com (Swaroop) — Thu, 06 Sep 2018 03:30:00 +0000

You must use a database editor such as SQL Developer, DB Visualizer etc to delete the user created application.

Before you begin
You must shut down the application server. If you delete an application, it will not to remove any custom tables, fields, or domains that you created to support the application.

Steps:

1. Log in to a database editor and connect to the database where the Maximo is running.
2. Enter the following commands, and replace the variable :appname with the name of the application you want to delete. Enter the application name in all uppercase.
For example, if the name of the application you want to delete is TEST, replace :appname with TEST in all the below sql queries.

delete from maxapps where app=:appname;
delete from maxpresentation where app=:appname;
delete from sigoption where app=:appname;
delete from applicationauth where app=:appname;
delete from maxlabels where app=:appname;
delete from maxmenu 
    where (menutype='MODULE' and elementtype='APP' and keyvalue=:appname) 
    or (menutype !='MODULE' and moduleapp=:appname);
delete from appdoctype where app=:appname;
delete from sigoptflag where app=:appname;
commit;

3. Logout of the database editor and start the application server.

SCCD 7.5 and Maximo 7.6 user interface System Properties

noreply@blogger.com (Swaroop) — Tue, 18 Jul 2017 22:05:00 +0000

SmartCloud Control Desk 7.5 and Maximo 7.6 have introduced new UI skins and navigation behavior.

There are four new System Properties which control the left navigation pane and other related visual attributes.

mxe.webclient.homeButtonHeaders - Moves Goto menu to left of the screen and adds Start Center button to the header
mxe.webclient.systemNavBar - Enables the lefthand navigation
mxe.webclient.tabBreadCrumbs - Removes tabs from list view
mxe.webclient.verticalLabels - Sets label above each input field

The skin can be selected setting the mxe.webclient.skin property: tivoli09 is the default 7.5 skin, tivoli13 is new skin.

Implicit Variables in Maximo Automation Scripts

noreply@blogger.com (Swaroop) — Mon, 15 May 2017 13:21:00 +0000

Implicit variables are those variables which need not be defined separately in the script. Some of the variables can be used directly ex: app, user, mbo. Some need to be associated with other variables we declare, ex: var_required (var is the user defined variable)
Below are the list of some of the implicit variables.

Name	Type	Description	Availability
app	String	Name of the Maximo application where the script is executing	All the launchpoints
mbo	psdi.mbo.Mbo	Current Mbo in the context of script execution. In case of Object LP it is the object in which the script is executed. In case of Attribute launchpoint it is the owner of the attribute in which the script is executed. In case of Action launchpoint it is same as the escalation or the workflow object.	All the launchpoints
mboname	String	Name of the current mbo in the context of script execution	All the launchpoints
user	String	Name of the user whose action initiated the script	All the launchpoints
errorkey	String	This is used to throw MXExceptions this works with errorgroup and params implict variables	All the launchpoints
errorgroup	String	This one points to the errorgroup of the MXException. Along with the errorkey it helps uniquely point to an error message	All the launchpoints
params	String[]	This is the parameters of the MXException	All the launchpoints
interactive	boolean	Indicates whether the script is running in an active user session or a non-user background session such as integration transaction/cron task.	All the launchpoints
evalresult	boolean	The boolean variable of type OUT to indicate the result of the condition evaluation.	Only custom condition launchpoint
onadd	boolean	This boolean variable indicates whether the mbo in the script being added	All launchpoint
ondelete	boolean	This boolean variable indicates whether the mbo in the script being deleted	All launchpoint
onupdate	boolean	This boolean variable indicates whether the mbo in the script being updated	All launchpoint
action	String	Name of the action that generates	Action launchpoint
scriptName	String	Name of the script being run	All launchpoint
launchPoint	String	Name of the launchpoint for the corresponding script being run	All launchpoint
scriptHome	psdi.mbo.Mbo	Refers to the mbo that is currently being worked on.	Action launchpoint
wfinstance	psdi.workflow.WFInstance	Indicates the workflow from which the current action was started	Action launchpoint (only when the action is launched fromteh workflow)

Below are some of the variables which can be used only after associating with the user defined variables:

Name	Type	Description	Availability
var_hidden	boolean	Retrives or sets the hidden flag to the business object attribute	All launchpoint
var_initial	Same as the variable	Provides the initial value for an attribute retrieved from the MBO	All launchpoint
var_internal	Same as the variable	Provides the internal value for a SYNONYMDOMAIN entry	All launchpoint
var_modified	boolean	Provides a flag that indicates whether the value for an attribute was modified	All launchpoint
var_required	boolean	Sets the required flag for the defined attribute	All launchpoint
var_readonly	boolean	Sets the read-only flag for the defined attribute	All launchpoint
var_previous	Same as the variable	Provides the previous value for an attribute retrieved from the MBO	Attribute launchpoint (only for the attribute that generated)

Please leave below comments if you need any help regarding variables.

Maximo Keyboard shortcuts

noreply@blogger.com (Swaroop) — Fri, 12 May 2017 13:28:00 +0000

You can use a combination of keys to perform an action without using a mouse.

You can navigate among and within the applications by using a combination of keys. You can use the following keyboard shortcuts to navigate the application screens.

Keyboard shortcuts for general navigation

Action	Keyboard shortcut
Move from one interface element to the next.	Tab key
Select buttons, links, and menu options.	Enter key
Select or clear a check box.	Spacebar
Display field help for field in focus.	Alt+F1

Keyboard shortcuts for global navigation

Link name	Keyboard shortcut
Bulletins	Alt+B
Go To	Alt+G
Reports	Alt+R
Start Center	Alt+C
Profile	Alt+P
Sign Out	Alt+S
Help	Alt+H
Return	Alt+R
Return with Value	Alt+W

Keyboard shortcuts for application-specific actions

Action	Applications	Keyboard shortcut
Assign Labor	Assignment Manager	Ctrl + Alt + L
Finish Assignment	Assignment Manager	Ctrl + Alt + F
Interrupt Assignment	Assignment Manager	Ctrl + Alt + U
Select Work Date	Assignment Manager	Ctrl + Alt + W
Start Assignment	Assignment Manager	Ctrl + Alt + T
Start Timer	Activities, Changes, Incidents, Problems, Releases, and Service Requests	Ctrl + Alt + B
Stop Timer	Activities, Changes, Incidents, Problems, Releases, and Service Requests	Ctrl + Alt + E

Keyboard shortcuts for toolbar actions
Action	Keyboard shortcut
Insert New Record	Ctrl+Alt+I
Save Record	Ctrl+Alt+S
Clear Changes	Ctrl+Alt+C
Previous Record	Ctrl+Alt+P
Next Record	Ctrl+Alt+N
Change Status	Ctrl+Alt+A
Create KPI	Ctrl+Alt+K
Put record in edit mode or release record from edit mode	Ctrl+Alt+L

Keyboard shortcuts for tables
Action	Keyboard shortcuts
Next Row	Ctrl+ ↓
Previous Row	Ctrl+ ↑
Open/Close Table Window Filter	Ctrl+Z
Next Page	Ctrl+→
Previous Page	Ctrl+←

Keyboard shortcuts for Calendar
Action	Keyboard shortcuts
Insert today's date	Ctrl+SHIFT+7
Move forward one day	Alt + ↑
Move back one day	Alt + ↓
Move forward one month	Ctrl+Shift+0
Move back one month	Ctrl+SHIFT+9
Move forward one year	Ctrl+SHIFT+ ↑
Move back one year	Ctrl+SHIFT+ ↓

Show current status memo for records in Maximo

noreply@blogger.com (Swaroop) — Sat, 04 Mar 2017 03:30:00 +0000

Objective:

To display the status memo of the current status in record.

For any object having status functionality the status history is tracked in different table, for example Work Order status will be tracked in WOSTATUS table.

To display the memo entered for the current status in the application can be done using relationships and application designer application.

Example:

Display current PO status memo in PO application.

Steps:

Create a relationship from PO to POSTATUS with where clause as below:
Name of the relationship: CURRENTSTATUS
```
ponum = :ponum and siteid = :siteid 
and status = :status and changedate = :statusdate
```
In the application designer for PO application add the attribute and give the attribute value as CURRENTSTATUS.MEMO, where CURRENTSTATUS is the relationship name from PO to POSTATUS.

How to add custom fields in result set portlet in Maximo 7.6

noreply@blogger.com (Swaroop) — Fri, 03 Mar 2017 05:14:00 +0000

Result Set functionality has been enhanced in Maximo 7.6 to use dot notation/joined attribute through relationship.

You can configure the result set portlet by using the Report Object Structure (ROS) Configured in Object Structures Application.

Steps:

Go To > Integrations > Object Structure
Click on New Object Structure.
Give the object structure name and give REPRORTING for Consumed by.
Add the objects in the Source Objects section, give the appropriate relationship between the objects.
Save the Object Structure.
Select Action > Set Report Object Structure Security
Add the maxadmin security group.
Create a new Result set portlet in the start center
Click on edit button
Select the Application and Query saved in the application.
You can see the object list from the ROS created in Step 2 and you can choose attributes including any relationship attributes.

Once the Result set configuration is complete you can see the records in the RS portlet.

Note: To create/edit the Result Set and choose the fields you want to include you may need to update the webclient.resultset.relatedattributes system property to 1.

How to add toolbar icons in Maximo 7.6

noreply@blogger.com (Swaroop) — Wed, 01 Mar 2017 03:00:00 +0000

In Maximo 7.6 with left navigation enabled only few icons appear on the toolbar.

To add a new icon to the toolbar follow the below steps:

Go To > System Configuration > Platform Configuration > System Properties
Filter for the property 'mxe.webclient.showOnToolbar'
For Example to add Change Status icon in the toolbar within the Global Properties for mxe.webclient.showOnToolbar property add 'STATUS' separated by comma at the end of the global value.
Click on Save
Click on the check box to the left of the mxe.webclient.showOnToolbar property and click on live refresh.
Click OK on the live refresh dialog box to save the changes.

Check the application to the new icon added.

Yes No Exception Handling in Maximo 7.6 Automation Script (Gathering User Input)

noreply@blogger.com (Swaroop) — Tue, 28 Feb 2017 08:25:00 +0000

A company requires to send email to the owner of work order when the highest priority is set in the work order priority. An automation script is used to send this email. The automation script uses a choice that confirms to email should be sent.

Steps:

In the database configuration application, from the select action Messages create a new message with following values:

Message Group: workorder
Message Key: wopriorityemail
Display Method: MSGBOX
Message ID Prefix: BMXZZ
Message ID Suffix: W
Display ID: 1
Value: Work Order owner can be notified through email when priority {0} is set. Send email?
Buttons: Yes, No
In the Automation Scripts application, create an attribute launch point with the following options:

Object: WORKORDER
Attribute: WOPRIORITY
Event: Run Action
Log Level: Debug
Enter the following code and create the automation script:

from psdi.server import MXServer

# Logic to implement when user clicks YES
def yesAction ():
    service.log("Sending Email")
    MXServer.sendEMail(<To Email>,<From Email>,<Subject> ,<Body>)

# Logic to implement when user clicks NO
def noAction ():
    service.log("Not Sending Email")

# Logic to present the choice message initially
def defaultMsg ():
    params=[str(priority)]
    # Use the service utility's yncerror() method to push the choice message
    service.yncerror("workorder", "wopriorityemail",params);

# Declaring the user input choices and the corresponding functions
cases = {service.YNC_NULL:defaultMsg,service.YNC_YES:yesAction,service.YNC_NO:noAction}

# Make sure the choice message is presented only 
#if the field validation was triggered from user interface
if interactive:
    if priority < 2:
        # Use the service utility's yncuserinput() method to trigger the interaction
        # User's response is stored in a local variable userChoice
        userChoice = service.yncuserinput()
        # Process the user input using Python's case statement
        cases[userChoice]()

How to pull a value through relationship in result set portlet in start center?

noreply@blogger.com (Unknown) — Mon, 27 Feb 2017 11:23:00 +0000

For selecting columns to display in the result set portlet we'll get the list of persistent attributes for the object that the query is based on.
This attribute list will be present in RESULTSETCOLS table. We will not get the related attributes by default.

To add a related attribute we've to prepare and execute an insert statement in the database. (See example below)

Example:
You need to see buyer name in result set portlet configured with query based on Purchase Orders (PO) application.
Buyer name will be there in PERSON table, we need to create a relationship in PO object with PERSON as child object (say: BUYER) where clause for the relationship will be personid=:purchaseagent
To see BUYER.DISPLAYNAME in the result set columns execute the below query.

Oracle:
insert into resultsetcols (app, attribute, maintable, resultsetcolsid ,rowstamp)
values ('PO', 'BUYER.DISPLAYNAME', 'PO', resultsetcolsseq.nextval, maxseq.nextval);

DB2:
insert into resultsetcols (app, attribute, maintable, resultsetcolsid)
values ('PO', 'BUYER.DISPLAYNAME', 'WORKORDER', nextval for resultsetcolsseq);

update maxsequence
set maxreserved=(select max(resultsetcolsid) from resultsetcols)
where tbname='RESULTSETCOLS' and name='RESULTSETCOLSID';

SQS (Microsoft SQL Server):
insert into resultsetcols (app, attribute, maintable, resultsetcolsid)
values
('PO', 'BUYER.DISPLAYNAME', 'WORKORDER', resultsetcolsseq.nextval);

What is REORDERMUTEX table

noreply@blogger.com (Swaroop) — Fri, 24 Feb 2017 08:12:00 +0000

The REORDERMUTEX table is a locking mechanism to make sure no two users are running a Material Request, Direst Issue or Storeroom Reorder at the same time.
The REORDERPAD table is a temporary data holder to collect item information for the Reorder process.
After the Reorder process is done, data will be left in ReorderPad.
When the next Reorder is run by the same user, data will be removed from ReorderPad.
If you are sure no Reorder is running currently, you could delete data from these two tables.

Concatenate two fields using automation script

noreply@blogger.com (Swaroop) — Wed, 22 Feb 2017 10:26:00 +0000

Goal:
To create an automation script in Maximo 7.5 that combines two fields into a new field and is triggered by the change of one of the fields.

Example:
I have two fields in my application and want to combine those fields into one new field.

One field on the record contains a project number (say: PROJECTNUM) and the other field contains a number unique for that project (say: PROJECTID). The unique identifier for the record should be the project number + number (say: PROJECTUID).

Launch Point Type: Attribute Launch Point
Attribute: PROJECTNUM / PROJECTID
Code:

from psdi.mbo import MboConstants
projectNum = mbo.getString("PROJECTNUM")
projectID = mbo.getString("PROJECTID")
projectUID = projectNum + projectID
mbo.setValue("PROJECTUID",projectUID, MboConstants.NOACCESSCHECK)

Set default value through relationship

noreply@blogger.com (Swaroop) — Wed, 25 Nov 2015 20:30:00 +0000

Goal: Populate the storeroom in Work order actuals (Materials section) from the person's default storeroom.

Solution:

Create a relationship from MATUSETRANS to MAXUSER.

Relationship: LOGGEDIN_USER
Child Object: MAXUSER
Where Clause: :&PERSONID& = personid

Give the default value for STORELOC attribute as ':LOGGEDIN_USER.DEFSTOREROOM'
Save the record.
Run the database configuration from select action in the list view of 'Database Configuration' application.
Note: This change don't require admin mode as it is a not structural change.

Apply Configuration Changes from Select Action

Start Configuring the Database

Database configuration is complete.

Testing:

Click on Profile on the top right corner. Select Default Information option, enter the default storeroom value in "Default Storeroom for Self-Service Requisitions" field.
Note: The User should have access to issue items from the given Storeroom.
Create a Work order and approve it. Go to Actuals tab, in the Materials section click on New row. The default storeroom given in the profile will be populated.

Database query to find the application access level

noreply@blogger.com (Swaroop) — Wed, 25 Nov 2015 04:30:00 +0000

If we have to check the access level to applications for a particular security group/user, it would be time consuming to look in the UI.

Below is the query to check the READ, INSERT, SAVE & DELETE permission to applications for a security group.

SELECT APPLICATIONAUTH.GROUPNAME,
       MAXAPPS.DESCRIPTION,
       MAX(CASE WHEN (OPTIONNAME IN 'READ') THEN 1 ELSE 0 END) AS READ_ACCESS,
       MAX(CASE WHEN (OPTIONNAME IN 'SAVE') THEN 1 ELSE 0 END) AS SAVE_ACCESS,
       MAX(CASE WHEN (OPTIONNAME IN 'INSERT') THEN 1 ELSE 0 END) AS NEW_ACCESS,
       MAX(CASE WHEN (OPTIONNAME IN 'DELETE') THEN 1 ELSE 0 END) AS DELETE_ACCESS
FROM APPLICATIONAUTH
INNER JOIN MAXAPPS ON MAXAPPS.APP = APPLICATIONAUTH.APP
WHERE OPTIONNAME IN ('READ',
                     'SAVE',
                     'INSERT',
                     'DELETE')
  AND GROUPNAME = <group_name>
GROUP BY APPLICATIONAUTH.GROUPNAME,
         MAXAPPS.DESCRIPTION
ORDER BY GROUPNAME;

Slightly modified query to check READ, INSERT, SAVE & DELETE permission to applications for a particular user.

SELECT MAXAPPS.DESCRIPTION,
       MAX(CASE WHEN (OPTIONNAME IN 'READ') THEN 1 ELSE 0 END) AS READ_ACCESS,
       MAX(CASE WHEN (OPTIONNAME IN 'SAVE') THEN 1 ELSE 0 END) AS SAVE_ACCESS,
       MAX(CASE WHEN (OPTIONNAME IN 'INSERT') THEN 1 ELSE 0 END) AS NEW_ACCESS,
       MAX(CASE WHEN (OPTIONNAME IN 'DELETE') THEN 1 ELSE 0 END) AS DELETE_ACCESS
FROM APPLICATIONAUTH
INNER JOIN MAXAPPS ON MAXAPPS.APP = APPLICATIONAUTH.APP
INNER JOIN groupuser ON GROUPUSER.GROUPNAME = APPLICATIONAUTH.GROUPNAME
WHERE GROUPUSER.USERID = <user_id>
  AND OPTIONNAME IN ('READ',
                     'SAVE',
                     'INSERT',
                     'DELETE')
GROUP BY MAXAPPS.DESCRIPTION;

Change the login messages for Development, Staging and Production environments in Maximo

noreply@blogger.com (Swaroop) — Tue, 17 Nov 2015 04:30:00 +0000

Some times it is necessary to differentiate between Maximo Development, Staging and Production environments.

One of the way to differentiate is to customize the login header messages. You can do it through database configuration application.

Go To > System Configuration > Platform Configuration > Database Configuration.
From the select action click on Messages.
Search for 'login' in the Message Group and 'welcome' in the Message Key.
Change the values in the message keys: welcome, welcomemaximomessage and welcomeusername.

You can also do it through following update queries.

update MAXMESSAGES set VALUE='Welcome' where MSGKEY='welcome';
update MAXMESSAGES set VALUE='Welcome to Maximo (Dev), {0}' where MSGKEY='welcomeusername';
update MAXMESSAGES set VALUE='Welcome to Maximo (Dev)' where MSGKEY='welcomemaximomessage';
update L_MAXMESSAGES set VALUE='Welcome' where ownerid=(select maxmessagesid from MAXMESSAGES where MSGKEY='welcome');
update L_MAXMESSAGES set VALUE='Welcome to Maximo (Dev), {0}' where ownerid=(select maxmessagesid from MAXMESSAGES where MSGKEY='welcomeusername');
update L_MAXMESSAGES set VALUE='Welcome to Maximo (Dev)' where ownerid=(select maxmessagesid from MAXMESSAGES where MSGKEY='welcomemaximomessage');

Send email through Communication template in Scripting

noreply@blogger.com (Swaroop) — Mon, 16 Nov 2015 09:49:00 +0000

We can send email notification from Communication Template with Automation Scripts.

It is needed only if the Application doesn't have the feature or if it cannot be attached to workflow/escalation.

This script uses Communication Template feature to send email from Automation Script. In the below example email will be sent to the owner of work order as and when the work order is saved.

Create a Communication template for any application (Say for example: Work Order Tracking application).
Create a relationship from between workorder and email objects. (In work order)

Condition: personid=: owner

Create a role to add the owner of work order.
Add the recipient from the role we created in the previous step.
Create a Relationship between Communication template and Work order objects.

Condition: ownerid in (select workorderid from workorder where wonum=:wonum and siteid = :siteid) and ownertable = 'ASSET'

Create an object launchpoint in workorder object Add method. Whenever a new workorder is created email has to be sent to the owner of workorder.

Installing Eclipse Plugin for Maximo Development

noreply@blogger.com (Swaroop) — Fri, 29 May 2015 13:59:00 +0000

Here is an eclipse plugin for IBM Maximo Asset Management customization.

Maximo Developer is an Eclipse plug-in designated for customization of IBM Maximo Asset Management System. It can help Maximo consultant or developer by automatically doing lot of boring and repetitive tasks.

Following are some of the tasks which can be achieved using this plugin.

Extending of existing Mbo and field classes.
Automatic project setup for Maximo.
Creation of new Mbo and field classes.
Automatic remote interface creation.
Remote interface synchronization with Mbo classes.
Automatic RMI connection.
Easy visual browsing.
Easy detaching and attaching of classes to Mbos and Mbo attributes and more...

Preview of eclipse configured with Maximo Developer

Installing Maximo Developer

Help > Install New Software
Click on Add and then Enter the below Details

Name: Maximo Developer
Location: http://maximodeveloper.sourceforge.net/update-site/
Select the plugin to be installed and click on Next.
Click on Next to proceed with the installation.
Select 'I accept the terms of license agreement' and click on Finish.
A security warning will pop up. Click on OK to continue.
Restart eclipse if required.

Alternatevly, if you are not able to access update site , you can get plugin jar file on the project site:
http://downloads.sourceforge.net/maximodeveloper

Download the latest release jar file, and put it in <Eclipse installation dir>/plugins directory.

Source: http://maximodeveloper.sourceforge.net/

IBM Maximo JavaDocs for Maximo Asset Management 7.1.1.9, 7.5.0.0 and 7.6.0.9

noreply@blogger.com (Swaroop) — Thu, 28 May 2015 13:00:00 +0000

You may download the JavaDocs for Maximo Asset Management 7.1.1.9 here.

You may download the JavaDocs for Maximo Asset Management 7.5.0.0 here.

You can find the JavaDocs for Maximo Asset Management 7.6.0.9 here.

Ref: https://www.ibm.com/support/pages/javadocs-maximo-asset-management-71-and-75