Skip to content

Commit 105b8eb

Browse files
author
Jens Kürten
committed
change order
1 parent f88ae56 commit 105b8eb

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

docs/reference/events.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -87,55 +87,57 @@ This event is fired **after** an engineering change has been released. Raising a
8787
|parts| list[[Part](objects.md#part)]|List of included parts.|
8888

8989

90-
## PartReleaseEvent
91-
`csfunctions.events.PartReleaseEvent`
90+
## PartReleaseCheckEvent
91+
`csfunctions.events.PartReleaseCheckEvent`
9292

93-
This event is fired **after** a part has been released. Raising an exception thus can not prevent the release.
93+
This event is fired when a user tries to release a part. Raising an exception will prevent the release. If the release is done via the express release, the event is triggered before reviewers are notified.
94+
Be aware that the part is not released yet and the release might still be aborted for other reasons (e.g. the reviewers don't give approval), so don't sent the part to e.g. an ERP system yet.
9495

95-
**PartReleaseEvent.name:** part_release
96+
**Supported actions:**
9697

97-
**PartReleaseEvent.data:**
98+
- [AbortAndShowErrorAction](actions.md#AbortAndShowErrorAction)
99+
100+
**PartRPartReleaseCheckEventeleaseEvent.name:** part_release_check
101+
102+
**PartReleaseCheckEvent.data:**
98103

99104
|Attribute|Type|Description|
100105
|-|-|-|
101-
|parts| list[[Part](objects.md#part)]|List of parts that were released.|
106+
|parts| list[[Part](objects.md#part)]|List of parts that will released.|
102107
|documents| list[[Document](objects.md#document)]|List of documents that belong to the released parts.|
103108
|dialog_data|PartReleaseDialogData|Contents of the dialog.|
104109

105-
**PartReleaseDialogData:**
110+
**PartReleaseCheckDialogData:**
106111

107112
|Attribute|Type|Description|
108113
|-|-|-|
109114
|cdbprot_remark|str \| None | Remark|
110115
|cdb_ec_id|str \| None| Engineering Change ID|
111116

112-
## PartReleaseCheckEvent
113-
`csfunctions.events.PartReleaseCheckEvent`
114-
115-
This event is fired when a user tries to release a part. Raising an exception will prevent the release. If the release is done via the express release, the event is triggered before reviewers are notified.
116-
Be aware that the part is not released yet and the release might still be aborted for other reasons (e.g. the reviewers don't give approval), so don't sent the part to e.g. an ERP system yet.
117117

118-
**Supported actions:**
118+
## PartReleaseEvent
119+
`csfunctions.events.PartReleaseEvent`
119120

120-
- [AbortAndShowErrorAction](actions.md#AbortAndShowErrorAction)
121+
This event is fired **after** a part has been released. Raising an exception thus can not prevent the release.
121122

122-
**PartRPartReleaseCheckEventeleaseEvent.name:** part_release_check
123+
**PartReleaseEvent.name:** part_release
123124

124-
**PartReleaseCheckEvent.data:**
125+
**PartReleaseEvent.data:**
125126

126127
|Attribute|Type|Description|
127128
|-|-|-|
128-
|parts| list[[Part](objects.md#part)]|List of parts that will released.|
129+
|parts| list[[Part](objects.md#part)]|List of parts that were released.|
129130
|documents| list[[Document](objects.md#document)]|List of documents that belong to the released parts.|
130131
|dialog_data|PartReleaseDialogData|Contents of the dialog.|
131132

132-
**PartReleaseCheckDialogData:**
133+
**PartReleaseDialogData:**
133134

134135
|Attribute|Type|Description|
135136
|-|-|-|
136137
|cdbprot_remark|str \| None | Remark|
137138
|cdb_ec_id|str \| None| Engineering Change ID|
138139

140+
139141
## WorkflowTaskTriggerEvent
140142
`csfunctions.events.WorkflowTaskTriggerEvent`
141143

0 commit comments

Comments
 (0)