Release Notes 2018-11-21

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,, 11.7.4

Release 11.3 #49229@2018-11-21

OpenEdge 11.7.4 support!

We are please to announce that we are not aware of any issues using the SmartComponent Library on OpenEdge 11.7.4. We hereby declare OpenEdge 11.7.4 fully supported for the SmartComponent Library as of the release of November 5th 2018.

OpenEdge 11.7.3 support!

The previously reported issues with the Progress Developer Studio Visual Designer (Visual Designer related OpenEdge 11.7.3 product alert!!!) has been resolved by Progress Software with Hotfix 007 of OpenEdge 11.7.3. We hereby announce full compatibility of the SmartComponent Library with OpenEdge 

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

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!

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.3 compatibility

During our tests on OpenEdge 11.7.3 we have experienced the following issues: 

  • [SCL-2216] - 11.7.3 Visual Designer disabling properties of ABL user controls

The issue has been resolved by Progress Software with hotfix 007 for OpenEdge 11.7.3.

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}
handler39=Consultingwerk.Web2.WebHandler.SmartFieldSecurityCheckWebHandler: /RestrictedFields/{TableName}
handler40=Consultingwerk.Web2.WebHandler.GetImageNamesHandler: /ImageNames

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-2454 FetchData requests with a Skip value beyond the actual result set caused the Data Access to read from the beginning


We have resolved an issue where reading data from a Business Entity with a Skip value in the FetchDataRequest object higher than the actual number of records returned by the query resulted in data returned from the beginning of the result set. This was reproducible in all consumers of the Business Entities.

We have resolved this now. When Skip is set beyond the result set, we're now raising the OffEndException as expected and no data will be returned.

SCL-2456 Resolved issues with the ActivateRelations method of the DatasetHelper in case of cricular relations in the Dataset


When a ProDataset contains circular relations (eOrder -> eCustomer and eCustomer to eOrder as inactive) then following error might have been raised by the AVM when using the DatasetHelper:ActivateRelations method.

Attempt to relate dataset buffer eOrder to parent with itself in ancestry. (11965)

This issue has been fixed.


SCL-2457 Export of repository objects to .smartrepo files caused ? in numeric values to be imported as 0 (zero)


We have resolved an issue in the export and import routine of .smartrepo files that was causing the replacement of unknown values in the receiving repository. The issue was caused by the WRITE-XML of a ProDataset with field exported as XML attributes and not XML elements (for better readability). XML attributes don't support a property null value and the AVM will skip ? values just like the omit-initial-value skips the 0 values.

We have introduced a new XML attribute "IsUnknownValue" on the SmartAttributeValue nodes that allows us to distinguish ? from 0 during the import.


SCL-2451 Removing extra pairs of parenthesis when generating a query string from a Table Query


Previously the following code:

 oQuery = NEW CustomerQuery() .
oQuery:Or (NEW CustomerQuery ():Country:Eq("USA"):And:City:Begins("Bost"),
           NEW CustomerQuery ():Country:Eq("DE"):And:City:Begins("Colog"))
MESSAGE oQuery:ToQueryString(false)

was resulting in this query string:

for each eCustomer where Country EQ "USA" AND City BEGINS "Bost" OR (Country EQ "DE" AND City BEGINS "Colog") AND CreditLimit LT 1000

Due to the stronger binding of the AND (vs. the OR) the parenthesis around the second set of Country and City criteria was not required. We're removing that now.

SCL-2458 Implemented ability to prevent DatasetModel/TableModel from retrieving next batch during GetNext()


Implemented a new property Batching on the TableModel class

oCustomer = NEW CustomerDatasetModel () .
oCustomer:BatchSize = 5 .
oCustomer:Customer:Batching = FALSE .
oCustomer:Customer:Filter:CustNum:LT(100):Run () .

When the Batching property is set to FALSE, the DatasetModel/TableModel will only provide access to the number of records specified by the BatchSize property.

The property can also be set using a fluent interface - when the TableModelGenerated has been generated using the most recent templates:

oCustomer = NEW CustomerDatasetModel () .
oCustomer:SetBatchSize(5):Customer:SetBatching (FALSE):Filter:CustNum:LT(100):Run () .

SCL-2464 BufferHandle property of TableModel class is now PUBLIC GET


As the DatasetHandle property of the DatasetModel class is PUBLIC GET the buffer handle's are not hidden anyway. So we have made the BufferHandle property of the TableModel PUBLIC GET too, to avoid the need for weak-typed references when the access to the Buffer is required.

New Feature

SCL-2462 Implemented a new general purpose parameter class for the FetchDataByKeyTable method of the BusinessEntity or DataAccess class


The new general purpose class Consultingwerk.OERA.GenericFetchDataByKeyTableParameter can be used as the parameter to the FetchDataByKeyTable method of the Business Entity and Data Access class.

DEFINE VARIABLE oKeys AS GenericFetchDataByKeyTableParameter NO-UNDO .

/* Create parameter object, providing value for the Tables property to the constructor */
oKeys = NEW GenericFetchDataByKeyTableParameter ("eOrderLine":U) .

/* Define the key fields */
oKeys:CreateField ("Ordernum", DataTypeEnum:INTEGER) .
oKeys:CreateField ("Linenum",  DataTypeEnum:INTEGER) .

/* Create records in the key table */
hRecord = oKeys:CreateRecord() .
hRecord::OrderNum = 1 .
hRecord::LineNum = 1 .

hRecord = oKeys:CreateRecord() .
hRecord::OrderNum = 1 .
hRecord::LineNum = 2 .

hRecord = oKeys:CreateRecord() .
hRecord::OrderNum = 1 .
hRecord::LineNum = 3 .

/* Invoke the method FetchDataByKeyTable */ 
ServiceInterface:InvokeMethod ("Consultingwerk.OeraTests.SCL647.OrderLineBusinessEntity",
                               INPUT-OUTPUT DATASET dsOrderLine, 
                               oKeys) .