CompleteActivity, ConsultActivity | Sun Microsystems 3 instruction

Conductor Script Commands

CompleteActivity

The CompleteActivity command completes the specified activity, putting it in COMPLETED state.

CompleteActivity process_id activity_name

ArgumentDescription

process_id

The process instance in which the activity was created.

activity_name The name of the activity.

The CompleteActivity command is only available when an engine is current. Use the FindEngine Script command to set the current engine.

When you issue the CompleteActivity command, the engine performs the following actions:

•commits pending process attribute updates—saves changes that were made in performing the activity and frees locks on process attributes associated with the activity

•evaluates the activity’s OnComplete method, if one is specified

•evaluates the activity’s OnComplete router methods

•checks for a process stall condition—when all other activity instances are either COMPLETED or PENDING (no activities are in ACTIVE or READY state) and no timers are active—and aborts the process if a stall condition is detected

•deletes the COMPLETED activity

ConsultActivity

The ConsultActivity command hands off the specified offered activity to other users using the specified consultation assignment rule. A consulted session returns the activity using an assignment rule specified by the return_rule.

276 iPlanet Integration Server • Process System Guide • August 2001

Image 276

Sun Microsystems 3 manual CompleteActivity, ConsultActivity

Contents

Process System Guide Page Contents Setting Up an iIS Process Management System Managing Engines Managing Registrations 137 Managing Process Execution 157 Troubleshooting 203 Appendix a Conductor Script Commands 261 Conductor Script Commands Conductor Script Commands Index List of Figures IPlanet Integration Server Process System Guide August List of Procedures IPlanet Integration Server Process System Guide August List of Procedures IPlanet Integration Server Process System Guide August Preface Product Name Change Audience for This Guide Organization of This Guide Text Conventions ALL Caps Other Documentation Resources Syntax Statements IPlanet Integration Server Documentation Online HelpDocumentation Roadmap IIS Example Programs To copy the documentation to a client or server To view and search the documentation Toolbar Button Keyboard Command What Is an iIS Process Engine? Introduction iIS Process Management What Is an iIS Process Engine? Multiple Engine Systems Workshops Minimal Engine Configuration IIS Process Engine Components 2Minimal Engine Configuration Failover Configuration 3Engine Configuration with Failover IIS Process Engine Components Full Configuration Failover and Load Balancing Combined IIS ProcessEngine What Does an iIS Process Engine Do? Setting up and Maintaining an iIS System IIS Process Management Tasks Setting Up an iPlanet UDS Runtime Environment Installing iIS Process Management SoftwareSetting Up and Maintaining Central Development Repositories Managing iIS Process Engines Managing RegistrationManaging Process Execution IIS Process Management Tools IIS Console Dump/Restore Facilities Conductor Script UtilityCustom System Management Tools Repository Management ToolsPage Setting Up an iIS Process Management System Preparation Setting up an iPlanet UDS Runtime Environment IIS Process System Components IIS Process Engines IIS Process System Software IIS Backbone Process System Software Modules Details, see , Using the Conductor Compiled and Interpreted Engine Components Setccomp.sh True False IIS Process System Configuration IIS Process System Software 2iIS Process System Configuration IIS Function Node type Server/Client Node Names Setting Up an iIS Process System IIS Process System Setup ProcedureTo set up an iIS process system IIS Installation Program Central Server Installation Engine Server Installation DLL Development Client Installation Configuring and Starting Your iIS Engines Runtime Client Installation Maintaining an iIS Process System Adding New Nodes to an iIS SystemTo add a new node to an iIS system Moving an iIS Engine Creating a New iIS Repository ServerMoving an iIS Repository Server To create a new iIS Repository Server Creating a Private iIS Repository Upgrading an iIS SystemTo create a private iIS Repository on a development node Uninstalling an iIS System IIS Console Overview Overview Using the cconsole Command Starting the iIS ConsoleTo start the iIS Console on Windows or Windows NT To start the iIS Console on UNIX, OpenVMS, or Windows NT IIS Console Main Window IPlanet UDS System Management Guide for information about Off Engine is configured but has not been started Main Viewing PanelOnline Engine has fully started and is online Menu Bar Mouse Popup Menu Setting Password Protection for iIS Console To set a password for iIS ConsoleExiting iIS Console Using iIS Console Windows Using the MouseWindow Refresh Behavior To turn automatic refresh off or on Filtering iIS Console Lists To set the automatic refresh intervalTo force an immediate refresh Operators Specifying Values Example Filter Expression Sorting iIS Console Lists Using List Views 2iIS Console Browser IIS Console Main Window Command Summary Environment Menu View Menu Engine Menu Monitor Menu Help Menu Page Managing Engines Production Engines Versus Development Engines Production Engines Versus Development Engines Configuring an Engine Engine Component Partitioning 1Engine Configuration with both Failover and Load Balancing Configuring an Engine Engine Startup Properties 2Typical Engine Partitioning Scheme Configuring an Engine Engine Configuration File Sample configuration file is reproduced below Dbservices NodenameservicenamepriorityDatabaseuserpassword Logtimers Dbservicememoryflag DbservicestacksizeUnitrecovercursorsize Governormemoryflag Customizing Engine Database Schema MonitordisplaylimitUnitsessionreconnectlimit Unitsessionreconnectaction FORTEROOT/sysdata/conductr/clN/environment/enginename.dbs How to Configure a New Engine Code Example To configure a new engine Property Description Configuring an Engine Configuring an Engine Configuring an Engine Minimum number of pages managed by the memory manager Configuring an Engine Process execution options are the following Duplicating an Engine Configuration Deleting an Engine ConfigurationTo duplicate an engine configuration To delete an engine configuration Starting an Engine Governor Engine Unit IdleBoth Embryonic OnlineStandby Primary Engine Unit Startup Phases Database Service InformpartnerStartupcomplete How to Start an Engine To start an engine Data on To start individual engine components Reconfiguring an Engine How to Reconfigure an EngineTo reconfigure an engine Reconfiguring an Engine How to Dynamically Modify Database Logging To modify database logging for an engine How to Tune Process Execution Monitoring and Changing Engine States To check the engine runtime configuration Monitoring Engines and Engine ComponentsMonitoring the Engine Monitoring Engine Components To monitor individual engine components Unit Startup Phases on Property Description Changing Engine States Changing Engine Unit StatesTo change the state of an engine unit About Recovering State Information Database Management Issues Managing an Engine DatabaseShutting Down Engine Components Recovering Data Growth of the DatabaseFailure of the Database Dumping and Restoring Data Dumping Database Tables Using the Dump/Restore Application To use the Dump/Restore application to dump database tables Managing an Engine Database Managing an Engine Database Using the Dump Command-line Utility Restoring Database Tables Preserving Engine Database Schema Customizations Follow the instructions under Dumping Database Tables on Managing an Engine Database Using the Restore Command-line Utility Dump/Restore Environment Variables WfdrengineWfdrdirectory Wfdrdatafile Managing Registrations About Registration About Registration What Does Registration Do? Install distribution on engine nodes Registration in Production Environments What Does Unregistration Do? Engine Registration Manager About Aliases 2Subprocess Activity References Registering iIS Distributions Registration Order Performing Registrations To register one or more distributions using the iIS Console Upgrading Registrations Unregistering iIS Distributions Registering Aliases To register an alias using the iIS Console Viewing Registrations for an Engine Unregistering AliasesTo unregister an alias Unregistering a Distribution To view the registrations for a given engineTo unregister a registered distribution Monitoring Instances of a Registered Process Definition To monitor instances of a registered process definition Performing Application Upgrades Monolithic Upgrades To perform a monolithic upgrade Rolling Upgrades To perform a rolling upgradePage Managing Process Execution Introduction Engine Sessions ActiveSuspended Disrupted Sessions Reconnectioninprogress Suspend TerminateReconnectallowed Reconnectprohibited Explicitly Suspended Sessions Explicitly Terminated Sessions Activity States PendingReady Completed Aborted Activity State Process Execution Activity Types Process Instance Creation Process Instance Execution Activity Creation Activity Execution Offered Activities Queued Activities Subprocess Activities Activity Termination Automatic Activities Completed Activities Monitoring and Managing Engine Sessions Process Instance TerminationCompleted Process Instances Aborted Process Instances Monitoring the State of a Session To obtain state information about a session Monitoring and Managing Engine Sessions Managing Sessions Suspending or Terminating SessionsTo suspend a session Sending and Broadcasting Messages to Sessions To terminate a sessionTo send a message to an active session Monitoring and Managing Engine Sessions Monitoring and Managing Process Execution To broadcast a message to all sessions Session Managing Process Instances Checking the Status of a Process InstanceTo check the current execution status of a process instance Monitoring and Managing Process Execution Monitoring and Managing Process Execution Aborting a Process Instance To abort a process instance Managing Activity Instances Checking the Status of an Activity Changing the State of an Activity To change the state of an activity To view the contents of an activity queue Managing Activity QueuesChecking the Status of an Activity Queue Reprioritizing a Queued Activity To reprioritize a queued activity Monitoring and Managing Process Execution Managing Timer Instances Checking the Status of a Timer Changing the Timer State and Expiration Time To change the state and expiration time of a timer Managing Process Attributes Checking the Value and Lock State of a Process Attribute Changing a Process Attribute Value Removing a Process Attribute Lock To change the value of a process attributeTo remove a process attribute lock Checking for Bottlenecks in Process Execution To find a process bottleneck Analyzing Process Execution History Log Schema State ValuesPreparecreate Created Monitoring and Managing Two-Phase Commit OFFExpired Terminated IIS Process Engine Operations Monitoring and Managing Two-Phase Commit Managing Two-Phase Commit Operations Troubleshooting Introduction Process Engine Alarms Window Monitoring Alarms To register an engine with the alarm service To unregister an engine from the Alarm service To filter alarms in the Process Engine Alarms window Viewing Alarms To search for an alarm in the Process Engine Alarms window To get detailed information about an alarm To remove an alarm from the Alarm window Engine Log Files To view an engine component log file IIS Console Trace Window Messages and Message Filters Specifying Message Filters 1Specifying iPlanet UDS Message Output Filters IIS Message Filters Message type trc debug Using the iIS Console Trace Window Setting Message FiltersTo open the iIS Console Trace window To set message filters for a selected engine IIS Console Engine Event Filter Window Special Example Write Client Messages to Trace WindowTo set the engine tracing Using the iIS Console Engine Event Filter Window Engine Event TypesTo open the Engine Event Filter window Displaying All Engine Events Displaying Process Instance EventsTo view all engine events for the selected engine To view all engine events for an existing process Events for the specified process instance display Performance Charts Filtering Engine EventsTo specify a custom filter Viewing Performance Indicators To view performance indicators for an engine Performance Charts Logging Performance Information To log performance informationTo stop logging performance information Page Using the Conductor Script Utility Starting Conductor Script Conductor Script HelpTo start Conductor Script on Windows or Windows NT Using the Cscript Command To start Conductor Script on UNIX, OpenVMS, or Windows NT Working with Conductor Script General Conductor Script Operations See SetPath Writing and Executing Scripts Comments Operating System and File Management Commands File Copy a specified file in the local file system Managing iIS Process Engines with Conductor Script Starting an Engine To start an engine where delays might be involved Starting Individual Engine Components Start all components Example Manual Startup Scenario Monitoring Engines and Engine Components Monitoring Individual Engine Components FindDBService State Managing Registrations with Conductor Script Making iIS Library Distributions To make an iIS library distribution Include a plan as a Registering iIS Library Distributions To register an iIS distribution with an engine Unregistering iIS Library Distributions To unregister an iIS distribution from an engine Unregister the specified Alias from the current Engine Managing Process Execution with Conductor Script Monitoring and Managing Engine Sessions To suspend or terminate a sessionTo send a message to one or more sessions Send a message with Monitoring and Managing Process Execution Managing Process InstancesManaging Activity Instances To check the status of a process instance To list the contents of an activity queue Managing Activity QueuesTo reprioritize an activity in a queue Managing Timers To check the status of a timerManaging Process Attributes To check the value or lock state of a process attribute Checking for Bottlenecks in Process Execution To remove an attribute lock Place the specified activity List all existing event filters for Current engine Monitoring and Managing Two-Phase Commit Transactions Monitoring Two-Phase Commit Operations Managing Two-Phase Commit Operations Commits the in-progress To resolve transactions after a client or engine failure Conductor Script Commands Conductor Script Command Summary Environment Mode Engine Component Mode Environment Mode Commands Engine Mode Commands Engine Management Start the specified Engine Mode Commands Process Execution Management Abort all process instances Current engine Delegate the specified offered Activity from Pending to Set the specified timer to Component Mode Commands Generic component Engine Unit Conductor Script Commands AbortActivity AbortAllProcesses AbortProcess BroadcastMessage CommitTransaction CompleteActivity ConsultActivity Activity instance to be delegated CreateActivity CreateFilter Event Type Object Class Object Instance DelegateActivity Examples Active FindDBService DeleteFilter FindEngine FindGovernor FindNode FindParentEngineFindPrimary FindUnit FlushLog IIOPServer ListActivitiesListActivityQueues ListConductorDistributions ListEngines ListFiltersListProcesses ListRegistrations Options ListTimers ListSessionsListTransactions MakeConductorDistribution ModLogFlags ReadyActivity RegisterAlias RegisterAssignmentRules RegisterProcessDefinition RegisterUserProfile RegisterValidation RemoveReadLock RemoveWriteLock RollbackActivity RollbackTransaction SendMessage Critical SetPassword SetAttributeValue SetPrimary SetQueuedActivityPriority SetTimer SetState SetTimerDeadline SetTimerElapsed ShowActivity ShowActivityQueue ShowConfiguration ShowEngine ShowLogFlags ShowProcess ShowSession ShowStatus Engine Engine unit Primary engine unit Instrument Description ShowTimer Shutdown StartActivity StartDBService StartEngine StartGovernor StartTimer StartUnit Table A-2StartUnit Command Options StopTimer SuspendAllSessions SuspendSession TerminateAllSessions Uninstall TerminateSession UnRegisterAlias UnRegisterAssignmentRules UnRegisterProcessDefinition UnRegisterUserProfile WaitForStartup Conductor Script Commands Page Engine Database Schema Database Tables by Category Database Tables by Category Alphabetical Listing of Tables WFHActivityUsers Database Table See… Description Database Schema Reference WFHSessionRole Current State Tables Table B-2 Table B-3 Actname VARCHAR264 Abortraction NUMBER38Wuser VARCHAR264 Nolinkeduser Activityname VARCHAR264 Tokcounter NUMBER38Wuser Not NUMBER38 Not VARCHAR264 Table B-7 Table B-9 WFHControl Table B-10 WFHLocks Locktype NUMBER38 Atttype NUMBER38Attseglength NUMBER38 Attvalue VARCHAR2255 Table B-12 Table B-12 WFHProcess Table B-13 Table B-15 Seqnumber Not NUMBER38 Null Processid NUMBER38Reqstatus NUMBER38 Actionflag NUMBER38 Table B-19 WFHSession Table B-20 Not VARCHAR2158Environment VARCHAR264 Engine VARCHAR264 Table B-23 WFHTimer Timername State Relativetime Not NUMBER38Null Attname VARCHAR264 Attsegmentid NUMBER38 Registration Tables Table B-23Currelativetime VARCHAR232 Table B-24 History Log Tables Libraryname Not VARCHAR232Loadoptions Projectname Wusage Createtime Table B-26 Processid NUMBER38Logtime Date Table B-27 Table B-28 WFHAlarmLog Alarmtype VARCHAR264Details VARCHAR2255 Table B-29 WFHAliasLog Table B-30 Table B-31 Table B-32 Activepage Not NUMBER38 Allocatepage Not NUMBER38Table B-33 Table B-34 Parentprocid NUMBER38Parentprocid Table B-35 Table B-36 Table B-38 WFHTimerLog Timername VARCHAR264Table B-37 Sessname VARCHAR264 Table B-39 Relativetime VARCHAR232 State Values Page Index Section B Section D Section E 284 Section L Section Q See also recovery 309 Section U