Making Long Description a Text Field (or Disabling Rich Text)

Starting with the Maximo 7.5 release, long descriptions have been enabled for rich text. 

However, if you want to disable rich text for long descriptions - you can configure Maximo to do this. This article describes how to disable the rich text - along with some items you may want to consider before implementing this change.  

Important Considerations:

• The instructions provided here remove the rich text editor for a text area. This process works; however, it has not been tested across all Maximo applications to determine whether there are any issues.
• The file that you change in the process described below can be updated by any subsequent hot fix or fix pack release. Whenever a hot fix or fix pack is installed, the control-registry.xml should be checked to see if it has changed. If it has changed, then the modification described in the following steps should be made again to the new control-registry.xml. Do not copy the old file that you modified and allow it to overwrite the file that was updated by the hot fix or fix pack. If you overwrite the file updated by the hot fix or fix pack, you risk losing important updates.
• The following instructions change only the control used for editing. Any existing records must be cleaned up and stripped of any embedded html.
• There are some applications that also use the richtexteditor control directly on some attributes; they have to be altered in the application designer (this change does not affect them).
• Some integrations (ex.  Report integrations) may not be able to interpret Maximo's rich text formatting.  Therefore, you may need to disable rich text if you rely heavily on this integrations.

 

Instructions for configuring long descriptions to use a text area instead of Rich Text Editor

1) Make a backup copy of the control-registry.xml file that is in <maximo_home>/applications/maximo/properties.

2) Open the file in an editor like notepad (or notepad++).

3) Find the text: <control-descriptor name="longdescription"

4) Once found, scroll a little farther down. Within that control descriptor block, there will be a section that looks like:

<component-list> <components id="${name}_components_v" layout="vertical"> <components nowrap="false" id="${name}_components_h1" layout="horizontal" makevertical="true"> <label id="${name}_label" labelcss="@{labelcss}" title="@{label}" dataattribute="@{dataattribute}" instance-class="psdi.webclient.components.LongDescriptionTitle" wraptext="true" textcss="@{textcss}" wraplength="@{wraplength}" labelfor="${name}_richtexteditor,${name}_richtextviewer,${name}_textarea"/> </components> <components id="${name}_components_h2" layout="horizontal"> <required-indicator id="${name}_required_indicator" dataattribute="@{dataattribute}" /> </components> <components id="${name}_components_h3" layout="horizontal"> <richtexteditor id="${name}_richtexteditor" dataattribute="@{dataattribute}" inputmode="@{inputmode}" width="@{width}" height="@{height}" plugins="@{plugins}" extra_plugins="@{extra_plugins}" dojo_require="@{dojo_require}" load_css="@{load_css}" dojo_type="@{dojo_type}" hidewhen="{mobile}==true" /> <richtextviewer id="${name}_richtextviewer" dataattribute="@{dataattribute}" width="@{width}" height="@{height}" hidewhen="{mobile}==false or {rendertextarea}==true" /> <textarea id="${name}_textarea" dataattribute="@{dataattribute}" width="@{width}" height="@{height}" inputmode="@{inputmode}" hidewhen="{mobile}==false or {rendertextarea}==false" /> </components> <children id="${name}_children" layout="none" /> </components> </component-list>

5) Add the following text (in bold and blue, note the <!-- and --> that are added):

<component-list> <components id="${name}_components_v" layout="vertical"> <components nowrap="false" id="${name}_components_h1" layout="horizontal" makevertical="true"> <label id="${name}_label" labelcss="@{labelcss}" title="@{label}" dataattribute="@{dataattribute}" instance-class="psdi.webclient.components.LongDescriptionTitle" wraptext="true" textcss="@{textcss}" wraplength="@{wraplength}" labelfor="${name}_richtexteditor,${name}_richtextviewer,${name}_textarea"/> </components> <components id="${name}_components_h2" layout="horizontal"> <required-indicator id="${name}_required_indicator" dataattribute="@{dataattribute}" /> </components> <components id="${name}_components_h3" layout="horizontal"> <!-- <richtexteditor id="${name}_richtexteditor" dataattribute="@{dataattribute}" inputmode="@{inputmode}" width="@{width}" height="@{height}" plugins="@{plugins}" extra_plugins="@{extra_plugins}" dojo_require="@{dojo_require}" load_css="@{load_css}" dojo_type="@{dojo_type}" hidewhen="{mobile}==true" /> <richtextviewer id="${name}_richtextviewer" dataattribute="@{dataattribute}" width="@{width}" height="@{height}" hidewhen="{mobile}==false or {rendertextarea}==true" /> <textarea id="${name}_textarea" dataattribute="@{dataattribute}" width="@{width}" height="@{height}" inputmode="@{inputmode}" hidewhen="{mobile}==false or {rendertextarea}==false" /> --> <textarea id="${name}_textarea" dataattribute="@{dataattribute}" width="@{width}" height="@{height}" inputmode="@{inputmode}" /> </components> <children id="${name}_children" layout="none" /> </components> </component-list>

6) Rebuild and redeploy the maximo.ear file.

#rich_text
#AssetandFacilitiesManagement
#Maximo
#configure
#MaximoEAM
#text