Release Notes 2018-06-26

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 #47271@2018-06-26

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: 

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:

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 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 Please download the .NET Assemblies ZIP file from our ESD and replace the in your environment with the latest one. The new assembly reference is:

<assembly name=", Version=, Culture=neutral, PublicKeyToken=cda1b098b1034b24"/>

As proparse is used by our Business Entity Generator, this new version of the 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

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

Overview of included tickets


SCL-2176 Resolved an issue with PASOE crashes when using the Swagger page for RESTful entities


We've resolved an issue caused by a combination of an invalid object reference passed to the VALIDATE-SEAL method of the client principal. The issue was causing PASOE to crash after a few invocations of the RestfulEntitiies Web Handler. We ware able to fix the invalid object reference issue in our code and Progress Software is working on the crashes caused by that.

SCL-2242 Annotation extraction fails for ObjectTypeBusinessEntity


This was caused by direct database access in the Business Entity. The annotation extraction works (as expected) without a DB connection. We've moved the code that requires the database connection to the Data Access class to resolve this issue.

SCL-2244 TEMP-TABLE ttServiceLoader:EMPTY-TEMP-TABLE() . in AppServerStartupManager not supported on 11.6


The EMPTY-TEMP-TABLE() method on a table handle is only valid from OpenEdge 11.7 on. In OpenEdge 11.6 this raises a warning. We've switched to the statis EMPTY TEMP-TABLE statement instead.

SCL-2245 Invalid Validation error when saving scheduler job plan


We've fixed an false validation error when saving Scheduler Job Plan records in the Scheduler Job Plan Maintenance Form. The false validation error was:
Invalid Planning Type. 
  Field: PlanningType 
  Table: eSmartSchedulerJobPlan


SCL-2213 Implemented support for https to the scl-pasoe scripts


The manager will first try to connect using HTTP if that fails HTTPS is used. Implemented nohostverify to connect to HTTPS appservers without a valid certificate. Made web request error handling more user friendly. Instead of displaying invalid url it now handles a number of errors. * If the command needs an application name, it verifies the application name. If the name is not found a list of available applications is shown. * If the command needs an agent PID the PID is verified. If the PID is not available a list of available agent PIDs is shown * If a wrong username or password is supplied the PasoeManager will return an error: Not authorized, check username and password * Corrected an error in console reporting, the wrong json object was used to check for children. This resulted in an invalid object error. When HTTPS is detected, the browser for the object tracking report will use HTTPS to show the report.  

SCL-2229 Improved handling of


UNIX: During initialization of the scripts there is a check if <DLC>/tty/netlib/ can be found, if this is not the case the script returns the following error:
"Cannot locate in '<DLC>/tty/netlib/' please check your OpenEdge installation" 
Windows: First it's checked if <DLC>/gui/netlib/ is available on the system. If that is not the case then it's checked if <DLC>/tty/netlib/ is available on the system.  When both are not available on the system the following error is returned:
"Cannot locate in ''<DLC>/gui/netlib/' or ''<DLC>/tty/netlib/' please check your OpenEdge installation"
If either one is found on the system, this library will be used by the scl-pasoe scripts. As an extra the parameter -debug is added to the scripts which displays the complete PROPATH.

SCL-2231 Better human understandable error messages in scl-pasoe scripts


When a command is used which uses the -a parameter (application name) the available applications will be queried on the pasoe instance. When for instance there was a problem with the deployment of the instance and no applications are deployed the script returns the error :
"No applications deployed on pasoe instance"
When an application was supplied with -a but it's not found on the instance the following error is returned:
"Could not find application '<name>' in available applications: (With a list of available applications)" 
When the user name and password are not correct the following error message is returned:
"Not authorized, check user name and password"
When the oemanager.war is not deployed (like on a production system) the following error message is returned:
"Please check if oemanager.war is deployed" 
When a command is executed which uses the -agentpid parameter to identify a process the process ID is verified before executing the command.  If there are no agents available the script will return error:
"Could not find any agent"
When the script could find agents but not the chosen one the script will return error:
"Could not find agent '<agentpid>' for application '<name>', available agents: (With a list of available agents)"
In all other error situations the http response status code and reason are displayed.    Please note that the scripts will first try to establish a connection using http, when that is not a success, the request is repeated using https. This is shown in the error message:
Error[1] (0): Trying http connection:
Error[2] (0): Connection failure for host localhost port 4812 transport TCP. (9407)
Error[3] (0): http://localhost:4812/oemanager/applications
Error[4] (0): Http failed, trying https connection:
Error[5] (0): https://localhost:4812/oemanager/applications
Error[6] (9318): Secure Socket Layer (SSL) failure. error code 0: Unknown SSL error (9318)
Error[7] (9407): Connection failure for host localhost port 4812 transport TCP. (9407)

SCL-2238 DatasetModel now honors sort on all tables also when UseDatasetQueries() is used


The following code retrieves records with the correct sort from the database (backend) and now does also sort the local query as expected
oOrder = NEW OrderDatasetModel () .
oOrder:Order:Filter:CustNum:Eq (1) .
oOrder:Order:FillChildTables = "eOrderLine":U .
oOrder:Order:Fill () .

SCL-2239 Added a method to return the last day of a month to the DateType class


 * Purpose: Returns the day number of the last day of the month relatively to the given date
 * Notes:   When no date is passed in, the current month will be used
 * @param pdtDate The base date
 * @return The datenumber of the first day of the year

SCL-2240 Dictionary and GenericDictionary now provide a method to return the Key of a given value


Added a method GetKey to the Dictionary and GenericDictionary class. The method returns the Key of an object in the Dictionary
METHOD PUBLIC CHARACTER GetKey (poItem AS Progress.Lang.Object).
Method should throw an error when an invalid value (not in the dictionary) is passed.

SCL-2243 Added method LogManager:GetCustomLoggingLevel


We've added a method GetCustomLoggingLevel to the LogManager class. This method returns the current logging logging level of a custom log entry type.

SCL-2249 Simplified activating disabling of DATA-RELATIONS in a DataAccess


In situations where a single Business Entity child table has more than one parent table we have now implemented API's i the DataAccess base class and the DatasetHelper that simplify the activation of a specific parent relation. Activating a specific parent-relation of a buffer will automatically deactivate the other parent relations. The ActivateDetailsRelations() method does activate those relations that are activated based on the Business Entity Design. A sample use of this in a DataAccess class would be:
    METHOD PUBLIC OVERRIDE VOID FetchData (poFetchDataRequest AS IFetchDataRequest):

        IF poFetchDataRequest:Tables = "eCustomer,eInvoice" THEN
            THIS-OBJECT:ActivateRelations("eCustomereInvoiceRelation") .

        SUPER:FetchData(poFetchDataRequest) .

            THIS-OBJECT:ActivateDefaultRelations() .
        END FINALLY.


SCL-2252 DatasetModel/TableModel does now provide strong typed variants for FillChildTables


Instead of relying on a Character list in the FillChildTables property, the same behavior in a DatasetModel's TableModel can now be achieved by setting logical properties in the form of Fill<TableName>, e.g.
oOrder = NEW OrderDatasetModel () .
oOrder:OrderLine:FillItem = TRUE.
oOrder:OrderLine:Fill () . 
oOrder = NEW OrderDatasetModel () .
oOrder:OrderLine:SetFillOrder(TRUE):SetFillItem(TRUE):Fill () . 
oOrder = NEW OrderDatasetModel () .
oOrder:OrderLine:FillAllChildTables () .
Customers that want to leverage this new feature need to re-generate the DatasetModel's using the Regenerate option in the Business Entity Designer.

SCL-2253 Added Debug Logging for the invocation of VALIDATE-SEAL in the RestServerSessionActivator


To support debugging issue SCL-2176 we've implemented detailed logging output around the invocation of the VALIDATE-SEAL method. This logging can be enabeld by either activating the _VALIDATE-SEAL:2_ or _VALIDATE-SEAL:4_ custom log entry.

New Feature

SCL-2226 Added support for a Class Name Prefix in SmartUnit


SmartUnit has been enhanced with support for a Class Name Prefix in the JUnit output file. This can be useful if unit tests from multiple environments (e.g. Windows or Unix) should be consolidated in a single Jenkins console. The SmartUnit static class and the SmartUnit ANT makro have been extended with the classNamePrefix argument (or property). The value of this property will be used as the prefix to all class names reported in the JUnit XML output file. Customers that want to make use of this feature should update their customized SmartUnit makros.
<!-- 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"/>                                                              
    <attribute name="classNamePrefix" default=""/>                                                               
    <element name="options" optional="true" />                                                                   
    <PCTRun procedure="Consultingwerk/SmartUnit/runtest.p"          
        graphicalMode="true" dlcHome="${progress.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" />                                         
        <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="ClassNamePrefix" value="@{classNamePrefix}"/>