MKS Integrity 2007 Integrations Builder Guide

Chapter 2: Understanding the MKS API
Integrating With the MKS Integrity Client
6
An MKS Integrity Client integration is the most common integration; for example, it is used by
all IDE and developer productivity tool integrations.
The MKS Integrity Client integration has many unique features.
GUI interaction for status, dialogs, and views
Integrations can use the MKS Integrity Client GUI when integrating with an
MKS Integrity Client. For more information, see “Using the Graphical User Interface” on
page 37.
Common session
By using a common session, an MKS Integrity Client integration can provide the user
with seamless interaction between the integration, MKS Integrity Client GUI, and the
CLI. Changes made through the GUI or CLI can influence the integration and vice versa.
For example, establishing a connection using the MKS Integrity Client provides the
default connection for the integration.
You also have the option of not using the tight coupling provided by a common session,
and using the GUI and CLI independently from the integration.
User preferences
Your Client
Your Client
Application
Integration Code
API
Integrity Client
All user preferences defined on an MKS Integrity Client are available to an
MKS Integrity Client integration. This is an especially valuable feature because it allows
an MKS Integrity Client integration to not have to specify connection or user
information, but to rely on the defaults set on the MKS Integrity Client.
MKS Integrity Client port detection
The port of the MKS Integrity Client integration point can be automatically detected
when integrating to an MKS Integrity Client installed on the same system as the
integration.
Local file system access
Integrity Server
Commands run through the API on an MKS Integrity Client have complete file system
access, the same as if they were run directly on the MKS Integrity Client. For more
information, see “Using File References” on page 40.