diff --git a/README.md b/README.md index 82299d0..8156d6d 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,34 @@ -# teamscale-sap-abap-connector -Teamscale Connector for SAP Netweaver® AS ABAP® +# Teamscale Connector for SAP Netweaver® AS ABAP® v1801 -This repository contains the Add-On for SAP Netweaver® AS ABAP® which is used to -connect [Teamscale](https://www.teamscale.com/) to a SAP Netweaver® AS ABAP® system. +## License +**© 2018 CQSE GmbH** +**Usage of this software and all its components is restricted to a +valid license for Teamscale (enterprise edition).** -To install the Teamscale connector, the transport files of the relese zip file -must be transported into the respective SAP system. For a detailed description -see chapter 6 of the Temascale [user guide](https://www.cqse.eu/download/teamscale/userguide.pdf). +## Version Info +**Version 1801**, originally provided for Teamscale v3.9.x. + +## Summary +This archive contains the transport files for the *Teamscale Connector for +SAP Netweaver® AS ABAP®*. This is required for the connection of +[Teamscale](https://www.teamscale.com) to a SAP Netweaver AS ABAP instance +to allow analysis of ABAP code, tests and/or custom code usage within *Teamscale*. + +## Contents +The archive comprises the following transports: + +1. **CQIK00252** (files K900296.CQI / R900296.CQI) + This is the main transport, objects are in /CQSE/ namespace and within package /CQSE/TEAMSCALE_CONNECTOR and its subpackages. + ==> Always required, should be transported first. +2. **CQRK00016** (files K900016.CQR / R900016.CQR) +This includes a default role (/CQSE/TEAMSCALE_RFC) for RFC access from Teamscale server to the Teamscale Connector for SAP Netweaver ABAP. This role can be assigned to technical user accounts which should be used by Teamscale server. +==> Optional, alternatively an appropriate role can be defined manually. + +## Installation +For transport, place the K* files in the 'cofiles' and the R* files in the +'data' directories within the transdir of your host machine (typically +/usr/sap/trans or C:\usr\sap\trans) and import the transport with transaction +STMS. Enable special conditions *overwrite originals* and *ignore invalid +component version*. + +For further details see Teamscale [user guide](https://www.cqse.eu/download/teamscale/userguide.pdf), chapter 6.