T D L H: Echnical Ocumentation Ibrary ELP
T D L H: Echnical Ocumentation Ibrary ELP
Table of Contents
1 Introduction ..................................................................................................................................... 3
2 What’s New ? .................................................................................................................................. 3
3 Profiling for the Technical Documentation Library ......................................................................... 3
Navigation Language ....................................................................................................................... 4
Documents Language ...................................................................................................................... 4
Current Market................................................................................................................................ 5
4 General Information about the TDL ................................................................................................ 6
Feature Improvements.................................................................................................................... 6
5 Software Configuration and Recommendation .............................................................................. 6
6 Using the Technical Documentation Library ................................................................................... 7
Technical Documentation Library access via Business Portal ......................................................... 7
Welcome Page................................................................................................................................. 9
TDL Features.......................................................................................................................... 10
My Favorite Selections .......................................................................................................... 11
Document Search Page ................................................................................................................. 12
Your Selection ....................................................................................................................... 12
Free Search ............................................................................................................................ 12
Navigation panes (Facette boxes) ......................................................................................... 12
Listing .................................................................................................................................... 16
Save Selection ....................................................................................................................... 17
Create or Update a Cart ........................................................................................................ 17
File Naming............................................................................................................................ 19
Carts and Selections ...................................................................................................................... 20
My Carts ................................................................................................................................ 20
My Selections ........................................................................................................................ 22
Archive........................................................................................................................................... 23
Feedback ....................................................................................................................................... 23
Subscription Feature ..................................................................................................................... 24
Help Using the TDL ........................................................................................................................ 24
1 Introduction
This document has been developed to help the Business Portal user understand the way the new
Technical Documentation Library (TDL) works.
It provides an explanation about the various TDL web pages available within the Business Portal, plus
detailed information about the documentation database itself. It also provides useful tips and
workarounds for using the search functions.
2 What’s New ?
New with the Technical Documentation Library in 2015
- Public Cart for Download
o This is a new reference Book that allows finding quickly all existing document
packages. It contains all documents associated with a product and release. The
packages contain Off Line search Tool.see section Documentation packages (Public
Cart for Download)
- OFF Line Search Tool with Public Cart for Download
o This package is a ZIP file for easy download of a dedicated solution OXE, OXO or OT. It
contains an embedded search tool. See section How to search text in pdf
documentation package?
- Subscription
o Being informed of documentation update inside the TDL is now possible since first of
January 2015.
o Every month an email is sent and lists all new update and allows an easy click to open
new document. See section Subscription Feature
Navigation Language
The Navigation Language parameter is used to set the preferred language for browsing the Business
Portal. The TDL is now hosted in the Business Portal and the TDL language for the browser will be the
same.
Documents Language
The Documents Language parameter is used to set the default language that will be used for the first
listing of documents.
The Document Language selected may restrict the number of documents listed. For example, if the
Documentation Language is set to Hungarian, you may only see 50 documents listed, even though
there are over 100 documents available if all the languages and publications are included. It is
recommended to set the parameter to English to display the complete set of documents.
See Language on page 15.
Note: To change the Documents Language to another language in the TDL and not in the Business
Portal, you must first select another language in the Language navigation pane (or Facette
box) and then remove the former document language from the selection. See Your Selection
on page 12.
Current Market
The Current Market parameter is used to define the market for the Business Portal user.
The market is only taken into account for the product OmniPCX Office Rich Communication Edition
and its documentation set.
Two major impacts of the current market setting are:
Some of the documentation has been rebranded and focuses on the specific market to show only
what the reseller is focusing on.
For example, the set known as “4068 IP” is renamed “Octopus Open IP 160” in the Deutsche
Telekom market.
The product itself is renamed and people connected with a particular market will no longer see
OmniPCX Office, but the new product names.
Note: The product renaming function is not yet active in the TDL.
See the list below.
OmniPCX Office Rich Communication Edition
- for Belgacom Market: Forum 700
- for Deutsche Telekom Market: Octopus Open
- for France Telecom Market: E-Diatonis
- for KPN Market: Vox Novo Office
For example, the OmniPCX Office Rich Communication Edition displays as Vox Novo Office for
KPN Market.
Feature Improvements
Search is now across products and releases - no more silos unless requested.
Search is now available within the Business Partner Portal – you no longer need to be in the TDL.
Global search is now possible for a dedicated product or feature across all products, marketing
deliverables, and technical documents.
Off line Search is also available when using the Public Cart for Download reference book.
All documents have been reclassified for greater search accuracy using different characterization.
A Documentation Note is available for the reference book documentation note (for solutions
OXE, OXO, and OpenTouch). It explains the changes in the documentation package release,
similar to software releases.
Cartography (Taxonomy): an Excel file is now available by product/release in the reference book
Documentation Note to facilitate the search of a dedicated document.
Navigation pane (Facette box) search mode is available for dynamic searching on a set of
documents.
Carts enable preparation of a package of documents for download and subscription.
Nearly all documents are now provided in PDF format for instant download, easy reading, and
search.
Subscription: be alerted of changes by e-mail is possible. It will be possible to register/unregister
in a next future. Until this happen a simple eSR or TDL feedback will allow to be added in the
subscription list.
A User feedback collection tool is now available.
Shortcuts and profiling allow quick retrieval of previous search results.
A new event window shares news about the TDL.
It is now possible to customize your own TDL Home page, which allows quick access to a previous
search, or to preferred products.
Method 2
From the Customer Support drop-down menu, select Technical Documentation Library from the
Technical Support option.
Method 3
Select the Technical Documentation Library link from the Popular Links section at the bottom of the
web page.
Welcome Page
This section describes the features available on the TDL Welcome page.
To access this welcome page use the Business Portal Quick Access menu, or click on this URL:
https://businessportal2.alcatel-lucent.com/customer-support/technical-support/tdl
TDL Features
Document Search
Links directly to the document search page.
See Document Search Page on page 12.
What’s New
The What’s New widget displays new activity on the Business Portal,
including new tools and product information that has been added.
Online Help
Provides access to Help information that you may need while using
TDL.
Online Help is also accessible on the search page.
Feedback
Links directly to the Feedback page for you to provide feedback about
the TDL.
See Feedback on page 23.
My Favorite Selections
My Favorite Selections is a set of Web links that allow you to launch a search on a pre-selected list of
documents. All links are called selections and are customizable by each user. Customization is done
on the Carts and Selections page. See Save Selection on page 17 and My Selections on page 22.
By default, four pre-selections are available and are managed by the TDL webmaster.
Your Selection
The Your Selection box shows the level of filters you have set.
To remove a filter, click on the X to the right of the filter name.
To remove all filters, click on the Reset button.
Free Search
Use the Free Search box to search on text that can be part of the document title or found in the
document metadata.
On entering free text, possible matches are displayed below the search box to help refine the search.
Click the OK button to start the search.
The search results list displays possible matches.
You can use the navigation pane boxes to fine tune the search results (see Listing on page 16).
See How to improve the search on page 31 for further information.
Use the + to expand a filter list, and use the checkbox on the right to select a filter.
The number of relevant documents is shown in parentheses to the right of the filter name. For
example, Release 7.0 (4) indicates that four documents match the Release 7.0 filter criteria.
Note: This is a logical number; it may not represent the actual number of physical documents that
will be listed in the search result. Depending on the filter(s) you set, the same document may
be mentioned multiple times in various counters.
Products/Release
Products/Release lets you search for:
A dedicated set of documents that crosses over all releases.
A specific release of a particular product.
All documents are part of a product and release; some of them are common between several
products and/or releases.
An “All Releases” value, such as “BiCS All Releases (1)”, is used when a document is cross-released
within a product. These documents are mainly technical bulletins or troubleshooting guides.
Reference Book
Each document is published for one reference book only.
The following reference book codes are used in the document file names:
Documentation Note DN A pseudo release note dedicated to the documentation package.
It’s a new type of document created to provide information about
the documentation itself, and to explain what is new in a
documentation package. These are related to a solution and a
release, currently OXO, OXE, OpenTouch (OTBE, OTMS & OTMC),
8770.
User Manuals UM An end user document that describes the full set of features for a
particular end user device or application.
User Guides UG An end user document that briefly describes the main features for
a particular end user device or application. It may also apply to
quick guides.
System Documentation SD A documentation-oriented Business Partner installer mainly linked
Administrator Manuals AM to our PABX (OXO, OXE, OTBE, OTMS, OTMC…).
Installation Manuals IM
Developer's Guide DG Document dedicated to Application Partner developers.
Interworking Report IR A document describing interoperability of our solutions with
external company solutions.
Cross Compatibility CC A document used by solution designers and on-site technicians to
check the compatibility of various components of a solution.
Feature List & FL A document used to design the solution.
Provisioning Level
Technical Bulletins TC A technical communication that is provided to communicate main
known issues.
Troubleshooting Guides TG A document used to qualify debugging tools used for Level 2
support.
Release Notes RN Software or Hardware Release Notes, related to components
versions, workarounds and installation procedures, and known
issues.
VirtualCD CD A dedicated package created to help a business partner get the
global documentation package of a product and release in only a
few downloads. It is based on the old Technical Documentation
Database system (TKB).
In Archive, it is only available for releases published before June
2014 and is an image of what was produced by this date. Any
documents produced after June 2014 are not included.
Note: This is a static package; it will be not be updated should any
changes be made to the Technical Documentation Library.
For active releases this is a ZIP file available on an FTP server for
download of a global solution document package.
Public Cart for Download PC ZIP file for easy download of a dedicated solution OXE, OXO or OT.
Contains an embedded search tool .
Note: The Security Advisory (SA) reference book type is no longer visible in the Technical
Documentation Library.
Theme/Feature/Subfeature
The options in the Theme/Feature/Subfeature pane let you filter the documents by characteristic. It
helps to add more filters and focus quickly on a set of documents sharing the same characteristics.
Language
This pane lets you filter documents by the language in which they were written. Select one or more
languages.
Publication Date
This pane allows filtering on four different publication date ranges.
Listing
The listing zone is where you access all documents matching your search result. By default all
contents of the documentation library are listed. The filters you set will determine what documents
appear here.
Document selection
Mark this box to select the document.
Document title
Click to open or download the document.
Preview icon
Click to preview the first 5 pages of the document.
Document language
File size
Publication date
Part number
Edition number
Select the All checkbox to view the exact number of documents in your search result. The All box is
available only if the number of documents in the search result exceeds the number of Result(s) by
page.
Save Selection
When the applied filters and listing are correct, you can save the request by clicking on the Save the
selection button.
Create Cart
To create a new cart:
1. Locate the documents you want added to the cart. Use the Navigation panes or search options to
locate the documents.
2. Mark the checkbox for the documents you want added to the cart.
3. Select the Add to cart button.
When creating a cart take care to select the right set of documents.
In the image below, you can see that only 25 items (rows or documents) are selected. To view the
entire list of documents, click on the purple box.
Update a Cart
To add new items to an existing cart:
1. Select the cart to which you want to add items.
2. Locate the documents you want added to the cart. Use the Navigation panes or search options to
locate the documents.
3. Mark the checkbox for the documents you want added to the cart.
4. Click on the Add to cart button.
Cart Messages
If no documents are selected, you may see the message:
In this case go back to the listing and select documents by marking the selection checkbox to the left
of the file name.
If you get any other message or if it is persistent, enter a service request and get support from
Alcatel-Lucent Enterprise.
File Naming
Note: The following rules do not apply for Technical Bulletin (TC), Technical Troubleshooting Guides
(TG) and Release Notes (RN).
Each document has its own name. Whenever possible, the part number and document language are
indicated in the name.
To see the document’s file name, roll the mouse over the document title.
Note: The language is often also part of the part number (3EU19814ENAB), but not always, as shown
in the exceptions below.
Exceptions:
For documents shared over several releases of the same product line, the release number is not
shown:
oxo_ug_4038_4039_4068_3GV19006BSAB_2_en.pdf
For documents shared between several product lines, the product is not shown:
ug_8125Conf_appairage_bluetooth_8AL90055FRAA_fr.pdf
My Carts
Select the My carts link to view and manage your carts.
To rename the cart, select . Enter the new name and select the Save button.
The cart can be renamed or you can remove documents from the cart by selecting the Remove link.
2. Locate the documents you want to remove and select the Remove button.
This message is displayed at the top of the cart. To save, select the Save button at the bottom of the
cart window.
My Selections
Select the My selections link to view and manage your selections.
To rename the selection, select . Enter the new name and select the Save button.
Archive
The Archive page is accessible through the TDL Welcome page. It is used as the main search page.
You will find the same features as previously described.
Inside the Archive there are mainly CD-ROMs (exe and rar files) generated with the old
documentation knowledge base. They have been kept to allow you to view previous product
documentation and are available for support purposes only. This is to reduce the amount of global
documents available when performing searches.
Feedback
Submit feedback by clicking on the Feedback link located at the top left corner of the Home page.
On the feedback form, enter your information and your feedback. You must specify the subject of
your feedback in the Subject field on the feedback form.
There is no guarantee that you will receive an answer from Alcatel-Lucent Enterprise. Alcatel-Lucent
reserves the right to give an answer or not to feedback.
If you wish to report a technical issue, you must use the technical issues standard process (eService
Request).
Subscription Feature
With the subscription feature you can receive regular e-mail alerts about the documentation
evolution.
There is no automatic migration of existing subscriptions from the previous Technical Documentation
Library to the new one. But we have tried our best to keep you in the loop.
Please use feedback feature or an eSR if you do not received subscription emails.
An excel file, saved at the root of the documentation package, lists all documents and information of
the documentation package.
From this file, you can directly open all documents. Use this file to manage (filter) the documentation
package.
To search text in all pdf files, use “search.bat” (root of the documentation package) to open the
search interface (see How to search text in pdf documentation package).
Or look for the Public Cart for Download reference book in the search page.
By selecting a system documentation package, you access to the Software Download pages:
Select the documentation package to download. A zip file is copied on your computer.
For a better use, you have to unzip the package on your computer.
When you have the part number of the search document, use the Search box and enter the number
without the 8AL as shown below.
The listing result for the English document is shown below. On the left side you will see options for
the other language documents that exist. To view one of them in the listing, click in the requested
language box.
E-mail URL
After a download request you will receive an e-mail with a URL for the ZIP file download.
To use this URL you must be connected to the Business Portal, in else the url will do not work.
End of Document