Back to Search Back to Search Results

Configuring the Titania Web Editor Connector

This section provides steps for installing a new instance of the Titania Web Editor and 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.

Configuring the Windchill Server

  1. Locate the windchill folder within the distribution.

  2. Copy the contents of tasks folder to the existing Windchill installation tasks folder.

    Note: The wtSafeArea folder does not need to be copied at this time.

Templates

Note: This is section is not applicable for Titania Web Reviewer-only installations.

Attention: Never modify files in the default folder. . Instead, copy the file and folder tree into the custom folder.

Templates are used to create new XML documents within Web Editor. Templates can be located either in Windchill or on the Web Editor application server.

Storing Templates on the Web Editor application server

This method is best if users can specify the Windchill URL when connecting to Titania Web Editor. Using this method, all templates are stored in a common location for all Windchill instances.

  1. Locate the templates folder within the web application folder.

  2. Place each template in the templates with a .template file extension. Templates can be organized into subfolders.

Storing Templates in Windchill

This method is best if Titania Web Editor is configured to a single Windchill server using the WindchillServerURL option. Refer to Web Editor Configuration. If this option is not utilized, all Windchill instances accessed by Titania Web Editor must have the templates located within each Windchill instance at the same location. In this case, it may be better to locate the templates in a common folder on the Web Editor application server.

  1. Create a Web Editor templates folder within Windchill. The location must be read-only to all Web Editor users. Best practice is to create a folder in the same container as the Arbortext Editor burst rules.

  2. Set the to the CMSTemplatesFolder Titania Web Editor configuration option to the folder path. Refer to the CMSTemplatesFolder option in Web Editor Configuration.

  3. Use Arbortext Editor to load each template into the templates folder using File | Save As Object menu option. Templates can be organized into subfolders. Alternately to saving each template individually, templates can be bulk loaded using the Arbortext Editor command-line function save_as_windchill_template_source(). Please refer to the How to Bulk Load Templates section in the Appendix.

Windchill Configurations

Windchill object types and attributes corresponding to the XML are defined in windchillConnector.xml and must be configured to match your Windchill implementation. If this is a new installation, find the windchillConnector.xml-template and rename to windchillConnector.xml.

Attention: Never modify files in the default folder. . Instead, copy the file and folder tree into the custom folder.

Windchill Configuration

Element/Attribute Definition
WindchillServerURL

Optional. This is the URL of the Windchill instance. For example, https://<servername>:8080/windchill. If blank, users must supply the URL. The default is blank.
RootFolderPath

Not applicable for Titania Web Reviewer-only installations.

Optional. If set, users will be restricted to only access or create objects within this folder. If not specified, users can navigate the entire Windchill repository based on their permissions.

EnablePublicationStructureAuthoring

Not applicable for Titania Web Reviewer-only installations.

Optional. Enabling publication structure authoring will add a Publication Structures folder within the container enable authors to navigate all publication structures within the container. Publication Structure elements within normal folder browsing will also be visible. It will also enable authors to author an entire publication structure at a time. Valid values are "true" or "false". Default is “false” if value is not provided.
EnableInformationStructureAuthoring

Not applicable for Titania Web Reviewer-only installations.

Optional. Enabling information structure authoring will add a Information Structures folder within the container enable authors to navigate all publication structures within the container. Information Structure elements within normal folder browsing will also be visible. It will also enable authors to author an entire information structure at a time. Valid values are "true" or "false". Default is “false” if value is not provided.
PublicationStructureResourceSectionName

Optional: The name of the section located within a publication structure that contains resource files. Resource files include the keybase files required to resolve key references to a keydef. If defined, the section and files contained will not be visible when viewing publication structures.
ContentMetadataAttributes

Optional. List of Windchill attributes that will be sent to the Web Editor with the content. These could be used by the UI for display or additional functionality. These attributes will also be attached to Titania Web Reviewer annotations and stored in the Annotations database. No value will be included if the attribute does not exist on the Windchill soft-type. The format is internal attribute names separated by comma's. The default is number,name,iterationInfo.modifier.

If the number attribute is specified, it will be displayed in the document header within the application for easy reference.
AutoReviseStates

Optional. List of Windchill internal state names that, when checked out, the system will automatically revise the object. The transition from these states to starting state must be valid within the Windchill lifecycle.
DynamicDocumentObjectType

Required. Set to the full path of the dynamic document object type. For example: WCTYPE|wt.epm.EPMDocument|com.mycompany.DynamicDocument. The dynamic document object name must match the internal value as defined in the Type and Attribute Manager. Navigate to EPMDocument then Dynamic Document. Copy the internal name as the dynamic document object name.
ObjectTypeMapping

Not applicable for Titania Web Reviewer-only installations.

Required. This tag is a child of ObjectTypeMappings and is used to map markup to Windchill object types. The allowable attributes are:

  • rootTag — Specify * to match any element, otherwise, provide a specific root element name (i.e. Concept). This is only valid when the contentType is set to text

  • contentType — Set to either text or graphics.

  • wcObjType — Set to the Windchill Dynamic Document internal name or a Dynamic Document subtype.

If not set, all objects will be mapped to the object type defined by DynamicDocumentObjectType.
MetadataMapping

Not applicable for Titania Web Reviewer-only installations.

Required This tag is a child of MetadataMappings and is used to map XML attributes into Windchill object types. Additional metadata mappings can be specified by repeating the MetadataMapping tag. The allowable attributes are:

  • contentType — Set to either text or graphics

  • expr — A valid XPath expression which evaluates to the value that is saved into the Windchill attribute. The XPath expression must evaluate to a string.

  • wcMetadataName —A valid Windchill Dynamic Document object attribute name.

Editor Configurations

Editor Configurations are defined in editorConfig.xml. If this is a new installation, find the editorConfig.xml-template and rename to editorConfig.xml.

Attention: Never modify files in the default folder. . Instead, copy the file and folder tree into the custom folder.

Web Editor Configuration

Element/Attributes Description
SpellCheckerServerURL

Required. The URL of the Titania Spell Checker service as configured in IIS,

Note: For Titania Web Reviewer-only installations, set the URL to https:\\<servername> as a placeholder.
LMServerURL

Required. The URL of the Titania License Manager service.
CMSTemplatesFolder

Not applicable for Titania Web Reviewer-only installations.

Optional. The full path into the CMS where the templates are stored. All Web Editor users must have permissions to read and download objects from this folder. The folder path must be the same as displayed in the Web Editor browser. If the CMSTemplatesFolder path is not set, the local templates will be used.
ListDefinitions/ListDefinition

Not applicable for Titania Web Reviewer-only installations.

Optional. This defines the list of valid values that can be assigned to XML attributes. Value lists can be either stored on the Web Application server or acquired from Windchill Global Enumerations. The ListDefinition maps the list name used in the attributes configuration with the actual list located on the server or within Windchill. If not specified, the system will assume a local JSON file that is named the same as the list name.

The name attribute maps to that list name used in the Attributes configuration. Refer to Attributes configuration for additional information.

When located on the Web Application server, lists are located in the Web Application lists folder. The connectorId attribute value must be set to “localfiles”. The listName attribute is set to the actual file located in the lists folder.

When located in a Windchill Enumerated list, the connectorId attribute value must be set to “windchill”. The listName attribute is set to the global enumeration internal name (i.e. com.ptc.source_languages).

Parent topic: Installing Titania Web Editor