CTI Components Requirements
This section describes components required for PeopleSoft CTI.
The PeopleSoft MultiChannel API (PSMCAPI) is a Java API and software development kit (SDK) that provides server-side connectivity with the PeopleSoft CTI system. PSMCAPI enables third-party telephony vendors and system integrators to integrate with PeopleSoft applications.
PSMCAPI and JSMCAPI are installed during PeopleTools installation.
This table provides the installed locations of PSMCAPI and JSMCAPI components:
Component |
Location |
---|---|
PSMCAPI Java archive |
<PS_HOME>\sdk\psmcapi\dist\lib |
PSMCAPI configuration files:
|
<PS_HOME>\sdk\psmcapi\dist\config |
JSMCAPI JavaScript file |
<PIA_HOME>\webserv\<domain>\applications\peoplesoft\PORTAL\ps\pMCF |
Working With Older Adapters
For some implementations using older versions of third party adapters, you may require a version of psmcapi.jar built with an older version of JDK. PeopleTools provides a previous version of the PSMCAPI for use with older adapters.
This table provides the installed locations of the PSMCAPI components provided for use with older adapters:
Component |
Location |
---|---|
PSMCAPI Java Archive |
PS_HOME\sdk\psmcapi\dist\archive\lib |
PSMCAPI configuration files |
PS_HOME\sdk\psmcapi\dist\archive\config |
Configuring PSMCAPI
Two files, psmcapilog.properties and renclient.properties, include parameters to configure PSMCAPI. Configure the logging characteristics of PSMCAPI in psmcapi.properties. To have PSMCAPI generate full debug logs, set com.peoplesoft.pt.mcf.level to FINEST.
The following table lists all the parameters in renclient.properties:
Parameter |
Default Value |
Description |
---|---|---|
interval_heartbeat_server |
30000 |
Heartbeat interval in milliseconds from PSMCAPI to console. |
interval_heartbeat_client |
30000 |
Heartbeat interval in milliseconds from console to PSMCAPI. |
maxsize_eventqueue |
100000 |
Maximum number of events in the event queue. |
interval_event_expired |
300000 |
Expiration interval in milliseconds for an event in the event queue. An expired event is never published to the client/console and is discarded from the event queue. |
interval_topic_reaper |
3600000 |
Topic reaper interval in milliseconds. |
number_of_requests_in_requestschunk |
1 |
The number of requests that JSMCAPI sends at a time during auto-recovery. |
waitingtime_between_requestchunks |
1 |
The time elapsed between two consecutive JSMCAPI request queues during auto-recovery. |
mtu_size |
0 |
The Maximum Transmission Unit size of your computer or network. Set mtu_size to 0 (zero) for no TCP packet padding, or to the maximum transmission unit (MTU) size for your network or computer to remove TCP acknowledgement delays. |
heartbeats_to_miss |
2 |
The number of heartbeat intervals to wait before removing a nonresponsive client |
psmcapi_heartbeats_to_miss |
5 |
The number of PSMCAPI heartbeat intervals to wait before removing a nonresponsive client. |
tcp_nodelay |
True |
TCP no delay. Set to True to disable the TCP Nagle algorithm. |
disable_session |
False |
This parameter is used when multiple PSMCAPI implementations subscribe to the same REN server. Set to True to disable the internal session and heartbeat listeners. |
CTI agents require only that the MCF Agent security object be enabled on the REN Permissions page of their associated permission list. The MCF Agent security object includes security for both CTI and other MCF channels.
To enable CTI configuration pages, authorize the CTI Type, CTI Applet, and CTI Console panel items on the PT_CTI page permissions for the appropriate permission list.
Also enable WEBLIB_MCF weblib permissions for the appropriate permission list.
The JavaScript MultiChannel Application Programming Interface (JSMCAPI) is an interface that application developers can use to generate the CTI Console or to enable CTI functionality on a PeopleSoft Pure Internet Architecture page. The JSMCAPI builds on the real-time event notification (REN) JavaScript client. JSMCAPI uses standard JavaScript.