Release Notes 2018-10-22

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 #48873@2018-10-22

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}

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-2395 Issue fixed in Repository Maintenance: Toggling checkbox properties in the Instance-Properties Grid should set Update State


When toggling the state of a checkbox for a logical property, the update state of the object instances grid was not set to updating. This only happened after changing a character property. We have resolved this issue now.

SCL-2400 Resolved an issue when opening source code from ProparseTreeViewForm


This has resulted in issue: Unable to render widget as Infragistics ButtonTool. Name may not be empty.

This has been fixed now.

SCL-2402 Fixed an issue in the Business Entity Tester


Pressing Enter in the Business Entity Filter Dialog with no filter value entered caused this issue:

The third argument to INDEX or R-INDEX must be in the range 1 to 32000 (for CHARACTER) or 1 to 1073741823 (for LONGCHAR). (4687)

This has been fixed now.

SCL-2403 .smartrepo files: Field PageKey has been exported as XML element instead of XML attribute


We have fixed the .smartrepo generation for the PageKey field of the SmartPage records.

Customers will have to dump all their existing repository data when they have used the PageKey.

SCL-2407 Filtering on ObjectMasterBusinessEntity by ObjectTypeName failed


We have fixed an issue that occurred after the optimizations in the ObjectMasterBusinessEntity. Filtering by the ObjectTypeName field was ignored. This has been resolved now.

SCL-2421 RepositoryManager no longer using UseDedicatedBusinessEntity on DatasetModels when executed on Frontend


We have resolved an issue in the SmartRepositoryManager implementation. This is no longer setting the UseDedicatedBusinessEntity flag of DatasetModels to TRUE when executed on an AppServer client.

SCL-2422 Object Master Maintenance errored on "Save As" when using AppServer


We've resolved an issue in the Obejct Master Maintenance with the "Save As" functionality. In a GUI session configured as an AppServer client this was causing the following issue:

Consultingwerk.SmartFramework.SmartDataAccess Database SmartDB not connected. (1006)

SCL-2423 Fixed System.ArgumentException when launching the SmartFramework Menu


We've fixed the following issue caused by starting the MainMenuForm for two different SmartDB's using the same repository branch for the Window settings:

System.ArgumentException: ActiveGroup cannot be set - specified Group cannot be activated! (Group may be disabled or its header may not be visible)

SCL-2427 Fixed on issue with CharacterType:IsNotNullOrEmpty


The method IsNotNullOrEmpty returned the unknown value for an unknown value. We've fixed this now.

SCL-2428 Fixed issues with UTF8 Character decoding in the JSDO Generic Service


UTF8 encoded characters (e.g. Umlaute) passed as part of the Query String for GET method have not been properly decoded. This has been resolved now.


SCL-2396 Grid Designer Control new refreshes the design view when switching from the Instances tab


The now Grid Designer refreshes when switching to this tab in the Repository Master Maintenance. This is required to reflect changes made in the Instances grid.

SCL-2397 Further performance optimization in the ObjectTypeBusinessEntity


When building the calculated fields for CustomObjectTypeGuid and ExtendsObjectTypeGuid, we no longer perform a request to the related Business Entities, when the GUID's are empty as those records do not exist in the DB.

SCL-2398 Enhanced the Proparse NodeWalker so that the INodeAction implementation can cancel processing


The Proparse NodeWalker recursively processes a JPNode's and calls back into a Task class for matching nodes.

The INodeAction Interface has now been extended to return a logical return value:

     * Purpose: Processes a JPNode
     * Notes:
     * @param poNode The JPNode to process
     * @return Logical value indicating if the process should be cancelled
    METHOD PUBLIC LOGICAL ProcessNode (poNode AS JPNode).

A logical value of TRUE returned by an implementation of the INodeAction will cause the NodeWalker to stop iterating further

SCL-2430 Improved error message when SmartAttribute.LookupValues is not CHR(3) delimited


We've improved the error message shown in the Object Master Maintenance screen when the value list of an attribute was not configured properly. Value lists need to be an CHR(3)-delimited list with an even number of entries.

New Feature

SCL-2142 Rendering of custom (repository defined) grids


We have implemented the Rendering of MetaGrid components with columns which are part of the repository definition (and not Business Entity Descriptor defined views).

SCL-2258 Rendering support for combo-boxes in Web Viewers


We have implemented the rendering of Combo-Boxes (Data driven, Smart Value Lists of simple value lists) in Angular viewers.

SCL-2387 Application PROPATH in the JSON config file


Added a new section environment to the JSON configuration file format. This section does currently support PROPATH related settings only (see also SCL-2429). The environment section supports defining application PROPATH entries as a JSON Array of Strings. This entries will be added to the beginning of the PROPATH configured either in the AppServer configuration or client .ini file. The environment section supports inheritance; when using inheritance, the PROPATH entries from multiple configuration files will be concatenated. The purpose defining the PROPATH in the JSON Configuration file format is to support a more standardized AppServer configuration.

A sample configuration of the environment settings may look like this:

    "environment": {
        "ensureAbsolutelPropath": true,
        "applicationPropath": [

SCL-2399 Implemented a Cache for the ISmartRepositoryService:FetchRepositoryObject method


The Consultingwerk.SmartFramework.Repository.ISmartRepositoryCache service is now used by the ISmartRepositoryService.FetchRepositoryObject to cache repository data that has been requested recently.

The cache can be configured with a maximum age after which cached repository data will be disposed. This configuration is performed using the RepositoryCacheMaxAge setting in the .applicationsettings/.restapplicationsettings file. The value is in seconds (3600 for 1 hr). A setting of 0 turns off the automatic cache refresh.

SCL-2404 New ProparseHelper API


We have added a new API to retrieve the full text of a Node excluding the leading white space and comments.

The API behaves similar to the JPNode:toStringFullText () API.

     * Purpose: Returns the full text of the Node
     * Notes:   Similar to the JPNode:toStringFullText() implementation, 
     *          but without the leading comments
     * @param poNode The node to return the full text of
     * @return The full text of the node

SCL-2412 Business Entity Tester: Including INDEX-INFORMATION for Data-Source Query into DataSource Query info output


We have now integrated the DATA-SOURCE Query's INDEX-INFORMATION into the output of the data source query information.

SCL-2424 Added new API to the repository Manager to locate Object Masters based on Attribute values


The following new API has been implemented:

 * Purpose: Returns a list of objects with the given attribute values
 * Notes: Useful to locate DataSource's for a given Business Entity etc.
 * @param poAttributes The DictionaryAttributeValue with the attribute values
 * @return The CharacterList with hte attribute values
 METHOD PUBLIC CharacterList GetObjectsWithAttributeValues (poAttributes AS DictionaryAttributeValue).

SCL-2429 JSON Config file now provides option to translate relative PROPATH entries to absolute


We've added a new section called "environment" to the JSON Configuration file. This section supports a logical property ensureAbsolutelPropath. When that is set to TRUE, the startup manager will convert relative entries in the PROPATH into absolute ones.

SCL-2432 Created a Repository Manager API to return a single Attribute Value of an Object Master


We've added the following new API to return a single attribute value:

     * Purpose: Returns a single Attribute Value assigned to an
     *          Object Master
     * Notes:
     * @param pcObjectMaster The Object Master GUID or Name
     * @param pcAttributeLabel The Attribute Label to return
     * @return The AttributeValue instance
    METHOD PUBLIC AttributeValue GetObjectMasterAttributeValue (pcObjectMaster AS CHARACTER,
                                                                pcAttributeLabel AS CHARACTER).

This API returns the attribute value defined for the object master or the class.