A090 – Help on a business object

What you will learn ?

How to add help messages on business objects:

  • Static Help
  • Contextual help
  • Help on fields

STEP 1: Access

Select a business object:

  • Via the Administration menu / Business object
  • By double-clicking on the object in the diagram view


Open the object AppClient

STEP 2: Translation object tab

Go to Translation object tab to access the list of all translations in each language.

STEP 3: Static help

Open a translation and enter:

  • Translation: item translation in the language of the user
  • Static help on that object using: This text will be displayed when the object is displayed
    Save / Close this form.

STEP 4: Contextual help

Back on the definition of the object, select the Contextual help tab to list the various helps related to different kind of access to the object.

STEP 5: Contextual help

Open or create a help by clicking the Create button (on the top left of the list):

  • Check the type of access in which help will be displayed (ex. creation)
  • Choose a language
  • Enter the Help content in the chosen language
  • Select a module
  • Save / Close
    Redo this step for all types of access where help is different, or in any other language.
    If the object has no contextual help in the language of the user, nothing will be displayed, only the attributes of the object will be presented.


Create an help for the creation of a client.

STEP 6: Object field tab

Back on the object definition, go to the Objectfield tab.

STEP 7: Field translations

STEP 7: Field translations

Click on one of the field link and open its Translation.


Open the field cliCode of the object AppClient

STEP 7: Test and validate

STEP 8: Field help

Open or create a translation:

  • Give translation: that will be displayed everywhere (list column and form field)
  • Complete with help: it will be presented as a tooltip when the mouse pass over the field


Enter and save a tooltip The customer code must be unique Clear the cache to see your modifications

  • by clicking the Clear Cache button from the definition of the object
  • or by clicking the Clear cache shortcut (top of the page)
STEP 9: Check static help

STEP 9: Check static help

Check the help contents

  • In search and list form, static support is available via the Help button on the right of the title bar of this object.


Open the customer search form, the customer list and customer form.

STEP 7: Test and validate

STEP 10: Check contextual help

Positioning in each context of the object (search, creation, updating …) and check that the help content appears following the settings:

  • Through a Help button in the title
  • Directly next to the form
  • Above the form

STEP 11: User messages

Additional user information may appear, particularly error messages that will be displayed :

  • Above the form: General message
  • On a particular field (required for example)

To configure the position of the message several system parameters can be used :

  • FORM_INLINED_HELP = yes/no to always display or access by clicking “Help”
  • FORM_INLINED_MESSAGE = yes/no to display to the top of the form or on each field concerned

Users messages are all configurable in static texts:

  • Menu Administration / Static Text
  • Search the “TEXT” list that contains all labels, search by the code or the translated value.


  • Create a constraint which displays an error message when a prospect without address becomes a client.
  • Change the system parameters to see the impact on the display.
  • Change the static text “required field” with “Please fill the field”
STEP 7: Test and validate

STEP 12: Shared post


Another way to exchange is the use of shared posts.
Each user can explain why or how he filled the fields.


  • Open a customer and click on the icon of “Sharing” in the title bar
  • Enter a comment and share
  • Reconnect with another user, and consult this comment from the customer or list all comments
    (“Shared posts” shortcut at the top of the screen).

A080 – Create a constraint on an object

How to add a constraint on a business object. A constraint is a business rule (If “condition” then “impacts”) on an object based on its contextual data and user rights.

A100 – Create a field type

Create an external field type