Release Notes 2018-07-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

Release 11.3 #47364@2018-07-02

OpenEdge 11.7.3 Product alert!

We've encountered a severe regression with the Progress Developer Studio Visual Designer in OpenEdge Release 11.7.3 (Service Pack 3 of OpenEdge 11.7). We won't announce formal compatibility of the SmartComponent Library with OpenEdge 11.7.3 for this reason. We'll inform once Progress Software has resolved this issue. 

Besides the issue with the Visual Designer however, we are not aware of any incompatibilities with OpenEdge 11.7.3. 

This article provides further details: Visual Designer related OpenEdge 11.7.3 product alert!!!

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!

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.

Your action may be required!

Changes to the SmartDB and SmartDB upgrade and migration utility

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/{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}

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-2259 Business Entity Designer Edit Source Editor "Data Access Validation Method" button was falsely Disabled under certain circumstances

Description:

When a Business Entity is generated without generating the DatasetController, the Business Entity Source Code Editor did not offer the "Data Access Validation Method" option. We have resolved this issue in this release.

SCL-2260 Fixed an issue in the MenuBusinessEntity that caused a runtime error after saving changes a second time in a session.

Description:

The error message caused in the Data Access classes observed was:

The parameter value 'eSmartMenu' for pcKey in Consultingwerk.Framework.Collections.CharacterDictionary is invalid.

The issue was caused by recent changes to the following Business Entities: * Consultingwerk.SmartFramework.Menu.MenuBusinessEntity * Consultingwerk.SmartFramework.Repository.Customization/CustomizationBusinessEntity * Consultingwerk.SmartFramework.System.SmartBusinessEntityBusinessEntity

Improvement

SCL-2197 Implemented reordering of temp-tables in the Business Entity Designer

Description:

The Business Entity Designer does not allow the reordering of the temp-tables in the generators DEFINE DATASET statement. The order can be changed using a setting in the Field Properties Viewer.

SCL-2217 Implemented repository support for the "step" property in SmartViewer JSON Layout for numeric fields.

Description:

MetaDataField instances in MetaViewer objects will now set the "step" property for numeric fields. For decimal fields, this property is based on the ABL FORMAT of the fields. See https://github.com/consultingwerk/SmartComponentsNG2/issues/237

SCL-2254 Implemented ability to change the product module from a Object Master in the Repository

Description:

It is now possible to change the product module of an existing Object Master in the Repository. As we are not able to move existing .smartrepo files - as this is dependent to the customer's setup, we have implemented an event in the ISmartRepository which is raised (on the application backend), when an Object Master was moved to another product module:

    /**
     * Purpose: Event raised when the Product Module of an Object Master is changed
     * Notes:
     * @param sender The reference to the object that raised the event
     * @param e The ObjectMasterProductModuleChangedEventArgs with the data for this event
     */
    DEFINE PUBLIC EVENT ObjectMasterProductModuleChanged SIGNATURE VOID (sender AS Progress.Lang.Object,  
                                                                         e AS ObjectMasterProductModuleChangedEventArgs).


SCL-2255 Implemented additional JsonHelper methods

Description:

Added the following methods to the JsonHelper:

    /**
     * Purpose: Builds a Character list of the property values in all objects of the array
     * Notes:
     * @param poJsonArray The JsonArray
     * @param pcPropertyName The name of the property to build a list of
     * @return The comma delimited list of property values
     */
    METHOD PUBLIC STATIC CHARACTER AttributeValueList (poJsonArray AS JsonArray,
                                                       pcPropertyName AS CHARACTER)

    /**
     * Purpose: Builds a Character list of the property values in all objects of the array
     * Notes:
     * @param poJsonArray The JsonArray
     * @param pcPropertyName The name of the property to build a list of
     * @param pcDelimiter The list delimiter
     * @return The delimited list of property values
     */
    METHOD PUBLIC STATIC CHARACTER AttributeValueList (poJsonArray AS JsonArray,
                                                       pcPropertyName AS CHARACTER,
                                                       pcDelimiter AS CHARACTER)

    /**
     * Purpose: Copies the given JSON Properties from the source JSON to
     *          the targegt JSON
     * Notes:
     * @param poSourceObject The source JSON object
     * @param poTargetObject The target JSON object
     * @param pcPropertyNames The names of the properties to copy
     */
    METHOD PUBLIC STATIC VOID CopyProperties (poSourceObject AS JsonObject,
                                              poTargetObject AS JsonObject,
                                              pcPropertyNames AS CHARACTER)

    /**
     * Purpose: Locates the JsonObject from a JsonArray with the requested
     *          integer value in a JsonArray property
     * Notes:
     * @param poJsonArray The JsonArray
     * @param pcPropertyName The name of the property
     * @param piPropertyValue The value of the property
     * @return The JsonObject or ? when the property value cannot be found
     */
    METHOD PUBLIC STATIC JsonObject FindJsonObjectWithArrayValue (poJsonArray AS JsonArray,
                                                                  pcPropertyName AS CHARACTER,
                                                                  piPropertyValue AS INTEGER)

    /**
     * Purpose: Locates the JsonObject from a JsonArray with the requested
     *          integer property value
     * Notes:
     * @param poJsonArray The JsonArray
     * @param pcPropertyName The name of the property
     * @param piPropertyValue The value of the property
     * @return The JsonObject or ? when the property value cannot be found
     */
    METHOD PUBLIC STATIC JsonObject FindJsonObjectWithPropertyValue (poJsonArray AS JsonArray,
                                                                     pcPropertyName AS CHARACTER,
                                                                     piPropertyValue AS INTEGER)

    /**
     * Purpose: Returns the Character Value specified by the given path
     * Notes:   Based on GetJsonObjectByPath, the last part of the path specifies
     *          the property name
     * @param poSourceJsonObject The source Json object that contains the target Json object
     * @param pcPath The path specifying the target object
     * @return The character value of ? when the path is not valid
     */
    METHOD PUBLIC STATIC CHARACTER GetCharacterByPath (poSourceJsonObject AS JsonObject,
                                                       pcPath AS CHARACTER)

    /**
     * Purpose: Returns the Character Value specified by the given path
     * Notes:   Based on GetJsonObjectByPath, the last part of the path specifies
     *          the property name
     * @param poSourceJsonObject The source Json object that contains the target Json object
     * @param pcPath The path specifying the target object
     * @param poArrayBase The array base (one or zero)
     * @return The character value of ? when the path is not valid
     */
    METHOD PUBLIC STATIC CHARACTER GetCharacterByPath (poSourceJsonObject AS JsonObject,
                                                       pcPath AS CHARACTER,
                                                       poArrayBase AS ArrayBaseEnum)

    /**
     * Purpose: Returns the Integer Value specified by the given path
     * Notes:   Based on GetJsonObjectByPath, the last part of the path specifies
     *          the property name
     * @param poSourceJsonObject The source Json object that contains the target Json object
     * @param pcPath The path specifying the target object
     * @return The character value of ? when the path is not valid
     */
    METHOD PUBLIC STATIC INTEGER GetIntegerByPath (poSourceJsonObject AS JsonObject,
                                                   pcPath AS CHARACTER)

    /**
     * Purpose: Returns the Integer Value specified by the given path
     * Notes:   Based on GetJsonObjectByPath, the last part of the path specifies
     *          the property name
     * @param poSourceJsonObject The source Json object that contains the target Json object
     * @param pcPath The path specifying the target object
     * @param poArrayBase The array base (one or zero)
     * @return The character value of ? when the path is not valid
     */
    METHOD PUBLIC STATIC INTEGER GetIntegerByPath (poSourceJsonObject AS JsonObject,
                                                   pcPath AS CHARACTER,
                                                   poArrayBase AS ArrayBaseEnum)

    /**
     * Purpose: Returns the Logical Value specified by the given path
     * Notes:   Based on GetJsonObjectByPath, the last part of the path specifies
     *          the property name
     * @param poSourceJsonObject The source Json object that contains the target Json object
     * @param pcPath The path specifying the target object
     * @return The character value of ? when the path is not valid
     */
    METHOD PUBLIC STATIC LOGICAL GetLogicalByPath (poSourceJsonObject AS JsonObject,
                                                   pcPath AS CHARACTER)

    /**
     * Purpose: Returns the Logical Value specified by the given path
     * Notes:   Based on GetJsonObjectByPath, the last part of the path specifies
     *          the property name
     * @param poSourceJsonObject The source Json object that contains the target Json object
     * @param pcPath The path specifying the target object
     * @param poArrayBase The array base (one or zero)
     * @return The character value of ? when the path is not valid
     */
    METHOD PUBLIC STATIC LOGICAL GetLogicalByPath (poSourceJsonObject AS JsonObject,
                                                   pcPath AS CHARACTER,
                                                   poArrayBase AS ArrayBaseEnum)

    /**
     * Purpose: Returns the values (string, number, boolean, null) of the given JsonArray
     *          as a delimited list
     * Notes:
     * @param poJsonArray The JsonArray to process
     * @return The delimited list of values
     */
    METHOD PUBLIC STATIC CHARACTER ToDelimitedList (poJsonArray AS JsonArray):

        RETURN JsonHelper:ToDelimitedList (poJsonArray, ",":U) 

    /**
     * Purpose: Returns the values (string, number, boolean, null) of the given JsonArray
     *          as a delimited list
     * Notes:
     * @param poJsonArray The JsonArray to process
     * @param pcDelimiter The list delimiter
     * @return The delimited list of values
     */
    METHOD PUBLIC STATIC CHARACTER ToDelimitedList (poJsonArray AS JsonArray,
                                                    pcDelimiter AS CHARACTER)


SCL-2256 New method in the StringHelper

Description:

We've added a new method in the StringHelper class which returns the position of the first capital letter in a given character value.

    /**
     * Purpose: Returns the position of the first capital letter in the given string
     * Notes:
     * @param pcString The string to parse
     * @return The position of the first capital letter or 0 when there is no capital letter
     */
    METHOD PUBLIC STATIC INTEGER FirstCapitalLetter (pcString AS CHARACTER):


SCL-2257 TempTableShape did render "?X" after field, when FieldValidationInstance was not set and Custom properties exist for a field

Description:

We've resolved the issue with the rendering of the field names on the design canvas of the Business Entity Designer.

SCL-2262 ServerSessionActivator no longer switches to user "nobody" when the current USERID is already "nobody"

Description:

The ServerSessionActivator class sets the current user ID to "nobody" at the end of every AppServer request. As this causes a message to be written to the database logfile, we're not checking if the current user ID is still "nobody" and will not set the user ID again to "nobody" to avoid extra messages in the database logfile.