Professional Documents
Culture Documents
TSX CMS ATA User Guide For Authors All Editions
TSX CMS ATA User Guide For Authors All Editions
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
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
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 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.
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.
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
1. When you open TechSight/X CMS ATA, you are prompted for a user name and password. You can also log in by
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
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.
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.
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
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.
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.
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
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
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".
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
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
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
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.
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
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
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
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
• 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.
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
--
# Default Catalog for Template and other files
#
#
# W3C DTDs and entity sets
#
--
CATALOG "C:/apps/SkyDocClient/XMetal/v5.0/catalog"
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...).
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
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.
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. Select REFINT or GRPHCREF from the Insert Markup window in the XML editor.
The Internal Link dialog displays.
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
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.
<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.
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.
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
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
1. Insert a new SUBJECT (or UNIT in an IPC) tag in the XML editor.
The Insert a New Subject/Unit dialog displays.
1. From within a UNIT element, select CHILD from the Insert Markup window.
The Insert a New Child Figure dialog displays.
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
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.
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.
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.
• 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.
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.
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.
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
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
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.
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
• Additional change letters are assigned to fragments that are in conflict. The TechSight/X CMS ATA special
change letters are as follows:
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
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.
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
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
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.
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.
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
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
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.
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
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.
1.
Select the manufacturer row you want to modify using Search WDM Lists from the Authoring Options
menu.
The WDM Search Lists dialog appears.
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.
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
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
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.
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.
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.
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.
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
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.