Release Notes 2020-07-20

Created by ConsultingwerkREST (Unlicensed)
Last updated: Jul 27, 2020 by Mike Fechner

Version Information

OpenEdge Release

Version Information

11.7.4, 11.7.5, 11.7.6, 12.1, 12.2

Release 11.7 #60160@2020-07-20

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.

OpenEdge 12.1 support!

We are pleased to announce that we are not aware of any issues using the SmartComponent Library on OpenEdge 12.1. We hereby declare OpenEdge 12.1 fully supported for the SmartComponent Library as of the release of September 21st 2019.

OpenEdge 11.7.6 support!

We are pleased to announce that we are not aware of any issues using the SmartComponent Library on OpenEdge 11.7.6. We hereby declare OpenEdge 11.7.6 fully supported for the SmartComponent Library as of the release of June 9th 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!

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 (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-3074 Fixed duplicate JSON output in OpenEdge 11.7.6 PASOE REST

Description:

We have resolved an issue that was causing all JSON and binary output returned by our PASOE web handlers to be returned twice to the caller. For JSON output this did inevitably result in invalid JSON syntax.
The issuse seems related to https://knowledgebase.progress.com/articles/Article/json-webhandler-returned-twice-in-11-7-6-when-using-webresponsewriter-s-write-methods - although we have been able to resolve this issue by removing a workaround for an issue with PASOE web handlers in OpenEdge 11.6.3.

SCL-3086 BusinessEntityGenerator's RaiseWriteFileEvent Method did not raise an event

Description:

We have resolved an issue in the BusinessEntityGenerator causing that the RaiseWriteFileEvent method did not raise an event.

Improvement

SCL-3066 Support SmartMessages based on HTML-templates

Description:

We have added a new field called MessageTemplate to the SmartMessage table. This field is used by the partner framework AKIOMA and allows support for free formatted error messages.
The field is also returned by the SmartMessage web handler / end point.

SCL-3073 Added two methods to the UltraToolbarsHelper

Description:

We have added two new methods to the UltraToolbarsHelper class
BuildRibbonToolsForButtons
BuildRibbonToolsForCombos
Those methods have been adopted from a customized version of the WinKit to support that customer using a standard release of the SmartComponent Library.

SCL-3075 SmartUnit now optionallys writes names of failed unit tests to stdout

Description:

The SmartUnit:WriteTestResult method now supports writing failed test results using the MESSAGE statement to the standard output (typically the OS or Jenkins console).
This simplifies inspecting the failed test results from the build output.
The new feature is triggered a true or false (default) value in the new logFailedTests parameter passed to the runtest.p procedure. 

<!-- SmartUnit Macro Definition -->    
<macrodef name="SmartUnit">
    <attribute name="testSuite" default=""/>
    <attribute name="baseDirectory" default=""/>
    <attribute name="tests" default=""/>
    <attribute name="output" default=""/>
    <attribute name="testrunner" default=""/>
    <attribute name="services" default=""/>
    <attribute name="haltOnError" default="false"/>
    <attribute name="forceXmlXref" default="false"/>  
    <attribute name="importClientLog" default="true"/>
    <attribute name="importStdOut" default="true"/>

    <element name="options" optional="true" />

    <sequential> 
        <PCTRun procedure="Consultingwerk/SmartUnit/runtest.p" 
            graphicalMode="true" dlcHome="${dlc}" cpinternal="iso8859-1" cpstream="iso8859-1"
            compileUnderscore="true" inputchars="200000" assemblies="../ABL/Assemblies"
            iniFile="../ABL/ini/progress.ini" token="10000" dirSize="500000" stackSize="500000" 
            maximumMemory="65534">

            <Profiler enabled="true" outputDir="profiler" coverage="true" />

            <options/>

            <Parameter name="TestSuite" value="@{testSuite}"/>
            <Parameter name="BaseDirectory" value="@{baseDirectory}"/>
            <Parameter name="Tests" value="@{tests}"/>
            <Parameter name="Output" value="@{output}"/>
            <Parameter name="TestRunner" value="@{testrunner}"/>
            <Parameter name="HaltOnError" value="@{haltOnError}"/>
            <Parameter name="ForceXmlXref" value="@{forceXmlXref}"/>
            <Parameter name="Services" value="@{services}"/>
            <Parameter name="logFailedTests" value="true"/>
        </PCTRun>        
    </sequential>
</macrodef>


SCL-3076 Removed SmartFramework/Lock and SmartFramework/Workflow from deployment packages without SmartFramework

Description:

We have removed the SmartFramework/Lock and SmartFramework/Workflow packages from those deployments that do not use the SmartFramework. Those packages are not supposed to be compiling in those deployments as the required SmartDB tables are excluded.

SCL-3080 scl-sng (Static Names Generator) now only changes file for non comment changes

Description:

The Static Names Generator utility ( https://consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094104/Static+Names+Generator ) has been improved so that it only writes modified files when those contain further changes than just the time stamp in the file header comment. This will typically lead to fewer versions of the static name classes simplifying versioning and branching.

New Feature

SCL-3036 Added database table for Workflow instances

Description:

To support default workflows with the status maintained in the SmartDB and not just on a status field in an application database table, we have added a new table to support this.

SCL-3068 Implemented copy routine for security allocations

Description:

We have added a new feature to the User Maintenane form. This feature allows to copy authorization settings from one user to another.

In the followingdialog, the user can select the source user to copy from and decide if the security assignment on the user and/or the group membership should be copied. Optionally existing data (security assignment and/or group membership based on the previous selection) will be removed.

SCL-3069 Allowing a user group to inherit from multiple user groups

Description:

We have implemented a new optional method for user group inheritance. This new feature allows a user group to inherit from more than a single user group. Previously a user group had a single fixed parent user group.
To support this feature a new database table SmartParentGroup has been introduced.
Enabling the feature
The new group inheritance feature needs to be enabled in products.i: 

&IF 1=0 &THEN
/* Mike Fechner, Consultingwerk Ltd. 05.08.2016
   SCL-3069: Allow a user group to inherit from multiple user groups
             To enable support for multiple group inheritance, set the following preprocessor
             to multiple. Reminder: When enabling this, don't forget to migrate existing
             Group inheritance from SmartGroup.ParentGroupGuid to records in the SmartParentGroup
             table. Supported values: single (default) and multiple */
&ENDIF
&GLOBAL-DEFINE SmartGroupInheritance multiple


Once this feature is enabled and the application has been recompiled, the Parent Group lookup in the Group Maintenance form will remain disabled. And the Parent Groups tab in that same form will be enabled.
It is mandatory, that for the session maintaining the group inheritance and the application session (PASOE backend) used to execute the application the same setting is used.
Data conversion
When the existing parent group's are still required after switching to multiple group inheritance, it's required to migrate the parent group information from the SmartGroup database table to the SmartParentGroup table.
The following program can be used for this: 

/*------------------------------------------------------------------------
    File        : convert-parent-groups.p
    Purpose     : Converts parent groups from SmartGroup to SmartParentGroup
  ----------------------------------------------------------------------*/

/* ***************************  Definitions  ************************** */

BLOCK-LEVEL ON ERROR UNDO, THROW.

{Consultingwerk/products.i}

/* ***************************  Main Block  *************************** */

&IF "{&SmartGroupInheritance}" NE "multiple" &THEN
MESSAGE "This routine should only be executed when using the" SKIP
        "multiple group inheritance feature (SCL-3069)!"
    VIEW-AS ALERT-BOX ERROR .
RETURN .
&ENDIF

DO TRANSACTION:
    FOR EACH SmartGroup WHERE SmartGroup.ParentGroupGuid > "":U
        EXCLUSIVE-LOCK:

        IF NOT CAN-FIND (SmartParentGroup WHERE SmartParentGroup.GroupGuid          = SmartGroup.GroupGuid
                                            AND SmartParentGroup.ParentingGroupGuid = SmartGroup.ParentGroupGuid) THEN DO:

            DISPLAY SmartGroup.GroupName WITH DOWN .

            CREATE SmartParentGroup .
            ASSIGN SmartParentGroup.GroupGuid          = SmartGroup.GroupGuid
                   SmartParentGroup.ParentingGroupGuid = SmartGroup.ParentGroupGuid .
        END.

        ASSIGN SmartGroup.ParentGroupGuid = "":U .
    END.

    /* Uncommend for test run
    MESSAGE "Undo"
        VIEW-AS ALERT-BOX.
    UNDO .
    */
END.

Attachment: convert-parent-groups.p

SCL-3071 Added new DataTypeHelper:IsDigit() method

Description:

We have added a new method IsDigit() to the DataTypeHelper. This method returns true, when the passed in string is a single character representing a digit.