Page tree
Skip to end of metadata
Go to start of metadata

This documentation refers to versions 7.0.3 and earlier of the CAST SAP Extractor. These versions are now superseded, but can still be used with CAST AIP 7.0 to 7.3. For the documentation of the current version the SAP extractor, please see CAST SAP Extractor NG Admin Guide.

This step explains how to run the SAP extraction tools when you are NOT connecting to the SAP instance from the CAST Delivery Manager Tool.

Testing

If you want to use the extraction program which has just been installed, then click the "Test" button in the program editor toolbar:

The program now runs and its parameter screen is displayed.

Extracting programs

If you want to extract information about programs, includes, user-exits, functions, BAPI or Web Dynpro for ABAP, then you must run the CAST Program Extractor. The following screen is displayed:

Setting input fields

You must set the different fields and then validate the screen. You can also set the different fields via "Multiple Selection" windows by clicking the button located to their right:

The following window appears:

You can then specify inclusion and exclusion patterns.

  • If you want to extract source code corresponding to a package or a set of packages, then you must use the field "Package". You can then specify complete names (used in conjunction with the "equal" operator) or patterns (used in conjunction with the "contains" operator).
  • If you want to extract source code corresponding to specific programs or transactions, then you must use the field "Object". You can then also specify complete names or patterns.
  • If you want to extract source code corresponding to transport requests, then you must use the field "Transport Request" or "Use File On Server". The first one allows you to specify one or several transport requests directly in the screen and the second one allows you to specify one or several transport requests in an external file located in the default SAP directory on the application server. This file must contain one transport request per line and each line must have two parts separated by a semicolon ( ; ) . The first part is the transport request name and the second part is the associated description.
  • If you want the extracted files to be created into a local directory on the user machine, then you must set the "Target Directory" field. The target directory name must not be longer than 72 characters. If it is longer than this limit, then the generated file names could be truncated and the following message box will appear. You can click the button CONTINUE if you do not want to change the target directory name. Then, the extraction process will start. If you choose CHANGE, then you will be able to change the target directory name.

  • If you want to create these files on the SAP server, then set the "Target Directory server" field as shown in the following screen:

The files will be then generated in a subdirectory that has been manually created in the default SAP directory (DIR_HOME). You can find values assigned to the environment field by using the transaction code AL11. Please ensure, however, that the target path contains NO blank spaces (i.e. *this folder*), otherwise the files will be generated in the wrong location.

  • It is not possible to set the Target Directory field and Target Directory server field at the same time. In this case, the extraction program stops and displays the error message: "Set only local or server file".
  • If you want the extractor to check the existence of packages associated to ABAP components, then set the option Check Existence of Package to ON. The default value is OFF and the extractor will not verify the existence of package in the TDEVC table.
  • If you would like to automatically extract include files that are used by the programs referenced in extraction criteria (package, name, transport), then activate the Extract dependent includes option. This will ensure that the code is fully extracted even if some of the includes do not match the selection criteria.

Outputs

Files generated by the CAST SAP Program extractor have the following extensions:

  • abap: source code of programs, functions, includes...
  • txt: execution statistics for extractors
  • flow: content of flow logic
  • list: list of transactions for a package
  • xml: BAPI, Web Dynpro for Abap source code, and package hierarchy - see also below for additional information on xml file generated
  • log: execution log file

They are generated in directories corresponding to their package if the extraction process is performed in online mode. In batch mode, the extractor for use with SAP > 4.6 will save results in zip files in the default SAP directory on the application server. In this case, directory tree corresponding to the packages will be saved in the zip file. The extractor for use with SAP <= 4.6 will not save results in zip files and directory tree corresponding to packages will not be created. This does not impact the source code analysis but this can create differences with previous online extractions (generated objects will be then considered as new objects).

In addition the CAST SAP Program extractor generates an xml file that contains information about the extracted ABAP components. It contains the following properties:

  • name
  • description
  • component type and date of creation
  • author
  • date of last modification
  • author
  • last transport order used

This file is saved in the same place as other files that are generated by the CAST SAP Program extractor (i.e. in directories corresponding to the package). The files use the following naming convention: PG_DESCR_xxx.XML where xxx corresponds to the package.

Extracting tables

If you want to extract information for a set of tables and views, then you must run the CAST Tables Extractor. The following screen is displayed:

Setting input fields

Input the required parameters in the available fields and then validate the screen (see instructions in Extracting programs in Using the extraction programs for the ABAP programs extractor). Note that you can use Tables Names and Package Names as criteria for extracting tables (use the fields Table Name and Package to achieve this - both fields accept the same input parameters).

The CAST table extractor can extract the number of rows for each extracted table. This information is available if the option "Extract table number of rows" is activated. You can also choose to extract (default) or not the number of rows for client-dependent tables.

Results are saved into an XML file ("SAP_tables_volume.SQLTABLESIZE") in the same directory as other generated files. This file can then be used in the SAP Analysis Unit editor - Source Settings tab (in the CAST Management Studio) to insert Table Row information for further exploitation in the CAST Engineering Dashboard.

Information related to table size is extracted from the environment on which the extractor is executed.

Outputs

Files generated by the SAP Table Extractor are as follows:

  • SAP_tables_xxxx.sap.xml: definition of tables (description, columns, primary keys, foreign keys, indexes, packages)
  • SAP_views_xxxx.sap.xml: definition of views
  • SAP_tables_packages_xxxxxxxx_xxxx.sap.xml: package hierarchy
  • SAP_tables_volume_xxxx.SQLTABLESIZE: number of rows of extracted tables
  • .log:execution log file

Important note about the generated files

"SAP_tables_xxxx.sap.xml" and "SAP_views_xxxx.sap.xml" files mentioned above are generated by the SAP Table extractor v. 5.6 and replace previous DEF, LINKS, and LIST files that are no longer used by the ABAP Analyzer delivered in CAST v. 7.x.x.
Versions 6.3.x and 6.4.x of CAST require you to use version 5.5.2 of the SAP Table extractor. Generated files for this version of the extraction tool are as follows:

  • SAP_tables_xxxx.def: definition of tables
  • SAP_tables_xxxx.links: not used
  • SAP_tables_xxxx.list: list of extracted tables
  • SAP_tables_volume_xxxx.SQLTABLESIZE: number of rows of extracted tables
  • SAP_views_xxxx.def: definition of views
  • SAP_views_xxxx.links: links between views and tables
  • SAP_views_xxxx.list: list of extracted views

In batch mode, the extractor for use with SAP > 4.6 will save results in zip files in the default SAP directory on the application server. Extractor for use with SAP <= 4.6 will not.

Additional information

Extractors save information related to extraction tasks in log files (.log) located in the output directory. They contain different types of information like input parameters used to run the extractors and events that occur during the extraction operation (information, warning, and error).

If you have problems, it is useful to provide CAST Support with as much information as possible in order to help the Support team to understand the situation correctly. You should gather the following information:

  • Log files
  • Screen shots showing messages, files etc.
  • Description of the execution mode (background, online, parameter used)
  • Examples of output files

At the bottom of the screen, you will see the status bar. It displays information about the extraction process, like for instance the current source file to be extracted:

At the end of the extraction process, a message box will be displayed allowing you to save extraction process statistics on disk:

...and extraction process statistics will also be displayed on screen:

  • No labels