PerformScriptCommandRTS

This method restarts or stops the Runtime Server through a custom script.

You can use this method to perform a stop on Runtime Server if a third party, such as SAP, is unavailable.

This method stops the currently running Runtime Server instance executing the script to either stop or restart.

Syntax

PerformScriptCommandRTS (CommandID as Long, MessageType as Long, UserCode as Long, MessageDescription as String)
Parameter Description
CommandID Identifier of the command to execute on the RTS instance.

Possible values

  • 0: Force the RTS instance to stop document processing.
  • 1: Restart the RTS instance.
MessageType The type of message to log when the command executes.

Possible values

  • 0: Information
  • 1: Warning
  • 2: Error
Note: Error messages are additionally forwarded to the MMC administration console of the Runtime Server.
UserCode User error code of the message. This error code can be defined by the developer as any custom error number.
MessageDescription The description of the message to log on the common Runtime Server log file and in the case of error messages on the MMC administration console.

Sample Code

The following code example demonstrate how to stop and restart the RTS instance. 

script code stops document processing for the current Runtime Server
' instance and logs specified message as error with error code "777"
Project.PerformScriptCommandRTS 0, 2, 777, "RTS is going to stop from Custom Script"
' specified message as warning with error code "999"
Project.PerformScriptCommandRTS 1, 1, 999, "RTS is going to be restarted from Custom Script"