Vasont Administrator Guide

Version 2016.1

CONFIDENTIAL ------© 2016 TransPerfect Translations International Inc. All rights reserved. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, recording, or any information storage and retrieval system without permission in writing from the publisher.

Vasont Systems A TransPerfect Company 315 Busser Road Emigsville, PA 17318 717-764-9720 www.vasont.com

Document Number: VAG-2016.1 TRADEMARKS Trademarked names appear throughout this book. Rather than list the names and entities that own the trademarks or insert a trademark symbol with each mention of the trademarked name, the author states that it is using the names only for editorial purposes and to the benefit of the trademark owner with no intention of infringing upon that trademark. Vasont Administrator Guide

Table of Contents

About Vasont Administrator ...... 1 Vasont Documentation ...... 5 Configuration Alterations ...... 5 Content Navigator Window ...... 5 User Navigator ...... 8 Creating the Basic Structure ...... 11 Creating a New Content Type ...... 11 Creating New Raw Components ...... 12 Creating New Aliases ...... 16 Creating New Wrappers ...... 23 Creating New Attributes ...... 24 Creating a New Collection ...... 26 Duplicating a Collection ...... 27 Importing an Entire Collection ...... 28 Using the Read DTD Utility ...... 31 Using the Read Schema Utility ...... 38 Processing Options ...... 41 Filtering Processing Options ...... 41 Processing Option Properties ...... 42 Finding the Right Processing Option ...... 43 Locating Usage of a Processing Option ...... 44 Building Collection Views ...... 45 Edit Views ...... 45 Creating an Edit View from Scratch ...... 45 Cloning an Edit View from Another Collection ...... 46 Adding an Edit View Component ...... 47 Updating an Edit View Component ...... 47 Locating an Edit View Component ...... 62 Expanding Edit View Components ...... 63 Resequencing Edit View Components ...... 63 Using a Detailed Edit View ...... 64 Deleting an Edit View Component ...... 65 Load and Extract Views ...... 65 Adding a New Load or Extract View ...... 65 Creating a Load or Extract View from Scratch ...... 70 Creating a Load or Extract View by Cloning ...... 72 Creating a Load or Extract View with Drag and Drop ...... 74 Creating a Load View Using the Read DTD Utility ...... 74 Updating a Load or Extract View ...... 74 Deleting a Load or Extract View ...... 74 Adding a Load or Extract View Component ...... 75 Updating a Load or Extract View Component ...... 76 Deleting a Load or Extract View Component ...... 81 Locating a Load or Extract View Component ...... 82 Expanding a Load or Extract View Component ...... 82 Detailed Load or Extract View ...... 83 Importing a Load or Extract View ...... 84 Exporting a Load or Extract View ...... 85 Refining the Basic Structure ...... 87 Attributes ...... 87 Updating an Attribute ...... 87

Updating an Alias Attribute ...... 88 Deleting an Attribute ...... 89 Deleting an Alias Attribute ...... 91 Raw Components ...... 93 Updating a Raw Component ...... 93 Deleting a Raw Component ...... 96 Aliases ...... 99 Updating or Deleting Alias Valid Values ...... 99 Wrappers ...... 100 Updating a Wrapper ...... 100 Deleting a Wrapper ...... 101 Content Types ...... 102 Updating a Content Type Name ...... 103 Deleting a Content Type ...... 103 Collection Groups ...... 103 Updating a Collection Group ...... 103 Deleting a Collection Group ...... 104 Collections ...... 104 Finding Collections ...... 104 Updating Collection Settings ...... 105 Deleting a Collection ...... 105 Defining Refine Collections ...... 106 Updating and Deleting Components ...... 107 Merging Components from One View to Another View ...... 107 Using the Edit View Merge Utility ...... 108 Using the Extract or Load View Merge Utility ...... 110 Copying Components from One View to Another View ...... 112 Performing a Batch Copy of an Edit View Component ...... 113 Performing a Batch Copy of an Extract or Load View Component ...... 113 Broadcasting Component Processing Options ...... 114 Purging Stranded Components ...... 117 Deleting Unused Setup Data ...... 118 Deleting Vasont Data ...... 118 Deleting Collection Data ...... 118 Purging Raw Material ...... 119 Building Raw Material In Collection Flag ...... 119 Merging Duplicate Raw Components ...... 119 Deleting Versions ...... 120 Deleting Project Data ...... 121 Batch Updating Components in a View ...... 121 Batch Updating Attributes ...... 122 Batch Updating Processing Options ...... 123 Batch Updating Actions ...... 124 Batch Updating Pointer Definitions ...... 124 Batch Updating Occurrences ...... 125 Batch Updating Advanced Settings ...... 126 Batch Updating Miscellaneous Settings ...... 127 Batch Updating General Settings ...... 128 Batch Updating from Where Used Feature ...... 128 Batch Updating Attributes from Where Used ...... 129 Batch Updating Processing Options from Where Used ...... 130 Batch Updating Raw Components from Where Used ...... 131 Batch Updating Wrappers from Where Used ...... 132 Batch Deleting from Where Used Feature ...... 134

Batch Deleting Attributes from Where Used ...... 134 Batch Deleting Attributes on a Raw Component ...... 135 Batch Deleting Occurrences on a Raw Component ...... 135 Batch Deleting Processing Options from Where Used ...... 135 Batch Deleting Pointer Definition Records ...... 136 Batch Deleting Components ...... 136 Creating and Maintaining Users or Roles ...... 139 Collections Tab ...... 139 Privileges Tab ...... 141 Roles Tab ...... 143 Advanced Tab ...... 144 Components Tab ...... 146 Workgroups Tab ...... 148 Ownership Groups Tab ...... 148 Admin Rights Tab ...... 149 Creating New Users ...... 153 Reviewer Seats ...... 154 Updating Users ...... 154 Deleting Users ...... 155 Creating New Roles ...... 155 Updating Roles ...... 156 Deleting Roles ...... 156 Creating New Workgroups ...... 156 Updating Workgroups ...... 156 Deleting Workgroups ...... 157 Creating New Ownership Groups ...... 157 Updating Ownership Groups ...... 157 Deleting Ownership Groups ...... 158 Languages ...... 158 Electronic Mail ...... 158 User Navigator Reports ...... 159 Creating Vasont Previews ...... 161 Preview Map File ...... 162 Custom Processors ...... 165 Creating Map Files ...... 165 Loading the Map File ...... 166 Editing the Map File ...... 167 Deleting the Map File ...... 168 Cascading Style Sheet for Preview ...... 168 Loading the Cascading Style Sheet ...... 169 Editing the Cascading Style Sheet ...... 170 Deleting the Cascading Style Sheet ...... 171 Creating a Style ...... 172 Editing Styles ...... 173 Deleting Styles ...... 173 Checking Style Usage ...... 174 Creating Extract Views for Preview ...... 175 Assigning a Style for the Collection ...... 178 Updating a Style Assignment ...... 179 Deleting a Style Assignment ...... 180 Troubleshooting the Preview Display ...... 180 Vasont Preview Daemon ...... 181 Preview Samples ...... 182 Preview for Displaying Stored Translation Content ...... 182

Preview for Displaying Modular Reuse and Branches ...... 183 Preview for Displaying Component Reuse ...... 186 Preview for Displaying Conditional Content ...... 187 Generating a Preview Color Key ...... 188 Generating Note Labels ...... 191 Generating and Using Reports ...... 195 Saving Reports ...... 195 Raw Component Reports ...... 196 Basic ...... 197 Detail ...... 197 Alias Attribute Reports ...... 197 Edit View Reports ...... 198 Basic ...... 199 Detail ...... 200 Genealogy ...... 200 Attributes ...... 201 Global Change ...... 201 Dynamic Indexes ...... 202 Pointers ...... 202 Undefined Pointers ...... 202 Processing Options ...... 203 Security ...... 203 Extract/Load View Reports ...... 204 Basic ...... 205 Attributes ...... 205 Processing Options ...... 205 Translations ...... 207 DTD ...... 208 Component Validation ...... 208 Workflow Reports ...... 208 Project Flow ...... 209 Project Users ...... 210 Project WorkGroups ...... 210 Project Processing ...... 211 Project Attributes ...... 211 Project Task Descriptions ...... 211 User Navigator Reports ...... 212 Users ...... 212 Roles ...... 213 Workgroups ...... 213 Ownership Groups ...... 214 User Information ...... 214 User Login Activity ...... 214 Vasont License Report ...... 216 Comparison Reports ...... 216 Compare Components ...... 217 Compare Processing Options ...... 218 Compare Attributes ...... 219 Client Key Exception ...... 220 Content Navigator Reports ...... 220 Multimedia Metadata ...... 223 Setup for Searching on Multimedia Metadata in Vasont ...... 224 Support Tables ...... 227 Editor Tags ...... 227

Adding an Editor Tag ...... 227 Deleting an Editor Tag ...... 227 Updating an Editor Tag ...... 228 Checking Usage of an Editor Tag ...... 228 Helpers ...... 228 Adding an Extension ...... 228 Deleting an Extension ...... 229 Version Method ...... 229 Sites ...... 230 Translations ...... 230 Adding a New Translation ...... 230 Updating a Translation ...... 230 Deleting a Translation ...... 231 Checking Usage of a Translation ...... 231 System Profiles ...... 231 Languages ...... 235 Adding a Language ...... 235 Deleting a Language ...... 235 Updating a Language ...... 235 Notification Events ...... 235 Activating or Disabling a Notification Event ...... 238 Attribute Sets ...... 238 Creating and Updating Workflow ...... 241 Workflow Projects ...... 241 Requirements for Initiating a Workflow Project in Vasont ...... 241 Adding a New Workflow Project ...... 241 Building a Graphic Workflow ...... 243 Reusing a Workflow Definition ...... 244 Updating a Workflow Project ...... 246 Duplicating a Workflow Project ...... 246 Deleting a Workflow Project ...... 246 Importing a Workflow Project ...... 247 Exporting a Workflow Project ...... 247 Deleting Workflow Project Data ...... 248 Adding a New Task ...... 248 Updating a Workflow Task ...... 250 Deleting a Workflow Task ...... 251 Workflow Projects Reports ...... 251 Collaborative Review ...... 253 Collaborative Review System Profile ...... 254 User Accounts for Review Participants ...... 254 Collaborative Review Collection Configuration ...... 255 Collaborative Review Extract View ...... 255 Collaborative Review Load View ...... 256 Collaborative Review Edit View ...... 257 Collaborative Review Collection Privileges ...... 258 Collaborative Review Reference Documents ...... 258 Collaborative Review Workflow ...... 259 Building a Translation Setup ...... 265 Creating Translation Collections and Views ...... 265 Automated Translation Extract and Load Programs ...... 270 Image Collections ...... 271 Component Level Translation ...... 271 Translation Previews ...... 271

Creating Translation Vendor Languages ...... 272 Translation Languages ...... 272 Translation Memory ...... 273 Translation Vendors ...... 274 Translation Vendor Languages ...... 275 Customizing Vasont Navigator ...... 277 Customizing the Logo on the Vasont Home Page ...... 277 Setup Options ...... 279 Creating a Collection for Storing Unstructured Documents ...... 279 Creating a Modularized Content Model for Reuse ...... 281 Creating a Section Collection ...... 281 Adding Section Pointers to the Manuals Collection ...... 283 Running the Collection Modularization Utility ...... 287 Post Modularization Alterations ...... 288 Other Configuration Options ...... 288 Controlled Vocabulary ...... 289 About Vocabularies ...... 289 Vocabulary Validation Techniques ...... 291 Oracle Text Stopwords ...... 291 Implementing Controlled Vocabulary ...... 292 Dynamic Index ...... 293 Creating a Dynamic Index ...... 294 Deleting a Dynamic Index ...... 296 Fast Extract of Modular Content ...... 296 Configuring Fast Extract ...... 297 Electronic Signatures ...... 300 Extracting Checked Out Modular Content as Read-Only ...... 300 Configuring Read-Only Modules ...... 300 Loading Changed Modular Content ...... 303 Configuring Change Monitoring of Modules ...... 304 Auto-Publishing ...... 306 Configuring the Project Organizer Collection for Auto-Publishing ...... 307 Configuring the Auto-Publishing Output Templates Collection ...... 309 Configuring the Auto-Publishing Publications Collection ...... 310 Configuring Auto-Publishing Extract Views ...... 311 Configuring Auto-Publishing Workflow ...... 312 Assigning Privileges for Auto-Publishing ...... 312 Auto-Publishing Extract and Load Programs ...... 313 Advanced System Utilities ...... 315 Understanding the System Level Menu Items ...... 315 Arguments ...... 315 Processing Options ...... 315 Data Types ...... 316 General Access Types ...... 316 Globals ...... 316 Occurrences ...... 316 Collection Access Types ...... 316 Raw Classes ...... 316 SGML Types ...... 316 XSLT ...... 316 Processing Options SQL Generation ...... 316 LDAP Authentication ...... 317 Configuring Vasont E-mail ...... 319 Technical Requirements for the Vasont CMS ...... 321

Requirements ...... 321 Hardware Recommendation ...... 321 Options ...... 321 Glossary ...... 323 Index ...... 329

The Vasont® CMS and the Vasont® Administrator form a content management system (CMS) providing typical content management features such as user and role permissions, and advanced capabilities including XML component level support, DITA component level support, content reuse, content processing, collaborative review, and management of unstructured content, digital assets, and translated content. The Vasont Administrator is divided into two sections, the Content Navigator and the User Navigator. The Content Navigator defines the rules for your data and the User Navigator defines the data security and privileges for users.

Your data's Content Model and corresponding rules of structure are set up in Vasont Administrator's Content Navi- gator. If using XML or SGML content, these rules correspond to the structure rules defined in your Document Type Definition (DTD) or schema. There are four key metadata definitions within a content type: raw components , aliases , attributes , and wrappers .

Through the creation in Vasont Administrator of content types , collection groups , and collections , you define how your content will be organized in Vasont. Think of Vasont's storage organization as a file cabinet. The Content Type is the file cabinet, a Collection Group is a file drawer, the Collections are folders in the drawer, and the Components are the documents in the folder. One of

VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 1 About Vasont Administrator the drawers would be a default drawer for all the collections that are in the content type but not in a collection group, since the collection group is optional.

To further explain each of these pieces:

1. Content Types are the highest level of metadata organization in Vasont and often serve as major divisions in content definition. Different content types typically store content definitions with very different content models. An example is a content type for the Engineering Group's data and another Content Type for the Documenta- tion Group's data.

2. Collection Groups are optional. They are used to organize collections into meaningful divisions. Example of collection groups are Publications and Images. A Publication collection group may contain collections for user manuals, service manuals, technical manuals. An Image collection group may contain collections for graphics, inline graphics, and company logos.

3. Collections are groupings of related content that follows the same structure. Content is defined in a collection by the Edit View which organizes components into a hierarchical structure.

4. Components are chunks of content defined in the rules of structure for each collection. Components usually correspond to elements in a DTD, but that is not required. Each component has a property called component

type which can be valued as text, multimedia or pointer. Examples of components are paragraph, title, figure, table, and section.

The previous illustrations show a content type for the Publications content. Your system may also support content types for other departments within your organization. For example, the Engineering department may store specifications and illustrations for the products they are developing. When the product is ready for user documentation, the Engineering information can be shared with the Publishing department. The Marketing department may also be tied in to the information sharing with collections and processing as well.

There are three component classes:

• Text components typically represent an element in your DTD but they can also contain any text, including metadata.

• Multimedia components may contain different types of files, such as graphic files, Word documents, PDF files, or sound and movie files. They may be stored within Vasont or pointed to by supplying a file path to a network location.

• Pointer components reference another component that may be stored in the same collection or a different collection within the same content type or even another content type. For example, a pointer component can reference a multimedia component.

There are three types of collection views:

1. Edit View is the configuration that defines how content is created, displayed, processed, and manipulated in the Vasont Navigator. There can be only one edit view for each collection. 2. Load View is the configuration used when files are imported into the database. There can be multiple load views for each collection. This means files with different tagging schemes may be loaded into the same collection, as long as a load view exists for each scheme. Load views are important when using XML or SGML data. 3. Extract View is the configuration used when files (typically XML files) are exported from the database. There can be multiple extract views for each collection. This means files may be extracted from the collection with different tagging schemes, as long as an extract view exists for each scheme. The following diagram shows two collections in the Publications content type.

Notice that collections define content instances but the actual content is stored once in raw material which provides implicit content reuse. A pointer component provides explicit reuse of a graphic instance. Projects define workflow for a collection. Workflow projects allow you to assign tasks and track their progress. A collection of workflow tasks is called a Project, and multiple projects can be defined for a collection. Vasont then provides project management capability to track the overall status of multiple ongoing or completed workflow projects.

Vasont Documentation

The Vasont CMS and associated documentation consists of:

• Vasont and the Vasont User Guide, for content editing and reuse, workflow management, and other content management features.

• The Vasont Administrator Guide offers step by step instructions for system setup and administration. It assumes an understanding of structured documents, XML and/or SGML and the basics of content management.

• Vasont Universal Integrator (VUI) for Arbortext Editor, Adobe FrameMaker, XMetaL, or OXygen. The VUI allows authors to work in a familiar environment within their editorial application, and provides a frequently used subset of functionality available in Vasont to simplify the editing process.

• Vasont Application Programming Interface (API) for advanced customization and integration. The Vasont API allows for development of new processing options, daemons, and other API programming to enhance and extend the base Vasont functionality and integrate with other applications, systems and processes.

• Vasont Processing Options are used to customize the way Vasont works. For example, they allow for moving, copying, inserting or editing of content when the content is being extracted, loaded or edited in Vasont.

• The Vasont New Features List outlines the features that have been added or altered for a specific release of the Vasont software.

The software offers compiled Help files and context sensitive help. PDFs of the documentation can be obtained from the Vasont Users' Zone at www.vasont.com.

Configuration Alterations

Your Vasont system is set up based on business rules and information provided by you and then configured by a Vasont analyst. This results in a customized configuration specific to your business needs. If you need to alter your configuration you should first consult with your Vasont support leader to confirm that your alterations will not have an undesirable result. Any issues that result from configuration changes that were not discussed and confirmed with the support leader are not covered under your Vasont application support agreement and assistance to repair any damage may be billable.

Content Navigator Window

What you see when you open Vasont Administrator is determined by the permissions that you have been assigned. If you have been granted access to the Content Navigator, the Content Navigator and the icon for Collections are automatically displayed.

To access the Content Navigator, if not already displayed, click the Content Nav button on the main toolbar.

The right window contains the full list of collections that the user has the right to access. This list can be sorted on the columns, including Collection, Content Type, Collection Group and Collection Name.

You can right-click on a Collection in the list and select the Go To menu option.

The collection, along with the views, is automatically displayed in a tree view in the left window.

The right window now shows just the information for the selected collection.

You can also select a Content Type or Collection Group in the left window and obtain the corresponding list of collections that are in the content type or Collection Group.

This list of collections can be sorted and the Go To option is available.

Clicking on Projects within a collection, in the left window, displays a list of the projects associated with the collection. It also shows any other collections where the workflow projects are being used and the components that the workflow is associated with. Projects contain detailed information about workflow setups.

Clicking on Processing Options displays a list in the right window of all the processing options that are available for use in the Vasont Administrator. You can sort the columns on Option Name, Event, Vasont Administrator Up- date Window, Element, Repeat Flag, or ID. For more information, see the Processing Options chapter.

Clicking on Projects displays a list in the right window of all of the workflow projects that have been defined across all content types and collections. The list contains projects that are owned by collections the user has the right to access. You can sort the columns on Project, Project ID, Collection Name, or Component Name. For more information on projects, see the Creating and Updating Workflow chapter.

Clicking on Styles displays a list in the right window of all of the styles that have been defined for Vasont preview (across all content types and collections). You can sort the columns on Style Name, Cascading Style Sheet, Conver- sion Map, or ID. For more information, see the Creating Vasont Previews chapter.

Clicking on Translation Vendor Languages displays a list in the right window for the translation vendors and their language abbreviations. This information is utilized by the Vasont Translation Package for communicating with translations vendors. For more information, see Building a Translation Setup.

Clicking on Metadata Types displays a list in the right window of each type and the total number of metadata types. Metadata Types define automatic metadata that Vasont captures for various multimedia file types such as graphics or Word documents. You can sort the columns on Name, Metadata Type ID, or User Defined. For more information, see Multimedia Metadata.

User Navigator

In order to assign and maintain rights and privileges, you need to access the User Navigator. This window controls all rights and privileges for users in Vasont and Vasont Administrator. Users are the sign-on names of individuals who can access Vasont and/or Vasont Administrator.

There are two types of users who have access to Vasont Administrator — Super Administrators and Associate Ad- ministrators. In Vasont Administrator, Super Administrators have full rights and Associate Administrators have limited rights.

There is always at least one Super Administrator; the Oracle schema owner is automatically assigned as the initial Super Administrator. The Super Administrator does not need any explicit permission. It will be determined that the user is the Oracle schema owner at the time of login and super administrator capabilities will be provided automatically.

• To access the User Navigator, click the User Nav button on the main toolbar.

If the User Nav button is grayed out, you do not have permission to access the User Navigator win- 2 dow.

• The left windowpane displays all Administrators, Users, Roles, Workgroups, and Ownership Groups. The right windowpane displays data about the selected administrator, user, role, workgroup, or ownership group.

• Click the plus sign (+) on Administrators, Users, Roles, Workgroups, or Ownership Groups to display all data. Roles are defined packages of permissions that can be assigned to one or more users. A role is a quick way to assign a group of privileges to users without having to specify details each and every time. A Workgroup is a group of users. After creation of a workgroup, workflow tasks can be assigned to it rather than to individual users. See Adding a New Task (Workgroups Tab). When a specific role or user is selected in the left windowpane, the right windowpane is activated relative to that selection. Each tab in the right pane can then be updated to reflect the exact permissions assigned to that user or role. One exception to this rule is that when a role is selected, the Admin Rights tab cannot be updated. When a specific workgroup is selected in the left windowpane, the only tab that is enabled is the Workgroups tab. The following tabs are available in the right windowpane: • Collections Tab • Privileges Tab • Roles Tab • Advanced Tab • Components Tab • Workgroups Tab • Ownership Groups Tab • Admin Rights Tab

This chapter provides information on how to create the basic pieces in the Vasont Administrator application. You will gain an understanding of the steps involved in creating new Content Types and Collections.

Creating a New Content Type

A content type is a set of building blocks (raw components, aliases, attributes and wrappers) and a group of related collections. Collections in the same content type sometimes share the same basic structure and components, although this is not a requirement. They can also share components and reference each other's components. Raw components in one collection can be used to build another collection in the same content type. It is possible to share raw components, aliases, attributes, and wrappers across content types. If global change capability is needed, the collections containing the shared components should be built under the same content type.

The Content Navigator window in Vasont Administrator is used to navigate, view, create and update collections for Vasont. 1. To access the Content Navigator, click the Content Nav button on the main toolbar. 2. If this is the first content type you are creating, click in the left window; otherwise, click an existing content type. 3. Right-click and select New → Content Type.

4. Enter a Name for the content type in the New Content Type window and then click the Save button.

5. Click Close on the main toolbar to exit the Content Navigator window. Now that a content type exists, its building blocks (raw components, aliases, attributes, and wrappers) need to be created. Within a content type, these building blocks are used to create collection views. Creating New Raw Components Raw components are basic units: building blocks assembled in different views to describe and constitute a collection. Think of each raw component as a parts bin for a specific type of information. Raw components may be general or specific. As they are assembled in a collection, they can be given other names (aliases) in addition to the generic raw component name. To create a new raw component: 1. From the Content Navigator, double-click a content type to expand the data and select Raw Components. Ex- isting raw components display in the right window.

If you select View → Filter, you have the option to filter the raw components using the following criteria: Class (Text, Pointer, or Multimedia), ID, Name, or Description. In addition, you have the option to filter on all raw components, only the raw components that have been used, or only the raw components that are unused.

2. Right-click Raw Components and select New → Pick List or New → Create New.

a. Pick List allows you to add raw components from another content type. The Raw Component Reuse Pick List shows all raw components in all content types.

• Click to select a Raw Component. Use Shift+click to pick a range of entries or Ctrl+click to pick random entries.

• Click OK. The new raw component(s) displays in the right window of the Content Navigator window. (Click Cancel to abort the action.)

b. Create New allows you to create a raw component from scratch using the New Raw Component window.

• On the General tab, enter a name for the raw component (this name cannot exceed 30 characters.) Enter a Description in the optional field. Pick a Raw Class from the dialog box drop-down menu (text, multimedia or pointer.) Where Used on the New Raw Component window can be clicked any time to determine if a component exists in any edit, extract, or load view.

• On the Aliases tab, enter one or more aliases for the raw component.

Aliases are additional names given to components. This allows for the same underlying raw component to have different children within a collection. Initially, an alias matching the raw component name

is automatically created; this may be retained or replaced. If you want to add a new alias, right-click and select Add from the pop-up menu.

• On the Attributes tab you can enter attributes for the raw component. These are known as raw attributes. Because attributes added at this level are global in nature, you should not add them at this level if they can change with different contexts for the component. For example, the date of birth will not change for a given employee, but the employment status can change in different contexts, therefore employment status would not be a good raw attribute. • To enter an attribute, right-click and select Add. • Select an attribute from the Attribute Pick List and click OK.

• Select an attribute from the Attribute Pick List and click OK. • The New Raw Component window now reflects the addition of the new attribute(s.)

• After an attribute has been added, you can enhance the data by selecting Update. A New Raw Component Attribute window displays.

• On the General tab, enter a Default Value and, if needed, a Value (Raw) for the attribute. A default value is assigned if no value is entered for the attribute. If a raw value is chosen, you must pick an attribute value from a list of raw material based on the raw component specified here. • On the Values tab, enter Valid Values for the attribute, if needed. Valid Values are one or more acceptable values for an element or an attribute. • On the Occurrences tab, right-click and select Add to set an Occurrence Rule and Group Number for the attribute. A dialog box appears in the main window under the Occurrence Rule field containing a drop-down menu from which you select an occurrence. Click Group Number and type in the appropriate value. An attribute's occurrence rule is defaulted to Zero or One, meaning the attribute is optional. If the attribute's occurrence is required, select Exactly One. This is a required field.

• On the New Raw Component window Defaults tab, enter a relationship to another raw component. Relationships link one piece of raw material to another. Once this relationship is established, you are able to link specific pieces of data in Vasont.

To add a relationship, right-click and select Add.

i. Select a raw component from the Raw Component Pick List. ii. Click OK. The New Raw Component window now reflects the addition of the new relationship. • On the Advanced tab of the New Raw Component window:

i. Pick Not Allowed, Optional, or Required from the Text dialog box menu to indicate the requirement of textual content for the raw component. ii. Use the Data Type menu and select Text or Number. iii. Use the Global Change menu and select Never, Always, or Pick List. iv. Select Parse SGML to SGML-parse the raw component when edited within Vasont (only for SGML users who purchased I4I.) • On the Translations tab you can define the languages into which you want to translate the textual content of the component. This option applies to a specific Vasont client configuration. Most Vasont clients use an alternative translation configuration. See Building a Translation Setup for more information. Creating New Aliases As raw components are created, they may be assigned one or more additional, more specific names. For instance, Author might be a raw component that is given the additional names of Novelist and Screenwriter. These additional names are referred to as Aliases. When a raw component is created, it is automatically given an alias that matches its raw component name. This default alias may be retained or replaced. When a collection is built, its components are actually aliases. This allows components that are the same underlying raw component to have different children within a collection. But a list of raw material (the data associated with a given raw component) viewed in Vasont would show, for this example, all of the Authors used in the collection.

In addition to the alias, a component may have yet another name assigned called its Navigator Name. This is the label you see in Vasont Navigator. The Navigator Name defaults to the alias. It is often the case that a component's names—Raw Component, Alias, and Navigator Name—are all the same. There are certain instances when it makes sense to use different aliases for a raw component. One is to allow the component to have different children in a collection. Another is to achieve greater reuse of data within a collection. For example, when components are dragged-and-dropped in Vasont Navigator, or cloned from one collection to another, the underlying naming structure becomes important. If two components in two different collections have different Navigator Names, but the same underlying alias and raw component, it is valid to move or copy the components from one collection to the other. If the components have different aliases, but are the same raw component, you are prompted to choose the alias for a component that is moved from one collection to another. Consider three textbooks: one has units called Chapter, the second has units called Section, and the third has units called Topic and Exercise. Suppose these four components were all of raw component Chapter, with aliases of Chapter, Section, Exercise, and Topic. If a chapter is cloned into the section collection, the chapter is transformed into a section. If a chapter is cloned into the exercise/topic collection, you are asked whether the chapter should become an exercise or a topic. If there is yet a fourth textbook that used a component of raw component chapter and alias chapter (like the first collection), but had a Navigator Name of Unit, a clone from the first collection to the fourth simply relabels the chapter as a unit. A new alias cannot be created independent of a raw component. See Creating New Raw Components for information on adding a new alias to a raw component. Alias Attributes An attribute can be defined on an alias to improve the efficiency of a Vasont setup. Since an attribute can be defined once on the Alias and used wherever the Alias is part of an edit view, a load view, or an extract view it minimizes the number of locations that require attention if a change is needed. Rather than having to set up an attribute on every component instance in edit views, load views, and extract views, the attribute can simply be defined once on the Alias. The attribute will be added to all instances of the component, throughout all collections in the content type where the Alias is defined. It is important to note, however, that attributes may still be defined on individual component instances in edit, load, and extract views. In some cases, an attribute must be defined on a component rather than an alias. For example, suppose that you want an attribute to exist purely within Vasont. In this case, you wouldn't want the attribute to be applied to the component in the extract view. Therefore, you would not want to define an alias attribute because it would be applied to all edit, load, and extract views. Another example would be when an attribute needs to have a processing option attached to it in the load or extract view to produce a specific action or result. In this case the attribute must reside on the view component in order to apply the processing option. In other cases, it may make sense to define an alias attribute and also define the attribute directly on the component in a single or multiple edit, load, or extract views. If you need to apply a processing option to an attribute in a load or extract view, you could define the attribute as an alias attribute. Then, you could also define the attribute on the component in the load or extract view and apply the processing option needed. You would need to apply the attribute directly to the component because processing options can not be applied to an alias attribute.

If the same attribute is defined both on the alias and directly on the component in an edit, load, or 2 extract view, the properties of the attribute that are defined directly on the component are used. The attributes that are applied directly to an edit view component will appear first in the Vasont attribute pane, followed by the attributes that are applied to the alias.

Creating Alias Attributes Prior to creating an alias attribute, you must first create the attribute at the content type level. See Creating New Attributes for more information.

To create a new alias attribute: 1. From the Content Navigator, double-click a content type to expand the data and select Aliases. The list of aliases displays in the right window. 2. Right-click on an alias and select Update. 3. To add an attribute to the alias, select the Attributes tab. Right-click and select Add.

4. Select an attribute from the Attribute Pick List and click OK.

5. If desired, right-click on an attribute and select Update to set or change its properties. The Update window contains three tabs. • General tab — This window contains the following items: Enter a Default Value, if desired. Select a Raw Value from the list. Assigning a raw value means that the attribute's value must be chosen from existing instances of the specified raw component. Clear the Allow Edits box to prevent all users from editing the attribute in Vasont. This is useful for FIXED attributes. Select the Allow Multiple Values box if the attribute should allow multiple valid value selections. When checked, the Vasont users will see an ellipses button next to the attribute in the collection navigator. The ellipses button will open a window that will allow multiple values to be applied. This feature is designed for configurations where users apply conditions (or meaningful values) to components and then extract the content according to a set of values for publishing a document that is designed for a specific audience. Define a Delimiter character if you are using the Allow Multiple Values option, and would like to use a delimiter other than the default. The space is used to separate the valid values in the attribute by default. If you prefer another delimiter, such as a semicolon or comma, enter the character in the box.

• Values tab — Assigning Valid Values to an attribute gives you a drop-down menu when the attribute is edited in Vasont. Free-form text maynot be entered. Valid values are not appropriate for all attributes. Right-click to Add a value, or select an existing value and right-click to Cut, Copy, Paste, Insert, Add, or Delete. • Occurrences tab — An attribute's occurrence rule defaults to Zero or One, meaning the attribute is optional. All attributes with a default value should be set to zero or one. Select Exactly One if the attribute's occurrence is required. Keep the Group selection set to 0. Do not create more than one occurrence rule for an attribute. Click X in the upper right corner to close the Attribute Update window. The Allow Edit property is set directly on the Attributes tab. 6. Click Save and Close.

Creating Alias Attributes With Drag and Drop Attributes may be added to an alias using the standard drag and drop functionality. This can be accomplished by dragging attributes from one alias to another alias, or from an edit view component to an alias. 1. Open an Update window for the alias or edit view component that contains the attributes to be copied. Select the Attributes tab. 2. Open an Update window for the alias that will receive the new attributes and select the Attributes tab. 3. Arrange both the source and target alias Update windows so that each is viewable. Hold down the Control key while dragging the source attribute to the target alias Update window. A hand icon will appear as you drag the attribute into the target window.

Associated attribute properties are copied along with the attribute to the new location.

This functionality will also work for copying attributes from an alias's attribute tab to an edit view 2 component's attribute tab. Copying Alias Attributes to Other Aliases The attributes from an alias may be copied to one or more other aliases. 1. From the alias's Attributes tab, select one or more desired attributes for copying.

2. Click Copy to Other Aliases.

3. The Alias Pick List displays. Select one or more aliases to receive a copy of the attributes and click OK.

4. A message displays stating the number of attributes that will be copied. Click Yes to continue with the action.

Alias Valid Values

A list of valid values can be applied to the alias in order to simplify the collection configuration. This type of setup provides one location for defining and updating the list of values, rather than multiple occurrences of the component valid value lists in multiple spots in collection edit views.

Edit view components will utilize the valid values on the alias if they exist. Valid values defined on the edit view component will take precedence over alias valid values in the event that the values exist in both places.

If your configuration currently has the valid values defined on the collection components, you can move them to the alias by using a right-click option called Copy Values to Alias. For more information see Copying Valid Values to Aliases.

A batch process is available to clear the valid values that exist on edit view components. For more information, see Clearing Valid Values from Edit View Components. Creating Alias Valid Values

To define a list of valid values on an alias:

1. Right-click on the Alias and select Update.

2. Select the Valid Values tab. Right-click in the window and select Add.

3. Type in the valid value.

Valid values may be altered by re-entering the text, or highlighting the value and right-clicking 2 and selecting Delete. 4. Repeat steps 2 and 3 until all values are entered. 5. Select the Alias tab. Using the drop-down list, set the Valid Value Flag to Yes or Yes-Allow Override.

• Yes: means that the user must pick one of the valid values when creating the component in Vasont. • Yes-Allow Override: means the user is permitted to enter a value other than one of the valid values listed when creating the component in Vasont.

If the valid values are set on the edit view component, then the Valid Value Flag from that com- 2 ponent will be honored. 6. Click Save. If the Valid Value Flag is set to No and values have been entered, a warning message will display. This is only a warning and does not prevent the save from occurring and will not prevent the window from closing. Click OK to dismiss the message.

7. Close the Update Alias window.

Copying Valid Values to Aliases If the current configuration contains valid values on edit view components, you can copy them to the alias to simplify the configuration and minimize maintenance. 1. In the Edit View navigator, right-click on the component and select Update.

2. Select the Valid Values tab. Right-click in the window and select Copy Values to Alias.

3. If valid values are already defined on the alias a message will display asking the user whether they should be overwritten. Click Yes to overwrite or No to cancel the process.

4. When the copy is completed, a message will display. Click OK. 5. Close the edit view component update window. Once the valid values have been copied to the alias, a batch process to clear the valid values from the edit view components can be performed. For more information, see Clearing Valid Values from Edit View Components. Clearing Valid Values from Edit View Components After valid values have been copied from the edit view component to the alias, a batch update may be performed to clear the values from the edit view components. 1. Select Raw Components. Right-click on the component where the valid values exist. Select Where Used. 2. Select a specific collection or multiple collections in the filter, depending on the scope of the alteration.

3. Select the Edit View tab. Select all entries where the valid values are to be cleared. Right-click on the highlighted entries and select Batch Update.

4. Select the Advanced tab. Using the drop-down list, set the Remove Valid Values to Yes.

5. Click OK.

6. Click Yes to save the changes.

Creating New Wrappers

Wrappers link SGML/XML tagged data to collection components in Vasont. Wrappers represent the tags present in XML or SGML files that are loaded into Vasont or are extracted out of Vasont. After wrappers are created, they are linked in Load and Extract Views with collection components. Wrappers are not needed in Edit Views. Many extract or load views can be defined for a particular collection, which allows tagged SGML or XML output to be generated independent of a single tagging scheme.

1. From the Content Navigator, double-click a content type to expand the data and then select Wrappers. Exist- ing wrappers display in the right window.

If Used is selected, only wrappers within a collection that is part of that particular content type are displayed.

2. Right-click Wrappers and select New → Pick List or New → Create New.

a. Pick List allows for the addition of wrappers from another content type. Wrapper Reuse Pick List shows all wrappers in all content types.

i. Click to select a wrapper. ii. Click OK. The new wrapper(s) displays in the right window of the main Content Navigator. b. To create a new wrapper from scratch, right-click Wrappers and select New → Create New. i. The New Wrapper window displays.

ii. Enter a name for the Begin Tag that should precede the data. Do not include angle bracket delimiters, because the load utility assumes brackets and the extract utility adds them. iii. Enter a name for the End Tag that should follow the data. Do not include angle bracket delimiters, but include the forward slash (/) that precedes the end tag. If the wrapper is associated with a component that contains no actual data (an empty element), omit the end tag altogether. 3. To view the new addition, as well as all Used wrappers, right-click Wrappers in the left window and select Used. The tags display in the right window. To toggle back to the original view, click Used. Creating New Attributes If raw components, aliases and collection components are the nouns, then Attributes are the adjectives within Vas- ont. Attributes are defined in a content type and may then be applied, using one of three different methods, for use in your Vasont configuration. Attributes can be applied to an alias, known as alias attributes, or they can be applied to a raw component, known as raw attributes. However, the most common application of attributes is on a component in a collection edit, load, or extract view. Alias attributes are used in order to simplify the setup and maintenance of your Vasont configuration. See Alias At- tributes for more information.

Raw attributes are used in order to assign metadata, in a global manner, to a specific piece of content. See Creating New Raw Components for more information on raw attributes. Component-level attributes can be applied to as many components as required. If an attribute is applied only to the edit view, then it can be added, changed, or used for searching within Vasont, but it is never extracted or loaded. If an attribute is applied to extract and load views but not to the edit view, then the value of that attribute is usually channeled during load into one of two special fields, the Client Key or the multimedia description. The attribute value is then pulled from these fields during extraction. When an attribute is created, its type is specified. This corresponds to an SGML or XML declared value. When an attribute is applied to a raw component, alias, or a collection component, other properties are specified, such as Oc- currences, required or optional default value, and a list of Valid Values. To create a new attribute in a content type: 1. From the Content Navigator, double-click the applicable content type to expand the data and select Attributes. Existing attributes display. 2. Right-click Attributes and select New → Pick List or New → Create New.

If Used is selected, only the attributes used in a collection that is part of that particular content type are displayed. a. New → Pick List allows for the addition of attributes from another content type. The Attribute Reuse Pick List window shows all attributes in all content types. i. Click to select an Attribute Name from the pick list. ii. Click OK. The new attribute displays. b. Use New → Create New to create an attribute from scratch. The New Attribute window displays.

i. Enter an Attribute Name in the dialog box. ii. Select a value from the SGML Type drop-down menu (corresponds to the SGML declared value.) The default is CDATA. Special Types for Auto-Publishing • SAVED_CONDITIONS: When an attribute of this type is selected in Vasont, a list of Saved Condition Sets will be displayed. Saved Condition Sets are a group of attributes and values that are used to filter content when extracting. These attributes and values are saved as a set so that they can be easily recalled when needed. For more information on Saved Conditions Sets, see conditionally_extract_based_on_attribute_value in the Vasont Processing Option Guide.

• PUBLISH_TYPE: When an attribute of with this type is selected in Vasont, a list of Publication Types will be displayed. Publication Types are defined in the Manage Publication Types window. Each Publication Type defines information about how a document will be automatically published and stored. iii. Type in a Description for the attribute, if needed, in the optional field.

Creating a New Collection Collections are the main elements of a content type. Once the raw components, attributes, and wrappers are defined, collections can be defined from them along with settings that control the behavior of the components in each collection instance. This section describes how to create a collection manually. Following this section are some other methods for automatically creating a collection. 1. From the Content Navigator, double-click the appropriate content type to display collections. 2. If another collection already exists, right-click on it and select New.

3. If no collections exist, right-click the appropriate content type and select New → Collection.

The New Collection window displays.

4. On the General tab, enter the Collection Name and Abbreviation (the abbreviation cannot exceed 20 characters). 5. On the Comments tab, enter any data or remarks relative to the new collection. 6. On the Refining Collections tab, if your data is modularized, select the related collections where you may want to perform Refine queries. See Defining Refine Collections for more information. 7. On the Advanced tab, enter Edition, Production Date, Language and Site (site refers to an installation site and is only relevant when there are multiple installation sites.) All Advanced tab settings are optional. 8. The Types tab contains values for establishing special behaviors for the collection when used with specific product features (i.e., Vasont, Vasont WebLNX®, Web Query Access). The available choices are: • Automated Publication Configuration: Identifies the collection as one that is used to organize content for the Auto-Publishing process. • Automated Publication Extract: Identifies the collection as one where the Auto-Publishing process will find content to be extracted for publishing. • Automated Publication Load: Identifies the collection as one that will store the published output from the Auto-Publishing process. • Component Library: Identifies the collection as a library (also known as an index or taxonomy). Vasont, Vasont WebLNX, and Web Query Access read this setting to present special behaviors for libraries. • Ignore Modular Checkout: Identifies the collection as one that should be ignored when Vasont WebLNX applies check outs to content when initiating a workflow task. • Queryable: Used by Web Query Access. It identifies a collection as one that Web Query users will perform searches on to locate documents that meet their needs. • Ignore Ownership Extension: Defines a collection that should be ignored when the Ownership Extension is activated in the system and actions controlled by the Ownership Extension are taking place. For example, when new primary components are created in the collection ownership values will not be applied or when retrieving content in the collection it will be displayed regardless of the ownership value. 9. Now that the collection is created, see Building Collection Views to define the component structure and rules. Duplicating a Collection Edit, load, and extract views are duplicated along with all workflow projects associated with that collection. (See Edit Views, Load and Extract Views, and Creating and Updating Workflow.) To duplicate a collection: 1. From the Content Navigator, double-click the appropriate content type. 2. Right-click the collection and select Duplicate.

3. In the Duplicate Collection Options Window you have the ability to change the default name and abbreviation given to the new collection. You also have the ability to change the security settings. Duplicate Security Set- tings is selected by default. This means all the security settings for User and Role rights of the original collection are duplicated for the new collection. You can clear this setting if desired.

4. If you do not change the collection name, it is duplicated with the same name followed by a number in paren- theses (example: Manuals (1).)

When a collection setup is copied, an exact duplicate is created. The duplicate collection, as well as the load and extract views, will have a new ID number.

There are times when an exact copy of a collection setup is acceptable, and there are times when alterations are required. This depends on how the collection (and interacting collections) are configured.

Some things to consider when duplicating a collection:

1. Load and Extract View names — It is important to rename the load and extract views to reflect the new collection name. If a user is presented with a list of load and extract views and there are several occurrences of views with the same name, it is very difficult to determine the appropriate view.

2. Pointer Records — Depending on your configuration, you may need to update the pointer definitions. For instance, if you are recreating a group of collections that work together (such as Manuals, Chapters and Sections), you would not want pointer components in the new group of collections to point to components in the old group of collections. See the information on the Pointers Tab in Updating an Edit View Component for more information on updating pointer definitions.

3. Arguments on Processing Options — The collection's components or attributes may contain processing options that have arguments specifying a particular load or extract view, collection, or Workflow task. These values need to be updated. In some cases, the arguments are selected from a drop-down list and in others it may be in the form of an ID number typed into the text argument box.

4. Global Change definitions — If the global change feature is utilized in the configuration, determine whether the additional entries need to be made to the global change records. It is possible that original collections will also need to have global change records updated so the global change feature will function as desired.

5. Dynamic Index definitions — If the dynamic indexing is configured for the original collection as well as the duplicate, alterations may be necessary to produce the type of index desired.

Importing an Entire Collection

1. On the main menu, select Utilities → Import → Entire Collection.

2. Select the file to be imported from the file selection dialog box.

Editing the XML file that was created during the export of the Collection is not supported at this 2 time.

3. Click Open. The Skip Importing Processing Options? message is displayed.

Clicking Yes will bypass the import of processing option definitions into the system. This will save time importing if the collection is imported into a system at the same software version as the collection from which it was exported.

Clicking No will import all processing option definitions. This will lengthen the importing time.

4. A question prompt displays asking if the collection should be imported to a specific Content Type.

Click Yes and the new collection will be placed in the specified content type.

Click No and the Import Collection Filter will allow the selection of the content type where the new collection should reside.

5. The Import Utility window prompts you for confirmation to continue.

If the content type into which the Collection is being imported already exists, the above confirmation box displays. If the content type does not exist in the database, it is created during the 2 import process (a message box stating this will display.)

Click Yes to continue with the import or No to cancel the action. When a collection is imported, some or all of the processing options' arguments may be modified. An internal compare of the new collection is performed to determine if any raw components, attributes, and wrappers already exist in the content type. If matches are found, the existing raw components, attributes, or wrappers are used; if not, new ones are created. 6. If data in the import file conflicts with data already in the content type, an Import Conflict Report will display. You can review and print the report, and then click Continue.

If there are processing option arguments that could not be modified, you are prompted to save a log file. If you do not save this file, you must manually verify which processing options were not 2 updated with correct argument values. Pointer components' records are not maintained during the import and will need to be redefined following the completion of the import.

When the import is complete, a message displays indicating success. • If the collection exists and has an empty edit view, the collection is overwritten. • If the collection exists and does not have an empty edit view, a new collection is created with the original collection's name followed by a number, such as (1.) For example, if the collection in the file being imported is Recipe Sample, the new collection is named Recipe Sample(1). • If there is no existing collection, a new collection is created with the original collection's name.

Using the Read DTD Utility Once a new collection is created, you can use the Read DTD Utility to automatically create a load and an edit view as well as create all raw components, attributes, and wrappers. This setup can then be used to load tagged data into Vasont.

Careful consideration should be used before running this utility in a system that already contains collection configurations. You must analyze the element and attribute declarations in the DTD and com- 2 pare them to the existing raw components, attributes, and wrappers to determine if there will be any conflicts. Reading a DTD into the Vasont Administrator without a thorough analysis could result in undesirable results. It is recommended that you discuss this with your Vasont support leader for guid- ance before proceeding.

Before a DTD can be read, a new collection must be created. The collection may be created within an existing content type, or a new content type can be created. (See Creating a New Collection ) If the DTD contains public entities, a catalog file must be available in order for the Read DTD utility to correctly interpret the DTD. Open the VasontApps.ini file, which is located in your Windows directory. Find the location of the following text in the file: [ReadDTD] CatalogPath= Enter the full path and filename of the catalog file following CatalogPath= and save the file. 1. From the menu, select Utilities → DTD → Read DTD. 2. Navigate to the DTD location, select the file, and click Open.

2 Read DTD supports a DTD that is broken into multiple files.

3. From the drop-down menus, select the content type and Collection into which the DTD is to be read.

4. Click OK. If the selected collection already contains data, a dialog box asks you to select a collection with no existing data.

• As the DTD is being processed, informational messages display in the lower left corner of the screen indicating what part of the DTD processing is taking place. Although small DTDs can be read in less than a minute, a larger DTD may take fifteen minutes or longer. • If there is only one element that can be a top-level component, it is set by default as the primary component. If there are multiple elements that can be a potential top-level component, the Select Top Level Component dialog box displays a list of components from which you can choose. The component that is chosen is set as the primary. When the utility is finished reading the DTD, the DTD Navigator window opens.

Read DTD attempts to correctly place data; however, you may need to make changes after the DTD 2 is loaded. Check the edit view to ensure occurrences and group numbers are correct. You can use the edit view Basic report to check this information. Use the various edit view reports to review other information. (See Edit View Reports.)

Once the DTD is read, you can accept the data, save the data, or perform updates in the DTD Navigator window. (See Accepting Setup Data and Saving Setup Data.) Previewing the Setup Using DTD Navigator The DTD Navigator provides a preview of the setup, which allows you to make changes before the actual edit and load views are built. (See Updating a DTD Navigator Component).

Setting the Primary The component with the red diamond beside it is the primary (top-level) component. To select a different component as the primary, right-click on the component and select Primary.

If the component set as the primary is changed from the default, its siblings are not included in the load and edit views. The top-level component and the parent of the new primary are automatically set as file wrappers in load view and are not included in edit view.

Updating a DTD Navigator Component The concept of granularity is very important in Vasont. Granularity describes the smallest chunk of stored content in Vasont. Granularity is determined by which components you choose to track rather than just carry along with the parent component. How big or how subdivided content components should be is a judgment call depending on the value and uses for the content. At a high level, the more value and the more uses content has, the finer the granularity should be. A very coarse granularity would define paragraph as the only component and ignore all other details contained within it. This would be fine for content used to archive and perform text searches from time to time. When fewer components are included, it allows for faster loads, extracts, and expansion of components when viewing content in Vas- ont. But if you want to create Web pages, repurpose content, and edit frequently, it may be more productive to identify not just paragraph, but keywords, equations, references, and graphics as components. Right-click a component in the DTD Navigator window and select Update.

The Update Title dialog box provides the capability to make changes. The following changes can be made:

• Tag: this box is automatically populated with the component selected on the DTD Navigator. The tag (Vasont calls these Wrappers) will match the element name in the DTD. • Raw Component: can be updated. By default, the Raw Component entry is the same as the Wrapper name. The Raw Component name indicates the Vasont component that is created and associated with the tag. • Tag names can function as component names, but sometimes tags are cryptic or dot/hyphen delimited; therefore, a user should consider renaming the component to a more readable format. Unlike tag names, Raw Component names may contain spaces, but are limited to 30 characters in length. • It is this name that the user sees in the Raw Component listing, so it is worth the time to give each component a clear and easy-to-understand label. The component xref, for instance, might be better labeled as Cross Reference.

• Description: enter a descriptor for the raw component. The type of information that can be entered here is a description of the Raw Component. This is useful in cases where several different Raw Components have similar functions, for instance; the Description can be used to capture the specific uses or purposes for each component. • Raw Class: Raw Class refers to the type of data stored in the Raw Component. The classes available are Text, Multimedia, and Pointer. Select the applicable class from the menu. • Text is the most common Raw Class, and indicates information stored as ASCII text. • Multimedia is any data that is not text and/or is a special file format. Examples are graphic images, Micro- soft Word or other data processing files, PDFs, video and audio files. Multimedia files are stored directly in Vasont as Binary Large Objects (BLOBs). • Pointers are links to other components. A pointer specifies the Raw Components it can point to in the same Primary, across Primaries, or across Vasont collections. • Alias: can be updated. If Alias is changed, click in the Navigator Name box to update that data as well. In most cases, the Alias is the same name as the Raw Component. It is useful, however, for differentiating Collections with the same basic structure but different purposes (i.e., Technical Manuals and Users' Guides). A structure may be moved from one Collection to another seamlessly so long as it has the same Raw Components, even though the Alias used in each Collection is different. When moved in this fashion, the Raw Component adopts the Alias specified for that Component in the context of each Collection. • Navigator Name: can be updated, if needed. However, clicking Alias does not automatically update this box when the Navigator Name is changed. This is the name that appears in the Vasont Navigator display. This name matches the defined Alias for each component. • Text Allowed: select as needed. Checking this box means that #PCDATA (text) is allowed in this component. If the DTD defines #PCDATA as part of an element's content model, the Read DTD utility automatically checks the Text Allowed box. Note: In the case of the primary component of a Collection, the Text Allowed box should be checked so that meaningful descriptions may be entered to label the primary in Vasont. For example, in the Vasont Navigator, seeing "Manual" does not specifically tell the user which Manual it is, but entering text to describe the Manual makes it obvious (i.e., Manual: Web Application Users' Guide). • Inline Component for Parent: select as needed. An Inline Component is part of a content model that allows #PCDATA (text). For example, a Para component may have a content model of #PCDATA or ModelNumber. In this case, ModelNumber is the Inline Component. • Store Text within Parent: select as needed. This checkbox is disabled (grayed out) if Text Allowed is selected. • If selected, a series of processing options on the Load View is applied which take the text of the component and display it as text of the parent component in the Edit View. The text is then moved back into the child component on extract so that the structure conforms to the DTD. This may be useful if a section component has no text but has a child of Title. Rather than the section component appearing empty in Vasont, the text of title could be displayed for viewing, editing, and searching purposes. For example, if Manual does not contain #PCDATA, but Manual does have a required "Title" component, a user may choose to store the Title inside of the Manual component. In the Vasont Navigator, the text of Title displays following the Manual label and makes Manuals easy to identify without expanding the model to expose the Title component (i.e., Manual: Introduction, rather than Title: Introduction). In this example, a user may search for a Manual, titled "Introduction" without having to search for a Title under Manual where the Title text is "Introduction". Choosing this option removes the Title component from this location in the Edit View, but it remains in the Load and Extract Views. The following processing options would be applied: • The component is not included in the edit view and the following processing options are applied: • retrieve_text (Event: extract_component) • store_in_parent (Event: load_component) • The component's parent is assigned the following processing option:

• Processing Option: store_text (Event: extract_component) • Wrapper Flag: select a wrapper flag (see Updating a Load or Extract View Component—General Tab.) There are three (3) valid values for the Wrapper Flag, i.e., Standard, File, and Pure. (This setting cannot be updated if Text Allowed is selected.) • A Standard Wrapper wraps actual collection component content. • A File Wrapper may be used when a "Primary" that is not the root element of the DTD has been chosen. In other words, in Vasont, the top element might be Manual, but the DTD may be written with a wrapper above that, called Manuals. In the Load View, a wrapper called Manuals will appear with no associated component and with the Wrapper Flag set to File. There can only be one File Wrapper per view. • A Pure Wrapper is one that is also represented only in Load and Extract Views because there is no associated Vasont component. Declaring a wrapper a "Pure Wrapper" indicates to the system that this is a layer that may be eliminated in the Edit View (what is seen in Vasont Navigator). Often DTDs are written with many extra layers of wrappers which give the Edit View a complicated look. On Extract, the extraneous wrappers are included in the extracted XML. Pure wrappers must be used cautiously-if there is ambiguity about the parent of the pure wrapper, files may not load properly. • Navigator Order: update the component's order. (See Updating an Edit View Component—General Tab.) The Read DTD utility determines the Navigator Order from the DTD. The Navigator Order indicates the component's sequence number under its Parent component. In content models where there is actual sequence, such as (legend, graphic) (legend followed by a graphic), the Read DTD utility assigns legend a Navigator Order of "1" and graphic a Navigator Order of "2". In content models where an OR group occurs, like (para | figure | xref)* (para or figure or xref, in any order and any occurrence), all of the components are given the same Navigator Order (i.e., "2"), because the order in which they load and are stored is the same as the order in the XML document. When content models contain #PCDATA, as well as other elements, a Navigator Order of "99" is assigned to the elements. These elements are referred to as Inline Components and are commonly assigned the value "99." For example, a content model of (#PCDATA | figure | xref)* (text or figure or xref, in any order and any occurrence) would result in figure and xref as Navigator Order "99." Navigator Order is meaningless for the Primary component because it has no "Parent." • Attribute Name: Attributes are listed as they are detected in the DTD. If desired, an attribute may be deleted from the model. Fixed attributes (#FIXED) will not appear in the Vasont setup because their values are fixed and cannot be changed by the user. Right-click and select Mark for Delete to remove an attribute.

Click OK when all updates are completed. Deleting a DTD Navigator Component

Right-click on a component and select Mark for Delete to remove it from the DTD Navigator.

Click Yes to confirm the deletion. The deleted component is not included in the edit or load views when the data is accepted. Deleting a DTD Navigator Component's Children

1. Right-click a component and select Delete Children.

The Delete Children dialog box displays.

2. Select the child wrapper components to be deleted.

3. Right-click and select Mark for Delete.

Expanding DTD Navigator Components

To expand DTD Navigator components, right-click on a component and select Expand All. All of the component's children and grandchildren display. Saving Setup Data

In order to preserve setup data for further updates, it must be saved. If the DTD Navigator window is closed without saving the data, the DTD needs to be read again.

1. Click Save Data on the main toolbar.

2. Navigate to the location on the PC where the file is to be saved. 3. Change the file name, if needed. 4. Click Save. Two files are created when the setup is saved. One stores Element information and the other stores Attribute information. The attribute text file is stored in the same directory as the element file. It's assigned the same name as the element file, except it has _att appended to its file name. Opening a Saved Data File Setup data that was saved before the data was accepted can be reopened in order to make further changes in the DTD Navigator. 1. Select Utilities → DTD → Open Saved File. 2. Use the Select File dialog box to navigate to the previously saved file. 3. Select the file and click Open. (CAUTION: Do not open the file with _att appended to its name.) 4. In the Select content type and Collection dialog box, select a content type and then a Collection to indicate where the setup is to be built when the data is accepted. The collection selected must be empty.

5. Click OK to open the DTD Navigator. Accepting Setup Data Accepting the setup data builds the edit and load views based on the DTD Navigator tree view. It also adds all raw components, attributes, and wrappers to the content type. 1. To accept data, click Accept Data on the main toolbar.

2. When the process is complete, click OK.

After the data is accepted and the utility builds an Edit View and a Load View, there are many additional changes which may need to be made. See the following section, Additional Data Model Up- 2 dates, for more details.

Additional Data Model Updates Raw Components, Attributes, and Wrappers Raw components are basic building blocks of data in Vasont. The elements in the DTD are translated into raw components. Element names are also translated into Wrappers that are used to build the Load View. Attributes are translated into attribute data.

Much of the data is defaulted and may need to be changed. • Attributes use the SGML declared value indicated in the DTD as their SGML type. • Wrappers that are EMPTY are created with no end tag. Other wrappers just use the begin tag preceded by a ‘/’ for an end tag. For more information on raw components, see Creating New Raw Components. For more information on wrappers, see Creating New Wrappers. For more information on attributes, see Creating New Attributes. Edit View and Load View You may want to make changes to the Edit or Load View setups after accepting the data. See Edit Views for details on the changes that can be made to the edit view. See Load and Extract Views for details on the changes that can be made to the load view. Creating an Extract View A collection's Extract View is used by Vasont to map components to a tagged format on extract. This view describes to the extract utility the tree structure of the content being extracted. An Extract View can be created by: • Cloning the Load View (after any updates have been made) • Using Drag and Drop (after any updates have been made) • Creating from Scratch See Load and Extract Views. Using the Read Schema Utility

The Read Schema Utility is used to automatically create a Load and an Edit View from a schema. It also creates all Raw Components, Attributes, and Wrappers. This setup can then be used to load tagged data into Vasont.

Careful consideration should be used before running this utility in a system that already contains col- 2 lection configurations. You must analyze the element and attribute declarations in the XSD and compare them to the existing raw components, attributes, and wrappers to determine if there will be any conflicts. Reading a XSD into the Vasont Administrator without a thorough analysis could result in undesirable results. It is recommended that you discuss this with your Vasont support leader for guid- ance before proceeding.

Preparing to Read a Schema

Before a schema can be read, a new collection must be created. (See Creating a New Collection). The collection may be created within an existing content type, or a new content type can be created. (See Creating a New Content Type). The Read Schema Utility requires that the user have Microsoft Java Virtual Machine installed on their PC. Reading a Schema

1. Select Utilities → Schema → Read Schema. 2. Navigate to the location of the schema to be read, select the file, and click the Open button.

3. From the drop-down list, select the Content Type and Collection into which the schema is to be read.

4. Click OK. If the selected collection already contains data, a message displays asking you whether to overwrite the data that already exists. • Click Yes to overwrite the data that already exists. Click No to select a different collection into which to read the schema. • As the schema is being processed, informational messages display in the lower left corner of the screen. These messages indicate what part of the schema processing is taking place. Small schemas can be read in less than a minute, depending on the speed of the user's processor. A larger schema may take fifteen minutes or longer. • If there is only one element that can be a top-level component, it is set as the primary component, by default. If there are multiple elements that can be a potential top-level component, the Select Top Level Component dialog box displays a list of components from which you can choose. The component that is chosen is set as the primary. When the utility is finished reading the schema, the DTD Navigator window appears.

The Read Schema utility converts the schema to a DTD, therefore, when the utility is finished read- 2 ing the schema, the DTD Navigator window contains the preliminary setup information. In addition, the extension of the schema file displays as .dtd in the title bar of the window.

Read Schema attempts to correctly place data; however, you may need to make some changes after the schema is loaded. You should check the edit view to ensure occurrences and group numbers are correct. The Edit View Basic report may also be used to check this information. Other information may be reviewed by using the various edit view reports. (See Edit View Reports). Now that the schema has been read, all further steps are essentially identical to those performed after the Read DTD utility is used to create a setup from a DTD. You can now take the following actions: • Accept the data: the data can be accepted exactly as it was read from the schema, without making any changes in the DTD Navigator window (see Accepting Setup Data in the Using the Read DTD Utility section) • Save the data: the data can be saved to a file, which allows you to make changes at a later time without reading the schema again (see Saving Setup Data in the Using the Read DTD Utility section) • Perform updates to the data: updates may be made to the setup data in the DTD Navigator window, prior to an Edit and Load view being generated (see Previewing the Setup Using DTD Navigator in the Using the Read DTD Utility section) See Opening a Saved Data File, in the Using the Read DTD Utility section, for information on opening a data file that was saved from the DTD Navigator window. After the data is accepted and the utility builds an Edit View and a Load View, there are many additional changes which may need to be made. See Additional Data Model Updates in the Using the Read DTD Utility section for more details.

Processing Options are used to customize the way Vasont works. They allow for moving, copying, inserting or editing of content when content is extracted, loaded, or edited in Vasont. Processing Options may be executed during certain actions in Vasont called events. Processing Options are one of the most powerful capabilities of Vasont. The ability to apply them to various operations within Vasont allows for greater flexibility without the need for expensive custom programming. Each processing option is written so it is reusable, as required. Some Processing Options are very general and may be applied in many different situations while others have been created specifically for a particular client's need. Some Processing Options are very specific to a client's content and are very specific on their descriptions. A Processing Option may require one or more arguments. A Processing Option may execute one or more other Pro- cessing Options as part of what it does. Consequently, Processing Options can be considered as building blocks for more complex operations.

Filtering Processing Options

On the left pane of the Content Navigator, below the Collections icon, is the Processing Options icon. By selecting this icon, the right pane of the Content Navigator will display all the processing options in alphabetical order. To shorten this large list, you can right-click on the Processing Options icon and select “Filter”.

The Processing Options Filter window will appear, which allows the input of metadata that will help narrow in on an appropriate processing option. The filtered list will appear in the right hand pane.

Processing Option Properties

When processing options are displayed in the right hand pane of the Content Navigator, a right-click on a processing option will allow the Properties menu item to be selected. The result will be important information about that processing option.

Using the up and down arrows will scroll through the existing list of the processing options.

The Arguments tab will describe each argument used in the processing option. Context sensitive help is available for each processing option. Right-click on a processing option in the list and select Help.

The compiled help file will open with the selected processing option displayed. This view may display more information, warnings, examples and screen shots of specific usage of the processing option.

Finding the Right Processing Option

The following are some tips for locating a processing option that may meet your needs:

1. Sort the processing option list by column. By default, the list is displayed alphabetically by option name. You can click on a column heading and have the list resorted by the entries in the column. For example, resort the list by Event.

2. Right-click on any processing option in the list and select Help. When the compiled help file opens for the Vasont Processing Options Guide, go to the Contents and locate the Processing Options by Function. This section contains categories of actions that may be performed. Within each category there are links to processing options that may provide a suitable function for your situation.

Locating Usage of a Processing Option

Select Processing Options in the left window pane of the Content Navigator. Right-click on the processing option in the list and select Where Used.

A filter will display that allows you to select the scope of the list returned. Select a content type and collection. Click OK.

The Where Used window displays. Select a tab to see the listing of components, tasks or views that have the processing option applied.

Right-clicking on an entry allows you to navigate to the component, task or view where applied. You may also delete or perform batch updates from this window.

This chapter provides information on how to create and modify your collection views. Detailed information includes building and modifying Edit, Load, and Extract Views.

Edit Views When you create a new collection in Vasont Administrator, an empty edit view is automatically created. A collection has only one edit view, and the structure of the edit view is often based on a DTD or a portion of a DTD. There are three ways to build an edit view: • create from scratch • clone from another collection • use the Read Utilities (see Using the Read DTD Utility or Using the Read Schema Utility) Creating an Edit View from Scratch 1. From the Content Navigator, expand the collection and select Edit View. 2. Right-click the edit view in the right window and select Open Navigator.

3. The Edit View window is blank. Right-click and select New.

The Alias Pick List displays with a list of available alias names. 4. Select an alias to represent the primary component for this collection's edit view. 5. Click OK. The first component is inserted into the edit view with its default properties.

6. Continue building the edit view by right-clicking on existing components, selecting New, and choosing additional aliases. As collection components are added to the edit view, they become the children of whatever com-

ponent is selected. The Navigator Order field on each edit view component controls the order of sibling components.

7. When the tree structure is built, return to each component, right-click and select Update to refine their default properties. The Batch Update utility process may also be used. (See Batch Updating Components in a View)

Cloning an Edit View from Another Collection

An edit view can be cloned from another collection in the same content type and components can then be modified as necessary.

1. From the Content Navigator, expand a collection and click Edit View.

2. Right-click the edit view in the right window and select Open Navigator.

3. In the left window, expand the collection having the empty edit view. Select Edit View.

4. Right-click the edit view in the right window and select Open Navigator.

5. The first opened edit view window is now hidden behind the Content Navigator window. From the main toolbar Window menu, select the name of the hidden edit view in order to bring it forward.

6. Arrange the two edit view windows so they can both be viewed in full.

7. Select the primary component in the edit view containing the structure to be cloned, hold down the Ctrl key, and drag and drop on the empty edit view window. The structure, components, and properties of the original edit view (Doc Manuals) are cloned (duplicated) into the new edit view (SC.)

8. In the new edit view, right-click and select Update, Delete, or Resequence. Use Expand All to display all of the data.

Adding an Edit View Component 1. From the Content Navigator, expand a collection and select Edit View. 2. Right-click the edit view in the right window and select Open Navigator. 3. If the edit view is blank, right-click and select New. If components already exist, right-click on a component and select New (the new component becomes a child of the selected component.) 4. The Alias Pick List window displays. Select an alias from the list and click OK. The alias becomes a collection component in the edit view. Add as many aliases as necessary to complete the process.

Updating an Edit View Component Much of the power of Vasont is controlled by properties associated with the components in the edit views. Each edit view component has over twenty variables that affect its behavior. If there are several components that require the same updates to their properties, the Batch Update utility may be used to edit or add attributes, actions, processing options, pointer records, occurrence rules, general settings, advanced settings, and inline settings (see Batch Updat- ing Components in a View). 1. From the Content Navigator, expand a collection and select Edit View.

2. Right-click the edit view in the right window and select Open Navigator. Right-click on a component in the edit view window and select Update.

3. The following tabs are available on the Update window: • General Tab

• Navigator Order: You can change the position of the component among its sibling components. Sib- ling components with the same Navigator Order are interchangeable in sequence. • Navigator Name: You can change the label for the component as it is seen in Vasont Navigator. • Alias: Displays the alias of the component. Click Raw Component Details to add or change an alias. • Raw Component: Displays the raw component. Click Raw Component Details to change the name or properties. • Raw Component Details: Opens the update window for the raw component. • Alias Attributes: Opens the Alias update window in order to allow you to view or update the alias attributes. In order to view a complete listing of all the attributes that are being used on a component, click the Alias Attributes button and, with the window remaining open, click on the Attributes tab on the component's update window.

• Actions Tab

• Actions are listed in the left column, and Version creation options are listed in the right column. Clear check boxes in the left-hand column to restrict actions for the component. For example, if the Allow Delete check box is cleared, the component cannot be deleted in Vasont Navigator. This restriction applies to all users regardless of their user permissions. The version creation options in the right column are obsolete. Versions are automatically created for all components when these events occur. See the Utilizing Versioning in Vasont chapter in the Vasont User Guide. • Occurrence Tab • This setting is similar to the occurrence setting in a DTD or XSD. For example, if the occurrence rule is set to Exactly One, then the content in Vasont will be flagged as incomplete if the component is missing, or if more than one of the components occur. If no occurrence rules display, the default (Zero, One or More, Group 0) is in effect. Right-click in the window to add an occurrence rule (multiple rules can be applied.)

• Use the drop-down arrow to Update the occurrence rules for a component.

• Inline Tab

• Select the Inline Component box if the component is inline to its parent's text. This means that the component can occur anywhere within the text of the parent component. • Select the Store Text within Book box to display in Vasont the inline's component tag and text as part of the text of its parent. • Select the appropriate Wrapper for the inline component using the drop-down arrow. For example, if the inline component being updated is a paragraph, then the corresponding wrapper is mostly likely

or . A wrapper is selected in the drop-down box by default. It does not need to be modified if you are not marking the component as an inline. • Attributes Tab

• Right-click in the window to Add or Delete an attribute. You can also add a new attribute by holding down the Control key and dragging the desired attribute from one component's Attribute window and dropping it in to another component's Attribute window. The attribute brings along any existing properties that were set in the original location. • You can also add a new attribute by dragging it from another component's attribute tab and dropping it here. The attribute brings along its valid values, its default value, and its occurrence rule.

• Right-click on a highlighted attribute and select Update to set or change its properties. The Update window contains three tabs.

• General— This tab contains the following settings: Enter a Default Value, if desired. Select a Value (Raw) from the list. Assigning a raw value means that the attribute's value must be chosen from existing instances of the specified raw component. Clear the Allow Edits box to prevent all users from editing the attribute in Vasont. This is useful for FIXED attributes. Select the Enable Data Warehouse Export box if you are using Vasont data warehouse functionality. Select the Allow Multiple Values box if the attribute should allow multiple valid value selections. When checked, the Vasont users will see an ellipses button next to the attribute in the collection navigator. The ellipses button will open a window that will allow multiple values to be applied. This feature is designed for configurations where users apply conditions (or meaningful values) to components and then extract the content according to a set of values for publishing a document that is designed for a specific audience. Define a Delimiter character if you are using the Allow Multiple Values option, and would like to use a delimiter other than the default. The space is used to separate the valid values in the attribute by default. If you prefer another delimiter, such as a semicolon or comma, enter the character in the box. • Values— Assigning Valid Values to an attribute gives you a drop-down menu when the attribute is edited in Vasont. Free-form text may not be entered. Valid values are not appropriate for all attributes. Right-click to Add a value, or select an existing value and right-click to Cut, Copy, Paste, Insert, Add, or Delete.

• Occurrences— An attribute's occurrence rule defaults to Zero or One, meaning the attribute is optional. All attributes with a default value should be set to zero or one.

Select Exactly One if the attribute's occurrence is required. Keep the Group selection set to 0. Do not create more than one occurrence rule for an attribute.

Attributes may also be defined on the alias. This can save setup time by creating a single point of maintenance for a component's attributes and properties. For more information, see Alias 2 Attributes.

• Global Change Tab

• Source Global Change Properties: This portion of the Global Change tab is where you define which collections, and components within those collections, will be taken into consideration when Vasont determines whether there is an exact text match. • Right-click to Add or Delete a global change record.

• Use the drop-down menus to define Never, Always or Pick List as the global change action taken when the component has this particular function performed to it, either Edits, Resequencing, Adds, Deletes, Cloning, or Clone on Approve.

For example, in the preceding screenshot, Edits is set to Pick List. This means that when the Para- graph [Chapter] component is edited in the Doc Manuals Vasont 11 collection, Vasont will look at all Paragraph components (Paragraph [ALL] under Component) in the same collection (Doc Man- uals Vasont 11 under Collection) in order to determine if there are any exact text matches. If matches are found, a Pick List window displays, showing all the matches. Specific components can then be selected from the Pick List to indicate which components should be affected by the global change.

When using the [ALL] option, any other components of the same type that do not have 2 global change applied will need to have the log setting set to Log But Don't Update so that updates are not automatically applied. For example, if Paragraph[ALL] is selected, then other Paragraph components without global change will need the log setting.

• The Target Global Change Log Properties portion of the window contains options for the global change log. Select one of the following: • Ignore Global Change Log is the default. When this option is selected, the component is not entered into the log. The global change icon does not appear on the changed component in Vasont. • Log But Don't Update allows you to review before permitting the change. • Log and Update changes the component, unless checked out by another user. If the change occurs, the component is entered into the global change log. If the change cannot be made, an entry in the global change log is noted. • Log Only If Checked Out records only the components currently checked out and blocked from global change. • Global changes on load processes are activated by applying the load_global_change processing option in the Vasont Administrator, to the component that is to kick off the global change in the load view. The global change log definitions are honored, with the exception of the pick list, even if selected. Only one global change transaction per load, per entity_id is allowed. In other words, the first time during the load process that a global change affects a component, is the only time it happens. This is to avoid a circular chain reaction during the load process. (For example: Component “A” does a global change to component “B,” and then later component “B” is encountered in the load file and does a global change to component “A.”)

• Dynamic Indexes Tab

• Right-click to Add or Delete a Dynamic Index record. These settings control the inclusion of the component in a dynamic index collection. • When a dynamic index record is added, a retrieve allows you to limit the number of components displayed in the pick list that follows. Select a collection and/or enter a Navigator name to limit the selection, then click OK. Select All Collections to get a list of all components in all collections. For details on creating a Dynamic Index, see Dynamic Index. • Pointers Tab • The Pointers tab is enabled if the component has been defined as a pointer (see Creating New Raw Components.) Entries in this tab identifies the location of pointee component(s.) • There are two types of Vasont pointer definitions, global or specific. Global Pointers are pointer/pointee definitions where any component in a specified collection may be the pointee. Specific Pointers are pointer/pointee definitions that specifically define what components in a collection are valid pointees. • Use global pointers only when a pointer component can point to all components in a collection. It's purpose is to simplify the collection configuration and not necessarily the system's efficiency. When global pointers are selected for a collection and specific pointers have been entered for that same collection, the specific pointers are ignored and the global pointers take precedence. A filter allows you to limit the number of components displayed in the pick list. Select a collection and/or Navigator name to limit the selection list and then click OK. Selecting All Collections will list all components in all collections.

When picking the collection, the user will see a list of all collections across all content 2 types, since pointers can be defined to point across content types.

• To define a specific pointer definition: Select the specific pointee component in the desired collection. • To define a global pointer definition:

a. Select [All] in the desired collection(s).

b. When you select [All], the value in the ID column appears as a zero. The value of zero tells the system that any component in the collection is a valid pointee. c. Click OK to continue.

• After the pointer entry displays in the Pointer window, set a Link Criteria. There are four choices: a. Client key: This is the default setting and means that the pointer's client key field matches up with its destination's client key. b. DITA href: This setting is used for DITA components that use the href attribute. It applies the href syntax required by the DITA standard for resolving a cross reference. The following examples il- lustrate href attribute values: Target is elsewhere in the same topic: href="#topicID" or href="#topicID/elemID" Target is in a different topic: href="filename.xml#topicID" or href="filename.xml#topicID/ elemID" Special behavior is applied to a component with this link criteria that allows you to create the component without linking it to a target component in the system. Normally a pointer component that does not link to another component will be flagged as incomplete, but in situations where the pointee is external to the system or is a variable target, pointers with DITA href link criteria and one of these settings will not be flagged incomplete: • If the format attribute is set to “html”. Typically used for URLs.

• If the keyref attribute is populated. Typically used for variable targets (targets that are not determined until conditional filtering of the content occurs). c. XLINK href: This setting is used for military DTD requirements for xlink:href attributes. It will evaluate a pointer's client key by separating it into two parts (which are separated with a # delimiter). The cross reference component must be configured with the xlink:href attribute value as the component client key. The following example illustrates how this type of pointer is resolved. xlink:href="M234529#M234529-01-01" The portion preceding the # is the client key of a primary component in the system. The portion following the # is the client key of a subcomponent found in the target primary component. For example: [workpackage]#[section]. d. Text: This setting matches the text of the pointer component with the text of a pointee. e. None: This setting means that there is no automatic process in place to link a pointer component and the pointee. Pointers will be linked in Vasont manually. This is rarely used, but if selected, it would most likely be for non-XML or non-SGML content. • Select the Same Primary box if you know that the pointer and the destination components always occur within the same primary component. This increases system speed and efficiency. If pointee components in other collections are selected as possible destinations, the Same Primary box should not be selected. • Allow GUI Create is selected as the default. This allows for dragging and dropping inline components using the Vasont interface. • Select the Pointer to Modular Content box if the pointer was established for explicit reuse in a modular configuration. In general, this box would be checked if the content that is referenced is included or embedded in a published document. Some examples would be Sections, Procedures, Images, Cautions/ Warnings. It would not be checked for cross references that would appear in the published document as a highlighted link. For example See the section "Introduction". Checking this box gives you the following functionality: a. When creating a version on demand, you are given the option to cascade the on demand version to modularized content. b. When reinstating a version of a component as a new entity, you are given the option to reinstate as new any referenced, modular components at the same time. c. When extracting a version, the modular content will be extracted as it existed at the same date and time as the parent version extract. d. When adding a label to a version, an identical label will be applied to the modularized content's version. e. When content is checked in or checked out that contains a pointer to modular content, the modular content will be checked in or checked out also.

This functionality is only available if the checkout_modularized_content or check- 2 in_modularized_content processing option is applied to the component.

f. The Cross Reference category of the Content Exception Report uses this setting to determine the content that makes up the composite document. When all of the content is identified, pointers within that content that do not have this box checked are perceived as cross reference pointers. If the cross reference pointers cannot be resolved within the content they are entered into the exception report. This allows a user to examine the cross references and determine the action to be taken before publishing the document.

g. The Metadata Report uses this setting to locate content that is referenced by a component, such as a Map or Manual, that has specific attributes applied. h. The Open Modular Content features uses this setting to locate content in other collections that is referenced from the selected component. • Select the Branch Notices box if the content that this pointer can point to may have branches. When checked and the referenced component has branches, the pointer component will be flagged with a Branch Notice icon . In addition, owners of the pointer component content will receive a notification when the branch primary is approved. This allows other content owners to determine the specific branch that the pointer should reference. It is commonly checked for topic references in DITA Maps or BookMaps (topicref, conceptref, taskref, etc.) In DocBook or custom DTD configurations, it may be checked on pointers to Chapters, Sections, Procedures, or smaller items such as Cautions/Warnings. • To delete a pointer definition: highlight the entry, right-click and select Delete. • Processing Options Tab

• Right-click to Insert, Add, Delete, View Description, or Update Arguments.

Selecting Insert places the new processing option above the one you clicked. Selecting 2 Add places the new processing option at the bottom of the list.

Processing options can also be added by holding down the Control key and dragging a processing option from one component and dropping into another component's Processing Option window. This allows the processing option and all of its arguments to be copied to the selected component. Processing options must be valid for the context in which you place them. For example, a processing option used for extract processes cannot be dropped onto an edit view component's window. • The processing option window has three columns: Processing Option (name of option), Event (event during which the option activates), and Text Argument.

Processing options currently implement text arguments two different ways: Older process- 2 ing options' text arguments must be entered as a text string right in the window; while newer processing options use a separate window with arguments listed along with drop-down values for arguments. To access, highlight the processing option, right-click and select Up- date Arguments. Processing options may have one or more arguments, although, some do not have any. They may also have a mix of the old and new style arguments.

• Use the Broadcast Processing Option Settings button to add processing options (and their arguments) to other components. For more information, see Broadcasting Component Processing Options. • Valid Values Tab

• These values are choices to select from when entering data for this component. Right-click to Add or Delete a valid value.

To save significant setup time when adding or changing valid value lists, the valid values may 2 be defined on the alias. For more information, see Alias Valid Values.

• Transform Tab

• Transformations allow users to enter components which can be transformed during the clone process. Both components must be the same raw component. Right-click to Add a component from the pick list for collection components. Select a component and click OK. • When a component carries a transform record of another component, it can transform during a collection clone. For example, an existing Section 2 component can be transformed into a new Section 3 if it has a transform record. If the component is not part of the destination collection's model (in that position), it drops out, along with all of its children, unless it has a transform record to preserve it as a different component in the destination collection. Examples: In Collection A, Graphic has a transform record of Image; during the clone process, Graphic becomes Image in Collection B.

In Collection A, List has no transform records so it drops out of Collection B during clone, as does the child, Item. • Advanced Tab

• Rule Relation ID is the identifier Vasont Administrator automatically assigns to the component. This field cannot be modified. • Client Key Flag can be set to Optional, Required, Unused, or View Only to control the behavior of the client key field. • Set the Matching Criteria to Client Key, Raw Component, Client Key/Raw, or Internal id. This determines how components already present in Vasont are compared to components that are being loaded into the same collection, and whether existing content is overwritten. • Set the Valid Value Flag to Yes, Yes-Allow Override, No, or Use Alias Flag. If the component has valid values, this setting controls the level of validation. The logic to determine valid value capabilities: • If the Edit View flag is set to No then no valid values are applicable for the component. • If the Edit View flag is set to Yes or Yes-Allow Override, then the Edit View valid values will be used. • If the Edit View flag is set to Use Alias Flag, then the Alias valid value flag is used. • If the Alias Flag is set to No then no valid values are applicable. • If the Alias Flag is set to Yes or Yes-Allow Override, then the Alias valid values will be used. When a new component is added to an edit view, the default setting is Use Alias Flag. This setting may also be altered in the Batch Update window. See Alias Valid Values for more information. • Select an Editor Tag if the component is to be SGML-parsed in an external editor. To add editor tags, see Adding an Editor Tag. • Set the Validation option box to enforce a validation of untracked markup in the component's Update window in Vasont. • If set to (none), then there will be no validation of untracked markup in the Update window. • If set to XML well formed, then a validation for well formedness will be performed on the untracked markup found within the text of the component's Update window in Vasont. This means that start and end tags must match, no overlapping elements or unquoted attributes, and empty tags must close with a />.

• If set to SGML valid, then the component will be parsed when edited within Vasont. This requires the Vasont S4 parser integration.

• Select the Expand Inline Children box if the component has inline children and their content should be pulled and included in the update if the component is edited.

• Select the Automatically Add with Parent box if the component should be automatically added when its parent component is added. First specify a default relationship. In the raw component update window, Defaults tab, add the child component as a default value on the parent component. (See Creating New Raw Components—Defaults Tab.)

• Where Used Tab

• Each usage of the component is shown in the window. It allows you to easily see and navigate to other occurrences.

• Right-click on a component and select either Update or Open Navigator.

• Referenced By Tab

This tab shows a list of all pointer components that point to the Section 1 [Chapter] component. It allows you to easily see and navigate to these instances.

You can right-click on a pointer component to open the update window or Edit View Navigator to the pointer component. This allows for quick editing of the pointers.

• Preview Tab

This tab defines the Styles used for Vasont previews. It is enabled for a primary component and a sub-components (i.e., Concept, Section). • The Preview Name is a name that you assign to indicate its purpose to the Vasont users. For example, if the preview highlights components that have multiple usages or highlights conref components in the display, then you may want to name it “Reuse Preview”. • The Style is the name assigned to a Cascading Style Sheet and a Conversion Map combination. These exist in the Vasont Administrator only. • The Extract View defines a special extract view that is to be used for the preview. The extract view has processing options and settings that create the desired display for the content. • The Translation View is a check box setting that instructs a preview in Vasont to display a language selection window, followed by a preview display that substitutes the base language raw material with a selected language's raw material. For more information, see Assigning a Style for the Collection in the Creating Vasont Previews. • Review Tab

This tab defines settings used for review content. It is be enabled for a collection's primary component and select sub-components. • The Style Name field only applies to the previous version of Collaborative Review and is ignored by the current Collaborative Review tools. • The Extract View defines a special extract view that is to be used for the review. The extract view has processing options and settings that create the desired display for the content.

• The Load View defines the view to use for updating the content after the editing phase of the review. It is important to remove anything that was added to the XML during the review extract before the review content is loaded (i.e., generated text, link text, etc).

• The Automatic Update defines the loading behavior that will occur at the end of the review activity.

• Always Load: Loading always occurs at the end of a review.

• Never Load: Loading process is always bypassed meaning the review Editor needs to apply all changes manually in Vasont.

• Prompt User: In the current Collaborative Review, loading will always occur.

• (none): This is a required field. (none) exists in this column to allow a user to specify (none) for all fields, thereby removing the review record.

• The Default Due Date Setting section defines the default duration for the review due date and the edit due date when initiating a review in Vasont. The number of days defined are added to the review start date. If left blank, the default duration for the review due date will be one day from the start date, and two days from the start date for the edit due date.

• The Review Email section allows for additions to the review email that is sent at review initiation. A link or additional text entered in this section are inserted in the emails sent for the review.

For more information, see Assigning a Style for the Collection in the Creating Vasont Previews.

Locating an Edit View Component

1. From the Content Navigator, expand the collection and select Edit View.

2. Right-click the edit view in the right window and select Open Navigator.

3. Right-click a component and select Find.

Find can be selected for any component. However, Vasont starts the search process at the point in 2 the hierarchy where Search is selected and does not loop back. In order to locate exactly what you are looking for, it is a good idea to begin your Find with the primary component.

4. On the Find: Edit View window, use the drop-down arrow to choose Collection Component.

5. Use the Value drop-down arrow to choose the component to be located.

6. Click Find. The selected component is found and highlighted in the edit view window.

You can also find a specific component attribute, raw attribute, or processing option. Expanding Edit View Components 1. From the Content Navigator, expand the collection and select Edit View. 2. Right-click the edit view in the right window and select Open Navigator. 3. Right-click on a component and select Expand All.

2 If your hierarchy is very complex, this may take some time.

4. All of the component's descendants, including children and grandchildren, are displayed. Use the scroll bar on the right to view all of the data if it is not immediately visible.

Resequencing Edit View Components 1. From the Content Navigator, expand the collection and then select Edit View. 2. Right-click the edit view in the right window and select Open Navigator.

3. Right-click on a component and select Resequence→Children or Resequence→Siblings.

• The Resequence→Children selection numbers the component's children beginning with 1.

• The Resequence→Siblings selection numbers the siblings that follow the component in ascending order, using the selected component's sequence number as a starting point.

Using a Detailed Edit View

In addition to the standard edit view Navigator, a more Detailed Navigator view is also available which shows rule relation ID, attributes, processing options and their text arguments recorded in the Navigator. This eliminates the need to do an Open Update on each component to check its key settings and properties.

1. From the Content Navigator, expand the collection and select Edit View.

2. Right-click the edit view in the right window and select Open Detail Navigator.

• The Detail Edit View window displays.

• Processing options and attributes can be deleted directly from the tree view by right-clicking and selecting Delete. 2 Drag and drop is disabled.

Deleting an Edit View Component

1. From the Content Navigator, expand the collection and select Edit View.

2. Right-click the edit view in the right window and select Open Navigator.

3. Right-click the component and select Delete.

4. A pop-up message window appears. Click Yes to confirm the deletion and return to the edit view window. Click No to close the pop-up message window and return to the edit view window without deleting the component.

Load and Extract Views

Vasont uses a collection's Load View during the loading of tagged data. This view describes to the load utility the tree structure of the content being loaded. A load view ensures that tagged data is associated with the correct collection component in the edit view and usually follows an existing DTD; however, the arrangement of the collection components in Vasont may differ slightly. For example, the edit view may contain additional components not found in the tagged data, like metadata components that are edited and tracked only in Vasont. Attribute values in the tagged data might be channeled into a special field like client key or multimedia description. A element in the tagged file might be eliminated in the edit view, and its content channeled (with a load view processing option) into the text of its parent. You can then see the title as the text of the section component in Vasont Navigator, avoid- ing the need to expand the section component to see the title as a child.Nearly all load view manipulations are reversible in the extract view. When a new collection is created in Content Navigator (see Creating a New Collection), a load view is not automatically created, except when the Read DTD utility is used to create the collection (see Using the Read DTD Utility.) A collection can have more than one load view, but an edit view must exist before any load or extract views are created. Adding a New Load or Extract View1. From the Content Navigator, expand the collection, right-click on Load or Extract View, and select New. (Ex- tract View was selected for the following examples.)2. Enter data into fields on the following tabs as needed. The only required field entry is the View Description dialog box on the General tab.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 65 Building Collection Views• General• View Description: General description for the view (required.) • Document Type: For a load view, this text should exactly match what is in each SGML/XML document loaded into the collection. If a mismatch occurs, the SGML/XML document is not loaded and an error message appears. If there is no entry in this text box, the load program loads any SGML/XML document that has a compatible structure to the selected collection. For an extract view, this text box entry is applied to the extracted SGML/XML document. If an XML declaration specifies encoding, the extracted file is created in that designated encoding. If there is no entry in this text box, the extracted file will not contain a doctype declaration, and the XML file will be created in the utf-8 encoding. Some examples of what may be entered in this text box: <?xml version="1.0" encoding="utf-8"?><!DOCTYPE book SYSTEM "book.dtd"> <!DOCTYPE book SYSTEM "../../book.dtd"> <?xml version="1.0" encoding="utf-8"?> <?xml-stylesheet type="text/xsl" href="book.<a href="/tags/XSL/" rel="tag">xsl</a>" ?> <!DOCTYPE book SYSTEM "book.dtd"> • View Type: Use the drop-down arrow to select Load or Utility Extract as type of view. Set to Compo- site and Utility Extract for extract views intended for use directly from Vasont Navigator (Composite Extract.) Composite Extracts allow the user to perform the extract from the right-click Extract menu in the Vasont collection navigator. The extract is available from a primary component or a sub-component (if the sub-component and extract view are configured for sub-component extracts). Processing options are available for file naming and sub-directory creation. Utility Extracts are performed from Tools → Primary Extract menu. The extract is available for primary components in a single collection, and will allow you to extract multiple primaries at a time. Pro- cessing options are available for file naming. This type of extract does not launch an editorial application when the extract completes.66 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide• Processing Options• Right-click to Add a Processing Option related to the view.You can add a processing option using drag and drop if it is valid for the view. For example, a processing option used for an edit view component cannot be dropped on an extract 2 view component.• DTD Data (load view only) • DTD data captures components from a DTD that are not used within Vasont but may need to be preserved. This data is included when a DTD is generated with a DTD Report. • Select the DTD component: Character Entities, Comments, Parameter Entities or Untracked Elements.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 67 Building Collection Views• Right-click and select Add. Enter the text of the DTD component.• To delete a DTD component, select it, right-click, and select Delete.• Translations• Translations defined on an extract view, allow one datastring to be translated into another. This happens when extracting data from Vasont. Right-click to Add a translation pertaining to the view.• Select a translation from the pick list and click OK.• To delete a translation, select it, right-click and select Delete.• To restore a translation, right-click and select Restore.• Choose the translation to be restored from the pick list and click OK. The Update Load Component window re-displays with the value restored.This only works if a translation has been saved and then deleted without resaving.This translation has nothing to do with translating from one language to another. It is a conver- 2 sion or transformation feature.68 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide• Comments• Enter any data or remarks in the dialog box pertinent to the load and extract views. • To just view the comments for a particular extract or load view, select the extract or load view in the Content Navigator and right-click to select View Comments. If valid comments exist, this menu option is enabled and comments displayed. Otherwise, the menu option is disabled. • Advanced• View ID: Vasont-assigned identifier for the current view. This field cannot be changed. • Collection: Name of the collection associated with the view. This field cannot be changed. • Top Component: Primary, or highest-level component in the view. May be set to a lower-level component in composite extract views. • File Extension: File type used when writing the extracted file. • File Contains XML: Ensures that load is handled as XML rather than SGML or some other tagged construct. For example, files could have the SVG or UML extension, among others, but should be loaded as XML. • Sub-Component Loads/Extracts: This is a Yes/No selection, and No is default value. If set to Yes, corresponding components in the load/extract view can be loaded/extracted at their level, without the need to create separate load/extract views. • Use Versions: This feature is obsolete. • Multi-Primary File: Select if the output file can contain more than one primary element.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 69 Building Collection Views• Parse Required: Select if the file should be SGML-parsed.• Vasont Administrator Use Only: Select if the view is seen and accessed only in Vasont Administrator and not directly in Vasont (invisible to the user.)Creating a Load or Extract View from ScratchIn order to build a load or extract view, you must first add a new load view and an edit view must exist. (See Adding a New Load or Extract View.)1. From the Content Navigator, expand the collection and select Load View or Extract View. The right window is blank.2. Right-click and select New to add a load view.The New Load View window displays with the View Type default value of Load. The only required field is View Description. (See Adding a New Load or Extract View for detailed information for each tab.)3. When the new load view is created, right-click the view in the right window and select Open Navigator.70 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideThe load or extract view navigator window is blank.If the component model for the view is identical to the component model in another extract or load view, then you can bypass adding components to the new view and apply the load_oth- 2 er_view or extract_other_view processing option to the view header. The component configuration must be identical to do this, meaning that all settings, attributes, processing options and arguments must be exactly the same. For more information, see load_other_view or extract_oth- er_view in the Vasont Processing Option Guide. Example: An extract view is needed for PDF creation. The view is identical to the Editorial extract, the only difference is that the content should not be checked out during the extract. To achieve this, create a new extract view for PDF publishing. Apply the same processing options to the new view header, but leave out the check_out processing option. Instead of adding a component structure to the view navigator, add the extract_other_view processing option to the view header. The processing option argument defines the view that will be referenced for the component structure, in this case the Editorial view. Benefit: This configuration practice will eliminate the unnecessary duplication of components and therefore reduces the number of maintenance points when components require updates.4. Right-click in the navigator window and select New. The Load or Extract View Pick List appears. The left window contains valid collection components. Valid wrappers appear in the right window.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 71 Building Collection Views5. Select the component that represents the primary for the load or extract view in the left window. Select a wrapper from the right window, then click the down arrow in the center of the window to pair the wrapper and collection component. A wrapper may be chosen without a collection component.6. Click OK. The wrapper or wrapper/collection component pair is inserted into the load or extract view with certain default properties.7. Continue building the structure(s) in this fashion. As each pair is added, it becomes a child of the selected pair. The default sequence number assigned to a component pair is assumed from the Navigator Order of the collection component in the edit view. 8. When the tree structure is complete, return to each component pair, right-click and select Update to refine the default properties. The Batch Update utility process may also be used.Valid collection components that appear in the view's pick list are determined by the hierarchy (tree 2 structure) defined in the edit view for the specified collection. Creating a Load or Extract View by Cloning A load or extract view can be cloned from another load or extract view from the same collection or from another collection in the same content type. Components can then be modified as necessary. 1. From the Content Navigator, expand a collection with an existing load/extract view and select Load View or Extract View.72 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide2. Right-click the load or extract view to be cloned (the source) in the right window and select Open Navigator.3. In the left window, expand a collection with an empty load or extract view (destination), then select Load or Extract View. 4. Right-click the view to be cloned into (destination) in the right window and select Open Navigator.5. From the Window menu, select Tile Horizontal. Three windows line up horizontally: the Content Navigator, the existing load or extract view (Doc Manuals Vas 11), and the empty load or extract view (SC.)6. Select the primary component in the existing load or extract view, hold down the Ctrl key, and drag and drop it on the empty load/extract view window. The structure, components, and properties of the original load or extract view are duplicated in the new view.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 73 Building Collection Views7. Update or delete the components, as necessary, in the new load or extract view.Creating a Load or Extract View with Drag and DropCreate a load or extract view by dragging a load or extract view from the right window of Content Navigator and dropping it on the load or extract view under a collection in the same content type in the left window of the Content Navigator. A new view is created based on the view that was dragged, and on the content of the edit view of the destination collection. The advantage to this method is that it automatically brings along other data, such as document type.The newly created view has the same description as the source view. You should change the description of the new view to distinguish between the two.You may need to click on another label in the collection and then click back to the Load or Extract 2 View label to refresh the display and reveal newly created view. Creating a Load View Using the Read DTD UtilityA basic load view is created along with the edit view, raw components, attributes, and wrappers when the Read DTD or Read Schema utility is used. (see Using the Read DTD Utility). Updating a Load or Extract View1. From the Content Navigator, expand the collection and select Load View or Extract View.2. Right-click the view in the right window and select Update.3. Update the fields on any of the tabs as described in the Adding a New Load or Extract View section.Deleting a Load or Extract View1. From the Content Navigator, expand the collection and select Load View or Extract View.74 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide2. Right-click the view in the right window and select Delete.A pop-up message window asks for confirmation of the delete action.If the view selected for deletion is used in the Auto-Publishing configuration, a warning message 2 displays stating that references to the view should be removed before the view is deleted.3. Click Yes to confirm the deletion or No to dismiss the pop-up and return to the Content Navigator window. Adding a Load or Extract View Component 1. From the Content Navigator, expand the collection and select Load View or Extract View. 2. Right-click the view in the right window and select Open Navigator.A load or extract view must exist before a component can be added. (See Adding a New Load or 2 Extract View.)VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 75 Building Collection Views3. If the view is blank, right-click and select New. If wrapper/component pairs already exist, right-click on a collection component/wrapper pair and select New (the new component pair becomes a child of the selected pair.)4. The Load or Extract View Pick List appears. The top left window contains valid collection components. Valid wrappers appear in the top right window. 5. Select a component in the left window, select a wrapper from the right window, then click the down arrow in the center of the window to pair the wrapper and collection component. A wrapper may be chosen without a collection component.6. Select as many pairs as needed, then click OK. A wrapper or wrapper/collection component pair is inserted into the load or extract view with certain default properties. Right-click and select Update if any changes are required. (See Updating a Load or Extract View Component.) Updating a Load or Extract View Component Much of the power of Vasont is controlled by properties associated with the components in the views. Each load or extract view component consists of four types of data that can change its behavior. These include general data, attributes, processing options and translations.76 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide1. From the Content Navigator, expand the collection and select Load View or Extract View. 2. Right-click the appropriate view in the right window and select Open Navigator.3. The load or extract view displays. 4. Right-click on any component in the load or extract view window and select Update. The following tabs are shown on the update window. • General• Tag: Select a wrapper. • Component: Select a collection component (or set to none.) • Wrapper Flag: Choose: Standard wraps actual collection component content. Pure wraps other wrappers. File is an outermost wrapper that surrounds a group of primary collection components. • Placement: Specify placement of the wrapper relative to its parent wrapper: Before: child component placed before its parent when loaded or extracted in Vasont Nested Before: child component nested before the text of its parent Inline: child component can occur anywhere among the text of its parent Nested After: child component nested after the text of its parent After: child component placed after its parent when loaded or extracted in Vasont • For example if a DTD (load view only) contained the following line: (term, def)+VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 77 Building Collection ViewsThese components would have to be given the same Sequence Number and Navigator Order and would display as siblings in Vasont. Therefore, no relationship would be established between a Term and its associated Def, especially when multiples occur: Term Def Term Def Term Def However, if Def is made a child of Term in Vasont Administrator, and if the placement of Def is set to After, each Def displays as a child of its associated Term in Vasont, but loads and extracts as a sibling to conform to the DTD. Term Def Term Def Term Def • Sequence Number: The position of the wrapper among its siblings. Sibling wrappers with the same Sequence Number are interchangeable. • Sub-Component Load/Extract: No is the default value. If set to Yes, corresponding components in the load/extract view can be loaded/extracted at their level, without the need to create separate load/extract views. • Wrapper Relation ID: Unique identifier to define a parent/child wrapper (tag) relationship. • Alias Attributes: Opens the Alias update window in order to allow you to view or update the alias attributes.In order to view a complete listing of all the attributes that are being used on a component, 2 click the Alias Attributes button and, with the window remaining open, click on the Attrib- utes tab on the component's update window.• Attributes78 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide• Right-click and select Add to add apply an attribute to the alias. (Another method is to drag it from another component's attributes tab and drop it here. The attribute brings along its valid values, default value, and occurrence rule.)• Choose an attribute from the pick list and click OK.• To apply a Processing Option to an attribute, select the attribute, right-click and choose Processing Op- tions.• The Update Load/Extract Component window displays.• Right-click and select Insert, Add, Delete, or View Description.• To Add, choose a processing option from the pick list and click OK. The update window reappears with the processing option added. Update the Text Argument, if necessary.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 79 Building Collection Views• Processing Options• You can Insert, Add, Delete, or View Description. • To add a Processing Option, right-click in the window and select Add.The Processing Options Pick List displays. • Select a processing option and click OK. The processing option is added to the component. • The processing option window has three columns: Processing Option (name of option), Event (event during which the option activates), and Text Argument. Processing options may have one or more arguments, although some do not have any. Arguments are defined in two different manners: the text arguments of older processing options must be entered as a text string in the window; newer processing options use a separate window as described in the next step. • To access the argument(s), select the processing option, right-click and select Update Arguments. • To delete (remove) or view the description for a processing option, right-click and select Delete or View Description. • If you select Delete, the processing option is removed from the tab. • If you select View Description, you will see a window containing the description.80 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide• Processing options can also be added using drag and drop from another component's Processing Options tab. Processing options must be valid for the context in which the you place them. • Translations• Right-click to Add a Translation pertaining to the view. • Select a translation from the pick list and click OK. The Update Load Component window displays with the translations value added. • To delete a translation, select it, right-click and select Delete. • To restore a translation, right-click and select Restore. • Click the desired value on the Translation Pick List, and then click OK. The Restore window displays. Click OK. • The Update Load Component window re-displays with the value restored.This procedure works only if a translation has been saved and then deleted without resav- 2 ing.)This translation has nothing to do with translating from one language to another. It is a con- 2 version or transformation feature.Deleting a Load or Extract View Component 1. From the Content Navigator, expand the collection and select Load View or Extract View. 2. Right-click the appropriate view in the right window and select Open Navigator.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 81 Building Collection Views3. Right-click the component and select Delete.4. Click Yes to confirm the deletion or No to dismiss the message and return to the load or extract view window.Locating a Load or Extract View Component1. From the Content Navigator, expand the collection and select Load View or Extract View.2. Right-click the view in the right window and select Open Navigator.3. Right-click the primary component and select Find.4. Select a Collection Component using the Component drop-down menu, and then select the component to be located using the Value drop-down menu.5. After selections are complete, click Find. The selected value is highlighted in the load view window that displays.It's also possible to find a specific component attribute, raw attribute, or processing option.Expanding a Load or Extract View Component1. From the Content Navigator, expand the collection and select Load View or Extract View.82 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide2. Right-click the view in the right window and select Open Navigator.3. Right-click on a component and select Expand All.The load or extract view window re-displays with all of the component's data expanded, i.e., children, grandchildren, etc.Detailed Load or Extract ViewIn addition to the standard extract or load view Navigator, a more Detailed Navigator view is also available. This Navigator view shows wrapper relation ID, attributes, processing options and their text arguments, eliminating the need to do an Open Update on each component to check its key settings and properties.1. From the Content Navigator, expand the collection and select Load View or Extract View.2. Right-click the view in the right window and select Open Detail Navigator.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 83 Building Collection ViewsThe Detail Load View window displays with all of the component's detailed data expanded.3. Attributes and processing options can be deleted directly from the tree view by right-clicking and selecting Delete. 2 Drag and drop is disabled.Importing a Load or Extract ViewAn Extract or Load view can be exported from Vasont and then imported into another Vasont schema. A common reason for doing this would be to develop and test these views in one Vasont schema and then transfer it to another Vasont schema. For example, development of an Extract View may be done in a Development environment and then moved into a Production environment.In order to perform an Import the corresponding Edit View of the exported collection must match the Edit View of the collection being imported into. This is necessary because Extract and Load views contain direct references to Edit View components.It is important that the software version of the schema that you are importing into is at the same version of the Vasont software as the schema where the export file was created.1. Choose Import → Load/Extract View from the menu.2. The user will then be prompted to pick a file. This would be an XML file that was created from exporting a Load or Extract View process.84 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide3. Click Yes to bypass the import of processing options.4. Next the user will be prompted for which collection to import the view.5. Click Yes to continue with the import into the specified collection. Click No to select a different collection.Once the collection is chosen and the user clicks OK the process will begin. After the process completes, a message box will display informing the user whether the process completed successfully. If there are any errors the message will describe the issue. Below is an example of the message a user will receive when the process completes successfully.There may be processing option arguments that need updated for the new location of the imported view. If a log file was created during the import, check the log file for processing options that were 2 reported during the import.Exporting a Load or Extract View 1. From the Content Navigator, expand the collection and select Load View or Extract View.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 85 Building Collection Views2. Right-click the appropriate view in the right window and select Export.3. The Select File to Save window displays. Enter the Path and File Name for the exported data. 2 The assigned file extension is .xml and cannot be changed.4. Click Save to export the data and return to the Content Navigator window. 2 Editing the XML file outside of Vasont is not supported at this time.86 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide Refining the Basic StructureThis chapter provides information for altering or deleting the settings on the basic pieces that make up a collection view. Some sections provide instructions for individual updates, while other sections provide instructions for batch updates. You will gain an understanding of the steps involved with making changes to: • Attributes • Raw Components • Aliases • Wrappers • Content Types • Collection Groups • CollectionsAttributes Attributes are additional pieces of information for a component. This includes attributes from a DTD, but can also be metadata attributes that are strictly used by Vasont for special behaviors. Updating an Attribute Attributes may be applied to raw components, aliases, or to collection components. When applied to collection components, they become part of that collection's load, edit, and/or extract views. Attributes may be applied selectively or to all three views. If an attribute is applied only to the edit view, it can be added, changed, or used for searching within Vasont, but it is never extracted or loaded. To update an attribute: 1. From the Content Navigator, double-click a content type to expand the data and select Attributes. Existing attributes display in the right window. 2. Right-click the Attribute and select Update.3. In the Update Attribute window, you can modify attribute name, SGML type, or description. 4. Complete the updates and select Save or Close to exit without taking any action and return to the main Content Navigator window. 5. Click Close on the main toolbar to exit the Content Navigator window.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 87 Refining the Basic StructureUpdating an Alias Attribute There are two ways that you can update the attributes on the alias. One way is from the Alias Update window and the other is from the Where Used window. Updating from the Alias Update Window 1. From the Content Navigator, double-click a content type to expand the data and select Aliases. Existing aliases display in the right window. 2. Right-click the Alias and select Update.3. In the Update Alias window, select the Attributes tab. Right-clicking on an entry will allow you to add, update or delete the attribute that is applied to the Alias.4. Complete the updates and select Save or Close to exit without taking any action and return to the main Content Navigator window. Updating from the Attribute Where Used window. 1. From the Content Navigator, double-click a content type to expand the data and select Attributes. Existing attributes display in the right window. 2. Right-click the Attribute and select Where Used.88 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide3. On the Attribute Filter, select at least one collection to search for uses of the attribute. Click OK. 2 In the collection drop-down list, only collections the user has the right to access will be visible.4. On the Attribute Where Used window select the Alias tab.5. Right-click on an entry and select Update to open the Alias Update window.6. Complete the updates and select Save or Close to exit without taking any action and return to the Where Used window. Deleting an Attribute If the attribute is associated with a raw component or a collection component and has associated data (values assigned), it cannot be removed until the attribute data is deleted. Delete the attribute data by using Vasont to locate all collection entries or raw material entries that have values for that attribute, then delete each attribute instance. If the attribute is associated with a collection component but has no associated data, you must first remove it from all collection views. Locate and delete all usages by performing the following steps: 1. From the Content Navigator, expand a content type and select Attributes. Existing attributes display in the right window.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 89 Refining the Basic Structure2. Right-click the Attribute and select Where Used.3. On the Attribute Filter, select one or more collections to search for uses of the attribute. Click OK. 4. The Attribute Where Used window displays. a. Edit View shows the collection component associated with the attribute, followed by its parent component in brackets. The collection is listed for each usage, along with the attribute's ID. b. Extract View shows the extract view description and the collection. The wrapper associated with the raw component is shown, followed by its parent wrapper in brackets. IDs for the wrapper relation (parent/child wrappers) and the view also display. c. Load View shows the load view description and the collection. The wrapper associated with the raw component is shown, followed by its parent wrapper in brackets. IDs for the wrapper relation (parent/child wrappers) and the view also display. d. Raw Component shows the applicable raw component, content type and ID data for the attribute, along with the default value and the value (raw component) data. e. Alias shows the aliases where the attribute has been applied. The list displayed shows all aliases that the attribute has been applied to regardless of the collection that the user may have chosen in the attribute filter in step #3. Knowing this information can allow you to save time editing information about this attribute. If the attribute is on the alias, it may cover with one update all the individual components that use the attribute across collections (See Alias Attributes for more info). f. Task shows applicable uses for the attribute for any workflow task that has the attribute applied. g. Project shows workflow projects where the attribute has been applied. 5. To delete, select a tab to display the usages. 6. Select a single usage or hold the Shift key and select several usages.90 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide7. Right-click on the highlighted usage(s) and select Delete. The usage(s) is automatically deleted from the selected view.If the attribute is applied to raw components, you must perform the following steps to perform the delete action. 1. Click X to close the Attribute Where Used window and return to the main Content Navigator window. 2. Double-click content type in the left window to expand the data. Click Raw Components. Existing raw components display in the right window. 3. Right-click the applicable Raw Component and select Update. 4. On the Update Raw Component window, click the Attributes tab. 5. Right-click the raw component and select Delete. 6. After completing the delete actions, click X. 7. On the confirmation pop-up message, click Yes to save the change or No to exit without taking any action and return to the main Content Navigator window. After the attribute is cleared of data and removed from all collections and/or raw components, delete the attribute as follows: 1. Click Content Nav on the main toolbar. 2. In the left window, double-click a content type to expand the data and select Attributes. Existing attributes display in the right window. 3. Right-click the Attribute and select Delete.4. On the confirmation pop-up message, click Yes to confirm the deletion or No to abort the action and return to the main Content Navigator window.Deleting an Alias Attribute1. From the Content Navigator, double-click a content type to expand the data and select Aliases. Existing aliases display in the right window.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 91 Refining the Basic Structure2. Right-click the Alias and select Update.3. In the Update Alias window, select the Attributes tab.4. Select Delete from the pop-up menu.5. Click Save to save the changes or click Close to exit without taking any action and return to the main Content Navigator window.When deleting an alias attribute, the logic allows the deletion if data exists and the corresponding 2 Edit View component has the attribute defined. For example, assume a user was trying to delete the “translate” attribute from the alias “Paragraph” and that there is data in Vasont for the translate attribute on Para [Section] in the Manuals collection. If the Administrator has the “translate” attribute defined in Administrator on the Para [Section] Edit View component in the Manuals collection, then the alias attribute would be allowed to be deleted.If data is found on at least one component type that does not have a corresponding Edit View definition then the following message is displayed.One option for removing this alias attribute is to delete the corresponding attribute data in Vasont. An alias attribute can also be removed if there is an attribute definition on the Edit View components that contain data in Vasont.92 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideRaw Components Raw Components are the basic building block of a Vasont collection. Raw components may be compared to elements in a DTD. They are defined in the content type and can be used to build multiple collections. Updating a Raw Component Raw Components are building blocks assembled in different views to constitute a collection. They may be general or specific in nature. Once assembled in a collection, Vasont Administrator provides the capability to update various data elements, including but not limited to, the name, description, and raw class. 1. Click the Content Nav button on the main toolbar. 2. Double-click the content type in the left window to expand the data and select Raw Components. Existing raw components display in the right window. 3. Right-click the Raw Component and select Update. The Update Raw Component window has six tabs: Gen- eral, Aliases, Attributes, Defaults, Advanced, and Translations. 4. Use the General tab to change the component name and the description for the raw component.The Raw Class dialog box is disabled. This data was entered when the component was first created and cannot be updated. Click Where Used to check in which view (edit, load, or extract) a 2 raw component is used.5. Use the Aliases tab to update alias names. Right-click and select an action.6. Use the Attributes tab to update attributes. Right-click and select Update.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 93 Refining the Basic Structure2 Attributes added at this level are global in nature.Select Update to display the Update Raw Component window. a. Use the General tab to update the Default Value and Value (Raw) for the attribute. A default value is one that is automatically assigned if no value is entered for the attribute. If you choose a raw value, you must pick the attribute value from a list of raw material based on the raw component specified here.94 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide b. Use the Values tab to update Valid Values. c. Use the Occurrences tab to update the Occurrence Rule and Group Number for the attribute. This is a required field. d. When all updates are complete, click X to close the window. The main Update Raw Component window is still visible and you can continue the update process. 7. Use the Defaults tab to update the default relationship. Right-click to select insert, add, or delete.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 95 Refining the Basic Structure8. On the Advanced tab: a. You can pick Not Allowed, Optional, or Required from the text dialog drop-down list to indicate the requirement of textual content for the raw component. b. Use the Data Type drop-down list to select Text or Number. c. Use the Global Change drop-down list to select Never, Always, or Pick List. d. Select an Editor Tag from the drop-down list to SGML-parse the raw component in an external editor. e. Select the Parse SGML box to SGML-parse the raw component when edited within Vasont. f. Click X to close the window. Click Yes on the confirmation pop-up message to save your changes. (You can also click Save and Close on the main toolbar to bypass the pop-up message.) Regardless of the selection, you return to the main Content Navigator window. 9. Use the Translations tab to update language relationships. Right-click to select insert, add, or delete. This option applies to a specific Vasont client configuration. Most Vasont clients use an alternative translation configuration. See Building a Translation Setup for more information. 10. Click Where Used on the Update Raw Component window at any time to determine if a component already exists in any edit, extract, or load view.Deleting a Raw Component If the raw component you want to delete is already part of a collection and has associated data, it cannot be deleted until the data itself is removed. Delete the data by using Vasont to locate all collection entries for that raw component type, and then delete each instance. If the raw component you want to delete is part of a collection but has no data associated with it, you must first remove it from all collection edit views. Locate and delete the raw component by performing the following steps: 1. Click the Content Nav button on the main toolbar.96 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide2. Double-click the applicable content type in the left window to expand the data and select Raw Components. Existing raw components display in the right window. 3. Right-click the Raw Component and select Where Used.4. On the Raw Type Filter, select one or more collections to search for uses of the raw component. Click OK. 2 In the collection drop-down list, only collections the user has the right to access will be visible.5. The Raw Component Where Used window displays. The window has three tabs: Edit View, Extract View, and Load View.Edit View shows the uses of the raw component for any collection within the current content type. You see the collection component associated with the raw component, followed by its parent component in brackets. The collection component name may be the same as the raw component, or it may be an alias. The collection is also listed for each usage, along with the raw component's ID. Extract View shows the uses of the raw component for any collection within the current content type. It is not necessary to remove any usages shown on this tab. They are automatically removed when they are deleted from the edit view. Load View shows uses of the raw component for any collection within the current content type. It is not necessary to remove any usages shown on this tab. They are automatically removed when they are deleted from the edit view. 6. After reviewing/checking all usages, click the Edit View tab and then click to select a usage.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 97 Refining the Basic Structure7. Right-click and select Open Navigator.8. A navigator Edit View window opens with the raw component usage highlighted. • If a top-level usage is being removed, the navigator opens with the top-level selection highlighted.• If a sub-level usage is being removed, the navigator opens with the data expanded and the raw component you want to delete already highlighted.9. Right-click the component and select Delete. 10. Repeat the process from Step 8 to delete additional usages. When all usage data has been removed from all collections, perform the raw component delete as follows: 1. Click Content Nav on the main toolbar. 2. In the left window double-click the applicable content type to expand the data. Click Raw Components. Ex- isting raw components display in the right window.98 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide3. Right-click the Raw Component you want to delete and select Delete.4. Click Yes to confirm the deletion, or No to abort the action. You return to the main Content Navigator window regardless of the selection. 5. When you complete all delete actions, click Close on the main toolbar to exit the Content Navigator window.Aliases Aliases are another name for an existing raw component. Each raw component has at least one alias by default, but you may add more alias names to a raw component as needed. For more information, see Creating New Aliases. To alter the name of an alias or remove an alias, see the Alias tab in Updating a Raw Component. To alter or remove the attributes on an alias, see Updating an Alias Attribute or Deleting an Alias Attribute. Updating or Deleting Alias Valid Values 1. Click the Content Nav button on the main toolbar. 2. Double-click the content type in the left window to expand the data and select Aliases. Existing aliases display in the right window. 3. Right-click the Alias and select Update. The Update Alias window has three tabs: Alias, Attributes, and Valid Values. 4. The Alias tab mostly contains information derived from the raw component to which the alias is associated.The Valid Value Flag can be altered on this window and has three values; Yes, Yes-Allow Override, and No. • Yes: means that the user must pick one of the valid values when creating the component in Vasont. • Yes-Allow Override: means the user is permitted to enter a value other than one of the valid values listed when creating the component in Vasont. Click Where Used to determine if the alias already exists in any edit, extract, or load view.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 99 Refining the Basic Structure5. Use the Valid Values tab to update the assigned values. Right-click to select insert, add, or delete.Wrappers Wrappers link SGML/XML tagged data to components. By having wrappers, Vasont can store a tag once and reuse it thousands of times. Updating a Wrapper Vasont Administrator uses tag neutral technology which means Wrappers are defined for items instead of tags. Many export versions can be defined for a particular setup, which allows output to be generated independent of a tagging scheme. To check on and update the usage of a wrapper within Vasont Administrator: 1. Click the Content Nav button on the main toolbar. 2. Double-click a content type in the left window to expand the data and select Wrappers. Existing wrappers display in the right window.3. Right-click the Wrapper you want to update and select Update. 4. Use Update Wrapper to update the names in the dialog boxes of the begin and/or end tags.100 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide5. Click X. 6. On the confirmation pop-up message, click Yes to save the change(s) or No to exit without taking any action. You return to the main Content Navigator window. 7. When all update actions are complete, click Close on the main toolbar to exit the Content Navigator window. Deleting a Wrapper Wrapper data can be a part of an edit view, a load view, or an extract view. If it is, you must first remove the usage from these views before you can delete the wrapper from the Content Navigator. To locate and remove the usages: 1. Click the Content Nav button on the main toolbar. 2. Double-click a content type in the left window to expand the data and select Wrappers. Existing wrappers display in the right window. 3. Right-click the Wrapper you want to delete and select Where Used. a. On the Wrapper Filter, select one or more collections to search for uses of the attribute. Click OK.In the collection drop-down list, only collections the user has the right to access will be visi- 2 ble. b. The Wrapper Where Used window displays. It has three tabs: Edit View, Extract View, and Load View. i. Edit View does not contain any usage information for a wrapper. ii. Extract View shows usages of the wrapper for any collection within the current content type. You must delete the usage from this tab prior to deleting the wrapper from the main Content Navigator window. iii. Load View shows uses of the wrapper for any collection within the current content type. You must delete the usage from this tab prior to deleting the wrapper from the main Content Navigator window. 4. After you check the usages on the Extract and Load Views, continue the process. Deleting a usage from either view is exactly the same, and extract view is used in the following examples:VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 101 Refining the Basic Structure a. Right-click the usage you want to delete and select Open Navigator. b. An Extract View navigator window opens with the usage highlighted. Right-click and select Delete. The usage is automatically deleted from this view. c. Repeat the process for both views until all applicable usages have been deleted. 5. When all usage data has been removed from all collections, perform the wrapper delete as follows: a. Click Content Nav on the main toolbar. b. Double-click the content type to expand the data and click Wrappers. Existing wrappers display in the right window. c. Right-click the Wrapper you want to remove and select Delete.6. On the confirmation pop-up message, click Yes to confirm the deletion or No to abort the delete. With either selection you return to the main Content Navigator window. 7. When all actions are complete, click Close on the main toolbar to exit the Content Navigator window.Content Types Content Types are a set of related Vasont collections that share the same raw components, attributes and wrappers.102 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideUpdating a Content Type Name 1. Click the Content Nav button on the main toolbar. 2. Click to select the content type you want to change. 3. Right-click and select Update. 4. Edit the Name of the content type in the Update content type window and then click X. 5. Click Yes on the pop-up message to save the data. 6. Click Close on the main toolbar to exit the Content Navigator window. Deleting a Content Type 1. Click the Content Nav button on the main toolbar. 2. Click to select the content type you want to delete. 3. Right-click and select Delete. 4. Click Yes to complete the process. 5. Click No to exit the warning message without taking any action. 6. Click Close on the main toolbar to exit the Content Navigator window.Collection Groups Collection Groups are used to help organize logical groupings of collections. Collection Groups are optional in a Vasont setup. Updating a Collection Group Vasont Administrator not only provides the capability to group a set of collections within a content type, it also provides a procedure for updating a collection group once it has been created. 1. From the Content Navigator, click the Collection Group you want to update.2. Right-click and select Update.3. On the Update Collection Group window, edit the name of the collection group.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 103 Refining the Basic Structure4. Click X. 5. On the confirmation pop-up message, click Yes to save the change. The main Content Navigator re-displays showing the update. 6. Repeat the process to perform additional updates, or click Close to exit the Content Navigator window. Deleting a Collection Group Collection groups are used to group a set of collections within a content type. If an existing collection group is no longer required, remove it by performing the following: 1. From the Content Navigator, select the Collection Group, right-click and select Delete2. A Warning message appears.Click Yes to confirm the deletion. The Content Navigator window re-displays and the Collection Group no longer appears under the content type. Click No to abort the delete action and return to the main Content Navigator window. 3. When all delete actions are complete, click Close on the main toolbar to exit the Content Navigator window.Collections Collections are groupings of similar content that share the same content model. Finding Collections In the Content Navigator, selecting Collections will cause the right window pane of the Navigator to display an alphabetical list of all collections in the system. By right-clicking on any collection in the list and selecting Go To will place the cursor in the exact location where the definitions exist for the selected collection.Only collections the user has the right to access will be visible in the collection list.104 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideThe list can be re-sorted by any of the columns by clicking on the desired heading. Updating Collection Settings Once a collection has been created, Vasont Administrator provides a procedure for updating the settings. 1. Click the Content Nav button on the main toolbar. 2. In the left window, expand a content type by clicking the plus (+) sign. 3. Right-click the collection and select Update. The Update Collection window displays.• Use General to change the collection name or the abbreviation. • Use Comment to enter any updated data or remarks pertinent to the collection. • Use Refining Collections to define the collections that the selected collection may related to when performing a refine in Vasont. Refine is a way to further limit content that has been retrieved into a collection navigator. The content is narrowed down relative to the data in the refining collection which is related to the base collection you are looking at. See Refining the Vasont Navigator in the Locating Content chapter of the Vasont User Guide for more information on using Refine. For more information on configuring Refine, see Defining Refine Collections. • Use Advanced to change edition, production date, language and site. • Use the Types tab to change special behaviors that are applied at the collection level. Right-click in the window and select Add and choose one or more values from the list. To remove an entry, right-click on the entry and select Delete.If you choose to delete an entry and it is being used by the Auto-Publishing configuration, you 2 will receive a message stating that the entry cannot be deleted until all references to it are removed from the Auto-Publishing configuration.4. Click Save and Close. Deleting a Collection Collections can be deleted from a content type, but first you must delete all data associated with the collection. Then use the following procedure to delete the collection. 1. Click the Content Nav button on the main toolbar. 2. Double-click the appropriate content type. 3. Right-click the collection and select Delete. 4. On the confirmation pop-up message, click Yes to confirm the deletion.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 105 Refining the Basic StructureDefining Refine Collections Refine queries are performed in Vasont after the navigator is populated using a Retrieve query. The Refine query allows you to further pare down the primaries in the Navigator based on additional criteria. The real power of the Refine query is exhibited with modular content and the ability to refine based on relationship with the modular content. When working with modular content, each collection participating in the modular content scenario can be configured to define the Refining Collections. These definitions are created on the collection's update window. 1. Click the Content Nav button on the main toolbar. 2. In the left window pane, expand a content type by clicking the plus (+) sign. 3. Right-click the collection and select Update. The Update Collection window displays. 4. Select the Refining Collections tab. Check off the collections that you would like to be available when performing a refine query in Vasont. Consider the following DITA configuration example:The DITA Maps collection references content in the Concepts, References, Tasks and Topics collections. The Concepts, References, Tasks and Topics collections reference graphics in the Images collection.Based on this example definition, the Vasont Navigator for the DITA Maps collection can be refined using criteria from the related Topics, Tasks, References, Concepts and/or Images collections. Refining collections would similarly be defined for the other collections in the scenario.The Refining Collections tab in the collection update window shows all collections that are rela- 2 ted to the current collection directly, or by extension, based on Vasont pointers. It is up to you to determine which collections make best sense for refine query usage.5. After making your selections, click Save and Close.106 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide6. On the confirmation pop-up message, click Yes to save the change. Updating and Deleting ComponentsFor instructions on Updating an Edit View Component, see Updating an Edit View Component.For instructions on Deleting an Edit View Component, see Deleting an Edit View Component.For instructions on Updating a Load or Extract View Component, see Updating a Load or Extract View Component.For instructions on Deleting a Load or Extract View Component, see Deleting a Load or Extract View ComponentMerging Components from One View to Another ViewThe Collection Merge Utility allows setup information from one collection view to be copied into another view. The merge includes components that exist in the source view, but not in the target view, as well as modifications to already existing components in the target view.This utility only performs additions and will not delete components in the target view if they do not 2 exist in the source view.Before using this utility you should do some analysis to get an idea of the level of changes that will occur to the target view, as well as after the merge to confirm the results. The Compare Components, Compare Processing Op- tions, and Compare Attributes reports will help you locate differences in the source and target views.Each view must be processed individually between the source and target collection. It is up to you to determine what source/target view pairs make sense. For example, you would not want to run this utility against a source extract view for publishing and a target extract view for previewing. The processing options and attributes on the components most likely differ and could cause undesirable results in the preview extract view (i.e., use of the ref_ex- tract_file processing option versus ref_extract processing option).It is a good idea to run basic view reports or processing option reports to have a history of what the 2 view looked like prior to the merge. You can print these reports or save an electronic copy of them (i.e., Excel or PDF).You may also want to duplicate the extract or load view prior to a merge and hold it as a temporary copy. This will serve as a backup if the merge process doesn't go as planned and you need to revert back to the previous component structure. The backup copy can be used to copy the lower-level components back to the original extract or load view if necessary. Contact your Vasont support leader if you need instructions on how to put the backup component structures into the original view.Another use for this tool is to update your production system with configuration information from your test system (i.e., upgrading from DITA 1.1 to DITA 1.2). This can be done by performing configuration changes in the test environment and validating that all changes are appropriate and working correctly. Then, the collections or select views can be exported using Exporting a Load or Extract View and imported (Importing a Load or Extract View) into the production system. This will create temporary collections and views, simply for the purpose of upgrading your existing collection views. The temporary collections and views are used as the source when running the Merge Utility. Once the merging process has completed, the temporary collections and views can be deleted from the production system.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 107 Refining the Basic StructureCopying changes from system to system only works well when the raw components and attributes in 2 both the test system and the production system are identically defined, meaning that their types are the same. For example, a Chapter component in both systems is defined as a text component, instead of one system where a Chapter is a text component and in the other system it is a pointer component. If this is true of any component, attribute, or other building blocks between the two systems, undesirable results will occur when the merge is performed.Using the Edit View Merge Utility Before running the merge utilities you should understand what will happen during the process so that you achieve expected results. When the Edit View Merge utility is run, the following logic will evaluate and take action according to these items: • Component Copy There are two types of component copy processes for adding a new component to a target view: 1. Component Copy from Target View Process A search is performed to see if the component in the source edit view exists in the target edit view. If it does exist and the “Inline” setting is the same for both components, then the component in the target view will be copied to the new location (as defined in the source view). 2 The Inline setting is found on the edit view component's Update window, on the Inline tab.This process is for situations where an existing component in the target view needs to be added under another parent component. Copying the component from the target view, rather than the source view, means that all settings that are being used for the component in the target view will be consistent. An example for a component copy is when the Abbreviated-Form component is found as a child component of Abstract in the source view, but not in the target view. In the target view, Abbreviated-Form component already exists, but as a child of the Paragraph component. In order to have the Abbreviated-Form component added as a child component of Abstract in the target view, it will be more efficient to copy the existing Abbreviated-Form under Paragraph in the target view to the Abstract location in the target view. This ensures that the new Abbreviated-Form component has the settings that are desired for it in the target view. In order for this to happen, the Abbreviated-Form inline setting must be the same (for the existing component in the target view that will be copied and the new component that needs to be created).2. Component Copy from Source View Process108 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideWhen the component exists in the target edit view, but does not have the same Inline setting, then the component in the source view will be copied to the new location in the target view. When the component does not exist in the target view, then the component will be copied from the source view. When a copy of a component is performed the following items are included in the copy action: • Edit view component • Processing options on the component, including any arguments • Attributes on the component, including valid values and occurrence rules • Occurrence rules • Valid values • Pointer definitions • Global change settings • Transform settings • Component Overlay from Source View Process When edit view components in the source view already exist in the target edit view, then an evaluation of component settings will be performed. Any settings that exist on the source component, but not on the target component, will be copied to update the target component. When a component overlay occurs, the following items are included in the overlay action: • Navigator order • Match criteria • Occurrence rules • Attributes, according to the following rules:Source Target Alias At- Attribute Attribute tribute Results Exists Exists Exists Yes Yes Yes Update attribute with valid values and occurrences from source to target. Yes Yes No Update attribute with valid values and occurrences from source to target. Yes No Yes Copy attribute from source to target. Yes No No Copy attribute from source to target. No Yes Yes Remove attribute from target. No Yes No Maintain target attribute.Performing an Edit View Merge 1. Go to Utilities → Collection Merge → Merge Edit View. 2. Choose a Content Type. If only one Content Type exists in the system, then it is automatically displayed. 3. Choose a Source Collection from the drop-down list. 4. Choose a Target Collection from the drop-down list.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 109 Refining the Basic StructureOnly collections that have a matching primary component will be available in the Target Collec- 2 tion drop-down list. The Target Collection cannot be the same as the Source Collection.5. The lower pane of the window will display components that exist in the source collection, but are not in the target collection. These are the components that will be added into the target collection when the merge process is initiated. Review the components in the list to determine whether or not you want to proceed. If there are any components in the list that are not appropriate for the target view, you should close the window and consider other options for updating the components in the target view.6. Click Merge. 7. A confirmation window will appear, asking you if you are ready to begin the merge process. Click OK to proceed, or Cancel to exit without any changes. 8. A message will display when the process has completed. Click OK. 9. Click Close to dismiss the utility window. 10. Use the Comparison Reports to evaluate the results. Using the Extract or Load View Merge Utility Before running the merge utilities you should understand what will happen during the process so that you achieve expected results. When the Extract or Load View Merge utility is run, the following logic will evaluate and take action according to these items: • Wrapper Copy There are two types of wrapper copy processes for adding a new wrapper to a target view: 1. Wrapper Copy from Target Process A search is performed to see if the wrapper in the source view exists in the target view. If it does exist and the “Placement” setting is the same for both wrappers, then the wrapper in the target view will be copied to the new location (as defined in the source view).The Placement setting is found on the extract or load view wrapper's Update window, on the 2 General tab.See Using the Edit View Merge Utility for an example. 2. Wrapper Copy from Source Process110 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideWhen the wrapper exists in the target view, but does not have the same Placement setting, then the wrapper in the source view will be copied to the new location in the target view. When the wrapper does not exist in the target view, then the wrapper will be copied from the source view. When a copy of a wrapper is performed the following items are included in the copy action: • Extract or Load view wrapper • Processing options on the wrapper, including any arguments • Attributes on the wrapper, including processing options and arguments • Extract or Load view translations • Wrapper Overlay from Source View Process When an extract or load view wrapper in the source view already exists in the target view, then an evaluation of the wrapper settings will be performed. Any settings that exist on the source wrapper, but not on the target wrapper, will be copied to update the target wrapper. When a wrapper overlay occurs, the following items are included in the overlay action: • Sequence number • Attributes, according to the following rules:Source Target Alias At- Attribute Attribute tribute Results Exists Exists Exists Yes Yes Yes Maintain target attribute and any associated processing options. Yes Yes No Maintain target attribute and any associated processing options. Yes No Yes Copy attribute from source to target including processing options. Yes No No Copy attribute from source to target including processing options. No Yes Yes Remove attribute from target if no processing options applied. No Yes No Maintain target attribute and any associated processing options.Performing an Extract or Load View Merge 1. Go to Utilities → Collection Merge → Merge Extract View or Merge Load View. 2. Choose a Content Type. If only one Content Type exists in the system it is automatically displayed. 3. Choose a Source Collection and Source View from the drop-down lists. 4. Choose a Target Collection and Target View from the drop-down lists.Only collections that have a matching primary wrapper will be available in the Target Collection 2 drop-down list. The Target Collection may be the same as the Source Collection, but the Target View may not be the same as the Source View selection.5. The lower pane of the window will display wrappers that exist in the source collection, but are not in the target collection. These are the wrappers that will be added into the target collection when the merge process is initiated. Review the wrappers in the list to determine whether or not you want to proceed. If there are any wrap-VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 111 Refining the Basic Structure pers in the list that are not appropriate for the target view, you should close the window and consider other options for updating the wrappers in the target view.6. Click Merge. 7. A confirmation window will appear, asking you if you are ready to begin the merge process. Click OK to proceed, or Cancel to exit without any changes. 8. A message will display when the process has completed. Click OK. 9. Click Close to dismiss the utility window. 10. Use the Comparison Reports to evaluate the results.Copying Components from One View to Another View Batch Copy allows a component in one collection view to be copied into another view. The copy action is performed on views of the same type (i.e., edit, load, or extract). It is based on the selected component and its parent. In other words, you will copy a component based on its rule relation. For example, if the selected component is a Model- Number that is a child of a Paragraph in an edit view, you will be able to copy ModelNumber to other edit views that have Paragraph. The component is copied to the selected views, along with the settings and processing options that appear on the source component's update window. The copy process is not recursive. This means that the children and descendants of the copied component will not be included in the batch copy. If the new component contains children, you will have to do repeated batch copy actions. If the target collections already contain the new component, but in a different location, then the new component would automatically obtain the children components after the batch copy has completed. This tool reduces the effort to update a configuration with a new component. You can add a new component to one view, and then easily copy it to the same location in other collections' views of the same type (i.e., edit, load, or extract).112 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuidePerforming a Batch Copy of an Edit View Component 1. Right-click on the component to be copied to other edit views and select Batch Copy.2. Select the edit views that should receive the new component and click OK.Only collections that have the parent component, but do not have the child component in the edit 2 view will be displayed in the list.3. You will be prompted to begin the process. Click OK to proceed. 4. A message will inform you when the copy process has completed. Click OK. 5. To verify that the component was successfully copied to the selected views, open navigators for views that you selected for updating, or do a Where Used on the raw component and verify that an entry exists in the Where Used window for each of the views that were selected for updating. Performing a Batch Copy of an Extract or Load View Component 1. Right-click on the component to be copied to other views and select Batch Copy.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 113 Refining the Basic Structure2. Select the views that should receive the new component and click OK.Only collections that meet the following criteria will be available in the list: 1) the view must have the component in the corresponding edit view, and 2) the view must have the parent compo- 2 nent, but does not have the child component.3. You will be prompted to begin the process. Click OK to proceed. 4. A message will inform you when the copy process has completed. Click OK. 5. Click Cancel to dismiss the Target Collections Views window. 6. To verify that the component was successfully copied to the selected views, open navigators for views that you selected for updating, or do a Where Used on the raw component and verify that an entry exists in the Where Used window for each of the views that were selected for updating.Broadcasting Component Processing Options Broadcast Processing Option Settings allows you to copy the processing options on a component to other components in the same edit view, as well as other edit views. This tool allows you to update a large number of components more efficiently, rather than doing individual component updates. Before using this process, examine the processing options and their arguments closely to be sure that you get the results that you expect. For example, the argument values should be appropriate when the processing options are placed on other components, or in other collections. If the processing option is going to be broadcast to other collections, and one of the arguments of the processing option is collection_id, the broadcast is not going to change that argument automatically. If you broadcast an item from one component onto another component and the rule_rela- tion_id is an argument, the broadcast is not goiing to automatically change the rule_relation_id. Therefore, consider arguments carefully when broadcasting. To broadcast a component's processing options:114 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide1. Open an edit view component's Update window that contains the processing options that you want to copy to other components. Click Broadcast Processing Option Settings.2. Select the collections in the left window pane that have components that you would like to have updated, and place them in the right window pane using the arrow button or Add All button. Choose a filter criteria by selecting one of the radio buttons for All, Primaries Only, or Match Source. • All: Retrieve all components in the target collections. • Primaries Only: Retrieve the primary components in the target collections. • Match Source: Retrieve the same component (as the source component) in the target collections. Click OK.3. The Broadcast window allows you to do several things: 1) Select the target components that will receive the processing options from the source; 2) examine the processing options that already exist on the target compo-VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 115 Refining the Basic Structure nents; 3) choose the broadcast behavior of appending or replacing processing options on the target components; and 4) re-filtering the potential target components.Analyze the content before performing the broadcast using the following features: • Highlight an entry in the Potential Broadcast Targets pane. The bottom portion of the window will show the processing options and their arguments that currently exist on the selected component. This will help you to determine if it is appropriate to overwrite this component's processing options with the broadcast action. • Display Source Processing Options will show a report of the processing options that are on the source component and will be broadcasted to the target components as a result of the broadcast action. • Report will generate a separate report window that includes all the processing options on the source component and the target components. If no target components are selected, the report will show the source component information. If there are target components with a checkmark in the checkbox, then the report will show the source component information, followed by the information for each checked target component. This report can be printed or saved to an electronic file.• If you determine that the list of potential target components is not appropriate, select Filter to open the filter window and reselect collections and new filter criteria.116 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideWhen you have completed the analysis and are prepared to begin the broadcast action: a. Place a checkmark in the checkbox for the components that you would like to have updated by the broadcast action. • Select All will automatically select each component and Clear All will clear all checked components. • Invert Selection will clear the checkmarks from the components with checkmarks, and add checkmarks to components that did not have checkmarks. b. Choose the type of broadcast action that you would like to occur: • Replace All: The target components' processing options will be overwritten with the processing options from the source component, including the processing option arguments. • Replace Same: The target components' processing options that are the same as the source component's processing options will be overwritten, including the processing option arguments. • Append: The target components will be appended with processing options from the source component. If one of the processing options that exists on the source already exists on the target, the one on the target will be preserved and any other processing options on the source will be added to the target. For example: Source Component Processing Options: client_key_from_id (text argument: overwrite=n prefix=v clone=p) and descendant_text_display Target Component Processing Options: client_key_from_id (text argument: overwrite=n prefix=v) When the broadcast is performed with the Append, the client_key_from_id processing option will not be overwritten on the target. The descendant_text_display processing option will be added to the target component. The result will be: Target Component Processing Options: client_key_from_id (text argument: overwrite=n prefix=v) and descendant_text_display c. Click Broadcast. 4. Open a Report and examine the results. This allows you to determine if the changes made during the broadcast action should be saved or rolled back. 5. When you are satisfied with the changes, click Save. If you are not satisfied with the changes then click Undo. 6. You may clear the checkmarks from the target components by clicking Clear All and re-selecting another group of target components to perform a new broadcast (i.e., different components or broadcast criteria). 7. Click Close when you have completed the broadcasting activity.Purging Stranded ComponentsThis utility purges any components that have been stranded (left hanging) as a result of deletions in the Edit, Extract or Load views. 1. From the main menu, select Utilities → Purge Stranded Components. A pop-up window appears requesting confirmation of the purge. 2. Click Yes to confirm the purge, or No to discontinue the action. If Yes is selected, you receive a message box when the purge is completed indicating the number of components that were removed.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 117 Refining the Basic StructureDeleting Unused Setup Data This utility removes all unused setup data stored in Vasont Administrator, including raw components, wrappers, and attributes. All unused data is permanently deleted from the Oracle database. It does not remove the collection data in Vasont. 1. Select Utilities → Delete Unused from the main menu, and then select an item from the pull-down menu. 2. For example, click Raw Components. The Delete Unused Raw Components window displays, listing all the content types. Select the content type where the deletion should occur. Click OK to proceed.3. On the Alert message, click OK to continue or Cancel to return to the Content Navigator window.4. When the deletion is complete, a Delete Unused Total reports the number and type of data deleted. Click OK to dismiss this message.Deleting Vasont Data The Vasont Administrator offers several utilities to delete data, versions, raw material and workflow project data. The following sections describe each utility in more detail. Deleting Collection Data This utility removes all data stored in Vasont for a given collection. All collection content is permanently deleted from the Oracle database, including version files. This utility does not remove the collection setup in the Vasont Administrator. 1. Select Utilities → Delete Collection Data from the main menu. 2. The Delete Collection Data window contains a list of all collections. Select the collection whose data you want to delete. Click OK. 2 Only collections the user has the right to access will be listed.118 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide3. Click Yes on the warning message to confirm the deletion or No to exit without taking further action. Purging Raw Material This utility purges content stored in Vasont that is no longer used in any collection or version associated with a collection. It currently purges across all content types. This is a true purge of raw material and the data is not recovera- ble from a version. All unattached raw material is permanently deleted from the Oracle database. The Raw Material In Collection flag should be built prior to purging raw material in order to ensure that all raw material not in a collection is purged. See Building Raw Material In Collection Flag. 1. From the main menu, select Utilities → Purge Raw Material. A pop-up Question window appears requesting confirmation of the purge. 2. Click Yes to confirm the purge, or No to discontinue the action. If Yes is selected, you receive a message box when the purge is completed indicating the number of raw components that have been removed. Building Raw Material In Collection Flag The Raw Material In Collection flag is a very processing intensive field to maintain in the database, so Vasont does not continually update this field. You can build the In Collection flag from Vasont Administrator or with the proper permissions, a user can build the in collection flag from the Raw Material window in Vasont. The Raw Material In Collection flag should be built prior to purging raw material in order to ensure that all raw material not in a collection is purged. See Purging Raw Material. 1. From the main menu, select Utilities → Build In Collection Flag. 2. Click Yes to confirm the purge. When the In Collection flag is finished being built, a message box displays confirming that the process has completed. Merging Duplicate Raw Components Before inserting new raw material, Vasont always checks to see if an identical piece of raw material already exists. If so, the existing piece of raw material is referenced and not duplicated. However, some circumstances may cause duplicate records to be created. For example, if two processes (e.g., Loads) are running simultaneously two identical raw material records could be added. This would occur because the two processes are running as part of separate transactions and would not have visibility to the other process. The Merge Duplicate Raw Components utility will search the system for duplicate Raw Components that have a class of Raw Text or Raw Pointer. If found, these records will be merged into a single raw material record and theVAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 119 Refining the Basic Structure duplicate will be deleted. All collection level components and versions will automatically be updated to reference the remaining raw material record.Duplicate Raw Pointer components are found by comparing the component they point to and text of 2 the pointer (if text exists).To run the utility, go to Utilities → Merge Duplicate Raw Components. A message will display explaining the process and requesting acknowledgment prior to executing the function. Click Yes to continue. When the process has completed a message will display reporting the number of duplicates removed. Click OK to dismiss the window. Deleting Versions This feature allows you to delete all of the version records for a collection. You can limit the deletions to versions created prior to a specified date. You can also choose to delete only versions for primaries that have been deleted from the database. 1. From the main toolbar, select Utilities → Delete Versions from the drop-down menu. The Delete Versions window displays a listing of all the collections that have version records. (Use the scroll bars to view all of the Collection Names, if necessary). 2 Only collections the user has the right to access will be listed.2. Select a Collection Name from the list. (Only one collection can be selected at a time.) 3. At the bottom of the window, choose whether to delete all versions or those created prior to a specified date. Type the date as necessary. If desired, check the Purge Deleted Primaries Only checkbox. This option allows you to only delete versions for primary components (and their descendants) that have previously been deleted from the system. This selection works in conjunction with the Delete All Versions or Delete Versions Prior To options. • Selecting Delete All Versions and Purge Deleted Primaries Only will delete all of the version history records on deleted primary components. • Selecting Delete Versions Prior To and Purge Deleted Primaries Only will delete version history on primary components that were deleted prior to the date specified in Delete Versions Prior To box.120 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide4. Click the OK button. If OK is clicked on, a confirmation pop-up message window displays. 5. Click Yes to confirm the delete, or click No to discontinue the action and dismiss the pop-up message.Deleting Project DataTo delete project data, select Utilities → Delete Project Data from the main menu. This utility removes all content associated with Workflow Projects. All project content is permanently deleted from the Oracle database. The utility does not remove the project setup data in the Vasont Administrator. 1. The Delete Project Data window contains a list of all the projects. Select the project whose data is to be deleted. Click OK to proceed with the deletion of the project data. 2 Only project data from collections the user has the right to access will be visible.2. Click Yes at warning message to confirm the deletion, or No to exit without taking further action.Batch Updating Components in a ViewThe Batch Update Utility lets you update multiple components within a view (extract views, load views, and edit views). Updates can be made to attributes, processing options, actions, pointers, occurrences, some advanced tab settings, raw components, wrappers, and some miscellaneous items. Changes are made within one view (edit, extract, load) at a time. Existing attributes modified with the batch utility are overwritten. Any processing options attached to the attributes are also lost, unless respecified with the same Batch Update. To select data for batch updates: 1. Go to Utilities → Batch Update from the main menu. 2. On the Batch Updates window, select a Collection and a View from the drop-down list at the top of the window. The component name, class name, generic name, and ID information appear in the lower portion.A user must first be granted the right to execute batch updates by a Vasont Administrator. 2 In the collection drop-down list, only collections the user has the right to access will be visible.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 121 Refining the Basic Structure3. Select one or more Component Names or Select All and click Update.4. The Batch Update window displays.Batch Updating AttributesTo add or change attributes on the selected components, click the Attributes tab on the Batch Updates window.1. Right-click and select Add.2. Select one or more attributes from the Attribute Pick List window and click OK.3. The new attribute(s) displays on the Attributes tab of the Batch Updates window.4. If the attribute requires additional properties (i.e., valid values, processing options, etc.), see Updating an Edit View Component or Updating a Load or Extract View Component for more information.Remove existing Attributes will delete all existing attributes on the selected components.• If checked, the first step in the process is to remove existing attributes, before adding new attributes defined in the batch update window.• If the box is checked and no attributes are defined in the batch update window, the process will simply remove all existing attributes for the selected components.• If the box in unchecked, then the new attributes will be added to the existing attributes that already exist on the components.122 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideIf the attribute already exists on the components, it will be overwritten with the newly defined attrib- 2 ute and it properties (i.e., processing options and arguments, occurrences, valid values, defaults, etc.).When you have finished defining the updates, click OK to apply them or click Cancel to exit the window without taking any action. Also see Copying Alias Attributes to Other Aliases for batch updating or applying alias attributes. Batch Updating Processing Options To add or change processing options related to the selected components, click the Processing Options tab on the Batch Updates window, right-click and select Add.1. Select one or more processing options from the Processing Options Pick List window and click OK. 2. The selected processing option(s) displays in the Processing Options tab of the Batch Updates window. • To update arguments, right-click the processing option and select Update Arguments from the menu. (This selection is available only if the processing option has arguments other than text arguments.) • Enter the argument information. 3. Click OK to apply the changes.New processing options for selected component(s), even if only the event is new, are added as speci- 2 fied. Processing option/event combinations that already exist on the component(s) are replaced.See Updating an Edit View Component or Updating a Load or Extract View Component for more information.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 123 Refining the Basic StructureBatch Updating Actions To allow or disallow actions related to the selected components, click the Actions tab on the Batch Updates window. This tab is only available when edit view is selected in the Batch Updates window.1. Make selections from the drop-down list for each action you want to update and click OK. See Updating an Edit View Component for more information. Batch Updating Pointer Definitions To add or change pointees related to the selected components, click the Pointers tab on the Batch Updates window. This tab is only available when edit view is selected in the Batch Updates window. 1. Right-click and select Add.2. On the Pointee Filter, select a collection from the drop-down list and click OK. 2 Only collections the user has the right to access will be visible.124 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide3. The Pointee Pick List for Collection Components displays.Select one or more pointees from the list and click OK. 4. The selected pointee(s) displays in the Pointers tab on the Batch Update window. • Select the settings for the pointer using the drop-down list or by placing a check mark in the various fields. Remove existing pointer definition records will delete all existing pointer definition records on the selected components. • If checked, the first step in the process is to remove existing records, before adding new records defined in the batch update window. • If the box is checked and no pointer definition records are defined in the batch update window, the process will simply remove all existing pointer definition records for the selected components leaving no pointer definitions. • If the box in unchecked, then the new pointer definitions will be added to the existing pointer definitions that already exist on the components. When you have finished defining the updates, click OK to apply them. See Updating an Edit View Component for more information. Batch Updating Occurrences To add or change occurrence rules related to the selected components, click the Occurrence tab on the Batch Up- dates window. This tab is only available when edit view is selected in the Batch Update window. 1. Right-click and select Add.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 125 Refining the Basic Structure2. Select an Occurrence Rule from the drop-down list. Edit the group number if necessary.Remove existing Occurrences will delete all existing occurrence rules on the selected components. • If checked, the first step in the process is to remove existing occurrence rules, before adding new occurrence rules defined in the batch update window. • If the box is checked and no occurrence rules are defined in the batch update window, the process will simply remove all existing occurrence rules for the selected components. The components will then use the default occurrence of Zero, One or More. • If the box in unchecked, then the new occurrence rules will be added to the existing occurrence rules that already exist on the components.If the component already has occurrence rules with the same group number as the new occurrence 2 rules that you are adding through the batch update window, then they will be overwritten and replaced with the new rules. If the component does not already have an occurrence rule with the same group number as the new occurrence rule you are adding, it will be added to the existing occurrence rules on the component. Occurrence rules on the component with other group numbers will remain in place.When you have finished defining the updates, click OK to apply them. See Updating an Edit View Component for more information. Batch Updating Advanced Settings To add or change Advanced tab information related to the selected components, click the Advanced tab on the Batch Updates window. This tab is only available when edit view is selected in the Batch Updates window.The following values can be selected:126 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide• Client Key Flag: Optional, Required, Unused, View Only • Matching Criteria: Client Key, Raw Component, Client Key/Raw, Internal Id • Validation Option: (none), XML well-formed, SGML valid - Used on text components for checking untracked markup. • Valid Value Flag: Yes, Yes-Allow Override, No, Use Alias Flag • Remove Valid Values: Yes, No - Used to clear valid values from edit view components. Click OK to apply the changes. See Updating an Edit View Component for more information. Batch Updating Miscellaneous Settings To add or change miscellaneous information related to the selected components, click the Misc tab on the Batch Updates window. This tab is only available when edit view is selected in the Batch Updates window.• To make changes to Navigator Name or Navigator Order, enter a value in the appropriate box. • Text Allowed, Inline Component for Parent, Store Text Within Parent, and Wrapper data may be entered using the drop-down lists. The following values can be selected: • Text Allowed: Not allowed, Optional, Required • Inline Component for Parent: Yes, No • Store Text Within Parent: Yes, No • Wrapper: Name of wrapper for inline component or None Click OK to apply the changes. See Updating an Edit View Component for more information.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 127 Refining the Basic StructureBatch Updating General Settings To add or change general information related to the selected load or extract view components, click the General tab on the Batch Updates window. This tab is only available when load or extract view is selected in the Batch Updates window.The following values can be selected: • Tag: Choose from the list of available Wrappers Be aware that not only is the selected component being updated with a new wrapper and wrapper relation value, but all of the children of the selected component need to be updated with a new wrapper relation value as well. Therefore, some restrictions to batch updating tags or wrappers are in place to protect against unwanted results. • All extract or load view components selected for batch updating must currently have the same tag. If there are at least two components with different tags, then the Tag field will not be available. • The new wrapper cannot already exist on any of the selected component's siblings. When this happens, a message will display explaining that the change cannot be made. For example, you can't change the Proper- ties component's wrapper to <section>, if the Section component exists with the <section> wrapper as a sibling to Properties. • The selected components cannot contain a recursive wrapper relation (i.e., <section> [<section>]). When this happens, the Tag field will not be available.Depending on where you make Tag changes (i.e., Wrapper Where Used window or Batch Update 2 Utility), the display will be refreshed to show the components based on their new tag name. • Wrapper Flag: Standard, Pure, File • Placement: Before, Nested Before, Inline, Nested After, After • Sequence Number: Enter a number that is appropriate for the order of the component (typically corresponds with the edit view navigator order) • Sub-Component Load/Extract: Yes or No Click OK to apply the changes. See Updating a Load or Extract View Component for more information.Batch Updating from Where Used Feature The Where Used feature can be used as a method for gathering components and performing updates to them. Most of the properties on the edit, load or extract view component's update window can be updated from the Batch Update128 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide process (i.e., attributes, processing options, actions, pointers, occurrences, some advanced tab settings and miscellaneous items). Changes can be made to multiple instances of a component(s) by view type (i.e., edit, load or extract). This functionality provides an efficient method for updating collection views. The following sections provide information on the items that allow Where Used and Batch Updating. Batch Updating Attributes from Where Used Use this utility for changing the properties of attributes on a group of collection components. Note: If the attribute is controlled at the alias attribute level it may not be necessary to batch update all the individual uses of an attribute on a given specific component across all its uses in collections. 1. Click the Content Nav button on the main toolbar. 2. Expand the Content Type. 3. Click Attributes in the left window. The existing attributes will display in the right window. 4. Right-click on the attribute and select Where Used.5. On the Attribute Filter, select a collection from the drop-down list and click OK. 2 Only collections the user has the right to access will be listed in the Attribute Filter.6. The Attribute Where Used window displays.A message will display if any of the Where Used tabs has tried to retrieve more than 32,000 entries. When this happens, try executing the Where Used process again, only this time, limit your 2 selection to a smaller collection set.Select the tab for the items that you would like to update (i.e., load view components, extract view components, etc.). Highlight the entries for updating, right-click and select Batch Update.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 129 Refining the Basic Structure7. The Batch Updates window displays.Make updates on the Attributes tab as needed. See Batch Updating Attributes for more information.Updates are not restricted to the Attributes tab. You can make any changes that are possible on 2 any of the tabs in this window.8. Click OK to apply the updates.Batch Updating Processing Options from Where Used1. Click the Content Nav button on the main toolbar.2. Click Processing Options in the left window. A complete list of processing options displays in the right window.3. Right-click on the processing option and select Where Used.4. On the Processing Option Filter, select a content type and collection(s) from the drop-down list and click OK.5. The Processing Option Where Used window displays.A message will display if any of the Where Used tabs has tried to retrieve more than 32,000 en- 2 tries. When this happens, try executing the Where Used process again, only this time, limit your selection to a smaller collection set.Select the tab for the items that you would like to update (i.e., load view components, load view headers, etc.).Highlight the entries for updating, right-click and select Batch Update130 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideThe Extract View tab or the Load View tab displays processing options that are applied to a 2 component or an attribute in the view. The View - High Level tab displays processing options that are applied to the load or extract view headers.If you are unsure where the processing option you would like to batch update is applied, check both tabs to determine which window contains the Where Used entries.6. The Batch Updates window displays.Make updates on the Processing Options tab as needed. See Batch Updating Processing Options for more information.Updates are not restricted to the Processing Options tab. You can make any changes that are pos- 2 sible on any of the tabs in this window.7. Click OK to apply the updates.Batch Updating Raw Components from Where Used1. Click the Content Nav button on the main toolbar.2. Expand the Content Type.3. Click Raw Components in the left window. The existing raw components display in the right window.4. Right-click on the raw component and select Where Used.5. On the Raw Type Filter, select a collection from the drop-down list and click OK.6. The Raw Component Where Used window displays.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 131 Refining the Basic StructureA message will display if any of the Where Used tabs has tried to retrieve more than 32,000 en- 2 tries. When this happens, try executing the Where Used process again, only this time, limit your selection to a smaller collection set.Select the tab for the items that you would like to update (i.e., edit view components, load view components, etc.). Highlight the entries for updating, right-click and select Batch Update.7. Updates can be performed on any of the tabs on the Batch Updates window. For more information: • Batch Updating Attributes • Batch Updating Processing Options • Batch Updating Actions • Batch Updating Pointer Definitions • Batch Updating Occurrences • Batch Updating Advanced Settings • Batch Updating Miscellaneous Settings • Batch Updating General Settings 8. Click OK to apply the changes. Batch Updating Wrappers from Where Used 1. Click the Content Nav button on the main toolbar. 2. Expand the Content Type. 3. Click Wrappers. The existing wrappers display in the right window. 4. Right-click on the wrapper and select Where Used.5. On the Wrapper Filter, select a collection from the drop-down list and click OK.132 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide2 Only collections the user has the right to access will be listed in the Wrapper Filter window.6. The Wrapper Where Used window displays.A message will display if any of the Where Used tabs has tried to retrieve more than 32,000 en- 2 tries. When this happens, try executing the Where Used process again, only this time, limit your selection to a smaller collection set.Select the tab for the items that you would like to update (i.e., load view components, extract view components, etc.).Highlight the entries for updating, right-click and select Batch Update.7. The Batch Updates window displays.Updates can be performed on any of the tabs on the Batch Updates window. See Updating an Edit View Com- ponent, Updating a Load or Extract View Component, Batch Updating Processing Options, Batch Updating At- tributes, or Batch Updating General Settings for more information.If you are changing the name of the wrapper associated to the extract or load view components, 2 see Batch Updating General Settings for important information.8. Click OK to apply the changes.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 133 Refining the Basic StructureBatch Deleting from Where Used FeatureThe following sections provide methods for removing attributes, occurrences, processing options, pointer definitions and components from collection views.Performing a Where Used on a specific raw component, attribute, or processing option will allow you to delete selected entries from a menu item.There are also options for removing multiple attributes, occurrences or pointer definitions from a raw component.These options provide a method for efficiently updating collection views. Batch Deleting Attributes from Where Used1. Click the Content Nav button on the main toolbar.2. Expand the Content Type.3. Click Attributes in the left window. The existing attributes display in the right window.4. Right-click on the attribute and select Where Used.5. On the Attribute Filter, select a collection from the drop-down list and click OK. 2 Only collections the user has the right to access will be listed in the Attribute Filter.6. The Attribute Where Used window displays.A message will display if any of the Where Used tabshas tried to retrieve more than 32,000 en- 2 tries. When this happens, try executing the Where Used process again, only this time, limit your selection to a smaller collection set.Select the tab for the items that you would like to delete (i.e., extract view components, aliases, etc.).Highlight the entries whose attribute is to be removed. Right-click and select Delete Attribute.134 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide7. The attribute is immediately deleted from the selected items (the components, alias, or tasks are not deleted). 8. Click X to close the Where Used window. Batch Deleting Attributes on a Raw Component To remove unwanted attributes from components, see Batch Updating Attributes for more information. Batch Deleting Occurrences on a Raw Component To remove unwanted occurrence rules from an edit view component, see Batch Updating Occurrences for more information. Batch Deleting Processing Options from Where Used 1. Click the Content Nav button on the main toolbar. 2. Click on Processing Options in the left window. A complete list of processing options displays in the right window. 3. Right-click the processing option and select Where Used.4. On the Processing Option Filter, select a content type and collection(s) from the drop-down list and click OK. 2 In the collection drop-down list, only collections the user has the right to access will be visible. 5. The Processing Option Where Used window displays.A message will display if any of the Where Used tabs has tried to retrieve more than 32,000 entries. When this happens, try executing the Where Used process again, only this time, limit your 2 selection to a smaller collection set.Select the tab for the items that you would like to delete (i.e., extract view components, extract view headers, etc.).VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 135 Refining the Basic StructureHighlight the entries whose processing option are to be removed. Right-click and select Delete Processing Op- tion.6. The processing option is immediately deleted from the selected items (the components, view headers, or tasks are not deleted). 7. Click X to close the Where Used window. Batch Deleting Pointer Definition Records To remove unwanted pointer definition records from an edit view component, see Batch Updating Pointer Defini- tions for more information. Batch Deleting Components A right-click menu option on the Where Used window and the Batch Update window will allow you to remove multiple components from a collection(s) view. The delete process will remove the selected components and their descendants from their associated views. The same rules that are currently enforced for an individual delete will also exist for deletes that occur in batch. Below is a list of constraints put on a deleted Edit, Extract or Load View Component. • Components can only be deleted if they do not have associated content • If a component is deleted, then its descendant components are also deleted. However, descendants can only be deleted if they are not used elsewhere in the hierarchy. For example, a para [section] is deleted and has a child Fig [para] component. Assume there is another paragraph component in the hierarchy such as para [chapter]. In this case the selected component of para [section] is deleted but the fig [para] cannot be removed because para is used elsewhere in the hierarchy. This logic is recursive to walk all descendants. This is the current behavior for handling deletes when done using the Edit View right-click Delete option. • If an Edit View component is deleted, then its associated Load and Extract View components must also be deleted. This is the current behavior for deletes.136 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideThe Delete Component option is available on the right-click menu in the Where Used and Batch Update windows. Select the components to be deleted and right-click on the highlighted area to select Delete Component.A Warning Message will display. Click Yes to continue with the deletion. Click No to abort the deletion process. When the process completes, a report will be generated that will give the results. This report will show all components processed. It will contain the same columns that the Where Used window contained (e.g. Collection, Compo- nent [Parent]). An additional column called “Process Result” will be populated for each component. If the component was successfully deleted, the Process Result value would be set to Deleted. If constraints exist that did not allow the components to be deleted, the “Process Result” column will explain why the component could not be deleted. For example, if data existed in Vasont for the component, the Result column value would read “Unable to Delete: Vasont Data Exists”. The report can be printed to serve as an audit trail of the process.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 137 Refining the Basic Structure138 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide Creating and Maintaining Users or RolesThis chapter provides information on the sections within the User Navigator in the Vasont Administrator application. The User Navigator is accessed by clicking on the User Nav button on the toolbar. If this button is disabled, you have not been assigned permission to this feature. For more information, see User Navigator. This is the part of the application where you define Vasont users, and determine what a Vasont user can or cannot do in the system. This is done in a combination of ways. First the users must be defined, and then from there, the users can be added to Roles and Workgroups. See Creating New Users, Creating New Roles, and Creating New Work- groups. It is most efficient to define Roles within your system and then assign Users to each Role. By doing this, future maintenance and changes become easier and eliminate the need for repetitive updates to multiple users. For example, some common Roles are Admin, Writer, Editor, Publisher, Trainer. Once the Roles have been defined and the Users have been added, select the collections that they will be allowed to access. This means that the user can look at the content in Vasont, but they may not perform any actions. See Col- lections Tab. In order for the user to be able to perform actions, they must be assigned privileges. This is where defining Roles simplifies the administrators job. Rather than assign each individual privileges for the collections that they will be working with, you will assign the privileges to the Role. Adjustments can be made to the Role's privileges as needed and eliminate the need to update each individual User. See Privileges Tab. Workgroups are created to group Users together for workflow assignments. See Creating New Workgroups and Cre- ating and Updating Workflow. Administrative type users may be assigned privileges that require an advanced knowledge of the system and more responsibility when making changes to the content. See Advanced Tab and Admin Rights Tab. The following sections describe how to create and maintain Administrators, Users, Roles, Workgroups and Privileg- es.Vasont Administrator does not automatically maintain a log of User Additions and User Deletions. 2 You may decide to create your own business procedures surrounding this, or use other methods to maintain records of User Additions and Deletions.Collections Tab When this tab is selected, the upper half of the window shows all Collections in the database potentially available for access by the specified Role or User. The bottom half identifies Collections granted to a specified Role or User. Access implies the ability to view information in Vasont. Both the upper and lower portions of the window also show additional information about the collections listed. All column heads are clickable and sortable. The following information is shown: • Collection AbbreviationVAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 139 Creating and Maintaining Users or Roles• Collection Name• Content Type• Collection Group• Edition• IDIn both the upper and lower portions of the window, you can modify the way the information is dis- 2 played, if desired. To do so, right-click and select View → Details or View → List. The details view is shown by default.To enable access to a given collection to a role or user, select the collection from the upper half of the window and drag-and-drop it to the lower half.Multiple collections may be selected by using Shift-click or Ctrl-click. Drag-and-drop all of the selected collections (at once) to the lower half of the window to enable access.To disable access of a given collection(s) to a role or user, select the collection(s) in the lower half of the window, right-click and select Delete from the menu. Disabling access automatically disables any other privileges that have been assigned to the role or user for that collection.The Collection Access Tab does not enable any updating capability. This is enabled on the Privileges 2 Tab or the Components Tab.There are two buttons at the bottom of the tab:• The Excludes Role Grants button is the default. If selected, only the collections to which the user was granted permission display in the lower half of the window (Granted). No collections that were granted to a role that has been assigned to the user are listed.• If the Includes Role Grants button is selected, all collections granted specifically to the user and also any collections granted to roles assigned to that user display.140 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuidePrivileges Tab When collection access has been assigned, you can grant additional privileges from this tab. When you select a specific collection from the drop-down Collection list at the top, the upper half of the window identifies privileges or restrictions you can assign for the collection, the selected role, or the user.To give a user the capability to view only, do not give the user any privileges; giving them permis- 2 sion via the Collections Tab is all that is needed. As long as a user has permission to view a collection, they have the ability to clone content from the “view-only” collection and into another collection. This is particularly valuable when content is modularized, and a user does not have privileges to the modularized content, but has the ability to reference it from a base collection.Following are brief descriptions of the Available Privileges and Restrictions automatically provided during the Vas- ont Administrator install and listed in the right windowpane: • Add all components: assigns the user the right to add components to a collection at any level. • Approve all components: assigns the user the right to promote a draft component to an approved component. • Batch processing: assigns the user the right to perform batch processes to one or more primaries in a collection for a user or group. In Vasont, the Tools → Process Collection menu option provides access to these processes; such as Analyze, Approve, Check-In, Check-Out, deleting the primary's Version History, etc. • Clone into all components: assigns, in a collection for a user or group, the right to create new content (anywhere within the collection hierarchy) via a “clone” operation. Vasont allows you to “clone” existing content from a source location to a target location in a variety of ways. You can drag-and-drop content from one spot to another (in a given collection or from one collection to another) to move or copy the content. You can also use Ctrl-C and Ctrl-P in Navigators to do the same thing. These operations are considered to be “clones” and have a discrete source and target.Clone into all components: covers the target (or drop) portion of a drag-and-drop operation. The source (or drag) portion of a drag-and-drop is not restricted, i.e., If the user can see the collection 2 and content (view only permission), they can still drag from a source collection onto a target collection where the user has more privileges.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 141 Creating and Maintaining Users or Roles• Confirm Pending Delete components: assigns the user the right to confirm the deletion of components previously marked for deletion. (See “Delete all components” in this section). • Delete all components: In a Vasont Navigator, the Mark for Delete option on the right-click (context) menu allows the user the ability to mark a component for deletion, but does not actually remove the component from the collection. Once the component is marked for deletion, the Confirm Pending Delete option will now be available in the right-click (context) menu and the user may select this option to actually remove the component from the collection. See Confirm Pending Delete components in this section. • Edit all components: assigns the user the right to update components in Vasont Navigator. In a Vasont Naviga- tor, the Update option on the right-click (context) menu will be available to the user and will open a component update window. The user will now be able to save changes made to the selected component. • Explicit Check Out: allows a user to perform check outs from the following areas: • Navigator Right-click Menu • Details Pane, Children and Siblings Information Tabs • Cross Collection Search Window • Process Collection, Batch Processing Window If the user does not have the Explicit Check Out or Update (full rights) permissions, then the user will not be able to perform check outs from the areas listed above. System level check outs will be performed regardless of whether a user has this privilege assigned. For example, if a user is allowed to perform updates, then the Update window automatically performs a check out when it is opened and a check in when the window is closed. • Extract: allows the user the ability to extract data from Vasont and import it into a helper application such as XMetaL, FrameMaker, or Arbortext. • Extract from menu: assigns the user the right to extract components from the Vasont database to a file, or files, in SGML or XML format. In Vasont, the Tools → Primary Extract menu option provides access to the Collec- tion Explorer window. The user selects a collection, then from the File Extract window, selects one or more primaries to extract. • Initiate Collaborative Review: assigns the user the right to coordinate a collaborative review. Collaborative Review is an additional Vasont package for reviewing, commenting and marking up content in Vasont's WYSI- WYG environment.The following message will display when the Initiate Collaborative Review privilege is granted to a 2 user or role for a collection that does not have the review style set up.See Assigning a Style for the Collection.This privilege is not rolled into the Update (Full Rights) privilege. It must be assigned in addition to 2 Update (Full Rights).• Load: allows the user the ability to load the data from a helper application back into Vasont. • Load from menu: provides the capability to load files in SGML or XML format into the Vasont database through the Tools → Primary Load menu option.142 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide• Manage Owners: assigns the user the ability to add or remove Content Owners and manage Owner Groups in Vasont.This privilege is not rolled into the Update (Full Rights) privilege. It must be assigned in addition to 2 Update (Full Rights).• Pick List all components: assigns, in a collection for a user or group, the right to add new content by picking existing content from the appropriate bin (Paragraph bin, Graphic bin, etc.). In a Vasont Navigator, the New option on the right-click (context) menu allows you to add new content in either a Pick List or a Create New mode. Create New invokes a dialog box where text, multimedia files, and other components may be added. Pick List allows you to pick existing content from the Raw Material bin (e.g., a Paragraph, a Graphic, etc.). Pick List is similar to drag-and-drop in that it provides a mechanism to reuse existing content. The key difference is that Pick List lets you pick existing content “out of context” (think of it as picking from a bin of paragraphs), whereas with drag-and-drop, existing content is located and reused based on a known context (book, chapter, etc.).• Reinstate versions: allows the user to reinstate previous versions of data. Reinstatement of a component can either replace the current version of the component (Reinstate Overwrite) or be created as a new entity (Rein- state New). In a Vasont Navigator, the Actions option on the right-click (context) menu allows you to select either View Versions or Create Version.• Resequence all components: assigns, in a collection for a user or group, the right to reorder primaries and/or the children under a parent. The application of this permission will not allow violation of content rules (as an example, if Author must always follow Paragraphs, you cannot move Author before the Paragraphs in the Vas- ont Navigator).• Update (full rights): assigns the right to, a collection for a user or group, every privilege listed on the Privileges Tab.This privilege does not include Initiate Collaborative Review and Manage Owners. If Update (Full 2 Rights) is granted and the user also needs Initiate Collaborative Review and/or Manage Owners, they must be granted in addition to Update (Full Rights).To enable a given privilege or restriction to a role or user, select a collection from the drop-down list and select the item from the upper half of the window. Drag-and-drop it on the lower half of the window.To remove a given privilege, select the item in the lower half of the window, right-click and select Delete.Update rights can also be assigned on the Components Tab. However, if it is used to grant a privilege, 2 the tab cannot be used to override that same privilege.Roles TabIf a specific user is selected in the left windowpane, the upper half of the right windowpane displays the available Roles you can assign to that user, and the lower half contains roles already assigned to the user.If a specific role is selected in the left windowpane, the upper half of the right windowpane displays the available Users who could be assigned to that role, and the lower half contains users already assigned to the role.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 143 Creating and Maintaining Users or RolesTo enable a given role/user to a user/role, select the item from the upper half of the windowpane and drag-and-drop it to the lower half.To disable a given role/user to a user/role, select the item in the lower half of the windowpane, right-click, and select Delete.Advanced TabWhen you select the Advanced tab, the upper half of the windowpane shows all Available special privileges you can give to a User or Role. The bottom half identifies those special privileges already Granted.There are two buttons at the bottom of the window:• If the default Excludes Role Grants button is selected, the lower half of the window shows those advanced privileges already granted to the selected user. Any advanced privileges already granted through a role assigned to that user are not shown.• If the Includes Role Grants button is selected, the lower half of the window shows those advanced privileges already granted to the selected user or any advanced privileges already granted through a role assigned to that user.144 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideFollowing are brief descriptions for all the Available privileges automatically provided during the Vasont install. While these privileges are granted in Vasont Administrator, many of them are performed using the Vasont Navigator menus. • Check in override: gives a user the authority to check in a component even though it may have been checked out by another user. • Collection clone: allows you to create a new collection using an existing one. • Complete Task Override: gives the user who is assigned this privilege the ability to complete workflow tasks assigned to other users, and have the completion of task recorded as though the task was completed by the assigned user. This is a special privilege to be used for demonstrations and training sessions. It allows a presenter or trainer to walk through a workflow without having to log into multiple sessions of Vasont as various users. When tasks are completed with the Complete Task Override privilege, a record of the activity will be applied in the Project Management → Details pane → Adjustment information bar. • Delete Primary Versions: allows a user to Delete Versions using the batch processing in Vasont. • Delete WebLNX Tasks: allows a user to delete one or more Vasont WebLNX tasks. • Delete workflow tasks: allows you to delete one or more workflow tasks. • Manage Asynchronous Processes: for future development. • Project Filter: provides the capability to use the Vasont workflow project filter to change the default display of tasks in the workflow window. • Publication Type Update: gives the user the ability to add, change, or delete Publication Types. These are definitions that are utilized by the Auto-Publishing process. • Raw Material Update: allows you to perform various update tasks using Vasont's raw material update processes. • Raw Material View: gives access to the Raw Material Browse window. • Reassign Collaborative Review Coordinator: enables you to reassign the Review Coordinator as another user. User must have the Initiate Collaborative Review priviliege to be assigned as the Review Coordinator. • Reassign Workflow Tasks: enables you to reassign a task from one user to another. • Remove Shared Queries: allows you to remove the “shared” property on queries that were saved and shared by another user. The query will not be deleted and the original owner will still be able to view the query in their own list, however the query will no longer be visible to other users. • Share Saved Condition Sets: gives the user who is assigned this privilege the ability to share saved sets with other users or delete shared saved conditions sets. This privilege affects the Setup Extract Conditions window that is displayed as part of a conditional extract process. Users who do not have the Share Saved Condition Sets privilege will have the following behavior: • The Delete Set button will be disabled when a shared Saved Condition is chosen. • The radio button for Save for all users will be grayed out and disabled. • Translation Component Adjustments: activates the Make Default, Remove Default, and Remove Link buttons in the Components tab of the Details pane-Translation Information Bar. • Vasont WebLNX XML Editor - Allow Text Page Editing: allows changes to the text within the XML editor. • Vasont WebLNX XML Editor - Manage Tracked Changes and Comment: allows management of tracked changes and comments within the XML editor. • Translation Window: enables access to the Vasont Translation feature in Vasont. See Building a Translation Setup for more information. • Workflow Scheduling Override: gives the authority to add, change, or modify the duration, duration flag, due date, and username values applied to a task in Vasont Administrator.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 145 Creating and Maintaining Users or RolesWorkflow Scheduling is available by right-clicking on a task in the Vasont Workflow Projects window and selecting Workflow Scheduling from the menu. To enable a given special privilege or restriction to a role or user, select the item from the upper half of the window, and drag-and-drop it to the lower half. To disable a given special privilege to a role or user, select the item in the lower half of the window, right-click, and select Delete. The item is immediately removed.Components Tab The Components tab allows a specific component in a specific collection to have special permissions for a selected Role or User. When the Components tab is selected, a User Components Filter appears (or Role Components Fil- ter, if a role is selected in the left pane).Use this window to limit the number of components displayed in the upper half of the window. You can select a collection using the drop-down list or you can type in a Navigator Name. You can also choose All Collections from the drop-down list to view all components in all collections. • Click OK to continue processing. The filter window appears automatically only when you click the Components tab for the first time for a specific user or role. In order to view the window when you again click on the tab for the same user or role, right-click in the upper half and select View Filter Window. To enable special control over a specific parent/child component combination in a specific collection to a role or user, select the item from the upper half of the window, and drag-and-drop it to the lower half of the window.146 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideNext, right-click on the item and select Update. Batch Update capability is also available. Select one or more components using Shift-click or Ctrl-click, then right-click and select Batch Update from the menu.Enable or disable the special controls by selecting or clearing items from the list of specific privileges. Then click Save and Close on the main toolbar to save the changes, dismiss the update window, and return to the User Naviga- tor window.To disable special control over a specific child/parent component combination in a specific collection to a role or user, select the item in the lower half, right-click on the item, and select Delete. The component is immediately removed.To enforce restrictions for any special control over a child/parent component combination in a specific collection, you must right-click on the item after it has been moved to the lower half, choose Up- 2 date from the menu, and clear the privileges to be restricted.Use the View - List selection on the menu to view just the Collection data without the details. Click the View - Details selection to activate and return to the default detailed view.Update rights can also be assigned on the Privileges Tab; however, if the Privileges tab is used to 2 grant a privilege, the Components tab cannot be used to override or revoke that same privilege.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 147 Creating and Maintaining Users or RolesWorkgroups Tab If a specific workgroup is selected in the left windowpane, the upper half of the right windowpane displays the available Users who could be granted membership to that workgroup, and the lower half contains users who have already been granted membership. To grant a user membership to the workgroup, select the user from the upper half of the window and drag it to the lower half of the window. To remove a user from the workgroup, select the user in the lower half of the window, right-click, and select Delete.When you select a workgroup in the left windowpane, the Workgroups tab displays and all other tabs 2 are disabled.If a specific user is selected in the left windowpane, the upper half of the right windowpane displays the available Workgroups to which the user can be granted membership, and the lower half contains workgroups to which the user has already been granted membership. To grant the user membership to a workgroup, select the workgroup from the upper half of the window and drag it to the lower half of the window. To remove the user from a workgroup, select the workgroup in the left half of the window, right-click, and select Delete.To view the list of available workgroups with details, right-click in the lower half of the window and 2 select View → Details.Ownership Groups Tab If a specific ownership group is selected in the left windowpane, the upper half of the right windowpane displays the available Users who could be granted membership to that ownership group, and the lower half contains users who have already been granted membership.148 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideTo grant a user membership to the ownership group, select the user from the upper half of the window and drag it to the lower half of the window. To remove a user from the ownership group, select the user in the lower half of the window, right-click, and select Delete.When you select an ownership group in the left windowpane, the Ownership Groups tab displays and 2 all other tabs are disabled.To view the list of available ownership groups with details, right-click in the lower half of the win- 2 dow and select View → Details.If a specific user is selected in the left windowpane, the upper half of the right windowpane displays the available Ownership Groups to which the user can be granted membership, and the lower half contains ownership groups to which the user has already been granted membership. To grant the user membership to an ownership group, select the ownership group from the upper half of the window and drag it to the lower half of the window. To remove the user from an ownership group, select the ownership group in the left half of the window, right-click, and select Delete.Admin Rights Tab The Admin Rights Tab is only accessible to Super Administrators. The Admin Rights Tab is used to grant permissions to other users who have access to Vasont Administrator. In some cases, it is desirable for different departments in an organization to assign Associate Administrators limited privileges in limited collections. The Super Adminis- trator-Associate Administrator solution permits privileges to be assigned based on content. A Super Administrator is defined as: • The user who is the schema owner. (It is not necessary for this user to have any specific rights granted on this tab, as this user is automatically assigned full rights within the Vasont Administrator.) • A user who has been granted the super administrator right. Initially, this can only be done by the schema owner. Once a user has been granted the super administrator right by the schema owner, the user has the same rights as the schema owner.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 149 Creating and Maintaining Users or RolesThe other rights that can be granted from this tab are associated with the Content Navigator, User Navigator, and Utilities. An Associate Administrator is defined as: • The user who has been granted one or more of the Content Navigator, User Navigator, or Utilities rights, but has not been granted the Super Administrator right. To assign Vasont Administrator permissions to a user: 1. Super Administrator status is required in order to grant one or more associate administrator rights. 2. In the left hand pane from the Users list, select the user to whom you wish to assign administrator rights. 3. In the right hand pane, select the Admin Rights tab. When this tab is selected, the top (Available Administra- tor Permissions) window shows the permissions that are available for the Super Administrator to assign to an Associate Administrator. The bottom (Granted) window identifies the permissions in which the Associate Ad- ministrator has Administrator rights.4. From the Available Administrator Permissions window, select one or more of the Associate Administrator permissions, then drag and drop the permissions in the Granted window below. Use Shift-click or Ctrl-click to select multiple permissions then drag and drop them on the Granted window at the same time. Note that the users name has been added to the Administrators list in the left hand pane.5. To remove a permission that has been granted for a user, right-click on the permission in the Granted window and select Delete.150 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideAssociate Administrator Scope:1. Select a user from the Administrator list to show the three Administrator tabs:2. User Navigator Scope: This tab determines in which collections the Associate Administrator has User Naviga- tor Administrator rights. Available collections are listed in Available Collections pane, but the Associate Ad- ministrator will only be able to assign user permissions for the collections that are in the Granted window. The Super Administrator gives the Associate Administrator rights to one or more collections by dragging a collection from the Available Collections window into the Granted window.Collections cannot be added unless the user has the Admin Right of User Navigator. If the user 2 does not have this right granted, a message will display when the Super Administrator tries to grant collections.3. Content Navigator Scope: This tab determines which collections the Associate Administrator has Content Navigator Administrator rights. Available collections are listed in the top (Available Collections) window, but the Associate Administrator will only be able to change setup details for the collections that are in the bottom (Granted) window.An Associate Administrator will only be able to view or modify setup information related to collections they have access to. If a user has no rights to any collection within a Content Type, then the Content Type will not be displayed.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 151 Creating and Maintaining Users or RolesSimilarly, if the user has no rights to any collection within a Collection Group then that Collection Group will not be displayed for the Associate Administrator.An Associate Administrator is not allowed to add or remove a Collection. For all collections the Associate has access to, they will have normal update rights (e.g. add/remove extract views, add/remove edit view components, etc.) within that collection.Collections cannot be added unless the user has the Admin Right of Content Navigator. If the user does not have this right granted then a message will be displayed when the Super Adminis- 2 trator tries to grant collections.4. Utilities Scope: This function permits the Associate Administrator to perform various utility operations. If the Associate Administrator does not have permission to perform utility operations, the utilities menu item will be grayed out as shown below.The various Utilities menus relate to collection level data. For example, Batch Update starts by prompting the user for a collection. An Associate Administrator will only be able to pick a collection that they have been granted access to. The following Utility menu items are also restricted by Collection: • Batch Update • Delete Collection Data • Delete Project Data • Delete Versions • Delete Unused • DTD • Schema152 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide• ImportCreating New Users A a new user account needs to be created in the Vasont Administrator, as well as in Oracle. Inform the Oracle Data- base Administrator so the user can be set up directly in the Oracle database and be assigned a password. This can happen before or after the user is created in User Navigator, but no sign-on can occur until the Oracle user account exists.There is an option that will cause the Oracle user account to be created whenever a user is created in Vasont Administrator. This requires that the Vasont schema owner has appropriate rights in Oracle to 2 create users. Please contact Vasont Systems for more details about this option and how to enable it.1. Right-click Users in the left windowpane, or right-click on a specific user to use Create Like, which copies all permissions from the selected user to the new user. 2. Select New or Create Like from the menu. 3. Enter the user's Name and Email Address (optional). (Users with email addresses are displayed with a special email icon.) Select a Language for the new user (English, French, or German) from the drop-down menu. The default is English.By default, the Login Name field is disabled, unless you have set the “Show_Login_Name ” system profile. In some cases, the Oracle user account names are cryptic and do not clearly represent the user's name. In Vasont it may be difficult to determine who tasks are assigned to or who made component edits. In this case, you can set the system profile to allow the users to log in with the name that is associated to their Oracle account, but once in Vasont, any action they perform will show as their User Name. See System Profiles for more information. The User Category is an optional field where free-form text can be entered. This field is intended to describe the user. For instance, if multiple departments in your company use Vasont, you may want to enter the department name in this field. When a user report is produced, this field will appear in a separate column (see User Information). 4. Choose the type of seats (license) that apply to the user by placing a checkmark in the boxes (Vasont, Review, Workflow, WebLNX, or Web Query Access). The Review, WebLNX, and Web Query Access seats are add-on packages to the Vasont licenses. Check with your system administrator or manager to confirm their availability in your system.When adding new users or additional seats options, if you exceed the maximum seats allowed in 2 your system, an error message will display.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 153 Creating and Maintaining Users or Roles5. Click New if you have more user accounts to create. If not, continue to the next step.6. Click Save and Close to complete the user account creation. The User Navigator will show the new user (BET- TY).Reviewer SeatsThe Collaborative Review package requires review-only seats. When a review-only Vasont user logs into Vasont, they will be presented with the Review List window. The active reviews for the user will be listed and they will be able to open the review and perform markup such as inserts, deletions, and comments.To set up a user for Review, check the Review Seat option on the User properties window in the User Nav.There is no relationship between the Review Seat check box and the other seat check boxes. Additionally, there is no restriction on the number of users that can have the Review Seat checked, but only a designated number of these users can be logged in at any given time. Review licensing is enforced in Vasont at run time, and the number of review users is dependent on the concurrent seats purchased for this purpose.For more details, see Creating New Users and Collaborative Review.Updating UsersAfter user data has been created, the initial information can be updated via the User Navigator.1. In the left windowpane, right-click on the User to be updated.2. Select Update from the menu.154 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide3. Modify the Name, Email Address, Language, User Category, or type of Seat for the user.4. Click Save and Close to save the changes and return to the User Navigator window. 2 If assigning a user seat exceeds the number of licenses allocated, the update cannot be completed.Deleting UsersA user can be removed via the User Navigator window. 1. In the left windowpane, right-click on the User to be deleted. 2. Select Delete from the menu. 3. Click Yes at the warning message to confirm the deletion and return to the User Navigator window, or No to exit the pop-up message without removing the user name.Deleting a user from the Vasont Administrator does not have any impact on the content, versions or 2 workflow history. Therefore, it is safe to remove unnecessary users from your User Navigator.Creating New Roles1. Right-click Roles in the left windowpane of User Navigator, or right-click on a specific role to use Create Like and copy all permissions from the selected role to the new role. 2. Select New or Create Like from the menu. 3. Enter a Name in the Role Name dialog box. Then click Save and Close on the main toolbar to save the change, dismiss the New Role window, and return to the User Navigator.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 155 Creating and Maintaining Users or RolesUpdating Roles 1. In the left windowpane, right-click the Role to be updated. 2. Select Update from the menu. 3. Use the Update Role window to modify the Name.4. Click Save and Close on the main toolbar to save the change. The User Navigator window re-displays and reflects the updated role.Deleting Roles 1. In the left windowpane, right-click the Role to be deleted. 2. Select Delete from the menu. 3. Click Yes at the warning message to confirm the deletion and return to the User Navigator. 4. No dismisses the warning message and the role delete action does not occur.Creating New Workgroups 1. Right-click Workgroups in the left windowpane, or right-click on a specific Workgroup to Create Like to create a new workgroup with the same users as the existing selected workgroup. 2. Select New or Create Like from the menu. 3. Enter a Name in the Workgroup Name dialog box. The Workgroup ID is automatically assigned.4. Click Save and Close on the main toolbar to save the new data and return to the User Navigator window. The new workgroup is listed in alphabetical order under the Workgroups category.Updating Workgroups 1. In the left windowpane, right-click on the Workgroup to be updated. 2. Select Update from the menu.156 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide3. Use the Update Workgroup window that displays to modify the Workgroup Name. Note the current workgroup name at the top of the window.4. Click Save and Close on the main toolbar to save the name change. The User Navigator window re-displays showing the updated data.Deleting Workgroups1. In the left windowpane, right-click the Workgroup to be deleted.2. Select Delete from the menu.3. On the pop-up Warning message window, click Yes to confirm the deletion.The User Navigator window re-displays. The group has been removed.4. Or click No to cancel the delete action and return to the User Navigator window.Creating New Ownership Groups1. Right-click Ownership Groups in the left windowpane, or right-click on a specific Ownership Group to Cre- ate Like to create a new ownership group with the same users as the existing selected ownership group.2. Select New or Create Like from the menu.3. Enter a Name in the Ownership Group Name dialog box. The Ownership Group ID is automatically assigned.4. Click Save and Close on the main toolbar to save the new data and return to the User Navigator window. The new ownership group is listed in alphabetical order under the Ownership Groups category.Updating Ownership Groups1. In the left windowpane, right-click on the Ownership Group to be updated.2. Select Update from the menu.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 157 Creating and Maintaining Users or Roles3. Use the Update Ownership Group window that displays to modify the Ownership Group Name. Note the current ownership group name at the top of the window.4. Click Save and Close on the main toolbar to save the name change. The User Navigator window re-displays showing the updated data.Deleting Ownership Groups 1. In the left windowpane, right-click the Ownership Group to be deleted. 2. Select Delete from the menu.If the Ownership is actively applied to content in Vasont, then a warning message will display. The message will state the number of primary components to which the ownership group is ap- 2 plied. If you click Yes to proceed with the deletion of the ownership group, then the ownership group will be removed from the each of the primary components to which it is applied in Vasont. If you click No, then the ownership group will not be deleted.3. On the pop-up Warning message window, click Yes to confirm the deletion. The User Navigator window re-displays. The group has been removed. 4. Or click No to cancel the delete action and return to the User Navigator window.Languages Vasont has the capability to provide interfaces in different languages. It does this by including a language with a person's user data. Language is entered while creating or modifying this data in Vasont Administrator. (See Creating New Users or Updating Users). The default language is English. The language selection indicates the language to be used in all Vasont windows, menus, buttons, etc.Electronic Mail Vasont has the capability to allow users to send email to any user defined in the User Navigator. It does this by including an email address with a person's user data. One example of using email is having a Processing Option associated with Workflow, such as email_task, that automatically sends an email to a user for whom workflow tasks are generated. When an email address is entered for a user, the email icon displays by the user's name. A Vasont shortcut is attached to emails generated from Vasont. The shortcut helps the user quickly login and get to the content from which the email was initiated.If you are unable to use the email shortcuts due to an application hosting environment, you may 2 choose to disable the email shortcut functionality. See Email_Vasont_Shortcut in System Profiles.158 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideTo configure the email functionality in your system, see Configuring Vasont E-mail.User Navigator Reports The following User Navigator reports are available: Users, Roles, Workgroups, User Information, and Vasont Li- cense Report.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 159 Creating and Maintaining Users or Roles160 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide Creating Vasont PreviewsThe Vasont preview system allows users to view their content in a styled format that closely resembles the published output. Many publishing systems use a complex publishing engine to produce precision output. The Vasont preview system is not meant to replace the publishing system, but instead provide a rapid view of the content within the content management system. Additional preview options can be added to the system to display content to emphasize items that are meaningful to you and your users. Perhaps you would like one preview option that displays pieces of content metadata, while another preview shows components with multiple uses. In Vasont, the preview is located in the Details Pane. For more information on how the preview works, see the The Vasont Environment chapter in the Vasont User Guide.The preview system converts Vasont XML output to an HTML format. In order to do this, specialized items are required to produce the previews from standard Vasont content. • A Vasont Extract View that produces XML content and uses the processing option append_entity_pi_to_tag. • A standard CSS file that contains style definitions for each XML element that may be encountered in the XML file. • An XML file which follows the VasontXmlHtmlConversion.dtd (listed below), that is a map of XML elements and entities that need to be converted into non-standard HTML types. This file is known as the map file. Once these pieces are put into place, a Vasont Style can be created in the Vasont Administrator's Content Navigator. The Style is then assigned to the Edit View component in a collection. This means that each collection is specifically configured for preview. A Style may be used for multiple collections if the data model is similar, but the Preview Extract View must be defined in each collection. The following sections provide instructions for creating and putting the pieces together and providing preview functionality in the Vasont navigator. • Creating a Map File and Loading into the Vasont Administrator. • Creating a Cascading Style Sheet and Loading into the Vasont Administrator. • Creating a Vasont Style. • Creating a Collection Preview Extract View. • Assigning the Vasont Style and Preview Extract View to a Collection Edit View component.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 161 Creating Vasont PreviewsAt the end of the chapter there are some samples of previews that may be useful in your environment. These are just some ideas that Vasont Systems's analyst came up with, you may have more useful ideas of your own.Preview Map File A map file is required, even if all the XML elements conform to HTML elements. At a minimum the map file needs to contain the root element of vasont.xml.html.conversion. Normally all XML elements are converted into HTML <DIV> elements which allows for custom styling but otherwise each <DIV> element is treated as plain text. The exceptions are for elements that require special display. Ex- amples of these are images, tables, and lists. Entries in the map file only have to be made for elements that require special display handling. A map file consists of one or more <element.conversion> sections and zero or more <entity.conversion> section. Each element conversion section does special display handling to convert one XML element to one HTML element. Each entity conversion section converts one character entity into its character. This is the DTD for map files: <!- - ******************************************************************* FILENAME: VasontXmlHtmlConversion.dtd VERSION: 1.0 DATE: January 10, 2008 - -> REVISED: December 31, 2008 <!- - ******************************************************************* Formal Public Identifier: "-//Vasont Systems//DTD VasontXmlHtmlConversion v1.0 20080110//EN//XML" ************************************************************** - -> <!ELEMENT vasont.xml.html.conversion (element.conversion+ | entity.conversion* | nextchange.conversion?)*> <!ELEMENT element.conversion (xml, html, processor?, attribute.conversion*, attribute.addition*)> <!ELEMENT nextchange.conversion (xmlattrib, htmlattrib, attribute.value*)> <ELEMENT entity.conversion (name, value) > <!ELEMENT xml (tag, parent*)> <!ELEMENT html (#PCDATA)> <!ELEMENT xmlattrib (#PCDATA)> <!ELEMENT htmlattrib (#PCDATA)> <!ELEMENT processor (#PCDATA)> <!ELEMENT attribute.conversion (xmlattrib, htmlattrib)> <!ELEMENT attribute.addition (attribute, value)> <!ELEMENT tag (#PCDATA)> <!ELEMENT parent (#PCDATA)> <!ELEMENT attribute (#PCDATA)> <!ELEMENT value (#PCDATA)> <!ELEMENT name (#PCDATA)> <!- - ******************************************************************* - -> The following is a sample conversion map for a DocBook type of structure: <?xml version="1.0" encoding="UTF-8"?> <vasont.xml.html.conversion> <element.conversion> <xml><tag>graphic</tag></xml> <html>img</html> <attribute.conversion> <xmlattribute>fileref</xmlattribute> <htmlattribute>src</htmlattribute>162 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide</attribute.conversion> <attribute.conversion> <xmlattribute>width</xmlattribute> <htmlattribute>width</htmlattribute> </attribute.conversion> <attribute.conversion> <xmlattribute>depth</xmlattribute> <htmlattribute>height</htmlattribute> </attribute.conversion> <processor>Vasont.XMLHTMLConversion.ImageConversionProcessor</processor> </element.conversion> <element.conversion> <xml><tag>inlinegraphic</tag></xml> <html>img</html> <attribute.conversion> <xmlattribute>fileref</xmlattribute> <htmlattribute>src</htmlattribute> </attribute.conversion> <attribute.conversion> <xmlattribute>width</xmlattribute> <htmlattribute>width</htmlattribute> </attribute.conversion> <attribute.conversion> <xmlattribute>depth</xmlattribute> <htmlattribute>height</htmlattribute> </attribute.conversion> <processor>Vasont.XMLHTMLConversion.ImageConversionProcessor</processor> </element.conversion> <element.conversion> <xml><tag>orderedlist</tag></xml> <html>ol</html> </element.conversion> <element.conversion> <xml><tag>itemizedlist</tag></xml> <html>ul</html> </element.conversion> <element.conversion> <xml><tag>listitem</tag></xml> <html>li</html> </element.conversion> <element.conversion> <xml><tag>table</tag></xml> <html>table</html> <processor>Vasont.XMLHTMLConversion.DitaTableProcessor</processor> </element.conversion> <element.conversion> <xml><tag>row</tag></xml> <html>tr</html> </element.conversion> <element.conversion> <xml><tag>tbody</tag></xml> <html>tbody</html> </element.conversion> <element.conversion>VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 163 Creating Vasont Previews<xml><tag>thead</tag></xml> <html>thead</html> </element.conversion> <element.conversion> <xml><tag>entry</tag></xml> <html>td</html> </element.conversion> <entity.conversion> <name>rsquo</name> <value>?</value> </entity.conversion> </vasont.xml.html.conversion> The following table covers sections of this map file in detail:XML fragment Comment <vasont.xml.html.conversion> This is the root element for a preview map. Each map file </vasont.xml.html.conversion> must have one open and close tag like this. <element.conversion> This element contains the conversion for one XML element type to an HTML element. A preview map can have many </element.conversion> of these elements. <element.conversion> Here is a simple conversion example. The XML file gener- <xml> ated from Vasont identifies a table cell as an entry but HTML only recognizes table cells as td elements. <tag>entry</tag> </xml> <html>td</html> </element.conversion> <element.conversion> This is another simple conversion. But this time a tbody is <xml> being converted into a tbody. Why would we need this? Remember that the default is to convert all XML elements <tag>tbody</tag> to DIV HTML elements. Since HTML displays a tbody ele- </xml> ment as the body of a table and that's what we want we need to make sure that tbody in XML remains tbody in HTML. <html>tbody</html> </element.conversion> <attribute.conversion> The attribute.conversion tag is used when an attribute in the <xmlattribute>href</xmlattribute> XML is significant to the display. As a general rule none of the XML attributes are used in the preview and they are not <htmlattribute>src</htmlattribute> transferred to the HTML. But there are cases when they are </attribute.conversion> needed. In the example, the href attribute in the XML identifies an image file that needs to be included as the src attribute in the HTML. <processor> We use the processor tag to identify elements that need custom conversion. In this case, because DITA and HTML Vasont.XMLHTMLConversion.DitaTableProcessor handle table definition very differently, we must use custom processing for the conversion (see the custom processors </processor> section below).164 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideXML fragment Comment <entity.conversion> This element contains the conversion for one character entity into its associated character element. A preview map </entity.conversion> can have zero, one or many of these elements. <entity.conversion> Here is an entity conversion example. The entity ' <name>rsquo</name> will be converted to its value. There should be an entity conversion for any entities that might be used in your docu- <value>?</value> ments. </entity.conversion>Custom Processors When the XML is so different from the HTML that simple tag and attribute conversion will not produce the desired result, special code is necessary to make the conversion. Vasont Systems has designed the preview system to be extensible by use of the processor tag to identify elements that need custom conversion. The custom processors are developed by Vasont Systems and can be made to handle just about any conversion necessary. Currently there are two custom processors available: • Vasont.XMLHTMLConversion.DitaTableProcessor • Vasont.XMLHTMLConversion.ImageConversionProcessor Creating Map Files Use these steps to develop a Map file for your collection: 1. Generate an XML file for the content you wish to preview. 2. Using this file, identify the XML elements that need to display in a fashion other than HTML DIV elements. The easiest way to do this is to look for items like ordered and unordered lists, list items, tables and parts of tables and images. 3. For each XML element that requires special display, determine the HTML element that will best display it and write an element conversion section: <element.conversion> <xml> <tag> XML tag name </tag> </xml> <html> HTML tag name </html> </element.conversion> 4. For each XML element determine if there are any attributes whose values might need to be included for display purposes. A good example would be the width attribute for an image. If attributes need to be included add them to the <element.conversion> like this: <attribute.conversion> <xmlattribute>width</xmlattribute> <htmlattribute>width</htmlattribute> </attribute.conversion> 5. For each XML element determine if there is a need for special processing and include a custom processor line like this:VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 165 Creating Vasont Previews<processor>Vasont.XMLHTMLConversion.ImageConversionProcessor</processor> 6. Add each XML entity add an <entity.conversion> and define the character to be displayed. <entity.conversion> <name>mdash</name> <value>—</value> </entity.conversion> 7. Finally verify that the entire map file is well-formed XML and is valid per the DTD. Note: you should not include the DTD in the DOCTYPE declaration as this will require the DTD to be present on client machines. Load the Map file into the Vasont Administrator, and pair it with a Cascading Style Sheet to create a Vasont Style. See Loading the Map File , Cascading Style Sheet for Preview, and Creating a Style for more information. Loading the Map File To load the preview map file: 1. In the Vasont Administrator's Content Navigator, right-click on Styles→Conversion Maps. Select New.2. A File Selection window appears. Navigate to the location where the conversion map file resides. Select the conversion map and click Open.3. The New Conversion Map window appears, showing the conversion map filename.166 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide4. Click Save and Close. 5. The newly added conversion map is listed in the right window pane.Editing the Map File To make alterations to the conversion map file: 1. In the Vasont Administrator's Content Navigator, select Styles. The available conversions maps will be listed in the right-window pane. 2. Right-click on the conversion map to be edited. Select Update.3. The Update Conversion Map window appears. Click View/Edit.4. If a conversion map with the same filename already exists in the Temp folder a warning message will occur. Click Yes to continue and overwrite the existing file in the Temp folder. 5. If a file association for xml is set on your machine, the conversion map will display in the assigned application. Otherwise, open the Temp folder and locate the conversion map that has been extracted. Open the conversion map in an editorial tool to make the edits.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 167 Creating Vasont Previews6. After the edits have been made and saved, return to the Vasont Administrator and click Save on the Update Conversion Map window.When the revised conversion map has been loaded to the Vasont Administrator, it should then be tested in Vasont to be assured that the new version is being read by the preview program. Testing should begin by creating a fresh preview for the component to which you have configured the preview. Deleting the Map File To delete a conversion map from the Vasont Administrator: 1. In the Vasont Administrator's Content Navigator, select Styles. The available conversions maps will be listed in the right-window pane. 2. Right-click on the conversion map to be deleted. Select Delete.3. A message will display, asking for confirmation of the deletion. Click Yes to continue with the deletion. 4. If the conversion map is not currently assigned to a collection preview, the deletion will occur. But if the conversion map is in use, an Unable to Delete message will display. Click OK. In order to delete the conversion map, locate the Style where the conversion map is being used and update the conversion map assignment. See Editing Styles for more information.Cascading Style Sheet for Preview The Cascading Style Sheet (CSS) will determine the display of the HTML file that Vasont has converted via the Preview Map file. Create the Cascading Style Sheet using the tool of your choice. If you already have a CSS for your content, it may be a good starting point and minimize the amount of work needed to define each element and its appropriate display. If you are unfamiliar with Cascading Style Sheet files a good tutorial is available at http://www.w3schools.com/css/ default.asp. Keep in mind that the cascading style sheet should contain entries for the converted HTML. So if you are not seeing the results that you expect, it may be due to the element name placed in the cascading style sheet. Load the Cascading Style Sheet into the Vasont Administrator. The CSS will be paired with a Preview Map file to create a Vasont Style.168 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideA CSS file is made up of rules. Each rule consists of two parts: the selector and the property list. Since this styling will be applied to an HTML document and your CSS file was probably meant to style XML there are some selectors and properties of XML CSS that will not be supported. Try to avoid using unsupported selectors as described below. However unsupported stylings will not cause your preview to fail but the results may not look as you expect.CSS Selectors Supported by Vasont• Universal— *• Descendant— element1 element2• Child— element1 > element2• Attribute - present— [attr]• Attribute - value equals— [attr="value"]• Attribute - value matches— [attr~="value"]• Attribute - value before hyphen matches— [attr|="value"]• Adjacent— element1 + element2• Pseudo-class— :first-childCSS Selectors NOT Supported by Vasont• Pseudo-element— :before• Pseudo-element— :after• Class selectors— (not available in XML CSS)• ID selectorsCSS Properties NOT Supported by Vasont• Any property that generates text as opposed to styling text like the content property.The Preview extract view may be configured to aid in the display of generated text. By using a com- 2 bination of wrappers and processing options you can insert generated text phrases into the extracted XML for Preview.Loading the Cascading Style SheetTo add the Cascading Style Sheet to your Vasont setup:1. In the Vasont Administrator's Content Navigator, right-click on Styles→Cascading Style Sheets. Select New.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 169 Creating Vasont Previews2. A File Selection window appears. Navigate to the location where the cascading style sheet resides. Select the cascading style sheet and click Open.3. The New Cascading Style Sheet window appears, showing the style sheet filename.4. Click Save and Close. 5. The newly added cascading style sheet is listed in the right window pane.Editing the Cascading Style Sheet To make alterations to the cascading style sheet: 1. In the Vasont Administrator's Content Navigator, select Styles→Cascading Style Sheets. The available cascading style sheets will be listed in the right window pane. 2. Right-click on the cascading style sheet to be edited. Select Update.170 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide3. The Update Cascading Style Sheet window appears. Click View/Edit.4. If a cascading style sheet with the same filename already exists in the Temp folder a warning message will occur. Click Yes to continue and overwrite the existing file in the Temp folder.5. If a file association for the CSS file extension is set on your machine, the cascading style sheet will display in the assigned application. Otherwise, open the Temp folder and locate the cascading style sheet that has been extracted. Open the cascading style sheet in an editorial tool to make the edits.6. After the edits have been made and saved, return to the Vasont Administrator and click Save on the Update Cascading Style Sheet window.When the revised cascading style sheet has been loaded to the Vasont Administrator, it should then be tested in Vas- ont to be assured that the new version is being read by the preview program. Deleting the Cascading Style SheetTo delete a cascading style sheet from the Vasont Administrator:1. In the Vasont Administrator's Content Navigator, select Styles→Cascading Style Sheets. The available cascading style sheets will be listed in the right window pane.2. Right-click on the cascading style sheet to be deleted. Select Delete.3. A message will display, asking for confirmation of the deletion. Click Yes to continue with the deletion.4. If the cascading style sheet is not currently assigned to a collection preview, the deletion will occur. But if the cascading style sheet is in use, an Unable to Delete message will display. Click OK.In order to delete the conversion map, locate the Style where the cascading style sheet is being used and update the cascading style sheet assignment. See Editing Styles for more information.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 171 Creating Vasont PreviewsCreating a Style A Vasont Style needs to be created in the Vasont Administrator in order to assign the style to a collection component. A Style consists of a Cascading Style Sheet file, a map file, and a name. Before you can create the Style, the Map file and the Cascading Style Sheet need to be loaded into the Vasont Ad- ministrator. See Loading the Map File and Loading the Cascading Style Sheet for more information. To create the Style: 1. In the Vasont Administrator's Content Navigator, right-click on Styles and select New.2. The New Style window appears. Enter a name for the new Style.3. Using the drop-down lists, select a Cascading Style Sheet and Conversion Map.4. Click Save and Close. 5. The new Style will appear in the listing in the right window pane. Notice that the display shows the map and cascading style sheet.172 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideNow that the Style has been assembled, the next step is to assign it to a collection. See Assigning a Style for the Collection for more information. Editing Styles To make alterations to the Style: 1. In the Vasont Administrator's Content Navigator, select Styles. The available styles will be listed in the right window pane. 2. Right-click on the style to be edited. Select Update.3. The Update Style window appears. Make the desired alterations.4. Click Save and Close. Deleting Styles To delete a style from the Vasont Administrator: 1. In the Vasont Administrator's Content Navigator, select Styles. The available styles will be listed in the right window pane. 2. Right-click on the style to be deleted. Select Delete.3. A message will display, asking for confirmation of the deletion. Click Yes to continue with the deletion. 4. If the style is not currently assigned to a collection preview, the deletion will occur. But if the style is in use, an Unable to Delete message will display. Click OK. In order to delete the style, locate the collection where the style is being used and remove it. See Deleting a Style Assignment for more information.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 173 Creating Vasont PreviewsChecking Style Usage To locate where a Style is being used: 1. In the Vasont Administrator's Content Navigator, select Styles. In the right window pane, right-click on the style and select Where Used.2. The Style Filter appears. Select the Content Type and Collection to be searched for results. Click OK.3. The Where Used window appears.4. Right-clicking on an entry in the listing will present a menu that will allow you to open a navigator, make updates or deletions.174 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideCreating Extract Views for Preview1. In the Vasont Administrator's Content Navigator, select the collection where you wish to create the Preview Extract. Right-click on Extract View and select New.2. The New Extract View window appears. On the General tab: a. Enter a name for the Extract View. Give a name to the view that clearly defines it as a Preview extract. b. Enter an xml declaration. c. Set the View Type to Utility Extract.On the Processing Options tab: a. Apply the bypass_application_launch processing option. b. Apply append_entity_pi_to_tag processing option. c. Apply client_key_filename processing option. This will provide a name for the extracted preview file.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 175 Creating Vasont PreviewsThe Preview Extract should not contain processing options for check out operations that will un- 2 intentionally check out the component just because a preview has been created or updated.On the Advanced tab check the Vasont Administrator Use Only box.The purpose of this selection is to hide the extract view from the users. Since the extract view is strictly for Preview purposes, there is no need to have it listed when doing an editorial or publish- 2 ing extract. You may wish to make this selection after you have completely tested the Preview setup. This will allow you perform extracts to observe and troubleshoot the tagging.3. Click Save and Close. 4. Open a navigator for the new Preview Extract. Open a navigator for a publishing extract view. Using a drag and drop with the Control key, clone the structure from the publishing extract navigator to the new Preview Extract navigator.5. Changes to consider making to the components of the new Preview Extract view: • Cross reference content will appear in the preview as long as a ref_text processing option has been applied to the pointer component and the referenced content contains text that can be displayed.176 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideIf the cross reference component is defined as an “element”, then the tag must be manipulated to allow the cross reference text to be entered in the component on extract.• Adjustments may be required for attributes in order to create the display you desire. This can be achieved by adding or deleting attributes on the component, or by applying the extract_value processing option to set an attribute value for the extracted component. • Wrappers in the extract view can be manipulated in two ways: a. Change the wrapper setting for a specific component and select a new wrapper from the drop-down list. This option is valid as long as a sibling component is not already using the desired wrapper.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 177 Creating Vasont Previews b. Apply the change_tag_name processing option. This processing option allows you to type a new name for the wrapper, and ignore the wrapper selection on the component.• Modular content will appear in the preview as long as a ref_extract or similar reference processing option has been applied in the pointer component in the Preview Extract view.Warning: Before including referenced content in your Preview, carefully consider some of the limitations: • If the referenced content is a large chunk of data, it may be confusing to users in Vasont when the red arrow indicator, that shows the position of the selected component in the tree view, does not move or appears to be missing. • If applying a visual annotation to a piece of content that is actually referenced from another collection, the visual annotation will be placed on the pointer component rather than the specific piece of content intended for the annotation. • The message that indicates whether the Preview is out-of-date displays based on changes to the components in the collection where the Preview is displayed. The referenced content may be out-of-date, but there will be no indication in the Preview. Once the Preview Extract has been created you will need to assign it to the Edit View component in the collection. Refer to Assigning a Style for the Collection for more information.Assigning a Style for the Collection A Style can be associated with a Preview. The Style must first be associated with a Collection. In order to successfully assign a Style to a collection, the Style and the Preview Extract view must first be created. See Creating a Style and Creating Extract Views for Preview for more information. 1. In the Vasont Administrator's Content Navigator, select the collection where you wish to assign the Style.178 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide2. Select Edit View in the left window pane. In the right window pane, right-click on the Edit View and select Open Navigator.3. In the Edit View navigator, right-click on the component that you would like to configure for preview and select Update. The component may be a primary or sub-component that makes sense for displaying (i.e., Chap- ter, Topic, Section, or Procedure).4. Select the Preview tab. Right-click in the window and select Add. Give the new preview a name. Using the drop-down lists, set the appropriate Style and Extract View. If you are creating a preview for displaying translated raw material, then check the Translation View box. If you are creating more than one preview, repeat the steps to add each of the preview styles needed.A translated raw material preview is a special preview that gives a user an idea of how much 2 of their base content is already translated to a selected language and stored in the system's raw material. When the Translation View box is checked, the users select the translation preview option in Vasont, and a language selection window will appear. Once the language is selected, the preview display will appear in a bilingual presentation, providing any of the base content has existing raw material translations for the chosen language. For an example, see Preview for Dis- playing Stored Translation Content.In order to make your selection, the Style and Extract view must first be created. See Creating a 2 Style and Creating Extract Views for Preview for more information.If the appropriate fields are not populated, the user is prompted to fix the entries before saving. Click OK to dismiss the window and make the necessary alterations to the Style entries. 5. Click Save and Close. After assigning the Style, test the preview availability in the Vasont Details Pane. Updating a Style Assignment To alter the Style assignment for a collection: 1. In the Vasont Administrator's Content Navigator, select the collection for updating. Select Edit View. 2. In the right window pane, right-click on the Edit View and select Open Navigator.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 179 Creating Vasont Previews3. In the Edit View navigator, right-click on the component that you would like to configure for preview and select Update. The component may be a primary or sub-component that makes sense for displaying (i.e., Chap- ter, Topic, Section, or Procedure). 4. Select the Preview tab. 5. Using the drop-down lists, change the settings as needed. 6. Click Save and Close. After altering the Style assignment, test the preview availability in the Vasont Detail Pane. Deleting a Style Assignment To remove the Style assignment for a collection: 1. In the Vasont Administrator's Content Navigator, select the collection where the Style will be deleted. Select Edit View. 2. In the right window pane, right-click on the Edit View and select Open Navigator. 3. In the Edit View navigator, right-click on the component that you would like to configure for preview and select Update. The component may be a primary or sub-component that makes sense for displaying (i.e., Chap- ter, Topic, Section, or Procedure). 4. Select the Preview tab. 5. If you are deleting a Preview style, right-click on the entry and select Delete. 6. Click Save and Close.Troubleshooting the Preview Display Here are some hints for testing and troubleshooting your Preview development: • Perform extracts using the Preview Extract to determine what the XML looks like before passing to the conversion map. • If the collection references modular content, modular extracts views for Preview may also be necessary. • Remember that XML elements are converted into HTML <DIV> elements, which are treated as plain text unless special processing or attributes have been applied. Image Display Problems: • Does the conversion map contain an entry for the graphic? • Does the conversion map contain an attribute entry for the graphic? • Does the conversion map contain a processor entry for the Image Converter? • See Preview Map File for more information and samples. Table Display Problems: • Does the conversion map contain an entry for the table, table head, table body, row and entry? • Does the conversion map contain an entry for the Table Processor? • Is the table extracted in the CALS or HTML table model? • See Preview Map File for more information and samples. List Display Problems • Does the conversion map contain an entry for the list? • Does the conversion map contain an entry for the list item?180 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide• See Preview Map File for more information and samples. Reference Text Display Problems: • Does the cross reference component contain the ref_text processing option? • Does the cross reference wrapper allow text? • Does the referenced component contain any text for displaying? • See Creating Extract Views for Preview for more information. Modular Content Display Problems: • Does the modular pointer component contain the ref_extract processing option? • See Creating Extract Views for Preview for more information. Indexterm Display Problems: • Does the index term contain attributes for altering the display, such as color, size, font weight? • Does the index term contain a change_tag_name or wrapper? • Are the primary, secondary and tertiary index term tags tracked in Vasont? • See Creating Extract Views for Preview and Preview Map File for more information.Vasont Preview Daemon To see a preview of the content in the Vasont navigator, it must first be generated or refreshed. Depending on the size of the content, it may take some time to create the previews. To help keep the previews up-to-date, a daemon program is available from Vasont Systems that will automatically create and refresh the previews. This program will save time by updating previews automatically, rather than depending on a user to initiate or update the preview. An XML file containing configuration parameters for the Vasont Preview Daemon must be setup before the daemon can be run. A sample version, VasontExtractConfigExample.xml, is included as part of the installation. It is sugges- ted that the supplied sample be copied to another file for editing and use by the daemon program, so that the original sample can be maintained for reference. The name of the configuration file is not important, as the full path and filename must be supplied to the daemon program as a command-line argument. More information about the configuration file will be included with the installer package. To run the Vasont Preview Daemon from a command line, change directories to the location of the daemon program. The daemon program requires a full path and filename of the XML configuration file to be passed to it. The daemon searches each component within the system where preview is enabled. A preview will be generated if one has not been created, or a preview will be updated if the component has been altered since the last preview generation. To run the daemon on a scheduled basis, simply set up the Windows scheduling software of your choice to execute the daemon. If you are using Vasont Preview and are interested in using this program, contact your Vasont Project Leader to obtain the installer and instructions for implementation.To improve the efficiency of previews, consider modularizing your content. For example, if updates 2 and reviews occur at the chapter level of your documents, consider moving chapters into a collection of their own. For more information on modularizing content, see Creating a Modularized Content Model for Reuse. Another option is to apply styles to more sub-components. For example, if you are currently creating previews at the Chapter level, consider applying a preview style to a Section or Procedure. This will reduce the amount of content that will display in the Preview pane.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 181 Creating Vasont PreviewsPreview Samples Many types of previews can be created to display your content. You can use a preview purely for reading the content in a presentation that is void of technical markup, or you can create previews that visually present more information about the data. The following samples will give you some ideas about using previews to display content, as well as providing information about the data that will make the user's job easier. Preview for Displaying Stored Translation Content It is possible to create a Vasont preview of base content and substitute translated language content where available in the system. This functionality allows you to determine how much of the content is already available in the system for the selected language and how much will go to a translation vendor. Having this information before the base language document is finalized gives you the opportunity to reword or rewrite content to reduce translation costs.The translation preview must be configured in the Vasont Administrator similar to other preview displays, but with a few key differences: 1. Extract View: This extract view should match your normal preview extract view with one exception. On the header of the translation preview extract view, the substitute_raw_translation processing option must be applied. The component_translate_attribute argument defines the attribute that will be placed on the components in the preview file when raw material for the selected language is found. This attribute is only visible to the preview engine and it is not viewable in the extracted XML or the converted HTML. The value argument de-182 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide fines the value that will be placed into the preview file when raw material for the selected language is found. This attribute and value provide a hook for styling the content in the preview pane.2. Cascading Style Sheet: If you choose to highlight translated content with a colorful background, then you will need to alter your Cascading Style Sheet (CSS) with the appropriate formatting. In the following screenshot, notice the formatting that will cause components with a translation attribute to display with a colored background screen.3. Edit View Style: Define the style in the Edit View update window, just as you would for any other preview. Check the Translation View box, so when this type of preview is selected in Vasont, a language selection list will display. Once the user selects the language they desire, the information is passed to the extract process. The available translated content substitutes the base language text, and the translation attributes are applied in the extracted preview file.Preview for Displaying Modular Reuse and BranchesPreviews can be created to show various types of reuse, such as, modules that are referenced from maps or manuals more than once, modules that are a branch or source of a branch, and components that are the source of a conrefVAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 183 Creating Vasont Previews(component containing the content that is being referenced). Having a visual display of this reuse helps you to easily see how the alterations you plan to make may effect other user's content.The reuse preview must be configured in the Vasont Administrator similar to other preview displays, but with a few key differences: 1. Extract View: This extract view should match your normal preview extract view with a few exceptions. The primary component should contain attributes to store modular reuse and branch metadata. In this sample, an attribute named Vasont Reuse has the extract_attrib_modular_uses processing option applied. In Vasont, when the content is extracted for a preview, this processing option will place VasontReuse="yes" in the XML if the primary is referenced more than once by a modular pointer component. The reference components typically reside in a Map or Manual.184 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideAlso in this sample, an attribute named VasontBranch has the extract_attrib_branches processing option applied. In Vasont, when the content is extracted for preview, this processing option will place Vaso- ntBranch="yes" in the XML if the primary is a branch or source of a branch.In this sample, components that are typically the source of a conref have a VasontConref attribute with ex- tract_attrib_conref processing option applied. In Vasont, when the content is extracted for a preview, this processing option will place VasontConref="yes" in the XML if the component is referenced by another component with a conref.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 185 Creating Vasont PreviewsYou may also want to add the ref_extract_conref processing option so that components that contain a conref attribute will pull the referenced content into the preview display. Otherwise, the display will be void of the referenced content and users who are examining the preview may not be aware of the intended content.2. Cascading Style Sheet: Alter your Cascading Style Sheet (CSS) with formatting for component with Vaso- ntBranch, VasontReuse, or VasontConref attributes. In the following screenshot, notice the formatting that will cause components with these attributes to display with a colored background screen or a colored border.3. Edit View Style: Define the Reuse style in the Edit View update window, just as you would for any other preview.Preview for Displaying Component Reuse The where used preview must be configured in the Vasont Administrator similar to other preview displays, but with a few key differences: 1. Extract View: This extract view should match your normal preview extract view with a few exceptions. Com- ponents that you choose to highlight and may contain text should contain an attribute to store where used metadata. In this sample, an attribute named Vasont WhereUsed has the extract_attrib_where_used processing op-186 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide tion applied. In Vasont, when the content is extracted for a preview, this processing option will place Vaso- ntWhereUsed="yes" in the XML if the component's raw material is used more than once.2. Cascading Style Sheet: Alter your Cascading Style Sheet (CSS) with formatting for components with Vaso- ntWhereUsed attributes. In the following screenshot, notice the formatting that will cause components with this attribute to display with a colored background screen or a colored border.3. Edit View Style: Define the WhereUsed style in the Edit View update window, just as you would for any other preview.Preview for Displaying Conditional ContentThe conditional attribute preview identifies content in the display that has a conditional attribute setting. When content contains multiple conditional components, the display can become a little cluttered. This type of preview makesVAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 187 Creating Vasont Previews deciphering the display a little easier for the user. The conditional attribute preview must be configured in the Vas- ont Administrator similar to other preview displays, but with a few key differences:1. Extract View: The audience and product attributes are a routine part of the DITA XML, so nothing special needs to be applied to the components or the attributes in the extract view for preview purposes. 2. Cascading Style Sheet: Alter your Cascading Style Sheet (CSS) with formatting for components with product and audience attributes. In the following screenshot, notice the formatting that will cause components with these attributes to display with a colored background screen or a colored border.Generating a Preview Color Key If you choose to add color to your preview display for a visual indication of where specific properties exist, you may also need to add a key or legend to give the users information for understanding what they see in the preview pane. The following sample gives you one idea on how you can pass a key along with the data for preview display:The data in this sample supports two products and two deliverables. The product attribute is used to identify components that specifically exist in the “Life-Support” or “All-Med” product documentation. The audience attribute identifies components that will exist in the published “healthcare professionals” documentation or the “marketing”188 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide literature. A color has been assigned to each of these four values so that the preview display can give the user a visual indication of where the conditional text exists in the content. There are several ways that you may accomplish a color key; this is one suggestion. To create the color key for display, alter the XML file that is delivered to the preview engine so that the key text is available, and add formatting for the color key components in the Cascading Style Sheet: 1. Extract View: The primary component in this extract view contains the append_text_to_tag processing option. The text argument is set to <[REUSE-KEY]>. The position argument is set to “after” and the tag argument is set to “begin”. This means that the preview XML will look like <concept><[REUSE-KEY]>. The <[RE- USE-KEY]> tag provides a hook in the XML for generating a color coded key in the preview display.A series of replace_text_patterns processing options on the extract view header operate off of the <[REUSE- KEY]> hook in the XML file.The first instance of the processing option searches for the <[REUSE-KEY]> and replaces it with the first part of the color key text and tagging. It embeds another <[REUSE-KEY]>, for triggering the next search function. Subsequence instances or replace_text_patterns hit on the <[REUSE-KEY]> and embeds the next part of the color key text and tagging. The color key tagging processes in this manner to break the arguments into sensible chunks and deal with input length limitations in the processing option's text arguments. For example: The XML file starts off with: <concept><[REUSE-KEY]>VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 189 Creating Vasont PreviewsThe first search and replace is defined as: P1="<[REUSE-KEY]>|<key1-snippet>METADATA KEY</key1-snippet><[REUSE-KEY]>" This will cause the XML file to look like this: <concept> <key1-snippet>METADATA KEY</key1-snippet> <[REUSE-KEY]> The second search and replace is defined as: P1="<[REUSE-KEY]>|<key2-snippet>product: <prod12-snippet>life_support</prod12-snippet> or <prod2-snippet>all_med</prod2-snippet></key2-snippet><[REUSE-KEY]>" This will cause the XML file to look like this: <concept> <key1-snippet>METADATA KEY</key1-snippet> <key2-snippet>product: <prod12-snippet>life_support</prod12-snippet> or <prod2-snippet>all_med</prod2-snippet> </key2-snippet> <[REUSE-KEY]> The third search and replace is defined as: P1="<[REUSE-KEY]>|<key2-snippet>audience: <aud1-snippet>healthcarepro</aud1-snippet> or <aud2-snippet>marketing </aud2-snippet></key2-snippet> This will cause the XML file to look like this: <concept> <key1-snippet>METADATA KEY</key1-snippet> <key2-snippet>product: <prod12-snippet>life_support</prod12-snippet> or <prod2-snippet>all_med</prod2-snippet> </key2-snippet> <key2-snippet>audience: <aud1-snippet>healthcarepro</aud1-snippet> or <aud2-snippet>marketing</aud2-snippet> </key2-snippet>. Now all of the text is tagged and embedded in the XML for displaying a color key.190 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide2. Cascading Style Sheet: Alter your Cascading Style Sheet (CSS) with formatting for color key components that you embedded in the XML preview file.Generating Note Labels In many publishing applications, the note element generates the"Note:" text. In fact, in some applications there are different types of notes (i.e., warnings, cautions, tips, etc.). This preview sample will show you how you can alter the extract view to include the note text.1. Extract View: The note component in the preview extract view contains the append_attribute_to_tag processing option. The attribute name argument defines the attribute on the component that contains the values you would like to append to the component's tag. In this example, the type attribute contains the value that needs to be pushed into the XML for displaying in the preview. The tag argument defines whether the begin or end tag should have the attribute value appended to it. The position argument defines where the attribute value should be placed in relation to the component's tag. The prefix and suffix arguments allow additional strings to be added to the attribute value, in this example, <snippet> tags are created for the attribute value. With the pro-VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 191 Creating Vasont Previews cessing option and arguments defined in this example, the XML file will look like <note type="important"><snippet>[important]</snippet>. This tag provides a hook that will be manipulated in further processes.The replace_text_patterns processing option is applied to the extract view header that is used for the preview.The processing option defines five search and replace strings because the note's type attribute has five possible values (shown in the following screenshot). Basically, the search string is looking for the value in brackets, and replacing with the same word but in uppercase characters. In addition, the brackets are dropped and a colon is added at the end of the word.P1="[attention]|ATTENTION:" P2="[caution]|CAUTION:" P3="[danger]|DANGER:" P4="[fastpath]|FASTPATH:" P5="[important]|IMPORTANT:"To summarize, with the processing option in place, the XML will look like this in the first pass of the extract:192 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideIn the second pass, the XML file looks like this:Now that the XML file contains the tagging and text for generating the note type, the style sheet must have a template for formatting the display. 2. Cascading Style Sheet: The style sheet defines formatting for outputting the snippet labels:VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 193 Creating Vasont Previews194 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide Generating and Using ReportsVasont Administrator reports offer a convenient way for you to gather information about your data, analyze the data, and then print and save the information for further use. All reports (except the Content Navigator Reports) are run from the Reports menu. Reports are divided into related categories: Raw Components, Edit View, Extract/Load View, Workflow, and User Navigator. When you run a report, the report toolbar displays above the report window and provides the following features:• Save As saves the report to a file. • Page Setup sets printing preferences. • Print Preview shows a preview of a printed page. • Print prints the report. • First, Prior, Next, and Last provide navigation through the report. • Close closes the report window.The report contents display at a type size that is optimal for outputting to a printing device. If the display is too small for you to view on your screen: 1) Click Print Preview, 2) Click View → Scale, 2 3) Set to the desired size.Saving Reports Report information can be saved to a file and used later for reference. 1. While viewing the report, click Save As on the report toolbar.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 195 Generating and Using Reports2. Select the folder where you want to store the file. From the Save As Type menu, select the file type you want to use. From the Encoding menu, select from ANSI/DBCS, <a href="/tags/Unicode/" rel="tag">Unicode</a> BE, Unicode LE, or UTF8.3. Enter a file name and click Save.Raw Component Reports Both Raw Component Reports, Basic and Detail, are generated the same way. 1. Select the report type from the menu. 2. From the Content Type Pick List, select a content type for which you want to generate a report.3. Click OK to view the report.196 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideBasicUse the Basic Report for Raw Components to view a list of raw components for a content type.From the report window you can see the raw component's description, raw class, alias, and alias ID.Drag the scroll bar to move through the information. DetailThe Detail Report for Raw Components contains a list of raw components for a content type.Use this report to view global change, editor tag, parse SGML/XML, text allowed, raw component default settings made by the user, and raw component ID data.Alias Attribute ReportsThe Attributes Report for Aliases contains data pertaining to the attributes that are applied to the Aliases in a specific content type.1. Select Reports → Aliases → Attributes.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 197 Generating and Using Reports2. From the Content Type Pick List, select a content type for which you want to generate a report.3. Click OK to view the report.Occurrence, valid values, SGML/XML type, and attribute link ID are some of the types of data shown. For more information on Alias attributes, see Alias Attributes.Edit View Reports All Edit View Reports are generated the same way. 1. Select the report type from the Reports menu. • Basic • Detail • Genealogy • Attributes • Global Change • Dynamic Indexes • Pointers • Undefined Pointers • Processing Options • Security198 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide2. From the Collections with Edit Views Pick List, select a collection for which you want to generate a report.This window does not appear for the Undefined Pointers report. See Undefined Pointers for more 2 information.3. Click OK to view the report. Basic The Basic Report for Edit View contains data for each collection component, and its specific usage, as well as the information entered on its General, Actions, Occurrence, and Inline tabs.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 199 Generating and Using ReportsDetail The Detail Report for Edit View contains data for each collection component, along with its specific usage, and the information entered on its advanced tab.Genealogy The Genealogy Report for Edit View contains data for each collection component, along with its specific usage, associated alias and raw component (with IDs), raw class, whether text is allowed, and the rule relation ID.200 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideAttributes The Attributes Report for Edit View contains data pertaining to the attributes for each collection component and its specific usage.Occurrence, valid values, SGML/XML type, and attribute link ID are some of the types of data shown. Global Change The Global Change Report for Edit View contains data for collection-specific parent/child component relationships that allow global change, the collection and collection component that would be affected by a global change, actions settings, and global change target behavior for each collection component.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 201 Generating and Using ReportsDynamic Indexes The Dynamic Indexes Report for Edit View contains data for the index collection, index component, and all collection components (and their specific usage) linked to an index collection on their dynamic indexes tab.Pointers The Pointers Report for Edit View contains data for each collection component designated as a pointer, the collection and collection components it points to, and other associated data.Undefined Pointers The Undefined Pointers Report lists all pointers found in your system that do not have pointer targets defined on the edit view component's Pointer tab. The report interrogates pointer components in all collections, in all content types. The results are alphabetically grouped by collection and then by component.202 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideWhen a pointer component does not contain any pointer targets, the pointer is not able to link to another component in the Vasont application. This report is helpful for quickly locating problem pointer components so that you may correct them. For more information, see Updating an Edit View Component, the Pointers tab section within item #3.Processing Options The Processing Options Report for Edit View contains data for each collection component, and its specific usage, that has one or more processing options attached to it along with the option name, event, and argument(s.)Security Component User Security Report for Edit View contains data for each collection component that has been assigned security information in the User Navigator. Data is shown for each user who has related security data, including the actions allowed.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 203 Generating and Using ReportsExtract/Load View Reports All Extract/Load View Reports are generated the same way. 1. Select Reports → Extract/Load View. • Basic • Attributes • Processing Options • On Wrappers • On Wrapper Attributes • On View • Translations • DTD • Component Validation 2. From the Extract/Load Views Pick List, select a collection and view for which you want to generate a report.3. Click OK to view the report.204 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideBasic The Basic Report contains general data for the selected view, followed by a list of collection components. Informa- tion shown on the General and Processing Options tabs of each collection component also displays.Attributes The Attributes Report contains general data for the selected view, followed by a list of collection components, their associated attributes, and information related to the attributes.Processing Options Processing Options Reports for Extract and Load Views provides valuable information when troubleshooting or understanding how content is being extracted or loaded into the system. Reports can be generated for Wrappers, Wrap- per Attributes, and Views.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 205 Generating and Using ReportsOn Wrappers The Processing Options Report for Wrappers report contains general version data for the selected view, followed by all wrappers that have one or more processing options attached to them. Each wrapper's associated collection component and processing options are displayed, along with each option's event and argument(s.)On Wrapper Attributes The Processing Options Report for Wrapper Attributes contains general version data for the selected view, followed by all wrappers that have one or more attributes with one or more processing options attached to them. Each wrapper's associated collection component, attributes, and processing options are displayed, along with each option's event and arguments.206 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideOn View Processing Options Report for View contains general data for the selected view, followed by any processing options applied directly to the view's header. The event and arguments also display for each processing option. Pro- cessing options are not displayed for specific components.Translations The Translations Report contains general data for the selected view, followed by collection components and their associated translations.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 207 Generating and Using ReportsDTD The DTD Report generates a DTD based on the extract or load view selected by the user. There are a number of items that may not be interpreted correctly, including occurrence indicators, the way elements are grouped, and con- nectors. You should review the report for inaccuracies.Component Validation The Component Validation Report compares the selected extract or load view components to the corresponding edit view components. If there are components found in the edit view, but are not present in the selected extract or load view, they will be listed in the report. This report will quickly point out where there are inconsistencies in extract and load view components so that you can fix them. For information on adding missing components, see Adding a New Load or Extract View. There are some components that intentionally only exist in the edit view. In the following screenshot, the FastEx- tractXMLBLOB, Support Document and XMLBLOB are special components for the edit view. They do not get extracted into the XML file, nor are they found in an XML file that is being loaded, therefore they are not added to the extract or load views. On the other hand, the equation component is one that appears in the XML and should be represented in extract and load views. Without the equation, the formatted content would not be complete for publishing. You will need to evaluate the components in the list to determine if they should or should not be added to the extract or load view.Workflow Reports All Workflow Reports are generated the same way. 1. Select Reports → Workflow. • Project Flow • Project Users208 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide• Project Workgroups • Project Processing • Project Attributes 2. From the Project Workflow Pick List, select a collection for which you want to generate a report.3. Click OK to view the report. Project Flow Task Flow Report for Project Detail is used to show the tasks for a project. The report shows the project description and the steps required for the specified project to be completed. Follow-on tasks are shown, as well as whether the follow-on task is optional or required.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 209 Generating and Using ReportsProject Users The User Assignment Report for Project Detail shows the project description and the tasks required for the specified project to be completed. The users assigned to each task are also shown, along with the user assignment type (this determines how a user is assigned to a task.)Project WorkGroups The Work Group Assignment Report for Project Detail shows the project description and the tasks required for the specified project to be completed. The assignment type is also shown, along with any work groups assigned to each task.210 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideProject Processing The Task Processing Options Report for Project Detail can be used to see how a project is processed. The project's tasks display along with any associated processing options.Project Attributes The Task Attribute Report for Project Detail is used to view attributes associated with tasks. It shows not only attributes, but also any applicable occurrence rules.Project Task Descriptions The Task Descriptions for Project Report is used to view the description associated with workflow tasks for a specific project. This report can be useful to document the activity that is intended to take place during the process-VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 211 Generating and Using Reports ing of a project. If the task descriptions are detailed enough, the report can be used as a procedural set of instructions for users.User Navigator ReportsAll User Navigator Reports are generated directly from clicking the report on the pull-down menu. Select Reports → User Navigator.• Users• Roles• Workgroups• User Information• Vasont License ReportUsersThe Users Report shows every user who has been created in the User Navigator and any of their assigned roles. The privileges each user has for each collection and any advanced capabilities or specific privileges that have been granted for any components are also provided.212 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideRoles The User Navigator Role Report shows the permissions that have been granted for each role, along with the users assigned to each role. If advanced capabilities, or specific privileges for any components are provided, these display as well.Workgroups The User Navigator Workgroup Report shows a list of all workgroups in the system and their users, if assigned.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 213 Generating and Using ReportsOwnership Groups The User Navigator Ownership Groups Report shows a list of all ownership groups in the system and their users, if assigned.User Information The Vasont User Information Report shows all users who have access to the current schema and any personal information that a user has entered using the User Profile utility in Vasont. This report also shows the seats that have been assigned to the user (i.e., Vasont, Review, Workflow, WebLNX, etc.).User Login Activity The User Login Activity Report provides login history for a selected user, users in a role, users in a workgroup, or for a date range. This report is helpful for gathering information about the usage of Vasont licenses and user access.214 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideSelect Reports → User Navigator → User Login Activity. A filter displays that allows you to select the criteria for the user logins that will be displayed in the report. Select the user, workgroup, role and a date range for the contents of your report.If a specific entry is selected in one of the filter panes and the other panes are set to “ALL”, then the specified entry will be used with the “Enable Date Range”. For example:• Choose a specific User, and set the Workgroup and Role to All. The report will display information for the selected user. If a date range is specified, then the report will display information for the selected user within the selected date range.• Choose a specific Workgroup, and set the User and Role to All. The report will display information for the selected users in the Workgroup. If a date range is specified, then the report will display information for the users in the selected workgroup, within the selected date range.• Choose a specific Role, and set the User and Workgroup to All. The report will display information for the selected users in the Role. If a date range is specified, then the report will display information for the users in the selected role, within the selected date range.• Choose All for Users, Workgroups, and Roles. The report will display information for anyone that logged into the system. If a date range is specified, then the report will display information for anyone who logged in within the selected date range.Click OK to generate the report.A login summary will display for each user in the report. The summary includes how many times the user logged in during the date range, and the average length of time for a session.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 215 Generating and Using ReportsWhen a user logs into the system and then logs out, information is stored in the database about their 2 session. If the user's session ends abnormally, no record will be recorded for the session.Since this report is based on functionality that is introduced in version ST 2.12 of Vasont, report con- 2 tents will only reflect login activity that has occurred since your system has been upgraded to ST 2.12.Vasont License Report The Vasont License Report provides information on the number of licenses available and those activated for a user's specific schema. The report heading will reflect the type of license model, “Simultaneous Seats” or “Named User Seats”.Comparison Reports Comparison reports provide a method for checking components, processing options, and attributes between two views. The reports will list items that are unique to each selected view. All Comparison Reports are generated directly from clicking the report on the pull-down menu. Select Reports → Comparison Reports. • Compare Components • Edit View Compare • Extract View Compare • Load View Compare • Compare Processing Options • Edit View Processing Options216 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide• Extract View Processing Options • Load View Processing Options • Compare Attributes • Edit View Attributes • Extract View Attributes • Load View Attributes • Client Key Exceptions • Edit View Client Key Exception • Extract View Client Key Exception • Load View Client Key ExceptionCompare ComponentsThe Compare Components Reports check for components that exist in one view but not in another. The reports help you to identify inconsistencies between two views that may otherwise go unnoticed until a problem occurs in the data processing. To compare the components in two different edit views, select Reports → Comparison Reports → Compare Components → Edit View Compare, Extract View Compare or Load View Compare. Select the Content Type and Source Collection using the drop-down lists. Select the Target Collection. Notice that the drop-down list only contains collections that have the same primary component as the Source Collection. When all selections are made, click OK to create the report. The report displays the components that were found to exist in one collection and not the other. The list is sorted by collection view so that you can clearly tell where the problem occurs. Evaluate each component to determine if it is an exception or a component that was overlooked in the configuration of the view. In the following example, Entity- DeclarationRef, FastExtractXMLBLOB, Support Document Ref and XMLBLOB are components that exist in the Concepts collection for special processing. These components are not needed in a collection where templates are stored, so it makes sense that they appear on the report as “missing” from the view.The extract and load view version of this report requires a few more selections because multiple extract or load views may exist. Choose a Content Type, Source Collection and Source View, and then the Target Collection and Target View. You can compare views in the same collection or in another collection with the same primary component as the Source Collection. In this example, notice that there are components in the Extract_Concepts_Editorial view in the Concepts collection, but they were not added to the Extract_Concepts_Editorial view in the Translated Concepts collection. Using this report, you are able to identify the problem and fix it before content is cloned from the Concepts collection to theVAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 217 Generating and Using ReportsTranslated Concepts collection. In a situation like this content would be dropped from the translated version of the content.Compare Processing Options The Compare Processing Options Reports check for components and their processing options that exist in one view but not in another. The reports help you to identify inconsistencies between two views that may otherwise go unnoticed until a problem occurs in the data processing. To compare the component's processing options in two different views, select Reports → Comparison Reports → Compare Processing Options → Edit View Processing Options, Extract View Processing Options, or Load View Processing Options. Select the Content Type and Source Collection using the drop-down lists. Select the Target Collection. Notice that the drop-down list only contains collections that have the same primary component as the Source Collection. When all selections are made, click OK to create the report. The report displays the components and their processing options that were found to exist in one collection and not the other. The list is sorted by collection view so that you can clearly tell where the problem occurs. Evaluate each processing option to determine if it is an exception or something that was overlooked in the configuration of the view. In the following example, create_new_from_template exists in the Concepts collection but not in the Transla- ted Concepts collection. This makes sense because Vasont users will not be creating new content in the translated collections, therefore there is no need to use content templates.This report compares the existence of processing options on components. It does not examine the ar- 2 gument values. If you need to compare or examine the argument values, use the basic view reports (see Processing Options and Extract/Load View Reports).The extract and load view version of this report requires a few more selections because multiple extract or load views may exist. Choose a Content Type, Source Collection and Source View, and then the Target Collection and Target View. You can compare views in the same collection or in another collection with the same primary component as the Source Collection. In this example, notice that there are components with processing options in the Extract_Concepts_Editorial view in the Concepts collection, but they were not added to the components in the Extract_Concepts_Editorial view in the218 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideTranslated Concepts collection. Using this report, you are able to identify the problem and fix it before content is extracted from the Translated Concepts collection. In a situation like this the extracted content would be missing the referenced MathRef content.Compare Attributes The Compare Attributes Reports check for components and their attributes that exist in one view but not in another. The reports help you to identify inconsistencies between two views that may otherwise go unnoticed until a problem occurs in the data processing. To compare the component's attributes in two different views, select Reports → Comparison Reports → Com- pare Attributes → Edit View Attributes, Extract View Attributes, or Load View Attributes. Select the Content Type and Source Collection using the drop-down lists. Select the Target Collection. Notice that the drop-down list only contains collections that have the same primary component as the Source Collection. When all selections are made, click OK to create the report. The report displays the components and their attributes that were found to exist in one collection and not the other. The list is sorted by collection view so that you can clearly tell where the problem occurs. Evaluate each attribute to determine if it is an exception or something that was overlooked in the configuration of the view. In the following example, the ProductManager attribute exists on the Concept component in the Concepts collection but not in the Template Concepts collection.This report compares the existence of attributes on components. It does not examine the property set- 2 tings of each attribute (i.e., valid values, occurrences, etc.). If you need to compare or examine the attributes, use the basic view reports (see Edit View Reports - Attributes, Extract/Load View Reports - Attributes and Processing Options - On Wrapper Attributes).The extract and load view version of this report requires a few more selections because multiple extract or load views may exist. Choose a Content Type, Source Collection and Source View, and then the Target Collection and Target View. You can compare views in the same collection or in another collection with the same primary component as the Source Collection. In this example, notice that there are attributes with processing options in the Extract_Concepts_Editorial view in the Concepts collection, but they were not added to the components in the Extract_Concepts_Editorial view in the Translated Concepts collection. Using this report, you are able to identify the problem and fix it before content isVAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 219 Generating and Using Reports extracted from the Translated Concepts collection. In a situation like this the extracted content would be missing the id attributes, so the component would not have an identification(id) in the XML file, and therefore would cause problems when reloading the file.Client Key ExceptionThe Client Key Exception Reports check for text components that are missing the typical client key processing options.• The Edit View Client Key Exception report will check the components in the selected edit view for the cli- ent_key_from_id processing option.• The Extract View Client Key Exception report will list components that do not have an attribute with the cli- ent_key processing option applied.• The Load View Client Key Exception report will list components that do not have an attribute with the cli- ent_key_load processing option applied.If a component is found in the selected view that does not have the processing option applied, it will be added to the report. These reports will quickly help you locate client key configuration problems in your setup and fix them.There are some components that intentionally do not have the client key processing options specified for the type of view (i.e., client_key_from_id, client_key_load, client_key). You will have to review the results and determine if the components are exceptions or if they need to be updated with a client key processing option. In the following example, FastExtractXMLBLOB and XMLBLOB are special components in the edit view that Vasont uses for processing; therefore they do not need to have client key values. The Title component gets extracted to the XML file and should have a client key processing option. You will need to investigate to see if the component has a different client key processing option (i.e., client_key_from_parent, client_key_from_mm_desc, etc.) or if there is a special configuration in place that doesn't require a client key processing option.Content Navigator ReportsFrom an active window you can generate a report using the Report button on the toolbar.220 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideThe report is an exact duplication of the active window.This is useful for printing a representation of an edit, load, or extract view.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 221 Generating and Using Reports222 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide Multimedia MetadataServer-Side processing allows metadata for Vasont multimedia content to be automatically captured and associated with the content. As an example, this metadata capture can be used to automatically obtain characteristics of graphics files, such as color depth, dimensions, file size, etc. In addition to graphics, the metadata capture extension can also collect metadata from Microsoft Office documents, PDF files and a variety of other multimedia formats. For this capture function to work, the file must be stored in the Vasont system. Files that are referenced in Vasont but stored in the file system will not have metadata captured. The metadata system recognizes certain Metadata Types. These are: • Adobe PDF and AI files • Bitmap files—Windows BMP files • Image files—most commonly GIF, PNG and JPG files • MPEG files—both movie and MP3 music files • Wave files—Windows WAV files • Microsoft Office documents—Any document that conforms to Microsoft’s OLE 2 <a href="/tags/Compound_document/" rel="tag">Compound Document</a> format: DOC, XLS, PPT, etc. files • Microsoft Office 2007 documents—Any document that conforms to Microsoft's Office Open XML format: DOCX, XLSX, PPTX, etc. • Unknown file types Each metadata type contains different properties. Some examples of possible properties are—File Size, Author, Color Info, Last Saved Date, etc. The list of properties captured will depend both on the Metadata Type and the actual data in the file. For some types, the list of properties is always the same. For others, the list of properties is dynamic. • Always captured regardless of file type—the system will always capture the size of the file in bytes even if the file type is unknown • Predefined capture types—for known file types the system captures specific data depending on the type. The types that have predefined properties are Bitmap, Image, MPEG, and Wave. • Several file formats (Microsoft Office documents and Adobe PDF documents) contain their own metadata storage system that consists of name-value pairs. The Vasont metadata system will dynamically create new properties as needed when they are captured from these files. In Vasont Administrator, the Metadata Types are listed in the Content Navigator. Selecting one of the Metadata Types in the left pane, will display a list of corresponding Metadata Properties in the right pane.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 223 Multimedia MetadataSetup for Searching on Multimedia Metadata in Vasont There are two parts to the metadata system. The first is the capture system, which is set up and installed by your Vasont administrator, in conjunction with your Oracle administrator. (See the document entitled “Vasont Server- Side Processing Configuration.<a href="/tags/PDF/" rel="tag">pdf</a>” located in the “\Installation and Configuration\Oracle\Optional Features \Server-Side Processing” folder on your installation CD.) The second part is the metadata search system, which allows searching of metadata. This is also set up by your Vas- ont administrator. It allows you to choose certain metadata properties as searchable, thus reducing the number of choices in the search properties list. To do this, raw attributes are created with names that correspond to the multimedia metadata property. Then these raw attributes are applied to the multimedia components. In Vasont Administrator: 1. Locate the name of the metadata property you wish to make searchable. In this case we are going to add the Color Info property:2. Note that the name has a space in it. As you know, attribute names cannot have spaces. To make an attribute that will link to a property that has spaces, substitute the underscore character for each space when creating the attribute. So, in our example, Color Info becomes Color_Info. 3. Now that we know the name of the attribute we wish to create, switch to the Attributes section of the tree, right- click and choose New:4. In the New Attribute window, enter the attribute name. The name is case sensitive. Therefore, be sure you maintain the case of the metadata property. Click Save and Close.224 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide5. Add the attribute to the raw component that will hold the multimedia files. Right-click on the component and choose Update.6. Click on the Attributes tab and right-click to add the attribute. Click Save.When you click Save after adding a multimedia raw attribute that matches an already existing metadata property, the following message displays.Since metadata may have been captured before the raw attribute was added, the data needs to be synchronized. As the message states, select Utilities → Update Raw Attributes from Metadata.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 225 Multimedia Metadata226 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide Support TablesSupport Tables are special tables that assist Vasont in communicating with SGML/XML editors and multimedia Helper applications, in determining the Vasont application's snapshot method, in setting Vasont sites, defining data translations to occur on extract, and updating system profiles. They are accessed from the main menu by selecting Utilities → Support Tables. The following tables are available: • Editor Tags • Helpers • Version Method • Sites • Translations • System Profiles • LanguagesEditor Tags The Editor Tags support table enables Vasont to communicate with the SGML editor that is specified in the Vaso- ntApps.ini file. This table contains a line item for each collection component that may be sent to the SGML editor. The editor tags themselves are SGML tags or combinations of tags that the SGML editor needs to properly edit and parse content. Editor tags may also be used by Vasont's internal parser when content is edited and saved in the Update window. This functionality is enabled on the Advanced tab of a collection component Update window by checking SGML parse and assigning an existing editor tag. In Vasont, when content is extracted and sent to an SGML editor by clicking the Export button on an Update window, the specified tags are placed around the component. The SGML editor uses the corresponding document type to parse the content. Editor tags can be thought of as a special set of wrappers used by a helper application (see Helpers). The SGML editor associated with this table is declared in the [SGML Editor] section of the VasontApps.ini file, which is located in the Windows directory. Adding an Editor Tag 1. Select Utilities → Support Tables → Editor Tags. 2. In the Editor Tags dialog box, right-click and select New from the pop-up menu. 3. Enter a Document Type, a Begin Tag, and an End Tag. 4. Click Save and Close. Deleting an Editor Tag 1. Select Utilities → Support Tables → Editor Tags. 2. Select an Editor Tag. Right-click and select Delete from the pop-up menu.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 227 Support Tables3. Click Yes to confirm the deletion.Updating an Editor Tag1. Select Utilities → Support Tables → Editor Tags.2. In the Editor Tags dialog box, select an Editor Tag. Right-click and select Update from the pop-up menu.3. Update the Document Type, the Begin Tag, or the End Tag.4. Click Save and Close.Checking Usage of an Editor Tag1. Select Utilities → Support Tables → Editor Tags.2. Select an Editor Tag. Right-click and select Where Used from the pop-up menu.3. A Window displays that includes tabs for Edit View and Raw Component. Click each tab to view Where Used data, if any. Use the scroll bar and/or the column separators to view all of the data, if needed.HelpersHelper applications are external, independent programs used to create, view, and modify multimedia files associated with Vasont content. Actual data files may be stored on the file system, or stored within Vasont as Binary Large Objects (BLOBs). Helper applications do not require any special setup within the Vasont environment other than the declaration of the extension associated with the program. The helper application invoked to edit a particular multimedia item is determined by the extension of the filename, if the file is stored external to Vasont, and by the object type for BLOBs. The actual association of file extension or object type to external program is determined by the Windows operating system association.In the multimedia Update window in Vasont, the drop-down list for object type shows the helper application extensions, allowing you to specify the type of data for a multimedia item. Because the operating system knows the program association, the proper helper application is launched when requested by you. To import a multimedia object into Vasont, the file extension must be included in the helper table. This allows you to limit the file types that you wish to be entered in the database. Adding an Extension1. Select Utilities → Support Tables → Helpers.2. Right-click and select New from the pop-up menu.228 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide3. Enter the File Extension in the dialog box.4. Click Save and Close. The Edit Helper and View Helper fields are not used. Instead, editing and viewing are dictated by the operating system program association. This association can be changed by opening Windows Explorer and clicking on View or Tools (depending on user's Windows version) →Folder Options. When Folder Options is selected from the pop-up menu, click the File Types tab on the window that displays to locate the applicable file type.Deleting an Extension 1. Select Utilities → Support Tables → Helpers. 2. Select an Extension. Right-click and select Delete from the pop-up menu. 3. Click Yes to confirm the deletion.Version Method Version Method indicates how versions are implemented for a Vasont application. Versions may be performed at the primary level, the component level, or not at all (meaning previous versions of component data cannot be restored). Most Vasont clients are set with the component level option. It provides the most capability but also creates more version records.When the primary or the component method is implemented, versions are tracked from approval toVAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 229 Support Tables approval of the entire primary or individual component, respectively. The Database Administrator sets the version method. To view the setting: Select Utilities → Support Tables → Version Method. The Version Method window displays for viewing only. The version method data is visible, but grayed out (disabled). Click the OK button to exit the window. 2 To change the version method, contact Vasont support for assistance.Sites The Sites table is important in an advanced network setup where two databases are separate, but share information. Site ID identifies which site controls what information; therefore, which users can perform updates versus view the information. The site configuration must be coordinated with Oracle's database replication feature, which requires custom work.Translations Translations allow one datastring to be translated into another. This takes affect when extracting data from Vasont. For example, the database value * may be translated to * when data is extracted from Vasont.This translation has nothing to do with translating from one language to another. It is a conversion or 2 transformation feature. Adding a New Translation 1. Select Utilities → Support Tables → Translations. 2. The Translations window displays. Right-click and select New from the pop-up menu.3. Enter the Database Value and the External File Value in the New Translation window that displays. 4. Click Save and Close. Updating a Translation 1. Select Utilities → Support Tables → Translations.230 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide2. Select a Translation from the Translations window that displays. Right-click and select Update from the pop- up menu. 3. Change the Database Value and/or the External File Value. 4. Click Save and Close. Deleting a Translation 1. Select Utilities → Support Tables → Translations. 2. Select a Translation from the Translations window that displays. Right-click and select Delete. 3. A confirmation window displays. Click Yes to confirm the deletion, or No to abort the action. Checking Usage of a Translation 1. Select Utilities → Support Tables → Translations. 2. Select a Translation from the Translations window that displays. Right-click and select Where Used. The Translation Where Used window displays and contains tabs for Extract View, Load View, and View--High Level. (Use the scroll bar and/or the column separators to view all of the data, if necessary). Each extract or load view that uses a translation is listed, including its view description, associated collection, component name, view ID, and wrapper relation (parent/child wrappers) ID. The View--High Level tab displays the view description, associated collection, and view ID of any translations that were applied directly to the update window of a load or extract view (affecting the entire view).System Profiles The System Profiles table can be used to update system-wide profile type values, if needed. Select Utilities → Sup- port Tables → System Profiles. The Update System Profiles window displays.• ASYNCH_CLIENT_WAIT_INTERVAL — Controls the amount of time the Vasont application will wait to get a response from the Oracle server to acknowledge a response and initiate a server side process (e.g. server load). • Batch_Extract_Unique_Filename — Used to honor filenaming processing options that are applied to an extract view header when using the Batch Extract Queue. Setting this profile to “No” will honor processing options like client_key_filename, extract_directory, and job_publish_file. Setting the system profile to “Yes” or leaving the setting blank will continue with the default behavior of creating unique filenames for the Batch Extract Queue. • Change_Active_Task — Determines whether a Change Active Task button appears on the Workflow or Project Management Reschedule window. If set to “Yes” and the logged in user has the advanced privilege of Workflow Scheduling Override, then the user may change the active workflow task to another task in the workflow project. The default setting is No.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 231 Support Tables• CLIENT_MANAGER_HELP — Used if you wish to access your own, customized help instead of Vasont's standard help through Vasont's help menu. • CLIENT_VASONT_HELP — Used if you wish to access your own, customized help instead of Vasont's standard help through Vasont's help menu. • COM_PROG_ID — Represents the Vasont Com object being used. The data shown in the box is the default value provided during the install process. • Cross_Colls_Search_Default — Controls the default collection option for the Cross Collection Search window for the system (and all users). The values are: both: This value will cause the Cross Collection Search window to be automatically populated with the user's Recent and Favorite collections. none: This value will cause the Cross Collection Search window to open without any pre-population of collections. recent: This value will cause the Cross Collection Search window to be automatically populated with the user's Recent collections. favorites: This value will cause the Cross Collection Search window to be automatically populated with the user's Favorite collections. When no value is specified the behavior will function with the default value of both. • default_report_date_format — Controls the date format display used in the Workflow and Annotations Report. Colons, slashes, and spaces will appear in the entered format (e.g. dd/mmm/yy). Date character formats with their meaning along with an example are shown in the following table:Character Meaning Example dd Day number with leading zero if appropriate 09 mm Month number with leading zero if appropriate 06 mmm Month name abbreviation Jun yy Two-digit year 97 yyyy Four-digit year 1997The following date formats are specifically supported: dd-mmm-yy yyyy-mmm-dd yyyy/mmm/dd yyyymmmdd dd-mmm-yyyy yyyy-mm yyyy/mm yyyymm yyyy-mm-dd yyyy/mm/dd yyyymmdd Note: Many date formats are supported along with those shown in the preceding table. • Delete_Source_On_Move — Controls whether or not a source component is set to pending delete during a move operation in Vasont. If set to “Yes”, then the system behavior will change from the default and automatically delete the source on a move operation. If the value is blank, set to “No”, or any other value, then the default behavior will occur where the source component is set to pending delete when a move operation occurs. Note: If set to “Yes”, the user performing the move must have the privilege of “Confirm Pending Delete Compo- nents” or “Update (Full Rights)” for the source component. If the user does not have the permissions then the source component will still be marked with a pending delete status instead of being automatically deleted. • DITAMASTER_SOURCE_VERSION — Used by Vasont Systems. • Email_Vasont_Shortcut — Determines whether a Vasont Shortcut will be attached to emails generated from Vasont. If set to “No”, then Vasont Shortcuts will be eliminated. This includes emails that are created from email232 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide buttons (e.g., Navigator Details Pane, Workflow window, etc.) and emails sent due to a processing option (e.g., email_task). If blank or set to “Yes”, the default behavior of attaching a Vasont Shortcut to the email will be in effect. For more information, see Using Email in the The Vasont Environent chapter of the Vasont User Guide. • Graphic_Collections — Controls the collections that appear in the Image Picklist in Vasont. Enter the ID(s) for the collection. If there are more than one, separate with a comma. • java_memory_size — Used with server-side processing. Enables the administrator to control the Java memory allocation on the Oracle server that is given to server side processes. The value represents the maximum number of bytes to allocate to the Oracle JVM during load operations. The value should be set to numbers larger than 268,435,456 (which seems to be the default JVM size in Oracle 10g on Windows Server). Values lower than the Oracle default will be ignored. Use this profile only to INCREASE JVM memory allocation. • LARGE_BLOB_THRESHOLD — Defines the threshold for loading a large multimedia file. Sometimes large files are problematic depending on system resources (i.e., memory), and will vary for each client depending on their environment. This field is used to define a file size threshold that is appropriate for your environment. (Note: Enter number only, no “MB”.) If set to “50”, then files larger than 50 MB will run through special processing to ensure that they can be handled without system resource issues. The default setting is 40 MB and is adequate in most environments. If you have a 50 MB file that continually crashes when loading to Vasont, then the 40 MB default setting may need to be lowered for your system (i.e., 30 MB). • Maximum_Open_Windows — Defines a maximum value for windows that can be opened in Vasont without causing the application to crash. The default value is “10”. This setting will be used to warn the user that they are about to exceed the threshold where opening additional windows could cause the application to crash. Logic in Vasont will assign a value to each type of window (i.e., Navigator, Workflow window, or Project Management window counts as “1/2”, Navigator with Details pane counts as “1”). When the user chooses Open Modular Content or Open Workspace, a calculation of the windows currently open and windows that will be opened as part of the request will be calculated. If the total exceeds the value placed in the Maximum_Open_Windows system profile setting, the user will receive a warning message. If the user chooses “Yes”, to continue with opening the windows, they take the chance that the application may be terminated. If the user chooses “No”, the windows will not be opened and they will remain at the location where they initiated the process. • NETWORK_IO_BUFFER_SIZE — Used to determine the Network I/O size to use for file read/write operations. Value should be present, but if value is not present or is a bad value, the default value of 16 MB will be used. • ORACLE_LISTENER_PORT — Used by the server-side processing features so the processes can establish another asynchronous Oracle Database connection for load, clone, etc. purposes. Typically, it is set by the serv- er_side_grants.sql script when installing and configuring server-side processing. However, it can be updated from the System Profiles window. • Ownership_Extension — Turns on/off the Ownership Extension feature. Feature is enabled when set to "Yes" and disabled when set to "No". • REDLINE_EXPAND_INLINES — This affects the Redline Report from the Version History. If “Yes”, a mini extract is performed for content including inlines and used in the Redline Report. Thus, all changes to the component containing inlines, and the inlines themselves, are reflected as a single entry in the Redline report. The default is “No”, indicating that changes to the parent and any inlines are reported independently. • Review_Application — Activates the Collaborative Review feature for the system and specifies the default location of the application used to review a component. For example: C:\Program Files (x86)\Oxygen XML Author 17\oxygenAuthor17.0.exe. • Select_Task_User_By_Default — Controls whether a user must be selected for a task or the first user in the list is automatically selected when clicking the OK button. If set to "No", the user is forced to select a user. ThisVAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 233 Support Tables feature was developed to prevent the user who came alphabetically first in the list from receiving most of the workflow tasks.• SERVER_POLLING_INTERVAL — Used with server-side processing (server load, server clone, server delete, etc.) While a server-side process is running, the client will display a progress dialog box. The server polling interval determines how frequently this dialog box is updated. It is measured in seconds and the default value is 4. Valid values are from 1 to 60 (values larger than 60 may work but are not recommended).Note that setting the server polling interval to a low value may increase network traffic whereas setting it to a high value will mean that the user display does not change often and may lead the user to believe that the process is hung.Also note that just because the polling interval is set to a given number it does not mean that the display will update that frequently. If there has been no significant progress since the last poll, then the display will not change. Also it may take several seconds after a poll for the display to update. To reduce the impact on the server, polling has a very low priority and may be set aside while other higher priority processes occur. The polling priority is not adjustable even though the frequency is.• Show_Descendant_Ref_By_Warning — Controls whether a warning displays when users access content that has a descendant that is referenced.• Show_Login_Name — When set to “yes”, and User accounts are set up with both a user name and a login name, a clearer and friendlier name will appear in Vasont. By default, this is turned off (or set to “no”). For more information, see Creating New Users.• Show_Update_Ref_By_Warning — Controls whether a warning displays when users access referenced content in Vasont.• Show_Variant_Warning — Controls whether a warning displays when users access content in Vasont that is part of a variant relationship.• SMTP_SERVER — Represents the mail server and can be updated, if needed.• Trans_clone_conref_targets — This profile modifies the translation clone process logic to consider conref target content when determining if a source primary (e.g. English Topic) needs to be cloned for translation. Normal logic is to only consider changes in the topic itself when determining if the source has changed since the last time the topic was translated. When the system profile “Trans_clone_conref_targets” is set to “yes”, translation clone logic will also interrogate the topic’s conref target content to determine if it has changed since the last time the topic was translated.This feature is typically used when the topic translation extracts pull in the conref target content, which is done via the processing option ref_extract_conref. In this scenario, it is necessary to consider the conref target data when determining if a topic needs to be re-submitted for translation.• TRANS_FILES_NAV_DISPLAY — Setting this profile to “no” can improve performance by turning off display processing options when opening the Translation window's File Tracking details pane. Setting it to "yes" will apply the normal behavior of navigator display processing options. Note: The speed in one database, with Nav Display turned off, for a 1,000 file project went from over 1 minute to less than 5 seconds.• Validate_Email_Domain — Used if you wish to allow a less restrictive validation on the domain of an email address (characters following the “@”). When empty, the more restrictive validation of the email domain will occur (abc@cf1. will not be valid, but abc@cf1.com will be valid). If set to “no”, then the less restrictive validation will occur.• VASONT_WEB_APP — Represents the path where the Web pages provided by Vasont are stored. This field contains data only if the user subscribes to the Vasont Web Application.When updating is complete, click Save and Close.234 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideLanguages The languages table defines the language in which the Vasont <a href="/tags/User_interface/" rel="tag">user interface</a> will display. Currently, English is the only supported language. To access the Languages table, select Utilities → Support Tables → Languages. Adding a Language 1. Right-click in the Languages window and select New. 2. Enter a language name and, optionally, a language locale. 3. Click Save and Close. Deleting a Language 1. To delete a language, right-click on the language and select Delete. 2. Click Yes to confirm the deletion. Updating a Language 1. To update a language, right-click on the language and select Update. 2. Update the language and/or the language locale. 3. Click Save and Close.Notification Events The Notification Events table allows notification events in Vasont to be activated or disabled. Each event listed in the table defines the notification category and a description of its use. The Active column displays Yes to show that the notification event is available in Vasont, or No to indicate that the event is disabled.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 235 Support TablesWhen the notification event is disabled, users can not access and subscribe to the specific notification event. The following list shows where Vasont displays the notification options that may be disabled. • Branch Approval — A notification is received by the content owner of the original branch whenever a branched primary component is Approved. The notification is sent to the owner, User 1 in this example, of pointer components that reference the source of the branch being Approved.• Component Added— When disabled, the right-click menu option called Configure Notifications will not appear on the menu.• Editing Nearing Due Date — The Editor receives a notification in the My Notifications section when the editing phase of a review is nearing the due date. • Reviewer Nearing Due Date — The Reviewer receives a notification in the My Notifications section when the editing phase of a review is nearing the due date. • Reviewing Nearing Due Date — A notification is received in the My Notifications section by users involved in a review when the reviewing phase is nearing the due date.236 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide• Variant Modified— When disabled the Configure Notification button on the Variant window is not visible.• Project Notifications— There are many events related to project notifications. Click on the Notifications button in the Project Management window. The Project Notifications window displays.Enable or disable event notifications by clicking on each checkbox.If all project notifications are disabled, the Notifications button on the Projects window is grayed out.• Workflow Notifications— There are many events related to workflow tasks. Click on the Notifications button in the Workflow Tasks window. The Configure Workflow Task Notification window displays.Enable or disable event notifications by clicking on each checkbox in the Enabled column.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 237 Support TablesIf all workflow related events are disabled, the Notifications button on the Workflow window is grayed out.Activating or Disabling a Notification EventTo activate an event:1. Select Utilities → Support Tables → Notification Events.2. Right-click on an event and select Activate.3. A confirmation message displays. Click Yes to enable, or No to cancel and exit without changes.4. When activated, the event shows an Active status of Yes in the Notification Events table.To disable an event:1. Select Utilities → Support Tables → Notification Events.2. Right-click on an event and select Disable.3. A confirmation message displays. Click Yes to disable, or No to cancel and exit without changes.4. When disabled, the event shows an Active status of No in the Notification Events table.Attribute SetsAttribute sets allow you to disable the ability to populate an attribute(s) on a component when a specified attribute (controlling attribute) is set to a given value. This functionality is achieved by applying the attribute_set_control processing option to the component and defining the attribute behavior in the Attribute Sets support table.In the following screenshot example, “product” is identified as the controlling attribute. In Vasont, when a component's product attribute is set to “professional”, and the component is configured with the attribute_set_control processing option, the “audience” attribute will be grayed out so users will not be able to enter a value. If the product238 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide attribute is set to “personal”, then the “otherprops” attribute will be grayed out. All other attributes on the component will be active; only the attribute(s) defined in the Excluded Attributes field will be disabled.See attribute_set_control in the Processing Options Guide for more information. To define a control attribute: 1. Go to Utilities → Support Tables → Attribute Sets. 2. Select a Content Type from the drop-down list. 3. Click Add to enter a new entry. 4. Select a Controlling Attribute from the drop-down list. 5. Enter a value for the controlling attribute in the Control Value field. (This value, when applied to a component's controlling attribute in Vasont, will disable the attributes defined in the Excluded Attributes field. 6. Use the ellipses button to enter the attributes that should be disabled in the Excluded Attributes field, when the Control Value is applied to a component's controlling attribute in Vasont. a. Click the ellipses button to open the Attribute Sets Exclusion window. b. Select one or more attributes from the list that should be disabled for the defined control value. c. Click OK. 7. If more control attributes and values are needed, repeat steps 3–6. 8. When all values have been defined, click OK to save and exit the Attribute Sets window. Click Apply to save without exiting the Attribute Sets window. 9. Once the control attributes sets have been defined, apply the attribute_set_control processing option to the components where applicable. See attribute_set_control in the Processing Options Guide for more information. To delete a control attribute entry: 1. Go to Utilities → Support Tables → Attribute Sets. 2. Select a Content Type from the drop-down list. 3. Highlight the entry to be removed. 4. Click Delete. 5. The Confirm Delete message will display. • Click Yes to continue with the deletion. • Click No to dismiss the confirmation window and cancel the deletion. 6. Click OK to save and exit the Attribute Sets window. Click Apply to save without exiting the Attribute Sets window.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 239 Support Tables7. If the deletion involves a control attribute to be totally removed from the Attribute Sets window, you may also need to remove the attribute_set_control processing option from components in the collection edit views. See attribute_set_control in the Processing Options Guide for more information.240 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide Creating and Updating WorkflowWorkflow allows you to track any flow of work related to a specific collection. Workflow components are defined at the collection level and are allowed to contain multiple components. A group of related Workflow Tasks is called a Project. In many cases, a project is created for a primary component. Each task is assigned to a user. This may be done within Vasont Administrator or Vasont as work progresses. Security for reassigning workflow tasks is provided. Anyone having this security can reassign any open task (their own or others) to anyone who is allowed to perform the task. To track workflow for a project within Vasont, use Vasont Administrator to set up the project and tasks. Workflow can be set up using dialog boxes or graphically through a flow diagram.Workflow Projects Each collection can have one or more associated projects. These projects are used to track the flow of work for a particular job. For example, an encyclopedia may have multiple projects, such as reviewing text for each article, checking authors and reviewing artwork. Each project is comprised of one or more tasks. Each task can be assigned to a user. Workflow is tracked by assigning a next task to each task. In addition, it is possible to add Attributes and Processing Options to tasks. After workflow has been set up using Vasont Administrator, use Vasont to track a project using the workflow window.Requirements for Initiating a Workflow Project in Vasont The following requirements or permissions are required for users to initiate a workflow: • Must be a user or member of the workgroup applied to the first task. • Must have collection access. • Must have the workflow seat checked on your user account. See Creating New Users. • If you are a user that can perform the task, it will automatically be assigned to you. You can reassign to another user if you have Reassign Workflow Tasks (advanced privilege). • Component must be added to the workflow project (Component tab). • Workflow can be automatically initiated if these processing options are applied (initiate task, start new workflow, initiate pointer workflow). See also Collaborative Review Workflow.Adding a New Workflow Project 1. Expand the Collection where you would like to add the new project. 2. Right-click on Projects and select New → Project.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 241 Creating and Updating Workflow3. At the New Project window, enter the Project Name in the dialog box.This is the only required field on the window. If you prefer to build workflow graphically, see 2 Building a Graphic Workflow.4. Enter a Description and use the drop-down arrow to set the Active Flag. (Yes is the default value.) The Active Flag turns the project On or Off. 5. Check the Exclusive checkbox if desired. If a Vasont component currently has an active workflow project which is marked as exclusive, the user is not able to initiate another workflow for the same component. If a component has active workflow which is not marked as exclusive, when initiating workflow, any projects marked as exclusive are filtered out of the project selection window. This prevents initiation of multiple workflow projects for the same component. 6. Enter a Duration and set the Duration Flag to Business Days, Calendar Days, or Weeks. (None is the default value.) These two fields specify the length of time it should take to complete the entire project. 7. The Project ID field cannot be altered because the ID is automatically assigned. 8. Use the Component tab to specify which component (or multiple components) to which you want to attach the workflow project. You must also specify in which collection the component exists. (A component must be entered at some point before workflow is used.) By default, the primary component in the collection in which you are creating the workflow project is already defined.A workflow project may be associated with more than one collection. This allows workflow 2 projects to be reused across collections.Although components are not required, workflow will not function without a component. Generally, a primary component is used, although any component can be selected.242 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide a. Right-click and select Add. b. In the filter that displays, select the collection to which you want to attach the workflow. In the Navigator Name field, enter the name of the component, if desired, and click OK. c. At the Component Pick List for Projects window, select one or more components and click OK. The component and collection pair is added to the tab. 9. Use the Attributes tab to specify attributes that you would like to appear in the Project Management window. To define project attributes: a. Right-click and select Add. b. Select the desired attribute(s) from the Attribute Pick List and click OK. c. Right-click on an attribute and select Update to apply properties. • General tab: Allow Edits — Checking this box allows a user to modify the value of the attribute in Vasont. Display in List View — If unchecked, the attribute will display by default in the Details pane and project filter. If checked, the attribute will display in the Project Management list view, as well as the Details pane and project filter. • Values tab: Right-click in this window and select Add to enter a list of valid values for the attribute. In Vasont, the user will be able to select the appropriate value from the list that you have established here. d. Click the X to close the update window. 10. Click Save and Close.Building a Graphic Workflow In order to build a graphic workflow you must first add a new project. See Adding a New Workflow Project. 1. Expand Projects and right-click on the project for which you would like to open the graphic workflow window. 2. Right-click on the project and select Graphic Workflow. 3. In the Workflow Project window, click and drag to draw a box representing a workflow task. Be sure to create boxes large enough to accommodate 6 or 7 lines of text so that all of the relevant data can be displayed when accessing the diagram in Vasont. In particular, if an Active task is overdue, content may be cut off when the box is too small.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 243 Creating and Updating Workflow4. Continue drawing boxes to represent workflow tasks.5. Right-click on each task to set up details and dependencies. See descriptions under Adding a New Task.6. After making the necessary changes, click the X and Yes to save the change.Reusing a Workflow Definition A new workflow project does not always have to be created in order to enable workflow for a collection. A workflow project that is created in one collection can be reused in another collection. This reuse capability is also possible across content types. To reuse a workflow project: 1. Expand the collection that contains the project that you would like to reuse. 2. Expand Projects. 3. Right-click on the project that you want to reuse and select Update. 4. Select on the Component tab.244 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide5. Right-click in the window and select Add.6. In the filter that displays, select the name of the collection in which you want to reuse the workflow project you are updating. In the Navigator Name field, enter the name of the component, if desired, and click OK. 7. At the Component Pick List for Projects window, select one or more components and click OK. The component and collection pair is added to the tab. 8. Click Save and Close.When reusing a workflow project, it is important to be aware of any processing options that may be 2 applied within the project you are reusing. Any processing options which have arguments that specify the name of a collection may not be appropriate for that location. For example, a clone processing option may have an argument for a specific destination collection.The collection which reuses the workflow of another will contain a project pointer under Projects. To determine where the workflow that is being pointed to is located, select the Project Pointer. In the right pane of the Content Navigator, the project name, base collection, and component name displays for the project that is being pointed to (reused). Right-click and select Go To to navigate to the workflow project that is being reused.In order to determine if a workflow project is being reused by another collection, click on Projects. All collection/ component pairs that have been defined for all of the projects in the collection are displayed in the right pane of the Content Navigator window. In the example below, Projects was selected under the Doc Manuals Vasont 11 collection. In the right pane of the window, you can see that the Documentation Workflow project has a collection name other than Doc Manuals Vas- ont 11 listed — Doc Manuals Vasont 10. It also shows Chapter [Book] under the Component Name column. There- fore, we know that the Doc Manuals Vasont 10 collection is reusing the Documentation Workflow project that is defined in this collection. You can also see that the workflow is associated with the Chapter [Book] component in that collection.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 245 Creating and Updating WorkflowTo navigate to the collection where the workflow is being reused, right-click on the appropriate collection/component pair and select Go To.Updating a Workflow Project1. Expand the collection that contains the project that you would like to update.2. Expand Projects.3. Right-click on the project and select Update.4. Edit the Project Name, Description, Active Flag, Duration, and Duration Flag for the project in the Update Project window. The Collection and Project ID data cannot be edited.5. Click the Component tab. Right-click in the window and select Insert, Add, or Delete from the drop-down menu, as appropriate.If Insert is selected, the new component is placed above the existing one. If Add is selected, the new component is placed after the existing one. If Delete is selected, the component is immediately removed.6. Click Save and Close on the main toolbar.7. The changes are saved and both the Update Project and Content Navigator windows are dismissed.Duplicating a Workflow ProjectYou can duplicate a Project within the same collection. To do this:1. Right-click on the Project to be duplicated and select Duplicate.2. The project is duplicated with the same name, except it now has a number at the end. Rename and alter the project as desired.Deleting a Workflow Project1. Expand the collection that contains the project that you would like to delete.2. Expand Projects.3. Right-click on the project and select Delete.4. At the warning message, click Yes to confirm the deletion, or No to exit the message without deleting the project.246 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideImporting a Workflow ProjectThe Import/Export of a Project includes the content of the project along with all the tasks. It does not include the graphic workflow. Any picture associated with the source project is not copied into the destination project. The Im- port/Export also does not include the project component data nor the users and workgroups data in the tasks. 2 To perform an export, see Exporting a Workflow Project.1. On the main menu, select Utilities → Import → Project.2. Select the file to be imported from the file selection dialog box and click Open.Editing the XML file that was created during the export of the Project is not supported at this 2 time.3. Select the Collection to receive the imported project. Click OK to continue the import. The Import Utility window displays prompting you for confirmation of the import.4. Click Yes to confirm and continue with the import. When the import is complete, a message displays indicating success.Exporting a Workflow ProjectThe Export utility is run from a Project's right-click menu.1. Right-click on the project to be exported and select Export.2. At the Select File to Save window, enter a File Name and click Save. (It must be an XML file.)The content of the selected project is stored in the specified file name. 2 Editing the XML file outside of Vasont is not supported at this time.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 247 Creating and Updating WorkflowDeleting Workflow Project Data For information on deleting project data, see Deleting Project Data in the Utilities for Deleting Vasont Data section of the Updating and Deleting chapter.Adding a New Task 1. Expand the collection that contains the project where a new task is to be added. 2. Expand Projects. 3. Select the Project. Associated tasks appear in the right windowpane. 4. Right-click on the project, select New → Task, or right-click in the right windowpane and select New. 5. At the New Task window, enter the appropriate data in the fields shown on the following tabs. • General Tab• Task Name — provide a name for the workflow task. • Task Description — enter a general description of the task. • User Assignment — select Pick, Rotate, or Queue from the drop-down menu. This specifies how the next user assigned to the task is determined. Pick (default) means that whoever completes the previous task will need to choose a user for this task from a pick list. Rotate causes tasks to be auto-assigned upon completion of the previous task; Vasont makes the choice by rotating through the list of users. Queue causes the task to be placed in a list and not assigned to any user; specified users can review the list and assign a task to themselves at any time. • Start Flag — select Yes or No from the drop-down menu. This determines whether this task can be the first task in the project. (No is the default value, unless this is the first task entered for the project.) • Duration — enter a number to associate with the setting in the duration flag field. These two fields specify the length of time it should take to complete the task. • Duration Flag — select Business Days, Calendar Days, or Weeks from the drop-down menu. (Weeks is the default value.) • Estimated Iterations — enter a numeric value that will be used to calculate the completion date for the workflow project. By default, “1.00” is entered on a new task. The value can be changed to a number248 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide greater or less than one, and set out to two decimal places. This value will also help in more accurately calculating projected overdue projects. Examples: • 1.00 — This task is estimated to occur once each time the workflow is instantiated. • .50 — This task will occur half of the time for each time the workflow is instantiated. This could occur when the task is optional and is expected to be chosen half of the time. • 3.00 — This task is estimated to occur three times each time the workflow is instantiated. This could occur when the task is part of a loop of tasks. For example, there are two tasks of Edit Content and Review Content. The Review Content can loop back to the Edit Content task. The estimate of “3.00” means that the looping is expected to occur 3 times on average. • WebLNX Task - selecting Yes means that this task will be performed by a user who is using Vasont WebLNX. This field will enforce special behavior for workflow tasks and the associated content in Vasont (i.e., active task cannot be deleted, content cannot be checked in, etc.). (No is the default value.) • Project Name — the name of the associated project cannot be changed. • Task Id — Vasont identifier for the current task. The data in this field is automatically assigned and cannot be changed. • Users Tab • You can assign Users to a Task on the Users tab or the Workgroups tab. For example, a task may have ten valid users. Each of these ten users can be added on the Users tab, or a workgroup can be created that includes the ten users. Then the workgroup can be added on the Workgroups tab. (See Creating New Workgroups.) • Right-click in the window and select Add to assign users allowed to perform the task. • The users displayed in the Task Username Pick List are those having security access to the collection that includes this task. Select users from the list. • Click OK. The user is assigned to the task. • Workgroups Tab • Right-click in the window and select Add to assign Workgroups allowed to perform the task. • Select a Workgroup from the Task Workgroup Pick List. • Click OK. The Workgroup is assigned to the task. • Next Task(s) Tab • Right-click in the window and select Add.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 249 Creating and Updating Workflow• Select a Task from the Next Task Pick List. • Click OK. You can assign multiple tasks to follow any task. Follow-on tasks need to be created before they can be added to the previous task. • Optional Flag values: When there is only one task, it is either Yes (optional) or No (mandatory). Op- tional Flag Pick One or Zero or One are used when there are multiple Next Tasks. Pick One means you must pick one of the Next Tasks, and Zero or One means you may pick one of the Next Tasks.• Attributes Tab • Right-click in the window and select Add. • Select an Attribute from the Attribute Pick List. You may, for example, want to add an attribute that sets a priority on the task. • Click OK. You can assign multiple attributes to any task. • Processing Options Tab • Right-click in the window and select Add. • Select a Processing Option from the Processing Options Pick List. • You can assign multiple processing options to any task. Click OK.Updating a Workflow Task1. Expand the collection that contains the project and task to be updated. 2. Expand Projects. 3. Select the Project containing the task to be updated. 4. In the right windowpane, right-click the task you wish to update and select Update.5. At the Update Task window, click the tab containing the data to modify and change the data, as necessary. In general, you can add, insert, delete or update data on various tabs. (See descriptions under Adding a New Task.) 6. When all update actions are complete, click Close on the main toolbar to exit the Content Navigator window.250 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideDeleting a Workflow Task 1. Expand the Collection that contains the project and task. 2. Expand Projects and click on the Project that contains the task definition to be deleted. 3. The project tasks will be listed in the right window pane. Right-click on the task and select Delete.• If the task being deleted is referenced by the Vasont WebLNX File Management System (FMS), a warnng message will display. Since the removal of this task will have adverse effects on the Vasont WebLNX workflow, you should carefully consider whether the deletion of the task makes sense. Choose Yes to continue with the deletion, or choose No to cancel. • The task definition may be deleted if there are no existing data occurrences of the task stored in Vasont. If there are data occurrences, then a message will display stating that the task definition may not be deleted because data exists. The Workflow filter in Vasont can be used to view and delete the data occurrences that exist. For example, if you want to remove the data occurrences for the “Final Approval” task in the “Topic Edit” project, the filter criteria could be set to: • Filter by Task Status: All • Filter by Component: All • Filter by User: All • Filter by Collection: All • Filter by Project: Topic Edit • Filter by Task: Final Approval When the results are returned in the workflow window the user can remove the tasks by selecting the tasks and right-clicking and choosing Delete Task from the pop-up menu. This selection is only available if the user has the advance privilege of Delete Workflow Task assigned to them. Now that the data occurrences for the task have been deleted, return to Vasont Administrator and delete the task definition. 4. At the confirmation window, click Yes to confirm the delete, or No to dismiss the message and the delete will not occur.Workflow Projects Reports The following Workflow Projects Reports are available: Project Flow, Project Users, Project WorkGroups, Project Processing, and Project Attributes. See the Generating and Using Reports chapter for more information.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 251 Creating and Updating Workflow252 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide Collaborative ReviewVasont's Collaborative Review allows Subject Matter Experts and Reviewers to examine XML content, provide suggestions for improvements to the content, and share comments with other Reviewers. The Reviewers apply comments to the content using a built-in review editor. When all Reviewers have completed their assignment, the Editor evaluates each comment and modifies the content based on the suggestions. When all comments have been addressed and the Editor has completed the modifications, the content is updated in Vasont. For more information, see the Reviewing Content chapter in the Vasont User Guide.This feature supports DITA and DocBook content. If you have a proprietary DTD or one that oXygen does not support with their standard installation, then you will need to build an oXygen framework in 2 order to implement this feature.When a review is initiated, the content is automatically extracted, along with referenced images and modular content. The files are zipped and stored in the database and ready for reviewing activity.The review can only be performed on a single XML file (i.e., Concept, Topic). The Collaborative 2 Review feature does not support DITA map and topic reviews at this time.When a Reviewer opens their review assignment, the zipped file is extracted from the database and placed in the Extract\Reviews folder, and unzipped into a client key subfolder. The oXygen Author application is launched and the XML file is displayed. The user must enter their login criteria to connect to Vasont with the VUI connector. This login is necessary to retrieve and share comments that have been applied to the content. The comments that the user applies to the content are stored in Vasont, separate from the XML file. Each time the review file is extracted from Vasont and opened in oXygen, the XML file and stored comments are merged together to display in a unified view in oXygen. When a review assignment is ended, the files are removed from the user's Extract\Reviews folder. After all reviewing activity is complete and the Editor has addressed all comments and modified the content, the file is loaded to Vasont and simultaneously zipped and stored in the database. The Editor's zipped file contains the change tracking and comment information. This file serves as the audit trail for the review and can be opened as needed. The Editor's Extract\Reviews folder is cleared of the files to avoid confusion on subsequent reviews of the same content. This feature is an add-on package to the basic Vasont system. When activated for the system, user accounts and collections must be configured to enable the reviewing capabilities. At a high level, the following items must be implemented. 1. oXygen Author version 17. 2. Run the installer for the Collaborative Review. (If you are accessing Vasont on Vasont Systems' data center, then this item is handled by the data center administrators). 3. The Review_Application system profile is set to define the path to the oXygen application. 4. Vasont user accounts must have the Review seat option selected. 5. The collection edit view must be configured with review information (edit view, extract view, and load view). 6. Users who will manage reviews must have the Initiate Collaborative Review permission for the collection.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 253 Collaborative Review7. Users who will perform the editorial phase of the review must have collection load and update privileges.Collaborative Review System Profile The Review_Application system profile tells the collaborative review feature where to find the oXygen installation on your system. 2 If this profile is undefined, then the previous Collaborative Review tool will launch.1. On the Vasont Administrator menu bar, select Utilities → Support Tables → System Profiles. 2. In the Update System Profiles window, set Review_Application to the location of the oXygen XML editor executable. For example: C:\Program Files (x86)\Oxygen XML Author 17\oxygenAuthor17.0.exeThe oXygen location specified in the system profile can be overridden if oXygen is installed in a dif- 2 ferent location on your machine (where you are performing your review). Add the following lines to your VasontApps.ini file on your machine: [Collaborative Review] ReviewApplication="C:\Program Files (x86)\Oxygen XML Author 170\oxygenAu- thor17.0.exe"User Accounts for Review Participants The review participants must have a Vasont user account. The Review Coordinator and the Editor must have a full Vasont license. Reviewers, at a minimum, must have a review account.Review-only Vasont seats can be purchased for users who will only access Vasont for the purpose of 2 performing reviews. When a review-only Vasont user logs into the Vasont CMS, the Review List window is presented and the active reviews for the user are listed. They can open a review and perform markup activity.1. Assign a Review Seat for Reviewers. This is a special type of user seat that provides a simplified version of Vasont for performing content reviews. See Reviewer Seats.Enter an email address to ensure Reviewers who do not log into Vasont frequently are alerted to 2 assigned reviews via email.If the Reviewer is a user who uses Vasont for other activities, then the Vasont Seat and Review Seat can both be checked. 2. Assign a Vasont Seat and a Review Seat for the Review Coordinator and the Editor. See Updating Users.254 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideCollaborative Review Collection Configuration The collections that contain content that will be reviewed must have an extract and load view, as well as settings on the edit view component. IMPORTANT: Keep in mind that the XML that is extracted for reviewing must be reloaded to Vasont. If you alter the XML (for better display results) in a way that cannot be reliably reversed it causes undesirable results in the data stored in Vasont. Collaborative Review Extract View An extract view is required for extracting the review content for reviewing activity. Create a new extract view for collaborative review, or use an existing extract view, providing the extract view meets the criteria defined in the following items. See Load and Extract Views. Settings needed for the extract view header: 1. General tab: a. View Description: Enter a name for the extract view that clearly identifies it for review purposes. b. Document Type: Define the XML declaration, encoding, and the doctype for the content. For example: <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"> c. View Type: Set the value to Composite and Utility Extract. 2. Processing Options tab: a. Client_key_filename (both comp_extract_file and extract_filename events) This processing option is required to give a name to the extracted file. b. Extract_other_view (providing you can reuse the component structure from another extract view). Right-click on the processing option and select Update Arguments to set the name of the extract view that contains the component structure that will be referenced. This processing option uses a component structure from another extract view thus reducing component maintenance in the future. If the component structure contains processing options or settings that differ for a review, then this processing option can not be used (e.g., reference text, generated text). If you are using an existing extract view that is used for other purposes, then this processing option is not required. 3. Advanced tab: a. File Extension: Set to “xml” or “dita” (depending on your use of the file extension in your content). b. File Contains XML: This box should be checked in order to extract the content according to XML stand- ards. c. Vasont Administrator Use Only: This box should be checked to hide the extract view from the list of normal extract options in the Vasont application. If you are using an existing extract view that is used for other purposes, then this setting is not necessary. The extract view component structure: The component structure may be identical to the one used for editorial updates or publishing. If so, then you may use the extract_other_view processing option on the view header, and there will be no component structure for the extract view.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 255 Collaborative ReviewIf you choose to alter the output by applying additional processing options that will improve the display of the content in the review environment, then you will need to copy the component structure to the review extract and make the modifications. In this case, you may not apply the extract_other_view processing option to the view header. Keep in mind that if you modify the extracted XML, then you will need to be able to reverse these items out of the XML before reloading the content after the review activity. Some examples of these alterations: • Including text of cross referenced content (i.e., xrefs) • Including attribute values as part of the text stream (i.e., note) • Removing unnecessary elements (i.e., indexterms) Collaborative Review Load View A load view is needed to load the reviewed content into Vasont. This can be the same load view that you use for loading content for editorial updates to be used for loading the reviewed content, or it can be a special load view that is created solely for this purpose. Settings needed for the load view header: 1. Processing Options tab: a. Client_key_filename This processing option identifies the file that will be loaded. b. Remove_processor_instructions This processing option is needed to eliminate the review processor instructions from loading into the Vas- ont. If you have processor instructions that you need to preserve, then you will need to define them in the argument on this processing option. c. Load_other_view (providing you can reuse the component structure from another load view). Right-click on the processing option and select Update Arguments to set the name of the load view that contains the component structure that will be referenced. This processing option uses a component structure from another load view thus reducing component maintenance in the future. If the component structure contains processing options or settings that differ for a review, then this processing option can not be used. If you are using an existing load view that is used for other purposes, then this processing option is not required. 2. Advanced tab: a. File Extension: Set to “xml” or “dita” (depending on your use of the file extension in your content). b. File Contains XML: This box should be checked in order to extract the content according to XML stand- ards. c. Vasont Administrator Use Only: This box should only be checked if you created a load specifically for loading review content. Checking this box will hide the load view from normal load options in the Vasont application. If you are using an existing load view that is used for other purposes, then this setting is not necessary. The load view component structure: The component structure may be identical to the one used for editorial updates or loading new content. If so, then you may use the load_other_view processing option on the view header, and there will be no component structure for the load view. If you altered the XML with the review extract view, then you may need a new load view and component structure that will remove the extra items.256 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideKeep in mind that if you modify the extracted XML, then you will need to be able to reverse these items out of the XML before reloading the content after the review activity. Collaborative Review Edit ViewThe component in the edit view that will be the launching point for review content must have the review information defined in the edit view. This may be a primary component or a sub-component in the edit view (i.e., Concept, Sec- tion).On the Review tab of the component's update window apply the following settings:• Style Name: This field only applies to the previous version of Collaborative Review and is ignored by the current Collaborative Review tools.• Extract View: Set this to the extract view that will be used to assemble content for reviewing. See Collaborative Review Extract View.• Load View: Set this to the load view that will be used to load the modified review file to Vasont at the end of the review activity. See Collaborative Review Load View.• Automatic Update: This setting determines whether the modified review content is loaded to Vasont at the end of the review activity.• Always Load: Loading always occurs at the end of a review.• Never Load: Loading process is always bypassed meaning the Review Editor needs to apply all changes to the content manually in Vasont.• Prompt User: In the current Collaborative Review, loading will always occur.• (none): This is a required field. (none) exists in this column to allow a user to specify (none) for all fields, thereby removing the Review record.• Default Due Date Settings: This section defines the default duration for the review due date and the edit due date when initiating a review in Vasont. The number of days defined are added to the review start date. If left blank, the default duration for the review due date will be one day from the start date, and two days from the start date for the edit due date.• Review Email: This section allows for additions to the review email that is sent at review initiation. A link or additional text entered in this section are inserted in the emails sent for the review.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 257 Collaborative ReviewCollaborative Review Collection Privileges Reviewers do not need any collection privilege in order to perform reviews. The Review Coordinator and the Editor need to be able to work in Vasont and gain access to the content. At a minimum, the Review Coordinator must have the Initiate Collaborative Review privilege in a collection in order to start a new review. The Editor must have privileges to load and update content. Typically, an Editor would have the Update (Full Rights) privilege, but your business may have more restrictive privileges for the Editor role. See Collections Tab and Privileges Tab for more information.Collaborative Review Reference Documents Often a user with a review task may need to access a related document to effectively assess the content to which they have been assigned. This is accomplished by storing the document in a Vasont component that the Collabora- tive Review can find and open. The component that stores the document must be a multimedia component or a pointer to a multimedia component that is a descendant of the top-level component being reviewed. To enable this feature: 1. In this example, the reviews are performed from the Section 1 component in the collection. The Section 1 component has a Documentation Update Ref child pointer component that points to another collection that stores Attachment multimedia components.2. In the Edit view, place the review_attachments_from_descendant processing option on the component where reviews are enabled. Set the descendant_component to the component where the documents are stored. In this258 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide example, the component is Documentation Update Ref. It is a child component of Section 1, and Section 1 is the component where reviews are performed.3. In Vasont, create a component that stores a document. In this example, a Documentation Update Ref and the Attachment component that it points to is created. Initiate a review on the Section 1 component. The reference document is extracted and stored along with the rest of the content. Open the review. The reference document is stored in the Extract\Reviews folder. Click on the View Attachments button in the XML editor. If multiple documents exist, you are prompted to select the desired document. If only one document exists, it automatically opens for viewing in the associated application. Also see the Vasont Processing Option Guide for information on review_attachments_from_pointer for another processing option configuration.Collaborative Review Workflow Various stages of the Collaborative Review can cause automated workflow advancement. This is done by applying a processing option to complete a workflow task based on the Reviewing phase, or to assign a workflow task to the Editor selected for the review. In order to implement the Workflow and Review automation, the Workflow must be applied to the component where the review is initiated.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 259 Collaborative ReviewConsider the following workflow example for a Concept collection. This workflow is applied to the Concept primary component.In the Vasont Administrator, the complete_review_task processing option is applied to the Edit View component.For the complete_review_task with the review_start event, assign the task argument of Initiate Review (shown in the previous screen shot).260 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideIn Vasont, the active workflow task for the Concept component is Initiate Review. The Review Coordinator clicks the Initiate New Review button on the Reviews Details pane to start the reviewing process.The active Initiate Review task is completed as shown in the next screen shot.In the example workflow project, the next task of Monitor Review is mandatory, so it is automatically initiated when the Initiate Review task is complete.In the Vasont Administrator, the assign_current_user processing option is applied to the Monitor Review workflow task, which automatically assigns the same user that completed the Initiate Review task.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 261 Collaborative ReviewTo further automate the process, the Monitor Review task can be automatically completed by applying the com- plete_review_task processing option with the review_reviewing_end event to the Concept component. Set the processing option argument to Monitor Review.In Vasont, when all Reviewers have completed their review session, the Monitor Review task is completed. In the example workflow project, the next task of Review Editing is mandatory, so it is automatically initiated when the Monitor Review task is complete.In the Vasont Administrator, the assign_review_editor processing option is applied to the Review Editing workflow task, which automatically assigns the Editor defined in the review to the Review Editing task. The following screen shot shows that in Vasont when the Review Coordinator initiated the review, the Review Editor was set to STEVE. When this workflow task is initiated, the processing option checks for a Review Editor. If one is found the task is automatically assigned to that Editor.262 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideIf an Editor is not found, or the Editor is not defined as a user who is allowed to perform the task, a pick list is displayed and you must select a user for the task assignment. Currently there are two processing options available for Workflow automation with Collaborative Review. For more information, see complete_review_task and assign_review_editor in the Vasont Processing Option Guide.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 263 Collaborative Review264 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide Building a Translation SetupImplementing a translation configuration allows you to utilize Vasont features for a uniform method of preparing and sending documents to and retrieving translated content from translation vendors. This section provides guide- lines for a basic implementation. To further customize your setup, there are several processing options that can be added to provide additional functionality for translation tracking and reporting, extracting, and publishing. See the Processing Option Guide chapter on Processing Options by Function. The section titled Foreign Language Handling lists processing options that were specifically developed for translation processes. For more information on how the translation features work, see the Managing Translations chapter in the Vasont User Guide.IMPORTANT: If you had a translation configuration prior to ST 2.2 release, a conversion will be 2 necessary to create raw material relationships for your translated content. Contact your Vasont support leader to discuss options for moving to the current Vasont translation methods.Creating Translation Collections and Views Each client's translation configuration varies depending on their needs. The items mentioned in this section are the key pieces that are necessary for a basic translation configuration. Once you have these items in place you may want to add other processing options, previews, and extract or load views to further enhance your translation setup. Before you begin, we recommend that you discuss your project with your Vasont support leader so that he/she can confirm that your system is a candidate for the instructions that follow in this section. If you prefer, your support leader can provide options for Vasont Systems to work with you to set up a translation configuration that best meets your needs.IMPORTANT: If you had a translation configuration prior to ST 2.2 release, a conversion will be 2 necessary to create raw material relationships for your translated content. Contact your Vasont support leader to discuss options for moving to the current Vasont translation methods.As of release ST 2.2, the standard configuration for translation should consist of the following: 1. Build two Vasont collections: one for source (or base) content and one for translated content. These two collections should have almost identical layouts so that the source content can be easily cloned into the target collection (once for each language). It is recommended that you duplicate the base language collection (typically English) to create the Translation collection. Additional processing options and attributes can be added to either collection as needed to provide features that may be desired for locating, updating and reporting on translated content. See Building Collection Views for more information on building a collection. See Duplicating a Collection for duplicating a collection. 2. If the source collection has pointers to modular content that also need to be translated, then create a translation collection for each source modular content collection. The following screen shot shows English collections and corresponding translations collections for DITA Map and Topic content. This same concept also applies toVAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 265 Building a Translation SetupDocBook or custom DTDs that have been modularized in Vasont. Instead of a Map and Topics, you may have a Book and Chapters or Sections.After the collections are cloned you will need to make some modifications to the translation collections: • Rename the translation collections so that you can easily distinguish them from the source collections. You may also want to alter the Load and Extract views names to include “translation” or “Trans”. • Pointers will need to be redefined in the translation collections so that they point to the appropriate translation collection target component. Pointers that point to modular content should be defined as “modular pointers” so that they are properly processed through the translation clone and translation extracts. This includes pointers to images or graphics. • If you are using Previews and Reviews in your setup, you will need to redefine the extract and load views on the translation Edit view components where you have allowed this functionality. Because of the clone, the extract and load views may be pointing to a view in the base collection, rather than the appropriate view in the translation collection. If you do not want to use Review in the translation collection, you may want to remove the capability en- tirely from the collection components. • Processing options on components in the translation collections will need to have their arguments analyzed to determine if they need to be updated for their new location. Here are a few examples: client_key_from_id will need to have the arguments removed that relate to clone. For example, if the arguments are listed as “overwrite=no prefix=v clone=y” then it should be changed to “overwrite=no prefix=v” in the translation collections. This is because the client keys on the components in the translation collection should remain the same as the source language components, but with a language suffix. Having consistent client keys is a key mechanism for linking the source and target components. This processing option is found on components in the Edit views. ref_extract, ref_extract_file or similar processing option for extracting referenced content will need to have their arguments updated in the translation collections so that they point to the appropriate extract view in the translation collection. These processing options are found on components in the Extract views. load_other_collection or similar processing option for loading modular content in the translation collections will need to have their arguments updated so that they reference the correct load view in the translation collection. Remove processing options that do not make sense in the translation collection. For example, processing options that automatically initiate workflow on the source content will not make sense on the translated content. • Workflow projects may need removed or changed in the translation collection to suit the activity that may occur in the translation collection. Workflow projects can also have processing options applied to tasks, so be sure to check the argument values to determine if alterations are necessary.266 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide• Assign user permissions to the new translation collections. These permissions will most likely be scaled back from the source collections because the number of users who may be allowed to work on translations, and the activity that they may perform, will be reduced. 3. Create a descendant metadata component in the Edit view of the main source collection (Map, Manual, or Book) that has a target language attribute. In this example, the Translation Metadata component is a child component to the primary component in Book Maps collection. Translation Metadata contains the Translation Lan- guage component with an attribute called xml:lang. The xml:lang attribute has defined values for the languages that will be used in your system.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 267 Building a Translation Setup4. Add the translate_clone processing option to Map, Manual or Book primary components. This can be added as a navigator pop-up processing option to the source primary or on a task in workflow. Include all the source- target collection IDs in the collection_pairs argument.Note: Translations processes, such as cloning and extracting for translation, begin at the highest level in your document. This is typically a Map, Manual, or Book. Therefore, this processing option is placed on the primary component in that collection. This is also the same collection that will contain the Translation Metadata Edit view component. To find more information on translate_clone processing option, see Processing Option Properties. The translation_clone processing option is compatible with the streamlined_exact_clone processing option. The benefit of using streamlined_exact_clone is that it will improve performance when cloning content for translation. Testing has shown in a typical DITA setup, that using streamlined_exact_clone for topic collections has made the translation process run more than twice as fast as the normal configuration. • The streamlined_exact_clone processing option relies on the source and target collections having the same edit view structure, which is normally the case with base topic collections and their corresponding translation topic collections. Since the structures match, the cloning process is able to bypass some of the default routines. • The streamlined_exact_clone does not handle post_add event processing options on the target collection for sub-components, however, it does for primary components. Since the client keys are not adjusted in translation collections, the absence of post_add processing options should not be an issue in a normal configuration. • If you have other critical post_add processing options for sub-components in the translation collection configuration, then the streamlined_exact_clone processing option should not be used. 5. Apply the delete_parallel_collection_attribute processing option (with the approve_pre event) to all Edit view primary components in the source collections (Maps, Concepts, References, Topics). This processing option will clear an attribute value on the corresponding translation content when the source primary component is268 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide placed into an approved status. This is the signal that the translated content is no longer valid because the source content has been changed. In this example the attribute that will be cleared is translation.6. Apply the client_key_use_popup processing option to all Edit view primary components, both source and translated collections. This processing option places a new item on the right-click menu in Vasont that allows you to create a list of other components in the system with the same client key value. Therefore, you are able to see and navigate between the source and translated instances of the content. Note: The ignore_suffixes_delimiter is an important argument in the use of this processing option. It should be defined as “_” (underscore character). This allows the list to contain the source component and target language components because they both have the same client key value, but with different language suffixes. For example: v123456, v123456_es, v123456_fr. 7. Create an attribute that will store the status of the translation process. Typically this attribute is called “translation”, but you may name it something else if preferred. Apply this attribute to the Edit view primary components in all translation collections. This attribute typically has three values: required, pending, and complete. The automated extract and load programs will set this attribute as it performs each of its functions. Note: This is the same attribute that was mentioned in delete_parallel_collection_attribute 8. Create an Extract view to be used for extracting content to send to the translation vendor. Some key features of this extract view: • A translation Extract view is needed for the main collection (Map, Manual, Book), as well as all modular collections. • embed_extract_info_pi processing option should be applied to the header of the Extract view. Be sure to populate the load_version argument with the correct load view to be used for updating the database with the completed translation. • bypass_application_launch processing option should be applied to the header of the Extract view. This will keep the application that has a Windows file association to XML from launching. • There will be no processing options to extract referenced modular content. This is because the programs that will be automatically extracting the content will find the referenced modules and extract them as a separate XML file. If you do not plan on using the automation programs for extracting, then you may want to keep the processing options for extracting referenced content. • exclude_tags should be removed from modular pointer components if you are using the automated extract extension program. This is because you need a placeholder in the XML file for the referenced module when loading the completed translation. If you are not using the automated extract extensions, then leave this processing option in place. 9. Create a Load view for loading completed translations that come back from the translation vendor. Key features of this load view include the following: • A translation Load view is needed for the main collection, as well as all modular collections.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 269 Building a Translation Setup• translation_load processing option should be applied to the header of the Load view. This processing option will cause the raw material being loaded to be flagged with the language to which it has been translated. • load_other_collection and similar processing options that cause referenced modular content to load into their respective collections should be removed if using the automated extract and load programs. If you are not using the automated extract extensions, then leave this processing option in place. 10. Add language definitions for each language. The same language abbreviations that you use in your content for the metadata language attribute should be used here. They do not need to be the same as the language abbreviations that your vendor uses.See Translation Languages for more information. 11. Add translation memory definitions. This value will be used to identify the raw material relationships between the source language and the translated languages. See Translation Memory for more information. 12. Add a vendor definition for each translation vendor.See Translation Vendors for more information. 13. For each vendor define the languages they can translate by linking your abbreviation for the language with the vendor's specific language abbreviation. See Translation Vendor Languages for more information. 14. If you have purchased translation extract/load extension programs, they will need to be installed and configured. (Instructions will be included with your delivery package.) The program runs on a separate PC, not on client PCs. See Automated Translation Extract and Load Programs for more information. If you do not plan on using an automated extract and load program, then you might consider the following processing options for setting the translation status attribute: • set_attribute_on_extract can be placed on the translation Extract view header. This processing option will set the primary component's “translation” attribute to “pending” when the content is extracted to go to the translation vendor. • attribute_default_load can be placed on the primary component of the translation Load view. This will set the “translation” attribute to “complete” when the translated content is loaded from the translation vendor. Automated Translation Extract and Load Programs Translation Extract and Load automation extensions are programs that can be purchased to supplement your translation process. They are required for a successful translation process to create the raw material relationships between270 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide the base language content and the languages to which the content has been translated. They also eliminate the bur- den of finding, extracting, and loading content that requires translation. In addition, they allow you to hold back content that has been previously changed and does not require re-translation.The programs watch over the content in the translation collection and determine when a Map, Manual, or Book and its modular content should be extracted and sent to the translation vendor. The program will extract the content and organize it into folders based on the project and the language to which it will be translated. The folders and files are placed in a specific location where the translation vendor can retrieve them for processing.When the vendor has completed the translation of the content, they will place the files in a specific location where the Load program will find them. The Load program will pick up the files and load them into Vasont in the appropriate collection. While loading the translated content, the program will update or create the raw material relationships between the base language content and the translated equivalent of the content. In addition, the translation status attribute will be set on the content to signal that the process has completed. 2 These programs are the only way to create and update raw material relationships in the database.If you are interested in adding these programs to your translation setup, contact your Vasont support leader for more information. Image CollectionsThe setup for an images or graphics collection will vary depending on whether you have a DITA configuration or other structured format. Since DITA images can contain content as well as a stored BLOB, the translation extract view is modeled the same as a DITA topic, except the image component will extract a BLOB. In other structures where an image is simply a stored BLOB, the translation extract will look a little different.The translation extract view for a non-DITA images collection may have an empty navigator (meaning no components will exist in the extract view). The header of the translation extract view will contain the blob_extract processing option. This processing option allows the automated extract program to pull the stored BLOB without creating any XML files. The client_key_filename processing option is also applied to the extract view header so that the stored BLOB is extracted with a filename that is equal to the client key. This will be important when loading the revised image files.The translation load view for a non-DITA images collection may contain the blob_load processing option. The automated load program will use the image filenames to determine where the images should be stored in Vasont. Component Level TranslationIf you wish to send your translation vendor XML files that contain components that were previously translated and stored in Vasont, you can utilize the component_translation_extract processing option. See the Processing Options Guide for more information.This type of extract will create a bilingual XML file. Therefore, before implementing, check with your translation vendor to verify that they are able to accept such files. Translation PreviewsIt is possible to create a Vasont preview of base content and substitute translated language content where available in the system. This functionality allows you to determine how much of the content is already available in the system for the selected language and how much will go to a translation vendor. Having this information before the base language document is finalized gives you the opportunity to reword or rewrite content to reduce translation costs.See Preview for Displaying Stored Translation Content for more information.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 271 Building a Translation SetupCreating Translation Vendor Languages In order to use Vasont's translation features, a few Vasont Administrator entries are required to define the vendors and the languages to which the content will be translated. The Translation Vendor Languages section of the Con- tent Navigator holds this information. A Translation Vendor Language entry defines a vendor and the languages that they will be handling. In addition, a translation memory is assigned that will allow Vasont to track the translation relationships in the raw material stored in Vasont. Once these fields are created, a Translation Vendor Language entry may be created. See Translation Ven- dor Languages for more instructions. Translation Languages In the Languages section of the Translation Vendor Languages, the names of each language and their Vasont abbreviation are defined. To create a language: 1. Expand Translation Vendor Languages in the Content Navigator. 2. Right-click on Languages and select New.3. Enter the language information.• Language Id: This number is automatically generated and identifies a language that will be used in Vasont. • Language Abbreviation: Enter the abbreviation to be used for the language in Vasont. A few things to consider when assigning the abbreviation: 1) What abbreviation will your translation vendor expect. For example, the vendor uses “es” for Spanish. 2) Do your publishing tools expect a specific abbreviation for the language? For example, the DITA-OT expects languages to be defined as “es-es”, rather than “es”. • Language Description: Enter the language name. • Flag Image Filename: To display a country flag along with the language in Vasont, use Browse to navigate to and enter a flag graphic in the Flag Image Filename field. Use View/Edit Flag to preview the stored image. Note: If you do not have graphics for the country flags, you can search for them on the internet. • Default Unit Cost: Enter the amount that is normally charged for translating a word in this language. This value is used to calculate costs and savings in various Vasont Translation windows and reports.272 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide• Default Match Unit Cost: Enter the normal cost for handling a word that already exists in the vendor's translation memory. This value is used to calculate costs and savings in various Vasont Translation windows and reports. • Auto Submit Vendor: Use the drop-down list to select a default vendor for the language. If a specific vendor is set, then translation projects for this language will automatically be sent to the chosen vendor. 4. Click Save and Close. The fields will display in the Translation Languages pane. To update a language: 1. Right-click on the language to be edited and select Update. 2. Edit the fields as needed. 3. Click Save and Close. The fields will display in the Translation Languages pane. To delete a language: 1. Right-click on the language to be removed and select Delete. 2. Click Yes to the warning “Are you sure that you want to delete this item?”. If you do not want to proceed with the delete, click No to cancel without making any changes. Translation Memory Vasont's Translation Memory is the ability to track relationships between base language text and the translated versions. In the Translation Memory section of the Translation Vendor Languages, the name of each translation memory is defined. To create a translation memory: 1. Expand Translation Vendor Languages in the Content Navigator. 2. Right-click on Translation Memory and select New.3. Enter the translation memory name.• Translation Memory Id: This number is automatically generated and identifies a translation memory in Vasont. • Translation Memory Name: Enter the name of translation memory. This is the name that Vasont uses for tracking component level and language relationships. 4. Click Save and Close. The fields will display in the Translation Memory pane. To update a translation memory: 1. Right-click on the translation memory to be edited and select Update.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 273 Building a Translation Setup2. Edit the fields as needed. 3. Click Save and Close. The fields will display in the Translation Memory pane. To delete a translation memory: 1. Right-click on the translation memory to be removed and select Delete. 2. Click Yes to the warning “Are you sure that you want to delete this item?”. If you do not want to proceed with the delete, click No to cancel without making any changes. Translation Vendors Translation vendors are defined in the Vendors section. To create a vendor: 1. Expand Translation Vendor Languages in the Content Navigator. 2. Right-click on Vendors and select New.3. Enter the translation vendor information.• Translation Vendor Id: This number is automatically generated and identifies a vendor in the Vasont Ad- ministrator. • Vendor Name: Enter the translation vendor's name. • Vendor Supports Quoting: Place a checkmark in the box if the vendor provides quoting services. • Active: This setting allows you to temporarily eliminate a vendor from consideration for receiving translation projects without permanently deleting them. Select “Yes” or “No” from the drop-down list provided. • Translation Memory Name: Select the translation memory that the vendor uses from the drop-down list provided. See Translation Memory. 4. Click Save and Close. The fields will display in the Translation Vendors pane. To update a vendor: 1. Right-click on the vendor to be edited and select Update. 2. Edit the fields as needed. 3. Click Save and Close. The fields will display in the Translation Vendors pane.274 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideTo delete a vendor: 1. Right-click on the vendor to be removed and select Delete. 2. Click Yes to the warning: “Are you sure that you want to delete this item?”. If you do not want to proceed with the delete, click No to cancel without making any changes. Translation Vendor Languages Once languages and vendors have been entered, a Translation Vendor Language may be created to associate vendors with specific languages. To create a translation vendor language: 1. Right-click on Translation Vendor Languages and select New.2. Populate the fields in the window to associate a vendor and language.• Vendor Name: Select a vendor name from the drop-down list. Note: The list is populated from the entries found in the Translation Vendors section. • Language Description: Select a language from the drop-down list. Note: The list is populated from the entries found in the Languages section. • Vendor Language Id: Enter an abbreviation that the translation vendor will use to identify the language. • Unit Cost: Enter the cost that the translation vendor will charge to translation content in the specified language. • Match Unit Cost: Enter the cost that the translation vendor will charge for handling translation matches. 3. Click Save and Close.To update a translation vendor language: 1. Right-click on the translation vendor language to be edited and select Update. 2. Make edits as needed. 3. Click Save and Close.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 275 Building a Translation SetupTo delete a translation vendor language: 1. Right-click on the translation vendor language to be removed and select Delete. 2. Click Yes to the warning : “Are you sure that you want to delete this item?”. If you do not want to proceed with the delete, click No to cancel without making any changes.276 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide Customizing Vasont NavigatorCustomizing the Logo on the Vasont Home Page The Vasont logo appears at the top of the Home Page in Vasont. You can customize the look of your Home Page by replacing the Vasont Systems logo with your own logo, if desired. To display your logo, place your graphic file (.bmp files only) in the root directory where Vasont is installed (e.g., C:\Vasont). The file must be named as follows: VasontClientLogo.bmp.You may need to experiment with the sizing of your graphic file. The graphic will be automatically resized when it is displayed on the Home Page. You will get the best results if your graphic is propor- 2 tioned similarly to the Vasont Systems logo.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 277 Customizing Vasont Navigator278 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide Setup OptionsThis chapter provides optional configuration features that you may find useful to add to your setup.Creating a Collection for Storing Unstructured Documents To create a collection to store content such as PDFs, Microsoft Word or FrameMaker documents, DTDs, XLS, ZIP, sound or video files, begin as you would when you create any new collection. 1. Create a new collection and give it a meaningful name. (See Creating a New Collection)2. Create a new raw component. (See Creating New Raw Components). 3. Give the raw component a name and select Multimedia as the raw class. This means that a file may be attached to the component.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 279 Setup Options4. Select the Advanced tab. By default, Text is set to optional. This means that text may be stored in this component.5. To place the component in the new collection, go to your collection and open a Navigator for the edit view. The edit view will be empty.6. Right-click in the empty Navigator and select New. Select the new raw component document from the Alias Pick List and click OK.7. The new component is now in the Navigator. Right-click on document and select Update. Go to the Processing Options tab, right-click and select Add.8. From the pick list, select client_key_from_id with the post_add event and click OK. 9. The processing option is now in the window. Type in the text argument of "overwrite=n prefix=v" 10. Click the Advanced tab. Set the Matching Criteria to Client Key.280 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide11. To provide import capabilities to the multimedia collections in your database, you need to add the file extensions that you will be using to the Helpers Table. See Adding an Extension for more information.Creating a Modularized Content Model for Reuse This section provides information on configuration modifications necessary to reorganize content for modularization. Content Modularization helps to promote maximum reuse in Vasont, improve the efficiency of previews and collaborative reviews, and segregate content based on security and privileges. If you have chunks of content that are reusable as a unit, it makes sense to modularize the reusable content to store and maintain in a separate Vasont collection. An example of this is Sections or Topics that may be reused in several Manuals or Maps. There are many benefits to modularization: • information is presented consistently in all documents that reference a module • you make alterations only in one location and all documents using the content are automatically updated • you can assign specific security and privileges to modular collections • you can track where each module is utilized To set up the modular content you need to: • create a new collection for the reusable content (modules) • drag-and-drop the reusable component from the base collection to the new collection • create a modular pointer component in the base collection • run the Clone Collection Utility with the collection modularization selected This process has many steps. For the purpose of illustration, our starting point was to determine that Chapters are comprised of many Sections that could be utilized by more than one Manual. Use the following steps as a guide for building your own modularized collection. Creating a Section Collection The first step is to create a new collection for the reusable modularized content. 1. Right-click on the Manuals collection, and select New.2. At the New Collection window, name the new collection Sections, and assign an abbreviation of Sections. 3. Save and Close the window.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 281 Setup OptionsThe new collection displays in the Content Navigator.Creating the Edit View Next, drag-and-drop the reusable component from the base collection to the new collection. 1. Open an Edit View navigator for the Manuals collection. Click the + on the primary component Manual, and on the Chapter component to expand the view. 2. Open an Edit View navigator for the Sections collection. 3. Position the two navigators so that both are viewable. 4. Locate a Section component in the Manuals navigator. 5. Hold the Ctrl key and drag the Section component from the Manuals navigator to the Sections navigator.6. Close both navigators by clicking the in the upper right corner. Creating the Load View 1. In the left windowpane of the Content Navigator, find the Sections collections, right-click on the Load View, and select New. 2. On the General tab, enter "Load Sections" as the name for the view. 3. Save and Close the window. 4. Open a Load View navigator for the Manuals collection. 5. Open a Load View navigator for the Sections collection. 6. Position the two navigators so that both are viewable. 7. Locate a Section component in the Manuals navigator. 8. Hold the Ctrl key and drag the Section component from the Manuals navigator to the Section navigator.282 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide9. Close both navigators. Creating the Extract View 1. Right-click on the Extract View in the left windowpane of the Content Navigator, under the Sections collection, and select New. 2. Enter Extract Sections to name the view. Use the drop-down arrow to change the View Type to Composite and Utility Extract. 3. Save and Close the window. 4. Open an Extract View navigator for the Manuals collection. 5. Open an Extract View navigator for the Sections collection. 6. Position the two navigators so that both are viewable. 7. Locate a Section component in the Manuals navigator.8. Hold the Ctrl key and drag the Section component from the Manuals navigator to the Section navigator. 9. Close both navigators Assigning Permissions and Privileges for Sections Collection Make sure to assign user permissions and privileges for modularized collection. See Creating and Maintaining Users or Roles for setting up access to a collection and assigning privileges for a User or Role. Adding Section Pointers to the Manuals Collection The Manuals collection will need to be adjusted to allow Section Ref pointer components. • Define modular pointer records for Section Ref to point to Sections collection. • Apply processing options to Section Ref to control the behavior for loading Section components. • Apply processing options to Section Ref to control the behavior for extracting Section components. Creating a Section Ref Pointer Component 1. In the Content Navigator, right-click Raw Components→New→Create New. 2. Name the new component Section Ref. Use the drop-down arrow to set the Raw Class to Pointer.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 283 Setup Options3. Save and Close the window. How to Locate Section Components1. Right-click Section in the Raw Component listing, and select Where Used. 2. Use the drop-down arrow to select the Manuals collection and click OK. 3. The Where Used window displays a listing of the places where Section components are currently located. Updating the Manuals Edit ViewFor our example, we will add a Section Ref pointer component to the Section [Appendix] component. 1. Click the Manuals Edit View tab to add a Section Ref pointer component Section [Appendix] component. • Open a navigator, right-click the parent Appendix component, and select New. • From the Alias Pick List, select the Section Ref component and click OK.2. The new Section Ref component has a navigator order of ‘‘1.’’3. Right-click the Section Ref component and select Update.284 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide4. On the General tab, update the Navigator Order value to match the existing Section component. In our example, Section has a navigator order of ‘‘3.’’ The Section Ref component should be given the same navigator order as the original Section component because the Section Ref component will replace the Section component. 5. On the Advanced tab, use the drop-down arrow to change the Matching Criteria to Client Key. 6. On the Occurrence tab, set the occurrence to match the existing Section component. In our example, the Sec- tion component has no occurrence set, so the Section Ref is left empty and the default value of ‘‘Zero, One or More’’ is applied. 7. Save and Close the window. 8. In the navigator the Section Ref component is displayed below the original Section component.Altering the Manuals Load View 1. In the left windowpane of the navigator, select the Manuals Load View. 2. In the right windowpane, right-click and select Open Navigator from the menu. 3. Right-click on the Section component and select Update. 4. On the General tab, use the drop-down arrow to change the component to Section Ref. 5. Save and Close the window. 6. Repeat these steps for all Section components (use the Where Used list to locate them). Altering the Manuals Extract View 1. In the left windowpane of the navigator, select the Manuals Extract View. 2. In the right windowpane, right-click and select Open Navigator from the menu. 3. Right-click the Section component and select Update. 4. On the General tab, use the drop-down arrow to change the component to Section Ref 5. Repeat these for all Section components (use the Where Used list to locate them). 6. Do not alter the Section [Section] entry. Adding Pointer Records to Edit View 1. In the Raw Component listing, right-click on Section Ref and select Where Used. 2. Using the drop-down arrow, select the Manuals collection and click OK.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 285 Setup Options3. Select the Edit View tab. 4. Select all entries of Section Ref. Right-click in the highlighted area and select Batch Update. 5. Select the Pointers tab. Right-click in the window and select Add. 6. Using the drop-down arrow, set the Collection to Sections and click OK. 7. Select [Section] and click OK. 8. The pointer record now appears in the window. This record states that the Section Ref component points to the Section primary component in the Sections collection. The Link Criteria when set to Client Key means the Section Ref and the Section will have the same Client Key in Vasont. The Same Primary when set to No means that the Section Ref can point to a Section that is not within the primary component (i.e., Manuals). The Pointer to Modular Content should be checked for this situation. This enables various features in Vasont for modularized content (i.e., cascading version history, checking referenced content in or out, content exception report features, etc. Checking this is highly recommended for modular content. It should not be checked for simple references that would not be reused in other situations.). Branch Notices should be checked if Branching will be utilized for the Sections. Checking this box will cause the SectionRefs to be marked with a branch notice icon (orange arrow) when a branch of the Section that the SectionRef points to is created. This is a signal to other users that there is another instance or update of the Section that may be preferred over the Section where the SectionRef currently points. For more information on branching modular content, see the Vasont User Guide. 9. Click OK. 10. Click Yes to save the changes. Adding Processing Options to Load View 1. With the Where Used window still open, select the Load View tab 2. Select all entries of Section Ref. Right-click in the highlighted area and select Batch Update. 3. Select the Processing Options tab. Right-click in the window and select Add. 4. Select load_other_collection from the listing and click OK. 5. Right-click on the processing option and select Update Argument. 6. Using the drop-down arrow, select Sections as the value for the collection argument and Load Sections as the value for the version argument. The load_other_collection processing option instructs the load process to take the Section content and load it into the collection identified in the argument. The version argument determines what load view to used. 7. Close the Arguments window by clicking on the X in the upper right corner. 8. Click OK. 9. Click Yes to save the changes Adding Processing Options to Extract View 1. From the Navigator, select the Extract View tab. 2. Select all entries of Section Ref. Right-click in the highlighted area and select Batch Update. 3. Select the Processing Options tab. Right-click in the window and select Add. 4. Scroll through the list and select exclude_tag. Scroll further down the list and select ref_extract using the Con- trol key. Click OK.286 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide5. The ref_extract processing option has a text style argument. This type of argument is keyed in the box to the right of the processing option. The name of the argument is version_id and its value is the identification number of the Extract View in the Sections collection. To find the Extract View identification number, see the Creating a Modularized Content Model for Reuse section of this document. The ref_extract processing option instructs the extract process to pull the Section content from the Section collection using the extract view identified in the version_id text argument. The exclude_tag processing option instructs the extract process to eliminate the tags associated with the Section Ref component. If this processing option is not applied, the extract file would contain two section tags for each Section extracted: one set of tags comes from the Section content extracted, and the other from the Section Ref. 6. Click OK. 7. Click Yes to save the changes. Adding Pointer Records for Xref Pointer records will need to be added to the Xref components in the Sections and Manuals collection. 1. In the Raw Component listing, right-click on Xref and select Where Used. 2. Click OK. 3. Select the Edit View tab. 4. Select all entries of Xref. Right-click in the highlighted area and select Batch Update. 5. Select the Pointers tab. Right-click in the window and select Add. 6. Click OK. 7. Select Manual, Appendix [Manual], Chapter [Manual], [Section], and Section [Section] components and click OK. 8. The pointer records should now appear in the window. The Link Criteria should be set to Client Key. The Same Primary should be set to No since the cross references may point to components in other Sections or other parts of the Manual. The Pointer to Modular Content should not be checked for this situation. Branch Notices should not be checked for this situation. 9. Click OK. 10. Click Yes to save the changes. 11. Close the Where Used window. Running the Collection Modularization Utility Now that the setup has been prepared for modularized Sections, the data will be pulled out of the base collection (Manuals), placed into their new collection (Sections), and a pointer created in the base collection to link to the content. 1. Select Utilities → Clone Collection. 2. A collection selection window will display. Select Manuals because this is where the Section content currently resides. Click OK. 3. Click OK to bypass the filter. 4. A listing will display containing all of the primaries that exist in the Manuals collection. 5. Select all of the entries. Note: The utility may be run on one or more specific primaries if desired. 6. Click the Clone button on the toolbar.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 287 Setup Options7. The Clone Entry window will display. In this window, select the collection where the content will be moved. In this example we will be using Sections collection. The Perform Collection Modularization box should be checked. This is what tells Vasont to pull only the content that is appropriate for the Sections collection. Click Clone. 8. When the process has completed, click the X in the upper right corner to close the Clone Collection window. 9. Open a navigator for the Sections and the Manuals collection and verify that the Sections were moved to the Sections collection. In the Manuals collection, the Section component should have been replaced with a Section Ref component. Verify that the Section Ref is linked to a Section component in the Sections collection. Right- click on a Section Ref and select Open Navigator. The Section will highlight in the Sections collection navigator (if it is open, otherwise a new navigator will open). 10. Close the navigators. Post Modularization Alterations Once all of the Section components have been moved out of the Manuals collection, the Section component can be deleted from the Manuals collection in the Vasont Administrator setup. Removing Section From Edit View 1. Right-click the Section in the Raw Component listing, and select Where Used. 2. Using the drop-down arrow, select Manuals collection and click OK . 3. In the Where Used window select the Edit View tab. 4. Right-click the Section [Appendix] component in the list and select Open Navigator. 5. Right-click on the Section component and select Delete. Note: To ensure that errors have not been made, verify that there is a Section Ref component at the same location before deleting the Section component 6. Click Yes to confirm the deletion. 7. Close the navigator and return to the Where Used list. 8. Repeat steps 4–7 for Section [Chapter]. 9. Close the Where Used window Testing the Setup in Vasont • In Vasont, approve Manuals and Sections. • Perform an extract of a Manual to verify that the Sections are being extracted in the appropriate position in the XML file. • Perform a load to verify that the Manual and the Section components load to the appropriate collection. • The primary should not go to draft status when round tripping the data. • The Section Ref should not be dropped or go to incomplete status when round tripping data. Other Configuration Options When the base content is loaded back to the database, the modularized Section components are updated, as well. In most client sites, the updating of a modularized Section is controlled by a specific group of users, who are most likely not the writer of the Manual. In this situation, the load_other_component processing option would not be placed on the Section components in the Load View, therefore restricting the Manual writers from changing the Sec- tion components. The following is a list of processing options that will allow conditional loading of Section components: 1. The load_other_collection_attr_required processing option loads the Section components (and their nested children) based on an attribute.288 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide2. The load_other_collection_attr_restrict processing option restricts the load of the Section components (and their nested children) based on an attribute. 3. The load_other_collection_status processing option loads the Section components (and their nested children) only if the Section component does not already exist in the Sections collection, or if the Section component is in Draft or Incomplete status. It is also possible to have the Section components reside in the Sections collection if they are reusable, or in the Manuals collection if they are unique and have no reuse value. To do this: • The Section and Section Ref components coexist in the Manuals Edit View. • The Section and Section Ref components will coexist in the Manuals Extract View. The Section Ref component will need a <sectionref> wrapper so that it will not overlap the Section component and <section> wrapper. The Sections collection will have an attribute on the Section component, with the processing option extract_val- ue. When the Section is extracted, the attribute will contain the fixed value that marks the Section as a reusable Section. The Section components that come from the Manuals collection will not contain the attribute value. Note: Normally this special attribute does not exist in the Edit View, therefore restricting a user from inadver- tently assigning a value to the special attribute on a Section. • The Section component will be in the Manuals Load View, but not the Section Ref. This is because all Section components in the XML will have the wrapper of <section>. When loading the Manual to the database, a processing option called change_load_component will look for the designated attribute with a specific value. If found, the Section will become a Section Ref and the content is dropped, and if not found the Section and its children will be loaded to the Manuals collection as a Section component.Controlled Vocabulary Vasont's Controlled Vocabulary (sometimes referred to as Terminology Management) feature includes mechanisms to define vocabularies as collections of terms, along with a user interface to validate Vasont content against those vocabularies and adjust the content and/or vocabularies as part of that validation process. This feature leverages database indexes built at the word level to greatly enhance performance. Behind the scenes a configurable lexicography engine is used to determine word breaks and to define “busy” terms such as “an”, “and” and “the”. See Oracle Text Stopwords.If the Oracle Text index for Vasont's textual content is not currently implemented, an Oracle Data- 2 base Administrator will need to enable the Oracle Text index in order to use the Controlled Vocabu- lary features. Instructions for creating and maintaining the Oracle Text index on Vasont's textual content can be found in the Vasont Oracle Text Configuration document on the Vasont Installer CD- ROM. The CD-ROM also includes pre-built scripts for creating and scheduling the maintenance of Oracle Text indexes.Currently, Vasont's Controlled Vocabulary feature is implemented as Processing Options that can be configured in Vasont Administrator. It can support English terms, as well as terms for translated content vocabularies. About Vocabularies Within Vasont, a vocabulary consists of two simplistic “term” collections that work in tandem to define a list of allowed terms and a list of restricted terms. For a restricted terms collection, child pointer components that point to allowed terms are also defined under each restricted term entry to specify a preferred term, or multiple preferredVAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 289 Setup Options terms, that should be used instead of the restricted term. The following illustrates a vocabulary, consisting of an allowed terms collection and a restricted terms collection, and the relationship between the two term lists:In this example, note that the Restricted Terms collection can have zero, one or many preferred term children (references to the Allowed Terms entries). When there are multiple preferred terms, their order under the parent (restricted) term indicates their order of precedence. In Vasont's Controlled Vocabulary feature, a term is defined as a single word or a phrase (multiple words separated by spaces). So both the single word “university” and the phrase “Drexel University” are considered to be terms. Phrases in an Allowed Terms collection only have meaning if they are used as a Preferred Term for a Restricted Terms entry (Restricted Term pointer to an Allowed Term). When a phrase is present in the Allowed Terms collection (for use as a Preferred Term) and Dictionary Validation is to be performed, be aware that the individual words that comprise that phrase should have their own, independent entries in the Allowed Terms collection.Term collection entries should follow the same case conventions used in an English dictionary, where most words are in lower case, proper nouns are capitalized, acronyms are in all caps, etc.Even though term collection entries can be entered in mixed case, be aware that all validation processes are performed in a case insensitive manner. As an example, consider an “iPhone” entry in a Restricted Terms collection. The validation processes will currently flag all occurrences of “iPhone” in content as invalid, even if they followed the mixed case convention. In short, the Controlled Vocabulary processes do not currently enforce case conventions. Vasont's Validate Terminology window has limited support for determining the capitalization convention to use for Replacement Terms. In general, Invalid Terms will be changed to the Replacement Term exactly as it appears in the Replacement Term field. The only exception to this rule is the use of the Change All button. When Change All is clicked, the current Invalid Term (highlighted in the preview) is replaced with the exact contents of the Replace- ment Term field. For subsequent occurrences of the Invalid Term that occur at the beginning of a sentence, the first letter of the Replacement Term text is forced to upper case. In general, this rule is effective but care should be taken when using the Change All button.290 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideThe use of Vasont collections for the storage of vocabulary terms is intentional and provides many inherent benefits due to the nature of a Vasont collection. These benefits include, but are certainly not limited to: • A readily available and familiar interface (the Vasont Navigator) for viewing and manipulating vocabulary terms. • The visibility to, and access rights for, a Vasont collection can readily be controlled. This provides a mechanism to treat the vocabularies as “read-only” for a certain set of users, but allows other users to modify a vocabulary. • Because the terms in an allowed terms collection and the terms in a restricted terms collection share a common alias (e.g., they are all from a common pool of terms), drag-and-drop can be used to move terms between collections and to create preferred term references to allowed terms. • Simplistic Vasont Extract and Load Views can be constructed for the term collections, providing a methodology for importing, exporting and exchanging terminology information with other programs or applications. • Multiple vocabularies, using differing pairings of term collections, can readily be constructed for different purposes. With Vasont's Controlled Vocabulary feature, the allowed terms and restricted terms collections that comprise the vocabulary also play a key role in the validation technique to be used when verifying Vasont content against the vocabulary. Vocabulary Validation Techniques Vasont's Controlled Vocabulary feature currently supports two validation techniques: dictionary validation and terminology validation. • Dictionary validation verifies the legitimacy of the terms used in Vasont content. With this validation technique, the allowed terms collection in the vocabulary is the focal point of the validation process and contains a large list of terms, much like a dictionary. Dictionary validation is considered to be strict; any terms encountered in content that are not found in the allowed terms collection (not found in the dictionary) are considered to be invalid. When using dictionary validation, the restricted terms collection can be used to extend and enhance the dictionary validation process. Even though the validation process is primarily driven by the allowed terms collection, the restricted terms collection can be used to list terms that should be avoided and identify preferred terms for those undesirable terms. • Terminology validation verifies word choice for Vasont content. With this validation technique, the restricted terms collection contains a list of terms that should not be used in Vasont content. Optionally, a restricted term can have child preferred terms, implemented as pointers to terms in the allowed terms collection. Terminology validation is considered to be loose; any terms encountered in content that are not found in the restricted terms collection are considered to be valid. The validate_against_controlled_vocabulary processing option applied in the Vasont Administrator determines the validation technique for the collection. Refer to validate_against_controlled_vocabulary documentation for more information. Oracle Text Stopwords The Oracle Text index used with Vasont's Controlled Vocabulary feature utilizes the default Oracle Text stoplist. A stoplist identifies the stopwords that are not included in the Oracle Text index. Stopwords can also be described as “busy words” that do not significantly affect the meaning of content and are not commonly queried for.English Default Stoplist a because for how might one so there until while all been from however Mr only some therefore ve who almost both had I Mrs onto still these very whose also but has if Ms or such they was why although by have in my our t this we willVAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 291 Setup Options an can having into no ours than those were with and could he is non s that though what would any d her it nor shall the through when yet are did here its not she their thus where you as do hers just of should them to whether your at does him ll on since then too which yours be either his meDictionary Validation• Individual stopwords will be ignored by the Dictionary Validation process, even if they are included in the Al- lowed Terms collection. Another way of stating this is that single word Allowed Terms entries, that happen to also be an Oracle Text stopword, have no effect and are ignored, but their presence in the Allowed Terms collection does no harm. • Stopwords in the Allowed Terms collection that are used as (or as part of) a Preferred Term (for a Restricted Term entry) are treated as significant. As an example, the Restricted Term “due to” can successfully be replaced by the Preferred (Allowed) Term “because of” even though both “because” and “of” are classified, by Oracle Text, as stopwords. Terminology Validation• Stopwords in the Allowed Terms collection that are used as (or as part of) a Preferred Term (for a Restricted Term entry) are treated as significant. As an example, the Restricted Term “due to” can successfully be replaced by the Preferred (Allowed) Term “because of” even though both “because” and “of” are classified, by Oracle Text, as stopwords. • Phrases in the Restricted Terms collection, that contain a mix of stopwords and non-stopwords, will be handled as expected. So, the Restricted Term “due to” will be sensed and reported as an invalid term, even though “to” is an Oracle Text stopword. • Individual word Restricted Term entries that are also an Oracle Text stopword, or Restricted Term phrases that are comprised solely of Oracle Text stopwords, cannot be handled by the Terminology Validation process and will not be found in content. As an example, assume that a Restricted Term collection contains the word “almost” or the phrase “because it is”. During Terminology Validation, occurrences of the word “almost” or the phrase “because it is” that truly exist in content will not be found and reported. Controlled Vocabulary validation processes, during start up, will sense and notify the user about Restricted Terms that cannot be handled because of stopword usage. If this message appears, there are several adjustments that can be made to address the issue(s). 1. If practical, remove the word that is also a stopword (or the phrase that is comprised solely of stopwords) from the Restricted Terms collection. 2. If practical, extend the problematic word or phrase to include at least one word that is not an Oracle Text stopword. 3. Have the Oracle Database Administrator (DBA) alter the default stoplist (CTXSYS.DEFAULT_STOP- LIST) or create a new stoplist for use with Vasont. Discussions regarding stoplist manipulation can be found in the Oracle Text documentation for your Oracle Database version. See Stoplist section in Oracle Text Indexing Elements chapter of the Oracle Text Reference. Vasont Systems can also offer assistance with altering the default, or creating a new stoplist as a Database Consulting service. Implementing Controlled Vocabulary To configure Vasont to use the Controlled Vocabulary feature, two collections must be created:292 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide• An Allowed Terms collection that contains a primary component called Term. Use this component to define acceptable terms to be used in the content. • A Restricted Terms collection that contains a primary component called Term with a child pointer component called AllowedTermRef. Use these components to define terms that should not be used in the content and their corresponding preferred terms.Once these two collections are created, the Controlled Vocabulary feature can be enabled by applying two processing options to a component in the collection(s) to be validated: add_terms_to_controlled_vocabulary and vali- date_against_controlled_vocabulary. The add_terms_to_controlled_vocabulary processing option will allow the Allowed Terms vocabulary to be built based on content in existing Vasont collections. The Allowed Terms vocabulary can also be populated by loading simple tagged XML files from an external source, such as vocabularies that are available on the Internet. See the Processing Options Guide for usage instructions and examples. The terms in both collections can also be entered directly into the Vasont Navigator by typing them in the Update Windowby choosing "Add" off the right-click menu off of an existing term component.Dynamic Index A Dynamic Index is used to create an index view of an existing collection. Indexing is maintained dynamically by coordinating the cloning process to index the appropriate entries. In addition to indexes, sub-collections also can be generated. For example, Collection XYZ has a primary element of Book that has many children, including Author (see Setting the Primary). It may be necessary to make an index by Author, i.e. a new collection, with Author as the primary element and Book as a Child.Original Collection contains:Book Author A Christmas Carol Charles Dickens Friday Robert Heinlein Great Expectations Charles Dickens Oliver Twist Charles Dickens Pride and Prejudice Jane Austin Stranger in a Strange Land Robert HeinleinVAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 293 Setup OptionsTreasure Island Robert Louis StevensonAfter the creation of a dynamic index and the creation of a new collection by cloning the existing collection, the new collection appears like this:Index Collection contains:Author Book Jane Austin Pride and Prejudice Charles Dickens A Christmas Carol Great Expectations Oliver Twist Robert Heinlein Friday Stranger in a Strange Land Robert Louis Stevenson Treasure IslandCreating a Dynamic IndexA dynamic index is created from a collection's Edit View.1. Create a new (index) Collection (see Creating a New Collection).2. Add the new collection components to the edit view of the index collection (see Adding an Edit View Compo- nent):• The primary component in the new (index) collection is a child component in the collection to be indexed.• The child component in the new (index) collection is the primary component in the collection to be indexed.3. Add a dynamic index to the collection to be indexed: a. Expand the collection to be indexed (click plus sign (+) on left side of Navigator window). b. Click on Edit View. c. Right-click on the edit view under the View Description column (right side of Navigator window). d. Select Open Navigator from the drop-down menu. e. Right-click on the primary component and select Update from the pop-up menu.294 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide f. On the Dynamic Indexes tab of the Update window, right-click and select Add from the pop-up menu. Other menu selections are only enabled if dynamic indexes were previously added. g. Enter a Collection and/or Navigator Name in the Dynamic Index Filter dialog boxes. Or, use the drop- down arrow in the Collection box to make a collection selection, example, “All Collections”. This selection displays all collection components present in all collections within the same content type (except the current collection). h. If the OK button is selected, the Dynamic Index Pick List for Collection Components window displays. Select the applicable component from the list and click on the OK button. i. The Update window displays. j. If processing options must be added, click on the Processing Options tab, right-click and select Add from the pop-up menu. Any option whose event name begins with “dyn_idx” can be applied to affect the dynamic index. (See the Vasont Processing Options Guide). • Select the desired processing option(s) from the pick list that displays and click on the OK button. • The update window that displays contains the processing option(s) that was just added. k. Click the X at the top of the window to save the addition(s). A pop-up confirmation message displays.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 295 Setup Options• Click the Yes button to save the changes and return to the Edit View window to continue processing. • Or, to bypass the confirmation pop-up message, click on the Save and Close buttons on the main toolbar. The additions are saved and you are returned to the Edit View window. l. Repeat step's through l’ for each component in the Index collection. 4. If the collection to be indexed does not have any data, nothing more is necessary. The index collection is maintained dynamically. If the collection to be indexed already has data, populate the new index collection in Vas- ont by using the collection clone function from the initial collection to the index collection. For more information, see Cloning in the Reusing Content chapter of the Vasont User Guide.If an attribute value is preferred as the primary of the index collection, rather than the text of a com- 2 ponent, the processing options attribute_to_component_index_add, attribute_to_component_in- dex_edit and attribute_to_component_index_delete may be used. To read more about these processing options see Overview of Processing Options Descriptions in the Vasont Processing Options Guide.Deleting a Dynamic Index 1. Click on the Plus sign (+) to expand the Collection that was previously set up to be indexed (left side of Navi- gator window). 2. Select the Edit View. 3. Right-click on the Edit View header (right side of Navigator window). 4. Select Open Navigator from the drop-down menu. 5. Right-click on the primary component in the Edit View window and select Update from the pop-up menu. 6. Click on the Dynamic Indexes tab of the update window that displays, right-click on the entry, and select Delete from the pop-up menu. The entry is removed.7. Click on the Save and then Close buttons on the main toolbar to save changes and return to the Edit View window.Fast Extract of Modular Content The Fast Extract configuration is used to improve the normal extract time of modular content. The extract time is improved by quickly grabbing pre-extracted versions of the modules that have been stored as multimedia BLOBs within the referenced modules.296 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideAn automatic process that is invisible to the user will extract the content to an XML file. The XML file is then stored in a child multimedia component of the module.There three methods for creating the FastExtractXML BLOBs: • Approving the Primary Component: A processing option that is applied to the Edit view's primary component will cause the FastExtractXML BLOB to be created or updated each time the primary component is placed into an approved status. See build_blob_extract_approve. • Batch Processing: Go to Tools → Process Collection. Select the collection and highlight primary entries for which you would like to create FastExtractXML BLOBs. Click Build Fast button on the tool bar or go to Edit → Fast Extract Build. This process is available when the fast_extract_build processing option is applied to the primary component. • Scheduled Program Daemon: A program can be obtained from Vasont Systems that will run in the background to build FastExtractXML BLOBs for specified collections. Contact your Vasont support leader to get more information. When the Manual and its Chapters are extracted using the extract view that has been configured for Fast Extract, the referenced Sections are extracted according to program logic in the fast_extract_xml_blob processing option. If the Section content has not changed since the FastExtractXML BLOB was built, then the Fast Extract capability will pull the stored XML BLOB. If the content has been altered since the XML BLOB was created, then a normal extract process will occur. Improvement Analysis: In our initial testing using a DITA Bookmap that had 895 topics and 76 graphics, the extract speed using Fast Extract improved by 80%. However, the speed of an extract is dependant on many factors, including equipment, content complexity, configuration complexity, amount of changed content, etc., so results may vary. Configuring Fast Extract In the following example, the Doc Manuals collection references Chapters, and the Doc Chapters collection references Sections in the Doc <a href="/tags/API/" rel="tag">APIs</a> collection. Since a Chapter contains many Sections it can take some time to extract theVAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 297 Setup OptionsBook. Often times, there are only a few Sections that are actually updated; therefore, Fast Extract could greatly improve the timing of a Book extract.The Fast Extract configuration will be applied to the Doc APIs collection. There are a few key pieces: • A multimedia component to store the XML BLOB of the approved content. • The build_blob_extract_approve processing option on the Edit View primary component. • An Extract View for extracting the content to an XML file. • The fast_extract_xml_blob processing option on the header of the Extract View. Applying Fast Extract to a collection: 1. Create a multimedia raw component to hold the XML BLOB. In this example the name of the multimedia component is “FastExtractXML”. See Creating New Raw Components for more information. 2. Open a navigator for the Edit View of the modular collection where you will be configuring the Fast Extract. Add the new FastExtractXML multimedia component to the Edit View. It should be a child of the primary component. See Adding an Edit View Component for more information.3. In the same Edit View, apply the build_blob_extract_approve processing option to the primary component (Section 1). The arguments define the extract view to be used to extract the content and the multimedia component that will store the XML BLOB. See Updating an Edit View Component for more information on applying processing options.298 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideThis processing option is what causes the FastExtractXML BLOB to be built when the compo- 2 nent is placed into an approved status. If you do not want this behavior, omit this processing option from the component.4. In the same Edit View, apply the fast_extract_build processing option to the primary component (Section 1). The arguments define the extract view to be used to extract the content and the multimedia component that will store the XML BLOB. See Updating an Edit View Component for more information on applying processing options.This processing option is what causes the FastExtractXML BLOB to be built when using the 2 Tools → Process Collection → Build Fast.5. Apply the fast_extract_xml_blob processing option to the header of the extract view that is called when a Man- ual that references the content is extracted. An argument defines the component that stores the XML BLOB.The conref_attribute can be set to “conref” if you are working with a DITA configuration and utilizing content references (conrefs).This processing option causes the extract of the FastExtractXML BLOB, providing that it is 2 available and up-to-date.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 299 Setup Options6. In Vasont, perform some extract tests to confirm that the Fast Extract process is working correctly. Keep in mind when testing that the FastExtractXML BLOBs need to exist in order for the Fast Extract process to occur. If the BLOBs are not available, there will be no noticeable time savings.Electronic Signatures Electronic signatures in Vasont are achieved by utilizing a workflow task and component annotations. Annotations are permanent records in Vasont and are not able to be deleted or altered by users, which makes them suitable for an electronic signature audit trail. For more information, see Applying an Electronic Signature in the Vasont User Guide and electronic_signature_task in the Vasont Processing Options Guide. Applying an Electronic Signature to a Workflow Task: 1. Create a workflow project for the component. Identify a task that, when completed, will require an electronic signature. 2. Apply the electronic_signature_task processing option to the task. 3. Perform some tests in Vasont with the workflow to be sure that the electronic signature functionality is occurring when the task is completed.Extracting Checked Out Modular Content as Read- Only In modular content configurations, it is possible that a user may extract content that contains references to other content that is presently checked out to another user. In these cases, the user should be aware that another user is currently working on a chunk of content and that any alterations they make to that same chunk of content will be lost when updating the content to the database (providing the content is still in a checked out state). It is also possible that the referenced content is no longer checked out when the user loads his/her updated content. In this case, the older version of the content (that was extracted while another user had it checked out) will overwrite the content that the previously updated by the other user. One solution for this situation is to mark the checked out content as “read-only”, and configure the editorial tool to block the content from changes. Then, when loading the content into Vasont, the read-only modules should be dropped to prevent any chance of overwriting another user's updates. This behavior can be accomplished with the following items: 1. Extract View: Populate an attribute in the extracted XML that defines the content as read-only when it is checked out to another user in Vasont. See check_out_user processing option. 2. Editorial Tool: Configure the editorial tool to react to the attribute and value “read-only” so that any attempts to alter the content found with the marked component are blocked. Also consider a styling alteration that grays out or places a background color on content that is locked. 3. Load View: During the load process, evaluate the attribute with the read-only setting and bypass the loading of the content. See load_other_collection_attr_restrict or prevent_load_by_attribute. Configuring Read-Only Modules Here is an example of how to configure read-only modules using a DITA configuration. When a user extracts a Map and a referenced topic is checked out by another user, the topic should contain a props attribute set to “Read-Only”. 1. First, determine where the alterations need to be made. The Map extract view has the ref_extract_file processing option applied to a ConceptRef. The version argument specifies that the Extract Concept - Editorial extract view be used when extracting the referenced Con-300 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide cept. No change needs to be made to the Map extract view, but the Concept extract view will need to be updated with the read-only settings.2. In the Extract Concept - Editorial extract view, apply the props attribute, if not already present. Apply the check_out_user processing option to the props attribute. The value argument should be set to “Read-Only.”Most configurations have the attributes placed on the alias. If you need to apply a processing op- 2 tion, the attribute must be placed on the view component. When an attribute exists on both the alias and the view component, the attribute on the view component overrides the alias attribute.In this example, we chose the props attribute to store the read only setting, but another attribute can be used, providing it is compatible with your editorial and publishing tools.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 301 Setup Options3. Make alterations to your VUI setup to honor the props="ReadOnly" attribute. CAUTION: This process should be performed by the Vasont system administrator. Open the file with a plain text editor (i.e., Notepad). Do not double-click on the file to open it, and do not use a word processing program (i.e., MS Word), or WordPad.• Depending on your editorial tool and VUI, locate and open the configuration file:XMetaL: Open the Vasont_UI.mcr file in \Program Files\XMetal (version #)\Author\Startup\ or \Program Files (x86)\XMetal (version #)\Author\Startup\ folder.Arbortext Editor: Open the vasont_initialize.vbs file in \Program Files\Arbortext\Editor\Custom\Scripts\ or \Program Files (x86)\Arbortext\Editor\Custom\Scripts\ folder. If you can't find it there, check in the \Pro- gram Files\PTC\ArbortextEditor\Custom\Scripts\.Oxygen XML Author: Open the config.properties file in \Program Files\Oxygen XML Author (version #)\plugins\ or \Program Files (x86)\Oxygen XML Author (version #)\plugins\ folder.• Find the line that states:XMetaL: “set the variables to make elements with the attribute and value readonly”Arbortext Editor: “Set up for read_only processing”Oxygen XML Author: “Read Only variables below”Just below this line are two lines you will edit:'g_sReadOnlyAttribute = "" 'g_sReadOnlyValue = ""Delete the single quote at the beginning of each of these lines.Inside of the double quotes, fill in the appropriate values for the attribute that will be used and the value that will make the component and its descendants read-only. g_sReadOnlyAttribute = "props" g_sReadOnlyValue = "ReadOnly"• Save and close the file.4. Adjust the load view so that read-only modules will be bypassed in the load process.In a DITA configuration, the modular topics are loaded from separate files that are referenced by the Map, therefore, in this example, the prevent_load_by_attribute processing option is applied to the Concept load view.302 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideIn other XML or SGML configurations, apply load_other_collection_attr_restrict to the pointer component in the Manual or Book.Loading Changed Modular ContentIn modular content configurations, it is possible that a user may extract content that contains references to other content modules. While performing updates, the user may only update a few components, while other modular content may remain untouched. By default, when loading the content to the database, all content will be loaded and evaluated for changes.To improve performance and speed of modular content loading, modular content can be marked with an attribute and value of “unchanged” as it is extracted from Vasont. The editorial tool can be configured so that when content inside of a module is altered, its ancestor component with the attribute value of “unchanged” can be switched to “changed”. While loading the updated content to the database, modules can be evaluated for the unchanged/changed attribute value. If the value is "unchanged", the load process will bypass the module, therefore saving time in the load process. Only modules marked as changed will be loaded.“”This behavior can be accomplished with the following items:1. Extract View: Populate an attribute in the extracted XML that defines the content as unchanged. See ex- tract_value processing option.2. Editorial Tool: Configure the editorial tool to be aware of the attribute and switch it to “changed” when a descendant component is altered.3. Load View: During the load process, evaluate the attribute with the unchanged or changed setting and bypass the loading of the content marked “unchanged”. See load_other_collection_attr_restrict or pre- vent_load_by_attribute.The way it works in the Vasont Universal Integrator and XML editor: When you make an alteration to a component in the XML editor, the VUI will look at ancestor components to locate the specified attribute with the value specified for changing. When found, the attribute value will be changed to the value that states the content has been updated. This process is effective for embedded modular content. For DITA content, you will want to set an attribute on the top-level component (i.e., concept, reference, task).VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 303 Setup OptionsIn a DITA configuration an attribute on the top-level component should be stamped with the value that indicates that the content has changed. Since DITA uses the same attributes on many components 2 throughout the structure, it is advisable to use an attribute and value that will not be found on lower- level components. For example, if you are going to use status attribute and the value unchanged, there is a risk that status=unchanged will be found in multiple locations of the file, and therefore result in a failure in the automated process of resetting the status attribute on the top-level component. Instead a lower-level component could have its status attribute set to “changed”. To avoid this issue, consider using another attribute, such as props, and setting the default value to “NoChange” and the altered value to “Changed”.The way it works in the Vasont WebLNX editor: An attribute is set on the top-level component with a specified value. It will either update the existing value or add the attribute and value if it is not already present. Configuring Change Monitoring of Modules Here is an example of how to configure a DITA configuration so that when a Map and its topics are edited, the referenced topics with changes will be loaded and the referenced topics without changes will be bypassed. 1. First, determine where the alterations need to be made. The Map extract view has the ref_extract_file processing option applied to a ConceptRef. The version argument specifies that the Extract Concept - Editorial extract view be used when extracting the referenced Con- cept. No change needs to be made to the Map extract view, but the Concept extract view will need to be updated with the read-only settings.304 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide2. In the Extract Concept - Editorial extract view, apply the status attribute, if not already present. Apply the extract_value processing option to the status attribute. The text argument should be set to “value=unchanged.”Most configurations have the attributes placed on the alias. If you need to apply a processing op- 2 tion, the attribute must be placed on the view component. When an attribute exists on both the alias and the view component, the attribute on the view component overrides the alias attribute. In this example, we chose the status attribute to store the read only setting, but another attribute can be used, providing it is compatible with your editorial and publishing tools.3. Make alterations to your VUI setup to honor the status="unchanged" attribute. CAUTION: This process should be performed by the Vasont system administrator. Open the file with a plain text editor (i.e., Notepad). Do not double-click on the file to open it, and do not use a word processing program (i.e., MS Word), or Word- Pad. • Depending on your editorial tool and VUI, locate and open the configuration file: XMetaL: Open the Vasont_UI.mcr file in \Program Files\XMetal (version #)\Author\Startup\ or \Program Files (x86)\XMetal (version #)\Author\Startup\ folder. Arbortext Editor: Open the vasont_change_marking_handler.vbs file in \Program Files\Arbortext\Edi- tor\Custom\Scripts\ or \Program Files (x86)\Arbortext\Editor\Custom\Scripts\ folder. If you can't find it there, check in the \Program Files\PTC\ArbortextEditor\Custom\Scripts\. Oxygen XML Author: Open the config.properties file in \Program Files\Oxygen XML Author (version #)\plugins\ or \Program Files (x86)\Oxygen XML Author (version #)\plugins\ folder. • Find the line that states: XMetaL: “set the variables to track changes and update the changed attribute” Arbortext Editor: This file is very small, so there is no marker for the section. Oxygen XML Author: “Changed attribute variables below” Just below this line are two lines you will edit: 'g_sChangeTrackAttribute = "" 'g_sChangedValue = "" 'g_sUnChangedValue = "" Delete the single quote at the beginning of each of these lines. Inside of the double quotes, fill in the appropriate values for the attribute that will be used and the value that will make the component and its descendants read-only. g_sChangeTrackAttribute = "status"VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 305 Setup Options g_sChangedValue = "changed" g_sUnChangedValue = "unchanged" • Save and close the file. 4. Adjust the load view so that read-only modules will be bypassed in the load process. In a DITA configuration, the modular topics are loaded from separate files that are referenced by the Map, therefore, in this example, the prevent_load_by_attribute processing option is applied to the Concept load view.In other XML or SGML configurations, you would apply load_other_collection_attr_restrict to the pointer component in the Manual or Book.Auto-Publishing Vasont's Auto-Publishing functionality allows content to be automatically extracted and published, using configuration features, workflow, and external programs. Using Vasont's automatic publishing functionality, you can have hands-free publishing. There's no need for publishers or project managers to spend time performing manual tasks. Workflow triggers the process, and Vasont's external programs handle the rest. For more information on how Auto-Publishing works, see the Auto-Publishing chapter in the Vasont User Guide or the Vasont Help file. The following information will help you configure this feature for your system, as well as understand the necessary items that make the feature work. A Project Organizer collection is used to drive the process. References to the publishable content are located in the Project Organizer collection, as well as output information for publishing.306 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuidePre-built templates can be used for creating new Output components in your Project Organizer. These templates are stored in the Output Templates collection. This collection is not essential to the Auto-Publishing process, but is for the convenience of creating new publishing entries. You can choose to store your published documents in the Publications collection. This option allows you to have all published documents automatically stored in Vasont and available for querying tools (i.e., WebQuery Access, Vas- ont WebLNX, or directly querying in Vasont).Your system may have been delivered with these collections in place. If so, you will need to confirm 2 that the items documented in this section are in place. If the collections do not exist in your system, contact your Vasont support leader.The following screenshot gives you an overview of the collections and components utilized in the Auto-Publishing configuration.A workflow project that is applied to the Subproject in the Project Organizer can automate the triggering of the publishing process. This is done by automatically setting a specified attribute with a value that indicates that the content is ready for publishing. This will happen on a completion of a workflow task. If you do not use workflow, then a user can manually update the attribute when the content is ready for publishing. The following sections will guide you through configuring the essential pieces of Auto-Publishing: • Configuring the Project Organizer Collection for Auto-Publishing • Configuring the Auto-Publishing Output Templates Collection • Configuring the Auto-Publishing Publications Collection • Configuring Auto-Publishing Extract Views • Configuring Auto-Publishing Workflow • Assigning Privileges for Auto-Publishing • Auto-Publishing Extract and Load Programs Configuring the Project Organizer Collection for Auto- Publishing Create a new collection for the Project Organizer. If one already exists in your system, then follow the instructions below to verify that it contains the essential items.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 307 Setup OptionsOn the Update Collection window the Types tab should have the following entries: Automated Publication Configu- ration, Automated Publication Extract, and Automated Publication Load.The edit view should have a structure similar to that shown in the following screenshot. The highlighted components are needed for the Auto-Publishing process.The Content Ref component is a pointer. It should be configured to reference the content that will be published (i.e., BookMap, Map, Manual, Book, etc.). The Output Ref component is a pointer. It should be configured to reference the stored published document (i.e., Document in the Publications collection). The Output component is a text component with the following attributes: • auto-publish: This is a CDATA attribute with valid values of “yes” and “no”. The default value is “no”. • auto-publish-status: This is a CDATA attribute that has valid values of “(none)”, “start”, “pending”, and “complete”. The default value is “(none)”. • publish-type: This is a PUBLISH_TYPE attribute with a default value of “[define]”. This is a special attribute type that will point to Publication Types that have been defined in your system. See Creating New Attributes. • store: This is a CDATA attribute with valid values of “yes” and “no”. The default value is “yes”. • PublishConditionSet: This is a SAVED_CONDITIONS attribute. This is a special attribute type that will point to Saved Extract Conditions that have been defined and “shared” in your system. See Creating New Attributes. The Metadata component is a text component that has the attributes that you would like to exist on the stored published documents (i.e., product, audience, locales, revision, etc.).If you plan to use Output Templates and create a collection to store them, then you may want to apply 2 these attributes to the Output and Metadata aliases. Doing this will apply and manage the attributes in one place, rather than having to apply them to multiple occurrences of the Output and Metadata components.308 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideContact your Vasont support leader when you have completed the Project Organizer collection configuration and ask for the create_default_pub_config.sql script. This script will place information into a special database table about your Project Organizer collection. The script will be customized for your system prior to delivery. You will be asked to provide the following items. • Collection ID and name.• Rule Relation IDs for the Subproject, Content Ref, Deliverables, Output, Metadata, and Output Ref components.• Attribute IDs for PublishConditionSet, publish-type, auto-publish-status, store, and auto-publish.The script will be prepared with this information and sent to you. Run the script on your database as part of the Auto-Publishing setup. Configuring the Auto-Publishing Output Templates Collection The Output Templates collection mimics the component structure for the Output component in the Project Organizer collection.There are no load or extract views needed for this collection. It is strictly used for quickly creating new Output components in the Project Organizer.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 309 Setup OptionsOnce the Output Template collection is created, then apply the clone_primary_to_component processing option to the Deliverables component in the Project Organizer collection. The clone_to_component argument is set to Output [Deliverables] and the template_collection argument is set to Output Templates.Configuring the Auto-Publishing Publications CollectionCreate a new collection for the Publications. If one already exists in your system, then use the following instructions to verify that it contains the essential items.On the Collection Update window the Types tab should have the following entries: Automated Publication Load and Queryable.The edit view should have a Document multimedia primary component. Apply the attributes that were applied to the Metadata component in the Output Templates and Project Organizer collections.Apply the mm_desc_mm_filename and client_key_from_mm_desc processing options. These processing options will assign client key values and give the file a name when it is opened for viewing.310 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideA load view is needed for this collection. The blob_load_primary_mm_component processing option is applied to the view header. The component argument is set to [Document].The load view contains a Document component. The same attributes that were applied to the edit view component should be applied here as well.Configuring Auto-Publishing Extract Views The extract view that is utilized by the Publication Type will need the external_app_call processing option applied to the view header. The example shown in the following screenshot shows the typical argument settings for use with the DITA-OT (Open Toolkit). In this example the external_app argument specifies a DOS-batch file that contains the instructions for executing the publishing tools.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 311 Setup OptionsConfiguring Auto-Publishing WorkflowThe Workflow Project is attached to the Subproject component. This allows you to create multiple Output components with varying values and instructions for publishing formats (i.e., PDF, HTMLHelp, WebHelp, etc.).The tasks in the workflow can be configured as needed for your business process. One task within the workflow should determine when the content is ready for publishing and will automatically set an attribute with a value that will be ready by the Auto-Publishing Extract program when it is completed. To automatically set the attribute, apply the set_descendant_attribute processing option.Assigning Privileges for Auto-PublishingThere are two advanced privileges required for users who manage key pieces of the Auto-Publishing setup: Publica- tions Types and Saved Condition Sets. For more information, see Auto-Publishing and Filtering Extracted Content in the Vasont User Guide.Publication Type Update: This advanced privilege is assigned to users who will be creating and updating Publica- tion Types in Vasont. The user will see the Add Publication Type and View/Modify Publication Type menu options enabled on the publish-type attribute window. Users without this permission will only be able to view publication types. In addition, when accessing the Manage Publications Type window (found on the Tools menu), only users with this permission will be able to create new entries or make alterations or deletions to existing entries.Share Saved Condition Sets: This advanced privilege is assigned to users who will be creating, updating, and sharing Condition Sets in the Setup Extract Conditions window. This permission will enable the Save for all users button. Users without this privilege will have the option disabled.312 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideAuto-Publishing Extract and Load Programs Programs for automating the extract and load process are available from Vasont Systems. These programs are executed from a task scheduler to allow for configurable scheduled intervals. Contact your Vasont Project Leader to obtain the Auto-Publishing Extract and Load program installer and instructions for implementation.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 313 Setup Options314 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide Advanced System UtilitiesUnderstanding the System Level Menu ItemsSelect Utilities → System Level on Vasont Administrator's main toolbar to view the System Level menu items.These are advanced functions that can only be accessed by the Vasont development team at Vasont Systems. Ac- cessing and updating is controlled via a password. The development team can extend these capabilities, if necessary. For informational purposes only, following are general descriptions and/or graphic examples for the items on the System Level drop-down menu. ArgumentsThe Arguments window contains a list of available argument names, including their description, type, and identification number (ID). The list allows for monitoring, tracking, and identifying existing arguments, thereby precluding the need to create new arguments each time new processing options are created, or their use is expanded. The data can be re-sorted by clicking on the column headings. Also, using the scroll bar, or moving the column separators right or left allows you to view all of the data, as needed.Processing OptionsThe Processing Options window contains a list of available processing options. Option name, description, event, Vasont Administrator update window, element, repeat flag, and ID information is also provided. The data can be re- sorted by clicking on the applicable column heading. Also, using the scroll bar, or moving the column separators right or left allows you to view all of the data, as needed.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 315 Advanced System UtilitiesData Types The Data Types window contains a list of datatypes that can exist within the applications. Edit mask and ID information is also provided. The data can be re-sorted by clicking on the applicable column heading. Also, using the scroll bar, or moving the column separators right or left allows you to view all of the data, as needed. General Access Types The General Access Types window contains a list of general type access capabilities that provide admittance to various Vasont or Vasont Administrator functions (example: raw material update/view, clone collection, reassign tasks, etc.). Description and ID information is also provided. The data can be re-sorted by clicking on the applicable column heading. Also, using the scroll bar, or moving the column separators right or left allows you to view all of the data, as needed. Globals The Globals window contains a list of global settings and their values unique to a user site. Occurrences The Occurrences window contains a list of occurrences that indicate the number of times an element may (or must) occur within its parent. Description, occurrence, and ID information is provided. The data can be re-sorted by clicking on the column headings. Also, using the scroll bar, or moving the column separators right or left allows you to view all of the data. Collection Access Types The Collection Access Types window contains a list of the type of access capabilities that provide gateways to various Vasont functions, example: add/approve/edit components, perform composite extract or load, update, etc. De- scription and ID information is provided. The data can be re-sorted by clicking on the column headings. Also, using the scroll bar, or moving the column separators right or left allows you to view all of the data. Raw Classes The Raw Classes window contains a list of available raw class type data (one of which must be applied when defining a raw component). Description, source table, and ID information for each raw class is also provided. The data can be re-sorted by clicking on the column headings. Also, using the scroll bar, or moving the column separators right or left allows you to view all of the data. SGML Types The SGML Types window contains a list of SGML types used to verify the validity of an attribute value being entered into a document. Description, maximum length, and ID information is provided. The data can be re-sorted by clicking on the column headings. Also, moving the column separators right or left, or using the scroll bar allows you to view all of the data. XSLT Select Utilities → System Level → XSLT to display the XSLT Modules window. This window provides information about the XSLT processor and stylesheet that are being used for Vasont Administrator functions, such as, the Read DTD, Read Schema, and the Vasont Import/Export utilities. Note: Vasont users cannot update this table, however if changes need to be made, instructions can be given to a database administrator, if one is available at the site. Processing Options SQL Generation This is a utility used to generate processing option SQL. This utility is password protected and only meant to be used by the staff of Vasont Systems.316 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide LDAP AuthenticationIf you utilize Vasont's LDAP Authentication feature, you will need to generate Vasont certificates as part of the set up. LDAP Authentication is an optional Vasont feature. With LDAP support, Vasont can be more easily integrated into large corporate environments where user account management is centralized. This will eliminate duplicate user maintenance efforts on the part of System Administrators, and will also ensure that Vasont users are not encumbered with having to remember multiple passwords (e.g., their network password and a different Vasont password) for their daily tasks. Vasont certificate files are a key security feature of LDAP authentication. Peform the following steps to generate a Vasont certificate file. 1. Select Utilities → Generate Profile Certificate. 2. Enter the Schema Owner name. 3. Enter the Password. 2 The LDAP server entry fields allow up to 256 characters for naming a server. 4. Enter the First LDAP Server.To generate a certificate that allows an anonymouse LDAP connection, skip the next two steps. 2 To ensure a secure connection a LDAP User Name and Password must be entered. 5. Enter the LDAP User Name. 6. Enter the LDAP Password.All existing certificates must be removed before generating new certificates. Certificates are 2 placed in C:\Vasont\Certificates\*.vcrt. 7. Click the Generate Certificate button.8. The final step for configuring LDAP is modifying the VasontApps.ini file located in C:\Windows\Vaso- ntApps.ini. The following lines must be added to the Vasont INI file.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 317 LDAP Authentication• AuthenticationMode=LDAP • LDAPSearchBase=Search Base • LDAPUsernameAttribute=Name For more information, see Vasont LDAP Authentication Configuration.pdf, which is included as part of the Vasont installer.318 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide Configuring Vasont E-mailOracle Requirements: When a user submits an e-mail using the Vasont application, it is transmitted to the appropriate recipient via the Oracle SMTP package. Consequently, Oracle must have the utl_smtp package installed. This package is installed by default during a typical Oracle installation. Contact your Oracle DBA to verify this package is installed. Vasont Setup: The Vasont Administrator setup is accomplished by using the System Profiles update function. This update process can be accessed from the Vasont Administrator's main toolbar by clicking Utilities → Support Ta- bles → System Profiles menu. For more information, see System Profiles. An update window displays with several profile types. The SMTP_SERVER value box represents the mail server to be used. Enter the appropriate server name. This would typically be your company's internal mail server.Depending on your email domain, you may need to adjust Vasont's validation process. By default, Vasont uses a strict email address validation, but if necessary, a system profile allows you to switch to a less restrictive validation. See Email_Vasont_Shortcut in System Profiles, for more information. When updating is complete, click Save and Close on the main toolbar to save the changes and exit the update window. Mail Server Configuration: It may be necessary to make adjustments to your company's e-mail server. Your mail server must be able to accept SMTP mail requests that are forwarded from the Oracle server.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 319 Configuring Vasont E-mail320 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide Technical Requirements for the Vasont CMSRequirementsDatabase: Oracle version 9i or higherDatabase Server Platforms: 40+ Major Unix Platforms or Windows Server PlatformsClient Platforms: Windows XP or higherHardware RecommendationThe following are typical hardware specifications for average use of the Vasont CMS. Faster hardware may be suitable for your application depending on your specific needs and environment (i.e., number of users, volume of content, transaction size, network speed, and anticipated growth).Client PC Server CPU: 1.0 GHz or higher Dual 2.0 GHz processor or higher RAM: 512 MB or higher 2 GB or higher Disk: 200 MB free space or higher 40 GB minimum utilizing RAID 1 technology Network: 100/1000 Mbps 100/1000 MbpsOptions• Citrix MetaFrame for Windows• XML/SGML Editors:• JustSystems XMetal• Synchro Soft oXygen• Adobe FrameMaker• PTC Arbortext Editor• XML/SGML Parsing Software• User Selected Helper ApplicationsVAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 321 Technical Requirements for the Vasont CMS322 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide GlossaryActive Content The content that you see in the Vasont navigator. In the versions window, the active content is represented as the [Current] version. Aliases Additional names that are assigned to a raw component. For instance, Author and Screenwriter could be aliases for a raw component named Writer. Aliases promote content reuse since the content is stored once regardless of which alias is used. Analyze A right-click option that may be performed on a component in Vasont. The component is validated against the rules that have been established in the Vasont Administrator for this type of component. Annotation Textual information and/or multimedia attachments associated with any collection-level component. Approved Status Components that are considered ready for publishing or in a final form. Argument In the Vasont Administrator, Processing Options have arguments. Arguments allow values to be passed to the programming code to make the processing option behave as desired. Arguments are also used in the Vasont API Functions. Associate Administrator This is a privilege that the super administrator assigns to another Vasont Admin- istrator user. It allows the user to oversee and make changes to specific collections in the Vasont Administrator. Attributes An additional piece of information for a component. This includes attributes from a DTD, but can also be metadata attributes that are strictly used by Vasont for special behaviors. Batch Update A utility that allows an operation to be run against to many different components in one pass. For example, adding a language attribute to Section, Title and Para- graph. Another example is using batch load or extract. BLOB A data format called Binary Large Object. All Vasont multimedia components are stored in Vasonts BLOBs. Bookmarks A shortcut to find information. A right-click option in Vasont navigator that allows a user to mark the location of a component for future reference. Branch A copy of modular content that maintains a link to the source from which it was created. Branch Label A label that is assigned to a Branch when it is created. It identifies the Branch when viewed in the collection navigator or the Details pane. Branch Notice An icon that is placed on a pointer component that points to a primary that is copied for a Branch. It signifies that the original pointee is the source of a new Branch, and that the owner of the pointer may want to review the content and determine the Branch that they would like their pointer to reference. Branch Notification A special Notification that is sent when content that is owned by the user contains a pointer to content that is involved in a Branch. Check In A right-click option in the Vasont navigator that allows a user to unlock content that they have had checked out.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 323 GlossaryCheck Out A right-click option in Vasont navigator that allows a user to lock down content that they are currently editing or modifying. No other user can update the content in the database when it is checked out. Client Key Vasont's external user defined identifier for a component. Clone A copy of content or structure. Collaborative Review A Vasont extension program that allows content to be critiqued through the use of comments left by Reviewers. An Editor accepts or rejects the Reviewers comments and marks up the content as necessary. When the editorial phase is completed the database is updated with the accepted changes. Collection A group of similar content that shares the same content model. Collection Access Collections that are available to a user. Collection Groups A named grouping of one or more collections. Comment Meaningful notes or text that can be added to an active workflow task or to a component's version. These notes help to define instructions or information about the task or version that they are placed on. Component An instance of content in a content model such as a paragraph in a manual. Composite Extracts/Loads A right-click option in the Vasont navigator that allows for the extraction or loading of content into or from XML or SGML files on a file system. Content Model A DTD, Schema, or well formed hierarchy of content that defines how content components are structured and their rules of behavior. Content Navigator The window in the Vasont Administrator that is used to navigate, view, create, and update collections content models for Vasont. Content Owner A user or group of users who have been assigned exclusive permission to a primary component in a collection. This ownership restricts other users from making any alterations to the component and its descendants. Content Types A set of related Vasont collections that share the same raw components, attributes and wrappers. Create New A right-click option in the Vasont navigator that allows a user to add new components to the database. Draft Status Components that have a yellow pencil icon. These components have been altered after being approved. Dynamic Indexes Index collections that are maintained dynamically with an associated component(s) in another collection. For example, a Book collection may contain the names of several Authors. An Index collection may be created from the Book collection of the Authors and the Books where they appear. Edit View The definition for creation, display, processing, and manipulation of content or entities within the Vasont Administrator Program. Editor A user who is assigned the responsibility of accepting or rejecting Reviewers' suggestions and comments and finalizing the edits in the Vasont Collaborative Review. Events Intervals in the programming code that allow for the insertion of Vasont processing options. Vasont has over 60 defined events such as Post Load, Pre Ex- tract, Post Approval etc. Extract View The rules for preparing and processing the content to an extracted SGML or XML file. This is done in the Vasont Administrator.324 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideGlobal Change Vasont's ability to identify all instances where a component is used, and if needed, change the content for all uses, some uses, or no uses when an update occurs. Implicit reuse facilitates global change. Granularity The level at which data is stored in Vasont. A very detailed configuration will store and track a large number of the elements from the DTD, where a less detailed configuration would store data in larger chunks and track fewer components. Graphic Workflow A graphical representation of a workflow project. It may also be used to create a new workflow or to add a task to an existing workflow project. It displays rec- tangles with descriptive text for each workflow task, and arrows to indicate the flow. Helper Applications Applications that are used to view and update multimedia data that is stored in Vasont. For example, Acrobat Reader, Microsoft Word, etc. Incomplete Status A component that is flagged with a red exclamation icon. This means that the content does not meet the requirements as defined in the collection setup in Vas- ont Administrator. Inline An Inline component occurs inside a component that is allowed to contain text, as well as children components. An example is a graphic inside a paragraph. The graphic is inline. Load View The defined structure and special processing that is expected when loading content into a Vasont collection. Defined in the Vasont Administrator. Match Criteria The method that Vasont uses to determine whether a component being loaded, is new or changed. Methods include text, Client Key, or both. Modular Content Content that is separated into meaningful chunks and stored in separate collections in Vasont. For example, sections may be stored separately from the chapters. Pointer components in the chapters reference the sections. When the chapter is extracted to an XML file, the sections are pulled and positioned in the chapter XML as indicated. This concept allows for reuse of the sections in multiple chapters or documents. Multimedia Component A component that stores data that is in a special format, see BLOB. For example, EPS, PDF, Microsoft Word, etc. Navigator A window that allows the browsing of stored content in a collection using hierarchical tree views. Navigator Order The order in which Vasont expects to see the components. Usually based on the DTD's content model. For example, <!ELEMENT book (frontmatter, chapter*, backmatter)>. The children of Book would be ordered as 1. Frontmatter, 2. Chapter, and 3. Backmatter. Notification A location on the Home Page where the logged in user can quickly see information about content to which they have subscribed. For example, changes to content where Variant relationships have been created, and events related to workflow project or tasks. Open Update A right-click option in Vasont navigator that allows editing of the content. Open View A right-click option in Vasont navigator that allows the viewing of content without the ability to edit or modify. Pointee Component The destination component referenced by the Pointer Component. Pointer Component Components that reference, or link, to other components in Vasont. Pointers provide explicit reuse.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 325 GlossaryPreview A tab in the Vasont Navigator's Details Pane which shows a styled view of the selected primary component. This view makes it easier to read and evaluate the content in Vasont. Annotations can be created and displayed from this window. Previous Versions See Versions Primary Component The top-level component in a Vasont collection definition. A typical collection will have many primaries. Just as a butterfly collection would contain many but- terflies. Privileges The specific functions that a User is allowed to perform in a collection, such as add, delete etc. Processing Option Reusable programming code that is used to customize client business logic in Vasont. Vasont has over 600 pre-built reusable processing options that can be applied to various events in the Vasont environment. Project An organized assemblage of tasks that define a workflow process. Project Management A window that allows you to view the overall status of your workflow projects. View multiple projects at one time; view projects for specific users; view projects due within a range of dates; view projects for specific collections. A Gantt chart provides a visual display of the progress of the projects. Raw Class Raw components are broken into three classes, text, pointer or multimedia. Each class has a unique feature that allows the component to behave in a specific manner in the system. Each component in a collection is one of the three classes. Raw Components The basic building block of a Vasont collection. Raw components may be compared to elements in a DTD. They are defined in the content type and can be used to build multiple collections. Raw Material Available components that may be utilized in the construction of one or more collections. Referenced By A right-click option in Vasont navigator that lists other components that may be linked to the current component by a pointer component. Components that are referenced more than once are being reused. Refine A Refine query is used after a Vasont Navigator is populated with a Retrieve query. The Refine query further reduces the number of primary components in the navigator by using additional query criteria. The criteria can be applied to the same collection or a related collection. Reinstate The process of taking a previous version of the content and reactivating it as active content. This can be done by overwriting or creating as a new primary. Reports The presentation of the details of a collection, project, etc. Retrieve Retrieves allow limitations on the number of primary components that are displayed in the navigator when retrieving a collection. Review See Collaborative Review. Review Coordinator A user who initiates the Collaborative Review in Vasont. This user selects the Reviewers, Editor and due dates for the session. Reviewer A special Vasont user who critiques the content in a Collaborative Review. Comments and suggestions to the content are applied in an XML editor. Follow- ing the Reviewers' session, an Editor will accept or reject the Reviewers' suggestions and the content is updated in the database. Role A specific type of user, based on the functions they perform. For example, Writ- er, Editor, etc.326 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideRule Relation The relationship between a component and it's parent. For example, when a PARAGRAPH occurs in a CHAPTER the rule relation would be Para- graph[Chapter] in Vasont. Search Search is used to locate specific items that meet the defined criteria within a Vasont Navigator window for collection content. Stranded Components Components that may have been corrected and need special processing to be cancelled. Structured data Electronic data containing tags or markers for the individual pieces of content. Some examples of structured data is SGML and XML. Since the data contains tags for the individual elements, the document can be consistently composed, searched, or broken into subdocuments. The tags may also contain attributes that provide metadata about the content. Style The assembly of a cascading style sheet (CSS), conversion map, and load/ extract view to produce a styled preview of content in the Vasont Details Pane. Sub-component Any component that is at a lower level than the primary. Super Administrator This is a privilege that is assigned to the schema owner and other users with the authority to oversee the entire configuration. The privilege allows the user full rights and access to all collections and features in the Vasont Administrator. The super administrator decides who the associate administrators will be and assigns them the appropriate privileges to the collections that they will oversee. Tasks A defined Workflow step in a project. Text Argument An argument and a value that is keyed directly into the processing option window, unlike processing options that have the right-click option of Update Argu- ment. Text Component The most common raw class. Text components store data, or wrap other components. For example, Paragraph or Body. Tools See Utilities. Translation Project Window A Vasont extension that allows you to track due dates, vendors, and status information for each language subproject. Content can be submitted for quote or translation directly from this window. Translation reuse is also tracked from this window. Unstructured data Electronic data without meaningful tags or markers for the individual pieces of text. Some examples of unstructured data would be Microsoft Word or Excel files, and PDFs. User A user is an assigned login and password for an individual to gain access to the system. User Navigator The window in the Vasont Administrator that controls the rights and privileges for users in Vasont. Utilities Programs that provide system tasks or functions in an automatic work saving fashion. Valid Values One or more values that are acceptable for a component or attribute. Define in the Vasont Administrator Variants Relationships that are maintained in Vasont between two or more separate content instances. Vasont Administrator The setup software tool for Vasont. Version History The historical data related to a collection.VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 327 GlossaryVersion On Demand The process of creating a version for the selected content at a point in time that a user sees a need for saving. Versions A capture of the data as it existed on a specific date and time. View A View in the Vasont Administrator describes the structure and special functionality of a collection. There are three types of views, Edit, Load, and Extract. View Headers Load and extract views contain Headers. This is where specific pieces of information are placed that affect the over-all load or extract file in the Vasont Ad- ministrator. Where Used In the Vasont Administrator, a listing of all of the locations in which a processing option, raw component, attribute, or wrapper may occur for a specific collection or a content type. In Vasont, a list showing where the exact same content is used in multiple places. Workflow Workflow allows users to track the progression of the work performances. Workgroup A Workgroup is a specific group of users that can perform various tasks in workflow. Working Collection The collection that a user is automatically logged into in Vasont because it is set as default collection. Wrappers Wrappers link SGML/XML tagged data to components. By having wrappers, Vasont can store a tag once and reuse it thousands of times.328 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide batch updating, 122, 129 A where used, 129 Accepting Setup Data, 37 control sets, 238 Actions, 49 creating, 17, 24 Activating, 238 alias attributes, 24 notification events, 238 aliases, 17 Active Content, 323 publish_type, 24 Adding, 11, 26, 47, 65, 75, 227, 228, 241, 248 raw attributes, 24 collections, 26 saved_conditions, 24 content types, 11 deleting, 89, 91, 135 edit view components, 47 alias attributes, 91 editor tags, 227 disabling, 238 extensions, 228 preview, 187 extract views, 65, 75 conditions, 187 load views, 65, 75 reporting, 201, 205, 206, 219 projects, 241 edit view, 201 tasks, 248 edit view comparison, 219 Admin Rights Tab, 149 extract view comparison, 219 Advanced Tab, 59, 126, 144 extract/load view, 205 batch updating, 126 load view comparison, 219 role grants, 144 processing options - extract/load views, 206 updating, 59 tasks, 250 Aliases, 1, 16, 17, 19, 20, 22, 24, 91, 99, 197, 323 updating, 50, 78, 87, 88 attributes, 17, 19, 24, 91, 197 alias attributes, 88 batch updating, 19 edit view components, 50 copying, 19 using across content types, 24 creating, 17 valid values, 17, 50 creating with drag and drop, 19 aliases, 17 deleting, 91 edit view components, 50 reports, 197 Auto-Publishing, 306, 307, 309, 310, 311, 312, 313 creating, 16 configuring, 307, 309, 310, 311, 312 deleting, 99 extract views, 311 updating, 99 output templates collection, 309 valid values, 20, 22, 99 project organizer collection, 307 copying, 22 publications collection, 310 creating, 20 workflow, 312 Analyzing, 323 extract and load programs, 313 API, 5 privileges, 312 Applying, 61 preview styles, 61 B Approved Status, 323 Basic Reports, 197, 199, 205 Arguments, 323 edit views, 199 Assigning, 178 extract/load views, 205 preview style, 178 raw components, 197 Associate Administrators, 8, 149, 323 Basic Setup, 11, 87 Attributes, 1, 17, 24, 50, 78, 87, 88, 89, 91, 122, 129, creating, 11 134, 135, 187, 197, 201, 205, 206, 219, 238, 250, 323 refining, 87 aliases, 17, 197 Batch Action Updates, 124 creating, 17 Batch Copy, 112 reports, 197 Batch Deletes, 134, 135, 136 batch deleting, 134 attributes, 134, 135VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 329 where used, 134 load views, 72 components, 136 Collaborative Reviews, 253, 254, 255, 256, 257, 258, occurrences, 135 259, 324 pointer definition records, 136 configuring, 254, 255, 256, 257, 258, 259 where used, 136 document access, 258 processing options, 135 edit views, 257 where used, 135 extract views, 255 Batch Updates, 108, 110, 113, 114, 121, 122, 124, 125, load views, 256 126, 127, 128, 129, 130, 131, 132, 134, 323 privileges, 258 advanced items, 126 system profile, 254 attributes, 122, 129 user accounts, 254 batch copy components, 113 workflow, 259 general items, 128 processing options, 259 merge utility, 108, 110 workflows, 259 miscellaneous items, 127 Collection Modularization Utility, 287 occurrences, 125 Collections, 1, 5, 26, 27, 28, 45, 103, 104, 105, 106, pointer definition records, 124 118, 279, 324 processing options, 114, 130 accessing, 5, 324 broadcasting changes, 114 adding, 26 where used, 130 defined, 1 raw components, 131 deleting, 105, 118 where used, 131 data, 118 wrappers, 132 duplicating, 27 where used, 132 groups, 1, 103, 104, 324 BLOBs, 323 defined, 1 Bookmarks, 323 deleting, 104 Branch Notices, 54 updating, 103 Branching, 323 importing, 28 label, 323 locating, 104 notices, 323 refine settings, 106 notification, 323 storing unstructured documents, 279 Broadcasting, 114 types, 26 Build In Collection Flag, 119 updating settings, 105 Building, 45, 65 views, 45 collection views, 45 building, 45 edit views, 45 properties, 45 extract views, 65 Collections Tab, 139 load views, 65 role grants, 139 Comments, 324 C Compare Attributes Reports, 219 Cascading Style Sheets, 161, 168 Compare Components Reports, 217 Checking In, 323 Compare Processing Options Reports, 218 Checking Out, 324 Comparison Reports, 216 Client Key Exception Reports, 220 Component Validation Reports, 208 Client Keys, 220, 324 Components, 1, 47, 58, 62, 63, 65, 75, 76, 81, 82, 117, reporting, 220 136, 217, 324 edit view exceptions, 220 defined, 1 extract view exceptions, 220 deleting, 136 load view exceptions, 220 edit views, 47, 62, 63, 65 Clone, 324 adding, 47 Cloning, 46, 72 deleting, 65 edit views, 46 expanding, 63 extract views, 72 locating, 62 resequencing, 63330 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide updating, 47 alias attributes, 19 extract views, 75, 76, 81, 82 alias valid values, 22 adding, 75 components in views, 112 deleting, 81 Create New, 324 expanding, 82 Creating, 11, 12, 16, 17, 19, 20, 23, 24, 26, 45, 70, 72, locating, 82 74, 153, 155, 156, 157, 161, 165, 172, 175, 265, 272, updating, 76 273, 274, 275, 279, 281, 294 load views, 75, 76, 81, 82 alias attributes, 17 adding, 75 alias valid values, 20 deleting, 81 aliases, 16 expanding, 82 attributes, 24 locating, 82 basic setup, 11 updating, 76 collections, 26, 279 multimedia, 1 unstructured documents, 279 pointer, 1 content types, 11 purge stranded, 117 dragging and dropping alias attributes, 19 reporting, 217 dynamic indexes, 294 edit view comparison, 217 edit views, 45 extract view comparison, 217 extract views, 70, 72 load view comparison, 217 cloning, 72 text, 1 from scratch, 70 types, 1 load views, 70, 72, 74 valid values, 58 cloning, 72 edit view components, 58 from scratch, 70 Components Tab, 146 read DTD utility, 74 Composite Extracts/Loads, 324 map files, 165 Configuration, 5 modularized collections, 281 making alterations, 5 ownership groups, 157 Configuring, 254, 255, 256, 257, 258, 259, 319 preview extract views, 175 address validation, 319 previews, 161 collaborative reviews, 254, 255, 256, 257, 258, 259 raw components, 12 document access, 258 roles, 155 edit views, 257 styles, 172 extract views, 255 translations, 265, 272, 273, 274, 275 load views, 256 configuration, 265 privileges, 258 languages, 272 system profile, 254 translation memory, 273 user accounts, 254 vendor languages, 275 workflow, 259 vendors, 274 email, 319 vendors and languages, 272 Content, 323 users, 153 active, 323 workgroups, 156 Content Models, 324 wrappers, 23 Content Navigator, 5, 293, 324 Customizing, 277 dynamic indexing, 293 home page graphics, 277 Content Owners, 324 Vasont, 277 Content Reuse, 1 Content Types, 1, 11, 102, 103, 324 D adding, 11 Daemons, 313 defined, 1 programs, 313 deleting, 103 Data, 118, 327 updating, 103 deleting, 118 Controlled Vocabulary, 289 structured, 327 Copying, 19, 22, 112VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 331 unstructured, 327 Disclaimer, 5 Deleting, 20, 36, 65, 74, 81, 89, 91, 96, 99, 101, 103, making configuration alterations, 5 104, 105, 118, 120, 121, 122, 124, 125, 134, 155, 156, Doctype, 66 157, 158, 168, 171, 173, 180, 227, 229, 246, 251, 273, Document Type, 66 274, 275, 276, 296 Documentation, 5 alias attributes, 91 Documents, 258 alias valid values, 20, 99 viewing, 258 aliases, 99 Draft Status, 324 attributes, 89, 122 Dragging and Dropping, 74 batch, 134 extract views, 74 cascading style sheets, 171 load views, 74 collection data, 118 DTD Navigator, 32, 33, 36 collection groups, 104 components, 36 collection styles, 180 deleting, 36 collections, 105 deleting, 36 content types, 103 components, 36 data, 118 expanding, 36 DTD navigator components, 36 setting the primary, 32 dynamic indexes, 296 setup previewing, 32 edit view components, 65 updating, 33 editor tags, 227 components, 33 extensions, 229 DTD Reports, 208 extract view components, 81 DTDs, 31 extract views, 74 utility, 31 load view components, 81 Duplicating, 27, 246 load views, 74 collections, 27 map files, 168 projects, 246 occurrences, 125 Duration Flag, 241, 248 ownership groups, 158 Dynamic Indexes, 54, 202, 293, 294, 296, 324 pointer definition records, 124 content navigator, 293 projects, 121, 246 creating, 294 data, 121 deleting, 296 raw components, 96 edit view reports, 202 roles, 156 updating, 54 styles, 173 tasks, 251 E translations, 273, 274, 275, 276 Edit Views, 1, 45, 46, 47, 62, 63, 64, 65, 107, 108, 112, languages, 273 113, 198, 199, 200, 201, 202, 203, 217, 218, 219, 220, translation memory, 274 324 vendor languages, 276 attribute comparison report, 219 vendors, 275 attributes reports, 201 unused setup data, 118 basic reports, 199 users, 155 batch copy components, 113 versions, 120 building, 45, 65 workgroups, 157 cloning, 45 wrappers, 101 create from scratch, 45 Detail Report, 197, 200 Read DTD utility, 45 edit views, 200 client key exceptions, 220 raw components, 197 cloning, 46 Detailed Views, 83 component comparison report, 217 extract, 83 components, 47, 63, 65 load, 83 adding, 47 Disabling, 238 deleting, 65 notification events, 238332 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide expanding, 63 cloning, 72 resequencing, 63 component comparison report, 217 updating, 47 components, 81, 82 creating, 45 deleting, 81 defined, 1 expanding, 82 deleting, 65 locating, 82 components, 65 creating, 70, 74 detail reports, 200 drag and drop, 74 detailed navigator views, 64 from scratch, 70 dynamic indexes reports, 202 defined, 1 genealogy reports, 200 deleting, 74 global change reports, 201 exporting, 85 locating, 62 importing, 84 components, 62 merge utility, 110 merge utility, 108 previews, 175, 178 pointers reports, 202 assigning, 178 processing option comparison report, 218 creating, 175 processing options reports, 203 processing option comparison report, 218 reports, 198 referencing another view component model, 70 security reports, 203 updating, 74, 76 undefined pointers report, 202 components, 76 updating components, 47 views, 74 updating components with batch copy, 112 updating components with batch copy, 112 updating components with merge utility, 107 updating components with merge utility, 107 Editing, 167, 170, 173 Extract/Load Views, 204, 205, 206, 207, 296 cascading style sheets, 170 attributes reports, 205 map files, 167 basic reports, 205 styles, 173 fast extract, 296 Editor Tags, 227 processing options reports, 207 Editors, 324 reports, 204, 206 Electronic Signatures, 300 processing options - wrapper attributes, 206 Email, 158, 319 processing options - wrappers, 206 address validation, 319 translations reports, 207 configuring, 319 Encoding, 66 F Entities, 162, 165 Fast Extract, 296 preview, 162, 165 Filtering, 41 Estimated Iterations, 248 processing options, 41 Events, 324 Flow Diagrams, 243 Expanding, 36, 63, 82 DTD navigator components, 36 edit view components, 63 G extract view components, 82 Genealogy Reports, 200 load view components, 82 edit views, 200 Exporting, 85, 247 General Tab, 128 extract views, 85 batch updating, 128 load views, 85 Generate Profile Certificate, 317 projects, 247 Generated Text, 191 Extract Views, 1, 65, 70, 72, 74, 75, 76, 81, 82, 84, 85, preview, 191 107, 110, 112, 113, 175, 178, 217, 218, 219, 220, 324 Global Change, 52, 201, 325 adding, 65, 75 reports, 201 attribute comparison report, 219 edit views, 201 batch copy components, 113 updating, 52 client key exceptions, 220 Global Pointers, 54VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 333 Granularity, 325 referencing another view component model, 70 Graphic Workflows, 243, 325 updating, 74, 76 components, 76 H views, 74 Helper Applications, 228, 325 updating components with batch copy, 112 Home Page Graphics, 277 updating components with merge utility, 107 Loading, 166, 169, 303 I cascading style sheets, 169 map files, 166 Importing, 28, 84, 247 modular content, 303 collections, 28 changed/unchanged content, 303 extract views, 84 Locating, 62, 82, 208, 219, 220 load views, 84 attribute comparison, 219 workflow projects, 247 edit view components, 62 Incomplete Status, 325 extract view components, 82 Inline Components, 50, 325 load view components, 82 updating, 50 missing client key processing options, 220 K missing extract or load view components, 208 Key or Legend, 188 preview, 188 M Mail Server, 319 L Map Files, 161, 162, 165, 166, 167, 168 creating, 165 Languages, 12, 158, 235, 272 deleting, 168 adding, 235 editing, 167 deleting, 235 entities, 162, 165 updating, 235 loading, 166 user navigator, 158 processors, 165 Legend or Key, 188 understanding, 162 preview, 188 Match Criteria, 59, 325 Link Criteria, 54 Merging, 107, 119 Load Views, 1, 65, 70, 72, 74, 75, 76, 81, 82, 84, 85, components in views, 107 107, 110, 112, 113, 217, 218, 219, 220, 325 raw components, 119 adding, 65, 75 Metadata, 5, 223 attribute comparison report, 219 multimedia, 223 batch copy components, 113 types, 5, 223 building, 65 Misc Tab, 127 client key exceptions, 220 batch updating, 127 cloning, 72 Modular Content, 303, 325 component comparison report, 217 loading, 303 components, 81, 82 Modular Pointers, 54 deleting, 81 Modularized Collections, 281 expanding, 82 building, 281 locating, 82 Multimedia Components, 1, 223, 224, 258, 325 creating, 70, 74 defined, 1 drag and drop, 74 metadata, 223, 224 from scratch, 70 search, 224 read DTD utility, 74 viewing, 258 defined, 1 deleting, 74 exporting, 85 N importing, 84 Navigator, 5, 16, 325 merge utility, 110 content, 5 processing option comparison report, 218 names, 16334 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide order, 325 generated note text, 191 Next Task(s), 249 samples, 191 Notifications, 235, 238, 325 key or legend, 188 events, 235, 238 samples, 188 activating, 238 map files, 162, 165, 166, 167, 168 disabling, 238 creating, 165 deleting, 168 O editing, 167 loading, 166 Occurrences, 49, 125, 135 processors, 165 batch updating, 125 understanding, 162 deleting, 135 raw material translations, 182 updating, 49 samples, 182 Open Update, 325 reuse, 183 Open View, 325 samples, 183 Opening a Saved Data File, 37 samples, 182, 183, 186, 187, 188, 191 Oracle Text Stopwords, 291 conditions, 187 Ownership Groups, 157, 158, 214 generated note text, 191 creating, 157 key or legend, 188 deleting, 158 raw material translations, 182 reports, 214 reuse, 183 user navigator, 214 where used, 186 updating, 157 setup, 32 Ownership Groups Tab, 148 DTD navigator, 32 styles, 61, 172, 173, 174 P applying, 61 Permissions, 141, 144 creating, 172 advanced, 144 deleting, 173 collection level, 141 editing, 173 Pointee Components, 325 where used, 174 Pointer Components, 1, 54, 124, 202, 325 troubleshooting, 180 batch updating, 124 Vasont preview daemon, 181 defined, 1 where used, 186 reports, 202 samples, 186 edit views, 202 Previous Versions, 326 updating, 54 Primary Components, 326 Pointer Definition Records, 136 Privileges, 8, 312, 326 deleting, 136 auto-publishing, 312 Previews, 32, 61, 161, 162, 165, 166, 167, 168, 169, Privileges Tab, 141 170, 171, 172, 173, 174, 175, 178, 179, 180, 181, 182, collections, 141 183, 186, 187, 188, 191, 326 Processing Options, 5, 41, 42, 43, 44, 57, 67, 80, 123, cascading style sheets, 168, 169, 170, 171 130, 135, 203, 206, 207, 218, 250, 326 deleting, 171 batch updating, 123 editing, 170 context sensitive help, 42 loading, 169 deleting, 135 collection styles, 179, 180 filtering, 41 deleting, 180 finding, 43 updating, 179 properties, 42 conditions, 187 reporting, 206, 218 samples, 187 edit view comparison, 218 entity conversion, 162, 165 extract view comparison, 218 extract views, 175, 178 load view comparison, 218 assigning, 178 reports, 203, 206, 207 creating, 175 edit views, 203VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 335 extract/load views, 206, 207 Read Schema, 38 wrapper attributes, 206 Referenced By, 60, 326 tasks, 250 edit view components, 60 updating, 57, 67, 80, 130 Refining, 87, 105, 106, 326 extract/load view components, 80 basic setup, 87 usage, 44 collections, 105, 106 Projects, 1, 5, 121, 209, 210, 211, 241, 246, 247, 248, defining, 106 326 settings, 105 adding, 241 Reinstate, 326 attributes, 211 Reports, 195, 196, 197, 198, 199, 200, 201, 202, 203, reporting, 211 204, 205, 207, 208, 209, 210, 211, 212, 213, 214, 216, components, 5 217, 218, 219, 220, 251, 326 data, 121 alias attributes, 197 deleting, 121 attribute comparison, 219 defined, 1, 5 client key exceptions, 220 deleting, 246 components comparison, 217 duplicating, 246 edit views, 198, 199, 200, 201, 202, 203, 217, 218, exporting, 247 219, 220 flow, 209 attribute comparison, 219 reporting, 209 attributes, 201 importing, 247 basic, 199 management, 326 client key exceptions, 220 names, 248 component comparison, 217 processing, 211 detail, 200 reporting, 211 dynamic indexes, 202 task description, 211 genealogy, 200 reporting, 211 global change, 201 updating, 246 pointers, 202 users, 210 processing option comparison, 218 reporting, 210 processing options, 203 where used, 5 security, 203 workgroups, 210 undefined pointers, 202 Properties, 42 extract views, 217, 218, 219, 220 processing options, 42 attribute comparison, 219 Purge Raw Material, 119 client key exceptions, 220 Purge Stranded Components, 117 component comparison, 217 processing option comparison, 218 R extract/load views, 204, 205, 207, 208 Raw Attributes, 24 attributes, 205 Raw Classes, 326 basic, 205 Raw Components, 1, 12, 93, 96, 131, 196, 197, 326 component validation reports, 208 basic reports, 197 DTD reports, 208 creating, 12 processing options, 207 deleting, 96 translations, 207 detail reports, 197 load views, 217, 218, 219, 220 reports, 196 attribute comparison, 219 updating, 93, 131 client key exceptions, 220 using across content types, 12 component comparison, 217 Raw Material, 119, 326 processing option comparison, 218 In Collection flag, 119 processing option comparison, 218 merging, 119 projects, 251 purging, 119 raw components, 196, 197 Read DTD, 31 basic, 197 detail, 197336 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator Guide saving, 195 workflow, 259 user navigator, 212, 213, 214, 216 collaborative reviews, 259 ownership groups, 214 Saved Data Files, 37 roles, 213 opening, 37 user information, 214 Saving, 36, 195 users, 212 reports, 195 vasont licence, 216 setup data, 36 vasont login activity, 214 Schemas, 38 workgroups, 213 utilities, 38 view comparison, 216 Searching, 106, 224, 327 workflow, 208, 209, 210, 211 multimedia metadata, 224 project attributes, 211 setup, 224 project flows, 209 refine collections, 106 project processing, 211 Security Reports, 203 project users, 210 edit views, 203 project workgroups, 210 Setting the Primary, 32 task description, 211 DTD navigator, 32 Requirements, 241 Setup, 36, 37, 224 workflow, 241 changes, 37 Resequencing, 63 data, 36 edit view components, 63 saving, 36 Retrieving, 326 searching, 224 Reuse, 1, 183 multimedia metadata, 224 preview, 183 Shadow History, 327 Reviews, 61, 154, 253, 326 Signatures, 300 coordinator, 326 Sites, 230 load behavior, 61 SMTP Server, 319 reviewer seats, 154 Start Flag, 248 reviewers, 326 Stoplist or Stopwords, 291 styles, 61 Stranded Components, 327 applying, 61 Styles, 5, 61, 161, 172, 173, 174, 179, 180, 327 Roles, 139, 155, 156, 213, 326 applying, 61 creating, 155 creating, 172 deleting, 156 deleting, 173 grants, 139 editing, 173 reports, 213 previews, 179, 180 user navigator, 213 deleting collection styles, 180 updating, 156 updating collection styles, 179 Roles Tab, 143 updating, 61 Rule Relations, 59, 327 where used, 174 Sub-components, 327 S Super Administrators, 8, 149, 327 Samples, 162, 182, 183, 186, 187, 188, 191, 259 Support Tables, 227, 228, 229, 230, 231, 235 collaborative reviews, 259 editor tags, 227, 228 workflow, 259 adding, 227 conversion map, 162 deleting, 227 previews, 182, 183, 186, 187, 188, 191 updating, 228 conditional attribute preview, 187 usage, 228 generated note text, 191 helpers, 228, 229 key or legend, 188 adding an extension, 228 reuse preview, 183 deleting an extension, 229 translation preview, 182 languages, 235 where used preview, 186 notification events, 235 sites, 230VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 337 system profiles, 231 deleting, 276 translations, 230, 231 updating, 275 adding, 230 vendors, 274, 275 deleting, 231 creating, 274 updating, 230 deleting, 275 usage, 231 updating, 274 version methods, 229 Troubleshooting, 180 System Level, 315 preview displays, 180 utilities, 315 System Profiles, 231 U Undefined Pointers Report, 202 T edit views, 202 Tasks, 241, 248, 250, 251, 327 Unstructured Documents, 279 adding new, 248 creating collections, 279 deleting, 251 Unused Data, 118 descriptions, 248 deleting, 118 IDs, 248 Updating, 19, 20, 33, 47, 74, 76, 87, 88, 93, 99, 100, names, 248 103, 105, 107, 108, 110, 112, 113, 114, 121, 122, 128, updating, 250 134, 154, 156, 157, 179, 228, 246, 250, 273, 274, 275 Terminology Management, 289 alias attributes, 19 vocabulary, 289 alias valid values, 20, 99 Text Arguments, 327 aliases, 99 Text Components, 1, 327 attributes, 87, 88, 122 defined, 1 alias attributes, 88 Tools, 327 batch, 107, 112, 121, 128, 134 Transforms, 58 batch copy components, 113 updating, 58 collection groups, 103 Translations, 5, 12, 81, 182, 207, 230, 231, 265, 270, collection settings, 105 271, 272, 273, 274, 275, 276, 327 collection styles, 179 adding, 230 content type names, 103 configuration, 182, 265, 270, 271, 272 DTD navigator components, 33 automated programs, 270 edit view components, 47 basic, 265 editor tags, 228 component level, 271 extract view components, 76 images, 271 extract views, 74 preview, 182, 271 load view components, 76 translation vendor languages, 272 load views, 74 deleting, 231 merge utility, 108, 110 languages, 272, 273 ownership groups, 157 creating, 272 processing options, 114 deleting, 273 projects, 246 updating, 273 raw components, 93 memory, 273, 274 roles, 156 creating, 273 tasks, 250 deleting, 274 translations, 273, 274, 275 updating, 273 languages, 273 reports, 207 translation memory, 273 extract/load views, 207 vendor languages, 275 updating, 81, 230 vendors, 274 extract/load view components, 81 users, 154 usage, 231 workgroups, 156 vendor languages, 5, 275, 276 wrappers, 100 creating, 275338 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 Vasont Administrator GuideUser Navigator, 8, 139, 141, 143, 144, 146, 148, 149, actions tab, 124, 126 153, 154, 155, 156, 157, 158, 212, 213, 214, 216, 327 attributes, 122 admin rights tab, 149 general tab, 128 advanced tab, 144 misc. tab, 127 role grants, 144 occurrence tab, 125 collections tab, 139 pointers tab, 124 role grants, 139 processing options, 123, 130 components tab, 146 raw components, 131 creating ownership groups, 157 wrappers, 132 creating roles, 155 building raw material In Collection flag, 119 creating users, 153 copying components from one view to another, 112 creating workgroups, 156 deleting versions, 120 deleting ownership groups, 158 Generate Profile Certificate, 317 deleting roles, 156 importing projects, 247 deleting users, 155 merging components from one view to another, 107 deleting workgroups, 157 merging raw components, 119 email, 158 purge raw material, 119 languages, 158 purge stranded components, 117 ownership group reports, 214 read DTD, 31 ownership groups tab, 148 read schema, 38 privileges tab, 141 support tables, 12, 227, 228, 235 roles reports, 213 editor tags, 227 roles tab, 143 helpers, 228 updating ownership groups, 157 languages, 12, 235 updating roles, 156 notification events, 235 updating users, 154 system, 315 updating workgroups, 156 system level, 315 user information, 214 user reports, 212 V users reports, 212 Valid Values, 17, 20, 22, 50, 58, 327 vasont licence reports, 216 aliases, 20 vasont login activity, 214 creating, 20 workgroup reports, 213 attributes, 17, 50 workgroups tab, 148 aliases, 17 Users, 153, 154, 155, 212, 214, 248, 249, 327 edit view components, 50 assigning, 249 clearing, 22 assignments, 248 components, 58 category, 153 edit view components, 58 creating, 153 creating, 20 deleting, 155 alias, 20 reports, 212, 214 updating, 58 user navigator, 212 edit view components, 58 reviewer-only, 154 Validating Setup, 202, 208, 219, 220 updating, 154 attribute comparison, 219 Utilities, 12, 31, 38, 107, 112, 117, 118, 119, 120, 121, missing client key processing options, 220 122, 123, 124, 125, 126, 127, 128, 130, 131, 132, 134, missing extract or load view components, 208 135, 136, 227, 228, 235, 247, 315, 317, 327 missing pointer definitions, 202 batch deleting, 134, 135, 136 Validation, 59 attributes, 134, 135 Vasont Administrator, 1, 5, 327 occurrences, 135 making alterations, 5 pointer definition records, 136 Vasont Licence Reports, 216 processing options, 135 user navigator, 216 batch updating, 121, 122, 123, 124, 125, 126, 127, Vasont Login Activity Report, 214 128, 130, 131, 132, 134VAG-2016.1 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. 339 Vasont Preview Daemon, 181 deleting, 157 Vendors, 274 projects, 210 Versions, 120, 229, 328 reports, 213 deleting, 120 user navigator, 213 method, 229 updating, 156 on demand, 328 Workgroups Tab, 148 View Headers, 328 Working Collections, 328 Viewing, 258 Wrappers, 1, 23, 100, 101, 132, 328 multimedia components, 258 creating, 23 Views, 328 deleting, 101 Vocabulary, 289, 291, 292 updating, 100, 132 controlling, 289 implementing, 292 X Oracle text stopwords, 291 XSLT, 316 overview, 289 validation techniques, 291 VUI, 5 W Where Used, 44, 60, 129, 174, 186, 328 attributes, 129 edit view components, 60 preview, 186 processing options, 44 styles, 174 Workflows, 121, 208, 209, 210, 211, 241, 243, 244, 246, 247, 248, 250, 251, 259, 328 collaborative reviews, 259 graphics, 243 projects, 121, 241, 246, 247, 251 adding new, 241 deleting, 246 deleting data, 121 duplicating, 246 exporting, 247 reports, 251 updating, 246 reports, 208, 209, 210, 211 project attributes, 211 project flows, 209 project processing, 211 project users, 210 task description, 211 requirements, 241 initiating, 241 reusing across collections, 244 tasks, 248, 250, 251 adding new, 248 deleting, 251 updating, 250 Workgroups, 156, 157, 210, 213, 249, 328 assigning, 249 creating, 156340 CONFIDENTIAL © 2016 TransPerfect Translations International Inc. VAG-2016.1 </div> </article> </div> </div> </div> <script type="text/javascript" async crossorigin="anonymous" src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-8519364510543070"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.1/jquery.min.js" crossorigin="anonymous" referrerpolicy="no-referrer"></script> <script> var docId = 'db6301e31ad918c6835e98e4369c30af'; var endPage = 1; var totalPage = 350; var pfLoading = false; window.addEventListener('scroll', function () { if (pfLoading) return; var $now = $('.article-imgview .pf').eq(endPage - 1); if (document.documentElement.scrollTop + $(window).height() > $now.offset().top) { pfLoading = true; endPage++; if (endPage > totalPage) return; var imgEle = new Image(); var imgsrc = "//data.docslib.org/img/db6301e31ad918c6835e98e4369c30af-" + endPage + (endPage > 3 ? ".jpg" : ".webp"); imgEle.src = imgsrc; var $imgLoad = $('<div class="pf" id="pf' + endPage + '"><img src="/loading.gif"></div>'); $('.article-imgview').append($imgLoad); imgEle.addEventListener('load', function () { $imgLoad.find('img').attr('src', imgsrc); pfLoading = false }); if (endPage < 7) { adcall('pf' + endPage); } } }, { passive: true }); </script> <script> var sc_project = 11552861; var sc_invisible = 1; var sc_security = "b956b151"; </script> <script src="https://www.statcounter.com/counter/counter.js" async></script> </html>