ExternalAuditor
The ExternalAuditor sends content to external web service for auditing and judges the results returned by the external service.
- Class
-
info.magnolia.services.seo.audit.impl.external.ExternalAuditor
ExternalAuditor is a convenient way to plug in a third party service (link a SEO ranking service or a spelling and grammar service) into Magnolia. An ExternalAuditor can be applied to different content types in Magnolia, for example a story defined in the Story app.
An ExternalAuditor does the following:
-
renders the selected content into a format suitable to the external service
-
builds a request to the external service with the formatted content and any additional parameters
-
sends a POST request to the external service and receives the results
-
processes the results to determine if the audit is passed or judged as a error, warning or not
Properties
In addition to the common auditor properties, this auditor can be configured with the following properties:
| Property | Description | ||
|---|---|---|---|
|
required A human-readable description of the configured auditor, suitable for use in auditor selection dialogs. |
||
|
required The name of the audit property where the audit results will be stored. |
||
|
required The location of the external web service. The url should be capable of receiving a |
||
|
optional The request parameter for the content. If not defined, the contentKey will be "text". |
||
|
required Defines pre-set parameters to be include in the service request. You can define additional static request parameters like license keys or client identifiers that will be added to the request. |
||
|
required A template definition for generating the content to be sent to the external service.
|
||
|
required A list of |
Example
Here is an example from the SEO module. You can find this configuration here: /modules/seo/config/auditManager/auditors/checkGrammar.
checkGrammar:
active: true
auditProperty: checkGrammar
class: info.magnolia.services.seo.audit.impl.external.ExternalAuditor
description: Check grammar (stories only)
url: https://api.textgears.com/check.php
definition:
class: info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
renderType: freemarker
templateScript: /seo/templates/story.ftl
requestParameters:
key: xxx
renderingParameters:
delegates:
requestSuccess:
auditLevel: auditWarning
auditProperty: checkGrammar
auditResult: TextGears request failure!
class: info.magnolia.services.seo.audit.impl.ValueDelegate
expectedValue: true
valueKey: result
checkGrammarScore:
auditLevel: auditErrors
auditProperty: checkGrammar
auditResult: Grammar score too low!
class: info.magnolia.services.seo.audit.impl.ThresholdDelegate
lowerBound: 0
upperBound: 80
valueKey: score