Skip to main content

Starting and Stopping Productions

By default, InterSystems IRIS® does not automatically start productions. This topic describes how to start and stop productions.

Note:

For a live, deployed production, InterSystems recommends that you use the auto-start option. The other options are intended primarily for use during development.

Task Privilege Needed
Access Interoperability menus in Management Portal
  • %Ens_Portal:USE

  • READ permission on the default global database resource for the namespace

Start or Stop a Production
  • %Ens_ProductionRun:USE

Manage Relative Startup Priority
  • READ permission on the default global database resource for all namespaces

Manage Deployment and Create Deployment Packages
  • %Ens_Deploy:USE

  • %Ens_DeploymentPkg:USE

  • %Ens_DeploymentPkgClient:USE

Starting a Production

To start a production from the Management Portal:

  1. Select Interoperability > List > Productions.

    InterSystems IRIS then displays the Production List page.

  2. Select the production that you want to start.

  3. Select Open.

    InterSystems IRIS displays the production.

  4. Select Start.

  5. Select OK. InterSystems IRIS displays a dialog box that indicates progress.

    Note:

    If any Terminal windows open as a result of starting the production, do not close them.

  6. When the dialog box shows it is Done, select OK.

Stopping a Production

To stop a production from the Management Portal:

  1. Select Interoperability > List > Productions.

    InterSystems IRIS then displays the Production List page.

  2. Select the production that you want to stop. This must be a production that is running.

  3. Select Open.

    InterSystems IRIS displays the production.

  4. Select Stop.

  5. Select OK. InterSystems IRIS displays a dialog box that indicates progress.

    Note:

    If any Terminal windows open as a result of starting the production, do not close them.

  6. When the dialog box shows it is Done, select OK.

  7. If the request to stop the production initially fails, the portal displays a message:

    “Production could not stop, do you want to force a shut down?”

    And provides a command:

    Yes - Force to Shut Down

    If you click this command, the production is forced to shut down.

If a production is Suspended or Troubled, see Correcting Production Problem States.

Managing Production Auto-Start

You can specify that a production is automatically started in a namespace at system startup, and is automatically stopped at system shutdown. This option is the recommended way to start and stop productions.

If you have access to all namespaces, you can assign a Relative Startup Priority to an auto-start production. When the system starts up, the production with the highest priority number starts first, regardless of its namespace. If two productions share a priority number, the alphabetical order of the productions’ namespaces determines which production starts first. You cannot set a Relative Startup Priority if you do not have access to all namespaces.

To access this page in the Management Portal, select Interoperability > Manage > Auto-Start Production.

To enable auto-start for a single production in the current namespace:

  1. Select the production from the drop-down list.

  2. If you have access to all namespaces, set the Relative Startup Priority. Productions with the highest number start first.

  3. Click Apply.

InterSystems IRIS displays a dialog asking you to confirm that you want to auto-start this production.

To disable auto-start in the current namespace:

  1. Do not select any productions from the drop-down list.

  2. Click Apply.

InterSystems IRIS displays a dialog box asking you to confirm that you do not want to auto-start any production in this namespace.

A different page lets you override auto-start for all productions.

Important:

If you define a production to auto-start in a mirror configuration, it automatically starts on the current primary node in a failover situation. No further action is necessary. For details on the mirror failover process, see Mirroring.

Overriding the Production Auto-Start Options in All Namespaces

For debugging purposes or during disaster recovery, you can override the auto-start options for all productions. To do so:

  1. In the Management Portal, select System Administration >Configuration > Additional Settings > Startup.

    The Startup Settings page appears.

  2. Select Edit next to the EnsembleAutoStart setting.

  3. Clear the check box.

  4. Click Save.

InterSystems IRIS subsequently disregards the namespace-specific settings in the Auto-Start Production page, which is described in the previous section. In other words, even if a production appears in the Startup sequence priorities for productions set to Auto-Start list for a given namespace, the system does not automatically restart the production.

Improving Restarts for Productions with Large Queues

By default, when a production is stopped, any asynchronous messages on the ^Ens.Queue global queue are moved to the ^Ens.Suspended queue. When the production is restarted, they are moved back. For productions with many messages in the queue, this can slow down the process of stopping and restarting a production. To avoid moving the messages, you can set the following ^Ens.Configuration global node:

set ^Ens.Configuration("Queues","KeepInQueues")=1

By default, the node is set to 0; you will have to change this for each namespace. This will prevent the messages from being moved out of the Ens.Queue global, which can improve restart speeds on productions which consistently have large queues.

Using Production Shutdown Groups

Production shutdown groups allow you to control the order in which productions are stopped when you shut down an instance. By default, all productions are shut down in parallel when you stop an instance. When productions are organized into production shutdown groups, InterSystems shuts down the first group of productions before starting to shut down productions in the next group. Each group name must be an integer, and InterSystems starts shutting down the lowest group number first. By default, all productions belong to group 2.

To add a production to a production shutdown group:

  1. Select the production’s namespace and then go to Interoperability > Manage > Configuration > Production Shutdown Groups.

  2. Select the production from the drop-down list.

  3. Enter the group’s number in Relative Shutdown Group.

  4. Select Apply.

The table at the bottom of the page displays the productions that are currently active in each namespace, along with their group number. You can assign a production to a group at any time, but it does not appear in the bottom table unless it is the active production, which means it is running or is the most recently stopped production in the namespace.

Note:

Using production shutdown groups can result in it taking longer for the instance to stop, which has implications for time-sensitive failovers.

Redeploying a Live Production

The Management Portal automates the process of deploying a production from a development system to a live system. Overview of Deploying a Production describes this process from the developer’s point of view. This section describes what InterSystems IRIS does when you are loading a new version of a production on a live system.

The developer has provided you with an XML deployment package file that contains an updated version of your production. This deployment package should be deployed to a test system before deploying it to the live system. To load it on the live system, select the correct namespace and select Interoperability, Manage, Deployment Changes, Deploy, and then click the Open Deployment or Open Local Deployment button, depending on whether the XML deployment package is located on the server or on the local machine. The Open Local Deployment button is not active if you are on the server machine. After you select the XML deployment package file, the form lists the new and changed items in the deployment package and displays the deployment notes that were specified when the package was created.

Deploy Production Changes page with listing the items to include in a deployment package and other package details

You can specify the following deployment settings:

  • Target production—specifies the production that the components will be added to. If the deployment package includes the production class from the source production, then the target production is set to the source production and cannot be changed. Otherwise, InterSystems IRIS sets the default production to the currently open production, but allows you to change it.

  • Rollback file—specifies the file to contain the rollback information.

  • Deployment log file—contains a log of the changes caused by the deployment.

When you have read the deployment notes and made any changes to the deployment settings, complete the deployment by clicking the Deploy button. InterSystems IRIS does the following to stop the production, load the new code, and then restart the production.

  1. Create and save the rollback package.

  2. Disable the components in the production that have a production settings (ptd) file in the deployment package.

  3. Import the XML file and compile the code. If there is an error compiling any component, the entire deployment is rolled back.

  4. Update the production settings.

  5. Write a log detailing the deployment.

  6. Enable the production components that were disabled if their current setting specify that they are enabled.

To undo the results of this deployment change, use the Open Deployment button to select the rollback file, then click the Deploy button.

If you are using studio, you use the Tools Import Local or Import Remote to import the XML file. But you must then manually compile the components and then disable and re-enable them in the production. Using the Import classes button on the Management Portal System Explorer does automatically compile the classes, but it does not create a rollback package and disable the components.

Displaying the Deployment History

You can view the deployment history of the productions in a namespace. To view the deployment history, select Interoperability, Manage, Deployment Changes, and History.

Deployment History page showing the status and details of four previous deployments

After you select one of the listed deployments, you can click Details to display information about the deployment, Rollback to undo the deployment changes, or Delete to delete the deployment history. Deleting the deployment history does not delete the rollback or log files.

FeedbackOpens in a new tab