IBM Cognos Software Development KitVersion 11.0.0

Developer Guide

IBM

Note

Before using this information and the product it supports, read the information in Notices on page1947.

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, 2018.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.................................................................................................................... 34Example - schedule a report................................................................................................................37Example - modify a report....................................................................................................................42Example - run the script player............................................................................................................46

Chapter 4. Managing security...............................................................................49Authenticating Users................................................................................................................................. 49

Authentication Providers......................................................................................................................49Custom Authentication Provider..........................................................................................................49Connect to IBM Cognos Analytics........................................................................................................49Log On................................................................................................................................................... 50Log Off...................................................................................................................................................51

Managing Authorization.............................................................................................................................51Before You Begin.................................................................................................................................. 52Managing Users, Groups, and Roles.................................................................................................... 52Managing Policies.................................................................................................................................53Managing Capabilities.......................................................................................................................... 55

Chapter 5. Managing content............................................................................... 59

iii

Data Integrity............................................................................................................................................. 59Internal Consistency............................................................................................................................ 59Concurrency Control.............................................................................................................................59

Classes and Properties.............................................................................................................................. 60Property Values and Characteristics....................................................................................................60Multilingual Properties......................................................................................................................... 60General Properties............................................................................................................................... 60Changing the Properties of an Object.................................................................................................. 61Retentions Property............................................................................................................................. 61

Relationships Between Objects.................................................................................................................62Parents and Children............................................................................................................................62References............................................................................................................................................63

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

Organizing Objects..................................................................................................................................... 64Creating a Folder Object.......................................................................................................................65Creating a URL Object.......................................................................................................................... 65Creating a Shortcut Object................................................................................................................... 65Copying an Object................................................................................................................................ 65Moving an Object.................................................................................................................................. 65Controlling the Visibility of Objects......................................................................................................65Disabling an Object...............................................................................................................................67Deleting an Object................................................................................................................................ 67Setting the Order of Objects.................................................................................................................67

Managing User Accounts........................................................................................................................... 67Deleting a User Account.......................................................................................................................67Copying a User Account....................................................................................................................... 68

Maintain the Content Store........................................................................................................................68

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

How IBM Cognos Builds a Request......................................................................................................70Specifying Options and Parameters.................................................................................................... 70Managing Event History........................................................................................................................73Scheduling Tasks..................................................................................................................................74Retrying Tasks...................................................................................................................................... 76

Running Service-based Tasks....................................................................................................................76Running Reports................................................................................................................................... 76Running Jobs........................................................................................................................................ 79Running Agents.................................................................................................................................... 80Running Content Manager Tasks......................................................................................................... 81Running Metrics Tasks..........................................................................................................................81Running Notification Tasks...................................................................................................................81

Understanding the Asynchronous Conversation.......................................................................................81Primary and Secondary Requests........................................................................................................82Using wait()...........................................................................................................................................82Optimizing the Asynchronous Conversation........................................................................................83The Conversation Context....................................................................................................................84Processing Constraints.........................................................................................................................87

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

Stop and Start Dispatchers and Services............................................................................................ 90

iv

Remove Dispatchers from the Environment............................................................................................. 91Steps..................................................................................................................................................... 91

Test Dispatchers........................................................................................................................................ 91Step.......................................................................................................................................................91

Activate a Content Manager Service......................................................................................................... 91Set the Logging Level................................................................................................................................. 92

Logging Properties................................................................................................................................92Steps..................................................................................................................................................... 93

Tune Server Performance.......................................................................................................................... 93Models.................................................................................................................................................. 93Operating Systems............................................................................................................................... 93Tuning Properties................................................................................................................................. 93Steps..................................................................................................................................................... 94

Group Dispatchers in Configuration Folders............................................................................................. 94Steps..................................................................................................................................................... 94

Define Server Groups.................................................................................................................................94Steps..................................................................................................................................................... 94

Configure Advanced Routing..................................................................................................................... 95Steps..................................................................................................................................................... 95

Configure Advanced Settings.................................................................................................................... 95Steps..................................................................................................................................................... 96

Use Advanced Routing...............................................................................................................................96Steps to Use Advanced Routing for Content Store Objects................................................................ 96Steps to Use Advanced Routing for Inline Specifications................................................................... 97

Hot Swapping PowerCubes....................................................................................................................... 97Steps..................................................................................................................................................... 97

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

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

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

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

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

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

v

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

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

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

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

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

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

Changes to .NET Framework support................................................................................................125Upgrading to IBM Cognos Analytics Version 10.1.0...............................................................................126

Upgrading Java Applications for Axis 1.4..........................................................................................126Changes to the cam_passport cookie............................................................................................... 127Changes to the Microsoft Excel Output Formats..............................................................................128Multi-Instance IBM Cognos Connection............................................................................................128

Upgrading to IBM Cognos Analytics Version 8.4.................................................................................... 128Changes to Report Specification Validation...................................................................................... 129

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

Chapter 11. Schema reference........................................................................... 131bibus.........................................................................................................................................................131

Chapter 12. Services..........................................................................................133Services in Java....................................................................................................................................... 133Services in C# .NET................................................................................................................................. 133List of Services......................................................................................................................................... 134agentService............................................................................................................................................ 135batchReportService................................................................................................................................. 137contentManagerService...........................................................................................................................138dataIntegrationService............................................................................................................................140dataMovementService.............................................................................................................................141deliveryService........................................................................................................................................ 142dimensionManagementService...............................................................................................................143dispatcher................................................................................................................................................ 144

vi

eventManagementService.......................................................................................................................145idVizService..............................................................................................................................................146indexSearchService................................................................................................................................. 146indexUpdateService.................................................................................................................................147jobService................................................................................................................................................ 149metadataService......................................................................................................................................150migrationService......................................................................................................................................151mobileService.......................................................................................................................................... 151monitorService.........................................................................................................................................152planningAdministrationConsoleService..................................................................................................154planningRuntimeService......................................................................................................................... 154planningTaskService................................................................................................................................155powerPlayService.................................................................................................................................... 155queryService............................................................................................................................................ 156relationalMetadataService...................................................................................................................... 157reportService........................................................................................................................................... 158repositoryService.....................................................................................................................................160saCAMService.......................................................................................................................................... 160systemService..........................................................................................................................................161

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

Chapter 14. Methods..........................................................................................175Methods in Java....................................................................................................................................... 175activate(searchPath)................................................................................................................................175activateURI(uri)....................................................................................................................................... 176add(parentPath, objects, options).......................................................................................................... 177add(objectPath, parameterValues, options)...........................................................................................180add(parentPath, object, options)............................................................................................................ 181addAnnotations(containerPath, objects, options)..................................................................................185addDrillPath(parentPath, object, options).............................................................................................. 187addNotification(objectPath).................................................................................................................... 189addTermAssociation(term, parameterValues, options)......................................................................... 191back(conversation, parameterValues, options)......................................................................................192background(conversation)...................................................................................................................... 194

vii

cancel(conversation)............................................................................................................................... 195cancelEvent(eventID).............................................................................................................................. 198cancelEvents(eventIDs).......................................................................................................................... 199clearCubeWorkloadLog(cubeNames, parameterValues, options)......................................................... 201clearNotifications(objectPath)................................................................................................................ 202collectParameterValues(objectPath, parameterValues, options)..........................................................204collectParameterValues(objectPath, parameterValues, options) obsolete....................................... 206collectParameterValuesSpecification(specification, parameterValues, options)................................. 207collectParameterValuesSpecification(specification, parameterValues, options) obsolete............... 211convertDrillThroughContext(inputContext, parameterValues, options)................................................ 212copy(objects, targetPath, options).......................................................................................................... 213copyAccount(sourceAccountPath, targetAccountPath, options)...........................................................216copyRename(objects, targetPath, newNames, options)........................................................................ 217currentPage(conversation, parameterValues, options)..........................................................................219delayEventsFor(eventIDs, for)................................................................................................................ 221delayEventsUntil(eventIDs, until)........................................................................................................... 223delete(objects, options).......................................................................................................................... 224delete(objectPath, parameterValues, options).......................................................................................226deleteAccount(objectPath, options)....................................................................................................... 228deleteAllNotifications()........................................................................................................................... 229deleteHotList(objectPath)....................................................................................................................... 230deleteNotification(objectPath)................................................................................................................231deleteTenants(tenantIDs)....................................................................................................................... 233deleteTermAssociation(term, parameterValues, options)..................................................................... 234deliver(conversation, parameterValues, options).................................................................................. 235determineRouting(objectPaths)..............................................................................................................238drill(conversation, parameterValues, options)....................................................................................... 240findDrillThroughPaths(objectPath, parameterValues, options)............................................................. 241firstPage(conversation, parameterValues, options)............................................................................... 243forward(conversation, parameterValues, options).................................................................................246get(objectPath, parameterValues, options)............................................................................................248getActiveContentManager().................................................................................................................... 249getConfiguration(properties)...................................................................................................................249getContext(conversation, parameterValues, options)............................................................................251getCubeMessages(cubeNames, parameterValues, options)................................................................. 253getCubeMetrics(cubeNames, parameterValues, options)..................................................................... 254getCubeState(cubeNames, parameterValues, options).........................................................................256getDeploymentOptions(archive, options)...............................................................................................258getFormatSamples(name).......................................................................................................................259getIdentity().............................................................................................................................................261getObjectContext(objectPath, parameterValues, options).................................................................... 261getOutput(conversation, parameterValues, options)............................................................................. 263getParameters(objectPath, parameterValues, options).........................................................................266getParametersSpecification(specification, parameterValues, options)................................................ 269getPromptValues(conversation, parameterValues, options)................................................................. 272getPromptValues(conversation, parameterValues, options) obsolete............................................... 275holdEvent(eventID)................................................................................................................................. 276holdEvents(eventIDs)..............................................................................................................................277incrementallyLoadCubes(cubeNames, parameterValues, options)...................................................... 278lastPage(conversation, parameterValues, options)................................................................................280lineage(conversation, parameterValues, options)..................................................................................283listArchives()............................................................................................................................................ 284listTenants(options).................................................................................................................................286logoff()......................................................................................................................................................287logon(credentials, roles)..........................................................................................................................288mapContentLocale(locale, normalize).................................................................................................... 290mapProductLocale(locale, normalize).................................................................................................... 291move(objects, targetPath, options).........................................................................................................292

viii

moveRename(objects, targetPath, newNames, options).......................................................................294nextPage(conversation, parameterValues, options).............................................................................. 296normalizeLocale(locale).......................................................................................................................... 299pauseCubes(cubeNames, parameterValues, options)...........................................................................300ping(dispatcherPath)............................................................................................................................... 301previousPage(conversation, parameterValues, options)....................................................................... 303query(searchPath, properties, sortBy, options)......................................................................................306query(objectPath, parameterValues, options)........................................................................................309queryDrillPath(objectPath, parameterValues, options)......................................................................... 312queryMetadata(request)......................................................................................................................... 314queryMultiple(requests)..........................................................................................................................315queryMultipleCache(requests, options)................................................................................................. 316queryNotification(objectPath).................................................................................................................318queryTenantMembership(tenantIDs)..................................................................................................... 319refreshCubeDataCache(cubeNames, parameterValues, options)......................................................... 320refreshCubeMemberCache(cubeNames, parameterValues, options)................................................... 322refreshCubeSecurity(cubeNames, parameterValues, options)............................................................. 324release(conversation)..............................................................................................................................326releaseEvent(eventID).............................................................................................................................329releaseEvents(eventIDs)......................................................................................................................... 330render(conversation, parameterValues, options)...................................................................................331restartCubes(cubeNames, parameterValues, options)..........................................................................334retrieveCredential(namespace).............................................................................................................. 335run(objectPath, parameterValues, options)............................................................................................337runAt(startTime, objectPath, parameterValues, options)...................................................................... 343runSpecification(specification, parameterValues, options)................................................................... 346scheduleEvent(eventID)..........................................................................................................................357scheduleEvents(eventIDs)...................................................................................................................... 358selectRoles(roles)....................................................................................................................................359startCubes(cubeNames, parameterValues, options)............................................................................. 360startService(servicePath)........................................................................................................................ 362stopCubes(cubeNames, parameterValues, options)..............................................................................363stopService(servicePath, immediately).................................................................................................. 365terminateSessions(search)..................................................................................................................... 366testDataSourceConnection(connectionString, credentials)...................................................................367testDataSourceConnection(connectionString, credentials) obsolete................................................ 370testDataSourceConnectionWithInfo(connectionString, credentials).................................................... 371trigger(triggerName)................................................................................................................................372update(objects, options)......................................................................................................................... 374update(object, options)........................................................................................................................... 376updateDrillPath(object, options).............................................................................................................380updateEvents(events)............................................................................................................................. 381updateMetadata(request)....................................................................................................................... 383validate(objectPath, parameterValues, options) obsolete..................................................................384validate(objectPath, parameterValues, options).................................................................................... 385validateContentLocale(locale)................................................................................................................ 388validateProductLocale(locale).................................................................................................................389validateSpecification(specification, parameterValues, options) obsolete......................................... 390validateSpecification(specification, parameterValues, options)............................................................391wait(conversation, parameterValues, options).......................................................................................395

Chapter 15. Classes........................................................................................... 401Classes in Java.........................................................................................................................................401account.................................................................................................................................................... 401adaptiveAnalyticsService........................................................................................................................ 410addOptions...............................................................................................................................................414addressSMTP........................................................................................................................................... 415

ix

addressSMTPArrayProp...........................................................................................................................416addressSMTPProp................................................................................................................................... 416adminFolder.............................................................................................................................................416agentDefinition........................................................................................................................................ 418agentDefinitionView.................................................................................................................................419agentOption............................................................................................................................................. 420agentOptionBoolean................................................................................................................................420agentOutputEnumProp............................................................................................................................420agentOutputHotList................................................................................................................................. 421agentService............................................................................................................................................ 422agentState................................................................................................................................................424agentTaskDefinition................................................................................................................................. 425agentTaskState........................................................................................................................................ 428aliasLocation obsolete..........................................................................................................................429aliasRoot.................................................................................................................................................. 429analysis.................................................................................................................................................... 430ancestorInfo............................................................................................................................................ 431ancestorInfoArrayProp............................................................................................................................ 432ancestorInfoProp.....................................................................................................................................432annotation................................................................................................................................................433annotationFolder..................................................................................................................................... 434annotationService....................................................................................................................................435anyTypeMIMEProp...................................................................................................................................437anyTypeProp............................................................................................................................................ 437anyURIArrayProp.....................................................................................................................................439anyURIProp..............................................................................................................................................439archiveDescriptor.................................................................................................................................... 440archiveLocation........................................................................................................................................442archiveOption...........................................................................................................................................443archiveOptionConflictResolution............................................................................................................ 444archiveOptionDescriptor......................................................................................................................... 444archiveOptionSearchPathSingleObject...................................................................................................445archiveOptionString.................................................................................................................................445asynchDetail............................................................................................................................................ 446asynchDetailAgentNotificationStatus..................................................................................................... 446asynchDetailAsynchSpecification........................................................................................................... 447asynchDetailContext................................................................................................................................447asynchDetailCount...................................................................................................................................448asynchDetailDrillPathObject................................................................................................................... 448asynchDetailDrillThroughRequest.......................................................................................................... 449asynchDetailDrillThroughTarget.............................................................................................................. 451asynchDetailDrillThroughTargetURI........................................................................................................452asynchDetailEventID............................................................................................................................... 453asynchDetailEventRecord....................................................................................................................... 453asynchDetailIndexData........................................................................................................................... 457asynchDetailIndexTerms.........................................................................................................................459asynchDetailMessages............................................................................................................................ 459asynchDetailMIMEAttachment............................................................................................................... 460asynchDetailParameters......................................................................................................................... 461asynchDetailParameterValues................................................................................................................ 461asynchDetailPromptPage........................................................................................................................ 462asynchDetailReportMetadata..................................................................................................................462asynchDetailReportObject...................................................................................................................... 463asynchDetailReportOutput......................................................................................................................463asynchDetailReportStatus.......................................................................................................................464asynchDetailReportValidation.................................................................................................................465asynchDetailROLAPDataSourceState..................................................................................................... 466asynchDetailROLAPMessages.................................................................................................................466

x

asynchDetailROLAPMetrics.....................................................................................................................467asynchDetailSelectionContext................................................................................................................ 467asynchDetailUnstructuredData............................................................................................................... 468asynchOption........................................................................................................................................... 468asynchOptionBoolean............................................................................................................................. 469asynchOptionEncoding............................................................................................................................469asynchOptionInt...................................................................................................................................... 469asynchOptionSearchPathSingleObject................................................................................................... 470asynchOptionSearchPathSingleObjectArray.......................................................................................... 470asynchOptionStringArray........................................................................................................................ 470asynchReply.............................................................................................................................................471asynchRequest........................................................................................................................................ 473asynchSecondaryRequest....................................................................................................................... 475asynchSpecification.................................................................................................................................475auditLevelEnumProp............................................................................................................................... 476authoredAgentDefinition......................................................................................................................... 480authoredPowerPlay8Report....................................................................................................................482authoredReport....................................................................................................................................... 483base64BinaryMIMEProp......................................................................................................................... 487baseAgentDefinition................................................................................................................................ 487baseAgentDefinitionActionEnumProp.................................................................................................... 493baseClass.................................................................................................................................................493baseClassArrayProp................................................................................................................................ 504baseClassProp......................................................................................................................................... 507baseDataIntegrationTask........................................................................................................................ 507baseDataMovementTask......................................................................................................................... 512baseHistoryDetail.................................................................................................................................... 516baseParameter........................................................................................................................................ 517baseParameterAssignment..................................................................................................................... 518baseParameterAssignmentArrayProp.................................................................................................... 519baseParameterAssignmentProp............................................................................................................. 519basePowerPlay8Report........................................................................................................................... 519basePowerPlay8ReportActionEnumProp............................................................................................... 523basePowerPlayClass................................................................................................................................523baseProp.................................................................................................................................................. 525baseReport...............................................................................................................................................528baseReportActionEnumProp...................................................................................................................535baseROLAPCubeConfiguration................................................................................................................536baseROLAPCubeConfigurationArrayProp............................................................................................... 538baseROLAPCubeConfigurationProp........................................................................................................538baseROLAPDataSource........................................................................................................................... 539baseRoutingRule......................................................................................................................................540baseRSSTask............................................................................................................................................540batchReportService................................................................................................................................. 543biBusHeader............................................................................................................................................ 549biBusHeaderExtension1..........................................................................................................................551booleanProp.............................................................................................................................................551boundRangeParmValueItem................................................................................................................... 554cacheOutput............................................................................................................................................ 554CAF........................................................................................................................................................... 556CAM.......................................................................................................................................................... 556CAMException..........................................................................................................................................560CAMPassport........................................................................................................................................... 561CAMProtect.............................................................................................................................................. 562CAMSettings.............................................................................................................................................563capability..................................................................................................................................................564catalog......................................................................................................................................................564catalogFolder........................................................................................................................................... 565

xi

classEnumArrayProp............................................................................................................................... 565classEnumProp........................................................................................................................................ 566configuration............................................................................................................................................566configurationData.................................................................................................................................... 631configurationFolder................................................................................................................................. 634contact..................................................................................................................................................... 692content..................................................................................................................................................... 697contentManagerCacheService................................................................................................................ 699contentManagerQueryOption..................................................................................................................701contentManagerQueryOptionBoolean.................................................................................................... 701contentManagerQueryOptionInt.............................................................................................................702contentManagerQueryOptionPropEnumArray........................................................................................702contentManagerQueryOptionRefPropArray............................................................................................702contentManagerQueryOptionString........................................................................................................ 703contentManagerService...........................................................................................................................703contentStoreUtilizationConfiguration..................................................................................................... 705contentTask..............................................................................................................................................707contentTaskOption.................................................................................................................................. 710contentTaskOptionAuditLevelEnum........................................................................................................710contentTaskOptionBoolean.....................................................................................................................711contentTaskOptionClassEnumArray....................................................................................................... 711contentTaskOptionCSUtilizationConfiguration....................................................................................... 711contentTaskOptionRetentionRuleArray.................................................................................................. 712contentTaskOptionSearchPathSingleObjectArray..................................................................................712contextOption.......................................................................................................................................... 712contextOptionFormat.............................................................................................................................. 713contextOptionStringArray........................................................................................................................713contextOptionType.................................................................................................................................. 714conversationContext................................................................................................................................714cookieVar................................................................................................................................................. 716copyAccountOption................................................................................................................................. 716copyAccountOptionBoolean....................................................................................................................717copyOptions............................................................................................................................................. 717credential................................................................................................................................................. 718currency................................................................................................................................................... 720currencyArrayProp...................................................................................................................................721currencyProp............................................................................................................................................721dashboard................................................................................................................................................ 722dataAdvisorService..................................................................................................................................725dataIntegrationService............................................................................................................................726dataIntegrationServiceSpecification...................................................................................................... 728dataIntegrationServiceSpecificationArrayProp......................................................................................728dataIntegrationServiceSpecificationProp...............................................................................................729dataIntegrationTaskOption..................................................................................................................... 729dataIntegrationTaskOptionBoolean........................................................................................................730dataMovementService.............................................................................................................................730dataMovementServiceSpecification....................................................................................................... 735dataMovementServiceSpecificationProp................................................................................................735dataMovementTask................................................................................................................................. 736dataMovementTaskAlias......................................................................................................................... 737dataSet.....................................................................................................................................................738dataSetFolder.......................................................................................................................................... 739dataSource...............................................................................................................................................739dataSourceCommandBlock.....................................................................................................................741dataSourceCommandBlockProp.............................................................................................................741dataSourceConnection............................................................................................................................ 742dataSourceCredential..............................................................................................................................744dataSourceNameBinding.........................................................................................................................745

xii

dataSourceSignon....................................................................................................................................746dateTimeProp...........................................................................................................................................747decimalProp.............................................................................................................................................748deleteOptions.......................................................................................................................................... 748deliveryOption......................................................................................................................................... 749deliveryOptionAddressSMTPArray..........................................................................................................750deliveryOptionChannel............................................................................................................................ 750deliveryOptionMemoPart........................................................................................................................ 751deliveryOptionSearchPathMultipleObjectArray..................................................................................... 751deliveryOptionSearchPathSingleObject..................................................................................................751deliveryOptionString................................................................................................................................752deliveryService........................................................................................................................................ 752deliveryServiceSpecification................................................................................................................... 755deploymentDetail.................................................................................................................................... 755deploymentImportRule...........................................................................................................................757deploymentObjectInformation............................................................................................................... 758deploymentOption...................................................................................................................................759deploymentOptionAnyType.....................................................................................................................760deploymentOptionArrayProp.................................................................................................................. 760deploymentOptionAuditLevel................................................................................................................. 760deploymentOptionBoolean..................................................................................................................... 761deploymentOptionClassEnumArray........................................................................................................761deploymentOptionImportRuleArray....................................................................................................... 762deploymentOptionMultilingualString......................................................................................................762deploymentOptionObjectInformationArray........................................................................................... 762deploymentOptionProp........................................................................................................................... 763deploymentOptionResolution................................................................................................................. 763deploymentOptionSearchPathSingleObjectArray.................................................................................. 763deploymentOptionString......................................................................................................................... 764deploymentOptionStringArray................................................................................................................ 764deploymentReference............................................................................................................................. 765deploymentReferenceArrayProp.............................................................................................................766deploymentReferenceProp..................................................................................................................... 766deploymentStatusEnumProp.................................................................................................................. 766dimensionManagementService...............................................................................................................767dimensionManagementServiceSpecification......................................................................................... 771directory...................................................................................................................................................772dispatcher................................................................................................................................................ 773dispatcherTransportVar...........................................................................................................................838displayObject........................................................................................................................................... 838distributionList.........................................................................................................................................839document.................................................................................................................................................842documentContent....................................................................................................................................843documentVersion.....................................................................................................................................847drillOption................................................................................................................................................ 848drillOptionParameterValues....................................................................................................................848drillPath....................................................................................................................................................848drillThroughAction................................................................................................................................... 852drillThroughOption...................................................................................................................................852drillThroughOptionAnyURI...................................................................................................................... 853drillThroughOptionBoolean..................................................................................................................... 853drillThroughOptionXMLEncodedXML...................................................................................................... 854drillThroughPath...................................................................................................................................... 854durationProp............................................................................................................................................ 854environmentVar....................................................................................................................................... 855eventManagementService.......................................................................................................................856eventManagementServiceSpecification..................................................................................................857eventRecord.............................................................................................................................................857

xiii

eventTypeEnumArrayProp.......................................................................................................................859eventTypeEnumProp............................................................................................................................... 860EVService................................................................................................................................................. 860exportDeployment...................................................................................................................................861faultDetail................................................................................................................................................ 864faultDetailArrayProp................................................................................................................................865faultDetailMessage.................................................................................................................................. 865faultDetailProp.........................................................................................................................................865favoritesFolder.........................................................................................................................................866floatProp.................................................................................................................................................. 867folder........................................................................................................................................................867formFieldVar................................................