The Commentary in Oracle Policy Automation Web Determinations is an underestimated tool in our enhancement list. Firstly what do we mean? In this example we are referring to the HTML files that can be combined with the Web Determination experience to provide assistance, background information, further reading or any other sort of contextual help. This is not the same thing as the Commentary style in Word.

The Commentary content of your Project is automatically generated when you go to the Build menu and select the appropriate option.

Generate Commentary Files

Generate Commentary Files

The files are generated as static HTML, and these files can be edited using the HTML Editor of your choice. The default appearance is based on a setting in the appearance.properties file we discussed in the earlier lessons. The parameter

opa-commentary-type

can have several values different to the default of “frameset“, when the Commentary will display in the small yellow frame at the side of the session.The “popup” value gives the following look and feel:

Popup Commentary

Popup Commentary

Finally “iframe” which displays the Commentary in the bottom of the window:

IFrame Option for Commentary

IFrame Option for Commentary

In addition to the Screen and attribute Commentary, for more advanced scenarios, the behaviour of the Commentary can be modified by the use of a Plugin. Development of a Commentary Plugin, for example where a customer requirement is to have centrally, database-stored  or file-stored commentary text, is outside the scope of this post but forms the basis of a more complete example here. Suffice to say that if you have many languages and a high degree of volatile content, then static HTML files may not be the way to go. Perhaps a content management system with the actual page information stored in a database, or another web-based application which can serve the content on request from the plugin.

Until next time!