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 section describes the extractor installation procedure on a SAP instance. There are two sections:

  • Section 1 - common installation process: this section must be followed regardless of the source code packaging method you are using (see Introduction to the SAP Extractors for more information)
  • Section 2 - installation process for CAST Delivery Manager Tool: this section is only mandatory if you are using the CAST Delivery Manager Tool to connect directly to the SAP instance (see Introduction to the SAP Extractors for more information).

Section 1 - common installation process

This section must be followed regardless of the source code packaging method you are using (see Introduction to the SAP Extractors for more information).

Although these instructions are common to both extraction tools, the procedure is illustrated with the ABAP program extractor only.

The first step consists of creating a new ABAP program on the SAP instance. To do this, activate the standard transaction "SE38" (corresponding to the ABAP Editor) from the initial screen of SAP (the SAP user must have "development authority" and program names must begin with the letter Z e.g.: ZCAST):

The following screen will then be displayed:

Type a name for the new program and set the "Sub-objects" option to its default value.

Naming conventions - the root name of the program can freely be set according to your development standards, but add the suffix '_PRG' for the program extractor and '_TAB' for the table extractor (see screenshot above). It is important to respect this naming convention because it allows you to exclude the source code of both extractors from the extraction process.

Example: You can name the ABAP programs extractor "ZCAST_EXTRACTOR_PRG" and the SAP tables extractor "ZCAST_EXTRACTOR_TAB".

Then click "Create". The following screen will then be displayed:

Set the different fields and validate the window by using the button located in the bottom left hand corner (Save).

  • Extractors for use with SAP 4.7 and SAP ECC5 require the installation of an INCLUDE file named ZCAST_UTILITY_ZIP (the corresponding source code is located at the root of your CAST installation folder).
  • Extractors for use with all versions of SAP require the installation of an INCLUDE file named ZCAST_EXTRACTOR_UTIL (the corresponding source code is located at the root of your CAST installation folder).

The installation procedure for these INCLUDE files is the same as for the extraction programs. Nevertheless, in the screen shot above, you must select the type "INCLUDE Program" instead of "Executable Program".

The following screen will then be displayed:

If you want to test the new program locally, without this one being transferred into the other environments, then click "Local object".

After this step, the ABAP editor window is displayed and will contain an empty ABAP program or an empty ABAP INCLUDE. Now it is necessary to call the "UTUL" transaction in order to load the source code from one of the text files provided by CAST. Make sure you use the correct source (according to your SAP version and to the extractor you want to install):

If the UTUL transaction is not available on your SAP system, then you can proceed as follows:

  1. Open the text file in a text editor (ex: Notepad)
  2. In the ABAP Editor, create a new executable program
  3. Edit the new program
  4. Copy the source code from the text editor and paste it in the ABAP Editor
  5. Save the new program

Once the file is loaded, the source code is displayed in the editor window as shown in the screen below:

Now activate the program (and the include file if you installed it) using the Activate button located on the program editor toolbar. This will terminate the creation of the new program:

The extraction program has now been created.

Section 2 - installation process for CAST Delivery Manager Tool

This section is only mandatory if you are using the CAST Delivery Manager Tool to connect directly to the SAP instance (see Introduction to the SAP Extractors for more information).

Programs and SAP tables extractors can be launched directly from the CAST Delivery Manager Tool through remote function modules (RFC) contained in a function group. You need to create these function modules in an existing function group or a new one. The procedure to create a new function group is as follows:

  • Select "function group" in the ABAP editor, then enter the new function group name (ZCAST_RFC_EXTRACTOR in our example):

  • If you are using an existing function group, select it in the same manner.

  • Now, you must create the RFC for the programs extractor.

  • Right-click on "Function Modules" item, then select "Create" and enter the function module name. You must call this function ZCAST_RFC_EXTRACTOR_PRG.

  • Enter a description, then click "Save":

  • Right-click the function module then choose "Change".

  • Modify the Attributes tab according to the following screen:

  • Add the following "Import attributes" in the "Import" tab according to the following screen. You must respect the parameter names exactly as shown below:

  • Copy the source code in to the "Source Code" tab, using the ZCAST_RFC_EXTRACTOR_PRG.txt provided file (copy/paste the text):

  • Save, validate and activate the function module.

  • Do the same thing for the tables extractor function module (named ZCAST_RFC_EXTRACTOR_TAB and where source code can be found in ZCAST_RFC_EXTRACTOR_TAB.txt file) using these screens:

  • The CAST Delivery Manager Tool should now be able to connect to the SAP instance.
  • No labels