Read Document

The Customer Sales Representative or Finance Department User wants to via CRM / Finance system GUI read document created by OCS.io. This operation is available in the CRM / Finance system GUI for users with correct privileges.

The CRM / Finance system via the RESTful API requests for reading of the document from the OCS.io. The request parameters contains the Document details and information necessary for retrieving of the document.

The OCS.io reads the document, then returns the document as a payload of the response.

The CRM / Finance system formats the document and presents it to the User in the GUI.

Primary Actor

Customer Sales Representative or Finance Department User.

Basic Flow

Step	Actor	Action	Description
1.	CSR / FIN User	Search Document	Customer Sales Representative or Finance Department User via CRM / Finance GUI searches for a Document.
2.	CRM / Finance	Display Search Document	CRM / Finance System displays result of Search Document to the User.
3.	CSR / FIN User	Request for Read Document Details	Customer Sales Representative or Finance Department User via CRM / Finance GUI requests for 'Read Document Details'.
4.	CRM / Finance	Call readDocument API	CRM / Finance System calls Read Document API exposed by OCS.io.
5.	OCS.io	Request Validations	OCS.io validates Request whether all mandatory attributes are populated, all data types are valid, ENUMs match with definition, etc. Additionally, OCS.io validates Request against Business Logic. This typically includes, that referenced entity exists in the system, entity has proper state, etc.
6.	OCS.io	Perform Business Logic	OCS.io performs Business Logic implemented for the Use-Case.
7.	OCS.io	Return readDocument Response	OCS.io returns Response to the CRM / Finance System.
8.	CRM / Finance	Result of Read Document Details	CRM / Finance system displays result of 'Read Document Details' to the User.

Step

Actor

Action

Description

CSR / FIN User

Search Document

Customer Sales Representative or Finance Department User via CRM / Finance GUI searches for a Document.

CRM / Finance

Display Search Document

CRM / Finance System displays result of Search Document to the User.

CSR / FIN User

Request for Read Document Details

Customer Sales Representative or Finance Department User via CRM / Finance GUI requests for 'Read Document Details'.

CRM / Finance

Call readDocument API

CRM / Finance System calls Read Document API exposed by OCS.io.

OCS.io

Request Validations

OCS.io validates Request whether all mandatory attributes are populated, all data types are valid, ENUMs match with definition, etc.

Additionally, OCS.io validates Request against Business Logic. This typically includes, that referenced entity exists in the system, entity has proper state, etc.

OCS.io

Perform Business Logic

OCS.io performs Business Logic implemented for the Use-Case.

OCS.io

Return readDocument Response

OCS.io returns Response to the CRM / Finance System.

CRM / Finance

Result of Read Document Details

CRM / Finance system displays result of 'Read Document Details' to the User.

Request Validations

The following validations are performed when reading a document:

Document must exist in the system.
Document Type associated with the Document must be configured in the way, that documents of that type are stored in the system.

Perform Business Logic

System returns JSON Payload of the Document.