A Web-based user interface for InterSystems Caché which allows to create and manage classes literally without touching any code.
JavaScript CSS HTML Batchfile
Clone or download
Pull request Compare This branch is 1 commit ahead of ZitRos:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
source
.babelrc
.gitmodules
LICENSE
README.md
gulpfile.babel.js
import.bat
package.json

README.md

Caché Visual Editor (alpha)

A Web-based user interface for InterSystems Caché which allows to create and manage classes literally without touching any code. Download the latest release from the releases page.

Features

  • Simple, intuitive and powerful visual class editing and exploring tool for both desktop and mobile devices;
  • Supports all basic class editing functionality:
    • Adding/deleting classes, editing class keywords, comments, etc;
    • Adding/deleting/altering class members: parameters, properties, methods, queries, xDatas, indices;
    • Convenient code editing for methods and xDatas;
    • Editing all class members keywords with inputs, drop-downs and suggestions;
    • XData code highlight (COS highlight is coming!);
  • Embedded web terminal if Caché web terminal is installed in the system;
  • Smart class members grouping, folding and convenient interface, adaptive design;
  • More features are coming!

Preview

Screenshot 0

Screenshot 1

Screenshot 2

Caché Support

Caché Visual Editor is supported by Caché version 2016.1 and higher.

Installation

Download the latest release from here and import XML file into Caché by one of the next ways:

  1. Just drag XML file over Studio window;
  2. Go to the Management Portal -> System Explorer -> Classes -> Import and select the XML file;
  3. Execute do $system.OBJ.Load("C:\path\to\file\FileToImport.xml","ck") in terminal.

Then check the installation output, it should say "Installation is complete!".

After this, open the next web-application: http://[host]/VisualEditor/ (slash at the end is required).

Development

Pre-requirements

To participate in development of this application, you need Git, NodeJS and Caché 2016.2+ to be installed (due to UDL import support).

The development process of this application lies completely outside Caché. It includes structured file tree under source directory, where each file can be edited in your favorite text editor.

At first, clone the repository. It contains submodules, so use the --recursive flag when cloning:

git clone --recursive https://github.com/intersystems-ru/cache-visual-editor
cd cache-visual-editor

Then you have to install all the project dependencies by running this command from the project's root:

npm install

And now you are ready to build the project from the sources!

Building and testing

This time and each next run this:

npm run gulp

Take your ready to import sources in build/cache folder.

One-command build and XML export

To simplify development on Windows (scripts for other platforms are welcome), make the copy of import.bat file and edit the path to your Caché instance there. Then you can just use one command import to deploy the project from source to Caché.

After setting import.bat up, just by one command import you get the next:

  1. Project is built by Gulp;
  2. VisualEditor package is imported into Caché;
  3. The XML file containing ready-to-deploy package is exported to build directory.