Skip to content

Commit

Permalink
feature(publish): #535 added user manual documentation for publishing…
Browse files Browse the repository at this point in the history
… assets
  • Loading branch information
ds-mmaul committed Jan 29, 2024
1 parent e37fafe commit 11abd85
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 2 deletions.
36 changes: 35 additions & 1 deletion docs/src/docs/user/user-manual.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -148,11 +148,45 @@ Parts that are in a quality alert are highlighted yellow.
=== Parts selection -> Create Quality alert

Select one or multiple child components/parts/batches that are build into your part.
Selection will enable you to create a quality alert (notification) to your customers.
Selection will enable you to create a quality alert (notification) to your customers. For this action, a button appears at the top right of the table as soon as an asset has been selected
The quality alert will be added to a queue (queued & requested inbox) and not directly sent to the customers.

Once the quality alert is created you will get a pop-up and can directly navigate to the inbox for further action.

=== Parts selection -> Publish Assets

Select one or multiple parts that are in the AsBuilt lifecycle. A button will appear on the right of the lifecycle view selection:

image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/user-guide/publish_assets_button.png[]

Selection will enable you to publish assets with the goal to persist them (import state "persistent").
With a click on the button a window will be opened, where the selected assets are displayed and a required policy must be selected:

image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/user-guide/publish_assets_view.png[]

The following table explains the different import state an asset can have:

[cols="1,1"]
|===
|transient
|Asset is uploaded but not synchronized with the Item Relationship Service (IRS).

|in_synchronization
|Asset is in the process of synchronizing with the IRS.

|persistent
|Asset is successfully synchronized with the IRS.

|unset
|The import state of the asset was not set

|error
|Along the import state transition and error occurred.
|===




=== Parts table column settings

On the right upper site of a table there is a settings icon in which you can set the table columns to a desired view.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<p
class="regular-text table&#45;&#45;selected&#45;&#45;label">{{ selectedPartsInfoLabel | i18n : {count: selection?.selected?.length || 0} }}</p>
<div class="table--header--select--button"
matTooltip="{{mainAspectType === MainAspectType.AS_PLANNED ? 'routing.notAllowedForAsPlanned' : 'routing.unauthorized' | i18n}}"
matTooltip="{{(mainAspectType === MainAspectType.AS_PLANNED ? 'routing.notAllowedForAsPlanned' : 'routing.unauthorized') | i18n}}"
matTooltipClass="table--header--tooltip"
matTooltipPosition="above"
[class.mdc-tooltip--multiline]="true"
Expand Down

0 comments on commit 11abd85

Please sign in to comment.