Release Notes 2018-04-29

Version Information

OpenEdge ReleaseVersion Information
11.3.3, 11.3.4, 11.4, 11.6.2, 11.6.3, 11.7, 11.7.1, 11.7.2

Release 11.3 #46178@2018-04-30

OpenEdge 11.7 Service Pack 2

We are announcing full compatibility with the Service Pack 2 for OpenEdge 11.7 (OpenEdge 11.7.2).

See further remarks below.

Deletion of SmartDataAdapters and BindingSources

In SCL-2019 we have changed the clean-up behavior of the SmartDataBrowser control when a Form is closed. After this change, the SmartDataBrowser will delete it's linked SmartDataSource (e.g. SmartBusinessEntityAdpater) instance and DataSource (binding source). In rare cases, where those instances may still be required after the form containing the browser have been closed, developers can set the following new property of the SmartDataBrowser to FALSE:

    /**
     * Purpose: Controls if the SmartDataBrowser deletes it's SmartDataSource and DataSource
     *          when the Form is closed
     * Notes:
     */
    DEFINE PUBLIC PROPERTY DeleteDataSourceOnFormClosed AS LOGICAL NO-UNDO INITIAL TRUE
    GET.
    SET.

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.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:

<assembly name="proparse.net, Version=4.0.1.1176, 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 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
    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/Form/{EntityName}/{ViewName}
    handler17=Consultingwerk.Web2.Services.SmartViewsHandler.SmartFormWebHandler: /SmartForm/Form/{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}

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

SCL-1999 Make Data Access query logging in QryInfo logentry type configurable

Description:


We have implemented the ability to configure the BASIC-LOGGING attribute for the data access queries used in [DataAccess|http://help.consultingwerkcloud.com/smartcomponent_library/release/Consultingwerk.OERA.DataAccess.html] derived classes. The BASIC-LOGGING attribute of a query object handle controls if the query produces logging output in the client/appserver logfile when the QryInfo:2 log entry type is set. Logging output will be generated like this:

2018-04-29 19:27:48:0466	+ 1558	[18/04/29@19:27:48.451+0200] P-017132 T-007472 2 AS-4 QRYINFO        Query Info Logging turned on for query  handle 5137 QueryId 1500798904480
2018-04-29 19:27:48:0963	+ 1559	[18/04/29@19:27:48.453+0200] P-017132 T-007472 2 AS-4 QRYINFO        Query Plan:  InsertToQuery Consultingwerk.OERA.Query.QueryString line 702
2018-04-29 19:27:48:0963	+ 1560	[18/04/29@19:27:48.453+0200] P-017132 T-007472 2 AS-4 QRYINFO        QueryId: 1500798904480
2018-04-29 19:27:48:0963	+ 1561	[18/04/29@19:27:48.453+0200] P-017132 T-007472 2 AS-4 QRYINFO        Query Handle: 5137
2018-04-29 19:27:48:0963	+ 1562	[18/04/29@19:27:48.453+0200] P-017132 T-007472 2 AS-4 QRYINFO        Type: Dynamically Opened Query
2018-04-29 19:27:48:0963	+ 1563	[18/04/29@19:27:48.453+0200] P-017132 T-007472 2 AS-4 QRYINFO        PREPARE-STRING: FOR EACH Customer WHERE Customer.CustNum = "1" INDEXED-REPOSITION
2018-04-29 19:27:48:0963	+ 1564	[18/04/29@19:27:48.453+0200] P-017132 T-007472 2 AS-4 QRYINFO        Prepared at Runtime
2018-04-29 19:27:48:0963	+ 1565	[18/04/29@19:27:48.453+0200] P-017132 T-007472 2 AS-4 QRYINFO        Client Sort: N
2018-04-29 19:27:48:0963	+ 1566	[18/04/29@19:27:48.453+0200] P-017132 T-007472 2 AS-4 QRYINFO        Scrolling: Y
2018-04-29 19:27:48:0963	+ 1567	[18/04/29@19:27:48.453+0200] P-017132 T-007472 2 AS-4 QRYINFO        INDEXED-REPOSITION specified
2018-04-29 19:27:48:0963	+ 1568	[18/04/29@19:27:48.453+0200] P-017132 T-007472 2 AS-4 QRYINFO        Table: sports2000.Customer
2018-04-29 19:27:48:0963	+ 1569	[18/04/29@19:27:48.453+0200] P-017132 T-007472 2 AS-4 QRYINFO          Indexes: CustNum
2018-04-29 19:27:48:0963	+ 1573	[18/04/29@19:27:48.457+0200] P-017132 T-007472 2 AS-4 QRYINFO        Query Statistics:  DatasetFill Consultingwerk.OERA.DataAccess line -1
2018-04-29 19:27:48:0963	+ 1574	[18/04/29@19:27:48.457+0200] P-017132 T-007472 2 AS-4 QRYINFO        QueryId: 1500798904480
2018-04-29 19:27:48:0963	+ 1575	[18/04/29@19:27:48.457+0200] P-017132 T-007472 2 AS-4 QRYINFO        Query Handle: 5137
2018-04-29 19:27:48:0963	+ 1576	[18/04/29@19:27:48.457+0200] P-017132 T-007472 2 AS-4 QRYINFO        Times prepared: 1
2018-04-29 19:27:48:0963	+ 1577	[18/04/29@19:27:48.458+0200] P-017132 T-007472 2 AS-4 QRYINFO        Time to prepare (ms): 0
2018-04-29 19:27:48:0963	+ 1578	[18/04/29@19:27:48.458+0200] P-017132 T-007472 2 AS-4 QRYINFO        DB Blocks accessed to prepare:
2018-04-29 19:27:48:0963	+ 1579	[18/04/29@19:27:48.458+0200] P-017132 T-007472 2 AS-4 QRYINFO         sports2000 : 2
2018-04-29 19:27:48:0963	+ 1580	[18/04/29@19:27:48.458+0200] P-017132 T-007472 2 AS-4 QRYINFO        Times opened: 1
2018-04-29 19:27:48:0963	+ 1581	[18/04/29@19:27:48.458+0200] P-017132 T-007472 2 AS-4 QRYINFO        Used REPOSITION: N
2018-04-29 19:27:48:0963	+ 1582	[18/04/29@19:27:48.458+0200] P-017132 T-007472 2 AS-4 QRYINFO        DB Blocks accessed:
2018-04-29 19:27:48:0963	+ 1583	[18/04/29@19:27:48.458+0200] P-017132 T-007472 2 AS-4 QRYINFO         sports2000 : 24
2018-04-29 19:27:48:0963	+ 1584	[18/04/29@19:27:48.458+0200] P-017132 T-007472 2 AS-4 QRYINFO        DB Reads:
2018-04-29 19:27:48:0963	+ 1585	[18/04/29@19:27:48.458+0200] P-017132 T-007472 2 AS-4 QRYINFO         Table: sports2000.Customer : 0
2018-04-29 19:27:48:0963	+ 1586	[18/04/29@19:27:48.458+0200] P-017132 T-007472 2 AS-4 QRYINFO         Index: Customer.CustNum : UNAVAILABLE
2018-04-29 19:27:48:0963	+ 1587	[18/04/29@19:27:48.458+0200] P-017132 T-007472 2 AS-4 QRYINFO        sports2000.Customer Table:
2018-04-29 19:27:48:0963	+ 1588	[18/04/29@19:27:48.458+0200] P-017132 T-007472 2 AS-4 QRYINFO         4GL Records: 1
2018-04-29 19:27:48:0963	+ 1589	[18/04/29@19:27:48.458+0200] P-017132 T-007472 2 AS-4 QRYINFO         Records from server: 1
2018-04-29 19:27:48:0963	+ 1590	[18/04/29@19:27:48.458+0200] P-017132 T-007472 2 AS-4 QRYINFO          Useful: 1
2018-04-29 19:27:48:0963	+ 1591	[18/04/29@19:27:48.458+0200] P-017132 T-007472 2 AS-4 QRYINFO          Failed: 0
2018-04-29 19:27:48:0963	+ 1592	[18/04/29@19:27:48.458+0200] P-017132 T-007472 2 AS-4 QRYINFO         Select By Client: N

To enable the BASIC-LOGGING for an individual DATA-SOURCE query, the following configuration in the .applicationsettings or .restapplicationsettings can be made. The configuration is retrieved using the [IConfigurationProvider|http://help.consultingwerkcloud.com/smartcomponent_library/release/Consultingwerk.Framework.IConfigurationProvider.html] service.

"DataAccessLogging": {
    "Consultingwerk.SmartComponentsDemo.OERA.Sports2000.CustomerDataAccess""eCustomer",
    "Consultingwerk.SmartComponentsDemo.OERA.Sports2000.OrderDataAccess""eOrderLine,eCustomer"
}

The first entry in the DataAccessLogging property is the name of a Data Access class, the second is the name of a temp-table buffer for which the logging should be turned on. Both the Data Access class name and the temp-table buffer name can be specified with the * as a wildcard character.

SCL-2175 Mock'ed DataAccess classes causing issues with SmartRelationService

Description:


We have resolved an issue in the [SmartDataAccess |http://help.consultingwerkcloud.com/smartcomponent_library/release/Consultingwerk.SmartFramework.SmartDataAccess.html] class (base class for Data Access objects leveraging SmartFramework features such as the referential integrity). The issue was caused by validation in the [SmartRelationService|http://help.consultingwerkcloud.com/smartcomponent_library/release/Consultingwerk.SmartFramework.System.SmartRelationService.html] causing all attempts to save back to temp-tables (data-source buffers of the mocked data access) to fail. This makes partial sense as the SmartRelationService is designed to manage referential integrity between database tables only. We've resolved this issue in the SmartDataAccess class by verifying if the data-source buffer is for a database or a temp-table and not calling into the SmartRelationService in case of a temp-table based data-source.