vasont universal integrator guide · 2018-03-12 · only typical content management features, but...

47
Vasont Universal Integrator Guide FrameMaker Version 2018.1 CONFIDENTIAL ------------------------ © 2018 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 221 W. Philadelphia St., Suite 114 York, PA 17401 717-764-9720 www.vasont.com © 2018 TransPerfect Translations International Inc. Document Number: VUIGF-2018.1

Upload: others

Post on 12-Apr-2020

1 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Vasont Universal Integrator GuideFrameMaker

Version 2018.1

CONFIDENTIAL------------------------

© 2018 TransPerfect Translations International Inc.All rights reserved. No part of this document may be

reproduced or transmitted in any form or by anymeans, electronic or mechanical, including

photocopying, recording, or any information storageand retrieval system without permission in writing

from the publisher.

Vasont SystemsA TransPerfect Company

221 W. Philadelphia St., Suite 114York, PA 17401717-764-9720

www.vasont.com

© 2018 TransPerfect Translations International Inc.

Document Number: VUIGF-2018.1

Page 2: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

TRADEMARKS

Trademarked names appear throughout this book. Rather than list the names and entities that own the trademarks orinsert a trademark symbol with each mention of the trademarked name, the author states that it is using the namesonly for editorial purposes and to the benefit of the trademark owner with no intention of infringing upon that trade-mark.

Page 3: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Table of ContentsUsing the Vasont Universal Integrator ..................................................................................................... 1

About the Vasont Universal Integrator ............................................................................................ 1Displaying the VUI Version Information ......................................................................................... 2

Technical Support ............................................................................................................... 2Recurring Features ...................................................................................................................... 3

Signing on to VUI ............................................................................................................................... 5Getting Started ........................................................................................................................... 5

Security ............................................................................................................................. 6Content Ownership .............................................................................................................. 6

Expired Passwords ...................................................................................................................... 6Interacting with Vasont ........................................................................................................................ 7

Working with the VUI Navigator ................................................................................................... 7Opening a Navigator ............................................................................................................ 7Navigator Window Overview ............................................................................................... 10The Navigator Pop-Up Menu ................................................................................................ 11Searching for Content in a Navigator ..................................................................................... 18Previewing Content in a Navigator ........................................................................................ 18Opening Content from a Navigator ........................................................................................ 19

Updating the Vasont Database ...................................................................................................... 19Disconnecting From the Database ................................................................................................. 21

Creating and Reusing Content .............................................................................................................. 23Creating New Vasont Content from Templates ................................................................................ 23Picking Existing Content from Vasont ............................................................................................ 24Using Drag and Drop Features ...................................................................................................... 26

Moving or Cloning an Entry ................................................................................................. 26Adding a File to Vasont ....................................................................................................... 27Adding Text to Vasont ........................................................................................................ 27

Working with VUI Workflow ............................................................................................................... 29Accessing Workflow Tasks .......................................................................................................... 29Viewing Workflow Content ......................................................................................................... 29Extracting Workflow Content ....................................................................................................... 30Completing Workflow Tasks ........................................................................................................ 30Viewing the Workflow Graphic .................................................................................................... 30Refreshing the Task List .............................................................................................................. 30

XML Handling for FrameMaker Processing ............................................................................................ 31Working with DITA in VUI ................................................................................................................. 33

Using DITA Conref Links in VUI ................................................................................................. 33Using DITA Href Links in VUI .................................................................................................... 33Using DITA Xref in VUI ............................................................................................................. 34Open Image Pick List .................................................................................................................. 34Paste Image Using VUI ............................................................................................................... 34

Glossary ........................................................................................................................................... 35Index ............................................................................................................................................... 41

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. iii

Page 4: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Vasont Universal Integrator Guide

iv CONFIDENTIAL © 2018 TransPerfect Translations International Inc. VUIGF-2018.1

Page 5: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Using the Vasont UniversalIntegrator

The Vasont Universal Integrator (VUI) is available for Arbortext Editor, FrameMaker, oXygen and XMetaL. Thisguide defines how to use the VUI application within FrameMaker.

The VUI is a Windows application extension that allows access to typical functionality of the Vasont Content Man-agement System (CMS) from within FrameMaker. Once installed, the VUI is available from within FrameMaker viamenu choices on the Vasont menu.

FrameMaker has multiple views for working with content. The two most common views are the Author View andthe WYSIWYG view. The VUI is available in the both the Author view and the WYSIWYG view of FrameMaker.The VUI does not function if the user is in the XML view of FrameMaker.

The VUI contains a subset of the Vasont functionality that is available via the Client-Server interface. User optionsfor VUI, such as your permissions and collection management must be set up in Vasont Administrator. For moreinformation on using the client-server version of Vasont and Vasont Administrator, see the Vasont User Guide andthe Vasont Administrator Guide.

About the Vasont Universal IntegratorThe VUI, the Vasont application, and the associated Vasont Administrator application form a CMS that allows notonly typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database that efficiently coordinates creation, storage, searching, using, reusing, versioning, linking, track-ing, editing and other content management tasks.

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. 1

Page 6: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Displaying the VUI Version InformationTo view VUI version information, choose About Vasont from the Vasont menu. A dialog box displays the majorand minor versions of the program files contained in the VUI. It also displays the Vasont version of the Oracle sche-ma and version information for the Vasont COM object if you are logged into VUI.

2 The version numbers of the various components may not be the same. This is intentional.

Technical SupportIf difficulties are encountered using VUI which cannot be resolved using online documentation, contact Vasont cli-ent support at (717) 764-9720. Please be prepared to provide the following information:

• Application name: VUI (Vasont Universal Integrator)

• Actual error message

• Steps taken to reproduce the error

• Version number. The version numbers for all the components of the VUI are available by choosing About Vas-ont from the Vasont menu within your SGML/XML editor (see the preceding graphic). The version number isbuilt into the application.

If, for some reason, you cannot access the About Vasont menu choice, the version number is also built into themain application file. It can be viewed by following these steps:

• Open Windows Explorer

• Locate and open the Vasont folder

• Locate and open the App folder

• Locate and right-click on the file - vsntntgrtr.dll

• Choose the Properties menu choice

Using the Vasont Universal Integrator

2 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. VUIGF-2018.1

Page 7: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

• Click on the Details tab

Refer to our website at www.vasont.com for additional support services.

Recurring FeaturesThe VUI is designed with various recurring features to facilitate and maximize the use of the application. Thesefeatures include, but are not limited to, the capability to:

• Re-sort columnar data and/or adjust columnar widths within a window.

• Click on the drop-down arrows on dialog boxes to obtain a list of all available options (example: Add, Insert).

• Right-click in a window to open pop-up menus containing choices from which you can select the appropriateaction (example: New, Check Out). Some menu items may be disabled (grayed out), while others may be ena-bled (bold). Only menu items that are relevant to the selected actions are enabled.

• Use the scroll bars that may appear at the bottom and to the right of a window to view all of the data. (Barsdisplay depending on the amount of available data, and can be moved up, down, right or left, as needed).

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. 3

Page 8: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Using the Vasont Universal Integrator

4 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. VUIGF-2018.1

Page 9: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Signing on to VUIThe VUI must be properly installed for FrameMaker through the Vasont Setup program and must be the same ver-sion as the database being accessed.

You must know the answers to the following three questions in order to sign onto the system.

1. Do I know my Username?

2. Do I know my Password?

3. Do I know which Profile to use?

If you do not know your Username, Password, or Schema, see your Vasont system administrator to obtain this infor-mation.

Getting StartedThe VUI features are available only after you have logged into Vasont. A login dialog appears the first time youaccess one of the VUI features. Your credentials for VUI are the same as the ones used to access the Vasont Client-Server.

Prior to logging into the VUI, you must open FrameMaker. Once FrameMaker is running, the following steps maybe performed:

1. Enter your username in the Login field of the Vasont Login window.

2. Enter your password in the Password field.

3. In the Profile field, select a profile, i.e., Production Server or Test Server. Most systems have only one profile.

4. Click OK.

When you log into the VUI, the release number for the software you are running is compared to the release numberfor the database you are accessing. If these release numbers do not match, login is not allowed and a message ap-

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. 5

Page 10: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

pears. This ensures that the version of the Vasont software matches the version of the Oracle database. If a mismatchexists you are not granted access to Vasont functionality.

SecurityBasic permissions are set up with assignment of a login id and password. This allows you access to the Vasont appli-cation. Permission may be granted for a specific collection, specific components of a collection, or even specificfeatures of the Vasont system, such as cloning data. Since ‘permissions’ are set up using the Vasont Administratorprogram, you must contact your local system administrator to establish permissions prior to using the Vasont appli-cation.

Content OwnershipThe VUI is enhanced to support the Content Ownership Extension. When the Ownership Extension is activated,VUI behavior is modified when interacting with Vasont. If a user is a member of a single ownership group, there isno change in VUI behavior. If a user is a member of multiple ownership groups, they are presented with a windowto choose which ownership group to activate for their current VUI session.

Expired PasswordsOn some installations, the system administrator may set up special password requirements. For example, passwordsmight expire every three months and a new, different password must be created.

If your system administrator has instituted advanced security requirements, a message box displays when your pass-word has expired.

If an expired password notice is received, click OK and then enter the old password, followed by a new password,twice. Consult your system administrator or see the Vasont User Guide to determine the minimum number of re-quired characters, combinations of letters and numbers, and any other password requirements. Once the system ac-cepts your new password, you are logged into the VUI. Otherwise, an error message displays and you can try again.Press Cancel if you choose not to login again.

Signing on to VUI

6 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. VUIGF-2018.1

Page 11: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Interacting with VasontThis chapter provides information for accessing a collection navigator through FrameMaker VUI and loading con-tent into the Vasont database.

Working with the VUI NavigatorA navigator is a window which allows you to browse and perform actions on stored content in a collection. Theamount of content that is retrieved into the navigator is dependent on the query that is used when opening the navi-gator. You may choose to retrieve a small, specific set of content that meets your defined criteria, or all content thatexists in the collection.The following sections explain how to open a navigator and the actions you are able to perform from the navigator.

Opening a Navigator1. From the menu bar, select Vasont and then select Open Vasont Navigator to open the Pick from Vasont -

Primary wizard.

2 If you have not already logged into Vasont, the login screen appears. (See Signing on to VUI).

2. The wizard first displays a tree view of the content types, collection groups, and collections contained in Vas-ont. Select a collection and click Next.

2 To save time, you may also double-click on a collection to select it.

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. 7

Page 12: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

3. After selecting a collection, the wizard determines if there are any saved queries available for that collection. Ifthere are, two more wizard pages appear which allow you to select a query and modify its criteria. Otherwise,you are taken directly to a navigator for the selected collection.

Use the following steps to select a saved query and change its criteria, if needed:

• Select a saved query from the list of queries displayed. If necessary, use the scroll bar on the right to see allthe available queries. After selecting the desired query, click Next.

2 You may deselect the highlighted query by clicking on it if the query selection is no longerdesired. If no query is selected and you click Next, the navigator window displays an unfilteredlist containing all primary components.

• The query page allows you to enter data with which to filter. Depending on the query that was selected,there may by one or more lines on the criteria page. Some lines may contain an edit box. This allows you totype in freeform data. Some lines may be grayed out and unavailable for editing. Some lines may alreadyhave data in the edit box but are not grayed out. These are default values for the query, which may be over-

Interacting with Vasont

8 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. VUIGF-2018.1

Page 13: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

ridden by editing the text. Some lines may contain a drop-down box, which allows you to select from sever-al predefined selections.

4. After all sections of the wizard are complete, click Finish to open the navigator window.

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. 9

Page 14: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Navigator Window OverviewThe navigator window is the access point to many functions for manipulating, organizing, and gathering informationabout the content. It is organized in a tree-like structure identical to those found in the Vasont Client-Server applica-tion.

Initially, when the navigator displays, a top-level view of the current collection is shown. The order of top-level, orprimary, entries reflects the sequence of the entries in the collection. Order is usually alphabetical, but entries begin-ning with non-alphabetic or ignored characters may be interspersed, as appropriate, for a collection.

• The icon preceding each entry indicates its current status.

Approved Checked Out To Someone Else

Draft New

Incomplete Entered in Global Change Log

Pending Delete Target of Global Change and Checked Out

Checked Out To Self Branch Notice

• A plus (+) to the left of the icon indicates the entry may have associated subentries.• Click the plus (+) to expand the entry one level. The plus (+) changes to a minus (−).• Click the minus (−) to reverse the process and roll up the subentries.• When subentries are visible, click the plus (+) preceding the subentry to expand one level farther; click minus

(−) to roll up the subentries.• If the entry is not preceded by a plus (+) or minus (−), its configuration in Vasont Administrator does not allow

it to have any subentries.The navigator window can remain running while you are editing content or doing any other function in FrameMak-er. Return to a running navigator by clicking anywhere within the window. In this manner, you do not have to repeti-tively use the Pick from Vasont wizard once a collection has been chosen.

Interacting with Vasont

10 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. VUIGF-2018.1

Page 15: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Multiple navigators may run at the same time. This allows you to view or work on multiple projects or collectionswithin FrameMaker.

Minimize a running navigator window by clicking the minimize button in the upper right corner of the navigatorwindow. The window is minimized to the taskbar at the bottom of the screen.

View the contents of a minimized navigator window by clicking the restore button to return the window to its previ-ous size and position.

Resize the navigator window by moving the mouse cursor to any outside edge of the navigator window and holdingdown the left mouse button while moving the mouse. Release the mouse button when the window is the desired size.

Move the navigator window to any location on the screen by clicking on the title bar and dragging the window to anew location.

Close an open navigator window by clicking the X in the upper right corner. Open navigators do not need closedbefore exiting FrameMaker. If FrameMaker is closed, any open navigators are automatically closed with no loss ofdata.

The Navigator Pop-Up MenuThe Navigator Pop-Up Menu contains items that act on the currently selected component in the navigator. Right-click on a component to select it and display the pop-up menu. The function of each item in the menu is discussedbelow.

• New: New allows for insertions of a new, empty component. Upon selection, a sub-menu appears with compo-nents that are legitimate inserts for that position, according to the collection's rules. Select a component for inser-tion.

2 The submenu contains a horizontal, dividing line. Components listed above the line are inserted atthe same level in the tree as the currently selected component. Items below the line are inserted as achild of the currently selected component.

• FrameMaker Actions: FrameMaker Actions allows you to import or export a FrameMaker document which isimported or exported as an XML file. The XML file is then stored in a multimedia component of the module.

• View: View allows you to view the content and attributes of an item. Clicking on the View menu choice opensthe Component Viewer window.

• Display Virtual View: Display Virtual View allows you to view content in an “index-like” view.

For example, suppose you had a collection which contained a number of different books. In the collection, Bookwas the primary component, and it had a child component of Author. If you selected Author, and chose DisplayVirtual View from the right-click menu, another navigator window displays containing the virtual view. The vir-tual view would contain Author entries at the top level and each Author would have child component(s) of Book(these being the books that the author wrote).

• Check In: Check In allows you to check in an item that is currently checked out. The user who initially checkedout a component may be required to check it in, depending on permissions given in the Vasont Administratorapplication. If an item is already checked in, the Check In menu item is disabled (grayed out).

Note: When a component is checked out to yourself, a Key icon appears to its left. When a component ischecked out to someone else, a Lock icon appears. See Navigator Window Overview.

• Check Out: Check Out allows you to reserve a component for your exclusive use. A checked out componentmay only be edited by the user who checked it out. Other users may still view the component. If an item is al-ready checked out, the check out menu choice is disabled (grayed out).

• Check Out Info: Check Out Info allows you to view the date and time that a component was checked out andby whom. Only when an item is checked out is the Check Out Info menu choice enabled, otherwise it is disabled

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. 11

Page 16: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

(grayed out). When Check Out Info is clicked, a message box containing current check out information appears.Click OK to dismiss the message box.

• Approve: Approve allows you to approve components that have new or draft status. New or added status is as-signed when a new entry is added and has not yet been approved. Draft status is automatically assigned when anapproved entry is updated. A top-level entry is also assigned a draft status if any of its subentries become draft.Only when an item is draft or new is the Approve menu choice enabled, otherwise it is disabled (grayed out).

• Delete: Delete allows you to delete a component and its children through the Vasont navigator. If structuredcontent is extracted and is currently open in the editor, you do not want to delete the component from the naviga-tor; instead, delete the component through the editor and reload the content. After a component is deleted, itsstatus changes to pending delete, which must be approved.

• Approve Delete: Approve Delete allows you to approve the deletion of components that have already beenmarked for deletion (have pending delete status). Only when an item is pending delete is the Approve Deletemenu choice enabled, otherwise it is disabled (grayed out).

• Undo Delete: Undo Delete is available on components which are pending delete.

• Analyze: Analyze helps to identify any missing components as validated against the rules of structure defined inthe Vasont Administrator.

• Refresh: Refresh allows you to refresh the current navigator in order to reflect any edits, deletions, or checkoutswhich may have been made in the collection by other users.

• ReFilter: ReFilter allows you to choose a different saved query than was chosen initially (or no query at all) andopen the navigator window, which displays the appropriate content. The Pick from Vasont - Primary wizardappears and guides you through the process of opening a new navigator with a new collection or a different fil-tering of the same collection.

2 When the wizard is displayed, clicking Cancel on any page returns you to the previously openednavigator window. If you complete the wizard and click Finish, the navigator window which is cur-rently open is closed and is replaced.

Interacting with Vasont

12 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. VUIGF-2018.1

Page 17: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

• Find: Find allows you to use a saved search that was created in Vasont to look for and move to specific content.The Find in Vasont wizard displays a list of saved searches that are available for this collection. Select a filterand click Next (or double-click a filter entry).

The search criteria page appears. Fill in or select the appropriate information and click Finish.

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. 13

Page 18: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

The wizard closes and the navigator window appears. The component matching the criteria is expanded andhighlighted.

2 If a match is not found within the selected primary, you are asked if you want to continue searchingall primaries below it.

After using the find wizard, find the next component that meets the search criteria by pressing the Fkey.

• Expand All: Expand All expands the navigator tree to show every level contained in the hierarchy beneath aprimary component. Some component trees are very large and will take a longer time to expand all subcompo-nents.

• Where Used: Where Used checks where an entry is used within the current collection.

Interacting with Vasont

14 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. VUIGF-2018.1

Page 19: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

When selected, a list of locations for the component is displayed. This list always contains at least one entry; thecomponent you originally clicked on. Double-click on any entry in the list to open another navigator window.The new navigator contains just one primary and opens to the entry that was selected.

Click the X in the top right-hand corner to dismiss the Where Used window.

• Referenced By: Referenced By displays the identification of every reference to an entry.

1. In the navigator, select the component to be checked. Right-click to open the pop-up menu and select Ref-erenced By.

2. The Referenced By window displays showing every component that is pointing to (referencing) the selectedcomponent. The details of the referencing entries are shown, including collection, primary description, pa-rent description, status flag, edit date (with time), and user name.

3. Double-click on an entry or right-click and select Open Navigator in the Referenced By window to displaya navigator for the referenced component. Open the navigator to see more details or perform edits on acomponent that is pointing to the selected component.

4. Right-click on an entry in the Referenced By window and select View to display select details and attributesfor the selected component.

5. Click the X in the top right-hand corner to dismiss the Referenced By window.

• View Variants: View Variants allows you to see any variants which have been created for a component. If novariants exist for the component, a message box displays stating this information.

1. Right-click and select View Variants to open the Variant Viewer window to display information about thevariant source or target. The variant type (Source or Target) is shown in the Variant Type column in thewindow. The collection where the variant is located, the component description, and the primary descrip-tion are also shown along with other information.

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. 15

Page 20: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

2. Right-click on an entry in the window and select Open Navigator to view the variant in the navigator win-dow.

3. Right-click on an entry and select View to open a view-only window showing the text of the variant com-ponent along with the component's metadata.

• Open In New Navigator: Open In New Navigator allows you to open a new navigator window containing onlya single primary component.

• Extract: Extract pulls structured content from Vasont and displays it in the XML editor specified through Win-dows, typically the application from which you are running VUI.

After selecting Extract, a wizard opens allowing you to select the extract view to use for extraction.

Click Next to begin the extract process. The document is loaded into FrameMaker and the navigator is mini-mized.

• Save as Disk File: Save as Disk File allows you to save a multimedia component to your file system. This op-tion is only enabled on the right-click menu of multimedia components.

Interacting with Vasont

16 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. VUIGF-2018.1

Page 21: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

• Versions: Versions allows you to view structured content as it existed in a previous state and reinstate it, if de-sired. Right-click to open the pop-up menu and select Versions. Select the version to examine and click Finish.

A specialized navigator window appears with the selected version loaded. The pointer icon indicates achanged item.

After viewing the older version, you can reinstate it or see a report of differences.

1. Click Redline to view a report of the changes made since this version.

2. Click Reinstate to rollback changes to this older version. All changes made to the entry since this olderversion are removed.

• Global Clone: Global Clone, if enabled (see note below), displays a list of other uses of the same content basedon a client key match. Select all or some of the matching components in the list and click the Clone button tooverlay the content. For example, assume you make changes to a section. You then right-click and select Global

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. 17

Page 22: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Clone. The system searches for other sections with a matching client key. If any are found, you are presentedwith a list of matches. All matching sections which you choose are overwritten with the content of the selectedsection.

2 The Global Clone right-click option is only available if two conditions are met. The componentmust have the global_clone_right_click processing option (see the Vasont Administrator Guide andthe Vasont Processing Options Guide). Also, the component must have a parent which was clonedor was the result of a clone.

• Topic Uses: Topic Uses displays other components with the same client key. Details such as the collection,component name, description, client key, and edit date are shown.

Searching for Content in a NavigatorThe Text Search box and the Search button work together to find content within the navigator. Once search criteriais entered into the Text Search and the Search button is pressed, a case insensitive search locates and highlights allexisting occurrences within the selected component and its descendants.

Click Search to continue the search within primary components and their descendants. Once all occurrences of thesearch criteria are found, a dialog box appears stating there are no additional components. Start a new search bypositioning your selection on a different area in the tree view or by typing different search criteria into the TextSearch box.

The search tool is very powerful and finds occurrences of a phrase or text within navigator tree view descendantsand also within the text of subcomponents.

Previewing Content in a NavigatorThe preview pane displays a styled view of the selected content allowing you to examine content before opening itwithin the editor.

• Show/Hide Preview: The Show Preview button is located on the lower right corner of the navigator and dis-plays the preview pane within the right half of the navigator. You can resize the window by clicking and holdingthe left mouse button and dragging the border to resize the panes. Once the content displays, the button textchanges to “Hide Preview”. Press again to hide the preview pane.

Interacting with Vasont

18 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. VUIGF-2018.1

Page 23: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Preview information is displayed at the top of the preview pane and contains information such as:

• When the preview was generated.

• If the preview is out of date and needs refreshed.

• No preview has been generated.

• No preview setup for this collection.

Previews cannot be generated or refreshed from the VUI navigator. You must login to Vasont to refresh or gen-erate a preview. See the Vasont User Guide for details.

While viewing a selection in the preview pane, the navigator tree view synchronizes with the preview pane. Theselection is highlighted in the tree view and the preview pane scrolls to the selected component and displays ared arrow marker.

• Find: The Find button allows for searching of a word or phrase within the preview pane. The Find dialog boxallows you to match whole words, match the case, or highlight all matches of the word or phrase which issearched. Click Previous or Next to move through the found matches in the Preview Pane.

• Print: The Print button allows you to print the content shown in the preview pane. A standard print dialog boxappears.

When a primary component contains references to other content, the preview window displays a preview of thatcontent if it exists. If it does not exist, the entire preview displays and the red arrow marker points to the reference inthe context of the existing document.

Opening Content from a NavigatorThe Open in Editor button extracts structured content from Vasont and displays it in the XML editor. This buttonfunctions the same as the “Extract” option on the navigator pop-up menu. See The Navigator Pop-Up Menu.

Updating the Vasont DatabaseVUI can only load files which were previously extracted from Vasont or created from a Vasont template.

The Update Vasont Database menu option is available in FrameMaker structured view and in the map editor view.Users do not need to switch to another editor view to use this option.

To load data from FrameMaker into Vasont, select Update Vasont Database from the Vasont menu.

A wizard displays and guides you through the load process. The first page of the wizard requests that you choose aload view (see Building Load and Extract Views in the Vasont Administrator Guide for more details on load views).

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. 19

Page 24: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Choose a load view and click Finish. The wizard closes and the update process begins.

2 When the update is complete, you are asked whether to update other primaries that are clones of thisprimary. The component must have the “global_clone_load” processing option applied to it for thisdialog to appear.

After the load process is complete, the document closes in FrameMaker. VUI then informs you that the update proc-ess was successful and asks if you wish to re-extract the document. Click Yes to begin the extraction process againor click No to close the document.

2 Re-extract the content if you need to confirm the content was saved as written or to make periodicupdates to the database while continuing to work on the content.

You may bypass the re-extract prompt by adding the following section to the vasont_fm_ui.ini file:

[UpdateVasont]PromptForReExtract=No

The vasont_fm_ui.ini file is located in your Windows folder. If it does not exist, create it using a simple text editorlike Notepad.

Interacting with Vasont

20 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. VUIGF-2018.1

Page 25: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Disconnecting From the DatabaseIt is not necessary to disconnect from the database before closing FrameMaker, although, it may be necessary todisconnect in order to log off as one user and log in as another. From the FrameMaker window, select Vasont andthen Disconnect From Database to log out of Vasont.

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. 21

Page 26: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Interacting with Vasont

22 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. VUIGF-2018.1

Page 27: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Creating and ReusingContent

This chapter describes methods that the FrameMaker VUI offers for creating new content and utilizing content thatalready exists in Vasont.

Creating New Vasont Content from TemplatesWhen creating new content in FrameMaker, use the Create New From Template feature. This feature provides twofunctions:

• Creates a placeholder in the Vasont database for the new content.

• Provides a starting structure for authoring content according to your business rule.

When you select the Create New From Template option from the Vasont menu, a special process in Vasont clonesa copy of the chosen template into the selected collection to create a new primary component. The new primarycomponent is assigned an ID value and then extracted into your FrameMaker editor. The ID and other hidden meta-data provide essential information when loading the finished content back into Vasont.

The detail in your template is dependent on your authoring rules and the team members who create the templates.The templates may contain static attribute values and components which are required for your business needs orauthoring guidelines. Sometimes instructions may be embedded in your components which guide you through theauthoring process. If you need additional templates or changes to existing templates, see your Vasont system admin-istrator.

This feature must be configured in the Vasont Administrator before templates may be defined and utilized in theFrameMaker editor. See the Vasont Processing Options Guide and the Vasont Administrator Guide for details.

To create new content using a template:

1. In the application window, select Vasont → Create New From Template.

If you are not logged into the Vasont database, you are presented with a login window. See Signing on to VUI.

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. 23

Page 28: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

2. The Pick From Vasont - Template window displays. The list contains collections which are configured withtemplate functionality.

3. Highlight a collection that contains the type of content you want to create and click Next.

A list of available templates for the collection that you selected displays.

4. Highlight the template you wish to use and click Finish.

5. The Extract from Vasont window displays with the available extract view options.

6. Select the desired extract view and click Next.

7. The content appears in the FrameMaker editor pane.

Take notice that the top-level component's ID attribute value and the filename have the same value. Do notchange these because this value tells Vasont where to store the content when loading into the database.

8. Edit and create content as needed.

Picking Existing Content from VasontThe Pick From Vasont option allows you to insert a copy of existing content from the database into a new or exist-ing component in an XML/SGML document, which is being edited within FrameMaker. A wizard steps you throughthe process of locating the text or multimedia component to insert.

1. To start the process, click inside the tag where you want to insert content.

2. From the Vasont menu, choose Pick From Vasont.

3. If the component is tracked in Vasont, the Pick from Vasont wizard opens.

The wizard determines if there are any stored queries available for that component. If so, two additional wizardpages are available that allow you to select a query and modify the criteria. Otherwise, you are taken directly tothe component selection screen.

4. The Pick from Vasont - Text listing displays.

Creating and Reusing Content

24 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. VUIGF-2018.1

Page 29: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

• Components of the type you requested which contain text are displayed in a list view. Select the desiredentry and click Finish to insert the content into the document.

• If the selected component is a graphic, a thumbnail view of the highlighted entry displays at the bottom ofthe page.

The View Large Size button displays a larger image view.

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. 25

Page 30: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

The View Image List button displays multiple thumbnail images from the list. For best performance, up to50 images are displayed in this view, so using a filter to retrieve a subset of the available content is essen-tial. In this view, select one of the thumbnails and click Next to insert the image into your document.

2 Any content that exists for this element in your extracted XML file is overwritten with the data selec-ted from the pick list.

Using Drag and Drop FeaturesVUI supports a wide variety of drag and drop features. These include moving and cloning existing content withinVasont and adding content from the file system or other applications into Vasont.If your operating system is Windows 2003 or higher, the navigator display includes a built-in mini file explorer. Youmay use this feature to search for files on your file system and drag them into the navigator to instantly add file-based content to Vasont. This is especially useful when adding graphics or other multimedia files.Users of earlier versions of the Windows operating system have the same functionality but must open a separateWindows Explorer window to search for content.

Moving or Cloning an EntryData may be moved, or cloned (smart copied), within a collection or between collections. When data is moved, it iseither placed in a different position within the same collection, or it is moved to an entirely different collection.Cloning actually makes a smart copy of the data, either within the same collection, or in a different collection. Bothof these actions are performed using drag-and-drop.Both the existing (source) location and the destination location of the entry must be visible. If moving or cloningbetween collections, open multiple navigator windows and tile them horizontally or vertically so that the requiredinformation is visible.

Moving a Component1. In the navigator, click and hold on the component you wish to move.2. Move the mouse to the destination location and release the left mouse button.

Creating and Reusing Content

26 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. VUIGF-2018.1

Page 31: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

3. You are asked to confirm your move to one of the following:

• Onto a sibling element under the same parent. Moving here will move the component and its descendants toa position directly after the destination element.

• Onto a different parent. Moving here will move the component and its descendants to become a child of thedestination element.

• Onto a sibling element under a different parent. Moving here will move the component and its descendantsto a position directly after the destination element.

• Onto an element in a different navigator. Moving here will move the component and its descendants to aposition directly after the destination element.

Cloning a Component1. In the navigator, locate the component you wish to copy.

2. Press Ctrl and click and hold on the component you wish to copy.

Move the mouse to the destination location and release the mouse button and the Ctrl key.

3. You are asked to confirm your copy to one of the following:

• Onto a sibling element under the same parent. Copying here will copy the component and its descendants toa position directly after the destination element.

• Onto a different parent. Copying here will copy the component and its descendants to become a child of thedestination element.

• Onto a sibling element under a different parent. Copying here will copy the component and its descendantsto a position directly after the destination element.

• Onto an element in a different navigator. Copying here will copy the component and its descendants to aposition directly after the destination element.

Clone and Replace1. In the navigator, locate the component you wish to copy.

2. Press Ctrl+R and click and hold on the component you wish to copy.

Move the mouse to the destination location and release the mouse button and the Ctrl key.

3. You are asked to confirm your overwrite.

Adding a File to VasontA large number of multimedia files may be stored and searched in Vasont, including Word documents, PowerPointpresentations, and numerous graphic formats, among others.

1. Open Windows Explorer and navigate to the file you want to add to Vasont.

2. Click on the selected file and drag it to the desired location in the navigator.

3. You are asked to confirm the addition.

Adding Text to VasontText may be added from any application which supports drag and drop functionality. For example, to enable dragand drop editing in Word, click the Microsoft Office button and then click Word Options. Click Advanced. UnderEditing options, select or clear the Allow text to be dragged and dropped check box.

1. In an open Word document, select the text that you want to add as a text component.

2. Drag the content to the desired location in the navigator.

3. You are asked to confirm your addition.

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. 27

Page 32: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Creating and Reusing Content

28 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. VUIGF-2018.1

Page 33: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Working with VUI WorkflowThe VUI allows you to access your active tasks in Vasont from FrameMaker. This functionality allows you to viewyour assignments, extract the content to which the workflow task is applied, and perform the requested work. Whenyou have accomplished the requested assignment, the task can be completed and removed from your active task list.

Workflow projects must be configured in the Vasont Administrator to enable this feature. See Workflow in the Vas-ont Administrator Guide and Project Workflow in the Vasont User Guide for complete details on setting up and us-ing workflow in Vasont.

Accessing Workflow Tasks1. In the application window, select Vasont → Open Workflow.

If you are not logged into the Vasont database, you are presented with a login window. See Signing on to VUI.

2. The My Tasks window displays with your active tasks. This window is similar to the My Tasks area on theVasont Home page. It lists all tasks which are currently assigned to you and corresponding information.

3. Highlight an entry to perform one of the following actions:

• Completing Workflow Tasks

• Viewing Workflow Content

• Extracting Workflow Content

• Viewing the Workflow Graphic

• Refreshing the Task List

4. Close the My Tasks window by clicking on the X in the upper right corner.

Viewing Workflow Content1. Open the My Tasks window by clicking on Open Workflow from the Vasont menu. See Accessing Workflow

Tasks.

2. Highlight the entry in the My Tasks window.

3. Click Open Navigator.

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. 29

Page 34: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

A navigator window displays with the selected content. From this navigator, you can perform any of the func-tions available on the right-click menu. See Working with the VUI Navigator.

Extracting Workflow Content1. Open the My Tasks window (either from the Vasont menu or maximize if it is currently minimized in the lower

left corner of the screen). See Accessing Workflow Tasks.

2. Highlight the entry in the My Tasks window.

3. Click Extract.

4. The Extract from Vasont window displays with the available extract view options.

5. Select the desired extract view and click Next.

6. The content appears in the FrameMaker editor pane. The My Tasks window is minimized to the lower left cor-ner of the application.

7. When the edits and alterations are complete, update the Vasont database with the revised content. See Updatingthe Vasont Database.

Completing Workflow Tasks1. Open the My Tasks window (either from the Vasont menu or maximize if it is currently minimized in the lower

left corner of the screen). See Accessing Workflow Tasks.

2. Highlight the entry in the My Tasks window.

3. Click Complete Task.

4. If there are tasks that follow, you are prompted with the Initiate Additional Tasks window. Select the next taskfor initiation and assign a user by selecting one from the drop-down list. Click OK.

Viewing the Workflow Graphic1. Open the My Tasks window (either from the Vasont menu or maximize if it is currently minimized in the lower

left corner of the screen). See Accessing Workflow Tasks.

2. Highlight the entry in the My Tasks window.

3. Click Workflow Graphic.

A graphical representation of the workflow displays. The graphic provides a simple overview of tasks and de-tails that have occurred and the remaining tasks to be accomplished.

Refreshing the Task ListThe Refresh button updates the display of workflow tasks. For example, if a new Task is added since the windowwas first opened, clicking the Refresh button checks the database and updates the My Tasks pane with the currentactive tasks.

Working with VUI Workflow

30 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. VUIGF-2018.1

Page 35: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

XML Handling forFrameMaker Processing

Since FrameMaker does certain non-standard things to XML output, the VUI for FrameMaker does some post pro-cessing of the XML. This processing consists of the following tasks:

• Removal of spaces surrounding attributes. While this is legal XML, Vasont expects to see attributes likeMyAttribute=“My attribute value”. But FrameMaker adds spaces around the equal sign like MyAttribute =“My attribute value”.

• Removal of embedded Vasont processing instruction. On extract, Vasont places a processing instruction afterthe doctype and before the first element. It uses this instruction to identify Vasont content during loads. Unfortu-nately, FrameMaker moves this PI inside the first element. If that element has text, the PI will become part of theelement text when loaded into Vasont. To avoid this occurrence, the Vasont PI is removed prior to load.

• Removal of element line breaks. FrameMaker inserts line breaks between element tags. Not only does this addto the size of XML files, it also changes the tracked parent text for any elements that are untracked in Vasont.VUI removes line breaks between elements prior to loading.

• Removal of relative path names in attributes. Vasont can optionally shorten path names in attributes. Frame-Maker will add relative path names to file names in attributes if that included file is not in the same folder as theXML file (such as graphic files).

• Conversion of Unix path delimiters to Windows path delimiters. FrameMaker always outputs paths as Unixstyle paths (ex: C:/docs/graphics). Vasont can optionally change those paths to Windows style (ex: C:\docs\graphics).

• Removal of leading capital from attribute names. FrameMaker always outputs attribute names in camel case(Attribute not attribute) regardless of the case of the incoming XML. Vasont can optionally force attributenames to lowercase.

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. 31

Page 36: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

XML Handling for FrameMaker Processing

32 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. VUIGF-2018.1

Page 37: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Working with DITA in VUIAs Darwin Information Typing Architecture (DITA) becomes more popular, the need for editorial tools which sup-port the unique features are necessary. This section explains various methods the VUI offers for DITA authoring.

Using DITA Conref Links in VUISelect the Create Conref menu choice from the Vasont menu in the editor to create a conref.

The Pick from Vasont - conref wizard appears allowing you to select a collection. The wizard provides two meth-ods for selecting the content you want to conref.

• Filter by primary. Pick component from a tree view of primary components. Components with a green check-mark may be selected as a conref. Those marked with a red X are not available for selection as a conref.

• Filter by component type. Pick components from a list of components.

After selecting a collection, the wizard determines if there are any saved queries available for that collection. If thereare, the wizard allows you to select a query and modify the criteria. Otherwise, you are taken directly to a navigatorfor the selected collection.

Select a component in the Pick from Vasont - conref wizard and click Finish to create a conref. A dialog box ap-pears once the conref is successfully added.

• When filtering by primary, the navigator displays a tree view of possible conref primaries. Only a limitedamount of text is displayed in the Pick from Vasont - conref wizard. Click Show Full Text to display all textwithin the full text viewer. Click Hide Full Text to hide the text viewer.

• The text search at the bottom left corner of the Pick from Vasont - conref wizard allows you to perform a case-insensitive search for text within all components of the navigator tree. Once the selection is found, the full text ofthat component is highlighted in the full text viewer.

• Press the search button repeatedly to find the next component containing the text specified in the search. Thesearch continues until no more components are found and stops once at the bottom of the navigator tree.

Using DITA Href Links in VUISelect the Pick DITA href link from the Vasont menu to insert an href attribute. This method does not actuallyextract the referenced file from Vasont and they will not normally display while editing.

The Pick from Vasont - href wizard allows you to browse through Vasont collections and insert a reference to anyVasont component as an href attribute. The format of the attribute's value uses the standard DITA syntax: File-Name#RootReference/ComponentReference.

Example: If the selected component's primary client key is v12345 and the selected component client key is v789,then the inserted href would be v12345.xml#v12345/v789.

If the selected component is a primary component in Vasont, then the attribute value again follows DITA conven-tion—only the file name is used.

Example: If the selected component is a primary and its client key is v12345 then the inserted href would bev12345.xml.

Exceptions: Vasont cannot insert an attribute where one is not allowed. This means that if an href attribute is notvalid for an element, then Vasont disables the menu choice or prevents its functioning.

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. 33

Page 38: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Vasont uses a different method for inserting an href in an image tag. The image tag is special in that it needs to havethe href file actually exist on the hard drive for it to display. To pick an image href from Vasont, users should selectthe Pick From Vasont menu choice, which creates the href and places the actual image file on the local drive.

Using DITA Xref in VUISelect the Insert DITA Xref menu choice from the Vasont menu to create an Xref.

Upon selection, the Insert DITA Xref uses the Pick from Vasont - href wizard. An Xref is first created at thedesired location and an href value is also added at the target location.

Exceptions: Vasont cannot insert an attribute where one is not allowed. This means that if an Xref attribute is notvalid for an element, then Vasont disables the menu choice or prevents its functioning.

Open Image Pick ListAn image may be copied onto the Windows clipboard and inserted into an XML file. Select Open Image Pick Listfrom the Vasont menu. Once selected, the Pick Image wizard appears allowing you to choose a default image filteror modify select conditions to find the desired image. Once the image is retrieved, a thumbnail or larger image viewis available. Select copy on the desired image to copy into your Windows clipboard. The image is then available forinsertion using the Paste Image menu option. See Paste Image Using VUI

Paste Image Using VUISelect Paste Image from the Vasont menu to insert an image into your file using VUI. Once the select image iscopied onto your clipboard, the image along with its associated tags is inserted at a valid point into your file.

If the user attempts to insert an image element at a location which it is not permitted, an error message appears.

Working with DITA in VUI

34 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. VUIGF-2018.1

Page 39: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

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, Authorand Screenwriter could be aliases for a raw component named Writer. Aliasespromote content reuse since the content is stored once regardless of which aliasis used.

Analyze A right-click option that may be performed on a component in Vasont. The com-ponent is validated against the rules that have been established in the VasontAdministrator for this type of component.

Annotation Textual information and/or multimedia attachments associated with any collec-tion-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 al-low values to be passed to the programming code to make the processing optionbehave 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 collec-tions in the Vasont Administrator.

Attributes An additional piece of information for a component. This includes attributesfrom a DTD, but can also be metadata attributes that are strictly used by Vasontfor special behaviors.

Batch Update A utility that allows an operation to be run against to many different componentsin 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 componentsare stored in Vasonts BLOBs.

Bookmarks A shortcut to find information. A right-click option in Vasont navigator that al-lows 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 wascreated.

Branch Label A label that is assigned to a Branch when it is created. It identifies the Branchwhen 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 iscopied for a Branch. It signifies that the original pointee is the source of a newBranch, and that the owner of the pointer may want to review the content anddetermine 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 con-tains 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 contentthat they have had checked out.

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. 35

Page 40: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Check Out A right-click option in Vasont navigator that allows a user to lock down contentthat they are currently editing or modifying. No other user can update the con-tent 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 useof comments left by Reviewers. An Editor accepts or rejects the Reviewers com-ments and marks up the content as necessary. When the editorial phase is com-pleted 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 acomponent's version. These notes help to define instructions or informationabout 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 orloading 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 contentcomponents 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 pri-mary component in a collection. This ownership restricts other users from mak-ing any alterations to the component and its descendants.

Content Types A set of related Vasont collections that share the same raw components, attrib-utes and wrappers.

Create New A right-click option in the Vasont navigator that allows a user to add new com-ponents to the database.

Draft Status Components that have a yellow pencil icon. These components have been al-tered after being approved.

Dynamic Indexes Index collections that are maintained dynamically with an associated compo-nent(s) in another collection. For example, a Book collection may contain thenames of several Authors. An Index collection may be created from the Bookcollection of the Authors and the Books where they appear.

Edit View The definition for creation, display, processing, and manipulation of content orentities 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 CollaborativeReview.

Events Intervals in the programming code that allow for the insertion of Vasont pro-cessing 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 orXML file. This is done in the Vasont Administrator.

Glossary

36 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. VUIGF-2018.1

Page 41: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Global Change Vasont's ability to identify all instances where a component is used, and if nee-ded, change the content for all uses, some uses, or no uses when an update oc-curs. Implicit reuse facilitates global change.

Granularity The level at which data is stored in Vasont. A very detailed configuration willstore and track a large number of the elements from the DTD, where a less de-tailed configuration would store data in larger chunks and track fewer compo-nents.

Graphic Workflow A graphical representation of a workflow project. It may also be used to create anew 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 theflow.

Helper Applications Applications that are used to view and update multimedia data that is stored inVasont. For example, Acrobat Reader, Microsoft Word, etc.

Incomplete Status A component that is flagged with a red exclamation icon. This means that thecontent 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. Thegraphic is inline.

Load View The defined structure and special processing that is expected when loading con-tent into a Vasont collection. Defined in the Vasont Administrator.

Match Criteria The method that Vasont uses to determine whether a component being loaded, isnew or changed. Methods include text, Client Key, or both.

Modular Content Content that is separated into meaningful chunks and stored in separate collec-tions in Vasont. For example, sections may be stored separately from the chap-ters. Pointer components in the chapters reference the sections. When the chap-ter is extracted to an XML file, the sections are pulled and positioned in thechapter XML as indicated. This concept allows for reuse of the sections in mul-tiple chapters or documents.

Multimedia Component A component that stores data that is in a special format, see BLOB. For exam-ple, EPS, PDF, Microsoft Word, etc.

Navigator A window that allows the browsing of stored content in a collection using hier-archical tree views.

Navigator Order The order in which Vasont expects to see the components. Usually based on theDTD'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 informa-tion about content to which they have subscribed. For example, changes to con-tent where Variant relationships have been created, and events related to work-flow 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 with-out 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 pro-vide explicit reuse.

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. 37

Page 42: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Preview A tab in the Vasont Navigator's Details Pane which shows a styled view of theselected primary component. This view makes it easier to read and evaluate thecontent 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 collectionwill 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 asadd, delete etc.

Processing Option Reusable programming code that is used to customize client business logic inVasont. Vasont has over 600 pre-built reusable processing options that can beapplied 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; viewprojects due within a range of dates; view projects for specific collections. AGantt chart provides a visual display of the progress of the projects.

Raw Class Raw components are broken into three classes, text, pointer or multimedia. Eachclass has a unique feature that allows the component to behave in a specificmanner 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 com-pared to elements in a DTD. They are defined in the content type and can beused to build multiple collections.

Raw Material Available components that may be utilized in the construction of one or morecollections.

Referenced By A right-click option in Vasont navigator that lists other components that may belinked to the current component by a pointer component. Components that arereferenced more than once are being reused.

Refine A Refine query is used after a Vasont Navigator is populated with a Retrievequery. The Refine query further reduces the number of primary components inthe navigator by using additional query criteria. The criteria can be applied tothe same collection or a related collection.

Reinstate The process of taking a previous version of the content and reactivating it as ac-tive 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 dis-played 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 theReviewers, 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' sugges-tions 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.

Glossary

38 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. VUIGF-2018.1

Page 43: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Rule Relation The relationship between a component and it's parent. For example, when aPARAGRAPH 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 aVasont Navigator window for collection content.

Stranded Components Components that may have been corrected and need special processing to becancelled.

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 containstags for the individual elements, the document can be consistently composed,searched, or broken into subdocuments. The tags may also contain attributes thatprovide 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 theauthority to oversee the entire configuration. The privilege allows the user fullrights and access to all collections and features in the Vasont Administrator. Thesuper administrator decides who the associate administrators will be and assignsthem 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 win-dow, 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 compo-nents. For example, Paragraph or Body.

Tools See Utilities.

Translation Project Window A Vasont extension that allows you to track due dates, vendors, and status infor-mation for each language subproject. Content can be submitted for quote ortranslation directly from this window. Translation reuse is also tracked from thiswindow.

Unstructured data Electronic data without meaningful tags or markers for the individual pieces oftext. Some examples of unstructured data would be Microsoft Word or Excelfiles, and PDFs.

User A user is an assigned login and password for an individual to gain access to thesystem.

User Navigator The window in the Vasont Administrator that controls the rights and privilegesfor users in Vasont.

Utilities Programs that provide system tasks or functions in an automatic work savingfashion.

Valid Values One or more values that are acceptable for a component or attribute. Define inthe Vasont Administrator

Variants Relationships that are maintained in Vasont between two or more separate con-tent instances.

Vasont Administrator The setup software tool for Vasont.

Version History The historical data related to a collection.

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. 39

Page 44: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Version On Demand The process of creating a version for the selected content at a point in time that auser 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 func-tionality 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 infor-mation 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 process-ing option, raw component, attribute, or wrapper may occur for a specific collec-tion or a content type. In Vasont, a list showing where the exact same content isused 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 inworkflow.

Working Collection The collection that a user is automatically logged into in Vasont because it is setas default collection.

Wrappers Wrappers link SGML/XML tagged data to components. By having wrappers,Vasont can store a tag <p> once and reuse it thousands of times.

Glossary

40 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. VUIGF-2018.1

Page 45: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

AAbout Vasont, 2Active Content, 35Aliases, 35Analyze, 12Analyzing, 35Approve, 12Approve Delete, 12Approved Status, 35Arguments, 35Associate Administrators, 35Attributes, 35

BBatch Updates, 35BLOBs, 35Bookmarks, 35Branching, 35

label, 35notices, 35notification, 35

CCheck In, 11Check Out, 11Check Out Info, 11Checking In, 35Checking Out, 36Client Keys, 36Clone, 36Collaborative Reviews, 36Collections, 36

accessing, 36groups, 36

Comments, 36Components, 11, 12, 13, 14, 15, 23, 26, 36

analyzing incomplete, 12approving, 12approving deletions, 12checking in, 11checking out, 11checking references to, 15checking usage, 14cloning, 26creating from templates, 23deleting, 12displaying check out info, 11displaying virtual view, 11expanding all, 14finding, 13

FrameMaker Actions, 11moving, 26viewing, 11viewing variants, 15

Composite Extracts/Loads, 36Conrefs, 33Content, 35

active, 35Content Models, 36Content Navigator, 36Content Owners, 36Content Ownership, 6Content Types, 36Create Conref, 33Create New, 36Create New From Template, 23

DData, 39

structured, 39unstructured, 39

Deleting, 12Disconnect From Database, 21Display Virtual View, 11DITA, 33Draft Status, 36Drag and Drop, 26Dynamic Indexes, 36

EEdit Views, 36Editors, 36Events, 36Expand All, 14Extract Views, 36Extracting, 16

FFilters, 8Find, 13FrameMaker Actions, 11

GGlobal Change, 37Global Clone, 17Granularity, 37Graphic Workflows, 37

HHelper Applications, 37Hrefs, 33

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. 41

Page 46: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

using with DITA, 33

IIcons, 10

navigator, 10Incomplete Status, 37Inline Components, 37Insert DITA Xref, 34

LLoad Views, 37Loading Data, 19

into Vasont, 19Logging In, 5

MMatch Criteria, 37Modular Content, 37Moving, 26

components, 26Multimedia Components, 37

NNavigator, 16, 37

opening new, 16order, 37

Navigator Controls, 18, 19find, 19hide preview, 18print, 19show preview, 18

Navigator Window, 7, 10, 11, 12, 18, 19icons, 10opening, 7opening content, 19pop-up menu, 11preview pane, 18refiltering the contents of, 12refreshing, 12searching for content, 18

New, 11Notifications, 37

OOpen Image Pick List, 34Open In New Navigator, 16Open Update, 37Open View, 37Opening, 7

navigator, 7

PPasswords, 6

expired, 6Paste Image using VUI, 34Pick DITA Href Link, 33Pick From Vasont, 24Pointee Components, 37Pointer Components, 37Pop-Up Menus, 11

navigator, 11Previews, 38Previous Versions, 38Primary Components, 38Privileges, 38Processing Options, 38Projects, 38

management, 38

RRaw Classes, 38Raw Components, 38Raw Material, 38Redline Report, 17Referenced By, 15, 38ReFilter, 12Refining, 38Refresh, 12Reinstate, 38Reports, 38Retrieving, 38Reviews, 38

coordinator, 38reviewers, 38

Roles, 38Rule Relations, 39

SSave as Disk File, 16Saving, 16

XML files, 16Searching, 39Security, 6Shadow History, 39Signing On, 5Stranded Components, 39Styles, 39Sub-components, 39Super Administrators, 39

TTasks, 39Technical Support, 2Text Arguments, 39Text Components, 39Tools, 39

42 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. VUIGF-2018.1

Page 47: Vasont Universal Integrator Guide · 2018-03-12 · only typical content management features, but content processing as well. Vasont is an Oracle-based content man-agement database

Topic Uses, 18Translations, 39

UUndo Delete, 12User Navigator, 39Users, 39Utilities, 39

VValid Values, 39Vasont Administrator, 39Vasont Database, 19

updating, 19Vasont Navigator, 7

opening, 7Versions, 17, 40

on demand, 40View, 11View Headers, 40View Variants, 15Views, 40VUI, 2, 5

about window, 2logging in, 5signing on, 5version information, 2

WWhere Used, 14, 40Workflow, 29, 30

accessing, 29completing tasks, 30extracting content, 30refreshing tasks list, 30viewing content, 29workflow graphic, 30

Workflows, 40Workgroups, 40Working Collections, 40Wrappers, 40

XXML Files, 16

saving, 16Xrefs, 34

using with DITA, 34

Vasont Universal Integrator Guide

VUIGF-2018.1 CONFIDENTIAL © 2018 TransPerfect Translations International Inc. 43