status-im/spiff-arena
2
0
Fork 0
mirror of https://github.com/status-im/spiff-arena.git synced 2025-03-01 09:50:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

updates to screenshots and tables (#1489)

Browse Source 
Co-authored-by: Kevin Burnett <18027+burnettk@users.noreply.github.com>
This commit is contained in:
Usama Ahmad 2024-05-08 05:56:14 +05:00 committed by GitHub
parent 141a327627
commit adab730bd9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 29 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

116
docs/Building_Diagrams/Script_Tasks.md
View File

@ -96,95 +96,29 @@ del(k)
## Functions available to script tasks ## Functions available to script tasks
Please see the [implementing files themselves](https://github.com/sartography/spiff-arena/tree/main/spiffworkflow-backend/src/spiffworkflow_backend/scripts) for the gory details. Please see the [implementing files themselves](https://github.com/sartography/spiff-arena/tree/main/spiffworkflow-backend/src/spiffworkflow_backend/scripts) for the details.
### `delete_process_instances_with_criteria` | Function Name | Description |
|----------------------------------|----------------------------------------------------------------------------------------------|
This function deletes process instances that match the provided criteria. | delete_process_instances_with_criteria | Deletes process instances that match the provided criteria. |
| get_all_permissions | Gets all permissions currently in the system. |
### `get_all_permissions` | get_current_task_info | Returns information about the current task. |
| get_current_user | Returns the current user. |
This function gets all permissions currently in the system. | get_data_sizes | Returns information about the size of task data. |
| get_encoded_file_data | Returns the encoded file data. This is a very expensive call. |
### `get_current_task_info` | get_env | Returns the current environment (e.g., testing, staging, production). |
| get_frontend_url | Returns the URL to the frontend. |
This function returns the information about the current task. | get_group_members | Returns the list of usernames of the users in the given group. |
| get_last_user_completing_task | Returns the last user who completed the given task. |
### `get_current_user` | get_localtime | Converts a Datetime object into a Datetime object for a specific timezone. |
| get_process_initiator_user | Returns the user that initiated the process instance. |
This function returns the current user. | get_secret | Returns the value for a previously configured secret. |
| get_task_data_value | Checks if a given value is in task data and returns its value. If it does not exist or is None, it returns the default | value. |
### `get_data_sizes` | get_toplevel_process_info | Returns information about the currently running process. |
| get_url_for_task_with_bpmn_identifier | Returns the URL to the task show page for a task with the given BPMN identifier. The script task calling this MUST be in the same process as the desired task. |
This function returns a dictionary of information about the size of task data. | get_user_properties | Gets the user properties for the current user. |
| markdown_file_download_link | Returns a markdown format string for a file download link. |
### `get_encoded_file_data` | refresh_permissions | Adds permissions using a dictionary. |
| set_user_properties | Sets given user properties on the current user. |
This function returns a string which is the encoded file data. | times_executed_by_user | Returns the number of times the user has started an instance of the current process model. |
This is a very expensive call. | user_has_started_instance | Returns a boolean indicating if the user has started an instance of the current process model. |
### `get_env`
This function returns the current environment - i.e., testing, staging, production.
### `get_frontend_url`
This function returns the URL to the frontend.
### `get_group_members`
This function returns the list of usernames of the users in the given group.
### `get_last_user_completing_task`
This function returns the last user who completed the given task.
### `get_localtime`
This function converts a Datetime object into a Datetime object for a specific timezone.
### `get_process_initiator_user`
This function returns the user that initiated the process instance.
### `get_secret`
This function returns the value for a previously configured secret.
### `get_task_data_value`
This function checks to see if a given value is in task data and returns its value.
If it does not exist or is None, it returns the default value.
### `get_toplevel_process_info`
This function returns a dictionary of information about the currently running process.
### `get_url_for_task_with_bpmn_identifier`
This function returns the URL to the task show page for a task with the given BPMN identifier.
The script task calling this MUST be in the same process as the desired task and should be next to each other in the diagram.
### `get_user_properties`
This function gets the user properties for the current user.
### `markdown_file_download_link`
This function returns a string which is a markdown format string.
### `refresh_permissions`
This function adds permissions using a dictionary.
### `set_user_properties`
This function sets given user properties on the current user.
### `times_executed_by_user`
This function returns a number indicating how many times the user has started an instance of the current process model.
### `user_has_started_instance`
This function returns a boolean to indicate if the user has started an instance of the current process model.

BIN
docs/Getting_Started/images/Events_Example.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 36 KiB

BIN
docs/Getting_Started/images/Milestone_Screenshot.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 13 KiB

4
docs/Getting_Started/quick_start.md
View File

@ -368,6 +368,8 @@ This can help you manage your workflows more efficiently and keep track of the p
### Milestones ### Milestones
A milestone is a specific point in a process that signifies a significant event or state. It provides a high-level overview of the progress made in the process. A milestone is a specific point in a process that signifies a significant event or state. It provides a high-level overview of the progress made in the process.
![Milestones](images/Milestone_Screenshot.png)
In BPMN, if you draw an intermediate event and do not specify its type (like message, signal, start, or end) but give it a name, it becomes a milestone. In BPMN, if you draw an intermediate event and do not specify its type (like message, signal, start, or end) but give it a name, it becomes a milestone.
Essentially, a milestone is an event that hasn't been set to something specific. Essentially, a milestone is an event that hasn't been set to something specific.
@ -377,7 +379,7 @@ Essentially, a milestone is an event that hasn't been set to something specific.
Events provide a detailed log of everything that happens in a process. Events provide a detailed log of everything that happens in a process.
They record every task and its execution time. They record every task and its execution time.
![Events](images/Events.png) ![Events](images/Events_Example.png)
The events tab provides a detailed log of all the tasks and their execution times. The events tab provides a detailed log of all the tasks and their execution times.
It can be noisy due to the granularity of the information, but it's essential for understanding the intricacies of the process. It can be noisy due to the granularity of the information, but it's essential for understanding the intricacies of the process.