Changes

Page history
Update Requirements, Design and Approach authored by Sourabh Roy's avatar Sourabh Roy
Show whitespace changes
Inline Side-by-side
Requirements,-Design-and-Approach.md
View page @ 4d127e9a
**<h2>1. Introduction</h2>** <h2>1. Introduction</h2>
<h4>1.1 Purpose of this document</h4> <h4>1.1 Purpose of this document</h4>
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; The objective of this document is to provide functional and non-functional requirements for OSDU Admin UI development team to develop a front-end project for accessing existing API which are currently invoked by Postman. This solution will ease up a lot of admin tasks with the intended UI.<br/> &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; The objective of this document is to provide functional and non-functional requirements for OSDU Admin UI development team to develop a front-end project for accessing existing API which are currently invoked by Postman. This solution will ease up a lot of admin tasks with the intended UI.<br/>
<h4>1.2 Project Background</h4> <h4>1.2 Project Background</h4>
...@@ -24,5 +24,7 @@ Discussions with various Module Owners and CSP is in progress and below requirem ...@@ -24,5 +24,7 @@ Discussions with various Module Owners and CSP is in progress and below requirem
<h2>2. Detailed Business Requirements - Functional</h2> <h2>2. Detailed Business Requirements - Functional</h2>
&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;Below are the point of contacts driving the requirements for Admin UI Project: &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;Below are the point of contacts driving the requirements for Admin UI Project:
<table><thead><th>Modules</th><th>Point of Contact</th><th>Initial Business Requirements Discussion</th><th>User Stories Received</th><th>API Availability</th><th>Prototype Screens Developed</th><th>Access to API</th><thead><tbody><tr> <td>Information Security</td> <td>Paco Hope</td> <td>Completed</td> <td>Completed</td> <td>Yes</td> <td>In Progress</td> <td>No</td> </tr><tr> <td>Data Platform</td> <td>Philip Jong & Stephen Whitley</td> <td>Completed</td> <td>In Progress</td> <td>To be Identified</td> <td>To be Created</td> <td>No</td> </tr> <tr> <td>Data Ingestion</td> <td>Stephen Whitely</td> <td>Completed</td> <td>To be Identified</td> <td>To be Identified</td> <td>To be Created</td> <td>No</td> </tr> <tr> <td>E&O</td> <td>Hrvoje Markovic</td> <td>Completed</td> <td>In Progress</td> <td>Yes</td> <td>Yes</td> <td>No</td> </tr> <tr> <td>Audit and Metrics</td> <td>Nidhi Fotedar</td> <td>Open</td> <td>To be Identified</td> <td>To be Identified</td> <td>To be Created</td> <td>No</td> </tr> <tr> <td>Data Loading</td> <td>Michael Haven</td> <td>Completed</td> <td>To be Identified</td> <td>To be Identified</td> <td>To be Created</td> <td>No</td> </tr> <tr> <td>System Configuration</td> <td>Raj Kannan</td> <td>In Progress</td> <td>To be Identified</td> <td>To be Identified</td> <td>To be Created</td> <td>No</td> </tr></tbody></table> <table><thead><th>Modules</th><th>Point of Contact</th><th>Initial Business Requirements Discussion</th><th>User Stories Received</th><th>API Availability</th><th>Prototype Screens Developed</th><th>Access to API</th><thead><tbody><tr> <td>Information Security</td> <td>Paco Hope</td> <td>Completed</td> <td>Completed</td> <td>Yes</td> <td>In Progress</td> <td>No</td> </tr><tr> <td>Data Platform</td> <td>Philip Jong & Stephen Whitley</td> <td>Completed</td> <td>In Progress</td> <td>To be Identified</td> <td>To be Created</td> <td>No</td> </tr> <tr> <td>Data Ingestion</td> <td>Stephen Whitely</td> <td>Completed</td> <td>To be Identified</td> <td>To be Identified</td> <td>To be Created</td> <td>No</td> </tr> <tr> <td>E&O</td> <td>Hrvoje Markovic</td> <td>Completed</td> <td>In Progress</td> <td>Yes</td> <td>Yes</td> <td>No</td> </tr> <tr> <td>Audit and Metrics</td> <td>Nidhi Fotedar</td> <td>Open</td> <td>To be Identified</td> <td>To be Identified</td> <td>To be Created</td> <td>No</td> </tr> <tr> <td>Data Loading</td> <td>Michael Haven</td> <td>Completed</td> <td>To be Identified</td> <td>To be Identified</td> <td>To be Created</td> <td>No</td> </tr> <tr> <td>System Configuration</td> <td>Raj Kannan</td> <td>In Progress</td> <td>To be Identified</td> <td>To be Identified</td> <td>To be Created</td> <td>No</td> </tr></tbody></table>
<h5>a. Login Screen</h5> <h4>a. Login Screen</h4>
<ul> <li>Initially Philip had provided requirements for a login and register screens. However, after discussions with Paco and Philip individually, it was decided that login screens should not be created for Admin UI</li> <li>Authentication and authorization will happen using the IDP and E&O APIs</li> <li>Access to OSDU Admin UI tool will be through bearer token generated through the IDP where the OSDU data platform is deployed</li> <li>Admin UI Portal will have unique URL’s depending on which instance it has been hosted on. </li> <li>Login and Registration is not part of Admin UI Development. It will be taken care by Organisations in their own IDP.</li> </ul> <ul> <li>Initially Philip had provided requirements for a login and register screens. However, after discussions with Paco and Philip individually, it was decided that login screens should not be created for Admin UI</li> <li>Authentication and authorization will happen using the IDP and E&O APIs</li> <li>Access to OSDU Admin UI tool will be through bearer token generated through the IDP where the OSDU data platform is deployed</li> <li>Admin UI Portal will have unique URL’s depending on which instance it has been hosted on. </li> <li>Login and Registration is not part of Admin UI Development. It will be taken care by Organisations in their own IDP.</li> </ul>
<h4>b. Landing page (Home page)</h4>
After Successful authentication from the respective IDP, user will be redirected to the Landing page (Home page).This home page will list below modules:
\ No newline at end of file