feat: Custom operations on Documents and Parts#40
Merged
jens-kuerten merged 9 commits intomainfrom Dec 8, 2025
Merged
Conversation
added 6 commits
April 14, 2025 16:59
…o event documentation
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request adds support for custom operations on documents and parts by introducing two new event types: CustomOperationDocumentEvent and CustomOperationPartEvent. These events allow users to trigger custom Python functions when performing operations on documents or parts in the CIM Database Cloud.
- Adds new event schemas and Python event classes for custom operations on documents and parts
- Updates documentation to describe the new events and their usage
- Provides a practical example showing how to generate and attach reports to documents using custom operations
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Adds navigation entry for the new basic_report example |
| json_schemas/request.json | Defines JSON schemas for CustomOperationDocumentEvent and CustomOperationPartEvent with their data structures |
| docs/reference/events.md | Documents the new custom operation events, including supported actions and data attributes |
| docs/examples/basic_report.md | Provides a complete example demonstrating custom operations by generating Word reports for documents |
| csfunctions/events/custom_operations.py | Implements Python classes for the custom operation events and their data models |
| csfunctions/events/base.py | Adds event name constants for the new custom operation events |
| csfunctions/events/init.py | Exports the new event types and integrates them into the Event union type |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
conlwi
approved these changes
Dec 2, 2025
albertsj
approved these changes
Dec 5, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add support for custom operations on documents and parts