CRM View Objects
《Examples of object reference》
$view.customer.sections["customer"] $view.customer.sections["personalinfo"].fields["name"] $view.customer.fields["name"] $view.contact.fields["result"] $view.contact.fields.result
※The event source object is stored in the $source variable.
・onScreenLoad case,
→In the case the customer information section group is loaded, customer object is used.
→In the case the contact result section is loaded, contact object is used
→In the case the contact history is loaded, contacthistory object is used.
・onContactResultCommit case, GenericSection object (contact section object）
→In the case the commit event occurs at contact result section, contact object is used.
→In the case the commit event occurs at contact history section, contacthistory is used.
・onFieldValueChanged case, Field object（Field object that the event occurs.）
$view ( root object)
【Properties】
string projectId : Current Project ID. In the case the view is not tied with the specific project, the value is null. string projectName : Current Project name. In the case the view is not tied with the specific project, the value is null.
CustomerSections customer : Customer Information section group GenericSection commonbase : Basic Information section (Agent View) GenericSection customerbase : Basic Information section (Management View) GenericSection calllistbase : Call List Basic Information section (Management View) GenericSection customerproject : Customer Information section GenericSection callinformation : Call Information section GenericSection contact : Contact Result section GenericSection callresult : Call Result section ReservationSection callreservation : Call retry schedule section HistoricalSection callhistory : Call history section HistoricalSection contacthistory : Contact history section
【Methods】
boolean isOnAgentView() : In the case agent view is being used, the value is true. boolean isContacting() : In the case the user is contacting the customer, the value is true.
CustomerSections customer (Customer Information sections’ object)
【Properties】
Object fields{ Field field1, Field field2,,, } : The associative array of Customer information Fields. Properties' name are as same as Object's field IDs.
Object sections{ Section section1, Section section2,,, } : The associative array of Customer Information sections. Properties' name are as same as Object's section IDs.
【Methods】
boolean isCustomer() : In the case the information is customer information, the value is true. boolean isCallList() : In the case the information is call list information, the value is true. boolean isEditing() : In the case the information is being edited, the value is true. boolean startEdit(); : Start edit mode. boolean saveEdit(); : Save edited items. boolean cancelEdit(); : Cancel edited items. void registerAsCustomer() : Register Customer. void setReservationCancelFlag(boolean); : Change the status of reservation cancel button clicked. boolean getReservationCancelFlag(); : Get the status of reservation cancel button clicked.
Section (Base object of section)
【Properties】
string secntionId : Section's ID( The value is same as default value or the category ID of the category. If it is not spefcified, the value is assigned automatically.)
【Methods】
object getDOMObject() : Top level DOM object that composes the section. object getTitleDOMObject() : Top level DOM object that composes the title part of the section. boolean getVisible() : Get the visibility status of the section. setVisible(boolean) : Set the visibility status of the section. booleangetReadonly() : Get the read-only status of the section. setReadonly(boolean) : Set the read-only status of the section. string getTitle() : Get the title of the section. setTitle(string) : Set the title of the section.
GenericSection extends Section (General Section Object)
【Properties】
Object fields{ Field field1, Field field2,,, } : The associative array of Section Fields. Properties' name are as same as Object's field IDs.
ReservationSection extends GenericSection ( Reservation Section Object)
【Methods】
void reserve() : reserve the call sending
HistoricalSection extends Section ( Historical Section Object)
【Properties】
Object fields{ Field field1, Field field2,,, } : The associative array of the opened Field's Fields. Properties' name are as same as Field Object's field IDs.
Field ( Defined Object of Field)
【Properties】
string fieldId : Field ID (Defined value or same value of Field's Field ID) string fieldType : The string that indicates field data type. Section parentSection : Section object the object belongs to.
【Methods】
object getDOMObject() : Top level DOM object that composes the Field. object getInputDOMObject() : Top level DOM object that composes the label part of the Field. object getLabelDOMObject() : Top level DOM object that composes the INPUT part of the Field. boolean getVisible() : Get the visibility status of the Field. setVisible(boolean) : Set the visibility status of the Field. boolean getReadonly() : Get the read-only status of the Field. setReadonly(boolean) : Set the read-only status of the Field. variant getValue() : Get the value of the Field. setValue(variant) : Set the value of the Field. getLabel(string) : Get the label of the Field. string setLabel() : Set the label of the Field.
《Data type of Fields》
●TextField extends Field : Text data type field ●LongTextField extends Field : Long Text data type field ●NumberField extends Field : Number data type field ●CheckBoxField extends Field : Check box data type field ●SelectListField extends Field : Select list data type field ●MultiSelectListField extends Field : Select list (tree) data type field. ●RadioButtonField extends Field : Radio button data type field ●DateField extends Field : Date data type field ●TelephoneNumberField extends Field : Telephone number data type field ●BirthdayField extends Field : Birthday data type field ●ScriptButtonField extends Field : Script button data type field ●ScriptField extends Field : Script data type field ●HiddenValueField extends Field : Hidden data type field ●TextLabelField extends Field : Text label data type field (e.g. "Customer ID" at Basic Information section) ●ConstantsLabelField extends Field : Constant label data field (e.g. "Call type" at Call Information) ●DateTimeLabelField extends Field : Datetime label data field (e.g. "Date/Time Created" at Basic Information) ●StatusField extends Field : Status data field (e.g. Customer status) ●TimeRangeField extends Field : Time range data field (e.g. "Time span" at Call Scheduling) ●ComboBoxField extends Field : Combo Box data field (e.g. "Assign Agent" at Call Scheduling) ●TSPField extends Field : TSP data field(e.g. TSP field at Contact Result)
《Defined Section Fields》
★commonbase : Basic Information Section (Agent View )
customer_id Customer ID(TextLabelField) registered_date Date/Time Created(ConversionLabelField) contacted_date Last Contact Date/Time(ConversionLabelField) contact_result Last Contact Result(ConversionLabelField) status Status(StatusField) reserve_user Scheduled User(ConversionLabelField) reserve_type Schedule Type(ConversionLabelField) reserve_telno Phone No.(ConversionLabelField) reserve_date Scheduled Date(ConversionLabelField) reserve_time Time span(ConversionLabelField) reserve_day_week Day of the Week(ConversionLabelField) reserve_priority Priority(ConversionLabelField)
★customerbase : Basic Information Section (Management View)
customer_id : Customer ID(TextLabelField) registered_date : Registered Date(ConversionLabelField) contacted_date : Last Contacted Date(ConversionLabelField) contact_result : Last Contact Result(ConversionLabelField) status : Status (StatusField)
★calllistbase : Call List Basic Information Section
registered_date : Registered Date(ConversionLabelField) completed_date : Completed Date(ConversionLabelField) state : Status(ConversionLabelField) dialed_result : Last Contacted Date(ConversionLabelField) contact_result : Last Contact Result(ConversionLabelField) dialed_count : Dialed count(TextLabelField) reserve_user : Reserve user(TextLabelField) reserve_agent : Assigned agent
★customerproject : Customer Information Section – project
status : Status (StatusField)
★callinformation : Call Information Section
call_id : Call ID (TextLabelField) contact_type : Call Type (ConversionLabelField) external_telno : Originating Phone Number (ConversionLabelField) customer_telno : Customer Phone number (TextLabelField) additional_info : Additional Info (TextLabelField) contacted_date : Contacted Date (HiddenField)
★contact : Contact Result Section
tsp : TSP Section (TSPField)
★callresult : Call Result Section
result : Call Result(SelectListField) result_option : Additional Info (SelectListField) result_note : Note (LongTextField)
★callreservation : Call Scheduling Section
reserve_type : Schedule Type (SelectListField) reserve_telno : Scheduled Phone Number (SelectListField) reserve_date : Scheduled Date(DateField) reserve_time : Time span(TimeRangeField) reserve_day_week : Day of the Week(CheckBoxField) reserve_agent : Assign Agent(ComboBoxField) reserve_project : Project(ComboBoxField)