Conductor Script Commands | Sun Microsystems 3 instruction

Appendix A

Conductor Script Commands

This appendix is an alphabetically ordered reference 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 commands for performing repository-based operations, as well as a large number of iIS-specific commands.

This appendix documents only the iIS-specific Conductor Script commands. For documentation of Fscript Commands accessible through Conductor Script, see the Fscript Reference Guide.

An introduction summarizes and groups the Conductor Script commands according to their function.

Conductor Script Command Summary

The following tables summarize Conductor Script commands and group them into the following categories, each of which represents a level within the hierarchy shown in Figure A-1:

•environment mode commands

•engine mode commands

•component mode commands

261

Image 261

Sun Microsystems 3 manual Conductor Script Commands, Conductor Script Command Summary

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 Product Name Change Preface Organization of This Guide Audience for This Guide ALL Caps Text Conventions Syntax Statements Other Documentation Resources IPlanet Integration Server Documentation Online HelpDocumentation Roadmap To copy the documentation to a client or server IIS Example Programs To view and search the documentation Toolbar Button Keyboard Command Introduction iIS Process Management What Is an iIS Process Engine? What Is an iIS Process Engine? Multiple Engine Systems Workshops IIS Process Engine Components Minimal Engine Configuration 2Minimal Engine Configuration 3Engine Configuration with Failover Failover Configuration IIS Process Engine Components Full Configuration Failover and Load Balancing Combined IIS ProcessEngine What Does an iIS Process Engine Do? IIS Process Management Tasks Setting up and Maintaining an iIS System 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 Console IIS Process Management Tools Conductor Script Utility Dump/Restore FacilitiesCustom 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 Backbone IIS Process System Software Process System Software Modules Details, see , Using the Conductor Setccomp.sh True False Compiled and Interpreted Engine Components 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 DLL Engine Server Installation Development Client Installation Runtime Client Installation Configuring and Starting Your iIS Engines Maintaining an iIS Process System Adding New Nodes to an iIS SystemTo add a new node to an iIS system Creating a New iIS Repository Server Moving an iIS EngineMoving 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 Overview IIS Console Overview Starting the iIS Console Using the cconsole CommandTo start the iIS Console on Windows or Windows NT To start the iIS Console on UNIX, OpenVMS, or Windows NT IPlanet UDS System Management Guide for information about IIS Console Main Window Off Engine is configured but has not been started Main Viewing PanelOnline Engine has fully started and is online Mouse Popup Menu Menu Bar Setting Password Protection for iIS Console To set a password for iIS ConsoleExiting iIS Console Using the Mouse Using iIS Console WindowsWindow Refresh Behavior To turn automatic refresh off or on Filtering iIS Console Lists To set the automatic refresh intervalTo force an immediate refresh Specifying Values Operators Example Filter Expression Sorting iIS Console Lists 2iIS Console Browser Using List Views Environment Menu IIS Console Main Window Command Summary Engine Menu View Menu Monitor Menu Help Menu Page Production Engines Versus Development Engines Managing Engines Production Engines Versus Development Engines Engine Component Partitioning Configuring an Engine 1Engine Configuration with both Failover and Load Balancing Configuring an Engine 2Typical Engine Partitioning Scheme Engine Startup Properties Configuring an Engine Sample configuration file is reproduced below Engine Configuration File Nodenameservicenamepriority DbservicesDatabaseuserpassword Logtimers Dbservicestacksize DbservicememoryflagUnitrecovercursorsize Governormemoryflag Monitordisplaylimit Customizing Engine Database SchemaUnitsessionreconnectlimit Unitsessionreconnectaction FORTEROOT/sysdata/conductr/clN/environment/enginename.dbs Code Example How to Configure a New Engine 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 Deleting an Engine Configuration Duplicating an Engine ConfigurationTo duplicate an engine configuration To delete an engine configuration Governor Starting an Engine Engine Unit IdleBoth Embryonic OnlineStandby Primary Engine Unit Startup Phases Database Service InformpartnerStartupcomplete To start an engine How 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 To modify database logging for an engine How to Dynamically Modify Database Logging How to Tune Process Execution Monitoring and Changing Engine States To check the engine runtime configuration Monitoring Engines and Engine ComponentsMonitoring the Engine To monitor individual engine components Monitoring 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 Database Tables Dumping and Restoring Data To use the Dump/Restore application to dump database tables Using the Dump/Restore Application 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 Wfdrengine Dump/Restore Environment VariablesWfdrdirectory Wfdrdatafile About Registration Managing Registrations About Registration What Does Registration Do? Install distribution on engine nodes Registration in Production Environments Engine Registration Manager What Does Unregistration Do? 2Subprocess Activity References About Aliases Registering iIS Distributions Performing Registrations Registration Order To register one or more distributions using the iIS Console Unregistering iIS Distributions Upgrading Registrations 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 To monitor instances of a registered process definition Monitoring Instances of a Registered Process Definition Performing Application Upgrades To perform a monolithic upgrade Monolithic Upgrades To perform a rolling upgrade Rolling UpgradesPage Introduction Managing Process Execution Engine Sessions ActiveSuspended Reconnectioninprogress Disrupted Sessions Terminate SuspendReconnectallowed Reconnectprohibited Explicitly Terminated Sessions Explicitly Suspended Sessions Activity States PendingReady Aborted Completed Activity State Activity Types Process Execution Process Instance Creation Activity Creation Process Instance Execution Offered Activities Activity Execution Queued Activities Subprocess Activities Automatic Activities Activity Termination Completed Activities Process Instance Termination Monitoring and Managing Engine SessionsCompleted Process Instances Aborted Process Instances To obtain state information about a session Monitoring the State of 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 To broadcast a message to all sessions Monitoring and Managing Process Execution 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 To abort a process instance Aborting a Process Instance Checking the Status of an Activity Managing Activity Instances 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 To reprioritize a queued activity Reprioritizing a Queued Activity Monitoring and Managing Process Execution Checking the Status of a Timer Managing Timer Instances To change the state and expiration time of a timer Changing the Timer State and Expiration Time Checking the Value and Lock State of a Process Attribute Managing Process Attributes Changing a Process Attribute Value Removing a Process Attribute Lock To change the value of a process attributeTo remove a process attribute lock To find a process bottleneck Checking for Bottlenecks in Process Execution Analyzing Process Execution State Values History Log SchemaPreparecreate Created OFF Monitoring and Managing Two-Phase CommitExpired Terminated IIS Process Engine Operations Monitoring and Managing Two-Phase Commit Managing Two-Phase Commit Operations Troubleshooting Introduction Process Engine Alarms Window To register an engine with the alarm service Monitoring Alarms To filter alarms in the Process Engine Alarms window To unregister an engine from the Alarm service To search for an alarm in the Process Engine Alarms window Viewing Alarms To remove an alarm from the Alarm window To get detailed information about an alarm Engine Log Files To view an engine component log file Messages and Message Filters IIS Console Trace Window 1Specifying iPlanet UDS Message Output Filters Specifying Message Filters Message type trc debug IIS Message Filters 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 Process Instance Events Displaying All Engine 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 To start Conductor Script on UNIX, OpenVMS, or Windows NT Using the Cscript Command Working with Conductor Script See SetPath General Conductor Script Operations Comments Writing and Executing Scripts File Operating System and File Management Commands Copy a specified file in the local file system Starting an Engine Managing iIS Process Engines with Conductor Script Starting Individual Engine Components To start an engine where delays might be involved Start all components Example Manual Startup Scenario Monitoring Engines and Engine Components Monitoring Individual Engine Components FindDBService State Making iIS Library Distributions Managing Registrations with Conductor Script To make an iIS library distribution Include a plan as a To register an iIS distribution with an engine Registering iIS Library Distributions Unregistering iIS Library Distributions Unregister the specified Alias from the current Engine To unregister an iIS distribution from an 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 Managing Process Instances Monitoring and Managing Process ExecutionManaging 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 To check the status of a timer Managing TimersManaging Process Attributes To check the value or lock state of a process attribute To remove an attribute lock Checking for Bottlenecks in Process Execution Place the specified activity List all existing event filters for Current engine Monitoring Two-Phase Commit Operations Monitoring and Managing Two-Phase Commit Transactions Commits the in-progress Managing Two-Phase Commit Operations To resolve transactions after a client or engine failure Conductor Script Command Summary Conductor Script Commands 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 Engine Unit Generic component AbortActivity Conductor Script Commands AbortProcess AbortAllProcesses CommitTransaction BroadcastMessage ConsultActivity CompleteActivity Activity instance to be delegated CreateActivity Event Type CreateFilter Object Instance Object Class Examples DelegateActivity Active DeleteFilter FindDBService FindGovernor FindEngine FindNode FindParentEngineFindPrimary FlushLog FindUnit IIOPServer ListActivitiesListActivityQueues ListConductorDistributions ListEngines ListFiltersListProcesses Options ListRegistrations ListTimers ListSessionsListTransactions ModLogFlags MakeConductorDistribution ReadyActivity RegisterAssignmentRules RegisterAlias RegisterUserProfile RegisterProcessDefinition RegisterValidation RemoveWriteLock RemoveReadLock RollbackTransaction RollbackActivity Critical SendMessage SetAttributeValue SetPassword SetQueuedActivityPriority SetPrimary SetState SetTimer SetTimerDeadline ShowActivity SetTimerElapsed ShowActivityQueue ShowEngine ShowConfiguration ShowProcess ShowLogFlags ShowSession Engine ShowStatus Engine unit Primary engine unit Instrument Description ShowTimer StartActivity Shutdown StartEngine StartDBService StartGovernor StartUnit StartTimer Table A-2StartUnit Command Options SuspendAllSessions StopTimer TerminateAllSessions SuspendSession TerminateSession Uninstall UnRegisterAssignmentRules UnRegisterAlias UnRegisterProcessDefinition WaitForStartup UnRegisterUserProfile Conductor Script Commands Page Database Tables by Category Engine Database Schema Database Tables by Category WFHActivityUsers Alphabetical Listing of Tables Database Table See… Description WFHSessionRole Database Schema Reference Table B-2 Current State Tables Table B-3 Abortraction NUMBER38 Actname VARCHAR264Wuser VARCHAR264 Nolinkeduser Tokcounter NUMBER38 Activityname VARCHAR264Wuser Not NUMBER38 Not VARCHAR264 Table B-7 Table B-10 WFHLocks Table B-9 WFHControl Atttype NUMBER38 Locktype NUMBER38Attseglength NUMBER38 Attvalue VARCHAR2255 Table B-12 Table B-12 WFHProcess Table B-15 Table B-13 Null Processid NUMBER38 Seqnumber Not NUMBER38Reqstatus NUMBER38 Actionflag NUMBER38 Table B-19 WFHSession Not VARCHAR2158 Table B-20Environment VARCHAR264 Engine VARCHAR264 Timername State Relativetime Not NUMBER38 Table B-23 WFHTimerNull Attname VARCHAR264 Attsegmentid NUMBER38 Table B-23 Registration TablesCurrelativetime VARCHAR232 Table B-24 Libraryname Not VARCHAR232 History Log TablesLoadoptions Projectname Wusage Createtime Processid NUMBER38 Table B-26Logtime Date Table B-27 Alarmtype VARCHAR264 Table B-28 WFHAlarmLogDetails VARCHAR2255 Table B-29 WFHAliasLog Table B-31 Table B-30 Table B-32 Activepage Not NUMBER38 Allocatepage Not NUMBER38Table B-33 Table B-34 Parentprocid NUMBER38Parentprocid Table B-36 Table B-35 Timername VARCHAR264 Table B-38 WFHTimerLogTable B-37 Sessname VARCHAR264 Relativetime VARCHAR232 Table B-39 State Values Page Index Section B Section D Section E 284 Section L Section Q See also recovery 309 Section U