eclipse-tractusx / sig-release

https://eclipse-tractusx.github.io/sig-release
Apache License 2.0
9 stars 10 forks source link

Optimize the CSV upload of sites and addresses #948

Open maximilianong opened 4 weeks ago

maximilianong commented 4 weeks ago

Overview

The portal provides the option to upload sites and addresses for a legal entity via CSV.

https://github.com/eclipse-tractusx/sig-release/issues/700

However, this page should be revised at certain points to make it easier for users to understand.

What's the benefit?

Companies can easily provide their site and address data, required for various use cases, to the data space via CSV upload. This allows them to contribute their own data to the Golden Record process without having to be a sharing member.

What are the Risks/Dependencies ?

BPDM team provided an API for this CSV upload.

Detailed explanation

Current implementation

https://github.com/eclipse-tractusx/sig-release/issues/700

Proposed improvements

Feature Team

Contributor

Committer

User Stories

Acceptance Criteria

Test Cases

Test Case 1

Steps

  1. Do something
  2. Click something
  3. Add something

Expected Result

  1. Expectation
  2. Expectation
  3. Expectation

Architectural Relevance

The following items are ensured (answer: yes) after this issue is implemented:

Justification: (Fill this out, if at least one of the checkboxes above cannot be ticked. Contact the Architecture Management Committee to get an approval for the justification)

Additional information

Cofinity-UX commented 4 weeks ago

@maximilianong Proposal for basic functionality, usability and wording fixes (I could not access the latest version of the reference implementation, maybe some points are already updated) Kindly add me as Contributor in this ticket, thank you!

General structure of page:

UX writing updates:

Main page:

Company Data Detail Modal:

Add Address/Site Modals:

cc: @MaximilianHauer @ybidois

Cofinity-UX commented 2 weeks ago

Hi @SujitMBRDI, can you explain what processes are happening in the background for the two status labels "pending" and "ready" (context: adding site data on Company Data page). Thank you!

Bildschirmfoto 2024-11-05 um 15 23 06 Bildschirmfoto 2024-11-05 um 15 23 18

cc: @maximilianong

SujitMBRDI commented 2 weeks ago

Hi @SujitMBRDI, can you explain what processes are happening in the background for the two status labels "pending" and "ready" (context: adding site data on Company Data page). Thank you! Bildschirmfoto 2024-11-05 um 15 23 06 Bildschirmfoto 2024-11-05 um 15 23 18

cc: @maximilianong

Hello @Cofinity-UX,

The logic behind these two sharing state is as below,

Ready - When a sharing member uploads new business partner input data, the sharing member might not want to share this data immediately to the golden record process. The sharing member may perform additional checks on analysis on it first, prepare it further, before deciding it is fit to be shared.

Pending - After a sharing member has updated the business partner input data, the BPDM Gate should request a cleaning of the input data at the orchestrator. The orchestrator will create a new cleaning task and return its unique identifier to the requesting Gate. A Gate should then save the task identifier for its business partner data and update its sharing state.

Cofinity-UX commented 2 weeks ago

Hi @SujitMBRDI, thank you for clarifying. Regarding the Ready status: right now, if I'm adding a site (Entry DEV (24.08)), the status goes automatically to pending. Where is the functionality to actively share the site data to the Golden Record process?

SujitMBRDI commented 2 weeks ago

Hi @SujitMBRDI, thank you for clarifying. Regarding the Ready status: right now, if I'm adding a site (Entry DEV (24.08)), the status goes automatically to pending. Where is the functionality to actively share the site data to the Golden Record process?

Hello @Cofinity-UX,

The functionality is totally depending on configuration you made while deploying application. Here is link for you reference. So, you can choose configurations as per the need like if you don't want business partner input data to directly ready to be shared then assign starts-as-ready to false likewise configurations can be changed.

Cofinity-UX commented 2 weeks ago

Hi @SujitMBRDI, if a customer subscribes to an application or service, the expectation is that the functionality is ready to use. So what you are describing is a scenario where a technically skilled user sets up this configuration in the backend, did I get that correctly? There is neither the information beforehand that this configuration can/must be taken nor any UI to do this connected to the Company Data page in the Portal?

@maximilianong how is this configuration planned to face a customer?

SujitMBRDI commented 1 week ago

Hi @SujitMBRDI, if a customer subscribes to an application or service, the expectation is that the functionality is ready to use. So what you are describing is a scenario where a technically skilled user sets up this configuration in the backend, did I get that correctly? There is neither the information beforehand that this configuration can/must be taken nor any UI to do this connected to the Company Data page in the Portal?

@maximilianong how is this configuration planned to face a customer?

Hello @Cofinity-UX,

I am not saying configuration planned to face a customer, you asked me to provide process which are happening in background. So as explained, due to default configuration on backend which is starts-as-ready set to true. It results when you add site then the status goes to automatically to Pending and after golden record process you will receive status as Success or Error.

Cofinity-UX commented 1 week ago

@SujitMBRDI From a UX point of view I need to understand both, background processes which then affect the user interaction on touchpoint level. Since the user won't do the BE configuration, we (as provider of the service) need to decide, which configuration will be set in place, right?

If "starts-as-ready" is set to true, which interaction of the user will then set it to "pending"?

SujitMBRDI commented 1 week ago

@SujitMBRDI From a UX point of view I need to understand both, background processes which then affect the user interaction on touchpoint level. Since the user won't do the BE configuration, we (as provider of the service) need to decide, which configuration will be set in place, right?

If "starts-as-ready" is set to true, which interaction of the user will then set it to "pending"?

@Cofinity-UX Yes, you are right.

stephanbcbauer commented 1 week ago

Some hints from Release Management (@ther3sa) and Tractus-X Project Lead (@stephanbcbauer)

Cofinity-UX commented 1 week ago

Hi @SujitMBRDI, to determine with configuration to take for our customers, I still need to know: If "starts-as-ready" is set to true, what (or which interaction of the user) needs to happen to set the status to "pending"?

SujitMBRDI commented 1 week ago

Hi @SujitMBRDI, to determine with configuration to take for our customers, I still need to know: If "starts-as-ready" is set to true, what (or which interaction of the user) needs to happen to set the status to "pending"?

Hello @Cofinity-UX, I suggest to setup meeting between us where i can provide you more details. But anyways, my point is simple here considering interaction of user while sharing data is nothing to do with configuration that i explained to you(I explained the configuration for your understanding). For User perspective - Once user share data, it will be automatically part of golden record process and there are stages of sharing for user shared data. In simple words you can interpret stages like Ready - is the stage where data is already initialised and ready to share for golden record data processing and Pending - is stage where data is being processed for golden record once golden record process finish then sharing stage will be either Success(consider shared data has been accepted for golden record) or Error(here shared data has not been accepted by golden record and you will also get error message why it was not accepted). Ideally, if you merge the both Ready and Pending sharing stages then you can say data is InProcess or InProgress something like that as both stages has very minimal difference in them.

Cofinity-UX commented 1 week ago

Totally agree @SujitMBRDI, a session is needed. I'll send you an invite for next week, anyone from your side who should join (@MaximilianHauer?)

manojava-gk commented 1 week ago

@Cofinity-UX add me to the list. would like to participate in the meeting

stephanbcbauer commented 1 week ago

@maximilianong mentioned this feature needs still some kind of refinement

stephanbcbauer commented 1 week ago

@MaximilianHauer mentioned -> Review by committer could be the problem. A lot todo

stephanbcbauer commented 1 week ago

@evegufy mentioned to prioritize this feature as high (from portal side)

evegufy commented 1 week ago

Acknowledging the fact that there is still refinement needed, Portal Committers: @oyo @ntruchsess @Phil91 @evegufy