Campaign Manager API

LockBatch

This method locks or unlocks a batch for edit for for control. Its signature is:

void LockBatch(
   string cmServer,
   string campaignID,
   string batchID,
   LockAction editLockAction,
   LockAction controlLockAction,
   UserInfo userInfo
);

Method Parameters

Parameters for this method are shown in the following table.

Parameter

Description

Type

Valid Input

cmServer

The DeltaV node where the Campaign Manager server is located

String

Name of node 

campaignID

Name of the campaign

String

Campaign node

batchID

The batch identifier

String

The batch identifier

editLockAction

Lock or unlock for edit

LockAction

instance of LockAction

controlLockAction

Lock or unlock for control

LockAction

instance of LockAction

userInfo

Credentials of the user. Can be null if not required

UserInfo

UserInfo instance or null