Copyright © Cloud Software Group, Inc. All rights reserved.

doStopProcesses()

Method

Purpose

This method stops one ore more iProcess Engine processes on the current server. If no parameters are passed, all processes on the current server are stopped. Use the ProcessType parameter to stop processes of a specified type. If you use this parameter you can also specify a specific process instance with the ProcessInstance parameter. You can also specify optional arguments to perform a forced shutdown, which stops processes regardless of any active user sessions.

Type

Synchronous, IMPACT_INFO.

Arguments

 

Name	Type	Description
ProcessType	String	Logical process name of the type of process to stop. The process type must be one that can be stopped independently of the other iProcess Engine processes (see getIsTypeDynamic()).
ProcessInstance	Integer	Logical process instance of the process to stop. Must be used in conjunction with the ProcessType parameter. A value of 0 means that all instances of the indicated process type are stopped.
ForcedShutdown	Boolean	Whether the shutdown is forced. If 1, users are given 300 seconds before the forced shutdown begins.
ForcedTimeout	Integer	Number of seconds before the forced shutdown begins. Must be used in conjunction with the ForcedShutdown parameter.

Errors

 

Error Code	Error Message
ERR_PMAMI_PROCTYPE	ProcessType is not a valid process type.
ERR_PMAMI_TYPEDYNAMIC	Processes of type ProcessType cannot be stopped independently.
ERR_PMAMI_PROCINST	ProcessInstance must be >= 0.
ERR_PMAMI_PARAM	ProcessInstance cannot be specified without ProcessType.
ERR_PMAMI_MALLOC	Insufficient memory to start processes.

See Also

getIsTypeDynamic()

Copyright © Cloud Software Group, Inc. All rights reserved.