7 Common parameter type definitions ToC Previous Next

7.8 DiagnosticInfo ToC Previous Next

The components of this parameter are defined in Table 132.

Table 132 – DiagnosticInfo

Name Type Description
DiagnosticInfo structure Vendor-specific diagnostic information.
   namespaceUri Int32 The symbolicId is defined within the context of a namespace. This namespace is represented as a string and is conveyed to the Client in the stringTable parameter of the ResponseHeader parameter defined in 7.29. The namespaceIndex parameter contains the index into the stringTable for this string. -1 indicates that no string is specified.
The namespaceUri shall not be the standard OPC UA namespace. There are no symbolicIds provided for standard StatusCodes.
   symbolicId Int32 The symbolicId shall be used to identify a vendor-specific error or condition; typically the result of some Server internal operation. The maximum length of this string is 32 characters. Servers wishing to return a numeric return code should convert the return code into a string and use this string as symbolicId (e.g., “0xC0040007” or “-4”).
This symbolic identifier string is conveyed to the Client in the stringTable parameter of the ResponseHeader parameter defined in 7.29. The symbolicId parameter contains the index into the stringTable for this string. -1 indicates that no string is specified.
The symbolicId shall not contain StatusCodes. If the localizedText contains a translation for the description of a StatusCode, the symbolicId is -1.
   locale Int32 The locale part of the vendor-specific localized text describing the symbolic id.
This localized text string is conveyed to the Client in the stringTable parameter of the ResponseHeader parameter defined in 7.29. The locale parameter contains the index into the stringTable for this string. -1 indicates that no string is specified.
   localizedText Int32 A vendor-specific localized text string describes the symbolic id. The maximum length of this text string is 256 characters.
This localized text string is conveyed to the Client in the stringTable parameter of the ResponseHeader parameter defined in 7.29. The localizedText parameter contains the index into the stringTable for this string. -1 indicates that no string is specified.
The localizedText refers to the symbolicId if present or the string that describes the standard StatusCode if the Server provides translations. If the index is -1, the Server has no translation to return and the Client should use the invariant StatusCode description from the specification.
   additionalInfo String Vendor-specific diagnostic information.
   innerStatusCode StatusCode The StatusCode from the inner operation.
Many applications will make calls into underlying systems during OPC UA request processing. An OPC UA Server has the option of reporting the status from the underlying system in the diagnostic info.
   innerDiagnosticInfo DiagnosticInfo The diagnostic info associated with the inner StatusCode.

Previous Next