Working With Setup Tool

Target Audience

Administrator (system or application)
Technology consultant

Overview

SAP CC Setup Tool is a user interface of SAP Convergent Charging. It is a command line program that allows you to setup the SAP CC Core Server system by directly modifying its back-end database. During the project implementation phase, you complete the installation by:

configuring some business or technical functions
maintaining the business data related to your business requirements

This user interface allows you to export and import the following configuration settings of the SAP CC system:

Business data:

The tax settings: EU VAT taxation policies (VAT rates, VAT Rules, country tax policies), EZTax transaction/service types

Business system settings:

The notification policy

Technical system settings:

The hardware key and the licenses - for all instances of the SAP CC system
The security settings required to secure communication channels (such as the key pairs for encryption mechanisms)
The instance map of the SAP CC system
The list of transport destinations of the target SAP CC systems.
The configuration dedicated to the integrated SAP Solution with the SAP ERP/FI-CA and SAP CRM systems of SAP Business Suite: JCo destinations, ERP reference system
The CIF configuration - for the rater and the bulkloader instances of the SAP CC system
The RIF configuration - for the rater instances of the SAP CC system

The use of all the commands is detailed in this SAP product documentation.

Important Note

The changes are not immediate and you must restart some relevant instances in the SAP CC Core Server system.

Notes

You cannot change all these SAP CC system settings with the Admin+ user interface.
Check that your license is always valid; otherwise, you cannot access to all the commands.

Getting Started

Executing the Program

The Setup Tool user interface is available from the dispatcher instances of your SAP CC Core Server system and communicates directly with the SAP CC Core Database system. The launch scripts are available in the installation folder.

To launch Setup Tool:

1. On the SAP Global Host of the SAP CC Core Server system, open one of the following directories depending on the operating system of the host machine:

<DRIVE>:\usr\sap\<SID>\CCD<SAP_INST_NB>\script\ (MS Windows operating system)
/usr/sap/<SID>/CCD<SAP_INST_NB>/script/ (UNIX, Linux, and other operating systems)

Where <SAP_INST_NB> is the SAP instance number, a two-digit number automatically assigned to the dispatcher instances by SAPinst at installation time.

2. Open a system console in this directory.

3. Execute the appropriate launch script with the correct command and arguments. In the console, type:

setup.bat <COMMAND_AND_ARGS> (MS Windows)
./setup.sh <COMMAND_AND_ARGS> (UNIX and Linux)

4. A prompt asks you to enter your administrator credentials. Type your SAP CC user logon.

5. Safely, type your user password. It is not displayed to the console.

6. Setup Tool verifies the user authentication and performs your operation.

Note

In a development or test system landscape, you can directly precise your credentials by adding the -login and -password arguments to the command line:

setup.bat <COMMAND_AND_ARGS> [-login=<USR_LOGON>] [-password=<VISIBLE_USR_PASSWD>] (MS Windows)
./setup.sh <COMMAND_AND_ARGS> [-login=<USR_LOGON>] [-password=<VISIBLE_USR_PASSWD>] (UNIX and Linux)

Where <USR_LOGON> and <VISIBLE_USR_PASSWD> are your SAP CC system credentials (logon, password) as a system or application administrator.

Make sure that you do not use these arguments in a production system landscape. The password is visible in the console.

Recommendation

In a secure environment, SAP SE recommends that you never use the additional -login and -password arguments.

Connecting and Logging On

An SAP CC user name and password must authenticate each command (except for the help command). The user name must correspond to an individual user.

Note

Consult the SAP CC Security Guide to get information on communication security and user rights to perform the commands described in this documentation.

Getting Help

You can simply use the help command to list the commands and get help with a particular command.

Example

./setup.sh
./setup.sh license

Commands

Command	Definition
about setuptool	To view the About information of SAP CC Setup Tool
bulkloader deletePolicy	To delete the bulkloader policy configuration from the database
bulkloader exportPolicy	To export the bulkloader policy configuration from the database to a file
bulkloader importPolicy	To import the bulkloader policy configuration into the database
certentry import	To import the client certificates from files into the database
certentry export	To export the client certificates from the database to files
certentry delete	To delete the client certificates
certentry list	To list all the client certificates
certentry link	To link the client certificate to one or several services
certentry unlink	To unlink a client certificate from all the declared services
certentry listLinks	To list all the linked certificate entries
cif delete	To delete the CIF configuration from the database
cif export	To export the CIF configuration from the database to a file
cif import	To import the CIF configuration into the database
eif deleteConfiguration	To delete the EIF configuration from the database
eif exportConfiguration	To export the EIF configuration from the database to a file
eif importConfiguration	To import the EIF configuration into the database
eif deleteDefaultMapping	To delete the default exportable item mapping from the database
eif exportDefaultMapping	To export the default exportable item mapping from the database to a file
eif importDefaultMapping	To import the default exportable item mapping into the database
erpreferencesystem setJCoDestination	To set the JCo destination name of the SAP ERP reference system into the database
erpreferencesystem getJCoDestination	To get the JCo destination name of the SAP ERP reference system from the database
eztax deleteTSTypes	To delete the EZTax Transaction/Service Types from the database
eztax exportTSTypes	To export the EZTax Transaction/Service Types from the database to a file
eztax importTSTypes	To import the EZTax Transaction/Service Types into the database
instancemap delete	To delete the instance map from the database
instancemap export	To export the instance map from the database to a file
instancemap import	To import the instance map into the database
jcodestination delete	To delete a JCo destination from the database
jcodestination export	To export a JCo destination from the database to a file
jcodestination import	To import a JCo destination into the database
jcodestination list	To list the available JCo destinations
keyentry delete	To delete the key entries
keyentry export	To export the key entries from the database to files
keyentry export_p12	To export the key entries from the database to a PKCS#12 file
keyentry import	To import the key entries from files into the database
keyentry import_p12	To import the key entries from a PKCS#12 file into the database
keyentry link	To link the key entry to one or several services.
keyentry list	To list all the key entries
keyentry unlink	To unlink a key entry from all the declared services
keyentry listLinks	To list all the linked key entries
license hardwarekey	To display the host hardware key
license export	To export the license from the database to a file
license import	To import the license into the database
migration generateCIPackageReport	To generate a report for migrating chargeable item packages to chargeable item classes
migration executeCIPackageReport	To execute a report migrating chargeable item packages to chargeable item classes
migration increaseCounterSnapshotCount	To increase the number of counter snapshots stored for each subscription/charging contract
migration deactivateRecharging	To deactivate the recharging operations that are based on counter snapshots
migration CC40SP08_GetAccessMigrationStatus	To get the status of the migration operation related to accesses
migration CC40SP08_ExecuteAccessMigration	To execute the migration operation related to accesses
migration CC40SP08_CompleteAccessMigrationForGuiders	To complete the migration of accesses for guider instances
migration CC40SP08_CompleteAccessMigrationForRaters	To complete the migration of accesses for rater instances
notificationpolicy delete	To delete a notification policy from the database
notificationpolicy export	To export a notification policy from the database to a file
notificationpolicy import	To import a notification policy from a file to the database
rif delete	To delete the RIF configuration from the database
rif export	To export the RIF configuration from the database to a file
rif import	To import the RIF configuration into the database
sapci deleteConfiguration	To delete the SAP CI configuration from the database (REVOKED: use commands 'erpreferencesystem getJCoDestination' and 'jcodestination delete' instead)
sapci exportConfiguration	To export the SAP CI configuration from the database to a file (REVOKED: use commands 'erpreferencesystem getJCoDestination' and 'jcodestination export' instead)
sapci importConfiguration	To import the SAP CI configuration into the database (REVOKED: use commands 'jcodestination import' and 'erpreferencesystem setJCoDestination' instead)
sapci deleteDefaultMapping	To delete the default SAP CI mapping from the database
sapci exportDefaultMapping	To export the default SAP CI mapping from the database to a file
sapci importDefaultMapping	To import the default SAP CI mapping into the database
transportdestination importList	To import a list of transport destinations from an XML file into the database
transportdestination exportList	To export the list of transport destinations from the database to an XML file
vatax deleteCountryTaxPolicies	To delete the country tax policies from the database
vatax deleteVATRate	To delete the VAT rates from the database
vatax exportCountryTaxPolicies	To export the country tax policies from the database to a file
vatax exportVATRate	To export the VAT rates from the database to a file
vatax exportVATRules	To export the VAT rules from the database to a file
vatax importCountryTaxPolicies	To import the country tax policies into the database
vatax importVATRate	To import the VAT rates into the database
vatax importVATRules	To import new VAT rules into the database