Release Notes 2018-06-10

OpenEdge 11.7.3 Product alert!

We've encountered a severe regression with the Progress Developer Studio Visual Designer in OpenEdge Release 11.7.3 (Service Pack 3 of OpenEdge 11.7). We won't announce formal compatibility of the SmartComponent Library with OpenEdge 11.7.3 for this reason. We'll inform once Progress Software has resolved this issue. 

Besides the issue with the Visual Designer however, we are not aware of any incompatibilities with OpenEdge 11.7.3. 

This article provides further details: Visual Designer related OpenEdge 11.7.3 product alert!!!

Version Information

OpenEdge Release

Version Information

11.3.3, 11.3.4, 11.4, 11.6.2, 11.6.3, 11.7, 11.7.1, 11.7.2

Release 11.3 #46858@2018-06-10

OpenEdge 11.7 Service Pack 2

We are announcing full compatibility with the Service Pack 2 for OpenEdge 11.7 (OpenEdge 11.7.2).

See further remarks below.

Deletion of SmartDataAdapters and BindingSources

In SCL-2019 we have changed the clean-up behavior of the SmartDataBrowser control when a Form is closed. After this change, the SmartDataBrowser will delete it's linked SmartDataSource (e.g. SmartBusinessEntityAdpater) instance and DataSource (binding source). In rare cases, where those instances may still be required after the form containing the browser have been closed, developers can set the following new property of the SmartDataBrowser to FALSE:

 * Purpose: Controls if the SmartDataBrowser deletes it's SmartDataSource and DataSource
 *          when the Form is closed
 * Notes:

Your action may be required!

Changes to the SmartDB and SmartDB upgrade and migration utility

Announcing the SmartFramework ERD Designer

We are announcing the availability of the SmartFramework ERD Designer

Release Notes

Following the release of the OpenEdge 11.7 Release we have completed our testing of the SmartComponent Library on this release of Progress and are proud to announce formal support for the SmartComponent Library on OpenEdge 11.7 with the 2017-04-24 release of the SmartComponent Library. Generally we recommend customers on OpenEdge 11 to upgrade to OpenEdge 11.7 quickly. Starting the 2017-07-14 release we are supporting OpenEdge 11.7 Service Pack 1 (11.7.1).

Starting the 2015-10-09 release the Business Entity Designer will feature a start page with links to most recent release note articles on this site.

With SCL-751 we have adopted native Enums for OpenEdge 11.6. To activate this feature customers must add a definition to products.i. SCL-751 provides details for this.

With SCL-1113 we have modified the templates for SmartWindowForms and SmartTabFolderPages generated from the Business Entity Designer. We have removed the initialization of the viewer controls SmartTableIOState property (value was set to "NoDataSource" within the InitializeComponent method). Customers using their own set of templates should adopt the same fix to their templates.

OpenEdge 11.7.2 compatibility

During our tests on OpenEdge 11.7.2 we have experienced two issues: 

  • [SCL-2007] - Correct support for WebHandler in CcsServiceManager
  • [SCL-2008] - Closing SmartWindowForm causes crash on OpenEdge 11.7.2

We consider it mandatory for customers using OpenEdge 11.7.2 to use at least the release #44166@2017-11-27 of the SmartComponent Library. 

Due to an fix for

  • [SCL-1924] - SmartViewerControl: copy mechanism cannot cope with clob datatype

from Progress Software for in OpenEdge we further recommend all customers to apply this hotfix as well. 

New Versions of Proparse .NET Assemblies (08 April 2018)

We have updated proparse with further enhancements in this release (see Please download the .NET Assemblies ZIP file from our ESD and replace the in your environment with the latest one. The new assembly reference is:

<assembly name=", Version=, Culture=neutral, PublicKeyToken=cda1b098b1034b24"/>

As proparse is used by our Business Entity Generator, this new version of the Assembly is also relevant for customers not doing GUI for .NET development and require support for parsing new ABL language constructs.

This version of proparse provides additional methods for refactoring purposes. The most recent code in the Consultingwerk.Studio package relies on those methods. It's therefore mandatory to update proparse to this version.

Hybrid Realm now using IAuthenticationService

We've updated the SmartHybridRealm class used for http authentication to leverage the IAuthenticationService. It is therefor required that for AppServers requiring http Authentication (e.g. REST or Web) the correct IAuthenticationService implementation is registered (using service.xml files).

Customers relying on the previous behavior should ensure that the Consultingwerk.SmartFramework.Authentication.AuthenticationService is regsitered as the IAuthenticationService. This implementation will auhtenticate users against the password stored in the SmartUser database table. 

When users with no Login Company set should be able to login using the SmartHybridRealm, it's required to set the Login Company Tennant Domain (similar to the field in the Login Company Maintenance) in the .restapplicationsettings / .applicationsettings, e.g.:


 "DefaultAuthenticationDomain": "consultingwerk" 

This is required as the Hydrid Realm Interface from Progress does not provide the domain name to the authentication method. 

Web Handler overview

This is an overview of the web handlers supported by this release

handler1=Consultingwerk.OERA.JsdoGenericService.WebHandler.CatalogWebHandler: /Catalog/{EntityName}
handler2=Consultingwerk.OERA.JsdoGenericService.WebHandler.CatalogsWebHandler: /Catalogs/{PackageName}
handler3=Consultingwerk.OERA.JsdoGenericService.WebHandler.CountWebHandler: /Resource/{EntityName}/count
handler4=Consultingwerk.OERA.JsdoGenericService.WebHandler.ResourceSubmitWebHandler: /Resource/{EntityName}/SubmitData
handler5=Consultingwerk.OERA.JsdoGenericService.WebHandler.InvokeMethodWebHandler: /Resource/{EntityName}/{MethodName}
handler6=Consultingwerk.OERA.JsdoGenericService.WebHandler.ResourceWebHandler: /Resource/{EntityName}
handler7=Consultingwerk.OERA.JsdoGenericService.WebHandler.BusinessServicesWebHandler: /BusinessServices/{OutputFormat}/{PackageName}
handler8=Consultingwerk.Web2.WebHandler.SmartMenuWebHandler: /SmartMenu/{MenuStructureId}
handler9=Consultingwerk.Web2.WebHandler.SmartMenuStructureWebHandler: /SmartMenuStructure
handler10=Consultingwerk.Web2.WebHandler.SmartRoutesWebHandler: /SmartRoutes
handler11=Consultingwerk.Web2.Services.SmartViewsHandler.SmartGridWebHandler: /SmartViews/Grid/{EntityName}/{ViewName}/{DetailTemplate}
handler12=Consultingwerk.Web2.Services.SmartViewsHandler.SmartGridWebHandler: /SmartViews/Grid/{EntityName}/{ViewName}
handler13=Consultingwerk.Web2.Services.SmartViewsHandler.SmartGridWebHandler: /SmartViews/Grid/{CustomViewName}
handler14=Consultingwerk.Web2.Services.SmartViewsHandler.SmartViewerWebHandler: /SmartViewer/Viewer/{EntityName}/{ViewName}
handler15=Consultingwerk.Web2.Services.SmartViewsHandler.SmartViewerWebHandler: /SmartViewer/Viewer/{ObjectName}
handler16=Consultingwerk.Web2.Services.SmartViewsHandler.SmartFormWebHandler: /SmartForm/{FormTemplate}/{EntityName}/{ViewName}
handler17=Consultingwerk.Web2.Services.SmartViewsHandler.SmartFormWebHandler: /SmartForm/{FormTemplate}/{ObjectName}
handler18=Consultingwerk.Web2.WebHandler.SmartMessageWebHandler: /SmartMessage/{MessageGroup}/{MessageNumber}
handler19=Consultingwerk.Web2.WebHandler.GetImageWebHandler: /Image/{FileName}
handler20=Consultingwerk.Web2.WebHandler.SmartValueListWebHandler: /ValueList/{ValueList}
handler21=Consultingwerk.Web2.WebHandler.SmartAttachmentsWebHandler: /Attachments/{Table}/{KeyValues}
handler22=Consultingwerk.Web2.WebHandler.SmartAttachmentWebHandler: /Attachment/{Guid}
handler23=Consultingwerk.Web2.WebHandler.SessionContextWebHandler: /SessionContext
handler24=Consultingwerk.Web2.WebHandler.ContextPropertiesWebHandler: /ContextProperties/{PropertyName}
handler25=Consultingwerk.Web2.WebHandler.ContextPropertiesWebHandler: /ContextProperties
handler26=Consultingwerk.Web2.WebHandler.SessionInfoWebHandler: /SessionInfo
handler27=Consultingwerk.Web2.WebHandler.FileSearchWebHandler: /FileSearch/{FileName}
handler28=Consultingwerk.Web2.WebHandler.ExecuteAblWebHandler: /ExecuteAbl
handler29=Consultingwerk.Web2.WebHandler.SmartLanguagesWebHandler: /Languages
handler30=Consultingwerk.OERA.RestResource.RestEntitiesWebHandler: /Entities
handler31=Consultingwerk.OERA.Swagger.SwaggerWebHandler: /Swagger/{EntityName}
handler32=Consultingwerk.OERA.Swagger.SwaggerRestEntitiesWebHandler: /SwaggerEntities/{OutputType}
handler33=Consultingwerk.Web2.WebHandler.SmartTokenSecurityCheckWebHandler: /TokenSecurityCheck/{ObjectName}
handler34=Consultingwerk.Web2.WebHandler.SmartTokenSecurityCheckWebHandler: /TokenSecurityCheck
handler35=Consultingwerk.Web2.WebHandler.SmartEntityTableMappingHandler: /EntityTableMapping/{EntityName}/{TableName}/{UiTypeCodes}
handler36=Consultingwerk.Web2.WebHandler.SmartTreeRootNodeWebHandler: /SmartViews/TreeRootNode/{rootnodeid}
handler37=Consultingwerk.Web2.WebHandler.SmartTreeChildNodesWebHandler: /SmartViews/TreeChildNodes/{parentnodeid}
handler38=Consultingwerk.Web2.WebHandler.SmartSecurityCheckWebHandler: /IsRestricted/{SecurityRealmCode}/{SecurityItemGuid}

UTF-8 based deployments available

Starting August 14th 2016 we ship our source code also as UTF-8 encoded. The ZIP files ending with contain the source code encoded with that code page. The source code in the remaining archives is still encoded in ISO8859-1. Also on Github there is a new branch containing the OpenEdge 11 based source code in UTF-8.

Related article (Progress K-Base): How to get Progress Developer Studio to save in UTF-8 encoding

New Feature Documentation

Download Link

Overview of included tickets


SCL-2211 Fixed FIND FIRST/LAST failed runtime error in the object master maintenance


We've fixed an issue that raised the error {{** FIND FIRST/LAST failed for table eDesignAttributeValue. (565)}} in the property sheet for instance attributes of the Object Master Maintenance form.   


SCL-2206 Renaming a temp-table in the Business Entity Designer should optionally update the entity class name field


When updating the name of a temp-table the Business Entity Designer does now prompt for updating the entity class name.

SCL-2208 Added more logging to the CcsServiceManager:getService Methods


To support issues with the instantiation or access to Web Handler instances, the CcsServiceManager (CCS implementation of the Service Manager) now supports detailled logging about the classes that are requested using the getService() method using the "ServiceManager" custom log entry type. 

SCL-2209 Added support for IsInRange validation for DECIMAL fields in the Business Entity Designer


The Business Entity Designer now supports the generation of IsInRange validation for DECIMAL fields. Prior to this change the IsInRange validation was only supported for INTEGER fields.

SCL-2210 Added support for sorting the result set in the Business Entity Tester


When the filter for a temp-table in the Business Entity Tester contains a BY-phrase, the result set will now be sorted by that criteria.

SCL-2212 Implemented support for combo-boxes when updating list based properties


The dynamic property grid used in the Object Master Maintenance on the Design Tab for Viewers or Grid now supports rendering properties as a combo-box.

SCL-2215 JSDO Catalog now includes ValidateData method by default


The ValidateData method of the Business Entity is now included as an invokable method in the JSDO by default.

New Feature

SCL-2201 Added new utility to the SmartFramework maintenance application to dump selected meta data


The SmartFramework maintenance application now has a new utility called "Export and Import SmartFramework Metadata".  This utility allows to export and import SmartFramework datasets (xml files).  The utility is configured using two XML files: - Consultingwerk\SmartFramework\Tools\deployment-datasets.json - Consultingwerk\SmartFramework\Tools\deployment-menusets.json The utility is launched from the SmartFramework menu function for the Form _Consultingwerk.Windows.Framework.System.ExportImportMetaDataForm_ using a character parameter. This character parameter provides the path to the deployment-datasets.json file. The deployment-menusets.json file is processed from the same folder. Using the deployment-dataset.json file, customers can configure the regular datasets for export and import:

        "Description": "SmartBusinessEntity Definitions",
        "BusinessEntity": "Consultingwerk.SmartFramework.System.SmartBusinessEntityBusinessEntity",
        "Tables": "*",
        "QueryString": "FOR EACH eSmartBusinessEntity WHERE NOT eSmartBusinessEntity.BusinessEntityPackage BEGINS 'Consultingwerk.SmartComponentsDemo'",
        "FileName": "smartbusinessentity.xml",
        "SkipFields": "TrackDeletions"
        "Description": "User Groups",
        "BusinessEntity": "Consultingwerk.SmartFramework.Authorization.GroupBusinessEntity",
        "Tables": "eSmartGroup",
        "QueryString": "FOR EACH eSmartGroup WHERE eSmartGroup.LoginCompanyGuid=''",
        "FileName": "smartgroup.xml",
        "SkipFields": ""

  The file deployment-menusets.json defines menu structures for dump and load:

        "Description": "SmartFramework Menu",
        "ParentGuids": "d5f16ac1-54ae-52b7-e211-391384a9e03a,fafd8128-fc6d-8eaf-e311-cd051a3c1fa6,90423811-8c25-1589-e311-0f23de584460",
        "FileName": "menu-structure.xml"
        "Description": "SmartComponents Web 2 Demo",
        "ParentGuids": "c8f0d5f7-0bbb-0a82-0314-747d2c383b8a",
        "FileName": "menu-structure-web2-demo.xml"


SCL-2202 SmartComponents NG: JSON rendering of check boxes


The SmartFramework repository does not support defining the inputType for controls. This allows rendering of logical fields as check boxes.

SCL-2205 Added support to control object tracking to the scl-pasoe scripts


Two new scripts are included in the bin directory: * scl-pasoe-trackablobjects.cmd (Windows) * scl-pasoe-trackablobjects (UNIX) Parameters: * -agentpid The proces ID of the the agent to monitor * -tracking on * -console reports on the console (by default the browser is used to view the json data) Activate ABL Object Tracking:

C:\Work_STREAM\SmartComponentLibrary\Develop\ABL\Consultingwerk\Studio\bin>scl-pasoe-trackablobjects.cmd -s 8820 -a oepas1 -agentpid 20140 -tracking on
DLC:       C:\Progress\OpenEdge117
OpenEdge Release 11.7.3 as of Tue Oct 24 19:02:00 EDT 2017
Activating trackABLObjects for agent 20140: SUCCESS

  Deactivate ABL Object Tracking:

C:\Work_STREAM\SmartComponentLibrary\Develop\ABL\Consultingwerk\Studio\bin>scl-pasoe-trackablobjects.cmd -s 8820 -a oepas1 -agentpid 20140 -tracking off
DLC:       C:\Progress\OpenEdge117
OpenEdge Release 11.7.3 as of Tue Oct 24 19:02:00 EDT 2017
Deactivating trackABLObjects for agent 20140: SUCCESS

  Check the ABL Object Tracking status:

C:\Work_STREAM\SmartComponentLibrary\Develop\ABL\Consultingwerk\Studio\bin>scl-pasoe-trackablobjects.cmd -s 8820 -a oepas1 -agentpid 20140 -tracking status
DLC:       C:\Progress\OpenEdge117
OpenEdge Release 11.7.3 as of Tue Oct 24 19:02:00 EDT 2017
TrackABLObjects for agent 20140 is not active

 Generate console report:

C:\Work_STREAM\SmartComponentLibrary\Develop\ABL\Consultingwerk\Studio\bin>scl-pasoe-trackablobjects.cmd -s 8820 -a oepas1 -agentpid 20140 -tracking report -console
DLC:       C:\Progress\OpenEdge117
OpenEdge Release 11.7.3 as of Tue Oct 24 19:02:00 EDT 2017
======== SESSION 4 ========
Source                                             Object        Handle ID         Size         Line
RunleakCode.p                                      MEMPTR             1038         1024           52
RunleakCode.p                                      MEMPTR             1037         1024           52
======== SESSION 7 ========
<No objects found for this session>

Report in the browser without -console it opens a browser and shows the json in the browser: 

SCL-2222 Added support for logical database name parameter to SmartDB upgrade and migration utility


We've implemented a new optional startup parameter to the SmartDB upgrade and migration utility ( -Dsmartldbname="SmartDB" This parameter can be used when the physical name of the SmartDB does not match the logical database name. The logical database name should match the SmartDB value in your _Consultingwerk/products.i_ file