Server Interface Reference

When developing UIM pages, you will need to know details about the façade server interfaces and their properties so that you can select the information that you want to display on each page. This information is all defined in the application's UML model, but, for your convenience, you can generate simple reference documentation in HTML format to make the information more easily accessible.

Thebeandoc target generates this reference documentation for all of the available façade server interfaces ("classes"), creating many HTML files in the <client-dir>/build/bean-doc folder. To view the documentation, open the index.html file created in that folder in a web browser. This document provides links to alphabetical lists of all classes, all operations on those classes, all domain definitions used by properties of those operations, and all code-tables referenced by any of those domain definitions. Each of these lists provides further links for cross-references or providing more details. Viewing a class will display a list of its operations and selecting an operation will show a list of its properties.

In UIM, you do not have to use the full property name; you can use only part of the ending of the name as long as it is unambiguous. In the reference documentation for each operation, both the full property name and the shortest, unique ending of the property name are given. This will help you to choose a name that is short and readable, but that will not cause any build errors later.

Beside many of the class, operation, and property names, you will see a Copy button. Clicking this button will copy the name to the clipboard, allowing you to paste it into your UIM file. For property names, the shortest unique name is copied. Copying to the clipboard using the Copy button only works in Microsoft Internet Explorer. In other browsers, you will have to select the text and use the normal copying commands.