Sun Microsystems 3 manual

Process System Guide iPlanet™ Integration Serve r V ers ion 3.0 August 2001[...]

Copyright (c) 2001 Sun Mic rosystems, Inc ., 901 San Anto nio Road, Palo A lto, Californ ia 94303, U.S .A. All rights rese rved. Sun Micros ystems, Inc . has intel lectual property ri ghts relat ing to tec hnology emb odied in the product t hat is des cribed in thi s document. In partic ular, and without l imitation, these intell ectual pr operty r[...]

3 Contents List of Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 List of Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Preface . . . . . . . . . . . . . . . . . . [...]

4 iPlanet Integratio n Server • Proces s System Gui de • August 2001 iIS Process Manage ment Tasks (continued) Managin g iIS Proces s Engin es . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Managin g Registra tion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . [...]

5 The iIS Console Ma in Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Main V iewing Pa nel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Menu Ba r . . . . . . . . . . . . . . . . . . [...]

6 iPlanet Integratio n Server • Proces s System Guide • August 2001 Reconfigu ring an E ngine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 How to Reconfig ure an Engi ne . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .[...]

7 Chapter 6 Mana ging Process Ex ecution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 Introduc tion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 Engine S essions . . . . . . . . . . . . . . . . . . . . . [...]

8 iPlanet Integratio n Server • Proces s System Guide • August 2001 Monitorin g and M anaging Two-P hase C ommit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 99 Managin g Two-Phase C ommit Oper ations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 Chapter 7 [...]

9 Managing iIS P rocess Eng ines with Conductor Script (continued) Monito ring Engin es and En gine Co mponents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 39 Monitorin g the Eng ine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239 M[...]

10 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Conductor Script Commands (continu ed) CreateFilt er . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279 Event Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . [...]

11 Conductor Script Commands (continued) RemoveWri teLock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297 RollbackAct ivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 98[...]

12 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Appendix B Engine Database Sch ema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327 Databas e Tables by Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327 Alphab[...]

13 List of Figures Figure 1-1 An iIS Process M anage ment Syst em . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Figure 1-2 Minima l Engine C onfigura tion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Figure 1-3 Engine C onfigura tion wit h Failov er . . . . . .[...]

14 iPlane t Integrati on Server • Process Syst em Guide • August 2001[...]

15 List of Procedures To copy t he documen tation to a cli ent or server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 To view and sea rch th e document ation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Before you invo ke the set ccomp scr ip[...]

16 iPlane t Integrati on Server • Process Syst em Guide • August 2001 To use t he Dump/Rest ore appli cation to restore databa se table s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 To tran sfer iIS libra ry distri butions to a production environ ment . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 To regist er one[...]

List of Procedures 17 To view all eng ine eve nts for an existi ng proces s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 To view all eng ine eve nts for t he next pro cess inst ance of a specific proc ess definit ion . . . . . . . . . . 2 20 To specify a custom filter . . . . . . . . . . . . . . . . . . . [...]

18 iPlane t Integrati on Server • Process Syst em Guide • August 2001[...]

19 Preface The iIS Pro cess Syst em Guide describes how to manage a process syst em, one of the two subsystems that comprise iIS. The guide provides the system management principles and concepts upon which a process system is based, and describes how to perform process system man agement tasks. This preface contains the following sections: • “ [...]

Audience for This Guide 20 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Audience for This Guide This book as sumes familiarity with the basic concepts underlying an iIS proces s system. A discussion of th ese concepts an d a description of i IS process sy stem components , the functions they perform, and how they interact [...]

Text Con ventions Preface 21 Text Convent ions This section pro vides information a bout the conventions used in this document. Chapter 8, “ Using the Conductor Script Uti lity ” Explai ns how t o perfo rm iIS sy stem manage ment tasks using Conductor Script commands. Appendix A, “ Conduct or Scri pt Commands ” Provides a comman d referen c[...]

Other Documen tation Resou rces 22 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Syntax Stat ements Syntax s tatements that de scribe usag e of TOOL meth ods and script commands u se the following conventions : Other Do cument ation Reso urces In addition to this guide, there are add itional documentation resources, which a[...]

Other Documen tation Resources Preface 23 iPlane t Integr ation Server Documentat ion iIS Adapter Develop ment Guide iIS Backbone In tegration Guide iIS Backbone Sy stem Guide iIS Con ceptua l Overv iew iIS Installation Gu ide iIS Proces s Client Prog ramming Gui de iIS Proces s Develop ment Guide iIS Proces s System Gu ide Online Help When you are[...]

iIS Exam ple Prog rams 24 iPlane t Integrati on Server • Process Syst em Guide • August 2001 iIS Example Progr ams iIS example programs are shipped with the iIS product and installed in two locations, one for process development (us ing the process engine) and one for applicatio n integration (using the iIS backbon e). Process Develo pment Exam[...]

View ing and S earching PD F Files Preface 25 2. Set up a directory structure that keeps th e iisdoc.pdf and the iis directory in the same relativ e location. The directory structure must be preserved to use the Acrobat search feature. ➤ To view and se arch the do cumentation 1. Open the file iisdoc.pdf , located in the doc directory. 2. Click th[...]

Viewing and Search ing PDF F iles 26 iPlane t Integrati on Server • Process Syst em Guide • August 2001 5. Click the buttons on the Acrobat Reader toolbar or use shortcut keys to navigate throug h the search results, a s shown in the followi ng table: To return to the iisdoc.pdf file, click the Homepage bookm ark at the top of the bookmarks lis[...]

27 Chapter 1 Introduction: iI S Process Management iIS process system ma nagement is largel y devoted to managing iIS process engines and the functions th ey perform. This chapter provides a high level description of what an iIS process eng ine is and what it does. It describes the relationship of the engine to other parts of the iIS system and d e[...]

What Is an iIS Proc ess En gin e? 28 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Once a process definition has bee n registered with the engine, an iIS process client applicatio n (or an applicati on proxy — see Figure 1-1 on page 30 ) can open a se ssion with the engine and create an instance of the process. The client[...]

What Is a n iIS Process E ngine? Chapt er 1 Introdu ction: iIS Pro cess Ma nagement 29 Multi ple E ngine Syste ms An iIS system does not need to be limited to a single engine. It can have a ny number of engines. For example, one engine migh t be used for testing and another used for production. (s ee “ Production E ngines Versus Development E ngi[...]

What Is an iIS Proc ess En gin e? 30 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Figur e 1-1 An iIS Process Manage ment System Engine Database Central Development Repository Applicat ion Services Organization Database Proc ess Engines Registration System Management Tools Process Develpm ent Workshops Engine Database Enter[...]

iIS Proce ss Engine Component s Chapt er 1 Introdu ction: iIS Pro cess Ma nagement 31 iIS Process En gine Compo nent s As mentioned earlier in this chapter, an iIS process engine is the h eart of an iIS system and has been designed to support mis sion-critical produ ction applicatio n systems. The iIS process engine maintains performance under heav[...]

iIS Pro cess Engine C omponents 32 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Figur e 1-2 Minima l Engine Conf iguration Engine Uni t The engine uni t is an application that perf orms all the basic iIS engine f unctions ( see “ What Does an i IS Process Engine Do? ” on page 36 ). The engine unit is a single iPlanet U[...]

iIS Proce ss Engine Component s Chapt er 1 Introdu ction: iIS Pro cess Ma nagement 33 engine database is not supplied by the iIS product and must be set up independently; however, the engine unit can create all required data base tables at startup time. The iIS process engin e supports all relat ional databa se systems supported by iPlanet UDS (for[...]

iIS Pro cess Engine C omponents 34 iPlane t Integrati on Server • Process Syst em Guide • August 2001 opens a channel to the backup unit, which takes over by recovering all the persis tent state in formati on store d in the e ngine da tabase. T he new p rimary e ngine unit starts process execution at the point where the old primary engine unit [...]

iIS Proce ss Engine Component s Chapt er 1 Introdu ction: iIS Pro cess Ma nagement 35 Full Confi guration: Fai lover and Load Balancing Combi ned To deal with hea vy loads on the engine and overcom e the potential bottleneck of a single databa se service, add itional database service s can be added to the failover engine configura tion, as illustra[...]

What Does an iI S Pr oces s Eng ine D o? 36 iPlane t Integrati on Server • Process Syst em Guide • August 2001 What Do es an iIS Pr ocess En gine Do? As suggested in “ W hat I s an iIS Proc ess E ngine ? ” on page 27 , an iIS pro cess engine performs a number of different functions in support of an iIS system. These include the follow ing. [...]

iIS Proc ess Manageme nt Tasks Chapt er 1 Introdu ction: iIS Pro cess Ma nagement 37 Figur e 1-5 Engine Ma nager Ob jects iIS Process Man agement Ta sks iIS process managemen t tasks can be grouped int o four broad categories: • setting up and maintain ing an iIS proces s system • managi ng iIS pro cess eng ines • managi ng registr ation of p[...]

iIS P roce ss Manage men t Tas ks 38 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Settin g Up an iPlan et UD S Runt ime Enviro nment An iIS process management system runs in an iPlanet UDS software environment. Both th e devel opmen t an d product ion cap abil itie s of iI S (bot h pro cess development and process executio[...]

iIS Proc ess Manageme nt Tasks Chapt er 1 Introdu ction: iIS Pro cess Ma nagement 39 Managing iI S Process Engi nes Care must be taken to make sure that each iIS process engine is set up and performing properly. Managing engines consists of the following tasks: • configuring eng ines • starting up and shutting down engine components • monitor[...]

iIS P roce ss Manage men t Too ls 40 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Managing process execution involves monitoring the activity of the engine and making a dministrati ve adjustme nts when necessa ry. The specific task s include: • monitoring engine sessions, and suspending or terminating sessions when neces[...]

iIS Process M anageme nt Tools Chapt er 1 Introdu ction: iIS Pro cess Ma nagement 41 Conductor Script Utility The Conductor Script utility is the functional equ ivalent of the iIS Consol e applicatio n, but with a command- line interface. You can perform an y of the functions usin g Conductor Script comma nds that you can perform in the iIS Console[...]

iIS P roce ss Manage men t Too ls 42 iPlane t Integrati on Server • Process Syst em Guide • August 2001[...]

43 Chapter 2 Setting Up an iIS Process Management System Setting up an iIS process managemen t system — whether for development, testing, producti on, or a c ombinatio n of the three — is the f irst task you mus t perform as an iIS pr oce ss sy ste m man ager. System setup invol ves determining whic h nodes in your environ ment support the diff[...]

Prepar ation: Set ting up an iPlanet U DS Runtime Environmen t 44 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Prepara tion: Settin g up an iPl anet UDS Runtime Environment An iIS process syste m runs in an iPlanet UDS software environment. Both the development and run time capabilities of iIS (process development an d pro[...]

iIS Process Syste m Components Chap ter 2 Setting Up an iIS P rocess Manage ment Sys tem 45 The iPlanet U DS installation program creates an iPlan et UDS directory st ructure and source files on your target node, se ts a number of environment variables used by i Plane t UDS a t st art up ti me, and c rea tes st artu p s crip ts f or st arti ng th e[...]

iIS Process System Compone nts 46 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Figur e 2-1 Components of an iIS Process Syst em The components of an iIS process system, shown in Figure 2-1 , are implemented through a n umber of software modu les running on vario us nodes in you r computing environment. Some of the componen[...]

iIS Process System Sof tware Chap ter 2 Setting Up an iIS P rocess Manage ment Sys tem 47 To set up an iIS process syste m, install the iIS system soft ware module s that support development o n your development nodes. Then install the iIS runt ime modules on the nodes o n which you will be executing yo ur distributed enterprise applicat ions. iIS [...]

iIS Process Sy stem Software 48 iPlane t Integrati on Server • Process Syst em Guide • August 2001 WFLibra ry (compiled) Process devel opmen t A libra ry distr ibution that su pports t he process develo pment worksh ops. Needed in iIS process developmen t reposito ry an d on process develo pment nod es. WFModel (compiled) Process devel opmen t [...]

iIS Process System Sof tware Chap ter 2 Setting Up an iIS P rocess Manage ment Sys tem 49 WFClientAP I (compiled) C++ client application dev elopm ent A DLL requir ed to wri te process client application code in C++ . Needed on C++ clien t application developmen t nodes , and on runtime nodes run ning C++ client applicat ions. WFCORBAapi (compiled)[...]

iIS Process Sy stem Software 50 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Compiled and I nterp reted Engine Components There is a script for alternating between the use of compiled or interpreted engine components . This is useful if exceptions o ccur when you are runnin g an engine in compiled mode; you can switch to i[...]

iIS Process System Sof tware Chap ter 2 Setting Up an iIS P rocess Manage ment Sys tem 51 ➤ Before you inv oke the se tccomp script, you must do the foll owing 1. Set the FORTE_ ROOT environmen t variable to point to a val id iIS instal lation. 2. Install the f ollowing iIS library distributions in the iPlanet UDS devel opment environment: ❍ WF[...]

iIS Process Sy stem Software 52 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Repository ser ver A server node ( runs an iP lane t UDS N ode Manage r) th at hos ts the iIS central development repository and repository service. Engine serv er A server n ode (runs an iPla net UDS Node Ma nager) that hosts o ne or more engine [...]

iIS Process System Sof tware Chap ter 2 Setting Up an iIS P rocess Manage ment Sys tem 53 Figur e 2-2 iIS Process System Con figuration You do not ha ve to decide at iIS install ation time exact ly which engine compo nents to assign to each server node because all compo nent partitions are installed on each server node that supports an engine. You [...]

iIS Process Sy stem Software 54 iPlane t Integrati on Server • Process Syst em Guide • August 2001 For the purpose of system setup, the primary considerations are that the iIS process engine is th e workhorse of y our iIS process sy stem and that it accesses a p otentially very large database. Your engine server node or nodes shou ld therefore [...]

Setting Up an iIS Process Sy stem Chap ter 2 Setting Up an iIS P rocess Manage ment Sys tem 55 Setting Up an iIS Process System After you have decided how to configure your iIS process system (and filled out the table in the previous section), you are ready to set up your system. To set up an iIS pro cess system , run the platform-spe cific iIS ins[...]

Setting Up an iIS Process Sy stem 56 iPlane t Integrati on Server • Process Syst em Guide • August 2001 7. After process client appl ications have been developed, run the iIS installation program on all runtime client nodes (those nodes th at support an iIS process client applicat ion but do not support d evelopment). 8. In sites developi ng or[...]

Setting Up an iIS Process Sy stem Chap ter 2 Setting Up an iIS P rocess Manage ment Sys tem 57 Central Serve r Installation On a cent ral serve r node — th e first node to b e installed in an iIS system — th e iIS installatio n program performs the opera tions described in the follo wing table: Operation Software Module FORTE_ROOT directory Pre[...]

Setting Up an iIS Process Sy stem 58 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Engin e Server Installa tion On an engine s erver node, which must be installed after the cen tral server node, th e iIS instal lation program performs th e operations described in th e following table: Operation Software Module FORTE_RO OT d[...]

Setting Up an iIS Process Sy stem Chap ter 2 Setting Up an iIS P rocess Manage ment Sys tem 59 Developm ent Client Installation A development client node can be used for either process development or client applicatio n development. On a develo pment client node, wh ich must be installed after the central server node, the iIS installa tion program [...]

Setting Up an iIS Process Sy stem 60 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Runtime Client Insta llation On a runtim e client node, which m ust be installed af ter the central server no de, the iIS instal lation program performs th e operations described in th e following table: Configurin g and Starting Your iIS Eng[...]

Maintaining an iIS Process Sy stem Chap ter 2 Setting Up an iIS P rocess Manage ment Sys tem 61 Maintaining an iIS Process Sys tem Once your iIS process system is set up and functional (inclu ding configurati on and startup of eng ines, as discussed in Chapter 4, “ Managing En gines ” ), there are relatively few m aintenance tasks that yo u nee[...]

Maintain ing an iIS P rocess System 62 iPlane t Integrati on Server • Process Syst em Guide • August 2001 3. Choos e default or c ustom ins tallation , depen ding on the compon ents you wan t to install on the node. Moving an i IS Eng ine Moving an iIS engine or engine component is straightforward. Y ou move the engine or engine component to a [...]

Maintaining an iIS Process Sy stem Chap ter 2 Setting Up an iIS P rocess Manage ment Sys tem 63 3. Move the two iIS repos itory files ( reposn ame .btx and reposnam e .btd) fro m FORTE_ROOT/repos on the original Repository Server node to the same location on the target node. 4. Modify the iPlanet UDS star tup script on the server to include the rps[...]

Maintain ing an iIS P rocess System 64 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Uninstal ling an iIS System Because iIS server so ftware is installed usi ng iPlanet UDS sys tem management services, the iPlanet UDS environ ment repository has a record of al l engine components installed on servers in your environment. T[...]

65 Chapter 3 The iIS Console This chapter describes the iIS Conso le, the iIS product ’ s window -based to ol for performi ng iIS proce ss managem ent task s. This chapte r assumes that yo u have set up an iIS proce ss managem ent system and have installed iIS process management appl ications (iIS Con sole and Conductor Script) on at least one no[...]

Overview 66 iPlane t Integrati on Server • Process Syst em Guide • August 2001 The iIS Console is us ed for the following four general k inds of iIS process managem ent tasks: • configure and manage process engines The iIS Console provides a set of w indows that let you configure a new iIS engine, start and view the status o f an already conf[...]

Starting the iIS Co nsole Chapt er 3 The iIS C onsole 67 Starting t he iIS Console You can st art the iIS Console on any node in your iPlanet UDS environment w here it has been installed. ➤ To start th e iIS Console o n Windows or Wi ndows NT 1. Double-click the iIS Console icon. 2. Enter a valid passwo rd if one is requested (see “ Setting Pa [...]

The iIS Console M ain Windo w 68 iPlane t Integrati on Server • Process Syst em Guide • August 2001 The follow ing table descri bes the command line flags for the cconsole command. The iIS Consol e Main Win dow The iIS Console main window is a view of con figured iIS process engines in yo ur active environment. In the main window, you can initi[...]

The iIS Console M ain Windo w Chapt er 3 The iIS C onsole 69 Figur e 3-1 iIS Console M ain Window Main Viewin g Panel The main viewing pa nel displays all conf igured engines in an iP lanet UDS environment. Engines are shown wi th icons representing the state of each engine: Most tasks yo u perform using the iIS Con sole are initiated by first sele[...]

The iIS Console M ain Windo w 70 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Menu Bar The iIS Console menu bar provides all the commands you can execute from the main win dow. The menus are su mmarized below , and a full list of the co mmands is provided at the end of this ch apter. The ma in wi ndow me nus ar e: Environm[...]

The iIS Console M ain Windo w Chapt er 3 The iIS C onsole 71 Setting Pa ssword Protectio n for iIS Console You can restrict access to iIS Console by settin g password protection for your active iIS environment. A password is then re quired to open iIS Console, as well as any other syst em management to ols, such as Cond uctor Script and the iPlanet[...]

Using iIS Console Windows 72 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Using iIS Console Windows The iIS Console is a graphical system applicatio n developed in iPlanet U DS whose windows behave in accordance with your host window system. If you use graphical applica tions in your host wi ndow system, th e Console will [...]

Using iI S Console Windo ws Chapt er 3 The iIS C onsole 73 ➤ To set t he automatic refr esh inter val 1. Choose View > Set Refresh Interval. The Refresh Interval window displays with the default tim e interval setting: 2. Enter a new time int erval in milliseconds . A time interval of zero tu rns off automatic refresh. 3. Click OK. ➤ To forc[...]

Using iIS Console Windows 74 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Operat ors You can buil d filter expressions that us e both comparison and lo gical operators. The compariso n operators are listed in th e following table: You can use a number of logical operators to join several filter expressions. The logical ope[...]

Using iI S Console Windo ws Chapt er 3 The iIS C onsole 75 Exampl e Filter Expre ssion In the session list example, suppose you enter the following expressio n in the Filter window : Activity RE ADY Activity ACTIVE Activity COMPLETED Activity AB ORTED Timer ON Timer OFF Object State/Status Value[...]

Using iIS Console Windows 76 iPlane t Integrati on Server • Process Syst em Guide • August 2001 The resulting session list w ould then be the fo llowing: Sorting i IS Console L ists The iIS Conso le lets you sort sessi ons, activitie s, and process ins tances by name, version, primary attribu te value, primary attribute name, ID , or creation t[...]

Using iI S Console Windo ws Chapt er 3 The iIS C onsole 77 4. If you select a text field, you can also specify that case-sensitivity apply to the displayed text by checking Cas e Sensitive Text Comparison. 5. Click OK. Using List Vi ews The iIS Console provides iPlanet UDS list views in the main window and th e Engine Status window so you can brows[...]

iIS Con sole Mai n Window Co mmand S ummary 78 iPlane t Integrati on Server • Process Syst em Guide • August 2001 iIS Console Main Window Command Summary The following tables summariz e the commands available f rom the iIS Console main win dow. Environment Menu Command Description See… Alarms … Lets you view all ala rms received f rom the s[...]

iIS Co nsole Main W indow C ommand Su mmary Chapt er 3 The iIS C onsole 79 View Menu Engine Menu Command Description See … Refresh N ow Forc es an im mediate refresh of t he engine list in the main viewing panel. page 72 Set Refr esh Interv al … Opens a Ref resh Interval window w here you can s et th e tim e inter val b etwee n au tomatic refre[...]

iIS Con sole Mai n Window Co mmand S ummary 80 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Monitor Menu Trace … Opens an engine trac e window in whic h you display messages, of the type you s pecify, gen erated by the various engine co mponents. page 212 Event Tra ce … Opens th e engine ev ent filter w indow which let[...]

iIS Co nsole Main W indow C ommand Su mmary Chapt er 3 The iIS C onsole 81 Help Menu Activiti es Resident … Opens the engine acti vity insta nces window, which displays t he list of all ac tivity instanc es for the selec ted engin e. You can so rt this list by activ ity name, activity ID, acti vity stat e, and proces s name. You can open a listed[...]

iIS Con sole Mai n Window Co mmand S ummary 82 iPlane t Integrati on Server • Process Syst em Guide • August 2001[...]

83 Chapter 4 Managing Engines This chapter describes how to manage iIS process engines. It covers the following topics: • configuring a n engine • starting an engine • monitori ng and chan ging th e state of a n engine • reco nfig uri ng a n eng ine t o acc omm odate inc rea sed lo ad, impr ove performance, or recover fro m failure • mana[...]

Productio n Engines V ersus Develo pment E ngines 84 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Keep these issues in mind when configuring an engine. In most situations, you have to configu re and manage at least one development en gine and one producti on engin e. State i nformation is needed for recov ery: current stat[...]

Config uring an E ngine Chapte r 4 Managin g Engines 85 Configuring a n Engine An iIS process system can h ave any number of engines. For example, one engine might be used for testing and another used for production. In other cases, organizati onal consi derations or hea vy load cond itions might requ ire a number of production engines. While engin[...]

Configur ing an Engine 86 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Figur e 4-1 Engine Configu ration with bot h Failover and Load Balancin g During insta llation, you de cided which nod es in your iPlanet UDS environment (engine servers) would have engine components installed on them. You must also determine your engin[...]

Config uring an E ngine Chapte r 4 Managin g Engines 87 Governor The governor does not do much processing and does not req uire a high performance server. It is recommended that you not assign it to the sa me server as either the primary or backup engine unit, because it would then not be able to dist inguish between failure of the primary engine u[...]

Configur ing an Engine 88 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Figur e 4-2 Typical Engine Pa rtitioni ng Scheme Engine Start up Properties Before you start an engine, yo u must specify a number of startup properties. These properties are stored in th e engine configuration file. The startup properties are the follo[...]

Config uring an E ngine Chapte r 4 Managin g Engines 89 Engine name An alpha-numeric name used to identify the engine in a given environment. Environment An alpha-numeric name th at specifies the iPla net UDS environment in which the engine resides. Database Config uration Properties Properties needed to access the engine database. These proper tie[...]

Configur ing an Engine 90 iPlane t Integrati on Server • Process Syst em Guide • August 2001 Engine Configu ration Fi le The engine component partitioning and engine startup properties are stored in an engine configura tion file in the followi ng location on the central server no de in you r en viro nmen t: FORTE_ROOT /sysdata/conductr/cl N / e[...]

Config uring an E ngine Chapte r 4 Managin g Engines 91 The engine properties specified in the configuration file ar e described in the following ta ble: Ta b l e 4 - 1 Proces s Engine Con figuration Properties Propert y Type of value Description FILE _VER SION stri ng Inte rnal us e. Do n ot modif y. GOVERN OR string Specif ies the nod e on wh ich[...]

Configur ing an Engine 92 iPlane t Integrati on Server • Process Syst em Guide • August 2001 GOVERNOR_MEMORY_ FLAG string Specifies memory options. Uses the sa me syntax as th e -fm flag used on i Plan et UDS part ition s. Defau lt valu es are n:2048,x :16384 , … . DBSERVICE_MEMORY_ FLAG string Specifies me mory optio ns. Uses t he same synta[...]

Config uring an E ngine Chapte r 4 Managin g Engines 93 Customizin g Engine Database Schema iIS provides a default databa se schema that it uses to create an en gine database. This default schem a can be used in a development environment wit hout modification. However, for deployed applications, you can modify the database schema according to you r[...]

Configur ing an Engine 94 iPlane t Integrati on Server • Process Syst em Guide • August 2001 When you configure a new engine, the default engine schema is specified by the following file on the central server node in your environment: FORTE_ROOT /sysdata/conductr/cl N / enviro nment / engine_name .dbs The database schem a file uses XML to defin[...]

Config uring an E ngine Chapte r 4 Managin g Engines 95 The following example shows how to modify the create index statement fo r the WFHActivity tabl e to include a table space qualifier. How to Configure a New Engine The easiest way to co nfigure a new engine is to use the iIS Console to create a n ew engine configura tion file and place it in th[...]

Configur ing an Engine 96 iPlane t Integrati on Server • Process Syst em Guide • August 2001 ➤ To configure a new engine 1. Choose Engin e > New. The Configure New Engi ne window displays : 2. Enter a name for the ne w engine in the Engine name field. The name can be case-s ensitive and of any length, but have no spaces. 3. Click the Datab[...]

Config uring an E ngine Chapte r 4 Managin g Engines 97 4. Enter the database config uration properties. For information on the Database Connection fields, refer to the iIS online help. The Text Attribute Segment Size fields allows you to specify the segment length for process a ttributes and user profile informatio n for a session. 5. Click the Lo[...]

Configur ing an Engine 98 iPlane t Integrati on Server • Process Syst em Guide • August 2001 6. Spec ify th e en gine da taba se t abl es ( Curr en t sta te a nd/ or Hist ory log) fo r wh ich you want to log information. If you wri te to history log tables, specify the informatio n to log. Current state This setting determines whether the engin[...]

Config uring an E ngine Chapte r 4 Managin g Engines 99 7. Select the Compon ents tab. The Component Partitioning dialog is displayed. 8. Specify the engine component partitioning. When assigning a component to a node, be sure that the node is an engine server node (that is, that engine com ponents were ins talled on the nod e during iIS instal lat[...]

Configur ing an Engine 100 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 a higher nume ric value signifying a h igher priority. It is sug gested that you decide on a sensible set o f priorities. A default priority of “ 1 ” is used if you do not specify a priority. The engin e distributes the database access load bas e[...]

Config uring an E ngine Chapter 4 Ma naging Engines 101 10. Specify memory options for the governor, database service, and engine unit memory flags if you want to override the default values. The settings yo u are most likely to cha nge are the minimum and maximu m memory allocation for engine units. The minimum allocation specifies the default siz[...]

Configur ing an Engine 102 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 11. Speci fy how many monitor windows can be open at a ny time. The Monitor Di splay Limit o ption (default va lue of 10), indica tes how many iIS Console monito r windows can be open a t any time. This limit appl ies to Sessions , Processes Resident[...]

Config uring an E ngine Chapter 4 Ma naging Engines 103 The process execution options are the following: For information about how to use these config uration options , see “ How to Tune Process Ex ecution ” on page 1 16 . 14. S peci fy en gin e rec ove ry be hav ior . If an engine goes down, an d then recovers, you can specify how long the eng[...]

Configur ing an Engine 104 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Duplicat ing an Engine Conf iguration If you have multiple engines that need to be configured similarly, or want to add an engine wi th a configurat ion similar to an exist ing engine, you can d uplicate an engine configuration. After creating a dupl[...]

Starti ng an Engine Chapter 4 Ma naging Engines 105 Startin g an Engine To start an engine, you start ea ch of its components — engine unit s, governor, and database services. These compone nts are applications, each consisting of a single serv er pa rt itio n that mus t es tabl ish c ommu nica tio n chan nels with oth er components. As each of t[...]

Starting an En gine 106 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 The governor has four internal sta tes, depending on its connections with the engine units: As the governor changes state (that is, as engine units start up and shut down), it determines which en gine unit is primary based on the state of the engine uni[...]

Starti ng an Engine Chapter 4 Ma naging Engines 107 If an en gine unit s tarts before the governor, but after its partner has started, then it must negotia te with its partner to establish which unit is to become primary. If one unit has been marked as the preferre d primary, then that unit becomes primary. If neither unit has been marked as the pr[...]

Starting an En gine 108 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Primar y Engin e Unit Start up Phases The primary engine unit must perform a number of startup operations to come fully online. These operati ons depend on whether the primary en gine unit is recovering from failure, is restarting an en gine on an exist[...]

Starti ng an Engine Chapter 4 Ma naging Engines 109 Database Servi ce When a database service starts, it attempts to conn ect to the primary engine unit. If the primary engine uni t is not online, the databa se service continues waiti ng for it indefinitely . When the primary engine unit starts up, the database service opens a communica tion channe[...]

Starting an En gine 110 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 How to Start an Engine You can start engine components from a centralized location using the iIS Console (see Cha pt er 3, “ The iIS Console ” ). The iIS Console uses iPlanet UDS syste m management agents to start the partitions corresponding to eac[...]

Starti ng an Engine Chapter 4 Ma naging Engines 111 3. Select a startup optio n. A number of options are av ailable for creating new engine database tables when starting an en gine (see “ Managing an Engine D atabase ” on page 124 ): Startup Option Description warm No new database tabl es are created during the primary engine unit startup pr oc[...]

Starting an En gine 112 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 4. Disable the engine components you do not want to start. By default, all compo nents specified in your configu ration file are ena bled. 5. Click Start. The governor, engin e units, and database services are sta rted, in that ord er. If the primary en[...]

Reconfig uring a n Engine Chapter 4 Ma naging Engines 113 Reconf igurin g an Engine An engine ’ s component partitioning and startup properties are stored in its engine configuration f ile, which is read at engin e startup time. To reconfigure an engine you modify the configuration file and restart the engine. Some limited reconfiguration , such [...]

Reconfig uring an Eng ine 114 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 2. Choose Engine > Reco nfigure. The Reconfigure Eng ine window displays: 3. Select the appropriate tab to m odify the property or properties you want to change. 4. When you have finish ed reconfiguring you r engine, click Save. The modified in[...]

Reconfig uring a n Engine Chapter 4 Ma naging Engines 115 How to Dynamically Modify Da tabase Log ging To chang e the logging configurati on of yo ur engine, norma lly to reduce or increase the amount of his torical state informatio n being logged to your eng ine database, you do not have to resta rt the engine. ➤ To modify dat abase loggi ng for[...]

Reconfig uring an Eng ine 116 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 How to Tune Process Exe cution The perform ance of a n engine depends on available system resources, such as memory. For example, if engine memory resources become overtaxed, engine perfor mance ca n degrad e, and an eng ine can e ven fail. It is [...]

Monit oring and Changin g Engine States Chapter 4 Ma naging Engines 117 used process instances (and al l their associated activities, timers, and process attributes), un til it brings the number of mem ory-resident process instan ces back within th e limit. The engine perform s these checks periodica lly, as specified by the value of the Swap-out I[...]

Monito ring and Ch anging Engine Sta tes 118 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Monitorin g Engine s and Engine Component s You can get sta tus informa tion about the engin e as a whol e as well as about each of the individual engine component in the iIS Console (see Chapter 3, “ Th e iIS Console ” ). iIS C[...]

Monit oring and Changin g Engine States Chapter 4 Ma naging Engines 119 The window provides information about the runtime state of the en gine and engine compon ent partitions. Part itions that are runnin g (even if not fully functional) are shown with a w arm-up state icon. For more detail on the functional state of a component, you can select tha[...]

Monito ring and Ch anging Engine Sta tes 120 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 The right side of the window provides information about the status of the engine component. F or example, status i nformation con tained on a pri mary engine unit is shown be low. Engine uni t In the case of an eng ine unit the foll[...]

Monit oring and Changin g Engine States Chapter 4 Ma naging Engines 121 Governor In th e case of a governor the followin g information is pro vided: Database ser vice In the case of a database servi ce the following in formation is provided: peak allo cated memory the amount of allocated memory remaining after the most recen t memory recla mation ([...]

Monito ring and Ch anging Engine Sta tes 122 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Changing Eng ine States You can chan ge the state of an engine, which usually involves changing the state of one or both engine units or shutting down one or more engin e components. You can use the iIS Console to perform many of th[...]

Monit oring and Changin g Engine States Chapter 4 Ma naging Engines 123 3. Click the Set Primary button i n the Engin e Status w indow. The pri mary unit now becomes th e backup unit, and the backup becomes the online unit . About R ecovering State Inform ation In a production system, placing a backup unit online requires recovering state informati[...]

Managi ng an Engine Datab ase 124 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 For more details on recovery levels, see the iIS Process Dev elopment Gui de and the iIS Proces s Client Prog ramming Gui de . Shut ting Down Eng ine Com ponen ts You can sh ut down an individua l component by clickin g the Shutdown butt on in[...]

Managi ng an Eng ine Database Chapter 4 Ma naging Engines 125 Growth of the Da tabase As with any of the enterprise data bases used by your workflow application, the engine database can grow in size. The current state tables grow and sh rink in proportion to the number of sessions, process instances, activities, process attributes, and timers that [...]

Managi ng an Engine Datab ase 126 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Dumping and Restori ng Data The iIS Dump/Res tore facility makes it possibl e to dump the data in an engine database to an ASCII file, an d then, subsequently, to restore the data to the existing database or to a new engine database. It is use[...]

Managi ng an Eng ine Database Chapter 4 Ma naging Engines 127 Using the Dump/Restor e Application The following procedure shows how to use the Dump/Restore application. ➤ To use the Dump/Restore applicati on to dump database tables 1. Start the Dump/R estore application. ❍ on Windows or Windows NT: double-click the Dump/Res tore icon. ❍ on UN[...]

Managi ng an Engine Datab ase 128 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 2. Configure a data file in which to dump the data. a. Click the Configure Fil es tab. b. In the Directory na me field, specify the directory into w hich the data file will be written . The directory must al ready exist; the Dump/R estore appl[...]

Managi ng an Eng ine Database Chapter 4 Ma naging Engines 129 3. Specify the engine database f rom which to dump th e data. a. Click the Configure Data base tab. b. In the Engine name field, enter the name of the engine whose data yo u want t o dump . When you exit the field, the Database type, Database name, User name, and User passwo rd fields wi[...]

Managi ng an Engine Datab ase 130 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 4. Dump the data. a. Click the Dump Tables tab. b. Select the category of tables you want to dump. By default, all categories are selected. Disable any category you do not wan t t o du mp. c. Click the Dump Tables button. d. Click OK in the In[...]

Managi ng an Eng ine Database Chapter 4 Ma naging Engines 131 As in all iPla net UDS command li ne specifications, if yo u use a name that includes a space, you should enclose the name in double quotation marks. The follow ing table descri bes the command line flags for the DrDump command: If you have set the environment variables described in “ [...]

Managi ng an Engine Datab ase 132 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Preservin g Engine Databa se Schema Cust omizations If you are upgrading to a new release of iIS, the database s chema for the process engine may have changed. If, in the previous release, you modified a process engine database schema to confo[...]

Managi ng an Eng ine Database Chapter 4 Ma naging Engines 133 Using the Dump/Restor e Application The following procedure shows how to rest ore database tables that were previously writ ten to an ASCII file, as explained in “ Dumping Database Tables ” on page 126 . ➤ To use the Dump/Restore applicati on to restore database tables 1. Start the[...]

Managi ng an Engine Datab ase 134 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 4. Restore the data. a. Click the Restore Tables tab. b. Select the categ ories of tables you want to restore. By default, all categories are selected. Disable any category you do not want to restore. c. Click the Restore Tables button. d. Cli[...]

Managi ng an Eng ine Database Chapter 4 Ma naging Engines 135 Using the Restore Command-l ine Utility The Dump/Restore facility ’ s DrRestore command retrieves data which has been dumped to an ASCII file and restor es it into an engine database. Syntax fo r drrest command: drrest -e engine_name [-d directory_name ] [-v data_file_name ] [-t regist[...]

Managi ng an Engine Datab ase 136 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Dump/R estore En vironm ent V ariable s iIS provides a s et of environment variables for use with the Dump/Restore f acility. You can set these variables to provide values for both the Dump/Restore applicatio n and the comm and-line utility . [...]

137 Chapter 5 Managing Registra tions Registration is the procedure by which program matic information abou t processes, users, and so on, created in the process developm ent workshops , is made available to a running iIS process engine, so it can be dyna mically loaded and used in process execution. The programmatic informa tion usually consi sts [...]

About Re gistration 138 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Registration is the procedure by which process logic created in the iIS process development workshops is made available to a runn ing engine (see “ What Does Registra tion Do? ” below) . The entities that get registered with an iIS en gine (describe[...]

About Reg istration Chapt er 5 Managi ng R egis trat ions 139 What Does Regist ration Do? The entity actually registered when you register a process defin ition, assignment rule, user profile, or user validati on is a library. (Alia ses are not libraries and this section does no t apply to them — see “ About Alia ses ” on pag e 143 .) A libra[...]

About Re gistration 140 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Figur e 5-1 Registration Steps • Installin g library distribution files o n the nodes hosting th e target engine (more specifically, hos ting the target engine un its). This step is performed by iPlanet UDS s ystem management agents. The highest compa[...]

About Reg istration Chapt er 5 Managi ng R egis trat ions 141 If at so me point you ha ve to move an engin e unit to a new node, you d o not have to manually re-register (reinstall) all the libraries on the new node. When an en gine unit first comes on line, if the registered libraries are not current ly installed on the host node, iPlanet UDS auto[...]

About Re gistration 142 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 4. Follow the in structions for registering iIS distribution s in “ Registering iIS Distribut ions ” on page 144 . What Does Unregist ration Do? Unregistering process d efinitions, assi gnment rules, user profiles, or a validation does not reverse t[...]

About Reg istration Chapt er 5 Managi ng R egis trat ions 143 About Alia ses An alias is a referen ce to a process definition registered w ith an engine. It is used by developers when defining a Subprocess activity in a process definition so they do not have to hard code the process name and host engine represented by the Subprocess activit y. Alia[...]

Registering iIS Distributions 144 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 If process1 and process2 ha rd-code the reference to process3 on engine3, then process3 could not be mo ved to another engine withou t modifying both process1 and process2 in the Process Definition Workshop, creating the respective library dis[...]

Regist ering iIS D istributi ons Chapt er 5 Managi ng R egis trat ions 145 Process Definit ion A process def inition must be registered with every engine that can execute that process def inition. Upgraded process definitions can be registered witho ut unregistering the old versio ns: the old process definition s are used for existing process insta[...]

Registering iIS Distributions 146 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 ➤ To register one or more d istributions using the iIS Consol e 1. Choose Environment > Registrations> New. The Register Distributions window displays: 2. To filter the list of distributions ava ilable for registration , select Process[...]

Regist ering iIS D istributi ons Chapt er 5 Managi ng R egis trat ions 147 Upgrading Reg istration s Sometimes you must register a new version (upgrade a registration) o f one of these library distributions. How you upg rade a registration depends on the upgrade registrati on characteristics of the d istribution type, as summ arized in the follow i[...]

Registering Aliases 148 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 ➤ To unregister a process definitio n, assignment rule dictionary, or user profil e 1. Choose Environment > Registration > Unregister. The Unregister Distribution window displays: 2. In the Distribution field, enter the name of the process defin[...]

Registering Aliases Chapt er 5 Managi ng R egis trat ions 149 Unlike process definitions, assignment rule dictionaries, user profiles, and the validation , aliases do not inv olve library distributi ons. In registering a n alias, you are simply making an entry in an engine ’ s r egistration table. You can register only one alias at a time, but yo[...]

Viewing Registration s for an E ngine 150 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Unregisterin g Alias es At times you might want to unregister an al ias from one or m ore engines, normal ly because thos e engines ar e no longer us ing it. Yo u can unregister only on e alias at a time. ➤ To unre gister an alias 1.[...]

Viewin g Registratio ns for an E ngine Chapt er 5 Managi ng R egis trat ions 151 ➤ To vi ew t he reg ist ratio ns f or a give n en gine 1. Select a runnin g engine in the iIS Conso le main window. 2. Choo se Mon itor > Re gis trati ons, or ch oos e Regi str ation s fr om the pop up menu. The Regist rations wind ow displays: 3. Click a tab to v[...]

Viewing Registration s for an E ngine 152 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 3. Click a tab to open it to view a particular type of registered distribution. The menu bar changes depending on th e type of registration you are viewing. For example, if you are viewin g assignment rul e distributions, yo u see the [...]

Perfor ming App lication Up grades Chapt er 5 Managi ng R egis trat ions 153 4. Right-cl ick and choose Process D efinition > Open fro m the popup menu. The Processe s Resident window displa ys: By selecting a process instance in the window a nd opening it (doubl e-click or use the mouse popup menu), you can get the process in stance ’ s activ[...]

Perform ing Appli cation U pgrades 154 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 However, sometimes an upgrade involves a new or modified extended user profile. If this is the case, then the user profile, the validation and the assignment rule dictionaries tha t depend upon it, an d client applica tions that reference[...]

Perfor ming App lication Up grades Chapt er 5 Managi ng R egis trat ions 155 Rolling Upgrade s Rolling upgrades must be used in production situations where work cannot be interrupted and client applicatio ns cannot be upgrad ed monolithica lly. In a rollin g upgrade, the changeover f rom an earlier version to an upgraded vers ion takes placed gradu[...]

Perform ing Appli cation U pgrades 156 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1[...]

157 Chapter 6 Managing Process Execution The main function of an iIS process en gine is to coordinate the work done by a variety of users (or application components) in perfo rming the activities that comprise a busin ess process. The e ngine does this by executing iIS process definitions that have been registered with the engine. Managing process [...]

Introducti on 158 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Engine Sessio ns An iIS process engine genera lly coordinates the work of a number of applications that perform various activities that com prise a business process. To mana ge this process flow, the engine needs to maintain sessions with each of the applicat[...]

Introdu ction Chapter 6 M anaging P rocess Execut ion 159 An ACTIVE or SUSPENDED session can be term inated by an application or user, or by a system manage r. A RECONNECTION_IN_PROGRESS session can be suspende d or termin ated by a sys tem manage r. A session that has bee n termina ted is deleted from the engine and the engine ’ s current state [...]

Introducti on 160 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 If the client session reconnects to the engine during the timeout period, th e sessions are restored depending on the value of the sess ion ’ s reconne ct action pro perty (set using the cont rol parameter to WFEngin e.OpenSession or WF Session.SetControl) [...]

Introdu ction Chapter 6 M anaging P rocess Execut ion 161 If a connection is permanently lost, the client API code notifies the client applicatio n that its connection h as been permanently lost. The clien t application must explicitly reop en its session to restore it to ACTIVE st ate. Its ability to restore a suspen ded session to an ACTIVE state[...]

Introducti on 162 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Activity Stat es During process execution the engine manages a succession of activities through a number of states, from creation to deletion. While there are a number of activity types, each with its own properties and behavior (see “ Activity Types ” on[...]

Introdu ction Chapter 6 M anaging P rocess Execut ion 163 ACTIVE When a clien t applicatio n accepts an offered a ctivity or t akes it off a queue, it is pla ced in ACTIVE st ate. The e ngine pe rforms any wo rk specified b y an OnActiv e method in the pr ocess de finition a nd then provides t he client appl ication with proc ess att ribute dat a n[...]

Introducti on 164 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Figur e 6-1 Activ ity St ate Tran sition s — from Creation to Ter mination PENDING READY ACTIVE ABORTED COMPLETED Activity reference d by rou ter of anothe r activity Ready m ethod finish es Client accepts a ctivity Client completes or a borts activity Engi[...]

Process Execution Chapter 6 M anaging P rocess Execut ion 165 Activi ty T ypes A process definition ca n include a number of different activity types, each of which passes throug h the various activit y states in a diff erent fashion. The ta ble below summarizes the different types of activities. For more information on activities, see the iIS Pr o[...]

Process Exe cution 166 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Process instance execution Process execution involves creation of any number of activities, including one or more Offer ed activities (which are offered to and performed by client applications), Queued activities (which are placed on a queue and performe[...]

Process Execution Chapter 6 M anaging P rocess Execut ion 167 Process Instance Execution Process execution consists of the s equential creation, execution, and termination of the activities specified in a process defi nition. When an activity is created, it remains in a PEND ING state until its trigger cond itions are fulfilled. In general, the act[...]

Process Exe cution 168 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Activity Executio n As a general rule, activity executio n consists of taking each a ctivity through the series of states descr ibed in “ Acti vity Sta tes ” on p age 162 . In each state, the engine performs a number of o perations before the act ivi[...]

Process Execution Chapter 6 M anaging P rocess Execut ion 169 Session a ssignment takes place in any of the f ollowing situ ations: • An offered activity is pla ced in a READY state fo r the first time. • An offered activity i s rolled back from an ACTIVE state to a READY state — can occur if a client application rolls the activity back to RE[...]

Process Exe cution 170 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 READY State Handling When a Que ued activ ity i s pla ced i n a RE ADY s tate, the activity is placed in a queue n amed after the queued activity and containi ng activities with the same name from multiple process instances. Client applications access th[...]

Process Execution Chapter 6 M anaging P rocess Execut ion 171 ACTIVE State H andling T he engine performs any work specif ied in the OnActive method (if one exists in the process definition). An acti ve su bproce ss act ivi ty is handled differ ently depe nding o n whe ther the subprocess activit y is synchron ous or asynch ronous. • Synch ronous[...]

Process Exe cution 172 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Comp lete d Acti vities When an engine places an activity in a COMPLETED state, the engine performs the followi ng actions: • executes the activity ’ s OnComplete m ethod, if one is specified in the pro cess definition • executes the activity ’ s[...]

Monitor ing and M anaging Eng ine Session s Chapter 6 M anaging P rocess Execut ion 173 Process Inst ance Termin ation Process termination occurs when the engine places a process instance in either a COMPLETED state or an ABORTED state. Completed Process I nstances An engine completes a proc ess instance when the Last activity reaches a COMPLETED s[...]

Monito ring and M anaging E ngine Sessi ons 174 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Moni toring the Stat e of a Sessi on Often you want to know inf ormation a bout a parti cular sessio n, such a s its state, i ts creation time, the lis t of activities assig ned to the session, or i nformation about any such assi[...]

Monitor ing and M anaging Eng ine Session s Chapter 6 M anaging P rocess Execut ion 175 3. To get more informatio n about a ses sion, select it, and choose Sess ion > Open from the popup menu. An activity list for th e session is displayed. For each activity in th e list, the dialog displays th e activity ID, the process name and process in stan[...]

Monito ring and M anaging E ngine Sessi ons 176 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Managing Se ssions Session m anagement consists of suspending or terminating sess ions, or sending a message to one or mo re sessions (that is, the co rresponding client a pplications). Suspend ing or Termi natin g Sessions On oc[...]

Monitor ing and M anaging Eng ine Session s Chapter 6 M anaging P rocess Execut ion 177 ➤ To terminat e a session 1. Choose Monito r > Sessions to displ ay the Sessions window with t he list of current se ssions fo r the engine. 2. Select the session to terminate. 3. Right-cl ick and choose Sessi on ’ Name ’ > Terminate from the popup m[...]

Monito ring and M anaging E ngine Sessi ons 178 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 2. Open the session of interest. 3. Click Send Me ssage. The Se nd Message w indow displ ays: 4. Type the message in the Message field. 5. Select the urgency: Inform ational or Critical. 6. Click Sen d.[...]

Moni tor ing an d Ma nagi ng P roces s Ex ecut ion Chapter 6 M anaging P rocess Execut ion 179 ➤ To broadcast a message to all sessi ons 1. Choo se Mon ito r > Ses si ons to ope n the list of cu rren t se ssi ons. 2. Right-cl ick and choose Sessi on > Broadcas t from the popup menu. The Broadcast Message windo w displays. 3. Type the messa [...]

Monito ring and M anaging Pro cess Execut ion 180 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Figur e 6-2 Process Ex ecution Objec ts: Propert ies an d Relationships Using the iIS Con sole, you can display lis ts of these objects an d filter them according to specific criteria. You can also open and view the properties [...]

Moni tor ing an d Ma nagi ng P roces s Ex ecut ion Chapter 6 M anaging P rocess Execut ion 181 activity que ue Ch ecking the status of an activity queue and possibly reprioritizing an activi ty within the queue (fo r queued activities only). timer Checking the status of a timer insta nce and resetting it or changin g its state. process attr ibute C[...]

Monito ring and M anaging Pro cess Execut ion 182 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 3. Select the process name you want to view instances of and cho ose Processes > Open Inst ances of. This open s the Processes R esident win dow, displa ying the list of proce ss instances being executed by the engine for th[...]

Moni tor ing an d Ma nagi ng P roces s Ex ecut ion Chapter 6 M anaging P rocess Execut ion 183 5. Select a proces s instance and choose Process > Open Instance. The Process Instance property inspector is displayed. By selecting th e appropriate tab, you can g et the process inst ance ’ s activ ity list , timer list, process attribute list, a n[...]

Monito ring and M anaging Pro cess Execut ion 184 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Abortin g a Proce ss Instance If you want to stop execution of a process instance, you can abort that process instance. This abo rts all uncom pleted activities, stops all ti mers, and discard s all process attribute updates. ?[...]

Moni tor ing an d Ma nagi ng P roces s Ex ecut ion Chapter 6 M anaging P rocess Execut ion 185 Managing Act ivit y Insta nces This section d escribes how to ch eck the status of an activity and change its state . Checking the Status of an Activity 1. Select the activity in any w indow that contains an activity list: ❍ Process Instance property in[...]

Monito ring and M anaging Pro cess Execut ion 186 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 2. Choose Activ ities > Open. The Activity property inspector displays: The property inspector consists of a number of tabs: the Info tab displays the basic properties of the activity , and additional tabs provide informatio[...]

Moni tor ing an d Ma nagi ng P roces s Ex ecut ion Chapter 6 M anaging P rocess Execut ion 187 • from ACTIVE t o READY You might do this because the person wo rking on an activ ity cannot complete it and you want it to be reoffered to other users. All process attributes are unlocked and rolled back to the values they had when the activity was fir[...]

Monito ring and M anaging Pro cess Execut ion 188 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 3. From the New state drop list, select the new state of the activity. 4. Cli ck th e Set b utto n. Managing Act ivity Queues This section describes how to check the status of an acti vity queue and how to reprioritize an activ[...]

Moni tor ing an d Ma nagi ng P roces s Ex ecut ion Chapter 6 M anaging P rocess Execut ion 189 3. Select a queue. 4. Choose Queue > Open. The Activity Queues window displays, showing the list of activities in the queue. For each activity in th e queue, the window displays the acti vity name, activity ID, activity state, prioritizing value (value[...]

Monito ring and M anaging Pro cess Execut ion 190 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 3. Choose Activ ity > Set Priority. The Set Queued Activity Pri ority window displays: 4. In the New prioritizing value, change the value of the queue prioritizing process attribute. 5. Click OK. The activity w ill be placed[...]

Moni tor ing an d Ma nagi ng P roces s Ex ecut ion Chapter 6 M anaging P rocess Execut ion 191 Managing Ti mer Instances This section d escribes how to check the status of a timer, re set it, or change its state . Checking the Statu s of a Ti mer 1. Open the Timers tab of a Process Instance property inspector, shown below. For each timer, the list [...]

Monito ring and M anaging Pro cess Execut ion 192 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 3. Choose Timers > Open. The Timer property inspector displays, with the basic properties of the selected timer: Changin g the Timer St ate and Ex piration Tim e ➤ To cha nge the state a nd exp irati on tim e of a tim er 1[...]

Moni tor ing an d Ma nagi ng P roces s Ex ecut ion Chapter 6 M anaging P rocess Execut ion 193 3. To change the state of the timer, click one of the radio buttons in the On/Of f Control. 4. To change the expiration tim e, click one of the radio button s in the Options box. ❍ For an elapsed timer (screen sho wn above), Re set sets the origina l el[...]

Monito ring and M anaging Pro cess Execut ion 194 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 An example attribute list (the Process Attributes tab of a Process Instan ce property inspector) is shown below. For each process attribute the list displays the attribute name, data type, attribute value, and lock state. Chang[...]

Moni tor ing an d Ma nagi ng P roces s Ex ecut ion Chapter 6 M anaging P rocess Execut ion 195 ➤ To change the value of a process attri bute 1. Select the attribute in an y process attribute lis t window, as described in “ Checking th e Value and Lock State of a Process At tribute ” on page 193 . 2. Choose Process Attributes > Set. The ch [...]

Monito ring and M anaging Pro cess Execut ion 196 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Checking for Bottlenecks i n Process Execution Instance s of a given proce ss sometimes s tall at a parti cular activity, ca using a bottleneck in execution of that activity. This could happen, for example, if a particular acti[...]

Analyzing P rocess Execu tion Chapter 6 M anaging P rocess Execut ion 197 To analyze the si tuation further you mi ght have to open particular activi ty instances, check sessions, or possibly check attributes of the corresponding process instances. Analyzing Proces s Execution The iIS product does no t provide tools for an alyzing inform ation in t[...]

Analyzing P rocess Execu tion 198 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 • Worker productivi ty You can perform productivity analyses. For example, you can tabulate how many activities have been completed in a given time as a function of the session (user). You can als o look at how many activities are currently [...]

Monit oring and Managin g Two-Phas e Comm it Chapter 6 M anaging P rocess Execut ion 199 Monitor ing a nd Ma naging Two-Pha se Co mmit iIS provides a two-phase commit protocol that allows process client applications to easily synch ronize iIS process sta te changes with a pplication databa se updates. As illustrated in Fi gure 6-3 , process client [...]

Monito ring and M anaging T wo-Phase Commit 200 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Figur e 6-3 Client A pplications Cha nge Both iIS Process State a nd Applicat ion Data For example, a process client applicati on typically interact s with the engine to start an activity, performs the activit y by updating appli[...]

Monit oring and Managin g Two-Phas e Comm it Chapter 6 M anaging P rocess Execut ion 201 Because of this two-phase commit capa bility, an iIS engine tran saction and an applicatio n transaction ca n be combined into a high er level distributed transa ction. The constituent transactions are placed in a PREPARE phase before either can commit. If eith[...]

Monito ring and M anaging T wo-Phase Commit 202 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 The iIS two -phase commit protocol is i mplemented by placin g an engine s ession in two-phase commit mode. iIS engine transaction s for this session are automatically placed in a PREPARE phase. A session with two-phase commit en[...]

203 Chapter 7 Troubleshooting This chapter d iscusses a numbe r of topics and approaches related to diagnos ing problems in your iIS proce ss manageme nt system. This chapter covers th e following kinds of tro ubleshooting info rmation: • alarm s • exceptions • messa ges • performance indicators Introd uction iIS provides a number of tools [...]

Introducti on 204 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 The information d isplayed in these iIS tools falls into the follo wing categories: Alarms A number of error conditi ons in the functioning of an iIS proces s engine that might require your intervention are reported as alarms. These conditions range from a co[...]

Process Engine Al arms Windo w Chap ter 7 Troublesh ooting 205 Process Engine Alarms Windo w A number of engine condit ions result in an alarm. An alarm is a message noti fying you of a cond ition in the functio ning of an iIS process engin e that might require intervention. The follow ing list shows th ese alarms and a description of the condition[...]

Process E ngine Al arms Window 206 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Moni toring Alarms Alarms for any numb er of engines can be displayed in the Process Engine Alarm s window , allowing you to mo nitor all you r iIS pro cess engi nes from on e centra l location. (A larms can also be written to the engine data[...]

Process Engine Al arms Windo w Chap ter 7 Troublesh ooting 207 3. The Process Engine Alarms window displays. In the following illustration, a registered engine, ceengine, was shut down, causing the Engin eUnitShutdown al arm to be displayed. ➤ To unr egist er an en gine from the Al arm ser vice 1. Select an engi ne in the engine list in the right[...]

Process E ngine Al arms Window 208 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 You can add additional expressions to build complex filters. For example, the following expressions displays alarms of type EngineUnitShutdownAlarm for the engine named ceengine: Type="EngineUnitShutdownAlarm" Engine="ceengine&[...]

Process Engine Al arms Windo w Chap ter 7 Troublesh ooting 209 ➤ To get det ailed i nformatio n about an alarm 1. Select the alarm in the Process Engine Alarms window. 2. Right-click and choose Alarm > Open fro m the popup menu. The Alarm Details win dow displays: ➤ To remov e an alar m from the Alarm windo w 1. Select the alarm in the Alarm[...]

Engine L og Files 210 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Engine L og Files Each iIS process engine compo nent, like other iPlanet UDS partitions, writes to a log file that records exceptio ns and message ou tput. The component log files are therefore an important source of troubleshooting information. The log f[...]

Engi ne Lo g Fi les Chap ter 7 Troublesh ooting 211 Instru ment Dat a Yo u can decid e to have instru ment data — suc h as app licat ion reso urc e usa ge or per forma nce s tati stic s — collected by the underlying system fo r an engine com ponent and written to the partition log f ile at time intervals you can specify. The l ogging of ins tru[...]

iIS Con sole Tr ace Window 212 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 4. Click the View Partition Log button. iIS Console Trace Window iIS Console provid es a trace window tha t displays in formation written to iIS engine compon ent log files. This in formation cons ists of output log ged by engine components when [...]

iIS Consol e Trace Window Chap ter 7 Troublesh ooting 213 This section discusses how to use the iIS Console Trace window to select an d display messages generated by iIS engine components. Specifyin g Message Filters The syntax for specifying log message filte rs is shown in Fi gure 7-1 . Genera lly you specify a standard output log file , “ %std[...]

iIS Con sole Tr ace Window 214 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 iIS Message F ilters iIS messag e filters follow the general guid elines above and have th e following particularities : Message type trc (debug) Service type cr (iIS runtime) Group number iIS uses the followin g group designat ions: Level number[...]

iIS Consol e Trace Window Chap ter 7 Troublesh ooting 215 For example, an iIS message filter for a prim ary engine unit might be as follo ws: FORTE_LOGGER_SETUP: "%stdout(trc:cr:2: 2)" This filter specifies that a ll messages about sessions created in the engine — but not a lot of detail — be written to the primary engine unit ’ s l[...]

iIS Con sole Tr ace Window 216 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 ➤ To set message f ilters for a selected e ngine 1. Select a runnin g engine in the iIS Conso le main window. 2. Choose Engine > Trace. The iIS Console Tra ce window displays. 3. Choose File > Modi fy Log Flags. This opens th e Select Com[...]

iIS C onsole En gine Even t Filter Window Chap ter 7 Troublesh ooting 217 All messages generated by the component that meet the specification are now written to the trace windo w, as well as to the components log file. Special Example: Write Client Messag es to Trace Window As an example of using message filters, suppose you want to have all messag[...]

iIS Con sole Engin e Event Fi lter Wind ow 218 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Engine Event Types iIS Console engine event types consist of: • time r stat e chan ges (on /off/ value chang e) • session events (start, suspend, terminate) • acti vity s tate change s • process events (start, termin ate, [...]

iIS C onsole En gine Even t Filter Window Chap ter 7 Troublesh ooting 219 Displ ayin g All Engi ne Events You can view all engine events for a running engine. ➤ To vie w all engine event s for the selected eng ine 1. From the Engine Event Filter win dow, select the option Show all engine events. Each engine event is identified by event type, clas[...]

iIS Con sole Engin e Event Fi lter Wind ow 220 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Events for the specified process instance display: ➤ To view all engine events for the next pr ocess instance of a specific p rocess definitio n 1. From the Engin e Event Filter window, select the optio n Next process instance o[...]

Per for mance Cha rts Chap ter 7 Troublesh ooting 221 Filtering Engine Events A fourth way to view engin e events is by providing a custom filt er. You can filter on events in volving se ssions, process instances, activities, eng ine objects, ti mers and registrations. For deta ils on valid filter expressions, s ee “ CreateFilter ” on page 279 [...]

Perform ance Ch arts 222 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 It is therefore a good idea to regularly monitor a number of performance indicators — i nstrumentat ion within an engin e that can be displayed over tim e in the iIS Console Performance Charts. The instruments displayed in the Performance Charts are [...]

Per for mance Cha rts Chap ter 7 Troublesh ooting 223 ➤ To view performance indicato rs for an engine 1. Select a runnin g engine in the iIS Conso le main window. 2. Choose Monitor > Performance. The Performance Charts window is displayed. You can choose View > Observed Values to expand the Charts window to display maximum, last obser ved ,[...]

Perform ance Ch arts 224 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 4. To set the vertical scale parameters for the char t and see the maximum and minimum values recorded by this chart, click somewhere in the chart, then right-click and cho ose Chart > Prop erties from the popup menu. The Timeline Properties window [...]

Per for mance Cha rts Chap ter 7 Troublesh ooting 225 Logging Pe rforman ce Informat ion You can save perfo rmance informatio n to a log file. ➤ To log pe rformance i nfor mation 1. At the Performance Charts window, choose File > Set Logging File. 2. Define a name and lo cation for the performance lo g data file. 3. Click OK. 4. Choose File &g[...]

Perform ance Ch arts 226 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1[...]

227 Chapter 8 Using the Conductor Script Utility This chapter describes the Conductor Script utility, the iIS command line system managem ent inter face. The Conductor Script utility is the command lin e equivalent of the iIS Co nsole. However, Condu ctor Script al so lets you inco rporate system man agement task s into scripts. Th ese scripts can [...]

Starting C onductor Scri pt 228 iPlan et Integra tion Serv er • Process System Gu ide • August 2001 Unlike the iIS Console, however, you can use Conductor Script to perform system management by building and executin g predefined scripts of Conductor Script commands. For in formation on buil ding and executing Conducto r Script scripts, see “ [...]

Star tin g Cond uct or Scr ipt Chapter 8 Using the Conductor Script Utility 229 ➤ To start Conducto r Script on U NIX, OpenVMS, or Windows N T 1. Use the cscript command (see “ Using the Cscript Com mand ” below for informatio n). 2. Enter a valid passwo rd if one is requested (see “ SetPassw ord ” on page 3 00 ). When Conductor Script st[...]

Working with Condu ctor Scrip t 230 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Working wit h Conducto r Script Conductor Script is a command line utility built o n top of the iPlanet UDS Fscript command utility . As such, it includes Fscript com mands for performing repository-based o perations, as well as a large n um[...]

Wor king wit h Cond ucto r Scr ipt Chapter 8 Using the Conductor Script Utility 231 For full reference documen tation of the commands discussed below, consult the Fscript Refe rence Guide . General Conducto r Script Operat ions The following table lists Conductor Scr ipt commands used for general operations such as getting onli ne help, defining th[...]

Working with Condu ctor Scrip t 232 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Writing and Executi ng Scripts This section describes Conduct or Script commands you use to write and execute scripts to automa te iIS process management tasks. Fo r full reference documentation of the commands, consult the Fscript Refere nc[...]

Wor king wit h Cond ucto r Scr ipt Chapter 8 Using the Conductor Script Utility 233 The follow ing tabl e lists Condu ctor Script commands m ost often u sed for wr iting and e xecut ing scrip ts: Operating Syste m and Fil e Mana gement Commands The following table lists Conductor Script commands for interacting with the operating system o n a node [...]

Working with Condu ctor Scrip t 234 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 CopyFile file1_name file2_name [r] Copy a specifie d file in the lo cal file syst em. Cp file1_name file2_name [r] Copy a specifie d file in the lo cal file syst em. Directory directory_name L ist the fi les in a di rectory. Duplicate file1_[...]

Manag in g iIS P roce ss En gine s wi th Co nduct or Sc ript Chapter 8 Using the Conductor Script Utility 235 Managing iIS Process Engines with Conductor Scr ipt This section d escribes how to perfo rm the following en gine manageme nt functions using Conductor Scrip t: • starting an engine • monitor ing an eng ine • changing engine component[...]

Managi ng iIS Proc ess Engine s with Con ductor Sc ript 236 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Starti ng Indi vidual En gine C ompone nts You can star t an individual en gine componen t on any node on which it i s installed. Each component is an application consisting of a single server partition that must esta[...]

Manag in g iIS P roce ss En gine s wi th Co nduct or Sc ript Chapter 8 Using the Conductor Script Utility 237 The Conductor Script commands used to start engines are documented in Appendix A, “ Conductor Script Commands ” and summarized in th e following table: Command Arguments Function See … ListEngines —— Displa y a lis t of all r unni[...]

Managi ng iIS Proc ess Engine s with Con ductor Sc ript 238 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 As indicated in the table, the engine unit partitio n has a startup argum ent which specifies that when the engine unit comes ONLINE, that it create the required tables in the engine database. This a rgument should be[...]

Manag in g iIS P roce ss En gine s wi th Co nduct or Sc ript Chapter 8 Using the Conductor Script Utility 239 The following Conductor Script commands start up the Enterprise engine in the preferred order. Monitorin g Engine s and Engine Component s After you have sta rted an engine, y ou should ensure that it h as started successf ully and monitor [...]

Managi ng iIS Proc ess Engine s with Con ductor Sc ript 240 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 The Conductor Script commands used to monitor engines are documented in Appendix A, “ Conductor Script Commands ” and summariz ed in the followin g table: Monitor ing In dividua l Engine Compo nents You can get m [...]

Manag in g iIS P roce ss En gine s wi th Co nduct or Sc ript Chapter 8 Using the Conductor Script Utility 241 The Conductor Script commands used to monitor individual engine components are documented in Appen dix A, “ Conductor Script Commands ” and summ arized in the followi ng table: Command Arguments Function S ee … FindEngine engine_name [...]

Managi ng iIS Proc ess Engine s with Con ductor Sc ript 242 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Changing Eng ine States You can change the state of an engine by changing th e state of an engine unit or by shutting down an engine component. Changin g Engine Un it States You might w ant to change the s tate of an [...]

Manag ing Regis tra tion s wi th Co nduct or Sc ript Chapter 8 Using the Conductor Script Utility 243 Shut ting Down Eng ine Com ponen ts You can shut down an individual component or all engine components using the Shutdown command. This command shuts down the current component or engine. If your engine components are standard iPlanet UDS pa rtitio[...]

Managi ng Regis trations w ith Conducto r Script 244 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 ➤ To make an iI S library di stributi on 1. Use the SetWorkspace command to make a particular workspace current. 2. Use the Open command to open the current workspace. 3. Use the ListPlans command to d isplay iIS plan s in[...]

Manag ing Regis tra tion s wi th Co nduct or Sc ript Chapter 8 Using the Conductor Script Utility 245 AddSupplierPlan plan_name I nclud e a plan a s a supplier plan to the current plan. Commit —— Commit changes to current works pace. CompilePlan [force_flag] compile al l out-of-date componen ts in a plan. ExportPlan file_name [node | ids] Expor[...]

Managi ng Regis trations w ith Conducto r Script 246 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Registerin g iIS Library Di stribut ions After iIS library distributions have been generated, they can be re gistered with iIS process engines. You can register any number of iIS distributions with an engine using Conductor [...]

Manag ing Regis tra tion s wi th Co nduct or Sc ript Chapter 8 Using the Conductor Script Utility 247 Unregisterin g iIS Li brary Distri butions Normally you un register an iIS distributio n from an engin e if it is no longer needed. Cold-starti ng an engine unregis ters all registrations; h owever, if you wa nt to be more selective, you can unreg [...]

Managi ng Regis trations w ith Conducto r Script 248 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 ➤ To unregis ter an iI S distribution f rom an engine 1. Use the FindEngine command to make a particular engine current. 2. Use the ListRegist rations command to di splay a list of i IS distributions that are registered wi[...]

Managi ng Process E xecution w ith Condu ctor Scrip t Chapter 8 Using the Conductor Script Utility 249 Managing Process Execution with Conductor Scr ipt This sec tion des cri bes how to per for m some ba sic m oni tori ng a nd man ageme nt of process execution using Conductor Script. Normally these operations are more suited to iIS Console than to [...]

Managi ng Process E xecution w ith Conduc tor Script 250 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Monitorin g and Managin g Engine Sessions This section describes h ow to perform a number of tasks regarding the mo nitoring and mana ging of sessio ns: • obtainin g state informa tion about a sess ion • suspending o[...]

Managi ng Process E xecution w ith Condu ctor Scrip t Chapter 8 Using the Conductor Script Utility 251 The commands needed to monitor and m anage iIS sessions are documented in Appendix A, “ Conductor Script Commands ” and summarized in the table below: Command Arguments Function S ee … BroadcastMessage message_text priority Send a m essage w[...]

Managi ng Process E xecution w ith Conduc tor Script 252 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Monitorin g and Managing Proces s Execution There are a number of situations where you are likely to want to monitor or intervene in pro cess execution to resolve problems . Depending on the sit uation, you might wish to[...]

Managi ng Process E xecution w ith Condu ctor Scrip t Chapter 8 Using the Conductor Script Utility 253 5. Use the ShowActivity command to display inform ation ab out a par ticula r act ivity . The output show s information ab out the activity, its a ttributes and its linked timers. You can get further information about these objects using their cor[...]

Managi ng Process E xecution w ith Conduc tor Script 254 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Managi ng T imers ➤ To check t he status of a t imer 1. Use the FindEngine command to make a particular engine current. 2. Use the ListTimers command to display a list of timers in the current engine. 3. Use the Create[...]

Managi ng Process E xecution w ith Condu ctor Scrip t Chapter 8 Using the Conductor Script Utility 255 ➤ To change the value of a process attri bute 1. Display a list o f attributes as described in Step 1 through Step 4 above. 2. Use the SetAttributeValue co mmand to set the value of any listed pro cess attrib ute. ➤ To re move an a ttribu te l[...]

Managi ng Process E xecution w ith Conduc tor Script 256 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 The commands needed to intervene in execution of an iIS process instance are documented in Appendix A, “ Conductor Script Commands ” an d summariz ed in the table below: Command Arguments Function See … AbortActivi[...]

Managi ng Process E xecution w ith Condu ctor Scrip t Chapter 8 Using the Conductor Script Utility 257 ListFilters —— List a ll existin g event fi lters f or the curre nt e ngi ne. page 289 ListProcesses [short], [name process_name] List process i nstance s for a specified pro cess ( or al l pro cess i nstan ces) i n the current engine, or list[...]

Managi ng Process E xecution w ith Conduc tor Script 258 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Monitorin g and Managin g Two-Phase Co mmit Transac tions The iIS two-pha se commit protocol fa cilitates the synchro nization of iIS process engine operatio ns with applicat ion transactio ns by making it possibl e to p[...]

Managi ng Process E xecution w ith Condu ctor Scrip t Chapter 8 Using the Conductor Script Utility 259 Managi ng Two- Phase Commit Op eratio ns If a session should be su spended for any of a number of reasons, any iIS e ngine transaction in a PREPARE phase is retained on the sessio n, awaiting res olution (commit or rollback). The process client ap[...]

Managi ng Process E xecution w ith Conduc tor Script 260 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 ➤ To resolv e transact ions after a client or engine fa ilure 1. Start Conducto r Script from a command line an d invoke ListTransactions . cscript >ListTransactions The output of this command identifies all session[...]

261 Appendix A Conducto r Script Commands This appendix is an alphabetically ordered referen ce of the Conductor Script commands. Conductor Script is a command line utility built on top of the iPlanet UDS Fscript command utility . As such, it includes Fscript com mands for performing repository-based o perations, as well as a large n umber of iIS-s[...]

Conduct or Script Comma nd Summary 262 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Figur e A-1 Hierar chy of Conduc tor Sc ript L evels Each Conductor Script command is de fined on one of these levels. To use a command, you navigate the hierarchy, making either an engine or an engine component “ current, ” and then [...]

Conduc tor Script Command Summar y Appen dix A Conducto r Script C ommands 263 Environment Mode Command s The Conductor Script environment mode commands work only in the active environment. They are used mostly to specify the current engine and current node, and also to make library distributions that can be registered with iIS process engines. Com[...]

Conduct or Script Comma nd Summary 264 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Engine Mode Commands: Engine Mana gement The Conductor Script engine mode commands work only for the current engine. They are used mostly to start components and specify the current component. SetPassword [old_password] [new_password] Set[...]

Conduc tor Script Command Summar y Appen dix A Conducto r Script C ommands 265 FindNode node_name S et the spe cified n ode as the “ current ” nod e. Th e node must exist in the environme nt. page 285 FindPrimary —— Set th e primary engin e unit for t he curren t engine a s the cur rent component. The primar y unit must be ONLINE . page 285[...]

Conduct or Script Comma nd Summary 266 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Engine Mode Commands: Process Execution Mana gement There are a large number of Conductor Script commands that let you monitor and manage sessio ns, process execution, and registration — func tion s per formed b y the primary engine u n[...]

Conduc tor Script Command Summar y Appen dix A Conducto r Script C ommands 267 Command Argument s Function See … AbortActivity process_id, activity_name Place the specified a ctivity in t he ABORTED stat e. page 273 AbortAllProcesses —— Abor t all process instance s in the current engine. page 274 AbortProcess process_id A bort the specified [...]

Conduct or Script Comma nd Summary 268 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 DelegateActivity process_id, activity_id state delegation_rule [user_name] [other_info] Delegate the specified offered activi ty (in th e specif ied st ate) to other users using the specified delegation a ssignment rule. The user name and[...]

Conduc tor Script Command Summar y Appen dix A Conducto r Script C ommands 269 ReadyActivity process_id, activity_name Change the st ate of the s pecified activi ty from PEN DING to READY. page 293 RegisterAlias alias_name, process_name, engine_name, environment Register the a lias — repres enting a specified pro cess runnin g on a specified en g[...]

Conduct or Script Comma nd Summary 270 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 SetQueuedActivity Priority process_id, activity_id prioritizing_value Repr ioritize activiti es in an act ivity queue by setting t he prioritizing process attribute for a specified activity to a spec ified value. page 301 SetTimer process[...]

Conduc tor Script Command Summar y Appen dix A Conducto r Script C ommands 271 Component Mode Command s The Conductor Script engine component mode commands work only for the current component. SuspendAllSessions —— Susp end all active ses sions in the current engine. page 319 SuspendSession session_id Sus pend the specifi ed active session. pag[...]

Conduct or Script Comma nd Summary 272 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Generi c componen t A few commands work for an y current component. Engin e Un it One command ap plies only if the current com ponent is an engi ne unit. Command Parameters Function See … ShowStatus [short] Display the sta tus of the cu[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 273 Conductor Script Com mands The following is a listing of all Cond uctor Script commands. AbortActiv ity The AbortActivity command aborts the specifie d activity, placing it in the ABORTED s tate. AbortActivity process_id activity_name The Abo rtActivity co m ma n d i s o nl [...]

Conduct or Script Comma nds 274 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 AbortAllProcesses The AbortAllProcesses co mmand abort s all pr ocess ins tances f or the curren t engine. AbortAllProcesses The AbortAllProcesses com mand is only a vailable for the current en gine. Use the FindEngine Script command to set the [...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 275 BroadcastMessag e The BroadcastMessage command send s a message to all active se ssions on the current engine. BroadcastMessage message urgency The Broa dcastMessage command is only ava ilable when an engine is current. Use the FindEngine Script command to set the current en[...]

Conduct or Script Comma nds 276 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 CompleteA ctivity The CompleteActivity command completes the specified activity, putting it in COMPLETED state. CompleteActivity process_id activity_n ame The Com pleteActivity command is only ava ilable when an engine is current. Use the FindEn[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 277 ConsultActivity process_id activity_id state consultation_rule return_rule [user_name1 [other_info1] [user_name2 [other_info2]]] The ConsultActivity command is only available when a n engine is current. Use the FindEngine Script command to set the current engine. The Consult[...]

Conduct or Script Comma nds 278 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 The user_name1 a nd other_info1 argumen ts must be supplied if required by th e consultation assignment rule. For example, if a co nsultation rule nam ed “ Manage rOf ” looks for the ma nager of the user who is handing o ff to a consult ant,[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 279 CreateFil ter The CreateFilter command creates a filter for events posted on the curren t engine object. CreateFilter time_interval filter_expr ession The CreateFilter command is only a vailable when an engi ne is current. Use the FindEngine Script command to set the current[...]

Conduct or Script Comma nds 280 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Object Class Object Instance This element specifies a particular instance ide ntification, if desired — for example, a se ssi on name , ac tiv ity n ame, or pr ocess ID. Operat ors The table below shows the different operato rs that can be use[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 281 Exam ples Some example filter expressions follow: When the CreateFilter command sets up the filter as specified, events that satisfy the filter expression are printed to the screen. DelegateAct ivity The DelegateActivity command delegates the specified offered activity to ot[...]

Conduct or Script Comma nds 282 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 The Del egateActivity command is only ava ilable when an engine is current. Use the FindEngine Script command to set the current engine. The DelegateActivity command is used to hand off the work asso ciated with an offered activity to someone el[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 283 DeleteFilter The DeleteFilter command deletes the s pecified event filter in the current engine. DeleteFilter filter_id The DeleteFilter command is available only when an engine is current, so you must first use the FindEngine Script command to set the current engine. You ca[...]

Conduct or Script Comma nds 284 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 FindEng ine The FindEngine command sets th e specified engine as the current engin e. FindEngine engine_name The FindEngine command is always available. The specified engine nee d not be running. You can use the ListEngines Script command to dis[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 285 Find Node The FindNode command sets the specified node as the current node. FindNode node_name The FindNode command is avai lable only for the current engine. The FindNode command is normally used to start engine components (using the StartGovernor , StartDBService , and Sta[...]

Conduct or Script Comma nds 286 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 The FindPrimary command is normally used to check the status of the primary engine unit (using the ShowStatus Script comma nd), to change its state (using the SetState and Shutdown Script commands), and to perform process execution and engine d [...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 287 IIOPSe rver The IIOPServer command starts, stops, or displays info rmation about the IIOP service needed to support CORBA/IIOP iIS process client applications. IIOPServer [start|stop|show] The IIOPServer command is always availa ble. The IIOPServer command is used to start u[...]

Conduct or Script Comma nds 288 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 The ListActivityQueues command displays all a ctivity queues in a specif ied process definition. For each queue the ListActivityQueues comman d displays the process name and the queue name. ListConduc torDistribut ions The ListConductorDistribut[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 289 ListEn gines The ListEngines command displays a list of all running an d configured engin es in the current environment. ListEngines The ListEngines command is always availa ble. The list display ed includes all configu red engines, indicatin g engines that are ONLINE. It al[...]

Conduct or Script Comma nds 290 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Options • If you use the short opti on, t he com mand dis plays a summa ry of proce ss instances by pro cess defini tion. • If you use the name option, the comm and displays all process insta nces for the specified registered process d efini[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 291 ListSessio ns The ListSessions command displays all sessions ma intained by the current engine. ListSessions The ListSessions command is available only when an engine is current, so you must first use the FindEngine Script command to set the current engine. For any given ses[...]

Conduct or Script Comma nds 292 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 MakeConducto rDistribut ion The MakeConductorDistribution command generates a library distribution for the current plan. The plan must be crea ted in the iIS process development worksh ops. MakeConductorDistribution The MakeConductorDistribution[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 293 To start loggi ng, use the ’ + ’ followed by a set of message filte rs in parenthese s. To stop loggin g, use the ’ - ’ follo wed by a set of me ssage filt ers in parenthe ses. The settings specified with the ModLogFlags command modify the log message filters that we[...]

Conduct or Script Comma nds 294 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 RegisterAl ias The RegisterAlias command register s the specified subpro cess alias in the current e ngine ’ s regist ration database. Fo r more informati on on aliases, see “ About Aliases ” on page 143 . RegisterAlias alias_name process_[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 295 Use the ListConductorDistribution s Script command to dis play a list of distributions av ailable for registration (yo u can filter the list for as signment rule dictionaries). The RegisterAssignmentRules com mand regi sters an assi gnment rule dictionary on ly if a dictiona[...]

Conduct or Script Comma nds 296 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 The RegisterUserProfile command is available only w hen an engine is current, so you must first use the FindEngine Script command to set the current engine. Use the ListConductorDistribution s Script command to dis play a list of distributions a[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 297 RemoveReadLock The RemoveReadLock command removes a read lock on the specif ied process attrib ute. RemoveReadLock process_id attribute_na me The RemoveReadLock comma nd is available only when an engine is current, so you must first use the FindEngine Script command to set t[...]

Conduct or Script Comma nds 298 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 RollbackActivi ty The RollbackActivity command changes the state of the specified a ctivity from ACTIVE to READY. RollbackActivity process_id activity_n ame The RollbackActivity command is available only when an engine is current, so you must fi[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 299 RollbackTransaction { session_ID | tran saction_ID } To commit an in -progress iIS engine transaction , use the CommitTr ansaction command. To list all in -progress iIS engine transaction s for a given engine, use the ListTransactions comman d. SendMessage The SendMessage co[...]

Conduct or Script Comma nds 300 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 SetAttributeValu e The SetAttribu teValue command sets a specified process attribu te in the current engine to a specified value. SetAttributeValue process_id attribute _name attribute_type value The SetAttributeValue command is available only w[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 301 You can use the SetPassword Script comman d to se t a passwor d, change an existing password to a new password, or delete an existing password. SetPrimary The SetPrimary command sets th e specified engine unit for the current engin e as the primary uni t. SetPrimary unit_nam[...]

Conduct or Script Comma nds 302 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 The SetQueuedActivityPriority command is available on ly when an engine is current, so you must first use the FindEngine Script co mmand to set the current engine. The SetQueuedActivityPriority command lets yo u change the orderin g of activitie[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 303 The SetTimer command is ava ilable only when an engine is current, so you must first use the FindEngine Script command to set the current engin e. You can use the SetTimer comm and to turn any timer on or off, to reset a n elapsed timer to its origina l time interval, or to [...]

Conduct or Script Comma nds 304 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 SetTimerElapse d The SetTimerElapsed command sets the specified elapsed timer to th e specified state (ON, O FF, or no cha nge) and sets a new el apsed time in terval until expira tion. SetTimerElapsed process_id timer_name state time_interval T[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 305 The ShowActivity command displa ys the following in formation : • acti vity n ame • act ivity ID • process name • process ID • act ivity sta te • ac tivi ty ty pe • applicatio n description • list of sessi ons for which a ctivity is on sess ion activity list,[...]

Conduct or Script Comma nds 306 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 The ShowActivityQueue comman d displays a list of activities in the queue, if any, or of sessions wa iting for a queued activity if no activities are in the queue. For each activity in the queue, the ShowActivityQueue command displays th e follo[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 307 You can use the ListEngines Script comma nd to display a li st of engines in the environment before selecting the engine to display. ShowLogFlags The ShowLogFlags command displa ys the log messag e filters (log flags) f or the current component. ShowLogFlags The ShowLogFlags[...]

Conduct or Script Comma nds 308 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 • list of activities , displaying activity n ame, activity ID, process ID, activi ty state (as in ListAc tivities Script comm and) • list of timers, displaying tim er name, process ID, state, type, expiration time and date (as in ListTimers [...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 309 • user • user ’ s role s • list of active attrib ute accessors You can use the ListSessions Script comm and to display a li st of sessions in the engine before selecting th e session to display. ShowStatus The ShowStatus command displays status information for the cu[...]

Conduct or Script Comma nds 310 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 engine unit: (See also “ primary en gine unit : ” on pa ge 311 .) • unit name • unit state: ONLINE or STANDB Y • shell state: IDLE, TOKEN_REQ UESTED (negotiating with partner), or CONNECTED • governor channel: OP EN or CLOSED • par[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 311 primary engi ne unit: • unit name • startup phase (if not ONLINE) • unit state: ONLINE or STANDBY • shell state: IDLE, TOKEN_REQ UESTED (negotiating with partner), or CONNECTED • governor channel: OP EN or CLOSED • par tner ch annel : OP EN or CLOSE D • ping in[...]

Conduct or Script Comma nds 312 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 ActiveActivities Number of current AC TIVE activities CurrentA ctivities Number of cu rrent a ctivities = P endingAct ivities + ReadyActiv ities + Activ eActiviti es CompletedAc tivities Number of complet ed acti vities (te rminated) s ince engi[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 313 ShowTimer The ShowTimer command displays the properti es of the specified timer. ShowTimer process_id timer_name The ShowTimer command is available o nly when an eng ine is current, so you must first use the FindEngine Script command to set the current engin e. The ShowTimer[...]

Conduct or Script Comma nds 314 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Shutdown The Shutdown command shuts down the curre nt engine or one of its individual components. Shutdown The Shutdown command is availa ble only when the engin e is current or if an engine component is current. Use the FindEngin e Script comma[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 315 In the case of offered a nd queued activities, which are perfo rmed by client applicatio ns, the engine w ill assig n the ACTIVE act ivity to th e session specif ied by the session_id parameter. In the case of Automatic or SubProcess activities, which are not directly perfor[...]

Conduct or Script Comma nds 316 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 The StartEngine comm and incl udes a n umber o f start op tions th at creat e new engine database tables: The newLog , newState , a nd newRegistration options are independent, except that you cannot create new registration tables without also cr[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 317 The StartGovernor command reads the memory flag setting for governor specified in the engine con figuration file (see “ Engine Co nfigurat ion File ” on page 90 and Step 10 under “ How to Confi gure a New Engine ” on page 95 ). The ShowStatus Script command — or th[...]

Conduct or Script Comma nds 318 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 The StartUnit command includes the f ollowing star t options that create new engine database tables: The newLog , newState , a nd newRegistration options are independent, except that you cannot create new registration tables without also creatin[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 319 StopTimer The StopTimer command changes the state of th e specified timer from ON to OFF. StopTimer process_id timer_name The StopTimer command is available o nly when an eng ine is current, so you must first use the FindEngine Script command to set the current engin e. The [...]

Conduct or Script Comma nds 320 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 SuspendSession The SuspendSession command suspends the s pecified active session, or sessions, in the current engine. SuspendSession session_id [ session_id … ] The SuspendSession comma nd is available only wh en an engine is current, so you m[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 321 The engine posts a Ses sionTerminated event on each session before it is terminated, so that the respective client applications can take appro priate action. The effect of terminating a sessio n on any ACTIVE activiti es is to place the activities back in READ Y state. Termi[...]

Conduct or Script Comma nds 322 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 The Uninstall command is a lways available. The Uninstall command is normally performed to cle an up the environment repository after unregi stering an iIS distribut ion from all engines in a n environment. UnRegisterAl ias The UnRegisterAlias c[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 323 The UnRegisterAssignmentRules command is available on ly when an engine is current, so you must first use the FindEngine Script command to set the current engine. Use the ListRegistrations S cript command to display a list of com ponents registered with th e current engine ([...]

Conduct or Script Comma nds 324 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 UnRegisterUserProf ile The UnRegisterUserProfile command deletes the specified user profile from the current engine ’ s registration da tabase. UnRegisterUserProfile user_profile_name The UnRegisterUserProfile command is available only w hen a[...]

Cond ucto r Scr ipt C omm ands Appen dix A Conducto r Script C ommands 325 The WaitForStartup command is avai lable only when an engine is current, so you must first use th e FindEngine S cript command to set the current engin e. In a script, the WaitForStartu p command is used after a Start Unit Script command. The WaitForStartu p command causes t[...]

Conduct or Script Comma nds 326 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1[...]

327 Appendix B Engine Database Schema This appendix documents the engine database schema. It lists the data base tables and the specificatio n of each, according to th e following categori es: • current state tables • registration tables • his tor y log t abl es The tables are grouped first by category, and then alphabetically within each cat[...]

Dat abase Tabl es by Cate gory 328 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 WFHPro cParamet ers WFHTerminatedProcs WFHTermProcPa ras WFHA ctiv ity WF HActi vityL og* WFHActStateLog* WFHQueuedActivity WFHRoleBasedA ct WFH Activ ity Toke ns WFH Activ ity User s WFHAssign ment WFHSession WFH SessionLog * WFHSessionRol e[...]

Alphab etical Listi ng of Tabl es Appen dix B Engin e Database Schema 329 Alphabet ical Listin g of Tables The following is an alphabetical list of all tables created in the engine data base, with a page reference to deta ils about each. Ta b l e B - 1 Engine Databa se Tab les Database Table See … Description WFHActiveTimer page 332 Active timers[...]

Alphabet ical Lis ting of Tab les 330 iPlan et Integra tion Serv er • Process System Gu ide • August 2001 WFHControl page 337 System maintain ed table o f sequence values for producing u nique ID s for proces s, sessi on, and timer in stances . WFHLocks page 337 The type of access h eld on all i nstances of process attr ibutes. WFHP erfor man c[...]

Database S chema Ref erence Appen dix B Engin e Database Schema 331 Database Schem a Refere nce This section provides an annotated description of all the ta bles created and maintained by a n iIS process engine. The iIS process engine automaticall y creates these tables when the engine is cold started and maintain their contents during normal opera[...]

Database S chema Ref erence 332 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Current Stat e Tables The following is an alphabetica l list of all current state ta bles in the engine database. Indexes to tables are indicated by a checkma rk ( ✔ ) in the Index column. In some cases, a table has an alt ernate index, indica[...]

Database S chema Ref erence Appen dix B Engin e Database Schema 333 TYPE NUMBER(38) Type of activity: 1 – F irst acti vity 2 – Last act ivity 3 – O ffered activ ity 4 – Su bproc ess act ivity 5 – Automatic activi ty 6 – Queu ed ac tivi ty 7 – Junction ac tivity Note: The se consta nt values a re intern al to the en gine on ly. You sh [...]

Database S chema Ref erence 334 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 ACTN AME VAR CHA R2(6 4) The na me o f the act ivity in the p roce ss definition. ABORTRACTION NU MBER(38) A bort routing information. Internal use only. WUSER VARCHAR2(64) The “ LinkedUser ” in formation pa ssed into this acti vity by it s [...]

Database S chema Ref erence Appen dix B Engin e Database Schema 335 Ta b l e B - 4 WFHActivityTokens Name Index Nu ll? Type Description PROCESSID ✔ NOT NULL NUMBER(38) Unique identif ier for the process insta nce in whic h this a ctivit y instan ce occur s. ACTIVITYID ✔ NOT NULL NUMBER(38) Unique identifier for a pend ing activit y instance w i[...]

Database S chema Ref erence 336 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Ta b l e B - 6 WFHAssign ment Name Index Nu ll? Type Description PROCESSID ✔ NOT NULL NUMBER(38) Unique identif ier for the process inst ance in whic h this a ctivit y instan ce occur s. ACTIVITYID ✔ NOT NULL NUMBER (38) Iden tifier fo r the[...]

Database S chema Ref erence Appen dix B Engin e Database Schema 337 Ta b l e B - 8 WFHComplexRule Name Index Nu ll? Type Description PROCESSID ✔ NUMBER(3 8) Unique identifier for the process instance in whic h this a ctivit y instan ce occur s. ACTIVITYID ✔ NU MBER(38) Id entifi er for the act ivity in stance in th e process in stance d esignat[...]

Database S chema Ref erence 338 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 LOCKTYPE NUMBER(38) Type of access to t he process attribute: 1 – WFAttributeAcces sor.READ 2 – WFAttributeAcces sor.READQ 3 – WFAttributeAccessor. WRITE 4 – W FAttribute Accessor.WRI TEQ 5 – WFAttributeAccess or.NO_LOCK ACCESSORID ✔[...]

Database S chema Ref erence Appen dix B Engin e Database Schema 339 Ta b l e B - 1 2 WFHProcess Name Index Nu ll? Type Description ID ✔ NOT NULL NUMBER(38) Unique identif ier for the process insta nce in this engi ne. TYPE NUMBER(38) Type of process (means of process creation): 1 – Process 2 – Subprocess STATE NUMBER(38) State of the proc ess[...]

Database S chema Ref erence 340 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 NEXTACTIVITYID NUMBER(38) S equence for t he next activity i nstance within t his pr ocess inst ance. INTERNALNAME VARCHAR2(138) Internal use only. PROCNAME VARCHAR2(64) The name of the process definition of which thi s runnin g process is an in[...]

Database S chema Ref erence Appen dix B Engin e Database Schema 341 Ta b l e B - 1 3 WFHPro cParamet ers Name Index Nu ll? Type Description PROCESSID ✔ NOT NULL NUMBER(38) The P ROCESSID of a synchronous subproc ess that has an output parameter. ATTNAME VARCHAR 2(64) The name o f a process attrib ute that must be returned to the c alling pr ocess[...]

Database S chema Ref erence 342 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Ta b l e B - 1 6 WFHRetryInfo Name Index Nu ll? Type Description GROUPID ✔ NOT NULL NUMBER(38) Identifier for the s ession between the engine and clien t. SEQNUMBER NOT NULL NUMBER( 38) Iden tifier fo r the retry attempt. PROCESSID NUMBER(38) [...]

Database S chema Ref erence Appen dix B Engin e Database Schema 343 Ta b l e B - 1 8 WFHSessAttributes Name Index Nu ll? Type Description SESSIONID ✔ NOT NULL NUMBER(38) Identifier for the s ession between the engine and clien t application. ATTNAME NOT NULL VARCHA R2(6 4) Name of a pro cess attrib ute in the session. ATTTYPE NOT NULL NUMBER(38) [...]

Database S chema Ref erence 344 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Ta b l e B - 2 0 WFHSessionRol e Name Index Nu ll? Type Description SESSIONID NOT NULL NUMBER(38) Unique identifier for the client session . Joins to WF HSESSION.ID. ROLENAME ● VARCHAR2(64) A role held by the session. Ta b l e B - 2 1 WFHTermi[...]

Database S chema Ref erence Appen dix B Engin e Database Schema 345 Ta b l e B - 2 2 WFHTermProcPa ras Name Index Nu ll? Type Description COMBINEDID ✔ NOT NULL VARCHAR2(158) Internal u se only. ATTNAME VARCHAR2 (64) Th e name of the attribute that must be returned to the callin g process (an outpu t pa rame ter ). ATTTYPE NUMBER(38) Attribute typ[...]

Database S chema Ref erence 346 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Registrati on Tables This section contains an alphabetical list of all registration tables in the engine database. For a de scription of each of these tables, refer to Table B- 1 on page 329 . CURRELATIVETIME VARCHAR2(32) F or a paused ela psed [...]

Database S chema Ref erence Appen dix B Engin e Database Schema 347 History Log Tabl es The following is an alphabetica l list of all his tory log tables in the engin e database. “ State Values ” on page 35 7 lists the possible values for the State f ield present in many of the history log tables. For a description of each of these tables, re f[...]

Database S chema Ref erence 348 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Ta b l e B - 2 6 WFH Activ ity Log Name Index Nu ll? Type Description ID NUMBER(38) Unique identifier for this activ ity instance w ithin the pr ocess inst ance in which i t occu rs. ACTN AME VAR CHA R2(6 4) The na me o f the act ivity in the p [...]

Database S chema Ref erence Appen dix B Engin e Database Schema 349 SESSIO NID NUMBER( 38) ID of the sessio n that owns this a ctivit y (if the activity is ACTIVE). LOGTIME DATE Time of th is logg ing. Ta b l e B - 2 8 WFHAlarmLog Name Index Nu ll? Type Description ALARMTYPE VARCHAR2( 64) The type of the alarm. DETAIL S VARCHAR2( 255) T he text of [...]

Database S chema Ref erence 350 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Ta b l e B - 3 0 WFHAttribLockLog Name Index Nu ll? Type Description PROCESSID NUMBER(38) Unique identif ier for the process inst ance in whic h this pro cess attrib ute occur s. ACTIVITYID NUMBER(38) If the access to the process attribute is as[...]

Database S chema Ref erence Appen dix B Engin e Database Schema 351 Ta b l e B - 3 2 WFHPerformanceLog Name Index Nu ll? Type Description SAMPLETIME NOT NULL DATE Date time stamp for the sample. RESPONSETIME NOT NULL NUMBER(38) Average engine re sponse ti me to requests by a client application. SWAPINTIME NOT NULL NUMBER(38) Average process sw ap i[...]

Database S chema Ref erence 352 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 ACTIVEPAGE NOT NULL NUMBER(38) The number of active memory pages for the engine. ALLOCATEPAGE NOT NULL NUMBER(38) The number of allocated memory pages for the engine. Ta b l e B - 3 3 WFHPro cAttri bLog Name Index Nu ll? Type Description PROCESS[...]

Database S chema Ref erence Appen dix B Engin e Database Schema 353 Ta b l e B - 3 4 WFHProcessLog Name Index Nu ll? Type Description ID NUMBER(3 8) Unique identifier for the process instance in this engi ne. PROCNAME VARCHAR2(64) The name of the process definition of which t his proces s is a n instan ce. SUBMITTIME DATE Date and ti me the pr oces[...]

Database S chema Ref erence 354 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Ta b l e B - 3 5 WFHP roce ssSta teLog Name Index Nu ll? Type Description ID NUMBER(3 8) Unique identifier for the process instance in this engi ne. STATE NUMBER(38) New state of the process instance: 405 – WFProcess.PREPARE_CREATE 410 – WFP[...]

Database S chema Ref erence Appen dix B Engin e Database Schema 355 STATE NUMBER(38) Effect of this re gistration action: 1 – Registered -1 – Unregist ered LOGTIME DATE Time of th is logg ing. Ta b l e B - 3 7 WFHSessionL og Name Index Nu ll? Type Description ID NUMBER(38) Unique identifier for the cli ent session. SESSNAME VARCHAR2(64) The ses[...]

Database S chema Ref erence 356 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 Ta b l e B - 3 9 WFHTimerStateLog Name Index Nu ll? Type Description ID NUMBER(38) Unique identifier for the timer in stance within t his en gine. PROCESSID NUMBER(38) Unique identif ier for the process inst ance in whic h this t imer i nstanc e[...]

Database S chema Ref erence Appen dix B Engin e Database Schema 357 State Values Many of the histor y log tables listed in this section have a field that represents the state of a given engine object: pro cess instance, activity, session, and timer. The following table shows the values corresponding to the various states of these objects: Object St[...]

Database S chema Ref erence 358 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1[...]

359 Index A AbortActivi ty command, Conductor Sc ript 273 AbortAl lProcesses com mand, Conduc tor Script 274 ABORTED activi ty stat e 163 , 199 , 357 process i nstanc e state 173 , 19 8 , 357 abort ing activi ties 186 process i nstances 181 Abort Process command, Cond uctor S cript 274 ACTIVE activi ty stat e 163 , 199 , 357 process i nstanc e stat[...]

Section B 360 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 B backup eng ine unit defined 33 partitionin g guidelines 86 BOTH govern or state 106 BroadcastMessage command, Conductor Script 275 C cconsole command 67 central server node definition 51 install ation 57 Chan nelDisco nnect alar m 205 client application develop[...]

Secti on D Index 361 Condu ctor Sc ript com mand (continued) ShowAc tivityQueu e 305 Sho wConf igurat ion 306 ShowE ngine 306 ShowLogFla gs 307 ShowProcess 307 ShowSess ion 308 ShowStat us 309 ShowTimer 31 3 Shutdown 314 StartAc tivity 314 StartDB Service 315 StartE ngine 315 StartGo vernor 316 StartT imer 317 StartUn it 317 StopTimer 319 SuspendAl[...]

Section E 362 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 engine (c ontinued) reconfig uration 113 recov ery 34 , 166 regi strati on ma nager 142 relation to iIS proc ess ma nagement sy stem 45 reloca ting 62 shuttin g down 124 shutti ng down c omponen ts 243 start ing wi th Co nduct or Scri pt 235 start ing wi th iIS C[...]

Section F Index 363 exception alarm 205 exception s, logged 210 execution options 103 Exit com mand, iIS Con sole 71 EXPIRED timer state 199 , 357 F failover, en gine unit 33 failure engine 34 , 159 engine da tabase 125 netw ork c onnec tion 159 filtering engine ev ents 217 iIS Console lists 73 FindDBService command, Conductor Sc ript 283 FindE ngi[...]

Section L 364 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 install ation central server 57 development client node 59 engine se rver n ode 58 runt ime cli ent nod e 60 instrum ent dat a, logged 211 L last a ctivity, description 165 librar y dist ribution and regi stration 139 ListActivit ies command, Conductor Script 287[...]

Section Q Index 365 performance chart 221 , 22 4 performance indica tors 222 performance, engi ne 89 , 116 ping int erval, se ssion 15 9 PREPARE st ate (tw o-phase comm it) 201 primary en gine uni t, parti tioning gu idelines 86 process attri butes locks, r emoving 194 value, changin g 194 val ue/l ock stat e, che ckin g 189 process client appl ica[...]

Section S 366 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 RegisterAlias command, Cond uctor Script 294 RegisterAssi gnmentRule s comman d, Conductor Script 29 4 regi steri ng Conductor distr ibutions 145 engine w ith alarm service 206 RegisterPro cessDefinition command, Conductor Script 29 5 RegisterUserProfil e command[...]

Section T Index 367 ShowE ngine comm and, C onducto r Script 306 ShowLogFla gs command, Conductor Script 307 ShowProcess command, Conductor Script 30 7 ShowSess ion command, Conductor Scr ipt 308 ShowStat us comman d, Conduc tor Scr ipt 239 , 24 0 , 309 ShowTimer command, Conduc tor Script 313 shutd own 124 , 243 Shutdown comma nd, Conductor Script[...]

Section U 368 iPlan et Integra tion Serv er • Process System Gu ide • August 200 1 U UDS runtime environment 44 Uninstall command, Conductor Script 32 1 uninst alling iI S 64 UnRegiste rAlias c ommand, Con ductor Scr ipt 322 UnRegisterAssignmentRu les command, Conductor Script 32 2 UnRegisterP rocessDefin ition command, Conductor Script 32 3 Un[...]