🔧 EasyTask Integration Server Management Guide¶
🚀 Start Integration Server¶
The Integration Server is started automatically during installation. If you need to restart it manually:
- On-Prem: The Integration Server runs locally on the infrastructure host. Use the system service manager to manage the server lifecycle.
- Cloud: The Integration Server runs locally alongside each worker agent. Use the system service manager on the agent host to manage it.
- Sandbox: The Integration Server is managed by the EasyTask team. Contact support if you experience issues.
✅ Confirming a Successful Start:
- The server becomes available for integration requests shortly after start.
- Check the Integrations page in the web UI to verify connectivity.
🛑 Stop Integration Server¶
- On-Prem: Use the system service manager to gracefully stop the Integration Server. A graceful stop ensures that any in-progress integration jobs complete before the server shuts down.
- Cloud: Use the system service manager on the agent host for a graceful shutdown.
- Sandbox: Contact EasyTask support.
✅ Confirming a Clean Shutdown:
- A graceful shutdown ensures active jobs are completed and resources are cleaned up safely.
- Check the server logs to verify a clean shutdown was completed.
⚙️ Additional Notes¶
- 🧩 Deployment Modes: Available for on-prem, cloud, and sandbox deployments.
- 🔒 Health Monitoring: The server emits periodic health signals for observability.
- 🛡️ Graceful Shutdown: Ensures active integration jobs complete and resources are cleaned up before stopping.
- 📋 Web UI Management: Integration keys and credentials can be managed from the Integrations page (
/integrations) in the web UI. - 🔐 Secure Credentials: All integration credentials are stored securely using encrypted credential storage.
Frequently Asked Questions¶
Q: How do I confirm the Integration Server is running? A: Check the Integrations page in the web UI to verify connectivity. For on-prem deployments, you can also check the server logs via the system service manager.
Q: What deployment modes are supported? A: The Integration Server supports on-prem, cloud, and sandbox deployments. For on-prem and cloud, the server runs locally alongside your infrastructure or agents. For sandbox, the server is managed by the EasyTask team.
Q: How do I safely stop the Integration Server? A: For on-prem and cloud, use the system service manager for a graceful shutdown. This ensures any active integration jobs complete before the server stops. For sandbox, contact EasyTask support.
Q: How do I manage integration credentials?
A: Navigate to the Integrations page (/integrations) in the web UI. You can add, view, edit, and delete credential keys for each integration type. Use the "Test Connection" button to validate credentials before saving.