API Call to rebuild cubes / datasets

Smarten provides industry-standard integration flow to seamlessly and securely integrate Smarten functionalities within your application. Administration and Configuration Web services API is used to manage Smarten configuration and administration related tasks from third-party applications.  Web services are SOAP based secure calls and can be called from most of the popular programming languages such as .NET, Java and PHP.

How to Integrate Web services:

To integrate Smarten configuration and administration web services, developers need to follow standard SOAP web service integration process. Developers need to generate functional stubs through WSDL definitions. 

The functional stubs will allow developers to make standard function calls in their native programming language which will directly communicate with the web services provided by Smarten. The process of creating functional stubs will also generate objects required by the web service.

Smarten web services are secured and requires authentication for integration. It uses HTTP basic authentication method for accessing the web service. Developers need to provide credentials of Smarten user for authentication.

You may need to call cube or dataset rebuild functions from your third party applications based on various events such as:

1. ETL process gets over and you need to rebuild cube or dataset
2. Data reload process gets over and you need to rebuild cube or dataset
3. Business requirements where cube or dataset needs to be rebuilt based on some event

How to manage cube rebuild:

Smarten web services WSDL definitions for Cube management service can be found from below URL:

http://<SMARTENURL>/ws/cubeManagement.wsdl

This service will be used to retrieve cube and object repository related information. Various functionalities like retrieving the cube list, setting cube permissions, setting cube column permissions, and rebuilding cube can be managed this way.

rebuildCube() function will be used to rebuild the cubes. The method has mainly two parameters in it (cubeId and Incremental).

 

Request Element	Data Type	Description	Setting Code
cubeId	String	Cube id of the cube to be rebuilt	setCubeId()
Incremental	Boolean	To specify whether the cube will be incremental or not. This is an optional parameter and the default value will be False.	setIncrimental()

 

The above parameters need to be set in RebuildCubeRequest object. After completing the request, the client (the page from where the request is being sent) will receive RebuildCubeResponse object. 

The response returned will contain these parameters which mentions if the request has been a success or not.

Response Element	Data Type	Description	Retrieval Code
Status	Status	Status of the web service call.	getStatus()

 

How to manage dataset rebuild:

This same service will be used to retrieve dataset related information. Smarten web services WSDL definitions for Dataset management service can be found from below URL:

http://<SMARTENURL>/ws/datasetManagement.wsdl

refreshDataSet() function will be used to rebuild the datasets. This method has only one parameter ie; datasetId.

 

Request Element	Data Type	Description	Setting Code
datasetId	String	Dataset id of the dataset to be rebuilt	setDatasetId()

 

The above parameter needs to be set in GetDataSetRefreshRequest object. After completing request the client will receive GetDataSetRefreshResponse object. The response returned will contain these parameters:

 

Response Element	Data Type	Description	Retrieval Code
Status	Status	Status of the web service call.	getStatus()

 

The response returned will contain the parameters which mentions if the request has been a success or not.

Note: This article is based on Smarten version 5.0. This may or may not be relevant to the Smarten version you may be using.

API SOAP API rebuild Rebuild dataset rebuild cube