External Tools Configuration
The External Tools Configuration screen allows you to configure the settings for external tools that are integrated into Squiz Matrix.
Bookmarks to the headings on this page:
The tools that can be integrated are as follows:
- HTML Tidy: this tool will check the HTML source code of the WYSIWYG Editors to ensure that it is valid. If it is not valid, it will try to correct the code.
- HTML Tidy Accessibility Checker: this tool will check the accessibility of the content that was entered into a WYSIWYG Editor.
- pdftohtml: this tool will index the content of any PDF files that are uploaded into system. If a search is then performed, for example through a Search Page, the content of the PDF files will also be searched.
- Antiword: this tool will index the content of any MS Word Documents that are uploaded into the system. If a search is then performed, for example through as Search Page, the content of the MS Word Documents will also be searched.
- PHP JPEG Metadata Toolkit: this tool will extract any dc:*XMP metadata from a JPEG image that has been uploaded into the system. This metadata can be created using Adobe Photoshop. For more information, visit The PHP Metadata Toolkit.
- Markdown and Markdownify: these tools allow you to configure and use the Markdown Content Type within the assets.
- getID3: this tool will extract metadata from a multimedia file that has been uploaded into the system, such as an MP3 or FLV file. For more information, visit the getID3() site.
- OGG Metadata Extraction: this tool will extract metadata from an OGG video file that has been uploaded into the system.
- Virus Checker: this tool will scan file assets for any potential threats. If the virus checker detects an infected file being uploaded, the file will be disallowed and the user will be informed.
- Mollom Spam Detector: this tool allows you to use Mollom's advanced spam prevention service to analyse and manage the form submissions of a site.
For the majority of these tools to work within Squiz Matrix, they need to be installed on the server.
Once installed, the path for each tool must be set in the system's tools.inc configuration file, located in the /data/private/conf directory.
When a tool has been configured correctly, it can be activated. Please note, that only the system's Root User can activate the external tools on this screen.
To access the External Tool Configuration screen, click on the System Configuration 
icon in the top right hand corner of the screen – a drop down list will appear
under this icon. From this list, select External Tools Configuration – the screen will appear.
Activate External Tools
This section allows you to enable the various system tools. Please note that the path to a tool must be correctly configured before the tool can be enabled. The Activate External Tools section of the External Tools Configuration screen is shown in the figure below.
The Activate External Tools section of the External Tools Configuration screen
The fields that are available in this section, outlined below, are only available to the system's Root User. The fields available are as follows:
- Enable HTML Tidy: select Yes from the list to enable HTML Tidy. This will only work if the correct path is specified in the Path to HTML Tidy field.
- HTML Tidy Accessibility Check Level: select the level of accessibility checking to perform on the content. This will only work if HTML Tidy is enabled.
- Enable pdftohtml: select Yes from the list to enable pdftohtml. This will only work if the correct path is specified in the Path to pdftohtml field.
- Enable Antiword: select Yes from the list to enable Antiword. This will only work if the correct path is specified in both the Path to Antiword and Path to Antiword Mappings field.
- Enable Photoshop Metadata Extraction: select Yes from the list to enable the PHP JPEG Metadata Toolkit. This will only work if the correct path is specified in the Path to PHP JPEG Metadata Toolkit.
- Enable Markdown: select Yes from the list to enable the Markdown tool. This will only work if the correct path is specified in the Path to Markdown field.
- Enable Markdownify: select Yes from the list to enable the Markdownify tool. This will only work if the correct path is specified in the Path to Markdownify field.
- Enable getID3 Extraction: select Yes from the list to enable getID3 Extraction. This will only work if the correct path is specified in the getID3 Extraction field.
- Enable OGG Metadata Extraction: select Yes from the list to enable OGG Metadata Extraction. This will only work if the correct path is specified in the Path to OGG Metadata Library field.
- Enable Virus Checker: select Yes from the list to enable the Virus Checker. This will only work if the correct path is specified in the Virus Checker field.
WYSIWYG Editor Tools
This section allows you to set up the tools for the system's WYSIWYG Editor. The WYSIWYG Editor Tools section of the External Tools Configuration screen is shown in the figure below.
The WYSIWYG Editor Tools section
The fields that are available in this section are outlined below:
-
Path to HTML Tidy: the path to the directory where the HTML Tidy tool has been installed. This is configured in the system's tools.inc file, located in the /data/private/conf directory.
If the path is incorrect or the tool has not been installed, a red error message will appear under the field. - Spell Checker Language: this field allows you to change the dictionary used by the pspell spell checker. This spell checker in used by Squiz Matrix in such areas as the WYSIWYG Editor spell checking. Squiz Matrix note that you must have already enabled support for the particular language dictionary in pspell otherwise this will not work.
Keyword Extraction Tools
This section displays the settings of the pdftohtml and Antiword tools. The Keyword Extraction Tools section of the External Tools Configuration screen is shown in the figure below.
The Keyword Extraction Tools section
The fields that are available in this section are outlined below:
-
Path to pdftohtml: the path to the directory where the pdftohtml tool has been installed. This is configured in the system's tools.inc file, located in the /data/private/conf directory.
If the path is incorrect or the tool has not been installed, a red error message will appear under the field, as shown in the figure below.
The error message for the pdftohtml tool -
Path to Antiword: the path to the directory where the Antiword tool has been installed. This is configured in the system's tools.inc file, located in the /data/private/conf directory.
If the path is incorrect or the tool has not been installed, a red error message will appear under the field, as shown in the figure below.
The error message for the antiword tool - Path to Antiword Mappings: the path to the directory where you store the Antiword mappings. This is configured in the system's tools.inc file, located in the /data/private/conf directory.
Photoshop Image Metadata Extraction
This section displays the settings of the PHP JPEG Metadata Toolkit. The Photoshop Image Metadata Extraction section of the External Tools Configuration screen is shown in the figure below.
The Photoshop Image Metadata Extraction
The fields that are available in this section are outlined below:
-
Path to PHP JPEG Metadata Toolkit: the path to the directory where the PHP JPEG Metadata Toolkit has been installed. This is configured in the system's tools.inc file, located in the /data/private/conf directory.
If the path is incorrect or the tool has not been installed, a red error message will appear under the field, as shown in the figure above.
Markdown Tools
This section displays the settings of the Markdown tools for the Markdown Content Type. The Markdown Tools section of the External Tools Configuration screen is shown in the figure below.
The Markdown Tools section
The fields that are available in this section are outlined below:
-
Path to Markdown: the path to the directory where the Markdown tool has been installed. This is configured in the system's tools.inc file, located in the /data/private/conf directory.
If the path is incorrect or the tool has not been installed, a red error message will appear under the field, as shown in the figure below.
The error message for the Markdown tool -
Path to Markdownify: the path to the directory where the Markdownify tool has been installed. This is configured in the system's tools.inc file, located in the /data/private/conf directory.
If the path is incorrect or the tool has not been installed, a red error message will appear under the field, as shown in the figure below.
The error message for the Markdownify tool
getID3 Extraction
This section displays the settings of the getID3 Extraction tool. The getID3 Extraction section of the External Tools Configuration screen is shown in the figure below.
The getID3 Extraction section
The fields that are available in this section are outlined below:
-
Path to getID3: the path to the directory where the getID3 tool has been installed. This is configured in the system's tools.inc file, located in the /data/private/conf directory.
If the path is incorrect or the tool has not been installed, a red error message will appear under the field, as shown in the figure on the below.
The error message for the getID3 tool
OGG Metadata Extraction
This section displays the settings of the OGG Metadata Extraction tool. The OGG Metadata Extraction section of the External Tools Configuration screen is shown in the figure below.
The OGG Metadata Extraction section
The fields that are available in this section are outlined below:
-
Path to OGG Metadata Library: the path to the directory where the OGG (vorbis/theora) PHP Metadata library has been installed. This is configured in the system's tools.inc file, located in the /data/private/conf directory.
If the path is incorrect or the tool has not been installed, a red error message will appear under the field, as shown in the figure above. For more information, refer to the Ogg.class.php site.
Virus Checker
This section allows you to set up the Virus Checker. The Virus Checker section of the External Tools Configuration screen is shown in the figure below.
The Virus Checker section
The fields that are available in this section are outlined below:
- Virus Checker Type: select which Antivirus checker to use. You can choose between the ClamAV and F-Prot tools. By default, this field is set to Clam Antivirus.
-
Path to Virus Checker: the path to the directory where the virus checker tool has been installed. This is configured in the system's tools.inc file, located in the /data/private/conf directory.
If the path is incorrect or the tool has not been installed, a red error message will appear under the field, as shown in the figure above.
JavaScript Configuration
This section allows you to set up a third-party JavaScript installation on your system. This configuration enables the use of server-side JavaScript processing on REST Resource JavaScript assets. For more information, refer to the REST Resource Assets chapter in the Web Services manual.
The JavaScript Configuration section of the External Tools Configuration screen
is shown in the figure below.
The JavaScript Configuration section
The fields that are available in this section are outlined below:
-
JavaScript Command: the path to the directory where the JavaScript engine has been installed. This is configured in the system's tools.inc file, located in the /data/private/conf directory.
If the path is incorrect or the tool has not been installed, a red error message will appear under the field, as shown in the figure above.Tip: To include ECMAScript for XML (E4X) support in a SpiderMonkey JavaScript installation, use /usr/bin/js -x as the JavaScript command path.
Mollom Spam Detector
This section allows you to set up Mollom Spam Detection on your system. Mollom is an advanced spam prevention service that analyses the quality of content posted to websites and automatically determines whether submissions are spam (unwanted content) or ham (legitimate content). If Mollom is unsure whether a submission is spam or not, a CAPTCHA will be presented for verification. The Mollom Spam Detector section of the External Tools Configuration screen is shown in the figure below.
The Mollom Spam Detector section
In order to use Mollom's spam detection service, you will need to obtain a registered user account at the Mollom website. The fields that are available in this section are outlined below:
- Test Mode: select whether or not to use Mollom Spam Detection for testing purposes only. If this field is set to Yes, posted content can be tagged as ham, spam or unsure without affecting the reputation of the user. By default, this field is set to No.
- Public Key: enter the public key of your registered Mollom user account.
- Private Key: enter the private key of your registered Mollom user account.
- Valid Keys?: whether or not the details supplied in the Public and Private Key fields is valid.
- Accept Bypassed Submission?: select whether or not submissions will be accepted if Mollom fails to respond as expected. For example, if this field is set to No and Mollom fails to classify a submission as either ham, spam or unsure, it will be rejected and not submitted on the site. By default, this field is set to Yes.
Squid Cache
The Squid Cache section allows you to modify the settings for clearing Squid cache within Squiz Matrix, for example, via the Clear Squid Cache Tool or the Clear Squiz Cache Trigger Action. For more information, refer to the Clear Squid Cache Tool chapter in the Tools manual and the Trigger Actions chapter in the Triggers manual.
The Squid Cache section of the External Tools Configuration screen is shown in the figure below.
The Squid Cache section of the External Tools Configuration screen
The following fields are available:
-
Host Names: enter the host name of the Squid Server. Multiple hosts can be specified, separately, on each new line.
The host name(s) specified in this field are used in the clear cache command, as follows:$ squidclient -h hostname -m PURGE $urls
$ squidclient -h proxy.example.com -m PURGE http://www.example.com - Path: the path to the Squid Client within your Squiz Matrix system. This is configured in the system's tools.inc file, located in the /data/private/conf directory. By default, this will be set to /usr/bin/squidclient.
- Port Number: enter the port number of the Squid client. By default, this field will be set to port 3128 .
-
Options: additional options are available to be included in the clear Squid cache purge command. For example, entering -r -T 5 to this field will append these options to the clear cache command, as follows:
$ squidclient -h hostname -r -T 5 -m PURGE $url
These additions will mean that this command will reload the URL, repopulating its cache, and have a timeout of five seconds.
The options available for appending the clear cache command are outlined in the table below.
Option Description -P file PUT request. -a Do NOT include Accept: header. -r Force cache to reload URL. -s Silent. Do not print data to stdout. -v Verbose. Print outgoing message to stderr. -i IMS If-Modified-Since time (in Epoch seconds) -h host Retrieve URL from cache on hostname. Default is localhost. -l host Specify a local IP address to bind to. Default is none. -p port Port number of cache. Default is 3128. -m method Request method, default is GET. -t count Trace count cache-hops. -g count Ping mode, "count" iterations (0 to loop until interrupted). -I interval Ping interval in seconds (default 1 second). -H 'string' Extra headers to send. Use '\n' for new lines. -T timeout Timeout value (seconds) for read/write operations. -u user Proxy authentication username. -w password Proxy authentication password. -U user WWW authentication username. -W password WWW authentication password. - Trailing Slash: select whether or not the clear Squid cache purge command should also clear selected URLs with an appended trailing slash. If this option is enabled and cache is cleared for the url http://www.example.com, cache will also be cleared for the url http://www.example.com/. By default. this option is disabled.
- Add Port to URL: specify a port to add to each URL when submitted to Squid. If you are running Squiz Matrix on a non-standard port behind Squid, you may need to add the port back to the URL to clear its cache.
Sendmail
This section displays the Sendmail settings for the system's Bulkmail server. You can configure the mail method used on the Bulkmail Manager. For more information, refer to the Bulkmail Manager chapter in the Bulkmail manual.
The Sendmail section of the External Tools Configuration screen is shown in the figure below.
The Sendmail section of the External Tools Configuration screen
The fields that are available in this section are as follows:
- Path: the file path to the Sendmail application, for example /usr/sbin/sendmail. This is configured in the system's tools.inc file, located in the /data/private/conf directory.
- Arguments: additional function parameters for sendmail. This is configured in the system's tools.inc file, located in the /data/private/conf directory.