log_subcase_phone
log_subcase_phone_list
Public Function log_subcase_phone(ByVal subcase_id As String, _
ByVal cont_first As String, ByVal cont_last As String, _
ByVal cont_phone As String, ByVal action_type As String, _
ByVal note_str As String, ByVal int_use As String, _
ByVal log_date As String, ByVal log_end_date As String, _
ByVal user_name As String, ByVal new_stat As String, _
ByVal cmit_title As String, ByVal cmit_notes As String, _
ByVal cmit_due As String, ByVal cmit_prior As Long, _
ByVal cmit_to As Boolean, ByVal gen_time_bombs As Boolean, _
ByVal int_fld1 As String, ByVal int_val1 As Long, _
ByVal int_fld2 As String, ByVal int_val2 As Long, _
ByVal str_fld1 As String, ByVal str_val1 As String, _
ByVal str_fld2 As String, ByVal str_val2 As String, _
ByVal date_fld1 As String, ByVal date_val1 As String) As Integer
Public Function log_subcase_phone_list(ByVal subcase_id As String, _
ByVal cont_first As String, ByVal cont_last As String, _
ByVal cont_phone As String, ByVal action_type As String, _
ByVal note_str As String, ByVal int_use As String, _
ByVal log_date As String, ByVal log_end_date As String, _
ByVal user_name As String, ByVal new_stat As String, _
ByVal cmit_title As String, ByVal cmit_notes As String, _
ByVal cmit_due As String, ByVal cmit_prior As Long, _
ByVal cmit_to As Boolean, ByVal gen_time_bombs As Boolean, _
Optional fld_list As Variant, Optional type_list As Variant, _
Optional val_list As Variant) As Integer
Description
These APIs are used to create a phone log against a subcase. The APIs allow for the assigning of notes and internal use only text. An action type is also specified. The action type is usually used to distinguish between incoming and outgoing calls. The contact for the phone call is also specified, as is the phone call ending time (for length of call calculations). A new status for the subcase can be set with this API. Additional fields can also be set as well as a time bomb (for the phone log), which allows notifications to be generated based on the event.
Optionally, you can also set a commitment with the note log. If you wish to set a commitment, you MUST set the commitment due date (cmit_due) and the commitement title (cmit_title). The commitment title usually comes from the user-defined list "COMMITMENT", but it does not have to for this API. Any string is acceptable. The other commitment fields are optional. You can add notes to the commitement , and a prior warning. Also, you must set if the commitment is to the contact or by the contact. The contact for the case is always used for the commitment contact.
The objid of the created log is returned in the FCCS object variable ret_objid.
The objid of the commitment log record is returned in the FCCS object variable ret_objid2.
The objid of the status change record is returned in the FCCS object variable ret_objid3.
Parameters
| Parameter Name | Required? | Description |
|---|---|---|
| subcase_id | Yes | The subcase to create the log for |
| cont_first | Yes | Phone call contact first name |
| cont_last | Yes | Phone call contact last name |
| cont_phone | Yes | Phone call contact phone number |
| action_type | No | The phone log action type code value. If left blank, default code is used |
| notes | No | The phone log text |
| int_use | No | Internal use only information |
| log_date | No | The date the log was created. If left blank, the current time is used |
| log_end_date | No | The date/time of the end of the phone call. If left blank, the log_date is used (i.e. a zero length phone call) |
| user_name | No | The user who created the log. If left blank, the current user performs the logging |
| new_stat | No | New status for the subcase. If blank (""), no status change is performed |
| cmit_title | No | Title of the commitment. If blank, no commitment is generated |
| cmit_notes | No | If generating a commitment, optional notes for the commitment (max length of 255) |
| cmit_due | No | When is the commitment due. If blank, no commitment is generated |
| cmit_prior | No | How long (in seconds) before the commitment is due should a warning business rule notification be fired. If set to 0, no warning is generated |
| cmit_to | Yes | Is the commitment made to the customer (=True), or by the customer (=False). If no commitment is to be generated, this value is ignored |
| gen_time_bombs | Yes | Should a time_bomb be generated (for notifications/business rules). |
| int_fld1, int_fld2 str_fld1, str_fld2 date_fld1 |
No | Names of additional fields to write |
| int_val1, int_val2 str_val1, str_val2 date_val1 |
No | Values for the additional fields. These values are only used if the corresponding field name field is filled with a valid field name |
| fld_list | Yes | List of additional field names to write. List must be present, but does not need to have any items in the list |
| type_list | Yes | List of additional field data types to write. List must be present, but does not need to have any items in the list |
| val_list | Yes | List of additional field values to write. List must be present, but does not need to have any items in the list |
Returns
| Value | Meaning |
|---|---|
| 0 | No errors |
| -1 | End of phone call is before start of call |
| -2 | Cannot find the specified subcase |
| -3 | Cannot find the specified contact |
| -4 | Cannot find the specified user |
| -5 | Cannot find the phone log action type string |
| -6 | Cannot find the PHONE LOG activity string |
| -7 | Cannot find employee record for specified user |
| -8 | The supplied status is invalid for the current condition |
| -9 | A commitment is to be created, but the title is blank |
| -10 | The prior warning is negative |
| -11 | The commitment due date is before the log creation date |
| -12 | Cannot find the COMMIT activity string |
| -13 | Could not find the com_tmplte for WARNING |
| -14 | Could not find the com_tmplte for COMMITMENT |
Examples
Create a phone log for subcase number 'C154-1'. The call was made with Bill Clinton. Set the notes for the log, and no other information. Generate a time bomb.
Field version:
JavaScript:
var ret_int = fccs.log_subcase_phone("C154-1", "Bill", "Clinton",
"555-555-1234","", "Some notes", "", "", "", "",
"", "", "", "", 0, true, true,
"", 0, "", 0, "", "", "", "", "", "");
Visual Basic:
Dim ret_int As Integer
ret_int = fccs.log_subcase_phone_list("C154-1", "Bill", "Clinton", _
"555-555-1234", "", "Some notes", "", "", "", "", _
"", "", "", "", 0, True, True, _
"", 0, "", 0, "", "", "", "", "", "")
List version:
JavaScript:
var ret_int = fccs.log_subcase_phone_list("C154-1", "Bill", "Clinton",
"555-555-1234", "", "Some notes", "", "", "", "",
"", "", "", "", 0, true, true);
Visual Basic:
Dim ret_int As Integer
ret_int = fccs.log_subcase_phone("C154-1", "Bill", "Clinton", _
"555-555-1234", "", "Some notes", "", "", "", "", _
"", "", "", "", 0, True, True)
Create a 3 minute phone log made by Bill Clinton for subcase number '2-2'. Set action code of 'Incoming call', some note text, and internal use only text. Have the note logged by marty on November 23, 1997 at 10PM. Change the status to "Working". Also, create a commitment for January 1, 1999 at 8:00AM, with a title, notes, and a prior warning of 1 hour (with the commitment being made by the contact). Generate some additional fields, but do not generate a time bomb.
Field version:
JavaScript:
var ret_int = fccs.log_subcase_phone("2-2", "Bill", "Clinton", "555-555-1234",
"Incoming call", "Some notes", "Internal notes",
"11/23/97 22:00:00", "11/23/97 22:03:00", "marty",
"Working", "Commit title", "Commit notes", "1/1/1999 8:00:00",
3600, false, true, "x_close_int1", 1, "x_close_int2", 456,
"x_summary2", "More text", "", "", "x_other_date", "1/1/99");
Visual Basic:
Dim ret_int As Integer
ret_int = fccs.log_subcase_phone("2-2", "Bill", "Clinton", "555-555-1234", _
"Incoming call", "Some notes", "Internal notes", _
"11/23/97 22:00:00", "11/23/97 22:03:00", "marty", _
"Working", "Commit title", "Commit notes", "1/1/1999 8:00:00", _
3600, False, True, "x_close_int1", 1, "x_close_int2", 456, _
"x_summary2", "More text", "", "", "x_other_date", _
"1/1/99")
List version:
JavaScript:
var fld_list = Server.CreateObject("FCFL.FCList");
var type_list = Server.CreateObject("FCFL.FCList");
var val_list = Server.CreateObject("FCFL.FCList");
fld_list.AppendItem("x_close_int1");
type_list.AppendItem("Long");
val_list.AppendItem ("1");
fld_list.AppendItem("x_close_int2");
type_list.AppendItem("Long");
val_list.AppendItem ("456");
fld_list.AppendItem("x_summary2");
type_list.AppendItem("String");
val_list.AppendItem("More text");
fld_list.AppendItem("x_other_date");
type_list.AppendItem("Date");
val_list.AppendItem("1/1/99");
var ret_int = fccs.log_subcase_phone_list("2-2", "Bill", "Clinton",
"555-555-1234", "Incoming call", "Some notes", "Internal notes",
"11/23/97 22:00:00", "11/23/97 22:03:00", "marty", "Working",
"Commit title", "Commit notes", "1/1/1999 8:00:00",
3600, false, true, fld_list, type_list, val_list);
Visual Basic:
Dim ret_int As Integer
Dim fld_list As New List
Dim type_list As New List
Dim val_list As New List
fld_list.AppendItem "x_close_int1"
type_list.AppendItem "Long"
val_list.AppendItem Trim(Str$(1))
fld_list.AppendItem "x_close_int2"
type_list.AppendItem "Long"
val_list.AppendItem Trim(Str$(456))
fld_list.AppendItem "x_summary2"
type_list.AppendItem "String"
val_list.AppendItem "More text"
fld_list.AppendItem "x_other_date"
type_list.AppendItem "Date"
val_list.AppendItem "1/1/99"
ret_int = fccs.log_subcase_phone_list("2-2", "Bill", "Clinton", _
"555-555-1234", "Incoming call", "Some notes", _
"Internal notes", "11/23/97 22:00:00", _
"11/23/97 22:03:00", "marty", "Working", "Commit title", _
"Commit notes", "1/1/1999 8:00:00", 3600, False, True, _
fld_list, type_list, val_list)