Saving an ESQL file

When you edit an ESQL file, you can save it to preserve the additions and modifications that you have made, and to force the editor to validate the content of the file.

Before you begin

This task assumes that you have created or opened an ESQL file. For more information, see Creating an ESQL file or Opening an existing ESQL file.

About this task

To save an ESQL file, complete the following steps.


  1. Change the contents of the ESQL file.
  2. Save the file by clicking File > Save or File > Save All.

    When you save the file, the validator is called by the editor to check that the ESQL obeys all grammar and syntax rules (specified by the syntax diagrams and explanations in ESQL reference).

    You can request additional validation when you set ESQL preferences:

    1. Click Window > Preferences > Integration Development > ESQL > Validation.
      The Preferences dialog box is displayed.
    2. Select the level of validation that you require for each category of error:
      1. Unresolved identifiers
      2. Message references do not match message definitions
      3. Database references do not match database schema
      4. Use of deprecated keywords

      The default level is warning; you can change this value to error or ignore.

      Validating message definitions can affect response times in the editor, particularly if you have complicated ESQL that makes many references to a complex message definition. You might choose to delay this validation. Call validation when you have finished developing the message flow and are about to deploy it, to avoid runtime errors.

      For each error found, the editor writes the code line number and the reason for the error; errors are created as entries in the Problems view.
  3. If you double-click the error, the editor positions your cursor on the line in which it found that error.
    The line is also highlighted by the error icon The error icon (white cross in a red circle).

    The editor might also find potential error situations, which it highlights as warnings (with the warning iconThe warning icon (black exclamation mark in a yellow triangle)); the editor also writes these warnings to the Problems view. For example, you might have included a BROKER SCHEMA statement that references an invalid schema (namespace).

    Check your code, and make the corrections required by that statement or function.

Save As

About this task

You can save a copy of this ESQL file by using File > Save As.


  1. Click File > Save As.
  2. Specify the integration project in which you want to save a copy of the ESQL file.
    The project name defaults to the current project. You can accept this name, or choose another name from the valid options that are displayed in the File Save dialog box.
  3. Specify the name for the new copy of the ESQL file.
    To save this ESQL file in the same project, either rename it, or confirm that you want to overwrite the current copy (that is, copy the file to itself).

    To save this ESQL file in another project, the project must exist. You can save the file with the same or another name in another project.

  4. Click OK.
    The message flow is saved and the message flow editor validates its contents. The editor provides a report of all errors that it finds in the Problems view.