.NET Based OPC UA Client/Server SDK
Lesson 1: Setting up a Basic OPC UA Server Console Application

The first lesson starts with an empty OPC UA server describing the code for integration of an OPC UA server component into a .NET application and the different server configuration options.

Create an Empty Server

The product specific information integration must be registered with the OPC UA server SDK. This is done by deriving a project specific class form the SDK class ServerManager. In the first step this derived class GettingStartedServerManager in the file GettingStartedServerManager.cs is empty.

internal class GettingStartedServerManager : ServerManager

The main integration code for adding the OPC UA server to the console application can be found in Program.cs

The license for the server SDK must be loaded first from the embedded resource.

To start the server an instance of the GettingStartedServerManager is created and passed to the start method of the default application instance object.

The configuration of the server is done through the App.config file. The configuration options are described later in this lesson.

static void Main(string[] args)
// The license file must be loaded from an embedded resource.
ApplicationLicenseManager.AddProcessLicenses(System.Reflection.Assembly.GetExecutingAssembly(), "License.lic");
// Start the server.
Console.WriteLine("Starting Server.");
GettingStartedServerManager server = new GettingStartedServerManager();
// The following function can be called to configure the server from code
// This will disable the configuration settings from app.config file
ApplicationInstance.Default.AutoCreateCertificate = true;
ApplicationInstance.Default.Start(server, null, server);
// Print endpoints for information.
// Block until the server exits.
Console.WriteLine("Press <enter> to exit the program.");
// Stop the server.
Console.WriteLine("Stopping Server.");
catch (Exception e)
Console.WriteLine("ERROR: {0}", e.Message);
Console.WriteLine("Press <enter> to exit the program.");

The server can be started and a client is able to connect. All information in the server address space is defined by the OPC UA specification. The NamespaceArray contains only two namespaces, the OPC UA defined namespace and the local server namespace.

The method PrintEndpoints is used to print the available endpoints to the command line (just as an information for the server developer).

static void PrintEndpoints(GettingStartedServerManager server)
// print the endpoints.
Console.WriteLine("Listening at the following endpoints:");
foreach (EndpointDescription endpoint in ApplicationInstance.Default.Endpoints)
StatusCode error = server.Application.GetEndpointStatus(endpoint);
Console.WriteLine(" {0}: Status={1}", endpoint, error.ToString(true));

Prepare Integration of Product Specific Information

A product specific NodeManager can be loaded by overwriting OnRootNodeManagerStarted in GettingStartedServerManager.cs.

protected override void OnRootNodeManagerStarted(RootNodeManager nodeManager)
Console.WriteLine("Creating Node Managers.");
Lesson1NodeManager lession1 = new Lesson1NodeManager(this);

The class Lesson1NodeManager is derived from the BaseNodeManager class which forms the Toolkit API. It overloads the methods Startup and Shutdown.

In Lesson1NodeManager.cs, the namespace URI is set in Startup.

public override void Startup()
Console.WriteLine("Starting Lesson1NodeManager.");
// TBD

The server NamespaceArray does now contain a third namespace.

Options for Loading Configuration Settings

The configuration settings are managed by the class ApplicationInstance. The settings can be loaded from XML file or can be set in code.

The Base Library Overview provides more details regarding Application Instance, the Configuration Schema for the configuration options and the Installation Process.

When started and the configuration is not set already, the application instance looks in the following locations for a configuration file:

  1. The value of the /configFile command line parameter;
  2. The value of the ConfigurationFilePath property;
  3. The UaApplicationConfiguration configuration section in the App.config file;
  4. An embedded resource in the entry Assembly with a file name ‘ApplicationSettings.xml’.

The file Program.cs of this lesson contains the following function ConfigureOpcUaApplicationFromCode with sample code to set the configuration settings from code before starting the application instance. The default option used in the server getting started lessons is the App.config file. But ConfigureOpcUaApplicationFromCode can be called instead before starting the application instance.

The standard configuration options can be set directly on the class SecuredApplication.

Additional configuration options like Trace Settings, Server Settings, User Identity Settings, Session Settings and Subscription Settings must be set as extension to the SecuredApplication.

This code requires an assembly reference to System.Runtime.Serialization

static void ConfigureOpcUaApplicationFromCode()
// fill in the application settings in code
// The configuration settings are typically provided by another module
// of the application or loaded from a data base. In this example the
// settings are hardcoded
SecuredApplication application = new SecuredApplication();
// ***********************************************************************
// standard configuration options
// general application identification settings
application.ApplicationName = "UnifiedAutomation GettingStartedServer";
application.ApplicationUri = "urn:localhost:UnifiedAutomation:GettingStartedServer";
application.ApplicationType = UnifiedAutomation.UaSchema.ApplicationType.Server_0;
application.ProductName = "UnifiedAutomation GettingStartedServer";
// configure certificate stores
application.ApplicationCertificate = new UnifiedAutomation.UaSchema.CertificateIdentifier();
application.ApplicationCertificate.StoreType = "Directory";
application.ApplicationCertificate.StorePath = @"%CommonApplicationData%\unifiedautomation\UaSdkNet\pki\own";
application.ApplicationCertificate.SubjectName = "CN=GettingStartedServer/O=UnifiedAutomation/DC=localhost";
application.TrustedCertificateStore = new UnifiedAutomation.UaSchema.CertificateStoreIdentifier();
application.TrustedCertificateStore.StoreType = "Directory";
application.TrustedCertificateStore.StorePath = @"%CommonApplicationData%\unifiedautomation\UaSdkNet\pki\trusted";
application.IssuerCertificateStore = new UnifiedAutomation.UaSchema.CertificateStoreIdentifier();
application.IssuerCertificateStore.StoreType = "Directory";
application.IssuerCertificateStore.StorePath = @"%CommonApplicationData%\unifiedautomation\UaSdkNet\pki\issuers";
application.RejectedCertificatesStore = new UnifiedAutomation.UaSchema.CertificateStoreIdentifier();
application.RejectedCertificatesStore.StoreType = "Directory";
application.RejectedCertificatesStore.StorePath = @"%CommonApplicationData%\unifiedautomation\UaSdkNet\pki\rejected";
// configure endpoints
application.BaseAddresses = new UnifiedAutomation.UaSchema.ListOfBaseAddresses();
application.SecurityProfiles = new ListOfSecurityProfiles();
application.SecurityProfiles.Add(new SecurityProfile() { ProfileUri = SecurityProfiles.Basic256Sha256, Enabled = true });
application.SecurityProfiles.Add(new SecurityProfile() { ProfileUri = SecurityProfiles.None, Enabled = true });
// ***********************************************************************
// ***********************************************************************
// extended configuration options
// trace settings
TraceSettings trace = new TraceSettings();
trace.MasterTraceEnabled = true;
trace.DefaultTraceLevel = UnifiedAutomation.UaSchema.TraceLevel.Info;
trace.TraceFile = @"%CommonApplicationData%\unifiedautomation\logs\ConfigurationServer.log.txt";
trace.MaxLogFileBackups = 3;
trace.ModuleSettings = new ModuleTraceSettings[]
new ModuleTraceSettings() { ModuleName = "UnifiedAutomation.Stack", TraceEnabled = true },
new ModuleTraceSettings() { ModuleName = "UnifiedAutomation.Server", TraceEnabled = true },
// Installation settings
InstallationSettings installation = new InstallationSettings();
installation.GenerateCertificateIfNone = true;
installation.DeleteCertificateOnUninstall = true;
// ***********************************************************************
// set the configuration for the application (must be called before start to have any effect).
// these settings are discarded if the /configFile flag is specified on the command line.