Caller ID App

From Cinemar Wiki
Jump to: navigation, search

Welcome to the MLServer4 CallerID App . This App will create variables that enables MainLobby clients to display CallerID information.

Requirements

•MLServer 4

•A compatible modem, Best Data 56k v.92/v.44 (#56HP) PCI Windows Internal Modem

•MainLobby 4 client or tablet scenes.


Description

Most phone services provide telephone number and caller informtion with each call. A phone modem can extract this data. The CallerID App can record this data and allows for mapping of the phone number to a caller's name that is maintained in the callerid database.

Here is how the communication works:

Telephone company > Incoming phone call > CallerID data > Modem (on PC com port) > CallerID App > callerid database > MainLobby4 Client


Getting Started

Install the modem with the latest drivers for your operating system. Note what comport the modem is installed to.


Installation

1. Shutdown MLServer 4

2. Download and install the CallerID App from MLinstaller on the Primary MLServer 4PC.

3. Start the MLServer 4 application.

4. Open the Server Apps window and make sure that the CallerID App is Enabled.

Caller ID Enabled.jpg


Setup

1. Start MLServer 4 if not already started.

2. Double click on callerid plugin and click on Settings once the new window appears.

3. If you are using callerid with a PC modem ((Recommended model: US Robotics USR5633ACCS USB, Best Data 56k v.92/v.44 (#56HP) PCI Windows Internal Modem), then make sure the modem is installed properly with it’s software driver, and select the modem com port in the CallerID com port drop down. Do this for both phone lines if you are using two phone lines and modems.

4. Set up the image folders you want to use or leave them on the default folders. (Recommend default folders.)

CallerID Settings.jpg

Events Tab

1. Click on the events tab to see curent events and to set up the logging for the App..


Importing Aliases from previous versions of callerid

1. Open the CallerID App.

2. Click on the Import button on the right side, select the location of your MLS3 data folder and select MLCallerID.mdb.

3. All of your aliases should now be in the list.


Adding an Alias

1. Open the callerid App.

2. Click on the Aliases tab at the top.

3. Click the Add button.

4. Enter the alias information in the empty data box that appearrs. CallerID images should be created at 480x640 for optimimum resolution

5. The new alias will now be in the list


Editing an Alias

1. Open the CallerID App.

2. Click on the Aliases tab at the top.

3. Select the alias you wish to edit from the alias list and click on the data box you wish to edit.


Deleteing an Alias

1. Open the CallerID App.

2. Click on the Aliases tab at the top.

3. Select the alias you wish to delete from the alias list.

4. Click on the Delete button..

5. The alias is now removed.

CallerID Aliases.jpg


Clear the call log

1. Open the CallerID App.

2. Click on the Call Log tab at the top.

3. Click on the Delete All button.


Delete a call from the call log

1. Open the callerid plugin.

2. Click on the Call Log tab at the top.

3. Select the call you wish to delete from the call list.

4. Click on the Delete button on the right.

CallerID CallLog.jpg


CallerID Supported Commands

CallerID|Power

{MLServeCmd}Script Usage

CallerID|Power (Literal)

CallerID|Power


Description This command turns the power of to the callerid plugin. This stops the on call command from being fired when you receive a call


CallerID|FirstCaller

{MLServeCmd}Script Usage

CallerID|FirstCaller (Literal)

CallerID|FirstCaller


Description Sets MLServer variables for the first caller in the list.


CallerID|LastCaller

{MLServeCmd}Script Usage

CallerID|LastCaller

(Literal) CallerID|LastCaller


Description Sets MLServer variables for the last caller in the list.

Notes


CallerID|Next

{MLServeCmd}Script Usage

CallerID|Next

(Literal) CallerID|Next


Description Sets MLServer variables for the next call in the list relative to the current caller being displayed.


|CallerIDPrevious

{MLServeCmd}Script Usage

CallerID|Previous

(Literal) MLServeCmd.callerid|Previous


Description Sets MLServer variables for the previous call in the list relative to the current caller being displayed.


CallerID|Delete

{MLServeCmd}Script Usage

CallerID|Delete~Call #

(Literal) CallerID|Delete~3 CallerID|Delete~1

Parameters Call # = The id of the call.


Description Deletes the specified call from the call log.


CallerID|FirstPage

{MLServeCmd}Script Usage

CallerID|FirstPage (Literal)

CallerID|FirstPage


Description Sets the MLServer variables for the first page of callers. The number of callers per page is determined by user settings.


CallerID|LastPage

{MLServeCmd}Script Usage

CallerID|LastPage

(Literal) CallerID|LastPage


Description Sets the MLServer variables for the last page of callers. The number of callers per page is determined by user settings.


|CallerID|NextPage

{MLServeCmd}Script Usage

CallerID|NextPage

(Literal) CallerID|NextPage


Description Sets the MLServer variables for the next page of callers. The number of callers per page is determined by user settings. This command works in a circular fashion; if you are on the last page of callers and issue this command it will go back to the first page of callers.


CallerID|PreviousPage

{MLServeCmd}Script Usage

CallerID|PreviousPage

(Literal)

CallerID|PreviousPage


Description Sets the MLServer variables for the previous page of callers. The number of callers per page is determined by user settings. This command works in a circular fashion, if you are on the first page of callers and issue this command it will go back to the last page of callers.


CallerID|ClearLog


{MLServeCmd}Script Usage

CallerID|ClearLog

(Literal)

CallerID|ClearLog


Description: Clears the Call Log


CallerID MLServer Variables

The CallerID App will auto generate variables in MLServer4 based on the settings you have entered. It will also update and create variables based on certain modem events. If possible all variables are set on startup.

callerid_power

callerid_active_page

callerid_pagetotal

callerid_lastcall_id_###

callerid_lastcall_date_###

callerid_lastcall_day_###

callerid_lastcall_image_###

callerid_lastcall_name_###

callerid_lastcall_companyname_###

callerid_lastcall_telephonenumber_###

callerid_lastcall_time_###

callerid_page_id_###

callerid_page_date_###

callerid_page_day_###

callerid_page_name_###

callerid_page_companyname_###

callerid_page_time_###

callerid_page_telephonenumber_###

callerid_page_image_###



Bugs

Feature Requests

Release Notes