This is a showcase building an automated Acrolinx Integration using the Acrolinx .NET SDK.

For integrating the Sidebar see: Acrolinx .NET Sidebar Demo.

This demo application implements modern .NET development practices:

• Dependency Injection: Uses Microsoft.Extensions.Hosting for professional service registration and lifecycle management
• Structured Logging: Implements Microsoft.Extensions.Logging with configurable log levels and structured output
• Configuration Management: Centralized, validated configuration with comprehensive error handling
• Performance Optimization: Concurrency throttling prevents API overload and ensures reliable batch processing
• Clean Architecture: Separation of concerns with interfaces, services, and hosted services

Please contact Acrolinx SDK support for consulting and getting your integration certified. The tests in this SDK work with a test license on an internal Acrolinx URL. This license is only meant for demonstration and developing purposes. Once you finished your integration, you'll have to get a license for your integration from Acrolinx.

Acrolinx offers different other SDKs, and examples for developing integrations.

Before you start developing your own integration, you might benefit from looking into:

• Build With Acrolinx,
• the Guidance for the Development of Acrolinx Integrations,
• the Acrolinx Platform API
• the Rendered Version of Acrolinx Platform API
• the Acrolinx SDKs, and
• the Acrolinx Demo Projects.

1. Open Acrolinx.Net.Demo.sln in Visual Studio 2019. Visual Studio Code with .NET extension can be used as an alternative.
2. Press F5 key to run it.

Before running the project, you must set the required environment variables.

To do this, run the following command:

source acro-env-vars.bash

This script sets the necessary API configuration, such as:

• ACROLINX_URL
• ACROLINX_SSO_TOKEN
• ACROLINX_USERNAME
• ACROLINX_CLIENT_SIGNATURE
• ACROLINX_CONTENT_DIR (For content processing or for automated checking, if needed)

Configuration Validation: The application automatically validates all environment variables on startup and provides clear error messages for missing or invalid configurations.

Run the following command to build the project:

dotnet build

Ensure that the build completes successfully before running the project.

Batch mode processes multiple files at once with intelligent concurrency control to prevent API timeouts.

Features:

• Concurrency Throttling: Limits concurrent requests to prevent API overload
• Progress Tracking: Real-time logging of file processing status
• Batch Reporting: Generates Content Analysis Dashboard links for batch results
• Error Resilience: Continues processing even if individual files fail

To run batch checking:

dotnet run --project Acrolinx.Net.Demo

• You'll be prompted to enter a Batch ID.
• The batch check will process all supported files found inside the directory specified in ACROLINX_CONTENT_DIR.
• Files are processed with concurrency control (max 2 concurrent requests) to ensure reliable operation.
• Once completed, it will return a Content Analysis Dashboard link and automatically open it in your browser.

Automated mode continuously watches a directory for new or modified files and checks them automatically.

Features:

• Real-time Monitoring: Uses FileSystemWatcher for immediate file change detection
• Interactive Controls: Pause/resume monitoring with keyboard commands
• Background Service: Runs as a proper hosted service with graceful shutdown
• Automatic Browser Opening: Opens scorecards automatically when checks complete

To run automated checking:

dotnet run --project Acrolinx.Net.AutoCheck

• This mode monitors the ACROLINX_CONTENT_DIR folder and automatically checks any file that is created or modified.
• The process runs in the background and will print scorecard links when a file is processed.
• Use 'p' to pause, 'r' to resume, or Ctrl+C to quit.

If you need to modify the checking behavior, you can edit:

• Batch Check Mode: Modify sdk-demo-dotnet/Acrolinx.Net.Demo/BatchProcessingService.cs
• Automated Check Mode: Modify sdk-demo-dotnet/Acrolinx.Net.AutoCheck/AutoCheckService.cs
• Configuration: Modify sdk-demo-dotnet/Acrolinx.Net.Shared/AcrolinxConfiguration.cs
• Core Services: Modify sdk-demo-dotnet/Acrolinx.Net.Shared/AcrolinxService.cs

The application uses Microsoft.Extensions.Hosting for proper dependency injection:

• Services are registered in Program.cs using standard .NET patterns
• Configuration is injected as IAcrolinxConfiguration
• Acrolinx functionality is available through IAcrolinxService
• Logging is available throughout the application

Professional logging with Microsoft.Extensions.Logging:

• Different log levels (Information, Warning, Error, Critical)
• Structured logging with correlation IDs
• Configurable output (console, file, etc.)
• Performance tracking and debugging information

Comprehensive error handling and validation:

• Configuration validation with detailed error messages
• API timeout handling with retry logic
• File processing error resilience
• Graceful degradation when services are unavailable

• Concurrency Control: Prevents API overload with semaphore-based throttling
• Request Pacing: Adds delays between requests to be API-friendly
• Memory Management: Proper disposal of resources and background services
• Async/Await: Non-blocking operations throughout the application

Copyright 2019-present Acrolinx GmbH

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.