Feature/8994 add classes description by v-dumas · Pull Request #789 · Combodo/iTop

v-dumas · 2025-12-19T16:04:22Z

Base information

Question	Answer
Related to Combodo ticket?	N°8994
Type of change?	Enhancement

Symptom (bug) / Objective (enhancement)

Improve User understanding of the various iTop classes and their usage, by adding a description which is displayed as a tooltip when going above a Dashlet Badge of a class.

Proposed solution (bug and enhancement)

Checklist before requesting a review

I have performed a self-review of my code
I have tested all changes I made on an iTop instance
I have added a unit test, otherwise I have explained why I couldn't
Is the PR clear and detailed enough so anyone can understand digging in the code?

Checklist of things to do before PR is ready to merge

...
...
...

Hipska

Great cleanup 👍 I do have a few minor suggestions.

datamodels/2.x/itop-config-mgmt/dictionaries/en.dict.itop-config-mgmt.php

Hipska · 2025-12-19T20:37:36Z

datamodels/2.x/itop-config-mgmt/dictionaries/en.dict.itop-config-mgmt.php

 Dict::Add('EN US', 'English', 'English', [
 	'Class:Tablet' => 'Tablet',
-	'Class:Tablet+' => '',
+	'Class:Tablet+' => 'End user device. For example iPad, Galaxy Note/Tab Nexus, Kindle,...',


Suggested change

'Class:Tablet+' => 'End user device. For example iPad, Galaxy Note/Tab Nexus, Kindle,...',

'Class:Tablet+' => 'End user device. For example iPad, Galaxy Note/Tab, Nexus, Kindle, …',

Inconsistency between classes : "End User" or "End user"?

Hipska · 2025-12-19T20:39:43Z

datamodels/2.x/itop-config-mgmt/dictionaries/en.dict.itop-config-mgmt.php

 Dict::Add('EN US', 'English', 'English', [
 	'Class:NetworkDevice' => 'Network Device',
-	'Class:NetworkDevice+' => '',
+	'Class:NetworkDevice+' => 'Any type of network device: router, switch, hub, load balancer, firewall…',


Suggested change

'Class:NetworkDevice+' => 'Any type of network device: router, switch, hub, load balancer, firewall…',

'Class:NetworkDevice+' => 'Any type of network device: router, switch, hub, load balancer, firewall, …',

Hipska · 2025-12-19T20:59:11Z

datamodels/2.x/itop-config-mgmt/dictionaries/en.dict.itop-config-mgmt.php

-	'Class:PhysicalInterface/Attribute:location_id' => 'Location id',
-	'Class:PhysicalInterface/Attribute:location_id+' => '',
-]);
+]);


Please restore EOL.

…ig-mgmt.php Co-authored-by: Thomas Casteleyn <thomas.casteleyn@super-visions.com>

jbostoen · 2025-12-23T19:45:28Z

datamodels/2.x/itop-structure/dictionaries/en.dict.itop-structure.php

 Dict::Add('EN US', 'English', 'English', [
 	'Class:Typology' => 'Typology',
-	'Class:Typology+' => '',
+	'Class:Typology+' => 'An abstract class. ExternalKeyAttribute to a Typology subclass are used in place of an EnumAttribute, to have more dynamic values',


Attributes perhaps (plural)?

I'm not sure if this will make it much more clear to a standard iTop user though (someone who doesn't modify the data model).

Abstract class. ExternalKeyAttribute to a Typology subclass are used in place of an EnumAttribute, to have more dynamic values.

jbostoen · 2025-12-23T19:46:06Z

datamodels/2.x/itop-structure/dictionaries/en.dict.itop-structure.php

 Dict::Add('EN US', 'English', 'English', [
 	'Class:DocumentWeb' => 'Document Web',
-	'Class:DocumentWeb+' => '',
+	'Class:DocumentWeb+' => 'Hyperlinks to external applications or documents. Think to them as “pointers” to external documents. You cannot search in their content from '.ITOP_APPLICATION_SHORT,


Think of them.

I'm also not sure the "French" quotes should be used here instead of regular ones ( " ).

Agree and I would rephrase it.
Proposal: 'can be considered as pointers to external documents (without quotes)

jbostoen · 2025-12-23T19:47:22Z

datamodels/2.x/itop-structure/dictionaries/en.dict.itop-structure.php

 Dict::Add('EN US', 'English', 'English', [
 	'Class:DocumentFile' => 'Document File',
-	'Class:DocumentFile+' => '',
+	'Class:DocumentFile+' => 'It\'s a type of Document which includes an '.ITOP_APPLICATION_SHORT.' uploaded file (in any format: Word, PDF, Spreadsheet, etc.). It can be used for all sorts of purpose: contract, sales order, datacenter maps, processing instructions, technical documentation.',


I'd suggest to drop the ITOP_APPLICATION_SHORT here?

Also: "It can be used for different purposes:"

dcoille · 2026-01-13T11:07:27Z

datamodels/2.x/itop-config-mgmt/dictionaries/en.dict.itop-config-mgmt.php

 Dict::Add('EN US', 'English', 'English', [
 	'Class:PhysicalDevice' => 'Physical Device',
-	'Class:PhysicalDevice+' => '',
+	'Class:PhysicalDevice+' => 'Abstract class, grouping physical types of Configuration Items. A Physical Device can be located. It has usually a Brand and Model.',


Remove ',' after Abstract class

dcoille · 2026-01-13T11:08:50Z

datamodels/2.x/itop-config-mgmt/dictionaries/en.dict.itop-config-mgmt.php

 Dict::Add('EN US', 'English', 'English', [
 	'Class:TelephonyCI' => 'Telephony CI',
-	'Class:TelephonyCI+' => '',
+	'Class:TelephonyCI+' => 'Abstract class, grouping telephony devices',


Remove ',' after Abstract class

dcoille · 2026-01-13T11:20:05Z

datamodels/2.x/itop-config-mgmt/dictionaries/en.dict.itop-config-mgmt.php

 Dict::Add('EN US', 'English', 'English', [
 	'Class:Phone' => 'Phone',
-	'Class:Phone+' => '',
+	'Class:Phone+' => 'End User device, a plain old wired phone',


'End User device. Plain wired phone'

dcoille · 2026-01-13T11:20:46Z

datamodels/2.x/itop-config-mgmt/dictionaries/en.dict.itop-config-mgmt.php

 Dict::Add('EN US', 'English', 'English', [
 	'Class:MobilePhone' => 'Mobile Phone',
-	'Class:MobilePhone+' => '',
+	'Class:MobilePhone+' => 'End User wireless phone device',


End User device. Wireless phone.

dcoille · 2026-01-13T13:10:40Z

datamodels/2.x/itop-config-mgmt/dictionaries/en.dict.itop-config-mgmt.php

 Dict::Add('EN US', 'English', 'English', [
 	'Class:Tablet' => 'Tablet',
-	'Class:Tablet+' => '',
+	'Class:Tablet+' => 'End user device. For example iPad, Galaxy Note/Tab Nexus, Kindle,...',


Inconsistency between classes : "End User" or "End user"?

dcoille · 2026-01-13T16:50:30Z

datamodels/2.x/itop-knownerror-mgmt/dictionaries/en.dict.itop-knownerror-mgmt.php

 Dict::Add('EN US', 'English', 'English', [
 	'Class:KnownError' => 'Known Error',
-	'Class:KnownError+' => 'Error documented for a known issue',
+	'Class:KnownError+' => 'Error which occurred multiple times, so we document it to avoid loosing energy in troubleshooting the next time it will be reported',


Error identified after multiple occurences and documented to ease troubleshooting.

dcoille · 2026-01-13T16:52:05Z

datamodels/2.x/itop-structure/dictionaries/en.dict.itop-structure.php

 Dict::Add('EN US', 'English', 'English', [
 	'Class:Contact' => 'Contact',
-	'Class:Contact+' => '',
+	'Class:Contact+' => 'An abstract class. A Contact can be linked to Tickets and FunctionalCIs for different purpose such as dispatch of incident, notification,...',


Abstract class. A Contact can be linked to Tickets and FunctionalCIs for different purpose such as dispatch of incident, notification,...

dcoille · 2026-01-13T17:03:49Z

datamodels/2.x/itop-structure/dictionaries/en.dict.itop-structure.php

 Dict::Add('EN US', 'English', 'English', [
 	'Class:DocumentNote' => 'Document Note',
-	'Class:DocumentNote+' => '',
+	'Class:DocumentNote+' => 'It is used to store a text document. HTML formatting is supported using the WYSIWYG editor. Search can be performed on its content.',


Used to store a text document. HTML formatting is supported using the WYSIWYG editor. Search can be performed on its content.

dcoille · 2026-01-13T17:05:16Z

datamodels/2.x/itop-structure/dictionaries/en.dict.itop-structure.php

 Dict::Add('EN US', 'English', 'English', [
 	'Class:DocumentWeb' => 'Document Web',
-	'Class:DocumentWeb+' => '',
+	'Class:DocumentWeb+' => 'Hyperlinks to external applications or documents. Think to them as “pointers” to external documents. You cannot search in their content from '.ITOP_APPLICATION_SHORT,


Agree and I would rephrase it.
Proposal: 'can be considered as pointers to external documents (without quotes)

dcoille · 2026-01-13T17:05:56Z

datamodels/2.x/itop-structure/dictionaries/en.dict.itop-structure.php

 Dict::Add('EN US', 'English', 'English', [
 	'Class:Typology' => 'Typology',
-	'Class:Typology+' => '',
+	'Class:Typology+' => 'An abstract class. ExternalKeyAttribute to a Typology subclass are used in place of an EnumAttribute, to have more dynamic values',


Abstract class. ExternalKeyAttribute to a Typology subclass are used in place of an EnumAttribute, to have more dynamic values.

v-dumas added 4 commits December 10, 2025 18:01

N°8994 - Add classes description (part1)

d29ba88

N°8994 - Add classes description (part2)

32d8bf6

N°8994 - Add description on all iTop classes (2)

06dbb6a

N°8994 - Add description on iTop classes (4)

b3b85fa

CombodoApplicationsAccount added the internal Work made by Combodo label Dec 19, 2025

Hipska suggested changes Dec 19, 2025

View reviewed changes

Update datamodels/2.x/itop-config-mgmt/dictionaries/en.dict.itop-conf…

5df5b15

…ig-mgmt.php Co-authored-by: Thomas Casteleyn <thomas.casteleyn@super-visions.com>

jbostoen reviewed Dec 23, 2025

View reviewed changes

dcoille suggested changes Jan 13, 2026

View reviewed changes

	'Class:Tablet+' => 'End user device. For example iPad, Galaxy Note/Tab Nexus, Kindle,...',
	'Class:Tablet+' => 'End user device. For example iPad, Galaxy Note/Tab, Nexus, Kindle, …',

	'Class:NetworkDevice+' => 'Any type of network device: router, switch, hub, load balancer, firewall…',
	'Class:NetworkDevice+' => 'Any type of network device: router, switch, hub, load balancer, firewall, …',

Conversation

v-dumas commented Dec 19, 2025

Base information

Symptom (bug) / Objective (enhancement)

Proposed solution (bug and enhancement)

Checklist before requesting a review

Checklist of things to do before PR is ready to merge

Uh oh!

Hipska left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants