Sabre Red 360 Developer Toolkit Upgrade and Maintenance

Before you can upgrade to a new version of the Sabre Red 360 Developer Toolkit, you must have installed a previous version. For first-time installation, complete all procedures in Setup for Desktop Red App Development.

Sabre Scribe Compiler Included as a part of the native Sabre Red 360 Developer Toolkit for the Eclipse IDE is a 32-bit Sabre Scribe Compiler (compatible with 64-bit Windows operating systems). Red App Developers can now also get access to Scribe Designer and Compiler tool as a part of the Sabre Red 360 Developer Toolkit, allowing them to Create/Edit & Modify Sabre Scripts and also wrap them into Sabre Red Apps to take advantage of Sabre Red 360 provisioning capabilities. Scribe developers that wish to continue deploying Sabre Scripts in the legacy method can continue using their existing process. The Sabre Red 360 Developer Toolkit Scribe Designer provides the same features as the existing Eclipse Sabre Scribe Developer. For more information of converting Sabre Scripts into Red Apps and the benefits of integrating with the Sabre Red App technology, please visit the integrated Eclipse Red App documentation after Installing the Red App Development Tools Software. That is required to get access to Developer Documentation and Tools, including Sabre Scribe Compiler.To get access to the Scribe Designer and compiler, follow the Sabre Red 360 Developer Toolkit Setup process and then read the Scribe Environment Setup section.For more information on developing Sabre Scripts, view the Sabre Scribe Resources.
Setup for Red App Development.

To upgrade your Sabre Red 360 Developer Toolkit to the latest version, complete all steps in this chapter in the order in which they are shown. The procedures are organized into the following parts:

Upgrading to a New Version of Sabre Red 360 Developer Toolkit

This procedure is organized into the following sections:

Before you begin, obtain the latest version of the Sabre Red 360 Developer Toolkit from the Sabre Dev Studio Red App Developer Resources

Extracting a New Version of the Sabre Red 360 Developer Toolkit

Note
 Remember to retain the same workspace location in Eclipse that you created when you set up your target platform. See Adding a Red App Target Platform.

  1. Download Sabre Red 360 Developer Toolkit file and place it in the *parent folder* that you established for Red Apps when you set up your development environment. (Refer to Step 1 in Extracting the Sabre Red 360 Developer Toolkit).

    Do not delete any of the sub-folders that contain the previous versions of the Sabre Red 360 Developer Toolkit.

  2. After that, close the Eclipse.

  3. On Windows right-click red-app-sdk-….zip file, select Extract All…, then select the place where it should be extracted.

    ExtractCompressedZippedFile.png

    On macOS the file may be already extracted. If it was not extracted automatically - just double click red-app-sdk-….tgz file.

    Winzip-Extracttohere.png

    Alternatively you can use third-party tool (eg. free software like 7zip or proprietary like WinZip).

    Be sure to retain the folder structure while extracting the file.

    The process of extracting the archive file automatically creates a new sub-folder and names the sub-folder with the upgraded version of Sabre Red 360 Developer Toolkit.

    UpgradeToolkit-1.png
    Figure 1. Folders for Multiple Versions of Sabre Red 360 Developer Toolkit

In the example, red-app-sdk-3.0-19.2-windows is the sub-folder with the upgraded version of the toolkit. This sub-folder contains additional sub-folders for the contents of the toolkit. Notice, that folders for the workspace and run configuration are also shown in Figure 1.

Adding a New Target Platform for an Upgraded Toolkit

  1. Open the Eclipse. From the Launch Workspace dialog, choose the location of your workspace. It must be the folder which you created for your workspace in Step 1 of Adding a Red App Target Platform. In this case, the location is C:\sdk\workspace.

  2. On the Eclipse workbench menu bar, choose Window > Preferences (on Windows) or Eclipse > Preferences (on macOS).

  3. From the list on the left, expand Plug-in Development, and then select Target Platform. A list of your target platforms appears in the Target Definitions panel on the right. (See Figure 2.)

    Ec-TargetPlatformUpd-Reload.png
    Figure 2. Active Target Platform on the Preferences Window

    Eclipse should display Active next to your Red App target platform. In the example, the name of the target platform is RedApp.

  4. Click Add.

  5. In Adding the Red App Target Platform, complete Step 8 through Step 20.

    When you finish adding and verifying the plug-ins, Eclipse will display your new target platform configuration, which should be similar to the following:

    UpgradeToolkit-2.png

  6. On Windows (skip this step on macOS) you have to set up an environment architecture.

    When your new target platform is added, your screen should be similar to Figure 3.

    UpgradeToolkit-4.png
    Figure 3. Upgraded Red App Target Platform in Eclipse Preferences Window

What to Do Next

Continue with Upgrading Your Red App Run Configuration.

Upgrading Your Red App Run Configuration

  1. From the workbench menu bar, choose Run > Run Configurations. The Main tab on the Run Configurations wizard is opened.

  2. On the left, select the run configuration that you are upgrading, then open the Plug-ins tab. In the example, the name of the run configuration is RedApp. (See Figure 4.)

    UpgradeToolkit-5.png
    Figure 4. Upgrading Plug-ins in the Run Configuration

  3. Select all of the following:

    • Launch with plug-ins selected below only

    • All plug-ins in the Target Platform group on the Plug-ins list

    • Include optional dependencies when computing required plug-ins check box

    • Add new workspace plug-ins to this launch configuration automatically check box

      You can also select the plug-ins in the Workspace group that you want to launch in Sabre Red 360.

  4. To make sure that you selected all necessary dependencies, validate the plug-ins for their dependencies by clicking Validate Plug-ins.

    If Eclipse successfully verifies the dependencies, the Validation dialog displays a message that no problems were detected.

    If Eclipse finds missing dependencies, the Validation dialog describes the problems it finds.

  5. To repair the problems automatically, click Continue.

    On the Plug-ins tab on the Run Configurations wizard, click Add Required Plug-ins.

  6. Click Apply to apply your changes.

  7. After all, close the Preferences window.

You are done upgrading your Red App development environment.

What to Do Next

Upgrading to a New Version of the Development Tools

When you install a new version of the Sabre Red 360 Developer Toolkit, it is typically installed to a new location. For example, assume that the location of the previous version of the Toolkit and development tools is C:\sdk\red-app-sdk-3.0-windows\devtools. The new location for the new version is C:\sdk\red-app-sdk-3.0-19.2-windows\devtools.

To install a new version of the Red App development tools, complete the following steps:

  1. Add a new location.

  2. Remove the old location from Eclipse.

    • On the Available Software window, click the Manage button (See Figure 5.)

    • On the Available Software Sites window, uncheck the previous version of the development tools. This is the version that you want to remove.

    • Be sure that the checkbox for a new version of the development tools is checked.

    • Click Apply and Close to confirm. Eclipse removes the pointer to the location, while retaining the files on your local drive.

image70.png
Figure 5. Managing software sites

What to Do Next

Target Platform Maintenance Procedures

This section includes the following optional procedures:

Passing Proxy Settings for Sabre Red 360 in Development Mode

Adding and Removing Plug-ins from a Run Configuration

Removing the Red App Target Platform from Eclipse

Passing Proxy Settings for Sabre Red 360 in Development Mode

The following procedure shows you how to store proxy settings in your run configuration. These settings are the same ones that are in the proxy settings window in Sabre Red 360. Eclipse uses these settings every time you launch Sabre Red 360 from Eclipse IDE in development mode. These settings are not stored or used in CERT or PROD.

  1. Open your run configuration in Eclipse IDE.

  2. Next, you need to type the arguments with your values in the Program Arguments field on the Arguments tab. (See Figure 6.)

    Use the following syntax:

    –argument value

    A list of arguments that Red Apps supports follows:

    proxy.host, proxy.port, proxy.user, proxy.password, proxy.domain

    ec-runconfig-proxysettings.png
    Figure 6. Proxy Settings for Sabre Red 360 on the Arguments Tab

Adding and Removing Plug-ins from a Run Configuration

You can add or remove plug-ins from a run configuration. Plug-ins that you add to the Red App target platform from your workspace are available in Sabre Red 360, and plug-ins that you remove from your workspace are not available.

Caution
 Because of plug-in dependencies, do not remove plug-ins from the Target Platform group. Removing a plug-in from the Red App target platform may cause your plug-ins either to become inoperable or to malfunction.

  1. From the Workbench menu bar, choose Run > Run Configurations. Eclipse will open the Run Configurations window.

  2. From the panel on the left, select the run configuration to which you want to add or remove plug-ins.

  3. Click the Plug-ins tab. (See Figure 7.)

    redapp-screenshot-16.png
    Figure 7. Workspace and Target Platform Plug-ins in the Run Configurations Window

The tab lists the plug-ins that are in the workspace and in the target platform.

Next, follow the steps either to add a plug-in or to remove a plug-in.

Adding a Plug-in to the Run Configuration

  1. First, you need to select the check box that is adjacent to the plug-in from the Workspace group.

  2. Then, click Add Required Plug-ins.

  3. When you add new plug-ins, make sure to validate that the dependencies are met. Repeat the steps described in Choosing Plug-ins for Your Run Configuration section.

Removing a Plug-in from the Run Configuration

Caution
 Because of plug-in dependencies, do not remove plug-ins from the Target Platform group. Removing a plug-in from the Red App target platform may cause your plug-ins either to become inoperable or to malfunction.

  1. In the Workspace group, remove the selection from the check box that is adjacent to the plug-in to be removed.

    Omit the steps for validating plug-ins.

  2. If the Apply button is available, click Apply.

  3. Next, click Run to launch Sabre Red 360.

  4. To log in, use your Sabre login credentials.

Tips on Toolbar Icons for Run Configurations

This topic provides tips that are related to run configurations. The behavior of the Run and debug buttons depends on how you defined your launch operation preferences. (For more information about launch operation preferences, consult the Eclipse documentation on Eclipse’s website at www.eclipse.org.).

Run Icon (Eclipse-Runbutton.png)

redapp-screenshot-17.pngClick the down arrow next to the Run icon to either launch the most recent application or to launch the selected resource.

Debug Icon (Eclipse-Debugbutton.png)

redapp-screenshot-18.pngClick the down arrow on the Debug icon to either launch the most recent application in debug mode or to launch the selected resource.

Removing the Red App Target Platform from Eclipse

This procedure removes the Red App target platform from Eclipse and your local drive.

Note
 Use Eclipse to remove the target platform before you remove any files from your local drive. If you do not remove the target platform from Eclipse first, Eclipse displays errors when you try to access components that used the target platform.

  1. On the Eclipse workbench menu bar, choose Window > Preferences (on Windows) or Eclipse > Preferences (on macOS).

  2. Next, expand Plug-in Development, and select Target Platform.

  3. On the right, select the target platform that you want to delete, and press the Remove button.

  4. Click Apply and Close.

  5. On your local drive, delete the targetplatform folder for the version that you removed in Eclipse.

    Install-2.png

In the example in the preceding figure, to remove the Red App target platform for old version, you would delete the targetplatform folder in the C:\sdk\red-app-sdk-3.0-windows path.

Development Tools Maintenance Procedures

This section consists of the following procedures:

Removing the Red App Development Tools from Eclipse

Installing the Red App Development Tools after Removal

Removing the Red App Development Tools from Eclipse

  1. Open the Eclipse, then choose Help > About Eclipse IDE (on Windows) or Help > About Eclipse (on macOS).

  2. On the About Eclipse SDK dialog, click Installation Details. (See Figure 8.)

    Ec-RemoveDevToolsWizards.png
    Figure 8. Installed Red App Dev Tools on the Eclipse Installation Details Window

    On the Installed Software tab in the Installation Details window, the Name list should display Red App Dev Tools.

  3. Select Red App Dev Tools.

  4. Click the Uninstall button.

  5. On the Uninstall Details window, select the name Red App Dev Tools. (See Figure 9.)

    Ec-RemoveDevToolsWizDetails.png
    Figure 9. Uninstall Details Window in Eclipse

  6. Click Finish.

  7. When Eclipse is done removing the installed software, the Software Updates dialog prompts you to restart Eclipse. To do it, click Restart Now.

    After Eclipse is restarted, Eclipse displays the Workspace launcher dialog.

  8. Either choose or confirm the path of your workspace for your target platform.

    Verify that the software is no longer installed. Confirm that the Package Explorer and Installation Details do not include the Red App Development Tools.

  9. Open Eclipse and choose Help > About Eclipse IDE (on Windows) or Help > About Eclipse (on macOS).

  10. On the About Eclipse SDK dialog, click Installation Details. (See Figure 10.)

    Ec-RemovedDevToolsWizards-Confirm.png
    Figure 10. Removal of Red App Dev Tools from Eclipse SDK Installation Details

The Red App Dev Tools entry should be removed from the Installed Software tab.

Installing the Red App Development Tools after Removal

If you remove the Red App development tools from the Eclipse, you can easily install the tools again.

  1. Open Eclipse. Choose Help > Install New Software. (See Figure 11.)

    Ec-InstallDevTools-SelectLocationforReinstall.png
    Figure 11. Choosing a Location to Reinstall the Red App Dev Tools

  2. On the Available Software screen, do not add a local location again. Choose the location from the Work With list.

  3. Complete the remaining steps for installation. See Steps 6 – 12 in Installing the Red App Development Tools.

    Tip
    		 Alternatively, you can click Available Software Site on the Install Available Software window. Remove the location that you added previously.

When you are done, verify that Red App Dev Tools software is installed.

  1. Choose Help > Install New software.

  2. Click the already installed? link.

Eclipse displays the SDK Installation Details window. If you installed the Red App Dev Tools successfully, the tools should be listed on this window.