Release Notes 2022-09-28

Version Information

OpenEdge Release

Version Information

11.7.9, 11.7.10, 11.7.11, 11.7.12, 12.2., 12.5.2

Release 11.7 #71961@2022-09-28

Security Bulletin - log4j CVE-2021-44228

Further details: log4j CVE-2021-44228

OpenEdge 12.3 support!

We are pleased to announce that we are not aware of any issues using the SmartComponent Library on OpenEdge 12.3. We hereby declare OpenEdge 12.3 fully supported for the SmartComponent Library as of the release of  November 24th 2020.

OpenEdge 12.2 support!

We are pleased 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.

.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: https://www.consultingwerk.com/support/forum 

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

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 11.7.2.001 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 https://github.com/consultingwerk/proparse/releases/tag/4.0.1.1177). Please download the .NET Assemblies ZIP file from our ESD and replace the proparse.net.dll in your environment with the latest one. The new assembly reference is:

<assembly name="proparse.net, Version=4.0.1.1177, Culture=neutral, PublicKeyToken=cda1b098b1034b24"/>

As proparse is used by our Business Entity Generator, this new version of the proparse.net 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 proparse.net.dll.

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=2.2.0.49856, 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

defaultHandler=OpenEdge.Web.CompatibilityHandler
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 _utf8.zip 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

http://esd.consultingwerkcloud.com/

https://github.com/consultingwerk/SmartComponentLibrary

Overview of included tickets


Bug

SCL-3787 Fixed TelemetryGrid:ProcessingFile event not following standard convention for .NET events

Description:

The ProcessingFileEventArgs class in the Consultingwerk.UltraControls assembly did not inherit from System.EventArgs which did lead to the following compile time warning when compiling the TelemetryViewerForm.cls ABL class:

Warning: The 'ProcessingFile' event is a .NET event that does not follow the .NET convention for event signatures. There may be an exception thrown if it fires when ABL code has subscribed to it. (18359)ABL Compiler(18359)

This issue is resolved.

Improvement

SCL-3732 Support for multiple tenant domains for a login company

Description:

We have extended our Login Company to support multiple tenant domains. Support for multiple tenant domains is implemented through supporting a comma delimited list of tenant domains in the login company maintenance.

The SmartHybridRealm and RestServerSessionActivator classes have been extended to test the users domain name against any entry to the SmartLoginCompany record.

SCL-3789 Using Native Serialization for commonly used Invokable Method parameter

Description:

In order to test https://consultingwerk.atlassian.net/browse/SCL-1320 we have implemented the usage of native serialization for commonly used ServiceAdapter:InvokeMethod calls used in the SmartFramework package.

New Feature

SCL-1320 New ServiceAdapter methods to use native ABL serialization

Description:

In order to support the use of native ABL serialization of objects (ie classes defined with the SERIALIZABLE keyword in the CLASS statement), 2 new methods are added to the Consultingwerk.OERA.IServiceAdapter interface and consequently to the Consultingwerk.OERA.ServiceAdapter implementation.

The methods are named InvokeMethod2 and have similar signatures to the existing InvokeMethod methods. The major difference is that the parameter object is defined as INPUT poParameter AS Progress.Lang.Object , instead of the input Consultingwerk.ISerializable parameter in the InvokeMethod methods. The parameter object is returned as a return value for cases where the service returns changed values (either to the existing parameter object, or a new or different parameter object). Note that InvokeMethod2 returns a different instance of the parameter object to the caller than the one which as passed in. Code that relies on properties of the returned object instance need to access those from the returned reference instead of expecting that the input object gets updated.

The methods validate that the input parameter objects are either defined as SERIALIZABLE or that they implement Consultingwerk.ISerializable . Parameter objects that are neither will cause a Consultingwerk.OERA.Exceptions.NoSerializableTypeException to be thrown.

Using the InvokeMethod2 methods is recommended, since native ABL serialization performs better that serialization written in ABL.

The new methods' signatures are below.

/**
 * Purpose: Invokes a custom method of the BusinessEntity.
 * Notes:   - The object passed in as a parameter must either be ABL-SERIALIZABLE or implement
 *            Consultingwerk.ISerializable
 * *        - This method differs from InvokeMethod() in that it always returns the parameter object
 * @param pcPartition The name of the AppServer partition for this call or "" for the default partition
 * @param pcEntityName The name of the business entity
 * @param pcMethodName The name of the business entity method to invoke
 * @param phDataset INPUT-OUTPUT DATASET-HANDLE The handle of the dataset of the business entity, optionally INPUT, optionally OUTPUT
 * @param poParameter The serializable parameter object to the method
 * @return The parameter object. May be updated/different from the input object
 */
METHOD PUBLIC Progress.Lang.Object InvokeMethod2 (pcPartition AS CHARACTER,
												  pcEntityName AS CHARACTER,
												  pcMethodName AS CHARACTER,
												  INPUT-OUTPUT DATASET-HANDLE phDataset,
												  poParameter AS Object) .

/**
 * Purpose: Invokes a custom method of the BusinessEntity.
 * Notes: - The phContextDataset parameter is intended to be passed by-reference
 *        - The object passed in as a parameter must either be ABL-SERIALIZABLE or implement
 *          Consultingwerk.ISerializable
 *        - This method differs from InvokeMethod() in that it always returns the parameter object
 * @param pcPartition The name of the AppServer partition for this call or "" for the default partition
 * @param pcEntityName The name of the business entity
 * @param pcMethodName The name of the business entity method to invoke
 * @param phDataset INPUT-OUTPUT DATASET-HANDLE The handle of the dataset of the business entity, optionally INPUT, optionally OUTPUT
 * @param poParameter The serializable parameter object to the method
 * @param phContextDataset The handle of the context dataset for this call
 * @return The parameter object. May be updated/different from the input object
 */
METHOD PUBLIC Progress.Lang.Object InvokeMethod2 (pcPartition  AS CHARACTER,
												  pcEntityName AS CHARACTER,
												  pcMethodName AS CHARACTER,
												  INPUT-OUTPUT DATASET-HANDLE phDataset,
												  poParameter AS Object,
												  phContextDataset AS HANDLE) .



In addition, the existing InvokeMethod methods now return the parameter object as a return value of type Progress.Lang.Object, to be consistent with the new InvokeMethod2 methods.

The Consultingwerk.SmartComponents.Implementation.SmartBusinessEntityAdapter has a new InvokeMethod2 method, and the InvokeMethod method now returns the parameter object. The new method signature is below.

    /**
     * Purpose: Invokes a method in the backend OERA business entity
     * Notes:   This variant of InvokeMethod2 uses the native ABL-SERIALIZABLE method
     *          for exchanging the parameter object with the backend. It does however
     *          return a different instance of the parameter object, so the unlike in
     *          InvokeMethod() the instance passed in as the poParameter reference is
     *          not updated with data from the backend. Thus we're introducing the
     *          return value to return the updated parameter object from the backend.
     * @param pcMethodName The method to be invoked in the Business Entity
     * @param phDataset INPUT-OUTPUT DATASET-HANDLE The handle of the dataset to be passed to the Business Entity method
     * @param poParameter The ISerializable parameter object to be passed to the Business Entity method
     * @return The instance of the parameter object
     */
    METHOD PUBLIC Progress.Lang.Object InvokeMethod2 (pcMethodName AS CHARACTER,
                                                      INPUT-OUTPUT DATASET-HANDLE phDataset,
                                                      poParameter AS Progress.Lang.Object):


SCL-3781 Implemented DynamicControlGroup rendering for GUI for .NET

Description:

We have implemented the rendering of ControlGroups for the GUI for .NET client. ControlGroups can be rendered within a MetaForm and MetaViewer. They support rendering of all components that can be rendered into a MetaForm themselves and thus represent a container type that can be used to build reusable tab pages or user controls based on other Viewers, Grids and DataSources for viewers.

The rendering is based on the MetaControlGroup type in the SmartFramework Repository.

This feature introduces a potentially breaking change for customers that have introduced their own rendered components for forms or viewers: We have added a new parameter

poTabFolderParent AS Consultingwerk.Windows.Framework.Repository.Rendering.ITabFolderParent



to various methods in the

* Consultingwerk.Windows.Framework.Repository.Rendering.IComponentRenderingService
* Consultingwerk.Windows.Framework.Repository.Rendering.IContainerRenderingService
* Consultingwerk.Windows.Framework.Repository.Rendering.IViewerComponentRenderingService

this parameter is typically just passed through from the methods to other affected methods that are called.