What's New in Intershop Studio 4.2.5

Product Version

4.2.5

Product To Version

4.2.5

Status

final


1 Introduction

This release introduces the new Query Editor. In addition, it comes with many fine and small improvements.

2 Query Editor

2.1 New Query Editor

The Query editor provides specialized features for editing Java code. This includes content assistance, hyper-linking, rich hovers, an outline, as well as syntax highlighting and formatting and much more.
The editor consists of two tabs:

  • General Properties: Edit the declarative content here, e.g., parameters and return values
  • XML Source: Edit the query templates as well as the declarative elements here.

Both tabs are synchronized with each other, so that changes on one tab are visible on the other immediately.

2.1.1 General Properties Tab

Edit declarative properties here:

  • Description
  • Processor
  • Parameters and Return Values

The General Properties tab:

2.1.2 Source Page: Content Assist

The source page provides a fully featured XML editor that additionally supports specialized features to edit query files.

2.1.2.1 XML Content Assist

Note

This section only gives an overview of content assistant features. Actually most attributes on the source page as well as on the General Properties tab support content assistance.

To ease the creation of valid query XML, the content assist provides schema based completion proposals.
XML completion proposals:

2.1.2.2 Intershop Element Content Assist

Editing the values of particular attributes is supported by the content assistant.

Content assist for parameter names - Accesses performed in expressions are proposed:
(This content assist is also available on the General Properties tab)

Content Assist for Mapper Attribute - Component Instances:
(This content assist is also available on the General Properties tab)

Content assist for expressions:

Content assist for calls
(of course, also parameters are supported):

2.1.2.3 Java Element Content Assist

Values that contain a fully qualified Java type name provide content assistance.

Content assist for Java types:

2.1.2.4 SQL Content Assist

Editing SQL is supported by the content assist.

Note

It may be necessary to connect to the database in order to support not only simple syntax elements but also table names or column names.

To connect to the database:

  1. Right-click to open the context menu.
  2. Select Set Connection Info..
    Connection Info dialog:

    A ready to use connection should be available in most cases.

SQL content assist for table names:

SQL content assist for column names:

2.1.3 Additional Features

The editor offers hover support for XML schema information as well as for referenced Java and Intershop elements. In values that contain references to Java types or Intershop elements, linking is supported (F3, Shift-Hover).

Referenced Query:

2.1.4 Preferences

Several aspects can be customized.

Use the 'Preferences...' action from the content menu to get a filtered list of relevant preference pages.

Content Assist preferences:

3 Ivy Support

3.1 Support Description of Cartridge Meta-Data with Apache Ivy

3.1.1 Ivy Support

Intershop Studio now supports editing cartridge ivy.xml files.

Intershop Studio uses the dependencies as well as other data (e.g., descriptions, versions) for all operations that depend on this information (e.g., pipeline lookups, classpath containers).

General cartridge properties:

The form based editing on the Overview tab as well the dependencies list are read-only at the moment. But the info here reflects the changes done on the ivy.xml tab.

The Cartridge Editor provides an additional tab to edit the ivy.xml file.

ivy.xml file tab:

Note

The IvyIDE feature has been added to Intershop Studio.

4 EDL Model

4.1 EDL Model and Code Validation

4.1.1 EDL Model Validation

An action (Validate Cartridge Element) is available to start the EDL model validation.

Validate EDL Models

4.1.2 EDL Code Synchronization Validation

Additional validation is available that detects synchronization problems between the model and the generated code.

In case the code needs to be created or recreated, errors or warnings will be issued.

This includes cases where the code generation templates are changed, which results in modified source code, or if the EDL model was modified without starting the code generation.

Validation Preferences

5 Pipelet and
Pipeline Handling

5.1 Creation Wizard and Pipelet Editor

5.1.1 New Pipelet Wizard

A new Pipelet Creation wizard is available.

The first page allows to enter general properties.

General properties:

The second page allows to specify properties of the pipelet class file.

Pipelet class properties:

The wizard cannot be used to manage pipelet parameters or pipelet configurations. This has to be done with the Pipelet Editor.

5.1.2 Pipelet Editor

The Pipelet Editor allows to edit the pipelet descriptor as well as the pipelet's Java code. It offers a form page to edit all properties of the pipelet descriptor and a tab that contains the pipelet's Java code.

5.1.2.1 Pipelet Descriptor

Use the form elements to edit the pipelet descriptor.

Pipelet descriptor tab:

5.1.2.2 Pipelet Java Class

The Java source tab contains a fully featured Java editor to edit the pipelet's Java class.

Pipelet Java source tab:

Note

Some Java source code will be created based on the descriptor (e.g., pipelet parameter assignment, creation and assignment of configuration variables).

The code that was generated by previous Intershop Studio versions was very verbose and restrictive and made pipelets hard to understand.
Now a (still simple) content assist is available that provides the the names of parameters and configuration properties. Also pipelet validation along with Quick Fixes allow to create and maintain valid and correct Java code.

Content assist for pipelet parameters and configuration names:

Pipelet content assist configuration:

5.2 Validation of Transaction Control Mode of Pipeline Transitions

5.2.1 Validation of Unclosed and Unopened Transaction

Transitions that begin or close a transaction will be validated, and non-closed or non-opened transactions are reported.

Note

This validation traverses (on purpose) the nodes without following call or jump nodes.

Pipeline transaction control validation:

Missing begin transaction:

Missing commit or rollback:

5.3 Move Pipeline Nodes Using Keyboard and Menu

5.3.1 Move Nodes Action

Nodes in the Pipeline Editor can easily be moved using the mouse. But it is hard to do that without the mouse and nodes may hide others.

Now several actions are available to move selected pipeline nodes into all directions (Context menu: Move):

  • Push: Moves the selected node one step into the nodes natural direction: Key INSERT
  • Left: Moves the selected node one step to the left: Key SHIFT+STRG+Cursor Left
  • Up: Moves the selected node one step up: Key SHIFT+STRG+Cursor Up
  • Right: Moves the selected node one step to the right: Key SHIFT+STRG+Cursor Right
  • Down: Moves the selected node one step down: Key SHIFT+STRG+Cursor Down.

The affected nodes will not only be moved, but will also cause nodes to move that might be hidden.

Move menu:

Move down Start before:

Move down Start after:

5.4 Appearance of Elements in the Pipeline Editor is Configurable

5.4.1 Color Schemes and Fonts

The Visual Pipeline Editor now uses fonts and colors that are configurable in the preferences.

This not only intended to give pipelines a fancy look matching individual tastes, but, more important, might address accessibility issues.

Color and Fonts preferences:

Pipeline example with customized colors and fonts:

5.4.2 Rulers and Grid

The View menu now provides actions to hide or show rulers or the grid.

View menu:

6 Convenience

6.1 Quickfix Action

The context menus now offer a command to apply quick fixes that are available for problem markers assigned to elements.

Quick fix menu item:

Quick fix selection dialog:

6.2 Referenced Elements as Tooltip in Properties View

6.2.1 Details Tooltip in Properties View

Fields displaying referenced elements or Java types now provide an information icon which has a tooltip for the referenced element if it can be resolved.

Tooltip of a pipelet in a pipelet node:

6.3 Delete Java Builder Output (ESTUDIO_TARGET) on Cartridge Project Deletion

6.3.1 Cartridge Project Deletion

Intershop cartridges often use a linked folder as Java builder output location. When the cartridge project is deleted (not necessarily from the file system, but just from the workspace), this link target remains on disk. Since this folder does not make sense anymore, it will be deleted if the project is deleted.

Delete cartridge deletiontest:

Delete cartridge deletiontest - Preview of changes to be performed:

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Tickets