Configuring Titania Web Reviewer Connector
This installation guide provides steps for installing a new instance of Titania Web Reviewer.
Configuration File Layout
All configurations
are located within the wwwroot
folder either
in the custom
or default
folder. The default
folder contains all out
of the box configuration and templates. The files in the default
folder should NEVER be modified. Rather they
should be copied into the custom
folder. Make
sure to copy the folder structure in addition to the configuration
file into the custom
folder. The system will
first look in the custom
folder then the default
folder. Future releases will only ever includes
updated files in the default
folder. The custom
folder will never be released.
Web Application Environment Configuration
The Web Application environment configurations are made using the Titania Position Recovery Service web site application Configuration Editor feature. Each of the below environment variables must be set.
default
folder. . Instead, copy the file and folder
tree into the custom
folder.Section | Argument | Name | Comment |
---|---|---|---|
system.webServer.aspnetCore |
environmentVariables |
CMS__APIBASEURL |
Set to the Web Editor API in the form https://<server>:<port>/api/editor/ replacing server and port with what was configured for the Titania Web Editor
Note: Make sure to
end the URL with a forward slash.
|
SchemaExperience__BlockTest |
Set to the value specified below by*. | ||
SchemaExperience__ObjectTest |
Set to the value specified below by **. |
*
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 or self::indexterm
**
self::img or self::hazardsymbol or self::mathml
Configuring the Annotations Database
The following file(s) need to be updated specific to the distribution.
-
Locate the database schema in the
schema
folder in the distribution corresponding to the previously installed database. -
Install the schema within the database using one of the following recommended database management tools corresponding to the installed database. Each of these can be downloaded from the vendors website.
-
Oracle SQL Developer
-
Microsoft Sql Server Management Studio
-
-
It is recommended that a dedicated user be configured specifically for Titania Web Reviewer.
Reviewer Configurations
Reviewer Configuration
Reviewer Configurations are defined in reviewConnector.xml
. If this is a new installation, find the reviewConnector.xml-template
and rename to reviewConnector.xml
.
default
folder. . Instead, copy the file and folder tree into the custom
folder.Reviewer Configuration
Element/Attributes | Description |
ReviewAppServerURL
|
Required. The URL of the Titania Position Recovery Service as configured in IIS. For example: https://<servername>:8083 |
Database
|
Required. |
DatabaseConnectionString
|
Required. Annotations database connection string excluding username and password. |
DatabaseConnectionUsername
|
Required. Annotations database connection string
username. The |
DatabaseConnectionPassword
|
Required. Annotations Database connection string
password. The |