Welcome to the Red Book for HPCC Systems® 7.0.x series. There are several sections in this Red Book as follows:

Users may benefit from glancing at other Red Book entries when making a large jump between releases.

Here's how to contact us if you find an issue or want to add something to the Red Book:

General HPCC Systems core platform

NEW - Login and usability issues running ECL Watch under Windows

Users of Windows 7 and 10 Internet Explorer 11.0.9 in Windows 7 and 11.0.9 – 11.239 Windows 10 Edge using DNS, may experience looping at login and inability to properly run ECL Watch. 

The suggested workaround for Windows 10 users is to update to the latest IE/Edge browser, while Windows 7 users will need to switch to Chrome, Firefox, or another browser.


NEW - Remove unwanted ws_store bindings for new environments created using envgen

If a user creates a new environment.xml file via configmgr, the environment file might include an unnecessary (and incomplete) Ws_Store instance configuration bound to the ECLWatch ESP. The user should remove the unwanted ws_store binding.


NEW - Error reading CSV file as a FLAT file causes deserialization errors

Reading files in ECL that are declared as one type (e.g. FLAT), but are published as a different type (e.g. CSV), causes problems, an example of an error that can be hit is: 

assert(required <= maxOffset) failed - file: rtlcommon.hpp

In these cases, it's usually because the published file has been sprayed with a meaningless record format. In HPCC Systems 7.0.x, it looks at that format and tries to translate from it and hits this issue.

A workaround for the issue is to use this option:

#option('layoutTranslation', 'ecl');

which forces the engines to use the record declaration declared in the ECL (and ignore the published record definition format).


Rendering issues when viewing Timings in ECL Watch using IE10 and IE11

If you experiencing these issues, you can work around it by using MS Edge, Chrome or Firefox while waiting for a resolution. More information is also available in this GitHub issue: https://github.com/hpcc-systems/Visualization/issues/3061.


New cross platform SOAPCALL behaviour in HPCC Systems 7.0.0

Prior to version 7.0.0 of the HPCC Systems platform, credentials were automatically sent with a SOAPCALL or HTTPCALL.

Versions 7.0.0 and later use security tokens and credentials are no longer available to be sent with a SOAPCALL. This is transparent when a 7.0.0 system is communicating with another 7.0.0 ESP in the same environment (same Dali). However, when a SOAPCALL is sent from a 7.0.0 system to a 6.x.x ESP (or to an ESP in another environment) credentials are not sent and the recipient cannot authenticate the request. There are two ways to remedy this:

  1. Upgrade the system receiving the SOAPCALL to 7.0.0
    This is the optimal solution, but may not fit in to your upgrade schedule or needs. This only works if the ESP is in the same environment.
  2. Embed encoded credentials in the SOAPCALL either in the URL or using HTTPHEADER.
    This is less secure, but can serve as a temporary solution. We strongly recommend using TLS (HTTPS) to send a SOAPCALL with embedded credentials.


ip := ''; // Not secure
ips := ''; TLS Encryption
ipspw := 'https://username:password@'; //credentials in URL
svc := 'MyModule.SomeService';
creds := D'username:password'; //Never put actual credentials in ECL code
// this is for example purposes
encodedCreds := STD.Str.EncodeBase64(creds);
//Using credentials in the URLOUTPUT(SOAPCALL(ipspw,svc,
                {STRING500 InData := 'Some Input Data'}, OutRec)); 
//Using HTTPHEADER to pass Authorization info
{STRING500 InData := 'Some Input Data'}, OutRec;
           HTTPHEADER('Authorization', 'Basic ' + encodedCreds)));


Spark Connector - Invalid null pointer exception might occur when creating an HpccFile object

An invalid null pointer exception might occur when creating an HpccFile object using the following constructor:

public HpccFile(String fileName, String connectionString, String user, String pass)

The workaround for this is to use the following alternative constructors:

public HpccFile(String fileName, Connection espconninfo) throws HpccFileException


public HpccFile(String fileName, Connection espconninfo, String targetColumnList, String filter, RemapInfo remap_info, int maxParts, String targetfilecluster) throws HpccFileException

These constructors require Connection objects which can be created as follows:

Connection espcon = new Connection(“http”, “myespaddress”, “8010”);


Uninstall HPCC Systems including Spark to sucessfully install HPCC Systems with plugins without Spark

Installing HPCC Systems 7.0.0 with plugins but without Spark over a previous 7.0.0 version of HPCC Systems with Spark (including pre gold release candidates) causes multiple conflicts. To avoid these conflicts, please completely uninstall your previous HPCC Systems 7.0.0 version first.


Spark-shell must be started using the actual IP address

When trying to install the spark shell using the following command, it will fail to connect to the local host:

/opt/HPCCSystems/externals/spark-hadoop/bin/spark-shell --master=spark://localhost:7077

You must supply the actual IP address as follows:

 /opt/HPCCSystems/externals/spark-hadoop/bin/spark-shell --master=spark://


The way disk files are projected has changed in HPCC Systems 7.0.0

A new flag has been added to disk reads and indexes to control whether the new or old method of translating file formats is used.  It is primarily used for testing. Occasionally if a dataset contains an alien data type and the results are projected it may be necessary to add the following to a dataset definition:  


For example:

d := dataset('imgfile', { rawLayout x, unsigned8 _fpos{virtual(fileposition)} }, FLAT, __OPTION__(legacy)); 

The compiler will report an error message indicating that the option is required:

"This dataset contains deprecated record formats and virtual fields. Remove the alien data types, or temporarily add __OPTION__(LEGACY) to the table definition"


HPCC Systems 7.0.0 now allows index translation when merging index parts

This change potentially changes the order that records are returned from stepped index reads with multiple input keys. Previously the payload was used for ordering, now it is restricted to the keyed portion.

Previously the order was determined by the trailing keyed components, the payload memcmp'd and finally any leading keyed components.  This would cause problems if payload fields are removed or added since the ordering would no longer be consistent.  (The previous code also potentially returned data in an undefined order since it was possible for exact matches to access uninitialised data.).

The order is now determined by the trailing keyed components and then leading keyed components.  If there are exact matches between multiple keys all results will be returned from the first matching keys, before exact matches from the next key.


Inconsistent UTF8 comparisons

In versions of the platform prior to HPCC Systems 7.0.0, the utf8 strings that do not contain characters above 0x80 order 'A' before 'a', but the unicode collation is to order 'a' before 'A'.  from HPCC Systems 7.0.o utf8 strings will always use the icu collation order.  This may cause the results of some queries to change, because values may now be sorted in a different order.


Changes to Std.Date in HPCC Systems 7.0.x

is_local_time has been added to some functions and issues with daylight savings time have now been resolved. New functionality includes:

New Std.Date.TimestampToString() function
Allows you to create a string version of timestamp value, much the same as Std.Date.SecondsToString() does.


New Std.Date functions YearWeekNumFromDate() and MonthWeekNumFromDate()
Given a date, these functions return the 1-based week number from the beginning of the year and month, respectively.


Fixed issues in Std.Date relating to daylight savings time and converting UTC times to local time or creating new times
Several functions acquired a new optional parameter to support local time:  SecondsToParts(), CreateDateFromSeconds(), CreateTimeFromSeconds(), CreateDateTimeFromSeconds().


New Std.Date.TimeZone module
Adds time zone support data and functions.


Add optional boolean parameter (month_ends_equal) to Std.Date.MonthsBetween() to force the function to treat the end of months equal
For example, given the dates 20160331 and 20160930 (last day of March and last day of September, respectively), if month_ends_equal is FALSE then the function's result will be 5; if month_ends_equal is TRUE then the result will be 6.


New ISO 'week dates' helper function
Calculates the 1-based week number of a date starting from a reference date.


New 'datetime' difference function
Returns the difference in seconds between two datetime stamps.


SEQUENTIAL is now converted to ORDERED inside a child query

Using SEQUENTIAL in an APPLY was reported as causing the following error:

value global('gl3NV181') in workunit is undefined (code generator issue)

Most of the times SEQUENTIAL is used, it would be better to use ORDERED, however there may be times when the previous functionality is needed such as in cases where the conversion changes something that happens to work as expected. To revert back to using the previous functionality use the following:

#option('transformNestedSequential', false);


DALI checks file scopes when CheckScopeScans is disabled

CheckScopeScans is meant to control scope enforcement when a user accesses a file list.  However, in HPCC Systems 5.6.8, https://track.hpccsystems.com/browse/HPCC-16185 introduced a regression whereby if CheckScopeScans was disabled, scopes would not be checked even for a single file request. This is now resolved in HPCC Systems 7.0.0.


The default implementation of GROUP(dataset, fields, ,ALL) has changed

Previously the output of the operation happened to be globally sorted by the grouping fields, but this will no longer be the case.  If any ECL code had been relying on this side-effect, that ECL may generate different results in HPCC Systems 7.0.0  Adding  ,SORTED to the GROUP statement will cause the system to use the pre 7.0 implementation and generate globally sorted results.


Uninstall WS-SQL before downloading HPCC Systems 7.0.0 Beta 1 to avoid compatibility errors

WS-SQL is no longer a stand alone module with a separate installation process. It has now been integrated into the HPCC Systems platform as a core feature. If you previously installed WS-SQL as a standalone add on to HPCC Systems that predates version 7.0.0 Beta 1, please uninstall the earlier version of WS-SQL before installing HPCC Systems 7.0.0 Beta 1, to avoid compatibility issues causing an error.

Updates and new features to WS-SQL will now be recorded in the HPCC Systems changelog.


Internet Explorer 8, 9 and 10 are not supported in HPCC Systems 7.0.0.

Microsoft stopped supporting these browser versions in January 2016, leading us to stop supporting them from HPCC Systems 7.0.0 Beta .


Unicode TRIM now removes only space characters rather than all whitespace

Prior to HPCC Systems 7.0.0, the implementation of TRIM on unicode strings related to removing whitespace, was inconsistent with the implementation applied to standard STRING values. This inconsistency has been fixed in HPCC Systems 7.0.0. In STRING, this is space (0x20), horizontal tab, vertical tab, line feed, form feed, carriage return (0x09 to 0x0D) and non-breaking space (0xA0). In UNICODE, it is all characters with the white space property.

However, it’s possible some code may have been relying on the previous behaviour. If so, you can specify, WHITESPACE on any TRIM expression where you wish to use the prior semantics of removing other whitespace characters as well as space characters.

https://track.hpccsystems.com/browse/HPCC-19075 and https://track.hpccsystems.com/browse/HPCC-19008

New option to disable built-in scheduler in eclserver

A 'schedulerDisabled' option has been added to the eclserver configuration which defaults to FALSE. 

If an eclscheduler component has been added to the environment, schedulerDisabled should be set to TRUE in eclserver components to disable the built in scheduler to avoid the situation where multiple schedulers are dealing with the same eclserver. The same problem may also be an issue where multiple load-balanced eclservers are used.

Eventually, we plan to remove the eclscheduler from eclserver completely.


Converting to a varstring from an integer is now always done via a string

This change has one known effect, (varstring2)123 used to produce ' **', it now produces '12'.


Root scope for workunit is now blank

If a statistic or timer previously had a scope of "workunit" in HPCC Systems 6.x.x, it will now have a scope of "" in HPCC Systems 7.x.x. This may affect code that is processing timings from existing workunits.


Assigning to the same field more than once in a transform now produces an error instead of a warning

Inside a transform:

SELF.x := ...
SELF.x.y := ....

Now generates an error that SELF.x.y has already been assigned.


Significant new features core platform

New attribute in EMBED treating it as an activity,  allowing it to stream output

This feature allows embeds to behave in similar ways to the inbuilt activities.  When the activity attribute is specified on an EMBED the system will generate an activity in the graph for that embed.  The inputs to the activity are any leading parameters which have streamed dataset type.  (Any streamed dataset parameters that follow parameters of other types are not processed as input activities.)  If the result has a dataset type, then the output from the activity will be fed into the activtiies that use that dataset.

The code for implementing the embed will need to behave differently depending on whether it is a global activity (only generating a portion of the dataset on each node) or executed within a child dataset, where each activity will generate the complete dataset.  The way this information is passed to the embeded code depends on the language:

Examples are included in the regression suite, for example, testing/regress/ecl/embedactivity*.ecl and testing/regress/ecl/pyembedactivity.ecl.


HPCC Systems 7.0.0 ESP now supports adding dynamic services at run time

This includes running services on new ports that weren’t allocated in the static configuration setup at ESP deployment time. Prior to HPCC Systems 7.0.0, all ESP ports were configured statically at deployment time, and settings for things like security and logging were defined as part of that static configuration. In HPCC Systems 7.0.0 a new configuration item was added that determines how dynamically allocated ports will be configured by default.

Unfortunately if you have to roll back an ESP after this information has been added to the ESP’s static configuration the ESP will get confused and will not be able to start.

A fix applied from HPCC Systems version 6.4.26 allows ESP to cope with this configuration item.  If you are dealing with this issue after rolling back an ESP, we recommend that you either: