Skip to content

Commit 40ca7e4

Browse files
author
lwi
committed
docs
1 parent 63831aa commit 40ca7e4

2 files changed

Lines changed: 239 additions & 1 deletion

File tree

‎docs/reference/events.md‎

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,164 @@ This event is fired **after** an engineering change has been released. Raising a
154154
| documents | list[[Document](objects.md#document)] | List of included documents. |
155155
| parts | list[[Part](objects.md#part)] | List of included parts. |
156156

157+
## ChangeOrderReleaseCheckEvent
158+
`csfunctions.events.ChangeOrderReleaseCheckEvent`
159+
160+
This event is fired when a user tries to release a change order. Raising an exception will prevent the release.
161+
Be aware that the change order is not released yet and the release might still be aborted for other reasons, so don't sent the change order to e.g. an ERP system yet.
162+
163+
**Supported actions:**
164+
165+
- [AbortAndShowErrorAction](actions.md#abortandshowerroraction)
166+
167+
**ChangeOrderReleaseCheckEvent.name:** change_order_release_check
168+
169+
**ChangeOrderReleaseCheckEvent.data:**
170+
171+
| Attribute | Type | Description |
172+
| ------------- | ------------------------------------------- | -------------------------------------------- |
173+
| change_orders | list[[ChangeOrder](objects.md#changeorder)] | List of change orders that will be released. |
174+
| documents | list[[Document](objects.md#document)] | List of included documents. |
175+
| parts | list[[Part](objects.md#part)] | List of included parts. |
176+
177+
178+
## ChangeOrderReleasedEvent
179+
`csfunctions.events.ChangeOrderReleasedEvent`
180+
181+
This event is fired **after** a change order has been released. Raising an exception thus can not prevent the release.
182+
183+
**Supported actions:**
184+
185+
- [StartWorkflowAction](actions.md#startworkflowaction)
186+
187+
**ChangeOrderReleasedEvent.name:** change_order_released
188+
189+
**ChangeOrderReleasedEvent.data:**
190+
191+
| Attribute | Type | Description |
192+
| ------------- | ------------------------------------------- | ----------------------------------------- |
193+
| change_orders | list[[ChangeOrder](objects.md#changeorder)] | List of change orders that were released. |
194+
| documents | list[[Document](objects.md#document)] | List of included documents. |
195+
| parts | list[[Part](objects.md#part)] | List of included parts. |
196+
197+
198+
## ChangeOrderStatusChangedEvent
199+
`csfunctions.events.ChangeOrderStatusChangedEvent`
200+
201+
This event is fired **after** a change order's status has been modified. Raising an exception cannot prevent the status change.
202+
203+
**ChangeOrderStatusChangedEvent.name:** change_order_status_changed
204+
205+
**ChangeOrderStatusChangedEvent.data:**
206+
207+
| Attribute | Type | Description |
208+
| ------------ | ------------------------------------- | ------------------------------------------------- |
209+
| change_order | [ChangeOrder](objects.md#changeorder) | The change order that had its status modified |
210+
| prev_status | int | The previous status of the change order |
211+
| documents | list[[Document](objects.md#document)] | List of documents attached to the change order |
212+
| parts | list[[Part](objects.md#part)] | List of parts attached to the change order |
213+
214+
215+
## ChangeOrderStatusChangeCheckEvent
216+
`csfunctions.events.ChangeOrderStatusChangeCheckEvent`
217+
218+
This event is fired when a user tries to modify a change order's status. Raising an exception will prevent the status change.
219+
220+
**Supported actions:**
221+
222+
- [AbortAndShowErrorAction](actions.md#abortandshowerroraction)
223+
224+
**ChangeOrderStatusChangeCheckEvent.name:** change_order_status_change_check
225+
226+
**ChangeOrderStatusChangeCheckEvent.data:**
227+
228+
| Attribute | Type | Description |
229+
| ------------- | ------------------------------------- | ------------------------------------------------- |
230+
| change_order | [ChangeOrder](objects.md#changeorder) | The change order that will have its status modified |
231+
| target_status | int | The target status of the change order |
232+
| documents | list[[Document](objects.md#document)] | List of documents attached to the change order |
233+
| parts | list[[Part](objects.md#part)] | List of parts attached to the change order |
234+
235+
236+
## ChangeRequestReleaseCheckEvent
237+
`csfunctions.events.ChangeRequestReleaseCheckEvent`
238+
239+
This event is fired when a user tries to release a change request. Raising an exception will prevent the release.
240+
Be aware that the change request is not released yet and the release might still be aborted for other reasons, so don't sent the change request to e.g. an ERP system yet.
241+
242+
**Supported actions:**
243+
244+
- [AbortAndShowErrorAction](actions.md#abortandshowerroraction)
245+
246+
**ChangeRequestReleaseCheckEvent.name:** change_request_release_check
247+
248+
**ChangeRequestReleaseCheckEvent.data:**
249+
250+
| Attribute | Type | Description |
251+
| --------------- | ----------------------------------------------- | ---------------------------------------------- |
252+
| change_requests | list[[ChangeRequest](objects.md#changerequest)] | List of change requests that will be released. |
253+
| documents | list[[Document](objects.md#document)] | List of included documents. |
254+
| parts | list[[Part](objects.md#part)] | List of included parts. |
255+
256+
257+
## ChangeRequestReleasedEvent
258+
`csfunctions.events.ChangeRequestReleasedEvent`
259+
260+
This event is fired **after** a change request has been released. Raising an exception thus can not prevent the release.
261+
262+
**Supported actions:**
263+
264+
- [StartWorkflowAction](actions.md#startworkflowaction)
265+
266+
**ChangeRequestReleasedEvent.name:** change_request_released
267+
268+
**ChangeRequestReleasedEvent.data:**
269+
270+
| Attribute | Type | Description |
271+
| --------------- | ----------------------------------------------- | ------------------------------------------- |
272+
| change_requests | list[[ChangeRequest](objects.md#changerequest)] | List of change requests that were released. |
273+
| documents | list[[Document](objects.md#document)] | List of included documents. |
274+
| parts | list[[Part](objects.md#part)] | List of included parts. |
275+
276+
277+
## ChangeRequestStatusChangedEvent
278+
`csfunctions.events.ChangeRequestStatusChangedEvent`
279+
280+
This event is fired **after** a change request's status has been modified. Raising an exception cannot prevent the status change.
281+
282+
**ChangeRequestStatusChangedEvent.name:** change_request_status_changed
283+
284+
**ChangeRequestStatusChangedEvent.data:**
285+
286+
| Attribute | Type | Description |
287+
| -------------- | ----------------------------------------- | ------------------------------------------------ |
288+
| change_request | [ChangeRequest](objects.md#changerequest) | The change request that had its status modified |
289+
| prev_status | int | The previous status of the change request |
290+
| documents | list[[Document](objects.md#document)] | List of documents attached to the change request |
291+
| parts | list[[Part](objects.md#part)] | List of parts attached to the change request |
292+
293+
294+
## ChangeRequestStatusChangeCheckEvent
295+
`csfunctions.events.ChangeRequestStatusChangeCheckEvent`
296+
297+
This event is fired when a user tries to modify a change request's status. Raising an exception will prevent the status change.
298+
299+
**Supported actions:**
300+
301+
- [AbortAndShowErrorAction](actions.md#abortandshowerroraction)
302+
303+
**ChangeRequestStatusChangeCheckEvent.name:** change_request_status_change_check
304+
305+
**ChangeRequestStatusChangeCheckEvent.data:**
306+
307+
| Attribute | Type | Description |
308+
| -------------- | ----------------------------------------- | ---------------------------------------------------- |
309+
| change_request | [ChangeRequest](objects.md#changerequest) | The change request that will have its status modified |
310+
| target_status | int | The target status of the change request |
311+
| documents | list[[Document](objects.md#document)] | List of documents attached to the change request |
312+
| parts | list[[Part](objects.md#part)] | List of parts attached to the change request |
313+
314+
157315
## PartCreateCheckEvent
158316
`csfunctions.events.PartCreateCheckEvent`
159317

@@ -299,6 +457,8 @@ This event is fired by the workflow task "Trigger Webhook".
299457
| parts | list[[Part](objects.md#part)] | List of parts attached to the workflow. |
300458
| documents | list[[Document](objects.md#document)] | List of documents attached to the workflow. |
301459
| engineering_changes | list[[EngineeringChange](objects.md#engineeringchange)] | List of engineering changes attached to the workflow. |
460+
| change_orders | list[[ChangeOrder](objects.md#changeorder)] | List of change orders attached to the workflow. |
461+
| change_requests | list[[ChangeRequest](objects.md#changerequest)] | List of change requests attached to the workflow. |
302462
| briefcases | list[[Briefcase](objects.md#briefcase)] | List of briefcases attached to the workflow. |
303463

304464
## EngineeringChangeStatusChanged

‎docs/reference/objects.md‎

Lines changed: 79 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@
143143
## Briefcase
144144
`csfunctions.objects.Briefcase`
145145

146-
Briefcases are used by Workflows and can contain parts, documents or engineering changes.
146+
Briefcases are used by Workflows and can contain parts, documents, engineering changes, change orders or change requests.
147147

148148
|Attribute|Type|Description|
149149
|-|-|-|
@@ -152,9 +152,87 @@ Briefcases are used by Workflows and can contain parts, documents or engineering
152152
|part_ids|list[str]|List of part IDs in this Briefcase. (teilenummer@t_index)|
153153
|document_ids|list[str]|List of document IDs in this Briefcase. (z_nummer@z_index)|
154154
|engineering_change_ids|list[str]|List of engineering change IDs in this Briefcase. (cdb_ec_id)|
155+
|change_order_ids|list[str]|List of change order IDs in this Briefcase. (cs_change_id)|
156+
|change_request_ids|list[str]|List of change request IDs in this Briefcase. (cs_change_id)|
155157
|parts|list[[Part](objects.md#part)]||
156158
|documents|list[[Document](objects.md#document)]||
157159
|engineering_changes|list[[EngineeringChange](objects.md#engineeringchange)]||
160+
|change_orders|list[[ChangeOrder](objects.md#changeorder)]||
161+
|change_requests|list[[ChangeRequest](objects.md#changerequest)]||
162+
163+
## ChangeOrder
164+
`csfunctions.objects.ChangeOrder`
165+
166+
A change order of the ECM module. Shares all attributes of its base class `csfunctions.objects.Change`.
167+
168+
|Attribute|Type|Description|
169+
|-|-|-|
170+
|cs_change_id|str|Change ID|
171+
|cdb_project_id|str \| None|Project ID|
172+
|product_object_oid|str \| None|Product object ID|
173+
|end_time_plan|datetime \| None|Planned end time|
174+
|status|int|Status|
175+
|title_de|str \| None|Title (de)|
176+
|title_en|str \| None|Title (en)|
177+
|cdb_object_id|str \| None|Object ID|
178+
|change_type|str \| None|Change Type|
179+
|cs_ecm_change_description_de|str \| None|Description (de)|
180+
|cs_ecm_change_description_en|str \| None|Description (en)|
181+
|c_event|str \| None|Event|
182+
|change_reason_de|str \| None|Reason (de)|
183+
|change_reason_en|str \| None|Reason (en)|
184+
|c_source|str \| None|Source|
185+
|part_ids|list[str]|List of part IDs, that were changed. (teilenummer@t_index)|
186+
|document_ids|list[str]|List of document IDs, that were changed. (z_nummer@z_index)|
187+
|affected_part_ids|list[str]|List of part IDs, that were planned to be changed. (teilenummer@t_index)|
188+
|affected_document_ids|list[str]|List of document IDs, that were planned to be changed. (z_nummer@z_index)|
189+
|accompanying_document_ids|list[str]|List of document IDs, that accompany the change. (z_nummer@z_index)|
190+
|parts|list[[Part](objects.md#part)]||
191+
|documents|list[[Document](objects.md#document)]||
192+
|affected_parts|list[[Part](objects.md#part)]||
193+
|affected_documents|list[[Document](objects.md#document)]||
194+
|accompanying_documents|list[[Document](objects.md#document)]||
195+
|cdb_cpersno|str \| None|Created by|
196+
|cdb_cdate|datetime \| None|Created on|
197+
|cdb_mpersno|str|Last Modified by|
198+
|cdb_mdate|datetime \| None|Last Modified on|
199+
200+
## ChangeRequest
201+
`csfunctions.objects.ChangeRequest`
202+
203+
A change request of the ECM module. Shares all attributes of its base class `csfunctions.objects.Change`.
204+
205+
|Attribute|Type|Description|
206+
|-|-|-|
207+
|cs_change_id|str|Change ID|
208+
|cdb_project_id|str \| None|Project ID|
209+
|product_object_oid|str \| None|Product object ID|
210+
|end_time_plan|datetime \| None|Planned end time|
211+
|status|int|Status|
212+
|title_de|str \| None|Title (de)|
213+
|title_en|str \| None|Title (en)|
214+
|cdb_object_id|str \| None|Object ID|
215+
|change_type|str \| None|Change Type|
216+
|cs_ecm_change_description_de|str \| None|Description (de)|
217+
|cs_ecm_change_description_en|str \| None|Description (en)|
218+
|c_event|str \| None|Event|
219+
|change_reason_de|str \| None|Reason (de)|
220+
|change_reason_en|str \| None|Reason (en)|
221+
|c_source|str \| None|Source|
222+
|part_ids|list[str]|List of part IDs, that were changed. (teilenummer@t_index)|
223+
|document_ids|list[str]|List of document IDs, that were changed. (z_nummer@z_index)|
224+
|affected_part_ids|list[str]|List of part IDs, that were planned to be changed. (teilenummer@t_index)|
225+
|affected_document_ids|list[str]|List of document IDs, that were planned to be changed. (z_nummer@z_index)|
226+
|accompanying_document_ids|list[str]|List of document IDs, that accompany the change. (z_nummer@z_index)|
227+
|parts|list[[Part](objects.md#part)]||
228+
|documents|list[[Document](objects.md#document)]||
229+
|affected_parts|list[[Part](objects.md#part)]||
230+
|affected_documents|list[[Document](objects.md#document)]||
231+
|accompanying_documents|list[[Document](objects.md#document)]||
232+
|cdb_cpersno|str \| None|Created by|
233+
|cdb_cdate|datetime \| None|Created on|
234+
|cdb_mpersno|str|Last Modified by|
235+
|cdb_mdate|datetime \| None|Last Modified on|
158236

159237
## Document
160238
`csfunctions.objects.Document`

0 commit comments

Comments
 (0)