SyncSharp is a powerful development framework used by software engineers to build high-performance data synchronization, file replication, and workflow automation solutions. Automating your workflows with SyncSharp plugins allows you to execute custom business logic, handle file movements, and trigger events across disparate systems without manual intervention. Core Architecture of SyncSharp Automation
SyncSharp relies on a declarative Trigger-and-Action pipeline. When an event occurs within your source environment, the SyncSharp core framework captures the event context and processes it through your registered plugins.
[ Source Event ] ──> [ SyncSharp Engine ] ──> [ Pre-Operation Plugin ] ──> [ Core Sync ] ──> [ Post-Operation Plugin ] Steps to Automate Your Workflow 1. Define the Automation Trigger
Before writing code, establish what event will kick off your workflow. SyncSharp primarily supports three types of triggers:
Event-Driven: Triggers instantly when a file is created, data is modified, or an API webhook is received.
Scheduled/Polling: Triggers at predefined intervals (e.g., every 5 minutes or nightly at 12:00 AM).
State-Based: Triggers only when specific criteria are met (e.g., when an order status changes to “Approved”). 2. Implement the ISyncPlugin Interface
To build your automation plugin, create a C# Class Library in Visual Studio, import the SyncSharp SDK, and implement the core execution interface.
using SyncSharp.SDK; public class WorkflowAutomationPlugin : ISyncPlugin { public string Name => “OrderProcessingAutomation”; // This method fires automatically when the SyncSharp engine calls the plugin public void Execute(ISyncContext context) { var syncItem = context.CurrentTargetItem; // Example Task: Validate data before syncing if (syncItem == null || string.IsNullOrEmpty(syncItem.Payload)) { context.Logger.LogWarning(“Empty payload detected. Skipping item.”); context.CancelOperation(); return; } // Example Task: Enrich data or format files dynamically syncItem.Payload = syncItem.Payload.ToUpper(); context.Logger.LogInfo($“Successfully processed item: {syncItem.Id}”); } } Use code with caution. 3. Choose Your Execution Stage
When registering your plugin in the SyncSharp pipeline, you must choose exactly when it runs to ensure proper workflow handling:
Pre-Operation Stage: Runs before data is committed or moved. Ideal for data validation, compliance checks, data enrichment, or stopping unauthorized transfers.
Post-Operation Stage: Runs after a successful sync operation. Ideal for sending email/Slack notifications, triggering downstream APIs, logging audit trails, or cleanup tasks. 4. Register and Deploy the Plugin Compile your C# project to generate a library (.dll) file.
Drop the .dll file into the designated /Plugins folder of your SyncSharp installation directory.
Open your SyncSharp Configuration Console or update the syncsharp.config file to map your plugin to a specific synchronization profile. Restart the SyncSharp background service to apply changes. Best Practices for SyncSharp Automation
Always run asynchronously for heavy tasks: If your plugin calls a third-party API or runs complex calculations, handle it asynchronously to prevent blocking the primary synchronization queue.
Set up explicit error boundaries: Always wrap your plugin logic in try-catch blocks. Use SyncSharp’s native logging context (context.Logger.LogError) so errors show up clearly in your central monitoring dashboards.
Implement strict data filtering: Ensure your plugin step targets specific attributes or file types. Running un-filtered logic across every global sync event will severely degrade system performance.
Leave a Reply