Release Notes 2023-05-10
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 #75889@2023-05-10 |
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:
|
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 |
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
- Support for RESTful invocation of Business Task and Business Entity Methods
- Invalid Proparse code-page setting corrupts temp-table field labels during "Refresh from Include"
- Generic Factory Service
- Using Invokable Business Entity Methods with Dataset Model Classes
- Using the Business Entity method FetchDataByKeyTable
- PASOE management scripts
- Business Entity Designer Launcher
- Searching data using ROWID's within the SmartBusinessEntityAdapter
- Business Entity Count Method
- SmartFramework ERD Designer
- Changes to the SmartDB and SmartDB upgrade and migration utility
- How to implement dynamic initial values
- How do I control the amount of details provided for error messages caused by our web handler
- Using custom log entry types
- Strong-typed Query Support
- Swagger REST API Documentation for RESTful Services
- Swagger REST API Documention for JSDO Generic Service
- Scaffolding utility for common helper classes
- RESTful services
- JSON Configuration File Format
- Common Component Specification (CCS)
Download Link
http://esd.consultingwerkcloud.com/
https://github.com/consultingwerk/SmartComponentLibrary
Overview of included tickets
Bug
SCL-4006 Resolved: FetchDataRequest doesn't evaluate date format correctly
Description:
We have resolved issues with formatting and parsing date values in the RestEntitiesWebHandler.
SCL-4075 Fixed regression: TableIO Delete was no longer working
Description:
We have fixed a regressing in the toolbar objects of our GUI for .NET Client. The regression was causing the Delete button of the toolbar controls no longer triggering a Delete in the TableIO target.
This issue is now fixed.
SCL-4078 Fixed leaking a dynamic buffer object handle in SmartRepositoryService
Description:
We have resolved a memory leak in the SmartRepositoryService. The leak was caused by a dynamic buffer object handler not getting cleaned up after use.
Improvement
SCL-3908 Support for named queries for RESTful Business Entities
Description:
Named queries are supported for RESTful queries, using the RestAddress annotation. To specify a named query for the request, add a {{namedQuery}} attribute to the {{@RestAddress}} annotation.
Parameters for the named query may optionally be provided using a {{namedQueryParameters}} attribute. These parameters are used to get values from the request’s query string.
The {{namedQueryParameters}} attribute contains a comma-separated list of parameters, or be empty. Each entry may take one of the following formats
* parameter-name . In this case, the parameter name is used as the query string key. The corresponding value is used as a character data type.
* parameter-name:parameter-data-type . In this case, the parameter name is used as the query string key. The corresponding value is converted to the data-type specified.
* query-string-name=parameter-name . The value of query-string-name is used to retrieve a value, and set as the parameter-name named query parameter. The character data type is used.
* query-string-name=parameter-name:data-type . The value of query-string-name is used to retrieve a value, and set as the parameter-name named query parameter. The corresponding value is converted to the data-type specified.
If the no matching query string value is passed in the request, the parameter is skipped (ie not set for the named query). Query string values that are not listed as named query parameters are ignored.
Example 1: using a data type conversion
@RestAddress (type="record", address="/Customers/CustomerByCustNum",
namedQuery="CustomersByCustNum",
namedQueryParameter="CustomerNumber:integer"
tables="eCustomer,eSalesrep", id="CustNum",
fields="eCustomer.*,eSalesrep.RepName,eSalesrep.Region", canRead="true", canUpdate="true", canDelete="true",
links="orders:/Customers/~{CustNum}/Orders,openOrders:/Orders?CustNum=~{CustNum}&&orderstatus=ordered,salesrep:/Salesreps/~{SalesRep}").
A request of {{GET /Customers/CustomerByCustNum?CustomerNumber=42}} will create the following
oNQ = NEW NamedQueryParameter ("CustomersByCustNum").
oNQ:Parameters:Add ("CustomerNumber", integer ("42")) .
Example 2: using a name mapping
@RestAddress (type="collection", address="/Customers/CustomerNachStadtUndLand",
namedQuery="CustomerByCountryAndState",
namedQueryParameters="Stadt=City,Land=Country"
tables="eCustomer,eSalesrep", id="CustNum",
fields="eCustomer.*,eSalesrep.RepName,eSalesrep.Region", canRead="true", canUpdate="true", canDelete="true",
links="orders:/Customers/~{CustNum}/Orders,openOrders:/Orders?CustNum=~{CustNum}&&orderstatus=ordered,salesrep:/Salesreps/~{SalesRep}").
A request of {{GET /Customers/CustomerNachStadtUndLand?Stadt=Bonn&Land=Deutschland}} will create the following
oNQ = NEW NamedQueryParameter ("CustomersByCityAndCountry").
oNQ:Parameters:Add ("City", "Bonn") .
oNQ:Parameters:Add ("Country", "Deutschland")
Example 3: no query string sent
@RestAddress (type="record", address="/Customers/CustomerByCustNum",
namedQuery="CustomersByCustNum",
namedQueryParameter="CustomerNumber:integer"
tables="eCustomer,eSalesrep", id="CustNum",
fields="eCustomer.*,eSalesrep.RepName,eSalesrep.Region", canRead="true", canUpdate="true", canDelete="true",
links="orders:/Customers/~{CustNum}/Orders,openOrders:/Orders?CustNum=~{CustNum}&&orderstatus=ordered,salesrep:/Salesreps/~{SalesRep}").
A request of {{GET /Customers/CustomerByCustNum}} will create the following
oNQ = NEW NamedQueryParameter ("CustomersByCustNum").
SCL-3997 ISO dates are supported in paths for Rest Resources
Description:
A RestAddress annotation that includes an ABL DATE field will have the date value read from the request URL as an ISO date value. The ISO dates are converted to ABL dates for queries.
For example, an annotation like the below expects a request on {{/web/Entities/Orders/1/2023-03-13}} ; a query of {{eOrder.CustNum = "1" and eOrder.OrderDate = "13/03/2023"}} is used (assuming -{{d DMY}})
@RestAddress (type="collection", address="/Orders/~{CustNum}/~{OrderDate}", tables="eOrder,eOrderLine", id="OrderNum",
fields="eOrder.*,eOrderLine.*", canRead="true", canCreate="false", canDelete="false",
links="OrdersByDate:/Orders/~{CustNum}/~{OrderDate},eCustomer:/Customers/~{CustNum}").
The values of the links written will also use an ISO date. For example the annotation above will , for the same URL, produce the following JSON.
{
"rel": "OrdersByDate",
"href": "http:\/\/localhost\/Entities\/Orders\/1\/2023-03-13"
}
SCL-4073 Implemented support for migration of IMAGE widgets on frames into the SmartFramework repository
Description:
The ABL Legacy GUI migration tool now supports migrating Image widgets into the Repository.
New Feature
SCL-130 SmartDataBrowser and SmartToolbarController: Implement the functionality to edit a record in a defined editor dialog defined on the SmartDataBrowser
Description:
A SmartUpdatableDataBrowser now fully supports to edit the current record in a separate Form through the DetailForm and DetailFormForUpdates property.
The DetailFormDataSources property provides an alternative form of passing Data Sources. When this property with a comma delimited list of Data Adapter names in the Form containing the Grid, those Data Sources are passed to the rendering routine of a dynamic Data Source. These Data Sources will be referenced in the Detail Form instead of the same named Data Sources in the detail form’s repository layout.
This allows to pass multiple Data Sources from the parent form to the detail form.
SCL-2714 RESTful: Ability to overload PUT, POST, PATCH, DELETE of @RestAddress with @RestMethod
Description:
RESTful Business Entities or Business Task now support overloading the PUT, POST, PATH and DELETE of an @RestAddress with an @RestMethod.
This allows to customize handling of certain request methods through a custom method.
SCL-3931 New rest resource formatting service
Description:
Business service methods annoted as a RestMethod can now format any returned datasets in the same manner as responses returned by the RestAddress URIs, ie with link references for self, child and related resources. This is possible using a new Consultingwerk.OERA.RestResource.IRestResourceFormatService and default Consultingwerk.OERA.RestResource.RestResourceFormatService implementation.
The IRestResourceFormatService provides methods to format a single record, a collection, a count response or just a general status message. The formatting methods accept data (typically a dataset) and also an instance of a Consultingwerk.OERA.RestResource.IRestResourceFormatParameter implementation. This type provides the formatting context (eg child links). The default implementation Consultingwerk.OERA.RestResource.RestResourceFormatParameter class is provided for this purpose. The methods return either JSON objects or arrays.
This formatting service must be run by the business service methods. Documentation on using this service can be found at Formatting datasets returned by RESTful Business Service methods .
Task
SCL-4079 Resolved Consultingwerk.SmartFramework.Menu.MenuBusinessEntity's "holding" of DataAccessObject
Description:
We have resolved cases where the MenuBusinessEntity was calling into the MenuDataAccess from custom method without shutting down the Data Access object at the end of the call. This left the Data Access object unexpectedly running.