Below are overviews of how to deploy the CDR resource adaptor, its output format, and how to force immediate deactivation of a CDR resource adaptor entity.

Deploying the CDR resource adaptor

The CDR resource adaptor comes packaged in a deployable unit: cdr-ra-du.jar. It has a single dependency, on the Google Protobuf library. Protobuf deployable unit protobuf-library.du.jar is delivered with the CDR resource adaptor package.

The CDR resource adaptor does not come with a deployment script. Instead, an example service, distributed as part of the CDR resource adaptor package, includes a script that installs and configures the resource adaptor for that example. Developers and administrators should refer to the example script for the exact steps and adjust them to their own needs. The basic procedure is:

  1. Deploy the Protobuf library.

  2. Deploy the CDR resource adaptor.

  3. Create a CDR resource adaptor entity.

  4. Bind the CDR resource adaptor entity to a link name expected by the service.

Output format

A CDR resource adaptor entity can be configured to produce either binary or text CDR files.

Binary output format Text output format

Defined in the Google Protobuf definition CdrFileFormat.proto (can be found in the CDR resource adaptor package, under etc/).

The Protobuf definition can use tools and languages supported by the Protobuf project.

CdrFileFormat.proto defines a list of records, where a record is one of:

  • Header

  • FieldDescriptor

  • MessageDescriptor

  • BinaryCdr

  • StringCdr Footer

  • Timestamp

Note
See also
Binary CDR file format

The format of a text CDR file consists of:

  • an optional one-line header containing the creation time of the CDR file (if Header is True)

  • zero or more CDRs, one per line

  • an optional one-line footer containing the completion time of the CDR file (if Footer is True).

All lines end with the platform-default line ending (LF \n on Unix, CRLF \r\n on Windows).

The format of an individual CDR is controlled by the calling service.

Immediate deactivation of a resource adaptor entity

When deactivated, a CDR resource adaptor entity remains in the STOPPING state until all pending CDRs are written and the CDR files completed and archived. If you need a faster shutdown, you can administratively remove the "CDR deactivation guard activities" (listed using the findactivities rhino-console command), to force the resource adaptor to transition to the INACTIVE state immediately.

Warning If the node exits for any reason before the write/archive process completes, partial CDR files needing manual recovery may be left behind.
Previous page Next page