Cube Manipulation TurboIntegrator Functions
These functions pertain to manipulating cubes.
CellGetN:
This is a TM1 TurboIntegrator function, valid only in TurboIntegrator processes.
This function retrieves a value from a numeric cube cell.
Syntax:
CellGetN(Cube, e1, e2 [,...en]);
Arguments:
| Argument | Description |
| Cube | The name of the cube from which you want to retrieve a value. |
| e1,...en | Dimension element names that define the intersection of the cube containing the value to be retrieved. Arguments e1 through en are sequence-sensitive. e1 must be an element from the first dimension of the cube, e2 must be an element from the second dimension, and so on. These arguments can also be the names of aliases for dimension elements or TurboIntegrator variables. |
Example:
CellGetN ('y2ksales', 'Actual', 'Argentina', 'S Series 1.8L Sedan', 'Sales', 'Jan');
This example retrieves the numeric value at the intersection of the Actual, Argentina, S Series 1.8L Sedan, Sales, and Jan elements in the y2ksales cube.
CellGetS:
This is a TM1 TurboIntegrator function, valid only in TurboIntegrator processes.
This function retrieves a value from a string cube cell.
Syntax:
CellGetS(Cube, e1, e2 [,...en]);
Arguments:
| Argument | Description |
| Cube | The name of the cube from which you want to retrieve a string. |
| e1,...en | Dimension element names that define the intersection of the cube containing the value to be retrieved. Arguments e1 through en are sequence-sensitive. e1 must be an element from the first dimension of the cube, e2 must be an element from the second dimension, and so on. These arguments can also be the names of aliases for dimension elements or TurboIntegrator variables. |
Example:
CellGetS('Personnel', 'Rep', 'Europe', 'Product');
This example retrieves the string value at the intersection of the Rep, Europe, and Product elements in the Personnel cube.
CellIsUpdateable:
This is a TM1 TurboIntegrator function, valid only in TurboIntegrator processes.
This function lets you determine if a cube cell can be written to. The function returns 1 if the cell can be written to, otherwise it returns 0.
Syntax:
CellIsUpdateable(Cube, e1, e2 [,...en]);
| Argument | Description |
| Cube | The name of the cube to which you want to write a value. |
| e1,...en | Dimension element names that define the cell to which you want to write a value. Arguments e1 through en are sequence-sensitive. e1 must be an element from the first dimension of the cube, e2 must be an element from the second dimension, and so on. These arguments can also be the names of aliases for dimension elements or TurboIntegrator variables. |
Example:
CellIsUpdateable ('y2ksales', 'Actual', 'Argentina', 'S Series 1.8L Sedan', 'Sales', 'Jan');
This example determines if the cell defined by the elements Actual, Argentina, S Series 1.8L Sedan, Sales, and Jan in the y2ksales cube can be written to. If the cell can receive a value, the function returns 1, otherwise it returns 0.
CellPutN:
This is a TM1 TurboIntegrator function, valid only in TurboIntegrator processes.
This function sends a numeric value to a cube cell.
Syntax:
CellPutN(x, Cube, e1, e2 [,...en]);
| Argument | Description |
| x | A numeric value. |
| Cube | The name of the cube to which you want to send the value. |
| e1,...en | Dimension element names that define the intersection of the cube to receive the value. Arguments e1 through en are sequence-sensitive. e1 must be an element from the first dimension of the cube, e2 must be an element from the second dimension, and so on. These arguments can also be the names of aliases for dimension elements or TurboIntegrator variables. |
Example:
CellPutN(12345, 'y2ksales', 'Actual', 'Argentina', 'S Series 1.8L Sedan', 'Sales', 'Jan');
This example sends the value 12345 to the intersection of the Actual, Argentina, S Series 1.8L Sedan, Sales, and Jan elements in the y2ksales cube.
CellPutProportionalSpread:
This is a TM1 TurboIntegrator function, valid only in TurboIntegrator processes.
This function distributes a specified value to the leaves of a consolidation proportional to existing cell values. CellPutProportionalSpread replaces existing cell values; it cannot be used to add to or subtract from existing cell values.
The function is analogous to the Proportional Spread data spreading method, which is described in detail in the IBM Cognos TM1 Users Guide. If you must add to or subtract from existing cell values, use the Proportional Spread method, which can be executed through the user interface or through data spreading syntax.
Note: When using CellPutProportionalSpread to distribute a value to the leaves of a consolidation, only those leaves already containing non-zero values are changed. This is because zero values cannot be incremented or decremented proportionally; any proportion of zero is still zero.
Syntax:
CellPutProportionalSpread( value, cube, e1, e2, e3...,en);
Arguments:
| Argument | Description |
| value | The value you want to distribute. |
| cube | The name of the cube into which you want to distribute the value. |
| e1...en | The names of the elements that identify the consolidation whose leaves will accept the distributed value. Arguments e1 through en are sequence-sensitive. e1 must be an element from the first dimension of the cube, e2 must be an element from the second dimension, and so on. These arguments can also be the names of aliases for dimension elements or TurboIntegrator variables. |
CellPutProportionalSpread(7000,'SalesCube', 'Actual', 'North America', 'S Series 1.8L Sedan','Sales', 'Jan');
This example distributes the value 7000 to the children of the consolidation in the SalesCube identified by the elements Actual, North America, S Series 1.8L Sedan, Sales, and Jan.
CellPutS:
This is a TM1 TurboIntegrator function, valid only in TurboIntegrator processes.
This function sends a string value to a cube cell.
Syntax:
CellPutS(String, Cube, e1, e2 [,...en]);
| Argument | Description |
| String | A String. |
| Cube | The name of the cube to which you want to send the string. |
| e1,...en | Dimension element names that define the intersection of the cube to receive the string. Arguments e1 through en are sequence-sensitive. e1 must be an element from the first dimension of the cube, e2 must be an element from the second dimension, and so on. These arguments can also be the names of aliases for dimension elements or TurboIntegrator variables. |
Example:
CellPutS('jones', 'Personnel', 'Rep', 'Europe', 'Product');
This example sends the string 'jones' to the intersection of the Rep, Europe, and Product elements in the personnel cube.
CubeCreate:
This is a TM1 TurboIntegrator function, valid only in TurboIntegrator processes.
This function creates a cube from specified dimensions. The order of dimensions specified in the function will be the order of dimensions in the cube definition.
After execution, CubeCreate automatically saves the resulting .cub file to disk.
Syntax:
CubeCreate(Cube, d1, d2 [,...dn]);
Arguments:
| Argument | Description |
| Cube | The name you want to assign to the cube. |
| d1,...dn | The names of dimensions that comprise the cube. You must specify at least two, but no more than 16, dimensions. |
Example:
CubeCreate('y2ksales', 'Actvsbud', 'Region', 'Model', 'Account1', 'Month');
This example creates a cube named y2ksales using the dimensions Actvsbud, Region, Model, Account1, and Month.
CubeDestroy:
This is a TM1 TurboIntegrator function, valid only in TurboIntegrator processes.
This function deletes a specified TM1 cube.
Syntax:
CubeDestroy(Cube);
Arguments:
| Argument | Description |
| Cube | The name of the cube you want to delete. |
Example:
CubeDestroy('y2ksales');
This example deletes the cube named y2ksales.
CubeExists:
This is a TM1 TurboIntegrator function, valid only in TurboIntegrator processes.
Use CubeExists to determine if a specific cube exists on the server from which a TurboIntegrator process is executed. The function returns 1 if the cube exists on the server, otherwise it returns 0.
Syntax:
CubeExists(CubeName);
Arguments:
| Argument | Description |
| CubeName | The name of the cube whose existence you want to confirm. |
Example:
CubeExists('Inventory');
This example determines if the Inventory cube exists on the TM1 server.
CubeGetLogChanges:
This is a TM1 TurboIntegrator function, valid only in TurboIntegrator processes.
This function returns the Boolean value of the Logging property for a specified cube. The Logging property is set in the TM1 Security Assignments dialog box and stored in the "}CubeProperties" control cube.
If Logging is turned on for a cube, the function returns 1.
If logging is turned off the function returns 0.
Syntax:
CubeGetLogChanges(CubeName);
Arguments:
| Argument | Description |
| CubeName | The cube for which you want to return the value of the Logging property. |
Example:
Assuming that Logging is turned on for the 2002sales cube, the function CubeGetLogChanges('2002sales');
returns 1.
CubeSetLogChanges:
This is a TM1 TurboIntegrator function, valid only in TurboIntegrator processes.
This function sets the LOGGING property for a cube.
Syntax:
CubeSetLogChanges(Cube, LogChanges);
Arguments:
| Argument | Description |
| Cube | The name of the cube for which you want to set the LOGGING property. |
| LogChanges | The Boolean value you want to assign to the property. 1= LOGGING on, 0 = LOGGING off. |
CubeUnload:
This is a TM1 TurboIntegrator function, valid only in TurboIntegrator processes.
This function unloads a specified cube, along with all associated cube views, from memory.
Syntax:
CubeUnload(CubeName);
Arguments:
| Argument | Description |
| CubeName | The cube you want to unload from memory. |
Example:
CubeUnload('ManufacturingBudget');
This example unloads the ManufacturingBudget cube, and any associated views, from server memory.
0 comments:
Post a Comment