A040 – Create an object field
What you will learn ?
This procedure allows to create a new field to an existing business object with:
- Translations
- Its value list
- Position in the template of the object

STEP 1: How to add a field
Select the business object:
- Either via a search menu Administration / Business Object
- By double-clicking on the object in the diagram
- By using the global search of its indexed name via header search
Prerequisite: Having created the business object.
Exercise:
- Open the
ModelApplication
diagram - Insert
AppClient
object - Double-click on the object
STEP 2: Create a field
You can create a field :
- Either via a search menu Administration / Add an object field
- By right-clicking on the object in the diagram and choose New content Field
- By double-clicking on the object the object definition form opens and choose Add a Field
- With the template editor
This step allows to create a field (all properties are available at the end of the wizard):
- Enter a unique name for the field respecting a naming convention (prefixed by a code of the object for example)
- Enter physical name when the field must be saved in a database, if this field is left blank it will be calculated for display. The physical name must not conflict with SQL (do not use keyword such as
order
,from
, etc.). - Select a type and a length for the field
- Indicate whether the field is required and / or functional key (unique id of the object)
- Indicate whether the field is visible, available in research and / or expanded in the forms or lists
- Click on Next
Exercise:
- Create a field
cliCode
on the objectAppClient
- Physical name
cli_code
- Size
10
,required
,visible everywhere
,functional key
,simple search
.
STEP 3: List of values
In the case of an enumerated field (single or multiple), the wizard allows to enter up to 10 possible values:
- Complete a unique code for the list using a naming convention related to the application or the field, this list can be reused for another field
Then for each possible value:
- Enter a unique code (respecting the field length). The code
0
is made to display an help in the first position in the list, but can’t be selected - Indicate whether this code will be the default field
- Translate the code in each language
Note: The list of values can be updated via Administration / List of values.
Exercise:
- Create a
cliType
field enumerated simple with 3 values for theAppClient
object - Name list
CLIENT_TYPE
- Code :
PRO
= Lead (default),CTM
= Customer,ABO
= Abandoned
STEP 4: Order in a area
In this step, you must:
- Choose the area where the field will be displayed and its order in this area.
- Indicate whether the object should be sort on this field:
a) negative number for descending sort,
b) to sort on multiple fields each must have a distinct order (ex. 1, 2 and -3)
Exercise:
- Put
cliCode
in a the fist areaAppClient-1
- Sort code in ascending order
STEP 6: Objectfield tab
On the object form select objectField tab to check that the field has been added.
It is possible to open the definition field by clicking on its name.
STEP 7: Field definition
This field definition form is displayed :
- When you click on the field name directly from the object field tab of the object form
- By the Administration / Field menu
- By double clicking on a field from the diagram
- From a global search on the name or the translation of the field
Once opening the field form:
- Use the More button to see all properties
- Set various options for the field (logical name, display, search …)
- Modify translations and help in the translation tab
- Click on Save
Exercise:
- Put the
cliCode
field indexable.
STEP 8: Objectfield
It is possible to override some properties of a field in the object context. The objectfield which is the relationship between a field and an object allows to do this.
The field can be used in other objects, and for each of them, it is possible to override some basic properties:
- Visible, required, editable, search, extended …
Exercise:
- Modify
cliCode
object field to hide the lists forAppClient
object. - Complete the
AppClient
object by creating other fields:- a field type:
cliType
, enumerated type (use the wizard to create a list of value) - a field last name:
cliNom
, mandatory, text field - a field first name:
cliPrenom
, non-mandatory, text field
- a field type:
- Create an
AppAdresse
object with:- a field street:
adrRue
, mandatory, text, 100 and key functional - a field postal code:
adrCodePostal
, mandatory, text, 5 and functional key - a field City:
adrVille
, mandatory, text, 50
- a field street:
- Create an
AppInteret
object with:- a field label:
intLibelle
, mandatory, text, 100 and functional key - a field score:
intScore
, int, 5, mandatory
- a field label:
STEP 9: Place field on the object form with template editor
In this step, you can:
- Choose how the fields are displayed on the object form with Template editor.
- Create area
- Create field
Exercise:
- Put
cliCode
in a specific area which label is Information - Create a text zone to display in this area
A030 – Create a business object
This procedure allows to create a business object with:
- Translations
- Access rights
- Location in a domain