This documentation describes the configuration and deployment of the Congree Web Interface.

Legend

Information, Tip, Note

Note: Note	Additional information for better understanding
Tip: Tip	Tip on working efficiently
Important: Note	Important note to avoid problems

Text Markups

the "Settings" dialog	User interface label
`Warning.xml`	File name

Actions to be Performed

Correct the error. Click "Check again".	Actions are numbered consecutively.
The "Check document" will open up.	The arrow indicates system reactions.
You have several options: Replace the faulty text. Click "Apply correction".	Circles mean: You have several action options.
The error has been successfully corrected.	The equals sign indicates the result of a successfully performed action.
The notification "The document does not contain any passages to be checked" is displayed.	The not equals sign indicates potentially undesirable results.
The sentence will be inserted in your document.	The box enables you to document which actions have already been performed and which results have already been achieved in the course of your evaluation.

Congree Web Interface Introduction

Congree Web Interface (short: CWI) allows the integration of Congree functionality into third party websites and web applications ("the Host").

Prerequisites

CWI requires the Congree Bulk Check Service to function. If you are unsure what that is or if you have it installed and licensed, please consult with your Congree representative.

CWI requires HTTPS to be used. If you do not want to use HTTPS some manual configuration is required. Please consult with your Congree representative.

Congree Web Interface Deployment

To be able to understand the following steps, you need to know how Congree Deployment Assistant is used. Find the manual here: Congree Installations- und Platform-Guide resp. Congree Installation and Platform Guide.

Go to Server Configuration and add Congree Bulk Check Service to the Host:

For the Congree Web Interface to work, you need to install at least the following sub components :

Language Check
Terminology
Congree Web Interface

Term Candidates has no effect on the Congree Web Interface since this feature is not supported but it might be used by other integrations using Congree Bulk Check Service.

Save your configuration and install on the Host.

Verification

After the installation via Congree Deployment Assistant has finished successfully, enter the following URLs in a browser where [hostname] is the Host.

https://[hostname]/CongreeWebInterface/cwi-integration.js

If you get some JavaScript Code or are asked to download a js file, this test has been successful

https://[hostname]/CongreeBulkCheckService/BulkCheckService.svc?singleWsdl

If you get some XML, this test has been successful.

If you get a security warning, there might be something wrong with your SSL certificates.

Please contact your administration in that case. Repeat this test from a client machine to verify it does not only work on the Host itself.

Integration

Requirements

CWI can work in two different display modes:

Fixed mode: In this mode, the CWI sidebar is always visible. The host must provide CWI with a div element. This element must exist at the time of the sidebar initialization. The Host is responsible for styling the div, i.e. to give it the correct size and placement. CWI will not re-style it.
Dynamic Overlay mode: In this mode, the CWI sidebar will be shown in an overlay. The Host is not required to provide any elements, however, the Host is required to trigger the showing and hiding of the overlay.

To configure the display mode, you have to adjust the cwi-integration.loader.

The CWI supports an integrated working mode: CWI will connect to one or multiple editors in the Host. These editors needs to exist when the sidebar is being initialized.

Important:

When you update Congree, the adjusted files are set back to default. Please copy the adjusted files, store them in another location and put them back in their folder after a Congree update.

Congree Web Interface

Contents