Acrolinx Server - 4.0.4 Service Release (31 October 2014)
This release fixes an issue that some customers have reported.
After you have configured your cost savings categories, you must assign the different issue types to the relevant cost savings categories. However, it was possible that the list of style and grammar issues was empty. Users were unable to assign issue types to cost savings categories. This issue has been resolved and the style and grammar issues should now be displayed as expected.
Acrolinx Server - 4.0.3 Service Release (18 August 2014)
This release fixes a serious SSL issue with the Website Checker that some customers have reported.
You can use the Acrolinx Website Checker to check a website for potential SEO improvements. However, when some users attempted to check a website, the Website Checker reported that an "Error had occurred". When reviewing the SEO server log file in debug mode, users noticed the error message "Error while handling the server exception: Unexpected end of file from server" . This issue was related to the version of Java that the SEO server is based on. This Java version contained a problem with SSL certificates which has since been fixed in newer Java versions. The original issue was now been resolved by upgrading the SEO server to a newer version of Java.
Acrolinx Server - 4.0.2 Service Release (12 May 2014)
This release fixes a serious linguistic issue that some customers have reported.
When the link checker was enabled in the core server properties, Acrolinx incorrectly flagged text as a grammar issue such as "your/you're confusion" or "where/were confusion". This issue was caused by a caching problem with the link checker and has now been resolved. Any users who were affected by this issue should no longer receive the incorrect grammar flags.
Acrolinx Server - 4.0.1 Service Release (29 April 2014)
This release fixes some issues that customers have reported.
When users tried to log in to the Dashboard, it was possible that this process took several minutes. After logging in, the overall performance of the Dashboard was very slow. For example, it could take up to several minutes to open the different pages. This issue occurred in environments with external terminology databases that contained many domains, typically several hundred. This issue was caused by a server issue that occurred during the creation of the domain structure and has been resolved. Users can now use the Dashboard without performance issues.
After administrators started the core server, the language server, and the SEO server, users could not select the SEO checking option in the plug-in options. This issue occurred because the available options are all cached once by the core server. If the SEO server was not running when a plug-in first connected to the server, SEO could not be enabled until the language server was restarted. This issue has been resolved and the SEO checking option is now always available if the SEO server is running.
This issue occurred when customers used checking profiles. If the names of the associated extraction settings contained characters that are invalid in some regular expressions, the server could not process the extraction settings. The check failed. This issue has been resolved. If an extraction settings file contains the problematic characters, the server now adds an entry to the log file and the check is processed as expected.
When a user tried to check with a checking profile that has been deleted on the server, the plug-in displayed an error message. This error message was too generic and did not indicate the cause of the issue. The error message has been improved and now gives users a clear indication of the issue.
When checking a document, the Acrolinx Scorecard displays the quality scores for the individual checking options. If you checked your document for SEO issues, it was possible that an SEO score of 100 was displayed, even though Acrolinx found SEO warnings in the document. This was confusing for some users. When calculating the SEO score, Acrolinx only factored in SEO issues. SEO issues are issues that are flagged in the document, for example issues with the assigned keywords. SEO warnings, however, were not included in the SEO score. SEO warnings depend on the individual document and are therefore only listed in the SEO report. However, to avoid misunderstandings, the calculation of the SEO score has been changed. Acrolinx now factors in both SEO issues and SEO warnings when calculating the SEO score.
If users searched for a term in the standard view of the Term Browser, the term was displayed in the search results but it was not possible to open the term information. When users clicked the term in the search results, nothing happened. This issue occurred when the searched term existed multiple times in the database. These duplicates can occur if a term is assigned to different domains. The issue only occurred in the standard view of the Term Browser. This issue has been resolved and terms from the search results are now displayed correctly.
In some cases, users did not receive the correct extraction settings even if the document closely matched the document type that the extraction settings were intended for. When users opened a second unrelated document, they received the previously missing extraction settings although the second document did not match the intended document type. This issue has now been resolved and the server is now stricter when matching extraction settings to document types. Users who were affected by this issue should no longer receive as many mismatched extraction settings.
If you use more than one Acrolinx plug-in on the same computer and you work with checking profiles, you might not receive the settings that you expected. For example, suppose that you use the Desktop Checker and the Word plug-in. Your assigned checking profile includes extraction settings for Word where the font "Courier" is excluded. If you check in Word while the Desktop Checker is running, the "Courier" font might not be excluded. This issue occurs because the Acrolinx server cannot always identify the individual Acrolinx plug-in when another plug-in is running. If you use an Acrolinx plug-in and notice that you are not getting the right extraction settings, close any other plug-ins that might be running on your computer and try again.
Information on Upgrading
We made this change because some users where receiving unexpected extraction settings and the server assigned extraction settings in an unpredictable way. This change should hopefully ensure that users receive consistent extraction settings when they work with the newest Acrolinx software. However, if you only upgrade your server, it is possible that plug-in users might not receive the extraction settings that you expect.
When you upgrade your server, upgrade your plug-ins to the latest version as well.
At the time of writing, the latest plug-in version is 4.0.1, so you should upgrade your plug-ins to version 4.0.1 or later.
If upgrading your plug-ins is not an option, have your Acrolinx administrator test the extraction settings to make sure that they are still intact.
To test the extraction settings, open all ofdocument types that you use in your organization and open the Acrolinx options to see if you receive the right extraction settings. For example, if you work with Microsoft Word and DITA, you would open a Microsoft Work document as well as all the different types of DITA file such as tasks, concepts, and topics. In each case, you would open the Acrolinx options and make sure that you receive the extraction settings that you usually receive. These settings could bespecific excluded fonts or excluded elements and sentence break elements.
- If some settings are missing, add them in the Acrolinx options.
- If you use checking profiles, make sure that the right extraction settings are assigned to the right checking profiles.
Acrolinx Server Release Notes - 4.0 Version (28 February 2014)
This release adds several new features and performance improvements to the Acrolinx server and fixes some bugs reported by customers.
Custom user information and custom document information
Custom user fields (previously "additional user information") are now documented exclusively in Analytics guide along with the new custom document fields. In previous versions, the information was duplicated in the Acrolinx Server administration guide and the Analytics guide.
- Using Analytics to calculate your Acrolinx ROI
- Migration of the default reporting database to the H2 database format
- The updated user interface for managing terms
- The updated quality score
You can now include voice scores in your Acrolinx resources. Voice scores measure the tone of voice in your content. The voice of your content is made up of several characteristics such as liveliness, informality, and readability. You receive scores for each of these characteristics. After you check your content, the Scorecard displays these scores underneath the quality score breakdown.
The Acrolinx professional services team sets up the voice scores for you. Acrolinx includes configuration files for voice in your linguistic resources. If you need more characteristics, you can ask the professional services team to create them.
Some characteristics include word lists. These lists contain words that influence the voice score for the characteristic. For example, you might have a list of words that are overused in marketing copy. These words reduce the liveliness of a document. You can ask the professional services team to include these lists when they set up your linguistic resources.
There are also some voice settings that you can configure yourself in the Dashboard. For example you can set voice score targets, disable or rename voice characteristics, and edit your word lists
- You can now collect both custom user information and custom document information. In previous server versions, you could only collect custom user information. Users can only see custom document fields when they check with an Acrolinx plug-in version 4.0 or later.
- You configure the fields for the custom information form in the Dashboard. You no longer have to edit the XML template files directly. If you have already configured an additional user information form in the configuration directory, this configuration is migrated to the new server version.
- Instead of configuring the custom fields in the Dashboard, you can still edit the underlying XML template files directly. This method is helpful if you generate the XML template files automatically from data in your databases. You might configure your system to generate an updated XML template file every time your system is updated with new information.
- If you enable the collection of custom information, users must fill out the custom information form before they can run a check. In previous server versions, it was possible to allow checking even if users did not fill out the form.
- Acrolinx now persistently stores data about users and documents every time a user runs a check. This enhancement ensures that you have a record of the data and can always query the historical data.
You find detailed information in the relevant section of the Acrolinx Analytics guide .
If you use Acrolinx, you might want to know if the improved content quality actually saves you money. For that purpose, you can use the reporting data to calculate your Acrolinx return on investment (ROI). You calculate your ROI by looking at how many issues your users found and corrected with Acrolinx. After you calculate how much money each corrected issue type saves, you assign the different issue types to ROI categories. When you create ROI reports, the results are broken down by these ROI categories.
ROI reports are part of the custom reporting templates included in your resources. Standard resources contain reporting templates to calculate the ROI by the configured categories and over a period of time. If you do not currently have any reporting templates installed, or require more reporting templates, contact your Acrolinx project consultant.
You find detailed information in the relevant section of the Acrolinx Analytics guide .
You can now configure your rules so that they only apply in certain contexts. Suppose that you work with DITA and have specific style rules for writing tasks. For example, you might want to ensure that authors always use the imperative when writing procedures. Similarly, you might decide that the imperative tense is optional when writing conceptual content. You can open the Dashboard and configure the "use imperative" rule so that it only applies to text that is written as a command within a procedure. This feature gives you the flexibility to define exactly where you want your style and grammar rules to apply.
When a check is complete, Acrolinx now generates a Scorecard that describes the detected issues. The new Scorecard replaces both the existing checking report and the results dialog. The Scorecard includes several improvements over the checking report. For example, the information is now displayed in an optimized way and the general navigation has been improved. You also benefit from the increased interactive options on the Scorecard. For example, you can hover over many elements on the Scorecard to display extra information and options. To display the Scorecard, you must use an Acrolinx server version 4.0 or later.
In Acrolinx Analytics, you can create custom reports that are based on predefined report templates. We updated and enhanced the default set of Analytics report templates. You can now select a custom time range in the "Quality" and "Usage" reports. You can now also select how you want to break down the data in the "Checking Metrics", "Quality", "Usage", and "ROI by Period" reports. These reports are part of the default report templates that are included in your linguistic resources. Additionally, you can now create the report "Most Frequent Spelling Issues" with information about the most frequent spelling issues in your texts.
When you search for terms in the Terminology Manager or the Term Browser, the results appear in the search results table. The search results table has been updated to add new features and to provide a more intuitive user experience.
- Acrolinx now uses an infinite scrolling list instead of pagination to display long lists of terms. The page automatically loads more items when you get close to the bottom of the page. To aid navigation, the table header is always displayed on top of the page when you scroll down. Infinite scrolling makes it easier to work with long lists which are common when working with terminology.
- You can use inline editing to edit a term directly in the search results table. To see if you can edit a cell in the search results table, move the mouse pointer over a cell. If it changes into a hand icon, you can click the cell and edit the field value. With inline editing, you can edit terms without leaving the search results table.
- You can group terms by term entry to see all terms that belong together. If you click Group by term entry , Acrolinx groups all synonyms and translations and displays them in separate sections of the search results table. This feature is especially useful if your terms usually have many synonyms and translations.
- It is easier to select or deselect terms in the search results table. To select or deselect all terms, select the checkbox in the header of the first column. This checkbox has three states, so you can also tell when only some of the filtered terms are selected. To select or deselect individual terms, select the checkbox next to the term. This change makes the user interface more intuitive for both experienced and new users.
In the Terminology Manager, you use batch edit functions to edit multiple terms in one action. You can now use the batch editing function to remove domains from terms. For example, if a domain becomes obsolete you can use the batch edit function to quickly remove the domain from all terms.
Acrolinx comes installed with a reporting database for testing the Analytics functionality. In previous server versions, Acrolinx installed an Apache Derby database for that purpose. In version 4.0, Acrolinx has changed that default database to H2. This database increases the performance for customers that use the default database. However, you should still only use the default database for testing and demonstration purposes. Acrolinx supports different external databases that are more suited for production environments. For a list of supported databases, see the Analytics guide .
If you have previously used the default Apache Derby database, you must migrate the existing reporting data to the H2 database. You find more information in the Information on Upgrading section of the release notes.
If you use Acrolinx Analytics but are concerned about information privacy, you can configure Acrolinx to anonymize all user-specific data that you collect. After you enable anonymous reporting, Acrolinx anonymizes all user data before writing it to the reporting database. This data includes the user name, user ID, details about the computer that ran the check, and details about the document that was checked. In the new server version, Acrolinx no longer stores context of a flag in the reporting database if anonymous reporting is enabled. The context of a flag is stored in the contextSurface column of the FlagEjb table. When anonymous reporting is enabled, Acrolinx only stores the value AnonymousContext instead of the actual context. This improvement adds more anonymity to your user data.
You can now save more customizations in the configuration directory. Acrolinx stores most of the CSS, image, and other files that control the styling in the server/www/gwt directory. You can now add files from anywhere in that directory that have the extension *.ico , *.png , *.gif , *.html , *.js , or *.css to the configuration directory. That way you can update Acrolinx without losing your customizations.
In Acrolinx Analytics, you can create custom reports in HTML, CSV, Excel, or PDF format. Developers can now also create a URL that contains the report parameters. Developers can use that URL to create an API call to open or create the report from another application. This feature is helpful when you want to recreate a report with identical parameters automatically, for example daily.
In previous server versions, the server waited for a fixed amount of time before starting the backup. Now, the backup is started more intelligently. When you start a reporting database backup, the server checks if any checks are still pending in the checking queue. If there are no checks pending, the backup starts straight away. If there are checks still pending, the backup starts as soon as all pending checks are finished. This change means that database backups are quicker. However, if a check takes very long, this change means that the backup can take longer to start. If you notice that a database backup takes significantly longer to start, check the core server log file. Acrolinx regularly adds an updated entry with information about the number of pending checks.
You can use the Term Browser property translationview.searchForm.restrictions.<FIELD_NAME>=<FIELD_VALUES> to restrict the range of options available to users in the translation view of the Term Browser. You can use this property to restrict the domains that users can search. This configuration is helpful if your terminology database contains more domains than you want your Term Browser users to display. For example, suppose that you have 10 domains but only 3 of these domains are relevant for your authors and translators. You can then restrict the translation view so that only terms from the 3 relevant domains are displayed as search results. Even if users filter for terms from all domains, only terms from the restricted domains are displayed. You find more information in the configuration topic for the translation view in the Term Browser documentation.
You use checking profiles to centrally manage most plug-in settings on behalf of your users. When you use checking profiles, your users automatically receive the right settings after they start an Acrolinx plug-in. While checking profiles are fully supported when you use a version 4 server with a version 4 plug-in, there are several limitations with legacy plug-ins . We made several improvements to the checking profile feature and many of these improvements affect checking profile support in legacy plug-ins. If you continue to use legacy plug-ins and checking profiles, upgrade to version 4 of Acrolinx Server. This upgrade ensures the best possible support for checking profiles in legacy plug-ins.
When you check with an Acrolinx plug-in, you receive a quality score for the document on the Acrolinx Scorecard. The quality score expresses the average of all category scores as a standardized score out of 100 that is easier for most users to understand. The higher the score, the higher the quality of the content. You can influence the calculation of the quality score by configuring the weighting of category scores. The quality score replaces the legacy checking score.
The styling of the rule help files has been updated
When you run a check with Acrolinx, you can click the rule name of a flag to display the rule help. The rule help contains more information about the flag. The style sheets for these rule help files have been updated. The new design is more streamlined and improves the readability of the displayed information. To benefit from the new style sheets, you must install version 4 resources.
If you work with synonyms, you can now display these synonyms in a separate column of the search results table. Synonyms are linked terms in the same language as the filtered term. Previously, synonyms were only displayed in the linked terms column. Now, if you add a column for the same language as the filtered term, such as English, you can see other English terms. This enhancement improves the user experience and provides a better overview if you work with terms that contain many translations and synonyms.
The core server log file contains a record of all events during the runtime of the core server. When a plug-in or other client issues a check request, the server adds an entry that lists the date and time of the check and the name of the checked document. These entries now also contain the name of the client together with the version and build number. This information helps you identify the checking activity of individual clients and is helpful when troubleshooting support issues.
When all language servers are busy, the core server puts new checking requests in a queue. If checking request are frequently queued and the queue times become too long, it might indicate bottlenecks in the processing capacity of the server. The core server log file now contains queueing metrics for each checking request. You can use this information to identify possible bottlenecks in the processing capacity of the server.
[INFO ][request <REQUEST_ID>] Queueing metrics: waited <QUEUE_TIME_IN_MS>ms before the Language Server processed the request (total since Acrolinx Core Server start: <TOTAL_QUEUE_TIME_IN_S>s)
You can now enable logging of HTTP requests to the server. Because the logging can have a severe impact on the performance of the server, you should only enable it when advised by the Acrolinx support.
You can now resize the text fields that are displayed when you edit terms on the term edit page or in the search results table. Text fields are all custom fields with the data type Text , for example fields for definitions or notes. If the text field is too small, you can resize the field by clicking and dragging the bottom right corner of the field. This change makes it easier for you to keep an overview when you enter long texts. While you can use this feature in most web browsers, it is not supported in Internet Explorer web browsers.
Acrolinx no longer officially supports Microsoft Windows XP. Windows XP is no longer supported by Microsoft. By concentrating on the newer Windows versions, Acrolinx can ensure to deliver the best possible user experience.
Bug Fixes - Server
If a term contained a comma or a full stop, it was possible that the language server failed to flag that term. This issue was caused by an error with the tokenization of the term. The server identified the full stop incorrectly as a sentence break. This issue has been resolved and the affected terms are now flagged correctly.
If a Japanese term contained a whitespace, the language server failed to load that term. This issue has been fixed with a workaround. The language server now does not inflect Japanese terms when they contain a whitespace. When users run a check, Acrolinx only identifies these terms when they are written exactly as they were entered into the terminology database. The original issue has been resolved and Acrolinx can now load the affected terms.
Bug Fixes - Documentation
To configure the weighting of category scores, administrators must edit the file thresholds.xml in the server/www/xsl directory. The documentation incorrectly claimed that this file could be copied to the configuration directory. If administrators copied the edited file to the configuration directory, the changes were not applied. The documentation has been changed and the procedure now correctly describes that administrators must edit the file in the installation directory.
Information on Upgrading
The database schemas have been updated
Extended the reporting database to include data for ROI reports
You can now calculate your Acrolinx return on investment (ROI) by reporting on how many issues your users found and corrected with Acrolinx. The reporting database schema has been updated to store ROI data. The database now includes the tables analyticsPropertyEjb , savingsCategoryEjb , and savingsRuleEjb to store different ROI-related data.
The reporting database now persistently stores user and document data
For each check, the server now stores custom user information and custom document information in the reporting database table DocumentEventMetaInfoEjb .
The reporting database now stores data about comparative checks
For each check, the database now stores if the check was a comparative check. Acrolinx stores the relevant data in the database table DocumentEventEjb .
The terminology database has been updated to store all data related to the updates and improvements of the Terminology Manager.
For each check, the database now stores the voice scores for each check in the reporting database. Acrolinx stores the relevant data in the database table VoiceCharacteristicEjb .
Acrolinx comes installed with a reporting database for testing the Analytics functionality. In previous server versions, Acrolinx installed an Apache Derby database for that purpose. In version 4.0, Acrolinx changed that default database to H2. If you use the default database, this new database format improves the database performance. However, you should still only use the default database for testing and demonstration purposes. Acrolinx supports different external databases that are more suited for production environments.
If you have previously used the default Apache Derby database, you must migrate the existing reporting data to the H2 database. During the migration, you must back up the old Derby database and restore that backup to the new H2 database. This procedure is only necessary if you use the default Apache Derby database. If you have configured Acrolinx to connect to an external database, you can ignore this procedure. You find detailed information about the migration procedure in the Analytics guide .
Suppose that you use checking profiles to define settings for several different user groups. If Acrolinx has added voice scores to your resources, your resources also come with a default set of target scores. These target scores give your authors an idea of what tone of voice they should aim for.
When you install your upgraded resources, Acrolinx automatically adds the standard set of target scores to all your checking profiles. This change means that all users see the same voice score targets when they start checking with the new server version. You might want some users to have different targets so ensure that you create more target sets and add them to the relevant checking profiles .
When you upgrade to a server that supports checking profiles, all existing users settings are migrated into the checking profiles structure. During migration, the server creates a checking profile for every combination of language and rule set that exist in your current resources. Additionally, all possible extraction settings are added to all checking profiles. If you changed the model user before the migration, it is possible that you do not get all or any extraction settings. To avoid this issue, select a model user with extraction settings before you migrate. The Acrolinx professional services team can help you with the migration to checking profiles.
When you upgrade Acrolinx from version 3.2 to version 4, you must restart your core server after you restored the database backup. This procedure is only necessary if you manually migrate the database from Acrolinx version 3.2 to Acrolinx version 4. For example, you manually migrate the reporting database if you use the default database because the default database has been changed. If you use an external reporting database, it is in most cases not necessary to manually migrate the reporting database.
When you use Acrolinx to configure context-specific rules, you can download the context definitions from the Dashboard to your local computer. However, in some environments, Internet Explorer 8 might prevent users from downloading the context definitions. If you encounter this issue, refer to the troubleshooting article about using Internet Explorer 8 with context definitions .
If you have configured Acrolinx to collect custom information, the custom information form is displayed in a web form inside the editor. If your server uses self-signed certificates, the form might not be displayed. This issue occurs because web forms do not display the dialog box to trust the self-signed certificate. To avoid this issue, either use a certificate that is signed by a certification agency or trust the self-signed certificate before you use the plug-in.
The "View Scorecards" page provides you with any easy way to open older Scorecards without accessing the file system on your server computer. However, if you open Scorecards that were created with an Acrolinx server before version 4.0, parts of the terminology information are not displayed correctly. This issue occurs because these older Scorecards were created as checking reports in the older Acrolinx version. When Acrolinx displays the content from these checking reports as Scorecards, terminology information might be displayed incorrectly.