Alcatel Manual_e.pdf

ADES CD-ROM INSTALLATION ANDUSER MANUAL

INSTALLATION MANUAL

3BW45194AAAAPCZZA Ed. 03

Status RELEASED 31/01/2002

Short title ADESMUINS

All rights reserved. Passing on and copying of this document, useand communication of its contents not permitted without writtenauthorization from Alcatel.

2 / 24 3BW45194AAAAPCZZA Ed.03

ADES CD-ROM installation and user manual

CONTENTS

1 INTRODUCTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2 SETUP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62.1 Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62.2 Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62.3 Setup modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

2.3.1 Common setup interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

2.3.2 Running the application from the CD-ROM . . . . . . . . . . . . . . . . . . . . . . 8

2.3.3 Full setup (application + collection) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

2.3.4 Application update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

2.3.5 Collection update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92.3.6 How to use the “Browse” button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

2.4 Uninstalling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122.5 Errors and corrective actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

3 RUNNING THE APPLICATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143.1 Application launch in Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143.2 Application launch in Unix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

4 USING THE ADES CD-ROM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154.1 Browsing the CD-ROM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164.2 Search interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184.3 Displaying search results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

4.3.1 Results linked to a given collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204.3.2 Results linked to all collections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

4.4 Displaying an HTML document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234.5 Displaying a PDF document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

3BW45194AAAAPCZZA Ed. 03 3 / 24



1 INTRODUCTIONThe ADES CD-ROM provides an easy-to-use support for browsing ALCATEL documentation on a userworkstation. Each CD-ROM contains a collection of documents that can be installed on a local work-station.

Each collection can be browsed from a scroll-down table of contents where each last item links to oneor several documents.

Each document can be opened as a PDF document (that can be printed) and as an HTML document,where applicable.

The user can also use the search module to find documents according to their properties and contents,using:

- all the collections installed on the workstation,

- all or part of his/her collection,

- previous search results.



2 SETUP

2.1 PrerequisitesThe following must be installed to used the ADES application:

- Acrobat Reader.

- CGM Plug-in.

- Internet Explorer 5.0 (SP2 or higher) or Netscape 4.7.

Hardware requirements are as follows:

- For PCs:

• Windows 95/98/NT SP4/2000 with Pentium II 300Mhz (or higher) or compatible.

• 32 MB RAM available for the application.

• 500 MB of free disk space for full setup or 30 MB for minimum setup.

- For UNIX stations:

• Solaris 2.5/2.7

• 32 MB RAM available for the application.

• 500 MB of free disk space for a full setup or 30 MB for a minimum setup.

Before starting setup in UNIX, the user must make sure the “netscape” command runs the browser.

2.2 ProceduresDepending on OS, the ADES CD-ROM setup procedure is as follows:

Table 1 : ADES CD-ROM setup procedure

Windows OS Unix OS

Insert the CD-ROM in the CD drive. Insert the CD-ROM in the CD drive.

From a Windows explorer window, dou-ble click the “Setup.exe” file located atthe CD-ROM root.

A DOS window pops up briefly, thena JAVA interface opens (see ChapterSetup modes) after a short while.

Open a “Terminal” window.

Go to the CD-ROM using the followingcommand:

“cd /cdrom” then press “Enter”.

type “./setup” then press “Enter”.

The following message appears: “In-stallation program launched, pleasewait...”

Wait for the interface to load; See Chap-ter “Application launch in Unix”

Exit the CD-ROM directory before eject-ing the CD-ROM, (e.g.: “cd /”.



2.3 Setup modesThis product can be used with two setup modes:

- Run from the CD-ROM. See Chapter 2.3.2

- Full setup, on the workstation. See Chapter 2.3.3

And can undergo two types of update:

- Application update. See Chapter 2.3.4

- Collection update. See Chapter 2.3.5

2.3.1 Common setup interfaces

Whatever the setup mode, the initial procedure is common to both modes:

1. Click the “Next” button in the first setup screen.

2. The license agreement is displayed. Read this text and select “I agree”, then click on “Next” ifyou agree with these terms.

3. The following window appears:

Figure 1 : Setup interface



2.3.2 Running the application from the CD-ROM

You can use ADES directly from the CD-ROM. This requires no application to be installed on yourworkstation. To do this:

1. Select the “Setup” icon.

Figure 2 : Setup icon

Note : When selected, the icon is grayed out.

2. Click “Next” and follow the instructions on screen.

3. Once setup is completed, a shortcut is created in the “Start/Ades” menu, pointing to the ap-plication.

Note : If a full setup has already been performed, this setup mode cannot be accessed.

Note : When the application is run from the CD-ROM, the user can uninstall it by simply re-moving the shortcut. To do this, right click on the “Start”menu, select “Browse”, openthe “Programs” directory to delete the “Ades” file, or use the “Uninstall ADES” shortcutin “Start/Programs/Ades” (See Chapter 2.4). This note applies to Windows only.

2.3.3 Full setup (application + collection)

The full product can be installed on the user’s workstation. In this case, he/she will not require theCD-ROM to run ADES.

The procedure is as follows:

1. Select the “Complete” icon then click “Next”.

Figure 3 : Complete icon


2. Click on the “Browse” button to choose the destination directory for your application (see howto use the “Browse” button in Chapter 2.3.6, if necessary).

3. Click “Next” twice to start full setup.

Note : This may take a few minutes.

4. Once setup is completed (progress bar up to 100% + message in the status bar), click “Next”then “OK” to exit setup.

5. Once full setup has finished, a shortcut is placed in the “Start/Ades” menu, from which youwill be able to run the application without CD-ROM.



2.3.4 Application update

This procedure is designed to update the files of a previously installed application.

Note : It is required to update the application for a version upgrade.

1. Select the “Application” icon then click “Next”.

Figure 4 : Application icon


2. Use the “Browse” button to find the directory containing the application files (see how to usethe “Browse” button in Chapter 2.3.6, if necessary).


2.3.5 Collection update

Collections must be updated if you wish to add or remove collections.

The collection update procedure is as follows:

1. Select the “Collection” icon then click “Next”

Figure 5 : Collection icon





Figure 6 : Collection update

You can choose to uninstall a collection (1) and/or to install a new one (2).

Note : The figure shows a single collection (in both cases), but it is possible to selectseveral collections to update or uninstall them simultaneously.

3. Select an option and click “Next”.

Note : The update process may take some time.

4. Follow the instructions on screen.



2.3.6 How to use the “Browse” button

2.3.6.1 Procedure for Windows

Figure 7 : Selection of the application directory in Windows

This allows you to:

- Select the drive on which you wish to install ADES via the scroll-down menu of the window.

- Select the appropriate directory. To do this, double-click the appropriate directory. It is then dis-played in the selection area.

Note : If this directory does not already exist, you can create it by clicking on the

button. A new window opens to allow you to enter the newdirectory name. Type a new name and confirm.

- Confirm your selection by clicking .

- To exit the window and cancel the selection, click .



2.3.6.2 Procedure for Unix

Figure 8 : Selection of the application directory in UNIX

(1) : To browse the parent directory.

(2) : To access your home directory directly (defined in your user profile).

(3) : to create a new directory (called “New Folder”) (if this does not appear, use the scroll bar to goto it). To change the name, click it (it becomes highlighted). You can now change the current name.

(4) : To choose file display mode (list or detailed view).

Note : The application will be installed in the highlighted directory and not in the open folder.The destination directory is that selected and not the open directory.

Click “OK” to confirm your selection.

2.4 UninstallingTo uninstall the ADES application, proceed as follows:

1. Insert the CD-ROM in the CD drive.

2. Run the “setup.exe” file on the CD root directory.

3. Click “Next”.

4. Select “I agree” and click “Next”.




Figure 9 : Uninstall window

6. Select the “Uninstall” icon.


Note : If the program is installed in Windows, you can run the Uninstall ADES shortcut in the“Start/Programs/Ades” menu, after you have inserted the ADES CD-ROM in the CDdrive.

2.5 Errors and corrective actionsErrors may occur during setup. For example, there may be not enough disk space available on yourworkstation.

If such a case arises, read the “Readme” file. This can be accessed:

- in the setup directory.

- from the link on a main page of a given collection. See Figure 12



3 RUNNING THE APPLICATIONThe launch process is different depending on the OS used.

3.1 Application launch in WindowsSelect “Start/Programs/Ades” and run ADES.

Select a browser in the dialog box:

Figure 10 : Selecting a browser

Select a browser from the list or select another (unlisted) browser by selecting the “Other Browser”option and clicking “Browse”.

Note : This screen is only displayed the first time the application is run.This screen may vary according to workstation configuration.

3.2 Application launch in UnixOpen a “Terminal” window and, according to the setup mode:

- Browse to the CD-ROM if the application must be run from the CD-ROM.

- Browse to the installation directory if using a full setup.

- Run the “./search” command.



4 USING THE ADES CD-ROMWhen the application opens, the following interface is displayed:

Figure 11 : ADES CD-ROM main window

The link to the collection (1) opens the following main window:



Figure 12 : Collection main window

This page allows you to open the “Questions and Restrictions” section linked to the ADES CD-ROM(1) or to go to the collection (2). See Chapter Search interface

4.1 Browsing the CD-ROMADES generates a dynamic table of contents that makes it easier to browse the CD-ROM contents.



Figure 13 : Example table of contents

To expand the table of contents, use the following arrows:

- : chapter can be expanded.

- : chapter expanded.

- : lowest level of a branch.

From this table of contents, you can:

- Go back to the main screen (1).

- Access a search interface for the whole collection (2).

- Display a tree structure to refine the search and view documents in the selected branch (3).

ADES offers:

- Different search criteria:

• search all collections (1). See Figure 14,

• search a given collection or a node in this collection (2). See Figure 14,

• search within a search result.



Figure 14 : ADES search interfaces

- Different formats:

• HTML,

• PDF.

Note : We advise you to choose the HTML format to browse documents, when available.Hypertext links are inserted, where applicable, to allow easy browsing through thecollection.When you wish to print all or part of the document, choose the PDF format.

4.2 Search interfaceOn opening, ADES loads the following search interface:



Figure 15 : ADES search interface

(1): Contains a list of available collections.

(2): To enter the text to be searched for within all collections.

(3): To enter the title to be searched for within all collections.

(4): To enter the mnemonic to be searched for within all collections.

(5): To enter the reference of the documents to be searched for within all collections.

(6): To enter the type of document to be searched for within all collections.

(7): To enter search criteria for the alarm and mnemonic dictionaries of all collections.

(8): To start the search.

When performing a search, follow these rules:

- Text fields must not contain the following characters:

• “>”, “<”.

• “[“, “]”.

• “(“, “)”.

• “{”, “}”.

Such characters are prohibited and generate error messages (see Figure 16) in any input field.



Figure 16 : Example error message

The “Back” button is used to return to the search interface.

- The “*” character is used to search a part of a word (text, title, mnemonic, mnemonic/alarm); e.g.:“subs*” will result in searching “subscriber”, “subscription”, etc.)

Note : If you do not use “*”, enter full words for a valid search.

- It is possible to search for more than one word; e.g.: title search: “subs* sw*” will result in occur-rences of titles that contain “subscriber” AND “switch”.

- Searching for a reference, for instance, will result in the following: “*36210*” results in“3BW36210ADAXUBAHB”.

- Querying dictionaries must be an exact match. To search for an alarm, just enter the alarm number,leaving the “0” before. For instance, to obtain alarm “001”, type “1”.

Note : Full text search cannot be combined with a dictionary query.

4.3 Displaying search resultsTwo types of results can be displayed:

- Results of a search over a given collection.

- Results of a search over all collections.

When you perform a full search or a dictionary query in a large file, the result displays part of thedocument.

4.3.1 Results linked to a given collection

Results linked to a given collection are displayed as follows:



Figure 17 : Results in a given collection

(1): To return to the main page.

(2): To access a search interface to search the collection or to search within the result.

(3): Tree structure used to refine the search and display the documents of the selected branch.

(4): Displays the search criteria and the number of results.

(5): Displays the relevance and title of the document.

(6): Alcatel reference.

(7): Release number.

(8): Mnemonic.

(9): Language.

(10): Document type.

4.3.2 Results linked to all collections

Click the “Search” button in the search interface to open the following window:



Figure 18 : List of results in all the collections

(1): Displays the search criteria and the number of results.

(2): Displays the relevance and the document title.

(3): Alcatel reference.

(4): Release number.

(5): Mnemonic.

(6): Language of the document.

(7): Comment on the document.

The user can navigate through the different result pages by clicking on the “Previous” and “Next” links.

The resulting documents can be displayed in two types of formats:

- HTML.

- PDF.

The following icons illustrate such possibilities:



Figure 19 : HTML and PDF icons

Note : If an HTML document is displayed, for a full text search or dictionary query, the wordsfound will be shown in red.

4.4 Displaying an HTML documentADES CD-ROM contains HTML documents.

Figure 20 : Navigating through an HTML document

(1): To display the main page of the document.

(2): To open the document with PDF format for eventual printout.

(3): Links to navigate through the document.

Arrows are used to expand the table of contents as detailed in Figure 13.

Some pages of the document have specific navigation buttons to make browsing easier.



Figure 21 : Navigation buttons in HTML pages

(1): Displays the parent chapter in the tree structure (e.g.: Chapter 3 � Chapter 2 � Chapter 1).

(2): Displays the chapter root (e.g.: Chapter 2.3 � Chapter 2).

(3): Displays the next chapter (Chapter 1 � Chapter 2 � Chapter 3).

4.5 Displaying a PDF documentADES CD-ROM contains PDF documents used to print these documents.

To do this, click the icon.


Documents

Alcatel Manual_e.pdf