Service Communication Proxy Properties

SCP Configuration Properties describes the properties for configuring SBA Gateway for use with a Service Communication Proxy (SCP) to process Converged Charging and Spending Limit Control messages.

Table 1. SCP Configuration Properties
Property	Description
scp.enabled	When this property is set to `true`, Service Communication Proxy (SCP) support is enabled. The default value is `false`.
scp.urls	The SCP URL(s).
scp.timeout	How long to wait in milliseconds for a response from the SCP before moving to the next URL. This property applies only when more than one URL is specified. Set this property to `-1` to disable it. The default value is `10000`.
scp.scpEnabledHeaders	Global headers to send to the SCP.
scp.responseHeaders	The HTTP headers to set in the response, if they are not already set in the mapping. The default value is the following: `3gpp-Sbi-Binding: "bl=nf-instance; nfinst=${gateway.nfInstanceId}"`
scp.convergedCharging.enabled	When this property is set to `true`, Service Communication Proxy (SCP) support for Converged Charging is enabled. The default value is `false`.
scp.convergedCharging.delegatedDiscovery	When this property is set to `true`, it determines how the `3gpp-sbi-target-apiRoot` and the SCP path are built. If this property is set to `true`, the `3gpp-sbi-target-apiRoot` is the root of the `notifyUri`. The SCP path is the selected SCP URL plus the `scpDefaultSubNotifyUri` (or just the selected SCP URL if `scpDefaultSubNotifyUri` is empty). If this property is set to `false`, the `3gpp-sbi-target-apiRoot` is the root of the `notifyUri`. The SCP path is the selected SCP URL plus the path of the `notifyUri`. The default value is `true`.
scp.convergedCharging.allowedEndpoints	The endpoints to which SCP headers are added. The default value is `chargingDataCreate`, which is defined by the `nf.endpoints` property in the nf-defaults.yaml file.
scp.convergedCharging.scpDefaultSubNotifyUri	When `delegatedDiscovery` is `true`, the value of this property is appended to the SCP path.
scp.convergedCharging.notifyRequestHeaders	The headers to send with the incoming request to the SCP. To clear a header from `responseHeaders`, set the value to an empty string. The default value is `3gpp-Sbi-callback: "Nchf_ConvergedCharging_Notify"`.
scp.spendingLimitControl.enabled	When this property is set to `true`, Service Communication Proxy (SCP) support for Spending Limit Control is enabled. The default value is `false`.
scp.spendingLimitControl.delegatedDiscovery	When this property is set to `true`, it determines how the `3gpp-sbi-target-apiRoot` and the SCP path are built. If this property is set to `true`, the `3gpp-sbi-target-apiRoot` is the root of the `notifyUri`. The SCP path is the selected SCP URL plus the `scpDefaultSubNotifyUri` (or just the selected SCP URL if `scpDefaultSubNotifyUri` is empty). If this property is set to `false`, the `3gpp-sbi-target-apiRoot` is the root of the `notifyUri`. The SCP path is the selected SCP URL plus the path of the `notifyUri`. The default value is `true`.
scp.spendingLimitControl.allowedEndpoints	The endpoints to which SCP headers are added. The default value is `spendingLimitCreate`, which is defined by the `nf.endpoints` property in the nf-defaults.yaml file.
scp.spendingLimitControl.scpDefaultSubNotifyUri	When `delegatedDiscovery` is `true`, the value of this property is appended to the SCP path.
scp.spendingLimitControl.notifyRequestHeaders	The headers to send with the incoming request to the SCP. To clear a header from `responseHeaders`, set the value to an empty string. The default value is `3gpp-Sbi-callback: "Nchf_SpendingLimitControl_Notify"`.

The following gateway.yaml excerpt shows the common configuration default values (where defaults exist) for these properties:


# Settings relating to the SCP (Service Communication Proxy)
scp:
  # Is SCP Support Enabled?
  enabled: false
  # The URL of the SCP
  urls: []
  # How long to wait (milliseconds) for a response from the SCP before moving to next URL (set to -1 to disable). This is only active when more than one URL is specified.
  timeout: 10000

  scpEnabledHeaders: []
  # Global headers to send to the SCP
  responseHeaders:
    3gpp-Sbi-Binding: "bl=nf-instance; nfinst=${gateway.nfInstanceId}"
  convergedCharging:
    # Enable the SCP for Converged Charging
    enabled: true
    # Changes how the 3gpp-sbi-target-apiRoot and the SCP path is constructed
    # If true, 
    #  - 3gpp-sbi-target-apiRoot: it will be the root of the notifyUri
    #  - SCP path: it will be the selected scp url + scpDefaultSubNotifyUri (or just selected scp url if scpDefaultSubNotifyUri is empty)
    # If false
    #  - 3gpp-sbi-target-apiRoot: it will be the root of the notifyUri
    #  - SCP path: it will be the selected scp url + the path of the notifyUri
    delegatedDiscovery: true
    # Send response headers only if endpoint matches
    # By default, we only send on CREATE
    allowedEndpoints:
      - chargingDataCreate
    scpDefaultSubNotifyUri: ""
    # Specify headers to send with the request to the SCP
    # To clear a header from responseHeaders, set the value to an empty string
    notifyRequestHeaders:
      3gpp-Sbi-callback: "Nchf_ConvergedCharging_Notify"
  spendingLimitControl:
    # Enable the SCP for Spending Limit Control
    enabled: true
    # Changes how the 3gpp-sbi-target-apiRoot and the SCP path is constructed
    # If true, 
    #  - 3gpp-sbi-target-apiRoot: it will be the root of the notifyUri
    #  - SCP path: it will be the selected scp url + scpDefaultSubNotifyUri (or just selected scp url if scpDefaultSubNotifyUri is empty)
    # If false
    #  - 3gpp-sbi-target-apiRoot: it will be the root of the notifyUri
    #  - SCP path: it will be the selected scp url + the path of the notifyUri
    delegatedDiscovery: true
    scpDefaultSubNotifyUri: ""
    # Send response headers only if endpoint matches
    # By default, we only send on CREATE
    allowedEndpoints:
      - spendingLimitCreate
    # Specify headers to send with the request to the SCP
    # To clear a header from responseHeaders, set the value to an empty string
    notifyRequestHeaders:
      3gpp-Sbi-callback: "Nchf_SpendingLimitControl_Notify"