Ir al contenido principal

Optimizing Sage Enterprise Management (X3) Code. Comparison between FOR and READ instructions

authorIcon By Sandra Moralejo


We are currently creating a new Rebate module for a client. This module calculates the best net rebate cost for each line entered during the sales flow cycle from Quotes to Invoices. Since this is a very resource intensive process we decided to compare our techniques to access the Sage Enterprise Management (X3) database tables and views to choose the most optimal ones.




We started by comparing two of the most used 4GL instructions - FORinstruction and READ instruction. I was using FOR when needed to loop through data extracted from the database and READ when needed to retrieve one specific value. After our research and testing I decided not to use READ anymore. Keep reading if you want to know why.


FOR Instruction

Sage Enterprise Management (X3) technical documentation says FOR can be used to perform loops in two cases: Read loops on database tables or joins and loops on index values or on a list of values.

I didn’t know by default FOR retrieves all fields in the table and also does an ORDER BY using the first index. This is inefficient in most cases and it is not a recommended practice when writing SQL queries. Luckily for us the FOR instruction can be optimized by using the COLUMNS instruction and the RECKEY keyword. COLUMNS instruction allows us to restrict the fields returned by the FOR instruction and RECKEY suppress the ORDER BY so the records are returned in the physical order they are stored in the database.

This a typical FOR instruction I used to write.

For [F:YYRBT] Where REBTXNTYP=3 and DOCNUM=[M:SDH0]SDHNUM
If func YSC25REBATE.FIND_REBATE([F:YYRBT]REBID) = 0 Then
 GOK = 0
Endif
Next

We ran SQL traces to see exactly what SQL query is generated by the 4GL instructions. This is the one generated by the 4GL instructions above.
Select YYRBT_.ROWID, YYRBT_.*
From CASHBACK.YREBATE YYRBT_
Where YYRBT_.REBTXNTYP_0 = @P1 And YYRBT_.DOCNUM_0 = @P2 Order by YYRBT_.REBID_0
Option (FAST 1)

This is the optimized FOR and how I’m doing it now.
Columns [YYRBT](REBID)
For [YYRBT]reckey Where REBTXNTYP=3 and DOCNUM=[M:SDH0]SDHNUM
If func YSC25REBATE.FIND_REBATE([F:YYRBT]REBID) = 0 Then
   GOK = 0
Endif
Next

This is the SQL query generated by the 4GL instructions above. Notice the SELECT SQL query includes the fields in the COLUMN instruction and also the fields that are part of the WHERE clause (REBTXNTYP and DOCNUM), which is preferable than returning all the fields in the table.

Select YYRBT_.ROWID, YYRBT_.DOCNUM_0, YYRBT_.REBTXNTYP_0, YYRBT_.REBID_0, YYRBT_.UPDTICK_0
From CASHBACK.YREBATE YYRBT_
Where YYRBT_.REBTXNTYP_0 = @P1 And YYRBT_.DOCNUM_0 = @P2

Option (FAST 1)

Much better, right? I still don’t like the FAST 1 hint as I have read it is better to let SQL optimizer decide what is the best execution plan to retrieve records, but nothing we can do as that hint is added automatically by Sage Enterprise management X3 programming language.


READ instruction

Sage Enterprise Management X3 technical documentation says READ can be used to get data from a table or a join based on the value of an index key previously defined or a temporary index.

This instruction by default also retrieves all fields in the table and does an ORDER BY. It can be optimized with the COLUMNS instruction to restrict the fields returned by the SQL query but it doesn’t provide a way to suppress the ORDER BY making it less efficient than FOR instruction that does allow it.

This is a typical READ instruction I used to write.

Read [F:YYRBT]YRBT1=PREBID
This is the SQL query generated by the 4GL instruction above.
Select YYRBT_.ROWID, YYRBT_.*
From CASHBACK.YREBATE YYRBT_
Where YYRBT_. REBID_0= @P1
Order by YYRBT_. REBID_0

Option (FAST 1)

This is the optimized READ. Extended keyword must be used when using COLUMNS with Read.

Columns [YYRBT](REBID) Extended
Read [F:YYRBT]YRBT1=PREBID

This is the SQL query generated by the 4GL instruction above. The SQL query still has the ORDER BY which in most cases is time consuming and not necessary.

Select YYRBT_.ROWID, YYRBT_.REBID_0
From CASHBACK.YREBATE YYRBT_
Where YYRBT_. REBID_0= @P1
Order by YYRBT_. REBID_0

Option (FAST 1)


Why bother using READ that always adds the ORDER BY if we can use FOR to achieve the same results in a more efficient way? Here at Southeast Computer Solutions, we write all type of integrations with Sage Enterprise Management (X3) using 4GL programming language and we pride in having code efficiencies for the best outcome.

Entradas populares de este blog

Valores de fstat

Fstat fstat  is a numeric status that is returned upon execution of a database operation, a sequential file operation, or a lock instruction. Syntax fstat Examples # MYTABLE is a table with a key called KEY1, that has a unique component called KEYVAL # Create a record in the table MYTABLE with they key value 1 if it doesn't exist Local File MYTABLE [MYT] Read [MYT]KEY1=1 If fstat [MYT]KEYVAL=1 : Write [MYT] If fstat MSG="The key was created in the mean time" Else MSG="Key created" Endif Else MSG="Key already exists" Endif Details fstat  is always set to '0' if the operation is successfully completed, and has a non-null value if there is an error: In a sequential read ( Getseq  and  Rdseq ),  fstat  is set to '1' at the end of the file. On  Lock ,  fstat  is set to '1' if the lock could not be performed. For a database operation ( Read ,  Look ,  Readlock ,  For ,  Write ,  ...
Leer más

3 ways to send a mail from code in Sage X3, with more attachments too

Origen Fuente:  https://en.sagedev.it/sagex3/send-mail-from-code-with-attachments-sage-x3/ Autor:  https://en.sagedev.it/category/sagex3/ In this post I’ll show you how to send a mail from adonix code in Sage X3. The points we will face are: 1) Meladx/Send introduction 2) Sending  through  meladx (the best way for me: at the end with just a single code line you send a mail!) 3) Sending  through  Workflow 4) Sending  through  ENVOI_MAIL(…) From AWRKMEL Sending mail from code in Sage X3: Send vs meladx Sage X3 has two native ways for sending mails. The first way is  meladx  executable file, that you can find in  runtime\bin  directory. The seconde one is Send instruction, that was used to send mail through an application of the client station (for more information on “Send GSERMES”  go here ). The Meladx executable Meladx send messages through SMTP/POP3 protocols by means of the mail  ...
Leer más

How to Install and Manage Sage X3 Add-Ins in Microsoft Office

When you enable an add-in, it adds custom commands and new features to Microsoft Office programs that help increase your productivity. In this blog post, we’ll review how to install the Sage X3 Add-In for MS Excel and what to do if your Sage X3 Add-In is missing. Fuente original: https://www.netatwork.com/how-to-install-and-manage-sage-x3-add-ins-in-ms-office/ How to Install the Sage X3 Add-In in Microsoft Excel Go to Administration > Utilities > Installation > Install addins for Office V11 Image:   V12 Image:   It should begin downloading the exe, open the exe Next > Install   Open Excel > File > Options   Select Add–Ins > Manage: COM Add-ins > Go   Check the “Excel AddIn for Sage” > Ok   You are now ready to export Excel-based reports/grids from Sage X3. How to troubleshoot and fix a missing Sage X3 add-in in Microsoft Excel Open the Microsoft Office product where the  Sage X3  add-in is missing. Go to Options: Se...
Leer más