Rational Developer for System z, Version 7.6

Features of the flow ESQL editor

This topic describes the features of the flow ESQL editor.
Note: Use the flow ESQL editor only for editing .esql files created by earlier levels of the service flow project tools (see Using ESQL expressions instead of ESQL modules).

Flow ESQL editor views

The flow ESQL editor has the following views:

Resource Navigator view
The navigator view shows all the resources in your workspace, that is all message set resources and all flow resources, including ESQL files.
Editor area
The editor area shows the contents of the resource that is currently open. It also shows tabs for each of the resource that you have open so that you can quickly switch between them.
Outline view
The Outline view displays any schemas, defined constants, modules, and routines that you have referenced in this ESQL file.
Problems view
The Problems view displays the warning and error messages that are generated by the editor's validation when you save the ESQL file. If you double click an error, the editor indicates where it is located by highlighting the corresponding ESQL code.

Formatting

Selecting Source > Format from the main menu of the workbench allows you to reformat a block of selected text. This option formats all selected lines of code (unless only partially selected, when they are ignored), or, if no lines are selected, formats the entire file (correcting alignments and indentation). You can also format code statements using the Shift Right or Shift Left options that are available from the Format menu.

Comments

You can add comments to and remove comments from your ESQL code:

  1. To change an existing line of code into a comment line, click Source > Comment.
  2. To change a comment line to a code line, click Source > Uncomment.
  3. To create a new comment line, press Enter to create a new line and either type the comment identifier -- or click Source > Comment. You can enter any text after the identifier: everything you type is ignored by the flow ESQL editor.

Content assistance

To help you to code valid ESQL, the editor displays a list of valid statements and functions at the point of the cursor. To invoke this assistance, click Edit > Content Assist. On some systems, you might also be able to use the key combination Ctrl+Space. Scroll through the list displayed to find and highlight the one that you want, and press Enter. The appropriate code is inserted into your module, and the list disappears.

Content assistance is provided in the following areas:

  • Applicable keywords, based on language syntax.
  • Blocks of code that go together, such as BEGIN END;.

Content assistance works only if the ESQL can be parsed correctly. Errors such as END missing after BEGIN, and other unterminated block statements, cause parser failures and no content assistance is provided. Try content assistance in other areas around the statement where it does not work to narrow down the point of error. Alternatively, save the ESQL file; saving the file causes validation and all syntax errors are written to the Tasks view. Refer to the errors reported to understand and correct the ESQL syntax. If you use content assistance to generate most statements (such as block statements), these are correctly entered and there is less opportunity for error.

Flow ESQL editor functions

Right-click in the editor area to access the following additional functions:

  • Undo and Revert File. To undo a change that you have made to the ESQL file, click Undo. If you undo a change, you can reinstate it by clicking Revert File.
  • Cut, Copy, and Paste. These are standard editor functions.
  • Shift Right and Shift Left. These are standard editor functions.
  • Save. Click this to save your changes.
  • Comment and Uncomment. Click Comment to change a line of ESQL code into a comment. Click Uncomment to change a comment into a line of ESQL code.
  • Format. This function formats all selected lines of code (unless only partially selected, when they are ignored), or, if no lines are selected, formats the entire file (correcting alignments and indentation).
  • Organize Schema Paths and Add Schema Path. These functions assist you with schema management.

Click Organize Schema Paths and any schema containing procedures or function called by the ESQL file is automatically added to the PATH statement (if you have not already added it). This function scans the ESQL file for instances of procedures or function residing in schemas not already fully qualified in the file.

Click Add Schema Path when you code a call to a procedure or function residing in a different schema to any you have included on the PATH statement, and this schema is added to the PATH statement. Ensure that the cursor is on the name of the procedure you are calling.


Terms of use | Feedback

This information center is powered by Eclipse technology. (http://www.eclipse.org)