IBM Cognos Software Development KitVersion 11.1.0

Developer Guide

IBM

Note

Before using this information and the product it supports, read the information in “Notices” on page1925.

Product Information

This document applies to IBM Cognos Software Development Kit Version 11.0.0 and may also apply to subsequentreleases.

Licensed Materials - Property of IBM© Copyright International Business Machines Corporation 2005, 2019.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract withIBM Corp.

Contents

Chapter 1. Introduction......................................................................................... 1

Chapter 2. Understanding the IBM Cognos Software Development Kit.....................3IBM Cognos Architecture.............................................................................................................................3

Service-Oriented Architecture............................................................................................................... 4Access and Authentication.....................................................................................................................4Using the BI Bus API.............................................................................................................................. 5IBM Cognos Analytics Services..............................................................................................................5

IBM Cognos Software Development Kit Components.............................................................................. 11Cognos Software Development Kit...................................................................................................... 11IBM Cognos Framework Manager Development.................................................................................12IBM Cognos Mashup Service............................................................................................................... 12Custom Authentication Provider API...................................................................................................12Script Player......................................................................................................................................... 12Other Customization Capabilities........................................................................................................ 13

Extending IBM Cognos Into Your Business...............................................................................................13Integration, Customization, and Extensibility..................................................................................... 13

Developer Resources................................................................................................................................. 14Product Documentation....................................................................................................................... 14

Chapter 3. Getting started................................................................................... 17BI Bus API..................................................................................................................................................18URL interface..............................................................................................................................................18Script Player............................................................................................................................................... 19IBM Cognos toolkits...................................................................................................................................19

The Java toolkit.................................................................................................................................... 20The .NET Framework toolkit................................................................................................................ 23

Reporting examples...................................................................................................................................24Example - connect to an IBM Cognos Analytics server.......................................................................25Example - log on to an IBM Cognos Analytics server..........................................................................26Example - run a report......................................................................................................................... 28Example - delete a report.................................................................................................................... 33Example - schedule a report................................................................................................................36Example - modify a report....................................................................................................................40Example - run the script player............................................................................................................44

Chapter 4. Managing security...............................................................................45Authenticating Users................................................................................................................................. 45

Authentication Providers......................................................................................................................45Custom Authentication Provider..........................................................................................................45Connect to IBM Cognos Analytics........................................................................................................45Log On................................................................................................................................................... 46Log Off...................................................................................................................................................47

Managing Authorization.............................................................................................................................47Before You Begin.................................................................................................................................. 48Managing Users, Groups, and Roles.................................................................................................... 48Managing Policies.................................................................................................................................49Managing Capabilities.......................................................................................................................... 51

Chapter 5. Managing content............................................................................... 55

iii

Data Integrity............................................................................................................................................. 55Internal Consistency............................................................................................................................ 55Concurrency Control.............................................................................................................................55

Classes and Properties.............................................................................................................................. 56Property Values and Characteristics....................................................................................................56Multilingual Properties......................................................................................................................... 56General Properties............................................................................................................................... 56Changing the Properties of an Object.................................................................................................. 57Retentions Property............................................................................................................................. 57

Relationships Between Objects.................................................................................................................58Parents and Children............................................................................................................................58References............................................................................................................................................59

Querying the Content Store....................................................................................................................... 60Example: Querying the Content Store in Java..................................................................................... 60Steps..................................................................................................................................................... 60

Organizing Objects..................................................................................................................................... 60Creating a Folder Object.......................................................................................................................61Creating a URL Object.......................................................................................................................... 61Creating a Shortcut Object................................................................................................................... 61Copying an Object................................................................................................................................ 61Moving an Object.................................................................................................................................. 61Controlling the Visibility of Objects......................................................................................................61Disabling an Object...............................................................................................................................63Deleting an Object................................................................................................................................ 63Setting the Order of Objects.................................................................................................................63

Managing User Accounts........................................................................................................................... 63Deleting a User Account.......................................................................................................................63Copying a User Account....................................................................................................................... 64

Maintain the Content Store........................................................................................................................64

Chapter 6. Running tasks..................................................................................... 65Using run()..................................................................................................................................................65

How IBM Cognos Builds a Request......................................................................................................66Specifying Options and Parameters.................................................................................................... 66Managing Event History........................................................................................................................69Scheduling Tasks..................................................................................................................................70Retrying Tasks...................................................................................................................................... 72

Running Service-based Tasks....................................................................................................................72Running Reports................................................................................................................................... 72Running Jobs........................................................................................................................................ 75Running Agents.................................................................................................................................... 76Running Content Manager Tasks......................................................................................................... 77Running Metrics Tasks..........................................................................................................................77Running Notification Tasks...................................................................................................................77

Understanding the Asynchronous Conversation.......................................................................................77Primary and Secondary Requests........................................................................................................78Using wait()...........................................................................................................................................78Optimizing the Asynchronous Conversation........................................................................................79The Conversation Context....................................................................................................................80Processing Constraints.........................................................................................................................83

Chapter 7. Dispatchers and services.....................................................................85Standby Dispatchers..................................................................................................................................85Before Using the IBM Cognos Software Development Kit for Server Administration............................. 85Read the Availability of Services and Studios........................................................................................... 85Read the Status of Dispatchers and Services........................................................................................... 86

Stop and Start Dispatchers and Services............................................................................................ 86

iv

Remove Dispatchers from the Environment............................................................................................. 87Steps..................................................................................................................................................... 87

Test Dispatchers........................................................................................................................................ 87Step.......................................................................................................................................................87

Activate a Content Manager Service......................................................................................................... 87Set the Logging Level................................................................................................................................. 88

Logging Properties................................................................................................................................88Steps..................................................................................................................................................... 89

Tune Server Performance.......................................................................................................................... 89Models.................................................................................................................................................. 89Operating Systems............................................................................................................................... 89Tuning Properties................................................................................................................................. 89Steps..................................................................................................................................................... 90

Group Dispatchers in Configuration Folders............................................................................................. 90Steps..................................................................................................................................................... 90

Define Server Groups.................................................................................................................................90Steps..................................................................................................................................................... 90

Configure Advanced Routing..................................................................................................................... 91Steps..................................................................................................................................................... 91

Configure Advanced Settings.................................................................................................................... 91Steps..................................................................................................................................................... 92

Use Advanced Routing...............................................................................................................................92Steps to Use Advanced Routing for Content Store Objects................................................................ 92Steps to Use Advanced Routing for Inline Specifications................................................................... 93

Hot Swapping PowerCubes....................................................................................................................... 93Steps..................................................................................................................................................... 93

Chapter 8. Deploying content............................................................................... 95Creating a Deployment Specification........................................................................................................ 95Exporting Data From the Content Store.................................................................................................... 95Moving the Deployment Archive................................................................................................................95Importing Data Into the Content Store..................................................................................................... 95Accessing Deployment History..................................................................................................................96

Listing the Deployment Archives......................................................................................................... 96Retrieving a Set of Deployment Options..............................................................................................96

Chapter 9. Coding practices and troubleshooting.................................................. 97Coding Practices........................................................................................................................................ 97

Managing Service Headers in Java Applications................................................................................. 97Handling Exceptions.............................................................................................................................99Language-specific Naming Conventions........................................................................................... 108Recommendations for URLs.............................................................................................................. 108Specifying Parameter Values of Type xsdDateTime or xsdDate....................................................... 109Replacing Illegal Characters in MIME Headers.................................................................................110Interpreting Messages that Use Response.Write Format................................................................. 110Localizing API Elements for Non-English Locales.............................................................................110Test Connections to Data Sources.....................................................................................................110

Troubleshooting.......................................................................................................................................110End of line characters removed for MHT and XLWA output..............................................................110Long-running Processes Do Not Complete....................................................................................... 111Data Source Connections are Ambiguous......................................................................................... 111UpdateMetadata Method Fails Unless the IBM Cognos Software Development Kit is Installed

On The Server................................................................................................................................111Using updateMetadata With Multiple Servers...................................................................................111Problems Encountered with Object Retention in Content Manager.................................................111SAP BW Issues Error Messages.........................................................................................................112Problems Using the Java Print Sample on Windows.........................................................................112

v

Report Output in CSV Format Contains an Extra Character..............................................................112Base64 Decoding XLS or singleXLS Formats Creates Invalid Files.................................................. 112IBM Cognos Analytics Reports Run More Slowly than Expected......................................................112Unable to View Metadata in Query Studio After Adding a Query......................................................113Client Applications Cannot Connect to IBM Cognos......................................................................... 113IBM Cognos Portal Services Extended Applications Portlet Not Working........................................113A Namespace with a defaultName Property Cannot be Updated.................................................... 114IBM Cognos Access Manager will Attempt to Authenticate a User who Runs a Report

Associated with an Unauthenticated Data Source.......................................................................114Multithreaded Java Client Causes Deserializer Not Found Error......................................................115Enabling Apache Axis Logging........................................................................................................... 115Using Axis Attachment Support in Java Applications....................................................................... 116Unable to View Running Reports or Jobs.......................................................................................... 116Value keyTransformation of Enumeration Set validateSeverityEnum Only Partially Works............ 116triggerName Issues............................................................................................................................116The Caption of an Unrecoverable Error is not Displayed in the Browser..........................................117Using the selectRoles Method has no Effect.....................................................................................117The Logged Information for Multiple Report Runs are Collapsed under the Same Request Id...... 117Deprecated Methods may Timeout before Returning a Response...................................................117Performance Problems in Java Applications due to Serialization of many Items with xs:nil

value of true.................................................................................................................................. 117Use of SystemMetricThresholds in the Object Model Differs from the Documentation.................. 118ui.drillThroughTargetParameterValues Not For External Use........................................................... 118

Application Development Guidelines......................................................................................................118Recommendation - Managing Long-Running or Resource-Intensive Tasks.................................... 118Recommendation - Managing biBusHeader Objects in Multithreaded Applications.......................119

Chapter 10. Upgrading SDK applications............................................................ 121General Guidelines for Upgrading your Applications............................................................................. 121

Using What's New Appendices to Review Changes.......................................................................... 121Upgrading to IBM Cognos Analytics Version 10.2.0...............................................................................121

Changes to .NET Framework support................................................................................................121Upgrading to IBM Cognos Analytics Version 10.1.0...............................................................................122

Upgrading Java Applications for Axis 1.4..........................................................................................122Changes to the cam_passport cookie............................................................................................... 123Changes to the Microsoft® Excel Output Formats..............................................................................124Multi-Instance IBM Cognos Connection............................................................................................124

Upgrading to IBM Cognos Analytics Version 8.4.................................................................................... 124Changes to Report Specification Validation...................................................................................... 125

Upgrading to IBM Cognos Analytics Version 8.3.................................................................................... 125Changes to Deployment Options....................................................................................................... 125

Chapter 11. Schema reference........................................................................... 127bibus.........................................................................................................................................................127

Chapter 12. Services..........................................................................................129Services in Java....................................................................................................................................... 129Services in C# .NET................................................................................................................................. 129List of Services......................................................................................................................................... 130agentService............................................................................................................................................ 131batchReportService................................................................................................................................. 133contentManagerService...........................................................................................................................134dataIntegrationService............................................................................................................................136dataMovementService.............................................................................................................................137deliveryService........................................................................................................................................ 138dimensionManagementService...............................................................................................................139dispatcher................................................................................................................................................ 140

vi

eventManagementService.......................................................................................................................141idVizService..............................................................................................................................................142indexSearchService................................................................................................................................. 142indexUpdateService.................................................................................................................................143jobService................................................................................................................................................ 145metadataService......................................................................................................................................146migrationService......................................................................................................................................147mobileService.......................................................................................................................................... 148monitorService.........................................................................................................................................149planningAdministrationConsoleService..................................................................................................150planningRuntimeService......................................................................................................................... 150planningTaskService................................................................................................................................151powerPlayService.................................................................................................................................... 151queryService............................................................................................................................................ 153relationalMetadataService...................................................................................................................... 153reportService........................................................................................................................................... 154repositoryService.....................................................................................................................................156saCAMService.......................................................................................................................................... 156systemService..........................................................................................................................................157

Chapter 13. Method sets.................................................................................... 159agent........................................................................................................................................................ 159asynch...................................................................................................................................................... 159authentication..........................................................................................................................................160content..................................................................................................................................................... 160dataSource...............................................................................................................................................161delivery.....................................................................................................................................................162deployment..............................................................................................................................................162dispatcher................................................................................................................................................ 162drillThrough..............................................................................................................................................163event........................................................................................................................................................ 163indexTerm................................................................................................................................................ 164indexUpdate.............................................................................................................................................164metadata..................................................................................................................................................165monitor.....................................................................................................................................................165paging.......................................................................................................................................................165parameter................................................................................................................................................ 166promptPaging.......................................................................................................................................... 166report....................................................................................................................................................... 167rolapCubeAdministration........................................................................................................................ 168standaloneCAM........................................................................................................................................168system......................................................................................................................................................169validate.....................................................................................................................................................169

Chapter 14. Methods..........................................................................................171Methods in Java....................................................................................................................................... 171activate(searchPath)................................................................................................................................171activateURI(uri)....................................................................................................................................... 172add(parentPath, objects, options).......................................................................................................... 173add(objectPath, parameterValues, options)...........................................................................................176add(parentPath, object, options)............................................................................................................ 177addAnnotations(containerPath, objects, options)..................................................................................181addDrillPath(parentPath, object, options).............................................................................................. 183addNotification(objectPath).................................................................................................................... 185addTermAssociation(term, parameterValues, options)......................................................................... 187back(conversation, parameterValues, options)......................................................................................188background(conversation)...................................................................................................................... 190

vii

cancel(conversation)............................................................................................................................... 191cancelEvent(eventID).............................................................................................................................. 194cancelEvents(eventIDs).......................................................................................................................... 195clearCubeWorkloadLog(cubeNames, parameterValues, options)......................................................... 196clearNotifications(objectPath)................................................................................................................ 198collectParameterValues(objectPath, parameterValues, options)..........................................................200collectParameterValues(objectPath, parameterValues, options) – obsolete....................................... 202collectParameterValuesSpecification(specification, parameterValues, options)................................. 203collectParameterValuesSpecification(specification, parameterValues, options) – obsolete............... 207convertDrillThroughContext(inputContext, parameterValues, options)................................................ 208copy(objects, targetPath, options).......................................................................................................... 209copyAccount(sourceAccountPath, targetAccountPath, options)...........................................................212copyRename(objects, targetPath, newNames, options)........................................................................ 213currentPage(conversation, parameterValues, options)..........................................................................215delayEventsFor(eventIDs, for)................................................................................................................ 217delayEventsUntil(eventIDs, until)........................................................................................................... 219delete(objects, options).......................................................................................................................... 220delete(objectPath, parameterValues, options).......................................................................................222deleteAccount(objectPath, options)....................................................................................................... 224deleteAllNotifications()........................................................................................................................... 225deleteHotList(objectPath)....................................................................................................................... 226deleteNotification(objectPath)................................................................................................................227deleteTenants(tenantIDs)....................................................................................................................... 229deleteTermAssociation(term, parameterValues, options)..................................................................... 230deliver(conversation, parameterValues, options).................................................................................. 231determineRouting(objectPaths)..............................................................................................................234drill(conversation, parameterValues, options)....................................................................................... 236findDrillThroughPaths(objectPath, parameterValues, options)............................................................. 237firstPage(conversation, parameterValues, options)............................................................................... 239forward(conversation, parameterValues, options).................................................................................242get(objectPath, parameterValues, options)............................................................................................244getActiveContentManager().................................................................................................................... 245getConfiguration(properties)...................................................................................................................245getContext(conversation, parameterValues, options)............................................................................247getCubeMessages(cubeNames, parameterValues, options)................................................................. 249getCubeMetrics(cubeNames, parameterValues, options)..................................................................... 250getCubeState(cubeNames, parameterValues, options).........................................................................252getDeploymentOptions(archive, options)...............................................................................................254getFormatSamples(name).......................................................................................................................255getIdentity().............................................................................................................................................257getObjectContext(objectPath, parameterValues, options).................................................................... 257getOutput(conversation, parameterValues, options)............................................................................. 259getParameters(objectPath, parameterValues, options).........................................................................262getParametersSpecification(specification, parameterValues, options)................................................ 265getPromptValues(conversation, parameterValues, options)................................................................. 268getPromptValues(conversation, parameterValues, options) – obsolete............................................... 270holdEvent(eventID)................................................................................................................................. 271holdEvents(eventIDs)..............................................................................................................................273incrementallyLoadCubes(cubeNames, parameterValues, options)...................................................... 274lastPage(conversation, parameterValues, options)................................................................................276lineage(conversation, parameterValues, options)..................................................................................278listArchives()............................................................................................................................................ 280listTenants(options).................................................................................................................................281logoff()......................................................................................................................................................282logon(credentials, roles)..........................................................................................................................283mapContentLocale(locale, normalize).................................................................................................... 285mapProductLocale(locale, normalize).................................................................................................... 287move(objects, targetPath, options).........................................................................................................288

viii

moveRename(objects, targetPath, newNames, options).......................................................................290nextPage(conversation, parameterValues, options).............................................................................. 292normalizeLocale(locale).......................................................................................................................... 295pauseCubes(cubeNames, parameterValues, options)...........................................................................296ping(dispatcherPath)............................................................................................................................... 297previousPage(conversation, parameterValues, options)....................................................................... 299query(searchPath, properties, sortBy, options)......................................................................................301query(objectPath, parameterValues, options)........................................................................................304queryDrillPath(objectPath, parameterValues, options)......................................................................... 308queryMetadata(request)......................................................................................................................... 310queryMultiple(requests)..........................................................................................................................311queryMultipleCache(requests, options)................................................................................................. 312queryNotification(objectPath).................................................................................................................313queryTenantMembership(tenantIDs)..................................................................................................... 315refreshCubeDataCache(cubeNames, parameterValues, options)......................................................... 316refreshCubeMemberCache(cubeNames, parameterValues, options)................................................... 318refreshCubeSecurity(cubeNames, parameterValues, options)............................................................. 320release(conversation)..............................................................................................................................321releaseEvent(eventID).............................................................................................................................325releaseEvents(eventIDs)......................................................................................................................... 326render(conversation, parameterValues, options)...................................................................................327restartCubes(cubeNames, parameterValues, options)..........................................................................330retrieveCredential(namespace).............................................................................................................. 331run(objectPath, parameterValues, options)............................................................................................333runAt(startTime, objectPath, parameterValues, options)...................................................................... 339runSpecification(specification, parameterValues, options)................................................................... 342scheduleEvent(eventID)..........................................................................................................................353scheduleEvents(eventIDs)...................................................................................................................... 354selectRoles(roles)....................................................................................................................................355startCubes(cubeNames, parameterValues, options)............................................................................. 356startService(servicePath)........................................................................................................................ 358stopCubes(cubeNames, parameterValues, options)..............................................................................359stopService(servicePath, immediately).................................................................................................. 361terminateSessions(search)..................................................................................................................... 362testDataSourceConnection(connectionString, credentials)...................................................................363testDataSourceConnection(connectionString, credentials) – obsolete................................................ 366testDataSourceConnectionWithInfo(connectionString, credentials).................................................... 367trigger(triggerName)................................................................................................................................368update(objects, options)......................................................................................................................... 370update(object, options)........................................................................................................................... 372updateDrillPath(object, options).............................................................................................................375updateEvents(events)............................................................................................................................. 377updateMetadata(request)....................................................................................................................... 378validate(objectPath, parameterValues, options) – obsolete..................................................................380validate(objectPath, parameterValues, options).................................................................................... 380validateContentLocale(locale)................................................................................................................ 384validateProductLocale(locale).................................................................................................................385validateSpecification(specification, parameterValues, options) – obsolete......................................... 386validateSpecification(specification, parameterValues, options)............................................................386wait(conversation, parameterValues, options).......................................................................................391

Chapter 15. Classes........................................................................................... 397Classes in Java.........................................................................................................................................397account.................................................................................................................................................... 397adaptiveAnalyticsService........................................................................................................................ 406addOptions...............................................................................................................................................410addressSMTP........................................................................................................................................... 411

ix

addressSMTPArrayProp...........................................................................................................................412addressSMTPProp................................................................................................................................... 412adminFolder.............................................................................................................................................412agentDefinition........................................................................................................................................ 414agentDefinitionView.................................................................................................................................415agentOption............................................................................................................................................. 416agentOptionBoolean................................................................................................................................416agentOutputEnumProp............................................................................................................................416agentOutputHotList................................................................................................................................. 417agentService............................................................................................................................................ 418agentState................................................................................................................................................420agentTaskDefinition................................................................................................................................. 422agentTaskState........................................................................................................................................ 424aliasLocation – obsolete..........................................................................................................................425aliasRoot.................................................................................................................................................. 425analysis.................................................................................................................................................... 426ancestorInfo............................................................................................................................................ 427ancestorInfoArrayProp............................................................................................................................ 428ancestorInfoProp.....................................................................................................................................428annotation................................................................................................................................................429annotationFolder..................................................................................................................................... 430annotationService....................................................................................................................................431anyTypeMIMEProp...................................................................................................................................433anyTypeProp............................................................................................................................................ 433anyURIArrayProp.....................................................................................................................................435anyURIProp..............................................................................................................................................435archiveDescriptor.................................................................................................................................... 436archiveLocation........................................................................................................................................439archiveOption...........................................................................................................................................439archiveOptionConflictResolution............................................................................................................ 440archiveOptionDescriptor......................................................................................................................... 440archiveOptionSearchPathSingleObject...................................................................................................441archiveOptionString.................................................................................................................................441asynchDetail............................................................................................................................................ 442asynchDetailAgentNotificationStatus..................................................................................................... 443asynchDetailAsynchSpecification........................................................................................................... 443asynchDetailContext................................................................................................................................444asynchDetailCount...................................................................................................................................444asynchDetailDrillPathObject................................................................................................................... 445asynchDetailDrillThroughRequest.......................................................................................................... 445asynchDetailDrillThroughTarget.............................................................................................................. 447asynchDetailDrillThroughTargetURI........................................................................................................449asynchDetailEventID............................................................................................................................... 449asynchDetailEventRecord....................................................................................................................... 450asynchDetailIndexData........................................................................................................................... 454asynchDetailIndexTerms.........................................................................................................................455asynchDetailMessages............................................................................................................................ 456asynchDetailMIMEAttachment............................................................................................................... 456asynchDetailParameters......................................................................................................................... 457asynchDetailParameterValues................................................................................................................ 457asynchDetailPromptPage........................................................................................................................ 458asynchDetailReportMetadata..................................................................................................................458asynchDetailReportObject...................................................................................................................... 459asynchDetailReportOutput......................................................................................................................459asynchDetailReportStatus.......................................................................................................................461asynchDetailReportValidation.................................................................................................................461asynchDetailROLAPDataSourceState..................................................................................................... 462asynchDetailROLAPMessages.................................................................................................................462

x

asynchDetailROLAPMetrics.....................................................................................................................463asynchDetailSelectionContext................................................................................................................ 463asynchDetailUnstructuredData............................................................................................................... 464asynchOption........................................................................................................................................... 464asynchOptionBoolean............................................................................................................................. 465asynchOptionEncoding............................................................................................................................465asynchOptionInt...................................................................................................................................... 465asynchOptionSearchPathSingleObject................................................................................................... 466asynchOptionSearchPathSingleObjectArray.......................................................................................... 466asynchOptionStringArray........................................................................................................................ 466asynchReply.............................................................................................................................................467asynchRequest........................................................................................................................................ 469asynchSecondaryRequest....................................................................................................................... 471asynchSpecification.................................................................................................................................471auditLevelEnumProp............................................................................................................................... 472authoredAgentDefinition......................................................................................................................... 476authoredPowerPlay8Report....................................................................................................................478authoredReport....................................................................................................................................... 479base64BinaryMIMEProp......................................................................................................................... 483baseAgentDefinition................................................................................................................................ 483baseAgentDefinitionActionEnumProp.................................................................................................... 488baseClass.................................................................................................................................................489baseClassArrayProp................................................................................................................................ 499baseClassProp......................................................................................................................................... 502baseDataIntegrationTask........................................................................................................................ 503baseDataMovementTask......................................................................................................................... 507baseHistoryDetail.................................................................................................................................... 511baseParameter........................................................................................................................................ 512baseParameterAssignment..................................................................................................................... 513baseParameterAssignmentArrayProp.................................................................................................... 514baseParameterAssignmentProp............................................................................................................. 514basePowerPlay8Report........................................................................................................................... 515basePowerPlay8ReportActionEnumProp............................................................................................... 518basePowerPlayClass................................................................................................................................518baseProp.................................................................................................................................................. 520baseReport...............................................................................................................................................523baseReportActionEnumProp...................................................................................................................530baseROLAPCubeConfiguration................................................................................................................530baseROLAPCubeConfigurationArrayProp............................................................................................... 533baseROLAPCubeConfigurationProp........................................................................................................533baseROLAPDataSource........................................................................................................................... 533baseRoutingRule......................................................................................................................................535baseRSSTask............................................................................................................................................535batchReportService................................................................................................................................. 538biBusHeader............................................................................................................................................ 544biBusHeaderExtension1..........................................................................................................................546booleanProp.............................................................................................................................................546boundRangeParmValueItem................................................................................................................... 548cacheOutput............................................................................................................................................ 549CAF........................................................................................................................................................... 551CAM.......................................................................................................................................................... 551CAMException..........................................................................................................................................554CAMPassport........................................................................................................................................... 556CAMProtect.............................................................................................................................................. 557CAMSettings.............................................................................................................................................558capability..................................................................................................................................................558catalog......................................................................................................................................................559catalogFolder........................................................................................................................................... 560

xi

classEnumArrayProp............................................................................................................................... 560classEnumProp........................................................................................................................................ 561configuration............................................................................................................................................561configurationData.................................................................................................................................... 625configurationFolder................................................................................................................................. 628contact..................................................................................................................................................... 685content..................................................................................................................................................... 690contentManagerCacheService................................................................................................................ 693contentManagerQueryOption..................................................................................................................694contentManagerQueryOptionBoolean.................................................................................................... 695contentManagerQueryOptionInt.............................................................................................................695contentManagerQueryOptionPropEnumArray........................................................................................695contentManagerQueryOptionRefPropArray............................................................................................696contentManagerQueryOptionString........................................................................................................ 696contentManagerService...........................................................................................................................696contentStoreUtilizationConfiguration..................................................................................................... 699contentTask..............................................................................................................................................700contentTaskOption.................................................................................................................................. 703contentTaskOptionAuditLevelEnum........................................................................................................704contentTaskOptionBoolean.....................................................................................................................704contentTaskOptionClassEnumArray....................................................................................................... 704contentTaskOptionCSUtilizationConfiguration....................................................................................... 705contentTaskOptionRetentionRuleArray.................................................................................................. 705contentTaskOptionSearchPathSingleObjectArray..................................................................................705contextOption.......................................................................................................................................... 706contextOptionFormat.............................................................................................................................. 706contextOptionStringArray........................................................................................................................707contextOptionType.................................................................................................................................. 707conversationContext................................................................................................................................708cookieVar................................................................................................................................................. 709copyAccountOption................................................................................................................................. 710copyAccountOptionBoolean....................................................................................................................710copyOptions............................................................................................................................................. 710credential................................................................................................................................................. 712currency................................................................................................................................................... 713currencyArrayProp...................................................................................................................................714currencyProp............................................................................................................................................715dashboard................................................................................................................................................ 715dataAdvisorService..................................................................................................................................718dataIntegrationService............................................................................................................................719dataIntegrationServiceSpecification...................................................................................................... 721dataIntegrationServiceSpecificationArrayProp......................................................................................722dataIntegrationServiceSpecificationProp...............................................................................................722dataIntegrationTaskOption..................................................................................................................... 723dataIntegrationTaskOptionBoolean........................................................................................................723dataMovementService.............................................................................................................................723dataMovementServiceSpecification....................................................................................................... 728dataMovementServiceSpecificationProp................................................................................................728dataMovementTask................................................................................................................................. 729dataMovementTaskAlias......................................................................................................................... 730dataSet.....................................................................................................................................................731dataSetFolder.......................................................................................................................................... 732dataSource...............................................................................................................................................732dataSourceCommandBlock.....................................................................................................................734dataSourceCommandBlockProp.............................................................................................................735dataSourceConnection............................................................................................................................ 735dataSourceCredential..............................................................................................................................737dataSourceNameBinding.........................................................................................................................739

xii

dataSourceSignon....................................................................................................................................739dateTimeProp...........................................................................................................................................740decimalProp.............................................................................................................................................741deleteOptions.......................................................................................................................................... 742deliveryOption......................................................................................................................................... 743deliveryOptionAddressSMTPArray..........................................................................................................743deliveryOptionChannel............................................................................................................................ 744deliveryOptionMemoPart........................................................................................................................ 744deliveryOptionSearchPathMultipleObjectArray..................................................................................... 744deliveryOptionSearchPathSingleObject..................................................................................................745deliveryOptionString................................................................................................................................745deliveryService........................................................................................................................................ 745deliveryServiceSpecification................................................................................................................... 748deploymentDetail.................................................................................................................................... 748deploymentImportRule...........................................................................................................................750deploymentObjectInformation............................................................................................................... 751deploymentOption...................................................................................................................................752deploymentOptionAnyType.....................................................................................................................753deploymentOptionArrayProp.................................................................................................................. 753deploymentOptionAuditLevel................................................................................................................. 754deploymentOptionBoolean..................................................................................................................... 754deploymentOptionClassEnumArray........................................................................................................755deploymentOptionImportRuleArray....................................................................................................... 755deploymentOptionMultilingualString......................................................................................................755deploymentOptionObjectInformationArray........................................................................................... 756deploymentOptionProp........................................................................................................................... 756deploymentOptionResolution................................................................................................................. 756deploymentOptionSearchPathSingleObjectArray.................................................................................. 757deploymentOptionString......................................................................................................................... 757deploymentOptionStringArray................................................................................................................ 758deploymentReference............................................................................................................................. 758deploymentReferenceArrayProp.............................................................................................................759deploymentReferenceProp..................................................................................................................... 759deploymentStatusEnumProp.................................................................................................................. 760dimensionManagementService...............................................................................................................760dimensionManagementServiceSpecification......................................................................................... 764directory...................................................................................................................................................765dispatcher................................................................................................................................................ 766dispatcherTransportVar...........................................................................................................................830displayObject........................................................................................................................................... 831distributionList.........................................................................................................................................831document.................................................................................................................................................834documentContent....................................................................................................................................836documentVersion.....................................................................................................................................839drillOption................................................................................................................................................ 840drillOptionParameterValues....................................................................................................................841drillPath....................................................................................................................................................841drillThroughAction................................................................................................................................... 845drillThroughOption...................................................................................................................................845drillThroughOptionAnyURI...................................................................................................................... 845drillThroughOptionBoolean..................................................................................................................... 846drillThroughOptionXMLEncodedXML...................................................................................................... 846drillThroughPath...................................................................................................................................... 847durationProp............................................................................................................................................ 847environmentVar....................................................................................................................................... 848eventManagementService.......................................................................................................................848eventManagementServiceSpecification..................................................................................................849eventRecord.............................................................................................................................................850

xiii

eventTypeEnumArrayProp.......................................................................................................................852eventTypeEnumProp............................................................................................................................... 852EVService................................................................................................................................................. 853exportDeployment...................................................................................................................................854faultDetail................................................................................................................................................ 856faultDetailArrayProp................................................................................................................................857faultDetailMessage.................................................................................................................................. 857faultDetailProp.........................................................................................................................................858favoritesFolder.........................................................................................................................................858floatProp.................................................................................................................................................. 859folder..................................................................................