Installing and Configuring an External Connector
What's an External Connector?
You use an external connector to integrate the Batch Checker with a content management system (CMS). You can add an external connector by installing an external connector file. Your organization can use the Acrolinx API to develop an external connector that works with your specific CMS. After you have installed and configured your external connector, you can use the Batch Checker to check files that are stored in your CMS.
Normally, external connectors are distributed centrally from your Acrolinx Server installation. If there are changes to your external connector, your Acrolinx Server administrator updates the server with a new package and the Batch Checker downloads and installs the new package the next time you connect to the server.
The server administrator copies the external connector package to the following location on your Acrolinx Server:
If your local installation is automatically updated but already contains external connector files from a previous update, those files are copied to a backup directory after you restart the Batch Checker.
During the backup process, all external connector files that are older than a week are removed from the backup directory. The external connector backup directory is located at:
If you are testing a new external connector, you can also install an external connector file for your Batch Checker installation only. An external connector file is a JAR file that you copy to a specific folder in your Batch Checker installation.
Installing an External Connector
You can install external connectors that are centrally distributed from your Acrolinx Server, or you can install an external connector for your Batch Checker installation only. After you configure your external connector, you can find and check files in your content repository.
To install and configure an external connector, follow these steps:
Install the external connector.
To install a centrally distributed external connector, refresh your connection to the Acrolinx Server.
If your Acrolinx Server administrator has updated your server with a new external connector package, the external connector package is downloaded and installed automatically.
To install an external connector file locally, copy your external connector file to the directory:
If this directory does not exist, create it.
To prevent your locally installed external connector from being overwritten by automatic updates, you can disable automatic updates in your system properties file .
- To install a centrally distributed external connector, refresh your connection to the Acrolinx Server.
Restart the Batch Checker.
If the external connector has successfully loaded, a new External connector option is visible in the Document Type section.The External connector dropdown displays a list of all installed connectors.
The Configure and Find Files buttons are enabled depending to the state of the selected connector.
If the selected connector is configurable, the Configure button is enabled.
You might receive a configurable external connector if you are required to enter login details for your CMS before you can scan for documents.
The Find Files button is enabled after you have configured the connector correctly, or if the connector does not require configuration.
- If your connector is configurable, click Configure and enter the required settings.
to find and select files for checking.
If your required files are not in the search results, click New Selection to select another location in your CMS.
After your search results are displayed in the file list, right click a file to open the shortcut menu and view any commands that are available for your external connector.
Your external connector might be customized with shortcut menu commands that are specific to your CMS. For example, developers can design an external connector that enables you to open your files in a specific editor directly from the Batch Checker shortcut menu.
Disabling Automatic Updates
By default, external connectors are distributed centrally from the Acrolinx Server. When you connect to a server that has been updated with a new external connector package, the Batch Checker automatically downloads and installs the new package. If you are testing an external connector that you have installed locally, you might disable automatic updates until you have finished testing.
To disable automatic updates, follow these steps:
- Close the Acrolinx Batch Checker and open the system.properties file.
Add the property:
When this property is not present, the default is true .
Save and close the file.
When you start the Acrolinx Batch Checker, the new value takes effect.