my sabre scribe installation guide

MySabre Scribe

INSTALLATION GUIDE

T a b l e o f C o n t e n t s

Table of Contents ...................................................................................................................... 1 Introduction ................................................................................................................................ 2 Requirements and Downloads ................................................................................................... 3

Downloads ............................................................................................................................ 3 Step One: Install the Eclipse version 3.3 IDE ........................................................................... 4 Step Two: Install MySabre Scribe Developer Plug-ins.............................................................. 4

Install the MySabre Scribe Developer Plug-in as follows: ..................................................... 4 Install the MySabre Scribe Search Plug-in............................................................................ 6

Step Three: Setup Eclipse ........................................................................................................ 8 Select a Workspace .............................................................................................................. 8 Switch to Sabre Perspective ................................................................................................. 9 Create a Project for Existing Scripts.................................................................................... 10 Change Properties and Preferences ................................................................................... 13

Support Information ................................................................................................................. 15 Checking the Plug-in Version .............................................................................................. 15 Installing Future MySabre Scribe Developer Plug-in Updates............................................. 16 Uninstalling MySabre Scribe Developer Plug-ins ................................................................ 17 Help Desk Support .............................................................................................................. 19

Edition 1.2 (December 2007)

© 2007 Sabre Inc. All rights reserved.

This documentation is the confidential and proprietary intellectual property of Sabre Inc. Any unauthorized use, reproduction, preparation of derivative works, performance, or display of this document, or software represented by this document, without the express written permission of Sabre Inc. is strictly prohibited.

Sabre, Sabre Travel Network, the Sabre logo design, MySabre, MySabre Scribe, and MySabre Scribe Developer, the Sabre logo design and Personal Trainer are trademarks and/or service marks of an affiliate of Sabre Inc. All other trademarks, service marks, and trade names are owned by their respective companies.

MySabre Scribe INSTALLATION GUIDE December 2007 Introduction 2

I n t r o d u c t i o n

MySabre® Scribe enhances legacy SabreScribe® functionality by providing additional tools and features that have been requested by Sabre system developers and agencies over many years, while maintaining the ability to use previously developed SabreScribe scripts.

About MySabre Scribe

MySabre® is a Web-based agent booking portal that integrates all the travel information you need – including the Sabre® global distribution system – right from your desktop. SabreScribe is a legacy scripting tool written in 1989 that was modified by rewriting the program with a Java wrapper to continue to run in MySabre® Scribe Developer. The MySabre Scribe Developer is built upon an open source development platform called Eclipse, to which MySabre has added plug-ins to customize the software for use in writing scripts for MySabre This new developer adds several new state of the art enhancements to the product while retaining the two aspects of the products that our clients told us they valued most about the legacy scripting tool:

• A separate file structure of the source code (.sst) and the runtime code (.ssc). • The ability to run current SabreScribe scripts (.ssc) files on MySabre Scribe

Developer runtime without modification. After you have installed and configured MySabre Scribe, you may refer to the following resources for more information:

Related Documents and Training • MySabre Scribe Scripting Guide which helps you develop good scripts

• MySabre Scribe Scripting Reference which provides details about the commands and other constructs of the scripting language

• FAQs (Frequently Asked Questions)

• MySabre Scribe Basic Training Class

MySabre Scribe INSTALLATION GUIDE December 2007 Requirements and Downloads 3

R e q u i r e m e n t s a n d D o w n l o a d s

Prior to installing MySabre Scribe Developer, you must have MySabre and legacy SabreScribe design software already installed on your computer.

Note: If you have previously run SabreScribe scripts in MySabre, then the design module has already been installed.

Note: If you do not already have legacy SabreScribe installed, please click the MySabre Scribe Compiler on the MySabre Scribe Developer Downloads page. For more information on installing legacy SabreScribe, please refer to the MySabre Help Menu and go to “Install SabreScribe for MySabre (pdf).”

D o w n l o a d s

The MySabre Scribe Developer requires that you download the Eclipse version 3.3.0 IDE and the MySabre Scribe Developer Plug-ins.

Please obtain this software only from the MySabre Scribe Developer Downloads page on eServices site as it is essential that the correct version is used. Sabre has packaged all the components of Eclipse needed for MySabre Scribe in the download from Agency eServices.

Note: Because MySabre Scribe is built upon the Eclipse version 3.3.0 platform, you must install software components in the following order:

1.

2.

3.

Eclipse version 3.3.0 IDE

MySabre Scribe Developer (Editor) Plug-in

MySabre Scribe Search Plug-in

MySabre Scribe INSTALLATION GUIDE December 2007 Step One: Install the Eclipse version 3.3 IDE 4

S t e p O n e : I n s t a l l t h e E c l i p s e v e r s i o n 3 . 3 I D E

For MySabre Scribe to function, you must first install the Eclipse version 3.3.0 platform.

Click Eclipse 3.3 (IDE) on the MySabre Scribe Developer Downloads page. 1.

2. Unzip the files into a new directory of your choice where you will store all your Eclipse files (for example, C:\Program Files\Eclipse). Make a note of the location where it is installed, as you will be selecting it with the browse button or typing this directory into the dialog boxes when you install the MySabre Scribe plug-ins, below.

S t e p T w o : I n s t a l l M y S a b r e S c r i b e D e v e l o p e r P l u g - i n s

You must install the MySabre Scribe Plug-ins to create the Eclipse icon on your desktop and load the enhanced scripting functionality. The (two) Plug-ins include the MySabre Scribe Developer (Editor) Plug-in and the MySabre Scribe Search Plug-in.

I n s t a l l t h e M y S a b r e S c r i b e D e v e l o p e r P l u g - i n a s f o l l o w s :

Click the MySabre Scribe Developer (Editor) Plug-in on the MySabre Scribe Developer Downloads page.

1.

2.

3.

Unzip the files (MySabreScribeIDE.zip) to any local folder or your desktop.

Run the installer SABREscribeIDE.exe.

Click Next. 4.

5. Click I Agree to agree to License Terms.

MySabre Scribe INSTALLATION GUIDE December 2007 Step Two: Install MySabre Scribe Developer Plug-ins 5

6. Ensure that the default Sabre Environment path is C:\Sabre|Apps|Scribe

Note: As mentioned in the pre-installation requirements, the legacy Scribe

environment must be already installed on your computer.

Click Next. 7.

8. Select the directory with the Java Runtime Environment directory.

• The default path for your computer’s Java Runtime Environment is displayed (installer obtains it from the Registry).

• If you are going to launch Eclipse with another JRE, browse to the desired JRE directory.

Click Next. 9.


10. Provide the installer with your directory path. It should point to the directory where you unzipped Eclipse.

Click Install. The plug-in installation is complete. 11.

Note: If you want to change Java Runtime that Eclipse uses (for example, in a situation where Java updates itself and changes its directory), you must run this installer again and provide a new Java directory path for the installer.

I n s t a l l t h e M y S a b r e S c r i b e S e a r c h P l u g - i n

Click the MySabre Scribe Search Plug-in on the MySabre Scribe Developer Downloads page.

1.

2.

3.

4.

Unzip the files (SearchPlug-inInstaller.zip) to any local folder or your desktop.

Run the SearchPlug-inInstaller.exe file in your local folder.

Agree to the License Terms.


5. Select the directory with Eclipse.

Note: If you previously added an Eclipse directory path when installing the MySabre Scribe Developer Plug-in (described above), this directory displays in the window; otherwise, the default directory displays.

Click Install. 6.

MySabre Scribe INSTALLATION GUIDE December 2007 Step Three: Setup Eclipse 8

S t e p T h r e e : S e t u p E c l i p s e

Now that you have downloaded and installed the Eclipse 3.3.0 IDE and MySabre Scribe plug-ins you must set up Eclispe.

S e l e c t a W o r k s p a c e

After installing and launching Eclipse (eclipse.exe), the Workspace Launcher displays. Eclipse SDK stores your project in a folder called a “workspace.”

This workspace stores information such as

• A project that contains Scribe scripts

• Scribe environment directory path (which can be set via the toolbar menu Window > Preferences > SABREscribe)

• Customized font colors for syntax highlighting (which can be set via the toolbar menu Window->Preferences->SABREscribe->Colors)

1.

2.

Choose a workspace folder to use for your session.

Note: It is recommended that you create one workspace to store your scripts and select Use this as the default and do not ask again. If you do not select this option, you will be prompted each time you launch a session. However, you can create more then one workspace and keep several different settings described above

Click OK.


3. The Welcome Screen displays. Click X by the word Welcome to close this screen.

S w i t c h t o S a b r e P e r s p e c t i v e

You must switch to the Sabre Perspective as follows:

From the Eclipse SDK menu toolbar, select Window > Open Perspective > Other.

1.

2. Select Scribe.

Click OK. 3.


C r e a t e a P r o j e c t f o r E x i s t i n g S c r i p t s

After you switch to the Sabre perspective, the Scribe Eclipse Platform displays, as shown below.

Create a new Project Resource that contains existing Scribe scripts, as follows:

Select File >New >Project. The New Project window displays. 1.

2. Select General >Project.

Click Next. 3.


4. Uncheck Use default location, as shown below.

Browse to the directory with Sabre Scripts (the default directory is c:\Sabre\Apps\Scribe\Scripts).

5.

6.

7.

Enter an appropriate name for this project such as ScribeScripts.

Click Finish.


8.

The project directory you just created displays in the Project Explorer.

In the Project Explorer, click the ‘+’ sign to expand list of scripts (i.e., "ScribeScripts").


C h a n g e P r o p e r t i e s a n d P r e f e r e n c e s

Before using the Editor you must change the “text file encoding” property and the text editor preference, as follows:

Right click your scripts project (i.e., ScribeScripts) in the Project Explorer and select Properties. The properties for the project display, as shown below:

1.

Under Text file encoding, select Other. 2.

3.

4.

Change the “Text file encoding” properties

Type- "SABRE_SCRIBE"

Click OK.


5.

6.

7.

From the Toolbar Menu, select Window >Preferences.

Change preferences for text editors

Select General >Editors >Text Editors.Make the following changes:

Make the following changes:

• Displayed tab width to 5

• Choose the Insert spaces for tabs checkbox

Click OK. You may now use the Editor for developing scripts. Ready to

Go! Note: For more information on usage and scripting, refer to the FAQs, MySabre

Scribe Scripting Guide, and MySabre Scribe Scripting Reference Guide.

MySabre Scribe INSTALLATION GUIDE December 2007 Support Information 15

S u p p o r t I n f o r m a t i o n

Please follow the suggestions below when you are speaking with support personnel.

C h e c k i n g t h e P l u g - i n V e r s i o n

When reporting issues to the Help Desk or Maintenance Team, the specialist may ask which plug-in version you have.

You can check the plug-in version in two ways:

You may find the file in plug-ins directory of Eclipse. A plug-in name contains date and hour of a build. For example, a plug-in named com.sabre.scribeeditor_1.0.0.v200709261638.jar means that the plug-in was built 26 Sept 2007 at 16:38.

OR

Select Help >Eclipse SDK About >Plug-in Details from the Eclipse interface. Sort by Provider and find Sabre, as shown below:

Note: In both of the examples mentioned above, the version of the plug-in is

v200709261638. Please be prepared to provide the support personnel with all numbers following the ‘v’.


I n s t a l l i n g F u t u r e M y S a b r e S c r i b e D e v e l o p e r P l u g - i n U p d a t e s

1. When advised of the availability of new MySabre Scribe Plug-In updates on the eServices MySabre Scribe Developer Download page, please go to that page and first click on the MySabre Scribe Editor Plug-in Download.

In general use, there should be no need to uninstall the MySabre Scribe Developer plug-ins. Future updates to the plug-ins may be downloaded and installed directly on top of the existing plug-ins.

There is no need to delete any files or to re-install Eclipse 3.3.0.

2.

3.

Please click on Next to run the Installer, Agree to License Terms, and Install when complete.

When finished installing MySabre Scribe Developer (Editor) Plug-in, then click on MySabre Scribe Search Plug-in Download, Next to run the Installer, Agree to License Terms, and Install when complete.


U n i n s t a l l i n g M y S a b r e S c r i b e D e v e l o p e r P l u g - i n s

In general use, there should be no need to uninstall the MySabre Scribe Developer plug-ins. As described elsewhere in this document, future updates to the plug-ins may be downloaded and installed directly on top of the existing plug-ins.

However, in the situation where a MySabre Scribe user may want to restore their system and Eclipse version 3.3.0 platform to the state from the time before the installation of the Developer (Editor) and Search plug-ins for whatever reason, it can be accomplished via the following steps.

(It is suggested that Help Desk assistance be obtained if a MySabre Scribe user wants to Uninstall the MySabre Scribe Plug-ins.)

Uninstalling MySabre Scribe Developer Plug-In

In the Scribe directory (the same one that you pointed to in MySabre Scribe Developer (Editor) installer wizard) you should find:

SABREscribeIDEUninstaller.exe

If you intend to uninstall MySabre Scribe Developer, run the .exe application file, and then you should see following window:


Click the Next button, and the MySabre Scribe Eclipse Editor Plug-in will be uninstalled.

Uninstalling modified Eclipse MySabre Scribe Search Plug-in

In the Scribe directory (the same one that you pointed to in MySabre Scribe Developer installer wizard) you should find:

SearchPluginUninstaller.exe

If you intend to uninstall MySabre Scribe Search Plug-In, run this application, then you will see a similar window as for Uninstall MySabre Scribe Developer Plug-In above. Follow the same instructions, and this will uninstall the MySabre Scribe Search Plug-in.


H e l p D e s k S u p p o r t

Support is available to assist you with any questions related to your installation.

• Sabre Software Desk

– E-mail: [email protected]

– U.S. & Canada: 1-866-334-7551

• Users in all other countries should contact their software support representative

Be prepared to provide the following information

A G E N C Y I N F O R M A T I O N

• Pseudo City Code (PCC)

• Line Address (LNIATA)

• Contact name

• Phone number

• Country

• E-mail address

B R O W S E R T Y P E & V E R S I O N N U M B E R

• Open your browser and choose “Help, About” to locate this information (for example, IE 6.0)

W O R K S T A T I O N C O N F I G U R A T I O N

• Processor (for example, 1.70 GHz Dell Optiplex)

• RAM (for example, 250 MB)

• Screen Resolution (for example, 1024 x 768, 16 bit color)

• Available hard drive space (for example,, 10 GB)

P R E V I O U S S A B R E S Y S T E M P L A T F O R M

• for example, Sabre for Windows, eVoya Webtop

O P E R A T I N G S Y S T E M

• for example, Windows 98, 2000, XP

J A V A P L U G - I N V E R S I O N

• Go to Start, Settings, Control Panel. Double click the Java Cup icon. The About tab contains this information.

C O N N E C T I V I T Y

• for example, dial up, DSL, cable, T1

I S S U E

• Describe your issue have and the exact steps used when you noticed the issue. If possible, please capture a screen shot of the issue.