Application data transfer object containing the following details:
1. Application name
Fields:
string applicationName:
Application name
<complexType name="ApplicationDTO">
<complexContent>
<extension base="
BaseDTO">
<sequence>
<element minOccurs="0"
name="applicationName"
type="
string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
Base data transfer object which has common information and constants that are
used across all data transfer objects.
Constants listed & their values:
| Variable name | Acutal value |
| =================== | =================== |
| CALCULATION_CUBE | Calculation_Cube |
| REPORTING_CUBE | Reporting_Cube |
| COST_LAYER | Cost |
| REVENUE_LAYER | Revenue |
<complexType name="BaseDTO">
<sequence/>
</complexType>
Type Hierarchy:
Calc script options data transfer object containing the following details:
1. POV member details
2. Layer name. Valid values are Cost or Revenue
3. List of stage names for which generated calc scripts need to be cleared
4. List of stage names for which all information needs to be cleared
5. List of stage names for which calc scripts need to be generated
6. List of stage names for which calc scripts should be executed
7. Boolean flag specifying if transfer of data needs to be done
Fields:
string calculateStageList:
List of stage names for which calc scripts should be executed
string clearAllStageList:
List of stage names for which all information needs to be cleared
string clearCalculatedStageList:
List of stage names for which generated calc scripts need to be cleared
string generateStageList:
List of stage names for which calc scripts need to be generated
boolean transferData:
Boolean flag specifying if transfer of data needs to be done
<complexType name="CalcScriptOptionsDTO">
<complexContent>
<extension base="
BaseDTO">
<sequence>
<element maxOccurs="unbounded"
minOccurs="0"
name="calculateStageList"
nillable="true"
type="
string"/>
<element maxOccurs="unbounded"
minOccurs="0"
name="clearAllStageList"
nillable="true"
type="
string"/>
<element maxOccurs="unbounded"
minOccurs="0"
name="clearCalculatedStageList"
nillable="true"
type="
string"/>
<element maxOccurs="unbounded"
minOccurs="0"
name="generateStageList"
nillable="true"
type="
string"/>
<element minOccurs="0"
name="layerName"
type="
string"/>
<element name="transferData"
type="
boolean"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
Copy POV data transfer object containing the following details:
1. Source POV dimension member group details
2. Destination POV dimension member group details
3. Boolean flag specifying whether Cost layer data should be copied or not
4. Boolean flag specifying whether Revenue layer data should be copied or not
5. Boolean flag specifying whether assignments data should be copied or not
6. Boolean flag specifying whether driver associations data should be copied or not
7. Boolean flag specifying whether driver data should be copied or not
8. Boolean flag specifying whether Cost and Revenue values should be copied or not
Fields:
boolean copyAssignments:
Boolean flag specifying whether assignments data should be copied or not
boolean copyCostLayerData:
Boolean flag specifying whether Cost layer data should be copied or not
boolean copyCostRevenueValues:
Boolean flag specifying whether Cost and Revenue values should be copied or not
boolean copyDriverAssociations:
Boolean flag specifying whether driver associations data should be copied or not
boolean copyDriverValues:
Boolean flag specifying whether driver data should be copied or not
boolean copyRevenueLayerData:
Boolean flag specifying whether Revenue layer data should be copied or not
<complexType name="CopyPOVDTO">
<complexContent>
<extension base="
BaseDTO">
<sequence>
<element name="copyAssignments"
type="
boolean"/>
<element name="copyCostLayerData"
type="
boolean"/>
<element name="copyCostRevenueValues"
type="
boolean"/>
<element name="copyDriverAssociations"
type="
boolean"/>
<element name="copyDriverValues"
type="
boolean"/>
<element name="copyRevenueLayerData"
type="
boolean"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
Cube deploy options data transfer object containing the following details:
1. Cube type to the deployed. Valid values are Calculation_Cube or Reporting_Cube
2. Boolean flag specifying whether the cube is deployed for the first time for this application
3. Boolean flag specifying whether the database should be updated or not
4. Boolean flag specifying whether the database should be replaced or not
5. Boolean flag specifying whether data should be archived before deployment begins
6. Boolean flag specifying whether data archived before deployment should be reloaded after deployment completes
7. Boolean flag specifying whether to delete or not the archived data after reload
Fields:
boolean archiveDataAndReloadAfterDeploy:
Boolean flag specifying whether data archived before deployment should be reloaded after deployment completes
boolean archiveDataBeforeDeploy:
Boolean flag specifying whether data should be archived before deployment begins
string cubeType:
Cube type to the deployed. Valid values are Calculation_Cube or Reporting_Cube
boolean deleteDataArchiveAfterReload:
Boolean flag specifying whether to delete or not the archived data after reload
boolean firstTimeDeployment:
Boolean flag specifying whether the cube is deployed for the first time for this application
boolean replaceDatabase:
Boolean flag specifying whether the database should be replaced or not
boolean updateDatabase:
Boolean flag specifying whether the database should be updated or not
<complexType name="CubeDeployOptionsDTO">
<complexContent>
<extension base="
BaseDTO">
<sequence>
<element name="archiveDataAndReloadAfterDeploy"
type="
boolean"/>
<element name="archiveDataBeforeDeploy"
type="
boolean"/>
<element minOccurs="0"
name="cubeType"
type="
string"/>
<element name="deleteDataArchiveAfterReload"
type="
boolean"/>
<element name="firstTimeDeployment"
type="
boolean"/>
<element name="replaceDatabase"
type="
boolean"/>
<element name="updateDatabase"
type="
boolean"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
Genealogy options data transfer object containing the following details:
1. POV dimension member group details
2. Layer name. Valid values are Cost or Revenue
3. List of genealogy execution paths
4. Boolean flag specifying whether this operation should overwrite exiting data or not
5. Boolean flag specifying whether the execution should be in chain
Fields:
boolean executeInChain:
Boolean flag specifying whether the execution should be in chain
boolean overwriteExisting:
Boolean flag specifying whether this operation should overwrite exiting data or not
string paths:
List of genealogy execution paths
<complexType name="GenealogyOptionsDTO">
<complexContent>
<extension base="
BaseDTO">
<sequence>
<element name="executeInChain"
type="
boolean"/>
<element minOccurs="0"
name="layerName"
type="
string"/>
<element name="overwriteExisting"
type="
boolean"/>
<element maxOccurs="unbounded"
minOccurs="0"
name="paths"
nillable="true"
type="
string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
POV member group data transfer object containing the following deatils:
1. POV dimension member 1 name
2. POV dimension member 2 name
3. POV dimension member 3 name
4. POV dimension member 4 name
5. POV state
Fields:
string povDimensionMember1:
POV dimension member 1 name
string povDimensionMember2:
POV dimension member 2 name
string povDimensionMember3:
POV dimension member 3 name
string povDimensionMember4:
POV dimension member 4 name
<complexType name="POVMemberGroupDTO">
<complexContent>
<extension base="
BaseDTO">
<sequence>
<element minOccurs="0"
name="povDimensionMember1"
type="
string"/>
<element minOccurs="0"
name="povDimensionMember2"
type="
string"/>
<element minOccurs="0"
name="povDimensionMember3"
type="
string"/>
<element minOccurs="0"
name="povDimensionMember4"
type="
string"/>
<element minOccurs="0"
name="povState"
type="
string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
<complexType name="stageDTO">
<complexContent>
<extension base="
BaseDTO">
<sequence>
<element minOccurs="0"
name="stageName"
type="
string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
<complexType name="ProfitabilityServiceException">
<sequence>
<element name="Message"
type="
string"/>
<element name="Code"
type="
int"/>
</sequence>
</complexType>
Referenced By:
Wrapper Type for copyPOVData input Parameters.
Fields:
string applicationName:
-- Name of the application to use.
CopyPOVDTO copyPOVData:
-- Selection details for Copy POV functionality.
<complexType name="copyPOVData">
<sequence>
<element name="applicationName"
type="
string"/>
</sequence>
</complexType>
Referenced By:
<complexType name="copyPOVDataResponse">
<sequence/>
</complexType>
Referenced By:
Wrapper Type for deleteApplication input Parameters.
Fields:
string applicationName:
- Name of the application to be deleted.
<complexType name="deleteApplication">
<sequence>
<element name="applicationName"
type="
string"/>
</sequence>
</complexType>
Referenced By:
<complexType name="deleteApplicationResponse">
<sequence/>
</complexType>
Referenced By:
Wrapper Type for deployCube input Parameters.
Fields:
string applicationName:
-- Name of the application to use.
<complexType name="deployCube">
<sequence>
<element name="applicationName"
type="
string"/>
</sequence>
</complexType>
Referenced By:
Wrapper Type for deployCube return parameter.
Fields:
string return:
CES task Id generated for the deploy cube action.
<complexType name="deployCubeResponse">
<sequence>
<element name="return"
type="
string"/>
</sequence>
</complexType>
Referenced By:
<complexType name="getApplications">
<sequence/>
</complexType>
Referenced By:
Wrapper Type for getApplications return parameter.
Fields:
ApplicationDTO return:
List of ApplicationDTOs containing application information.
<complexType name="getApplicationsResponse">
<sequence>
<element maxOccurs="unbounded"
minOccurs="0"
name="return"
type="
ApplicationDTO"/>
</sequence>
</complexType>
Referenced By:
Wrapper Type for getPOV input Parameters.
Fields:
string applicationName:
- Name of the application for which POVs should be retrieved.
<complexType name="getPOV">
<sequence>
<element name="applicationName"
type="
string"/>
</sequence>
</complexType>
Referenced By:
Wrapper Type for getPOV return parameter.
<complexType name="getPOVResponse">
<sequence>
<element maxOccurs="unbounded"
minOccurs="0"
name="return"
type="
POVMemberGroupDTO"/>
</sequence>
</complexType>
Referenced By:
Wrapper Type for getStages input Parameters.
Fields:
string applicationName:
- Name of the application for which stages should be retrieved.
<complexType name="getStages">
<sequence>
<element name="applicationName"
type="
string"/>
</sequence>
</complexType>
Referenced By:
Wrapper Type for getStages return parameter.
Fields:
stageDTO return:
List of StageDTOs containing stage information.
<complexType name="getStagesResponse">
<sequence>
<element maxOccurs="unbounded"
minOccurs="0"
name="return"
type="
stageDTO"/>
</sequence>
</complexType>
Referenced By:
Wrapper Type for getTaskStatusByProcessName input Parameters.
Fields:
string processName:
-- CES process name for which status is to be retrieved.
<complexType name="getTaskStatusByProcessName">
<sequence>
<element name="processName"
type="
string"/>
</sequence>
</complexType>
Referenced By:
Wrapper Type for getTaskStatusByProcessName return parameter.
Fields:
string return:
Comma separated values of all tasks and their statuses for the
specified CES process name. Eg: 12345=Done,123455=Active if the process
has 2 tasks created for it with the task Ids: 12345 and 123455.
<complexType name="getTaskStatusByProcessNameResponse">
<sequence>
<element name="return"
type="
string"/>
</sequence>
</complexType>
Referenced By:
Wrapper Type for importFromStaging input Parameters.
Fields:
string applicationName:
-- Name of the application to use.
string importConfigName:
-- Import configuration to be imported.
<complexType name="importFromStaging">
<sequence>
<element name="applicationName"
type="
string"/>
<element name="importConfigName"
type="
string"/>
</sequence>
</complexType>
Referenced By:
<complexType name="importFromStagingResponse">
<sequence/>
</complexType>
Referenced By:
Wrapper Type for processCalcScripts input Parameters.
Fields:
string applicationName:
-- Name of the application to use.
<complexType name="processCalcScripts">
<sequence>
<element name="applicationName"
type="
string"/>
</sequence>
</complexType>
Referenced By:
Wrapper Type for processCalcScripts return parameter.
Fields:
string return:
CES task Id generated for the Calculation scripts processing action.
<complexType name="processCalcScriptsResponse">
<sequence>
<element name="return"
type="
string"/>
</sequence>
</complexType>
Referenced By:
Wrapper Type for processGenealogyExecutionPaths input Parameters.
Fields:
string applicationName:
-- Name of the application to use.
<complexType name="processGenealogyExecutionPaths">
<sequence>
<element name="applicationName"
type="
string"/>
</sequence>
</complexType>
Referenced By:
Wrapper Type for processGenealogyExecutionPaths return parameter.
Fields:
string return:
CES task Id generated for executing genealogy paths.
<complexType name="processGenealogyExecutionPathsResponse">
<sequence>
<element name="return"
type="
string"/>
</sequence>
</complexType>
Referenced By: