Product backend commands

KSC server may communicate with product backends via product backend commands. To receive and process product backend commands client should subscribe to "KLSRV_EV_PROD_BACKEND_CMD" event using event polling mechanism (Event polling usage). Client which is able to process or forward product backend commands is also referred as "Service console".

"KLSRV_EV_PROD_BACKEND_CMD" event fields

Attribute	Type	Description
CMD_ID	paramString	command id
CMD_PROD_NAME	paramString	product name
CMD_PROD_VERSION	paramString	product version

Subscription to "KLSRV_EV_PROD_BACKEND_CMD" event must always contain filter with non-empty values for "CMD_PROD_NAME" and "CMD_PROD_VERSION", otherwise subscription will be rejected.

When client receives "KLSRV_EV_PROD_BACKEND_CMD" it should use ServiceNwcCommandProvider methods to get command parameters and provide with command results.

To be able to process product backend commands client must have Execute right to "FUNC_AREA_PRODUCT_INTEGRATION".

Command description

Each backend command has following attributes:

Attribute	Type	Description
CMD_NAME	paramString	Command name
CMD_PROD_NAME	paramString	Product name
CMD_PROD_VERSION	paramString	Product version
CMD_PARAMS	params	Command-specific parameters

Command errors

Each command may finish with error. Service console passes error as (paramParams) container with following fields:

Attribute	Type	Description	Optional
CMD_ERR_STR_ID	paramString	One of known errors defined in this document. This is the only field understood and analyzed by KSC server. See errors list below	Optional
CMD_ERR_ORIGINATOR_ID	paramString	Error originator identity. Value chosen arbitrarily by error originator and aims to help to identify problem source
CMD_ERR_ID	paramInt	Error id as defined by error originator. Not understood by KSC, but may be understood by command initiator	Optional
CMD_ERR_DESCR	paramString	Human-readable error description
CMD_ERR_LOC_DESCR	paramString	Human-readable localized error description	Optional
CMD_ERR_FNAME	paramString	Source file where error generated	Optional
CMD_ERR_LNUMBER	paramInt	Line number where error generated	Optional

List of common known errors:

Error string id	Description
ERR_NO_BACKEND	Command cannot be routed to product backend
ERR_NOT_SUPPORTED	Command not supported by product backend
ERR_UNKNOWN_TOKEN	Authorization token not provided or unknown to product backend
ERR_EXPIRED_TOKEN	Authorization token expired

See also:

ServiceNwcCommandProvider

List of supported backend commands

Event polling usage