public class DataMap
extends java.lang.Object
Calling execute() on a DataMap will push data from the source location to the target location. The push can be further scoped by specifying an override members map for the source location. Data map push will error out when override members map contains members from unmapped dimensions of the target location.
Example call from Groovy to push data, clearing data in the target region beforehand:
Example call from Groovy to push data scoped down with override members, clearing data in the target region beforehand:if(operation.application.hasDataMap("cubeLink1")) operation.application.getDataMap("cubeLink1").execute(true)
The execute() method on a DataMap is a privileged method and can be called only by users with administrator privileges. If there is a requirement for planners to push data from the source location to the target location, then a SmartPush created from a DataMap can be used as shown below:/*RTPS: {MyAccount} {MyScenario} {MyVersion} {MyEntity}*/ if(operation.application.hasDataMap("cubeLink1")) operation.application.getDataMap("cubeLink1").execute(["Account":rtps.MyAccount.enteredValue, "Scenario":rtps.MyScenario.enteredValue, "Version":rtps.MyVersion.enteredValue, "Entity":rtps.MyEntity.enteredValue], true)
By default, parameters are case insensitive and may not be null or empty unless otherwise specified./*RTPS: {MyAccount} {MyScenario} {MyVersion} {MyEntity}*/ if(operation.application.hasDataMap("cubeLink1")) operation.application.getDataMap("cubeLink1").createSmartPush().execute(["Account":rtps.MyAccount.enteredValue, "Scenario":rtps.MyScenario.enteredValue, "Version":rtps.MyVersion.enteredValue, "Entity":rtps.MyEntity.enteredValue])
Modifier and Type | Method and Description |
---|---|
SmartPush |
createSmartPush()
Returns a SmartPush that can be used to push data to the target
location specified in the underlying data map.
|
boolean |
equals(java.lang.Object arg0) |
void |
execute(boolean clearData)
Executes this data map, clearing data in the target region beforehand
if requested.
|
void |
execute(java.util.Map<java.lang.String,java.lang.String> overrideMembersMap,
boolean clearData)
Executes this data map using the specified override members map,
clearing data in the target region beforehand if requested.
|
void |
execute(java.util.Map<java.lang.String,java.lang.String> overrideMembersMap,
java.util.Map<java.lang.String,java.lang.String> overrideExclusionMembersMap,
boolean clearData)
Executes this data map using the specified override members map,
clearing data in the target region beforehand if requested.
|
java.lang.String |
getName()
Returns the name of this data map.
|
int |
hashCode() |
java.lang.String |
toString()
Returns a string representation of the object.
|
public SmartPush createSmartPush() throws java.lang.Exception
java.lang.Exception
- if an unexpected fault occurspublic void execute(boolean clearData) throws java.lang.Exception
This is a privileged method. (see section Privileged Method)
clearData
- true to clear the target location before pushing datajava.lang.SecurityException
- if the current user is not permitted to execute
this memberDataPushException
- if the data push failsjava.lang.Exception
- if an unexpected fault occurspublic void execute(java.util.Map<java.lang.String,java.lang.String> overrideMembersMap, boolean clearData) throws java.lang.Exception
Any members overridden will replace the members in the data map definition for the overridden dimensions during execution.
This is a privileged method, see section Privileged Method
overrideMembersMap
- a map containing the dimension name
as the key and a member
selection string as a valueclearData
- true to clear the target location before pushing datajava.lang.SecurityException
- if the current user is not permitted to execute
this data mapDataPushException
- if the data push failsjava.lang.Exception
- if an unexpected fault occurspublic void execute(java.util.Map<java.lang.String,java.lang.String> overrideMembersMap, java.util.Map<java.lang.String,java.lang.String> overrideExclusionMembersMap, boolean clearData) throws java.lang.Exception
Any members overridden will replace the members in the data map definition for the overridden dimensions during execution.
Any members specified in a selection in the exclusion map will be excluded from the member selection in the data map definition for the excluded dimensions during execution.
Any members from the evaluated exclusion selection not present in the evaluated member selection from the data map definition will be ignored.
overrideMembersMap
- a map containing the dimension name
as the key and a member
selection string as a valueoverrideExclusionMembersMap
- a map containing the dimension name
as the key and a member
selection string as a valueclearData
- true to clear the target location before pushing dataDataPushException
- if the data push failsjava.lang.Exception
- if an unexpected fault occurspublic java.lang.String getName()
public java.lang.String toString()
toString
in class java.lang.Object
public boolean equals(java.lang.Object arg0)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
Copyright © 2017, 2024, Oracle and/or its affiliates. All rights reserved.