Complementary attributes: Difference between revisions

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search
Tag: 2017 source edit
mNo edit summary
Tag: 2017 source edit
Line 10: Line 10:
Then click on '''New Attribute'''
Then click on '''New Attribute'''


==List of fields for each complementary attribute==
=List of fields for each complementary attribute=
Each attribute has a some fields that need to be set
Each attribute has a some fields that need to be set
[[File:Fields of each complementary attribute.png|thumb]]
[[File:Fields of each complementary attribute.png|thumb]]


===Label or translation key===
==Label or translation key==
* '''Mandatory field'''
* '''Mandatory field'''
* Label of the new field. This can be a translation key (new or existing), then you also need to set the 'language file' field.
* Label of the new field. This can be a translation key (new or existing), then you also need to set the 'language file' field.


===Attribute code===
==Attribute code==
* '''Mandatory field'''
* '''Mandatory field'''
* Code of the new field. Can only contain alphanumerical and lower case characters without space
* Code of the new field. Can only contain alphanumerical and lower case characters without space


===Type===
==Type==
* '''String (1 line)''' : Text on one line.
* '''String (1 line)''' : Text on one line.
* '''Long text (n lines)''' : Text on several lines.
* '''Long text (n lines)''' : Text on several lines.
Line 44: Line 44:
* '''Separator (not a field)''' :
* '''Separator (not a field)''' :


===Size===
==Size==


===Position===
==Position==


===Value===
==Value==


===Language file===
==Language file==


===Computed field===
==Computed field==


===Default value (Database)===
==Default value (Database)==


===Unique===
==Unique==


===Required===
==Required==


===Can always be edited===
==Can always be edited==


===Visibility===
==Visibility==


===Display on PDF===
==Display on PDF==


===Totalizable===
==Totalizable==


===Help text to show on tooltip===
==Help text to show on tooltip==


=Tips=
= Tips=
== Computed Fields==
== Computed Fields==
You can enter here a formula using other properties of object or any PHP coding to get a dynamic computed value. You can use any PHP compatible formulas including the "?" condition operator, and following global object: '''$db, $conf, $langs, $mysoc, $user, $object'''.
You can enter here a formula using other properties of object or any PHP coding to get a dynamic computed value. You can use any PHP compatible formulas including the "?" condition operator, and following global object: '''$db, $conf, $langs, $mysoc, $user, $object'''.

Revision as of 15:28, 22 December 2021

Introduction

Most of the Dolibarr modules have the possibilities to enhance the standard fields by new users fields. These fields are called "Complementary attributes" can be defined for objects or object lines.

How to use

Go to the parameters of the module where you want to create new user fileds

Module configuration.png

On the configuration page, select the complementary attribute menu

Complementary attribute menu.png

Then click on New Attribute

List of fields for each complementary attribute

Each attribute has a some fields that need to be set

Fields of each complementary attribute.png

Label or translation key

  • Mandatory field
  • Label of the new field. This can be a translation key (new or existing), then you also need to set the 'language file' field.

Attribute code

  • Mandatory field
  • Code of the new field. Can only contain alphanumerical and lower case characters without space

Type

  • String (1 line) : Text on one line.
  • Long text (n lines) : Text on several lines.
  • Html text : Text with HTML tags.
  • Integer :
  • Float :
  • Date :
  • Date and hour :
  • Boolean (one checkbox) :
  • Price :
  • Phone :
  • Email :
  • Url :
  • Password :
  • Select list :
  • Select from table :
  • Radio buttons (one choice only) :
  • Checkboxes :
  • Checkboxes from table :
  • Link to an object :
  • Separator (not a field) :

Size

Position

Value

Language file

Computed field

Default value (Database)

Unique

Required

Can always be edited

Visibility

Display on PDF

Totalizable

Help text to show on tooltip

Tips

Computed Fields

You can enter here a formula using other properties of object or any PHP coding to get a dynamic computed value. You can use any PHP compatible formulas including the "?" condition operator, and following global object: $db, $conf, $langs, $mysoc, $user, $object.

WARNING: Only some properties of $object may be available. If you need a properties not loaded, just fetch yourself the object into your formula like in the second example.

Using a computed field means you can't enter yourself any value from interface. Also, if there is a syntax error, the formula may return nothing.


Example of formula:

$object->id < 10 ? round($object->id / 2, 2): ($object->id + 2 * $user->id) * (int) substr($mysoc->zip, 1, 2)


Example to reload object

(($reloadedobj = new Societe($db)) && ($reloadedobj->fetchNoCompute($obj->id ? $obj->id: ($obj->rowid ? $obj->rowid: $object->id)) > 0)) ? $reloadedobj->array_options['options_extrafieldkey'] * $reloadedobj->capital / 5: '-1'


Other example of formula to force load of object and its parent object:

(($reloadedobj = new Task($db)) && ($reloadedobj->fetchNoCompute($object->id) > 0) && ($secondloadedobj = new Project($db)) && ($secondloadedobj->fetchNoCompute($reloadedobj->fk_project) > 0)) ? $secondloadedobj->ref: 'Parent project not found'

Visibility

(($c = new Categorie($db)) && ($cats = $c->containing($object->id, Categorie::TYPE_PRODUCT))&& (in_array('mycategory',$cats ))) ? 1 : 0