The ECE SDK includes sample programs that demonstrate how to use the ECE API for sending requests to ECE.

You can use these sample programs in the following ways:

• Use the sample programs as code samples for calling the ECE APIs.

• Use the sample programs as code samples for writing custom applications.

• Run sample programs to send requests to ECE and receive responses.

  The sample programs print information about the messages exchanged.

• Use the sample program scripts to get an idea of the configuration and dependencies that are required for integrating the ECE client into your build system (Maven, Ant, and so on).

You can also look at the sample program source code to see how it works. For example, if you want to write a program that sends a unit-based debit request to ECE, examine SampleDebitRefund to:

• View the methods to use in your code.

• How to use the libraries and calls.

Table 24-1 shows the ECE SDK software directory structure, where ECE_home is the directory in which the ECE Server software is installed.

All of the sample programs can work with the ready-to-use sample data included with the ECE Server software installation. The sample programs are supported on the Linux platform.

Each sample program includes these supporting files:

• Source files to view or modify for your own applications

• Shell scripts to compile and run the sample programs

The sample programs use the generic .ecc script sdk_production_loader.ecc.

For a list of each sample program, their descriptions, the shell scripts used to compile and run them, and the applicable .ecc script, see:

• Usage Request Sample Programs

• Update Request Sample Programs

• Policy Request Sample Programs

• Query Request Sample Programs

• Extension Implementation Sample Programs

• Notification Sample Programs

• Custom Plug-In Sample Programs

To determine which parameter values you must use for running a sample program, you can use the sample script's help option. For descriptions of the methods the sample programs use, see oracle.communication.brm.charging.sdk in Elastic Charging Engine Java API Reference.

Table 24-8 lists the custom plug-in sample programs.

You compile and run a sample program with the shell script provided for that sample program.

To compile and run a sample program:

1. Open the ECE_home/config/eceTopology.conf file.

2. Uncomment the line where the sdkCustomerLoader node is defined.

   You are required to uncomment this line to be able to run the SDK sample programs.

   Caution:

   Do not run the customerLoader utility without the -incremental parameter in a production environment.

3. Go to the ECE server bin directory:

   cd ECE_home/bin

4. Load the ECE runtime environment:

   ./ecc 'load sdk_production_loader.ecc'

5. Go to the ECE SDK bin subdirectory that contains the shell script for compiling and running the sample program you want to run:

   cd ECE_home/ocecesdk/bin/sample_program_directory

   where sample_program_directory is extensions, notification, plugin, policy, query, update, or usage. See Table 24-1 for more information.

   For example, to compile and run the sample_voice_session.sh sample program (the sample program for sending a voice session usage request to ECE), you must be in the ECE_home/ocecesdk/bin/usage directory.

6. Compile the sample program:

   sh ./scriptname.sh build

   You must compile the sample program once.

   For example, to compile the sample_voice_session.sh sample program, enter:

   sh ./sample_voice_session.sh build

7. Run the sample program.

   sh. /scriptname.sh run

   Some programs require that you enter parameters. The run command output gives you information about what parameters are required. You can also run the command with no parameters to use default parameter values from the SDK scripts.

8. When you are done with the sample program, shut down the ECE runtime environment:

   ecc stop server

The following shows an example of how to run the SampleDebitRefundSession sample program.

sample_debit_refund_session.sh  build | run | defaultrun  userId  requestType  correlationId  [BALANCE_ELEMENT_ID,AMOUNT BALANCE_ELEMENT_ID,AMOUNT ...]  [TOTAL,IN,OUT TOTAL,IN,OUT ...]

where:

• build compiles the related SDK source files.

• run runs the SDK program (debit refund) according to the parameters you provide. You can supply the parameters in the command line or provide no parameters to run the program with default parameter values.

• defaultrun builds and runs the SDK program. No parameters are required. The program uses the default parameter specified inside the shell script.

• The order of parameters are fixed and if one optional parameter is provided then all values of other optional parameters must be supplied.

• requestType is either DEBIT_AMOUNT, REFUND_AMOUNT, DEBIT_UNIT, or REFUND_UNIT.

• DEBIT_AMOUNT or REFUND_AMOUNT, BALANCE_ELEMENT_ID is the well-known ISO code for balance elements, such as 840 for US Dollars or 95 for Included Minutes.

• DEBIT_UNIT or REFUND_UNIT, TOTAL, IN, and OUT must be specified with numbers in MB (megabytes).

For example, the following command debits 10 USD and 25 Included Minutes:

sample_debit_refund_session.sh run 650999777 DEBIT_AMOUNT CORR_ID 840,10 95,25

This example command refunds 50 USD and 5 Included Minutes:

sample_debit_refund_session.sh run 650999777 REFUND_AMOUNT CORR_ID 840,50 95,5

To compile and deploy the SampleRatedEventFormatterCustomPlugin sample program:

1. Configure Rated Event Formatter by doing the following:

   1. Access the ECE configuration MBeans in a JMX editor, such as JConsole. See "Accessing ECE Configuration MBeans".

   2. Expand the ECE Configuration node.

   3. Expand charging.ratedEventFormatters.Instance_Name, where Instance_Name is the name of the instance you want to configure such as ratedEventFormatter1.

   4. Expand Attributes.

   5. Set the pluginType attribute to oracle.communication.brm.charging.sdk.plugin.SampleRatedEventFormatterKafkaCustomPlugin.

2. Go to the ECE_home/ocecesdk/bin/plugin directory and then build the sample program:

   sh ./build_deploy_plugin.sh build SampleRatedEventFormatterKafkaCustomPlugin

3. Deploy the sample program:

   sh ./build_deploy_plugin.sh deploy SampleRatedEventFormatterKafkaCustomPlugin

4. Ensure that your Kafka Server is up and running.

5. Create a topic in your Kafka Server for the rated events.

   For example, this command creates a Kafka topic named RatedEvent:

   bin/kafka-topics.sh --create --bootstrap-server kafkaHost:port --replication-factor 1 --partitions 1 --topic RatedEvents

   where kafkaHost and port are the host and port that the Kafka client will connect to in a bootstrap Kafka cluster the first time it starts.

6. Wait until the entire configuration is ready and all components are up and running.

7. Perform usage, such as initiate, update, or terminate, for one of your customers.

   Rated events will be published to the Kafka topic in JSON format. Also, JSON information will be added to the ratedEventFormatter1.log file under the ECE_home/log directory.

8. Confirm that the event was published to the Kafka topic by running the Kafka console consumer:

   bin/kafka-console-consumer.sh --bootstrap-server kafkaHost:port --topic RatedEvents

9. When you are done with the sample program, shut down the ECE runtime environment:

   ecc stop server