MKS Integrity 2007 Integrations Builder Guide

More documents

Recommendations

Info

Chapter 3: Using the MKS API Using File References 40 Some application commands reference the file system either as an input or output, for example: MKS Source Sandbox commands MKS Source check out command MKS Source check in command MKS Source command that provide bulk data transfer MKS Integrity commands that specify an image or item attachment These commands still interact with the file system when run through the API. There are three things to keep in mind when working with commands with file system references: integration point current working directory location of the API Integration Point File system references are applied at the integration point not at the integration location. When constructing a command to send to a remote integration point, the file system references must be valid on the remote system, which is where the files are read or written. All file system references are valid when using an MKS Integrity Client as an integration point. All file references on the MKS Integrity Server are restricted to server/temp in the server install directory for security reasons. If you need complete file system access, but want to integrate your server application directly to an MKS Integrity Server, consider the scenario described in “Integrating With the MKS Integrity Client as Server” on page 7. Current Working Directory Several commands have implicit logic to derive settings that are not specified in the command by searching the system, starting with the current working directory. When using the API, if no current working directory (--cwd) setting has been set on the command, the directory that the current integration application started in is used as the current working directory. For this reason, you must either explicitly include all settings for files (for example, the Sandbox or project name) or determine what the current working directory should be and pass it as the --cwd setting for all commands that use it.
Location of the API Best Practices The si projectadd, si projectco, and si projectci commands enable you to transfer bulk data by specifying a source or output file. If you use these commands through the API and want to transfer bulk data to the API's file system rather than the Integration Point’s file system, you must create a special command option. For the MKS Java API, you create this option using the com.mks.api.FileOption class. For the MKS C API, you create this option using the mksOptionListAddFile method. When you use this option, any file locations that you specify are relative to the location of the API. For more information on Java API classes or C API methods, see the MKS Java API documentation or MKS C API documentation, both of which can be accessed through the MKS Integrity Server Web page. For more information on the bulk data commands, see the si projectadd, si projectco, and si projectci commands in the MKS Source 2007 CLI Reference Guide and the im extractattachments command in the MKS Integrity 2007 CLI Reference Guide. Using Uncertified Commands You can use uncertified commands to initiate commands and views that use the GUI. Much of the response content for uncertified commands is missing or incomplete. Some uncertified commands throw command level exceptions. Uncertified command responses contain: the application and command the exit code (same as the CLI) exceptions containing only a message, no ID or fields results containing only a message Any data returned by uncertified commands, and even the entire response structure, is subject to change when the commands are certified, and should not be used. For a list of certified commands, see “API Certified Commands” on page 53. Best Practices This section describes some of the recommended practices for using the API: “Copying the API” on page 42 “Managing Users” on page 42 “Memory Management Tips” on page 47 “Using Facade Patterns” on page 48 41
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 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: To use interim responses for the Ja
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?