From d9ee15de1d15e4bc17d338b44078a7eaed0c4df3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Souchet=20C=C3=A9line?= <4921914+csouchet@users.noreply.github.com> Date: Wed, 22 Jan 2025 17:18:29 +0100 Subject: [PATCH] docs: make the user doc more readable (#3253) I changed the internal model image from **Landscape** to **Portrait**. I also fixed a missing property in `AssociationFlow`, the missing link for `GlobalTask` and some arrows not linked to elements. --- .../images/architecture/internal-model.drawio | 475 ++++++++++-------- .../images/architecture/internal-model.svg | 2 +- 2 files changed, 263 insertions(+), 214 deletions(-) diff --git a/docs/users/architecture/images/architecture/internal-model.drawio b/docs/users/architecture/images/architecture/internal-model.drawio index ea4797d26f..04d7e16c83 100644 --- a/docs/users/architecture/images/architecture/internal-model.drawio +++ b/docs/users/architecture/images/architecture/internal-model.drawio @@ -1,30 +1,27 @@ - + - + - - + + - + - + - + - - - - - + + @@ -37,54 +34,52 @@ - + + - + - + - - - - - + + - + - + - - + + - - + + - + - - + + - - + + @@ -96,38 +91,39 @@ - + - - + - + - - + + - - + - + - - - + + + + + + @@ -135,30 +131,34 @@ - + - - - + + + + + + - + - + - - + + - + + - + @@ -166,59 +166,73 @@ - + - + - - + + - + - - - - - - + + - + - - + + - + - + - + + + + + + + + + + + + + + + + + + + - + @@ -247,7 +261,7 @@ - + @@ -260,86 +274,100 @@ - - - - + + + + - + + - + - + - + - - + + - + + + + - + - - - - + + + + + + + + - - + + - + - - + + - - + + - + - - - - - + + + + + + + + - - - - - + + + + + + + + - + @@ -351,7 +379,7 @@ - + @@ -375,7 +403,7 @@ - + @@ -393,13 +421,13 @@ - + - + - + @@ -407,7 +435,7 @@ - + @@ -421,7 +449,7 @@ - + @@ -444,7 +472,7 @@ - + @@ -461,7 +489,7 @@ - + @@ -479,19 +507,19 @@ - + - + - + - + @@ -499,13 +527,13 @@ - + - - + + - - + + @@ -516,101 +544,100 @@ - - + + - - + - + - + - + + + - - - - - + + + + + + + + + + + - + - + - - - - - - + + + - + - + - - + + - + - + - + - - - - + - - - - - - - + + + + - + + - + - + @@ -619,106 +646,98 @@ - + - + - - + + - + - + - + - - + + - + + - + - + - - + + - + - - - - + + + + + - - - - + + + + + + + - - - - - - - - - - - - - - - - - - - + - + + + + + + - + @@ -726,17 +745,47 @@ - - + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/users/architecture/images/architecture/internal-model.svg b/docs/users/architecture/images/architecture/internal-model.svg index ccd2505b61..148c922fc8 100644 --- a/docs/users/architecture/images/architecture/internal-model.svg +++ b/docs/users/architecture/images/architecture/internal-model.svg @@ -1,4 +1,4 @@ -
0..1
0..1
0..1
0..1
0..1
0..1
2..*
2..*
1
1
1
1
1
1
1
1
1..*
1..*
1
1
0
0
0..*
0..*
Extends
Extends
1
1
0..1
0..1EdgeShape- id: string- bpmnElement: ShapeBpmnElement- bounds: Bounds- label: Label- isHorizontal?: boolean- isMarkerVisible?: boolean- isMessageVisible?: boolean- extensions: ShapeExtensionsShapes- flowNodes: Shape[]- lanes: Shape[]- pools: Shape[]
Extends
Extends
Extends
Extends
1
1
Extends
Extends
1
1
0
0
Extends
Extends
Extends
ExtendsParticipant- name?: string- id: string- processRef?: stringShapeBpmnElement- id?: string- name?: string- kind: ShapeBpmnElementKind- parentId?: string- instantiate?: boolean = false- incomingIds?: string[] = []- outgoingIds?: string[] = []Definitions- collaboration?: Collaboration- process?: Process- bpmnModel: BpmnModel+ bpmnModel(): BpmnModelCollaborationProcessBpmnModel- edges: Edge[]Label- font?: Font- bounds?: Bounds- extensions: LabelExtensionsFont- name?: string- size?: number- isBold?: boolean- isItalic?: boolean- isUnderline?: boolean- isStrikeThrough?: booleanBounds- x: number- y: number- width: number- height: numberFlow- id: string- name: string- sourceRefId: string- targetRefId: string- kind: FlowKindSequenceFlow- sequenceFlowKind: SequenceFlowKindSequenceFlowKindMessageVisibleKindWaypoint- x: number- y: number
1
1
1
1FlowKindAssociationFlow
Extends
ExtendsMessageFlow
1
1AssociationDirectionKind
0..3
0..3ShapeBpmnEvent- eventDefinitionKind: ShapeBpmnEventDefinitionKindShapeBpmnEventDefinitionKindShapeBpmnMarkerKindShapeBpmnSubProcess- subProcessKind: ShapeBpmnSubProcessKind
Extends
ExtendsShapeBpmnActivity- markers?: ShapeBpmnMarkerKind[] = []ShapeBpmnCallActivity- callActivityKind: ShapeBpmnCallActivityKind- globalTaskKind?: GlobalTaskKindShapeBpmnElementKindShapeBpmnCallActivityKind
1
1ShapeBpmnBoundaryEvent- isInterrupting?: boolean = trueShapeBpmnStartEvent- isInterrupting?: boolean
Extends
ExtendsShapeBpmnEventBasedGateway- gatewayKind?: ShapeBpmnEventBasedGatewayKindShapeBpmnEventBasedGatewayKind
1
1
Extends
Extends
Extends
ExtendsShapeBpmnSubProcessKind- extensions: EdgeExtensions- id: string- bpmnElement: SequenceFlow- waypoints: Waypoint[]- label: Label- messageVisibleKind: MessageVisibleKind = MessageVisibleKind.NONEShapeBpmnIntermediateCatchEvent- sourceIds?: string[] = []ShapeBpmnIntermediateThrowEvent- targetId?: stringText is not SVG - cannot display \ No newline at end of file +
0..1
0..1
0..1
2..*
1
1
1
1
1..*
1
0
0..*
Extends
1
0..1
Edge- id: string- bpmnElement: SequenceFlow- waypoints: Waypoint[]- label: Label- messageVisibleKind: MessageVisibleKind = MessageVisibleKind.NONE- extensions: EdgeExtensionsShape- id: string- bpmnElement: ShapeBpmnElement- bounds: Bounds- label: Label- isHorizontal?: boolean- isMarkerVisible?: boolean- isMessageVisible?: boolean- extensions: ShapeExtensionsShapes- flowNodes: Shape[]- lanes: Shape[]- pools: Shape[]
Extends
Extends
1
Extends
1
0
Extends
Extends
Participant- name?: string- id: string- processRef?: stringShapeBpmnElement- id?: string- name?: string- kind: ShapeBpmnElementKind- parentId?: string- instantiate?: boolean = false- incomingIds?: string[] = []- outgoingIds?: string[] = []Definitions- collaboration?: Collaboration- process?: Process- bpmnModel: BpmnModel+ bpmnModel(): BpmnModelCollaborationProcessBpmnModel- edges: Edge[]Label- font?: Font- bounds?: Bounds- extensions: LabelExtensionsFont- name?: string- size?: number- isBold?: boolean- isItalic?: boolean- isUnderline?: boolean- isStrikeThrough?: booleanBounds- x: number- y: number- width: number- height: numberFlow- id: string- name: string- sourceRefId: string- targetRefId: string- kind: FlowKindSequenceFlow- sequenceFlowKind: SequenceFlowKindSequenceFlowKindMessageVisibleKindWaypoint- x: number- y: number
1
1
FlowKindAssociationFlow- associationDirectionKind: AssociationDirectionKind
Extends
MessageFlow
1
AssociationDirectionKind
0..3
ShapeBpmnEvent- eventDefinitionKind: ShapeBpmnEventDefinitionKindShapeBpmnEventDefinitionKindShapeBpmnMarkerKind
Extends
ShapeBpmnActivity- markers?: ShapeBpmnMarkerKind[] = []ShapeBpmnCallActivity- callActivityKind: ShapeBpmnCallActivityKind- globalTaskKind?: GlobalTaskKindShapeBpmnElementKindShapeBpmnCallActivityKind
1
ShapeBpmnBoundaryEvent- isInterrupting?: boolean = trueShapeBpmnStartEvent- isInterrupting?: boolean
Extends
ShapeBpmnEventBasedGateway- gatewayKind?: ShapeBpmnEventBasedGatewayKindShapeBpmnEventBasedGatewayKind
1
Extends
Extends
ShapeBpmnSubProcessKind
Extends
ShapeBpmnIntermediateCatchEvent- sourceIds?: string[] = []
Extends
ShapeBpmnIntermediateThrowEvent- targetId?: stringShapeBpmnSubProcess- subProcessKind: ShapeBpmnSubProcessKind
1
GlobalTaskKind
 \ No newline at end of file