From 32778eeea01628444f755d3a1574ac730a98fbc9 Mon Sep 17 00:00:00 2001 From: v-dumas Date: Wed, 10 Dec 2025 18:01:30 +0100 Subject: [PATCH] =?UTF-8?q?N=C2=B08994=20-=20Add=20classes=20description?= =?UTF-8?q?=20(part1)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../dictionaries/cs.dict.itop-config-mgmt.php | 2 +- .../dictionaries/en.dict.itop-config-mgmt.php | 40 +++++++++++-------- .../en_gb.dict.itop-config-mgmt.php | 2 +- .../dictionaries/it.dict.itop-config-mgmt.php | 2 +- .../dictionaries/sk.dict.itop-config-mgmt.php | 2 +- .../dictionaries/en.dict.itop-structure.php | 25 +++++++----- 6 files changed, 42 insertions(+), 31 deletions(-) diff --git a/datamodels/2.x/itop-config-mgmt/dictionaries/cs.dict.itop-config-mgmt.php b/datamodels/2.x/itop-config-mgmt/dictionaries/cs.dict.itop-config-mgmt.php index 902afc29a..1da16ffcd 100644 --- a/datamodels/2.x/itop-config-mgmt/dictionaries/cs.dict.itop-config-mgmt.php +++ b/datamodels/2.x/itop-config-mgmt/dictionaries/cs.dict.itop-config-mgmt.php @@ -579,7 +579,7 @@ Dict::Add('CS CZ', 'Czech', 'Čeština', [ // 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', diff --git a/datamodels/2.x/itop-config-mgmt/dictionaries/en.dict.itop-config-mgmt.php b/datamodels/2.x/itop-config-mgmt/dictionaries/en.dict.itop-config-mgmt.php index 1fb57c29b..95ed339a7 100644 --- a/datamodels/2.x/itop-config-mgmt/dictionaries/en.dict.itop-config-mgmt.php +++ b/datamodels/2.x/itop-config-mgmt/dictionaries/en.dict.itop-config-mgmt.php @@ -103,7 +103,7 @@ Dict::Add('EN US', 'English', 'English', [ Dict::Add('EN US', 'English', 'English', [ 'Class:FunctionalCI' => 'Functional CI', - 'Class:FunctionalCI+' => '', + 'Class:FunctionalCI+' => 'Abstract class grouping multiple types of Configuration Items', 'Class:FunctionalCI/Attribute:name' => 'Name', 'Class:FunctionalCI/Attribute:name+' => '', 'Class:FunctionalCI/Attribute:description' => 'Description', @@ -142,7 +142,9 @@ Dict::Add('EN US', 'English', 'English', [ 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.', 'Class:PhysicalDevice/ComplementaryName' => '%1$s - %2$s', 'Class:PhysicalDevice/Attribute:serialnumber' => 'Serial number', 'Class:PhysicalDevice/Attribute:serialnumber+' => '', @@ -302,7 +304,7 @@ Dict::Add('EN US', 'English', 'English', [ 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…', 'Class:NetworkDevice/ComplementaryName' => '%1$s - %2$s', 'Class:NetworkDevice/Attribute:networkdevicetype_id' => 'Network type', 'Class:NetworkDevice/Attribute:networkdevicetype_id+' => '', @@ -324,7 +326,7 @@ Dict::Add('EN US', 'English', 'English', [ Dict::Add('EN US', 'English', 'English', [ 'Class:Server' => 'Server', - 'Class:Server+' => '', + 'Class:Server+' => 'Physical Device, a computer running an operating system and designed to execute Software Instances', 'Class:Server/ComplementaryName' => '%1$s - %2$s', 'Class:Server/Attribute:osfamily_id' => 'OS family', 'Class:Server/Attribute:osfamily_id+' => '', @@ -388,7 +390,7 @@ Dict::Add('EN US', 'English', 'English', [ Dict::Add('EN US', 'English', 'English', [ 'Class:NAS' => 'NAS', - 'Class:NAS+' => '', + 'Class:NAS+' => 'Network-attached storage (NAS) is an high-capacity storage device connected to a network', 'Class:NAS/ComplementaryName' => '%1$s - %2$s', 'Class:NAS/Attribute:nasfilesystem_list' => 'Filesystems', 'Class:NAS/Attribute:nasfilesystem_list+' => 'All the file systems in this NAS', @@ -400,7 +402,7 @@ Dict::Add('EN US', 'English', 'English', [ Dict::Add('EN US', 'English', 'English', [ 'Class:PC' => 'PC', - 'Class:PC+' => '', + 'Class:PC+' => 'Personal Computer, Desktop or Laptop', 'Class:PC/ComplementaryName' => '%1$s - %2$s', 'Class:PC/Attribute:osfamily_id' => 'OS family', 'Class:PC/Attribute:osfamily_id+' => '', @@ -506,7 +508,9 @@ Dict::Add('EN US', 'English', 'English', [ Dict::Add('EN US', 'English', 'English', [ 'Class:ApplicationSolution' => 'Application Solution', - 'Class:ApplicationSolution+' => '', + 'Class:ApplicationSolution+' => 'Application Solutions describe complex applications that are made of (or depend on) several basic components. +They are a specialized type of “Group” for documenting large applications. +The main information conveyed by an Application Solution is its list of relationships.', 'Class:ApplicationSolution/Attribute:functionalcis_list' => 'CIs', 'Class:ApplicationSolution/Attribute:functionalcis_list+' => 'All the configuration items that compose this application solution', 'Class:ApplicationSolution/Attribute:businessprocess_list' => 'Business processes', @@ -529,7 +533,9 @@ Dict::Add('EN US', 'English', 'English', [ Dict::Add('EN US', 'English', 'English', [ 'Class:BusinessProcess' => 'Business Process', - 'Class:BusinessProcess+' => '', + 'Class:BusinessProcess+' => 'A Business Process is used to document a high-level process or an important application for the operations. +It is quite similar to an Application Solution but for describing higher level applications or whole processes in the organization. +The main information conveyed by a Business Process is its list of relationships with Application Solutions and Contacts.', 'Class:BusinessProcess/Attribute:applicationsolutions_list' => 'Application solutions', 'Class:BusinessProcess/Attribute:applicationsolutions_list+' => 'All the application solutions that impact this business process', 'Class:BusinessProcess/Attribute:status' => 'Status', @@ -586,7 +592,7 @@ Dict::Add('EN US', 'English', 'English', [ Dict::Add('EN US', 'English', 'English', [ 'Class:DBServer' => 'DB Server', - 'Class:DBServer+' => '', + 'Class:DBServer+' => 'An instance of a database server software (like MySQL, Oracle, SQL Server, DB2…) running on a particular system (PC, Server or Virtual Machine).', 'Class:DBServer/Attribute:dbschema_list' => 'DB schemas', 'Class:DBServer/Attribute:dbschema_list+' => 'All the database schemas for this DB server', ]); @@ -596,8 +602,8 @@ Dict::Add('EN US', 'English', 'English', [ // Dict::Add('EN US', 'English', 'English', [ - 'Class:WebServer' => 'Web server', - 'Class:WebServer+' => '', + 'Class:WebServer' => 'Web Server', + 'Class:WebServer+' => 'An instance of a web server software running on a specific system (PC, Server or Virtual Machine).', 'Class:WebServer/Attribute:webapp_list' => 'Web applications', 'Class:WebServer/Attribute:webapp_list+' => 'All the web applications available on this web server', ]); @@ -608,7 +614,8 @@ Dict::Add('EN US', 'English', 'English', [ Dict::Add('EN US', 'English', 'English', [ 'Class:PCSoftware' => 'PC Software', - 'Class:PCSoftware+' => '', + 'Class:PCSoftware+' => 'An instance of a software application installed on a PC. +For example: an instance of MS Office, Corel Draw, Adobe Photoshop or Filezilla.', ]); // @@ -617,7 +624,7 @@ Dict::Add('EN US', 'English', 'English', [ Dict::Add('EN US', 'English', 'English', [ 'Class:OtherSoftware' => 'Other Software', - 'Class:OtherSoftware+' => '', + 'Class:OtherSoftware+' => 'Any type of software that do not fit in the other categories: PC Software, Middleware, DB server or Web Server.', ]); // @@ -626,7 +633,8 @@ Dict::Add('EN US', 'English', 'English', [ Dict::Add('EN US', 'English', 'English', [ 'Class:MiddlewareInstance' => 'Middleware Instance', - 'Class:MiddlewareInstance+' => '', + 'Class:MiddlewareInstance+' => 'An instance of a middleware software (software offering services to other software, or enterprise integration software) installed on a particular system (PC, Server or Virtual Machine). +For example: Tomcat, JBoss, Talend, Microsoft BizTalk, IBM Websphere or Lotus Domino can be put under this category.', 'Class:MiddlewareInstance/ComplementaryName' => '%1$s - %2$s', 'Class:MiddlewareInstance/Attribute:middleware_id' => 'Middleware', 'Class:MiddlewareInstance/Attribute:middleware_id+' => '', @@ -640,7 +648,7 @@ Dict::Add('EN US', 'English', 'English', [ Dict::Add('EN US', 'English', 'English', [ 'Class:DatabaseSchema' => 'Database Schema', - 'Class:DatabaseSchema+' => '', + 'Class:DatabaseSchema+' => 'An instance of dabatase running of a specific DB server.', 'Class:DatabaseSchema/ComplementaryName' => '%1$s - %2$s', 'Class:DatabaseSchema/Attribute:dbserver_id' => 'DB server', 'Class:DatabaseSchema/Attribute:dbserver_id+' => '', @@ -654,7 +662,7 @@ Dict::Add('EN US', 'English', 'English', [ Dict::Add('EN US', 'English', 'English', [ 'Class:WebApplication' => 'Web Application', - 'Class:WebApplication+' => '', + 'Class:WebApplication+' => 'An instance of an application accessible using a web browser and that runs on a given Web Server instance.', 'Class:WebApplication/ComplementaryName' => '%1$s - %2$s', 'Class:WebApplication/Attribute:webserver_id' => 'Web server', 'Class:WebApplication/Attribute:webserver_id+' => '', diff --git a/datamodels/2.x/itop-config-mgmt/dictionaries/en_gb.dict.itop-config-mgmt.php b/datamodels/2.x/itop-config-mgmt/dictionaries/en_gb.dict.itop-config-mgmt.php index 3f3e74dd4..154c4f3c7 100644 --- a/datamodels/2.x/itop-config-mgmt/dictionaries/en_gb.dict.itop-config-mgmt.php +++ b/datamodels/2.x/itop-config-mgmt/dictionaries/en_gb.dict.itop-config-mgmt.php @@ -596,7 +596,7 @@ Dict::Add('EN GB', 'British English', 'British English', [ // 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', diff --git a/datamodels/2.x/itop-config-mgmt/dictionaries/it.dict.itop-config-mgmt.php b/datamodels/2.x/itop-config-mgmt/dictionaries/it.dict.itop-config-mgmt.php index b691acb80..b26c050ee 100644 --- a/datamodels/2.x/itop-config-mgmt/dictionaries/it.dict.itop-config-mgmt.php +++ b/datamodels/2.x/itop-config-mgmt/dictionaries/it.dict.itop-config-mgmt.php @@ -577,7 +577,7 @@ Dict::Add('IT IT', 'Italian', 'Italiano', [ // 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', diff --git a/datamodels/2.x/itop-config-mgmt/dictionaries/sk.dict.itop-config-mgmt.php b/datamodels/2.x/itop-config-mgmt/dictionaries/sk.dict.itop-config-mgmt.php index d1d80a81a..f5d7204d7 100644 --- a/datamodels/2.x/itop-config-mgmt/dictionaries/sk.dict.itop-config-mgmt.php +++ b/datamodels/2.x/itop-config-mgmt/dictionaries/sk.dict.itop-config-mgmt.php @@ -577,7 +577,7 @@ Dict::Add('SK SK', 'Slovak', 'Slovenčina', [ // 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~~', diff --git a/datamodels/2.x/itop-structure/dictionaries/en.dict.itop-structure.php b/datamodels/2.x/itop-structure/dictionaries/en.dict.itop-structure.php index 7b2af60e4..794c9133d 100644 --- a/datamodels/2.x/itop-structure/dictionaries/en.dict.itop-structure.php +++ b/datamodels/2.x/itop-structure/dictionaries/en.dict.itop-structure.php @@ -48,7 +48,9 @@ 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', @@ -114,7 +116,7 @@ Dict::Add('EN US', 'English', 'English', [ Dict::Add('EN US', 'English', 'English', [ 'Class:Contact' => 'Contact', - 'Class:Contact+' => '', + 'Class:Contact+' => 'An abstract class', 'Class:Contact/ComplementaryName' => '%1$s - %2$s', 'Class:Contact/Attribute:name' => 'Name', 'Class:Contact/Attribute:name+' => '', @@ -152,7 +154,7 @@ Dict::Add('EN US', 'English', 'English', [ Dict::Add('EN US', 'English', 'English', [ 'Class:Person' => 'Person', - 'Class:Person+' => '', + 'Class:Person+' => 'A type of Contact', 'Class:Person/ComplementaryName' => '%1$s - %2$s', 'Class:Person/Attribute:name' => 'Last Name', 'Class:Person/Attribute:name+' => '', @@ -193,7 +195,7 @@ Dict::Add('EN US', 'English', 'English', [ 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.', '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', @@ -214,7 +216,7 @@ Dict::Add('EN US', 'English', 'English', [ Dict::Add('EN US', 'English', 'English', [ 'Class:Document' => 'Document', - 'Class:Document+' => '', + 'Class:Document+' => 'A document that can be shared across multiple objects', 'Class:Document/ComplementaryName' => '%1$s - %2$s - %3$s', 'Class:Document/Attribute:name' => 'Name', 'Class:Document/Attribute:name+' => '', @@ -250,7 +252,7 @@ Dict::Add('EN US', 'English', 'English', [ Dict::Add('EN US', 'English', 'English', [ 'Class:DocumentFile' => 'Document File', - 'Class:DocumentFile+' => '', + 'Class:DocumentFile+' => 'Any type of file stored as is. Its content is usually not accessible to search.', 'Class:DocumentFile/Attribute:file' => 'File', 'Class:DocumentFile/Attribute:file+' => '', ]); @@ -261,7 +263,7 @@ Dict::Add('EN US', 'English', 'English', [ Dict::Add('EN US', 'English', 'English', [ 'Class:DocumentNote' => 'Document Note', - 'Class:DocumentNote+' => '', + 'Class:DocumentNote+' => 'Simple text. Search can be performed on its content.', 'Class:DocumentNote/Attribute:text' => 'Text', 'Class:DocumentNote/Attribute:text+' => '', ]); @@ -272,7 +274,7 @@ Dict::Add('EN US', 'English', 'English', [ Dict::Add('EN US', 'English', 'English', [ 'Class:DocumentWeb' => 'Document Web', - 'Class:DocumentWeb+' => '', + 'Class:DocumentWeb+' => 'Simple URL to a remote document. Its content is not accessible to search.', 'Class:DocumentWeb/Attribute:url' => 'URL', 'Class:DocumentWeb/Attribute:url+' => '', ]); @@ -283,7 +285,8 @@ Dict::Add('EN US', 'English', 'English', [ 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', 'Class:Typology/Attribute:name' => 'Name', 'Class:Typology/Attribute:name+' => '', 'Class:Typology/Attribute:finalclass' => 'Typology sub-class', @@ -296,7 +299,7 @@ Dict::Add('EN US', 'English', 'English', [ 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.', ]); // @@ -305,7 +308,7 @@ Dict::Add('EN US', 'English', 'English', [ 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.', ]); //