Congree integration documentation
- Claudius Hörth
- Constantin Walter
This overview is meant to provide you some knowledge about Congree's integration possibilities. The goal is to help you to decide which integration is suitable for your needs.
Congree standard integration
For almost all popular systems, Congree offers a standard integration. This means an out of the box plugin which is ready to use after installation. To get an overview of all standard integrations, see https://www.congree.com/en/interfaces.
Because of the almost endless variety of different content related systems, a standard integration cannot be developed and maintained for each of them. For not so common systems and individual software solutions, we offer other possibilities, see below.
Technology: COM
Original user interface
Automatically benefit from feature updates
Automated Testing on Congree side
Highest stability
Most efficient support
Entire communication and technology is made by Congree
Requirements for editor API have to be met
Expensive for custom editing environments
Congree Anytime and Congree Indie
Congree Anytime enables the checking of text from any application, regardless of whether a Congree plugin is available or not. The check works via Windows clipboard and allows you to send text to Congree Anytime using just one shortcut.
You have files to be checked, but no editor for which a Congree standard integration is available? Then you can use the editor Congree Indie, which provides the Congree Authoring Client integrated in a basic editor which allows to open, edit and save files. File type examples are txt, xml or html.
The disadvantage of both possibilities: Congree is not integrated in the systems you are normally using. And for Congree Anytime, you have to consider that the check does not take place while clicking and typing, but has to be triggered consciously. Also, a disadvantage of Congree Anytime is the need to bring the changes made back to your original application. Besides the fact that this procedure can be cumbersome, the copy and paste process can ruin complex layout elements, f. e. tables.
Requires no development on customer side
Needs to be deployed
Least comfortable method of working with Congree
Congree Web Interface
The Congree Web Interface gives you the opportunity to integrate Congree into a web application of your choice. From web-based WYSIWYG text editors to SAP text fields to your totally individual web editor: Congree is where text is created. The Congree Web Interface provides developers the full Congree user interface and Congree Authoring Client logic. Only the integration into the web application (can be as less as 2 lines of code) has to be done by you.
Currently, the Congree Web Interface features the Congree Language Check and terminology research, which means that the term candidates extraction and all Authoring Memory related features are not available at the moment.
Technology: HTTP/JavaScript
Documentation: Congree Web Interface
Easy to implement
Reduced feature set
Congree Proxy Editor
The Congree Proxy Editor allows integrations into Windows desktop software if you do not have a supported editor control. Examples are simple text fields in desktop applications, or home-made editors. Here, the Congree Proxy Editor works as some kind of virtual editor which makes the third-party system content checkable by Congree.
The application into which the Congree Proxy Editor is integrated will call Congree if text has to be checked. Congree provides events to listen to for interaction with the client functionality:
- click a message
- apply correction proposal
Technology: COM/ActiveX
Documentation: Congree API for Proxy Editor
Original user interface
Automatically benefit from feature updates
Back end communication by Congree
Requires installation on Client side
Connection between editor and Congree needs to be implemented by a third party
Congree REST API
The Congree REST API is an easy state of the art way to provide Congree interfaces to third-party applications.
REST APIs are especially advantageous if you want to avoid using SOAP. Nevertheless, when using the Congree REST API, both Congree user interface and Congree Authoring Client logic have to be developed by you in case you use the Congree REST API. Therefore, developers should first check the Congree Web Interface as an integration possibility, because it will significantly reduce development efforts.
Technology: HTTP(S)/REST
Documentation: Congree REST API
Easy to implement
Requires implementation of an user interface by a third party
Reduced feature set
Congree Bulk Check Service
The principle of the Congree Bulk Check Service is, that text is sent to server-side Congree components, which return check results in a bulk operation mode (no real-time). The Congree user interface has to be developed by you. The third-party system in which the Congree Bulk Check Service is used in codes the logic.
For developers who are used to SOAP, the Congree Bulk Check Service provides the possibility to implement Congree successfully and with low efforts. However, for new implementations, you might prefer the REST API, as it is the more modern approach. Even more, if you want to benefit from future Congree features, you might use the Congree REST API.
Currently, the Congree Bulk Check Service features the Congree Language Check, terminology research and term candidates extraction, which means that all Authoring Memory related features are not available at the moment.
Technology: HTTP(S)/SOAP
Documentation: Congree Bulk Check Service
Easy to implement
Requires implementation of an user interface by a third party
Reduced feature set
Not developed any further