Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create/Edit/Delete Submodel #195

Open
4 tasks
Tracked by #8
aaronzi opened this issue Jan 4, 2025 · 0 comments · May be fixed by #231
Open
4 tasks
Tracked by #8

Create/Edit/Delete Submodel #195

aaronzi opened this issue Jan 4, 2025 · 0 comments · May be fixed by #231
Assignees
Labels
enhancement New feature or request VWS4LS Tickets related to VWS4LS Project

Comments

@aaronzi
Copy link
Member

aaronzi commented Jan 4, 2025

As a BaSyx user,
I want to be able to create, edit and delete Submodels using the AAS Web UI.

Rules

  • A button to create new Submodels should only be available if the editor mode is enabled via the respective environment variable
  • Editing/Deleting Submodels should only be available if the editor mode is enabled via the respective environment variable
  • Authorization is out of scope for this ticket as well
  • The button to create new submodels should be located in the AASTreview component [1]
  • Clicking the button should open a dialog with an input mask for entering Submodel information
  • Editing/deleting a Submodel should be available via action buttons in the VTreeview component at the respective submodel [2]
  • All Submodel traits should be supported in the input mask (see meta-model v3 [4] p. 59)
  • The input mask for creating a Submodel should be its own component in the "EditorComponents" directory [3]
  • The input mask for Submodels should be the same for create and edit
  • The input mask should include validation respecting the specific requirements for the respective trait (if it's mandatory, should follow specific rules, ...)
  • Already created input components from Create/Edit/Delete AAS #10 should be leveraged
  • Vuetify's v-expansion-panels [5], v-text-field [6], v-select [7], v-btn [8] and v-dialog [9] should be used
  • Vuetifies rule attribute for v-text-field and v-select should be leveraged for validation including form validation [10] before saving

Entry Points

[1] https://github.com/eclipse-basyx/basyx-aas-web-ui/blob/main/aas-web-ui/src/components/AASTreeview.vue
[2]

<v-icon v-else-if="item.modelType === 'Submodel' && !item.children" color="primary">
mdi-folder-alert
</v-icon>
<!-- Icon for Submodel with children (open/closed) -->
<v-icon v-else-if="item.modelType === 'Submodel' && item.children" color="primary">
{{ showChildren ? 'mdi-folder-open' : 'mdi-folder' }}
</v-icon>

[3] https://github.com/eclipse-basyx/basyx-aas-web-ui/tree/main/aas-web-ui/src/components/EditorComponents

Acceptance Criteria

  • New component that includes an input mask for creating/editing all relevant Submodel properties [4] p. 63
  • Adding new Submodels is possible via a button located in [1] using the mentioned input mask
  • Updating Submodel information is possible via an action button located in [2] by using the input mask as well
  • Deleting a Submodel is possible via an action button located in [2]

Risks and Assumptions

References and Notes

[4] https://industrialdigitaltwin.org/wp-content/uploads/2023/06/IDTA-01001-3-0_SpecificationAssetAdministrationShell_Part1_Metamodel.pdf
[5] https://vuetifyjs.com/en/components/expansion-panels/#usage
[6] https://vuetifyjs.com/en/components/text-fields/#usage
[7] https://vuetifyjs.com/en/components/selects/#usage
[8] https://vuetifyjs.com/en/components/buttons/#usage
[9] https://vuetifyjs.com/en/components/dialogs/#usage
[10] https://vuetifyjs.com/en/components/forms/#rules

Dependencies and Blockers

Env variable to disable the editor mode was implemented before in #8
Input components that are relevant for creating/editing shells were implemented before in #10

@aaronzi aaronzi converted this from a draft issue Jan 4, 2025
@aaronzi aaronzi self-assigned this Jan 4, 2025
@aaronzi aaronzi added enhancement New feature or request VWS4LS Tickets related to VWS4LS Project labels Jan 4, 2025
@github-project-automation github-project-automation bot moved this to To triage in Support Requests Jan 4, 2025
@aaronzi aaronzi moved this from Backlog to In Progress in BaSyx for VWS4LS Jan 4, 2025
@aaronzi aaronzi moved this from In Progress to Backlog in BaSyx for VWS4LS Jan 6, 2025
@aaronzi aaronzi mentioned this issue Jan 7, 2025
18 tasks
@aaronzi aaronzi moved this from Backlog to In Progress in BaSyx for VWS4LS Jan 9, 2025
@aaronzi aaronzi linked a pull request Jan 9, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request VWS4LS Tickets related to VWS4LS Project
Projects
Status: In Progress
Development

Successfully merging a pull request may close this issue.

1 participant