MKS Integrity 2007 Integrations Builder Guide

More documents

Recommendations

Info

MKS Integrity 2007 Integrations Builder Guide Copyright © 2001–2007 MKS Software Inc.; in Canada copyright owned by MKS Inc. All rights reserved. MKS makes no warranty of any kind with regard to this material, including, but not limited to the implied warranties of merchant ability, performance, or fitness for a particular purpose. MKS shall not be liable for errors contained herein, or for any direct, indirect, incidental, or consequential damages resulting from the use of this material. No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language in any form by any means, without written permission from MKS. MKS, MKS Source Integrity, MKS Integrity Manager, Implementer, MKS Toolkit, Sandbox, NuTCRACKER, MKS Integrity Solution, AlertCentre, MKS Integrity Suite, and MKS Federated Server are trademarks or registered trademarks of MKS Inc. All other trademarks or registered trademarks are the property of their respective holders. Corporate Headquarters Worldwide Offices: 410 Albert Street Waterloo, ON N2L 3V3 Canada tel: 519 884 2251 fax: 519 884 8861 sales (toll free): 800 265 2797 www.mks.com This document is uncontrolled when printed or copied. 1815 South Meyers Rd. Suite 220 Oakbrook Terrace, IL USA 60181 tel: 630 827 4900 fax: 630 629 9167 sales (toll free): 800 633 1235 12701 Fair Lakes Circle Suite 350 Fairfax, VA USA 22033 tel: 1 703 803 3343 fax: 1 703 803 3344 sales (toll free): 1 800 637 8034 Martinstraße 42-44 73728 Esslingen Germany tel: +49 711 351775 0 fax: +49 711 351775 7555 Third Floor, Duke’s Court Duke Street, Woking Surrey GU21 5BH United Kingdom tel: +44 (0)1483 733900 fax: +44 (0)1483 733901 sales: +44 (0)1483 733919 3 Killiney Road #07-05 Winsland House 1 Singapore 239519 tel: +65-6732-8768 fax: +65-6732-0768 Ebisu Garden Place Tower 18F Ebisu 4-20-3 Shibuya-ku, Tokyo, Japan 150-6018 tel: 03-5789-5862 fax: 03-5789-5757
Table of Contents Chapters 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 About This Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Assumptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 2 Understanding the MKS API . . . . . . . . . . . . . . . . . . . . . . . . 3 The API Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Integration Scenarios. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Integrating With the MKS Integrity Client . . . . . . . . . . . . . . . . . . 6 Integrating With the MKS Integrity Server . . . . . . . . . . . . . . . . . . 7 Integrating With the MKS Integrity Client as Server . . . . . . . . . . 7 Integrating Your Desktop With the MKS Integrity Server . . . . . 8 Where To Go Next . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 3 Using the MKS API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 API Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Java API Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 C API Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Setting Up Your Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Java API Environment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 C API Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Integration Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Integration Points. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Controlling Access to an Integration Point . . . . . . . . . . . . . 14 Communicating With an Integration Point . . . . . . . . . . . . . 14 Creating an Integration Point. . . . . . . . . . . . . . . . . . . . . . . . . 15 Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Session Caching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Using a Common Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Creating a Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Command Runners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Running Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Specifying a Command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Default Command Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Executing a Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Reading Responses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Creation Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Action Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 View Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Command Response Summary . . . . . . . . . . . . . . . . . . . . . . . 25 Viewing Responses With the API Viewer Utility . . . . . . . . 26 Java API Exceptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 i
Page 1: ® Integrity MKS Integrity 2007 Int
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 and 20: C HAPTER THREE Using the MKS API De
Page 21 and 22: Setting Up Your Environment The fol
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?