Solution – Details

The rule consists of the following four ON blocks:

• INIT – initializes values of variables which you will use in the rule
• INPUT – extracts the sales data from the report
• CHECK – checks the data and prints a balancing report
• ENDJOB – prints a final comment and terminates the job

Opening the Rule

1. From the IOA Primary Option Menu, enter the Rule Definition facility by typing BR in the COMMAND field and pressing Enter. The Rule Definition entry panel is displayed:

   Figure 60 Control-M/Analyzer Rule Definition Entry Panel

   -------------- CONTROL-M/ANLAYZER RULE DEFINITION - ENTRY PANEL ------------(BR)

   COMMAND ===>                                                                  

                                                                                

                                                                                

                                                                                

   SPECIFY LIBRARY, RULE                                                        

                                                                                

      LIBRARY ===> CTB.PROD.RULES                                                

      RULE    ===>                  (Blank for rule selection list)           

                                                                                

                                                                                

                                                                                

                                                                                

                                                                                

                                                                                

                                                                                

                                                                                

                                                                                

                                                                                

                                                                                

                                                                                

                                                                                

                                                                                

   USE THE COMMAND "SHPF" TO SEE PFK ASSIGNMENT                           13.41.48

2. If the library name in the LIBRARY field in this example is different from your Control-M/Analyzer RULES library name, change it to appear as shown in this example.
3. Leave the RULE field blank. Press Enter. The Rule List screen is displayed.
4. From the list of rules defined, select ARWARN02 for browsing as follows:
   1. Place the cursor in the OPT field, to the left of the rule named ARWARN02.
   2. Type B and press Enter. The Rule Definition screen for ARWARN02 is displayed.

   Figure 61 Rule Definition Screen for Rule ARWARN02

           LIBRARY : CTB.PROD.RULES                                RULE : ARWARN02

   COMMAND ===>                                                    SCROLL===> CRSR

   +---------------------------------- BROWSE -----------------------------------+

   | OWNER   M66                      GROUP INTRAC                               |

   | UPDATED 03/04/99  -  15:30:05    BY M66                                     |

   | DESC    SUMMARIZE AND CHECK PAYROLL TOTALS                                  |

   | OPTIONS                                                                     |

   | =========================================================================== |

   | EXECUTE INIT     UPON                                                   C   |

   | ON DATA                                                                     |

   | ALWAYS                                                                      |

   |   DO SET      = ERRORCOUNT=0                                            C   |

   |   DO SET      = SLSNO=0                                                 C   |

   |   DO SET      = BLANK=' '                                               C   |

   |   DO PRINT    = ******** PAYROLL CONTROL TOTALS *********           F   C   |

   | =========================================================================== |

   | EXECUTE INPUT    UPON                                                   C   |

   | ON SYSOUT     PROCST          PGMST STEP01   DDNAME SYSUT2   JOBNM          |

   |    MODE PG    LINECT 0000    DATASTAMP                                      |

   | WHEN LINE 001     - 060     COL 001     - 025              STOP    AND/OR   |

   |      STRING = 'YTD COMMISSIONS PAID'                                        |

   |   DO EXTRACT  = YTDPAID                                                     |

   |                 LEVEL 0 LINE +000 COL 0068 - 0078 PROCESS          TYP      |

   PLEASE FILL IN RULE DEFINITION.                                        14.46.10

   Defining ON Blocks for this Rule

5. The first ON block in this rule is called INIT, as defined in the line that begins "EXECUTE INIT." This block is defined as an ON DATA block, set to ALWAYS perform the DO actions that follow it in the ON DATA block definition.

   The purpose of this ON block is to initialize the values of variables that are used later in the rule. These variables are

   • ERRORCOUNT, which is a variable to keep track of all of the errors encountered as the rule performs its balancing actions

     This count will be used, after examining the entire report, to determine if the rule should terminate OK or NOTOK.

   • SLSNO, which is a sequential salesperson number

     Because the report you are producing is distributed to various employees, and because the individual salesperson earnings printed on the report are confidential, the rule uses a salesperson number rather than a name. This number will be a sequential number assigned by you.

   • BLANK, which is a variable that allows the rule to print blank lines, to create a better-looking report.

     Alternatively, you may use an AutoEdit variable named %%BLANK in your print line.

   Many rules have ON blocks such as this one to initialize variables and perform other setup functions.

   You can now look at the next ON block, called INPUT. To get a better look at this entire ON block, do the following to move its first line to the top of the screen:

6. Examine the SCROLL field in the upper right area of the screen. If this field does not contain the value CRSR, place the cursor in the SCROLL field and type CRSR.
7. To bring the first line of the INPUT block to the top of the screen, place the cursor on the line beginning with the words EXECUTE INPUT and press PF08/PF20, or enter the DOWN command. The first line of the block is now displayed at the top of the screen, and its entire contents are now visible.

   Figure 62 INPUT Block

           LIBRARY : CTB.PROD.RULES                                RULE : ARWARN02

   COMMAND ===>                                                    SCROLL===> CRSR

   +---------------------------------- BROWSE -----------------------------------+

   | EXECUTE INPUT    UPON                                                   C   |

   | ON SYSOUT     PROCST          PGMST STEP01   DDNAME SYSUT2   JOBNM          |

   |    MODE PG    LINECT 0000    DATASTAMP                                      |

   | WHEN LINE 001     - 060     COL 001     - 025              STOP    AND/OR   |

   |      STRING = 'YTD COMMISSIONS PAID'                                        |

   |   DO EXTRACT  = YTDPAID                                                     |

   |                 LEVEL 0 LINE +000 COL 0068 - 0078 PROCESS          TYP      |

   |   DO EXTRACT  = YTDOWED                                                     |

   |                 LEVEL 0 LINE +001 COL 0068 - 0078 PROCESS          TYP      |

   |   DO EXTRACT  = CURRENT                                                     |

   |                 LEVEL 0 LINE +002 COL 0068 - 0078 PROCESS          TYP      |

   |   DO BLOCK    = CHECK    ARG                                            C   |

   | =========================================================================== |

   | EXECUTE ENDJOB   UPON                                                   C   |

   | ON DATA                                                                     |

   | IF       ERRORCOUNT>0                                                   C   |

   |   DO PRINT    = %%BLANK                                             F   C   |

   |   DO PRINT    = ****** ERRORS IN COMMISSIONS ABOVE ******           F   C   |

   |   DO TERMINAT = NOTOK    COD 0999                                           |

   | ELSE                                                                        |

   PLEASE FILL IN RULE DEFINITION.                                        15.00.48

   Before examining this screen in detail, you need to first understand how a "data source" related ON block is structured.

   Figure 63 ON Block Structure

   

   When you need to extract data from a report or file, you use an ON block structure as shown in Figure 63. An ON block consists of the following parameters:

   • EXECUTE – The EXECUTE parameter identifies the beginning of a new ON block. After the word EXECUTE, give the ON block a name. In these examples, you are not using the UPON parameter. This parameter can be used to specify criteria which determine if the current ON block is executed.
   • ON <data source> – The ON parameter identifies the report or file that you want to process. What you specify here enables Control-M/Analyzer to receive the output from the system.
   • WHEN <criteria> – The WHEN parameter searches for the specific data that you need from your report.
   • DO <actions> – DO parameters indicate the balancing actions to take for each line that met your search criteria.
8. Now see how this ON block structure is implemented in the INPUT ON block.
   • EXECUTE INPUT marks the beginning of the block named INPUT.
   • ON SYSOUT indicates that this block is working with a report file.

     If you are not familiar with Job Control Language (JCL), the details for this part of the Control-M/Analyzer rule can be provided by your system administrator. The ON SYSOUT parameter instructs Control-M/Analyzer to look in the JCL in the first job step (STEP01). There, Control-M/Analyzer will find a data definition (DD) JCL statement labeled SYSUT2. This is the statement that gives Control-M/Analyzer the information it needs, in order to describe the characteristics of the report file.

   • MODE PG indicates that the block is examining the report by page. This means that when data is extracted from the report, the line and column numbers are specified relative to the beginning of the current page.
   • LINECT indicates the number of lines per page. When not specified, as above, it defaults to 60.
   • WHEN describes the search criteria.

     As defined in this block, when the rule finds the data string "YTD COMMISSIONS PAID" anywhere between columns 1 through 25, in lines 1 through 60, meaning, on any line of the report, Control-M/Analyzer is instructed to DO the balancing actions. The following DO EXTRACT and DO BLOCK instructions are performed repetitively, every time the WHEN search criteria are satisfied:

     • DO EXTRACT takes data out of the report and puts it into a variable. Control-M/Analyzer can then reference and work with this variable. This extraction of data from the report occurs for each line in which the string "YTD COMMISSIONS PAID" is found.

   Figure 64 Extract from the Sales Commission Detail Report

   ----+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9---

   INTRAC INC.             SALES OPERATIONS DEPARTMENT     DATE 10/10/01 TIME 23:45      PAGE  4

      

       S A L E S     C O M M I S S I O N S    D E T A I L           FROM 10/10/01   TO  10/10 01

   |SALESPERSON    HARVEY J. JONES  (197)   | INVOICE #  | INVOICE DATE |  AMOUNT  | STATUS

   |                                        | CJ39394    | 02/02/00     |   2040.00| COLLECTION|

   |                                        | CJ98443    | 03/03/00     |    245.00|           |

   |                                        | MJ24545    | 04/04/00     |  10344.40|           |

   |                                        | RJ10030    | 01/02/00     |   5329.39|           |

   |                                        | RJ12233    | 02/02/00     |  5000.00 |           |

   |                                        | RJ30021    | 03/02/00     | 16670.10 |           |

   |                                        | RJ32991    | 02/03/00     | 30300.44 |           |

   |                                        | RJ33939    | 03/03/00     |   900.25 |           |

   |                                        | RJ38001    | 04/04/00     |  1000.23 |           |

   |                                        | RJ93043    | 04/04/00     |   415.89 |           |

   +--------------------------------------------------------------------------------------------

   |TOTAL SALES - THIS MONTH                                              72245.70 (PAID IN FULL

   |ADJUSTMENTS                                                           -5800.70

   |YTD SALES (INCLUDING THIS MONTH)                                    -127879.00

   |YTD COMMISSIONS PAID                                                      0.00

   |YTD COMMISSIONS OWED                                                  -5115.00

   |COMMISSION PAYROLL AMOUNT                                              5115.00

   ---------------------------------------------------------------------------------------------

   • DO EXTRACT YTDPAID—The rule extracts report data from columns 68-78 into a variable called YTDPAID. The report data comes from the above WHEN search, specifically line +0, meaning the line in which "YTD COMMISSIONS PAID" is found, plus 0 lines.
   • DO EXTRACT YTDOWED—This information is also extracted from columns 68-78 into the variable called YTDOWED. The report data comes from line +1, meaning the line in which "YTD COMMISSIONS PAID" is found, + 1 line.
   • DO EXTRACT CURRENT—This information also comes from the report data columns 68-78 and is put into the variable called YTDOWED. The report data comes from line +2, meaning the line in which "YTD COMMISSIONS PAID" is found, + 2 lines.
   • DO BLOCK CHECK — After extracting the above information, perform ON block CHECK before continuing to search further down the report for the next occurrence of "YTD COMMISSIONS PAID."

   Now that the information has been extracted, the rule performs balancing actions on the data. Therefore, a separate ON DATA block is defined in to perform the balancing actions.

9. Using PF08/PF20, or entering the DOWN command, scroll forward until you see the ON block called EXECUTE CHECK.
10. Place the cursor on the line beginning with EXECUTE CHECK and press PF08/PF20 or enter the DOWN command.

    Figure 65 The EXECUTE CHECK ON Block

            LIBRARY : CTB.PROD.RULES                                RULE : ARWARN02

    COMMAND ===>                                                    SCROLL===> CRSR

    +---------------------------------- BROWSE -----------------------------------+

    | =========================================================================== |

    | EXECUTE CHECK    UPON                                                   C   |

    | ON DATA                                                                     |

    | ALWAYS                                                                      |

    |   DO SET      = CALCAMT=YTDPAID+CURRENT                                 C   |

    |   DO SET      = DIFFERENCE=ABS(CALCAMT-YTDOWED)                         C   |

    |   DO SET      = SLSNO=INT(SLSNO+1)                                      C   |

    |   DO PRINT    = SALESPERSON #%%SLSNO                                F   C   |

    |   DO PRINT    = YTD COMM. PAID             %%YTDPAID                F   C   |

    |   DO PRINT    = CURRENT AMOUNT             %%CURRENT                F   C   |

    |   DO PRINT    = -----------------------------------------           F   C   |

    |   DO PRINT    = CALCULATED TOTAL              %%CALCAMT             F   C   |

    |   DO PRINT    = REPORTED TOTAL             %%YTDOWED                F   C   |

    |   DO PRINT    = -----------------------------------------           F   C   |

    |   DO PRINT    = DIFFERENCE   ***** %%DIFFERENCE *****               F   C   |

    |   DO PRINT    = %%BLANK                                             F   C   |

    | IF       DIFFERENCE>0                                                   C   |

    |   DO PRINT    = ***** SERIOUS PAYROLL ERROR - SEE ABOVE *****       F   C   |

    |   DO PRINT    = %%BLANK                                             F   C   |

    |   DO SET      = ERRORCOUNT=ERRORCOUNT+1                                 C   |

    PLEASE FILL IN RULE DEFINITION.                                        15.06.39

    The ON block called CHECK performs calculations and prints information to the balancing report. Generally, calculations are performed using DO SET parameters. DO SET assigns a value to a variable. Output to the report is performed with DO PRINT parameters.

    The ON block CHECK performs the following actions:

    • The new variable CALCAMT is set to the sum of YTDPAID and CURRENT. These two variables were extracted from the report.
    • The variable DIFFERENCE is calculated as the difference between the amount just calculated (CALCAMT) and the amount from the report (YTDOWED). As you will see later in the rule, if there is a difference, it means that there is a serious error. Function ABS is used to set the difference to the "absolute value" of CALCAMT minus YTDOWED.

      The ABS function is one of the many functions available in Control-M/Analyzer to assist the balancing effort. The ABS function is used because the difference should always print as a positive number. When there is a difference, you do not know which amount is the correct amount (CALCAMT or YTDOWED). All you are concerned with in this instance is that there is a difference.

    • The last DO SET parameter increments the salesperson number (SLSNO) by 1. If you want to examine the commission totals for more than one salesperson, you can continue sequentially through the current list of salespeople, based on their salesperson numbers.
    • The report is printed with the group of DO PRINT parameters. As you may recall from the first rule as defined in Problem 1, these print lines are output to two places: the Invocation Report on SYSPRINT, and the user report on SYSUSER.
    • Whenever you want to include a variable in the print line, precede the variable name with two percent signs (%%). As you see in Figure 65, this ON block prints several lines and several variables: YDTPAID, CURRENT, CALCAMT, YTDOWED, DIFFERENCE.

    You can compare these instructions to the actual SYSUSER report, as shown in Figure 68.

    The last part of this ON block contains an IF and ELSE combination of parameters.

11. Position the cursor on the line beginning with the string "IF DIFFERENCE > 0" and press PF08/PF20, or enter the DOWN command.

    Figure 66 IF and ELSE Parameters

            LIBRARY : CTB.PROD.RULES                                RULE : ARWARN02

    COMMAND ===>                                                    SCROLL===> CRSR

    +---------------------------------- BROWSE -----------------------------------+

    | IF       DIFFERENCE>0                                                   C   |

    |   DO PRINT    = ***** SERIOUS PAYROLL ERROR - SEE ABOVE *****       F   C   |

    |   DO PRINT    = %%BLANK                                             F   C   |

    |   DO SET      = ERRORCOUNT=ERRORCOUNT+1                                 C   |

    | ELSE                                                                        |

    |   DO PRINT    = COMMISSIONS OK                                      F   C   |

    |   DO PRINT    = %%BLANK                                             F   C   |

    | =========================================================================== |

    | EXECUTE          UPON                                                   C   |

    | ON                                                                          |

    ======= >>>>>>>>>>>>>>> END OF RULE DEFINITION PARAMETERS <<<<<<<<<<<<<<< =====

                                                                                 

                                                                                 

                                                                                 

                                                                                 

                                                                                 

                                                                                 

                                                                                 

                                                                                 

                                                                                 

    PLEASE FILL IN RULE DEFINITION.                                        15.07.59

    This IF and ELSE definition determines for each salesperson if there is a problem in the balancing report, as follows:

    • If the DIFFERENCE that was calculated previously was greater than 0, then
      • print an error message, followed by a blank line
      • add 1 to the error count
      • otherwise (ELSE),
    • Print a message indicating that the commissions are OK, followed by a blank line

    Terminating the Rule

12. All that is left is for the rule definition to terminate it after the entire report has been examined. This is done with the ON block called ENDJOB.
    1. Press PF07/PF19 or enter the UP command, to scroll backward until you see the ON block ENDJOB.
    2. Place the cursor on the line beginning with the string "EXECUTE ENDJOB" and press PF08/PF20 or enter the DOWN command.

    Figure 67 ON Block ENDJOB

            LIBRARY : CTB.PROD.RULES                               RULE : ARWARN02

    COMMAND ===>                                                    SCROLL===> CRSR

    +---------------------------------- BROWSE -----------------------------------+

    | EXECUTE ENDJOB   UPON                                                   C   |

    | ON DATA                                                                     |

    | IF       ERRORCOUNT>0                                                   C   |

    |   DO PRINT    = %%BLANK                                             F   C   |

    |   DO PRINT    = ****** ERRORS IN COMMISSIONS ABOVE ******           F   C   |

    |   DO TERMINAT = NOTOK    COD 0999                                           |

    | ELSE                                                                        |

    |   DO PRINT    = %%BLANK                                             F   C   |

    |   DO PRINT    = ---------  COMMISSIONS ARE PERFECT  ---------       F   C   |

    |   DO TERMINAT = OK       COD 0000                                           |

    | =========================================================================== |

    | EXECUTE CHECK    UPON                                                   C   |

    | ON DATA                                                                     |

    | ALWAYS                                                                      |

    |   DO SET      = CALCAMT=YTDPAID+CURRENT                                 C   |

    |   DO SET      = DIFFERENCE=ABS(CALCAMT-YTDOWED)                         C   |

    |   DO SET      = SLSNO=INT(SLSNO+1)                                      C   |

    |   DO PRINT    = SALESPERSON #%%SLSNO                                F   C   |

    |   DO PRINT    = YTD COMM. PAID             %%YTDPAID                F   C   |

    |   DO PRINT    = CURRENT AMOUNT             %%CURRENT                F   C   |

    PLEASE FILL IN RULE DEFINITION.                                        15.08.50

Because ON block ENDJOB is the block that sequentially follows ON block INPUT, it is executed right after Control-M/Analyzer has finished executing ON block INPUT—that is, after the rule has scanned the entire report and found and processed all of the lines it was searching for.

ON block ENDJOB performs one of the following two actions, depending on whether there were any errors found when the data was checked:

• If there any errors were found, the rule prints a final line to indicate errors, and then terminates the rule with a NOTOK result and with the user code of 999. This code is a numeric code that indicates an out-of-balance situation.

  Note: You can create your own rules, and you can choose your own codes to signify various errors.

• If no errors are found, this indicates that the commissions are perfect in the printout. The rule terminates with an OK result, and with the user code of 0.