cmdbuild usermanual eng v240

8/18/2019 CMDBuild UserManual ENG V240

1/80

» User Manual

March 2016

Author Tecnoteca srl

www.tecnoteca.com

ENG

www.cmdbuild.org

Version

2.4


2/80

User Manual

No part of this document may be reproduced, in whole or in part, without the express written permissionof Tecnoteca s.r.l.

CMDBuild ® uses many reat technoloies from the open source community!"ostre#$%, &pache, Tomcat, 'clipse, 'xt (#, (asper)eports, *)eport, 'nhydra #har+, T', -C#*nentory, %iferay, &lfresco, /eo#erer, -pen%ayers, "refuse, $uart0, BiMserer.e are than+ful for the reat contributions that led to the creation of these products.

CMDBuild ® is a pro1ect of Tecnoteca #rl. Tecnoteca isresponsible of software desin and deelopment, it2s the official

maintainer and has reistered the CMDBuild loo.

*n the pro1ect also the Municipality of Udine was inoled as theinitial customer.

CMDBuild ® is released under &/"% open source license 3http!44www.nu.or4licenses4apl56.7.html8

CMDBuild ® is a reistered trademar+ of Tecnoteca #rl.

'erytime the CMDBuild® loo is used, the official maintainer 9Tecnoteca srl9 must be mentioned: inaddition, there must be a lin+ to the official website!

http!44www.cmdbuild.or.

CMDBuild ® loo!

• cannot be modified 3color, proportion, shape, font8 in any way, and cannot be interated intoother loos

• cannot be used as a corporate loo, nor the company that uses it may appear as author 4 owner4 maintainer of the pro1ect

• cannot be remoed from the application, and in particular from the header at the top of eachpae

The official website is http://www.cmdbuild.org

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae


3/80

User Manual

Contents

*ntroduction...................................................................................................................................... =

CMDBuild modules...................................................................................................................................... = &ailable documentation.............................................................................................................................. >

/ettin #tarted................................................................................................................................. ?

CMDBuild philosophy.................................................................................................................................. ?/eneral Criteria........................................................................................................................................... @Aow to use CMDBuild.................................................................................................................................. @

User *nterface................................................................................................................................. 7

/eneral desin criteria............................................................................................................................... 7Control elements........................................................................................................................................ <illin in forms for data editin .................................................................................................................. 6Menu.......................................................................................................................................................... 6

#implified user interface............................................................................................................................ =

&ccessin the application............................................................................................................... ?

"C )euirements...................................................................................................................................... ? &uthentication............................................................................................................................................ ?

)elations raph..............................................................................................................................@

Eisual area................................................................................................................................................. FToolbar in the top riht...............................................................................................................................


4/80

User Manual *ntroduction

Introduction

CMDBuild is an -pen #ource web application desined to model and manae assets and sericescontrolled by the *CT Department, therefore it handles the related wor+flow operations, ifnecessary accordin to *T*% best practices.

The manaement of a Confiuration Database 3CMDB8 means +eepin up5to5date, and aailableto other processes, the database related to the components in use, their relations and theirchanes oer time.

ith CMDBuild, the system administrator can build and extend its own CMDB 3hence the pro1ectname8, modelin the CMDB accordin to the company needs: the administration module allows you toproressiely add new classes of items, new attributes and new relations. Iou can also define filters,9iews9 and access permissions limited to rows and columns of eery class.

CMDBuild proides complete support for *T*% best practices, which hae become a 9standard de

facto9 by now, a non5proprietary system for serices manaement with process5oriented criteria.

Than+s to the interated wor+flow enine, you can create new wor+flow processes with externalisual editors, and import 4 execute them inside the CMDBuild application accordin to theconfiured automatisms.

& tas+ manaer interated in the user interface of the &dministration Module is also aailable. *tallows to manae different operations 3process starts, e5mail receiin and sendin, connectorexecutions8 and data controls on the CMDB 3synchronous and asynchronous eents8. Based ontheir findins, it sends notifications, starts wor+flows and executes scripts.

CMDBuild includes also (asper)eports, an open source report enine that allows you to createreports: you can desin 3with an external editor8, import and run custom reports inside CMDBuild.

Then it is possible to define some dashboards made up of charts which immediately show the situationof some indicators in the current system 3J"*8.

CMDBuild interates &lfresco, the popular open source document manaement system. Iou canattach documents, pictures and other files.

Moreoer, you can use /*# features to eoreference and display assets on a eoraphical map3external map serices8 and 4 or an office plan 3local /eo#erer8 and B*M features to iew 6Dmodels 3*C format8.

The system includes also a #-&" and a )'#T webserice, to implement interoperability solutionswith #-&.

CMDBuild includes two framewor+s called Basic Connector and &danced Connector, which areable 5 throuh the #-&" webserice 5 to sync the information recorded in the CMDB with externaldata sources, for example throuh automatic inentory systems 3such as the open source -C#*nentory8 or throuh irtuali0ation or monitorin systems.

Throuh the )'#T webserice, CMDBuild /U* ramewor+ allows to issue custom webpaes onexternal portals able to interact with the CMDB.

& user interface for mobile tools 3smartphones and tablets8 is also aailable. *t is implemented asmulti5platform app 3i-#, &ndroid8 and lin+ed to the CMDB throuh the )'#T webserice.

CMDBuild modules

The CMDBuild application includes two main modules!

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae =


5/80

User Manual *ntroduction

• the &dministration Module for the initial definition and the next chanes of the data modeland the base confiuration 3relation classes and typoloies, users and authori0ation,dashboards, upload report and wor+flows, options and parameters8

• the Manaement Module, used to manae cards and relations, add attachments, runwor+flow processes, isuali0e dashboards and execute reports

The &dministration Module is aailable only to the users with the 9administrator9 role: theManaement Module is used by all the users who iew and edit data.

Available documentation

This manual is dedicated to the Manaement Module, throuh which the *T serice operators willbe able to update and iew cards, run processes, execute reports, eoreference items and performother utility features.

Iou can find all the manuals on the official website 3http!44www.cmdbuild.or8!

• system oeriew 39-eriew Manual98

• system administration 39&dministrator Manual98

• installation and system manaement 39Technical Manual98

• wor+flow confiuration 39or+flow Manual98

• webserice details and confiuration 3Kebserice ManualL8

• connectors to sync data throuh external systems 3KConnectorsManualL8

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae >


6/80

User Manual /ettin #tarted

etting !tarted

CMDBuild philosoph"

& CMDB is a storae and consultation system that handles the information assets of a company.

*t is the official central repository and proides a consistent iew of *T serices.

*t is a dynamic system that represents the current situation and +nowlede of informationtechnoloy assets and related entities! hardware 3computers, peripherals, networ+in, telephoneeuipment8, software 3basic, enironment, application software8, documents 3pro1ects, contracts,manuals8 and other resources, internal and external.

*t is a monitorin system for the processes executed, described and manaed throuh thewor+flow functions.

CMDBuild is a robust, customi0able and extensible CMDB solution.

"roidin an extensible solution means proidin an open and dynamic system that can be easilydesined, confiured and extended by the system administrator in different phases in terms of typesof ob1ects to manae, attributes and relations.

#ince there are not two orani0ations that operate exactly on the same set of ob1ects 3assets8 and,for each ob1ect, on the same information, we decided to set, as the primary CMDBuild feature, thesystem flexibility, deelopin features to confiure the whole system! data model, processes,reports, external systems connectors, etc.

To be more precise, the manaement features aailable in CMDBuild allow you to!

•

display the data cards of a class or a iew accordin to the aailable permissions 3on thewhole class or on subsets of rows and columns8

• carry out researches throuh the filter mechanisms aailable in the system, with thepossibility of storin a search filter and reuse it later

• use the confiured widets to run specific card functions

• consult the relations amon cards with a raphic tool or simply browsin the system

• insert or update data card, includin the notes field with ATM% editor

• create or edit relations amon cards, includin relations attributes

• upload card attachments

• eoreference ob1ects, maps or


7/80


eneral Criteria

The use of the Manaement Module assumes that the system administrator has defined, usin the &dministration Module, an initial data model for the system.

*t is not necessary for the initial model to describe all the properties manaed by the orani0ation, itis indeed important to adopt a policy to radually deelop the system throuh successie phases interms of cards and relations between them.

e recommend you to start by manain a small but complete set of ob1ects and relations andthen extend the system once the +nowlede and reuirements hae become clearer.

CMDBuild expects that operators use the Manaement Module to manae cards accordin to the

rules defined by the system administrator with the &dministration Module.

e recommend you to use CMDBuild!

• respectin procedures and permissions

• properly recordin data cards! a database with missin information is not useful

• recordin the new information, as soon as they are aailable, and updatin the existinones! an outdated system is not useful to anyone

#ow to use CMDBuild

The main purpose of CMDBuild is to!

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae @


8/80


• et updated information on each indiidual asset and relations with other assets or otherelements of the system

• find out the state of each asset and of each relation in any preious time

• update the information stored in the system 5 cards and documents 5 either indiidually orwith adanced functions for multiple chanes

• assist the operator by definin processes and implementin wi0ards

• refer to the dashboards for the control of basic manaement parameters

• create useful reports for the analysis of daily operations or historical trends and statistics

• carry out automatic actiities 3notification e5mails, wor+flow launch, script implementation8that follow operations 3such as e5mail receiin, wor+flow launch, chec+ on synchronousand asynchronous eents8 confiured throuh the Tas+ Manaer aailable in the &dministration Module

The most widely used features, rouped in the 9data cards9 section, are !• the consultation of the data cards of a class or a iew, accordin to the aailable

permissions 3on the whole class or on subsets of rows and columns8

• the card search, specifyin filters both on the data cards of the current class and on thoseof the relation classes, with the possibility of storin and reusin them

• card data oeriew, card relations and history

• perform specific functions 3widet8 confiured for that card

• sinle or multiple card print

• raphical naiation of card relations

• card data update

• relations definition, includin relations attributes

• card attachments upload

• card eoreference 3/*#8

• 6D model eoreference

The 9"rocesses tab9 has a powerful wor+flow enine for!

• process oeriew

• editin of pendin processes

The KDashboardL section allows to!

• display the dashboard list confiured in the system

• display the rids found in eery dashboard, with the possibility of consultin the eneratednumbers

The 9)eport9 tab also proides a powerful print enine for!

• custom desined reports 3i)eport8

• data export in C#E format or as a #$% uery

The 9Utilities9 tab includes some wi0ard to handle operations such as!

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae F


9/80


• edit all class attributes

• import data from external C#E files

• export data to C#E

• password chane

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae G


10/80

User Manual User *nterface

$ser InterfaceThe user interface uses &1ax technoloy.

This solution, part of the new eb


11/80


&dministration Module!



12/80


Control elements

%avigation chronolog"

Top riht there is an icon to access the chronoloy of those actions performed in the system startinfrom the last loin and to enter a card you hae already isited!

• naiation chronoloy

This list shows the seuence of actions and the related type, function and detail. *t allows een toreturn to the same position of the chosen row.

&esi'ing the main areas

The three main areas described aboe can be resi0ed by clic+in and drain the layout borders.

-n paes with a standard layout 3diided into upper and lower area8 you can 3only in ManaementModule8 act more uic+ly usin buttons located on the top riht to!

• expand to full5heiht card details area

• expand to full5heiht the data rid

• restore standard layout

(Accordion) menu

The menu on the left side is accordion5style and allows the user to open 4 close each item of thefirst leel with a simple clic+.

-penin 4 closin a menu entry toles the sub5elements of the selected entry.

rid management

The standard data rid manaement 3Manaement Module only8 permits to!

• sort on a specific column with a mouse clic+

• see additional columns in the rid 3amon aailable ones8

*n some cases you can call special features associated with a row of the rid simply by doubleclic+in on the item 3open relations, open document in the attachments tab, etc.8.

There is also a button to print 3"D or C#E8 data 3rows and columns8 that2s currently displayed inthe rid.

inally, usin the 9Map9 button it is possible to switch between textual and eoraphical modes.

*uic+ action on grid elements

*n some cases you can call special features associated with a row of the rid simply by doubleclic+in on the item 3open relations, open document in the attachments tab, etc.8.



13/80


!election filter

The selection filter, if defined, is aailable in two modes!

• uic+ search on all card attributes 3not 1ust those shown on the

rid8

• adanced search filter, which proides adanced filterin 3includedthe storin and the filter reuse8 and will be described in indiidualuse cases

Interactive help

*n some cards 3in particular in the process manaement8 there is a button in the lower riht cornerthat displays a panel with some compilation tips.

,illing in forms for data editing

Data cards compilation reuires different fields!

• numeric or strin type with simple content

• multiline text

• date type, with interactie calendar

• simple list select

• adanced list select 3with filterin options8

• formatted text 3with editor8

you can then use the widets 3buttons8 confiured for the card.

'ery insert operation includes confirmation and cancellation buttons

Menu

Both &dministration and Manaement modules wor+ on the same ob1ects, the first to setconfiuration options 3data structures8, the second to manae the information stored in theseob1ects 3cards8.

Both modules hae an 9&ccordion9 style menu and include the same entries, howeer for eachentry there are different options in the two modules!

• loo+up tables, definition of filters and iews, users and roups, definition of menu, /*#

confiuration, confiuration of base parameters in the &dministration Module

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae 6


14/80


• naiation menu 3list of items aailable to the current user, ordered in folders in a coherentand orani0ed way8 iews, dashboards and utilities in the Manaement Module

The Manaement Module proides an additional menu 5 the naiation menu 5 that includes a list

of items aailable to the current user: it2s possible to define a custom naiation menu usin the &dministration Module.

!implified user interface

Throuh proper confiuration parameters set in the &dministration Module 3/roups Manaement ;Confiuration User *nterface8, you can define a simplified interface for those users2 /roups thatdemand it.

*n particular, you can!

• hide one by one the headins of the accordion Menu placed in the left side of the pae

• hide one by one all T&Bs of the cards and of the processes

• hide the accordion Menu itself when openin the pae

• set an alternatie display mode of the cards 4 processes list and of the insertion or updateform of a card 4 process



15/80




16/80

User Manual &ccessin the application

Accessing the application

The Manaement Module is used by *T serice operators and can be used to iew and update thecards, run processes, execute reports and perform other utility operations.

-biously, the aboe actiities are aailable only if the system has been correctly confiured usinthe &dministration Module.

-C &euirements

CMDBuild is a web5based application, so both modules are aailable usin a standard webbrowser.

The system user has to arrane on his4her processor only an updated web browser 3irefox up toersion =6, Chrome up to ersion =F, Microsoft 'xplorer F or more recent up to ersion 78.

The web architecture ensures complete usability to any *T orani0ation that operates in multiplelocations 3ie collaboratie wor+flow8: any entrusted client can connect and interact with the systemusin a standard web browser.

Authentication

Iou must loin to use the application.

The loin form reuires a username, a password and eentually a lanuae selection 3if theapplication has been confiured to handle multiple lanuaes8

-nce the user has loed in, the system starts with the Manaement Module and only the usersthat hae the reuired role can switch to &dministration Module by clic+in on the lin+ on top of thepae 3isible by clic+in on the information panel located in the center8

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae ?


17/80

User Manual )elations raph

&elations graph

#ince this is a feature aailable in many situations, we describe now the details of the relationraph.

The purpose of the function is to!

• supply a 6D isual and interactie representation of the raph of relations stored inCMDBuild for the displayed node3s8

• allow interactie analysis throuh filters on cards and relations, raph explosions,application of pre5defined filters 3naiation trees8, application of other pre5defined functions

By desinin the new displayer, we were loo+in for a solution that could rant an optimal resultwhen iewin raphs that include 3een hih8 number of nodes and relations. &t the end we optedfor the 6D choice, which offers one more spatial dimension to wor+ on.

The user interface is diided into a raphical area on the left and a text area on the riht, which aresynchroni0ed.

urthermore, there are two toolbars, one on the top riht and one at the bottom riht.



18/80


isual areaThe isual representation of the raph includes!

• nodes, correspondin to the card 9root9 3to reuest the raph openin8 and to the correlated

cards. &ll of them are represented with a default icon or with icons that are preiouslyuploaded into the system accordin to their class

• archi, correspondin to the relations amon the nodes

or each node and transition there is a tooltip with the main information related to the item.

The selected nodes are hihlihted in yellow.

&ailable features in the isual area!

• selection of a node 3clic+ the riht mouse button8, with contextual presentation of the cardsand of the relations in the text area on the riht

• selection of addin nodes 3clic+ the left mouse button and hold CT)%8

•

9explosion9 of a node 3double clic+8, and openin of children nodes for the number of leelsset in the toolbar at the bottom riht

• KexplosionL of the whole raph, and openin of all children nodes for the number of leelsset throuh the slider of the toolbar at the bottom riht

• 0oom in the raph 3mouse wheel8, in order to explore some areas

• moin the whole raph 3riht button of the mouse8

• 6D rotation of the raph 3clic+ the riht button and moe the mouse on the pae area8

*n the followin screenshot you can see the result of the 6D rotation on the raph iewed on thepreious pae.

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae F


19/80


*n the followin screenshot you can see that, after double5clic+in on a node, its relations areopened.

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae G


20/80


Toolbar in the top rightThe toolbar aailable in the top riht includes the followin tools!

• KUndoL! it cancels the last operation

• K&pply the current layoutL! it sets the layout of the first openin pae

• K#top the current operationL! it stops the current operation

• KCenter the imaeL! it centers all nodes

• KCenter the layout on selectionL! it centers the raph onto the current element

• K#elect all nodesL! it selects all nodes

• KDelete selected nodesL! it deletes the selected nodes

• KDelete unselected nodesL! it deletes the non5selected nodes

• K-ped selected nodesL! it opens the relations of all selected nodes for the number

of leels set in the toolbar at the bottom riht

• K)eopen the raph from this nodeL! it re5opens the raph from the selected node

• K#elect the subraph that contains the selected elementsL!it selects the minimum sub5raph includin the selected nodes

• KChoose naiation treeL! it applies one of the pre5defined naiation raphs

*n the two followin screenshots you can see the result when applyin a naiation tree to a raph.



21/80




22/80


Te0t area*n the text area you can see!

• the card with the main attributes 3attributes 9Base display9, defined in the &dministration

Module8 and list of relations defined for that card• the card with all attributes, if necessary diided on arious paes

• the list of cards correspondin the nodes displayed on the raph

• the list of classes ownin the nodes displayed on the raph

*n the followin screenshots you can iew those data related to the node selected on the raph inthe T&B Card, only with the main attributes and relations 3first imae8 and with the complete cardattributes.

Note the openin of the relations with fie leels 3throuh the slider of the toolbar at the bottom8.



23/80


*n the three followin screenshots there are the nodes related to the cards selected in the T&BCards list.



24/80


Throuh the proper icon 3character KminusL8, you can iew only the selected data cards in the list3in the example, @ elements out of G8!

Throuh the field for the text search, you can een reduce the selected cards!



25/80


*n the followin screenshot there are all nodes belonin to the classes selected in the T&BClasses.

Below, under the text area, there are reiteratie data aboe the number of nodes and the displayedrelations.



26/80


Toolbar at the bottom rightThe toolbar aailable at the bottom riht includes the followin tools!

• K-pen the properties panelL! access to the confiuration pae

• K-pen the filter panelL! access to the pae of the filter settin

• K'nable 4 disableL tooltips on raphL! enable 4 disable tooltips on nodes andrelations

• K%eelsL! number of relation leels to open if reuired

• K#lider leelsL! another way to select the number of leels

• K%abelsL! to show on no nodes, only on selected nodes or on all nodes

Throuh the filter functions, you can select 4 deselect one or more classes and one or moredomains and iew the related results on the raph.

#election of classes!



27/80


)esults on the raph!

ilter on domains!



28/80


Aere2s the result after the application of labels on all raph nodes.

The followin screenshot shows the #etup panel 3the settins are still alid durin the currentsession, but they can be made persistent by the &dministration Module8.



29/80

User Manual Cards

Cards

Usin the Manaement Module it2s possible to access the information stored in the system,perform searches, update cards, create relations, see card history.

Card 1ist

or all the entries in 9Cards9 menu 3or for classes aailable in the naiation menu8 theManaement Module offers, on the top riht, the list 39rid98 of cards of the selected class. Thedetails of the sinle hihlihted card are shown on the bottom riht corner.

Cardlist manaement allows to!

• sort cards by clic+in on column header 3the first clic+ will sort

ascendin, the second descendin8

• add columns to the rid 3the default columns are defined in the &dministration Module8. The list of aailable columns5attributes isshown by clic+in on the column arrow 3screenshot8

• use the pae controls to moe one pae forward or bac+ward, moeto the first 4 last pae, moe to a specific pae number

• reload rid data 3refresh8

• access the 9adanced9 search system



30/80

User Manual Cards

• define a new search filter, selectin attribute alues for the card orfor the related cards 3see next pararaph8

• store the new search filter

• edit an existin filter

• clone an existin filter

• delete an existin filter

• delete a search filter

• perform a uic+ card search 3search on all class attributes, includedthose that are not displayed8

• print 3"D or C#E8 data 3rows and columns8 currently displayed inthe rid

• chane the pae layout by clic+in and drain the layout borders

• switch to map iew to display cards position on a map 4 plan

Definition of a new advanced search filter

& filter lets you search for cards usin multiple search criteria!

• search on all the attributes of the current class 3the conditions must be simultaneously alid,that is 9&ND98 with different operators and also by applyin more conditions on the sameattribute 3in this case it will be considered as 9-)98

• search on all the attributes of the classes related to the current card, either by selectinindiidual rows in the T&B 9%ist9 or by applyin filters on the attributes of the related class

•

search on all the attachments 3text5based attachments8*n the next example we extract computers hain 9'pson9 or 9Canon9 brand and containin thestrin 9Monitor9 in their description.

The search can be saed as filter and then reused by the same or other users who shared thatfilter with the administrator.



31/80

User Manual Cards

*n the next example we extract all computers assined to by 9Mary (ohnson9 or 9Michael Dais93the selected domain is 9&sset&ssinee98.



32/80

User Manual Cards

&lso in this case, you can sae and reuse the search.

The followin example extracts all the computers in one of the two data center rooms 3the domainis set to 9)oom asset98.

The two selection types 39%ist9 and 9ilter9 tabs8 can be used simultaneously, i.e. it is alwayspossible to narrow the list extracted by clic+in on the chec+boxes of the rows displayed.

hen the user confirms the search filter, the application searches matchin cards: the columnsshown are the ones defined in the &dministration Module.



33/80

User Manual Cards

Card TAB

*n addition to the card list 3common to all subpaes of this menu section8, the Card T&B shows the

list of attributes of the selected card.There is the possibility of performin the followin operations!

• create a new card by clic+in on the 9&dd card9 button

• edit an existin card by selectin the row and clic+in the 9Modify card9button

• delete an existin card by selectin the row and clic+in the 9Deletecard9 button 3loical delete8

• clone the current card

• open the relations raph for the selected card

• print current card

The layout of cards containin a lot of attributes can be rearraned by splittin the information intodata roups 3in the screenshot the roups are 9/eneral9, 9&dministratie data9 and 9Technicaldata98: usin then the tabs 3located on the top 4 bottom area 5 it depends on settins in the &dministration Module8 it2s possible to open only the selected roup of attributes.

The fields shown durin an insert or update operation are confiured usin the &dministrationModule. There are two 9'ditin modes9 you can set in the &dministration Module! 9'ditable9 foreditable attributes and 9)ead -nly9 for read5only attributes.



34/80

User Manual Cards

Dependin on the attribute type, the system uses in the form!

• standard input fields

• selection lists 39%oo+up9 fields type8

• reference fields with seeral options 3see example below8!• select a alue directly from the correspondin list or open the pop5up window to use

adanced features 39list9 and 9filter9 tabs as described in the preious pararaph8

• set alues for domain attributes 3those set in the &dministration Module as 9basedisplay98

• date fields, with calendar widet

hen the list of attributes exceed the isible area heiht, a scroll bar on the riht helps you scrolldown the whole list.

Usin the form buttons you can confirm or cancel current operation.

&ny alidation errors are hihlihted usin the current user lanuae.

*n the example below there2s a card with an ATM% field and a reference field 39#upplier98: on theriht there are four icons!

• the first opens the list with the names of the suppliers and lets you choose anoption

• the second allows you to reset the alue

• the third opens the adanced pop5up window 3see below8

• the fourth proides access to the relation attributes 3see below8

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae 6=


35/80

User Manual Cards

Below you can find the popup for 9&ssinee9 reference field alue, with adanced filterfunctionalities!

Below you can see a sample of manaement of those attributes defined on the 9domain9 where the

)eference field 9Technical reference9 is confiured 3in the example the role of the asset2s referent8!

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae 6>


36/80

User Manual Cards

2idget

idets 5 which can be confiured usin the &dministration Module 5 can be used to performspecific functions useful for the current card.

-n a common card, the followin widets can be confiured!

• Create report! it allows to print a report

• Calendar! it shows the specified deadlines on a calendar

• Naiation tree! it allows to select one or more datacards throuh an interface based on apreconfiured naiation tree 3subset of the domain raph8

• #tart wor+flow! it allows to start the specified wor+flow by usin a popup window 3thewor+flow will then o ahead with the common CMDBuild functions8

• "in! it performs a pin on the specified host

• Create or modify card! it allows to insert 4 edit a data card into a class that is different to thecurrent one

urther widets can be used 1ust within the wor+flows 3see the or+flow Manual8.

Below you can see examples of pop5up windows that CMDBuild creates in case of 9"in9 and9Calendar9 widets.

"in

Usin the 9"in9 widet, you can run a 9pin9 command on the *" address of the current computercard and erify its reachability.

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae 6?


37/80

User Manual Cards

Calendar

Usin the 9Calendar9 widet, you can chec+ the warranties by openin the calendar at the end ofthe warranty date of the current computer card.

Create report

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae 6@


38/80

User Manual Cards

*t allows to print a report amon the ones desined with *)eport and imported into CMDBuild.

*f the report includes certain parameters, they are reuired at renderin time.

Create or Modify Card

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae 6F


39/80

User Manual Cards

*t allows you to enter 3read5only or writable8 a data card of interest in spite of the current one

*n the followin example, startin from the card of a "C you can refer to eery assinee2s personaldata

1oc+ of a card in edit

*f the CMDBuild instance is confiured with the actie loc+ function and a user as+s for a data card ora wor+flow to be edited 39'dit card9 button8, the system reseres the card 4 process instance to thatuser for the period defined in the confiuration parameters.

*f another user tries to edit the same card 4 process instance in the same period, the followin errormessae appears!

KThe user username has edited the card for n secondsL.The card or process instance will be automatically released as soon asthe first user leaes the editin modality, throuh the button 9Confirm9or 9Cancel9.

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae 6G


40/80

User Manual Cards

Details TAB

or certain classes it can be useful to manae cards usin a 9master5slae9 schema, where 9slae9

cards are hierarchically related to 9master9 cards.This option can be enabled by usin the 9Master Detail9 chec+box on the correspondin domain,and definin in the detail 3slae8 class a reference field that refers to the main class 3master8.

*n the followin example we hae confiured a domain so that the assets located in a ien roomare connected, with a Master5Detail domain, to the room itself.

&s a conseuence, the master card will show a further selection list 3on the riht8 called 9Details9,which may include the name of one or more classes related to the 9Master9 class.

hen accessin the card list, an entry called 9&sset9 3the domain description8 will appear, andwhen selectin that entry we will et, in the tab 9Details9, the list of assets located in the current

room.

There is the possibility of performin the followin operations!

• create a new card usin the button on the top of the screen

• edit card

• delete card 3loical delete8

• open the relations raph for current card

• displays and allows the editin of the 9Notes9 field

• displays and allows you to manae documents attached to the card

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae =7


41/80

User Manual Cards

%otes TAB

Usin the 9Notes9 tab you can browse and update the 9Notes9 field, a field containin a descriptionof the selected card.

The 9Notes9 field is manaed usin an ATM% editor that allows arious formattin options 3type,si0e and font color, text alinment, lists8.



42/80

User Manual Cards

&elations TAB

The 9)elations9 T&B allows you to manae the relations of the current card.


• create a new relation for the current card

• open 3moe to8 the related card 3double clic+ on the card row8

• edit relation lin+in a different card

• delete relation 3loical delete8

• open or edit related card

• open the attachments of the lin+ed card

• open the relations raph to see actie relations

The relations are rouped by domain, with the possibility of collapsin or expandin each roup.

By default, the roups containin a number of relations minor than the threshold set in the &dministration Module are automatically expanded.

The application shows also the attributes defined for the domain 3if any8.

The relations tab is disabled if no domains inole the current class 3directly or throuh asuperclass8.



43/80

User Manual Cards

Create new relation

To create a new relation you can clic+ the 9&dd domain9 button that shows the list of domains3relationship type8 aailable for the current class.

The application opens a popup window with a list of cards, so you can select a card to beconnected either directly or by applyin some filters in the 9ilter9 tab.

Dependin on the domain cardinality, you miht be able to select more elements usinchec+boxes.

*n the next example we chose a card from the 9&sset9 class, then we selected the domain9proided by supplier9 and then we selected the 9Misco9 entry from the list of aailable suppliers.

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae =6


44/80


45/80

User Manual Cards

Move to related card

By clic+in on the reen arrow on the riht or by double5clic+in the row, the application moes tothe 9)elations9 T&B of the related card.

3dit relation

The edit function uses the same tool described for the creation of a new relation.

*n this case, howeer, the domain maintains the oriinal alue.

Delete relation

)elation is deleted, but loical delete is performed 3thus history is still aailable8.

Displa" related card

The application shows in a pop5up window the related card with all its attributes.

or example, this is the isuali0ation of the supplier card connected to the "C.

4pen relations graph

"lease refer to the specific chapter at the beinnin of this manual.

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae =>


46/80


47/80

User Manual Cards

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae =@


48/80

User Manual Cards

Attachments TAB

The 9&ttachments9 T&B allows you to iew the documents attached to the current card.

The application uses &lfresco DM# as storae system, howeer standard operations 3such asattach, open, delete, etc.8 ta+e place usin CMDBuild standard interface.

hen loadin a new attachment, the user must select a document type from a drop5down list: thislist must be defined usin &dministration Module 3administrator has to create a specific &lfresco%oo+up and set all the parameters into the &lfresco confiuration pae8.


• upload a new attachment

• download attachment 3open8

• edit attachment description

• delete attachment

The interation of &lfresco DM# reuires the creation of a specific CMDBuild area inside the &lfresco repository, creatin a folder dedicated to the first leel, a subfolder for each class and,inside, a subfolder for each card.

The attachment feature is completely interated in CMDBuild, so the use of &lfresco interface isnot necessary. Aoweer, those wishin to use the &lfresco interface will find the same documentsaailable in CMDBuild.

Attachments upload

The upload ta+es place usin a file upload form, the fields are!

• attachment cateory 3related to a specific loo+up 5 see the confiuration parameters in the &lfresco section of the &dministration Module8

• file

• attachment description

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae =F


49/80


50/80

User Manual Cards

Map management

By clic+in on the 9Map9 button you can see or chane the position of an ob1ect on the map 3or

plan8: let2s see how to confiure the /*# feature in CMDBuild.The prereuisites are!

• "ost/*# installation 3please refer to technical documentation for ersion number8

• actiation of "ost/*# operations in your database 3#$% scripts proided in the "ost/*#documentation8

The CMDBuild confiuration reuires!

• confiuration 5 in the &dministration Module 5 of at least one eoraphical attribute

• actiation of a map serice 3-pen #treet Map or /oole Maps or IahooO Maps8 and 4 oractiation of /eo#erer /*# serer for raster 4 ector files 3plans, etc.8

The /*# features aailable in CMDBuild, once you switch to map mode 3button 9Map9 on the rid8,include!

• switch to map mode

• bac+ to 9%ist9 mode

• 90oom in9 4 90oom out9, usin the mouse wheel or by usin the mapcontrols

•

Kpan9, by moin the mouse on the map

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae >7


51/80

User Manual Cards

• Kcontrol layerL, to actiate a preconfiured map serice and show oneor more layers for the current class

• /*# naiation tree, to o into details of an item and to display thoseelements contained in the lower leels: you can also o into the relatedcard by clic+in on the reen arrow on the riht

• list of elements of the current class, to display those elementscontained and to o into the related card by clic+in on the reen arrowon the riht

• KinfoL, i.e. display the list of those elements set in a certain point of themap, which can be reached by pressin the left button more than twoseconds: also in this case you can place into the related card byclic+in on the reen arrow on the riht

• 0oom leel and current coordinates of the mouse cursor

/*# features for the current cards include!

• display cards on the map: the selected card appears with a yellow

bullet while the other cards appear with the predefined attribute icon

• display the editin toolbar by enterin card editin mode

• select the eoraphical attribute 3if the current class has more thanone8

• add a new eoraphic element or moe an existin one 3theaddition of a new element automatically remoes the preiouslydefined element, causin its replacement8

• delete the existin eoraphic element for the current card



52/80

User Manual Cards

Throuh the described functionalities, you can et an adanced manaement of the asseteoreference.

#ample of items set onto the plan!



53/80

User Manual Cards

BIM viewer

The isible *C models should be imported in adance into CMDBuild 3or into its dedicated

B*Mserer repository8, throuh its proper function aailable in the &dministration Module.The *C files include entities and relations of the represented model, startin from a root class 3e..Buildin8

#uch root class is reconi0ed in the U* of CMDBuild. *n the card list it is supported by a specialicon that starts the iewer.

-nce it starts, the 6D iewer will show you a pop5up window li+e the followin one.

The functions aailable in the 6D iewer of B*M are subdiided into the three headins of theaccordion menu on the left!

• arious controls described in the followin table

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae >6


54/80

User Manual Cards

• list of layers that include the elements of the model, with the possibilityof showin 4 hidin each of them

• hierarchical tree of each element of the model, with the possibility ofshowin 4 hidin each of them and moin in the card of the elementclosin the iewer window

The detail functions aailable in the headin 9ControlsL 3first headin of the preious table8 include!

• Camera!

• )eset! restore the initial chec+point

• ront! show the model from the front chec+point

• #ide! show the model from the side chec+point

• Top! show the model from the top chec+point

• Mode

•

"an! it allows the moement of the model• )otate! it allows the rotation of the model

• Poom! it 0ooms the model

• 'xpose! by selectin a buildin floor, you can extract ithori0ontally from the buildin body and efficiently iew itsfeatures and its elements

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae >=


55/80

User Manual or+flow cards

2or+flow cards

CMDBuild wor+flow user interface proides, for all +inds of wor+flow!• list of open 4 closed process instances 3dependin on the alue selected in the combo8

• process details, in both read and write

• buttons to open sub5cards of the current wor+flow step to execute context5dependantoperations 3iew, create or edit data cards, create relations, select related cards, uploadattachments, etc.8

• a panel to display instructions for current wor+flow step 3button on the riht8

e proide a specific manual 3or+flow Manual8 dedicated to the confiuration and use of thewor+flow system. *n this chapter there are only some eneral information and screenshots relatedto the directions for use throuh the Manaement Module

This is a sample of form for a step that is part of a )fC manaement wor+flow.

(ust li+e the standard cards, wor+flow cards proide attributes, notes, relations and history.

*t2s possible to interact with the CMDBuild wor+flow usin simplified interfaces that miht be easierto use for non5technical users. They can be used to open a new support tic+et or to subscribe *Tserices or to alidate any actiities in authori0ation wor+flows.

Tal+in of this, CMDBuild proide a tool for the implementation of external interfaces calledCMDBuild /U* ramewor+, which interacts with CMDBuild throuh the webserice )'#T.

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae >>


56/80


*t allows an 3almost8 unlimited freedom when pro1ectin the raphic layout, defined throuh an HM%descriptor and with the possibility of interenin on the C##, and it allows you to use it in portalsbased on different technoloies, since it is deeloped in 1aascript 4 (uery enironment.

-n the other side, the /U* ramewor+ confiuration needs a 1aascript code customi0ation, that issimplified than+s to predefined functions 3communication, authentication loics, etc.8 and to natieraphic solutions 3forms, rids, upload buttons and other widets8

#ample of interface for the adancement of a process.

&s an alternatie, CMDBuild proides a standard solution to issue some features in the form of"ortlet 3standard (#)


57/80


This solution is ery adantaeous because it can adapt to the related CMDBuild instance withoutdeelopin a code for the manaement of the interaction between two enironments.

*ts limit is its 9self adaptability9 itself that does not allow any +ind of customi0ation.

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae >@


58/80


Card TAB

By selectin the function of )fC process manaement, the system shows the )fC as open 3or in

the selected status chosen in the upper list! open, suspended, complete, aborted, all8.Throuh the button K#tart )euest for ChaneL the Aelpdes+ can reister a new reuest.

"rior to fill in the form, the operator can refer to the operatie instructions associable with eeryuser actiity 3by wor+in in the H"D% file which describes the process flow8.

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae >F


59/80


2idget

idets confiured usin the &dministration Module can be used to perform specific functionsuseful for the current user2s actiity.

These widets can be classified as follows!

• Create or modify card! create or modify a datacard in a specified class

• Manae relation! create, edit or lin+ cards 3create relations8 to the main card

• %in+ card! select cards from a filtered list 3the filter is specified usin the C$% lanuae8,with a eoraphical extension to select dots and ployons on the map

• ebserice! select a record from a list by ueryin an external webserice 3e.. databasesused in the wor+flow8

•

'mail manaement 3with parameter substitution, also obtained with C$% uery8• &ttachment! attachment manaement

• Note! notes manaement with I#*I/ editor

• Create report! run reports 3the report may be attached to the process and sent ia mail8

• 'dit rid! compilin a table with seeral rows 3data cards8 and columns 3data cardattributes8, with the possibility of addin or deletin rows or importin them from C#E files

• #tart wor+flow! startin another selected static wor+flow 3accordin to the definition ofwor+flow8 or a dynamic selected wor+flow 3durin the start of the wor+flow8

• Naiation tree! it allows to select one or more datacards throuh an interface based on a

preconfiured naiation tree 3subset of the domain raph8

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae >G


60/80


30ample 5: 1in+ card

The widet allows in this example to select one or more cards from a filtered list of assets 3locatedin the predefined office8.

*n this example, the wor+flow proides access to the wor+space usin the button!

The wor+ area in the -ptions T&B has the followin interface 3the select mode, sinle or multiple,can be modified8!

30ample 6: Manage email


The wor+ area in the -ption T&B has the followin interface!

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae ?7


61/80


*t2s possible to create automatically emails usin a preset template, fill it out manually, orincorporate free text in an email automatically enerated.



62/80


hen you are writin an e5mail, you can attach documents by uploadin them both from your ownfile system and from the ones filed in the document system interated in CMDBuild.

The fields KToL and KCCL can include one or more e5mail addresses: in case of seeral addresses

the separator should be K,L.

30ample 7: Attachment management


The wor+ area in the -ption T&B has the followin interface!



63/80


&elations TAB

&bout the processes cards, you can refer the relations created durin the actiity proress.

The relations can be manually created from the user interface or direct from the system throuhautomatisms based on &"*s confiured in the process.

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae ?6


64/80


#istor" TAB

)eferrin to the Aistory T&B you can +now the complete seuence of each sinle proress actiity,

their users, beinnin and endin date.#uch information can be used throuh report and dashboard to calculate and proide experienceindexes 3J"*8 of the serice effectieness 3#%& control8.

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae ?=


65/80

User Manual Dashboard

Dashboard

CMDBuild includes the possibility of confiurin one or more 9dashboard9 paes: each of them canbe addressed to a different typoloy of aspects which should be controlled! asset situation, sericedes+ performances, cost allocation, etc.

'ery dashboard is made up of a number of charts with different typoloies! pie, bar, line, auechart.

%i+e all CMDBuild components, also the dashboards are confiured in the &dministration Moduleand can be referred in the Manaement Module, both with the specific Dashboard headin of theaccordion menu and in the Naiation Menu.

or eery dashboard chart you can perform the followin operations!

• display or hide the controls to edit the possible proided parameters

• display the complete list of the alues for the chart calculation

• update the chart display

• if reuired, edit the analysis parameters, and update the chart display

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae ?>


66/80


*n the followin sample you can see how you can edit the alori0ation of the proided parameter inthe bar chart, in this case the analysis class.

*n the followin sample you can see how the alue list for the bar chart calculation can be

demanded and shown.

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae ??


67/80


The dashboards are performed throuh proper components of the 'xt (# library, which the wholeCMDBuild user interface is implemented with, and include some interaction mechanisms for thedata reference.

*n the followin sample, if you place the mouse on a pie chart area, the area will be hihlihted andthe correspondin numeric alue will be presented.

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae ?@


68/80

User Manual )eport

&eport

CMDBuild includes and uses a powerful report enine 3(asper)eport8 able to create dynamicreports that are desined usin an external isual editor 3i)eport8 and then imported usin the &dministration Module.

The report enine supports these formats!

• "D

• C#E, used to import data into spreadsheets

• -DT, used to import data into a word processor

&eport t"pes and features

*)eport editor has the followin features!

• text formattin options 3font, text alinment, space, colour, etc.8

• standard elements definition 3header, footer, column headins, summary, etc.8

• data roupin

• expressions ealuation

• computed fields

• adanced subreports manaement

• barcodes support

• eometric elements 3lines, rectanles8

• imaes and charts 3pie, bar, /antt, etc.8

Usin these features it2s possible to create and import in CMDBuild!

• tabular reports with roups and totals 3multi5leel option8

• reports with imaes and loos

• reports with statistics and raphs

• labels with barcodes

Custom report parameters can be defined and then reuired at renderin time Before renderin,CMDBuild will present a popup with the reuired report parameters 3i.e. computer name, daterane, etc8

%oo+up and )eference parameters will be displayed automatically as a dropdown list with

predefined alues.)eports imported into CMDBuild can be executed!

• selectin the report from the naiation menu 3if aailable8 in the top5left column

• accessin the list of aailable reports 3for the current user8 by choosin the 9)eport9 menuin the left column

#creenshot of report selection 4 execution

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae ?F


69/80


70/80

User Manual Utility features

$tilit" features

#ome of the utility features are!• password chane

• massie card data editin

• C#E export

• C#E import

-assword change

This operation allows the user to set a new password: the user has to insert the old password toconfirm the chane.

User must insert the new password twice 3to aoid typin errors8.

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae @7


71/80


Massive card editing

This feature allows you to chane the alue of one or more attributes of a selected set of cards.

&t first you hae to select a class from the ones aailable in the top left menu.

Then you can create filters to select the cards you want to edit usin both the uic+ filter or theadanced one 3described on preious paes8.

Next you can manually select the sinle cards to apply the chane, or you may select all the cardsin the list by clic+in the chec+box at the top of the last column.

-nce selected the cards, you hae to select 3chec+box8 the attributes you want to chane andinsert the new alue.

inally, you hae to confirm the operation by clic+in the 9Confirm9 button.

Before performin the editin operation, the system shows the number of the cards that will beedited, demandin an ac+nowledment or the cancellation of the operation.

*n the next example we chane all the cards with 9A"9 brand, settin the 9&cceptance date9 to7?47G4


72/80


Import C! data

The C#E 3Comma #eparated Ealue8 file import is a useful feature that allows you to upload data to

CMDBuild usin a 9wi0ard9: this is a fast way to upload a lot of cards into the application within fewsteps.

This operation is performed throuh the user interface, as shown below, and not by ueryin thedatabase, because we want the application to control and alidate data before insertion.

*t is important to notice that the import operation always appends data, so imported cards are alwaysadded to the existin ones.

The import operation includes these steps.

!tep 5

The first step includes!

• class selection 3the import operation wor+s only on a sinle class8

• C#E file selection

• fields separator selection! 9,9 3comma8 or 9:9 3semicolon8 or 9Q9 39pipe98

Confirmin the operation with the 9Upload9 button, the application will import data from thespecified file, showin imported cards in the standard rid.

#creenshot of user interface proided by the system.

The first row of the C#E file will include the columns headins.

The system will match only the columns in the C#E file with the attributes names 3note! the name,



73/80


N-T the description8 defined usin &dministration Module 3i.e. the column name in the databasetable8.

The import function will propose the C#E file contents as table on the CMDBuild pae, hihlihtin

in red possible inalid rows 3column name not identified, compulsory columns not present, datatype inalid or not correspondin to the database, etc8.

%oo+up attributes must match 3uppercase4lowercase, blan+ spaces, etc.8 the loo+up description asstated, at reistration time, in the &dministration Module.

)eference attributes must match the 9Code9 3note! 9Code9, N-T 9Description98 field of the relatedcard 3uppercase4lowercase, blan+ spaces, etc.8.

Dates must be written usin dd4mm4yy format

*n the C#E file, only the rows with the column number proided in the headin row are consideredalid! you hae to pay attention not to insert any additional empty rows or columns in the C#E file.

The example shows some errors on reference fields.

!tep 6

The next step is the correction of any hihlihted errors, which can be done by double5clic+in onthe field and chanin the alue 3as shown in the screenshot8.

&lternatiely, it is possible to modify the C#E file and retry the import operation.

-nce resoled the errors, you can press the 9Update9 button to re5run data alidation.

inally, if there are no errors, you will complete the operation by filin the cards in the database.

"lease, remember that the data import operation always appends data, so new cards are alwaysadded to the existin ones 3otherwise it creates an error if there is a duplicate +ey8.

Below you can find a screenshot of the user interface proided by the system for the final loadin.

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae @6


74/80


75/80


30port C! data

This feature allows you to create a C#E 3Comma #eparated Ealue8 file that contains class data,

usin the selected field separator 3possible separators are 9,9, 9:9 and 9Q98.The browser will as+ you to sae or open the file usin the application associated with the fileextension 9cs9.

#creenshot of user interface proided by the system.

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae @>


76/80

User Manual &""'ND*H! /lossary

A--3%DI8: lossar"

ATTAC#M3%T

&n attachment is a file associated to a card.

&ttachments containin text 3"D, -pen -ffice, Microsoft ord, etc.8 are indexed in full text modeso that they can appear in search results.

24&9,142 !T3-

9&ctiity9 means one of the steps of which the process consists.

&n actiity has a name, an executor, a type, possible attributes and methods with statements3CMDBuild &"*8 to be executed.

& process instance is a sinle process that has been actiated automatically by the application ormanually by an operator.

#ee also! "rocess

ATT&IB$T3

The term refers to an attribute of a CMDBuild class.

CMDBuild allows you to create new attributes 3in classes and domains8 or edit existin ones.

or example, in 9supplier9 class the attributes are! name, address, phone number, etc..

'ach attribute corresponds, in the Manaement Module, to a form field and to a column in thedatabase.

#ee also! Class, Domain, )eport, #uperclass, &ttribute Type

BIM

Method with the aim to support the whole life cycle of a buildin! from its construction, use andmaintenance, to its demolition, if any.

The B*M method 3Buildin *nformation Modelin8 is supported by seeral *T prorams that caninteract throuh an open format for data exchane, called *C 3*ndustry oundation Classes8.

#ee also! /*#

CI

e define C* 3Confiuration *tem8 each item that proides *T serice to the user and has asufficient detail leel for its technical manaement.

C* examples include! serer, wor+station, software, operatin system, printer, etc.

#ee also! Confiuration

C1A!!

& Class is a complex data type hain a set of attributes that describe that +ind of data.

& Class models an ob1ect that has to be manaed in the CMDB, such as a computer, a software, aserice proider, etc.

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae @?


77/80


CMDBuild allows the administrator 5 with the &dministration Module 5 to define new classes ordelete 4 edit existin ones.

Classes are represented by cards and, in the database, by tables automatically created at the

definition time.#ee also! Card, &ttribute

C4%,I$&ATI4%

The confiuration manaement process is desined to +eep updated and aailable to otherprocesses the items 3C*8 information, their relations and their history.

*t is one of the ma1or *T*% processes manaed by the application.

#ee also! C*, *T*%

DA!#B4A&D

*n CMDBuild, a dashboard corresponds to a collection of different charts, in this way you canimmediately hold in eidence some +ey parameters 3J"*8 related to a particular manaementaspect of the *T serice.

#ee also! )eport

DATABA!3

The term refers to a structured collection of information, hosted on a serer, as well as utilitysoftware that handle this information for tas+s such as initiali0ation, allocation, optimi0ation,bac+up, etc..

CMDBuild relies on "ostre#$%, the most powerful, reliable, professional and open source

database, and uses its adanced features and ob1ect5oriented structure.

D4MAI%

& domain is a relation between two classes.

& domain has a name, two descriptions 3direct and inerse8, classes codes, cardinality andattributes.

The system administrator, usin the &dministration Module, is able to define new domains ordelete 4 edit existin ones.

*t is possible to define custom attributes for each domain.

#ee also! Class, )elation

DATA ,I1T3&

& data filter is a restriction of the list of those elements contained in a class, obtained by specifyinboolean conditions 3eual, not eual, contains, beins with, etc.8 on those possible alues that canbe accepted by eery class attribute.

Data filters can be defined and used exceptionally, otherwise they can be stored by the operatorand then recalled 3by the same operator or by operators of other user roups, which et thepermission to use them by the system &dministrator8

#ee also! Class, Eiew

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae @@


78/80


79/80


#ee also! or+flow step

&31ATI4%

& relation is a lin+ between two CMDBuild cards or, in other words, an instance of a ien domain. & relation is defined by a pair of uniue card identifiers, a domain and attributes 3if any8.

CMDBuild allows users, throuh the Manaement Module, to define new relations amon thecards stored in the database.

#ee also! Class, Domain

&3-4&T

The term refers to a document 3"D or C#E8 containin information extracted from one or moreclasses and related domains.

CMDBuild users run reports by usin the Manaement Module: reports definitions are stored in the

database.

#ee also! Class, Domain, Database

CA&D

The term 9card9 refers to an element stored in a class.

& card is defined by a set of alues, i.e. the attributes defined for its class.

CMDBuild users, throuh the Manaement Module, are able to store new cards and update 4delete existin ones.

Card information is stored in the database and, more exactly, in the table4columns created for thatclass 3&dministration Module8.

#ee also! Class, &ttribute

!$-3&C1A!!

& superclass is an abstract class used to define attributes shared between classes. rom theabstract class you can derie real classes that contain data and include both shared attributes3specified in the superclass8 and specific subclass attributes.

or example, you can define the superclass 9Computer9 with some basic attributes 3)&M, AD,etc.8 and then define deried subclasses 9Des+top9, 9Noteboo+9, 9#erer9, each one with somespecific attributes.

#ee also! Class, &ttribute

ATT&IB$T3 T-3

'ach attribute has a data type that represents attribute information and manaement.

The attribute type is defined usin the &dministration Module and can be modified within somelimitations, dependin on the data already stored in the system.

CMDBuild manaes the followin attribute types! 9Boolean9, 9Date9, 9Decimal9, 9Double9, 9*net9 3*"address8, 9*nteer9, 9%oo+up9 3lists set in 9#ettins9 4 9%oo+Up98, 9)eference9 3forein +ey8, 9#trin9,9Text9, 9Timestamp9.

#ee also! &ttribute

CMDBuild ; -pen #ource Confiuration and Manaement Database "ae @G


80/80


I32

& iew not only includes the whole content of a CMDB class, it is a roup of cards defined in aloical way.

*n particular, a iew can be defined in CMDBuild by applyin a filter to a class 3so it will contain areduced set of the same rows8 or specifyin an #$% function which extracts attributes from one ormore related classes.

The first iew type maintains all functionalities aailable for a class, the second one allows the soledisplay and search with fast filter.

#ee also! Class, ilter

23B!3&IC3

& webserice is an interface that describes a collection of methods, aailable oer a networ+ andwor+in usin HM% messaes.

ith webserices, an application allows other applications to interact with its methods.CMDBuild includes a #-&" and a )'#T webserice.

2ID3T

& widet is a component of a /U* that improes user interaction with the application.

CMDBuild uses widets 3presented as 9buttons98 that can be placed on cards or processes. Thebuttons open popup windows that allow you to insert additional information, and then display theoutput of the selected function.

cmdbuild usermanual eng v240

Documents