Advanced Workflow Tips & Tricks: Step-by- Step Guide. Kristof Depypere - Mathisse De Strooper

Transcription

1 Advanced Wrkflw Tips & Tricks: Step-by- Step Guide Kristf Depypere - Mathisse De Strper

2 Table f Cntents 1. Ask The Expert Basic Descriptin Develpment BPMN image 6 2. Ask The Expert Advanced Step Descriptin Develpment BPMN image 7 3. Ask The Expert Advanced step Descriptin Develpment BPMN image 9 4. Ask The Expert Advanced step Descriptin Develpment BPMN image Ask The Expert Advanced step Descriptin Develpment BPMN image Ask The Expert Advanced step Descriptin Develpment BPMN image Ask The Expert Advanced step 6 15 Advanced Wrkflw Tips & Tricks: Step-by-Step Guide 2

3 7.1 Descriptin Develpment BPMN image 15 Advanced Wrkflw Tips & Tricks: Step-by-Step Guide 3

4 1. Ask the Expert Basic 1.1 Descriptin The Ask the Expert wrkflws bring users in direct cntact with the subject matter expert f a certain asset. The user will be able t ask a questin directly t the expert. The expert will be ntified and will be able t answer the questin in a user-friendly way. 1.2 Develpment The basics f wrkflws and the instructins n hw t install Eclipse + Activity Plugin can be fund in ur User Guide: API dcumentatin can be fund underneath (instanceurl)/dcs/index.html r Step by Step guide: Create a new Activity diagram Right click n yur flder New è Other Activity Diagram Add a Pl t yur activity diagram (if yu dn t see this panel: Windw è Shw View è Palette) Cntainer Drag and drp a pl n t yur activity diagram Click n the title f the pl and give it a unique id G t the prcess tab and prvide a unique prcess id and name Add a Start Event t yur pl Start event Drag and drp a start event t yur pl G t the Main "cnfig" tab Give the initiatr a name: startuser Cnfigure the start frm Click n yur start event G t the Frm tab Create new Questin field Id = questin Name = Questin Type = String Required = true Readable = true Writeable = true Create a new buttn Id = buttn Name = Ask Questin Type = buttn Required = false Readable = true Writeable = true Create new wrkflw variable (which can be changed frm within the Data Gvernance Center) Id = rle Name = Expert Rle User Expressin Advanced Wrkflw Tips & Tricks: Step-by-Step Guide 4

5 Type = string Default = rle (Subject Matter Expert) Required = false Readable = false Writeable = true Add a Service Task t yur Pl Task Drag and drp a service task t yur pl General è Name = Send questin t the cmments Cnnect the start event and service task using a sequence flw Cnfigure the "addcmment" actin G t the Main cnfig tab Task type = Java class Select class Search fr addcmment delegate (make sure yu added the Cllibra cre api as a library, see: user guide) Add cmment field Name = cmment Expressin = ${questin} resultvariablename Name = questincmment Add a User Task t yur Pl Task Drag and drp a user task t yur pl General è Name = Answer the questin Cnnect the Send questin t cmments service task with the user task using a sequence flw Set the assigned user G t the Main cnfig Candidate user = ${rle} (= the rle which is cnfigured inside the start frm) Cnfigure the user frm G t the Frm tab Create new answer field Id = answer Name = Answer Type = textarea Required = true Readable = true Writeable = true Create new answer buttn Id = answerbuttn Name = Answer Type = buttn Default = false Required = false Readable = true Writeable = true Add a Service Task t yur Pl Task Drag and drp a service task t yur pl General è Name = Add answer as a reply cmment Cnnect the Answer the questin user task with the service task using a sequence flw Cnfigure the addcmment actin G t the Main cnfig tab Task type = Java class Select class Advanced Wrkflw Tips & Tricks: Step-by-Step Guide 5

6 Search fr addcmment delegate (make sure yu added the Cllibra cre api as a library, see: user guide) Add cmment field Name = cmment Expressin = ${answer} Add parent field Name = parent Expressin = ${questincmment.id} Add a Mail Task t yur Pl Task Drag and drp mail task t yur pl General è Name = Send Answer Cnnect the Add answer as reply cmment service task with the mail task using a sequence flw Cnfigure the mail actin G t the Main cnfig tab T = user(${startuser}) Subject = Yur questin: ${questin} has been answered Charset = UTF-8 Nn-html: The questin: ${questin} has been answered by ${users.getusernames(rle).iteratr().next()} ====================================== Answer: ${answer} Add a Terminate End Event t yur Pl End event Drag and drp a terminate end event t yur pl Cnnect the Send Answer mail task with the terminate end event using a sequence flw 1.3 BPMN image Advanced Wrkflw Tips & Tricks: Step-by-Step Guide 6

7 2. Ask the Expert Advanced Step Descriptin In this first step, we will add task buttn which uses a language translatin t make the required actin clearer t the user when he is pening his task. 2.2 Develpment The basics f wrkflws and the instructins n hw t install Eclipse + Activity Plugin can be fund in ur User Guide: API dcumentatin can be fund underneath (instanceurl)/dcs/index.html r Step by Step guide: Add a task buttn t the Answer the questin user task G t the Frm tab Add new taskbuttn Id = pentaskbuttn Name = answer.questin.buttn (will be translated by the language file f the Data Gvernance Center, this can be fund inside Settings è General è Language) 2.3 BPMN image Advanced Wrkflw Tips & Tricks: Step-by-Step Guide 7

8 3. Ask the Expert Advanced Step Descriptin In this secnd step, we will give the user the ptin t chse an expert when there is mre than ne expert assigned t the asset. 3.2 Develpment The basics f wrkflws and the instructins n hw t install Eclipse + Activity Plugin can be fund in ur User Guide: API dcumentatin can be fund underneath (instanceurl)/dcs/index.html r Step by Step guide: Add an exclusive gateway after the Send questin t cmments service task Gateway Drag and drp the exclusive gateway t yur pl Default flw = singleexpert Cnnect the Send questin t cmments service task with the exclusive gateway using a sequence flw Cnnect the exclusive gateway with the Answer the questin user task using a sequence flw Name = singleexpert Add a script task t yur Pl where we will get all the experts f a certain asset Task Drag and drp a script task t yur Pl Cnnect the exclusive gateway t yur script task using a sequence flw. Name = multipleexperts Main cnfig Cnditin = ${users.getusernames(rle).size()>1} Name = Set expert list Main Cnfig Script Language = Grvy Script: String subjectmatterexperts=users.getusernamescsv(rle) executin.setvariable('subjectmatterexperts', subjectmatterexperts) Add a user task t yur Pl Task Drag and drp a user task t yur pl Cnnect the Set expert list script task with yur user task using a sequence flw Name = Chse yur expert Set the assigned user Main Cnfig -> Candidate user = user(${startuser}) Create the user frm G the Frm tab Create new field where we will display the drpdwn f experts Id = user Name = Select a subject matter expert Type = user Frm values Advanced Wrkflw Tips & Tricks: Step-by-Step Guide 8

9 prpsedvalues = ${subjectmatterexperts} prpsedfixed = true Required = false Readable = false Writeable = true Create new task buttn Id = chseexpertbuttn Name = Chse Expert Type = taskbuttn Required = false Readable = true Writeable = true Add new service task t yur pl t reset the rle variable t the chsen expert Task Drag and drp a service task t yur pl Name = Set user expressin Main Cnfig Task Type = Expressin Expressin = user(${user}) Result variable = rle Cnnect the Chse yur expert user task with yur service task using a sequence flw Cnnect yur service task with the Answer the questin user task using a sequence flw 3.3 BPMN image Advanced Wrkflw Tips & Tricks: Step-by-Step Guide 9

10 4. Ask the Expert Advanced Step Descriptin In this third step, we will setup actin mail and activity stream s that the expert is able t answer the questin via Develpment The basics f wrkflws and the instructins n hw t install Eclipse + Activity Plugin can be fund in ur User Guide: API dcumentatin can be fund underneath (instanceurl)/dcs/index.html r Step by Step guide: Add actin mail capability t the Answer the questin user task G t the Listeners tab Create new ActinMailSender listener Event = create Type = java class Class = cm.cllbira.dg.cre.wrkflw.activity.tasklistener.actinmailsender Fields Subject = Questin: ${questin} (EXPRESSION) includeattributes = true includerelatins = true includeactivitystream = true Add activity stream (cmments) capability t the Answer the questin G t the Listeners tab Create new SetActivityStreamListener Event = create Type = java class Class = cm.cllibra.dgc.cre.wrkflw.activity.listener.setactivitystreamlistener Fields resurcetypes = CM 4.3 BPMN image Advanced Wrkflw Tips & Tricks: Step-by-Step Guide 10

11 5. Ask the Expert Advanced Step Descriptin In this furth step, we will explain hw t use the new API v2 (released tgether with Data Gvernance Center v5.1) 5.2 Develpment The basics f wrkflws and the instructins n hw t install Eclipse + Activity Plugin can be fund in ur User Guide: API dcumentatin can be fund underneath (instanceurl)/dcs/index.html r Step by Step guide: Remve the Add answer as reply cmment service task Add script task t replace it Task Drag and drp script task t yur pl Name = Add answer as reply cmment Main cnfig Script language = grvy Script: imprt java.util.set; imprt cm.cllibra.dgc.cre.api.mdel.reference.impl.resurcereferenceimpl; imprt cm.cllibra.dgc.cre.api.dt.instance.cmment. AddCmmentRequest; imprt cm.cllibra.dgc.cre.mdel.user.user; def baseresurceid = new ResurceReferenceImpl(UUID.frmString(item.id), cm.cllibra.dgc.cre.api.mdel.resurcetype.asset); def addcmmentrequest = AddCmmentRequest.builder().cntent(answer.tString()).parentId(UUID.frmString(ques ncmment.id)).baseresurce(baseresurceid).build(); cmmentapi.addcmment(addcmmentrequest) Advanced Wrkflw Tips & Tricks: Step-by-Step Guide 11

12 5.3 BPMN image Advanced Wrkflw Tips & Tricks: Step-by-Step Guide 12

13 6. Ask the Expert Advanced Step Descriptin In this fifth step, we will add functinality t handle Data Gvernance Center events which will enable the expert t answer the questin by replying t the cmment directly. 6.2 Develpment The basics f wrkflws and the instructins n hw t install Eclipse + Activity Plugin can be fund in ur User Guide: API dcumentatin can be fund underneath (instanceurl)/dcs/index.html r Step by Step guide: Add a signal bundary event t the Answer the questin user task Bundary event Drag and drp a signal bundary event n the Answer the questin user task Main cnfig Cancel activity = false Signal ref = COMMENT_ADDED Add script task t check whether the added cmment is the reply t ur questin Task Drag and drp a script task t yur pl and cnnect it with the signal bundary event using a sequence flw Name = Check added cmment is reply Main cnfig Script language = grvy Script: imprt cm.cllibra.dgc.cre.mdel.cmment.cmment String addedcmmentid = event.geteventresurceid() Cmment addedcmment = cmmentcmpnent.getcmment(addedcmmentid) Cmment parentcmment = addedcmment.getparentcmment() blean cmmentisreply = false if (parentcmment!= null) { if (questincmment.getid().equals(parentcmment.getid())) { cmmentisreply = true executin.setvariable('answer', addedcmment.getcntent()) } } executin.setvariable('cmmentisreply', cmmentisreply) Add exclusive gateway t yur pl t stp the wrkflw when the cmment is nt a reply t ur questin Gateway Advanced Wrkflw Tips & Tricks: Step-by-Step Guide 13

14 Drag and drp an exclusive gateway t yur pl Cnnect the check added cmment is reply script task with yur exclusive gateway using a sequence flw Add secnd end event t yur pl End event Drag and drp an end event t yur pl Cnnect the exclusive gateway with the end event using a sequence flw Name = nreply Cnnect the exclusive gateway with the Send answer mail task using a sequence flw Name = reply Main cnfig Cnditin = ${cmmentisreply} Cnfigure the default flw f the exclusive gateway General Default flw = n reply 6.3 BPMN image Advanced Wrkflw Tips & Tricks: Step-by-Step Guide 14

15 7. Ask the Expert Advanced Step Descriptin In this sixth step, we will learn yu hw t benefit frm asynchrnus peratins and run-as functinality. 7.2 Develpment The basics f wrkflws and the instructins n hw t install Eclipse + Activity Plugin can be fund in ur User Guide: API dcumentatin can be fund underneath (instanceurl)/dcs/index.html r Step by Step guide: Add the answer as a reply cmment in the backgrund G t the Add answer as reply cmment script task Check the bx Asynchrnus Make sure the cmment is added as the expert s user (asynchrnus tasks are executed by System) by implementing the run-as functinality G t the Add answer as reply cmment script task Script: imprt java.util.set; imprt cm.cllibra.dgc.cre.api.mdel.reference.impl.resurcereferenceimpl; imprt cm.cllibra.dgc.cre.api.dt.instance.cmment. AddCmmentRequest; imprt cm.cllibra.dgc.cre.mdel.user.user; User smeuser = users.getusers(rle).iteratr().next(); users.runasuser(smeuser, { def baseresurceid = new ResurceReferenceImpl(UUID.frmString(item.id), cm.cllibra.dgc.cre.api.mdel.resurcetype.asset); def addcmmentrequest = AddCmmentRequest.builder().cntent("[ANSWER 6]: "+answer.tstring()).parentid(uuid.frmstring(questincmment.id)).baseresurce(baser esurceid).build(); cmmentapi.addcmment(addcmmentrequest) }) 7.3 BPMN image Advanced Wrkflw Tips & Tricks: Step-by-Step Guide 15

16 Cllibra.cm US Fllw Us: twitter.cm/cllibra Cllibra