/ EUROPEAN COMMISSION
DIRECTORATE-GENERAL
INFORMATICS
Information systems Directorate

European Commission

e-TrustEx Use Case Specification: Retrieve Document Wrapper

Date: / 5/06/2012
Version: / 0.001
Authors: / Alice Vasilescu
Revised by: / Technical Review:
Quality Review:
Approved by:
Public:
Reference Number:

TABLE OF CONTENTS

1. Use-Case Description 1

1.1. Functional Features List 1

1.2. Actor List 1

2. Flow of Events 1

2.1. B1: Basic Flow 1

2.1.1. User submits a message 1

2.1.2. System authenticates and authorizes access to the User 1

2.1.3. System validates the message against the schema 2

2.1.4. System validates the business rules of "hard" severity relating to the message content: 2

2.1.5. System queries the message repository 2

2.1.6. System submits the Document Wrapper Response 2

Variations of Data used in the Basic Flow (Same behavior is expected) 3

2.2. SubFlows 3

2.3. Alternative Flows 3

2.3.1. A1: At step 2.1.6 System queries the message repository, when no document matches the query criteria (in most cases because of incorrect document type and/or documentID) 3

2.4. Exceptional Flows 3

2.4.1. E1: At step 2.1.1 User submits a message the system is down 3

2.4.2. E2: At step 2.1.3”System validates the message against the schema”, the validation fails 3

2.4.3. E3: At step 2.1.4” System validates the business rules of "hard" severity relating to the message content”, one of the rules fails 3

2.4.4. E4: At step2.1.5”System queries the message repository”, technical failure is reported 4

2.4.5. E5: At step 2.1.6 “System submits the Document Wrapper Response”, a technical error occurs regarding the connection with the User 4

3. Special Requirements 4

3.1. Interface(s) with other Systems 4

3.2. SecurityRequirements 4

3.3. Other Non Functional Features 4

3.4. Constraints 4

4. Preconditions 4

5. Postconditions 4

5.1. Postcondition One 4

6. Additional Information 4


Document History

Version / Date / Comment / Modified Pages
0.001 / 5/06/2012 / Creation / All

e-TrustEx Use Case Specification: Retrieve Document Wrapper - Page ii

1. Use-Case Description

This service enables the User to retrieve a Document Wrapper (a.k.a Binary file) from the e-TrustEx system.

1.1. Functional Features List

Data / FEAT126 / Support of binary file description
Size / FEAT127 / Support of large binary files
Data / FEAT138 / Retrieval of a received binary file
Auditability / FEAT139 / Logging

1.2. Actor List

User / Any system using this service
System / e-TrustEx

2. Flow of Events

The details of Document Wrapper message can be found at the following location:

https://webgate.ec.europa.eu/CITnet/svn/digit-elnvoicing/trunk/03-Development/03 e-TrustEx/0003 Analysis & Design/xml

The details on e-PRIOR's state machines can be found in svn:

https://webgate.ec.europa.eu/CITnet/svn/digit-elnvoicing/trunk/03-Development/03 e-TrustEx/0003 Analysis & Design/eTrust_ARCH.doc

The details of the SOAP faults can be found in svn:

http://citnet.cec.eu.int/CITnet/svn/digit-elnvoicing/trunk/03-Development/01%20e-PRIOR/0003%20Analysis%20&%20Design/001%20Data%20Model/1000%20Faults/

User Access use case can be found in svn:

https://webgate.ec.europa.eu/CITnet/svn/digit-elnvoicing/trunk/03-Development/03 e-TrustEx/0002 Requirements/Use Case Model/Infrastructure Services/User+Access+Use+Case+Specification.doc

2.1. B1: Basic Flow

2.1.1. User submits a message

  • This use case starts when the User submits a message to the Retrieve Document Wrapper service end-point. In case the User is outside of EC internal network, this opens an https connection between the User and the System.

2.1.2. System authenticates and authorizes access to the User

  • Include Use Case “User Access” to authenticate and authorize access to the User.

2.1.3. System validates the message against the schema

  • The system validates the message against the Document Wrapper Request XML Schema Design rules (i.e. data types, mandatory/ optional data elements and attributes, data elements multiplicity)

ID / Description /
RULE59 / The system checks that the message conforms to the Document Wrapper Request schema

2.1.4. System validates the business rules of "hard" severity relating to the message content:

ID / Description
RULE279 / The SenderParty ID must be present and not empty in the message payload

2.1.5. System queries the message repository

  • The essential parameters for the system to perform the Document Wrapper Retrieve Request of a business document are provided below.

Element / Xpath
Receiver Party ID / Header.BusinessHeader.Sender.Identifier
Receiver User / The user provided as authentication data
ID / ID
Document Type Code / DocumentTypeCode
SenderParty ID / SenderParty.EndpointID
  • System queries for Document Bundles:
  • With specific Receiver Party
  • With a specific Receiver User
  • With specific Sender Party
  • With the retrieved Document Bundles, the system selects the linked Document Wrapper:
  • Of a specific Document Type Code and
  • With a specific Document ID
  • System builds the Document Wrapper Response

2.1.6. System submits the Document Wrapper Response

  • Based on the result of the previously mentioned query, the system builds the Document Wrapper Response. ONLY a single document matches the previously mentioned criteria, the full structured content of this matching document is returned in this message

Note: The response message contains a single (retrieved) Document Wrapper

  • System responds with a Document Wrapper Response having in its Document Content the data of the requested document wrapper. The binary content is carried within a MIME multipart.
  • This closes the secured connection between the User and the system
  • Use Case Ends

Variations of Data used in the Basic Flow (Same behavior is expected)

  • Not identified.

2.2. SubFlows

  • Not identified.

2.3. Alternative Flows

2.3.1. A1: At step 2.1.6 System queries the message repository, when no document matches the query criteria (in most cases because of incorrect document type and/or documentID)

  • The essential parameters for the system to perform the retrieve request of a business document are the same. However no document matches the query criteria (in most cases because of incorrect document type and/or documentID)
  • When no document was found in the message repository matching the criteria. The system responds with a Retrieve Request Response with empty Document Content
  • This closes the https connection between the User and the system
  • The Use Case Ends.

2.4. Exceptional Flows

2.4.1. E1: At step 2.1.1 User submits a message the system is down

  • The User receives a 503 Service Unavailable

·  The Use Case Ends.

2.4.2. E2: At step 2.1.3”System validates the message against the schema”, the validation fails

  • When broken XSD constraints are reported (1 or more), the System submits a SOAP Fault [6]
  • This closes the https connection between the User and the system
  • The Use Case Ends.

2.4.3. E3: At step 2.1.4” System validates the business rules of "hard" severity relating to the message content”, one of the rules fails

  • When some rules of “hard” severity fails, the System submits a SOAP Fault [8] with the description of the failed rule and the "DWR:4" code.
  • This closes the https connection between the User and the system
  • The Use Case Ends

2.4.4. E4: At step2.1.5”System queries the message repository”, technical failure is reported

  • When technical error occurs, the System submits a SOAP Fault [1]
  • This closes the https connection between the User and the system

·  The Use Case Ends

2.4.5. E5: At step 2.1.6 “System submits the Document Wrapper Response”, a technical error occurs regarding the connection with the User

  • The system detects when a User closes its connection
  • In this case the system cannot respond to the subsequent request

·  The Use Case Ends

3. Special Requirements

3.1. Interface(s) with other Systems

None.

3.2. SecurityRequirements

The reader should refer to chapter 1.1 Functional Features List of subtype "Security"

3.3. Other Non Functional Features

N/A

3.4. Constraints

N/A

4. Preconditions

There are currently no preconditions defined.

5. Postconditions

5.1. Postcondition One

Following the basic flow the system responds with an Retrieve Request Response.

6. Additional Information

List of response codes for document Wrapper used in this use case:

Code / Label
DWR:4 / Hard business rule violated

e-TrustEx Use Case Specification: Retrieve Document Wrapper - Page 3 / 4