[POLICY] Enable policy management in Trace-X

[mkanal]

As admin
I want to create / update and delete policy definitions
so that trace-x is able to create policy

Link

• releated to Concept: Enable policy management in Trace-X #568
• https://github.com/eclipse-tractusx/policy-hub/tree/release/v0.1.0-rc.4/docs/technical-documentation/requests
• [POLICY] Enable Policy Hub API for Policy Validation #880

Hints / Details

• https://github.com/eclipse-tractusx/policy-hub/blob/release/v0.1.0-rc.4/docs/technical-documentation/requests/example-requests.md
• https://miro.com/app/board/uXjVO5JVoho=/?moveToWidget=3458764578856827872&cot=14
• https://github.com/eclipse-tractusx/traceability-foss/blob/main/docs/concept/%23568-policy-management/%23568-policy-management.md

Acceptance Criteria

• Accessible only for role "Admin"

Master View

• Deletion of Policies single and multiple selection in tableView

• Column Settings for customizing the table

• Number of selected policies is shown

• Constraints are shown in a comprehensive form in yaml syntax as preview (policy type is shortened to 3 rows and 50 characters) To see the full policy the policy has to opened "View Policy"

• View Policy is Edit and Create Policy Dialog in ReadOnly

• Operator eq neq in not in are supported

Detail View

• Policy create/Edit view implemented as in Miro Concept
• BE Validation for policy constrains validation is implemented against the policy hub
• In case a policy is uploaded in Edit mode the policy will override the current definition. In this case, a confirmation dialog will be shown. "Policy is override. Do you really want to override the current policy? " Yes / No?

 PolicyType 
           logicalOperator
                  leftOperand operator [rightOperand]
                  leftOperand operator [rightOperand]
                  leftOperand operator [rightOperand]

Usage
           and
                  Membership eq  [activre]
                  BusinessPartnerNumber eq [BPNL00000003CRHK]
                  FrameworkAgreement in [Traceability, Quality, PCF]

Access
           or
                  BusinessPartnerNumber in [BPNL00000003CRHK, BPNL00000003CRHF, BPNL00000003CRHO]

`

Additional Info

• JSON upload will replace the whole content when creating/editing policies
• Detailed View can be easily added (almost like edit view but in read-only mode) --> to be discussed

Out of Scope

• Table filter supported for all columns
• Table uses pagination
• Table uses sorting
• Table uses autocomplete
• Create Policy - no bpn autocomplete since no API will be provided
• No template upload/download

[mkanal]

@ds-mwesener @ds-crehm
Please prepare the story that it could be relaized within the next iteration. Thank you very much.

[ds-crehm]

@mkanal
JSON upload for "Edit policies" possible?
Dev recommmendation: Yes (less effort, consistency)

IRS policy store doesn't offer pagination/sorting/filtering -> not possible to implement in Trace-X

[ds-crehm]

Some possible improvements:

CREATING POLICIES:

1. Why is there a character limit for BPNs and why 84?
2. Tooltip when saving the policy should be "Save policy" (DE: "Richtlinie speichern")
3. Save icon should be blue when enabled like in quality notifications
4. A policy can be saved when all constraints are empty. That should not be possible.
5. Since at least one constraint is mandatory, there should be an empty one when starting the creation of policies and it should not be possible to delete all constraints (there should be always one)
6. Tooltip for adding constraints should be "Add constraint" instead of just "Add"
7. When adding more than three constraints, you can't see what's happening anymore. An indicator of the amount of constraints would be nice (then you can see that the number is increasing)
8. Tooltips for uploading are not accurate. I'm not uploading a template. I'm uploading a policy as JSON (maybe I used the provided tamplate for it, but the it's not a template anymore) -> "Upload policy JSON" & "Apply content from file overwriting existing data" or something like that would be better
9. I would not show this field. Instead I would only show the file name as text, if I actually uploaded anything.
10. Date picker is overlapping data
11. German instruction "Die Reihenfolge der Regeln wird berücksichtigt" is strange. Should be "Bitte berücksichtigen Sie, dass die Reihenfolge der Regeln relevant ist" (consistent with the English one)
12. I would not say "Zeichenfolgen" and "String" -> For the user "Text"/"text" would be easier to understand.
13. In the field it says "BPNLs" in the label it says "BPNs".
14. "0 Characters." and "84 Characters left." tooltips -> Remove the dots and write characters in lowercase.
15. This one is wrong. That was improved already in the other tables and looks like this now: (Although I would remove the dot at the end as well)
16. Tooltip overlaps the arrow. That's annoying when trying to move a contraint up multiple times.
17. The name of the default policy template is "policy-template-.json". The last dash should be removed.

DETAIL VIEW:

1. This should not be possible - will seem strange to the user
2. Data not very readable
3. Input instructions in read-only mode should be removed.
4. When switching from detail view to edit mode and then clicking "Back", I would expect to get back to the detail view. Instead I get back to the table.

POLICY TABLE:

1. Always "AND" at the end
2. Title should be "Confirm deletion" instead. (Can be reused as well) In German "Löschen bestätigen". Text should be "Do you want to delete the selected policies?" In German "Möchten Sie die ausgewählten Richtlinien löschen?" And the list of policies may be graphically improved a little. Right now it doesn't look too great.

[mkanal]

Review:

• Why do I have to add a text longer than 8 character for PolicyId ?

• Please enter a valid BPN. Please add user feedback how a valid BPN should look like.

• Okay I forgot to fill out the date - is it mandatory ? Please give user feedback to have a valid form. The disabling tooltip is very generic. Proposal "Incomplete policy could not be saved"
  

• Typo in disabled tooltip atleast > at least

• Description is in the wrong column
  

• Too generic error message left operand is missing

[mkanal]

@ds-crehm and @ds-mmaul
Please address review results. Please show me the feature in next review session.

[ds-mmaul]

Review:

• Why do I have to add a text longer than 8 character for PolicyId ?
• Please enter a valid BPN. Please add user feedback how a valid BPN should look like.
• Okay I forgot to fill out the date - is it mandatory ? Please give user feedback to have a valid form. The disabling tooltip is very generic. Proposal "Incomplete policy could not be saved"
  
• Typo in disabled tooltip atleast > at least

• Description is in the wrong column
  
• Too generic error message left operand is missing

• Why do I have to add a text longer than 8 character for PolicyId ?

• removed minlength 8 of policyname

• Please enter a valid BPN. Please add user feedback how a valid BPN should look like.

• Provided example in error hint

• Okay I forgot to fill out the date - is it mandatory ? Please give user feedback to have a valid form. The disabling tooltip is very generic. Proposal "Incomplete policy could not be saved"

• fixed with form validation on save button hover. The tooltip should now be enough because the invalid form inputs will now transition into error state

• Typo in disabled tooltip atleast > at least

• fixed

• Description is in the wrong column

• adjusted

• Too generic error message left operand is missing

• fixed with form validation on save button hover. The tooltip should now be enough because the invalid form inputs will now transition into error state

[ds-mmaul]

fixed with #1094

[ds-crehm]

• Description is in the wrong column

This doesn't make sense to me.

I'm typing comma-separated text in the Right Operand column, not in the Operator column.

Everything else looks good to me.

[ds-mmaul]

The concept states that the label should be under the right operand, which is what I implemented. With feedback from @mkanal , I changed the label to be positioned under Operator (middle). @mkanal , @ds-crehm please clarify whats needed and provide feedback so I can adjust to your requirements. Thank you

• Description is in the wrong column

This doesn't make sense to me. I'm typing comma-separated text in the Right Operand column, not in the Operator column.

Everything else looks good to me.

[mkanal]

LGFM. PO acceptance in behalf of @jzbmw