Skip to content

Automator Overview

Automator|Client Services · .NET 10
DevOps & Integration Engineers
Automators integrate PayrollEngine into surrounding systems and build operational tooling. They use the .NET Client Services SDK and the Payroll Console CLI to automate payroll workflows, run CI/CD pipelines, and extend the platform with custom commands.
Automator
Client Services · .NET 10
NuGet SDK · CLI

What Automators Do

🔌 System Integration
Connect PayrollEngine to HR, ERP, and accounting systems. Use the JSON Exchange Model for structured import and export of payroll data.
⚡ Webhook Consumers
Receive engine events (CaseValueAdded, PayrunJobCompleted) and trigger downstream processes in real time via HTTP POST callbacks.
🔄 CI/CD Pipelines
Automate regulation validation on every commit with Payrun-Tests. Chain import, test, and export steps in .pecmd command files.
📊 Load Testing
Generate scaled test data, bulk-import employees and case changes, and execute load tests with built-in timing reports (CSV output).
🧩 Custom Commands
Extend the Payroll Console with domain-specific commands via Automation Extensions — C# class libraries dropped into the extensions folder.
🤖 LLM Pipelines
Combine SDK access with LLM output: import generated regulations via Exchange, validate with test runners, and surface results for Regulator review.

Required Skills

Skill Level
.NET / C# Required
REST API / HTTP Required
JSON Required
CLI / scripting Required
Docker Recommended

NuGet Packages

PayrollEngine.Client.Core
Core client library and API object model
PayrollEngine.Client.Services
Typed service access to all REST endpoints
PayrollEngine.Client.Scripting
Local scripting runtime for development & debug
PayrollEngine.Client.Test
Test runner framework for Case and Payrun tests

Packages are available on NuGet.org (no authentication required).

Tools

Tool Purpose
Payroll Console Primary CLI: import, export, test, load test, reports
Client Services SDK .NET library for custom tooling and integrations
Exchange Model JSON / Excel import and export of payroll data
Automation Extension Plugin mechanism for custom console commands
Docker Pre-built containers for Backend, Console, WebApp

Automation Patterns

Command Files (.pecmd)

Chain console commands for repeatable batch operations:

# Deploy and validate a regulation
PayrollImport MyRegulation.json
PayrunTest    MyRegulation.pt.json
PayrollExport Results.json

CI/CD Validation

Run payrun tests in a build pipeline to catch regulation regressions:

PayrollConsole PayrunTest MyRegulation.pt.json

LLM Workflow

  1. LLM generates regulation JSON + C# scripts
  2. SDK imports via Exchange
  3. Test runners validate against expected results
  4. Regulator reviews and approves

Next Steps