News combit Dev Blog

New OpenEdge Data Provider for List & Label 21

Posted: Wednesday, March 2, 2016 | 0 comment(s)
 
This time we feature a guest post from our partner and developer colleague Thomas Wurl. About two years ago, Thomas developed a free data provider for Progress OpenEdge available for all List & Label customers. While this provider was adopted successfully by many Progress users, it suffered some restrictions. So Thomas decided to restart from scratch and came up with an incredibly fast and powerful new solution. Here's his story. 

In 2014 I came up with the first version of the List & Label Data Provider for OpenEdge. This data provider was a hybrid of C# and ABL code and due to its ABL part only runnable within ABL sessions. Technically this solution was ok, but too slow because of the required .NET – ABL bridge calls for each record and each column value.  And the bad thing is – there is nothing you can do about it!
So the idea was born to write another one in pure C#, communication with OpenEdge via JSON, AppServer aware, service-oriented almost generic backend, tools to generate schemas for the services and – first of all - fast!
A hard decision!  I had to start from scratch, learn JSON and dive quite deep into C#. Another challenge was the OpenEdge generic backend stuff. But here it is!
 

Openedge data provider for reporting tool version 21
 

 
The data provider acts as a data source for List & Label. The first thing the provider does is to ask the service for its schema. Based on the schema the provider creates instances for the classes “Table”, “Table Row”, “Table Column” and “Table Relation”. This is the first thing List & Label asks for when you call methods like Design() or Print().
The result is a full blown schema in the designer with access to all tables, all child tables and all foreign keys:
 

Openedge data provider for reporting tool version 21
 
The provider supports advanced sorting and advanced filtering including multi-value filters. You can add foreign keys of a table row in any depth and even multiple instances of the same foreign key table but different children. Foreign keys are retrieved together with the table in a single service hit. The service sends only columns being used in the layout and columns building the used relations. Sorting is also done by the service.

Using the provider is quite easy. You need to define your services. If you want generic access to your entire database, create a service class similar to the Sports2000 demo service.  All you have to do is to register all of your database tables and to define relations. The music plays in the generic OpenEdge Service  class you inherit from.

/*------------------------------------------------------------------------
    File        : Sports2000Service
   ----------------------------------------------------------------------*/
USING Progress.Lang.*.
USING ListLabel.OpenEdgeAdapter.OpenEdgeService.
USING ListLabel.OpenEdgeAdapter.OpenEdgeSchema FROM PROPATH.

BLOCK-LEVEL ON ERROR UNDO, THROW.

CLASS ListLabelDemo.Sports2000Service INHERITS OpenEdgeService: 

       CONSTRUCTOR PUBLIC Sports2000Service (  ):
             SUPER ().
       END CONSTRUCTOR.

       METHOD OVERRIDE PUBLIC VOID registerSchema(  ):
        ServiceSchema:DatabaseName = "sports2000".
        FOR EACH sports2000._file WHERE _file._hidden = FALSE NO-LOCK:
              ServiceSchema:registerFile(_file._file-name).
        END.
        
        {ListLabelDemo/sports2000_relations.i}

        /* Optional Views for large schemas */
        ServiceSchema:registerView("OrderView","Order,OrderLine",2).
        
        RETURN.
       END METHOD.

END CLASS.

Relations are registered similar to files in the include file. An included relation generator tool helps you to get this done – at least a first shot.


/* Customer */
ServiceSchema:registerFileRelation("Customer","BillTo","CustNum,CustNum","Customer_BillTo"). /* Indexes: Customer.Customer <->> BillTo.custnumbillto */
ServiceSchema:registerFileRelation("Customer","Invoice","CustNum,CustNum","Customer_Invoice"). /* Indexes: Customer.Customer <->> Invoice.CustNum */
ServiceSchema:registerFileRelation("Customer","Order","CustNum,CustNum","Customer_Order"). /* Indexes: Customer.Customer <->> Order.CustOrder */
ServiceSchema:registerFileRelation("Customer","RefCall","CustNum,CustNum","Customer_RefCall"). /* Indexes: Customer.Customer <->> RefCall.CustNum */
ServiceSchema:registerFileRelation("Customer","ShipTo","CustNum,CustNum","Customer_ShipTo"). /* Indexes: Customer.Customer <->> ShipTo.custnumshipto */


Service is done. Ready to rumble!

USING TasteITConsulting.ListLabel21.OpenEdgeDataProvider FROM ASSEMBLY.
USING combit.ListLabel21.ListLabel FROM ASSEMBLY.
USING ListLabelDemo.Sports2000ServiceAdapter FROM PROPATH.

DEFINE VARIABLE oProvider       AS OpenEdgeDataProvider     NO-UNDO.
DEFINE VARIABLE oLL             AS ListLabel                NO-UNDO.
DEFINE VARIABLE oServiceAdapter AS Sports2000ServiceAdapter NO-UNDO.

oProvider = NEW OpenEdgeDataProvider().
oServiceAdapter = NEW Sports2000ServiceAdapter().
oLL = NEW ListLabel().

/* Get the schema */
oProvider:ServiceAdapter = oServiceAdapter.
oProvider:ServiceName    = "ListLabelDemo.Sports2000Service".
oProvider:ViewName       = "OrderView".
oProvider:Initialize().

/* Attach the data provider */
oLL:DataSource        = oProvider.
oLL:ForceSingleThread = TRUE. /* :-( */

/* Limit rows for designer preview. */
oProvider:MaxRows = 50.

/* Action! */
oLL:Design().
oLL:Dispose().

If you want to give it a try then download. Before trying to build your own service please read the documentation here and then play around with the demo application. You can find both, download and documentation, here.

 

Openedge data provider for reporting tool version 21
 

Everything has been built with List & Label 21, Open Edge 11.6 64 bit and Visual Studio Community 2015. .NET Framework 4 is required.

If you don’t have the above yet, please use the following links for download:

•    https://www.combit.net/en/download-trial/ 
•    https://www.progress.com/openedge/classroom-edition

If you're working with really huge databases, you might also want to check out the latest performance optimizations for the Designer.




Author: Thomas Wurl
CEO and Head of Development of Taste IT Consulting

Thomas Wurl, the CEO and Head of Development of Taste IT Consulting, is a Progress specialist and has a profound history with its projects. For 8 years, he worked as a consultant for Progress Software GmbH in Cologne and for the Progress Software Corporation at its American headquarters. As Progress Certified Solution Designer who has 25 years of experience with Progress, Thomas realizes projects on all orders of magnitude for a wide variety of industry sectors.



RSS
combit Development BlogRSS
What’s this blog for?
A place to share updates about the ongoing development of our products. General musings on the software industry included.
Archive
April 2021 (1)
March 2021 (1)
February 2021 (2)
January 2021 (1)
December 2020 (2)
November 2020 (1)
October 2020 (2)
September 2020 (1)
August 2020 (2)
July 2020 (1)
June 2020 (1)
May 2020 (2)
April 2020 (2)
March 2020 (2)
February 2020 (1)
January 2020 (1)
December 2019 (1)
November 2019 (2)
October 2019 (2)
September 2019 (2)
August 2019 (2)
July 2019 (2)
June 2019 (2)
May 2019 (1)
April 2019 (0)
April 2019 (1)
March 2019 (1)
February 2019 (1)
January 2019 (1)
December 2018 (1)
November 2018 (2)
October 2018 (4)
September 2018 (4)
August 2018 (2)
July 2018 (2)
June 2018 (2)
May 2018 (1)
April 2018 (1)
March 2018 (1)
February 2018 (2)
January 2018 (1)
December 2017 (1)
November 2017 (2)
October 2017 (3)
September 2017 (3)
August 2017 (2)
July 2017 (2)
June 2017 (1)
May 2017 (2)
April 2017 (1)
March 2017 (1)
February 2017 (1)
January 2017 (2)
December 2016 (1)
November 2016 (1)
October 2016 (4)
September 2016 (5)
August 2016 (2)
July 2016 (2)
June 2016 (3)
May 2016 (2)
April 2016 (3)
March 2016 (3)
February 2016 (1)
January 2016 (2)
December 2015 (2)
November 2015 (1)
October 2015 (4)
September 2015 (5)
August 2015 (2)
July 2015 (2)
June 2015 (2)
May 2015 (1)
April 2015 (2)
March 2015 (1)
February 2015 (1)
January 2015 (1)
December 2014 (2)
November 2014 (1)
October 2014 (1)
September 2014 (2)
August 2014 (1)
July 2014 (2)
June 2014 (1)
May 2014 (2)
April 2014 (1)
March 2014 (2)
+1 800 256 3608 (toll-free North America only)