Campaign execution modes

Each campaign may be in one of three possible execution modes:

  • Manual - Each batch is manually released (by a user or external program) to the Batch Executive and must be started manually (by a user or external program). Released means it is placed on the Batch Executive's batch list and put in a state of ACTIVE-READY.

  • Auto Release - Each batch in the campaign is automatically released to the Batch Executive. Only one batch from a campaign is released at a time and only one may be in an ACTIVE-READY state. The number of running batches may be up to the maximum number specified during the campaign creation. The batches must be started manually (by a user or external program).

  • Auto Start - Each batch in the campaign is released automatically to the Batch Executive and started automatically. The number of active batches may be up to the maximum number specified during the campaign creation, plus one batch in the ACTIVE-READY state. A released batch is started automatically if the number of active batches within the campaign is less than the defined maximum number of active batches.

If the campaign is configured as Auto Release or Auto Start, you should also use the Auto Remove function. Auto Remove removes batches from the Batch Executive after a specified period of time, keeping the list of completed batches to a minimum.

Note:

In certain cases the Campaign Manager server must place any automatically running campaigns (those found in either AUTO-RELEASE or AUTO-START mode) back into MANUAL mode. For example, if the Campaign Manager server loses its connection with the Batch Executive (that is, if the Batch Executive is shut down while automatic campaigns are running) or if there is an error in the execution of a campaign, then the Campaign Manager server will immediately place the campaigns into MANUAL mode so that any automatic processing will cease. In these cases, the AUTO-REMOVE-IN-MANUAL mode will be deselected (temporarily disabled) as to also prevent any automatic removal of completed batches in these campaigns. The other two auto remove options (those for AUTO-RELEASE and AUTO-START) will NOT be changed.

Important:

If downloading equipment changes for batches running in campaigns, put the campaigns in MANUAL mode first. The newly downloaded equipment change forces the next batch in the campaign to go to HELD. However, the following batches can still Auto Start. To avoid batches being run out of order, place the campaign in MANUAL mode and then make and download the equipment changes.

There are several ways to change the execution mode:

  • Right-click the campaign in the Campaign Manager hierarchy and select the desired execution mode.

  • Select the campaign and click the appropriate Mode button on the toolbar.

  • Open the Campaign Properties dialog and select a new mode.

You need to have the required security privilege to be able to change the campaign execution mode. To place a campaign in any of the auto modes, you must have the DeltaV security key CAMPAIGN_MODIFY, as well as the corresponding Batch key, as follows:

  • For Auto Release mode, you need the BATCH_ADD key.

  • For Auto Start mode, you need the BATCH_ADD and BATCH_START keys.

  • To be able to specify that completed batches are to be automatically removed, you need the BATCH_REMOVE key.