get

Definition

To view the values of an SAP CC system parameter, a parameter list, or indicators

Command Usage

Command Arguments

Name	Description
<PARAM_NAME>	The technical name of the system parameter or indicator in the SAP CC Core Server 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 allows you to:

• display the list of all the system parameters and indicators that are available in a running SAP CC Core Server system or in specific instances to prepare your actions
• retrieve detailed information about a particular SAP CC system parameter or indicator to inspect in the SAP CC system

The detailed information includes the following elements:

Element	Runtime Value	Last Changed Value	Next Restart Value	Scope to specify in the command
System parameter	Yes	Yes	Yes	MEMORY, PERSISTENT, or ALL
Indicator	Yes	N/A	N/A	MEMORY or ALL

Use

You use this command to:

• view the values of a system parameter such as the runtime values (see the MEMORY scope) currently used by each the instances of the SAP CC Core Server system and the restart value (see the PERSISTENT scope) registered in the back-end database and only used when the SAP CC system or an instance restarts.
• list the available parameters and indicators to identify the parameters (and indicators) to view and inspect.

Viewing a System Parameter or an Indicator

When you are familiar with the system parameters of SAP CC, you can inspect a system parameter or an indicator quickly. In the Admin+ console, type get and specify the technical name of the parameter, the scope of the values, and the target instances in the running SAP CC Core Server system.

If no parameter name is specified (see <PARAM_NAME>), the get command returns the list of all the available system parameters and indicators.

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.
• Last Changed or Initial Value: The parameter value used at startup time; then the runtime value before an immediate change.
• Runtime or Memory Value: The parameter value at runtime, which is the current value used by an instance in the SAP CC system and may be changed online according to the access rights. The memory value can differ from the persistent value.
• Restart or Persistent Value: The parameter value that will be used in the case of a restart; the value is recorded in the back-end database. This value is defined for all the instances of the same type in the SAP CC system.

Depending on the access rights defined for each parameter, you can change:

• i) Both the current runtime value (MEMORY scope) and the restart value (PERSISTENT scope); The configuration change is immediate and permanent.
• ii) Only the runtime value; The change is immediate and temporary. When an instance restarts manually, automatically, or after a crash, it uses the restart value of the parameter registered in the back-end database.
• iii) Only the restart value; The change is differed and permanent.

You cannot change some parameters that are computed by the SAP CC system.

The get command retrieves the type and the values of the system parameter (or the indicator).

Listing the Available Parameters and Indicators

In the Admin+ console, type get to view the lists of the parameters and indicators that are available in the connected SAP CC Core Server system.

To limit the report to a particular type of instances in the SAP CC system, precise the target instance type in the command as an optional argument. In the console, type get <INST_TYPE> where <INST_TYPE> is a predefined keyword associated to an instance type. To view the list for another instance type, repeat your command.

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

        Available indicator list:
        +---------------------------------------+-------+--------------+
        |Name                                   |Type   |Instance Types|
        +---------------------------------------+-------+--------------+
        :                                       :       :              :
        +---------------------------------------+-------+--------------+

Where:

Column Name	Description
Name	The technical name of the indicator
Type	The type of the indicator: STRING, INTEGER, BOOLEAN, DATE, LONG
Instance types	The list of instance types that manage this indicator: bulkLoader, dispatcher, guider, rater, taxer, updater

        Available parameter list:
        +-----------------+---------+--------------+--------+-------------+--------------+
        |Name             |Type     |Instance Types|Optional|Source       |Default Value |
        +-----------------+---------+--------------+--------+-------------+--------------+
        :                 :         :              :        :             :              |
        +-----------------+---------+--------------+--------+-------------+--------------+

Where:

Column Name	Description
Name	The technical name of the system parameter
Type	The type of the system parameter (STRING, INTEGER, BOOLEAN, DATE, LONG)
Instance Types	The list of instance types. The possible keywords are: bulkLoader, dispatcher, guider, rater, taxer, updater
Optional	The optional state of the parameter (no, yes)
Source	The location where a parameter persistent value is saved (DB, FILE, INSTANCE_MAP, XML_GENERATED, INDICATOR, SYSTEM)
Default Value	The default value (factory settings) of the system parameter

Technical Operations

You use this command to view and inspect a system parameter or an indicator in the SAP CC Core Server system.

Troubleshooting Operations

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

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 values of an SAP CC system parameter
reset - To reset an SAP CC system parameter to its default value (factory settings)

Additional Information

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

Messages

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 parameter list:
indicator.list	Available indicator 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>