MKS Integrity 2007 Integrations Builder Guide

More documents

Recommendations

Info

Chapter 3: Using the MKS API API Documentation 12 Details of all Java public classes and all C functions are provided in separate documents. Java API Documentation The Java API public classes are documented in the MKS Java API documentation, which can be accessed through the MKS Integrity Server Web page. If this documentation is not available through the Web page, contact your administrator. The MKS Java API documentation contains the following packages: com.mks.api contains classes and methods used to run API commands. com.mks.api.response contains classes and methods used to access API responses. com.mks.api.si contains model type constants for MKS Source. com.mks.api.im contains model type constants for MKS Integrity. com.mks.api.ic contains model type constants for the MKS Integrity Client. com.mks.api.util contains classes and methods used for testing API commands. C API Documentation The C API functions are documented in the MKS ANSI C API documentation, which can be accessed through the MKS Integrity Server Web page. If this documentation is not available through the Web page, contact your administrator. The MKS ANSI C API documentation contains the following packages: mksCommand.h contains functions used to run API commands. mksError.h contains the error codes that can be returned by API commands. mksLog.h contains functions used to log API messages. mksResponse.h contains functions used to access API responses. mksResponseUtil.h contains functions used for displaying API responses. mksVersion.h contains the MKS API version. mksapi.h includes all of the above.
Setting Up Your Environment The following environment setup is required for the MKS API. Java API Environment Setting Up Your Environment You can use the Java version of the API with any platform that has a supported version of the Java Runtime Environment (JRE). For details on the supported versions, see “Supported Configurations” on page 99. C API Environment NOTE MKS recommends using JRE 1.5. You cannot use the Java API with Integrity products prior to version 4.6. The C version of the API is implemented using ANSI C. You can use the C API with any ANSI C compiler on supported platforms. When compiling on a Windows platform, you need to use the _stdcall calling convention. For details on the supported platforms, see the MKS Integrity Server 2007 Administration Guide. NOTE You cannot use the C API with Integrity products prior to version 2005. To use the C API libraries on any UNIX platform, you need to set the environment variable LD_LIBRARY_PATH=$CLIENT_DIR/lib/$sys (for HP-UX set SHLIB_PATH, for AIX set LIBPATH). For North American UNIX servers to view German characters through the C API, the locale needs to be set correctly using setlocale(). If the locale is not set correctly, German characters come out as ?. To correctly set the locale, do one of the following: In a shell, #export LC_ALL=en_US.ISO8859-1 In a C program, setlocale(LC_ALL, ""); The C API uses the OpenSSL package to communicate with the MKS Integrity Server via SSL when using a secure integration point. This package requires the /dev/[u]random device. If your platform does not have this device, one of the following packages can be installed and used: EGD: The Entropy Gathering Daemon (http://egd.sourceforge.net) PRNGD: Pseudo Random Number Generator Daemon (http://www.aet.tucottbus.de/personen/jaenicke/postfix_tls/prngd.html) 13
Page 1 and 2: ® Integrity MKS Integrity 2007 Int
Page 3 and 4: Table of Contents Chapters 1 Introd
Page 5 and 6: Table of Contents connect. . . . .
Page 7 and 8: Table of Contents Using API Logging
Page 9 and 10: C HAPTER ONE Introduction Understan
Page 11 and 12: C HAPTER TWO Understanding the MKS
Page 13 and 14: Integration Scenarios integrations,
Page 15 and 16: Automatically starting the MKS Inte
Page 17 and 18: Where To Go Next Where To Go Next T
Page 19: C HAPTER THREE Using the MKS API De
Page 23 and 24: Integration Objects If you are inte
Page 25 and 26: Integration Objects A session maint
Page 27 and 28: For example, for the si about comma
Page 29 and 30: Java Example: Retrieving the item I
Page 31 and 32: Running Commands type values, items
Page 33 and 34: field = mksItemGetField(first, "Sta
Page 35 and 36: Field: Name = Summary Data Type = j
Page 37 and 38: API Connection Exceptions Applicati
Page 39 and 40: Running Commands The following tabl
Page 41 and 42: C API Errors Running Commands Curre
Page 43 and 44: Error Code Description Reason for E
Page 45 and 46: Using the Graphical User Interface
Page 47 and 48: To use interim responses for the Ja
Page 49 and 50: Location of the API Best Practices
Page 51 and 52: Set only to override client default
Page 53 and 54: Session session = intPt.createSessi
Page 55 and 56: mksResponse response = NULL; mksrtn
Page 57 and 58: Accessing Item Fields Best Practice
Page 59 and 60: HP/UX You need: -I/include as a co
Page 61 and 62: C HAPTER FOUR API Certified Command
Page 63 and 64: Certified Commands MKS Integrity MK
Page 65 and 66: Standard Data Types There is no Un
Page 67 and 68: Work item The change package attrib
Page 69 and 70: cps/viewcp MKS Integrity Commands T
Page 71 and 72:
createcpattribute createcpentry MKS
Page 73 and 74:
deletecpentry MKS Integrity Command
Page 75 and 76:
editcptype editissue Work Item The
Page 77 and 78:
importissue issues/viewissue MKS In
Page 79 and 80:
states/viewstate You can use this v
Page 81 and 82:
viewproject viewquery viewstate vie
Page 83 and 84:
archiveinfo Work Item The location
Page 85 and 86:
closecp co Work Item Result Specifi
Page 87 and 88:
createsandbox MKS Source Commands U
Page 89 and 90:
lock Field Data Type Description Pr
Page 91 and 92:
projectco projectinfo The following
Page 93 and 94:
projects rename Field Data Type Des
Page 95 and 96:
evert Work Item Result Specifies th
Page 97 and 98:
unlock viewhistory Field Data Type
Page 99 and 100:
for a Sandbox/former Sandbox, no co
Page 101 and 102:
C HAPTER FIVE Administrating the MK
Page 103 and 104:
Server Integration Point Policy Def
Page 105 and 106:
Command Compatibility Patch Managem
Page 107 and 108:
Supported Configurations The MKS AP
Page 109 and 110:
Index A about command 58 access met
Page 111 and 112:
deletecp command 64 deletecpattribu
Page 113 and 114:
supported configurations 99 T troub
Page 115 and 116:
Product Notices Copyright © 2001-2
Page 117 and 118:
Cryptix General License Copyright
Page 119 and 120:
the above copyright notice, this li
Page 121 and 122:
The following software may be inclu
Page 123 and 124:
different components. For example,
show all

MKS Integrity 2007 Integrations Builder Guide

Create successful ePaper yourself

Delete template?

Save as template?