Acrolinx work for both small and large teams or writers.
If you connect your integration to the Acrolinx Platform in the cloud, you shouldn't have to worry about scaling problems.
If you’re planning to significantly increase the load on the Acrolinx Platform, talk to Acrolinx Support in advance. Acrolinx can fine-tune the scalability of your instance.
See also How Do I set up Acrolinx to scale for a large number of users?
Build your integration according to our best practices on communicating with the Acrolinx Platform. The Acrolinx Platform will block any unreasonable requests.
Use the following guidelines to minimize issues and maximize the user experience.
Use partner-dev to develop an integration.
Partner-dev is a shared instance of the Acrolinx developer community.
The instance has a fixed allocation of resources and can handle both integration tests and batch checks.
However, since it's a shared instance, use it in the spirit of goodwill to other developers.
If possible, submit your check requests in sequential order and avoid too many parallel requests.
Always call a requestCheck function first and then call the check function (see the Sidebar API Reference).
This way the Sidebar controls the frequency of checks.
A user action usually starts a check.
The Acrolinx Platform schedules checks from the Sidebar with a high priority (see Check Types). Giving Sidebar checks priority means that users get quick feedback and guidance on their content.
Use lazy loading to reduce the initial load time of the Sidebar. Efficiency is especially important when each document has its own Sidebar.
The integration environment usually limits the number of simultaneous requests.
If you open many documents at once, the Sidebar might fail to load. The root cause may be a combination of too many requests and a connection timeout on the integration side.
To avoid this situation, use a lazy load method to load the Sidebar when the user switches to the document.
Design your Acrolinx Integration to run smoothly both in the cloud and on premise. Cloud environments can usually handle high loads and Acrolinx Support can allocate additional resources if needed. On-premise setups often use physical hardware that admins can’t easily scale.
By default, batch checking integrations should submit one check after the other. Set a Check Type with a priority below high.
Each integration has its own performance requirements. If sequential processing is too slow, the admin can configure the number of parallel check requests. Don't maximize the load to 100%. Even if you know the exact resource allocation of an Acrolinx Platform instance. Overall performance and user experience can suffer if multiple integrations exceed the maximum load.
In the development phase, consider the number of parallel users the integration will have and the checking features you implement. How many parallel checks do you expect?
Usually it's sufficient if you limit the:
- Maximum parallel checks per user.
- Number of cron-based scheduled checks that are executed in parallel.