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 page1903.

Product Information

This document applies to IBM Cognos Software Development Kit Version 11.1.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......................................................................................................................................... 13Other 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................................................................................................................ 57Parents and Children............................................................................................................................58References............................................................................................................................................59

Querying the Content Store....................................................................................................................... 59Example: 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...............................................................................................................................62Deleting 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................................................................................................................................. 87

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

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..................................................................................................................... 90Steps..................................................................................................................................................... 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...................................................................92

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...................................................................................... 124

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................................................................................................................................. 132contentManagerService...........................................................................................................................134dataIntegrationService............................................................................................................................135dataMovementService.............................................................................................................................137deliveryService........................................................................................................................................ 138dimensionManagementService...............................................................................................................139dispatcher................................................................................................................................................ 139

vi

eventManagementService.......................................................................................................................140idVizService..............................................................................................................................................142indexSearchService................................................................................................................................. 142indexUpdateService................................................................................................................................ 143jobService................................................................................................................................................ 144metadataService......................................................................................................................................145migrationService......................................................................................................................................147mobileService.......................................................................................................................................... 147monitorService.........................................................................................................................................148planningAdministrationConsoleService..................................................................................................150planningRuntimeService......................................................................................................................... 150planningTaskService................................................................................................................................150powerPlayService.................................................................................................................................... 151queryService............................................................................................................................................ 152relationalMetadataService...................................................................................................................... 153reportService........................................................................................................................................... 153repositoryService.....................................................................................................................................155saCAMService.......................................................................................................................................... 156systemService..........................................................................................................................................157

Chapter 13. Method sets.................................................................................... 159agent........................................................................................................................................................ 159asynch...................................................................................................................................................... 159authentication..........................................................................................................................................160content..................................................................................................................................................... 160dataSource...............................................................................................................................................161delivery.....................................................................................................................................................161deployment..............................................................................................................................................162dispatcher................................................................................................................................................ 162drillThrough..............................................................................................................................................162event........................................................................................................................................................ 163indexTerm................................................................................................................................................ 164indexUpdate.............................................................................................................................................164metadata..................................................................................................................................................164monitor.....................................................................................................................................................165paging.......................................................................................................................................................165parameter................................................................................................................................................ 165promptPaging.......................................................................................................................................... 166report....................................................................................................................................................... 166rolapCubeAdministration........................................................................................................................ 167standaloneCAM........................................................................................................................................168system......................................................................................................................................................168validate.....................................................................................................................................................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)....................................................................................... 235findDrillThroughPaths(objectPath, parameterValues, options).............................................................237firstPage(conversation, parameterValues, options)...............................................................................239forward(conversation, parameterValues, options).................................................................................241get(objectPath, parameterValues, options)............................................................................................243getActiveContentManager().................................................................................................................... 245getConfiguration(properties)...................................................................................................................245getContext(conversation, parameterValues, options)........................................................................... 247getCubeMessages(cubeNames, parameterValues, options)................................................................. 249getCubeMetrics(cubeNames, parameterValues, options)..................................................................... 250getCubeState(cubeNames, parameterValues, options).........................................................................252getDeploymentOptions(archive, options)...............................................................................................253getFormatSamples(name).......................................................................................................................255getIdentity().............................................................................................................................................256getObjectContext(objectPath, parameterValues, options).................................................................... 257getOutput(conversation, parameterValues, options).............................................................................259getParameters(objectPath, parameterValues, options).........................................................................261getParametersSpecification(specification, parameterValues, options)................................................ 264getPromptValues(conversation, parameterValues, options)................................................................. 268getPromptValues(conversation, parameterValues, options) – obsolete...............................................270holdEvent(eventID)................................................................................................................................. 271holdEvents(eventIDs)..............................................................................................................................272incrementallyLoadCubes(cubeNames, parameterValues, options)...................................................... 274lastPage(conversation, parameterValues, options)............................................................................... 275lineage(conversation, parameterValues, options)..................................................................................278listArchives()............................................................................................................................................ 280listTenants(options)................................................................................................................................ 281logoff()......................................................................................................................................................282logon(credentials, roles)..........................................................................................................................283mapContentLocale(locale, normalize).................................................................................................... 285mapProductLocale(locale, normalize).................................................................................................... 286move(objects, targetPath, options).........................................................................................................287

viii

moveRename(objects, targetPath, newNames, options).......................................................................289nextPage(conversation, parameterValues, options).............................................................................. 291normalizeLocale(locale).......................................................................................................................... 294pauseCubes(cubeNames, parameterValues, options)...........................................................................295ping(dispatcherPath)............................................................................................................................... 296previousPage(conversation, parameterValues, options)....................................................................... 298query(searchPath, properties, sortBy, options)..................................................................................... 301query(objectPath, parameterValues, options)........................................................................................304queryDrillPath(objectPath, parameterValues, options)......................................................................... 307queryMetadata(request)......................................................................................................................... 309queryMultiple(requests)..........................................................................................................................310queryMultipleCache(requests, options)................................................................................................. 311queryNotification(objectPath).................................................................................................................312queryTenantMembership(tenantIDs)..................................................................................................... 314refreshCubeDataCache(cubeNames, parameterValues, options).........................................................315refreshCubeMemberCache(cubeNames, parameterValues, options)...................................................317refreshCubeSecurity(cubeNames, parameterValues, options)............................................................. 319release(conversation)..............................................................................................................................320releaseEvent(eventID).............................................................................................................................324releaseEvents(eventIDs)......................................................................................................................... 325render(conversation, parameterValues, options)...................................................................................326restartCubes(cubeNames, parameterValues, options)..........................................................................329retrieveCredential(namespace).............................................................................................................. 330run(objectPath, parameterValues, options)........................................................................................... 331runAt(startTime, objectPath, parameterValues, options)...................................................................... 338runSpecification(specification, parameterValues, options)................................................................... 340scheduleEvent(eventID)..........................................................................................................................351scheduleEvents(eventIDs)...................................................................................................................... 353selectRoles(roles)....................................................................................................................................354startCubes(cubeNames, parameterValues, options)............................................................................. 355startService(servicePath)........................................................................................................................ 356stopCubes(cubeNames, parameterValues, options)..............................................................................358stopService(servicePath, immediately).................................................................................................. 360terminateSessions(search)..................................................................................................................... 361testDataSourceConnection(connectionString, credentials)...................................................................362testDataSourceConnection(connectionString, credentials) – obsolete................................................ 365testDataSourceConnectionWithInfo(connectionString, credentials).................................................... 365trigger(triggerName)................................................................................................................................367update(objects, options)......................................................................................................................... 369update(object, options)........................................................................................................................... 371updateDrillPath(object, options).............................................................................................................374updateEvents(events)............................................................................................................................. 376updateMetadata(request)....................................................................................................................... 377validate(objectPath, parameterValues, options) – obsolete..................................................................379validate(objectPath, parameterValues, options).................................................................................... 379validateContentLocale(locale)................................................................................................................ 383validateProductLocale(locale).................................................................................................................384validateSpecification(specification, parameterValues, options) – obsolete......................................... 385validateSpecification(specification, parameterValues, options)........................................................... 385wait(conversation, parameterValues, options).......................................................................................390

Chapter 15. Classes........................................................................................... 395Classes in Java.........................................................................................................................................395account.................................................................................................................................................... 395adaptiveAnalyticsService........................................................................................................................ 404addOptions...............................................................................................................................................408addressSMTP........................................................................................................................................... 409

ix

addressSMTPArrayProp...........................................................................................................................410addressSMTPProp................................................................................................................................... 410adminFolder.............................................................................................................................................410agentDefinition........................................................................................................................................ 411agentDefinitionView................................................................................................................................ 413agentOption............................................................................................................................................. 413agentOptionBoolean................................................................................................................................414agentOutputEnumProp............................................................................................................................414agentOutputHotList................................................................................................................................. 415agentService............................................................................................................................................ 416agentState................................................................................................................................................418agentTaskDefinition.................................................................................................................................419agentTaskState........................................................................................................................................422aliasLocation – obsolete..........................................................................................................................423aliasRoot.................................................................................................................................................. 423analysis.................................................................................................................................................... 424ancestorInfo............................................................................................................................................ 425ancestorInfoArrayProp............................................................................................................................426ancestorInfoProp.....................................................................................................................................426annotation................................................................................................................................................426annotationFolder..................................................................................................................................... 427annotationService....................................................................................................................................428anyTypeMIMEProp.................................................................................................................................. 430anyTypeProp............................................................................................................................................431anyURIArrayProp.....................................................................................................................................432anyURIProp..............................................................................................................................................433archiveDescriptor.................................................................................................................................... 434archiveLocation........................................................................................................................................436archiveOption...........................................................................................................................................437archiveOptionConflictResolution............................................................................................................ 437archiveOptionDescriptor......................................................................................................................... 438archiveOptionSearchPathSingleObject...................................................................................................438archiveOptionString.................................................................................................................................439asynchDetail............................................................................................................................................ 439asynchDetailAgentNotificationStatus..................................................................................................... 440asynchDetailAsynchSpecification........................................................................................................... 440asynchDetailContext............................................................................................................................... 441asynchDetailCount...................................................................................................................................441asynchDetailDrillPathObject................................................................................................................... 442asynchDetailDrillThroughRequest.......................................................................................................... 442asynchDetailDrillThroughTarget............................................................................................................. 444asynchDetailDrillThroughTargetURI.......................................................................................................446asynchDetailEventID............................................................................................................................... 446asynchDetailEventRecord....................................................................................................................... 447asynchDetailIndexData........................................................................................................................... 451asynchDetailIndexTerms........................................................................................................................ 452asynchDetailMessages............................................................................................................................ 453asynchDetailMIMEAttachment............................................................................................................... 453asynchDetailParameters......................................................................................................................... 454asynchDetailParameterValues................................................................................................................ 454asynchDetailPromptPage........................................................................................................................ 455asynchDetailReportMetadata..................................................................................................................455asynchDetailReportObject...................................................................................................................... 456asynchDetailReportOutput......................................................................................................................456asynchDetailReportStatus.......................................................................................................................457asynchDetailReportValidation.................................................................................................................458asynchDetailROLAPDataSourceState..................................................................................................... 458asynchDetailROLAPMessages.................................................................................................................459

x

asynchDetailROLAPMetrics.....................................................................................................................459asynchDetailSelectionContext................................................................................................................ 460asynchDetailUnstructuredData...............................................................................................................460asynchOption...........................................................................................................................................461asynchOptionBoolean............................................................................................................................. 461asynchOptionEncoding............................................................................................................................462asynchOptionInt...................................................................................................................................... 462asynchOptionSearchPathSingleObject................................................................................................... 462asynchOptionSearchPathSingleObjectArray.......................................................................................... 463asynchOptionStringArray........................................................................................................................ 463asynchReply.............................................................................................................................................463asynchRequest........................................................................................................................................ 465asynchSecondaryRequest.......................................................................................................................467asynchSpecification.................................................................................................................................468auditLevelEnumProp............................................................................................................................... 469authoredAgentDefinition......................................................................................................................... 473authoredPowerPlay8Report....................................................................................................................474authoredReport....................................................................................................................................... 476base64BinaryMIMEProp......................................................................................................................... 479baseAgentDefinition................................................................................................................................ 480baseAgentDefinitionActionEnumProp.................................................................................................... 485baseClass.................................................................................................................................................485baseClassArrayProp................................................................................................................................ 496baseClassProp......................................................................................................................................... 499baseDataIntegrationTask........................................................................................................................499baseDataMovementTask.........................................................................................................................504baseHistoryDetail.................................................................................................................................... 507baseParameter........................................................................................................................................ 508baseParameterAssignment.....................................................................................................................510baseParameterAssignmentArrayProp.................................................................................................... 510baseParameterAssignmentProp............................................................................................................. 511basePowerPlay8Report...........................................................................................................................511basePowerPlay8ReportActionEnumProp............................................................................................... 514basePowerPlayClass............................................................................................................................... 515baseProp.................................................................................................................................................. 516baseReport...............................................................................................................................................520baseReportActionEnumProp...................................................................................................................527baseROLAPCubeConfiguration................................................................................................................527baseROLAPCubeConfigurationArrayProp............................................................................................... 529baseROLAPCubeConfigurationProp........................................................................................................530baseROLAPDataSource........................................................................................................................... 530baseRoutingRule......................................................................................................................................531baseRSSTask........................................................................................................................................... 532batchReportService................................................................................................................................. 534biBusHeader............................................................................................................................................ 540biBusHeaderExtension1..........................................................................................................................542booleanProp.............................................................................................................................................542boundRangeParmValueItem...................................................................................................................545cacheOutput............................................................................................................................................ 545CAF........................................................................................................................................................... 547CAM.......................................................................................................................................................... 547CAMException..........................................................................................................................................551CAMPassport........................................................................................................................................... 552CAMProtect.............................................................................................................................................. 553CAMSettings.............................................................................................................................................554capability..................................................................................................................................................554catalog......................................................................................................................................................555catalogFolder........................................................................................................................................... 556

xi

classEnumArrayProp............................................................................................................................... 556classEnumProp........................................................................................................................................ 557configuration............................................................................................................................................557configurationData.................................................................................................................................... 621configurationFolder................................................................................................................................. 624contact..................................................................................................................................................... 681content..................................................................................................................................................... 686contentManagerCacheService................................................................................................................ 689contentManagerQueryOption..................................................................................................................690contentManagerQueryOptionBoolean.................................................................................................... 691contentManagerQueryOptionInt.............................................................................................................691contentManagerQueryOptionPropEnumArray........................................................................................691contentManagerQueryOptionRefPropArray............................................................................................692contentManagerQueryOptionString........................................................................................................692contentManagerService...........................................................................................................................692contentStoreUtilizationConfiguration..................................................................................................... 695contentTask............................................................................................................................................. 696contentTaskOption.................................................................................................................................. 699contentTaskOptionAuditLevelEnum....................................................................................................... 699contentTaskOptionBoolean.................................................................................................................... 700contentTaskOptionClassEnumArray.......................................................................................................700contentTaskOptionCSUtilizationConfiguration.......................................................................................700contentTaskOptionRetentionRuleArray..................................................................................................701contentTaskOptionSearchPathSingleObjectArray................................................................................. 701contextOption.......................................................................................................................................... 701contextOptionFormat.............................................................................................................................. 702contextOptionStringArray........................................................................................................................702contextOptionType.................................................................................................................................. 703conversationContext............................................................................................................................... 703cookieVar................................................................................................................................................. 705copyAccountOption................................................................................................................................. 705copyAccountOptionBoolean................................................................................................................... 705copyOptions.............................................................................................................................................706credential................................................................................................................................................. 707currency................................................................................................................................................... 709currencyArrayProp...................................................................................................................................710currencyProp........................................................................................................................................... 710dashboard................................................................................................................................................ 710dataAdvisorService..................................................................................................................................713dataIntegrationService............................................................................................................................715dataIntegrationServiceSpecification...................................................................................................... 717dataIntegrationServiceSpecificationArrayProp......................................................................................717dataIntegrationServiceSpecificationProp...............................................................................................717dataIntegrationTaskOption.....................................................................................................................718dataIntegrationTaskOptionBoolean....................................................................................................... 718dataMovementService.............................................................................................................................719dataMovementServiceSpecification....................................................................................................... 723dataMovementServiceSpecificationProp................................................................................................724dataMovementTask................................................................................................................................. 724dataMovementTaskAlias......................................................................................................................... 725dataSet.....................................................................................................................................................726dataSetFolder.......................................................................................................................................... 727dataSource...............................................................................................................................................728dataSourceCommandBlock.....................................................................................................................729dataSourceCommandBlockProp.............................................................................................................730dataSourceConnection............................................................................................................................ 730dataSourceCredential..............................................................................................................................733dataSourceNameBinding.........................................................................................................................734

xii

dataSourceSignon....................................................................................................................................735dateTimeProp.......................................................................................................................................... 735decimalProp.............................................................................................................................................736deleteOptions.......................................................................................................................................... 737deliveryOption......................................................................................................................................... 738deliveryOptionAddressSMTPArray..........................................................................................................738deliveryOptionChannel............................................................................................................................ 739deliveryOptionMemoPart........................................................................................................................ 739deliveryOptionSearchPathMultipleObjectArray..................................................................................... 739deliveryOptionSearchPathSingleObject..................................................................................................740deliveryOptionString................................................................................................................................740deliveryService........................................................................................................................................ 740deliveryServiceSpecification................................................................................................................... 743deploymentDetail.................................................................................................................................... 743deploymentImportRule...........................................................................................................................745deploymentObjectInformation............................................................................................................... 746deploymentOption...................................................................................................................................747deploymentOptionAnyType.................................................................................................................... 748deploymentOptionArrayProp.................................................................................................................. 748deploymentOptionAuditLevel................................................................................................................. 748deploymentOptionBoolean..................................................................................................................... 749deploymentOptionClassEnumArray........................................................................................................749deploymentOptionImportRuleArray....................................................................................................... 750deploymentOptionMultilingualString......................................................................................................750deploymentOptionObjectInformationArray........................................................................................... 750deploymentOptionProp........................................................................................................................... 751deploymentOptionResolution................................................................................................................. 751deploymentOptionSearchPathSingleObjectArray.................................................................................. 751deploymentOptionString......................................................................................................................... 752deploymentOptionStringArray................................................................................................................ 752deploymentReference............................................................................................................................. 753deploymentReferenceArrayProp............................................................................................................ 753deploymentReferenceProp..................................................................................................................... 754deploymentStatusEnumProp.................................................................................................................. 754dimensionManagementService...............................................................................................................755dimensionManagementServiceSpecification......................................................................................... 759directory...................................................................................................................................................759dispatcher................................................................................................................................................ 760dispatcherTransportVar...........................................................................................................................825displayObject........................................................................................................................................... 825distributionList.........................................................................................................................................826document.................................................................................................................................................829documentContent....................................................................................................................................830documentVersion.....................................................................................................................................834drillOption................................................................................................................................................ 835drillOptionParameterValues....................................................................................................................835drillPath....................................................................................................................................................835drillThroughAction................................................................................................................................... 839drillThroughOption.................................................................................................................................. 839drillThroughOptionAnyURI......................................................................................................................840drillThroughOptionBoolean.....................................................................................................................840drillThroughOptionXMLEncodedXML......................................................................................................840drillThroughPath...................................................................................................................................... 841durationProp............................................................................................................................................ 841environmentVar....................................................................................................................................... 842eventManagementService.......................................................................................................................842eventManagementServiceSpecification................................................................................................. 844eventRecord.............................................................................................................................................844

xiii

eventTypeEnumArrayProp...................................................................................................................... 846eventTypeEnumProp............................................................................................................................... 846EVService................................................................................................................................................. 847exportDeployment...................................................................................................................................848faultDetail................................................................................................................................................ 850faultDetailArrayProp................................................................................................................................851faultDetailMessage.................................................................................................................................. 852faultDetailProp.........................................................................................................................................852favoritesFolder.........................................................................................................................................852floatProp.................................................................................................................................................. 853folder.........................................................................................................................................