MKS Integrity 2007 Integrations Builder Guide

More documents

Recommendations

Info

Table of Contents ii Catching Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Work Item Exceptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 API Connection Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Command Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Application Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Internal Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 MKS Integrity Client Launch Exceptions. . . . . . . . . . . . . . . 33 Interrupted Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 C API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 C API Application Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Internal Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Command Variations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Using the Graphical User Interface . . . . . . . . . . . . . . . . . . . . . . . . 37 GUI for Status Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 GUI for Prompting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Full GUI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Using Interim Responses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Using Impersonation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Using File References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Integration Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Current Working Directory . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Location of the API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Using Uncertified Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Best Practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Copying the API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Managing Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Single User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Multiple Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Dedicated Sessions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Memory Management Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Using Facade Patterns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Converting MKS Source Scripts to API Programs . . . . . . . . . . . 48 Accessing Item Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Retrieving Item Fields as Strings for the Java API . . . . . . . 49 Retrieving Item Fields as Strings for the C API. . . . . . . . . . 49 Creating Programs for the C API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 4 API Certified Commands . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Format for Command Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 Certified Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 MKS Integrity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 MKS Source. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Standard Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 Unicode Support for C API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 User Item Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Date and Datetime Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 MKS Integrity Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 about . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 columnsets/viewcolumnset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Table of Contents connect. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 copyissue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 cpattributes/viewcpattribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 cpentryattributes/viewcpentryattribute . . . . . . . . . . . . . . . . . . . 59 cps/viewcp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 cptypes/viewcptype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 createcp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 createcpattribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 createcpentry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 createcpentryattribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 createcptype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 createissue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 deletecp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 deletecpattribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 deletecpentry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 deletecpentryattribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 deletecptype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 disconnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 editcpattribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 editcpentry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 editcpentryattribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 editcptype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 editissue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 extractattachments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 fields/viewfield . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 groups/viewgroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 importissue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 issues/viewissue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 projects/viewproject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 queries/viewquery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 states/viewstate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 types/viewtype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 users/viewuser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 viewcolumnset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 viewcp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 viewcpattribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 viewcpentryattribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 viewcptype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 viewfield . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 viewgroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 viewissue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 viewproject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 viewquery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 viewstate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 viewtype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 viewuser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 MKS Source Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 iii
Page 1 and 2: ® Integrity MKS Integrity 2007 Int
Page 3: Table of Contents Chapters 1 Introd
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?