Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

You open the SAP CC REST agent configuration dialog from a workflow configuration. To open the SAP CC REST agent configuration, click Build → New Configuration. Select Workflow from the Configurations dialog. When prompted to Select workflow type, select Realtime. Click Add agent and select SAP CC REST from the Agent Selection dialog.

Client Tab

The Client tab contains configuration data that is required to connect to a remote server.

...

Setting

Description

REST API

Choose between Charging Service or Loading Service API. This will allow the SAP CC REST agent to switch between the two services.

REST API Version

The version of the Charging Service or Loading Service API. Each of the API versions will have its specific services associated with it that can be viewed under View Supported Services.

View Supported Services

Shows the supported services within the API that is selected in the REST API and REST API Version fields.

Host

Add IP address or hostname of the SAP Convergent Charging instance on the SAP Cloud.

Port

Add the Charging or Loading port of the SAP Convergent Charging instance on the SAP Cloud.

API Path

The path for the API to access the content from the SAP Convergent Charging instance on the SAP Cloud.

Route Error UDR

When this option is selected, and there is any unexpected exception, an Error UDR will be sent as an output from the agent.

For example,

  • Connection Failure or timeout due to wrong host, port, or authorization credentials.

If this option is not selected, the error will not be routed.

For more information, refer https://infozone.atlassian.net/wiki/spaces/MD93UEPE4D/pages/319717377342392923/SAP+CC+REST+UDRs#errorUDR

Use TLS

Select to use TLS encrypted communication with Host. You will be able to browse and select the Security Profile with the necessary credentials.

For more information about Security Profile, refer to Security Profile.

Info

Info!

Refer to the Securing Communications with the Core Server System section in the SAP Convergent Charging Installation and Maintenance Guide for more information on how to apply TLS on the SAP CC server.

Authentication tab

The Authentication tab contains configurations related to the authentication required to establish a connection between the SAP CC REST agent and the SAP CC server.

...

Setting

Description

Authentication Type

Choose between the following authentication method for the SAP CC REST agent:

  • Basic - Standard username and password authentication method used to connect to the SAP CC server.

  • OAuth 2.0 - Use of tokens created using an OAuth2 authorization server based on two grant types supported by the agent. Client Credentials and Resource Owner Password Credentials.

Basic Authentication

Username

The username for accessing the SAP CC server.

Password

The password associated with the username.

OAuth 2.0 Authentication - Client Credentials

Grant Type

Select the grant type:

  • Client Credentials
    The agent fetches the access token from the Access Token URI during initialization, using client id and client secret for basic authentication. The credentials are base64 encoded and sent in the header of the request.
    The response contains an access token, which is then used in subsequent requests.

  • Resource Owner Password Credentials

    The agent fetches the access token from the Access Token URI during initialization, using the following credentials for authentication:

    • Client ID

    • Client Secret

    • Username

    • Password

    The credentials are sent in the body of the request. The response contains an access token, which is then used in subsequent requests. 

Client ID

Enter the unique client identifier issued by the authorization server.

Client Secret

Enter the client's secret.

Username

Enter the resource owner username, this can be the end-user granting access to a protected resource. This field is required when you have selected Resource Owner Password Credentials from the drop-down list Grant Type.

Password

Enter the password associated with the username. This field is required when you have selected Resource Owner Password Credentials from the drop-down list Grant Type.

Access Token URI

Enter the URI where the access token can be obtained.

Token Expiration Override (s)

Enter a time in seconds when you would like to refresh the access token prior to the expiration. This allows the application to obtain a new access token without the user's interaction. 

Additional Parameters

Some authentication servers may require additional parameters in the body of the token requests. To add a parameter, click the Add button and then enter the name of the parameter in the Key field and the value of the parameter in the Value field.

Do not use escape characters in the value field, these will be added automatically by the agent. For instance, "https://example.com/ " will be sent as "https%3A%2F%2example.com%2F".

Note

Note!

If an agent is configured on the Authentication Tab to use OAuth 2.0, an additional step may be required if the token needs to be obtained via HTTPS protocol.

The SAP CC REST agent internally uses the Java built-in HTTP Client to obtain a token. If a certificate is required to contact the authentication server, the proper certificate has to be put into the default certificates file for the respective JDK distribution used.

Example for OpenJDK 64-Bit Server VM Zulu17.40+19-CA

Code Block
cd $JAVA_HOME/lib/security
keytool -import -alias mycert -keystore cacerts -file oauth2Host.cert

Traffic Control Tab

The Traffic Control tab contains configurations required to control the request flow with the SAP CC Server.

...