Back-end configuration

The Fonto Review backend also has required configuration. This configuration is necessary to perform a compare between revisions of documents to map positions (annotations) from one revision to another.

Schema experience

The Fonto Review backend also has required configuration. This configuration is necessary to perform a compare between revisions of documents to map positions (annotations) from one revision to another.

This configuration consists of two environment variables:

Option

Default

Required

Description

SchemaExperience__BlockTest

(None)

Yes

The value of this setting is an XPath that checks whether the given node is a block.

Must be XPath 1.0 compliant.

Example:

XQuery

self::p or self::td or self::title or self::li

Example with namespaces:

XQuery

*[(local-name()='p' or local-name()='td' or local-name()='title' or local-name()='li') and namespace-uri()='my:namespace:uri']

SchemaExperience__ObjectTest

(None)

Yes

The value of this setting is an XPath that checks whether the given node is an object.

Must be XPath 1.0 compliant.

Example:

XQuery

self::img or self::formula

Example with namespaces:

XQuery

*[(local-name()='img' or local-name()='formula') and namespace-uri()='my:namespace:uri']

DITA Example:

If you're based on the DITA schema, use the following 2 configuration settings.

BlockTest:

Other

SchemaExperience__BlockTest="self::alt or self::cmd or self::codeblock or self::consequence or self::ddhd or self::dt or self::dthd or self::equation-block or self::glossAbbreviation or self::glossAcronym or self::glossdef or self::glossShortForm or self::glossSynonym or self::glossterm or self::howtoavoid or self::lcAge or self::lcAssessment or self::lcAttitude or self::lcBackground or self::lcDelivery or self::lcEdLevel or self::lcGapItemDelta or self::lcGeneralDescription or self::lcGoals or self::lcInteractionLabel2 or self::lcJtaItem or self::lcKnowledge or self::lcLearnStrat or self::lcMotivation or self::lcNeeds or self::lcObjective or self::lcObjectivesStem or self::lcOrgConstraints or self::lcPlanObjective or self::lcPlanResources or self::lcProcesses or self::lcSkills or self::lcSpecChars or self::lcTaskItem or self::lcTime or self::lcValues or self::lcWorkEnvDescription or self::lines or self::linktext or self::navtitle or self::p or self::pre or self::proptype or self::propvalue or self::pt or self::screen or self::searchtitle or self::shortdesc or self::sli or self::title or self::typeofhazard"

ObjectTest:

Other

SchemaExperience__ObjectTest="self::img or self::hazardsymbol or self::mathml"

Annotation Export API

The Fonto Review backend offers an additional endpoint that can be called to retrieve a CSV export of the annotations in the given documents.

The Annotation Export API will only return annotations that are returned on the /review/state/ calls. This means that private annotations will not be exported by default.

The configuration needs to be done in a new exports.xml file in the root of your application. Further documentation of the configuration file can be found in the corresponding XSD file, which you can find here: http://schemas.fontoxml.com/review/1.0/exports.xsd

An example file is described below. It follows the datamodel as described in the Fonto Review Reference Configuration.

exports.xml

XML

<exports>
    <csvExport id="123">
        <textColumn select="id" header="ID" />
        <textColumn select="originalText" header="Original text" />
        <textColumn select="metadata.commentType" header="Comment type" />
        <textColumn select="metadata.comment" header="Comment" />
        <textColumn select="metadata.proposedChange" header="Proposed change" />
        <textColumn select="resolvedMetadata.resolution" header="Resolution" />
        <textColumn select="resolvedMetadata.resolution.resolvedComment" header="Resolution message" />
    </csvExport>
</exports>

Host configuration options

In addition to the generic host configuration options, the Fonto Review backend provides the following configuration options:

Option

Default

Required

Description

Cms:ApiBaseUrl

(None)

Yes

The absolute base URL of the CMS endpoint including a trailing slash. This endpoint must be accessible by the backend.

These options can be configured using any of the supported configuration providers. Information about configuration conventions might prove useful. When running the Fonto Review backend using the Fonto Development Tools, configuring the options as environment variables in an .env file is supported.

Command line parameters

The Fonto Review backend supports the following command line parameters:

Parameter

Default

Required

Description

--as-windows-service

(None)

No

Run the backend as Windows Service. Only available for self-contained builds on Windows.

Logging

Logging options can be provided using any of the . Please refer to the for available options. In addition, the Fonto Review backend supports an optional NLog configuration file. Information about how to configure NLog can be found in its official documentation.