Web service APIs > Campaign Manager API

Campaign Manager sample client

Sample C# code, including a complete application, is included in the DeltaV installation in the directory: \DeltaV\samples\CampaignManager\WCFCMClient\.

The sample application also includes XML usage examples.

To use the sample application:

To set up the sample application:

  1. Run CMSampleClient.exe in \DeltaV\samples\CampaignManager\WCFCMClient\bin

    Note

    Make sure the *.config files in this directory are not read-only.

    The Settings dialog appears.



  2. Enter settings for your system. 

    Some tips:

    • Verify that the correct server name and port number are in the Address field.

    • After editing the Web Service config group, click Set as default to retain your settings the next time you run the client. 

    • The User Credentials group contains the information used by the Connect method. The Username can be any batch user.

    • Set the User Principal Name:

      • In the DeltaV domain environment, use DeltaVAdmin@<DeltaV domain>.

      • In the external domain environment, use DeltaVAdmin@<external domain>.

      • In a workgroup environment, use <machine name>\DeltaVAdmin

  3. Click OK. If your settings are accepted the sample client application appears. When you are using the sample client:

    • To change your settings, select FileConnection.

    • If the service is in a Faulted state, select FileReconnect.

    • If a change is not reflected in the client's interface, select FileRefresh.