Release Notes 2020-05-19

Version Information

OpenEdge Release

Version Information

11.7.4, 11.7.5, 12.0, 12.1, 12.2

Release 11.7 #59011@2020-05-19

OpenEdge 12.2 support!

We are please to announce that we are not aware of any issues using the SmartComponent Library on OpenEdge 12.2. We hereby declare OpenEdge 12.2 fully supported for the SmartComponent Library as of the release of April 09th 2020.

OpenEdge 12.1 support!

We are please to announce that we are not aware of any issues using the SmartComponent Library on OpenEdge 12.1. We hereby declare OpenEdge 12.1 fully supported for the SmartComponent Library as of the release of September 21st 2019.

OpenEdge 12.0 support!

We are please to announce that we are not aware of any issues using the SmartComponent Library on OpenEdge 12.0. We hereby declare OpenEdge 12.0 fully supported for the SmartComponent Library as of the release of May 1st 2019.

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.

.NET Framework Version 4.7

.NET 4.7 is not supported with OpenEdge 11.x, see: Is .NET 4.7 certified and supported for OpenEdge? 

Progress has reported severy issues with OpenEdge GUI for .NET and .NET 4.7: GUI .Net Application crashes after .Net upgrade to 4.7

When using the .NET Framework 4.7, please make sure, you upgrade to OpenEdge 11.6.4 or OpenEdge 11.7.2 or later. Also, it may be required to recompile the application on a PC running .NET Framework 4.7 when applications are also executed on a PC with .NET Framework 4.7.

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 (30 December 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 debug information when errors are thrown from

New Version of the Consultingwerk.SmartComponents Assemly (09 January 2019)

To support the new SmartFilterControl and the "Filter" link between the SmartFilterControl/SmartDynamciFilterControl and a SmartBusinessEntityAdapter or SmartDatasetChildAdapter we have updated the Consultingwerk.SmartComponents.dll. The new Assembly reference is:

<assembly name="Consultingwerk.SmartComponents, Version=, Culture=neutral, PublicKeyToken=10603cb31df311b3"/>

Customers need to update this Assembly in order to compile the latest releases of the SmartComponent Library.

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
handler41=Consultingwerk.Web2.WebHandler.ExecuteQueryWebHandler: /ExecuteQuery
handler42=Consultingwerk.Web2.WebHandler.TranslationProviderWebHandler: /GetTranslation

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-3025 Improved rendering of Labels on connectors in the Crainiate diagramming control


We have improved the rendering of connectors in the Crainiate diagramming Control. The control is used to implement the design surface of the Business Entity Designer. As a result of this change, labels on the child table of a Data-Relation (e.g. 1 or N and the relation field names) are no longer rendered up-side-down in some situations.

SCL-3029 Crainiate Shape Image no longer locking until end of AVM session


We have resolved an issue in the Crainiate diagramming control that caused images used to render shapes remaining locked until the application (e.g. Business Entity Designer) has been exited.

SCL-3030 Enabled wild card search in the Open Repository Object Dialog


The Open Repository Object Dialog now supports using the asterisk character to perform a wild card search in the object name field.

SCL-3031 Implemented improvements to the Folder/Package Browser Dialog


We have made the following improvements to the folder browser dialog used for instance in the Business Entity Designer to browse for a package or folders.
When used to browse for a Package we now:
- disallow creating new "folders" with a period or spaces in the name
- when returning existing folders, disallow those with period or spaces in the name

SCL-3034 Resolved performance issues while drawing the design surface in the Business Entity Designer


We have resolved an issue causing a rather disturbing delay after every user interaction with the design canvas shapes in the Business Entity Designer. The diagram works significantly more fluent now.

New Feature

SCL-3011 Workflow status diagram


Applications can embed a diagram displaying the current workflow status of any given workflow enabled record. The diagram renders the workflow diagram as present in the workflow maintenance as well and marks the current status with a red border.
For this purpose the WorkflowDiagramControl needs to be added to an application screen. To render a workflow on the diagram, the following code is required in a suitable event handler. This example here renders the workflow diagram in an Infragistics UltraPopupControlContainer and is activated by clicking on a Link Label control:

     * Purpose: Event handler for the LinkClicked event of the linkLabel1
     * Notes:
     * @param sender The reference to the control that raised the event
     * @param e The LinkLabelLinkClickedEventArgs with the data for this event
    METHOD PRIVATE VOID linkLabel1_LinkClicked (sender AS System.Object,
                                                e AS System.Windows.Forms.LinkLabelLinkClickedEventArgs):

        DEFINE VARIABLE oRenderer AS WorkflowProcessInstanceDiagramRenderer NO-UNDO .
        DEFINE VARIABLE oPoint    AS System.Drawing.Point                   NO-UNDO .

        oPoint = THIS-OBJECT:PointToScreen (ultraComboEditor1:Location) .
        oPoint:Offset (ultraComboEditor1:Width * -1 + ultraComboEditor1:Width, ultraComboEditor1:Height) .

        ultraPopupControlContainer1:Show (ultraComboEditor1,
                                          oPoint) .

        oRenderer = NEW WorkflowProcessInstanceDiagramRenderer (THIS-OBJECT:workflowDiagramControl1) .

        oRenderer:RenderWorkflowDiagram (SmartComponentsDemoServices:OERA:Sports2000:OrderBusinessEntity,
                                         CAST (THIS-OBJECT:SmartDataSource,  SmartDatasetAdapter):QueryHandle:GET-BUFFER-HANDLE("eOrder":U),
                                         "OrderApproval":U) .



SCL-3012 Workflow overview / task list


We have implemented the new form Consultingwerk.Windows.Framework.Workflow.WorkflowInstanceForm to support displaying active workflow instances (for the current user).
Application services that intend to provide workflow instances (task items) need to subscribe to the event CollectWorkflowInstances of the Consultingwerk.SmartFramework.Workflow.IWorkflowEngine service.

     * Purpose: Event raised to collect ttWorkflowStatus records of various provides
     * Notes:
     * @param dsWorkflowStatus INPUT-OUTPUT Dataset with workflow status records
    DEFINE EVENT CollectWorkflowInstances SIGNATURE VOID (INPUT-OUTPUT DATASET dsWorkflowStatus) .

When the event is raised multiple subscribers are called and can add records to the ttWorkflowStatus temp-table in the dsWorkflowStatus dataset.
A sample implementation of such a subscriber can be a service subscribing to the events of the IWorkflowEngine when started

     * Purpose: Initializer/Startup
     * Notes:
    METHOD PUBLIC VOID initialize ():

        DEFINE VARIABLE oWorkflowEngine AS IWorkflowEngine NO-UNDO .

        oWorkflowEngine = {Consultingwerk/get-service.i IWorkflowEngine
                                "NEW WorkflowEngine ()"} .

        oWorkflowEngine:CollectWorkflowInstances:Subscribe (CollectWorkflowInstancesHandler) .
        oWorkflowEngine:OpenWorkflowInstance:Subscribe (OpenWorkflowInstanceHandler) .


and an event handler for the CollectWorkflowInstances event:

     * Purpose: Event handler for the CollectWorkflowInstances event of the Workflow engine
     * Notes:
     * @param dsWorkflowStatus INPUT-OUTPUT Dataset with workflow status records
    METHOD PROTECTED VOID CollectWorkflowInstancesHandler (INPUT-OUTPUT DATASET dsWorkflowStatus):

        DEFINE VARIABLE oEntity AS OrderBusinessEntity NO-UNDO .

        oEntity = CAST (ServiceManager:GetBusinessService (SmartComponentsDemoServices:OERA:Sports2000:OrderBusinessEntity,
                        OrderBusinessEntity) .

        oEntity:GetWorkflowInstances (INPUT-OUTPUT DATASET dsWorkflowStatus BY-REFERENCE) .


This subscriber may call into a method of a Business Entity (a Business Entity is typically not suited to subscribe to the event directly, as Business Services may not always be running).
In the method of the Business Entity, ttWorkflowStatus records are typically created using the CreateWorkflowStatusRecord API of the IWorkflowEngine service. The application logic needs to assign the Assignee,WorkflowTimestamp and RecordDescription fields accordingly.

     * Purpose: Adds the OrderApproval workflow items to the dsWorkflowStatus
     * Notes:
     * @param dsWorkflowStatus INPUT-OUTPUT Dataset with workflow status records
    METHOD PUBLIC VOID GetWorkflowInstances (INPUT-OUTPUT DATASET dsWorkflowStatus):

        DEFINE VARIABLE oWorkflowEngine AS IWorkflowEngine      NO-UNDO .
        DEFINE VARIABLE oRequest        AS FetchDataRequest     NO-UNDO .
        DEFINE VARIABLE oSalesrep       AS SalesRepDatasetModel NO-UNDO .
        DEFINE VARIABLE cCustName       AS CHARACTER            NO-UNDO .

        oWorkflowEngine = {Consultingwerk/get-mandatory-service.i IWorkflowEngine} .

        oSalesrep = NEW SalesRepDatasetModel() .

        oRequest = NEW FetchDataRequest ("eOrder,eCustomer":U,
                                         "for each eOrder where (eOrder.OrderStatus = 'Ordered'~
                                                              or eOrder.OrderStatus = 'Approval pending'~
                                                              or eOrder.OrderStatus = 'Approved'~
                                                              or eOrder.OrderStatus = 'Partially Shipped') and eOrder.Salesrep = 'HXM' by eOrder.OrderDate descending":U,
                                         500) .


        FOR EACH eOrder:
            oWorkflowEngine:CreateWorkflowStatusRecord (BUFFER ttWorkflowStatus:HANDLE,
                                                        BUFFER eOrder:HANDLE,
                                                        "OrderApproval":U) .

            IF CAN-FIND (eCustomer WHERE eCustomer.CustNum = eOrder.CustNum) THEN DO:
                {&_proparse_ prolint-nowarn(findnoerror)}
                FIND eCustomer WHERE eCustomer.CustNum = eOrder.CustNum .
                ASSIGN cCustName = eCustomer.Name.
                ASSIGN cCustName = "<Customer not available>":U .

            ASSIGN ttWorkflowStatus.Assignee          = oSalesrep:Salesrep:RepName
                   ttWorkflowStatus.WorkflowTimestamp = DATETIME-TZ (eOrder.OrderDate, (eOrder.Ordernum MODULO 86400) * 1000).

            CASE eOrder.OrderStatus:
                WHEN "Ordered":U THEN
                    ASSIGN ttWorkflowStatus.RecordDescription = SUBSTITUTE ("Approval pending for Order &1, Promise Date &2, &3":U,
                                                                            eOrder.Ordernum, eOrder.PromiseDate, cCustName) .
                WHEN "Approval pending":U THEN
                    ASSIGN ttWorkflowStatus.RecordDescription = SUBSTITUTE ("Awaiting approval for Order &1, Promise Date &2, &3":U,
                                                                            eOrder.Ordernum, eOrder.PromiseDate, cCustName) .
                WHEN "Approved":U THEN
                    ASSIGN ttWorkflowStatus.RecordDescription = SUBSTITUTE ("Awaiting shipping for Order &1, Promise Date &2, &3":U,
                                                                            eOrder.Ordernum, eOrder.PromiseDate, cCustName) .
                WHEN "Partially Shipped":U THEN
                    ASSIGN ttWorkflowStatus.RecordDescription = SUBSTITUTE ("Complete shipping for Order &1, Promise Date &2, &3":U,
                                                                            eOrder.Ordernum, eOrder.PromiseDate, cCustName) .
            END CASE .

            RELEASE ttWorkflowStatus .


SCL-3032 Implemented fix method for corrupted dock manager settings


Some customers have experienced every now and then corrupted Infragistics Dock Manager settings being stored and restored when GUI for .NET applications have been launched. Some customers more frequently than others. Some customers never. A typical result of broken Dock Manager settings has been that the Infragistics Column Chooser has not been rendered in a Dockable Pane and those just overlaid some random location on the main window.
We have found various sources in the Infragistics Forum (e.g. ) and other sites indicating that this might be an issue in the Infragistics component when saving the settings.
We have now added code to our reference MainMenuForm which detects this situation and will automatically reset the stored Dock Manager settings to avoid the disturbance for the users.
The following code has been added in the OnLoad() method around the call to the DockManagerHelper:RestoreFromSettingsService ().

        /* Prepare restoring of initial Dock Manager settings in case restoring the stored settings fails. */
        oDockedControls = DockManagerHelper:GetDockedControls(ultraDockManager1) .

            oMemoryStream = NEW MemoryStream() .

            ultraDockManager1:SaveAsXML(oMemoryStream) .

            /* DockManager */
            DockManagerHelper:RestoreFromSettingsService (ultraDockManager1,
                                                          THIS-OBJECT:WindowPositionRegistryKey) .

            IF NOT DockManagerHelper:EnsureDockedControls(ultraDockManager1, oDockedControls) THEN DO:
                oMemoryStream:Seek(0, SeekOrigin:Begin) .
                ultraDockManager1:LoadFromXML(oMemoryStream) .

                IF VALID-OBJECT (oMemoryStream) THEN
                    oMemoryStream:Dispose() .

                IF VALID-OBJECT (oMemoryStream) THEN
                    DELETE OBJECT oMemoryStream .
            END FINALLY.