Search

200 result(s) for Method

• OPC-10000-1 – OPC Unified Architecture - Part 1: Overview and Concepts
  2.1.20 Method
  Method callable software function that is a component of an Object
• OPC-10000-1 – OPC Unified Architecture - Part 1: Overview and Concepts
  6.8 Method Service Set
  Method Service Set Methods represent the function calls of Objects . They are defined in OPC 10000-4 . Methods are invoked and return after completion, whether successful or unsuccessful. Execution times ... Methods may vary, depending on the function they are performing. The Method Service Set defines the means to invoke Methods . A Method is always a component of an Object . Discovery
• OPC-10000-3 – OPC Unified Architecture - Part 3: Address Space Model
  4.8 Methods
  Server and return the result to the client. The lifetime of the Method's invocation instance begins when the client calls the Method and ends when the result is returned ... owning Object or ObjectType is specified in the service call when invoking the Method . While Methods may affect the state of the owning Object , they have no explicit state
• OPC-10000-3 – OPC Unified Architecture - Part 3: Address Space Model
  4.10.3 AddIn model
  Property and the relative path " MyFeature/MyMethodO " can be used for the respective Method
• OPC-10000-3 – OPC Unified Architecture - Part 3: Address Space Model
  5.5.4 Client-side creation of Objects of an ObjectType
  ObjectType . In addition to the AddNodes Service ObjectTypes may have a special Method with the BrowseName " Create ". This Method is used to create an Object of this ObjectType ... This Method may be useful for the creation of Objects where the semantic of the creation should differ from the default behaviour expected in the context of the AddNodes Service
• OPC-10000-3 – OPC Unified Architecture - Part 3: Address Space Model
  5.7.1 Method NodeClass
  Method NodeClass Methods define callable functions. Methods are invoked using the Call Service defined in OPC 10000-4 . Method invocations are not represented in the AddressSpace . Method invocations always ... completion and always return responses when complete. Methods are defined using the Method NodeClass , specified in Table 15 . Table 15 - Method NodeClass Name Use Data Type Description Attributes Base NodeClass
• OPC-10000-3 – OPC Unified Architecture - Part 3: Address Space Model
  5.7.2 HasArgumentDescription ReferenceType
  ReferenceType - extends the semantic of the HasComponent ReferenceType to reference argument Metadata of a Method NodeClass . The SourceNode of this ReferenceType shall be a Method and the TargetNode of this
• OPC-10000-3 – OPC Unified Architecture - Part 3: Address Space Model
  5.8.6.1 Overview
  only be used on Variables used as instances, never on InstanceDeclarations or VariableTypes . For Method Arguments , it can be used in combination with the HasArgumentDescription
• OPC-10000-3 – OPC Unified Architecture - Part 3: Address Space Model
  6.2.1 InstanceDeclaration
  InstanceDeclaration An InstanceDeclaration is an Object , Variable or Method that references a ModellingRule with a HasModellingRule Reference and is the TargetNode of a hierarchical Reference from a TypeDefinitionNode or another
• OPC-10000-3 – OPC Unified Architecture - Part 3: Address Space Model
  6.2.4 Similar Node of InstanceDeclaration
  Objects the same TypeDefinitionNode or a subtype of it. In the case of a Method a similar Node of an InstanceDeclaration is a Node that also has the same arguments
• OPC-10000-3 – OPC Unified Architecture - Part 3: Address Space Model
  6.3.3.3 Overriding InstanceDeclarations
  added. A subtype shall not override an argument of its supertype's Method InstanceDeclaration which is defined with a concrete DataType. Method arguments defined with an abstract DataType ... overridden . A subtype shall not remove an argument of its supertype's Method InstanceDeclaration . A subtype shall not add mandatory additional arguments however it may append optional arguments after
• OPC-10000-3 – OPC Unified Architecture - Part 3: Address Space Model
  6.4.4.4.4 OptionalPlaceholder
  used to define the BrowseName where subtypes and instances provide more information. The Method definition with the OptionalPlaceholder only defines the BrowseName. An instance or subtype defines the InputArguments ... OutputArguments . A subtype shall also change the ModellingRule to Optional or Mandatory . The Method is optional for instances. For example, a Device might have a Method to perform calibration however
• OPC-10000-3 – OPC Unified Architecture - Part 3: Address Space Model
  6.4.4.4.5 MandatoryPlaceholder
  used to define the BrowseName where subtypes and instances provide more information. The Method definition with the MandatoryPlaceholder only defines the BrowseName. An instance or subtype defines the InputArguments ... OutputArguments . A subtype shall also change the ModellingRule to Mandatory . The Method is mandatory for instances
• OPC-10000-3 – OPC Unified Architecture - Part 3: Address Space Model
  7.7 HasComponent ReferenceType
  deleted. The TargetNode of this ReferenceType shall be a Variable , an Object or a Method . If the TargetNode is a Variable , the SourceNode shall be an Object , an ObjectType ... Variable is defined as DataVariable . If the TargetNode is an Object or a Method , the SourceNode shall be an Object or ObjectType
• OPC-10000-3 – OPC Unified Architecture - Part 3: Address Space Model
  7.12 HasModellingRule ReferenceType
  semantic of this ReferenceType is to bind the ModellingRule to an Object , Variable or Method . The ModellingRule mechanisms are described in 6.4.4 . The SourceNode of this ReferenceType shall ... Object , Variable or Method . The TargetNode shall be an Object of the ObjectType "ModellingRule" or one of its subtypes. Each Node shall be the SourceNode of at most
• OPC-10000-3 – OPC Unified Architecture - Part 3: Address Space Model
  7.15 GeneratesEvent
  Events instances of ObjectTypes or VariableTypes may generate and Methods may generate on each Method call. The SourceNode of References of this type shall be an ObjectType , a VariableType ... Method InstanceDeclaration . The TargetNode of this ReferenceType shall be an ObjectType representing EventTypes , that is, the BaseEventType or one of its subtypes
• OPC-10000-3 – OPC Unified Architecture - Part 3: Address Space Model
  7.16 AlwaysGeneratesEvent
  ReferenceType is to identify the types of Events Methods have to generate on each Method call. The SourceNode of References of this type shall be a Method InstanceDeclaration . The TargetNode
• OPC-10000-3 – OPC Unified Architecture - Part 3: Address Space Model
  8.6 Argument
  Argument This Structured DataType defines a Method input or output argument specification. It is for example used in the input and output argument Properties for Methods . Its elements are described
• OPC-10000-3 – OPC Unified Architecture - Part 3: Address Space Model
  8.55 PermissionType
  EventType Nodes or SourceNodes . Call 12 The Client is allowed to call the Method if this bit is set on the Object or ObjectType Node passed in the Call request ... Method Instance associated with that Object or ObjectType . This bit affects the UserExecutable Attribute when set on Method Node . This Permission is only valid for Objects, ObjectType or Methods . AddReference
• OPC-10000-3 – OPC Unified Architecture - Part 3: Address Space Model
  9.29 AuditUpdateMethodEventType
  AuditUpdateMethodEventType This is a subtype of AuditEventType and is used for categorization of Method related Events . This type follows all behaviours of its parent type
• OPC-10000-3 – OPC Unified Architecture - Part 3: Address Space Model
  A.6 Methods
  necessary to do in OPC COM since there was no concept of a Method available. However, a simple OPC COM wrapper might not be able to do this. Methods
• OPC-10000-3 – OPC Unified Architecture - Part 3: Address Space Model
  C.2.2 Simple notation
  part of the DisplayName of the ReferenceType . The font shall be set in italic. Method Oval including text representing the string-part of the DisplayName of the Method . The font
• OPC-10000-4 – OPC Unified Architecture - Part 4: Services
  4.1 Service Set model
  read and write the values of Variables . Figure 6 - Attribute Service Set The Method Service Set is illustrated in Figure 7 . It defines Services that allow Clients to call methods ... Methods run to completion when called. They may be called with method-specific input parameters and may return method-specific output parameters. Figure 7 - Method Service Set The MonitoredItem Service
• OPC-10000-4 – OPC Unified Architecture - Part 4: Services
  5.12.1 Overview
  Execution times for Methods may vary, depending on the function that they perform. The Method Service Set defines the means to invoke Methods . A Method shall be a component ... that identify their supported Methods . Because Methods may control some aspect of plant operations, Method invocation may depend on environmental or other conditions. This may be especially true when attempting
• OPC-10000-4 – OPC Unified Architecture - Part 4: Services
  5.12.2.1 Description
  list of Methods . This Service provides for passing input and output arguments to/from a Method . These arguments are defined by Properties of the Method . If the Method is invoked ... context of a Session and the Session is terminated, the results of the Method's execution cannot be returned to the Client and are discarded. This is independent
• OPC-10000-4 – OPC Unified Architecture - Part 4: Services
  5.12.2.2 Parameters
  NodeId The NodeId shall be that of the Object or ObjectType on which the Method is invoked. In case of an Object, the Object or the ObjectType of the Object ... source of a HasComponent Reference (or subtype of HasComponent Reference ) to the Method specified in methodId . In case of an ObjectType , the ObjectType shall be the source of a HasComponent
• OPC-10000-4 – OPC Unified Architecture - Part 4: Services
  5.12.2.4 StatusCodes
  address space. Bad_NotExecutable The executable Attribute does not allow the execution of the Method . Bad_ArgumentsMissing The Client did not specify all of the non-optional input arguments ... Method . Bad_TooManyArguments The Client specified more input arguments than defined for the Method . Bad_InvalidArgument See Table 178 for the description of this result code. Used to indicate
• OPC-10000-4 – OPC Unified Architecture - Part 4: Services
  5.13.2.1 Description
  that should not be interrupted. To resolve this situation, the Server Object provides a Method GetMonitoredItems that returns the list of Server and client handles for the monitored items ... Subscription . This Method is defined in OPC 10000-5 . The Server shall verify that the Method is called within the Session context of the Session that owns the Subscription
• OPC-10000-4 – OPC Unified Architecture - Part 4: Services
  6.6.5 Manually Forcing Failover
  range. This can be done through a Server specific configuration tool or through the Method RequestServerStateChange on the ServerType . The Method is formally defined in OPC 10000-5 . This Method
• OPC-10000-4 – OPC Unified Architecture - Part 4: Services
  6.7 Re-establishing connections
  able to get the lost NotificationMessages through Republish , the Client should use the Method ResendData or should read the values of all data MonitoredItems to make sure the Client ... data should be sent in the next regular PublishingInterval . The Server Object provides a Method ResendData that initiates resending of all data monitored items in a Subscription . This Method
• OPC-10000-4 – OPC Unified Architecture - Part 4: Services
  6.8 Durable Subscriptions
  should persist the queues frequently even if the Server is not shut down. The Method SetSubscriptionDurable defined in OPC 10000-5 is used to set a Subscription into this durable ... allow much longer lifetimes and queue sizes than for normal Subscriptions . The Method shall be called before the MonitoredItems are created in the durable Subscription . The Server shall verify that
• OPC-10000-4 – OPC Unified Architecture - Part 4: Services
  7.24.1 Overview
  VariableAttributes Defines the Attributes for the Variable NodeClass . MethodAttributes Defines the Attributes for the Method NodeClass . ObjectTypeAttributes Defines the Attributes for the ObjectType NodeClass . VariableTypeAttributes Defines the Attributes
• OPC-10000-4 – OPC Unified Architecture - Part 4: Services
  7.24.4 MethodAttributes parameter
  parameter. Table 153 - MethodAttributes Name Type Description MethodAttributes structure Defines the Attributes for the Method NodeClass specifiedAttributes UInt32 A bit mask that indicates which fields contain valid values. A field
• OPC-10000-5 – OPC Unified Architecture - Part 5: Information Model
  5.5 Methods
  Table 7 shall be set as specified in Table 7 . Table 7 - Common Method Attributes Attributes Value Executable All Methods defined in this specification shall be executable ( Executable Attribute ... True"), unless it is defined differently in the Method definition. UserExecutable The value of the UserExecutable Attribute is server-specific. It is assumed that all Methods can be executed
• OPC-10000-5 – OPC Unified Architecture - Part 5: Information Model
  6.3.1 ServerType
  VendorServerInfoType Mandatory HasComponent Object ServerRedundancy 1 - ServerRedundancyType Mandatory HasComponent Object Namespaces - NamespacesType Optional HasComponent Method GetMonitoredItems Defined in 9.1 Optional HasComponent Method ResendData Defined in 9.2 Optional HasComponent Method SetSubscriptionDurable ... Defined in 9.3 Optional HasComponent Method RequestServerStateChange Defined in 9.4 Optional Conformance Units Base Info ServerType ServerArray defines an array of Server URIs. This Variable is also referred
• OPC-10000-5 – OPC Unified Architecture - Part 5: Information Model
  6.3.2 ServerCapabilitiesType
  unsigned integer specifying the maximum number of parallel continuation points of the LogObject GetRecords method that the Server can support per session. The value specifies the maximum the Server ... Property indicates the maximum length of a one or multidimensional array supported by Variables, Method arguments and Event fields of the Server . In a multidimensional array it indicates the overall
• OPC-10000-5 – OPC Unified Architecture - Part 5: Information Model
  6.3.12 AddressSpaceFileType
  DataType TypeDefinition Modelling Rule Subtype of the FileType defined in OPC 10000-20 HasComponent Method ExportNamespace The method has no parameters. Optional Conformance Units Base Info ServerType The ExportNamespace Method ... they represent static configuration information. The client is expected to call the ExportNamespace Method first to update the XML file and then access the file with the Methods defined
• OPC-10000-5 – OPC Unified Architecture - Part 5: Information Model
  6.3.15 NonTransparentBackupRedundancyType
  HasProperty Variable RedundantServerArray RedundantServerDataType[] PropertyType Mandatory HasProperty Variable Mode RedundantServerMode PropertyType Mandatory HasComponent Method Failover The method has no parameters. Mandatory Conformance Units Redundancy Server The Mode Property represents ... higher ServiceLevel value for BACKUP_READY than BACKUP_NOT_READY . The Failover Method is used to request a manual transfer of primary and backup modes. This method has no arguments
• OPC-10000-5 – OPC Unified Architecture - Part 5: Information Model
  6.4.3 AuditEventType
  PropertyType Optional Conformance Units Auditing Connections Auditing NodeManagement Auditing History Services Auditing Write Auditing Method This EventType inherits all Properties of the BaseEventType . Their semantic is defined ... related to the source of the AuditEvents . If the AuditEvent is related to a Method invocation, then typically this Property would be "Method/" concatenated with the name
• OPC-10000-5 – OPC Unified Architecture - Part 5: Information Model
  6.4.27 AuditUpdateMethodEventType
  Variable InputArguments BaseDataType[] PropertyType Mandatory HasProperty Variable OutputArguments BaseDataType[] PropertyType Optional Conformance Units Auditing Method Auditing Method Output This EventType inherits all Properties of the AuditEventType . Their semantic is defined ... this type shall be assigned to the NodeId of the Object that the Method resides on. The SourceName for Events of this type shall be "Attribute/Call". Note that
• OPC-10000-5 – OPC Unified Architecture - Part 5: Information Model
  6.4.37 AuditClientUpdateMethodResultEventType
  AuditClientUpdateMethodResultEventType This EventType allows Method calls issued by a Client to be audited. Its representation in the AddressSpace is formally defined in Table 61 . Table 61 - AuditClientUpdateMethodResultEventType definition Attribute Value ... single Client action may generate several Events of this type, one per Method called. ObjectId identifies the Object on which the Method was called. The ExpandedNodeId shall use a namespaceUri
• OPC-10000-5 – OPC Unified Architecture - Part 5: Information Model
  9.1 GetMonitoredItems
  subscriptionId clientHandles Array of clientHandles for all MonitoredItems of the Subscription identified by subscriptionId Method Result Codes (defined in Call Service) Result Code Description Bad_SubscriptionIdInvalid Defined ... UserAccessDenied Defined in OPC 10000-4 The Method was not called in the context of the Session that owns the Subscription . Table 118 specifies the AddressSpace representation for the GetMonitoredItems
• OPC-10000-5 – OPC Unified Architecture - Part 5: Information Model
  9.2 ResendData
  Signature ResendData( [in] UInt32 subscriptionId ); Argument Description subscriptionId Identifier of the Subscription to resend. Method Result Codes (defined in Call Service) Result Code Description Bad_SubscriptionIdInvalid Defined ... UserAccessDenied Defined in OPC 10000-4 The Method was not called in the context of the Session that owns the Subscription . Table 119 specifies the AddressSpace representation for the ResendData
• OPC-10000-5 – OPC Unified Architecture - Part 5: Information Model
  9.3 SetSubscriptionDurable
  SetSubscriptionDurable SetSubscriptionDurable Method is used to set a Subscription into a mode where MonitoredItem data and event queues are stored and delivered even if an OPC UA Client was disconnected ... Subscription . revisedLifetimeInHours The revised lifetime in hours the Server applied to the durable Subscription . Method Result Codes (defined in Call Service) Result Code Description Bad_SubscriptionIdInvalid Defined
• OPC-10000-5 – OPC Unified Architecture - Part 5: Information Model
  9.4 RequestServerStateChange
  RequestServerStateChange The Method RequestServerStateChange allows a Client to request a state change in the Server . The Client shall provide credentials with administrative rights when invoking this Method on the Server ... changes it state to SHUTDOWN_4 before the restart if secondsTillShutdown is not 0. Method Result Codes (defined in Call Service) Result Code Description Bad_UserAccessDenied The current user
• OPC-10000-5 – OPC Unified Architecture - Part 5: Information Model
  12.43 TrimmedString
  which has no leading or trailing whitespace. When a TrimmedString is specified as a Method input argument or written to a Variable and the incoming TrimmedString contains leading or trailing
• OPC-10000-6 – OPC Unified Architecture - Part 6: Mappings
  5.1.9 Variant
  DataValue . Variants can contain DataValue when used in other contexts such as Method Arguments or PubSub Messages . The Variant in a DataValue cannot, directly or indirectly, contain another DataValue . ExtensionObjects
• OPC-10000-6 – OPC Unified Architecture - Part 6: Mappings
  F.7 UAInstance
  UAVariable Defines a Variable Node as described in OPC 10000-3 . UAMethod Defines a Method Node as described in OPC 10000-3 . UAView Defines a View Node as described
• OPC-10000-6 – OPC Unified Architecture - Part 6: Mappings
  F.9 UAMethod
  UAMethod is a subtype of the UAInstance defined in F.7 . It represents a Method Node. The fields in the UAMethod type are defined in Table F.9 . Table F.9 - UAMethod Element ... fields from the UAInstance type described in F.7 . MethodDeclarationId NodeId May be specified for Method Nodes that are a target of a HasComponent reference from a single Object Node
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  4.2 Conditions
  performed. The Server will generate AuditEvents for Enable and Disable operations (either through a Method call or some Server / vendor - specific means), rather than generating an AuditEvent Notification for each
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  4.5 Condition state synchronization
  required to maintain an Event history. Clients request a Refresh by calling the ConditionRefresh Method . The Server will respond with a RefreshStartEventType Event . This Event is followed by the Retained
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  4.10 Condition instances in the AddressSpace
  AddressSpace is not always possible, doing so allows for direct interaction (read, write and Method invocation) with a specific Condition instance. For example, if a Condition instance is not exposed ... there is no way to invoke the Enable or Disable Method for the specific Condition instance
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  4.11 Alarm and Condition auditing
  this information is required in many cases. Audit records are generated for all Method calls that affect the state of the system, for example, an Acknowledge Method call would generate ... without adding new fields to them. This document describes the AuditEventType that each Method shall generate if Audit Events are supported by the Server . For example, the Disable Method
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.5.2 ConditionType
  Mandatory HasComponent Variable Comment LocalizedText ConditionVariableType Mandatory HasProperty Variable ClientUserId String PropertyType Mandatory HasComponent Method Disable Defined in Clause 5.5.4 Mandatory HasComponent Method Enable Defined in Clause 5.5.5 Mandatory HasComponent ... Method AddComment Defined in Clause 5.5.6 Mandatory HasComponent Method ConditionRefresh Defined in Clause 5.5.7 HasComponent Method ConditionRefresh2 Defined in Clause 5.5.8 ConformanceUnits A & C Basic Table 9 - ConditionType Additional
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.5.4 Disable Method
  Disable Method The Disable Method is used to change a Condition instance to the Disabled state. Normally, the NodeId of the object instance as the ObjectId is passed ... instances in the AddressSpace. Therefore, all Servers shall allow Clients to call the Disable Method by specifying ConditionId as the ObjectId. The Method cannot be called with an ObjectId
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.5.5 Enable Method
  Enable Method The Enable Method is used to change a Condition instance to the enabled state. Normally, the NodeId of the object instance as the ObjectId is passed ... instances in the AddressSpace. Therefore, all Servers shall allow Clients to call the Enable Method by specifying ConditionId as the ObjectId. The Method cannot be called with an ObjectId
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.5.6 AddComment Method
  AddComment Method The AddComment Method is used to apply a comment to a specific state of a Condition instance. Normally, the NodeId of the Object instance is passed ... AddressSpace. Therefore, all Servers shall also allow Clients to call the AddComment Method by specifying ConditionId as the ObjectId. The Method cannot be called with an ObjectId of the ConditionType
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.5.7 ConditionRefresh Method
  ConditionRefresh Method ConditionRefresh allows a Client to request a Refresh of all Condition instances that currently are in an interesting state (they have the Retain flag set). This includes previous ... Condition instance for which the Server maintains Branches . A Client would typically invoke this Method when it initially connects to a Server and following any situations, such as communication disruptions
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.5.8 ConditionRefresh2 Method
  ConditionRefresh2 Method ConditionRefresh2 allows a Client to request a Refresh of all Condition instances that currently are in an interesting state (they have the Retain flag set) that are associated ... other respects it functions as ConditionRefresh. A Client would typically invoke this Method when it initially connects to a Server and following any situations, such as communication disruptions where resynchronization
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.6.2 DialogConditionType
  Mandatory HasProperty Variable OkResponse Int32 PropertyType Mandatory HasProperty Variable CancelResponse Int32 PropertyType Mandatory HasComponent Method Respond Defined in Clause 5.6.3 . Mandatory HasComponent Method Respond2 Defined in Clause 5.6.4 . Optional ConformanceUnits ... used for the corresponding fields like DefaultResponse , LastResponse and SelectedOption in the Respond Method . The recommended localized names for the common options are described in A.1 . Typical combinations of response
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.6.3 Respond Method
  Respond Method Respond is used to pass the selected response option and end the dialog. DialogState/Id will return to False. Signature Respond( [in] Int32 SelectedResponse ); The parameters are defined ... Table 26 - Respond parameters Argument Description SelectedResponse Selected index of the ResponseOptionSet array. Method result codes in Table 27 (defined in Call Ser v ice) Table 27 - Respond Result Codes
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.6.4 Respond2 Method
  Respond2 Method Respond2 Method extends the respond method by adding a comment field. For other functionality see the Respond Method definition. Signature Respond2( [in] Int32 SelectedResponse [in] LocalizedText Comment ... unchanged. To reset the comment, an empty text with a locale shall be provided. Method result codes in Table 30 (defined in Call Ser v ice) Table 30 - Respond2 Result
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.7.3 Acknowledge Method
  Acknowledge Method The Acknowledge Method is used to acknowledge an Event Notification for a Condition instance state where AckedState is False. Normally, the NodeId of the object instance is passed ... Condition instances in the AddressSpace. Therefore, Servers shall allow Clients to call the Acknowledge Method by specifying ConditionId as the ObjectId. The Method cannot be called with an ObjectId
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.7.4 Confirm Method
  Confirm Method The Confirm Method is used to confirm an Event Notifications for a Condition instance state where ConfirmedState is False. Normally, the NodeId of the object instance is passed ... Condition instances in the AddressSpace. Therefore, Servers shall allow Clients to call the Confirm Method by specifying ConditionId as the ObjectId. The Method cannot be called with an ObjectId
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.8.2 AlarmConditionType
  OptionalPlaceholder HasProperty Variable ReAlarmTime Duration PropertyType Optional HasComponent Variable ReAlarmRepeatCount Int16 BaseDataVariableType Optional HasComponent Method Reset Defined in 5.8.5 Optional HasComponent Method Reset2 Defined in 5.8.6 5.8.5 Optional HasComponent Method ... Silence Defined in 5.8.7 Optional HasComponent Method Suppress Defined in 5.8.8 Optional HasComponent Method Suppress2 Defined in 5.8.9 Optional HasComponent Method Unsuppress Defined in 5.8.10 Optional HasComponent Method Unsuppress2 Defined
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.8.5 Reset Method
  Reset Method The Reset Method is used reset a latched Alarm instance. It is only available on an instance of an AlarmConditionType that exposes the LatchedState . Normally, the NodeId ... Condition instances in the AddressSpace. Therefore, Servers shall allow Clients to call the Reset Method by specifying ConditionId as the ObjectId. The Method cannot be called with an ObjectId
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.8.6 Reset2 Method
  Reset2 Method The Reset2 Method extends the Reset Method , by adding an optional Comment . For other functionality see the Reset Method definition. Signature Reset2( [in] LocalizedText Comment ); The parameters ... defined in Table 46. Table 46 - Reset2 Method parameters Argument Description Comment A localized text that shall be applied to the Condition . If the Comment argument is NULL (both locale
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.8.7 Silence Method
  Silence Method The Silence Method is used silence a specific Alarm instance. It is only available on an instance of an AlarmConditionType that also exposes the SilenceState . Normally, the NodeId ... Condition instances in the AddressSpace. Therefore, Servers shall allow Clients to call the Silence Method by specifying ConditionId as the ObjectId. The Method cannot be called with an ObjectId
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.8.8 Suppress Method
  Suppress Method The Suppress Method is used to suppress a specific Alarm instance. It is only available on an instance of an AlarmConditionType that also exposes the SuppressedState . This Method ... SuppressedState of an Alarm and overwrite any suppression caused by an associated AlarmSuppressionGroup . This Method works in parallel with any suppression triggered by an AlarmSuppressionGroup , in that if the Method
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.8.9 Suppress2 Method
  Suppress2 Method The Suppress2 Method extends the Suppress Method , by adding an optional Comment . For other functionality see the Suppress Method definition. Signature Suppress2( [in] LocalizedText Comment ); The parameters ... defined in Table 53 Table 53 - Suppress2 Method parameters Argument Description Comment A localized text that shall be applied to the Condition . If the Comment argument is NULL (both locale
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.8.10 Unsuppress Method
  Unsuppress Method The Unsuppress Method is used to clear the SuppressedState of a specific Alarm instance. It is only available on an instance of an AlarmConditionType that also exposes ... SuppressedState . This Method can be used to overwrite any suppression cause by an associated AlarmSuppressionGroup. This Method works in parallel with any suppression triggered by an AlarmSuppressionGroup, in that
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.8.11 Unsuppress2 Method
  Unsuppress2 Method The Unsuppress2 Method extends the Suppress Method , by adding an optional Comment . For other functionality see the Unsuppress Method definition. Signature Unsuppress2( [in] LocalizedText Comment ); The parameters ... defined in Table 58. Table 58 - Unsuppress2 Method parameters Argument Description Comment A localized text that shall be applied to the Condition . If the Comment argument is NULL (both locale
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.8.12 RemoveFromService Method
  RemoveFromService Method The RemoveFromService Method is used to suppress a specific Alarm instance. It is only available on an instance of an AlarmConditionType that also exposes the OutOfServiceState . Normally ... Condition instances in the AddressSpace. Therefore, Servers shall allow Clients to call the RemoveFromService Method by specifying ConditionId as the ObjectId. The Method cannot be called with an ObjectId
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.8.13 RemoveFromService2 Method
  RemoveFromService2 Method The RemoveFromService2 Method extends the RemoveFromService Method , by adding an optional Comment . For other functionality see the RemoveFromService Method definition. Signature RemoveFromService2( [in] LocalizedText Comment ); The parameters ... defined in Table 63 Table 63 - RemoveFromService2 Method parameters Argument Description Comment A localized text that shall be applied to the Condition . If the Comment argument is NULL (both locale
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.8.14 PlaceInService Method
  PlaceInService Method The PlaceInService Method is used to set the OutOfServiceState to False of a specific Alarm instance. It is only available on an instance of an AlarmConditionType that also ... Condition instances in the AddressSpace. Therefore, Servers shall allow Clients to call the PlaceInService Method by specifying ConditionId as the ObjectId. The Method cannot be called with an ObjectId
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.8.15 PlaceInService2 Method
  PlaceInService2 Method The PlaceInService2 Method extends the PlaceInService Method , by adding an optional Comment . For other functionality see the PlaceInService Method definition. Signature PlaceInService2( [in] LocalizedText Comment ); The parameters ... defined in Table 68. Table 68 - PlaceInService2 Method parameters Argument Description Comment A localized text that shall be applied to the Condition . If the Comment argument is NULL (both locale
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.8.16 GetGroupMemberships Method
  GetGroupMemberships Method The GetGroupMemberships Method is used to find the list of AlarmGroups that this alarm is in. Signature GetGroupMemberships( [out] NodeId[] Group ); Method result codes in Table 71 (defined ... NodeIdInvalid Used to indicate that the specified ObjectId is not valid or that the Method was called on the AlarmConditionType Node . See 10000-4 for the general description of this
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.8.17.1 Overview
  ShelvedStateMachine shall be set to Unshelved . All but two transitions are caused by Method calls as illustrated in Figure 16 . The "Time Expired" transition is simply a system ... TransitionType HasComponent Object UnshelvedToOneShotShelved TransitionType HasComponent Object OneShotShelvedToUnshelved TransitionType HasComponent Object OneShotShelvedToTimedShelved TransitionType HasComponent Method TimedShelve Defined in Clause 5.8.17.4 Mandatory HasComponent Method OneShotShelve Defined in Clause 5.8.17.6 Mandatory HasComponent
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.8.17.2 Unshelve Method
  Unshelve Method The Unshelve Method sets the instance of AlarmConditionType to the Unshelved state. Normally, the MethodId found in the Shelving child of the Condition instance and the NodeId ... AddressSpace. Therefore, all Servers shall also allow Clients to call the Unshelve Method by specifying ConditionId as the ObjectId where the ConditionId is the Condition that has Shelving child
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.8.17.3 Unshelve2 Method
  Unshelve2 Method The Unshelve2 Method extends the Unshelve Method , by adding an optional Comment . For other functionality see the Unshelve Method definition. Signature Unshelve2( [in] LocalizedText Comment ); The parameters ... defined in Table 78 Table 78 - Unshelve2 Method parameters Argument Description Comment A localized text that shall be applied to the Conditions . If the Comment argument is NULL (both locale
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.8.17.4 TimedShelve Method
  TimedShelve Method The TimedShelve Method sets the instance of AlarmConditionType to the TimedShelved state (parameters are defined in Table 81 and result codes are described in Table 82 ). Normally ... AddressSpace. Therefore, all Servers shall also allow Clients to call the TimedShelve Method by specifying ConditionId as the ObjectId where the ConditionId is the Condition that has the Shelving child
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.8.17.5 TimedShelve2 Method
  TimedShelve2 Method The TimedShelve Method extends the TimedShelve Method , by adding an optional Comment . For other functionality see the TimedShelve Method definition. Signature TimedShelve2( [in] Duration ShelvingTime [in] LocalizedText Comment ... this Property. Comment A localized text that shall be applied to the Condition . Method Result Codes in Table 85 (defined in Call Service) Table 85 - TimedShelve2 result codes Result Code
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.8.17.6 OneShotShelve Method
  OneShotShelve Method The OneShotShelve Method sets the instance of AlarmConditionType to the OneShotShelved state. Normally, the MethodId found in the Shelving child of the Condition instance and the NodeId ... AddressSpace. Therefore, all Servers shall also allow Clients to call the OneShotShelve Method by specifying ConditionId as the ObjectId where the ConditionId is the Condition that has the Shelving child
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.8.17.7 OneShotShelve2 Method
  OneShotShelve2 Method The OneShotShelve2 Method Signature OneShotShelve2( [in] LocalizedText Comment ); The parameters are defined in Table 89. Table 89 - OneShotShelve2 Method parameters Argument Description Comment A localized text that shall ... unchanged. To reset the comment, an empty text with a locale shall be provided. Method Result Codes are defined in Table 90 (status code field is defined in Call
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.10.1 Overview
  Figure 24 . Figure 24 - AuditEvent hierarchy AuditConditionEventTypes are normally used in response to a Method call. However, these Events shall also be notified if the functionality of such a Method
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.10.3 AuditConditionEnableEventType
  indicate Method/Enable or Method/Disable. If the audit Event is not the result of a Method call, but due to an internal action of the Server, the SourceName shall reflect Enable
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.10.8 AuditConditionShelvingEventType
  inheriting the InstanceDeclarations of that Node. ConformanceUnits A & C Shelving Auditing If the Method indicates a TimedShelve operation, the ShelvingTime field shall contain duration for which to shelve
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  5.12 HasCondition Reference type
  this case the SourceNode of this ReferenceType shall be an Object , Variable or Method Node . The TargetNode shall be a Condition instance or a ConditionType . Table 136 - HasCondition ReferenceType Definition
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  9.2 AlarmMetricsType
  Mandatory HasComponent Variable MaximumReAlarmCount UInt32 BaseDataVariableType Mandatory HasComponent Variable AverageAlarmRate Double AlarmRateVariableType Mandatory HasComponent Method Reset Mandatory ConformanceUnits A & C Alarm Metrics An instance of AlarmMetricsType can be added ... time at which the Server started or the time of the last Reset Method invocation, whichever is later. MaximumActiveState is the maximum time for which an Alarm
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  9.4 Reset Method
  Reset Method The Reset Method is used reset all of the counters, rates and time in the Object Signature Reset(); Method Result Codes in Table 51 (defined in Call Service ... general description of this result code. Comments The Reset Method will clear all setting in the diagnostic object and initialize them to zero. Table 148 specifies the AddressSpace representation
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  Annex C Mapping to EEMUA (Informative)
  awareness of its presence. In OPC UA this can be accomplished with the Acknowledge Method . Active Alarm Active = True An Alarm Condition which is on (i.e. limit has been exceeded
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  D.2.1 Event areas
  single UA Server . The Area hierarchy is discovered with the BrowseOPCAreas and the GetQualifiedAreaName Method s. The Area name returned by BrowseOPCAreas is used as the BrowseName and DisplayName
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  D.2.2 Event sources
  HasEventSource Reference . The Sources are discovered by calling BrowseOPCAreas and the GetQualifiedSourceName Method s. The Source name returned by BrowseOPCAreas is used as the BrowseName and DisplayName. The QualifiedSourceName
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  D.2.6 Condition instances
  address space. Condition s can be acknowledged by passing the EventId to the Acknowledge Method defined on the AcknowledgeableConditionType . Condition s cannot be enabled or disabled
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  D.2.7 Condition Refresh
  does not store the state of Condition s. When ConditionRefresh is called the Refresh Method is called on all COM AE Subscription s associated with the ConditionRefresh call. The wrapper
• OPC-10000-9 – OPC Unified Architecture - Part 9: Alarms & Conditions
  D.3.5 Event Category attribute mapping
  Event which is currently unacknowledged (AckRequired = True), the UA A & C Server Acknowledge Method associated with the Condition is called and the subsequent Event produced
• OPC-10000-10 – OPC Unified Architecture - Part 10: Programs
  3.1.4 Program Control Method
  Program Control Method Method having specific semantics designed for the control of a Program by causing a state transition
• OPC-10000-10 – OPC Unified Architecture - Part 10: Programs
  4.2.7 Program Control Methods
  Program . Table 4 lists the set of defined Program Control Methods. Each Method causes transitions from specified states and shall be called when the Program is in one of those ... behaviour of the base Program Finite State Machine . Table 4 - Program Control Methods Method Name Description Start Causes the Program to transition from the Ready state to the Running state
• OPC-10000-10 – OPC Unified Architecture - Part 10: Programs
  4.2.10.1 Overview
  creatable, then the Client can add the Program to the Server . The Object Create Method defined in OPC 10000-3 , is used to create the Program instance. The initial state
• OPC-10000-10 – OPC Unified Architecture - Part 10: Programs
  4.2.10.2 Program instances
  Instances can be run in parallel . For example , the Program may define a Start Method that has an input argument to specify which resource is acted upon by its Functions
• OPC-10000-10 – OPC Unified Architecture - Part 10: Programs
  5.2.4.1 Overview
  includes references to the Causes of specific Program state transitions. These causes refer to Method instances . Programs that do not support a Program Control Method will omit the Causes reference ... that Method from the ProgramStateMachineType references. If a Method's Causes reference is omitted from the ProgramStateMachineType then a Client cannot cause the associated state transition. The Method instances referenced
• OPC-10000-10 – OPC Unified Architecture - Part 10: Programs
  5.2.4.2 Standard attributes
  Standard attributes The Executable Method attribute indicates if a method can currently be executed. For Program Control Methods , this means that the owning Program has a current state that supports ... transition caused by the Method
• OPC-10000-10 – OPC Unified Architecture - Part 10: Programs
  5.2.5.1 Overview
  allows the auditing of changes to the Program 's state in conjunction with Client Method Calls
• OPC-10000-10 – OPC Unified Architecture - Part 10: Programs
  5.2.6 AuditProgramTransitionEventType
  means to audit the Program State transitions associated with any Client invoked Program Control Method. Servers shall generate AuditProgramTransitionEvents if auditing is supported. Table 10 specifies the definition ... identifies whether the state transition resulted from a Program Control Method call (set Status to TRUE) or not (set Status to FALSE). The SourceName specified in OPC 10000-5 , identifies
• OPC-10000-10 – OPC Unified Architecture - Part 10: Programs
  5.2.8 ProgramDiagnostic2 DataType
  CreateSessionId contains the SessionId of the Session on which the call to the Create Method was issued to create the Program Invocation . createClientName String The CreateClientName is the name ... last Program state transition that occurred. lastMethodCall String The LastMethodCall identifies the last Program Method called on the Program Invocation . lastMethodSessionId NodeId The LastMethodSessionId contains the SessionId of the Session
• OPC-10000-10 – OPC Unified Architecture - Part 10: Programs
  A.2.4.1 General
  specified . The base behaviours of these Methods are defined by the ProgramStateMachineType. The Start Method initiates the download activity and passes the source and destination locations for the transfer ... Suspend Method is used to pause the activity temporarily. The Resume Method reinitiates the download, when paused. The Halt Method aborts the download. Each of the Methods causes a Program
• OPC-10000-10 – OPC Unified Architecture - Part 10: Programs
  A.2.6.2 DomainDownloadType
  Machine Types , TransferStateMachine and FinishStateMachine . The DomainDownloadType omits references to the Reset Program Control Method and its associated state transition (HaltedToReady), which it does not support. Table A.2 - DomainDownloadType Attribute ... TransitionType HasComponent Object RunningToSuspended TransitionType HasComponent Object SuspendedToRunning TransitionType HasComponent Object SuspendedToHalted TransitionType HasComponent Method Start Mandatory HasComponent Method Suspend Mandatory HasComponent Method Halt Mandatory HasComponent Method Resume Mandatory HasComponent
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  3.1.18 Privilege
  entry: for example, a Privilege can be defined when the right to call a Method depends on the parameters passed to the Method . Note 2 to entry: a Privilege
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  4.3.5 Global Discovery
  access the GDS, the Client uses the Call service to invoke the QueryApplications Method (see 6.5.11 ) to retrieve a list of Servers that meet the filter criteria provided. The QueryApplications ... Method is similar to the FindServers service except that it provides more advanced search and filter criteria. The discovery process is illustrated in Figure 5 . Figure 5 - The Global Discovery
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  4.4.3 Global Discovery for Reverse Connections
  domain of the GDS. The SecurityAdmin uses the Call service to invoke the QueryApplications Method (see 6.5.11 ) with "RCP" as a ServerCapabilityFilter to get a list of Clients
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  6.4 Application Registration Workflow
  check if there is already a registration available for the ApplicationUri . The DirectoryType Method FindApplications is used to pass the ApplicationUri of the application to the GDS. The Method returns ... fatal error and the status must be verified with a DiscoveryAdmin . RegisterApplication The DirectoryType Method RegisterApplication is used to pass in an application record with the application information
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  6.5.3 DirectoryType
  HasComponent Object 2:Applications - 0:FolderType Mandatory 0:HasComponent Method 2:FindApplications Defined in 6.5.4 . Mandatory 0:HasComponent Method 2:RegisterApplication Defined in 6.5.6 . Mandatory 0:HasComponent Method 2:UpdateApplication ... Defined in 6.5.7 . Mandatory 0:HasComponent Method 2:UnregisterApplication Defined in 6.5.8 . Mandatory 0:HasComponent Method 2:GetApplication Defined in 6.5.9 . Mandatory 0:HasComponent Method 2:QueryApplications Defined
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  6.5.6 RegisterApplication
  RegisterApplication The RegisterApplication Method is used to register a new applicationwith a GlobalDiscoveryServer . This Method shall be called from an authenticated SecureChannel and from a Client that has access ... Annex D . RegisterApplication shall not create duplicate records. If the ApplicationUri already exists the Method returns Bad_EntryExists . If RegisterApplication succeeds the application is added to the list of applications
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  6.5.7 UpdateApplication
  UpdateApplication The UpdateApplication Method 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 ... updating an existing application the ApplicationUri cannot be changed. If it is changed the Method returns Bad_WriteNotSupported . If the update was successful and auditing is supported, the GDS shall
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  6.5.8 UnregisterApplication
  UnregisterApplication The UnregisterApplication Method 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 ... 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
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  6.5.10 QueryApplications
  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 ... application will pass this filter if it supports all of the specified Capabilities. This Method shall not return records with a ServerCapabilities that includes NA. Each time the GDS creates
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  6.5.11 QueryServers (deprecated)
  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 ... application will pass this filter if it supports all of the specified Capabilities. This Method shall not return records with a ServerCapabilities that includes NA. Each time the GDS creates
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.4 Push Management
  signs the Certificate, the new Certificate is pushed to the Server with the UpdateCertificate Method . There are two use cases for PushManagement: Management of a Server via the ServerConfiguration Object ... Configuration Database is used by the Server to persist its configuration information. The RegisterApplication Method (or internal equivalent) is assumed to have been called before the sequence in the diagram
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.6 Pull Management Workflow
  pair creation are described in Figure 16 . The boxes with blue text indicate Method calls. Figure 15 - Certificate Pull Management Workflow Figure 16 - The Pull Management Options for Key Pair ... SigningRequestPending If one or more signing requests are pending for a CertificateGroup , the FinishRequest Method is called directly with the ApplicationId and the RequestId for the pending signing request
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.7.2 Update Certificates Workflow
  required. It is shown in Figure 17 . The boxes with blue text indicate Method calls. Figure 17 - PushManagement Update Multiple Certificates Workflow The steps of the workflow are described
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.7.3 Update TrustList Workflow
  standalone workflow. It is shown in Figure 18 . The boxes with blue text indicate Method calls. Figure 18 - PushManagement Update TrustList Workflow The steps of the PushManagement Update TrustList workflow
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.7.4 Update Single Certificate Workflow
  required. It is shown in Figure 19 . The boxes with blue text indicate Method calls. Figure 19 - PushManagement Update Certificate Workflow The steps of the workflow are described in Table ... useable Certificate does not exist a new self-signed Certificate is generated. CreateSelfSignedCertificate This Method creates a new self-signed Certificate using field values provided by the CertificateManager . This Method
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.7.5 Create Endpoint Workflow
  another workflow. It is shown in Figure 20 . The boxes with blue text indicate Method calls. Figure 20 - PushManagement Create Endpoint Workflow The steps of the workflow are described
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.7.6 Update Configuration Workflow
  another workflow. It is shown in Figure 21 . The boxes with blue text indicate Method calls. Figure 21 - PushManagement Update Configuration Workflow The steps of the workflow are described ... least the RestartDelayTime period but no longer than the RevertAfterTime period. ConfigurationFileType:: ConfirmUpdate This Method tells the Server that the changes can be made permanent because the CertificateManager could reconnect
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.8.2.1 TrustListType
  file for writing the Server will not actually update the TrustList until the CloseAndUpdate Method is called. Simply calling Close will discard the updates. The bit Masks in TrustListDataType structure ... PropertyType Optional 0:HasProperty Variable 0:DefaultValidationOptions TrustListValidationOptions 0:PropertyType Optional 0:HasComponent Method 0:OpenWithMasks Defined in 7.8.2.2 . Mandatory 0:HasComponent Method 0:CloseAndUpdate Defined in 7.8.2.5 . Mandatory
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.8.2.2 Open
  Open The Open Method is inherited from FileType which is defined in OPC 10000-5 . The Open Method shall not support modes other than Read (0x01) and the Write + EraseExisting ... SecureChannel is not authenticated the Server shall return Bad_SecurityModeInsufficient . Method Result Codes Result Code Description Bad_NotSupported The mode is not supported. Bad_TransactionPending The TrustList cannot be opened
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.8.2.3 OpenWithMasks
  OpenWithMasks The OpenWithMasks Method allows a Client to read only a portion of the TrustList. This Method can only be used to read the TrustList . After calling this Method ... detect out of band changes to theTrustList before the Client calls the Close Method , then the next Read returns Bad_InvalidState . If the Server cannot detect out of band changes
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.8.2.4 Read
  Read The Read Method is inherited from FileType which is defined in OPC 10000-5 . If the Server is able to detect out of band changes to the TrustList before ... Client calls the Close Method , then this Method returns Bad_InvalidState . Additional Method Result Codes Result Code Description Bad_InvalidState The state of the TrustList has changed
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.8.2.5 CloseAndUpdate
  CloseAndUpdate The CloseAndUpdate Method closes the TrustList and applies the changes to the TrustList . It can only be called if the TrustList was opened for writing. If the Close Method ... untrusted or revoked Certificate shall be closed. This process may not complete before the Method returns and could take a significant amount of time on systems with limited resources
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.8.2.6 AddCertificate
  AddCertificate The AddCertificate Method allows a Client to add a single Certificate to the TrustList . The Purpose of the associated CertificateGroup determines the validation rules for the Certificate . For ApplicationCertificateType ... Purposes other than ApplicationCertificateType , the validation rules are not defined by this specification. This Method will return a validation error if the Certificate is issued
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.8.2.7 RemoveCertificate
  RemoveCertificate The RemoveCertificate Method allows a Client to remove a single Certificate from the TrustList . It returns Bad_InvalidArgument if the Thumbprint does not match a Certificate in the TrustList ... that has CRLs then all CRLs for that CA are removed as well. This Method returns Bad_CertificateChainIncomplete if the Certificate is a CA Certificate needed to validate another Certificate
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.8.2.12 TrustListUpdateRequestedAuditEventType
  TrustListUpdateRequestedAuditEventType This event is raised when a Method that changes the TrustList is called It is raised when CloseAndUpdate, AddCertificate or RemoveCertificate Method on a TrustListType Object is called
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.8.2.13 TrustListUpdatedAuditEventType
  raised when a TrustList is successfully changed. This is the result of a CloseAndUpdate Method on a TrustListType Object or the result of a ApplyChanges Method on the ServerConfigurationType Object ... being called. It shall also be raised when the AddCertificate or RemoveCertificate Method causes an update to the TrustList . Its representation in the AddressSpace is formally defined in Table
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.8.3.1 CertificateGroupType
  HasComponent Object 0:TrustListOutOfDate 0:TrustListOutOfDateAlarmType Optional 0:HasCondition ObjectType 0:TrustListOutOfDateAlarmType 0:HasComponent Method 0:GetRejectedList Defined in 7.8.3.2 . Optional Conformance Units GDS Certificate Manager Pull Model Push Model ... TrustListOutOfDate Alarms , the corresponding HasCondition References shall be specified on the instance. The GetRejectedList Method returns the list of Certificates that have been rejected by the Server when using
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.8.3.2 GetRejectedList
  GetRejectedList GetRejectedList Method returns the list of Certificates that have been rejected by the Server . No rules are defined for how the Server updates this list or how long ... list that have no unsuppressed validation errors but are not trusted. For PullManagement , this Method is not present on the CertificateGroup . For PushManagement , this Method shall be called from
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.8.3.4 CertificateGroupDataType
  update is rejected if a Certificate is assigned to a deleted CertificateType . The DeleteCertificate Method is used to remove Certificates . The Purpose imposes restrictions on the allowed CertificateTypes . The update
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.8.5.1 ConfigurationFileType
  applications. This should be ConfigureAdmin , SecurityAdmin or an equivalent administrative Role . The Open Method shall not support modes other than Read (0x01) and Read + Write (0x03). When a Client opens ... Client shall follow the following steps. Read the existing configuration with the FileType Read Method . Set the position to the beginning of the file with the FileType SetPosition Method . Write
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.8.5.2 CloseAndUpdate
  CloseAndUpdate The CloseAndUpdate Method closes the ConfigurationFile and applies the changes to the configuration. It can only be called if the ConfigurationFile was opened for writing. If the Close Method ... previous configuration if the Client is not able to reconnect and call the ConfirmUpdate Method . If auditing is supported, the Server shall generate the ConfigurationUpdatedAuditEventType (see 7.8.5.8 ) when the configuration
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.8.5.3 ConfirmUpdate
  ConfirmUpdate The ConfirmUpdate Method allows a Client to confirm that it can connect after the configuration has been applied. The Client shall disconnect from the Server and reconnect before calling ... ConfirmUpdate . The RevertAfterTime parameter passed to the CloseAndUpdate Method specifies how long the Server shall wait for confirmation. If the Server could not apply all changes then the return code
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.9.2 CertificateDirectoryType
  defined in 6.5.3 . 0:Organizes Object 2:CertificateGroups 0:CertificateGroup FolderType Mandatory 0:HasComponent Method 2:StartSigningRequest Defined in 7.9.3 . Mandatory 0:HasComponent Method 2:StartNewKeyPairRequest Defined in 7.9.4 . Mandatory ... HasComponent Method 2:FinishRequest Defined in 7.9.5 . Mandatory 0:HasComponent Method 2:RevokeCertificate Defined in 7.9.6 . Optional 0:HasComponent Method 2:GetCertificateGroups Defined in 7.9.7 . Mandatory 0:HasComponent Method
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.9.3 StartSigningRequest
  StartSigningRequest The StartSigningRequest Method is used to initiate a request to create a Certificate which uses the private key which the caller currently has. The new Certificate is returned ... passed to FinishRequest . The call returns the NodeId that is passed to the FinishRequest Method . The CertificateGroupId parameter allows the caller to specify a CertificateGroup that provides context
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.9.4 StartNewKeyPairRequest
  StartNewKeyPairRequest The StartNewKeyPairRequest Method is used to start a request for a new Certificate and Private Key . The Certificate and Private Key . are returned in the FinishRequest response. Signature StartNewKeyPairRequest ... passed to FinishRequest . The call returns the NodeId that is passed to the FinishRequest Method . The CertificateGroupId parameter allows the caller to specify a CertificateGroup that provides context
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.9.5 FinishRequest
  FinishRequest The FinishRequest Method is used to finish a certificate request started with a call to StartNewKeyPairRequest or StartSigningRequest . Signature FinishRequest ( [in] NodeId ApplicationId [in] NodeId RequestId [out] ByteString Certificate ... StartNewKeyPairRequest or StartSigningRequest . It is expected that a Client will periodically call this Method until an entity with access to the RegistrationAuthorityAdmin Role has approved the request. If the Client
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.9.6 RevokeCertificate
  RevokeCertificate The RevokeCertificate Method is used to revoke a Certificate issued by the CertificateManager . When a Certificate is revoked it shall be removed from any TrustLists that ... Certificates assigned to an application are automatically revoked when the UnregisterApplication Method is called (see 6.5.8 ). This Method shall be called from an authenticated SecureChannel and from a Client that
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.9.7 GetCertificateGroups
  GetCertificateGroups The GetCertificateGroups Method returns the CertificateGroups assigned to application. Signature GetCertificateGroups( [in] NodeId ApplicationId [out] NodeId[] CertificateGroupIds ); Argument Description ApplicationId The identifier assigned to the application ... TrustList and one or more CertificateTypes which may be assigned to an application. This Method shall be called from an authenticated SecureChannel and from a Client that has access
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.9.8 GetCertificates
  GetCertificates The GetCertificates Method returns the Certificates assigned to the application and associated with the CertificateGroup . This Method shall be called from an authenticated SecureChannel and from a Client that ... encoded Certificates assigned to application. This list only includes Certificates that are currently valid. Method Result Codes (defined in Call Service) Result Code Description Bad_NotFound The ApplicationId does
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.9.9 GetTrustList
  GetTrustList The GetTrustList Method is used to retrieve the NodeId of a TrustList assigned to an application. Signature GetTrustList( [in] NodeId ApplicationId [in] NodeId CertificateGroupId [out] NodeId TrustListId ); Argument Description ... application. Access permissions also apply to the TrustList Objects which are returned by this Method . This TrustList includes any Certificate Revocation Lists (CRLs) associated with issuer Certificates in the TrustList
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.9.10 GetCertificateStatus
  GetCertificateStatus The GetCertificateStatus Method is used to check if an application has to update its Certificate . If this Method is called for a CertificateGroup which the application does not belong ... then the Method shall return UpdateRequired =TRUE. This Method shall be called from an authenticated SecureChannel and from a Client that has access to the CertificateAuthorityAdmin Role, the ApplicationAdmin Privilege
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.9.11 CheckRevocationStatus
  CheckRevocationStatus CheckRevocationStatus Method is used to check the revocation status of a Certificate. Clients or Servers may use this Method if the issuer Certificate has a crlDistributionPoint extension, an authorityInformationAccess ... revocation status check (see OPC 10000-4 ) on the Certificate before calling this Method . The CertificateManager shall check the Signature on the Certificate and may do additional validation. This Method
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.9.12 CertificateRequestedAuditEventType
  rejected by the CertificateManager . This can be the result of a StartNewKeyPairRequest or StartSigningRequest Method calls. Its representation in the AddressSpace is formally defined in Table 84 . Table 84 - CertificateRequestedAuditEventType
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.9.13 CertificateDeliveredAuditEventType
  delivered by the CertificateManager to a Client . This is the result of a FinishRequest Method completing successfully. Its representation in the AddressSpace is formally defined in Table 85 . Table
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.10.2 Transaction Lifecycle
  These transactions are created automatically and the Server returns ApplyChangesRequired =TRUE in a Method response to tell the Client that a transaction is active. Servers that do not support transactions ... return ApplyChangesRequired =FALSE and apply any changes before returning a Method response. If a Method called within a transaction fails (e.g. a parameter was invalid) the transaction state shall
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.10.3 ServerConfigurationType
  PropertyType Optional 0:HasProperty Variable 0:InApplicationSetup 0:Boolean 0:PropertyType Optional 0:HasComponent Method 0:UpdateCertificate See 7.10.5 . Mandatory 0:HasComponent Method 0:CreateSelfSignedCertificate See 7.10.6 . Optional 0:HasComponent ... Method 0:DeleteCertificate See 7.10.7 . Optional 0:HasComponent Method 0:GetCertificates See 7.10.8 . Optional 0:HasComponent Method 0:ApplyChanges See 7.10.9 . Mandatory 0:HasComponent Method 0:CancelChanges See 7.10.11 . Optional
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.10.5 UpdateCertificate
  used to update a Certificate . There are the following two use cases for this Method : The PrivateKey is already known to the Server (i.e. it was created with the CreateSigningRequest ... CreateSelfSignedCertificate (see 7.10.6 ) Method ). The PrivateKey was created outside the Server and is updated with this Method . The Purpose of the associated CertificateGroup determines the validation rules for Certificate being
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.10.6 CreateSelfSignedCertificate
  CreateSelfSignedCertificate CreateSelfSignedCertificate Method creates a new self-signed Certificate and associates it with a CertificateGroup . This Method allows an administration Client to create a Certificate used by the Server ... generate PrivateKeys for the specified CertificateType then the Server shall return Bad_NotSupported . This Method shall be called from an authenticated SecureChannel and from a Client that has access
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.10.7 DeleteCertificate
  DeleteCertificate DeleteCertificate Method a Certificate that is associated with a CertificateGroup . If no Certificate is assigned to the CertificateType slot then a Bad_InvalidState error is returned. If a transaction ... deleted. This determination happens when ApplyChanges is called. ApplyChanges is always required when this Method is called. The Server is responsible for managing the lifetime of the PrivateKeys associated with
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.10.8 GetCertificates
  GetCertificates The GetCertificates Method returns the Certificates assigned to CertificateTypes associated with a CertificateGroup . This Method shall be called from an authenticated SecureChannel and from a Client that has access ... CertificateType for the Certificate is specified by the corresponding element in the CertificateTypeIds parameter. Method Result Codes (defined in Call Service) Result Code Description Bad_UserAccessDenied The current user does
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.10.9 ApplyChanges
  ApplyChanges The ApplyChanges Method is used to apply pending Certificate and TrustList updates and to complete a transaction as described in 7.10.2 . ApplyChanges returns Bad_InvalidState if any TrustList ... immediately affected. This ensures the caller of ApplyChanges can get a response to the Method call. Once the Method response is returned the Server shall force existing SecureChannels affected
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.10.10 CreateSigningRequest
  CreateSigningRequest CreateSigningRequest Method asks the Server to create a PKCS #10 DER encoded Certificate Request that is signed with the Server's private key. The Certificate Request can be then ... pair for each combination of CertificateGroupId and CertificateTypeId . If this Method is called multiple times with the same CertificateGroupId and CertificateTypeId then any previously generated new key pair, that
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.10.11 CancelChanges
  CancelChanges The CancelChanges Method is used to tell the Server to discard changes to the TrustLists or Certificates which were waiting for the Client to ApplyChanges . This Method shall ... created the transaction and has access to the SecurityAdmin Role (see 7.2 ). Signature CancelChanges(); Method Result Codes (defined in Call Service) Result Code Description Bad_UserAccessDenied The current user does
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.10.12 GetRejectedList
  GetRejectedList GetRejectedList Method returns the list of Certificates that have been rejected by the Server . No rules are defined for how the Server updates this list or how long ... size is not large enough to allow the entire list to be returned. This Method shall be called from an authenticated SecureChannel and from a Client that has access
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.10.13 ResetToServerDefaults
  ResetToServerDefaults The ResetToServerDefaults Method resets an application configuration to its default settings. If the application is running on a Device that supports OPC 10000-21 , the Device is placed ... Setup process described in Annex G . If the application is a Server , after this Method completes the Server shall set the ServerState to SHUTDOWN and the shutdownReason to a localized
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.10.26 CertificateUpdateRequestedAuditEventType
  CertificateUpdateRequestedAuditEventType This event is raised when the UpdateCertificate Method is called. If a PrivateKey was one of the InputArguments then that argument is set to NULL before generating this Event
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  7.10.27 CertificateUpdatedAuditEventType
  event is raised when a Certificate is actually changed as a result of a Method call. This is the result of a successful call to UpdateCertificate or ApplyChanges ... ServerConfigurationType Object . No Event is raised if the Method call fails. If ApplyChanges affects multiple Certificates then this Event is raised for each changed Certificate . Its representation in the AddressSpace
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  8.5.4 KeyCredentialServiceType
  PropertyType Mandatory 0:HasProperty Variable 2:SecurityPolicyUris 0:String[] 0:PropertyType Optional 0:HasComponent Method 2:StartRequest Defined in 8.5.5 . Mandatory 0:HasComponent Method 2:FinishRequest Defined in 8.5.6 . Mandatory ... HasComponent Method 2:Revoke Defined in 8.5.7 . Optional Conformance Units Pull Model for KeyCredential ServicePull Model for KeyCredential Service The ResourceUri Property uniquely identifies the resource that accepts the KeyCredentials
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  8.5.5 StartRequest
  request. The SecurityPolicyUri specifies the security profile used for the encryption. This Method shall be called from an encrypted SecureChannel and from a Client that has access to the KeyCredentialAdmin ... identifier for the request. This identifier shall be passed to the FinishRequest (see 8.5.6 ). Method Result Codes (defined in Call Service) Result Code Description Bad_NotFound The ApplicationUri
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  8.5.6 FinishRequest
  Client should call again. It is expected that a Client will periodically call this Method until the KeyCredentialService has completed the request. This Method shall be called from an encrypted ... KeyCredentialAdmin Role, the ApplicationAdmin Privilege , or the ApplicationSelfAdmin Privilege (see 8.2 ) . In addition, this Method shall only be called SecureChannel using that same Certificate that Client used to call StartRequest
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  8.5.7 Revoke
  Revoke The Revoke Method is used to revoke a KeyCredential used by a Client or Server . KeyCredentials shall be deleted when revoked. This Method shall be called from an encrypted ... Signature Revoke ( [in] String CredentialId ); Argument Description CredentialId The unique identifier for the KeyCredential . Method Result Codes (defined in Call Service) Result Code Description Bad_InvalidArgument The CredentialId is does
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  8.5.9 KeyCredentialRequestedAuditEventType
  accepted or rejected by the Server . This can be the result of a StartRequest Method call. Its representation in the AddressSpace is formally defined in Table 130 . Table 130 - KeyCredentialRequestedAuditEventType
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  8.5.10 KeyCredentialDeliveredAuditEventType
  delivered by the Server to an application. This is the result of a FinishRequest Method completing. Its representation in the AddressSpace is formally defined in Table 131 . Table 131 - KeyCredentialDeliveredAuditEventType
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  8.5.11 KeyCredentialRevokedAuditEventType
  raised when a KeyCredential is revoked. This is the result of a RevokeKeyCredential Method completing. Its representation in the AddressSpace is formally defined in Table 132 . Table 132 - KeyCredentialRevokedAuditEventType Definition
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  8.6.3 CreateCredential
  CreateCredential CreateCredential is used to add a new KeyCredentialConfiguration Object . This Method shall be called from an encrypted SecureChannel and from a Client that has access to the SecurityAdmin Role ... URLs shall be provided. CredentialNodeId A unique identifier for the new KeyCredentialConfiguration Object Node . Method Result Codes (defined in Call Service) Result Code Description Bad_InvalidArgument The ResourceUri, ProfileUri
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  8.6.5 KeyCredentialConfigurationType
  PropertyType Optional 0:HasProperty Variable 0:ServiceStatus 0:StatusCode 0:PropertyType Optional 0:HasComponent Method 0:GetEncryptingKey Defined in 8.6.6 . Optional 0:HasComponent Method 0:UpdateCredential Defined in 8.6.7 . Optional ... HasComponent Method 0:DeleteCredential Defined in 8.6.8 . Optional Conformance Units Push Model for KeyCredential Service The ResourceUri Property uniquely identifies the resource that accepts the KeyCredentials . The ProfileUri Property specifies
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  8.6.6 GetEncryptingKey
  GetEncryptingKey The GetEncryptingKey Method is used to request a key that can be used to encrypt a KeyCredential . This Method shall be called from an encrypted SecureChannel and from ... also specifies the contents of the PublicKey . This may be different from the RequestedSecurityPolicyUri. Method Result Codes (defined in Call Service) Result Code Description Bad_InvalidArgument The CredentialId
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  8.6.7 UpdateCredential
  UpdateCredential The UpdateCredential Method is used to update a KeyCredential used by a Server . The KeyCredential secret may be encrypted using the key returned by GetEncryptingKey . The SecurityPolicyUri species ... used for encryption. The format of the encrypted data is described in 8.5.6 . This Method shall be called from an encrypted SecureChannel and from a Client that has access
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  8.6.8 DeleteCredential
  DeleteCredential The DeleteCredential Method is used to delete a KeyCredential used by a Server . This Method shall be called from an encrypted SecureChannel and from a Client that has access ... SecurityAdmin Role (see 8.2 ) . Signature DeleteCredential(); Method Result Codes (defined in Call Service) Result Code Description Bad_UserAccessDenied The current user does not have the rights required. Bad_SecurityModeInsufficient
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  8.6.9 KeyCredentialUpdatedAuditEventType
  which are authorized to view such information. This is the result of a UpdateCredential Method completing. Its representation in the AddressSpace is formally defined in Table 140 . Table 140 - KeyCredentialUpdatedAuditEventType
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  8.6.10 KeyCredentialDeletedAuditEventType
  raised when a KeyCredential is updated. This is the result of a DeleteCredential Method completing. Its representation in the AddressSpace is formally defined in Table 141 . Table 141 - KeyCredentialDeletedAuditEventType Definition
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  9.3 Implicit
  with a call to CreateSession or it can be implicit via a Session -less Method Call. With this use case, the Client uses the EndpointDescriptions provided by the "Authorization
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  9.4 Explicit
  case describes how a Client authenticates itself with a UserIdentityToken provided in the FinishRequestToken Method call. User credentials for Session with the Authorization Server are not required. This use case ... Client . The StartRequestToken and FinishRequestToken Methods can be invoked via Session -less Method calls
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  9.5 Chained
  Identity Service" is inserted before the Client calls the StartRequestToken Method
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  9.6.4 AuthorizationServiceType
  PropertyType Optional 0:HasProperty Variable 2:SupportedRoles 0:String[] 0:PropertyType Optional 0:HasComponent Method 2:RequestAccessToken Defined in 9.6.5 . Optional 0:HasComponent Method 2:StartRequestToken Defined in 9.6.6 . Optional ... HasComponent Method 2:FinishRequestToken Defined in 9.6.7 . Optional 0:HasComponent Method 2:RefreshToken Defined in 9.6.8 . Optional 0:HasComponent Method 2:GetServiceDescription Defined in 9.6.9 . Mandatory 0:GeneratesEvent ObjectType
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  9.6.5 RequestAccessToken (Deprecated)
  RequestAccessToken is used to request an AccessToken from an AuthorizationService . The scenarios where this Method is used are described fully in 9.3 , 9.4 and 9.5 . The PolicyId and UserTokenType ... UserIdentityToken provided for the Session (or the request if using a Session -less Method Call ) to determine privileges. If the associated UserTokenPolicy provides a SecurityPolicyUri , then the IdentityToken is encrypted
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  9.6.6 StartRequestToken
  StartRequestToken The StartRequestToken Method is used to initiate a new request for an AccessToken. The PolicyId provided shall identify one of the UserTokenPolicies for the AuthorizationService Object . The contents ... service. The AuthorizationService cleans up unused requestIds . Client should call FinishRequestToken immediately after this Method returns. The RequestId is only accessible via the current Session and resources are freed when
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  9.6.7 FinishRequestToken
  FinishRequestToken The FinishRequestToken Method is used to complete a request for an AccessToken from an AuthorizationService . It is called after calling StartRequestToken defined in 9.6.6 . The RequestedRoles are used ... where the ServiceData replaces the ServerNonce and the RequestorData replaces the ClientNonce . This Method shall be called from an encrypted SecureChannel and from a Client that has access
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  9.6.8 RefreshToken
  RefreshToken The RefreshToken Method is used to request an AccessToken from an AuthorizationService using a cached RefreshToken. The CurrentRefreshToken shall only be accepted if the ClientCertificate used to create ... SecureChannel is the same as the ClientCertificate used when the FinishRequestToken Method returned the original RefeshToken . This Method shall be called from an encrypted SecureChannel and from a Client that
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  9.6.9 GetServiceDescription
  GetServiceDescription The GetServiceDescription Method is used to read the metadata needed to request AccessTokens from the AuthorizationService . Signature GetServiceDescription ( [out] String ServiceUri [out] ByteString ServiceCertificate [out] UserTokenPolicy[] UserTokenPolicies ); Argument Description ... validate the AccessTokens provided by the AuthorizationService. UserTokenPolicies The UserIdentityTokens accepted by the AuthorizationService. Method Result Codes (defined in Call Service) Result Code Description Bad_UserAccessDenied The current user does
• OPC-10000-12 – OPC Unified Architecture - Part 12: Discovery and Global Services
  H.3 Initial Enrolment
  authorizes the EST client before allowing the operation to proceed. In OPC UA, a Method is used to request a Certificate . The CertificateManager also authenticates and authorizes the client before
• OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub
  3.1.1 Action
  sent by a Requestor Note 1 to entry: An Action is similar to a Method that can be invoked via PubSub
• OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub
  5.4.3 Actions
  receives a request message sent by a Requestor . An Action could be a Method in an OPC UA Address Space or business logic in an OPC UA PubSub application ... Action targets that share the same request and response parameters. An example is a Method defined on an ObjectType that can be called on different Object instances. In this case
• OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub
  5.4.5.1 General
  PubSub NetworkMessages . Separate keys are associated with each SecurityGroupId in the system. The GetSecurityKeys Method exposed by the SKS shall be called to receive necessary key material for a SecurityGroupId ... calling GetSecurityKeys for every key needed. The PubSubKeyServiceType defined in 8.2 specifies the GetSecurityKeys Method . The GetSecurityKeys Method can be implemented by a Publisher or by a central
• OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub
  5.4.5.2 SecurityGroup Management
  context of a SecurityGroup. A SecurityGroup is created on a SKS using the Method AddSecurityGroup . To limit access to the SecurityGroup and therefore to the security keys, Permissions shall
• OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub
  5.4.5.3 Key acquisition handshakes
  SecurityGroup . Then it passes the identifier of the SecurityGroup to the GetSecurityKeys Method that verifies the identity and returns the keys used to secure messages for the PubSubGroup . The GetSecurityKeys ... Method is defined in 8.3.2 . The access to the GetSecurityKeys Method may use SessionlessInvoke Service calls. These calls typically use an Access Token that is retrieved from an Authorization Service
• OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub
  5.4.5.4 Authorization Services and Security Key Service
  Handshake with a Security Key Service The SKS is a Server that exposes a Method called GetSecurityKeys . The Access Token is used to determine if the calling application is allowed ... check the Permissions assigned to the SecurityGroup Object identified by the GetSecurityKeys Method arguments. Publishers and Subscribers can request keys if the Access Token they provide is mapped to Roles
• OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub
  6.2.3.10.5 ActionMethods
  ActionMethods The parameter ActionMethods defines a list of Object and Method pairs as source for the Action defined in the parameter ActionMethods . The DataType ActionMethodDataType represents the configuration information ... Object and Method pair. The ActionMethodDataType is formally defined in Table 28 . Table 28 - ActionMethodDataType structure Name Type Description ActionMethodDataType Structure ObjectId NodeId The NodeId shall be that
• OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub
  6.2.3.10.6 PublishedActionMethodDataType
  PublishedActionMethodDataType This Structure DataType is used to represent Action source Method information for PublishedAction . It is a subtype of the PublishedActionDataType defined in 6.2.3.10.4 . The PublishedActionMethodDataType is formally defined
• OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub
  6.2.4.1 DataSetWriterId
  external assignment by configuration tools, and 0x8000 - 0xFFFF for internal assignment like through the Method CloseAndUpdate of the PubSubConfigurationType
• OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub
  6.2.5.4 SecurityKeyServices
  ApplicationType Enum ApplicationType SERVER The security keys are pulled from the SKS using the Method GetSecurityKeys . CLIENT The security keys are pushed from the SKS to the PubSub application using ... Method SetSecurityKeys . CLIENTANDSERVER Invalid value. DISCOVERYSERVER Invalid value. If the SKS information is sent as part of a discovery announcement message for a WriterGroup , the ApplicationType shall
• OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub
  6.2.6.1 WriterGroupId
  external assignment by configuration tools, and 0x8000 - 0xFFFF for internal assignment like through the Method CloseAndUpdate of the PubSubConfigurationType
• OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub
  6.2.12.2 SecurityGroupDataType
  existing keys of the SecurityGroup are invalidated. The behaviour is described for the InvalidateKeys Method in 8.4.2 . The SecurityGroupDataType is formally defined in Table 89 . Table 89 - SecurityGroupDataType structure Name ... SecurityGroup . MaxFutureKeyCount UInt32 The maximum number of future keys returned by the Method GetSecurityKeys . MaxPastKeyCount UInt32 The maximum number of historical keys stored by the SKS. SecurityGroupId String The identifier