 | |
Introduction | |
This document is intended for all audiences. However, there are technical sections that may not pertain to non-developers. IT professionals that are familiar with Windows Server should be responsible for the installation and maintenance of the TAM ConneXion. The main users of the TAM ConneXion will be developers who are creating integration programs.
Overview
Applied Systems ConneXion is a .NET program that provides and XML based programming interface for The Agency Manager software system.
XML streams are used by the ConneXion software to connect third party applications to a TAM database via the ConneXion data processor and business tier logic of the TAM system. ConneXion is the software interface through which external applications can interact with TAM data in a safe and structured way.
Within this document exists a list of most of the API's that are currently available. In addition to the API's, there is also sample VB.Net code and field structures.
Getting Started
ConneXion Business Architecture
ConneXion provides a "language" through which software systems can interact with the TAM agency management system. In order to make communicating with the TAM database simple and intuitive, the ConneXion classes closely model the data represented by the standard TAM graphical user interface.
The graphical user interface is modeled in the ConneXion system:
• When adding a policy to the TAM system through ConneXion, there must be an existing customer or prospect to which the policy will be attached.
• When adding an application to the TAM system through ConneXion, there must be an existing policy to which the application will be attached.
This model leads to the following common sequence of commands issued through ConneXion:
• A ConneXion Customer XML stream is passed to the ConneXion command processor. web service example
• A ConneXion Policy XML stream is passed to the ConneXion command processor. web service example
• A ConneXion Application XML stream is passed to the ConneXion command processor. web service example.
In this sequence of commands each XML stream builds on the previous stream. The policy XML contains an element that denotes the client to which the policy should be attached. The application XML contains an element that denotes the policy to which it should be attached.
Though the previous sequence of events is the most common, there is no requirement in ConneXion that information be entered in the strict manner of Customer>Policy>Application. A typical example is the creation of 50 prospects and activities in TAM through ConneXion. Policy and application information may be attached at a later date by simply including the appropriate prospect or client identifier in the policy XML.
Deployment of your Third Party Program
When you deploy your application, do not include any TAM or ConneXion files that are dependencies. Those files should already be on the machine since it is required to have both the TAM Client and ConneXion loaded. Deploying these files with your application can cause errors.
Sample ConneXion Applications
Included on the Documentation CD are 3 sample applications that can be saved to the local machine and run using VB.NET. They are:
WSTestDemoWebService - Demo application using the Web Service. Must have the Web Services installed to run.
WSTestDemoClassLibrary - Demo application using the Class Library. Must have the Class Library installed to run.
WSTestDemoTAMCentral - Demo application using TAM Central. Must have a valid TAM Central license to run.
Note The user should already be familiar with VB.NET to view these demo applications.
Technical Architecture
Overview
ConneXion is an XML based toolkit for use by developers to programmatically interact with The Agency Manager (collectively referred to as TAM) software systems. ConneXion may be used by third party applications to store information in TAM or to retrieve information from TAM for integration into their own database systems. ConneXion defines XML streams that produce calls in the TAM business tier libraries that carry out the specified operation. ConneXion is intended for use in a wide variety of applications including insurance Internet application development, third party software integration, and data warehousing.
ConneXion is run using Microsoft .Net technology in either a Web Services or Class Libraries environment.
Configuration Option 1 (Class Libraries)
User's workstation:
This option should be used when ConneXion will be used in conjunction with a standalone or “thick client” software package. In this configuration ConneXion will typically be installed on each user’s workstation along with WinTAM and the integrating third party product.
Software Requirements:
• Microsoft .Net Framework 4.5.2. Microsoft .NET Framework 4.6.2 is compatible, but not required for Applied TAM operation.
• WinTAM installed.
• ConneXion Software installed.
Windows 8.1 or Windows 10 may be used.
Configuration Option 2 (Web Services)
Dedicated ConneXion workstation/server:
This option should be used when ConneXion will be used in conjunction with a “thin client” or web based software implementation. In this configuration it is preferable that no console user or service applications make use of the dedicated server or workstation except through ConneXion. Any additional services hosted by this machine will degrade the resources available to handle user requests routed through ConneXion.
Software Requirements:
• IIS 10, IIS 8.5 or IIS 8
• Microsoft .Net Framework 4.5.2. Microsoft .NET Framework 4.6.2 is compatible, but not required for Applied TAM operation.
• WinTAM installed.
• WorkStation Operating Systems:
* Microsoft Windows 8.1 Professional/Enterprise 64-bit edition, Microsoft Windows 10 Professional/Enterprise 64-bit edition
OR
• Server Operating Systems:
* Microsoft Windows Server 2019, Microsoft Windows Server 2016, Microsoft Windows Server 2012 R2, Microsoft Windows Server 2012
Windows 8.1 or Windows 10 may be used.
Configuration Option 2 removes most of the data processing load from the third party software vendor’s client equipment. This configuration also offers a higher level of fault tolerance to client systems by taking processing off the application host and moving it to a pool of MTS or COM+ servers.
Resource distribution and fault tolerance are particularly important attributes in cases where users are simultaneously using a single computer, through thin client technology where processing resources are scarce for each client. Examples of such shared resource application platforms include IIS and WinFrame hosted users.
A second important use of the ConneXion technology is in the case of disparate platforms. For example: An application running in an apache Internet service environment, hosted on a Unix based platform, could still communicate with the TAM software system through the listener service included in the ConneXion toolkit.
ConneXion Server
Recommended hardware:
Hardware should be consistent with WinTAM workstation requirements at the lower end. (If you need these requirements, please access our website at https://content.appliedsystems.com/documents/doc_central/ST-Shared-Technology/tamconnexionhandsg2017.com)
As the number of users accessing a particular installation of the ConneXion system increase, the system capacity requirements for any dedicated ConneXion server also increase. Multiple dedicated servers may exist in a single implementation to support the distribution of processing ConneXion calls in an effort to enhance performance. Viable operating systems include Windows 8.1 or Windows 10 but the number of network connections required should be a consideration when using workstation class OS versions.
Terminal Services
If your agency runs a Terminal Services server, special settings must be made. See Development Tips for instructions on setting up a workstation for Terminal Services. If you have any concerns or questions, please contact ConneXionSupport@appliedsystems.com