Shared JavaScript Libraries

The Shared JavaScript Libraries manager allows you to add, edit or delete shared Javascript libraries and functions:

It is composed of a header bar and two panels: a Library Manager, and a Code Editor. Shared functions can be grouped into libraries although each function is self-contained.

If you do not have the prerequisite access rights, the Shared JavaScript Libraries manager is only available in read-only mode.

Viewing Libraries

To open the Shared JavaScript Libraries manager, perform one of the following actions:

• Navigate to View>Shared JavaScript Libraries.
• Select the button on the Rhapsody IDE menu bar and select Shared JavaScript Libraries.
• Press Ctrl+Shift+S.

The Shared JavaScript Libraries manager provides you with the following panels:

Managing Libraries

The Shared JavaScript Libraries manager enables you to perform the following actions through the header bar:

You can perform the following actions through the right-click menu in the Library Manager panel (actions available through the header bar are not listed):

You can also open the right-click menu by pressing F2.

Adding a Library

To create and add a new library: 

1. Open the Shared JavaScript Libraries manager.
2. Either:
   • Select Add Library in the right-click menu, or
   • Select the Add Library button.
3. Enter a name for the new library, or use the default name provided.

Renaming a Library

To rename a library:

1. Open the Shared JavaScript Libraries manager.
2. Select a library in the Library Manager.
3. Select Rename Library in the right-click menu.
4. Enter a new name for the library.
5. If the library or any function within the library is being used in any components, the Library Uses dialog is displayed. Select the OK to confirm renaming.

Deleting a Library

To delete a library:

1. Open the Shared JavaScript Libraries manager.
2. Select a library in the Library Manager.
3. Either:
   • Select Remove Library in the right-click menu, or
   • Select the Remove button.

4. Select the Yes button in the dialog to proceed, or the No button to abort.

5. If the library or any function within the library is being used in any components, the Library Uses dialog is displayed. Select the OK to confirm deletion.

Showing Library Use

The Show Uses tab in the Information panel of Rhapsody IDE enables you to determine which components are affected when you modify a particular library:

The Show Uses tab provides you with the following information:

To determine which components are using a particular library:

1. Open the Shared JavaScript Libraries manager.
2. Select a library in the Library Manager panel.
3. Select the Show Uses button (or Show Uses in the right-click menu) to display the library's uses in the Show Uses tab in the Information panel of Rhapsody IDE.
4. To view or edit the configuration properties of a component using the shared JavaScript library: 
   • Double-click on the component path.
   • Or alternatively, from the right-click menu, select Open Properties.
5. Select the Close button to close the dialog.

Managing Functions

Adding a Function

To create and add a new function: 

1. Open the Shared JavaScript Libraries manager.
2. Either:
   • Select Add Function in the right-click menu, or
   • Select the Add Function button.
3. Enter a name for the new function in the Library Manager panel, or use default one provided. The function can only be created in a library.
4. Enter the JavaScript code.

Renaming a Function

To rename function: 

1. Open the Shared JavaScript Libraries manager.
2. Select a library in the Library Manager panel.
3. Select Rename Function in the right-click menu.
4. Enter a new name for the function in the Tree View, function name in the code editor will automatically be renamed. 
5. If the function is being used in any component, Function Uses dialog is displayed. Select the OK button to confirm renaming.

Editing a Function

Editing a single shared function checks out whole JavaScript library where the shared function is including other shared functions in it.

To edit a function: 

To delete a function:

1. Open the Shared JavaScript Libraries manager.
2. Select a function in the Library Manager panel.
3. Either:
   • Select Remove Function in the right-click menu, or
   • Select the Remove button.
4. Select the Yes button in the dialog to proceed, or the No button to abort.
5. If the function is being used in any component, Function Uses dialog is displayed. Select the OK button to confirm deletion.

Showing Function Use

The Show Uses tab in the Information panel of Rhapsody IDE enables you to determine which components are affected when you modify a particular function:

The Show Uses tab provides you with the following information:

To display which components are using a particular function:

1. Open the Shared JavaScript Libraries manager.
2. Select a function in the Library Manager panel.
3. Select the Show Uses button (or Show Uses in the right-click menu) to display the function's uses in the Show Uses tab in the Information panel of Rhapsody IDE.
4. To view or edit the configuration properties of a component using the JavaScript function: 
   • Double-click on the component path.
   • Or alternatively, from the right-click menu, select Open Properties.
5. Select the Close button to close the dialog.

Validating Functions

You can manually verify whether a function is syntactically correct through the Shared JavaScript Libraries manager. This check, however, does not determine whether the function is contextually correct.

To validate a function:

1. Open the Shared JavaScript Libraries manager.
2. Select a function panel.
3. From the Library Manager panel, check out the library the function is in.

4. Select the function and select Validate Function in the right-click menu to display the Validation Result dialog.

5. If there are:

   • No validation errors, a success message is displayed:

     
     

   • Otherwise, a validation report is displayed:

     
     

6. Select the Close button to close the dialog.

Code Editor

The Code Editor enables you to inspect, write and edit JavaScript functions. You can open multiple functions at a time which appear in their own tab:

Braces Outlining

Braces enclosed code block are outlined and can be expanded and folded.

Supported Shortcuts

The Code Editor supports the following shortcuts:

Built-in Context Menu

To display the built-in context menu, right-click in the editor’s pane to activate context menu:

Auto-complete Support

Non-contextual auto-complete support. Basic auto-complete is supported and it includes all JavaScript keywords, Rhapsody built-in functions, and all shared JavaScript functions/libraries.

To activate the auto-complete, press Ctrl+Space. Initially, the auto-complete list will be sorted alphabetically, it will be narrowed down while typing in. Pressing tab to select the current best-matched keyword and the auto-complete will finish.

It also includes words that have been used in the current document. All words that have been used will be included in the auto-complete list.

Calling Shared JavaScript Functions

You can call the shared JavaScript functions from all the components that execute JavaScript code. For example, JavaScript filters, JavaScript conditional connectors, Web Service Client communication points, and so on. However, you cannot check in and check out libraries, within lockers, for which you do not have the Edit permission. This safety mechanism has been built in to prevent users from accidentally modifying existing behavior.

For example, in order to call the function myFunc in the library MyLib, use the built-in function require() in your JavaScript code as follows:

var mylib=require("MyLib");
var result=mylib.myFunc(parameter1, parameter2);

You must call require() for every library you want to use.

Naming Conventions

1. Function names are case sensitive, for example:  "f1" and "F1" are two different valid names.
2. Function names must begin with a letter, underscore or dollar sign.
3. Names must not be:
   • JavaScript built-in objects, properties, and methods, for example: Math, Number, String.
   • Java objects and properties, for example: getClass, java.
   • Windows Reserved Words, for example: alert, focus, form.
   • HTML Event Handlers, for example: onblur, onclick, onfocus.
   • Rhapsody JavaScript objects, for example: getCounter, dataMap, getLookupTable.
4. Names can contain letters, digits, underscores, and dollar signs.
5. Local variables within functions must not:
   • Be declared with the same name as Rhapsody variables or variables declared within a JavaScript filter.

Configuration Properties