This chapter explains how to find and use the event data records (EDRs) that Oracle Communications Evolved Application Server (OCECAS) generates. This chapter also provides a table of the keys that represent activities in the EDRs. This information in this chapter is useful for developing and debugging SIP traffic.
EDRs record details of events that occur while OCECAS is processing traffic or performing management operations. Unless you specifically filter them out, EDRs are generated for every service performed, including all voice, IFR, WebRTC, or data calls. EDRs are also generated for OCECAS management actions, interactions with applications, and with network nodes. EDRs are stored in files that have a configurable life cycle.
EDRs are stored in the OCECAS Management System domain in Middleware_home/occas/sdc-root/sdc/sdc_1/user_projects/domains/sdc_management_domain/servers/mgmt1/edr
EDR files that are open for writing use this syntax: NodeID.open, for example testing3.open. Here, NodeID is the hostname of the system running the ECAS implementation.
Closed EDR filenames use this syntax:
environmentID_-_running_count.YYYYMMDD_-_time+UTC_offset
Where:
envirnmentID is the OCECAS component generating the EDRS.
running_count is the number of EDR files generated. The count starts with 1 and increments.
YYYYMDD is the date format.
time is the local time.
UTC_offset is the number of time zones from UTC.
For example, this EDR filename: ecas_-_1.20150616_-_0315+1200 is a closed EDR file generated by the ecas node. The 1 indicates that it is the first EDR file generated; the date indicates that the file was closed on June 16th, 2015 at 03:14 in the time zone 12 hours ahead of UTC.
This example EDR is generated by creating a control flow:
web.URL=/api/change-sets/2/control-flows/pid/11/diffs|pfm.dom=sdc_management_
domain|web.mth=POST|web.rht=dhcp-uk-IP_address.uk.oracle.com|web.usr=user|
web.res=200|web.rqt=2015-03-02T15:08:20.967Z|
Table 7-1 list the important management node EDR fields.
Table 7-1 EDR Platform Identification Fields.
| EDR Field | Parent PID | Added By | Name | Description | Examples |
|---|---|---|---|---|---|
|
pfm.dom |
200.1 |
Evolved Communications |
Domain Name |
The domain that generated the EDR. Used to filter EDRs generated from various domains. |
scf_staging_domain, scf_production_domain |
|
pfm.srv |
200.2 |
Evolved Communications |
Server Name |
The name of the managed server. |
engine1, engine2, mgmt1 |
A SIP session call generated this example URD:
pfm.srv=engine1|pfm.dom=scf_testing_domain|call.relc=400|udr.pvd=MVNO1| call.spmt=REGISTER|chs.cfn=SIP REGISTER|call.sedt=2015-03-02T15:02:39.960Z| call.cid=5c72cec76eb29c78c4eb5f01abe878e3@127.0.0.1|chs.dep=21|call.pcl=SIP| chs.tfn=ST-1-1-27,INCS-216-1-37,STRE-55-1-65,COPY-2-2-77,COPY-4-2-88, COPY-6-1-104,COMP-135-3-115,COMP-9-1-125,COPY-76-1-144,COPY-109-1-165, COPY-88-1-180,COMP-38-1-191,STRE-39-1-197,DTO-37-1-212,COMP-60-1-223, COPY-61-1-240,COPY-215-2-253,CPDT-22-3-385,STRE-24-1-389, COPY-27-1-399,COMP-106-2-407,COPY-31-1-419,COMP-65-1-427,COMP-62-1-458, EXCT-69-1-469,EXCT-70-1-480,CPRL-66-3-497,STRE-68-1-501,AEDR-85-1-511, TSST-72-2-564,REL-203-1-571,END-204|call.ssdt=2015-03-02T15:02:39.270Z| call.roam=true|chs.cst=3|
Runtime EDRs record the activities that the SIP session traverses during session processing. The activities are referenced using the Activity fast keys. Fast keys are three and four-letter abbreviations that represent individual activities. Table 7-5 lists the fast keys.
Table 7-2 lists the Runtime EDR node fields.
| EDR Field | Parent PID | Added By | Name | Description | Examples |
|---|---|---|---|---|---|
|
call.ssdt |
100.1 |
Evolved Communications |
Start Datetime |
UTC Datetime when service is triggered on the environment. This is not the call establishment time and you should not use it for billing purposes. |
Date time in YYYY-mm-hhThh:mm:ss.SSS format. For example, 2015-09-08T20:55:09.006Z |
|
call.dg |
100.2 |
Evolved Communications |
Calling URI |
The SIP message calling URI. Derived from the /CallInfo/CallingParty/Uri in context fields. |
sip:alice@atlanta.com, tel:+358-555-1234567 |
|
call.cld |
100.3 |
Evolved Communications |
Calling URI |
The SIP message called URI. Derived from the /CallInfo/CallingParty/Uri context fields. |
sip:bob@biloxy.com, tel:+358-555-1234568 |
|
call.rcld |
100.4 |
Evolved Communications |
Redirected Called URI |
When Evolved Communications redirects the original called URI to another URI, then this EDR field contains the redirected URI. The cld EDR Field contains the Original Called URI. |
sip:bob@biloxy.com, tel:+358-555-1234568 |
|
call.ctyp |
100.5 |
An activity |
Call Type |
An informal description of the call type defined in the control flow. |
origination, termination, and so on. |
|
call.b2br |
100.6 |
Evolved Communications |
B2B Session Result |
The result of B2B session establishment, coded as an integer value: |
1 |
|
call.b2st |
100.7 |
Evolved Communications |
B2B Session Start Time |
The UTC datetime set when the B2B session was established. |
Date time in YYYY-mm-hhThh:mm:ss.SSS format. For example: 2015-09-08T20:58:19.046Z |
|
call.b2et |
100.8 |
Evolved Communications |
B2B Session End Time |
The UTC datetime set when the B2B session ended. |
Date time in YYYY-mm-hhThh:mm:ss.SSS format. For example: 2015-09-08T20:58:40.012Z |
|
call.dcld |
100.10 |
Evolved Communications |
Diverted Call URI |
Only present if a service rule diverts the call. |
sip:bob@biloxy.com |
|
call.drul |
100.11 |
Evolved Communications |
Call Diversion Rule |
Identifies the service rule that diverted the call. |
The options are:
|
|
call.relc |
100.12 |
Evolved Communications |
SIP Release Cause |
The SIP cause value that releases the calling party |
200 (Normal Release) |
|
call.spmt |
100.14 |
Evolved Communications |
SIP Initiation Method |
SIP method that initiated the session |
INVITE, REGISTER, and so on. |
|
call.sedt |
100.15 |
Evolved Communications |
End Datetime |
The UTC datetime that the service ended on the environment |
Date time in YYYY-mm-hhThh:mm:ss.SSS format, For example: 2015-09-08T20:58:49.210Z |
|
call.cid |
100.16 |
Evolved Communications |
SIP Call ID |
The SIP ID used to identify the call |
a84b4c76e66710@pc33.atlanta.com |
|
call.pcl |
100.17 |
Evolved Communications |
Protocol |
The protocol that initiated the session |
SIP, Diameter, and so on. |
|
call.bar |
100.18 |
Evolved Communications |
Call Barred |
A binary value that indicates whether the call has been barred |
True/False |
|
call.roam |
100.19 |
An activity |
Call Roaming |
A binary value that indicates whether the call is a roaming call |
True/False |
|
call.dtry |
100.20 |
An activity |
Country Code |
The ISO 3166-1 alpha 3 country code of country that subscriber is registered in |
GBR, USA, NZL and so on. |
|
call.rgstn |
100.21 |
An activity |
Registration |
The registration operation |
reg, rereg, or dereg |
|
chs.cst |
500.1 |
Evolved Communications |
Change Set ID |
The change Set ID used to execute the flow |
An integer for Change Set Id. |
|
chs.cfn |
500.2 |
Evolved Communications |
Control Flow Names |
The names of control flows executed, including bootstrap flow name |
SIP INVITE, Session Origination, and so on. |
|
chs.tfn |
500.3 |
Evolved Communications |
Activities traversed |
Lists the activities traversed during flow execution |
ST-1-1-17,FILL-5-1-30,FILL-6-1-45,END-4. See Table 7-5 for a list of the activity fast keys. |
|
chs.dep |
500.4 |
Evolved Communications |
Deployment ID |
The deployment ID used during flow execution |
An integer for Deployment ID |
This example EDR was generated by provisioning a subscriber:
web.URL=/api/subscriber|pfm.dom=scf_udr_domain|web.mth=POST| web.rht=localhost.localdomain|web.usr=user|web.res=201| web.rqt=2015-03-02T15:09:05.166Z|
Table 7-3 lists the EDR fields for the UDR Node.
Table 7-3 EDR Fields for the UDR Node
| EDR Field | Parent PID | Added By | Name | Description | Examples |
|---|---|---|---|---|---|
|
web.mth |
300.1 |
Evolved Communications |
Web Request Method |
The RESTful request method name. GET requests do not generate EDRs. |
POST, PUT, DELETE |
|
web.URL |
300.2 |
Evolved Communications |
Web Request URL |
This URL is relative to the document root; not the full URL. |
/api/change-sets/214/service-data |
|
web.usr |
300.3 |
Evolved Communications |
User Name |
The login name of the user. |
test, and so on. |
|
web.rht |
300.4 |
Evolved Communications |
Remote Host |
The name of the remote Host that sent HTTP request to Evolved Communications. This field is taken from HTTP request header. |
localhost.localdomain |
|
web.rqt |
300.5 |
Evolved Communications |
Request Time |
The UTC datetime when the request arrived at Evolved Communications. |
Date time in YYYY-mm-hhThh:mm:ss.SSS format, For example: 2015-09-08T20:58:49.210Z |
|
web.res |
300.6 |
Evolved Communications |
HTTP Response Code |
HTTP Response Code |
200 (Success), 404 (Not Found), and so on. Refer to HTTP response codes for full list of values |
|
udr.pvd |
600.1 |
Evolved Communications |
Service Provider |
The service provider name. |
For example, MVNO1 |
|
udr.eec |
600.2 |
Evolved Communications |
UDR error code |
UDR error code. |
An integer representing the UDR error code. These are the same as HTTP status codes:
The error reasons are listed in the udr.eer field. |
|
udr.eer |
600.3 |
Evolved Communications |
UDR Error reason |
The UDR action error or status message. |
UDR error or status message corresponding to the error code in the udr.eec field:
|
You configure EDR file generation using the OCECAS Administration console.
Note:
You must be in Production Mode to change the EDR file configuration settings.To configure EDR file generation:
Start the Administration Console.
See "About the OCECAS Administration Console" for details.
In the Domain Structure panel on the upper left, select Evolved Communications.
The Evolved Communications Configuration page appears.
Click Lock and Edit.
Make the EDR file configuration changes that your implementation requires.
See Table 7-4 for the list of configuration parameters, their default values, and descriptions of their behavior.
Click Save to save your changes.
You have these options for configuring EDR file generation:
Table 7-4 EDR File Configuration Parameters
| EDR File Parameter | Default Value | Description |
|---|---|---|
|
Node Name |
ecas |
The informal name of the OCECAS node generating EDRs. |
|
Location of EDR Directory |
domain_home/sdc_management_domain/servers/mgmt1/edr |
Directory where EDR files are stored before they are moved to archive location. |
|
Maximum EDR file size: |
500 |
Maximum size (in kilobytes) of EDR file. When the file reaches this size, it is saved and another file is created. |
|
File Close Timeout |
1800 |
Duration of the file life seconds. After reaching this limit the file is closed and saved, and the next EDR file is opened for writing. |
|
Days to keep in EDR directory |
10 |
The time limit in days to keep the EDR file in the EDR directory. After this time expires, the EDR File is moved to the Archive location. |
|
Archive directory location: |
domain_home/sdc_management_domain/servers/mgmt1/edr/archive |
Directory location where EDR files are archived for storage. |
|
Days to keep in Archive directory: |
0 |
Number of days to keep EDR files in Archive directory, After this time limit the files are deleted. The default value (0) never deletes the files. |
|
Advanced - Filter to exclude EDRs based on Data |
NA |
EDRs that meet the filtering criteria are not written to EDR file. Default value is empty, so all EDRs are written to file. For example if you enter'.*web.mth=POST.*' for filter criteria, EDRs with the web request method of POST are not stored. |
|
Advanced - Configuration Cache Duration |
10000 |
Duration (in milliseconds) for which the EDR configuration is cached. This parameter determines how often the EDR configuration is read from the Oracle database by the management domain. Reading the database less often improves the EDR processing speed. The default value is 10000ms, that means the EDR configuration is cached for 10000 milliseconds. Note that EDR configuration changes are effective after they are refreshed. |
The Session Design Center UI supports a number of configurable activities that you use to build SIP calls in control flows and define SIP session behavior. Each activity has a fast key abbreviation that identifies in EDRs. Table 7-5 lists the fast key for each activity.
| Activity Name | Activity Fast Key |
|---|---|
|
Adjust Media |
ADJM |
|
Add EDR Field Value |
AEDR |
|
Alarm |
ALM |
|
Array Index |
AIDX |
|
Compare |
COMP |
|
Compare Data Time |
CPDT |
|
Compare Day of Week |
CPDW |
|
Compare List and Value |
CPRL |
|
Copy Value |
COPY |
|
Date Time Offset |
DTO |
|
End |
END |
|
End Charging Session |
ECS |
|
Event Charge |
EVTC |
|
Extract and Store String |
EXCT |
|
Find and Replace and Store Value |
FIND |
|
Generate and Document and Store |
DGOC |
|
Increment Statistic |
INCS |
|
Load Service Definition |
LSD |
|
Notes |
NOTE |
|
Prefix Tree Lookup |
PTLU |
|
Release |
REL |
|
Remote Copy |
RCPY |
|
Retrieve Session List |
RSL |
|
Route |
RTE |
|
Route Changed |
RTEC |
|
Run Control Flow |
RCF |
|
Run Service Definition |
RSD |
|
Run Web Service |
RWS |
|
Send Message |
SEND |
|
Start |
ST |
|
Start Back to Back Session |
SBBS |
|
Start Charging Session |
SCS |
|
Start Collecting Digits |
SCOL |
|
Start Conference Session |
CONF |
|
Start Playing Media |
SPLY |
|
Start Recording Message |
SREC |
|
Statistics Branching |
STB |
|
Stop Media |
STPM |
|
Store |
STRE |
|
Store Session Key |
STSK |
|
Sync Statistic |
SYNS |
|
Telemetry |
TELM |
|
Translate and Store Value |
TSST |
|
Update Charging Session |
UCS |
|
Update Profile |
UPDP |
|
Wait For Event |
WFEV |