Information, Tip, Note

Text Markups

Actions to be Performed

CWI requires the Congree API 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.

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.

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.

• Loading CWI
• Instantiating CWI
• Further features
• Full example Dynamic mode
• Full example Fixed Mode
• Required changes in Host
• Option Documentation
• Adjust cwi-integration.loader
• Requirements
• Using CWI as sliding overlay

CWI can work in two different display modes:

1. 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.
2. 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.

You can find the cwi-integration.loader in *C:\ProgramFiles (x86)\Congree Language Technologies GmbH\Congree Bulk Check Service\Congree Web Interface*. In this folder, you can find three files which can be adjusted.

If you are using the fixed display mode, you have to modify the file C:\Program Files (x86)\Congree Language Technologies GmbH\Congree Bulk Check Service\Congree Web Interface\cwi-integration.loader.sample-sidebar.js

For the dynamic display mode, modify the file C:\Program Files (x86)\Congree Language Technologies GmbH\Congree Bulk Check Service\Congree Web Interface\cwi-integration.loader.sample-overlay.js.

Rename the file to contain your host applications name, e.g. cwi-integration.loader.cms.js.

Open the desired file and change the body of the loadSidebar function to your needs.

By way of changing the body of the loadSidebar function,

• You define the field IDs of the
  containers whose content is to be checked by the Congree Web Interface.
• You define which document-specific rule set is used by default by the Congree Web Interface.
• You can adjust the back end URLs, if neccessary.
• You deliver the login information for the Congree Web Interface, like user name and password.

For more details, see Option Documentation.

Congree.Sidebar

The following options are available when initializing the Congree Sidebar:

Authentication configuration object

Congree.Sidebar.show

This method is only relevant in the Fixed display mode.

The show function on the sidebar object requires one parameter: The ID of the div element that will contain the Congree Sidebar.

Congree.Sidebar.asOverlay

This method is only relevant in the Overlay display mode.

The following options are available when calling asOverlay on the sidebar object:

Congree.Sidebar.logout

This JS function can be used to logout the current user programmatically.

Include the cwi-integration Javascript file:

<script src="https://[hostname]/CongreeWebInterface/cwi-integration.js"</script>

Create a Javascript function that initializes and shows the Congree Sidebar:

Example 1: Authentication with Username and Password

<script type="text/javascript">

var congree = window.Congree || {};
window.Congree = congree;

congree.loadSidebar = function (username, password) {
    congree.sidebar = new Congree.Sidebar({
        serverAddress: "[hostname]",
        authentication: {
            userName: "[username]",
            password: "[password]",
			accessTokenURL: "[Congree Identity Server URL]",
            loginType: "usernamePassword"
        },
        initialRuleSetName: "[ruleset]”,
        editors: [
            Congree.AdapterFor.TextInput('textarea:not(.cke_source)'),
            Congree.AdapterFor.TextInput('input[type="text"]'),
            Congree.AdapterFor.TinyMce4('.tinymce4', 'tinymce'),
            Congree.AdapterFor.CKEditor4('.ckeditor4')
        ]
    });
    congree.sidebar.show("congreeSidebar");
};

</script>

Include the CWI loader javascript file:

 <script src="https://[hostname]/CongreeWebInterface/cwi-integration.loader.sample-sidebar.js"</script>

Example 2: Authentication via Trust CMS

<script type="text/javascript">

var congree = window.Congree || {};
window.Congree = congree;

congree.loadSidebar = function (username, password) {
    congree.sidebar = new Congree.Sidebar({
        serverAddress: "[hostname]",
        authentication: {
            userName: "SamWon",
            password: "[REST API secret]",
            loginType: "cms",
			accessTokenURL: "[Congree Identity Server URL]",
            thirdPartySystemsIdentifier: "Confluence"
        },
        initialRuleSetName: "[ruleset]”,
        editors: [
            Congree.AdapterFor.TextInput('textarea:not(.cke_source)'),
            Congree.AdapterFor.TextInput('input[type="text"]'),
            Congree.AdapterFor.TinyMce4('.tinymce4', 'tinymce'),
            Congree.AdapterFor.CKEditor4('.ckeditor4')
        ]
    });
    congree.sidebar.show("congreeSidebar");
};

</script>

Include the CWI loader javascript file.

<script src="https://[hostname]/CongreeWebInterface/cwi-integration.loader.cms.js"</script>

Call Congree.loadSidebar() at a time when the specified elements are created.

If the username and password for Congree depend on a login of the host application, they can be supplied as parameters to that function.

The

Only relevant for dynamic display mode:

Call Congree.SidebarOverlay.show(), when the Congree Overlay should be shown, e.g. in the focus event of your editor elements.

Call Congree.SidebarOverlay.hide(), when the Congree Overlay should be hidden, e.g. in the blur event of your editor elements.