Skip to content

Documentation Page: Features & Refactoring#734

Merged
jjoderis merged 63 commits into
mainfrom
instance/documentation
May 18, 2026
Merged

Documentation Page: Features & Refactoring#734
jjoderis merged 63 commits into
mainfrom
instance/documentation

Conversation

@Zayn-Javed
Copy link
Copy Markdown
Contributor

@Zayn-Javed Zayn-Javed commented Apr 16, 2026

Overview:
Implemented printable documentation page for process execution instances (an extension to process documentation Page). Both pages are accessible via the shared viewer URL and support PDF export via browser print.

Summary

Code Generalisation:

  • Refactored and generalised the existing code for Process Documentation and made it resuable.

Both Documentation Pages:

  • New section for Sub-Processes (Extended Sub-Processes, Event triggered Sub-Processes)
  • Boundary Events are now shown attached with its parent without any separate section for them
  • Accessibility to both documentation pages for all registered users (by encoding spaceId in token)

BPMN order Fixes:

  • Element ordering follows actual BPMN sequence flows

Instance Documentation Page:

  • All features of the process documentation page plus execution-specific sections
  • Execution Overview showing execution ID, start/end times, overall state
  • Detailed Execution Log per element showing execution state, timing, machine, and variable changes
  • Process diagram colored by execution state with token positions overlaid
  • End states of all process variables

PDF Export:

  • Correct filename format: PROCEED - <process name> - Version: <version>
  • Page breaks before each major section
  • Fonts size consistence for headings

Backend Function:

  • Added a backend function to get the Full Name of a user given its ID
  • Added a backend function to get the Name of a Process given its ID without any other checks
  • Added a backend function to fetch process with BPMN for any authenticated user

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions
Copy link
Copy Markdown

CLOUDRUN ACTIONS

✅ Successfully created Preview Deployment.

https://pr-734---ms-server-staging-c4f6qdpj7q-ew.a.run.app

@github-actions
Copy link
Copy Markdown

CLOUDRUN ACTIONS

✅ Successfully created Preview Deployment.

https://pr-734---ms-server-staging-c4f6qdpj7q-ew.a.run.app

@github-actions
Copy link
Copy Markdown

CLOUDRUN ACTIONS

✅ Successfully created Preview Deployment.

https://pr-734---ms-server-staging-c4f6qdpj7q-ew.a.run.app

@github-actions
Copy link
Copy Markdown

CLOUDRUN ACTIONS

✅ Successfully created Preview Deployment.

https://pr-734---ms-server-staging-c4f6qdpj7q-ew.a.run.app

@github-actions
Copy link
Copy Markdown

CLOUDRUN ACTIONS

✅ Successfully created Preview Deployment.

https://pr-734---ms-server-staging-c4f6qdpj7q-ew.a.run.app

Comment thread tests/ms2/processes/documentation-page/documentation-page.spec.ts Outdated
Comment thread tests/ms2/processes/documentation-page/documentation-page.spec.ts Outdated
Comment thread tests/ms2/processes/documentation-page/documentation-page.spec.ts
Comment thread tests/ms2/processes/documentation-page/documentation-page.spec.ts Outdated
Comment thread tests/ms2/processes/documentation-page/documentation-page.spec.ts Outdated
Comment thread src/management-system-v2/app/shared-viewer/documentation-page-utils.ts Outdated
Comment thread src/management-system-v2/app/shared-viewer/documentation-page-utils.ts Outdated
Comment thread src/management-system-v2/app/shared-viewer/documentation-page-utils.ts Outdated
.filter({
hasText: 'Sub Process: A',
})
.first();
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think using ".first()" kind of implies ambiguities in the locator which are then alleviated by picking the first element that fits. The playwright documentation advises against that and recommends finding a locator that uniquely identifies the element.

Comment thread src/management-system-v2/app/shared-viewer/process-document-content.tsx Outdated
@github-actions
Copy link
Copy Markdown

CLOUDRUN ACTIONS

✅ Successfully created Preview Deployment.

https://pr-734---ms-server-staging-c4f6qdpj7q-ew.a.run.app

@jjoderis jjoderis merged commit b4d222b into main May 18, 2026
12 checks passed
@jjoderis jjoderis deleted the instance/documentation branch May 18, 2026 15:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants