Python Action

Creating an Action Using Action Type: Python

Overview

This document provides step-by-step instructions for creating and configuring an action using the Python action type in Callgoose SQIBS automation platform. The Python action type allows users to execute Python scripts for automation workflows. Below are the configuration options and their descriptions:

Steps to Add a Python Action

Navigate to Add Action

• Access the automation section in the Callgoose SQIBS automation platform.
• Go to Automation, and you can see Action.
• Click on Action and then click on Add Actions to create a new action.

Select Action Type

• Choose Python as the action type from the list of available options.

Copy from Existing Actions

• Copy From:
• Click on Copy From to copy an existing action.
• You can copy actions from:
• Callgoose Actions: Predefined task-based scripts and programs available free of charge.
• Team Actions: Actions shared within your team.
• Global Actions: Actions available globally across the platform.
• Callgoose Actions provide several task-based scripts and programs that you can use and modify according to your requirements.

Fill in the Details

• Name*:
• Provide a descriptive name for the action.
• Example: Generate Report.
• Description*:
• Add a detailed description of what the action does.
• Example: This action generates a detailed report based on input data.
• Version:
• Select the required Python version.
• Example: Python 3.11.
• Success Response*:
• Define the expected output when the script runs successfully. The success response is similar to the exit status in Linux.
• Example: 0 exit status indicates the script or command executed successfully.

Configure Arguments

• Have Argument:
• Choose whether the action requires arguments.
• Yes: Enables input fields to define arguments for the script.
• No: Indicates that no arguments are required.

Set Expected Run Time

• Expected Run Time (in Minutes)*:
• Specify the estimated time for the script execution.
• Example: 10 (indicating 10 minutes).

Upload the Python Script File

• Python Script File*:
• Upload the Python script file to be executed.
• Click on File Upload and select the appropriate script from your local system.

Additional Notes

• If you are using pip install, ensure you use a versioned pip. For this action, use pip3.11 or the appropriate version corresponding to your selected Python version.
• Fields marked with an asterisk (*) are mandatory.
• Ensure the Python script is tested locally before uploading to avoid runtime errors.
• Use descriptive names and success responses to make it easier for team members to understand the action.
• The "Expected Run Time" should be realistic to help with workflow monitoring and optimization.

Example Configuration

Name: Generate Report

Description: This action generates a detailed report based on input data.

Version: Python 3.11

Success Response: 0 (indicating the Python script executed successfully).

Have Argument: Yes

Expected Run Time (in Minutes): 10

Python Script File: Upload a script named generate_report.py.

Conclusion

By following these steps, you can effectively configure and execute a Python action in Callgoose SQIBS. This capability enhances the automation of data processing tasks and simplifies workflow management.