Qlik Language Definition for UltraEdit

Note: Due to a lack of end user interest, this project no longer being maintained. Should you wish to provide updates, pull requests will still be reviewed and accepted.

The Qlik Custom Language Definition for UltraEdit gives basic syntax highlighting and auto-completion when working with QlikView and Qlik Sense script files in UltraEdit.

The syntax highlighting that is provided is limited to the capabilities of UltraEdit Wordfiles and themes, and is an approximation of what you would get in Qlik's Edit Script dialogs. It currently supports the following features:

• Highlighting of all current (v11.20) functions
• Highlighting of all current (v11.20) keywords and statements
• Highlighting of line comments (//) and block comments (/* */ and REM ; )
• Folding of code blocks including IF, SWITCH, FOR, DO and SUB statements
• LOAD statements, QUALIFY statements, STORE statements and subroutines shown in the UltraEdit function list
• Script templates for commonly used commands and code snippets

If you find any keywords or functions missing then please let me know by logging an issue and I'll add them to the next release. Support may also be added for subroutines within Qlik code libraries. If you'd like me to add support for your library, again please contact me.

##Installation

Here are the steps to getting it installed and working yourself:

1. It is recommended that you are running the latest version of UltraEdit (v21.30.0 at the time of release). Some previous versions do not support all Wordfile and theme features.
2. Close all running instances of UltraEdit.
3. Download the QlikView Wordfile latest release ZIP archive file from https://github.com/MattFryer/QlikView-UltraEdit/releases/latest
4. Unpack the files from the archive to a folder on you hard drive.
5. Copy the "qlikview.uew" file from the folder to the "%UserProfile%\AppData\Roaming\IDMComp\UltraEdit\wordfiles". Tip: you can copy the path (including the % part) into Windows Explorer address bar. Windows may ask you to provide administrator privileges.
6. Copy the "qlikview-tpl.xml" file from the folder to the "%UserProfile%\AppData\Roaming\IDMComp\UltraEdit\templates\language".
7. Copy the "QlikView.ue-theme" file from the folder to the "%UserProfile%\AppData\Roaming\IDMComp\UltraEdit\templates\themes".
8. Open UltraEdit and navigate to the menu Advanced -> Configuration...
9. The Configuration dialog will appear, under the "Navigation" tree on the left hand side, select Editor -> Word Wrap/Tab Settings.
10. Click the "Change list..." button (top right), the Modify File Types dialog will appear.
11. Type "qvs" into the File Extensions box and click "Add". Now click "OK" to close the dialog.
12. Back on the Configuration dialog, from the "Select extension for settings or default" drop-down select the "qvs" entry you just added.
13. Click the "Browse..." button and navigate to the "AutoComplete.txt" file which you unpacked from the ZIP file in step 4 above. Click "Open".
14. Click "OK" to close the Configuration dialog.

Upgrade

If you already have a previous version of the QlikView Wordfile installed you will need to follow these steps to remove it and install the latest version:

1. Close all running instances of UltraEdit.
2. Download the QlikView Wordfile latest release ZIP archive file from https://github.com/MattFryer/QlikView-UltraEdit/releases/latest
3. Unpack the files from the archive to a folder on you hard drive.
4. Copy the "qlikview.uew" file from the folder to the "%UserProfile%\AppData\Roaming\IDMComp\UltraEdit\wordfiles" and if prompted, allow it to overwrite any existing version of the file. Tip: you can copy the path (including the % part) into Windows Explorer address bar. Windows may also ask you to provide administrator privileges.
5. Copy the "qlikview-tpl.xml" file from the folder to the "%UserProfile%\AppData\Roaming\IDMComp\UltraEdit\templates\language" and if prompted, allow it to overwrite any existing version of the file.
6. Copy the "QlikView.ue-theme" file from the folder to the "%UserProfile%\AppData\Roaming\IDMComp\UltraEdit\templates\themes" and if prompted, allow it to overwrite any existing version of the file.
7. Open UltraEdit and navigate to the menu Advanced -> Configuration...
8. The Configuration dialog will appear, under the "Navigation" tree on the left hand side, select Editor -> Word Wrap/Tab Settings.
9. From the "Select extension for settings or default" drop-down select the "qvs" entry. If no "qvs" entry is shown, continue from point 10 of the Installation instructions above.
10. Click the "Browse..." button and navigate to the "AutoComplete.txt" file which you unpacked from the ZIP file in step 4 above. Click "Open".
11. Click "OK" to close the Configuration dialog.

How To Use

If you open a .qvs file, UltraEdit will automatically identify it as a QlikView script file and apply the Wordfile for you. If you are creating a new file or using a different file extension then you'll need to change the language using the menu View -> View as (Highlighted File Type) -> QlikView.

By default, UltraEdit will use the highlighting colours set within the theme you are using. If you would like to see the script file in the default colours used within QlikView Edit Script dialog, you can enable the QlikView theme provided. To enable it from the menu select View -> Themes -> QlikView.

A series of templates have been included which allow you to add commonly used commands and script snippets. To insert a template, place the cursor at the position within the script file where you wish to insert the template, then from the menu select Insert -> Individual Templates and then select the template you wish to use. Some templates will prompt you to complete elements of the template. For example, after inserting the "Binary Load" template, UltraEdit will select the area where you need to insert the path to the QVW file. Type (or paste) the path and hit enter to complete the template.

Disclaimer

This Wordfile is provided free of charge, as is, with no warranties or guarantees. Neither Datoniq Limited or QlikViewAddict.com (including any of it's contributors) accept any liability for problems or loss resulting from it's use. Qlik is a registered trademark of QlikTech International AB.