Installation of the CAST SAP Extractor
Check the SAP system compatibility
See Prerequisites in CAST SAP Extractor NG.
Check the CAST SAP Extractor deliverables
Before starting to install the CAST SAP Extractor, please ensure that you have received the complete installation kit which includes the following deliverables:
- A workbench transport request: This transport request contains all the development objects that are required to install the CAST SAP Extractor. A manifest (a text file) will also be provided, that describes the different objects that are contained in the transport request. The following screenshot shows a sample manifest:
- Two customizing transport requests:
- The first one embeds the custom role which is needed to be able to use the CAST SAP Extractor – see CAST SAP Extractor NG - User Guide - 8.3.x - 8.2.x - 8.0.x. This role can be delivered either by importing the provided customizing transport request, or by uploading a simple text file, which is also provided, into the target SAP system.
- The second one embeds the table entries which define the default naming patterns needed for the CAST SAP Extractor to retrieve standard repair based routines and user exits. Those entries can be delivered either by importing the provided customizing transport request, or by manually maintaining them in the custom table.
If either of the above deliverables is not present, please contact CAST Support.
Importing the CAST SAP Extractor
Before running the import action using the STMS (SAP transport management system), place the (data | cofiles) files supplied with the CAST SAP Extractor in the following location on the SAP system:
SAP Transaction: STMS
- Double click on the SAP System you would like to use in order to host the tool:
Click Extras > Other Requests > Add:
Enter transport request number and target client:
Select transport transport request(s) using thebutton:
Execute import by clicking on thebutton and carry out the import procedure, checking the Ignore Invalid Component Version option as shown below:
- Once the import is completed (click the button), please check the import log, to ensure no return code is higher than 4 by accessing the import log (click the button):
Importing the CAST for SAP authorization role
An authorization is required to be able to launch the CAST SAP Extractor. These authorizations are encompassed into a PFCG role, entitled “/INVY/CAST_EXTRACTOR”. Based on the CAST authorization deliverables that were provided to you, you need to follow different steps to install the CAST authorization role.
Custom transport request
If the authorization role was delivered to you via a custom transport request, you need to import this request into your target system. You can follow the same procedure as described in the previous paragraph SAP Transaction: STMS:
Authorization role provided in a text file
If the authorization role was provided in a text file, you need to manually upload the text file into the target system:
- Launch the PFCG transaction to open the Role Maintenance editor
- Click Role and then Upload:
- An information popup will be displayed. Click the OK button:
- Choose the file provided to you by CAST and upload the SAP PFCG file using to the standard file upload editor:
- The PFCG authorization role /INVY/CAST_EXTRACTOR will then be uploaded into the target system.
Importing routines and user exits naming patterns
Routines and user exits naming patterns are required for the CAST SAP Extractor to retrieve and process custom patterns. Those patterns are stored in a custom table entitled /INVY/EXTRMODI_T. This table has to be populated for this extraction feature to be operational.
Default entries are delivered in a dedicated custom transport request, which can be imported following the same procedure as described before.
Otherwise, they can also be manually entered through the SM30 transaction:
- Click Maintain:
- Enter or adjust entries. Latest default values are listed in the transport request manifest file:
Checking a successful installation
You should check the transport logs to see whether the installation has completed successfully. For example return codes of 0 and 4 are acceptable and in the installation has been successful:
Installation of an additional patch
Before starting to install a CAST SAP Extractor patch, please ensure that you have received the patch installation kit which includes the following deliverables:
- A transport request: This transport request contains all the development objects that are required to install the new patch.
If the above deliverable is not present, please contact CAST Support.
Importing CAST patches
The installation process for a CAST SAP Extractor patch is identical to the "from scratch" installation process described above.
Assigning a role to a user
As has been detailed above, the CAST SAP Extractor is delivered with a PFCG role that you need to install in your SAP instance before users can start using the CAST SAP Extractor (see CAST SAP Extractor NG - User Guide - 8.3.x - 8.2.x - 8.0.x).
To start the role installation:
- The maintenance window will popup. Enter the Role name with the following data: /INVY/CAST_EXTRACTOR, then click the "Edit" button:
- Go to the User tab and then click the "Selection" button.
- Here you can add a new user to the previously selected role. You can either enter the user's last name or their user ID. Then, click on the "OK" button to search and find the user:
- When the required user is found, click on the corresponding row and click the "OK" button:
- You can see below that the new User has been added to the chosen role /INVY/CAST_EXTRACTOR:
- Finally lick on the "Save" button followed by the "User comparison" button.
Removing a role from a user
In order to remove a role from a specific user, start with the same SAP transaction PFCG, choose the corresponding Role and switch to the "Edit" mode similar to when assigning a role to a user (as described above):
- In the User panel, you will find the list of the users that have been assigned the selected Role.
- Choose the row corresponding to the User, and click the "delete row" button to remove the user:
- Do not forget to save your changes once complete.
Uninstalling the CAST SAP Extractor from the SAP instance
The uninstall process has two steps:
- Uninstall the CAST SAP Extractor role
- Uninstall the CAST SAP Extractor
Uninstall the CAST SAP Extractor role
As explained previously, a new PFCG role must be installed in order to be able to use the CAST SAP Extractor. This role can be installed using two methods:
- A custom transport request
Creating a new role in SAP transaction PFCG
Therefore, the method used for the role installation will affect how the role is removed from the SAP instance.
Uninstalling the CAST SAP Extractor role via a custom transport request
If you have installed the role by importing a custom transport request, than you can delete this same role by importing a deletion transport request.
In order to be able to remove the CAST role by importing a deletion transport request into your SAP system, you need to make sure that you have received the corresponding deliverables:
- A deletion transport request: this transport request contains a deletion entry for CAST authorization role.
Please contact CAST if you do not have this transport request.
To delete CAST authorization role, you need to import the deletion transport request provided by CAST. You can follow the instructions in paragraph Installing the CAST for SAP authorization role (above) - the process is identical.
Uninstalling CAST Role manually
If you have installed CAST Role by uploading the corresponding file, than you can delete this role manually from your system:
No specific deliverables are required in this case.
In order to delete CAST authorization role manually:
- Launch the Role Maintenance editor (Transaction PFCG)
- Enter /INVY/CAST_EXTRACTOR in the input corresponding to the role name.
- Click the delete button and confirm:
Uninstall the CAST SAP Extractor NG
In order to uninstall CAST SAP Extractor NG, two different transport requests will be provided to the customer:
- Package content removal transport request
- Package removal transport request
To uninstall the CAST SAP Extractor, please import the deletion transport requests in the following strict order:
- Import “Package content removal transport request” into the target system first - this will delete the CAST SAP Extractor NG from the system. Nevertheless, the name of the packages that contained the extractor will not be deleted at this point. In order to finish the deletion of the extractor completely, please import the second removal transport request listed below.
- Import “Package removal transport request” into the target system next - this will complete the uninstall procedure, by deleting what has not been deleted by the first deletion transport requests, i.e. CAST custom development package names.