Open topic with navigation

TIBCO iProcess® Engine 11.10.0

# Forcing the iProcess Engine to Shutdown

Normally, when you want to shut down iProcess Engine, you must first get all users to log out of iProcess Suite.

However, you can force iProcess Engine to shut down, even if there are users logged in. There are two ways you can do this:

| • | Using the `swstop` command from a command prompt. See the following section for details.

| • | Using the `swstop` command from the Services dialog box. For more information, see Enable Forced Shutdown from the Services Dialog Box.

## Using the swstop Command

You can use the following command to force the iProcess Engine to shut down:

`SWDIR``\bin\swstop [-f [``timeout``]]`

where:

| • | `-f` issues a forced shutdown event to shut down the iProcess Engine processes, whether or not there are users logged in.

| • | `timeout` is the period, in seconds, to wait before shutting down iProcess Engine. If `timeout` is omitted, a default timeout value of 300 (5 minutes) is used. If a subsequent `swstop` `-f` `timeout` command is issued before the first `timeout` value has expired, the `timeout` will be reset to the new value if the new `timeout` value is smaller. You cannot increase the timeout period - a larger timeout value will be ignored.

Note:

| • | On a UNIX system, you must be logged in to iProcess Engine as a background user to use this command.

| • | When the forced shutdown command is issued, a message is sent to all users informing them that the system will be stopped in `timeout` seconds.

| • | Make sure you save any changes to procedure definitions before enabling the forced shutdown otherwise any such changes will be lost.

| • | If any released work items have not been processed by the time the background processes shut down, these changes are queued and processed when iProcess Engine restarts.

For example:

| • | The following command causes iProcess Engine to shut down after the default delay of 300 seconds.

`swstop -f`

| • | The following command causes iProcess Engine to shut down after a delay of 3 minutes.

`swstop -f 180`

| • | If this command is issued 1 minute after the previous example, the delay before the shutdown will be reset to 30 seconds.

`swstop -f 30`

## Enable Forced Shutdown from the Services Dialog Box

To force iProcess Engine to shut down from the Services dialog box, you must:

Create a new string value called `SERVICE_STOP_PARAMS` in the Windows Registry and enter the `swstop` command as the string value data. For more information, see Creating the SERVICE_STOP_PARAMS String Value.

Once you have created the SERVICE_STOP_PARAMS string value, when you stop Process Sentinels from the Services dialog box, the Process Sentinels are shut down using the `swstop` command with the parameters you specified. For more information, see Manually Stopping the iProcess Engine.

To disable the forced shutdown from the Services dialog box, either:

| • | Delete the `SERVICE_STOP_PARAMS` string value from the Windows Registry, or

| • | Delete the value data from the `SERVICE_STOP_PARAMS` string value in the Windows Registry.

## Creating the SERVICE_STOP_PARAMS String Value

To create the `SERVICE_STOP_PARAMS` string value:

| 1. | From the Start menu, click the Run button. The Run dialog box appears.

| 2. | In the Open: field, type `regedit`, and click the OK button. The Registry Editor window appears.

| 3. | Navigate to the registry list where the `SERVICE_STOP_PARAMS` string value is to be located, at:

`RegistryLocation``\Staffware plc\Staffware Server\Nodes\``nodename`

where:

| — | `RegistryLocation` is `\HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node for` a 64-bit machine.

| — | `nodename` is the name of the iProcess Engine installation.

| 4. | From the Edit menu, select New > String Value. A new value named `New Value #1` is created.

| 5. | Right-click the New Value #1 item and click the Rename button. Rename the `New Value #1 item` to the `SERVICE_STOP_PARAMS` item.

| 6. | Right-click the SERVICE_STOP_PARAMS item and click the Modify button. The Edit String dialog box appears.

| 7. | Enter the following value in the Value Data: box:

`swstop` `[-f [timeout]] [-n retries`]

where:

| — | `-f` issues a forced shutdown event to shut down the iProcess Engine processes, whether or not there are users logged in.

| — | `timeout` (optional) is the period, in seconds, to wait before shutting down the iProcess Engine. If `timeout` is omitted, a default timeout value of 300 seconds (5 minutes) is used. The `timeout` value can be a numeric value between 0 - 7200. If a value less than 0 is entered, the default value of 300 seconds (5 minutes) is used. If a value greater than 7200 is entered, the value of 7200 seconds is used.

| — | `-n` `retries` (optional) is the maximum number of times the forced shutdown command will be retried, if required. The `retries` value can be a numeric value of 0 or greater. The re-issue of the forced shutdown command occurs if any of the processes have not shut down. This overcomes the problem of an event being lost in the event system and the process not receiving the shutdown message.

If all the processes have still not completely shut down after the number of retries then a final forced shutdown is issued.

If `retries` is omitted, (or if a value of less than 0 is entered), a default value of `0` is used. This means that a forced shutdown is issued after the timeout period and is not re-tried. Any processes that have not shutdown are forced to shutdown.

If all the processes have still not completely shut down after the final forced shut down is issued because, for example, a process has hung, then these processes will have to be shut down manually through the Task Manager or by restarting the machine that is hosting iProcess Engine.

Note:

| • | When the forced shutdown command is issued, a message is sent to all users informing them that the system will be stopped in `timeout` seconds.

| • | After 2 minutes, Microsoft Windows issues the following message:

`Could not stop the iProcess nodename Process Sentinels service on Local Computer. Error 1053: The service did not respond to the start or control request in a timely fashion`

where `nodename` is the name of your iProcess Engine installation. This is a warning only. Click the OK button, Process Sentinels continue to shut down.

| • | Make sure you save any changes to procedure definitions before enabling the forced shutdown otherwise any such changes will be lost.

| • | If any released work items have not been processed by the time the background processes shut down, these changes are queued and processed when iProcess Engine restarts.

Did you find this helpful?

Yes No
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO iProcess® Engine

Copyright © 1994-2025. Cloud Software Group, Inc. All Rights Reserved.