DCSA Reference Documentation / Standards / Standard Releases / Operational Vessel Schedules / Archive / Operational Vessel Schedules v3.0.2

DCSA OVS 3.0.2 - Use Cases

Archived copy: This immutable copy preserves Operational Vessel Schedules v3.0.2. View the current v3 documentation.

This page is published as part of the complete documentation set for this version. Use cases have been reformatted to align with other standards; their intent and meaning remain unchanged.

Contents

• Introduction
  • Overview
  • Use case structure
• Operational Vessel Schedules standard use cases
  • UC1: Retrieving Operational Vessel Schedules
    • Actors
    • Description
    • Preconditions
    • Postconditions
    • Flow
    • Retrieval criteria
    • Exceptions

Introduction

Overview

In line with the techniques used in software development, DCSA has incorporated user stories and use cases into the standards development process to support the digitalization efforts of the shipping industry. Both user stories and use cases serve the purpose of capturing and documenting requirements, but they differ in granularity, level of detail, and the stages of the development process in which they are most prominently used. Use cases support user stories: a user story is supported by one or more use cases and vice versa. Together, user stories and use cases can be used to provide a high level understanding of the business requirements of the system being built.

Use case structure

Use cases are descriptions of how a system will respond to a specific request or interact with a user and are a valuable technique for capturing and defining functional requirements in a way that is easily understandable by both technical and non-technical stakeholders. The use cases defined in this standard include the following components:

Actors

Actors are external entities interacting with the system being defined, and can be either users or other systems. They participate in the use case interaction and are the ones for whom the system provides value.

Description

A brief explanation that summarizes the purpose of the use case.

Preconditions

Prerequisites that need to be fulfilled or tasks that must be finished prior to the execution of the use case.

Postconditions

Relevant criteria of the system state after the successful completion of the use case.

Flow

The primary steps of the use case, outlining the expected sequence of interactions between the actors and the system.

Operational Vessel Schedules standard use cases

The following use case has been created by DCSA to define the business process supported by the Operational Vessel Schedules standard.

UC1: Retrieving Operational Vessel Schedules

Actors

Operational Vessel Schedules Consumer

Operational Vessel Schedules Producer

Description

An Operational Vessel Schedules Consumer requests from an Operational Vessel Schedules Producer the latest available operational vessel schedule information matching a defined set of retrieval criteria.

The request may concern operational vessel schedule information related to a service, voyage, vessel, port, or terminal.

Preconditions

The Operational Vessel Schedules Consumer has the criteria required to request the relevant operational vessel schedule information.

The Operational Vessel Schedules Producer has generated, collected, received, or can retrieve the operational vessel schedule information matching the requested criteria.

Postconditions

The Operational Vessel Schedules Consumer has the latest available operational vessel schedule information matching the requested criteria.

Flow

The Operational Vessel Schedules Consumer sends the Operational Vessel Schedules Producer a request containing the relevant schedule retrieval criteria.

The Operational Vessel Schedules Producer retrieves the latest available operational vessel schedule information matching the requested criteria from its systems.

The Operational Vessel Schedules Producer sends the relevant operational vessel schedule information to the Operational Vessel Schedules Consumer.

Retrieval criteria

The Operational Vessel Schedules Consumer may request operational vessel schedule information using criteria related to:

a specific service

a specific voyage

a specific vessel

a specific port or terminal

These retrieval criteria support the user stories defined for service schedules, voyage schedules, vessel schedules, and port or terminal schedules. They do not constitute separate use cases.

Exceptions

If the Operational Vessel Schedules Producer cannot retrieve any matching operational vessel schedule information, it sends back an empty list.

If the Operational Vessel Schedules Producer cannot process the request, it responds according to the applicable OVS API specification with the relevant error response.