DocumentationLinksType TOC Previous Next Specification

AddIn to link documentation provided by the manufacturer and / or end-user.

The representation of the DocumentationLinksType ObjectType in the address space is shown in the following table:

Name Attribute
NodeId ns=1;i=1011
NamespaceUri http://opcfoundation.org/UA/AMB/
BrowseName DocumentationLinksType
NodeClass ObjectType
IsAbstract False
SubtypeOf BaseObjectType
Categories AMB DocumentationLinks Base

The references from the DocumentationLinksType ObjectType Node are shown in the following table:

Reference NodeClass BrowseName DataType TypeDefinition ModellingRule
HasComponent Variable <Link> UriString BaseDataVariableType OptionalPlaceholder
HasComponent Method AddLink     Optional
HasProperty Variable DefaultInstanceBrowseName QualifiedName PropertyType Mandatory
HasComponent Method RemoveLink     Optional

Signature

    AddLink(
        [in]  UriString LinkToExternalSource
        [in]  QualifiedName BrowseName
        [in]  LocalizedText DisplayName
        [in]  LocalizedText Description
        [out] NodeId LinkVariable
    );
Argument Description
LinkToExternalSource Link to an external source. The server might or might not check if a correct URI is provided, or if the URI is available/reachable.
BrowseName The BrowseName of the new created Node. Method fails if a Variable with the same BrowseName already exists.
DisplayName The DisplayName of the new created Node. If the server supports multiple locales, and the Client wants to provide more than one locale, the Write operation on the Variable shall be used.
Description The Description of the new created Node. If the server supports multiple locales, and the Client wants to provide more than one locale, the Write operation on the Variable shall be used.
LinkVariable The NodeId of the newly created Variable.

Signature

    RemoveLink(
        [in]  NodeId VariableToBeDeleted
    );
Argument Description
VariableToBeDeleted NodeId of the Variable containing a link, that should be deleted. Variable shall be referenced from the Object with a HasComponent Reference where the Method is called on.