Working with Config Tool

Target Audience

  • IT administrator (system, application, business)
  • IT consultant
  • Support specialist

Overview

This SAP Product Documentation is the primary help of your SAP CC 5.0 Config Tool user interface.

Depending on your goals, use the quick links or the complete table or contents to view your user-centric information.

What's New in This Document

This section highlights the main changes in this SAP product document. They relate both to new or changed features in the SAP CC 5.0 software and to documentation enhancements to enrich your SAP user experience continuously.

What's New in SP 1

As of SP 1, consider the new or changed features:

Getting Started

If this is your first time using the SAP CC 5.0 Config Tool user interface, get started by working through this topic to familiarize yourself.

Config Tool is a user interface of SAP Convergent Charging. It is a command line program that allows you to quickly configure or transport a large subset of system parameters in the SAP CC Core Server system. A complete or partial SAP CC system restart is necessary to take the changes into account.

Use

This user interface allows you to:

  • Configure a consistent set of system parameters (persistent values) in an SAP CC Core Server system or in the system instances of the same type
  • Transport the complex parameter configuration from a source SAP CC system (in a development landscape) to a target SAP CC system in another system landscape (test landscape, quality assurance landscape)

Config Tool connects to the back-end database system (Core Database) that relates to your Core Server system. The SAP CC system parameters are stored in this database in the INSTANCE_CONFIGURATION table. Config Tool does never connect directly to an SAP CC system.

You can:

  • Export the persistent values of all the configuration parameters of the SAP CC Core Server system to an XML file.
  • Import, and thus update, some configuration parameters into the corresponding SAP CC Core Database system before restarting the relevant instances of the SAP CC system

Notes

During the project implementation phase or the production operation phase:

Important Note

Check that your license is always valid; otherwise, you cannot access to all the commands.

Refer to your tasks and the corresponding procedures to work efficiently during the project implementation phase or during the production operation phase.

File and Format

Config Tool manages dedicated XML (Extensible Markup Language) files. The character encoding is UTF-8 to support many languages.

As of SP 1, the SAP CC Cockpit user interface supports these files. In the app Manage SAP CC System Parameters, consult the available tasks:

File Format (XML)

The file format is XML. Consider the following XML definition:

XML Syntax

The root XML element is <clusterConfig>:

  • It may include a sequence of nested elements (<instanceConfiguration>) for each type of instances in an SAP CC Core Server system. The name attribute specifies the instance type. In SAP Convergent Charging, the possible predefined values are: rater, updater, guider, bulkLoader, dispatcher, and taxer.

  • Each <instanceConfiguration> element includes the new configuration value of a parameter for the SAP CC system. You set up this configuration by using the nested element: <configParameter>. The name attribute specifies the technical name of the SAP CC system parameter and the value attribute specifies the new persistent value of the system parameter that you want to change. The values depend on each parameter.

Refer to the SAP CC 5.0 System Parameter Reference for more detailed information about the technical names of the SAP CC system parameters and about the possible parameter values.

Tip

Export the current settings of your SAP CC system for more technical information about the file format.

Example

<clusterConfig>

    <instanceConfiguration name="rater">

        <configParameter name="AUDIT_ACTIVATION" value="true"/>

        ..

    </instanceConfiguration>

</clusterConfig>

Launching Config Tool

Executing the Program

The Config 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 Config 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 systems)
  • /usr/sap/<SID>/CCD<SAP_INST_NB>/script/ (UNIX, Linux, and other operating systems)
  • Where <SID> is the unique SAP system ID and where <SAP_INST_NB> is the SAP instance number, a two-digit number automatically assigned to the dispatcher instances by the SAP installer.

2. Open a system console in this directory.

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

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

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

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

6. Config 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:

  • config.bat <COMMAND_AND_ARGS> [-login=<USR_LOGON>] [-password=<VISIBLE_USR_PASSWD>] (MS Windows)
  • ./config.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 5.0 Security Guide to get information on communication security and user rights to perform the commands described in this documentation.

Getting In-App Help

You can use the help command of the user interface to list the commands and get help with a particular command. In a system console, type config.bat configuration help or ./config.sh configuration help to display information about the commands.

Activities and Tasks

You use Config Tool regularly or exceptionally to inspect or configure the Core Server system.


With Config Tool, you can change some parameters to:

  • Configure a business function in your SAP CC Core Server system such as charging and refillling services
  • Configure a technical function in the system such as SAP user management, security, log and trace management.
  • Configure a function only in some instances of your Core Server system
  • Quickly set up or change a subset of parameters of an SAP CC system
  • Transport a complete or partial system configuration from a development system to a quality system

Procedures


See here:

To view some SAP CC system parameters:

To inspect some parameters or to create a report with the persistent values, just use the 'configuration export' command.

To configure a subset of SAP CC system parameters:

In your system, apply the following procedure to change some persistent values of the SAP CC system parameters:

  • Execute Config Tool to first export the relevant configuration settings from the back-end database to a new file
  • Make a backup copy of the exported file if you need to restore the configuration. You do not need to backup the database.
  • Edit the XML file and change the necessary parameter values depending on your business or technical requirements. Refer to the file format information and to the SAP CC 5.0 System Parameter Reference.
  • Import the persistent values of system parameters from your changed file into the back-end database system
  • Restart the relevant instances of the SAP CC Core Server system or restart the complete SAP CC system

Example

  • Execute Config Tool to export the relevant configuration settings to a file: ./config.sh configuration export parameters.xml all -login=admin -password=pass
  • Make a file copy
  • Edit the text file and change the required parameters depending on your maintenance needs
  • Import your changed file: ./config.sh configuration import newparameters.xml -login=admin -password=pass
  • Restart the complete SAP CC system with SAP MC
To transport a subset of SAP CC system parameters:

Apply the following procedure to transport the parameters from a source SAP CC Core Server system to a target SAP CC system:

In the source system:

  • Execute Config Tool to export the relevant configuration settings from the back-end database to a new file. This database system relates to the source SAP CC system (Core Server).
  • Edit the text file and remove the unnecessary items
  • Save this customized file
  • Transfer the changed file to the target system

In the target system:

  • Execute Config Tool to export the current configuration settings from the back-end database to a new file. This database system relates to the target SAP CC system (Core Server).
  • Archive this file as a backup file
  • Get the customized file previously prepared and import the parameter values of your changed file into the back-end database system that relates to the target SAP CC system
  • Restart the relevant instances of the target SAP CC Core Server system or restart the complete SAP CC system
To copy an SAP CC system:

To copy an SAP CC Core Server system from one system landscape to another landscape, refer to the Procedures for Copying an SAP CC System from a Landscape to Another in the SAP CC 5.0 Installation Guide.

Commands

You can use the following commands to complete your daily or occasional tasks. Access to your information quickly:

Note

All commands are case insensitive.

Command Definition
about To view the About information and version of SAP CC Config Tool
configuration export To export SAP CC system parameters from the database to a file
configuration import To import a large set of SAP CC system parameters into the database
configuration check To check the SAP CC system parameters in the database
configuration help To display the help information about a particular command
help To get the list of the commands available in SAP CC Config Tool

FAQs and Tips

Based on customer feedbacks, we deliver Frequently Asked Questions (FAQs) about all aspects of working with the Config Tool user interface efficiently. We complete these solutions with time-saving tips and tricks. Please share your SAP user experience to enrich these sections.


See here:

FAQs

Review this FAQ section to find answers about SAP CC Config Tool.

Why is the exported XML file not complete?

Config Tool exports only the SAP CC system parameters that it can import to the INSTANCE_CONFIGURATION database table again. The user interface does not export the persistent values of all the parameters that are defined in an SAP CC Core Server system.

For example, it does not export neither the SYSTEM_ID system parameter nor the EXTERNAL_SERVICE_HOST system parameter. It does not handle the system parameters that are stored in the CONFIGURATION database table.

Tips

Prepare and use custom files to change some particular system configuration settings

With Config Tool, you can prepare different XML files that contain only an isolated subset of persistent values. Prepare these files to keep the persistent values that are relevant for your configuration operations.

Export multiple files.

Edit each file. Delete the unnecessary parameters and change the required values.

For example, you can create two system configuration files that correspond to the log and trace configuration for your SAP CC system. One file relates to a production system that is live. The second file can relate to a debug mode.

Use our SAP Notes and KBAs

In SAP ONE Support Launchpad:

Use SAP CC Cockpit

As of release 5, you can benefit from a web application to manage the SAP CC system parameters quickly and efficiently: just use the app Manage SAP CC System Parameters in your SAP CC 5.0 Cockpit user interface.

Troubleshooting Problems

As part of the technical operations, you may have to troubleshoot some problems with your user interface or with your SAP CC environment (systems, data, users) in the system landscape.

You use Config Tool to troubleshoot some problems and to:

  • Retrieve information and analyze symptoms
  • Perform some important actions (immediate corrections, preventive actions)
  • Determine the root causes
  • Resolve an issue

Related Documentation

For more information, see the related user assistance and product documentation of SAP Convergent Charging 5.0 on SAP Help Portal or on your data center portal.

Select your field of interest that relates to the Config Tool user interface:

Note

Refer to the SAP CC 5.0 Application Help for more information about the processes and functions of SAP Convergent Charging.

Additional Information

For more information about data transport (master data or business data), consult the SAP CC 5.0 Core Tool - Primary Help.