Script task and sub process call activity example #2202
Conversation
|
Warning Rate limit exceeded@usama9500 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 23 minutes and 36 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe pull request introduces documentation updates for SpiffArena, focusing on two key areas: script task properties and sub-processes/call activities. The changes enhance the documentation by adding detailed explanations, example use cases, and structured information about script tasks and workflow components. The updates aim to provide clearer guidance for users working with SpiffArena's workflow design and scripting capabilities. Changes
Sequence DiagramsequenceDiagram
participant User
participant ScriptTask
participant WorkflowContext
participant CustomFunctions
User->>ScriptTask: Configure Script Task
ScriptTask->>WorkflowContext: Define Input Variables
ScriptTask->>WorkflowContext: Execute Python Script
WorkflowContext->>CustomFunctions: Utilize Available Functions
ScriptTask->>WorkflowContext: Set Output Variables
WorkflowContext-->>User: Return Workflow Results
This sequence diagram illustrates the basic workflow of a script task in SpiffArena, showing how users configure tasks, interact with the workflow context, and leverage custom functions during script execution. Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/Building_Diagrams/sub-processes_and_call_activities.md (3)
56-58: Fix list indentation for better markdown formatting.The unordered lists under "Input Variables" and "Output Variables" have incorrect indentation.
- - No specific inputs required in this example as tasks dynamically retrieve options from context or form +- No specific inputs required in this example as tasks dynamically retrieve options from context or form - - `selected_items`: A dictionary containing the user's food selections (e.g., `{"Appetizer": "Spring Rolls", "Soup": "Tomato Soup", ...}`). +- `selected_items`: A dictionary containing the user's food selections (e.g., `{"Appetizer": "Spring Rolls", "Soup": "Tomato Soup", ...}`).🧰 Tools
🪛 Markdownlint (0.37.0)
56-56: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
58-58: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
98-98: Remove trailing punctuation from heading.Remove the colon from the heading for consistency with markdown style guidelines.
-#### **Call Activity: Handle Payment**: +#### **Call Activity: Handle Payment**🧰 Tools
🪛 Markdownlint (0.37.0)
98-98: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
88-96: Consider varying sentence structure in steps section.Multiple consecutive sentences begin with "Step". Consider rewording for better readability.
-**Step 1**: **Enter Name** - A User Task that collects the customer's name. -**Step 2**: **Select Food** - A Subprocess to handle food selection. -**Step 3**: **Display Bill Value** - A Script Task to calculate the total bill. -**Step 4**: **Handle Payment** - A Call Process that navigates to a payment-handling process. -**Step 5**: **Order Confirmation** - A User Task that displays order confirmation. +1. **Enter Name**: A User Task that collects the customer's name. +2. **Select Food**: A Subprocess to handle food selection. +3. **Display Bill Value**: A Script Task to calculate the total bill. +4. **Handle Payment**: A Call Process that navigates to a payment-handling process. +5. **Order Confirmation**: A User Task that displays order confirmation.🧰 Tools
🪛 LanguageTool
[style] ~92-~92: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...Subprocess to handle food selection. Step 3: Display Bill Value - A Script ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~94-~94: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...pt Task to calculate the total bill. Step 4: Handle Payment - A Call Proces...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~96-~96: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...gates to a payment-handling process. Step 5: Order Confirmation - A User Ta...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (5)
docs/Building_Diagrams/images/Call_Activity.pngis excluded by!**/*.pngdocs/Building_Diagrams/images/Call_Activity1.pngis excluded by!**/*.pngdocs/Building_Diagrams/images/Script_task_update.pngis excluded by!**/*.pngdocs/Building_Diagrams/images/sub_process.pngis excluded by!**/*.pngdocs/Building_Diagrams/images/sub_process1.pngis excluded by!**/*.png
📒 Files selected for processing (2)
docs/Building_Diagrams/Script_Tasks.md(1 hunks)docs/Building_Diagrams/sub-processes_and_call_activities.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/Building_Diagrams/Script_Tasks.md
[duplication] ~22-~22: Possible typo: you repeated a word
Context: ... collaboration or future updates. 3. Script - Script Field: A text area for entering the c...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~34-~34: Possible typo: you repeated a word
Context: ...d debug scripts more effectively. 4. Instructions - Instructions Field: Use this section to define tas...
(ENGLISH_WORD_REPEAT_RULE)
docs/Building_Diagrams/sub-processes_and_call_activities.md
[style] ~92-~92: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...Subprocess to handle food selection. Step 3: Display Bill Value - A Script ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~94-~94: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...pt Task to calculate the total bill. Step 4: Handle Payment - A Call Proces...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~96-~96: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...gates to a payment-handling process. Step 5: Order Confirmation - A User Ta...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 Markdownlint (0.37.0)
docs/Building_Diagrams/sub-processes_and_call_activities.md
56-56: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
58-58: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
98-98: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
🔇 Additional comments (5)
docs/Building_Diagrams/sub-processes_and_call_activities.md (3)
Line range hint 1-13: LGTM! Clear introduction and well-structured content.
The introduction effectively explains the distinction between sub-processes and call activities, providing clear guidance on their usage.
🧰 Tools
🪛 Markdownlint (0.37.0)
56-56: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
58-58: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
14-59: LGTM! Comprehensive sub-process documentation with clear examples.
The restaurant ordering system example effectively demonstrates the use of sub-processes, with clear explanations of each step and component.
🧰 Tools
🪛 Markdownlint (0.37.0)
56-56: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
58-58: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
Line range hint 60-97: LGTM! Well-structured call process documentation with practical examples.
The payment handling example effectively demonstrates the use of call activities, with clear explanations of when and how to use them.
🧰 Tools
🪛 LanguageTool
[style] ~92-~92: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...Subprocess to handle food selection. Step 3: Display Bill Value - A Script ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~94-~94: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...pt Task to calculate the total bill. Step 4: Handle Payment - A Call Proces...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~96-~96: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...gates to a payment-handling process. Step 5: Order Confirmation - A User Ta...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 Markdownlint (0.37.0)
98-98: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
docs/Building_Diagrams/Script_Tasks.md (2)
9-42: LGTM! Comprehensive documentation of script task properties.
The section provides clear explanations of all properties with helpful examples and proper formatting. The Python code example effectively demonstrates context variable usage.
🧰 Tools
🪛 LanguageTool
[duplication] ~22-~22: Possible typo: you repeated a word
Context: ... collaboration or future updates. 3. Script - Script Field: A text area for entering the c...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~34-~34: Possible typo: you repeated a word
Context: ...d debug scripts more effectively. 4. Instructions - Instructions Field: Use this section to define tas...
(ENGLISH_WORD_REPEAT_RULE)
Line range hint 43-120: LGTM! Excellent examples and comprehensive function documentation.
The section provides:
- Clear examples with both Python and JSON code
- Well-documented pre/post script usage
- Comprehensive table of custom functions with descriptions
🧰 Tools
🪛 LanguageTool
[duplication] ~22-~22: Possible typo: you repeated a word
Context: ... collaboration or future updates. 3. Script - Script Field: A text area for entering the c...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~34-~34: Possible typo: you repeated a word
Context: ...d debug scripts more effectively. 4. Instructions - Instructions Field: Use this section to define tas...
(ENGLISH_WORD_REPEAT_RULE)
Added:
Summary by CodeRabbit