Micro Focus. Enterprise View. Dynamic Link Process Guide

Transcription

1 Micro Focus Enterprise View Dynamic Link Process Guide

2 Copyright 2007 Micro Focus (IP) Ltd. All rights reserved. Micro Focus (IP) Ltd. has made every effort to ensure that this book is correct and accurate, but reserves the right to make changes without notice at its sole discretion at any time. The software described in this document is supplied under a license and may be used or copied only in accordance with the terms of such license, and in particular any warranty of fitness of Micro Focus software products for any particular purpose is expressly excluded and in no event will Micro Focus be liable for any consequential loss. Animator, COBOL Workbench, EnterpriseLink, Mainframe Express, Micro Focus, Net Express, REQL and Revolve are registered trademarks, and AAI, Analyzer, Application Server, Application to Application Interface, AddPack, AppTrack, AssetMiner, CCI, DataConnect, Dialog System, Enterprise Server, Enterprise Server with MTO, EuroSmart, FixPack, LEVEL II COBOL, License Server, Mainframe Access, Mainframe Manager, Micro Focus COBOL, Micro Focus Studio, Micro Focus Server, Object COBOL, OpenESQL, Personal COBOL, Professional COBOL, Server Express, SmartFind, SmartFind Plus, SmartFix, SourceConnect, SupportLine, Toolbox, VS COBOL, WebSync, and Xilerator are trademarks of Micro Focus (IP) Ltd. IBM and CICS are registered trademarks, and IMS, DB2, DB2/390, DB2 Connect Enterprise Edition, DB2 Connect Personal Edition, COBOL for OS/390, Enterprise Systems Architecture/390, ESA/390, MVS, MVS/ESA, OS/390, S/390, System/390, VSE/ESA and MFS are trademarks, of International Business Machines Corporation. Netscape Enterprise Server is a trademark of Netscape Communications Corporation. Internet Information Server, Windows 95, Windows 98, Windows NT 4.0, Windows ME and Windows 2000 are registered trademarks of Microsoft Corporation. Pentium is a registered trademark of INTEL Corporation. Borland Database Engine and Midas are trademarks of Inprise Corporation. Oracle is a trademark of Oracle Corporation Inc. UNIX is a registered trademark of The Open Group. Solaris, Ultra Sparc and Java are trademarks of Sun Microsystems, Inc. Linux, GCC compiler, GNU CTAGS, GNU DIFF, Samba and KDE/GNOME refer to Open Source tools. This product includes modified versions of software developed by the Apache Software Foundation (as described on the Apache web site). The YGrep Search Engine is Copyright (c) Yves Roumazeilles. All other trademarks are the property of their respective owners.

3 No part of this publication, with the exception of the software product user documentation contained on a CD-ROM, may be copied, photocopied, reproduced, transmitted, transcribed, or reduced to any electronic medium or machine-readable form without prior written consent of Micro Focus (IP) Ltd. Contact your Micro Focus representative if you require access to the modified Apache Software Foundation source files. Licensees may duplicate the software product user documentation contained on a CD-ROM, but only to the extent necessary to support the users authorized access to the software under the license agreement. Any reproduction of the documentation, regardless of whether the documentation is reproduced in whole or in part, must be accompanied by this copyright statement in its entirety, without modification. U.S. GOVERNMENT RESTRICTED RIGHTS. It is acknowledged that the Software and the Documentation were developed at private expense, that no part is in the public domain, and that the Software and Documentation are Commercial Computer Software provided with RESTRICTED RIGHTS under Federal Acquisition Regulations and agency supplements to them. Use, duplication or disclosure by the U.S. Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of The Rights in Technical Data and Computer Software clause at DFAR et. seq. or subparagraphs (c)(1) and (2) of the Commercial Computer Software Restricted Rights at FAR , as applicable. Contractor is Micro Focus (IP) Ltd, 9420 Key West Avenue, Rockville, Maryland Rights are reserved under copyright laws of the United States with respect to unpublished portions of the Software.

4 4

5 5 Table of Contents: 1. About This Document What Is a Dynamic Link? Basic and Extended Dynamic Links How to Define a Dynamic Link Basic Dynamic Link Step 1 Welcome Step 2 Masked Program Name Definition Step 3 Program Type Definition Step 4 Variable for : Generic Dispatcher I/O Dispatcher I/O Video Dispatcher I/O Print Dispatcher I/O Standard CALL I/O I/O Video I/O Print Dynamic SQL Step 5 Preview Extended Dynamic Link Step 1 Welcome Step 2 Specify Internal Classification Step 3 Specify Dynamic Link Properties Step 4 Define Search Criteria for Object Types Specify Object Type and Its Properties Define Reference Types Step 5 Complete How to Import Dynamic Links Where to View Dynamic Links How to Work With Proposed, Confirmed and Not Handled Dynamic Links39

6 6

7 7 1. About This Document This guide describes the processing phases, step-by-step, for creating dynamic links, viewing them and working with them.

8 8

9 9 2. What Is a Dynamic Link? In this guide we use the term link to denote the process of transferring control from one object to another within the run unit. The object that calls another object is the calling object (source or parent object). The object identified in the call statement is the called object (destination or child object). When the called object is not clearly specified (i.e. its name is received at run time from outside or it can change during the run unit), we call this a dynamic link. During the analysis phase, when the Enterprise View Analyzer identifies a dynamic link in the source code, the relationships between Enterprise View objects are created. In order to have a clearer presentation of the relationships between the dynamically called objects, you can create dynamic link definitions before the execution of an analysis job. There are two types of custom dynamic link definitions basic and extended. To create them you generate basic or extended dynamic call definitions in the Enterprise View environment using the Dynamic Link Configuration Wizard in the Enterprise View Configuration Manager, using the Dynamic Links module. The custom dynamic link definitions contain the rules that will be used for the identification of the dynamic links and the relationships between objects during the analysis phase. The Enterprise View Analyzer uses these definitions and creates proposed dynamic links. If there are no custom dynamic link definitions, the Enterprise View Analyzer creates proposed dynamic links using logic of its own. The dynamic links with status proposed can be managed, and changed to confirmed or not handled in the Enterprise View Configuration Manager module.

10 10

11 11 3. Enterprise View Process Overview Define Dynamic link Extended Basic or Extended Basic Step 1 Welcome Step 1 Welcome Step 2 Specify Internal Classification Step 2 Masked Program Name Definition Step 3 Specify Dynamic Link Properties Step 3 Program Type Definition Step 4 Define Search Criteria for Object Types Step 5 Complete Step 4 Variable for : Step 5 Preview Analyze Sources Check Results Proposed or Confirmed Proposed Confirmed Set as Confirmed or Not Handled View the Results in the Client Modules

12 12

13 13 4. Basic and Extended Dynamic Links Basic dynamic links are used for Java, C, C++, Visual Basic, CSD, PL/I, while the extended ones are used for COBOL programs and COBOL Delta Macro programs. The New Dynamic Link Wizard for the extended dynamic links lets you create many relationships to one dynamic link. In the Dynamic Link Configuration Wizard for basic dynamic links, each created dynamic link can create only one type of relationship. The extended dynamic links provide more options for defining various types of relationships. In the future, basic dynamic links will become obsolete and fully replaced by the extended dynamic links. The latter will cover all functions of the former.

14 14

15 15 5. How to Define a Dynamic Link Select the Enterprise View Configuration Manager Dynamic Link or start the Enterprise View Configuration Manager and select the Dynamic Link module from the sidebar Basic Dynamic Link To create a dynamic link for Java, C, C++, Visual Basic, CSD or PL/I, select the New Dynamic Link (Basic) by right-clicking. The Dynamic Link Configuration Wizard will then create a dynamic link definition.

16 Step 1- Welcome Choose the type of dynamic link - system or not. The system dynamic link does not report relationships. In this case, after Step 2 you will directly go to Step 5.

17 Step 2 - Masked Program Name Definition Enter the following information: Masked Program Name Enter a masked program name. It can be the masked name of a dispatcher program, function or method. You can use the * and? symbols. The? stands for a single character, the * stands for any number of characters. Language Choose the type of language from the dropdown list: Java, C, C++, Visual Basic, CSD, PL/I. Number of Parameters Specify if the number of parameters is important. Select the Not Important radio button if it isn t. If the link depends on the number of parameters, select the Maximum Number of Parameters radio button and choose the number. Note: If there are two dynamic links with the same dispatcher name but a different number of parameters, the parser will first try to match the ones with the corresponding number of parameters. If there are no matching ones, the parser will search for ones with Not Important selected.

18 Step 3 - Program Type Definition Choose the program type. It can be Generic Dispatcher, I/O Dispatcher, I/O Video Dispatcher, I/O Print Dispatcher, I/O Standard, CALL I/O, I/O Video, I/O Print or Dynamic SQL. Depending on your choice, in the next steps you will fill in additional information about the dynamic link.

19 Step 4 - Variable for : Generic Dispatcher If you choose the Generic Dispatcher for the program type, the following step is available: Step I - Variable for Program Name The Linked Program name comes from: The dispatcher program name the linked program name will be the same as the masked program name. One of the call parameters - the linked program name will come from one of the call parameters. You have to specify which parameter contains the linked program name. Prefix/Mask/Suffix: Prefix type a string that will be added in front of the linked program name. Mask this is a string built as follows: an optional sequence of _ and/or?, specifying that all characters falling onto a _, must be suppressed and all characters falling onto a? must be kept; an optional trailing * specifying that the trailing string must be kept. The _/? sequence is evaluated from left to right; any _ is replaced with nothing (e.g. if the found value is ABC and the mask is?_?, the result is AC). If the found value is longer than the mask and a trailing * is present, the rest of the string is kept. If the found value is longer than the mask and no trailing * is present, the rest of the string is suppressed. If the mask is longer than the found value, the found

20 20 value is masked until bytes are available and excessive mask wildcards are ignored. This operation creates the mask of the linked program name. Suffix type a string that will be added to the end of the linked program name. From/Count: This lets you obtain the linked program name as a substring of the dispatcher program name or of one of the parameters. From byte specifies the starting position of the substring. Count specifies the length of the substring in characters I/O Dispatcher If you choose the I/O Dispatcher for the program type, the following steps are available: Step I Variable for Program Name Step II Variable for Table Name Identify the name of the used table. The Table name can be identified starting from the dispatcher name or from one of the parameters used in the link.

21 21 The Table name comes from: The dispatcher program name the table name will be the same as the masked program name. One of the call parameters the table name will come from one of the call parameters. You have to specify which parameter contains the table name. The last parameter the table name will come from the last call parameter. Prefix/Mask/Suffix: Prefix type a string that will be added in front of the table name. Mask creates the mask of the table name. For details see Mask in Step I - Variable for Program Name. Suffix type a string that will be added to the end of the table name. From/Count: This lets you obtain the table name as a substring of the dispatcher program name or of one of the parameters. From byte specifies the starting position of the substring. Count specifies the length of the substring in characters. Step III Variable for I/O Type

22 22 The I/O Type comes from: The dispatcher program name the I/O type will come from the masked program name. One of the call parameters the I/O type will come from one of the call parameters. Grid of references: Reference Type shows the type of the reference between the program which contains the dynamic link and the table defined in Step II. Name shows if the parameter is defined by name or by value. Value shows the value of the parameter. Details: Reference Type choose the type of the reference that will be created between the program which contains the dynamic link and the table defined in Step II. By Name - if the By Name flag is checked, Enterprise View will use the name of the parameter to determine the reference type. Otherwise it will use the value of the parameter for this purpose. Value a reference of the specified type will be created if the value or the name (depending on the By Name checkbox) of the parameter matches the specified value I/O Video Dispatcher If you choose the I/O Video Dispatcher for the program type, the following steps are available: Step I Variable for Program Name Step II Variable for Video Map Object Name The Video Map Object Name comes from: The dispatcher program name the video map object name will be the same as the masked program name. One of the call parameters the video map object name will come from one of the call parameters. You have to specify which parameter contains the video map object name. Prefix/Mask/Suffix: Prefix type a string that will be added in front of the video map object name. Mask creates the mask of the video map object name. For details see Mask in Step I - Variable for Program Name.

23 23 Suffix type a string that will be added to the end of the video map object name. From/Count: This allows you to obtain the video map object name as a substring of the dispatcher program name or of one of the parameters. From byte specifies the starting position of the substring. Count specifies the length of the substring in characters I/O Print Dispatcher If you choose the I/O Print Dispatcher for the program type, the following steps are available: Step I Variable for Program Name Step II Variable for Print File Object Name The Print File Object Name comes from: The dispatcher program name the print file object name will be the same as the masked program name. One of the call parameters the print file object name will come from one of the call parameters. You have to specify which parameter contains the print file object name. Prefix/Mask/Suffix: Prefix type a string that will be added in front of the print file object name. Mask creates the mask of the print file object name. For details see Mask in Step I - Variable for Program Name. Suffix type a string that will be added to the end of the print file object name. From/Count: This allows you to obtain the print file object name as a substring of the dispatcher program name or of one of the parameters. From byte specifies the starting position of the substring. Count specifies the length of the substring in characters.

24 I/O Standard If you choose the I/O Standard for the program type, the following steps are available: Step I Variable for Table Name Note: The table name will be the same as the linked program name. Step II Variable for I/O Type Note: The I/O type will come from the linked program name CALL I/O If you choose the CALL I/O for the program type, the following steps are available: Step I Variable for Table Name Note: The table name will be the same as the linked program name. Step II Variable for I/O Type Note: The I/O type will come from the linked program name.

25 I/O Video If you choose the I/O Video for the program type, the following step is available: Step I Variable for Video Map Object Name Note: The video map object name will be the same as the linked program name I/O Print If you choose the I/O Print for the program type, the following step is available: Step I Variable for Print File Object Name Note: The print file object name will be the same as the linked program name.

26 Dynamic SQL If you choose the Dynamic SQL for the program type, the following step is available: Step I Variable for SQL Statement On this step you will be able to identify the name of the used table. The Table name can be identified starting from the SQL Statement or from one of the parameters used in the link. The Table name comes from: One of the call parameters the SQL statement will come from one of the call parameters. You have to specify which parameter contains the SQL statement Step 5 Preview

27 27 This step previews the dynamic link which you have configured. Press the Generate button to start the process Extended Dynamic Link To create one or more dynamic link(s) for a COBOL program or COBOL Delta Macro program internal classification, you have to select the New Dynamic Link (Extended) function by right-clicking. The New Dynamic Link Wizard will create custom dynamic link(s) Step 1 Welcome This wizard will help you to create a custom dynamic link. It will be used by the Enterprise View Analyzer to create links and relationships during the analysis job and will create proposed dynamic links which can be managed from the Enterprise View Tech module.

28 Step 2 Specify Internal Classification Specify the sources internal classification (Java Sources, COBOL program or COBOL Delta Macro program) to which a dynamic link will be applied.

29 Step 3 Specify Dynamic Link Properties Specify: Dynamic Link Properties Enter the following information: Dynamic Link Name Enter a dynamic link name. You can use the * and? symbols. The? stands for a single character, the * stands for any number of characters. Create Relation If the checkbox is checked, Enterprise View will create a relationship between the analyzed object and the Dynamic Link Name. This relationship is always a call relationship. Dynamic Link Type Choose from the following options: Other System Dynamic SQL All types of dynamic links that are not system, dynamic SQL and delta macro. Goes to Step 4. Goes directly to Step 5 and creates a system dynamic link. The system dynamic link does not report relations. Allows you to track the execution of SQL statements for

30 30 Delta Macro which the dynamic link is used. If you choose the dynamic SQL type, you must select the parameter number from which the dynamic SQL will be taken. After that, you will go directly to Step 5. This type is used if you have chosen COBOL Delta Macro program for the Internal Classification and if there are delta macro statements in the source code. Goes to Step 4. Number of Parameters Specify if the number of parameters is important: Not Important Parameter Number Select the Not Important radio button if the number of parameters is not important. If the link depends on the number of parameters, select the Parameter Number option and choose the number. It will show from which parameter the relationship comes. Note: If there are two dynamic links with the same dispatcher name but a different number of parameters, the parser will first try to match the ones with the corresponding number of parameters. If there are no matching ones, the parser will search for ones with Not Important selected Step 4 Define Search Criteria for Object Types

31 31 Describe the rules that will be applied during the analysis phase to identify the dynamic link and the relations that have to be created. You can choose from the following buttons: New Object Type Definition: lets you create a new object type definition. Edit Object Type Definition: lets you edit the created object type definition. Delete Object Type Definition: deletes the selected object type from the dynamic link. After the and sub-steps the window above will show all object types and relationships that are defined. The Object Type Defined grid will show information about the object type, parameter number or value, locate method and mask. The Relations Defined grid will show information about the reference type, locate method, parameter number or value and if there is a relationship or not Specify Object Type and Its Properties Specify the object type and its properties. The selected properties will be used during the analysis phase to identify the dynamic link.

32 32 Object Type Properties The Parameter comes from Locate Method The Object Type dropdown list has different values depending on the selected internal classification (which you have selected in Step 2): for Java sources File, Java Packages, Program, Service for COBOL program File, Include, Map Definition, Printer File Definition, Program, Queue, Service, Transaction for Delta Macro Program Delta Macro, File, Include, Map Definition, Program, Queue, Service, Transaction Dispatcher Program Name the linked object name will come from the dynamic link name. Last Parameter the linked object name will come from the last parameter. Parameter Number - the linked object name will come from one of the call parameters. You have to specify which parameter contains the linked object name. Variable Names the linked object name will come from variable names, which will be described in the Variable Names tab. Object Name - the linked object name will come from the fixed object name. You have to specify the name of the object. The locate method depends on the selected item in The Parameter comes from section. For the Parameter Number, Last Parameter and Variable Names you can choose from: Parameter Content the linked object name will take the value of the parameter. Parameter Name the linked object name will take the name of the parameter. For the Dispatcher Program Name and Object Name the locate method will be the parameter content. Prefix/Mask/Suffix Prefix you can type a string that will be added in front of the dynamic link name. Mask - this is a string built as follows: an optional sequence of _ and/or?, specifying that all characters falling onto a _ must be suppressed and all characters falling onto a? must be kept; an optional trailing * specifying that the trailing string must be kept. The _/? sequence is evaluated from left to right; any _ is replaced with nothing (e.g. if the found value is ABC and the mask is?_?, the result is AC). If the found value is longer than the mask and a trailing * is present, the rest of the string is kept. If the found value is longer than the mask and no trailing * is present, the rest of the string is suppressed. If the mask is longer than the found value, the found value is masked until bytes are available and excessive mask wildcards are ignored. This operation creates the mask of the dynamic link name. Suffix you can type a string that will be added to the end of the dynamic link name. From/Count This allows you to obtain the linked object name as a substring

33 33 Variable Names of the dynamic link name or of one of the parameters. From - specifies the starting position of the substring. Count - specifies the length of the substring in characters. If you choose the Variable Names in The Parameter comes from section, you have to define some variable names. The product will search only among them Define Reference Types Define all references that need to be monitored during the analysis phase and traced in Enterprise View. The grid shows all created relationships and information about their type, locate method and value. The relations name comes from Dispatcher Program Name the relationship name will come from the dynamic link name. Last Parameter - the relationship name will come from the last parameter. Parameter Number - the relationship name will come from one of the call parameters. You have to specify which parameter contains the relationship name.

34 34 Variable Names - the relationship name will come from variable names, which will be described in the Variable Names tab. Fixed Relations - the relationship name will come from the fixed relationships. Locate Method Note: The relations name comes from property influences all relationships. The locate method depends on the selected item in The relations name comes from section. For the Parameter Number, Last Parameter and Variable Names you can choose from: Parameter Content - the relationship name will take the value of the parameter. Parameter Name the relationship name will take the name of the parameter. Reference Type and Variable Name Reference Type the type of the relationship that will be created. The values that are shown in this dropdown list depend on the selected item from the Object Type dropdown list in the sub-step. Variable Name - the relationship name will come from variable names and the product will search only among them. This grid has to be filled in only if you have chosen the Variable Names in The relations name comes from section. Value the value of the parameter. This field has to be filled in only if you have selected Dispatcher Program Name, Parameter Number or Last Parameter in The relations name comes from section. Create Relation If this checkbox is checked, the specified relationship will be created. Otherwise, the relationship will not be created. If you have chosen the Fixed Relations in The relations name comes from section, it will automatically create a relationship, which means that this checkbox will be checked by default.

35 Step 5 Complete You are told that the dynamic link has been successfully generated. Click the Finish button to exit from the wizard.

36 36 6. How to Import Dynamic Links To start the Import Dynamic Links function, you have to select the button in the toolbar of the Dynamic Links module of the Enterprise View Configuration Manager. You can import dynamic link(s) from the other models, which are in the Work with Model window ( ) to the current model which you have selected from the Enterprise View Navigator s Select Model function. The Import Dynamic Links window contains two grids. The first one shows all existing models and brief descriptions of them. The second grid shows all dynamic links belonging to the selected method, their classifications and parameter number. The parameter number column shows the maximum number of parameters which you have defined in the Dynamic Link Configuration Wizard. A value -1 means that the number of parameters is set to Not Important. You can select all or some of the dynamic links which you want to import and press the Import button. This operation will import the selected dynamic links to the current model.

37 37 7. Where to View Dynamic Links Existing dynamic links can be viewed in the Enterprise View Tech module (select Enterprise View Tech from the Enterprise View Navigator and then choose the Dynamic Links module in the sidebar). The window shows a standard organization view and programs with dynamic links. The Programs with Dynamic Links part is divided into three sections: Filter Options, List of Programs and Dynamic Links/Attributes/References. The Filter Options section allows you to filter by System, Object Type, Object Language, Library/File Name and Status (All, Proposed, Confirmed and Not Handled). By default the values of the Filter Options section are *ALL* for the System, Object Type and Object Language dropdown lists, empty in the Library/File Name field, and All in the Status frame. The List of Programs section contains a grid of all programs with dynamic links for the selected organization view. When you move up and down the organization view tree, the data in the List of Programs and Dynamic Links/Attributes/References sections will be refreshed after you choose different options in the Filter Options part and press the Apply button. The Dynamic Links part contains all dynamic links related to the selected program in the List of Programs section. They are shown in three tabsheets: Proposed, Confirmed and Not Handled.

38 38

39 39 8. How to Work With Proposed, Confirmed and Not Handled Dynamic Links The Proposed/Confirmed/Not Handled tabsheets show information about the type of the dynamic link, line number of code that contains the selected dynamic link and the line number of code that contains the selected dynamic link if it is a copy/include. You can change the state of the selected proposed dynamic link to Not Handled and change it back by right-clicking.

40 40