Skip Navigation

Wrapping Sabre Scribe Scripts as a Plug-in

This procedure shows how to wrap Sabre Scribe scripts as a plug-in. To use this procedure, you must have compiled Sabre Scribe scripts.

Creating a New Eclipse Plug-in Project Without an Activator Class or UI Dependencies

Create a new plug-in project to wrap your Sabre Scribe scripts. Complete all steps in Creating Empty Plug-in Projects with an Eclipse Wizard, but make the change that is described in the following step below. When Eclipse displays the Content screen on the New Plug-in Project dialog, remove the selections from the following check boxes. (See the figure below.)

  • Generate an Activator, a Java class that controls the plug-in’s life cycle

  • This plug-in will make contributions to the UI

Note
 The Open SabreScript dialog is organized into groups. The group name on the dialog originates from the ID property on the Content screen in the New Plug-in Project wizard. You may want to choose a project ID that is suitable for display to end-users on the dialog.

Content Screen in New Plug-in Project

clip image002

 

Creating a Folder Structure for Your Scripts

  1. On your local drive, create a folder structure for your visible and hidden scripts inside your plug-in project. Recommendations are to create a folder structure that is similar to the structure in the next figure.

clip image004

  1. In Package Explorer, right-click the package name of your Sabre Scribe scripts project, and then choose New > Folder. Type a name for your parent folder.

  2. If you have visible and hidden scripts, add visible and hidden child folders.

  3. Using Eclipse, put your scripts into the appropriate folders. Select and copy the scripts on your local drive. Right-click the folder in Eclipse, and choose Paste.

clip image006

        In the preceding figure, SampleScript.ssc is a visible script. The Open SabreScript dialog in Sabre Red 360 displays the names of the scripts in the visible folder to end-users. End-users cannot see HelperScript.scc because HelperScript.scc is in the hidden folder. SampleScript.ssc calls HelperScript.scc.

  1. Open MANIFEST.MF, and then open the Build tab. Add your scripts folder to the binary build.

clip image008

 

  1. Open the Dependencies tab, and then add the com.sabre.edge.app.scribe dependency. On the Extensions tab, click Add.

  2. On the New Extension dialog, add the com.sabre.edge.app.scribe.scriptsprovider extension point.

clip image010

 

  1. On the Extensions tab, right-click com.sabre.edge.app.scribe.scriptsprovider. Choose New > provider from the menu. Add provider properties in the following fields:

visibleScriptsPath

You are required to type the relative path to your folder for visible scripts. If you do not add the folder, Sabre Red 360 cannot display the scripts in this path to end-users on the GUI.
In the example, the path is scripts\visible.

hiddenScriptsPath

In order to make your hidden scripts available to their calling scripts, type the relative path to your folder for hidden scripts. If you do not add the path, your hidden scripts are not available to the calling scripts.
In the example, the path is scripts\hidden.
If you do not want your visible or main scripts to access your hidden scripts, leave this field blank.
Sabre Red 360 never displays the scripts in hiddenScriptsPath to end-users.