1 PACKAGE CCT_ServerDataInput_PUB AS
2 /* $Header: ccticiis.pls 120.0 2005/06/02 09:35:09 appldev noship $*/
3
4 G_PKG_NAME CONSTANT VARCHAR(80) := 'CCT_ServerDataInput_PUB';
5
6 /* start of comments
7 Record data for an Outbound (time, site, campaign, list) tuple combination.
8 Api name : Advanced_Outbound_Input
9 Type : Public
10 Pre-regs : None
11 Function : Record data to ICI Advanced Outbound table
12 Parameters :
13 :p_api_version IN NUMBER Required
14 Used by the API to compare the version numbers of incoming
15 calls to its current version number, returns an unexpected error
16 if they are incompatible.
17
18 :p_init_msg_list IN VARCHAR2 Optional
19 Default = FND_API.G_FALSE
20 The API message list must be initialized every time a program
21 calls an API.
22
23 :p_commit IN VARCHAR2 Optional
24 Default = FND_API.G_FALSE
25 Before returning to its caller, an API should check the value
26 of p_commit. If it is set to TRUE it should commit its work.
27
28 :p_validation_level IN NUMBER Optional
29 Default = FND_API.G_VALID_LEVEL_FULL
30 Determins which validation steps should be executed and which
31 should be skipped. Public APIs by definition have to perform FULL
32 validation on all the data passed to them
33
34 : x_return_status OUT VARCHAR2
35 Returns the result of all operations performed by the API
36
37 : x_msg_count OUT NUMBER
38 Holds the number of messages in the API message list.
39
40 : x_msg_data OUT VARCHAR2
41 Holds the message in an encoded format.
42
43 : p_time IN DATE Optional
44 Default = NULL
45 The time, to the minute, for this data. Input will be truncated
46 to the minute, and the data must be for the minute {yyyy-mon-dd
47 hh:mm:00.0} to {yyyy-mon-dd hh:mm:59.9}, local to the advanced
48 outbound server.
49
50 : p_site_id IN NUMBER Optional
51 Default = NULL
52 ID of the site. This is an index to the site definition table.
53
54 : p_site_name IN VARCHAR2 Optional
55 Default = NULL
56 Name of the site.
57
58 : p_campaign_id IN NUMBER Optional
59 Default = NULL
60 ID of the campaign. This is an index to the campaign definition table.
61
62 : p_campaign_name IN VARCHAR2 Optional
63 Default = NULL
64 Name of the campaign.
65
66 : p_list_id IN NUMBER Optional
67 Default = NULL
68 ID of the list. This is an index to the list definition table.
69
70 : p_list_name IN VARCHAR2 Optional
71 Default = NULL
72 Name of the list.
73
74 : p_busy_count IN NUMBER Optional
75 Default = NULL
76 Total occurences in this minute.
77
78 : p_connect_count IN NUMBER Optional
79 Default = NULL
80 Total occurences in this minute.
81
82 : p_answering_machine_count IN NUMBER Optional
83 Default = NULL
84 Total occurences in this minute.
85
86 : p_modem_count IN NUMBER Optional
87 Default = NULL
88 Total occurences in this minute.
89
90 : p_sit_count IN NUMBER Optional
91 Default = NULL
92 Total occurences in this minute. Standard identification tone?
93
94 : p_rna_count IN NUMBER Optional
95 Default = NULL
96 Total occurences in this minute. Ring no answer.
97
98 : p_other_count IN NUMBER Optional
99 Default = NULL
100 Total occurences in this minute.
101
102 : p_predictive_dials IN NUMBER Optional
103 Default = NULL
104 Total occurences in this minute. Dials in predictive mode.
105
106 : p_progressive_dials IN NUMBER Optional
107 Default = NULL
108 Total occurences in this minute. Dials in progressive mode.
109
110 : p_preview_dials IN NUMBER Optional
111 Default = NULL
112 Total occurences in this minute. Dials in preview mode.
113
114 : p_preview_time IN NUMBER Optional
115 Default = NULL
116 Total time agents spent previewing calls, this minute. In seconds.
117
118 : p_withdrawn_dials IN NUMBER Optional
119 Default = NULL
120 Totals dials that were later withdrawn, this minute.
121
122 : p_wait_time_average IN NUMBER Optional
123 Default = NULL
124 Average idle time for agents this minute. In seconds.
125
126 : p_wait_time_std_dev IN NUMBER Optional
127 Default = NULL
128 Standard deviation of idle time for agents this minute. In seconds.
129
130 : p_wait_time_cumulative_avg IN NUMBER Optional
131 Default = NULL
132 Average idle time for agents cumulative for today. In seconds.
133
134 : p_wait_time_cumulative_stddev IN NUMBER Optional
135 Default = NULL
136 Standard deviation of idle time for agents cumulative for today.
137 In seconds.
138
139 : p_wait_time_minimum IN NUMBER Optional
140 Default = NULL
141 Minimum idle time for agents this minute. In seconds.
142
143 : p_wait_time_maximum IN NUMBER Optional
144 Default = NULL
145 Maximum idle time for agents this minute. In seconds.
146
147 : p_wait_time_total IN NUMBER Optional
148 Default = NULL
149 Total idle time for agents this minute. In seconds.
150
151 : p_number_agents_predictive IN NUMBER Optional
152 Default = NULL
153 Number of agents working (predictive), sampled sometime this
154 minute.
155
156 : p_number_agents_outbound IN NUMBER Optional
157 Default = NULL
158 Number of agents working (outbound), sampled sometime this
159 minute.
160
161 : p_number_working_dialers IN NUMBER Optional
162 Default = NULL
163 Number of dialers working, sampled sometime this minute.
164
165 : p_abandon_count IN NUMBER Optional
166 Default = NULL
167 Total occurences in this minute.
168
169 : p_abandon_percentage IN NUMBER Optional
170 Default = NULL
171 Percentage in this minute.
172
173 : p_callback_count IN NUMBER Optional
174 Default = NULL
175 Total occurences in this minute.
176
177 : p_callback_percentage IN NUMBER Optional
178 Default = NULL
179 Percentage in this minute.
180
181 : p_outcome_1_count IN NUMBER Optional
182 Default = NULL
183 Total occurences in this minute. User-defined outcome 1.
184
185 : p_outcome_2_count IN NUMBER Optional
186 Default = NULL
187 Total occurences in this minute. User-defined outcome 2.
188
189 : p_outcome_3_count IN NUMBER Optional
190 Default = NULL
191 Total occurences in this minute. User-defined outcome 3.
192
193 : p_records_start_of_day IN NUMBER Optional
194 Default = NULL
195 Constant number.
196
197 : p_records_remaining IN NUMBER Optional
198 Default = NULL
199 Number of records remaining in list. Sampled sometime this minute.
200
201 : p_predicted_exhaustion_date IN DATE Optional
202 Default = NULL
203 Estimate until the list is exhausted.
204
205 : p_recs_to_be_released_in_1 IN NUMBER Optional
206 Default = NULL
207 Estimated number of records to be released in the next minute.
208
209 : p_recs_to_be_released_in_5 IN NUMBER Optional
210 Default = NULL
211 Estimated number of records to be released in the next 5 minutes.
212
213 : p_recs_to_be_released_in_15 IN NUMBER Optional
214 Default = NULL
215 Estimated number of records to be released in the next 15 minutes.
216
217 : p_recs_to_be_released_in_60 IN NUMBER Optional
218 Default = NULL
219 Estimated number of records to be released in the next hour.
220
221 Version : Current Version 1.0
222 Previous Version n/a
223 Initial Version 1.0
224
225 end of comments */
226
227 PROCEDURE Advanced_Outbound_Input
228 ( p_api_version IN NUMBER,
229 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
230 p_commit IN VARCHAR2 := FND_API.G_FALSE,
231 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
232 x_return_status OUT nocopy VARCHAR2,
233 x_msg_count OUT nocopy NUMBER,
234 x_msg_data OUT nocopy VARCHAR2,
235
236 p_time IN DATE := NULL,
237
238 p_site_id IN NUMBER := NULL,
239 p_site_name IN VARCHAR2 := NULL,
240 p_campaign_id IN NUMBER := NULL,
241 p_campaign_name IN VARCHAR2 := NULL,
242 p_list_id IN NUMBER := NULL,
243 p_list_name IN VARCHAR2 := NULL,
244
245 p_busy_count IN NUMBER := NULL,
246 p_connect_count IN NUMBER := NULL,
247 p_answering_machine_count IN NUMBER := NULL,
248 p_modem_count IN NUMBER := NULL,
249 p_sit_count IN NUMBER := NULL,
250 p_rna_count IN NUMBER := NULL,
251 p_other_count IN NUMBER := NULL,
252
253 p_predictive_dials IN NUMBER := NULL,
254 p_progressive_dials IN NUMBER := NULL,
255 p_preview_dials IN NUMBER := NULL,
256 p_preview_time IN NUMBER := NULL,
257 p_withdrawn_dials IN NUMBER := NULL,
258
259 p_wait_time_average IN NUMBER := NULL,
260 p_wait_time_std_dev IN NUMBER := NULL,
261 p_wait_time_cumulative_avg IN NUMBER := NULL,
262 p_wait_time_cumulative_stddev IN NUMBER := NULL,
263 p_wait_time_minimum IN NUMBER := NULL,
264 p_wait_time_maximum IN NUMBER := NULL,
265 p_wait_time_total IN NUMBER := NULL,
266
267 p_number_agents_predictive IN NUMBER := NULL,
268 p_number_agents_outbound IN NUMBER := NULL,
269 p_number_working_dialers IN NUMBER := NULL,
270 p_abandon_count IN NUMBER := NULL,
271 p_abandon_percentage IN NUMBER := NULL,
272 p_callback_count IN NUMBER := NULL,
273 p_callback_percentage IN NUMBER := NULL,
274
275 p_outcome_1_count IN NUMBER := NULL,
276 p_outcome_2_count IN NUMBER := NULL,
277 p_outcome_3_count IN NUMBER := NULL,
278
279 p_records_start_of_day IN NUMBER := NULL,
280 p_records_remaining IN NUMBER := NULL,
281 p_predicted_exhaustion_date IN DATE := NULL,
282 p_recs_to_be_released_in_1 IN NUMBER := NULL,
283 p_recs_to_be_released_in_5 IN NUMBER := NULL,
284 p_recs_to_be_released_in_15 IN NUMBER := NULL,
285 p_recs_to_be_released_in_60 IN NUMBER := NULL
286 );
287
288 /* ************************************************** */
289
290 /* start of comments
291 Record data for a Blending (time, site, media type, LOS category)
292 tuple combination.
293 Api name : Interaction_Blending_Input
294 Type : Public
295 Pre-regs : None
296 Function : Record data to ICI Interaction Blending table
297 Parameters :
298 :p_api_version IN NUMBER Required
299 Used by the API to compare the version numbers of incoming
300 calls to its current version number, returns an unexpected error
301 if they are incompatible.
302
303 :p_init_msg_list IN VARCHAR2 Optional
304 Default = FND_API.G_FALSE
305 The API message list must be initialized every time a program
306 calls an API.
307
308 :p_commit IN VARCHAR2 Optional
309 Default = FND_API.G_FALSE
310 Before returning to its caller, an API should check the value
311 of p_commit. If it is set to TRUE it should commit its work.
312
316 should be skipped. Public APIs by definition have to perform FULL
313 :p_validation_level IN NUMBER Optional
314 Default = FND_API.G_VALID_LEVEL_FULL
315 Determins which validation steps should be executed and which
317 validation on all the data passed to them
318
319 : x_return_status OUT VARCHAR2
320 Returns the result of all operations performed by the API
321
322 : x_msg_count OUT NUMBER
323 Holds the number of messages in the API message list.
324
325 : x_msg_data OUT VARCHAR2
326 Holds the message in an encoded format.
327
328 : p_time IN DATE Optional
329 Default = NULL
330 The time, to the minute, for this data. Input will be truncated
331 to the minute, and the data must be for the minute {yyyy-mon-dd
332 hh:mm:00.0} to {yyyy-mon-dd hh:mm:59.9}, local to the advanced
333 outbound server.
334
335 : p_site_id IN NUMBER Optional
336 Default = NULL
337 ID of the site. This is an index to the site definition table.
338
339 : p_site_name IN VARCHAR2 Optional
340 Default = NULL
341 Name of the site.
342
343 : p_media_type_id IN NUMBER Optional
344 Default = NULL
345 ID of the media type. This is an index to the media type
346 definition table.
347
348 : p_media_type IN VARCHAR2 Optional
349 Default = NULL
350 Name of the media type.
351
352 : p_los_id IN NUMBER Optional
353 Default = NULL
354 ID of the level of service category. This is an index to the
355 level of service definition table.
356
357 : p_los_name IN VARCHAR2 Optional
358 Default = NULL
359 Level of service category name.
360
361 : p_direction IN NUMBER Optional
362 Default = NULL
363 Type of LOS: Inbound (:= 1) or Outbound (:= 0)
364
365 : p_items_queued_count IN NUMBER Optional
366 Default = NULL
367 Number of items queued for this media type.
368
369 : p_items_serviced_count IN NUMBER Optional
370 Default = NULL
371 Number of items serviced for this media type.
372
373 : p_items_serviced_within_LOS IN NUMBER Optional
374 Default = NULL
375 Number of items serviced within LOS constraints for this media
376 type.
377
378 : p_items_not_serv_within_LOS IN NUMBER Optional
379 Default = NULL
380 Number of items not serviced within LOS constraints for this
381 media type.
382
383 : p_number_agents_working IN NUMBER Optional
384 Default = NULL
385 Number of agents currently working items of this media type.
386
387 : p_minimum_agents_required IN NUMBER Optional
388 Default = NULL
389 Minimum number of agents required by LOS category.
390
391 : p_items_left_to_be_serviced IN NUMBER Optional
392 Default = NULL
393 Number of items left to be serviced for an outbound LOS
394 category quota.
395
396 : p_items_serviced_today IN NUMBER Optional
397 Default = NULL
398 Number of items serviced, cumulative for today.
399
400 Version : Current Version 1.0
401 Previous Version n/a
402 Initial Version 1.0
403
404 end of comments */
405
406 PROCEDURE Interaction_Blending_Input
407 ( p_api_version IN NUMBER,
408 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
409 p_commit IN VARCHAR2 := FND_API.G_FALSE,
410 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
411 x_return_status OUT nocopy VARCHAR2,
412 x_msg_count OUT nocopy NUMBER,
413 x_msg_data OUT nocopy VARCHAR2,
414
415 p_time IN DATE := NULL,
416
417 p_site_id IN NUMBER := NULL,
418 p_site_name IN VARCHAR2 := NULL,
422 p_los_name IN VARCHAR2 := NULL,
419 p_media_type_id IN NUMBER := NULL,
420 p_media_type IN VARCHAR2 := NULL,
421 p_los_id IN NUMBER := NULL,
423
424 p_direction IN NUMBER := NULL,
425
426 p_items_queued_count IN NUMBER := NULL,
427 p_items_serviced_count IN NUMBER := NULL,
428 p_items_serviced_within_LOS IN NUMBER := NULL,
429 p_items_not_serv_within_LOS IN NUMBER := NULL,
430 p_number_agents_working IN NUMBER := NULL,
431 p_minimum_agents_required IN NUMBER := NULL,
432
433 p_items_left_to_be_serviced IN NUMBER := NULL,
434 p_items_serviced_today IN NUMBER := NULL
435 );
436
437 /* ************************************************** */
438
439
440 /* start of comments
441 Record data for a Multi Channel Manager (time, interaction classification)
442 tuple combination.
443 Api name : Multi_Channel_Manager_Input
444 Type : Public
445 Pre-regs : None
446 Function : Record data to ICI Multi Channel Manager table
447 Parameters :
448 :p_api_version IN NUMBER Required
449 Used by the API to compare the version numbers of incoming
450 calls to its current version number, returns an unexpected error
451 if they are incompatible.
452
453 :p_init_msg_list IN VARCHAR2 Optional
454 Default = FND_API.G_FALSE
455 The API message list must be initialized every time a program
456 calls an API.
457
458 :p_commit IN VARCHAR2 Optional
459 Default = FND_API.G_FALSE
460 Before returning to its caller, an API should check the value
461 of p_commit. If it is set to TRUE it should commit its work.
462
463 :p_validation_level IN NUMBER Optional
464 Default = FND_API.G_VALID_LEVEL_FULL
465 Determins which validation steps should be executed and which
466 should be skipped. Public APIs by definition have to perform FULL
467 validation on all the data passed to them
468
469 : x_return_status OUT VARCHAR2
470 Returns the result of all operations performed by the API
471
472 : x_msg_count OUT NUMBER
473 Holds the number of messages in the API message list.
474
475 : x_msg_data OUT VARCHAR2
476 Holds the message in an encoded format.
477
478 : p_time IN DATE Optional
479 Default = NULL
480 The time, to the minute, for this data. Input will be truncated
481 to the minute, and the data must be for the minute {yyyy-mon-dd
482 hh:mm:00.0} to {yyyy-mon-dd hh:mm:59.9}, local to the advanced
483 outbound server.
484
485 : p_interaction_center_id IN NUMBER Optional
486 Default = NULL
487 ID of the interaction center. This is an index to the interaction
488 center definition table.
489
490 : p_interaction_center_name IN VARCHAR2 Optional
491 Default = NULL
492 Name of the interaction center.
493
494 : p_interaction_class_id IN NUMBER Optional
495 Default = NULL
496 ID of the interaction classification. This is an index to the
497 interaction classification definition table.
498
499 : p_interaction_class_name IN VARCHAR2 Optional
500 Default = NULL
501 Name of the interaction classification.
502
503 : p_interactions_received IN NUMBER Optional
504 Default = NULL
505 Number of interactions received this minute.
506
507 : p_interactions_offered IN NUMBER Optional
508 Default = NULL
509 Number of interactions offered to agents this minute.
510
511 : p_interactions_answered IN NUMBER Optional
512 Default = NULL
513 Number of interactions answered by agents this minute.
514
515 : p_interactions_transferred IN NUMBER Optional
516 Default = NULL
517 Number of interactions transferred this minute.
518
519 : p_interactions_handled IN NUMBER Optional
520 Default = NULL
524 Default = NULL
521 Number of interactions handled (by agents or automation) this minute.
522
523 : p_interactions_abandoned IN NUMBER Optional
525 Number of interactions abandoned this minute. Technically,
526 abandoned calls are not interactions.
527
528 : p_speed_to_answer_avg IN NUMBER Optional
529 Default = NULL
530 Average speed to answer a call this minute. In seconds.
531 = p_speed_to_answer_total / p_interactions_answered
532
533 : p_speed_to_answer_std_dev IN NUMBER Optional
534 Default = NULL
535 Standard deviation for average speed to answer.
536
537 : p_speed_to_answer_total IN NUMBER Optional
538 Default = NULL
539 Total speed to answer time, in seconds.
540
541 : p_wait_to_abandon_avg IN NUMBER Optional
542 Default = NULL
543 Average wait to abandon a call this minute. In seconds.
544 = p_wait_to_abandon_total / p_interactions_abandoned
545
546 : p_wait_to_abandon_std_dev IN NUMBER Optional
547 Default = NULL
548 Standard deviation for average wait to abandon.
549
550 : p_wait_to_abandon_total IN NUMBER Optional
551 Default = NULL
552 Total wait to abandon, in seconds.
553
554 : p_percent_occupancy_rate IN NUMBER Optional
555 Default = NULL
556 0.0 <= percent <= 1.0
557 = p_total_talk_time / (p_total_talk_time + p_total_idle_time)
558
559 : p_percent_utilization_rate IN NUMBER Optional
560 Default = NULL
561 0.0 <= percent <= 1.0
562 = (p_total_talk_time + p_total_idle_time) / p_total_log_time
563
564 : p_percent_transfer_rate IN NUMBER Optional
565 Default = NULL
566 0.0 <= percent <= 1.0
567 = p_interactions_transferred / p_interactions_answered
568
569 : p_total_talk_time IN NUMBER Optional
570 Default = NULL
571 Total talk time in seconds.
572
573 : p_total_hold_time IN NUMBER Optional
574 Default = NULL
575 Total hold time in seconds.
576
577 : p_total_idle_time IN NUMBER Optional
578 Default = NULL
579 Total idle time in seconds.
580
581 : p_total_wrap_time IN NUMBER Optional
582 Default = NULL
583 Total wrap time in seconds.
584
585 : p_total_log_time IN NUMBER Optional
586 Default = NULL
587 Total log time in seconds.
588
589 Version : Current Version 1.0
590 Previous Version n/a
591 Initial Version 1.0
592
593 end of comments */
594
595 PROCEDURE Multi_Channel_Manager_Input
596 ( p_api_version IN NUMBER,
597 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
598 p_commit IN VARCHAR2 := FND_API.G_FALSE,
599 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
600 x_return_status OUT nocopy VARCHAR2,
601 x_msg_count OUT nocopy NUMBER,
602 x_msg_data OUT nocopy VARCHAR2,
603
604 p_time IN DATE := NULL,
605
606 p_interaction_center_id IN NUMBER := NULL,
607 p_interaction_center_name IN VARCHAR2 := NULL,
608 p_interaction_class_id IN NUMBER := NULL,
609 p_interaction_class_name IN VARCHAR2 := NULL,
610
611 p_interactions_received IN NUMBER := NULL,
612 p_interactions_offered IN NUMBER := NULL,
613 p_interactions_answered IN NUMBER := NULL,
614 p_interactions_transferred IN NUMBER := NULL,
615 p_interactions_handled IN NUMBER := NULL,
616 p_interactions_abandoned IN NUMBER := NULL,
617
618 p_speed_to_answer_avg IN NUMBER := NULL,
619 p_speed_to_answer_std_dev IN NUMBER := NULL,
620 p_speed_to_answer_total IN NUMBER := NULL,
621
622 p_wait_to_abandon_avg IN NUMBER := NULL,
623 p_wait_to_abandon_std_dev IN NUMBER := NULL,
624 p_wait_to_abandon_total IN NUMBER := NULL,
625
626 p_percent_occupancy_rate IN NUMBER := NULL,
627 p_percent_utilization_rate IN NUMBER := NULL,
628 p_percent_transfer_rate IN NUMBER := NULL,
629
630 p_total_talk_time IN NUMBER := NULL,
631 p_total_hold_time IN NUMBER := NULL,
632 p_total_idle_time IN NUMBER := NULL,
633 p_total_wrap_time IN NUMBER := NULL,
634 p_total_log_time IN NUMBER := NULL
635 );
636
637 End CCT_ServerDataInput_PUB;