Release Notes 2023-07-30

Version Information

OpenEdge Release

Version Information

11.7.9, 11.7.10, 11.7.11, 11.7.12, 12.2, 12.6, 12.7 CQC

Release 11.7 #77042@2023-07-30

Security Bulletin - log4j CVE-2021-44228

Further details: log4j CVE-2021-44228

OpenEdge 12.7 support!

We are pleased to announce that we are not aware of any issues using the SmartComponent Library on OpenEdge 12.7. We hereby declare OpenEdge 12.7 fully supported for the SmartComponent Library as of the release of  May 10th 2023.

OpenEdge 12.6 support!

We are pleased to announce that we are not aware of any issues using the SmartComponent Library on OpenEdge 12.6. We hereby declare OpenEdge 12.6 fully supported for the SmartComponent Library as of the release of  October 4th 2022.

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


Improvement

SCL-3559 The RestEntitiesWebHandler builds a FetchDataRequest using the QueryExpressionWithSort property when enabled in the Business Entity

Description:

If a Business Entity implements the Consultingwerk.OERA.ISupportsQueryExpressionWithSort interface, the Consultingwerk.OERA.RestResource.RestEntitiesWebHandler webhandler will construct fetch data requests using the QueryExpressionWithSort property rather than using the string-based Queries property.

If a Business Entity does not implement the Consultingwerk.OERA.ISupportsQueryExpressionWithSort interface, the default behaviour continues to be to build a query string and populate the fetch data request’s Queries property.

SCL-3791 Reduced code-duplication between DynamicControlGroup and DynamicForm rendering

Description:

To improve maintainability of our code base we have reduced code duplication between the rendering of DynamicControlGroup and DynamicForm repository objects.

SCL-4068 Implemented alternative SmartComponent Library Desktop

Description:

We have implemented an alternative SmartComponent Library Desktop as the carrousel of the initial SmartComponent Library desktop became less usable with a large number of tools added. The new desktop can be launched in the same way as the previous desktop - the startup procedure is called Consultingwerk/Studio/Desktop/start2.p

Note: This feature relies on an additional Telerik .NET Assembly:

<assembly name="Telerik.WinControls.Themes.VisualStudio2012Dark, Version=2021.2.615.40, Culture=neutral, PublicKeyToken=5bb2a467cbec794e"/>

SCL-4155 Custom tags can be added to RESTful annotations and business services

Description:

Tags can be added to RESTful annotations and business services, to group endpoints and/or services meaningfully in the Swagger documentation generated by the Consultingwerk.OERA.Swagger.SwaggerRestEntitiesWebHandler webhandler, typically used for the /SwaggerEntities endpoint.

Tags can be added as a comma-separated value to any RestAddress and RestMethod annotations, using a new tags attribute. These tags apply to the documentation generated for those endpoints. If no tags are specified, the default tags for the business service are used: the business service class name. If multiple tags are used, the endpoint(s) will appear in multiple groups.

The same tags can be used by multiple business service endpoints, allowing logical grouping of services in the Swagger documentation.

For example, adding the tags=”Customers” attribute as below will ensure that the GET, DELETE and POST endpoints, as well as the GET /Count endpoint, will be in a Customers group in the Swagger documentation.

@RestAddress (type="collection", address="/SCL4155/Customers", tables="eCustomer", id="CustNum",
              tags="Customers",
              fields="Name,City,Country",
              canRead="true", canCreate="true", canDelete="true",
              links="orders:/Customers/~{CustNum}/Orders,openOrders:/Orders?CustNum=~{CustNum}&&orderstatus=ordered,salesrep:/Salesreps/~{SalesRep}").



The default tags used for all the endpoints described in a service can be provided by means of a new annotation, @ApiDoc . This annotation supports a single attribute named tags, which work in the same way as those added to the RestAddress and RestMethod annotations.

@ApiDoc(tags="Customers").



In addition, details for these tags can be provided in a file. The location of this file is specified in the .restapplicationsettings file. Information in this file includes the tag name and a description of the tag, and optionally information about an external documentation URL.

For example,

{
  "pets": { 
      "description": "Everything about your Pets",
      "url": "http://docs.my-api.com/pet-operations.htm",
      "urlDescription": "Click here for pet info"      
  },
  "store": {
      "description": "Access to Petstore orders",
      "url": "http://docs.my-api.com/store-orders.htm",
      "urlDescription": "Click here for store info"
  }
}



If no tag detail is avaiable (eg no configuration provided, or the file cannot be found), the tag values are still used for grouping services. Details on configuring the file location are at https://consultingwerk.atlassian.net/wiki/spaces/SCL/pages/1989509121/Providing+Swagger+tag+descriptions .

Additional information can be found at https://consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094254/Support+for+RESTful+invocation+of+Business+Task+and+Business+Entity+Methods and https://consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094560/RESTful+services .

SCL-4166 GenericDataImporter in GUI now provides option to disable RI checks

Description:

The GUI frontend for the GenericDataImporter (Import/Export SmartFramework metadata) now provides an option to disable the referential integrity checks of the SmartDataAccess classes during the import. The option is settable from a checkbox in the import wizards.

SCL-4167 TableAndFieldStaticClassGeneratorPlugin now checks to create target directory

Description:

The Business Entity Designer plugin now checks if it needs to create the target folder. Previously the plugin failed when the target folder was not available. The functionality is based on a new API in the FileHelper class: CreateDirectoryForFile

SCL-4174 Improved error message when fetching repository objects with orphaned SmartObjectInstance records

Description:

We have improved the error message raised when fetching repository objects fails due to orphaned object instances (instance records pointing to an invalid object master guid).

The error message now includes the name of the instance causing the issue.

SCL-4175 Export/Import Menu structure from GUI now work with an AppServer connection

Description:

The Export/Import Menu structure from GUI now work in a thin client session connected to an AppServer. The improvement is based on a new general purpose business task that supports invoking methods of custom objects on the AppServer remotely: Consultingwerk.OERA.DynamicInvokeBusinessTask

SCL-4177 Supporting BufferHelper:FindDatabaseBuffer for database buffers that are not source-buffer of a Data-Source

Description:

We’re now supporting the BufferHelper:FindDatabaseBuffer for database buffers that are not source-buffer of a Data-Source. Previously the method fetched the KEYS attribute of the buffer from the DATA-SOURCE object handle. Now we’re fetching the attribute directly from the BUFFER object handle.

SCL-4178 New GUID for the "Toolbar" SmartLinkType record in the repository

Description:

Due to a conflict with a customer’s application that had already added a SmartLinkType record named “Toolbar” we’ve had to update the GUID of the SmartLinkType reocrd that we have recently introduced. The SmartDB update and migration routine has been enhanced with a routine that updates the LinkTypeGuid from "e3fb1251-e65b-d5a0-ae14-1b265c7998ed" to "f52235a4-c120-2490-3814-9d291ca82acc" in the SmartLinkType, SmartSupportedLink and SmartLink database tables.

It is mandatory to execute the SmartDB update and migration routine against every SmartDB that previously had loaded the release from June 18th of newer.

Customers may observe that containers using the “Toolbar” link are indicated as modified and will be dumped by the data versioning scripts.

New Feature

SCL-3986 Implement support for rendering "enabledState" setting on Smart Fields in Angular Viewers

Description:

The rendering of Angular viewers now includes rendering of the three enabled states for components in the viewer: Add, Copy, Update

SCL-4070 Implemented support rendering for components of type "custom" in Angular Smart Viewer and Smart Frame

Description:

Rendering support for custom components has been added to Angular viewers and smart frames. The rendering is based on the placeholderId attribute.

SCL-4074 Added an Outline View to Repository Viewer Designer

Description:

To improve usability of the viewer designer for large repository based designs we have added an Outline View to the viewer designer. The outline view can be accessed from a Button in the contextual ribbon of the designer.

SCL-4176 SmartDataAdapter's ParentPositionChangedBase method now check for validity of SmartDataSource

Description:

The ParentPositionChangedBase method of the SmartDataAdapter class can be used to signal linked data adapters, that the current SmartDataAdapter instance points to a different record (e.g. after opening the client side query). However in case of a SmartDatasetAdapter that has no SmartDataSource, this meathod did lead to closing the current adapter’s query.

This issue is now resolved.