Deployment > Using the Deployment Activity > Specify the Update Method | Deployment

Specify the Update Method

When a version is delivered to a deployment client, the Runtime Manager needs to be restarted to apply the included changes. The Update Method allows you to specify how a restart will be initiated.

  WARNING

LOSS OF CONTROL

  • If you set the Update Method to Force, the runtime system will automatically shutdown on the deployment client when a deployment occurs.
  • If you set the Update Method to Prompt, the runtime system may be shutdown at an inappropriate time if an operator does not fully understand the implications of the dialog that appears.

You need to carefully consider how an update method will impact the runtime system before you deploy a project version.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

There are three options you can use for the Update Method.

ClosedPrompt

When the Update Method is set to Prompt, the client machine accepts the project and a message box will display prompting the operator to restart Runtime Manager.

Note: To use your own prompt instead of the default prompt, you can create custom Cicode and implement it with the parameters [Deployment]AskRestartFunc and [Deployment]AskRestartArgs. Refer to Create a Custom Deployment Prompt for more information.

ClosedNotify

When the Update Method is set to Notify, the client machine accepts the project and a notification is added to the system tray indicating a new project has been deployed and that Runtime Manager needs to be restarted.

ClosedForce

When the Update Method is set to Force, the client machine accepts the project and restarts Runtime Manager automatically.

If Runtime Manager is not running on a deployment client, a deployed project will be transferred but will not run. You will need to start Runtime Manager to launch the project.

See also

Deploy a Version

Published June 2018