Using field Flags to set attribute content
Each attribute in Maximo / ICD can have several Validation Java classes and Jython scripts associated which will trigger when a new value for an attribute is set. Field flags can control some of the conditions under which the attributes can be modified and prevent execution of that classes / scripts.
The following field Flags are commonly used:
- NOACCESSCHECK is used to update the value even if the attribute is marked readonly
- NOVALIDATION supressess checking of the value. Be sure you know what you do, because you will prevent the business logic from checking for a valid value.
- DELAYVALIDATION does not perform any validation when the attribute is modified. The validation takes place on the save action. This can be useful if the validity of an attribute depends on other attributes.
- NOACTION is used to bypass the execution of all business rules. Use it carefully!
- NOVALIDATION_AND_NOACTION is a combination of the NOVALIDATION and NOACTION flag.
Now how do we use these flags in Jython? They are used in the setValue() Method as a third parameter. So sometimes you will see scripts like this:
itemMbo.setValue(description", "Hello World!", 1L)
In this 1L stands for NOVALIDATION and it is bad practise to write it in a numeric format. How about this style?
from psdi.mbo import MboConstants itemMbo.setValue("description", "Hello World!", MboConstants.NOVALIDATION) companyMbo.setValue("company", "COM1", MboConstants.NOVALIDATION_AND_NOACTION)
If multiple field flags should be combined for a field they could be combined by a bitwise or operation. See this example:
from psdi.mbo import MboConstants itemMbo.setValue("description", "Hello World!", MboConstants.NOVALIDATION | MboConstants.NOACCESSCHECK)
So far we always used the setValue method to directly manipulate the field flag while we are setting a value to a field. In some cases it is also useful to just set the field flag without applying a new value. This can be done with the setFieldFlag method. You can set and remove certain flags from a field. Mostly taken is this for the read only state:
from psdi.mbo import MboConstants itemMbo.setFieldFlag("description", MboConstants.READONLY,False) itemMbo.setValue("description", "Hello World!") itemMbo.setFieldFlag("description", MboConstants.READONLY,True)
The setFieldFlag method can also take a list of fields as a parameter, if you would like to modify a bunch of fields:
from psdi.mbo import MboConstants fields = ['DESCRIPTION','ITEMTYPE', 'ORDERUNIT'] itemMbo.setFieldFlag(fields, MboConstants.READONLY,False)