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

chore(documentation): user manual update, contract detailed view request logic fix #1122

Merged
merged 6 commits into from
Mar 27, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ _**For better traceability add the corresponding GitHub issue number in each cha
- #718 update maven-project-info-reports-plugin from 3.4.5 to 3.5.0
- #718 update jsonschema2pojo-core from 1.1.1 to 1.2.1
- #718 migrate Spring Boot from 3.1.9 to 3.2.4
- Updated user manual with new part detailed view also for supplier and customer parts
- fixed bug in request logic of contracts detailed view

### Removed
- Shedlock, resilence4j, templateResolver as not used anymore
Expand Down
18 changes: 9 additions & 9 deletions docs/src/docs/user/user-manual.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -101,26 +101,26 @@ Navigates to the Catena-X portal.
Only applicable for the admin user role.
Possibility to check the network status based on logfiles and will provide access to configuration possibilities for the application.

==== Contracts View and export
==== Contracts view and export

In the Contracts View an admin user can view contract agreements and sort them by the contract ID.
In the Contracts view an admin user can view contract agreements and sort them by the contract ID.

Also, it's possible to select contracts and export/download them as a .csv file
Also, it's possible to select contracts and export/download them as a .csv file.

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

By clicking on the burger menu of a data row you can get to the detailed view of a contract
By clicking on the burger menu of a data row you can get to the detailed view of a contract.

==== Contract Detailed View
==== Contract detailed view

The Contract Detailed View is divided into two sections.
The contract detailed view is divided into two sections.

On the left, you'll find a
general overview of the contract data.

On the right, policy details are
displayed in JSON format. Use the View Selector to switch between
JSON View and JSON Tree View. Expand the policy details card on the right
displayed in JSON format. Use the view selector to switch between
JSON view and JSON tree view. Expand the policy details card on the right
upper side for full-width display.

image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/user-guide/admin_contract_detailed_view.png[]
Expand Down Expand Up @@ -290,7 +290,7 @@ Information about the identifiers at the customer for the respective part/batch.
==== Traction battery code data

If the asset has the "traction battery code" aspect model, an additional section underneath will be displayed.
In this section there are detailed information about the traction battery and a table with its subcomponents
In this section there is detailed information about the traction battery and a table with its subcomponents

==== Creation of a quality incident from detailed 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 @@ -34,7 +34,6 @@ export class ContractsComponent {
this.contractsFacade.setContracts(0,10,[null,null]);
}
})
console.log("ngOnInit")

this.pagination = { page: 0, pageSize: 10, sorting: [ '', null ] };
this.tableConfig = {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import {Injectable} from '@angular/core';
import {Pagination} from '@core/model/pagination.model';
import {Contract} from '@page/admin/core/admin.model';
import {AdminService} from '@page/admin/core/admin.service';
import {ContractsState} from '@page/admin/presentation/contracts/contracts.state';
import {provideDataObject} from '@page/parts/core/parts.helper';
import {TableHeaderSort} from '@shared/components/table/table.model';
import {View} from '@shared/model/view.model';
import {Observable, Subject, Subscription} from 'rxjs';
import { Injectable } from '@angular/core';
import { Pagination } from '@core/model/pagination.model';
import { Contract } from '@page/admin/core/admin.model';
import { AdminService } from '@page/admin/core/admin.service';
import { ContractsState } from '@page/admin/presentation/contracts/contracts.state';
import { provideDataObject } from '@page/parts/core/parts.helper';
import { TableHeaderSort } from '@shared/components/table/table.model';
import { View } from '@shared/model/view.model';
import { Observable, Subject, Subscription } from 'rxjs';

@Injectable()
export class ContractsFacade {
Expand Down Expand Up @@ -46,7 +46,7 @@ export class ContractsFacade {

public setSelectedContractById(contractId: string): void {
this.selectedContractSubscription = this.adminService.getContracts(0, 10, [null,null], {contractId: [contractId]}).subscribe({
next: data => (this.contractsState.selectedContract = { data: data.content as unknown as Contract}),
next: data => (this.contractsState.selectedContract = { data: data.content[0] as unknown as Contract}),
error: error => (this.contractsState.selectedContract = {error})
})
}
Expand Down