Release Notes 2018-07-10

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 #47486@2018-07-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!!!

Introducing the SmartComponent Library developer forum

Got questions about using the SmartComponent Library? Wish to discuss feature requests with other users of the SmartComponent Library? To facilitate networking in the growing number of SmartComponent Library users and developers, we've added a developer forum on our new home-page. The developer forum can be found at: 

A login is required to participate in the forum. Don't be shy - create your account today!

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-2267 Added missing templates for DatasetModel Interfaces


The template for generating DatasetModel Interfaces have been missing. We have added those templates. The "Generate Intreface" or "Generate Read-Only Interface" options of the DatasetModel generator plugin of the Business Entity Designer are now working as expected. The missing tempalte was: Consultingwerk/BusinessEntityDesigner/Generator/Templates/Model/datasetmodelinterface.template


SCL-2241 Implemented a JsonSerializable variant of the LongcharLoggingStream class


The SerializableLongcharLoggingStream represents an LONGCHAR based ILoggingStream implementation which is serializable. This class can be used in situations where a single Logging stream should be used on client and AppServer. 

SCL-2248 Export a UI-Screen with all children-elements in a nested XML-structure


The process of exporting repository object masters to .smartrepo files has been changed. This change now produces a nested XML structure matching the structure of the object instances on the container. Please note, that with this change you'll have to dump all .smartrepo files. The new and old structure are no longer compatible to each other. It is recommend to use something like this to perform this task after compiling the most recent version of the SmartComponent Library: Please replace "<your root folder>" with the root folder for the export.
USING Consultingwerk.SmartFramework.Repository.* FROM PROPATH . 
USING Consultingwerk.SmartFramework.Repository.Tools.* FROM PROPATH . 

DEFINE VARIABLE oExporter AS RepositoryObjectExporter NO-UNDO .
DEFINE VARIABLE oRepository AS ISmartRepositoryService NO-UNDO .

oRepository = {Consultingwerk/get-service.i ISmartRepositoryService "NEW SmartRepositoryService()"} .
oExporter = NEW RepositoryObjectExporter() .

FOR EACH SmartObjectMaster NO-LOCK:
                                   "<your root folder>",
                                   TRUE) .

SCL-2250 Create strong-typed variants for ActivateRelations in a data access class


To simplify the usage of the ActivateRelations() API in the Data Access class, we are not generating methods in the Data Access class which do no longer require passing a DATA-RELATION Names as a Character argument:
        Purpose: Activates at eCustomereSalesrepRelation DATA-RELATION
    METHOD PROTECTED VOID ActivateRelationeCustomereSalesrepRelation ():
        THIS-OBJECT:ActivateRelations ("eCustomereSalesrepRelation":U).

        Purpose: Activates at ItemRelation DATA-RELATION
    METHOD PROTECTED VOID ActivateRelationItemRelation ():
        THIS-OBJECT:ActivateRelations ("ItemRelation":U).

        Purpose: Activates at OrderLineRelation DATA-RELATION
    METHOD PROTECTED VOID ActivateRelationOrderLineRelation ():
        THIS-OBJECT:ActivateRelations ("OrderLineRelation":U).

        Purpose: Activates at OrderRelation DATA-RELATION
    METHOD PROTECTED VOID ActivateRelationOrderRelation ():
        THIS-OBJECT:ActivateRelations ("OrderRelation":U).

SCL-2266 IMessageFormButtonProvider and IErrorMessageFormButtonProvider is now able to specify tooltip for buttons


Services for the IMessageFormButtonProvider and IErrorMessageFormButtonProvider interfaces are now able to specify the Tooltip to be used for the custom buttons. We are passing the _AccessibleDescription_ property value of the returned buttons to the UltraTooltipManager instance in the message dialogs.

SCL-2269 scl-gen Parameter should support data types for parameters


The <a href="">scl-gen</a> Parameter utility now supports custom parameter types for the serializable parameter object When specifying a parameter on the command line of the utiltiy, it's now possible to pass parameters either as <ParameterName> or <ParameterName>:<ParameterType> such as
scl-gen Parameter Test Test1:int Test2:date Test3 Test4:Consultingwerk.CharacterHolder
When the parameter type is not passed, CHARACTER is assumed.

SCL-2272 scl-gen NamedQuery now supports custom data types for query parameters


The <a href="">scl-gen</a> NamedQuery utility now supports custom parameter types for named queries. When specifying a parameter on the command line of the utiltiy, it's now possible to pass parameters either as <ParameterName> or <ParameterName>:<ParameterType> such as
scl-gen NamedQuery SampleNamedQuery Sample Test1 Test2:Int Test3:Date
When the parameter type is not passed, CHARACTER is assumed.

SCL-2276 The GarbageCollectorHelper is now able to clean up mempointers


We've added a variant of the GarbageCollectorHelper:DeleteObject method that supports cleaning up MEMPTR variables. As the SET-SIZE (mptr) = 0 does not require a validation (unlike the DELETE OBJECT hWidget) if the MEMPTR is allocated, this method is solely implemented for consistency and does not have any added value over using the SET-SIZE statement.

SCL-2278 Using a looking for the selection of the Product Module in the Value List Maintenance


Previously we had been using a combo-box to select the product module in the Value List Maintenance. This has been changed into a Lookup control now. The lookup provides better usability for customers with a large number of product modules.

SCL-2279 Implemented support for Skip with DatasetModel


We have implemented the Skip property in the DatasetModel class. When this property is set, the Skip value will be used to Skip the given number of records when retrieving data from the Business Entity. This allows the implementation of custom batching routines using DatasetModel classes.

SCL-2280 Calling CustomizeFetchDataRequest from FetchDataByKeyTable in DataAccess


The Data Access class is now also calling into the _CustomizeFetchDataRequest_ method from the FetchDataByKeyTable method. This allows to customize all FetchDataRequest parameter instances processed in the DataAccess class in a single central location.

New Feature

SCL-2273 ValueListProvider now caches generated ValueLists


The SmartFramework ValueListProvider implementation does now cache the generated Infragistics ValueList instances in memory. This eliminates the need for another AppServer call when a ValueList has already been retrieved.

SCL-2275 Implemented "Open Master" in Repository Object Maintenance


The Smart Object Master Maintenance Form does now allow to open another instance of the Form with the object master of the currently selected object instance opened. This function can be invoked by double clicking on an object instance record in the grid or clicking on a button in the Ribbon of the Form.