The GlobalDiscoveryServer Information Model used for discovery is shown in Figure 13. Most of the interactions between the GlobalDiscoveryServer and Application administrator or the Client will be via Methods defined on the Directory folder.

Figure 13 – The Address Space for the GDS

This Object is the root of the GlobalDiscoveryServer AddressSpace and it is the target of an Organizes reference from the Objects folder defined in OPC 10000-5. It organizes the information that can be accessed into subfolders. The implementation of a GDS can customize and organize the folders in any manner it desires. For example folders can exist for information models, or for optional services or for various locations in an administrative domain. It is defined in Table 4.

Table 4 – Directory Object Definition

Attribute	Value
BrowseName	2:Directory
TypeDefinition	2:DirectoryType defined in 6.6.3.
References	NodeClass	BrowseName	DataType	TypeDefinition	Modelling Rule
Conformance Units
GDS Application Directory

DirectoryType is the ObjectType for the root of the GlobalDiscoveryServer AddressSpace. It organizes the information that can be accessed into subfolders It also provides methods that allow applications to register or find applications. It is defined in Table 5.

Table 5 – DirectoryType Definition

Attribute	Value
BrowseName	2:DirectoryType
IsAbstract	False
References	NodeClass	BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of the 0:FolderType defined in OPC 10000-5.
0:HasComponent	Object	2:Applications	-	0:FolderType	Mandatory
0:HasComponent	Method	2:FindApplications	Defined in 6.6.4.		Mandatory
0:HasComponent	Method	2:RegisterApplication	Defined in 6.6.6.		Mandatory
0:HasComponent	Method	2:UpdateApplication	Defined in 6.6.7.		Mandatory
0:HasComponent	Method	2:UnregisterApplication	Defined in 6.6.8.		Mandatory
0:HasComponent	Method	2:GetApplication	Defined in 6.6.9.		Mandatory
0:HasComponent	Method	2:QueryApplications	Defined in 6.6.10.		Mandatory
0:HasComponent	Method	2:QueryServers	Defined in 6.6.11.		Mandatory
Conformance Units
GDS Application Directory

The Applications folder may contain Objects representing the Applications known to the GDS. These Objects may be organized into subfolders as determined by the GDS. Some characteristics for organizing applications are the networks, the physical location, or the supported profiles. The QueryApplications Method can be used to search for OPC UA Applications based on various criteria.

A GDS is not required to expose its Applications as browsable Objects in its AddressSpace, however, each Application shall have a unique NodeId which can be passed to Methods used to administer the GDS.

The FindApplications Method returns the Applications associated with an ApplicationUri. It can be called by any Client application.

The RegisterApplication Method is used to add a new Application to the GDS. It requires administrative privileges.

The UpdateApplication Method is used to update an existing Application in the GDS. It requires administrative privileges.

The UnregisterApplication Method is used to remove an Application from the GDS. It requires administrative privileges.

The QueryApplications Method is used to find Client or Server applications that meet the criteria provided. This Method replaces the QueryServers Method.

The QueryServers Method is used to find Servers that meet the criteria specified. It can be called by any Client application. This Method has been replaced by the QueryApplications Method

FindApplications is used to find the ApplicationId for an approved OPC UA Application (see 6.6.6 or 6.4). This list of records returned shall have zero or one element.

If the returned array is null or zero length then the GDS does not have an entry for the ApplicationUri.

Signature

FindApplications(

[in] String applicationUri

[out] ApplicationRecordDataType[] applications

);

Argument	Description
applicationUri	The ApplicationUri that identifies the Application of interest.
applications	A list of application records that match the ApplicationUri. The ApplicationRecordDataType is defined in 6.6.5.

Method Result Codes (defined in Call Service)

Result Code	Description
Bad_UserAccessDenied	The current user does not have the rights required.

Table 6 specifies the AddressSpace representation for the FindApplications Method.

Table 6 – FindApplications Method AddressSpace Definition

Attribute	Value
BrowseName	2:FindApplications
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
0:HasProperty	Variable	0:InputArguments	0:Argument[]	0:PropertyType	Mandatory
0:HasProperty	Variable	0:OutputArguments	0:Argument[]	0:PropertyType	Mandatory

This type defines a DataType which represents a record in the GDS.

If the ApplicationType is Client the serverCapabilities shall include RCP (reverse connect) and all DiscoveryUrls shall begin with the rcp+ prefix which indicates that reverse connections are supported.

If the ApplicationType is ClientAndServer the serverCapabilities may include RCP and all DiscoveryUrls that support reverse connect have the rcp+ prefix. If the same URL supports normal connetions and reverse connection then there shall be two elements in the DiscoveryUrls array with and without the rcp+ prefix.

Table 7 – ApplicationRecordDataType Structure

Name	Type	Description
ApplicationRecordDataType	Structure	Subtype of the Structure DataType defined in OPC 10000-5
applicationId	NodeId	The unique identifier assigned by the GDS to the record. This NodeId may be passed to other Methods.
applicationUri	String	The URI for the Application associated with the record.
applicationType	ApplicationType	The type of application. This type is defined in OPC 10000-4.
applicationNames	LocalizedText[]	One or more localized names for the application. The first element is the default ApplicationName for the application when a non-localized name is needed.
productUri	String	A globally unique URI for the product associated with the application. This URI is assigned by the vendor of the application.
discoveryUrls	String[]	The list of discovery URLs for an application. The first HTTPS URL specifies the domain used as the Common Name of HTTPS Certificates. .
serverCapabilities	String[]	The list of server capability identifiers for the application. The allowed values are defined in Annex D.

Its representation in the AddressSpace is defined in Table 8.

Table 8 – ApplicationRecordDataType Definition

Attribute		Value
BrowseName		2:ApplicationRecordDataType
IsAbstract		False
References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure DataType defined in OPC 10000-5.
Conformance Units
GDS Application Directory

RegisterApplication is used to register a new Application Instance with a GlobalDiscoveryServer.

This Method shall be called from an authenticated SecureChannel and from a Client that has access to the DiscoveryAdmin Role or the ApplicationAdmin Privilege (see 6.2).

Servers that support transparent redundancy shall register as a single application and pass the DiscoveryUrls for all available instances and/or network paths.

Servers that support non-transparent redundancy shall register as different applications. In addition, OPC 10000-4 requires the use of the NTRS ServerCapability defined in Annex D.

RegisterApplication shall not create duplicate records if the ApplicationUri already exists.

If RegisterApplication succeeds the OPC UA Application is approved and is returned by QueryApplications and FindApplications.

If registration was successful and auditing is supported, the GDS shall generate the ApplicationRegistrationChanged AuditEventType (see 6.6.12).

Signature

RegisterApplication(

[in] ApplicationRecordDataType application

[out] NodeId applicationId

);

Argument	Description
application	The application that is to be registered with the GlobalDiscoveryServer.
applicationId	A unique identifier for the registered Application. This identifier is persistent and is used in other Methods used to administer applications.

Method Result Codes (defined in Call Service)

Result Code	Description
Bad_InvalidArgument	The application or one of the fields of the application record is not valid. The text associated with the error shall indicate the exact problem.
Bad_UserAccessDenied	The current user does not have the rights required.

Table 9 specifies the AddressSpace representation for the RegisterApplication Method.

Table 9 – RegisterApplication Method AddressSpace Definition

Attribute	Value
BrowseName	2:RegisterApplication
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
0:HasProperty	Variable	0:InputArguments	0:Argument[]	0:PropertyType	Mandatory
0:HasProperty	Variable	0:OutputArguments	0:Argument[]	0:PropertyType	Mandatory

UpdateApplication is used to update an existing Application in a GlobalDiscoveryServer.

This Method shall be called from an authenticated SecureChannel and from a Client that has access to the DiscoveryAdmin Role, the ApplicationSelfAdmin Privilege, or the ApplicationAdmin Privilege (see 6.2).

If the update was successful and auditing is supported, the GDS shall generate the ApplicationRegistrationChanged AuditEventType (see 6.6.12).

Signature

UpdateApplication(

[in] ApplicationRecordDataType application

);

Argument	Description
application	The application that is to be updated in the GDS database.

Method Result Codes (defined in Call Service)

Result Code	Description
Bad_NotFound	The applicationId is not known to the GDS.
Bad_InvalidArgument	The application or one of the fields of the application record is not valid. The text associated with the error shall indicate the exact problem.
Bad_UserAccessDenied	The current user does not have the rights required.

Table 10 specifies the AddressSpace representation for the UpdateApplication Method.

Table 10 – UpdateApplication Method AddressSpace Definition

Attribute	Value
BrowseName	2:UpdateApplication
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
0:HasProperty	Variable	0:InputArguments	0:Argument[]	0:PropertyType	Mandatory

UnregisterApplication is used to remove an Application from a GlobalDiscoveryServer.

This Method shall be called from an authenticated SecureChannel and from a Client that has access to the DiscoveryAdmin Role, the ApplicationSelfAdmin Privilege, or the ApplicationAdmin Privilege (see 6.2).

This Method shall only be invoked by authorized users.

A Server Application that is unregistered may be automatically added again if the GDS is configured to populate itself by calling FindServersOnNetwork and the Server Application is still registering with its local LDS.

If an Application has Certificates issued by the CertificateManager, these Certificates shall be revoked when this Method is called.

If un-registration was successful and auditing is supported, the GDS shall generate the ApplicationRegistrationChanged AuditEventType (see 6.6.12).

Signature

UnregisterApplication(

[in] NodeId applicationId

);

Argument	Description
applicationId	The identifier assigned by the GDS to the Application.

Method Result Codes (defined in Call Service)

Result Code	Description
Bad_NotFound	The applicationId is not known to the GDS.
Bad_UserAccessDenied	The current user does not have the rights needed to unregister the application.

Table 11 specifies the AddressSpace representation for the UnregisterApplication Method.

Table 11 – UnregisterApplication Method AddressSpace Definition

Attribute	Value
BrowseName	2:UnregisterApplication
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
0:HasProperty	Variable	0:InputArguments	0:Argument[]	0:PropertyType	Mandatory

GetApplication is used to find an OPC UA Application known to the GDS.

Signature

GetApplication(

[in] NodeId applicationId

[out] ApplicationRecordDataType application

);

Argument	Description
applicationId	The ApplicationId that identifies the Application of interest.
application	The application record that matches the ApplicationId. The ApplicationRecordDataType is defined in 6.6.5

Method Result Codes (defined in Call Service)

Result Code	Description
Bad_NotFound	The applicationId is not known to the GDS.
Bad_UserAccessDenied	The current user does not have the rights needed to read the requested record.

Table 12 specifies the AddressSpace representation for the GetApplication Method.

Table 12 – GetApplication Method AddressSpace Definition

Attribute	Value
BrowseName	2:GetApplication
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
0:HasProperty	Variable	0:InputArguments	0:Argument[]	0:PropertyType	Mandatory
0:HasProperty	Variable	0:OutputArguments	0:Argument[]	0:PropertyType	Mandatory

QueryApplications is used to find Client or Server applications that meet the specified filters. The only Clients returned are those that support the reverse connection capability described in OPC 10000-6.

QueryApplications returns ApplicationDescriptions instead of the ServerOnNetwork Structures returned by QueryServers. This is more useful to some Clients because it matches the return type of FindServers.

Any Client is able to call this Method, however, the set of results returned may be restricted based on the Client’s user credentials.

The applications returned shall pass all of the filters provided (i.e. the filters are combined in an AND operation). The capabilities parameter is an array and an application will pass this filter if it supports all of the specified capabilities.

Each time the GDS creates or updates an application record it shall assign a monotonically increasing identifier to the record. This allows Clients to request records in batches by specifying the identifier for the last record received in the last call to QueryApplications. To support this the GDS shall return records in order starting from the lowest record identifier. The GDS shall also return the last time the counter was reset. If a Client detects that this time is more recent than the last time the Client called the Method it shall call the Method again with a startingRecordId of 0.

The lastCounterResetTime parameter is used to indicate that the counters on records had to be reset for some reason such as a Server restart. The Client may not use any nextRecordId received prior to this time to set the value for the startingRecordId in a new call.

The return parameter is a list of ApplicationDescriptions. The mapping from a ApplicationRecord to an ApplicationDescriptions is shown in Table 13.

Table 13 – ApplicationRecordDataType to ApplicationDescription Mapping

ApplicationRecordDataType	ApplicationDescription	Notes
applicationId	--	Ignored
applicationUri	applicationUri
applicationType	applicationType
applicationNames	applicationName	The name that best matches the preferredLocales for the current Session is returned. If there is no Session the first element is returned.
productUri	productUri
discoveryUrls	discoveryUrls
--	gatewayServerUri	Set to NULL.
--	discoveryProfileUri	Set to NULL.
serverCapabilities	--	Ignored

Signature

QueryApplications(

[in] UInt32 startingRecordId

[in] UInt32 maxRecordsToReturn

[in] String applicationName

[in] String applicationUri

[in] UInt32 applicationType

[in] String productUri

[in] String[] capabilities

[out] UtcTime lastCounterResetTime

[out] UInt32 nextRecordId

[out] ApplicationDescription[] applications

);

Argument	Description
INPUTS
startingRecordId	Only records with an identifier greater than this number will be returned. Specify 0 to start with the first record in the database.
maxRecordsToReturn	The maximum number of records to return in the response. 0 indicates that there is no limit.
applicationName	The ApplicationName of the applications to return. Supports the syntax used by the LIKE FilterOperator described in OPC 10000-4. Not used if an empty string is specified. The filter is only applied to the default ApplicationName.
applicationUri	The ApplicationUri of the applications to return. Supports the syntax used by the LIKE FilterOperator described in OPC 10000-4. Not used if an empty string is specified.
applicationType	A mask indicating what types of applications are returned. The mask values are: 0x1 – Servers; 0x2 – Clients; If the mask is 0 then all applications are returned.
productUri	The ProductUri of the applications to return. Supports the syntax used by the LIKE FilterOperator described in OPC 10000-4. Not used if an empty string is specified.
capabilities	The capabilities supported by the applications returned. The applications returned shall support all of the capabilities specified. If no capabilities are provided this filter is not used. The allowed values are defined in Annex D.
OUTPUTS
lastCounterResetTime	The last time the counters were reset.
nextRecordId	The identifier of the next record. It is passed as the startingRecordId in subsequent calls to QueryApplications to fetch the next batch of records. It is 0 if there are no more records to return.
applications	A list of Applications which meet the criteria. The ApplicationDescription structure is defined in OPC 10000-4.

Table 14 specifies the AddressSpace representation for the QueryApplications Method.

Table 14 – QueryApplications Method AddressSpace Definition

Attribute	Value
BrowseName	2:QueryApplications
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
0:HasProperty	Variable	0:InputArguments	0:Argument[]	0:PropertyType	Mandatory
0:HasProperty	Variable	0:OutputArguments	0:Argument[]	0:PropertyType	Mandatory

QueryServers is used to find Server applications that meet the specified filters.

Any Client is able to call this Method, however, the set of results returned may be restricted based on the Client’s user credentials.

The applications returned shall pass all of the filters provided (i.e. the filters are combined in an AND operation). The serverCapabilities parameter is an array and an application will pass this filter if it supports all of the specified capabilities.

Each time the GDS creates or updates an application record it shall assign a monotonically increasing identifier to the record. This allows Clients to request records in batches by specifying the identifier for the last record received in the last call to QueryServers. To support this the GDS shall return records in order starting from the lowest record identifier. The GDS shall also return the last time the counter was reset. If a Client detects that this time is more recent than the last time the Client called the Method it shall call the Method again with a startingRecordId of 0.

The lastCounterResetTime parameter is used to indicate that the counters on records had to be reset for some reason such as a Server restart. The Client may not use any recordId received prior to this time to set the value for the startingRecordId in a new call.

The return parameter is a list of ServerOnNetwork Structures. The mapping from a ApplicationRecordDataType to an ServerOnNetwork is shown in Table 15.

Table 15 – ApplicationRecordDataType to ServerOnNetwork Mapping

ApplicationRecordDataType	ServerOnNetwork	Notes
applicationId	--	Ignored
applicationUri	--	Ignored
applicationType	--	Ignored
applicationNames	serverName	The name that best matches the preferredLocales for the current Session is returned. If there is no Session the first element is returned.
productUri	--	Ignored
discoveryUrls	discoveryUrl	A ServerOnNetwork record is returned for each discoveryUrl in the ApplicationRecord.
serverCapabilities	serverCapabilities
--	recordId	This is the recordId assigned by the QueryServers call. It may be used as the startedRecordId in a subsequent call to QueryServers.

Signature

QueryServers(

[in] UInt32 startingRecordId

[in] UInt32 maxRecordsToReturn

[in] String applicationName

[in] String applicationUri

[in] String productUri

[in] String[] serverCapabilities

[out] UtcTime lastCounterResetTime

[out] ServerOnNetwork[] servers

);

Argument	Description
INPUTS
startingRecordId	Only records with an identifier greater than this number will be returned. Specify 0 to start with the first record in the database.
maxRecordsToReturn	The maximum number of records to return in the response. 0 indicates that there is no limit.
applicationName	The ApplicationName of the Applications to return. Supports the syntax used by the LIKE FilterOperator described in OPC 10000-4. Not used if an empty string is specified. The filter is only applied to the default ApplicationName.
applicationUri	The ApplicationUri of the Servers to return. Supports the syntax used by the LIKE FilterOperator described in OPC 10000-4. Not used if an empty string is specified.
productUri	The ProductUri of the Servers to return. Supports the syntax used by the LIKE FilterOperator described in OPC 10000-4. Not used if an empty string is specified.
serverCapabilities	The applications returned shall support all of the server capabilities specified. If no server capabilities are provided this filter is not used.
OUTPUTS
lastCounterResetTime	The last time the counters were reset.
servers	A list of Servers which meet the criteria. The ServerOnNetwork structure is defined in OPC 10000-4.

Method Result Codes (defined in Call Service)

Result Code	Description
Bad_UserAccessDenied	The current user does not have the rights required.

Table 16 specifies the AddressSpace representation for the QueryServers Method.

Table 16 – QueryServers Method AddressSpace Definition

Attribute	Value
BrowseName	2:QueryServers
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
0:HasProperty	Variable	0:InputArguments	0:Argument[]	0:PropertyType	Mandatory
0:HasProperty	Variable	0:OutputArguments	0:Argument[]	0:PropertyType	Mandatory

This event is raised when the RegisterApplication, UpdateApplication or UnregisterApplication Methods are called.

Its representation in the AddressSpace is formally defined in Table 17.

Table 17 – ApplicationRegistrationChangedAuditEventType Definition

Attribute		Value
BrowseName		2:ApplicationRegistrationChangedAuditEventType
IsAbstract		True
References	NodeClass		BrowseName	DataType	TypeDefinition	ModellingRule
Subtype of the 0:AuditUpdateMethodEventType defined in OPC 10000-5.
Conformance Units
GDS Application Directory

This EventType inherits all Properties of the AuditUpdateMethodEventType. Their semantics are defined in OPC 10000-5.