Understanding JSMCAPI

The JSMCAPI enables custom configuration of MCF consoles (including the CTI console), MCF functionality on a PeopleSoft Pure Internet Architecture page, and queue and agent monitoring. For example, developers can create supervisor dashboards with which to monitor activity on their channels of interest, or developers can modify consoles according to their company's business requirements. The JSMCAPI builds on the REN JavaScript client. JSMCAPI uses standard JavaScript.

PeopleSoft provides sample pages demonstrating the functionality that is enabled by JSMCAPI. These pages are for demonstration purposes only, and should not be used in a production environment.

JSMCAPI is delivered with PeopleTools; you do not need a separate installation. The jsmcapi.js file is located in the <PIA_HOME>\webserv\<domain>\applications\peoplesoft\PORTAL\ps\pMCF folder.

Understanding Reason Objects and Reason Codes

PeopleSoft MCF provides reason codes to explain any error or an event that has happened. The third party vendors uses the same reason codes as provided by PeopleSoft MCF to create reason objects that they send with the events. PSMCAPI internally parses the event, gets the reason code, and sends it to JSMCAPI with the event. The CTI sample console or third-party multichannel console looks up a mapper table that maintains the mapping of the reason codes to the Message Catalog entries and displays the reason code messages associated with the error or event that was sent by PSMCAPI.

To display the reason code messages, the sample console picks up all the reason codes and reason messages from the Message Catalogue. Whenever an error occurs, the JavaScript function will extract the reasoncode from the reason object in event and look for the reason message. Then, the JavaScript code prepares the reason message from the fields of reason object and displays the reason message in a new small window.

Reason codes can also be send with requests from JSMCAPI side. The JavaScript function will prompt for the reason codes and any extra data as part of reason.

The following table lists the reason codes and their corresponding reason messages:

Reason Code	Description/Message Entry
0	System or general error has occurred.
1	See provider for details.
2	Extension or agent is busy.
3	No answer.
4	Task is in transfer.
5	Task is in conference.
6	Task is abandoned.
7	Searching for an agent.
8	Incoming task.
9	Task is assigned.
10	Connection is established.
11	User or Task data is updated.
12	Request is completed successfully.
13	State of the agent, group, or extension changed.
14	New task is initiated.
15	Conference is not successful.
16	Transfer is not successful.
17	Retrieve is not successful.
18	Forward is not successful.
19	Reject is not successful.
20	Revoke is not Successful.
21	Task is revoked.
22	Task is withdrawn.
23	Do Not Disturb is turned on.
24	Do Not Disturb is turned off.
25	Forwarding of calls is set.
26	Forwarding of calls is canceled.
27	Phone is on hook.
28	Phone is off hook.
29	New call is initiated.
30	Call is put on hold.
31	Call is parked.
32	Call is cleared.
33	Call is alternated between hold and active states.
34	Call is taken off hold.
35	Hold is not successful.
36	Invalid session.
37	Invalid State.
38	Incorrect Data.
39	Unsupported Feature.
40	Configuration Error.
41	Server is on.
42	Server is off.
43	Agent is Busy.
44	Unexpected Error.

The following table maps the reason codes to the entries in the Message Catalog:

Message Number MCFMSGNUM	Message Set Number MCFMSGSETNUM	Reason Code Number REASONCODENO
2790	162	0
2791	162	1
2792	162	2
2793	162	3
2794	162	4
2795	162	5
2796	162	6
2797	162	7
2798	162	8
2799	162	9
2800	162	10
2801	162	11
2802	162	12
2803	162	13
2804	162	14
2805	162	15
2806	162	16
2807	162	17
2808	162	18
2809	162	19
2810	162	20
2811	162	21
2812	162	22
2813	162	23
2814	162	24
2815	162	25
2816	162	26
2817	162	27
2818	162	28
2819	162	29
2820	162	30
2821	162	31
2822	162	32
2823	162	33
2824	162	34
2825	162	35
2826	162	36
2827	162	37
2828	162	38
2829	162	39
2830	162	40
2831	162	41
2832	162	42
2833	162	43
2834	162	44