cmdbuild workflowmanual eng v240

8/18/2019 CMDBuild WorkflowManual ENG V240

1/70

» Workflow Manual

March 2016

Author Tecnoteca srl

www.tecnoteca.com

ENG

www.cmdbuild.org

Version

2.4


2/70

Workflow 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 technolo!ies from the open source community"#ost!re$%&, 'pache, Tomcat, (clipse, (xt )$, )asper*eports, +*eport, (nhydra $hark, TW(, C$+n-entory, &iferay, 'lfresco, eo$er-er, pen&ayers, #refuse, %uart/, BiMser-er.We are thankful for the !reat contributions that led to the creation of these products.

CMDBuild is a pro0ect of Tecnoteca $rl. Tecnoteca isresponsible of software desi!n and de-elopment, it1s the official

maintainer and has re!istered the CMDBuild lo!o.

+n the pro0ect also the Municipality of 2dine was in-ol-ed as theinitial customer.

CMDBuild is released under '#& open source license 3http"44www.!nu.or!4licenses4a!pl56.7.html8

CMDBuild is a re!istered trademark of Tecnoteca $rl.

(-erytime the CMDBuild lo!o is used, the official maintainer 9Tecnoteca srl9 must be mentioned: inaddition, there must be a link to the official website"

http"44www.cmdbuild.or!.

CMDBuild lo!o"

• cannot be modified 3color, proportion, shape, font8 in any way, and cannot be inte!rated intoother lo!os

• cannot be used as a corporate lo!o, nor the company that uses it may appear as author 4 owner4 maintainer of the pro0ect

• cannot be remo-ed from the application, and in particular from the header at the top of eachpa!e

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

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e


3/70


4/70

Workflow Manual

Introduction

CMDBuild is an pen $ource web application desi!ned to model and mana!e assets and ser-icescontrolled by the +CT Department, therefore it handles the related workflow operations, ifnecessary accordin! to +T+& best practices.

The mana!ement of a Confi!uration Database 3CMDB8 means keepin! up5to5date, and a-ailableto other processes, the database related to the components in use, their relations and theirchan!es o-er time.

With CMDBuild, the system administrator can build and extend its own CMDB 3hence the pro0ectname8, modelin! the CMDB accordin! to the company needs: the administration module allows you topro!ressi-ely add new classes of items, new attributes and new relations. Fou can also define filters,9-iews9 and access permissions limited to rows and columns of e-ery class.

CMDBuild pro-ides complete support for +T+& best practices, which ha-e become a 9standard de

facto9 by now, a non5proprietary system for ser-ices mana!ement with process5oriented criteria.

Thanks to the inte!rated workflow en!ine, you can create new workflow processes with external-isual editors, and import 4 execute them inside the CMDBuild application accordin! to theconfi!ured automatisms.

' task mana!er inte!rated in the user interface of the 'dministration Module is also a-ailable. +tallows to mana!e different operations 3process starts, e5mail recei-in! and sendin!, connectorexecutions8 and data controls on the CMDB 3synchronous and asynchronous e-ents8. Based ontheir findin!s, it sends notifications, starts workflows and executes scripts.

CMDBuild includes also )asper*eports, an open source report en!ine that allows you to createreports: you can desi!n 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 3E#+8.

CMDBuild inte!rates 'lfresco, the popular open source document mana!ement system. Fou canattach documents, pictures and other files.

Moreo-er, you can use +$ features to !eoreference and display assets on a !eo!raphical map3external map ser-ices8 and 4 or an office plan 3local eo$er-er8 and B+M features to -iew 6Dmodels 3+C format8.

The system includes also a $'# and a *($T webser-ice, to implement interoperability solutionswith $'.

CMDBuild includes two frameworks called Basic Connector and 'd-anced Connector, which areable 5 throu!h the $'# webser-ice 5 to sync the information recorded in the CMDB with externaldata sources, for example throu!h automatic in-entory systems 3such as the open source C$+n-entory8 or throu!h -irtuali/ation or monitorin! systems.

Throu!h the *($T webser-ice, CMDBuild 2+ ramework allows to issue custom webpa!es onexternal portals able to interact with the CMDB.

' user interface for mobile tools 3smartphones and tablets8 is also a-ailable. +t is implemented asmulti5platform app 3i$, 'ndroid8 and linked to the CMDB throu!h the *($T webser-ice.

CMDBuild modules

The CMDBuild application includes two main modules"

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e =


5/70

Workflow Manual

• the 'dministration Module for the initial definition and the next chan!es of the data modeland the base confi!uration 3relation classes and typolo!ies, users and authori/ation,dashboards, upload report and workflows, options and parameters8

• the Mana!ement Module, used to mana!e cards and relations, add attachments, runworkflow processes, -isuali/e dashboards and execute reports

The 'dministration Module is a-ailable only to the users with the 9administrator9 role: theMana!ement Module is used by all the users who -iew and edit data.

Available documentation

This manual describes the workflow process included in the CMDBuild application, throu!h whichyou can confi!ure 3'dministration module8 and run 3Mana!ement Module8 processes for themana!ement of collaborati-e acti-ities.

Fou can find all the manuals on the official website 3http"44www.cmdbuild.or!8"

• system o-er-iew 39-er-iew Manual98

• system administration 39'dministrator Manual98

• system usa!e 3G2ser ManualH8

• installation and system mana!ement 39Technical Manual98

• webser-ice details and confi!uration 3GWebser-ice ManualH8

• connectors to sync data throu!h external systems 3GConnectorsManualH8

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e >


6/70

Workflow Manual

Description of the worflow s!stem

"eneral Information

+n order to support +T+& methodolo!ical indications, CMDBuild is able not only to mana!e theupdate of the asset in-entory and their functional relations, but also to enable the definition andcontrol of the processes for +T ser-ice mana!ement.

' process includes an acti-ity seIuence, carried out by operators and4or computer applications,e-ery application represents an operation that has to be carried out within the process, related, inthis case, to the +T asset mana!ement with Iuality criteria.

i-en the amount of processes options, the or!ani/ational procedures and the flexibility pursuedby the CMDBuild pro0ect, we chose not to implement a series of ri!id and predefined processes,but a !eneric workflow en!ine to model processes case5by5case.

+n the first part of this document you wil find !eneral concepts and basic mechanisms implementedin the system with the CMDBuild


7/70

Workflow Manual

3http"44www.to!ether.at4prod4workflow4twe8 for the workflow desi!n and for the definition ofinte!ration mechanisms with CMDBuild

The followin! schema shows the workflow mana!ement accordin! to the model standardi/ed with

the WfMC.

Terminolog!

The followin! 9-ocabulary9 includes the followin! terms"

• process" seIuence of steps that reali/e an action

• acti-ity" workflow step

• process instance" acti-e process created executin! the first step

• acti-ity instance" creation of an acti-ity, accomplished automatically or by an operator

The abo-e terms are arran!ed into CMDBuild as follows"

• each process is related to a special class defined by the 'dministration Module under theheadin! 9#rocesses9: the class includes all attributes of the scheduled acti-ities

• each 9process instance9 corresponds to a card of the 9process9 class 3current acti-ity8,

combined with the list of its -ersions 3ended acti-ities8

• each acti-ity instance corresponds to a card of the 9process9 class 3current acti-ity8 or to ahistorici/ed -ersion 3ended acti-ity8

(ach process has a name, one or more participants, some -ariables and a seIuence of acti-itiesand transitions which carry out it.

The process status can be"

• Gacti-eH, i.e. it is still in an intermediate acti-ity

• GcompleteH, i.e. it ends its acti-ity

• GabortedH, i.e. unnaturally terminated

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e @

http://www.together.at/prod/workflow/twehttp://www.together.at/prod/workflow/twe


8/70

Workflow Manual

• GsuspendedH, i.e. maintained only for retrocompatibility with workflow system untilCMDBuild .>

(ach acti-ity can be distin!uished by"

• a name

• a performer, which necessarily corresponds to a 9user !roup9 and optionally to an operator

• a type" process start, process endin!, acti-ity performed by an operator, acti-ityautomatically carried out by the system

• any attributes comin! from CMDBuild or inside the workflow, which will be set durin! itsimplementation

• any wid!ets 3-isual controls of some predefined typolo!ies8 that will be acti-ated durin! itsimplementation

• a script 3in the Beanshell, roo-y or )a-ascript lan!ua!es8, pro-ided in the automaticacti-ities, throu!h which the operations between an user acti-ity and the followin! can be

carried out

%efactoring &.'

With the


9/70

Workflow Manual

+t is ad-isable to mi!rate in a short time, since the double CMDBuild compatibility with To!etherWorkflow $er-er


10/70

Workflow Manual

Implementation method

(orflows as special classesThe mechanisms for the workflow mana!ement are implemented in CMDBuild throu!h conceptsand procedures entirely consistent with the mechanisms already in the system for the mana!ementof the cards.

The workflow mana!ement includes"

• GspecialH #rocess classes: each corresponds to a type of workflow

• attributes, correspondin! to the information presented 3for read or write8 in the forms whichmana!e the reali/ation of each sin!le step of the process

• relations with other process instances or standard cards in-ol-ed in the process

• users1 !roups, that will be able to perform e-ery acti-ity, coincidin! with CMDBuild users1!roups

• special tools for customi/in! the beha-ior of the workflow 3wid!ets and scripts written withproper '#+s8

Within the same homo!eneity criteria between 9normal9 and 9process9 classes, we adopted thefollowin! technical tactics"

• the new 9confidential9 superclass called 9'cti-ity9 contains some attributes shared withspecific workflows, whose workflows are underclasses

• the 9history9 mechanism was used to draw the pro!ress reports of a process

• the 9relations9 mechanism has been kept to create automatic or manual links between acard and a process instance, or between two process instances

Building the worflow

The tools usable throu!h the workflow -isual editor are of utmost importance in enablin! the desi!nof complex processes, and include"

• the choice of those attributes which can be placed on each form correspondin! to a useracti-ity

• the choice of those wid!ets 3-isual controls8 which can be placed on each formcorrespondin! to a user acti-ity 3-iewin! or creatin! or editin! cards, -iewin! or creatin!relations, sin!le or multiple selection of cards, upload of the attached files, implementationof reports8

• flow5control mechanisms, amon! them parallel acti-ities and subprocesses

• scriptin! lan!ua!e 3Bean$hell, roo-y or )a-ascript8 for the definition of those automatismswhich must be carried out between a user acti-ity and the followin!

• '#+ functions which can be called in the scripts

+f you are interested in the documentation of further mechanisms used in the workflows, de-elopedfor CMDBuild -ersions until .> 3and supported in CMDBuild


11/70

Workflow Manual

Defining a new process

To create a new 9#rocess9 class, you should follow the next lo!ic seIuence of passa!es"

• analysis of the new process which has to be implemented, in order to sin!le out"

▫ list of the users1 !roups in-ol-ed in the process

▫ workflow" user acti-ities, automatic acti-ities, transition conditions, etc.

▫ descripti-e attributes of the process in its user acti-ities and the related typolo!ies3strin!s, inte!er, etc.8 and the presentation mode 3read5only, readin! and writin!,possible compulsoriness8

▫ predefined lists of -alues reIuired for the creation of 9&ookup9 attributes

▫ domains reIuired to deal correlations between the new process and other classes orother pre5existin! processes 3which mi!ht also be used to create the 9*eference9attributes8

▫ wid!ets to confi!ure in e-ery user acti-ity

▫ wid!ets to confi!ure in e-ery automatic process acti-ity

• creation of the new process class, which will be defined in the 9#rocesses9 section of theCMDBuild 'dministration Module, complete of"

▫ specific attributes identified in the pre-ious step

▫ domains identified in the pre-ious step

• creation of missin! users1 !roups, that should be added throu!h the 'dministration Module

• throu!h the 'dministration Module 3from the G#D&H T'B a-ailable for each G#rocessH class8export of the new process template, which includes"

▫ process name

▫

list of process attributes, that will be placed in the -arious user acti-ities▫ list of 9actors9 3users8 that interact with the process 3the 9$ystem9 role is automatically

created to position system acti-ities8

• desi!n of detail flow of the workflow usin! the TW( external editor, which will help thecompletion of the template exported by CMDBuild

• sa-e, usin! the special functions of TW( external editor of the M& file 3to be exact #D&


12/70

Workflow Manual

Initiation and progress of a process

+n the Mana!ement Module, CMDBuild can perform, throu!h the support of the TW$ To!etherWorkflow $er-er en!ine, the processes desi!ned with TW( To!ether Workflow (ditor and thenimported throu!h the 'dministration Module.

+n order to keep the !reatest coherence with the CMDBuild functionalities, dedicated to themana!ement of the items cards in the system, the user interface of the Mana!ement Module wasdesi!ned so that it is consistent with the mana!ement of the normal data 9classes9"

• there is a special menu item 9#rocesses9 consistent with the 9data sheets9 3otherwise9process9 elements can be inserted in the Na-i!ation menu with 9data sheets9 elements orreports and dashboards8

• the process mana!ement draws on the standard mana!ements which already exist for thenormal cards" G&istH, GCardH, 9Details9 GNotesH, G*elationsH, GKistoryH, 9'ttachments9

• in the G&istH T'B of a specific process, the user can see the acti-ities instances, in whichhe4she is in-ol-ed 3since he4she attends that acti-ity or pre-ious acti-ities of that process8with"

▫ filters by status 3started, completed, suspended8

▫ data area with tabular display of the information 3process name, acti-ity name, reIuestdescription, process status and further attributes defined as 9display base9 in the 'dministration Module8, which you can click on in order to access to the mana!ementcard of that acti-ity

▫ possible e-idences of parallel acti-ities for that process instance



13/70

Workflow Manual

▫ buttons to create a new acti-ity or to make that choice

• in the GCardH T'B you can -isuali/e or fill in the attributes pro-ided for that process acti-ityinstance 3write or read5only access can be set up throu!h the TW( editor8 otherwise you

can carry out further operations throu!h the proper wid!ets 3-isual controls8 confi!ured withthe TW( editor

• in the GNotesH T'B you can -isuali/e or insert notes about the acti-ity instance

• in the G*elationsH T'B you can -isuali/e or insert relations between the acti-ity instanceand the instances of other classes 3GcardsH8

• in the GKistoryH T'B you can -isuali/e the pre-ious -ersions of that acti-ity instance3instances already carried out8

The list of acti-ities is displayed hi!h up in the followin! exemplifyin! form, while you can carry outan acti-ity fillin! in the card at the bottom.

$ince workflows are peculiar classes, you can find the control buttons also in the upper ri!ht of theworkflow mana!ement form to display full screen the upper or lower side of the form.

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e 6


14/70

Workflow Manual

Interaction of the worflow with e)ternal tools

"eneral Information+n some cases it may be reIuired that a process 3like a new reIuest of KelpDesk8 is started by auser who is not expert enou!h at usin! CMDBuild 3such as the user of the item or of the +Tser-ice8.

This can be sol-ed usin! the CMDBuild 2+ ramework, described as follows.

*tart of a process from an intranet portal via CMDBuild "$I +ramewor

The 2+ ramework is a 0a-ascript 4 )Iuery de-elopment en-ironment, used to implement asimplified user interface. Thanks to it, non5expert users can interact with the CMDBuild application.

The 2+ ramework includes the followin! main features"

• it can be acti-ated in portals based on different technolo!ies

• it allows an 3almost8 unlimited freedom when pro0ectin! the !raphic layout, defined throu!han M& descriptor and with the possibility of inter-enin! on the C$$

• it !rants a Iuick confi!uration thanks to predefined functions 3communication,authentication lo!ics, etc.8 and to nati-e !raphic solutions 3forms, !rids, upload buttons andother wid!ets8

• it adapts to workflow ad-ancement forms desi!ned throu!h the -isual editor TW(

• it interacts with CMDBuild throu!h the *($T webser-ice

• it is able to !ather data from the database of other applications, allowin! the mana!ementof mix solutions

' sample of implementation based on the CMDBuild 2+ ramework is the $elf5$er-ice portal,which is part of the preconfi!ured -ersion CMDBuild *('DF


15/70

Workflow Manual

• reIuest for technical information

• openin! of a dama!e notice

• reIuest for an +T ser-ice, selected from the ser-ices catalo!ue

• consultation of the ad-ancement of your own reIuests

• appro-al of authori/ation reIuests

• summary of recei-ed notification emails

• '%

• connected user profile

• list of assets and ser-ices assi!ned to the connected user

• useful links

The CMDBuild 2+ ramework is not the only one possible option.

Fou can e-en implement external web interfaces from the be!innin!, usin! your fa-ouritede-elopment lan!ua!e and interactin! with CMDBuild throu!h its *($T and $'# webser-ices.

But this solution is less efficient if compared to the re5use of the a-ailable 2+ ramework.

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e >


16/70

Workflow Manual

,)ample of configuration of a new process

"eneral Information

The chosen process that describes the -arious passa!es necessary for its confi!uration is asimplified *eIuest for Chan!e 3or *fC8 process.

+t is an extremely simplified process, modelled only for educational purposes: it was su!!ested forconfi!uration modalities, not for a real use in the production.

The sample process, complete with the definition in CMDBuild and the #D& flow desi!ned withTW(, is a-ailable on the demo database supplied with CMDBuild.

Description of the %fC process used as e)ample

The actors of the process are the users1 !roups"

• Kelpdesk, which carries out the initial re!istration of the reIuest recei-ed by a user

• Chan!e Mana!er, responsible for the chan!es to the +T assets of the company

• +T expert, in-ol-ed for the production of analysis documents and for the chan!e execution

Kere1s a lo!ic schema of the process"

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e ?


17/70

Workflow Manual

The process includes the followin! operations"

• *fC recordin!

• e-aluation of the reIuest1s formal aspects"

• direct closin! if the *fC is not acceptable

• shift to the decisional step, if analysis acti-ities are not reIuested

• execution reIuest of one or more analysis typolo!ies, amon! impact, cost, riskanalysis

• execution of the reIuested analysis typolo!ies 3impact, cost, risk analysis8

• decision by the Chan!e Mana!er, which mi!ht be closed if the *fC is not appro-ed

• *fC execution by an +T expert, if the *fC is appro-ed

• final closin!

#hase - Items creation in CMDBuild

Throu!h the 'dministration Module, under the headin! Menu #rocesses, the process*eIuestorChan!e is created in order to mana!e the workflow"

$ome attributes pro-ided in the process are &ookup, so they reIuire the pre-enti-e definition of therelated lists, as you can see in the followin! screenshots.

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e @


18/70

Workflow Manual

&ookup *C cate!ory 3linked to the GCate!oryH attribute of the process8

&ookup *C decision 3linked to the GDecisionH attribute of the process8

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e A


19/70

Workflow Manual

&ookup *C final result 3linked to the Ginal*esultH attribute of the process8

&ookup *C formal e-aluation 3linked to the Gormal(-aluationH attribute of the process8

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e J


20/70

Workflow Manual

&ookup *C priority 3linked to the G*C#riorityH attribute of the process8

&ookup *C status 3linked to the G*C$tatusH attribute of the process8



21/70

Workflow Manual

The followin! 9domains9 are created in order to define in the process the G*eIuestorH attributes asforei!n keys on the class G(mployeeH and the relations with the Chan!e Mana!er and +T experts,who respecti-ely assesses and execute the *fC"

't this point the attributes of the process can be created"



22/70

Workflow Manual

&ast thin! you can create the users1 !roups in-ol-ed in the workflow"

't this point you can export the #D& schema produced by CMDBuild, used with the -isual editorTW( to desi!n the detail flow of the process itself"



23/70

Workflow Manual

The #D& file will include only the !eneral data a-ailable at the moment"

• process name

• list of unreser-ed process attributes present in the process mana!ement class

• list of the roles defined in the system

Those data will be the startin! point of the acti-ities carried out throu!h the TW( editor, in which allaspects related to the specific process flow will be enriched.

#hase & Configuration of the flow with T(,

Throu!h the TW( editor it1s possible to perform the followin! operations"

• flow desi!n by placin! the acti-ities of the -arious pro-ided typolo!ies 3process startin! andendin!, user acti-ities, automatic acti-ities, routin! acti-ities for the parallelism

mana!ement8 and their connection accordin! to the pro-ided transition typolo!ies• completion of user acti-ities, specifyin! what process attributes will be shown in the form

related to that acti-ity 3by indicatin! if read5only or read4write8 and what wid!ets will bemade a-ailable in the same form 3by indicatin! the parameters pro-ided for each one8

• completion of automatic acti-ities, writin! the script which implements the automatismsreIuired in that acti-ity 3usin! the '#+ a-ailable for that aim8

• completion of transitions amon! acti-ities, specifyin! the criteria for the flow to co-er atransition or another, when the choice is bindin!

Kere are some descripti-e screenshots of the abo-e mentioned acti-ities.

eneral flow desi!n"

2ser acti-ities 5 GLariablesH T'B, used to choose the attributes which must appear in the form 3withpossible indication of read5only modality8"



24/70

Workflow Manual

2ser acti-ities 5 G(xtended 'ttributesH T'B, used to indicate the compulsory attributes3G2#D'T(*(%2+*(DH8 and to reIuest the input in the form of one or more wid!ets 3in the sampleopen'ttachments for the attachments and createModifyCard to consult the reIuester card8

'utomatic acti-ity 5 GTypeH T'B, used to write the script that implements the pro-ided automatisms



25/70

Workflow Manual

3in the sample, the acti-ity $F$77 carries out the automatic structurin! of the system date, theautomatic attribution of a uni-ocal pro!ressi-e number, the buildin! of a si!nificant description, thestructurin! of a new state reached by the process8.

Transition, used to link two acti-ities, conditionally or not 3in the example it is pro-ided a condition

related to the formal acceptance of the *fC8



26/70

Workflow Manual

#hase Importation of the 0#D1 file in CMDBuild

When the confi!uration of the process in TW( is complete, you will load in CMDBuild the related#D& file.

The process flow can be then modified se-eral times, only exportin! the last -ersion fromCMDBuild, editin! it with TW( and importin! it a!ain in CMDBuild. Fou ha-e to consider that thenew -ersion will be used when new processes are started, while each current process will !o onwith the #D& -ersion -alid when they first started.

#hase 2 Implementation of the process from CMDBuild

The workflow imported in CMDBuid is a-ailable to be used by the pro-ided operators !roups.

+n the example, the mana!ement workflow of the *fC will be started by an operator of theKelpdesk !roup, -alued by an operator of the Chan!e Mana!er !roup, analysed and carried out by

an operator of the +T expert !roup. Fou ha-e to consider that the operators of the $uper2ser !roupcan 9personify9 any other !roup defined in CMDBuild.

rom the *fC process mana!ement, the *fC are presented as open 3or in the state selected onthe upper list" open, suspended, complete, aborted, all8.

Throu!h the button G$tart *eIuest for Chan!eH the Kelpdesk can re!ister a new reIuest.



27/70

Workflow Manual

#re-ious to fillin! in the form, the operator can refer to the operati-e instructions associable withe-ery user acti-ity 3which can be formulated with TW(, fillin! in the field GDescriptionH in theGeneralH T'B of the acti-ity8.



28/70

Workflow Manual

By -alidatin! the pro!ress at the followin! step, the acti-ity is taken by the Chan!e Mana!er, that 5in our simplified example 5 will fill in the followin! information"

+n the example we pro-ide at this step the possible use of the enclosed loadin! wid!ets and those

for the reference of the complete reIuester card"



29/70

Workflow Manual

The Chan!e Mana!er demanded in our example two typolo!ies of analysis, so the workflowmo-es to +T experts, that, in parallel 3usin! one of the new functionalities implemented inCMDBuild


30/70

Workflow Manual

The Chan!e Mana!er currently pro-ides the results of the reIuested discussions and can takehis4her decision.

+f the decision is positi-e, accordin! to the flow desi!ned with TW(, the +T experts are asked tocarry out the *fC acti-ity. 't the be!innin! the operation makes the reIuest with indication of theacti-ities which must be carried out: at the end it re!isters the acti-ities already carried out.



31/70

Workflow Manual

's last operation, the Chan!e Mana!er closes the *fC statin! a positi-e result.



32/70

Workflow Manual

't this sta!e, the *fC we worked on 3number @8 will not appear in the list of the open *fC.

But it can be refered with all its information in the list of the completed *fC 3the list can be selectedin the upper part of the form8



33/70

Workflow Manual

+n addition to the basic information, you can refer to the relations confi!ured with that *fC processinstance 3*elations T'B8.



34/70

Workflow Manual

Fou can also refer to the seIuence complete with pro!ress acti-ities of the process 3Kistory T'B8.

2ploadin! the attachments durin! the process 3usin! the proper wid!et8, you can refer to thepossible a-ailable documents 3'ttachments T'B8.

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e 6=


35/70

Workflow Manual

(idgets prompted to use in the user activities of

the worflow(idget list

CMDBuild makes some wid!ets a-ailable 3-isual controls8, placed in the ri!ht part of the form,which mana!e the pro!ress of the process throu!h the pro-ided acti-ity.

raphically, such controls are desi!ned with buttons with the specified label durin! the definitionstep.

'bout the confi!uration, they are defined as G(xtended attributesH 3pro-ided in the #D& standard8usin! the TW( editor.

+n this document, the data types are both ori!inal 3inte!er, strin!, date, float, boolean8 and complex

types added in the workflows of CMDBuild 3lookup id type description, lookups lookuparray, reference id idclass description, references reference array8.

3isual control Description #arameters 4otes

mana!e*elation +t shows the cardlist 3which can beselected8 in relationto the specifiedcard accordin! tothe specifieddomain

+nput"

DomainName string ClassName string b0+d integer Button&abel string (nabledunctions

character array*eIuired integer +sDirect string

or

+nput"DomainName string b0*ef referenceButton&abel string (nabledunctionscharacter array *eIuired integer

utput"Check'rrayreferences

(nabledunctions is an array of boolean-alues which enables differentfunctionalities accordin! to the followin!positional method"5 link element5 add and link element5 acti-ate selection check

5 acti-ate selection radio button5 modify relation5 disconnect element5 modify element5 delete element

The parameter *eIuired must beindicated only if the selection of at leastone element is compulsory+sDirect can take the -alues GtrueH or GfalseH

linkCards +t shows thepa!inated list 5which can beselected 5 of allcards belon!in! toa class, withpossible display ona !eo!raphicalmap

+nput"ClassName string Button&abel string $in!le$elect integer No$elect integer *eIuired integer ilter string Default$election string

The parameter $in!le$elect must beindicated only if the selection of one sin!lerow is allowed 3radio button rather thancheck8

+f you indicate the parameter No$elect ,the selection of the rows will be disabled3neither radio button nor check8

The parameter *eIuired forces the

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e 6>


36/70

Workflow Manual

'llowCard(ditin! integer Map string $tartMapWith&atitude

integer $tartMapWith&on!itude integer $tartMapWithOoominteger Metadata string Metadatautputstring

utput"Check'rray references[metadataOutput]

text

selection of one row at least

The ilter parameter is a C%& expression3CMDBuild Iuery lan!ua!e8(xample" ilter from #erson where +d

PclientQCustomerR

The Default$election parameter specifiesthe default C%& Iuery

The optional 'llowCard(ditin! parameteradds an icon to edit the card

The optional Map parameter enables themap -isuali/ation 3if it is set 1enabled18

The parameters related to the initialpresentation of the map are optional

The Metadata -ariable accepts as uniIue

-alue 3waitin! for future extensions8 the1point"#+NT1 strin!.

The Metadatautput -ariable accepts asuniIue -alue the 1Smetadatautput1 strin!that represents the name of the output-ariable.

They both are necessary to mana!e theselection of a sin!le point on an alreadyexistin! poly!onal.The point coordinates will be !i-en back inthe metadatautput -ariable in the W$A=format.

' possible example"point"#+NT3>A=@77.??A=7@=6A6J6.>A8

createModifyCard +t shows thespecified card inthe chan!e 3if b0+dis specified8,otherwise it allowsthe creation of anew card in thespecified class

+nput"ClassName string Button&abel string *eadnly inte!er

or

+nput"*eference referenceButton&abel string ReadOnly integer

or

+nput"ClassName string b0+d integer Button&abel string ReadOnly integer

utput"*eference reference

(xample"ClassName12ser1b0+dclient"*eIuester Button&abel 1Create or modify 2ser1*eIuester

#.$.the prefix Gclient"H is reIuired to access to a-ariable before the workflow is proceededto the followin! step

*eadnly shows the card read5only

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e 6?


37/70

Workflow Manual

create*eport +nput"*eportType string *eportCode string Button&abel string

orce#D integer orceC$L integer #arameter5#arameter5<...#arameter5n

utput"*eport2*& string

*eportType can currently only take the1custom1 -alue*eportCode coincides with the reportGCodeH attribute in the schedule G*eportH

orce#D forces the output in #D formatorceC$L forces the output in C$L format#arameter5 ... #arameter5nthey represent launch parameters pro-idedby the report

mana!e(mail +t allows to productthrou!h template orwrite free e5mails

which will be sentdurin! thede-elopment of theprocess.

+nput"Button&abel string To'ddresses string

CC'ddresses string $ub0ect string Content string Assignments string *eadnly boolean

Lisuali/in! e5mails, the electronic mailboxwill be checked for possible new e5mails

The parameters To'ddresses,

Cc'ddresses, $ub0ect and Content are9strin! template9 which can include 9ta!s9for the 9substitution9 of -ariables 3for furtherinformation see the next para!raph8+t is reIuired the confi!uration ofparameters for the e5mail sendin! in the fileworkflow.conf .

openNote +t -isuali/es thepa!e whichincludes the KTM&editor to insertnotes

+nput"Button&abel string

+t can1t be used in the first process acti-ity

open'ttachment +t -isuali/es thepa!e pro-ided forthe uploadin! ofthe file which hasto be enclosed tothe current process

+nput"Button&abel string

+t can1t be used in the first process acti-ity

calendar +t displays thecalendar with theselected dates

+nput"Button&abel string ClassName string ilter string (-ent$tartDate date(-ent(ndDate date(-entTitle string

rom the class ClassName you can collectthe dates you want to display in thecalendar, with possible filter 3it is optionalbut it takes the precedence on theClassName8.The parameter (-ent(ndDate is optional.(-entTitle indicates the attribute that drawsthe text and writes it on the calendar fore-ery date

presetromCard +t populates thecurrent acti-ity withthose datareco-ered by aselected card.

+nput"Button&abel string ClassName string ilter string 'ttributeMappin!string

ClassName, the name of the class, as analternati-e to ilter, which is on the contrarya C%& expression. 'ttributeMappin! is a strin! in the form of1ac,a


38/70

Workflow Manual

the moment $'#only8 as a !rid. Foucan select somerows of this !rid to

obtain their M&seriali/ation aswid!et output.

Method string Name$pace#refixstring Name$pace2*+

string NodesTo2se's*owsstring NodesTo2se'sColumns string $in!le$elect1true1Mandatory1true1*eadnly1true1String parametersutput$eparatorstring

utput"

utput string -ariable

Name$pace#refixnamespace prefix1

3optional8

Name$pace2*+1namespace 2*+1

3optional8NodesTo2se's*ows

Names of elements 3separated by commas

without spaces8 of the answer to display in

the !rid

NodesTo2se'sColumnsNames of the

elements 3separated by commas without

spaces8 of the answer to use as !rid

columns.

Call parameters 3optional8 possible

parameters pro-ided for in the Web

$er-ice.utput -ariable3optional8

that will be optimi/ed throu!h the M&

seriali/ation related to the selected nodes +f

it is strin! type, then the separator has also

to be specified.

utput$eparator 3optional8 character to

separate the results. +f it is missin!, they

will be !i-en back as strin! array.

startWorkflow +t allows to start a

workflow accordin!two modalities"8 confi!urationread by wid!ets


39/70

Workflow Manual

n9#resets string

utput"

utput string variable

The output -ariable will be a sin!le strin!containin! the seriali/ation of the inserteddata, separated by the abo-e5mentionedcharacters

#resetType and #reset are necessary toupload in ad-ance some -alues into the!rid: these -alues will be then editeddirectly by the user. +f you want to use a-ariable as input or the output of another!rid, you simply ha-e to specify the key#reset+nput$trin! where +nput$trin! is aformatted strin! like the !rid output.+f you want to upload in ad-ance the !ridstartin! from a function 3ha-in! as columnnames the same reference class fields8 youha-e specify #resetsType9function9 and

#resetsHwfSfunctionSnameH whereHwfSfunctionSnameH is the name of a storedprocedure in the database definedaccordin! to criteria used to createdashboards.

'ny parameter has to be specified insuccession in the form of"#aram9-alue9 3function inputparameter8#aram


40/70

Workflow Manual

$eriali/ationType[#son!text] EeyLalue$eparatorstring

'ttributes$eparatorstring *ows$eparator string

utput"utput string -ariable

na-i!ationTree +t allows to selectone or more datacards throu!h aninterfacethat is based on apreconfi!uredna-i!ation tree3subset of domain!raph8

+nput"Na-i!ationTreeNamestrin!Button&abel strin!

utput"Check'rray

references

Na-i!ationTreeName represents the nameof that tree you want to display

admin$tart By a process withmore start acti-itiesdistinct for each!roup, it sin!les outthe acti-ity for theadminister user

No input nor output parameters

+t is an Gextended attributeH, not a wid!et 3itdoesn1t ha-e a user interface8, but it isdescribed in this section, since it isconfi!ured like wid!ets.

+urther information for the use of 5string template6 in the tool manage,mail

The tool manage$mail allows to write e5mails which will be sent durin! the de-elopment of theprocess. Lisuali/in! e5mails, the electronic mailbox will be checked for possible new e5mails to-isuali/e the !rid.

Input parameters • string Button&abel• one or more blocks for the e5mails definition

◦ string template To'ddresses" recipientUs addresses◦ string template Cc'ddresses" carbon copy addresses◦ string template $ub0ect" e5mail sub0ect◦ string template Content" e5mail body 3KTM&8◦ string template Condition" 0a-ascript expression whose

e-aluation defines if the e5mail is !enerated or not

• other optional parameters which include Iueries or 0a-ascriptexpressions

• flag *eadnly" read5only email

output parameters none

The only5read flag is seen as a boolean -alue: a boolean -alue 3of the process8, a positi-e inte!er-alue or a non empty strin! are considered true

+n the template strings the -ariables, written in the form Pnamespace"localnameR, are interpreted ina different way dependin! on the namespace 3if omitted, it defaults to 9ser-er98.

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e =7


41/70

Workflow Manual

client"nameclient"name.+dclient"name.Description

orm1s name -ariable: for attributes such as &ook2p or *eference you ha-e tospecify, with the bullet list, whether you want the %d or the &escription

server "name #rocess name -ariable in the pre-ious step

)a"name Lariable name of the extended attribute definition, extended as templateexcludin! the -ariables with namespace #s and c'l

user "iduser "name

+D and name of the connected user

group"idgroup"name

+D and name of the connected !roup

7s"name Lariable name of the extended attribute definition interpreted as a template ande-aluated as a 0a-ascript code

c8l"name.field Lariable name of the extended attribute definition interpreted as a template ande-aluated carryin! out a C%& Iuery, whose field is identified by field

The definition blocks of the e5mails can be written in two ways"

ToAddresses9...9CcAddresses9...9*ub7ect9...9Content9...9

or 3if you want to specify more than one e5mail8"

ToAddresses-9...9CcAddresses-9...9*ub7ect-9...9Content-9...9

ToAddresses&9...9CcAddresses&9...9*ub7ect&9...9Content&9...9...

,)ample -

ToAddresses9fooVexample.com9*ub7ect99c8l:uer!%e8uester.Description; 5 9client:%e8uest;9uer!%e8uester 9select Description,(mail,ffice from (mployee where +d 9c8l:*ill!uer!.Id;9*ill!uer!9select +d from (mployee where +d9client:%e8uester;9

'ddress" The recipient1s address is statically completed with the strin! fooVexample.com

Body" Messa!e Body (mpty$ub0ect"

• The -ariable %uery*eIuester selects an (mployee card which includes the fieldsDescription, (mail and ffice: the extracted -alues are a-ailable usin! for example thesyntax PcIl"%uery*eIuester.DescriptionR, which will be replaced with the field Descriptionextracted from the -ariable %uery*eIuester

• +nside %uery*eIuester, PcIl"$illy%uery.+dR will be replaced with the +d field of the cardreturned from the $illy%uery 3indeed nested Iueries are supported8, replaced before withPclient"*eIuesterR with the -alue taken in the form

• Pclient"*eIuestR of will be completed with the form -alue

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e =


42/70

Workflow Manual

,)ample &

...Content9The reIuester, 97s:


43/70

Workflow Manual

A#I prompted to use in the automatic activities of

the worflow"eneral Information

+n CMDBuild there are some '#+s 3'pplication #ro!rammin! +nterface8 which can be used in theautomatic acti-ities of the workflow for the script writin!: so it is possible to implement custombeha-iors 3manipulation of process -ariables, card creation and relations in CMDB, e5mail sendin!,report creation, etc.8.

?e! words

Process

#rocess+d" int

+d of the current process

#rocessClass" $trin!

Class name of the current process

#rocessCode" $trin!

uni-ocal #rocess+nstance+d of the current process

#erformer

SCurrent2ser" *eferenceType

reference to the 2ser that performed the last acti-ity of the current process

SCurrentroup" *eferenceType

reference to the *ole that performed the last acti-ity of the current process

A#I

cmdb

it identifies the nati-e functions in CMDBuild

Management of CMDBuild items

They concern the CMDBuild specific data: for other data 3inte!er, strin!, date, float8 you can use allmanipulation methods offered by the )a-a lan!ua!e.

%eferenceT!pe

Methods

!et+d 38" int

it returns the *eference id

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e =6


44/70

Workflow Manual

!etDescription38" $trin!

it returns the *eference description

1ooupT!pe

Methods

!et+d 38" int

it returns the &ookup id

!etType 38" $trin!

it returns the &ookup type

!etDescription 38" $trin!

it returns the &ookup description

!etCode 38" $trin!

it returns the &ookup code

CardDescriptor

Methods

!etClassName 38" $trin!

it returns the Class name for a CardDescriptor -ariable

!et+d 38" int

it returns the +d name for a CardDescriptor -ariable

eIuals 3CardDescriptor cardDescriptor8" boolean

it compares the CardDescriptor -ariable with the specified one

Card

Methods

!etCode 38" $trin!

it returns the Code for a Card -ariable

!etDescription 38" $trin!

it returns the Description for a Card -ariable

has3$trin! name8" boolean

it controls the presence of the specified attribute in the Card -ariablehas'ttribute3$trin! name8" boolean

it controls the presence of the specified attribute in the Card -ariable

!et3$trin! name8" b0ect

it returns the specified attribute -alue of the Card -ariable

!et'ttributeNames38" $et$trin!X

it returns the attributes list of the Card -ariable

!et'ttributes38" Map$trin!, b0ectX

it returns the attributes list and their -alues of the Card -ariable. The returned -alues

respect the CMDBuild types 3*eferenceType, &ookupType, Date, +nte!er, ...8

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e ==


45/70

Workflow Manual

Downloaded%eport

Methods

!et2rl 38" $trin!

it returns the local 2*& for the report sa-e

eIuals 3Downloaded*eport downloaded*eport8" boolean

it compares the Downloaded*eport -ariable with the specified one

Access methods to CMDBuild

4ewCard

Builders

newCard 3$trin! className8" NewCardit creates a new Card created in the specified Class of CMDBuild

Modifiers

withCode 3$trin! -alue8" NewCard

it adds the Code to the new card created in CMDBuild

withDescription 3$trin! -alue8" NewCard

it adds the Description to the new card created in CMDBuild

with 3$trin! name, b0ect -alue8" NewCard

it adds the -alue specified for the specified attribute to the new card created in CMDBuildwith'ttribute 3$trin! name, b0ect -alue8" NewCard

it adds the -alue specified for the specified attribute to the new card created in CMDBuild

Actions

create 38" CardDescriptor

it creates the new card in CMDBuild settin! the attributes pre-iously defined

(xample"

/*

* Creation of a new card in the “Employee” class having

* the following attributes:

* “Code” = “T!!!”

* “"ame” = “#ames”

* “$urname” = “%etfield”

*/

cd"ewEmployee = cmdb&newCard'“Employee”(

&withCode'“T!!!”(

&with'“"ame”) “#ames”(

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e =>


46/70

Workflow Manual

&withttribute'“$urname”) “%etfield”(

&create'(+

4ew#rocessInstance

Builders

new#rocess+nstance 3$trin! className8" New#rocess+nstance

it creates a new process instance created in CMDBuild for the specified process

Modifiers

withDescription 3$trin! -alue8" New#rocess+nstance

it adds the Description to the new card created in CMDBuild

with 3$trin! name, b0ect -alue8" New#rocess+nstanceit adds the -alue specified for the specified attribute to the new process created in

CMDBuild

with'ttribute 3$trin! name, b0ect -alue8" New#rocess+nstance

it adds the -alue specified for the specified attribute to the new process created in

CMDBuild

Actions

start 38" #rocess+nstanceDescriptor

it creates the new process in CMDBuild settin! the attributes pre-iously defined, and doesnot ad-ance

start'nd'd-ance 38" #rocess+nstanceDescriptor

it creates the new process in CMDBuid settin! the attributes pre-iously defined, and

ad-ances at the followin! step

(xample"

/*

* Creation of a new card in the “,e-uest.orChange” class

* having the following attributes

* “,e-uester” = “#ames %etfield”

* “,.CEtended0escription” = “1y printer is bro2en”

*/

pid"ew,e-uest.orChange =cmdb&new3rocess4nstance'“,e-uest.orChange”(

&with'“,e-uester”) “#ames %etfield”(

&withttribute'“,.CEtended0escription”) “1y printer isbro2en”(

&startnddvance'(+

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e =?


47/70

Workflow Manual

,)istingCard

Builders

existin!Card 3$trin! className, int id8" (xistin!Card

it creates a Card existin! in the specified Class ha-in! the specified +d to Iuery CMDBuild

existin!Card 3CardDescriptor cardDescriptor8" (xistin!Card

it creates an existin! Card indicated by the specified CardDescriptor to Iuery CMDBuild

Modifiers

withCode 3$trin! -alue8" (xistin!Card

it sets the Code for the Card reIuested to CMDBuild

withDescription3$trin! -alue8" (xistin!Card

it sets the Description for the Card reIuested to CMDBuild

with 3$trin! name, b0ect -alue8" (xistin!Card

it sets the specified attribute with the specified -alue for the Card reIuested to CMDBuild

with'ttribute 3$trin! name, b0ect -alue8" (xistin!Card

it sets the specified attribute with the specified -alue for the Card reIuested to CMDBuild

with'ttachment3$trin! url, $trin! name, $trin! cate!ory, $trin! description8" (xistin!Card

it attaches a file 3pointed out throu!h a ser-er local url8 to the selected card

by settin! the file name, its cate!ory and its description

attachments38" (xistin!Card

it allows you to access the attachments of the selected card

select'll38" (xistin!Card

it allows you to select all documents of the selected card

selectByName3 $trin! name, $trin! name


48/70

Workflow Manual

upload3'ttachment attachment, 'ttachment attachment


49/70

Workflow Manual

4terable ttachment0escriptor> attachments

cmdb&eistingCard'cd"ewEmployee(

&attachments'(

&fetch'(+

/*

* 0elete of the card attachment that was previously

* created in the “Employee” class

*/

cmdb&eistingCard'cd"ewEmployee(

&attachments'(

&select?y"ame'$tring@ABattachment8nameD(

&delete'(+

4ew%elation

Builders

new*elation 3$trin! domainName8" New*elation

it creates a new relation added in the specified Domain of CMDBuild

Modifiers

withCard 3$trin! className, int card+d8" New*elation

it sets the card in the source side of the relation

withCard< 3$trin! className, int card+d8" New*elation

it sets the card in the tar!et side of the relation

Actions

create 38

it creates the new relation in CMDBuild amon! the Cards indicated in the specified

Domain

(xample"

/*

* Creation of a new relation in the “ssetssignee” domain

* between a card of the selected “sset” class)

* through the 4tem ,eference attribute) and

* the card previously created in the “Employee” class

*/

cmdb&new,elation'“ssetssignee”(

&withCard'“Employee”) cd"ewEmployee&get4d'((

&withCard'“sset”) 4tem&get4d'((

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e =J


50/70

Workflow Manual

&create'(+

,)isting%elation

Buildersexistin!*elation 3$trin! domainName8" (xistin!*elation

it creates an existin! relation in the specified Domain of CMDBuild

Modifiers

withCard 3$trin! className, int card+d8" (xistin!*elation

it sets +dClass and l1b0+d of the Card from the source side of the relation

withCard< 3$trin! className, int card+d8" (xistin!*elation

it sets +dClass and l1b0+d of the Card from the tar!et side of the relation

Actions

delete 38

it deletes 3lo!ic delete8 the relation existin! in CMDBuild amon! the Cards indicated in the

specified Domain

(xample"

/*

* 0elete the relation on the “ssetssignee” domain

* among the cards previously indicated */

cmdb&eisting,elation'“ssetssignee”(

&withCard'“Employee”) cd"ewEmployee&get4d'((

&withCard'“sset”) 4tem&get4d'((

&delete'(+

uer!Class

Builders

IueryClass 3$trin! className8" %ueryClass

it creates a Iuery that Iueries the class specified in CMDBuild

Modifiers

withCode 3$trin! -alue8" %ueryClass

it sets the Card Code for the filter used to Iuery CMDBuild

withDescription 3$trin! -alue8" %ueryClass

it sets the Card Description for the filter used to Iuery CMDBuild

with3$trin! name, b0ect -alue8" %ueryClass

it sets the -alue for the specified attribute of the Card for the filter used to Iuery

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e >7


51/70

Workflow Manual

CMDBuild

with'ttribute3$trin! name, b0ect -alue8" %ueryClass

it sets the -alue for the specified attribute of the Card for the filter used to Iuery

CMDBuild

Actions

fetch 38" &istCardX

it performs the search Iuery on the specified Class of CMDBuild and returns the list of

those Cards that respect the filter pre-iously set

(xample"

/*

*


52/70

Workflow Manual

* “1edium” and “


53/70

Workflow Manual

Create%eport

Builders

create*eport3$trin! title, $trin! format8" Create*eport

it creates the *eport in the specified format 3pdf, cs-8 with the specified Title

Modifiers

with3$trin! name, b0ect -alue8" Create*eport

it sets the input parameter -alue specified for the *eport

Actions

download38" Downloaded*eport

it !enerates the indicated *eport usin! the parameters pre-iously defined

(xample"

/*

* 4t generated the ,eport “0ismissedssets” which shows the list

* of the abandoned ssets

*/

new,eport = cmdb&create,eport'“ssigned assets to”(

&download'(+

4ewMail

Builders

newMail 38" NewMail

it creates a new e5mail to send

Modifiers

withrom 3$trin! from8" NewMail

it sets the sender of the e5mail to send

withTo 3$trin! to8" NewMail

it sets the recipients of the e5mail to send

withCc 3$trin! cc8" NewMail

it sets the carbon copy recipients of the e5mail to send

withBcc 3$trin! bcc8" NewMail

it sets the blind carbon copy recipients of the e5mail to send

with$ub0ect 3$trin! sub0ect8" NewMail

it sets the sub0ect of the e5mail to send

withContent 3$trin! content8" NewMail

it sets the text of the e5mail to send

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e >6


54/70

Workflow Manual

withContentType 3$trin! contentType8" NewMail

it sets the content MimeType of the e5mail to send, the allowed -alues are Gtext4htmlH or

Gtext4plainH. +f not otherwise specified, the default -alue is Gtext4plainH

with'ttachment 32*& url8" NewMail it sets the url of a document to enclose to the e5mail

with'synchronous$end 3bool boolean8" NewMail

it sends the e5mail asynchronously in spite of the script: in this way any timeout

problem will be a-oided, but you will not be able to inter-ene in case of error by sendin! the e5

mail

Actions

send 38

it performs the e5mail sendin! usin! the pre-iously defined statements

(xample"

/*

* $end an e8mail notification

*/

cmdb&new1ail'(

&with.rom'“fromaddress;somemail&com”(

&withTo'“toaddress;somemail&com”(

&withCc'“ccaddress;somemail&com”(&with$ubect'“1ail subect”(

&withContent'“1ail content”(

&send'(+

Methods for t!pes conversion

%eferenceT!pe

Methods

referenceTyperom3Card card8" *eferenceType

it returns the *eferenceType item related to the specified Card

referenceTyperom3CardDescriptor cardDescriptor8" *eferenceTypeit retuns the *eferenceType item related to the specified CardDescriptor

referenceTyperom3int id8" *eferenceTypeit returns the *eferenceType item related to the card with the specified +d

(xample"

/*

* $et the “,e-uester” process attribute ,eference

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e >=

mailto:[email protected]:[email protected]:[email protected]:[email protected]:[email protected]:[email protected]


55/70

Workflow Manual

* type) given the “cd"ewEmployee” Card0escriptor

* previously created

*/

,e-uester = cmdb&referenceType.rom'cd"ewEmployee(+

1ooupT!pe

Methods

select&ookupBy+d 3int id8" &ookupTypeit returns the &ookupType item with the specified +d

select&ookupByCode 3$trin! type, $trin! code 8" &ookupTypeit returns the &ookupType item with specified Type and Code

select&ookupByDescription 3$trin! type, $trin! description 8" &ookupTypeit returns the &ookupType item with specified Type and Description

(xample"

/* $et the $tate process attribute >


56/70

Workflow Manual

* process attribute ,eference type

*/

selectedEmployee = cmdb&card.rom',e-uester(+

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e >?


57/70

Workflow Manual

Appendi): Documentation to use T(* &.

+oreword

+n appendix you will find the specified technical documentation of the workflow system used untilCMDBuild .>, whose compatibility is maintained also in CMDBuild


58/70

Workflow Manual

clear&ookup +t resets the -alueof a &ookup-ariable

&ookup lookup The -alue of the 9+d9attribute is set to 5

clear*eference +t resets the -alueof a *eference-ariable

*ef reference The -alue of the 9+d9attribute is set to 5

concat

concat6 4 concat=4 ... 4 concatA

+t concatenates twoor more strin!s

+nput$trin! string +nput$trin!< string ...+nput$trin!n string

utput$trin!string

create*eferenceb0 +t creates areference -ariableand initiali/es it

ClassName string b0+d integer Description string

ut*efreference

The -ariable is initiali/edwith the -alues read by theattributes GClassNameH,Gb0+dH and GDescriptionH ofthe specified card

dateTo$trin! +t con-erts a date-ariable into astrin!

+nputDate date utput$trin!string

floatTo$trin! +t con-erts a float-ariable into astrin!

+nputloat float utput$trin!string

floatCopy +t copies the -alueof a float -ariableinto another float-ariable

rom float To float

!et*eference+d +t extracts the G+dHattribute from areference -ariable

*ef reference Card+d integer

!et*eferenceClass+d +t extracts theGClass+dH attributefrom a reference-ariable

*ef reference Class+d integer

!et&ookupDescription +t extracts theGDescriptionHattribute from alookup -ariable

&ookup lookup Descriptionstring

!et&ookup+d +t extracts the G+dH

attribute from alookup -ariable

&ookup lookup +d %nteger

!et&ookupCode +t extracts theGCodeH attributefrom a lookup-ariable

&ookup lookup Code String

!et*eferenceDescription

+t extracts theGDescriptionHattribute from areference -ariable

*ef reference Descriptionstring

!et*eferencerom +t extracts the *ef'rray ut*ef +f the array is null or the

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e >A


59/70

Workflow Manual

'rray specified*eference from thespecified array

references%ndex integer

reference index is hi!her than itsdimension, it is 9null9 a!ain

intTo$trin! +t con-erts aninte!er -ariable intoa strin!

+nput+nt integer utput$trin!string

intCopy +t copies the -alueof an inte!er-ariable intoanother inte!er-ariable

rom integer To integer

lookupTo$trin! +t con-erts the 9+d9field of the lookup-ariable into astrin!

+nput&ookuplookup

utput$trin!string

next+nt +t increases thespecified inte!er-ariable

+nput+nt integer +nput+nt integer

referenceTo$trin! +t con-erts the G+dHfield of thereference -ariableinto a strin!

+nput*eferencereference

utput$trin!string

strin!ToDate +t con-erts a strin!-ariable into a date

+nput$trin! string utputDatedate

+t accepts as input formatsFF4MM4dd or FF4mm4ddKK"mm"ss

strin!Copy +t copies the -alue

of a strin! -ariableinto another strin!-ariable

rom string To string

dateCopy +t copies the -alueof a date -ariableinto another date-ariable

rom date To date

strin!ToBool +t con-erts a strin!-ariable into aboolean -alue

rom string To boolean +t accepts as input the trueor false strin!s

strin!To+nt +t con-erts a strin!

-ariable into aninte!er

rom string To integer +n input it accepts the

representation of an inte!ernumber in the shape ofstrin!

strin!Toloat +t con-erts a strin!-ariable into a float

rom string To float +n input it accepts therepresentation of a float inthe shape of strin!

Methods for the flow control

Tool Description Input parameters =utputparameters

4otes

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e >J


60/70

Workflow Manual

next*ef +t increases theiterator on areference array

*ef'rrayreferencesCurrent+ndexinteger

KasNextbooleanCurrent+ndexinteger

CurrentLaluereference

*ef'rray is a referencearray, CurrentLalue is thereference correspondin! tothe current index

reset+terator +t resets theiterators

*ef'rrayreferences

KasNextbooleanCurrent+ndexinteger

Current+ndex is set to 7,KasNext is true if the arrayis not empty

resume#rocess +t reboots thespecified process

#rocess+nstance+dstring (omplete integer

The status of the specifiedprocess must beG$uspendedH

+f GCompleteH takes on the-alue , the process stepsforward

suspend#rocess +t suspends thespecified process

#rocess+nstance+dstring

The constant GC2**(NTHcan be used to indicate thecurrent process

The process is suspendedimmediately before thefollowin! manual acti-ity

-oid'pp Null tool

Access methods to CMDB


4otes

createCard +t creates a newcard and returnsthe H+dH

ClassName string CardCode string CardDescriptionstring

Card+d integer The method sets only thebasic attributes 9Code9 and9Description9

+n order to set the otherones, you ha-e to use theupdate'ttribute tool ordefine a createCardmetatool

createCard*ef +t creates a new

card and returnsthe reference

ClassName string

CardCode string CardDescriptionstring

Card*eference

reference

The method sets only the

basic attributes 9Code9 and9Description9

+n order to set the otherones, you ha-e to use theupdate'ttribute tool ordefine a createCardmetatool

create*elation +t creates a relationbetween two cards

DomainNamestring ClassName string ClassName< string b0+d integer

Done boolean

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e ?7


61/70

Workflow Manual

b0+d< integer

create*elation*ef +t creates a relationbetween two cards,

the first of them isspecified byreference

DomainNamestring b0*eferencereferenceClassName< string b0+d< integer

Done boolean

create*elation


62/70

Workflow Manual

select&ookupByTypeCode

+t returns a &ookupentry, specified bytype and code

Type string Code string

&ookup lookup

select*eferenceByCode +t returns areference itemcorrespondin! tothe card specifiedby code

ClassName string Code string ut*efreference

select*eferenceByCustom'ttribute

+t returns areference itemcorrespondin! tothe indicated cardthrou!h a !enericattribute

ClassName string 'ttributeNamestring 'ttributeLaluestring

ut*efreference

select*eferenceBy

*eference

+t returns a

reference itemcorrespondin! to areference attributeexistin! in the cardspecified byreference

b0*eference

reference Attribute)amestring

ut*ef

reference

select*elations +t returns on aspecific domain anarray of referencescorrespondin! tothe cards related tothe one !i-en by

the specified id andclass

ClassName string Card+d integer &omain)amestring

*ef'rrayrelations

select*elationsBy*eference

+t returns on aspecific domain anarray of referencescorrespondin! tothe cards related tothe one !i-en bythe specifiedreference

ClassName string Card+d integer &omain)amestring

*ef'rrayrelations

update'ttribute +t modifies a card ClassName string 'ttributeName

string b0+d integer 'ttributeLaluestring

Done boolean The method edits only thespecified attribute

+n order to edit moreattributes, you ha-e todefine an updateCardmetatool

update'ttribute*ef +t edits a cardspecified byreference

b0*ef reference 'ttributeNamestring 'ttributeLaluestring

Done boolean

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e ?


63/70

Workflow Manual

,)ternal methods


4otes

!etCurrentTimestamp +t returns thesystem date andtime

TheDate date

!etCurrentroup*eference

+t returns areference -ariablecorrespondin! tothe current user!roup

roup*efreference

The returned itemcorresponds to the current!roup card in the CMDB9*ole9 table

!etCurrent2ser*e

ference

+t returns a

reference -ariablecorrespondin! tothe current user

2ser*ef

reference

The returned item

corresponds to the currentuser card in the CMDB9*ole9 table

!et*eportull2rl +t returns the link tothe report createdwith the extendedattributecreate*eport

*eport2rl string *eport2rl string

sendMail +t sends an e5mail rom'ddressesstring To'ddressesstring

CC'ddressesstring BCC'ddressesstring $ub0ect string Content string 2rl'ttachmentsstring MimeType string

The tool pro-ides that $harkparameters related to the e5mail sendin! are correctlyconfi!ured

#arameters rom, To and 'ttach can include more-alues concatenated with G,H#arameters CC'ddresses,BCC'ddresses and2rl'ttachments can be setby an empty strin!MimeType can take the-alues Gtext4htmlH orGtext4plainH

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e ?6


64/70

Workflow Manual

Template automatic methods usable in the worflow

+n order to use To!ether Workflow $er-er


65/70

Workflow Manual

b0*ef reference

&ist of inputparameterspro-ided by the

function

update#rocess $a-e or pro!ress ofanother processinstance

#rocess+nstance+dstring 'ttributes list to set

Done boolean

or a better readability, the followin! table shows separately the Tool'!ent indication and otherpossible attributes that must be specified as TW( in the metatool definition.

'll -alues of the attributes are strin! type.

Template t!pe Metatool attribute Metatool value

createCard Tool'!entClass

ClassName

or!.cmdbuild.shark.toola!ent.CreateCardTool'!ent

YClass NameZ

create*eport Tool'!entClass

Type

Code

ormat

or!.cmdbuild.shark.toola!ent.Create*eportTool'!ent

custom

Y*eport codeZ

pdf or cs-

executeunction Tool'!entClass

#rocedure

or

Cursor#rocedure

or!.cmdbuild.shark.toola!ent.(xecute$tored#rocedureTool'!ent

Y#ost!re$%& function name with return sin!le -alueZ

Y#ost!re$%& function name with return multiple -alueZ

start#rocess Tool'!entClass

#rocessClass

Complete

or!.cmdbuild.shark.toola!ent.#rocess$tartTool'!ent

YClass NameZ

3to ad-ance the process to the followin! acti-ity8

or

7 3to stop the process on the first acti-ity8

updateCard Tool'!entClass or!.cmdbuild.shark.toola!ent.2pdate'ttributeTool'!ent

update#rocess Tool'!entClass

#rocessClass

Complete

or!.cmdbuild.shark.toola!ent.#rocess2pdateTool'!ent

YClass NameZ

3to ad-ance the process to the followin! acti-ity8

or

7 3to stop the process on the first acti-ity8+f the process is 9$uspended9, the resume#rocess method mustbe carried out in ad-ance.

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e ?>


66/70

Workflow Manual

A##,4DI0: "lossar!

ATTAC@M,4T

'n attachment is a file associated to a card.

'ttachments containin! text 3#D, pen ffice, Microsoft Word, etc.8 are indexed in full text modeso that they can appear in search results.

(=%?+1=( *T,#

9'cti-ity9 means one of the steps of which the process consists.

'n acti-ity has a name, an executor, a type, possible attributes and methods with statements3CMDBuild '#+8 to be executed.

' process instance is a sin!le process that has been acti-ated automatically by the application ormanually by an operator.

$ee also" #rocess

ATT%IB$T,

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 Mana!ement 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 Modelin!8 is supported by se-eral +T pro!rams that caninteract throu!h an open format for data exchan!e, called +C 3+ndustry oundation Classes8.

$ee also" +$

CI

We define C+ 3Confi!uration +tem8 each item that pro-ides +T ser-ice to the user and has asufficient detail le-el for its technical mana!ement.

C+ examples include" ser-er, workstation, software, operatin! system, printer, etc.

$ee also" Confi!uration

C1A**

' Class is a complex data type ha-in! a set of attributes that describe that kind of data.

' Class models an ob0ect that has to be mana!ed in the CMDB, such as a computer, a software, aser-ice pro-ider, etc.

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e ??


67/70

Workflow Manual

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

C=4+I"$%ATI=4

The confi!uration mana!ement process is desi!ned to keep updated and a-ailable to otherprocesses the items 3C+8 information, their relations and their history.

+t is one of the ma0or +T+& processes mana!ed by the application.

$ee also" C+, +T+&

DA*@B=A%D

+n CMDBuild, a dashboard corresponds to a collection of different charts, in this way you canimmediately hold in e-idence some key parameters 3E#+8 related to a particular mana!ementaspect of the +T ser-ice.

$ee also" *eport

DATABA*,

The term refers to a structured collection of information, hosted on a ser-er, as well as utilitysoftware that handle this information for tasks such as initiali/ation, allocation, optimi/ation,backup, etc..

CMDBuild relies on #ost!re$%&, the most powerful, reliable, professional and open source

database , and uses its ad-anced features and ob0ect5oriented structure.

D=MAI4

' domain is a relation between two classes.

' domain has a name, two descriptions 3direct and in-erse8, 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 +I1T,%

' data filter is a restriction of the list of those elements contained in a class, obtained by specifyin!boolean conditions 3eIual, not eIual, contains, be!ins with, etc.8 on those possible -alues that canbe accepted by e-ery 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, Liew

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e ?@


68/70

Workflow Manual

"I*

' +$ is a system able to produce, mana!e and analyse spatial data by associatin! !eo!raphicelements to one or more alphanumeric descriptions.

+$ functionalities in CMDBuild allow you to create !eometric attributes 3in addition to standardattributes8 that represent, on plans 4 maps, markers position 3assets8, polylines 3cable lines8 andpoly!ons 3floors, rooms, etc.8.

$ee also" B+M

"$I +%AM,(=%?

+t is a user interface you can completely customise. +t is ad-ised to supply a simplified access tothe application. +t can be issued onto any webportals and can be used with CMDBuild throu!h thestandard *($T webser-ice.

$ee also" Mobile, Webser-ice

ITI1

9Best practices9 system that established a 9standard de facto9: it is a non5proprietary system for themana!ement of +T ser-ices, followin! a process5oriented schema 3+nformation Technolo!y+nfrastructure &ibrary8.

+T+& processes include" $er-ice $upport, +ncident Mana!ement, #roblem Mana!ement, Chan!eMana!ement, Confi!uration Mana!ement and *elease Mana!ement.

or each process, +T+& handles description, basic components, criteria and tools for Iualitymana!ement, roles and responsibilities of the resources in-ol-ed, inte!ration points with otherprocesses 3to a-oid duplications and inefficiencies8.

$ee also" Confi!uration

1==?$#

The term 9&ookup9 refers to a pair of -alues 3Code, Description8 set by the administrator in the 'dministration Module.

These -alues are used to bind the user1s choice 3at the form fillin! time8 to one of the preset-alues.

With the 'dministration Module it is possible to define new 9&ook2p9 tables accordin! toor!ani/ation needs.

M=BI1,

+t is a user interface for mobile tools 3smartphones and tablets8. +t is implemented as multi5platformapp 3i$, 'ndroid8 and can be used with the CMDB throu!h the *($T webser-ice.

$ee also" 2+ ramework, Webser-ice

#%=C,**

The term 9process9 3or workflow8 refers to a seIuence of steps that reali/e an action.

(ach process will take place on specific assets and will be performed by specific users.

' process is acti-ated by startin! a new process 3fillin! related form8 and ends when the lastworkflow step is executed.

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e ?A


69/70

Workflow Manual

$ee also" Workflow step

%,1ATI=4

' relation is a link between two CMDBuild cards or, in other words, an instance of a !i-en domain. ' relation is defined by a pair of uniIue card identifiers, a domain and attributes 3if any8.

CMDBuild allows users, throu!h the Mana!ement Module, to define new relations amon! thecards stored in the database.

$ee also" Class, Domain

%,#=%T

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

CMDBuild users run reports by usin! the Mana!ement 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, throu!h the Mana!ement 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

*$#,%C1A**

' superclass is an abstract class used to define attributes shared between classes. rom theabstract class you can deri-e 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, KD,etc.8 and then define deri-ed subclasses 9Desktop9, 9Notebook9, 9$er-er9, each one with somespecific attributes.

$ee also" Class, 'ttribute

ATT%IB$T, T#,

(ach attribute has a data type that represents attribute information and mana!ement.

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 mana!es the followin! attribute types" 9Boolean9, 9Date9, 9Decimal9, 9Double9, 9+net9 3+#address8, 9+nte!er9, 9&ookup9 3lists set in 9$ettin!s9 4 9&ook2p98, 9*eference9 3forei!n key8, 9$trin!9,9Text9, 9Timestamp9.

$ee also" 'ttribute

CMDBuild ; pen $ource Confi!uration and Mana!ement Database #a!e ?J


70/70

Workflow Manual

3I,(

' -iew not only includes the whole content of a CMDB class, it is a !roup of cards defined in alo!ical 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 a-ailable for a class, the second one allows the soledisplay and search with fast filter.

$ee also" Class, ilter

(,B*,%3IC,

' webser-ice is an interface that describes a collection of methods, a-ailable o-er a network andworkin! usin! M& messa!es.

With webser-ices, an application allows other applications to interact with its methods.CMDBuild includes a $'# and a *($T webser-ice.

(ID",T

' wid!et is a component of a 2+ that impro-es user interaction with the application.

CMDBuild uses wid!ets 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 workflowmanual eng v240

Documents