All ProductsGlobal Search
Help Portal

get

Definition

To view the value of an SAP CC system parameter

Command Usage

Syntax

get <PARAM_NAME> [<SCOPE> [<INST_TARGETS> ...]]

get [<INST_TYPE>]

Command Arguments
Name Description
<PARAM_NAME> The name of the parameter or the name of the indicator of the SAP CC system
<SCOPE> Optional: The scope (MEMORY, PERSISTENT, or ALL); By default: MEMORY for indicators, ALL for parameters.
<INST_TARGETS> Optional: The target instances of the SAP CC Core Server system (from the instance IDs or instance types); By default: All the possible system instances relevant for the parameter.
<INST_TYPE> Optional: The type of the instance in the SAP CC system to limit the research

Detailed Information

The get command retrieves detailed information about a system configuration parameter or an indicator and displays the list of all the parameters and indicators that are available in an SAP CC Core Server system.

Recommendation

Refer to the SAP CC System Parameter Reference documentation for more information about the system parameters.

Use

This command allows you to access to the values of a parameter such as the runtime value (see the MEMORY scope) taken into account by the SAP CC system and the startup value (see the PERSISTENT scope) registered in the back-end database and only used when the SAP CC system or an instance restarts. The name of the system parameter (or the indicator) must be set as an argument.

If no parameter name is specified (see <PARAM_NAME>), the get command returns the list of all the available system parameters and indicators. If an instance type is specified, the list is limited to the parameters relevant to the type of the system instance. The get command retrieves the type and the value of the system parameter (or the indicator).

The SAP CC system manages different values for a parameter:

  • Default Value: The factory settings used by the reset command, which can differ from the initial installation settings.
  • Initial Value: The parameter value used at startup time
  • Memory Value: The parameter value at runtime, which is the current value used by the SAP CC system and may be changed online according to the access rights. The memory value can differ from the persistent value.
  • Persistent Value: The parameter value that will be used in the case of a restart; the value is recorded in the back-end database.

According to the access rights set for each parameter, you can change the current memory value or the persistent value only used at startup time.

Example

Type the following commands to list the available parameters and indicators:

  • get: All the parameters and indicators
  • get rater: All the parameters and indicators of the rater instances in the SAP CC system

Example

Type the following commands to retrieve detailed information:

  • get SYSTEM_ID: The SID (SAP ID)
  • get VERSION: The version number of the SAP CC system; This is the technical internal number and not the marketable release number.
  • get SERVICES_STATISTICS: The statistics about the use of the business and technical services provided by the SAP CC system.

Notes

  • There is no startup value defined for an indicator.
  • Use SAP CC Config Tool to export the complete list of the system parameters and their values for your SAP CC system.
  • The get command does not retrieve the configuration parameters and structures managed with SAP CC Setup Tool. Use this user interface to retrieve the current configuration settings.
Listing the Available Parameters and Indicators

The get command retrieves and displays the list of the available indicators, then the system parameters. 

        Available indicators list
        +---------------------------------------+-------+--------------+
        |Name                                   |Type   |Instance types|
        +---------------------------------------+-------+--------------+
        :                                       :       :              :
        +---------------------------------------+-------+--------------+
Column Name Description
Name The name of the parameter
Type The type of the parameter: STRING, INTEGER, BOOLEAN, DATE, LONG
Instance types List of instance types: bulkloader, dispatcher, guider, rater, taxer, updater 
        Available parameters list
        +-----------------+---------+--------------+--------+-------------+--------------+
        |Name             |Type     |Instance types|Optional|Source       |Default value |
        +-----------------+---------+--------------+--------+-------------+--------------+
        :                 :         :              :        :             :              |
        +-----------------+---------+--------------+--------+-------------+--------------+
Column Name Description
Name The name of the indicator
Type The type of the indicator (STRING, INTEGER, BOOLEAN, DATE, LONG)
Instance types List of instance types (bulkloader, dispatcher, guider, rater, taxer, updater)
Optional The optional state of the parameter (no, yes)
Source The source describes how a parameter persistent value is saved (DB, FILE, INSTANCE_MAP, XML_GENERATED, INDICATOR, SYSTEM)
Default value The default value of the parameter

Maintenance Operations

You use this command to monitor an indicator of the SAP CC system.

Example

Type the following commands to retrieve detailed information:

  • Free memory: get FREE_MEMORY
  • Status of the data cache dedicated to the customer master data: get SUBSCRIPTION_CACHE_STATUS
  • Statistics about the usage of the business and technical services: get SERVICES_STATISTICS

Troubleshooting Operations

You use this command to retrieve the values (runtime, startup) of a configuration parameter in the different instances of the SAP CC system.

Authorization

You must have a specific role in your SAP CC user profile. Refer to the SAP CC Security Guide for more information about the necessary authorizations.

See Also

list - To view the list of server instances of the connected SAP CC system and communication settings
set - To change the value of an SAP CC system parameter
reset - To reset an SAP CC system parameter to its default value

Additional Information

Consult the SAP CC System Parameter Reference documentation for more information about the system parameters that configure the business features or the technical features. This documentation details also the system indicators.

Message(s)

Code Message Action
err.missing_parameter Error: This command requires {number} argument(s).  
err.unknown_parameter Error: The parameter "{}" is unknown to the SAP CC system.  
err.unknown_scope Error: Unknown scope {scope}.  
err.bad_targets Error: Bad target: {target}.  
exception.unknown Error: The parameter {parameter} is unknown to the instance of the SAP CC system.  
exception.persistent_access Error: It is forbidden to access to the persistent value of an indicator.  
exception.bad_target Error: Bad target {target}.  
exception.concurrent_access Error: Concurrent access to the parameter {parameter}.  
no.param No parameters are available.  
param.list Available parameters list  
indicator.list Available indicators list  
yes yes  
no no  
parameters.name Name  
parameters.type Type  
parameters.optional Optional  
parameters.source Source  
parameters.default Default value  
parameters.instanceTypes Instance types  
parameter.name NAME  
parameter.access ACCESS  
parameter.value.memory MEMORY VALUE  
parameter.value.persistent PERSISTENT VALUE  
parameter.value.default DEFAULT VALUE  
parameter.value.init INITIAL VALUE  
scope.memory MEMORY  
scope.persistent PERSISTENT  
parameter.access.rw Read & Write (RW)  
parameter.access.r Read-Only (RO)  
parameter.value.unset <--Unset-->  
parameter.value.unknown <Unknown>  
parameter.value.hidden <Hidden>  
© Copyright 2013 SAP SE or an SAP affiliate company. All rights reserved.