IBM Planning AnalyticsVersión 2 Release 0

Referencia de TM1

IBM

Nota

Antes de utilizar esta información y el producto al que da soporte, lea la información del apartado“Avisos” en la página 433.

Información sobre el producto

Este documento se aplica a IBM Planning Analytics Versión 2.0 y puede aplicarse también a versiones posteriores.

Licensed Materials - Property of IBM

Última actualización: 2019-11-13© Copyright International Business Machines Corporation 2007, 2019.

Contenido

Introducción........................................................................................................xv

Capítulo 1. Cuadros de diálogo y ventanas..............................................................1Cuadro de diálogo Propiedades del botón de acción..................................................................................1

Pestaña Proceso..................................................................................................................................... 2Pestaña Hoja de trabajo......................................................................................................................... 3Pestaña Apariencia.................................................................................................................................4

Cuadro de diálogo Opciones avanzadas......................................................................................................5Cuadrícula Correlación avanzada...........................................................................................................5

Editor de atributos....................................................................................................................................... 7Menú Archivo.......................................................................................................................................... 7Menú Editar.............................................................................................................................................7Opciones de formato.............................................................................................................................. 8

Ventana Registro de auditoría................................................................................................................... 10Panel Consulta......................................................................................................................................10Panel Resultados..................................................................................................................................12

Ventana Detalles del registro de auditoría................................................................................................13Barra de herramientas Detalles........................................................................................................... 14Cuadrícula Detalles.............................................................................................................................. 14

Asistente para la configuración de tareas.................................................................................................14Pantalla 1 (paso 1)............................................................................................................................... 15Pantalla 2 (paso 2)............................................................................................................................... 15

Ventana Clientes/Grupos...........................................................................................................................15Menú Seguridad....................................................................................................................................16Menú Clientes.......................................................................................................................................16Menú Grupos........................................................................................................................................ 16Cuadrícula Clientes/Grupos................................................................................................................. 17

Cuadro de diálogo Centro de mensajes de clientes..................................................................................18Cuadro de diálogo Crear una dimensión................................................................................................... 18Cuadro de diálogo Crear objeto de réplica de servidor............................................................................ 19Cuadro de diálogo Creación de cubos.......................................................................................................19Cuadro de diálogo Optimizador del cubo..................................................................................................20Cuadro de diálogo Propiedades del cubo................................................................................................. 21Cube Viewer............................................................................................................................................... 21

Menú Archivo........................................................................................................................................22Menú Editar.......................................................................................................................................... 22Menú Ver...............................................................................................................................................23Menú Opciones.....................................................................................................................................23

Cuadro de diálogo Borrar subconjuntos con nombre............................................................................... 24Cuadro de diálogo Borrar vistas con nombre............................................................................................24Editor de dimensiones............................................................................................................................... 25

Menú Dimensión...................................................................................................................................25Menú Editar.......................................................................................................................................... 25Menú Ver...............................................................................................................................................28

Cuadro de diálogo Insertar elementos de dimensiones...........................................................................29Cuadro de diálogo Ordenar elementos de dimensiones.......................................................................... 29Cuadro de diálogo Propiedades de elementos de dimensiones.............................................................. 30Ver los detalles ..........................................................................................................................................31Cuadro de diálogo Editar fórmula..............................................................................................................31Cuadro de diálogo Editar referencia al cubo.............................................................................................32

iii

Cuadro de diálogo Filtrar elementos por atributo.................................................................................... 32Cuadro de diálogo Filtrar elementos por nivel..........................................................................................33Cuadro de diálogo Filtrar subconjunto......................................................................................................33Cuadro de diálogo Filtrar vista...................................................................................................................35Cuadro de diálogo Obtener vista (Navegador de hojas de cálculo)......................................................... 37Menú Navegador de hojas de cálculo........................................................................................................37Ventana Registro de mensajes.................................................................................................................. 38

Menú Archivo........................................................................................................................................38Menú Editar.......................................................................................................................................... 38Menú Ayuda..........................................................................................................................................39

Cuadro de diálogo Nuevo atributo.............................................................................................................39Cuadro de diálogo Abrir subconjunto........................................................................................................39Cuadro de diálogo Abrir vista.................................................................................................................... 39Asistente de informes de impresión......................................................................................................... 40

Todas las pantallas...............................................................................................................................40Pantalla 1 de 3......................................................................................................................................40Pantalla 2 de 3......................................................................................................................................41Pantalla 3 de 3......................................................................................................................................42

Cuadro de diálogo Opciones de proceso...................................................................................................44Cuadro de diálogo Replicar cubo...............................................................................................................44

Información del cubo........................................................................................................................... 45Información de reglas.......................................................................................................................... 45Información de dimensiones............................................................................................................... 45

Editor de reglas.......................................................................................................................................... 47Menú Archivo........................................................................................................................................47Menú Editar.......................................................................................................................................... 47Menú Ver...............................................................................................................................................48Menú Insertar....................................................................................................................................... 49Menú Herramientas..............................................................................................................................49

Cuadro de diálogo Guardar subconjunto.................................................................................................. 50Cuadro de diálogo Guardar vista............................................................................................................... 50Cuadro de diálogo Guardar vista (Navegador de hojas de cálculo)..........................................................50Cuadro de diálogo Asignaciones de seguridad......................................................................................... 51

Cuadrícula Asignaciones...................................................................................................................... 51Privilegios de acceso............................................................................................................................ 51Seleccionar dimensión......................................................................................................................... 55

Cuadro de diálogo Seleccionar cubo.........................................................................................................55Cuadro de diálogo Seleccionar cubo para reglas......................................................................................55Cuadro de diálogo Seleccionar dimensión................................................................................................55Cuadro de diálogo Seleccionar elemento................................................................................................. 55Server Explorer (ventana principal)...........................................................................................................56

Menú Archivo........................................................................................................................................56Menú dinámico..................................................................................................................................... 56Menú Editar.......................................................................................................................................... 67Menú Ver...............................................................................................................................................67

Editor de subconjuntos..............................................................................................................................68Menú Subconjunto............................................................................................................................... 69Menú Editar.......................................................................................................................................... 69Menú Ver...............................................................................................................................................71Menú Herramientas..............................................................................................................................72

Cuadro de diálogo Alias............................................................................................................................. 73Cuadro de diálogo Opciones de TM1........................................................................................................ 73

Parámetros de inicio de sesión............................................................................................................ 73Servidor local........................................................................................................................................73TLS (Transport Layer Security) del servidor de administración..........................................................74

Cuadro de diálogo Consulta del registro de transacciones...................................................................... 75Cuadro de diálogo Resultados de la consulta del registro de transacciones.......................................... 75Editor de TurboIntegrator..........................................................................................................................77

iv

Menú Archivo........................................................................................................................................77Menú Editar.......................................................................................................................................... 77Pestaña Origen de datos...................................................................................................................... 77Vista previa de cuadrícula.................................................................................................................... 91Pestaña Variables.................................................................................................................................91Pestaña Correlaciones......................................................................................................................... 93Pestaña Avanzado................................................................................................................................ 97Pestaña Planificación........................................................................................................................... 99

Ventana Extracción de vistas.................................................................................................................. 100Cuadro de diálogo Estilos de vista.......................................................................................................... 100

Capítulo 2. Funciones de reglas..........................................................................103Operadores aritméticos de reglas de TM1..............................................................................................103Operadores de comparación en reglas de TM1......................................................................................103Operadores lógicos en reglas de TM1.....................................................................................................103Funciones de reglas de atributos............................................................................................................ 104

ATTRN.................................................................................................................................................104ATTRS................................................................................................................................................. 105CubeATTRN........................................................................................................................................ 105CubeATTRS.........................................................................................................................................106DimensionATTRN............................................................................................................................... 106DimensionATTRS................................................................................................................................106ElementAttrN..................................................................................................................................... 107ElementAttrS......................................................................................................................................108

Función de reglas de cálculo de consolidación...................................................................................... 108ConsolidatedAvg................................................................................................................................ 108ConsolidateChildren...........................................................................................................................109ConsolidatedCount.............................................................................................................................111ConsolidatedCountUnique.................................................................................................................112ConsolidatedMax................................................................................................................................113ConsolidatedMin................................................................................................................................ 114

Funciones de reglas de datos de cubo....................................................................................................114CellValueN.......................................................................................................................................... 114CellValueS.......................................................................................................................................... 115DB....................................................................................................................................................... 116ISLEAF................................................................................................................................................ 117ISUNDEFINEDCELLVALUE................................................................................................................. 117UNDEF................................................................................................................................................ 118UNDEFINEDCELLVALUE.....................................................................................................................118UNDEFVALS........................................................................................................................................ 119

Funciones de reglas de fecha y hora.......................................................................................................120DATE................................................................................................................................................... 120DATES.................................................................................................................................................121DAY..................................................................................................................................................... 122DAYNO................................................................................................................................................122MONTH............................................................................................................................................... 122NOW....................................................................................................................................................123TIME................................................................................................................................................... 123TIMST................................................................................................................................................. 123TIMVL .................................................................................................................................................125TODAY................................................................................................................................................ 127YEAR................................................................................................................................................... 128

Funciones de reglas de información de dimensiones............................................................................ 128DIMIX................................................................................................................................................. 129DIMNM................................................................................................................................................129DIMSIZ ...............................................................................................................................................129DNEXT.................................................................................................................................................130

v

DNLEV.................................................................................................................................................130DTYPE ................................................................................................................................................ 131TABDIM.............................................................................................................................................. 131

Funciones de reglas de información de elementos................................................................................132ELCOMP ............................................................................................................................................. 132ELCOMPN........................................................................................................................................... 132ElementComponent .......................................................................................................................... 133ElementComponentCount................................................................................................................. 133ElementCount ....................................................................................................................................134ElementFirst....................................................................................................................................... 134ElementIndex.....................................................................................................................................135ElementIsAncestor............................................................................................................................ 135ElementIsComponent........................................................................................................................136ElementIsParent ............................................................................................................................... 136ElementLevel......................................................................................................................................137ElementName.....................................................................................................................................138ElementNext.......................................................................................................................................138ElementParent................................................................................................................................... 139ElementParentCount..........................................................................................................................139ElementType ..................................................................................................................................... 140ElementWeight .................................................................................................................................. 140ELISANC............................................................................................................................................. 141ELISCOMP ..........................................................................................................................................141ELISPAR .............................................................................................................................................142ELLEV..................................................................................................................................................142ELPAR................................................................................................................................................. 143ELPARN...............................................................................................................................................144ELWEIGHT ......................................................................................................................................... 144LevelCount..........................................................................................................................................145

Funciones de reglas financieras..............................................................................................................145FV........................................................................................................................................................145PAYMT ................................................................................................................................................146PV........................................................................................................................................................146

Funciones de reglas de jerarquías.......................................................................................................... 147Jerarquía............................................................................................................................................ 147HierarchyCount.................................................................................................................................. 147HierarchyIndex...................................................................................................................................148HierarchyN..........................................................................................................................................148

Funciones de reglas lógicas.................................................................................................................... 149CONTINUE..........................................................................................................................................149IF.........................................................................................................................................................149STET....................................................................................................................................................150

Funciones de reglas matemáticas.......................................................................................................... 150ABS..................................................................................................................................................... 150ACOS...................................................................................................................................................151ASIN....................................................................................................................................................151ATAN...................................................................................................................................................151COS..................................................................................................................................................... 152EXP..................................................................................................................................................... 152INT...................................................................................................................................................... 152ISUND................................................................................................................................................. 153LN........................................................................................................................................................153LOG..................................................................................................................................................... 153MAX.....................................................................................................................................................154MIN .................................................................................................................................................... 154MOD.................................................................................................................................................... 154RAND.................................................................................................................................................. 155ROUND................................................................................................................................................155

vi

ROUNDP............................................................................................................................................. 156SIGN................................................................................................................................................... 156SIN......................................................................................................................................................157SQRT...................................................................................................................................................157TAN..................................................................................................................................................... 157

Funciones de reglas de texto.................................................................................................................. 158CAPIT..................................................................................................................................................158CHAR...................................................................................................................................................158CODE...................................................................................................................................................158DELET................................................................................................................................................. 159FILL.....................................................................................................................................................159INSRT................................................................................................................................................. 160LONG...................................................................................................................................................160LOWER................................................................................................................................................160NUMBR .............................................................................................................................................. 161SCAN...................................................................................................................................................161STR......................................................................................................................................................162SUBST.................................................................................................................................................163TRIM................................................................................................................................................... 164UPPER.................................................................................................................................................164

Otras funciones de reglas........................................................................................................................164FEEDERS.............................................................................................................................................164FEEDSTRINGS.................................................................................................................................... 165SKIPCHECK........................................................................................................................................ 165

Capítulo 3. Funciones de macro......................................................................... 167Acceso a funciones de macros de Microsoft Excel 2010 y versiones posteriores................................ 167Acceso a las funciones de macros desde módulos VBA........................................................................ 167D_PICK.....................................................................................................................................................167D_FSAVE.................................................................................................................................................. 168D_SAVE.................................................................................................................................................... 169DBProportionalSpread.............................................................................................................................169E_PICK..................................................................................................................................................... 170I_EXPORT................................................................................................................................................ 171I_NAMES ................................................................................................................................................. 172I_PROCESS.............................................................................................................................................. 172M_CLEAR..................................................................................................................................................173N_CONNECT.............................................................................................................................................173N_DISCONNECT...................................................................................................................................... 173OPTGET....................................................................................................................................................174OPTSET.................................................................................................................................................... 175PublishSubset..........................................................................................................................................176PublishView............................................................................................................................................. 176QUDEFINE................................................................................................................................................176QUDEFINEEX........................................................................................................................................... 178QUEXPORT...............................................................................................................................................180QULOOP................................................................................................................................................... 181QUSUBSET............................................................................................................................................... 181R_SAVE.................................................................................................................................................... 182SUBDEFINE..............................................................................................................................................182SUBPICK.................................................................................................................................................. 183T_CLEAR...................................................................................................................................................184T_CREATE................................................................................................................................................ 184T_CREATE16............................................................................................................................................ 185T_PICK..................................................................................................................................................... 186T_SAVE.....................................................................................................................................................186TM1RECALC............................................................................................................................................. 186

vii

TM1RECALC1...........................................................................................................................................186VUSLICE................................................................................................................................................... 187W_DBSENABLE........................................................................................................................................187

Capítulo 4. Funciones de hoja de trabajo............................................................ 189DBR.......................................................................................................................................................... 189DBRA........................................................................................................................................................ 190DBRW....................................................................................................................................................... 191DBS...........................................................................................................................................................191DBSA........................................................................................................................................................ 192DBSS........................................................................................................................................................ 193DBSW....................................................................................................................................................... 193DFRST.......................................................................................................................................................194DIMIX....................................................................................................................................................... 195DIMNM..................................................................................................................................................... 195DIMSIZ..................................................................................................................................................... 196DNEXT...................................................................................................................................................... 196DNLEV...................................................................................................................................................... 197DTYPE.......................................................................................................................................................197ELCOMP....................................................................................................................................................198ELCOMPN................................................................................................................................................. 198ELISCOMP................................................................................................................................................ 199ELISPAR................................................................................................................................................... 200ELLEV....................................................................................................................................................... 200ELPAR.......................................................................................................................................................201ELPARN.................................................................................................................................................... 201ELSLEN.....................................................................................................................................................202ELWEIGHT............................................................................................................................................... 202SUBNM..................................................................................................................................................... 203SUBSIZ.....................................................................................................................................................204TABDIM....................................................................................................................................................205TM1ELLIST...............................................................................................................................................205TM1GLOBALSANDBOX............................................................................................................................208TM1INFO..................................................................................................................................................208TM1PRIMARYDBNAME........................................................................................................................... 209TM1RptElIsConsolidated........................................................................................................................ 209TM1RptElIsExpanded..............................................................................................................................210TM1RptElLev............................................................................................................................................210TM1RptFilter............................................................................................................................................210TM1RptRow............................................................................................................................................. 211TM1RptTitle............................................................................................................................................. 213TM1RptView.............................................................................................................................................214TM1User...................................................................................................................................................214VIEW.........................................................................................................................................................215

Capítulo 5. funciones de TurboIntegrator........................................................... 217Palabras reservadas de TurboIntegrator................................................................................................217Funciones de TurboIntegrator de texto y ASCII.....................................................................................217

ASCIIDelete........................................................................................................................................218ASCIIOutput.......................................................................................................................................218NumberToString.................................................................................................................................219NumberToStringEx.............................................................................................................................220SetInputCharacterSet........................................................................................................................ 220SetOutputCharacterSet......................................................................................................................223SetOutputEscapeDoubleQuote......................................................................................................... 223StringToNumber.................................................................................................................................224StringToNumberEx.............................................................................................................................224

viii

TextOutput......................................................................................................................................... 225Funciones de TurboIntegrator de manipulación de atributos............................................................... 226

ATTRNL...............................................................................................................................................226ATTRSL............................................................................................................................................... 227AttrDelete........................................................................................................................................... 228AttrInsert............................................................................................................................................229AttrPutN..............................................................................................................................................229AttrPutS.............................................................................................................................................. 230ChoreAttrDelete................................................................................................................................. 231ChoreAttrInsert.................................................................................................................................. 231ChoreAttrN......................................................................................................................................... 232ChoreAttrNL........................................................................................................................................232ChoreAttrPutN....................................................................................................................................233ChoreAttrPutS.................................................................................................................................... 234ChoreAttrS..........................................................................................................................................235ChoreAttrSL........................................................................................................................................ 235CreateHierarchyByAttribute.............................................................................................................. 236CubeAttrDelete.................................................................................................................................. 237CubeAttrInsert................................................................................................................................... 237CubeAttrPutN..................................................................................................................................... 238CubeAttrPutS......................................................................................................................................239CubeATTRNL...................................................................................................................................... 240CubeATTRSL.......................................................................................................................................241DimensionAttrDelete......................................................................................................................... 242DimensionAttrInsert.......................................................................................................................... 242DimensionAttrPutN............................................................................................................................ 243DimensionAttrPutS.............................................................................................................................244DimensionATTRNL............................................................................................................................. 244DimensionATTRSL..............................................................................................................................245ElementATTRNL................................................................................................................................. 246ElementATTRSL................................................................................................................................. 247ElementAttrPutN................................................................................................................................248ElementAttrPutS................................................................................................................................ 249ElementAttrInsert.............................................................................................................................. 250ElementAttrDelete............................................................................................................................. 251HierarchyAttrPutN..............................................................................................................................251HierarchyAttrPutS.............................................................................................................................. 252HierarchyATTRN.................................................................................................................................253HierarchyATTRS................................................................................................................................. 253HierarchyATTRNL...............................................................................................................................254HierarchyATTRSL............................................................................................................................... 255HierarchySubsetATTRS......................................................................................................................256HierarchySubsetATTRN..................................................................................................................... 256HierarchySubsetATTRSL....................................................................................................................257HierarchySubsetATTRNL................................................................................................................... 258HierarchySubsetAttrPutS...................................................................................................................259HierarchySubsetAttrPutN.................................................................................................................. 260HierarchySubsetAttrInsert................................................................................................................ 261HierarchySubsetAttrDelete................................................................................................................262ProcessAttrDelete.............................................................................................................................. 262ProcessAttrInsert...............................................................................................................................263ProcessAttrN...................................................................................................................................... 263ProcessAttrNL.................................................................................................................................... 264ProcessAttrPutN.................................................................................................................................265ProcessAttrPutS................................................................................................................................. 266ProcessAttrS.......................................................................................................................................267ProcessAttrSL.....................................................................................................................................267SubsetATTRS......................................................................................................................................268

ix

SubsetATTRN..................................................................................................................................... 269SubsetATTRSL....................................................................................................................................269SubsetATTRNL................................................................................................................................... 270SubsetAttrPutS...................................................................................................................................271SubsetAttrPutN.................................................................................................................................. 272SubsetAttrInsert................................................................................................................................ 273SubsetAttrDelete................................................................................................................................274ViewAttrDelete................................................................................................................................... 274ViewAttrInsert....................................................................................................................................275ViewAttrN........................................................................................................................................... 275ViewAttrNL......................................................................................................................................... 276ViewAttrPutN......................................................................................................................................277ViewAttrPutS...................................................................................................................................... 278ViewAttrS............................................................................................................................................279ViewAttrSL..........................................................................................................................................279

Funciones de TurboIntegrator de gestión de tareas.............................................................................. 280ChoreError.......................................................................................................................................... 280ChoreQuit........................................................................................................................................... 281ChoreRollback.................................................................................................................................... 281SetChoreVerboseMessages............................................................................................................... 281

Funciones de TurboIntegrator de manipulación de cubos.................................................................... 282AddCubeDependency........................................................................................................................ 282CellGetN............................................................................................................................................. 282CellGetS..............................................................................................................................................284CellIncrementN..................................................................................................................................284CellIsUpdateable............................................................................................................................... 285CellPutN..............................................................................................................................................286CellPutProportionalSpread................................................................................................................ 286CellPutS.............................................................................................................................................. 287CubeClearData................................................................................................................................... 288CubeCreate.........................................................................................................................................288CubeDestroy.......................................................................................................................................289CubeDimensionCountGet.................................................................................................................. 289CubeExists..........................................................................................................................................289CubeGetLogChanges..........................................................................................................................290CubeSaveData.................................................................................................................................... 290CubeSetConnParams......................................................................................................................... 291CubeSetLogChanges.......................................................................................................................... 292CubeTimeLastUpdated...................................................................................................................... 292CubeUnload........................................................................................................................................293

Funciones de TurboIntegrator de reserva de datos............................................................................... 293CubeDataReservationAcquire............................................................................................................293CubeDataReservationRelease........................................................................................................... 294CubeDataReservationReleaseAll.......................................................................................................295CubeDataReservationGet.................................................................................................................. 296CubeDataReservationGetConflicts.................................................................................................... 297CubeDRAcquire.................................................................................................................................. 298CubeDRRelease..................................................................................................................................299CubeDRReleaseAll............................................................................................................................. 300CubeDRGet.........................................................................................................................................301CubeDRGetConflicts.......................................................................................................................... 302

Funciones de TurboIntegrator de fecha y hora...................................................................................... 303FormatDate.........................................................................................................................................303NewDateFormatter............................................................................................................................ 304ParseDate........................................................................................................................................... 305

Funciones de TurboIntegrator de manipulación de dimensiones......................................................... 306DimensionCreate................................................................................................................................306DimensionDeleteAllElements............................................................................................................306

x

DimensionDeleteElements................................................................................................................ 306DimensionDestroy..............................................................................................................................307DimensionElementComponentAdd................................................................................................... 307DimensionElementComponentAddDirect......................................................................................... 308DimensionElementComponentDelete...............................................................................................309DimensionElementComponentDeleteDirect.....................................................................................309DimensionElementDelete.................................................................................................................. 310DimensionElementDeleteDirect........................................................................................................ 310DimensionElementExists................................................................................................................... 311DimensionElementInsert...................................................................................................................312DimensionElementInsertDirect.........................................................................................................312DimensionElementPrincipalName.....................................................................................................313DimensionExists.................................................................................................................................314DimensionHierarchyCreate................................................................................................................314DimensionSortOrder.......................................................................................................................... 315DimensionTimeLastUpdated............................................................................................................. 316DimensionTopElementInsert............................................................................................................ 317DimensionTopElementInsertDirect...................................................................................................317DimensionUpdateDirect.....................................................................................................................318

Funciones de TurboIntegrator de manipulación de jerarquías..............................................................319HierarchyContainsAllLeaves..............................................................................................................319HierarchyCreate................................................................................................................................. 319HierarchyDeleteAllElements............................................................................................................. 320HierarchyDeleteElements..................................................................................................................320HierarchyDestroy............................................................................................................................... 321HierarchyElementComponentAdd.....................................................................................................321HierarchyElementComponentAddDirect...........................................................................................321HierarchyElementComponentDelete................................................................................................ 322HierarchyElementComponentDeleteDirect...................................................................................... 323HierarchyElementDelete....................................................................................................................324HierarchyElementDeleteDirect..........................................................................................................324HierarchyElementExists.....................................................................................................................325HierarchyElementInsert.................................................................................................................... 326HierarchyElementInsertDirect.......................................................................................................... 326HierarchyElementPrincipalName...................................................................................................... 328HierarchyExists.................................................................................................................................. 328HierarchyHasOrphanedLeaves.......................................................................................................... 329HierarchySortOrder............................................................................................................................329HierarchyTimeLastUpdated...............................................................................................................331HierarchyTopElementInsert.............................................................................................................. 331HierarchyTopElementInsertDirect.................................................................................................... 332HierarchyUpdateDirect...................................................................................................................... 333

Funciones de TurboIntegrator de ODBC.................................................................................................333ODBCClose......................................................................................................................................... 333ODBCOpen..........................................................................................................................................334ODBCOPENEx.....................................................................................................................................334ODBCOutput.......................................................................................................................................335SetODBCUnicodeInterface................................................................................................................ 335

Funciones de TurboIntegrator de control de procesos..........................................................................336ExecuteCommand.............................................................................................................................. 336ExecuteProcess..................................................................................................................................336GetProcessErrorFileDirectory............................................................................................................338GetProcessErrorFilename..................................................................................................................338GetProcessName............................................................................................................................... 339If......................................................................................................................................................... 339ItemReject..........................................................................................................................................340ItemSkip............................................................................................................................................. 340ProcessBreak..................................................................................................................................... 340

xi

ProcessError.......................................................................................................................................341ProcessExists..................................................................................................................................... 341ProcessQuit........................................................................................................................................ 341ProcessRollback.................................................................................................................................341RunProcess.........................................................................................................................................342Synchronized......................................................................................................................................343While...................................................................................................................................................344

Funciones de TurboIntegrator de gestión de reglas.............................................................................. 345CubeProcessFeeders......................................................................................................................... 345CubeRuleAppend............................................................................................................................... 345CubeRuleDestroy............................................................................................................................... 346DeleteAllPersistentFeeders............................................................................................................... 347ForceSkipCheck..................................................................................................................................347RuleLoadFromFile.............................................................................................................................. 347

Funciones de recintos de pruebas.......................................................................................................... 348GetUseActiveSandboxProperty......................................................................................................... 348ServerActiveSandboxGet................................................................................................................... 349ServerActiveSandboxSet................................................................................................................... 349ServerSandboxClone..........................................................................................................................350ServerSandboxCreate........................................................................................................................ 350ServerSandboxesDelete.....................................................................................................................351ServerSandboxDiscardAllChanges.................................................................................................... 354ServerSandboxMerge.........................................................................................................................355ServerSandboxExists......................................................................................................................... 356ServerSandboxGet............................................................................................................................. 357ServerSandboxListCountGet..............................................................................................................357SetUseActiveSandboxProperty..........................................................................................................358

Funciones de TurboIntegrator de seguridad.......................................................................................... 359AddClient............................................................................................................................................359AddGroup........................................................................................................................................... 359AssignClientToGroup......................................................................................................................... 360AssignClientPassword........................................................................................................................360AssociateCAMIDToGroup.................................................................................................................. 361CellSecurityCubeCreate.....................................................................................................................361CellSecurityCubeDestroy................................................................................................................... 362DeleteClient........................................................................................................................................362DeleteGroup....................................................................................................................................... 363ElementSecurityGet........................................................................................................................... 363ElementSecurityPut........................................................................................................................... 364HierarchyElementSecurityGet........................................................................................................... 365HierarchyElementSecurityPut........................................................................................................... 365RemoveCAMIDAssociation................................................................................................................ 366RemoveCAMIDAssociationFromGroup............................................................................................. 366RemoveClientFromGroup.................................................................................................................. 367SetHierarchyGroupsSecurity............................................................................................................. 367SetHierarchyElementGroupsSecurity............................................................................................... 368SetDimensionGroupsSecurity............................................................................................................368SetElementGroupsSecurity............................................................................................................... 369SecurityOverlayGlobalLockCell......................................................................................................... 370SecurityOverlayCreateGlobalDefault................................................................................................ 370SecurityOverlayDestroyGlobalDefault...............................................................................................371SecurityOverlayGlobalLockNode.......................................................................................................372SecurityRefresh..................................................................................................................................372

Funciones de TurboIntegrator de manipulación de servidores............................................................. 373BatchUpdateFinish.............................................................................................................................373BatchUpdateFinishWait..................................................................................................................... 374BatchUpdateStart.............................................................................................................................. 375DisableBulkLoadMode....................................................................................................................... 375

xii

EnableBulkLoadMode........................................................................................................................ 375RefreshMdxHierarchy........................................................................................................................ 375SaveDataAll........................................................................................................................................ 376ServerShutdown.................................................................................................................................377

Funciones de TurboIntegrator de manipulación de subconjuntos........................................................ 378HierarchySubsetAliasSet................................................................................................................... 378HierarchySubsetCreate......................................................................................................................378HierarchySubsetDeleteAllElements.................................................................................................. 379HierarchySubsetDestroy....................................................................................................................380HierarchySubsetElementExists......................................................................................................... 380HierarchySubsetElementDelete........................................................................................................ 381HierarchySubsetElementGetIndex................................................................................................... 381HierarchySubsetElementInsert.........................................................................................................382HierarchySubsetExists.......................................................................................................................383HierarchySubsetGetSize.................................................................................................................... 383HierarchySubsetGetElementName................................................................................................... 383HierarchySubsetIsAllSet....................................................................................................................384HierarchySubsetMDXGet................................................................................................................... 385HierarchySubsetMDXSet....................................................................................................................385SubsetAliasSet................................................................................................................................... 386SubsetCreate......................................................................................................................................386SubsetCreateByMDX..........................................................................................................................387SubsetDeleteAllElements..................................................................................................................389SubsetDestroy....................................................................................................................................389SubsetElementDelete........................................................................................................................ 389SubsetElementExists......................................................................................................................... 390SubsetElementGetIndex................................................................................................................... 390SubsetElementInsert.........................................................................................................................391SubsetExists.......................................................................................................................................391SubsetExpandAboveSet.....................................................................................................................392SubsetFormatStyleSet....................................................................................................................... 393SubsetGetElementName................................................................................................................... 393SubsetGetSize.................................................................................................................................... 394SubsetIsAllSet....................................................................................................................................394SubsetMDXGet................................................................................................................................... 394SubsetMDXSet....................................................................................................................................395

Funciones de TurboIntegrator de manipulación de vistas.....................................................................395PublishView........................................................................................................................................396DisableMTQViewConstruct................................................................................................................ 396EnableMTQViewConstruct................................................................................................................. 397ViewColumnDimensionSet................................................................................................................ 398ViewColumnSuppressZeroesSet....................................................................................................... 398ViewConstruct.................................................................................................................................... 399ViewCreate......................................................................................................................................... 399ViewCreateByMDX............................................................................................................................. 400ViewDestroy....................................................................................................................................... 402ViewExists.......................................................................................................................................... 402ViewExtractFilterByTitlesSet.............................................................................................................402ViewExtractSkipCalcsSet...................................................................................................................403ViewExtractSkipConsolidatedStringsSet...........................................................................................404ViewExtractSkipRuleValuesSet......................................................................................................... 405ViewExtractSkipZeroesSet................................................................................................................ 406ViewMDXSet....................................................................................................................................... 406ViewMDXGet.......................................................................................................................................407ViewRowDimensionSet......................................................................................................................407ViewRowSuppressZeroesSet.............................................................................................................408ViewSubsetAssign..............................................................................................................................409ViewSuppressZeroesSet....................................................................................................................409

xiii

ViewTitleDimensionSet......................................................................................................................410ViewTitleElementSet..........................................................................................................................410ViewZeroOut.......................................................................................................................................411

Otras funciones de TurboIntegrator....................................................................................................... 411AddInfoCubeRestriction.................................................................................................................... 411ExecuteJavaN.....................................................................................................................................413ExecuteJavaS..................................................................................................................................... 413Expand................................................................................................................................................414FileExists............................................................................................................................................ 415LogOutput...........................................................................................................................................415TM1User............................................................................................................................................. 416WildcardFileSearch............................................................................................................................ 416

Capítulo 6. Variables de TurboIntegrator............................................................419Variables locales de TurboIntegrator..................................................................................................... 419

DatasourceASCIIDecimalSeparator..................................................................................................419DatasourceASCIIDelimiter................................................................................................................ 419DatasourceASCIIHeaderRecords......................................................................................................420DatasourceASCIIQuoteCharacter..................................................................................................... 420DatasourceASCIIThousandSeparator............................................................................................... 421DatasourceCubeview......................................................................................................................... 421DatasourceDimensionSubset............................................................................................................ 421DatasourceNameForServer............................................................................................................... 422DatasourceNameForClient.................................................................................................................422DataSourceODBOCatalog.................................................................................................................. 422DataSourceODBOConnectionString.................................................................................................. 423DataSourceODBOCubeName.............................................................................................................423DataSourceODBOHierarchyName..................................................................................................... 423DataSourceODBOLocation.................................................................................................................423DataSourceODBOProvider................................................................................................................. 424DataSourceODBOSAPClientID...........................................................................................................424DataSourceODBOSAPClientLanguage...............................................................................................424DatasourcePassword......................................................................................................................... 425DatasourceQuery............................................................................................................................... 425DataSourceSAPUsingRoleAuths........................................................................................................ 425DataSourceSAPUsingTexts................................................................................................................426DatasourceType................................................................................................................................. 426DatasourceUsername........................................................................................................................ 426MinorErrorLogMax..............................................................................................................................427NValue................................................................................................................................................ 427OnMinorErrorDoItemSkip.................................................................................................................. 427SValue.................................................................................................................................................428Archivo TM1ProcessError.log............................................................................................................ 428Value_Is_String..................................................................................................................................429

Variables globales de TurboIntegrator................................................................................................... 429NumericGlobalVariable("VariableName");........................................................................................ 430StringGlobalVariable("VariableName");............................................................................................ 430

Variables globales implícitas...................................................................................................................430DataMinorErrorCount......................................................................................................................... 430MetadataMinorErrorCount................................................................................................................. 430ProcessReturnCode........................................................................................................................... 431PrologMinorErrorCount...................................................................................................................... 431

Variables de usuario de TurboIntegrator................................................................................................432

Avisos............................................................................................................... 433

Índice............................................................................................................... 437

xiv

Introducción

Este documento se ha concebido para su uso con IBM® Planning Analytics.

Este documento es una recopilación de material de referencia para funciones, variables y otroselementos de programación del software de IBM Planning Analytics.

Planning Analytics proporciona soluciones de software para la gestión y la supervisión continuadas de laadministración del rendimiento financiero y operativo de toda la empresa.

Declaración de limitación de responsabilidad de los ejemplos

La compañía Ejemplo Viaje de Aventuras, la compañía Viaje de aventuras, Ventas de VA, las variacionesdel nombre Viaje de Aventuras y Ejemplo Viaje de Aventuras y Ejemplo de planificación representanoperaciones empresariales ficticias con datos de ejemplo utilizados para desarrollar aplicaciones deejemplo para IBM y clientes de IBM. Estos registros ficticios incluyen datos de muestra paratransacciones comerciales, distribución de productos, finanzas y recursos humanos. Cualquier parecidocon nombres, direcciones, números de contacto o valores de transacción reales es una meracoincidencia. Otros archivos de ejemplo pueden contener datos ficticios generados manual oinformáticamente, datos relativos a hechos procedentes de orígenes públicos o académicos, o datosutilizados con el permiso del poseedor del copyright, para utilizarlos como datos de ejemplo paradesarrollar las aplicaciones de ejemplo. Los nombres de producto a los que se hace referencia puedenser marcas registradas de sus respectivos propietarios. Queda prohibida la duplicación no autorizada.

Características de accesibilidad

Las características de accesibilidad ayudan a los usuarios que tienen alguna discapacidad física, porejemplo movilidad restringida o visión limitada, a utilizar productos de tecnología de la información.

Este producto no soporta actualmente características de accesibilidad que ayuden a los usuarios condiscapacidad física, como movilidad o visión limitada, a utilizar este producto.

Proyecciones futuras

En esta documentación se describe la funcionalidad actual del producto. Puede que se incluyanreferencias a elementos que actualmente no están disponibles. Sin embargo, no deberá deducirse sufutura disponibilidad real. Estas referencias no constituyen un compromiso, promesa ni obligación legalque implique la entrega de ningún tipo de material, código o funcionalidad. El desarrollo, la entrega y lacomercialización de las características o la funcionalidad son aspectos que quedan a la entera discreciónde IBM.

Consideraciones de seguridad

Para obtener las condiciones de seguridad para IBM Planning Analytics, consulte la publicaciónInstalación y configuración de Planning Analytics. Puede encontrar la información acerca de cómogestionar la autenticación de usuarios y grupos en el capítulo Gestión de usuarios y grupos de ladocumentación TM1 Operations.

© Copyright IBM Corp. 2007, 2019 xv

xvi IBM Planning Analytics: Referencia de TM1

Capítulo 1. Cuadros de diálogo y ventanasEsta sección describe todas las ventanas y todos los cuadros de diálogo importantes de IBM PlanningAnalytics.

Cuadro de diálogo Propiedades del botón de acciónUtilice el cuadro de diálogo Propiedades del botón de acción para añadir botones de acción TM1 a unahoja de trabajo. Puede configurar el botón para ejecutar un proceso y/o desplazarse a otra hoja detrabajo.

Para obtener ejemplos y conocer los pasos sobre cómo utilizar los botones de acción en las hojas detrabajo, consulte TM1 para desarrolladores en el Knowledge Center de IBM (https://www.ibm.com/support/knowledgecenter/SSD29G_2.0.0).

Servidor

Esta lista incluye los nombres de todos los servidores TM1 que están disponibles actualmente en lared.

Seleccione el servidor en el que está ubicada la hoja de trabajo de procesos o de destino del botón deacción.

Conectar

Este botón está disponible sólo cuando no está conectado al servidor que está actualmenteseleccionado en el cuadro de lista de servidores.

Pulse este botón para conectarse al servidor que seleccionó en el cuadro de lista de servidores.

Desconectar

Este botón está disponible sólo cuando está conectado al servidor que está actualmenteseleccionado en el cuadro de lista de servidores.

Pulse este botón para desconectarse del servidor que seleccionó en el cuadro Servidor.

Acción

Seleccione la acción que desea que realice el botón de acción al pulsar el mismo.

• Ejecutar un proceso TurboIntegrator

Seleccione esta opción para configurar un botón de acción que ejecute un proceso. Al seleccionaresta opción, se activará la pestaña Proceso.

• Ir a otra hoja de trabajo

Seleccione esta opción para configurar un botón de acción que se desplace a otra hoja de trabajo. Alseleccionar esta opción, se activará la pestaña Hoja de trabajo.

• Ejecutar un proceso y, a continuación, ir a una hoja de trabajo

Seleccione esta opción para configurar un botón de acción que ejecute un proceso y después sedesplace a otra hoja de trabajo. Al seleccionar esta opción, se activarán las pestañas Proceso y Hojade trabajo.

• Solo calcular/volver a crear

Seleccione esta opción para realizar una operación de recálculo o de volver a crear sin ejecutar unproceso de TI o desplazarse a una nueva hoja de trabajo. Esto puede resultar útil si desea actualizarsolamente la hoja actual o recargar la versión original de un formulario activo.

También puede utilizar la pestaña Calcular para seleccionar la operación de cálculo que desea queTM1 realice antes de ejecutar un proceso de TI o desplazarse a otra hoja de trabajo.

© Copyright IBM Corp. 2007, 2019 1

Aceptar

Cierra el cuadro de diálogo Propiedades del botón de acción e inserta un botón de acción en la hoja detrabajo.

Cancelar

Cierra el cuadro de diálogo Propiedades del botón de acción sin insertar ningún botón de acción.

Pestaña ProcesoUtilice la pestaña Proceso para configurar un botón de acción para ejecutar un proceso.Proceso

Utilice esta lista para seleccionar el proceso que desee ejecutar de una de las siguientes formas:

• Para ejecutar un proceso que esté disponible en el servidor actual, seleccione el nombre de procesode la lista.

• Para recuperar el nombre de proceso y los valores de parámetros de la hoja de trabajo actual,seleccione Obtener información del proceso de la hoja de trabajo.

Opciones

Abre el cuadro de diálogo Opciones de proceso, en el que puede controlar el comportamiento delbotón de acción antes y después de la ejecución del proceso.

Para obtener más información, consulte la sección “Cuadro de diálogo Opciones de proceso” en lapágina 44.

Nombre de proceso

Esta opción aparecerá sólo cuando seleccione la opción Obtener información del proceso de la hojade trabajo en la lista Proceso.

Introduzca una referencia de Excel que incluya el nombre del proceso que se va a ejecutar de una delas siguientes formas.

• Para hacer referencia a una única celda, utilice el siguiente formato: =ColumnNameRowName. Porejemplo: =A1.

• Para hacer referencia a un rango con nombre en Excel, utilice el siguiente formato: =NameOfRange• Para seleccionar la celda en la hoja de trabajo actual, pulse el botón Referencia de Excel que

aparece junto al cuadro Nombre de proceso.

Parámetros

Introduzca los valores de los parámetros del proceso, según la forma en que haya seleccionado elnombre de proceso en la lista Proceso.

• Si ha seleccionado un proceso en la lista Proceso, la cuadrícula Parámetros aparecerá con una listade los parámetros del proceso seleccionado. Puede introducir valores de cada parámetrodirectamente en la cuadrícula o utilizar una referencia de Excel que recupere de forma dinámica unvalor del parámetro de la hoja de trabajo actual.

• Si ha seleccionado la opción Obtener información del proceso de la hoja de trabajo en la listaProceso, debe utilizar una referencia de Excel para recuperar los valores de los parámetros de lahoja de trabajo actual. Puede introducir una referencia en una única celda, un rango de celdas o unrango con nombre. Las referencias deben indicar el número de celdas adecuado, según el númerode parámetros que espere el proceso.

Pulse el botón Referencia de Excel para seleccionar directamente la celda o el rango de celdasde la hoja de trabajo.

Para obtener ejemplos, consulte la documentación de TM1 para desarrolladores.

2 IBM Planning Analytics: Referencia de TM1

Referencia de Excel

Crea una referencia de Excel que recupera de forma dinámica el nombre de proceso o los valores delos parámetros de la hoja de trabajo actual al pulsar el botón Acción.

Pestaña Hoja de trabajoUtilice la pestaña Hoja de trabajo para configurar un botón de acción y desplazarse a otra hoja de trabajode Excel.Buscar en

Utilice uno de los siguientes métodos para seleccionar una hoja de trabajo:

• TM1 Applications - Seleccione esta opción si desea seleccionar una hoja de trabajo en el árbol deTM1 Applications.

• Archivos: seleccione esta opción si desea elegir una hoja de trabajo del sistema.

Examinar

Pulse este botón para seleccionar la hoja de trabajo a la que desea desplazarse.

• Si ha seleccionado la opción TM1, se abre un cuadro de diálogo donde puede seleccionar una hojade trabajo del árbol de TM1 Applications.

• Si ha seleccionado la opción Archivos, aparecerá el cuadro de diálogo Abrir, en el que podráexaminar y seleccionar un archivo del sistema.

Libro de trabajo

Contiene la ruta y el nombre del libro de trabajo de Excel al que desea desplazarse. Puede introducireste valor de una de las siguientes formas:

• Pulse el botón Examinar que aparece junto a la opción Buscar en para seleccionar un libro detrabajo en el árbol TM1 Applications o en los archivos del sistema.

• Pulse el botón Referencia de Excel para seleccionar una celda que evalúe la ruta y el nombre de unlibro de trabajo.

• Introduzca manualmente la ruta y el nombre de un libro de trabajo.• Introduzca manualmente una referencia de Excel que evalúe el nombre y la ruta de un libro de

trabajo.

La ruta de un libro de trabajo del árbol TM1 Applications utiliza el formato:

<NombreCarpeta>\<NombreCarpeta>\<NombreLibroTrabajo

Por ejemplo:

Planning Sample\Bottom Up Input\Budget Input

La ruta de un archivo de red utiliza el formato:

\\<NombreSistema>\<NombreCarpeta>\<NombreLibroTrabajo>

Por ejemplo:

\\boston\reports\2007_summary.xls

Para obtener información detallada y ejemplos, consulte la documentación de IBM Cognos TM1 paradesarrolladores.

Hoja

Contiene el nombre de la hoja de trabajo a la que desea desplazarse. Puede introducir este valor deuna de las siguientes formas:

• Pulse el botón Examinar para seleccionar un libro de trabajo y, a continuación, seleccione una hojade trabajo en la lista Hoja.

• Introduzca manualmente el nombre de una hoja de trabajo.

Capítulo 1. Cuadros de diálogo y ventanas 3

• Introduzca manualmente una referencia de Excel que evalúe el nombre de una hoja de trabajo.• Pulse el botón Referencia de Excel para seleccionar una celda que evalúe el nombre de una hoja de

trabajo.

Para obtener información detallada y ejemplos, consulte la documentación de IBM Cognos TM1 paradesarrolladores.

Hacer coincidir elementos de título

Esta opción hace coincidir y establece automáticamente dimensiones de título entre hojas de trabajode origen y destino cuando un usuario pulsa el botón Acción para desplazarse hasta la hoja de trabajode destino.

Para obtener información detallada y ejemplos, consulte la documentación de IBM Cognos TM1 paradesarrolladores.

Sustituir libro de trabajo actual

Esta opción determina la forma de abrir la hoja de trabajo de destino.

• Si no se selecciona esta opción (valor predeterminado), la hoja de trabajo de destino se abre en unanueva ventana en Excel o en una nueva pestaña de TM1 Web.

• Si selecciona esta opción, la hoja de trabajo de destino se abrirá en la misma ventana o pestaña,sustituyendo a la hoja de trabajo de origen.

PRECAUCIÓN: Si activa esta opción, no olvide guardar el libro de trabajo antes de probar elnuevo botón. Podría perder los cambios si pulsa el botón y cierra el libro de trabajo actual.

Opciones avanzadas

Pulse este botón para abrir el cuadro de diálogo Opciones avanzadas, en el que podrá correlacionarmanualmente campos entre las hojas de trabajo de origen y destino con un botón de acción que sedesplaza de una hoja de trabajo a otra.

Para obtener más detalles, consulte: “Cuadro de diálogo Opciones avanzadas” en la página 5.

Pestaña AparienciaUtilice la pestaña Apariencia para configurar la apariencia visual del botón de acción.Título

Establece el texto del título que aparece en el botón de acción.Fuente

Pulse este botón para mostrar el cuadro de diálogo Fuente, en el que podrá establecer el tamaño y elestilo de fuente del texto del botón.

Mostrar imagen de fondo

Le permite seleccionar un archivo de imagen (formato bmp, gif o jpg) que se estirará para ajustarse albotón de acción.

Seleccione esta opción y, a continuación, pulse Examinar para ubicar y seleccionar el archivo deimagen que desee utilizar.

Mostrar como hiperenlace

Muestra el botón de acción como hiperenlace con texto azul subrayado en lugar de como un botónestándar.

Esta opción no está disponible al seleccionar la opción Mostrar imagen de fondo.

Vista previaEsta área muestra una vista previa del título del texto, el estilo de fuente, el color de fuente y el colorde fondo del botón.

Colores

Le permite establecer los colores de texto y fondo del botón de acción.

4 IBM Planning Analytics: Referencia de TM1

Pulse la muestra de colores de texto o fondo para mostrar el cuadro de diálogo Color, en el que puedeseleccionar un color estándar o definir un color personalizado.

Esta opción no está disponible al seleccionar la opción Mostrar como hiperenlace.

Cuadro de diálogo Opciones avanzadasUtilice el cuadro de diálogo Opciones avanzadas para correlacionar manualmente campos entre las hojasde trabajo de origen y destino al insertar un botón de acción que se desplace de una hoja de trabajo aotra. Esta herramienta le ayuda a correlacionar dimensiones, celdas y valores de la hoja de trabajo deorigen con la hoja de trabajo de destino.

Nota: La opción de correlación avanzada se aplica después de haberse realizado cualquier correlaciónautomática mediante la opción Hacer coincidir elementos de título.

Campo Descripción

Añadir Añade una nueva fila a la cuadrícula Correlaciónavanzada.

Borrar Borra la fila seleccionada de la cuadrículaCorrelación avanzada.

Aceptar Cierra el cuadro de diálogo Opciones avanzadas yguarda los valores.

Cancelar Cierra el cuadro de diálogo Opciones avanzadas singuardar los valores.

Para obtener ejemplos acerca de cómo utilizar el cuadro de diálogo Opciones avanzadas, consulte sTM1para desarrolladores en el Knowledge Center de IBM (https://www.ibm.com/support/knowledgecenter/SSD29G_2.0.0).

Cuadrícula Correlación avanzadaUtilice la cuadrícula Correlación avanzada para definir la correlación de los campos entre las hojas detrabajo de origen y destino. Puede utilizar la cuadrícula para especificar cómo los elementos de las hojasde trabajo de origen y destino coinciden cuando se abre la hoja de destino. Cada fila de la cuadrículadefine una configuración de correlación.

Campo Descripción

Tipo de origen Este campo representa el tipo de objeto del valorque desea correlacionar.

Seleccione el Tipo de origen de la siguientemanera:

• SUBNM: indica que está correlacionando a partirde una celda que contiene una dimensión detítulo en la hoja de trabajo de origen.

• DBRW seleccionado: indica que estácorrelacionando a partir de una celda quecontiene una fórmula DBRW en la hoja de trabajode origen.

• Valor: indica que introducirá un valor numérico ouna cadena que se enviará al destino.

Capítulo 1. Cuadros de diálogo y ventanas 5

Campo Descripción

Objeto de origen Este campo toma un valor según lo seleccionadoen el campo Tipo de origen.

Introduzca el Objeto de origen de la siguientemanera:

• Si la opción Tipo de origen está establecida enSUBNM, deberá especificar el nombre de ladimensión de título que exista en la hoja detrabajo de origen.

• Si la opción Tipo de origen está establecida en laDBRW seleccionada, deberá especificar elnombre de una dimensión de título de columna ofila que exista en la hoja de trabajo de origen.

• Si la opción Tipo de origen está establecida enValor, deberá introducir una cadena o un valornumérico que se enviará a la hoja de trabajo dedestino.

También puede recuperar estos valores de la hojade trabajo de origen utilizando el símbolo = paracrear una referencia de Excel.

Tipo de destino Este campo es el tipo de celda de la hoja de trabajode destino en la que se insertará el valor del campoObjeto de origen.

Seleccione el Tipo de destino de la siguientemanera:

• SUBNM: indica que el destino es una dimensiónde título de la hoja de trabajo de destino.

• Rango con nombre: indica que el destino es unrango con nombre de la hoja de trabajo dedestino.

• Rango: indica que el destino es una celda de lahoja de trabajo de destino.

PRECAUCIÓN: Si establece el Tipo dedestino en un rango o un rango connombre, las fórmulas o los datos queexistían previamente en la celda de destinose sustituirán cuando se desplace con elbotón de acción. Si la celda de destinocontiene una función DBRW de TM1, lafunción se pierde y la celda no se podráconectar al servidor, ni se podrá leer ograbar en el servidor.

6 IBM Planning Analytics: Referencia de TM1

Campo Descripción

Objeto de destino Este campo representa la ubicación de la hoja detrabajo de destino en la que se insertará el valor deObjeto de origen.

Introduzca el objeto de destino de la siguientemanera, según la selección del tipo de destino:

• Si la opción Tipo de destino se define comoSUBNM, debe especificar el nombre de ladimensión de título en la hoja de trabajo dedestino.

• Si la opción Tipo de destino se define comoRango con nombre, debe especificar el nombredel rango en la hoja de trabajo de destino.

• Si la opción Tipo de destino se define comoRango, debe especificar la ubicación de celda enla hoja de trabajo de destino.

También puede utilizar una referencia de Excelpara recuperar el valor del campo Objeto dedestino.

Para ver un ejemplo detallado, consulte ladocumentación de IBM CognosTM1 paradesarrolladores.

Subconjunto Introduzca un valor en el campo Subconjuntocuando el campo Tipo de destino esté definidocomo SUBNM.

Alias Introduzca un valor en el campo Alias cuando elcampo Tipo de destino esté definido como SUBNM.

Editor de atributosUtilice el Editor de atributos para crear y editar atributos de cubos, dimensiones, elementos y réplicas.

Tenga en cuenta que todos los elementos incluyen un atributo Formato, que define cómo aparecen losvalores de elemento en Cube Viewer. El valor predeterminado del atributo Formato es Sin estilo.

Menú Archivo

Elemento de menú Descripción

Cerrar Cierra el Editor de atributos.

Menú Editar

Capítulo 1. Cuadros de diálogo y ventanas 7

Elemento de menú Descripción

Deshacer celda Deshace la última acción de celda. Esta opción seaplica sólo a celdas individuales. No puededeshacer acciones que se apliquen a un rango deceldas.

Cortar Corta el contenido de las celdas seleccionadas y locoloca en el portapapeles.

Copiar Copia el contenido de las celdas seleccionadas y locoloca en el portapapeles.

Pegar Pega el contenido del portapapeles en las celdasseleccionadas.

Añadir nuevo atributo Abre el cuadro de diálogo Nuevo atributo, en el quepuede crear un nuevo atributo para los elementosde la dimensión.

Borrar atributo seleccionado Borra un atributo seleccionado. Debe eliminaratributos de forma individual; no puede eliminarvarios atributos a la vez.

Borrar Borra el contenido de las celdas seleccionadas.

Editar formato de elementos Abre el cuadro de diálogo Formato numérico, en elque puede asignar valores al atributo Formato.

Opciones de formatoLa opción Formato está disponible solo al seleccionar celdas en la intersección de las filas de elementos yla columna Formato. Pulse el botón Formato para mostrar el cuadro de diálogo Formato de número.

Seleccione una opción en el cuadro de lista Categoría para especificar un formato de visualización paralas celdas seleccionadas.

Están disponibles los siguientes formatos de número:

Categoría de formato Descripción

General Este formato muestra números sin puntosseparando los dígitos que están a la izquierda delpunto decimal. Los valores negativos vanprecedidos de un signo menos (-).

Utilice la opción Precisión para especificar elnúmero de dígitos que siguen al punto decimal.Tenga en cuenta que los valores derivados dereglas devuelven enteros únicamente cuandotienen formato General.

8 IBM Planning Analytics: Referencia de TM1

Categoría de formato Descripción

Fijo Este formato muestra números sin puntosseparando los dígitos que están a la izquierda delpunto decimal. Los valores negativos vanprecedidos de un signo menos (-); los usuarioscuentan con la opción de utilizar paréntesis paralos negativos si lo prefieren.

Utilice la opción Precisión para especificar elnúmero de dígitos que siguen al punto decimal.

Moneda Este formato muestra números con el símbolo demoneda que se especifica en las Propiedades deconfiguración regional de Windows, y utiliza puntospara separar los dígitos de tres en tres a laizquierda del punto decimal. Los valores negativosvan precedidos de un signo menos (-).

Utilice la opción Precisión para especificar elnúmero de dígitos que siguen al punto decimal.

Fecha Muestra una lista de formatos de fechapredefinidos.

Hora Muestra una lista de formatos de horapredefinidos.

Porcentaje Este formato multiplica los números por 100 ymuestra un signo de porcentaje (%) detrás deellos. Los dígitos que están a la izquierda del puntodecimal no utilizan comas, y los valores negativosvan precedidos de un signo menos (-).

Utilice la opción Precisión para especificar elnúmero de dígitos que siguen al punto decimal.

Científico Este formato muestra números en notacióncientífica. Los valores negativos van precedidos deun signo menos (-).

Utilice la opción Precisión para especificar elnúmero de dígitos que siguen al punto decimal.

Personalizar Puede definir una expresión de formatopersonalizada según sea necesario.

Precisión Esta opción determina el número de cifrasdecimales que van a aparecer en un formatoseleccionado. Si un valor tiene más cifrasdecimales que las indicadas en la precisiónespecificada, se redondea solo para fines devisualización; el valor completo se almacena en labase de datos de TM1.

Capítulo 1. Cuadros de diálogo y ventanas 9

Ventana Registro de auditoríaUtilice la ventana Registro de auditoría para consultar y ver registros incluidos en el registro de auditoríade TM1.

La ventana Registro de auditoría contiene dos paneles principales; el panel Consulta y el panelResultados. Utilice estos paneles para buscar el registro de auditoría y ver los registros recuperados en subúsqueda.

Panel ConsultaUtilice el panel Consulta para crear consultas que busquen en el registro de auditoría de TM1.

La barra de herramientas del panel Consulta contiene un botón Ejecutar consulta para consultar elregistro de auditoría después de establecer las opciones de consulta.

Las opciones de consulta se organizan en los siguientes grupos:

• Fecha y hora• Propietario de eventos• Tipo de evento

Opciones de fecha y hora

Las opciones de fecha y hora incluyen el establecimiento del periodo de tiempo que desee consultar.

Opción Descripción

Periodo de tiempo Contiene una lista de periodos de tiempopredefinidos para la consulta.

Seleccione un periodo de tiempo predefinido oseleccione Periodo de tiempo personalizado paraactivar las opciones Hora de inicio y Hora definalización.

Hora de inicio La fecha/hora de inicio de la consulta.

Esta opción sólo se activa al seleccionar Periodode tiempo personalizado en la opción Periodo detiempo.

TM1 realiza consultas en todos los registrosescritos en el registro de auditoría en dicha fecha/hora o después de dicha fecha/hora.

Pulse para abrir la herramienta de calendario,en la que puede seleccionar una fecha y una hora.

10 IBM Planning Analytics: Referencia de TM1

Opción Descripción

Hora de finalización La fecha y hora de finalización de la consulta.

Esta opción sólo se activa al seleccionar Periodode tiempo personalizado en la opción Periodo detiempo.

TM1 realiza consultas en todos los registros deauditoría hasta la hora de finalización queespecifique.

Pulse el icono Calendario para abrir laherramienta de calendario, en la que puedeseleccionar una fecha y una hora.

La hora de finalización predeterminadacorresponde a la fecha y hora actuales.

Opciones de Propietario del evento

Las opciones de Propietario del evento responden a la pregunta "¿Quién ha provocado este evento?". Elpropietario del evento puede ser una tarea planificada o un usuario de TM1.

Las opciones de Propietario del evento incluyen los siguientes parámetros:

Opción Descripción

Todo Establece que la consulta busque eventos deauditoría causados por cualquier tarea planificadao usuario de TM1.

Cliente Establece que la consulta busque eventos deauditoría causados únicamente por usuarios deTM1.

Para buscar eventos causados por un usuarioespecífico de TM1, pulse el botón Seleccionar

cliente . Puede seleccionar un único cliente ovarios clientes.

De forma predeterminada, se seleccionan todoslos clientes.

Tarea planificada Establece que la consulta busque eventos deauditoría causados únicamente por tareasplanificadas.

Para buscar eventos causados por una tareaplanificada específica, pulse el botón Seleccionar

tarea planificada . Puede seleccionar unaúnica tarea planificada o varias tareas planificadas.

De forma predeterminada, se seleccionan todas lastareas planificadas.

Capítulo 1. Cuadros de diálogo y ventanas 11

Opciones de Tipo de eventoLas opciones de Tipo de evento le permiten seleccionar el tipo de objeto o evento en el que desea realizarla búsqueda. Por ejemplo, puede utilizar estas opciones de búsqueda para "buscar intentos de inicio desesión fallidos" o "buscar eventos en los que se eliminó una dimensión".

Opción Descripción

Todo Establece que la consulta busque ambos tipos deeventos de auditoría; eventos relacionados conobjetos y en todo el sistema.

En todo el sistema Establece que la consulta busque únicamenteeventos de auditoría en todo el sistema.

Para buscar un evento específico en todo elsistema, seleccione el evento de la lista.

El valor predeterminado busca todos los eventosen todo el sistema.

Opción Descripción

Objeto Establece que la consulta busque únicamenteeventos de auditoría de tipo objeto.

Para buscar un evento de objeto específico, utilicelas opciones de la siguiente manera:

• Tipo de objeto: Limita la consulta a un solo tipoespecífico de objeto de TM1. Por ejemplo,eventos relacionados únicamente condimensiones.

• Nombre de objeto: le permite seleccionar unnombre de objeto específico.

Pulse para mostrar un cuadro de diálogo enel que puede seleccionar objetos por nombre.

Nota: Al definir la opción Tipo de objeto comoElemento, se desactivará el botón Selección delnombre de objeto debido a que puede que lalista de elementos sea demasiado larga paramostrarse. Para buscar eventos relacionados conun elemento específico, debe introducirmanualmente un nombre de elemento utilizandoel siguiente formato:DimensionName:ElementName. Por ejemplo:region:italy

• Tipo de evento: limita la consulta a un solo tipoespecífico de evento de objeto. El valorpredeterminado busca todos los eventos de tipoobjeto.

Panel ResultadosUtilice el panel Resultados para ver y desplazarse por los registros recuperados en la búsqueda.

12 IBM Planning Analytics: Referencia de TM1

Barra de herramientas del panel ResultadosLa barra de herramientas Resultados tiene los siguientes botones:

Acción Botón Descripción

Copiar Copia el valor de la celdaactualmente seleccionada en elportapapeles de Windows.

Buscar Abre el cuadro de diálogo Buscar,en el que puede buscar texto enlos registros de eventos.

Exportar Abre el cuadro de diálogoGuardar como, en el que puedeguardar los registros de eventosen un archivo en uno de lossiguientes formatos:

• XML• Delimitado por comas• Delimitado por tabuladores

Cuadrícula ResultadosEl panel Resultados incluye una cuadrícula que muestra los registros del archivo de registro de auditoríarecuperados por la consulta. Los registros recuperados se organizan en las siguientes columnas:

Columna Descripción

Fecha Fecha y hora del evento.

Usuario Cliente de TM1 (usuario) o tarea planificada que hacausado el evento.

Descripción/tipo de evento Breve descripción del evento.

Tipo de objeto Tipo del objeto TM1 asociado al evento.

Nombre de objeto Nombre del objeto TM1 asociado al evento.

Detalles Muestra un icono para indicar que existeinformación detallada sobre el evento específico.

Si un evento tiene detalles, puede verlos pulsandoel icono Detalles de dicho registro.

Puede clasificar los registros de la cuadrícula de cualquier columna en orden ascendente o descendentepulsando el título de la columna.

Ventana Detalles del registro de auditoríaLa ventana Detalles del registro de auditoría muestra los eventos secundarios de un evento de registro deauditoría que aparecieron en los resultados de la consulta de la ventana principal Registro de auditoría.

Capítulo 1. Cuadros de diálogo y ventanas 13

Barra de herramientas DetallesLa barra de herramientas Detalles tiene los siguientes botones:

Botón Descripción

Copiar Copia el valor de la celda actualmenteseleccionada en el portapapeles de Windows.

Buscar Abre el cuadro de diálogo Buscar, en el que puedebuscar texto en los registros de eventos.

Exportar Abre el cuadro de diálogo Guardar como, en el quepuede guardar los registros de eventos en unarchivo en uno de los siguientes formatos:

• XML• separado por comas• separado por tabuladores

Cuadrícula DetallesLa cuadrícula Detalles muestra los registros de detalles de los eventos secundarios que pertenecen alevento padre.

Los registros de detalles se organizan en las siguientes columnas:

Columna Descripción

Fecha Fecha y hora del evento.

Usuario Cliente de TM1 (usuario) o tarea planificada que hacausado el evento.

Descripción/tipo de evento Breve descripción del evento.

Tipo de objeto Tipo del objeto TM1 asociado al evento.

Nombre de objeto Nombre del objeto TM1 asociado al evento.

Puede clasificar los registros de la cuadrícula de cualquier columna en orden ascendente o descendentepulsando el título de la columna.

Asistente para la configuración de tareasUtilice el Asistente para la configuración de tareas para planificar una réplica, proceso de sincronización oejecución a intervalos regulares.

El Asistente consta de dos pantallas:

• Pantalla 1: seleccione las réplicas y procesos que se van a incluir en la tarea.• Pantalla 2: especifique la hora de inicio de la ejecución inicial de la tarea y el intervalo posterior con el

que debe ejecutarse la tarea.

14 IBM Planning Analytics: Referencia de TM1

Pantalla 1 (paso 1)

Campo Descripción

Lista Disponibles Enumera todas las réplicas y procesos disponiblespara planificar como tareas.

Lista Seleccionados Enumera las réplicas o los procesos seleccionadospara ser incluidos en la tarea actual.

Añadir Pulse este botón para mover las réplicas o losprocesos seleccionados de la lista Disponibles a lalista Seleccionados

Añadir todo Pulse este botón para mover todas las réplicas otodos los procesos de la lista Disponibles a la listaSeleccionados.

Eliminar Pulse este botón para mover las réplicas o losprocesos seleccionados de la lista Seleccionados ala lista Disponibles.

Eliminar todo Pulse este botón para mover todas las réplicas otodos los procesos de la lista Seleccionados a lalista Disponibles.

Especificar valores de parámetros Pulse el botón del ratón para abrir el cuadro dediálogo Valores de parámetros, en el que puedeespecificar los valores de cualquier parámetrorelacionado con el proceso seleccionado.

Pantalla 2 (paso 2)

Campo Descripción

Fecha y hora de inicio de la tarea Seleccione una fecha de inicio en el calendario yespecifique una hora de inicio en el campo Hora.

Frecuencia de ejecución de tareas Rellene los campos adecuados para establecer elintervalo con el que debe ejecutarse la tarea.

La planificación de la tarea está activa Rellene este cuadro para activar la tarea que se vaa ejecutar con el intervalo y la hora de inicioespecificados. Borre este cuadro para activar latarea más tarde.

Ventana Clientes/GruposLa ventana Clientes/Grupos le permite crear y modificar clientes y grupos de usuarios en un servidor.

Capítulo 1. Cuadros de diálogo y ventanas 15

Cuadrícula Clientes/Grupos

La cuadrícula Clientes/Grupos muestra nombres de clientes como cabeceras de fila y grupos de usuarioscomo cabeceras de columna. Una "X" en la intersección de un nombre de cliente y un grupo de usuariosindica el grupo al que pertenece el usuario. Los usuarios pueden pertenecer a varios grupos.

La cuadrícula también incluye varias columnas que muestran propiedades de clientes en el servidor.

• La celda de la intersección de un nombre de cliente y la columna Contraseña contiene la contraseña delcliente.

• La celda de la intersección de un nombre de cliente y la columna Días para la caducidad contiene elnúmero de días durante los cuales la contraseña es válida para el cliente. Después de que transcurraeste número de días, el cliente ya no podrá iniciar sesión en el servidor con la contraseña asignada. Uncliente cuya contraseña caduque pronto comenzará a recibir avisos de la caducidad cinco días antes dela fecha de caducidad.

• La celda de la intersección del nombre de cliente y la columna Estado indica si el cliente está activo enel servidor.

• La celda de la intersección del nombre de cliente y la columna Número máximo de conexiones indica elnúmero máximo de conexiones que se puede establecer en el servidor con la contraseña y el nombrede cliente asociados.

Menú Seguridad

Elemento de menú Descripción

Cerrar Cierra el cuadro de diálogo Clientes/Grupos.

Menú Clientes

Elemento de menú Descripción

Añadir nuevo cliente Abre el cuadro de diálogo Creando nuevo cliente,en el que podrá crear un nuevo cliente en elservidor.

Borrar cliente Borra el cliente seleccionado actualmente delservidor.

Desconectar cliente Desconecta al cliente seleccionado actualmentedel servidor.

Configurar contraseña Establece la contraseña del cliente seleccionadoactualmente.

Borrar contraseña Borra la contraseña del cliente seleccionadoactualmente.

Menú Grupos

16 IBM Planning Analytics: Referencia de TM1

Elemento de menú Descripción

Añadir nuevo grupo Abre el cuadro de diálogo Creando nuevo grupo, enel que podrá crear un nuevo grupo de usuarios enel servidor.

Borrar grupo Borra el grupo de usuarios seleccionadoactualmente del servidor.

Cuadrícula Clientes/GruposPuede introducir datos de clientes directamente en la cuadrícula Clientes/Grupos.

La cuadrícula incluye varias columnas, tal y como se describe en la siguiente tabla.

Columna Descripción

Nombre de usuario Muestra los nombres de usuario de todos losclientes del servidor.

Contraseña Identifica si una contraseña está definida para uncliente determinado.

Puede pulsar una celda en la intersección de lacolumna Contraseña y una fila de cliente y, acontinuación, introducir una contraseña paraasignar una contraseña al cliente.

Después de escribir una contraseña, TM1 le solicitaque vuelva a especificar la contraseña para queconfirme la contraseña.

Días para la caducidad Indica el número de días de validez de lacontraseña de un cliente determinado.

Para asignar la caducidad de la contraseña de uncliente, pulse la celda en la intersección de lacolumna Días para la caducidad y la fila de clientey, a continuación, introduzca un valor decaducidad.

Conexiones máximas Identifica el número máximo de conexiones que sepueden realizar en el servidor a través de uncliente determinado.

Para asignar un número máximo de conexiones aun cliente, pulse la celda de la intersección de lacolumna Número máximo de conexiones y la filade cliente y, a continuación, introduzca el númeromáximo de conexiones del cliente.

Estado Indica el estado de conexión actual de un clientedeterminado.

Capítulo 1. Cuadros de diálogo y ventanas 17

Columna Descripción

Grupos de usuarios Existe una columna para cada grupo de usuariosdel servidor.

Para asignar un cliente a un grupo de usuarios,seleccione la casilla de verificación de laintersección de la columna del grupo de usuarios yel nombre del cliente.

Los clientes pueden pertenecer a varios grupos deusuarios.

Cuadro de diálogo Centro de mensajes de clientesEl cuadro de diálogo Centro de mensajes de clientes le permite administrar las conexiones de clientes aun servidor. También puede utilizar este cuadro de diálogo para apagar de forma remota un servidor.Debe ser un miembro del grupo ADMIN de un servidor para acceder a este cuadro de diálogo.

Seleccione un servidor en el panel de la izquierda de Server Explorer y, a continuación, seleccioneServidor, Gestor de servidor para abrir el cuadro de diálogo Centro de mensajes de clientes.

Campo Descripción

Apagar servidor Seleccione esta opción para apagar el servidor y, acontinuación, especifique un intervalo en minutos.

Desconectar clientes Seleccione esta opción para desconectar clientesdel servidor y, a continuación, especifique unintervalo en minutos.

Debe pulsar Seleccionar clientes para crear oseleccionar el subconjunto de clientes que se va adesconectar.

Difundir mensaje a los clientes seleccionados Seleccione esta opción para difundir un mensajede texto a los clientes conectados al servidor.

Introduzca el mensaje en el cuadro de texto y, acontinuación, pulse Seleccionar clientes para crearo seleccionar un subconjunto de clientes querecibirán el mensaje.

Cuadro de diálogo Crear una dimensiónIntroduzca el nombre de la dimensión que desee crear en el campo que aparece en la parte superior delcuadro de diálogo y, a continuación, pulse Aceptar.

Para crear una dimensión en su servidor local, introduzca únicamente el nombre de la dimensión.

Para crear una dimensión en un servidor remoto, introduzca el nombre de la dimensión precedido delnombre del servidor y dos puntos. Por ejemplo, introduzca Sales:Product para crear la dimensiónProduct en el servidor Sales.

18 IBM Planning Analytics: Referencia de TM1

Cuadro de diálogo Crear objeto de réplica de servidorUtilice el cuadro de diálogo Crear objeto de réplica de servidor para establecer una nueva conexión deréplica o para modificar una conexión existente.

Campo Descripción

En el servidor Seleccione un servidor de origen de la lista. La listaincluye los nombres de todos los servidores queestán disponibles actualmente en la red.

Como usuario Introduzca su nombre de usuario en el servidor deorigen seleccionado.

Con contraseña Introduzca la contraseña del servidor de origenseleccionado.

Con espacio de nombres Si el objeto utiliza seguridad de pasaporte CAM,especifique el ID de espacio de nombres de IBMCognos. No escriba aquí el nombre descriptivo.

Utilizar el inicio de sesión integrado Seleccione este cuadro para utilizar laautenticación Inicio de sesión integrado, en lugarde la seguridad estándar de TM1.

Cuadro de diálogo Creación de cubosUtilice las siguientes opciones del cuadro de diálogo Creación de cubos para crear un nuevo cubo a partirde dimensiones definidas previamente.

Campo Descripción

Nombre de cubo Introduzca el nombre del cubo que está creandoen este campo.

Dimensiones disponibles Una lista de todas las dimensiones disponibles enel servidor en el que está creando el cubo.

Dimensiones del nuevo cubo La lista de dimensiones del cubo que está creando.

Añadir Pulse este botón para mover las dimensionesseleccionadas de la lista Dimensiones disponiblesa la lista Dimensiones del nuevo cubo

Eliminar Pulse este botón para mover las dimensionesseleccionadas de la lista Dimensiones del nuevocubo a la lista Dimensiones disponibles.

Subir Pulse este botón para subir las dimensionesseleccionadas en la lista Dimensiones del nuevocubo. Con cada pulsación del botón, lasdimensiones seleccionadas subirán una posición.

Capítulo 1. Cuadros de diálogo y ventanas 19

Campo Descripción

Bajar Pulse este botón para bajar las dimensionesseleccionadas en la lista Dimensiones del nuevocubo. Con cada pulsación del botón, lasdimensiones seleccionadas bajarán una posición.

Cancelar Pulse el botón del ratón para cancelar la creacióndel cubo y salir del cuadro de diálogo Creación decubos.

Restablecer Pulse el botón del ratón para restablecer la listaDimensiones disponibles y borrar la listaDimensiones del nuevo cubo.

Actualizar Pulse el botón del ratón para actualizar la listaDimensiones disponibles. Esta opción sondea elservidor en busca de nuevas dimensiones y añadelas dimensiones nuevas a la lista Dimensionesdisponibles.

Propiedades Pulse este botón para asignar propiedades al cubo.

Puede asignar propiedades que definen unadimensión de medidas, una dimensión de tiempo yel estado de carga a petición del cubo.

Aceptar Pulse el botón del ratón para aceptar laconfiguración del cuadro de diálogo y crear elcubo.

Cuadro de diálogo Optimizador del cuboTM1 incluye una característica que permite optimizar el orden de las dimensiones de un cubo, con lo cualse consume menos memoria y se mejora el rendimiento.

Si no está familiarizado con sus datos, es posible especificar un orden de dimensiones durante la creacióndel cubo que dé como resultado un rendimiento inferior al óptimo. Es posible que la distribución de losdatos de un cubo cambie con el paso del tiempo, lo que provoca que el orden de las dimensionesespecificado durante la creación del cubo no sea el idóneo.

Cuando optimiza el orden de las dimensiones de un cubo, TM1 no cambia el orden real de lasdimensiones en la estructura del cubo. TM1 cambia la forma en que se han ordenado las dimensionesinternamente en el servidor, pero dado que la estructura del cubo no cambia, las reglas, las funciones olas aplicaciones que hacen referencia al cubo continúan siendo válidas.

Al cambiar el orden de las dimensiones, puede ver de forma instantánea un informe que detalla elimpacto que tienen sus cambios en el consumo de memoria del cubo.

Por las siguientes razones, debería optimizar el orden de las dimensiones de un cubo sólo en un entornode desarrollo mientras intenta determinar la configuración óptima del cubo:

• El servidor requiere importantes recursos de memoria para volver a configurar el orden de lasdimensiones de un cubo. Durante el proceso de reorganización, la memoria RAM temporal del servidorse multiplica por dos en el cubo que está reordenando. Por ejemplo, un cubo de 50 MB requiere 100 MBde RAM para volver a configurarse.

• La reordenación coloca un bloqueo de lectura en el servidor, bloqueando todas las solicitudes de losusuarios durante el proceso de reordenación.

20 IBM Planning Analytics: Referencia de TM1

Nota: Debe ser miembro del grupo ADMIN para poder optimizar el orden de las dimensiones de loscubos. La opción de optimización sólo está disponible para los cubos de los servidores remotos; no podráoptimizar el orden de las dimensiones en los cubos de un servidor local. De igual forma, al optimizar elorden de las dimensiones de un cubo, no debería mover las dimensiones de cadena desde la últimaposición, ni mover las dimensiones de cadena a la última posición.

Procedimiento

1. En el panel de árbol de Server Explorer, seleccione el cubo que desee optimizar.2. Pulse Cubo, Reordenar dimensiones.

Se abrirá el cuadro de diálogo Optimizador del cubo.3. Seleccione una dimensión en el cuadro de lista Nuevo orden de las dimensiones.4. Pulse las flechas que indican hacia arriba o hacia abajo para cambiar el orden de la dimensión del

cubo.5. Pulse Probar.

Tenga en cuenta el valor que aparece junto a la etiqueta Cambio en el porcentaje. Si este valor esnegativo, el nuevo orden de las dimensiones utiliza menos memoria y, por lo tanto, es más eficaz.

6. Repita los pasos 3 a 5 hasta que logre el orden de las dimensiones más eficaz.7. Pulse Aceptar.

Cuadro de diálogo Propiedades del cuboUtilice el cuadro de diálogo Propiedades del cubo para establecer las propiedades de los cubosindividuales.

Campo Descripción

Dimensión de medidas Seleccione una dimensión de medidas de la lista.

Dimensión de tiempo Seleccione una dimensión de tiempo de la lista.

Cargar a petición Seleccione la casilla para cargar el cubo en lamemoria del servidor únicamente cuando uncliente solicite los datos del cubo. Desactive lacasilla para cargar el cubo de forma automáticacuando se inicie el servidor.

Cube Viewer

Dimensiones de título

Las dimensiones de título aparecen directamente junto a la barra de herramientas en la parte superior dela ventana Cube Viewer. Cada dimensión aparecerá en un cuadro de lista.

Dimensiones de fila

Las dimensiones de fila aparecerán en la parte superior del eje de filas de Cube Viewer. Los elementos dedimensiones actuales aparecerán como cabeceras de fila en Cube Viewer.

Capítulo 1. Cuadros de diálogo y ventanas 21

Dimensiones de columna

Las dimensiones de columna aparecerán en la parte izquierda del eje de columnas de Cube Viewer. Loselementos de dimensiones actuales aparecerán como cabeceras de columna en Cube Viewer.

Menú ArchivoLas siguientes opciones están disponibles en el menú Archivo de Cube Viewer.

Opción Descripción

Abrir Abre el cuadro de diálogo Abrir Vista de TM1, en elque puede abrir otras vistas relacionadas con elcubo actual.

Recargar Vuelve a cargar la definición de vista actual.

Calcular Calcula la vista actual.

Guardar Guarda la configuración de vista actual.

Guardar como Guarda la configuración de vista actual con unnuevo nombre.

Borrar vistas Abre el cuadro de diálogo Borrar vistas connombre, en el que puede borrar vistas guardadas.

Sección Exporta la vista actual a una hoja de trabajo deExcel. La hoja de trabajo de Excel se llena defórmulas que recuperan y escriben valores en elservidor en el que se origina la vista.

Formulario activo Lanza la opción Insertar formulario activo para quepueda añadir una conexión de Formulario activo alos datos de la celda actual de la hoja de trabajo.

Instantánea Exporta la vista actual a una hoja de trabajo deExcel como valores simples. La hoja de trabajo nomantiene ninguna conexión con el servidor en elque se origina la vista.

Cerrar Cierra la ventana Cube Viewer.

Menú EditarLas siguientes opciones están disponibles en el menú Editar de Cube Viewer.

Opción Descripción

Deshacer acción Deshace la última acción de celda. Guardar oCerrar finalizan la colección de acciones quepueden deshacerse o volver a realizarse.

Rehacer restaura la última acción de celda.

Cortar Corta el contenido de las celdas seleccionadas y locoloca en el portapapeles.

22 IBM Planning Analytics: Referencia de TM1

Opción Descripción

Copiar Copia el contenido de las celdas seleccionadas,con el formato actual, en el portapapeles.

Copiar valor sin formato Copia el contenido sin formato de las celdasseleccionadas en el portapapeles.

Pegar Pega el contenido del portapapeles en las celdasseleccionadas.

Borrar Borra los valores de celda seleccionados.

Editar atributos de cubo Abre la ventana Editor de atributos, en la quepuede asignar y editar atributos de todos los cubosen el servidor actual.

Menú VerLas siguientes opciones están disponibles en el menú Ver de Cube Viewer.

Opción Descripción

Barra de herramientas Oculta o muestra la barra de herramientas en laparte superior de Cube Viewer. Una marca deselección indica que se muestra la barra deherramientas.

Barra de estado Oculta o muestra la barra de estado en la parteinferior de Cube Viewer. Una marca de selecciónindica que se muestra la barra de estado.

De derecha a izquierda Este botón de alternar cambia la posición de lasdimensiones de columna de Cube Viewer.

Una flecha hacia la derecha indica que lascolumnas están distribuidas de derecha aizquierda. Una flecha hacia la izquierda indica quelas columnas están distribuidas de izquierda aderecha.

Menú OpcionesLas siguientes opciones están disponibles en el menú Opciones de Cube Viewer

Opción Descripción

Suprimir ceros Esta opción suprime o muestra todas las filas ycolumnas que contienen sólo valores cero en lavista del cubo. Una marca de selección indica quelas filas y columnas que contienen sólo ceros sesuprimen de la vista actual.

Capítulo 1. Cuadros de diálogo y ventanas 23

Opción Descripción

Suprimir ceros en las filas Esta opción suprime o muestra todas las filas quecontienen sólo valores cero en la vista del cubo.Una marca de selección indica que las filas quecontienen sólo ceros se suprimen de la vistaactual.

Suprimir ceros en las columnas Esta opción suprime o muestra todas las columnasque contienen sólo valores cero en la vista delcubo. Una marca de selección indica que lascolumnas que contienen sólo ceros se suprimen dela vista actual.

Recalcular automáticamente Esta opción activa o desactiva la acción de volver acalcular automáticamente tras la reconfiguraciónde la vista. Una marca de selección indica que lavista se recalcula automáticamente cuando cambiala configuración de la vista.

Formato Abre el cuadro de diálogo Formato numérico, en elque puede definir el formato numérico de losvalores de la vista actual. Tenga en cuenta que elformato que seleccione se aplicará únicamente alos valores en los que no se especifique el atributoFormato.

Anchura de columna Abre el cuadro de diálogo Ancho de columna, quele permite establecer una anchura mínima ymáximo para las columnas de Cube Viewer.

Sección en un nuevo libro de trabajo Esta opción determina cómo se crean lassecciones.

Una marca de selección indica que las seccionesse insertan en un nuevo libro de trabajo alseleccionar Archivo, Sección.

Si no activa esta opción, las secciones seinsertarán en una nueva hoja del libro de trabajoactual.

Cuadro de diálogo Borrar subconjuntos con nombreEste cuadro de diálogo muestra los subconjuntos relacionados con la dimensión actual. Para eliminar unsubconjunto, seleccione el subconjunto y pulse Aceptar.

Para seleccionar varios subconjuntos adyacentes, pulse y arrastre los subconjuntos. Para seleccionarvarios subconjuntos no adyacentes, pulse la tecla Ctrl y pulse cada subconjunto.

Cuadro de diálogo Borrar vistas con nombreEste cuadro de diálogo muestra las vistas relacionadas con el cubo actual. Para eliminar una vista,seleccione la vista y pulse Aceptar.

24 IBM Planning Analytics: Referencia de TM1

Para seleccionar varias vistas adyacentes, pulse y arrastre las vistas. Para seleccionar varias vistas noadyacentes, pulse la tecla Ctrl y pulse cada vista.

Editor de dimensiones

Panel Elementos

Muestra los elementos de la dimensión que está visualizando actualmente.

Panel Propiedades

Al seleccionar un elemento consolidado en el panel Elementos, el panel Propiedades mostrará laspropiedades de los hijos inmediatos del elemento consolidado.

Al seleccionar un elemento de hoja, el panel Propiedades mostrará las propiedades del elemento de hoja.

Nota: Al visualizar un conjunto de dimensiones excepcionalmente grande en el Editor de dimensionescon el panel Propiedades activado, es posible que tenga problemas de rendimiento. Esto puede ocurrircuando selecciona una consolidación en el panel Elementos y TM1 tiene que mostrar la lista completa depropiedades y elementos relacionados en el panel Propiedades.

Si trabaja con conjuntos de dimensiones grandes, es posible que desee desactivar el panel Propiedades.Para desactivar el panel Propiedades, pulse la opción Ventana de propiedades en el menú Ver paraeliminar la marca de selección situada junto a la opción.

Menú Dimensión

Elemento de menú Descripción

Guardar Guarda la estructura de dimensiones actual.

Guardar como Guarda la estructura de dimensiones actual con unnuevo nombre.

Cerrar Cierra el Editor de dimensiones.

Menú Editar

Elemento de menú Descripción

Cortar Corta los elementos seleccionados y los coloca enel portapapeles.

Copiar Copia los elementos seleccionados en elportapapeles.

Capítulo 1. Cuadros de diálogo y ventanas 25

Elemento de menú Descripción

Pegar Pega el contenido del portapapeles como un nuevoelemento.

• Cuando no seleccione ningún elemento en elEditor de dimensiones, esta opción insertará unnuevo elemento encima del primer elementoseleccionado en el panel Elementos.

• Al seleccionar un elemento en el panelElementos, esta opción mostrará un menúsecundario con las opciones Pegar por encima,Pegar como hijo y Pegar por debajo.

Pegar por encima Pega el contenido del portapapeles encima de unelemento seleccionado.

Pegar por debajo Pega el contenido del portapapeles debajo de unelemento seleccionado.

Pegar como hijo Pega el contenido del portapapeles como hijo deun elemento seleccionado.

Insertar hijo Abre el cuadro de diálogo Insertar elementos dedimensiones, en el que puede insertar un hijo ovarios hijos de un elemento seleccionado.

Insertar elemento Abre el cuadro de diálogo Insertar elementos dedimensiones, en el que puede insertar elementosde hoja (simples) en la dimensión.

Seleccionar todo Selecciona todos los elementos del panelElementos.

Filtro por, nivel Abre el cuadro de diálogo Filtro por nivel, en el quepuede seleccionar elementos por nivel jerárquico.

Esta opción afecta únicamente a la visualización delos elementos, no afecta a la estructura dedimensiones. Al utilizar esta opción, el panelElementos mostrará únicamente los elementos delnivel que haya especificado.

Filtro por, atributo Abre el cuadro de diálogo Filtro por atributo, en elque puede seleccionar elementos por valor deatributo.

Esta opción afecta únicamente a la visualización delos elementos, no afecta a la estructura dedimensiones. Al utilizar esta opción, el panelElementos mostrará únicamente los elementoscon el valor de atributo que haya especificado.

26 IBM Planning Analytics: Referencia de TM1

Elemento de menú Descripción

Filtro por, comodín Le permite seleccionar elementos que coincidancon una expresión de búsqueda definida por elusuario.

Esta opción afecta únicamente a la visualización delos elementos, no afecta a la estructura dedimensiones. Al utilizar esta opción, el panelElementos mostrará únicamente los elementosque coincidan con la expresión de búsqueda quehaya especificado.

Seleccionar alias Abre el cuadro de diálogo Alias de TM1, en el quepuede seleccionar un alias para visualizarlo en elEditor de dimensiones.

Orden, ascendente Clasifica todos los elementos del panel Elementosen orden alfabético ascendente.

Esta opción afecta únicamente a la visualización delos elementos, no afecta a la estructura dedimensiones.

Orden, descendente Clasifica todos los elementos del panel Elementosen orden alfabético descendente.

Esta opción afecta únicamente a la visualización delos elementos, no afecta a la estructura dedimensiones.

Orden, Jerarquía Ordena todos los elementos del panel Elementosen orden jerárquico, para que pueda ver la relaciónpadre/hijo de los elementos.

Esta opción afecta únicamente a la visualización delos elementos, no afecta a la estructura dedimensiones.

Orden, Índice ascendente Ordena todos los elementos del panel Elementosen orden ascendente según el valor de índice delelemento.

Esta opción afecta únicamente a la visualización delos elementos, no afecta a la estructura dedimensiones.

Orden, Índice descendente Ordena todos los elementos del panel Elementosen orden descendente según el valor de índice delelemento.

Esta opción afecta únicamente a la visualización delos elementos, no afecta a la estructura dedimensiones.

Capítulo 1. Cuadros de diálogo y ventanas 27

Elemento de menú Descripción

Mantener Modifica el panel Elementos para que sóloaparezcan los elementos seleccionadosactualmente.

Esta opción afecta únicamente a la visualización delos elementos, no afecta a la estructura dedimensiones.

Ocultar Modifica el panel Elementos para que se ocultenlos elementos seleccionados actualmente.

Esta opción afecta únicamente a la visualización delos elementos, no afecta a la estructura dedimensiones.

Borrar elemento Borra todas las instancias de un elementoseleccionado en la dimensión.

Borrar desde la consolidación Borra la instancia de un elemento seleccionado enla consolidación actual.

Editar formatos de elementos Abre la hoja de trabajo Editar formatos deelementos, en la que puede definir estilos devisualización de elementos. Estos estilos devisualización se aplican a las secciones dinámicasy a las hojas web de TM1 Web.

Desplegar elemento Muestra todos los hijos de un elementoseleccionado.

Contraer elemento Oculta todos los hijos de un elementoseleccionado.

Propiedades Abre el cuadro de diálogo Propiedades deelementos de dimensiones, en el que puedeasignar el tipo de elemento y el peso de unelemento seleccionado.

Menú Ver

Elemento de menú Descripción

Barras de herramientas Oculta o muestra las distintas barras deherramientas en la parte superior de la ventanaEditor de dimensiones. Una marca de selecciónindica que se muestra una barra de herramientas.

Barra de estado Oculta o muestra la barra de estado en la parteinferior de la ventana Editor de dimensiones. Unamarca de selección indica que se muestra la barrade estado.

28 IBM Planning Analytics: Referencia de TM1

Elemento de menú Descripción

Ventana Propiedades Oculta o muestra el panel Propiedades. Una marcade selección indica que se muestra el panelPropiedades.

Actualizar Actualiza la visualización del panel Elementos.

Cuadro de diálogo Insertar elementos de dimensionesUtilice este cuadro de diálogo para añadir elementos simples, de cadena o consolidados a una dimensión.El cuadro de diálogo contiene las siguientes opciones.

Opción Descripción

Nombre de dimensión Nombre de la dimensión a la que añade loselementos. No es una opción editable.

Nombre de padre Nombre del elemento padre al que añade loselementos. No es una opción editable.

Si seleccionó un elemento en el Editor dedimensiones al abrir el cuadro de diálogo Insertarelementos de dimensiones, dicho elementoaparecerá como Nombre de padre. Si noseleccionó ningún elemento, el nombre de padrees Root.

Insertar nombre del elemento Introduzca un nombre para el nuevo elemento eneste cuadro.

Tipo de elementos Realice una selección adecuada del elemento quedesee insertar.

Peso del elemento Si el tipo de elemento es Simple y el nombre depadre es cualquier otro que no sea Root,introduzca un peso en este cuadro. El peso es unfactor de multiplicación que se aplica a unelemento durante la consolidación.

Un peso relacionado con un elemento de unaconsolidación no modifica el valor del elemento enninguna otra parte de la dimensión.

Añadir Pulse Añadir cada vez que especifique un nuevoelemento, tipo y peso.

Aceptar Pulse este botón cuando termine de añadir loselementos para asignar los nuevos elementos a ladimensión.

Cuadro de diálogo Ordenar elementos de dimensionesUtilice este cuadro de diálogo para establecer el orden de los elementos de una dimensión.

Capítulo 1. Cuadros de diálogo y ventanas 29

El orden de los elementos de una dimensión determina el valor de índice de todos los elementos de ladimensión. El primer elemento de una dimensión tiene un valor de índice de 1, el segundo elemento tieneun valor de índice de 2, etc. El orden de los elementos de una dimensión es importante, ya que muchasfunciones de TM1 (hoja de trabajo, reglas y TurboIntegrator) hacen referencia a los valores del índice delos elementos.

Nota: Si cambia el orden de los elementos de una dimensión, las funciones que hagan referencia avalores de índice de elementos devolverán nuevos valores posiblemente inesperados.

Siga estos pasos para establecer el orden de los elementos.

Procedimiento

1. Seleccione un tipo de ordenación.

Tipo Descripción

Automático Activa las opciones de ordenación automática pornombre, nivel y jerarquía.

Manual Ordena los elementos de la forma en queaparecen actualmente en la estructura dedimensiones y establece la propiedad deordenación de la dimensión en manual.

2. Si ha seleccionado el tipo de ordenación manual, siga con el paso 5.3. Seleccione una opción de Ordenar automáticamente por.

Tipo Descripción

Nombre Clasifica los elementos en orden alfabético

Nivel Clasifica los elementos por orden jerárquico.

Jerarquía Ordena los elementos según la jerarquía de ladimensión.

4. Si es necesario, seleccione una Dirección del orden.5. Pulse Aceptar.

Ya ha establecido el orden de los elementos de la dimensión. Al abrir la dimensión, verá los elementosen orden según la clasificación por opción que especificó en el paso 3.

ResultadosYa ha establecido el orden de los elementos de la dimensión. Al abrir la dimensión, verá los elementos enorden según la clasificación por opción que especificó en el paso 3.

Cuadro de diálogo Propiedades de elementos de dimensionesMuestra el nombre, tipo y peso del elemento actual.

30 IBM Planning Analytics: Referencia de TM1

Panel Propiedades

Opciones Descripción

Tipo de elementos Para cambiar el tipo de elemento actual,seleccione un nuevo tipo en la lista. Existen trestipos de elementos posibles: simples,consolidados y de cadena.

Peso del elemento Para cambiar el peso del elemento actual, efectúeuna doble pulsación en el campo Peso delelemento e introduzca un nuevo valor de peso.

Ver los detallesEl menú Ver los detalles enumera las opciones que se utilizan para crear y gestionar un proceso deobtención de detalles y una asignación de detalles. Los procesos de obtención de detalles y lasasignaciones de detalles se utilizan para crear enlaces entre las celdas del cubo y los datos detalladosrelacionados.

Opciones Descripción

Crear/editar/eliminar reglas de asignación dedetalles

Seleccione estas opciones para crear, editar oeliminar asignaciones de detalles. La opción Crearabre el editor de reglas para que pueda diseñar laregla.

Crear/editar proceso de obtención de detalles Un proceso de obtención de detalles es un procesode TurboIntegrator que define los datosdetallados, que se abren en una nueva ventana.Estas opciones editan una regla de asignación dedetalles existente o le permiten crear una nueva.Las opciones Crear muestran los parámetros y losvalores que se utilizarán y los detalles del origende datos. Si cambia el origen de datos de unproceso de obtención de detalles, TurboIntegratorno actualiza la función con el nuevo origen dedatos dado que la función está fuera del áreaSentencias generadas. Debe editar el origen dedatos de la vista del cubo en la funciónReturnViewHandle del proceso de obtención dedetalles.

Cuadro de diálogo Editar fórmulaEl cuadro de diálogo Editar fórmula le guía a través del proceso de creación de las funciones DBR, DBRW yDBS. También puede utilizar el cuadro de diálogo Editar fórmula para editar cualquier función de TM1 enuna hoja de trabajo.

Para mostrar el cuadro de diálogo Editar fórmula, pulse una celda de una hoja de trabajo y seleccioneTM1, Editar fórmula. Si la celda contiene una función de TM1, la función se muestra en el campo deentrada del cuadro de diálogo.

Capítulo 1. Cuadros de diálogo y ventanas 31

Campo Descripción

DB Ref Pulse este botón para insertar una función DBR enla celda actual. TM1 le guía por varios cuadros dediálogo que le ayudan a crear la función.

DBRW Pulse este botón para insertar una función DBRWen la celda actual. TM1 le guía por varios cuadrosde diálogo que le ayudan a crear la función.

DB Send Pulse este botón para insertar una función DBS enla celda actual. TM1 le guía por varios cuadros dediálogo que le ayudan a crear la función.

Ref. de celda Pulse este botón para insertar una referencia decelda en una función. TM1 le solicita queseleccione la celda a la que quiere hacer referenciay le solicita también un tipo de referencia.

Nombres Pulse este botón para insertar un nombre de cubo,dimensión o elemento en una función

El editor de fórmulas puede utilizarse para crear funciones que hagan referencia a cubos de hasta 29dimensiones.

Cuadro de diálogo Editar referencia al cuboEste cuadro de diálogo le permite establecer las referencias de elementos que se utilizan en las funcionesde las hojas de trabajo de TM1, tales como DBRW y DBSW.

El cuadro de diálogo contiene botones y campos que corresponden a cada dimensión del cubo al quehace referencia la función de hoja de trabajo de TM1. Por ejemplo, la siguiente imagen muestra el cuadrode diálogo Editar referencia al cubo de una función DBRW que hace referencia al cubo SalesCube de labase de datos de muestra de TM1. El cuadro de diálogo incluye botones de todas las dimensiones delcubo SalesCube.

Cuando inserta una función de TM1 en una hoja de trabajo, TM1 intenta determinar si existe algunareferencia a elementos relevante en la hoja de trabajo. Si es el caso, dichas referencias se insertanautomáticamente en los campos adecuados en el cuadro de diálogo Editar referencia al cubo. Si no sepueden determinar las referencias a elementos relevantes, TM1 inserta "Undef" en los campos.

Puede establecer referencias en este cuadro de diálogo de uno de los siguientes modos:

• pulsando un botón de dimensión y seleccionando un elemento. En este caso, la referencia se insertacomo una cadena en el campo adecuado.

• introduciendo una referencia de celda directamente en un campo. Puede utilizar referencias de celdarelativas a filas, relativas a columnas o absolutas.

Si el cubo en el que está creando una referencia contiene más de 16 dimensiones, pulse Anterior paravolver a las páginas de las 16 dimensiones anteriores, o pulse Siguiente para ir a las páginas de las 16dimensiones siguientes.

Cuadro de diálogo Filtrar elementos por atributoUtilice este cuadro de diálogo para seleccionar sólo los elementos de subconjuntos que tengan un valorde atributo específico.

32 IBM Planning Analytics: Referencia de TM1

Seleccione el atributo deseado en la lista Seleccionar un atributo.

Seleccione un valor correspondiente en la lista Seleccionar un valor.

Cuadro de diálogo Filtrar elementos por nivelEl cuadro de lista muestra los niveles jerárquicos disponibles en el subconjunto actual. Para ver sólo loselementos de un nivel determinado, seleccione el nivel y pulse Aceptar.

Para seleccionar varios niveles adyacentes, pulse y arrastre los niveles. Para seleccionar varios niveles noadyacentes, pulse la tecla Ctrl y pulse cada nivel.

Cuadro de diálogo Filtrar subconjuntoEl cuadro de diálogo Filtrar subconjunto le permite crear un subconjunto dinámico según los valores deun cubo específico. Por ejemplo, puede crear un subconjunto de la dimensión Region que devuelve los 10elementos con los mayores valores de ventas reales anuales de 1.8L Sedan en el cubo Sales.

El cuadro de diálogo contiene las siguientes opciones.

Opción Descripción

CubeName El cubo en el que desea filtrar los valores.

Capítulo 1. Cuadros de diálogo y ventanas 33

Opción Descripción

Filtro El tipo de filtro que desea aplicar a la vista actual.

TopCount

Filtra el subconjunto para devolver sólo los nelementos mayores, donde n es un númeroespecificado en la opción Valor.

BottomCount

Filtra el subconjunto para devolver sólo los nelementos menores, donde n es un númeroespecificado en la opción Valor.

TopSum

Filtra el subconjunto para devolver sólo loselementos mayores cuya suma sea mayor oigual que n, donde n es un número especificadoen la opción Valor.

BottomSum

Filtra el subconjunto para devolver sólo loselementos menores cuya suma sea mayor oigual que n, donde n es un número especificadoen la opción Valor.

TopPercent

Filtra el subconjunto para devolver sólo loselementos mayores cuya suma sea mayor oigual que n, donde n es un porcentaje del totalde una dimensión especificado en la opciónValor.

BottomPercent

Filtra el subconjunto para devolver sólo loselementos menores cuya suma sea mayor oigual que n, donde n es un porcentaje del totalde una dimensión especificado en la opciónValor.

Ninguno

No se aplica al filtrado de subconjuntos.

Valor Un valor para el tipo de Filtro.

Seleccionar elemento de columna Los elementos de columna a los que se aplica elfiltro o la ordenación. Pulse los botones dedimensión para seleccionar un único elementopara cada dimensión de columna.

34 IBM Planning Analytics: Referencia de TM1

Opción Descripción

Ordenar El orden de clasificación que desea aplicar a loselementos de columna seleccionados.

Ascendente

Ordena los valores de los elementos decolumna especificados de menor a mayor.

Descendente

Ordena los valores de los elementos decolumna especificados de mayor a menor.

Ninguno

Sin orden de clasificación.

Seleccionar elementos de columna Debe seleccionar un único elemento en cadadimensión de cubo restante. Por ejemplo, si filtra ladimensión Region en la base de datos de muestraen los valores del cubo Sales, debe especificar unúnico elemento en cada dimensión Model, Month,ActVsBud y Account1.

En cada dimensión, pulse el botón adecuado yseleccione un único elemento.

Si el cubo contiene más de 16 dimensiones, pulse

para retroceder las páginas necesarias hasta

las 16 dimensiones anteriores, o pulse paraadelantar las páginas hasta las 16 dimensionessiguientes.

Cuadro de diálogo Filtrar vistaEl cuadro de diálogo Filtrar vista le permite filtrar y ordenar columnas en Cube Viewer o el Navegador dehojas de cálculo.

El cuadro de diálogo contiene las siguientes opciones.

Opción Filtro/Descripción

CubeName El cubo en el que desea filtrar u ordenar losvalores. Esta opción siempre se establece en elcubo relacionado con la vista actual. No se puedeeditar.

Filtro El tipo de filtro que desea aplicar a la vista actual.

TopCount

Filtra la vista para mostrar sólo los n elementosmayores, donde n es un número especificado en laopción Valor.

Capítulo 1. Cuadros de diálogo y ventanas 35

Opción Filtro/Descripción

BottomCount

Filtra la vista para mostrar sólo los n elementosmenores, donde n es un número especificado en laopción Valor.

TopSum

Filtra la vista para mostrar sólo los elementos másgrandes cuya suma sea mayor o igual que n, donden es un número especificado en la opción Valor.

BottomSum

Filtra la vista para mostrar sólo los elementos máspequeños cuya suma sea mayor o igual que n,cuando n es un número especificado en la opciónValor.

TopPercent

Filtra la vista para mostrar sólo los elementos másgrandes cuya suma sea mayor o igual que n,cuando n es un porcentaje del total de unadimensión especificado en la opción Valor.

BottomPercent

Filtra la vista para mostrar sólo los elementos máspequeños cuya suma sea mayor o igual que n,cuando n es un porcentaje del total de unadimensión especificado en la opción Valor.

Ninguno

Sin filtro. Seleccione esta opción si desea ordenarlos valores sin filtrarlos.

Valor Un valor para el tipo de Filtro.

Seleccionar elemento de columna Los elementos de columna a los que se aplica elfiltro o la ordenación. Pulse los botones dedimensión para seleccionar un único elementopara cada dimensión de columna.

Ordenar El orden de clasificación que desea aplicar a loselementos de columna seleccionados.

Ascendente

Ordena los valores de los elementos de columnaespecificados de menor a mayor.

Descendente

Ordena los valores de los elementos de columnaespecificados de mayor a menor.

36 IBM Planning Analytics: Referencia de TM1

Opción Filtro/Descripción

Ninguno

Sin orden de clasificación.

Cuadro de diálogo Obtener vista (Navegador de hojas de cálculo)El cuadro de diálogo Obtener vista le permite abrir una vista en el servidor local o en cualquier servidordisponible en la red.

Campo Descripción

Servidor La lista Servidor muestra todos los servidoresdisponibles en la red. Seleccione el servidor en elque está ubicada la vista que desee abrir.

Si no ha iniciado sesión en el servidor que contienela vista que desea abrir, pulse Conectar para abrirel cuadro de diálogo Conectar servidor e inicie lasesión en el servidor. Pulse Iniciar el servidor localpara iniciar el servidor local.

Cubo La lista Cubos muestra todos los cubos disponiblesen el servidor seleccionado. Seleccione el cuborelacionado con la vista que desee abrir.

Vista La lista Vista mostrará todas las vistas disponiblesen el cubo seleccionado. Seleccione la vista quedesee abrir.

Menú Navegador de hojas de cálculoEl menú Navegador de hojas de cálculo está disponible al pulsar con el botón derecho del ratón enControl de vista TM1. El menú le permite abrir, actualizar, dar formato, dividir y guardar una vista.También incluye varias opciones que controlan el comportamiento del Navegador de hojas de cálculo.

Elemento de menú Descripción

Actualizar vista Actualiza la vista actual enviando los valores editados a la base de datos TM1 yrecuperando los valores actuales de la base de datos.

Obtener vista Abre el cuadro de diálogo Obtener vista, en el que puede abrir una vista encualquier servidor disponible.

Estilos Abre el cuadro de diálogo Estilos de vista, que le permite dar formato a una vista.

Guardar Abre el cuadro de diálogo Guardar vista, que le permite guardar una vista deTM1.

Borrar pantalla Borra todos los datos relacionados con una vista, incluidas las etiquetas decolumna, fila y título.

Capítulo 1. Cuadros de diálogo y ventanas 37

Elemento de menú Descripción

Borrar Suprime el Control de vista de TM1. Tenga en cuenta que todos los datosrelacionados con la vista, incluidos los valores y las etiquetas, permanecerán enla hoja de cálculo.

Cortar Corta el Control de vista de TM1 y lo coloca en el portapapeles.

Copiar Copia el Control de vista de TM1 en el portapapeles.

Sección Secciona la vista actual en una nueva hoja de cálculo de Excel.

Suprimir ceros Este botón de alternar suprime o muestra valores cero en la vista del cubo. Unamarca de selección indica que los ceros se suprimen en la vista actual.

Mostrarautomáticamente

Este botón de alternar activa o desactiva la actualización automática de la vistatras la reconfiguración de la vista. Una marca de selección indica que la vista seactualiza automáticamente cuando cambia la configuración de la vista.

Actualizar vista derecálculo

Este botón de alternar activa o desactiva la actualización automática de la vistatras volver a calcular la hoja de cálculo (F9). Una marca de selección indica que lavista se actualiza cuando se vuelve a calcular la hoja de cálculo.

Ayuda Abra la ayuda del Navegador de hojas de cálculo.

Ventana Registro de mensajesLa ventana Registro de mensajes TM1 muestra los mensajes de estado sobre la actividad del servidor.Estos mensajes se guardan en el registro de mensajes del servidor y contienen información sobreactividades, como por ejemplo procesos ejecutados, tareas, dimensiones y cubos cargados y réplicasincronizada.

Para obtener más información sobre el registro de mensajes del servidor, consulte la publicación TM1Operations.

Panel Registro de mensajes

Este panel muestra mensajes de estado que se incluyen en el registro de mensajes del servidor.

Cada fila del panel representa un único mensaje. Si un mensaje del registro muestra un estado de error enuna réplica o proceso ejecutado, puede efectuar una doble pulsación en el mensaje para ver lainformación acerca de por qué la actividad generó el error.

Para obtener más información sobre los campos del panel Registro de mensajes, consulte la publicaciónTM1 Operations.

Menú Archivo

Elemento de menú Descripción

Salir Cierra la ventana Registro de mensajes.

Menú Editar

38 IBM Planning Analytics: Referencia de TM1

Elemento de menú Descripción

Copiar Copia el texto seleccionado del panel Registro demensajes en el portapapeles.

Buscar Abre el cuadro de diálogo Buscar, en el que puedebuscar texto en el panel Registro de mensajes.

Menú Ayuda

Elemento de menú Descripción

Ayuda del registro de mensajes Abre la ayuda del registro de mensajes.

Contenido e índice Abre la Biblioteca de documentación de TM1completa.

Cuadro de diálogo Nuevo atributo

Campo Descripción

Nombre del nuevo atributo Introduzca un nombre para el nuevo atributo eneste campo.

Numérico Seleccione esta opción si los valores de atributoson números.

Cadena Seleccione esta opción si los valores de atributoson cadenas de caracteres.

Alias Seleccione esta opción si los valores de atributoson nombres alternativos a los nombres deelemento, dimensión, cubo o servidor actuales.

Cuadro de diálogo Abrir subconjuntoUtilice el cuadro de diálogo Abrir subconjunto para abrir un subconjunto de dimensiones existente.

Para abrir el subconjunto predeterminado público, seleccione el cuadro Predeterminado y pulse Abrir.

Cuadro de diálogo Abrir vistaUtilice el cuadro de diálogo Abrir vista para abrir una vista de cubo existente.

Para abrir la vista predeterminada pública, seleccione el cuadro Predeterminado y pulse Abrir.

Capítulo 1. Cuadros de diálogo y ventanas 39

Asistente de informes de impresiónUtilice el Asistente de informes de impresión para crear informes con el estilo de "libro de referencia", apartir de secciones de TM1.

El Asistente consta de tres pantallas.

• Pantalla 1: seleccione las hojas que se van a incluir en el informe• Pantalla 2: seleccione las dimensiones de título que va a utilizar en el informe, establezca el orden en el

que aparecen en el informe y las opciones de impresión del libro de trabajo• Pantalla 3: seleccione un destino de impresión para el informe (impresora, archivo de Excel o archivo

PDF)

El Asistente de informes de impresión también le permite guardar los valores del informe.

Todas las pantallas

Botón Descripción

Cargar Pulse este botón para cargar un trabajo deimpresión de TM1.

Guardar Pulse este botón para guardar los valores actualesdel informe como trabajo de impresión de TM1.

Guardar como Pulse este botón para guardar los valores actualesdel informe como trabajo de impresión de TM1 conun nombre nuevo.

Siguiente Pulse este botón para avanzar hasta la siguientepantalla del Asistente.

Cancelar Pulse este botón para cerrar la ventana Asistentesin crear ningún informe.

Pantalla 1 de 3

Elemento Descripción

Incluya estas hojas en la lista de informes Enumera las hojas de trabajo disponibles del librode trabajo de Excel que puede incluir en el informe.

Para incluir una hoja de trabajo en el informe,seleccione la casilla de verificación que aparecejunto al nombre de la hoja.

Seleccionar todo Pulse este botón para incluir todas las hojas en elinforme.

Borrar todo Pulse este botón para excluir todas las hojas delinforme.

40 IBM Planning Analytics: Referencia de TM1

Pantalla 2 de 3

Elemento Descripción

Lista Dimensiones de título disponibles Enumera las dimensiones de título disponibles quepuede utilizar en el informe.

En cada dimensión, esta lista muestra el nombredel subconjunto (si procede), el número deelementos de la dimensión o del subconjunto y ladirección de celda de la dimensión de título de lahoja de trabajo.

Lista Dimensiones de título seleccionadas Enumera las dimensiones de título que va a incluiren el informe.

El orden de esta lista se utiliza cuando TM1 crea elinforme.

Añadir Pulse este botón para mover las dimensionesseleccionadas de la lista Dimensiones de títulodisponibles a la lista Dimensiones de títuloseleccionadas.

Añadir todo Pulse este botón para mover todas lasdimensiones de la lista Dimensiones de títulodisponibles a la lista Dimensiones de títuloseleccionadas.

Eliminar Pulse este botón para mover las dimensionesseleccionadas de la lista Dimensiones de títuloseleccionadas a la lista Dimensiones de títulodisponibles.

Eliminar todo Pulse este botón para mover todas lasdimensiones de la lista Dimensiones de títuloseleccionadas a la lista Dimensiones de títulodisponibles.

Subir Pulse este botón para subir la dimensión en la listaDimensiones de título seleccionadas. El orden deesta lista se utiliza cuando TM1 crea el informe.

Bajar Pulse este botón para bajar la dimensión en la listaDimensiones de título seleccionadas. El orden deesta lista se utiliza cuando TM1 crea el informe.

Editor de subconjuntos Pulse este botón para abrir el Editor desubconjuntos si desea seleccionar un subconjuntode elementos de la dimensión seleccionadaactualmente en la lista Dimensiones de títuloseleccionadas.

Capítulo 1. Cuadros de diálogo y ventanas 41

Elemento Descripción

Imprimir un solo libro de trabajo Seleccione esta opción para crear un informeorganizado en un grupo completo de hojas detrabajo.

Cada hoja del informe se imprime una sola vez,incluidas las hojas que no contienen datos desección de TM1.

Imprimir varios libros de trabajo Seleccione esta opción para crear un informeorganizado en varios grupos según los elementosde dimensiones.

Esta opción crea un informe con un mayor númerode hojas, ya que se imprime una copia de cada hojapara cada elemento de título.

Número total de libros de trabajo de Excel que sevan a crear

Muestra el número total de hojas de Excel que TM1creará en el informe actual.

Pantalla 3 de 3

Campo Descripción

Imprimir en impresora Seleccione esta opción si desea imprimir elinforme en una impresora.

Guardar como archivos Excel Seleccione esta opción si desea crear el informecomo archivo de Excel.

Guardar como archivos PDF Seleccione esta opción si desea crear el informecomo archivo PDF.

Vista previa Este botón está disponible al seleccionar la opciónImprimir en impresora.

Pulse este botón para previsualizar el informeantes de imprimirlo.

Nombre de impresora Esta opción está disponible al seleccionar la opciónImprimir en impresora.

Utilice esta opción para especificar la impresora enla que TM1 imprime el informe.

Número de copias Esta opción está disponible al seleccionar la opciónImprimir en impresora.

Utilice esta opción para especificar el número decopias del informe que se van a imprimir.

Imprimir en archivo Esta opción está disponible al seleccionar la opciónImprimir en impresora.

Seleccione esta opción para guardar el informecomo archivo listo para imprimir.

42 IBM Planning Analytics: Referencia de TM1

Campo Descripción

Nombre de archivo Esta opción está disponible al seleccionar lasopciones Imprimir en impresora e Imprimir enarchivo.

Introduzca una ruta completa y un nombre dearchivo en el que desee guardar el informe.También debe especificar un tipo de archivo. Porejemplo, si imprime un archivo utilizando unaimpresora PostScript, debe añadir el tipo dearchivo .ps al nombre del archivo.

Examinar Este botón está disponible al seleccionar la opciónimprimir o guardar el informe en un archivo.

Pulse este botón para seleccionar el directorio enel que desea guardar el informe.

Intercalar Esta opción está disponible al seleccionar la opciónImprimir en impresora.

Seleccione esta opción para agrupar páginas alimprimir varias copias del informe.

Crear nuevo libro de trabajo para cada título Esta opción está disponible al elegir guardar elinforme como archivo de Excel o PDF.

Seleccione esta opción si desea crear un archivoindependiente en cada dimensión de título delinforme.

Nombre de directorio Esta opción está disponible al guardar un informecomo archivo de Excel o PDF y seleccionar laopción Crear nuevo libro de trabajo para cadatítulo.

Introduzca un directorio en el que desee guardarlos archivos del informe. Para seleccionar unaubicación de directorio, pulse el botón Examinar.

Crear instantánea Esta opción está disponible al seleccionar la opciónGuardar como archivos Excel.

Seleccione esta opción cuando desee guardar elinforme como archivo de Excel que contienevalores reales y no funciones TM1 que recuperanvalores.

Retroceder Pulse este botón para retroceder hasta la anteriorpantalla del Asistente.

Finalizar Pulse este botón para crear el informe según lasopciones que haya seleccionado.

Capítulo 1. Cuadros de diálogo y ventanas 43

Cuadro de diálogo Opciones de procesoUtilice el cuadro de diálogo Opciones de proceso para controlar el comportamiento del botón de acciónantes y después de la ejecución del proceso.

Puede utilizar uno de los siguientes métodos para establecer el texto de confirmación y los mensajes deestado que aparecerán al pulsar el botón de Acción:

• Introduzca el texto del mensaje directamente en el cuadro de texto.• Utilice una referencia de Excel para recuperar dinámicamente el texto de un mensaje de la hoja de

trabajo.

Por ejemplo, para recuperar el texto de un mensaje del contenido de la celda A1, introduzca =A1 en elcuadro de texto de dicho mensaje. Para hacer referencia a un rango con nombre, utilice el formato:=Named Range.

Para obtener más información acerca de cómo utilizar el cuadro de diálogo Opciones de proceso,consulte IBM Cognos TM1 para desarrolladores.

Campo Descripción

Recálculo automático - Libro Seleccione esta opción para que TM1 recalcule deforma automática el libro de trabajo enterodespués de que se ejecute el proceso.

Mostrar mensaje de confirmación Seleccione esta opción para mostrar un mensajedespués de que el proceso se haya ejecutadocorrectamente.

Introduzca el texto del mensaje en el cuadro tal ycomo se describe anteriormente.

Mostrar mensaje de error Seleccione esta opción para mostrar un mensaje siel proceso no se ejecuta correctamente.

Introduzca el texto del mensaje en el cuadro tal ycomo se describe anteriormente.

Mostrar cuadro de diálogo de confirmación Seleccione esta opción para mostrar el cuadro demensaje de confirmación Sí/No antes de que seinicie el proceso. El usuario puede pulsar Sí paraejecutar el proceso o No para cancelarlo.

Introduzca el texto del mensaje en el cuadro tal ycomo se describe anteriormente.

Aceptar Pulse este botón para guardar los valores y cerrarel cuadro de diálogo.

Cancelar Pulse este botón para cerrar el cuadro de diálogosin guardar los valores.

Cuadro de diálogo Replicar cuboUtilice el cuadro de diálogo Replicar cubo para replicar un cubo de un servidor de origen en un servidor dedestino.

44 IBM Planning Analytics: Referencia de TM1

Información del cubo

Elemento Descripción

Nombre Nombre del cubo duplicado del servidor dedestino.

De forma predeterminada, TM1 asigna un nombreal cubo duplicado concatenando el nombre delservidor de origen con el nombre del cubo deorigen.

No cambie el nombre predeterminado si estáreplicando reglas en dicho cubo.

Copiar datos y configurar para sincronizar Seleccione esta opción para copiar datos cuando laréplica se establezca y para sincronizar datoscuando la sincronización tenga lugar entre losservidores de origen y de destino.

Copiar datos, pero no configurar para sincronizar Seleccione esta opción para copiar datos cuando laréplica se establezca, y para desactivar lasincronización de los datos más tarde.

Replicar vistas Seleccione esta opción para replicar todas lasvistas asociadas al cubo de origen.

Información de reglas

Elemento Descripción

Copiar regla Seleccione esta opción para copiar las reglas delcubo de origen en el cubo duplicado.

Establecer la regla para sincronizar Rellene este cuadro para sincronizar reglas cuandola sincronización tenga lugar entre los servidoresde origen y destino.

Desactive este cuadro para desactivar lasincronización de la regla.

No copiar regla Si selecciona esta opción, TM1 no copia la regla delcubo de origen en el cubo duplicado.

Información de dimensiones

Capítulo 1. Cuadros de diálogo y ventanas 45

Elemento Descripción

Cuadro Información de dimensiones Este cuadro muestra información acerca de lasdimensiones del cubo duplicado.

Si el cubo de origen no contiene reglas, TM1cambia el nombre de las dimensiones duplicadasconcatenando los nombres del servidor de origencon los nombres de la dimensión de origen.

Si el cubo de origen contiene reglas, TM1 nocambia los nombres de las dimensiones del cuboduplicado.

El cuadro Información de dimensiones tambiénmuestra el nombre de la dimensión de origen, elservidor de origen y el estado de réplica de cadadimensión del cubo.

Seleccionar dimensión local Para utilizar una dimensión local en lugar de unadimensión de origen, pulse la dimensión de origendel cuadro Información de dimensiones y pulseSeleccionar dimensión local. Seleccione ladimensión local que desee utilizar y pulse Aceptar.

Restablecer la selección actual con los parámetrospredeterminados

Si cambia alguna de las opciones de Informaciónde dimensiones para una dimensión en un cuboreplicado, podrá restaurar los valorespredeterminados de todas las opcionesseleccionando la dimensión en el cuadroInformación de dimensiones y pulsando estebotón.

Sobrescribir dimensión Esta opción está disponible al seleccionar unadimensión local.

Seleccione esta opción para sobrescribir ladimensión local con la definición de la dimensiónde origen.

Establecer la dimensión para sincronizar Rellene este cuadro para sincronizar los cambiosentre la dimensión de origen y de espejo cuando lasincronización tenga lugar entre los servidores deorigen y de destino.

Elimine la selección de este cuadro para desactivarla sincronización de la dimensión.

No sobrescribir dimensión Esta opción está disponible al seleccionar unadimensión local.

Seleccione esta opción para utilizar la dimensiónlocal tal cual.

Replicar subconjuntos Seleccione esta opción para replicar todos lossubconjuntos asociados a la dimensión de origen.

46 IBM Planning Analytics: Referencia de TM1

Editor de reglasEl editor de reglas tiene un conjunto de menús completo para crear, editar y gestionar las reglas de TM1rules. Existen atajos del teclado para las opciones de menú más utilizadas.

Menú ArchivoLa siguiente tabla describe las opciones del menú Archivo.

Nombre Descripción

Importar Abre un cuadro de diálogo de exploración dearchivos para que pueda seleccionar el archivo detexto que desea importar. El texto importadosustituirá la regla actual, si existe alguna.

Guardar Guarda la regla actual en el servidor.

Guardar como Guarda la regla actual en un archivo .rux de reglasde TM1 externo.

Comprobar sintaxis Comprueba la regla actual en busca de errores desintaxis.

imprimir Abre el cuadro de diálogo Imprimir para que puedaimprimir la regla actual.

Imprimir vista previa Abre la ventana Imprimir vista previa, en la quepuede ver una versión impresa de muestra de laregla antes de enviarla a una impresora.

Salir Cierra el Editor de reglas.

Menú EditarLa siguiente tabla describe las opciones del menú Editar.

Nombre Descripción

Deshacer Deshace la última edición.

Se soportan distintos niveles en "deshacer".

Rehacer Invierte el último comando deshacer.

Cortar Elimina el texto seleccionado y lo coloca en elportapapeles.

Copiar Copia el texto seleccionado en el portapapeles.

Pegar Pega el contenido del portapapeles en el Editor dereglas.

Seleccionar todo Selecciona todo el contenido del Editor de reglas.

Capítulo 1. Cuadros de diálogo y ventanas 47

Nombre Descripción

Buscar Abre el cuadro de diálogo Buscar, en el que puedebuscar texto en la regla.

Buscar/Sustituir... Abre el cuadro de diálogo Buscar/Sustituir parabuscar y sustituir texto.

Buscar siguiente Localiza la siguiente aparición del texto que estábuscando.

Alternar marcador Activa o desactiva un marcador para la línea decódigo actual.

Siguiente marcador Mueve el cursor al siguiente marcador disponible.

Marcador anterior Mueve el cursor al anterior marcador disponible.

Borrar todos los marcadores Elimina todos los marcadores.

Selección de comentarios Añade un símbolo de comentario # delante detodas las líneas en el texto actualmenteseleccionado para excluir las líneas de la reglacompilada.

Nota: La longitud del comentario está limitada a255 bytes. En los juegos de caracteresoccidentales, como por ejemplo el inglés, un únicocarácter se representa con un único byte, lo que lepermite introducir comentarios con 255caracteres. Sin embargo, los juegos de caracteresgrandes, como por ejemplo el chino, japonés ycoreano, utilizan varios bytes para representar uncarácter. En este caso, puede sobrepasarse ellímite de 255 bytes con anterioridad y no permitirrealmente la introducción de 255 caracteres.

Anular comentarios de la selección Elimina el símbolo de comentario # que estádelante de todas las líneas en el texto actualmenteseleccionado para incluir las líneas en la regla.

Sangría Aplica sangría en las líneas actualmenteseleccionadas.

No aplicar sangría Elimina la sangría de las líneas actualmenteseleccionadas.

Ir a la línea... Muestra el cuadro de diálogo Ir a la línea para quepueda introducir un número de línea específico enel Editor de reglas y desplazarse a dicha línea.

Menú VerLa siguiente tabla describe las opciones del menú Ver.

Nota: Cualquier cambio que realice en los valores del menú Ver se guardará cuando salga del Editor dereglas y se volverá a aplicar automáticamente la próxima vez que abra el Editor de reglas.

48 IBM Planning Analytics: Referencia de TM1

Nombre Descripción

Ajuste de línea Activa o desactiva la característica de ajuste delínea para que las líneas de texto se extiendanhacia la derecha o se ajusten cuando se muestranen el panel Editar.

Números de línea Activa o desactiva los números de línea.

Ayudas contextuales de funciones Activa o desactiva la visualización de las ayudascontextuales de funciones.

Autocompletar Activa o desactiva la característica autocompletaral escribir en el panel Editar.

Barra de herramientas Activa o desactiva la visualización de la barra deherramientas principal.

Barra de estado Activa o desactiva la visualización de la barra deestado en la parte inferior del Editor de reglas.

Objetos de control Activa o desactiva la visualización de objetos decontrol de TM1 cuando se seleccionan cubos.

Desplegar todas las regiones Despliega todas las regiones definidas por elusuario en la regla actual para mostrar todas laslíneas.

Contraer todas las regiones Contrae todas las regiones definidas por el usuarioen la regla actual para ocultar todas las líneas queestán incluidas en una región.

Menú InsertarLa siguiente tabla describe las opciones del menú Insertar.

Nombre Descripción

Función Muestra el cuadro de diálogo Insertar una funciónpara introducir una nueva función en la reglaactual.

Referencia del cubo Muestra el cuadro de diálogo Insertar referenciadel cubo para que pueda insertar una función DB.

Menú HerramientasLa siguiente tabla describe las opciones del menú Herramientas.

Nombre Descripción

Preferencias... Muestra el cuadro de diálogo Preferencias, en elque puede establecer atributos de fuente como eltipo, el tamaño y el color de fuente que se va autilizar en el panel Editar.

Capítulo 1. Cuadros de diálogo y ventanas 49

Nombre Descripción

Opciones... Muestra el cuadro de diálogo Opciones de control,en el que puede ajustar los valores globales delEditor de reglas.

Cuadro de diálogo Guardar subconjunto

Campo Descripción

Seleccionar o introducir nombre de subconjunto Introduzca un nombre para el subconjuntoguardado o seleccione un nombre en la lista.

Privado Active esta opción para guardar el subconjuntocomo objeto privado. Desactive esta opción paraguardar el subconjunto como objeto público.

Valor predeterminado Active esta opción para guardar el subconjuntocomo subconjunto predeterminado.

Guardar expresión Si el subconjunto es dinámico, active esta opciónpara guardar la expresión MDX con el subconjunto.

Si el subconjunto es dinámico y no activa estaopción, la expresión MDX no se guardará y elsubconjunto que aparece como resultado seráestático, y contendrá los elementos que esténpresentes al guardarlo.

Cuadro de diálogo Guardar vista

Campo Descripción

Seleccionar o introducir una vista con nombre Introduzca un nombre para la vista guardada oseleccione un nombre en la lista.

Privado Active esta opción para guardar la vista comoobjeto privado. Desactive esta opción para guardarla vista como objeto público.

Valor predeterminado Active esta opción para guardar la vista como vistapredeterminada.

Cuadro de diálogo Guardar vista (Navegador de hojas de cálculo)

50 IBM Planning Analytics: Referencia de TM1

Campo Descripción

Nombre de vista Introduzca un nombre para la vista en este campo.

Privado Active esta opción para guardar la vista comoobjeto privado. Desactive esta opción para guardarla vista como objeto público.

Valor predeterminado Active esta opción para guardar la vista como vistapredeterminada.

Cuadro de diálogo Asignaciones de seguridadEl cuadro de diálogo Asignaciones de seguridad le permite asignar privilegios de acceso a cubos,dimensiones, elementos individuales, procesos y tareas. Los privilegios de acceso se asignan por grupode usuarios.

Cuadrícula AsignacionesLa cuadrícula Asignaciones muestra nombres de objeto como cabeceras de fila y grupos de usuarioscomo cabeceras de columna. Los privilegios de acceso aparecen como valores de celda en la intersecciónde un objeto determinado y un grupo de usuarios.

Al acceder al cuadro de diálogo Asignación de seguridad en el grupo Cubes, la cuadrícula incluirá lacolumna Conexión. Esta columna incluirá una casilla de verificación para cada cubo. Para activar laconexión a un cubo, active la casilla de verificación de la intersección del nombre del cubo y la columnaConexión. Para desactivar el registro, desactive la casilla de verificación. El valor predeterminado esActivado.

Privilegios de accesoPulse una de las siguientes opciones para asignar privilegios de acceso a una celda seleccionada de lacuadrícula Asignaciones:

Ningún privilegioLa tabla siguiente describe la posibilidad de que los grupos de usuarios de TM1 accedan a diversosobjetos de TM1 cuando se les asignan privilegios de Ninguno para un objeto.

Objeto Descripción

Cubo Los miembros del grupo no pueden ver el cubo enServer Explorer y, por lo tanto, no puedenexaminarlo.

Elemento Los miembros del grupo no pueden ver el elementoen el Editor de subconjuntos ni en el Editor dedimensiones, ni tampoco las celdas identificadaspor el elemento al examinar un cubo.

Dimensión Los miembros del grupo no pueden ver ladimensión en Server Explorer ni pueden examinarningún cubo que contenga la dimensión.

Capítulo 1. Cuadros de diálogo y ventanas 51

Objeto Descripción

Proceso Los miembros del grupo no pueden ver el procesoen Server Explorer.

Nota: Los privilegios asignados a los procesos sepasan por alto cuando un proceso se ejecuta desdeuna tarea.

Tarea Los miembros del grupo no pueden ver la tarea enServer Explorer.

Aplicación Los miembros del grupo no pueden ver laaplicación ni su contenido en Server Explorer.

Referencia Los miembros del grupo no pueden ver lareferencia en Server Explorer.

Privilegio de lecturaLa tabla siguiente describe la posibilidad de que los grupos de usuarios de TM1 accedan a diversosobjetos de TM1 cuando se les asignan privilegios de lectura para un objeto.

Objeto Descripción

Cubo Los miembros del grupo pueden ver los datos delcubo, pero no pueden editarlos.

Elemento Los miembros del grupo pueden ver los datosidentificados por el elemento, pero no puedeneditarlos.

Dimensión Los miembros del grupo pueden ver los elementosde una dimensión, pero no pueden editar laestructura de dimensiones.

Proceso Los miembros del grupo pueden ver el proceso enServer Explorer y pueden ejecutar el proceso, perono pueden editarlo.

Nota: Los privilegios asignados a los procesos sepasan por alto cuando un proceso se ejecuta desdeuna tarea.

Tarea Los miembros del grupo pueden ver la tarea enServer Explorer y pueden ejecutar manualmente latarea, pero no pueden editarla ni cambiar el estadode activación.

Aplicación Los miembros del grupo pueden ver la aplicación yutilizar todas las referencias que estén dentro de laaplicación para las que tenga, al menos, privilegiosde lectura. Puede crear referencias privadas en laaplicación, y también puede crear subaplicacionesprivadas

52 IBM Planning Analytics: Referencia de TM1

Objeto Descripción

Referencia Los miembros del grupo pueden abrir la referenciay utilizarla, pero no pueden actualizar la referenciaen la aplicación padre. Sin embargo, sí puederealizar la operación "guardar como" para guardaruna nueva versión privada de la referencia enaplicaciones en las que tenga, como mínimo,privilegios de lectura.

Privilegio de escrituraLa tabla siguiente describe la posibilidad de que los grupos de usuarios de TM1 accedan a diversosobjetos de TM1 cuando se les asignan privilegios administrativos respecto a un objeto.

Objeto Descripción

Cubo Los miembros del grupo pueden ver y editar losdatos del cubo, y pueden crear vistas privadas delcubo.

El acceso de escritura no le permite editar losdatos identificados a través de elementosconsolidados o derivados de reglas. Por definición,los valores derivados de consolidaciones o dereglas no pueden editarse.

Elemento Los miembros del grupo pueden ver y editar losdatos identificados a través del elemento.

Dimensión Los miembros del grupo pueden editar atributos deelemento, editar formatos de elemento y crearsubconjuntos privados en la dimensión. Losmiembros del grupo también pueden editaratributos de la propia dimensión.

Privilegio de reservaLa tabla siguiente describe la posibilidad de que los grupos de usuarios de TM1 accedan a diversosobjetos de TM1 cuando se les asignan privilegios de reserva de un objeto.

Tenga en cuenta que al reservar un objeto, dicha reserva caducará cuando el servidor que contiene elobjeto se apague.

Objeto Descripción

Cubo Los miembros del grupo pueden ver y editar losdatos del cubo, y pueden reservar el cubo paraimpedir que otros clientes editen los datos delcubo. Puede liberar un cubo que haya reservado.

Elemento Los miembros del grupo pueden ver y editar losdatos identificados a través del elemento, ypueden reservar el elemento para impedir queotros usuarios editen los datos. Puede liberar unelemento que haya reservado.

Capítulo 1. Cuadros de diálogo y ventanas 53

Objeto Descripción

Dimensión Los miembros del grupo pueden añadir, borrar yreordenar elementos de la dimensión, y puedenreservar la dimensión para impedir que otrosusuarios editen la estructura de dimensiones.Puede liberar una dimensión que haya reservado.

Privilegio de bloqueoLa tabla siguiente describe la posibilidad de que los grupos de usuarios de TM1 accedan a diversosobjetos de TM1 cuando se les asignan privilegios de bloqueo de un objeto.

Tenga en cuenta que no existen privilegios de desbloqueo, y que únicamente los usuarios que tenganprivilegios administrativos de un objeto podrán desbloquear dicho objeto.

Objeto Descripción

Cubo Los miembros del grupo pueden ver y editar losdatos del cubo, y pueden bloquearlo.

Cuando un cubo está bloqueado, nadie puedeactualizar sus datos.

Elemento Los miembros del grupo pueden ver y editar losdatos identificados a través del elemento, ypueden bloquear el elemento.

Cuando se bloquea un elemento, nadie puedeactualizar los datos identificados a través delelemento.

Dimensión Los miembros del grupo pueden añadir, borrar yreordenar elementos de la dimensión, y puedenbloquear la dimensión para impedir que otrosusuarios editen la estructura de dimensiones.

Cuando una dimensión está bloqueada, nadiepuede editar la estructura de dimensiones.

Privilegio administrativoLa tabla siguiente describe la capacidad de los grupos de usuarios de TM1 para acceder a diversosobjetos de TM1 cuando se les asignan privilegios administrativos respecto a un objeto.

Objeto Descripción

Cubo Los miembros del grupo pueden leer, escribir,reservar, liberar, bloquear, desbloquear y borrar elcubo.

Elemento Los miembros del grupo pueden ver, actualizar yborrar celdas identificadas a través del elemento.Pueden reservar, liberar, bloquear y desbloquear elelemento. También pueden otorgar privilegios deacceso de este elemento a otros usuarios.

54 IBM Planning Analytics: Referencia de TM1

Objeto Descripción

Dimensión Los miembros del grupo pueden añadir, borrar yreordenar los elementos de la dimensión. Puedenreservar, liberar, bloquear y desbloquear ladimensión. También pueden crear subconjuntospúblicos de la dimensión y otorgar privilegios deacceso de la dimensión a otros usuarios.

Aplicación Los miembros del grupo pueden ver la aplicación,utilizar referencias dentro de la aplicación y crearreferencias públicas y privadas en la aplicación.También pueden crear subaplicaciones públicas yprivadas.

Cuando un grupo cuenta con un privilegioadministrativo con respecto a una aplicación, losmiembros del grupo pueden establecer privilegiosde seguridad en todas las referencias ysubaplicaciones de la aplicación en otros grupos,pero no en el suyo propio.

Referencia Los miembros del grupo pueden utilizar lareferencia, así como actualizar o borrar lareferencia. Pueden publicar referencias privadas yprivatizar referencias públicas.

Seleccionar dimensiónAl acceder al cuadro de diálogo Asignación de seguridad desde una dimensión individual, estarádisponible la opción Seleccionar dimensión. Esta opción le permite asignar privilegios de acceso aelementos de varias dimensiones.

Tras asignar privilegios de acceso a una dimensión, pulse Guardar y, a continuación, seleccione unanueva dimensión en la lista Seleccionar dimensión. Al finalizar la asignación de privilegios de todas lasdimensiones deseadas, pulse Aceptar para cerrar el cuadro de diálogo.

Cuadro de diálogo Seleccionar cuboSeleccione el nombre de cubo que desee insertar en la hoja de trabajo o fórmula y pulse Aceptar.

Cuadro de diálogo Seleccionar cubo para reglasSeleccione el cubo para el que desee crear una nueva regla y pulse Aceptar.

Cuadro de diálogo Seleccionar dimensiónSeleccione el nombre de dimensión que desee insertar en la hoja de trabajo o fórmula y pulse Aceptar.

Cuadro de diálogo Seleccionar elementoSeleccione el nombre de elemento que desee insertar en la hoja de trabajo o fórmula y pulse Aceptar.

Capítulo 1. Cuadros de diálogo y ventanas 55

Server Explorer (ventana principal)

Panel de la izquierda (panel de árbol)

Muestra una representación jerárquica de todos los objetos de los servidores a los que está actualmenteconectado.

Panel de la derecha (Panel Propiedades)

Muestra las propiedades del objeto seleccionado en el panel de la izquierda de Server Explorer. Laspropiedades varían en función del objeto seleccionado.

Menú ArchivoLas siguientes opciones están disponibles en el menú Archivo en Server Explorer.

Elemento de menú Descripción

Opciones Abre el cuadro de diálogo Opciones de TM1.

Apagar servidor local Apaga el servidor local y le solicita que guarde loscambios en los datos. Esta opción está disponibleúnicamente cuando el servidor local se estáejecutando.

Iniciar servidor local Inicia el servidor local. Esta opción está disponibleúnicamente cuando el servidor local no se estáejecutando.

Actualizar servidores disponibles Actualiza la visualización de los servidoresdisponibles en el panel de la izquierda de ServerExplorer.

Salir Cierra Server Explorer y las demás ventanasrelacionadas con TM1 Perspectives/TM1 Architect.

Menú dinámicoLas opciones disponibles en el segundo menú de Server Explorer varían en función del tipo de objetoactualmente seleccionado.

Grupo de servidoresLas siguientes opciones están disponibles en el menú TM1 cuando se selecciona el grupo de servidoresen Server Explorer.

Opción Descripción

Guardar todos los datos Guarda los datos de todos los servidores a los queestá actualmente conectado.

ServidorLas siguientes opciones están disponibles en el menú Servidor al seleccionar un servidor individual enServer Explorer.

56 IBM Planning Analytics: Referencia de TM1

Opción Descripción

Guardar datos Guarda todas las ediciones de los datos en elservidor seleccionado.

Reiniciar (borrar memoria para el servidor local) Apaga y reinicia el servidor local. Al seleccionaresta opción, puede reciclar y guardar los datos enel servidor local o reciclar y abandonar los cambiosen el servidor local.

Apagar Apaga el servidor local. Esta opción está disponibleúnicamente cuando se selecciona el servidor local.

Seguridad, Clientes/Grupos Abre el Editor de clientes/grupos del servidorseleccionado. Debe tener privilegiosadministrativos del servidor para acceder al Editorde clientes/grupos.

Seguridad, Cambiar contraseña Abre el cuadro de diálogo Cambiar contraseña, enel que puede cambiar la contraseña del servidorseleccionado.

Seguridad, Actualizar seguridad Actualizar todas las asignaciones/estructuras deseguridad del servidor seleccionado.

Capítulo 1. Cuadros de diálogo y ventanas 57

Opción Descripción

Asignación de funciones Permite al administrador establecer permisos paracaracterísticas específicas por grupo de usuarios.En la intersección del grupo de usuarios y lafunción, los administradores pueden establecerOtorgar o Denegar (al igual que En blanco) paraactivar o desactivar dicha función. Algunos valoresde la función pueden ignorarse en función de losvalores de configuración establecidos en elservidor.

Las siguientes funciones pueden establecerse porgrupo de usuario:

• Bloquear acceso a Server Explorer

Para evitar que se lance Server Explorer, pulse laintersección de esta función y el grupo deusuario y seleccione Otorgar. En blanco oDenegar significa que Server Explorer estásiendo utilizado por este grupo de usuarios.

• Modo de reescritura de Espacio de trabajopersonal

Para activar la utilización de espacios de trabajopersonales por parte de un grupo de usuarios,pulse la intersección del grupo de usuarios y estafunción y seleccione Otorgar. En blanco oDenegar significa que este grupo de usuarios noutiliza espacios de trabajo personales.

Si DisableSandboxing está establecido como T,se ignora esta asignación de funciones.

• Recinto de pruebas

Para activar la utilización de recintos de pruebaspor parte de un grupo de usuarios para crearvarios escenarios posibles, pulse la interseccióndel grupo de usuarios y esta función y seleccioneOtorgar. En blanco o Denegar significa que estegrupo de usuarios no puede utilizar variosrecintos de pruebas.

Si DisableSandboxing está establecido como T,se ignora esta asignación de funciones.

Para obtener más información, consulte ladocumentación TM1 Operations y TM1 Architect,Perspectives, and TM1 Web.

Ver registro de transacciones Abre el cuadro de diálogo Consulta del registro detransacciones, en el que puede ver un registro detransacciones del servidor seleccionado.

Ver registro de mensajes Abre el cuadro de diálogo Registro de mensajes,que muestra mensajes registrados en el servidorseleccionado.

58 IBM Planning Analytics: Referencia de TM1

Opción Descripción

Iniciar supervisión de rendimiento Inicia la supervisión de rendimiento. Cuando elcontrol de rendimiento se está ejecutando, TM1llena varios cubos de control, lo que le permitesupervisar las estadísticas de los cubos, losclientes y el servidor.

Detener supervisión de rendimiento Detiene la supervisión de rendimiento.

Actualizaciones diferidas, Iniciar actualizacionespor lotes

Inicia las actualizaciones por lotes que se van aenviar al servidor seleccionado.

Actualizaciones diferidas, Finalizar actualizacionespor lotes

Finaliza las actualizaciones por lotes y envía todaslas ediciones al servidor seleccionado.

Gestor de servidor Abre el cuadro de diálogo Centro de mensajes declientes, en el que puede apagar el servidorseleccionado, desconectar clientes y difundirmensajes.

Cancelar apagado Cancela el apagado de un servidor ejecutadopreviamente.

Desconectarse a sí mismo Desconecta su cliente del servidor seleccionado.

¿Quién soy? Devuelve un mensaje que indica su nombre deusuario en el servidor.

AplicacionesLas siguientes opciones están disponibles en el menú Aplicaciones al seleccionar el grupo Aplicaciones ouna aplicación individual en Server Explorer.

Opción Descripción

Abrir Despliega la aplicación seleccionada o el grupoAplicaciones para mostrar las referencias y lassubaplicaciones.

Cerrar Contrae la aplicación seleccionada o el grupoAplicaciones para ocultar las referencias y lassubaplicaciones.

Borrar Borra la aplicación seleccionada. Al borrar unaaplicación, todas las subaplicaciones y referenciasde la aplicación se borrarán automáticamente. Estaopción no está disponible cuando se selecciona elgrupo Aplicaciones.

Renombrar Establece el nombre de aplicación seleccionado enel modo de edición, por lo que puede introducir unnuevo nombre para la aplicación. Esta opción noestá disponible cuando se selecciona el grupoAplicaciones.

Capítulo 1. Cuadros de diálogo y ventanas 59

Opción Descripción

Seguridad, Asignaciones de seguridad Abre la ventana Asignaciones de seguridad deTM1, en la que puede asignar privilegios deseguridad a las referencias y subaplicacionesinmediatas incluidas en la aplicación seleccionadao en el grupo Aplicaciones.

Seguridad, Publicar Seleccione esta opción para publicar unaaplicación privada. Al publicar una aplicación,todas las subaplicaciones y referencias privadas aobjetos públicos de la aplicación también sepublican automáticamente. Esta opción no estádisponible cuando se selecciona el grupoAplicaciones.

Seguridad, Privatizar Seleccione esta opción para privatizar unaaplicación pública. Al privatizar una aplicación,todas las subaplicaciones y referencias públicas dela aplicación también se privatizaránautomáticamente. Esta opción no está disponiblecuando se selecciona el grupo Aplicaciones.

CubosLas siguientes opciones están disponibles en el menú Cubos al seleccionar un grupo de cubos en ServerExplorer.

Opción Descripción

Crear nuevo cubo Abre el cuadro de diálogo Creación de cubos.

Editar atributos Abre el Editor de atributos del cubo seleccionado.

Asignaciones de seguridad Abre el cuadro de diálogo Asignaciones deseguridad de TM1 en los cubos del grupo de cubosseleccionado. Debe ser miembro del grupo Admindel servidor que contenga el grupo de cubos paraacceder a este cuadro de diálogo.

CuboLas siguientes opciones están disponibles en el menú Cubo al seleccionar un cubo en Server Explorer.

Opción Descripción

Examinar Abre el cubo que se va a examinar en la ventanaCube Viewer.

Examinar en Excel Abre el cubo que se va a examinar en la ventanaNavegador de hojas de cálculo.

Elegir Copia el nombre del cubo en el portapapeles.

Crear nuevo cubo Abre el cuadro de diálogo Creación de cubos.

60 IBM Planning Analytics: Referencia de TM1

Opción Descripción

Descargar cubo Descarga el cubo seleccionado de la memoria delservidor.

Borrar cubo Borra el cubo seleccionado y todos los datosasociados. Debe tener privilegios administrativospara borrar un cubo

Reordenar dimensiones Abre la ventana Optimizador del cubo, en la quepuede optimizar el orden de las dimensiones delcubo seleccionado.

Crear regla Abre el Editor de reglas, en el que puede crear unaregla para el cubo seleccionado.

Borrar regla Borra la regla asociada al cubo seleccionado. Debetener privilegios administrativos de un cubo parapoder borrar la regla asociada.

Exportar como datos ASCII Exporta los datos contenidos en el cuboseleccionado a un archivo ASCII delimitado porcomas (.cma).

Sincronizar datos Sincroniza los datos del cubo seleccionado condatos del servidor de réplica asociado.

Seguridad, Reservar Reserva de forma temporal el cubo seleccionadopara que otros clientes no puedan editar los datosdel cubo. Debe tener privilegios de reserva parareservar un cubo.

Seguridad, Liberar Libera un cubo que ha reservado para que otrosclientes puedan editar los datos del cubo. Debetener privilegios de reserva para liberar un cubo.

Seguridad, Bloquear Bloquea de forma permanente el cuboseleccionado para que otros clientes no puedaneditar los datos del cubo. El cliente con el que hainiciado la sesión también quedará bloqueado paraestos elementos. Debe tener privilegios de bloqueopara bloquear un cubo.

Seguridad, Desbloquear Desbloquea el cubo seleccionado para que otrosclientes no puedan editar los datos. Debe tenerprivilegios administrativos para desbloquear uncubo.

Propiedades Abre el cuadro de diálogo Propiedades del cubo,en el que puede establecer las dimensiones demedidas y tiempo.

DimensionesLas siguientes opciones están disponibles en el menú Dimensiones al seleccionar un grupo dedimensiones en Server Explorer.

Capítulo 1. Cuadros de diálogo y ventanas 61

Opción Descripción

Crear nueva dimensión Abre la ventana Editor de dimensiones, en la quepuede crear una nueva dimensión.

Editar atributos Abre la ventana Editor de atributos, en la quepuede asignar y editar atributos para todas lasdimensiones del grupo seleccionado.

Asignaciones de seguridad Abre el cuadro de diálogo Asignaciones deseguridad de TM1, en el que puede asignar losprivilegios de seguridad para cada dimensión delgrupo. Debe ser miembro del grupo Admin parautilizar esta opción.

DimensiónLas siguientes opciones están disponibles en el menú Dimensión al seleccionar una dimensión en ServerExplorer.

Opción Descripción

Insertar nuevo subconjunto Abre la ventana Editor de subconjuntos de ladimensión.

Elegir Copia el nombre de la dimensión en elportapapeles.

Editar estructura de dimensiones Abre la dimensión seleccionada que se va a editaren la ventana Editor de dimensiones. Debe tenerprivilegios de escritura para la dimensiónseleccionada para poder utilizar esta opción.

Crear nueva dimensión Abre una ventana Editor de dimensiones vacía, enla que puede crear una nueva dimensión. Debe sermiembro del grupo Admin para poder crear unanueva dimensión.

Exportar dimensión Exporta las dimensiones seleccionadas como unarchivo delimitado por comas (.cma).

Eliminar dimensión Elimina la dimensión seleccionada. Debe sermiembro del grupo Admin para poder eliminar unadimensión.

Establecer el orden de los elementos Abre el cuadro de diálogo Ordenar elementos dedimensiones, en el que puede establecer el ordende los elementos de la dimensión seleccionada.

Editar atributos de elemento Abre la ventana Editor de atributos, en la quepuede asignar y editar atributos para todos loselementos de la dimensión seleccionada.

Sincronizar datos Sincroniza los datos de la dimensión seleccionadacon datos asociados de cualquier servidorreplicado.

62 IBM Planning Analytics: Referencia de TM1

Opción Descripción

Seguridad, Reservar Reserva de forma temporal la dimensiónseleccionada para que los demás clientes nopuedan editar la estructura de dimensiones. Debetener privilegios de reserva para reservar unadimensión. Tenga en cuenta que esta opciónreserva sólo la estructura de dimensiones. Noreserva los datos identificados a través de loselementos de la dimensión seleccionada.

Seguridad, Liberar Libera una dimensión reservada para que otrosclientes puedan editar la estructura dedimensiones. Debe tener privilegios de reservapara liberar una dimensión. Tenga en cuenta queesta opción libera sólo la estructura dedimensiones. No libera los datos identificados através de los elementos de la dimensiónseleccionada.

Seguridad, Bloquear Bloquea de forma permanente la dimensiónseleccionada para que otros clientes no puedaneditar la estructura de dimensiones. Debe tenerprivilegios de bloqueo para bloquear unadimensión. Tenga en cuenta que esta opciónbloquea sólo la estructura de dimensiones. Nobloquea los datos identificados a través de loselementos de la dimensión seleccionada.

Seguridad, Desbloquear Desbloquea la dimensión seleccionada para queotros clientes puedan editar la estructura dedimensiones. Debe tener privilegiosadministrativos para desbloquear una dimensión.Tenga en cuenta que esta opción desbloquea sólola estructura de dimensiones. No desbloquea losdatos identificados a través de los elementos de ladimensión seleccionada.

Seguridad, Asignaciones de seguridad deelementos

Abre el cuadro de diálogo Asignaciones deseguridad de TM1, en el que puede asignar losprivilegios de seguridad para cada elemento de ladimensión. Debe tener privilegios de escritura parala dimensión seleccionada para poder utilizar estaopción.

CubeViewsLas siguientes opciones están disponibles en el menú CubeViews al seleccionar un grupo de vistas enServer Explorer.

Opción Descripción

Crear vista nueva Abre la ventana Cube Viewer, en la que puedeconfigurar una nueva vista.

Capítulo 1. Cuadros de diálogo y ventanas 63

CubeViewLas siguientes opciones están disponibles en el menú CubeView al seleccionar una vista en ServerExplorer.

Opción Descripción

Examinar Abre la vista en la ventana Cube Viewer.

Examinar en Excel Abre la vista en el Navegador de hojas de cálculo.

Exportar como datos de texto Abre la ventana Extracción de vistas, desde la quepuede exportar la vista como archivo delimitadopor comas (.cma).

Publicar Esta opción está disponible al seleccionar una vistaprivada. Seleccione esta opción para convertir unavista privada en pública. Las vistas públicas estándisponibles para todos los clientes con privilegiosde lectura del cubo que contiene la vista.

Borrar vista Borra la vista seleccionada. Tenga en cuenta queesta opción sólo borra la configuración de la vista,no los datos que contiene la vista.

SubconjuntosLas siguientes opciones están disponibles en el menú Subconjuntos al seleccionar un grupo desubconjuntos en Server Explorer.

Opción Descripción

Insertar nuevo subconjunto Abre la ventana Editor de subconjuntos, en la quepuede definir un nuevo subconjunto.

SubconjuntoLas siguientes opciones están disponibles en el menú Subconjunto al seleccionar un subconjunto enServer Explorer.

Opción Descripción

Abrir Abre el subconjunto seleccionado en la ventanaEditor de subconjunto.

Crear nuevo subconjunto Abre la ventana Editor de subconjuntos de ladimensión a la que pertenece el subconjuntoseleccionado. Puede definir un nuevo subconjuntoen esta ventana

Publicar Esta opción está disponible al seleccionar unsubconjunto privado. Seleccione esta opción paraconvertir un subconjunto privado en público. Lossubconjuntos públicos están disponibles paratodos los clientes con privilegios de lectura de ladimensión que contiene el subconjunto.

64 IBM Planning Analytics: Referencia de TM1

Opción Descripción

Borrar subconjunto Borra el subconjunto seleccionado. Tenga encuenta que esta opción sólo borra la configuracióndel subconjunto, y no borra los elementoscontenidos en el subconjunto de la dimensiónpadre.

RéplicasLas siguientes opciones están disponibles en el menú Réplicas al seleccionar un grupo de réplicas enServer Explorer.

Opción Descripción

Insertar nueva réplica Abre el cuadro de diálogo Crear objeto de réplicade servidor, en el que puede establecer una nuevaconexión de réplica.

RéplicaLas siguientes opciones están disponibles en el menú Réplica al seleccionar una réplica en ServerExplorer.

Opción Descripción

Sincronizar datos Sincroniza datos entre los servidores de destino yde origen.

Modificar parámetros de réplica Abre el cuadro de diálogo Crear objeto de réplicade servidor, en el que puede modificar losparámetros de la conexión de réplica seleccionada.

Borrar réplica Borra la conexión de réplica seleccionada.

Mostrar tareas involucradas Abre el cuadro de diálogo Seleccionar tareas paramodificar. Puede utilizar este cuadro de diálogopara eliminar la réplica seleccionada de cualquiertarea asociada.

Cubo replicadoLas siguientes opciones están disponibles en el menú Cubo al seleccionar un cubo replicado en ServerExplorer.

Opción Descripción

Replicar Abre el cuadro de diálogo Replicar cubo del cuboseleccionado, en el que puede definir losparámetros de réplica y replicar el cubo.

Sincronizar datos Sincroniza datos entre el cubo replicado y elservidor de origen.

ProcesosLas siguientes opciones están disponibles en el menú Procesos al seleccionar un grupo de procesos enServer Explorer.

Capítulo 1. Cuadros de diálogo y ventanas 65

Opción Descripción

Crear nuevo proceso Abre TurboIntegrator, donde puede crear un nuevoproceso.

Asignaciones de seguridad Abre el cuadro de diálogo Asignaciones deseguridad de TM1, en el que puede establecer losprivilegios de seguridad de procesos en el servidoractual.

ProcesoLas siguientes opciones están disponibles en el menú Proceso al seleccionar un proceso en ServerExplorer.

Opción Descripción

Mostrar tareas involucradas Abre el cuadro de diálogo Seleccionar tareas paramodificar. Puede utilizar este cuadro de diálogopara eliminar el proceso seleccionado de cualquiertarea asociada.

Editar proceso Abre el proceso seleccionado en la ventanaTurboIntegrator.

Ejecutar proceso Ejecuta el proceso seleccionado.

Vista Permite visualizar un proceso en el modo de sólolectura. Permite a los miembros de los gruposDataAdmin y SecurityAdmin visualizar un procesoen el modo solo lectura, cuando la opción Acceso aseguridad está habilitada para el proceso.

Acceso a seguridad Controla si un proceso está capacitado paramodificar los datos de seguridad en la secuenciade comandos del proceso. Sólo los miembros delos grupos ADMIN y SecurityAdmin puedenestablecer esta opción. Esta opción puede definirlade forma independiente para cada proceso.

Borrar proceso Borra el proceso seleccionado.

Utilizar el recinto de pruebas activo Configura el proceso para que utilice los datos delrecinto de pruebas activo actual, al ejecutar enproceso, en lugar de los datos básicos. El recintode pruebas activo está determinado por el recintode pruebas actualmente seleccionado en CubeViewer.

TareasLas siguientes opciones están disponibles en el menú Tareas al seleccionar un grupo de tareas en ServerExplorer.

66 IBM Planning Analytics: Referencia de TM1

Opción Descripción

Crear nueva tarea Abre el Asistente para la configuración de tareas,en el que puede planificar una nueva tarea.

Asignaciones de seguridad Abre el cuadro de diálogo Asignaciones deseguridad de TM1, en el que puede establecer losprivilegios de seguridad para las tareas en elservidor actual.

TareaLas siguientes opciones están disponibles en el menú Tarea al seleccionar una tarea individual en ServerExplorer.

Opción Descripción

Activar planificación Esta opción alterna el estado de ejecución de lastareas. Seleccione esta opción para activar la tareaseleccionada que se va a ejecutar. Cuando seactive una tarea, aparecerá una marca de selecciónjunto a esta opción.

Seleccione esta opción de nuevo para desactivar latarea seleccionada.

Editar Abre la tarea para editarla en el Asistente para laconfiguración de tareas.

Debe desactivar una tarea antes de editarla.

Ejecutar Ejecuta la tarea seleccionada.

Borrar Borra la tarea seleccionada.

Debe desactivar una tarea antes de borrarla.

Menú EditarLas siguientes opciones están disponibles en el menú Editar en Server Explorer.

Opción Descripción

Copiar Copia la etiqueta del objeto seleccionado en elportapapeles.

Borrar Borra el objeto seleccionado del servidor.

Menú VerLas siguientes opciones están disponibles en el menú Ver en Server Explorer.

Opción Descripción

Barra de estado Oculta o muestra la barra de estado en la parteinferior de la ventana Server Explorer. Una marcade selección indica que se muestra la barra deestado.

Capítulo 1. Cuadros de diálogo y ventanas 67

Opción Descripción

Barra de herramientas Oculta o muestra la barra de herramientas en laparte superior de la ventana Server Explorer. Unamarca de selección indica que se muestra la barrade herramientas.

Ventana Propiedades Oculta o muestra el panel Propiedades de ServerExplorer. Una marca de selección indica que semuestra el panel Propiedades.

Objetos:

Aplicaciones

Cubos

Dimensiones

Réplicas

Procesos

Tareas

Oculta o muestra cualquiera de los objetos en elpanel de la izquierda (panel de árbol) de ServerExplorer.

Una marca de selección indica que se muestra elobjeto seleccionado.

Contraer todos los hijos Contrae el árbol del panel de la izquierda de ServerExplorer para ocultar todos los hijos de un objetoseleccionado.

Desplegar todos los hijos Despliega el árbol del panel de la izquierda deServer Explorer para mostrar todos los hijos de unobjeto seleccionado.

Mostrar objetos de control Oculta o muestra las dimensiones y los cubos decontrol en el panel de la izquierda de la ventanaServer Explorer. Una marca de selección indica quese muestran los objetos de control.

Actualizar Actualiza la visualización jerárquica actual de losobjetos en el panel de la izquierda de ServerExplorer.

Editor de subconjuntos

Panel Elementos

Muestra una representación jerárquica de todos los elementos del subconjunto que está visualizandoactualmente.

Panel Propiedades

Muestra las propiedades de los elementos seleccionados en el panel Elementos del Editor desubconjuntos. Al seleccionar un elemento consolidado, este panel muestra los nombres, tipos y pesos detodos los hijos del elemento consolidado.

Nota: Al visualizar un conjunto de dimensiones excepcionalmente grande en el Editor de subconjuntoscon el panel Propiedades activado, es posible que tenga problemas de rendimiento. Esto puede ocurrir

68 IBM Planning Analytics: Referencia de TM1

cuando selecciona una consolidación en el panel Elementos y TM1 tiene que mostrar la lista completa depropiedades y elementos relacionados en el panel Propiedades.

Si trabaja con conjuntos de dimensiones grandes, es posible que desee desactivar el panel Propiedades.Para desactivar el panel Propiedades, pulse la opción Ventana de propiedades en el menú Ver paraeliminar la marca de selección situada junto a la opción.

Menú Subconjunto

Elemento de menú Descripción

Abrir Abre el cuadro de diálogo Guardar subconjunto deTM1. Seleccione un subconjunto en la lista y pulseAceptar para abrir el subconjunto.

Recargar Vuelve a cargar la definición del subconjuntoactual.

Guardar Guarda la definición del subconjunto actual.

Guardar como Guarda la definición del subconjunto actual con unnuevo nombre.

Cerrar Cierra el Editor de subconjuntos.

Menú Editar

Elemento de menú Descripción

Deshacer Deshace la última acción.

Rehacer Restaura la última acción de "deshacer".

Cortar Corta los elementos seleccionados y los coloca enel portapapeles.

Copiar Copia los elementos seleccionados en elportapapeles.

Copiar nombre exclusivo Copia el nombre de elemento, como expresiónMDX, en el portapapeles. El nombre de elementocopiado se puede pegar en la ventana Expresióndel Editor de subconjuntos.

Pegar Pega el contenido del portapapeles en el punto deinserción actual.

Pegar por encima Pega el contenido del portapapeles encima delelemento seleccionado actualmente.

Pegar por debajo Pega el contenido del portapapeles debajo delelemento seleccionado actualmente.

Capítulo 1. Cuadros de diálogo y ventanas 69

Elemento de menú Descripción

Insertar subconjunto Abre una nueva instancia del Editor desubconjuntos para que pueda añadir unaconsolidación definida por el usuario alsubconjunto actual.

Mantener Mantiene únicamente los elementos actualmenteseleccionados en el panel Elementos del Editor desubconjuntos, y elimina los demás elementos.

Borrar Borra los elementos seleccionados de la definicióndel subconjunto actual.

Elegir elementos, Horizontal Copia los elementos seleccionados en elportapapeles con orientación horizontal, por lo quepueden pegarse en una fila de una hoja de trabajo.

Elegir elementos, Vertical Copia los elementos seleccionados en elportapapeles con orientación vertical, por lo quepueden pegarse en una columna de una hoja detrabajo.

Orden, descendente Clasifica todos los elementos del panel Elementosen orden alfabético descendente.

Orden, ascendente Clasifica todos los elementos del panel Elementosen orden alfabético ascendente.

Orden, Jerarquía Ordena todos los elementos del panel Elementosen orden jerárquico, para que pueda ver la relaciónpadre/hijo de los elementos.

Orden, Índice ascendente Ordena todos los elementos del panel Elementosen orden ascendente según el valor de índice delelemento.

Orden, Índice descendente Ordena todos los elementos del panel Elementosen orden descendente según el valor de índice delelemento.

Detallar más Muestra los hijos inmediatos de los elementosseleccionados.

Distribuir Muestra los padres inmediatos de los elementosseleccionados.

Desplegar elemento Muestra todos los hijos de los elementosseleccionados.

Contraer elemento Contrae las consolidaciones seleccionadas paraque no se muestren los hijos.

Filtro por, niveles Abre el cuadro de diálogo Filtro por nivel, en el quepuede seleccionar elementos por nivel jerárquico.

70 IBM Planning Analytics: Referencia de TM1

Elemento de menú Descripción

Filtro por, atributo Abre el cuadro de diálogo Filtro por atributo, en elque puede seleccionar elementos por valor deatributo.

Filtro por, Extracción de vistas Le permite seleccionar únicamente los elementosque se ajusten a una consulta definida por elusuario.

Esta opción está disponible únicamente al abrir elEditor de subconjuntos pulsando una etiqueta dedimensión en la ventana Cube Viewer.

Filtro por, comodín Le permite seleccionar elementos que coincidancon una cadena de búsqueda definida por elusuario.

Seleccionar alias Abre el cuadro de diálogo Alias de TM1, en el quepuede seleccionar un alias definido previamentecon el que visualizar los nombres de elementos.

Seguridad, Reservar Reserva de forma temporal el elementoseleccionado para que otros clientes no puedaneditar los datos identificados a través delelemento. Debe tener privilegios de reserva parareservar un elemento.

Seguridad, Liberar Libera un elemento reservado para que otrosclientes puedan editar los datos identificados através del elemento. Debe tener privilegios dereserva para liberar un elemento.

Seguridad, Bloquear Bloquea de forma permanente el elementoseleccionado para que otros clientes no puedaneditar los datos identificados a través delelemento. Debe tener privilegios de bloqueo parabloquear un elemento.

Seguridad, Desbloquear Desbloquea el elemento seleccionado para queotros clientes puedan editar los datos identificadosa través del elemento. Debe tener privilegiosadministrativos para desbloquear una dimensión.

Editar formatos de elementos Abre la hoja de trabajo Editar formatos deelementos, en la que puede definir estilos devisualización de secciones dinámicas y hojas webde TM1.

Menú Ver

Capítulo 1. Cuadros de diálogo y ventanas 71

Elemento de menú Descripción

Barras de herramientas Abre un submenú que le permite activar odesactivar la visualización de todas las barras deherramientas del Editor de subconjuntos.

Una marca de selección indica que se muestra unabarra de herramientas.

Barra de estado Oculta o muestra la barra de estado en la parteinferior de la ventana Editor de subconjuntos.

Una marca de selección indica que se muestra labarra de estado.

Ventana Propiedades Oculta o muestra el panel Propiedades.

Una marca de selección indica que se muestra elpanel Propiedades.

Ventana Expresión Oculta o muestra la ventana Expresión en la parteinferior del Editor de subconjuntos. Una marca deselección indica que se muestra la ventanaExpresión.

Desplegar por encima Esta opción determina cómo se expanden y secontraen las consolidaciones al detallar más.

Al activar esta opción, los hijos de unaconsolidación se expanden por encima de laconsolidación al detallar más.

Al desactivar esta opción, los hijos de unaconsolidación se expanden por debajo de laconsolidación al detallar más.

Al activar la opción Desplegar por encima en unsubconjunto, al detallar más en una consolidaciónen Cube Viewer, el Navegador de hojas de cálculoo en la sección, el comportamiento será elsiguiente:

Si la opción está activada en un subconjunto defilas, al detallar más en una consolidaciónaparecerán los hijos por encima de laconsolidación.

Si la opción está activada en un subconjunto decolumnas, al detallar más en una consolidaciónaparecerán los hijos a la izquierda de laconsolidación.

Actualizar Actualiza la visualización del panel Elementos.

Menú Herramientas

72 IBM Planning Analytics: Referencia de TM1

Elemento de menú Descripción

Registrar expresión Inicia el registro de las acciones en el Editor desubconjuntos.

Detener registro Detiene el registro de las acciones en el Editor desubconjuntos.

Al detener el registro, TM1 genera una expresiónMDX que se puede guardar para crear unsubconjunto dinámico.

Borrar expresión Borra el contenido de la ventana Expresión.

Filtro Abre el cuadro de diálogo Filtrar subconjunto, quele permite crear un subconjunto dinámico basadoen los valores del cubo.

Cuadro de diálogo AliasPara ver los elementos del subconjunto actual en función de los alias asignados, seleccione un nombre dealias en la lista y pulse Aceptar.

Cuadro de diálogo Opciones de TM1En el cuadro de diálogo Opciones de TM1 se pueden establecer las opciones siguientes.

Parámetros de inicio de sesión

Opción Descripción

Host de administración Introduzca el nombre del sistema del host deadministración. El host de administración es elsistema en el que se ejecuta el servidor deadministración.

Inicio de sesión integrado Active esta opción para utilizar el inicio de sesiónintegrado.

Desactive esta opción para utilizar la seguridad deinicio de sesión de TM1 estándar.

El valor predeterminado es Desactivado.

Servidor local

Capítulo 1. Cuadros de diálogo y ventanas 73

Opción Descripción

Directorio de datos del servidor local Introduzca la ruta completa del directorio de datosdel servidor local, o pulse el botón adjuntoExaminar para desplazarse hasta el directorio.También puede pulsar la flecha hacia abajo pararealizar una selección en una lista de directorios alos que se ha accedido recientemente.

Conectar al servidor local durante el inicio Desactive esta opción para iniciar TM1Perspectives/TM1 Architect sin lanzar el servidorlocal.

El valor predeterminado es Activado.

Nota: El servidor local solo se admite en las versiones de 32 bits de TM1. El directorio de datospredeterminado del servidor local es Pdata. Si ejecuta una versión de 64 bits de TM1, el servidor deejemplo Sdata, que se instala de forma predeterminada con el servidor de TM1, incluye los mismosobjetos y datos que en Pdata.

TLS (Transport Layer Security) del servidor de administración

Opción Descripción

Entidad emisora de certificados La ruta completa del archivo de la entidad emisorade certificados que emitió el certificado delServidor de administración.

Lista de revocación de certificados La ruta completa del archivo de revocación decertificados emitido por la entidad emisora decertificados que emitió el certificado del Servidorde administración. Sólo existirá un archivo derevocación de certificados, en el caso de que sehaya revocado uno.

ID de certificado El nombre del principal al que se emite elcertificado del Servidor de administración.

Utilizar almacén de certificados Seleccione esta opción si desea que se exporte elcertificado de entidad emisora de certificados queen un principio emitió el certificado del Servidor deadministración desde el almacén de certificados deWindows en tiempo de ejecución.

Cuando se selecciona esta opción, debe tambiénestablecer un valor para ID de certificado deexportación en el cuadro de diálogo Opciones deTM1.

ID de certificado de exportación La clave de identidad empleada para exportar elcertificado de entidad emisora de certificados queen un principio emitió el certificado del Servidor deadministración, desde el almacén de certificados.

Este parámetro sólo es necesario si activa laopción Utilizar almacén de certificados.

74 IBM Planning Analytics: Referencia de TM1

Cuadro de diálogo Consulta del registro de transaccionesEl cuadro de diálogo Consulta del registro de transacciones le permite consultar y ver registros en elregistro de transacciones de TM1 (Tm1s.log). El cuadro de diálogo contiene campos para cuatroparámetros que debe especificar para ejecutar una consulta.

Opción Descripción

Hora de inicio La fecha/hora de inicio de la consulta.

TM1 realiza consultas en todos los registrosescritos en el registro en dicha fecha/hora odespués de dicha fecha/hora. Debe utilizar elformato MM/DD/AAAA HH:MM:SS para especificaruna hora de inicio.

La fecha/hora de inicio predeterminada son las00:01:00 GMT de la fecha en la que se lanzó laconsulta.

Hora de finalización La fecha/hora de finalización de la consulta.

De forma predeterminada es __/__/____ __:__:__,que es una fecha/hora de finalización abierta. Siacepta el valor predeterminado, TM1 consultatodos los registros hasta la hora en la que se halanzado la consulta.

Cliente(s) Los clientes a los que se aplica la consulta. Puederealizar consultas sobre un solo cliente o sobretodos los clientes. De forma predeterminada essobre todos los clientes (*).

Cubo(s) Los cubos a los que se aplica la consulta. Puederealizar consultas sobre un solo cubo o sobre todoslos cubos. De forma predeterminada es sobretodos los cubos (*).

Para establecer cualquiera de los parámetros anteriores, pulse la flecha que aparece junto al campoadecuado.

Cuadro de diálogo Resultados de la consulta del registro de transaccionesEl cuadro de diálogo Resultados de la consulta del registro de transacciones presenta el resultado de unaconsulta del registro de transacciones en formato de tabla. La tabla contiene las siguientes columnas encada registro que devuelva la consulta:

Columna Descripción

LOGTIME La hora a la que se editó un valor.

REPLICATIONTIME La hora a la que se replicó un valor.

CLIENT El nombre del cliente que escribió el valor.

OLDVALUE El valor de los datos antes de la edición.

Capítulo 1. Cuadros de diálogo y ventanas 75

Columna Descripción

NEWVALUE EL valor de los datos después de la edición.

CUBENAME El cubo en el que se escribió el valor.

KEY N Existen varias columnas Key N en la tabla, y cadacolumna representa los elementos que identificanel valor.

El cuadro de diálogo Resultados de la consulta del registro de transacciones incluye tres menús.

El menú Archivo contiene un único elemento: Salir.

El menú Ayuda contiene un único elemento para abrir la ayuda del cuadro de diálogo.

El menú Editar contiene los siguientes elementos:

Elemento de menú Descripción

Copiar Copia una única celda seleccionada en elportapapeles.

Ocultar Suprime la visualización de los registrosseleccionados en la tabla.

Puede pulsar Actualizar para restaurar lavisualización de los registros ocultos.

Ordenar Abre un submenú en el que puede seleccionar lascolumnas que se van a ordenar o el orden declasificación que se va a aplicar.

Buscar Abre el cuadro de diálogo Buscar/Sustituir, que lepermite buscar la tabla actual.

Seleccionar Selecciona los registros resaltados

Anular selección Anula la selección de los registros resaltados.

Seleccionar todo Selecciona todos los registros de la tabla.

Deseleccionar todo Anula la selección de todos los registros de latabla.

Detener Detiene los registros seleccionados. Al detener unregistro, el valor OLDVALUE del registro sustituyeal valor NEWVALUE del registro.

Al seleccionar varios registros de una únicaubicación del cubo, los registros se detienen en elvalor OLDVALUE del primer LOGTIME.

76 IBM Planning Analytics: Referencia de TM1

Editor de TurboIntegratorEl Editor de TurboIntegrator le permite definir procesos para importar datos o metadatos de variasfuentes posibles. El editor se compone de cinco pestañas, de las que varias son dinámicas o contienensubpestañas. Puede definir un proceso completando cada pestaña en orden secuencial.

Menú Archivo

Elemento de menú Descripción

Guardar Guarda la definición de proceso actual.

Guardar como Guarda la definición de proceso actual con unnuevo nombre.

Ejecutar Ejecuta el proceso actual.

Salir Cierra el Editor de TurboIntegrator.

Menú Editar

Elemento de menú Descripción

Deshacer Deshace la última acción de escritura que serealizó en la subpestaña de procedimiento Prólogo,Metadatos, Datos o Epílogo.

Cortar Corta el texto seleccionado y lo coloca en elportapapeles.

Copiar Copia el texto seleccionado en el portapapeles.

Pegar Pega el contenido del portapapeles en la celda o elcampo actual.

Pestaña Origen de datosUtilice la pestaña Origen de datos para identificar y acceder al origen del que desee importar los datos.

Nota: Al definir un proceso desde un cliente de TM1, la ruta de un origen de datos ASCII u ODBC puedeser distinta de la ruta que utiliza el servidor. Si esto ocurre, el proceso no se realizará correctamente. Paraasegurarse de que los procesos se realizan correctamente:

• Defina los procesos relacionados con los orígenes de datos ODBC en el servidor real en el que va a estarubicado el proceso. No utilice un cliente remoto para definir dicho proceso.

• Utilice Entorno de red en Windows para definir la ruta de los orígenes de datos ASCII. Esto asegura quela ruta no es ambigua ni para los clientes ni para los servidores.

Los campos y opciones disponibles en la pestaña Origen de datos varían en función del tipo de origen dedatos que seleccione. La siguiente tabla describe las opciones y campos necesarios para cada fuente.

ODBCDefinir un origen de datos ODBC:

Capítulo 1. Cuadros de diálogo y ventanas 77

Campos Descripción

Nombre de origen de datos La ruta completa al origen de datos ODBC.

UserName Su nombre de usuario en la fuente.

Contraseña Su contraseña.

Consulta Una consulta SQL para extraer datos de la fuente.

Utilizar Unicode Marque esta opción para utilizar Unicode en estafuente.

Vista previa Muestra los 10 primeros registros.

TextoDefinir un origen de datos ASCII o de texto:

Campos Descripción

Nombre de origen de datos La ruta completa al archivo de texto de la fuente.Para asegurarse de que esta ruta sea reconocibletanto para el cliente como para el servidor, pulse elbotón Examinar y utilice el Entorno de red paradefinir la ruta.

Nombre del origen de datos del servidor Al crear un nuevo proceso, TurboIntegratorpresupone que el nombre del origen de datos delservidor es idéntico al nombre del origen de datosutilizado para crear el proceso.

Si el nombre del origen de datos del servidordifiere del origen de datos local utilizado para crearel proceso, introduzca la ruta completa del archivode origen de datos del servidor.

Tipo de delimitador Si la fuente utiliza un carácter para definir lascolumnas, seleccione Delimitado y, acontinuación, seleccione el carácter en el cuadroDelimitador.

Anchura fija Si la fuente utiliza una anchura fija, seleccioneAncho fijo y, a continuación, utilice el botónEstablecer anchos de campo para abrir el cuadrode diálogo Vista previa para establecer anchos decolumna.

Comillas Especifique las comillas utilizadas en los datos deorigen.

Número de registros de títulos Si los registros de títulos abarcan más de una fila,introduzca aquí el número de filas. De lo contrario,deje este campo en blanco.

Delimitadores de números Introduzca el carácter que desea utilizar en elSeparador decimal y el Separador de millares dela fuente.

78 IBM Planning Analytics: Referencia de TM1

ODBODefina un origen de datos ODBC establecido para una base de datos relacional que pueda crearseutilizando el panel de control Orígenes de datos de Microsoft Windows:

Cubo o dimensiónSeleccionar el tipo de importación que se va a realizar:

Campos Descripción

Proveedor de ODBO Para importar un cubo ODBO, utilice el menúdesplegable para seleccionar la base de datos OLEpara origen de datos OLAP, incluidos los serviciosde Microsoft Analysis Services que desee utilizar.

Ubicación de ODBO Introduzca la ubicación del archivo de esteproveedor.

Al importar una dimensión, deje este campo enblanco.

Origen de datos ODBO Introduzca el nombre que asigna su administradora un conjunto de catálogos de una ubicacióndeterminada. En Microsoft Analysis Services, éstees el nombre de un servidor registrado.

Catálogo ODBO Es el nombre asignado por su administrador a unacolección determinada de bases de datos (cubos,dimensiones y otros objetos). Para MAS, este es elnombre de la base de datos.

ID de usuario de ODBO Un nombre de usuario válido para la base de datos.

Contraseña de ODBO Una contraseña válida de este origen de datos.

Parámetros adicionales de conexión Introduzca aquí los parámetros adicionales quenecesita la fuente ODBO. Delimite los parámetroscon un punto y coma.

Al importar una dimensión, deje este campo enblanco.

Consulta MDXDefinir una consulta basada en MDX:

Campos Descripción

Pestaña Conexión Introduzca la información de conexión necesaria.Los parámetros de conexión son específicos decada proveedor.

Pulse Conectar. Si se conecta correctamente,estará disponible la pestaña Consulta MDX.

Pestaña Consulta MDX Introduzca la consulta MDX en esta pestaña opegue una consulta MDX que esté enfuncionamiento de otra aplicación.

Capítulo 1. Cuadros de diálogo y ventanas 79

SAPDefine el origen de datos RFC SAP:

Pestaña Campo Descripción

Conexión Sistema Nombre del sistema SAP al quedesea conectarse.

Si el nombre del sistema incluyeespacios, ponga el nombre entrecomillas dobles.

Cliente Un número que corresponde a laversión de interfaz de usuario delservidor SAP. Por ejemplo, 498.

Usuario Su nombre de usuario en elsistema SAP.

Contraseña Su contraseña en el sistema SAP.

Idioma Idioma que desea utilizar parainiciar sesión en el sistema SAP.

Todas las descripcionestextuales se cambian al idiomaespecificado si está disponible.

El parámetro de idioma es unaabreviatura de dos letras, porejemplo, EN=English.

Parámetros adicionales deconexión

Introduzca otros parámetros yvalores para utilizarlos alconectarse a su sistema BW SAP.

Tamaño de paquete Valor que limita el número defilas de cada paquete que seenvía de SAP a TM1. Un tamañode paquete reducido daría comoresultado un aumento del tráficode red con paquetes pequeños,mientras que un tamaño mayorresulta en una disminución deltráfico de red pero con paquetesmás grandes por transmisión.

El tamaño de paquetepredeterminado, que es ademásel tamaño mínimo, es 50.000.

80 IBM Planning Analytics: Referencia de TM1

Cubo de información

Área Campo Descripción

Cubo de información Mostrar nombres técnicos SAP Para utilizar nombres técnicos,seleccione esta casilla deverificación. Deje esta casilla sinmarcar para mostrarlos según sunombre descriptivo.

Seleccionar InfoCube para cargardesde

Utilice esta opción para indicar elInfoCube desde el que deseaimportar los datos.

Seleccionar cubo TM1 paracargar en

Para importar el InfoCube SAP aun cubo TM1 existente, pulseesta opción y seleccione el cuboque recibirá los datos delInfoCube SAP.

Seleccionar cubo TM1 paracargar en

Para crear un nuevo cubo TM1cuando importe el InfoCube,introduzca el nombre del nuevocubo TM1 en el campo En.

Acción de cubo TM1 Crear Importa datos y metadatosdesde el InfoCube SAP y crea unnuevo cubo en TM1. Utilice estaopción únicamente cuando noexista en el servidor ninguno delos cubos ni dimensiones queestá importando.

Recrear Destruye un cubo TM1 existentey lo vuelve a crear utilizando losdatos y metadatos del InfoCubeSAP. Utilice esta opción solocuando existan las dimensiones yel cubo TM1 y desee sustituirlospor nuevas estructuras y datosdel InfoCube SAP.

Actualizar Importa datos de un InfoCubeSAP existente y los inserta en uncubo TM1 existente. Esta opciónno cambia la estructura de loscubos ni las dimensiones en elservidor.

Capítulo 1. Cuadros de diálogo y ventanas 81

Área Campo Descripción

Los procesos que especificanNinguna acción no afectan a losdatos o metadatos de los cubosTM1.

Utilice esta opción para probar ydepurar procesos o para definirsus propias operacionespersonalizadas.

Acción de datos Almacenar valores Esta opción escribe valores decelda del InfoCube SAP en elcubo TM1.

Si elige esta opción cuando estáseleccionada la opción Actualizarcubo, se sobrescriben los valoresexistentes del cubo TM1 con losvalores importados del InfoCube.

Acumular valores La opción Acumular valores lepermite agregar valores de cuboTM1 existentes con valoresimportados de un InfoCube SAP.

Porción de puesta a cero delcubo de destino

Esta opción se habilita cuandoselecciona la acción Actualizarcubo.

Seleccione esta opción si deseaestablecer todos los puntos dedatos en una vista de cuboespecífica como cero.

Para definir la vista de cubo comocero, puede:

• Pulsar la lista de Vista paraseleccionar una vista existentey ponerla a cero.

• Pulsar el botón Más junto a lalista opciones de Vista paradefinir una nueva vista paraponer a cero.

82 IBM Planning Analytics: Referencia de TM1

Área Campo Descripción

Activar conexión de cubos Para registrar los cambios en losdatos del cubo mientras importadesde un InfoCube SAP,seleccione esta opción.

Para desactivar el registrodurante la importación, desactiveesta opción.

Nota: Inhabilitar el registroacelera la carga y la actualizaciónde los datos, pero imposibilita larecuperación de cualquieractualización si se produce unerror del sistema.

Pestaña Características

Campo Descripción

Seleccionar jerarquías Identifique las jerarquías delorigen de datos.

Identifique las jerarquías delorigen de datos.

Fecha de evaluación Fecha en la que todos losatributos SAP que dependen deltiempo se importarán a TM1 tal ycomo se encontraban en la fechaespecífica. Los atributos que noson temporales se importancomo se encuentran en elmomento de la ejecución delproceso.

Si se borra esta fecha, todos losatributos SAP se importarán tal ycomo se encuentren en la fechaen la que se ejecute el procesoTM1.

No importe jerarquías conintervalos.

Fecha en la que todos losatributos SAP que dependen deltiempo se importarán a TM1 tal ycomo se encontraban en la fechaespecífica. Los atributos que noson temporales se importancomo se encuentran en elmomento de la ejecución delproceso.

Si se borra esta fecha, todos losatributos SAP se importarán tal ycomo se encuentren en la fechaen la que se ejecute el procesoTM1.

No importe jerarquías conintervalos.

Dimensión TM1 Seleccione la dimensión TM1existente que se correlacione conesta característica.

Deje este campo en blanco si nodesea importar la característicaal cubo TM1.

Seleccione la dimensión TM1existente que se correlacione conesta característica.

Deje este campo en blanco si nodesea importar la característicaal cubo TM1.

Acción de dimensión TM1 Crear Crear una nueva dimensión TM1desde la característica SAP.

Recrear Recrear completamente unadimensión TM1 existente conelementos importados desde lacaracterística SAP.

Capítulo 1. Cuadros de diálogo y ventanas 83

Campo Descripción

Actualizar Actualizar una estructura dedimensiones existente añadiendonuevos elementos importadosdesde la característica SAP.

AsIs Procesar la característica através de TurboIntegrator perosin utilizar la característica paracrear o modificar ninguna de lasdimensiones TM1.

Utilice esta opción para probar ydepurar los procesos, o paramanipular la característica en lapestaña Avanzado deTurboIntegrator.

No cargar No importar la característica SAPa TM1. La característica seexcluye completamente cuandose procesa el InfoCube SAP através de TurboIntegrator.

Seleccionar atributos Atributos de característica Defina los atributos para esteorigen de datos.

Texto Identifica atributos con un valorde cadena.

Numérico Identifica atributos con un valornumérico.

Alias Identifica atributos que sonnombres alternativos para lasdimensiones a las que estánasociados. Un alias de dimensióndebe ser exclusivo con respectoal resto de alias de dimensión onombres de dimensión reales

Seleccionar cifras clave Seleccione cada cifra clave quedesee importar a TM1.

Si las cifras clave secorrelacionan con una dimensiónTM1 existente, pulse la columnaDimensión TM1 y seleccione ladimensión que corresponda a lascifras clave.

Seleccione cada cifra clave quedesee importar a TM1.

Si las cifras clave secorrelacionan con una dimensiónTM1 existente, pulse la columnaDimensión TM1 y seleccione ladimensión que corresponda a lascifras clave.

Restricciones Añadir restricciones Cree una nueva restricción paraesta característica.

84 IBM Planning Analytics: Referencia de TM1

Campo Descripción

Característica SAP Seleccione la característica en laque desee establecer unarestricción.

Signo Indica si la restricción esinclusiva o exclusiva.

Elija Incluir si desea que elproceso TurboIntegrator importesolo aquellos valores que quedendentro de la definición de larestricción.

Elija Excluir si desea que elproceso TurboIntegrator importesolo aquellos valores que quedenfuera de la definición de larestricción.

Opción El Operador utilizado para larestricción.

Puede elegir entre ochooperadores, como se describe enla tabla siguiente.

Opción Operadores de restricción

Operador Descripción

= La restricción identifica solo características igualesal Valor bajo especificado.

< > La restricción identifica únicamente característicasinferiores o superiores al Valor bajo especificado.

< La restricción identifica únicamente característicasinferiores al Valor bajo especificado.

> La restricción identifica únicamente característicassuperiores al Valor bajo especificado.

< = La restricción identifica únicamente característicasinferiores o iguales al Valor bajo especificado.

> = La restricción identifica únicamente característicassuperiores o iguales al Valor bajo especificado.

[ ] La restricción identifica únicamente característicasque quedan entre el Valor bajo y el Valor alto,ambos incluidos.

] [ La restricción identifica únicamente característicasque quedan fuera del Valor bajo y el Valor alto,ambos incluidos.

Capítulo 1. Cuadros de diálogo y ventanas 85

Puede elegir entre ocho operadores, como se describe en la tabla siguiente.

Introduzca un valor bajo para la restricción en la columna Valor bajo.

Introduzca un valor elevado para la restricción, si es necesario, en la columna Valor elevado.

Nota: Las restricciones no se validan a través de TurboIntegrator. Debe asegurarse de que lasrestricciones que introduce son precisas y válidas para sus datos SAP.

Seguridad

Campo Descripción

Importar seguridad Indica que deben importarse las asignaciones deseguridad de esta característica.

Consolidación superior Crea una consolidación de nivel superior para ladimensión de TM1 que se ha creado utilizando elnombre que se introdujo aquí.

Convertir los textos en exclusivos Para crear alias exclusivos para todos loselementos que se crean a partir de la característicaSAP, seleccione esta opción. Cuando importa unacaracterística SAP a TM1, los valores decaracterística se convierten en elementos dedimensión TM1 mientras que las descripciones devalores SAP se convierten en alias de elementos deTM1. En TM1 , todos los alias de elemento de unadimensión deben ser exclusivos. Si un procesoTurboIntegrator intenta asignar el mismo alias avarios elementos, el proceso generará errores yfallará la creación del alias.

Cuando la opción Convertir los textos en exclusivosestá seleccionada, TM1 examina las descripcionesSAP que se han importado y convertido en aliasTM1. Si TM1 detecta que varios valores utilizandescripciones idénticas, TM1 anexa el nombre delvalor a la descripción para generar alias exclusivos.

Si no se selecciona la opción Convertir los textosen exclusivos, no se obtiene ningún datoSAP_Text.

Cuando no está seleccionada la opción Convertirlos textos en exclusivos, puede añadirDataSourceSAPUsingTexts=1; en el prólogopara importar los valores de atributo de alias.

Consulte la función AttrPutS para conseguir elmismo comportamiento utilizando un script TI.

Fecha de evaluación Todos los valores de característica existentes entrela fecha seleccionada y la fecha de ejecución delproceso se importarán a TM1. Si no se haespecificado ninguna fecha de evaluación, la fechapredeterminada será la fecha en la que se ejecutael proceso TurboIntegrator.

86 IBM Planning Analytics: Referencia de TM1

Tabla SAP

Campo Descripción

Tabla SAP Indica que el origen de datos es una consulta detabla SAP.

Nombre de tabla Nombre de la tabla SAP que se va a utilizar.

Cadena de filtros Una cadena de filtros SQL que se utilizará en lacláusula WHERE cuando la sentencia de SQLSELECT que ha generado TurboIntegrator seejecute sobre la tabla SAP.

Tabla ODS

Campo Descripción

Tabla ODS Se utiliza para exportar datos de TM1 en una tablaODS que a continuación puede utilizarse paraimportar datos a través de un InfoCube SAP.

Configuración de ODS Defina los detalles de la tabla ODS.

Examinar Seleccione la vista de TM1 que desee utilizar comoorigen de datos.

Mostrar nombres técnicos Para utilizar nombres técnicos, seleccione estacasilla de verificación. Deje esta casilla sin marcarpara mostrarlos según su nombre descriptivo.

Seleccionar tabla ODS Seleccione la tabla ODS a la que desee exportar.

Capítulo 1. Cuadros de diálogo y ventanas 87

Campo Descripción

Columnas Las columnas pueden ser características SAP ocifras clave. Debe conocer la estructura de lastablas ODS para saber qué columnas soncaracterísticas y cuáles son cifras clave;TurboIntegrator no distingue entre los tipos decolumna de la tabla ODS.

Debe tener en cuenta los siguientes detalles alcorrelacionar dimensiones con las características:

• No tiene que correlacionar una dimensión concada columna de la característica de la tablaODS. Puede que algunas columnas no tenganuna dimensión TM1 correspondiente cuandotermine con la correlación. En ese caso,cualquier columna de la característica que noesté correlacionada se vaciará al finalizar laexportación.

• No debería correlacionar una única dimensiónTM1 con varias columnas de la tabla decaracterísticas de ODS. La interfaz de usuario deTurboIntegrator no le impide hacerlo, pero talcorrelación dará como resultado valores decolumna redundantes en la tabla ODS.

• Cuando correlaciona una dimensión de título devista TM1 con una característica y la dimensiónde título no utiliza un subconjunto con nombre,solo se exportará a la tabla ODS el últimoelemento del actual subconjunto de título sinnombre. Si la dimensión de título sí utiliza unsubconjunto con nombre, todos los elementosdel subconjunto se exportan a la tabla ODS.

Seleccionar medida Se presupone que la última dimensión de la vistadel cubo de origen es la dimensión de medidas.Cuando correlaciona una dimensión de medidascon una columna de la tabla ODS, se habilita elbotón Seleccionar medida.

Seleccione el único elemento que se correlacionadirectamente con la columna de cifras clave de latabla ODS

Si su tabla ODS incluye una única columna decifras clave, también puede utilizar la cifra clavealternativa.

88 IBM Planning Analytics: Referencia de TM1

Campo Descripción

Dimensión TM1 Si su tabla ODS incluye una única columna decifras clave, puede utilizar la opción_TM1CellValue_ para correlacionar valores de cuboTM1 con la tabla ODS. No puede utilizar la opción_TM1CellValue_ si su tabla ODS contiene variascolumnas de cifras clave.

Para utilizar esta opción, no correlacione ladimensión de medidas de TM1 con la columna decifras clave. En su lugar, pulse la columnaDimensión TM1 y seleccione _TM1CellValue_.

Cuando utiliza este método alternativo paracorrelacionar los valores del cubo de TM1, ladimensión de medidas de TM1 no se debencorrelacionar con ninguna columna ODS.

Moneda

Campo Descripción

Moneda de SAP Se utiliza para importar datos de moneda a uncubo tridimensional nuevo o existente de suservidor.

Mostrar nombres técnicos SAP Para utilizar nombres técnicos, seleccione estacasilla de verificación. Deje esta casilla sin marcarpara mostrarlos según su nombre descriptivo.

Introducir nombre del cubo Introduzca un cubo tridimensional existente ointroduzca un nuevo nombre para el cubo.

Moneda DESDE Seleccione la moneda inicial que desee importardesde SAP.

La lista de monedas disponibles refleja lasmonedas definidas en su sistema SAP.

Dimensión de destino Especifique la dimensión TM1 que recibirán lascadenas de moneda de SAP.

Moneda A Seleccione la segunda moneda que desee importardesde SAP.

Tipo de conversión Seleccione el método de conversión que utilizarápara convertir la moneda inicial en la segundamoneda.

TM1Utiliza una dimensión o un cubo de TM1 como el origen de datos.

Capítulo 1. Cuadros de diálogo y ventanas 89

Campo Descripción

Vista de cubo

Subconjunto de dimensiones

Utilice el botón Examinar para seleccionar unadimensión o una vista TM1 disponible que deseeutilizar como origen de datos. Pulse el botón Vistaprevia. A continuación, complete los campos de lasdemás pestañas.

IBM Cognos Package ConnectorEliminado en la versión 2.0.8 Indica que el origen de datos es un paquete de IBM Cognos publicadocreado a partir de una consulta SAP.

Paquete

Campo Descripción

Conexión Defina la conexión con esteorigen de datos.

Defina la conexión con esteorigen de datos.

Espacio de nombres deautenticación

Muestra todos los espacios denombres de IBM Cognos creadosque se encuentran disponiblesactualmente.

ID de usuario Contraseña

Paquete Seleccionar paquete Pulse el botón Examinar paraseleccionar un paquetepublicado disponible.

Seleccionar cubo TM1 paracargar en

Si está importando los datosdirectamente en un cubo TM1existente, introduzca aquí elnombre del cubo o utilice elmenú desplegable.

Acción de datos, Acción de cubo,Activar registro de cubos

Consulte las descripciones deestos campos en el cubo deinformación de SAP anterior.

Dimensión

Campo Descripción

Dimensión Paquete Identifique el paquete que deseautilizar para esta dimensión.

Dimensión para cargar desde Identifique la dimensión quedesee utilizar.

Dimensión para cargar en Identifique la dimensión en laque desee importar.

90 IBM Planning Analytics: Referencia de TM1

Campo Descripción

Acción de dimensión TM1 Consulte la descripción de lapestaña Características paraobtener más información.

Recuperar los valores deseguridad

Utilice la seguridad de ladimensión.

Consolidación superior Nombre de una consolidación denivel superior de la dimensiónTM1 con todos los elementosimportados como hijos de laconsolidación.

Seleccionar jerarquías Seleccione y correlacione lasjerarquías que desea utilizar enesta importación y defina elmodo en el que deseacorrelacionarlas con la nuevadimensión TM1. Consulte ladocumentación de IBM CognosTM1 TurboIntegrator paraobtener información detallada.

Seleccionar atributos Seleccione los atributos quedesee utilizar y defina lacorrelación. Consulte ladocumentación de IBM CognosTM1 TurboIntegrator paraobtener información detallada.

NingunaSe utiliza para añadir un prólogo definido por el usuario a un proceso.

Si el origen de datos del proceso es Ninguna, TurboIntegrator ejecutar inmediatamente el procedimientode Epílogo tras finalizar el procesamiento del Prólogo.

Nota: Cuando el origen de datos de un proceso es Ninguna, se ignoran los procedimientos de Metadatos yDatos. En este caso, todos los scripts para el proceso deben crearse en los procedimientos de Prólogo oEpílogo.

Vista previa de cuadrículaLa vista previa de cuadrícula muestra los primeros diez registros de su origen de datos. Utilice estacuadrícula para confirmar que la fuente es correcta y para ayudar a determinar la estructura de losregistros.

Si cambia su origen de datos, pulse de nuevo en Vista previa para actualizar la visualización de lacuadrícula.

Pestaña VariablesLa pestaña Variables incluye una cuadrícula y dos botones.

Cuadrícula

Utilice la cuadrícula Variables para asignar variables e identificar el contenido de cada columna en suorigen de datos. La cuadrícula Variables incluye las siguientes columnas.

Capítulo 1. Cuadros de diálogo y ventanas 91

Columna Descripción

ID de columna Enumera cada columna o campo exclusivoidentificado en su origen de datos. Las celdas deesta columna no pueden editarse.

Nombre de variable Contiene una variable creada automáticamentepara cada columna de su origen de datos. Todaslas variables creadas se denominan Vn, donde n es0 en la primera columna y se incrementa en 1 encada columna posterior de la fuente.

Para asignar una variable diferente, pulse la celdaadecuada e introduzca la nueva variable.

Tipo de variable Contiene una lista para cada columna de su origende datos. Utilice la lista para especificar si unavariable es de cadena o numérica.

Valor de muestra Contiene valores de muestra del primer registro desu fuente. Estos valores de muestra le ayudan aidentificar el contenido de cada columna de sufuente. Las celdas de la columna Valor de muestrano pueden editarse.

Contenido Contiene una lista para cada columna de su origende datos. Utilice la lista para especificar el tipo devalor contenido en cada columna de su fuente.

Fórmula Esta columna está atenuada en todos los camposde su fuente, y está disponible sólo al crear unanueva variable.

Al crear una nueva variable, efectúe una doblepulsación en la celda Fórmula asociada para abrirel cuadro de diálogo Fórmula de variables delproceso, en el que puede definir una fórmula parala variable.

Botones

Botón Descripción

Nueva variable Pulse el botón del ratón para crear una nuevavariable.

Borrar Pulse el botón del ratón para borrar una variablecreada por el usuario.

Fórmula de variables del procesoEl cuadro de diálogo Fórmula de variables del proceso muestra las fórmulas utilizadas en un proceso deTurboIntegrator y permite su edición. Si existe una fórmula y pulsa Fórmula en la pestaña Variables, lafórmula establecida actualmente se muestra en la ventana Fórmula. Pulse Nueva variable para definir unafórmula nueva.

92 IBM Planning Analytics: Referencia de TM1

Opción Descripción

Fórmula La fórmula entrada actualmente se muestra enesta ventana. Esta ventana se actualiza a medidaque se especifica texto de fórmula.

Destino Elija la ubicación de esta fórmula en función de lasnecesidades de programación para este proceso.Seleccione Datos para colocar esta fórmula en lasección Datos del proceso de TurboIntegrator.Seleccione Metadatos para colocar la fórmula en lasección Metadatos. Si se seleccionan ambasopciones, la fórmula se coloca en las dosubicaciones.

Evaluar Pulse aquí para validar la fórmula.

Valor de muestra Cuando la fórmula se evalúa, aquí se muestrainformación sobre la fórmula. Por ejemplo, Línea 1:Error de sintaxis antes o después: \n (final de línea)falta el punto y coma.

Mostrar automáticamente cada vez que cambie elnombre de la variable

Pulse aquí para mostrar este cuadro de diálogo sise cambia el nombre de la variable. Si el cuadro noestá marcado, debe solicitarlo manualmentepulsando el cuadro Fórmula de la pestañaVariables.

Pestaña CorrelacionesUtilice la pestaña Correlaciones para especificar cómo se correlacionan los datos de origen con cubos,dimensiones, datos, consolidaciones y atributos de la base de datos de TM1.

La pestaña Correlaciones se compone de una serie de subpestañas, cada una de las cuales contieneopciones que le permiten correlacionar variables de los datos de origen con estructuras de metadatosexistentes de TM1. Las subpestañas disponibles varían en función del tipo de valores contenidos en losdatos de origen, tal y como se especifica en la columna Contenido de la pestaña Variables.

La pestaña Correlaciones contiene las siguientes subpestañas.

Cubo

Utilice la subpestaña Cubo para especificar cómo TurboIntegrator correlaciona los datos importados conlos cubos de TM1. La subpestaña Cubo incluye las siguientes opciones.

Opción Descripción

Acción de cubo Seleccione una opción para crear, actualizar, volvera crear o no aplicar ninguna acción a un cubo.

Nombre de cubo Especifique el cubo al que se aplica la acción.

Si crea un nuevo cubo, introduzca el nombre delcubo en el campo de entrada. De lo contrario,seleccione un cubo existente en la lista.

Capítulo 1. Cuadros de diálogo y ventanas 93

Opción Descripción

Porción puesta a cero Esta opción se habilita cuando selecciona la acciónActualizar cubo. Seleccione este cuadro si deseaque todos los puntos de datos de una vista de cubosean cero.

Nombre de vista Esta opción se habilita al seleccionar lasopcionesActualizar cubo y Porción de puesta acero.

Seleccione o defina la vista que englobe los puntosde datos que desee poner a cero.

Acción de datos Seleccione una opción que determine cómo sealmacenarán en el cubo los datos procesados.

La opción Almacenar valores sustituye los valoresdel cubo existentes por valores importados através del proceso.

La opción Acumular valores añade valoresimportados por el proceso a los valores del cuboexistentes.

Activar conexión de cubos Marque esta casilla de verificación para escribir loscambios realizados en los cubos en el archivoTm1s.log. Desmarque esta casilla para procesarlos cubos sin registrar los cambios en Tm1s.log.

Dimensiones

Utilice la subpestaña Dimensiones para correlacionar variables de elementos con elementos dedimensiones.

La subpestaña incluye una cuadrícula que puede utilizar para correlacionar variables individuales condimensiones de la base de datos TM1. La cuadrícula incluye las siguientes columnas.

Columna Descripción

Variable de elemento Contiene el nombre de cada variable para la queespecificó un valor Contenido de Elemento. El valorContenido se especifica en la pestaña Variables.

Esta columna también contiene la etiqueta(Variables de datos) de las variables con un valorContenido de Datos.

Valor de muestra Un valor de muestra del primer registro de suorigen de datos. Utilice este valor para ayudar aidentificar la dimensión con la que se va acorrelacionar la variable de elemento.

94 IBM Planning Analytics: Referencia de TM1

Columna Descripción

Dimensión Enumera todas las dimensiones disponibles en elservidor. Seleccione la dimensión con la que se vaa correlacionar la variable de elemento.

Para correlacionar la variable de elemento con unanueva dimensión, introduzca el nuevo nombre dedimensión en el campo de entrada.

Orden en el cubo Esta opción se habilita cuando la acción del cuboes Crear.

Especifique el orden de cada dimensión del cuboque está creando.

Acción Enumera las acciones de las dimensionesdisponibles. Seleccione una acción.

Para crear una nueva dimensión, debe especificaruna acción de Crear.

Tipo de elementos Seleccione un tipo de elemento para la variable, yasea Numérico o De cadena.

Orden de elementos Seleccione una opción para clasificar loselementos de cualquier dimensión que estécreando o actualizando. Existen cuatro órdenes declasificación:

Entrada: clasifica los elementos en el orden en quese crearon en la dimensión.

Nombre: clasifica los elementos en ordenalfabético, ya sea ascendente o descendente.

Nivel: clasifica los elementos por orden jerárquico,ya sea ascendente o descendente.

Jerarquía: ordena los elementos tal y comoaparecen en la jerarquía de dimensión.

Datos

Utilice la subpestaña Datos para correlacionar variables de datos con elementos específicos.

La subpestaña incluye una cuadrícula que puede utilizar para correlacionar variables individuales en labase de datos de TM1. La cuadrícula incluye las siguientes columnas.

Columna Descripción

Variable de datos Contiene el nombre de cada variable en la queespecificó un valor Contenido de Datos. El valorContenido se especifica en la pestaña Variables.

Capítulo 1. Cuadros de diálogo y ventanas 95

Columna Descripción

Elemento Pulse el botón de flecha hacia la derecha para abrirel Editor de subconjuntos, en el que puedeseleccionar el elemento con el que se va acorrelacionar la variable.

Para correlacionar la variable con un nuevoelemento, introduzca el nombre de elemento en elcampo de entrada.

Tipo de elementos Seleccione un tipo de elemento aquí.

Valor de muestra Un valor de muestra del primer registro de suorigen de datos. Utilice este valor para ayudar aidentificar el elemento con el que se va acorrelacionar la variable de datos.

Consolidaciones

Utilice la subpestaña Consolidaciones para correlacionar hijos con elementos consolidados.

La subpestaña incluye una cuadrícula que puede utilizar para correlacionar variables individuales condimensiones de la base de datos de TM1. La cuadrícula incluye las siguientes columnas.

Columna Descripción

Variable de consolidación Contiene el nombre de cada variable en la queespecificó un valor Contenido de Consolidación. Elvalor Contenido se especifica en la pestañaVariables.

Dimensión Lista de dimensiones con las que puedecorrelacionarse la consolidación.

Variable de hijo Enumera las variables en las que puedeseleccionar el hijo inmediato de la consolidación.

Peso Asigna un peso a la variable de hijo especificada.

Valor de muestra Un valor de muestra del primer registro de suorigen de datos. Utilice este valor para ayudar aidentificar el elemento con el que se va acorrelacionar la consolidación.

96 IBM Planning Analytics: Referencia de TM1

Columna Descripción

Orden de elementos Seleccione una opción para clasificar loselementos de cualquier consolidación que estécreando o actualizando. Existen cuatro órdenes declasificación:

Entrada: clasifica los elementos en el orden en quese crearon en la dimensión.

Nombre: clasifica los elementos en ordenalfabético, ya sea ascendente o descendente.

Nivel: clasifica los elementos por orden jerárquico,ya sea ascendente o descendente.

Jerarquía: ordena los elementos tal y comoaparecen en la jerarquía de dimensión.

Atributos

Utilice la subpestaña Atributos para correlacionar variables de atributos con atributos específicos.

La subpestaña incluye una cuadrícula que puede utilizar para correlacionar variables individuales condimensiones de la base de datos de TM1. La cuadrícula incluye las siguientes columnas.

Columna Descripción

Variable de atributo Contiene el nombre de cada variable en la queespecificó un valor Contenido de Atributo. El valorContenido se especifica en la pestaña Variables.

Valor de muestra Muestra un valor de muestra del origen de datos.Utilice esta muestra para ayudar a correlacionar elatributo.

Dimensión Enumera todas las dimensiones disponibles en elservidor. Seleccione la dimensión a la que se va aaplicar el atributo.

Variable de elemento Enumera las variables de elementos. Seleccione lavariable del elemento a la que se va a aplicar lavariable de atributo.

Atributo Enumera los atributos con los que puedecorrelacionarse la variable. Seleccione el atributoadecuado en esta lista.

Acción Seleccione Crear un nuevo atributo o Actualizaruno existente.

Tipo de atributo Identifica el tipo de atributo seleccionado en lacolumna Atributo.

Pestaña AvanzadoLa pestaña Avanzado contiene varias subpestañas que muestran las sentencias que ha creado TM1, enfunción de las opciones que seleccione en el Editor de TurboIntegrator. La pestaña Avanzado tambiénincluye una subpestaña en la que puede definir parámetros del proceso.

Capítulo 1. Cuadros de diálogo y ventanas 97

Parámetros

Elemento Descripción

Insertar Pulse el botón del ratón para insertar un nuevoparámetro.

Borrar Pulse el botón del ratón para borrar un parámetroseleccionado.

Parámetros Introduzca un nombre para cada nuevo parámetro.

Tipo Para cada parámetro, seleccione un tipo aquí.

Valor predeterminado Especifique un valor para utilizarlo como valorpredeterminado para este parámetro cuando seejecute el proceso de TurboIntegrator.

Realizar pregunta Especifique una solicitud para utilizarla con esteparámetro cuando se ejecute el proceso deTurboIntegrator.

Prólogo

Elemento Descripción

Cuadro de texto Sentencia Muestra las sentencias creadas que definen unaserie de acciones que se ejecutarán antes deprocesar el origen de datos.

Puede mejorar un proceso creando sentenciasadicionales con reglas o funcionesTurboIntegrator.

Botón Ir a la línea Pulse este botón, introduzca la línea a la que deseair y, a continuación, pulse Aceptar para irdirectamente a una línea de código en el cuadro detexto sentencias.

Metadatos

Elemento Descripción

Cuadro de texto Sentencia Muestra las sentencias creadas que definen unaserie de acciones que se han de ejecutar en TM1antes de procesar el origen de datos.

Puede mejorar un proceso creando sentenciasadicionales con reglas o funcionesTurboIntegrator.

Botón Ir a la línea Pulse este botón, introduzca la línea a la que deseair y, a continuación, pulse Aceptar para irdirectamente a una línea de código en el cuadro detexto sentencias.

98 IBM Planning Analytics: Referencia de TM1

Datos

Elemento Descripción

Cuadro de texto Sentencia Muestra las sentencias creadas que definen unaserie de acciones que se ejecutarán al procesar elorigen de datos.

Puede mejorar un proceso creando sentenciasadicionales con reglas o funcionesTurboIntegrator.

Botón Ir a la línea Pulse este botón, introduzca la línea a la que deseair y, a continuación, pulse Aceptar para irdirectamente a una línea de código en el cuadro detexto sentencias.

Epílogo

Elemento Descripción

Cuadro de texto Sentencia Muestra las sentencias creadas que definen unaserie de acciones que se ejecutarán tras procesarel origen de datos.

Puede mejorar un proceso creando sentenciasadicionales con reglas o funcionesTurboIntegrator.

Botón Ir a la línea Pulse este botón, introduzca la línea a la que deseair y, a continuación, pulse Aceptar para irdirectamente a una línea de código en el cuadro detexto sentencias.

Pestaña PlanificaciónUtilice esta pestaña para planificar un proceso que se va a ejecutar a intervalos regulares.

Elemento Descripción

Planificar este proceso como tarea con nombre Marque esta opción para ejecutar este procesocomo tarea a intervalos regulares. De formapredeterminada, la tarea lleva el mismo nombreque el proceso. Si desea asignar a la tarea unnombre diferente, escríbalo en el campo deentrada.

Fecha y hora de inicio de la tarea Seleccione una fecha de inicio en el calendario yespecifique una hora de inicio en el campo Hora.

Frecuencia de ejecución de tareas Rellene los campos adecuados para establecer elintervalo con el que debe ejecutarse la tarea.

Capítulo 1. Cuadros de diálogo y ventanas 99

Ventana Extracción de vistasUtilice la ventana Extracción de vistas para crear una vista que incluya únicamente aquellos valores quecumplan los criterios definidos por el usuario, o bien para definir una vista para exportar.

Omitir parámetros

Parámetro Descripción

Omitir valores consolidados Active esta opción para ignorar los valoresderivados de la consolidación al extraer la vista.Desactive esta opción para incluir los valoresderivados de la consolidación al extraer la vista. Elvalor predeterminado es Desactivado.

Omitir valores calculados según reglas Active esta opción para ignorar los valoresderivados de reglas al extraer la vista. Desactiveesta opción para incluir los valores derivados dereglas al extraer la vista. El valor predeterminadoes Desactivado.

Omitir valores cero/en blanco Active esta opción para ignorar los valores cero oen blanco al extraer la vista. Desactive esta opciónpara incluir los valores cero o en blanco al extraerla vista. El valor predeterminado es Activado.

Parámetros de rango

Parámetro Descripción

Operador Seleccione un operador que defina los valores quedesee extraer.

Límites numéricos Introduzca un valor numérico para las variables delOperador.

Límites de texto Introduzca un valor de cadena para las variablesdel Operador.

Selección de elementos de dimensión

En cada dimensión, pulse el botón Subconjunto y seleccione los elementos o el subconjunto quedefinan los parámetros para la extracción de vistas.

Si la vista contiene más de 16 dimensiones, pulse para retroceder las páginas necesarias hasta las 16

dimensiones anteriores, o pulse para adelantar las páginas hasta las 16 dimensiones siguientes.

Cuadro de diálogo Estilos de vistaEl cuadro de diálogo Estilos de vista le permite aplicar estilos de Excel a una vista del cubo de TM1 en elNavegador de hojas de cálculo. El cuadro de diálogo contiene varias listas que le permiten aplicar unestilo de Excel existente a un rango de celdas, así como botones que le permiten editar o crear estilos.

100 IBM Planning Analytics: Referencia de TM1

Elemento Descripción

Fondo Seleccione un estilo de esta lista para aplicar alfondo del Navegador de hojas de cálculo.

Celdas de datos Seleccione un estilo en esta lista para aplicar aceldas de datos.

El estilo Celdas de datos tiene prioridad sobre elestilo Fondo.

Celdas de la cabecera de fila Seleccione un estilo en esta lista para aplicar aceldas de la cabecera de fila.

El estilo Celdas de la cabecera de fila tieneprioridad sobre el estilo Fondo.

Celdas de la cabecera de columna Seleccione un estilo en esta lista para aplicar aceldas de la cabecera de columna.

El estilo Celdas de la cabecera de columna tieneprioridad sobre el estilo Fondo.

Botones Editar estilo Pulse el botón Editar estilo adecuado para editar ocrear estilos para el rango asociado del Navegadorde hojas de cálculo.

Inmovilizar paneles Active o desactive esta opción para inmovilizar yliberar los paneles del Navegador de hojas decálculo.

Al activar esta opción, los nombres de elementosde fila permanecerán visibles cuando se desplacehorizontalmente a través de una vista, y losnombres de elementos de columna permaneceránvisibles cuando se desplace verticalmente.

Al desactivar esta opción, los nombres deelementos de fila y columna se moverán junto conlos valores del cubo cuando se desplace a travésde una vista.

Capítulo 1. Cuadros de diálogo y ventanas 101

102 IBM Planning Analytics: Referencia de TM1

Capítulo 2. Funciones de reglasEsta sección incluye una lista completa de todas las funciones de reglas de IBM TM1. Puede utilizarcualquiera de estas funciones cuando escribe las reglas TM1.

Operadores aritméticos de reglas de TM1Los siguientes operadores matemáticos pueden utilizarse en la creación de reglas de TM1.

Operador Significado

+ (signo más) Suma

- (signo menos) Resta

* (asterisco) Multiplicación

/ (barra diagonal) La división por cero utilizando este operadordevuelve un valor no definido.

\ (barra invertida) La división por cero utilizando este operadordevuelve cero.

^ (signo de intercalación/acento circunflejo) Exponenciación

Operadores de comparación en reglas de TM1Los operadores de comparación comparan valores de la parte de la fórmula de una sentencia de cálculode reglas.

Para comparar dos valores de cadena, inserte el símbolo @ antes del operador de comparación. Porejemplo, IF ('A' @= 'B',0,1) genera el número 1.

Operador Significado

> Mayor que

< Menor que

>= Mayor o igual a

<= Menor o igual a

= Igual a

<> No igual a

Operadores lógicos en reglas de TM1Puede combinar expresiones en una sentencia de cálculo de reglas utilizando operadores lógicos.

© Copyright IBM Corp. 2007, 2019 103

Operador Significado Ejemplo

& (signo ampersand) AND (Value1 > 5) & (Value1 < 10)Devuelve TRUE si el valor esmayor que 5 y menor que 10.

% (signo de porcentaje) OR (Value1 > 10) % (Value1 < 5)Devuelve TRUE si el valor esmayor que 10 o menor que 5.

~ (virgulilla) NOT ~(Value1 > 5) Equivalente a(Value1 <= 5)

Funciones de reglas de atributosFunciones de regla que funcionan con atributos.

ATTRNATTRN devuelve un atributo numérico para un elemento especificado de una dimensión.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ATTRN(dimension, element, attribute)

Argumento Descripción

dimension Un nombre de dimensión válido.

element Un elemento de la dimensión.

attribute El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido delelemento.

Nota: Al utilizar esta función en una sentenciacondicional (IF), la sentencia es la parte quecontiene la condición, no todo el bloquecondicional. Después de un error leve, la ejecucióncontinúa con la siguiente sentencia. Elprocesamiento de TI no sabe que se encontraba enuna sentencia condicional una vez procesado elerror leve, por lo que la siguiente sentencia es lasiguiente línea, no la línea posterior a endif.

Para evitar esta situación, utilice variables en lasoperaciones que pudiesen producir un error leve y,a continuación, utilice las variables en la sentenciacondicional. Por ejemplo:

V1 = CELLGETN('PNLCube', 'fred','argentina','Sales','Jan');IF(V1 = 454);ASCIIOUTPUT('bug.txt', 'if logic not working properly');ENDIF;

104 IBM Planning Analytics: Referencia de TM1

Ejemplo

En este ejemplo, la función devuelve el valor numérico del atributo Engine Size del elemento L Series 1.8LSedan de la dimensión Model.

ATTRN('Model', 'L Series 1.8L Sedan', 'Engine Size')

ATTRSATTRS devuelve un atributo de cadena para un elemento especificado de una dimensión.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ATTRS(dimension, element, attribute)

Argumento Descripción

dimension Un nombre de dimensión válido.

element Un elemento de la dimensión.

attribute El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido delelemento.

Ejemplo

En este ejemplo, la función devuelve el valor de cadena del atributo Currency del elemento 10100 de ladimensión plan_business_unit.

ATTRS('plan_business_unit', '10100', 'Currency')

CubeATTRNCubeATTRN devuelve un atributo numérico para un cubo especificado.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

CubeATTRN(CubeName, AttrName);

Argumento Descripción

CubeName Un nombre de cubo válido.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido delcubo.

Ejemplo

En este ejemplo, la función devuelve el valor numérico del atributo Accounting_Code del cubo Product.

CubeATTRN('Product', 'Accounting_Code');

Capítulo 2. Funciones de reglas 105

CubeATTRSCubeATTRS devuelve un atributo de cadena para un cubo especificado.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

CubeATTRS(CubeName, AttrName);

Argumento Descripción

CubeName Un nombre de cubo válido.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido delcubo.

Ejemplo

En este ejemplo, la función devuelve el valor de cadena del atributo Owner del cubo Product.

CubeATTRS('Product', 'Owner');

DimensionATTRNDimensionATTRN devuelve un atributo numérico para una dimensión especificada.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

DimensionATTRN(DimName, AttrName);

Argumento Descripción

DimName Un nombre de dimensión válido.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de ladimensión.

Ejemplo

En este ejemplo, la función devuelve el valor numérico del atributo Accounting_Code de la dimensiónPlan_Business_Unit.

DimensionATTRN('Plan_Business_Unit', 'Accounting_Code');

DimensionATTRSDimensionATTRS devuelve un atributo de cadena para una dimensión especificada.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

DimensionATTRS(DimName, AttrName);

106 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

DimName Un nombre de dimensión válido.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de ladimensión.

Ejemplo

En este ejemplo, la función devuelve el valor de cadena del atributo Manager de la dimensiónPlan_Business_Unit.

DimensionATTRS('Plan_Business_Unit', 'Manager');

ElementAttrNElementAttrN devuelve un atributo numérico para un elemento especificado de una dimensión.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ElementAttrN(dimension, hierarchy, element, attribute)

Argumento Descripción

dimension Un nombre de dimensión válido.

hierarchy Nombre de la jerarquía de la dimensión.

element Un elemento de la dimensión.

attribute El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido delelemento.

Nota: Al utilizar esta función en una sentenciacondicional (IF), la sentencia es la parte quecontiene la condición, no todo el bloquecondicional. Después de un error leve, la ejecucióncontinúa con la siguiente sentencia. Elprocesamiento de TI no sabe que se encontraba enuna sentencia condicional una vez procesado elerror leve, por lo que la siguiente sentencia es lasiguiente línea, no la línea posterior a endif.

Para evitar esta situación, utilice variables en lasoperaciones que pudiesen producir un error leve y,a continuación, utilice las variables en la sentenciacondicional. Por ejemplo:

V1 = CELLGETN('PNLCube', 'fred','argentina','Sales','Jan');IF(V1 = 454);ASCIIOUTPUT('bug.txt', 'if logic not working properly');ENDIF;

Capítulo 2. Funciones de reglas 107

Ejemplo

En este ejemplo, la función devuelve el valor numérico del atributo Engine Size del elemento L Series 1.8LSedan de la jerarquía Automobile de la dimensión Model.

ElementAttrN('Model', 'Automobile', 'L Series 1.8L Sedan', 'Engine Size')

ElementAttrSElementAttrS devuelve un atributo de cadena para un elemento especificado de una dimensión.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ElementAttrS(dimension, hierarchy, element, attribute)

Argumento Descripción

dimension Un nombre de dimensión válido.

hierarchy Nombre de la jerarquía de la dimensión.

element Un elemento de la dimensión.

attribute El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido delelemento.

Ejemplo

En este ejemplo, la función devuelve el valor de cadena del atributo Currency del elemento 10100 de lajerarquía expense de la dimensión plan_business_unit.

ElementAttrS('plan_business_unit', 'expense', '10100', 'Currency')

Función de reglas de cálculo de consolidaciónLas funciones ConsolidatedMax; ConsolidatedMin; ConsolidatedAvg; ConsolidatedCount; y ConsolidatedCountUnique realizan cálculos matemáticos sobre las consolidaciones.

ConsolidatedAvgConsolidatedAvg calcula el valor promedio en una consolidación y devuelve un valor único.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ConsolidatedAvg(flag-value, cube-name, element_1, element_2,… );

Argumentosflag-value

El valor de distintivo es la suma de los valores siguientes:

108 IBM Planning Analytics: Referencia de TM1

• 1 - Utilizar ponderación de consolidación al calcular este valor (incluir ceros en el cálculo). Si estevalor no está activado, se utiliza el valor sin formato del elemento consolidado. Las condicionessiguientes pueden afectar a la hora de ver si se incluyen ceros en el cálculo:

– Si se especifica cero como la ponderación de algunos elementos consolidados, el parámetro deconfiguración: ZeroWeightOptimization=F debe establecerse para estos elementos a fin defactorizarse en el cálculo de estas funciones. Sin este parámetro de configuración, los elementospara los que la ponderación es cero se eliminan de la lista de consolidaciones y, por lo tanto, nose procesan cuando se descubren aspectos como el valor mínimo o máximo.

– Si desea que las celdas con valor cero participen en el promedio, se debe establecer UNDEFVALSpara el cubo de modo que cuando se asigne cero a una celda del cubo, se almacenará un valor enla celda exactamente igual que con cualquier otro valor no cero, y luego participará en elpromedio.

– Si una regla de cubo incluye SKIPCHECK, se pasarán por alto los ceros incluso cuando el valorflag-value esté establecido en 1. Elimine SKIPCHECK de la regla para incluir los ceros en elpromedio consolidado.

• 2 - Pasar por alto los valores de cero. Si se define este valor, los valores de cero no se incluirán en elcálculo.

cube-name

Nombre del cubo en el que residen los valores.

Si la función se está ejecutando como parte de una regla de cubo y no como parte de un proceso deTurboIntegrator, el argumento cube-name puede especificarse como una cadena vacía para indicar elcubo actual. Esto significa que puede escribir una regla como, por ejemplo,['Apr']=ConsolidatedAvg( 0, '', !actvsbud, '1 Quarter' );

element_1, element_2, …

Los nombres de elementos de dimensiones que definen la intersección del cubo que contiene el valorque se debe recuperar.

Los argumentos element_1 a element_n son distinguen entre secuencias. element_1 debe ser unelemento de la primera dimensión del cubo, element_2 debe ser un elemento de la segundadimensión, etcétera. Estos argumentos pueden ser también los nombres de alias de elementos dedimensiones o variables de TurboIntegrator.

Ejemplo

En un cubo denominado Declaración de ingresos con tres dimensiones denominadas Regiones, Hora yDeclaración de ingresos, la dimensión Declaración de ingresos contiene un elemento denominado GrossSales para el número global de ventas.

Para calcular el promedio de ventas en todas las regiones en el año 2010, escriba:

ConsolidatedAvg( 1, 'Income Statement', 'All Regions', '2010', 'Gross Sales' );

ConsolidateChildrenConsolidateChildren obliga a calcular los valores consolidados sumando los hijos inmediatos de unadimensión especificada. ConsolidateChildren resulta útil si se calculan consolidaciones intermediasmediante reglas y desea calcular una consolidación padre sumando las consolidaciones intermedias enlugar de sumar los valores de hoja subyacentes.

Esta función solo es válida en las reglas de TM1.

Sintaxis

ConsolidateChildren(DimName1, DimName2, ...)

Capítulo 2. Funciones de reglas 109

Argumento Descripción

DimName1, DimName2, ... Nombres de las dimensiones cuyasconsolidaciones se realizarán.

La función requiere al menos un argumentoDimName, y puede aceptar tantos argumentosDimName como dimensiones existan en el cubopara el que se escribe la regla.

Ejemplo

Supongamos que tenemos un cubo denominado Sales compuesto por las dimensiones ActVsBud, Region,Model, Account1 y Month.

En este ejemplo, la dimensión Month se define tal y como se indica a continuación:

Si no existe ninguna regla para este cubo, el valor de la consolidación Year se calculará sumando todoslos valores de hoja subyacentes, en este caso de Jan a Dec. La siguiente imagen ilustra estaconsolidación.

Ahora, supongamos que crea la siguiente regla para este cubo, que indica que todos los valorestrimestrales deben ser 1:

[{'1 Quarter', '2 Quarter', '3 Quarter', '4 Quarter'}]=1;

El resultado es el siguiente:

110 IBM Planning Analytics: Referencia de TM1

En la imagen siguiente, puede ver que realmente los valores trimestrales los calcula la regla, mientrasque la consolidación Year se sigue calculando sumando todos los valores de hoja subyacentes. Si esta noes la ruta de cálculo que desea, puede utilizar la función ConsolidateChildren para forzar a TM1 a quecalcule la consolidación Year sumando sus hijos inmediatos, concretamente 1 Quarter, 2 Quarter, 3Quarter y 4 Quarter.

['Year']=ConsolidateChildren('Month');[{'1 Quarter', '2 Quarter', '3 Quarter', '4 Quarter'}]=1;

En la regla, la sentencia ['Year']=ConsolidateChildren('Month') indica que la consolidaciónYear debe calcularse sumando los hijos inmediatos de Year en la dimensión Month.

La imagen siguiente muestra el resultado de la sentencia['Year']=ConsolidateChildren('Month'):

Tenga en cuenta que la consolidación Year ahora se calcula sumando sus hijos inmediatos.

Es importante recordar que para una consolidación dada, la función ConsolidateChildren únicamente seaplica a los hijos inmediatos de la consolidación.

La función ConsolidateChildren también puede utilizarse para especificar cómo se calculan lasconsolidaciones en varias dimensiones, tal y como se muestra en el siguiente ejemplo:

Argumento Descripción

['World','Year']=ConsolidateChildren('Region','Month')

Esta sentencia aplica la funciónConsolidateChildren a las consolidaciones World yYear. En este caso, World se calcula sumandotodos sus hijos inmediatos en la dimensión Region,mientras que Year se calcula sumando sus hijosinmediatos en la dimensión Month.

ConsolidatedCountConsolidatedCount cuenta el valor en una consolidación y devuelve un valor único.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ConsolidatedCount(flag-value, cube-name, element_1, element_2,… );

Argumentosflag-value

El valor de distintivo es la suma de los valores siguientes:

1 - Utilizar ponderación de consolidación al calcular este valor. Si no se activa, se utilizará el valor sinformato del elemento consolidado.

2 - Pasar por alto valores cero. Si se establece, los valores cero no se utilizarán por parte de estasfunciones.

Nota: Si se especifica cero como la ponderación de algunos elementos consolidados, el parámetro deconfiguración: ZeroWeightOptimization=F debe establecerse para estos elementos a fin defactorizarse en el cálculo de estas funciones. Sin este parámetro de configuración, los elementos para

Capítulo 2. Funciones de reglas 111

los que la ponderación es cero se eliminan de la lista de consolidaciones y, por lo tanto, no seprocesan cuando el descubrimiento alinea el valor mínimo o máximo.

cube-name

Nombre del cubo en el que residen los valores.

Si la función se está ejecutando como parte de una regla de cubo y no como parte de un proceso deTurboIntegrator, el argumento cube-name puede especificarse como una cadena vacía para indicar elcubo actual. Esto significa que puede escribir una regla como: ['Apr']=ConsolidatedCount( 1,'', !actvsbud, '1 Quarter' );

element_1, element_2, …

Los nombres de elementos de dimensiones que definen la intersección del cubo que incluye el valorque desea recuperar.

Los argumentos de element_1 a element_n distinguen secuencias. element_1 debe ser un elementode la primera dimensión del cubo, element_2 debe ser un elemento de la segunda dimensión, etc.Estos argumentos pueden ser también los nombres de alias de elementos de dimensiones o variablesde TurboIntegrator.

ConsolidatedCountUniqueConsolidatedCountUnique cuenta el número de elementos exclusivos para los que existen realmentepuntos de datos para la consolidación especificada. Los elementos exclusivos se cuentan en unadimensión de la celda consolidada.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ConsolidatedCountUnique( 0, unique-along-dimension-name, cube-name,elem_1, elem_2, . . . );

Argumentosflag word

Especifique 0 (cero).

Nota: Si se especifica cero como la ponderación de algunos elementos consolidados, el parámetro deconfiguración: ZeroWeightOptimization=F debe establecerse para estos elementos a fin defactorizarse en el cálculo de estas funciones. Sin este parámetro de configuración, los elementos paralos que la ponderación es cero se eliminan de la lista de consolidaciones y, por lo tanto, no seprocesan cuando se descubren aspectos como el valor mínimo o máximo.

unique-along-dimension-nameDimensión en la que deben encontrarse entradas de elementos exclusivos para los que existen datosreales.

cube-name

Nombre del cubo en el que residen los valores.

Si la función se está ejecutando como parte de una regla de cubo y no como parte de un proceso deTurboIntegrator, el argumento cube-name puede especificarse como una cadena vacía para indicar elcubo actual.

element_1, element_2, …

Nombres de elementos de dimensiones que definen la intersección del cubo para el que se debeprocesar el valor consolidado.

Los argumentos de element_1 a element_n distinguen secuencias. element_1 debe ser un elementode la primera dimensión del cubo, element_2 debe ser un elemento de la segunda dimensión, etc.Estos argumentos pueden ser también los nombres de alias de elementos de dimensiones o variablesde TurboIntegrator.

112 IBM Planning Analytics: Referencia de TM1

Ejemplo

En un cubo denominado Income Statement con tres dimensiones: Regions, Time, e Income Statement, ladimensión Income Statement contiene un elemento denominado Gross Sales para el número global deventas. Para contar cuántas regiones han tenido unos determinados ingresos por ventas brutos en el año2010, escriba:

ConsolidatedCountUnique( 0, 'Regions', 'Income Statement', 'All Regions', '2010', 'Gross Sales' );

ConsolidatedMaxConsolidatedMax calcula el valor máximo en una consolidación y devuelve un valor único.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ConsolidatedMax(flag-value, cube-name, element_1, element_2,… );

Argumentosflag-value

El valor de distintivo es la suma de los valores siguientes:

1 - Utilizar ponderación de consolidación al calcular este valor. Si no se activa, se utilizará el valor sinformato del elemento consolidado.

2 - Pasar por alto valores cero. Si se establece, los valores cero no se utilizarán por parte de estasfunciones.

Nota: Si se especifica cero como la ponderación de algunos elementos consolidados, el parámetro deconfiguración: ZeroWeightOptimization=F debe establecerse para estos elementos a fin defactorizarse en el cálculo de estas funciones. Sin este parámetro de configuración, los elementos paralos que la ponderación es cero se eliminan de la lista de consolidaciones y, por lo tanto, no seprocesan cuando el descubrimiento alinea el valor mínimo o máximo.

cube-name

Nombre del cubo en el que residen los valores.

Si la función se está ejecutando como parte de una regla de cubo y no como parte de un proceso deTurboIntegrator, el argumento cube-name puede especificarse como una cadena vacía para indicar elcubo actual. Esto significa que puede escribir una regla como: ['Apr']=ConsolidatedMax( 1,'', !actvsbud, '1 Quarter' );

element_1, element_2, …

Los nombres de elementos de dimensiones que definen la intersección del cubo que incluye el valorque desea recuperar.

Los argumentos de element_1 a element_n distinguen secuencias. element_1 debe ser un elementode la primera dimensión del cubo, element_2 debe ser un elemento de la segunda dimensión, etc.Estos argumentos pueden ser también los nombres de alias de elementos de dimensiones o variablesde TurboIntegrator.

Ejemplo

Supongamos que tiene un cubo denominado Income Statement con tres dimensiones: "Area", "Time" e"Income Statement". La dimensión Income Statement contiene un elemento "Gross Sales" para elnúmero global de ventas.

Capítulo 2. Funciones de reglas 113

Para calcular el máximo de ventas en todas regiones en el año 2010, utilice:

ConsolidatedMax( 1, 'Income Statement', 'All Regions', '2010', 'Gross Sales' );

ConsolidatedMinConsolidatedMin calcula el valor mínimo en una consolidación y devuelve un valor único.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ConsolidatedMin(flag-value, cube-name, element_1, element_2,… );

Argumentosflag-value

El valor de distintivo es la suma de los valores siguientes:

1 - Utilizar ponderación de consolidación al calcular este valor. Si no se activa, se utilizará el valor sinformato del elemento consolidado.

2 - Pasar por alto valores cero. Si se establece, los valores cero no se utilizarán por parte de estasfunciones.

Nota: Si se especifica cero como la ponderación de algunos elementos consolidados, el parámetro deconfiguración: ZeroWeightOptimization=F debe establecerse para estos elementos a fin defactorizarse en el cálculo de estas funciones. Sin este parámetro de configuración, los elementos paralos que la ponderación es cero se eliminan de la lista de consolidaciones y, por lo tanto, no seprocesan cuando el descubrimiento alinea el valor mínimo o máximo.

cube-name

Nombre del cubo en el que residen los valores.

Si la función se está ejecutando como parte de una regla de cubo y no como parte de un proceso deTurboIntegrator, el argumento cube-name puede especificarse como una cadena vacía para indicar elcubo actual. Esto significa que puede escribir una regla como: ['Apr']=ConsolidatedMin( 1,'', !actvsbud, '1 Quarter' );

element_1, element_2, …

Los nombres de elementos de dimensiones que definen la intersección del cubo que incluye el valorque desea recuperar.

Los argumentos de element_1 a element_n distinguen secuencias. element_1 debe ser un elementode la primera dimensión del cubo, element_2 debe ser un elemento de la segunda dimensión, etc.Estos argumentos pueden ser también los nombres de alias de elementos de dimensiones o variablesde TurboIntegrator.

Funciones de reglas de datos de cuboFunciones de regla que funcionan con datos de cubo.

CellValueNCellValueN devuelve el valor numérico de los elementos especificados de un cubo. Esta es una función dereglas de TM1 que solo es válida en las reglas de TM1. El uso de esta función en un proceso deTurboIntegrator provocará un error.

Para las dimensiones que no están entre los parámetros de los elementos, las coordenadas se recuperandel destino de regla (la celda que se recupera y que desencadena la evaluación de la regla). El

114 IBM Planning Analytics: Referencia de TM1

comportamiento de la función es similar al de la expresión de referencia dentro del cubo (por ejemplo,[ 'Measures':'Count' ] ), tal y como se utiliza en la parte derecha de la regla.

Los parámetros de elemento pueden especificarse en cualquier orden y, en el caso de CellValueN, sepueden especificar varios elementos de la misma dimensión (pero de diferentes jerarquías de ladimensión). Dado que no es necesario que la lista de elementos esté en el orden de las dimensiones delcubo, es preciso calificar con la dimensión todos los parámetros de elemento. Los parámetros deelemento de las dimensiones multijerárquicas también deben calificarse con la jerarquía.

Sintaxis

CellValueN(cube, element1,..., elementN);

Argumento Descripción

cube Nombre del cubo.

elementN Nombre de elemento que define la celda. Debeespecificarse un elemento como mínimo.

Ejemplo

CellValueS('ForecastCube', 'Products':'ProductsByChannel':'Channel2', 'Measures':'Count');

Este ejemplo devuelve el valor numérico de la celda especificada. La dimensión Products tiene variasjerarquías, mientras que la dimensión Measures tiene una sola jerarquía.

La referencia dentro del cubo está restringida a los parámetros literales, pero CellValueN no lo está. Estecomportamiento es similar al de la función de reglas DB(). Los parámetros de elemento puedenespecificarse mediante expresiones con valores de cadena. Por ejemplo, el parámetro de elementoProducts anterior se podría especificar así:

'Products' : 'ProductsByChannel' : AttrS( … )

A diferencia de DB() y la expresión de referencia dentro del cubo, los parámetros de elemento deCellValueN deben estar calificados con la dimensión o con la dimensión y la jerarquía.

CellValueSCellValueS devuelve el valor de cadena de los elementos especificados de un cubo. Esta es una funciónde reglas de TM1 que solo es válida en las reglas de TM1. El uso de esta función en un proceso deTurboIntegrator provocará un error.

Para las dimensiones que no están entre los parámetros de los elementos, las coordenadas se recuperandel destino de regla (la celda que se recupera y que desencadena la evaluación de la regla). Elcomportamiento de la función es similar al de la expresión de referencia dentro del cubo (por ejemplo,[ 'Measures':'Count' ] ), tal y como se utiliza en la parte derecha de la regla.

Los parámetros de elemento pueden especificarse en cualquier orden y, en el caso de CellValueS, sepueden especificar varios elementos de la misma dimensión (pero de diferentes jerarquías de ladimensión). Dado que no es necesario que la lista de elementos esté en el orden de las dimensiones delcubo, es preciso calificar con la dimensión todos los parámetros de elemento. Los parámetros deelemento de las dimensiones multijerárquicas también deben calificarse con la jerarquía.

Sintaxis

CellValueS(cube, element1,..., elementN);

Capítulo 2. Funciones de reglas 115

Argumento Descripción

cube Nombre del cubo.

elementN Nombre de elemento que define la celda. Debeespecificarse un elemento como mínimo.

Ejemplo

CellValueS('ForecastCube', 'Products':'ProductsByChannel':'Channel2', 'Measures':'Location');

Este ejemplo devuelve el valor de cadena de la celda especificada. La dimensión Products tiene variasjerarquías, mientras que la dimensión Measures tiene una sola jerarquía.

La referencia dentro del cubo está restringida a los parámetros literales, pero CellValueS no lo está. Estecomportamiento es similar al de la función de reglas DB(). Los parámetros de elemento puedenespecificarse mediante expresiones con valores de cadena. Por ejemplo, el parámetro de elementoProducts anterior se podría especificar así:

'Products' : 'ProductsByChannel' : AttrS( … )

A diferencia de DB() y la expresión de referencia dentro del cubo, los parámetros de elemento deCellValueS deben estar calificados con la dimensión o con la dimensión y la jerarquía.

DBDB devuelve un valor de un cubo en una base de datos de TM1. DB devuelve un valor numérico si seutiliza en una expresión numérica y un valor de cadena si se utiliza en una expresión de cadena.

DB es una función de reglas de TM1, válida solamente en las reglas de TM1. El uso de esta función en unproceso de TurboIntegrator provocará un error.

Sintaxis

DB(cube, e1, e2, [...e256])

Parámetroscube

El nombre del cubo del que se va a recuperar el valor.

e1,...en

Nombres de elementos de dimensiones que definen la intersección que incluye el valor que desearecuperar.

Los argumentos de e1 a en distinguen secuencias. e1 debe ser un elemento de la primera dimensióndel cubo, e2 debe ser un elemento de la segunda dimensión, etc.

Ejemplo

En este ejemplo, Budget es el nombre del cubo, y la función devuelve el valor de la intersección deCalifornia, 15" Flat Panel Monitors, Net Sales y January.

DB('Budget', 'California', '15" Flat Panel Monitors', 'Net Sales', 'January')

116 IBM Planning Analytics: Referencia de TM1

Cuando se utiliza para hacer referencia a las dimensiones multijerárquicas, debe especificar la jerarquíaconcreta. En este ejemplo, el elemento Category2 existe en la jerarquía ByCategory de la dimensiónProductsCube.

DB('ProductsCube', 'ByCategory':'Category2',...)

ISLEAFISLEAF devuelve 1 si una celda especificada es una celda de hoja (identificada únicamente por elementosde hoja/simples). Si la celda especificada está identificada por cualquier elemento consolidado, la funcióndevolverá 0.

Esta función solo es válida en las reglas de TM1.

La función ISLEAF no puede utilizarse en procesos de TurboIntegrator. La presencia de esta función en unproceso impedirá la compilación del mismo.

Sintaxis

ISLEAF

Argumentos

Ninguno.

Ejemplo

Puede utilizar ISLEAF en una sentencia IF para probar si una celda actual es una celda de hoja. Porejemplo:

[]=IF((ISLEAF=1),TrueStatement, FalseStatement);

Ejecuta TrueStatement si la celda actual es una celda de hoja; de lo contrario, ejecuta FalseStatement.

ISUNDEFINEDCELLVALUEISUNDEFINEDCELLVALUE compara el valor transferido del valor de cubo numérico, que se ve influido porla presencia de la declaración UNDEFVALS en la regla de ese cubo. La función devuelve 1 si el valortransferido equivale al valor predeterminado del cubo; de lo contrario, la función devuelve 0.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ISUNDEFINEDCELLVALUE(TestValue, <Cube>)

Argumentos

Argumento Descripción

TestValue El valor numérico para comparar con el valor predeterminado del cubo.

Capítulo 2. Funciones de reglas 117

Argumento Descripción

Cubo Un argumento de cadena opcional que especifica el cubo cuyo valorpredeterminado se debe comparar.

Cuando se utiliza ISUNDEFINEDCELLVALUE en una regla, se asume que el cuboes el cubo objeto salvo que se especifique otra cosa.

Cuando se utiliza en un TI, es necesario especificar un cubo.

Si el cubo se omite en un TI, o no es válido al especificarse, se utilizará 0 para lacomparación.

Ejemplo

ISUNDEFINEDCELLVALUE(TestValue) devuelve 1 cuando TestValue es el valor especial sin definir y seutiliza en la regla de un cubo con UNDEFVALS declarado.

UNDEFUNDEF devuelve el valor no definido. Esta función puede utilizarse para impedir que los datos sealmacenen en un cubo según una prueba lógica.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

UNDEF

Argumentos

Ninguno.

Ejemplo

UNDEF devuelve el valor no definido.

UNDEFINEDCELLVALUEUNDEFINEDCELLVALUE devuelve el valor de cubo numérico, que se ve influido por la presencia de ladeclaración UNDEFVALS en la regla de ese cubo.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

UNDEFINEDCELLVALUE(<Cube>)

118 IBM Planning Analytics: Referencia de TM1

Argumentos

Argumento Descripción

Cube Un argumento de cadena opcional que especifica el cubo cuyo valorpredeterminado se debe devolver.

Cuando se utiliza UNDEFINEDCELLVALUE en una regla, se asume que el cubo esel cubo objeto salvo que se especifique otra cosa.

Cuando se utiliza en un proceso de TI, es necesario especificar un cubo.

Si el cubo se omite en un proceso de TI, o no es válido al especificarse, sedevolverá 0.

Ejemplo

UNDEFINEDCELLVALUE devuelve 0 cuando se utiliza en la regla de un cubos sin UNDEFVALS declarado, ocuando se utiliza en un proceso de TI.

UNDEFINEDCELLVALUE devuelve el valor sin definir especial cuando se utiliza en la regla de un cubo conUNDEFVALS declarado.

UNDEFINEDCELLVALUE('ExampleCube') devuelve el valor predeterminado 'ExampleCube' o 0 si'ExampleCube' no existe.

UNDEFVALSLa inclusión de UNDEFVALS en las reglas para un cubo cambia el valor predeterminado del cubo, que escero, por un valor no definido especial. Al igual que otras funciones de reglas, UNDEFVALS se aplicaúnicamente al cubo asociado con la regla en la que aparece la función.

Se trata de una función de reglas TM1, sólo válida en las reglas TM1.

El uso de UNDEFVALS tiene ramificaciones que afectan al modo en que los datos se almacenan en el cuboy al modo en que se recuperan.

• Almacenamiento de datos

En el caso de un cubo sin UNDEFVALS en las reglas, el valor predeterminado es cero. Si se intentaalmacenar un cero en una celda del cubo, esa solicitud de almacenamiento se pasará por alto, ya quese trata de un intento redundante de almacenar el valor predeterminado, y eso consumiría espacio dememoria de forma innecesaria. Del mismo modo, si una celda ya contiene un valor y el valor se suprime,no se almacena nada en la celda.

Si el cubo tiene UNDEFVALS definido en las reglas, el valor predeterminado se convierte en un valor nodefinido especial. Ahora, cuando se almacena un cero en la celda de un cubo, se almacena realmente,como ocurriría con cualquier valor distinto de cero.

El valor no definido especial es solamente un valor de tiempo de ejecución, devuelto de las solicitudesde valores de celdas. Nunca se almacena en una celda real en la memoria y nunca se escribe en disco.La inclusión de UNDEFVALS en la regla de un cubo no tiene efecto alguno en el uso de la memoria ni enel almacenamiento de disco, excepto en el caso de las celdas que realmente contienen un cero comovalor. Si UNDEFVALS se incluye en la regla de un cubo, los valores cero de ese cubo consumirán espaciode memoria y se escribirán en disco, igual que cualquier otro valor de datos. Si UNDEFVALS no seespecifica, las celdas con valor cero no se almacenan en la memoria ni se escriben en disco.

• Recuperación de datos

En el caso de un cubo sin UNDEFVALS en las reglas, el valor predeterminado es cero. Cuando serecupera una celda y no hay ningún valor almacenado actualmente para ese valor en el cubo, sedevuelve el valor cero (como valor predeterminado). Esto significa que una aplicación no puede saber siuna celda existe realmente y contiene el valor cero o si la celda no existe (como puede ocurrir con losdatos difusos).

Capítulo 2. Funciones de reglas 119

Si el cubo tiene UNDEFVALS definido en las reglas, el valor predeterminado se convierte en un valor nodefinido especial. En este caso, cuando se recupera una celda no existente, el valor recuperado seráeste valor no definido especial. Esto se puede utilizar para distinguir una celda que no existe (nodefinido especial) de una celda que sí existe pero cuyo valor es cero (se devuelve cero). Cualquiercliente escrito para ejecutarse con TM1 que pueda encontrar un cubo con la función UNDEFVALSestablecida debe estar preparado para manipular un valor de celda que sea este no definido especial enlugar de un cero. Un cliente puede detectar si un valor devuelto de TM1 es este valor no definidoespecial con la función de API TM1ValIsUndefined. Para obtener información detallada sobre lafunción de la API TM1ValIsUndefined, consulte la documentación de API de TM1.

Nota: Este valor no definido especial no es el valor devuelto por la función UNDEF() de TurboIntegrator.El valor devuelto por UNDEF() es un valor no definido utilizado para acciones tales como el intento dedividir entre cero, calcular el logaritmo de un número no permitido, etc.

En TurboIntegrator, en el caso de las operaciones aritméticas normales (+, -, *, /, \, ^) y lascomparaciones aritméticas normales (<, >, >=, <=, =, <>), el valor no definido especial se trata como uncero. Por este motivo, el código siguiente no funciona:

NoCellVal = UndefinedCellValue( 'cube-name' );If ( vv = NoCellVal );

En esta comparación, NoCellVal, que es el valor no definido especial para un cubo UNDEFVALS, se tratacomo un cero. Esto significa que la comparación es en realidad If ( vv = 0 ).

En TurboIntegrator debe utilizar IsUndefinedCellValue para comprobar si un valor de celda es el valor nodefinido especial. Por ejemplo:

vv = CellGetN( 'cube-name', elements-list);if ( IsUndefinedCellValue( vv, 'cube-name' ) = 1 ); #the cells does not exist cell_does_not_exist = 1;else; #cell exists cell_does_not_exist = 0;Endif;

Sintaxis

UNDEFVALS

Argumentos

Ninguno.

Funciones de reglas de fecha y horaFunciones de regla que funcionan con fechas y horas.

DATEDATE devuelve la cadena de fecha en formato aa-mm-dd o aaaa-mm-dd para un determinado número deserie.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

DATE(SerialNumber, ReturnFourDigitYear)

120 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

SerialNumber Una fecha expresada en formato de serie.

ReturnFourDigitYear Un argumento booleano opcional que determina si la funciónDATE devuelve una cadena que utilice una notación de dos ocuatro dígitos para el año.

Si ReturnFourDigitYear es true, la función devuelve una fecha quequeda dentro del rango Jan. 1, 1960 - Dec. 31, 9999, utilizandouna notación de cuatro dígitos para el año. La fecha de serie 0corresponde a Jan. 1, 1960 y la fecha de serie 2936549corresponde a Dec. 31, 9999.

Si ReturnFourDigitYear es false, o si este argumento opcional seomite de la función DATE, la función devuelve una fecha quequeda dentro del rango Jan. 1, 1960 - Dec. 31, 2059, utilizandouna notación de dos dígitos para el año. La fecha de serie 0corresponde a Jan 1, 1960 y la fecha de serie 36524corresponde a Dec. 31, 2059.

Si ReturnFourDigitYear es falso o se omite y especifica una fechade serie mayor que 36524, la fecha de serie utilizada por lafunción se determina mediante la fórmula n - 36525. Porejemplo, si especifica una fecha de serie de 36530, entonces36530 - 36525 = 5. En este caso, DATE utiliza 5 como la fecha deserie y devuelve la fecha Jan. 6, 1960.

Ejemplo

DATE(13947) devuelve 98-03-09.

DATE(13947, 1) devuelve 1998-03-09.

DATESDATES devuelve una cadena de fecha en formato "aa-mm-dd" o "aaaa-mm-dd", que corresponde a undeterminado año, mes y día.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

DATES(year, month, day)

Argumento Descripción

year Un año, expresado en formato aa o aaaa.

month Un mes, expresado en formato mm.

day Un día, expresado en formato dd.

Ejemplo

DATES(98, 2, 10) devuelve "10.02.98".

DATES(1998, 2, 10) devuelve "1998-02-10".

Capítulo 2. Funciones de reglas 121

DAYDAY devuelve un valor numérico para el día en una determinada cadena de fecha.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

DAY(DateString)

Argumento Descripción

DateString Una cadena de fecha en formato AA-MM-DD oAAAA-MM-DD.

Ejemplo

DAY('02-05-25') devuelve 25.

DAYNODAYNO devuelve el número de fecha de serie que corresponde a una determinada cadena de fecha.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Nota: DAYNO puede devolver fechas de serie a partir del 1 de enero de 1960 (cadena de fecha1960-01-01 o 60-01-01). En lo que respecta a las fechas a partir del 31 de diciembre de 2059, utilice unaño de cuatro dígitos en la cadena de fecha. Por ejemplo, la cadena de fecha correspondiente al 5 deenero de 2061 sería 2061-01-05.

Sintaxis

DAYNO('DateString')

Argumento Descripción

DateString Una cadena de fecha en formato AA-MM-DD oAAAA-MM-DD.

Ejemplo

DAYNO('98-03-09') devuelve 13947.

MONTHMONTH devuelve un valor numérico para el mes en una determinada cadena de fecha.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

MONTH(date)

Argumento Descripción

date Una cadena de fecha en formato AA-MM-DD oAAAA-MM-DD.

122 IBM Planning Analytics: Referencia de TM1

Ejemplo

MONTH('02-05-25') devuelve 5.

NOWNOW devuelve el valor actual de fecha/hora en formato de número de serie.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

NOW

Argumentos

Ninguno.

Ejemplo

NOW devuelve el valor actual de fecha/hora en formato de número de serie.

TIMETIME devuelve una cadena, en formato HH:MM, que representa la hora del sistema del servidor de TM1.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

TIME

Argumentos

Ninguno.

Ejemplo

Si se proporciona una hora del sistema de 9:33 AM, TIME devuelve la cadena "09:33".

Si se proporciona una hora del sistema de 9:33 PM, TIME devuelve la cadena "21:33".

TIMSTTIMST devuelve una cadena de fecha/hora con formato.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

TIMST(datetime, format, ExtendedYears)

Capítulo 2. Funciones de reglas 123

Argumento Modificador/

Descripción

datetime Un número de serie de fecha/hora.

La parte entera del número especifica la fecha y laparte decimal especifica la hora del día. El númerode día 0 corresponde a "60-01-01". Los númerosnegativos corresponden a años anteriores. Losaños del siglo XXI, hasta 2059, se representan poraños de 00 a 59. Una hora es la veinticuatroavaparte de un día, un minuto es la sesentava parte deuna hora y un segundo es la sesentava parte de unminuto.

format Una cadena que da formato al resultado de lafunción. Todos los caracteres del argumento deformato aparecen en el resultado, a excepción delos siguientes caracteres, que devuelven valoresde componentes de fecha/hora:

\y

los últimos dos dígitos del año (97, 98, etc.)

\Y

los cuatro dígitos del año (1997, 1998, etc.)

\m

los dos dígitos del mes (de 01 a 12)

\M

la abreviatura del mes (JAN, FEB, etc.)

\d

los dos dígitos del día (de 01 a 31)

\D

el dígito del día (de 1 a 31)

\h

la hora en tiempo militar (de 00 a 23)

\H

la hora estándar (de 1 a 12)

\i

el minuto (de 00 a 59)

\s

el segundo (de 00 a 59)

124 IBM Planning Analytics: Referencia de TM1

Argumento Modificador/

Descripción

\p

a.m. o p.m.

ExtendedYears Este parámetro booleano opcional especifica si lafunción devuelve una fecha que queda dentro delrango 1960 -2059 o 1960 - 9999.

Si ExtendedYears es true, la función devuelve unafecha que queda dentro del rango Jan. 1, 1960 -Dec. 31, 9999. La fecha de serie 0 corresponde aJan. 1, 1960 y la fecha de serie 2936549corresponde a Dec. 31, 9999.

Si ExtendedYears es false, o si este argumentoopcional se omite de la función TIMST, la funcióndevuelve una fecha que queda dentro del rangoJan. 1, 1960 - Dec. 31, 2059. La fecha de serie 0corresponde a Jan 1, 1960 y la fecha de serie36524 corresponde a Dec. 31, 2059.

Si ExtendedYears es falso o se omite y especificauna fecha de serie mayor que 36524, la fecha deserie utilizada por la función se determinamediante la fórmula n - 36525. Por ejemplo, siespecifica una fecha de serie de 36530, entonces36530 - 36525 = 5. En este caso, TIMST utiliza 5como la fecha de serie y devuelve la fecha Jan. 6,1960.

Ejemplo

TIMST(366.0000, '\M \D, \Y') devuelve "JAN 1, 1961".

TIMST(366.5000, '\H\p \imin\ssec') devuelve "12p.m. 00min00sec".

TIMST(366.1000, 'On \M \D, \Y at \H\p \imin\ssec') devuelve "On JAN 1, 1961 at 2a.m. 24min00sec".

TIMST(11111.1100, 'On \M \D, \Y at \H\p \imin\ssec') devuelve 'On JUN 3,1990 at 2a.m. 38min24sec'.

TIMVLTIMVL devuelve el valor numérico de un componente (año, mes, etc.) de un valor de fecha/hora.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

TIMVL(datetime, type, ExtendedYears)

Capítulo 2. Funciones de reglas 125

Argumento Modificador y

Descripción

datetime Número de serie de fecha y hora.

La parte entera del número especifica la fecha y laparte decimal especifica la hora del día. El númerode día 0 corresponde a "60-01-01". Los númerosnegativos corresponden a años anteriores. Losaños del siglo XXI, hasta 2059, se representan poraños de 00 a 59. Una hora es la veinticuatroavaparte de un día, un minuto es la sesentava parte deuna hora y un segundo es la sesentava parte de unminuto.

type Un carácter que especifica el tipo de componenteque debe extraerse. A continuación, se indicanargumentos type válidos:

Y

valor year (1997, 1998, etc.)

M

valor month (de 1 a 12)

D

valor day (de 1 a 31)

H

valor hour (de 0 a 23)

C

valor minute (de 00 a 59)

S

valor second (de 00 a 59)

126 IBM Planning Analytics: Referencia de TM1

Argumento Modificador y

Descripción

ExtendedYears Este parámetro booleano opcional especifica si lafunción devuelve una fecha que queda dentro delrango 1960 -2059 o 1960 - 9999.

Si ExtendedYears es true, la función devuelve unafecha que queda dentro del rango Jan. 1, 1960 -Dec. 31, 9999. La fecha de serie 0 corresponde aJan. 1, 1960 y la fecha de serie 2936549corresponde a Dec. 31, 9999.

Si ExtendedYears es false, o si este argumentoopcional se omite de la función TIMVL, la funcióndevuelve una fecha que queda dentro del rangoJan. 1, 1960 - Dec. 31, 2059. La fecha de serie 0corresponde a Jan 1, 1960 y la fecha de serie36524 corresponde a Dec. 31, 2059.

Si ExtendedYears es falso o se omite y especificauna fecha de serie mayor que 36524, la fecha deserie utilizada por la función se determinamediante la fórmula n - 36525. Por ejemplo, siespecifica una fecha de serie de 36530, entonces36530 - 36525 = 5. En este caso, TIMVL utiliza 5como la fecha de serie y devuelve la fecha Jan. 6,1960.

Ejemplo

TIMVL(11111.1100, 'Y') devuelve 1990.

TIMVL(11111.1100, 'H') devuelve 2.

TODAYTODAY devuelve la fecha actual en formato aa-mm-dd.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

TODAY(<ReturnFourDigitYear>)

Capítulo 2. Funciones de reglas 127

Argumento Descripción

ReturnFourDigitYear Un argumento booleano opcional que determina sila función TODAY devuelve una cadena que utilizauna notación de dos o cuatro dígitos para el año.

Si ReturnFourDigitYear es true, la función devuelveuna fecha que queda dentro del rango Jan. 1, 1960- Dec. 31, 9999, utilizando una notación de cuatrodígitos para el año. La fecha de serie 0corresponde a Jan. 1, 1960 y la fecha de serie2936549 corresponde a Dec. 31, 9999.

Si ReturnFourDigitYear es false, o si esteargumento opcional se omite de la función TODAY,la función devuelve una fecha que queda dentrodel rango Jan. 1, 1960 - Dec. 31, 2059, utilizandouna notación de dos dígitos para el año. La fechade serie 0 corresponde a Jan 1, 1960 y la fecha deserie 36524 corresponde a Dec. 31, 2059.

Si ReturnFourDigitYear es falso o se omite yespecifica una fecha de serie mayor que 36524, lafecha de serie utilizada por la función se determinamediante la fórmula n - 36525. Por ejemplo, siespecifica una fecha de serie de 36530, entonces36530 - 36525 = 5. En este caso, TODAY utiliza 5como la fecha de serie y devuelve la fecha Jan. 6,1960.

Ejemplo

P1=TODAY(1) devuelve una cadena de fecha en formato AAAA-MM-DD como 2009-06-05.

P1=TODAY(0) devuelve una cadena de fecha en formato AA-MM-DD como 09-06-05

YEARYEAR devuelve un valor numérico para el año en una determinada cadena de fecha.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

YEAR(date)

Argumento Descripción

date Una cadena de fecha en formato AA-MM-DD.

Ejemplo

YEAR('02-05-25') devuelve 2.

Funciones de reglas de información de dimensionesFunciones de regla que gestionan la información de dimensiones.

128 IBM Planning Analytics: Referencia de TM1

DIMIXDIMIX devuelve el número de índice de un elemento de una dimensión.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

DIMIX(server_name:dimension, element)

Argumento Descripción

dimension Nombre de dimensión válido calificado con elnombre del servidor.

element El nombre de un elemento de la dimensión.

Si el elemento no es un elemento de la dimensiónespecificada, la función devuelve 0.

Ejemplo

Brazil tiene un valor de índice de tres en la dimensión Region. El ejemplo devuelve 3.

DIMIX('planning_sample:Region','Brazil')

DIMNMDIMNM devuelve el elemento de una dimensión que corresponde al argumento de índice.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

DIMNM(server_name:dimension, index)

Argumento Descripción

dimension Nombre de dimensión válido calificado con elnombre del servidor.

index Un valor menor o igual que el número deelementos de la dimensión.

Si este argumento es menor que 1 o mayor que elnúmero de elementos de la dimensión, la funcióndevuelve 0.

Ejemplo

Este ejemplo devuelve "Belgium", que es el elemento de la dimensión Region con un valor de índice de 2.

DIMNM(planning_sample:'Region',2)

DIMSIZDIMSIZ devuelve el número de elementos de una dimensión especificada.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Capítulo 2. Funciones de reglas 129

Sintaxis

DIMSIZ(dimension)

Argumento Descripción

dimension Un nombre de dimensión válido.

En algunas instalaciones es necesario calificar elnombre de la dimensión con el nombre delservidor, como en server_name:dimension.

Ejemplo

Si la dimensión Accounts incluye 19 elementos, el ejemplo devuelve el valor 19.

DIMSIZ('Accounts')

DNEXTDNEXT devuelve el nombre de elemento que sigue al elemento especificado como argumento de lafunción.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

DNEXT(dimension, element)

Argumento Descripción

dimension Un nombre de dimensión válido.

En algunas instalaciones es necesario calificar elnombre de la dimensión con el nombre delservidor, como en server_name:dimension.

element El nombre de un elemento de la dimensión. Esteargumento puede ser también el nombre de unalias de un elemento de la dimensión.

Ejemplo

Si la dimensión Location contiene los elementos ordenados California, Oregon y Washington, el ejemplodevuelve Washington.

DNEXT("Location","Oregon")

DNLEVDNLEV devuelve los niveles de número de una dimensión.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

DNLEV(dimension)

130 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

dimension Un nombre de dimensión válido.

En algunas instalaciones es necesario calificar elnombre de la dimensión con el nombre delservidor, como en server_name:dimension.

Ejemplo

DNLEV('Region')

En la dimensión Region, las diversas naciones (nivel 0) se agregan formando regiones (nivel 1). Lasregiones se agregan formando superregiones (nivel 2), que a su vez se agregan formando el mundo (nivel3).

Existen cuatro niveles en la dimensión Region, de modo que el ejemplo devuelve el valor 4.

DTYPEDTYPE devuelve información sobre el tipo de elemento de un elemento especificado. DTYPE devuelve Nsi el elemento es un elemento numérico, S si el elemento es un elemento de cadena y C si el elemento esun elemento consolidado.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

DTYPE(dimension, element)

Argumento Descripción

dimension Un nombre de dimensión válido.

element El nombre de un elemento de la dimensión.

Ejemplo

El elemento Europe es un elemento consolidado de la dimensión Region, de modo que el ejemplodevuelve C.

DTYPE('Region','Europe')

TABDIMTABDIM devuelve el nombre de dimensión que corresponde al argumento de índice.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Capítulo 2. Funciones de reglas 131

Sintaxis

TABDIM(cube, index)

Argumento Descripción

cube Un nombre de cubo válido.

index Un valor positivo menor o igual que el número totalde dimensiones del cubo.

Ejemplo

El cubo SalesCube contiene cinco dimensiones: account1, actvsbud, model, month y region. El ejemplodevuelve model, la tercera dimensión de SalesCube.

TABDIM('SalesCube',3)

Funciones de reglas de información de elementosFunciones de regla que gestionan la información de elementos.

ELCOMPELCOMP devuelve el nombre de un hijo de un elemento consolidado de una dimensión especificada.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ELCOMP(dimension, element, position)

Argumento Descripción

dimension Un nombre de dimensión válido.

element El nombre de un elemento consolidado de ladimensión.

position Un valor positivo menor o igual que el número totalde hijos del elemento especificado.

Ejemplo

En la dimensión Region, el elemento consolidado Central Europe es una consolidación de los hijos Francey Germany. Germany se encuentra en la segunda posición de esta consolidación. De esta manera, elejemplo devuelve Germany.

ELCOMP('Region','Central Europe',2)

ELCOMPNELCOMPN devuelve el número de componentes de un elemento especificado. Si el argumento element noes un elemento consolidado, la función devuelve 0.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

132 IBM Planning Analytics: Referencia de TM1

Sintaxis

ELCOMPN(dimension, element)

Argumento Descripción

dimension Un nombre de dimensión válido.

element El nombre de un elemento consolidado de ladimensión.

Ejemplo

En la dimensión Region, el elemento Scandinavia es una consolidación de tres elementos. El ejemplodevuelve 3.

ELCOMPN('Region','Scandinavia')

ElementComponentElementComponent devuelve el nombre de un hijo de un elemento consolidado de una dimensiónespecificada. Si el argumento element no es un elemento consolidado, la función devuelve 0.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ElementComponent(dimension, hierarchy, element, position)

Argumento Descripción

dimension Un nombre de dimensión válido.

hierarchy Nombre de la jerarquía de la dimensión.

element El nombre de un elemento consolidado de ladimensión.

position Un valor positivo menor o igual que el número totalde hijos del elemento especificado.

Ejemplo

En la dimensión Region, el elemento consolidado Central Europe es una consolidación de los hijos Francey Germany. Germany se encuentra en la segunda posición de esta consolidación. De esta manera, elejemplo devuelve Germany.

ElementComponent('Region', 'Europe', 'Central Europe', 2)

ElementComponentCountElementComponentCount devuelve el número de componentes de un elemento especificado. Si elargumento element no es un elemento consolidado, la función devuelve 0.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Capítulo 2. Funciones de reglas 133

Sintaxis

ElementComponentCount(dimension, hierarchy, element)

Argumento Descripción

dimension Un nombre de dimensión válido.

hierarchy Nombre de la jerarquía de la dimensión.

element El nombre de un elemento consolidado de ladimensión.

Ejemplo

En la dimensión Region, el elemento Scandinavia es una consolidación de tres elementos. El ejemplodevuelve 3.

ElementComponentCount('Region', '', 'Scandinavia')

ElementCountElementCount devuelve el número de elementos de una dimensión especificada.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ElementCount(dimension, hierarchy)

Argumento Descripción

dimension Un nombre de dimensión válido.

En algunas instalaciones es necesario añadir elnombre de la dimensión al nombre del servidor,como en server_name:dimension.

hierarchy Nombre de la jerarquía de la dimensión.

Ejemplo

Si la jerarquía Receivables de la dimensión Accounts incluye 19 elementos, el ejemplo devuelve el valor19.

ElementCount('Accounts', 'Receivables')

ElementFirstElementFirst devuelve el primer elemento de una dimensión especificada.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ElementFirst(server_name:dimension, hierarchy)

134 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

dimension Un nombre de dimensión válido.

hierarchy Nombre de la jerarquía de la dimensión.

Ejemplo

Si la jerarquía North America de la dimensión Location contiene los elementos ordenados California,Oregon y Washington, el ejemplo devuelve California.

ElementFirst("planning_sample:Location", "North America")

ElementIndexElementIndex devuelve el número de índice de un elemento de una dimensión.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ElementIndex(server_name:dimension, hierarchy, element)

Argumento Descripción

dimension Nombre de dimensión válido calificado con elnombre del servidor.

hierarchy Nombre de la jerarquía de la dimensión.

element El nombre de un elemento de la dimensión.

Si el elemento no es un elemento de la dimensiónespecificada, la función devuelve 0.

Ejemplo

Brazil tiene un valor de índice de tres en la dimensión Region. El ejemplo devuelve 3.

ElementIndex('planning_sample:Region', 'South America', 'Brazil')

ElementIsAncestorElementIsAncestor determina si element1 es un ancestro de element2 en la dimensión especificada. Lafunción devuelve 1 si element1 es un ancestro de element2; de lo contrario, la función devuelve 0.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ElementIsAncestor(dimension, hierarchy, element1, element2)

Argumento Descripción

dimension Un nombre de dimensión válido.

hierarchy Nombre de la jerarquía de la dimensión.

Capítulo 2. Funciones de reglas 135

Argumento Descripción

element1 El nombre de un elemento de la dimensión.

element2 El nombre de un elemento de la dimensión.

Ejemplo

En la jerarquía Western de la dimensión Region, el elemento Europe es un ancestro de Germany. Elejemplo devuelve 1.

ElementIsAncestor('Region', 'Western', 'Europe', 'Germany')

ElementIsComponentElementIsComponent determina si element1 es un hijo de element2 en la dimensión especificada. Lafunción devuelve 1 si element1 es un hijo de element2; de lo contrario, la función devuelve 0.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ElementIsComponent(dimension, hierarchy, element1, element2)

Argumento Descripción

dimension Un nombre de dimensión válido.

hierarchy Nombre de la jerarquía de la dimensión.

element1 El nombre de un elemento de la dimensión.

element2 El nombre de un elemento de la dimensión.

Ejemplo

En la dimensión Region, el elemento Central Europe es una consolidación de dos elementos, Germany yFrance. El ejemplo devuelve 1.

Nota: Esta función devuelve 1 únicamente para hijos inmediatos. En el ejemplo anterior, Germany es unhijo de Central Europe. Además, Central Europe es un hijo de Europe.

ElementIsComponent('Region', 'Countries', 'Germany', 'Central Europe')

Sin embargo, dado que la función devuelve 1 únicamente para hijos inmediatos, el siguiente ejemplodevuelve 0:

ElementIsComponent('Region', 'Countries'', 'Germany', 'Europe')

ElementIsParentElementIsParent determina si element1 es un padre de element2 en la dimensión especificada. Lafunción devuelve 1 si element1 es un padre de element2; de lo contrario, la función devuelve 0.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

136 IBM Planning Analytics: Referencia de TM1

Sintaxis

ElementIsParent(dimension, hierarchy, element1, element2)

Argumento Descripción

dimension Un nombre de dimensión válido.

hierarchy Nombre de la jerarquía de la dimensión.

element1 El nombre de un elemento de la dimensión.

element2 El nombre de un elemento de la dimensión.

Ejemplo

En la dimensión Region, el elemento consolidado Central Europe es el padre tanto de Germany como deFrance. De esta manera, el ejemplo devuelve 1.

Nota: Esta función devuelve 1 únicamente para padres inmediatos. En el ejemplo anterior, Europe es unpadre de Central Europe. Además, Central Europe es un padre de Germany.

ElementIsParent('Region', 'Countries', 'Central Europe', 'Germany')

Sin embargo, dado que Europe no es un padre inmediato de Germany, el siguiente ejemplo devuelve 0:

ElementIsParent('Region', 'Countries', 'Europe', 'Germany')

ElementLevelElementLevel devuelve el nivel de un elemento de una dimensión.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ElementLevel(dimension, hierarchy, element)

Argumento Descripción

dimension Un nombre de dimensión válido.

hierarchy Nombre de la jerarquía de la dimensión.

element El nombre de un elemento de la dimensión.

Ejemplo

ElementLevel('Region','Countries', 'Europe')

En la dimensión Region, las naciones individuales (nivel 0) se agregan formando regiones (nivel 1). Lasregiones se agregan formando superregiones (nivel 2), que a su vez se agregan formando el mundo (nivel3). El ejemplo devuelve 2, dado que Europe es un elemento de nivel 2.

Capítulo 2. Funciones de reglas 137

ElementNameElementName devuelve el elemento de una dimensión que corresponde al argumento de índice.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ElementName(server_name:dimension, hierarchy, index)

Argumento Descripción

dimension Nombre de dimensión válido calificado con elnombre del servidor.

hierarchy Nombre de la jerarquía de la dimensión.

index Un valor menor o igual que el número deelementos de la dimensión.

Si este argumento es menor que 1 o mayor que elnúmero de elementos de la dimensión, la funcióndevuelve 0.

Ejemplo

Este ejemplo devuelve "Belgium", que es el elemento contenido en la jerarquía Countries de la dimensiónRegion con un valor de índice de 2.

ElementName(planning_sample:'Region', 'Countries', 2)

ElementNextElementNext devuelve el nombre de elemento que sigue al elemento especificado como argumento de lafunción.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ElementNext(dimension, hierarchy, element)

138 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

dimension Un nombre de dimensión válido.

En algunas instalaciones es necesario añadir elnombre de la dimensión al nombre del servidor,como en server_name:dimension.

hierarchy Nombre de la jerarquía de la dimensión.

element El nombre de un elemento de la dimensión. Esteargumento puede ser también el nombre de unalias de un elemento de la dimensión.

Ejemplo

Si la dimensión Location contiene los elementos ordenados California, Oregon y Washington, el ejemplodevuelve Washington.

ElementNext("Location","Cities", "Oregon")

ElementParentElementParent devuelve el padre de un elemento en una dimensión especificada.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ElementParent(dimension, hierarchy, element, index)

Argumento Descripción

dimension Un nombre de dimensión válido.

hierarchy Nombre de la jerarquía de la dimensión.

element El nombre de un elemento de la dimensión.

index Un valor positivo menor o igual que el número totalde elementos consolidados (padres) que utilizan elargumento element como hijo.

Ejemplo

En la dimensión Model, el elemento Wagon 4WD es un hijo tanto de Total Wagons como de Total 4WD.Por lo tanto, tanto Total Wagons como Total 4 WD son padres de Wagon 4WD. En la estructura de ladimensión Model, Total Wagons se define en primer lugar y Total 4WD se define en segundo lugar.

ElementParent('Model', 'Automobile', 'Wagon 4WD', 2)

El ejemplo devuelve Total 4WD, ya que es la segunda instancia de un padre de Wagon 4WD en ladimensión Model.

ElementParentCountElementParentCount devuelve el número de padres de un elemento de una dimensión especificada.

Capítulo 2. Funciones de reglas 139

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ElementParentCount(dimension, hierarchy, element)

Argumento Descripción

dimension Un nombre de dimensión válido.

hierarchy Nombre de la jerarquía de la dimensión.

element El nombre de un elemento de la dimensión.

Ejemplo

En la dimensión Model, el elemento Wagon 4WD es un hijo tanto de Total Wagons como de Total 4WD.Por lo tanto, tanto Total Wagons como Total 4 WD son padres de Wagon 4WD. La función devuelve 2.

ElementParentCount('Model', 'Automobile', 'Wagon 4WD')

ElementTypeElementType devuelve información sobre el tipo de elemento de un elemento especificado. ElementTypedevuelve N si el elemento es un elemento numérico, S si el elemento es un elemento de cadena y C si elelemento es un elemento consolidado.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ElementType(dimension, hierarchy, element)

Argumento Descripción

dimension Un nombre de dimensión válido.

hierarchy Nombre de la jerarquía de la dimensión.

element El nombre de un elemento de la dimensión.

Ejemplo

El elemento Europe es un elemento consolidado de la dimensión Region, de modo que el ejemplodevuelve C.

ElementType('Region', 'Countries', 'Europe')

ElementWeightElementWeight devuelve el peso de un hijo de un elemento consolidado.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ElementWeight(dimension, hierarchy, element1, element2)

140 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

dimension Un nombre de dimensión válido.

hierarchy Nombre de la jerarquía de la dimensión.

element1 El nombre de un elemento consolidado de ladimensión.

element2 El nombre de un hijo del elemento consolidado.

Ejemplo

El elemento Variable Costs, que es un hijo de Gross margin, tiene un peso de -1. El siguiente ejemplodevuelve -1.

ElementWeight('Account1', 'SubAccount1', 'Gross margin', 'Variable Costs')

ELISANCELISANC determina si element1 es un ancestro de element2 en la dimensión especificada. La funcióndevuelve 1 si element1 es un ancestro de element2; de lo contrario, la función devuelve 0.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ELISANC(dimension, element1, element2)

Argumento Descripción

dimension Un nombre de dimensión válido.

element1 El nombre de un elemento de la dimensión.

element2 El nombre de un elemento de la dimensión.

Ejemplo

En la dimensión Region, el elemento Europe es un ancestro de Germany. El ejemplo devuelve 1.

ELISANC('Region', 'Europe', 'Germany')

ELISCOMPELISCOMP determina si element1 es un hijo de element2 en la dimensión especificada. La funcióndevuelve 1 si element1 es un hijo de element2; de lo contrario, la función devuelve 0.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ELISCOMP(dimension, element1, element2)

Capítulo 2. Funciones de reglas 141

Argumento Descripción

dimension Un nombre de dimensión válido.

element1 El nombre de un elemento de la dimensión.

element2 El nombre de un elemento de la dimensión.

Ejemplo

En la dimensión Region, el elemento Central Europe es una consolidación de dos elementos, Germany yFrance. El siguiente ejemplo devuelve 1.

Nota: Esta función devuelve 1 únicamente para hijos inmediatos. En este ejemplo, Germany es un hijo deCentral Europe. Además, Central Europe es un hijo de Europe.

ELISCOMP('Region','Germany','Central Europe')

Sin embargo, dado que la función devuelve 1 únicamente para hijos inmediatos, el siguiente ejemplodevuelve 0:

ELISCOMP('Region','Germany','Europe')

ELISPARELISPAR determina si element1 es un padre de element2 en la dimensión especificada. La funcióndevuelve 1 si element1 es un padre de element2; de lo contrario, la función devuelve 0.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ELISPAR(dimension, element1, element2)

Argumento Descripción

dimension Un nombre de dimensión válido.

element1 El nombre de un elemento de la dimensión.

element2 El nombre de un elemento de la dimensión.

Ejemplo

En la dimensión Region, el elemento consolidado Central Europe es el padre tanto de Germany como deFrance. En consecuencia, el siguiente ejemplo devuelve 1.

Nota: Esta función devuelve 1 únicamente para padres inmediatos. En este ejemplo, Europe es un padrede Central Europe. Además, Central Europe es un padre de Germany.

ELISPAR('Region','Central Europe','Germany')

Sin embargo, dado que Europe no es un padre inmediato de Germany, el siguiente ejemplo devuelve 0:

ELISPAR('Region','Europe','Germany')

ELLEVELLEV devuelve el nivel de un elemento de una dimensión.

142 IBM Planning Analytics: Referencia de TM1

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ELLEV(dimension, element)

Argumento Descripción

dimension Un nombre de dimensión válido.

element El nombre de un elemento de la dimensión.

Ejemplo

ELLEV('Region','Europe')

En la dimensión Region, las naciones individuales (nivel 0) se agregan formando regiones (nivel 1). Lasregiones se agregan formando superregiones (nivel 2), que a su vez se agregan formando el mundo (nivel3). El ejemplo devuelve 2, dado que Europe es un elemento de nivel 2.

ELPARELPAR devuelve el padre de un elemento en una dimensión especificada.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ELPAR(dimension, element, index)

Argumento Descripción

dimension Un nombre de dimensión válido.

element El nombre de un elemento de la dimensión.

index Un valor positivo menor o igual que el número totalde elementos consolidados (padres) que utilizan elargumento element como hijo.

Capítulo 2. Funciones de reglas 143

Ejemplo

En la dimensión Model, el elemento Wagon 4WD es un hijo tanto de Total Wagons como de Total 4WD.Por lo tanto, tanto Total Wagons como Total 4 WD son padres de Wagon 4WD. En la estructura de ladimensión Model, Total Wagons se define en primer lugar y Total 4WD se define en segundo lugar.

ELPAR('Model','Wagon 4WD',2)

El ejemplo devuelve Total 4WD, ya que es la segunda instancia de un padre de Wagon 4WD en ladimensión Model.

ELPARNELPARN devuelve el número de padres de un elemento de una dimensión especificada.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ELPARN(dimension, element)

Argumento Descripción

dimension Un nombre de dimensión válido.

element El nombre de un elemento de la dimensión.

Ejemplo

En la dimensión Model, el elemento Wagon 4WD es un hijo tanto de Total Wagons como de Total 4WD.Por lo tanto, tanto Total Wagons como Total 4 WD son padres de Wagon 4WD. La función devuelve 2.

ELPARN('Model','Wagon 4WD')

ELWEIGHTELWEIGHT devuelve el peso de un hijo de un elemento consolidado.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ELWEIGHT(dimension, element1, element2)

Argumento Descripción

dimension Un nombre de dimensión válido.

element1 El nombre de un elemento consolidado de ladimensión.

element2 El nombre de un hijo del elemento consolidado.

Ejemplo

El elemento Variable Costs, que es un hijo de Gross margin, tiene un peso de -1.

144 IBM Planning Analytics: Referencia de TM1

El siguiente ejemplo devuelve -1.

ELWEIGHT('Account1','Gross margin','Variable Costs')

LevelCountLevelCount devuelve los niveles de número de una dimensión.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

LevelCount(dimension, hierarchy)

Argumento Descripción

dimension Un nombre de dimensión válido.

En algunas instalaciones es necesario calificar elnombre de la dimensión con el nombre delservidor, como en server_name:dimension.

hierarchy Nombre de la jerarquía de la dimensión.

Ejemplo

LevelCount('Region', 'Countries')

En la dimensión Region, las diversas naciones (nivel 0) se agregan formando regiones (nivel 1). Lasregiones se agregan formando superregiones (nivel 2), que a su vez se agregan formando el mundo (nivel3).

Existen cuatro niveles en la dimensión Region, de modo que el ejemplo devuelve el valor 4.

Funciones de reglas financierasFunciones de regla utilizadas para gestionar información financiera.

FVFV devuelve el valor de una anualidad en el momento del último pago. Una anualidad es una serie depagos realizados a intervalos iguales de tiempo. Se presupone que los pagos se realizarán al final de cadaperiodo.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Capítulo 2. Funciones de reglas 145

Sintaxis

FV(payment, interest, periods)

Argumento Descripción

payment La cantidad del pago realizado por periodo.

interest El tipo de interés pagado por periodo.

periods El número de periodos de la anualidad.

Ejemplo

Este ejemplo devuelve el valor de una anualidad transcurridos 5 años, con pagos de 1.000 dólaresestadounidenses al año con un interés del 14%.

FV(1000, .14, 5)

PAYMTPAYMT devuelve la cantidad de pago de una anualidad basada en un determinado valor inicial o capital,un tipo de interés y un número de periodos. Una anualidad es una serie de pagos realizados a intervalosiguales de tiempo.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

PAYMT(principal, interest, periods)

Argumento Descripción

principal El valor actual o la cantidad total que vale ahorauna serie de pagos futuros.

interest El tipo de interés pagado por periodo.

periods El número de periodos de la anualidad. Sepresupone que los pagos se realizarán al final decada periodo.

Ejemplo

Este ejemplo devuelve el pago de una anualidad de 5 años que se paga anualmente, con un capital de100.000 dólares estadounidenses y un tipo de interés del 14%.

PAYMT(100000, .14, 5)

PVPV devuelve el valor inicial o principal de una anualidad.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

PV(payment, interest, periods)

146 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

payment La cantidad del pago realizado.

interest El tipo de interés pagado por periodo.

periods El número de periodos de la anualidad. Sepresupone que los pagos se realizarán al final decada periodo.

Ejemplo

Este ejemplo devuelve el valor principal de una anualidad con 5 pagos anuales de 1.000 dólaresestadounidenses y un tipo de interés del 14%.

PV(1000, .14, 5)

Funciones de reglas de jerarquíasFunciones para gestionar las jerarquías en las reglas.

JerarquíaSi solo se incluye una jerarquía en la dimensión proporcionada, la función Hierarchy devuelve el nombrede la jerarquía. En caso contrario, devuelve una serie vacía. La función Hierarchy solo es válida en lasreglas de TM1.

Con la introducción del soporte de varias jerarquías en TM1, es necesario identificar qué jerarquías estánen contexto cuando se utilizan varias jerarquías.

La función Hierarchy no se puede utilizar en procesos de TurboIntegrator. La presencia de esta función enun proceso impedirá la compilación del mismo.

Sintaxis

Hierarchy (DimName);

Argumento Descripción

DimName Un nombre de dimensión válido.

Ejemplo

Este ejemplo devuelve 'Quarter', que es la única jerarquía de la dimensión Quarter.

Hierarchy ('Quarter');

HierarchyCountHierarchyCount devuelve el número de jerarquías de la dimensión proporcionada. La funciónHierarchyCount solo es válida en las reglas de TM1.

La función HierarchyCount no se puede utilizar en procesos de TurboIntegrator. La presencia de estafunción en un proceso impedirá la compilación del mismo.

Capítulo 2. Funciones de reglas 147

Sintaxis

HierarchyCount (DimName);

Argumento Descripción

DimName Un nombre de dimensión válido.

Ejemplo

Este ejemplo devuelve 3, que es el número de jerarquías de la dimensión del modelo.

HierarchyCount ('model');

HierarchyIndexHierarchyIndex devuelve un índice basado en 1 si la jerarquía están en la dimensión suministrada, de locontrario, devuelve 0. La función HierarchyIndex solo es válida en reglas de TM1.

La función HierarchyIndex no se puede utilizar en procesos de TurboIntegrator. La presencia de estafunción en un proceso impedirá la compilación del mismo.

Sintaxis

HierarchyIndex (DimName, HierName);

Argumento Descripción

DimName Un nombre de dimensión válido.

HierName Un nombre de jerarquía válido del que deseabuscar la posición del índice en DimName.

Ejemplo

Este ejemplo devuelve 3, que es la posición de la jerarquía CustomerTarget de la dimensión del modelo.

HierarchyIndex ('model', 'CustomerTarget');

HierarchyNLa función HierarchyN devuelve el nombre de la jerarquía en una posición especificada en la dimensiónproporcionada y una serie vacía si el índice está fuera de ámbito. La función HierarchyN solo es válida enreglas de TM1.

La función HierarchyN no se puede utilizar en procesos de TurboIntegrator. La presencia de esta funciónen un proceso impedirá la compilación del mismo.

Sintaxis

HierarchyN (DimName, index);

Argumento Descripción

DimName Un nombre de dimensión válido.

148 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

index Un valor menor o igual que el número de jerarquíasde la dimensión.

Si este argumento es menor que 1 o mayor que elnúmero de jerarquías de la dimensión, la funcióndevuelve 0.

Ejemplo

Este ejemplo devuelve 'CustomerTarget', que es la tercera jerarquía de la dimensión del modelo.

HierarchyN ('model', 3);

Funciones de reglas lógicasOperadores lógicos para utilizar en reglas.

CONTINUESi se incluye como parte de una expresión de reglas, CONTINUE permite una regla posterior con la mismadefinición de área para ejecutarse. Normalmente, TM1 solo ejecuta la primera regla que encuentra parauna determinada área.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

CONTINUE

Argumentos

Ninguno.

Ejemplo

['Jan']= if(!region @= 'Argentina',10,CONTINUE);

['Jan']=20;

En este ejemplo, a todas las celdas identificadas por January y Argentina se les asigna un valor de 10. Alas celdas identificadas por Jan y cualquier otro elemento Region se les asigna un valor de 20.

IFIF devuelve un valor si la expresión lógica que especifica es TRUE y otro valor si es FALSE.

Esta función solo es válida en las reglas de TM1.

TurboIntegrator utiliza su propia función IF, que puede evaluar varias expresiones lógicas.

Sintaxis

IF(expression, true_value, false_value)

Capítulo 2. Funciones de reglas 149

Argumento Descripción

expression Cualquier valor o expresión que puede evaluarsecomo TRUE o FALSE.

true_value El valor que se devuelve si la expresión es TRUE.

false_value El valor que se devuelve si la expresión es FALSE.

Ejemplo

IF(1<2, 4, 5) devuelve 4.

IF(1>2, 'ABC', 'DEF') devuelve 'DEF'.

STETLa función STET cancela el efecto de una regla para un elemento en concreto.

Se trata de una función de reglas de TM1, que solo es válida en las reglas de TM1. Esta función no puedeutilizarse en procesos de TurboIntegrator.

Sintaxis

STET

Argumentos

Ninguno.

Ejemplo

En este ejemplo, la regla dicta que el valor de Sales es siempre 100, excepto para la intersección de Salesy el elemento France de la dimensión Region.

['Sales'] = IF(!Region @= 'France',STET, 100);

Funciones de reglas matemáticasOperadores matemáticos para utilizar en reglas.

ABSABS devuelve el valor absoluto de un número.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ABS(x)

Argumento Descripción

x El número cuyo valor absoluto desea averiguar.

Ejemplo

ABS(-1.2) devuelve 1.2

150 IBM Planning Analytics: Referencia de TM1

ACOSACOS devuelve el ángulo, en radianes, cuyo coseno es x.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ACOS(x)

Argumento Descripción

x El coseno del ángulo que desea encontrar. x debeestar entre -1 y 1; de lo contrario, la funcióndevuelve un error.

Ejemplo

ACOS(0) devuelve 1.5708.

ASINASIN devuelve el ángulo, en radianes, cuyo seno es x.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ASIN(x)

Argumento Descripción

x El seno del ángulo que desea encontrar. x debeestar entre -1 y 1; de lo contrario, la funcióndevuelve un error.

Ejemplo

ASIN(1) devuelve 1.5708.

ATANATAN devuelve el ángulo, en radianes, cuya tangente es x. El resultado se encuentra entre -pi/2 y +pi/2.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ATAN(x)

Argumento Descripción

x La tangente del ángulo que desea averiguar.

Ejemplo

ATAN(1) devuelve .7854.

Capítulo 2. Funciones de reglas 151

COSCOS devuelve el coseno de un ángulo expresado en radianes.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

COS(x)

Argumento Descripción

x Un ángulo, expresado en radianes, cuyo cosenodesea averiguar.

Ejemplo

COS(0) devuelve 1.

EXPEXP devuelve el antilogaritmo natural de un número.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

EXP(x)

Argumento Descripción

x Un número cuyo antilogaritmo natural deseaaveriguar.

Ejemplo

EXP(1) devuelve 2.71828.

INTINT devuelve el mayor entero que es menor o igual que un valor especificado.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

INT(x)

Argumento Descripción

x Un valor numérico.

Ejemplo

INT(5.6) devuelve 5.

INT(-5.6) devuelve -6.

152 IBM Planning Analytics: Referencia de TM1

ISUNDISUND devuelve 1 si un valor especificado no se ha definido; de lo contrario, devuelve 0.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ISUND(x)

Argumento Descripción

x Un número o expresión.

Ejemplo

ISUND(5.2) devuelve 0.

ISUND(1/0) devuelve 1.

LNLN devuelve el logaritmo natural (base e) de un número.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

LN(x)

Argumento Descripción

x Un número positivo. La función devuelve un error six es negativo o cero.

Ejemplo

LN(10) devuelve 2.302585093.

LOGLOG devuelve el logaritmo en base 10 de un número positivo.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

LOG(x)

Argumento Descripción

x Un número positivo. La función devuelve un error six es negativo o cero.

Ejemplo

LOG(10) devuelve 1.

Capítulo 2. Funciones de reglas 153

MAXMAX devuelve el número mayor de un par de valores.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

MAX(num1, num2)

Argumento Descripción

num1 El primero de un par de valores.

num2 El segundo de un par de valores.

Ejemplo

MAX(10, 3) devuelve 10.

MINMIN devuelve el número menor de un par de valores.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

MIN(num1, num2)

Argumento Descripción

num1 El primero de un par de valores.

num2 El segundo de un par de valores.

Ejemplo

MIN(10, 3) devuelve 3.

MODMOD devuelve el resto de dividir un número entre un divisor.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

MOD(number, divisor)

Argumento Descripción

number El número cuyo resto desea averiguar.

divisor El valor entre el que se divide el argumentonumber.

154 IBM Planning Analytics: Referencia de TM1

Ejemplo

MOD(10, 3) devuelve 1.

RANDRAND genera un número aleatorio que se distribuye de manera uniforme entre 0 y 1. El generador denúmeros aleatorios se inicia cuando se carga TM1.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

RAND.

Argumentos

Ninguno.

Ejemplo

RAND genera un número aleatorio que se distribuye uniformemente entre 0 y 1.

ROUNDROUND redondea un determinado número hasta el entero más próximo. El redondeo se puede realizar dediversas formas, todas ellas válidas.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

La forma más básica de redondeo es sustituir un número arbitrario por un entero. Hay varias formas deredondear un número y como un entero q.

Las más habituales son:

• Redondear al número más cercano

q es el entero más cercano a y (consulte "Redondear en dirección contraria a" para ver las reglas quese aplican en caso de que sea igual).

• Redondear hacia cero (o truncar)

q es la parte entera de y, sin los dígitos de fracción.• Redondear hacia abajo (suelo; "floor" en inglés)

q es el entero más alto que no es mayor que y.• Redondear hacia arriba (techo; "ceiling" en inglés)

q es el entero más bajo que no es menor que y.• Redondear en dirección contraria a cero

Si y es un entero, q es y; en caso contrario, q es el entero más cercano a 0 y tiene un valor tal que y estáentre 0 y q.

TurboIntegrator básicamente utiliza el método de redondeo hacia abajo de floor(x + 0,5). Microsoft Excelutiliza el método de redondeo al número más cercano. Esto puede dar como resultado enterosdiferentes en función de si utiliza un proceso TurboIntegrator o de si trabaja con Excel.

Sintaxis

ROUND(number)

Capítulo 2. Funciones de reglas 155

Argumento Descripción

number El número que desea redondear.

Ejemplo

ROUND(1.46) devuelve 1.

ROUNDPROUNDP redondea un determinado número con una precisión decimal especificada.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

ROUNDP(number, decimal)

Argumento Descripción

number El número que desea redondear.

decimal La precisión decimal con la que desea aplicar elredondeo. Si este argumento es positivo, la funciónredondea el número especificado de dígitos a laderecha del punto decimal. Si este argumento esnegativo, la función redondea el númeroespecificado de dígitos a la izquierda del puntodecimal.

El argumento decimal debe encontrarse entre -15y 15, ambos inclusive.

Ejemplo

ROUNDP(1.46, 1) devuelve 1.5.

ROUNDP(1.466, 2) devuelve 1.47.

ROUNDP(234.56, -1) devuelve 230.00.

ROUNDP(234.56, 0) devuelve 235.00.

SIGNSIGN determina si un número es positivo, negativo o cero. La función devuelve 1 si el número es positivo,-1 si el número es negativo y 0 si el número es cero.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

SIGN(number)

Argumento Descripción

number Un número.

156 IBM Planning Analytics: Referencia de TM1

Ejemplo

SIGN(-2.5) devuelve -1.

SINSIN devuelve el seno de un ángulo determinado.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

SIN(x)

Argumento Descripción

x Un valor, expresado en radianes, cuyo seno deseaconocer.

Ejemplo

SIN(1.5708) devuelve 1.

SQRTSQRT devuelve la raíz cuadrada de un determinado valor.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

SQRT(x)

Argumento Descripción

x Cualquier valor positivo. SQRT devuelve un error six es negativo.

Ejemplo

SQRT(16) devuelve 4.

TANTAN devuelve la tangente de un ángulo determinado.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

TAN(x)

Argumento Descripción

x Un valor, expresado en radianes, cuya tangentedesea conocer.

Capítulo 2. Funciones de reglas 157

Ejemplo

TAN(0) devuelve 0.

TAN(.7854) devuelve 1.

Funciones de reglas de textoReglas para gestionar el texto en las reglas.

CAPITCAPIT aplica mayúsculas iniciales a todas las palabras de una cadena.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

CAPIT(string)

Argumento Descripción

string Una cadena de texto.

Ejemplo

CAPIT('first quarter sales') devuelve "First Quarter Sales".

CHARCHAR devuelve el carácter identificado por un determinado código numérico ASCII.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

CHAR(number)

Argumento Descripción

number Un número de código ASCII. Este número debeencontrarse entre 1 y 255, ambos inclusive.

Ejemplo

CHAR(100) devuelve "d".

CODECODE devuelve el código numérico ASCII para un carácter especificado de una cadena.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

CODE(string, location)

158 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

string Una cadena de texto.

location Un número que especifica el carácter de la cadenacuyo valor de código ASCII desea averiguar.

Ejemplo

CODE('321', 2) devuelve 50.

CODE('End', 3) devuelve 100.

DELETDELET devuelve el resultado de eliminar un número especificado de caracteres desde un punto de inicioespecificado en una cadena.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

DELET(string, start, number)

Argumento Descripción

string Una cadena de texto.

start El carácter en el que comienza la eliminación.

number El número de caracteres que se eliminarán.

Ejemplo

DELET('payment', 3, 3) devuelve "pant".

FILLFILL repite una determinada cadena según sea necesario para devolver una cadena de una determinadalongitud.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

FILL(string, length)

Argumento Descripción

string Una cadena de texto. Esta cadena se repite segúnsea necesario para alcanzar la longitudespecificada.

length La longitud de la cadena que desea que devuelva lafunción.

Capítulo 2. Funciones de reglas 159

Ejemplo

FILL('-', 5) devuelve '-----'.

FILL('ab', 5) devuelve 'ababa'.

INSRTINSRT inserta una cadena en otra cadena en un punto de inserción especificado.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

INSRT(string1, string2, location)

Argumento Descripción

string1 Una cadena de texto.

string2 Una cadena de texto.

location El carácter de string2 en el que desea insertarstring1. La función inserta string1 en string2inmediatamente antes del carácter queespecifique.

Ejemplo

INSRT('ABC', 'DEF', 2) devuelve "DABCEF".

LONGLONG devuelve la longitud de una cadena.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

LONG(string)

Argumento Descripción

string Una cadena de texto.

Ejemplo

LONG('Sales') devuelve 5.

LOWERLOWER convierte todos los caracteres en mayúsculas en una cadena en minúsculas.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

LOWER(string)

160 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

string Una cadena de texto.

Ejemplo

LOWER('First Quarter Sales') devuelve "first quarter sales".

NUMBRNUMBR convierte una cadena en un número. La cadena pasada a la función NUMBR debe utilizar. (punto)como separador decimal y , (coma) como separador de millares. Cualquier otro separador decimal/demillares provocará resultados incorrectos.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

NUMBR(string)

Argumento Descripción

string La cadena que desea convertir en un número.Todos los caracteres distintos de '0' a '9', '+', '-', '.'y'E' se ignoran.

Ejemplo

NUMBR('-5.6') devuelve -5.6.

NUMBR('-5A. B6C') devuelve -5.6.

SCANSCAN devuelve un número que indica la ubicación del inicio de la primera aparición de una subcadenaespecificada en una cadena. Si la subcadena no aparece en la cadena indicada, la función devuelve 0.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

SCAN(substring, string)

Argumento Descripción

substring La subcadena que está tratando de localizar.

string La cadena en la que está buscando la subcadena.

Los argumentos para esta función distinguen entre mayúsculas y minúsculas. Las mayúsculas yminúsculas utilizadas en el argumento substring deben coincidir exactamente con las mayúsculas yminúsculas del argumento string para que la función devuelva un valor distinto a cero.

Ejemplo

SCAN('scribe', 'described') returns 3.

Capítulo 2. Funciones de reglas 161

No obstante, SCAN('Scribe', 'described') devuelve 0, debido a que las mayúsculas y minúsculasdel argumento substring (Scribe) no coinciden con las mayúsculas y minúsculas del argumentostring (described).

STRSTR convierte un número en una cadena.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

STR(number, length, decimal)

Argumento Descripción

number El número que se convierte en una cadena.

Este número puede contener un signo positivo onegativo.

Este número puede contener posicionesdecimales.

length Longitud de la cadena en el resultado de la función,incluidos signos, separadores, decimales oposiciones decimales.

Si el número de dígitos en el número es inferior alparámetro length, la función podría insertarespacios en blanco iniciales hasta alcanzar estalongitud tras insertar signo, separadores,decimales o posiciones decimales.

Si el número de dígitos en el número sobrepasa elparámetro length, la función trunca el númerohasta alcanzar esta longitud.

Si se especifica el parámetro length, debe ser unnúmero positivo mayor que "0".

Si no se especifica el parámetro length, elparámetro number se mantiene y la longitud delresultado de la función incluye signo, separadores,decimales y posiciones decimales.

decimal El número de posiciones decimales que seincluirán en el resultado de la función.

Si este parámetro es "0" o no se especifica, no seincluye ningún punto decimal.

Si el número especificado tienen más posicionesdecimales que el número de posiciones decimalessolicitado, el resultado de la función se redondea.

Ejemplos

Llamada defunción

Número Longitud Decimal Resultado

STR(3.14159, 6, 2) 3.14159 6 2 " 3.14"

162 IBM Planning Analytics: Referencia de TM1

Llamada defunción

Número Longitud Decimal Resultado

STR(-3.14, 6, 0) -3.14159 6 0 " -3"

STR(3.14159,5,3) 3.14159 5 3 "3.142"

STR(1000000,4,0) 1000000 4 0 "1000"

Tenga en cuentaque el número setrunca.

STR(1000000,4,2) 1000000 4 2 "1000000.00"

Tenga en cuentaque el número nose trunca porque seespecifica eldecimal.

STR(10,2,4) 10 2 4 "10.0000"

STR(1000000,5,0) 1000000 5 0 "1,000"

Tenga en cuentaque el número setrunca. Esto es loque se devuelve sise especificanseparadores decoma.

STR(1000000,10,5)

1000000 10 5 "1,000,000.00000"

Tenga en cuentaque esto es lo quese devuelve si seespecificanseparadores decoma.

SUBSTSUBST devuelve una subcadena de una determinada cadena.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

SUBST(string, beginning, length)

Argumento Descripción

string La cadena de la que desea extraer la subcadena.

beginning El carácter en el que comienza la subcadena.

length La longitud de la subcadena.

Capítulo 2. Funciones de reglas 163

Ejemplo

SUBST('Retirement', 3, 4) devuelve "tire".

TRIMTRIM devuelve el resultado de eliminar los espacios en blanco que están delante y detrás de una cadena.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

TRIM(string)

Argumento Descripción

string Una cadena de texto.

Ejemplo

TRIM(' First Quarter ') devuelve "First Quarter".

UPPERUPPER convierte una cadena de texto en una cadena en mayúsculas.

Esta función es válida en los procesos de reglas de TM1 y TurboIntegrator.

Sintaxis

UPPER(string)

Argumento Descripción

string Una cadena de texto.

Ejemplo

UPPER('First Quarter Results') devuelve FIRST QUARTER RESULTS.

Otras funciones de reglasFunciones de reglas no encontradas en otras categorías.

FEEDERSCuando utilice una declaración SKIPCHECK para restaurar la consolidación difusa en una regla de TM1,también debe asegurarse de que las sentencias de feeder identifiquen todas las celdas derivadas. Paraello, inserte una declaración FEEDERS inmediatamente después de todas las sentencias de reglas:

FEEDERS;

Inmediatamente después de la declaración de FEEDERS debe crear sentencias de feeder queidentifiquen las celdas derivadas de reglas del cubo.

Para obtener toda la información sobre las reglas de TM1, incluida la creación de feeders, consulte lapublicación Reglas de TM1.

164 IBM Planning Analytics: Referencia de TM1

FEEDSTRINGSLos valores de cadena generados por reglas no se muestran cuando en una vista se suprimen los ceros, ano ser que la cadena esté ubicada en una celda que se inserta. Para activar el feeding de celdas decadena, inserte la declaración FEEDSTRINGS como primera línea de su regla.

FEEDSTRINGS;

Una vez colocada esta declaración, puede configurar feeders para las celdas de cadena en una vista decubo, y confiar en que la cadena estará disponible para las demás reglas, aunque la vista tengasuprimidos los ceros. Las sentencias que definen feeders para las celdas de cadena deben crearse bajo ladeclaración FEEDERS de su regla.

Al igual que en los feeders numéricos, un feed a una celda consolidada provoca el feeding de todos loscomponentes de la consolidación. Dado que puede almacenar cadenas en celdas consolidadas, debeprestar especial atención si dichas celdas se utilizan para ser insertadas en otras celdas. El uso excesivode feeders de cadena puede provocar explosiones de cálculos y un bajo rendimiento de la aplicación.

Para obtener toda la información sobre las reglas de TM1, incluida la creación de feeders, consulte lapublicación TM1 Rules.

SKIPCHECKPuede restaurar la consolidación difusa y mejorar el rendimiento insertando una declaración SKIPCHECKal comienzo de una regla de TM1.

Durante las consolidaciones, TM1 utiliza un algoritmo de consolidación difusa para omitir celdas quecontengan ceros o estén vacías. Este algoritmo agiliza los cálculos de consolidaciones en cubos muydifusos. Un cubo difuso es un cubo en el que el número de celdas completas como porcentaje de lasceldas totales es bajo.

Cuando consolida los datos de cubos que cuentan con reglas definidas, TM1 desactiva este algoritmo deconsolidación difusa porque es posible que una o más celdas vacías se calculen con una regla. (Laomisión de celdas calculadas mediante reglas provocará que los totales consolidados sean incorrectos).Cuando se desactiva el algoritmo de consolidación difusa, se comprueba cada celda en busca de un valordurante la consolidación. Esto puede ralentizar los cálculos de los cubos muy grandes y difusos.

SKIPCHECK;

Si su regla utiliza una sentencia FEEDSTRINGS, la sentencia SKIPCHECK debe ser la segunda sentenciade su regla. Si su regla no utiliza una sentencia FEEDSTRINGS, la sentencia SKIPCHECK debe ser laprimera sentencia de su regla.

Cuando utilice SKIPCHECK para restaurar la consolidación difusa, también debe asegurarse de que suregla incluya una declaración FEEDERS y de que las sentencias de feeder identifiquen las celdasderivadas de reglas.

Para obtener toda la información sobre las reglas de TM1, incluida la creación de feeders, consulte lapublicación Reglas de TM1.

Capítulo 2. Funciones de reglas 165

166 IBM Planning Analytics: Referencia de TM1

Capítulo 3. Funciones de macroIBM Planning Analytics incluye un conjunto de funciones de macros que puede incorporar en macros deMicrosoft Excel. Puede utilizar funciones de macros en TM1 Perspectives para acceder a servidores,estructuras y datos de cubo y opciones de TM1.

Nota: Antes de ejecutar estas macros, debe cargar el complemento de TM1 (Tm1p.xla). Para obtenerinformación acerca de la carga de complementos, consulte la ayuda de Microsoft Excel.

Acceso a funciones de macros de Microsoft Excel 2010 y versionesposteriores

Procedimiento

1. Pulse con el botón derecho del ratón en la pestaña hoja de la hoja de trabajo activa.2. En el menú de atajo, pulse Insertar.3. Efectúe una doble pulsación en Macro de MS Excel 4.0.4. Pulse la celda en la que desea colocar la función de macro.5. Pulse Fórmulas y, a continuación, pulse Insertar función.6. En la lista de categorías, seleccione TM1.7. Seleccione la función que desea insertar y pulse Aceptar.8. Escriba valores para los argumentos.9. Pulse Aceptar para colocar la función en la celda actual de la hoja de macros.

Acceso a las funciones de macros desde módulos VBAPara acceder a funciones de macros desde módulos VBA, utilice el método Ejecutar.

Run ("macro_function", arg1, ...)

Ejemplo

Sub Elemlist( ) Worksheets("Sheet1").Select Cells(3,5).Select ActiveCell.Value = Run ("E_PICK", "local:Region")End Sub

Este procedimiento llama a la función de macro E_PICK, que accede a una lista de elementos de ladimensión Region. El elemento seleccionado llena una celda de la hoja de trabajo Sheet1.

D_PICKD_PICK llama a un cuadro de diálogo que muestra todas las dimensiones disponibles en el directorio dedatos local y en los servidores conectados de forma remota. La dimensión que seleccione en el cuadro dediálogo se convertirá en el valor de la función D_PICK.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

© Copyright IBM Corp. 2007, 2019 167

Sintaxis

D_PICK

Argumentos

Ninguno.

D_FSAVED_FSAVE permite crear o actualizar dimensiones muy grandes cuyas hojas de trabajo de dimensionessuperarían el límite de filas de una hoja de trabajo de Excel.

Para utilizar la función D_FSAVE, cree un archivo ASCII delimitado denominado dim.dit, donde dim es elnombre de la dimensión que desea crear o actualizar. Este archivo debe estar ubicado en su directorio dedatos del servidor local.

La estructura del archivo ASCII debe coincidir con una hoja de trabajo de dimensiones, tal y como seindica a continuación:

• Incluya tres campos por línea.• En el primer campo, especifique el tipo de elemento (C para consolidado; N para elemento numérico; S

para elemento de cadena; en blanco para el componente de consolidación).• En el segundo campo, especifique el nombre del elemento.• En el tercer campo, especifique el peso, si fuera necesario. El peso predeterminado es 1,0.

Separe los campos utilizando el delimitador definido en su sistema operativo. En Windows, estedelimitador está definido por la entrada Separador de listas del cuadro de diálogo Propiedades deconfiguración regional.

Si hay errores en la estructura del archivo ASCII, como elementos no definidos o colocadosincorrectamente, aparecerá un mensaje de error.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

D_FSAVE(file)

Argumento Descripción

file El nombre de un archivo ASCII delimitado quetiene la extensión de archivo .dit. No incluya laextensión de archivo. Este archivo debe estarubicado en su directorio de datos local de TM1.

Ejemplo

=D_FSAVE("Region")

Este ejemplo lee un archivo ASCII denominado Region.dit y crea o actualiza la dimensión Region.

Nota: D_FSAVE puede utilizarse para crear o actualizar dimensiones en servidores remotos. Sin embargo,la función siempre busca el archivo .dit en el directorio de datos local (tal y como se ha definido enTm1p.ini). Debe asegurarse de que el archivo .dit de la dimensión que desee crear o actualizar esté

168 IBM Planning Analytics: Referencia de TM1

ubicado en su directorio de datos local y, a continuación, especificar el servidor en el que desea crear oactualizar la dimensión introduciendo en el archivo .dit el nombre del servidor como prefijo.

=D_FSAVE("TM1Serv:Region")

Este ejemplo busca un archivo denominado Region.dit en el directorio de datos del servidor local, peroescribe la dimensión Region en el directorio de datos del servidor TM1Serv.

D_SAVED_SAVE guarda la hoja de trabajo activa como un archivo de hoja de trabajo de dimensiones (dim.xdi). Elnombre del libro de trabajo se utiliza como nombre de archivo. A continuación, TM1 crea o actualiza ladimensión especificada por el nombre del libro de trabajo.

Si la hoja de trabajo activa no se ajusta a un formato de hoja de trabajo de dimensiones o no cuenta contoda la información, aparecerá un mensaje de error. Por ejemplo, debe definir todos los elementosutilizados en una consolidación de nivel 1 como elementos numéricos (N).

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

D_SAVE

Argumentos

Ninguno.

DBProportionalSpreadDBProportionalSpread distribuye un valor especificado a las hojas de una consolidación que esproporcional a los valores de celda existentes.

Esta función es análoga al método de dispersión de datos Dispersión proporcional, que se describedetalladamente en la documentación de TM1 Perspectives and TM1 Architect.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

DBProportionalSpread( value, server:cube, e1, e2, e3...,e16 )

Argumento Descripción

value El valor que desea distribuir.

server:cube El nombre del cubo en el que desea distribuir elvalor, con el nombre del servidor adecuado comoprefijo.

Por ejemplo, para distribuir valores en el cuboSales en el servidor Accounting, debe especificarAccounting:Sales.

e1...e16 Los nombres de los elementos que identifican laconsolidación cuyas hojas aceptarán el valordistribuido.

Capítulo 3. Funciones de macro 169

Ejemplo

DBProportionalSpread( 2000, "Accounting:Sales", "Actual", "Argentina", "S Series 1.8L Sedan", "Sales", "1 Quarter" )

Este ejemplo distribuye el valor 2000 a los hijos de la consolidación identificados por los elementosActual, Argentina, S Series 1.8L Sedan, Sales y 1 Quarter. Distribuye valores en el cubo Sales en elservidor Accounting.

E_PICKE_PICK llama al Editor de subconjuntos, mostrando todos los elementos de la dimensión especificada. Elnombre del elemento que seleccione en el Editor de subconjuntos se convertirá en el valor que devuelvala función E_PICK.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

E_PICK(Dimension, Alias, Subset, Element)

Argumento Descripción

Dimensión Un nombre de dimensión válido. La dimensiónpuede estar ubicada en el directorio de datos localo en un servidor remoto al que esté conectado.

Utilice un prefijo de nombre de servidor paraindicar la ubicación del servidor. Para el servidorlocal, especifique local:dim. Para un servidorremoto, especifique servername:dim.

Alias El nombre de un alias que exista para elsubconjunto. Cuando este parámetro estéestablecido, se aplicará el alias al abrir elsubconjunto en el Editor de subconjuntos y lafunción devolverá el alias del elemento queseleccione.

Si decide no establecer un parámetro Alias debepasar una cadena vacía a la función.

Subconjunto El nombre del subconjunto que se abrirá en elEditor de subconjuntos al llamar a E_PICK. Debefacilitarse el parámetro Alias para utilizar esteparámetro. El parámetro Alias puede definirsecomo una cadena vacía ("").

Si decide no establecer un parámetro Subset debepasar una cadena vacía a la función.

ElementNameOrIndex El nombre o número de índice del elemento que sepreseleccionará cuando se abra el Editor desubconjuntos.

Si decide no establecer un parámetroElementNameOrIndex debe pasar una cadenavacía a la función.

170 IBM Planning Analytics: Referencia de TM1

Ejemplo 1

=E_PICK("TM1SERV:Region"," "," "," ")

Este ejemplo abre la dimensión Region en el Editor de subconjuntos.

=E_PICK ("TM1SERV:Region","Deutsch","Europe","Argentina")

Este ejemplo abre el subconjunto Europe en el Editor de subconjuntos. Se aplicará el alias Deutsche y sepreseleccionará el elemento Argentina cuando se abra el Editor de subconjuntos.

=E_PICK ("TM1SERV:Region"," "," ",14)

Este ejemplo abre la dimensión Region en el Editor de subconjuntos, con el 14.º elemento de la definiciónde la dimensión preseleccionado.

I_EXPORTI_EXPORT exporta datos del cubo especificado a un archivo ASCII delimitado, que se crea en el directorio'Mis documentos' actual del usuario. En la mayoría de los casos, el directorio 'Mis documentos' esC:\Users\<nombre_usuario>\Documents.

Nota: I_EXPORT aplica un bloqueo al servidor, lo que impide que otros usuarios accedan al servidordurante la ejecución de la función. Si utiliza esta función para exportar un cubo grande, es posible que nopueda accederse al servidor durante un tiempo considerable.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

I_EXPORT(cube, file, zero, calcs)

Argumento Descripción

cube Un nombre de cubo válido. El cubo puede estarubicado en su directorio de datos local o en unservidor remoto al que esté conectado. Utilice unprefijo de nombre de servidor para indicar laubicación del servidor. Para el servidor local,especifique local:cube. Para un servidor remoto,especifique servername:cube.

file El nombre del archivo ASCII delimitado para crear.Se utiliza la extensión de archivo .cma; no laespecifique.

zero Especifica si se incluyen los valores iguales a cero.Especifique TRUE para incluirlos, FALSE paraexcluirlos.

calcs Especifica si se incluyen los valores calculados.Especifique TRUE para incluirlos, FALSE paraexcluirlos.

Ejemplo

=I_EXPORT("local:92act4d","Download",FALSE,TRUE)

Capítulo 3. Funciones de macro 171

Este ejemplo exporta datos del cubo 92act4d al archivo Download.cma. Los valores cero se excluyen y losvalores calculados se incluyen.

I_NAMESPuede utilizar I_NAMES para crear una lista de nombres de elementos. Esta función lee un archivo ASCIIdelimitado y escribe todos los nombres exclusivos de la columna especificada en la correspondientecolumna de la hoja de trabajo activa.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

I_NAMES(file, column)

Argumento Descripción

file El nombre de un archivo ASCII delimitado, cuyaextensión de archivo es .cma. No incluya laextensión de archivo.

column Un número que especifica el campo del archivoASCII en el que se leerán los nombres y la columnade la hoja de trabajo activa en la que se escribirándichos nombres.

Ejemplo

=I_NAMES("98Sales",3)

Este ejemplo inspecciona el archivo 98sales.cma. Todos los nombres exclusivos de la tercera columna seescriben en la columna C de la hoja de trabajo activa.

I_PROCESSI_PROCESS lee en los registros de un archivo ASCII, uno por uno, para la primera fila de la hoja de trabajoactiva. Cada campo llena una celda distinta. La hoja de trabajo se recalcula tras leer cada registro.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

I_PROCESS(file)

Argumento Descripción

file El nombre de un archivo ASCII delimitado, cuyaextensión de archivo es .cma. No incluya laextensión de archivo.

Ejemplo

=I_PROCESS("98Sales ")

Este ejemplo lee cada registro del archivo 98sales.cma para la primera fila de la hoja de trabajo activa.

172 IBM Planning Analytics: Referencia de TM1

M_CLEARM_CLEAR borra y vuelve a cargar todas las dimensiones de la memoria. No borra cubos ni reinicia elservidor.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

M_CLEAR

Argumentos

Ninguno.

N_CONNECTN_CONNECT establece una conexión a un servidor remoto. Si se establece correctamente la conexión,N_CONNECT no devuelve ningún valor. Si no se puede establecer una conexión, de devuelven mensajesde error del servidor.

Nota: La función N_CONNECT no se soporta cuando un servidor está utilizando seguridad de inicio desesión integrado o de IBM Cognos 8 para la autenticación. Esta función solo se puede conectar a unservidor que se ha configurado para que utilice la autenticación estándar de TM1.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

N_CONNECT(server, client, password)

Argumento Descripción

server El nombre de un servidor remoto. Este servidordebe registrarse en el Servidor de administraciónal que hace referencia su cliente.

client El nombre de usuario que se conecta al servidorespecificado.

password La contraseña del cliente especificado.

Ejemplo

=N_CONNECT("Sales","USR2","Swordfish")

Este ejemplo establece una conexión con el servidor remoto denominado Sales, utilizando el nombre decliente USR2 y la contraseña Swordfish.

N_DISCONNECTN_DISCONNECT le desconecta de todos los servidores remotos a los que esté conectados. Esta funciónno le desconecta de su servidor local. N_DISCONNECT devuelve TRUE si se desconecta correctamente detodos los servidores a los que esté conectado. Devuelve FALSE si no puede desconectarse de losservidores remotos.

Capítulo 3. Funciones de macro 173

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

N_DISCONNECT

Argumentos

Ninguno.

OPTGETOPTGET devuelve el valor actual de una opción en el archivo Tm1p.ini.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

OPTGET(option)

Argumento Descripción

option Un nombre de opción de TM1 válido.

Valores de opciones válidos Descripción

AdminHost Devuelve el nombre o la dirección del Host deadministración al que hace referencia su cliente.

AnsiFiles Devuelve T si actualmente se utiliza el juego decaracteres ANSI para importar datos de archivosASCII delimitados. Devuelve F si actualmente seutiliza el juego de caracteres ASCII.

DataBaseDirectory Devuelve la ruta completa del directorio de datosdel servidor local.

GenDBRW Devuelve F si la hoja de trabajo de seccióncontiene fórmulas DBR. Devuelve T si la hoja detrabajo de sección contiene fórmulas DBRW.

NoChangeMessage Devuelve T si se ha configurado esta opción paraque devuelva el mensaje NO CHANGE cuando unafórmula DBSn seleccione una celda de nivel C.Devuelve F si se ha configurado esta opción comoF.

Ejemplo

=OPTGET("DataBaseDirectory")

Este ejemplo devuelve la ruta completa del directorio de datos del servidor local.

174 IBM Planning Analytics: Referencia de TM1

OPTSETOPTSET establece una valor de una opción de TM1 especificada.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

OPTSET(option, value)

Argumento Descripción

option Un nombre de opción de TM1 válido.

value Un valor válido para la opción especificada.

Valores de opciones válidos Descripción

AdminHost Especifique el nombre del Host de administraciónen el que se esté ejecutando un Servidor deadministración.

AnsiFiles Especifique un valor que establezca el juego decaracteres utilizado durante las importaciones dedatos. Especifique T para utilizar el juego decaracteres ANSI. Especifique F para utilizar eljuego de caracteres ASCII.

DataBaseDirectory Especifique un valor que establezca la rutacompleta del directorio de datos del servidor local.

GenDBRW Especifique un valor que determine la fórmula queutilizará TM1 para enlazar valores de hojas detrabajo de sección con cubos. Especifique T paragenerar fórmulas DBRW cuando se creen hojas detrabajo de sección. Especifique F para generarfórmulas DBR.

NoChangeMessage Especifique un valor que determine si TM1mostrará el mensaje NO CHANGE cuando unafórmula DBSn apunta a una celda de nivel C.Especifique T para mostrar el mensaje. EspecifiqueF para mostrar únicamente el valor.

Ejemplo

=OPSET("DataBaseDirectory","c:\Tm1data")

Este ejemplo establece el directorio de datos local en c:\Tm1data.

Capítulo 3. Funciones de macro 175

PublishSubsetPublishSubset publica un subconjunto privado con nombre en un servidor. Si trata de publicar unsubconjunto privado para el que exista un subconjunto público con el mismo nombre, se le pedirá quesobrescriba el subconjunto público existente.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

PublishSubset(dimension, subset)

Argumento Descripción

dimension El nombre con el prefijo del servidor de ladimensión que contiene el subconjunto privadoque desea publicar. Por ejemplo, para publicar unsubconjunto de la dimensión Region del servidorFinance, pasaría "Finance:Region" comoargumento de la dimensión.

subset El nombre del subconjunto privado que deseapublicar.

PublishViewPublishView publica una vista privada con nombre en un servidor. Esta función no puede publicar unavista privada que utilice subconjuntos privados.

Todos los subconjuntos privados de una vista privada deben publicarse primero con la función de macroPublishSubset. Si trata de publicar una vista privada para la que exista una vista pública con el mismonombre, se le pedirá que sobrescriba la vista pública existente.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

PublishView(cube, view)

Argumento Descripción

cube El nombre con el prefijo del servidor del cubo quecontiene la vista privada que desea publicar. Porejemplo, para publicar una vista del cuboProjections en el servidor Finance, pasaría"Finance:Projections" como argumento del cubo.

view El nombre de la vista privada que desea publicar.

QUDEFINEQUDEFINE establece y guarda parámetros para conjuntos de consultas de TM1. QUDEFINE es elequivalente de crear un conjunto de consultas utilizando el cuadro de diálogo Extracción de vistas.

Puede ejecutar consultas creadas con esta función utilizando el cuadro de diálogo Extracción de vistas.

176 IBM Planning Analytics: Referencia de TM1

También puede utilizar el conjunto de consultas como un argumento para las funciones de macroQUEXPORT, QULOOP y QUSUBSET.

Nota: QUDEFINE aplica un bloqueo al servidor, lo que impide que otros usuarios accedan al servidordurante la ejecución de la función. Si utiliza esta función para crear una consulta que englobe una gransección de un cubo, es posible que no pueda accederse al servidor durante un tiempo considerable.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

QUDEFINE(cube, query, range, LowLim, HiLim, SkpZeroes,SkpCons)

Argumento Descripción

cube El nombre del cubo al que se le realizará unaconsulta.

Utilice un prefijo de nombre de servidor paraindicar la ubicación del servidor. Para el servidorlocal, especifique local:cube. Para un servidorremoto, especifique servername:cube.

query El nombre del conjunto de consultas que seguardará para utilizarlo en el futuro.

range Un rango de celdas de la hoja de trabajo queincluye una columna para cada dimensión delcubo. Cuando ejecuta la consulta, TM1 soloexamina las celdas del cubo identificadas por loselementos que se especifican en el rango o a losque se hace referencia en el rango.

El rango debe contener una columna para cadadimensión del cubo. El orden de las columnas debeser el mismo que las dimensiones del cubo.

En cada columna, debe especificar o hacerreferencia a los elementos que se incluirán. Paraincluir un subconjunto de elementos, indique losnombres de los elementos o especifique unnombre de un subconjunto. Escriba el nombre delsubconjunto precedido por el carácter de barrainclinada invertida (\). Por ejemplo, \trimestreespecifica el subconjunto trimestre. Para incluirtodos los elementos en una dimensión (elsubconjunto ALL), deje la columna en blanco.

Puede utilizar las funciones DBR para llenar lasceldas del rango. Si las funciones devuelvenvalores en blanco para cualquier columna delrango, QUDEFINE utiliza el subconjunto ALL para ladimensión asociada a dicha columna.

LowLim El valor de celda más bajo que se tendrá en cuentapara la exportación.

HighLim El valor de celda más alto que se tendrá en cuentapara la exportación.

Capítulo 3. Funciones de macro 177

Argumento Descripción

SkpZeroes Especifica si se omiten las celdas que contenganceros. Especifique TRUE para excluirlas, FALSEpara incluirlas.

SkpCons Especifica si se omiten las celdas que contenganvalores consolidados. Especifique TRUE paraexcluirlas, FALSE para incluirlas.

Ejemplo

=QUDEFINE("local:98sales", "Topsell", Sheet1!B3:F5, 3000, 5000, TRUE, TRUE)

Este ejemplo crea un conjunto de consultas que contiene elementos mostrados en la Sheet1, en el rangode celdas B3:F5. Cuando ejecuta esta consulta, TM1 únicamente inspecciona las celdas del cuboidentificadas por estos elementos y exporta los valores no consolidados del rango 3000 a 5000.

Nota: Si lowlim o highlim es una cadena compuesta por caracteres numéricos, Excel requerirá que lacadena aparezca entre cuatro comillas dobles y signos & sencillos, tal y como se indica a continuación:

""""&"0123"&""""

QUDEFINEEXQUDEFINEEX establece y guarda parámetros para conjuntos de consultas de TM1. Es el equivalente decrear un conjunto de consultas utilizando el cuadro de diálogo Extracción de vistas. Esta función esidéntica a la macro QUDEFINE, con la excepción de que QUDEFINEEX incluye un argumento que lepermite excluir valores derivados de reglas de la consulta.

Puede ejecutar consultas creadas con esta función utilizando el cuadro de diálogo Extracción de vistas.

También puede utilizar el conjunto de consultas como un argumento para las funciones de macroQUEXPORT, QULOOP y QUSUBSET.

Nota: QUDEFINEEX aplica un bloqueo al servidor, lo que impide que otros usuarios accedan al servidordurante la ejecución de la función. Si utiliza esta función para crear una consulta que englobe una gransección de un cubo, es posible que no pueda accederse al servidor durante un tiempo considerable.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

QUDEFINEEX(cube, query, range, lowlim, hilim, skpZeroes,skpCons, skpRuleVals)

Argumento Descripción

cube El nombre del cubo al que se le realizará unaconsulta.

Utilice un prefijo de nombre de servidor paraindicar la ubicación del servidor. Para el servidorlocal, especifique local:cube. Para un servidorremoto, especifique servername:cube.

178 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

query El nombre del conjunto de consultas que seguardará para utilizarlo en el futuro.

range Un rango de celdas de la hoja de trabajo queincluye una columna para cada dimensión delcubo. Cuando ejecute la consulta, TM1 únicamenteexaminará las celdas del cubo identificadas por loselementos que se especifican en el rango o a losque se hace referencia en el rango.

El rango debe contener una columna para cadadimensión del cubo. El orden de las columnas debeser el mismo que las dimensiones del cubo.

En cada columna, debe especificar o hacerreferencia a los elementos que se incluirán. Paraincluir un subconjunto de elementos, indique losnombres de los elementos o especifique unnombre de un subconjunto. Escriba el nombre delsubconjunto precedido por el carácter de barrainclinada invertida (\). Por ejemplo, \trimestreespecifica el subconjunto trimestre. Para incluirtodos los elementos en una dimensión (elsubconjunto ALL), deje la columna en blanco.

Puede utilizar las funciones DBR para llenar lasceldas del rango. Si las funciones devuelvenvalores en blanco para cualquier columna delrango, QUDEFINEEX utilizará el subconjunto ALLpara la dimensión asociada a dicha columna.

lowlim El valor de celda más bajo que se tendrá en cuentapara la exportación.

highlim El valor de celda más alto que se tendrá en cuentapara la exportación.

skpZeroes Especifica si se omiten las celdas que contenganceros. Especifique TRUE para excluirlas, FALSEpara incluirlas.

skpCons Especifica si se omiten las celdas que contenganvalores consolidados. Especifique TRUE paraexcluirlas, FALSE para incluirlas.

skpRuleVals Especifica si se omiten las celdas que contenganvalores derivados de reglas. Especifique TRUE paraexcluirlas, FALSE para incluirlas.

Ejemplo

=QUDEFINEEX("local:SalesCube", "Topsell", Sheet1!B3:F5, 3000, 5000, TRUE, TRUE, FALSE)

Este ejemplo crea un conjunto de consultas que contiene elementos mostrados en Sheet1, en el rango deceldas B3:F5. Cuando ejecuta esta consulta, TM1 solo inspecciona las celdas del cubo identificadas por

Capítulo 3. Funciones de macro 179

estos elementos y exporta los valores no consolidados del rango 3000 a 5000, incluidos los valores queno se derivan mediante las reglas.

Nota: Si lowlim o highlim es una cadena compuesta por caracteres numéricos, Excel requerirá que lacadena aparezca entre cuatro comillas dobles y signos & sencillos, tal y como se indica a continuación:

""""&"0123"&""""

QUEXPORTQUEXPORT exporta valores de celdas del cubo especificado a un archivo ASCII delimitado.

Para crear el conjunto de consultas, utilice la función QUDEFINE.

Los registros de salida tienen el siguiente formato:

• El nombre del cubo que contiene los valores exportados• Nombres de elementos que identifican la ubicación de celda de un único valor exportado• El valor exportado

Para un cubo de cinco dimensiones, TM1 crea registros que contienen siete campos:

"cube name", "elem1", "elem2", "elem3", "elem4", "elem5", valor

Nota: QUEXPORT aplica un bloqueo al servidor, lo que impide que otros usuarios accedan al servidordurante la ejecución de la función. Si utiliza esta función para exportar valores de un conjunto grande deconsultas, es posible que no pueda accederse al servidor durante un tiempo considerable.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

QUEXPORT(cube, query, file)

Argumento Descripción

cube El nombre del cubo al que se le realizará unaconsulta.

Utilice un prefijo de nombre de servidor paraindicar la ubicación del servidor. Para el servidorlocal, especifique local:cube. Para un servidorremoto, especifique servername:cube.

query El nombre de un conjunto de consultas existente.

file El nombre del archivo ASCII delimitado (.cma) quecontendrá los datos del cubo exportado. No incluyala extensión de archivo. El archivo se crea en eldirectorio de datos local.

Ejemplo

=QUEXPORT("sales:98sales", "Sedans", "Sedans")

Este ejemplo exporta datos del cubo 98sales utilizando el conjunto de consultas Sedans. Los registros seescriben en el archivo Sedans.cma.

180 IBM Planning Analytics: Referencia de TM1

QULOOPQULOOP exporta datos del cubo especificado que cumplen con los criterios del conjunto de consultas.TM1 lee cada registro de salida, uno por uno, en la primera fila de la hoja de trabajo activa. Cada campollena una celda distinta. La hoja de trabajo se recalcula tras leer cada registro.

Los registros de salida tienen el siguiente formato:

• El nombre del cubo que contiene los valores exportados• Los nombres de elementos que identifican la ubicación de celda de un único valor exportado• El valor exportado

Para un cubo de cinco dimensiones, TM1 crea registros que contienen siete campos:

"cube name", "elem1", "elem2", "elem3", "elem4", "elem5", valor

Utilice QULOOP conjuntamente con una fórmula DBSn para llenar celdas de un cubo.

Nota: QULOOP aplica un bloqueo al servidor, lo que impide que otros usuarios accedan al servidordurante la ejecución de la función. Si utiliza esta función para exportar valores de un conjunto grande deconsultas, es posible que no pueda accederse al servidor durante un tiempo considerable.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

QULOOP(cube, query)

Argumento Descripción

cube El nombre del cubo al que se le realizará unaconsulta. Utilice un prefijo de nombre de servidorpara indicar la ubicación del servidor. Para elservidor local, especifique local:cube. Para unservidor remoto, especifique servername:cube.

query El nombre de un conjunto de consultas existente.

Ejemplo

=QULOOP("sales:98sales", "Sedans")

Este ejemplo exporta datos del cubo 98sales utilizando el conjunto de consultas Sedans.

QUSUBSETQUSUBSET es el equivalente de ejecutar una consulta desde el cuadro de diálogo Extracción de vistascuando se le llama desde el Editor de subconjuntos.

Nota: QUSUBSET aplica un bloqueo al servidor, lo que impide que otros usuarios accedan al servidordurante la ejecución de la función. Si utiliza esta función para ejecutar una consulta que devuelva un grannúmero de elementos, es posible que no pueda accederse al servidor durante un tiempo considerable.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

QUSUBSET(cube, query, dimension, subset)

Capítulo 3. Funciones de macro 181

Argumento Descripción

cube El nombre del cubo al que se le realizará unaconsulta. Utilice un prefijo de nombre de servidorpara indicar la ubicación del servidor. Para elservidor local, especifique local:cube. Para unservidor remoto, especifique servername:cube.

query El nombre de una consulta existente.

dimension El nombre de una dimensión para la que existe laconsulta.

subset El nombre del subconjunto de dimensiones que secreará, que incluirá la lista de elementos quecumplen con los criterios del subconjunto. Porejemplo, un subconjunto puede devolver la lista deregiones en las que las ventas de coches superanuna determinada cantidad.

Ejemplo

=QUSUBSET("sales:98sales", "Top", "Region", "Topsales")

Este ejemplo crea el subconjunto Topsales de la dimensión Region según los criterios de la consulta Top.

R_SAVER_SAVE guarda la hoja de trabajo activa como una hoja de trabajo de reglas y la compila en unarchivo .rux. El libro de trabajo debe tener el mismo nombre que el cubo para el que se están compilandolas reglas.

Las sentencias de reglas que evitan que se compilen las reglas se escriben en el archivo tm1erlog.cma,del directorio de datos local.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

RSAVE

Argumentos

Ninguno.

SUBDEFINESUBDEFINE crea un subconjunto de dimensiones formado por nombres de elementos encontrados en lahoja de trabajo activa.

Cuando SUBDEFINE crea el subconjunto, éste se creará como subconjunto privado.

Si el subconjunto con nombre ya existe como subconjunto privado cuando se ejecuta la función,sobrescribirá el subconjunto privado con ese nombre.

Si el subconjunto con nombre ya existe como subconjunto público, SUBDEFINE creará el subconjuntocomo privado. Si desea sobrescribir el subconjunto público con nombre existente, deberá publicar el

182 IBM Planning Analytics: Referencia de TM1

subconjunto privado creado por la función SUBDEFINE para sobrescribir el subconjunto públicoexistente.

Nota: SUBDEFINE aplica un bloqueo al servidor, lo que impide que otros usuarios accedan al servidordurante la ejecución de la función. Si utiliza esta función para crear un subconjunto con un gran númerode elementos, es posible que no pueda accederse al servidor durante un tiempo considerable.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

SUBDEFINE(dimension, subset, range)

Argumento Descripción

dimension El nombre de la dimensión para la que desea crearun subconjunto. Utilice un prefijo de nombre deservidor para indicar la ubicación del servidor. Parael servidor local, especifique local:dim. Para unservidor remoto, especifique servername:dim.

subset El nombre del subconjunto de dimensiones.

range El rango de las celdas de la hoja de trabajo quecontienen los nombres de los elementos de ladimensión. Se ignorarán los valores de celda delrango que no sean elementos válidos.

Ejemplo

=SUBDEFINE("local:Model", "Smith", B7:M7)

Este ejemplo crea un subconjunto denominado Smith para la dimensión Model. El subconjunto contieneelementos encontrados en el rango de celdas B7:M7.

SUBPICKSUBPICK llama a un cuadro de diálogo que muestra todos los elementos del subconjunto especificado.Los elementos que seleccione se insertarán en la hoja de trabajo activa, comenzando en la posición decelda actual.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

SUBPICK(dimension, subset, vertical)

Argumento Descripción

dimension El nombre de la dimensión que contienesubconjuntos. Utilice un prefijo de nombre deservidor para indicar la ubicación del servidor. Parael servidor local, especifique local:dim. Para unservidor remoto, especifique servername:dim.

Capítulo 3. Funciones de macro 183

Argumento Descripción

subset El nombre del subconjunto cuyos elementos deseaseleccionar.

vertical Especifique TRUE para insertar los nombres de loselementos de forma vertical, desde la celda actualhacia abajo. Especifique FALSE para insertar losnombres de los elementos de forma horizontal,desde la celda actual hacia la derecha.

Ejemplo

=SUBPICK("local:Model", "Smith", TRUE, )

Este ejemplo inserta elementos seleccionados del subconjunto Smith en la hoja de trabajo activa. Loselementos se organizan de forma vertical, comenzando desde la celda actual hacia abajo.

T_CLEART_CLEAR borra todos los cambios o adiciones realizados en los datos del cubo desde la memoria.

Nota: T_CLEAR no le pregunta si desea guardar en disco algún dato del cubo de la RAM. Los datos que nose hayan guardado se eliminarán sin guardarse en el disco. Por lo tanto, si desea guardar los datos delcubo que estén actualmente en la RAM, llame en primer lugar a la función T_SAVE.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

T_CLEAR

Argumentos

Ninguno.

T_CREATET_CREATE crea un cubo que cuenta con un máximo de ocho dimensiones, el cual es el límite en lasversiones anteriores de TM1.

Nota: Si utiliza T_CREATE para crear un cubo con un nombre de un cubo ya existente, TM1 sustituye elcubo existente y elimina todos sus datos.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

T_CREATE(cube,d1,d2[,d3,d4,d5,d6,d7,d8])

184 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

cube El nombre del cubo que se creará.

Utilice un prefijo de nombre de servidor paraindicar la ubicación del servidor. Para el servidorlocal, especifique local:cube. Para un servidorremoto, especifique servername:cube.

d1...d8 Nombres de ocho dimensiones existentes comomáximo, en el orden en el que desee almacenarlasen el cubo. Debe especificar al menos dosdimensiones.

Ejemplo

=T_CREATE("local:Sales","Region","Products","Month")

Este ejemplo crea un cubo denominado Sales. Este nuevo cubo tiene tres dimensiones, que aparecen enel siguiente orden: Region, Products y Month.

T_CREATE16T_CREATE16 crea un cubo que cuenta con un máximo de dieciséis dimensiones.

Nota: Si el primer argumento de esta función es un nombre de cubo existente, TM1 sustituye el cuboexistente y elimina todos sus datos.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

T_CREATE16(cube,d1,d2[,d3,...,d16])

Argumento Descripción

cube El nombre del cubo que se creará.

Utilice un prefijo de nombre de servidor paraindicar la ubicación del servidor. Para el servidorlocal, especifique local:cube. Para un servidorremoto, especifique servername:cube.

d1...d16 Nombres de dieciséis dimensiones existentescomo máximo, en el orden en el que deseealmacenarlas en el cubo. Debe especificar almenos dos dimensiones.

Ejemplo

=T_CREATE("Sales","Region","Products","Month")

Este ejemplo crea un cubo denominado Sales. Este nuevo cubo tiene tres dimensiones, que aparecen enel siguiente orden: Region, Products y Month.

Capítulo 3. Funciones de macro 185

T_PICKT_PICK invoca un cuadro de diálogo que muestra todos los cubos disponibles en los servidores locales yremotos de TM1. El nombre del cubo que selecciona en el cuadro de diálogo se convierte en el valor de lafunción T_PICK. Su macro inserta el nombre del cubo en la primera celda de la hoja de trabajo activa.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

T_PICK

Argumentos

Ninguno.

T_SAVET_SAVE guarda en disco todos los datos del cubo que están actualmente en la RAM. T_SAVE solamentepuede utilizarse para guardar datos en un servidor local; la función no puede utilizarse con servidoresremotos. T_SAVE no le pregunta si desea guardar datos de cubos individuales.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

T_SAVE

Argumentos

Ninguno.

TM1RECALCTM1RECALC obliga a volver a calcular todas las hojas de trabajo abiertas. Es el equivalente de pulsar F9en Excel. Una función de macro similar, TM1RECALC1, obliga a volver a calcular únicamente la hoja detrabajo activa.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

TM1RECALC

Argumentos

Ninguno.

TM1RECALC1TM1RECALC1 fuerza un recálculo de la hoja de trabajo activa. Es el equivalente de pulsar MAYÚSCULAS-F9 en Excel. Una función de macro similar, TM1RECALC, obliga a volver a calcular todas las hojas detrabajo abiertas.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

186 IBM Planning Analytics: Referencia de TM1

Sintaxis

TM1RECALC1

Argumentos

Ninguno.

VUSLICEVUSLICE crea una hoja de trabajo de sección desde la vista de cubos especificada. La sección se insertacomenzando en la celda superior izquierda (A1 o R1C1) de la hoja de trabajo activa.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

VUSLICE(cube, view)

Argumento Descripción

cube El nombre de un cubo existente.

Utilice un prefijo de nombre de servidor paraindicar la ubicación del servidor. Para el servidorlocal, especifique local:cube. Para un servidorremoto, especifique servername:cube.

view El nombre de una vista asociada al cubo.

Ejemplo

=VUSLICE("local:98sales","Quarterly")

Este ejemplo copia datos de la vista Quarterly del cubo 98sales en la hoja de trabajo activa.

W_DBSENABLEW_DBSENABLE activa (o desactiva) la acción de volver a calcular automáticamente las funciones DBS enuna hoja de trabajo.

Por lo general, si se inserta una función DBS en una hoja de trabajo, la función no se ejecutará hasta quela hoja vuelva a calcularse con las teclas F9 o MAYÚSCULAS+F9. Puede utilizar la función W_DBSENABLEpara ejecutar inmediatamente funciones DBS a medida que se crean en una hoja de trabajo.

Nota: Las funciones DBS no se ejecutarán en los módulos VBA a no ser que W_DBSENABLE se configurecomo TRUE.

Esta función de macro de TM1 solo es válida en las macros de Excel y en los módulos VBA.

Sintaxis

=W_DBSENABLE(LogicalFlag)

Capítulo 3. Funciones de macro 187

Argumento Descripción

LogicalFlag Si es TRUE, las funciones DBS se ejecutaráninmediatamente cuando se inserten en una hoja detrabajo o se llamen desde ella.

Si es FALSE, las funciones DBS únicamente seejecutarán cuando la hoja de trabajo vuelva acalcularse de forma explícita.

188 IBM Planning Analytics: Referencia de TM1

Capítulo 4. Funciones de hoja de trabajoLas funciones de hoja de trabajo de IBM Planning Analytics devuelven un valor numérico o un valor decadena. Puede utilizar las funciones de hoja de trabajo de TM1 en cualquier lugar de una hoja de trabajode IBM Planning Analytics for Microsoft Excel o de TM1.

Para acceder a estas funciones en Microsoft Excel, seleccione Fórmulas > Insertar función.

Nota: Si utiliza Planning Analytics for Microsoft Excel, en primer lugar debe habilitar el complemento IBMCognos Office Reporting TM1.

Si una función de hoja de trabajo hace referencia a un objeto de un servidor remoto, debe colocar unprefijo delante del objeto, que incluya el nombre del servidor y dos puntos. Por ejemplo, para hacerreferencia al cubo SalesCube en el servidor SData, utilice SData:SalesCube. Debe estar conectado alservidor al que se hace referencia a través de la función para recibir valores precisos en la hoja de trabajo.Si no está conectado al servidor, la función de hoja de trabajo de TM1 devuelve *KEY_ERR.

Las funciones de hoja de trabajo de TM1 aceptan cadenas, valores o referencias de celda comoargumentos. Las cadenas deben colocarse entre comillas. Los nombres de elemento numéricos debencolocarse entre comillas dobles. Por ejemplo ""1""14357"". Las referencias de celda deben hacerreferencia a argumentos válidos de una función determinada. Puede utilizar convenciones estándar dereferencias de celda absolutas y relativas en las funciones de hoja de trabajo.

Debido a una limitación con Microsoft Excel, las funciones de hoja de trabajo no pueden contener más de30 argumentos. Cuando construya una referencia de cubo, un argumento debe ser el nombre del cubo, loque deja 29 argumentos restantes para especificar las dimensiones del cubo.

Si registra una macro de hoja de trabajo en Microsoft Excel que incluya la función de TM1, la macro que semuestra como resultado puede incluir funciones de hoja de trabajo de TM1 no documentadas. Sinembargo, podemos modificar o suspender estas funciones no documentadas en futuras versiones sinprevio aviso.

Las funciones de hoja de trabajo no pueden utilizarse en reglas de TM1 o en procesos deTurboIntegrator.

DBRDBR recupera un valor de un cubo de TM1 especificado.

Cuando todos los argumentos de elemento (e1, e2, etc.) para la función son elementos de hoja, la funciónDBR también se puede utilizar para grabar valores en el cubo especificado, a condición de que el usuariotenga los privilegios de acceso adecuados al cubo, las dimensiones, los elementos y/o las celdaspertinentes. Al introducir un valor en una celda que contiene dicha función DBR, el valor se envía alservidor.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

DBR(cube, e1, e2,[...en])

Argumento Descripción

cube El nombre del cubo del que se va a recuperar el valor.

© Copyright IBM Corp. 2007, 2019 189

Argumento Descripción

e1,...en Los nombres de elementos de dimensiones que definen la intersección delcubo que incluye el valor que desea recuperar.

Los argumentos de e1 a en distinguen secuencias. e1 debe ser un elementode la primera dimensión del cubo, e2 debe ser un elemento de la segundadimensión, etc. Estos argumentos también pueden ser nombres de alias deelementos de dimensiones.

Los nombres de elemento numéricos deben colocarse entre comillas dobles.Por ejemplo ""14357"".

Ejemplo

DBR("92act4d", "California", "3.5 Diskettes", "Net Sales", "January")

En este ejemplo, 92act4d es el nombre del cubo y la función devuelve el valor en la intersección deCalifornia, 3.5 Diskettes, Net Sales y January.

DBRADBRA recupera el valor de un atributo de elemento especificado. El valor devuelto puede ser de cadena onumérico, en función del tipo de atributo.

La función DBRA también se puede utilizar para escribir valores de atributos de elementos en el servidor.Al introducir un valor, ya sea numérico o de cadena, en una celda que contenga una función DBRA, elatributo de elemento correspondiente se actualizará en el servidor.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

DBRA(server:dimension, element, attribute)

Argumento Descripción

server:dimension Un nombre de dimensión válido debe llevar delante el nombre del servidoradecuado y dos puntos; por ejemplo, "SData:Region" hace referencia a ladimensión Region del servidor SData.

Si la dimensión no va precedida del nombre de un servidor, la función DBRAintenta ejecutarse en el servidor local.

element Un elemento de la dimensión.

attribute El atributo para el que desea recuperar un valor. Este argumento debe serun atributo válido del elemento.

Ejemplo

DBRA("SData:Model", "L Series 1.8L Sedan", "ManufactureCode")

En este ejemplo, la función devuelve el valor del atributo Manufacture Code del elemento L Series 1.8LSedan de la dimensión Model en el servidor SData.

190 IBM Planning Analytics: Referencia de TM1

DBRWDBRW recupera un valor de un cubo de TM1 especificado.

Cuando todos los argumentos de elemento (e1, e2, etc.) para la función son elementos de hoja, la funciónDBRW también se puede utilizar para grabar valores en el cubo especificado, a condición de que elusuario tenga los privilegios de acceso adecuados al cubo, las dimensiones, los elementos y/o las celdaspertinentes.

DBRW funciona igual que la función DBR, aunque con una gran diferencia; DBRW reduce el tráfico de redy puede mejorar el rendimiento en redes de área amplia.

En las hojas de trabajo con un gran número de funciones de hoja de trabajo de TM1, DBRW fuerza a TM1 aque ejecute funciones en "paquetes", en lugar de individualmente. Las funciones DBR habituales seejecutan individualmente durante el recálculo de hojas de trabajo. Las funciones de DBRW fuerzan a TM1a que ejecute dos pases en la hoja de trabajo. En el primer pase, todos los valores modificados en lasceldas que contienen funciones DBRW se envían al cubo en un único paquete. En el segundo pase, losvalores del cubo se envían de vuelta a la hoja de trabajo en un único cubo. En consecuencia, la hoja detrabajo se recalcula dos veces cuando se ejecutan las funciones DBRW.

La creación de paquetes DBRW tiene lugar cuando la función se utiliza en una celda independiente.Cuando las funciones DBRW se utilizan en cálculos complejos, la función actúa como una función DBR,por lo que no se producen acumulaciones de rendimiento.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

DBRW(cube, e1, e2[,...en])

Argumento Descripción

cube El nombre del cubo del que se va a recuperar el valor.

e1,...en Los nombres de elementos de dimensiones que definen la intersección delcubo que incluye el valor que desea recuperar.

Los argumentos de e1 a en distinguen secuencias. e1 debe ser unelemento de la primera dimensión del cubo, e2 debe ser un elemento de lasegunda dimensión, etc. Estos argumentos también pueden ser nombresde alias de elementos de dimensiones.

Los nombres de elemento numéricos deben colocarse entre comillasdobles.

Ejemplo

DBRW("92act4d", "California", "3.5 Diskettes", "NetSales", "January")

En este ejemplo, la función devuelve el valor que se encuentra en la intersección de California, 3.5Diskettes, Net Sales y January del cubo 92act4d.

DBSDBS envía un valor numérico a un cubo de TM1. Esta función no puede enviar una cadena a un cubo. Paraenviar cadenas, utilice la función DBSS.

Cuando crea una función DBS, con la opción TM1 > Edit Formula, el cuadro de diálogo Editar fórmula leguía por una serie de pasos para crear cada argumento de función con la secuencia correcta.

Capítulo 4. Funciones de hoja de trabajo 191

Si el cubo no existe o alguno de los argumentos no es válido, la función devolverá KEY ERROR.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

DBS(value, cube, e1, e2[,...en])

Argumento Descripción

value El valor que se está enviando.

cube El cubo al que se envía el valor.

e1, ...en Los nombres de elementos que definen la intersección del cubo al que seenvía el valor.

Los argumentos de e1 a en distinguen secuencias. e1 debe ser unelemento de la primera dimensión del cubo, e2 debe ser un elemento dela segunda dimensión del cubo, etc. Estos argumentos también puedenser nombres de alias de elementos de dimensiones.

Los nombres de elemento numéricos deben colocarse entre comillas.

EjemploEn este ejemplo, la función envía el valor 5342 al cubo 92act4d en la intersección de California, 3.5Diskettes, Net Sales y January.

DBS(5342,"92act4d","California","3.5 Diskettes", "NetSales", "January")

DBSADBSA envía un valor a un atributo de elemento especificado. El valor enviado puede ser de cadena onumérico, en función del tipo de atributo.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

DBSA(att_value, dimension, element, att_name)

Argumento Descripción

att_value El valor que desea enviar.

dimension Un nombre de dimensión válido. El nombre de ladimensión debe llevar delante el nombre delservidor adecuado y dos puntos; por ejemplo,"SData:Region" hace referencia a la dimensiónRegion del servidor SData.

Si la dimensión no va precedida del nombre de unservidor, la función DBSA intentará ejecutar elservidor local.

element Un elemento de la dimensión.

192 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

att_name El atributo al que desea enviar un valor. att_namedebe ser un atributo válido del elementoespecificado por elem_name.

Ejemplo

DBSA(''LS-1.8-M7398", "SData:Model", "L Series 1.8LSedan", "Manufacture Code")

DBSSDBSS envía una cadena a un cubo de cualquier número de dimensiones. Esta función no puede enviar unvalor numérico a un cubo. Utilice la función DBS para enviar valores numéricos.

Cuando crea una función DBSS, con la opción TM1 > Edit Formula, el cuadro de diálogo Editar fórmula leguía por una serie de pasos para crear cada argumento de función con la secuencia correcta.

Si el cubo no existe o alguno de los argumentos no es válido, la función devolverá KEY ERROR.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

DBSn(string, cube, e1, e2,...en)

Argumento Descripción

string La cadena que se está enviando.

cube El cubo al que se envía la cadena.

e1, ...en Los nombres de elementos que definen laintersección del cubo al que se envía la cadena.

Los argumentos de e1 a en distinguen secuencias.e1 debe ser un elemento de la primera dimensióndel cubo, e2 debe ser un elemento de la segundadimensión del cubo, etc. Estos argumentostambién pueden ser nombres de alias deelementos de dimensiones.

Ejemplo

DBSS("Smith","Info","California","Last Name")

En este ejemplo, la fórmula envía la cadena Smith al cubo Info en la intersección de California y LastName.

DBSWDBSW envía un valor numérico a un cubo de TM1. Esta función no puede enviar una cadena a un cubo.Para enviar cadenas, utilice la función DBSS.

Esta función es similar a la función DBS, aunque con una gran diferencia; DBSW reduce el tráfico de red ypuede mejorar el rendimiento en redes de área amplia.

Capítulo 4. Funciones de hoja de trabajo 193

En las hojas de trabajo con un gran número de referencias de cubos, DBSW hacen que TM1 envíe valoresen paquetes, en lugar de hacerlo individualmente. Las funciones DBS habituales se actualizanindividualmente durante el recálculo. Las referencias DBSW hacen que TM1 envíe todos los valoresmodificados en una hoja de trabajo de un único paquete.

En dichas circunstancias, puede utilizar de forma segura una función DBS/DBR como argumento en unafunción DBS.

Nota: Si utiliza VBA para calcular una hoja de trabajo que contenga funciones DBSW, debe invocar lafunción de macro de TM1 para calcular la hoja de trabajo. No utilice el método Calcular VB para calcularuna hoja de trabajo que contenga funciones DBSW; si lo hace, cada función DBSW se ejecutaráindividualmente, rechazando el propósito de la función y dando como resultado un menor rendimiento.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

DBSW(value, cube, e1, e2[,...en])

Argumento Descripción

value El valor que se está enviando.

cube El cubo al que se envía el valor.

e1, ...en Los nombres de elementos que definen laintersección del cubo al que se envía el valor.

Los argumentos de e1 a en distinguen secuencias.e1 debe ser un elemento de la primera dimensióndel cubo, e2 debe ser un elemento de la segundadimensión del cubo, etc. Estos argumentostambién pueden ser nombres de alias deelementos de dimensiones.

Los nombres de elemento numéricos debencolocarse entre comillas.

Ejemplo

DBSW(5342,"92act4d","California","3.5 Diskettes", "NetSales", "January")

DFRSTDFRST devuelve el primer elemento de una dimensión especificada.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

DFRST(server_name:dimension)

Argumento Descripción

dimension Un nombre de dimensión válido.

194 IBM Planning Analytics: Referencia de TM1

Ejemplo

DFRST("planning_sample:Location")

Si la dimensión Location incluye los elementos ordenados California, Oregon y Washington, el ejemplodevuelve California.

DIMIXDIMIX devuelve el número de índice de un elemento de una dimensión.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

DIMIX(server_name:dimension, element)

Argumento Descripción

dimension Un nombre de dimensión válido.

element El nombre de un elemento de la dimensión.

Si el elemento no es un elemento de la dimensiónespecificada, la función devuelve 0. Esteargumento puede ser también el nombre de unalias de un elemento de la dimensión.

Ejemplo

DIMIX("planning_sample: Location","Washington")

Si la dimensión Location contiene los elementos ordenados California, Oregon y Washington, el ejemplodevolverá el valor 3, ya que Washington es el tercer elemento de la dimensión.

DIMNMDIMNM devuelve el elemento de una dimensión que corresponde al argumento de índice. Si incluye elparámetro Alias opcional en esta función, la función devolverá el alias del elemento seleccionado.

Al efectuar una doble pulsación en una celda que contiene una función DIMNM, se abrirá el cuadro dediálogo Dimensión. A continuación, puede seleccionar un nuevo elemento para colocarlo en la hoja detrabajo. La función DIMNM actualiza automáticamente el argumento de índice para reflejar el nuevoelemento.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

DIMNM(server_name:Dimension, Index, [Alias])

Argumento Descripción

Dimensión Un nombre de dimensión válido.

Capítulo 4. Funciones de hoja de trabajo 195

Argumento Descripción

Index Un valor menor o igual que el número deelementos de la dimensión.

Alias El nombre de un alias que existe en la dimensión.Éste es un argumento opcional. SI lo utiliza, lafunción devolverá el alias del elementoespecificado.

DIMSIZDIMSIZ devuelve el número de elementos de una dimensión especificada.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

DIMSIZ(dimension)

Argumento Descripción

dimension Un nombre de dimensión válido.

Ejemplo

DIMSIZ("Accounts")

Si la dimensión Accounts incluye 19 elementos, el ejemplo devuelve el valor 19.

DNEXTDNEXT devuelve el nombre de elemento que sigue al elemento especificado como argumento de lafunción.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

DNEXT(server:dimension, element)

Argumento Descripción

server:dimension Un nombre de dimensión válido debe llevardelante el nombre del servidor adecuado y dospuntos; por ejemplo, "SData:Region" hacereferencia a la dimensión Region del servidorSData.

Si la dimensión no lleva delante un nombre deservidor, la función DNEXT intentará ejecutarsefrente al servidor local.

196 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

element El nombre de un elemento de la dimensión. Esteargumento puede ser también el nombre de unalias de un elemento de la dimensión.

Ejemplo

DNEXT("Production:Location","Oregon")

Si la dimensión Location del servidor Production contiene los elementos ordenados California, Oregon yWashington, el ejemplo devuelve Washington.

DNLEVDNLEV devuelve el número de niveles jerárquicos de una dimensión.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

DNLEV(dimension)

Argumento Descripción

dimension Un nombre de dimensión válido.

Ejemplo

DNLEV("Region")

En la dimensión Region, las diversas naciones (nivel 0) se agregan formando regiones (nivel 1). Lasregiones se agregan formando superregiones (nivel 2), que a su vez se agregan formando el mundo (nivel3).

En la dimensión Region existen cuatro niveles jerárquicos (0, 1, 2 y 3). Por lo tanto, el ejemplo devolveráel valor 4.

DTYPEDTYPE devuelve información sobre el tipo de elemento del elemento especificado. Devuelve "N" si elelemento es un elemento numérico, "S" si el elemento es un elemento de cadena.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Capítulo 4. Funciones de hoja de trabajo 197

Sintaxis

DTYPE(dimension, element)

Argumento Descripción

dimension Un nombre de dimensión válido.

element El nombre de un elemento de la dimensión. Esteargumento puede ser también el nombre de unalias de un elemento de la dimensión.

Ejemplo

DTYPE("Region","Europe")

El elemento Europe de la dimensión Region es un elemento consolidado, de modo que el ejemplodevuelve "C".

ELCOMPELCOMP devuelve el nombre de un hijo de un elemento consolidado de una dimensión especificada. Si elargumento element no es un elemento consolidado, la función devuelve 0.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

ELCOMP(dimension, element, index)

Argumento Descripción

dimension Un nombre de dimensión válido.

element El nombre de un elemento consolidado de ladimensión. Este argumento puede ser también elnombre de un alias de un elemento de ladimensión.

index Un valor positivo menor o igual que el número totalde hijos del elemento especificado.

Ejemplo

ELCOMP("Region","Central Europe",2)

En la dimensión Region, el elemento consolidado Central Europe es una consolidación de los hijosGermany y France. De esta manera, el ejemplo devuelve France.

ELCOMPNELCOMPN devuelve el número de componentes de un elemento especificado. Si el argumento element noes un elemento consolidado, la función devuelve 0.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

198 IBM Planning Analytics: Referencia de TM1

Sintaxis

ELCOMPN(dimension, element)

Argumento Descripción

dimension Un nombre de dimensión válido.

element El nombre de un elemento consolidado de ladimensión. Este argumento puede ser también elnombre de un alias de un elemento de ladimensión.

Ejemplo

En la dimensión Region, el elemento Scandanavia es una consolidación de tres elementos. El ejemplodevuelve 3.

ELISCOMPELISCOMP determina si element1 es un hijo de element2 en la dimensión especificada. La funcióndevuelve TRUE si element1 es un hijo de element2, de lo contrario la función devuelve FALSE.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

ELISCOMP(dimension, element1, element2)

Argumento Descripción

dimension Un nombre de dimensión válido.

element1 El nombre de un elemento de la dimensión. Esteargumento puede ser también el nombre de unalias de un elemento de la dimensión.

element2 El nombre de un elemento de la dimensión. Esteargumento puede ser también el nombre de unalias de un elemento de la dimensión.

Ejemplo

ELISCOMP("Region","Germany","Central Europe")

En la dimensión Region, el elemento Central Europe es una consolidación de dos elementos, Germany yFrance. El ejemplo devuelve TRUE.

Tenga en cuenta que esta función devuelve TRUE únicamente en los hijos inmediatos. En el ejemploanterior, Germany es un hijo de Central Europe. Además, Central Europe es un hijo de Europe. Sinembargo, dado que la función devuelve TRUE únicamente en hijos inmediatos, el siguiente ejemplodevuelve False:

ELISCOMP("Region","Germany","Europe")

Capítulo 4. Funciones de hoja de trabajo 199

ELISPARELISPAR determina si element1 es un padre de element2 en la dimensión especificada. La funcióndevuelve TRUE si element1 es un padre de element2, de lo contrario la función devuelve FALSE.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

ELISPAR(dimension, element1, element2)

Argumento Descripción

dimension Un nombre de dimensión válido.

element1 El nombre de un elemento de la dimensión. Esteargumento puede ser también el nombre de unalias de un elemento de la dimensión.

element2 El nombre de un elemento de la dimensión. Esteargumento puede ser también el nombre de unalias de un elemento de la dimensión.

Ejemplo

ELISPAR("Region","Central Europe","Germany")

En la dimensión Region, el elemento consolidado Central Europe es el padre tanto de Germany como deFrance. De esta manera, el ejemplo devuelve TRUE

Tenga en cuenta que esta función devuelve TRUE únicamente en los padres inmediatos. En el ejemploanterior, Europe es un padre de Central Europe. Además, Central Europe es un padre de Germany. Sinembargo, dado que Europe no es un padre inmediato de Germany, el siguiente ejemplo devuelve FALSE:

ELISPAR("Region","Europe","Germany")

ELLEVELLEV devuelve el nivel de un elemento de una dimensión.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

ELLEV(dimension, element)

Argumento Descripción

dimension Un nombre de dimensión válido.

element El nombre de un elemento de la dimensión. Este argumento puede sertambién el nombre de un alias de un elemento de la dimensión.

200 IBM Planning Analytics: Referencia de TM1

Ejemplo

ELLEV("Region","Europe")

En la dimensión Region, las naciones individuales (nivel 0) se agregan formando regiones (nivel 1). Lasregiones se agregan formando superregiones (nivel 2), que a su vez se agregan formando el mundo (nivel3).

El ejemplo devuelve 2, dado que Europe es un elemento de nivel 2.

ELPARELPAR devuelve el padre de un elemento en una dimensión especificada

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

ELPAR(dimension, element, index)

Argumento Descripción

dimension Un nombre de dimensión válido.

element El nombre de un elemento de la dimensión. Esteargumento puede ser también el nombre de unalias de un elemento de la dimensión.

index Un valor positivo menor o igual que el número totalde elementos consolidados (padres) que utilizan elargumento element como hijo.

Ejemplo

ELPAR("Model","Wagon 4WD",2)

En la dimensión Model, el elemento Wagon 4WD es un hijo tanto de Total Wagons como de Total 4WD.Por lo tanto, tanto Total Wagons como Total 4 WD son padres de Wagon 4WD. En la estructura de ladimensión Model, Total Wagons se define en primer lugar y Total 4WD se define en segundo lugar.

El ejemplo devuelve Total 4WD, ya que es la segunda instancia de un padre de Wagon 4WD en ladimensión Model.

ELPARNELPARN devuelve el número de padres de un elemento de una dimensión especificada.

Capítulo 4. Funciones de hoja de trabajo 201

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

ELPARN(dimension, element)

Argumento Descripción

dimension Un nombre de dimensión válido.

element El nombre de un elemento de la dimensión. Esteargumento puede ser también el nombre de unalias de un elemento de la dimensión.

Ejemplo

ELPARN("Model","Wagon 4WD")

En la dimensión Model, el elemento Wagon 4WD es un hijo tanto de Total Wagons como de Total 4WD.Por lo tanto, tanto Total Wagons como Total 4 WD son padres de Wagon 4WD. La función devuelve 2.

ELSLENELSLEN devuelve la longitud de un elemento de cadena de una dimensión. Si el elemento especificado noes un elemento de la dimensión especificada, o no es un elemento de cadena, la función devuelve 0.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

ELSLEN(dimension, element)

Argumento Descripción

dimension Un nombre de dimensión válido.

element El nombre de un elemento de cadena de ladimensión. Este argumento puede ser también elnombre de un alias de un elemento de ladimensión.

Ejemplo

ELSLEN("Region","Washington")

El elemento Washington es un elemento de cadena con 10 caracteres de longitud. El ejemplo devuelve10.

ELWEIGHTELWEIGHT devuelve el peso de un hijo de un elemento consolidado.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

202 IBM Planning Analytics: Referencia de TM1

Sintaxis

ELWEIGHT(dimension, element1, element2)

Argumento Descripción

dimension Un nombre de dimensión válido.

element1 El nombre de un elemento consolidado de ladimensión. Este argumento puede ser también elnombre de un alias de un elemento de ladimensión.

element2 El nombre de un hijo del elemento consolidado.Este argumento puede ser también el nombre deun alias de un elemento de la dimensión.

Ejemplo

ELWEIGHT("Account1","Gross margin","Variable costs")

Tal y como muestra la siguiente figura, el elemento Variable costs, que es un hijo de Gross margin, tieneun peso de -1.

El ejemplo devuelve -1.

SUBNMSUBNM devuelve el elemento de un subconjunto de dimensiones correspondiente al argumentoIndexOrName. Si incluye el parámetro Alias opcional en esta función, la función devolverá el alias delelemento seleccionado.

Al efectuar una doble pulsación en una celda que contiene una función SUBNM, se abrirá el Editor desubconjuntos. A continuación, puede seleccionar un nuevo elemento para colocarlo en la hoja de trabajo.El elemento seleccionado se convertirá en el valor devuelto de la función SUBNM, y la función actualizaráde forma automática el argumento IndexOrName para reflejar el nuevo elemento.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

SUBNM(Dimension, Subset, IndexOrName, [Alias])

Argumento Descripción

Dimensión Un nombre de dimensión válido.

Subconjunto El nombre de un subconjunto de la dimensión.

Capítulo 4. Funciones de hoja de trabajo 203

Argumento Descripción

IndexOrName Índice del subconjunto o nombre de un elementodel subconjunto.

Si se trata de un índice, un entero positivo menor oigual al número total de elementos delsubconjunto especificado. Si se trata de unnombre, una cadena que representa el nombre deun elemento del subconjunto.

Alias El nombre de un alias que exista para elsubconjunto. Éste es un argumento opcional. Si seutiliza, el alias especificado se aplica cuando elEditor de subconjuntos se abre y la funcióndevuelve el alias del elemento seleccionado.

Ejemplo

SUBNM("Region","Top Producers",2)

El subconjunto Top Producers de la dimensión Region contiene los elementos ordenados United States,Germany, Great Britain y Mexico. Dado que el argumento de índice apunta al segundo elemento delsubconjunto, el ejemplo devuelve Germany.

SUBNM("Region","Top Producers","Germany","Deutsch")

Este ejemplo devuelve el alias Deutsch del elemento Germany (Deutschland) desde el subconjunto TopProducers de la dimensión Region.

SUBSIZSUBSIZ devuelve el número de elementos de un subconjunto de dimensiones.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

SUBSIZ(dimension, subset)

Argumento Descripción

dimension Un nombre de dimensión válido.

subset El nombre de un subconjunto de la dimensión.

Ejemplo

SUBSIZ("Region","Top Producers")

El subconjunto Top Producers de la dimensión Region contiene cuatro elementos: United States,Germany, Great Britain y Mexico.

El ejemplo devuelve 4.

204 IBM Planning Analytics: Referencia de TM1

TABDIMTABDIM devuelve el nombre de dimensión que corresponde a un argumento de índice determinado.

La función siempre devuelve una dimensión en función del orden de dimensiones original del cuboespecificado, incluso si el orden de las dimensiones del cubo ha cambiado a través del Optimizador delcubo de TM1.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

TABDIM(cube, index)

Argumento Descripción

cube Un nombre de cubo válido.

index Un valor positivo menor o igual que el número totalde dimensiones del cubo.

Ejemplo

TABDIM("98sales",3)

El cubo 98sales contiene cinco dimensiones: account1, actvsbud, model, month y region. El ejemplodevuelve model, la tercera dimensión de 98sales.

TM1ELLISTTM1ELLIST devuelve un vector descendente de matriz de valores. Resulta útil porque puede obtener unconjunto de valores de elementos de un modelo TM1 utilizando una única fórmula.

Nota:

• TM1ELLIST no sobrescribe o inserta en ningún espacio que no sea de fórmula como un Informedinámico. Es responsabilidad del diseñador de la hoja de trabajo consumir correctamente la respuestade los valores plurales.

• TM1ELLIST devuelve una matriz de valores, sin embargo, solamente se visualiza el primer elemento sila función se coloca en un almacén de valores singular.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

TM1ELLIST(ServerDimension, [SetName], [ElementList],[AliasOverride], [ExpandAbove], [MDXOverride], [IndentRate], [IndentCharacter])

Argumento Descripción Necesario/Opcional

ServerDimension Una dimensión que se especifica con el formatoserver:dimension.

Obligatorios

SetName Conjunto con nombre. Si este argumento estávacío, se utilizarán todos los elementos de ladimensión.

Opcional

Capítulo 4. Funciones de hoja de trabajo 205

Argumento Descripción Necesario/Opcional

Elementlist Matriz de valores que especifica una lista deelementos para constituir un conjunto. Porejemplo, ElementList puede hacer referencia a unrango de celdas.

Al suministrar este argumento, se pasa por alto elconjunto con nombre especificado mediante elargumento SetName.

Si este argumento está vacío, se utilizarán loselementos del conjunto especificado mediante elargumento SetName.

Opcional

AliasOverride Cadena que define el alias que se utiliza en elconjunto.

Al suministrar este argumento, reemplazará lapropiedad Alias predeterminada definida por elsubconjunto que especificó el argumentoSetName.

Si este argumento está vacío, se utilizará el aliasdel conjunto especificado mediante el argumentoSubsetName.

Opcional

ExpandAbove Distintivo booleano para activar o desactivar lapropiedad Expand Above del conjunto.

Al suministrar este argumento, reemplazará lapropiedad Expand Above predeterminada definidapor el subconjunto que especificó el argumentoSet.

Si el valor del argumento es 1, los miembrosconsolidados se expandirán hacia arriba a la horade ver los detalles.

Si el valor de este argumento es 0, los miembrosconsolidados se expandirán hacia abajo a la horade ver los detalles. Si este argumento está vacío,se utilizará la propiedad Expand Above delsubconjunto especificado mediante el argumentoSubset.

Opcional

MDXOverride Sentencia MDX que se aplica al subconjuntoespecificado por el argumento SubsetName/ElementList.

Al suministrar este argumento, reemplazará elfiltro MDX predeterminado definido por elsubconjunto que especificó el argumentoSetName.

Si este argumento está vacío o se omite, seutilizarán los miembros del conjunto especificadomediante el argumento SetName.

Opcional

206 IBM Planning Analytics: Referencia de TM1

Argumento Descripción Necesario/Opcional

IndentRate Valor entero para indicar cuántas sangrías seaplican a cada nivel a la hora de ver los detalles deun miembro consolidado.

Si el valor del argumento es 0, no se realizará lasangría automática. IndentRate depende del nivelde conjunto de los elementos del conjunto.

Si este argumento está vacío o se omite, se aplicauna sangría a cada nivel a medida que desciende amayor nivel de detalle en un miembro consolidado.

Opcional

IndentCharacter IndentChar establece el símbolo que seproporciona para la sangría de la cadena, el valorpredeterminado es el carácter en-space (elsímbolo de espacio normal).

Opcional

Ejemplo

TM1ELLIST("PlanSamp:plan_currency","All currencies")

TM1ELLIST devuelve una matriz de elementos basada en los argumentos proporcionados.

Para recuperar todos los valores devueltos, puede crear un rengo con nombre en Excel, haciendoreferencia a la fórmula. Para ello, cree un rango con nombre y especifique la fórmula TM1ELLIST en lacolumna Hace referencia a.

Seleccione el número de celdas que desee (según el tamaño de matriz devuelto) en Excel, especifique=[rango con nombre] y pulse Ctrl+Mayús+Intro.

A continuación, puede utilizar la función INDEX de Excel para extraer un único elemento para el rango.

Capítulo 4. Funciones de hoja de trabajo 207

TM1GLOBALSANDBOXTM1GLOBALSANDBOX devuelve el recinto de pruebas global que está activo actualmente para el usuario.

Nota: Esta función solo es válida en hojas web de Planning Analytics for Microsoft Excel y de PlanningAnalytics. No se admite en IBM TM1 Perspectives.

Sintaxis

TM1GLOBALSANDBOX(SERVER)

Argumento Descripción Necesario/Opcional

Servidor Nombre del servidor de TM1. Obligatorios

Ejemplo

TM1GLOBALSANDBOX("Planning Sample")

TM1INFOTM1INFO devuelve información sobre el cliente y la versión actual de TM1.

Nota: Esta función solo es válida en hojas web de Planning Analytics for Microsoft Excel y de PlanningAnalytics. No se admite en IBM TM1 Perspectives.

Sintaxis

TM1INFO("Property Name")

208 IBM Planning Analytics: Referencia de TM1

Argumento Descripción Necesario/Opcional

Property Name El nombre de la propiedad puede ser cualquiera delos siguientes:clientversion

Devuelve el número completo de versión delcliente. Por ejemplo, 10.2.10000

clientversionmajorDevuelve el número principal de versión delcliente.

clientversionminorDevuelve el número mínimo de versión delcliente.

clientversionpatchDevuelve el número del fixpack y de la revisión.

clientDevuelve el nombre de cliente. Por ejemplo,cor o websheet.

Obligatorios

Ejemplo

TM1INFO("clientversion")

TM1PRIMARYDBNAMETM1PRIMARYDBNAME devuelve el nombre del TM1 Server primario a través del cual se ha autenticado elusuario, incluso si este ha iniciado sesión implícitamente en varios TM1 Server. Esta función no aceptaningún argumento.

Nota: Esta función solo es válida en hojas web de Planning Analytics for Microsoft Excel y de PlanningAnalytics. No se admite en IBM TM1 Perspectives.

Sintaxis

TM1PRIMARYDBNAME()

TM1RptElIsConsolidatedTM1RptElIsConsolidated devuelve un valor booleano para indicar si se ha consolidado un elemento en unFormulario activo. Esta función de hoja de trabajo se utiliza para crear formularios activos.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

TM1RptElIsConsolidated(RptRowFormula, Element)

Argumento Descripción

RptRowFormula Referencia absoluta a una celda que contiene unafórmula TM1RptRow.

Capítulo 4. Funciones de hoja de trabajo 209

Argumento Descripción

Element Referencia relativa a una celda que contiene unelemento de la fórmula TM1RptRow.

TM1RptElIsExpandedTM1RptElIsExpanded devuelve un valor booleano para indicar si un elemento se expande en unsubconjunto de filas de un Formulario activo. Esta función de hoja de trabajo se utiliza para crearformularios activos.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

TM1RptElIsExpanded(RptRowFormula, Element)

Argumento Descripción

RptRowFormula Referencia absoluta a una celda que contiene unafórmula TM1RptRow.

Element Referencia relativa a una celda que contiene unelemento de la fórmula TM1RptRow.

TM1RptElLevTM1RptElLev devuelve un valor entero de un nivel de elemento relativo a la raíz del subconjunto. Estafunción de hoja de trabajo se utiliza para crear formularios activos. Esta función es diferente a la funciónde hoja de trabajo EILev.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

TM1RptElLev(RptRowFormula, Element)

Argumento Descripción

RptRowFormula Referencia absoluta a una celda de la fórmulaTM1RptRow.

Element Referencia relativa a una celda que contiene unelemento de la fórmula TM1RptRow.

TM1RptFilterTM1RptFilter define el filtro que se ha aplicado a la dimensión de columna de un Formulario activo. Estafunción de hoja de trabajo se utiliza para crear formularios activos.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

210 IBM Planning Analytics: Referencia de TM1

Sintaxis

TM1RptFilter(ReportView,Tuple,FilterFunction,FilterValue,SortOrder)

Argumento Descripción

ReportView Referencia de celda a una celda que contiene unafórmula TM1RptView. El filtro se aplica a la vistaespecificada por la fórmula TM1RptView.

Tuple Cadena de tupla que especifica el elemento de ladimensión de columna al que se aplica el filtro. Porejemplo, [month].[Feb].

FilterFunction Uno de los siguientes nombres de funciones defiltro:

TOPCOUNT

BOTTOMCOUNT

TOPPERCENT

BOTTOMPERCENT

TOPSUM

BOTTOMSUM

FilterValue Valor de filtro.

SortOrder Uno de los siguientes dos órdenes de clasificación:

asc

desc

Ejemplo

=TM1RptFilter($B$4,"[month].[Jan]","TOPCOUNT",5,"asc")

TM1RptRowTM1RptRow establece la definición de fila maestra de formulario activo. La definición de fila maestra rigeel comportamiento de todas las filas del Formulario activo. Esta función de hoja de trabajo se utiliza paracrear formularios activos.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

TM1RptRow(ReportView, Dimension, Subset, SubsetElements,Alias, ExpandAbove,MDXStatement, Indentations, ConsolidationDrilling)

Argumento Descripción

ReportView Referencia a una celda que contiene una fórmulaTM1RptView.

Capítulo 4. Funciones de hoja de trabajo 211

Argumento Descripción

Dimensión Una dimensión que se especifica con el formatonombre_servidor_tm1:nombre_dimensión.

Subconjunto Subconjunto con nombre. Si este argumento estávacío, se utilizarán todos los elementos de ladimensión.

SubsetElements Referencia de rango de celdas que especifica unalista de elementos para constituir un subconjunto.

Al suministrar este argumento, se ignora elsubconjunto con nombre especificado mediante elargumento Subset.

Si este argumento está vacío, se utilizarán loselementos del subconjunto especificado medianteel argumento Subset.

Alias Cadena que define el alias que se utiliza en elsubconjunto.

Al suministrar este argumento, reemplazará lapropiedad Alias predeterminada definida por elsubconjunto que especificó el argumento Subset.

Si este argumento está vacío, se utilizará el aliasdel subconjunto especificado mediante elargumento Subset.

ExpandAbove Distintivo booleano para activar o desactivar lapropiedad Expand Above del subconjunto. Alsuministrar este argumento, reemplazará lapropiedad Expand Above predeterminada definidapor el subconjunto que especificó el argumentoSubset.

Si el valor del argumento es 1, los elementosconsolidados se expandirán hacia arriba a la horade ver los detalles.

Si el valor del argumento es 0, los elementosconsolidados se expandirán hacia abajo a la horade ver los detalles.

Si este argumento está vacío, se utilizará lapropiedad Expand Above del subconjuntoespecificado mediante el argumento Subset.

MDXStatement Sentencia MDX que se aplica al subconjuntoespecificado por el argumento Subset.

Al suministrar este argumento, reemplazará elfiltro MDX predeterminado definido por elsubconjunto que especificó el argumento Subset.

Si este argumento está vacío o se omite, seutilizarán los elementos del subconjuntoespecificado mediante el argumento Subset.

212 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

Indentations Valor entero para indicar cuántas sangrías seaplican a cada nivel a la hora de detallar más unelemento consolidado. Si el valor del argumento es0, no se realizará la sangría automática.

Éste es un argumento opcional. Cuando el valor noestá disponible, se aplica una sangría a cada nivelal detallar más en un elemento consolidado.

ConsolidationDrilling Distintivo booleano para activar o desactivar elacceso a los detalles en los elementosconsolidados.

Cuando el valor de este argumento es 1, losusuarios pueden detallar más en los elementosconsolidados del Formulario activo.

Cuando este valor del argumento es 0, los usuariosno pueden detallar más en los elementosconsolidados del Formulario activo.

Éste es un argumento opcional. Cuando elargumento no está disponible, el comportamientopredeterminado es permitir ver los detalles en loselementos consolidados.

Ejemplo

=TM1RptRow($B$9,"sdata:region","",'{AR}01'!$B$17:$B$18,"",1,"",5, 0)

TM1RptTitleTM1RptTitle define una dimensión de título de formulario activo. Esta función de hoja de trabajo se utilizapara crear formularios activos.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

TM1RptTitle(Dimension,Element)

Argumento Descripción

Dimensión Una dimensión que se especifica con el formatotm1_name:dimension_name.

Elemento Referencia de celda a una celda que contiene unafunción SUBNM que devuelve un nombre deelemento.

Ejemplo

TM1RptTitle("SData:model",$C$7)

Capítulo 4. Funciones de hoja de trabajo 213

TM1RptViewTM1RptView define la vista que aparece en un Formulario activo. Esta función de hoja de trabajo se utilizapara crear formularios activos.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

TM1RptView(ViewID,ZeroSuppression,TM1RptTitle,...)

Argumento Descripción

ViewID El nombre de una vista que utiliza el formatotm1_name:cube_name:unique_id.

ZeroSuppressio Distintivo booleano para activar o desactivar lapropiedad de supresión de ceros de la vista. 1 =activado, 0 = desactivado

TM1RptTitle En cada dimensión de título del Formulario activo,incluya una función TM1RptTitle como argumentode TM1RptView.

FormatRange El rango de formateo del Formulario activo.

Al crear un Formulario activo, se crea un rango connombre denominado TM1RPTFMTRNG para incluirtodas las celdas del rango de formateo. Puedeutilizar este rango con nombre como argumento.

IDColumn Columna que contiene las ID de formato delFormulario activo.

Al crear un formulario activo, se crea un rango connombre denominado TM1RPTFMTIDCOL paraincluir todas las celdas del rango de formateo.Puede utilizar este rango con nombre comoargumento.

Ejemplo

=TM1RPTVIEW("SData:SalesCube:6", 0, TM1RPTTITLE("SData:actvsbud",$C$6), TM1RPTTITLE("SData:model",$C$7), TM1RPTTITLE("SData:account1",$C$8), TM1RPTFMTRNG,TM1RPTFMTIDCOL)

TM1UserTM1User devuelve el nombre de usuario del usuario actual de TM1.

Si el usuario TM1 actual no está conectado a un servidor, o si el servidor especificado no se estáejecutando, TM1User devuelve una cadena vacía.

Si TM1User se ejecuta con un servidor que está configurado para utilizar la autenticación CAM, la funcióndevolverá el nombre de usuario interno/CAMID, no el nombre de visualización.

214 IBM Planning Analytics: Referencia de TM1

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

TM1User("ServerName")

Argumento Descripción

ServerName Nombre del servidor al que está conectado elusuario de TM1.

Ejemplo

TM1User("SData")

Si un usuario denominado BrianT ha iniciado sesión en el servidor SData, y ese usuario ejecuta la funciónTM1User, el ejemplo anterior devolverá BrianT.

VIEWVIEW crea una vista optimizada del cubo especificado por el argumento del cubo.

Se crea una única función VIEW al dividir una vista desde el explorador de cubos.

Todas las fórmulas DBR y DBRW que hacen referencia a la función VIEW pueden acceder a esta vistaoptimizada. De esta forma, los resultados se devuelven de una forma mucho más rápida.

Varias funciones VIEW pueden residir en la misma hoja de cálculo si cuenta con bloques de fórmulas DBRque hacen referencia a vistas y/o cubos de TM1.

Esta función de hoja de trabajo solo es válida en hojas de trabajo.

Sintaxis

VIEW(cube, e1,e2[,...en])

Argumento Descripción

cube El nombre del cubo desde el que se van arecuperar los datos.

e1,...en Cualquiera de los elementos específicos de laporción que se deben utilizar como título o lacadena "!". La cadena "!" indica que la dimensióncorrespondientes es una fila o columna de la vista.Estos argumentos también pueden ser nombres dealias de elementos de dimensiones.

Ejemplo

VIEW("93sales",$B$2,$B$3,$B$4,"!","!")

Capítulo 4. Funciones de hoja de trabajo 215

216 IBM Planning Analytics: Referencia de TM1

Capítulo 5. funciones de TurboIntegratorTM1 TurboIntegrator le permite manipular metadatos y datos de TM1 cuando define un proceso.

Esto se logra mediante el uso de funciones de las subpestañas Prólogo, Metadatos, Datos y Epílogo de lapestaña Avanzado de la ventana TurboIntegrator. Estas subpestañas incluyen sentencias generadas quese basan en valores y opciones que selecciona al definir un proceso TurboIntegrator. Las funciones quecree deben aparecer tras las sentencias generadas. Para obtener más información sobre la creación deprocesos con TurboIntegrator, consulte la documentación de TM1 TurboIntegrator.

Las funciones de TurboIntegrator de esta sección están ordenadas por categoría.

No existe ninguna interfaz que sirva de ayuda en la creación de funciones de TurboIntegrator. Especifiquefunciones de forma manual directamente en la correspondiente subpestaña de la pestaña Avanzado. Losargumentos de cadena para funciones de TurboIntegrator deben aparecer entre comillas simples. Paraindicar el fin de cada función, debe incluirse un punto y coma (;) en la ventana de TurboIntegrator.

Además de estas funciones de TurboIntegrator, también puede incorporar todas las funciones de reglasTM1, estándar en una definición de proceso, excepto la función STET.

Todos los argumentos de las funciones de TurboIntegrator están limitados a 256 bytes. Una función deTurboIntegrator puede aceptar varios argumentos, y todos los argumentos están limitados a 256 bytes.

Palabras reservadas de TurboIntegratorPara impedir que se produzcan errores en sus scripts de TurboIntegrator, debe evitar que se creenvariables con nombres que coincidan con cualquiera de las palabras que aparecen en las tablassiguientes.

Hay cuatro categorías de palabras reservadas en TurboIntegrator:

• Nombres de funciones de reglas - Consulte Capítulo 2, “Funciones de reglas”, en la página 103 paraobtener una lista completa de todos los nombres de funciones de reglas.

• Nombres de funciones de TurboIntegrator - Consulte Capítulo 5, “funciones de TurboIntegrator”, en lapágina 217 para obtener una lista completa de todos los nombres de funciones de TurboIntegrator.

• Nombres de variables locales implícitas - consulte “Variables locales de TurboIntegrator” en la página419 para obtener una lista completa de todos los nombres de variables locales implícitas deTurboIntegrator.

• Palabras clave de TurboIntegrator - Estas palabras están reservadas y no se deben utilizar comovariables en los scripts:

– break– else– elseif– end– endif– if– while

Funciones de TurboIntegrator de texto y ASCIIEstas funciones pertenecen a ASCII y texto.

© Copyright IBM Corp. 2007, 2019 217

ASCIIDeleteASCIIDelete elimina un archivo ASCII.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ASCIIDelete(FileName);

Argumento Descripción

FileName El nombre del archivo ASCII que desea eliminar. Sino se especifica una vía de acceso completa, TM1busca el archivo en el directorio de datos delservidor.

Ejemplo

Este ejemplo suprime el archivo ASCII denominado 2002Q1Results.cma del directorioC:\exported_data.

ASCIIDelete('C:\exported_data\2002Q1Results.cma');

ASCIIOutputASCIIOutput escribe un registro separado por comas en un archivo ASCII.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

El archivo ASCII se abre cuando se escribe el primer registro y se cierra cuando el procedimiento deTurboIntegrator (Prólogo, Metadatos, Datos o Epílogo) que contiene la función ASCIIIOutput termina deprocesarse.

Los registros de salida generados por ASCIIOutput están limitados a 8000 bytes. Si un registro de salidasupera los 8000 bytes, el registro se trunca y aparece un aviso en el archivo TM1ProcessError.log.

Cuando ASCIIOutput encuentra un argumento String que exige que el registro de salida supere el límitede 8000 bytes, ignora ese argumento y los argumentos posteriores. Por ejemplo, si existen 10argumentos String y la salida de los primeros siete argumentos es de 7950 bytes en total, y la salida deloctavo argumento es de 51 bytes, únicamente se escribirá en el registro la salida de los primeros sieteargumentos. Si existen diez argumentos String y el primer argumento supera los 8000 bytes, no seescribirá ninguna salida en el registro.

Si utiliza la función ASCIIOutput para escribir en el mismo archivo en varios procedimientos (pestañas) deun proceso TurboIntegrator, el archivo se sobrescribirá cada vez que se abra para un nuevoprocedimiento.

La función ASCIIOutput genera un error leve si se produce un error al escribir el archivo ASCII. Además,la función devuelve un valor tras la ejecución: 1 si la función escribe correctamente el archivo ASCII y 0 sise produce un error.

Nota: Únicamente se genera el error y se devuelve el valor si ASCIIOutput está escribiendo en un discoque no es el disco en el que se está ejecutando el servidor. Por ejemplo, si el servidor se está ejecutandoen la unidad C:, y ASCIIOutput está escribiendo en la unidad F: y esta última se queda sin espacio, secapturará el error y el servidor permanecerá activo. Si el servidor se está ejecutando en la unidad C:mientras que ASCIIOutput también está escribiendo en dicha unidad y ésta se queda sin espacio, elservidor finalizará (como se esperaba).

Nota: La capacidad de ejecutar la función ASCIIOutput cuando el origen de datos es una vista de cubo sedetermina mediante la asignación de la función Permitir exportación como texto, que se establece porgrupo de usuarios. Si un usuario es miembro de un grupo al que se ha denegado la capacidad de exportar

218 IBM Planning Analytics: Referencia de TM1

datos como texto, cuando intente ejecutar ASCIIOutput se cerrará el proceso con un error de permisos. Elregistro de mensajes del proceso indica "Se ha cancelado la ejecución. No hay acceso deseguridad para ASCIIOutput."

Para obtener información detallada sobre cómo definir la función Permitir exportación como texto,consulte "Asignación de funciones" en TM1 Operations.

Nota: La función ASCIIOutput coloca el carácter hexadecimal 0x1A al final de todos los archivosgenerados. Sin embargo, TM1 Web no puede abrir una hoja web que contenga el carácter hexadecimal0x1A.

Si utiliza ASCIIOutput para exportar datos de TM1 en un archivo ASCII y, a continuación, intenta abrir elarchivo en una hoja web de TM1, encuentra el siguiente error.

Se produjo un error al convertir el libro de trabajo de MS Excel a formato XML; el valor hexadecimal 0x1Ano es un carácter válido.

Si elimina el carácter hexadecimal 0x1A de la hoja web, el archivo se abre en TM1 Web.

Sintaxis

ASCIIOutput(FileName, String1, String2, ...Stringn);

Argumento Descripción

FileName Una ruta completa del archivo ASCII en el quedesea escribir el registro. La ruta debe incluir unaextensión de archivo.

String1...Stringn Una cadena que corresponde a cada campo quedesee crear en el archivo ASCII. Este argumentopuede ser una cadena o una variable deTurboIntegrator de una cadena.

Ejemplo

Este ejemplo escribe un registro en el archivo ASCII NewCube.cma. Cada campo del registro correspondea una variable asignada por TurboIntegrator a una columna de su origen de datos.

ASCIIOutput('NewCube.cma', V1, V2, V3, V4, V5 );

NumberToStringNumberToString convierte un número en una cadena, utilizando el separador decimal para el entornolocal del usuario actual.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

En Microsoft Windows, el separador decimal es un valor de Opciones regionales.

La salida de esta función es similar al formato de número "general"; no utiliza separadores de millares yutiliza el signo menos (-) para indicar números negativos.

Sintaxis

NumberToString(Value);

Argumento Descripción

Value El valor real que desea convertir en una cadena.

Capítulo 5. funciones de TurboIntegrator 219

Ejemplo

nRET = NumberToString(1234.5);

NumberToStringExNumberToStringEx convierte un número en una cadena, utilizando el formato de la cadena que se hapasado, el separador decimal y el separador de millares.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

NumberToStringEx(Value, NumericFormat, DecimalSep, ThousandsSep);

Argumento Descripción

Valor El valor real que desea convertir en una cadena.

FormatString Una cadena de formato numérico de TM1 quedefine el formato de salida de las funciones. Losformatos numéricos están descritos en ladocumentación de IBM Cognos TM1 Perspectives,TM1 Architect, and TM1 Web.

DecimalSep El separador decimal que se utilizará en la cadenade salida.

ThousandsSep El separador de millares que se utilizará en lacadena de salida.

Ejemplo

sRet=NUMBERTOSTRINGEX(7895.23,'#,0.#########', ',', '.');

ASCIIOUTPUT('number_to_string.txt',sRet);

Devolverá en el archivo ascii;

7.895,23

SetInputCharacterSetLa función SetInputCharacterSet le permite especificar el juego de caracteres de un origen de datosTurboIntegrator.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Cuando un proceso TurboIntegrator lee un archivo externo como entrada, necesita conocer el juego decaracteres en el que se escribió dicho archivo externo. Si el archivo contiene una marca de orden de bytesválida, las funciones de TM1 se convertirán correctamente a UTF-8, si es necesario.

Para aquellos formatos que carezcan de una marca de orden de bytes válida, los caracteres se debenconvertir de cualquier otra codificación a UTF-8. Si los conversores adecuados están disponibles en lamáquina que aloja al servidor, el archivo de entrada se convertirá al juego de caracteres Unicode querequiere TM1.

Sintaxis

SetInputCharacterSet (CharacterSet);

220 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

CharacterSet La codificación de caracteres del archivo deentrada que utilizará el proceso TurboIntegrator.

Si el argumento CharacterSet no es un tipo decarácter conocido, se establece el tipopredeterminado en el entorno local del sistema.

Codificación de caracteres Entorno local del sistema

TM1CS_ISO_8859_1 ISO-8859-1 Latín 1, Europa occidental

TM1CS_ISO_8859_2 ISO-8859-2 Latín 2, Europa central

TM1CS_ISO_8859_3 ISO-8859-3 Latín 3, Europa meridional

TM1CS_ISO_8859_4 ISO-8859-4 Latín 4, Europa septentrional

TM1CS_ISO_8859_5 ISO-8859-5 Latín/Cirílico

TM1CS_ISO_8859_6 ISO-8859-6 Latín/Árabe

TM1CS_ISO_8859_7 ISO-8859-7 Latín/Griego

TM1CS_ISO_8859_8 ISO-8859-8 Latín/Hebreo

TM1CS_ISO_8859_9 ISO-8859-9 Latín 5, Turco

TM1CS_ISO_8859_10 ISO-8859-10 Latín 6, Nórdico,

TM1CS_ISO_8859_11 ISO-8859-11 Latín/Tailandés

TM1CS_ISO_8859_13 ISO-8859-13 Latín 7, Ribera del Báltico

TM1CS_ISO_8859_14 ISO-8859-14 Latín 8, Celta

TM1CS_ISO_8859_15 ISO-8859-15 Latín 9, sustituye a ISO-8859-1

TM1CS_ISO_8859_16 ISO-8859-16 Latín 10, Europa suroriental

TM1CS_WCP1250 Microsoft Windows Europa Central

TM1CS_WCP1251 Windows cirílico

TM1CS_WCP1252 Windows latín 1 multilingüe

TM1CS_WCP1253 Windows griego

TM1CS_WCP1254 Windows turco

TM1CS_WCP1255 Windows hebreo

TM1CS_WCP1256 Windows árabe

Capítulo 5. funciones de TurboIntegrator 221

Codificación de caracteres Entorno local del sistema

TM1CS_WCP1257 Windows báltico

TM1CS_WCP1258 Windows vietnamita

TM1CS_WCP874 Windows tailandés

TM1CS_WCP932 Windows japonés

TM1CS_WCP936 Windows chino simplificado

TM1CS_WCP949 Windows coreano

TM1CS_WCP950 Windows chino tradicional

TM1CS_KOI8R Ruso y cirílico (KOI8-R)

TM1CS_GB18030 UNICODE versión PRC

TM1CS_BIG5 Chino tradicional

TM1CS_SHIFTJIS JIS 0201 + JIS 0208, ligeramente diferente deCP932

TM1CS_SJIS0213 JIS 0213-2004, no necesita BMP.

TM1CS_EUC_JP EUC japonés

TM1CS_EUC_CN EUC chino simplificado

TM1CS_EUC_KR EUC coreano

TM1CS_UTF8 UTF-8

TM1CS_UTF16 UTF-16 Little Endian

TM1CS_UTF16ESC Notación UNICODE

TM1CS_UTF32 UTF-32 Little Endian

TM1CS_OS_DEFAULT sistema operativo predeterminado

TM1CS_LOCALPATH codificación local pero notación UNICODE en modono nativo.

Ejemplo

SetInputCharacterSet ('TM1CS_ISO_8859_11');

Este ejemplo especifica que el juego de caracteres de entrada del origen de datos de TurboIntegrator esISO-8859-11 Latín/Tailandés.

222 IBM Planning Analytics: Referencia de TM1

SetOutputCharacterSetSetOutputCharacterSet le permite especificar el juego de caracteres que se utilizará al escribir en unarchivo de texto utilizando TextOutput en un proceso de TurboIntegrator.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

La función con la función TextOutput.

Se utiliza con TextOutputs.

Sintaxis

SetOutputCharacterSet( FileName, CharacterSet );

Argumento Descripción

FileName Una ruta completa del archivo de texto para el quedesea especificar un juego de caracteres. La rutadebe incluir una extensión de archivo.

Este argumento debe ser idéntico al argumentoFileName de la función TextOutput.

CharacterSet La codificación de caracteres que se utilizará alescribir en el archivo de salida.

Para obtener más información sobre los valores válidos de CharacterSet, consulte:“SetInputCharacterSet” en la página 220.

SetOutputEscapeDoubleQuoteSetOutputEscapeDoubleQuote permite utilizar caracteres de escape con las comillas dobles queaparecen en los nombres de elemento o en los valores de datos a la hora de exportar una vista de cubo aun archivo .csv.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Cuando se incluye SetOutputEscapeDoubleQuote en el script TurboIntegrator y se establece en 1, elarchivo exportado conserva las posiciones de las comillas dobles tal como aparecen en la vista de cubode origen utilizando en cada una de las comillas dobles otro par de comillas dobles como caracteres deescape. Por ejemplo, si un elemento de la vista de origen se llama "Región", el elemento se exporta como"""Región""" en el archivo de salida .csv.

Cuando SetOutputEscapeDoubleQuote no se incluye en el script TurboIntegrator o se establece en 0, elarchivo exportado no utiliza caracteres de escape para las comillas dobles que aparecen en el cubo deorigen.

SetOutputEscapeDoubleQuote se utiliza junto con la función ASCIIOutput, que es la función que enrealidad escribe en el archivo de salida. SetOutputEscapeDoubleQuote debe preceder a ASCIIOutput enel script TurboIntegrator, y ambas funciones deben utilizar el mismo valor de parámetro FileName.

Sintaxis

SetOutputEscapeDoubleQuote(FileName, Num);

Capítulo 5. funciones de TurboIntegrator 223

Argumento Descripción

FileName Una ruta completa al archivo en el que deseaescribir la vista del cubo. La ruta debe incluir unaextensión de archivo.

Num Distintivo que determina si las comillas doblesaparecen con caracteres de escape en el archivode salida.

1 indica que las comillas dobles aparecen concaracteres de escape en el archivo de salida.

0 indica que las comillas dobles no aparecen concaracteres de escape en el archivo de salida.

Ejemplo

SetOutputEscapeDoubleQuote('C:\temp\cube1.csv', 1);

En este ejemplo, se utilizan caracteres de escape con todas las comillas dobles que se encuentren en lavista de cubo de origen a la hora de escribir la salida en el archivo C:\temp\cube1.csv.

StringToNumberStringToNumber convierte una cadena en un número, utilizando el separador decimal para el entornolocal del usuario actual. Si la cadena de entrada no es una cadena de número válida, el valor devueltoserá un valor de coma flotante no válido. En Microsoft Windows, el separador decimal es un valor deOpciones regionales.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

StringToNumber(String);

Argumento Descripción

String La cadena que desea convertir en un número.

Ejemplo

nRET = StringToNumber('123.45');

StringToNumberExStringToNumberEx convierte una cadena en un número, utilizando el separador decimal y el separador demillares que se han pasado. Si la cadena de entrada no es una cadena de número válida, el valor devueltoserá un valor de coma flotante no válido.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

StringToNumberEx(String, DecimalSep, ThousandsSep);

224 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

String La cadena que desea convertir en un número.

DecimalSep El separador decimal que se utilizará en el númerode salida.

ThousandsSep El separador de millares que se utilizará en elnúmero de salida.

Ejemplo

nRET = StringToNumberEx('12453.45', ' . ', ' , ');

TextOutputTextOutput escribe un registro separado por comas en un archivo de texto.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

De forma predeterminada, TextOutput escribe caracteres en el juego de caracteres del entorno local delservidor. Para crear un archivo en un juego de caracteres distinto, llame a la funciónSetOutputCharacterSet antes de invocar TextOutput.

El archivo de texto se abre cuando se escribe el primer registro, y se cierra cuando el procedimiento deTurboIntegrator (Prólogo, Metadatos, Datos o Epílogo) que contiene la función TextOutput termina deprocesarse.

Si utiliza la función TextOutput para escribir en el mismo archivo en varios procedimientos (pestañas) deun proceso TurboIntegrator, el archivo se sobrescribirá cada vez que se abra para un nuevoprocedimiento.

Los registros de salida generados por TextOutput están limitados a 8000 bytes. Si un registro de salidasupera los 8000 bytes, el registro se trunca y aparece un aviso en el archivo TM1ProcessError.log.

Cuando TextOutput encuentra un argumento String que exige que el registro de salida supere el límite de8000 bytes, ignora ese argumento y los argumentos posteriores. Por ejemplo, si existen 10 argumentosString y la salida de los primeros siete argumentos es de 7950 bytes en total, y la salida del octavoargumento es de 51 bytes, únicamente se escribirá en el registro la salida de los primeros sieteargumentos. Si existen diez argumentos String y el primer argumento supera los 8000 bytes, no seescribirá ninguna salida en el registro.

La función TextOutput genera un error leve si se produce un error al escribir el archivo de texto. Además,la función devuelve un valor tras la ejecución: 1 si la función escribe correctamente el archivo de texto y 0si se produce un error.

Únicamente se generará el error y se devolverá el valor si TextOutput está escribiendo en un disco que nosea el disco en el que se está ejecutando el servidor. Por ejemplo, si el servidor se está ejecutando en launidad C:, y TextOutput está escribiendo en la unidad F: y esta última se queda sin espacio, se capturaráel error y el servidor permanecerá activo. Si el servidor se está ejecutando en la unidad C: mientras queTextOutput también está escribiendo en dicha unidad y ésta se queda sin espacio, el servidor finalizará(como se esperaba).

Nota: La capacidad de ejecutar la función TextOutput cuando el origen de datos es una vista de cubo sedetermina mediante la asignación de la función Permitir exportación como texto, que se establece porgrupo de usuarios. Si un usuario es miembro de un grupo al que se ha denegado la capacidad de exportardatos como texto, cuando intente ejecutar TextOutput se cerrará el proceso con un error de permisos. Elregistro de mensajes del proceso indica "Se ha cancelado la ejecución. No hay acceso deseguridad para TextOutput."

Capítulo 5. funciones de TurboIntegrator 225

Para obtener información detallada sobre cómo definir la función Permitir exportación como texto,consulte "Asignación de funciones" en la documentación de IBM Cognos TM1 Operations.

Sintaxis

TextOutput(FileName, String1, String2, ...Stringn);

Argumento Descripción

FileName Una ruta completa del archivo de texto en el quedesea escribir el registro. La ruta debe incluir unaextensión de archivo.

String1...Stringn Una cadena que corresponde a cada campo quedesee crear en el archivo de texto. Este argumentopuede ser una cadena o una variable deTurboIntegrator de una cadena.

Ejemplo

TextOutput('NewCube.cma', V1, V2, V3, V4, V5 );

Este ejemplo escribe un registro en el archivo NewCube.cma. Cada campo del registro corresponde a unavariable asignada por TurboIntegrator a una columna de su origen de datos.

Funciones de TurboIntegrator de manipulación de atributosEstas funciones facilitan la manipulación de atributos.

ATTRNLATTRNL devuelve un atributo numérico para un elemento especificado de una dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ATTRNL(DimName, ElName, AttrName, [LangLocaleCode]);

Argumento Descripción

DimName Un nombre de dimensión válido.

ElName Un elemento de la dimensión.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido delelemento.

226 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma para el que desea que sedevuelva un valor.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales listados en la dimensión de controlde contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, el entorno local actual delusuario se utiliza como argumento deLangLocaleCode.

Si no existe ningún valor de atributo paraLangLocaleCode, se devuelve el valor de unLangLocaleCode padre asociado. Si no existeningún valor de atributo para un LangLocaleCodepadre asociado, se devuelve el valor de atributobase.

Por ejemplo, si LangLocaleCode es fr-CA, lafunción devuelve el valor de atributo del entornolocal fr-CA, si está disponible. Si el valor deatributo de fr-CA no está disponible, la funciónintenta devolver el valor de atributo del entornolocal fr padre. Si el valor de atributo de fr no estádisponible, se devuelve el valor de atributo base.

Ejemplo

En este ejemplo, la función devuelve el valor numérico del atributo Engine Size del elemento L Series 1.8LSedan de la dimensión Model del entorno local francés.

ATTRNL('Model', 'L Series 1.8L Sedan', 'Engine Size', 'fr');

ATTRSLAttrSL devuelve un atributo de cadena para un elemento especificado de una dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

AttrSL(DimName, ElName, AttrName, [LangLocaleCode]);

Argumento Descripción

DimName Un nombre de dimensión válido.

ElName Un elemento de la dimensión.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido delelemento.

Capítulo 5. funciones de TurboIntegrator 227

Argumento Descripción

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma para el que desea que sedevuelva un valor.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales listados en la dimensión de controlde contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, el entorno local actual delusuario se utiliza como argumento deLangLocaleCode.

Si no existe ningún valor de atributo paraLangLocaleCode, se devuelve el valor de unLangLocaleCode padre asociado. Si no existeningún valor de atributo para un LangLocaleCodepadre asociado, se devuelve el valor de atributobase.

Por ejemplo, si LangLocaleCode es fr-CA, lafunción devuelve el valor de atributo del entornolocal fr-CA, si está disponible. Si el valor deatributo de fr-CA no está disponible, la funciónintenta devolver el valor de atributo del entornolocal fr padre. Si el valor de atributo de fr no estádisponible, se devuelve el valor de atributo base.

Ejemplo

En este ejemplo, la función devuelve el valor de cadena del atributo Currency del elemento 10100 de ladimensión Plan_Business_Unit del entorno local francés.

AttrSL('Plan_Business_Unit', '10100', 'Currency', 'fr');

AttrDeleteAttrDelete suprime un atributo de elemento de la base de datos de TM1.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

AttrDelete(DimName, AttrName);

Argumento Descripción

DimName La dimensión de la que desea eliminar un atributode elemento.

AttrName El nombre del atributo que desea eliminar.

228 IBM Planning Analytics: Referencia de TM1

Ejemplo

Este ejemplo elimina el atributo de elemento Colorinterior de la dimensión Modelo.

AttrDelete('Modelo', 'Colorinterior');

AttrInsertAttrInsert crea un atributo de elemento para una dimensión. Esta función puede crear un atributo dealias, numérico o de cadena.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

AttrInsert(DimName, PrevAttr, AttrName, Type);

Argumento Descripción

DimName La dimensión para la que desea crear un atributode elemento.

PrevAttr El atributo que precede al atributo que estácreando.

AttrName El nombre que desea asignar al nuevo atributo.

Tipo El tipo de atributo. Existen tres posibles valorespara el argumento Type:

• N: crea un atributo numérico.• S: crea un atributo de cadena.• A: crea un atributo de alias.

Ejemplo

Este ejemplo crea el atributo de cadena InteriorColor de la dimensión Model. Este atributo se insertadespués del atributo Transmission.

AttrInsert('Model', 'Transmission', 'InteriorColor','S');

AttrPutNAttrPutN asigna un valor a un atributo de elemento numérico.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

AttrPutN( Value, DimName, ElName, AttrName, [LangLocaleCode] );

Argumento Descripción

Value El valor numérico que desea asignar a un atributode elemento.

DimName La dimensión padre del elemento al que deseaasignar un valor de atributo.

Capítulo 5. funciones de TurboIntegrator 229

Argumento Descripción

ElName El elemento al que desea asignar un valor deatributo.

AttrName El atributo cuyo valor desea asignar.

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma al que se aplicaNumericValue.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales ISO 639-1 listados en la dimensióncontrol de contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, se actualiza el valor de atributobase.

Ejemplo

Este ejemplo asigna el valor 2257993 al atributo Códprod de S Series 1.8L Sedan de la dimensiónModelo.

AttrPutN(2257993, 'Modelo', ' S Series 1.8L Sedan ', 'Códprod');

AttrPutSAttrPutS asigna un valor a un atributo de elemento de cadena.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

AttrPutS(Value, DimName, ElName, AttrName, [LangLocaleCode] );

Argumento Descripción

Value El valor que desea asignar a un atributo deelemento.

DimName La dimensión padre del elemento al que deseaasignar un valor de atributo.

ElName El elemento al que desea asignar un valor deatributo.

AttrName El atributo cuyo valor desea asignar.

230 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma al que se aplica el valor.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales listados en la dimensión de controlde contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, se actualiza el valor de atributobase.

Ejemplo

Este ejemplo asigna la cadena Beige al atributo Colorinterior de S Series 1.8L Sedan de la dimensiónModelo.

AttrPutS('Beige', 'Modelo', 'S Series 1.8L Sedan', 'Colorinterior');

ChoreAttrDeleteChoreAttrDelete suprime un atributo chore de la base de datos TM1.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ChoreAttrDelete(AttrName);

Argumento Descripción

AttrName El nombre del atributo de tarea que deseasuprimir.

Ejemplo

Este ejemplo suprime el atributo de descripción para tareas en TM1 Server.

ChoreAttrDelete('Description');

ChoreAttrInsertChoreAttrInsert crea un atributo nuevo para tareas en TM1 Server. Esta función puede crear un atributode alias, numérico o de cadena.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Atención: Si actualiza un atributo de tarea existente, en primer lugar debe suprimir dicho atributomediante la función ChoreAttrDelete. Después puede utilizar ChoreAttrInsert para volver a crear elatributo con los cambios deseados.

Importante: Si intenta actualizar un atributo existente sin suprimirlo antes, la inserción falla sin generarun aviso ni un error. El atributo existente no cambia; ni se actualiza ni se sobrescribe.

Sintaxis

ChoreAttrInsert( PrevAttrName, NewAttrName, AttrType);

Capítulo 5. funciones de TurboIntegrator 231

Argumento Descripción

PrevAttrName El atributo que precede al atributo que estácreando. Si no hay ningún atributo anterior o deseaque el nuevo atributo sea el primer atributo paratareas, deje este argumento vacío.

NewAttrName El nombre que desea asignar al nuevo atributo detarea.

AttrType El tipo de atributo. Hay tres valores posibles parael argumento AttrType:

• N: crea un atributo numérico.• S: crea un atributo de cadena.• A: crea un atributo de alias.

Ejemplo

Este ejemplo crea el atributo de cadena Description para tareas. Este atributo se inserta después delatributo Owner.

ChoreAttrInsert('Owner', 'Description', 'S');

ChoreAttrNChoreAttrN devuelve un atributo numérico para un tarea especificada.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ChoreAttrN(ChoreName, AttrName);

Argumento Descripción

ChoreName Un nombre de tarea válido.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de latarea.

Ejemplo

En este ejemplo, la función devuelve el valor numérico del atributo Division_Code de la tarea Import.

ChoreAttrN('Import', 'Division_Code');

ChoreAttrNLChoreAttrNL devuelve el valor numérico de un atributo para una tarea especificada relacionada con unentorno local concreto.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

232 IBM Planning Analytics: Referencia de TM1

Sintaxis

ChoreAttrNL(ChoreName, AttrName, [LangLocaleCode]);

Argumento Descripción

ChoreName Un nombre de tarea válido.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de latarea.

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma para el que desea que sedevuelva un valor.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales listados en la dimensión de controlde contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, el entorno local actual delusuario se utiliza como argumento deLangLocaleCode.

Si no existe ningún valor de atributo paraLangLocaleCode, se devuelve el valor de unLangLocaleCode padre asociado. Si no existeningún valor de atributo para un LangLocaleCodepadre asociado, se devuelve el valor de atributobase.

Por ejemplo si LangLocaleCode es fr-CA, lafunción devuelve el valor de atributo del entornolocal fr-CA (Francés-Canadá), si está disponible.Si el valor de atributo de fr-CA no está disponible,la función intenta devolver el valor de atributo delentorno local fr (francés) padre. Si el valor deatributo de fr no está disponible, se devuelve elvalor de atributo base.

Ejemplo

En este ejemplo, la función devuelve el valor numérico del atributo Division_Code de la tarea Import parael entorno local francés.

ChoreAttrNL('Import', 'Division_Code', 'fr');

ChoreAttrPutNChoreAttrPutN asigna un valor a un atributo numérico de tarea.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ChoreAttrPutN(NumericValue, ChoreName, AttrName, [LangLocaleCode] );

Capítulo 5. funciones de TurboIntegrator 233

Argumento Descripción

NumericValue El valor que desea asignar a un atributo de tarea.

ChoreName La tarea a la que desea asignar un valor deatributo.

AttrName El atributo cuyo valor desea asignar.

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma al que se aplicaNumericValue.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales ISO 639-1 listados en la dimensióncontrol de contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, se actualiza el valor de atributobase.

Ejemplo

Este ejemplo asigna el valor 7161994 al atributo Division_Code de la tarea Import para el código deentorno local francés.

ChoreAttrPutN(7161994, 'Import', 'Division_Code','fr');

ChoreAttrPutSChoreAttrPutS asigna un valor a un atributo de cadena de tarea.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ChoreAttrPutS(String, ChoreName, AttrName, [LangLocaleCode] );

Argumento Descripción

String La cadena que desea asignar a un atributo detarea.

ChoreName La tarea a la que desea asignar un valor deatributo.

AttrName El atributo cuyo valor desea asignar.

234 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma al que se aplicaNumericValue.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales ISO 639-1 listados en la dimensióncontrol de contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, se actualiza el valor de atributobase.

Ejemplo

Este ejemplo asigna el valor de cadena Ricci al atributo Owner de la tarea Import para el código deentorno local francés.

ChoreAttrPutS('Ricci', 'Import', 'Owner', 'fr');

ChoreAttrSChoreAttrS devuelve un atributo de cadena para una tarea especificada.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ChoreAttrS(ChoreName, AttrName);

Argumento Descripción

ChoreName Un nombre de tarea válido.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de latarea.

Ejemplo

En este ejemplo, la función devuelve el valor de cadena del atributo Owner de la tareaExchange_Rate_Updates.

ChoreAttrS('Exchange_Rate_Updates', 'Owner');

ChoreAttrSLChoreAttrSL devuelve un valor de atributo de serie para una tarea especificada relacionada con unentorno local dado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ChoreAttrSL(ChoreName, AttrName, [LangLocaleCode]);

Capítulo 5. funciones de TurboIntegrator 235

Argumento Descripción

ChoreName Un nombre de tarea válido.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de latarea.

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma para el que desea que sedevuelva un valor.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales listados en la dimensión de controlde contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, el entorno local actual delusuario se utiliza como argumento deLangLocaleCode.

Si no existe ningún valor de atributo paraLangLocaleCode, se devuelve el valor de unLangLocaleCode padre asociado. Si no existeningún valor de atributo para un LangLocaleCodepadre asociado, se devuelve el valor de atributobase.

Por ejemplo, si LangLocaleCode es fr-CA, lafunción devuelve el valor de atributo del entornolocal fr-CA (Francés-Canadá), si está disponible.Si el valor de atributo de fr-CA no está disponible,la función intenta devolver el valor de atributo delentorno local fr (francés) padre. Si el valor deatributo de fr no está disponible, se devuelve elvalor de atributo base.

Ejemplo

En este ejemplo, la función devuelve el valor de cadena del atributo Owner del cuboDepreciate_Inventory para el entorno local francés.

ChoreAttrSL('Depreciate_Inventory', 'Owner', 'fr');

CreateHierarchyByAttributeCreateHierarchyByAttribute crea una simple jerarquía de nivel 3 a partir de un único atributo.

La nueva jerarquía consiste en un único elemento raíz de nivel alto, un nivel medio de consolidacionesque representan valores de atributo existentes y un nivel bajo de hojas de dimensión que incluyen el valordel atributo asociado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Nota: Esta función crea una jerarquía a partir del conjunto de valores de atributo actual, pero el sistemano conserva automáticamente la jerarquía en sincronización con los datos de atributo si éstos semodifican. Los modeladores deberán volver a generar la jerarquía cuando resulte necesario.

236 IBM Planning Analytics: Referencia de TM1

Sintaxis

CreateHierarchyByAttribute(DimName, AttrName [, emptyParent [, rootName ] ] );

Argumento Descripción

DimName Nombre de la dimensión que contiene el atributo.Se creará una jerarquía con el mismo nombre queel de la dimensión.

AttrName Nombre del atributo a partir del que crear lajerarquía.

emptyParent Especifica el nombre de una consolidación quedebe crearse, a fin de recopilar hojas de dimensiónque no tengan un valor de atributo. Si se pasacomo una cadena vacía, la función no creará unaconsolidación.

rootName Sustituye el nombre del elemento raíz que, deforma predeterminada, se denomina como elatributo.

Ejemplo

CreateHierarchyByAttribute ('Country', 'City');

Este ejemplo crea una jerarquía a partir del atributo City de la dimensión Country.

CubeAttrDeleteCubeAttrDelete suprime un atributo de cubo de la base de datos TM1.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeAttrDelete(AttrName);

Argumento Descripción

AttrName El nombre del atributo de cubo que desea suprimir.

Ejemplo

Este ejemplo suprime el atributo de descripción para cubos en el servidor TM1.

CubeAttrDelete('Description');

CubeAttrInsertCubeAttrInsert crea un atributo nuevo para cubos en el servidor TM1. Esta función puede crear unatributo de alias, numérico o de cadena.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Atención: Si actualiza un atributo de cubo existente, en primer lugar debe suprimir dicho atributomediante la función CubeAttrDelete. Después puede utilizar CubeAttrInsert para volver a crear elatributo con los cambios deseados.

Capítulo 5. funciones de TurboIntegrator 237

Importante: Si intenta actualizar un atributo existente sin suprimirlo antes, la inserción falla sin generarun aviso ni un error. El atributo existente no cambia; ni se actualiza ni se sobrescribe.

Sintaxis

CubeAttrInsert( PrevAttrName, NewAttrName, AttrType);

Argumento Descripción

PrevAttrName El atributo que precede al atributo que estácreando. Si no hay ningún atributo anterior o deseaque el nuevo atributo sea el primer atributo paralos cubos, deje este argumento vacío.

NewAttrName El nombre que desea asignar al nuevo atributo decubo.

AttrType El tipo de atributo. Hay tres valores posibles parael argumento AttrType:

• N: crea un atributo numérico.• S: crea un atributo de cadena.• A: crea un atributo de alias.

Ejemplo

Este ejemplo crea el atributo de cadena de descripción para cubos. Este atributo se inserta después delatributo de propietario.

CubeAttrInsert('Owner', 'Description', 'S');

CubeAttrPutNCubeAttrPutN asigna un valor a un atributo de cubo numérico.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeAttrPutN(NumericValue, CubeName, AttrName, [LangLocaleCode] );

Argumento Descripción

NumericValue El valor que desea asignar a un atributo de cubo.

CubeName El cubo para el que desea asignar un valor deatributo.

AttrName El atributo cuyo valor desea asignar.

238 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma al que se aplicaNumericValue.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales ISO 639-1 listados en la dimensióncontrol de contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, se actualiza el valor de atributobase.

Ejemplo

Este ejemplo asigna el valor 07161994 al atributo AccountingCode del cubo Ventas para el código deentorno local del idioma francés.

CubeAttrPutN(07161994, 'Sales', 'AccountingCode','fr');

CubeAttrPutSCubeAttrPutS asigna un valor a un atributo de cubo de cadena.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeAttrPutS(String, CubeName, AttrName, [LangLocaleCode] );

Argumento Descripción

String La cadena que desea asignar a un atributo de cubo.

CubeName El cubo para el que desea asignar un valor deatributo.

AttrName El atributo cuyo valor desea asignar.

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma al que se aplicaNumericValue.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales ISO 639-1 listados en la dimensióncontrol de contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, se actualiza el valor de atributobase.

Capítulo 5. funciones de TurboIntegrator 239

Ejemplo

Este ejemplo asigna el valor de cadena Prototype al atributo Description del cubo Ventas para el códigode entorno local del idioma francés.

CubeAttrPutS('Prototype', 'Sales', 'Description','fr');

CubeATTRNLCubeATTRNL devuelve un valor de atributo numérico para un cubo especificado respecto a un entornolocal dado.

Esta función es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeATTRNL(CubeName, AttrName, [LangLocaleCode]);

Argumento Descripción

CubeName Un nombre de cubo válido.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido delcubo.

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma para el que desea que sedevuelva un valor.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales listados en la dimensión de controlde contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, el entorno local actual delusuario se utiliza como argumento deLangLocaleCode.

Si no existe ningún valor de atributo paraLangLocaleCode, se devuelve el valor de unLangLocaleCode padre asociado. Si no existeningún valor de atributo para un LangLocaleCodepadre asociado, se devuelve el valor de atributobase.

Por ejemplo, si LangLocaleCode es fr-CA, lafunción devuelve el valor de atributo del entornolocal fr-CA (Francés-Canadá), si está disponible.Si el valor de atributo de fr-CA no está disponible,la función intenta devolver el valor de atributo delentorno local fr (francés) padre. Si el valor deatributo de fr no está disponible, se devuelve elvalor de atributo base.

240 IBM Planning Analytics: Referencia de TM1

Ejemplo

En este ejemplo, la función devuelve el valor numérico del atributo Accounting_Code del cubo Productpara el entorno local francés.

CubeATTRNL('Product', 'Accounting_Code', 'fr');

CubeATTRSLCubeATTRSL devuelve un valor de atributo de cadena para un cubo especificado respecto a un entornolocal dado.

Esta función es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeATTRSL(CubeName, AttrName, [LangLocaleCode]);

Argumento Descripción

CubeName Un nombre de cubo válido.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido delcubo.

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma para el que desea que sedevuelva un valor.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales listados en la dimensión de controlde contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, el entorno local actual delusuario se utiliza como argumento deLangLocaleCode.

Si no existe ningún valor de atributo paraLangLocaleCode, se devuelve el valor de unLangLocaleCode padre asociado. Si no existeningún valor de atributo para un LangLocaleCodepadre asociado, se devuelve el valor de atributobase.

Por ejemplo, si LangLocaleCode es fr-CA, lafunción devuelve el valor de atributo del entornolocal fr-CA (Francés-Canadá), si está disponible.Si el valor de atributo de fr-CA no está disponible,la función intenta devolver el valor de atributo delentorno local fr (francés) padre. Si el valor deatributo de fr no está disponible, se devuelve elvalor de atributo base.

Capítulo 5. funciones de TurboIntegrator 241

Ejemplo

En este ejemplo, la función devuelve el valor de cadena del atributo Owner del cubo Product para elentorno local francés.

CubeATTRSL('Product', 'Owner', 'fr');

DimensionAttrDeleteDimensionAttrDelete suprime un atributo de dimensión de la base de datos TM1.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DimensionAttrDelete(AttrName);

Argumento Descripción

AttrName El nombre del atributo de dimensión que deseasuprimir.

Ejemplo

Este ejemplo suprime el atributo de descripción para dimensiones en el servidor TM1.

DimensionAttrDelete('Description');

DimensionAttrInsertDimensionAttrInsert crea un atributo nuevo para dimensiones en el servidor TM1. Esta función puedecrear un atributo de alias, numérico o de cadena.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Atención: Si actualiza un atributo de dimensión existente, en primer lugar debe suprimir dichoatributo mediante la función DimensionAttrDelete. Después puede utilizar DimensionAttrInsertpara volver a crear el atributo con los cambios deseados.

Importante: Si intenta actualizar un atributo existente sin suprimirlo antes, la inserción falla sin generarun aviso ni un error. El atributo existente no cambia; ni se actualiza ni se sobrescribe.

Sintaxis

DimensionAttrInsert( PrevAttrName, NewAttrName, AttrType);

Argumento Descripción

PrevAttrName El atributo que precede al atributo que estácreando. Si no hay ningún atributo anterior o deseaque el nuevo atributo sea el primer atributo paralas dimensiones, deje este argumento vacío.

NewAttrName El nombre que desea asignar al nuevo atributo dedimensión.

242 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

AttrType El tipo de atributo. Hay tres valores posibles parael argumento AttrType:

• N: crea un atributo numérico.• S: crea un atributo de cadena.• A: crea un atributo de alias.

Ejemplo

Este ejemplo crea el atributo de cadena descripción para dimensiones. Dado que no hay ningúnparámetro PrevAttrName, este atributo se inserta como el primer atributo para dimensiones en elservidor TM1.

DimensionAttrInsert('', 'Description', 'S');

DimensionAttrPutNDimensionAttrPutN asigna un valor a un atributo de dimensión numérica.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DimensionAttrPutN(NumericValue, DimensionName, AttrName, [LocalLangCode] );

Argumento Descripción

NumericValue El valor que desea asignar a un atributo dedimensión.

DimensionName La dimensión para la que desea asignar un valor deatributo.

AttrName El atributo cuyo valor desea asignar.

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma al que se aplicaNumericValue.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales ISO 639-1 listados en la dimensiónde control de contextos culturales (Cultures).

Cuando no se especifica o se omiteLangLocaleCode, se actualiza el valor de atributobase.

Ejemplo

Este ejemplo asigna el valor 07161994 a un atributo AccountingCode de la dimensión de modelos para elcódigo de entorno local del idioma francés.

DimensionAttrPutN(07161994, 'Models', 'AccountingCode','fr');

Capítulo 5. funciones de TurboIntegrator 243

DimensionAttrPutSDimensionAttrPutS asigna un valor a un atributo de dimensión de cadena.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DimensionAttrPutS(String, DimensionName, AttrName, [LangLocaleCode] );

Argumento Descripción

String La cadena que desea asignar a un atributo dedimensión.

DimensionName La dimensión para la que desea asignar un valor deatributo.

AttrName El atributo cuyo valor desea asignar.

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma al que se aplicaNumericValue.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales ISO 639-1 listados en la dimensióncontrol de contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, se actualiza el valor de atributobase.

Ejemplo

Este ejemplo asigna el valor de cadena Prototype al atributo Description de la dimensión de modelo parael código de entorno local del idioma francés.

DimensionAttrPutS('Prototype', 'Model', 'Description','fr');

DimensionATTRNLDimensionATTRNL devuelve un valor de atributo numérico para una dimensión especificada respecto aun entorno local dado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DimensionATTRNL(DimName, AttrName, [LangLocaleCode]);

Argumento Descripción

DimName Un nombre de dimensión válido.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de ladimensión.

244 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma para el que desea que sedevuelva un valor.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales listados en la dimensión de controlde contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, el entorno local actual delusuario se utiliza como argumento deLangLocaleCode.

Si no existe ningún valor de atributo paraLangLocaleCode, se devuelve el valor de unLangLocaleCode padre asociado. Si no existeningún valor de atributo para un LangLocaleCodepadre asociado, se devuelve el valor de atributobase.

Por ejemplo, si LangLocaleCode es fr-CA, lafunción devuelve el valor de atributo del entornolocal fr-CA (Francés-Canadá), si está disponible.Si el valor de atributo de fr-CA no está disponible,la función intenta devolver el valor de atributo delentorno local fr (francés) padre. Si el valor deatributo de fr no está disponible, se devuelve elvalor de atributo base.

Ejemplo

En este ejemplo, la función devuelve el valor numérico del atributo Accounting_Code de la dimensiónPlan_Business_Unit para el entorno local francés.

DimensionATTRNL('Plan_Business_Unit', 'Accounting_Code', 'fr');

DimensionATTRSLDimensionATTRSL devuelve un valor de atributo de cadena para una dimensión especificada respecto aun entorno local dado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DimensionATTRSL(DimName, AttrName, [LangLocaleCode]);

Argumento Descripción

DimName Un nombre de dimensión válido.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de ladimensión.

Capítulo 5. funciones de TurboIntegrator 245

Argumento Descripción

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma para el que desea que sedevuelva un valor.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales listados en la dimensión de controlde contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, el entorno local actual delusuario se utiliza como argumento deLangLocaleCode.

Si no existe ningún valor de atributo paraLangLocaleCode, se devuelve el valor de unLangLocaleCode padre asociado. Si no existeningún valor de atributo para un LangLocaleCodepadre asociado, se devuelve el valor de atributobase.

Por ejemplo, si LangLocaleCode es fr-CA, lafunción devuelve el valor de atributo del entornolocal fr-CA (Francés-Canadá), si está disponible.Si el valor de atributo de fr-CA no está disponible,la función intenta devolver el valor de atributo delentorno local fr (francés) padre. Si el valor deatributo de fr no está disponible, se devuelve elvalor de atributo base.

Ejemplo

En este ejemplo, la función devuelve el valor de cadena del atributo Manager de la dimensiónPlan_Business_Unit para el entorno local francés.

DimensionATTRSL('Plan_Business_Unit', 'Manager', 'fr');

ElementATTRNLElementATTRNL devuelve un atributo numérico para un elemento especificado de una dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ElementATTRNL(DimName, HierName, ElName, AttrName, [LangLocaleCode]);

Argumento Descripción

DimName Un nombre de dimensión válido.

HierName Nombre de la jerarquía de la dimensión.

ElName Un elemento de la dimensión.

246 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido delelemento.

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma para el que desea que sedevuelva un valor.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales listados en la dimensión de controlde contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, el entorno local actual delusuario se utiliza como argumento deLangLocaleCode.

Si no existe ningún valor de atributo paraLangLocaleCode, se devuelve el valor de unLangLocaleCode padre asociado. Si no existeningún valor de atributo para un LangLocaleCodepadre asociado, se devuelve el valor de atributobase.

Por ejemplo, si LangLocaleCode es fr-CA, lafunción devuelve el valor de atributo del entornolocal fr-CA, si está disponible. Si el valor deatributo de fr-CA no está disponible, la funciónintenta devolver el valor de atributo del entornolocal fr padre. Si el valor de atributo de fr no estádisponible, se devuelve el valor de atributo base.

Ejemplo

En este ejemplo, la función devuelve el valor numérico del atributo Engine Size del elemento L Series 1.8LSedan de la dimensión Model del entorno local francés. Este ejemplo se aplica a la jerarquía 2015.

ATTRNL('Model', '2015', 'L Series 1.8L Sedan', 'Engine Size', 'fr');

ElementATTRSLElementATTRSL devuelve un atributo de cadena para un elemento especificado de una dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ElementATTRSL(DimName, HierName, ElName, AttrName, [LangLocaleCode]);

Argumento Descripción

DimName Un nombre de dimensión válido.

HierName Nombre de la jerarquía de la dimensión.

Capítulo 5. funciones de TurboIntegrator 247

Argumento Descripción

ElName Un elemento de la dimensión.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido delelemento.

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma para el que desea que sedevuelva un valor.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales listados en la dimensión de controlde contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, el entorno local actual delusuario se utiliza como argumento deLangLocaleCode.

Si no existe ningún valor de atributo paraLangLocaleCode, se devuelve el valor de unLangLocaleCode padre asociado. Si no existeningún valor de atributo para un LangLocaleCodepadre asociado, se devuelve el valor de atributobase.

Por ejemplo, si LangLocaleCode es fr-CA, lafunción devuelve el valor de atributo del entornolocal fr-CA, si está disponible. Si el valor deatributo de fr-CA no está disponible, la funciónintenta devolver el valor de atributo del entornolocal fr padre. Si el valor de atributo de fr no estádisponible, se devuelve el valor de atributo base.

Ejemplo

En este ejemplo, la función devuelve el valor de cadena del atributo Currency del elemento 10100 de ladimensión Plan_Business_Unit del entorno local francés.

ElementATTRSL('Plan_Business_Unit', '10100', 'Currency', 'fr');

ElementAttrPutNElementAttrPutN asigna un valor a un atributo de elemento numérico.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ElementAttrPutN( Value, DimName, HierName, ElName, AttrName, [LangLocaleCode] );

Argumento Descripción

Value El valor numérico que desea asignar a un atributode elemento.

248 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

DimName La dimensión padre del elemento al que deseaasignar un valor de atributo.

HierName Nombre de la jerarquía de la dimensión.

ElName El elemento al que desea asignar un valor deatributo.

AttrName El atributo cuyo valor desea asignar.

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma al que se aplicaNumericValue.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales ISO 639-1 listados en la dimensiónde control de contextos culturales (Cultures).

Cuando no se especifica o se omiteLangLocaleCode, se actualiza el valor de atributobase.

Ejemplo

Este ejemplo asigna el valor 2257993 al atributo ProdCode de S Series 1.8L Sedan de la jerarquíaAutomobile de la dimensión Model.

ElementAttrPutN(2257993, 'Model', 'Automobile', ' S Series 1.8L Sedan ','ProdCode');

ElementAttrPutSElementAttrPutS asigna un valor a un atributo de elemento de cadena.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ElementAttrPutS(Value, DimName, HierName, ElName, AttrName, [LangLocaleCode] );

Argumento Descripción

Value El valor que desea asignar a un atributo deelemento.

DimName La dimensión padre del elemento al que deseaasignar un valor de atributo.

HierName Nombre de la jerarquía de la dimensión.

ElName El elemento al que desea asignar un valor deatributo.

AttrName El atributo cuyo valor desea asignar.

Capítulo 5. funciones de TurboIntegrator 249

Argumento Descripción

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma al que se aplica el valor.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales listados en la dimensión de controlde contextos culturales (Cultures).

Cuando no se especifica o se omiteLangLocaleCode, se actualiza el valor de atributobase.

Ejemplo

Este ejemplo asigna la cadena Beige al atributo InteriorColor de S Series 1.8L Sedan de la jerarquíaAutomobile de la dimensión Model.

ElementAttrPutS('Beige', 'Model', 'Automobile', 'S Series 1.8L Sedan', 'InteriorColor');

ElementAttrInsertElementAttrInsert crea un atributo de elemento para una dimensión. Esta función puede crear un atributode alias, numérico o de cadena.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ElementAttrInsert(DimName, HierName, PrevAttr, AttrName, Type);

Argumento Descripción

DimName La dimensión para la que desea crear un atributode elemento.

HierName Nombre de la jerarquía de la dimensión.

PrevAttr El atributo que precede al atributo que estácreando.

AttrName El nombre que desea asignar al nuevo atributo.

Tipo El tipo de atributo. Existen tres posibles valorespara el argumento Type:

• N: crea un atributo numérico.• S: crea un atributo de cadena.• A: crea un atributo de alias.

Ejemplo

Este ejemplo crea el atributo de cadena InteriorColor en la jerarquía Automobile de la dimensión Model.Este atributo se inserta después del atributo Transmission.

ElementAttrInsert('Model', 'Automobile', 'Transmission', 'InteriorColor','S');

250 IBM Planning Analytics: Referencia de TM1

ElementAttrDeleteElementAttrDelete suprime un atributo de elemento de la base de datos de TM1.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ElementAttrDelete(DimName, HierName, AttrName);

Argumento Descripción

DimName La dimensión de la que desea eliminar un atributode elemento.

HierName Nombre de la jerarquía de la dimensión.

AttrName El nombre del atributo que desea eliminar.

Ejemplo

Este ejemplo suprime el atributo de elemento InteriorColor de la jerarquía Autombile de la dimensiónModel.

ElementAttrDelete('Model', 'Automobile', 'InteriorColor');

HierarchyAttrPutNHierarchyAttrPutN asigna un valor a un atributo numérico de una jerarquía especificada dentro de unadimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyAttrPutN(NumericValue, DimensionName, HierName, AttrName, [LocalLangCode] );

Argumento Descripción

NumericValue El valor que desea asignar a un atributo dedimensión.

DimensionName La dimensión para la que desea asignar un valor deatributo.

HierName Nombre de la jerarquía de la dimensión.

AttrName El atributo cuyo valor desea asignar.

Capítulo 5. funciones de TurboIntegrator 251

Argumento Descripción

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma al que se aplicaNumericValue.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales ISO 639-1 listados en la dimensiónde control de contextos culturales (Cultures).

Cuando no se especifica o se omiteLangLocaleCode, se actualiza el valor de atributobase.

Ejemplo

Este ejemplo asigna el valor 07161994 a un atributo AccountingCode de la dimensión de modelos para elcódigo de entorno local del idioma francés. Este cambio se aplica a la jerarquía Receivables en ladimensión Models.

HierarchyAttrPutN(07161994, 'Models', 'Receivables', 'AccountingCode','fr');

HierarchyAttrPutSHierarchyAttrPutS asigna un valor a un atributo de serie de una jerarquía especificada dentro de unadimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyAttrPutS(String, DimensionName, HierName, AttrName, [LangLocaleCode] );

Argumento Descripción

String La cadena que desea asignar a un atributo dedimensión.

DimensionName La dimensión para la que desea asignar un valor deatributo.

HierName Nombre de la jerarquía de la dimensión.

AttrName El atributo cuyo valor desea asignar.

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma al que se aplicaNumericValue.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales ISO 639-1 listados en la dimensióncontrol de contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, se actualiza el valor de atributobase.

252 IBM Planning Analytics: Referencia de TM1

Ejemplo

Este ejemplo asigna el valor de cadena Prototype al atributo Description de la dimensión de modelo parael código de entorno local del idioma francés. Este cambio se aplica a la jerarquía Receivables en ladimensión Model.

HierarchyAttrPutS('Prototype', 'Model', 'Receivables', 'Description','fr');

HierarchyATTRNHierarchyATTRN devuelve un atributo numérico para una jerarquía especificada dentro de una dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyATTRN(DimName, HierName, AttrName);

Argumento Descripción

DimName Un nombre de dimensión válido.

HierName Nombre de la jerarquía de la dimensión.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de ladimensión.

Ejemplo

En este ejemplo, la función devuelve el valor numérico del atributo Accounting_Code de la dimensiónPlan_Business_Unit. Este ejemplo se aplica a la jerarquía Equipment.

HierarchyATTRN('Plan_Business_Unit', 'Equipment', 'Accounting_Code');

HierarchyATTRSHierarchyATTRS devuelve un atributo de serie para una jerarquía especificada dentro de una dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyATTRS(DimName, AttrName);

Argumento Descripción

DimName Un nombre de dimensión válido.

HierName Nombre de la jerarquía de la dimensión.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de ladimensión.

Capítulo 5. funciones de TurboIntegrator 253

Ejemplo

En este ejemplo, la función devuelve el valor de cadena del atributo Manager de la dimensiónPlan_Business_Unit. Este ejemplo se aplica a la jerarquía Equipment.

HierarchyATTRS('Plan_Business_Unit', 'Equipment', 'Manager');

HierarchyATTRNLHierarchyATTRNL devuelve un valor de atributo numérico para una jerarquía especificada dentro de unadimensión respecto a un entorno local dado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyATTRNL(DimName, HierName, AttrName, [LangLocaleCode]);

Argumento Descripción

DimName Un nombre de dimensión válido.

HierName Nombre de la jerarquía de la dimensión.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de ladimensión.

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma para el que desea que sedevuelva un valor.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales listados en la dimensión de controlde contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, el entorno local actual delusuario se utiliza como argumento deLangLocaleCode.

Si no existe ningún valor de atributo paraLangLocaleCode, se devuelve el valor de unLangLocaleCode padre asociado. Si no existeningún valor de atributo para un LangLocaleCodepadre asociado, se devuelve el valor de atributobase.

Por ejemplo, si LangLocaleCode es fr-CA, lafunción devuelve el valor de atributo del entornolocal fr-CA (Francés-Canadá), si está disponible.Si el valor de atributo de fr-CA no está disponible,la función intenta devolver el valor de atributo delentorno local fr (francés) padre. Si el valor deatributo de fr no está disponible, se devuelve elvalor de atributo base.

254 IBM Planning Analytics: Referencia de TM1

Ejemplo

En este ejemplo, la función devuelve el valor numérico del atributo Accounting_Code de la dimensiónPlan_Business_Unit para el entorno local francés. Esta función se aplica a la jerarquía Equipment.

HierarchyATTRNL('Plan_Business_Unit', 'Equipment', 'Accounting_Code', 'fr');

HierarchyATTRSLHierarchyATTRSL devuelve un valor de atributo de serie para una jerarquía especificada dentro de unadimensión respecto a un entorno local dado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyATTRSL(DimName, HierName, AttrName, [LangLocaleCode]);

Argumento Descripción

DimName Un nombre de dimensión válido.

HierName Nombre de la jerarquía de la dimensión.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de ladimensión.

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma para el que desea que sedevuelva un valor.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales listados en la dimensión de controlde contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, el entorno local actual delusuario se utiliza como argumento deLangLocaleCode.

Si no existe ningún valor de atributo paraLangLocaleCode, se devuelve el valor de unLangLocaleCode padre asociado. Si no existeningún valor de atributo para un LangLocaleCodepadre asociado, se devuelve el valor de atributobase.

Por ejemplo, si LangLocaleCode es fr-CA, lafunción devuelve el valor de atributo del entornolocal fr-CA (Francés-Canadá), si está disponible.Si el valor de atributo de fr-CA no está disponible,la función intenta devolver el valor de atributo delentorno local fr (francés) padre. Si el valor deatributo de fr no está disponible, se devuelve elvalor de atributo base.

Capítulo 5. funciones de TurboIntegrator 255

Ejemplo

En este ejemplo, la función devuelve el valor de cadena del atributo Manager de la dimensiónPlan_Business_Unit para el entorno local francés. Esta función se aplica a la jerarquía Equipment.

HierarchyATTRSL('Plan_Business_Unit', 'Equipment', 'Manager', 'fr');

HierarchySubsetATTRSHierarchySubsetATTRS devuelve un atributo de serie para un subconjunto especificado asociado a unajerarquía de una dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchySubsetATTRS(DimName, HierName, SubName, AttrName);

Argumento Descripción

DimName Un nombre de dimensión válido.

HierName Nombre de una jerarquía de una dimensión.

SubName Nombre de un subconjunto de una dimensión.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de ladimensión.

Ejemplo

En este ejemplo, la función devuelve el valor de cadena del atributo Manager del subconjunto Sales de lajerarquía Europe de la dimensión Plan_Business_Unit.

HierarchySubsetATTRS('Plan_Business_Unit', 'Europe', 'Sales', 'Manager');

HierarchySubsetATTRNHierarchySubsetATTRN devuelve un atributo numérico para un subconjunto especificado asociado a unajerarquía de una dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchySubsetATTRN(DimName, HierName, SubName, AttrName);

Argumento Descripción

DimName Un nombre de dimensión válido.

HierName Nombre de una jerarquía de una dimensión.

SubName Nombre de un subconjunto de una dimensión.

256 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de ladimensión.

Ejemplo

En este ejemplo, la función devuelve el valor numérico del atributo Accounting_Code del subconjuntoSales de la jerarquía Europe de la dimensión Plan_Business_Unit.

HierarchySubsetATTRN('Plan_Business_Unit', 'Europe', 'Sales', 'Accounting_Code');

HierarchySubsetATTRSLHierarchySubsetATTRSL devuelve el valor de serie de un atributo para un subconjunto especificado (y elentorno local) asociado a una jerarquía de una dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchySubsetATTRSL(DimName, HierName, SubName, AttrName, [LangLocaleCode]);

Argumento Descripción

DimName Un nombre de dimensión válido.

HierName Nombre de una jerarquía de una dimensión.

SubName Nombre de un subconjunto de una dimensión.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de ladimensión.

Capítulo 5. funciones de TurboIntegrator 257

Argumento Descripción

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma para el que desea que sedevuelva un valor.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales listados en la dimensión de controlde contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, el entorno local actual delusuario se utiliza como argumento deLangLocaleCode.

Si no existe ningún valor de atributo paraLangLocaleCode, se devuelve el valor de unLangLocaleCode padre asociado. Si no existeningún valor de atributo para un LangLocaleCodepadre asociado, se devuelve el valor de atributobase.

Por ejemplo, si LangLocaleCode es fr-CA, lafunción devuelve el valor de atributo del entornolocal fr-CA (Francés-Canadá), si está disponible.Si el valor de atributo de fr-CA no está disponible,la función intenta devolver el valor de atributo delentorno local fr (francés) padre. Si el valor deatributo de fr no está disponible, se devuelve elvalor de atributo base.

Ejemplo

En este ejemplo, la función devuelve el valor de cadena del atributo Manager del subconjunto Sales (de lajerarquía Europe) para el entorno local francés.

HierarchySubsetATTRSL('Plan_Business_Unit', 'Europe', 'Sales', 'Manager', 'fr');

HierarchySubsetATTRNLHierarchySubsetATTRNL devuelve el valor numérico de un atributo para un subconjunto especificado (y elentorno local) asociado a una jerarquía de una dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchySubsetATTRNL(DimName, HierName, SubName, AttrName, [LangLocaleCode]);

Argumento Descripción

DimName Un nombre de dimensión válido.

HierName Nombre de una jerarquía de una dimensión.

SubName Nombre de un subconjunto de una dimensión.

258 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de ladimensión.

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma para el que desea que sedevuelva un valor.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales listados en la dimensión de controlde contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, el entorno local actual delusuario se utiliza como argumento deLangLocaleCode.

Si no existe ningún valor de atributo paraLangLocaleCode, se devuelve el valor de unLangLocaleCode padre asociado. Si no existeningún valor de atributo para un LangLocaleCodepadre asociado, se devuelve el valor de atributobase.

Por ejemplo, si LangLocaleCode es fr-CA, lafunción devuelve el valor de atributo del entornolocal fr-CA (Francés-Canadá), si está disponible.Si el valor de atributo de fr-CA no está disponible,la función intenta devolver el valor de atributo delentorno local fr (francés) padre. Si el valor deatributo de fr no está disponible, se devuelve elvalor de atributo base.

Ejemplo

En este ejemplo, la función devuelve el valor numérico del atributo Accounting_Code del subconjuntoSales (de la jerarquía Europe) para el entorno local francés.

HierarchySubsetATTRNL('Plan_Business_Unit', 'Europe', 'Sales', 'Accounting_Code', 'fr');

HierarchySubsetAttrPutSHierarchySubsetAttrPutS asigna un valor de serie a un atributo para un subconjunto especificadoasociado a una jerarquía de una dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchySubsetAttrPutS(String, DimName, HierName, SubName, AttrName, [LangLocaleCode] );

Argumento Descripción

String La cadena que desea asignar a un atributo dedimensión.

Capítulo 5. funciones de TurboIntegrator 259

Argumento Descripción

DimName La dimensión para la que desea asignar un valor deatributo.

HierName Nombre de una jerarquía de una dimensión.

SubName Nombre de un subconjunto de una dimensión.

AttrName El atributo cuyo valor desea asignar.

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma al que se aplicaNumericValue.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales ISO 639-1 listados en la dimensióncontrol de contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, se actualiza el valor de atributobase.

Ejemplo

Este ejemplo asigna el valor de cadena Prototype al atributo Description del subconjunto Z (de lasubconjunto 2016 de la dimensión Model) para el código de entorno local del idioma francés.

HierarchySubsetAttrPutS('Prototype', 'Model', '2016', 'Z', 'Description','fr');

HierarchySubsetAttrPutNHierarchySubsetAttrPutN asigna un valor numérico a un atributo para un subconjunto especificadoasociado a una jerarquía de una dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchySubsetAttrPutN(NumericValue, DimName, HierName, SubName, AttrName, [LocalLangCode] );

Argumento Descripción

NumericValue El valor que desea asignar a un atributo dedimensión.

DimName La dimensión para la que desea asignar un valor deatributo.

HierName Nombre de una jerarquía de una dimensión.

SubName Nombre de un subconjunto de una dimensión.

AttrName El atributo cuyo valor desea asignar.

260 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma al que se aplicaNumericValue.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales ISO 639-1 listados en la dimensiónde control de contextos culturales (Cultures).

Cuando no se especifica o se omiteLangLocaleCode, se actualiza el valor de atributobase.

Ejemplo

Este ejemplo asigna el valor 07161994 al atributo AccountingCode del subconjunto Z (de la jerarquía2016 de la dimensión Models) para el código de entorno local del idioma francés.

HierarchySubsetAttrPutN(07161994, 'Models', '2016', 'Z', 'AccountingCode','fr');

HierarchySubsetAttrInsertHierarchySubsetAttrInsert crea un nuevo atributo para los subconjuntos en el servidor de TM1. Estafunción crea un atributo de alias, numérico o de cadena.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

Atención: Si actualiza un atributo de subconjunto existente, en primer lugar debe suprimir dichoatributo mediante la función HierarchySubsetAttrDelete. Después puede utilizarHierarchySubsetAttrInsert para volver a crear el atributo con los cambios deseados.

Importante: Si intenta actualizar un atributo existente sin suprimirlo antes, la inserción falla sin generarun aviso ni un error. El atributo existente no cambia; ni se actualiza ni se sobrescribe.

HierarchySubsetAttrInsert( Dimension, Hierarchy, PrevAttrName, NewAttrName, AttrType);

Argumento Descripción

Dimensión Nombre de la dimensión cuyos subconjuntos sevan a actualizar.

Jerarquía Nombre de una jerarquía de una dimensión.

PrevAttrName El atributo que precede al atributo que estácreando. Si no hay ningún atributo anterior o deseaque el nuevo atributo sea el primer atributo paralos subconjuntos, deje este argumento vacío.

NewAttrName El nombre que desea asignar al nuevo atributo desubconjunto.

Capítulo 5. funciones de TurboIntegrator 261

Argumento Descripción

AttrType El tipo de atributo. Hay tres valores posibles parael argumento AttrType:

• N: crea un atributo numérico.• S: crea un atributo de cadena.• A: crea un atributo de alias.

Ejemplo

Este ejemplo crea el atributo de cadena Description para los subconjuntos de la jerarquía Z de ladimensión Model. Dado que no hay ningún parámetro PrevAttrName, este atributo se inserta como elprimer atributo para subconjuntos en el servidor de TM1.

HierarchySubsetAttrInsert('Model', 'Z', '', 'Description', 'S');

HierarchySubsetAttrDeleteHierarchySubsetAttrDelete suprime un atributo de subconjunto de la base de datos de TM1.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchySubsetAttrDelete(Dimension, Hierarchy, AttrName);

Argumento Descripción

Dimensión Nombre de la dimensión cuyos atributos desubconjunto se van a suprimir.

Jerarquía Nombre de una jerarquía de una dimensión.

AttrName El nombre del atributo de dimensión que deseasuprimir.

Ejemplo

Este ejemplo suprime el atributo Description para los subconjuntos de la jerarquía Z de la dimensiónModel.

HierarchySubsetAttrDelete('Model', 'Z, 'Description');

ProcessAttrDeleteProcessAttrDelete suprime un atributo de la base de TM1.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ProcessAttrDelete(AttrName);

262 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

AttrName El nombre del atributo de proceso que deseaeliminar.

Ejemplo

Este ejemplo suprime el atributo Description para procesos de su servidor TM1.

ProcessAttrDelete('Description');

ProcessAttrInsertProcessAttrInsert crea un atributo nuevo para procesos en TM1 Server. Esta función puede crear unatributo de alias, numérico o de cadena.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Atención: Si actualiza un atributo de proceso existente, en primer lugar debe suprimir dichoatributo mediante la función ProcessAttrDelete. Después puede utilizar ProcessAttrInsert paravolver a crear el atributo con los cambios deseados.

Importante: Si intenta actualizar un atributo existente sin suprimirlo antes, la inserción falla sin generarun aviso ni un error. El atributo existente no cambia; ni se actualiza ni se sobrescribe.

Sintaxis

ProcessAttrInsert( PrevAttrName, NewAttrName, AttrType);

Argumento Descripción

PrevAttrName El atributo que precede al atributo que estácreando. Si no hay ningún atributo anterior o deseaque el nuevo atributo sea el primer atributo paraprocesos, deje este argumento vacío.

NewAttrName El nombre que desea asignar al nuevo atributo deproceso.

AttrType El tipo de atributo. Hay tres valores posibles parael argumento AttrType:

• N: crea un atributo numérico.• S: crea un atributo de cadena.• A: crea un atributo de alias.

Ejemplo

Este ejemplo crea el atributo de cadena Description para procesos. Este atributo se inserta después delatributo Owner.

ProcessAttrInsert('Owner', 'Description', 'S');

ProcessAttrNProcessAttrN devuelve un atributo numérico para un proceso especificado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Capítulo 5. funciones de TurboIntegrator 263

Sintaxis

ProcessAttrN(ProcessName, AttrName);

Argumento Descripción

ProcessName Un nombre de proceso válido.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido delproceso.

Ejemplo

En este ejemplo, la función devuelve el valor numérico del atributo Store_Code del proceso Daily_Sales.

ProcessAttrN('Daily_Sales', 'Store_Code');

ProcessAttrNLProcessAttrNL devuelve el valor numérico de un atributo para un proceso especificado relacionado con unentorno local concreto.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ProcessAttrNL(ProcessName, AttrName, [LangLocaleCode]);

Argumento Descripción

ProcessName Un nombre de proceso válido.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido delproceso.

264 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma para el que desea que sedevuelva un valor.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales listados en la dimensión de controlde contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, el entorno local actual delusuario se utiliza como argumento deLangLocaleCode.

Si no existe ningún valor de atributo paraLangLocaleCode, se devuelve el valor de unLangLocaleCode padre asociado. Si no existeningún valor de atributo para un LangLocaleCodepadre asociado, se devuelve el valor de atributobase.

Por ejemplo, si LangLocaleCode es fr-CA, lafunción devuelve el valor de atributo del entornolocal fr-CA (Francés-Canadá), si está disponible.Si el valor de atributo de fr-CA no está disponible,la función intenta devolver el valor de atributo delentorno local fr (francés) padre. Si el valor deatributo de fr no está disponible, se devuelve elvalor de atributo base.

Ejemplo

En este ejemplo, la función devuelve el valor numérico del atributo Store_Code de la tarea Daily_Salespara el entorno local francés.

ProcessAttrNL('Daily_Sales', 'Store_Code', 'fr');

ProcessAttrPutNProcessAttrPutN asigna un valor a un atributo de proceso numérico.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ProcessAttrPutN(NumericValue, CubeName, AttrName, [LangLocaleCode] );

Argumento Descripción

NumericValue El valor que desea asignar a un atributo deproceso.

ProcessName El proceso al que desea asignar un valor deatributo.

AttrName El atributo cuyo valor desea asignar.

Capítulo 5. funciones de TurboIntegrator 265

Argumento Descripción

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma al que se aplicaNumericValue.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales ISO 639-1 listados en la dimensióncontrol de contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, se actualiza el valor de atributobase.

Ejemplo

Este ejemplo asigna el valor 8051997 al atributo Store_Code del proceso Daily_Sales para el código deentorno local francés.

ProcessAttrPutN(8051997, 'Daily_Sales', 'Store_Code','fr');

ProcessAttrPutSProcessAttrPutS asigna un valor a un atributo de proceso de cadena.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ProcessAttrPutS(String, ProcessName, AttrName, [LangLocaleCode] );

Argumento Descripción

String La cadena que desea asignar a un atributo deproceso.

ProcessName El proceso al que desea asignar un valor deatributo.

AttrName El atributo cuyo valor desea asignar.

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma al que se aplicaNumericValue.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales ISO 639-1 listados en la dimensióncontrol de contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, se actualiza el valor de atributobase.

266 IBM Planning Analytics: Referencia de TM1

Ejemplo

Este ejemplo asigna el valor de cadena Ricci al atributo Owner del proceso Import_Transactional para elcódigo de entorno local francés.

ProcessAttrPutS('Ricci', 'Import_transactional', 'Owner', 'fr');

ProcessAttrSProcessAttrS devuelve un atributo cadena para un proceso especificado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ProcessAttrS(ProcessName, AttrName);

Argumento Descripción

ProcessName Un nombre de proceso válido.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido delproceso.

Ejemplo

En este ejemplo, la función devuelve el valor de cadena del atributo Owner del proceso Refresh_Cubes.

ProcessAttrS('Refresh_Cubes', 'Owner');

ProcessAttrSLProcessAttrSL devuelve un valor de atributo de cadena para un proceso especificado relacionado con unentorno local dado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ProcessAttrSL(ProcessName, AttrName, [LangLocaleCode]);

Argumento Descripción

ProcessName Un nombre de proceso válido.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido delproceso.

Capítulo 5. funciones de TurboIntegrator 267

Argumento Descripción

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma para el que desea que sedevuelva un valor.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales listados en la dimensión de controlde contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, el entorno local actual delusuario se utiliza como argumento deLangLocaleCode.

Si no existe ningún valor de atributo paraLangLocaleCode, se devuelve el valor de unLangLocaleCode padre asociado. Si no existeningún valor de atributo para un LangLocaleCodepadre asociado, se devuelve el valor de atributobase.

Por ejemplo, si LangLocaleCode es fr-CA, lafunción devuelve el valor de atributo del entornolocal fr-CA (Francés-Canadá), si está disponible.Si el valor de atributo de fr-CA no está disponible,la función intenta devolver el valor de atributo delentorno local fr (francés) padre. Si el valor deatributo de fr no está disponible, se devuelve elvalor de atributo base.

Ejemplo

En este ejemplo, la función devuelve el valor de cadena del atributo Owner del procesoExchange_Rate_Update para el entorno local French-Canada.

ProcessAttrSL('Exchange_Rate_Update', 'Owner', 'fr-CA');

SubsetATTRSSubsetATTRS devuelve un atributo de cadena para un subconjunto especificado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SubsetATTRS(DimName, SubName, AttrName);

Argumento Descripción

DimName Un nombre de dimensión válido.

SubName Nombre de un subconjunto de una dimensión.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de ladimensión.

268 IBM Planning Analytics: Referencia de TM1

Ejemplo

En este ejemplo, la función devuelve el valor de cadena del atributo Manager del subconjunto Sales de ladimensión Plan_Business_Unit.

SubsetATTRS('Plan_Business_Unit', 'Sales', 'Manager');

SubsetATTRNSubsetATTRN devuelve un atributo numérico para un subconjunto especificado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SubsetATTRN(DimName, SubName, AttrName);

Argumento Descripción

DimName Un nombre de dimensión válido.

SubName Nombre de un subconjunto de una dimensión.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de ladimensión.

Ejemplo

En este ejemplo, la función devuelve el valor numérico del atributo Accounting_Code del subconjuntoSales de la dimensión Plan_Business_Unit.

SubsetATTRN('Plan_Business_Unit', 'Sales', 'Accounting_Code');

SubsetATTRSLSubsetATTRSL devuelve el valor de cadena de un atributo para un subconjunto especificado respecto aun entorno local dado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SubsetATTRSL(DimName, SubName, AttrName, [LangLocaleCode]);

Argumento Descripción

DimName Un nombre de dimensión válido.

SubName Nombre de un subconjunto de una dimensión.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de ladimensión.

Capítulo 5. funciones de TurboIntegrator 269

Argumento Descripción

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma para el que desea que sedevuelva un valor.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales listados en la dimensión de controlde contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, el entorno local actual delusuario se utiliza como argumento deLangLocaleCode.

Si no existe ningún valor de atributo paraLangLocaleCode, se devuelve el valor de unLangLocaleCode padre asociado. Si no existeningún valor de atributo para un LangLocaleCodepadre asociado, se devuelve el valor de atributobase.

Por ejemplo, si LangLocaleCode es fr-CA, lafunción devuelve el valor de atributo del entornolocal fr-CA (Francés-Canadá), si está disponible.Si el valor de atributo de fr-CA no está disponible,la función intenta devolver el valor de atributo delentorno local fr (francés) padre. Si el valor deatributo de fr no está disponible, se devuelve elvalor de atributo base.

Ejemplo

En este ejemplo, la función devuelve el valor de cadena del atributo Manager del subconjunto Sales parael entorno local francés.

SubsetATTRSL('Plan_Business_Unit', 'Sales', 'Manager', 'fr');

SubsetATTRNLSubsetATTRNL devuelve el valor numérico de un atributo para un subconjunto especificado respecto a unentorno local dado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SubsetATTRNL(DimName, SubName, AttrName, [LangLocaleCode]);

Argumento Descripción

DimName Un nombre de dimensión válido.

SubName Nombre de un subconjunto de una dimensión.

270 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de ladimensión.

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma para el que desea que sedevuelva un valor.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales listados en la dimensión de controlde contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, el entorno local actual delusuario se utiliza como argumento deLangLocaleCode.

Si no existe ningún valor de atributo paraLangLocaleCode, se devuelve el valor de unLangLocaleCode padre asociado. Si no existeningún valor de atributo para un LangLocaleCodepadre asociado, se devuelve el valor de atributobase.

Por ejemplo, si LangLocaleCode es fr-CA, lafunción devuelve el valor de atributo del entornolocal fr-CA (Francés-Canadá), si está disponible.Si el valor de atributo de fr-CA no está disponible,la función intenta devolver el valor de atributo delentorno local fr (francés) padre. Si el valor deatributo de fr no está disponible, se devuelve elvalor de atributo base.

Ejemplo

En este ejemplo, la función devuelve el valor numérico del atributo Accounting_Code del subconjuntoSales para el entorno local francés.

SubsetATTRNL('Plan_Business_Unit', 'Sales', 'Accounting_Code', 'fr');

SubsetAttrPutSSubsetAttrPutS asigna un valor de cadena a un atributo para un subconjunto especificado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SubsetAttrPutS(String, DimensionName, SubName, AttrName, [LangLocaleCode] );

Argumento Descripción

String La cadena que desea asignar a un atributo dedimensión.

Capítulo 5. funciones de TurboIntegrator 271

Argumento Descripción

DimensionName La dimensión para la que desea asignar un valor deatributo.

SubName Nombre de un subconjunto de una dimensión.

AttrName El atributo cuyo valor desea asignar.

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma al que se aplicaNumericValue.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales ISO 639-1 listados en la dimensióncontrol de contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, se actualiza el valor de atributobase.

Ejemplo

Este ejemplo asigna el valor de cadena Prototype al atributo Description del subconjunto Z (de ladimensión Model) para el código de entorno local del idioma francés.

SubsetAttrPutS('Prototype', 'Model', 'Z', 'Description','fr');

SubsetAttrPutNSubsetAttrPutN asigna un valor numérico a un atributo para un subconjunto especificado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SubsetAttrPutN(NumericValue, DimensionName, SubName, AttrName, [LocalLangCode] );

Argumento Descripción

NumericValue El valor que desea asignar a un atributo dedimensión.

DimensionName La dimensión para la que desea asignar un valor deatributo.

SubName Nombre de un subconjunto de una dimensión.

AttrName El atributo cuyo valor desea asignar.

272 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma al que se aplicaNumericValue.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales ISO 639-1 listados en la dimensiónde control de contextos culturales (Cultures).

Cuando no se especifica o se omiteLangLocaleCode, se actualiza el valor de atributobase.

Ejemplo

Este ejemplo asigna el valor 07161994 al atributo AccountingCode del subconjunto Z (de la dimensiónModels) para el código de entorno local del idioma francés.

SubsetAttrPutN(07161994, 'Models', 'Z', 'AccountingCode','fr');

SubsetAttrInsertSubsetAttrInsert crea un atributo nuevo para subconjuntos en el servidor de TM1. Esta función crea unatributo de alias, numérico o de cadena.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Atención: Si actualiza un atributo de subconjunto existente, en primer lugar debe suprimir dichoatributo mediante la función SubsetAttrDelete. Después puede utilizar SubsetAttrInsert paravolver a crear el atributo con los cambios deseados.

Importante: Si intenta actualizar un atributo existente sin suprimirlo antes, la inserción falla sin generarun aviso ni un error. El atributo existente no cambia; ni se actualiza ni se sobrescribe.

Sintaxis

SubsetAttrInsert( Dimension, PrevAttrName, NewAttrName, AttrType);

Argumento Descripción

Dimensión Nombre de la dimensión cuyos subconjuntos sevan a actualizar.

PrevAttrName El atributo que precede al atributo que estácreando. Si no hay ningún atributo anterior o deseaque el nuevo atributo sea el primer atributo paralos subconjuntos, deje este argumento vacío.

NewAttrName El nombre que desea asignar al nuevo atributo desubconjunto.

Capítulo 5. funciones de TurboIntegrator 273

Argumento Descripción

AttrType El tipo de atributo. Hay tres valores posibles parael argumento AttrType:

• N: crea un atributo numérico.• S: crea un atributo de cadena.• A: crea un atributo de alias.

Ejemplo

Este ejemplo crea el atributo de cadena Description para los subconjuntos de la dimensión Model. Dadoque no hay ningún parámetro PrevAttrName, este atributo se inserta como el primer atributo parasubconjuntos en el servidor de TM1.

SubsetAttrInsert('Model', '', 'Description', 'S');

SubsetAttrDeleteSubsetAttrDelete suprime un atributo de subconjunto de la base de datos de TM1.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SubsetAttrDelete(Dimension, AttrName);

Argumento Descripción

Dimensión Nombre de la dimensión cuyos atributos desubconjunto se van a suprimir.

AttrName El nombre del atributo de dimensión que deseasuprimir.

Ejemplo

Este ejemplo suprime el atributo Description para los subconjuntos de la dimensión Model.

SubsetAttrDelete('Model', 'Description');

ViewAttrDeleteViewAttrDelete suprime un atributo de vista para un cubo específico de la base de datos TM1.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewAttrDelete(CubeName, AttrName);

Argumento Descripción

CubeName El nombre del cubo cuyo atributo de vista se va asuprimir.

274 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

AttrName El nombre del atributo de vista que desea eliminar.

Ejemplo

Este ejemplo suprime el atributo Description para vistas del cubo Sales de su servidor TM1.

ViewAttrDelete('Sales', 'Description');

ViewAttrInsertViewAttrInsert crea un atributo nuevo para vistas de un cubo específico en el servidor TM1. Esta funciónpuede crear un atributo de alias, numérico o de cadena.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Atención: Si actualiza un atributo de vista existente, en primer lugar debe suprimir dicho atributomediante la función ViewAttrDelete. Después puede utilizar ViewAttrInsert para volver a crear elatributo con los cambios deseados.

Importante: Si intenta actualizar un atributo existente sin suprimirlo antes, la inserción falla sin generarun aviso ni un error. El atributo existente no cambia; ni se actualiza ni se sobrescribe.

Sintaxis

ViewAttrInsert( CubeName, PrevAttrName, NewAttrName, AttrType);

Argumento Descripción

CubeName El cubo padre al que desea asignar un atributo devista.

PrevAttrName El atributo que precede al atributo que estácreando. Si no hay ningún atributo anterior o deseaque el nuevo atributo sea el primer atributo paravistas, deje este argumento vacío.

NewAttrName El nombre que desea asignar al nuevo atributo devista.

AttrType El tipo de atributo. Hay tres valores posibles parael argumento AttrType:

• N: crea un atributo numérico.• S: crea un atributo de cadena.• A: crea un atributo de alias.

Ejemplo

Este ejemplo crea el atributo de cadena Description para vistas del cubo Sales. Este atributo se insertadespués del atributo de propietario.

ViewAttrInsert('Sales', 'Owner', 'Description', 'S');

ViewAttrNViewAttrN devuelve un atributo numérico para una vista especificada.

Capítulo 5. funciones de TurboIntegrator 275

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewAttrN(CubeName, ViewName, AttrName);

Argumento Descripción

CubeName Un nombre de cubo válido.

ViewName Un nombre de vista válido.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de lavista.

Ejemplo

En este ejemplo, la función devuelve el valor numérico del atributo Category_Code de la vista Product delcubo Sales.

ViewAattrN('Sales', 'Product', 'Category_Code');

ViewAttrNLViewAttrNL devuelve el valor numérico de un atributo para una vista especificada relacionada con unentorno local concreto.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewAttrNL(CubeName, ViewName, AttrName, [LangLocaleCode]);

Argumento Descripción

CubeName El cubo padre de la vista cuyo valor de atributodesea recuperar.

ViewName Un nombre de vista válido.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de lavista.

276 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma para el que desea que sedevuelva un valor.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales listados en la dimensión de controlde contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, el entorno local actual delusuario se utiliza como argumento deLangLocaleCode.

Si no existe ningún valor de atributo paraLangLocaleCode, se devuelve el valor de unLangLocaleCode padre asociado. Si no existeningún valor de atributo para un LangLocaleCodepadre asociado, se devuelve el valor de atributobase.

Por ejemplo, si LangLocaleCode es fr-CA, lafunción devuelve el valor de atributo del entornolocal fr-CA (Francés-Canadá), si está disponible.Si el valor de atributo de fr-CA no está disponible,la función intenta devolver el valor de atributo delentorno local fr (francés) padre. Si el valor deatributo de fr no está disponible, se devuelve elvalor de atributo base.

Ejemplo

En este ejemplo, la función devuelve el valor numérico del atributo Category_Code de la vista Product delcubo Sales para el entorno local francés.

ViewAttrNL('Sales', 'Product', 'Category_Code', 'fr');

ViewAttrPutNViewAttrPutN asigna un valor a un atributo de vista numérico.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewAttrPutN(NumericValue, CubeName, ViewName, AttrName, [LangLocaleCode] );

Argumento Descripción

NumericValue El valor que desea asignar a un atributo de vista.

CubeName El cubo padre de la vista a la que desea asignar unvalor de atributo.

ViewName La vista a la que desea asignar un valor de atributo.

Capítulo 5. funciones de TurboIntegrator 277

Argumento Descripción

AttrName El atributo cuyo valor desea asignar.

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma al que se aplicaNumericValue.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales ISO 639-1 listados en la dimensióncontrol de contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, se actualiza el valor de atributobase.

Ejemplo

Este ejemplo asigna el valor 8222001 al atributo Category_Code de la vista Product del cubo Sales, parael código de entorno local francés.

ViewAttrPutN(8222001, 'Sales', 'Product', 'Category_Code','fr');

ViewAttrPutSViewAttrPutS asigna un valor de cadena a un atributo para una vista especificada.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewAttrPutS(String, CubeName, ViewName, AttrName, [LangLocaleCode] );

Argumento Descripción

String La cadena que desea asignar a un atributo de vista.

CubeName El cubo padre de la vista a la que desea asignar unvalor de atributo.

ViewName El nombre de la vista a la que desea asignar unvalor de atributo.

AttrName El atributo cuyo valor desea asignar.

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma al que se aplicaNumericValue.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales ISO 639-1 listados en la dimensióncontrol de contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, se actualiza el valor de atributobase.

278 IBM Planning Analytics: Referencia de TM1

Ejemplo

Este ejemplo asigna el valor Rocheford al atributo Owner de la vista Individual_Stores del cubo Sales,para el código de entorno local francés.

ViewAttrPutS('Rocheford', 'Sales', 'Individual_Stores', 'Owner','fr');

ViewAttrSViewAttrS devuelve un atributo cadena para una vista especificada.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewAttrS(CubeName, ViewName, AttrName);

Argumento Descripción

CubeName El cubo padre de la vista para el que desea que sedevuelva un valor de atributo.

ViewName La vista para la que desea que se devuelva un valorde atributo.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de lavista.

Ejemplo

ViewAttrS('Plan_Business_Unit', 'Sales', 'Manager');

En este ejemplo, la función devuelve el valor de cadena del atributo Manager de la vista Sales del cuboPlan_Business_Unit.

ViewAttrSLViewAttrSL devuelve el valor de cadena de un atributo para una vista especificada relacionada con unentorno local concreto.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewAttrSL(CubeName, ViewName, AttrName, [LangLocaleCode]);

Argumento Descripción

CubeName El cubo padre de la vista para la que desea que sedevuelva un valor de atributo.

ViewName La vista para la que desea que se devuelva un valorde atributo.

AttrName El atributo para el que desea recuperar un valor.Este argumento debe ser un atributo válido de lavista.

Capítulo 5. funciones de TurboIntegrator 279

Argumento Descripción

LangLocaleCode Este parámetro opcional especifica el código deentorno local de idioma para el que desea que sedevuelva un valor.

Los valores de LangLocaleCode válidoscorresponden a los códigos de idiomainternacionales listados en la dimensión de controlde contextos culturales (}Cultures).

Cuando no se especifica o se omiteLangLocaleCode, el entorno local actual delusuario se utiliza como argumento deLangLocaleCode.

Si no existe ningún valor de atributo paraLangLocaleCode, se devuelve el valor de unLangLocaleCode padre asociado. Si no existeningún valor de atributo para un LangLocaleCodepadre asociado, se devuelve el valor de atributobase.

Por ejemplo, si LangLocaleCode es fr-CA, lafunción devuelve el valor de atributo del entornolocal fr-CA (Francés-Canadá), si está disponible.Si el valor de atributo de fr-CA no está disponible,la función intenta devolver el valor de atributo delentorno local fr (francés) padre. Si el valor deatributo de fr no está disponible, se devuelve elvalor de atributo base.

Ejemplo

En este ejemplo, la función devuelve el valor de cadena del atributo Manager de la vista Sales del cuboPlan_Business_Unit para el entorno local French-Canada.

ViewAttrSL('Plan_Business_Unit', 'Sales', 'Manager', 'fr-CA');

Funciones de TurboIntegrator de gestión de tareasEstas funciones pertenecen a la gestión de tareas.

ChoreErrorChoreError causa la terminación inmediata de la tarea. Puede llamarse desde cualquier proceso de unatarea. La función de TurboIntegrator ChoreError causa una finalización inmediata de una tarea individual.Las tareas finalizadas con esta función se marcan con un estado de error.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ChoreError;

Argumentos

Ninguno.

280 IBM Planning Analytics: Referencia de TM1

ChoreQuitChoreQuit causa la terminación inmediata de la tarea. Puede llamarse desde cualquier proceso de unatarea. La tarea actual finalizará con un estado de error y se escribirá un mensaje en el archivo de registrodel servidor indicando que se ha invocado ChoreQuit para finalizar la tarea.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ChoreQuit;

Argumentos

Ninguno.

ChoreRollbackChoreRollback inicia la retrotracción de una tarea. Cuando se utiliza en un proceso de TurboIntegrator,esta función desecha todas las ediciones pendientes y cancela cualquier proceso adicional. Se muestraun mensaje de error en los archivos tm1server.log y tm1processorerrorXXX.log.

Cuando se utiliza en una tarea de modalidad de confirmación única, ChoreRollback desecha todas lasediciones pendientes de todos los procesos anteriores y detiene la ejecución de tareas con un código deerror. Cuando se utiliza en una tarea de modalidad de confirmación múltiple, ChoreRollback desechatodas las ediciones pendientes del proceso actual y detiene la ejecución de las tareas con un código deerror. Los cambios que ya se han confirmado no se pueden retrotraer.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ChoreRollback;

Argumentos

Ninguno.

SetChoreVerboseMessagesSetChoreVerboseMessages se utiliza para activar (o desactivar) el envío de mensajes con informes másdetallados al archivo Tm1s.log. Puede utilizar esta función para depurar tareas en las que varios procesosse invocan entre sí con la función ExecuteProcess.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SetChoreVerboseMessages(Flag);

Pasar un valor cero desactiva la salida de estos mensajes; pasar un valor distinto de cero permite la salidade mensajes más detallados. De forma predeterminada, este distintivo está desactivado.

Utilice esta función para activar (o desactivar) el envío de mensajes con informes más detallados alarchivo Tm1s.log. Esta función es especialmente útil en las tareas de depuración en las que variosprocesos se llaman entre sí mediante el uso de la función ExecuteProcess.

Pasar un valor cero desactiva la salida de estos mensajes; pasar un valor distinto de cero permite la salidade mensajes más detallados. De forma predeterminada, este distintivo está desactivado.

Capítulo 5. funciones de TurboIntegrator 281

Argumento Descripción

Flag Seleccione un valor que no sea cero para activarmensajes más detallados. Seleccione cero (valorpredeterminado) para desactivar los mensajesdetallados.

Funciones de TurboIntegrator de manipulación de cubosEstas funciones pertenecen a la manipulación de cubos.

AddCubeDependencyAddCubeDependency permite predefinir dependencias entre cubos para evitar problemas de bloqueodurante el uso normal del sistema.

Durante el funcionamiento normal, las dependencias entre cubos se establecen cuando se recuperan losdatos que traspasan los límites del cubo (tales como los datos que proceden de una regla que hacereferencia a un cubo externo). Para crear la información de dependencia, el servidor debe bloquear loscubos mientras se establece la dependencia, manteniendo el bloqueo probablemente durante unproceso de cálculo de vistas de larga duración. Dado que es un bloqueo de 'escritura', los demás usuariosno podrán acceder a los cubos. La función AddCubeDependency permite establecer la dependencia aliniciarse el servidor, evitando así que deban establecerse posteriormente nuevos bloqueos.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

AddCubeDependency(BaseCube, DependentCube);

Argumento Descripción

BaseCube Nombre del cubo del que dependeDependentCube.

DependentCube Nombre de un cubo que depende de otro cubo(BaseCube) para los datos. Con mayor frecuencia,se tratará de un cubo que utiliza reglas paraextraer datos de un cubo externo.

Ejemplo

Presuponga un cubo con el nombre 'SalesCube' que incluye la regla ['net']=!Units *DB('PriceCube', ... );

En este ejemplo, 'SalesCube' es el cubo dependiente, ya que depende de los valores del cubo basedenominado 'PriceCube' para calcular el valor de 'net'. Para establecer esta dependencia, debe ejecutarla función siguiente en un proceso de TurboIntegrator: AddCubeDependency( 'PriceCube','SalesCube' );

Para establecer la dependencia en el momento de la carga del servidor, puede crear un proceso queejecute la función AddCubeDependency, planifique el proceso como tarea y después defina esa tareacomo una de las tareas StartupChores en Tm1s.cfg.

CellGetNCellGetN recupera un valor de una celda de cubos numérica.

282 IBM Planning Analytics: Referencia de TM1

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CellGetN(Cube, e1, e2 [,...en]);

Argumento Descripción

Cube El nombre del cubo del que desea recuperar unvalor.

e1,...en Los nombres de elementos de dimensiones quedefinen la intersección del cubo que incluye elvalor que desea recuperar.

Los argumentos de e1 a en distinguen secuencias.e1 debe ser un elemento de la primera dimensióndel cubo, e2 debe ser un elemento de la segundadimensión, etc. Estos argumentos pueden sertambién los nombres de alias de elementos dedimensiones o variables de TurboIntegrator.

Si alguna de las dimensiones del cubo utilizajerarquías también puede utilizar la convención'HierarchyName':'ElementName' paraespecificar un elemento en una jerarquíaespecífica. En este caso, la secuencia deargumentos aún debe cumplir el orden dedimensiones del cubo. Por ejemplo, si desea hacerreferencia a varios elementos de jerarquías en lasegunda dimensión del cubo, todos estosargumentos deben aparecer después delargumento de la primera dimensión del cubo yantes del argumento de la tercera dimensión delcubo.

Ejemplo de CELLGETN y variables

Al utilizar esta función en una sentencia condicional (IF), la sentencia es la parte que contiene lacondición, no todo el bloque condicional. Después de un error leve, la ejecución continúa con la siguientesentencia. El proceso TurboIntegrator desconoce que se encuentra en una sentencia condicional una vezprocesado el error leve, de modo que la siguiente sentencia es la línea siguiente y no la línea que sigue aENDIF;.

Para evitar esta situación, utilice variables en las operaciones que pudiesen producir un error leve y, acontinuación, utilice las variables en la sentencia condicional.

V1 = CELLGETN('PNLCube', 'fred','argentina','Sales','Jan');IF(V1 = 454); ASCIIOUTPUT('bug.txt', 'if logic not working properly');ENDIF;

Ejemplo de CellGetN sin jerarquías

Este ejemplo muestra una función que utiliza nombres de elemento simples como argumentos y no hacereferencia a ninguna jerarquía. Recupera el valor numérico en la intersección de los elementos Actual,Argentina, S Series 1.8L Sedan, Sales y Jan en el cubo Sales.

CellGetN ('Sales', 'Actual', 'Argentina', 'S Series1.8L Sedan', 'Sales', 'Jan');

Capítulo 5. funciones de TurboIntegrator 283

Ejemplo de CellGetN con referencias a varias jerarquías

Este ejemplo ilustra una función que hace referencia a varias jerarquías en la dimensión Model. Recuperael valor numérico en la intersección de los elementos Actual, Argentina, S Series (de la jerarquía Vehiclesen la dimensión Model), 2.8 Litre (de la jerarquía Enginesize de la dimensión Model) y Jan del cubo Sales.

CellGetN('Sales', 'Actual', 'Argentina', ('vehicles':'S Series', 'enginesize':'2.8 Litre'), 'Sales', 'Jan');

Nota: En este ejemplo se ha truncado artificialmente la línea de código para facilitar su lectura.

CellGetSCellGetS recupera un valor de una celda de cubo de cadena.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CellGetS(Cube, e1, e2 [,...en]);

Argumento Descripción

Cubo El nombre del cubo del que desea recuperar unvalor.

e1,...en Los nombres de elementos de dimensiones quedefinen la intersección del cubo que incluye elvalor que desea recuperar.

Los argumentos de e1 a en distinguen secuencias.e1 debe ser un elemento de la primera dimensióndel cubo, e2 debe ser un elemento de la segundadimensión, etc. Estos argumentos pueden sertambién los nombres de alias de elementos dedimensiones o variables de TurboIntegrator.

Consulte la nota en “CellGetN” en la página 282relativa a la lógica de IF con esta función.

Ejemplo

CellGetS('Personal', 'Rep', 'Europa', 'Producto');

Este ejemplo recupera el valor de cadena de la intersección de los elementos Rep, Europa y Producto delcubo Personal.

CellIncrementNCellIncrementN incrementa el valor de celda numérico actual por el valor especificado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CellIncrementN(x, Cube, e1, e2 [,...en]);

Argumento Descripción

x Valor numérico que desea añadir a un valor decelda actual.

284 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

Cubo El nombre del cubo al que desea enviar el valor.

e1,...en Los nombres de elementos de dimensiones quedefinen la intersección del cubo que recibirá elvalor.

Los argumentos de e1 a en distinguen secuencias.e1 debe ser un elemento de la primera dimensióndel cubo, e2 debe ser un elemento de la segundadimensión, etc. Estos argumentos pueden sertambién los nombres de alias de elementos dedimensiones o variables de TurboIntegrator.

Ejemplo

CellIncrementN(1000, 'y2ksales', 'Actual', 'Argentina', 'S Series 1.8L Sedan', 'Sales', 'Jan');

Este ejemplo incrementa por 1000 el valor de la intersección de los elementos Real, Argentina, S Series1.8L Sedan, Ventas y Ene del cubo ventasa2000.

CellIsUpdateableCellIsUpdateable determina si se puede escribir en una celda de cubo. La función devuelve 1 si se puedeescribir en la celda; de lo contrario, devuelve 0.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CellIsUpdateable(Cube, e1, e2 [,...en]);

Argumento Descripción

Cubo El nombre del cubo en el que desea escribir unvalor.

e1,...en Los nombres de elementos de dimensiones quedefinen la celda en la que desea escribir un valor.

Los argumentos de e1 a en distinguen secuencias.e1 debe ser un elemento de la primera dimensióndel cubo, e2 debe ser un elemento de la segundadimensión, etc. Estos argumentos pueden sertambién los nombres de alias de elementos dedimensiones o variables de TurboIntegrator.

Ejemplo

CellIsUpdateable ('ventasa2000', 'Real', 'Argentina', 'S Series 1.8L Sedan', 'Ventas', 'Ene');

Este ejemplo determina si se puede escribir en la celda definida por los elementos Real, Argentina, SSeries 1.8L Sedan, Ventas y Ene del cubo ventasa2000. Si la celda puede recibir un valor, la funcióndevuelve 1; de lo contrario, devuelve 0.

Capítulo 5. funciones de TurboIntegrator 285

CellPutNCellPutN envía un valor numérico a una celda de cubo.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CellPutN(x, Cube, e1, e2 [,..., en]);

Argumento Descripción

x Un valor numérico.

Cubo El nombre del cubo al que desea enviar el valor.

e1, e2, ..., en Los nombres de elementos de dimensiones quedefinen la intersección del cubo que recibirá elvalor.

Los argumentos de e1 a en distinguen secuencias.e1 debe ser un elemento de la primera dimensióndel cubo, e2 debe ser un elemento de la segundadimensión, etc. Estos argumentos pueden sertambién los nombres de alias de elementos dedimensiones o variables de TurboIntegrator.

Nota: Si proporciona argumentos que no sean válidos a la función CellPutN() en un procesoTurboIntegrator cuando el cubo no existe, se envía un error a tm1server.log.

Ejemplo

CellPutN(12345, 'ventasa2000', 'Real', 'Argentina', 'S Series 1.8L Sedan', 'Ventas', 'Ene');

Este ejemplo envía el valor 12345 a la intersección de los elementos Real, Argentina, S Series 1.8LSedan, Ventas y Ene del cubo ventasa2000.

CellPutProportionalSpreadCellPutProportionalSpread distribuye un valor especificado a las hojas de una consolidación que esproporcional a los valores de celda existentes. CellPutProportionalSpread sustituye valores de celdaexistentes; no puede utilizarse para añadirse o restarse de los valores de celda existentes.

Esta función es análoga al método de dispersión de datos Dispersión proporcional, que se describedetalladamente en la documentación de TM1 Perspectives and TM1 Architect. Si debe añadirse o restarsede valores de celda existentes, utilice el método Proportional Spread, que puede ejecutarse a través de lainterfaz de usuario o a través de la sintaxis de dispersión de datos.

Nota: Al utilizar CellPutProportionalSpread para distribuir un valor a las hojas de una consolidación,únicamente se modifican aquellas hojas que ya contienen valores que no son cero. Esto sucede porquelos valores cero no pueden aumentarse ni disminuirse de forma proporcional; cualquier proporción decero sigue siendo cero.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CellPutProportionalSpread( value, cube, e1, e2, e3...,en );

286 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

value El valor que desea distribuir.

cube El nombre del cubo en el que desea distribuir elvalor.

e1...en Los nombres de los elementos que identifican laconsolidación cuyas hojas aceptarán el valordistribuido.

Los argumentos de e1 a en distinguen secuencias.e1 debe ser un elemento de la primera dimensióndel cubo, e2 debe ser un elemento de la segundadimensión, etc. Estos argumentos pueden sertambién los nombres de alias de elementos dedimensiones o variables de TurboIntegrator.

Ejemplo

CellPutProportionalSpread(7000,'SalesCube', 'Actual','North America', 'S Series 1.8L Sedan', 'Sales', 'Jan')

Este ejemplo distribuye el valor 7000 a los hijos de la consolidación de SalesCube identificada por loselementos Actual, North America, S Series 1.8L Sedan, Sales y Jan.

CellPutSCellPutS envía un valor de cadena a una celda de cubo.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CellPutS(String, Cube, e1, e2 [,...en]);

Argumento Descripción

Cadena Una cadena.

Cubo El nombre del cubo al que desea enviar la cadena.

e1,...en Los nombres de elementos de dimensiones quedefinen la intersección del cubo que recibirá lacadena.

Los argumentos de e1 a en distinguen secuencias.e1 debe ser un elemento de la primera dimensióndel cubo, e2 debe ser un elemento de la segundadimensión, etc. Estos argumentos pueden sertambién los nombres de alias de elementos dedimensiones o variables de TurboIntegrator.

Ejemplo

CellPutS('jones', 'Personal', 'Rep', 'Europa', 'Producto');

Capítulo 5. funciones de TurboIntegrator 287

Este ejemplo envía la cadena "jones" a la intersección de los elementos Rep, Europa y Producto del cubopersonal.

CubeClearDataCubeClearData borra todos los datos de un cubo. Esta función es mucho más rápida que realizar unaoperación como crear una vista para cubrir el cubo entero y, a continuación, un ViewZeroOut() paraponerlo a cero.

Cuando utilice CubeClearData para borrar los datos de un cubo, se borrarán también todas las celdasalimentadas con los feeders. Deberá volver a guardar la regla que establece los alimentadores o utilizar lafunción CubeProcessFeeders para restaurar las celdas feed.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Nota: Esta acción simplemente borra los datos del cubo, no borra y vuelve a crear el cubo en sí. Esto tieneconsecuencias al utilizar recinto de pruebas. Si se borra y se vuelve a crear un cubo, se descartarán todoslos recintos de pruebas que pueda tener un usuario, puesto que se ha borrado el cubo contra el que secrearon (aunque se pueda haber vuelto a crear un cubo con el mismo nombre). Si por el contrario seutiliza la acción CubeClearData(), los datos del recinto de pruebas se considerarán válidos, puesto que elcubo contra el que se creó el recinto de pruebas aún existe.

Sintaxis

CubeClearData( name-of-cube-as-string );

Argumento

El nombre del cubo que se desea borrar, como una cadena.

Ejemplo

CubeClearData( 'expense' );

CubeCreateCubeCreate crea un cubo a partir de unas dimensiones concretas. El orden de las dimensionesespecificadas en la función será el orden de las dimensiones en la definición del cubo. Tras ejecutarse,CubeCreate guarda automáticamente el archivo .cub resultante en el disco.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeCreate(Cube, d1, d2 [,...dn]);

Argumento Descripción

Cube El nombre que desea asignar al cubo.

d1,...dn Los nombres de las dimensiones que forman elcubo. Debe especificar al menos dos dimensiones,pero no más de 256.

Ejemplo

CubeCreate('ventasa2000', 'Actvsbud', 'Región', 'Modelo', 'Cuenta1', 'Mes');

288 IBM Planning Analytics: Referencia de TM1

Este ejemplo crea un cubo denominado ventasa2000 utilizando las dimensiones Actvsbud, Región,Modelo, Cuenta1 y Mes.

CubeDestroyCubeDestroy suprime un cubo de TM1 especificado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeDestroy(Cube);

Argumento Descripción

Cube El nombre del cubo que desea eliminar.

Ejemplo

CubeDestroy('ventasa2000');

Este ejemplo elimina el cubo denominado ventasa2000.

CubeDimensionCountGetCubeDimensionCountGet devuelve el número de dimensiones de un cubo.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeDimensionCountGet(CubeName);

Argumento Descripción

CubeName Nombre del cubo cuyo número de dimensionesdesea determinar.

EjemploCubeDimensionCountGet('Sales');

En este ejemplo, la función devuelve el número de dimensiones del cubo Sales.

CubeExistsCubeExists determina si existe un cubo específico en el servidor desde el que se ejecuta un procesoTurboIntegrator. La función devuelve 1 si el cubo existe en el servidor; de lo contrario, devuelve 0.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeExists(CubeName);

Argumento Descripción

CubeName El nombre del cubo cuya existencia deseaconfirmar.

Capítulo 5. funciones de TurboIntegrator 289

Ejemplo

CubeExists('Inventario');

Este ejemplo determina si el cubo Inventario existe en el servidor.

CubeGetLogChangesCubeGetLogChanges devuelve el valor booleano de la propiedad Logging de un cubo especificado.

La propiedad Logging se configura en el cuadro de diálogo Asignaciones de seguridad de TM1 y sealmacena en el cubo de control }CubeProperties. Si se activa Logging para un cubo, la función devuelve 1.Si Logging está desactivado, la función devuelve 0.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeGetLogChanges(CubeName);

Argumento Descripción

CubeName El cubo al que desea devolver el valor de lapropiedad Logging.

Ejemplo

CubeGetLogChanges('ventas2002');

Si el registro se encuentra activado para el cubo ventas2002, la función devuelve 1.

CubeSaveDataCubeSaveData() serializa un cubo.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Para mejorar el rendimiento, se puede inhabilitar el registro de transacciones durante la carga de datos.Para proteger los datos cargados recientemente en el caso improbable de que se produzca un bloqueodel servidor, se pueden serializar los cambios en disco. SaveDataAll se ha utilizado para serializar datosen disco y para truncar el registro de transacciones. Cuando se procesa un comando SaveDataAll, elservidor adquiere un bloqueo de lectura en cada cubo y un bloqueo IX en cada cubo modificado. Estopuede generar una contención importante de la actividad de usuario, si se ejecuta SaveDataAll duranteperiodos de actividad del usuario.

Generalmente, no es necesario que se serialicen todos los cubos afectados por SaveDataAll ya quenormalmente se cargan con datos nuevos. CubeSaveData se utiliza para serializar un cubo individual endisco. CubeSaveData serializa los datos del cubo que se han confirmado en la memoria, incluidas lasmodificaciones realizadas en el mismo durante el proceso TurboIntegrator actual que todavía no se hanconfirmado.

Sintaxis

CubeSaveData(Cube);

Argumento Descripción

Cubo El nombre del cubo que desea serializar.

290 IBM Planning Analytics: Referencia de TM1

Ejemplo

CubeSaveData ('SalesCube');

Tenga en cuenta el siguiente código de proceso de TurboIntegrator:

CellPutN(500, 'y2ksales', 'Actual', 'Argentina', 'S Series 1.8 L Wagon', 'Sales', 'Jan');

CubeSaveData('y2ksales');

CellPutN(1000, 'y2ksales', 'Actual', 'Argentina', 'S Series 1.8 L Wagon', 'Sales', 'Jan');

Cuando se procesa el comando CubeSaveData, se incluye el valor de 500 para la celda de ventas deenero en la serialización del cubo en disco, aunque todavía no se haya confirmado. La actualización de lacelda de ventas de Enero a 1000 no formará parte de la serialización.

Registro de transacciones

Cuando se ejecuta CubeSaveData aparece una entrada nueva en el registro de transacciones. Cuando seprocesa un archivo de registro de transacciones durante la recuperación, todas las actualizaciones de uncubo que se hayan aplicado hasta el momento se descartarán cuando se encuentre una directivaCubeSaveData para el cubo, puesto que todas las actualizaciones ya se habrán serializado en el cubo.

Recuperación de bloqueos del servidor

El comando SaveDataAll se beneficia del hecho que durante su procesamiento todos los cubos esténbloqueados y trunca el registro de transacciones sabiendo que todas las actualizaciones realizadas antesde la serialización se han guardado correctamente en el disco. Este no es el caso de CubeSaveData, por lotanto, debe modificar el modo en que se realiza la recuperación de datos cuando se ha serializado uncubo.

El archivo de registro de transacciones puede contener registros que representan cambios más antiguosque los datos más recientes del cubo y no se debe aplicar cuando se están recuperando los datos.

CubeSetConnParamsCubeSetConnParams se utiliza para cifrar la contraseña de un cubo virtual en el cubo }CubeProperties.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeSetConnParams(cubeName, providerName, dataSourceLocation,dataSourceName, dataSourceCatalog, userID, password, sapClientID, sapClientLang, providerString);

Argumento Descripción

cubeName El nombre del cubo para el que desea establecer lacontraseña.

providerName

dataSourceLocation Nombre que asigna su administrador a un conjuntode catálogos de una ubicación determinada. EnMicrosoft Analysis Services, éste es el nombre deun servidor registrado.

dataSourceName

Capítulo 5. funciones de TurboIntegrator 291

Argumento Descripción

dataSource catalog Es el nombre asignado por su administrador a unacolección determinada de bases de datos (cubos,dimensiones y otros objetos). Para MAS, este es elnombre de la base de datos.

UserID Un nombre de usuario válido para la base de datos.

Password La contraseña que se utilizará en este origen dedatos.

sapClientID ID de cliente SAP

sapClientLang Configuración de idioma de SAP.

providerString

Ejemplo

CubeSetConnParams(sc, TM1OLAP, tm1server, , sdata, admin, apple, , , );

CubeSetLogChangesCubeSetLogChanges establece la propiedad Registro para un cubo.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeSetLogChanges(Cube, LogChanges);

Argumento Descripción

Cube El nombre del cubo para el que desea establecer lapropiedad LOGGING.

LogChanges El valor booleano que desea asignar a la propiedad.1= LOGGING activado, 0 = LOGGING desactivado.

CubeTimeLastUpdatedCubeTimeLastUpdated devuelve un valor de serie que indica la fecha y hora de la última actualización deun cubo especificado.

El valor de serie que devuelve esta función utiliza una fecha de inicio de 1 de enero de 1900 12:00:00A.M., equivalente al valor 1.0. Las fechas se representan como enteros, mientras que las horas serepresentan como números decimales entre .0 y .999999. Esto es coherente con el modo en que sealmacenan y notifican los valores de serie de fecha y hora en Microsoft Excel.

Nota: De forma predeterminada, los valores de serie de fecha y hora de TM1 utilizan una hora de iniciodel 1 de enero de 1960 12:00:00 A.M. Para resolver la incoherencia entre los valores de serie de fecha yhora de Excel y TM1, puede establecer UseExcelSerialDate=T en el archivo Tm1s.cfg para indicar alservidor TM1 que utilice los valores de serie de fecha y hora que cumplen los estándares de Excel.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

292 IBM Planning Analytics: Referencia de TM1

Sintaxis

CubeTimeLastUpdated(cube);

Argumento Descripción

cube Nombre del cubo.

Ejemplo

CubeTimeLastUpdated('Sales');

Este ejemplo devuelve un valor correspondiente a la hora de la última actualización del cubo Sales.

CubeUnloadCubeUnload descarga un cubo especificado de la memoria junto con toda las vistas de cubo asociadas.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeUnload(CubeName);

Argumento Descripción

CubeName El cubo que desea descargar de la memoria.

Ejemplo

CubeUnload('Presupuestofabricación');

Este ejemplo descarga el cubo Presupuestofabricación y las vistas asociadas de la memoria del servidor.

Funciones de TurboIntegrator de reserva de datosUtilice las funciones de TurboIntegrator siguientes para obtener, liberar y administrar medianteprogramación las reservas de datos.

Para obtener más información sobre el uso de la característica Reserva de datos, consulte el tema"Utilización de las reservas de datos" en la documentación de IBM Cognos TM1 para desarrolladores.

CubeDataReservationAcquireCubeDataReservationAcquire Adquiere una reserva de datos para el cubo, usuario y tupla especificados.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeDataReservationAcquire(Cube, User, bForce, Address, [AddressDelimiter])

Argumento Descripción

Cube Nombre del cubo.

Capítulo 5. funciones de TurboIntegrator 293

Argumento Descripción

User Nombre del propietario de la reserva nueva.

El nombre de usuario proporcionado se validará para garantizar que se tratade un usuario existente.

bForce Valor booleano que determina el comportamiento si la reserva solicitadaentra en conflicto con una reserva existente.

Si se establece en 0 (falso), la solicitud se rechaza si entra en conflicto conuna reserva existente.

Si se establece en 1 (verdadero) y el usuario que está ejecutando el procesode TurboIntegrator tiene la función DataReservationOverride, las reservasconflictivas se liberan y se otorga la solicitada.

Address Secuencia de cadenas con señales de nombres de elementos que definen latupla. El orden debe coincidir con el orden original de las dimensiones delcubo.

Todas las celdas del cubo contenidas en la tupla forman la región que sereserva. Puede elegir un elemento de cada dimensión o utilizar una cadenavacía entre los delimitadores para seleccionar una dimensión completa. Enfunción del lugar que el elemento ocupe en la jerarquía, la solicitud reservauna sola celda, una sección o el cubo entero.

AddressDelimiter Cadena de caracteres opcional que se utiliza para separar los nombres de loselementos en el parámetro Address.

El valor predeterminado es '|'.

Valor de retorno

Booleano: Devuelve verdadero si la adquisición se realiza correctamente.

Ejemplo

CubeDataReservationAcquire('DRTestCube','User1',0,'ElemX|ElemY|ElemZ');

En el ejemplo siguiente se establece el parámetro bForce en 1 para forzar la solicitud de DR si existealgún conflicto y se utiliza un carácter delimitador distinto para el parámetro AddressDelimiter.

CubeDataReservationAcquire('DRTestCube','User2',1,'ElemX*ElemY*ElemZ','*');

CubeDataReservationReleaseCubeDataReservationRelease libera la reserva de datos especificada.

Si el usuario especificado no coincide con el propietario de la reserva, la liberación solamente se realizarási el usuario especificado tiene la función DataReservationOverride habilitada.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeDataReservationRelease(Cube, User, Address,[AddressDelimiter])

294 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

Cube Nombre del cubo.

User Nombre del propietario de la reserva.

El nombre de usuario proporcionado se validará para garantizar que setrata de un usuario existente.

Address Secuencia de cadenas con señales de nombres de elementos que definenla tupla. El orden debe coincidir con el orden original de las dimensionesdel cubo.

AddressDelimiter Cadena de caracteres opcional que se utiliza para separar los nombres delos elementos en el parámetro Address.

El valor predeterminado es '|'.

Valor de retorno

Booleano: Devuelve verdadero si la liberación se realiza correctamente.

Ejemplo

CubeDataReservationRelease('DRTestCube','User1','ElemX|ElemY|ElemZ');

En el ejemplo siguiente se utiliza un carácter distinto para el parámetro AddressDelimiter.

CubeDataReservationRelease('DRTestCube','User2','ElemX*ElemY*ElemZ','*');

CubeDataReservationReleaseAllCubeDataReservationReleaseAll libera varias reservas de datos existentes.

Se liberarán todas las reservas contenidas totalmente en la dirección especificada que se correspondancon el filtro de usuarios. Si el filtro de usuarios está en blanco, significa todos los usuarios.

Si el usuario especificado en el filtro no coincide con el usuario que está ejecutando el proceso deTurboIntegrator, debe tener habilitada la función DataReservationOverride.

Si se utiliza un filtro de usuarios en blanco y sólo comodines en el campo de dirección, se liberan todaslas reservas.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeDataReservationReleaseAll(Cube, UserFilter, Address, [AddressDelimiter])

Argumento Descripción

Cube Nombre del cubo.

UserFilter Filtro de nombres de usuario que se utilizará en la comparación con lasreservas existentes.

Address Secuencia de cadenas con señales de nombres de elementos que definen latupla. El orden debe coincidir con el orden original de las dimensiones delcubo.

Capítulo 5. funciones de TurboIntegrator 295

Argumento Descripción

AddressDelimiter Cadena de caracteres opcional que se utiliza para separar los nombres de loselementos en el parámetro Address.

El valor predeterminado es '|'.

Valor de retorno

Booleano: Devuelve verdadero si no hay errores.

Ejemplo

CubeDataReservationReleaseAll('DRTestCube','User1','ElemX|ElemY|ElemZ');

En el ejemplo siguiente se liberan todas las reservas en el cubo especificado para todos los usuarios.

CubeDataReservationReleaseAll('DRTestCube','','||');

CubeDataReservationGetCubeDataReservationGet busca las reservas existentes en un cubo específico para un usuario o paratodos.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeDataReservationGet(Index, Cube, User, [AddressDelimiter]) returns Address;

Argumento Descripción

Index Índice de bucle basado en uno que se utilizará para la iteración por lasreservas en el cubo especificado.

Cube Nombre del cubo en el que se buscará.

User Nombre del propietario de la reserva que se utilizará como filtro.

Si se deja en blanco, la función devuelve las reservas de todos lospropietarios.

Si se proporciona un nombre, la función filtra los resultados para elpropietario especificado únicamente.

AddressDelimiter Cadena de caracteres opcional que se utiliza para separar los nombres de loselementos en el parámetro Address devuelto.

El valor predeterminado es '|'.

Valor de retorno

Address: Hora de creación de la reserva, nombre del propietario de la reserva y elemento de dirección dela reserva. En primer lugar aparece la hora de creación, seguida del delimitador, el ID de usuario, eldelimitador y los ID de elementos separados por el delimitador según el orden de las dimensiones delcubo (orden original).

Se devuelve una cadena vacía si no hay ninguna entrada para el índice especificado.

El formato del valor de retorno es:

296 IBM Planning Analytics: Referencia de TM1

[creation time][delimiter][owner name][delimiter][element1][delimiter][element2][delimiter]…[elementN]

Por ejemplo:

"20100622211601|Fred Bloggs|Elemento1|Elemento2|Elemento3"

Nota: Las reservas pueden cambiar mientras se realiza una iteración por la lista de reservas, por lo que eluso del índice no garantiza que se obtenga una lista completa de las reservas. Se pueden añadir oeliminar reservas en cualquier posición de la lista, por lo que se pueden omitir o repetir reservas al pasarpor los valores del índice.

Si se especifica el filtro de propietarios, el índice se aplica solamente a los miembros de la lista filtrada. Sila lista de reservas tiene los propietarios User1, User1 y User2 y en la solicitud se especifica User2 comopropietario, un índice de 1 recuperará el tercer miembro de la lista.

Ejemplo

CubeDataReservationGet(1,'DRTestCube','User1','*');

CubeDataReservationGet(1,'DRTestCube','');

El ejemplo siguiente localizaría todas las reservas propiedad del usuario Fred Bloggs en el cubo ExpenseInput y realizaría alguna operación de utilidad con ellas:

vIndex = 1;vCube = 'Expense Input';vUserFilter = 'Fred Bloggs';vDelim = '|';vAddress = CubeDataReservationGet( vIndex, vCube, vUserFilter,vDelim);WHILE (vAddress @<> ''); vSep1 = SCAN( vDelim, vAddress); vDRUser = SUBST( vAddress, 1, vSep1 - 1); vDRAddress = SUBST( vAddress, vSep1 + 1, LONG(vDRAddress) - vSep1);

# do something meaningful with theuser and reservation address here vIndex = vIndex + 1; vAddress = CubeDataReservationGet( vIndex, vCube, vUserFilter,vDelim);END;

CubeDataReservationGetConflictsCubeDataReservationGetConflicts busca las reservas existentes en un cubo específico que entrarían enconflicto con el usuario, la dirección y la tupla que se han especificado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeDataReservationGetConflicts(Index, Cube, User, Address, [AddressDelimiter])returns ConflictAddress;

Argumento Descripción

Index Índice de bucle basado en uno que se utilizará para la iteración por losconflictos que se corresponden con esta consulta.

Cube Nombre del cubo en el que se buscará.

User La consulta buscará las reservas que entrarían en conflicto con esteusuario.

Capítulo 5. funciones de TurboIntegrator 297

Argumento Descripción

Address Secuencia de cadenas con señales de nombres de elementos que definenla tupla. El orden debe coincidir con el orden original de las dimensionesdel cubo.

AddressDelimiter Cadena de caracteres opcional que se utiliza para separar los nombres delos elementos en el parámetro Address.

El valor predeterminado es '|'.

Valor de retorno

ConflictAddress: Hora de creación de la reserva, nombre del propietario de la reserva y elemento dedirección de la reserva. En primer lugar aparece la hora de creación, seguida del delimitador, el ID deusuario, el delimitador y los ID de elementos separados por el delimitador según el orden de lasdimensiones del cubo (orden original).

Se devuelve una cadena vacía si no hay ninguna entrada para el índice especificado.

El formato del valor de retorno es:

[creation time][delimiter][owner name][delimiter][element1][delimiter][element2][delimiter]…[elementN]

Por ejemplo:

"20100622211601|Fred Bloggs|Elemento1|Elemento2|Elemento3"

Nota: Las reservas pueden cambiar mientras se realiza una iteración por la lista de reservas conflictivas,por lo que el uso del índice no garantiza que se obtenga una lista completa de las reservas. Se puedenañadir o eliminar reservas en cualquier posición de la lista, por lo que se pueden omitir o repetir reservasal pasar por los valores del índice.

CubeDRAcquireCubeDRAcquire adquiere una reserva de datos para el cubo, usuario y tupla especificados. Mientras queCubeDataReservationAcquire se aplica a las dimensiones con una sola jerarquía, esta función seaplica a las dimensiones con una o más jerarquías.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeDRAcquire(Cube, User, bForce, Element-list)

Argumento Descripción

Cube Nombre del cubo.

User Nombre del propietario de la reserva nueva.

El nombre de usuario proporcionado se validará para garantizar que se tratade un usuario existente.

298 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

bForce Valor booleano que determina el comportamiento si la reserva solicitadaentra en conflicto con una reserva existente.

Si se establece en 0 (falso), la solicitud se rechaza si entra en conflicto conuna reserva existente.

Si se establece en 1 (verdadero) y el usuario que está ejecutando el procesode TurboIntegrator tiene la función DataReservationOverride, las reservasconflictivas se liberan y se otorga la solicitada.

Element-list Las coordenadas se expresan como una lista de longitud variable deargumentos individuales del nombre de elemento. Se espera que cada uno delos parámetros del nombre de elemento esté calificado jerárquicamente. Si ladimensión tiene una sola jerarquía, utilice el nombre de la dimensión. En otrocaso, utilice el nombre de la jerarquía deseada.

Los elementos se especifican con el formato '<jerarquía>':'<elemento>', conlas instancias separadas por una coma.

Valor de retorno

Booleano: Devuelve verdadero si la adquisición se realiza correctamente.

Ejemplo

CubeDRAcquire('DRTestCube','User1',0,'Hier1':'ElemX','Hier2':'ElemY','Hier3':'ElemZ');

En el ejemplo siguiente se establece el parámetro bForce en 1 para forzar la solicitud de DR si existealgún conflicto y se utiliza un carácter delimitador distinto para el parámetro AddressDelimiter.

CubeDRAcquire('DRTestCube','User2',1,'Hier1':'ElemX','Hier2':'ElemY','Hier3':'ElemZ');

CubeDRReleaseCubeDRRelease libera la reserva de datos especificada. Mientras que CubeDataReservationReleasese aplica a las dimensiones con una sola jerarquía, esta función se aplica a las dimensiones con una omás jerarquías.

Si el usuario especificado no coincide con el propietario de la reserva, la liberación solamente se realizarási el usuario especificado tiene la función DataReservationOverride habilitada.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeDRRelease(Cube, User, Element-list)

Argumento Descripción

Cube Nombre del cubo.

User Nombre del propietario de la reserva.

El nombre de usuario proporcionado se validará para garantizar que setrata de un usuario existente.

Capítulo 5. funciones de TurboIntegrator 299

Argumento Descripción

Element-list Las coordenadas se expresan como una lista de longitud variable deargumentos individuales del nombre de elemento. Se espera que cada unode los parámetros del nombre de elemento esté calificadojerárquicamente. Si la dimensión tiene una sola jerarquía, utilice el nombrede la dimensión. En otro caso, utilice el nombre de la jerarquía deseada.

Los elementos se especifican con el formato '<jerarquía>':'<elemento>',con las instancias separadas por una coma.

Valor de retorno

Booleano: Devuelve verdadero si la liberación se realiza correctamente.

Ejemplo

CubeDRRelease('DRTestCube','User1','Hier1':'ElemX','Hier2':'ElemY','Hier3':'ElemZ');

En el ejemplo siguiente se utiliza un carácter distinto para el parámetro AddressDelimiter.

CubeDRRelease('DRTestCube','User2','Hier1':'ElemX','Hier2':'ElemY','Hier3':'ElemZ');

CubeDRReleaseAllCubeDRReleaseAll libera varias reservas de datos existentes. Mientras queCubeDataReservationReleaseAll se aplica a las dimensiones con una sola jerarquía, esta función seaplica a las dimensiones con una o más jerarquías.

Se liberarán todas las reservas contenidas totalmente en la dirección especificada que se correspondancon el filtro de usuarios. Si el filtro de usuarios está en blanco, significa todos los usuarios.

Si el usuario especificado en el filtro no coincide con el usuario que está ejecutando el proceso deTurboIntegrator, debe tener habilitada la función DataReservationOverride.

Si se utiliza un filtro de usuarios en blanco y sólo comodines en el campo de dirección, se liberan todaslas reservas.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeDRReleaseAll(Cube, UserFilter, Element-list)

Argumento Descripción

Cube Nombre del cubo.

UserFilter Filtro de nombres de usuario que se utilizará en la comparación con lasreservas existentes.

Element-list Las coordenadas se expresan como una lista de longitud variable deargumentos individuales del nombre de elemento. Se espera que cada unode los parámetros del nombre de elemento esté calificado jerárquicamente.Si la dimensión tiene una sola jerarquía, utilice el nombre de la dimensión.En otro caso, utilice el nombre de la jerarquía deseada.

Los elementos se especifican con el formato '<jerarquía>':'<elemento>', conlas instancias separadas por una coma.

300 IBM Planning Analytics: Referencia de TM1

Valor de retorno

Booleano: Devuelve verdadero si no hay errores.

Ejemplo

CubeDRReleaseAll('DRTestCube','User1','Hier1':'ElemX','Hier2':'ElemY','Hier3':'ElemZ');

En el ejemplo siguiente se liberan todas las reservas en el cubo especificado para todos los usuarios.

CubeDRReleaseAll('DRTestCube','','');

CubeDRGetCubeDRGet busca las reservas existentes en un cubo específico para un usuario o para todos. Mientrasque CubeDataReservationGet se aplica a las dimensiones con una sola jerarquía, esta función seaplica a las dimensiones con una o más jerarquías.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeDRGet(Index, Cube, User, Element-list) returns Address;

Argumento Descripción

Index Índice de bucle basado en uno que se utilizará para la iteración por lasreservas en el cubo especificado.

Cube Nombre del cubo en el que se buscará.

User Nombre del propietario de la reserva que se utilizará como filtro.

Si se deja en blanco, la función devuelve las reservas de todos lospropietarios.

Si se proporciona un nombre, la función filtra los resultados para elpropietario especificado únicamente.

Element-list Las coordenadas se expresan como una lista de longitud variable deargumentos individuales del nombre de elemento. Se espera que cada uno delos parámetros del nombre de elemento esté calificado jerárquicamente. Si ladimensión tiene una sola jerarquía, utilice el nombre de la dimensión. En otrocaso, utilice el nombre de la jerarquía deseada.

Los elementos se especifican con el formato '<jerarquía>':'<elemento>', conlas instancias separadas por una coma.

Valor de retorno

Address: Hora de creación de la reserva, nombre del propietario de la reserva y elemento de dirección dela reserva. En primer lugar aparece la hora de creación, seguida del delimitador, el ID de usuario, eldelimitador y los ID de elementos separados por el delimitador según el orden de las dimensiones delcubo (orden original).

Se devuelve una cadena vacía si no hay ninguna entrada para el índice especificado.

El formato del valor de retorno es:

[creation time][delimiter][owner name][delimiter][element1][delimiter][element2][delimiter]…[elementN]

Capítulo 5. funciones de TurboIntegrator 301

Por ejemplo:

"20100622211601|Fred Bloggs|Elemento1|Elemento2|Elemento3"

Nota: Las reservas pueden cambiar mientras se realiza una iteración por la lista de reservas, por lo que eluso del índice no garantiza que se obtenga una lista completa de las reservas. Se pueden añadir oeliminar reservas en cualquier posición de la lista, por lo que se pueden omitir o repetir reservas al pasarpor los valores del índice.

Si se especifica el filtro de propietarios, el índice se aplica solamente a los miembros de la lista filtrada. Sila lista de reservas tiene los propietarios User1, User1 y User2 y en la solicitud se especifica User2 comopropietario, un índice de 1 recuperará el tercer miembro de la lista.

Ejemplo

CubeDRGet(1,'DRTestCube','User1','*');

CubeDRGet(1,'DRTestCube','');

El ejemplo siguiente localizaría todas las reservas propiedad del usuario Fred Bloggs en el cubo ExpenseInput y realizaría alguna operación de utilidad con ellas:

vIndex = 1;vCube = 'Expense Input';vUserFilter = 'Fred Bloggs';vHier = 'Currency';vElem = 'Local Currency';vAddress = CubeDRGet( vIndex, vCube, vUserFilter, vHier:vElem);WHILE (vAddress @<> ''); vSep1 = SCAN( vHier:vElem, vAddress); vDRUser = SUBST( vAddress, 1, vSep1 - 1); vDRAddress = SUBST( vAddress, vSep1 + 1, LONG(vDRAddress) - vSep1);

# do something meaningful with theuser and reservation address here vIndex = vIndex + 1; vAddress = CubeDRGet( vIndex, vCube, vUserFilter, vHier:vElem);END;

CubeDRGetConflictsCubeDRGetConflicts busca las reservas existentes en un cubo específico que entrarían en conflicto con elusuario, la dirección y la tupla que se han especificado. Mientras queCubeDataReservationGetConflicts se aplica a las dimensiones con una sola jerarquía, esta funciónse aplica a las dimensiones con una o más jerarquías.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeDRGetConflicts(Index, Cube, User, Element-list) returns ConflictAddress;

Argumento Descripción

Index Índice de bucle basado en uno que se utilizará para la iteración por losconflictos que se corresponden con esta consulta.

Cube Nombre del cubo en el que se buscará.

User La consulta buscará las reservas que entrarían en conflicto con esteusuario.

302 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

Element-list Las coordenadas se expresan como una lista de longitud variable deargumentos individuales del nombre de elemento. Se espera que cada unode los parámetros del nombre de elemento esté calificadojerárquicamente. Si la dimensión tiene una sola jerarquía, utilice el nombrede la dimensión. En otro caso, utilice el nombre de la jerarquía deseada.

Los elementos se especifican con el formato '<jerarquía>':'<elemento>',con las instancias separadas por una coma.

Valor de retorno

ConflictAddress: Hora de creación de la reserva, nombre del propietario de la reserva y elemento dedirección de la reserva. En primer lugar aparece la hora de creación, seguida del delimitador, el ID deusuario, el delimitador y los ID de elementos separados por el delimitador según el orden de lasdimensiones del cubo (orden original).

Se devuelve una cadena vacía si no hay ninguna entrada para el índice especificado.

El formato del valor de retorno es:

[creation time][delimiter][owner name][delimiter][element1][delimiter][element2][delimiter]…[elementN]

Por ejemplo:

"20100622211601|Fred Bloggs|Elemento1|Elemento2|Elemento3"

Nota: Las reservas pueden cambiar mientras se realiza una iteración por la lista de reservas conflictivas,por lo que el uso del índice no garantiza que se obtenga una lista completa de las reservas. Se puedenañadir o eliminar reservas en cualquier posición de la lista, por lo que se pueden omitir o repetir reservasal pasar por los valores del índice.

Funciones de TurboIntegrator de fecha y horaEstas funciones dan formato y analizan fechas y horas en una amplia gama de formatos y configuracionesregionales.

FormatDateFormatDate da formato a un valor de fecha según un formateador definido con la funciónNewDateFormatter.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

FormatDate(Date, <Patrón>, <Índice>)

Argumento Descripción

Fecha Un valor de fecha.

El tipo de valor, de serie o UNIX, debe corresponderse con el formateadorutilizado.

Capítulo 5. funciones de TurboIntegrator 303

Argumento Descripción

Patrón Patrón utilizado para dar formato a las fechas.

Visite http://userguide.icu-project.org/formatparse/datetime para obtener unalista completa de sintaxis de formatos.

Si se pasa una cadena vacía, el formato se determina por la configuraciónregional en función de los parámetros FormatterStyle y FormatterType que sehan utilizado con la función NewDateFormatter.

Index El índice devuelto por una llamada a la función NewDateFormatter.

El valor predeterminado es 0.

Si no existe ningún formateador en el índice, se utilizará un formateadorpredeterminado como si se hubiera creado con la siguiente llamada:

NewDateFormatter('', 'Etc/UTC', 'serial', 'medium', 'date')

Ejemplo

sDate = FormatDate(18000);

NewDateFormatterNewDateFormatter define un formateador de fecha. Devuelve un índice para utilizar con las funcionesParseDate y FormatDate. El índice empieza en 0 y aumenta en uno con cada llamada a NewDateFormat.Los formateadores de fecha son válidos durante la ejecución del proceso.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

NewDateFormatter(Locale, <TimeZone>, <UseUNIXTime>, <FormatterStyle>, <FormatterType>, <TimeType>)

Argumento Descripción

Entorno local Configuración regional para análisis o formato de fechas.

Si se pasa una cadena vacía, se utiliza la configuración regional. Lasconfiguraciones regionales se especifican con el formato de lenguaje [_territory][.variant]. Por ejemplo, cs_CK representa el idioma checo y la República checa.

Huso horario Huso horario para análisis o formato de fechas.

Consulte http://en.wikipedia.org/wiki/List_of_tz_database_time_zones paraobtener una lista completa de husos horarios.

Si no se especifica, la zona horaria utilizada es UTC ('Etc/UTC').

UseUNIXTime Si se especifica 'unix', las horas se tratan como milisegundos desde el 1 deenero de 1970. De lo contrario, se tratan con el formato de serie de TM1.

Tenga en cuenta que solo se pueden procesar las fechas posteriores al 1 de enerode 1970 aunque se utilice el formato de serie de TM1.

304 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

FormatterStyle Controla el formato de fecha que se utiliza cuando se especifica un patrón vacío enlas funciones FormatDate o ParseDate.

Los valores válidos son 'full', 'long', 'medium' o 'short'.

El valor predeterminado es 'medium'.

FormatterType Controla el tipo de formato que se utiliza cuando se especifica un patrón vacío enlas funciones FormatDate o ParseDate.

Los valores válidos son 'time', 'date' o 'datetime'.

El valor predeterminado es 'date'.

Ejemplo

dfUNIX = NewDateFormatter('', 'Etc/UTC', 'unix');

dfStyleFullDateTime = NewDateFormatter('en_us', 'America/Toronto', 'serial', 'full', 'datetime');

ParseDateParseDate analiza una cadena de fecha según un formateador definido con la función NewDateFormatter.

Se devuelve un valor de fecha, de serie o UNIX, en función del formateador especificado. Si la fecha no sepuede analizar, se devuelve un valor sin definir. Este valor se puede probar con la función ISUND.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ParseDate (DateString, <Pattern>, <Index>)

Argumento Descripción

DateString Una cadena de fecha.

Patrón Patrón utilizado para analizar fechas.

Visite http://userguide.icu-project.org/formatparse/datetime para obtener unalista completa de sintaxis de formatos.

Si se pasa una cadena vacía, el formato se determina por la configuraciónregional en función de los parámetros FormatterStyle y FormatterType que sehan utilizado con la función NewDateFormatter.

Index El índice devuelto por una llamada a la función NewDateFormatter. El valorpredeterminado es 0. Si no existe ningún formateador en el índice, se utilizaráun formateador predeterminado como si se hubiera creado con la siguientellamada:

NewDateFormatter('', 'Etc/UTC', 'serial', 'medium', 'date')

Ejemplo

nDate = ParseDate('2011/11/24', 'yyyy/MM/dd');

Capítulo 5. funciones de TurboIntegrator 305

Funciones de TurboIntegrator de manipulación de dimensionesEstas funciones facilitan la manipulación de dimensiones.

DimensionCreateDimensionCreate crea una nueva dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DimensionCreate(DimName);

Argumento Descripción

DimName El nombre que desea asignar a la dimensión.

Ejemplo

DimensionCreate('Producto');

Este ejemplo crea la dimensión Producto.

DimensionDeleteAllElementsDimensionDeleteAllElements elimina todos los elementos de una dimensión. Esta función resulta útilpara volver a crear jerarquías de dimensión.

Nota: Al borrar un elemento se borran todos los datos del cubo identificados por dicho elemento. Sinembargo, si utiliza DimensionDeleteAllElements para eliminar elementos y vuelve a crear dichoselementos con los mismos nombres en la pestaña Metadatos, tras volver a crear la dimensión seconservarán todos los puntos de datos de un cubo identificado por los elementos.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DimensionDeleteAllElements(DimName);

Argumento Descripción

DimName El nombre de la dimensión de la que deseaeliminar todos los elementos.

Ejemplo

DimensionDeleteAllElements('Modelo');

Este ejemplo elimina todos los elementos de la dimensión Modelo.

DimensionDeleteElementsDimensionDeleteElements suprime todos los elementos de hoja de una dimensión utilizando unsubconjunto de elementos. Se suprimen todos los elementos del subconjunto al que se hace referencia,incluidos los elementos de nivel C.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

306 IBM Planning Analytics: Referencia de TM1

Sintaxis

DimensionDeleteElements (DimensionName, Subset )

Argumento Descripción

DimensionName El nombre de la dimensión de la que deseasuprimir el subconjunto de elementos.

Subconjunto La lista de elementos que se van a suprimir de ladimensión indicada. El subconjunto suele sertemporal.

DimensionDestroyDimensionDestroy suprime una dimensión de la base de datos de TM1.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DimensionDestroy(DimName);

Argumento Descripción

DimName El nombre de la dimensión que desea eliminar.

Ejemplo

DimensionDestroy('Product');

Este ejemplo suprime la dimensión Producto de la base de datos TM1.

DimensionElementComponentAddDimensionElementComponentAdd añade un componente (hijo) a un elemento consolidado. No puedeutilizar esta función en el procedimiento de Epílogo de un proceso TurboIntegrator.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DimensionElementComponentAdd(DimName, ConsolidatedElName,ElName, ElWeight);

Argumento Descripción

DimName La dimensión padre del elemento consolidado alque desea añadir un hijo.

ConsolidatedElName El elemento al que desea añadir un hijo.

ElName El nombre del elemento hijo.

ElWeight El peso del elemento hijo.

Capítulo 5. funciones de TurboIntegrator 307

Ejemplo

DimensionElementComponentAdd('Medidas', 'Ventas netas', 'Gastos', -1);

Este ejemplo añade el hijo Gastos a la consolidación Ventas netas de la dimensión Medidas. El hijo tieneun peso de -1 en la consolidación.

DimensionElementComponentAddDirectDimensionElementComponentAddDirect añade un componente (hijo) a un elemento consolidadoeditando directamente una dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

El método predeterminado para editar una dimensión en TM1 es utilizar un patrón de edición de copiacompleta. En dicho patrón, se crea una copia de edición de la dimensión, las ediciones se aplican a lacopia de edición, y finalmente vuelve a escribirse la dimensión real utilizando la copia de edición comoplantilla. TurboIntegrator admite la edición automática de la copia completa siempre que se utilicenfunciones de TurboIntegrator para la edición de dimensiones (como DimensionElementComponentAdd)en el procedimiento de metadatos del proceso. TurboIntegrator crea automáticamente la copia deedición y le aplica las operaciones de edición; a continuación vuelve a escribir la dimensión real al finaldel procedimiento de metadatos.

Las ediciones directas son diferentes en tanto que no hay copia de edición. En su lugar, las operacionesse llevan a cabo directamente en la dimensión real. Existen dos casos de uso especializado y diferentepara los que está indicado este tipo de edición directa:

• Cuando el propósito del proceso TurboIntegrator es realizar un pequeño cambio en una dimensióngrande. En este caso, la edición directa será más eficaz porque evita la copia y la reescritura completade la dimensión grande.

• Cuando el propósito del proceso TurboIntegrator es cargar grandes volúmenes de datos en un cubo. Eneste caso, el procedimiento de Metadatos del proceso se mantiene deliberadamente vacío, y lamodificación de cualquier elemento necesario para dar soporte a la carga de datos se realiza utilizandollamadas directas en el procedimiento de Datos. Cuando el procedimiento de Metadatos está vacío, elproceso se salta una repetición completa sobre el origen de datos externo, gracias a lo cual las cargasde datos pueden ser más rápidas.

Sintaxis

DimensionElementComponentAddDirect(DimName, ConsolidatedElName,ElName, ElWeight);

Argumento Descripción

DimName La dimensión padre del elemento consolidado alque desea añadir un hijo.

ConsolidatedElName El elemento consolidado al que desea añadir unhijo.

ElName El nombre del elemento hijo.

ElWeight El peso del elemento hijo.

Ejemplo

DimensionElementComponentAddDirect('Measures', 'Net Sales', 'Expenses', -1);

Este ejemplo añade el hijo Expenses a la consolidación Net Sales de la dimensión Measures. El hijo tieneun peso de -1 en la consolidación.

308 IBM Planning Analytics: Referencia de TM1

DimensionElementComponentDeleteDimensionElementComponentDelete elimina un componente (hijo) de un elemento consolidado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DimensionElementComponentDelete(DimName, ConsolidatedElName,ElName);

Argumento Descripción

DimName La dimensión padre del elemento consolidado delque desea eliminar un hijo.

ConsolidatedElName El elemento consolidado del que desea eliminar unhijo.

ElName El nombre del elemento hijo que desea eliminar.

Ejemplo

DimensionElementComponentDelete('Región', 'Benelux', 'Bélgica');

Este ejemplo elimina el hijo Bélgica de la consolidación Benelux de la dimensión Región.

DimensionElementComponentDeleteDirectDimensionElementComponentDeleteDirect suprime un componente (hijo) de un elemento consolidadoeditando directamente la dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

El método predeterminado para editar una dimensión en TM1 es utilizar un patrón de edición de copiacompleta. En dicho patrón, se crea una copia de edición de la dimensión, las ediciones se aplican a lacopia de edición, y finalmente vuelve a escribirse la dimensión real utilizando la copia de edición comoplantilla. TurboIntegrator admite la edición automática de la copia completa siempre que se utilicenfunciones de TurboIntegrator para la edición de dimensiones (comoDimensionElementComponentDelete) en el procedimiento de metadatos del proceso. TurboIntegratorcrea automáticamente la copia de edición y le aplica las operaciones de edición; a continuación vuelve aescribir la dimensión real al final del procedimiento de metadatos.

Las ediciones directas son diferentes en tanto que no hay copia de edición. En su lugar, las operacionesse llevan a cabo directamente en la dimensión real. Existen dos casos de uso especializado y diferentepara los que está indicado este tipo de edición directa:

• Cuando el propósito del proceso TurboIntegrator es realizar un pequeño cambio en una dimensióngrande. En este caso, la edición directa será más eficaz porque evita la copia y la reescritura completade la dimensión grande.

• Cuando el propósito del proceso TurboIntegrator es cargar grandes volúmenes de datos en un cubo. Eneste caso, el procedimiento de Metadatos del proceso se mantiene deliberadamente vacío, y lamodificación de cualquier elemento necesario para dar soporte a la carga de datos se realiza utilizandollamadas directas en el procedimiento de Datos. Cuando el procedimiento de Metadatos está vacío, elproceso se salta una repetición completa sobre el origen de datos externo, gracias a lo cual las cargasde datos pueden ser más rápidas.

Sintaxis

DimensionElementComponentDeleteDirect(DimName, ConsolidatedElName,ElName);

Capítulo 5. funciones de TurboIntegrator 309

Argumento Descripción

DimName La dimensión padre del elemento consolidado delque desea eliminar un hijo.

ConsolidatedElName El elemento consolidado del que desea eliminar unhijo.

ElName El nombre del elemento hijo que desea eliminar.

Ejemplo

DimensionElementComponentDeleteDirect('Region', 'Benelux','Belgium');

Este ejemplo elimina el hijo Belgium de la consolidación Benelux de la dimensión Region.

DimensionElementDeleteDimensionElementDelete elimina un elemento de una dimensión.

Nota: Al borrar un elemento se borran todos los datos del cubo identificados por dicho elemento.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DimensionElementDelete(DimName, ElName);

Argumento Descripción

DimName La dimensión que incluye el elemento que deseaeliminar.

ElName El elemento que desea eliminar.

Ejemplo

DimensionElementDelete('Región', 'Bélgica');

Este ejemplo elimina el elemento Bélgica de la dimensión Región.

DimensionElementDeleteDirectDimensionElementDeleteDirect suprime un elemento de una dimensión editando directamente ladimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Nota: Al borrar un elemento se borran todos los datos del cubo identificados por dicho elemento.

El método predeterminado para editar una dimensión en TM1 es utilizar un patrón de edición de copiacompleta. En dicho patrón, se crea una copia de edición de la dimensión, las ediciones se aplican a lacopia de edición, y finalmente vuelve a escribirse la dimensión real utilizando la copia de edición comoplantilla. TurboIntegrator admite la edición automática de la copia completa siempre que se utilicenfunciones de TurboIntegrator para la edición de dimensiones (como DimensionElementDelete) en elprocedimiento de metadatos del proceso. TurboIntegrator crea automáticamente la copia de edición y leaplica las operaciones de edición; a continuación vuelve a escribir la dimensión real al final delprocedimiento de metadatos.

310 IBM Planning Analytics: Referencia de TM1

Las ediciones directas son diferentes en tanto que no hay copia de edición. En su lugar, las operacionesse llevan a cabo directamente en la dimensión real. Existen dos casos de uso especializado y diferentepara los que está indicado este tipo de edición directa:

• Cuando el propósito del proceso TurboIntegrator es realizar un pequeño cambio en una dimensióngrande. En este caso, la edición directa será más eficaz porque evita la copia y la reescritura completade la dimensión grande.

• Cuando el propósito del proceso TurboIntegrator es cargar grandes volúmenes de datos en un cubo. Eneste caso, el procedimiento de Metadatos del proceso se mantiene deliberadamente vacío, y lamodificación de cualquier elemento necesario para dar soporte a la carga de datos se realiza utilizandollamadas directas en el procedimiento de Datos. Cuando el procedimiento de Metadatos está vacío, elproceso se salta una repetición completa sobre el origen de datos externo, gracias a lo cual las cargasde datos pueden ser más rápidas.

Sintaxis

DimensionElementDeleteDirect(DimName, ElName);

Argumento Descripción

DimName La dimensión que incluye el elemento que deseaeliminar.

ElName El elemento que desea eliminar.

Ejemplo

DimensionElementDeleteDirect('Region', 'Belgium');

Este ejemplo elimina el elemento Bélgica de la dimensión Región.

DimensionElementExistsDimensionElementExists determina si existe un elemento específico en una dimensión en el servidor enque se ejecuta un proceso de TurboIntegrator. La función devuelve 1 si el elemento existe en el servidor,de lo contrario, devuelve 0.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DimensionElementExists(DimName, ElName);

Argumento Descripción

DimName La dimensión que incluye el elemento que deseabuscar. La dimensión debe existir en el servidor enque se ejecuta el proceso de TurboIntegrator.

ElName El elemento que desea buscar.

Ejemplo

Este ejemplo determina si el elemento Belgium existe en la dimensión Region en el servidor.

DimensionElementExists('Region', 'Belgium');

Capítulo 5. funciones de TurboIntegrator 311

DimensionElementInsertDimensionElementInsert añade un elemento a una dimensión. Puede utilizar esta función para añadirelementos consolidados, numéricos o de cadena. No puede utilizar esta función en el procedimiento deDatos o Epílogo de un proceso TurboIntegrator.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DimensionElementInsert(DimName, InsertionPoint, ElName,ElType);

Argumento Descripción

DimName La dimensión en la que desea añadir un elemento.

InsertionPoint Un elemento de dimensión existente. El elementoque se añade a la dimensión se insertaráinmediatamente antes de este elemento existente.Si este parámetro es una serie vacía (''), elelemento nuevo se añade al final de la dimensión.

ElName El nombre que desea asignar al elemento nuevo.

ElType El tipo de elemento. Hay tres posibles valores deElType:

N: equivale a un elemento numérico.

S: equivale a un elemento de cadena.

C: equivale a un elemento consolidado.

Ejemplo

DimensionElementInsert('Region','Belgium','Netherlands','S');

Este ejemplo añade el elemento de cadena Netherlands a la dimensión Region. Netherlands se añadeinmediatamente antes de Belgium en la dimensión.

Ejemplo con un punto de inserción vacío

DimensionElementInsert('Region','','Netherlands','S');

Este ejemplo añade el elemento de cadena Netherlands a la dimensión Region. Netherlands se añade alfinal de la dimensión.

DimensionElementInsertDirectDimensionElementInsertDirect suprime un elemento de una dimensión editando directamente ladimensión. Puede utilizar esta función para añadir elementos consolidados, numéricos o de cadena.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

El método predeterminado de editar una dimensión en TM1 es utilizar un patrón de edición de copiacompleta. En dicho patrón, se crea una copia de edición de la dimensión, las ediciones se aplican a lacopia de edición, y finalmente vuelve a escribirse la dimensión real utilizando la copia de edición comoplantilla. TurboIntegrator admite la edición automática de la copia completa siempre que se utilicenfunciones de TurboIntegrator para la edición de dimensiones (como DimensionElementInsert) en lapestaña de metadatos del proceso. TurboIntegrator crea automáticamente la copia de edición y le aplica

312 IBM Planning Analytics: Referencia de TM1

las operaciones de edición; a continuación vuelve a escribir la dimensión real al final del procedimientode metadatos.

Las ediciones directas son diferentes en tanto que no hay copia de edición. En su lugar, las operacionesse llevan a cabo directamente en la dimensión real. Existen dos casos de uso especializado y diferentepara los que está indicado este tipo de edición directa:

• Cuando el propósito del proceso TurboIntegrator es realizar un pequeño cambio en una dimensióngrande. En este caso, la edición directa será más eficaz porque evita la copia y la reescritura completade la dimensión grande.

• Cuando el propósito del proceso TurboIntegrator es cargar grandes volúmenes de datos en un cubo. Eneste caso, el procedimiento de Metadatos del proceso se mantiene deliberadamente vacío, y lainserción de cualquier elemento necesario para dar soporte a la carga de datos se realiza utilizandollamadas directas en el procedimiento de Datos. Cuando el procedimiento de Metadatos está vacío, elproceso se salta una repetición completa sobre el origen de datos externo, gracias a lo cual las cargasde datos pueden ser más rápidas.

Sintaxis

DimensionElementInsertDirect(DimName, InsertionPoint, ElName,ElType);

Argumento Descripción

DimName La dimensión a la que desea añadir un elementonuevo.

InsertionPoint Un elemento de dimensión existente. El elementoque se añade a la dimensión se insertaráinmediatamente antes de este elemento existente.Si este parámetro está vacío, el nuevo elemento seañade al final de la dimensión.

Observe que esta función está optimizada para loscasos en que se pasa InsertionPoint como cadenavacía.

ElName El nombre que desea asignar al nuevo elemento.

ElType El tipo de elemento. Hay tres posibles valores deElType:

N: equivale a un elemento numérico.

S: equivale a un elemento de cadena.

C: equivale a un elemento consolidado.

Ejemplo

DimensionElementInsertDirect('Region', 'Belgium', 'Netherlands','N');

Este ejemplo añade el elemento numérico Netherlands a la dimensión Region. Netherlands aparece justodelante de Belgium en la definición de dimensión.

DimensionElementPrincipalNameDimensionElementPrincipalName devuelve el nombre principal de un elemento o alias de elemento.

TurboIntegrator debe utilizar nombres de elementos principales al actualizar dimensiones; no puedenutilizarse alias de elementos. Esta función es útil para determinar nombres de elementos principales al

Capítulo 5. funciones de TurboIntegrator 313

tratar de actualizar una dimensión cuando solamente los alias de elementos están disponibles en elproceso TurboIntegrator.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DimensionElementPrincipalName( DimName, ElName )

Argumento Descripción

DimName El nombre de la dimensión de la que desearecuperar un nombre de elemento principal.

ElName Un nombre de elemento. ElName puede ser unalias de elemento o un nombre de elementoprincipal.

Ejemplo

Si ElName no se encuentra actualmente en la versión guardada de DimName, la función devuelveEIName.

Si ElName se encuentra en DimName, ya sea como alias de elemento o como nombre de elementoprincipal, devuelve el nombre principal del elemento.

DimensionExistsDimensionExists determina si existe una dimensión específica en el servidor desde el que se ejecuta unproceso TurboIntegrator. La función devuelve 1 si la dimensión existe en el servidor; de lo contrario,devuelve 0.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DimensionExists(DimName);

Argumento Descripción

DimName El nombre de la dimensión cuya existencia deseaconfirmar.

Ejemplo

DimensionExists('Región');

Este ejemplo determina si existe la dimensión Región en el servidor.

DimensionHierarchyCreateDimensionHierarchyCreate crea una nueva jerarquía en una dimensión existente. La jerarquía no puedetener el mismo nombre que la dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DimensionHierarchyCreate(DimName, HierName);

314 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

DimName El nombre de la dimensión existente quecontendrá la jerarquía.

HierName El nombre que desea asignar a la jerarquía. Nopuede utilizar el nombre de la dimensión.

Ejemplo

DimensionHierarchyCreate('Vehicles', 'Trucks');

Este ejemplo crea la jerarquía Trucks vacía en la dimensión Vehicles.

DimensionSortOrderDimensionSortOrder establece un sentido y un tipo de ordenación de los elementos de la dimensión y delos componentes de los elementos consolidados de una dimensión. El orden de clasificación definido porDimensionSortOrder determina cómo aparecerá el subconjunto en el Editor de subconjuntos.

DimensionSortOrder establece propiedades de una dimensión; la dimensión no se ordena realmentehasta que se guarda en el servidor.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DimensionSortOrder(DimName, CompSortType, CompSortSense, ElSortType , ElSortSense);

Argumento Descripción

DimName El nombre de la dimensión para la que deseaestablecer un orden de clasificación.

CompSortType Define el modo en que los componentes de loselementos consolidados aparecen en la dimensión.Existen dos valores de CompSortType:

ByInput: conserva el orden en que loscomponentes se insertaron originalmente en lasconsolidaciones.

ByName: ordena los componentes de lasconsolidaciones por el nombre.

CompSortSense Define el sentido de la ordenación de loscomponentes de las consolidaciones. Se trata deun argumento necesario, pero únicamente seaplica cuando CompSortType es ByName. Hay dosposibles valores de CompSortSense:

Ascending: ordena los componentes de lasconsolidaciones en orden alfabético ascendente.

Descending: ordena los componentes de lasconsolidaciones en orden alfabético descendente.

Capítulo 5. funciones de TurboIntegrator 315

Argumento Descripción

ElSortType Define un orden de clasificación para loselementos de la dimensión. Hay cuatro posiblesvalores de ElSortType:

ByInput: conserva al orden en que los elementosse insertaron originalmente en la dimensión.

ByName: ordena los elementos de la dimensiónpor el nombre.

ByLevel: ordena los elementos de la dimensión porel nivel.

ByHierarchy: ordena los elementos de ladimensión por la jerarquía.

ElSortSense Define el sentido de la ordenación de loselementos de la dimensión. Se trata de unargumento necesario, pero se aplica únicamentecuando ElSortType es ByName o ByLevel. Hay dosposibles valores de ElSortSense:

Ascending: ordena los elementos de la dimensiónen orden ascendente, ya sea alfabéticamente o porel nivel.

Descending: ordena los elementos de la dimensiónen orden descendente, ya sea alfabéticamente opor el nivel.

Ejemplo

DimensionSortOrder ('Región', 'ByName', 'Descending', 'ByLevel','Ascending');

Este ejemplo establece un orden de clasificación para la dimensión Región. Todos los elementos de ladimensión se clasifican en orden ascendente por el nivel, y los componentes de las consolidaciones seclasifican en orden alfabético descendente.

DimensionTimeLastUpdatedDimensionTimeLastUpdated devuelve un valor de serie que indica la fecha y hora de la últimaactualización de un cubo especificado.

El valor de serie devuelto por esta función utiliza una fecha de inicio de Jan 1 1900 12:00:00 A.M.,equivalente al valor 1.0. Las fechas se representan como enteros, mientras que las horas se representancomo números decimales entre .0 y .999999. Esto es coherente con la manera en que se almacenan ynotifican los valores de serie de fecha y hora en Microsoft Excel.

Nota: De forma predeterminada, los valores de serie de fecha y hora de TM1 utilizan una hora de inicio deJan 1 1960 12:00:00 A.M. Para resolver la incoherencia entre los valores de serie de fecha y hora deExcel y TM1, puede establecer UseExcelSerialDate=T en el archivo Tm1s.cfg para indicar al servidorTM1 que utilice los valores de serie de fecha y hora que cumplen los estándares de Excel.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DimensionTimeLastUpdated(dimension);

316 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

dimension Nombre de la dimensión.

Ejemplo

DimensionTimeLastUpdated('Region');

Este ejemplo devuelve información sobre cuándo se actualizó por última vez la dimensión Region.

DimensionTopElementInsertDimensionTopElementInsert crea un elemento raíz en una dimensión. Si la dimensión ya tiene una solaraíz, este elemento no se creará.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DimensionTopElementInsert(DimName, InsertionPoint, ElName);

Argumento Descripción

DimName La dimensión para la que desea crear un elementoraíz.

InsertionPoint Un elemento de dimensión existente. El elementoraíz que se añade a la dimensión se insertaráinmediatamente antes de este elemento existente.

ElName El nombre que desea asignar al nuevo elementoraíz.

Ejemplo

DimensionTopElementInsert('Region', 'Netherlands', 'World');

Este ejemplo añade el elemento raíz World a la dimensión Region. World aparece inmediatamente antesde Netherlands en la definición de dimensión.

DimensionTopElementInsertDirectDimensionTopElementInsertDirect crea un elemento raíz en una dimensión editando directamente ladimensión. Si la dimensión ya tiene una sola raíz, este elemento no se creará.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

El método predeterminado para editar una dimensión en TM1 es utilizar un patrón de edición de copiacompleta. En dicho patrón, se crea una copia de edición de la dimensión, las ediciones se aplican a lacopia de edición, y finalmente vuelve a escribirse la dimensión real utilizando la copia de edición comoplantilla. TurboIntegrator admite la edición automática de la copia completa siempre que se utilicenfunciones de TurboIntegrator para la edición de dimensiones (como DimensionTopElementInsert) en elprocedimiento de metadatos del proceso. TurboIntegrator crea automáticamente la copia de edición y leaplica las operaciones de edición; a continuación vuelve a escribir la dimensión real al final delprocedimiento de metadatos.

Las ediciones directas son diferentes en tanto que no hay copia de edición. En su lugar, las operacionesse llevan a cabo directamente en la dimensión real. Existen dos casos de uso especializado y diferentepara los que está indicado este tipo de edición directa:

Capítulo 5. funciones de TurboIntegrator 317

• Cuando el propósito del proceso TurboIntegrator es realizar un pequeño cambio en una dimensióngrande. En este caso, la edición directa será más eficaz porque evita la copia y la reescritura completade la dimensión grande.

• Cuando el propósito del proceso TurboIntegrator es cargar grandes volúmenes de datos en un cubo. Eneste caso, el procedimiento de Metadatos del proceso se mantiene deliberadamente vacío, y lamodificación de cualquier elemento necesario para dar soporte a la carga de datos se realiza utilizandollamadas directas en el procedimiento de Datos. Cuando el procedimiento de Metadatos está vacío, elproceso se salta una repetición completa sobre el origen de datos externo, gracias a lo cual las cargasde datos pueden ser más rápidas.

Sintaxis

DimensionTopElementInsertDirect(DimName, InsertionPoint, ElName);

Argumento Descripción

DimName La dimensión para la que desea crear un elementoraíz.

InsertionPoint Un elemento de dimensión existente. El elementoraíz que se añade a la dimensión se insertaráinmediatamente antes de este elemento existente.

ElName El nombre que desea asignar al nuevo elementoraíz.

Ejemplo

DimensionTopElementInsertDirect('Region', 'Netherlands', 'World');

Este ejemplo añade el elemento raíz World a la dimensión Region. World aparece inmediatamente antesde Netherlands en la definición de dimensión.

DimensionUpdateDirectDimensionUpdateDirect realiza una reescritura completa de una dimensión que ha sido objeto de unaedición directa en un proceso TurboIntegrator, principalmente compactando el espacio de memoria queocupa la dimensión.

Una dimensión que experimenta una serie de ediciones directas únicamente (eliminación de elementos,en particular) al final utilizará más memoria que su contraparte completamente reescrita. Esta funciónpuede utilizarse opcionalmente después de editar directamente una dimensión conDimensionElementInsertDirect, DimensionElementDeleteDirect,DimensionElementComponentAddDirect, DimensionElementComponentDeleteDirect y/oDimensionTopElementInsertDirect. La llamada a DimensionUpdateDirect supone un coste inicial dememoria de copia completa, pero se puede utilizar para garantizar que la dimensión está en su ocupaciónde memoria más bajo posible una vez finalizado el procesamiento.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DimensionUpdateDirect(DimName);

Argumento Descripción

DimName El nombre de la dimensión que desea reescribir.

318 IBM Planning Analytics: Referencia de TM1

Ejemplo

DimensionUpdateDirect('Region');

Este ejemplo reescribe la dimensión Región.

Funciones de TurboIntegrator de manipulación de jerarquíasEstas funciones facilitan la manipulación de jerarquías.

HierarchyContainsAllLeavesHierarchyContainsAllLeaves devuelve true solo si la jerarquía especificada contiene el conjunto completode elementos de hoja que se existen en la dimensión. Es decir, contiene todos los elementos de hoja quepueden verse en la jerarquía Leaves especial. Si en la jerarquía especificada falta uno o más elementos dehoja, esta función devuelve FALSE.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyContainsAllLeaves(DimName, HierName);

Argumento Descripción

DimName Nombre de la dimensión que contiene la jerarquíade todas las hojas.

HierName Nombre de la jerarquía que se va a determinarcomo jerarquía de todas las hojas.

Ejemplo

HierarchyContainsAllLeaves('Region', 'Leaves');

Este ejemplo determina si la jerarquía Leaves, de la dimensión Region, contiene todos los miembros dehoja.

HierarchyCreateHierarchyCreate crea una nueva jerarquía en una dimensión existente. La jerarquía no puede tener elmismo nombre que la dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyCreate(DimName, HierName);

Argumento Descripción

DimName El nombre de la dimensión existente quecontendrá la jerarquía.

HierName El nombre que desea asignar a la jerarquía. Nopuede utilizar el nombre de la dimensión.

Capítulo 5. funciones de TurboIntegrator 319

Ejemplo

HierarchyCreate('Vehicles', 'Trucks');

Este ejemplo crea la jerarquía Trucks vacía en la dimensión Vehicles.

HierarchyDeleteAllElementsHierarchyDeleteAllElements suprime todos los elementos de una jerarquía. Esta función resulta útil paravolver a crear jerarquías de dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyDeleteAllElements(DimName, HierName);

Argumento Descripción

DimName El nombre de la dimensión de la que deseaeliminar todos los elementos.

HierName Nombre de la jerarquía de la dimensión.

Ejemplo

HierarchyDeleteAllElements('Equipment','Helmets');

Este ejemplo suprime todos los elementos de la jerarquía Helmets de la dimensión Equipment.

HierarchyDeleteElementsHierarchyDeleteElements suprime los elementos de hoja de una jerarquía utilizando un subconjunto deelementos.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyDeleteElements (DimensionName, HierarchyName, Subset)

Argumento Descripción

DimensionName El nombre de la dimensión de la que deseasuprimir el subconjunto de elementos.

HierarchyName El nombre de la jerarquía de la que desea suprimirel subconjunto de elementos.

Si la jerarquía indicada es la jerarquía Hojas, elsubconjunto debería listar estas hojas que se hande suprimir y se eliminarán por completo de ladimensión.

Subconjunto La lista de elementos que se van a suprimir de lajerarquía indicada. El subconjunto suele sertemporal.

320 IBM Planning Analytics: Referencia de TM1

HierarchyDestroyHierarchyDestroy suprime una jerarquía de la base de datos de TM1.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyDestroy(DimName, HierName);

Argumento Descripción

DimName Nombre de la dimensión que contiene la jerarquía.

HierName Nombre de la jerarquía que desea suprimir.

Ejemplo

HierarchyDestroy('Product','Transmissions');

Este ejemplo suprime la jerarquía Transmissions de la base de datos de TM1.

HierarchyElementComponentAddHierarchyElementComponentAdd añade un componente (hijo) a un elemento consolidado. No puedeutilizar esta función en el procedimiento de Epílogo de un proceso TurboIntegrator.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyElementComponentAdd(DimName, HierName, ConsolidatedElName, ElName, ElWeight);

Argumento Descripción

DimName La dimensión padre del elemento consolidado alque desea añadir un hijo.

HierName Jerarquía de la dimensión especificada.

ConsolidatedElName El elemento al que desea añadir un hijo.

ElName El nombre del elemento hijo.

ElWeight El peso del elemento hijo.

EjemploHierarchyElementComponentAdd('Measures', 'Europe', 'Net Sales', 'Expenses',-1);

Este ejemplo añade el hijo Expenses a la consolidación Net Sales de la jerarquía Europe de la dimensiónMeasures. El hijo tiene un peso de -1 en la consolidación.

HierarchyElementComponentAddDirectHierarchyElementComponentAddDirect añade un componente (hijo) a un elemento consolidado editandodirectamente una dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Capítulo 5. funciones de TurboIntegrator 321

El método predeterminado de editar una dimensión en Cognos TM1 es utilizar un patrón de edición decopia completa. En dicho patrón, se crea una copia de edición de la dimensión, las ediciones se aplican ala copia de edición, y finalmente vuelve a escribirse la dimensión real utilizando la copia de edición comoplantilla. TurboIntegrator admite la edición automática de la copia completa siempre que se utilicenfunciones de TurboIntegrator para la edición de dimensiones (como HierarchyElementComponentAdd)en el procedimiento de metadatos del proceso. TurboIntegrator crea automáticamente la copia deedición y le aplica las operaciones de edición; a continuación vuelve a escribir la dimensión real al finaldel procedimiento de metadatos.

Las ediciones directas son diferentes en tanto que no hay copia de edición. En su lugar, las operacionesse llevan a cabo directamente en la dimensión real. Existen dos casos de uso especializado y diferentepara los que está indicado este tipo de edición directa:

• Cuando el propósito del proceso TurboIntegrator es realizar un pequeño cambio en una dimensióngrande. En este caso, la edición directa será más eficaz porque evita la copia y la reescritura completade la dimensión grande.

• Cuando el propósito del proceso TurboIntegrator es cargar grandes volúmenes de datos en un cubo. Eneste caso, el procedimiento de Metadatos del proceso se mantiene deliberadamente vacío, y lamodificación de cualquier elemento necesario para dar soporte a la carga de datos se realiza utilizandollamadas directas en el procedimiento de Datos. Cuando el procedimiento de Metadatos está vacío, elproceso se salta una repetición completa sobre el origen de datos externo, gracias a lo cual las cargasde datos pueden ser más rápidas.

Sintaxis

HierarchyElementComponentAddDirect(DimName, HierName, ConsolidatedElName, ElName, ElWeight);

Argumento Descripción

DimName La dimensión padre del elemento consolidado alque desea añadir un hijo.

HierName Jerarquía de la dimensión especificada.

ConsolidatedElName El elemento consolidado al que desea añadir unhijo.

ElName El nombre del elemento hijo.

ElWeight El peso del elemento hijo.

EjemploHierarchyElementComponentAddDirect('Measures', 'Europe', 'Net Sales','Expenses', -1);

Este ejemplo añade el hijo Expenses a la consolidación Net Sales de la jerarquía Europe de la dimensiónMeasures. El hijo tiene un peso de -1 en la consolidación.

HierarchyElementComponentDeleteHierarchyElementComponentDelete elimina un componente (hijo) de un elemento consolidado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyElementComponentDelete(DimName, HierName, ConsolidatedElName, ElName);

322 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

DimName La dimensión padre del elemento consolidado delque desea eliminar un hijo.

HierName Nombre de la jerarquía de la dimensión.

ConsolidatedElName El elemento consolidado del que desea eliminar unhijo.

ElName El nombre del elemento hijo que desea eliminar.

Ejemplo

HierarchyElementComponentDelete('Region', 'Western', 'Benelux', 'Belgium');

Este ejemplo suprime el hijo Belgium de la consolidación Benelux de la jerarquía Western de la dimensiónRegion.

HierarchyElementComponentDeleteDirectHierarchyElementComponentDeleteDirect suprime un componente (hijo) de un elemento consolidadoeditando directamente la dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

El método predeterminado de editar una dimensión en TM1 es utilizar un patrón de edición de copiacompleta. En dicho patrón, se crea una copia de edición de la dimensión, las ediciones se aplican a lacopia de edición, y finalmente vuelve a escribirse la dimensión real utilizando la copia de edición comoplantilla. TurboIntegrator admite la edición automática de la copia completa siempre que se utilicenfunciones de TurboIntegrator para la edición de dimensiones (como HierarchyElementComponentDelete)en el procedimiento de metadatos del proceso. TurboIntegrator crea automáticamente la copia deedición y le aplica las operaciones de edición; a continuación vuelve a escribir la dimensión real al finaldel procedimiento de metadatos.

Las ediciones directas son diferentes en tanto que no hay copia de edición. En su lugar, las operacionesse llevan a cabo directamente en la dimensión real. Existen dos casos de uso especializado y diferentepara los que está indicado este tipo de edición directa:

• Cuando el propósito del proceso TurboIntegrator es realizar un pequeño cambio en una dimensióngrande. En este caso, la edición directa será más eficaz porque evita la copia y la reescritura completade la dimensión grande.

• Cuando el propósito del proceso TurboIntegrator es cargar grandes volúmenes de datos en un cubo. Eneste caso, el procedimiento de Metadatos del proceso se mantiene deliberadamente vacío, y lamodificación de cualquier elemento necesario para dar soporte a la carga de datos se realiza utilizandollamadas directas en el procedimiento de Datos. Cuando el procedimiento de Metadatos está vacío, elproceso se salta una repetición completa sobre el origen de datos externo, gracias a lo cual las cargasde datos pueden ser más rápidas.

Sintaxis

HierarchyElementComponentDeleteDirect(DimName, HierName, ConsolidatedElName, ElName);

Argumento Descripción

DimName La dimensión padre del elemento consolidado delque desea eliminar un hijo.

Capítulo 5. funciones de TurboIntegrator 323

Argumento Descripción

HierName Nombre de la jerarquía de la dimensión.

ConsolidatedElName El elemento consolidado del que desea eliminar unhijo.

ElName El nombre del elemento hijo que desea eliminar.

Ejemplo

HierarchyElementComponentDeleteDirect('Region', 'Western', 'Benelux', 'Belgium');

Este ejemplo suprime el hijo Belgium de la consolidación Benelux de la jerarquía Western de la dimensiónRegion.

HierarchyElementDeleteHierarchyElementDelete elimina un elemento de una jerarquía.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyElementDelete(DimName, HierName, ElName);

Argumento Descripción

DimName La dimensión que incluye el elemento que deseaeliminar.

HierName Nombre de la jerarquía de la dimensión.

ElName El elemento que desea suprimir de la jerarquía.

Ejemplo

HierarchyElementDelete('Region', 'Western', 'Belgium');

Este ejemplo suprime el elemento Belgium de la jerarquía Western de la dimensión Region.

HierarchyElementDeleteDirectHierarchyElementDeleteDirect suprime un elemento de una dimensión editando directamente ladimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Nota: Al borrar un elemento se borran todos los datos del cubo identificados por dicho elemento.

El método predeterminado para editar una dimensión en TM1 es utilizar un patrón de edición de copiacompleta. En dicho patrón, se crea una copia de edición de la dimensión, las ediciones se aplican a lacopia de edición, y finalmente vuelve a escribirse la dimensión real utilizando la copia de edición comoplantilla. TurboIntegrator admite la edición automática de la copia completa siempre que se utilicenfunciones de TurboIntegrator para la edición de dimensiones (como DimensionElementDelete) en elprocedimiento de metadatos del proceso. TurboIntegrator crea automáticamente la copia de edición y leaplica las operaciones de edición; a continuación vuelve a escribir la dimensión real al final delprocedimiento de metadatos.

324 IBM Planning Analytics: Referencia de TM1

Las ediciones directas son diferentes en tanto que no hay copia de edición. En su lugar, las operacionesse llevan a cabo directamente en la dimensión real. Existen dos casos de uso especializado y diferentepara los que está indicado este tipo de edición directa:

• Cuando el propósito del proceso TurboIntegrator es realizar un pequeño cambio en una dimensióngrande. En este caso, la edición directa será más eficaz porque evita la copia y la reescritura completade la dimensión grande.

• Cuando el propósito del proceso TurboIntegrator es cargar grandes volúmenes de datos en un cubo. Eneste caso, el procedimiento de Metadatos del proceso se mantiene deliberadamente vacío, y lamodificación de cualquier elemento necesario para dar soporte a la carga de datos se realiza utilizandollamadas directas en el procedimiento de Datos. Cuando el procedimiento de Metadatos está vacío, elproceso se salta una repetición completa sobre el origen de datos externo, gracias a lo cual las cargasde datos pueden ser más rápidas.

Sintaxis

HierarchyElementDeleteDirect(DimName, HierName, ElName);

Argumento Descripción

DimName La dimensión que incluye el elemento que deseaeliminar.

HierName Nombre de la jerarquía de la dimensión.

ElName El elemento que desea eliminar.

Ejemplo

HierarchyElementDeleteDirect('Region', 'Western', 'Belgium');

Este ejemplo suprime el elemento Belgium de la jerarquía Western de la dimensión Region.

HierarchyElementExistsHierarchyElementExists determina si existen elementos específicos en una jerarquía en el servidor desdeel que se ejecuta un proceso de TurboIntegrator. La función devuelve 1 si los elementos existen en lajerarquía en el servidor, de lo contrario, devuelve 0.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyElementExists(DimName, HierName, ElemName);

Argumento Descripción

DimName El nombre de la dimensión que contiene elelemento cuya existencia desea confirmar.

HierName Nombre de la jerarquía de la dimensión.

ElName El elemento que desea buscar en la jerarquía.

Capítulo 5. funciones de TurboIntegrator 325

Ejemplo

HierarchyElementExists('Region', 'Western', 'Belgium');

Este ejemplo determina si existe el elemento Belgium de la jerarquía Western de la dimensión Region enel servidor.

HierarchyElementInsertHierarchyElementInsert añade un elemento a una dimensión. Puede utilizar esta función para añadirelementos consolidados, numéricos o de cadena. No puede utilizar esta función en el procedimiento deDatos o Epílogo de un proceso TurboIntegrator.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyElementInsert(DimName, HierName, InsertionPoint, ElName, ElType);

Argumento Descripción

DimName La dimensión a la que desea añadir un elementonuevo.

HierName Nombre de la jerarquía de la dimensión.

InsertionPoint Un elemento de dimensión existente. El elementoque se añade a la dimensión se insertaráinmediatamente antes de este elemento existente.Si este parámetro está vacío, el nuevo elemento seañade al final de la dimensión.

ElName El nombre que desea asignar al nuevo elemento.

ElType El tipo de elemento. Hay tres posibles valores deElType:

N: equivale a un elemento numérico.

S: equivale a un elemento de cadena.

C: equivale a un elemento consolidado.

Ejemplo

HierarchyElementInsert('Region', 'Western', 'Belgium', 'Netherlands','N');

Este ejemplo añade el elemento numérico Netherlands a la jerarquía Western de la dimensión Region.Netherlands aparece inmediatamente antes de Belgium en la definición de dimensión.

HierarchyElementInsertDirectHierarchyElementInsertDirect añade un elemento a una dimensión editando directamente la dimensión.Puede utilizar esta función para añadir elementos consolidados, numéricos o de cadena.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

El método predeterminado para editar una dimensión en TM1 es utilizar un patrón de edición de copiacompleta. En dicho patrón, se crea una copia de edición de la dimensión, las ediciones se aplican a lacopia de edición, y finalmente vuelve a escribirse la dimensión real utilizando la copia de edición comoplantilla. TurboIntegrator admite la edición automática de la copia completa siempre que se utilicen

326 IBM Planning Analytics: Referencia de TM1

funciones de TurboIntegrator para la edición de dimensiones (como HierarchyElementInsert) en lapestaña de metadatos del proceso. TurboIntegrator crea automáticamente la copia de edición y le aplicalas operaciones de edición; a continuación vuelve a escribir la dimensión real al final del procedimientode metadatos.

Las ediciones directas son diferentes en tanto que no hay copia de edición. En su lugar, las operacionesse llevan a cabo directamente en la dimensión real. Existen dos casos de uso especializado y diferentepara los que está indicado este tipo de edición directa:

• Cuando el propósito del proceso TurboIntegrator es realizar un pequeño cambio en una dimensióngrande. En este caso, la edición directa será más eficaz porque evita la copia y la reescritura completade la dimensión grande.

• Cuando el propósito del proceso TurboIntegrator es cargar grandes volúmenes de datos en un cubo. Eneste caso, el procedimiento de Metadatos del proceso se mantiene deliberadamente vacío, y lainserción de cualquier elemento necesario para dar soporte a la carga de datos se realiza utilizandollamadas directas en el procedimiento de Datos. Cuando el procedimiento de Metadatos está vacío, elproceso se salta una repetición completa sobre el origen de datos externo, gracias a lo cual las cargasde datos pueden ser más rápidas.

Sintaxis

HierarchyElementInsertDirect(DimName, HierName, InsertionPoint, ElName, ElType);

Argumento Descripción

DimName La dimensión a la que desea añadir un elementonuevo.

HierName Nombre de la jerarquía de la dimensión.

InsertionPoint Un elemento de dimensión existente. El elementoque se añade a la dimensión se insertaráinmediatamente antes de este elemento existente.Si este parámetro está vacío, el nuevo elemento seañade al final de la dimensión.

Observe que esta función está optimizada para loscasos en que se pasa InsertionPoint como cadenavacía.

ElName El nombre que desea asignar al nuevo elemento.

ElType El tipo de elemento. Hay tres posibles valores deElType:

N: equivale a un elemento numérico.

S: equivale a un elemento de cadena.

C: equivale a un elemento consolidado.

Ejemplo

HierarchyElementInsertDirect('Region', 'Western', 'Belgium', 'Netherlands','N');

Este ejemplo añade el elemento numérico Netherlands a la jerarquía Western de la dimensión Region.Netherlands aparece justo delante de Belgium en la definición de dimensión.

Capítulo 5. funciones de TurboIntegrator 327

HierarchyElementPrincipalNameHierarchyElementPrincipalName devuelve el nombre principal de un elemento o alias de elemento.

TurboIntegrator debe utilizar nombres de elementos principales al actualizar dimensiones; no puedenutilizarse alias de elementos. Por tanto, esta función es útil para determinar nombres de elementosprincipales al tratar de actualizar una dimensión cuando solamente los alias de elementos estándisponibles en el proceso TurboIntegrator.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyElementPrincipalName( DimName, HierName, ElName )

Argumento Descripción

DimName El nombre de la dimensión de la que desearecuperar un nombre de elemento principal.

HierName Nombre de la jerarquía de la dimensión.

ElName Un nombre de elemento. ElName puede ser unalias de elemento o un nombre de elementoprincipal.

Ejemplo

Si ElName no se encuentra actualmente en la versión guardada de DimName, la función devuelveEIName.

Si ElName se encuentra en DimName, ya sea como alias de elemento o como nombre de elementoprincipal, devuelve el nombre principal del elemento.

HierarchyExistsHierarchyExists determina si existe una jerarquía específica en el servidor en el que se ejecuta un procesoTurboIntegrator. La función devuelve 1 si la jerarquía existe en el servidor; de lo contrario, devuelve 0.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyExists(DimName, HierName);

Argumento Descripción

DimName El nombre de la dimensión que contiene lajerarquía cuya existencia desea confirmar.

HierName Nombre de la jerarquía de la dimensión.

Ejemplo

HierarchyExists('Region', 'Europe');

Este ejemplo determina si la jerarquía Europe, de la dimensión Region, existe en el servidor.

328 IBM Planning Analytics: Referencia de TM1

HierarchyHasOrphanedLeavesHierarchyHasOrphanedLeaves devuelve 1 si hay uno o más elementos en la jerarquía especificada que noson componentes de un elemento padre en esa jerarquía.

La función devuelve 1 si existe la jerarquía en el servidor, de lo contrario, devuelve 0. Esta funcióndevuelve 0 si todos los elementos hoja de la jerarquía son un componente de uno o varios elementospadre. Los valores almacenados en estos elementos no se añadirán.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyHasOrphanedLeaves(DimName, HierName);

Argumento Descripción

DimName Nombre de la dimensión que contiene la jerarquíaque se va revisar.

HierName Nombre de la jerarquía que se va a revisar para versi contiene miembros de hoja huérfanos.

Ejemplo

HierarchyHasOrphanedLeaves('Region', 'Europe');

Este ejemplo determina si la jerarquía Europe, de la dimensión Region, contiene hojas huérfanas.

HierarchySortOrderHierarchySortOrder establece un sentido y un tipo de ordenación de los elementos de la dimensión y delos componentes de los elementos consolidados de una dimensión. El orden de clasificación definido porDimensionSortOrder determina cómo aparecerá el subconjunto en el Editor de subconjuntos.

DimensionSortOrder establece propiedades de una dimensión; la dimensión no se ordena realmentehasta que se guarda en el servidor.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchySortOrder(DimName, HierName, CompSortType, CompSortSense,ElSortType , ElSortSense);

Argumento Descripción

DimName El nombre de la dimensión para la que deseaestablecer un orden de clasificación.

HierName Nombre de la jerarquía de la dimensión.

Capítulo 5. funciones de TurboIntegrator 329

Argumento Descripción

CompSortType Define el modo en que los componentes de loselementos consolidados aparecen en la dimensión.Existen dos valores de CompSortType:

ByInput: conserva el orden en que loscomponentes se insertaron originalmente en lasconsolidaciones.

ByName: ordena los componentes de lasconsolidaciones por el nombre.

CompSortSense Define el sentido de la ordenación de loscomponentes de las consolidaciones. Se trata deun argumento necesario, pero únicamente seaplica cuando CompSortType es ByName. Hay dosposibles valores de CompSortSense:

Ascending: ordena los componentes de lasconsolidaciones en orden alfabético ascendente.

Descending: ordena los componentes de lasconsolidaciones en orden alfabético descendente.

ElSortType Define un orden de clasificación para loselementos de la dimensión. Hay cuatro posiblesvalores de ElSortType:

ByInput: conserva al orden en que los elementosse insertaron originalmente en la dimensión.

ByName: ordena los elementos de la dimensiónpor el nombre.

ByLevel: ordena los elementos de la dimensión porel nivel.

ByHierarchy: ordena los elementos de ladimensión por la jerarquía.

ElSortSense Define el sentido de la ordenación de loselementos de la dimensión. Se trata de unargumento necesario, pero se aplica únicamentecuando ElSortType es ByName o ByLevel. Hay dosposibles valores de ElSortSense:

Ascending: ordena los elementos de la dimensiónen orden ascendente, ya sea alfabéticamente o porel nivel.

Descending: ordena los elementos de la dimensiónen orden descendente, ya sea alfabéticamente opor el nivel.

Ejemplo

HierarchySortOrder ('Region', 'Europe', 'ByName', 'Descending','ByLevel', 'Ascending');

330 IBM Planning Analytics: Referencia de TM1

Este ejemplo establece un orden de clasificación para la jerarquía Europe de la dimensión Region. Todoslos elementos de la dimensión se clasifican en orden ascendente por el nivel, y los componentes de lasconsolidaciones se clasifican en orden alfabético descendente.

HierarchyTimeLastUpdatedHierarchyTimeLastUpdated indica cuándo se actualizó por última vez una jerarquía de dimensiónespecificada. La función devuelve un número real que representa el día actual (con las horas, los minutos,los segundos y los milisegundos) desde el principio del año 1900.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyTimeLastUpdated(dimension, hierarchy);

Argumento Descripción

dimension Nombre de la dimensión.

hierarchy Nombre de la jerarquía.

Ejemplo

HierarchyTimeLastUpdated('Region', 'Europe');

Este ejemplo devuelve información sobre cuándo se actualizó por última vez la jerarquía Europe de ladimensión Region. Si se devuelve un valor de 42548.<horas>.<minutos>.<milisegundos>, puede dividir42548 entre 365, con lo que se obtiene 116 (aproximadamente). Si se suma al año inicial, 1900, elresultado es el año actual, 2016.

HierarchyTopElementInsertHierarchyTopElementInsert crea un elemento raíz en una dimensión. Si la dimensión ya tiene una solaraíz, este elemento no se creará.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyTopElementInsert(DimName, HierName, InsertionPoint, ElName);

Argumento Descripción

DimName La dimensión para la que desea crear un elementoraíz.

HierName Nombre de la jerarquía de la dimensión.

InsertionPoint Un elemento de dimensión existente. El elementoraíz que se añade a la dimensión se insertaráinmediatamente antes de este elemento existente.

ElName El nombre que desea asignar al nuevo elementoraíz.

Capítulo 5. funciones de TurboIntegrator 331

Ejemplo

HierarchyTopElementInsert('Region', 'Western', 'Netherlands', 'World');

Este ejemplo añade el elemento raíz World a la jerarquía Western de la dimensión Region. Mundo apareceinmediatamente antes de Países Bajos en la definición de dimensión.

HierarchyTopElementInsertDirectHierarchyTopElementInsertDirect crea un elemento raíz en una dimensión editando directamente ladimensión. Si la dimensión ya tiene una sola raíz, este elemento no se creará.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

El método predeterminado para editar una dimensión en TM1 es utilizar un patrón de edición de copiacompleta. En dicho patrón, se crea una copia de edición de la dimensión, las ediciones se aplican a lacopia de edición, y finalmente vuelve a escribirse la dimensión real utilizando la copia de edición comoplantilla. TurboIntegrator admite la edición automática de la copia completa siempre que se utilicenfunciones de TurboIntegrator para la edición de dimensiones (como HierarchyTopElementInsert) en elprocedimiento de metadatos del proceso. TurboIntegrator crea automáticamente la copia de edición y leaplica las operaciones de edición; a continuación vuelve a escribir la dimensión real al final delprocedimiento de metadatos.

Las ediciones directas son diferentes en tanto que no hay copia de edición. En su lugar, las operacionesse llevan a cabo directamente en la dimensión real. Existen dos casos de uso especializado y diferentepara los que está indicado este tipo de edición directa:

• Cuando el propósito del proceso TurboIntegrator es realizar un pequeño cambio en una dimensióngrande. En este caso, la edición directa será más eficaz porque evita la copia y la reescritura completade la dimensión grande.

• Cuando el propósito del proceso TurboIntegrator es cargar grandes volúmenes de datos en un cubo. Eneste caso, el procedimiento de Metadatos del proceso se mantiene deliberadamente vacío, y lamodificación de cualquier elemento necesario para dar soporte a la carga de datos se realiza utilizandollamadas directas en el procedimiento de Datos. Cuando el procedimiento de Metadatos está vacío, elproceso se salta una repetición completa sobre el origen de datos externo, gracias a lo cual las cargasde datos pueden ser más rápidas.

Sintaxis

HierarchyTopElementInsertDirect(DimName, HierName, InsertionPoint, ElName);

Argumento Descripción

DimName La dimensión para la que desea crear un elementoraíz.

HierName Nombre de la jerarquía de la dimensión.

InsertionPoint Un elemento de dimensión existente. El elementoraíz que se añade a la dimensión se insertaráinmediatamente antes de este elemento existente.

ElName El nombre que desea asignar al nuevo elementoraíz.

Ejemplo

HierarchyTopElementInsertDirect('Region', 'Western', 'Netherlands', 'World');

332 IBM Planning Analytics: Referencia de TM1

Este ejemplo añade el elemento raíz World a la jerarquía Western de la dimensión Region. Mundo apareceinmediatamente antes de Países Bajos en la definición de dimensión.

HierarchyUpdateDirectHierarchyUpdateDirect realiza una reescritura completa de una jerarquía que ha sido objeto de unaedición directa en un proceso TurboIntegrator, básicamente compactando el espacio que ocupa lamemoria de la jerarquía.

Una dimensión que experimenta una serie de ediciones directas únicamente (eliminación de elementos,en particular) al final utilizará más memoria que su contraparte completamente reescrita. Esta funciónpuede utilizarse opcionalmente después de editar directamente una dimensión conHierarchyElementInsertDirect, HierarchyElementDeleteDirect, HierarchyElementComponentAddDirect,HierarchyElementComponentDeleteDirect o HierarchyTopElementInsertDirect. La llamada aHierarchyUpdateDirect supone un coste inicial de copia completa de la memoria, pero se puede utilizarpara garantizar que la dimensión está en su nivel ocupación de memoria más bajo posible una vezfinalizado el procesamiento.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyUpdateDirect(DimName, HierName);

Argumento Descripción

DimName El nombre de la dimensión que desea reescribir.

HierName Nombre de la jerarquía de la dimensión.

Ejemplo

HierarchyUpdateDirect('Region', 'Western');

Este ejemplo vuelve a escribir jerarquía Western de la dimensión Region.

Funciones de TurboIntegrator de ODBCEstas funciones facilitan la manipulación de ODBC.

ODBCCloseODBCClose cierra una conexión con un origen de datos ODBC.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ODBCClose(Source);

Argumento Descripción

Source El nombre de un origen de datos ODBC abierta.

Ejemplo

ODBCClose('Contabilidad');

Capítulo 5. funciones de TurboIntegrator 333

Este ejemplo cierra la conexión al origen ODBC Contabilidad.

ODBCOpenODBCOpen abre un origen de datos ODBC para la salida.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ODBCOpen(Source, ClientName, Password);

Argumento Descripción

Source Un nombre de origen de datos ODBC.

ClientName Un cliente válido en el origen de datos.

Password Una contraseña para ClientName.

Ejemplo

ODBCOpen('Contabilidad', 'Jdoe', 'Bstone');

Este ejemplo abre el origen de datos ODBC Contabilidad para el cliente Jdoe mediante la contraseñaBstone.

ODBCOPENExODBCOPENEx abre un origen de datos ODBC de salida especificando que la conexión debe abrirse comouna conexión Unicode.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

El formato es: ODBCOPENEx (nombre del conjunto de datos, nombre del cliente del conjunto de datos,contraseña del cliente, (distintivo de interfaz Unicode))

ODBCOpenEx(Source, ClientName, Password, UseUnicodeODBC);

Argumento Descripción

Source Un nombre de origen de datos ODBC.

ClientName Un cliente válido en el origen de datos.

Contraseña Una contraseña para ClientName.

UseUnicodeODBC Define el tipo de conexión Unicode que se va autilizar.

Ejemplo

ODBCOpenEx( TestTable, sa, , 1 );

chinese= ;chinese = CHARW( 37123 );fieldval = chinese | SomeNewText;

334 IBM Planning Analytics: Referencia de TM1

sql = Update TestTable set ForeName = N | fieldval | WHERE CustomerId = 1ODBCOUTPUT( Unicode, sql );

La sentencia SQL que aparece como resultado es:

Update TestTable set ForeName = N?SomeNewText WHERE CustomerId = 1

ODBCOutputODBCOutput ejecuta una consulta de actualización SQL a un origen de datos ODBC abierto. Debe utilizarla función ODBCOpen para abrir el origen de datos antes de llamar a ODBCOutput, y utilizar ODBCClosepara cerrar el origen de datos antes de salir del proceso.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ODBCOutput(Source, SQLQuery, [SQLQuery2, SQLQuery3, ...]);

Argumento Descripción

Source El origen de datos ODBC en el que desea realizaruna consulta.

SQLQuery Una sentencia de consulta SQL.

Aunque ODBCOutput se desarrolló para actualizartablas, puede utilizarse para ejecutar cualquierconsulta SQL en el origen de datos.

En circunstancias en las que la sentencia deconsulta SQL supera los 255 caracteres, debedividir la consulta en varios argumentos SQLQuery(SQLQuery2, SQLQuery3, etc.). Esto le permitecrear sentencias de consulta que superan el límitede 255 caracteres de los argumentosTurboIntegrator. Cuando se ejecuta la funciónODBCOutput, se concatenan todos los argumentosSQLQuery y se realiza la consulta de formacorrecta.

Ejemplo

ODBCOutput('Accounting', 'INSERT [CategoryID], [CategoryName]FROM Categories;');

Este ejemplo ejecuta la consulta especificada con el origen de datos Contabilidad.

SetODBCUnicodeInterfaceSetODBCUnicodeInterface establece si la interfaz ODBC debe utilizar las funciones de todo Unicode o lasfunciones de caracteres de un solo byte habituales. Si establece esta función en 1, utilizará la interfazODBC de caracteres "comodín".

Algunos controladores ODBC soportan la interfaz de un solo byte más antigua, así como una interfaz de'caracteres comodín' de estilo Unicode, donde los caracteres pasan y se recuperan como cantidades de16 bits. Si el controlador seleccionado no soporta uno u otro estilo, se proporcionará un distintivo paraobligar a TurboIntegrator a utilizar un estilo de interfaz particular.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Capítulo 5. funciones de TurboIntegrator 335

Sintaxis

SetODBCUnicodeInterface=1

Argumento Descripción

1 Utilice la interfaz ODBC de caracteres "comodín".

0 Utilice la interfaz de un solo byte.

Funciones de TurboIntegrator de control de procesosEstas funciones pertenecen al control de procesos.

ExecuteCommandExecuteCommand ejecuta una línea de mandatos durante un proceso. Puede utilizar ExecuteCommandpara ejecutar una aplicación de escritorio, pero no un servicio.

Si utiliza ExecuteCommand para ejecutar un ejecutable, se aplican las siguientes condiciones:

• Si el argumento CommandLine únicamente especifica el nombre de un archivo que se ejecutará, unservidor Windows buscará el archivo tanto en el directorio de bases de datos del servidor como en eldirectorio en el que está ubicado Tm1s.exe. Un servidor UNIX busca el archivo únicamente en eldirectorio de bases de datos del servidor.

• Si el argumento CommandLine utiliza un prefijo de ruta relativo, tanto el servidor Windows como elservidor UNIX tratan de localizar el archivo únicamente en el directorio de bases de datos del servidor.

• En el servidor Microsoft Windows o UNIX puede pasar una ruta absoluta al argumento CommandLinepara ejecutar un archivo en cualquier ubicación.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ExecuteCommand(CommandLine, Wait);

Argumento Descripción

CommandLine La línea de comandos que desea ejecutar.

Wait Indica si el proceso debe esperar a que elcomando finalice la ejecución antes de continuarcon la siguiente sentencia del proceso. Un valor deargumento de 0 hace que el proceso realice lasiguiente sentencia sin esperar a que se ejecute lalínea de comandos. Un valor de argumento de 1hace que el proceso espere a que la línea decomandos se ejecute de forma correcta antes decontinuar con la siguiente sentencia.

ExecuteProcessExecuteProcess lets you execute a TurboIntegrator process from within another process.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

336 IBM Planning Analytics: Referencia de TM1

Sintaxis

ExecuteProcess(ProcessName, [ParamName1, ParamValue1,ParamName2, ParamValue2]);

Argumento Descripción

ProcessName El nombre del proceso que se ejecutará. Este proceso debe estarubicado en el mismo servidor que el proceso desde el que se llama aExecuteProcess.

Si no es posible encontrar el proceso denominado por este argumentoen el tiempo de ejecución, el proceso de llamada finalizaráinmediatamente. (TurboIntegrator no comprueba si ProcessName esválido durante la compilación.)

ParamName El nombre de un parámetro existente del proceso que se ejecutará.Este argumento únicamente es necesario si el proceso que seejecutará utiliza parámetros.

ParamValue Un valor válido para el parámetro ParamName. Si especifica unargumento ParamName, debe especificar el correspondienteParamValue.

Los argumentos ParamName y ParamValue deben ser paresordenados, con el nombre del parámetro seguido del valor. Debeespecificar un ParamName y el correspondiente ParamValue de cadaparámetro del proceso que se ejecutará.

Los nombres de parámetros pasados en la función ExecuteProcess se comparan durante el tiempo deejecución con los nombres de parámetros especificados en el proceso que se ejecutará. Si los nombrespasados no se pueden encontrar en la lista de parámetros del proceso que se ejecutará, se producirá unerror grave, que provocará la finalización inmediata del proceso desde el que se llame a ExecuteProcess.

Valores de retorno

ExecuteProcess devuelve un valor real que puede probarse con una de las siguientes funciones de valorde retorno:

Función Descripción

ProcessExitByChoreQuit() indica que salió del proceso debido a la ejecución de la funciónChoreQuit

ProcessExitNormal() indica que el proceso se ejecutó con normalidad

ProcessExitMinorError() indica que el proceso se ejecutó correctamente, pero se encontraronerrores leves

ProcessExitByQuit() indica que salió del proceso debido a un comando explícito de "salida"

ProcessExitWithMessage() indica que el proceso finalizó con normalidad, con un mensaje escritoen tm1server.log

ProcessExitSeriousError() indica que salió del proceso debido a un error grave

ProcessExitOnInit() indica que el proceso se interrumpió durante la inicialización

Capítulo 5. funciones de TurboIntegrator 337

Función Descripción

ProcessExitByBreak() indica que salió del proceso porque se encontró una funciónProcessBreak

EjemploPara registrar cuándo falla un proceso llamado por ExecuteProcess debido a un error grave, deberíautilizar un código similar al que se indica a continuación:

return_value = ExecuteProcess('create_sales_cube');ASCIIOutput('C:\temp\process_return_value.txt', 'El proceso se ha canceladocon errores graves en', TIME, 'on', TODAY);if(return_value = ProcessExitSeriousError() )endif;

GetProcessErrorFileDirectoryGetProcessErrorFileDirectory devuelve el nombre de ruta completo, con la barra final, del directoriodonde se escriben los archivos de error del proceso de TurboIntegrator. De forma predeterminada, todoslos archivos de registro de errores del proceso se escriben en el directorio de datos del servidor en el queestá ubicado el proceso.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

GetProcessErrorFileDirectory;

Argumentos

Ninguno.

GetProcessErrorFilenameGetProcessErrorFilename devuelve el nombre del archivo de registro de errores del procesoTurboIntegrator asociado con un proceso. Si el proceso no ha generado aún un archivo de registro deerrores, la función devuelve una cadena vacía (nula).

Importante: no se genera un archivo de registro de errores del proceso hasta que se hayan ejecutadotodas las sentencias de una determinada pestaña de un proceso (Prólogo, Metadatos, Datos o Epílogo).De esta manera, puede utilizar GetProcessErrorFilename para comprobar si alguna pestaña anterior hagenerado un archivo de registro de errores, pero no puede utilizar la función para determinar si la pestañaactual del proceso hará que los errores se escriban en un archivo de registro.

Por ejemplo, al determinar que GetProcessErrorFilename devuelva una cadena no nula en la pestañaEpílogo, puede indicar que los errores se generaron en las pestañas Prólogo, Metadatos o Datos. Sinembargo, no puede utilizar GetProcessErrorFilename en la pestaña Datos para determinar si la pestañaDatos genera errores.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SetProcessErrorFilename;

Argumentos

Ninguno.

338 IBM Planning Analytics: Referencia de TM1

GetProcessNameGetProcessName devuelve el nombre del proceso actual como una cadena.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

GetProcessName()

Argumentos

Ninguno.

Nombre = GetProcessName();

IfLa sentencia If permite que un proceso ejecute una sentencia o un conjunto de sentencias cuando unadeterminada expresión sea true. Puede utilizar operadores aritméticos, operadores lógicos y operadoresde comparación para crear una expresión.

La sentencia If de TurboIntegrator difiere de la función IF de Rules en que la sentencia deTurboIntegrator puede aceptar varias sentencias ElseIf o Else para evaluar diversas expresiones,mientras que la función IF de Rules puede evaluar únicamente una expresión.

Puede anidar un máximo de 20 sentencias If/ElseIf/Else en un proceso TurboIntegrator. Si supera 20sentencias If/ElseIf/Else anidadas, recibirá un error al tratar de guardar el proceso.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

If(expression);statement1;ElseIf(expression);statement2;ElseIf(expression);statement3;Else;statement4;EndIf;

Argumentos

Ninguno.

Ejemplos

If (x=5); ASCIIOutput('c:\temp\if.txt','x equivale a cinco');ElseIf (x=1); ASCIIOutput ('c:\temp\if.txt', 'x equivale a uno');ElseIf (x=2); ASCIIOutput ('c:\temp\if.txt', 'x equivale a dos');ElseIf (x=3); ASCIIOutput ('c:\temp\if.txt', 'x equivale a tres');ElseIf (x=4); ASCIIOutput ('c:\temp\if.txt', 'x equivale a cuatro');Else; ASCIIOutput ('c:\temp\if.txt', 'x falls outside expected range');EndIf;

Este ejemplo evalúa el valor de X. Si X=5, se ejecuta la función ASCIIOutput para escribir la cadena "xequivale a cinco" en c:\temp\if.txt. Si X no equivale a 5, se evalúa la primera sentencia ElseIf. Si X=1, se

Capítulo 5. funciones de TurboIntegrator 339

ejecuta la función ASCIIOutput para escribir la cadena "x equivale a uno" en c:\temp\if.txt. Esteprocesamiento continúa hasta que se ejecuta EndIf.

También se pueden construir sentencias If sin el uso de ElseIf, como en este ejemplo:

IF(expression); statement1; ELSE; statement2; ENDIF;

ItemRejectItemReject rechaza un registro de origen y lo coloca en el registro de errores, junto con un mensaje deerror especificado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ItemReject(ErrorString);

Argumento Descripción

ErrorString El mensaje de error que desea escribir en elregistro de errores cuando se rechaza un registro.

Ejemplo

ItemReject(' Valor fuera del rango aceptable.');

Este ejemplo coloca un registro de origen en el registro de errores, junto con el mensaje de error "Valorfuera del rango aceptable" cuando el registro de origen contiene un valor que está más allá de un rangodefinido.

ItemSkipItemSkip fuerza a un proceso a que omita el elemento de origen de datos actual.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ItemSkip;

Argumentos

Ninguno.

ProcessBreakProcessBreak detiene el proceso de los datos de origen y avanza a la parte Epílogo de un proceso.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ProcessBreak;

340 IBM Planning Analytics: Referencia de TM1

Argumentos

Ninguno.

ProcessErrorProcessError provoca la finalización inmediata de un proceso.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ProcessError;

Argumentos

Ninguno.

ProcessExistsProcessExists determina si existe un proceso TurboIntegrator específico.

La función ProcessExists devuelve uno de estos tres valores posibles:

• Si un proceso de TurboIntegrator con un nombre especificado no existe, la función devuelve 0.• Si un proceso con el nombre especificado no existe y es válido, la función devuelve 1.• Si un proceso con el nombre especificado no existe, pero tiene errores de compilación, la función

devuelve -1.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ProcessExists(ProcessName);

Argumento Descripción

ProcessName El nombre del proceso para el que está intentandodeterminar el estado.

ProcessQuitProcessQuit finaliza un proceso de TurboIntegrator.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ProcessQuit;

Argumentos

Ninguno.

ProcessRollbackProcessRollback inicia la retrotracción de un proceso. Cuando se utiliza en un proceso deTurboIntegrator, esta función desecha todas las ediciones pendientes y cancela cualquier procesoadicional. Se muestra un mensaje de error en los archivos tm1server.log y tm1processorerrorXXX.log.

Capítulo 5. funciones de TurboIntegrator 341

Nota: En la versión 2.0.8 o posteriores de IBM Planning Analytics, cuando se retrotrae o se reinicia unproceso de TurboIntegrator, el proceso se representa ahora en el archivo tm1server.log en tres pasos:inicio, reinicio debido a la contención de bloqueo o retrotracción y, seguidamente, finalización.

Se añade una entrada al archivo tm1server.log que muestra el proceso de TurboIntegrator comoreinicio debido a la contención de bloqueo o retrotracción en lugar de sólo inicio. Este registro se habilitade forma predeterminada sin establecer ninguna opción de depuración específica.

Cuando se utiliza en una tarea de modalidad de confirmación única, ProcessRollback desecha todas lasediciones pendientes de todos los procesos anteriores y continúa ejecutando el siguiente proceso de latarea. Si se encuentra una contención de bloque después de invocar ProcessRollback, se reinicia la tareacompleta.

Cuando se utiliza en una tarea de modalidad de confirmación múltiple, ProcessRollback desecha todaslas ediciones pendientes del proceso actual y continúa ejecutando el siguiente proceso de la tarea. Loscambios que ya se han confirmado no se pueden retrotraer. Si se encuentra una contención de bloquedespués de invocar ProcessRollback, solo se reinicia el proceso actual.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ProcessRollback;

Argumentos

Ninguno.

RunProcessRunProcess permite ejecutar procesos de TurboIntegrator en paralelo, cada uno de los cuales en supropia hebra, gestionada por TM1 Server. Este método agiliza la carga de datos y otras operaciones en lasque se utilizan procesos de TurboIntegrator para dividir el trabajo.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

RunProcess(ProcessName, [ParamName1, ParamValue1,ParamName2, ParamValue2]);

Argumento Descripción

ProcessName El nombre del proceso que se ha de ejecutar. Este proceso debe estarubicado en el mismo servidor que el proceso desde el que se invocaRunProcess.

Si no es posible encontrar el proceso denominado por este argumentoen el tiempo de ejecución, el proceso de llamada finalizaráinmediatamente. (TurboIntegrator no comprueba si ProcessName esválido durante la compilación.)

ParamName El nombre de un parámetro existente del proceso que se ha deejecutar. Este argumento únicamente es necesario si el proceso que seva a ejecutar utiliza parámetros.

342 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

ParamValue Un valor válido para el parámetro ParamName. Si especifica unargumento ParamName, debe especificar el correspondienteParamValue.

Los argumentos ParamName y ParamValue deben ser paresordenados, con el nombre del parámetro seguido del valor. Debeespecificar un ParamName y el correspondiente ParamValue de cadaparámetro del proceso que se ha de ejecutar.

Los nombres de parámetros pasados en la función RunProcess se comparan durante el tiempo deejecución con los nombres de los parámetros especificados en el proceso que se va a ejecutar. Si losnombres especificados no se pueden encontrar en la lista de parámetros del proceso que se va aejecutar, se genera un error grave que provoca la finalización inmediata del proceso desde el que seinvoca RunProcess.

Valores de retorno

RunProcess devuelve una serie. La serie es el JobID o una serie vacía si se produce un error.

SynchronizedSynchronized se puede utilizar en un script de TurboIntegrator para forzar la ejecución en serie de unconjunto designado de procesos de TurboIntegrator.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

La función synchronized() utiliza la sintaxis siguiente.

synchronized (lockName);

Synchronized toma un solo parámetro necesario que es un nombre definido por el usuario para un objetode bloqueo. Este nombre de objeto de bloqueo se puede utilizar en varios procesos de TurboIntegratorpara serializar su ejecución como grupo.

Argumento Descripción

lockName El nombre definido por el usuario de un objeto de bloqueo en el quesincronizar. Los nombres no distinguen entre mayúsculas y minúsculasy se ignoran los espacios intercalados. La longitud de los nombres nopuede superar los 1023 caracteres.

Cadena/Sí/Ninguno

Semántica

Un proceso de TurboIntegrator puede realizar cualquier número de llamadas a synchronized(), concualquier número de objetos de bloqueo. La serialización es efectiva desde el momento en que se llama asynchronized(), hasta que se completa la transacción que la contiene.

Por ejemplo, si se llama a synchronized() desde un subproceso (Ps) del proceso maestro (Pm) o tareamaestra (Cm), el objeto bloqueado se "libera" cuando se completa el proceso Pm o la tarea Cm. Laexcepción es que un SaveDataAll (SDA) "finaliza" de forma prematura la ejecución de una transacción amitad del proceso, esto se aplica también a los objetos de bloqueo.

La llamada a synchronized() se puede colocar en cualquier lugar dentro de un script TurboIntegrator,pero la serialización se aplica a todo el proceso de TurboIntegrator cuando se encuentra.

Capítulo 5. funciones de TurboIntegrator 343

Presuponga que existe un proceso de TurboIntegrator con una llamada a synchronized() en algún lugar amitad de su script y que una operación O1 precede a dicha llamada. Es posible que dos instancias de esteproceso de TurboIntegrator se inicien al mismo tiempo. Es posible que una instancia se ejecute hasta sufinalización, incluida su llamada a synchronized(), antes de que la segunda instancia alcance su llamadasynchronized(). En este caso, al usuario le parece que los dos procesos se han ejecutado de formasimultánea. Si, en su lugar, el segundo proceso alcanza su llamada synchronized() antes de que finalice elprimero, deshará cualquier trabajo que haya realizado (O1) y esperará a que se complete el primero. Eneste caso, para el usuario los dos procesos se han serializado.

Para evitar esta confusión, y para optimizar el uso de synchronized(), se recomienda (sin que seaobligatorio) que las llamadas synchronized() sean las primeras sentencias de un proceso deTurboIntegrator.

Ejemplo

Presuponga que el proceso P de TurboIntegrator necesita actualizar dos cubos, Cube_1 y Cube_2.

Es posible que otros procesos de TurboIntegrator también tengan que actualizar Cube_1 o Cube_2.

Para que todos los procesos de TurboIntegrator que actualizarán Cube_1 o Cube_2 se ejecuten uno trasotro, el proceso P puede llamar a synchronized() de este modo:

sCube_1='Cube_1';sCube_2='Cube_2';sE1='Elm1';sE2='Elm2';sE4='Units';sE5='Price';

Synchronized( sCube_1 );Synchronized( sCube_2 );

CellPutn( 111, sCube_1, sE1, sE2 );CellPutn( 9.99, sCube_2, sE4, sE5 );

# ...

Otros procesos de TurboIntegrator que actualizarán Cube_1 o Cube_2 también deben llamar asynchronized( sCube_1 ) o synchronized( sCube_2 ) de un modo similar.

En este ejemplo, los dos nombres de objetos de bloqueo se han elegido para que sean los mismos que losnombres de los cubos. Pero un nombre de objeto de bloqueo no tiene que ser el mismo que el de otrosobjetos TM1 (cubos, dimensiones, subconjuntos).

WhileLa sentencia While permite que un proceso repita una serie de sentencias siempre que una determinadacondición sea true. Las sentencias While se pueden anidar.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

WHILE(logical expression);

statement1;

statement2;

...

statement n;

END;

Nota: Todas las sentencias WHILE deben concluir con una sentencia END.

344 IBM Planning Analytics: Referencia de TM1

Argumentos

Ninguno.

Funciones de TurboIntegrator de gestión de reglasEstas funciones facilitan la gestión de reglas.

CubeProcessFeedersCubeProcessFeeders vuelve a procesar todos los feeders de las reglas de un cubo especificado.

Esta función vuelve a procesar todos los feeders de las reglas de un cubo especificado. Normalmente losfeeders se vuelven a procesar de forma automática al guardar la edición de un archivo de regla, sinembargo, si los datos cambian, y dichos cambios en los datos modificarán algunos feeders condicionales,esta función deberá llamarse para volver a evaluar dichos feeders condicionales.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeProcessFeeders(CubeName);

Argumento Descripción

CubeName El cubo cuyos feeders desea volver a procesar.

Ejemplo

CubeProcessFeeders('ventas2003');

Este ejemplo vuelve a procesar todos los feeders de las reglas del cubo ventas2003.

CubeRuleAppendCubeRuleAppend añade una sola línea de texto de regla a una regla de cubo de TM1.

Básicamente, esta función añade una sola línea de texto a un archivo de reglas (.rux). La línea de textosuele ser una sentencia de regla, pero también puede ser un comentario. Si no hay ninguna reglaasociada al cubo en el momento en que se ejecuta la función, se creará una regla nueva que sólo contienela línea que se ha pasado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CubeRuleAppend(CubeName, RuleText, IsCalculationRule);

Argumento Descripción

CubeName El nombre del cubo asociado a la regla en la quedesea añadir una línea de texto.

Capítulo 5. funciones de TurboIntegrator 345

Argumento Descripción

RuleText La línea única de texto que desea añadir a la regla.

La línea completa de texto que añada deberá irentre comillas simples y debe cumplir con lasconvenciones sintácticas de las reglas.

Si la línea de texto incluye referencias a elementos,en los nombres de elemento deberán utilizarsedobles comillas simples como caracteres deescape de las comillas simples que suelenenglobar a los nombres de elemento. Por ejemplo,una referencia a un elemento llamado CL3 se debeespecificar como [''CL3''].

A continuación se indican una serie de ejemplos delíneas válidas de texto que puede añadir a unaregla:

'[''CL3''] = [''CL4''] + [''Trial''];'

'skipcheck;'

'[''Trial''] => [''CL3''];'

IsCalculationRule El parámetro IsCalculationRule declara si la líneadebe insertarse justo encima de una sección defeeder que pudiera existir en la regla del cubo. Sise omite el parámetro IsCalculationRule, o se pasacomo 0.0, la nueva línea simplemente se añadirá alfinal de la regla.

Puesto que los archivos de reglas (.rux) constan deuna sección de cálculo seguida de una secciónfeeder opcional, las líneas que se hayan añadido yque sean sentencias de reglas de cálculo (o suscomentarios correspondientes) deben utilizar un1.0 para este argumento para asegurarse de que lanueva línea se inserta en la ubicación apropiadadel archivo de reglas.

Ejemplos

CubeRuleAppend( 'MyCube', '[''CL3''] = [''CL4''] + [''Trial''];', 1.0 );

Este ejemplo inserta la sentencia de cálculo ['CL3'] = ['CL4'] + ['Trial']; al final de la secciónde cálculo de la regla para el cubo MyCube.

CubeRuleAppend( 'MyCube', '[''Trial''] => [''CL3''];', 0.0 );

Este ejemplo inserta la sentencia feeder ['Trial'] => ['CL3']; al final de la regla para el cuboMyCube.

CubeRuleDestroyCubeRuleDestroy suprime las reglas existentes que corresponden a un cubo especificado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

346 IBM Planning Analytics: Referencia de TM1

Sintaxis

CubeRuleDestroy(CubeName);

Argumento Descripción

CubeName El nombre del cubo asociado a la regla que deseasuprimir

Ejemplo

CubeRuleDestroy('SalesProjections');

En este ejemplo se suprime la regla de SalesProjectionscube.

DeleteAllPersistentFeedersDeleteAllPersistentFeeders borra los archivos .feeder que permanecen. Cuando se utiliza esta función,todos los cubos se marcan como "no guardar feeders", de modo que con una función SaveData posterior,los feeders no permanecen, lo que significa que todos los feeders se vuelven a calcular cuando se reiniciael servidor.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DeleteAllPersistentFeeders;

Argumentos

Ninguno.

ForceSkipCheckForceSkipCheck fuerza la consulta para que se ejecute como si el cubo incluya SKIPCHECK en las reglas.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Esto significa que la consulta solamente procesará los valores que están realmente en el cubo, encontraposición a los casos (sin SKIPCHECK) en los que se enumeraría cada celda posible al buscarvalores. Esta función establece el estado de la consulta de vista de modo que se seleccionen solamentevalores en el cubo. La función debe añadirse a la sección Prólogo del proceso de TurboIntegrator. Alcolocar ForceSkipCheck() en el prólogo se ve afectada toda la consulta de vista de elementos de datosque haya después.

Sintaxis

ForceSkipCheck()

Argumentos

Ninguno.

RuleLoadFromFileRuleLoadFromFile crea una regla de TM1 para un cubo específico a partir de un archivo de texto. Cadasentencia de regla debe acabar con un punto y coma (;) y los comentarios deben tener como prefijo elcarácter #. Si ya existe una regla para el cubo especificado, se sobrescribe la regla por la regla que hacreado RuleLoadFromFile.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Capítulo 5. funciones de TurboIntegrator 347

Sintaxis

RuleLoadFromFile(Cube, TextFile);

Argumento Descripción

Cube El nombre del cubo para el que desea crear unaregla.

TextFile El nombre del archivo de texto desde el que deseacrear una regla.

Puede especificar la ruta completa de este archivo,incluyendo la extensión y el nombre de archivo.(Ejemplo 1 a continuación.)

Si únicamente especifica la extensión y el nombrede archivo, TurboIntegrator busca el archivo en eldirectorio de datos del servidor.

Si no especifica una extensión de archivo,TurboIntegrator asumirá la extensión .rux de formapredeterminada. (Ejemplo 2 a continuación.)

Si deja en blanco el argumento TextFile, TurboIntegrator buscará un archivo de origen con el mismonombre que el cubo (pero con una extensión .rux) en el directorio de datos del servidor. (Ejemplo 3 acontinuación.)

Ejemplo

RuleLoadFromFile('Ventas', 'C:\temp\cuberule.txt');

Este ejemplo utiliza el contenido del archivo cuberule.txt del directorio C:\temp para crear una regla parael cubo Ventas.

RuleLoadFromFile('Ventas', 'reglacubo');

Este ejemplo crea una regla para el cubo Ventas utilizando el archivo denominado reglacubo.rux deldirectorio de datos del servidor.

RuleLoadFromFile('Ventas', ' ');

Este ejemplo crea una regla para el cubo Ventas utilizando el archivo denominado Sales.rux del directoriode datos del servidor.

Funciones de recintos de pruebasEstas funciones se utilizan con los recintos de pruebas.

GetUseActiveSandboxPropertyGetUseActiveSandboxProperty devuelve un valor booleano que indica si un proceso lee y escribe datos enlos datos básicos o en el recinto de pruebas activo del usuario.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

El valor predeterminado se reserva para procesos que lean y escriban en los datos básicos.

• Si el valor devuelto es 0, el proceso está leyendo y escribiendo en los datos básicos.• Si el valor devuelto es 1, el proceso está leyendo y escribiendo en el recinto de pruebas activo.

348 IBM Planning Analytics: Referencia de TM1

Nota: Esta función devolverá el valor permanente de esta propiedad tal y como se establece en la interfazde usuario de Architect/Server Explorer, a menos que haya utilizado la funciónSetUseActiveSandboxProperty en el proceso. En dicho caso, el valor de esta propiedad se determinamediante el valor que se estableció por última vez con la función SetUseActiveSandboxProperty.

Sintaxis

GetUseActiveSandboxProperty()

Argumentos

Ninguno.

Ejemplo

return_value = GetUseActiveSandboxProperty();

Este ejemplo devolverá un valor booleano que indicará si el proceso está leyendo o escribiendo datos delcubo en el recinto de pruebas activo o en los datos básicos.

ServerActiveSandboxGetServerActiveSandboxGet devuelve el nombre del recinto de pruebas activo del usuario. Si el usuario notiene ningún recinto de pruebas activo, devolverá una cadena vacía. Dado que las tareas se ejecutan en elcontexto de un usuario de administración especial y pueden no tener ningún recinto de pruebas activo,esta función siempre devuelve una cadena vacía cuando se ejecute a través de una tarea.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ServerActiveSandboxGet();

Argumentos

Ninguno.

Ejemplo

return_value = ServerActiveSandboxGet();

Este ejemplo devolverá el recinto de pruebas activo del usuario que ejecuta el proceso de TI en el que serealice la llamada de la función.

ServerActiveSandboxSetServerActiveSandboxSet establece el recinto de pruebas activo del usuario que realiza la acción. Seutiliza una cadena vacía para eliminar el recinto de pruebas activo del usuario que realiza la acción. Estafunción genera un error si el usuario que realiza la acción no cuenta con un recinto de pruebas con elnombre que se ha especificado.

Dado que las tareas se ejecutan en el contexto de un usuario de administración especial y es posible queno tengan ningún recinto de pruebas activo, esta función siempre genera un error cuando se ejecutamediante una tarea.

Nota: Para que un proceso de TurboIntegrator lea y escriba valores en el contexto del recinto de pruebasactivo del usuario que realiza la acción, debe establecerse la propiedad UseActiveSandbox. Consulte losapartados “GetUseActiveSandboxProperty” en la página 348 y “SetUseActiveSandboxProperty” en lapágina 358.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Capítulo 5. funciones de TurboIntegrator 349

Sintaxis

ServerActiveSandboxSet(SandboxName)

Argumento Descripción

SandboxName Valor de cadena. Nombre de un recinto de pruebasque pertenece al usuario que realiza la acción.

Ejemplo: Establecer el recinto de pruebas activo del usuario que realiza la acción en "Mejor caso"

ServerActiveSandboxSet('Best case');

Ejemplo: Eliminar el recinto de pruebas activo del usuario que realiza la acción y establecer elcontexto de nuevo en los datos base

ServerActiveSandboxSet('');

ServerSandboxCloneServerSandboxClone clona un recipiente de pruebas existente en un nuevo recipiente de pruebas.

Los recintos de pruebas son espacios de trabajo privados en los que un usuario puede especificar yalmacenar valores de datos separados de los datos básicos de TM1. Los recintos de pruebas sealmacenan en disco y, cuando se utilizan, en la memoria.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ServerSandboxClone(sandboxName,newSandboxName );

Argumento Descripción

sandboxName Valor de cadena. Nombre de un recinto de pruebasque pertenece al usuario que realiza la acción.

newSandboxName Valor de cadena. El nombre de un recinto depruebas que se ha de crear como clon desandboxName.

Ejemplo

ServerSandboxClone( 'Best case', 'Second best case');

ServerSandboxCreateServerSandboxCreate crea un nuevo recipiente de pruebas.

Los recintos de pruebas son espacios de trabajo privados en los que un usuario puede especificar yalmacenar valores de datos separados de los datos básicos de TM1. Los recintos de pruebas sealmacenan en disco y, cuando se utilizan, en la memoria.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ServerSandboxCreate( sandboxName );

350 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

sandboxName Valor de cadena. El nombre del recinto de pruebasque se va a crear.

Ejemplo

ServerSandboxCreate( 'My sandbox' );

ServerSandboxesDeleteServerSandboxesDelete permite a los administradores descartar los recintos de pruebas que cumplen uncriterio determinado.

Los recintos de pruebas son espacios de trabajo privados en los que un usuario puede especificar yalmacenar valores de datos separados de los datos básicos de TM1. Los recintos de pruebas sealmacenan en disco y, cuando se utilizan, en la memoria.

Esta función se ejecuta en el lado del servidor y está disponible mediante TurboIntegrator y la función dela API ServerSandboxesDelete. Si se utiliza esta característica en un proceso de TurboIntegrator, losadministradores pueden planificar el mantenimiento mediante tareas automatizadas.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Descripción

Esta función utiliza un predicado para describir el recinto de pruebas que se va a suprimir. Una lectura deun predicado podría ser: "Suprimir recintos de pruebas cuyo atributo sea condición valor."

Por ejemplo: "suprimir recintos de pruebas cuyo tamaño sea mayor que 10 MB". En este ejemplo, elatributo es el "tamaño" del recinto de pruebas, la condición es "mayor que" y el valor es "10 MB".

Existen dos parámetros de caracteres delimitadores opcionales para la función de TurboIntegrator. Dadoque un recinto de pruebas no tiene restricciones en cuanto a los caracteres que se pueden utilizar en sunombre, los administradores pueden suministrar su propio delimitador seguro, cuando sea necesario.

Por ejemplo, ServerSandboxesDelete( 'client:=:Admin, name:=:best casescenario' );"

En el ejemplo siguiente, el carácter de dos puntos se utiliza en el nombre del recinto de pruebas("best::case::scenario"), de modo que se necesita otro delimitador:

ServerSandboxesDelete( 'client|=|Admin# name|=|best::case::scenario', '|', '#' );"

Nota: La sintaxis exacta de un predicado difiere entre los formatos de TurboIntegrator y de la API de estafunción.

Sintaxis

ServerSandboxesDelete(string,string,string)

Capítulo 5. funciones de TurboIntegrator 351

Argumento Descripción

Predicados El nombre del proceso que se ejecutará. Este proceso debe estarubicado en el mismo servidor que el proceso desde el que se invocaRunProcess.

Obligatorios

Cadena

Sin valor predeterminado

Una lista de predicados de longitud arbitraria. Cada predicado es unacadena que contiene tres señales. La primera señal indica un atributodel recinto de pruebas. La segunda indica una condición, por ejemplo,">" o "=". La tercera señal es un valor posible del atributo según el cualse deben filtrar condicionalmente los recintos de pruebas. La longitudde toda la cadena no debe superar los 10.000 caracteres.

Delimitador de predicado Opcional

Cadena

El valor predeterminado es el signo de dos puntos (:)

Carácter delimitador opcional.

La longitud de la cadena no debe superar 1 carácter.

Delimitador de lista depredicados

Opcional

Cadena

El valor predeterminado es la coma (,)

Carácter delimitador opcional.

La longitud de la cadena no debe superar 1 carácter.

Atributos de filtro

Los atributos de filtro son propiedades de un recinto de pruebas que se pueden utilizar para comprobar siel recinto de pruebas cumple determinadas condiciones. Los nombres de atributos y sus condicionesválidas correspondientes no distinguen entre mayúsculas y minúsculas e ignoran los espacios en blancointercalados. Por ejemplo, las dos llamadas siguientes son válidas:

ServerSandboxesDelete( 'client:=:Admin' );

ServerSandboxesDelete( 'C L I E N T : = :Admin' );

Tabla 1. Atributos de filtro

Atributo DescripciónCondiciones válidas Tipo de valor

UpdateDate Indicación de fecha y horade la última acción deescritura realizada en elrecinto de pruebas.

<, =, >. Indicación de fecha y hora en formatoestándar internacional, es decir, AAAA-MM-DD. Los días son las unidades máspequeñas.

AccessDate Indicación de fecha y horade la última descarga deun recinto de pruebas.

<, =, >. Indicación de fecha y hora en formatoestándar internacional, es decir, AAAA-MM-DD. Los días son las unidades máspequeñas.

352 IBM Planning Analytics: Referencia de TM1

Tabla 1. Atributos de filtro (continuación)

Atributo DescripciónCondiciones válidas Tipo de valor

CreationDate Indicación de fecha y horade la creación de unrecinto de pruebas.

<, =, >. Indicación de fecha y hora en formatoestándar internacional, es decir, AAAA-MM-DD. Los días son las unidades máspequeñas.

Size Tamaño de un recinto depruebas en la memoria.

<, =, >. Tamaño basado en las reglas deconversión de log4cxx (vea el parámetrode configuración AuditLogMaxTempFileSize). Por ejemplo, 10 MB. Loskilobytes son las unidades más pequeñas.

Name Nombre de un recinto depruebas.

=,containing.

Cadena.

Client Cliente propietario de unrecinto de pruebas.

=. Cadena.

Group Un grupo del que esmiembro el clientepropietario de un recintode pruebas.

=. Cadena.

Registro y valores devueltos

La supresión de un recinto de pruebas se registra utilizando la funcionalidad de registro de auditoría yaexistente. Adicionalmente, se incluye un informe más detallado de los efectos de la administración delrecinto de pruebas en el registro de depuración (tm1server.log) en el nivel INFO. Este informe incluirá lalista de recintos de pruebas afectados y también algunos de sus atributos y los errores encontrados.

ServerSandboxesDelete solamente devuelve un estado de correcto o de error.

SemánticaLista de predicados

Cuando se pasan varios predicados en una sola llamada a ServerSandboxesDelete, éstos sonconjuntivos. En otras palabras, para que un recinto de pruebas coincida con el criterio que se hapasado, todos los predicados tienen que ser verdaderos. Se pueden utilizar varias llamadas aServerSandboxesDelete para obtener un comportamiento disyuntivo. Solamente se puede pasar unatributo de cada tipo en cada llamada a ServerSandboxesDelete. Por ejemplo, no es válido pasar dosveces el cliente ya que un recinto de pruebas solamente tiene un cliente propietario. Cuando sedetecta que un atributo aparece varias veces, se muestra un aviso en el informe detallado, noobstante, la operación no se interrumpirá con un error. En este caso, se prueban los predicados comoen cualquier otra consulta pero el conjunto de resultados siempre está vacío.

Bloqueos

Para evitar problemas de bloqueos masivos, ServerSandboxesDelete observa los recintos de pruebasde un cliente como una instantánea puntual y, a continuación, cuando es posible libera los bloqueosque garantizan una transacción serializable. Debido a este comportamiento, cuando se "pasa" uncliente en la iteración de todos los clientes, se puede añadir a dicho cliente un recinto de pruebas quecoincida con el criterio de filtro antes de que se complete la transacción de mantenimiento. Estecomportamiento es similar al que se da cuando se añade un recinto de pruebas para el clienteinmediatamente después de que se completa la transacción.

Capítulo 5. funciones de TurboIntegrator 353

Ámbito

Los miembros del grupo ADMIN (superusuario) y DataAdmin tendrán acceso a todos los recintos depruebas de todos los clientes. Deben especificar explícitamente el atributo de cliente para limitar elámbito de su llamada a ServerSandboxesDelete únicamente a sus propios recintos de pruebas. Todoslos demás usuarios solamente tienen acceso a sus propios recintos de pruebas. Si especifican uncliente diferente, o un grupo al que no pertenecen, la función terminará anormalmente en error y sedevolverá un error de privilegio.

Recintos de pruebas en uso

Cuando un recinto de pruebas cumple el criterio de supresión, pero está en uso, dicho recinto depruebas no se suprime. Aparecerá una entrada en el informe de nivel de información del registro dedepuración indicándolo.

Fechas de acceso y actualización

Los atributos de fecha pueden ser coincidencias como mucho con la granularidad de días. Debido aesta restricción, el registro de estos atributos es en consecuencia granular. En las escrituras de celdasindividuales no se actualiza la fecha de última actualización. En lugar de ello, el sistema registra lafecha de descarga de un recinto de pruebas en el que se ha realizado una operación de escrituramientras se cargaba en la memoria. Para estos recintos de pruebas, la fecha de último acceso y lafecha de última actualización serán iguales. Únicamente se actualiza la fecha de último accesocuando se descarga un recinto de pruebas de la memoria. Asimismo, debido a que los recintos depruebas en memoria no están sujetos a ServerSandboxesDelete, no se actualiza la fecha de últimoacceso cuando se carga un recinto de pruebas en la memoria.

Por ejemplo, presuponga el siguiente escenario de uso:

Tabla 2. Ejemplo de Día de último acceso

Día Hora Acción

1 1 Cargar recinto de pruebas S

1 2 Escribir 1

2 3 Leer 1

2 4 Descargar recinto de pruebas

Un usuario trabaja con un recinto de pruebas durante dos días (quizás durante un periodo más cortoque abarque el cambio de día). A la hora 4, cuando se descarga el recinto de pruebas, la fecha deúltima actualización se establece en 2, y no en 1, que es cuando se ha producido realmente la últimaactualización. En este caso, la fecha de último acceso también se establece en 2 a la hora 4. Si laacción de Escribir 1 fuera una acción de lectura, únicamente la fecha de último acceso se estableceríaen 2, mientras que la fecha de última actualización no se modificaría.

Ejemplo

ServerSandboxesDelete( 'client:=:Admin, name:=:best case scenario' );

ServerSandboxDiscardAllChangesServerSandboxDiscardAllChanges descarta todos los cambios en un recipiente de pruebas existente.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ServerSandboxDiscardAllChanges( sandboxName );

354 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

sandboxName Valor de cadena. Nombre de un recinto de pruebasque pertenece al usuario que realiza la acción.

Ejemplo

ServerSandboxDiscardAllChanges( 'MySandbox' );

ServerSandboxMergeServerSandboxMerge fusiona un recinto de pruebas de origen en un recinto de pruebas de destinoexistente. Si el recinto de pruebas de destino no se especifica, el recinto de pruebas de origen se fusionaen la base.

Los recintos de pruebas son espacios de trabajo privados en los que un usuario puede especificar yalmacenar valores de datos separados de los datos básicos de TM1. Los recintos de pruebas sealmacenan en disco y, cuando se utilizan, en la memoria.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ServerSandboxMerge( src, tgt, conflictRes, waitForLocks);

Argumento Descripción

src El nombre del recinto de pruebas de origen que es propiedad delusuario que ejecuta la acción que se va a fusionar con el recinto depruebas <tgt> .

El recinto de pruebas <src> no se modifica.

Obligatorios

String

tgt El nombre de un recinto de pruebas que es propiedad del usuario queejecuta la acción que se va a fusionar con el recinto de pruebas <src> .

El recinto de pruebas <tgt> se actualiza.

Si <tgt> está en blanco, se está fusionando <src> con los datos base yse está actualizando la base.

Necesario. Para dejar este parámetro en blanco, utilice 2 comillassimples seguidas: ''.

String

conflictRes Se hace caso omiso del parámetro <conflictRes>.

Opcional

Numérico

Capítulo 5. funciones de TurboIntegrator 355

Argumento Descripción

waitForLocks El parámetro <waitForlocks> es un entero que indica si hay queesperar a que los bloqueos garanticen la serialización.

1 significa que se esperan los bloqueos, se capturan las excepcionesen conflicto y se realiza otro intento en lugar de permitir laretrotracción de la tarea o el proceso.

0 significa que no se esperan bloqueos. Permite las excepciones queprovocan la retrotracción.

Opcional

Numérico

Ejemplo

Se fusiona mySandbox en la base.

ServerSandboxMerge(mySandbox, '');

ServerSandboxExistsServerSandboxExists comprueba si existe el recinto de pruebas que se ha pasado. 1 es el valor que sedevuelve cuando existe el recinto de pruebas transferido y 0 en caso contrario.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ServerSandboxExists( sandboxname )

o

ServerSandboxExists( sandboxname, username )

Argumentos

El nombre del recinto de pruebas cuya existencia se está comprobando. ServerSandboxExists adoptaun parámetro de serie opcional, el nombre del cliente propietario. El cliente que llama puede utilizar elparámetro opcional para especificar un cliente que no sea él mismo si cuenta con los privilegiosadecuados. Se producirá un error de privilegio si el cliente especificado no es el cliente ejecutor y elcliente ejecutor no pertenece a los grupos DataAdmin o ADMIN. Si no se utiliza el parámetro opcional, elsujeto serán los recintos de prueba del cliente activo.

Ejemplo

El siguiente fragmento de código muestra cómo se pueden utilizar las funcionesServerSandboxExists, ServerSandboxGet y ServerSandboxListCountGet para iterar losrecintos de prueba del usuario denominado User1 y la salida de esos recintos de prueba en un archivo detexto. El proceso TurboIntegrator se ejecutaría de forma correcto para los miembros de los grupos Admino Data Admin y para el usuario llamado User1. El proceso TurboIntegrator fallaría con un error deprivilegio para los demás usuarios.

SandboxIndex = 1;NumSandboxes = ServerSandboxListCountGet( 'User1' );

WHILE( SandboxIndex <= NumSandboxes );

SandboxName = ServerSandboxGet( SandboxIndex, 'User1' );

356 IBM Planning Analytics: Referencia de TM1

IF( ServerSandboxExists( SandboxName, 'User1' ) = 1 );

ASCIIOUTPUT( 'C:\User1Sandboxes.txt', SandboxName );

ENDIF;

SandboxIndex = SandboxIndex + 1;

END;

ServerSandboxGetServerSandboxGet devuelve el nombre del recinto de pruebas identificado por el número N, donde N es elparámetro especificado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ServerSandboxGet( index )

o

ServerSandboxGet( index, username)

Argumentos

El índice del recinto de pruebas solicitado de la colección de recintos de prueba del usuario. El espacio deíndice será contiguo, por lo que se puede utilizar la primera aparición de una devolución de cadena vacíapara romper la iteración. Asimismo, la eliminación de un recinto de pruebas alterará los índices decualquier recinto de pruebas detrás de ese recinto en la lista.

ServerSandboxGet adopta un parámetro de serie opcional, el nombre del cliente propietario. El clienteque llama puede utilizar el parámetro opcional para especificar un cliente que no sea él mismo si cuentacon los privilegios adecuados. Se producirá un error de privilegio si el cliente especificado no es el clienteejecutor y el cliente ejecutor no pertenece a los grupos DataAdmin o ADMIN. Si no se utiliza el parámetroopcional, el sujeto serán los recintos de prueba del cliente activo.

Ejemplo

El siguiente fragmento de código muestra cómo se pueden utilizar las funcionesServerSandboxExists, ServerSandboxGet y ServerSandboxListCountGet para iterar losrecintos de prueba del usuario denominado User1 y la salida de esos recintos de prueba en un archivo detexto. El proceso TurboIntegrator se ejecutaría de forma correcto para los miembros de los grupos Admino Data Admin y para el usuario llamado User1. El proceso TurboIntegrator fallaría con un error deprivilegio para los demás usuarios.

SandboxIndex = 1;NumSandboxes = ServerSandboxListCountGet( 'User1' );

WHILE( SandboxIndex <= NumSandboxes );

SandboxName = ServerSandboxGet( SandboxIndex, 'User1' );

IF( ServerSandboxExists( SandboxName, 'User1' ) = 1 );

ASCIIOUTPUT( 'C:\User1Sandboxes.txt', SandboxName );

ENDIF;

SandboxIndex = SandboxIndex + 1;

END;

ServerSandboxListCountGetServerSandboxListCountGet devuelve el recuento de recintos de pruebas como un número.

Capítulo 5. funciones de TurboIntegrator 357

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ServerSandboxListCountGet()

o

ServerSandboxListCountGet( username )

Argumentos

ServerSandboxListCountGet adopta un parámetro de serie opcional, el nombre del clientepropietario. El cliente que llama puede utilizar el parámetro opcional para especificar un cliente que nosea él mismo si cuenta con los privilegios adecuados. Se producirá un error de privilegio si el clienteespecificado no es el cliente ejecutor y el cliente ejecutor no pertenece a los grupos DataAdmin o ADMIN.Si no se utiliza el parámetro opcional, el sujeto serán los recintos de prueba del cliente activo.

Ejemplo

El siguiente fragmento de código muestra cómo se pueden utilizar las funcionesServerSandboxExists, ServerSandboxGet y ServerSandboxListCountGet para iterar losrecintos de prueba del usuario denominado User1 y la salida de esos recintos de prueba en un archivo detexto. El proceso TurboIntegrator se ejecutaría de forma correcto para los miembros de los grupos Admino Data Admin y para el usuario llamado User1. El proceso TurboIntegrator fallaría con un error deprivilegio para los demás usuarios.

SandboxIndex = 1;NumSandboxes = ServerSandboxListCountGet( 'User1' );

WHILE( SandboxIndex <= NumSandboxes );

SandboxName = ServerSandboxGet( SandboxIndex, 'User1' );

IF( ServerSandboxExists( SandboxName, 'User1' ) = 1 );

ASCIIOUTPUT( 'C:\User1Sandboxes.txt', SandboxName );

ENDIF;

SandboxIndex = SandboxIndex + 1;

END;

SetUseActiveSandboxPropertySetUseActiveSandboxProperty controla si un proceso lee y escribe datos del cubo en los datos básicos oen el recinto de pruebas activo del usuario. El valor predeterminado se reserva para procesos que lean yescriban en los datos básicos.

El ámbito de esta función se aplica únicamente al proceso que se está ejecutando actualmente ysustituye temporalmente al valor permanente de esta propiedad que está establecido en la interfaz deusuario de Architect/Server Explorer.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SetUseActiveSandboxProperty(PropertyValue)

358 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

PropertyValue Valor booleano que indica si el proceso deberíautilizar el contexto del recinto de pruebas activo alleer o escribir datos del cubo.

Si PropertyValue = 0, el proceso ignorará elcontexto del recinto de pruebas activo y la lectura/escritura en los datos básicos.

Si PropertyValue = 1, el proceso leerá/escribirádatos del cubo en el recinto de pruebas activo.

Ejemplo

SetUseActiveSandboxProperty(1);

Este ejemplo provocará que el proceso lea/escriba datos del cubo en el recinto de pruebas activo para elresto de la ejecución.

Funciones de TurboIntegrator de seguridadEstas funciones pertenecen al ámbito de la seguridad.

AddClientAddCliente crea un nuevo cliente en el servidor. Los cambios aplicados mediante las funciones AddClientno tendrán efecto hasta que finalice el procedimiento de Metadatos de un proceso. Esta función, al igualque todas las funciones que actualizan metadatos, no debe utilizarse en las pestañas Datos y Epílogo deun proceso.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

AddClient(ClientName);

Argumento Descripción

ClientName El nombre del cliente que desea añadir al servidor.

El nombre del cliente está limitado a 255caracteres/bytes.

Ejemplo

AddClient('Brian');

Este ejemplo añade el cliente Brian al servidor.

AddGroupAddGroup crea un nuevo grupo de usuarios en el servidor. Los cambios aplicados mediante la funciónAddGroup no tendrán efecto hasta que finalice el procedimiento de Metadatos de un proceso. Estafunción, al igual que todas las funciones que actualizan metadatos, no debe utilizarse en las pestañasDatos y Epílogo de un proceso.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Capítulo 5. funciones de TurboIntegrator 359

Sintaxis

AddGroup(GroupName);

Argumento Descripción

GroupName El nombre del grupo que desea crear.

Ejemplo

AddGroup('Finanza');

Esta función añade el grupo de usuarios Finanza al servidor.

AssignClientToGroupAssignClientToGroup asigna un cliente existente en un servidor a un grupo de usuarios existente. Estafunción asigna un cliente existente en un servidor a un grupo de usuarios existente.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

AssignClientToGroup(ClientName, GroupName);

Argumento Descripción

ClientName El nombre del cliente que desea asignar a ungrupo.

GroupName El grupo al que desea asignar el cliente.

Ejemplo

AssignClientToGroup('Brian', 'Finanza');

Este ejemplo asigna el cliente existente Brian al grupo de usuarios existente Finanza.

AssignClientPasswordAssignClientPassword asigna una contraseña a un cliente existente de un servidor. AssignClientPassworddevuelve 1 si la asignación de contraseña es correcta y devuelve 0 si se produce un error en la asignación.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

AssignClientPassword (ClientName, Password);

Argumento Descripción

ClientName El nombre del cliente al que desea asignar unacontraseña.

360 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

Contraseña La contraseña que desea asignar al cliente. Cuandoasigne una contraseña, utilice texto sin formato.TM1 cifrará la contraseña en el servidor.

Las contraseñas deben incluir cinco caracterescomo mínimo.

Ejemplo

AssignClientPassword ('Brian', 'flyfisher');

Este ejemplo asigna la contraseña "flyfisher" al cliente denominado Brian.

AssociateCAMIDToGroupAssociateCAMIDToGroup elimina una asociación entre un grupo de usuarios de TM1 y un CAMID.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

AssociateCAMIDToGroup(GroupName, CAMID, CAMIDDisplayValue);

Argumento Descripción

GroupName El nombre del grupo de TM1 que desea asociar conel CAMID.

CAMID El nombre del grupo CAMID. Si el CAMID no existe,se creará en el cubo decontrole }ClientCAMAssociatedGroups.

CAMIDDefDisplayValue El alias del grupo CAMID.

CellSecurityCubeCreateCellSecurityCubeCreate crea un cubo de seguridad a partir de un cubo existente utilizando un conjunto dedimensiones reducido. Esta función, al igual que todas las funciones que actualizan metadatos, no debeutilizarse en las pestañas Datos y Epílogo de un proceso.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CellSecurityCubeCreate (‘DataCube’, ‘0:0:1:0’);

Argumento Descripción

Cubo Nombre del cubo de datos.

Capítulo 5. funciones de TurboIntegrator 361

Argumento Descripción

DimensionMap Cadena que especifica si la dimensión de cadaposición debe utilizarse en el cubo de seguridad. Elorden de las dimensiones es el orden del cubooriginal. Un 1 para cada dimensión incluida y un 0para una excluida. Cada valor está separado pordos puntos.

Devolución de booleano Verdadero si la operación ha sido correcta. Unerror importante en caso contrario.

Información adicional La propiedad GrantSecurityAccess debe establecerpara este proceso TurboIntegrator para que seasatisfactoria. Crea el cubo de seguridad de celda.

Ejemplo

CellSecurityCubeCreate (‘DataCube’, ‘0:0:1:0’);

Este ejemplo crea un cubo RDCLS a partir del cubo llamado DataCube.

CellSecurityCubeDestroyCellSecurityCubeDestroy destruye un cubo de seguridad que se ha creado a partir de un cubo existente.Esta función, al igual que todas las funciones que actualizan metadatos, no debe utilizarse en laspestañas Datos y Epílogo de un proceso.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

CellSecurityCubeDestroy (‘DataCube’, ‘0:0:1:0’);

Argumento Descripción

Cubo Nombre del cubo de datos.

Devolución de booleano Verdadero si la operación ha sido correcta. Unerror importante en caso contrario.

Información adicional La propiedad GrantSecurityAccess debe establecerpara este proceso TurboIntegrator para que seasatisfactoria. Destruye el cubo de seguridad decelda.

Ejemplo

CellSecurityCubeDestroy (‘DataCube’);

DeleteClientDeleteClient elimina un cliente del servidor. Los cambios aplicados mediante la función DeleteClient notendrán efecto hasta que finalice el procedimiento de Metadatos de un proceso. Esta función, al igual quetodas las funciones que actualizan metadatos, no debe utilizarse en las pestañas Datos y Epílogo de unproceso

362 IBM Planning Analytics: Referencia de TM1

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DeleteClient(ClientName);

Argumento Descripción

ClientName Nombre del cliente que desea eliminar delservidor.

Ejemplo

DeleteClient('Brian');

Este ejemplo elimina el cliente Brian del servidor.

DeleteGroupDeleteGroup elimina un grupo de usuarios del servidor. Los cambios aplicados mediante la funciónDeleteGroup no tendrán efecto hasta que finalice el procedimiento de Metadatos de un proceso. Estafunción, al igual que todas las funciones que actualizan metadatos, no debe utilizarse en las pestañasDatos y Epílogo de un proceso.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

DeleteGroup(GroupName);

Argumento Descripción

GroupName El grupo que desea eliminar.

Ejemplo

DeleteGroup('Finanza');

Este ejemplo elimina el grupo de usuarios Finanza del servidor.

ElementSecurityGetElementSecurityGet recupera el nivel de seguridad asignado a un grupo especificado de un elemento dedimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ElementSecurityGet(DimName, ElName, Group);

Argumento Descripción

DimName La dimensión padre del elemento para el que estárecuperando un nivel de seguridad.

Capítulo 5. funciones de TurboIntegrator 363

Argumento Descripción

ElName El elemento para el que está recuperando un nivelde seguridad.

Group El grupo de usuarios del que está recuperando unnivel de seguridad.

Ejemplo

ElementSecurityGet('Region', 'Germany', 'Budgeting');

Este ejemplo devuelve el nivel de seguridad asignado al grupo de usuarios Presupuesto para el elementoAlemania de la dimensión Región.

ElementSecurityPutElementSecurityPut asigna un nivel de seguridad a un grupo especificado para un elemento dedimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ElementSecurityPut(Level, DimName, ElName, Group);

Argumento Descripción

Level El nivel de seguridad que está asignando. Hay seisposibles valores de Level:

• None• Read• Write• Reserve• Lock• Admin

DimName La dimensión padre del elemento para el que estáasignando un nivel de seguridad.

ElName El elemento al que está asignando un nivel deseguridad.

Group El grupo de usuarios al que está asignando un nivelde seguridad.

Ejemplo

ElementSecurityPut('Reserva', 'Región', 'Alemania', 'Presupuesto');

Este ejemplo asigna seguridad Reserva al grupo Presupuesto para el elemento Alemania de la dimensiónRegión.

364 IBM Planning Analytics: Referencia de TM1

HierarchyElementSecurityGetHierarchyElementSecurityGet recupera el nivel de seguridad asignado a un grupo especificado de unelemento de dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyElementSecurityGet(DimName, HierName, ElName, Group);

Argumento Descripción

DimName La dimensión padre del elemento para el que estárecuperando un nivel de seguridad.

HierName Nombre de la jerarquía de la dimensión.

ElName El elemento para el que está recuperando un nivelde seguridad.

Group El grupo de usuarios del que está recuperando unnivel de seguridad.

Ejemplo

HierarchyElementSecurityGet('Region', 'Europe', 'Germany', 'Budgeting');

Este ejemplo devuelve el nivel de seguridad asignado al grupo de usuarios Budgeting para el elementoGermany de la dimensión Region. El elemento aparece en la jerarquía Europe de la dimensión Region.

HierarchyElementSecurityPutHierarchyElementSecurityPut asigna un nivel de seguridad a un grupo especificado para un elemento dedimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchyElementSecurityPut(Level, DimName, HierName, ElName, Group);

Argumento Descripción

Level El nivel de seguridad que está asignando. Hay seisposibles valores de Level:

• None• Read• Write• Reserve• Lock• Admin

DimName La dimensión padre del elemento para el que estáasignando un nivel de seguridad.

Capítulo 5. funciones de TurboIntegrator 365

Argumento Descripción

HierName Nombre de la jerarquía de la dimensión.

ElName El elemento al que está asignando un nivel deseguridad.

Group El grupo de usuarios al que está asignando un nivelde seguridad.

Ejemplo

HierarchyElementSecurityPut('Reserve', 'Region', 'Europe', 'Germany', 'Budgeting');

Este ejemplo asigna seguridad Reserve al grupo Budgeting para el elemento Germany de la dimensiónRegion. El elemento aparece en la jerarquía Europe de la dimensión Region.

RemoveCAMIDAssociationRemoveCAMIDAssociation elimina todas las asociaciones entre grupos de usuarios de TM1 y un CAMIDespecificado.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

RemoveCAMIDAssociation(CAMID, RemoveCAMID);

Argumento Descripción

CAMID El nombre del grupo CAMID cuyas asociaciones deseguridad desea eliminar.

RemoveCAMID Determina si el CAMID especificado se eliminarádel cubo de control }ClientCAMAssociatedGroups.

0 mantiene el CAMID en el cubo decontrol }ClientCAMAssociatedGroups.

1 elimina el CAMID del cubo decontrol }ClientCAMAssociatedGroups.

RemoveCAMIDAssociationFromGroupRemoveCAMIDAssociationFromGroup elimina una asociación entre un grupo de usuarios de TM1 y unCAMID.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

RemoveCAMIDAssociationFromGroup(GroupName, CAMID);

Argumento Descripción

GroupName El nombre del grupo de usuarios de TM1 para elque desea eliminar la asociación.

366 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

CAMID El nombre del grupo CAMID para el que deseaeliminar la asociación.

RemoveClientFromGroupRemoveClientFromGroup elimina un cliente especificado de un grupo de usuarios.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

RemoveClientFromGroup(ClientName, GroupName);

Argumento Descripción

ClientName El cliente que desea eliminar.

GroupName El grupo de usuarios del que desea eliminar elcliente.

Ejemplo

RemoveClientFromGroup('Brian', 'Finanzas');

Este ejemplo elimina el cliente Brian del grupo de usuarios Finanzas.

SetHierarchyGroupsSecuritySetHierarchyGroupsSecurity establece el nivel de seguridad para todos los grupos existentes para lajerarquía de dimensión especificada.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SetHierarchyGroupsSecurity(securityLevel, dimension, hierarchy)

Argumento Descripción

securityLevel El nivel de seguridad que está asignando. Hay seisposibles valores:

• None• Read• Write• Reserve• Lock• Admin

dimension Nombre de la dimensión.

hierarchy Nombre de la jerarquía de dimensión.

Capítulo 5. funciones de TurboIntegrator 367

Ejemplo

SetHierarchyGroupsSecurity('Reserve', 'Region', 'Europe');

Este ejemplo asigna seguridad Reserve a todos los grupos existentes en la jerarquía Europe de ladimensión Region.

SetHierarchyElementGroupsSecuritySetHierarchyElementGroupsSecurity establece el nivel de seguridad para un elemento especificado deuna jerarquía de una dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SetHierarchyElementGroupsSecurity(securityLevel, dimension, hierarchy, element)

Argumento Descripción

securityLevel El nivel de seguridad que está asignando. Hay seisposibles valores:

• None• Read• Write• Reserve• Lock• Admin

dimension Nombre de la dimensión.

hierarchy Nombre de la jerarquía de dimensión.

element El elemento al que está asignando un nivel deseguridad.

Ejemplo

SetHierarchyElementGroupsSecurity('Reserve', 'Region', 'Europe', 'Germany');

Este ejemplo asigna seguridad Reserve al elemento Germany de la jerarquía Europe de la dimensiónRegion.

SetDimensionGroupsSecuritySetDimensionGroupsSecurity establece el nivel de seguridad para todos los grupos existentes para ladimensión especificada.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SetDimensionGroupsSecurity(securityLevel, dimension)

368 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

securityLevel El nivel de seguridad que está asignando. Hay seisposibles valores:

• None• Read• Write• Reserve• Lock• Admin

dimension Nombre de la dimensión.

Ejemplo

SetDimensionGroupsSecurity('Reserve', 'Region');

Este ejemplo asigna seguridad Reserve a todos los grupos existentes de la dimensión Region.

SetElementGroupsSecuritySetElementGroupsSecurity establece el nivel de seguridad para un elemento especificado de unadimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SetElementGroupsSecurity(securityLevel, dimension, element)

Argumento Descripción

securityLevel El nivel de seguridad que está asignando. Hay seisposibles valores:

• None• Read• Write• Reserve• Lock• Admin

dimension Nombre de la dimensión.

element El elemento al que está asignando un nivel deseguridad.

Ejemplo

SetElementGroupsSecurity('Reserve', 'Region', 'Germany');

Este ejemplo asigna seguridad Reserve al elemento Germany de la dimensión Region.

Capítulo 5. funciones de TurboIntegrator 369

SecurityOverlayGlobalLockCellSecurityOverlayGlobalLockCell se utiliza para restringir los derechos de acceso de un nodo únicamente aderechos de solo lectura bloqueándolo. Utiliza el preformato global para incluir a todos los usuarios. Elcubo de preformato debe crearse antes de utilizar este comando. Los elementos proporcionados en ladirección deben ser solamente para las dimensiones utilizadas en el preformato.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SecurityOverlayGlobalLockCell(bLock, Cube, element1,..., elementN)

Argumento Descripción

bLock Si es 1, se bloquea. Con 0 se desbloquea.

Cube Nombre del cubo.

elementN Nombre de elemento de preformato que define latupla. El orden debe coincidir con el orden originalde las dimensiones del cubo.

Devolución de booleano Verdadero si la operación ha sido correcta. Unerror importante en caso contrario.

Información adicional La propiedad GrantSecurityAccess debe establecerpara este proceso TurboIntegrator para que seasatisfactoria. Crea el cubo de preformato deseguridad global predeterminado. Los preformatosglobales se aplican a todos los usuarios.

Ejemplo

SecurityOverlayGlobalLockCell(1,’Sales’,’MA’); SecurityOverlayGlobalLockCell(0,’Products’,’MA','2011’);

En el primer ejemplo solamente hay una dimensión que se utilice para el preformato. En el segundoejemplo se utilizan dos dimensiones.

SecurityOverlayCreateGlobalDefaultSecurityOverlayCreateGlobalDefault se utiliza para crear o destruir un cubo de preformato de seguridad ypara establecer el preformato de un área determinada de un cubo de datos.

Tenga en cuenta que si se crea un cubo de datos con un nombre que corresponde a un cubo depreformato, el cubo de datos se convierte en un preformato si se reinicia el servidor. Cuando se carga elcubo, se configurará como preformato si se encuentra un cubo de datos coincidente.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SecurityOverlayCreateGlobalDefault (Cube, DimensionMap)

Argumento Descripción

Cube Nombre del cubo.

370 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

DimensionMap Cadena que especifica si la dimensión de cadaposición debe utilizarse en el preformato. El ordende las dimensiones es el orden del cubo original.Un 1 para cada dimensión incluida y un 0 para unaexcluida. Cada valor está separado por dos puntos.

Devolución de booleano Verdadero si la operación ha sido correcta. Unerror importante en caso contrario.

Información adicional La propiedad GrantSecurityAccess debe establecerpara este proceso TurboIntegrator para que seasatisfactoria. Crea el cubo de preformato deseguridad global predeterminado. Los preformatosglobales se aplican a todos los usuarios.

Ejemplo

SecurityOverlayCreateGlobalDefault(‘DataCube’, ‘0:0:1:0’);

SecurityOverlayDestroyGlobalDefaultSecurityOverlayDestroyGlobalDefault se utiliza para destruir un cubo de preformato de seguridad y paraestablecer el preformato de un área determinada de un cubo de datos.

Tenga en cuenta que si se crea un cubo de datos con un nombre que corresponde a un cubo depreformato, el cubo de datos se convierte en un preformato si se reinicia el servidor. Cuando el cubo estécargado, se configurará como preformato si se encuentra un cubo de datos coincidente.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SecurityOverlayDestroyGlobalDefault (Cube)

Argumento Descripción

Cube Nombre del cubo.

Devolución de booleano Verdadero si la operación ha sido correcta. Unerror importante en caso contrario.

Información adicional La propiedad GrantSecurityAccess debe establecerpara este proceso TurboIntegrator para que seasatisfactoria. Crea el cubo de preformato deseguridad global predeterminado. Los preformatosglobales se aplican a todos los usuarios.

Ejemplo

SecurityOverlayDestroyGlobalDefault(‘DataCube’);

Capítulo 5. funciones de TurboIntegrator 371

SecurityOverlayGlobalLockNodeSecurityOverlayGlobalLockNode se utiliza para restringir los derechos de acceso de un nodo únicamentea derechos de solo lectura bloqueándolo. Utiliza el preformato global para incluir a todos los usuarios. Elcubo de preformato debe crearse antes de utilizar este comando. Los elementos proporcionados en ladirección deben ser solamente para las dimensiones utilizadas en el preformato.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SecurityOverlayGlobalLockNode(bLock, Cube, Address, [AddressDelimiter])

Argumento Descripción

bLock Si es 1, se bloquea. Con 0 se desbloquea.

Cube Nombre del cubo.

Address Secuencia de cadenas con señales de nombres deelementos de preformato que definen la tupla. Elorden debe coincidir con el orden original de lasdimensiones del cubo.

Devolución de dirección Cadena de caracteres opcional utilizada paraseparar los nombres de elementos en

el parámetro Address. El valor predeterminado es‘|’.

Devolución de booleano Verdadero si la operación ha sido correcta. Unerror importante en caso contrario.

Información adicional La propiedad GrantSecurityAccess debe establecerpara este proceso TurboIntegrator para que seasatisfactoria. Crea el cubo de preformato deseguridad global predeterminado. Los preformatosglobales se aplican a todos los usuarios.

Ejemplos

SecurityOverlayGlobalLockNode(1,’Sales’,’MA’); SecurityOverlayGlobalLockNode(0,’Products’,’MA | 2011’); SecurityOverlayGlobalLockNode(0,’Products’, ‘MA : 2011’, ‘:’);

En el primer ejemplo solamente hay una dimensión que se utilice para el preformato. En los otros dosejemplos se utilizan dos dimensiones.

SecurityRefreshSecurityRefresh lee todos los cubos de control de seguridad y vuelve a generar las estructuras internas enel servidor que utilizan las funciones de la API de TM1.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SecurityRefresh;

372 IBM Planning Analytics: Referencia de TM1

Argumentos

Ninguno.

Funciones de TurboIntegrator de manipulación de servidoresEstas funciones facilitan la manipulación de servidores.

BatchUpdateFinishBatchUpdateFinish indica al servidor que salga del modo de actualización por lotes.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Semántica

Cuando se ejecutan varios procesos en el modo de actualización por lotes y se aplican cambios en unúnico cubo, es posible que el esquema de bloqueo de TM1 que uno de los procesos actualice el cubo.Esto se realiza de forma predeterminada; cuando un proceso obtiene un bloqueo para escribir cambios enun cubo, se impedirá que otros procesos escriban en dicho cubo para conservar la integridad de losdatos.

Este esquema de bloqueo puede ilustrarse utilizando un ejemplo de dos procesos, Proceso1 y Proceso 2,que actualizan un único cubo.

• Ambos procesos se inician y llaman a la función BatchUpdateStart para iniciar actualizaciones por lotes.• Cada proceso funciona en un único origen de datos.• Proceso 1 finaliza el procesamiento de datos y llama a la función BatchUpdateFinish. El proceso obtiene

un bloqueo de escritura en el cubo y realiza cambios.• Mientras que Proceso 1 aún retiene un bloqueo de escritura en el cubo, Proceso 2 finaliza el

procesamiento de datos y llama a la función BatchUpdateFinish. Sin embargo, dado que Proceso 1retiene el bloqueo, Proceso 2 no puede obtener un bloqueo para el cubo. Todos los cambios de datosaplicados en Proceso 2 se deshacen y se reinicia Proceso 2. Esto garantiza la integridad de los datos.

Capítulo 5. funciones de TurboIntegrator 373

En función del tamaño del origen de datos de Proceso 2, la acción de retrotraer datos y volver a ejecutarel proceso puede provocar una importante reducción del rendimiento. Para hacer frente a este problemade rendimiento, puede utilizar la función BatchUpdateFinishWait en vez de BatchUpdateFinish.

Sintaxis

BatchUpdateFinish(SaveChanges);

Argumento Descripción

SaveChanges Un distintivo que ordena al servidor que guarde odescarte cambios realizados en el modo deactualización por lotes.

Especifique 0 para guardar los cambios, 1 paradescartar los cambios.

Ejemplo

BatchUpdateFinish(0);

Este ejemplo indica al servidor que guarde los cambios de los datos de TM1 y que salga del modo deactualización por lotes.

BatchUpdateFinishWaitLa función BatchUpdateFinishWait es idéntica a BatchUpdateFinish, excepto que el proceso espera a queel bloqueo pase a estar disponible y, a continuación, confirma los cambios. Si un proceso invocaBatchUpdateFinishWait, pero no puede proteger un bloqueo de escritura de un cubo para confirmar loscambios, el proceso espera hasta que el bloqueo esté disponible y, a continuación, confirma los cambios.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

No se deshacen los cambios de los datos aplicados en el proceso ni se vuelve a ejecutar el proceso.

Nota: Mientras está a la espera del bloqueo de escritura del cubo, el proceso libera los bloqueos delectura que ha adquirido para otros objetos durante la ejecución del proceso. Dado que estos bloqueos delectura se liberan antes de que el proceso pueda realizar cambios en el cubo, los objetos para los que seliberan los bloqueos de lectura pueden modificarse antes de que se actualice el cubo. Esto puede originarinconsistencia en los datos al utilizar BatchUpdateFinishWait.

Le recomendamos que utilice BatchUpdateFinishWait solamente en situaciones controladas en las quesabe que otros procesos no están modificando datos ni metadatos relacionados con el proceso que llamaa BatchUpdateFinishWait.

Sintaxis

BatchUpdateFinishWait(SaveChanges);

Argumento Descripción

SaveChanges Un distintivo que ordena al servidor que guarde odescarte cambios realizados en el modo deactualización por lotes. Especifique 0 para guardarlos cambios, 1 para descartar los cambios.

Ejemplo

BatchUpdateFinishWait(0);

374 IBM Planning Analytics: Referencia de TM1

Este ejemplo indica al servidor que guarde los cambios de los datos de TM1 y que salga del modo deactualización por lotes.

BatchUpdateStartBatchUpdateStart permite actualizaciones por lotes.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

BatchUpdateStart;

Argumentos

Ninguno.

DisableBulkLoadModeDisableBulkLoadMode inhabilita el proceso de cargas de gran volumen.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

Para obtener más información, consulte “EnableBulkLoadMode” en la página 375.

EnableBulkLoadModeEnableBulkLoadMode habilita el modo de carga de gran volumen para un proceso de TurboIntegrator.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

Puede habilitar el modo de carga de gran volumen en las secciones Prólogo o Epílogo de un proceso deTurboIntegrator. Para una mayor eficacia, habilite el modo de carga de gran volumen en la primerasentencia, o muy cerca de ella, de la sección Prólogo del proceso.

Tras habilitar el modo de carga de gran volumen en un proceso, solo se podrá inhabilitar en la última líneade la sección Epílogo. Si trata de deshabilitar el modo de carga de gran volumen en cualquier otro puntodel proceso, éste no compilará.

Si se habilita el modo de carga de gran volumen en un proceso de TurboIntegrator, continuará habilitadohasta que se desactive explícitamente o hasta que la tarea finalice. Esto significa que puede habilitar elmodo en un proceso de una tarea y, a continuación, ejecutar una serie de procesos de TurboIntegratorantes de inhabilitarlo. También puede entrar y salir del modo de carga de gran volumen repetidas veces,utilizándolo solo para determinados puntos importantes de una tarea.

Utilice los siguientes comandos TurboIntegrator para habilitar y deshabilitar el modo de carga de granvolumen en un proceso de TurboIntegrator.

EnableBulkLoadMode();

Utilice la siguiente función de TurboIntegrator solo en la última línea de la sección Epílogo del proceso deTI cuando utilice el modo de carga de gran volumen.

DisableBulkLoadMode();

RefreshMdxHierarchyRefreshMdxHierarchy actualiza las jerarquías MDX de un servidor sin necesidad de que reinicie elservidor.

Capítulo 5. funciones de TurboIntegrator 375

Utilice esta función después de configurar o editar los niveles de jerarquía con nombre personalizados deuna dimensión del cubo de control }HierarchyProperties.

Para obtener información detallada sobre cómo utilizar los niveles con nombre con dimensiones, consultela sección relacionada en la documentación de IBM Cognos TM1 para desarrolladores.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

RefreshMdxHierarchy(dimensionName, hierarchy)

Argumento Descripción

dimensionName Parámetro de cadena opcional para especificar unadimensión específica para actualizar.

Deje este parámetro en blanco para actualizartodas las dimensiones.

hierarchy Nombre de la jerarquía de la dimensión. Se trata deun parámetro opcional.

Ejemplo

Actualizar todas las dimensiones:

RefreshMdxHierarchy('');

Para actualizar únicamente la dimensión de clientes:

RefreshMdxHierarchy('customers');

SaveDataAllSaveDataAll guarda todos los datos TM1 de la memoria del servidor en el disco y reinicia el archivo deregistro.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Utilización de SaveDataAll en una tarea

SaveDataAll realiza todos los cambios que una tarea establece antes de llamar a la función SaveDataAll.

Mientras se ejecuta una tarea, acumula bloqueos en los objetos a los que accede. La operación iniciadapor la función SaveDataAll libera temporalmente todos estos bloqueos. Una vez que se realiza estaoperación, SaveDataAll vuelve a adquirir todos los bloqueos con los que contaba para poder seguiraccediendo a los objetos con los que estaba trabajando.

Durante esta operación aparece una breve ventana en la que se liberan los bloqueos y otro usuario oproceso TurboIntegrator puede eliminar objetos que la tarea original estaba utilizando. Cuando la tareaoriginal trate de volver a adquirir los bloqueos de estos objetos, los objetos no estarán disponibles y latarea interrumpirá el procesamiento. En este caso, se escribe un error similar al que aparece acontinuación en el archivo Tm1s.log:

844 WARN 2008-04-01 16:40:09,734 TM1.Server TM1ServerImpl::FileSave podíavolver a adquirir el bloqueo en el objeto con el índice 0x200002ca

376 IBM Planning Analytics: Referencia de TM1

Contención de bloqueo y utilización de SaveDataAll al finalizar procesos de TurboIntegrator

Si utiliza SaveDataAll como el último comando de un proceso de TurboIntegrator es posible que aumentela contención del bloqueo para procesos de TM1 TurboIntegrator.

En las versiones de IBM TM1, normalmente SaveDataAll se añadía al final de un proceso deTurboIntegrator que cargaba datos con el registro inhabilitado. SaveDataAll proporcionaba un modo deescribir datos de la memoria al disco directamente tras una importación satisfactoria, de modo que losdatos recién importados no se perdieran en caso de percances, como la terminación anormal de unservidor.

Sin embargo, añadir SaveDataAll como último comando puede provocar numerosos procesos deimportación de TurboIntegrator, cada uno con SaveDataAll como último comando. Esta técnicafuncionaba en la versión 9.0 de TM1, y en versiones anteriores, porque el modelo de bloqueo anteriorsolo utilizaba el bloqueo de escritura global. En un momento dado en las versiones anteriores, sólo unaoperación de escritura podría tener lugar. Por tanto, las operaciones SaveDataAll simultáneas nuncaresultaban de varias operaciones de escritura simultáneas.

En la versión 9.1 y posteriores se presentó un modelo de bloqueo por objeto más detallado que permiteoperaciones de escritura simultáneas, siempre que estas operaciones de escritura no compitan por losmismos recursos. Si compiten por los mismos recursos, se impone una contención de bloqueo, que obligaa que uno de los procesos se retrotraiga. Así, ahora dos procesos de importación de TurboIntegratorpueden ejecutarse simultáneamente si no comparten objetos; por ejemplo, si realizan una importación endos cubos diferentes.

La función SaveDataAll de TurboIntegrator depende del archivo de registro de transacciones tm1s.log eimplica a todos los objetos del modelo de datos. Por tanto, dos procesos de importación deTurboIntegrator que utilicen por igual la función SaveDataAll, no pueden ejecutarse en paralelo: uno seejecutará, mientras que se obligará a retrotraer al otro (y su proceso de TurboIntegrator). Lo mismo seaplica si los procesos de TurboIntegrator forman parte de tareas: sólo una tarea podrá ejecutar la funciónSaveDataAll de TurboIntegrator, mientras que la otra tarea se verá obligada a retrotraerse.

Una retrotracción no es deseable desde el punto de vista del rendimiento, puesto que aumenta el tiempototal de ejecución de un proceso o una tarea de TurboIntegrator. Las operaciones simultáneas deSaveDataAll que compitan entre ellas siempre provocarán un bloqueo de contención y una retrotracción.

Existen dos posibles soluciones para evitar operaciones simultáneas de SaveDataAll que compitan entreellas:

• No utilizar la función SaveDataAll de TurboIntegrator. En su lugar, habilite el registro de cubos para loscubos de importación.

• Si por motivos de rendimiento no se puede habilitar el registro de cubos para los cubos de importación,en la aplicación de TM1 solo debe haber un proceso que invoque la función SaveDataAll deTurboIntegrator. Utilice una tarea autónoma, única y diferenciada para ejecutar la operaciónSaveDataAll.

Sintaxis

SaveDataAll;

Argumentos

Ninguno.

ServerShutdownServerShutdown concluye un servidor que se está ejecutando como una aplicación. ServerShutdown nopuede utilizarse para apagar un servidor que se ejecuta como un servicio de Windows.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Capítulo 5. funciones de TurboIntegrator 377

Sintaxis

ServerShutDown(SaveData);

Argumento Descripción

SaveData Un valor booleano que indica si el servidor debeguardar los cambios en el disco antes de apagarse.

Si SaveData = 0, el servidor se apaga sin guardarlos cambios.

Si SaveData = 1, el servidor guarda los cambios dela memoria en el disco antes de apagarse.

Ejemplo

ServerShutdown(1);

Este ejemplo apaga el servidor y guarda los datos en disco.

Funciones de TurboIntegrator de manipulación de subconjuntosEstas funciones facilitan la manipulación de subconjuntos.

HierarchySubsetAliasSetHierarchySubsetAliasSet establece el atributo de alias que se utilizará en un subconjunto.HierarchySubsetAliasSet devuelve 1 si es correcto; de lo contrario, devuelve 0.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchySubsetAliasSet( DimName, HierName, SubName, AliasName );

Argumento Descripción

DimName La dimensión padre del subconjunto para el quedesea establecer el alias.

HierName Nombre de la jerarquía de la dimensión.

SubName El subconjunto para el que desea establecer elalias.

AliasName El alias que desea utilizar en el subconjunto.

HierarchySubsetCreateHierarchySubsetCreate crea un subconjunto público vacío de una determinada jerarquía y dimensión.

Cuando el argumento opcional AsTemporary se establece en 1, el subconjunto es temporal y existesolamente mientras dure el proceso o la tarea de TurboIntegrator donde sea ha creado el subconjunto.

Nota:

En la versión 11.2.0 y anteriores de TM1 Server, los subconjuntos temporales solo los podía ver elproceso que los había creado y cualquiera de sus procesos hijo. Los subconjuntos temporales no estabanvisibles para procesos de ancestros y hermanos. Se podían crear subconjuntos con el mismo nombre en

378 IBM Planning Analytics: Referencia de TM1

procesos hijo hermanos con el mismo proceso padre. Se podían crear subconjuntos con el mismo nombreen procesos hijo hermanos con el mismo proceso padre.

En TM1 Server versión 11.3.0 y posterior, estos subconjuntos temporales están visibles para los procesosde ancestros y hermanos. Si un proceso padre A de TurboIntegrator invoca dos procesos hijo A1 y A2 deTurboIntegrator y el proceso A1 de TurboIntegrator crea un subconjunto temporal S, el subconjuntotemporal S existe mientras dura el proceso A de TurboIntegrator. No puede crear un subconjuntotemporal con el mismo nombre S en el proceso A2 de TurboIntegrator ya que los procesos hermanos A1y A2 pueden ver y utilizar el subconjunto.

Mientras exista un subconjunto temporal, este tendrá prioridad frente a un subconjunto público que tengael mismo nombre. Si otra función de TurboIntegrator hace referencia a un subconjunto que existe tantocomo temporal y como permanente, la función utiliza el subconjunto temporal.

No hay bloqueos asociados a un subconjunto temporal, ya que un subconjunto temporal nunca se guarda.Esto puede dar como resultado una mejora del rendimiento, ya que no es necesario que TurboIntegratorespere a que se liberen los bloqueos antes de trabajar con un subconjunto temporal.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchySubsetCreate(DimName, HierName, SubName, [AsTemporary]);

Argumento Descripción

DimName La dimensión padre del subconjunto que estácreando.

HierName Nombre de la jerarquía de la dimensión.

SubName El nombre que desea asignar al subconjunto.

AsTemporary Argumento opcional que especifica si elsubconjunto que se va a crear es temporal. 1 indicaque se trata de un subconjunto temporal y 0 que setrata de un subconjunto permanente.

Si este argumento se omite, el subconjunto serápermanente.

Ejemplo

HierarchySubsetCreate('Region', 'European', 'Northern Europe', 1);

Este ejemplo crea el subconjunto Northern Europe temporal de la jerarquía European de la dimensiónRegion. Puede utilizar SubsetElementInsert para añadir elementos al subconjunto.

HierarchySubsetDeleteAllElementsHierarchySubsetDeleteAllElements suprime todos los elementos de un subconjunto público de unajerarquía de dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchySubsetDeleteAllElements(DimName, HierName, SubsetName);

Capítulo 5. funciones de TurboIntegrator 379

Argumento Descripción

DimName La dimensión padre del subconjunto del que deseaeliminar elementos.

HierName Nombre de la jerarquía de la dimensión.

SubsetName El subconjunto del que desea eliminar elementos.Debe ser un subconjunto público. TurboIntegratorno puede acceder a objetos privados.

Ejemplo

HierarchySubsetDeleteAllElements('Region', 'European', 'Central Europe');

Este ejemplo suprime todos los elementos del subconjunto Central Europe de la jerarquía European de ladimensión Region.

HierarchySubsetDestroyHierarchySubsetDestroy suprime un atributo de subconjunto de la base de datos de TM1.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchySubsetDestroy(DimName, HierName, SubName);

Argumento Descripción

DimName La dimensión padre del subconjunto que estáeliminando.

HierName Nombre de la jerarquía de la dimensión.

SubName El nombre del subconjunto que desea eliminar.

Ejemplo

HierarchySubsetDestroy('Region', 'European', 'Northern Europe');

Este ejemplo suprime el subconjunto Northern Europe de la jerarquía European de la dimensión Region.

HierarchySubsetElementExistsHierarchySubsetElementExists determina si existe un elemento específico en un subconjunto públicoconcreto en el servidor desde el que se ejecuta un proceso de TurboIntegrator.HierarchySubsetElementExists no se puede utilizar para determinar si un elemento existe en unsubconjunto privado.

Si el elemento existe en el subconjunto especificado, la función devuelve 1; de lo contrario, devuelve 0.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchySubsetElementExists(DimName, HierName, SubsetName, ElementName);

380 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

DimName Dimensión padre del subconjunto que contiene elelemento cuya existencia desea confirmar.

HierName Nombre de la jerarquía de la dimensiónespecificada.

SubsetName Subconjunto público que contiene el elementocuya existencia desea confirmar.

ElementName Elemento cuya existencia desea confirmar.

Ejemplo

HierarchySubsetElementExists('Region', 'Eastern', 'Europe', 'Italy');

Este ejemplo determina si el elemento Italy existe en el subconjunto Europe de la jerarquía Eastern de ladimensión Region.

HierarchySubsetElementDeleteHierarchySubsetElementDelete suprime un elemento de un subconjunto de una jerarquía de dimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchySubsetElementDelete(DimName, HierName, SubName, Index);

Argumento Descripción

DimName La dimensión padre del subconjunto del que deseaeliminar un elemento.

HierName Nombre de la jerarquía de la dimensión.

SubName El subconjunto del que desea eliminar unelemento.

Index El número de índice del elemento que deseaeliminar del subconjunto.

Ejemplo

HierarchySubsetElementDelete('Region', 'European', 'Northern Europe', 3);

Este ejemplo suprime el tercer elemento del subconjunto Northern Europe de la jerarquía European de ladimensión Region.

HierarchySubsetElementGetIndexHierarchySubsetElementGetIndex recupera el índice de un elemento de un subconjunto de una jerarquíade dimensión.

La función devuelve el índice de la primera aparición del elemento especificado. Si el elemento no existeen el subconjunto o no se encuentra, se devuelve cero. Si la dimensión o el subconjunto no se encuentrano se especifica un índice de inicio fuera de rango, se generará un error y la función de TurboIntegrator sedetendrá.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Capítulo 5. funciones de TurboIntegrator 381

Sintaxis

HierarchySubsetElementGetIndex(DimName, HierName, SubsetName, ElementName, StartIndex);

Argumento Descripción

DimName Dimensión padre del subconjunto.

HierName Nombre de la jerarquía de la dimensión.

SubsetName Subconjunto que contiene el elemento.

ElementName Nombre del elemento que desea buscar en elsubconjunto.

StartIndex Número de índice desde el que se iniciará labúsqueda. El valor debe estar comprendido entre 1y el tamaño del subconjunto.

Ejemplo

HierarchySubsetElementGetIndex('Region', 'Country', 'Europe', 'Italy', 3);

Este ejemplo recupera el índice de Italy del subconjunto Europe de la jerarquía Country de la dimensiónRegion. La búsqueda empieza en el índice 3.

HierarchySubsetElementInsertHierarchySubsetElementInsert añade un elemento a un subconjunto existente en una jerarquía dedimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchySubsetElementInsert(DimName, HierName, SubName, ElName, Position);

Argumento Descripción

DimName La dimensión padre del subconjunto al que deseaañadir un elemento.

HierName Nombre de la jerarquía de la dimensión.

SubName El nombre del subconjunto al que está añadiendoun elemento.

ElName El nombre del elemento que desea añadir alsubconjunto. El elemento debe existir en la basede datos de TM1.

Position Un valor que indica la posición de índice delelemento dentro del subconjunto.

Ejemplo

HierarchySubsetElementInsert('Region', 'European', 'Northern Europe', 'Finland',3);

Este ejemplo añade el elemento Finland al subconjunto Northern Europe de la jerarquía European de ladimensión Region. Finland es el tercer elemento de la definición de subconjunto.

382 IBM Planning Analytics: Referencia de TM1

HierarchySubsetExistsHierarchySubsetExists determina si un subconjunto público específico existe en el servidor desde el quese ejecuta un proceso de TurboIntegrator. La función devuelve 1 si el subconjunto existe en el servidor;de lo contrario, devuelve 0. Tenga en cuenta que esta función no se puede utilizar para determinar laexistencia de subconjuntos privados.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchySubsetExists(DimName, HierName, SubsetName);

Argumento Descripción

DimName El nombre de la dimensión que es el padre delsubconjunto cuya existencia desea confirmar.

HierName Nombre de la jerarquía de la dimensión.

SubsetName El nombre del subconjunto público cuya existenciadesea confirmar

Ejemplo

HierarchySubsetExists('Region', 'Industrialized, 'Northern Europe');

Este ejemplo determina si el subconjunto Northern Europe existe dentro de la jerarquía Industrialized dela dimensión Region.

HierarchySubsetGetSizeHierarchySubsetGetSize devuelve el número de elementos de un subconjunto de la jerarquía dedimensión.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchySubsetGetSize(DimName, HierName, SubsetName);

Argumento Descripción

DimName La dimensión padre del subconjunto cuyo tamañodesea determinar.

HierName Nombre de la jerarquía de la dimensión.

SubsetName El subconjunto cuyo tamaño desea determinar.

Ejemplo

HierarchySubsetGetSize('Region', 'Eastern', 'EurAsia');

Esta función devuelve el número de elementos del subconjunto EurAsia de la jerarquía Eastern de ladimensión Region.

HierarchySubsetGetElementNameHierarchySubsetGetElementName devuelve el nombre del elemento de una ubicación de índiceespecificada en un determinado subconjunto de una jerarquía de dimensión.

Capítulo 5. funciones de TurboIntegrator 383

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchySubsetGetElementName(DimName, HierName, SubsetName, ElementIndex);

Argumento Descripción

DimName El padre del subconjunto del que desea recuperarun nombre de elemento.

HierName Nombre de la jerarquía de la dimensión.

SubsetName El subconjunto del que desea recuperar un nombrede elemento.

ElementIndex Un número que representa la posición dentro delsubconjunto del elemento que desea recuperar.

Ejemplo

HierarchySubsetGetElementName('Region', 'Western', 'Americas', 4);

Este ejemplo devuelve el nombre del cuarto elemento del subconjunto Americas de la jerarquía Westernen la dimensión Region.

HierarchySubsetIsAllSetHierarchySubsetIsAllSet establece un subconjunto para utilizar todos los elementos de la dimensiónpadre. HierarchySubsetIsAllSet devuelve 1 si es correcto; de lo contrario, devuelve 0.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchySubsetIsAllSet( DimName, HierName, SubName, Flag );

Argumento Descripción

DimName La dimensión padre del subconjunto del que deseautilizar todos los elementos.

HierName Nombre de la jerarquía de la dimensión.

SubName El subconjunto del que desea utilizar todos loselementos de la dimensión.

Flag Cualquier valor que no sea cero especifica que elsubconjunto utiliza todos los elementos actualesde la dimensión padre y que se actualizarádinámicamente para utilizar todos los elementosde la dimensión padre siempre que se llame alsubconjunto.

La especificación de un valor cero inmoviliza loselementos del subconjunto como conjunto actualde todos los elementos de la dimensión padre. Elsubconjunto no se actualizará dinámicamente parautilizar todos los elementos de la dimensión en elfuturo.

384 IBM Planning Analytics: Referencia de TM1

HierarchySubsetMDXGetHierarchySubsetMDXGet recupera la expresión MDX utilizada para crear un subconjunto.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchySubsetMDXGet(DimName, HierName, SubName);

Argumento Descripción

DimName Dimensión padre del subconjunto.

HierName Nombre de la jerarquía de la dimensión.

SubName Subconjunto para el que desea recuperar laexpresión MDX.

Ejemplo

mdxString = HierarchySubsetMDXGet('Cities', 'Italy', 'testsubset');

HierarchySubsetMDXSetHierarchySubsetMDXSet elimina la expresión MDX de un subconjunto dinámico y convierte elsubconjunto dinámico en un subconjunto estático sin bloquear la dimensión subyacente. El contenido delsubconjunto se conserva pero se elimina la expresión. Si lo desea, también puede llenar el subconjuntocon una expresión MDX nueva.

Todos los elementos antiguos en el momento de la llamada se guardan como elementos del nuevosubconjunto estático. La función devuelve el número de elementos que el subconjunto nuevo contiene.

Nota: Esta función solamente funciona un subconjuntos públicos.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

HierarchySubsetMDXSet(DimName, HierName, SubName, MDX_expression);

Argumento Descripción

DimName Dimensión padre del subconjunto.

HierName Nombre de la jerarquía de la dimensión.

SubName Subconjunto para el que desea eliminar laexpresión MDX.

MDX_expression La expresión MDX (opcional) con la que deseallenar el subconjunto. Todos los elementos sesuprimen y el subconjunto se llena con loselementos definidos por la expresión MDX nueva.Si la expresión MDX no es válida, el procesamientode TurboIntegrator se detiene, el contenido delsubconjunto no se cambia y se registra un error.

Si no utiliza este parámetro, incluya una cadenavacía como se muestra en el ejemplo.

Capítulo 5. funciones de TurboIntegrator 385

Ejemplo

countMem = HierarchySubsetMDXSet('Cities', 'Italy', 'testsubset', '');

SubsetAliasSetSubsetAliasSet establece el atributo de alias que se utilizará en un subconjunto. SubsetAliasSet devuelve1 si es correcto; de lo contrario, devuelve 0.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SubsetAliasSet( DimName, SubName, AliasName );

Argumento Descripción

DimName La dimensión padre del subconjunto para el quedesea establecer el alias.

SubName El subconjunto para el que desea establecer elalias.

AliasName El alias que desea utilizar en el subconjunto.

SubsetCreateSubsetCreate crea un subconjunto público vacío de una determinada dimensión.

Cuando el argumento AsTemporary se establece en 1, el subconjunto es temporal y existe solamentemientras dure el proceso o la tarea de TurboIntegrator de confirmación única donde sea ha creado elsubconjunto. Si un proceso TurboIntegrator invoca procesos TurboIntegrator hijo utilizando la funciónExecuteProcess o ExecuteProcessWithReturn y se crea el subconjunto temporal en uno de estosprocesos TurboIntegrator hijo, el subconjunto se mantiene mientras dura el proceso de TurboIntegratorpadre.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Nota:

En TM1 Server versión 11.2.0 y anterior, las vistas y subconjuntos temporales solo las podía ver elproceso que las había creado y cualquiera de sus procesos hijo. Las vistas y subconjuntos temporales noestaban visibles para procesos de ancestros y hermanos. Se podían crear subconjuntos con el mismonombre en procesos hijo hermanos con el mismo proceso padre. Se podían crear subconjuntos con elmismo nombre en procesos hijo hermanos con el mismo proceso padre.

En TM1 Server versión 11.3.0 y posterior, estos subconjuntos temporales están visibles para los procesosde ancestros y hermanos. Si un proceso padre A de TurboIntegrator invoca dos procesos hijo A1 y A2 deTurboIntegrator y el proceso A1 de TurboIntegrator crea un subconjunto temporal S, el subconjuntotemporal S existe mientras dura el proceso A de TurboIntegrator. No puede crear un subconjuntotemporal con el mismo nombre S en el proceso A2 de TurboIntegrator ya que los procesos hermanos A1y A2 pueden ver y utilizar el subconjunto.

Una tarea es un caso especial de un proceso de TurboIntegrator padre que invoca un procesoTurboIntegrator hijo que se ha planificado para ejecutarse en un momento específico. Puede utilizar dostipos de tareas.

Confirmación únicaEn el árbol de ámbito/ejecución de una tarea de confirmación única, solo se puede crear unsubconjunto temporal del mismo nombre para un proceso TurboIntegrator hijo.

Confirmación múltipleEn el árbol de ámbito/ejecución de una tarea de confirmación múltiple, que se confirma después decada proceso TurboIntegrator hijo, cada proceso TurboIntegrator hijo puede crear un subconjunto

386 IBM Planning Analytics: Referencia de TM1

temporal del mismo nombre, ya que un subconjunto temporal no persiste después de unaconfirmación.

Mientras exista un subconjunto temporal, éste tiene prioridad frente a cualquier subconjunto público oprivado con el mismo nombre. Si otra función de TurboIntegrator hace referencia a un subconjunto queexiste tanto como temporal y como permanente, la función utiliza el subconjunto temporal.

No hay bloqueos asociados a un subconjunto temporal, ya que un subconjunto temporal no se guardanunca. Esto puede mejorar el rendimiento, ya que no es necesario que TurboIntegrator espere a que seliberen los bloqueos para poder realizar operaciones en un subconjunto temporal.

Sintaxis

SubsetCreate(DimName, SubName, [AsTemporary]);

Argumento Descripción

DimName La dimensión padre del subconjunto que estácreando.

SubName El nombre que desea asignar al subconjunto.

AsTemporary Este es un argumento opcional que especifica si elsubconjunto que se va a crear es temporal. 1 indicaque se trata de un subconjunto temporal. 0 indicaque se trata de un subconjunto permanente.

Si este argumento se omite, el subconjunto serápermanente.

Ejemplo

SubsetCreate('Region', 'Northern Europe', 1);

Este ejemplo crea el subconjunto temporal Northern Europe de la dimensión Region. Puede utilizarSubsetElementInsert para añadir elementos al subconjunto.

SubsetCreateByMDXSubsetCreateByMDX crea un subconjunto público basado en una expresión MDX que se ha pasado.

Cuando el argumento AsTemporary se establece en 1, el subconjunto es temporal y existe mientrasdure el proceso o la tarea de TurboIntegrator de confirmación única donde sea ha creado el subconjunto.Si un proceso TurboIntegrator invoca procesos TurboIntegrator hijo utilizando la funciónExecuteProcess o ExecuteProcessWithReturn y se crea el subconjunto temporal en uno de estosprocesos TurboIntegrator hijo, el subconjunto se mantiene mientras dura el proceso de TurboIntegratorpadre.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Nota:

En TM1 Server versión 11.2.0 y anterior, las vistas y subconjuntos temporales solo las podía ver elproceso que las había creado y cualquiera de sus procesos hijo. Las vistas y subconjuntos temporales noestaban visibles para procesos de ancestros y hermanos. Se podían crear subconjuntos con el mismonombre en procesos hijo hermanos con el mismo proceso padre. Se podían crear subconjuntos con elmismo nombre en procesos hijo hermanos con el mismo proceso padre.

En TM1 Server versión 11.3.0 y posterior, estos subconjuntos temporales están visibles para los procesosde ancestros y hermanos. Si un proceso padre A de TurboIntegrator invoca dos procesos hijo A1 y A2 deTurboIntegrator y el proceso A1 de TurboIntegrator crea un subconjunto temporal S, el subconjuntotemporal S existe mientras dura el proceso A de TurboIntegrator. No puede crear un subconjunto

Capítulo 5. funciones de TurboIntegrator 387

temporal con el mismo nombre S en el proceso A2 de TurboIntegrator ya que los procesos hermanos A1y A2 pueden ver y utilizar el subconjunto.

Una tarea es un caso especial de un proceso TurboIntegrator padre que invoca un procesoTurboIntegrator hijo. Puede utilizar dos tipos de tareas.

Confirmación únicaEn el árbol de ámbito/ejecución de una tarea de confirmación única, solo se puede crear unsubconjunto temporal del mismo nombre para un proceso TurboIntegrator hijo.

Confirmación múltipleEn el árbol de ámbito/ejecución de una tarea de confirmación múltiple, que se confirma después decada proceso TurboIntegrator hijo, cada proceso TurboIntegrator hijo puede crear un subconjuntotemporal del mismo nombre, ya que un subconjunto temporal no persiste después de unaconfirmación.

Mientras exista un subconjunto temporal, éste tiene prioridad frente a cualquier subconjunto público oprivado con el mismo nombre. Si otra función de TurboIntegrator hace referencia a un subconjunto queexiste tanto como temporal y como permanente, la función utiliza el subconjunto temporal.

No hay bloqueos asociados a un subconjunto temporal, ya que un subconjunto temporal no se guardanunca. Esto puede mejorar el rendimiento, ya que no es necesario que TurboIntegrator espere a que seliberen los bloqueos para poder realizar operaciones en un subconjunto temporal.

Sintaxis

SubsetCreatebyMDX(SubName, MDX_Expression, [AsTemporary]);

Argumento Descripción

SubName El nombre que desea asignar al subconjunto.

MDX_Expression Una expresión MDX que devuelve un subconjunto.

AsTemporary Este es un argumento opcional que especifica si elsubconjunto que se va a crear es temporal. 1 indicaque se trata de un subconjunto temporal. 0 indicaque se trata de un subconjunto permanente.

Si este argumento se omite, el subconjunto serápermanente.

Ejemplo

SubsetCreatebyMDX('0-level months', '{TM1SORT( {TM1FILTERBYLEVEL( {TM1SUBSETALL([month] )}, 0)}, ASC)} ', 1 );

Este ejemplo crea un subconjunto público con el nombre '0-level months' basado en una expresión MDXque devuelve un subconjunto que consta de todos los elementos de nivel 0 de la dimensión Month,clasificados en orden alfabético ascendente.

Ejemplo de un subconjunto temporal utilizado por el proceso padre

En este ejemplo se crean dos procesos. El proceso padre, Proceso A, invoca al proceso hijo, Proceso B. ElProceso B crea un subconjunto temporal que el Proceso A utiliza como origen de datos.

Proceso A/prólogo

ExecuteProcess('Process-B');DatasourceDimensionSubset = 'My2003Months';

388 IBM Planning Analytics: Referencia de TM1

Proceso B/prólogo

SubsetCreateByMdx('My2003Months', '{[plan_time].[Jan-2003],[plan_time].[Jul-2003]}', 1);

SubsetDeleteAllElementsSubsetDeleteAllElements elimina todos los elementos de un subconjunto público.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SubsetDeleteAllElements(DimName, SubsetName);

Argumento Descripción

DimName La dimensión padre del subconjunto del que deseaeliminar elementos.

SubsetName El subconjunto del que desea eliminar elementos.Debe ser un subconjunto público. TurboIntegratorno puede acceder a objetos privados.

Ejemplo

SubsetDeleteAllElements('Región', 'Europa Central');

Este ejemplo elimina todos los elementos del subconjunto Europa Central de la dimensión Región.

SubsetDestroySubsetDestroy suprime un subconjunto de la base de datos de TM1.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SubsetDestroy(DimName, SubName);

Argumento Descripción

DimName La dimensión padre del subconjunto que estáeliminando.

SubName El nombre del subconjunto que desea eliminar.

Ejemplo

SubsetDestroy('Región', 'Europa del Norte');

Este ejemplo elimina el subconjunto Europa del Norte de la dimensión Región.

SubsetElementDeleteSubsetElementDelete elimina un elemento de un subconjunto.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SubsetElementDelete(DimName, SubName, Index);

Capítulo 5. funciones de TurboIntegrator 389

Argumento Descripción

DimName La dimensión padre del subconjunto del que deseaeliminar un elemento.

SubName El subconjunto del que desea eliminar unelemento.

Index El número de índice del elemento que deseaeliminar del subconjunto.

Ejemplo

SubsetElementDelete('Región', 'Europa del Norte', 3);

Este ejemplo suprime el tercer elemento del subconjunto Northern Europe de la dimensión Region.

SubsetElementExistsSubsetElementExists determina si existe un elemento específico en un subconjunto público concreto enel servidor en que se ejecuta un proceso de TurboIntegrator. SubsetElementExists no se puede utilizarpara determinar si un elemento existe en un subconjunto privado.

Si el elemento existe en el subconjunto especificado, la función devuelve 1; de lo contrario, devuelve 0.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SubsetElementExists(DimName, SubsetName, ElementName);

Argumento Descripción

DimName Dimensión padre del subconjunto que contiene elelemento cuya existencia desea confirmar.

SubsetName Subconjunto público que contiene el elementocuya existencia desea confirmar.

ElementName Elemento cuya existencia desea confirmar.

Ejemplo

SubsetElementExists('Region', 'Europe', 'Italy');

Este ejemplo determina si el elemento Italy existe en el subconjunto Europe de la dimensión Region.

SubsetElementGetIndexSubsetElementGetIndex recupera el índice de un elemento de un subconjunto. La función devuelve elíndice de la primera aparición del elemento especificado.

Si el elemento no existe en el subconjunto o no se encuentra, se devuelve cero. Si la dimensión o elsubconjunto no se encuentran o se especifica un índice de inicio fuera de rango, se generará un error y lafunción de TurboIntegrator se detendrá.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SubsetElementGetIndex(DimName, SubsetName, ElementName, StartIndex);

390 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

DimName Dimensión padre del subconjunto.

SubsetName Subconjunto que contiene el elemento.

ElementName Nombre (o alias) del elemento que desea buscaren el subconjunto.

StartIndex Número de índice desde el que se iniciará labúsqueda. El valor debe estar comprendido entre 1y el tamaño del subconjunto.

Ejemplo

SubsetElementGetIndex('Region', 'Europe', 'Italy', 3);

Este ejemplo recupera el índice de Italy del subconjunto Europe de la dimensión Region. La búsquedaempieza en el índice 3.

SubsetElementInsertSubsetElementInsert añade un elemento a un subconjunto existente.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SubsetElementInsert(DimName, SubName, ElName, Position);

Argumento Descripción

DimName La dimensión padre del subconjunto al que deseaañadir un elemento.

SubName El nombre del subconjunto al que está añadiendoun elemento.

ElName El nombre del elemento que desea añadir alsubconjunto. El elemento debe existir en la basede datos de TM1.

Position Un valor que indica la posición de índice delelemento dentro del subconjunto.

Ejemplo

SubsetElementInsert('Región', 'Europa del Norte', 'Finlandia', 3);

Este ejemplo añade el elemento Finland al subconjunto Northern Europe de la dimensión Region. Finlandes el tercer elemento de la definición de subconjunto.

SubsetExistsSubsetExists determina si un subconjunto público específico existe en el servidor desde el que se ejecutaun proceso de TurboIntegrator.

La función devuelve 1 si el subconjunto existe en el servidor; de lo contrario, devuelve 0. Tenga en cuentaque esta función no se puede utilizar para determinar la existencia de subconjuntos privados.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Capítulo 5. funciones de TurboIntegrator 391

Sintaxis

SubsetExists(DimName, SubsetName);

Argumento Descripción

DimName El nombre de la dimensión que es el padre delsubconjunto cuya existencia desea confirmar.

SubsetName El nombre del subconjunto público cuya existenciadesea confirmar

Ejemplo

SubsetExists('Región', 'Europa del Norte');

Este ejemplo determina si el subconjunto Europa del Norte del cubo Región existe en el servidor.

SubsetExpandAboveSetSubsetExpandAboveSet configura la propiedad Expand Above de un subconjunto. La función devuelve 1si es correcta; de lo contrario, devuelve 0.

Cuando esta propiedad está configurada como TRUE, los hijos de una consolidación aparecen encima dela consolidación cuando la consolidación aparece en una fila, y a la izquierda de la consolidación cuandola consolidación aparece en una columna.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SubsetExpandAboveSet( DimName, SubsetName, ExpandAboveFlag);

Argumento Descripción

DimName La dimensión padre del subconjunto para el quedesea configurar la propiedad Expand Above.

SubsetName El subconjunto para el que desea configurar lapropiedad Expand Above.

ExpandAboveFlag Defina ExpandAboveFlag como 1 para configurar lapropiedad Expand Above como TRUE. Cuando estapropiedad es TRUE; las consolidaciones sedespliegan por encima de las filas y a la izquierdade las columnas.

Defina ExpandAboveFlag como 0 para configurar lapropiedad Expand Above como FALSE. Cuandoesta propiedad es FALSE, las consolidaciones sedespliegan por debajo de las filas y a la derecha delas columnas.

Ejemplo

SubsetExpandAboveSet('Región', 'Europa', 1 );

Este ejemplo configura la propiedad Expand Above como TRUE para el subconjunto Europa de ladimensión Región.

392 IBM Planning Analytics: Referencia de TM1

SubsetFormatStyleSetSubsetFormatStyleSet aplica un estilo de visualización existente a un subconjunto con nombre.

Los estilos de visualización se definen para elementos específicos. Si aplica un estilo de visualizaciónexistente a un subconjunto que incluye elementos que no se incluyen en el estilo de visualización, no seaplicará formateo a dichos elementos.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SubsetFormatStyleSet( DimName, SubsetName, FormatName);

Argumento Descripción

DimName La dimensión padre del subconjunto al que deseaaplicar un estilo de visualización.

SubsetName El nombre del subconjunto al que está aplicandoun estilo de visualización.

FormatName El nombre del estilo de visualización existente quedesea aplicar al subconjunto.

Ejemplo

SubsetFormatStyleSet ('Región', 'Europa del Norte', 'BoldCurrencyLeftJustified');

Este ejemplo aplica el estilo de visualización BoldCurrencyLeftJustified al subconjunto Europa del Nortede la dimensión Región.

SubsetGetElementNameSubsetGetElementName devuelve el nombre del elemento en una ubicación de índice especificadadentro de un determinado subconjunto.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SubsetGetElementName(DimName, SubsetName, ElementIndex);

Argumento Descripción

DimName El padre del subconjunto del que desea recuperarun nombre de elemento.

SubsetName El subconjunto del que desea recuperar un nombrede elemento.

ElementIndex Un número que representa la posición dentro delsubconjunto del elemento que desea recuperar.

Ejemplo

SubsetGetElementName('Región', 'América', 4);

Este ejemplo devuelve el nombre del cuarto elemento del subconjunto América de la dimensión Región.

Capítulo 5. funciones de TurboIntegrator 393

SubsetGetSizeSubsetGetSize devuelve el número de elementos de un subconjunto.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SubsetGetSize(DimName, SubsetName);

Argumento Descripción

DimName La dimensión padre del subconjunto cuyo tamañodesea determinar.

SubsetName El subconjunto cuyo tamaño desea determinar.

Ejemplo

SubsetGetSize('Región', 'EurAsia');

Esta función devuelve el número de elementos del subconjunto EurAsia de la dimensión Región.

SubsetIsAllSetSubsetIsAllSet establece un subconjunto para utilizar todos los elementos de la dimensión padre.SubsetIsAllSet devuelve 1 si es correcto; de lo contrario, devuelve 0.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SubsetIsAllSet( DimName, SubName, Flag );

Argumento Descripción

DimName La dimensión padre del subconjunto del que deseautilizar todos los elementos.

SubName El subconjunto del que desea utilizar todos loselementos de la dimensión.

Flag Cualquier valor que no sea cero especifica que elsubconjunto utiliza todos los elementos actualesde la dimensión padre y que se actualizarádinámicamente para utilizar todos los elementosde la dimensión padre siempre que se llame alsubconjunto.

La especificación de un valor cero inmoviliza loselementos del subconjunto como conjunto actualde todos los elementos de la dimensión padre. Elsubconjunto no se actualizará dinámicamente parautilizar todos los elementos de la dimensión en elfuturo.

SubsetMDXGetSubsetMDXGet recupera la expresión MDX utilizada para crear un subconjunto.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

394 IBM Planning Analytics: Referencia de TM1

Sintaxis

SubsetMDXGet(DimName, SubName);

Argumento Descripción

DimName Dimensión padre del subconjunto.

SubName Subconjunto para el que desea recuperar la expresión MDX.

Ejemplo

mdxString = SubsetMDXGet('Cities', 'testsubset');

SubsetMDXSetSubsetMDXSet elimina la expresión MDX de un subconjunto dinámico y convierte el subconjuntodinámico en un subconjunto estático sin bloquear la dimensión subyacente. El contenido del subconjuntose conserva pero se elimina la expresión. Si lo desea, también puede llenar el subconjunto con unaexpresión MDX nueva.

Todos los elementos antiguos en el momento de la llamada se guardan como elementos del nuevosubconjunto estático. La función devuelve el número de elementos que el subconjunto nuevo contiene.

Nota: Esta función solamente funciona un subconjuntos públicos.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

SubsetMDXSet(DimName, SubName, MDX_expression);

Argumento Descripción

DimName Dimensión padre del subconjunto.

SubName Subconjunto para el que desea eliminar laexpresión MDX.

MDX_expression La expresión MDX (opcional) con la que deseallenar el subconjunto. Todos los elementos sesuprimen y el subconjunto se llena con loselementos definidos por la expresión MDX nueva.Si la expresión MDX no es válida, el procesamientode TurboIntegrator se detiene, el contenido delsubconjunto no se cambia y se registra un error.

Si no utiliza este parámetro, incluya una cadenavacía como se muestra en el ejemplo.

Ejemplo

countMem = SubsetMDXSet('Cities', 'testsubset', '');

Funciones de TurboIntegrator de manipulación de vistasEstas funciones pertenecen a la manipulación de vistas.

Capítulo 5. funciones de TurboIntegrator 395

PublishViewPublishView publica una vista privada con nombre en el servidor.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

PublishView(Cube, View, PublishPrivateSubsets, OverwriteExistingView);

Argumento Descripción

Cube El nombre del cubo que contiene la vista privadaque se publicará.

View El nombre de la vista privada que se publicará.

PublishPrivateSubsets Este argumento booleano (1 o 0) determina sitambién debe publicarse algún subconjuntoprivado presente en la vista.

Si PublishPrivateSubsets es true (1), todos lossubconjuntos privados utilizados en la vista sepublican junto con la vista.

Si este argumento es false (0), los subconjuntosprivados no se publican. Una vista pública nopuede contener subconjuntos privados, de modoque la vista no se publicará y se escribirá un erroren el archivo de registro de TurboIntegrator.

Nota: Si un subconjunto privado contiene otrosubconjunto privado como consolidación definidapor el usuario, el subconjunto nunca podrápublicarse utilizando la función PublishView,independientemente del valor del argumentoPublishPrivateSubsets.

OverwriteExistingView Este argumento booleano (1 o 0) determina si debesobrescribirse alguna vista pública existente con elmismo nombre cuando se publique la vistaprivada.

Si OverwriteExistingView es true (1), cualquiervista pública existente con el mismo nombre sesobrescribirá cuando se publique la vista privada.

Si este argumento es false (0), la vista pública nose sobrescribirá, la vista privada no se publicará yse escribirá un error en el archivo de registro deTurboIntegrator.

DisableMTQViewConstructDisableMTQViewConstruct inhabilita el proceso de consulta de varias hebras cuando calcula una vistaque se utilizará como origen de datos de TurboIntegrator para un único proceso de TurboIntegrator.Cuando MTQQuery=T en el archivo tms1.cfg, se puede invocar DisableMTQViewConstruct parareemplazar este valor en un proceso TurboIntegrator.

Esta función debe aparecer en el Prólogo, no tiene efecto alguno en ningún otro procedimiento de unproceso.

396 IBM Planning Analytics: Referencia de TM1

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

Nota: Si el valor del parámetro MTQ es 1 (o es OFF), esta funcionalidad se desactiva y no se puedesustituir.

El valor de MTQQuery se puede reemplazar en un proceso TurboIntegrator individual invocando lafunción DisableMTQViewConstruct.

Si MTQQuery=T (valor predeterminado), se puede invocar DisableMTQViewConstruct para inhabilitar lafunción de procesos individuales de TurboIntegrator.

Después de habilitar EnableMTQViewConstruct en un proceso, solo se podrá inhabilitar en la última líneade la sección Epílogo. Si intenta utilizar la DisableMTQViewConstruct en cualquier otro proceso, elproceso no se compilará.

Si se habilita el modo de carga de gran volumen en un proceso de TurboIntegrator, continuará habilitadohasta que se desactive explícitamente o hasta que la tarea finalice. Esto significa que puede habilitar elmodo en un proceso y, a continuación, ejecutar una serie de procesos de TurboIntegrator antes deinhabilitarlo.

Ejemplo

Utilice los siguientes mandatos de TurboIntegrator para inhabilitar procesos de consulta de varias hebrascuando calcula una vista para que se utilice como origen de datos de TurboIntegrator para un únicoproceso de TurboIntegrator.

DisableMTQViewConstruct()

Consulte también “EnableMTQViewConstruct” en la página 397.

EnableMTQViewConstructEnableMTQViewConstruct habilita el proceso de consulta de varias hebras cuando calcula una vista quese utilizará como origen de datos de TurboIntegrator para un único proceso de TurboIntegrator. CuandoMTQQuery=F en el archivo tms1.cfg, se puede invocar EnableMTQViewConstruct para reemplazar estevalor en un proceso TurboIntegrator.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

Nota: Si el valor del parámetro MTQ es 1 (o es OFF), esta funcionalidad se desactiva y no se puedesustituir.

El valor de MTQQuery se puede reemplazar en un proceso TurboIntegrator individual invocando lafunción EnableMTQViewConstruct.

Si MTQQuery=F en el archivo tms1.cfg donde se ejecuta esta función, se puede invocarEnableMTQViewConstruct para reemplazar este valor en un proceso TurboIntegrator individual.

Puede habilitar EnableMTQViewConstruct en la sección Prólogo o Epílogo de un proceso deTurboIntegrator. Para una mayor eficacia, habilite EnableMTQViewConstruct en la primera sentencia, oen la que esté más cerca de la primera, en la sección Prólogo del proceso.

Ejemplo

Utilice los siguientes mandatos de TurboIntegrator para habilitar procesos de consulta de varias hebrascuando calcula una vista para que se utilice como origen de datos de TurboIntegrator para un únicoproceso de TurboIntegrator.

EnableMTQViewConstruct()

Capítulo 5. funciones de TurboIntegrator 397

Consulte también “DisableMTQViewConstruct” en la página 396.

Después de habilitar EnableMTQViewConstruct en un proceso, solo se podrá inhabilitar en la última líneade la sección Epílogo. Si intenta utilizar la inhabilitación de DisableMTQViewConstruct en cualquier otroproceso, el proceso no se compilará.

Si se habilita el modo de carga de gran volumen en un proceso de TurboIntegrator, continuará habilitadohasta que se desactive explícitamente o hasta que la tarea finalice. Esto significa que puede habilitar elmodo en un proceso y, a continuación, ejecutar una serie de procesos de TurboIntegrator antes deinhabilitarlo.

ViewColumnDimensionSetViewColumnDimensionSet establece una dimensión de columna para una vista de TM1.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewColumnDimensionSet(CubeName, ViewName, DimName, StackPosition);

Argumento Descripción

CubeName El cubo padre de la vista para la que estáestableciendo la dimensión de columnas.

ViewName La vista para la que está estableciendo ladimensión de columna.

DimName La dimensión que desea establecer comodimensión de columna para la vista.

StackPosition Un número que indica la posición de pila de ladimensión en la vista. Se trata de un númerobasado en 1. 1 indica la posición de pila más alta. 2indica una posición inferior a 1, etc.

Ejemplo

ViewColumnDimensionSet('98sales', 'Quarter1', 'Month',1);

Este ejemplo establece Month como una dimensión de columna para la vista 1Quarter del cubo 98sales.En el caso de que aparezcan dimensiones de columnas apiladas, Month se coloca en la posición más alta.

ViewColumnSuppressZeroesSetViewColumnSuppressZeroesSet suprime o habilita la visualización de las columnas que solo contienenvalores de cero en una vista de cubo de TM1.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewColumnSuppressZeroesSet(Cube, ViewName, Flag);

Argumento Descripción

Cubo El cubo padre de la vista para la que deseasuprimir o permitir la visualización de valores cero.

398 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

ViewName La vista para la que desea permitir o suprimir lavisualización de ceros.

Flag Un valor binario que permite o suprime ceros.Especifique 1 para suprimir la visualización decolumnas que contengan únicamente ceros en lavista. Especifique 0 para permitir la visualizaciónde columnas que contengan únicamente ceros.

Ejemplo

ViewColumnSuppressZeroesSet('99sales', '1st QuarterActuals', 1);

Este ejemplo suprime la visualización de las columnas que contengan únicamente ceros en la vistaValores reales 1er trimestre del cubo ventas99.

ViewConstructViewConstruct construye, calcula previamente y almacena una vista Stargate en la memoria de unservidor. Esta función resulta útil para el cálculo previo y el almacenamiento de vistas grandes, de modoque se pueda acceder a ellas rápidamente tras una actualización o carga de datos.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewConstruct(CubeName, ViewName);

Argumento Descripción

CubeName El cubo desde el que desea construir la vista.

ViewName La vista que desea construir. Esta vista debe seruna vista pública existente en el servidor.

Ejemplo

Viewconstruct('99sales', '1st Quarter Actuals');

Este ejemplo crea la vista 1st Quarter Actuals del cubo 99sales.

ViewCreateViewCreate crea una vista vacía de un cubo especificado.

Cuando el argumento opcional AsTemporary se establece en 1, la vista es temporal y existe solamentemientras dure el proceso o la tarea de TurboIntegrator donde sea ha creado la vista.

Nota:

En la versión 11.2.0 y anteriores de TM1 Server, las vistas temporales solo las podía ver el proceso quelas había creado y cualquiera de sus procesos hijo. Las vistas temporales no estaban visibles paraprocesos de ancestros y hermanos. Se podían crear vistas con el mismo nombre en procesos hijohermanos con el mismo proceso padre. Se podían crear subconjuntos con el mismo nombre en procesoshijo hermanos con el mismo proceso padre.

Capítulo 5. funciones de TurboIntegrator 399

En la versión 11.3.0 y posteriores de TM1 Server, estas vistas temporales están visibles para los procesosde ancestros y hermanos. Si un proceso padre A de TurboIntegrator invoca dos procesos hijo A1 y A2 deTurboIntegrator y el proceso A1 de TurboIntegrator crea una vista temporal S, la vista temporal S existemientras dura el proceso A de TurboIntegrator. No puede crear una vista temporal con el mismo nombreS en el proceso A2 de TurboIntegrator ya que los procesos hermanos A1 y A2 pueden ver y utilizar lavista.

Mientras exista una vista temporal, esta tendrá prioridad frente a una vista pública que tenga el mismonombre. Si otra función de TurboIntegrator hace referencia a una vista que existe tanto como temporal ycomo permanente, la función utiliza la vista temporal.

Los objetos temporales tienen ámbito de transacción. Cuando se confirma una transacción, se limpiantodos los objetos temporales. Si una tarea se ejecuta en modalidad de confirmación única en la que todoslos procesos de la tarea se ejecutan lógicamente en el contexto de una transacción, los objetostemporales que se crean en un proceso siguen existiendo, son visibles y están disponibles para su uso enprocesos posteriores que ejecute la tarea.Sin embargo, en la modalidad de confirmación múltiple, estosprocesos se limpian en el momento de la confirmación de la transacción que ha ajustado la ejecución delproceso creado por el objeto temporal.

No hay bloqueos asociados a una vista temporal, ya que una vista temporal nunca se guarda. Esto puededar como resultado una mejora del rendimiento, ya que no es necesario que TurboIntegrator espere aque se liberen los bloqueos antes de trabajar con una vista temporal.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewCreate(Cube, ViewName, <AsTemporary>);

Argumento Descripción

Cube El cubo padre de la vista que está creando.

ViewName El nombre que desea asignar a la vista.

AsTemporary Argumento opcional que especifica si la vista quese va a crear es temporal. 1 indica que se trata deuna vista temporal y 0 que se trata de una vistapermanente.

Si este argumento se omite, la vista serápermanente.

Ejemplo

Este ejemplo crea una vista temporal llamada 1st Quarter Actuals a partir del cubo Sales.

ViewCreate('Sales', '1st Quarter Actuals', 1);

ViewCreateByMDXViewCreateByMDX crea una vista con una expresión MDX específica.

Cuando el argumento opcional AsTemporary se establece en 1, la vista es temporal y existe solamentemientras dure el proceso o la tarea de TurboIntegrator donde sea ha creado la vista.

Nota:

En la versión 11.2.0 y anteriores de TM1 Server, las vistas temporales solo las podía ver el proceso quelas había creado y cualquiera de sus procesos hijo. Las vistas temporales no estaban visibles paraprocesos de ancestros y hermanos. Se podían crear vistas con el mismo nombre en procesos hijo

400 IBM Planning Analytics: Referencia de TM1

hermanos con el mismo proceso padre. Se podían crear subconjuntos con el mismo nombre en procesoshijo hermanos con el mismo proceso padre.

En la versión 11.3.0 y posteriores de TM1 Server, estas vistas temporales están visibles para los procesosde ancestros y hermanos. Si un proceso padre A de TurboIntegrator invoca dos procesos hijo A1 y A2 deTurboIntegrator y el proceso A1 de TurboIntegrator crea una vista temporal S, la vista temporal S existemientras dura el proceso A de TurboIntegrator. No puede crear una vista temporal con el mismo nombreS en el proceso A2 de TurboIntegrator ya que los procesos hermanos A1 y A2 pueden ver y utilizar lavista.

Mientras exista una vista temporal, esta tendrá prioridad frente a una vista pública que tenga el mismonombre. Si otra función de TurboIntegrator hace referencia a una vista que existe tanto como temporal ycomo permanente, la función utiliza la vista temporal.

Los objetos temporales tienen ámbito de transacción. Cuando se confirma una transacción, se limpiantodos los objetos temporales. Si una tarea se ejecuta en modalidad de confirmación única en la que todoslos procesos de la tarea se ejecutan lógicamente en el contexto de una transacción, los objetostemporales que se crean en un proceso siguen existiendo, son visibles y están disponibles para su uso enprocesos posteriores que ejecute la tarea. Sin embargo, en la modalidad de confirmación múltiple, estosprocesos se limpian en el momento de la confirmación de la transacción que ha ajustado la ejecución delproceso creado por el objeto temporal.

No hay bloqueos asociados a una vista temporal, ya que una vista temporal nunca se guarda. Esto puedemejorar el rendimiento, ya que no es necesario que TurboIntegrator espere a que se liberen los bloqueospara poder realizar operaciones en una vista temporal.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewCreateByMDX(Cube, ViewName, MDX_expression , <AsTemporary>);

Argumento Descripción

Cube El cubo padre de la vista que está creando.

ViewName El nombre que desea asignar a la vista.

MDX_expression Valor de cadena que contiene una expresión devista MDX válida.

AsTemporary Argumento opcional que especifica si la vista quese va a crear es temporal. 1 indica que se trata deuna vista temporal y 0 que se trata de una vistapermanente.

Si este argumento se omite, la vista serápermanente.

Ejemplo

Este ejemplo, basado en la base de datos de ejemplo de Planning, crea una vista temporal denominadaAccount en el cubo plan_BudgetPlan.

ViewCreateByMDX('plan_BudgetPlan', 'Account', 'select {[plan_version].[FY 2003 Budget]} on 0, {[plan_business_unit].[10300]} on 1 from plan_budgetplan where [plan_department].[200][plan_chart_of_accounts].[41101][plan_exchange_rates].[local][plan_source].[goal][plan_time].[Jan-2003]' ,1);

Capítulo 5. funciones de TurboIntegrator 401

ViewDestroyViewDestroy suprime una vista de la base de datos de TM1.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewDestroy(Cube, ViewName);

Argumento Descripción

Cube El cubo padre de la vista que está eliminando.

ViewName El nombre de la vista que desea eliminar.

Ejemplo

ViewDestroy('ventas99', 'Valores reales 1er trimestre');

Este ejemplo elimina la vista Valores reales 1er trimestre del cubo ventas99.

ViewExistsViewExists determina si existe una vista pública específica en el servidor en el que se ejecuta un procesode TurboIntegrator. La función devuelve 1 si la vista existe en el servidor; de lo contrario, devuelve 0.Tenga en cuenta que esta función no se puede utilizar para determinar la existencia de vistas privadas.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewExists(CubeName, ViewName);

Argumento Descripción

CubeName El nombre del cubo que es el padre de la vista cuyaexistencia desea confirmar.

ViewName El nombre de la vista pública cuya existencia deseaconfirmar

Ejemplo

ViewExists('Inventario', 'Cierrefeb');

Este ejemplo determina si la vista Cierrefeb del cubo Inventario existe en el servidor.

ViewExtractFilterByTitlesSetViewExtractFilterByTitlesSet establece una opción para filtrar por mosaicos en valores consolidados quese excluyen de una vista o de cualquier extracción de vistas asociada.

TM1 permite el almacenamiento de cadenas en valores calculados. Cuando excluya un valor calculado deuna vista o extracción de vistas, tal vez le interese excluir también de la vista la cadena de mensaje.

Nota: Esta función afecta a las vistas según existen en el servidor. El ámbito de esta función no se limita aextracciones generadas a partir de una vista.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

402 IBM Planning Analytics: Referencia de TM1

Sintaxis

ViewExtractFilterByTitlesSet (Cube, ViewName, FilterByTitles, Temporary);

Argumento Descripción

Cube El cubo padre de la vista para la que estáestableciendo la opción.

ViewName La vista para la que está estableciendo la opción.

FilterByTitles Un valor binario que activa o desactiva la opción.Especifique 0 para incluir títulos almacenados envalores consolidados. Este es el comportamientoactual y predeterminado. Especifique 1 paraexcluir títulos almacenados en valoresconsolidados.

Temporary Un valor booleano que indica si los valores sontemporales.

Ejemplo

ViewExtractFilterByTitlesSet ('99sales', '1st QuarterActuals', 1, 0);

ViewExtractSkipCalcsSetViewExtractSkipCalcsSet establece una opción para incluir/excluir valores consolidados de una vista ycualquier extracción de vista asociada. Una extracción de vistas es una vista de TM1 exportada como unarchivo ASCII separado por comas (.cma).

Nota: Esta función afecta a las vistas según existen en el servidor. El ámbito de esta función no se limita aextracciones generadas a partir de una vista.

ViewExtractSkipCalcsSet equivale a la opción Omitir valores consolidados del cuadro de diálogoExtracción de vistas.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewExtractSkipCalcsSet (Cube, ViewName, Flag);

Argumento Descripción

Cube El cubo padre de la vista para la que estáestableciendo la opción.

ViewName La vista para la que está estableciendo la opción.

Flag Un valor binario que activa o desactiva la opción.Especifique 1 para excluir valores consolidados dela extracción de vistas. Especifique 0 para incluirvalores consolidados.

Capítulo 5. funciones de TurboIntegrator 403

Ejemplo

ViewExtractSkipCalcsSet ('99sales', '1st Quarter Actuals',1);

Este ejemplo activa la opción Omitir valores consolidados de la vista Valores reales 1er trimestre. Laextracción de vistas no incluirá valores consolidados.

Nota acerca del efecto que tiene habilitar una combinación concreta de funciones de manipulaciónde vistas

Considere un escenario en el que se cumplan todas estas condiciones:

• La medida es una cadena• ViewExtractSkipCalcsSet = 1• ViewExtractSkipConsolidatedStringsSet = 0 (la función no se utiliza)• ViewExtractSkipRuleValuesSet = 0 (la función no se utiliza)

En este escenario, la salida es diferente en función de si se habilita la función ViewExtractSkipZeroesSet ono.

• Si establece ViewExtractSkipZeroesSet = 0, el servidor de TM1 enumera todas las celdas de cuboposibles, no solamente las celdas de datos existentes. Esta situación es bastante inusual, ya que laenumeración de todas las celdas posibles significa que el número de celdas exploradas es el productode los tamaños de todas las dimensiones del cubo. Este producto se puede hacer grande muyrápidamente. En este modo, la función ViewExtractSkipCalcsSet omite todas las celdas consolidadas,incluso si la medida es una cadena.

• Si establece ViewExtractSkipZeroesSet = 1, el servidor de TM1 explora solamente las celdas que estánen el cubo. En este modo, una cadena almacenada en una celda consolidada se trata como una simplehoja (la celda, después de todo, tiene un valor simple y es una hoja). Por lo tanto, aunque la funciónViewExtractSkipCalcsSet está habilitada, la entrada no se omite porque esta celda no es una celdaconsolidada calculada. En este caso, si desea omitir las entradas, debe habilitar la funciónViewExtractSkipConsolidatedStringsSet.

ViewExtractSkipConsolidatedStringsSetViewExtractSkipConsolidatedStringsSet establece una opción para excluir cadenas en valoresconsolidados que se excluyen de una vista o de cualquier extracción de vistas asociada. Una extracciónde vistas es una vista de TM1 exportada como un archivo ASCII separado por comas (.cma).

TM1 permite el almacenamiento de cadenas en valores calculados. Cuando excluya un valor calculado deuna vista o extracción de vistas, tal vez le interese excluir también de la vista la cadena de mensaje.

Nota: Esta función afecta a las vistas según existen en el servidor. El ámbito de esta función no se limita aextracciones generadas a partir de una vista.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewExtractSkipConsolidatedStringSet (Cube, ViewName, Flag);

Argumento Descripción

Cube El cubo padre de la vista para la que estáestableciendo la opción.

ViewName La vista para la que está estableciendo la opción.

404 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

Flag Un valor binario que activa o desactiva la opción.Especifique 0 para incluir las cadenasalmacenadas en valores consolidados. Este es elcomportamiento actual y predeterminado.Especifique 1 para excluir las cadenasalmacenadas en valores consolidados.

Nota: Consulte la información sobre el efecto que tiene habilitar una combinación concreta de funcionesde manipulación de vistas.

Ejemplo

ViewExtractSkipConsolidatedStringsSet ('99sales', '1st QuarterActuals', 1);

Este ejemplo activa la opción Saltar regla para cadena consolidada para la extracción creada a partir de lavista 1st Quarter Actuals. La extracción no incluirá ninguna cadena del valor consolidado.

ViewExtractSkipRuleValuesSetViewExtractSkipRuleValuesSet establece una opción para incluir/excluir valores calculados medianteregla de una vista y cualquier extracción de vista asociada. Una extracción de vistas es una vista de TM1exportada como un archivo ASCII separado por comas (.cma).

ViewExtractSkipRuleValuesSet equivale a la opción Omitir valores calculados según reglas del cuadro dediálogo Extracción de vistas.

Nota: Esta función afecta a las vistas según existen en el servidor. El ámbito de esta función no se limita aextracciones generadas a partir de una vista.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewExtractSkipRuleValuesSet (Cube, ViewName, Flag);

Argumento Descripción

Cube El cubo padre de la vista para la que estáestableciendo la opción.

ViewName La vista para la que está estableciendo la opción.

Flag Un valor binario que activa o desactiva la opción.Especifique 1 para excluir valores calculadossegún reglas de la extracción. Especifique 0 paraincluir valores calculados según reglas.

Nota: Consulte la información sobre el efecto que tiene habilitar una combinación concreta de funcionesde manipulación de vistas.

Ejemplo

ViewExtractSkipRuleValuesSet ('99sales', '1st QuarterActuals', 1);

Este ejemplo activa la opción Omitir valores calculados según reglas para la extracción creada a partir dela vista Valores reales 1er trimestre. La extracción no incluirá valores calculados según reglas.

Capítulo 5. funciones de TurboIntegrator 405

ViewExtractSkipZeroesSetViewExtractSkipZeroesSet establece una opción para incluir/excluir valores cero de una vista y cualquierextracción de vista asociada. Una extracción de vistas es una vista de TM1 exportada como un archivoASCII separado por comas (.cma).

ViewExtractSkipZeroesSet equivale a la opción Omitir valores cero/en blanco del cuadro de diálogoExtracción de vistas.

Nota: Esta función afecta a las vistas según existen en el servidor. El ámbito de esta función no se limita aextracciones generadas a partir de una vista.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewExtractSkipZeroesSet (Cube, ViewName, Flag);

Argumento Descripción

Cube El cubo padre de la vista para la que estáestableciendo la opción Omitir ceros.

ViewName La vista para la que está estableciendo la opciónOmitir ceros.

Flag Un valor binario que activa o desactiva la opción.Especifique 1 para excluir ceros de la extracción.Especifique 0 para incluir ceros.

Cuando se utiliza UNDEFVALS para representarceros, los valores no se excluyen cuando elargumento Flag (distintivo) es 1.

Nota: Consulte la información sobre el efecto que tiene habilitar una combinación concreta de funcionesde manipulación de vistas.

Ejemplo

ViewExtractSkipZeroesSet ('99sales', '1st Quarter Actuals',1);

Este ejemplo activa la opción Omitir ceros para la extracción creada a partir de la vista 1st QuarterActuals. La extracción no incluirá valores en blanco ni ceros.

ViewMDXSetViewMDXSet establece la expresión MDX para una vista MDX existente.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewMDXSet(Cube, ViewName, MDX_expression);

Argumento Descripción

Cube El cubo padre de la vista que está creando.

ViewName El nombre que desea asignar a la vista.

406 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

MDX_expression Valor de cadena que contiene una expresión devista MDX válida.

Ejemplo

ViewMDXSet('Sales', 'Account', "select {[plan_version].[FY 2003 Budget]} on 0, {[plan_business_unit].[10300]} on 1 from plan_budgetplan where [plan_department].[200][plan_chart_of_accounts].[41101][plan_exchange_rates].[local][plan_source].[goal][plan_time].[Jan-2003]" );

Este ejemplo define la expresión MDX para la vista "Cuenta" del cubo "Ventas".

ViewMDXGetViewMDXGet recupera la expresión MDX para una vista MDX existente.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewMDXGet(Cube, ViewName);

Argumento Descripción

Cube El cubo padre de la vista que está creando.

ViewName El nombre que desea asignar a la vista.

Ejemplo

ViewMDXGet('Sales', 'Account');

Este ejemplo recupera la expresión MDX de la vista "Cuenta".

ViewRowDimensionSetViewRowDimensionSet establece una dimensión de fila para una vista de TM1.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewRowDimensionSet(CubeName, ViewName, DimName, StackPosition);

Argumento Descripción

CubeName El cubo padre de la vista para la que estáestableciendo la dimensión de fila.

ViewName La vista para la que está estableciendo ladimensión de fila.

Capítulo 5. funciones de TurboIntegrator 407

Argumento Descripción

DimName La dimensión que desea establecer comodimensión de fila para la vista.

StackPosition Un número que indica la posición de pila de ladimensión en la vista. Se trata de un númerobasado en 1. 1 indica la posición de pila más a laizquierda. 2 indica una posición a la derecha de 1,etc.

Nota: Un cliente de TM1 puede establecer unparámetro Tm1p.ini(BrowseDisplayReadsRightToLeft=T) que inviertala orientación de los datos en Cube Viewer. Cuandose invierte la orientación de los datos, se inviertentambién las posiciones de la pila. 1 indica laposición de pila más a la derecha. 2 indica unaposición a la izquierda de 1, etc.

Ejemplo

ViewRowDimensionSet('98sales', 'Quarter1', 'Month',1)

Este ejemplo establece Mes como dimensión de fila para la vista Trimestre1 del cubo ventas98. En elcaso de que aparezcan dimensiones de filas apiladas, Month se coloca en la posición más a la izquierda.

ViewRowSuppressZeroesSetViewRowSuppressZeroesSet suprime o permite la visualización de las filas que contienen únicamentevalores de cero en una vista de cubo de TM1.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewRowSuppressZeroesSet(Cube, ViewName, Flag);

Argumento Descripción

Cubo El cubo padre de la vista para la que deseasuprimir o permitir la visualización de valores cero.

ViewName La vista para la que desea permitir o suprimir lavisualización de ceros.

Flag Un valor binario que permite o suprime ceros.Especifique 1 para suprimir la visualización de filasque contienen únicamente ceros en la vista.Especifique 0 para permitir la visualización de filasque contienen únicamente ceros.

Ejemplo

ViewRowSuppressZeroesSet('99sales', '1st Quarter Actuals',1);

408 IBM Planning Analytics: Referencia de TM1

Este ejemplo suprime la visualización de las filas que contengan únicamente ceros en la vista Valoresreales 1er trimestre del cubo ventas99.

ViewSubsetAssignViewSubsetAssign asigna un subconjunto con nombre a una vista de cubos.

Nota: Se puede crear un subconjunto temporal con las funciones CreateSubset o CreateSubsetByMDX. Siintenta utilizar ViewSubsetAssign para asignar un subconjunto temporal a una vista permanente, lafunción fallará y generará una notificación de error.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewSubsetAssign(Cube, ViewName, DimName, SubName);

Argumento Descripción

Cube El cubo padre de la vista a la que está asignandoun subconjunto.

ViewName La vista a la que está asignando un subconjunto.

DimName La dimensión padre del subconjunto que estáasignando a la vista.

SubName El nombre del subconjunto que desea asignar a lavista.

Ejemplo

ViewSubsetAssign('ventas99', 'Valores reales 1er trimestre', 'Mes', 'T1');

Este ejemplo asigna el subconjunto T1 de la dimensión Mes a la vista 1er trimestre.

ViewSuppressZeroesSetViewSuppressZeroesSet suprime o permite la visualización de todas las filas y columnas que contenganúnicamente valores de cero en una vista de cubos de TM1.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewSuppressZeroesSet(Cube, ViewName, Flag);

Argumento Descripción

Cube El cubo padre de la vista para la que deseasuprimir o permitir la visualización de valores cero.

ViewName La vista para la que desea permitir o suprimir lavisualización de ceros.

Capítulo 5. funciones de TurboIntegrator 409

Argumento Descripción

Flag Un valor binario que permite o suprime ceros.Especifique 1 para suprimir la visualización de filaso columnas que contengan únicamente ceros en lavista. Especifique 0 para permitir la visualizaciónde filas y columnas que contengan únicamenteceros.

Ejemplo

ViewSuppressZeroesSet('99sales', '1st Quarter Actuals',1);

Este ejemplo suprime la visualización de las filas o columnas que contengan únicamente ceros en la vistaValores reales 1er trimestre del cubo ventas99.

ViewTitleDimensionSetViewTitleDimensionSet establece una dimensión de título para una vista de TM1.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewTitleDimensionSet(CubeName, ViewName, DimName);

Argumento Descripción

CubeName El cubo padre de la vista para la que estáestableciendo la dimensión de título.

ViewName La vista para la que está estableciendo ladimensión de título.

DimName La dimensión que desea establecer comodimensión de título para la vista.

Ejemplo

ViewTitleDimensionSet('ventas98', 'Trimestre1', 'Mes');

Este ejemplo establece Mes como dimensión de título para la vista Trimestre1 del cubo ventas98.

ViewTitleElementSetViewTitleElementSet establece un elemento de título para una vista de TM1. ViewTitleElementSet seutiliza de forma conjunta con la función ViewTitleDimensionSet.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewTitleElementSet(CubeName, ViewName, DimName, Index);

410 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

CubeName El cubo padre de la vista para la que estáestableciendo el elemento de título.

ViewName La vista para la que está estableciendo el elementode título.

DimName La dimensión padre del elemento de título.

Index Un índice en la dimensión especificada que indicael elemento que se establecerá como elemento detítulo.

Ejemplo

ViewTitleElementSet('98sales', 'Quarter1', 'Model',3);

Este ejemplo establece el tercer elemento de la dimensión Modelo como elemento de título de la vistaTrimestre1 del cubo ventas98.

ViewZeroOutViewZeroOut establece en cero todos los puntos de datos de una vista.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ViewZeroOut(Cube, ViewName);

Argumento Descripción

Cube El cubo padre de la vista que desea poner a cero.

ViewName La vista que desea poner a cero.

Ejemplo

ViewZeroOut('ventas99', 'Valores reales 1er trimestre');

Este ejemplo establece todos los puntos de datos de Valores reales 1er trimestre en cero.

Otras funciones de TurboIntegratorEstas funciones facilitan otras tareas.

AddInfoCubeRestrictionAddInfoCubeRestriction filtra los datos de InfoCube a medida que se introducen en TM1. Utilice estafunción para limitar los valores que se importan para una característica específica. Esta función debecolocarse en el Prólogo. La función puede llamarse varias veces para filtrar más de una característica enun único proceso.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Capítulo 5. funciones de TurboIntegrator 411

Sintaxis

AddInfoCubeRestriction(STRING CharactName, STRING sign,STRING compOperator, STRING lowValue, STRING highValue)

Argumento Descripción

STRING CharactName Contiene el nombre técnico de la característica quese va a limitar. El tipo de datos debe ser unacadena de caracteres con una longitud igual oinferior a 30.

STRING sign Contiene I (= inclusivo) o E (= exclusivo). Exclusivoes la función NOT lógica de la restricción queespecifica esta fila. El tipo de datos debe ser uncarácter con una longitud de 1.

STRING compOperator Contiene el operador comparativo relacional. Eltipo de datos debe ser una cadena de caracterescon una longitud de 2. Los operadorescomparativos válidos son:

'EQ' = igual

'NE' = no igual

'LT' = inferior a

'GT' = superior a

'LE' = inferior o igual

'GE' = superior o igual

'BT' = entre

'NB' = no entre

STRING lowValue Contiene el valor bajo del operador especificado enla fila anterior. El tipo de datos debe ser unacadena de caracteres con una longitud igual oinferior a 60.

STRING highValue Contiene el valor alto del operador especificado enlas dos filas anteriores. El tipo de datos debe seruna cadena de caracteres con una longitud igual oinferior a 60. Solo es necesario para los operadoresBT y NB, de lo contrario, se ignorará, y en este casose colocará aquí una cadena vacía.

Ejemplo

El ejemplo siguiente devuelve todos los valores de características entre 1997 y 2000.

AddInfoCubeRestriction('0CALYEAR','E','BT','1997','2000');

El ejemplo siguiente devuelve todos los valores de características que no están entre 1997 y 2000.

AddInfoCubeRestriction('0CALYEAR','I','NB','1997', '2000') ;

412 IBM Planning Analytics: Referencia de TM1

El ejemplo siguiente devuelve todos los valores de características que no sean iguales a USD.

AddInfoCubeRestriction('0DOC_CURRCY', 'I', 'NE', 'USD','') ;

ExecuteJavaNExecuteJavaN ejecuta un proceso Java™ de TurboIntegrator que devuelve un número. Si desea ejecutarun proceso Java de TurboIntegrator que devuelva una cadena, utilice ExecuteJavaS.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ExecuteJavaN('JavaTIClass', ['OptionalParameter1', 'OptionalParameter2', ...] )

Argumento Descripción

JavaTIClass Nombre completo de la clase Java deTurboIntegrator que desea ejecutar.

OptionalParameters Parámetros opcionales que se pasan al propioproceso Java de TurboIntegrator. Puede pasartantos parámetros como sean necesarios, incluidoninguno.

Solo puede pasar cadenas como parámetros; nopuede pasar números. Puede utilizar la funciónStringToNumber de TurboIntegrator para pasarnúmeros a los scripts Java de TurboIntegrator.Para obtener más información, consulte"StringToNumber" en la Referencia de TM1.

Una clase Java de TurboIntegrator que devuelve un número y se puede llamar desde ExecuteJavaN debeutilizar el patrón siguiente:

package com.example;

import com.ibm.cognos.tm1.javati.JavaTI;

@JavaTIpublic class MyTestTI { public static double MyTestTI (String [] args) [ ... return ...; }}

Ejemplo

ExecuteJavaN('com.example.MyTestTI', 'First', 'Second', 'Third');

ExecuteJavaSExecuteJavaS ejecuta un proceso Java de TurboIntegrator que devuelve una cadena. Si desea ejecutar unproceso Java de TurboIntegrator que devuelva un número, utilice ExecuteJavaN.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

ExecuteJavaS('JavaTIClass', ['OptionalParameter1', 'OptionalParameter2', ...] )

Capítulo 5. funciones de TurboIntegrator 413

Argumento Descripción

JavaTIClass Nombre completo de la clase Java deTurboIntegrator que desea ejecutar.

OptionalParameters Parámetros opcionales que se pasan al propioproceso Java de TurboIntegrator. Puede pasartantos parámetros como sean necesarios, incluidoninguno.

Solo puede pasar cadenas como parámetros; nopuede pasar números. Puede utilizar la funciónStringToNumber de TurboIntegrator para pasarnúmeros a los scripts Java de TurboIntegrator.Para obtener más información, consulte"StringToNumber" en la Referencia de TM1.

Una clase Java de TurboIntegrator que devuelve una cadena y se llama desde ExecuteJavaS debe utilizarel patrón siguiente.

package com.example;

import com.ibm.cognos.tm1.javati.JavaTI;

@JavaTIpublic class MyTestTI { public static String MyTestTI (String [] args) [ ... return ...; }}

Ejemplo

ExecuteJavaS('com.example.MyTestTI', 'First', 'Second', 'Third');

ExpandExpand expande los nombres de variables de TurboIntegrator, encerrados entre signos %, a sus valoresde tiempo de ejecución. Un uso común de la función Expand es pasar el valor de variables deTurboIntegrator a la función ODBCOutput.

Si el nombre de la variable representa una variable de cadena, la expresión de variable completa debeaparecer entre comillas. Por ejemplo, "%V1%".

Si a Expand se le proporciona un valor numérico, se realiza una conversión de tipo implícita y el valornumérico se convierte en una cadena.

Esa cadena tiene una longitud mínima fija de 10 caracteres. Si el número convertido es demasiado bajopara ocupar los 10 caracteres, se rellena con espacios iniciales. Solamente se convierten los tresprimeros caracteres decimales. Por ejemplo, un valor numérico de 0,123456789 se convertiría en lacadena "0,123".

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

Expand(String);

414 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

String Cualquier cadena que incluya nombres devariables de TurboIntegrator entre signos de %.

Ejemplo

ODBCOutPut( 'TransData', Expand( 'INSERT INTO SALES ( MONTH, PRODUCT, SALES ) VALUES ( "%V0%", "%V1%",%V2% )' ) );

Este ejemplo ilustra el uso de la función Expand dentro de la función ODBCOutput. Este ejemplo insertaregistros en una tabla relacional denominada Sales que está formada por tres columnas: Month, Producty Sales.

La función Expand convierte las variables V0, V1 y V2 en sus valores reales dentro de la vista. Suponiendoque el primer valor de la vista sea 123.456, y esté definido por los elementos Jan y Widget

Expand( 'INSERT INTO SALES ( MONTH, PRODUCT, SALES ) VALUES ( "%V0%", "%V1%",%V2% )' )

pasa a ser

'INSERTINTO SALES ( MONTH, PRODUCT, SALES ) VALUES ( Jan, Widget, 123.456 )'

en el tiempo de ejecución.

FileExistsFileExists determina si existe un archivo especificado. La función devuelve 1 si el archivo existe, 0 si noexiste.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

FileExists(File);

Argumento Descripción

File El nombre de un archivo. Si no se especifica una víade acceso completa, TM1 busca el archivo en eldirectorio de datos del servidor.

Ejemplo

FileExists('C:\tm1s7\pdata\model.dim');

Este ejemplo determina si el archivo model.dim existe.

LogOutputLogOutput escribe un mensaje en el archivo tm1server.log cuando se detecta un error de undeterminado nivel de gravedad en un proceso de TurboIntegrator.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Requisito previo

Para habilitar el registro de mensajes de TurboIntegrator, debe añadir el depurador TM1.TILogOutputen el archivo tm1-log.properties y establecer el depurador en el nivel que desee. Por ejemplo, si seañade TM1.TILogOutput=DEBUG a tm1-log.properties, se habilita el registro para todos los niveles

Capítulo 5. funciones de TurboIntegrator 415

de gravedad. Para obtener información detallada acerca del archivo tm1-log.properties, consulte"Configuración y activación del registro de mensajes del servidor" en TM1 Operations.

Sintaxis

LogOutput('SeverityLevel', 'MessageString');

Argumento Descripción

SeverityLevel Nivel de gravedad que inicia el registro en elarchivo tm1server.log. Los valores válidos paraeste argumento son:

• 'DEBUG'• 'INFO'• 'WARN'• 'ERROR'• 'FATAL'

MessageString Mensaje que desea escribir en el archivotm1server.log. El mensaje puede ser una cadenaentre comillas simples o puede ser otra función deTurboIntegrator que devuelva una cadena.

Ejemplos

LogOutput('WARN', 'El proceso TI ha encontrado una condición de aviso');

LogOutput('ERROR', TM1User() );

TM1UserTM1User devuelve una cadena que informa acerca del cliente de TM1 actual. Cuando se ejecuta en unproceso que el usuario está ejecutando directamente, también devuelve el nombre de cliente de TM1 delusuario. Cuando se ejecuta en una tarea que el usuario ejecuta directamente, también devuelve elnombre de cliente de TM1 del usuario.

Si la ejecución se realiza desde una tarea planificada, devolverá un nombre con la forma R*<nombre detarea>; por ejemplo, R*UpdateRegionDimension.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

Sintaxis

TM1User()

WildcardFileSearchWildcardFileSearch permite utilizar caracteres comodín para buscar archivos en un directorioespecificado.

Los resultados de la función WildCardFileSearch pueden variar en función del sistema operativo utilizado.Los archivos de un directorio de Windows se ordenan alfabéticamente y los archivos de un directorioUNIX se ordenan de forma aleatoria. Dado que el orden de clasificación varía entre los sistemasoperativos, la misma función WildCardFileSearch ejecutada en directorios idénticos, uno de Windows y elotro de UNIX, devolverá resultados diferentes.

Esta función solo es válida en los procesos de TM1 TurboIntegrator.

416 IBM Planning Analytics: Referencia de TM1

Sintaxis

WildcardFileSearch( Pathname, PriorFilename);

Argumento Descripción

Pathname Un nombre de ruta de los archivos que deseabuscar. El nombre de ruta debe terminar en unnombre de archivo, que puede contener unasecuencia de comodín utilizando los caracteres *y/o ? .

El carácter comodín ? coincide con cualquiercarácter.

El carácter comodín * coincide con cero o máscaracteres.

PriorFilename El nombre de un archivo existente en el directorioespecificado. Este nombre de archivo no puedecontener caracteres comodín. La búsquedacomodín especificada por el argumento Pathnamecomenzará DESPUÉS de este archivo.

Si pasa una cadena vacía como argumentoPriorFilename, la función WildcardFileSearchdevolverá el primer archivo que coincida con lasecuencia comodín especificada por el argumentoPathname.

Ejemplo

El siguiente ejemplo muestra el uso de la función WildcardFileSearch para determinar el primer archivode registro del servidor generado en 2004:

file = WildcardFileSearch( 'C:\Program Files\Cognos\TM1\Custom\TM1Data\SData\tm1s2004*.log', ' ');

Este ejemplo devuelve el primer archivo que coincida con la secuencia comodín 'tm1s2004*.log' deldirectorio C:\Archivos de programa\Cognos\TM1\Custom\TM1Data\SData\.

Dado que los archivos de registro del servidor reciben su nombre y se guardan con indicaciones de fechay hora secuenciales, y dado que el segundo parámetro de WildcardFileSearch está vacío, la funcióndevolverá el primer archivo de registro del servidor que comience por los caracteres "tm1s2004". Deberíaser el primer archivo de registro del servidor generado en el año 2004.

El siguiente ejemplo muestra el uso de la función WildcardFileSearch para devolver el primer archivo deregistro del servidor generado después de haberse generado tm1s20040211153827.log:

file = WildcardFileSearch( 'C:\Program Files\Cognos\TM1\Custom\TM1Data\SData\tm1s*.log', 'tm1s20040211153827.log');

Este ejemplo comienza buscando en el directorio C:\Archivos de programa\Cognos\TM1\Custom\TM1Data\SData\ inmediatamente después del archivo tm1s20040211153827.log, y devuelve el primerarchivo posterior que coincida con la secuencia comodín 'tm1s*.log'.

tm1s20040220175522.log es el primer archivo que aparece tras tm1s20040211153827.log y coincidecon la secuencia comodín. De esta manera, el ejemplo devuelve tm1s20040220175522.log.

Capítulo 5. funciones de TurboIntegrator 417

418 IBM Planning Analytics: Referencia de TM1

Capítulo 6. Variables de TurboIntegratorEn este documento se listan las variables de IBM Planning Analytics por categorías.

Variables locales de TurboIntegratorAl ejecutar un proceso TurboIntegrator, se crea un conjunto de variables locales implícitas. Las variableslocales sólo existen en el contexto del proceso en el que se utilizan y no están disponibles fuera delproceso. Las variables locales se destruyen al salir de un proceso. Estas variables, que se enumeran acontinuación, pueden sobrescribirse para manipular un proceso.

DatasourceASCIIDecimalSeparatorEsta variable local de TurboIntegrator establece el separador decimal que se va a utilizar en cualquierconversión de una cadena en un número o de un número en una cadena. Si establece esta variabletambién debe establecer la variable DatasourceASCIIThousandSeparator.

El carácter especificado debe ser un carácter imprimible ASCII estándar, con un valor decimalcomprendido entre 33 y 127, ambos inclusive.

Sintaxis

DatasourceASCIIDecimalSeparator='Char';

o

DatasourceASCIIDecimalSeparator=Char(xx);

Argumento Descripción

Char El carácter ASCII que se va a utilizar comoseparador.

El carácter puede especificarse como un carácterentre comillas simples o como un código decimalde carácter ASCII sin comillas.

Los dos ejemplos siguientes establecen una coma (,) como separador.

DatasourceASCIIDecimalSeparator=',';

DatasourceASCIIDecimalSeparator=Char(44);

DatasourceASCIIDelimiterEsta variable local de TurboIntegrator establece el carácter ASCII que se va a utilizar como delimitadorde campo cuando DatasourceType sea "CHARACTERDELIMITED".

El carácter especificado debe ser un carácter imprimible ASCII estándar, con un valor decimalcomprendido entre 33 y 127, ambos inclusive.

Sintaxis

DatasourceASCIIDelimiter='Char';

© Copyright IBM Corp. 2007, 2019 419

o

DatasourceASCIIDelimiter=Char(xx);

Argumento Descripción

Char El carácter ASCII que se va a utilizar comodelimitador.

El carácter puede especificarse como un carácterentre comillas simples o como un código decimalde carácter ASCII sin comillas.

Los dos ejemplos siguientes establecen el guion (-) como delimitador de campos.

DatasourceASCIIDelimiter='-';

DatasourceASCIIDelimiter=Char(45);

DatasourceASCIIHeaderRecordsEsta variable local de TurboIntegrator indica el número de registros que se van a omitir antes de procesarel origen de datos.

Sintaxis

DatasourceASCIIHeaderRecords=N;

Argumento Descripción

N El número de registros que se van a omitir antes deprocesar el origen de datos.

DatasourceASCIIQuoteCharacterEsta variable local de TurboIntegrator establece el carácter ASCII que se va a utilizar para encerrar loscampos del archivo de origen cuando DatasourceType sea "CHARACTERDELIMITED".

El carácter especificado debe ser un carácter imprimible ASCII estándar, con un valor decimalcomprendido entre 33 y 127, ambos inclusive.

Sintaxis

DatasourceASCIIQuoteCharacter='Char';

o

DatasourceASCIIQuoteCharacter=Char(xx);

Argumento Descripción

Char El carácter ASCII que encierra los campos en elorigen de datos.

El carácter puede especificarse como un carácterentre comillas simples o como un código decimalde carácter ASCII sin comillas.

420 IBM Planning Analytics: Referencia de TM1

Los dos ejemplos siguientes establecen el asterisco (*) como delimitador de campos.

DatasourceASCIIQuoteCharacter='*';

DatasourceASCIIQuoteCharacter=Char(42);

DatasourceASCIIThousandSeparatorEsta variable local de TurboIntegrator establece el separador de millares que se va a utilizar en cualquierconversión de una cadena en un número o de un número en una cadena.

Si establece esta variable también debe establecer la variable DatasourceASCIIDecimalSeparator.

El carácter especificado debe ser un carácter imprimible ASCII estándar, con un valor decimalcomprendido entre 33 y 127, ambos inclusive.

Sintaxis

DatasourceASCIIThousandSeparator='Char';

o

DatasourceASCIIThousandSeparator=Char(xx);

Argumento Descripción

Char El carácter ASCII que se va a utilizar comoseparador.

El carácter puede especificarse como un carácterentre comillas simples o como un código decimalde carácter ASCII sin comillas.

Los dos ejemplos siguientes establecen el punto (.) como separador de millares.

DatasourceASCIIThousandSeparator='.';

DatasourceASCIIThousandSeparator=Char(46);

DatasourceCubeviewEsta variable local de TurboIntegrator establece la vista que se va a procesar si DatasourceType es"VIEW".

Sintaxis

DatasourceCubeview='ViewName';

Argumento Descripción

ViewName El nombre de la vista que se va a procesar. Debeser una vista existente del cubo especificada por lavariable DataSourceNameForServer.

DatasourceDimensionSubsetEsta variable local de TurboIntegrator establece el subconjunto que se va a procesar si DatasourceTypees "SUBSET".

Capítulo 6. Variables de TurboIntegrator 421

DatasourceNameForServer=nombre de la dimensión también es necesario junto conDATASOURCEDIMENSIONSUBSET para que TM1 pueda identificar la ubicación del subconjunto.

Sintaxis

DatasourceDimensionSubset='SubsetName';

Argumento Descripción

SubsetName El nombre del subconjunto que se va a procesar.

DatasourceNameForServerEsta variable local de TurboIntegrator establece el nombre del origen de datos (archivo .cma, nombre delcubo, origen ODBC) que utiliza el servidor al ejecutar el proceso.

Sintaxis

DatasourceNameForServer='Name';

Argumento Descripción

Nombre En un origen de datos .cma, la ruta completa delarchivo .cma.

En los cubos, el nombre del cubo precedido por lacadena "local:".

En un origen ODBC, el nombre del origen.

DatasourceNameForClientEsta variable local de TurboIntegrator establece el nombre del origen de datos (archivo .cma, nombre delcubo, origen ODBC) que utiliza el cliente al crear o editar el proceso.

Sintaxis

DatasourceNameForClient='Name';

Argumento Descripción

Nombre En un origen de datos .cma, la ruta completa delarchivo .cma.

En los cubos, el nombre del cubo precedido por lacadena "local:".

En un origen ODBC, el nombre del origen.

DataSourceODBOCatalogEsta variable local de TurboIntegrator establece el nombre de la recopilación de bases de datos quecontiene los cubos, las dimensiones u otros objetos a los que desee conectarse. Para Microsoft AnalysisServices, éste es el nombre de la base de datos.

Sintaxis

DataSourceODBOCatalog='Catalog';

422 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

Catalog El nombre de la recopilación de bases de datos alas que desee conectarse.

DataSourceODBOConnectionStringEsta variable local de TurboIntegrator establece los parámetros de conexión adicionales que pueden sernecesarios para conectarse al servidor OLAP.

Sintaxis

DataSourceODBOConnectionString='String';

Argumento Descripción

Cadena El valor que se utiliza para definir parámetros deconexión adicionales.

Asigne estos parámetros a esta variable,delimitada por puntos y coma.

DataSourceODBOCubeNameEsta variable local de TurboIntegrator establece el nombre del cubo del servidor OLAP que desea utilizarcomo origen de datos.

Sintaxis

DataSourceODBOCubeName='Name';

Argumento Descripción

Nombre El nombre del cubo que se va a utilizar.

DataSourceODBOHierarchyNameEsta variable local de TurboIntegrator establece el nombre de la jerarquía de la dimensión específica queestá utilizando como origen de datos. Puede utilizar esta variable en otros productos OLAP, tales comoSAP BW, en los que una jerarquía es un objeto independiente.

Esta variable no se utiliza con orígenes de datos de TM1.

Sintaxis

DataSourceODBOHierarchyName='Name';

Argumento Descripción

Nombre El nombre de la jerarquía de una dimensiónespecífica.

DataSourceODBOLocationEsta variable local de TurboIntegrator establece el nombre de la ubicación (sistema) en la que se estáejecutando el servidor OLAP.

Capítulo 6. Variables de TurboIntegrator 423

TM1 utiliza esta variable pero otros servidores OLAP no lo hacen. Para TM1, se trata de la ubicacióndonde se ejecuta el host de administración.

Sintaxis

DataSourceODBOLocation='Location';

Argumento Descripción

Location El nombre de la ubicación (sistema) del servidorOLAP.

DataSourceODBOProviderEsta variable local de TurboIntegrator establece el nombre del proveedor ODBO que desea utilizar comoorigen de datos. Éste es el nombre completo asignado por el fabricante del proveedor ODBO paraidentificar su servidor de bases de datos multidimensional.

Debe utilizar el nombre de un proveedor ODBO que esté instalado en su servidor.

Sintaxis

DataSourceODBOProvider='Provider';

Argumento Descripción

Provider El nombre del proveedor ODBO que se va a utilizarcomo origen de datos.

Entre los nombres de proveedores comúnmenteutilizados se incluyen:

Proveedor MD de base de datos OLE de TM1

Proveedor de base de datos OLE Microsoft paraOLAP Services 8.0

Proveedor de OLE DB de SAP BW

DataSourceODBOSAPClientIDEsta variable local de TurboIntegrator establece el número de cliente que corresponda a la versión de lainterfaz de usuario del servidor SAP al que desee conectarse.

Sintaxis

DataSourceODBOSAPClientID='ID';

Argumento Descripción

ID Un número que corresponde a la versión deinterfaz de usuario del servidor SAP.

Por ejemplo, 498.

DataSourceODBOSAPClientLanguageEsta variable local de TurboIntegrator establece la especificación del idioma del idioma del sistema SAPal que desee conectarse.

424 IBM Planning Analytics: Referencia de TM1

Sintaxis

DataSourceODBOSAPClientLanguage='Language';

Argumento Descripción

Language La especificación del idioma del sistema SAP.

Para inglés estadounidense, utilice EN.

Para alemán, utilice DE.

Para los demás idiomas, consulte ladocumentación de SAP.

DatasourcePasswordEsta variable local de TurboIntegrator establece la contraseña utilizada para conectarse al origen dedatos.

Sintaxis

DatasourcePassword='Password';

Argumento Descripción

Contraseña La contraseña utilizada para conectarse al origende datos establecida conDatasourceNameForServer.

DatasourceQueryEsta variable local de TurboIntegrator establece la cadena de consulta con el origen de datos.

Sintaxis

DatasourceQuery='Query';

Argumento Descripción

Consulta La cadena de consulta que se va a utilizar con elorigen de datos y que se estableció conDatasourceNameForServer.

DataSourceSAPUsingRoleAuthsLa variable local DataSourceSAPUsingRoleAuths indica al proceso TurboIntegrator que omita lainformación de seguridad cuando procesa un origen de datos SAP. Esta variable debe colocarse enPrólogo.

Sintaxis

DataSourceSAPUsingRoleAuths='0'

Argumento Descripción

0 La información de seguridad se ignora al procesarun origen de datos SAP.

Capítulo 6. Variables de TurboIntegrator 425

Argumento Descripción

1 La información de seguridad se lee al procesar unorigen de datos SAP.

DataSourceSAPUsingTextsLa variable local DataSourceSAPUsingTexts indica al proceso TurboIntegrator que omita lasdescripciones de características cuando procesa un origen de datos SAP, lo que disminuye el consumo dememoria y mejora el rendimiento. Esta variable debe colocarse en Prólogo.

Sintaxis

DataSourceSAPUsingTexts='0'

Argumento Descripción

0 Las descripciones de características se ignoran alprocesar un origen de datos SAP. El nombretécnico de la característica se importa a TM1 comonombre de elemento y como alias.

1 Las descripciones de características se leen alprocesar un origen de datos SAP.

DatasourceTypeEsta variable local de TurboIntegrator establece el tipo del origen de datos.

Sintaxis

DataSourceType='Type';

Argumento Descripción

Tipo Entre los tipos válidos se incluyen:

'CHARACTERDELIMITED', 'POSITIONDELIMITED','VIEW', 'SUBSET', ODBC' y 'OLEDBOLAP','SAPCHARACTERISTICTEXTS'

DatasourceUsernameEsta variable local de TurboIntegrator establece el nombre utilizado para conectarse al origen de datos.

Sintaxis

DatasourceUserName='Name';

Argumento Descripción

Nombre El nombre utilizado para conectarse al origen dedatos establecida con DatasourceNameForServer.

426 IBM Planning Analytics: Referencia de TM1

MinorErrorLogMaxEsta variable local de TurboIntegrator define el número de errores leves que se escribirán en el archivoTM1ProcessError.log durante la ejecución del proceso. Si esta variable no se define en el proceso, elnúmero de errores leves predeterminado escrito en el archivo de registro será 1000.

Sintaxis

MinorErrorLogMax=N;

Argumento Descripción

N Valor que indica el número de errores que debenescribirse en el archivo de registro.

Especifique un entero mayor que cero paraestablecer el número máximo de errores que seescribirán en el archivo de registro.

Especifique un valor de 0 para no registrar erroresdurante la ejecución del proceso.

Especifique un valor de -1 para permitir que seescriba un número ilimitado de errores leves en elarchivo de registro.

En la tabla siguiente se proporciona un mensaje de registro de errores de ejemplo y el resultado correspondiente.

Ejemplo Resultado

MinorErrorLogMax=750; El archivo de registro aceptará hasta 750 errores.

MinorErrorLogMax=0; No se escribirán errores en el archivo de registro.

MinorErrorLogMax=-1; No existe ningún límite en el número de erroresque se escribirán en el archivo de registro.

NValueCuando DatasourceType es "VIEW", esta variable local de Turbointegrator determina el valor de la celdaactual si Value_Is_String es 0. (Es decir, cuando la celda actual es numérica).

Sintaxis

Nvalue=N;

Argumento Descripción

N El valor de la celda actual.

OnMinorErrorDoItemSkipEsta variable local de TurboIntegrator ordena a TurboIntegrator que pase al siguiente registro cuandoencuentre un error leve durante el procesamiento de un registro.

Esta variable resulta útil en escenarios en los que un único valor/campo erróneo de un registro provoquevarios errores leves.

Capítulo 6. Variables de TurboIntegrator 427

Por ejemplo, si tiene 100 funciones CELLPUTN en un proceso y uno de los campos de un registrodeterminado es "erróneo" o no válido, el recuento de errores leves se incrementa en 100. (1 por cadafunción CELLPUTN que encuentre el error). Estos 100 errores leves hacen que se acerque al límite deerrores leves definido por MinorErrorLogMax. Un proceso TurboIntegrator no se realizará correctamentecuando supere el número de errores leves definido por MinorErrorLogMax.

Si OnMinorErrorDoItemSkip=1; se incluye en la pestaña Prólogo del proceso, el proceso saltainmediatamente al siguiente registro cuando se encuentra un campo "erróneo" o no válido en un registrode origen. Utilizando el ejemplo anterior, el recuento de errores leves se incrementará sólo en 1, en lugarde en 100.

Sintaxis

OnMinorErrorDoItemSkip=N;

Argumento Descripción

N Valor que indica si el elemento debe omitirsecuando se encuentre un error leve.

1 (o cualquier valor que no sea cero) dicta que elproceso debe saltar al siguiente registro cuando seencuentre un error leve.

0 indica que TurboIntegrator debe continuarprocesando el registro actual cuando se encuentreun error leve.

SValueCuando DatasourceType es "VIEW", esta variable local de Turbointegrator determina el valor de la celdaactual si Value_Is_String no es 0. (Es decir, cuando la celda actual contiene una cadena).

Sintaxis

Svalue='String';

Argumento Descripción

Cadena El valor de la celda actual.

Archivo TM1ProcessError.logCuando un proceso TurboIntegrator se encuentra con un error, genera un archivo TM1ProcessError.log.Este archivo de registro se guarda en el directorio de datos del servidor en el que está ubicado el proceso.

Un archivo TM1ProcessError.log contiene una lista de errores encontrados por el proceso. Por cada errorque encuentre, el archivo de registro registra la pestaña y la línea que provocaron el error, junto con unabreve descripción del error.

Cuando se genera un archivo de registro de errores de procesos, TM1 asigna un nombre exclusivo que lepermite identificar fácilmente los procesos de TurboIntegrator que han generado el archivo de errores yla hora en que se ha creado el archivo. Los nombres de archivo se asignan mediante la convenciónsiguiente:

TM1ProcessError_<indicación de fecha y hora>_<nombre del proceso>.log.

En esta convención, <indicación de fecha y hora> es la hora (expresada en aaaammddhhmmss GMT) enque se generó el archivo y <nombre del proceso> es el nombre del proceso TurboIntegrator que provocólos errores.

428 IBM Planning Analytics: Referencia de TM1

Por ejemplo, un archivo de error denominado TM1ProcessError_20040224203148_ CreateSalesCube.logindica que el archivo de error se generó a las 20:31:48 GMT del 24 de febrero de 2004 y que contieneerrores provocados por el proceso CreateSalesCube.

La intervención manual es necesaria para suprimir o archivar estos archivos de registro. Se genera unnuevo archivo de registro cada vez que un proceso de TurboIntegrator tiene un error (1 archivo deregistro por ejecución de TurboIntegrator).

Es posible que se generen varios registros de errores de proceso de TurboIntegrator para procesos deTurboIntegrator que se ejecutan con frecuencia y generan un error en cada ejecución. Muchos archivosde registro generados en el directorio de registros de la base de datos de TM1 pueden afectar alrendimiento de la base de datos de TM1 cuando se crean o se actualizan los archivos de registro.

La capacidad de Planning Analytics Administration para descargar los archivos de registro puede verseafectada por un gran número de archivos en el directorio de registros de la base de datos de TM1.Serecomienda limitar el número de archivos en el directorio de registros de la base de datos de TM1 amenos de 2000 archivos.

Value_Is_StringCuando DatasourceType es "VIEW", esta variable local de TurboIntegrator determina si la celda actualdebe tratarse como valor numérico o de cadena.

Sintaxis

Value_Is_String=N;

Argumento Descripción

N Valor que indica si la celda actual es un valornumérico o de cadena.

0 dicta que la celda es un número; cualquier otrovalor indica que la celda se trata como una cadena.

Variables globales de TurboIntegratorEste tipo de variable de TurboIntegrator se asocia a una tarea individual de TM1 o a un proceso individualy a cualquier subproceso que conlleve. Existen dos tipos de variables globales: implícitas y definidas porel usuario. Las variables globales implícitas se describen aquí. Las variables globales definidas por elusuario se describen a continuación.

Las variables globales se pueden utilizar de dos formas:

• Las variables globales pueden declararse dentro de un proceso que forme parte de una tareadeterminada. Una vez declaradas, las variables globales estarán disponibles para el resto de procesosque formen parte de la tarea. Las variables permanecerán mientras se ejecute la tarea y durante eltiempo que dure la sesión de servidor actual. Las variables globales se destruirán cuando se apague elservidor

• Las variables globales pueden declararse en un proceso y pueden estar disponibles para cualquierproceso posterior llamado por la función ExecuteProcess( ). Estos subprocesos deben utilizar lasmismas sentencias de declaración de variables locales (descritas a continuación) para poder acceder alas variables globales.

En el caso de que el nombre de una variable global sea idéntico al nombre de una variable local, ladefinición de la variable local tendrá prioridad y reemplazará a la variable global.

Las variables globales se declaran en un proceso TurboIntegrator utilizando una de las siguientes dosfunciones

Capítulo 6. Variables de TurboIntegrator 429

NumericGlobalVariable("VariableName");Utilice esta función para declarar una variable global numérica.

StringGlobalVariable("VariableName");Utilice esta función para definir una variable global de cadena.

Variables globales implícitasAl ejecutar un proceso TurboIntegrator, se crea un conjunto de variables globales implícitas. Si el procesoque crea las variables forma parte de una tarea, dichas variables globales estarán disponibles y podráncompartirse con los demás procesos de la tarea.

Además, todas las variables globales implícitas de un proceso estarán disponibles y podrán compartirsecon cualquier proceso posterior llamado por la función ExecuteProcess( ).

Aunque las variables implícitas se crean a través del proceso TurboIntegrator, debe declarar una variableantes de que pueda utilizarse en un proceso

Las variables globales implícitas se declaran en un proceso TurboIntegrator utilizandoNumericGlobalVariable('VariableName');:

Pulse uno de los siguientes enlaces para obtener más información sobre las variables globales implícitasespecíficas.

• DataMinorErrorCount.• MetadataMinorErrorCount.• ProcessReturnCode.• PrologMinorErrorCount.

Por ejemplo, para utilizar la variable global implícita PrologMinorErrorCount en un proceso, debe declararen primer lugar la variable de la siguiente manera:

NumericGlobalVariable('PrologMinorErrorCount');

DataMinorErrorCountEsta variable global de TurboIntegrator cuenta los errores leves que tienen lugar en la parte Datos de unproceso TurboIntegrator. Por cada error leve que encuentre, el valor de la variable se incrementará en 1.

Sintaxis

DataMinorErrorCount=N;

Argumento Descripción

N El número de errores leves encontrados en la parteDatos del proceso.

MetadataMinorErrorCountEsta variable global de TurboIntegrator cuenta los errores leves que tienen lugar en la parte Metadatos deun proceso TurboIntegrator. Por cada error leve que encuentre, el valor de la variable se incrementará en1.

Sintaxis

MetadataMinorErrorCount=N;

430 IBM Planning Analytics: Referencia de TM1

Argumento Descripción

N El número de errores leves encontrados en la parteMetadatos del proceso.

ProcessReturnCodeEsta variable global de TurboIntegrator almacena el estado de salida del proceso TurboIntegratorejecutado más recientemente.

Sintaxis

ProcessReturnCode=StatusCode;

Código de estado Descripción

ProcessExitByBreak() Indica que ha salido el proceso porque se haencontrado una función ProcessBreak.

ProcessExitByChoreQuit() Indica que ha salido del proceso debido a laejecución de la función ChoreQuit.

ProcessExitByChoreRollback() Indica que ha salido del proceso porque se haencontrado una función ChoreRollback.

ProcessExitByProcessRollback() Indica que ha salido del proceso porque se haencontrado una función ProcessRollback.

ProcessExitByQuit() Indica que ha salido del proceso debido a uncomando quit.

ProcessExitMinorError() Indica que el proceso ha ejecutado correctamente,pero se han encontrado errores leves.

ProcessExitNormal() Indica que el proceso se ha ejecutado connormalidad.

ProcessExitOnInit() Indica que el proceso se ha cancelado de formaanómala durante la inicialización.

ProcessExitSeriousError() Indica que ha salido del proceso debido a un errorgrave.

ProcessExitWithMessage() Indica que ha salido del proceso con normalidad,con un mensaje grabado en tm1server.log.

PrologMinorErrorCountEsta variable global de TurboIntegrator cuenta los errores leves que tienen lugar en la parte Prólogo deun proceso TurboIntegrator. Por cada error leve que encuentre, el valor de la variable se incrementará en1.

Sintaxis

PrologMinorErrorCount=N;

Capítulo 6. Variables de TurboIntegrator 431

Argumento Descripción

N El número de errores leves encontrados en elPrólogo.

Variables de usuario de TurboIntegratorEste tipo de variable se asocia con un usuario individual de TM1 y no con un proceso o tarea en concreto.Las variables de usuario pueden manipularse desde cualquier proceso o tarea de TurboIntegratormientras el usuario con el que la variable está asociada tenga una sesión iniciada en el servidor.

Las variables de usuario deben declararse explícitamente. Una vez declaradas las variables de usuariopermanecen durante toda la sesión de TM1 (hasta que el usuario cierra la sesión o se desconecta delservidor).

Las variables de usuario se declaran en un proceso TurboIntegrator utilizando una de las dos funcionessiguientes:

• NumericGlobalVariable('VariableName');. Utilice esta función para declarar una variable de usuarionumérica.

• StringGlobalVariable('VariableName');. Utilice esta función para definir una variable de usuario decadena.

Las variables de usuario se crean la primera vez que se encuentra dicha declaración en cualquier procesoTurboIntegrator en ejecución.

Una vez creada, puede hacerse referencia al nombre de la variable, así como utilizarse simplementecomo cualquier variable local o global, y el valor de la variable persistirá en los procesos y en las tareasúnicamente mientras el usuario que creó la variable tenga una sesión iniciada en el servidor.

432 IBM Planning Analytics: Referencia de TM1

Avisos

Esta información se ha desarrollado para productos y servicios que se ofrecen en todo el mundo.

Puede que IBM tenga disponible este material en otros idiomas. Sin embargo, es posible que tengaobligación de tener una copia del producto o de la versión del producto en dicho idioma para acceder a él.

Puede que IBM no ofrezca en algunos países los productos, servicios o características que se explican eneste documento. Póngase en contacto con el representante de IBM de su localidad para obtenerinformación acerca de los productos y servicios que actualmente están disponibles en su zona. Cualquierreferencia hecha a un producto, programa o servicio de IBM no implica ni pretende indicar que sólo puedautilizarse ese producto, programa o servicio de IBM. En su lugar, podrá utilizarse cualquier producto,programa o servicio con características equivalentes que no infrinja ningún derecho de propiedadintelectual de IBM. Sin embargo, será responsabilidad del usuario evaluar y verificar el funcionamiento decualquier programa, producto o servicio que no sea de IBM. Este documento puede incluir descripcionesde productos, servicios o características que no forman parte de la titularidad de licencia o programa queha adquirido.

Puede que IBM tenga patentes o solicitudes de patentes pendientes relacionadas con los temasprincipales que se tratan en este documento. La posesión de este documento no le otorga ningunalicencia sobre estas patentes. Puede enviar sus consultas sobre licencias, por escrito, a la direcciónsiguiente:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785EE. UU.

Para realizar consultas sobre licencias relacionadas con la información de doble byte (DBCS), póngase encontacto con el Departamento de propiedad intelectual de IBM de su país o envíe sus consultas, porescrito, a la dirección:

Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan Ltd.19-21, Nihonbashi-Hakozakicho, Chuo-kuTokio 103-8510, Japón

El párrafo siguiente no tiene aplicación en el Reino Unido ni en ningún otro país en el que talesprovisiones sean incoherentes con la legislación local: INTERNATIONAL BUSINESS MACHINESCORPORATION PROPORCIONA ESTA PUBLICACIÓN "TAL CUAL", SIN GARANTÍAS DE NINGÚN TIPO, YASEAN EXPRESAS O IMPLÍCITAS, INCLUIDAS, PERO SIN LIMITARSE A, LAS GARANTÍAS IMPLÍCITAS DENO INFRACCIÓN, COMERCIALIZACIÓN O IDONEIDAD PARA UNA FINALIDAD DETERMINADA. En algunosestados no está permitida la renuncia de las garantías expresas o implícitas en determinadastransacciones, por lo tanto, puede que esta declaración no se aplique a su caso.

Esta información podría incluir imprecisiones técnicas o errores tipográficos. Periódicamente se realizancambios en la información que aquí se presenta; tales cambios se incorporarán en nuevas ediciones de lapublicación. IBM podría realizar mejoras y/o cambios en el producto o productos y/o programa oprogramas que se describen en esta publicación en cualquier momento y sin previo aviso.

Cualquier referencia hecha en esta información a sitios web que no son de IBM sólo se proporciona parasu comodidad y bajo ninguna circunstancia ha de interpretarse que IBM representa o se haceresponsable del contenido de esos sitios web. Los materiales de esos sitios web no forman parte de losmateriales de este producto de IBM y la utilización de esos sitios web será responsabilidad del usuario.

IBM podría utilizar o distribuir la información que se le envía de la forma que considere más oportuna sinincurrir por ello en ninguna obligación con el remitente de la información.

© Copyright IBM Corp. 2007, 2019 433

Los tenedores de licencias de este programa que deseen obtener información acerca de éste con el fin depermitir: (i) el intercambio de información entre programas creados independientemente y otrosprogramas (incluido el presente) y (ii) la utilización mutua de la información que se ha intercambiado,deben ponerse en contacto con:

IBM Software Group Attention: Licensing 3755 Riverside Dr. Ottawa, ON K1V 1B7 Canadá

Esta información podría estar disponible, de acuerdo con los términos y condiciones aplicables,incluyendo en algunos casos el pago de una tarifa.

El programa bajo licencia que se describe en este documento y todo el material bajo licencia disponiblepara éste los proporciona IBM en función de lo dispuesto en el IBM Customer Agreement, IBMInternational Program License Agreement o cualquier otro acuerdo equivalente celebrado entre ambaspartes.

Los datos relacionados con el rendimiento que pudiera contener este documento se han determinado enun entorno controlado. Por lo tanto, los resultados obtenidos en otros entornos operativos podrían variarsignificativamente. Puede que algunas mediciones se hayan obtenido en sistemas de desarrollo y noexiste ninguna garantía que permita afirmar que puedan obtenerse las mismas mediciones en sistemasde disponibilidad general. Es más, puede que algunas mediciones sean estimaciones obtenidas porextrapolación. Los resultados reales podrían variar. Los usuarios de este documento deben verificar losdatos que se aplican a su entorno específico.

La información relacionada con productos que no son de IBM se ha obtenido de los proveedores de esosproductos, los anuncios que han publicado u otras fuentes de disponibilidad pública. IBM no ha probadoesos productos y no puede confirmar la precisión de la información relacionada con el rendimiento, lacompatibilidad ni ningún otro aspecto relacionado con productos que no son de IBM. Las preguntasrelacionadas con las prestaciones de los productos que no son de IBM deben dirigirse a los proveedoresde esos productos.

Todas las declaraciones relacionadas con futuras directrices o intenciones de IBM están sujetas acambios o a su retirada sin previo aviso y sólo representan objetivos.

Esta información se proporciona únicamente para fines de planificación. La información de estedocumento está sujeta a cambios antes de que los productos que se describen estén disponibles.

Esta información contiene ejemplos de datos e informes que se utilizan en operaciones empresariales deuso habitual. Para ilustrarlas de la forma más completa posible, los ejemplos incluyen nombres depersonas, compañías, marcas y productos. Todos estos nombres son ficticios y cualquier similitud quepudiera darse con nombres y direcciones que utilice una empresa real es pura coincidencia.

LICENCIA DE COPYRIGHT:

Esta información contiene programas de aplicación de ejemplo en código fuente, que ilustran técnicas deprogramación en las distintas plataformas operativas. Puede copiar, modificar y distribuir los programasde ejemplo de cualquier forma, sin tener que pagar a IBM, con intención de desarrollar, utilizar,comercializar o distribuir programas de aplicación que estén en conformidad con la interfaz deprogramación de aplicaciones (API) de la plataforma operativa para la que están escritos los programasde ejemplo. Los ejemplos no se han probado minuciosamente bajo todas las condiciones. Por lo tanto,IBM no puede garantizar ni certificar la fiabilidad, servicio o funcionamiento de estos programas. Losprogramas de ejemplo se proporcionan "TAL CUAL" sin garantías de ningún tipo. IBM no será responsablede los daños derivados del uso de los programas de ejemplo.

Las copias, cualquier parte de estos programas de ejemplo o cualquier trabajo que se derive de ellosdebe incluir un aviso de copyright como el siguiente:© (nombre de la compañía) (año). Partes de este código se han obtenido de programa de ejemplo de IBMCorp. © Copyright IBM Corp. _escriba el año o años_.

434 Avisos

Puede que si visualiza esta información en copia software, las fotografías e ilustraciones a color noaparezcan.

Esta oferta de software no utiliza cookies ni otras tecnologías para recopilar información de identificaciónpersonal.

©

Información sobre el producto

Este documento se aplica a la versión 2.0.0 de IBM Planning Analytics y puede aplicarse también aversiones posteriores.

Copyright

Materiales bajo licencia - Propiedad de IBM© Copyright IBM Corp. 2007, 2019.

US Government Users Restricted Rights – El uso, la duplicación o la revelación están restringidos por elContrato GSA ADP Schedule con IBM Corp.

IBM, el logotipo de IBM, e ibm.com son marcas registradas o marcas comerciales de InternationalBusiness Machines Corp., registradas en muchas jurisdicciones en todo el mundo. Otros nombres deproductos y servicios pueden ser marcas registradas de IBM o de otras compañías. Hay disponible unalista actual de marcas registradas de IBM en la web en " Copyright and trademark information " atwww.ibm.com/legal/copytrade.shtml.

Los términos siguientes son marcas registradas de otras compañías:

• Microsoft, Windows, Windows NT y el logotipo de Windows son marcas registradas de MicrosoftCorporation en Estados Unidos o en otros países.

• Adobe, el logotipo de Adobe, PostScript y el logotipo de PostScript son marcas registradas de AdobeSystems Incorporated en Estados Unidos o en otros países.

• La marca registrada Linux® se utiliza conforme a una sublicencia de Linux Foundation, el licenciatarioexclusivo de Linus Torvalds, propietario de la marca a nivel mundial.

• UNIX es una marca registrada de The Open Group en Estados Unidos y en otros países.• Java y todas las marcas registradas y logotipos basados en Java son marcas registradas de Oracle o susafiliados.

• Red Hat®, JBoss®, OpenShift®, Fedora®, Hibernate®, Ansible®, CloudForms®, RHCA®, RHCE®, RHCSA®,Ceph® y Gluster® son marcas registradas de Red Hat, Inc. o sus filiales en Estados Unidos y otros países.

Las capturas de pantalla de productos Microsoft se utilizan con el permiso de Microsoft.

Avisos 435

436 IBM Planning Analytics: Referencia de TM1

Índice

AABS 150acceso

privilegios Asignaciones de seguridad 51ACOS 151AddClient 359AddCubeDependency 282AddGroup 359AddInfoCubeRestriction 411Admin

Asignaciones de seguridad 54Transport Layer Security del servidor, opciones de TM174

ajuste de línea 48Alias TM1, cuadro de diálogo 73anular comentarios 47aplicación

Server Explorer 59ASCII

y texto, funciones de TurboIntegrator 217ASCIIDelete 218ASCIIOutput 218asignar

cuadrícula Asignaciones de seguridad 51ASIN 151asistente de informes de impresión 40AssignClientPassword 360AssignClientToGroup 360AssociateCAMIDToGroup 361ATAN 151atributo

editor 7Editor de TurboIntegrator 93funciones de TurboIntegrator de manipulación 226

AttrDelete 228AttrInsert 229ATTRN 104ATTRNL 226AttrPutN 229AttrPutS 230ATTRS 105AttrSL 227autocompletar 48avanzada

cuadrícula de correlación 5avanzadas

opciones 5avanzado

pestaña del Editor de TurboIntegrator 97ayuda contextual 48

Bbarra de estado 48barra de herramientas 48BatchUpdateFinish 290, 373

BatchUpdateFinishWait 374BatchUpdateStart 375bloqueo

asignaciones de seguridad 54botón de acción

propiedades 1botón de acción de apariencia 4botones

Editor de TurboIntegrator 91Buscar 47

CCAPIT 158CellGetN 282CellGetS 284CellIncrementN 284CellIsUpdateable 285CellPutN 286CellPutProportionalSpread 286CellPutS 287CellSecurityCubeCreate 361CellSecurityCubeDestroy 362CellValueN 114CellValueS 115CHAR 158chino 47ChoreAttrDelete 231ChoreAttrInsert 231ChoreAttrN 232ChoreAttrNL 232ChoreAttrPutN 233ChoreAttrPutS 234ChoreAttrS 235ChoreAttrSL 235ChoreError 280ChoreRollback 281clientes

/grupo, ventana 15/grupos, cuadrícula 15, 17cuadro de diálogo Centro de mensajes de 18menú Clientes/Grupos 16

CODE 158comentarios 47comparación 103comprobar sintaxis 47conectar servidor 37consolidación

Editor de TurboIntegrator 93ConsolidatedAvg 108ConsolidatedCount 111ConsolidatedCountUnique 112ConsolidatedMax 113ConsolidatedMin 114consulta del registro de transacciones

cuadro de diálogo 75cuadro de diálogo de resultados 75

Índice 437

contención de bloqueo 376CONTINUE 149control

objetos 48opciones 49

coreano 47correlación automática 5COS 152crear

cubo, cuadro de diálogo 19dimensión, cuadro de diálogo 18objeto de réplica de servidor 19

CreateHierarchyByAttribute 236cuadrícula

Editor de TurboIntegrator 91cuadro de diálogo Abrir subconjunto 39cuadro de diálogo Abrir vista 39Cuadro de diálogo Borrar subconjuntos con nombre 24Cuadro de diálogo Borrar vistas con nombre 24Cuadro de diálogo Obtener vista (Navegador de hojas decálculo) 37cuadro de diálogo Opciones de proceso 44cuadro de diálogo Opciones de TM1 73cuadros de diálogo 1CubeAttrDelete 237CubeAttrInsert 237CubeATTRN 105CubeATTRNL 240CubeAttrPutN 238CubeAttrPutS 239CubeATTRS 106CubeATTRSL 241CubeClearData 288CubeCreate 288CubeDataReservationAcquire 293CubeDataReservationGet 296CubeDataReservationGetConflicts 297CubeDataReservationRelease 294CubeDataReservationReleaseAll 295CubeDestroy 289CubeDimensionCountGet 289CubeDRAcquire 298CubeDRGet 301CubeDRGetConflicts 302CubeDRRelease 299CubeDRReleaseAll 300CubeExists 289CubeGetLogChanges 290CubeProcessFeeders 345CubeRuleAppend 345CubeRuleDestroy 346CubeSetConnParams 291CubeSetLogChanges 292CubeTimeLastUpdated 292CubeUnload 293CubeView

Server Explorer 63, 64cubo

cuadro de diálogo Propiedades del 21editor de subconjuntos de información 45Editor de TurboIntegrator 93funciones de manipulación de TurboIntegrator 282optimizar 20Server Explorer 60

cubo (continuación)visor 21

DD_FSAVE 168D_PICK 167D_SAVE 169DataMinorErrorCount 430DatasourceASCIIDecimalSeparator 419DatasourceASCIIDelimiter 419DatasourceASCIIHeaderRecords 420DatasourceASCIIQuoteCharacter 420DatasourceASCIIThousandSeparator 421DatasourceCubeview 421DatasourceDimensionSubset 421DatasourceNameForClient 422DatasourceNameForServer 422DataSourceODBOCatalog 422DataSourceODBOConnectionString 423DataSourceODBOCubeName 423DataSourceODBOHierarchyName 423DataSourceODBOLocation 423DataSourceODBOProvider 424DataSourceODBOSAPClientID 424DataSourceODBOSAPClientLanguage 424DatasourcePassword 425DatasourceQuery 425DataSourceSAPUsingRoleAuths 425DataSourceSAPUsingTexts 426DatasourceType 426DatasourceUsername 426DATE 120DATES 121datos

Editor de TurboIntegrator 93, 97origen, pestaña del editor de TurboIntegrator 77

DAY 122DAYNO 122DBProportionalSpread 169DBR 189DBRA 190DBRW 191DBS 191DBSA 192DBSS 193DBSW 193DELET 159DeleteAllPersistentFeeders 347DeleteClient 362DeleteGroup 363DFRST 194dimensión

cuadro de diálogo Insertar elementos 29cuadro de diálogo Ordenar elementos de 29cuadro de diálogo Propiedades de elementos 30editor de subconjuntos de información 45Editor de TurboIntegrator 93funciones de reglas de información 128funciones de TurboIntegrator de manipulación 306menú Editor de dimensiones 25Server Explorer 62

DimensionAttrDelete 242DimensionAttrInsert 242

438 IBM Planning Analytics: Referencia de TM1

DimensionATTRN 106DimensionATTRNL 244DimensionAttrPutN 243DimensionAttrPutS 244DimensionATTRS 106DimensionATTRSL 245DimensionCreate 306DimensionDeleteAllElements 306DimensionDeleteElements 306DimensionDestroy 307DimensionElementComponentAdd 307DimensionElementComponentAddDirect 308DimensionElementComponentDelete 309DimensionElementComponentDeleteDirect 309DimensionElementDelete 310DimensionElementDeleteDirect 310DimensionElementExists 311DimensionElementInsert 312DimensionElementInsertDirect 312, 317DimensionElementPrincipalName 313dimensiones de columna

Cube Viewer 21dimensiones de título

Cube Viewer 21DimensionExists 314DimensionHierarchyCreate 314DimensionSortOrder 315DimensionTimeLastUpdated 316DimensionTopElementInsert 317DimensionUpdateDirect 318DIMIX 129, 195DIMNM 129, 195DIMSIZ 129, 196DisableBulkLoadMode 375DisableMTQViewConstruct 396DNEXT 130, 196DNLEV 130, 197DTYPE 131, 197

EE_PICK 170editar

fórmula, cuadro de diálogo 31referencia al cubo, cuadro de diálogo 32

Editor 77ELCOMP 132, 198ELCOMPN 132, 198ElementAttrDelete 251ElementAttrInsert 250ElementAttrN 107ElementATTRNL 246ElementAttrPutN 248ElementAttrPutS 249ElementAttrS 108ElementATTRSL 247ElementComponent 133ElementComponentCount 133ElementCount 134ElementFirst 134ElementIndex 135ElementIsAncestor 135ElementIsComponent 136ElementIsParent 136

ElementLevel 137ElementName 138ElementNext 138elemento

funciones de reglas de información 132panel Editor de dimensiones 25panel Editor de subconjuntos 68

ElementParent 139ElementParentCount 139ElementSecurityGet 363ElementSecurityPut 364ElementType 140ElementWeight 140ELISANC 141ELISCOMP 141, 199ELISPAR 142, 200ELLEV 142, 200ELPAR 143, 201ELPARN 144, 201ELSEN 202ELWEIGHT 144, 202EnableBulkLoadMode 375EnableMTQViewConstruct 397epílogo

Editor de TurboIntegrator 97escritura

asignaciones de seguridad 53Excel

funciones de macro 167ExecuteCommand 336ExecuteJavaN 413ExecuteJavaS 413ExecuteProcess 336, 429EXP 152Expand 414exponenciación 103

Ffecha y hora

funciones de TurboIntegrator 303FEEDERS 164FEEDSTRINGS 165fila

Cube Viewer 21FileExists 415FILL 159filtrar

elementos por atributo, cuadro de diálogo 32elementos por nivel, cuadro de diálogo 33subconjunto, cuadro de diálogo 33vista, cuadro de diálogo 35

ForceSkipCheck 347FormatDate 303Fórmula de variables del proceso 92funciones

reglas 103, 167TurboIntegrator 217

Funciones de cálculo 108funciones de hoja de trabajo de TM1

TM1ELLIST 205TM1GLOBALSANDBOX 208TM1INFO 208TM1PRIMARYDBNAME 209

Índice 439

funciones de macroacceder 167lista 167

funciones de recintos de pruebas 348funciones de reglas de jerarquías 147funciones de reglas de texto 158funciones de reglas financieras 145funciones de reglas matemáticas 150Funciones de TurboIntegrator de ODBC 333funciones de TurboIntegrator de reserva de datos

CubeDataReservationAcquire 293CubeDataReservationGet 296CubeDataReservationGetConflicts 297CubeDataReservationRelease 294CubeDataReservationReleaseAll 295CubeDRAcquire 298CubeDRGet 301CubeDRGetConflicts 302CubeDRRelease 299CubeDRReleaseAll 300

FV 145

GGetProcessErrorFileDirectory 338GetProcessErrorFilename 338GetProcessName 339GetUseActiveSandboxProperty 348Grupo de servidores

Server Explorer 56guardar

cuadro de diálogo de vista del navegador de hojas decálculo 50subconjunto, cuadro de diálogo 50vista, cuadro de diálogo 50

HHierarchyATTRN 253HierarchyATTRNL 254HierarchyAttrPutN 251HierarchyAttrPutS 252HierarchyATTRS 253HierarchyATTRSL 255HierarchyContainsAllLeaves 319HierarchyCreate 319HierarchyDeleteAllElements 320HierarchyDeleteElements 320HierarchyDestroy 321HierarchyElementComponentAdd 321HierarchyElementComponentAddDirect 321HierarchyElementComponentDelete 322HierarchyElementComponentDeleteDirect 323HierarchyElementDelete 324HierarchyElementDeleteDirect 324HierarchyElementExists 325HierarchyElementInsert 326HierarchyElementInsertDirect 326HierarchyElementPrincipalName 328HierarchyElementSecurityGet 365HierarchyElementSecurityPut 365HierarchyExists 328HierarchyHasOrphanedLeaves 329

HierarchySortOrder 329HierarchySubsetAliasSet 378HierarchySubsetAttrDelete 262HierarchySubsetAttrInsert 261HierarchySubsetATTRN 256HierarchySubsetATTRNL 258HierarchySubsetAttrPutN 260HierarchySubsetAttrPutS 259HierarchySubsetATTRS 256HierarchySubsetATTRSL 257HierarchySubsetCreate 378HierarchySubsetDeleteAllElements 379HierarchySubsetDestroy 380HierarchySubsetElementDelete 381HierarchySubsetElementExists 380HierarchySubsetElementGetIndex 381HierarchySubsetElementInsert 382HierarchySubsetExists 383HierarchySubsetGetElementName 383HierarchySubsetGetSize 383HierarchySubsetIsAllSet 384HierarchySubsetMDXGet 385HierarchySubsetMDXSet 385HierarchyTimeLastUpdated 331HierarchyTopElementInsert 331HierarchyTopElementInsertDirect 332HierarchyUpdateDirect 333hoja de trabajo

botón de acción 3

II_EXPORT 171I_NAMES 172I_PROCESS 172If 339IF 149importar 47imprimir 47Informes dinámicos

TM1ELLIST 205TM1GLOBALSANDBOX 208TM1INFO 208TTM1PRIMARYDBNAME 209

insertar referencia de cubo 49INSRT 160INT 152ISUND 153ISUNDEFINEDCELLVALUE 117ItemReject 340ItemSkip 340

Jjaponés 47jerarquía

funciones de manipulación de TurboIntegrator 319juego de caracteres 220juegos de caracteres grandes 47

KKEY_ERR 189

440 IBM Planning Analytics: Referencia de TM1

Llectura

asignaciones de seguridad 52LevelCount 145LN 153LOG 153lógicas

funciones de reglas 149lógicos

operadores 103LONG 160LOWER 160

MM_CLEAR 173marcadores 47MAX 154menú Archivo

atributos 7Cube Viewer 22Editor de TurboIntegrator 77Server Explorer 56ventana Registro de mensajes 38

menú Ayudaventana Registro de mensajes 39

menú dinámicoServer Explorer 56

menú Editaratributos 7Cube Viewer 22Editor de dimensiones 25Editor de subconjuntos 69Editor de TurboIntegrator 77resultados de la consulta del registro de transacciones75Server Explorer 67ventana Registro de mensajes 38

menú Gruposclientes/grupos 16

menú HerramientasEditor de subconjuntos 72

Menú Navegador de hojas de cálculo 37menú Ver

Cube Viewer 23Editor de dimensiones 28Editor de subconjuntos 71Server Explorer 67

MetadataMinorErrorCount 430metadatos

Editor de TurboIntegrator 97método Ejecutar 167MIN 154MinorErrorLogMax 427MOD 154módulos VBA

funciones de macro 167MONTH 122

NN_CONNECT 173

N_DISCONNECT 173NewDateFormatter 304ninguno

Asignaciones de seguridad 51no aplicar sangría 47NOW 123nuevo atributo, cuadro de diálogo 39NumberToString 219NumberToStringEx 220NUMBR 161NumericGlobalVariable(VariableName) 430NumericSessionVariable(VariableName) 432números de línea 48NValue 427

OODBCClose 333ODBCOpen 334ODBCOPENEx 334ODBCOutput 335omitir parámetros

extracción de vistas 100OnMinorErrorDoItemSkip 427opciones

atributos 8menú Cube Viewer 23propiedades de elementos de dimensiones 30

operadores aritméticos 103OPTGET 174optimizar cubos 20OPTSET 175

Ppanel de la derecha (panel Propiedades)

Server Explorer 56panel de la izquierda (panel de árbol)

Server Explorer 56parámetros

Editor de TurboIntegrator 97parámetros de inicio de sesión

opciones de TM1 73parámetros de rango

extracción de vistas 100ParseDate 305PAYMT 146pestaña Correlaciones del Editor de TurboIntegrator 93pestaña Planificación

Editor de TurboIntegrator 99pestañas

Editor de TurboIntegrator 77preferencias 49proceso

botón de acción 2funciones de TurboIntegrator de control 336Server Explorer 66

ProcessAttrDelete 262ProcessAttrInsert 263ProcessAttrN 263ProcessAttrNL 264ProcessAttrPutN 265ProcessAttrPutS 266

Índice 441

ProcessAttrS 267ProcessAttrSL 267ProcessBreak 340ProcessError 341ProcessExists 341ProcessQuit 341ProcessReturnCode 431ProcessRollback 341PrologMinorErrorCount 431prólogo

Editor de TurboIntegrator 97propiedades

configuración regional 8de elementos de dimensiones, panel 30panel Editor de dimensiones 25panel Editor de subconjuntos 68

propiedades de configuración regional 8PublishSubset 176PublishView 176, 396PV 146

QQUDEFINE 176QUDEFINEEX 178QUEXPORT 180QULOOP 181QUSUBSET 181

RR_SAVE 182RAND 155RefreshMdxHierarchy, función 375regiones definidas por el usuario 48registro de auditoría

ventana 10ventana de detalles 13

registro de mensajesventana 38

reglafunciones 103funciones de macro 167funciones de TurboIntegrator de gestión 345información del Editor de subconjuntos 45

RemoveCAMIDAssociation 366RemoveCAMIDAssociationFromGroup 366RemoveClientFromGroup 367replicar

Server Explorer 65replicar cubo

cuadro de diálogo 44Server Explorer 65

reservaasignaciones de seguridad 53

ROUND 155ROUNDP 156RuleLoadFromFile 347RunProcess 342

Ssangría 47

SAPCharacteristicTexts 426SaveDataAll 376SCAN 161SecurityOverlayCreateGlobalDefault 370SecurityOverlayDestroyGlobalDefault 371SecurityOverlayGlobalLockCell 370SecurityOverlayGlobalLockNode 372SecurityRefresh 372seguridad

Asignaciones de, cuadro de diálogo 51funciones de TurboIntegrator 359menú de Clientes/Grupos 16

seleccionar cubocuadro de diálogo 55para reglas, cuadro de diálogo 55

seleccionar dimensiónasignaciones de seguridad 55cuadro de diálogo 55

seleccionar elementocuadro de diálogo 55extracción de vistas 100

ServerActiveSandboxGet 349ServerActiveSandboxSet 349ServerSandboxesDelete 351ServerSandboxExists 356ServerSandboxGet 357ServerSandboxListCountGets 357ServerShutdown 377servidor

Explorer (ventana principal) 56funciones de manipulación de TurboIntegrator 373Server Explorer 56

servidor localopciones de TM1 73

SetChoreVerboseMessages 281SetDimensionGroupsSecurity 368SetElementGroupsSecurity 369SetHierarchyElementGroupsSecurity 368SetHierarchyGroupsSecurity 367SetInputCharacterSet 220SetODBCUnicodeInterface 335SetOutputEscapeDoubleQuote 223SetUseActiveSandboxProperty 358SIGN 156SIN 157sintaxis 343SQRT 157STET 150, 217STR 162StringGlobalVariable(VariableName) 430StringSessionVariable(VariableName) 432StringToNumber 224StringToNumberEx 224subconjunto

editor 68funciones de manipulación de TurboIntegrator 378menú Editor de subconjuntos 69Server Explorer 64

SUBDEFINE 182SUBNM 203SUBPICK 183SubsetAliasSet 386SubsetAttrDelete 274SubsetAttrInsert 273

442 IBM Planning Analytics: Referencia de TM1

SubsetATTRN 269SubsetATTRNL 270SubsetAttrPutN 272SubsetAttrPutS 271SubsetATTRS 268SubsetATTRSL 269SubsetCreate 386SubsetCreateByMDX 387SubsetDeleteAllElements 389SubsetDestroy 389SubsetElementDelete 389SubsetElementExists 390SubsetElementGetIndex 390SubsetElementInsert 391SubsetExists 391SubsetExpandAboveSet 392SubsetFormatStyleSet 393SubsetGetElementName 393SubsetGetSize 394SubsetIsAllSet 394SubsetMDXGet 394SubsetMDXSet 395SUBSIZ 204SUBST 163SValue 428synchronized() 343

TT_CLEAR 184T_CREATE 184T_CREATE16 185T_PICK 186T_SAVE 186TABDIM 131, 205TAN 157tarea

abandonar 281asistente para la configuración 14funciones de TurboIntegrator de gestión 280Server Explorer 66, 67

TextOutput 225TIME 123TIMST 123TIMVL 125TM1ELLIST 205TM1GLOBALSANDBOX 208TM1INFO 208Tm1p.xla 167TM1PRIMARYDBNAME 209TM1ProcessError.log 428TM1RECALC 186TM1RECALC1 186TM1RptElIsConsolidated 209TM1RPTELISCONSOLIDATED 214TM1RptElIsExpanded 210TM1RptElLev 210TM1RPTELLSEXPANDED 214TM1RptFilter 210TM1RptRow 211TM1RptTitle 213TM1RptView 214TM1User 214, 416todas las pantallas

todas las pantallas (continuación)asistente de informes de impresión 40

TODAY 127TRIM 164TurboIntegrator

funciones 217límites 217variables de usuario 432variables globales 429

UUNDEFINEDCELLVALUE 118UPPER 164UTF-8 220

VValue_Is_String 429variables

de usuario de TurboIntegrator 432global 429globales implícitas 430pestaña del editor de TurboIntegrator 91

variables globales 429variables globales implícitas 430variables locales 419varios

funciones de reglas 164funciones de TurboIntegrator 411

ventana Detalles del registro de auditoría 13ventana Registro de auditoría 10ventana Registro de mensajes 38ventanas y cuadros de diálogo 1VIEW 215ViewAttrDelete 274ViewAttrInsert 275ViewAttrN 275ViewAttrNL 276ViewAttrPutN 277ViewAttrPutS 278ViewAttrS 279ViewAttrSL 279ViewColumnDimensionSet 398ViewColumnSuppressZeroesSet 398ViewConstruct 399ViewCreate 399ViewCreateByMDX 400ViewDestroy 402ViewExists 402ViewExtractFilterByTitlesSet 402ViewExtractSkipCalcsSet 403ViewExtractSkipConsolidatedStringsSet 404ViewExtractSkipRuleValuesSet 405ViewExtractSkipZeroesSet 406ViewMDXGet 407ViewMDXSet 406ViewRowDimensionSet 407ViewRowSuppressZeroesSet 408ViewSubsetAssign 409ViewSuppressZeroesSet 409ViewTitleDimensionSet 410ViewTitleElementSet 410

Índice 443

ViewZeroOut 411vista

cuadro de diálogo de estilos 100funciones de manipulación de TurboIntegrator 395ventana de extracción 100

vista previa de cuadrículaeditor de TurboIntegrator 91

VUSLICE 187

WW_DBSENABLE 187While 344WildcardFileSearch 416

YYEAR 128

444 IBM Planning Analytics: Referencia de TM1

IBM®