Web Server

SOTA Server

Resolver

VIN does not already exist

E1 - An ADD_VIN command is sent from Web Server to SOTA Server

E2 - VIN is added to the SOTA Server Database

E3 - A success code is sent back to Web Server

E4 - An ADD_VIN command is snet to External Resolver from Web Server

E5 - VIN is added to External Resolver database

E6 - A success code is sent back to Web Server

VIN is part of the system

X1 - VIN already exists. Triggered by E2, E5

Web Server

SOTA Server

VIN has been installed by VIN_ADD

E1 - A delete VIN command is sent from Web Server to SOTA Server

E2 - All references to Packages being installed on given VIN are removed from SOTA Server Database

E3 - The VIN is removed from the SOTA Server Database

E4 - Any Data Plan references to the VIN are removed from the SOTA Server Database

E5 - A success code is sent back to the Web Server

E6 - A DELETE_VIN command is sent from Web Server to Resolver

E7 - All references to Components being installed on the given VIN are removed from the Resolver Database

E8 - All references to Packages being installed on the given VIN are removed from the Resolver Database

E9 - The VIN is removed from the Resolver Database

E10 - A success code is sent back to the Web Server

X1 - VIN does not exist. Triggered by E6

Web Server

SOTA Server

External Resolver

None

E1 - A SEARCH_VIN command is sent from Web Server to SOTA Server. VIN is searched for using POSIX-style regular expressions.

E2 - The SOTA Server Database is searched for all VINs matching the given expression.

E3 - For each retrieved VIN, the part numbers of all installed Components are retrieved by the Web Server from the Resolver(!)

E4 - For each retrieved VIN, the IDs of all Installed Packages are retrieved

E5 - All matching VINs, with their retrieved Components and Installed Packages are returned by SOTA Server to Web Server

None

Web Server

SOTA Server

None

E1 - A SET_VIN_DATA_PLAN command is sent from Web Server to SOTA Server with VIN and Data Plan ID.

E2 - The VIN is retrieved from the SOTA Server Database

E3 - The Data Plan is retrieved from the SOTA Server Database

E4 - A success code is sent back to the Web Server

X1 - VIN does not exist. Triggered by E2

X2 - Data Plan does not exist. Triggered by E3

Web Server

SOTA Server

None

E1 - A GET_VIN_PACKAGE_HISTORY command is sent from Web Server to SOTA Server with a VIN.

E2 - The provided VIN is retrieved from the SOTA Server Database

E3 - All updates, completed, failed, in-flight or pending targeting the provided VIN are retieved from the SOTA Server Database, together with the IDs of all Packages included in the update for each VIN

E4 - A success code is sent back to the Web Server, with all updates, their package IDs, their status, and the completion / failure date

X1 - VIN does not exist. Triggered by E2

Web Server

SOTA Server

Software package does not already exist

E1 - An ADD_SOFTWARE_PACKAGE command is sent from Web Server to SOTA Server together with an ID string, a version (major.minor.patch), a description, and a vendor. The software package binary is sent as part of the command together with a checksum.

E2 - Software package’s meta-data is added to SOTA Server database

E3 - The SOTA Server stores the package binary in its storage area and stores the URL to the binary in the database.

E4 - A success code is sent back to Web Server

X1 - Software Package with same ID String and Version is already registered with SOTA Server. Triggered by E2

Web Server

External Resoler

Software package does not already exist

E1 - An ADD_SOFTWARE_PACKAGE command is sent from Web Server to the Resolver together with an ID string, a version (major.minor.patch), a description, and a vendor.

E2 - Software package’s meta-data is added to the Resolver database

E3 - An ADD_SOFTWARE_PACKAGE command is sent from Web Server to External Resolver together with an ID string.

E4 - Software Package is added to External Resolver database

E5 - A success code is sent back to Web Server

X1 - Software Package with same ID String and Version is already registered with SOTA Server. Triggered by E2

Web Server

SOTA Server

None

E1 - A SEARCH_PACKAGE command is sent from Web Server to SOTA Server with a regular expression formatted Package ID and version string

E2 - The SOTA Server Database is searched for all Packages matching the search criteria.

E3 - All matching Package IDs, with their version, vendor and descriptions are returned.

None

Web Server

SOTA Server

None

E1 - An ADD_DATA_PLAN command is sent from Web Server to SOTA Server with a Data Plan ID.

E2 - The Data Plan is added to SOTA Server Database.

E3 - A success code is sent back to Web Server

X1 - Data Plan already exists. Triggered by E2.

Web Server

SOTA Server

PLAN_ADD executed to provide a Data Plan to which to add a Billing Cycle

E1 - An ADD_BILLING_CYCLE command is sent from Web Server to SOTA Server with a Data Plan ID, a Billing Cycle start date / time, and a Billing Cycle pool size.

E2 - The Data Plan is retrieved from the SOTA Server Database

E3 - A Billing Cycle is created in the SOTA Server Database with zero bytes transmitted, the given start data, and the pool size.

E4 - A success code is returned by SOTA Server to Web Server

X1 - Data Plan does not exist. Triggered by E2.

Web Server

SOTA Server

None

E1 - A SEARCH_DATA_PLAN command is sent from Web Server to SOTA Server with a Data Plan ID regular expression

E2 - A success code is returned by SOTA Server to Web Server with all located Data Plan IDs

None

Web Server

SOTA Server

None

E1 - A SEARCH_BILLING_CYCLES command is sent from Web Server to SOTA Server with a Data Plan ID, an earliest date / time, and a latest date / time.

E2 - The Data Plan is retrieved from SOTA Server Database.

E3 - All Billing Cycles belonging to the Data Plan, with a start date / time between the provided earliest and latest date / time, are retrieved from SOTA Server Database together with their pool size, and used data.

E4 - A success code is returned by SOTA Server to Web Server with all located Billing Cycles, their pool size and data usage.

X1 - Data Plan does not exist. Triggered by E2.

SOTA Server

Network Monitoring Process

None

E1 - An ADD_DATA_TRAFFIC command is sent from an internal SOTA Server Network Monitoring Process to SOTA Server with a VIN and a byte count of transmitted data.

E2 - The VIN is retrieved from SOTA Server Database.

E3 - The Data Plan setup for the VIN created through the VIN_SET_DATA_PLAN use case is retrieved from SOTA Server.

E4 - The Billing Cycle, owned by the Data Plan, that has the latest start date / time before the provided date / time stamp is retrieve from the SOTA Server Database.

E5 - The data usage for the given Billing Cycle is incremented by the byte count provided

E6 - A success code is returned to the Network Monitoring Process, together with the retrieved Data Plan ID, and the start date, pool size, and update data usage of the located Billing Cycle.

X1 - VIN does not exist. An error code is sent back to Web Server. Triggered by E2.

A1 - No Data Plan is setup for VIN. A success code is sent back to Web Server. Triggered by E3.

A2 - No Billing Cycles have been added to the Data Plan. A success code is sent back to Web Server. Triggered by E4.

Web Server

External Resolver

None

E1 - A FILTER_ADD command is sent from Web Server to External Resolver with the filter expression and a filter label.

E2 - The filter expression is validated for semantic and syntactic correctness.

E3 - The fitler is stored in the External Resolver Database.

E4 - A success code is returned by External Resolver to Web Server.

X1 - Filter Label already exists. Triggered by E1.

X2 - Filter Expression validation fails. Triggered by E2.

Web Server

External Resolver

None

E1 - A FILTER_SEARCH command is sent from Web Server to External Resolver with a regular expression describing zero or more filter labels.

E2 - The filters with matching filter labels are retrieved from the External Resolver Database.

E3 - A success code is returned by External Resolver to Web Server, with all matching filter labels and their filter expression.

None

Web Server

External Resolver

None

E1 - A FILTER_VALIDATE command is sent from Web Server to External Resolver with a filter expression.

E2 - The filter expression is validated for semantic and syntactic correctness.

E4 - If the filter expression is valid, a success code is returned to Web Server

E5 - If the filter expression is not valid, an error code is returned together with an error message describing the problem with the filter expression.

None

Web Server

External Resolver

Filter has been added to External Resolver Database using FILTER_ADD

E1 - A DELETE_FILTER command is sent from Web Server to External Resolver with a filter label.

E2 - The filter is deleted from the External Resolver Database.

E3 - A success code is returned by External Resolver to Web Server.

X1 - Filter label does not exist. Triggered by E2.

Web Server

External Resolver

Filter has been added to External Resolver Database using FILTER_ADD

Package has been added to External Resolver Database using PACKAGE_ADD

E1 - A FILTER_PACKAGE_ADD command is sent from Web Server to External Resolver with a filter label and a Package ID.

E2 - The filter is retrieved from External Resolver Database.

E3 - The Package is retrieved from External Resolver Database.

E4 - A reference is added to External Resolver Database that the filter should be applied to all VINs when the Package is to be resolved in QUEUE_REQUEST_ADD.

E3 - A success code is returned by External Resolver to Web Server.

X1 - Filter label does not exist. Triggered by E2.

X2 - Package ID does not exist. Triggered by E3.

Web Server

External Resolver

Filter-Package association has been added to External Resolver Database using FILTER_PACKAGE_ADD

E1 - A FILTER_PACKAGE_DELETE command is sent from Web Server to External Resolver with a filter label and a Package ID.

E2 - The reference that the given Filter should be applied to the specific Package ID is removed from the External Resolver Database.

E3 - A success code is returned by External Resolver to Web Server.

X1 - Filter-Package association does not exist. Triggered by E2.

Web Server

External Resolver

None

E1 - A FILTER_SEARCH_PACKAGE_BY_FILTER command is sent from Web Server to External Resolver with a filter label.

E2 - The External Resolver Database is searched for all Packages associated with the given Filter.

E3 - A success code is returned by External Resolver to Web Server, with all retrieved Package IDs.

X1 - Filter label does not exist. Triggered by E2.

Web Server

External Resolver

None

E1 - A FILTER_SEARCH_FILTER_BY_PACKAGE command is sent from Web Server to External Resolver with a Package ID.

E2 - The External Resolver Database is searched for all Filters assocaited with the given Package.

E3 - A success code is returned by External Resolver to Web Server, with all retrieved Filter Labels.

X1 - Package does not exist. Triggered by E2.

Web Server

External Resolver

None

E1 - An ADD_COMPONENT command is sent from Web Server to External Resolver

E2 - The Component is added to External Resolver Database

E3 - A success code is sent back to Web Server

X1 - If Component exists, X1 is executed. Triggered at E1.

Web Server

External Resolver

None

E1 - An ADD_COMPONENT command is sent from Web Server to External Resolver

E2 - The provided VIN is retrieved from External Resolver Database

E3 - The provided Component is retrieved from External Resolver Database

E4 - The part provided Component is marked as installed on the VIN in External Resolver Database

E5 - A success code is sent back to Web Server

X1 - VIN does not exist - an error code is sent back to Web Server. Triggered at E2 if VIN does not exist.

X2 - Component does not exist - an error code is sent back to Web Server. Triggered at E3 if Component does not exist.

The association is registered in the External Resolver, and searchable with VIN_SEARCH_BY_COMP and COMP_SEARCH_BY_VIN

Web Server

External Resolver

None

E1 - An ADD_PACKAGE command is sent from Web Server to External Resolver with a Package and a VIN

E2 - The provided VIN is retrieved from External Resolver Database

E3 - The provided Package is retrieved from External Resolver Database

E4 - The Package is marked as installed on the VIN in External Resolver Database

E5 - A success code is sent back to Web Server

X1 - VIN does not exist - an error code is sent back to Web Server. Triggered at E2 if VIN does not exist.

X2 - Package does not exist - an error code is sent back to Web Server. Triggered at E3 if Package does not exist.

The association is registered in the External Resolver, and searchable with PACKAGE_SEARCH_BY_VIN

Web Server

External Resolver

None

E1 - A DELETE_PACKAGE command is sent from Web Server to External Resolver with a Package and a VIN

E2 - The reference to the Package being installed on the VIN is removed

E3 - A success code is sent back to Web Server

X1 - The Package is not registered as installed on the VIN - an error code is sent back to Web Server. Triggered at E2.

None

Web Server

External Resolver

None

E1 - A SEARCH_COMPONENT command is sent from Web Server to External Resolver with a POSIX-style regular expression for the part numbers of interest

E2 - The External Resolver Database is searched for all Components matching the part number regular expression

E3 - The part numbers of all matching Components are returned

None

None

Web Server

External Resolver

None

E1 - A SEARCH_COMPONENT command is sent from Web Server to External Resolver with specific Component ID (part number) of interest

E2 - The Component is retrieved from the External Resolver Database

E3 - All VINs associated with the Component ID (part number) are retrieved from the External Resolver Database

E4 - The retrieved VINs are returned by External Resolver to Web Server

X1 - Component does not exist - an error code is sent back to Web Server. Triggered at E2 if Component ID is not found.

None

Web Server

External Resolver

None

E1 - A SEARCH_COMPONENT command is sent from Web Server to External Resolver with specific VIN (not regexp) of interest

E2 - The VIN is retrieved from the External Resolver Database

E3 - All Components associated with the VIN are retrieved from the External Resolver Database

E4 - The retrieved Components are returned by External Resolver to Web Server

X1 - VIN does not exist - an error code is sent back to Web Server. Triggered at E2 if VIN is not found.

None

Web Server

External Resolver

Both references software Packages have been added with PACKAGE_ADD

E1 - An ADD_PACKAGE_DEPENDENCY command is sent from Web Server to External Resolver with the Package ID that has a dependency and the Package ID that is depended upon.

E2 - The Package for the dependent Package ID is retrieved from the External Resolver Database.

E3 - The Package for the depended Package ID is retrieved from the External Resolver Database.

E4 - The unidirectional Dependency between the two Packages is stored in the External Resolver Database.

E5 - A success code is sent back to Web Server

X1 - Dependent Package ID does not exist. Triggered by E2

X2 - Depended Package ID does not exist. Triggered by E3

Web Server

External Resolver

None

E1 - A GET_PACKAGE_DEPENDENCIES command is sent from Web Server to External Resolver with a software Package ID and an optional recursive resolve flag.

E2 - The Package is retrieved from the External Resolver Database.

E3 - The Package Dependencies are retrieved from the External Resolver Database.

E4 - If the recursive resolve flag is set, E3 is executed for each located Dependency, resulting in a complete Dependency Graph including all Packages needed to run the provided Package ID on a Component.

E5 - All retrieved Dependencies are returned, where each Dependency contains the Package ID of the depended-upon Package and the ID of the Package that is dependent on it.

Dependency for A1 is { A1, { B1, B2 { C1, { D1, D2 } } } }
Returns:
  D1 -> C1
  D2 -> C2
  C1 -> B2
  B2 -> A1
  B1 -> A1

X1 - Package does not exist. Triggered by E2

Web Server

External Resolver

A Dependency has previously been set up by PACKAGE_ADD_DEPENDENCY

E1 - A DELETE_PACKAGE_DEPENDENCY command is sent from Web Server to External Resolver with the IDs of the dependent and depended-upon Packages

E2 - Dependent Package is retrieved from External Resolver Database

E3 - Depended-upon Package is retrieved from External Resolver Database

E4 - External Resolver Database is searched for the matching unidircetional Dependency

E5 - The unidirectional dependency is deleted from the External Resolver Database

E6 - A success code is sent back to Web Server

X1 - Dependent Package does not exist. Triggered by E2

X2 - Depended-upon Package does not exist. Triggered by E3

X3 - Dependency relation could not be found. Triggered by E4

Web Server

External Resolver

None

E1 - A SEARCH_PACKAGE_BY_VIN command is sent from Web Server to External Resolver

E2 - Package is retrieved from External Resolver Database

E3 - All VINs with Package installed are retrieved from External Resolver Database

E4 - A success code is sent back to Web Server with all VINs that have the Package installed

X1 - Package does not exist. Triggered by E2

Web Server

External Resolver

SOTA Server

Package added with PACKAGE_ADD

E1 - A QUEUE_PACKAGE request is sent from Web Server to SOTA Server with a Package ID, a Priority, and a Date/time Interval in which the install must happen

E2 - The database is searched for the Package ID

E3 - A Resolve VIN command is sent from SOTAServer to Resolver

E4 - External Resolver searches its database for all Filters associated with Package

E5 - All VINs are consecutively run through all Filters

E6 - External Resolver returns the subset of VINs passing all Filters to SOTA Server, where each VIN has a list of dependent-on Packages that need to be bundled with the update for the install to succeed on that VIN

E7 - SOTA Server creates a software update generated for each VIN returned by External Resolver, containing the package IDs of main and dependent-on packages to install, the date/time interval provided in E1, the priority provided in E1, and a creation date/time stamp set to the current time.

E8 - A unique Install Request ID, used in all future references to the Install Request, is returned by SOTA Server to Web Server

X1 - Package ID does not exist. Triggered by E2

A1.1 - Resolver returns all provisioned VINs to SOTA Server. Triggered by E4. Continue execution at E7.

Web Server

SOTA Server

QUEUE_REQUEST_ADD called to setup the Install Request that is to be cancelled

E1 - A CANCEL_PACKAGE request is sent from Web Server to SOTA Server with an Install Request ID

E2 - SOTA Server database is searched for the Install Request ID

E3 - Each VIN that has an update generated from the Install Request is retrieved from SOTA Server database

E4 - Each VIN that is still marked as pending is removed, and is marked as canceled.

E5 - Each VIN that is marked as being in flight is ignored. (If the update is currently being transmitted to its target VIN, it is allowed to complete.)

E6 - Each VIN that is marked as completd is ignored.

E7 - A success code is returend by SOTA Server to Web Server

X1 - Install Request ID does not exist. Triggered by E2

Web Server

SOTA Server

QUEUE_REQUEST_ADD called to setup the Install Request that is to be queried

E1 - A GET_INSTALL_REQUEST_STATUS request is sent from Web Server to SOTA Server with an Install Request ID

E2 - SOTA Server database is searched for the Install Request ID

E3 - The number of VINs where the Install Request has completed is calculated

E4 - The number of VINs where the Install Request is still pending is calculated

E5 - The number of VINs where the Install Request has failed is calculated

E6 - A success code is returned by SOTA Server to Web Server together with the number of completed, in-flight, pending and failed updates

X1 - Install Request ID does not exist. Triggered by E2

Web Server

SOTA Server

None

E1 - A GET_INSTALL_REQUEST_COMPLETED request is sent from Web Server to SOTA Server with an Install Request ID

E2 - SOTA Server database is searched for the Install Request ID

E3 - Each VIN that has successfully completed the Install Request is retrieved, together with the timestamp of completion, from the database

E4 - A success code is returned by SOTA Server to Web Server together with all retrieved VINs

X1 - Install Request ID does not exist. Triggered by E2

Web Server

SOTA Server

QUEUE_REQUEST_ADD called to setup the Install Request that is to be queried

E1 - A GET_INSTALL_REQUEST_COMPLETED request is sent from Web Server to SOTA Server with an Install Request ID

E2 - SOTA Server database is searched for the Install Request ID

E3 - Each VIN that is still pending to receive the software update as part of the specified Install Request is retrieved from the database

E4 - A success code is returned by SOTA Server to Web Server together with all retrieved VINs

X1 - Install Request ID does not exist. Triggered by E2

Web Server

SOTA Server

QUEUE_REQUEST_ADD called to setup the Install Request that is to be queried

E1 - A GET_INSTALL_REQUEST_COMPLETED request is sent from Web Server to SOTA Server with an Install Request ID

E2 - SOTA Server database is searched for the Install Request ID

E3 - Each VIN that has successfully completed the Install Request is retrieved, together with the timestamp of completion, from the database

E4 - A success code is returned by SOTA Server to Web Server together with all retrieved VINs

X1 - Install Request ID does not exist. Triggered by E2

Web Server

SOTA Server

QUEUE_REQUEST_ADD called to setup the Install Request that is to be queried

E1 - A GET_INSTALL_REQUEST_COMPLETED request is sent from Web Server to SOTA Server with an Install Request ID

E2 - SOTA Server database is searched for the Install Request ID

E3 - All VINs that have failed to receive a software update as a part of the specified Request ID are retrieved, together with an error code and a time stamp, from the database

E4 - A success code is returned by SOTA Server to Web Server together with all retrieved VINS and their error codes and time stamps.

X1 - Install Request ID does not exist. Triggered by E2

External Resolver

SOTA Server

Invoked by QUEUE_INITIATE_XMIT or TRANSFER_START

E1 - SOTA Server checks if there is a software update marked as in-flight for the targeted VIN

E2 - If an in-flight update was found, it is returned to the invoker of this use case. End of use case

E3 - SOTA Server retrieves all currently pending software updates for the target VIN from the database

E4 - All retrieved software updates are sorted by the priority provided to QUEUE_REQUEST_ADD when the updates were created

E5 - All software updates with the same priority are sorted by their creation date/time stamp.

E6 - The software update at the top of the priority- and date/time stamp-sorted list is retrieved for transfer, including all its dependent-upon packages

E7 - The size of the software update is verified to be less than the remaining bytes of the active billing cycle of the data plan used by the target VIN

A1 - No packages are pending for the VIN. Use case returns with a nothing-to-do answer. Triggered by E3

A2 - No data plan has been set by VIN. Use case returns successfully with the given software update. Triggered by E7

A3 - Software update size is greater than remaining size of current billing cycle. Use case returns an over size error. Triggered by E7

Web Server

SOTA Server

High-level scheduler triggers this use case periodically

E1 - All VINs with pending software or in-flight updates are retrieved. (Failed, completed, and in-flight updates are ignored.)

E2 - Each VIN is traversed in a non-specified order

E3 - If the currently traversed VIN’s Device is connected to SOTA Server, the VIN is skipped. (Ignore VINs that are currently being communicated with.)

E4 - If the currently traversed VIN has had DEV_WAKEUP, or DEV_DISCONNECT executed within the number of seconds specified by the VIN’s reconnect interval provided to VIN_ADD, the VIN is skipped. (Ignore VINs that we’ve tried to communicate with during the last number of seconds specified by the reconnect interval. Avoids continuous reconnect attempts.)

E5 - Use case QUEUE_GET_NEXT_SOFTWARE_UPDATE is executed to retrieve the next in-flight or pending software to (continue to) send to the VIN

E6 - Send a wakeup signal to trigger DEV_WAKEUP on the currently traversed VIN. (Wakeup/shoulder tap SMS)

E7 - A success code is returned together with the number VINs that have been sent a wakeup signal

A1 - QUEUE_GET_NEXT_SOFTWARE_UPDATE returns 'nothing-to-do'. Use case continues at E3 with the next VIN from the list retrieved in E1. Triggered by E5

A2 - QUEUE_GET_NEXT_SOFTWARE_UPDATE returns oversize error. Use case continues at E3 with the next VIN from the list retrieved in E1. (Will leave the oversized update as pending until the next billing cycle for the data plan used by the VIN becomes active.) Triggered by E5

SOTA Server

High-level scheduler triggers this use case periodically

E1 - All pending software updates are retrieved from the database.

E2 - Each pending software update has its date/time Install Interval compared with the current date and time.

E3 - If the current date/time is before or inside of the software update’s Install Interval, it will not be touched, and the next software pending software update is examined

E4 - If the current date/time is after the software update’s Install Interval, it will be marked as failed. (The software update will be returned in future calls to QUEUE_GET_FAILED_VINS)

E5 - The failed update will have an error code set as "expired"

E6 - The failed update will have a failure date/time stamp set to the current time.

E7 - A success code is returned together with the number of purged updates.

None

Web Server

SOTA Server

VIN added with VIN_ADD

E1 - A GET_ALL_PACKAGES request is sent from Web Server to SOTA Server with a VIN to retrieve the installed software list

E2 - The database is searched for the VIN

E3 - SOTA Server creates a GET_ALL_PACKAGES request containing the VIN, a default date/time interval, a default priority, and a creation date/time stamp set to the current time.

E4 - A unique Request ID, used in all future references to the installation request, is returned by SOTA Server to Web Server

X1 - The VIN does not exist. An error code is sent back to Web Server

Device

None

E1 - The Device receives a wakeup notification via a mobile or other network trigger mechanism.

E2 - The Device uses PKI-based signatures to validate that the wakeup notification is from SOTA Server

E3 - The DEV_CONNECT use cases is executed.

X1 - PKI validation failed. The message is ignored and the use cases is terminated. Triggered by E2

Device

SOTA Server

DEV_WAKEUP executed, or periodic server connect occurs.

E1 - The Device sets up a network connection

E2 - The Device connects to the predefined SOTA Server

E3 - The Device authenticates itself to the SOTA Server

E4 - The SOTA Server authenticates itself to the Device

E5 - Use case transitions to UPDATE_NOTIFICATION

X1 - Network connection failed. Triggered by E1.

X2 - Device Authentication fails. Use case transitions to DEV_DISCONNECT. Triggered by E3

X3 - SOTA Server Authentication fails. Use case transitions to DEV_DISCONNECT. Triggered by E4

A1 - TRIGGER_TRANSFER_START is waiting to have its message sent to SOTA Server. The use case transitions to TRIGGER_TRANSFER_START-E2. Triggered by E5.

A2 - TRANSFER_START is waiting to have its message sent to Device. The use case transitions to TRANSFER_START-E2. Triggered by E5.

A3 - TRANSFER_CHUNK is waiting to have its message sent to Device. The use case transitions to TRANSFER_CHUNK-E2. Triggered by E5.

A4 - TRANSFER_COMPLETE is waiting to have its message sent to Device. The use case transitions to TRANSFER_COMPLETE-E1. Triggered by E5.

Device

SOTA Server

Multiple

E1 - SOTA Server sends Disconnect command to Device

E2 - Device terminates network connection

E3 - Device schedules next time to execute DEV_CONNECT

X1 - Network connection lost before disconnect is received by device. Triggered by E1. DEV_CONNECT is executed X times in order to reconnet to the server.

Device

SOTA Server

DEV_CONNECT has been executed to setup and authenicate a SOTA Server - Device connection.

E1 - Use case QUEUE_GET_NEXT_SOFTWARE_UPDATE is executed to retrieve the next pending or in-flight update to transfer / continue.

E2 - A SOFTWARE_UPDATE_AVAILABLE command is sent by SOTA Server to Device with the Package IDs included in the download, size, a download index and a descriptive string

E3 - Device forwards the update information to the Software Loading Manager. The Software Loading Manager will either wait for a user confirmation, or automatically initiate the download.

E4 - Use case transitions to TRIGGER_TRANSFER_START

X1 - Network connection lost before update is received by device. Triggered by E2. DEV_CONNECT is executed X times in order to reconnet to the server.

Device

SOTA Server

UPDATE_NOTIFICATION has been executed. Connection is up.

E1 - An INITIATE_SOFTWARE_DOWNLOAD command is sent by Software Loading Manager to SOTA Client on Device

E2 - An INITIATE_SOFTWARE_DOWNLOAD command is forwarded by Device to SOTA Server together with the download index provided by UPDATE_NOTIFICATION

E3 - Use case transitions to TRANSFER_START

A1 - Software Loading Manager cancels download instead of starting it. Triggered by E1.

X1 - Network connection lost before Initiate / Cancel Software Download is sent. Triggered by E2. Use case transitions to DEV_CONNECT.

Device

SOTA Server

DEV_CONNECT has been executed to setup and authenticate a SOTA Server - Device connection OR

INSTALL_REPORT has been executed to signal the success or failure of a previous install

E1 - An INITIATE_SOFTWARE_DOWNLOAD command is received by SOTA Server from Device.

E2 - An START_DOWNLOAD command is sent by SOTA Server to Device with the Package IDs to be installed and the total size of the transfer.

E3 - Device verifies that it has the resources to receive the package from SOTA Server.

E4 - Use case transitions to TRANSFER_CHUNK

A1.1 - CANCEL_SOFTWARE_DOWNLOAD received. Triggered by E1. Use case transitions to INSTALL_REPORT with a CANCELLED result code. (Software update was cancelled by Software Loading Manager, possibly after the user pressed "no" in a confirmation dialog).

A1 - Network connection was lost before START_DOWNLOAD command was sent. Triggered by E1. Use case transitions to DEV_DISCONNECT. (No packages available for transfer since they were cancelled between QUEUE_INITIATE_XMIT and this use case)

A2 - Software update is marked as in-flight. Use case transitions to TRANSFER_CHUNK. (We are picking up a previously interrupted software update transfer and want to move on to the next chunk of the update)

A3 - Next element in queue is a GET_ALL_PACKAGES request. Use case transitions to GET_ALL_PACKAGES

Device

SOTA Server

TRANSFER_START has been executed.

Device is connected to SOTA Server

E1 - SOTA Server retrieves the lowest numbered chunk (data block) that has yet to be transferred to Device

E2 - SOTA Server transmits chunk to Device

E3 - Device receives chunk

E4 - Device stores chunk at its correct position in the package being built up

E5 - Device sense acknowledgement of successful chunk receipt to SOTA Server

E6 - SOTA Server marks chunk as successfully transmitted

E7 - Use case restarts at E1 with next untransmitted chunk

A1 - No more chunks to transmit. Triggered by E1. Use case transitions to TRANSFER_COMPLETE

X1 - Network connection is lost before chunk is received by Device. Triggered by E2. DEV_CONNECT is executed X times in order to reconned to the server. After X times, we rely on QUEUE_INITIATE_XMIT for future retries.

A2 - Chunk has already been received. Triggered by E4. (Retransmit of chunks are allowed in case the ack in E5 is lost).

X2 - Network connection lost before acknowledgement is received by SOTA Server. Triggered by E5. DEV_CONNECT is executed X times in order to reconnect to the server. Chunk will be retransmitted, and E4.A1 will handle the case. After X time, we rely on QUEUE_INITIATE_XMIT for future retries.

Device

SOTA Server

Called by TRANSFER_CHUNK-A1.

E1 - SOTA Server sends FINALIZE_DOWNLOAD command to Device

E2 - Device validates that all chunks have been received

E3 - SOTA Server marks software update as in-flight with 0 bytes left to transmit.

E4 - Use case transitions to INSTALL_SOFTWARE_UPDATE

X1 - Network connection lost before FINALIZE_DOWNLOAD command is received by Device. Triggered by E1. DEV_CONNECT is executed X times in order to reconnect to the server. After X times we rely on QUEUE_INITIATE_XMIT for future retries.

X2.1 - Chunks are missing on Device, even if SOTA Server believes all have been transmitted. Triggered by E2. Use case transitions to INSTALL_SOFTWARE_UPDATE with an INCOMPLETE_DOWNLOAD result code.

Device

TRANSFER_COMPLETE executed.

E1 - Device verifies signature and integrity of software updates.

E2 - Device sends an INSTALL command to the Software Loading Manager.

E3 - Software Loading Manager returns an installation result code and descriptive text.

E4 - The installation result is forwarded to the INSTALL_REPORT use case.

X1 - Package validation fails. Triggered by E1. Use case transitions to INSTALL_REPORT with a VALIDATION_FAIL result code.

Device

SOTA Server

External Resolver

INSTALL_SOFTWARE_UPDATE executed.

E1 - Device sends report with provided result code to SOTA Server

E2 - If result code is SUCCESS, the software update for the VIN is marked as completed.

E3 - If result code is not SUCCESS, the software update for the VIN is marked as failed together with provided result code.

E4 - If result code is SUCCESS, the VIN_ADD_PACKAGE use case is executed to update the installed package list of the External Resolver Database.

E5 - Use case transitions to TRANSFER_START to start the transmission of the next software update for the VIN.

X1 - Network connection lost before report is received by SOTA Server. Triggered by E1. DEV_CONNECT is executed X times in order to reconnect to the server.

A1 - VIN is already marked as completed. Triggered by E2. Use case transitions to TRANSFER_START.

A2 - VIN is already marked as failed. Triggered by E3. Use case transitions to TRANSFER_START.

Device

SOTA Server

DEV_CONNECT has been executed to setup and authenticate a SOTA Server - Device connection OR

INSTALL_REPORT has been executed to signal the success or failure of a previous install.

E1 - Use case QUEUE_GET_NEXT_SOFTWARE_UPDATE is executed to retrieve the next pending or in-flight update to transfer / continue, yielding instead a queued GET_ALL_PACKAGES request.

E2 - A GET_ALL_PACKAGES command is sent by SOTA Server to Device.

E3 - Device uses local package manager to retrieve a list of all installed packages

E4 - Device returns all installed packages to SOTA Server.

E4.1 - SOTA Server uses VIN_PACKAGE_ADD and VIN_PACKAGE_DELETE to synchronize External Resolver’s installed package list for the given VIN.

E5 - Use case transitions to TRANSFER_START to start.

X3 - Acknowledgement lost due to network disconnect. Triggered by E4. DEV_CONNECT is executed X times in order to reconnect to the server. After X times, we rely on QUEUE_INITIATE_XMIT for future retries.