Annex B Use cases (Informative)

B.1 General

The following use cases describe how base features are supported by the FDT OPC UA system architecture.

B.2 Use case: List topology

Use Case List Topology
Description

The OPC UA client shows the topology in a hierarchical tree to the user. The tree is provided by an OPC UA server for FDT OPC Information Model.

If the OPC UA server supports a network topology, it is provided according to the 'Device Integration Host Model' defined in OPC UA DI.

Stakeholder
PreconditionsTopology is available in OPC UA Server
Post conditionsUser can see the topology in a hierarchy
ActorsEngineer, Expert, Observer
TriggerWhenever a user needs a list of devices for further access
Frequency
Description
StepAction
1User triggers connect from OPC Client to OPC Server
2User starts browsing from node 2:DeviceTopology
3OPC Client displays the topology to the user
Exceptions
RequirementsUser has access permissions to the server
Notes

Network/communication topology

Physical topology

Open Issues

B.3 Use case: Identify device

Use Case Identify Device
DescriptionA user gets information about a physical device selected in a topology. The OPC UA client provides this information to the user by reading identification information provided according to the FDT OPC UA information model.
PreconditionsTopology and device node is available in OPC UA Server
Post conditions
ActorsEngineer, Expert, Observer, Plant Asset Manager
TriggerWhenever a user needs information about a device
Frequency
Description
StepAction
1User browses namespace to a node representing a device
2User starts reading identification information of the device
3OPC Server obtains information about the device from associated DTM
4OPC Client displays the identification values to the user
Exceptions
RequirementsUser has access permissions to the server
Notes
Open Issues

B.4 Get list of available device parameters

B.4.1 Use case: Browse device parameters

Use CaseBrowse device parameters.
Description

OPC Client has the UI windows for displaying the device details information.

If the device has the blocks, the UI window displays block names which the device has.

If a device has blocks, the UI window displays parameter names which are included in blocks.

If a device does not have a block, the UI window displays parameter names which the device has.

StakeholderMass Configuration
PreconditionsUse Case B.2 (List Topology)
Post conditionsOn the OPC client, user can see the parameter names which the device or the block has.
ActorsEngineer, Expert, Observer, Plant Asset Manager
TriggerWhenever a user needs a list of parameters for further access.
Frequency
Description
StepAction
1On OPC Client, user opens a UI window of a device which is selected on the topology which is listed by the Use Case B.2.
2User browses a name list on the selected device in the OPC Client.
3OPC Server retrieves a name list of the selected device.
4

OPC Client displays a name list to user.

If selected device has blocks (if the device is FF-H1 or PROFIBUS PA), OPC Client displays the block name list.

5User selects an item in the name list, and user browses the selected item (block name list or parameter list).
6If the object type of selected item is “Block”, OPC Server retrieves available parameters of the selected block.
Extension
StepBranching Action
4OPC Server gets the attributes (Label Name / Help Description) of the selected item in the list and displays in the OPC Client.
Variations
StepBranching Action
4If selected device has no blocks (if the device is HART), OPC Client displays the parameter name list.
6

If the object type of selected item is “Parameter”, OPC Server retrieves available attributes of the selected parameter.

For the enumeration case, an OPC Client displays the corresponding label with the value.

ExceptionsStep 2, The device is not ready to communicate.
Step 3, The DTM which is browsed does not provide a block list (if the device is FF-H1) or a parameter list.
Step 6, If the object type of selected item is “Parameter Element”, OPC Server does not return a list. OPC Client displays a message informing user that there are no available items.
RequirementsUser has access permissions to the server
Notes

[Hierarchy of items]

[Up to the parameter]

FF-H1 / PROFIBUS PA : {Device} --- {Block} --- {Parameter}

HART : {Device} --- {Parameter}

[Up to the element]

FF-H1 : {Device} --- {Block} --- {Parameter} --- {Element(*)}

(*) Element = the member variable of the structure

[Up to the enumeration]

FF-H1 / PROFIBUS PA : {Device} --- {Block} --- {Parameter} --- {Enumeration}

FF-H1 : {Device} --- {Block} --- {Parameter} --- {Element} --- {Enumeration}

HART : {Device} --- {Parameter} --- {Enumeration}

Open Issues

B.4.2 Use case: Get attributes of a device parameter

Use CaseGet attributes of a device parameter
Description

OPC Client has the UI windows for displaying the device details information.

The UI window displays parameter names, its’ engineering units and values (if the parameter is readable).

When OPC Client displays the value of a parameter, the value is displayed according to the “display format“, which is described in the DD.

If the OPC Client also has the parameter-write-function and if the parameter is writable, an UI-element for writing the value to a parameter is displayed.

StakeholderMass Configuration
Preconditions

Topology and device node are available in OPC UA Server

Device is connected to the OPC UA Server.

OPC Client gets the parameter list of a device from OPC Server.

To display the parameter name and its value, OPC Client tries to get the detail information of each parameter.

Post conditions

On the OPC client, user can see the parameter names, and can see the detail information for each parameter.

Detail Information of parameter:

the data type, the label name, the minimum value, the maximum value, the engineering units, writable, readable, the enumeration list, the display format, the edit format.

ActorsEngineer, Expert, Observer, Plant Asset Manager
TriggerWhenever a user needs the attributes of parameters for further access.
Frequency
Description
StepAction
1OPC Client requests to get the attributes of a parameter of a device to OPC Server.
2OPC Server gets the attributes of the parameter which is specified by OPC Client from the device DTM.
3OPC Client displays the parameter name to use the label name, and the engineering units.
ExceptionsStep 1, The specified parameter does not exist in the device.
Requirements
Notes

To use the attributes of a device parameter which is gotten by this use case, OPC Client can work as follows.

[For read parameter]

OPC Client can recognize a parameter is readable or not, and then OPC Client gets the value of the parameter via OPC Server from the device.

OPC Client displays the corresponding label with the value if the data type of a parameter is the enumeration, otherwise (if the data type is not the enumeration) OPC Client displays the value according to the “display format“.

[For write parameter]

OPC Client can recognize a parameter is writable or not, and then OPC Client can check the entered value whether the data type, and the minimum value and the maximum value of the entered value are correct or not when user tries to write a value to a parameter.

Open Issues

B.5 Use case: Get Device Status

Use CaseGet Device Status
Description

DTM can provide the NE107 status as the device status by the next procedure.

Reading the data from the device parameters which express the device status or the results of the diagnosis of the device.

Calculating the bits and mapping to the NE107 status definition.

StakeholderMass Configuration
PreconditionsClient connected to OPC Server.
Post conditionsOPC Client can display NE107 status as the device status.
ActorsEngineer, Expert, Observer, Plant Asset Manager
TriggerWhenever a user needs the device status information of the device.
Frequency
Description
StepAction
2User triggers to retrieve device status of a device in OPC Client.
3OPC Client requests to get the diagnosis parameter/s of a device to OPC Server.
4OPC Server retrieves the device status from the DTM
5DTM reads the value of the diagnosis parameter/s of a device and calculates the status
8OPC Client displays the NE107 status of the device.
ExceptionsStep 4, No diagnosis parameter/s are defined, if the DTM does not support to retrieve the diagnosis parameter/s.
Requirements
Notes
Open Issues

B.6 Use case: Get Device Diagnostics

Use CaseGet Device Diagnostic Information
DescriptionA software or user requests diagnostic information (context specific diagnostic information) from a physical device. The OPC UA client collects this information by reading device diagnostic information provided according to the OPC UA DI information model.
Stakeholder
Used by
Preconditions

Device node is available in OPC UA Server

Device is connected to the OPC UA Server (means online or only somehow accessible?)

Use case B.2 (List Topology)

Post conditionsMaintenance or asset manager can derive actions
ActorsEngineer, Expert, Observer, Maintenance Manager, Asset Manager, Operator
TriggerStatus of device is not Good. This information is provided by: Use case B5 or by alarms
Frequency
Description
StepAction
1OPC Client User opens UI of the device
2User requests diagnostic data of the device
3OPC client requests diagnostic data of the device from the OPC server
4OPC server gets diagnostic data from the DTM
5OPC server sends the diagnostic data to the client, displaying the data on the UI
Exceptions
Requirements
NotesAccording to FDT2.0 the expectation is, that the DTM provides the parameters for device specific diagnostic within one group of parameters.
Open Issues

B.7 Read parameters

B.7.1 Use case: Read offline data

Use Case Read offline parameters
DescriptionA software or user requests device parameter (the last set values) from a DTM. The OPC UA client collects this information by reading device parameter from the offline set provided according to the FDT OPC UA information model.
Stakeholder
PreconditionsDevice node is available in OPC UA Server and the Client already knows the ParameterIds of the Parameters to read (may have been retrieved according to use case B4.2).
Post conditionsClient knows the current value of device parameters
ActorsEngineer, Expert, Observer, Operator
TriggerWhenever the data is needed
Frequency
Description
StepAction
PreparationThe OPC Client selects the respective device node and the parameter set of the device.
1OPC Client executes Read-Service (one or multiple times) with the list of identifiers for the respective device parameters (list of ParameterIds) and the list of AttributeIds for Value and (at least once) for DateType.
2OPC Server retrieves the requested attributes (e.g. value) of the parameter which are specified in the Read-Request from the DTM (instance data set) and returns them to the client.
5OPC Client displays the parameter value (or uses it otherwise).
ExceptionsStep 1, The specified parameter does not exist in the device.
Requirements
Notes
Open Issues

B.7.2 Use case: Read online data

Use Case Read online parameters
DescriptionA software or user requests device parameter (the current values in the device) from a DTM. The OPC UA client collects this information by reading device parameter from the online set provided according to the FDT OPC UA information model.
Stakeholder
PreconditionsDevice node is available in OPC UA Server and the Client already knows the ParameterIds of the Parameters to read (may have been retrieved according to use case B4.2).
Post conditionsClient knows the current value of device parameters
ActorsEngineer, Expert, Observer, Operator
TriggerWhenever the data is needed
Frequency
Description
StepAction
PreparationThe OPC Client selects the respective offline device node
1OPC Client selects the online device and the parameter set of the online device.
2OPC Client executes Read-Service (one or multiple times) with the list of identifiers for the respective device parameters (list of ParameterIds) and the list of AttributeIds for Value and (at least once) for DateType.
3OPC Server requests the requested attributes (e.g. value) of the parameter which are specified in the Read-Request from the DTM (instance data set).
4The DTM retrieves the current values from the device and returns them to the server.
5OPC Server returns the requested information to the client.
6OPC Client displays the parameter value (or uses it otherwise).
ExceptionsStep 1, The specified parameter does not exist in the device.
Requirements
Notes
Open Issues

B.8 Use case: Write device parameters

Use Case Writing Online Device Parameter
DescriptionThe OPC client allows configuring or updating parameter values on the device. Writing is executed from an OPC client to an OPC server providing the FDT OPC UA information model.
Stakeholder
PreconditionsUse Case B1 (List Topology)
Post conditionsOPC client can retrieve the updated device parameter values
ActorsField Engineer, Device Expert, Maintenance Engineer
TriggerDevice Commissioning, Device Calibration, Device Configuration
Frequency
Description
StepAction
2User starts browse from Device Topology
3OPC Client displays the topology to the user
4User browse the parameters on the selected device
5OPC Client displays available parameters on the device
6User selects the device parameter that the value needs to be updated or changed
7User changes the value of the selected device parameter based on its type
8User commits the changes
9OPC server puts the lock on the device
10OPC server validates the specified parameter value
11OPC server writes the updated value to the device
12OPC server removes the lock on the device
13OPC client displays the new value of the selected device parameter
ExceptionsStep 7, Value does not match the data type of the device parameter.
Step 8, Device is in locked state.
Step 10, Value exceeds the minimum and maximum limit specification of the device parameter.
RequirementsUser has access permissions to the server
Notes
Open Issues

B.9 Use case: Audit trail

Use Case Audit Trail
DescriptionA central Audit Trail system logs audit events from FDT based tools. All auditable actions in the FDT tool produce OPC UA Audit Events and the central Audit Trail system subscribes for OPC UA Audit Events from the tool.
Used by
PreconditionsAudit Events are supported by the OPC UA Server
Post conditionsConfiguration changes are logged in the central Audit Trail.
ActorsAdministrator for central Audit Trail system, Engineer, Expert
TriggerWhenever device configuration actions must be logged in an audit trail
Frequency
Description
StepAction
1Define configuration changes that create an audit event in the OPC UA Server and FDT Frame
2Activate Audit Events in the OPC UA Server
3Configure central Audit Trail system to subscribe for audit events from the FDT OPC UA Server
4Log configuration changes in the central Audit Trail system
5View Audit Trail through a tool that comes with the central Audit Trail system
Exceptions
Requirements
Notes
Open Issues

_____________