Skip to content

Feature/8994 add classes description #789

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
v-dumas wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

Feature/8994 add classes description #789

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d29ba88
N°8994 - Add classes description (part1)
v-dumas Dec 10, 2025
32d8bf6
N°8994 - Add classes description (part2)
v-dumas Dec 11, 2025
06dbb6a
N°8994 - Add description on all iTop classes (2)
v-dumas Dec 18, 2025
b3b85fa
N°8994 - Add description on iTop classes (4)
v-dumas Dec 19, 2025
5df5b15
Update datamodels/2.x/itop-config-mgmt/dictionaries/en.dict.itop-conf…
v-dumas Dec 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion datamodels/2.x/itop-config-mgmt/dictionaries/cs.dict.itop-config-mgmt.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -579,7 +579,7 @@
//

Dict::Add('CS CZ', 'Czech', 'Čeština', [
'Class:WebServer' => 'Web server',
'Class:WebServer' => 'Web Server',
'Class:WebServer+' => '',
'Class:WebServer/Attribute:webapp_list' => 'Web aplikace',
'Class:WebServer/Attribute:webapp_list+' => 'Všechny webové aplikace dostupné na tomto web serveru',
Expand Down
218 changes: 105 additions & 113 deletions datamodels/2.x/itop-config-mgmt/dictionaries/en.dict.itop-config-mgmt.php
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion datamodels/2.x/itop-config-mgmt/dictionaries/en_gb.dict.itop-config-mgmt.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -596,7 +596,7 @@
//

Dict::Add('EN GB', 'British English', 'British English', [
'Class:WebServer' => 'Web server',
'Class:WebServer' => 'Web Server',
'Class:WebServer+' => '',
'Class:WebServer/Attribute:webapp_list' => 'Web applications',
'Class:WebServer/Attribute:webapp_list+' => 'All the web applications available on this web server',
Expand Down
2 changes: 1 addition & 1 deletion datamodels/2.x/itop-config-mgmt/dictionaries/it.dict.itop-config-mgmt.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -577,7 +577,7 @@
//

Dict::Add('IT IT', 'Italian', 'Italiano', [
'Class:WebServer' => 'Web server',
'Class:WebServer' => 'Web Server',
'Class:WebServer+' => '~~',
'Class:WebServer/Attribute:webapp_list' => 'Applicazioni web',
'Class:WebServer/Attribute:webapp_list+' => 'Tutte le applicazioni web disponibili su questo server web',
Expand Down
2 changes: 1 addition & 1 deletion datamodels/2.x/itop-config-mgmt/dictionaries/sk.dict.itop-config-mgmt.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -577,7 +577,7 @@
//

Dict::Add('SK SK', 'Slovak', 'Slovenčina', [
'Class:WebServer' => 'Web server',
'Class:WebServer' => 'Web Server',
'Class:WebServer+' => '~~',
'Class:WebServer/Attribute:webapp_list' => 'Webové aplikácie',
'Class:WebServer/Attribute:webapp_list+' => 'All the web applications available on this web server~~',
Expand Down
2 changes: 1 addition & 1 deletion datamodels/2.x/itop-knownerror-mgmt/dictionaries/en.dict.itop-knownerror-mgmt.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@

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',
'Class:KnownError/Attribute:name' => 'Name',
'Class:KnownError/Attribute:name+' => 'This is expected to be a unique identifier within the Known Errors of this organization',
'Class:KnownError/Attribute:org_id' => 'Organization',
Expand Down
2 changes: 1 addition & 1 deletion datamodels/2.x/itop-problem-mgmt/dictionaries/en.dict.itop-problem-mgmt.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@

Dict::Add('EN US', 'English', 'English', [
'Class:Problem' => 'Problem',
'Class:Problem+' => '',
'Class:Problem+' => 'An incident becomes a Problem when it is not resolved in a timely manner or when it recurs frequently',
'Class:Problem/Attribute:status' => 'Status',
'Class:Problem/Attribute:status+' => '',
'Class:Problem/Attribute:status/Value:new' => 'New',
Expand Down
23 changes: 12 additions & 11 deletions datamodels/2.x/itop-structure/dictionaries/en.dict.itop-structure.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@

Dict::Add('EN US', 'English', 'English', [
'Class:Organization' => 'Organization',
'Class:Organization+' => '',
'Class:Organization+' => 'It can be a customer, a provider, your company or departments within your company. Organizations can be organized in hierarchy. Users can be limited to objects belonging to some organizations only.',
'Class:Organization/Attribute:name' => 'Name',
'Class:Organization/Attribute:name+' => 'Common name',
'Class:Organization/Attribute:code' => 'Code',
Expand Down Expand Up @@ -114,7 +114,7 @@

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,...',
'Class:Contact/ComplementaryName' => '%1$s - %2$s',
'Class:Contact/Attribute:name' => 'Name',
'Class:Contact/Attribute:name+' => '',
Expand Down Expand Up @@ -152,7 +152,8 @@

Dict::Add('EN US', 'English', 'English', [
'Class:Person' => 'Person',
'Class:Person+' => '',
'Class:Person+' => 'A type of Contact used to describe physical persons. Persons can be grouped into Teams. Persons can be linked to other configuration items (eg. to describe who to contact in case of incident with an application).
Other usage: the caller of a User request is a Person as well as the agent assigned to resolve it.',
'Class:Person/ComplementaryName' => '%1$s - %2$s',
'Class:Person/Attribute:name' => 'Last Name',
'Class:Person/Attribute:name+' => '',
Expand Down Expand Up @@ -193,7 +194,7 @@

Dict::Add('EN US', 'English', 'English', [
'Class:Team' => 'Team',
'Class:Team+' => '',
'Class:Team+' => 'A type of Contact. Often used to group Persons, but not only. Teams are expected to watch Tickets dispatched to them, and assign it to an agent, usually a member of that team.',
'Class:Team/ComplementaryName' => '%1$s - %2$s',
'Class:Team/Attribute:persons_list' => 'Members',
'Class:Team/Attribute:persons_list+' => 'All the people belonging to this team',
Expand All @@ -214,7 +215,7 @@

Dict::Add('EN US', 'English', 'English', [
'Class:Document' => 'Document',
'Class:Document+' => '',
'Class:Document+' => 'A document that can be shared across multiple objects so it is easy and quick to retrieve it from all the places where it is pertinent',
'Class:Document/ComplementaryName' => '%1$s - %2$s - %3$s',
'Class:Document/Attribute:name' => 'Name',
'Class:Document/Attribute:name+' => '',
Expand Down Expand Up @@ -250,7 +251,7 @@

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.',
Copy link
Contributor

@jbostoen jbostoen Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd suggest to drop the ITOP_APPLICATION_SHORT here?

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

'Class:DocumentFile/Attribute:file' => 'File',
'Class:DocumentFile/Attribute:file+' => '',
]);
Expand All @@ -261,7 +262,7 @@

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.',
'Class:DocumentNote/Attribute:text' => 'Text',
'Class:DocumentNote/Attribute:text+' => '',
]);
Expand All @@ -272,7 +273,7 @@

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,
Copy link
Contributor

@jbostoen jbostoen Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Think of them.

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

'Class:DocumentWeb/Attribute:url' => 'URL',
'Class:DocumentWeb/Attribute:url+' => '',
]);
Expand All @@ -283,7 +284,7 @@

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',
Copy link
Contributor

@jbostoen jbostoen Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

'Class:Typology/Attribute:name' => 'Name',
'Class:Typology/Attribute:name+' => '',
'Class:Typology/Attribute:finalclass' => 'Typology sub-class',
Expand All @@ -296,7 +297,7 @@

Dict::Add('EN US', 'English', 'English', [
'Class:DocumentType' => 'Document Type',
'Class:DocumentType+' => '',
'Class:DocumentType+' => 'Typology to organize your Documents and group them logically for you.',
]);

//
Expand All @@ -305,7 +306,7 @@

Dict::Add('EN US', 'English', 'English', [
'Class:ContactType' => 'Contact Type',
'Class:ContactType+' => '',
'Class:ContactType+' => 'Typology to organize your Contacts and group them logically for you.',
]);

//
Expand Down