You can download the install from the Distributions page on the AMETHYST Webadmin.
Please contact Datatex for the latest version for you server.
There is an auto-update feature on the server that will upgrade or downgrade clients that is not the same version as the server.
The default Windows 32 installation location is: C:\Program Files\Datatex\AmtClient and on 64bit windows it is located in: C:\Program Files (x86)\Datatex\AmtClient
Requirements for AmtClient 1.6 to work:
- At least Amethyst 1.6.3
- Extension Side recording solution or Trunk Side Solution with CTI or VoIPRecorder (physical extensions)
- PC's running Windows XP, Vista, 7 or 8. Terminal Server installation is also supported.
- Administrative rights to install the software. (Not required after installation)
- Windows Firewall must allow the service to communicate through it to Amethyst IP.(The installer will add a Firewall Whitelist entry)
- List of Windows logins and the related extension numbers.
NB: The service [AmtPCService] handles all the communication with the Amethyst server and the application [AmtPCManager] handles the popups and input from an agent.
Installation of Client Software
- Run the installer on the agent PC. make sure they have administrative rights or use the "RunAs Administrator" option.
- Only enter an extension number during the installation if the extension are fixed and will always be next to the computer where this client is installed. By leaving it blank, Amethyst will use the extension that is linked to the Windows Login on the CTI Device Screen.
- Check that the purple icon appears in the icon Tray of Windows.
- Please note that the icon may be hidden behind the "Hidden Icons" button. Click the button and drag the AmtClient Icon to the visible icon tray so that the agent can always see the icon.
On completion of the installation the following things will try and take place:
- AmtClient Service will broadcast on the local network subnet to find the Amethyst Server
- If the Amethyst server is found, the client will automatically register itself with the local IP and Windows Login.
- If an extension was configured during the installation of the AmtClient, this extension is sent to the Amethyst Server. The Windows Login and Extension is then mapped together on the CTI Device Screen.
Every time the service starts up the above steps are followed again. If this broadcast doesn't find the Amethyst server or it is blocked by the PC's firewall, the software will not connect to Amethyst. The Amethyst IP can be configured in the AmtClient's INI file before the service is started and it will explicitly try and connect to that IP.
While the Service is not properly communicating with Amethyst, the AmtClient interface will be grey.
If it successfully finds and connects to Amethyst, it will turn purple.
Client Configuration
Manually configuring the Amethyst Server IP
If the Amethyst server is on a different Subnet / Network but it is still accessible from the agent PC, the IP can be manually configure in the INI file of the AMTPCService.INI.
- Test that you can access the Amethyst Web interface from the Agent PC, to ensure that the communication is correct.
- Stop the AmtPCService in the Windows Services facility before editing any files.
- Open the INI file in the default installation location and change the CITRIXHOST and the FTPSERVER setting to the Amethyst IP.
- Once the file is saved, you can start the AmtPCService again.
Below is an INI file with each field explained.
- Code: Select all
C:\Program Files\Datatex\AMTClient\AmtPCService.INI
[SETTINGS]
;The extension as configured during the installation. If this value is left blank, the Amethyst server will send the CTI Device extension based on the Windows Login to this client.
EXTENSION=3306
;When screenshots are enabled, how often to take a screenshot during a recording
SCREENSHOTINTERVAL=30
[LOGGING]
;Should additional logging be enabled. Only use this if the service is still not working properly and you need
;more information about what it is doing.
VERBOSE=0
[NETWORK]
;The UDP Ports the Service will be listing on for instructions from Amethyst.
UDPPORT=27002
LOCALPORT=27004
;This is the IP address of the Amethyst Server. If the server can't find the Amethyst server, the default value is 127.0.0.1.
CITRIXHOST=192.168.1.100
CITRIXPORT=27009
;Make this IP the same as the Amethyst Server unless there is a reason your FTP server is separate from
;your Amethyst server. E.g. Remote Server
FTPSERVER=192.168.1.100
FTPLOGIN=amethyst
FTPPASSWORD=amt
[INTEGRATION]
LINKPORT=27005
After making sure that your IPs are correct, you should be able to go to your Amethyst Webadmin and check that the AmtClient has updated the CTI Device list. The AmtClient settings con now be configured from this screen.
AmtClient Settings
1. Global Settings:
These are the FTP settings that will be sent to all connected AmtClients.
- FTP Server is usually the same IP as the Amethyst Server. If the value is showing as "127.0.0.1", the AmtClients will try and connect to themselves and will not be able to work properly.
- FTP Login and Password should be as per screenshot.
- Screenshot Interval is how often during a recording a screenshot must be taken. Making this value less than 30 seconds, will increase the amount of space required to store recordings dramatically.
2. Defaults for new AMTClients:
This is the default values that will be used when a new AmtClient registers itself with Amethyst.
- PopupType determins which mode of popup will be generated for a new recording.
- None = No popup
- SMALL = A popup with the call details and just a Subject field
- BIG = A popup with call information, Subject and space to enter notes.
- Force Input determine whether the popup can not be canceled or closed with out entering a value
- Take focus will cause the input cursor to be moved from the active application to the popup when it is triggered.
3. Prompt lists
This facility allows you to dropdown lists. These drop-down lists can then be used in place of the Subject field on the AmtClient popup. You can select which drop down list to use per agent.
To add a new list
- Enter the list name in the field next to the button "Add Prompt list" and click the button.
- Now another box will appear below this that allows you to enter the selection options below each other. The list will appear in the order that you enter them here.
- Click the "Add/Change list" button to save the list.
4. Agent list
This is the list of automatically registered AmtClients. The Windows list and IP is updated every time the AmtClient connects. If the AmtClient has an extension in the INI file, it will send it along and will update it on the list, if the agent has HotDesk Disabled.
Each Field as it appears on the screen:
- Windows Login: Exactly as it comes from the Agent PC. This is used in HotDesk environments to follow the agent.
- Extension: The value that should be allocated to this Agent or PC. In Hotdesk is enabled sites, this value will be sent to the AmtClient as the Authoritative Extension. In Hotdesk Disabled sites, this value can automatically be changed based on the authoritative extension from the INI file on the Agent PC.
- Popup Type. See the Default Values.
- Prompt: The text displayed where the agent can enter a subject/short note (Max 30 Characters)
- Prompt list: select one of the created Prompt lists.
- Force Input: Enabling this will prevent the window from being closed until something has been entered on the popup.
- Take Focus: The input focus is taken from the current active application and focused on the popup input field.
- HotDesk: This setting controls which extension value is the authoritative value.
Enabled = CTI Device Configured value. The configured value will not be automatically changed.
Disabled = INI File Value. The Configured value on Amethyst will be changed to the value in the INI file. - Computer IP: This is the last IP where the AmtClient connected from. The Ports are also listed for troubleshooting purposes.
- CBS: Calls Between Screenshots (CBS) is how many recordings must between each attempt to take screen shots.
E.g.
1 = Every single call will take screenshots.
5 = every 5th call will attempt to take screen shots. - CNS: Calls until Next Screenshot (CNS) is how many calls must still be made before the next attempt is. E.g. If the CBS is 10 and the current call is the seconds call, the CNS will be 8. So after the next 8 calls it will try to do screenshots again.
Multi User Environments (e.g. Terminal Servers, Citrix):
The AmtPCService accesses the main INI file to retrieve its global settings, but the AMTPCMangager has it's own INI file to allow a per user configuration. These INI files are stored in a location where the AmtPCClient can always write to.
Windows Vista and 7
- Code: Select all
C:\Users\All Users\Datatex\AMTClient
Windows XP
- Code: Select all
C:\Documents and Settings\All Users\Application Data\Datatex\AmtClient
Windows 8 (possibly Windows 7 )
- Code: Select all
C:\Programmdata\Datatex\AMTClient
This folder will contains a folder for each Windows Login that the AmtPCService detects logging into the server where it is running. Each folder contains an INI file for that windows login. The Per agent information and last 20 calls is stored in this file.
Here is an example:
AMTPCManager.INI
- Code: Select all
[PROGRAMTYPE]
PROGRAM=AMTCLIENT
[SCREENSHOTS]
;Should screenshots be taken during phone calls.
ENABLE=0
;How often are screenshots to be take (in seconds)
INTERVAL=30
[POPUPS]
;Should the window popup when a new call starts. (Depends if your setup supports notification of start of call and the extension involved. E.g. Extension side recording or CTI enabled)
ENABLE=1
;Is the input forced; can the window be closed without entering information.
FORCEPOPUPINPUT=1
; Input mask
FORCEPOPUPINPUTMASK=
; The location on the screen where the main window shows, when you open it.
X=907
Y=394
;popup location on the screen
EDITX=677
EDITY=423
;Should the big (0) or small (1) popup be used when popup the window.
BIGPOPUPS=0
;What doe you want to call the input field. Makes this screen a bit more combustible.
PROMPT=SUBJECT:
[SETTINGS]
;The Agents Virtual Extensions. Use this only if the agent's extension moves with them when they login on a new phone. The Extension in the main INI file should then be blanked out.
EXTENSION=3306
[HISTORY]
;Previous 20 calls already completed, are listed here.
Manual Install:
You can manually copy the AmtClient folder onto a PC and run the following command in a COMMAND window to register the service.
- Code: Select all
"C:\program files\Datatex\AmtClient\AmtPCService.exe" /install
To un-register the service again you can use this command:
- Code: Select all
"C:\program files\Datatex\AmtClient\AmtPCService.exe" /uninstall
Example Setup Scenarios:
Setup 1:
This setup will cover most installations.
Agents can sit at any desk and login to any phone, but the extensions numbers always stay the same, they don't "move" with the agent. Or a regular office where each person has their own desk and they don't move around.
The AmtPCService and Manager should be installed on the PC where the agent logs in. The extension number must be configured in the AmtPCService.INI file. Since the extension will always be linked to the PC and not to the agent. The AmtClient will then always send the extension that it has configured in the INI file to Amethyst, including the agent's Windows login.
Setup 2:
Agents can sit at any desk and login to any phone, the extension number then changes to the agents' extension number. The AmtPCService can be installed on the local PC/Terminal or on the Terminal server. The extension in the AmtPCSerivce.INI must be cleared. The agent's extension number must be configured in on the CTI Devices next to their Windows login.
Now the Amethyst will report the extension to the AmtPCManager for the linked Windows login. When the AmtPCManager interface starts up, it will communicate with the AmtPCService and then receive the ports that it will start using for popup instructions.
Once the ports have been allocated, the service is ready to go and will turn purple.
The AmtPCSerivce will start allocating ports from 27003 up to 28003 (UDP and TCP). It will allocate on a first come first serve basis. Once a port is freed up, it will be re-used for the next client.