Release Notes 2018-09-02
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, 11.7.3.007 | Release 11.3 #48127@2018-09-02 |
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 11.7.3.007.
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: https://www.consultingwerk.com/support/forum
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 11.7.2.001 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 https://github.com/consultingwerk/proparse/releases/tag/4.0.1.1176). 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 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
defaultHandler=OpenEdge.Web.CompatibilityHandler 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 _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-2341 Memory leaks observed by customer with FetchDataRequest instances and DatasetModels
Description:
One customer has observed a high number of FetchDataRequest instances present in the session memory.We have reviewed and tested the code and could not identify any issues caused by our code.
It is however by design that the DatasetModelPerformer class keeps an instance of the FetchDataRequest class when the Business Entity indicated that for the current request, there are more batches of data available. In those cases, the same FetchDataRequest instance is reused when making follow up requests to the backend.
We have verified, that once the DatasetModel class is removed (by DELETE OBJECT or the GarbageCollector), that there is no FetchDataRequest instance left in memory.
To ensure that no 3rd party code is keeping a reference to the FetchDataRequest instance, we have implemented code to actively DELETE OBJECT an existing FetchDataRequest instance in the DatasetModelPerformer:
- when a new query is opened
- when the current query hit's the end of the result set and the Business Entity indicates that there are no further batches availalbe
Improvement
SCL-2339 Implemented ability to provide additional filters with FetchDataByKeyTable method
Description:
The Business Entity / Data Access method FetchDataByKeyTable does now support additional filter criteria. Previously it was not possible to combine filtering on a set of unique key values (provided in the key temp-table) with additional filter criteria. This has been implemented now.The new Interface Consultingwerk.OERA.IFetchDataByKeyTableRequest enhances the IFetchDataByKeyTableParameter interface with properties known from the IFetchDataRequest interface:
- CustomContext
- CustomParameter
- NamedQuery
- Queries
- StopAfter
It if possible to implement the IFetchDataByKeyTableRequst Interface by implementing from the FetchDataRequest class:
CLASS Consultingwerk.OeraTests.SCL2339.FetchDataByKeyTableRequest INHERITS FetchDataRequest IMPLEMENTS IFetchDataByKeyTableRequest: DEFINE TEMP-TABLE ttCustomer NO-UNDO FIELD CustNum AS INTEGER INDEX CustNum IS UNIQUE CustNum . DEFINE PUBLIC PROPERTY KeyValueTableHandle AS HANDLE NO-UNDO GET. PRIVATE SET. CONSTRUCTOR PUBLIC FetchDataByKeyTableRequest (): ASSIGN THIS-OBJECT:KeyValueTableHandle = TEMP-TABLE ttCustomer:HANDLE THIS-OBJECT:Tables = "eCustomer":U . END CONSTRUCTOR. CONSTRUCTOR PUBLIC FetchDataByKeyTableRequest (poQuery AS CustomerQuery): THIS-OBJECT() . THIS-OBJECT:Queries = poQuery:ToQueryString(TRUE) . END CONSTRUCTOR. METHOD PUBLIC VOID AddCustomer (piCustNum AS INTEGER): CREATE ttCustomer. ASSIGN ttCustomer.CustNum = piCustNum . RELEASE ttCustomer . END METHOD. END CLASS.
As the new Interface IFetchDataByKeyTableRequest extends the IFetchDataByKeyTableParameter interface, objects implementing this interface can be passed whenever an IFetchDataByKeyTableParameter object is supported as well, e.g.:
DEFINE VARIABLE oRequest AS FetchDataByKeyTableRequest NO-UNDO . DEFINE VARIABLE oQuery AS CustomerQuery NO-UNDO . DEFINE VARIABLE oCustomer AS CustomerDatasetModel NO-UNDO . oQuery = NEW CustomerQuery () . oQuery:SalesRep:Eq("HXM":U) . oRequest = NEW FetchDataByKeyTableRequest (oQuery) . FOR EACH Customer WHERE CustNum >= 20 AND CustNum <= 100: oRequest:AddCustomer(Customer.CustNum) . END. oCustomer = NEW CustomerDatasetModel () . oCustomer:Customer:Fill (oRequest) .
SCL-2340 Added new method FindWidgetWithName to WidgetHelper
Description:
Added the following new method in the Consultingwerk.Util.WidgetHelper class:/** * Purpose: Locates the Widget handle with the given name based * on a list of widget handles * Notes: Used to find a Frame handle in the cWinKitListOfFrameHandles * variable, etc. * @param pcWidgetName The name of the frame to locate * @param pcWidgetHandles The comma delimited list of frame handles * @return The handle of the frame with the requested name or ? */ METHOD PUBLIC STATIC HANDLE FindWidgetWithName (pcWidgetName AS CHARACTER, pcWidgetHandles AS CHARACTER):
SCL-2346 Additional UltraToolbarsHelper:CreateButtonToolFromButton variant that allows to pass a custom tool name
Description:
In situations where a button with the same name is used on two FRAME's, it may be required to add them to the UltraToolbarsManager with different Key properties of the ButtonTool. As the Key property of the ButtonTool can only be assigned when NEW'ing the ButtonTool, we've implemented a new variant of the CreateButtonToolFromButton method in the UltraToolbarsHelper:/** * Purpose: Creates a Button Tool (RootTool only) in the UltraToolbarsManager * based on the properties of a ABL Button Widget * Notes: * @param poToolbarsManager The reference to the UltraToolbarsManager that contains the Ribbon * @param phButton The HANDLE of the ABL BUTTON widget * @param pcButtonKey The key for the new button * @return The reference to the ButtonTool that was created to represent the ABL BUTTON widget */ METHOD PUBLIC STATIC ButtonTool CreateButtonToolFromButton (poToolbarsManager AS UltraToolbarsManager, phButton AS HANDLE, pcButtonKey AS CHARACTER):
SCL-2347 Implemented returning a longchar from @RestMethod annotated methods.
Description:
With the changes for SCL-2344, we're now also allowing to return LONGCHAR values from a RESTful method.LONGCHAR return values must be wrapped in an OpenEdge.Core.String instance, which is supported by the OpenEdge WebHandler as the response entity by default
@RestMethod (address="/TestWithRespose3", requestMethod="get", response="return"). METHOD PUBLIC RestMethodResponse TestMethod4 (): DEFINE VARIABLE oResponse AS OpenEdge.Core.String NO-UNDO . DEFINE VARIABLE lcResponse AS LONGCHAR NO-UNDO . lcResponse = "Hallo Welt!" . oResponse = NEW OpenEdge.Core.String (lcResponse) . RETURN NEW RestMethodResponse (oResponse, "text/plain") . END METHOD.
SCL-2350 Support messages[] also for error returned as JSON with only a single error message
Description:
Our JSON based WebHandlers have previously returned errors with only a single error message (NumMessages = 1) with a single message character property and errors with multiple error messages (NumMessages > 1) with an messages array of errors.While this is a pretty common method in some REST and JavaScript API's, other clients may find this confusing or inconsistent.
We have therefor implemented a new setting in the .restapplicationsettings file called JsonErrorEnforceMessageArray. When this will be set to "true" (character), also a single error message will be wrapped in the messages array. When this is not present or set to false, the previous behavior persists.
SCL-719 Changed how the DataSource method SourceColumn is referencing the buffer for DATA-SOURCE-COMPLETE-MAP
Description:
In this ticket we had intended to change the naming of DATA-SOURCE object's in the DataAccess classes. We've been hesitating to do so, as this would affect existing code.The biggest pain point with the current naming of DATA-SOURCE's is the code generated in the SourceColumn method of the DataAccess classes. As this was referencing the temp-table buffer through the DATA-SOURCE.
The new code now references the temp-table buffer directly - as this is the buffer that directly knows about the DATA-SOURCE-COMPLETE-MAP:
METHOD OVERRIDE PUBLIC CHARACTER SourceColumn (pcTable AS CHARACTER, pcColumn AS CHARACTER): DEFINE VARIABLE cMap AS CHARACTER NO-UNDO. DEFINE VARIABLE iPos AS INTEGER NO-UNDO . @SourceColumnCaseBlock. CASE pcTable: WHEN "eCustomer":U THEN cMap = BUFFER eCustomer:DATA-SOURCE-COMPLETE-MAP . END CASE .
This also resolves issues referencing the DATA-SOURCe-COMPLETE-MAP in situations with dynamic or alternative DATA-SOURCE's.
New Feature
SCL-2299 Implemented client-startup based on CCS Startup Manager
Description:
We have implemented a new client startup routine based on the JSON Configuration File Format . A client startup procedure may now use the GuiClientStartupManager to start a session. A sample client startup procedure may look like this:/* *************************** Definitions ************************** */ BLOCK-LEVEL ON ERROR UNDO, THROW. USING Consultingwerk.Framework.* FROM PROPATH . USING Consultingwerk.Util.* FROM PROPATH. {Consultingwerk/products.i} DEFINE VARIABLE oStartupManager AS GuiClientStartupManager NO-UNDO . /* *************************** Main Block *************************** */ IF NOT CONNECTED (&IF DEFINED (SmartDB) NE 0 &THEN "{&SmartDB}":U &ELSE "SmartDB":U &ENDIF) THEN oStartupManager = NEW GuiClientStartupManager ("Consultingwerk/Windows/Framework/Reference/startup_gui_client.json":U) . ELSE oStartupManager = NEW GuiClientStartupManager ("Consultingwerk/Windows/Framework/Reference/startup_gui_fatclient.json":U) . oStartupManager:initialize() . CATCH err AS Progress.Lang.Error: ErrorHelper:ShowErrorMessageBox (err). END CATCH.
Typical settings, such as the startup procedure, default AppServer partition name, taskbar application id etc. are now set as static properties, like this:
"staticProperties": { "Consultingwerk.Framework.GuiClientStartupManager:TaskbarApplicationId": "de.consultingwerk.reference.mainmenuform", "Consultingwerk.OERA.DataAccess:LogFetchDataDetails": true, "Consultingwerk.OERA.ServiceInterface:LoggingLevelAsCharacter": "Request", "Consultingwerk.Framework.FrameworkSettings:ApplicationLabel": "Consultingwerk Reference Application", "Consultingwerk.Framework.FrameworkSettings:BaseRegistryKey": "Software\\Consultingwerk Ltd.\\Sample Applications\\", "Consultingwerk.Framework.FrameworkSettings:StoreWindowPosition": true, "Consultingwerk.Framework.FrameworkSettings:StoreRibbonQuickAccessToolbar": true, "Consultingwerk.Framework.FrameworkSettings:StoreUltraSplitterPosition": true, "Consultingwerk.SmartComponents.Implementation.SmartDataBrowser:SaveColumnSettings": true, "Consultingwerk.SmartComponents.Implementation.SmartToolbarControllerSettings:SmartToolbarControllerDefaultExit": true, "Consultingwerk.Framework.FrameworkSettings:DebugMode": true, "Consultingwerk.Framework.NotifyIconWaitStateManager:IdleIconFileName": "Consultingwerk/Framework/NotifyIcons/server_client.ico", "Consultingwerk.Framework.NotifyIconWaitStateManager:BusyIconFileName": "Consultingwerk/Framework/NotifyIcons/server_client_exchange.ico", "Consultingwerk.Framework.GuiClientStartupManager:StartupForm": "Consultingwerk.Windows.Framework.Reference.MainMenuForm", "Consultingwerk.Util.ClassHelper:UseExternalRuntimeForGetClassNames": true, "Consultingwerk.SmartComponents.Base.SmartWindowFormController:MapEnterKeyToTab": true }
SCL-2344 Support custom HTTP status code from RESTful method invocation
Description:
The RestEntitiesWebHandler now supports returning a custom HTTP status code, status reason and content-type from RESTful methods. RESTful methods can return now etiher a JSON Serializable, object, a JSON Fragment or an object implementing the IRestMethodResponse interface.INTERFACE Consultingwerk.OERA.RestResource.IRestMethodResponse:
/** * Purpose: Returns the HTTP ContentType of the response * Notes: Should default to application/json */ DEFINE PUBLIC PROPERTY ContentType AS CHARACTER NO-UNDO PUBLIC GET. /** * Purpose: Returns the Response Entity * Notes: */ DEFINE PUBLIC PROPERTY Entity AS Progress.Lang.Object NO-UNDO GET. SET. /** * Purpose: Returns the HTTP StatusCode as a StatusCodeEnum value * Notes: */ DEFINE PUBLIC PROPERTY StatusCode AS StatusCodeEnum NO-UNDO GET. /** * Purpose: Returns the HTTP StatusReason (e.g. OK) * Notes: Should default to StatusCodeHelper:GetMessage (StatusCode) */ DEFINE PUBLIC PROPERTY StatusReason AS CHARACTER NO-UNDO GET. END INTERFACE.
Through this Interface for the return value, RESTful methods do now support to return a custom HTTP status.
We are providing a default implementation of the IRestMethodResponse interface with the RestMethodResponse class.
Below a few samples of RESTful methods returning the RestMethodResponse:
1) This method is returning the HTTP status 204 (no content)
@RestMethod (address="/TestNoRespose", requestMethod="get", parameterClassName="Consultingwerk.CharacterHolder", response="return"). METHOD PUBLIC RestMethodResponse TestMethod (poInput AS CharacterHolder): RETURN NEW RestMethodResponse (StatusCodeEnum:NoContent) . END METHOD.
2) This method is returning a CharacterHolder with a HTTP Status Code of Accepted
@RestMethod (address="/TestWithRespose1", requestMethod="get", parameterClassName="Consultingwerk.CharacterHolder", response="return"). METHOD PUBLIC RestMethodResponse TestMethod2 (poInput AS CharacterHolder): RETURN NEW RestMethodResponse (NEW CharacterHolder (SUBSTITUTE ("Hello &1!", poInput:Value)), StatusCodeEnum:Accepted) . END METHOD.
3) This method is returning a JSON Object, with an Accepted status and a custom Reason "Angenommen"
@RestMethod (address="/TestWithRespose2", requestMethod="get", parameterClassName="Consultingwerk.CharacterHolder", response="return"). METHOD PUBLIC RestMethodResponse TestMethod3 (poInput AS CharacterHolder): DEFINE VARIABLE oJson AS JsonObject NO-UNDO . oJson = NEW JsonObject () . oJson:Add ("Hello", poInput:Value) . RETURN NEW RestMethodResponse (oJson, StatusCodeEnum:Accepted, "Angenommen") . END METHOD.