Know-how to use TM1 functions for Excel, Rules and TurboIntegrator

A dictionary for end-users and developers

Excel (IBM reference)
Excel Macro (IBM reference)
Rule (IBM reference)
TurboIntegrator (TI) (IBM reference)
MDX (IBM reference)

TM1 FunctionDefinitionExcelRulesTIMore Information
DBRRetrieve and write back a value or text to a cube’s cell. DBR is less efficient over a WAN than DBRW. DBR will be processed before a DBRW.Excel
DBRARetrieve and write back a value or text to a dimension’s attribute.Excel
DBRWProvides read and write back capability to Excel from a Cube.Excel
DBSSend a value to a cube’s cell. This function cannot send a string to a cube. To send strings, use the DBSS function.Excel
DBSASend a value to a dimension attribute. The value sent can be either a string or numeric value, based on the attribute type.Excel
DBSSSend a value to a dimension attribute. The value sent can be either a string or numeric value, based on the attribute type.Excel
DBSWSend a numeric value to a cube’s cell. DBSW is more efficient over a WAN than DBS.Excel
DFRSTReturns the first element in a dimensionExcel
DIMIXReturns an element’s index number in a dimensionExcelRulesTIRefer to Rules for TI syntax
DIMNMReturns an element’s primary name based on an index in a dimensionExcelRulesTIRefer to Rules for TI syntax
DIMSIZReturns the number of elements in a dimension.ExcelRulesTIRefer to Excel for Rules and TI syntax
DNEXTReturns the next element based on the index in a dimensionExcelRulesTIRefer to Excel for Rules and TI syntax
DNLEVReturns the number of levels in a dimensionExcelRulesTIRefer to Excel for Rules and TI syntax
DTYPEReturns the element type in a dimensionExcelRulesTIRefer to Excel for Rules and TI syntax
ELCOMPReturns the name of a child element from a consolidated element based on the positionExcelRulesTIRefer to Rules for TI syntax
ELCOMPNReturns the number of components under an elementExcelRulesTIRefer to Rules for TI syntax
ELISCOMPDetermine whether an element is a component of a parent element in a dimensionExcelRulesTIRefer to Rules for TI syntax
ELISPARDetermine whether an element is a parent of a child in a dimensionExcelRulesTIRefer to Rules for TI syntax
ELLEVReturns the level of an element within a dimension.ExcelRulesTIRefer to Rules for TI syntax
ELPARReturns the parent of an element in a dimensionExcelRulesTIRefer to Rules for TI syntax
ELPARNReturns the number of parents for an elementExcelRulesTIRefer to Rules for TI syntax
ELSLENReturns the number of characters in the element in a dimensionExcel
ELWEIGHTReturns the element’s weight to a consolidated element in a dimensionExcelRulesTIRefer to Rules for TI syntax
SUBNMReturns an element from a dimension setExcel
TABDIMReturns the dimension name in a cube based on an indexExcelTIRefer to Rules for TI syntax
TM1ELLISTReturns elements based on a list of elements, MDX or setExcel
TM1GLOBALSANDBOXReturns the active sandbox for the userExcel
TM1INFOReturns information on the TM1 clientExcel
TM1PRIMARYDBNAMEReturns the primary TM1 server name the user is authenticated inExcel
TM1RptElIsConsolidatedReturns a boolean value if an element is consolidatedExcel
TM1RptElIsExpandedReturns a boolean value if an element is expanded on the row setExcel
TM1RptElLevReturns an element’s level relative to the root in the subsetExcel
TM1RptFilterApply a filter to the Dynamic report to sort the row based on a columnExcel
TM1RptRowReturns the row set in a Dynamic Report Excel
TM1RptTitleUsed to define the title dimension Excel
TM1RptViewControls the definition of the report like zero suppression and the format areaExcel
TM1UserReturns the user logged inExcelTIRefer to Excel for TI syntax
VIEWSets up an optimised view for a cube that is cached in memory, so it can be referenced quickerExcel
ABSConverts a number into an absolute value.RulesTIRefer to Rules for TI syntax
ACOSReturns the angle, in radians, whose cosine is x.RulesTIRefer to Rules for TI syntax
AddClientCreate a new client on the server. TI
AddCubeDependencyEstablish cube dependency manually. TI
AddGroupCreate a new group on the server. TI
ASCIIDeleteDeletes an ASCII file.TI
ASINReturns the angle, in radians, whose sine is x. RulesTIRefer to Rules for TI syntax
ATANReturns the angle, in radians, whose tangent is x.RulesTIRefer to Rules for TI syntax
ATTRNReturns the numeric attribute for a specified element of a dimension.RulesTIRefer to Rules for TI syntax
ATTRSReturns the string attribute for a specified element of a dimension.RulesTIRefer to Rules for TI syntax
CAPITCapitalize the first letter of every word in a string. RulesTIRefer to Rules for TI syntax
CellValueNReturns the numeric value of the specified element in a specified cube.Rules
CellValueSReturns a string attribute for a specified cube.Rules
CHARConverts the ASCII numeric code into the character. RulesTIRefer to Rules for TI syntax
CODEConverts the character to the ASCII numeric code.  RulesTIRefer to Rules for TI syntax
ConsolidateChildrenForces consolidate value to be calculated by summing immediate children. Rules
ConsolidatedAvgReturns the average value in a consolidation.  RulesTIRefer to Rules for TI syntax
ConsolidatedCountReturns the number of values in a consolidationRulesTIRefer to Rules for TI syntax
ConsolidatedCountUniqueCounts the unique elements of the consolidated cell in one dimension. RulesTIRefer to Rules for TI syntax
ConsolidatedMaxReturns the maximum value in a consolidation.  RulesTIRefer to Rules for TI syntax
ConsolidatedMinReturns the minimum value in a consolidation.  RulesTIRefer to Rules for TI syntax
CONTINUEAllows a subsequent rule within the same intersection to be executed. RulesTIRefer to Rules for TI syntax
COSReturns the cosine of an angle expressed in radians.RulesTIRefer to Rules for TI syntax
CubeATTRNReturns a numeric attribute for a specified cube.RulesTIRefer to Rules for TI syntax
CubeATTRSReturns a string attribute for a specified cube.RulesTIRefer to Rules for TI syntax
DATEReturns the date in a string yy-dd-mm format.RulesTIRefer to Rules for TI syntax
DATESReturns the date in a string yy-dd-mm or yyyy-dd-mm format.RulesTIRefer to Rules for TI syntax
DAYReturns  the day from a date in a numeric format.RulesTIRefer to Rules for TI syntax
DAYNOReturns the serial number from a date in a numeric format. RulesTIRefer to Rules for TI syntax
DBRetrieve a value from a cube cell. Rules
DELETDeletes a specified number of characters from a specified position within a string.RulesTIRefer to Rules for TI syntax
DimensionATTRNReturns a numeric attribute for a specified dimension.RulesTIRefer to Rules for TI syntax
ElementAttrNReturns the numeric attribute value of the specified element of a dimension.  RulesTIRefer to Rules for TI syntax
ElementAttrSReturns the string attribute value of the specified element of a dimension.  RulesTIRefer to Rules for TI syntax
ElementComponentReturns the name of child of a consolidated element. RulesTIRefer to Rules for TI syntax
ElementComponentCountReturns the number of components of the consolidation. RulesTIRefer to Rules for TI syntax
ElementCountReturns the number of components of the consolidated element.RulesTIRefer to Rules for TI syntax
ElementFirstReturns the first element of a specified dimension.    RulesTIRefer to Rules for TI syntax
ElementIndexReturns the index number of an element within a dimension. RulesTIRefer to Rules for TI syntax
ElementIsAncestorDetermines if the element is an ancestor of another element or not. Function returns 1 if the element is ancestor of another element. RulesTIRefer to Rules for TI syntax
ElementIsComponentDetermines if the element is child of a consolidation or not.  Function returns 1 if the element is child of consolidation. RulesTIRefer to Rules for TI syntax
ElementIsParentDetermines if an element is parent of another element or not.  RulesTIRefer to Rules for TI syntax
ElementLevelReturns the level of an element within a dimension.RulesTIRefer to Rules for TI syntax
ElementNameReturns the element of a dimension based on the index argument. RulesTIRefer to Rules for TI syntax
ElementNextReturns the element that follows the specified element of a dimension.RulesTIRefer to Rules for TI syntax
ElementParentReturns the parent of an element in the dimension.RulesTIRefer to Rules for TI syntax
ElementParentCounteturns the number of parents of an element in the dimension.  RulesTIRefer to Rules for TI syntax
ElementTypeReturns element type information of an element in the dimension. RulesTIRefer to Rules for TI syntax
ElementWeightReturns the weight of a child element in a consolidation element.RulesTIRefer to Rules for TI syntax
ELISANCDetermines if an element is ancestor of another element or not.  RulesTIRefer to Rules for TI syntax
EXPReturns the natural anti-log of a number.RulesTIRefer to Rules for TI syntax
FEEDERSFlag rule cells and force TM1 engine to calculate. Rules
FEEDSTRINGSEnables feeding of string cells. Rules
FILLRepeats a string to the specified number of lengthsRules
FVReturns the future value of an annuity at the time of the last payment. RulesTIRefer to Rules for TI syntax
HierarchyReturns the name of the hierarchy if there is only one hierarchy at the dimension otherwise it returns empty string.  Rules
HierarchyCountReturns the number of hierarchies in the supplied dimension.Rules
HierarchyIndexFunction returns a 1-based index if the hierarchy is in the supplied dimension, 0 otherwise.Rules
HierarchyNReturns the name of the hierarchy at a specified position. Rules
IFUses a conditional expression to check if an expression is true or false. RulesTI
INSRTInserts one string into another string at the given position number.RulesTIRefer to Rules for TI syntax
INTReturns the largest value that is less than or equals to a specified value. RulesTIRefer to Rules for TI syntax
ISLEAFDetermines if an element is leaf element or not.Rules
ISUNDReturns 1 if the argument value is undefined.  RulesTIRefer to Rules for TI syntax
ISUNDEFINEDCELLVALUECompares the argument value with default numeric cube value and returns 1 if the cell value is equal to cube’s default value. RulesTIRefer to Rules for TI syntax
LNConverts a number into an absolute value. returns the natural base e logarithm of a number.RulesTIRefer to Rules for TI syntax
LOGReturns the base 10 logarithm of a positive number.RulesTIRefer to Rules for TI syntax
LONGReturns the length of the string. RulesTIRefer to Rules for TI syntax
LOWERConverts text characters to lower case. RulesTIRefer to Rules for TI syntax
MAXReturns the largest number between two numbers.   RulesTIRefer to Rules for TI syntax
MINReturns the smallest number between two numbers.  RulesTIRefer to Rules for TI syntax
MODReturns the remainder after a number is divided by a divisor. RulesTIRefer to Rules for TI syntax
MONTHReturns the month from a date in a numeric format. RulesTIRefer to Rules for TI syntax
NOWReturns the current Time in a serial number format.   RulesTIRefer to Rules for TI syntax
NUMBRConverts string character to a number. RulesTIRefer to Rules for TI syntax
PAYMTReturns the payment amount of an annuity based on the principal amount, rate, and number of periodsRulesTIRefer to Rules for TI syntax
PVReturns the initial or principal value of an annuityRulesTIRefer to Rules for TI syntax
RANDFunction generates a random number. RulesTIRefer to Rules for TI syntax
ROUNDFunction rounds a number to the nearest integer. RulesTIRefer to Rules for TI syntax
ROUNDPRounds a number at a specified decimal precision. RulesTIRefer to Rules for TI syntax
SCANSearches the specified substring within a string and returns the starting position of the substring. RulesTIRefer to Rules for TI syntax
SIGNDetermines if the number is positive or negative. RulesTIRefer to Rules for TI syntax
SINReturns the sine of an angle expressed in radians.RulesTIRefer to Rules for TI syntax
SKIPCHECKForces TM1 engine to skip the check of all N level empty cells in a cube. RulesTIRefer to Rules for TI syntax
SQRTReturns the square root of a give value. RulesTIRefer to Rules for TI syntax
STETCancels the effect of rule for a specified element. Rules
STRConverts number to a string character.  RulesTIRefer to Rules for TI syntax
SUBSTReturns the substring of a specified string. RulesTIRefer to Rules for TI syntax
TANReturns the tangent of an angle expressed in radians.RulesTIRefer to Rules for TI syntax
TIMEReturns the current Time from the TM1 server in a string format. RulesTIRefer to Rules for TI syntax
TIMSTReturns a formatted date/time in a string format.RulesTIRefer to Rules for TI syntax
TIMVLReturns a formatted date/time in a string format. RulesTIRefer to Rules for TI syntax
TODAYReturns the current date in a string yy-dd-mm format. RulesTIRefer to Rules for TI syntax
TRIMRemoves any leading and trailing spaces from a string. RulesTIRefer to Rules for TI syntax
UNDEFReturns the undefined value.RulesTIRefer to Rules for TI syntax
UNDEFINEDCELLVALUEReturns the default numeric cube value. RulesTIRefer to Rules for TI syntax
UNDEFVALSChanges the default value for the cube from zero to a special undefined value.RulesTIRefer to Rules for TI syntax
UPPERConverts text characters to upper case. RulesTIRefer to Rules for TI syntax
YEARReturns the year from a date in a numeric format. RulesTIRefer to Rules for TI syntax
ASCIIOutputExports to an ASCII file. The fields exported must be in string format. To convert a number to string, use NumberToString or STR.TI
AssignClientPasswordChange the password for a user.  TI
AssignClientToGroupAssigns an existing client on a server to an existing user group.  TI
AssociateCAMIDToGroupCreates an association between a TM1 user group and a CAMID (Cognos Access Manager ID) that can be viewed in }ClientCAMAssociatedGroups control cube. TI
AttrDeleteDeletes an attribute for a dimension.TI
AttrInsertCreates a new attribute for a dimenion.TI
ATTRNLReturns a numeric attribute for an element in a dimension.TI
AttrPutNUploads a value to a numeric attribute for an element.TI
AttrPutSUploads a string into an attribute to an element.TI
ATTRSLReturns a string attribute for an element.TI
BatchUpdateFinishEnds the batch process that was started by BatchUpdateStart.  TI
BatchUpdateFinishWaitEnds the batch process until a lock become available that was started by BatchUpdateStart.TI
BatchUpdateStartEnables batch updates so changes can be committed together when BatchUpdateFinish or BatchUpdateFinishWait is called.TI
CellGetNRetrieves a numeric value from a cube cell.TI
CellGetSRetrieves a string value from a cube cell.TI
CellIncrementNIncreases a numeric value by a value.TI
CellIsUpdateableChecks whether a cube cell can be written to. If the cell can be written to, the function returns 1, otherwise a 0 is returned.TI
CellPutNWrites a numeric value to a cube cell.TI
CellPutProportionalSpreadProportionally spreads a value to the children of a consolidation.TI
CellPutSWrites a string value to a cube cell.TI
CellSecurityCubeCreateCreates cell security for a cube.  TI
CellSecurityCubeDestroyDeletes cube’s cell security.TI
ChoreAttrDeleteDeletes an attribute for Chores.TI
ChoreAttrInsertCreates an attribute for Chores. TI
ChoreAttrNRetrieves a numeric attribute for a Chore. TI
ChoreAttrNLRetrieves a numeric attribute for a Chore, based on a language locale. TI
ChoreAttrPutNUploads data to a numeric attribute for a Chore. TI
ChoreAttrPutSUploads data to a string attribute for a Chore. TI
ChoreAttrSRetrieves data from a string attribute for a chore.   TI
ChoreAttrSLRetrieves data from a string attribute for a chore, based on the language locale. TI
ChoreErrorTerminates the chore and flag with an error status.  TI
ChoreQuitTerminates a chore and flag with an error status.  TI
ChoreRollbackTerminates a chore and begins a rollback.  TI
CreateHierarchyByAttributeCreates a hierarchy composed of three levels. The lowest level is the N element, the first parent is a given attribute, and the top level is given by a parameter. The new hierarchy will have the same name as the given attribute.   TI
CubeAttrDeleteDeletes a cube’s attribute. TI
CubeAttrInsertCreates a new attribute for Cubes.TI
CubeATTRNLRetrieves data from a numeric attribute for a cube by language locale.TI
CubeAttrPutNUploads data to a numeric attribute for a cube.TI
CubeAttrPutSUploads data to a string attribute for a cube.TI
CubeATTRSLRetrieves data from a string attribute for a Cube, based on the language locale.TI
CubeClearDataCubeClearData clears the entire data for a Cube.TI
CubeCreateCreates a cube using the list of specified dimensions.TI
CubeDataReservationAcquireAcquires data reservation for a cube, user and intersection.TI
CubeDataReservationGetFinds the data reservations for a cube.TI
CubeDataReservationGetConflictsGets data reservation set for a cube that conflicts with a user, address and tuple.TI
CubeDataReservationReleaseReleases the data reservation for a cube, user and address.  TI
CubeDataReservationReleaseAllReleases all the data reservation specified.TI
CubeDestroyDeletes a Cube from the TM1 Server.   TI
CubeDimensionCountGetReturns the number of dimensions in a cube. TI
CubeDRAcquireAcquires data reservation for a user in a cube according to an element list. This function applies to dimensions with one or more hierarchies, while CubeDataReservationAcquire is used for dimensions with a single hierarchy.TI
CubeDRGetFinds existing reservations on a specific cube for all or one user. This function applies to dimensions with one or more hierarchies, while CubeDataReservationGet is used for dimensions with a single hierarchy.TI
CubeDRGetConflictsGets the current data reservation conflicts of the cube. This function applies to dimensions with one or more hierarchies, while CubeDataReservationGetConflicts is used for dimensions with a single hierarchy.TI
CubeDRReleaseReleases the data reservation specified in the element list. This function applies to dimensions with one or more hierarchies, while CubeDataReservationRelease is used for dimensions with a single hierarchy.TI
CubeDRReleaseAllReleases all the data reservation specified in the element list. This function applies to dimensions with one or more hierarchies, while CubeDataReservationReleaseAll is used for dimensions with a single hierarchy.TI
CubeExistsUsed check if a cube exists on the TM1 Server.TI
CubeGetLogChangesDetermines whether logging property of a cube is turned on or not.  TI
CubeProcessFeedersRe-processes feeders in the rule for a specified cube. TI
CubeRuleAppendAppends a single line of text to a rule.TI
CubeRuleDestroyDeletes the rule from a cube.TI
CubeSaveDataSerialises a cube to disk.TI
CubeSetConnParamsSets the connection parameters and encrypt the password for a virtual cube stored in }CubeProperties control cube. TI
CubeSetLogChangesSets the logging property for a cube.TI
CubeTimeLastUpdatedReturns a serial value which refers to the last time the cube was updated. TI
CubeUnloadUnloads a cube and its view from the memory. TI
DataMinorErrorCountCounts minor errors that occur in Data tab.TI
DatasourceASCIIDecimalSeparatorSets the decimal separator for a text file.TI
DatasourceASCIIDelimiterSets the delimiter for a text file.TI
DatasourceASCIIHeaderRecordsSets the header records for a text file.TI
DatasourceASCIIQuoteCharacterSets the quote character for a text fileTI
DatasourceASCIIThousandSeparatorSets the thousand separator for a text fileTI
DatasourceCubeviewSets the cube view in the data source.TI
DatasourceDimensionSubsetSets the dimension subset in the data source.TI
DatasourceNameForClientSets the name of the data source from the client’s perspective when creating or editing the process.TI
DatasourceNameForServerSets the name for the data source.TI
DatasourcePasswordSets the password used for the data sourceTI
DatasourceQuerySets query for the data sourceTI
DatasourceTypeSets the type used for the data source.TI
DatasourceUsernameSets the name used to connect to the data source.TI
DeleteAllPersistentFeedersDeletes all persistent feeders on the TM1 Server.TI
DeleteClientDeletes an existing client from the server.TI
DeleteGroupDeletes a group from the server.  TI
DimensionAttrPutNUploads data to a numeric attribute for a dimension.TI
DimensionAttrPutSUploads data to a string attribute for a dimension.TI
DimensionCreateCreates a new dimension.  TI
DimensionDeleteAllElementsDeletes all elements in a dimension.TI
DimensionDeleteElementsDeletes elements in a dimension based on a subset.TI
DimensionDestroyDeletes a dimension.TI
DimensionElementComponentAddAdds an element to a consolidated element in a rollup according to a specific weight in a dimension. This action occurs after a commitment in the process (e.g. at the end of executing the metadata tab). To action this function immediately, use DimensionElementComponentAddDirect.TI
DimensionElementComponentAddDirectAdds an element to a consolidated element in a rollup according to a specific weight in a dimension. This function is actioned immediately.  To action this function until the process makes a commitment (e.g. at the end of executing the metadata tab), use DimensionElementComponentAdd.TI
DimensionElementComponentDeleteDeletes an element from a consolidated element in a rollup. This action occurs after a commitment in the process (e.g. at the end of executing the metadata tab). To action this function immediately, use DimensionElementComponentDeleteDirect.TI
DimensionElementComponentDeleteDirectDeletes an element from a consolidated element. This function is actioned immediately.  To action this function until the process makes a commitment (e.g. at the end of executing the metadata tab), use DimensionElementComponentDelete.TI
DimensionElementDeleteDeletes an element in a dimension. This action occurs after a commitment in the process (e.g. at the end of executing the metadata tab). To action this function immediately, use DimensionElementDeleteDirect.TI
DimensionElementDeleteDirectDeletes an element directly in a dimension. This function is actioned immediately.  To action this function until the process makes a commitment (e.g. at the end of executing the metadata tab), use  DimensionElementDelete.TI
DimensionElementExistsChecks whether a specific element exists in a dimension. If the element exists, the result is 1 and if it does not exist, the result is 0.TI
DimensionElementInsertAdds an element in a dimension. This action occurs after a commitment in the process (e.g. at the end of executing the metadata tab). To action this function immediately, use DimensionElementInsertDirect.TI
DimensionElementInsertDirectAdds an element in a dimension by directly editing a dimension. This function is actioned immediately.  To action this function until the process makes a commitment (e.g. at the end of executing the metadata tab), use DimensionElementInsert.TI
DimensionElementPrincipalNameReturns the principal name of an element or element alias.TI
DImensionExistsChecks whether a dimension exists. If the dimension exists, the result is 1 and if it does not exist the result is 0.TI
DimensionHierarchyCreateCreates a hierarchy in a dimension. No elements will be inserted in the hierarchy.TI
DimensionSortOrderSorts the elements and components of consolidations within a dimension.TI
DimensionTimeLastUpdatedReturns a serial value indicating date and time when a dimension was last updated. Use TIMST to convert the value to a date/time format.TI
DimensionTopElementInsertCreates a root element in a dimension. This can only be created if the dimension does not have a standalone root element. This action occurs after a commitment in the process (e.g. at the end of executing the metadata tab). To action this function immediately, use DimensionTopElementInsertDirect.TI
DimensionTopElementInsertDirectCreates a root element in a dimension by directly editing a dimension. This can only be created if the dimension does not have a standalone root element. This function is actioned immediately.  To action this function until the process makes a commitment (e.g. at the end of executing the metadata tab), use DimensionTopElementInsert.TI
DimensionUpdateDirectRewrites a dimension that has been edited with Dimension*Direct function(s) (e.g. DimensionElementInsertDirect) to reduce the memory utilised to edit the dimension.TI
DisableBulkLoadModeDisables bulk load processing on the TM1 Server. To enable bulk load processing, use EnableBulkLoadMode. TI
DisableMTQViewConstructDisables multi-threaded query processing in a process which uses a cube view as the datasource. This function will override the value MTQQuery=F set in the tms1.cfg file. TI
ElementAttrDeleteDeletes attribute for a dimension.TI
ElementAttrInsertCreate an attribute for a dimension.TI
ElementATTRNLRetrieves a numeric attribute for an element.TI
ElementAttrPutNUploads data to a numeric attribute for an element.TI
ElementAttrPutSUploads data from a string attribute for an element.TI
ElementATTRSLReturns a string attribute for an element.TI
ElementSecurityGetRetrieves the security level assigned to a specified group for a dimension element.TI
ElementSecurityPutAssigns a security level to a specified group for an element.TI
EnableBulkLoadModeEnables bulk load processing to improve process efficiency. Call EnableBulkLoadMode in the Prolog or Epilog. This function is enabled in in one process and remains enabled until disabled with DisableBulkLoadMode or until a chore completes.TI
EnableMTQViewConstructEnables multi-threaded query processing in a process which uses a cube view as the datasource. This function will override the value MTQQuery=F set in the tms1.cfg file. TI
ExecuteCommandExecutes a command line.TI
ExecuteProcessExecutes a process. TI
ExpandExpands variable names, enclosed in % signs.TI
FileExistsSearches if a file exists in a folder. If the file exists, then 1 is returned, otherwise 0 is returned. TI
ForceSkipCheckForces the view query to process only values in the cube, instead of going through every possible cell. Use in the Prolog tab.TI
FormatDateFormats a date valueTI
GetProcessErrorFileDirectoryReturns the full path name, with trailing slash, of the directory where error files are written.TI
GetProcessErrorFilenameReturns the name of the error log file associated with the process. If the process has not yet generated an error log file, the function returns an empty (null) string.TI
GetProcessNameReturns the name of the process.TI
HierarchyContainsAllLeavesIf a hierarchy contains all leaf elements in the dimension. If all are leaf elements the function returns 1 (True) and if missing one or more leaf elements it returns 0 (false).TI
HierarchyCreateCreates a new hierarchy in a dimension.TI
HierarchyDeleteAllElementsDeletes all elements in a hierarchy.TI
HierarchyDeleteElementsDeletes an element from a hierarchy.TI
HierarchyDestroyDeletes a hierarchy from a dimension.TI
HierarchyElementComponentAddAdds an element to a consolidated element in a hierarchy, rolling up according to the weight defined. This action occurs after a commitment in the process (e.g. at the end of executing the metadata tab). To action this function immediately, use HierarchyElementComponentAddDirect.TI
HierarchyElementComponentAddDirectAdds an element to a consolidated element in a hierarchy, rolling up according to the weight defined. This function is actioned immediately.  To action this function until the process makes a commitment (e.g. at the end of executing the metadata tab), use HierarchyElementComponentAdd.TI
HierarchyElementComponentDeleteDeletes a component (child) from a consolidated element in a hierarchy. This action occurs after a commitment in the process (e.g. at the end of executing the metadata tab). To action this function immediately, use HierarchyElementComponentDeleteDirect.TI
HierarchyElementComponentDeleteDirectDeletes a component (child) from a consolidated element in a specific hierarchy in a dimension. This function is actioned immediately.  To action this function until the process makes a commitment (e.g. at the end of executing the metadata tab), use HierarchyElementComponentDelete.TI
HierarchyElementDeleteDeletes a member element of a specific hierarchy. This action occurs after a commitment in the process (e.g. at the end of executing the metadata tab). To action this function immediately, use HierarchyElementDeleteDirect..TI
HierarchyElementDeleteDirectDeletes a member element of a specific hierarchy in a dimension. This function is actioned immediately.  To action this function until the process makes a commitment (e.g. at the end of executing the metadata tab), use HierarchyElementDelete.TI
HierarchyElementExistsChecks whether an element exists in a dimension. If the element exists, the result is 1. If it does not exist, the result is 0. TI
HierarchyElementInsertAdds an element to a hierarchy. This action occurs after a commitment in the process (e.g. at the end of executing the metadata tab). To action this function immediately, use HierarchyElementInsertDirect.TI
HierarchyElementInsertDirectAdds an element to a specific hierarchy. This function is actioned immediately.  To action this function until the process makes a commitment (e.g. at the end of executing the metadata tab), use HierarchyElementInsert.TI
HierarchyElementPrincipalNameReturns the principal name of an element given an alias or the element name itself.TI
HierarchyElementSecurityGetReturns the level of security privilege designated to a group for an element.TI
HierarchyElementSecurityPutSets security access for a group to an element.TI
HierarchyExistsChecks whether a specific hierarchy exists in a dimension. If the hierarchy exists, the result is 1 and if it does not exist the result is 0.TI
HierarchyHasOrphanedLeavesReturns 1 if a hierarchy in a dimension has an orphaned element or returns 0 if there is no orphaned element in that hierarchy.TI
HierarchySortOrderSets the order in which elements in a dimension are organized and displayed.TI
HierarchySubsetAliasSetSets an alias for a subset for a hierarchy. Returns 1 if successful or 0 if not.TI
HierarchySubsetAttrDeleteDeletes a subset attribute from a hierarchy in a dimension.TI
HierarchySubsetAttrInsertAdds a new attribute for subsets.TI
HierarchySubsetAttrPutSWrites a string value to a subset’s attribute or set of elements in a hierarchy for a dimension.TI
HierarchySubsetATTRSRetrieve data from a string attribute associated to a subset in a hierarchy.TI
HierarchySubsetATTRSLRetrieve data from a string attribute associated to a subset in a hierarchy, based on a language locale.TI
HierarchySubsetCreateCreates an empty public subset in a hierarchy.TI
HierarchySubsetDeleteAllElementsDeletes all elements in a subset from a hierarchy. TI
HierarchySubsetDestroyDestroys a subset from a hierarchy.TI
HierarchySubsetElementDeleteDeletes an element from a subset using an index number.TI
HierarchySubsetElementExistsChecks if an elements exists in a public subset. 1 is returned if the elements exists or 0 if it does not exist in the subset.TI
HierarchySubsetElementGetIndexReturns the index of an element in a subset for a hierarchy.TI
HierarchySubsetElementInsertAdds an element into a subset associated to a hierarchy.TI
HierarchySubsetExistsChecks if a public subset exists for a hierarchy. 1 is returned if the subset exists or 0 if the subset does not exist.TI
HierarchySubsetGetElementNameReturns the name of an element from a subset using an index number that’s associated with a hierarchy.TI
HierarchySubsetGetSizeReturns the number of elements in a subset that’s associated with a hierarchy.TI
HierarchySubsetIsAllSetSets a subset to contain all elements of the dimension.TI
HierarchySubsetMDXGetReturns the MDX expression used to for a subset that’s associated with a hierarchy.TI
HierarchySubsetMDXSetInserts a MDX expression to a public subset.TI
HierarchyTimeLastUpdatedReturns a number which refers to the last time the hierarchy was updated. This is a consecutive number that counts the days since 01/01/1900. TI
HierarchyTopElementInsertAdds a root element to a hierarchy, if there isn't any root element in it. This action occurs after a commitment in the process (e.g. at the end of executing the metadata tab). To action this function immediately, use HierarchyTopElementInsertDirect.TI
HierarchyTopElementInsertDirectAdds a root element to target hierarchy if there isn’t any root element in it. This function is actioned immediately.  To action this function until the process makes a commitment (e.g. at the end of executing the metadata tab), use HierarchyTopElementInsert.TI
ItemRejectSkips the current source data transaction like ItemSkip. However, ItemReject allows us to write a custom message in the log file.TI
ItemSkipSkips the current transaction in the process.TI
LogOutputWrites a message to the tm1server.log file.