Titania Web Editor Installation Guide v2024.1

The Titania License Manager service must be installed and licensed. Refer to the Titania License Manager Installation Guide for instructions. Additionally, a license will need to be obtained from the vendor. The vendor will need the Device Name of the Titania License Manager installation server.

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).

Installing the Open in Titania Web Editor and Open in Titania Web Reviewer features are optional. To install them, follow the procedure below.

1. Extract the wtSafeAreas file into the <Windchill>/wtSafeArea folder on the Windchill server. There are two folders inside of this folder that should align with the folder structure you see inside the wtSafeArea.

2. Navigate to wtSafeArea/siteMode/codebase/titania.properties and update the URLs corresponding to your implementation ensuring that ?docNbr= remains at the end of the URL.

3. Open a Windchill Shell as Administrator and run the following command to deploy the files.

   ant -f bin/swmaint.xml installSiteChanges

4. Restart Windchill and verify the new Open in Titania Web Editor and/or Open in Titania Web Reviewer menu items are visible in the Actions ⇒ Open In... for Dynamic Documents, Information Structures and Publication Structures.

   Note: Only the menu items corresponding to your implementation will be displayed.

Installation of the Share menu is optional. To install, follow the procedure below.

1. Locate the Arbortext Editor Application distributable and copy the com.titania.web folder to a new application that is accessible by Arbortext Editor users.

   If an Arbortext Editor application is already being used, then copy com.titania.web into the existing application folder.

   Note: Do not install the application into the Arbortext Editor Program Files folder. Instead, create a new folder either on the local drive or a common file share.

2. If not already set on the local users PC, modify the APTAPPLICATION environment variable with the application path from Step 1.

   Note: If the APTAPPLICATION environment variable does not already exist, follow the steps below to create it:

   1. On the local users PC, navigate to the Environment Variables.

   2. Select New to add a new environment variable.

   3. In the Variable name: field, type APTAPPLICATION

   4. In the Variable value: field, type the folder path that points directly to the location of the application folder.

      Note: Be sure ;%D is added to the path.

   5. Click OK to apply the changes.

3. Locate the configuration file config.xml file in the com.titania.web/config folder

   . Update the webeditorbaseurl and webreviewbaseurl to point to the Titania Web Editor and/or Titania Web Reviewer application servers.
   Note: The webeditorbaseurl is only required if Titania Web Editor is installed. The webreviewbaseurl is only required if Titania Web Reviewer is installed.

4. Start Arbortext Editor and open an XML document from Windchill.

5. Verify the new Share file menu is visible with the submenus visible corresponding to your installation.

Attributes are displayed in the Attributes slide-out panel. All attributes are configured in the attributes.json file located in the uiconfigs folder. This is best illustrated with an example:

{
    "self::div": {
        "class": {
            "localName": "class",
            "label":
            "Class",
            "display": "input",
            "properties": {
                "type": "text"
            }
        }
    }
}

The first level in the json should be an XPath Test  to select an element. The second level is the name of the attribute which is being configured.

The following properties need to be configured for each attribute:

• localName: The name of the attribute as defined in the schema.

• namespaceURI: The namespace uri of this attribute. This may be omitted for attributes in the null namespace.

• label: The label which will be displayed for the attribute.

• display: The type of input which will be provided for input.

• properties: The properties of the input.

The different display options are:

• readonly: When an attribute should not be edited, but should be shown in the attributes editor, it can be configured to display as readonly:

  {
  	"self::div": {
  		"id": {
  			"localName": "id",
  			"label": "Identifier",
  			"display": "readonly"
  		}
  	}
  }

• input with properties.type is:

  • text: A normal text input, the value should be a string.

  • number: A numeric stepper input, the value should be a number. Extra properties that can be used are numberOfDecimals(default is 2) and step(default is 1)

  {
  	"self::age": {
  		"mean": {
  			"localName": "mean",
  			"label": "Mean",
  			"display": "input",
  			"properties": {
  				"type": "number",
  				"numberOfDecimals": 0
  			}
  		}
  	}
  }

• select: A single select with drop down menu. Use when the attribute should have a value out of a clearly defined list. The possible values should be provided with properties.options. This should be an array of items, with a label and value. This should be a string.

  {
  	"self::div": {
  		"class": {
  			"localName": "class",
  			"label": "Class",
  			"display": "select",
  			"properties": {
  				"options": [
  					{
  						"label": "Aligned left",
  						"value": "left"
  					},
  					{
  						"label": "Aligned center",
  						"value": "center"
  					},
  					{
  						"label": "Aligned right",
  						"value": "right"
  					}
  				]
  			}
  		}
  	}
  }

  Alternatively, properties.options can be set to a list name. This list name corresponds to the ListDefinition defined in the Editor Configurations. In this example, the attributes value list will come from the languages list.

  {
  	"xml:lang": {
  		"localName": "xml:lang",
  		"label": "Language",
  		"display": "select",
  		"properties": {
  			"options": "languages"
  		}
  	}
  }

• autocomplete: A single autocomple with drop down menu. Use when the attribute should have a value out of a clearly defined (and long) list. The possible values should be provided with properties.options. This should be an array of items, with a label and value. This should be a string. properties.options can also be a list name similar to select.

  {
  	"self::div": {
  		"color": {
  			"localName": "color",
  			"label": "Color",
  			"display": "autocomplete",
  			"properties": {
  				"options": [
  					{
  						"label": "Blue",
  						"value": "blue"
  					},
  					{
  						"label": "Red",
  						"value": "red"
  					},
  					⋮
  					{
  						"label": "Yellow",
  						"value": "yellow"
  					},
  					{
  						"label": "Violet",
  						"value": "violet"
  					}
  				]
  			}
  		}
  	}
  }

• button-with-value-from-modal: A button that opens a custom modal which should provide a value (this should be a string) that is displayed after the button. The modalComponentName and buttonLabel should at least be added to the properties. The properties buttonLabel, icon and iconAfter are optional.

  {
  	"self::div": {
  		"date": {
  			"localName": "date",
  			"label": "Date",
  			"display": "button-with-value-from-modal",
  			"properties": {
  				"modalComponentName": "CustomDateSelectModal",
  				"icon": "calendar"
  			}
  		}
  	}
  }

Browser configurations control the behavior of the Titania Web Editor browser. Browser configurations are configured in the browser.json file located in the uiconfigs folder. This is best illustrated with an example:

{
	"navigation": {
		"maxObjectsReturned": 25
	},
	"newDocument": {
		"documentTitleLength": 64
	}
}

navigation settings control overall browser navigation.

• maxObjectsReturned. When browsing with a folder with a large number of objects, this setting controls the number of objects returned in a single page. The browser will present a Next and Prev button to allow navigation to the next set of objects. NOTE: This must be set to 25.

newDocument settings control aspects of creating a new document.

• documentTitleLength. Maximum number of characters allows for a title. This is typically limited by the CCMS.

Lists configurations are individual json files that define attribute valid values used by the Attributes slide-out panel. All list configuration files are stored in the lists folder. This is best illustrated with the languages.json as an example:

[
	{
		"value": "en",
		"label": "English"
	},
	{
		"value": "es",
		"label": "Spanish"
	},
	{
		"value": "fr",
		"label": "French"
	}
]

The list consists of repeating name and value pairs for each list item.

• value. Value stored in the XML attribute.

• name. Text displayed to the user.

Outline Badge configurations defines the statuses that appear in the Outline panel. This configuration applies to both Web Editor and Web Reviewer. The configuration file is called outlineNodeStatuses.json is located in the uiconfigs folder.

{
	"nodeStatuses": [
		{
			"internalName": "INWORK",
			"label": "In Work",
			"icon": "file-lines",			
			"condensedLabel": "IW",
			"backgroundColor": "state-message-icon-info-color",
			"clickOperation": "scroll-node-into-view",
			"tooltipContent": "This document is in work."
		},
		{
			"internalName": "RELEASED",
			"label": "Released",
			"icon": "file-check",			
			"condensedLabel": "R",
			"backgroundColor": "state-message-icon-success-color",
			"clickOperation": "scroll-node-into-view",
			"tooltipContent": "This document is released."
		},
		{
			"internalName": "revised",
			"label": "Revised",
			"icon": "rectangle-history",			
			"condensedLabel": "RV",
			"backgroundColor": "state-message-icon-muted-color",
			"clickOperation": "scroll-node-into-view",
			"tooltipContent": "This document has been revised."
		},	
		{
			"internalName": "new",
			"label": "New",
			"icon": "file",			
			"condensedLabel": "N",
			"backgroundColor": "state-message-icon-muted-color",
			"clickOperation": "scroll-node-into-view",
			"tooltipContent": "This document is new."
		},	
		{
			"internalName": "reused",
			"label": "Reused",
			"icon": "arrows-to-circle",			
			"condensedLabel": "RE",
			"backgroundColor": "state-message-icon-muted-color",
			"clickOperation": "scroll-node-into-view",
			"tooltipContent": "This document has been reused."
		}
	]
}

• “internalName” should match the lifecycle state as it appears in the content management system (internal name, not display name). ”. The “new”, “revised”, and “reused” nodeStatuses must remain. The lifecycle specific nodeStatuses can be changed. The “new” status indicates that the object has yet to be released. The “revised” status indicates that a previously released object has been revised for updates. The “reused” status indicates that the object is reused in multiple publications.

• “label” is the English description of the lifecycle state.

• “icon” is the name of an applicable FontAwesome icon (https://fontawesome.com/icons).

• “condensedLabel” is 1 character that displays if there is no “icon” defined. The “icon” should be omitted to use this or the “condensedLabel” should appear before the “icon” to utilize it.

• “backgroundColor” is defined with one of the following, which designates the color of the icon and the popup text:

  • state-message-icon-error-color (red)

  • state-message-icon-info-color (blue)

  • state-message-icon-muted-color (dark grey)

  • state-message-icon-success-color (green)

  • state-message-icon-warning-color (orange)

• The “clickOperation” should remain as is.

• The “tooltipContent” is the descriptive text for the item when the user hovers over it.