This guide details the management of predefined functions available for use within Workflow Step Actions in GimCore. These functions provide reusable logic to automate tasks and manipulate data during workflow execution.
To access and manage these functions, navigate to the Project Workflow section in the left navigation menu and select Workflow Action Functions.
Workflow Action Functions Data Table
Upon navigating to the Workflow Action Functions screen, you will be presented with a data table listing all configured action functions. This table provides a comprehensive overview of each function, including its key properties.
- Name: Displays the unique name assigned to the action function. This name is used to reference the function within workflow step actions.
- Code: Shows the actual code or script associated with the function. This code defines the operations performed by the function.
- Description: Provides a brief explanation of the function's purpose and functionality. This aids in understanding what each function does at a glance.
- Actions: This column contains interactive icons for managing individual action functions:
- Edit (Pencil Icon) 📝: Click this icon to modify the details of an existing action function. This opens the 'Edit Workflow Action Function' modal, allowing you to update its properties.
- Delete (Trash Can Icon) 🗑️: Click this icon to remove an action function from the system. A confirmation prompt will appear to prevent accidental deletion.
Adding a New Workflow Action Function ➕
To create a new predefined function for use in your workflows, follow these steps:
- Click the Add New button, typically located in the page header. This action will open the 'Add New Workflow Action Function' modal dialog.
- Within the modal, configure the following fields:
- Name: Enter a unique and descriptive name for your new action function. This name will be used to identify and select the function when configuring workflow steps.
- Code: Input the programmatic code or script that defines the function's logic. This can involve various operations such as data manipulation, external API calls, or conditional logic.
- Description: Provide a clear and concise description of what the function does. This is crucial for maintainability and understanding the function's purpose.
- After entering all required information, click the Save button within the modal to create the new action function. The function will then appear in the data table.
Editing an Existing Workflow Action Function ✏️
To modify the details of an existing action function:
- Locate the desired workflow action function in the data table.
- Click the Edit (Pencil Icon) 📝 in the 'Actions' column corresponding to the function you wish to modify. This will open the 'Edit Workflow Action Function' modal, pre-populated with the function's current details.
- Update the fields as necessary:
- Name: Modify the name of the function. Ensure the new name remains unique.
- Code: Adjust the code or script to update the function's behavior.
- Description: Refine the description to accurately reflect any changes in the function's purpose or operation.
- Click the Save button within the modal to apply your changes. The updated information will be reflected in the data table.
Deleting a Workflow Action Function 🗑️
To remove an action function from GimCore:
- Locate the workflow action function you wish to delete in the data table.
- Click the Delete (Trash Can Icon) 🗑️ in the 'Actions' column for that function.
- A confirmation dialog will appear, asking you to confirm the deletion. This is a critical step as deleting a function is permanent and may affect existing workflow steps that utilize it.
- Confirm the action to permanently remove the workflow action function from the system.