Actions ¶

MultiFlexi Actions are modular components that can be executed when specific events occur during job execution. Actions provide a way to extend MultiFlexi’s functionality by integrating with external services and systems.

Overview ¶

Actions in MultiFlexi are event-driven components that can be triggered at different points in the job lifecycle:

Action Icons Gallery ¶

MultiFlexi provides a comprehensive set of actions, each with its distinctive icon:

Available Actions¶
Icon	Action Name	Description
	ToDo	Microsoft Office 365 integration for task management
	Reschedule	Dynamic job scheduling and timing control
	WebHook	HTTP POST requests to external endpoints
	RedmineIssue	Redmine project management integration
	Github	GitHub repository management and issue creation
	TriggerJenkins	Jenkins CI/CD pipeline triggering
	LaunchJob	MultiFlexi job launching and workflow orchestration
	Stop	Process and service termination control
	Zabbix	Monitoring system integration
	CustomCommand	Arbitrary shell command execution
	Sleep	Workflow timing and pause control

Action Lifecycle ¶

Actions can be triggered at different points in the job lifecycle:

Success Actions: Executed when a job completes successfully
Fail Actions: Executed when a job fails or encounters an error

Each action is implemented as a PHP class that inherits from MultiFlexi\CommonAction and provides both a backend execution component and a UI configuration component.

Available Actions ¶

ToDo Action ¶

The ToDo Action integrates with Microsoft Office 365 To Do (Microsoft Graph API) to create and manage tasks based on job execution events.

Features:

Create ToDo tasks automatically when jobs succeed or fail
Support for both delegated and application authentication methods
Customizable task titles and descriptions with placeholder support
Configurable task priorities (low, normal, high)
Integration with multiple Office365 tenants

Use Cases:

Create reminder tasks when important jobs fail
Track completed data processing operations
Notify team members about system maintenance completion
Log business process milestones in team task lists

Configuration ¶

The ToDo Action supports two authentication methods:

Method 1: Username/Password Authentication (Delegated)

This method uses user credentials and accesses the authenticated user’s ToDo lists.

OFFICE365_USERNAME=user@company.onmicrosoft.com
OFFICE365_PASSWORD=user_password
OFFICE365_TENANT=company.onmicrosoft.com

Method 2: Client ID/Secret Authentication (Application)

This method uses application credentials and can access any user’s ToDo lists with proper permissions.

OFFICE365_CLIENTID=87731a38-540e-405d-9e1f-e867617dd8fe
OFFICE365_CLSECRET=8FR8Q~3Rab4-4o7cAd~1vDRId8oYiqEtMJB.Ucb2
OFFICE365_TENANT=company.onmicrosoft.com
OFFICE365_USER_ID=5cded639-0b8d-4abc-8976-d202aa1770fa

Required Azure API Permissions ¶

For the ToDo Action to work properly, your Azure App Registration must have the appropriate Microsoft Graph API permissions configured.

For Username/Password Authentication (Delegated Permissions):

Navigate to Azure Portal → App registrations → Your app
Go to API permissions
Click Add a permission → Microsoft Graph → Delegated permissions
Add the following permissions:
- Tasks.ReadWrite - Read and write user’s tasks
- User.Read - Sign in and read user profile
Click Grant admin consent for your organization

For Client ID/Secret Authentication (Application Permissions):

Navigate to Azure Portal → App registrations → Your app
Go to API permissions
Click Add a permission → Microsoft Graph → Application permissions
Add the following permissions:
- Tasks.ReadWrite.All - Read and write all tasks
- User.Read.All - Read all users’ profiles
Important: Click Grant admin consent for your organization
Ensure your application has a Client Secret configured in Certificates & secrets

Azure App Registration Setup:

Create App Registration:
- Go to Azure Portal → Azure Active Directory → App registrations
- Click New registration
- Enter a name for your application
- Select appropriate supported account types
- Click Register
Configure Client Secret (for Application authentication):
- In your app registration, go to Certificates & secrets
- Click New client secret
- Add a description and select expiration period
- Copy the Value (not the Secret ID) - this is your OFFICE365_CLSECRET
Get Required IDs:
- Application (client) ID: Found on the app registration Overview page
- Directory (tenant) ID: Found on the app registration Overview page
- User Object ID: Go to Azure Active Directory → Users → Select user → Copy Object ID

Configuration Parameters ¶

When configuring a ToDo Action in MultiFlexi, you can customize the following parameters:

Office365 Credential

Select the Office365 credential containing authentication information

ToDo List

Choose which ToDo list to create tasks in (automatically populated based on available lists)

Default Task Priority

Set the priority for created tasks:

low - Low priority
normal - Normal priority (default)
high - High priority

Task Subject Template

Customize the task title using placeholders:

{job_name} - Name of the executed job
{status} - Job execution status (success/failure)
{company} - Company name

Example: Task: {job_name} - {status}

Task Body Template

Customize the task description using placeholders:

{job_name} - Name of the executed job
{status} - Job execution status
{company} - Company name
{timestamp} - Execution timestamp

Example: Job: {job_name}\nCompany: {company}\nStatus: {status}\nTime: {timestamp}

Authentication Methods Comparison ¶

Authentication Methods¶
Aspect	Username/Password (Delegated)	Client ID/Secret (Application)
Setup Complexity	Simple - just user credentials	Complex - requires Azure app registration
Security	Requires storing user passwords	More secure - no user passwords
Permissions	Limited to user’s own tasks	Can access any user’s tasks
API Endpoint	`/me/todo/lists`	`/users/{userId}/todo/lists`
Admin Consent	Not required	Required
Recommended For	Personal use, development	Production, enterprise environments

Troubleshooting ¶

Common Issues and Solutions:

“UnknownError” from Microsoft Graph API
- Cause: Missing API permissions or insufficient admin consent
- Solution: Verify Azure app registration has correct permissions and admin consent is granted
“Cannot access user data”
- Cause: Invalid User ID or insufficient permissions
- Solution: Verify the User Object ID is correct and app has User.Read.All permission
“Invalid client secret detected”
- Cause: Using Client Secret ID instead of the secret value
- Solution: Copy the secret Value from Azure Portal, not the ID
“SharePoint tenant detected”
- Cause: Using SharePoint tenant name instead of full domain
- Solution: Use full domain format (e.g., company.onmicrosoft.com)
Authentication failed with username/password
- Cause: Account has MFA enabled or conditional access policies
- Solution: Use Client ID/Secret authentication method instead

Debug Information:

MultiFlexi provides detailed debug information when ToDo Action fails:

API endpoints being called
Token permission verification results
Request IDs for Microsoft support
Specific error codes and messages

Reschedule Action ¶

The Reschedule Action allows you to modify the scheduling of jobs, changing when they will run next. This is useful for dynamic scheduling based on job results, system load, or business requirements.

Features: - Modify job schedules dynamically - Support for cron expressions and time intervals - One-time delays or permanent schedule changes - Integration with MultiFlexi’s job scheduler

Configuration Options:

New Schedule - Cron expression or time specification for the new schedule
Delay Type - Type of delay (minutes, hours, days, weeks)
Delay Amount - Number of delay units
One-time or Recurring - Whether to reschedule once or change the recurring schedule

Use Cases: - Delay jobs during maintenance windows - Reschedule failed jobs for retry with backoff - Adjust frequency based on system performance - Implement business logic-based scheduling

WebHook Action ¶

The WebHook Action sends HTTP POST requests to external endpoints, enabling integration with third-party systems and services.

Features: - HTTP/HTTPS webhook notifications - Customizable headers and payloads - Authentication support (Basic, Bearer token, API key) - Retry mechanisms with configurable backoff - SSL certificate validation

Configuration Options:

URL - Target webhook endpoint URL
HTTP Method - Request method (POST, PUT, PATCH)
Headers - Custom HTTP headers
Payload - JSON or form data to send
Authentication - Basic auth, API key, or bearer token
Timeout - Request timeout in seconds
Retry Policy - Number of retry attempts and backoff strategy

Security Features: - SSL/TLS certificate validation - Webhook signature verification - Configurable user agent strings - Request/response logging for debugging

Use Cases: - Notify external systems of job completion - Trigger workflows in other applications - Send data to analytics platforms - Integration with chat systems (Slack, Teams, Discord)

RedmineIssue Action ¶

The RedmineIssue Action creates and manages issues in Redmine project management systems, perfect for automated issue tracking and project management workflows.

Features: - Automatic issue creation in Redmine - Customizable issue attributes - Support for custom fields - Integration with Redmine projects and trackers - API key authentication

Configuration Options:

Redmine URL - Base URL of your Redmine instance
API Key - Redmine API access key
Project - Target project identifier
Tracker - Issue tracker type
Status - Initial issue status
Priority - Issue priority level
Subject - Issue title/subject
Description - Detailed issue description
Assignee - User to assign the issue to
Category - Issue category
Custom Fields - Project-specific custom field values

Authentication: Requires a valid Redmine API key with permissions to create issues in the target project.

Use Cases: - Automatically create issues for failed jobs - Generate maintenance tickets - Track deployment activities - Create bug reports from monitoring alerts

Github Action ¶

The Github Action integrates with GitHub repositories to create issues, pull requests, and manage repository activities.

Features: - GitHub Issues and Pull Request creation - Repository management operations - Label and milestone assignment - Markdown-formatted descriptions - GitHub API v4 (GraphQL) and v3 (REST) support

Configuration Options:

Repository - Target GitHub repository (owner/repo format)
Authentication Token - GitHub Personal Access Token or OAuth token
Action Type - Issue creation, PR creation, or repository management
Title - Issue or PR title
Body - Detailed description with Markdown support
Labels - Repository labels to apply
Assignees - Users to assign to the issue/PR
Milestone - Target milestone
Branch - Branch for PR operations

Required Permissions: The GitHub token must have appropriate permissions: - Issues: Write - For creating and managing issues - Pull Requests: Write - For creating PRs - Repository: Read - For repository access - Metadata: Read - For accessing repository metadata

Use Cases: - Create issues for deployment failures - Generate automated pull requests - Track feature requests and bugs - Integrate with development workflows

TriggerJenkins Action ¶

The TriggerJenkins Action starts builds and jobs on Jenkins CI/CD servers, enabling automated pipeline triggering based on MultiFlexi job results.

Features: - Remote Jenkins job triggering - Build parameter passing - Job status monitoring - CSRF token handling - Multiple authentication methods

Configuration Options:

Jenkins URL - Base URL of Jenkins instance
Job Name - Name of the Jenkins job to trigger
Authentication - Username/password or API token
Parameters - Build parameters to pass to Jenkins job
Wait for Completion - Whether to wait for job completion
Timeout - Maximum wait time for job completion

Security Configuration: - Basic authentication support - API token authentication (recommended) - CSRF token handling - SSL certificate validation

Use Cases: - Trigger deployments after successful tests - Start build pipelines based on data processing results - Chain Jenkins jobs with MultiFlexi workflows - Automated CI/CD integration

LaunchJob Action ¶

The LaunchJob Action starts other MultiFlexi jobs or external processes, enabling complex workflow orchestration and job chaining.

Features: - MultiFlexi job launching - External process execution - Parameter passing between jobs - Process lifecycle management - Resource usage monitoring

Configuration Options:

Job Type - MultiFlexi job or external command
Job Identifier - Job ID or command to execute
Parameters - Parameters to pass to the launched job
Working Directory - Directory for command execution
Environment Variables - Custom environment variables
Wait for Completion - Whether to wait for job completion
Timeout - Maximum execution time
Success Criteria - Conditions that define successful completion

Process Management: - Process lifecycle monitoring - Resource usage tracking - Output capture and logging - Clean shutdown handling

Use Cases: - Create complex multi-step workflows - Launch parallel processing jobs - Execute system maintenance scripts - Orchestrate data processing pipelines

Stop Action ¶

The Stop Action terminates running processes, jobs, or services, providing control over system resources and workflow management.

Features: - Process and service termination - Graceful shutdown handling - Force termination capabilities - Safety confirmation prompts - Comprehensive operation logging

Configuration Options:

Target Type - Process, service, or MultiFlexi job
Target Identifier - Process ID, service name, or job ID
Stop Method - Graceful shutdown or forced termination
Timeout - Time to wait before forcing termination
Confirmation Required - Whether to require manual confirmation

Safety Features: - Confirmation prompts for critical operations - Graceful shutdown attempts before force killing - Process ownership verification - Logging of all stop operations

Use Cases: - Emergency job termination - Resource cleanup operations - Service restart workflows - Automated system maintenance

Zabbix Action ¶

The Zabbix Action sends monitoring data, alerts, and metrics to Zabbix monitoring systems, enabling comprehensive system monitoring integration.

Features: - Zabbix sender integration - Custom metric reporting - Alert generation - Performance data collection - Multiple data type support

Configuration Options:

Zabbix Server - Hostname or IP of Zabbix server
Port - Zabbix server port (default 10051)
Host Name - Monitored host name in Zabbix
Item Key - Zabbix item key for the metric
Value - Metric value to send
Timestamp - Optional custom timestamp
Authentication - PSK or certificate authentication

Supported Data Types: - Numeric values (integers, floats) - Text values - Log entries - Status indicators - Custom metrics

Use Cases: - Send job execution metrics to monitoring - Report application performance data - Generate custom alerts and notifications - Integration with existing monitoring infrastructure

CustomCommand Action ¶

The CustomCommand Action executes arbitrary shell commands or scripts, providing maximum flexibility for system automation and integration.

Features: - Shell command execution - Script running capabilities - Environment variable support - Input/output handling - Security restrictions

Configuration Options:

Command - Shell command or script to execute
Arguments - Command-line arguments
Working Directory - Directory for command execution
Environment Variables - Custom environment variables
Input Data - Data to pass to command stdin
Timeout - Maximum execution time
Expected Exit Code - Success criteria
Output Capture - Whether to capture stdout/stderr

Security Considerations: - Command validation and sanitization - Restricted execution environments - User privilege management - Audit logging of all commands

Use Cases: - Execute system maintenance scripts - Run data processing utilities - Integration with legacy systems - Custom automation workflows

Sleep Action ¶

The Sleep Action pauses workflow execution for a specified duration, useful for timing control, rate limiting, and coordination between workflow steps.

Features: - Precise timing control - Interruptible sleep operations - Progress monitoring - Resource-efficient waiting - Multiple time unit support

Configuration Options:

Duration - Sleep time amount
Time Unit - Seconds, minutes, hours, or days
Interruptible - Whether sleep can be interrupted
Progress Reporting - Show countdown or progress indicator

Implementation Features: - High-precision timing - Graceful interruption handling - Progress monitoring - Resource-efficient waiting

Use Cases: - Rate limiting for API calls - Waiting for external system processing - Coordinating parallel workflows - Implementing retry delays

Action Configuration Best Practices ¶

When configuring actions, follow these best practices:

Security: - Use encrypted credential storage - Implement least-privilege access - Regular credential rotation - Audit action configurations

Performance: - Configure appropriate timeouts - Implement retry mechanisms - Monitor resource usage - Use async operations where possible

Monitoring: - Enable comprehensive logging - Set up alerting for failures - Track action performance metrics - Implement health checks

Maintenance: - Document action configurations - Version control action definitions - Test actions in staging environments - Regular configuration reviews