Config Tool
Config Tool
Config Tool
© 2023 SAP SE or an SAP affiliate company. All rights reserved.
1 Config Tool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1 What's New?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.2 Getting Started. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Launching Config Tool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Getting In-App Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.3 Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Viewing some SAP CC Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Configuring a subset of SAP CC system parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Transporting a subset of SAP CC system parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Copying an SAP CC system. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.4 Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
about. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
configuration export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
configuration import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
configuration check. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
configuration help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.5 FAQs and Tips. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
1.6 Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Config Tool
2 PUBLIC Content
1 Config Tool
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.
Related Documentation
Note
Refer to the SAP CC 2022 Application Help for more information about the processes and functions of SAP
Convergent Charging.
Tasks [page 7]
Commands [page 9]
This section highlights the main changes in this SAP product document. They relate both to new or changed
features in the SAP CC 2022 software and to documentation enhancements to enrich your SAP user
experience continuously.
Config Tool
Config Tool PUBLIC 3
1.2 Getting Started
If this is your first time using the SAP CC 2022 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
• 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 [page 10] the persistent values of all the configuration parameters of the SAP CC Core Server
system to an XML file
• Import [page 12], and thus update, some configuration parameters into the corresponding SAP CC Core
Database system before restarting the relevant instances of the SAP CC system
Note
• If you want to change only one parameter in an SAP CC system or if you want to apply changes
temporarily, you can use:
• The app Manage SAP CC System Parameters in your SAP CC 2022 Cockpit user interface
• Or the set command of the Admin+ user interface
• You cannot configure all the SAP CC system settings with Config Tool. Use the SAP CC Setup Tool user
interface to configure some particular functions or data (business or technical) in an SAP CC system.
• If you want to transport some business data or master data, use the SAP CC Core Tool user interface
Remember
Check that your license is always valid. Otherwise, you cannot access to all the commands.
Refer to your tasks and the corresponding procedures [page 7] to work efficiently during the project
implementation phase or during the production operation phase
Config Tool
4 PUBLIC Config Tool
File and Format
Config Tool manages dedicated XML (Extensible Markup Language) files. The character encoding is UTF-8 to
support many languages.
The SAP CC Cockpit user interface supports these files. In the app Manage SAP CC System Parameters,
consult the available tasks:
• 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 2022 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 [page 10] 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>
Config Tool
Config Tool PUBLIC 5
1.2.1 Launching Config Tool
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.
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\ for Microsoft Windows
• /usr/sap/<SID>/CCD<SAP_INST_NB>/script/ for Linux and UNIX operating systems
Where <SID > is the unique SAP system ID and <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 [page 9] and arguments. In a system
console, type:
• config.bat <COMMAND_AND_ARGS> for Microsoft Windows
• config.sh <COMMAND_AND_ARGS> for Linux and UNIX operating systems
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:
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.
Config Tool
6 PUBLIC Config Tool
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 2022 Security Guide to get information on communication security and user rights to
perform the commands described in this documentation.
You can use the help command of the user interface to list the commands [page 9] 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.
1.3 Tasks
You use Config Tool regularly or exceptionally to inspect or configure the Core Server system.
• 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
To inspect some parameters or to create a report with the persistent values, just use the configuration export
[page 10] command.
Config Tool
Config Tool PUBLIC 7
1.3.2 Configuring 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 [page 6] Config Tool to first export [page 10] 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 2022 System Parameter Reference
• Import [page 12] 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
Apply the following procedure to transport the parameters from a source SAP CC Core Server system to a
target SAP CC system:
Config Tool
8 PUBLIC Config Tool
1.3.4 Copying an SAP CC system
To copy an SAP CC Core Server system from one system landscape to another landscape, refer to the Copying
an SAP CC Core Server procedure of the SAP CC 2022 Installation and Maintenance Guide documentation.
1.4 Commands
Note
You can use the following commands to complete your daily or occasional tasks [page 7]. Access to your
information quickly:
about [page 9]
To view the About information and version of SAP CC Config Tool.
1.4.1 about
Command Usage
• Microsoft Windows:
config.bat about
./config.sh about
Config Tool
Config Tool PUBLIC 9
Alias
configtool
Detailed Information
The about command displays information about the version of your SAP CC Config Tool user interface.
Authorization
To work with this command in the user interface, you must have a specific role in your SAP CC user profile.
Refer to the SAP CC 2022 Security Guide documentation for more information about the necessary
authorizations.
Additional Information
Compare your displayed version number to the versions of all the instances in the SAP CC system by opening
the app Display System Status in SAP CC 2022 Cockpit.
Command Usage
• Microsoft Windows:
Config Tool
10 PUBLIC Config Tool
Command Arguments
Name Description
<TO_FILE_PATH> The name and the path of the XML file that will contain the
list of SAP CC system parameters and values
Detailed Information
The export command gets the persistent values of the system parameters of an SAP CC Core Server system
or of a particular type of system instances. Config Tool retrieves these values from the back-end database
system (SAP CC Core Database) and saves them to a new XML file. If the file already exists, the user interface
does not finalize the export operation and does not modify the existing file.
Use the all argument to export all the SAP CC system parameters. Otherwise precise the instance type of
the SAP CC system to restrict the export operation to. The other possible arguments are: rater, updater,
guider, bulkLoader, dispatcher, and taxer.
Example
Depending on your task, you can change the file and use the import [page 12] command. As of SP 1, you can
also work with SAP CC Cockpit.
Use
• create a report
• change the persistent values of a subset of parameters
• or transport a complete or partial list of parameters
Refer to your tasks and the corresponding procedures [page 7] for an efficient daily work during the project
implementation phase or during the productive operation phase.
Note
The exported persistent values may differ from the runtime values currently set in the running SAP CC
system.
Config Tool
Config Tool PUBLIC 11
Authorization
To work with this command in the user interface, you must have a specific role in your SAP CC user profile.
Refer to the SAP CC 2022 Security Guide documentation for more information about the necessary
authorizations.
Tip
You can export a subset of parameters with the app Manage SAP CC System Parameters in your SAP CC 2022
Cockpit user interface.
Command Usage
• Microsoft Windows:
Command Arguments
Name Description
<FROM_FILE_PATH> The name and the path of the XML file that contains the new
configuration of the SAP CC system
Detailed Information
The import command manages a large set of SAP CC system parameters that are defined in a customized
XML file.
• Config Tool connects to the back-end database system (SAP CC Core Database) that relates to your SAP
CC Core Server system
• The user interface retrieves the parameter values from the database and verifies the new values. Refer to
the SAP CC 2022 System Parameter Reference for more information about the parameter constraints of
an SAP CC Core Server system.
Config Tool
12 PUBLIC Config Tool
• Config Tool stores these parameters into the back-end database system
Caution
The import command will change the parameter values stored in the back-end database system (SAP CC
Core Database). There is no undo command. SAP SE recommends that you first export the parameters to
a backup file that can be used to restore the SAP CC system.
Prerequisites
• You have prepared your file by using previously the export [page 10] command to have a recent version of
the parameters
• You know the types of instances that must be restarted in the SAP CC Core Server system
File Format
The file format is XML. See the definition details [page 5].
Results
You can restart the SAP CC system or the necessary instances of the system to take the changes into account.
Caution
In a high-availability (HA) environment, you sequentially restart the rater instances available in an SAP CC
system.
Use
You use the import command to change a list of parameters or to transport a list of parameters. Refer to your
tasks and the corresponding procedures [page 7] for an efficient daily work during the project implementation
phase or during the productive operation phase.
Authorization
To work with this command in the user interface, you must have a specific role in your SAP CC user profile.
Refer to the SAP CC 2022 Security Guide documentation for more information about the necessary
authorizations.
Tip
You can export a subset of parameters with the app Manage SAP CC System Parameters in your SAP CC 2022
Cockpit user interface.
Config Tool
Config Tool PUBLIC 13
1.4.4 configuration check
Command Usage
• Microsoft Windows:
Detailed Information
The check command verifies some parameter values in the SAP CC system parameters stored in the back-end
database system. Refer to the SAP CC 2022 System Parameter Reference for more information about the
parameter constraints of an SAP CC Core Server system.
Use
You do not need to use this command. Config Tool performs these verifications during the import operation
[page 12].
Note
Do not manually use this command. The SAP installer (SL Common GUI) uses this command during the
upgrade of your SAP system or during the implementation of a support package (SP) or a patch level.
Authorization
To work with this command in the user interface, you must have a specific role in your SAP CC user profile.
Refer to the SAP CC 2022 Security Guide documentation for more information about the necessary
authorizations.
Config Tool
14 PUBLIC Config Tool
1.4.5 configuration help
Command Usage
• Microsoft Windows:
Authorization
To work with this command in the user interface, you must have a specific role in your SAP CC user profile.
Refer to the SAP CC 2022 Security Guide documentation for more information about the necessary
authorizations.
1.4.6 help
Command Usage
• Microsoft Windows:
config.bat help
./config.sh help
Detailed Information
The help command lists the commands that are available in the SAP CC Config Tool user interface.
Config Tool
Config Tool PUBLIC 15
Authorization
To work with this command in the user interface, you must have a specific role in your SAP CC user profile.
Refer to the SAP CC 2022 Security Guide documentation for more information about the necessary
authorizations.
FAQs
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.
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
Config Tool
16 PUBLIC Config Tool
In SAP ONE Support Launchpad:
• SAP Customers and SAP Partners can search for Config Tool information from support.sap.com/notes (the
component name is IS-CC
• They can also use the feature https://support.sap.com/en/my-support/knowledge-base.html
Use SAP CC Cockpit
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 2022 Cockpit user interface.
1.6 Troubleshooting
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.
Config Tool
Config Tool PUBLIC 17
Important Disclaimers and Legal Information
Hyperlinks
Some links are classified by an icon and/or a mouseover text. These links provide additional information.
About the icons:
• Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your
agreements with SAP) to this:
• The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.
• SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.
• Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering an SAP-hosted Web site. By using
such links, you agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this
information.
Example Code
Any software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax
and phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of
example code unless damages have been caused by SAP's gross negligence or willful misconduct.
Bias-Free Language
SAP supports a culture of diversity and inclusion. Whenever possible, we use unbiased language in our documentation to refer to people of all cultures, ethnicities,
genders, and abilities.
Config Tool
18 PUBLIC Important Disclaimers and Legal Information
Config Tool
Important Disclaimers and Legal Information PUBLIC 19
www.sap.com/contactsap
SAP and other SAP products and services mentioned herein as well as
their respective logos are trademarks or registered trademarks of SAP
SE (or an SAP affiliate company) in Germany and other countries. All
other product and service names mentioned are the trademarks of their
respective companies.