Download as pdf or txt
Download as pdf or txt
You are on page 1of 113

TechSight/X CMS ATA User

Guide for Authors, version 5.10


2 | OpenTopic | TOC

Contents
Overview of the TechSight/X CMS ATA Document Authoring Process........................................................... 4
Manual Support by Fleet.......................................................................................................................... 4
About the TechSight/X CMS ATA System............................................................................................. 6
About Documentum..................................................................................................................... 7
Manual Revision Cycles...............................................................................................................7
Configuring and Starting TechSight/X CMS ATA Client................................................................................... 9
Start TechSight/X CMS ATA.................................................................................................................. 9
Log in to TechSight/X CMS ATA........................................................................................................... 9
Set TechSight/X CMS ATA Preferences............................................................................................... 10
Launch the TechSight/X CMS ATA Preferences Dialog.......................................................... 10
Applications for Editing and Viewing....................................................................................... 11
Client/Server Communication Configuration............................................................................ 12
Conflict Configuration Tab........................................................................................................ 13
General Preferences....................................................................................................................13
Getting Started with the TechSight/X CMS ATA Client Interface................................................................... 15
TechSight/X CMS ATA Interface Panes............................................................................................... 15
TechSight/X CMS ATA Object Icons................................................................................................... 16
Toolbar................................................................................................................................................... 16
Using Navigation Tabs.......................................................................................................................................18
Search Manuals...................................................................................................................................... 19
Common Search Attributes........................................................................................................ 21
Conflict Tab............................................................................................................................................22
Draft Tab................................................................................................................................................ 23
Approved Tab.........................................................................................................................................24
TR Tab....................................................................................................................................................27
Inbox Tab............................................................................................................................................... 27
Editing a TechSight/X CMS ATA Manual Fragment........................................................................................29
Authoring Options..................................................................................................................................30
Previewing a Fragment...........................................................................................................................32
Preview a Fragment....................................................................................................................32
Create a Draft............................................................................................................................. 32
Checkin and Checkout of a Draft........................................................................................................... 33
Delete a Draft............................................................................................................................. 33
Check-in an Object.....................................................................................................................34
Configuring the XML Editor..............................................................................................................................35
Configure Arbortext............................................................................................................................... 35
Configuring XMetaL for TechSight/X CMS ATA................................................................................ 37
Authoring Changes in a Manual.........................................................................................................................39
Using Effectivity.................................................................................................................................... 39
Insert EFFECT tag..................................................................................................................... 40
Manual Effectivity by Tail Number........................................................................................... 41
Insert a Graphic...................................................................................................................................... 42
Insert a Sheet.......................................................................................................................................... 43
Insert REFINT and GRPHCREF Elements........................................................................................... 45
Insert a REFEXT Element......................................................................................................................45
Insert a REFGEN Element..................................................................................................................... 46
Creating New Anchors........................................................................................................................... 47
Anchors by Doctype...................................................................................................................47
Insert a New Child......................................................................................................................48
Insert a REFEXT Element..........................................................................................................48
Insert a SUPPLEMENT Element............................................................................................... 49
OpenTopic | TOC | 3

Creating New Anchors........................................................................................................................... 51


Task-Based Anchors (AMM, EM, FRMFIM)........................................................................... 51
Insert New SECTION Tags........................................................................................................54
Insert New SUBJECT or UNIT Tags.........................................................................................55
IPC Anchor Elements.................................................................................................................56
Using Global Data Manager.......................................................................................................57
Understanding Fragment Copy.................................................................................................. 63
Reusing Content......................................................................................................................... 64
Reconciling OEM Revisions...................................................................................................... 67
Using Graphics........................................................................................................................... 68
Resolving Conflicts.................................................................................................................... 70
Using Temporary Revisions (TRs)............................................................................................ 78
Authoring Equipment and Wire Lists Manuals..........................................................................90
Deactivating and Reactivating an Editable Fragment.......................................................................... 101
Deactivate a Child Element......................................................................................................101
Reactivate a Child Element...................................................................................................... 101
Validating Links................................................................................................................................... 102
Validate Links.......................................................................................................................... 103
Validating and Approving Fragments................................................................................................. 104
Validate a Fragment................................................................................................................. 104
Submit for Approval.................................................................................................................107
Revert to Manufacturer Versions............................................................................................. 109
View Object Attributes.............................................................................................................110
Manually Controlling Page Breaks During Publish............................................................................. 111
Insert a Point Page Section.......................................................................................................112
Insert a Blank Page...................................................................................................................112
4 | OpenTopic | Overview of the TechSight/X CMS ATA Document Authoring Process

Overview of the TechSight/X CMS ATA Document


Authoring Process
This guide describes the TechSight/X CMS ATA document authoring functions used to author and update ATA
manuals. The intended audience for this document is authors. Users interested in installation, configuration, and
system administration of the TechSight/X CMS ATA system should refer to the TechSight/X CMS ATA Installation
Guide. Users who want to learn about document administration in ATA manuals, refer to the TechSight/X CMS ATA
User Guide for Document Administrators .
This guide describes the TechSight/X CMS ATA document authoring functions used to author and update FlightOps
manuals. The intended audience for this document is authors. Users interested in installation, configuration, and
system administration of the TechSight/X CMS ATA system should refer to the TechSight/X CMS ATA Installation
Guide. Users who want to learn about document administration in FlightOps manuals, refer to the TechSight/X CMS
ATA User Guide for Document Administrators .

Manual Support by Fleet


TechSight/X CMS ATA supports a large number of fleets and manuals. For each fleet, TechSight/X CMS ATA
supports the following manuals.

Table 1: Manual Name Abbriviations

Manual Name Manual Name Abbreviation


Aircraft Illustrated Parts Catalog AIPC
Aircraft Maintenance Manual AMM
Aircraft Wiring List AWL
Boeing Fault Isolation Manual BFIM
Engine Cleaning, Inspection, and Repair CIR
Components Maintenance Manual CMM
Corrosion Prevention Manual CPM
Engine Illustrated Parts Catalog EIPC
Engine Manual EM
Electrical Standard Practices Manual ESPM
Flight Crew Operating Manual FCOM
Fault Isolation Manual FIM
Fault Reporting Manual Fault Isolation Manual FRMFIM
Heavy Maintance Manual HMM
Illustrated Tool and Equipment ITEM
Non-Destructive Testing Manual NDT
Ramp Maintenance Manual RMM
Service Bulletin SB
System Description Section SDS
Service Manual SM
OpenTopic | Overview of the TechSight/X CMS ATA Document Authoring Process | 5

Manual Name Manual Name Abbreviation


Standard Practices Manual SPM
Structural Repair Manual SRM
System Schematic Manual/Aircraft Schematic SSM/ASM (Boeing/Airbus)
Manual
Standard Wiring Practices Manual SWPM
Troubleshooting Manual TSM
Wiring Diagram Equipment List WDEL
Wiring Diagram Manual/Aircraft Wiring Manual WDM/AWM (Boeing/Airbus)

727
AIPC, AMM, WDM

737-300/400/500
AIPC, AMM, SDS, SRM, SSM, WDM

737-600/700/800/900
AIPC, AMM, FRMFIM, SDS, SRM, SSM, WDEL, WDM

747-100/200/300
AMM

747-400
AIPC, AMM, FRMFIM, SRM, SSM, WDM

747-SP
AMM

757
AIPC, AMM, BFIM, SRM, SSM, WDEL, WDM

767
AIPC, AMM, BFIM, SRM, SSM, WDM, WDEL

777
AIPC, AMM, FRMFIM, SRM, SSM, WDM

A300-600
AMM, AWL, IPC, SRM, SSM/ASM, WDM/AWM

A310
AMM, ESPM, IPC, SSM/ASM, WDM/AWM

A320
AIPC, AMM, ASM, AWL, AWM, ESPM, SRM, SSM, TSM, WDM

A330
AIPC, AMM, ASM, AWL, AWM, ESPM, SRM, SSM, TSM, WDM
6 | OpenTopic | Overview of the TechSight/X CMS ATA Document Authoring Process

A340
AIPC, AMM, SRM

MD10
AIPC, AMM, WDM/

MD11
AIPC, AMM, FRMFIM, SSM, WDM

MD12
Task Cards

MD80
AIPC, AMM

MD90
AIPC, AMM, SSM, WDM

DC10
AIPC, AMM, WDM

Boeing (across all fleets)


SWPM

Airbus (across all fleets)


ESPM

GE engine
EIPC, EM, HMM, ITEM, SB, SPM

PW engine
CIR, CMM, EIPC, EM, OP & CS, SB, SP & PM, SPM, TLM

Rolls Royce/Trent
CMM, EIPC, EM, Omat, SB, SPM, TLM

EMB-170
AMM, CPM, FIM, IPC, NDT, RMM, SRM, SSM/ASM, SWPM, WDM/AWM

About the TechSight/X CMS ATA System


TechSight/X CMS ATA is the TechSight/X Suite tool that authors XML-based airline maintenance manuals. The
system integrates a Documentum document repository with the latest XML editors from XMetaL and Arbortext, and
provides the foundation for information management for FAA compliance, based on ATA standards.
TechSight/X CMS ATA is the TechSight/X Suite tool that authors XML-based airline flight operations manuals. The
system integrates a Documentum document repository with the latest XML editors from XMetaL and Arbortext, and
provides the foundation for information management for FAA compliance, based on ATA standards.
TechSight/X CMS ATA functionality includes:
• Importing, validating, bursting, and categorizing Manufacturer (MFR) data for ATA manuals
OpenTopic | Overview of the TechSight/X CMS ATA Document Authoring Process | 7

• Managing full and incremental revisions


• Supporting ATA file exchange standards (SGML, and so on)
• Supporting paper scanning and catalogs
• Providing a full authoring environment for manual creation and revision updates
• Producing appropriate renditions of information (XML, PDF, SGML, and so on)
• Providing a publish/release mechanism independent of a Documentum document repository
• Importing, validating, bursting, and categorizing data for FlightOps manuals
• Managing full and incremental revisions
• Supporting paper scanning and catalogs
• Providing a full authoring environment for manual creation and revision updates
• Producing appropriate renditions of information (XML, PDF, SGML, and so on)
• Providing a publish/release mechanism independent of a Documentum document repository

Using the TechSight/X CMS ATA Interface


TechSight/X CMS ATA, the primary user interface for authoring, is Windows-based and provides tree-based
navigation based on the XML structure of documents within a docbase, Documentum's document repository. In
addition to several other features, TechSight/X CMS ATA provides tabs that allow you to easily get the results of
queries commonly used during the authoring process.
TechSight/X CMS ATA is designed to easily integrate with an XML editor. This tight integration currently is
available with JustSystem, Inc.'s XMetaL Editor and PTC's Arbortext Editor. If an editor integration is not available
for a particular editor, or if an airline does not want the integration for a particular customer, then TechSight/X CMS
ATA can act as a standalone application. Regardless of the integration, the tools and functionality of the TechSight/X
CMS ATA interface remain the same.
All the details about authoring in TechSight/X CMS ATA are covered in the TechSight/X CMS ATA User Guide
for Authors. TechSight/X CMS ATA's interface is primarily an author's interface. It also provides access to the
TechSight/X CMS ATA Admin tool (hereafter called the Admin tool) for users assigned the Document Administrator
role.

About Documentum
The TechSight/X CMS ATA system works in conjunction with a document management system developed by
Documentum. Documentum is the repository where both the manufacturer and airline versions of ATA manuals are
stored. Documentum is also the mechanism that provides role-based security in the TechSight/X CMS ATA system.
The user ID received for TechSight/X CMS ATA is the user ID that has been defined for the user in Documentum.
TechSight/X CMS ATA provides a front-end to the Documentum repository. The Documentum system uses some
terms that are also used in TechSight/X CMS ATA. This section describes some of those terms.
Documentum is an object-oriented system. TechSight/X CMS ATA manuals are burst into fragments before being
stored in Documentum. The fragments are what an author modifies when editing information using TechSight/
X CMS ATA. Each fragment is stored as a Documentum object. The object might have many versions, and each
version has a specific security level and a set of attributes that you can use for searching. The attributes define how
TechSight/X CMS ATA finds related objects and determine who can do what to each object based on its security.
The attributes stored on each version of an object also store information about who modified the object and why. This
makes it possible for TechSight/X CMS ATA to find the history of different fragments. TechSight/X CMS ATA can
also restore fragments as they were at some point in a past release.
There is an Attributes menu item on the TechSight/X CMS ATA interface that allows you to look at many of the
relevant attributes of an object, but in most cases TechSight/X CMS ATA sets the values for these attributes based on:
the login, data in the XML file, and other system information.

Manual Revision Cycles


The following figure shows the flow of an ATA-2200 SGML manual as it is imported, modified by an airline author,
published, and finally released through the airline's viewing medium. TechSight/X CMS ATA supports importing
SGML temporary revisions (TRs) between major manufacturer release cycles.
8 | OpenTopic | Overview of the TechSight/X CMS ATA Document Authoring Process

The flow of a manual proceeds as follows: it is imported, modified by an airline author, published, and finally
released through the airline's viewing medium.
The TechSight/X CMS ATA Document Administrator (Docadmin) handles the Import, Publish, and Release
functions. The TechSight/X CMS ATA Technical Writer is responsible for all of the details pertaining to the
authoring process.

TechSight/X CMS ATA Manual Revision Terminology


The manufacturers who produce the original documentation have traditionally done so on a revision cycle that is
based on periodic releases. This 3, 4, 6, or 12 month cycle constitutes a new revision level for the manufacturer's data
set. ATA-2200 calls this revision level the Transmittal Sequence Number, or TSN. TechSight/X CMS ATA has its
own revision levels which do not necessarily correspond to the manufacturer's.
Updates to FlightOps manuals occur as they are needed, usually for safety reasons.
TechSight/X CMS ATA manuals go through various states before you can release them for public viewing. The
TechSight/X CMS ATA manual states are as follows:

Table 2: Manual States and Descriptions

State
Description
IMPORTED
The manual has been successfully imported from manufacturer data. After a manual has been imported, then
the airline authors can go into TechSight/X CMS ATA and make changes.
PUBLISHED
The manual is exported. Any approved fragments are included in the Publish.
Fragments that are imported from MFR data or approved by an airline author after the Publish do not appear
in the released manual.
You can do as many publishing operations as needed before you Release a manual.

RELEASED
The manual is released for public viewing.
OpenTopic | Configuring and Starting TechSight/X CMS ATA Client | 9

Configuring and Starting TechSight/X CMS ATA Client


The primary authoring interface into the TechSight/X Suite system is through a desktop application called TechSight/
X CMS ATA. This chapter describes how you start TechSight/X CMS ATA and log in to the TechSight/X Suite
system. This chapter also describes the basic configuration of the TechSight/X CMS ATA application so that it can
connect to the correct server, launch an editor on your local machine, and provide you with some diagnostic tools.
See Getting Started with the TechSight/X CMS ATA Client Interface on page 15 to learn about navigating and
authoring within the TechSight/X CMS ATA system.
Note: This topic assumes that the TechSight/X Suite
server component is installed, configured, running, and
reachable on the network before a TechSight/X CMS ATA
client is connected to it. Start up and configuration of the
server component are described in the TechSight/X CMS
ATA Installation Guide.
You can start TechSight/X CMS ATA through the Start menu or by starting the XML editor integrated with
TechSight/X CMS ATA.

Start TechSight/X CMS ATA


After TechSight/X CMS ATA is installed on the client workstation, a shortcut is available in the Windows StartStart
menu to launch TechSight/X CMS ATA. The default setup places this in the standard Programs menu. If your IT
department modified the startup location, then you must find out where it is and launch TechSight/X CMS ATA from
there. The figure below shows the TechSight/X CMS ATA program group with the TechSight/X CMS ATA launch
application highlighted. TechSight/X CMS ATA Admin is used by the Document Administrator to manage manuals
within the TechSight/X CMS ATA system; it is not used for authoring changes to the manuals.

1. Click the Start menu.


2. Go to Program Files.
3. Click TSX CMS ATA Author to start the TechSight/X CMS ATA.

Figure 1: TechSight/X CMS ATA Launch Menu

Log in to TechSight/X CMS ATA


To log in to TechSight/X CMS ATA you must have a user ID to the Documentum docbase where the ATA manuals
are stored. The system administrator provides user names.

1. When you open TechSight/X CMS ATA, you are prompted for a user name and password. You can also log in by

clicking the Login/Logoff icon if TechSight/X CMS ATA is already running.


The login window displays:
10 | OpenTopic | Configuring and Starting TechSight/X CMS ATA Client

2. Enter a user name and password.


3. Click OK.
After a successful log in, the Navigate tab in TechSight/X CMS ATA opens with a view of the fleets in the
TechSight/X CMS ATA repository.
4. Click the Login icon again to log out.
Note: TechSight/X CMS ATA keeps the logged in
mode active until you log out or shut down the computer.
This minimizes the number of times you have to log
in to TechSight/X CMS ATA. This is a convenient
feature from a user perspective, but the logged in mode
continues even when the TechSight/X CMS ATA
client is not running, allowing another user to launch
TechSight/X CMS ATA and author documents under
your login. Log off from TechSight/X CMS ATA
whenever you close it to ensure no other users work
under your login.

Set TechSight/X CMS ATA Preferences


You must set TechSight/X CMS ATA editing preferences correctly for the following reasons:
• TechSight/X CMS ATA associates certain file format types to certain applications much like Windows does.
For example, Windows knows to associate a file with a ".doc" extension with Microsoft Word. You can specify
alternate tools to "Open With", but there is only one default action. The concept in TechSight/X CMS ATA is
similar, however, TechSight/X CMS ATA allows you to pick separate viewing and editing applications. For
example, you can configure TechSight/X CMS ATA to edit an XML document with a specific XML editor and to
view it with Internet Explorer. You must know where these applications are installed on your computer to set the
features correctly. This feature was set during TechSight/X CMS ATA installation. The procedure for associating
format types to applications is described below.
• The client communicates with the TechSight/X CMS ATA server using a server name and port created by the
system administrator during installation.
• There are other preferences that tell the client where and how to store things on the local computer. These
configurations are generally set up for you by the TechSight/X CMS ATA installation script and there is typically
no reason to change them.

Launch the TechSight/X CMS ATA Preferences Dialog


Use the TechSight/X CMS ATA preferences dialog to associate file types, set client communications, and set other
preferences.
1.
Click the preferences icon to launch the Preferences dialog.
The Preferences dialog appears.
OpenTopic | Configuring and Starting TechSight/X CMS ATA Client | 11

2. Select the tab you want to set preferences in.

Applications for Editing and Viewing


The Formats tab is the most important preference to set from an author's perspective. This tab controls which
application is launched when a fragment is "viewed " or "edited" in TechSight/X CMS ATA. When TechSight/X
CMS ATA is installed, the default preferences are CGM, TIFF, XML, HTML, and PNG. These formats are generally
set as follows:

Table 3: Editing and Viewing Applications

File Type Editing Applications Viewing Applications


XML Arbortext Editor or XMetaL Internet Explorer
CGM Micrografx Designer, Visio, or Internet Explorer or CGM
some other application that can viewer
read and write CGM
TIF Paintshop Pro, Ulead Internet Explorer or TIF
PhotoImpact, or some other viewer such as the Kodak
application that can read and Image Tool
write TIF files
HTM NA Internet Explorer or HTML
viewer
JPG Joint Photographic Experts NA
Group (ISO). A format for
storing/compressing high-
quality color and grayscale
photographs in bitmap form.
PNG Portable Network Graphics NA
bitmap (filename extension).

Note:
For more information on setting graphics formats see
Using Graphics on page 68.
Internet Explorer must have the appropriate plugins to
view TIF and CGM graphic files.

You can use the Preferences dialog to create new format types (for example, ".doc" for MS Word). This action
requires you to be an administrator on the system., however, this normally is done using other methods by the
administrator (see the TechSight/X CMS ATA User Guide for Document Administrators for more details).
12 | OpenTopic | Configuring and Starting TechSight/X CMS ATA Client

Figure 2: TechSight/X CMS ATA Preferences (Format Tab)

Client/Server Communication Configuration


The Communication tab is generally set by a system administrator and does not need to be changed unless the server
that you are connecting to has moved or the administrator has altered the service running on the server in some way.
If incorrect values are used, the connection to the TechSight/X CMS ATA server is lost.
The Public Key field is the publicly distributed portion of the public/private key encryption scheme used to
communicate to a TechSight/X CMS ATA server. Do not alter this key, unless you have very specific instructions
from an administrator. Keep this value private. Sharing this value could allow an unauthorized user to communicate
with the server. However, access to the user network, server, and port, as well as a user name and password would be
required before an unauthorized user could communicate with the server.

Figure 3: TechSight/X CMS ATA Preferences (Communication Tab)


OpenTopic | Configuring and Starting TechSight/X CMS ATA Client | 13

Conflict Configuration Tab


The Conflict tab determines if conflicts are displayed in a side-by-side comparison view (Single Instance), or as
separate fragments (Fragmented). This setting becomes the default for previewing conflicts from the TechSight/X
CMS ATA Conflict tab and in the XML editor. It does not affect how conflicts are previewed from the Navigation
tab.
The Conflict tab determines if conflicts are displayed in a side-by-side comparison view (Single Instance), or as
separate fragments (Fragmented). This setting becomes the default for previewing conflicts from the TechSight/X
CMS ATA Conflict tab and in the XML editor. It does not affect how conflicts are previewed from the Navigation tab
or the Inbox tab.
Choose one of the following options:
• Single Instance
• Fragmented

Figure 4: TechSight/X CMS ATA Preferences (Conflict Tab)

General Preferences
The General tab is primarily reserved for product development and debugging purposes. This feature is usually best
left for the system administrator to configure. You do not need to set these values during normal authoring.
Table 4: General Preference Settings
Feature Description
Launch Debug Window This feature presents a window that displays the
client/server communication that occurs when a
specific action is selected. This box is not checked
during normal operation.
14 | OpenTopic | Configuring and Starting TechSight/X CMS ATA Client

Feature Description
Show query results from cache (for each tab) if This option uses cached results when a query tab
exist is selected (for example, Conflict, Approved, and
TR tabs). This provides a faster user response,
but it also can provide out of date information.
Typically, this box is unchecked.
Remove working copy of file at check-in This deletes the local copy of a file when it is
checked in. Typically, this is selected so that there
is less clutter on your computer.
Check-out Directory Use this field to enable TechSight/X CMS ATA to
store files in another directory on your computer
when they are downloaded from the server for
editing. This setting defaults to the location where
TechSight/X CMS ATA is installed. The default
setting does not typically need to change.

Figure 5: TechSight/X CMS ATA Preferences (General Tab)


OpenTopic | Getting Started with the TechSight/X CMS ATA Client Interface | 15

Getting Started with the TechSight/X CMS ATA Client


Interface
TechSight/X CMS ATA is the primary user interface for authoring manuals within TechSight/X Suite. Just
like Windows Explorer is a browser helps you find and work with files in the Windows file system, so does the
TechSight/X CMS ATA browser help you to find and act on the various objects that make up manuals within
TechSight/X CMS ATA.
This chapter describes the basic features of the TechSight/X CMS ATA interface that you need to know to start
working with the manual fragments that are stored in the TechSight/X Suite repository. Later topics describe
advanced features that you need to know to edit fragments and to take full advantage of the TechSight/X CMS ATA
authoring environment.

TechSight/X CMS ATA Interface Panes


TechSight/X CMS ATA provides an upper pane called the Approved Pane. This pane displays all fragments that
either have been imported by the manufacturer, or fragments that have been modified or created and approved by the
airline.

Figure 6: TechSight/X CMS ATA Panes


>
16 | OpenTopic | Getting Started with the TechSight/X CMS ATA Client Interface

The lower pane is called the Draft Pane. When you edit a fragment selected from the Approved Pane, a draft of that
fragment is created by the TechSight/X CMS ATA system and displayed in the Draft Pane. An airline author can
only modify fragments after they have moved to a draft status. You must validate and approve draft fragments before
they can become viewable from the Approved Pane.

TechSight/X CMS ATA Object Icons


The Navigate tab is the most important window to access the manuals in TechSight/X CMS ATA. This tab provides
a way to navigate through all of the information stored in TechSight/X CMS ATA. This section describes the icons in
the Navigate tab.

Table 5: TechSight/X CMS ATA Object Icons

Icon Description
The Fleet object serves as a container for manuals.
There are no viewable attributes in a fleet object.
The Manual object serves as a container for all
fragments in the manual. It also stores as attributes
important information about each manual.
The Editable Fragment is an object that you can
edit or view. It also has many attributes that you
can view.
The Anchor elements are contained within an
editable fragment object. The anchor by itself is
not editable in these instances. These are used
for navigation, or to show the sub-components
within a fragment without editing or viewing the
fragment.
The Graphic object contains a graphical image.
You can only edit graphics when they are in the
Draft Pane. View or edit approved graphics by
selecting the appropriate action from the editable
fragment that contains the graphic.
The Green Check is placed on an editable
fragment that is currently in draft mode.
The red X is placed on an editable fragment with a
conflict that you must resolve manually.
The Lock on an editable fragment indicates a draft
object that is currently locked for editing. This
is done by "checking-out" the object from the
document management system.

Toolbar
The TechSight/X CMS ATA toolbar contains the options to perform actions on objects that are stored in TechSight/
X Suite. The toolbar uses icons to reduce the amount of space in TechSight/X CMS ATA. The smaller footprint
helps TechSight/X CMS ATA to run more quickly when embedded into an XML editor as an OCX. To find the
functionality of a menu, mouse over the icon and the tool tip text appears that describes the menu's function.
OpenTopic | Getting Started with the TechSight/X CMS ATA Client Interface | 17

Table 6: Toolbar

Icon Name Description


Login Click this button to log in or
out.

Options menu This menu is used for most


authoring-related tasks in both
the Approved Pane and the
Draft Pane.
TR Menu This menu is used for
managing SGML TRs that
have been imported into
TechSight/X CMS ATA. This
menu only becomes active
when a TR is selected.
Search This button launches a Search
dialog that you can use to
search for objects based on
their attributes or text.
Metadata This button launches the
Metadata dialog and displays
metadata for ITEM and PAGE.
Preferences This button launches the
Preferences dialog that you
use to configure various
aspects of the TechSight/X
CMS ATA application.
Admin menu This menu only appears
if your login is in the
document administrators
(docadmin) group. This feature
provides some shortcuts for
troubleshooting methods.
Help menu This menu displays the Help
Utility and TechSight/X CMS
ATA information.
18 | OpenTopic | Using Navigation Tabs

Using Navigation Tabs


The TechSight/X CMS ATA Navigate tab provides the traditional hierarchical navigation of a manual, but sometimes
you need a better way to find the data. TechSight/X CMS ATA gives you tabs that present different views of
fragments within the manual. These tabs are based on predetermined queries that group things together to provide a
more natural way of working with sets of data.
When you click a query tab, a set of objects to work with is returned, similar to working with objects that are
presented hierarchically. The query-based tabs are briefly explained in the following table.
Table 7: TechSight/X CMS ATA Navigation Tabs
Tab Description
Results Displays the results of a user-defined query.
Conflict Displays all objects that have been placed in
conflict during a manufacturer revision of a
manual. The objects disappear from this list as
conflicts are resolved and approved.
Note: Because
TechSight/X CMS
ATA, FlightOps Edition
does not support
temporary revisions,
the Conflict tab is never
populated.

Draft Displays all objects that have been placed in


conflict during a manufacturer revision of a
manual. The objects disappear from this list as
conflicts are resolved and approved.
Approved Displays all objects that have been modified and
approved since the last release of the manual.
TR Displays all TR objects in TechSight/X CMS
ATA. This includes both SGML TRs and TRs that
have been added as attachments.
Note: Because
TechSight/X CMS
ATA, FlightOps Edition
does not support
temporary revisions,
the TR tab is never
populated.

Inbox Displays all Change Requests with an acquired


and ready status for those fragments that are
managed within TechSight/X BPM. The Change
Requests are removed from this list after you
highlight the Change Request and selects: "submit
for approval", "revert to manufacturer version",
"accept airline deletion", or "keep manufacturer
deletion".
The Results, Conflict, Draft, Approved, and TR tabs display the results of a query performed on the objects in the
docbase. All of the query tabs depend on a specific fleet and manual being selected to determine the results that are
OpenTopic | Using Navigation Tabs | 19

displayed when the tab is selected. When you navigate to a specific fleet and manual, the tab automatically performs
the query on the manual set when the tab is selected.

Search Manuals
The Results tab is a special query tab that can perform user-specified queries. This tab is extremely powerful, but it
also requires a more detailed knowledge of what is occurring under the covers of TechSight/X CMS ATA. This tab
shows the results of a search that is initiated using the Search icon on the menu bar. The icon used to launch a search
is shown below.

Figure 7: Search Menu

Figure 8: Search Menu

1. Select the Search icon from the menu bar.


The Advanced Search dialog appears.
Note: The first three fragment attributes are separated
by the default And. You can override the default by
selecting Or from the drop-down list. When you insert
additional fragment attributes, you must also select either
And or Or in the And/Or column.
20 | OpenTopic | Using Navigation Tabs

Figure 9: Advanced Search dialog


2. Select a Fleet from the drop-down list.
3. Select a Manual from the list of manuals that appear for the selected fleet.
You can search multiple manuals by holding down the CTRL or SHIFT keys while selecting the manuals.
4. Select a fragment type from the Fragment Type drop-down list to search.
Select XMLXML to search for any text object. If you are searching for graphics, then select Illustration.
5. You can perform very specific searches by using the object's attribute values. It is beyond the scope of this guide
to list all of the attributes, however, a few of the common ones are described in Common Search Attributes on
page 21. Do the following to search by a specific attribute value:
a) Select a text box in the Attribute column. A drop-down list of many potential attributes appears that you can
use for searching.
b) Select the Operator depending on whether performing an exact match (e.g., is or is not), or a less specific
search (e.g., contains, less than, greater than, etc.).
c) Type in a value (if the field is a text string, date, or number), or select from a drop-down list if the value is
boolean or some other system value with a limited number of options.
d) Insert a new row to search on multiple attribute conditions.
e) Select the boolean condition (and/or) for the new row.
f) Repeat the steps for the new row.
g) Add or remove search criteria rows by using the Insert or Delete buttons. Use Delete All to start over with a
new set of query criteria.
h) Click Run Query when you are ready to begin the search.
6. You can perform a full-text search on a manual, which is similar to what an internet search engine would do. To
perform a full-text search:
a) Find the Full-Text portion of the Search dialog.
b) Enter a word or phrase to search for under the Contains: label.
OpenTopic | Using Navigation Tabs | 21

c) The In: option allows you to limit a search so that it only finds the specified phrase within a selected XML
element. This helps if you only want to find the specified text when it is specifically identified as a title, part
number, or manufacturer code. If you do not know exactly where the phrase occurs, leave this field empty.
d) Click the Run Query button to perform the query.

Figure 10: User Search Dialog

Common Search Attributes


The following table lists some common search attributes.
Table 8: Common Search Attributes
Attribute Name Description
Name The name of the object. Generally this is a
combination of the type of fragment and the ATA
code (e.g., "Figure 72-21-00-01").
Title The title of the fragment. Generally a description
of what the fragment does (e.g., ROTOR
ASSEMBLY AND COMPONENTS - FAN).
ATA Code The ATA-100 code that represents the chapter-
section-subject as well as additional numbers
depending on the type of fragment (e.g.,
72-21-00-01).
Reviewed by The name of the person who approved the
fragment (in many cases this is also the author).
Authors The name of a person who made changes to the
fragment.
22 | OpenTopic | Using Navigation Tabs

Attribute Name Description


Graphic Number The value of the GNBR attribute that appears in
the XML SHEET element (e.g., ME_G12346566).
Approval Date The date that the fragment was approved. This is
useful to find everything approved in a specific
time period.
Status Text objects can be in many states. If a status
is not specified, then inactive objects can be
received.
Note: The APPROVED
state is the most
commonly entered state.

Conflict Tab
Because revision imports are not supported in TechSight/X CMS ATA, FlightOps Edition, the conflict tab is never
populated.
The Conflict tab is intended to be your "to do" list after a revision import. The greatest strength of TechSight/X CMS
ATA lies in its ability to manage fragments that are modified by both the airline and the manufacturer. In many cases,
TechSight/X CMS ATA can resolve the conflict by merging the changes automatically, but a problem arises when
specific airline-owned anchors are subsequently revised by the manufacturer. You must manually decide what you
need to do. The Conflict tab provides a quick way for you to see all of the objects in a manual containing conflicts
that you must manually resolved. You can view and edit these fragments to resolve the conflicts. Conflicts that you
resolve and approve no longer appear in this tab. You can work by using this as a "to do" list to resolve conflicts after
a revision import. The list is empty when all conflicts are resolved and approved.
Note: The Conflict tab only applies to ATA manuals.

Objects in conflict have a special icon to identify their status. The conflict icon indicates items that are in
conflict. This attribute can be combined with the Draft icon to show conflict objects that are currently being edited in
draft mode. All the objects in the Conflict tab typically have the red X as shown below. The only objects that might
not have the red X are those that were in conflict and have been resolved and approved. They disappear from the list
the next time the tab is refreshed by pressing Get or by switching to another tab and back.
OpenTopic | Using Navigation Tabs | 23

Figure 11: Conflict Tab

Figure 12: Conflict Tab

Draft Tab
The Draft tab provides a convenient method of displaying all of the editable fragments that are currently in work
by an author. This tab is especially useful if you are working on many fragments spread across a manual, or if you
forgot the location of the fragment you were working on. When you click the Draft tab, a list of airline fragments
is displayed within the selected fleet and manual where the status attribute is DRAFT. You can perform all of the
normal authoring operations, such as Edit, View, or Approve on the objects that are displayed in the Draft tab.
Note: The Draft tab is not user-specific. It shows all
drafts in a manual regardless of who is working the draft.
If a draft object is checked out, however, it is locked so
that only the author who checked it out can edit it. Locked

items are indicated by the locked item icon .


24 | OpenTopic | Using Navigation Tabs

A typical Draft tab appears below. The objects in the Approved Pane of TechSight/X CMS ATA are displayed with

the draft icon . When a draft-editable object is selected in the Approved Pane, the components that make up the
draft appear in the Draft Pane. In the case shown in the following figure, there is one draft graphic along with the
draft version of the editable fragment. The XML fragment is locked for edit, or checked out, by the author with the
user name of "author2".

Figure 13: Draft Tab

Figure 14: Draft Tab

Approved Tab
The Approved tab is a quick way to see all of the fragments that have been authored since the last internal release
of the manual. This shows the airline changes made in the current release cycle that are included in the next publish
operation. This provides an easy way to check on other dependent documents such as job cards that might need to
know that a part of a manual has changed. The Approved tab view shows objects in draft mode if they were approved
and then edited again before the manual was released. It is important to understand the distinction between publishing
a manual and releasing it to interpret this information correctly.
OpenTopic | Using Navigation Tabs | 25

Note: Use this feature for a recently approved fragment


that requires another update. To perform the update, click
the Approved tab, and a list of recent work that was
completed displays.

Figure 15: Objects in the Approved Tab


26 | OpenTopic | Using Navigation Tabs

Figure 16: Objects in the Approved Tab


OpenTopic | Using Navigation Tabs | 27

TR Tab
Note: Because TechSight/X CMS ATA, FlightOps
Edition does not support temporary revisions, the TR tab is
never populated.
You can introduce temporary Revisions (TRs) into TechSight/X CMS ATA from an SGML TR import of
manufacturer data, or they can be internally generated by attaching a graphic or a scanned image to an existing
fragment as a supplement. In either case, the TR attribute gets set with a TR number that TechSight/X CMS ATA can
use to find fragments with TRs against them.
A view of the TRtab appears below. The objects shown are a list of all fragments in the manual that have TR numbers
stored in their TR number attribute. In this example, one of the objects is in conflict. A TR import can cause conflicts
with existing airline fragments, the same as a full import can. You must resolve these conflicts before you can publish
the manual.

Figure 17:

Figure 18:

Inbox Tab
This topic is only for integrated TechSight/X CMS ATA.
The TechSight/X CMS ATA Inbox tab serves as an author's "to do" list within the TechSight/X BPM integrated
product. The Inbox tab displays TechSight/X CMS ATA fragments associated with TechSight/X BPM Change
Requests (CRs). A view of theInbox tab appears below. The fragments shown are a list of CRs the author has
available to work on, indicated by a Ready or Acquired status.
To edit a fragment, you must acquire it. To acquire a CR with a Ready status, highlight the CR and select Edit
Document from the Authoring Options menu in the Approved Pane. This automatically acquires the CR and sets
its status to Acquired. For more information on Change Requests and the TechSight/X BPM integration, refer to the
TechSight/X BPM User Guide.
Note: The SkyManager integration allows you to
choose if you want to manage imported documents with
TechSight/X BPM. Make this decision during the Import
process. A document that is not managed by TechSight/
X BPM allows you to author any fragment in a manual
that you have permission to edit. It does not require the
fragment to exist in the Inbox. For more information on
setting Import preferences, refer to the TechSight/X CMS
ATA User Guide for Document Administrators.
28 | OpenTopic | Using Navigation Tabs

Figure 19: Objects in the Inbox Tab

Table 9: Inbox Icons

Icon Description
The Ready CR has been routed from TechSight/
X BPM for authoring. It is displayed in the Inbox
for every user in the authoring group until it is
Acquired for editing.
The Acquired CR has been assigned to a specific
author and is removed from every other Inbox.
(The CR acquiring was done in TechSight/X
BPM's Inbox)
The green check is placed on an editable fragment
that is currently in draft mode.
The red "X" is placed on an editable fragment with
a conflict that you must resolve manually.
OpenTopic | Editing a TechSight/X CMS ATA Manual Fragment | 29

Editing a TechSight/X CMS ATA Manual Fragment


Use the Authoring Options menu to make changes to a fragment. The Options menu appears in both the Approved
Pane (titled Authoring Options, when placing the cursor over the drop-down arrow) and the Draft Pane (titled
Options, when placing the cursor over the drop-down arrow), but the features are slightly different for each. See the
following figures.

Figure 20: Options Menu in the Approved Pane

Figure 21: Options Menu in the Approved Pane


30 | OpenTopic | Editing a TechSight/X CMS ATA Manual Fragment

Figure 22: Options Menu in the Draft Pane

Authoring Options
The following table gives a detailed description of the actions that you can take from the Authoring Options
menu item in the Approved Pane or the Options menu item in the Draft Pane, depending on document type.

Table 10: Authoring Options

Option Approved Pane Draft Pane


Create Document Sends a request to create the N/A
new Task Card (CR). Displays
the Task Card number. Routes
the CR to the group to which
the author belongs. Causes the
SkySuite Form Server screen
to appear.
Edit Document Creates a draft version of the Checks-out the selected text or
editable fragment and launches graphic object and launches it
the text object in the editor. in the appropriate editor.
Preview Document Displays the current approved Displays the current
XML object in a Web browser. checked–in XML draft
object in a Web browser.
View Assembled Section as Assembles a fragment in XML N/A
XML for viewing.
Delete Draft Permanently deletes the entire N/A
draft, including any graphics or
new text fragments.
Validate Checks-in a draft object N/A
and performs a differencing
operation to find any changes.
Checks for basic validity and
prepares the document for
Approval.
Approve Makes the draft object the N/A
current approved object, along
OpenTopic | Editing a TechSight/X CMS ATA Manual Fragment | 31

Option Approved Pane Draft Pane


with any graphics or new child
fragments.
Submit for Approval For documents managed by N/A
SkyManager, an author uses
this option to route an authored
fragment to the approver.
Revert to MFR Version Reverts an airline-owned N/A
object to the most currently
imported manufacturer version
of that object. This includes
any graphics associated
with the text object, and it
optionally includes children.
Accept MFR Deletion Used during conflict resolution N/A
to accept a conflict caused by
an airline deleting a fragment.
Keep Airline Deleted Used during conflict resolution N/A
to accept a conflict caused by
an airline deleting a fragment.
Attributes Displays the relevant attributes Displays the relevant attributes
of the approved object. of the selected draft object.
Versions Shows the past approved and N/A
released versions of an object.
Edit/Preview PNR data Launches the Global Data N/A
Manager that is used to find
reusable part information in an
AIPC.
Search WDM Lists Used to search, edit, or create N/A
Equipment and Wire rows in a
wiring manual.
Checkout N/A Locks an object for editing by
a specific user and downloads
it to that user's local computer.
Checkin N/A Unlocks a locked object and
uploads the modified file to the
server as a new version of the
draft object.
Cancel Checkout N/A Unlocks a locked object and
discards any local file. Does
not version the draft object.
Browse to Working Directory N/A Opens a Windows Explorer
window for the local file
system that contains the files
for locally downloaded objects
that have been checked out.
Search Metadata Searches metadata for a N/A
manual including effectivity,
revisions, and certifications.
32 | OpenTopic | Editing a TechSight/X CMS ATA Manual Fragment

Option Approved Pane Draft Pane


Validate Links Validates internal and external Validates internal and external
references in approved references in draft fragments
fragments within the same fleet within the same fleet or cross-
or cross-fleet. fleet.

Previewing a Fragment
The Preview Document option is an extremely useful feature that allows an author to see an instant What You See Is
What You Get preview of an XML fragment.
This feature displays a fragment as it appears in published output form. Therefore, you must use the same browser for
previewing as is used in viewing. Choose the browser for each file type in the TechSight/X CMS ATA Preferences

.
Note: In the upper Approved Pane of the Navigate ,
Approved, Draft, and TR tabs, the preview displays
the current APPROVED version. In the Conflict tab,
the preview displays either a split screen view of both
conflicting versions, or a scroll-down view of the
conflicting versions in the case of Task Card conflicts.
Note: In the upper Approved Pane of the Navigate ,
Approved, Draft, and TR tabs, the preview displays
the current APPROVED version. In the Conflict tab,
the preview displays either a split screen view of both
conflicting versions, or a scroll-down view of the
conflicting versions in the case of Task Card conflicts. The
TR and Conflict tabs apply only to ATA manuals.
The XML editor customizations support an instant preview that allows you to see the fragment during editing, while
using the custom menu TechSight/X to select the menu item "Preview". Also note that for Previewing, output in PDF
format must have an installation of Adobe Acrobat Reader available.

Preview a Fragment
The Preview Document option gives you a preview of an XML fragment as it appears in published output form.
1. Select the draft object to preview from the Draft Pane.
2. If you are previewing a draft object that is not checked in, then select the Checkin option from the Options menu
in the Draft Pane.
3. Select Preview from the Options menu in the Draft Pane.
The object is displayed in a Web browser.

Create a Draft
TechSight/X CMS ATA creates a draft version of a fragment when the Edit Document operation is selected. A draft
is created by making a copy of an approved object and any of its associated graphics in a working area. You can edit,
save, preview, and validate draft objects at any time. Any changes made while in draft are not a permanent part of the
manual until the fragment is approved. Having a fragment in draft does not impact the import process, so import and
publish/release cycles on a manual are not hindered while a fragment is being worked on in draft.
1. Find an editable fragment in TechSight/X CMS ATA by using the Navigate tab or any query tab.
Note: If a document is not managed by TechSight/
X BPM, you can directly edit fragments from the
Navigate or any query tab. If a document is managed
by TechSight/X BPM, you can use the Navigate tab
OpenTopic | Editing a TechSight/X CMS ATA Manual Fragment | 33

to navigate to a fragment, but not to directly edit the


fragment. When authoring documents managed by
TechSight/X BPM, you can edit from the Inbox tab.
Authoring options are enabled outside of the Inbox (in
the Conflict tab) if and only if the fragment is checked
out and the "lock owner" is the current user logged in.
2. Select the editable fragment so that it is highlighted.
3. Select Edit Document from the Authoring Options menu in the Approved Pane. TechSight/X CMS ATA does the
following:
• Creates a draft version of the fragment and displays it in the Draft Pane. The object in the Approved Pane is

now shown with the checked icon .


• Automatically checks-out the draft to you and downloads it to your local computer file system.
Note: As long as the draft is checked out, no other
authors can access that version of the draft.
• Automatically launches and displays the draft fragment for editing in an XML editor.

Checkin and Checkout of a Draft


This section describes the check-in and check-out processes. These processes help to identify who is working on a
particular draft object, and they also prevent another author from inadvertently modifying a fragment that another
author is working on. When a draft object is checked out, it is downloaded to your computer and locked so that no
one else can edit it. There are a variety of actions to choose from to work with a checked-out object.
The Checkout and Edit functions are closely related. An edit goes one step further by launching the checked-out file
in the XML editor. Typically, the reason for checking-out a file is because you want to edit it. To edit, select Edit,
and the file is checked out and launched in the XML editor. If the fragment is already checked out to you, then it is
launched in the editor.
In some cases you might want to lock the file without editing. The Checkout option allows you to do this too. You
can subsequently select Edit if you want to edit a file that you previously checked out.
Note: You can only edit files that you checked out, and
you must be working on the same client computer that you
were working on when you checked out the file.
The Cancel Checkout operation closes the file in the editor, removes the lock on the fragment, and discards any
editing changes made since the fragment was last checked out. When you select the Cancel Checkout option,
TechSight/X CMS ATA prompts you to confirm that you really want to discard the changes.

Delete a Draft
If you want to discard the most recent editing changes, use the Cancel Checkout operation. There are other situations
where you want to delete all versions of a draft. This might occur, for example, if you accidentally started to edit a
different fragment than you intended.
Note: When authoring documents managed by
SkyManager, you can only delete editing changes from the
Inbox tab. If a document is not managed by SkyManager
you can delete editing changes from any query tab in
TechSight/X CMS ATA.

1. Select Delete Draft from the Authoring Options menu in the Approved Pane.
A confirmation dialog appears.
34 | OpenTopic | Editing a TechSight/X CMS ATA Manual Fragment

Figure 23: Delete Draft Confirmation Dialog


2. Click OK to delete all versions of a draft. The draft and any associated graphics or fragments are removed from
the Draft Pane, and the checkmark icon disappears from the object in the Approved Pane.

Check-in an Object
You can check in the object after having made changes to it. This creates a new version of the draft object in the
document management system. It is important to note that you can check in as often as necessary and the older
changes all remain until you delete the draft or approve the fragment. After approval or deletion is done, however, all
draft versions are permanently removed.
Note: TechSight/X CMS ATA does not currently allow
you to revert to an older draft version, but a system
administrator can go through the Documentum interface to
get older draft versions if required.

Select the Checkin menu item from the Options menu in the Draft Pane.
A Checkin operation performs the following actions:
• Automatically saves and closes the file in the XML editor
• Uploads the file to the server
• Releases the lock on the draft object
• Sets certain attributes on the draft object that identify who checked in the object and the time it was checked in
OpenTopic | Configuring the XML Editor | 35

Configuring the XML Editor


An XML editor must be configured to interact with TechSight/X CMS ATA to get the full benefit of the authoring
support. This configuration is generally done by the system administrator when the TechSight/X CMS ATA system is
set up, but in some cases you might need to know this information.

Configure Arbortext
After installing the Arbortext Editor, you must configure the application. It requires customized files to work
correctly with TechSight/X CMS ATA.
Note: Typically this task is performed by the system
administrator with the assistance of InfoTrust professional
services.

1. Open Arbortext Editor by selecting Start | All Programs | Arbortext, Arbortext Editor 5.3
2. Select Tools | Preferences.
36 | OpenTopic | Configuring the XML Editor

Figure 24: Arbortext Editor Preferences dialog


3. Select Window.
4. Check Full Menus.
5. Click OK.
6. Select File Locations from the list of preference category.
Note: Do not remove the Arbortext Editor paths
when you prepend the following TechSight/X CMS
ATA custom paths. Enter the path to the catalog in the
doctypes folder, and the graphics and entities folders in
your Arbortext (Epic53) installation location, similar
to the example in the figure below. A semi colon is
required after each custom path. For example:
OpenTopic | Configuring the XML Editor | 37

• C:\tsx-cms-ata
\Epic53\epic53\doctypes;
• C:\tsx-cms-ata
\Epic53\epic53\graphics;
• C:\tsx-cms-ata
\Epic53\epic53\entities;
The file locations fields appear.
7. Click OK.
8. Close Arbortext Editor.
The next time you author changes in TechSight/X CMS ATA, the new configuration takes effect.

Configuring XMetaL for TechSight/X CMS ATA


XMetaL must have a custom macro file installed to run the code in the TechSight/X CMS ATA/FlightOps client
Dynamic Link Libraries (DLLs). It also must have a special catalog file that points to the doctype specific information
that is stored on the server. You must know the XMetaL editor's installation directory on the local client PC. This
location varies between versions, but is similar to the following format: C:\Program Files\XMetaL\Author
\xmetal50.exe. For example purposes, your XMetaL path is referred to as %xmetal_home% in the following
procedure.
1. Navigate to the C:\TSX CMS ATA \XMetal50\v5.0\macros directory.
2. Copy the Xmetal_FlightDoc.mcr file.
3. Paste the Xmetal_FlightDoc.mcr file in the %xmetal_home%\Author\StartUp directory.
4. Rename or remove the %xmetal_home%\Author\extid.map file.
Note: The extid.map file is an obsolete proprietary
method of finding public identifiers that should no
longer be used. If an existing application is using this
file then refer to the XMetaL documentation to port the
entries in an existing extid.map file to a catalog file.
5. Find or create the file named %xmetal_home%\Author\Rules\catalog.soc .
Note: XMetaL attempts to read a file named either
catalog or catalog.soc . Verify that only one of
these files exists. The preferred name is catalog.soc
so Windows allows a file association in a file editor.
6. Open the catalog.soc file for editing.
a) Set the CATALOG value to the directory location of the XMetaL catalog.
For example:

CATALOG "C:/apps/tsx-cms-ata-client/XMetal/v5.0/catalog"
Or

CATALOG "%xmetal_home%/XMetal/v5.0/catalog"
Note: UNC paths cannot be used for the
filesys_code_root value in an XMetaL catalog file.
You must have a mapped drive from the client PC to
the location on the server or client that stores the DTD
files.
b) Save the catalog.soc file.
Note: When XMetal opens a new document type for
the first time, it asks if you want to Preserve Space or
Apply Formatting. Select Preserve Space.
38 | OpenTopic | Configuring the XML Editor

Note: InfotrustGroup recommends you turn off the


option to Restore last open documents because
this option references documents that no longer exist
after they are checked into TechSight/X CMS ATA/
FlightOps. To turn this option off, go to: Tools |
Options | General and uncheck Restore Last Open
Documents.

--
# Default Catalog for Template and other files
#
#
# W3C DTDs and entity sets
#
--

CATALOG "C:/apps/SkyDocClient/XMetal/v5.0/catalog"

PUBLIC "-//W3C//DTD HTML 4.0//EN" "strict.dtd"


PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "loose.dtd"
PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN" "frameset.dtd"
PUBLIC "-//W3C//ENTITIES Latin1//EN//HTML" "entities/HTMLlat1.ent"
PUBLIC "-//W3C//ENTITIES Symbols//EN//HTML" "entities/HTMLsymbol.ent"
PUBLIC "-//W3C//ENTITIES Special//EN//HTML" "entities/HTMLspecial.ent"
OpenTopic | Authoring Changes in a Manual | 39

Authoring Changes in a Manual


You launch an XML editor to make authoring changes to a manual that is stored in the TechSight/X Suite system. By
launching the editor you move outside of TechSight/X CMS ATA and into some of the other client components of
TechSight/X Suite. The basic components that assist with authoring are:
• A Document Type Definition, or DTD, for the manual--XML data is comprised of elements, attributes, and text,
and it is up to the DTD to define when and where these are allowed in a particular manual. The DTDs that are
used in TechSight/X CMS ATA are based closely on the ATA Spec 2200 standard. InfoTrust Group recommends
that you receive training both in SGML and XML authoring and in the specifics of the ATA Spec 2200 before
beginning to author.
• A Stylesheet to format the text--After using the DTD to validate the data, the next job of the XML editor is to
present the data in a way that makes it easy to work with. This is the job of a stylesheet. Different editors use
different stylesheet mechanisms, but produce data that closely resembles the published output visible to the end
user. The stylesheet adds features such as color, highlighting, indenting, and numbering to make the data stand
out.
• Custom code for the editor--After the data is validated and styled, the XML editor then provides a customization
mechanism that can assist you when inserting new tags. Some tags, such as a PARAGRAPH tag, are very simple.
Insert the tag and start typing (or, click ENTER and a new paragraph appears). Other tags are more complex.
Some tags, such as the tags that are used to create tables, are dealt with by the editor itself. Other tags that are
specific to the ATA Spec are handled by TechSight/X CMS ATA. Inserting a cross-reference, for example, can
be tedious if it is necessary to manually edit the attributes that make up the reference. In TechSight/X CMS ATA,
the CROSS-REFERENCE tags launch a dialog that allows you to hierarchically navigate to the desired anchor to
reference. This type of assistance is also provided for inserting graphics, new anchors, and new fragments into the
manual.
You can also edit graphics with TechSight/X CMS ATA, but this user guide describes authoring XML text since no
customizations are needed to author graphics. All that is needed is to specify an image editor that supports the image
types in the TechSight/X CMS ATA configurations.
The typical steps in authoring changes in a manual are:
1. Navigate tab/Inbox tab
2. Check-out a fragment, create draft
3. Author changes
Note: When you create changes, you can describe them
using the chgdesc element. Comments included in the
chgdesc element are listed in the Revision Highlights.
4. Submit for approval/Check-in fragment
5. Validate fragment
6. Approve
Note:

Using Effectivity
All ATA manuals and FlightOps manuals contain an EFFECT tag that is allowed by the DTD at specific points in the
document to apply effectivity.
Note: EFFECT is used in MEL document types. In
Airbook and FCOM document types, effect is replaced by
the EFFMNGT tag. The EFFECT tag is still part of the
Airbook and FCOM DTD, however it is not used.
Generally, the EFFECT tag immediately follows an ANCHOR tag. Anchor elements such as CHAPTER (or CHAP),
SECTION, SUBJECT, UNIT, PGBLK, FIGURE, SUBTASK, ITEM, GRAPHIC, and SHEET all have effectivity,
40 | OpenTopic | Authoring Changes in a Manual

and when the EFFECT tag is the first tag under the ANCHOR tag then the effectivity that is specified in that tag
applies to the entire anchor. If an anchor does not specify an effectivity, then the effectivity is inherited from its
parent element. However, TechSight/X CMS ATA does not check to validate that a child's effectivity is within the
range of the parent's. This is a task that must be performed by an author.
Generally, the EFFECT tag immediately follows an ANCHOR tag. Anchor elements such as CHAPTER (or CHAP),
SECTION, SUBJECT, ITEM, GRAPHIC, and SHEET all have effectivity, and when the EFFECT tag is the first
tag under the ANCHOR tag then the effectivity that is specified in that tag applies to the entire anchor. If an anchor
does not specify an effectivity, then the effectivity is inherited from its parent element. However, TechSight/X CMS
ATA does not check to validate that a child's effectivity is within the range of the parent's. This is a task that must be
performed by an author.
Note: TechSight/X CMS ATA automatically inserts the
effectivity information for most anchor elements when you
are creating a new ANCHOR tag. The dialog that assists
with inserting the anchor element also provides a button
that launches the Effectivity dialogs that are described in
this section.
Many of the ATA DTDs allow the EFFECT tag to be added by inclusion. This is a feature that is allowed in
SGML, but not in XML. Inclusion basically allows the EFFECT tag to go almost anywhere, so it is impossible for
a computer-based system to figure out what the effectivity is supposed to apply to. Since inclusions are not allowed
in XML, TechSight/X CMS ATA converts all effectivity statements that are added by inclusion into processing
instructions. The processing instructions are converted to text statements by the style sheets in the viewing browser.
Note: Effectivity by inclusion is one of the poorly thought
out areas of the ATA spec. Do not add effectivity by using
processing instructions. If a "floating" effectivity is needed
below the anchor level, enter it in as a text statement (such
as: On aircraft 001-003 do the following...).

Insert EFFECT tag


Engine manuals have the "concepts of models" and "groups of models".
FlightOps manuals allow the following tags in an EFFECT tag: SBEFF, MODEFF or CONFIGEFF.

1. Using the XML editor, insert an EFFECT tag where it is allowed by the DTD (this is almost always allowed
immediately following an anchor element).
The Effectivity Groups and Models dialog appears.
OpenTopic | Authoring Changes in a Manual | 41

Figure 25: Select Effectivity by Groups and Models dialog


2. Select the models and groups that you want to include in the effectivity for the anchor that you are editing.
Note: When a group is selected, all models in that group
also become selected. Conversely, when all the models
in the group are selected, the group that contains those
models also gets selected.
3. You can enter Optional Effectivity Text statements. This information is intended to be in addition to the group and
model information, for example, Model X with bendix starter installed.
4. Click Insert to insert the EFFECT tag into the document.
A description of the Effectivity Groups and Models features follows:
• Group--This is the first column in the table. It is pre-populated with all the groups defined for this manual,
given the parent effectivity.
• Group or Model--This is the second column in the table. It is pre-populated with all the groups and models that
exist in the group defined in the first column.
• Effect Text--This is the effectivity text value pre-populated with the parent effect text.
• Select All--This button checks the box located in front of each entry in this table and highlights the text in bold
blue.
• Deselect All--This button removes the check from each entry in this table and highlights the text in black.
• Cancel--This button closes the CREATE EFFECT tag dialog and cancels the action to insert an EFFECT tag.
• Insert--This button inserts an EFFECT tag.

Manual Effectivity by Tail Number


Manuals use numbers to indicate effectivity. The numbers are based on a Customer Effectivity Code (CEC) value that
correlates to a specific aircraft tail number. The ATA Spec defines the CEC value as a 3 digit integer. Six digits are
required to specify an effectivity range (for example, 001001 applies to 001 only, while 001023 translates to a range
of 001 to 023). The TechSight/X CMS ATA XML DTDs have modified this slightly, and they provide a separate
START and END range for each EFFRG element.
The Effectivity dialog appears whenever you try to insert an EFFRG element within an EFFECT element. You can
also access it by clicking when you insert most anchor elements.
42 | OpenTopic | Authoring Changes in a Manual

Figure 26: Effectivity and Tail Number dialog

Insert a Graphic
A GRAPHIC element is a container for a set of SHEET elements. The GRAPHIC itself does not point to any image
files. The SHEET element contains the actual reference to the image.

1. Select a new GRAPHIC tag to insert using the XML editor.


The GRAPHIC dialog appears.

Figure 27: Insert a new GRAPHIC dialog


2. Enter the appropriate Title and Sequence (Seq) in the fields provided.
3. To change Effectivity, click Edit.
4. Click OK to insert the GRAPHIC tag.
5. Select a TITLE tag.
6. Enter a title for the graphic.
You must insert a SHEET element inside the GRAPHIC element for a graphic to appear.
OpenTopic | Authoring Changes in a Manual | 43

Insert a Sheet
The SHEET element contains the GNBR attribute that references an image that you use when viewing the object. The
SHEET element must be placed inside a GRAPHIC element. As a result, this element has a unique significance, and
it is handled differently than most other elements.

1. Insert a SHEET tag using the XML editor.


The Insert a SHEET dialog appears. The graphics list in the dialog shows all of the graphics that are currently
imported into TechSight/X CMS ATA and available in the Draft Pane of TechSight/X CMS ATA for this
fragment. If preview is turned on, then each graphic appears on the left side of the dialog as you scroll through the
list.

Figure 28: Insert a SHEET dialog


2. If the desired graphic is not available for use, then click Import Graphic from File.
The Insert a Import CGM, TIFF dialog appears.
44 | OpenTopic | Authoring Changes in a Manual

Figure 29: Import CGM, Tiff dialog.

To import a graphic from the file system:


a) Use the Drive, Folder, and File Name list boxes to navigate to the system location where graphics are
available. Select the graphic You want to import.
b) If the Preview box is checked, then a preview of the selected graphic is displayed in the Preview frame.
c) Enter a title for the SHEET you want to insert. This field is required.
d) Check the small Stoplight icon on the right hand side of the dialog. After it is clear that everything has been
done properly, compress the graphic, then continue.
Note: The small stoplight gives an indication of the
size of the graphic. If the light is green then the graphic
is small and presents no problems when downloaded
and viewed online. If the light is yellow or red, confirm
that the graphic has been properly compressed. Often
a red light occurs on a scanned image that was never
compressed and requires a lengthy amount of time to
download in a browser.
e) Click Import.
The Import window closes and you return to the "Insert a Sheet" window where the image that was imported
appears in the Graphics list.
3. Select the graphic you want to use from the Graphics list.
4. Enter a title and sheet number as required.
5. Change the effectivity as required.
6. Click OK.
The GRAPHIC reference is added to the document. If you imported a new GRAPHIC, a new object is added to
the draft folder, and when approved, the new GRAPHIC is added to the TechSight/X CMS ATA repository.
OpenTopic | Authoring Changes in a Manual | 45

Insert REFINT and GRPHCREF Elements


You can associate REFINT with any anchor (fragment or non-fragment). You can associate GRPHCREF with any
graphic anchor in the same manual.
Note: TechSight/X CMS ATA does not validate internal
referencing to unpublished targets.

1. Select REFINT or GRPHCREF from the Insert Markup window in the XML editor.
The Internal Link dialog displays.

Figure 30: Internal Link dialog


2. Navigate to the internal fragment you want to link to.
3. Click Select.

Insert a REFEXT Element


You can associate REFEXT with an entire manual or any anchor (fragment or non-fragment) in a different manual
within the same fleet folder. The only limit for REFEXT is the associated reference must have an ATA code and
contain the same manufacturer code.
Note: TechSight/X CMS ATA does not validate external
referencing to unpublished targets.

1. Select REFEXT from the Insert Markup window.


The External Link dialog displays.
46 | OpenTopic | Authoring Changes in a Manual

Figure 31: External References dialog


2. Navigate to the external fragment you want to link to.
3. Click Select.

Insert a REFGEN Element


You can associate REFGEN with an entire manual or any anchor (fragment or non-fragment) in a different manual
within the same fleet folder that does not have an ATA code. It must contain the same manufacturer code.
Note: TechSight/X CMS ATA does not validate internal
referencing to unpublished targets.

1. Select REFGEN from the Insert Markup window.


The External Link dialog appears.
OpenTopic | Authoring Changes in a Manual | 47

Figure 32: External References dialog


2. Navigate to the internal fragment you want to link to.
3. Click Select.

Creating New Anchors


ANCHOR tags are defined as the minimum revisable unit of a manual. A true ANCHOR tag must contain a key value
that uniquely identifies it within a manual. It must also contain a change letter and a revision date. TechSight/X CMS
ATA automatically inserts these values into new anchors.
These topics describe the individual anchor elements that are supported by dialogs in TechSight/X CMS ATA. Many
anchor elements are similar across different manufacturers, with minor variations at times.
You can insert a child element in a fragment that you have checked out. For example, if you check out the BODY
fragment from a MEL doctype manual, you can insert a new child of an existing CHAP element.
Note: When you create changes, you can describe them
using the chgdesc element. Comments included in the
chgdesc element are listed in the Revision Highlights.

Anchors by Doctype
Each FlightOps doctype has its own specific elements that are anchors. They are listed in the table below.
Table 11: Anchors by Doctype

FCOM Airbook MEL


Vol Front Matter Front Matter
48 | OpenTopic | Authoring Changes in a Manual

FCOM Airbook MEL


Fmtr Body Body
Fmsect Chapter Chapter
Chap Bkmatr Bkmatr
Sect Appendices Appendices
Subject
Table 12: Anchors by Doctype
FCOM Airbook MEL
Vol Body
Chapter Chapter Chapter
Section Section Section
Item Page Item
Graphic Graphic Graphic
Sheet Sheet Sheet

Insert a New Child


Insert a new child to add an element to an existing fragment. After you have added a new element, you can add
content.
1. Select the fragment you want to add an element to.
2.
Select the Authoring Options menu item.
3. Select Edit Document from the Authoring Options menu.
The fragment opens in an XML editor.
4. Insert a new child element.
TechSight/X CMS ATA pre-populates the Insert a New Child dialog. In this case, the doctype is MEL and the
CHAP element is inserted in a BODY element.

Figure 33: Insert a New Child dialog


5. Enter a title.
6. Click OK to insert the new tag.
7. A new draft CHAP editable fragment is created in TechSight/X CMS ATA.
You can edit his fragment separately to add graphics and other content.

Insert a REFEXT Element


You can associate REFEXT with an entire manual or any anchor (fragment or non-fragment) in a different manual
within the same fleet folder. The only limit for REFEXT is the associated reference must have an ATA code.
OpenTopic | Authoring Changes in a Manual | 49

Note: TechSight/X CMS ATA does not validate external


referencing to unpublished targets.

1. Select REFEXT from the Insert Markup window.


The External Link dialog displays.

Figure 34: External References dialog


2. Navigate to the internal fragment to which to link.
3. Click OK.

Insert a SUPPLEMENT Element


Supplements are image files that you can insert to the top of an editable fragment. Use these for rapidly inserting
data that might not be available in SGML form. A common example of using a supplement is to scan a paper TR and
include it as a supplement. Each fragment allows supplements to be added as the very first element following the top
level element. In XML an image file is any file whose content is not XML parsible. The supplement can be a graphic
(such as CGM, TIFF, JPG, GIF, or PNG and so on), but it can also be other file types such as PDF, Microsoft Excel
or a Microsoft Word document.
Note: Supplements appear in a viewing browser as a
hyper link to an image file, but they might not appear in
the printed version of the manual.
Supplements are inserted in much the same way as a SHEET element.
1. Insert a supplement element at the top of the fragment that requires the addition of a supplement.
The Insert Supplement dialog appears.
2. Insert a SUPPLEMENT tag using the XML editor.
The Insert a SUPPLEMENT dialog appears. The graphics list in the dialog shows all of the graphics that are
currently imported into TechSight/X CMS ATA and available in the Draft Pane of TechSight/X CMS ATA for
50 | OpenTopic | Authoring Changes in a Manual

this fragment. If preview is turned on, then each graphic appears on the left side of the dialog as you scroll through
the list.
3. If the desired graphic is not available for use, then click Import Graphic from File.
The Insert a Import CGM, TIFF dialog appears.

Figure 35: Import CGM, Tiff dialog


To import a graphic from the file system:
a) Use the Drive, Folder, and File Name list boxes to navigate to the system location where graphics are
available. Select the graphic You want to import.
b) If the Preview box is checked, then a preview of the selected graphic is displayed in the Preview frame.
c) Enter a title for the SUPPLEMENT you want to insert. This field is required.
d) Check the small Stoplight icon on the right hand side of the dialog. After it is clear that everything has been
done properly, compress the graphic, then continue.
Note: The small stoplight gives an indication of the
size of the graphic. If the light is green then the graphic
is small and presents no problems when downloaded
and viewed online. If the light is yellow or red, confirm
that the graphic has been properly compressed. Often
a red light occurs on a scanned image that was never
compressed and requires a lengthy amount of time to
download in a browser.
e) Click Import.
The Import window closes and you return to the "Insert a SUPPLEMENT" window where the image that was
imported appears in the Graphics list.
4. Select the graphic you want to use from the Graphics list.
5. Enter a title and SUPPLEMENT number as required.
OpenTopic | Authoring Changes in a Manual | 51

6. Change the effectivity as required.


7. If the supplement is acting as a temporary revision, enter the TR number in the field provided
8. Click OK.
The GRAPHIC reference is added to the document. If you imported a new GRAPHIC, a new object is added to
the draft folder, and when approved, the new GRAPHIC is added to the TechSight/X CMS ATA repository.

Creating New Anchors


ANCHOR tags are very special in the ATA-2200 Spec. They are defined as the minimum revisable unit of a manual.
A true ANCHOR tag must contain a key value that uniquely identifies it within a manual. It must also contain a
change letter and a revision date. ANCHOR tags often carry other important information, such as the attributes
needed to generate an AMTOSS or JEMTOSS code. It would be very tedious to create all of this information every
time you have to insert an anchor--especially in those manuals where the anchor might be as small as a SUBTASK
element in a maintenance manual or an ITEM element in an Illustrated Parts Catalogue (IPC).
The following example shows all of the elements and attribute values that you need to enter a new TASK element
into a manual.

<TASK
ATACODE="76-11-01-000-802-G00"
CHAPNBR="76"
CHAPPREF="G"
CHG="N"
CONFLTR="G"
FUNC="000"
KEY="BB31091E71FAB6979C61AF47032ECE9B"
PGBLKNBR="4"
REVDATE="20030505"
SECTNBR="11"
SEQ="802"
SUBJNBR="01"
VARNBR="00"
>
<EFFECT EFFTEXT="Cargo Aircraft Configuration">
<EFFRG END="999" START="001"/>
</EFFECT>

TechSight/X CMS ATA knows most of these values based on the context of the fragment within the manual,
therefore, it pre-populates almost all of this information. The few items that require input you can usually select from
an easy-to-use interface. Many anchor elements are similar across different manufacturers, with minor variations at
times.
Note: When you create changes, you can describe them
using the chgdesc element. Comments included in the
chgdesc element are listed in the Revision Highlights.

Task-Based Anchors (AMM, EM, FRMFIM)


Task-based anchors are those anchors used in a system that contain tasks and subtasks. The page block (PGBLK) is
included in this group since it normally contains the various tasks. ATA has defined a set of numbering standards that
are intended to uniquely identify these anchors in a manual. This system is referred to as the Aircraft Maintenance
Task Oriented Support System (AMTOSS) and the Jet Engine Maintenance Task Oriented Support System
(JEMTOSS).
TechSight/X CMS ATA develops all of the numbering required for PGBLK, TASK, and SUBTASK elements, except
for the specific codes that cannot be automatically determined. The PGBLK element has a page block number that is
assigned differently depending on the intended purpose of the page block. The TASK and SUBTASK elements have
52 | OpenTopic | Authoring Changes in a Manual

a function code that you must assign depending on the function of the task. TechSight/X CMS ATA provides a drop-
down list for these codes based on ATA defined values so that you do not have to remember them.

Insert a PGBLK Element


Task-based anchors are those anchors used in a system that contain tasks and subtasks. The page block (PGBLK) is
included in this group since it normally contains the various tasks. ATA has defined a set of numbering standards that
are intended to uniquely identify these anchors in a manual. This system is referred to as the Aircraft Maintenance
Task Oriented Support System (AMTOSS) and the Jet Engine Maintenance Task Oriented Support System
(JEMTOSS).
TechSight/X CMS ATA develops all of the numbering required for PGBLK, TASK, and SUBTASK elements, except
for the specific codes that cannot be automatically determined. The PGBLK element has a page block number that is
assigned differently depending on the intended purpose of the page block. The TASK and SUBTASK elements have
a function code that you must assign depending on the function of the task. TechSight/X CMS ATA provides a drop-
down list for these codes based on ATA defined values so that you do not have to remember them.

1. Insert a new child element from within a SUBJECT element while editing a CHAPTER fragment in the XML
editor.
TechSight/X CMS ATA pre-populates the Create New Child Tag dialog.

Figure 36: New Page Block dialog


2. Click Edit if you want to change Effectivity.
3. Click OK to insert the new tag.
4. A new draft PGBLK editable fragment is created in the TechSight/X CMS ATA.
You can edit his fragment separately to add tasks, graphics, and other content.

Insert a TASK Element


Since a TASK is an anchor and an editable fragment, only a new TASK can be inserted as a child element while
editing a PGBLK. The new TASK is inserted as a child directly under the PGBLK element.

1. Insert a new child element in the XML editor from within a PGBLK fragment.
The Insert a New TASK dialog displays.
OpenTopic | Authoring Changes in a Manual | 53

Figure 37: New Task dialog


2. Pick a function code from the drop-down list that is relevant to the intended function of the task.
3. The function code description becomes the default title.
You can enter any title.
4. Enter a new sequence code.
Note: The ATA rule for an AMTOSS/JEMTOSS
sequence code is that the values for TASK must fall
between 801-999, whereas the values for SUBTASK
must fall within 001-800. Sequence is really a misnomer
since these often are not sequential as the manual is
modified over time. You can pick any value in the
allowed range since TechSight/X CMS ATA adds an
Airline Unique Identifier (ALUNQI) attribute to ensure
that the AMTOSS/JEMTOSS code is unique within the
manual.
5. If you need to change Effectivity, click Edit.
6. A new TASK editable fragment is created in the TechSight/X CMS ATA Draft Pane.
You can separately edit this fragment to add subtasks, graphics, and other content.

Insert a SUBTASK Element


SUBTASK elements are treated very similarly to TASK elements, except that a SUBTASK is not an editable
fragment, and it does not have a title. You can insert the SUBTASK element from the topic element from within a
TASK editable fragment. Except for these issues, the process for inserting a SUBTASK is identical to the "Insert
TASK" process.

1. Insert a new child element in the XML editor from within a TASK fragment.
The Insert a New SUBTASK dialog displays.
54 | OpenTopic | Authoring Changes in a Manual

Figure 38: New SUBTASK dialog


2. Pick a function code from the drop-down list that is relevant to the intended function of the subtask.
3. Enter a new sequence code.
Note: The ATA rule for an AMTOSS/JEMTOSS
sequence code is that the values for SUBTASK must fall
between 801-999, whereas the values for SUBTASK
must fall within 001-800. Sequence is really a misnomer
since these often are not sequential as the manual is
modified over time. You can pick any value in the
allowed range since TechSight/X CMS ATA adds an
Airline Unique Identifier (ALUNQI) attribute to ensure
that the AMTOSS/JEMTOSS code is unique within the
manual.
4. If you need to change Effectivity, click Edit.

Insert New SECTION Tags


Top Level Anchors in all Manuals (CHAPTER, SECTION, and SUBJECT elements) are common in ATA manuals.
The Illustrated Parts Catalog (IPC) uses UNIT instead of SUBJECT, but the basic concept is the same. At the time of
this writing, TechSight/X CMS ATA does not support the insertion of a new CHAPTER into a manual.

1. Insert a SECTION tag using the XML editor.


The Insert a New SECTION dialog displays.
OpenTopic | Authoring Changes in a Manual | 55

Figure 39: New Section dialog


2. Enter a title for the section.
3. Insert the appropriate section number.
Note: If you want to create a SECTION in a series of
SECTIONs, the value of the last SECTION number
displays in the "Sect" field. This value must be
incremented to reflect the addition of the new SECTION.
4. Click OK to insert the new tag.
Note: The SECTION dialog does not automatically
insert any effectivity information.

Insert New SUBJECT or UNIT Tags


This procedure describes inserting the 3rd level anchor in any ATA manual. In most manuals this is the SUBJECT
element, but the IPC uses UNIT instead of SUBJECT.

1. Insert a new SUBJECT (or UNIT in an IPC) tag in the XML editor.
The Insert a New Subject/Unit dialog displays.

Figure 40: New Subject dialog


2. Enter a title for the SUBJECT/UNIT
3. Enter the appropriate value in the SUBJECT (or UNIT) field.
When inserting several values in a row, TechSight/X CMS ATA remembers the last SUBJECT/UNIT value. The
value can be incremented.
4. Click OK to insert the new tag.
Note: The SUBJECT or UNIT dialogs do not
automatically insert any effectivity information.
56 | OpenTopic | Authoring Changes in a Manual

IPC Anchor Elements


The IPC's main hierarchy is CHAPTER, SECTION, UNIT, FIGURE, ITEM. The IPC also has GRAPHIC and
SHEET elements, as well as REFINT and REFEXT.
The IPC specific dialogs described here allow you to insert a FIGURE as a child element of a UNIT. They also allow
you to insert an ITEM into a FIGURE.
Airframe IPCs also have an anchor element called a PNRDATA element. This element allows for part number data
to be used in multiple ITEM elements. Because of its reusable nature, the PNRDATA element is handled differently
than other anchor elements.

Insert a FIGURE Element


Since a FIGURE is an anchor and an editable fragment, you can only insert a new FIGURE as a child element while
editing a CHAPTER. The new FIGURE is inserted as a CHILD directly under the UNIT element.

1. From within a UNIT element, select CHILD from the Insert Markup window.
The Insert a New Child Figure dialog displays.

Figure 41: Insert a New Child Figure dialog


2. Enter the appropriate Title and Figure number.
3. If it is necessary to change Effectivity, click Edit .
4. Click OK to insert the new tag.
A new draft FIGURE editable fragment is created in the Draft Pane. You can edit that fragment separately to add
graphics and items.

Insert a New Item


ITEM elements are added for each referenced part in an IPC figure. Items make up the part list that is added in a
FIGURE element immediately following the GRAPHIC element.

1. Select a new ITEM tag to insert using the XML editor.


The Insert a New Item dialog appears.
OpenTopic | Authoring Changes in a Manual | 57

Figure 42: New Item dialog


2. Fill in the item number that relates to the item number on the FIGURE's graphic; it must be 3 digits with an
optional alpha character (e.g., 001, 020, and 123A are all valid item numbers).
Note: If this is a non-illustrated item, then enter the
appropriate item number according to the company's
specified authoring practices. After the ITEM element is
inserted, the ILLUSIND attribute must be set to "0". This
causes the item to display as a non-illustrated item.
3. If changing Effectivity, click Edit.
4. Click OK to insert the new tag.

Using Global Data Manager


Global references are a very powerful feature of TechSight/X CMS ATA that illustrate how data is authored once and
reused in multiple locations. Use it with caution so that no fragments are modified inadvertently.
Global data is currently used only for IPC part number information in airframe manuals. The data comes from the
manufacturer with the Part Number List separated from the main IPC content that contains Figures and Items. The
content of the Part Number List contains information about the part that is independent of where it is used. This
content is stored in an anchor element named PNRDATA. The PNRDATA element contains a part number and a
manufacturer code that must correspond to the part number and manufacturer code that is contained in an IPC ITEM
element. At some point this information must be merged to create a complete IPC ITEM listing. In TechSight/X CMS
ATA the data is merged during the view process, as well as when you publish.

Launch the Global Data Manager


There are two ways to launch the Global Data Manager tool.

1.

Select the Edit/Preview PnrData menu item from the Authoring Options menu in the Approved
Pane. The Edit/Preview PnrData menu item is only enabled when an IPC fragment is highlighted.
2. When you view the IPC ITEM element, you can see a button next to the part number that allows you to change the
part information. This is labeled either Edit/Preview Part or Change, depending on the editor that you are using.
Click this button to change the part information.
58 | OpenTopic | Authoring Changes in a Manual

Figure 43: PnrData Edit Button in an IPC ITEM

Global Part Manager Components


The Global Part Manager dialog appears below. Its components are described in the following table.
OpenTopic | Authoring Changes in a Manual | 59

Figure 44: Global Part Manager dialog

Table 13: Global Part Manager Components

Component Description
MFR/PNR Window Displays a list of parts by manufacturer CAGE
code and part number. These parts are the result of
a query made using the Search button.
60 | OpenTopic | Authoring Changes in a Manual

Component Description
FIGURE Window Shows all of the IPC Figures in which the selected
part is contained.
PREVIEW Window Displays the part information as it would appear.
Search Button Used to search a part number. You can enter a
partial part number in this search.
Create New Button Creates a new part.
Show Airline Version Button If there is an airline version of a part, then this
is the default view in the preview window. This
button is labeled Show Mfr Version. You can
toggle the view shown in the preview window
between the manufacturer and the airline versions
using this button.
Edit Button Allows you to edit an existing PNRDATA anchor
in the XML editor.
Insert Button Inserts the selected part into an IPC ITEM if you
are at a point in the document where insertion is
allowed.

Edit Existing Part Number Data


All airline globals are stored in a special folder at the top level of the manual named the Airline Global
Objects folder. Only airline global objects appear in this folder. You can only see manufacturer objects through the
PNRDATA manager.
If you launch the Global Part Manager from within the XML editor while editing a FIGURE fragment, then the
draft PNRDATA object is displayed in the Draft Pane of TechSight/X CMS ATA along with the draft object for the
FIGURE itself.
If the Global Part Manager is launched from the TechSight/X CMS ATA Options menu, then the draft object is
located in the Airline Global Objects folder. You can also go directly into the Airline Global Objects folder
and edit a part as you would edit any other fragment.

Figure 45: Airline Global Objects folder

1. Launch the Global Part Manager.


The Global Part Manager dialog appears.
2. Select the part to edit from the Global Part Manager part list window.
OpenTopic | Authoring Changes in a Manual | 61

Figure 46: Global Part Manager dialog


3. Click Edit.
62 | OpenTopic | Authoring Changes in a Manual

Figure 47: Confirmation window appears

You must go to TechSight/X BPM to create a Change-Request that references the selected Part Number and route
it to the Inbox for authoring.
Note: Use the ATA-2200 Tag and Attribute Glossary
for information on the many tag options that you can
add to a PNRDATA element. Do not change the part
number or manufacturer code while editing the part.
These two fields make up the key of the part, and this
is how the part is referenced when included in an IPC
ITEM. Changing either of these fields creates a new and
unique part.

Create a New Part


The creation of a new airline part is a relatively rare occurrence. Often, all that is needed is making an alternate part
number for an existing part.

1. Click Create New on the Global Part Manager folder.


The Create New PNRDATA dialog appears.

Figure 48: Create New PNRDATA dialog


2. Enter the new part number in the PNR field.
OpenTopic | Authoring Changes in a Manual | 63

3. Enter the new manufacturer code in the MFR field. The manufacturer code is the five (5) character Commercial
and Government Entity (CAGE) code for the manufacturer of the part.
4. Click Verify to verify that this part number and manufacturer code has not been used in another part.
5. Click Create to create the new part in the Create New PNRDATA dialog.
TechSight/X CMS ATA requests a keyword for the new part.
6. Click OK in the Keyword box.
The following confirmation appears.

Figure 49: Create New Part confirmation


7. Go to TechSight/X BPM to create a Change Request that references the new Part Number and route it to the
Inbox for authoring.

Validate and Approve a Global Part


Validating and approving a global part or a fragment are very similar. The only major difference when you validate
a global object is that TechSight/X CMS ATA informs you which figures are being modified. In some cases, a small
change to part information can affect many FIGURE fragments that reference that part. TechSight/X CMS ATA
informs you what is being changed so you have a chance to back out of the operation.
Airline created or modified global objects are always accessible in the Airline Global Objects folder. This
is true even if the object has not yet been approved. You can perform all of the standard editing operations on the
PNRDATA fragments in this folder. You can validate or approve a global object in this folder at any time.
If you began editing the part from an IPC FIGURE fragment, you do not need to go to the Airline Global
Objects folder. The draft of the PNRDATA fragment appears along with the draft of the FIGURE fragment. The
draft PNRDATA is validated and approved with the FIGURE fragment.

Understanding Fragment Copy


Fragment Copy is a feature that allows you, when creating a new fragment (inserting a CHILD tag), to create the new
fragment by making a copy of an existing fragment instead of from the normal template. TechSight/X CMS ATA
performs several transformations when creating the copy. The basic contents of the fragment remain unchanged, but
various attributes and elements that relate to the new location have been updated as follows:
• All KEY and anchor ID attributes are assigned new, unique values.
• CHG and REVDATE, and other TechSight/X Suite attributes like ATACODE are managed by TechSight/X CMS
ATA.
• All location type anchor attributes, on all anchors, are updated for the new location such as, CHAPNBR,
SECTNBR, etc.) by inheriting values from the new parent.
• Set location type anchor attributes that are required for the top element of the new anchor instance, like FIGNBR
for a copied FIGURE, with the Insert dialog as you do when you create a new fragment.
• You can set location type anchor attributes that are either optional for the top element of the new anchor instance,
or are for anchors internal to the fragment, with editing--in some cases these edits are required.
• Some anchor attributes, like ITEMNBR on an AIPC FIGURE, are carried forward, unchanged from the source,
and are not alterable.
• If internal references (REFINT or GRPHCREF) target an id or key internal to the fragment, and that was thus
updated for the copy, TechSight/X CMS ATA replaces the reference id with the new value. Internal references
that point outside the fragment, and external references are not altered.
• TechSight/X CMS ATA removes all CHILD and SUPPLEMENT tags from the copy.
64 | OpenTopic | Authoring Changes in a Manual

• TechSight/X CMS ATA creates copies of all illustrations in the fragment, assigning them new, unique GNBRs,
and updates the SHEET elements with those new GNBRs. All such illustrations are airline-owned.

Fragment Copy Insertions


The following table lists the currently supported doctypes and child insertion elements by Fragment Copy.
Table 14: Current Supported Fragment Copy Insertions
Doctype Child Insertion Element for Fragment Copy
Airbook Chapter, Section, Subject
MEL Chapter, Section, Item
FCOM Chap, Sect, FMSect
Airbook Page
FCOM Item
Note: Removing CHILD tags can result in an invalid
fragment, and you must create the proper children, by
creating a copy of an existing fragment.

Reusing Content
Content reuse allows you to reuse fragments across multiple Flight Operations (FO) manuals provided they share
a common public identifier. This implementation can only be reused at the fragment levels. Currently the fragment
levels for the FO data are:
• Airbook: Chapter, Section, Subject
• MEL: Chapter, Section, Item
• FCOM: Chap, Sect, FMSect
Reusable content is stored in reusable content manuals. These manuals are imported from templates that exist in the
docbase. Reusable content manuals cannot be published. Manuals using reusable content resolve the reference to the
reusable content at publish time. Whether a publish is made to TechSight/X IETP ATA or the PDF generator, there is
no difference in the appearance between reusable content and local content.
You can reuse content after you have imported the content you want to reuse using TechSight/X CMS ATA Admin.
To import reusable content, follow the instructions for importing from a template in the TechSight/X CMS ATA
User Guide for Document Administrators. After you import data it appears in the TechSight/X CMS ATA Author
navigation tree.

Figure 50: Reusable Content in the Navigation Tree


After you have imported the content you want to reuse, there are two steps to identifying and referencing the reusable
content:
1. Designate which content you want to reuse
2. Designate the location where you want to use it
TechSight/X CMS ATA provides functionality to easily determine which reusable content is used and where it is
used.

Create Reusable Content


Designate which content you want to reuse.
OpenTopic | Authoring Changes in a Manual | 65

1. Open the fragment you want to reuse from the Inbox tab.
Edit the fragment in the Draft pane to ensure that it is valid.
2. Insert a child.
3. Give it a title you can recognize for your reusable content.
4.
Click the Authoring Options icon .
5. Select Validate.
6.
Click the Authoring Options icon .
7. Select Submit for Approval.
Reuse the fragment in other manuals.

Create Reusable Content from an Existing Fragment


Designate which content you want to reuse from an existing fragment.
1. Open the fragment you want to reuse from the Inbox tab.
Edit the fragment in the Draft pane to ensure that it is valid.
2. Select the child you want to reuse.
All of the children of the referenced element become reusable.
3. Give it a title you can recognize for your reusable content.
4. Click Make Reusable.
The Select Location window appears.

Figure 51: Select the Location to Store the Reusable Fragment window
5. Browse to the location you want to store the reusable fragment.
6. Click Select.
The selected child and its children are moved into the draft folder of the selected target.
66 | OpenTopic | Authoring Changes in a Manual

7. Edit the draft of the reusable content.


The draft contains:
• an assembled version of all of the content to be reused
• updated keys
• updated references to those keys, within the current assembled fragment
• references outside of the scope of the assembled fragment are replaced by an INVALID_REFERENCE
processing instruction
Note: Evaluate each invalid reference processing
instruction and remove or replace it with a valid
reference.
8. Select Validate.
9.
Click the Authoring Options icon .
10. Select Submit for Approval.
A REUSE-REF element replaces the CHILD element in the original document..

Show Where Content is Reused


You can find all the manuals where reusable content is being used.
1. Select the Reusable Content that you want to find where it is being used.
2.
Click the Authoring Options icon .
3. Select Show Where Used from the drop-down menu.
The Content Reuse Show Where Used window appears.

Note: You can click Export List... to save the list of


reusable content and its location.

Figure 52: Content Reuse Show Where Used window


4. Click OK.

Show the Content Reused in a Fragment


You can select a fragment and get a list of all of the reused content contained in it.
1. Select the fragment in which you want to find reused content.
2.
Click the Authoring Options icon .
3. Select Show What Used from the drop-down menu.
The Content Reuse Show What Used window appears.
OpenTopic | Authoring Changes in a Manual | 67

Note: You can click Export List... to save the list of


reusable content and its location.

Figure 53: Content Reuse Show What Used window


4. Click OK.

Reconciling OEM Revisions


OEM Reconciliation resolves changes in OEM revisions of a manual with the airline versions. This reconciliation
process is used when the manuals are provided as structured data, but where the schema for the OEM data is different
than the schema for the customer manual in TechSight/X CMS ATA. Airlines that use the ITG flight operations
document models for their manuals can use the TechSight/X CMS ATA reconciliation process defined here for
incorporating OEM changes into their manuals managed by TechSight/X CMS ATA. This process differs from
the revision import/conflict resolution process TechSight/X CMS ATA provides for OEM and airline manuals that
use the same schema. The ITG flight operations document models are designed to support airlines creating and
maintaining their own flight operations manuals. When combined with the reconciliation process, the airline is able to
re-write, re-organize, discard or supplement a flight operations as they see fit, while retaining an effective process to
track and incorporate the changes provided by the OEM in each revision.

Add OEM Revisions


After you review a Change Request and decide you need to modify a fragment with OEM revisions, make changes.
Add OEM revisions from a Change Request in your Inbox.

1. Select the Change Request in your Inbox that you want to work on.
2. Click the Authoring Options icon.
3. Select Change Request Details.
The TechSight/X Server Form window appears.
68 | OpenTopic | Authoring Changes in a Manual

Figure 54: TechSight/X Form Server window


4. Click Copy to Draft.
The fragment is checked out and the graphic file is added to the Draft directory in the repository.
5. If you want to return to the Change Request Details, click Back.
Click Close Window to proceed to editing.
6. Use the XML editor to edit the fragment.
7. Save the fragment.
8. Select Validate.
9.
Click the Authoring Options icon .
10. Select Submit for Approval.

Using Graphics
An XML-based system treats graphics very differently from text. The XML part contains the structure of the
document, and anything that is not XML is referred to as a non-parsible entity. The XML text contains references
to non-parsible objects; the referenced objects depend on the rendering tool knowing how the objects are to be
displayed. In the case of Internet Explorer, the browser knows how to render XML, but it requires a third party
utility to view graphic files such as Computer Graphics Metafile (CGM), Tagged Image File Format (TIFF), Joint
Photographic Experts Group (JPG), or Portable Network Graphics (PNG) before it can display these. This is very
different than a Word document, for example, where the graphics are embedded into the document itself.
This is why the process to create or edit a graphical image in TechSight/X CMS ATA is separate from the process
that links the graphic into the text. This separation also allows for another department, such as drafting, to have
control of graphics while a different group is responsible for text. This section describes the process to create a new
graphic in TechSight/X CMS ATA, and to edit an existing graphic. The process to insert the graphic into the XML
text content is described in Insert a Sheet on page 43.
Table 15: ATA-2200 Graphic Formats
Format Description
Tagged Image File Format (TIFF), TIFF with TIFF is a bitmap format that is commonly used for
CCITT Group 4 Compression scanners, fax machines, and picture images. This
OpenTopic | Authoring Changes in a Manual | 69

Format Description
format is widely supported by most image editing
packages.
Computer Graphics Metafile (CGM) CGM is a vector format that is created using
an electronic drawing system. Vector formats
represent drawings as shapes rather than points,
so they are generally smaller than a corresponding
bitmap. They also allow almost unlimited
enlargement without image degradation. CGM
was chosen by ATA since it was standardized
by an international standards organization (ISO
8632). There are still, however, very few tools that
completely support this format.
PDF, JPG, GIF, MS Word, Excel TechSight/X CMS ATA provides limited support
to create supplements using other non-XML
entities. In the XML world, a file is essentially
a parsible XML document or it is a graphic that
some other application can process. You might not
consider PDF or Word to be graphics, but to an
XML parser, they are graphics.

Choosing a Graphics Editor


There are many different tools you can use to edit TIFF images. The Kodak Image Viewer, that comes with MS
Windows, is a good choice if no other TIFF editing applications exist. Many of the TIFF images added to TechSight/
X CMS ATA come from scanned-in paper. Most scanners and FAX utilities also come with some type of TIFF
editing support.
Note: Almost any good graphics package supports
TIFF, but make sure that it also supports Group 4
Compression. TechSight/X CMS ATA graphics are
eventually distributed through a wide area network or
some other mechanism. An uncompressed high resolution
TIFF graphic is huge, and even though it might download
quickly on to the local network, it might take several
minutes to download the image at a remote station.
Choosing a Computer Graphics Metafile (CGM) editor requires more work than choosing a TIFF editor. Popular
graphics packages such as Microsoft Visio, Micrografx Designer, Corel Draw, and Adobe Illustrator all advertise
support for CGM import and export. There are also third-party tools that convert AutoCAD files to and from CGM.
TechSight/X CMS ATA customers use CGM for anything from minor editing of text to creating entire drawings from
scratch. Evaluate the products to find one that suits your particular budget and needs.
Note: Verify how the editor interfaces with TechSight/
X CMS ATA. Some editors need to do a special import
to bring in CGMs. This can result in a less than seamless
editing operation since TechSight/X CMS ATA expects
the applications it works with to read and write directly to
the CGM file.
CGM viewing in TechSight/X CMS ATA preview is accommodated by the Corel Active CGM plug-in. This tool has
been proven to do the best job in rendering CGM graphics accurately even when they are less than perfect from the
manufacturer. This is the same tool that is used to view CGM graphics. The benefit of having the same tool in both
environments is that you can see any problems in the graphic viewing before they hit the shop floor. Corel also offers
a dedicated CGM editing tool that is a part of the Active CGM product suite. The Active CGM editing component is
not cheap, and InfoTrust Group does not endorse it nor support it as part of the TechSight/X S1000D Suite system.
Assess the amount of editing you have to do on CGM graphics to help make your decision.
70 | OpenTopic | Authoring Changes in a Manual

Edit a Graphics Image


To edit a graphic, you must first set up the format preferences in TechSight/X CMS ATA so it launches the preferred
graphic editor. Set up both an editing and a viewing application for graphics.
After the editor is installed and the launch applications for each graphic type has been associated, you are ready to
edit graphics in TechSight/X CMS ATA. TechSight/X CMS ATA only approves XML text fragments, so it is not
possible to directly edit a graphic without creating a draft of the text that is associated with the graphic. You must first
find the text fragment that the graphic is associated with and edit it from TechSight/X CMS ATA. Copy the graphics
to the draft folder during the draft creation process. When the graphic object exists in the Draft Pane, you can check
it out and edit it like any other document in the TechSight/X CMS ATA repository. After you complete the editing,
approve the graphic by approving the associated text fragment.
Before you can edit graphic objects with TechSight/X CMS ATA, confirm the following preconditions have been
met:
• Check out the editable fragment for editing. The text fragment containing the graphic must be in draft mode.
• The graphics editor for the objects format type must be defined by the Documentum format preferences or the
default Windows preferences.
• The appropriate graphics editor is installed on the client computer.
1. Navigate to an editable fragment containing a graphic.
2. Select Edit Document from the Authoring Options menu in the Approved Pane.
TechSight/X CMS ATA automatically launches and displays the draft XML fragment for editing in the XML
editor. If you are editing a graphic, then the editor does not need to be open.
3. Select the graphic in the editable fragment you want to edit in the Draft Pane.
4. Select Edit from the Options menu in the Draft Pane.
The graphic editor associated with the appropriate format is launched.
5. Use the graphic editor to make modifications.
6. Check-in the draft for the modified graphic.
Note: When working with XML in a text editor,
TechSight/X CMS ATA automatically saves and checks
in files whenever the "Validate" or "Approve" options
are selected. Special Application Programming Interface
(API) links into the XML editors allow this to happen to
ensure that no unsaved file is inadvertently checked in.
This customization does not apply to graphics editors,
so you must be certain that the file was saved before
performing a Checkin, Validate, or Approve from
TechSight/X CMS ATA.
When a manufacturer graphic is modified by the airline, the GNBR attribute on the XML fragment is modified
when the fragment is validated by appending the phrase "_CUST". This provides a means of ensuring that the
XML text references the airline's version of the graphic instead of the manufacturer's.

Resolving Conflicts
A conflict in TechSight/X CMS ATA is an airline anchor that has been subsequently revised by the manufacturer. In
other words, a conflict is the result of the following process:
1. An import of manufacturer SGML data is completed (whether a full import or a temporary revision).
2. An airline author has revised a portion of the manual.
3. A revision import of manufacturer SGML data (whether a full import or a temporary revision) revises the same
anchor that was modified by the airline author.
Airline technical publication departments have struggled for years with handling the conflicts that arise when the
manufacturer revises portions of paper manuals that were customized by the airline. A tremendous amount of effort
is required to update all paper and electronic documentation that must be maintained in legacy systems. TechSight/X
CMS ATA does not remove all of the complexity of this difficult problem, but it does minimize the redundancy that
is inherent in the paper methods.
OpenTopic | Authoring Changes in a Manual | 71

Conflict Handling in TechSight/X CMS ATA


TechSight/X CMS ATA specializes in two aspects of conflict resolution:
1. Minimizing the amount of data that you must resolve when a conflict occurs.
2. Clearly displaying the results of a conflict to help you detect the actual changes that were made by the
manufacturer.
TechSight/X CMS ATA detects changes at the anchor level to minimize the chance of a manufacturer revision
becoming a conflict. If the airline modifies one subtask in a task, but the manufacturer revises another, there is
conflict. The new manufacturer subtask is merged into the airline fragment without a conflict. On the other hand, if
the manufacturer revises the same subtask, then TechSight/X CMS ATA must flag this as a conflict, and you must
manually fix the conflict. A conflict also occurs if a child anchor is added or removed from its parent. For example, a
conflict in an airline-owned task arises if a new subtask is added to the task, or if a subtask is removed from the task.
TechSight/X CMS ATA provides help with conflict resolution in the following ways:
• The TechSight/X CMS ATA Conflict tab provides a quick method for you to work with all of the objects that
are in conflict after a revision import. Depending on how your user preferences are set, TechSight/X CMS ATA
displays fragments in a comparison, side-by-side single instance view, or fragmented displaying each version in a
separate view. See for details about configuring fragments in conflict are displayed.
• Preview a conflict from the Navigation tab using the TechSight/X CMS ATA Preview feature in the Authoring
Options menu item. This allows you to see the airline and the manufacturer changes side-by-side, along with
revision markup to know what changed on the manufacturer side to cause the conflict (this assumes that the
manufacturer put in the appropriate revision markup).
• When you edit a fragment that is in conflict, TechSight/X CMS ATA displays the airline and manufacturer
content side-by-side (for fragments in conflict with an HTML or a PDF set, and using TechSight/X IETP ATA).
You can cut and paste between the manufacturer and the airline version of the objects to resolve the conflict.
• The XML editor highlights anchors that are in conflict differently, depending on what type of conflict was
generated.
• Preview a conflict from the Inbox tab using the TechSight/X CMS ATA Preview feature in the Authoring
Options menu item. This allows you to see the airline and the manufacturer changes side-by-side, along with
revision markup to know what changed on the manufacturer side to cause the conflict.
ATA-2200 Anchors
The level of revision in a paper manual has always been the page. In the electronic world, however, the page can
mean different things depending on the media on which the data is displayed. Since the page could change, the need
for a different type of container for a revised piece of information exists.
The ATA iSpec 2200 defines the anchor as the minimum unit of revision. There are many rules about anchors that
you must understand to comprehend the revision process as a whole.
Anchors must have a change letter to indicate their status in the current revision of the manual. The ATA anchor
change letters are as follows:
Table 16: ATA Anchor Change Letters
N New
R Revised
D Deleted
U Unchanged
• Anchors must have a revision date that indicates the last time the anchor was modified.
• Anchors can contain other anchors for example, a CHAPTER contains SECTION, SUBJECT, PGBLK, TASK,
and SUBTASK anchors).
There are also rules in TechSight/X CMS ATA that are more specific than ATA to assist with managing the authoring
and conflict resolution processes.
• Adding or removing a child anchor from its parent anchor causes the parent anchor to be revised (for example,
adding a new SUBTASK causes the TASK to be revised).
• Anchors are owned by the airline or manufacturer. This is indicated by the COC attribute being set to "T" for
airline anchors and "F" for manufacturer anchors.
72 | OpenTopic | Authoring Changes in a Manual

• Additional change letters are assigned to fragments that are in conflict. The TechSight/X CMS ATA special
change letters are as follows:

Table 17: Change Letters for Conflicted Fragments

XR Airline and manufacturer anchors are in conflict


ZR The editable fragment that contains this anchor
is in conflict, and this particular anchor has
been revised by the manufacturer, but it is not in
conflict.
XD Manufacturer has deleted an anchor that was under
airline ownership

Assessing the Volume of Conflicts with the Change Manifest


The Change Manifest is a report listing conflicts created from a revision import. It is created when you import a
revision and appears in the Document Information folder in the directory tree for the manual.

Figure 55: Change Manifest folder

Each report gives details about the changes that occurred to a particular fragment, and the actions that need to be
taken.
OpenTopic | Authoring Changes in a Manual | 73

Figure 56: Change Manifest report


The Change Manifest describes the processing that is done at import time:
• creating new airline and manufacturer versions
• capturing information about revised manufacturer anchors and conflicts with airline-owned anchors
• logging actions and determinations
The Change Manifest describes what actions have been taken, and what actions need to be taken when a
manufacturer’s manual revision is imported. Each anchor that was New, Revised or Deleted is accounted for and is
organized according to what has been or must be done. There are four categories:
1. Conflicts with Active Airline Fragments: Manufacturer changes that conflict with airline changes and require
resolution by an author. You must resolve these cases before another release can be done.
2. Conflicts with Deleted Airline Fragments: Manufacturer changes that conflict with airline changes in fragments
that have been deleted by the airline. These cases should be reviewed to determine if the changes made by the
manufacturer alter the airline’s decision that deleted it. If you decide to take action to incorporate any of these
changes into a deleted fragment, the fragment must first be revived by authoring the parent fragment. You must
explicitly decide to either keep the fragment deleted, or to revive it and resolve the conflicts before another release
can be done.
3. Merged Anchors: The manufacturer made changes to anchors in airline fragments that did not conflict with airline
anchors, and these have been automatically merged. These changes should be reviewed for possible impact to
related airline COCs. No action is required – these changes have been incorporated.
4. Accepted Fragments: The manufacturer made changes to fragments where the airline has not made any changes.
These have been automatically accepted. These changes should be reviewed for possible impact to related airline
COCs. No action is required – these changes have been incorporated.

Analyze a Conflict
The following procedure demonstrates how to proceed through the preliminary analysis of a conflict.
74 | OpenTopic | Authoring Changes in a Manual

1. Select the desired manual and then click the Conflict tab in TechSight/X CMS ATA.
2. Select the desired manual and then click the Inbox tab in TechSight/X CMS ATA.
3. Select a conflicting fragment, then choose Preview Document from the Authoring Options menu in the Approved
Pane.
The conflict appears in a browser as a split screen view.
Figure 57: Conflict Preview window

4. Look for airline modified text on the airline side as indicated by COC markup. It does not matter if the COC
contains a REV marker.
Note: COC markup only surrounds text, not attributes.
It is possible for a COC anchor not to contain any COC
markup. In that case, you must open the fragment in an
editor to determine airline ownership.
5. Look for changed text on the OEM (manufacturer) side as indicated by REV markup.
These are the locations that can cause conflicts. Sometimes the change is very small, and the changes are easily
incorporated into the airline's version. Other times the manufacturer change is substantial, but the airline-owned
portions are small. You must make a decision on how to proceed. The options are:
• If the manufacturer made many changes, then you might want to migrate the existing airline changes into the
manufacturer version.
• If there are few manufacturer changes, then you might want to migrate the manufacturer changes into the
airline version.
Note: If the manufacturer version contained a TR,
copy the processing instructions and the information
associated with them, into the airline version. The
processing instructions begin: <TR. Doing this enables
the TR information to show up in the preview and
published fragment.
• You can choose to ignore the manufacturer changes and keep the airline version as is (deleted changes cannot
be ignored).
OpenTopic | Authoring Changes in a Manual | 75

• You can revert the entire fragment of the manufacturer version by selecting Revert to Manufacturer Version
from the Authoring Options menu in the Approved Pane. Airline changes are removed from the fragment and
the conflict is resolved.
• If you cannot edit the fragment because the Edit menu is grayed out, the manufacturer has deleted this anchor.
The only way to approve this type of conflict is to select Accept Manufacturer Deletion from the Authoring
Options menu in the Approved Pane.
• If you cannot edit the fragment because the Edit menu is grayed out, the airline previously deleted the
fragment. If you want to keep the fragment deleted, then select Keep Airline Deleted from the Authoring
Options menu in the Approved Pane.
• If you cannot edit the fragment because the Edit menu is grayed out, the airline previously deleted the
fragment. When the manufacturer revises the fragment and you want to edit the revision, reactivate the parent
of the deleted fragment, then select the reactivated fragment and select the Revert to Manufacturer Version
menu item from the Authoring Options menu in the Approved Pane.
• If the conflict was caused because an imported fragment conflicts with an active temporary revision (TR) and
you want to keep the TR, select Keep Active TR from the Authoring Options menu.
• If the conflict was caused because an imported and activated SGML TR conflicts with an airline fragment and
you want to keep the TR, select Keep Active TR from the Authoring Options menu.
6. If you must edit the fragment to resolve the conflict, select the fragment.
7. Select Edit Document from the Authoring Options menu in the Approved Pane.
The fragment appears in an XML editor for editing.

Edit a Conflict
When you edit a fragment that is in conflict, a draft version of the fragment is created. Unlike an ordinary fragment,
the draft version has an airline component and a manufacturer component to it. When the conflict is analyzed, decide
if you want to start with the manufacturer version and add in the airline changes, or start with the airline version and
add in the new manufacturer changes. In both cases, the result is a fragment that contains airline-owned anchors.
Note: The following example displays the conflict in
Single Instance (comparison) mode. If you want to see the
each version of the fragment separately, change the user
preferences in the Conflict tab. See Conflict Configuration
Tab on page 13 for details.

1. Edit the appropriate fragment in the draft window.


A single object in draft that combines both the airline and manufacturer versions appears in comparison mode.
When the fragment is displayed in the editor, the anchors are color highlighted.
Note: TechSight/X CMS ATA inserts customized tags
into the fragment, such as CONFLICT, COC-VERSION,
COC-PLACE, OEM-VERSION, and OEM-PLACE. Do
not try to move or modify these tags because doing so
can adversely affect the operation of the conflict display
in the XML Editor.
76 | OpenTopic | Authoring Changes in a Manual

Figure 58: Side-by-side Conflict View


2. Delete the red anchors with text stating "The new OEM revision has deleted this anchor, this MUST be deleted
from the Airline fragment".
TechSight/X CMS ATA does not allow validation of a fragment that contains manufacturer deleted anchors. If
you want to keep any airline content from one of these anchors, then you must create a new airline anchor for this
content.
3. Copy and paste green anchors (anchors that were not in the current airline version) from the manufacturer side.
If you are editing the manufacturer version, then it is not necessary to do anything. If these anchors are missing
from the final fragment that is approved, then the airline considers them removed.
Note: If a manufacturer child link that was previously
removed by the airline is reinserted, then the child
becomes reactivated. This process does not recur more
than one level deep.
4. Copy the yellow anchors from the manufacturer side to the airline side, if you are working with the airline version.
OpenTopic | Authoring Changes in a Manual | 77

This ensures that you include the latest manufacturer changes on the airline version. If these anchors are not
copied, then airline-owned anchors from the old version of the manufacturer anchors are created. If working from
the manufacturer side, leave these anchors in.
5. Examine pink, or light red, highlighted anchors. These anchors contain the conflicts.
Although color coding detects anchor level changes, it is necessary to examine these anchors at the element level
to find specific differences. Use the processing instructions that show revision markup on the manufacturer side to
determine exactly what has changed in the current manufacturer revision. Use COC markup on the airline side to
determine what the airline has changed in the past. Incorporate the intent of the light red anchors into the text of
the fragment that you keep.
6. When you have resolved each anchor, double click Done.
Note: In some cases, when you resolve a conflict, the
Done button disappears.
7. When you finish resolving all conflicts, click Resolve Using This Side.
8. Save your changes.
Use the Preview feature to view the fragment.
Editor Conflict Resolution Color Coding
The abbreviations in the columns in the table below are: Manufacturer (MFR) change letters are the ATA-2200
change letters used for Unchanged (U), Revised (R), New (N), and Deleted (D).
Airline ownership is established by the airline author modifying an anchor and approving the fragment. Airline-
owned anchors appear with a light green highlighting.
Table 18: Airline has taken ownership of the anchor by modifying it in a previous revision
Type MFR Change Letter Airline Side MFR Side
Highlighting Hightlighting
1 R Light red Light red
2 D Red with yellow text N/A--deleted
Table 19: Airline has not taken ownership of the anchor
Type MFR Change Letter Airline Side MFR Side
Highlighting Hightlighting
3 R Yellow yellow
4 D Red with black text N/A--deleted
Table 20: Airline version of the fragment does not contain the anchor
Type MFR Change Letter Airline Side MFR Side
Highlighting Hightlighting
5 R Comment using Light red
green text indicating
the approximate
location of
the reinserted
manufacturer anchor
6 N Comment using N/A--deleted
green text indicating
the approximate
location of the new
manufacturer anchor
Note: This might be a new manufacturer anchor, or the
airline might have previously deleted it.
78 | OpenTopic | Authoring Changes in a Manual

Conflict Type Descriptions


1. Type 1 is the typical conflict where the manufacturer has revised an airline-owned anchor. Determine what
changed and then determine how to resolve the conflict.
2. In Type 2, the manufacturer deleted an anchor that the airline had taken ownership of. TechSight/X CMS ATA's
interpretation of the ATA standard has been that manufacturer deleted anchors must go. TechSight/X CMS ATA
does not permit you to approve the fragment until the anchor has been removed from the airline side.
Note: You can keep the airline content if you create a
new airline anchor.
3. Type 3 is really not a conflict per se. There was a conflict in this fragment, and the normal merging of
non-conflicting anchors does not occur if there is a conflict anywhere within the fragment. Verify that the
manufacturer content makes it into the airline fragment. If the manufacturer content does not make it into the
airline fragment, then the anchor becomes an airline anchor.
4. Type 4 is really not a conflict either, for the same reasons as Type 3. In this case, you must remove the deleted
anchor from the airline side.
5. In Type 5, the airline deleted something that the manufacturer has revised. If you examine this change and
determine that it is insignificant, then the change can stay deleted. If the change is significant then you must
decide on the best way to incorporate it into the new fragment.
6. Type 6 is really not a conflict either, since a new anchor by definition cannot be in conflict. In this case, you must
decide where the best location for the new anchor is, or if the new anchor belongs in the airline version at all.

Using Temporary Revisions (TRs)


Manufacturers produce revisions of manuals at regular intervals, commonly 3 to 12 months. When a change is
required for a manual, that is too important to wait for the next scheduled revision, manufacturers create a Temporary
Revision (TR). Often a TR is used to provide safety-related information that cannot wait for the next scheduled
revision. Outstanding TRs are usually incorporated into the next scheduled revision, and the TR is retired at that time.
However, in some cases, a TR can remain in effect across normal revisions.
Importing an SGML TR into TechSight/X CMS ATA
A manufacturer TR is always a fragment of data that adds to or replaces an existing part of a manual. Fragments
in TechSight/X CMS ATA are associated with anchor boundaries to create manageable chunks of information for
editing. Each manual type allows specific elements to contain TRs. For example, pageblock and task anchors are
the fragments used for TRs in an AMM. A TR must be applied to one of these data fragments. TRs are brought into
TechSight/X CMS ATA with a two step process: first the TR is imported using the Admin tool (this has no immediate
effect on the manual); then the TR is activated, incorporating its contents into a manual.
Only one TR is allowed at a time for any given fragment – this is an ATA rule that is enforced by TechSight/X CMS
ATA. The activation of a TR fails if a prior TR is already active on the same fragment. The prior TR must be retired,
and then the new TR can be activated.
When a TR is activated in TechSight/X CMS ATA, it is always maintained as a whole, and its content is never
automatically merged with any existing manufacturer or airline data. TechSight/X CMS ATA’s handling of the TR
activation depends up the state current state of the portion of the manual affected by the TR. This can be broken down
into three cases:
1. The TR modifies a part a manual that the airline has not modified.
2. The TR modifies a part of a manual that the airline has modified.
3. The TR is adding a new fragment to the manual (for example, a new task).
The actions required after TR activation are different in each case. For 1, the TR is automatically approved, and is
ready to be published with no further action. For 2, a conflict is set between the TR fragment and the existing airline
fragment . This conflict must be resolved by taking 1 0f 2 actions before it can be published:
• To accept the TR, which automatically deactivates the prior airline version (the manufacturer version remains
inactive).
• To revert to the manufacturer’s version. This gives you a record of the resolution in TechSight/X CMS ATA,
though in essence it nullifies having imported and activated the TR in the first place.
In 3, you must edit the parent fragment, such as a page block, to add the new fragment to the manual. Editing the
fragment always results in the airline “owning” the fragment, and the content becomes your responsibility. The
content is tagged with the TR number, and tracked as a TR by TechSight/X CMS ATA. However, since you can
OpenTopic | Authoring Changes in a Manual | 79

merge the TR content with original manufacturer content and whatever airline changes they choose, TechSight/X
CMS ATA cannot distinguish these. Consequently retiring this TR later on is best done by authoring, and not by
retiring the TR.

Activate a TR as a Supplement
You can scan and attach a non-SGML TR to a fragment as a hyperlinked supplement. Adding a supplement is
essentially the same process as adding a graphic.

1. Navigate to the editable fragment that you want to associate with the TR.
2. Select Edit Document from the Authoring Options menu in the Approved Pane.
The XML editor appears.
3. Insert a SUPPLEMENT element in a valid location.
Note: A valid location for the SUPPLEMENT is
typically defined in the DTD to immediately follow the
document element in an editable fragment.
The Insert Supplement window appears.
4. In the Graphics list, a list of the graphics included in the draft fragment, currently being edited is displayed.
(When you are editing a fragment, all of its children are also added to the draft folder.) When you select the
Preview check box, you can select a GRAPHIC in the list and see it in the Preview frame.
80 | OpenTopic | Authoring Changes in a Manual

Figure 59: Insert Supplement dialog


5. If you cannot view the supplement you want, then import a new one from the file system by clicking Import
Supplement.
Note: The supplement import process currently supports
CGM, TIFF, Text, MS Excel, MS Word, GIF, JPG,
and PDF. You must configure TechSight/X CMS ATA
to use the appropriate Web browsers to support your
supplement file formats.
OpenTopic | Authoring Changes in a Manual | 81

Figure 60: Import Supplement dialog


6. Use the Drive, Folder, and File list boxes to navigate to the system location where graphics are available. When
you select the Preview check box, you can select a graphic file in the list and see it in the Preview frame.
The Size field shows an icon referring to the graphic and if it might cause performance problems.
7. Enter a title for the supplement to insert.
8. Click Import.
The Import window closes and the Insert a Sheet window reappears, with the imported graphic in the Graphics
list.
9. Make a selection from the Common/Graphics list.
10. Enter a TR number for the supplement.
This field is optional.
11. Change the effectivity as required.
12. Click OK.
The supplement markup is added to the document.
Note: You must approve the fragment containing the
supplement before it can become active.
82 | OpenTopic | Authoring Changes in a Manual

Activate an SGML TR
In the case of activating SGML TRs, the document administrator must import an SGML TR into TechSight/X CMS
ATA. Refer the TechSight/X CMS ATA User Guide for Document Administrators for details about importing an
SGML TR. After the TR is imported, you can preview and activate the TR.
1. Go to the Temporary Revisions (TR) folder for the manual of the TR you want to activate.
2. Select the TR number in the Pending folder for the TR that you want to activate.
3.
Click the TR menu in the main menu bar.
4. Select Activate TR from the TR menu.
5. Click OK to start the activation process.
The TR window appears and displays messages describing the progress as TechSight/X CMS ATA merges the
revised fragments in the TR with the existing data in the manual.

Figure 61: TR Progress window


An SGML TR that did not conflict with any airline authored changes is automatically approved when it is
activated. The TR moves from the Pending folder to the Active folder and to under the TR tab.
Note: If the TR corresponds to a fragment with an
airline anchor, a conflict is generated, the same as when
a scheduled manufacturer import has revised fragments
that correspond to a fragment with an airline anchor.
You must resolve the conflict by manually incorporating
the TR into the fragment.
6. Click Close.
7. Go to the Conflict tab to see if activating the TR caused any conflicts with existing fragments.
If the TR caused conflicts with existing fragments, you must resolve and approve the conflicts before you can
publish the manual.

Manually Authoring a Non-SGML TR


When a TR is not delivered in SGML format, there are two options for getting a change into a manual. If the TR is
provided as a PDF document, then you can edit the corresponding fragment in the manual, and link to the PDF TR as
a supplement. This is expedient, but not recommended because the original fragment remains, and is presented to the
end user who must click the hyperlink to access the PDF TR.
It is more effective to edit the corresponding fragment. This is done by examining the TR and incorporating the new
information into the corresponding fragment. When you validate the fragment, TechSight/X CMS ATA prompts
you to enter the TR number so it knows the changes relate to a TR. TechSight/X CMS ATA cannot distinguish if the
changes are from the TR or if they are merging with pre-existing airline changes. This means you are responsible
OpenTopic | Authoring Changes in a Manual | 83

for the accuracy of the final content and marking it as a TR. When the time comes to retire this type of TR, if all the
changes you made came from the manufacturer’s TR (and no changes from an airline were merged with it), then
‘revert to manufacturer’ operation is the correct one to choose.
Add a Non-SGML TR
Examine the TR and incorporate the new information into the corresponding fragment. When you validate the
fragment, TechSight/X CMS ATA prompts you to enter the TR number so it knows the changes relate to a TR. Since
TechSight/X CMS ATA cannot distinguish if the changes are from the TR or if they are merging with pre-existing
airline changes, you are responsible for the accuracy of the final content and marking it as a TR. When the time
comes to retire this type of TR, if all the changes you made came from the manufacturer’s TR (and no changes from
an airline were merged with it), then ‘revert to manufacturer’ operation is the correct one to choose.

1.
Click the Authoring Options menu in the main menu bar.
2. Select Edit Document from the Authoring Options menu.
The fragment appears in the XML editor.
3. Go to the location for the new TR.
4. Insert a NEWTR element.
The Insert New TR Dialog appears.

Figure 62: Insert New TR dialog


5. Select TR from the list.
6. Modify the content.
7. Validate and approve the fragment.

Activate a TR that Contains a New Anchor


When you try to activate a TR that has a new anchor, the activation fails. You must edit the manual, and insert a new
TR into it. When you activate a TR with a new anchor, you receive the following message.
84 | OpenTopic | Authoring Changes in a Manual

Figure 63: Insert a NEWTR Element Error Message


1. Follow the steps in Activate an SGML TR on page 82
An error message appears.
2. Select the fragment you want to add an anchor to.
3.
Click the Authoring Options menu in the main menu bar.
4. Select Edit Document from the Authoring Options menu.
The fragment appears in the XML editor.
5. Go to the location for the new TR.
6. Insert a NEWTR element.
The Insert New TR Dialog appears.

Figure 64: Insert New TR dialog


7. Select TR from the list.
8. Modify the content if necessary.
9. Validate and approve the fragment.
OpenTopic | Authoring Changes in a Manual | 85

TRs and Revision Import


When a new manual revision is imported, all fragments that are revised and that also have a TR active are marked
as conflicts. When a manufacturer revises a fragment that the airline has modified, TechSight/X CMS ATA can
merge the manufacturer changes into the airline changes as long as they are anchors the airline has not changed.
However, no merging is ever done with TRs that are active in TechSight/X CMS ATA. Unchanged fragments in the
new revision can also have active TRs, but since there are no new changes, the TR remains active and no conflict is
reported.
For the resulting conflicts, you must determine which version of the fragment you want to keep. Active TRs that do
not create a conflict should also be reviewed, to determine if they need to be retired. Manufacturers may list active
and incorporated TRs in the front matter of manuals, or may provide guidelines based on release dates for revised
manuals and the TRs. There is no structured information in the TR or the revision that TechSight/X CMS ATA can
use to control TRs, so you must use the information in the TRs and the manual front matter to guide the handling of
TRs.
In some cases, you have to do some research to determine whether or not a TR should remain or be removed after a
new manual revision. Some of the situations difficult to assess arise because there is a significant lag time between
the time a manufacturer freezes revision data and the actual delivery of a manual revision. A TR can be issued after
the manufacturers’ internal freeze for the manual has occurred. When it is unclear, the manufacturer should be
consulted.
Conflicts that occur from importing a revision and active TRs are handled the same way as conflicts that occur when
you import a TR.
Retire an SGML TR
A TR is retired when it is no longer needed. In many cases, this happens automatically by the conflict resolution
process when the manufacturer incorporates the TR into the manual and you document administrator imports the
manual revision. In some cases, the manufacturer has a new TR that supersedes an old one. In this case, it is necessary
to remove the original TR before importing the new one. In other cases, a TR might not apply any longer and so it
need to be retired. Some TRs are imported but never activated and need to be retired.
When you retire a TR, the following occurs in TechSight/X CMS ATA:
• The activated TR is moved to the Retired folder under the Temporary Revisions folder.
• Any airline fragments containing the TR return a past version.
• Any references to the TR are removed.
• Conflicts are created for the fragments that were modified by the airline, since the TR was activated.

1. Go to the Temporary Revisions folder of the manual with the TR you want to retire.
2. In the Active folder, find the TR number for the TR that you want to retire.
3.
Click the TR menu in the main menu bar.
86 | OpenTopic | Authoring Changes in a Manual

Figure 65: TR menu


OpenTopic | Authoring Changes in a Manual | 87

Figure 66: TR menu


88 | OpenTopic | Authoring Changes in a Manual

4. Select Remove TR from the TR menu.


Selecting this option removes all the TR data from TechSight/X CMS ATA. The activated TR is moved to the
Retired folder under the Temporary Revisions folder.
Retire a TR Manually
In some cases TechSight/X CMS ATA cannot retire a TR and you must retire a TR manually. Retire a TR manually
when:
• the TR was authored (that is, manually inserted into a fragment) and never activated.
• the previous version of the TR was updated by a revision import where an anchor for a TR was updated but other
anchors in the fragment were not.
• the TR is in a conflicted state.
When you attempt to retire a TR using Remove TR and it fails, the following message appears.

Figure 67: Cannot Retire TR error message


You can retire the TR using the Revert to Manufacturer function. If the TR is in a conflicted state, edit the TR to
remove the conflict.
1. Select the fragment for the TR you want to remove.
2.
Click the Authoring Options menu in the main menu bar.
3. Choose following task to remove the TR manually by first reverting to the manufacturer version of the fragment.
a) Select Revert to Manufacturer from the Authoring Options menu.
The Revert to Manufacturer Version confirmation appears.
b) Select the TR in the Active folder.
c)
Click the TR menu in the main menu bar.
d) Select Remove TR.
The Remove TR confirmation appears.
e) Click Continue.
The TR is moved to the Retired folder.
4. Choose following task to remove the TR manually by first editing the fragment and removing any conflict with
the TR.
OpenTopic | Authoring Changes in a Manual | 89

a) Select Edit Document from the Authoring Options menu.


The fragment appears in the XML editor.
b) Edit the fragment to resolve the conflict with the TR.
c) Save the fragment.
d) Select Approve from the Authoring Options menu to validate and approve the fragment.
The Validate Document Fragment window appears.

Figure 68: Validate Document Fragment dialog


e) Select the TR you want to retire, from the list of TRs.
f) Click Delete.
g) Click Validate.
h) Click Approve.
The TR is moved to the Retired folder.

Approve a TR
After you have finished working with a TR, you must approve it.
1. Select the TR you want to approve.
2.
Click Authoring Options .
3. Click Approve.
The Validate Document Fragment dialog appears.
90 | OpenTopic | Authoring Changes in a Manual

Figure 69: Validate Document Fragment dialog


4. Click Validate.
5. Click Approve.

Authoring Equipment and Wire Lists Manuals


The ATA classification for the Wiring Manual (WM) describes four distinct manuals:
• Wiring Diagram Manual (WDM)
• Wiring Manual Equipment and Wire Lists (WDEL)
• System Schematic Manual (SSM)
• Standard Wiring Practices Manual (SWPM)
While the ATA allows these to be supplied separately, or in various combinations, the wiring diagrams are combined
with the Equipment and Wire lists to form one WDM manual, the SSM is a second manual, and the SWPM is
provided as a third.
The WDM, SSM and SWPM are manuals that follow the standard ATA Chapter, Section, and Subject structure.
Each of these has front matter that provides general explanatory and reference material. The body of the WDM and
SSM have the standard chapter, section, and subject structure, but the content is comprised of drawings, though
textual content is allowed. The SWPM is the "Special Chapter 20" that is a general reference--this is also commonly
referenced from the equipment list.
Note: When you create changes, you can describe them
using the chgdesc element. Comments included in the
chgdesc element are listed in the Revision Highlights.
OpenTopic | Authoring Changes in a Manual | 91

Equipment and Wire List Manual Structure


Structure of the Manual Front Matter
The Manual Front Matter contains the usual parts: Effectivity Cross Reference, Revision Highlights, Introduction, etc.
The only unusual aspect is the size of the introduction.
Structure of the Body for WDM and SSM Manuals
The body of the WDM and SSM manuals consists solely of drawings organized in a CHAPTER/SECTION/
SUBJECT/GRAPHIC/SHEET hierarchy. Each of these levels has a (normally numeric identifier, a title and
effectivity. There is a GDESC element that is also allowed in a SHEET that can contain the only actual textual
content in the body.
Structure of the Body of the SWPM Manual
The body of the SWPM consists only of Chapter 20, organized in a CHAPTER/SECTION/SUBJECT hierarchy using
the special elements SPCHAPTER/SPSECTION/SPSUBJECT ("SP" for Standard Practices). Each SUBJECT then
contains textual content.
Structure of the Equipment and Wire Lists
The ATA structure defines Equipment and Wire data essentially as two database tables. These are provided in SGML
form, with one record, or row, for each equipment identifier or wire. These are very long lists, and this data comprises
the majority of the structured data (SGML) portion of the manuals. The actual drawings are the other large part of the
manuals. In the combined WDM/WDEL, these lists make up over 90% of the SGML.
The older SSWD format, that Boeing used for the wiring manuals, delivered eight distinct lists: equipment, bracket,
circuit breaker, wire, hookup, terminal strip, ground, and splice. Thus, this is a significant change, with the new wire
list incorporating additional data.
One important change is the inclusion of grounds and splices in the equipment list. This provides a place to store
location and other information about these entities.

Support for Equipment and Wire List Manuals


TechSight/X CMS ATA is divided into three major operations: Importing, Authoring, and Publishing. There are
many special internal operations needed to support the unique characteristics of these manuals, but most are for the
Equipment and Wire lists.
The Import and Publishing operations are done the same way as other manuals. This is also true for authoring
the front matter and body of these manuals. Only the authoring of the Equipment and Wire lists is different, and
completely unique.
Manual Front Matter Authoring Support
The Manual Front Matter is fragmented into the usual parts: effectivity cross reference, revision highlights,
introduction, etc. In all other manuals, the introduction is managed as a single fragment. However, the unusually
large size of the WDM introduction requires further fragmentation to yield a manageable size. The introduction is
fragmented at the L1ITEM level. This is accomplished by introducing a special element to replace the L1ITEM only
for the INTRO, L1ITEMASFRAGMENT. Since the element already has full anchor status (i.e. it has a key, change
letter, and rev date) each of these L1ITEM fragments is managed independently with respect to conflict resolution.
Body for the WDM and SSM Manuals Authoring Support
The CHAPTER and SUBJECT are the normal fragmentation level for the body of the WDM and SSM. The
SUBJECT is edited for gaining access to modify, add or delete GRAPHICs and/or SHEETs.
The authoring operations are the same as for other manuals types.
Body of the SWPM Manual Authoring Support
The SPCHAPTER and SPSUBJECT are the normal fragmentation level for the body of the SWPM. The authoring
operations are the same as for other manuals types.
Equipment and Wire Lists Authoring Support
The Equipment and Wire lists are managed in a manner similar to that used for the PNRDATA in the AIPC manuals,
though there are significant differences.
92 | OpenTopic | Authoring Changes in a Manual

Managing Equipment and Wire List Manuals


The Equipment and Wire lists are managed in a manner similar to that used for the PNRDATA in the AIPC manuals,
though there are significant differences.
Importing
The lists, especially the wire list, are very large and can contain many rows of data (e.g. 100,000 wire rows). When
the WDM/WDEL is imported into TechSight/X CMS ATA, the Equipment and Wire lists are separated out and
stored in the persistent manufacturer storage area for the manual as "eqiplist.xml" and "extwlist.xml". Several
search index files are also created with names beginning with "eq" or "wr". Each import captures the complete, new
Equipment and Wire lists, replacing the prior ones, and generates new index files for them.
When a new manufacturer revision is imported, if the manufacturer has changed rows that the airline has modified,
conflicts are reported, as with normal fragments. The changed manufacturer rows are also stored in the docbase as
new versions of the manufacturer object that were created when the row was edited.
Authoring
Objects for an Equipment or Wire Row are created in the TechSight/X CMS ATA docbase only when the airline
authors modify a manufacturer row, or create a unique airline row. To support this, two new object types are added:
"ata_eqrow" and "ata_extwrow". A dedicated search feature is provided for accessing this data.
Initially, the only Equipment or Wire Rows are those provided by the manufacturer, and they all exist in the data files
in persistent storage. Only when you choose to modify a manufacturer row, "ata_eqrow" or "ata_extwrow" objects are
created in the TechSight/X CMS ATA docbase, or, when they create a new, airline unique row. These operations are
always initiated from the dedicated WDM Equipment/Wire List search dialog.
When a manufacturer row is first Edited, an MFR object is created along with an airline draft. When it is Approved
an airline object is created and the draft is deleted. If you create a new airline unique row, an airline object is initially
created as well as an airline draft. When the draft is Approved, the airline object is versioned and the draft is deleted.
When the airline objects exist, they are incorporated into the normal TechSight/X CMS ATA Navigation, Conflict,
Draft and Approved displays. In the Navigation view, they are located under the Globals folder at the top level of
the manual. Subsequent Editing operations on one of these existing objects creates a draft. When the draft changes are
complete and Approved, the airline object is versioned and the draft is deleted.
When a new manufacturer revision is imported, or if the manufacturer changed rows that the airline has modified,
conflicts are reported, as with normal fragments. Each conflict must be resolved by Editing the Equipment or Wire
object, and making the appropriate decisions on how to resolve the conflict.
Publishing
The older SSWD format that Boeing used for the wiring manuals delivered eight distinct lists: equipment, bracket,
circuit breaker, wire, hookup, terminal strip, ground, and splice. These continue to be the form delivered to the
TechSight/X CMS ATA end-user.
The publishing process takes the latest manufacturer Equipment and Wire lists, merges in the approved airline rows
from the docbase, and then proceeds to generate the eight lists as "views" into the Equipment and Wire lists.

Interfaces for Equipment and Wire List Manuals


Unique interfaces have been created to support the authoring for the Equipment and Wire lists in an efficient manner,
while retaining standard TechSight/X CMS ATA characteristics.
When an airline version of an Equipment or Wire Row exists, all the standard Navigation, Conflict, Draft and
Approved operations are done as with all other TechSight/X CMS ATA fragments. In the Navigate tab, all the airline
rows are in the Airline Global Objects folder. Manufacturer rows that have no airline COCs are accessed
with a search dialog and do not appear in the Navigate tab.
A special Search dialog is used to search the manufacturer lists and all approved airline objects. You can search the
data and select a row for Editing, creating an airline version of the row.
Small dialogs are accessed from the Search dialog to create new, airline unique Equipment or Wire Rows. These
gather a minimal set of data, and then proceed on to the normal editing process.
OpenTopic | Authoring Changes in a Manual | 93

Editing of the Equipment or Wire Rows is accomplished with custom dialogs. These provide a convenient and
organized way to view and edit this data, avoiding the need to use an XML editor for changing these small row
"documents". Special features streamline the process of resolving conflicts with manufacturer changes.

Search the Equipment and Wire Lists


The Search dialog has three major parts: Search Criteria, Search Results and Create a New, Unique Airline Row.
The Search dialog is always the place to start when you want to edit a manufacturer row, or Create a New, Unique
Airline Row.

1. Select a part of the content of a WDM.


2.
Select the Authoring Options menu.
The Authoring Options menu appears.

Figure 70: Authoring Options menu


3. Select Search WDM Lists.
The WDM Search Lists dialog appears.
94 | OpenTopic | Authoring Changes in a Manual

Figure 71: Search WDM Equipment and Wire Lists dialog


4. Select a field and value you want to search in the Search Equipment List or the Search Wire List column.

Click the Help icon next to a field to view hints for the required values.
The search hints provide some information on the normal values for a field, as specified by the ATA. However,
the actual data might contain values that do not conform. Entering invalid values calls a warning.
Note that there is no general wire number search, only a search for a wire number within a bundle. Thus, a
complete Bundle Number must be specified to locate a Wire Number.
OpenTopic | Authoring Changes in a Manual | 95

Figure 72: Equipment and Wire Lists Search Hint


Search Results display the results of a search (up to 25 items). If the search yields more than 25 matches, then the
"Go to page", "Prev" and "Next" operations are active to allow access to the desired portion of the results. Search
results are limited to 1,000 items (40 pages of 25). Use a more specific search if too many results are received.
The Class column on the left displays one of three values:
• mfr_original--This is data from the lists in persistent storage, and indicates this row has not been modified by
the airline.
• airline_chg--This is an airline object that was created by editing a manufacturer row. This appears once the
first airline change has been approved. These objects also show in the Navigate, Conflict, Draft and Approved
Panes, as appropriate.
• airline_new--This is an airline object that was created wholly by the airline; it has no manufacturer
relationship. These objects also show in the Navigate, Conflict, Draft and Approved tabs, as appropriate.
All Equipment or Wire items that have been created by the airline (airline_new) are listed first, followed by all the
manufacturer (mfr_original ) and airline-modified manufacturer (airline_chg) items.

Create an Airline Version of a Manufacturer Equipment or Wire Row


To modify a manufacturer row, first perform a search and select the desired item. Manufacturer items that have never
been modified by the airline are classified as "mfr_original".
1.
Select the manufacturer row you want to modify using Search WDM Lists from the Authoring Options
menu.
The WDM Search Lists dialog appears.
Manufacturer items that have never been modified by the airline are classified as mfr_original.
2. Click Edit in the Search Results box.
A copy of the row data in a manufacturer object is created in the docbase. A draft is also created and opens in the
editor. From this point, the new Equipment or Wire row is accessible from the normal TechSight/X CMS ATA
Navigation, Draft and Approved tabs.
Note: To edit an existing Equipment or Wire row
from a TechSight/X BPM integrated publication, go
to TechSight/X BPM to create a Task that references
the selected Equipment or Wire row and route it
to the Inbox to do the authoring. Click Edit from
the Search WDM Equipment and Wire Lists
96 | OpenTopic | Authoring Changes in a Manual

dialog, and then click OK in the following message

dialog:
When first edited, the Equipment and Wire rows are initially drafts and do not appear as an "airline_chg" in any
search results until approved for the first time. The manufacturer row appears in the search results until the draft
is approved. An attempt to edit the draft generates an error--airline drafts must be edited the first time from the
TechSight/X CMS ATA Navigate or Draft tab.

Create a New Airline Equipment or Wire Row


The lower Create a New, Unique Airline Row frame of the Search WDM Equipment and Wire Lists dialog has
two buttons: Create Equip Row and Create Wire Row. Selecting either of these opens a dialog for entering the
minimum information necessary for that type of row.

1.
Select the manufacturer row you want to modify using Search WDM Lists from the Authoring Options
menu.
The WDM Search Lists dialog appears.

Figure 73: Create Airline Equip Row dialog

Note: An Equipment Row, the Equipment Identification


Number (EIN) value that is provided cannot be changed
later. Enter it carefully.
OpenTopic | Authoring Changes in a Manual | 97

Figure 74: Create Wire Row dialog


2. If creating a new Wire, note that the Bundle number and Wire number provided cannot be changed later. Enter
it carefully. During later editing, you can change an ACTWIRE to an INACTWIRE, or vice versa. If you are
creating a new SPAREPIN, you cannot change the EIN later, nor can you change it to an ACTWIRE or an
INACTWIRE.
The following confirmation appears.

Figure 75: Airline Object Creation confirmation


3. After creating the new Equipment or Wire row from the Search WDM Equipment and Wire Lists dialog, click
OK in the following message dialog.
To Edit a newly created Equipment or Wire row from a TechSight/X BPM integrated publication, go to
TechSight/X BPM to create a CR that references the new Equipment or Wire row and route it to the Inbox to do
the authoring.
When the Create New button is selected on one of these dialogs, a new airline object is created, then a draft of
that, and then the editor is displayed for making changes. As when creating from a manufacturer row, the new
Equipment or Wire row is accessible from the normal TechSight/X CMS ATA Navigation, Draft and Approved
tabs.
Note: The new Equipment and Wire rows are initially
drafts, and do not appear in any search results until
approved for the first time.

Editing Wire and Equipment Rows


Custom editors are provided for editing WDEL Wire and Equipment rows. Instead of using a generic XML editor,
these are custom form-based editors that allow you to focus on the actual content and not worry about the XML
tagging.
The editors are invoked whenever a Wire or Equipment row is edited:
• performing an EDIT of a selected row from the Search dialog
• performing a Create Equipment Row or Create Wire Row from the Search dialog
• performing an EDIT from the normal TechSight/X CMS ATA Navigation, Draft or Approved tabs
98 | OpenTopic | Authoring Changes in a Manual

The editors present the various elements in the XML as fields with labels, which correspond to the XML element
or attribute names. The actual meaning of the fields is not addressed here, nor are the rules about how to fill in the
content. Refer to manufacturer or ATA documentation. The Equipment and Wire rows are very different, but there
are some parts that are similar: KEY, CHG, REVDATE Attributes, CHGDESC elements, Effectivity, References, etc.

Common Editor Features


The following features make up the editor:
• The Save button saves all changes made and exit the editor. No validation is done. Starting another EDIT
continues where you left off.
• The Cancel button exits the editor without saving, discarding any changes you made.
• The Help button displays a short description of the operation, distinguishing between one of three distinct
situations:
• Editing Airline Changes to MFR Wire Row
• Editing Airline-Created Wire Row
• Conflict Resolution Editing Mode
Edit Wire and Equipment Rows
The boxes seen in the editor always display the values that are currently active, the airline's Customer Originated
Changes (COC) value (if one has been set) or, the manufacturer value (if one has not been set). There are three kinds
of boxes:
• Simple text boxes with a label to the side used for most fields
• Multi-line text boxes with a labeled button to the side (used only for EFFRG)
• Combo, or pull-down boxes, with a down arrow button on the right and a labeled button to the side used for fields
that can have multiple values
1. For all the simple text boxes (a box where there is a single, simple value for the field) the editor continually
compares the airline value in the form viewed to the latest manufacturer value and highlights the box in light blue
when there are any differences. These are the airline Customer Originated Changes (COCs). Mouse over one of
these light blue boxes to see the manufacturer value and to easily compare the airline and manufacturer values.
If a change that reverts back to the same value as the manufacturer's is made, the field no longer has a light blue
highlighting and is no longer a COC.
2. To edit any of these simple text boxes, place the cursor in the box and edit the desired value. Double-clicking
on the box brings up a dialog that displays both the current airline and manufacturer values. You can change the
airline value here, or if the left arrow between the values is clicked, the manufacturer value is transferred to the
airline, restoring their value and removing the airline COC.
3. All EFFRG and REFINT/REFEXT boxes are not directly edited. Use specialized dialogs to control changing
the values that are invoked by clicking the label button. However, like the simple text boxes, these boxes use the
same light blue highlighting to indicate an airline COC. Mouse over the box to see the manufacturer value for
comparison. Note that for REFINT/REFEXT, the content field is filled in by the Reference selection dialog, but
you can edit it to provide a more verbose explanation. The length of your explanation is limited due to the form-
based display of this data in TechSight/X CMS ATA.
4. There are multi-valued combo or drop-down boxes that have a pull-down arrow on the right. Due to the possible
multiple values, these do not show highlighting to indicate a COC, but clicking the labeled button next to the box
brings up a dialog that also displays the manufacturer values. Buttons on those dialogs allow you to restore the
original manufacturer values
Change EFFRG
When you click the EFFRG button, a dialog is displayed that lists all the aircraft from the effectivity cross reference
in the front matter of the WDM. There is a check box next to each with marks corresponding to the current EFFRG
value.
Check or uncheck aircraft as needed to create the needed EFFRG. When closed, the most compact set of range
values are computed (i.e. "010 025, 029 034, 123 999") and returned to the display.
The Effectivity and Tail Number dialog appears.
OpenTopic | Authoring Changes in a Manual | 99

Figure 76: Effectivity and Tail Number dialog

Change REFINT and REFEXT


Browse and select the desired target, which automatically transfers the proper information back to the row. You can
edit the "Ref Content" field, as there are cases where the selected target may not provide very useful information, but
the other fields cannot be edited except by using the browse feature.

When you select the Browse for Reference button, the following dialog displays.
The Equipment and Wire List dialog appears.
100 | OpenTopic | Authoring Changes in a Manual

Figure 77: Equipment and Wire List dialog


Note: HDIAGNBR references must be a REFINT (a
diagram within the WDM), and CH20REF references
must be a REFEXT
Change the CHGDESC
Context for the current task
1. Enter or remove one or more CHGDESCs.
2. Delete all old CHGDESC values.
3. Enter a new CHGDESC value for the change you are making.
This change is composed into the Revision Highlights when the new revision of the manual is published.
Note: The REV Attributes frame is a display of the
CHG, REVDATE and KEY attributes on the airline row.
The KEY is never changed under any circumstances, and
the CHG and REVDATE are automatically managed by
TechSight/X CMS ATA, so these fields are view only.
Equipment Editor Features
The equipment editor displays the EIN information on the top left, the fleet and manual on the top center, and the
primary action buttons on the top right. The EIN is the primary identifier for the row and is always display only. The
EIN-MFR is defined by the ATA, but is disabled at this time because it is not currently used in manufacturer data.
The content is organized into four tabs:
• PART, for the basic part information
• REFERENCES, for the HDIAGNBR, C20REF, and DWG references
• LOC/PNL/BKT/MATE, for a collection of location, panel, bracket and/or mate with data
• EFFECT/MISC, for Effectivity, Revision Attributes, etc.
OpenTopic | Authoring Changes in a Manual | 101

Figure 78: TechSight/X CMS ATA WDEL Equipment Row Editor

Deactivating and Reactivating an Editable Fragment


You can deactivate any editable fragment by editing its parent, removing the child element for the fragment that is
deactivated, then approving the parent. You can reactivate any editable fragment that was deactivated by the airline.

Deactivate a Child Element


The following example demonstrates deactivating a particular in a Airbook manual.

1. Using the Navigate tab in TechSight/X CMS ATA, locate the PAGE to deactivate.
2. Select the parent, which is a SECTION.
3. Select Edit Document from the Options menu in the Approved Pane.
4. With the SECTION fragment open in the XML editor, select the child element referring to the PAGE you want to
deactivate and delete.
5. Check the SECTION fragment in and go through the validate and approval processes as usual.
The PAGE that was deactivated becomes inactive until reactivated. Only decativated children that have been
checked in can re reactivated.
Note: The dialog informs that these children and their
descendants are being deleted. To reactivate the deleted
children, see Reactivate a Child Element

Reactivate a Child Element


You can reactivate any editable fragment that was deactivated by the airline. Airline deactivation can occur by
deleting the CHILD from the parent and checking it in, or by performing a Revert to Manufacturer operation.
102 | OpenTopic | Authoring Changes in a Manual

Figure 79: Reactivation of an Inactive Child dialog


Note: Manufacturer deleted fragments can not be
reactivated

The process for reactivating an airline fragment is accomplished when inserting a new child element. If TechSight/
X CMS ATA finds any inactive children of this fragment then the Reactivate button on the Insert Child window
becomes available.
Note: The reactivation process is not recursive. If you are
editing a Chapter, for example, and reactivate a Section,
you must go into that Section and reactivate the Items
contained in the Section.
1. Click Reactivate to open the Inactive Children window.

Figure 80: Inactive Child Tags dialog


2. Select a deactivated fragment.
3. Click Activate.
A CHILD tag pointing to the inactive fragment is added into the document. When you the fragment is approved,
TechSight/X CMS ATA reactivates the airline version of the child fragment.

Validating Links
You can validate references to published fragments using Validate Links from the Authoring Options menu.
When you click Validate Links all internal and external references (within the same fleet or cross-fleet) are checked
OpenTopic | Authoring Changes in a Manual | 103

to ensure that the reference location exists within the latest published manual. Validating links shows you both a
link that is broken, and a target that is missing. When you validate links on a fragment that has deleted anchors that
are referenced in another fragment, TechSight/X CMS ATA reports the missing anchors and broken links they are
causing.
Note: If the link references an anchor you have deleted
in a document that you have not published and released,
the link appears valid because it is referencing that latest
released fragment (in which the anchor still existed). After
you publish and release the fragment, and validate links,
the broken link appears.
A report is produced that identifies any references that are invalid. References become invalid when an anchor has
been deleted, and the reference has not. The report includes internal and external references. It also identifies draft,
approved, and released references that become invalid on approval.
You can execute the Validate Links menu option from the Navigate, Draft, or Inbox tab or the Draft pane.

Validate Links
Validate links in fragments in the Navigate, Draft, or Inbox tab or the Draft pane after you make changes to a
fragment. Validate Links helps you confirm that a new link is valid.

1. Select the fragment whose links you want to validate.


2.
Select Validate Links from the Authoring Options menu.
The Link Validation results window appears. In this case there are no broken links.

Figure 81: Link Validation results window


104 | OpenTopic | Authoring Changes in a Manual

Note: When you delete an anchor that another fragment


is referencing, the invalid link does not appear here,
because the fragment with the reference has not changed.
Publish and release the edited fragment, then repeat this
procedure on the edited fragment. When you validate
the links on a fragment with missing anchors, the invalid
links appear. See Validate a Fragment for details on
fixing broken links.

Validating and Approving Fragments


TechSight/X CMS ATA provides a controlled process for getting changes into a manual fragment. Nothing gets into
a manual until there is a reasonable certainty that it is a valid change. The first part of this check and balance is the
limited access rights. Only a user in the author group can create a draft or validate. A user must be in the reviewer
group to approve a validated fragment. The author is responsible for making any changes that are required to make a
valid fragment. A reviewer can view a fragment, but not edit it. In practice, an author is often assigned to fill both of
these roles. Users in both roles can perform the validation and approval in a single step. (See the TechSight/X CMS
ATA User Guide for Document Administrators section onTechSight/X CMS ATA Role-Based Security for more
information on how TechSight/X CMS ATA uses groups to control access.)
Validation is the workhorse of the validation/approval cycle. Validation determines what has changed, and it provides
revision markup that highlights recently changed parts of the manual fragment. This makes it convenient for an
independent reviewer to quickly spot the changed portions of a fragment.
Note: Revision validation only applies to ATA manuals.

Running the Validation process initiates the following steps that must be completed before you can approve a
fragment.
1. Verifies you have authority to validate.
2. Ensures that the fragment is valid XML and that it parses to the correct DTD.
3. Checks for contradictions in the structure of the fragment.
4. Validates internal and external links.
5. Checks for referenced graphics and makes sure they exist.
6. Requests related information such as authorizing documents and the reasons for revision. This information is
stored in the draft object's attributes.
7. If the XML meets the basic validation requirements, then it moves on to the differencing step. In this step, the
basic checks are as follows:
• The current draft is checked against the original draft to apply change markup (REVST/REVEND).
• The current draft is checked against the most recent manufacturer version to apply Customer Originated
Changes (COC) markup, except in the case of FlightOps manuals..
• The current draft anchors are compared to the most recent manufacturer version's anchors to determine which
anchors belong to the airline.
8. TechSight/X CMS ATA then applies change markup to the draft and checks it in as a new version. You can edit or
view the draft to see the change markup that was applied during validation.

Validate a Fragment
TechSight/X CMS ATA checks many parameters to provide reasonable confidence that the fragment is ready for
approval. This step is where information about authorizing documents, or reasons for change, are entered. Validation
determines what has changed, and it provides revision markup that highlights recently changed parts of the manual
fragment.
Note: Revision validation only applies to ATA manuals.
OpenTopic | Authoring Changes in a Manual | 105

Running the Validation process initiates the following steps that must be completed before you can approve a
fragment.

1. Using the Draft tab in TechSight/X CMS ATA, locate the fragment to validate.
2. Select the fragment, and select Validate from the Authoring Options menu in the Approved Pane.
3. If any fragments were deactivated during editing, a message appears reminding you that deactivation occurs for
the child element listed as well as any descendants of that child.
A validation window appears.

Figure 82: Validation Window 1


4. Click Validate to continue.
A window opens for editing the session.
106 | OpenTopic | Authoring Changes in a Manual

Figure 83: Validate a Document Fragment dialog


5. Add information that is relevant to the approval of this draft, which can include any of the following:
• TRs: Any existing TR information is listed. If a TR no longer applies to the draft, select the entry and click
Delete. To add new TR information, click Add, and enter the TR information in the dialog that appears.
Note: Because TechSight/X CMS ATA, FlightOps
Edition does not support temporary revisions, the TR
area is never populated.
• Authorizing Document. Any existing authorizing documents is listed. If an authorizing document no longer
applies to the draft, select the entry and click Delete. To add new authorizing document information, click
Add, and enter the authorizing information in the dialog that appears.
• Add Comments or Remove Comments. To add other comments, type them directly in the Comments field.
To remove all comment information, click Clear.
Note: When broken internal or external links are
detected, they are listed in the comments and indicate
you have deleted anchors that are being referenced by
other fragments. The fragment number and attribute
reference ID are listed. Go to the fragment and remove
the reference. Search the reference ID in the fragment to
find the invalid link.
OpenTopic | Authoring Changes in a Manual | 107

6. Click Validate to continue.

If there are any markup errors found, an error message is displayed. You must edit the fragment again, and run the
Validate function built into the XML editor to determine what the markup errors are and how to correct them. After
validation is complete, notify the reviewer that the draft is ready for approval.

Submit for Approval


The Submit For Approval menu item is found directly beneath the Approve menu item on the Authoring Options
drop-down menu of the Approved Pane. The Submit For Approval menu option is shown in the following figure.
The Approve menu item is always disabled for a manual that is managed by TechSight/X BPM. It is replaced by
the Submit For Approval menu item. After authoring a fragment, you can select Submit For Approval which
ensures the fragment has been validated, and the CR has been routed to the approver. The fragment then appears in
the TechSight/X BPM Inbox for the reviewer group where it can then be either "Approved" or "Rejected" based on
the decision of the approver.

1. Click the Inbox tab.


2. Select the fragment you want to submit for approval.
3.

Click Options Menu .


The Options Menu appears.
108 | OpenTopic | Authoring Changes in a Manual
OpenTopic | Authoring Changes in a Manual | 109

4. Select Submit for Approval from the drop-down menu.

Revert to Manufacturer Versions


This action deactivates all airline customizations performed on a fragment and revert it back to a pure manufacturer
version. In some cases, this requires reverting the children of the reverted fragment, while in other cases the reverting
of children is optional. The Revert dialog, described in this section, guides you through the process of reverting
descendants.
Note: Since Revert effectively approves an object without
going through validation, you must be in the Reviewer
group to perform this operation.

1. Locate the airline approved fragment to revert.


2. Select the fragment and select Revert to Manufacturer Version from the Authoring Options menu in the
Approved Pane.
3. If the airline version of the fragment is not active, and none of its descendants are active, then message appears
that says "There is nothing to revert".
4. If there are active airline objects in the descendant tree of the object that was selected, then the Revert to
Manufacturer Version dialog that informs you to revert Chapter 22. You also must revert Pgblk 22-00-00-501.
On the other hand, Pgblk 22-12-00-0001 is an airline modified task, but it could remain that way even if the page
block was reverted. You must decide if the entire page block and all contained tasks to be reverted were really
wanted, or if you want the listed task to remain as an airline task.

Figure 85: Revert to Manufacturer Version dialog


5. If you decide you want all the tasks to be reverted to their manufacturer version, then check Recursively change
all fragments. Otherwise, leave this check box unchecked.
6. Click Yes to continue, or the No to cancel the operation.
A confirmation message appears.
110 | OpenTopic | Authoring Changes in a Manual

Figure 86: Revert to Manufacture Version confirmation

View Object Attributes


TechSight/X CMS ATA allows you to view the attributes associated with Draft or Approved objects. For the most
part, the TechSight/X CMS ATA system automatically sets these attributes, and you do not have the required access
rights to manually change them. You can view the attributes to see what values TechSight/X CMS ATA is using
to perform some operations. You can also search for the attributes when you are performing a user query from the
Results tab.

1. Go to the Navigate tab in TechSight/X CMS ATA and select the fleet and manual to edit.
2. Select an editable fragment (denoted by a whole page icon rather than a torn page icon for text fragments or the
graphics icon for a figure).
3. Select Attributes from the Options menu in the Approved Pane.
The TechSight/X CMS ATA Attributes Window appears.
OpenTopic | Authoring Changes in a Manual | 111

Figure 87: Attribute Window

Click the different tabs across the top of the dialog to see a different set of attributes. If values in the attribute field
appear grayed, that attribute is not editable.
Note: The Attributes function is available from either
the Draft Pane or the Approved Pane. Notice that the
attribute values on the draft version are different from
those in the same fragment selected from the Approved
Pane.

Manually Controlling Page Breaks During Publish


Sometimes a minor change in a section can ripple through subsequent pages, causing them to re-paginate. TechSight/
X CMS ATA minimizes this problem by allowing you to insert a point (or alpha) page. Point pages do not disrupt the
historical numbering of the manual. When they are properly located, point pages can contain minor changes avoiding
a content ripple effect on subsequent pages. TechSight/X CMS ATA allows you to manually insert the start and end
of point pages and also insert 'intentionally left blank' pages. For example, if a text change in the source document
removes several pages of text, but you want the subsequent pages to retain their original page numbering, you can
specify the number of blank pages to insert any place in the document.
Note:
Point pages or inserted blank pages can only be used with
the PDF publish processing step.
The point page functionality is made possible with a ITG
Framework application called RenderDataCPA. This
112 | OpenTopic | Authoring Changes in a Manual

application requires additional installation procedures. See


the TechSight/X CMS ATA Installation and Configuration
Guide, 5.8.1 for details.

Insert a Point Page Section


Designate a point page section of pages. The section of point pages is numbered separately from the rest of the
section. The numbering for a point page section begins with the page number prior to the beginning of the point page
section, appended with a sequential number or character. Once the point page section ends, normal page numbering
continues.
Note: You can only insert a point page section when you
publish to PDF.

1. Open the fragment you want to revise.


2. Make the necessary revisions.
3. Save the revisions.
4. Preview the fragment.
5. Compare the fragment to the original.
Note: Determine how your revisions have changed the
page numbering.
6. Determine where to start and end the page point section so to minimize the disruption to page numbering made by
your revisions.
The start should be somewhere within the changed text area or immediately following it, but prior to the next page
break (before an odd number page if in duplex mode). The end should be just prior to the first (odd) page of the
previous revision that follows the changed area. This ensures that the content ripple effect of the text change is
stopped at this page.
7. Enter the processing instruction at the location where you want the point page section to begin.
<?dmt-pp point="start"?>
8. Enter the processing instruction at the location where you want the point page section to end.
<?dmt-pp point="end"?>
9. Save your changes.

Insert a Blank Page


Sometimes the deletion of content causes the opposite effect of adding content--the missing content causes a
“backward” ripple effect. To deal with this situation, you can insert a processing instruction that tells TechSight/
X CMS ATA to insert a certain number of blank pages, in the form of “Intentionally Left Blank”. At the point of
insertion, a page break occurs, and the number of “Intentionally Left Blank” pages are inserted. Zero is also a valid
value; in this case, a page break occurs, but no “Intentionally Left Blank” pages are inserted following the forced page
break.
Note: You can only insert a blank page when you publish
to PDF.

1. Open the fragment you want to revise.


2. Make the necessary revisions.
3. Save the revisions.
4. Preview the fragment.
5. Determine where you need to insert blank pages and how many, or where you want a page break.
6. Enter the processing instruction at the location where you want the page break and subsequent blank pages added.
<?dmt-pp blanks="2"?>
The number between the quotation marks specifies how many pages are inserted. Enter zero to force a page break
without adding any additional pages.
OpenTopic | Authoring Changes in a Manual | 113

7. Save your changes.

You might also like