Integration of 3rd party software into Amethyst

[Belinda Frick]

AMETHYST 1.3 no longer supported,
please contact your dealer for upgrade options!

Integration functions available for Amethyst. These are the prefered methods.
You can also use ODBC drivers in some instances.


Important Notes

The com objects and sample programs referenced here related to integration
through com objects are not available at this stage.

You need version 3.3.2.0 of the SLVR and version 1.3.4.0 of the Amethyst
Server for the UDP protocl to work.

All future integration methods will be covered in this document. Therefore
this document may change from time to time. All other documents related to
integration into Amethyst will become obselete.



FUNCTIONS

1. REQUEST FOR INFORMATION
2. REQUEST TO SET INFORMATION

Function 1 - Request for information

UDP PACKET FORMAT=RFI|COMMAND|USERNAME|COMPUTERNAME|YOURLINKBACK|

WHERE
1. RFI Is a literal.
2. COMMAND Is one of the following literals
a) REF=GET REFERENCE.
b) STS=GET STATUS
c) ALL=GET ALL FIELDS
3. USERNAME Is the username you are requesting information for.
4. COMPUTERNAME Is the computer the user is working on.
5. YOURLINKBACK Is a link or reference back to your application e.g.
an account code, membership number or order number.

The reference will only be returned if a recording is in progress for the user.

The result returned is in the format:

FYI|USERNAME|COMPUTERNAME|YOURLINKBACK|RESULT|


WHERE

1.FYI is a literal
2. USERNAME ,COMPUTERNAME and YOURLINKBACK are the same
as received in a RFI.
3. RESULT depends on the command that was used

a) REF will return a Recording reference only if a recording was
taking place.
b) STS will return the current status
c) All will return all the fields delimited by commas e.g.

status,lastcall,ping,reference,version,nextftp

NOTES
1. Return Results will be in random fashion. Not serialized.
Do not expect responses back in the same sequence as you
requested them.
2. The username must match the Amethyst Username.
This can also be case sensitive.

The COM Function for the above would be

Function GetAmtInfo(VAR COMMAND,USERNAME,COMPUTERNAME,YOURLINKBACK : String) : String


Function 2 - Request to set information

UDP PACKET FORMAT=RSI|COMMAND|USERNAME|COMPUTERNAME|YOURDATA|

WHERE
1. RSI Is a literal.
2. COMMAND Is one of the following literals
a) STX=SET TEXT
3. USERNAME Is the username you are requesting information for.
4. COMPUTERNAME Is the computer the user is working on.
5. YOURDATA Is the alphanumeric information you would like to set.
an account code, membership number or order number.


NOTES
1. The information will be added at the end of any user notes entered.
2. Information will only be added while the status is RECORD OR WRAP/IDLE.


The COM Procedure for the above would be

Procedure SetAmtInfo(VAR COMMAND,USERNAME,COMPUTERNAME,YOURDATA : String);

METHODS

Method 1 (Via UDP for cross OS platform integration)
Method 2 (Via UDP for cross OS platform integration with COM object)

Protocol

UDP via TCPIP using normal TEXT BASED PIPE DELIMITED STRINGS.

Requirements

You will need to setup a UDP reader listening for information from Amethyst
as well as be able to send commands via a UDP sender to Amethyst.

Amethyst Server

Host=AmethystServer
Port=27000

Local PC

Host=PCREQUESTING
Port=27004


SAMPLE AND TEST PROGRAMS
AMTIntegrationClient - Amethyst 3rd Party Client Testing To Amethyst Server Example
AMTCOMOBJECT - Amethyst 3rd Party Client link to Amethyst via UDP and COM object - No Source
AMTCOMCLIENT - Amethyst 3rd Party Client link to Amethyst using AMTCOMOBJECT with source.
AmtInter20030610.zip - Amethyst 3rd Party Client Testing To Amethyst Server Example with source for
Delphi - CLX (Windows and Linux)