This method creates a campaign within the DeltaV Campaign Manager. The method returns void. Its signature is:
void CreateCampaign( string nodeName, CampaignInfo campaignInfo, UserInfo userInfo );
Parameters for this method are shown in the following table.
Parameter |
Description |
Type |
Valid Input |
|---|---|---|---|
nodeName |
The DeltaV node where the Campaign Manager server is located |
String |
Name of node |
campaignInfo |
Settings for the campaign to be created |
CampaignInfo |
CampaignInfo instance |
userInfo |
Credentials of the user. Can be null if not required |
UserInfo |
UserInfo instance or null |
When creating a campaign using a recipe with a step assigned to a fixed unit, you must define the specific unit under RecipeInfo.UnitBindings. If you leave this null or set it to {Defer} the campaign and batches are created but a LOAD_FAILED error occurs when the batch is released to the Batch Executive. The Campaign Manager web service does not check if a step is assigned to a fixed unit or not.
To ensure that a step is assigned to a fixed unit perform the following checks when you create a campaign:
Call GetExecutiveRecipeInfo to get the recipe steps under the Steps property.
Call GetRecipeUnits to get the list of units for each step.
If only one unit is returned, assign the step to that unit. To prevent errors when releasing a batch to the executive, define values under UnitBinding.StepName and UnitBinding.UnitName of the campaign base recipe.