Campaign Manager data contracts

Data contracts define complex data that can be exchanged with the service. Data contracts contain information required by the service to process the method invoked by the client.

DataMembers for which the Valid Input field is specified as NA are read only. Campaign Manager Web Service includes the following data contracts.

CampaignInfo

This data contract is used when creating or updating a campaign. This is also the data contract returned when requesting for the campaign status.

Some of the data members contained are read-only and will be populated only during a status request. If the data member is defined during an update or creation of a new campaign, the value is ignored.

DataMembers	Description	Type	Valid Input	Required
AutoRemoveInManual	Auto remove completed batches in manual mode. Default is False	Boolean	True or False	No
AutoRemoveInAutoRelease	Auto remove completed batches in auto-release mode. This option is disabled during a continuous iteration campaign. Default is False	Boolean	True or False	No
AutoRemoveinAutoStart	Auto remove completed batches in auto-start mode. This option is disabled during a continuous iteration campaign. Default is False	Boolean	True or False	No
MinRemoveDelay	Minimum delay for auto remove. Default is 60 minutes	Integer	Integer	No
BatchCompleteCount	Completed batches	Integer	NA	No
BatchCount	Total batches	Integer	NA	No
BatchExecutionMode	Batch execution mode. Default is Manual.	Enumeration	Enumeration value	No
BatchList	Batches contained in the campaign.	BatchInfo[ ]	NA	No
ContinuousIteration	Default is False	Boolean	True or False	No
CreatedBy	User who created the campaign.	String	NA	No
CreatedDate	Date the campaign was created.	DateTime	NA	No
Description	Campaign description	String	Any string	No
ID	Unique campaign identifier	String	Alphanumeric	Yes
InProcessBatches	Number of batches currently released to the executive.	Integer	NA	No
IsLocked	Checks if campaign is locked.	Boolean	NA	No
LockCount	Number of times the current lock owner has locked the campaign	Integer	NA	No
LockOwner	User who currently has the campaign locked.	String	NA	No
MaximumActiveBatches	Maximum active batches in the campaign. Default is 1.	Integer	Integer	No
ModifiedBy	User who last modified the campaign	String	NA	No
ModifiedDate	Date the campaign was last modified.	DateTime	NA	No
Prefix	Prefix for the batch ID. Default is the campaign ID.	String	Alphanumeric	No
RecipeInfo	Base recipe information	RecipeInfo	RecipeInfo instance	No
StartSequence	Start sequence number. Default is 1	Integer	Integer	No
State	Current campaign state.	CampaignState	NA	No
Suffix	Suffix for the batch ID. Default is the base recipe ID.	String	Alphanumeric	No
UserComments	User comments.	String[ ]	String array	No

BatchInfo

This data contract is used when adding or updating a batch within a campaign. This is also the data contract returned when requesting for the batch status.

Some of the data members contained are read-only and will be populated only during a status request. If the data member is defined during an update or creation of a new campaign, the value is ignored.

DataMembers	Description	Type	Valid Input	Required
Cleanup	Indicates if the batch is a cleanup batch. Default is False	Boolean	True or False	No
CreatedBy	User who created the batch.	String	NA	No
CreatedDate	Date the batch was created.	DateTime	NA	No
ID	Unique batch identifier	String	Alphanumeric	No
Index	Batch index	Integer	NA	No
IsBasedOnBaseRecipe	Indicates if the batch is based on the base recipe. Must be set to false when adding a batch with different recipe settings from the campaign base recipe.	Boolean	True or False	No
IsLockedForEdit	Checks whether the batch is currently locked for editing	Boolean	NA	No
LockEditOwner	User who locked the batch for edit	string	NA	No
EditLockCount	Number of times the edit owner has locked the batch for edit.	Integer	NA	No
IsLockedForControl	Checks whether the batch is currently locked for control.	Boolean	NA	No
LockControlOwner	User who locked the batch for control.	String	NA	No
ControlLockCount	Number of times the control owner has locked the batch for control.	Integer	NA	No
ModifiedBy	User who last modified the batch.	String	NA	No
ModifiedDate	Date the batch was last modified.	DateTime	NA	No
RecipeInfo	Recipe on which batch was based.	RecipeInfo	RecipeInfo instance	No
ReleasedBy	User who released the batch.	String	NA	No
ReleasedDate	Date batch was released.	DateTime	NA	No
RemovedFromExecutiveBy	User who removed batch from Batch Executive	String	NA	No
RemovedFromExecutiveDate	Date batch was removed from the Batch Executive	DateTime	NA	No
Setup	Indicates if batch is a setup batch. Default is False	Boolean	True or False	No
StartedBy	User who started the batch.	String	NA	No
StartedDate	Date batch was started	DateTime	NA	No
State	Current batch state	BatchState	NA	No

RecipeInfo

This data contract contains the recipe information in the campaign or batch. No method directly uses this data contract since it should be defined within the CampaignInfo and BatchInfo data contracts.

Some of the data members contained are read-only and will be populated only during a status request. If the data member is defined during an update or creation of a new campaign, the value is ignored.

DataMembers	Description	Type	Valid Input	Required
Name	Recipe name	String	Alphanumeric	Yes
Executive	Name of the Batch Executive	String	Alphanumeric	No
EquipmentTrain	Equipment train associated with the recipe	EquipmentTrain	EquipmentTrain instance	No
Formula	Formula for the recipe	Formula	Formula instance	No
EnforceFormulaSelection	Flag that requires the user to select a formula when assigning a recipe	Boolean	NA	No
Scale	Scale percentage	Floating point	Numeric	No⁽¹⁾
ScaleUnits	Scale units	String	Any string	No
UnitBindings	Settings for steps and bound units or aliases	UnitBinding[ ]	UnitBinding array	No
UnitAliasing	Settings for aliases and their assigned units	UnitAlias[ ]	UnitAlias array	No

⁽¹⁾ If the Scale of a batch recipe is null, Scale is set to the scale value of the campaign base recipe. This applies even if the batch recipe is different from the campaign base recipe. Client applications must explicitly set a scale value if other behavior is required.

UserInfo

This data contract contains the user information required to perform a service method.

DataMembers	Description	Type	Valid Input	Required
ConfirmerUsername	The DeltaV user account that has access to the Campaign Manager	String	Alphanumeric	Yes
ConfirmerPassword	Password of the user account	String	Alphanumeric	Yes
VerifierUsername	The DeltaV user account of the verifier	String	Alphanumeric	No
VerifierPassword	Verifier password	String	Alphanumeric	No

ExecRecipeInfo

DataMembers	Description	Type	Valid Input	Required
Name	Name of the recipe	String	NA	No
Description	Recipe property	String	NA	No
Abstract	Recipe property	String	NA	No
Area	The plant area associated with a recipe (instance based Unit Procedures or Operations only)	String	NA	No
Type	Whether the recipe is a Operation, Unit Procedure or Procedure	String	NA	No
ClassOrInstance	Whether the Recipe runs on a single unit or any unit in a unit class (Unit Procedures or Operations only)	String	NA	No
BatchRunLength	Recipe property	String	NA	No
BatchSizeDefault	Default size of the created recipe (used for parameter scaling)	Floating point	NA	No
BatchSizeMin	Minimum size of the created recipe (used for parameter scaling)	Floating point	NA	No
BatchSizeMax	Maximum size (see Max Scale Enforced) of the created recipe (used for parameter scaling)	Floating point	NA	No
DefaultFormula	The default formula for enforced formula section	String	NA	No
EnforceFormulaSelection	Flag that requires the user to select a formula when assigning a recipe	Boolean	NA	No
FileName	Recipe download script file name	String	NA	No
MaxScaleEnforced	Whether the scale for an instance of this recipe may exceed 100% or not	Boolean	NA	No
ProductCode	Recipe property	String	NA	No
ProductName	Recipe property	String	NA	No
ProductVersion	Recipe property	String	NA	No
Released	Whether this recipe can be loaded by the operator or not	Bool	NA	No
VersionNumber	Current version of the recipe	String	NA	No
VersionDate	Current modified date of the recipe	DateTime	NA	No
ValidatedAgainst	Recipe property	String	NA	No
ValidationTime	Recipe property	String	NA	No
Author	Recipe property	String	NA	No
ApprovedBy	Recipe property	String	NA	No
FormulaList	List of formulas	String[ ]	NA	No
Parameters	List of formula parameters	Parameter[ ]	NA	No
EquipmentTrains	List of equipment train instances	String	NA	No
Aliases	List of aliases	String	NA	No
Steps	List of steps	String	NA	No
Note: Recipe property indicates that the DataMember is just information that you can associate with the recipe. These members are optional and do not affect recipe execution.

EquipmentTrain

DataMembers	Description	Type	Valid Input	Required
Name	Name of the recipe's selected equipment train	String	Alphanumeric	Yes
Description	The description for the selected equipment train.	String	NA	No

Formula

DataMembers	Description	Type	Valid Input	Required
Name	Formula for the recipe. The default is Default.	String	Alphanumeric	No
Description	Formula description.	String	NA	No
IsCustomFormula	States if the formula is a standard or custom formula.	Boolean	NA	No
Parameters	The selected equipment train's base class	Parameter[ ]	Parameter array	No

Parameter

DataMembers	Description	Type	Valid Input	Required
Name	Parameter name	String	Alphanumeric	Yes
Min	Minimum limit	Floating point	NA	No
Value	The value of the parameter	String	Alphanumeric	Yes
Max	Maximum limit	Floating point	NA	No
EU	Engineering unit	String	NA	No
ParamType	Parameter type	RecipeParamType	NA	No
Scalable	Indicates if the parameter can be scaled	Boolean	NA	No
Locked	Indicates if the parameter is locked in the recipe.	Boolean	NA	No

UnitBinding

DataMembers	Description	Type	Valid Input	Required
StepName	Recipe step	String	Alphanumeric	Yes
UnitName	Bound unit or alias	String	Alphanumeric	Yes
Area	Name of area containing the bound unit	String	NA	No

UnitAlias

DataMembers	Description	Type	Valid Input	Required
AliasName	Alias name	String	Alphanumeric	Yes
UnitName	Unit instance	String	Alphanumeric	Yes
SelectionMode	Selection Mode	Enumeration	SelectionMode instance	No

UnitOrAlias

UnitOrAlias is the base class for the Unit and Alias data contracts. The method GetRecipeUnits return type is UnitOrAlias. The data returned from the method conforms to the Unit or Alias data contract depending on the context of the method's use.

Unit

DataMembers	Description	Type	Valid Input	Required
Name	Name of the unit	String	NA	Yes
Class	Unit class	String	NA	No
ProcessCell	Process cell associated with the unit class	String	NA	No
MaxOwners	Maximum number of owners	Integer	NA	No
DownstreamUnits	List of downstream units	String[ ]	NA	No

Alias

DataMembers	Description	Type	Valid Input	Required
Name	Name of the unit	String	NA	Yes
UnitClass	Unit class	String	NA	No
SelectionMode	Unit selection mode	SelectionMode	NA	No
DownstreamAliases	List of downstream aliases	String array	NA	No

ConfiguredActionInfo

DataMembers	Description	Type	Valid Input	Required
ConfiguredAction	The action to check for confirmer and/or verifier accounts	ConfiguredAction enumeration	NA	Yes
IsConfirmerRequired	States if a confirmer account is required for the specified action	Boolean	NA	Yes
IsVerifierRequired	States if a verifier account is required for the specified action	Boolean	NA	Yes

CampaignStatus

CampaignStatus is an enumeration:

Defining
Defined
Active
Complete
Terminated
Closed
Unknown

BatchStatus

BatchStatus is an enumeration set:

Defining
Defined
Released
ActiveReady
ActiveAborting
ActiveAborted
ActiveHolding
ActiveHeld
ActiveStopping
ActiveStopped
ActiveIdle
ActiveStarting
ActiveRestarting
ActiveRunning
ActiveComplete
CompleteNoError
ReleasedFailed
Closed
LoadFailed
Recovering
RecoverFailed
Lost
Unknown
Releasing
Starting
Removing
CompleteWithError
CompleteNotStarted

BatchExecutionMode

BatchExecutionMode is an enumeration set:

Manual
AutoRelease
AutoStart

ConfiguredAction

ConfiguredAction is an enumeration set:

ReleaseBatch
AddCampaign
ConfiguredClient
RemoveCampaign
ModifyBatch
ModifyCampaign
RemoveBatch
StartBatch
StartClient
StopClient
UnlockCampaign
UserComment

LockAction

LockAction is an enumeration set:

Lock
Unlock

RecipeParamType

RecipeParamType is an enumeration set:

Integer
NamedSet
Real
String
Unknown

SelectionMode

SelectionMode is an enumeration set:

Defer
FromPolicy
DeferAndHasPolicy

Note

Note Use the SelectionMode DeferAndHasPolicy if an alias in a recipe uses a selection policy and you want to use Defer as the binding.