MKS Integrity 2007 Integrations Builder Guide

Chapter 3: Using the MKS API
Copying the API
Managing Users
42
“Converting MKS Source Scripts to API Programs” on page 48
“Accessing Item Fields” on page 49
If you are using the API, when you run your integration you should use the same version of
the API that you used to compile your integration. It should be copied and bundled with the
integration. If you rely on the API that is installed on the client or server, when the version
number changes (that is, when the client or server is upgraded), the next time you try to run
your integration you may have binary compatibility issues. For more information, see “Java
and C API Compatibility” on page 96.
NOTE You should also keep a copy of the matching MKS API documentation from
the MKS Integrity Server.
As an alternative to keeping a copy of the API, you could make sure that a newly compiled
version of your integration is used with the upgraded API files.
An integration uses sessions differently depending on the number of users it is managing. To
best understand the information in this section, you should be familiar with the information
outlined in “Sessions” on page 16.
Single User
A single user session is the scenario that a lot of scripts are written for: running a sequence of
commands for a single user. A single user session can be used for a client or server
integration point. The following examples show how to create a single user session for both
integration points.
NOTE You specify the user and password in two places. The session is used to
validate that you have authority to create a session on the server integration point.
The command runner defaults identify the user to run the command as. A different
user and password could be used for each of these.
Java Example: Client Integration
IntegrationPointFactory ipf =
IntegrationPointFactory.getInstance();
CmdRunner cmdRunner =
ipf.createLocalIntegrationPoint()
.getCommonSession()
.createCmdRunner();