PPLMetabase

Syntax

SNArray allReportDescriptors() const

Example

The example of use is given in the Data Analysis section.

Syntax

void cancelLastDownloads()

Example

The example of use is given in the Canceling of report Loading section.

Syntax

long downloadReport(PPLMetabaseRepositoryObjectDescriptor *reportDescriptor)

Parameters

reportDescriptor. Report description.

Example

The example of use is given in the Data Analysis section.

Syntax

long downloadReports(NArray *reportDescriptors)

Parameters

reportDescriptors. Array of loading report descriptions.

Example

The example of use is given in the Displaying of Dashboard section.

Syntax

SNArray favoriteDescriptors() const

Example

The example of use is given in the Saving a Report to Favorites section.

Syntax

SPPLDataSource getDataSourceByObjectId(NString *objectId) const

Parameters

objectId. Data source identifier.

Example

The example of use is given in the Data Analysis section.

Syntax

SNString getHost() const

Example

The example of use is given in the Data Analysis section.

Syntax

SNString getLogin() const

Example

The example of use is given in the Data Analysis section.

Syntax

SNString getPassword() const

Example

The example of use is given in the Data Analysis section.

Syntax

SPPLReport getReportByObjectId(NString *objectId) const

Parameters

objectId. Report object identifier.

Example

The example of use is given in the Data Analysis section.

Syntax

SPPLReport getReportByObjectKey(int64 objectKey) const

Parameters

objectKey. Report object key.

Example

The example of use is given in the Data Analysis section.

Syntax

bool isHttpsEnabled() const

Example

Available values:

• true. Data encryption is available on repository connection.

• false. Data encryption is not available on repository connection.

Example

The example of use is given in the Data Analysis section.

Syntax

SNArray localFolderDescriptors() const

Example

The example of use is given in the Working with Repository Folders sections.

Syntax

SNArray localReportDescriptors() const

Example

The example of use is given in the Displaying of Dashboard section.

Syntax

SPPLMetabaseRepositoryDescriptor relatedRepositoryDescriptor() const

Example

The example of use is given in the Data Analysis section.

Syntax

SNArray remoteFolderDescriptors() const

Example

The example of use is given in the Working with Repository Folders sections.

Syntax

SNArray remoteReportDescriptors() const

Example

The example of use is given in the Displaying of Dashboard section.

Syntax

void removeFavorite(PPLMetabaseRepositoryFavoriteDescriptor *descriptor)

Parameters

descriptor. Description of favorite repository object.

Example

The example of use is given in the Displaying of Dashboard section.

Syntax

void removeObject(PPLMetabaseRepositoryObjectDescriptor *descriptor)

Parameters

descriptor. Repository object description.

Example

The example of use is given in the Data Analysis section.

Syntax

void saveReport(PPLReport *report) const

Parameters

report. Report object.

Example

The example of use is given in the Saving a Report to Favorites section.

Syntax

SPPLMetabaseRepositoryFavoriteDescriptor saveReportAsFavorite(PPLReport *report,

NString *name, bool hidden = false)

Parameters

report. Report object.

name. Favorite report description.

hidden. Indicates whether report should be added to favorites. Available values:

• true. Report should not be added to favorites.

• false. Report should be added to favorites (default).

Example

The example of use is given in the Saving a Report to Favorites section.

Syntax

SPPLMetabaseRepositoryFavoriteDescriptor saveReportAsFavorite(PPLMetabaseRepositoryObjectDescriptor *reportDescription, NString *name, bool hidden = false)

Parameters

reportDescription. Report object description.

name. Favorite report description.

hidden. Indicates whether report should be added to favorites. Available values:

• true. Report should not be added to favorites.

• false. Report should be added to favorites (default).

Example

The example of use is given in the Saving a Report to Favorites section.

Syntax

void setHost(NString *host) const

Parameters

host. Repository web address.

Example

The example of use is given in the Data Analysis section.

Syntax

void setHttpsEnabled(bool bEnabled) const

Parameters

bEnabled. Indicates whether data encryption is available on repository connection. Available values:

• true. Data encryption is available on repository connection.

• false. Data encryption is not available on repository connection.

Example

The example of use is given in the Data Analysis section.

Syntax

void updateRemoteRepositoryContent(NString *login, NString *password)

Parameters

login. Login for access to server data.

password. Password for access to server data.

Example

The example of use is given in the Data Analysis section.

Syntax

static SPPLMetabase sharedMetabase(NString* repositoryPath)

Parameters

repositoryPath. Repository path.

Example

The example of use is given in the Data Analysis section.

Syntax

static SPPLMetabase sharedMetabase(NString *host, NString *webAppName, NString *mobileAppName)

Parameters

host. Repository web address.

webAppName. Name of web application for repository access.

mobileAppName. Name of mobile application for repository access.

Example

The example of use is given in the Data Analysis section.

Syntax

static SPPLMetabase sharedMetabase(PPLMetabaseRepositoryDescriptor *descriptor)

Parameters

descriptor. Repository description.

Example

The example of use is given in the Data Analysis section.