IBM Planning AnalyticsVersão 2 Release 0

Referência do TM1

IBM

Nota

Antes de usar estas informações e o produto que elas suportam, leia as informações em “Avisos” napágina 431.

Informações do Produto

Este documento se aplica ao IBM Planning Analytics Versão 2.0 e também pode se aplicar às liberações subsequentes.

Licensed Materials - Property of IBM

Última atualização: 2019-11-05© Copyright International Business Machines Corporation 2007, 2019.

Índice

Introdução.......................................................................................................... xv

Capítulo 1. Windows e Caixas de Diálogo............................................................... 1Caixa de Diálogo Propriedades do Botão de Ação...................................................................................... 1

Guia Processo......................................................................................................................................... 2Guia Planilha...........................................................................................................................................2Guia Aparência....................................................................................................................................... 4

Caixa de Diálogo Opções Avançadas...........................................................................................................4Grade Mapeamento Avançado...............................................................................................................5

Editor de Atributos....................................................................................................................................... 7Menu Arquivo..........................................................................................................................................7Menu Editar.............................................................................................................................................7Opções de Formato................................................................................................................................ 8

Janela de Log de Auditoria.......................................................................................................................... 9Painel Consulta.....................................................................................................................................10Painel Resultados.................................................................................................................................12

Janela Detalhes do Log de Auditoria.........................................................................................................13Barra de Ferramentas Detalhes...........................................................................................................13Grade Detalhes.....................................................................................................................................14

Assistente de Configuração de Tarefa de Organização de Processos..................................................... 14Tela 1 (Etapa 1).................................................................................................................................... 14Tela 2 (Etapa 2).................................................................................................................................... 15

Janela Clientes/Grupos............................................................................................................................. 15Menu Segurança...................................................................................................................................16Menu Clientes.......................................................................................................................................16Menu Grupos........................................................................................................................................ 16Grade Clientes/Grupos.........................................................................................................................17

Caixa de Diálogo Mensagens para os Clientes..........................................................................................18Caixa de Diálogo Criar uma Dimensão...................................................................................................... 18Caixa de Diálogo Criar Objeto de Replicação do Servidor........................................................................ 18Caixa de Diálogo Criando Cubo................................................................................................................. 19Caixa de Diálogo do Cube Optimizer......................................................................................................... 20Caixa de Diálogo Propriedades do Cubo................................................................................................... 21Cube Viewer............................................................................................................................................... 21

Menu Arquivo........................................................................................................................................21Menu Editar.......................................................................................................................................... 22Menu Visualizar.................................................................................................................................... 23Menu de Opções...................................................................................................................................23

Caixa de Diálogo Excluir Subconjuntos Nomeados.................................................................................. 24Caixa de Diálogo Excluir Visualizações Nomeadas...................................................................................24Editor de Dimensão....................................................................................................................................24

Menu Dimensão....................................................................................................................................25Menu Editar.......................................................................................................................................... 25Menu Visualizar.................................................................................................................................... 28

Caixa de Diálogo Inserir Elemento de Dimensão......................................................................................28Caixa de Diálogo Ordenação de Elementos de Dimensão........................................................................29Caixa de Diálogo Propriedades do Elemento de Dimensão..................................................................... 30Drill ............................................................................................................................................................ 30Caixa de Diálogo Editar Fórmula............................................................................................................... 31Caixa de Diálogo Editar Referência ao Cubo.............................................................................................31

iii

Caixa de Diálogo Filtrar Elementos por Atributo.......................................................................................32Caixa de Diálogo Filtrar Elementos por Nível............................................................................................32Caixa de Diálogo Filtrar Subconjunto........................................................................................................ 32Caixa de Diálogo Filtrar Visualização........................................................................................................ 34Caixa de Diálogo Obter Visualização (In-Spreadsheet Browser)............................................................. 36Menu do In-Spreadsheet Browser............................................................................................................ 36Janela Log de Mensagens..........................................................................................................................37

Menu Arquivo........................................................................................................................................37Menu Editar.......................................................................................................................................... 38Menu Ajuda...........................................................................................................................................38

Caixa de Diálogo Novo Atributo.................................................................................................................38Caixa de Diálogo Abrir Subconjunto..........................................................................................................38Caixa de Diálogo Abrir Visualização.......................................................................................................... 39Assistente de Relatório de Impressão......................................................................................................39

Todas as Telas......................................................................................................................................39Tela 1 de 3............................................................................................................................................ 39Tela 2 de 3............................................................................................................................................ 40Tela 3 de 3............................................................................................................................................ 41

Caixa de Diálogo Opções de Processo...................................................................................................... 43Caixa de Diálogo Replicar Cubo.................................................................................................................44

Informações do Cubo...........................................................................................................................44Informações sobre Regra.....................................................................................................................44Informações da Dimensão...................................................................................................................44

Editor de Regras.........................................................................................................................................46Menu Arquivo........................................................................................................................................46Menu Editar.......................................................................................................................................... 46Menu Visualizar.................................................................................................................................... 47Menu Inserir......................................................................................................................................... 48Menu Ferramentas............................................................................................................................... 48

Caixa de Diálogo Salvar Subconjunto........................................................................................................49Caixa de Diálogo Salvar Visualização........................................................................................................ 49Caixa de Diálogo Salvar Visualização (In-Spreadsheet Browser)............................................................ 49Caixa de Diálogo Designações de Segurança........................................................................................... 50

Grade Designações...............................................................................................................................50Privilégios de Acesso............................................................................................................................50Selecionar Dimensão............................................................................................................................54

Caixa de Diálogo Selecionar Cubo.............................................................................................................54Caixa de Diálogo Selecionar Cubo para Regras........................................................................................ 54Caixa de Diálogo Selecionar Dimensão.....................................................................................................54Caixa de Diálogo Selecionar Elemento......................................................................................................54Server Explorer (Janela Principal).............................................................................................................55

Menu Arquivo........................................................................................................................................55Menu Dinâmico.....................................................................................................................................55Menu Editar.......................................................................................................................................... 66Menu Visualizar.................................................................................................................................... 66

Editor de Subconjunto............................................................................................................................... 67Menu Subconjunto............................................................................................................................... 68Menu Editar.......................................................................................................................................... 68Menu Visualizar.................................................................................................................................... 70Menu Ferramentas............................................................................................................................... 71

Caixa de Diálogo de Alias...........................................................................................................................72Caixa de diálogo Opções do TM1.............................................................................................................. 72

Parâmetros de Login............................................................................................................................ 72Servidor Local....................................................................................................................................... 72Segurança da Camada de Transporte do Servidor..............................................................................73

Caixa de Diálogo Consulta do Log de Transações.................................................................................... 74Caixa de Diálogo Resultados da Consulta do Log de Transações............................................................ 74Editor do Turbo Integrator.........................................................................................................................75

iv

Menu Arquivo........................................................................................................................................76Menu Editar.......................................................................................................................................... 76Guia Origem de Dados..........................................................................................................................76Grade de Visualização.......................................................................................................................... 89Guia Variáveis....................................................................................................................................... 89Guia Mapas........................................................................................................................................... 91Guia Avançado......................................................................................................................................95Guia Programação................................................................................................................................ 97

Janela Extração de Visualização............................................................................................................... 97Caixa de Diálogo Estilos de Visualização.................................................................................................. 98

Capítulo 2. Funções das Regras..........................................................................101Operadores aritméticos no TM1 Rules................................................................................................... 101Operadores de comparação no TM1 Rules.............................................................................................101Operadores lógicos no TM1 Rules.......................................................................................................... 101Funções de Regras de Atributo............................................................................................................... 102

ATTRN.................................................................................................................................................102ATTRS................................................................................................................................................. 103CubeATTRN........................................................................................................................................ 104CubeATTRS.........................................................................................................................................104DimensionATTRN............................................................................................................................... 104DimensionATTRS................................................................................................................................105ElementAttrN..................................................................................................................................... 105ElementAttrS......................................................................................................................................106

Funções de Regras de Cálculo de Consolidação.................................................................................... 107ConsolidatedAvg................................................................................................................................ 107ConsolidateChildren...........................................................................................................................108ConsolidatedCount.............................................................................................................................110ConsolidatedCountUnique.................................................................................................................111ConsolidatedMax................................................................................................................................111ConsolidatedMin................................................................................................................................ 112

Funções de Regras de Dados do Cubo....................................................................................................113CellValueN.......................................................................................................................................... 113CellValueS.......................................................................................................................................... 114BD....................................................................................................................................................... 115ISLEAF................................................................................................................................................ 115ISUNDEFINEDCELLVALUE................................................................................................................. 116UNDEF................................................................................................................................................ 116UNDEFINEDCELLVALUE.....................................................................................................................117UNDEFVALS........................................................................................................................................ 117

Funções de Regras de Data e Hora......................................................................................................... 119DATA...................................................................................................................................................119DATES.................................................................................................................................................119DIA......................................................................................................................................................120DAYNO................................................................................................................................................120MÊS.....................................................................................................................................................121AGORA................................................................................................................................................121TIME................................................................................................................................................... 121TIMST................................................................................................................................................. 121TIMVL .................................................................................................................................................123HOJE...................................................................................................................................................125ANO.....................................................................................................................................................126

Funções de Regras de Informações de Dimensão................................................................................. 126DIMIX................................................................................................................................................. 127DIMNM................................................................................................................................................127DIMSIZ ...............................................................................................................................................127DNEXT.................................................................................................................................................128

v

DNLEV.................................................................................................................................................128DTYPE ................................................................................................................................................ 129TABDIM.............................................................................................................................................. 129

Funções de Regras de Informações de Elementos................................................................................ 130ELCOMP ............................................................................................................................................. 130ELCOMPN........................................................................................................................................... 130ElementComponent .......................................................................................................................... 131ElementComponentCount................................................................................................................. 131ElementCount ....................................................................................................................................132ElementFirst....................................................................................................................................... 132ElementIndex.....................................................................................................................................133ElementIsAncestor............................................................................................................................ 133ElementIsComponent........................................................................................................................134ElementIsParent ............................................................................................................................... 134ElementLevel......................................................................................................................................135NomeElemento.................................................................................................................................. 136ElementNext.......................................................................................................................................136ElementParent................................................................................................................................... 137ElementParentCount..........................................................................................................................137Tipo de Elemento .............................................................................................................................. 138ElementWeight .................................................................................................................................. 138ELISANC............................................................................................................................................. 139ELISCOMP ..........................................................................................................................................139ELISPAR .............................................................................................................................................140ELLEV..................................................................................................................................................140ELPAR................................................................................................................................................. 141ELPARN...............................................................................................................................................141ELWEIGHT ......................................................................................................................................... 142LevelCount..........................................................................................................................................142

Funções de Regras Financeiras...............................................................................................................143VF........................................................................................................................................................143PAYMT ................................................................................................................................................144VP........................................................................................................................................................144

Funções de regras de hierarquias........................................................................................................... 145Hierarquia...........................................................................................................................................145HierarchyCount.................................................................................................................................. 145HierarchyIndex...................................................................................................................................145HierarchyN..........................................................................................................................................146

Funções de Regras Lógicas..................................................................................................................... 146CONTINUE..........................................................................................................................................146SE........................................................................................................................................................147STET....................................................................................................................................................147

Funções de Regras Matemáticas............................................................................................................ 148ABS..................................................................................................................................................... 148ACOS...................................................................................................................................................148ASEN...................................................................................................................................................148ATAN...................................................................................................................................................149COS..................................................................................................................................................... 149EXP..................................................................................................................................................... 149INT...................................................................................................................................................... 150ISUND................................................................................................................................................. 150LN........................................................................................................................................................150LOG..................................................................................................................................................... 151MÁXIMO............................................................................................................................................. 151MÍNIMO ............................................................................................................................................. 151Resto...................................................................................................................................................152ALEATÓRIO........................................................................................................................................ 152ARRED................................................................................................................................................ 152

vi

ROUNDP............................................................................................................................................. 153SINAL..................................................................................................................................................154SEN..................................................................................................................................................... 154RAIZ....................................................................................................................................................154TAN..................................................................................................................................................... 155

Funções de Regras de Texto................................................................................................................... 155CAPIT..................................................................................................................................................155CARACT.............................................................................................................................................. 155CÓDIGO.............................................................................................................................................. 156DELET................................................................................................................................................. 156FILL.....................................................................................................................................................157INSRT................................................................................................................................................. 157LONG...................................................................................................................................................157MINÚSCULA....................................................................................................................................... 158NUMBR .............................................................................................................................................. 158SCAN...................................................................................................................................................158STR......................................................................................................................................................159SUBST.................................................................................................................................................161ARRUMAR...........................................................................................................................................161MAIÚSCULA........................................................................................................................................162

Diversas Funções de Regras....................................................................................................................162FEEDERS.............................................................................................................................................162FEEDSTRINGS.................................................................................................................................... 162SKIPCHECK........................................................................................................................................ 163

Capítulo 3. Funções de Macro............................................................................ 165Acessando funções macro do Microsoft Excel 2010 e posterior...........................................................165Acessando Funções de Macro a partir de Módulos VBA........................................................................ 165D_PICK.....................................................................................................................................................165D_FSAVE.................................................................................................................................................. 166D_SAVE.................................................................................................................................................... 167DBProportionalSpread.............................................................................................................................167E_PICK..................................................................................................................................................... 168I_EXPORT................................................................................................................................................ 169I_NAMES ................................................................................................................................................. 170I_PROCESS.............................................................................................................................................. 170M_CLEAR..................................................................................................................................................171N_CONNECT.............................................................................................................................................171N_DISCONNECT...................................................................................................................................... 171OPTGET....................................................................................................................................................172OPTSET.................................................................................................................................................... 173PublishSubset..........................................................................................................................................173PublishView............................................................................................................................................. 174QUDEFINE................................................................................................................................................174QUDEFINEEX........................................................................................................................................... 176QUEXPORT...............................................................................................................................................178QULOOP................................................................................................................................................... 179QUSUBSET............................................................................................................................................... 179R_SAVE.................................................................................................................................................... 180SUBDEFINE..............................................................................................................................................180SUBPICK.................................................................................................................................................. 181T_CLEAR...................................................................................................................................................182T_CREATE................................................................................................................................................ 182T_CREATE16............................................................................................................................................ 183T_PICK..................................................................................................................................................... 183T_SAVE.....................................................................................................................................................184TM1RECALC............................................................................................................................................. 184

vii

TM1RECALC1...........................................................................................................................................184VUSLICE................................................................................................................................................... 185W_DBSENABLE........................................................................................................................................185

Capítulo 4. Funções da Planilha......................................................................... 187DBR.......................................................................................................................................................... 187DBRA........................................................................................................................................................ 188DBRW....................................................................................................................................................... 189DBS...........................................................................................................................................................189DBSA........................................................................................................................................................ 190DBSS........................................................................................................................................................ 191DBSW....................................................................................................................................................... 192DFRST.......................................................................................................................................................192DIMIX....................................................................................................................................................... 193DIMNM..................................................................................................................................................... 193DIMSIZ..................................................................................................................................................... 194DNEXT...................................................................................................................................................... 194DNLEV...................................................................................................................................................... 195DTYPE.......................................................................................................................................................196ELCOMP....................................................................................................................................................196ELCOMPN................................................................................................................................................. 197ELISCOMP................................................................................................................................................ 197ELISPAR................................................................................................................................................... 198ELLEV....................................................................................................................................................... 198ELPAR.......................................................................................................................................................199ELPARN.................................................................................................................................................... 200ELSLEN.....................................................................................................................................................200ELWEIGHT............................................................................................................................................... 200SUBNM..................................................................................................................................................... 201SUBSIZ.....................................................................................................................................................202TABDIM....................................................................................................................................................203TM1ELLIST...............................................................................................................................................203TM1GLOBALSANDBOX............................................................................................................................206TM1INFO..................................................................................................................................................206TM1PRIMARYDBNAME........................................................................................................................... 207TM1RptElIsConsolidated........................................................................................................................ 207TM1RptElIsExpanded..............................................................................................................................208TM1RptElLev............................................................................................................................................208TM1RptFilter............................................................................................................................................208TM1RptRow............................................................................................................................................. 209TM1RptTitle............................................................................................................................................. 211TM1RptView.............................................................................................................................................212TM1User...................................................................................................................................................212VIEW.........................................................................................................................................................213

Capítulo 5. Funções do Turbo Integrator.............................................................215Palavras reservadas do Turbo Integrator............................................................................................... 215Funções ASCII e de Texto do Turbo Integrator......................................................................................215

ASCIIDelete........................................................................................................................................215ASCIIOutput.......................................................................................................................................216NumberToString.................................................................................................................................217NumberToStringEx.............................................................................................................................218SetInputCharacterSet........................................................................................................................ 218SetOutputCharacterSet......................................................................................................................221SetOutputEscapeDoubleQuote......................................................................................................... 221StringToNumber.................................................................................................................................222StringToNumberEx.............................................................................................................................222

viii

TextOutput......................................................................................................................................... 223Funções de Manipulação de Atributos do Turbo Integrator.................................................................. 224

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

ix

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

Funções de Gerenciamento de Tarefas de Organização de Processos do Turbo Integrator................278ChoreError.......................................................................................................................................... 278ChoreQuit........................................................................................................................................... 278ChoreRollback.................................................................................................................................... 278SetChoreVerboseMessages............................................................................................................... 279

Funções de Manipulação de Cubos do Turbo Integrator....................................................................... 279AddCubeDependency........................................................................................................................ 279CellGetN............................................................................................................................................. 280CellGetS..............................................................................................................................................282CellIncrementN..................................................................................................................................282CellIsUpdateable............................................................................................................................... 283CellPutN..............................................................................................................................................283CellPutProportionalSpread................................................................................................................ 284CellPutS.............................................................................................................................................. 285CubeClearData................................................................................................................................... 286CubeCreate.........................................................................................................................................286CubeDestroy.......................................................................................................................................287CubeDimensionCountGet.................................................................................................................. 287CubeExists..........................................................................................................................................287CubeGetLogChanges..........................................................................................................................288CubeSaveData.................................................................................................................................... 288CubeSetConnParams......................................................................................................................... 289CubeSetLogChanges.......................................................................................................................... 290CubeTimeLastUpdated...................................................................................................................... 290CubeUnload........................................................................................................................................291

Funções do Turbo Integrator de Reserva de Dados............................................................................... 291CubeDataReservationAcquire............................................................................................................291CubeDataReservationRelease........................................................................................................... 292CubeDataReservationReleaseAll.......................................................................................................293CubeDataReservationGet.................................................................................................................. 294CubeDataReservationGetConflicts.................................................................................................... 295CubeDRAcquire.................................................................................................................................. 296CubeDRRelease..................................................................................................................................297CubeDRReleaseAll............................................................................................................................. 298CubeDRGet.........................................................................................................................................299CubeDRGetConflicts.......................................................................................................................... 300

Funções Date e Time do TurboIntegrator...............................................................................................301FormatDate.........................................................................................................................................301NewDateFormatter............................................................................................................................ 302ParseDate........................................................................................................................................... 303

Funções de Manipulação de Dimensões do Turbo Integrator............................................................... 304DimensionCreate................................................................................................................................304DimensionDeleteAllElements............................................................................................................304

x

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

Funções do TurboIntegrator para manipulação de hierarquia.............................................................. 317HierarchyContainsAllLeaves..............................................................................................................317HierarchyCreate................................................................................................................................. 317HierarchyDeleteAllElements............................................................................................................. 318ExcluirElementos da HierarchyDeleteElements............................................................................... 318HierarchyDestroy............................................................................................................................... 319HierarchyElementComponentAdd.....................................................................................................319HierarchyElementComponentAddDirect...........................................................................................320HierarchyElementComponentDelete................................................................................................ 321HierarchyElementComponentDeleteDirect...................................................................................... 321HierarchyElementDelete....................................................................................................................322HierarchyElementDeleteDirect..........................................................................................................323HierarchyElementExists.....................................................................................................................323HierarchyElementInsert.................................................................................................................... 324HierarchyElementInsertDirect.......................................................................................................... 325HierarchyElementPrincipalName...................................................................................................... 326HierarchyExists.................................................................................................................................. 326HierarchyHasOrphanedLeaves.......................................................................................................... 327HierarchySortOrder............................................................................................................................327HierarchyTimeLastUpdated...............................................................................................................329HierarchyTopElementInsert.............................................................................................................. 329HierarchyTopElementInsertDirect.................................................................................................... 330HierarchyUpdateDirect...................................................................................................................... 331

Funções Open Database Connectivity do Turbo Integrator................................................................... 332ODBCClose......................................................................................................................................... 332ODBCOpen..........................................................................................................................................332ODBCOPENEx.....................................................................................................................................332ODBCOutput.......................................................................................................................................333SetODBCUnicodeInterface................................................................................................................ 334

Funções de Controle de Processo do Turbo Integrator......................................................................... 334ExecuteCommand.............................................................................................................................. 334ExecuteProcess..................................................................................................................................335GetProcessErrorFileDirectory............................................................................................................337GetProcessErrorFilename..................................................................................................................337GetProcessName............................................................................................................................... 337Se........................................................................................................................................................ 338ItemReject..........................................................................................................................................338ItemSkip............................................................................................................................................. 339ProcessBreak..................................................................................................................................... 339

xi

ProcessError.......................................................................................................................................339ProcessExists..................................................................................................................................... 340ProcessQuit........................................................................................................................................ 340ProcessRollback.................................................................................................................................340RunProcess.........................................................................................................................................341Synchronized......................................................................................................................................341While...................................................................................................................................................343

Funções de Gerenciamento de Regras do Turbo Integrator..................................................................343CubeProcessFeeders......................................................................................................................... 343CubeRuleAppend............................................................................................................................... 344CubeRuleDestroy............................................................................................................................... 345DeleteAllPersistentFeeders............................................................................................................... 345ForceSkipCheck..................................................................................................................................346RuleLoadFromFile.............................................................................................................................. 346

Funções do Ambiente de Simulação.......................................................................................................347GetUseActiveSandboxProperty......................................................................................................... 347ServerActiveSandboxGet................................................................................................................... 347ServerActiveSandboxSet................................................................................................................... 348ServerSandboxClone..........................................................................................................................348ServerSandboxCreate........................................................................................................................ 349ServerSandboxesDelete.....................................................................................................................349ServerSandboxDiscardAllChanges.................................................................................................... 353ServerSandboxMerge.........................................................................................................................353ServerSandboxExists......................................................................................................................... 354ServerSandboxGet............................................................................................................................. 355ServerSandboxListCountGet..............................................................................................................356SetUseActiveSandboxProperty..........................................................................................................357

Funções de Segurança do Turbo Integrator........................................................................................... 357AddClient............................................................................................................................................357AddGroup........................................................................................................................................... 358AssignClientToGroup......................................................................................................................... 358AssignClientPassword........................................................................................................................359AssociateCAMIDToGroup.................................................................................................................. 359CellSecurityCubeCreate.....................................................................................................................359CellSecurityCubeDestroy................................................................................................................... 360DeleteClient........................................................................................................................................361DeleteGroup....................................................................................................................................... 361ElementSecurityGet........................................................................................................................... 361ElementSecurityPut........................................................................................................................... 362HierarchyElementSecurityGet........................................................................................................... 363HierarchyElementSecurityPut........................................................................................................... 363RemoveCAMIDAssociation................................................................................................................ 364RemoveCAMIDAssociationFromGroup............................................................................................. 364RemoveClientFromGroup.................................................................................................................. 365SetHierarchyGroupsSecurity............................................................................................................. 365SetHierarchyElementGroupsSecurity............................................................................................... 366SetDimensionGroupsSecurity............................................................................................................366SetElementGroupsSecurity............................................................................................................... 367SecurityOverlayGlobalLockCell......................................................................................................... 368SecurityOverlayCreateGlobalDefault................................................................................................ 368SecurityOverlayDestroyGlobalDefault...............................................................................................369SecurityOverlayGlobalLockNode.......................................................................................................370SecurityRefresh..................................................................................................................................370

Funções de Manipulação do Servidor do Turbo Integrator....................................................................371BatchUpdateFinish.............................................................................................................................371BatchUpdateFinishWait..................................................................................................................... 372BatchUpdateStart.............................................................................................................................. 373DisableBulkLoadMode....................................................................................................................... 373

xii

EnableBulkLoadMode........................................................................................................................ 373RefreshMdxHierarchy........................................................................................................................ 374SaveDataAll........................................................................................................................................ 375ServerShutdown.................................................................................................................................376

Funções de Manipulação de Subconjunto do Turbo Integrator.............................................................376HierarchySubsetAliasSet................................................................................................................... 376HierarchySubsetCreate......................................................................................................................377HierarchySubsetDeleteAllElements.................................................................................................. 378HierarchySubsetDestroy....................................................................................................................378HierarchySubsetElementExists......................................................................................................... 379HierarchySubsetElementDelete........................................................................................................ 379HierarchySubsetElementGetIndex................................................................................................... 380HierarchySubsetElementInsert.........................................................................................................380HierarchySubsetExists.......................................................................................................................381HierarchySubsetGetSize.................................................................................................................... 382HierarchySubsetGetElementName................................................................................................... 382HierarchySubsetIsAllSet....................................................................................................................383HierarchySubsetMDXGet................................................................................................................... 383HierarchySubsetMDXSet....................................................................................................................383SubsetAliasSet................................................................................................................................... 384SubsetCreate......................................................................................................................................384SubsetCreateByMDX..........................................................................................................................386SubsetDeleteAllElements..................................................................................................................387SubsetDestroy....................................................................................................................................388SubsetElementDelete........................................................................................................................ 388SubsetElementExists......................................................................................................................... 389SubsetElementGetIndex................................................................................................................... 389SubsetElementInsert.........................................................................................................................390SubsetExists.......................................................................................................................................390SubsetExpandAboveSet.....................................................................................................................391SubsetFormatStyleSet....................................................................................................................... 391SubsetGetElementName................................................................................................................... 392SubsetGetSize.................................................................................................................................... 392SubsetIsAllSet....................................................................................................................................393SubsetMDXGet................................................................................................................................... 393SubsetMDXSet....................................................................................................................................394

Funções de Manipulação de Visualização do Turbo Integrator............................................................. 394PublishView........................................................................................................................................394DisableMTQViewConstruct................................................................................................................ 395EnableMTQViewConstruct................................................................................................................. 396ViewColumnDimensionSet................................................................................................................ 397ViewColumnSuppressZeroesSet....................................................................................................... 397ViewConstruct.................................................................................................................................... 398ViewCreate......................................................................................................................................... 398ViewCreateByMDX............................................................................................................................. 399ViewDestroy....................................................................................................................................... 401ViewExists.......................................................................................................................................... 401ViewExtractFilterByTitlesSet.............................................................................................................401ViewExtractSkipCalcsSet...................................................................................................................402ViewExtractSkipConsolidatedStringsSet...........................................................................................403ViewExtractSkipRuleValuesSet......................................................................................................... 404ViewExtractSkipZeroesSet................................................................................................................ 405ViewMDXSet....................................................................................................................................... 406ViewMDXGet.......................................................................................................................................406ViewRowDimensionSet......................................................................................................................406ViewRowSuppressZeroesSet.............................................................................................................407ViewSubsetAssign..............................................................................................................................408ViewSuppressZeroesSet....................................................................................................................408

xiii

ViewTitleDimensionSet......................................................................................................................409ViewTitleElementSet..........................................................................................................................409ViewZeroOut.......................................................................................................................................410

Diversas Funções do Turbo Integrator................................................................................................... 410AddInfoCubeRestriction.................................................................................................................... 410ExecuteJavaN.....................................................................................................................................412ExecuteJavaS..................................................................................................................................... 412Expandir..............................................................................................................................................413FileExists............................................................................................................................................ 414LogOutput...........................................................................................................................................414TM1User............................................................................................................................................. 415WildcardFileSearch............................................................................................................................ 415

Capítulo 6. Variáveis do Turbo Integrator........................................................... 417Variáveis Locais do Turbo Integrator...................................................................................................... 417

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

Variáveis Globais do Turbo Integrator.................................................................................................... 427NumericGlobalVariable('VariableName');......................................................................................... 428StringGlobalVariable('VariableName');..............................................................................................428

Variáveis Globais Implícitas.................................................................................................................... 428DataMinorErrorCount......................................................................................................................... 428MetadataMinorErrorCount................................................................................................................. 429ProcessReturnCode........................................................................................................................... 429PrologMinorErrorCount...................................................................................................................... 430

Variáveis de Usuário do Turbo Integrator...............................................................................................430

Avisos............................................................................................................... 431

Índice Remissivo............................................................................................... 435

xiv

Introdução

Este documento foi criado para ser usado com o IBM® Planning Analytics.

Este documento é uma coleção de materiais de referência para as funções de software, variáveis e outroselementos de programação do IBM Planning Analytics.

O Planning Analytics fornece soluções de software para o gerenciamento e o monitoramento contínuosde Gerenciamento do desempenho Financeiro e Operacional na empresa.

Renúncia de Responsabilidade de Amostras

A Companhia de Aventuras de Amostra, a Companhia das Grandes Aventuras, a GO Sales, qualquervariação dos nomes Aventuras de Amostra ou Grandes Aventuras, e a Amostra de Planejamentorepresentam operações de negócios fictícias com dados de amostra usados para desenvolver aplicativosde amostra para a IBM e para os clientes da IBM. Esses registros fictícios incluem dados de amostra paratransações de vendas, distribuições de produtos, finanças e recursos humanos. Qualquer semelhançacom nomes, endereços, números de contato ou valores de transações reais é mera coincidência. Outrosarquivos de amostra podem conter dados fictícios gerados automática ou manualmente, dados factuaiscompilados de origens acadêmicas ou públicas ou dados usados com permissão do portador decopyright, para uso como dados de amostra para desenvolver aplicativos de amostra. Os nomes deprodutos referidos podem ser marcas comerciais de seus respectivos proprietários. A duplicação nãoautorizada é proibida.

Recursos de Acessibilidade

Os recursos de acessibilidade ajudam os usuários que têm deficiências físicas como mobilidade reduzidaou visão limitada a usar produtos de tecnologia da informação.

Atualmente este produto não é compatível com recursos de acessibilidade que ajudam usuários comdeficiências físicas, como mobilidade ou visão restritas, a usá-lo.

Instruções prospectivas

Esta documentação descreve a funcionalidade atual do produto. Referências a itens que não estãodisponíveis atualmente podem estar incluídas. Não se deve inferir implicações de qualquerdisponibilidade futura. Tais referências não representam um compromisso, uma promessa ou umaobrigação legal de entrega de qualquer material, código ou funcionalidade. O desenvolvimento, aliberação e a sincronização de recursos ou funcionalidade ficam ao arbítrio exclusivo da IBM.

Considerações de segurança

Para considerações de segurança para IBM Planning Analytics, consulte Instalação e Configuração doPlanning Analytics. As informações sobre como gerenciar a autenticação de usuário e de grupo podem serlocalizadas no capítulo Gerenciando usuários e grupos da documentação Operações do TM1.

© Copyright IBM Corp. 2007, 2019 xv

xvi IBM Planning Analytics: Referência do TM1

Capítulo 1. Windows e Caixas de DiálogoEsta seção descreve todas as janelas e caixas de diálogo significativas do IBM Planning Analytics.

Caixa de Diálogo Propriedades do Botão de AçãoUse a caixa de diálogo Propriedades de Botão de Ação para incluir botões de ação do TM1 em umaplanilha. O botão pode ser configurado para executar um processo e/ou navegar para outra planilha.

Para obter exemplos e etapas sobre o uso dos botões de ação em planilhas, consulte TM1 for Developersno IBM Knowledge Center (https://www.ibm.com/support/knowledgecenter/SSD29G_2.0.0).

Servidor

Essa lista inclui os nomes de todos os servidores TM1 disponíveis no momento em sua rede.

Selecione o servidor em que o processo ou a planilha de destino está disponível para o botão de Ação.

Conectar

Este botão está disponível somente quando você não está conectado ao servidor atualmenteselecionado na caixa de listagem de servidores.

Clique neste botão para se conectar ao servidor selecionado na caixa de listagem de servidores.

Desconectar

Este botão está disponível somente quando você está conectado ao servidor atualmente selecionadona caixa de listagem de servidores.

Clique neste botão para se desconectar do servidor selecionado na caixa de servidores.

Ação

Selecione a ação que deseja que o botão de Ação execute quando for clicado.

• Executar um Processo do Turbo Integrator

Selecione esta opção para configurar um botão de Ação que executa um processo. Ao selecionaresta opção, a guia Processo torna-se ativada.

• Ir para Outra Planilha

Selecione esta opção para configurar um botão de Ação que navega para outra planilha. Aoselecionar esta opção, a guia Planilha torna-se ativada.

• Executar um Processo e ir para uma Planilha

Selecione esta opção para configurar um botão de Ação que executa um processo e, então, navegapara outra planilha. Ao selecionar esta opção, as guias Processo e Planilha tornam-se ativadas.

• Calcular/Reconstruir Somente

Selecione esta opção para recalcular ou reconstruir sem executar um processo do TI ou navegarpara uma nova planilha. Isso poderá ser útil se atualizar somente a planilha atual ou recarregar aversão original de um Formulário Ativo.

Também é possível usar a guia Calcular para selecionar a operação de cálculo que deseja que oTM1 execute antes de executar um processo do TI ou de navegar para outra planilha.

OK

Fecha a caixa de diálogo Propriedades do Botão de Ação e insere um botão de Ação na planilha.

Cancelar

Fecha a caixa de diálogo Propriedades do Botão de Ação sem inserir um botão de Ação.

© Copyright IBM Corp. 2007, 2019 1

Guia ProcessoUse a guia Processo para configurar um botão de Ação para executar um processo.Processo

Use esta lista para selecionar o processo que você deseja executar de uma das seguintes maneiras:

• Para executar um processo disponível no servidor atual, selecione o nome do processo na lista.• Para recuperar o nome do processo e valores de parâmetros da planilha atual, selecione Obter

Informações do Processo da Planilha.

Opções

Abre o diálogo Opções do Processo, no qual é possível controlar o comportamento do botão de Açãoantes e depois da execução do processo.

Para obter detalhes, consulte a seção “Caixa de Diálogo Opções de Processo” na página 43.

Nome do Processo

Esta opção aparece quando você seleciona Obter Informações do Processo da Planilha na listaProcesso.

Insira uma referência do Excel que forneça o nome do processo a ser executado de uma dasseguintes maneiras.

• Para fazer referência a uma única célula, use o seguinte formato: =ColumnNameRowName. Porexemplo: =A1.

• Para fazer referência a um intervalo nomeado no Excel, use o seguinte formato: =NameOfRange• Para selecionar a célula a partir da planilha atual, clique no botão Referência do Excel próximo à

caixa Nome do Processo.

Parâmetros

Insira valores para os parâmetros do processo, dependendo de como você selecionou o nome doprocesso da lista Processo.

• Se você selecionou um processo da lista Processo, a grade Parâmetros aparecerá com uma lista dosparâmetros para o processo selecionado. É possível inserir valores para cada parâmetrodiretamente na grade ou usar uma referência do Excel que recupera dinamicamente um valor deparâmetro da planilha atual.

• Se você selecionou a opção Obter Informações do Processo da Planilha na lista Processo, deveráusar uma referência do Excel para recuperar os valores de parâmetros da planilha atual. É possívelinserir uma referência a uma única célula, a um intervalo de células ou a um intervalo nomeado.Qualquer referência deve apontar para o número apropriado de células, dependendo do número deparâmetros que o processo está esperando.

Clique no botão Referência do Excel para selecionar diretamente a célula ou o intervalo decélulas da planilha.

Para obter exemplos, consulte a documentação do TM1 for Developers.

Referência do Excel

Cria uma referência do Excel que recupera dinamicamente o nome do processo ou o(s) valor(res) deparâmetros da planilha atual quando o botão Ação for clicado.

Guia PlanilhaUse a guia Planilha para configurar um botão de Ação para navegar para outra planilha do Excel.Consultar

Use um dos seguintes métodos para selecionar uma planilha:

2 IBM Planning Analytics: Referência do TM1

• TM1 Applications - Selecione esta opção se quiser escolher uma planilha a partir da árvore deAplicativos do TM1.

• Arquivos - Selecione esta opção se desejar escolher uma planilha de seu computador.

Navegar

Clique neste botão para selecionar a planilha para a qual você deseja navegar.

• Caso tenha selecionado a opção Aplicativos do TM1, será aberta uma caixa de diálogo na qual épossível selecionar uma planilha a partir da árvore de Aplicativos do TM1.

• Se você selecionou a opção Arquivos, aparecerá a caixa de diálogo Abrir, na qual é possível navegare selecionar um arquivo de seu computador.

Pasta de Trabalho

Contém o caminho e nome da pasta de trabalho do Excel para a qual você deseja navegar. Este valorpode ser inserido de uma das seguintes maneiras:

• Clique no botão Procurar ao lado da opção Consultar para selecionar uma planilha da árvore deAplicativos do TM1 ou a partir dos arquivos no computador.

• Clique no botão Referência do Excel para selecionar uma célula que seja avaliada para um caminhoe nome de pasta de trabalho.

• Insira manualmente um nome e caminho de pasta de trabalho.• Insira manualmente uma referência do Excel que seja avaliada para um caminho e nome de pasta

de trabalho.

O caminho para uma pasta de trabalho na árvore de Aplicativos do TM1 usa o formato:

<FolderName>\<FolderName>\<WorkbookName>

Por exemplo:

Amostra de Planejamento\Entrada de Baixo para Cima\Entrada de Orçamento

O caminho para um arquivo de rede usa o formato:

\\<ComputerName>\<FolderName>\<WorkbookName>

Por exemplo:

\\boston\reports\2007_summary.xls

Para obter detalhes e exemplos, consulte a documentação do IBM Cognos TM1 for Developers.

Planilha

Contém o nome da planilha para a qual você deseja navegar. Este valor pode ser inserido de uma dasseguintes maneiras:

• Clique no botão Navegar para selecionar uma pasta de trabalho e, em seguida, selecione umaplanilha da lista Planilha.

• Insira manualmente um nome de planilha.• Insira manualmente uma referência do Excel que seja avaliada para um nome de planilha.• Clique no botão Referência do Excel para selecionar uma célula que seja avaliada para um nome de

planilha.

Para obter detalhes e exemplos, consulte a documentação do IBM Cognos TM1 for Developers.

Corresponder Elementos do Título

Esta opção corresponde e define automaticamente as dimensões de título entre as planilhas deorigem e de destino quando um usuário clica no botão de Ação para navegar para a planilha dedestino.

Para obter detalhes e exemplos, consulte a documentação do IBM Cognos TM1 for Developers.

Capítulo 1. Windows e Caixas de Diálogo 3

Substituir Planilha Atual

Esta opção determina como a planilha de destino será aberta.

• Se essa opção não for selecionada (padrão), a planilha de destino será aberta em uma nova janelano Excel ou em uma nova guia no TM1 Web.

• Se esta opção for selecionada, a planilha de destino será aberta na mesma janela ou guia,substituindo a planilha de origem.

CUIDADO: Se você ativar esta opção, lembre-se de salvar sua pasta de trabalho antes detestar o novo botão. Suas mudanças podem ser perdidas se você clicar no botão e causar ofechamento da pasta de trabalho atual.

Opções Avançadas

Clique neste botão para abrir a caixa de diálogo Opções Avançadas, na qual é possível mapearmanualmente campos entre as planilhas de origem e de destino para um botão de Ação, que navegade uma planilha para outra.

Para obter detalhes, consulte “Caixa de Diálogo Opções Avançadas” na página 4.

Guia AparênciaUse a guia Aparência para configurar a aparência visual do botão de Ação.Legenda

Define o texto da legenda que é exibido no botão de Ação.Fonte

Clique neste botão para exibir a caixa de diálogo Fonte, na qual é possível definir o estilo e tamanhode fonte para o texto do botão.

Mostrar Imagem de Plano de Fundo

Permite selecionar um arquivo de imagem (formato bmp, gif ou jpg) que será expandido para ajustar-se ao botão de Ação.

Selecione esta opção e, em seguida, clique em Navegar para localizar e selecionar o arquivo deimagem que você deseja usar.

Exibir como Hiperlink

Exibe o botão de Ação como um hyperlink com texto azul, sublinhado, em vez de um botão padrão.

Esta opção não fica disponível quando você seleciona a opção Mostrar Imagem de Plano de Fundo.

VisualizarEsta área mostra uma visualização da legenda do texto, estilo de fonte, cor da fonte e cor do plano defundo para o botão.

Cores

Permite definir as cores do texto e do plano de fundo para o botão de Ação.

Clique na amostra de cor de Texto ou Plano de Fundo para exibir a caixa de diálogo Cor, na qual épossível selecionar uma cor padrão ou definir uma cor customizada.

Esta opção não fica disponível quando você seleciona a opção Exibir como Hyperlink.

Caixa de Diálogo Opções AvançadasUse a caixa de diálogo Opções Avançadas para mapear manualmente campos entre as planilhas deorigem e de destino ao inserir um botão de Ação que navega de uma planilha para outra. Esta ferramentaajuda-o a mapear dimensões, células e valores da planilha de origem para a planilha de destino.

Nota: O mapeamento avançado é aplicado depois que qualquer mapeamento automático tiver sidoexecutado pela opção Corresponder Elementos do Título.

4 IBM Planning Analytics: Referência do TM1

Campo Descrição

Incluir Inclui uma nova linha na grade MapeamentoAvançado.

Excluir Exclui a linha selecionada da grade MapeamentoAvançado.

OK Fecha a caixa de diálogo Opções Avançadas e salvasuas configurações.

Cancelar Fecha a caixa de diálogo Opções Avançadas semsalvar suas configurações.

Para obter exemplos sobre o uso da caixa de diálogo Opções Avançadas, consulte TM1 for Developers noIBM Knowledge Center (https://www.ibm.com/support/knowledgecenter/SSD29G_2.0.0).

Grade Mapeamento AvançadoUse a grade Mapeamento Avançado para definir o mapeamento de campos entre as planilhas de origem ede destino. A grade pode ser usada para especificar como os elementos nas planilhas de origem e dedestino são correspondidos quando a planilha de destino é aberta. Cada linha na grade define umaconfiguração de mapeamento.

Campo Descrição

Tipo de Origem Este campo representa o tipo de objeto para ovalor que você deseja mapear.

Selecione o Tipo de Origem da seguinte forma:

• SUBNM - Indica que você está mapeando de umacélula que contém uma dimensão de título naplanilha de origem.

• DBRW Selecionada - Indica que você estámapeando de uma célula que contém umafórmula DBRW na planilha de origem.

• Valor - Indica que você inserirá um valor desequência ou numérico que será enviado para odestino.

Capítulo 1. Windows e Caixas de Diálogo 5

Campo Descrição

Objeto de Origem Este campo usa um valor dependendo do que estáselecionado no campo Tipo de Origem.

Insira o Objeto de Origem da seguinte forma:

• Se Tipo de Origem for definido como SUBNM,será necessário especificar o nome da dimensãode título existente na planilha de origem.

• Se Tipo de Origem for definido como DBRWSelecionada, será necessário especificar o nomede uma dimensão de título da linha ou colunaexistente na planilha de origem.

• Se Tipo de Origem for definido como Valor, seránecessário inserir um valor de sequência ounumérico que será enviado para a planilha dedestino.

Também é possível recuperar estes valores daplanilha de origem, usando o símbolo = para criaruma referência do Excel.

Tipo de Destino Este campo é o tipo de célula na planilha dedestino em que o valor do campo Objeto de Origemserá inserido.

Selecione o Tipo de Destino da seguinte forma:

• SUBNM - Indica que o destino é uma dimensãode título na planilha de destino.

• Intervalo Nomeado - Indica que o destino é umintervalo nomeado na planilha de destino.

• Intervalo - Indica que o local de destino é umacélula na planilha de destino.

CUIDADO: Se você definir um Tipo deDestino como um Intervalo Nomeado ouIntervalo, os dados ou fórmulaspreexistentes na célula de destino serãosobrescritos quando você navegar com obotão de Ação. Caso a célula de destinocontenha uma função DBRW do TM1, afunção será perdida e a célula não poderáse conectar, ler ou fazer gravações noservidor.

6 IBM Planning Analytics: Referência do TM1

Campo Descrição

Objeto de Destino Este campo representa o local na planilha dedestino em que o valor do Objeto de Origem seráinserido.

Insira o Objeto de Destino da seguinte forma,dependendo de sua seleção para Tipo de Destino:

• Se Tipo de Destino for definido como SUBNM,será necessário especificar o nome da dimensãode título na planilha de destino.

• Se Tipo de Destino for definido como IntervaloNomeado, será necessário especificar o nome dointervalo na planilha de destino.

• Se Tipo de Destino for definido como Intervalo,será necessário especificar o local da célula naplanilha de destino.

Também é possível usar uma referência do Excelpara recuperar o valor para o campo Objeto deDestino.

Para obter um exemplo detalhado, consulte adocumentação do IBM CognosTM1 for Developers.

Subconjunto Insira um valor para o campo Subconjunto quandoo campo Tipo de Destino for definido comoSUBNM.

Alias Insira um valor para o campo Alias quando ocampo Tipo de Destino for definido como SUBNM.

Editor de AtributosUse o Editor de Atributos para criar e editar atributos para cubos, dimensões, elementos e replicações.

Observe que todos os elementos incluem um atributo de Formato, que define como os valores deelementos são exibidos no Cube Viewer. O valor de atributo de Formato padrão é Sem Estilo.

Menu Arquivo

Item de Menu Descrição

Fechar Fecha o Editor de Atributos.

Menu Editar

Capítulo 1. Windows e Caixas de Diálogo 7

Item de Menu Descrição

Desfazer Célula Desfaz a última ação da célula. Esta opção éaplicável apenas a células individuais. Não épossível desfazer ações aplicadas a um intervalode células.

Recortar Recorta o conteúdo de células selecionadas para aÁrea de Transferência.

Copiar Copia o conteúdo de células selecionadas para aÁrea de Transferência.

Colar Cola o conteúdo da Área de Transferência nascélulas selecionadas.

Incluir Novo Atributo Abre a caixa de diálogo Novo Atributo, a partir daqual é possível criar um novo atributo para oselementos na dimensão.

Excluir Atributo Selecionado Exclui um atributo selecionado. Os atributosdevem ser excluídos individualmente; não épossível excluir vários atributos simultaneamente.

Limpar Limpa o conteúdo de células selecionadas.

Editar Formato do Elemento Abre a caixa de diálogo Formato Numérico, a partirda qual é possível designar valores de atributos deFormato.

Opções de FormatoA opção de Formato fica disponível apenas quando você seleciona células na interseção da colunaFormato e elementos de linha. Clique no botão Formato para exibir a caixa de diálogo Formato Numérico.

Selecione uma opção da caixa de listagem Categoria para especificar um formato de exibição para ascélulas selecionadas.

Os seguintes formatos numéricos estão disponíveis:

Categoria de Formato Descrição

Geral Este formato exibe números sem vírgulasseparando dígitos à esquerda do ponto decimal. Osvalores negativos são prefixados com um sinal demenos (-).

Use a opção Precisão para especificar o número dedígitos que seguem o ponto decimal. Observe queos valores derivados de Regras retornam númerosinteiros apenas quando definidos como formatoGeral.

8 IBM Planning Analytics: Referência do TM1

Categoria de Formato Descrição

Ajustado Este formato exibe números sem vírgulasseparando dígitos à esquerda do ponto decimal. Osvalores negativos são prefixados com um sinal demenos (-); os usuários têm a opção de usarparênteses para negativos, se preferirem.

Use a opção Precisão para especificar o número dedígitos que seguem o ponto decimal.

Moeda Este formato exibe números com o símbolomonetário especificado em seu WindowsRegionalSettingsProperties, e utiliza vírgulas paraseparar dígitos da terceira casa da esquerda doponto de decimal. Os valores negativos sãoprefixados com um sinal de menos (-).

Use a opção Precisão para especificar o número dedígitos que seguem o ponto decimal.

Data Exibe uma lista de formatos de data predefinidos.

Hora Exibe uma lista de formatos de horáriopredefinidos.

Porcentagem Este formato multiplica números por 100 e exibe oseguinte sinal de porcentagem (%). Os dígitos àesquerda do ponto decimal não usam vírgulas, e osvalores negativos são prefixados com um sinal demenos (-).

Use a opção Precisão para especificar o número dedígitos que seguem o ponto decimal.

Científico Este formato exibe números em anotaçãocientífica. Os valores negativos são prefixados comum sinal de menos (-).

Use a opção Precisão para especificar o número dedígitos que seguem o ponto decimal.

Customizado É possível definir uma expressão de formatocustomizado, conforme necessário.

Precisão Esta opção determina o número de casas decimaisa serem exibidas para um formato selecionado. Seum valor tiver mais casas decimais do que aprecisão especificada, ele será arredondadoapenas para fins de exibição; o valor inteiro ficaarmazenado no banco de dados do TM1.

Janela de Log de AuditoriaUse a janela Log de auditoria para consultar e visualizar registros contidos no log de auditoria do TM1.

Capítulo 1. Windows e Caixas de Diálogo 9

A janela de Log de Auditoria contém dois painéis principais; o painel Consulta e o painel Resultados. Useestes painéis para procurar no log de auditoria e visualizar os registros recuperados por sua procura.

Painel ConsultaUse o painel Consulta para construir consultas que fazem procuras no log de auditoria do TM1.

A barra de ferramentas do painel Consulta contém um ícone Executar consulta que permite consultaro log de auditoria após a configuração das opções de consulta.

As opções de consulta estão organizadas nos seguintes grupos:

• Data e Hora• Proprietário do Evento• Tipo de Evento

Opções Data e Hora

As opções Data e Hora incluem definir o período de tempo que você deseja consultar.

Opção Descrição

Período de Tempo Contém uma lista de períodos de tempopredefinidos para a consulta.

Selecione um período de tempo predefinido ouselecione Período de Tempo Customizado paraativar as opções de horário de Início eEncerramento.

Horário de Início A data/hora de início para a consulta.

Esta opção é ativada apenas quando vocêseleciona Período de Tempo Customizado para aopção Período de Tempo.

O TM1 faz consultas em todos os registrosgravados no log de auditoria nesta data/hora ouapós ela.

Clique em para abrir a ferramenta calendário,na qual é possível selecionar uma data e hora.

Horário de Encerramento A data e hora de encerramento para a consulta.

Esta opção é ativada apenas quando vocêseleciona Período de Tempo Customizado para aopção Período de Tempo.

O TM1 faz consultas em todos os registros deauditoria até o horário de encerramentoespecificado.

Clique no ícone Calendário para abrir aferramenta do calendário em que é possívelselecionar uma data e hora.

O horário de encerramento padrão é a data e horaatuais.

10 IBM Planning Analytics: Referência do TM1

Opções de Proprietário do Evento

As opções de Proprietário do Evento respondem à pergunta "Quem causou este evento". O proprietáriodo evento pode ser um usuário real ou uma tarefa de organização de processos planejada do TM1.

As opções de Proprietário do Evento incluem os seguintes parâmetros:

Opção Descrição

Tudo Configura a consulta para procurar eventos deauditoria causados por qualquer usuário ou tarefade organização de processos planejada do TM1.

Clientes Configura a consulta para procurar eventos deauditoria causados apenas por usuários do TM1.

Para procurar eventos causados por um usuárioespecífico do TM1, clique no botão Selecionar

cliente . É possível selecionar um únicocliente ou vários clientes.

O padrão é todos os clientes.

Tarefa de Organização de Processos Planejada Define a consulta para procurar eventos deauditoria causados apenas por tarefas deorganização de processos planejadas.

Para procurar eventos causados por uma tarefa deorganização de processos planejada específica,clique no botão Selecionar tarefa de organização

de processos planejada . É possívelselecionar uma única tarefa de organização deprocessos planejada ou várias tarefas deorganização de processos planejadas.

O padrão é todas as tarefas de organização deprocessos planejadas.

Opções de Tipo de EventoAs opções de Tipo de Evento permitem selecionar o tipo de objeto ou evento que você deseja procurar.Por exemplo, é possível usar estas opções de procura para "localizar tentativas de login malsucedidas" ou"localizar eventos nos quais uma dimensão foi excluída".

Opção Descrição

Tudo Define a consulta para procurar dois tipos deeventos de auditoria; eventos de todo o sistema erelacionados a objetos.

Em todo o sistema Define a consulta para procurar apenas eventos deauditoria de todo o sistema.

Para procurar um evento de todo o sistemaespecífico, selecione o evento da lista.

A configuração padrão procura todos os eventos detodo o sistema.

Capítulo 1. Windows e Caixas de Diálogo 11

Opção Descrição

Objeto Define a consulta para procurar apenas eventos deauditoria de tipo de objeto.

Para procurar um evento de objeto específico, useas opções conforme a seguir:

• Tipo de objeto - limita a consulta a apenas umtipo específico de objeto do TM1. Por exemplo,eventos relacionados apenas a dimensões.

• Nome do Objeto - Permite selecionar um nomedo objeto específico.

Clique em para exibir uma caixa de diálogona qual é possível selecionar objetos por nome.

Nota: Quando você define a opção Tipo deObjeto para Elemento, o botão Seleção de Nomedo Objeto é desativado, pois a lista pode sermuito grande para ser exibida. Para procurareventos relacionados a um elemento específico,você deve inserir manualmente um nome deelemento usando o seguinte formato:DimensionName:ElementName. Por exemplo:region:italy

• Tipo de Evento - Limita a consulta a apenas umtipo específico de evento de objetos. Aconfiguração padrão procura todos os eventos detipo de objeto.

Painel ResultadosUse o painel Resultados para visualizar e navegar nos registros recuperados por sua procura.

Barra de Ferramentas do Painel ResultadosA barra de ferramentas Resultados possui os seguintes botões:

Ação Botão Descrição

Copiar Copia o valor na célulaselecionada atualmente para aárea de transferência doWindows.

Localizar Abre a caixa de diálogo Localizar,na qual é possível procurar textonos registros de eventos.

12 IBM Planning Analytics: Referência do TM1

Ação Botão Descrição

Exportar Abre a caixa de diálogo Salvarcomo, na qual é possível salvaros registros de eventos em umarquivo em um dos seguintesformatos:

• XML• Delimitado por vírgula• Delimitado por guia

Grade ResultadosO painel Resultados inclui uma grade que exibe os registros de log de auditoria recuperados pelaconsulta. Os registros recuperados estão organizados nas seguintes colunas:

Coluna Descrição

Data Data e hora do evento.

Usuário O cliente (usuário) ou a tarefa de organização deprocessos planejada do TM1 que foi responsávelpor causar o evento.

Tipo/Descrição do Evento Breve descrição do evento.

Tipo de Objeto Tipo de objeto do TM1 associado ao evento.

Nome do Objeto Nome do objeto do TM1 associado ao evento.

Detalhes Exibe um ícone para indicar que existeminformações detalhadas para o evento específico.

Se um evento tiver detalhes, é possível visualizaros detalhes, clicando no ícone Detalhes paraesse registro.

Os registros podem ser classificados na grade em ordem crescente ou decrescente para qualquer coluna,clicando no título da coluna.

Janela Detalhes do Log de AuditoriaA janela Detalhes do Log de Auditoria exibe os subeventos para um evento de log de auditoria que foiexibido nos resultados da consulta da janela Log de Auditoria principal.

Barra de Ferramentas DetalhesA barra de ferramentas Detalhes possui os seguintes botões:

Botão Descrição

Copiar Copia o valor na célula selecionada atualmentepara a área de transferência do Windows.

Capítulo 1. Windows e Caixas de Diálogo 13

Botão Descrição

Localizar Abre a caixa de diálogo Localizar, na qual épossível procurar texto nos registros de eventos.

Exportar Abre a caixa de diálogo Salvar como, na qual épossível salvar os registros de eventos em umarquivo em um dos seguintes formatos:

• XML• separado por vírgula• separado por guia

Grade DetalhesA grade Detalhes exibe os registros de detalhes de subeventos que pertencem ao evento pai.

Os registros de detalhes estão organizados nas seguintes colunas:

Coluna Descrição

Data Data e hora do evento.

Usuário O cliente (usuário) ou a tarefa de organização deprocessos planejada do TM1 que foi responsávelpor causar o evento.

Tipo/Descrição do Evento Breve descrição do evento.

Tipo de Objeto Tipo de objeto do TM1 associado ao evento.

Nome do Objeto Nome do objeto do TM1 associado ao evento.

Os registros podem ser classificados na grade em ordem crescente ou decrescente para qualquer coluna,clicando no título da coluna.

Assistente de Configuração de Tarefa de Organização de ProcessosUse o Assistente de Configuração de Tarefa de Organização de Processos para planejar uma replicaçãoou processo para sincronização ou execução em um intervalo regular.

O Assistente consiste em duas telas:

• Tela 1 - Selecione as replicações e os processos a serem incluídos na tarefa de organização deprocessos.

• Tela 2 - Especifique o horário de início para a execução inicial da tarefa de organização de processos eo intervalo subsequente no qual a tarefa de organização de processos deve ser executada.

Tela 1 (Etapa 1)

14 IBM Planning Analytics: Referência do TM1

Campo Descrição

Lista Disponível Lista todas as replicações e processos disponíveispara programação como tarefas de organização deprocessos.

Lista Selecionado Lista as replicações ou processos selecionadospara inclusão na tarefa de organização deprocessos atual.

Incluir Clique neste botão para mover replicações ouprocessos selecionados da lista Disponível para alista Selecionado

Incluir todos Clique neste botão para mover todas asreplicações ou processos da lista Disponível para alista Selecionado.

Remover Clique neste botão para mover replicações ouprocessos selecionados da lista Selecionado para alista Disponível.

Remover todos Clique neste botão para mover todas asreplicações ou processos da lista Selecionado paraa lista Disponível.

Especificar Valores para Parâmetros Clique para abrir a caixa de diálogo Valores deParâmetros, a partir da qual é possível especificarvalores para quaisquer parâmetros associados aoprocesso selecionado.

Tela 2 (Etapa 2)

Campo Descrição

Data e Hora de Início da Tarefa de Organização deProcessos

Selecione uma data de início no calendário eespecifique um horário de início no campo deTempo.

Frequência de Execução da Tarefa de Organizaçãode Processos

Preencha os campos apropriados para estabelecero intervalo no qual a tarefa de organização deprocessos deve ser executada.

A Tarefa de Organização de Processos Está Ativa Preencha esta caixa para ativar a tarefa deorganização de processos para execução nohorário de início e intervalo especificados. Limpeesta caixa para ativar a tarefa de organização deprocessos posteriormente.

Janela Clientes/GruposA janela Clientes/Grupos permite criar e modificar clientes e grupos de usuários em um servidor.

Capítulo 1. Windows e Caixas de Diálogo 15

Grade Clientes/Grupos

A grade Clientes/Grupos exibe nomes de clientes como títulos da linha e grupos de usuários como títulosda coluna. Um 'X' na interseção de um nome de cliente e um grupo de usuários indica o grupo ao qual ousuário pertence. Os usuários podem pertencer a vários grupos.

A grade também inclui várias colunas que exibem propriedades para clientes no servidor.

• A célula na interseção de um nome de cliente e a coluna Senha contém a senha para o cliente.• A célula na interseção de um nome de cliente e a coluna Dias para Expiração contém o número de dias

durante os quais a senha é válida para o cliente. Após decorrer este número de dias, o cliente nãopoderá mais efetuar login no servidor com a senha designada. Um cliente cuja senha expirará em brevecomeça a receber uma notificação da expiração cinco dias antes da data de expiração.

• A célula na interseção do nome de cliente e a coluna Status indica se o cliente está ativo no servidor.• A célula na interseção do nome de cliente e a coluna Máximo de Conexões indica o número máximo de

conexões que podem ser estabelecidas no servidor com o nome de cliente e senha associados.

Menu Segurança

Item de Menu Descrição

Fechar Fecha a caixa de diálogo Clientes/Grupos.

Menu Clientes

Item de Menu Descrição

Incluir Novo Cliente Abre a caixa de diálogo Criando Novo Cliente, apartir da qual é possível criar um novo cliente noservidor.

Excluir Cliente Exclui do servidor o cliente selecionado nomomento.

Desconectar Cliente Desconecta do servidor o cliente selecionado nomomento.

Definir Senha Define a senha para o cliente selecionado nomomento.

Limpar Senha Limpa a senha para o cliente selecionado nomomento.

Menu Grupos

Item de Menu Descrição

Incluir Novo Grupo Abre a caixa de diálogo Criando Novo Grupo, apartir da qual é possível criar um novo grupo deusuários no servidor.

16 IBM Planning Analytics: Referência do TM1

Item de Menu Descrição

Excluir Grupo Exclui do servidor o grupo de usuários selecionadono momento.

Grade Clientes/GruposÉ possível inserir dados para clientes diretamente na grade Clientes/Grupos.

A grade inclui várias colunas, conforme descrito na tabela a seguir.

Coluna Descrição

Nome de Usuário Exibe os nomes de usuários de todos os clientes noservidor.

Senha Identifica se uma senha está definida para umdeterminado cliente.

É possível clicar em uma célula na interseção dacoluna Senha e uma linha do cliente, em seguida,digitar uma senha para designar uma senha aocliente.

Após a inserção de uma senha, o TM1 solicita quea senha seja inserida novamente, paraconfirmação.

Datas de Expiração Indica o número de dias em que a senha de umdeterminado cliente é válida.

Para designar expiração para a senha de umcliente, clique na célula na interseção da colunaDias para Expiração e a linha do cliente, emseguida, digite um valor de expiração.

Conexões Máximas Identifica o número máximo de conexões quepodem ser feitas no servidor por um determinadocliente.

Para designar um número máximo de conexõespara um cliente, clique na célula na interseção dacoluna Máximo de Conexões e a linha do cliente,em seguida, digite o número máximo de conexõespara o cliente.

Status Indica o status da conexão atual de umdeterminado cliente.

Grupos de Usuários Há uma coluna para cada grupo de usuários noservidor.

Para designar um cliente a um grupo de usuários,preencha a caixa de seleção na interseção dacoluna do grupo de usuários e o nome do cliente.

Os clientes podem pertencer a vários grupos deusuários.

Capítulo 1. Windows e Caixas de Diálogo 17

Caixa de Diálogo Mensagens para os ClientesA caixa de diálogo Centro de Sistema de Mensagens para o Cliente permite gerenciar as conexões docliente com um servidor. Também é possível usar esta caixa de diálogo para encerrar remotamente umservidor. Você deve ser membro do grupo ADMIN para um servidor para acessar esta caixa de diálogo.

Selecione um servidor na área de janela esquerda do Server Explorer, em seguida, escolha Servidor,Gerenciador de Servidores para abrir a caixa de diálogo Mensagens para os Clientes.

Campo Descrição

Encerrar Servidor Selecione esta opção para encerrar o servidor e,então, especifique um intervalo de Minutos.

Desconectar Clientes Selecione esta opção para desconectar clientes doservidor e, então, especifique um intervalo deMinutos.

Você deve clicar em Selecionar Clientes para criarou selecionar um subconjunto de clientes a seremdesconectados.

Transmitir Mensagem para Clientes Selecionados Selecione esta opção para transmitir umamensagem de texto a clientes conectados aoservidor.

Insira a mensagem na caixa de texto, em seguida,clique em Selecionar Clientes para criar ouselecionar um subconjunto de clientes parareceber a mensagem.

Caixa de Diálogo Criar uma DimensãoInsira um nome para a dimensão que você deseja criar no campo, na parte superior da caixa de diálogo,em seguida, clique em OK.

Para criar uma dimensão em seu servidor local, insira apenas o nome da dimensão.

Para criar uma dimensão em um servidor remoto, prefixe o nome da dimensão com o nome do servidor edois pontos. Por exemplo, insira Sales:Product para criar a dimensão Produto no servidor Vendas.

Caixa de Diálogo Criar Objeto de Replicação do ServidorUse a caixa de diálogo Criar Objeto de Replicação do Servidor para estabelecer uma nova conexão dereplicação ou para modificar uma conexão existente.

Campo Descrição

Para Servidor Selecione um servidor de origem da lista. A listainclui os nomes de todos os servidores disponíveisno momento em sua rede.

Como Usuário Insira seu nome de usuário no servidor de origemselecionado.

18 IBM Planning Analytics: Referência do TM1

Campo Descrição

Com Senha Insira sua senha para o servidor de origemselecionado.

Com Namespace Se o objeto utiliza segurança do CAM Passport,insira o ID de namespace do IBM Cognos. Nãoinsira, aqui, o nome descritivo.

Usar Login Integrado Marque esta caixa para usar a autenticação deLogin integrado, em vez da segurança padrão doTM1.

Caixa de Diálogo Criando CuboUse as seguintes opções na caixa de diálogo Criando Cubo para criar um novo cubo a partir de dimensõesdefinidas anteriormente.

Campo Descrição

Nome do Cubo Digite o nome para o cubo que está sendo criadoneste campo.

Dimensões Disponíveis Uma lista de todas as dimensões disponíveis noservidor no qual o cubo está sendo criado.

Dimensões no Novo Cubo A lista de dimensões no cubo que está sendocriado.

Incluir Clique neste botão para mover as dimensõesselecionadas da lista Dimensões Disponíveis para alista Dimensões no Novo Cubo

Remover Clique neste botão para mover as dimensõesselecionadas da lista Dimensões no Novo Cubopara a lista Dimensões Disponíveis.

Mover para Cima Clique neste botão para mover as dimensõesselecionadas para cima por meio da listaDimensões no Novo Cubo. Cada clique do botãomover as dimensões selecionadas uma posiçãopara cima.

Mover para Baixo Clique neste botão para mover as dimensõesselecionadas para baixo por meio da listaDimensões no Novo Cubo. Cada clique do botãomover as dimensões selecionadas uma posiçãopara baixo.

Cancelar Clique para cancelar a criação do cubo e sair dacaixa de diálogo Criando Cubo.

Capítulo 1. Windows e Caixas de Diálogo 19

Campo Descrição

Reconfigurar Clique para reconfigurar a lista DimensõesDisponíveis e limpar a lista Dimensões no NovoCubo.

Atualizar Clique para atualizar a lista Dimensões Disponíveis.Esta opção sonda o servidor em busca de novasdimensões e inclui as novas dimensões na listaDimensões Disponíveis.

Propriedades Clique neste botão para designar propriedades docubo.

É possível designar propriedades que definem umadimensão das medidas, uma dimensão de tempo estatus de carregamento sob demanda para o cubo.

OK Clique para aceitar a configuração da caixa dediálogo e criar o cubo.

Caixa de Diálogo do Cube OptimizerO TM1 inclui um recurso que permite otimizar a ordem das dimensões em um cubo, consumindo menosmemória e aumentando o desempenho.

Quando você não está familiarizado com seus dados, é possível que você especifique uma ordem dedimensões durante a criação do cubo que resulte em um desempenho menor do que o ideal. É possívelque a distribuição de dados em um cubo mude ao longo do tempo, o que torna ineficiente a ordem dedimensões especificada durante a criação do cubo.

Quando a ordem das dimensões em um cubo é otimizada, o TM1 não altera a ordem real das dimensõesna estrutura do cubo. O TM1 altera a maneira em que as dimensões são ordenadas internamente noservidor, mas, como a estrutura do cubo não é alterada, as regras, funções e aplicativos que fazemreferência ao cubo permanecem válidas.

Conforme você altera a ordem de dimensões, pode visualizar instantaneamente um relatório que detalhao impacto de suas mudanças no consumo de memória do cubo.

Pelas seguintes razões, você deve otimizar a ordem de dimensões em um cubo apenas em um ambientede desenvolvimento, enquanto estiver tentando determinar a configuração ideal do cubo:

• São necessários recursos expressivos de memória para que o servidor reconfigure a ordem dasdimensões em um cubo. Durante o processo de reordenação, a RAM temporária no servidor éaumentada por um fator de dois para o cubo que está sendo reordenado. Por exemplo, um cubo de 50MB requer 100 MB de RAM para reconfiguração.

• A reordenação coloca um bloqueio de leitura no servidor, bloqueando todos os pedidos do usuárioenquanto a reordenação é executada.

Nota: Você deve ser um membro do grupo ADMIN para otimizar a ordem das dimensões nos cubos. Aopção de otimização está disponível apenas para cubos em servidores remotos; não é possível otimizar aordem das dimensões em cubos em um servidor local. Além disso, ao otimizar a ordem de dimensões emum cubo, você não deve mover as dimensões da sequência da última posição, nem mover as dimensõesda sequência para a última posição.

Procedimento

1. Na área de janela em Árvore do Server Explorer, selecione o cubo que você deseja otimizar.

20 IBM Planning Analytics: Referência do TM1

2. Clique em Cubo, Reordenar Dimensões.

A caixa de diálogo do Cube Optimizer se abre.3. Selecione uma dimensão na caixa de listagem Nova Ordem de Dimensões.4. Clique nas setas acima ou abaixo para alterar a ordem da dimensão no cubo.5. Clique em Testar.

Observe o valor próximo ao rótulo Mudança em Porcentagem. Se este valor for negativo, a nova ordemde dimensões consumirá menos memória e, portanto, será mais eficiente.

6. Repita as etapas 3 a 5 até obter a ordenação de dimensões mais eficiente.7. Clique em OK.

Caixa de Diálogo Propriedades do CuboUse a caixa de diálogo Propriedades do Cubo para definir propriedades para cubos individuais.

Campo Descrição

Dimensão das Medidas Selecione uma dimensão das medidas da lista.

Dimensão de Tempo Selecione uma dimensão de tempo da lista.

Carregar sob Demanda Preencha a caixa para carregar o cubo na memóriado servidor apenas quando um cliente solicitardados do cubo. Limpe esta caixa para carregar ocubo automaticamente quando o servidor foriniciado.

Cube Viewer

Dimensões de Título

As dimensões de título aparecem diretamente abaixo da Barra de Ferramentas na parte superior dajanela do Cube Viewer. Cada dimensão é exibida em uma caixa de listagem.

Dimensões da Linha

As dimensões da linha aparecem na parte superior do eixo da linha do Cube Viewer. Os elementos dedimensão atuais aparecem como títulos da linha no Cube Viewer.

Dimensões da Coluna

As dimensões da coluna aparecem à esquerda do eixo da coluna do Cube Viewer. Os elementos dedimensão atuais aparecem como títulos da coluna no Cube Viewer.

Menu ArquivoAs opções a seguir estão disponíveis no Menu Arquivo no Cube Viewer.

Opção Descrição

Abrir Abre a caixa de diálogo Abrir visualização do TM1,a partir da qual é possível abrir outrasvisualizações associadas ao cubo atual.

Capítulo 1. Windows e Caixas de Diálogo 21

Opção Descrição

Recarregar Recarrega a definição de visualização atual.

Calcular Calcula a visualização atual.

Salvar Salva a configuração de visualização atual.

Salvar como Salva a configuração de visualização atual com umnovo nome.

Excluir Visualizações Abre a caixa de diálogo Excluir VisualizaçõesNomeadas, a partir da qual é possível excluirvisualizações nomeadas.

Fatiar Exporta a visualização atual para uma planilha doExcel. A planilha Excel é preenchida com fórmulasque recuperam e gravam valores no servidor daqual a visualização se origina.

Formulário Ativo Ativa a opção Formulário Ativo para permitir incluiruma conexão de Formulário Ativo na célula atualda planilha.

Captura Instantânea Exporta a visualização atual para uma planilha doExcel como valores simples. A planilha nãomantém uma conexão com o servidor a partir doqual a visualização se origina.

Fechar Fecha a janela do Cube Viewer.

Menu EditarAs opções a seguir estão disponíveis no Menu Editar no Cube Viewer.

Opção Descrição

TransAction Desfaz a última ação da célula. Salvar ou Fecharencerra a coleção de ações que podem serdesfeitas ou refeitas.

Refazer restaura a última ação da célula.

Recortar Recorta o conteúdo de células selecionadas para aÁrea de Transferência.

Copiar Copia o conteúdo de células selecionadas,conforme formatadas no momento, para a Área deTransferência.

Copiar Valor Não Formatado Copia o conteúdo não formatado de célulasselecionadas para a Área de Transferência.

Colar Cola o conteúdo da Área de Transferência nascélulas selecionadas.

22 IBM Planning Analytics: Referência do TM1

Opção Descrição

Excluir Exclui os valores de células selecionados.

Editar Atributos do Cubo Abre a janela do Editor de Atributos, a partir daqual é possível designar e editar atributos paratodos os cubos no servidor atual.

Menu VisualizarAs opções a seguir estão disponíveis no Menu Visualizar no Cube Viewer.

Opção Descrição

Barra de Ferramentas Oculta ou exibe a Barra de Ferramentas na partesuperior do Cube Viewer. Um visto indica que aBarra de Ferramentas é exibida.

Barra de Status Oculta ou exibe a Barra de Status na parte inferiordo Cube Viewer. Um visto indica que a Barra deStatus é exibida.

Da Direita para a Esquerda Esta alternância altera a posição de dimensões dacoluna no Cube Viewer.

Uma seta apontando para a direita indica que ascolunas são organizadas da direita para aesquerda. Uma seta apontando para a esquerdasignifica que as colunas são organizadas daesquerda para a direita.

Menu de OpçõesAs opções a seguir estão disponíveis no Menu de Opções no Cube Viewer

Opção Descrição

Suprimir Zeros Esta opção suprime ou exibe todas as linhas ecolunas contendo apenas valores zero navisualização do cubo. Um visto indica que as linhase colunas contendo apenas zeros são suprimidasna visualização atual.

Suprimir Zeros em Linhas Esta opção suprime ou exibe todas as linhascontendo apenas valores zero na visualização docubo. Um visto indica que as linhas contendoapenas zeros são suprimidas na visualização atual.

Suprimir Zeros em Colunas Esta opção suprime ou exibe todas as colunascontendo apenas valores zero na visualização docubo. Um visto indica que as colunas contendoapenas zeros são suprimidas na visualização atual.

Capítulo 1. Windows e Caixas de Diálogo 23

Opção Descrição

Recalcular Automaticamente Esta opção ativa ou desativa o recálculoautomático durante a reconfiguração davisualização. Um visto indica que a visualização éautomaticamente recalculada sempre que aconfiguração de visualização é alterada.

Formatar Abre a caixa de diálogo Formato Numérico, a partirda qual é possível definir o formato numérico paravalores na visualização atual. Observe que oformato selecionado é aplicável apenas aosvalores para os quais não existe nenhum atributode Formato especificado.

Largura da Coluna Abre a caixa de diálogo Largura da Coluna, quepermite definir uma largura mínima e uma máximapara colunas no Cube Viewer.

Fatiar para Nova Pasta de Trabalho Esta opção determina como as fatias são criadas.

Um visto indica que as fatias são inseridas em umanova pasta de trabalho quando você escolheArquivo, Fatia.

Se esta opção não estiver ativada, as fatias serãoinseridas em uma nova planilha da pasta detrabalho atual.

Caixa de Diálogo Excluir Subconjuntos NomeadosEsta caixa de diálogo exibe os subconjuntos associados à dimensão atual. Para excluir um subconjunto,selecione-o e clique em OK.

Para selecionar vários subconjuntos adjacentes, clique e arraste nos subconjuntos. Para selecionar váriossubconjuntos não adjacentes, pressione CTRL-clique em cada subconjunto.

Caixa de Diálogo Excluir Visualizações NomeadasEsta caixa de diálogo exibe as visualizações associadas ao cubo atual. Para excluir uma visualização,selecione-a e clique em OK.

Para selecionar várias visualizações adjacentes, clique e arraste nas visualizações. Para selecionar váriasvisualizações não adjacentes, pressione CTRL-clique em cada visualização.

Editor de Dimensão

Área de Janela Elementos

Exibe elementos da dimensão que está sendo visualizada.

24 IBM Planning Analytics: Referência do TM1

Área de Janela Propriedades

Quando você seleciona um elemento consolidado na área de janela Elementos, a área de janelaPropriedades exibe as propriedades dos filhos imediatos do elemento consolidado.

Quando você seleciona um elemento folha, a área de janela Propriedades exibe as propriedades doelemento folha.

Nota: Ao visualizar um conjunto de dimensões excepcionalmente grande no Editor de Dimensão com aárea de janela Propriedades ativada, você talvez tenha problemas de desempenho. Isso pode acontecerquando uma consolidação é selecionada na área de janela Elementos e o TM1 precisa exibir a lista inteirade propriedades e elementos relacionados na área de janela Propriedades.

Se estiver trabalhando com conjuntos de dimensões grandes, poderá ser necessário desativar a área dejanela Propriedades. Para desativar a área de janela Propriedades, clique na opção Janela Propriedadesno Menu Visualizar para remover o visto próximo à opção.

Menu Dimensão

Item de Menu Descrição

Salvar Salva a estrutura da dimensão atual.

Salvar como Salva a estrutura da dimensão atual com um novonome.

Fechar Fecha o Editor de Dimensão.

Menu Editar

Item de Menu Descrição

Recortar Recorta os elementos selecionados para a Área deTransferência.

Copiar Copia os elementos selecionados para a Área deTransferência.

Colar Cola o conteúdo da Área de Transferência comoum novo elemento.

• Quando nenhum elemento estiver selecionadono Editor de Dimensão, esta opção inserirá umnovo elemento acima do primeiro elementoexibido na área de janela Elementos.

• Quando um elemento estiver selecionado naárea de janela Elementos, esta opção exibirá umsubmenu com as opções Colar Acima, Colarcomo Filho e Colar Abaixo.

Colar Acima Cola o conteúdo da Área de Transferência acimade um elemento selecionado.

Colar Abaixo Cola o conteúdo da Área de Transferência abaixode um elemento selecionado.

Capítulo 1. Windows e Caixas de Diálogo 25

Item de Menu Descrição

Colar como Filho Cola o conteúdo da Área de Transferência comoum filho de um elemento selecionado.

Inserir Filho Abre a caixa de diálogo Inserir Elemento deDimensão, a partir da qual é possível inserir umfilho ou filhos de um elemento selecionado.

Inserir Elemento Abre a caixa de diálogo Inserir Elemento deDimensão, a partir da qual é possível inserirelementos folha (simples) na dimensão.

Selecionar Tudo Seleciona todos os elementos na área de janelaElementos.

Filtrar por, Nível Abre a caixa de diálogo Filtrar por Nível, a partir daqual é possível selecionar elementos por nível dehierarquia.

Esta opção afeta apenas a exibição de elementos;ela não afeta a estrutura da dimensão. Quandovocê usar esta opção, a área de janela Elementosexibirá apenas os elementos do nível especificado.

Filtrar por, Atributo Abre a caixa de diálogo Filtrar por Atributo, a partirda qual é possível selecionar elementos por valorde atributo.

Esta opção afeta apenas a exibição de elementos;ela não afeta a estrutura da dimensão. Quandovocê usar esta opção, a área de janela Elementosexibirá apenas os elementos com o valor deatributo especificado.

Filtrar por, Curinga Permite selecionar elementos que correspondem auma expressão de procura definida pelo usuário.

Esta opção afeta apenas a exibição de elementos;ela não afeta a estrutura da dimensão. Quandovocê usar esta opção, a área de janela Elementosexibirá apenas os elementos correspondentes àexpressão de procura especificada.

Selecionar Alias Abre a caixa de diálogo Aliases do TM1, a partir daqual é possível selecionar um alias a ser usadopara exibição no Editor de dimensão.

Classificar, Crescente Classifica todos os elementos na área de janelaElementos em ordem alfabética crescente.

Esta opção afeta apenas a exibição de elementos;ela não afeta a estrutura da dimensão.

26 IBM Planning Analytics: Referência do TM1

Item de Menu Descrição

Classificar, Decrescente Classifica todos os elementos na área de janelaElementos em ordem alfabética decrescente.

Esta opção afeta apenas a exibição de elementos;ela não afeta a estrutura da dimensão.

Classificar, Hierarquia Classifica todos os elementos na área de janelaElementos em ordem hierárquica, portanto, épossível ver o relacionamento pai/filho deelementos.

Esta opção afeta apenas a exibição de elementos;ela não afeta a estrutura da dimensão.

Classificar, Índice Crescente Classifica todos os elementos na área de janelaElementos em ordem crescente, de acordo com ovalor de índice de elemento.

Esta opção afeta apenas a exibição de elementos;ela não afeta a estrutura da dimensão.

Classificar, Índice Decrescente Classifica todos os elementos na área de janelaElementos em ordem decrescente, de acordo como valor de índice de elemento.

Esta opção afeta apenas a exibição de elementos;ela não afeta a estrutura da dimensão.

Manter Altera a área de janela Elementos para que apenasos elementos selecionados no momento sejamexibidos.

Esta opção afeta apenas a exibição de elementos;ela não afeta a estrutura da dimensão.

Ocultar Altera a área de janela Elementos para que oselementos selecionados no momento fiquemocultos.

Esta opção afeta apenas a exibição de elementos;ela não afeta a estrutura da dimensão.

Excluir Elemento Exclui todas as instâncias de um elementoselecionado da dimensão.

Excluir da Consolidação Exclui a instância de um elemento selecionado daconsolidação atual.

Editar Formatos do Elemento Abre a planilha Editar Formatos de Elemento, apartir da qual é possível definir estilos de exibiçãode elementos. Esses estilos de exibição sãoaplicados em fatias dinâmicas e em planilhas daweb do TM1 Web.

Expandir Elemento Exibe todos os filhos de um elemento selecionado.

Capítulo 1. Windows e Caixas de Diálogo 27

Item de Menu Descrição

Reduzir Elemento Oculta todos os filhos de um elementoselecionado.

Propriedades Abre a caixa de diálogo Propriedades do Elementode Dimensão, a partir da qual é possível designar otipo e peso de um elemento para um elementoselecionado.

Menu Visualizar

Item de Menu Descrição

Barras de Ferramentas Oculta ou exibe as várias barras de ferramentas naparte superior da janela do Editor de Dimensão.Um visto indica que uma barra de ferramentas éexibida.

Barra de Status Oculta ou exibe a Barra de Status na parte inferiorda janela do Editor de Dimensão. Um visto indicaque a Barra de Status é exibida.

Janela Propriedades Oculta ou exibe a área de janela Propriedades. Umvisto indica que a área de janela Propriedades éexibida.

Atualizar Atualiza a exibição da área de janela Elementos.

Caixa de Diálogo Inserir Elemento de DimensãoUse esta caixa de diálogo para incluir elementos simples, de sequência ou consolidados em umadimensão. O diálogo contém as seguintes opções.

Opção Descrição

Nome da Dimensão O nome da dimensão na qual estão sendo incluídoselementos. Esta não é uma opção editável.

Nome do Pai O nome do elemento-pai no qual estão sendoincluídos elementos. Esta não é uma opçãoeditável.

Se um elemento foi selecionado no editor dedimensão quando você abriu a caixa de diálogoInserir Elemento de Dimensão, esse elemento seráexibido como o Nome do Pai. Se nenhum elementofoi selecionado, o Nome do Pai será Raiz.

Inserir Nome de Elemento Insira um nome para o novo elemento nesta caixa.

Tipo de Elemento Faça uma seleção apropriada para o elemento quevocê deseja inserir.

28 IBM Planning Analytics: Referência do TM1

Opção Descrição

Peso do Elemento Se o tipo de elemento for Simples e o Nome do Paifor algo diferente de Raiz, insira um peso nestacaixa. O peso é um fator de multiplicação aplicadoa um elemento durante a consolidação.

Um peso associado a um elemento de umaconsolidação não altera o valor do elemento emoutro local na dimensão.

Incluir Clique em Incluir sempre que especificar um novoelemento, tipo e peso.

OK Clique neste botão quando terminar de incluirelementos para confirmar os novos elementos nadimensão.

Caixa de Diálogo Ordenação de Elementos de DimensãoUse esta caixa de diálogo para definir a ordem de elementos em uma dimensão.

A ordem de elementos em uma dimensão determina o valor de índice para cada elemento na dimensão.O primeiro elemento em uma dimensão possui um valor de índice de 1, o segundo elemento possui umvalor de índice de 2, e assim por diante. A ordem dos elementos em uma dimensão é importante porquemuitas funções do TM1 (planilha, regras e Turbo Integrator) fazem referência a valores de índice doselementos.

Nota: Se você alterar a ordem de elementos em uma dimensão, as funções que fazem referência avalores de índice de elementos retornarão valores novos e possivelmente inesperados.

Use as seguintes etapas para definir a ordem de elementos.

Procedimento

1. Selecione um tipo de classificação.

Tipo Descrição

Automático Ativa as opções Classificação Automática por:Nome, Nível e Hierarquia.

Manual Ordena elementos conforme eles existem naestrutura da dimensão e define a propriedade declassificação de dimensão como Manual.

2. Se você selecionar o tipo de classificação Manual, vá para a etapa 5.3. Selecione uma opção Classificação Automática por.

Tipo Descrição

Nome Classifica elementos em ordem alfabética

Nível Classifica elementos por nível de hierarquia.

Hierarquia Classifica elementos de acordo com a hierarquiada dimensão.

Capítulo 1. Windows e Caixas de Diálogo 29

4. Se aplicável, selecione uma Direção de Classificação.5. Clique em OK.

Agora você tem a ordem dos elementos de dimensão. Quando abrir a dimensão, você verá oselementos por ordem, de acordo com a opção Classificar por, especificada na etapa 3.

ResultadosAgora você tem a ordem dos elementos de dimensão. Quando abrir a dimensão, você verá os elementospor ordem, de acordo com a opção Classificar por, especificada na etapa 3.

Caixa de Diálogo Propriedades do Elemento de DimensãoExibe o nome, tipo e peso do elemento atual.

Área de Janela Propriedades

Opções Descrição

Tipo de Elemento Para alterar o tipo do elemento atual, selecione umnovo tipo da lista. Existem três possíveis tipos deelementos: simples, consolidado e de sequência.

Peso do Elemento Para alterar o peso do elemento atual, clique duasvezes no campo Peso do Elemento e insira umnovo valor de peso.

DrillO menu Drill lista as opções usadas para criar e gerenciar um processo de drill e uma designação de drill.Os processos de drill e designações são usados para criar links entre as células do cubo com dadosdetalhados relacionados.

Opções Descrição

Criar/Editar/Excluir Regras de Designação de Drill Escolha estas opções para criar, editar ou excluirdesignações de drill. A opção Criar abre o editor deregras para que seja possível projetar a regra.

Criar/Editar Processo de Drill Um processo de drill é um processo do TurboIntegrator que define os dados detalhados, quesão abertos em uma nova janela. Estas opçõeseditam uma regra de designação de drill existenteou permitem criar uma nova. As opções Criarexibem os parâmetros e valores a serem usados eos detalhes para a origem de dados. Se vocêalterar a origem de dados para um processo dedrill, o Turbo Integrator não atualizará a funçãocom a nova origem de dados, porque a função estáfora da área Instruções Geradas. Você deve editara origem de dados de Visualização do Cubo nafunção ReturnViewHandle para o processo de drill.

30 IBM Planning Analytics: Referência do TM1

Caixa de Diálogo Editar FórmulaA caixa de diálogo Editar Fórmula orienta-o na criação de funções DBR, DBRW e DBS. Também é possívelusar a caixa de diálogo Editar fórmula para editar qualquer função do TM1 em uma planilha.

Para exibir a caixa de diálogo Editar fórmula, clique em uma célula em uma planilha e escolha TM1,Editar fórmula. Caso a célula contenha uma função do TM1, a função será exibida no campo de entradada caixa de diálogo.

Campo Descrição

Ref. de BD Clique neste botão para inserir uma função DBR nacélula atual. O TM1 o orienta em várias caixas dediálogo que ajudam a criar a função.

DBRW Clique neste botão para inserir uma função DBRWna célula atual. O TM1 o orienta em várias caixasde diálogo que ajudam a criar a função.

Envio de BD Clique neste botão para inserir uma função DBS nacélula atual. O TM1 o orienta em várias caixas dediálogo que ajudam a criar a função.

Ref. Célula Clique neste botão para inserir uma referência decélula em uma função. O TM1 solicita que vocêselecione a célula à qual deseja fazer referência esolicita um tipo de referência.

Nomes Clique neste botão para inserir um cubo, dimensãoou nome de elemento em uma função

O Editor de Fórmulas pode ser usado para criar funções que fazem referência a cubos de até 29dimensões.

Caixa de Diálogo Editar Referência ao CuboEsta caixa de diálogo permite configurar as referências de elemento usadas em funções de planilha doTM1, como DBRW e DBSW.

A caixa de diálogo contém botões e campos que correspondem a cada dimensão no cubo ao qual afunção de planilha do TM1 faz referência. Por exemplo, a imagem a seguir mostra a caixa de diálogoEditar referência ao cubo para uma função DBRW que faz referência ao cubo SalesCube no banco dedados de amostra do TM1. A caixa de diálogo inclui botões para todas as dimensões no cubo SalesCube.

Quando uma função do TM1 é inserida em uma planilha, o TM1 tenta determinar se existem referênciasde elemento relevantes na planilha. Neste caso, essas referências são automaticamente inseridas noscampos apropriados na caixa de diálogo Editar Referência ao Cubo. Caso não seja possível determinarreferências de elemento relevantes, o TM1 insere "Undef" nos campos.

É possível definir referências nesta caixa de diálogo:

• clicando em um botão da dimensão e selecionando um elemento. Neste caso, a referência é inseridacomo uma sequência no campo apropriado.

• inserindo uma referência de célula diretamente em um campo. É possível usar referências de célularelativas à linha, relativas à coluna ou absolutas.

Capítulo 1. Windows e Caixas de Diálogo 31

Se o cubo para o qual está sendo criada uma referência contiver mais de 16 dimensões, clique emAnterior para voltar para a página com as 16 dimensões anteriores, ou clique em Avançar para avançarpara a página com as 16 dimensões seguintes.

Caixa de Diálogo Filtrar Elementos por AtributoUse esta caixa de diálogo para selecionar apenas os elementos de subconjunto que possuem um valor deatributo especificado.

Selecione o atributo desejado da lista Selecionar um Atributo.

Selecione um valor correspondente da lista Selecionar um Valor.

Caixa de Diálogo Filtrar Elementos por NívelA caixa de listagem exibe os níveis de hierarquia disponíveis no subconjunto atual. Para visualizar apenaselementos de um determinado nível, selecione o nível e clique em OK.

Para selecionar vários níveis adjacentes, clique e arraste nos níveis. Para selecionar vários níveis nãoadjacentes, pressione CTRL-clique em cada nível.

Caixa de Diálogo Filtrar SubconjuntoA caixa de diálogo Filtrar Subconjunto permite criar um subconjunto dinâmico com base em valores emum cubo especificado. Por exemplo, é possível criar um subconjunto da dimensão Região que retorna os10 elementos com os maiores valores para vendas anuais reais de Sedã 1.8L no cubo Sales.

A caixa de diálogo contém as seguintes opções.

Opção Descrição

CubeName O cubo para o qual você deseja filtrar valores.

32 IBM Planning Analytics: Referência do TM1

Opção Descrição

Filtrar O tipo de filtro que você deseja aplicar àvisualização atual.

Contagem dos Maiores

Filtra o subconjunto para retornar apenas osmaiores n elementos, em que n é um númeroespecificado na opção Valor.

Contagem dos Menores

Filtra o subconjunto para retornar apenas osmenores n elementos, em que n é um númeroespecificado na opção Valor.

Soma dos Maiores

Filtra o subconjunto para retornar apenas osmaiores elementos cuja soma é maior ou iguala n, em que n é um número especificado naopção Valor.

Soma dos Menores

Filtra o subconjunto para retornar apenas osmenores elementos cuja soma é maior ou iguala n, em que n é um número especificado naopção Valor.

Percentual dos Maiores

Filtra o subconjunto para retornar apenas osmaiores elementos cuja soma é maior ou iguala n, em que n é uma porcentagem da dimensãototal especificada na opção Valor.

Percentual dos Menores

Filtra o subconjunto para retornar apenas osmenores elementos cuja soma é maior ou iguala n, em que n é uma porcentagem da dimensãototal especificada na opção Valor.

Nenhum

Não aplicável à filtragem de subconjuntos.

Valor Um valor para o tipo de Filtro.

Selecionar Membro da Coluna O(s) elemento(s) da coluna no(s) qual(is) o filtro ouclassificação é aplicada. Clique nos botões dadimensão para selecionar um único elemento paracada dimensão da coluna.

Capítulo 1. Windows e Caixas de Diálogo 33

Opção Descrição

Classificar A ordem de classificação que você deseja aplicarao(s) elemento(s) da coluna selecionado(s).

Modo ascendente

Classifica valores para o(s) elemento(s) dacoluna especificado(s) do mais baixo para omais alto.

Ordem decrescente

Classifica valores para o(s) elemento(s) dacoluna especificado(s) do mais alto para o maisbaixo.

Nenhum

Nenhuma ordem de classificação.

Selecionar Membros da Coluna Você deve selecionar um único elemento de cadadimensão do cubo restante. Por exemplo, seestiver filtrando a dimensão Região no banco dedados de amostra em relação a valores no cuboSales, você deverá especificar um único elementode cada uma das dimensões Modelo, Mês,ActVsBud e Account1.

Para cada dimensão, clique no botão apropriado eselecione um único elemento.

Se o cubo contiver mais de 16 dimensões, clique

em para voltar para a página com as 16

dimensões anteriores, ou clique em paraavançar para a página com as 16 dimensõesseguintes.

Caixa de Diálogo Filtrar VisualizaçãoA caixa de diálogo Filtrar Visualização permite filtrar e classificar colunas no Cube Viewer ou no In-Spreadsheet Browser.

O diálogo contém as seguintes opções.

Opção Filtro/Descrição

CubeName O cubo para o qual você deseja filtrar ou classificarvalores. Esta opção é sempre definida para o cuboassociado à visualização atual. Ela não pode sereditada.

Filtrar O tipo de filtro que você deseja aplicar àvisualização atual.

34 IBM Planning Analytics: Referência do TM1

Opção Filtro/Descrição

Contagem dos Maiores

Filtra a visualização para exibir apenas os maioresn elementos, em que n é um número especificadona opção Valor.

Contagem dos Menores

Filtra a visualização para exibir apenas os menoresn elementos, em que n é um número especificadona opção Valor.

Soma dos Maiores

Filtra a visualização para exibir apenas os maioreselementos cuja soma é maior ou igual a n, em quen é um número especificado na opção Valor.

Soma dos Menores

Filtra a visualização para exibir apenas os menoreselementos cuja soma é maior ou igual a n, em quen é um número especificado na opção Valor.

Percentual dos Maiores

Filtra a visualização para exibir apenas os maioreselementos cuja soma é maior ou igual a n, em quen é uma porcentagem da dimensão totalespecificada na opção Valor.

Percentual dos Menores

Filtra a visualização para exibir apenas os menoreselementos cuja soma é maior ou igual a n, em quen é uma porcentagem da dimensão totalespecificada na opção Valor.

Nenhum

Nenhum filtro. Selecione esta opção se desejarclassificar valores sem filtragem.

Valor Um valor para o tipo de Filtro.

Selecionar Membro da Coluna O(s) elemento(s) da coluna no(s) qual(is) o filtro ouclassificação é aplicada. Clique nos botões dadimensão para selecionar um único elemento paracada dimensão da coluna.

Classificar A ordem de classificação que você deseja aplicarao(s) elemento(s) da coluna selecionado(s).

Modo ascendente

Classifica valores para o(s) elemento(s) da colunaespecificado(s) do mais baixo para o mais alto.

Capítulo 1. Windows e Caixas de Diálogo 35

Opção Filtro/Descrição

Ordem decrescente

Classifica valores para o(s) elemento(s) da colunaespecificado(s) do mais alto para o mais baixo.

Nenhum

Nenhuma ordem de classificação.

Caixa de Diálogo Obter Visualização (In-Spreadsheet Browser)A caixa de diálogo Obter Visualização permite abrir uma visualização no servidor local ou em qualquerservidor disponível na rede.

Campo Descrição

Servidor A lista Servidor exibe todos os servidoresdisponíveis em sua rede. Selecione o servidor noqual reside a visualização que você deseja abrir.

Se você não estiver com logon efetuado noservidor que contém a visualização que desejaabrir, clique em Conectar para abrir a caixa dediálogo Conectar Servidor e efetuar logon noservidor. Clique em Iniciar Servidor Local parainiciar o servidor local.

Cubo A lista Cubo exibe todos os cubos disponíveis noservidor selecionado. Selecione o cubo associado àvisualização que você deseja abrir.

Visualizar A lista Visualização exibe todas as visualizaçõesdisponíveis no cubo selecionado. Selecione avisualização que você deseja abrir.

Menu do In-Spreadsheet BrowserO menu do In-Spreadsheet Browser pode ser acessado clicando com o botão direito no Controle devisualização do TM1. O menu permite abrir, atualizar, formatar, fatiar e salvar uma visualização. Eletambém inclui várias opções que controlam o comportamento do In-Spreadsheet Browser.

Item de Menu Descrição

AtualizarVisualização

Atualiza a visualização atual, enviando os valores editados para o banco dedados do TM1 e recuperando valores atuais do banco de dados.

Obter Visualização Abre a caixa de diálogo Obter Visualização, a partir da qual é possível abrir umavisualização em qualquer servidor disponível.

Estilos Abre a caixa de diálogo Estilos de Visualização, que permite formatar umavisualização.

36 IBM Planning Analytics: Referência do TM1

Item de Menu Descrição

Salvar Abre a caixa de diálogo Salvar visualização, que permite salvar uma visualizaçãodo TM1.

Limpar Exibição Limpa todos os dados associados a uma visualização, incluindo título, rótulos dalinha e da coluna.

Excluir Exclui o Controle de visualização do TM1. Observe que todos os dadosassociados à visualização, incluindo valores e rótulos, permanecem na planilha.

Recortar Recorta o Controle de visualização do TM1 e o envia para a Área detransferência.

Copiar Copia o Controle de visualização do TM1 e o envia para a Área de transferência.

Fatiar Fatia a visualização atual para uma nova planilha do Excel.

Suprimir Zeros Esta alternância suprime ou exibe valores zero na visualização do cubo. Um vistoindica que os zeros são suprimidos na visualização atual.

MostrarAutomaticamente

Esta alternância ativa ou desativa a atualização da visualização automáticadurante a reconfiguração da visualização. Um visto indica que a visualização éautomaticamente atualizada sempre que a configuração de visualização éalterada.

AtualizarVisualização aoRecalcular

Esta alternância ativa ou desativa a atualização da visualização automáticadurante o recálculo da planilha (F9). Um visto indica que a visualização éatualizada sempre que a planilha é recalculada.

Ajuda Abre o tópico da ajuda do In-Spreadsheet Browser.

Janela Log de MensagensA janela Log de mensagens do TM1 exibe mensagens de status sobre a atividade do servidor. Essasmensagens são salvas no log de mensagens do servidor e contém detalhes sobre uma atividade, taiscomo processos, tarefas, cubos carregados e dimensões e replicação sincronizada.

Para obter informações detalhadas sobre o log de mensagens do servidor, consulte Operações do TM1.

Área de Janela Log de Mensagens

Esta área de janela exibe mensagens de status contidas no log de mensagens do servidor.

Cada linha na área de janela representa uma mensagem exclusiva. Se uma mensagem no log mostraruma condição de erro para um processo ou replicação executada, você poderá clicar duas vezes namensagem para visualizar os detalhes do motivo pelo qual a atividade gerou o erro.

Para obter detalhes sobre os campos na área de janela Log de mensagens, consulte Operações do TM1.

Menu Arquivo

Capítulo 1. Windows e Caixas de Diálogo 37

Item de Menu Descrição

Sair Fecha a janela Log de Mensagens.

Menu Editar

Item de Menu Descrição

Copiar Copia o texto selecionado da área de janela Log deMensagens para a Área de Transferência.

Localizar Abre a caixa de diálogo Localizar, na qual épossível procurar texto na área de janela Log deMensagens.

Menu Ajuda

Item de Menu Descrição

Ajuda do Log de Mensagens Abre o tópico da ajuda Log de Mensagens.

Conteúdo e Índice Abre a Biblioteca de documentação do TM1completa

Caixa de Diálogo Novo Atributo

Campo Descrição

Nome do Novo Atributo Insira um nome para o novo atributo neste campo.

Numérico Selecione esta opção se os valores de atributosforem números.

Sequência Selecione esta opção se os valores de atributosforem sequências de caracteres.

Alias Selecione esta opção se os valores de atributosforem nomes alternativos para os nomes atuais deelemento, dimensão, cubo ou servidor.

Caixa de Diálogo Abrir SubconjuntoUse a Caixa de Diálogo Abrir Subconjunto para abrir um subconjunto de dimensões existente.

Para abrir o subconjunto público padrão, selecione a caixa Padrão e clique em Abrir.

38 IBM Planning Analytics: Referência do TM1

Caixa de Diálogo Abrir VisualizaçãoUse a Caixa de Diálogo Abrir Visualização para abrir uma visualização do cubo existente.

Para abrir a visualização pública padrão, selecione a caixa Padrão e clique em Abrir.

Assistente de Relatório de ImpressãoUse o Assistente Imprimir relatório para gerar relatórios de estilo "livro de sínteses" a partir de fatias doTM1.

O Assistente consiste em três telas.

• Tela 1 - Selecionar as planilhas a serem incluídas no relatório• Tela 2 - Selecionar as dimensões de título a serem usadas no relatório, definir a ordem na qual elas

aparecem no relatório e definir as opções de impressão da pasta de trabalho• Tela 3 - Selecionar um destino de impressão para o relatório (impressora, arquivo do Excel ou arquivo

PDF)

O Assistente de Relatório de Impressão também permite salvar as configurações do relatório.

Todas as Telas

Botão Descrição

Carregar Clique neste botão para carregar uma Tarefa deimpressão do TM1 existente.

Salvar Clique neste botão para salvar as configurações derelatório atuais como uma Tarefa de impressão doTM1.

Salvar como Clique neste botão para salvar as configurações derelatório atuais como uma Tarefa de impressão doTM1 com um novo nome.

Próximo Clique neste botão para avançar para a próximatela do Assistente.

Cancelar Clique neste botão para fechar a janela doAssistente sem gerar um relatório.

Tela 1 de 3

Item Descrição

Incluir estas planilhas na lista de relatórios Lista as planilhas disponíveis na pasta de trabalhoatual do Excel que podem ser incluídas norelatório.

Para incluir uma planilha no relatório, selecione acaixa de seleção próxima ao nome da planilha.

Capítulo 1. Windows e Caixas de Diálogo 39

Item Descrição

Selecionar Tudo Clique neste botão para incluir todas as planilhasno relatório.

Limpar Tudo Clique neste botão para excluir todas as planilhasdo relatório.

Tela 2 de 3

Item Descrição

Lista de Dimensões de Título Disponíveis Lista as dimensões de título disponíveis quepodem ser usadas no relatório.

Para cada dimensão, esta lista exibe o nome dosubconjunto (se aplicável), o número de elementosna dimensão ou subconjunto e o endereço dacélula da dimensão de título na planilha.

Lista de Dimensões de Título Selecionadas Lista as dimensões de título a serem incluídas norelatório.

A ordem dessa lista é usada quando o TM1 gera orelatório.

Incluir Clique neste botão para mover as dimensõesselecionadas da lista Dimensões de TítuloDisponíveis para a lista Dimensões de TítuloSelecionadas.

Incluir Todos Clique neste botão para mover todas as dimensõesda lista Dimensões de Título Disponíveis para alista Dimensões de Título Selecionadas.

Remover Clique neste botão para mover as dimensõesselecionadas da lista Dimensões de TítuloSelecionadas para a lista Dimensões de TítuloDisponíveis.

Remover Tudo Clique neste botão para mover todas as dimensõesda lista Dimensões de Título Selecionadas para alista Dimensões de Título Disponíveis.

Mover para Cima Clique neste botão para mover a dimensãoselecionada para cima na lista Dimensões de TítuloSelecionadas. A ordem dessa lista é usada quandoo TM1 gera o relatório.

Mover para Baixo Clique neste botão para mover a dimensãoselecionada para baixo na lista Dimensões deTítulo Selecionadas. A ordem dessa lista é usadaquando o TM1 gera o relatório.

40 IBM Planning Analytics: Referência do TM1

Item Descrição

Editor de Subconjunto Clique neste botão para abrir o Editor deSubconjunto, se desejar selecionar umsubconjunto de elementos da dimensãoselecionada no momento na lista Dimensões deTítulo Selecionadas.

Imprimir Planilha Única Selecione esta opção para criar um relatóriodisposto em um grupo completo de planilhas.

Cada planilha no relatório é impressa apenas umavez, incluindo as planilhas que não contêm dadosde fatia do TM1.

Imprimir Várias Pastas de Trabalho Selecione esta opção para criar um relatóriodisposto em vários grupos com base em elementosde dimensão.

Esta opção cria um relatório com um número maiorde planilhas, porque é impressa uma cópia de cadaplanilha para cada elemento do título.

Total de Pastas de Trabalho do Excel que serãogeradas

Exibe o número total de planilhas do Excel que oTM1 gerará para o relatório atual.

Tela 3 de 3

Campo Descrição

Imprimir na Impressora Selecione esta opção se desejar imprimir orelatório em uma impressora.

Salvar Como Arquivos do Excel Selecione esta opção se desejar gerar o relatóriocomo um arquivo do Excel.

Salvar Como Arquivos PDF Selecione esta opção se desejar gerar o relatóriocomo um arquivo PDF.

Visualizar Este botão fica disponível quando você seleciona aopção Imprimir na Impressora.

Clique neste botão para visualizar o relatório antesda impressão.

Nome da Impressora Esta opção fica disponível quando você seleciona aopção Imprimir na Impressora.

Use esta opção para especificar a impressorausada pelo TM1 para imprimir o relatório.

Número de Cópias Esta opção fica disponível quando você seleciona aopção Imprimir na Impressora.

Use esta opção para especificar o número decópias do relatório a serem impressas.

Capítulo 1. Windows e Caixas de Diálogo 41

Campo Descrição

Imprimir em Arquivo Esta opção fica disponível quando você seleciona aopção Imprimir na Impressora.

Selecione esta opção para salvar o relatório comoum arquivo pronto para impressão.

Nome do Arquivo Esta opção fica disponível quando você selecionaas opções Imprimir na Impressora e Imprimir noArquivo.

Insira um caminho completo e nome do arquivo noqual você deseja salvar o relatório. Você tambémdeve especificar um tipo de arquivo. Por exemplo,se você imprimir um arquivo utilizando umaimpressora PostScript, deve anexar o tipo dearquivo .ps ao nome do arquivo.

Navegar Este botão fica disponível quando você seleciona aopção para imprimir ou salvar o relatório em umarquivo.

Clique neste botão para escolher o diretório noqual deseja salvar o relatório.

Agrupar Esta opção fica disponível quando você seleciona aopção Imprimir na Impressora.

Selecione esta opção para agrupar páginas juntasao imprimir várias cópias do relatório.

Gerar Nova Pasta de Trabalho para cada Título Esta opção fica disponível quando você escolhesalvar o relatório como um arquivo do Excel ouPDF.

Selecione esta opção se desejar criar um arquivoseparado para cada dimensão de título norelatório.

Nome de Diretório Esta opção está disponível ao salvar um relatóriocomo um arquivo do Excel ou PDF e quando vocêselecionar a opção Gerar Nova Pasta de Trabalhopara cada Título.

Insira um diretório no qual salvar os arquivos derelatório. Para escolher um local do diretório,clique no botão Navegar.

Criar Captura Instantânea Esta opção fica disponível quando você seleciona aopção Salvar como Arquivos do Excel.

Selecione essa opção quando quiser salvar orelatório como um arquivo do Excel que contémvalores reais e não funções do TM1 que recuperamvalores.

Voltar Clique neste botão para voltar para a tela anteriordo Assistente.

42 IBM Planning Analytics: Referência do TM1

Campo Descrição

Concluir Clique neste botão para gerar o relatório com basenas opções selecionadas.

Caixa de Diálogo Opções de ProcessoUse a caixa de diálogo Opções de Processo para controlar o comportamento do botão de Ação antes edepois da execução do processo.

É possível usar um dos seguintes métodos para definir o texto para mensagens de confirmação e destatus que são exibidas quando o botão de Ação é clicado:

• Insira o texto para uma mensagem diretamente na caixa de texto.• Use uma referência do Excel para recuperar dinamicamente o texto para uma mensagem da planilha.

Por exemplo, para recuperar o texto para uma mensagem do conteúdo da célula A1, insira =A1 na caixade texto para essa mensagem. Para fazer referência a um intervalo nomeado, use o formato: =IntervaloNomeado.

Para obter mais informações sobre como usar o diálogo Opções de processo, consulte IBM Cognos TM1for Developers.

Campo Descrição

Recalcular planilha automaticamente Selecione esta opção para que o TM1 recalculeautomaticamente a planilha completa após aexecução do processo.

Mostrar Mensagem de Êxito Selecione esta opção para exibir uma mensagemapós a execução bem-sucedida do processo.

Insira o texto da mensagem na caixa conformedescrito acima.

Mostrar Mensagem de Falha Selecione esta opção para exibir uma mensagemse o processo não for executado com êxito.

Insira o texto da mensagem na caixa conformedescrito acima.

Mostrar Caixa de Diálogo de Confirmação Selecione esta opção para exibir uma caixa demensagens de confirmação Sim/Não antes doinício do processo. O usuário pode clicar em Simpara executar o processo, ou em Não paracancelar.

Insira o texto da mensagem na caixa conformedescrito acima.

OK Clique neste botão para salvar suas configuraçõese fechar a caixa de diálogo.

Cancelar Clique neste botão para fechar a caixa de diálogosem salvar suas configurações.

Capítulo 1. Windows e Caixas de Diálogo 43

Caixa de Diálogo Replicar CuboUse a caixa de diálogo Replicar Cubo para replicar um cubo de um servidor de origem para um servidor dedestino.

Informações do Cubo

Item Descrição

Nome O nome do cubo espelhado no servidor de destino.

Por padrão, o TM1 nomeia o cubo espelhadoconcatenando o nome do servidor de origem com onome do cubo de origem.

Não altere o nome padrão se estiver replicandoregras nesse cubo.

Copiar Dados e Configurar para Sincronização Selecione esta opção para copiar dados quando areplicação for estabelecida e para sincronizardados quando ocorrer a sincronização entre osservidores de origem e de destino.

Copiar Dados mas não Definir para Sincronizar Selecione esta opção para copiar dados quando areplicação for estabelecida, mas para desativarposteriormente a sincronização de dados.

Replicar Visualizações Selecione esta opção para replicar todas asvisualizações associadas ao cubo de origem.

Informações sobre Regra

Item Descrição

Copiar Regra Selecione esta opção para copiar regras do cubode origem para o cubo espelhado.

Definir Regra a Ser Sincronizada Preencha esta caixa para sincronizar regrasquando ocorrer a sincronização entre os servidoresde origem e de destino.

Limpe esta caixa para desativar a sincronização daregra.

Não Copiar Regra Ao selecionar essa opção, o TM1 não copiará aregra do cubo de origem para o cubo espelhado.

Informações da Dimensão

44 IBM Planning Analytics: Referência do TM1

Item Descrição

Caixa Informações de Dimensão Esta caixa exibe informações sobre as dimensõesno cubo espelhado.

Caso o cubo de origem não contenha regras, o TM1renomeará as dimensões espelhadas,concatenando os nomes do servidor de origemcom os nomes da dimensão de origem.

Se o cubo de origem contiver regras, o TM1 nãoalterará os nomes de dimensões no cuboespelhado.

A caixa Informações de Dimensão também exibe onome da dimensão de origem, do servidor deorigem e o status de replicação para cadadimensão no cubo.

Selecionar Dimensão Local Para usar uma dimensão local no lugar de umadimensão de origem, clique na dimensão deorigem na caixa Informações de Dimensão e cliqueem Selecionar dimensão local. Selecione adimensão local que deseja usar e clique em OK.

Reconfigurar a Seleção Atual para o Padrão Se você alterar quaisquer opções de Informaçõesde Dimensão para uma dimensão em um cuboreplicado, poderá restaurar todas as opções paraos valores-padrão, selecionando a dimensão nacaixa Informações de Dimensão e clicando nestebotão.

Substituir Dimensão Esta opção fica disponível quando você selecionauma dimensão local.

Selecione esta opção para sobrescrever adimensão local com a definição da dimensão deorigem.

Definir Dimensão a Ser Sincronizada Preencha esta caixa para sincronizar mudançasentre a dimensão de origem e a espelhada, quandoocorrer a sincronização entre os servidores deorigem e de destino.

Limpe esta caixa para desativar a sincronização dadimensão.

Não sobrescrever dimensão Esta opção fica disponível quando você selecionauma dimensão local.

Selecione esta opção para usar a dimensão localcomo está.

Replicar Subconjuntos Selecione esta opção para replicar todos ossubconjuntos associados à dimensão de origem.

Capítulo 1. Windows e Caixas de Diálogo 45

Editor de RegrasO Editor de regras possui um conjunto completo de menus para criar, editar e gerenciar as regras do TM1.São fornecidos atalhos de teclado para as opções de menu mais comumente usadas.

Menu ArquivoA tabela a seguir descreve as opções no Menu Arquivo.

Nome Descrição

Importar Abre um diálogo de navegação de arquivo, paraque seja possível selecionar um arquivo de textopara importação. O texto importado sobrescreveráa regra atual, se existir uma.

Salvar Salva a regra atual no servidor.

Salvar como Salva a regra atual em um arquivo .rux de regraexterna do TM1.

Verificar Sintaxe Verifica erros de sintaxe na regra atual.

Imprimir Abre a caixa de diálogo Imprimir para que sejapossível imprimir a regra atual.

Visualização de Impressão Abre a janela Visualização de Impressão, na qual épossível visualizar uma versão impressa deamostra da regra antes de enviá-la para umaimpressora.

Sair Fecha o Editor de Regras.

Menu EditarA tabela a seguir descreve as opções no Menu Editar.

Nome Descrição

Desfazer Desfaz a última edição.

Vários níveis de desfazer são suportados.

Refazer Reverte para o último comando desfazer.

Recortar Remove o texto selecionado e coloca-o na área detransferência.

Copiar Copia o texto selecionado para a área detransferência.

Colar Cola o conteúdo da área de transferência no Editorde Regras.

Selecionar Tudo Selecione todo o conteúdo do Editor de Regras.

46 IBM Planning Analytics: Referência do TM1

Nome Descrição

Localizar Abre a caixa de diálogo Localizar, para que sejapossível procurar texto na regra.

Localizar / Substituir... Abre a caixa de diálogo Localizar/Substituir paraprocurar e substituir texto.

Localizar Próxima Localiza a próxima ocorrência do texto que vocêestá procurando.

Alternar Marcador Ativa ou desativa um marcador para a linha decódigo atual.

Próximo Marcador Move o cursor para o próximo marcador disponível.

Marcador Anterior Move o cursor para o marcador anterior disponível.

Limpar Todos os Marcadores Remove todos os marcadores.

Seleção de Comentário Inclui um símbolo de comentário # na frente detodas as linhas no texto selecionado no momentopara excluir as linhas da regra compilada.

Nota: O comprimento do comentário é limitado a255 bytes. Para conjuntos de caracteresocidentais, como o inglês, um único caractere érepresentado por um único byte, permitindo inserircomentários com 255 caracteres. No entanto,conjuntos de caracteres grandes, como chinês,japonês e coreano, usam vários bytes pararepresentar um caractere. Neste caso, o limite de255 bytes pode ser excedido mais rapidamente ede fato não permitir a entrada de 255 caracteres.

Remover Comentários da Seleção Remove o símbolo de comentário # da frente detodas as linhas no texto selecionado no momentopara incluir as linhas na regra.

Indentação Indenta as linhas selecionadas no momento.

Retirar Indentação Remove a indentação das linhas selecionadas nomomento.

Ir para Linha... Exibe a caixa de diálogo Ir para a Linha, para queseja possível inserir e ir para um número da linhaespecífico no Editor de Regras.

Menu VisualizarA tabela a seguir descreve as opções no Menu Visualizar.

Nota: As mudanças feitas nas configurações no Menu Visualizar serão salvas quando você sair do Editorde Regras e serão automaticamente reaplicadas na próxima vez em que você abrir o Editor de Regras.

Capítulo 1. Windows e Caixas de Diálogo 47

Nome Descrição

Quebra Automática de Linha Ativa/desativa o recurso de quebra automática delinha, para que as linhas de texto sejam estendidasà direita ou sejam quebradas para exibição na áreade janela Editar.

Números de Linha Ativa/desativa os números da linha.

Dicas de Ferramentas da Função Ativa/desativa a exibição de dicas de ferramentasda função.

Autocompletar Ativa/desativa o recurso autocompletar ao digitarna área de janela Editar.

Barra de Ferramentas Ativa/desativa a exibição da barra de ferramentasprincipal.

Barra de Status Ativa/desativa a exibição da barra de status naparte inferior do Editor de Regras.

Objetos de Controle Ativa/desativa a exibição de objetos de controle doTM1 ao selecionar cubos.

Expandir Todas as Regiões Expande todas as regiões definidas pelo usuário naregra atual para mostrar todas as linhas.

Recolher Todas as Regiões Reduz todas as regiões definidas pelo usuário naregra atual para ocultar todas as linhas que estãoincluídas em uma região.

Menu InserirA tabela a seguir descreve as opções no Menu Inserir.

Nome Descrição

Função Exibe a caixa de diálogo Inserir Função para inseriruma nova função na regra atual.

Referência do Cubo Exibe o diálogo Inserir Referência do Cubo paraque seja possível inserir uma função DB.

Menu FerramentasA tabela a seguir descreve as opções no Menu Ferramentas.

Nome Descrição

Preferências... Exibe o diálogo Preferências, no qual é possíveldefinir os atributos de fonte, como tipo de fonte,tamanho e cor a serem usados na área de janelaEditar.

48 IBM Planning Analytics: Referência do TM1

Nome Descrição

Opções... Exibe o diálogo Opções de Controle, no qual épossível ajustar as configurações globais para oEditor de Regras.

Caixa de Diálogo Salvar Subconjunto

Campo Descrição

Selecionar ou Inserir Nome do Subconjunto Insira um nome para o subconjunto salvo, ouselecione um nome da lista.

Particular Ative esta opção para salvar o subconjunto comoum objeto particular. Desative esta opção parasalvar o subconjunto como um objeto público.

Padrão Ative esta opção para salvar o subconjunto comoum subconjunto padrão.

Salvar Expressão Se o subconjunto for dinâmico, ative esta opçãopara salvar a expressão MDX com o subconjunto.

Se o subconjunto for dinâmico e você não ativaresta opção, a expressão MDX não será salva e osubconjunto resultante será estático, contendo oselementos presentes quando salvo.

Caixa de Diálogo Salvar Visualização

Campo Descrição

Selecionar oi Inserir Visualização Nomeada Insira um nome para a visualização salva, ouselecione um nome da lista.

Particular Ative esta opção para salvar a visualização comoum objeto particular. Desative esta opção parasalvar a visualização como um objeto público.

Padrão Ative esta opção para salvar a visualização comouma visualização padrão.

Caixa de Diálogo Salvar Visualização (In-Spreadsheet Browser)

Capítulo 1. Windows e Caixas de Diálogo 49

Campo Descrição

Nome da Visualização Insira um nome para a visualização neste campo.

Particular Ative esta opção para salvar a visualização comoum objeto particular. Desative esta opção parasalvar a visualização como um objeto público.

Padrão Ative esta opção para salvar a visualização comouma visualização padrão.

Caixa de Diálogo Designações de SegurançaA caixa de diálogo Designações de Segurança permite designar privilégios de acesso para cubos,dimensões, elementos individuais, processos e tarefas de organização de processos. Os privilégios deacesso são designados por grupo de usuários.

Grade DesignaçõesA grade Designações exibe nomes de objetos como títulos da linha e grupos de usuários como títulos dacoluna. Os privilégios de acesso aparecem como valores de células na interseção de um determinadoobjeto e grupo de usuários.

Quando você acessa a caixa de diálogo Designação de Segurança a partir de um grupo Cubos, a gradeinclui uma coluna Criação de Log. Esta coluna inclui uma caixa de seleção para cada cubo. Para ativar acriação de log para um cubo, ative a caixa de seleção na interseção do nome do cubo e a coluna Criaçãode Log. Para desativar a criação de log, desative a caixa de seleção. O padrão é ativado.

Privilégios de AcessoClique em uma das seguintes opções para designar um privilégio de acesso a uma célula selecionada nagrade Designações:

Privilégio NoneA tabela a seguir descreve a capacidade de grupos de usuários do TM1 para acessar vários objetos doTM1 quando o privilégio None for designado para um objeto.

Objeto Descrição

Cubo Os membros do grupo não podem ver o cubo noServer Explorer e, portanto, não podem navegar nocubo.

Elemento Os membros do grupo não podem ver o elementono Editor de Subconjunto ou no Editor deDimensão, e não podem visualizar célulasidentificadas pelo elemento ao navegar em umcubo.

Dimensão Os membros do grupo não podem ver a dimensãono Server Explorer, e não podem navegar emcubos que contêm a dimensão.

50 IBM Planning Analytics: Referência do TM1

Objeto Descrição

Processo Os membros do grupo não podem ver o processono Server Explorer.

Nota: Os privilégios designados a processos sãoignorados quando um processo é executado apartir de uma tarefa de organização de processos.

Tarefa de organização de processos Os membros do grupo não podem ver a tarefa deorganização de processos no Server Explorer.

Aplicativo Os membros do grupo não podem ver o aplicativoou seu conteúdo no Server Explorer.

Referência Os membros do grupo não podem ver a referênciano Server Explorer.

Privilégio ReadA tabela a seguir descreve a capacidade de grupos de usuários do TM1 para acessar vários objetos doTM1 quando o privilégio Read for designado para um objeto

Objeto Descrição

Cubo Os membros do grupo podem visualizar dados nocubo, mas não podem editar os dados.

Elemento Os membros do grupo podem visualizar dadosidentificados pelo elemento, mas não podemeditar os dados.

Dimensão Os membros do grupo podem visualizar oselementos em uma dimensão, mas não podemeditar a estrutura da dimensão.

Processo Os membros do grupo podem ver o processo noServer Explorer e podem executá-lo, mas nãopodem editá-lo.

Nota: Os privilégios designados a processos sãoignorados quando um processo é executado apartir de uma tarefa de organização de processos.

Tarefa de organização de processos Os membros do grupo podem ver a tarefa deorganização de processos no Server Explorer epodem executá-la manualmente, mas não podemeditá-la ou alterar o status de ativação.

Aplicativo Os membros do grupo podem ver o aplicativo eusar as referências no aplicativo, para o qual vocêtem pelo menos o privilégio Read. É possível criarreferências particulares no aplicativo, bem comosubaplicativos particulares

Capítulo 1. Windows e Caixas de Diálogo 51

Objeto Descrição

Referência Os membros do grupo podem abrir e usar areferência, mas não podem atualizá-la noaplicativo pai. No entanto, é possível executar umaoperação "salvar como" para salvar uma novaversão particular da referência em qualqueraplicativo para o qual você tem pelo menosprivilégio Read.

Privilégio WriteA tabela a seguir descreve a capacidade de grupos de usuários do TM1 para acessar vários objetos doTM1 quando o privilégio Write for designado para um objeto.

Objeto Descrição

Cubo Os membros do grupo podem visualizar e editardados do cubo, e podem criar visualizaçõesparticulares do cubo.

O acesso de gravação não permite editar dadosidentificados por elementos consolidados ouderivados de regras. Por definição, os valoresderivados por consolidação ou por regras nãopodem ser editados.

Elemento Os membros do grupo podem visualizar e editardados identificados pelo elemento.

Dimensão Os membros do grupo podem editar atributos deelemento, editar formatos de elementos e criarsubconjuntos particulares para a dimensão. Osmembros do grupo também podem editaratributos para a própria dimensão.

Privilégio ReserveA tabela a seguir descreve a capacidade de grupos de usuários do TM1 para acessar vários objetos doTM1 quando o privilégio Reserve for designado para um objeto.

Observe que, ao reservar um objeto, essa reserva expira quando o servidor que contém o objeto forencerrado.

Objeto Descrição

Cubo Os membros do grupo podem visualizar e editardados no cubo, e podem reservar o cubo paraimpedir que outros clientes editem dados do cubo.Você pode liberar um cubo reservado.

Elemento Os membros do grupo podem visualizar e editardados identificados pelo elemento e podemreservar o elemento para impedir que outrosusuários editem dados. Você pode liberar umelemento reservado.

52 IBM Planning Analytics: Referência do TM1

Objeto Descrição

Dimensão Os membros do grupo podem incluir, remover ereordenar elementos na dimensão e podemreservar a dimensão para impedir que outrosusuários editem a estrutura da dimensão. Vocêpode liberar uma dimensão reservada.

Privilégio LockA tabela a seguir descreve a capacidade de grupos de usuários do TM1 para acessar vários objetos doTM1 quando o privilégio Lock for designado para um objeto.

Observe que não há nenhum privilégio Unlock e que apenas os usuários com o privilégio Admin para umobjeto podem desbloquear esse objeto.

Objeto Descrição

Cubo Os membros do grupo podem visualizar e editardados no cubo e podem bloquear o cubo.

Quando um cubo está bloqueado, ninguém podeatualizar seus dados.

Elemento Os membros do grupo podem visualizar e editardados identificados pelo elemento e podembloquear o elemento.

Quando um elemento está bloqueado, ninguémpode atualizar dados identificados pelo elemento.

Dimensão Os membros do grupo podem incluir, remover ereordenar elementos na dimensão e podembloquear a dimensão para impedir que outrosusuários editem a estrutura da dimensão.

Quando uma dimensão está bloqueada, ninguémpode editar a estrutura da dimensão.

Privilégio AdminA tabela a seguir descreve a capacidade de grupos de usuários do TM1 em acessar vários objetos do TM1quando designado o privilégio de Administração para um objeto.

Objeto Descrição

Cubo Os membros do grupo podem ler, gravar, reservar,liberar, bloquear, desbloquear e excluir o cubo.

Elemento Os membros do grupo podem visualizar, atualizar eexcluir células identificadas pelo elemento. Elespodem reservar, liberar, bloquear e desbloquear oelemento. Eles também podem conceder a outrosusuários privilégios de acesso para este elemento.

Capítulo 1. Windows e Caixas de Diálogo 53

Objeto Descrição

Dimensão Os membros do grupo podem incluir, remover ereordenar elementos na dimensão. Eles podemreservar, liberar, bloquear e desbloquear adimensão. Eles também podem criar subconjuntospúblicos para a dimensão e conceder a outrosusuários privilégios de acesso para a dimensão.

Aplicativo Os membros do grupo podem ver o aplicativo, usarreferências no aplicativo e criar referênciaspúblicas e particulares no aplicativo. Eles tambémpodem criar subaplicativos públicos e particulares.

Quando um grupo tiver privilégio Admin para umaplicativo, os membros do grupo poderão definirprivilégios de segurança para todas as referênciase subaplicativos no aplicativo para outros grupos,mas não para seu próprio grupo.

Referência Os membros do grupo podem usar a referência,bem como atualizar ou excluir a referência. Elespodem publicar referências particulares eprivatizar referências públicas.

Selecionar DimensãoQuando você acessa a caixa de diálogo Designação de Segurança a partir de uma dimensão individual, aopção Selecionar Dimensão fica disponível. Esta opção permite designar privilégios de acesso paraelementos em várias dimensões.

Depois de designar privilégios de acesso para uma dimensão, clique em Salvar, em seguida, selecioneuma nova dimensão da lista Selecionar Dimensão. Ao concluir a designação de privilégios para todas asdimensões desejadas, clique em OK para descartar a caixa de diálogo.

Caixa de Diálogo Selecionar CuboSelecione o nome do cubo que deseja inserir em sua planilha ou fórmula e clique em OK.

Caixa de Diálogo Selecionar Cubo para RegrasSelecione o cubo para o qual deseja criar uma nova regra e clique em OK.

Caixa de Diálogo Selecionar DimensãoSelecione o nome da dimensão que deseja inserir em sua planilha ou fórmula e clique em OK.

Caixa de Diálogo Selecionar ElementoSelecione o nome de elemento que deseja inserir em sua planilha ou fórmula e clique em OK.

54 IBM Planning Analytics: Referência do TM1

Server Explorer (Janela Principal)

Área de Janela Esquerda (Área de Janela em Árvore)

Exibe uma representação hierárquica de todos os objetos em servidores aos quais você está conectado.

Área de Janela Direita (Área de Janela Propriedades)

Exibe as propriedades do objeto selecionado na área de janela esquerda do Server Explorer. Aspropriedades variam, de acordo com o objeto selecionado.

Menu ArquivoAs opções a seguir estão disponíveis no Menu Arquivo no Server Explorer.

Item de Menu Descrição

Opções Abre a caixa de diálogo Opções do TM1.

Encerrar servidor local Encerra o servidor local e solicita que você salvemudanças nos dados. Esta opção fica disponívelapenas quando o servidor local está em execução.

Iniciar servidor local Inicia o servidor local. Esta opção fica disponívelapenas quando o servidor local não está emexecução.

Atualizar Servidores Disponíveis Atualiza a exibição de servidores disponíveis naárea de janela esquerda do Server Explorer.

Sair Fecha o Server Explorer e quaisquer outras janelasassociadas ao TM1 Perspectives/TM1 Architect.

Menu DinâmicoAs opções disponíveis no segundo menu no Server Explorer variam de acordo com o tipo de objetoselecionado no momento.

Grupo de ServidoresAs opções a seguir estão disponíveis a partir do menu do TM1 ao selecionar o Grupo de servidoes noServer Explorer.

Opção Descrição

Salvar Todos os Dados Salva dados em todos os servidores aos quais vocêestá conectado.

ServidorAs opções a seguir ficam disponíveis no Menu Servidor quando você seleciona um servidor individual noServer Explorer.

Opção Descrição

Salvar Dados Salva todas as edições em dados no servidorselecionado.

Capítulo 1. Windows e Caixas de Diálogo 55

Opção Descrição

Reciclar (Limpar memória para Servidor Local) Encerra e reinicia o servidor local. Ao escolher estaopção, você tem a possibilidade de reciclar e salvardados no servidor local, ou de reciclar e abandonarmudanças no servidor local.

Encerrar Encerra o servidor local. Esta opção fica disponívelapenas quando o servidor local está selecionado.

Segurança, Clientes/Grupos Abre o Editor de Clientes/Grupos para o servidorselecionado. Você deve ter privilégios Admin parao servidor para acessar o Editor de Clientes/Grupos.

Segurança, Alterar Senha Abre a caixa de diálogo Mudança de Senha, a partirda qual é possível alterar sua senha no servidorselecionado.

Segurança, Atualizar Segurança Atualiza todas as estruturas/designações desegurança no servidor selecionado.

56 IBM Planning Analytics: Referência do TM1

Opção Descrição

Designações de Recursos Permite que o administrador defina permissõespara recursos específicos por grupo de usuários.Na interseção do grupo de usuários e o recurso, osadministradores podem definir Conceder ou Negar(igual a em branco) para ativar ou desativar esserecurso. Algumas configurações de recursospodem ser ignoradas, dependendo das definiçõesde configuração feitas no servidor.

Os seguintes recursos podem ser definidos porgrupo de usuários:

• Bloquear Acesso ao Server Explorer

Para impedir que o Server Explorer seja ativado,clique na interseção deste recurso e o grupo deusuários e selecione Conceder. Em Branco ouNegar significa que o Server Explorer é usado poreste grupo de usuários.

• Modo de Writeback de Área de TrabalhoPessoal

Para permitir que um grupo de usuários useÁreas de trabalho pessoais, clique na interseçãodo grupo de usuários e neste recurso e selecioneConceder. Em Branco ou Negar significa queeste grupo de usuários não usa Áreas deTrabalho Pessoais.

Se DisableSandboxing for definido como T, estadesignação de recurso será ignorada.

• Ambiente de Simulação

Para permitir que um grupo de usuários useAmbientes de simulação para criar várioscenários what-if, clique na interseção do grupode usuários e neste recurso e selecioneConceder. Em Branco ou Negar significa queeste grupo de usuários não pode usar váriosAmbientes de Simulações.

Se DisableSandboxing for definido como T, estadesignação de recurso será ignorada.

Consulte a documentação Operações do TM1 eTM1 Architect, Perspectives e TM1 Web para obtermais informações.

Visualizar Log de Transação Abre a caixa de diálogo Consulta do Log deTransações, a partir da qual é possível visualizarum log de transações no servidor selecionado.

Visualizar Log de Mensagens Abre a caixa de diálogo Log de Mensagens, queexibe mensagens registradas no servidorselecionado.

Capítulo 1. Windows e Caixas de Diálogo 57

Opção Descrição

Iniciar Monitor de Desempenho Inicia o monitoramento de desempenho. Quando oMonitor de desempenho está em execução, o TM1preenche vários cubos de controle que permitemcontrolar estatísticas para cubos, clientes eservidores.

Parar Monitor de Desempenho Para o monitoramento de desempenho.

Atualizações Adiadas, Iniciar Atualizações de Lote Inicia as atualizações de lote a serem enviadaspara o servidor selecionado.

Atualizações Adiadas, Encerrar Atualizações deLote

Encerra atualizações de lote e envia todas asedições para o servidor selecionado.

Gerenciador de Servidores Abre a caixa de diálogo Mensagens para osClientes, a partir da qual é possível encerrar oservidor selecionado, desconectar clientes etransmitir mensagens.

Cancelar Encerramento Cancela um encerramento do servidor executadoanteriormente.

Desconectar Item Desconecta seu cliente do servidor selecionado.

Quem Sou Eu Retorna uma mensagem indicando seu nome deusuário no servidor.

AplicativosAs opções a seguir ficam disponíveis no Menu Aplicativos quando você seleciona o grupo de Aplicativosou um aplicativo individual no Server Explorer.

Opção Descrição

Abrir Expande o aplicativo selecionado ou o grupo deAplicativos para revelar referências esubaplicativos.

Fechar Reduz o aplicativo selecionado ou o grupo deAplicativos para ocultar referências esubaplicativos.

Excluir Exclui o aplicativo selecionado. Ao excluir umaplicativo, todos os subaplicativos e referências noaplicativo são automaticamente excluídos. Estaopção não fica disponível quando o grupo deAplicativos está selecionado.

Renomear Define o nome do aplicativo selecionado em modode edição, para que seja possível digitar um novonome para o aplicativo. Esta opção não ficadisponível quando o grupo de Aplicativos estáselecionado.

58 IBM Planning Analytics: Referência do TM1

Opção Descrição

Segurança, Designações de Segurança Abre a janela Designações de segurança do TM1, apartir da qual é possível designar privilégios desegurança para as referências e os subaplicativosimediatos contidos no aplicativo ou grupo deaplicativos selecionado.

Segurança, Tornar Público Escolha esta opção para publicar um aplicativoparticular. Ao publicar um aplicativo, todos ossubaplicativos e referências particulares a objetospúblicos no aplicativo também são publicadosautomaticamente. Esta opção não fica disponívelquando o grupo de Aplicativos está selecionado.

Segurança, Tornar Particular Escolha esta opção para privatizar um aplicativopúblico. Ao privatizar um aplicativo, todos ossubaplicativos e referências públicas no aplicativotambém são automaticamente privatizados. Estaopção não fica disponível quando o grupo deAplicativos está selecionado.

CubosAs opções a seguir ficam disponíveis no Menu Cubos quando você seleciona um grupo de cubos no ServerExplorer.

Opção Descrição

Criar Novo Cubo Abre a caixa de diálogo Criando Cubo.

Editar Atributos Abre o Editor de Atributos para o cuboselecionado.

Designações de Segurança Abre a caixa de diálogo Designações de segurançado TM1 para os cubos no grupo de cubosselecionado. Você deve ser membro do grupoAdmin no servidor que contém o grupo de cubospara acessar esta caixa de diálogo.

CuboAs opções a seguir ficam disponíveis no Menu Cubo quando você seleciona um cubo no Server Explorer.

Opção Descrição

Navegar Abre o cubo para navegação na janela do CubeViewer.

Navegar no Excel Abre o cubo para navegação no In-SpreadsheetBrowser.

Escolher Copia o nome do cubo para a Área deTransferência.

Criar Novo Cubo Abre a caixa de diálogo Criando Cubo.

Capítulo 1. Windows e Caixas de Diálogo 59

Opção Descrição

Descarregar Cubo Descarrega o cubo selecionado da memória doservidor.

Excluir Cubo Exclui o cubo selecionado e todos os dadosassociados. Você deve ter privilégios Admin paraexcluir um cubo

Reordenar Dimensões Abre a janela do Cube Optimizer, a partir da qual épossível otimizar a ordem de dimensões no cuboselecionado.

Criar Regra Abre o Editor de Regras, a partir do qual é possívelcriar uma regra para o cubo selecionado.

Excluir Regra Exclui a regra associada ao cubo selecionado. Vocêdeve ter privilégios Admin para um cubo paraexcluir a regra associada.

Exportar como Dados ASCII Exporta os dados contidos no cubo selecionadopara um arquivo ASCII delimitado por vírgula(.cma).

Sincronizar Dados Sincroniza os dados no cubo selecionado comdados do servidor de replicação associado.

Segurança, Reserve Reserva temporariamente o cubo selecionado paraque outros clientes não possam editar dados nocubo. Você deve ter privilégios Reserve parareservar um cubo.

Segurança, Release Libera um cubo reservado para que outros clientespossam editar dados no cubo. Você deve terprivilégios Reserve para liberar um cubo.

Segurança, Lock Bloqueia permanentemente o cubo selecionadopara que outros clientes não possam editar dadosno cubo. O cliente ao qual está conectado tambémé bloqueado desses elementos. Você deve terprivilégios Lock para bloquear um cubo.

Segurança, Unlock Desbloqueia o cubo selecionado para que outrosclientes possam editar dados. Você deve terprivilégios Admin para desbloquear um cubo.

Propriedades Abre a caixa de diálogo Propriedades do Cubo, apartir da qual é possível definir dimensões demedida e de tempo.

DimensõesAs opções a seguir ficam disponíveis no Menu Dimensões quando você seleciona um grupo de dimensõesno Server Explorer.

60 IBM Planning Analytics: Referência do TM1

Opção Descrição

Criar Nova Dimensão Abre a janela do Editor de Dimensão, a partir daqual é possível criar uma nova dimensão.

Editar Atributos Abre a janela do Editor de Atributos, a partir daqual é possível designar e editar atributos paratodas as dimensões no grupo selecionado.

Designações de Segurança Abre a caixa de diálogo Designações de segurançado TM1, a partir da qual é possível designarprivilégios de segurança para cada dimensão nogrupo. Você deve ser membro do grupo Admin parausar esta opção.

DimensãoAs opções a seguir ficam disponíveis no Menu Dimensão quando você seleciona uma dimensão no ServerExplorer.

Opção Descrição

Inserir Novo Subconjunto Abre a janela do Editor de Subconjunto para adimensão.

Escolher Copia o nome da dimensão para a Área deTransferência.

Editar Estrutura da Dimensão Abre a dimensão selecionada para edição na janelado Editor de Dimensão. Você deve ter privilégiosWrite para a dimensão selecionada para usar estaopção.

Criar Nova Dimensão Abre uma janela vazia do Editor de Dimensão, apartir da qual é possível criar uma nova dimensão.Você deve ser membro do grupo Admin para criaruma nova dimensão.

Exportar Dimensão Exporta as dimensões selecionadas como umarquivo delimitado por vírgula (.cma).

Excluir Dimensão Exclui a dimensão selecionada. Você deve sermembro do grupo Admin para excluir umadimensão.

Definir Ordem de Elementos Abre a caixa de diálogo Ordenação de Elementosde Dimensão, a partir da qual é possível definir aordem de elementos na dimensão selecionada.

Editar Atributos de Elemento Abre a janela do Editor de Atributos, a partir daqual é possível designar e editar atributos paratodos os elementos na dimensão selecionada.

Sincronizar Dados Sincroniza os dados na dimensão selecionada comdados associados de quaisquer servidoresreplicados.

Capítulo 1. Windows e Caixas de Diálogo 61

Opção Descrição

Segurança, Reserve Reserva temporariamente a dimensão selecionadapara que outros clientes não possam editar aestrutura da dimensão. Você deve ter privilégiosReserve para reservar uma dimensão. Observe queesta opção reserva apenas a estrutura dadimensão. Ela não reserva nenhum dos dadosidentificados por elementos na dimensãoselecionada.

Segurança, Release Libera uma dimensão reservada para que outrosclientes possam editar a estrutura da dimensão.Você deve ter privilégios Reserve para liberar umadimensão. Observe que esta opção libera apenas aestrutura da dimensão. Ela não libera nenhum dosdados identificados por elementos na dimensãoselecionada.

Segurança, Lock Bloqueia permanentemente a dimensãoselecionada para que outros clientes não possameditar a estrutura da dimensão. Você deve terprivilégios Lock para bloquear uma dimensão.Observe que esta opção bloqueia apenas aestrutura da dimensão. Ela não bloqueia nenhumdos dados identificados por elementos nadimensão selecionada.

Segurança, Unlock Desbloqueia a dimensão selecionada para queoutros clientes possam editar a estrutura dadimensão. Você deve ter privilégios Admin paradesbloquear uma dimensão. Observe que estaopção desbloqueia apenas a estrutura dadimensão. Ela não desbloqueia nenhum dos dadosidentificados por elementos na dimensãoselecionada.

Segurança, Designações de Segurança deElementos

Abre a caixa de diálogo Designações de segurançado TM1, a partir da qual é possível designarprivilégios de segurança para cada elemento nadimensão. Você deve ter privilégios Write para adimensão selecionada para usar esta opção.

Visualizações do CuboAs opções a seguir ficam disponíveis no Menu Visualizações do Cubo quando você seleciona um grupo devisualizações no Server Explorer.

Opção Descrição

Criar Nova Visualização Abre a janela do Cube Viewer, a partir da qual épossível configurar uma nova visualização.

CubeViewAs opções a seguir ficam disponíveis no Menu Visualização do Cubo quando você seleciona umavisualização no Server Explorer.

62 IBM Planning Analytics: Referência do TM1

Opção Descrição

Navegar Abre a visualização na janela do Cube Viewer.

Navegar no Excel Abre a visualização no In-Spreadsheet Browser.

Exportar como Dados de Texto Abre a janela Extração de Visualização, a partir daqual é possível exportar a visualização como umarquivo delimitado por vírgula (.cma).

Publicar Esta opção fica disponível quando você selecionauma visualização particular. Escolha esta opçãopara converter uma visualização de particular empública. As visualizações públicas estãodisponíveis para todos os clientes com privilégiosRead para o cubo que contém a visualização.

Excluir Visualização Exclui a visualização selecionada. Observe queesta opção exclui apenas a configuração devisualização, e não os dados contidos navisualização.

SubconjuntosAs opções a seguir ficam disponíveis no Menu Subconjuntos quando você seleciona um grupo desubconjuntos no Server Explorer.

Opção Descrição

Inserir Novo Subconjunto Abre a janela do Editor de Subconjunto, a partir daqual é possível definir um novo subconjunto.

SubconjuntoAs opções a seguir ficam disponíveis no Menu Subconjunto quando você seleciona um subconjunto noServer Explorer.

Opção Descrição

Abrir Abre o subconjunto selecionado na janela do Editorde Subconjunto.

Criar Novo Subconjunto Abre a janela do Editor de Subconjunto para adimensão à qual o subconjunto selecionadopertence. É possível definir um novo subconjuntonesta janela

Publicar Esta opção fica disponível quando você selecionaum subconjunto particular. Escolha esta opçãopara converter um subconjunto de particular empúblico. Os subconjuntos públicos estãodisponíveis para todos os clientes com privilégiosRead para a dimensão que contém o subconjunto.

Capítulo 1. Windows e Caixas de Diálogo 63

Opção Descrição

Excluir Subconjunto Exclui o subconjunto selecionado. Observe queesta opção exclui apenas a configuração dosubconjunto, e não exclui os elementos contidosno subconjunto da dimensão-pai.

ReplicaçõesAs opções a seguir ficam disponíveis no Menu Replicações quando você seleciona um grupo dereplicações no Server Explorer.

Opção Descrição

Inserir Nova Replicação Abre a caixa de diálogo Criar Objeto de Replicaçãodo Servidor, a partir da qual é possível estabeleceruma nova conexão de replicação.

ReplicaçãoAs opções a seguir ficam disponíveis no Menu Replicação quando você seleciona uma replicação noServer Explorer.

Opção Descrição

Sincronizar Dados Sincroniza dados entre os servidores de destino ede origem.

Modificar Parâmetros de Replicação Abre a caixa de diálogo Criar Objeto de Replicaçãodo Servidor, a partir da qual é possível modificar osparâmetros para a conexão de replicaçãoselecionada.

Excluir Replicação Exclui a conexão de replicação selecionada.

Exibir Tarefas de Organização de ProcessosEnvolvidas

Abre a caixa de diálogo Selecionar Tarefas deOrganização de Processos para Modificação. Estacaixa de diálogo pode ser usada para remover areplicação selecionada de quaisquer tarefas deorganização de processos associadas.

Cubo ReplicadoAs opções a seguir ficam disponíveis no Menu Cubo quando você seleciona um cubo replicado no ServerExplorer.

Opção Descrição

Replicar Abre a caixa de diálogo Replicar Cubo para o cuboselecionado, a partir da qual é possível definirparâmetros de replicação e replicar o cubo.

Sincronizar Dados Sincroniza dados entre o cubo replicado e oservidor de origem.

ProcessosAs opções a seguir ficam disponíveis no Menu Processos quando você seleciona um grupo de processosno Server Explorer.

64 IBM Planning Analytics: Referência do TM1

Opção Descrição

Criar Novo Processo Abre o Turbo Integrator, a partir do qual é possívelcriar um novo processo.

Designações de Segurança Abre a caixa de diálogo Designações de segurançado TM1, a partir da qual é possível configurarprivilégios de segurança para processos noservidor atual.

ProcessoAs opções a seguir ficam disponíveis no menu Processo quando você seleciona um processo no ServerExplorer.

Opção Descrição

Exibir Tarefas de Organização de ProcessosEnvolvidas

Abre a caixa de diálogo Selecionar Tarefas deOrganização de Processos para Modificação. Estacaixa de diálogo pode ser usada para remover oprocesso selecionado de quaisquer tarefas deorganização de processos associadas.

Editar Processo Abre o processo selecionado em uma janela doTurbo Integrator.

Executar Processo Executa o processo selecionado.

Visualizar Visualiza um processo em modo somente leitura.Permite que os membros dos grupos DataAdmin eSecurityAdmin visualizem um processo em modosomente leitura quando a opção Acesso deSegurança é ativada para o processo.

Acesso de Segurança Controla se um processo pode modificar dados desegurança no script do processo. Apenas osmembros dos grupos ADMIN e SecurityAdminpodem definir esta opção. Defina esta opção emuma base processo a processo.

Excluir Processo Exclui o processo selecionado.

Usar Ambiente de Simulação Ativo Configura o processo para usar os dados noambiente de simulação ativo atual em vez dedados base, ao executar o processo. O ambientede simulação ativo é determinado por qualambiente de simulação está selecionado no CubeViewer.

Tarefas de organização de processosAs opções a seguir ficam disponíveis no Menu Tarefas de Organização de Processos quando vocêseleciona um grupo de tarefas de organização de processos no Server Explorer.

Capítulo 1. Windows e Caixas de Diálogo 65

Opção Descrição

Criar Nova Tarefa de Organização de Processos Abre o Assistente de Configuração de Tarefa deOrganização de Processos, a partir do qual épossível planejar uma nova tarefa de organizaçãode processos.

Designações de Segurança Abre a caixa de diálogo Designações de segurançado TM1, a partir da qual é possível configurarprivilégios de segurança para as tarefas deorganização de processos no servidor atual.

Tarefa de organização de processosAs opções a seguir ficam disponíveis no menu Tarefa de Organização de Processos quando vocêseleciona uma tarefa de organização de processos individual no Server Explorer.

Opção Descrição

Ativar Programação Esta opção alterna o status de execução de tarefasde organização de processos. Selecione esta opçãopara ativar a tarefa de organização de processosselecionada para execução. É exibido um vistopróximo a esta opção quando uma tarefa deorganização de processos é ativada.

Selecione esta opção novamente para desativar atarefa de organização de processos selecionada.

Editar Abre a tarefa de organização de processos paraedição no Assistente de Configuração de Tarefa deOrganização de Processos.

Você deve desativar uma tarefa de organização deprocessos antes da edição.

Executar Executa a tarefa de organização de processosselecionada.

Excluir Exclui a tarefa de organização de processosselecionada.

Você deve desativar uma tarefa de organização deprocessos antes da exclusão.

Menu EditarAs opções a seguir estão disponíveis no Menu Editar no Server Explorer.

Opção Descrição

Copiar Copia o rótulo do objeto selecionado para a Áreade Transferência.

Excluir Exclui o objeto selecionado do servidor.

Menu VisualizarAs opções a seguir estão disponíveis no Menu Visualizar no Server Explorer.

66 IBM Planning Analytics: Referência do TM1

Opção Descrição

Barra de Status Oculta ou exibe a barra de status na parte inferiorda janela do Server Explorer. Um visto indica que abarra de status é exibida.

Barra de Ferramentas Oculta ou exibe a barra de ferramentas na partesuperior da janela do Server Explorer. Um vistoindica que a barra de ferramentas é exibida.

Janela Propriedades Oculta ou exibe a área de janela Propriedades doServer Explorer. Um visto indica que a área dejanela Propriedades é exibida.

Objetos:

Aplicativos

Cubos

Dimensões

Replicações

Processos

Tarefas de organização de processos

Oculta ou exibe qualquer um dos objetos na áreade janela esquerda (área de janela em Árvore) doServer Explorer.

Um visto indica que o objeto selecionado é exibido.

Reduzir Todos os Filhos Reduz a árvore na área de janela esquerda doServer Explorer para ocultar todos os filhos de umobjeto selecionado.

Expandir Todos os Filhos Expande a árvore na área de janela esquerda doServer Explorer para mostrar todos os filhos de umobjeto selecionado.

Exibir Objetos de Controle Oculta ou exibe os cubos de controle e dimensõesna área de janela esquerda da janela do ServerExplorer. Um visto indica que os objetos decontrole são exibidos.

Atualizar Atualiza a exibição hierárquica atual de objetos naárea de janela esquerda do Server Explorer.

Editor de Subconjunto

Área de Janela Elementos

Exibe uma representação hierárquica de todos os elementos no subconjunto que você está visualizando.

Área de Janela Propriedades

Exibe as propriedades dos elementos selecionados na área de janela Elementos do Editor deSubconjunto. Quando você seleciona um elemento consolidado, esta área de janela exibe os nomes, tipose pesos de todos os filhos do elemento consolidado.

Capítulo 1. Windows e Caixas de Diálogo 67

Nota: Ao visualizar um conjunto de dimensões excepcionalmente grande no Editor de Subconjunto com aárea de janela Propriedades ativada, você talvez tenha problemas de desempenho. Isso pode acontecerquando uma consolidação é selecionada na área de janela Elementos e o TM1 precisa exibir a lista inteirade propriedades e elementos relacionados na área de janela Propriedades.

Se estiver trabalhando com conjuntos de dimensões grandes, poderá ser necessário desativar a área dejanela Propriedades. Para desativar a área de janela Propriedades, clique na opção Janela Propriedadesno Menu Visualizar para remover o visto próximo à opção.

Menu Subconjunto

Item de Menu Descrição

Abrir Abre a caixa de diálogo Salvar subconjunto doTM1. Selecione um subconjunto da lista e cliqueem OK para abrir o subconjunto.

Recarregar Recarrega a definição de subconjunto atual.

Salvar Salva a definição de subconjunto atual.

Salvar como Salva a definição de subconjunto atual com umnovo nome.

Fechar Fecha o Editor de Subconjunto.

Menu Editar

Item de Menu Descrição

Desfazer Desfaz a última ação.

Refazer Restaura a última ação "desfazer".

Recortar Recorta os elementos selecionados para a Área deTransferência.

Copiar Copia os elementos selecionados para a Área deTransferência.

Copiar Nome Exclusivo Copia o nome de elemento, como uma expressãoMDX, para a Área de Transferência. O nome deelemento copiado pode então ser colado na Janelade Expressão do Editor de Subconjunto.

Colar Cola o conteúdo da Área de Transferência no pontode inserção atual.

Colar Acima Cola o conteúdo da Área de Transferência acimado elemento selecionado no momento.

Colar Abaixo Cola o conteúdo da Área de Transferência abaixodo elemento selecionado no momento.

68 IBM Planning Analytics: Referência do TM1

Item de Menu Descrição

Inserir Subconjunto Abre uma nova instância do Editor de Subconjuntopara que seja possível incluir uma consolidaçãodefinida pelo usuário no subconjunto atual.

Manter Mantém apenas os elementos selecionados nomomento na área de janela Elementos do Editor deSubconjunto e remove os demais elementos.

Excluir Remove os elementos selecionados da definiçãode subconjunto atual.

Selecionar Elementos, Horizontal Copia os elementos selecionados para a Área deTransferência em uma orientação horizontal, paraque eles possam ser colados em uma linha daplanilha.

Selecionar Elementos, Vertical Copia os elementos selecionados para a Área deTransferência em uma orientação vertical, paraque eles possam ser colados em uma coluna daplanilha.

Classificar, Decrescente Classifica todos os elementos na área de janelaElementos em ordem alfabética decrescente.

Classificar, Crescente Classifica todos os elementos na área de janelaElementos em ordem alfabética crescente.

Classificar, Hierarquia Classifica todos os elementos na área de janelaElementos em ordem hierárquica, portanto, épossível ver o relacionamento pai/filho deelementos.

Classificar, Índice Crescente Classifica todos os elementos na área de janelaElementos em ordem crescente, de acordo com ovalor de índice de elemento.

Classificar, Índice Decrescente Classifica todos os elementos na área de janelaElementos em ordem decrescente, de acordo como valor de índice de elemento.

Fazer Drill Down Exibe os filhos imediatos de elementosselecionados.

Sintetização Exibe os pais imediatos de elementosselecionados.

Expandir Elemento Exibe todos os filhos de elementos selecionados.

Reduzir Elemento Reduz as consolidações selecionadas para que osfilhos não sejam exibidos.

Capítulo 1. Windows e Caixas de Diálogo 69

Item de Menu Descrição

Filtrar por, Níveis Abre a caixa de diálogo Filtrar por Nível, a partir daqual é possível selecionar elementos por nível dehierarquia.

Filtrar por, Atributo Abre a caixa de diálogo Filtrar por Atributo, a partirda qual é possível selecionar elementos por valorde atributo.

Filtrar por, Extração de Visualização Permite selecionar apenas os elementos queatendem a uma consulta definida pelo usuário.

Esta opção fica disponível apenas quando vocêabre o Editor de Subconjunto, clicando em umrótulo da dimensão na janela do Cube Viewer.

Filtrar por, Curinga Permite selecionar elementos que correspondem auma sequência de procura definida pelo usuário.

Selecionar Alias Abre a caixa de diálogo Aliases do TM1, a partir daqual é possível selecionar um alias definidoanteriormente, pelo qual os nomes de elementosserão exibidos.

Segurança, Reserve Reserva temporariamente o elemento selecionadopara que outros clientes não possam editar dadosidentificados pelo elemento. Você deve terprivilégios Reserve para reservar um elemento.

Segurança, Release Libera um elemento reservado para que outrosclientes possam editar dados identificados peloelemento. Você deve ter privilégios Reserve paraliberar um elemento.

Segurança, Lock Bloqueia permanentemente o elementoselecionado para que outros clientes não possameditar dados identificados pelo elemento. Vocêdeve ter privilégios Lock para bloquear umelemento.

Segurança, Unlock Desbloqueia o elemento selecionado para queoutros clientes possam editar dados identificadospelo elemento. Você deve ter privilégios Adminpara desbloquear uma dimensão.

Editar Formatos do Elemento Abre a planilha Editar formatos de elementos, naqual é possível definir estilos de exibição parafatias dinâmicas e Planilhas da web do TM1.

Menu Visualizar

70 IBM Planning Analytics: Referência do TM1

Item de Menu Descrição

Barras de Ferramentas Abre um submenu que permite ativar ou desativara exibição de todas as barras de ferramentas doEditor de Subconjunto.

Um visto indica que uma barra de ferramentas éexibida.

Barra de Status Oculta ou exibe a Barra de Status na parte inferiorda janela do Editor de Subconjunto.

Um visto indica que a Barra de Status é exibida.

Janela Propriedades Oculta ou exibe a área de janela Propriedades.

Um visto indica que a área de janela Propriedadesé exibida.

Janela de Expressão Oculta ou exibe a Janela de Expressão na parteinferior do Editor de Subconjunto. Um visto indicaque a Janela de Expressão é exibida.

Expandir Acima Esta opção determina como as consolidações sãoexpandidas e reduzidas ao fazer drill down.

Quando esta opção for ativada, os filhos de umaconsolidação serão expandidos acima daconsolidação ao fazer drill down.

Quando esta opção for desativada, os filhos deuma consolidação serão expandidos abaixo daconsolidação ao fazer drill down.

Quando a opção Expandir Acima for ativada em umsubconjunto, fazer drill down em umaconsolidação no Cube Viewer, no In-SpreadsheetBrowser ou na fatia resultará no seguintecomportamento:

Se a opção for ativada em um subconjunto delinhas, fazer drill down em uma consolidaçãoexibirá os filhos acima da consolidação.

Se a opção for ativada em um subconjunto decolunas, fazer drill down em uma consolidaçãoexibirá os filhos à esquerda da consolidação.

Atualizar Atualiza a exibição da área de janela Elementos.

Menu Ferramentas

Item de Menu Descrição

Registrar Expressão Inicia o registro de ações no Editor deSubconjunto.

Capítulo 1. Windows e Caixas de Diálogo 71

Item de Menu Descrição

Parar Registro Para o registro de suas ações no Editor deSubconjunto.

Ao parar a gravação, o TM1 gera uma expressãoMDX que pode ser salva para criar um subconjuntodinâmico.

Limpar Expressão Limpa o conteúdo da Janela de Expressão.

Filtrar Abre a caixa de diálogo Filtrar Subconjunto, quepermite criar um subconjunto dinâmico com baseem valores do cubo.

Caixa de Diálogo de AliasPara visualizar os elementos de subconjunto atuais por aliases designados, selecione um nomealternativo da lista e clique em OK.

Caixa de diálogo Opções do TM1As opções a seguir podem ser configuradas na caixa de diálogo Opções do TM1.

Parâmetros de Login

Opção Descrição

Host Administrativo Insira o nome do computador de seu HostAdministrador. O Host Administrador é ocomputador no qual o Servidor Administrativo éexecutado.

Login Integrado Ative esta opção para usar o Login Integrado.

Desative essa opção para usar a segurança delogin padrão do TM1.

O padrão é desativado.

Servidor Local

Opção Descrição

Diretório de Dados do Servidor Local Insira o caminho completo para o Diretório deDados do Servidor Local, ou clique no botãoNavegar associado para navegar para o diretório.Também é possível clicar na seta para baixo paraselecionar de uma lista de diretórios acessadosrecentemente.

72 IBM Planning Analytics: Referência do TM1

Opção Descrição

Conectar ao Servidor Local ao Inicializar Altere essa opção para desligado para iniciar oTM1 Perspectives/TM1 Architect sem ativar oservidor local.

O padrão é ativado.

Nota: O servidor local é suportado apenas em versões de 32 bits do TM1. O diretório de dados padrãopara o servidor local é Pdata. Se você estiver executando uma versão de 64 bits do TM1, o servidor deamostra Sdata, que é instalado por padrão com o servidor TM1, conterá os mesmos objetos e dados queos localizados no Pdata.

Segurança da Camada de Transporte do Servidor

Opção Descrição

Autoridade de Certificação O caminho completo do arquivo da autoridade decertificação que emitiu o certificado do ServidorAdministrativo.

Lista de Revogação de Certificado O caminho completo do arquivo de revogação docertificado emitido pela autoridade de certificaçãoque originalmente emitiu o certificado do ServidorAdministrativo. Um arquivo de revogação decertificado existirá apenas no caso de umcertificado ter sido revogado.

ID do Certificado O nome do principal para o qual o certificado doServidor Administrativo é emitido.

Usar Repositório de Certificados Selecione essa opção se deseja que o certificadode autorização de certificação que emitiuoriginalmente o certificado do servidoradministrativo seja exportado do armazenamentode certificados do Windows no tempo de execução.

Quando essa opção for selecionada, você tambémdeverá definir um valor para o ID do Certificado deexportação na caixa de diálogo Opções do TM1.

Exportar ID do Certificado A chave de identidade usada para exportar ocertificado de autorização de certificação, queoriginalmente emitiu o certificado do ServidorAdministrativo, a partir do armazenamento decertificados.

Este parâmetro será necessário apenas se vocêativar a opção Usar Armazenamento deCertificados.

Capítulo 1. Windows e Caixas de Diálogo 73

Caixa de Diálogo Consulta do Log de TransaçõesA caixa de diálogo Consulta do log de transações permite consultar e visualizar registros no log detransações do TM1 (Tm1s.log). A caixa de diálogo contém campos para quatro parâmetros que devem serespecificados para executar uma consulta.

Opção Descrição

Horário de Início A data/hora de início para a consulta.

O TM1 faz consultas em todos os registrosgravados no log de transações nesta data/hora ouapós ela. Você deve usar o formato MM/DD/AAAAHH:MM:SS para especificar um horário de início.

A data/hora de início padrão é 00:01:00 GMT nadata de ativação da consulta.

Horário de Encerramento A data/hora de encerramento para a consulta.

O padrão é __/__/____ __:__:__, que é uma data/hora de abertura-encerramento. Ao aceitar opadrão, o TM1 fará consultas em todos os registrosaté o horário de ativação da consulta.

Cliente(s) O(s) cliente(s) no(s) qual(is) a consulta é aplicada.É possível consultar em um único cliente ou emtodos os clientes. O padrão é todos os clientes (*).

Cubos(s) O(s) cubo(s) no(s) qual(is) a consulta é aplicada. Épossível consultar em um único cubo ou em todosos cubos. O padrão é todos os cubos (*).

Para definir qualquer um dos parâmetros acima, clique na seta próxima ao campo apropriado.

Caixa de Diálogo Resultados da Consulta do Log de TransaçõesA caixa de diálogo Resultados da Consulta do Log de Transações apresenta o resultado de uma consultado log de transações em formato de tabela. A tabela contém as seguintes colunas para cada registroretornado pela consulta:

Coluna Descrição

LOGTIME O horário em que um valor foi editado.

REPLICATIONTIME O horário em que um valor foi replicado.

CLIENT O nome do cliente que gravou o valor.

OLDVALUE Valor dos dados antes da edição.

NEWVALUE Valor dos dados após a edição.

CUBENAME O cubo no qual o valor foi gravado.

74 IBM Planning Analytics: Referência do TM1

Coluna Descrição

CHAVE N Existem várias colunas Chave N na tabela, cadacoluna representando os elementos queidentificam o valor.

A caixa de diálogo Resultados da Consulta do Log de Transações inclui três menus.

O Menu Arquivo contém um único item: Sair.

O Menu Ajuda contém um único item para abrir a ajuda para a caixa de diálogo.

O Menu Editar contém os seguintes itens:

Item de Menu Descrição

Copiar Copia uma única célula selecionada para a área detransferência.

Ocultar Suprime a exibição do(s) registro(s) selecionado(s)na tabela.

É possível clicar em Atualizar para restaurar aexibição de registros ocultos.

Classificar Abre um submenu a partir do qual é possívelescolher colunas para classificar ou uma ordem declassificação a ser aplicada.

Localizar Abre a caixa de diálogo Localizar/Substituir, quepermite procurar a tabela atual.

Selecionar Seleciona o(s) registro(s) realçado(s)

Desmarcar Desmarca o(s) registro(s) realçado(s).

Selecionar Tudo Seleciona todos os registros na tabela.

Desmarcar Tudo Desmarca todos os registros na tabela.

Restaurar Restaura o(s) registro(s) realçado(s). Quando umregistro for restaurado, OLDVALUE para o registrosubstituirá NEWVALUE para o registro.

Quando vários registros para um único local docubo forem selecionados, os registros serãorestaurados para OLDVALUE do LOGTIME maisanterior.

Editor do Turbo IntegratorO Editor do Turbo Integrator permite definir processos para importar dados ou metadados de váriasorigens possíveis. O editor é formado por cinco guias, várias das quais são dinâmicas ou contêm subguias.Defina um processo concluindo cada guia em ordem sequencial.

Capítulo 1. Windows e Caixas de Diálogo 75

Menu Arquivo

Item de Menu Descrição

Salvar Salva a definição de processo atual.

Salvar como Salva a definição de processo atual com um novonome.

Executar Executa o processo atual.

Sair Fecha o Editor do Turbo Integrator.

Menu Editar

Item de Menu Descrição

Desfazer Desfaz a última ação de digitação que foiexecutada na subguia de procedimento Prólogo,Metadados, Dados ou Epílogo.

Recortar Recorta o texto selecionado para a Área deTransferência.

Copiar Copia o texto selecionado para a Área deTransferência.

Colar Cola o conteúdo da Área de Transferência nocampo ou célula atual.

Guia Origem de DadosUse a guia Origem de Dados para identificar e acessar a origem da qual você deseja importar dados.

Nota: Ao definir um processo a partir do cliente do TM1, o caminho para uma origem de dados ASCII ouODBC pode ser diferente do caminho usado pelo servidor. Se isto ocorrer, o processo falhará. Paraassegurar que seus processos funcionem corretamente:

• Defina processos envolvendo origens de dados Open Database Connectivity no servidor real, no qual oprocesso deve residir. Não use um cliente remoto para definir tal processo.

• Utilize o Ambiente de Rede do Windows para definir o caminho para origens de dados ASCII. Istoassegura que o caminho não seja ambíguo para clientes e servidores.

Os campos e opções disponíveis na guia Origem de Dados variam de acordo com o Tipo de Origem deDados selecionado. A tabela a seguir descreve os campos e opções necessários para cada origem.

Open Database ConnectivityDefine uma origem de dados Open Database Connectivity:

Campos Descrição

Nome da Origem de Dados O caminho completo para a origem de dados OpenDatabase Connectivity.

76 IBM Planning Analytics: Referência do TM1

Campos Descrição

UserName Seu nome de usuário na origem.

Senha Sua senha.

Consulta Uma consulta SQL para extrair dados da origem.

Usar Unicode Clique aqui para usar Unicode para esta origem.

Visualizar Exibe os primeiros 10 registros.

TextoDefine uma origem de dados ASCII ou de Texto:

Campos Descrição

Nome da Origem de Dados O caminho completo para o arquivo de texto deorigem. Para assegurar que este caminho sejareconhecido no cliente e no servidor, clique nobotão Navegar e use o Ambiente de Rede paradefinir o caminho.

Nome da Origem de Dados no Servidor Ao criar um novo processo, o Turbo Integratorpresume que o nome da origem de dados noservidor seja idêntico ao nome da origem de dadosusado para criar o processo.

Se o nome da origem de dados no servidor fordiferente da origem de dados local usada para criaro processo, insira o caminho completo para oarquivo da origem de dados no servidor.

Tipo de Delimitador Se a origem usar um caractere para definir ascolunas, selecione Delimitado, em seguida,escolha o caractere na caixa Delimitador.

Largura Ajustada Se a origem usar uma largura fixa, selecioneLargura Fixa, em seguida, use o botão DefinirLarguras de Campo para abrir a caixa de diálogoVisualização para definir larguras da coluna.

Caractere Aspas Especifique o caractere aspas usado nos dados deorigem.

Número de registros de título Se os registros de título forem expandidos paramais de uma linha, insira o número de linhas aqui.Caso contrário, deixe este campo em branco.

Delimitadores de Número Insira o caractere a ser usado para SeparadorDecimal e Separador de Milhares na origem.

ODBODefinir uma origem de dados ODBC estabelecida para um banco de dados relacional que pode serconstruído utilizando o painel de controle do Microsoft Windows Data Sources:

Capítulo 1. Windows e Caixas de Diálogo 77

Cubo ou DimensãoSelecione o tipo de importação a ser feita:

Campos Descrição

Provedor de ODBO Para importar um cubo ODBO, utilize o menususpenso para selecionar OLE DB para origem dedados OLAP, inclusive para usar o MicrosoftAnalysis Services.

Local de ODBO Insira o local do arquivo para este provedor.

Ao importar uma dimensão, deixe este campo embranco.

Origem de Dados ODBO Insira o nome designado por seu administrador aum conjunto de catálogos em um local específico.Nos Microsoft Analysis Services, esse é o nome deum servidor registrado.

Catálogo ODBO O nome designado por seu administrador a umacoleção específica de bancos de dados (Cubos,Dimensões e outros objetos). Para o MAS, este é onome do banco de dados.

ID do Usuário de ODBO Um nome de usuário válido para o banco de dados.

Senha de ODBO Uma senha válida nesta origem de dados.

Parâmetros de Conexão Adicionais Insira aqui parâmetros adicionais requeridos pelaorigem ODBO. Delimite os parâmetros com pontose vírgulas.

Ao importar uma dimensão, deixe este campo embranco.

Consulta MDXDefine uma consulta baseada em MDX:

Campos Descrição

Guia Conexão Insira as informações de conexão necessárias. Osparâmetros de conexão são específicos dofornecedor.

Clique em Conectar. Se sua conexão for bem-sucedida, a guia Consulta MDX ficará disponível.

Guia Consulta MDX Insira a consulta MDX nesta guia ou cole umaconsulta MDX ativa de outro aplicativo.

SAPDefine a origem de dados SAP RFC:

78 IBM Planning Analytics: Referência do TM1

Guia Campo Descrição

Conexão Sistema O nome do sistema SAP ao qualvocê deseja conectar-se.

Se o nome do sistema incluirespaços, coloque o nome entreaspas duplas.

Clientes Um número que corresponde àversão da UI no servidor SAP. Porexemplo, 498.

Usuário Seu nome de usuário no sistemaSAP.

Senha Sua senha no sistema SAP.

Idioma O idioma que você deseja usarpara efetuar logon no sistemaSAP.

Todas as descrições textuais sãoretornadas no idiomaespecificado, se disponível.

O parâmetro de idioma é umaabreviação de duas letras, porexemplo, EN=English.

Parâmetros de ConexãoAdicionais

Insira outros parâmetros evalores usados para conectar-seao sistema SAP BW.

Tamanho do Pacote Um valor que limita o número delinhas em cada pacote enviadodo SAP para o TM1. Um tamanhodo pacote menor resultará emmaior tráfego de rede compacotes pequenos, enquanto umtamanho do pacote maiorresultará em menor tráfego derede, mas com pacotes maiorespor transmissão.

O tamanho do pacote padrão,que também é o tamanhomínimo do pacote, é 50.000.

Info Cube

Área Campo Descrição

Info Cube Mostrar Nomes Técnicos do SAP Para usar nomes técnicos,selecione esta caixa de seleção.Deixe esta caixa desmarcadapara exibir por nome descritivo.

Capítulo 1. Windows e Caixas de Diálogo 79

Área Campo Descrição

Selecionar InfoCube do qualCarregar

Use a opção para indicar oInfoCube do qual você desejaimportar dados.

Selecionar o Cubo do TM1 para oCarregamento

Para importar o SAP InfoCubepara um cubo do TM1 existente,clique nesta opção e selecione ocubo que receberá os dados doSAP InfoCube.

Selecionar o Cubo do TM1 para oCarregamento

Para criar um novo cubo do TM1ao importar o InfoCube, insira umnome para o novo cubo do TM1neste campo.

Ação do cubo do TM1 Criar Importa dados e metadados doSAP InfoCube e cria um novocubo em TM1. Use esta opçãosomente quando nenhum doscubos e dimensões sendoimportados existirem no servidor.

Recriar Destrói um cubo do TM1existente e o reconstrói usandodados e metadados do SAPInfoCube. Use esta opçãosomente quando o cubo e asdimensões do TM1 existirem evocê desejar substituí-los pornovas estruturas e dados do SAPInfoCube.

Atualizar Importa dados de um cubo SAPInfoCube existente e os insereem um cubo do TM1 existente.Esta opção não altera a estruturade cubos e dimensões noservidor.

Os processos que especificamNenhuma ção não afetam osdados ou metadados dos cubosdo TM1.

Use esta opção para testar edepurar processos ou para definirsuas próprias operaçõescustomizadas.

80 IBM Planning Analytics: Referência do TM1

Área Campo Descrição

Ação de Dados Armazenar Valores Esta opção grava valores decélula do SAP InfoCube para ocubo do TM1.

Se você escolher essa opçãoquando a opção Atualizar cuboestiver selecionada, os valoresexistentes do cubo do TM1 serãosobrescritos pelos valoresimportados do InfoCube.

Acumular Valores A opção Acumular valorespermite agregar valores do Cubodo TM1 existente com valoresimportados do SAP InfoCube.

Porção Zerada do Cubo deDestino

Esta opção fica disponívelquando você seleciona a açãoAtualizar Cubo.

Selecione esta opção se desejardefinir todos os pontos de dadosem uma visualização do cuboespecificada como zero.

Para definir a visualização docubo para ser zerada, você pode:

• Clicar na lista Visualização paraselecionar uma visualizaçãoexistente para ser zerada.

• Clicar no botão Mais próximo àlista de opções Visualizaçãopara definir uma novavisualização para ser zerada.

Habilitar Criação de Log de Cubos Para registrar mudanças emdados do cubo ao importar de umSAP InfoCube, selecione estaopção.

Para desativar a criação de log aoimportar, limpe esta opção.

Nota: A desativação da criaçãode log acelera o carregamento ea atualização de dados, mastorna impossível recuperaratualizações em caso de umafalha do sistema.

Guia Características

Campo Descrição

Selecionar Hierarquias Identifique as hierarquias naorigem de dados.

Identifique as hierarquias naorigem de dados.

Capítulo 1. Windows e Caixas de Diálogo 81

Campo Descrição

Data de Avaliação A data em que todos os atributosdo SAP dependentes de temposerão importados para o TM1como estiverem na dataespecificada. Os atributos quenão são dependentes de temposão importados conformeexistem no momento daexecução do processo.

Se essa data for desmarcada,todos os atributos do SAP serãoimportados como estão na datada execução do processo doTM1.

Não importe uma hierarquia comintervalos.

A data em que todos os atributosdo SAP dependentes de temposerão importados para o TM1como estiverem na dataespecificada. Os atributos quenão são dependentes de temposão importados conformeexistem no momento daexecução do processo.

Se essa data for desmarcada,todos os atributos do SAP serãoimportados como estão na datada execução do processo doTM1.

Não importe uma hierarquia comintervalos.

Dimensão do TM1 Selecione a dimensão existentedo TM1 que é mapeada para estacaracterística.

Deixe esse campo vazio se vocênão desejar importar acaracterística para o cubo doTM1.

Selecione a dimensão existentedo TM1 que é mapeada para estacaracterística.

Deixe esse campo vazio se vocênão desejar importar acaracterística para o cubo doTM1.

Ação de Dimensão do TM1 Criar Crie uma nova dimensão do TM1a partir da característica do SAP.

Recriar Recrie totalmente uma dimensãodo TM1 existente com elementosimportados da característica doSAP.

Atualizar Atualizar uma estrutura dadimensão existente, incluindonovos elementos importados dacaracterística do SAP.

AsIs Processe a característica pormeio do TurboIntegrator, masnão use a característica para criarou modificar quaisquerdimensões do TM1.

Use esta opção para testar edepurar processos ou paramanipular a característica na guiaAvançado do Turbo Integrator.

82 IBM Planning Analytics: Referência do TM1

Campo Descrição

Não Carregar Não importe a característica doSAP para TM1. A característica étotalmente excluída quando oSAP InfoCube é processado pormeio do Turbo Integrator.

Selecionar Atributos Atributos da Característica Define os atributos para estaorigem de dados.

Texto Identifica atributos com um valorde sequência.

Numérico Identifica atributos com um valornumérico.

Alias Identifica atributos que sãonomes alternativos para asdimensões às quais eles estãoassociados. Um alias dedimensão deve ser exclusivoentre os demais aliases dedimensão ou nomes da dimensãoreais

Selecionar Key Figure Selecione cada key figure a serimportada para o TM1.

Caso as key figures sejammapeadas para uma dimensãodo TM1 existente, clique nacoluna Dimensão do TM1 eselecione a dimensão quecorresponde às key figures.

Selecione cada key figure a serimportada para o TM1.

Caso as key figures sejammapeadas para uma dimensãodo TM1 existente, clique nacoluna Dimensão do TM1 eselecione a dimensão quecorresponde às key figures.

Restrições Incluir Restrições Crie uma nova restrição para estacaracterística.

Característica do SAP Selecione a característica na qualdefinir uma restrição.

Sinal Indica se a restrição é inclusivaou exclusiva.

Escolha Incluir se desejar que oprocesso do Turbo Integratorimporte apenas os valores queestão contidos na definição derestrição.

Escolha Excluir se desejar que oprocesso do Turbo Integratorimporte apenas os valores queestão fora da definição derestrição.

Capítulo 1. Windows e Caixas de Diálogo 83

Campo Descrição

Opção O Operador usado para arestrição.

Existem oito operadores paraescolha, conforme descrito natabela a seguir.

Operadores de Restrição de Opção

Operador Descrição

= A restrição identifica apenas características iguaisao Valor Baixo especificado.

< > A restrição identifica apenas característicasmenores ou maiores que o Valor Baixoespecificado.

< A restrição identifica apenas característicasmenores que o Valor Baixo especificado.

> A restrição identifica apenas característicasmaiores que o Valor Baixo especificado.

< = A restrição identifica apenas característicasmenores ou iguais ao Valor Baixo especificado.

> = A restrição identifica apenas característicasmaiores ou iguais ao Valor Baixo especificado.

[ ] A restrição identifica apenas características queestão entre o Valor Baixo e o Valor Altoespecificados, inclusive.

] [ A restrição identifica apenas características queestão fora do Valor Baixo e do Valor Altoespecificados, inclusive.

Existem oito operadores para escolha, conforme descrito na tabela a seguir.

Insira um valor baixo para a restrição na coluna Valor Baixo.

Insira um valor alto para a restrição, se necessário, na coluna Valor Alto.

Nota: As restrições não são validadas por meio do Turbo Integrator. Você deve assegurar que asrestrições inseridas sejam precisas e válidas para os dados do SAP.

Segurança

Campo Descrição

Importar Segurança Indica que as designações de segurança para estacaracterística devem ser importadas.

84 IBM Planning Analytics: Referência do TM1

Campo Descrição

Consolidação Superior Cria uma consolidação de nível superior para adimensão do TM1 criada usando o nome inseridoaqui.

Fazer Textos Únicos Para gerar aliases exclusivos para todos oselementos criados a partir da característica doSAP, selecione esta opção. Quando você importauma característica do SAP para o TM1, os valorescaracterísticos se tornam elementos de dimensãodo TM1 enquanto as descrições de valor do SAPtornam-se aliases do elemento TM1. No TM1,todos os aliases de elementos em uma dimensãodevem ser exclusivos. Se um processo do TurboIntegrator tentar designar o mesmo alias a várioselementos, o processo gerará erros e a criação doalias falhará.

Quando a opção Tornar textos exclusivos forselecionada, o TM1 examinará as descrições doSAP que são importadas e convertidas em aliasesdo TM1. Se o TM1 detectar que vários valoresusam descrições idênticas, o TM1 anexará o nomedo valor à descrição, para gerar alias exclusivos.

Se Tornar Textos Exclusivos não for marcada,nenhum dado de SAP_Text será buscado.

Quando Tornar textos exclusivos não formarcado, será possível incluirDataSourceSAPUsingTexts=1; no prólogo paraimportar os valores de atributo do alias.

Consulte a função AttrPutS para obter o mesmocomportamento usando um script do TI.

Data de Avaliação Todos os valores de características que existiamentre a data selecionada e a data da execução doprocesso serão importados para o TM1. Quandonão houver uma data de avaliação especificada, opadrão será a data da execução do processo doTurbo Integrator.

Tabela do SAP

Campo Descrição

Tabela do SAP Indica que a origem de dados é uma consulta detabela do SAP.

Nome da Tabela Nome da tabela do SAP a ser usada.

Sequência de Filtros Uma sequência de filtros SQL a ser usada nacláusula WHERE quando a instrução SQL SELECTgerada pelo Turbo Integrator for executada natabela do SAP.

Capítulo 1. Windows e Caixas de Diálogo 85

Tabela ODS

Campo Descrição

Tabela ODS Usado para exportar dados do TM1 para umatabela ODS que pode, então, ser usada paraimportar dados por meio de um SAP Infocube.

Configuração de ODS Define os detalhes da tabela ODS.

Navegar Selecione a visualização do TM1 a ser usada comoa origem de dados.

Mostrar Nomes Técnicos Para usar nomes técnicos, selecione esta caixa deseleção. Deixe esta caixa desmarcada para exibirpor nome descritivo.

Selecionar Tabela ODS Selecione a tabela ODS para a qual exportar.

Colunas As colunas podem ser características ou númerosprincipais do SAP. Você deve estar familiarizadocom a estrutura da tabela ODS para saber quaiscolunas são características e quais são númerosprincipais; o Turbo Integrator não diferencia tiposde colunas da tabela ODS.

Você deve estar ciente dos seguintes detalhes aomapear dimensões para características:

• Você não precisa mapear uma dimensão paracada coluna de característica na tabela ODS.Algumas colunas poderão não ter uma dimensãocorrespondente do TM1 quando o mapeamentofor concluído. Neste caso, qualquer coluna decaracterística que não foi mapeada ficará vaziaquando a exportação estiver concluída.

• Não é necessário mapear uma dimensão únicado TM1 para diversas colunas da tabela decaracterísticas ODS. A interface com o usuário doTurbo Integrator não impede que você faça isso,mas esse tipo de mapeamento resultará emvalores de coluna redundantes na tabela ODS.

• Ao mapear uma dimensão de títulos dasvisualizações do TM1 para uma característica,caso a dimensão de título não use umsubconjunto nomeado, apenas o últimoelemento no subconjunto de títulos nãonomeado atual será exportado para a tabelaODS. Se a dimensão de título usar umsubconjunto nomeado, todos os elementos desubconjunto serão exportados para a tabelaODS.

86 IBM Planning Analytics: Referência do TM1

Campo Descrição

Selecionar Medida A última dimensão na visualização do cubo deorigem será considerada a dimensão das medidas.Ao mapear uma dimensão das medidas para umacoluna da tabela ODS, o botão Selecionar Medidafica disponível.

Selecione um único elemento que seja mapeadodiretamente para a coluna de key figure na tabelaODS

Se sua tabela ODS incluir uma única coluna de keyfigure, você também poderá usar o key figurealternativo.

Dimensão do TM1 Se a tabela ODS incluir uma única coluna de keyfigure, é possível usar a opção _TM1CellValue_para mapear valores de cubo do TM1 para a tabelaODS. Você não pode usar a opção _TM1CellValue_se sua tabela ODS contiver várias colunas de keyfigure.

Para usar essa opção, não mapeie a dimensão dasmedidas do TM1 para a coluna de key figure. Emvez disso, clique na coluna Dimensão do TM1 eselecione _TM1CellValue_.

Ao usar esse método alternativo para mapear osvalores do cubo do TM1, não será necessáriomapear a dimensão das medidas do TM1 paranenhuma coluna ODS.

Moeda

Campo Descrição

Moeda do SAP Usado para importar dados da moeda para umcubo tridimensional novo ou existente no servidor.

Mostrar Nomes Técnicos do SAP Para usar nomes técnicos, selecione esta caixa deseleção. Deixe esta caixa desmarcada para exibirpor nome descritivo.

Inserir Nome do Cubo Insira um cubo tridimensional existente ou insiraum novo nome do cubo.

Da Moeda Selecione a moeda inicial a ser importada do SAP.

A lista de moedas disponíveis reflete as moedasdefinidas no sistema SAP.

Dimensão de Destino Especifique a dimensão do TM1 que receberásequências de moeda do SAP.

Para a Moeda Selecione a segunda moeda a ser importada doSAP.

Capítulo 1. Windows e Caixas de Diálogo 87

Campo Descrição

Tipo de Conversão Selecione o método de conversão a ser usadodurante a conversão da moeda inicial para asegunda moeda.

TM1Usa um cubo ou dimensão do TM1 como a origem de dados.

Campo Descrição

Visualização do Cubo

Subconjunto da Dimensão

Use o botão Navegar para selecionar umavisualização ou Dimensão disponível do TM1 paraser usada como a origem de dados. Clique nobotão Visualização. Em seguida, preencha oscampos nas outras guias.

IBM Cognos Package ConnectorRemovido na v2.0.8 Indica que a origem de dados é um pacote do IBM Cognos publicado e criado pormeio de uma consulta SAP.

Pacote

Campo Descrição

Conexão Define a conexão com estaorigem de dados.

Define a conexão com estaorigem de dados.

Namespace de Autenticação Exibe todos os IBM CognosNamespaces atualmentedisponíveis.

UserID Senha

Pacote Selecionar Pacote Clique no botão Navegar paraselecionar um Pacote depublicação disponível.

Selecione o cubo do TM1 paracarregar

Se estiver importando os dadosdiretamente para um cuboexistente do TM1, insira o nomedo cubo aqui ou use o menususpenso.

Ação de Dados, Ação do Cubo,Ativar Criação de Log do Cubo

Consulte as descrições destescampos no SAP Info Cube acima.

Dimensão

Campo Descrição

Dimensão Pacote Identifique o Pacote a ser usadopara esta dimensão.

88 IBM Planning Analytics: Referência do TM1

Campo Descrição

Dimensão da qual carregar Identifique a dimensão a serusada.

Dimensão para a qual carregar Identifique a dimensão para aqual importar.

Ação de Dimensão do TM1 Consulte a descrição para a guiaCaracterísticas para obterdetalhes.

Recuperar Configurações deSegurança

Use a segurança na dimensão.

Consolidação Superior O nome de uma consolidação denível superior para a dimensãodo TM1 com todos os elementosimportados como filhos daconsolidação.

Selecionar Hierarquias Selecione e mapeie ashierarquias a serem usadasnessa importação e defina comoserão mapeadas para a novadimensão do TM1. Consulte adocumentação do IBM CognosTM1 TurboIntegrator para obterdetalhes.

Selecionar Atributos Selecione os Atributos a seremusados e defina o mapeamento.Consulte a documentação doIBM Cognos TM1 TurboIntegratorpara obter detalhes.

NenhumUsado para incluir um prólogo definido pelo usuário em um processo.

Se a origem de dados para o processo for Nenhum, o Turbo Integrator executará imediatamente oprocedimento do Epílogo após a conclusão do processamento do Prólogo.

Nota: Quando a origem de dados para um processo for Nenhum, os procedimentos de Metadados eDados serão ignorados. Neste caso, todos os scripts para o processo devem ser criados nosprocedimentos do Prólogo ou do Epílogo.

Grade de VisualizaçãoA grade de visualização exibe os primeiros dez registros em sua origem de dados. Use esta grade paraconfirmar se a origem está correta e para ajudar a determinar a estrutura de registros.

Se você alterar a origem de dados, clique em Visualização novamente para atualizar a exibição da grade.

Guia VariáveisA guia Variáveis inclui uma grade e dois botões.

Capítulo 1. Windows e Caixas de Diálogo 89

Grade

Use a grade Variáveis para designar variáveis e identificar o conteúdo de cada coluna em sua origem dedados. A grade Variáveis inclui as seguintes colunas.

Coluna Descrição

ID da Coluna Lista cada campo ou coluna exclusiva identificadaem sua origem de dados. As células nesta colunanão podem ser editadas.

Nome da Variável Contém uma variável gerada automaticamentepara cada coluna em sua origem de dados. Todasas variáveis geradas são chamadas Vn, em que n é0 para a primeira coluna e é incrementada em 1para cada coluna subsequente na origem.

Para designar uma variável diferente, clique nacélula apropriada e insira a nova variável.

Tipo de Variável Contém uma lista para cada coluna em sua origemde dados. Use a lista para especificar se umavariável é de sequência ou numérica.

Valor de Exemplo Contém valores de amostra do primeiro registro desua origem. Estes valores de amostra ajudam aidentificar o conteúdo de cada coluna de suaorigem. As células na coluna Valor de Amostra nãopodem ser editadas.

Conteúdo Contém uma lista para cada coluna em sua origemde dados. Use a lista para especificar o tipo devalor contido em cada coluna da origem.

Fórmula Esta coluna fica esmaecida para todos os camposna origem e fica disponível apenas quando vocêcria uma nova variável.

Ao criar uma nova variável, clique duas vezes nacélula Fórmula associada para abrir a caixa dediálogo Fórmula da Variável do Processo, a partirda qual é possível definir uma fórmula para avariável.

Botões

Botão Descrição

Nova Variável Clique para criar uma nova variável.

Excluir Clique para excluir uma variável criada pelousuário.

Fórmula de Variável do ProcessoA caixa de diálogo Fórmula Variável do Processo é exibida e permite a edição de fórmulas usadas em umprocesso do Turbo Integrator. Quando uma fórmula existe e você clica em Fórmula, na guia Variáveis, a

90 IBM Planning Analytics: Referência do TM1

fórmula atualmente configurada é exibida na janela Fórmula. Clique em Nova Variável para definir a novafórmula.

Opção Descrição

Fórmula A fórmula atualmente inserida é exibida nestajanela. À medida em que insere o texto da fórmula,esta janela é atualizada.

Destino Escolha o local para esta fórmula, dependendo dasnecessidades de programação deste processo.Selecione Dados para colocar esta fórmula naseção Dados do processo do Turbo Integrator.Selecione Metadados para posicionar a fórmula naseção Metadados. Ambos colocam a fórmula emambos os locais.

Avaliar Clique aqui para validar a fórmula.

Valor de Amostra Quando a fórmula é avaliada, as informações sobrea fórmula são exibidas aqui. Por exemplo, Linha 1:erro de sintaxe em ou antes de: \n (fim da linha)caractere de ponto e vírgula ausente.

Mostrar automaticamente cada vez que o nome davariável é alterado.

Clique aqui para exibir essa caixa de diálogo se onome da variável for alterado. Caso a caixa estejadesmarcada, deve-se fazer a solicitaçãomanualmente, clicando na caixa Fórmula, na guiaVariáveis.

Guia MapasUse a guia Mapas para especificar como os dados de origem são mapeados para cubos, dimensões,dados, consolidações e atributos no banco de dados do TM1.

A guia Mapas consiste em uma série de subguias, cada uma contendo opções que permitem mapearvariáveis de dados de origem para estruturas de metadados existentes do TM1. As subguias que estãodisponíveis variam de acordo com o tipo de valores contidos nos dados de origem, conforme especificadona coluna Conteúdo da guia Variáveis.

A guia Mapas contém as seguintes subguias.

Cubo

Use a subguia Cubo para especificar como o Turbo Integrator mapeia os dados importados para cubos doTM1. A subguia Cubo inclui as seguintes opções.

Opção Descrição

Ação do Cubo Selecione uma opção para criar, atualizar, recriarou aplicar nenhuma ação a um cubo.

Nome do Cubo Especifique o cubo ao qual a ação é aplicável.

Se estiver criando um novo cubo, digite o nome docubo no campo de entrada. Caso contrário,selecione um cubo existente da lista.

Capítulo 1. Windows e Caixas de Diálogo 91

Opção Descrição

Porção Zerada Esta opção fica disponível quando você seleciona aação Atualizar Cubo. Selecione esta caixa sedesejar definir todos os pontos de dados em umavisualização do cubo como zero.

Nome da Visualização Esta opção fica disponível quando você selecionaas opções Atualizar Cubo e Zerar Parte.

Selecione ou defina a visualização que contém ospontos de dados que você deseja zerar.

Ação de Dados Selecione uma opção que determina como osdados processados são armazenados no cubo.

Armazenar Valores sobrescreve valores do cuboexistentes por valores importados pelo processo.

Acumular Valores inclui valores importados peloprocesso em valores do cubo existentes.

Habilitar Criação de Log de Cubos Preencha esta caixa de seleção para gravarmudanças no cubo no arquivo Tm1s.log. Limpeesta caixa para processar cubos sem registrarmudanças no Tm1s.log.

Dimensões

Use a subguia Dimensões para mapear variáveis do elemento para elementos de dimensão.

A subguia inclui uma grade usada para mapear variáveis individuais para dimensões no banco de dadosdo TM1. A grade inclui as seguintes colunas.

Coluna Descrição

Variável do Elemento Contém o nome de cada variável para a qual vocêespecificou um valor Conteúdo de Elemento. Ovalor de Conteúdo é especificado na guia Variáveis.

Esta coluna também contém o rótulo (Variáveis deDados) para quaisquer variáveis com um valorConteúdo de Dados.

Valor de Exemplo Um valor de amostra do primeiro registro de suaorigem de dados. Use este valor para ajudar aidentificar a dimensão para a qual a variável doelemento é mapeada.

Dimensão Lista todas as dimensões disponíveis no servidor.Selecione a dimensão para a qual a variável doelemento é mapeada.

Para mapear a variável do elemento para uma novadimensão, digite o nome da nova dimensão nocampo de entrada.

92 IBM Planning Analytics: Referência do TM1

Coluna Descrição

Ordem no Cubo Esta opção fica disponível quando a Ação do Cuboé Criar.

Especifique a ordem de cada dimensão no cuboque está sendo criado.

Ação Lista as ações de dimensão disponíveis. Selecioneuma ação.

Para criar uma nova dimensão, você deveespecificar uma ação Criar.

Tipo de Elemento Selecione um tipo de elemento para a variável,Numérico ou de Sequência.

Ordem do Elemento Selecione uma opção para ordenar elementos nasdimensões que estão sendo criadas ouatualizadas. Existem quatro ordens declassificação:

Entrada - Classifica elementos na ordem em queeles são criados na dimensão.

Nome - Classifica elementos em ordem alfabética,crescente ou decrescente.

Nível - Classifica elementos por nível de hierarquia,crescente ou decrescente.

Hierarquia - Classifica elementos conforme elesexistem na hierarquia da dimensão.

Dados

Use a subguia Dados para mapear variáveis de dados para elementos específicos.

A subguia inclui uma grade usada para mapear variáveis individuais para elementos no banco de dadosdo TM1. A grade inclui as seguintes colunas.

Coluna Descrição

Variável de Dados Contém o nome de cada variável para a qual vocêespecificou um valor Conteúdo de Dados. O valorde Conteúdo é especificado na guia Variáveis.

Elemento Clique no botão de seta à direita para abrir o Editorde Subconjunto, no qual é possível escolher oelemento para o qual a variável é mapeada.

Para mapear a variável para um novo elemento,digite o nome de elemento no campo de entrada.

Tipo de Elemento Selecione um tipo de elemento aqui.

Capítulo 1. Windows e Caixas de Diálogo 93

Coluna Descrição

Valor de Exemplo Um valor de amostra do primeiro registro de suaorigem de dados. Use este valor para ajudar aidentificar o elemento para o qual a variável dedados é mapeada.

Consolidações

Use a subguia Consolidações para mapear filhos para elementos consolidados.

A subguia inclui uma grade usada para mapear variáveis individuais para dimensões no banco de dadosdo TM1. A grade inclui as seguintes colunas.

Coluna Descrição

Variável de Variável Contém o nome de cada variável para a qual vocêespecificou um valor Conteúdo de Consolidação. Ovalor de Conteúdo é especificado na guia Variáveis.

Dimensão Lista de dimensões para as quais a consolidaçãopode ser mapeada.

Variável Filha Lista as variáveis das quais você seleciona o filhoimediato da consolidação.

Peso Designa um peso à variável-filho especificada.

Valor de Exemplo Um valor de amostra do primeiro registro de suaorigem de dados. Use este valor para ajudar aidentificar o elemento para o qual a consolidação émapeada.

Ordem do Elemento Selecione uma opção para ordenar elementos nasconsolidações que estão sendo criadas ouatualizadas. Existem quatro ordens declassificação:

Entrada - Classifica elementos na ordem em queeles são criados na dimensão.

Nome - Classifica elementos em ordem alfabética,crescente ou decrescente.

Nível - Classifica elementos por nível de hierarquia,crescente ou decrescente.

Hierarquia - Classifica elementos conforme elesexistem na hierarquia da dimensão.

Atributos.

Use a subguia Atributos para mapear variáveis de atributo para atributos específicos.

A subguia inclui uma grade usada para mapear variáveis individuais para dimensões no banco de dadosdo TM1. A grade inclui as seguintes colunas.

94 IBM Planning Analytics: Referência do TM1

Coluna Descrição

Variável do Atributo Contém o nome de cada variável para a qual vocêespecificou um valor Conteúdo de Atributo. O valorde Conteúdo é especificado na guia Variáveis.

Valor de Exemplo Exibe um valor de amostra da origem de dados.Use esta amostra para ajudar a mapear o atributo.

Dimensão Lista todas as dimensões disponíveis no servidor.Selecione a dimensão à qual o atributo é aplicável.

Variável do Elemento Lista as variáveis do elemento. Selecione a variávelpara o elemento ao qual a variável de atributo éaplicável.

Atributo Lista os atributos para os quais a variável pode sermapeada. Selecione o atributo apropriado destalista.

Ação Escolha Criar um novo atributo ou Atualizar umexistente.

Tipo de Atributo Identifica o tipo de atributo selecionado na colunaAtributo.

Guia AvançadoA guia Avançado contém várias subguias que exibem instruções geradas pelo TM1, com base nas opçõesselecionadas em outro lugar no Editor do Turbo Integrator. A guia Avançado também inclui uma subguiana qual é possível definir parâmetros para o processo.

Parâmetros

Item Descrição

Inserir Clique para inserir um novo parâmetro.

Excluir Clique para excluir um parâmetro selecionado.

Parâmetros Digite um nome para cada novo parâmetro.

Tipo Para cada parâmetro, selecione um tipo aqui.

Valor Padrão Insira um valor a ser usado como o valor padrãopara este parâmetro quando o processo do TurboIntegrator for executado.

Prompt de Pergunta Insira um prompt a ser usado para este parâmetroquando o processo do Turbo Integrator forexecutado.

Capítulo 1. Windows e Caixas de Diálogo 95

Prólogo

Item Descrição

Caixa de texto Instrução Exibe as instruções geradas que definem uma sériede ações a serem executadas antes doprocessamento da origem de dados.

É possível aprimorar um processo criandoinstruções adicionais com regras ou funções doTurbo Integrator.

Botão Ir para a Linha Clique neste botão, insira a linha para a qual vocêdeseja ir, em seguida, clique em OK para irdiretamente para uma linha de código na caixa detexto da instrução.

Metadados

Item Descrição

Caixa de texto Instrução Exibe instruções geradas que definem uma sériede ações a serem executadas em metadados doTM1 antes do processamento da origem de dados.

É possível aprimorar um processo criandoinstruções adicionais com regras ou funções doTurbo Integrator.

Botão Ir para a Linha Clique neste botão, insira a linha para a qual vocêdeseja ir, em seguida, clique em OK para irdiretamente para uma linha de código na caixa detexto da instrução.

Dados

Item Descrição

Caixa de texto Instrução Exibe as instruções geradas que definem uma sériede ações a serem executadas quando a origem dedados for processada.

É possível aprimorar um processo criandoinstruções adicionais com regras ou funções doTurbo Integrator.

Botão Ir para a Linha Clique neste botão, insira a linha para a qual vocêdeseja ir, em seguida, clique em OK para irdiretamente para uma linha de código na caixa detexto da instrução.

96 IBM Planning Analytics: Referência do TM1

Epílogo

Item Descrição

Caixa de texto Instrução Exibe as instruções geradas que definem uma sériede ações a serem executadas após oprocessamento da origem de dados.

É possível aprimorar um processo criandoinstruções adicionais com regras ou funções doTurbo Integrator.

Botão Ir para a Linha Clique neste botão, insira a linha para a qual vocêdeseja ir, em seguida, clique em OK para irdiretamente para uma linha de código na caixa detexto da instrução.

Guia ProgramaçãoUse esta guia para planejar um processo para ser executado em intervalos regulares.

Item Descrição

Planejar este Processo como uma Tarefa deOrganização de Processos Nomeada

Verifique aqui para executar este processo comouma tarefa de organização de processos emintervalos regulares. Por padrão, a tarefa deorganização de processos possui o mesmo nomeque o processo. Se desejar designar um nomediferente à tarefa de organização de processos,digite-o no campo de entrada.

Data e Hora de Início da Tarefa de Organização deProcessos

Selecione uma data de início no calendário eespecifique um horário de início no campo deTempo.

Frequência de Execução da Tarefa de Organizaçãode Processos

Preencha os campos apropriados para estabelecero intervalo no qual a tarefa de organização deprocessos deve ser executada.

Janela Extração de VisualizaçãoUse a janela Extração de Visualização para criar uma visualização que inclua apenas os valores queatendem aos critérios definidos pelo usuário, ou para definir uma visualização para exportação.

Ignorar Parâmetros

Parâmetro Descrição

Ignorar Valores Consolidados Ative esta opção para ignorar valores derivados pormeio de consolidação ao extrair a visualização.Desative esta opção para incluir valores derivadospor meio de consolidação ao extrair a visualização.O padrão é desativado.

Capítulo 1. Windows e Caixas de Diálogo 97

Parâmetro Descrição

Ignorar Valores Calculados por Regras Ative esta opção para ignorar valores derivados pormeio de regras ao extrair a visualização. Desativeesta opção para incluir valores derivados por meiode regras ao extrair a visualização. O padrão édesativado.

Ignorar Valores Zero/Em Branco Ative esta opção para ignorar zeros ou valores embranco ao extrair a visualização. Desative estaopção para incluir zeros ou valores em branco aoextrair a visualização. O padrão é ativado.

Parâmetros do Intervalo

Parâmetro Descrição

Operador Selecione um operador que define os valores quevocê deseja extrair.

Limites Numéricos Insira um valor numérico para a(s) variável(is) noOperador.

Limites do Texto Insira um valor de sequência para a(s) variável(is)no Operador.

Seleção de Elementos de Dimensão

Para cada dimensão, clique no botão Subconjunto e selecione os elementos ou subconjuntos quedefinem os parâmetros para a extração de visualização.

Se a visualização a partir da qual você está criando a extração contiver mais de 16 dimensões, clique em

para voltar para a página com as 16 dimensões anteriores, ou clique em para avançar para apágina com as 16 dimensões seguintes.

Caixa de Diálogo Estilos de VisualizaçãoA caixa de diálogo Estilos de visualização permite aplicar estilos do Excel à visualização do cubo do TM1no In-Spreadsheet Browser. A caixa de diálogo contém várias listas que permitem aplicar um estiloexistente do Excel a um intervalo de células, bem como botões que permitem editar ou criar estilos.

Item Descrição

Plano de Fundo Selecione um estilo desta lista para aplicar aoplano de fundo do In-Spreadsheet Browser.

Células de Dados Selecione um estilo desta lista para aplicar acélulas de dados.

O estilo Células de Dados tem precedência sobre oestilo Plano de Fundo.

98 IBM Planning Analytics: Referência do TM1

Item Descrição

Células de Cabeçalho de Linha Selecione um estilo desta lista para aplicar acélulas do cabeçalho da linha.

O estilo Células do Cabeçalho da Linha temprecedência sobre o estilo Plano de Fundo.

Células do Cabeçalho da Coluna Selecione um estilo desta lista para aplicar acélulas do cabeçalho da coluna.

O estilo Células do Cabeçalho da Coluna temprecedência sobre o estilo Plano de Fundo.

Botões Editar Estilo Clique no botão Editar Estilo apropriado para editarou criar estilos para o intervalo associado do In-Spreadsheet Browser.

Áreas de Janela de Congelamento Alterne esta opção para congelar e descongelaráreas de janela no In-Spreadsheet Browser.

Quando esta opção for ativada, os nomes deelementos da linha permanecerão visíveis quandovocê rolar horizontalmente por uma visualização, eos nomes de elementos da coluna permanecerãovisíveis quando você rolar verticalmente.

Quando esta opção for desativada, os nomes deelementos da linha e da coluna serão movidos comos valores do cubo, conforme você rola por umavisualização.

Capítulo 1. Windows e Caixas de Diálogo 99

100 IBM Planning Analytics: Referência do TM1

Capítulo 2. Funções das RegrasEsta seção contém uma lista completa de todas as funções de regras do IBM TM1. É possível usarqualquer uma dessas funções ao gravar regras do TM1.

Operadores aritméticos no TM1 RulesOs operadores matemáticos a seguir poderão ser usados ao construir regras do TM1.

Operador Significado

+ (sinal de mais) Adição

- (sinal de menos) Subtração

* (asterisco) Multiplicação

/ (barra) Divisão por zero usando este operador retorna umvalor indefinido.

\ (barra invertida) Divisão por zero usando este operador retornazero.

^ (sinal de intercalação/circunflexo) Exponenciação

Operadores de comparação no TM1 RulesOs operadores de comparação comparam valores na parte da fórmula de uma instrução de cálculo deregra.

Para comparar dois valores de sequência, insira o símbolo @ antes do operador de comparação. Porexemplo, IF ('A' @= 'B',0,1) mostra como resultado o número 1.

Operador Significado

> Maior que

< Menor que

>= Maior ou igual a

<= Menor ou igual a

= Igual a

<> Diferente de

Operadores lógicos no TM1 RulesÉ possível combinar expressões em uma instrução de cálculo de regras usando operadores lógicos.

© Copyright IBM Corp. 2007, 2019 101

Operador Significado Exemplo

& (e comercial) E (Valor1 > 5) & (Valor1 < 10)Retorna TRUE se o valor formaior que 5 e menor que 10.

% (sinal de porcentagem) OU (Valor1 > 10) % (Valor1 < 5)Retorna TRUE se o valor formaior que 10 ou menor que 5.

~ (til) NÃO ~(Valor1 > 5) Equivalente a(Valor1 <= 5)

Funções de Regras de AtributoFunções de regras que funcionam em atributos.

ATTRNATTRN retorna um atributo numérico para um elemento especificado de uma dimensão.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

ATTRN(dimension, element, attribute)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento Um elemento da dimensão.

102 IBM Planning Analytics: Referência do TM1

Argumento Descrição

atributo O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidodo elemento.

Nota: : Quando esta função for usada em umainstrução condicional (SE), a instrução será a parteque contém a condição, não o bloco condicionalinteiro. Após um erro secundário, a execuçãocontinuará com a próxima instrução. Oprocessamento do TI não tem conhecimento deque ele estava em uma condicional quando o errosecundário foi processado, portanto, a próximainstrução é a próxima linha, não a linha depois deendif.

Para evitar esta situação, use variáveis paraqualquer operação que possa encontrar um errosecundário e, em seguida, use as variáveis nainstrução condicional. Por exemplo:

V1 = CELLGETN('PNLCube', 'fred','argentina','Sales','Jan');IF(V1 = 454);ASCIIOUTPUT('bug.txt', 'if logic not working properly');ENDIF;

Exemplo

Neste exemplo, a função retorna o valor numérico do atributo Tamanho do Motor do elemento Sedã SérieL 1.8L na dimensão do Modelo.

ATTRN('Model', 'L Series 1.8L Sedan', 'Engine Size')

ATTRSATTRS retorna um atributo de sequência para um elemento especificado de uma dimensão.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

ATTRS(dimension, element, attribute)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento Um elemento da dimensão.

atributo O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidodo elemento.

Capítulo 2. Funções das Regras 103

Exemplo

Neste exemplo, a função retorna o valor de sequência do atributo Moeda do elemento 10100 nadimensão plan_business_unit.

ATTRS('plan_business_unit', '10100', 'Currency')

CubeATTRNCubeATTRN retorna um atributo numérico para um cubo especificado.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

CubeATTRN(CubeName, AttrName);

Argumento Descrição

CubeName Um nome de cubo válido.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidodo cubo.

Exemplo

Neste exemplo, a função retorna o valor numérico do atributo Accounting_Code do cubo Produto.

CubeATTRN('Product', 'Accounting_Code');

CubeATTRSCubeATTRS retorna um atributo de sequência para um cubo especificado.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

CubeATTRS(CubeName, AttrName);

Argumento Descrição

CubeName Um nome de cubo válido.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidodo cubo.

Exemplo

Neste exemplo, a função retorna o valor de sequência do atributo Proprietário do cubo Produto.

CubeATTRS('Product', 'Owner');

DimensionATTRNDimensionATTRN retorna um atributo numérico para uma dimensão especificada.

104 IBM Planning Analytics: Referência do TM1

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

DimensionATTRN(DimName, AttrName);

Argumento Descrição

DimName Um nome de dimensão válido.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda dimensão.

Exemplo

Neste exemplo, a função retorna o valor numérico do atributo Accounting_Code da dimensãoPlan_Business_Unit.

DimensionATTRN('Plan_Business_Unit', 'Accounting_Code');

DimensionATTRSDimensionATTRS retorna um atributo de sequência para uma dimensão especificada.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

DimensionATTRS(DimName, AttrName);

Argumento Descrição

DimName Um nome de dimensão válido.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda dimensão.

Exemplo

Neste exemplo, a função retorna o valor de sequência do atributo Manager da dimensãoPlan_Business_Unit.

DimensionATTRS('Plan_Business_Unit', 'Manager');

ElementAttrNElementAttrN retorna um atributo numérico para um elemento especificado de uma dimensão.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

ElementAttrN(dimension, hierarchy, element, attribute)

Capítulo 2. Funções das Regras 105

Argumento Descrição

dimensão Um nome de dimensão válido.

hierarchy O nome da hierarquia dentro da dimensão.

elemento Um elemento da dimensão.

atributo O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidodo elemento.

Nota: : Quando esta função for usada em umainstrução condicional (SE), a instrução será a parteque contém a condição, não o bloco condicionalinteiro. Após um erro secundário, a execuçãocontinuará com a próxima instrução. Oprocessamento do TI não tem conhecimento deque ele estava em uma condicional quando o errosecundário foi processado, portanto, a próximainstrução é a próxima linha, não a linha depois deendif.

Para evitar esta situação, use variáveis paraqualquer operação que possa encontrar um errosecundário e, em seguida, use as variáveis nainstrução condicional. Por exemplo:

V1 = CELLGETN('PNLCube', 'fred','argentina','Sales','Jan');IF(V1 = 454);ASCIIOUTPUT('bug.txt', 'if logic not working properly');ENDIF;

Exemplo

Neste exemplo, a função retorna o valor numérico do atributo Engine Size do elemento da L Series 1.8LSedan na hierarquia Automobile da dimensão Model.

ElementAttrN('Model', 'Automobile', 'L Series 1.8L Sedan', 'Engine Size')

ElementAttrSElementAttrS retorna um atributo de sequência para um elemento especificado de uma dimensão.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

ElementAttrS(dimension, hierarchy, element, attribute)

Argumento Descrição

dimensão Um nome de dimensão válido.

hierarchy O nome da hierarquia dentro da dimensão.

elemento Um elemento da dimensão.

106 IBM Planning Analytics: Referência do TM1

Argumento Descrição

atributo O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidodo elemento.

Exemplo

Neste exemplo, a função retorna o valor de sequência do atributo Currency do elemento 10100 nahierarquia de despesas da dimensão plan_business_unit.

ElementAttrS('plan_business_unit', 'expense', '10100', 'Currency')

Funções de Regras de Cálculo de ConsolidaçãoConsolidatedMax; ConsolidatedMin; ConsolidatedAvg; ConsolidatedCount; e Consolidated CountUniqueexecutam cálculos matemáticos em consolidações.

ConsolidatedAvgConsolidatedAvg calcula o valor médio em uma consolidação e retorna um valor único.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

ConsolidatedAvg(flag-value, cube-name, element_1, element_2,… );

Argumentosflag-value

O valor do sinalizador é a soma dos seguintes valores:

• 1 - Usar o peso de consolidação ao calcular o valor (incluir zeros no cálculo). Se esse valor nãoestiver ativado, o valor bruto do elemento consolidado será usado. As condições a seguir podemafetar se os zeros são incluídos no cálculo:

– Se zero for especificado como o peso de alguns elementos consolidados, o parâmetro deconfiguração: ZeroWeightOptimization=F deverá ser configurado para que esses elementossejam fatorados no cálculo dessas funções. Sem esse parâmetro de configuração, os elementospara os quais a ponderação é zero são eliminados da lista de consolidação e, portanto, não sãoprocessados durante a descoberta de coisas como valores mínimo e máximo.

– Se você desejar que as células zero participem da média, UNDEFVALS deverá ser configuradopara o cubo de modo que, quando um zero for designado a uma célula do cubo, um valor sejaarmazenado na célula exatamente como qualquer outro valor diferente de zero e, em seguida, eleparticipe da média.

– Se uma regra de cubo incluir um SKIPCHECK, os zeros serão ignorados mesmo quando o flag-value estiver configurado como 1. Remova SKIPCHECK da regra para incluir zeros na médiaconsolidada.

• 2-Ignorar valores zero. Se esse valor for configurado, os valores iguais a zero não serão incluídos nocálculo.

cube-name

Nome do cubo em que os valores residem.

Se a função estiver em execução como parte de uma regra de cubo, NÃO como parte de um processoTurboIntegrator, o argumento cube-name poderá ser especificado como uma sequência vazia para

Capítulo 2. Funções das Regras 107

representar o cubo atual. Isso significa que é possível gravar uma regra como['Apr']=ConsolidatedAvg( 0, '', !actvsbud, '1 Quarter' );

element_1, element_2, …

Os nomes de elementos de dimensão que definem a interseção do cubo que contém o valor a serrecuperado.

Os argumentos element_1 a element_n são sensíveis à sequência. element_1 deve ser um elementoda primeira dimensão do cubo, element_2 deve ser um elemento da segunda dimensão, e assim pordiante. Estes argumentos também podem ser os nomes de aliases para elementos de dimensão ouvariáveis do Turbo Integrator.

Exemplo

Em um cubo chamado Declaração de renda, com três dimensões chamadas Regiões, Horário eDeclaração de renda, a dimensão Declaração de renda contém um elemento chamado Vendas brutaspara o número de vendas geral.

Para calcular a média de vendas em todas as regiões no ano 2010, grave:

ConsolidatedAvg( 1, 'Income Statement', 'All Regions', '2010', 'Gross Sales' );

ConsolidateChildrenConsolidateChildren força valores consolidados a serem calculados somando o filho imediato em umadimensão especificada. ConsolidateChildren é útil quando consolidações intermediárias são calculadaspor regras e você quer que uma consolidação pai seja calculada somando as consolidaçõesintermediárias em vez de somar os valores de folha subjacentes.

Esta função é válida apenas em regras do TM1.

Sintaxe

ConsolidateChildren(DimName1, DimName2, ...)

Argumento Descrição

DimName1, DimName2, ... Nomes das dimensões nas quais as consolidaçõesserão executadas.

A função requer pelo menos um argumentoDimName e pode aceitar a mesma quantidade deargumentos DimName e de dimensões no cubopara o qual a regra é gravada.

Exemplo

Considere um cubo chamado Sales formado pelas dimensões ActVsBud, Região, Modelo, Account1 eMês.

Neste exemplo, a dimensão Mês é definida da seguinte forma:

108 IBM Planning Analytics: Referência do TM1

Caso nenhuma regra esteja em vigor para esse cubo, o valor da consolidação Year será calculadosomando todos os valores de folha subjacentes, nesse caso, Jan a Dec. A imagem a seguir ilustra essaconsolidação.

Agora, suponha que você crie a seguinte regra para este cubo, que indica que todos os valores trimestraisdevem ser 1:

[{'1 Quarter', '2 Quarter', '3 Quarter', '4 Quarter'}]=1;

O resultado é o seguinte:

Na imagem a seguir, é possível ver que os valores trimestrais são de fato calculados pela regra, mas aconsolidação Year ainda é calculada somando todos os valores de folha subjacentes. Caso este não seja ocaminho de cálculo desejado, é possível usar a função ConsolidateChildren para forçar o TM1 a calcular aconsolidação Ano, somando seus filhos imediatos, especificamente o 1º Trimestre, o 2º Trimestre, o 3ºTrimestre e o 4º Trimestre.

['Year']=ConsolidateChildren('Month');[{'1 Quarter', '2 Quarter','3 Quarter', '4 Quarter'}]=1;

Na regra, a instrução ['Year']=ConsolidateChildren('Month') diz que a consolidação Ano deveser calculada somando-se os filhos imediatos do Ano na dimensão Mês.

A imagem a seguir mostra o resultado da instrução ['Year']=ConsolidateChildren('Month'):

Capítulo 2. Funções das Regras 109

Observe que a consolidação Ano agora é calculada somando seus filhos imediatos.

É importante lembrar que, para uma determinada consolidação, a função ConsolidateChildren é aplicávelapenas aos filhos imediatos da consolidação.

A função ConsolidateChildren também pode ser usada para especificar como as consolidações sãocalculadas em várias dimensões, como no exemplo a seguir:

Argumento Descrição

['World','Year']=ConsolidateChildren('Region','Month')

Esta instrução aplica a função ConsolidateChildrenàs consolidações Mundo e Ano. Neste caso, Mundoé calculado somando todos os seus filhosimediatos na dimensão Região, enquanto Ano écalculado somando seus filhos imediatos nadimensão Mês.

ConsolidatedCountConsolidatedCount conta o valor em uma consolidação e retorna um valor único.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

ConsolidatedCount(flag-value, cube-name, element_1, element_2,… );

Argumentosflag-value

O valor do sinalizador é a soma dos seguintes valores:

1 - usa ponderação de consolidação ao calcular o valor. Se ele não estiver ativado no valor bruto doelemento consolidado, ele será usado.

2 - ignora valores iguais a zero. Se ele estiver configurado, os valores iguais a zero não serão usadospor essas funções.

Nota: Se zero for especificado como a ponderação de alguns elementos consolidados, o parâmetro deconfiguração ZeroWeightOptimization=F deverá ser configurado para esses elementos seremfatorados no cálculo dessas funções. Sem esse parâmetro de configuração, os elementos para osquais a ponderação é zero são eliminados da lista de consolidação e, portanto, não são processadosdurante a descoberta de coisas como valores mínimo e máximo.

cube-name

Nome do cubo em que os valores residem.

Se a função estiver em execução como parte de uma regra de cubo, NÃO como parte de um processoTurboIntegrator, o argumento cube-name poderá ser especificado como uma sequência vazia pararepresentar o cubo atual. Isso significa que é possível gravar uma regra, tal como:['Apr']=ConsolidatedCount( 1, '', !actvsbud, '1 Quarter' );

element_1, element_2, …

Os nomes de elementos de dimensão que definem a interseção do cubo que contém o valor a serrecuperado.

110 IBM Planning Analytics: Referência do TM1

Os argumentos element_1 a element_n são sensíveis à sequência. element_1 deve ser um elementoda primeira dimensão do cubo, element_2 deve ser um elemento da segunda dimensão do cubo, eassim por diante. Estes argumentos também podem ser os nomes de aliases para elementos dedimensão ou variáveis do Turbo Integrator.

ConsolidatedCountUniqueConsolidatedCountUnique conta o número de elementos exclusivos para os quais pontos de dadosrealmente existem para a consolidação especificada. Os elementos exclusivos são contados ao longo deuma dimensão da célula consolidada.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

ConsolidatedCountUnique( 0, unique-along-dimension-name, cube-name,elem_1, elem_2, . . . );

Argumentosflag word

Especifique 0 (zero).

Nota: Se zero for especificado como a ponderação de alguns elementos consolidados, o parâmetro deconfiguração ZeroWeightOptimization=F deverá ser configurado para esses elementos seremfatorados no cálculo dessas funções. Sem esse parâmetro de configuração, os elementos para osquais a ponderação é zero são eliminados da lista de consolidação e, portanto, não são processadosdurante a descoberta de coisas como valores mínimo e máximo.

unique-along-dimension-nameA dimensão ao longo da qual entradas do elemento exclusivo para o qual existem dados reais devemser contadas.

cube-name

Nome do cubo em que os valores residem.

Se a função estiver em execução como parte de uma regra de cubo, NÃO como parte de um processoTurboIntegrator, o argumento cube-name poderá ser especificado como uma sequência vazia pararepresentar o cubo atual.

element_1, element_2, …

Nomes de elemento de dimensão que definem a interseção do cubo que é o valor consolidado a serprocessado.

Os argumentos element_1 a element_n são sensíveis à sequência. element_1 deve ser um elementoda primeira dimensão do cubo, element_2 deve ser um elemento da segunda dimensão do cubo, eassim por diante. Estes argumentos também podem ser os nomes de aliases para elementos dedimensão ou variáveis do Turbo Integrator.

Exemplo

Em um cubo chamado Declaração de Renda com três dimensões: Regiões, Horário e Declaração deRenda, a dimensão Declaração de Renda contém um elemento chamado Vendas Brutas para o número devendas geral. Para contar quantas regiões tinham alguma venda bruta no ano de 2010, grave:

ConsolidatedCountUnique( 0, 'Regions', 'Income Statement', 'All Regions', '2010', 'Gross Sales' );

ConsolidatedMaxConsolidatedMax calcula o valor máximo em uma consolidação e retorna um valor único.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Capítulo 2. Funções das Regras 111

Sintaxe

ConsolidatedMax(flag-value, cube-name, element_1, element_2,… );

Argumentosflag-value

O valor do sinalizador é a soma dos seguintes valores:

1 - usa ponderação de consolidação ao calcular o valor. Se ele não estiver ativado no valor bruto doelemento consolidado, ele será usado.

2 - ignora valores iguais a zero. Se ele estiver configurado, os valores iguais a zero não serão usadospor essas funções.

Nota: Se zero for especificado como a ponderação de alguns elementos consolidados, o parâmetro deconfiguração ZeroWeightOptimization=F deverá ser configurado para esses elementos seremfatorados no cálculo dessas funções. Sem esse parâmetro de configuração, os elementos para osquais a ponderação é zero são eliminados da lista de consolidação e, portanto, não são processadosdurante a descoberta de coisas como valores mínimo e máximo.

cube-name

Nome do cubo em que os valores residem.

Se a função estiver em execução como parte de uma regra de cubo, NÃO como parte de um processoTurboIntegrator, o argumento cube-name poderá ser especificado como uma sequência vazia pararepresentar o cubo atual. Isso significa que é possível gravar uma regra, tal como:['Apr']=ConsolidatedMax( 1, '', !actvsbud, '1 Quarter' );

element_1, element_2, …

Os nomes de elementos de dimensão que definem a interseção do cubo que contém o valor a serrecuperado.

Os argumentos element_1 a element_n são sensíveis à sequência. element_1 deve ser um elementoda primeira dimensão do cubo, element_2 deve ser um elemento da segunda dimensão do cubo, eassim por diante. Estes argumentos também podem ser os nomes de aliases para elementos dedimensão ou variáveis do Turbo Integrator.

Exemplo

Considere um cubo chamado Declaração de Renda com três dimensões, "Área", "Horário" e "Declaraçãode Renda". A dimensão Declaração de Renda contém um elemento "Vendas Brutas" para o número devendas geral.

Para calcular o máximo de vendas em todas as regiões no ano de 2010, use:

ConsolidatedMax( 1, 'Income Statement', 'All Regions', '2010', 'Gross Sales' );

ConsolidatedMinConsolidatedMin calcula o valor mínimo em uma consolidação e retorna um valor único.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

ConsolidatedMin(flag-value, cube-name, element_1, element_2,… );

112 IBM Planning Analytics: Referência do TM1

Argumentosflag-value

O valor do sinalizador é a soma dos seguintes valores:

1 - usa ponderação de consolidação ao calcular o valor. Se ele não estiver ativado no valor bruto doelemento consolidado, ele será usado.

2 - ignora valores iguais a zero. Se ele estiver configurado, os valores iguais a zero não serão usadospor essas funções.

Nota: Se zero for especificado como a ponderação de alguns elementos consolidados, o parâmetro deconfiguração ZeroWeightOptimization=F deverá ser configurado para esses elementos seremfatorados no cálculo dessas funções. Sem esse parâmetro de configuração, os elementos para osquais a ponderação é zero são eliminados da lista de consolidação e, portanto, não são processadosdurante a descoberta de coisas como valores mínimo e máximo.

cube-name

Nome do cubo em que os valores residem.

Se a função estiver em execução como parte de uma regra de cubo, NÃO como parte de um processoTurboIntegrator, o argumento cube-name poderá ser especificado como uma sequência vazia pararepresentar o cubo atual. Isso significa que é possível gravar uma regra, tal como:['Apr']=ConsolidatedMin( 1, '', !actvsbud, '1 Quarter' );

element_1, element_2, …

Os nomes de elementos de dimensão que definem a interseção do cubo que contém o valor a serrecuperado.

Os argumentos element_1 a element_n são sensíveis à sequência. element_1 deve ser um elementoda primeira dimensão do cubo, element_2 deve ser um elemento da segunda dimensão do cubo, eassim por diante. Estes argumentos também podem ser os nomes de aliases para elementos dedimensão ou variáveis do Turbo Integrator.

Funções de Regras de Dados do CuboFunções de regras que trabalham em dados do cubo.

CellValueNCellValueN retorna o valor numérico dos elementos especificados em um cubo. Esta é uma função deregras do TM1, válida apenas em regras do TM1. O uso desta função em um processo do Turbo Integratorresultará em um erro.

Para dimensões que não estão entre os parâmetros de elemento, as coordenadas são recuperadas dodestino de regra (a célula está sendo recuperada e acionando a avaliação da regra). O comportamento dafunção é análogo à expressão de referência dentro do cubo (por exemplo, [ 'Measures':'Count' ]),conforme usado no lado direito da regra.

Os parâmetros de elemento podem ser especificados em qualquer ordem, e para o CellValueN, podemser especificados diversos elementos da mesma dimensão (mas diferentes hierarquias da dimensão).Como a lista de elementos não precisa estar em ordem de dimensão de cubo, é necessário qualificar adimensão de todos os parâmetros de elemento. Parâmetros de elementos de dimensões com diversashierarquias também deve ser qualificados para hierarquia.

Sintaxe

CellValueN(cube, element1,..., elementN);

Capítulo 2. Funções das Regras 113

Argumento Descrição

cubo Nome do cubo.

elementN O nome do elemento que define a célula. Ummínimo de um elemento deve ser especificado.

Exemplo

CellValueS('ForecastCube', 'Products':'ProductsByChannel':'Channel2', 'Measures':'Count');

Este exemplo retorna o valor numérico da célula especificada. A dimensão Produtos tem diversashierarquias, enquanto a dimensão Medidas tem uma hierarquia.

A referência dentro do cubo é restrita a parâmetros literais, enquanto o CellValueN não é. Essecomportamento é análogo à função de regras BD(). Os parâmetros de elemento podem ser especificadosusando expressões com valor de sequência. Por exemplo, o parâmetro de elemento Produtos acimapoderia ser especificado como:

'Products' : 'ProductsByChannel' : AttrS( … )

Ao contrário do DB() e da expressão de referência dentro do cubo, os parâmetros do elemento CellValueNdevem ser qualificados por dimensão ou qualificado por dimensão e hierarquia.

CellValueSCellValueS retorna o valor de sequência dos elementos especificados em um cubo. Esta é uma função deregras do TM1, válida apenas em regras do TM1. O uso desta função em um processo do Turbo Integratorresultará em um erro.

Para dimensões que não estão entre os parâmetros de elemento, as coordenadas são recuperadas dodestino de regra (a célula está sendo recuperada e acionando a avaliação da regra). O comportamento dafunção é análogo à expressão de referência dentro do cubo (por exemplo, [ 'Measures':'Count' ]),conforme usado no lado direito da regra.

Os parâmetros de elemento podem ser especificados em qualquer ordem e, para CellValueS, várioselementos da mesma dimensão (mas hierarquias diferentes da dimensão) podem ser especificados.Como a lista de elementos não precisa estar em ordem de dimensão de cubo, é necessário qualificar adimensão de todos os parâmetros de elemento. Parâmetros de elementos de dimensões com diversashierarquias também deve ser qualificados para hierarquia.

Sintaxe

CellValueS(cube, element1,..., elementN);

Argumento Descrição

cubo Nome do cubo.

elementN O nome do elemento que define a célula. Ummínimo de um elemento deve ser especificado.

Exemplo

CellValueS('ForecastCube', 'Products':'ProductsByChannel':'Channel2', 'Measures':'Location');

Este exemplo retorna o valor de sequência da célula especificada. A dimensão Produtos tem diversashierarquias, enquanto a dimensão Medidas tem uma hierarquia.

114 IBM Planning Analytics: Referência do TM1

A referência dentro do cubo é restrita a parâmetros literais, enquanto CellValueS não é. Essecomportamento é análogo à função de regras BD(). Os parâmetros de elemento podem ser especificadosusando expressões com valor de sequência. Por exemplo, o parâmetro de elemento Produtos acimapoderia ser especificado como:

'Products' : 'ProductsByChannel' : AttrS( … )

Ao contrário do BD() e da expressão de referência dentro do cubo, os parâmetros do elemento CellValueSdevem ser qualificados por dimensão ou qualificados por dimensão e hierarquia.

BDO BD retorna um valor de um cubo em um banco de dados do TM1. DB retorna um valor numérico seusado em uma expressão numérica, e um valor de sequência se usado em uma expressão de sequência.

BD é uma função de regras do TM1, válida somente em regras do TM1. O uso desta função em umprocesso do Turbo Integrator causa um erro.

Sintaxe

DB(cube, e1, e2, [...e256])

Parâmetroscubo

O nome do cubo do qual o valor será recuperado.

e1,...en

Nomes de elementos de dimensão que definem a interseção contendo o valor a ser recuperado.

Os argumentos e1 a en são sensíveis à sequência. e1 deve ser um elemento da primeira dimensão docubo, e2 deve ser um elemento da segunda dimensão e assim por diante.

Exemplo

Neste exemplo, Budget é o nome do cubo e a função retorna o valor na interseção de Califórnia,Monitores com Tela Plana 15", Vendas Líquidas e Janeiro.

DB('Budget', 'California', '15" Flat Panel Monitors', 'Net Sales','January')

Quando usado para referenciar dimensões de hierarquia múltipla, deve-se especificar a hierarquiaespecífica. Neste exemplo, o elemento Category2 existe na hierarquia ByCategory da dimensãoProductsCube.

DB('ProductsCube', 'ByCategory':'Category2',...)

ISLEAFISLEAF retorna 1 se uma célula especificada for uma célula folha (identificada apenas por elementosfolha/simples). Se a célula especificada for identificada por qualquer elemento consolidado, a funçãoretornará 0.

Esta função é válida apenas em regras do TM1.

A função ISLEAF não pode ser usada em processos do Turbo Integrator. A presença desta função em umprocesso impedirá a compilação do processo.

Sintaxe

ISLEAF

Capítulo 2. Funções das Regras 115

Argumentos

Nenhum.

Exemplo

É possível usar ISLEAF em uma instrução SE para testar se uma célula atual é uma célula folha. Porexemplo:

[]=IF((ISLEAF=1),TrueStatement, FalseStatement);

Executa a TrueStatement se a célula atual for uma célula folha, caso contrário, executa FalseStatement.

ISUNDEFINEDCELLVALUEISUNDEFINEDCELLVALUE compara o valor passado para o valor do cubo numérico padrão, que éinfluenciado pela presença da declaração UNDEFVALS na regra desse cubo. A função retorna 1 se o valorpassado for igual ao valor padrão do cubo, caso contrário, retorna 0.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

ISUNDEFINEDCELLVALUE(TestValue, <Cube>)

Argumentos

Argumento Descrição

TestValue O valor numérico para comparar com o valor padrão do cubo.

Cube Um argumento String opcional que especifica o cubo cujo valor padrão deve sercomparado.

Quando ISUNDEFINEDCELLVALUE é usada em uma regra, o cubo é assumidocomo cubo sujeito, a menos que seja especificado de outra forma.

Quando usada em um TI, um cubo deve ser especificado.

Se o cubo for omitido em um TI, ou se não for válido quando especificado, umvalor igual a 0 será usado para comparação.

Exemplo

ISUNDEFINEDCELLVALUE(TestValue) retorna 1 quando TestValue é o valor indefinido especial e éusado na regra de um cubo com UNDEFVALS declarado.

UNDEFUNDEF retorna o valor indefinido. Esta função pode ser usada para impedir que os dados sejamarmazenados em um cubo baseado em um teste lógico.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

UNDEF

Argumentos

Nenhum.

116 IBM Planning Analytics: Referência do TM1

Exemplo

UNDEF retorna o valor indefinido.

UNDEFINEDCELLVALUEUNDEFINEDCELLVALUE retorna o valor do cubo numérico padrão, que é influenciado pela presença dadeclaração UNDEFVALS na regra desse cubo.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

UNDEFINEDCELLVALUE(<Cube>)

Argumentos

Argumento Descrição

Cube Um argumento String opcional que especifica o cubo cujo valor padrão deve serretornado.

Quando UNDEFINEDCELLVALUE é usada em uma regra, o cubo é assumidocomo cubo sujeito, a menos que seja especificado de outra forma.

Quando usado em um processo do TI, um cubo deve ser especificado.

Se o cubo for omitido em um processo do TI, ou se não for válido quandoespecificado, um valor igual a 0 será retornado.

Exemplo

UNDEFINEDCELLVALUE retorna 0 quando é usado na regra de um cubo sem UNDEFVALS declarado ouquando é usado em um processo do TI.

UNDEFINEDCELLVALUE retorna o valor indefinido especial quando usado na regra de um cubo comUNDEFVALS declarado.

UNDEFINEDCELLVALUE('ExampleCube') retorna o valor padrão de 'ExampleCube' ou 0, se'ExampleCube' não existir.

UNDEFVALSA colocação de UNDEFVALS nas regras para um cubo altera o valor padrão do cubo de zero para um valorindefinido especial. Como outras funções de regra, UNDEFVALS se aplica apenas ao cubo associado àregra na qual a função aparece.

Esta é uma função de regras do TM1 válida apenas nas regras do TM1.

O uso de UNDEFVALS tem ramificações quanto ao modo como os dados são armazenados no cubo erecuperados.

• Armazenamento de Dados

Para um cubo sem UNDEFVALS nas regras, o valor padrão é zero. Se houver uma tentativa dearmazenar um zero em uma célula do cubo, essa solicitação de armazenamento será ignorada, vistoque esta é uma tentativa redundante de armazenar o valor padrão e isso consumiria espaço namemória sem necessidade. Semelhantemente, se uma célula já contém um valor e o valor for excluído,nada será armazenado na célula.

Se, entretanto, o cubo tiver UNDEFVALS definido nas regras, isso tornará o valor-padrão um valorindefinido especial. Agora, quando um zero é armazenado em uma célula de um cubo, ele é realmentearmazenado, exatamente como qualquer outro valor não zero.

Capítulo 2. Funções das Regras 117

O valor especial indefinido é apenas um valor do tempo de execução, retornado a partir das solicitaçõespor valores de células. Ele nunca é armazenado em uma célula real na memória e nunca é gravado nodisco. A inclusão de UNDEFVALS na regra de um cubo não afeta o uso da memória ou o armazenamentoem disco, exceto pelas células que realmente contêm zero como valor. Quando UNDEFVALS é incluídona regra de um cubo, os valores iguais a zero nesse cubo consomem espaço de memória e são gravadosno disco, como ocorre com qualquer outro valor de dados. Se UNDEFVALS não for especificado, ascélulas com valor zero não serão armazenadas na memória e nem serão gravadas no disco.

• Recuperação de Dados

Para um cubo sem UNDEFVALS nas regras, o valor padrão é zero. Quando uma célula é recuperada enão há nenhum valor atualmente armazenado para esse valor no cubo, um valor de zero (como o valor-padrão) é retornado. Isso significa que um aplicativo não consegue saber se uma célula realmenteexiste e contém zero como o valor da célula ou se a célula não existe (como pode ocorrer com dadosesparsos).

Se, entretanto, o cubo tiver UNDEFVALS definido, isso tornará o valor-padrão um valor indefinidoespecial. Nesse caso, quando uma célula inexistente é recuperada, o valor recuperado será esse valorespecial indefinido. Isso pode ser usado para diferenciar uma célula que não existe (quando especialindefinido é retornado) de uma célula que existe, mas cujo valor é zero (é retornado zero). Qualquercliente que foi gravado para ser executado em relação a TM1 e que pode encontrar um cubo comUNDEFVALS configurado, deve estar preparado para manipular um valor de célula desse especialindefinido, em vez de um zero. Um cliente pode detectar se um valor retornado de TM1 é o valorespecial indefinido com a função da API TM1ValIsUndefined. Para obter detalhes sobre a função daAPI TM1ValIsUndefined, consulte s documentação da API TM1.

Nota: Esse valor especial indefinido não é o valor retornado pela função UNDEF() do Turbo Integrator. Ovalor retornado pelo UNDEF() é um valor indefinido usado para coisas como uma tentativa de dividir porzero ou usar o logaritmo de um número ilegal, etc.

No Turbo Integrator, para operações aritméticas normais (+, -, *, /, \, ^) e comparações aritméticasnormais (<, >, >=, <=, =, <>), o valor especial indefinido é tratado como um zero. Por esse motivo, o códigoa seguir não funciona:

NoCellVal = UndefinedCellValue( 'cube-name' );If ( vv = NoCellVal );

Nessa comparação, NoCellVal, que é o valor especial indefinido para um cubo UNDEFVALS, é tratadocomo um zero. Isso significa que a comparação é realmente If (vv = 0 ).

No Turbo Integrator deve-se utilizar o IsUndefinedCellValue para testar se um valor de célula é o valorespecial indefinido. Por exemplo:

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;

Sintaxe

UNDEFVALS

Argumentos

Nenhum.

118 IBM Planning Analytics: Referência do TM1

Funções de Regras de Data e HoraFunções que regras que trabalham com datas e horas.

DATADATA retorna a sequência de datas no formato aa-mm-dd ou aaaa-mm-dd para um determinado númerode série.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

DATE(SerialNumber, ReturnFourDigitYear)

Argumento Descrição

SerialNumber Uma data expressa em formato serial.

ReturnFourDigitYear Um argumento Booleano opcional que determina se a funçãoDATE retorna uma sequência usando a notação de dois ou quatrodígitos para o ano.

Se ReturnFourDigitYear for true, a função retornará a data queestá contida no intervalo de 1 de Jan. de 1960 a 31 de Dez. de9999, usando a notação de quatro dígitos para o ano. A dataserial 0 corresponde a 1 de Jan. de 1960 e a data serial 2936549corresponde a 31 de Dez. de 9999.

Se ReturnFourDigitYear for false, ou se este argumento opcionalfor omitido da função DATE, a função retornará uma data queestá contida no intervalo de 1 de Jan. de 1960 a 31 de Dez de2059, usando a notação de dois dígitos para o ano. A data serial 0corresponde a 1 de Jan. de 1960 e a data serial 36524corresponde a 31 de Dez. de 2059.

Se ReturnFourDigitYear for false ou for omitido e você especificaruma data serial maior que 36524, a data serial usada pela funçãoserá determinada pela fórmula n - 36525. Por exemplo, se vocêespecificar uma data serial de 36530, 36530 - 36525 = 5. Nestecaso, DATE usará 5 como a data serial e retornará a data 6 deJan. de 1960.

Exemplo

DATE(13947) retorna 98-03-09.

DATE(13947, 1) retorna 1998-03-09.

DATESDATES retorna uma sequência de datas, no formato 'aa-mm-dd' ou 'aaaa-mm-dd', correspondente a umdeterminado ano, mês e dia.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

DATES(year, month, day)

Capítulo 2. Funções das Regras 119

Argumento Descrição

year Um ano, expresso em formato aa ou aaaa.

month Um mês, expresso em formato mm.

day Um dia, expresso em formato dd.

Exemplo

DATES(98, 2, 10) retorna '98-02-10'.

DATES(1998, 2, 10) retorna '1998-02-10'.

DIADAY retorna um valor numérico para o dia em uma determinada sequência de datas.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

DAY(DateString)

Argumento Descrição

DateString Uma sequência de datas em formato AA-MM-DDou AAAA-MM-DD.

Exemplo

DAY('02-05-25') retorna 25.

DAYNODAYNO retorna o número de série de data correspondente a uma determinada sequência de datas.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Nota: DAYNO pode retornar datas para sequências de datas, começando em 1 de Janeiro de 1960(sequências de datas 1960-01-01 ou 60-01-01). Para datas após 31 de Dezembro de 2059, você deveusar um ano de quatro dígitos na sequência de datas. Por exemplo, a sequência de datas para 5 deJaneiro de 2061 seria 2061-01-05.

Sintaxe

DAYNO('DateString')

Argumento Descrição

DateString Uma sequência de datas em formato AA-MM-DDou AAAA-MM-DD.

Exemplo

DAYNO('98-03-09') retorna 13947.

120 IBM Planning Analytics: Referência do TM1

MÊSMONTH retorna um valor numérico para o mês em uma determinada sequência de datas.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

MONTH(date)

Argumento Descrição

data Uma sequência de datas em formato AA-MM-DDou AAAA-MM-DD.

Exemplo

MONTH('02-05-25') retorna 5.

AGORANOW retorna o valor data/hora atual em formato de número de série.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

AGORA

Argumentos

Nenhum.

Exemplo

NOW retorna o valor data/hora atual em formato de número de série.

TIMETIME retorna uma sequência, no formato HH:MM, representando a hora do sistema no servidor TM1.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

TIME

Argumentos

Nenhum.

Exemplo

Especificada uma hora do sistema de 9:33 AM, TIME retorna a sequência '09:33'.

Especificada uma hora do sistema de 9:33 PM, TIME retorna a sequência '21:33'.

TIMSTTIMST retorna uma sequência de data/hora formatada.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Capítulo 2. Funções das Regras 121

Sintaxe

TIMST(datetime, format, ExtendedYears)

Argumento Modificador/

Descrição

datetime Um número de série de data/hora.

A parte do número inteiro do número especifica adata, e a parte decimal especifica a hora no dia. Odia número 0 corresponde a '60-01-01'. Númerosnegativos correspondem a anos anteriores. Osanos no Século 21, até 2059, são representadospelos anos 00 a 59. Uma hora representa 1/24 deum dia, um minuto 1/60 de uma hora, e umsegundo 1/60 de um minuto.

format Uma sequência que formata o resultado da função.Todos os caracteres no argumento de formatoaparecem no resultado, exceto os seguintescaracteres, que retornam valores de componentede data/hora:

\y

os últimos dois dígitos do ano (97, 98, etc.)

\Y

os quatro dígitos do ano (1997, 1998, etc.)

\m

os dois dígitos do mês (01 a 12)

\M

a abreviação do mês (JAN, FEV, etc.)

\d

os dois dígitos do dia (01 a 31)

\D

o dígito do dia (1 a 31)

\h

a hora em horário militar (00 a 23)

\H

a hora padrão (1 a 12)

\i

o minuto (00 a 59)

122 IBM Planning Analytics: Referência do TM1

Argumento Modificador/

Descrição

\s

o segundo (00 a 59)

\p

a.m. ou p.m.

ExtendedYears Este parâmetro Booleano opcional especifica se afunção retorna uma data que está contida nointervalo 1960 - 2059 ou 1960 - 9999.

Se ExtendedYears for true, a função retornará umadata que está contida no intervalo de 1 de Jan. de1960 e 31 de Dez. de 9999. A data serial 0corresponde a 1 de Jan. de 1960 e a data serial2936549 corresponde a 31 de Dez. de 9999.

Se ExtendedYears for false, ou se este argumentoopcional for omitido da função TIMST, a funçãoretornará uma data que está contida no intervalode 1 de Jan. de 1960 a 31 de Dez. de 2059. A dataserial 0 corresponde a 1 de Jan. de 1960 e a dataserial 36524 corresponde a 31 de Dez. de 2059.

Se ExtendedYears for false ou for omitido e vocêespecificar uma data serial maior que 36524, adata serial usada pela função será determinadapela fórmula n - 36525. Por exemplo, se vocêespecificar uma data serial de 36530, 36530 -36525 = 5. Neste caso, TIMST usará 5 como a dataserial e retornará a data 6 de Jan. de 1960.

Exemplo

TIMST(366.0000, '\M \D, \Y') retorna 'JAN 1, 1961'.

TIMST(366.5000, '\H\p \imin\ssec') retorna '12p.m. 00min00sec'.

TIMST(366.1000, 'On \M \D, \Y at \H\p \imin\ssec') retorna 'On JAN 1, 1961 at 2a.m. 24min00sec'.

TIMST(11111.1100, 'On \M \D, \Y at \H\p \imin\ssec') retorna 'On JUN 3,1990 at 2a.m. 38min24sec'.

TIMVLTIMVL retorna o valor numérico de um componente (ano, mês, etc.) de um valor data/hora.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

TIMVL(datetime, type, ExtendedYears)

Capítulo 2. Funções das Regras 123

Argumento Modificador e

Descrição

datetime Um número de série de data e hora.

A parte do número inteiro do número especifica adata, e a parte decimal especifica a hora no dia. Odia número 0 corresponde a '60-01-01.' Númerosnegativos correspondem a anos anteriores. Osanos no Século 21, até 2059, são representadospelos anos 00 a 59. Uma hora representa 1/24 deum dia, um minuto 1/60 de uma hora, e umsegundo 1/60 de um minuto.

type Um caractere que especifica o tipo de componentea ser extraído. Os seguintes são argumentos detipo válidos:

Y

valor de ano (1997, 1998, etc.)

M

valor de mês (1 a 12)

D

valor de dia (1 a 31)

H

valor de hora (0 a 23)

I

valor de minuto (00 a 59)

S

valor de segundo (00 a 59)

124 IBM Planning Analytics: Referência do TM1

Argumento Modificador e

Descrição

ExtendedYears Este parâmetro Booleano opcional especifica se afunção retorna uma data que está contida nointervalo 1960 - 2059 ou 1960 - 9999.

Se ExtendedYears for true, a função retornará umadata que está contida no intervalo de 1 de Jan. de1960 e 31 de Dez. de 9999. A data serial 0corresponde a 1 de Jan. de 1960 e a data serial2936549 corresponde a 31 de Dez. de 9999.

Se ExtendedYears for false, ou se este argumentoopcional for omitido da função TIMVL, a funçãoretornará uma data que está contida no intervalode 1 de Jan. de 1960 a 31 de Dez. de 2059. A dataserial 0 corresponde a 1 de Jan. de 1960 e a dataserial 36524 corresponde a 31 de Dez. de 2059.

Se ExtendedYears for false ou for omitido e vocêespecificar uma data serial maior que 36524, adata serial usada pela função será determinadapela fórmula n - 36525. Por exemplo, se vocêespecificar uma data serial de 36530, 36530 -36525 = 5. Neste caso, TIMVL usará 5 como a dataserial e retornará a data 6 de Jan. de 1960.

Exemplo

TIMVL(11111.1100, 'Y') retorna 1990.

TIMVL(11111.1100, 'H') retorna 2.

HOJETODAY retorna a data atual em formato aa-mm-dd.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

TODAY(<ReturnFourDigitYear>)

Capítulo 2. Funções das Regras 125

Argumento Descrição

ReturnFourDigitYear Um argumento Booleano opcional que determinase a função TODAY retorna uma sequência usandoa notação de dois ou quatro dígitos para o ano.

Se ReturnFourDigitYear for true, a função retornaráa data que está contida no intervalo de 1 de Jan.de 1960 a 31 de Dez. de 9999, usando a notaçãode quatro dígitos para o ano. A data serial 0corresponde a 1 de Jan. de 1960 e a data serial2936549 corresponde a 31 de Dez. de 9999.

Se ReturnFourDigitYear for false, ou se esteargumento opcional for omitido da função TODAY,a função retornará uma data que está contida nointervalo de 1 de Jan. de 1960 a 31 de Dez de2059, usando a notação de dois dígitos para o ano.A data serial 0 corresponde a 1 de Jan. de 1960 e adata serial 36524 corresponde a 31 de Dez. de2059.

Se ReturnFourDigitYear for false ou for omitido evocê especificar uma data serial maior que 36524,a data serial usada pela função será determinadapela fórmula n - 36525. Por exemplo, se vocêespecificar uma data serial de 36530, 36530 -36525 = 5. Neste caso, TODAY usará 5 como adata serial e retornará a data 6 de Jan. de 1960.

Exemplo

P1=TODAY(1) retorna uma sequência de dados em formato AAAA-MM-DD, por exemplo, 2009-06-05.

P1=TODAY(0) retorna uma sequência de datas em formato AA-MM-DD, por exemplo, 09-06-05

ANOYEAR retorna um valor numérico para o ano em uma determinada sequência de datas.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

YEAR(date)

Argumento Descrição

data Uma sequência de datas em formato AA-MM-DD.

Exemplo

YEAR('02-05-25') retorna 2.

Funções de Regras de Informações de DimensãoFunções de regras que gerenciam informações de dimensão.

126 IBM Planning Analytics: Referência do TM1

DIMIXO DIMIX retorna o número de índice de um elemento em uma dimensão.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

DIMIX(server_name:dimension, element)

Argumento Descrição

dimensão Um nome de dimensão válido qualificado pelonome do servidor.

elemento O nome de um elemento na dimensão.

Se o elemento não for membro da dimensãoespecificada, a função retornará 0.

Exemplo

Brasil possui um valor de índice de três na dimensão Região. O exemplo retorna 3.

DIMIX('planning_sample:Region','Brazil')

DIMNMDIMNM retorna o elemento de uma dimensão que corresponde ao argumento de índice.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

DIMNM(server_name:dimension, index)

Argumento Descrição

dimensão Um nome de dimensão válido qualificado pelonome do servidor.

índice Um valor menor ou igual ao número de elementosna dimensão.

Se este argumento for menor que 1 ou maior que onúmero de elementos na dimensão, a funçãoretornará 0.

Exemplo

Este exemplo retorna 'Bélgica', que é o elemento na dimensão Região com um valor de índice de 2.

DIMNM(planning_sample:'Region',2)

DIMSIZO DIMSIZ retorna o número de elementos em uma dimensão especificada.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Capítulo 2. Funções das Regras 127

Sintaxe

DIMSIZ(dimension)

Argumento Descrição

dimensão Um nome de dimensão válido.

Algumas instalações podem precisar qualificar onome da dimensão com o nome do servidor, comoem server_name:dimension.

Exemplo

Se a dimensão Contas contiver 19 elementos, o exemplo retornará o valor 19.

DIMSIZ('Accounts')

DNEXTO DNEXT retorna o nome de elemento que segue o elemento especificado como um argumento para afunção.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

DNEXT(dimension, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

Algumas instalações podem precisar qualificar onome da dimensão com o nome do servidor, comoem server_name:dimension.

elemento O nome de um elemento na dimensão. Esteargumento também pode ser o nome de um aliaspara um elemento de dimensão.

Exemplo

Se a dimensão Local contiver os elementos ordenados Califórnia, Oregon e Washington, o exemploretornará Washington.

DNEXT("Location","Oregon")

DNLEVDNLEV retorna os níveis de número em uma dimensão.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

DNLEV(dimension)

128 IBM Planning Analytics: Referência do TM1

Argumento Descrição

dimensão Um nome de dimensão válido.

Algumas instalações podem precisar qualificar onome da dimensão com o nome do servidor, comoem server_name:dimension.

Exemplo

DNLEV('Region')

Na dimensão Região, as diversas nações (Nível 0) somam-se às regiões (Nível 1). As regiões são entãoincluídas em super-regiões (Nível 2) que, por sua vez, são incluídas no mundo (Nível 3).

Existem quatro níveis na dimensão Região, portanto, o exemplo retorna o valor 4.

DTYPEDTYPE retorna informações sobre o tipo de elemento de um elemento especificado. DTYPE retorna N se oelemento for um elemento numérico, S se o elemento for um elemento de sequência e C se o elementofor um elemento consolidado.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

DTYPE(dimension, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento O nome de um elemento na dimensão.

Exemplo

O elemento Europa é um elemento consolidado da dimensão Região, portanto, o exemplo retorna C.

DTYPE('Region','Europe')

TABDIMTABDIM retorna o nome da dimensão que corresponde ao argumento de índice.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Capítulo 2. Funções das Regras 129

Sintaxe

TABDIM(cube, index)

Argumento Descrição

cubo Um nome de cubo válido.

índice Um valor positivo menor ou igual ao total dedimensões no cubo.

Exemplo

O cubo SalesCube contém cinco dimensões: account1, actvsbud, modelo, mês e região. O exemploretorna modelo, a terceira dimensão de SalesCube.

TABDIM('SalesCube',3)

Funções de Regras de Informações de ElementosFunções de regras que gerenciam informações de elementos.

ELCOMPO ELCOMP retorna o nome de um filho de elemento consolidado em uma dimensão especificada.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ELCOMP(dimension, element, position)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento O nome de um elemento consolidado na dimensão.

posição Um valor positivo menor ou igual ao total de filhosno elemento especificado.

Exemplo

Na dimensão Região, o elemento consolidado Europa Central é uma consolidação dos filhos França eAlemanha. Alemanha é a segunda posição nesta consolidação. De forma apropriada, o exemplo retornaAlemanha.

ELCOMP('Region','Central Europe',2)

ELCOMPNO ELCOMPN retorna o número de componentes em um elemento especificado. Se o argumento doelemento não for um elemento consolidado, a função retornará 0.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

130 IBM Planning Analytics: Referência do TM1

Sintaxe

ELCOMPN(dimension, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento O nome de um elemento consolidado na dimensão.

Exemplo

Na dimensão Region, o elemento Scandinavia é uma consolidação de três elementos. O exemplo retorna3.

ELCOMPN('Region','Scandinavia')

ElementComponentElementComponent retorna o nome de um filho de um elemento consolidado em uma dimensãoespecificada. Se o argumento do elemento não for um elemento consolidado, a função retornará 0.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ElementComponent(dimension, hierarchy, element, position)

Argumento Descrição

dimensão Um nome de dimensão válido.

hierarchy O nome da hierarquia dentro da dimensão.

elemento O nome de um elemento consolidado na dimensão.

posição Um valor positivo menor ou igual ao total de filhosno elemento especificado.

Exemplo

Na dimensão Região, o elemento consolidado Europa Central é uma consolidação dos filhos França eAlemanha. Alemanha é a segunda posição nesta consolidação. De forma apropriada, o exemplo retornaAlemanha.

ElementComponent('Region', 'Europe', 'Central Europe', 2)

ElementComponentCountElementComponentCount retorna o número de componentes em um elemento especificado. Se oargumento do elemento não for um elemento consolidado, a função retornará 0.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ElementComponentCount(dimension, hierarchy, element)

Capítulo 2. Funções das Regras 131

Argumento Descrição

dimensão Um nome de dimensão válido.

hierarchy O nome da hierarquia dentro da dimensão.

elemento O nome de um elemento consolidado na dimensão.

Exemplo

Na dimensão Region, o elemento Scandinavia é uma consolidação de três elementos. O exemplo retorna3.

ElementComponentCount('Region', '', 'Scandinavia')

ElementCountElementCount retorna o número de elementos em uma dimensão especificada.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ElementCount(dimension, hierarchy)

Argumento Descrição

dimensão Um nome de dimensão válido.

Algumas instalações podem precisar qualificar onome da dimensão com o nome do servidor, comoem server_name:dimension.

hierarchy O nome da hierarquia dentro da dimensão.

Exemplo

Se a hierarquia Receiveables na dimensão Accounts contiver 19 elementos, o exemplo retornará o valor19.

ElementCount('Accounts', 'Receivables')

ElementFirstElementFirst retorna o primeiro elemento de uma dimensão especificada.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ElementFirst(server_name:dimension, hierarchy)

Argumento Descrição

dimensão Um nome de dimensão válido.

hierarchy O nome da hierarquia dentro da dimensão.

132 IBM Planning Analytics: Referência do TM1

Exemplo

Se a hierarquia North America da dimensão Location contiver os elementos ordenados California, Oregone Washington, o exemplo retornará California.

ElementFirst("planning_sample:Location", "North America")

ElementIndexElementIndex retorna o número de índice de um elemento dentro de uma dimensão.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ElementIndex(server_name:dimension, hierarchy, element)

Argumento Descrição

dimensão Um nome de dimensão válido qualificado pelonome do servidor.

hierarchy O nome da hierarquia dentro da dimensão.

elemento O nome de um elemento na dimensão.

Se o elemento não for membro da dimensãoespecificada, a função retornará 0.

Exemplo

Brasil possui um valor de índice de três na dimensão Região. O exemplo retorna 3.

ElementIndex('planning_sample:Region', 'South America', 'Brazil')

ElementIsAncestorElementIsAncestor determina se element1 é um antecessor de element2 na dimensão especificada. Afunção retorna 1 se element1 for um antecessor de element2, caso contrário, a função retorna 0.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ElementIsAncestor(dimension, hierarchy, element1, element2)

Argumento Descrição

dimensão Um nome de dimensão válido.

hierarchy O nome da hierarquia dentro da dimensão.

elemento1 O nome de um elemento na dimensão.

elemento2 O nome de um elemento na dimensão.

Capítulo 2. Funções das Regras 133

Exemplo

Na hierarquia Western da dimensão Region, o elemento Europe é um antecessor de Germany. O exemploretorna 1.

ElementIsAncestor('Region', 'Western', 'Europe', 'Germany')

ElementIsComponentElementIsComponent determina se o element1 é um filho do element2 na dimensão especificada. Afunção retorna 1 se element1 for um filho de element2, caso contrário, a função retorna 0.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ElementIsComponent(dimension, hierarchy, element1, element2)

Argumento Descrição

dimensão Um nome de dimensão válido.

hierarchy O nome da hierarquia dentro da dimensão.

elemento1 O nome de um elemento na dimensão.

elemento2 O nome de um elemento na dimensão.

Exemplo

Na dimensão Região, o elemento Europa Central é uma consolidação de dois elementos, Alemanha eFrança. O exemplo retorna 1.

Nota: esta função retorna 1 apenas para filhos imediatos. No exemplo acima, Alemanha é um filho deEuropa Central. Além disso, Europa Central é um filho de Europa.

ElementIsComponent('Region', 'Countries', 'Germany', 'Central Europe')

No entanto, como a função retorna 1 apenas para filhos imediatos, o exemplo a seguir retorna 0:

ElementIsComponent('Region', 'Countries'', 'Germany', 'Europe')

ElementIsParentElementIsParent determina se o element1 é um pai do element2 na dimensão especificada. A funçãoretorna 1 se element1 for um pai de element2, caso contrário, a função retorna 0.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ElementIsParent(dimension, hierarchy, element1, element2)

Argumento Descrição

dimensão Um nome de dimensão válido.

hierarchy O nome da hierarquia dentro da dimensão.

134 IBM Planning Analytics: Referência do TM1

Argumento Descrição

elemento1 O nome de um elemento na dimensão.

elemento2 O nome de um elemento na dimensão.

Exemplo

Na dimensão Região, o elemento consolidado Europa Central é o pai de Alemanha e França. De formaapropriada, o exemplo retorna 1.

Nota: esta função retorna 1 apenas para pais imediatos. No exemplo acima, Europa é um pai de EuropaCentral. Além disso, Europa Central é um pai de Alemanha.

ElementIsParent('Region', 'Countries', 'Central Europe', 'Germany')

No entanto, como Europa não é um pai imediato de Alemanha, o exemplo a seguir retorna 0:

ElementIsParent('Region', 'Countries', 'Europe', 'Germany')

ElementLevelElementLevel retorna o nível de um elemento dentro de uma dimensão.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ElementLevel(dimension, hierarchy, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

hierarchy O nome da hierarquia dentro da dimensão.

elemento O nome de um elemento na dimensão.

Exemplo

ElementLevel('Region','Countries', 'Europe')

Na dimensão Região, as nações individuais (Nível 0) somam-se às regiões (Nível 1). As regiões são entãoincluídas em super-regiões (Nível 2) que, por sua vez, são incluídas no mundo (Nível 3). O exemploretorna 2, pois Europa é um elemento de Nível 2.

Capítulo 2. Funções das Regras 135

NomeElementoElementName retorna o elemento de uma dimensão que corresponde ao argumento de índice.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ElementName(server_name:dimension, hierarchy, index)

Argumento Descrição

dimensão Um nome de dimensão válido qualificado pelonome do servidor.

hierarchy O nome da hierarquia dentro da dimensão.

índice Um valor menor ou igual ao número de elementosna dimensão.

Se este argumento for menor que 1 ou maior que onúmero de elementos na dimensão, a funçãoretornará 0.

Exemplo

Este exemplo retorna 'Belgium', que é o elemento na hierarquia Countries da dimensão Region com umvalor de índice igual a 2.

ElementName(planning_sample:'Region', 'Countries', 2)

ElementNextElementNext retorna o nome de elemento que segue o elemento especificado como um argumento paraa função.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ElementNext(dimension, hierarchy, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

Algumas instalações podem precisar qualificar onome da dimensão com o nome do servidor, comoem server_name:dimension.

hierarchy O nome da hierarquia dentro da dimensão.

elemento O nome de um elemento na dimensão. Esteargumento também pode ser o nome de um aliaspara um elemento de dimensão.

136 IBM Planning Analytics: Referência do TM1

Exemplo

Se a dimensão Local contiver os elementos ordenados Califórnia, Oregon e Washington, o exemploretornará Washington.

ElementNext("Location","Cities", "Oregon")

ElementParentElementParent retorna o pai de um elemento em uma dimensão especificada.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ElementParent(dimension, hierarchy, element, index)

Argumento Descrição

dimensão Um nome de dimensão válido.

hierarchy O nome da hierarquia dentro da dimensão.

elemento O nome de um elemento na dimensão.

índice Um valor positivo menor ou igual ao número totalde elementos consolidados (pais) que usam oargumento do elemento como um filho.

Exemplo

Na dimensão Modelo, o elemento Wagon 4x4 é um filho de Total de Wagons e de Total de 4x4. Portanto,Total de Wagons e Total de 4x4 são pais de Wagon 4x4. Na estrutura da dimensão do Modelo, Total deWagons é definido primeiro, Total de 4x4 é definido em segundo lugar.

ElementParent('Model', 'Automobile', 'Wagon 4WD', 2)

O exemplo retorna Total de 4x4, pois esta é a segunda instância de um pai para Wagon 4x4 na dimensãodo Modelo.

ElementParentCountElementParentCount retorna o número de pais de um elemento em uma dimensão especificada.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ElementParentCount(dimension, hierarchy, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

hierarchy O nome da hierarquia dentro da dimensão.

elemento O nome de um elemento na dimensão.

Capítulo 2. Funções das Regras 137

Exemplo

Na dimensão do Modelo, o elemento Wagon 4x4 é um filho de Total de Wagons e de Total de 4x4.Portanto, Total de Wagons e Total de 4x4 são pais de Wagon 4x4. A função retorna 2.

ElementParentCount('Model', 'Automobile', 'Wagon 4WD')

Tipo de ElementoElementType retorna informações sobre o tipo de elemento de um elemento especificado. ElementTyperetorna N se o elemento é um elemento numérico, S se o elemento é um elemento de sequência e C se oelemento é um elemento consolidado.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ElementType(dimension, hierarchy, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

hierarchy O nome da hierarquia dentro da dimensão.

elemento O nome de um elemento na dimensão.

Exemplo

O elemento Europa é um elemento consolidado da dimensão Região, portanto, o exemplo retorna C.

ElementType('Region', 'Countries', 'Europe')

ElementWeightElementWeight retorna o peso de um filho em um elemento consolidado.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ElementWeight(dimension, hierarchy, element1, element2)

Argumento Descrição

dimensão Um nome de dimensão válido.

hierarchy O nome da hierarquia dentro da dimensão.

elemento1 O nome de um elemento consolidado na dimensão.

elemento2 O nome de um filho do elemento consolidado.

138 IBM Planning Analytics: Referência do TM1

Exemplo

O elemento Custos Variáveis, que é um filho de Margem bruta, possui um peso de -1. O exemplo a seguirretorna -1.

ElementWeight('Account1', 'SubAccount1', 'Gross margin', 'Variable Costs')

ELISANCELISANC determina se element1 é um antecessor de element2 na dimensão especificada. A funçãoretorna 1 se element1 for um antecessor de element2, caso contrário, a função retorna 0.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ELISANC(dimension, element1, element2)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento1 O nome de um elemento na dimensão.

elemento2 O nome de um elemento na dimensão.

Exemplo

Na dimensão Região, o elemento Europa é um antecessor de Alemanha. O exemplo retorna 1.

ELISANC('Region', 'Europe','Germany')

ELISCOMPO ELISCOMP determina se o elemento1 é um filho do elemento2 na dimensão especificada. A funçãoretorna 1 se element1 for um filho de element2, caso contrário, a função retorna 0.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ELISCOMP(dimension, element1, element2)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento1 O nome de um elemento na dimensão.

elemento2 O nome de um elemento na dimensão.

Exemplo

Na dimensão Região, o elemento Europa Central é uma consolidação de dois elementos, Alemanha eFrança. O exemplo a seguir retorna 1.

Capítulo 2. Funções das Regras 139

Nota: esta função retorna 1 apenas para filhos imediatos. Nesse exemplo, Germany é um filho de CentralEurope. Além disso, Europa Central é um filho de Europa.

ELISCOMP('Region','Germany','Central Europe')

No entanto, como a função retorna 1 apenas para filhos imediatos, o exemplo a seguir retorna 0:

ELISCOMP('Region','Germany','Europe')

ELISPARO ELISPAR determina se o elemento1 é um pai do elemento2 na dimensão especificada. A função retorna1 se element1 for um pai de element2, caso contrário, a função retorna 0.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ELISPAR(dimension, element1, element2)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento1 O nome de um elemento na dimensão.

elemento2 O nome de um elemento na dimensão.

Exemplo

Na dimensão Região, o elemento consolidado Europa Central é o pai de Alemanha e França. Assim, oexemplo a seguir retorna 1.

Nota: esta função retorna 1 apenas para pais imediatos. Nesse exemplo, Europe é um pai de CentralEurope. Além disso, Europa Central é um pai de Alemanha.

ELISPAR('Region','CentralEurope','Germany')

No entanto, como Europa não é um pai imediato de Alemanha, o exemplo a seguir retorna 0:

ELISPAR('Region','Europe','Germany')

ELLEVO ELLEV retorna o nível de um elemento em uma dimensão.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ELLEV(dimension, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento O nome de um elemento na dimensão.

140 IBM Planning Analytics: Referência do TM1

Exemplo

ELLEV('Region','Europe')

Na dimensão Região, as nações individuais (Nível 0) somam-se às regiões (Nível 1). As regiões são entãoincluídas em super-regiões (Nível 2) que, por sua vez, são incluídas no mundo (Nível 3). O exemploretorna 2, pois Europa é um elemento de Nível 2.

ELPARO ELPAR retorna o pai de um elemento em uma dimensão especificada.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ELPAR(dimension, element, index)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento O nome de um elemento na dimensão.

índice Um valor positivo menor ou igual ao número totalde elementos consolidados (pais) que usam oargumento do elemento como um filho.

Exemplo

Na dimensão Modelo, o elemento Wagon 4x4 é um filho de Total de Wagons e de Total de 4x4. Portanto,Total de Wagons e Total de 4x4 são pais de Wagon 4x4. Na estrutura da dimensão do Modelo, Total deWagons é definido primeiro, Total de 4x4 é definido em segundo lugar.

ELPAR('Model','Wagon 4WD',2)

O exemplo retorna Total de 4x4, pois esta é a segunda instância de um pai para Wagon 4x4 na dimensãodo Modelo.

ELPARNO ELPARN retorna o número de pais de um elemento em uma dimensão especificada.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ELPARN(dimension, element)

Capítulo 2. Funções das Regras 141

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento O nome de um elemento na dimensão.

Exemplo

Na dimensão do Modelo, o elemento Wagon 4x4 é um filho de Total de Wagons e de Total de 4x4.Portanto, Total de Wagons e Total de 4x4 são pais de Wagon 4x4. A função retorna 2.

ELPARN('Model','Wagon 4WD')

ELWEIGHTO ELWEIGHT retorna o peso de um filho em um elemento consolidado.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

ELWEIGHT(dimension, element1, element2)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento1 O nome de um elemento consolidado na dimensão.

elemento2 O nome de um filho do elemento consolidado.

Exemplo

O elemento Custos Variáveis, que é um filho de Margem bruta, possui um peso de -1.

O exemplo a seguir retorna -1.

ELWEIGHT('Account1','Gross margin','Variable Costs')

LevelCountLevelCount retorna os níveis de número em uma dimensão.

Essa função é válida em regras do TM1 e em processos do Turbo Integrator.

Sintaxe

LevelCount(dimension, hierarchy)

Argumento Descrição

dimensão Um nome de dimensão válido.

Algumas instalações podem precisar qualificar onome da dimensão com o nome do servidor, comoem server_name:dimension.

142 IBM Planning Analytics: Referência do TM1

Argumento Descrição

hierarchy O nome da hierarquia dentro da dimensão.

Exemplo

LevelCount('Region', 'Countries')

Na dimensão Região, as diversas nações (Nível 0) somam-se às regiões (Nível 1). As regiões são entãoincluídas em super-regiões (Nível 2) que, por sua vez, são incluídas no mundo (Nível 3).

Existem quatro níveis na dimensão Região, portanto, o exemplo retorna o valor 4.

Funções de Regras FinanceirasFunções de regras usadas para gerenciar informações financeiras.

VFFV retorna o valor de uma anuidade no momento do último pagamento. Uma anuidade é uma série depagamentos feitos em intervalos iguais de tempo. Os pagamentos devem ser feitos no final de cadaperíodo.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

FV(payment, interest, periods)

Argumento Descrição

pagamento A quantia do pagamento feito por período.

interesse A taxa de juros paga por período.

períodos O número de períodos na anuidade.

Exemplo

Este exemplo retorna o valor de uma anuidade no final de 5 anos, com pagamentos de R$ 1.000 por anocom 14% de juros.

FV(1000,.14,5)

Capítulo 2. Funções das Regras 143

PAYMTPAYMT retorna a quantia de pagamento de uma anuidade com base em um determinado valor ouprincipal, em uma taxa de juros e em uma quantidade de períodos. Uma anuidade é uma série depagamentos feitos em intervalos iguais de tempo.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

PAYMT(principal, interest, periods)

Argumento Descrição

principal O valor presente, ou a quantia total que éequivalente no momento a uma série depagamentos futuros.

interesse A taxa de juros paga por período.

períodos O número de períodos na anuidade. Ospagamentos devem ser feitos no final de cadaperíodo.

Exemplo

Este exemplo retorna o pagamento em uma anuidade de 5 anos, que é pago anualmente, com umprincipal de R$ 100.000 com 14% de juros.

PAYMT(100000, .14, 5)

VPPV retorna o valor inicial ou principal de uma anuidade.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

PV(payment, interest, periods)

Argumento Descrição

pagamento A quantia do pagamento feito.

interesse A taxa de juros paga por período.

períodos O número de períodos na anuidade. Ospagamentos devem ser feitos no final de cadaperíodo.

Exemplo

Este exemplo retorna o valor principal de uma anuidade com 5 pagamentos anuais de R$ 1.000 com 14%de juros.

PV(1000, .14, 5)

144 IBM Planning Analytics: Referência do TM1

Funções de regras de hierarquiasFunções para gerenciar hierarquias em regras.

HierarquiaCaso haja apenas uma hierarquia incluída na dimensão fornecida, Hierarchy retornará o nome dahierarquia. Caso contrário, retornará uma sequência de caracteres vazia. Hierarchy é válida apenas emregras do TM1.

Com a introdução do suporte para várias hierarquias no TM1, é necessário identificar quais hierarquiasestão no contexto quando várias hierarquias estiverem em uso.

Hierarchy não pode ser usada em processos do Turbo Integrator. A presença desta função em umprocesso impedirá a compilação do processo.

Sintaxe

Hierarchy (DimName);

Argumento Descrição

DimName Um nome de dimensão válido.

Exemplo

Este exemplo retorna 'Quarter', que é a única hierarquia na dimensão Quarter.

Hierarchy ('Quarter');

HierarchyCountHierarchyCount retorna o número de hierarquias na dimensão fornecida. HierarchyCount é válida apenasem regras do TM1.

HierarchyCount não pode ser usada em processos do Turbo Integrator. A presença desta função em umprocesso impedirá a compilação do processo.

Sintaxe

HierarchyCount (DimName);

Argumento Descrição

DimName Um nome de dimensão válido.

Exemplo

Este exemplo retorna 3, que é o número de hierarquias na dimensão do modelo.

HierarchyCount ('model');

HierarchyIndexHierarchyIndex retorna um índice baseado em 1 se a hierarquia estiver na dimensão fornecida; casocontrário, retorna 0. HierarchyIndex é válida apenas em regras do TM1.

HierarchyIndex não pode ser usada em processos do Turbo Integrator. A presença desta função em umprocesso impedirá a compilação do processo.

Capítulo 2. Funções das Regras 145

Sintaxe

HierarchyIndex (DimName, HierName);

Argumento Descrição

DimName Um nome de dimensão válido.

HierName Um nome de hierarquia válido que você desejeencontrar na posição de índice em DimName.

Exemplo

Este exemplo retorna 3, que é a posição de índice da hierarquia CustomerTarget na dimensão do modelo.

HierarchyIndex ('model', 'CustomerTarget');

HierarchyNHierarchyN retorna o nome da hierarquia em uma posição especificada na dimensão fornecida e umasequência de caracteres vazia, caso o índice esteja fora do escopo. HierarchyN é válida apenas em regrasdo TM1.

HierarchyN não pode ser usada em processos do Turbo Integrator. A presença desta função em umprocesso impedirá a compilação do processo.

Sintaxe

HierarchyN (DimName, index);

Argumento Descrição

DimName Um nome de dimensão válido.

índice Um valor menor ou igual ao número de hierarquiasna dimensão.

Se este argumento for menor que 1 ou maior que onúmero de hierarquias na dimensão, a funçãoretornará 0.

Exemplo

Este exemplo retorna 'CustomerTarget', que é a terceira hierarquia na dimensão do modelo.

HierarchyN ('model', 3);

Funções de Regras LógicasOperadores lógicos para usar em regras.

CONTINUEQuando incluído como parte de uma expressão de regra, CONTINUE permite que uma regra subsequentecom a mesma definição de área seja executada. Normalmente, o TM1 executa apenas a primeira regraencontrada para uma determinada área.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

146 IBM Planning Analytics: Referência do TM1

Sintaxe

CONTINUE

Argumentos

Nenhum.

Exemplo

['Jan']= if(!region @='Argentina',10,CONTINUE);

['Jan']=20;

Neste exemplo, a todas as células identificadas por Janeiro e Argentina é designado um valor de 10. Àscélulas identificadas por Jan e qualquer outro elemento Região é designado um valor de 20.

SESE retorna um valor se uma expressão lógica especificada for TRUE e outro valor se ela for FALSE.

Esta função é válida apenas em regras do TM1.

O Turbo Integrator usa sua própria função IF, que é capaz de avaliar várias expressões lógicas.

Sintaxe

IF(expression, true_value, false_value)

Argumento Descrição

expression Qualquer valor ou expressão que pode ser avaliadacomo TRUE ou FALSE.

true_value Um valor que é retornado se a expressão for TRUE.

false_value Um valor que é retornado se a expressão forFALSE.

Exemplo

IF(1<2, 4, 5) retorna 4.

IF(1>2, 'ABC', 'DEF') retorna 'DEF'.

STETA função STET cancela o efeito de uma regra para um determinado elemento.

Esta é uma função de regras do TM1 válida apenas nas regras do TM1. Esta função não pode ser usadaem processos do Turbo Integrator.

Sintaxe

STET

Argumentos

Nenhum.

Capítulo 2. Funções das Regras 147

Exemplo

Neste exemplo, a regra indica que o valor para Vendas é sempre 100, exceto para a interseção de Vendase o elemento França da dimensão Região.

['Sales'] = IF(!Region @= 'France',STET, 100);

Funções de Regras MatemáticasOperadores matemáticos para usar em regras.

ABSABS retorna o valor absoluto de um número.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

ABS(x)

Argumento Descrição

x O número para o qual você deseja localizar o valorabsoluto.

Exemplo

ABS(-1.2) retorna 1.2

ACOSACOS retorna o ângulo, em radianos, cujo cosseno é x.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

ACOS(x)

Argumento Descrição

x O cosseno do ângulo que você deseja localizar. xdeve estar entre -1 e 1; caso contrário, a funçãoretornará um erro.

Exemplo

ACOS(0) retorna 1.5708.

ASENASIN retorna o ângulo, em radianos, cujo seno é x.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

ASIN(x)

148 IBM Planning Analytics: Referência do TM1

Argumento Descrição

x O seno do ângulo que você deseja localizar. x deveestar entre -1 e 1; caso contrário, a funçãoretornará um erro.

Exemplo

ASIN(1) retorna 1.5708.

ATANATAN retorna o ângulo, em radianos, cuja tangente é x. O resultado está entre -pi/2 e +pi/2.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

ATAN(x)

Argumento Descrição

x A tangente do ângulo que você deseja localizar.

Exemplo

ATAN(1) retorna .7854.

COSCOS retorna o cosseno de um ângulo expresso em radianos.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

COS(x)

Argumento Descrição

x Um ângulo, expresso em radianos, para o qualvocê deseja localizar o cosseno.

Exemplo

COS(0) retorna 1.

EXPEXP retorna o antilogaritmo natural de um número.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

EXP(x)

Capítulo 2. Funções das Regras 149

Argumento Descrição

x Um número para o qual você deseja localizar oantilogaritmo natural.

Exemplo

EXP(1) retorna 2.71828.

INTINT retorna o maior número inteiro que é menor ou igual a um valor especificado.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

INT(x)

Argumento Descrição

x Um valor numérico.

Exemplo

INT(5.6) retorna 5.

INT(-5.6) retorna -6.

ISUNDISUND retorna 1 se um valor especificado for indefinido; caso contrário, retorna 0.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

ISUND(x)

Argumento Descrição

x Um número ou expressão.

Exemplo

ISUND(5.2) retorna 0.

ISUND(1/0) retorna 1.

LNLN retorna o logaritmo natural (base e) de um número.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

LN(x)

150 IBM Planning Analytics: Referência do TM1

Argumento Descrição

x Um número positivo. A função retorna um erro se xfor negativo ou zero.

Exemplo

LN(10) retorna 2.302585093.

LOGLOG retorna o logaritmo de base 10 de um número positivo.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

LOG(x)

Argumento Descrição

x Um número positivo. A função retorna um erro se xfor negativo ou zero.

Exemplo

LOG(10) retorna 1.

MÁXIMOMAX retorna o maior número em um par de valores.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

MAX(num1, num2)

Argumento Descrição

num1 O primeiro em um par de valores.

num2 O segundo em um par de valores.

Exemplo

MAX(10, 3) retorna 10.

MÍNIMOMIN retorna o menor número em um par de valores.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

MIN(num1, num2)

Capítulo 2. Funções das Regras 151

Argumento Descrição

num1 O primeiro em um par de valores.

num2 O segundo em um par de valores.

Exemplo

MIN(10, 3) retorna 3.

RestoMOD retorna o resto da divisão de um número por um divisor.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

MOD(number, divisor)

Argumento Descrição

number O número para o qual você deseja localizar o resto.

divisor O valor pelo qual o argumento do número édividido.

Exemplo

MOD(10, 3) retorna 1.

ALEATÓRIORAND gera um numéro aleatório que é distribuído uniformemente entre 0 e 1. O gerador de númeroaleatório é propagado quando o TM1 é carregado.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

RAND.

Argumentos

Nenhum.

Exemplo

RAND gera um número aleatório que é distribuído de maneira uniforme entre 0 e 1

ARREDROUND arredonda um número especificado para o número inteiro mais próximo. O arredondamento podeser feito de diversas formas válidas.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

A forma mais básica de arredondamento é substituir um número arbitrário por um número inteiro. Hámuitas formas de arredondar um número y para um número inteiro q.

152 IBM Planning Analytics: Referência do TM1

As mais comuns são:

• Arredondar para o mais próximo

q é o número inteiro mais próximo de y (consulte "Arredondar acima de zero" para obter regras dedesempate).

• Arredondar em direção a zero (ou truncar)

q é a parte inteira de y, sem os dígitos fracionais.• Arredondar para baixo (ou obter o piso)

q é o número inteiro maior que não excede y.• Arredondar para cima (ou obter o limite)

q é o menor inteiro que não é menos do que y.• Arredondar acima de zero

Se y for um número inteiro, q é y; do contrário, q é o número inteiro mais próximo de 0 e de tal formaque y está entre 0 e q.

O Turbo Integrator usa, essencialmente, o método Arredondar para baixo de floor(x + .5). O MicrosoftExcel utiliza o método Arredondar para o mais próximo. Isso pode resultar em números inteirosdiferentes, dependendo de estar usando um processo do Turbo Integrator ou trabalhando no Excel.

Sintaxe

ROUND(number)

Argumento Descrição

number O número que você deseja arredondar.

Exemplo

ROUND(1.46) retorna 1.

ROUNDPROUNDP arredonda um número especificado em uma precisão decimal especificada.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

ROUNDP(number, decimal)

Argumento Descrição

number O número que você deseja arredondar.

decimal A precisão decimal na qual aplicar oarredondamento. Se este argumento for positivo, afunção arredondará o número especificado dedígitos à direita do ponto decimal. Se esteargumento for negativo, a função arredondará onúmero especificado de dígitos à esquerda doponto decimal.

O argumento decimal deve estar entre -15 e 15,inclusive.

Capítulo 2. Funções das Regras 153

Exemplo

ROUNDP(1.46, 1) retorna 1.5.

ROUNDP(1.466, 2) retorna 1.47.

ROUNDP(234.56, -1) retorna 230.00.

ROUNDP(234.56, 0) retorna 235.00.

SINALSIGN determina se um número é positivo, negativo ou zero. A função retorna 1 se o número for positivo,-1 se o número for negativo e 0 se o número for zero.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

SIGN(number)

Argumento Descrição

number Um número.

Exemplo

SIGN(-2.5) retorna -1.

SENSIN retorna o seno de um determinado ângulo.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

SIN(x)

Argumento Descrição

x Um valor, expresso em radianos, para o qual vocêdeseja o seno.

Exemplo

SIN(1.5708) retorna 1.

RAIZSQRT retorna a raiz quadrada de um determinado valor.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

SQRT(x)

154 IBM Planning Analytics: Referência do TM1

Argumento Descrição

x Qualquer valor positivo. SQRT retorna um erro se xfor negativo.

Exemplo

SQRT(16) retorna 4.

TANTAN retorna a tangente de um determinado ângulo.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

TAN(x)

Argumento Descrição

x Um valor, expresso em radianos, para o qual vocêdeseja a tangente.

Exemplo

TAN(0) retorna 0.

TAN(.7854) retorna 1.

Funções de Regras de TextoRegras para gerenciar texto em regras.

CAPITCAPIT aplica letra maiúscula inicial a cada palavra em uma sequência.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

CAPIT(string)

Argumento Descrição

sequência Uma sequência de texto.

Exemplo

CAPIT('first quarter sales') retorna 'First Quarter Sales'.

CARACTCHAR retorna o caractere identificado por um determinado código numérico ASCII.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Capítulo 2. Funções das Regras 155

Sintaxe

CHAR(number)

Argumento Descrição

number Um número de código ASCII. Este número deveestar entre 1 e 255, inclusive.

Exemplo

CHAR(100) retorna 'd'.

CÓDIGOCODE retorna o código numérico ASCII para um caractere especificado em uma sequência.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

CODE(string, location)

Argumento Descrição

sequência Uma sequência de texto.

local Um número que especifica o caractere nasequência para o qual você deseja localizar o valorde código ASCII.

Exemplo

CODE('321', 2) retorna 50.

CODE('End', 3) retorna 100.

DELETDELET retorna o resultado da exclusão de um número especificado de caracteres de um ponto de inícioespecificado em uma sequência.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

DELET(string, start, number)

Argumento Descrição

sequência Uma sequência de texto.

start O caractere no qual começa a exclusão.

number O número de caracteres a serem excluídos.

156 IBM Planning Analytics: Referência do TM1

Exemplo

DELET('payment', 3, 3) retorna 'pant'.

FILLFILL repete uma determinada sequência, conforme necessário, para retornar uma sequência de umcomprimento especificado.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

FILL(string, length)

Argumento Descrição

sequência Uma sequência de texto. Esta sequência érepetida, conforme necessário, para obter ocomprimento especificado.

comprimento O comprimento da sequência que você deseja queseja retornada pela função.

Exemplo

FILL('-', 5) retorna '-----'.

FILL('ab', 5) retorna 'ababa'.

INSRTINSRT insere uma sequência em outra sequência em um ponto de inserção especificado.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

INSRT(string1, string2, location)

Argumento Descrição

string1 Uma sequência de texto.

string2 Uma sequência de texto.

local O caractere em string2 na qual você deseja inserirstring1. A função insere string1 em string2imediatamente antes do caractere especificado.

Exemplo

INSRT('ABC', 'DEF', 2) retorna 'DABCEF'.

LONGLONG retorna o comprimento de uma sequência.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Capítulo 2. Funções das Regras 157

Sintaxe

LONG(string)

Argumento Descrição

sequência Uma sequência de texto.

Exemplo

LONG('Sales') retorna 5.

MINÚSCULALOWER converte todos os caracteres maiúsculos em uma sequência em minúsculos.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

LOWER(string)

Argumento Descrição

sequência Uma sequência de texto.

Exemplo

LOWER('First Quarter Sales') retorna 'first quarter sales'.

NUMBRNUMBR converte uma sequência em um número. A sequência transmitida para a função NUMBR deveusar . (ponto) como o separador decimal e , (vírgula) como o separador de milhares. Qualquer outroseparador decimal/de milhares causará resultados incorretos.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

NUMBR(string)

Argumento Descrição

sequência A sequência que você deseja converter em umnúmero. Todos os caracteres diferentes de '0' a '9','+', '-', '.'e 'E' são ignorados.

Exemplo

NUMBR('-5.6') retorna -5.6.

NUMBR('-5A. B6C') retorna -5.6.

SCANSCAN retorna um número que indica o local de início da primeira ocorrência de uma subsequênciaespecificada em uma sequência. Se a subsequência não ocorrer na sequência especificada, a funçãoretornará 0.

158 IBM Planning Analytics: Referência do TM1

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

SCAN(substring, string)

Argumento Descrição

subsequência A subsequência que você está tentando localizar.

sequência A sequência na qual você está procurando asubsequência.

Os argumentos para essa função fazem distinção entre maiúsculas e minúsculas. A capitalização usadano argumento substring deve corresponder exatamente à capitalização usada no argumento stringpara que a função retorne um valor diferente de zero.

Exemplo

SCAN('scribe', 'described') retorna 3.

No entanto, SCAN('Scribe', 'described') retorna 0, porque maiúsculas e minúsculas noargumento substring (Scribe) não corresponde a maiúsculas e minúsculas no argumento string(described).

STRSTR converte um número em uma sequência.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

STR(number, length, decimal)

Argumento Descrição

number O número que está sendo convertido em umasequência.

Esse número pode conter um sinal positivo ounegativo.

Este número pode conter casas decimais.

Capítulo 2. Funções das Regras 159

Argumento Descrição

comprimento O comprimento da sequência no resultado dafunção, incluindo sinal, separadores, decimais oucasas decimais.

Se o número de dígitos no número for menor que oparâmetro de comprimento, a função poderáinserir espaços iniciais em branco para atingir essecomprimento após a inserção de sinais,separadores, decimais ou casas decimais.

Se o número de dígitos no número exceder oparâmetro de comprimento, a função truncará onúmero para atingir esse comprimento.

Se o parâmetro de comprimento for especificado,ele deverá ser um número positivo maior que "0".

Se o parâmetro de comprimento não forespecificado, o parâmetro de número serápreservado e o comprimento do resultado dafunção incluirá, separadores, decimais, casasdecimais e casas decimais.

decimal O número de casas decimais a serem incluídas noresultado da função.

Se esse parâmetro for "0" ou não for especificado,um separador decimal não será incluído.

Se o número especificado tiver mais casasdecimais do que o número de casas decimaissolicitadas, o resultado da função seráarredondado.

Exemplos

Chamada defunção

Número Comprimento Decimal Resultado

STR( 3.14159, 6, 2) 3.14159 6 2 " 3.14"

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 "

Observe que onúmero é truncado.

STR (1000000,4, 2) 1000000 4 2 " 1000000.00 "

Observe que onúmero não étruncado porque odecimal estáespecificado.

STR (10,2, 4) 10 2 4 " 10.0000 "

STR (1000000,5, 0) 1000000 5 0 " 1.000 "

160 IBM Planning Analytics: Referência do TM1

Chamada defunção

Número Comprimento Decimal Resultado

Observe que onúmero é truncado.Isto é o que seráretornado se osseparadores devírgula foremespecificados.

STR (1000000, 10,5)

1000000 10 5 " 1.000.000.00000"

Observe que isso éo que seráretornado seseparadores devírgula foremespecificados.

SUBSTSUBST retorna uma subsequência de uma determinada sequência.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

SUBST(string, beginning, length)

Argumento Descrição

sequência A sequência da qual você deseja extrair asubsequência.

beginning O caractere no qual a subsequência é iniciada.

comprimento O comprimento da subsequência.

Exemplo

SUBST('Retirement', 3, 4) retorna 'tire'.

ARRUMARTRIM retorna o resultado do corte de espaços em branco à esquerda e à direita de uma sequência.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

TRIM(string)

Argumento Descrição

sequência Uma sequência de texto.

Capítulo 2. Funções das Regras 161

Exemplo

TRIM(' First Quarter ') retorna 'First Quarter'.

MAIÚSCULAUPPER converte uma sequência de texto em maiúsculas.

Esta função é válida em ambos os processos TM1 Rules e TurboIntegrator.

Sintaxe

UPPER(string)

Argumento Descrição

sequência Uma sequência de texto.

Exemplo

UPPER('First Quarter Results') retorna FIRST QUARTER RESULTS.

Diversas Funções de RegrasFunções de regras não localizadas em outras categorias.

FEEDERSAo usar uma declaração SKIPCHECK para restaurar a consolidação dispersa em uma regra do TM1, deve-se também assegurar que todas as células derivadas de regras sejam identificadas por instruções doalimentador. Para isso, insira uma declaração FEEDERS imediatamente após todas as instruções deregras:

FEEDERS;

Imediatamente após a declaração FEEDERS, você deve criar instruções de alimentadores que identificamas células derivadas de regras no cubo.

Para acessar as informações completas sobre as regras do TM1, incluindo consolidação dispersa e acriação de alimentação, consulte o TM1 Rules.

FEEDSTRINGSOs valores de sequência gerados por regras não são exibidos quando uma visualização tem supressão dezeros, a menos que a sequência resida em uma célula alimentada. Para ativar a alimentação de células desequência, insira a declaração FEEDSTRINGS como a primeira linha de sua regra.

FEEDSTRINGS;

Quando esta declaração estiver em operação, será possível configurar alimentadores para células desequência em uma visualização do cubo, e contar com a sequência que ficará disponível para outrasregras, mesmo que a visualização tenha supressão de zeros. As instruções que definem alimentadorespara células de sequência devem ser criadas abaixo da declaração FEEDERS em sua regra.

Como no caso de alimentadores numéricos, uma alimentação para uma célula consolidada resulta naalimentação de todos os componentes da consolidação. Como é possível armazenar sequências emcélulas consolidadas, você deve dar uma atenção especial se tais células forem usadas para alimentaroutras células. O uso excessivo de alimentadores de sequência pode resultar em explosões de cálculos eem um desempenho do aplicativo insatisfatório.

162 IBM Planning Analytics: Referência do TM1

Para obter uma discussão completa sobre as regras do TM1, incluindo a criação de alimentadores,consulte Regras do TM1.

SKIPCHECKÉ possível restaurar a consolidação dispersa e melhorar o desempenho, inserindo uma declaraçãoSKIPCHECK no início da regra TM1.

Durante as consolidações, o TM1 usa um algoritmo de consolidação dispersa para ignorar as células quecontêm zero ou estão vazias. Este algoritmo acelera os cálculos de consolidação em cubos que sãoaltamente dispersos. Um cubo disperso é um cubo no qual o número de células preenchidas como umaporcentagem do total de células é baixo.

Ao consolidar dados em cubos que possuem regras definidas, o TM1 desativa esse algoritmo deconsolidação dispersa porque uma ou mais células vazias podem, de fato, ser calculadas por uma regra.(Ignorar células calculadas por regras resultará em totais consolidados incorretos). Quando o algoritmode consolidação dispersa for desativado, em cada célula será verificado um valor durante a consolidação.Isto pode reduzir cálculos em cubos que são muito grandes e dispersos.

SKIPCHECK;

Se sua regra usar uma instrução FEEDSTRINGS, a instrução SKIPCHECK deverá ser a segunda instruçãona regra. Se sua regra não usar uma instrução FEEDSTRINGS, a instrução SKIPCHECK deverá ser aprimeira instrução na regra.

Ao usar SKIPCHECK para restaurar a consolidação espalhada, você também deve assegurar que suaregra inclua uma declaração FEEDERS e que todas as células derivadas de regras sejam identificadas porinstruções do alimentador.

Para acessar as informações completas sobre as regras do TM1, incluindo consolidação dispersa e acriação de alimentação, consulte o TM1 Rules.

Capítulo 2. Funções das Regras 163

164 IBM Planning Analytics: Referência do TM1

Capítulo 3. Funções de MacroO IBM Planning Analytics inclui um conjunto de funções macro que podem ser incorporadas nas macrosdo Microsoft Excel. É possível usar funções de macro no TM1 Perspectives para acessar servidores, dadosde cubo e estruturas e opções do TM1.

Nota: Antes de executar essas macros, deve-se carregar o suplemento do TM1 (Tm1p.xla). Para obterinformações sobre o carregamento de suplementos, consulte a ajuda do Microsoft Excel.

Acessando funções macro do Microsoft Excel 2010 e posterior

Procedimento

1. Clique com o botão direito do mouse na guia da planilha da planilha ativa.2. No menu de atalho, clique em Inserir.3. Clique duas vezes em Macro do MS Excel 4.0.4. Clique na célula em que deseja colocar a função macro.5. Clique em Fórmulas e, em seguida, clique em Inserir Função.6. Na lista de categoria, selecione TM1.7. Selecione a função que deseja inserir e, em seguida, clique em OK.8. Digite valores para os argumentos.9. Clique em OK para colocar a função na célula atual na planilha de macro.

Acessando Funções de Macro a partir de Módulos VBAPara acessar funções de macro a partir de módulos VBA, use o método Run.

Run ("macro_function", arg1, ...)

Exemplo

Sub Elemlist( ) Worksheets("Sheet1").Select Cells(3,5).Select ActiveCell.Value = Run ("E_PICK", "local:Region")End Sub

Este procedimento chama a função de macro E_PICK, que acessa uma lista de elementos na dimensãoRegião. O elemento selecionado preenche uma célula na planilha Planilha1.

D_PICKD_PICK chama uma caixa de diálogo que lista todas as dimensões disponíveis no diretório de dados locale em servidores remotos conectados. A dimensão selecionada na caixa de diálogo torna-se o valor dafunção D_PICK.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

D_PICK

© Copyright IBM Corp. 2007, 2019 165

Argumentos

Nenhum.

D_FSAVED_FSAVE permite criar ou atualizar dimensões muito grandes cujas planilhas de dimensões excederiam olimite da linha de uma planilha do Excel.

Para usar a função D_FSAVE, crie um arquivo ASCII delimitado, chamado dim.dit, em que dim é o nomeda dimensão que você deseja criar ou atualizar. Este arquivo deve residir no diretório de dados local.

A estrutura do arquivo ASCII deve corresponder a uma planilha de dimensões, da seguinte forma:

• Inclua três campos por linha.• No primeiro campo, especifique o tipo de elemento (C para consolidado; N para elemento numérico; S

para elemento de sequência; em branco para componente de consolidação).• No segundo campo, especifique o nome de elemento.• No terceiro campo, especifique o peso, se necessário. O peso padrão é 1.0.

Separe os campos usando o delimitador definido em seu sistema operacional. No Windows, essedelimitador é definido pela entrada de Separador de Lista na diálogo de Propriedades de ConfiguraçãoRegional.

Se houver erros na estrutura do arquivo ASCII, tais como, elementos fora do lugar ou indefinidos, seráexibida uma mensagem de erro.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

D_FSAVE(file)

Argumento Descrição

arquivo O nome de um arquivo ASCII delimitado que tem aextensão do arquivo .dit. Não inclua a extensão doarquivo. Este arquivo deve residir no diretório dedados local do TM1.

Exemplo

=D_FSAVE("Region")

Este exemplo lê um arquivo ASCII chamado Region.dit e cria ou atualiza a dimensão Região.

Nota: D_FSAVE pode ser usada para criar ou atualizar dimensões em servidores remotos. No entanto, afunção sempre procura o arquivo .dit no diretório de dados local (conforme definido no Tm1p.ini).Certifique-se de que o arquivo .dit para a dimensão que você deseja criar/atualizar resida em seu diretóriode dados local, em seguida, especifique o servidor no qual deseja criar/atualizar a dimensão, prefixando oarquivo .dit com o nome do servidor.

=D_FSAVE("TM1Serv:Region")

Este exemplo procura um arquivo chamado Region.dit no diretório de dados do servidor local, mas gravaa dimensão Region no diretório de dados do servidor TM1Serv.

166 IBM Planning Analytics: Referência do TM1

D_SAVED_SAVE salva a planilha ativa como um arquivo de planilha de dimensões (dim.xdi). O nome da pasta detrabalho é usado como o nome do arquivo. O TM1 então cria ou atualiza a dimensão especificada pelonome da pasta de trabalho.

Se a planilha ativa não estiver em conformidade com um formato de planilha de dimensões ou nãocontiver algumas informações, será exibida uma mensagem de erro. Por exemplo, você deve definir todosos elementos usados em uma consolidação de nível 1 como elementos numéricos (N).

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

D_SAVE

Argumentos

Nenhum.

DBProportionalSpreadDBProportionalSpread distribui um valor especificado para as folhas de uma consolidação proporcionalaos valores de célula existentes.

A função é análoga ao método de difusão de dados em Difusão Proporcional, que está descrito emdetalhes na documentação do TM1 Perspectives e do TM1 Architect.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

DBProportionalSpread( value, server:cube, e1, e2, e3...,e16 )

Argumento Descrição

valor O valor que você deseja distribuir.

servidor:cubo O nome do cubo, prefixado com o nome doservidor apropriado, no qual você deseja distribuiro valor.

Por exemplo, para distribuir valores para o cuboSales no servidor de Contabilidade, especifiqueAccounting:Sales.

e1...e16 Os nomes dos elementos que identificam aconsolidação cujas folhas aceitarão o valordistribuído.

Exemplo

DBProportionalSpread( 2000, "Accounting:Sales", "Actual", "Argentina","S Series 1.8L Sedan", "Sales", "1 Quarter" )

Capítulo 3. Funções de Macro 167

Este exemplo distribui o valor 2000 para os filhos da consolidação identificados pelos elementos Real,Argentina, Sedã Série S 1.8L, Vendas e 1 Trimestre. Ele distribui valores para o cubo Sales no servidor deContabilidade.

E_PICKE_PICK chama o Editor de Subconjunto listando todos os elementos na dimensão especificada. O nomede elemento selecionado no Editor de Subconjunto torna-se o valor de retorno da função E_PICK.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

E_PICK(Dimension, Alias, Subset, Element)

Argumento Descrição

Dimensão Um nome de dimensão válido. A dimensão poderesidir no diretório de dados local ou em umservidor remoto ao qual esteja conectado.

Use um prefixo de nome do servidor para indicar olocal do servidor. Para o servidor local, especifiquelocal:dim. Para um servidor remoto, especifiqueservername:dim.

Alias O nome de um alias existente para o subconjunto.Quando este parâmetro for definido, o alias seráaplicado quando o subconjunto for aberto no Editorde Subconjunto e a função retornar o alias para oelemento selecionado.

Se optar por não definir um parâmetro Alias, vocêdeverá transmitir uma sequência vazia para afunção.

Subconjunto O nome do subconjunto a ser aberto no Editor deSubconjunto quando E_PICK for chamada. Oparâmetro Alias deve ser fornecido para usar esteparâmetro. O parâmetro Alias pode ser definidocomo uma sequência vazia ("").

Se optar por não definir um parâmetro Subset,você deverá transmitir uma sequência vazia para afunção.

ElementNameOrIndex O nome ou número do índice do elemento a serpré-selecionado quando o Editor de Subconjuntofor aberto.

Se optar por não definir um parâmetroElementNameOrIndex, você deverá transmitir umasequência vazia para a função.

Exemplo 1

=E_PICK("TM1SERV:Region"," "," "," ")

168 IBM Planning Analytics: Referência do TM1

Este exemplo abre a dimensão Região no Editor de Subconjunto.

=E_PICK ("TM1SERV:Region","Deutsch","Europe","Argentina")

Este exemplo abre o subconjunto Europa no Editor de Subconjunto. O alias Deutsche será aplicado e oelemento Argentina será pré-selecionado quando o Editor de Subconjunto for aberto.

=E_PICK("TM1SERV:Region"," "," ",14)

Este exemplo abre a dimensão Região no Editor de Subconjunto, com o 14º elemento na definição dedimensão pré-selecionado.

I_EXPORTI_EXPORT exporta dados do cubo especificado para um arquivo ASCII delimitado, que é criado nodiretório atual 'My Documents' do usuário. Na maioria dos casos, o diretório 'My Documents' é C:\Users\<user_name>\Documents.

Nota: I_EXPORT aplica um bloqueio no servidor, evitando que outros usuários acessem o servidordurante a execução da função. Se esta função for usada para exportar um cubo grande, o servidor poderáficar inacessível por um longo período de tempo.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

I_EXPORT(cube, file, zero, calcs)

Argumento Descrição

cubo Um nome de cubo válido. O cubo pode residir emseu diretório de dados local ou em um servidorremoto ao qual você está conectado. Use umprefixo de nome do servidor para indicar o local doservidor. Para o servidor local, especifiquelocal:cube. Para um servidor remoto, especifiqueservername:cube.

arquivo O nome do arquivo ASCII delimitado a ser criado. Éusada a extensão do arquivo .cma; nãoespecifique-a.

zero Especifica se valores zero são incluídos.Especifique TRUE para incluí-los, FALSE paraexcluí-los.

cálculos Especifica se valores calculados são incluídos.Especifique TRUE para incluí-los, FALSE paraexcluí-los.

Exemplo

=I_EXPORT("local:92act4d","Download",FALSE,TRUE)

Este exemplo exporta dados do cubo 92act4d para o arquivo Download.cma. Valores zero são excluídos evalores calculados são incluídos.

Capítulo 3. Funções de Macro 169

I_NAMESI_NAMES pode ser usada para criar uma lista de nomes de elementos. Esta função lê por meio de umarquivo ASCII delimitado e grava todos os nomes exclusivos na coluna especificada para a colunacorrespondente na planilha ativa.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

I_NAMES(file, column)

Argumento Descrição

arquivo O nome de um arquivo ASCII delimitado, cujaextensão do arquivo é .cma. Não inclua a extensãodo arquivo.

coluna Um número que especifica o campo no arquivoASCII a partir do qual ler nomes e a coluna naplanilha ativa na qual esses nomes são gravados.

Exemplo

=I_NAMES("98Sales",3)

Este exemplo inspeciona o arquivo 98sales.cma. Todos os nomes exclusivos na terceira coluna sãogravados na coluna C da planilha ativa.

I_PROCESSI_PROCESS lê os registros de um arquivo ASCII, um por vez, na primeira linha da planilha ativa. Cadacampo preenche uma célula diferente. A planilha é recalculada após a leitura em cada registro.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

I_PROCESS(file)

Argumento Descrição

arquivo O nome de um arquivo ASCII delimitado, cujaextensão do arquivo é .cma. Não inclua a extensãodo arquivo.

Exemplo

=I_PROCESS("98Sales ")

Este exemplo lê em cada registro do arquivo 98sales.cma na primeira linha da planilha ativa.

170 IBM Planning Analytics: Referência do TM1

M_CLEARM_CLEAR limpa e recarrega todas as dimensões na memória. Ela não limpa os cubos e não reinicia oservidor.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

M_CLEAR

Argumentos

Nenhum.

N_CONNECTN_CONNECT estabelece uma conexão com um servidor remoto. Se a conexão for bem-sucedida,N_CONNECT não retornará nenhum valor. Se uma conexão não puder ser estabelecida, serão retornadasmensagens de erro do servidor.

Nota: A função N_CONNECT não é suportada quando um servidor está usando o Login Integrado ou asegurança do IBMCognos8 para autenticação. Essa função pode se conectar somente a um servidor queesteja configurado para usar a autenticação padrão do TM1.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

N_CONNECT(server, client, password)

Argumento Descrição

server O nome de um servidor remoto. Este servidor deveser registrado no Servidor Administrativo ao qualseu cliente faz referência.

cliente O nome de usuário que conecta-se ao servidorespecificado.

senha A senha para o cliente especificado.

Exemplo

=N_CONNECT("Sales","USR2","Swordfish")

Este exemplo estabelece uma conexão com o servidor remoto denominado Sales, usando o nome docliente USR2 e a senha Swordfish.

N_DISCONNECTN_DISCONNECT desconecta você de todos os servidores remotos aos quais você está conectado. Afunção não desconecta-o de seu servidor local. N_DISCONNECT retorna TRUE se ela desconectá-lo comêxito de todos os servidores aos quais você está conectado. Ela retorna FALSE se não puder fazer adesconexão de nenhum servidor remoto.

Capítulo 3. Funções de Macro 171

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

N_DISCONNECT

Argumentos

Nenhum.

OPTGETOPTGET retorna o valor atual de uma opção no arquivo Tm1p.ini.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

OPTGET(option)

Argumento Descrição

option Um nome de opção do TM1 válido.

Valores de Opção Válidos Descrição

AdminHost Retorna o nome ou endereço do HostAdministrador ao qual seu cliente faz referência.

AnsiFiles Retorna T se o conjunto de caracteres ANSI forusado no momento para importar dados dearquivos ASCII delimitados. Retorna F se oconjunto de caracteres ASCII for usado nomomento.

DataBaseDirectory Retorna o caminho completo para o diretório dedados do servidor local.

GenDBRW Retorna F se a planilha da fatia contiver fórmulasDBR. Retorna T se a planilha da fatia contiverfórmulas DBRW.

NoChangeMessage Retorna T se esta opção for definida para retornara mensagem NENHUMA MUDANÇA quando umafórmula DBSn apontar para uma célula de nível C.Retorna F se esta opção for definida como F.

Exemplo

=OPTGET("DataBaseDirectory")

Este exemplo retorna o caminho completo para o diretório de dados do servidor local.

172 IBM Planning Analytics: Referência do TM1

OPTSETOPTSET configura um valor para uma opção do TM1 especificada.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

OPTSET(option, value)

Argumento Descrição

option Um nome de opção do TM1 válido.

valor Um valor válido para a opção especificada.

Valores de Opção Válidos Descrição

AdminHost Especifique o nome do Host Administrador no qualum Servidor Administrativo está em execução.

AnsiFiles Especifique um valor que define o conjunto decaracteres usado durante importações de dados.Especifique T para usar o conjunto de caracteresANSI. Especifique F para usar o conjunto decaracteres ASCII.

DataBaseDirectory Especifique um valor que configure o caminhocompleto para o diretório de dados do servidorlocal.

GenDBRW Especifique um valor que determina qual fórmula oTM1 usa para vincular valores em planilhas de fatiaa cubos. Especifique T para gerar fórmulas DBRWquando as planilhas da fatia forem criadas.Especifique F para gerar fórmulas DBR.

NoChangeMessage Especifique um valor que determina se o TM1exibe a mensagem NO CHANGE quando umafórmula DBSn apontar para uma célula de nível C.Especifique T para exibir a mensagem. EspecifiqueF para exibir apenas o valor.

Exemplo

=OPSET("DataBaseDirectory","c:\Tm1data")

Este exemplo define o diretório de dados local para c:\Tm1data.

PublishSubsetPublishSubset publica um subconjunto particular nomeado em um servidor. Se você tentar publicar umsubconjunto particular para o qual existe um subconjunto público com nome idêntico, será solicitado quesobrescreva o subconjunto público existente.

Capítulo 3. Funções de Macro 173

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

PublishSubset(dimension, subset)

Argumento Descrição

dimensão O nome prefixado pelo servidor da dimensão quecontém o subconjunto particular que você desejapublicar. Por exemplo, para publicar umsubconjunto da dimensão Região no servidor deFinanças, transmita "Finance:Region" como oargumento da dimensão.

subconjunto O nome do subconjunto particular que você desejapublicar.

PublishViewPublishView publica uma visualização particular nomeada em um servidor. Esta função não pode publicaruma visualização particular que usa subconjuntos particulares.

Todos os subconjuntos particulares em uma visualização particular devem primeiro ser publicados com afunção de macro PublishSubset. Se você tentar publicar uma visualização particular para a qual existeuma visualização pública com nome idêntico, será solicitado que sobrescreva a visualização públicaexistente.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

PublishView(cube, view)

Argumento Descrição

cubo O nome prefixado pelo servidor do cubo quecontém a visualização particular que você desejapublicar. Por exemplo, para publicar umavisualização do cubo Projections no servidor deFinanças, transmita "Finance:Projections" como oargumento do cubo.

visualização O nome da visualização particular que você desejapublicar.

QUDEFINEQUDEFINE configura e salva parâmetros para conjuntos de consultas do TM1. QUDEFINE equivale àcriação de um conjunto de consultas usando a caixa de diálogo Extração de Visualização.

É possível executar consultas criadas com esta função usando a caixa de diálogo Extração deVisualização.

Também é possível usar o conjunto da consulta como um argumento para as funções de macroQUEXPORT, QULOOP e QUSUBSET.

174 IBM Planning Analytics: Referência do TM1

Nota: QUDEFINE aplica um bloqueio no servidor, evitando que outros usuários acessem o servidordurante a execução da função. Se esta função for usada para criar uma consulta que inclua uma grandeseção de um cubo, o servidor poderá ficar inacessível por um longo período de tempo.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

QUDEFINE(cube, query, range, LowLim, HiLim, SkpZeroes,SkpCons)

Argumento Descrição

cubo O nome do cubo a ser consultado.

Use um prefixo de nome do servidor para indicar olocal do servidor. Para o servidor local, especifiquelocal:cube. Para um servidor remoto, especifiqueservername:cube.

consulta O nome do conjunto da consulta a ser salvo parauso futuro.

intervalo Um intervalo de células da planilha que inclui umacoluna para cada dimensão no cubo. Quando aconsulta é executada, o TM1 examina apenas ascélulas do cubo identificadas pelos elementosespecificados ou referenciados no intervalo.

O intervalo deve conter uma coluna para cadadimensão no cubo. A ordem das colunas deve serigual à das dimensões no cubo.

Em cada coluna, especifique ou faça referência aoselementos a serem incluídos. Para incluir umsubconjunto de elementos, liste os nomes deelementos ou especifique um nome dosubconjunto. Escreva o nome do subconjuntoprecedido pelo caractere barra invertida (\). Porexemplo, \trimestre especifica o subconjuntotrimestre. Para incluir todos os elementos em umadimensão (o subconjunto TODOS), deixe a colunaem branco.

As funções DBR podem ser usadas para preencheras células no intervalo. Se as funções retornaremvalores em branco para qualquer coluna nointervalo, QUDEFINE usará o subconjunto TODOSpara a dimensão associada a essa coluna.

LowLim O valor de célula mais baixo a ser considerado paraexportação.

HighLim O valor de célula mais alto a ser considerado paraexportação.

SkpZeroes Especifica se as células contendo zeros sãoignoradas. Especifique TRUE para excluí-las, FALSEpara incluí-las.

Capítulo 3. Funções de Macro 175

Argumento Descrição

SkpCons Especifica se as células contendo valoresconsolidados são ignoradas. Especifique TRUEpara excluí-las, FALSE para incluí-las.

Exemplo

=QUDEFINE("local:98sales", "Topsell", Sheet1!B3:F5, 3000, 5000,TRUE, TRUE)

Este exemplo cria um conjunto da consulta que contém elementos listados em Planilha1, no intervalo decélulas B3:F5. Quando essa consulta é executada, o TM1 inspeciona apenas as células do cuboidentificadas por esses elementos e exporta os valores não consolidados no intervalo de 3000 a 5000.

Nota: Se lowlim ou highlim for uma sequência formada de caracteres numéricos, o Excel exigirá que asequência seja colocada entre uma série de quatro aspas duplas e es comerciais únicos, da seguinteforma:

""""&"0123"&""""

QUDEFINEEXQUDEFINEEX configura e salva parâmetros para conjuntos de consultas do TM1. É equivalente à criaçãode um conjunto da consulta usando a caixa de diálogo Extração de Visualização. Esta função é idêntica àmacro QUDEFINE, com exceção de que QUDEFINEEX inclui um argumento que permite excluir valoresderivados de regras da consulta.

É possível executar consultas criadas com esta função usando a caixa de diálogo Extração deVisualização.

Também é possível usar o conjunto da consulta como um argumento para as funções de macroQUEXPORT, QULOOP e QUSUBSET.

Nota: QUDEFINEEX aplica um bloqueio no servidor, evitando que outros usuários acessem o servidordurante a execução da função. Se esta função for usada para criar uma consulta que inclua uma grandeseção de um cubo, o servidor poderá ficar inacessível por um longo período de tempo.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

QUDEFINEEX(cube, query, range, lowlim, hilim, skpZeroes,skpCons, skpRuleVals)

Argumento Descrição

cubo O nome do cubo a ser consultado.

Use um prefixo de nome do servidor para indicar olocal do servidor. Para o servidor local, especifiquelocal:cube. Para um servidor remoto, especifiqueservername:cube.

consulta O nome do conjunto da consulta a ser salvo parauso futuro.

176 IBM Planning Analytics: Referência do TM1

Argumento Descrição

intervalo Um intervalo de células da planilha que inclui umacoluna para cada dimensão no cubo. Quando vocêexecutar a consulta, o TM1 examinará apenas ascélulas do cubo identificadas pelos elementosespecificados ou referidos no intervalo.

O intervalo deve conter uma coluna para cadadimensão no cubo. A ordem das colunas deve serigual à das dimensões no cubo.

Em cada coluna, especifique ou faça referência aoselementos a serem incluídos. Para incluir umsubconjunto de elementos, liste os nomes deelementos ou especifique um nome dosubconjunto. Escreva o nome do subconjuntoprecedido pelo caractere barra invertida (\). Porexemplo, \trimestre especifica o subconjuntotrimestre. Para incluir todos os elementos em umadimensão (o subconjunto TODOS), deixe a colunaem branco.

As funções DBR podem ser usadas para preencheras células no intervalo. Se as funções retornaremvalores em branco para qualquer coluna nointervalo, QUDEFINEEX usará o subconjuntoTODOS para a dimensão associada a essa coluna.

lowlim O valor de célula mais baixo a ser considerado paraexportação.

highlim O valor de célula mais alto a ser considerado paraexportação.

skpZeroes Especifica se as células contendo zeros sãoignoradas. Especifique TRUE para excluí-las, FALSEpara incluí-las.

skpCons Especifica se as células contendo valoresconsolidados são ignoradas. Especifique TRUEpara excluí-las, FALSE para incluí-las.

skpRuleVals Especifica se as células contendo valoresderivados de regras são ignoradas. EspecifiqueTRUE para excluí-las, FALSE para incluí-las.

Exemplo

=QUDEFINEEX("local:SalesCube", "Topsell", Sheet1!B3:F5, 3000,5000, TRUE, TRUE, FALSE)

Este exemplo cria um conjunto da consulta que contém elementos listados em Planilha1, no intervalo decélulas B3:F5. Quando essa consulta é executada, o TM1 inspeciona apenas as células do cuboidentificadas por esses elementos e exporta os valores não consolidados no intervalo de 3000 a 5000,incluindo os derivados por meio de regras.

Capítulo 3. Funções de Macro 177

Nota: Se lowlim ou highlim for uma sequência formada de caracteres numéricos, o Excel exigirá que asequência seja colocada entre uma série de quatro aspas duplas e es comerciais únicos, da seguinteforma:

""""&"0123"&""""

QUEXPORTQUEXPORT exporta valores de células do cubo especificado para um arquivo ASCII delimitado.

Para criar o conjunto da consulta, use a função QUDEFINE.

Cada registro de saída possui o seguinte formato:

• O nome do cubo que contém os valores exportados• Nomes de elementos que identificam o local da célula de um único valor exportado• O valor exportado

Para um cubo de cinco dimensões, o TM1 cria registros contendo sete campos:

"cube name", "elem1", "elem2", "elem3", "elem4", "elem5", value

Nota: QUEXPORT aplica um bloqueio no servidor, evitando que outros usuários acessem o servidordurante a execução da função. Se esta função for usada para exportar valores de um conjunto da consultagrande, o servidor poderá ficar inacessível por um longo período de tempo.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

QUEXPORT(cube, query, file)

Argumento Descrição

cubo O nome do cubo a ser consultado.

Use um prefixo de nome do servidor para indicar olocal do servidor. Para o servidor local, especifiquelocal:cube. Para um servidor remoto, especifiqueservername:cube.

consulta O nome de um conjunto da consulta existente.

arquivo O nome do arquivo ASCII delimitado (.cma) paraconter os dados do cubo exportados. Não inclua aextensão do arquivo. O arquivo é criado nodiretório de dados local.

Exemplo

=QUEXPORT("sales:98sales", "Sedans", "Sedans")

Este exemplo exporta dados do cubo 98sales usando o conjunto da consulta Sedãs. Os registros sãogravados no arquivo Sedans.cma.

178 IBM Planning Analytics: Referência do TM1

QULOOPQULOOP exporta dados que atendem aos critérios de conjunto de consulta do cubo especificado. O TM1lê cada registro de saída, um de cada vez, na primeira linha da planilha ativa. Cada campo preenche umacélula diferente. A planilha é recalculada após a leitura em cada registro.

Cada registro de saída possui o seguinte formato:

• O nome do cubo que contém os valores exportados• Os nomes de elementos que identificam o local da célula de um único valor exportado• O valor exportado

Para um cubo de cinco dimensões, o TM1 cria registros contendo sete campos:

"cube name", "elem1", "elem2", "elem3", "elem4", "elem5", value

Use QULOOP juntamente com uma fórmula DBSn para preencher células em um cubo.

Nota: QULOOP aplica um bloqueio no servidor, evitando que outros usuários acessem o servidor durantea execução da função. Se esta função for usada para exportar valores de um conjunto da consulta grande,o servidor poderá ficar inacessível por um longo período de tempo.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

QULOOP(cube, query)

Argumento Descrição

cubo O nome do cubo a ser consultado. Use um prefixode nome do servidor para indicar o local doservidor. Para o servidor local, especifiquelocal:cube. Para um servidor remoto, especifiqueservername:cube.

consulta O nome de um conjunto da consulta existente.

Exemplo

=QULOOP("sales:98sales", "Sedans")

Este exemplo exporta dados do cubo 98sales usando o conjunto da consulta Sedãs.

QUSUBSETQUSUBSET equivale à execução de uma consulta a partir da caixa de diálogo Extração de Visualizaçãoquando chamada a partir do Editor de Subconjunto.

Nota: QUSUBSET aplica um bloqueio no servidor, evitando que outros usuários acessem o servidordurante a execução da função. Se esta função for usada para executar uma consulta que retorna umgrande número de elementos, o servidor poderá ficar inacessível por um longo período de tempo.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

QUSUBSET(cube, query, dimension, subset)

Capítulo 3. Funções de Macro 179

Argumento Descrição

cubo O nome do cubo a ser consultado. Use um prefixode nome do servidor para indicar o local doservidor. Para o servidor local, especifiquelocal:cube. Para um servidor remoto, especifiqueservername:cube.

consulta O nome de uma consulta existente.

dimensão O nome de uma dimensão para a qual a consultaexiste.

subconjunto O nome do subconjunto de dimensões a ser criado,que conterá a lista de elementos que atendem aoscritérios do subconjunto. Por exemplo, umsubconjunto pode retornar a lista de regiões nasquais as vendas de carros excedem um valorespecificado.

Exemplo

=QUSUBSET("sales:98sales", "Top", "Region", "Topsales")

Este exemplo cria o subconjunto Vendas Principais para a dimensão Região, com base nos critérios daconsulta Principal.

R_SAVER_SAVE salva a planilha ativa como uma planilha de regras e a compila em um arquivo .rux. A pasta detrabalho deve ter o mesmo nome que o cubo para o qual as regras estão sendo compiladas.

As instruções de regras que impedem a compilação de regras são gravadas no arquivo tm1erlog.cma, nodiretório de dados local.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

RSAVE

Argumentos

Nenhum.

SUBDEFINESUBDEFINE cria um subconjunto de dimensões que consiste em nomes de elementos localizados naplanilha ativa.

Quando SUBDEFINE criar o subconjunto, ele será criado como um subconjunto particular.

Se o subconjunto nomeado já existir como um subconjunto particular quando a função for executada, elesobrescreverá o subconjunto particular existente por esse nome.

Se o subconjunto nomeado existir como um subconjunto público, SUBDEFINE ainda criará o subconjuntocomo particular. Se desejar sobrescrever o subconjunto público nomeado existente, será necessário

180 IBM Planning Analytics: Referência do TM1

publicar o subconjunto particular que foi criado pela função SUBDEFINE para sobrescrever o subconjuntopúblico existente.

Nota: SUBDEFINE aplica um bloqueio no servidor, evitando que outros usuários acessem o servidordurante a execução da função. Se esta função for usada para criar um subconjunto com um grandenúmero de elementos, o servidor poderá ficar inacessível por um longo período de tempo.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

SUBDEFINE(dimension, subset, range)

Argumento Descrição

dimensão O nome da dimensão para a qual você deseja criarum subconjunto. Use um prefixo de nome doservidor para indicar o local do servidor. Para oservidor local, especifique local:dim. Para umservidor remoto, especifique servername:dim.

subconjunto O nome do subconjunto de dimensões.

intervalo O intervalo de células da planilha contendo osnomes de elementos na dimensão. Os valores decélulas no intervalo que não são elementos válidossão ignorados.

Exemplo

=SUBDEFINE("local:Model", "Smith", B7:M7)

Este exemplo cria um subconjunto chamado Smith para a dimensão do Modelo. O subconjunto contémelementos localizados no intervalo de células B7:M7.

SUBPICKSUBPICK chama uma caixa de diálogo que lista todos os elementos no subconjunto especificado. Oselementos selecionados são inseridos na planilha ativa, iniciando na posição da célula atual.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

SUBPICK(dimension, subset, vertical)

Argumento Descrição

dimensão O nome da dimensão que contém subconjuntos.Use um prefixo de nome do servidor para indicar olocal do servidor. Para o servidor local, especifiquelocal:dim. Para um servidor remoto, especifiqueservername:dim.

subconjunto O nome do subconjunto cujos elementos vocêdeseja selecionar.

Capítulo 3. Funções de Macro 181

Argumento Descrição

vertical Especifique TRUE para inserir os nomes deelementos verticalmente, da célula atual abaixo.Especifique FALSE para inserir os nomes deelementos horizontalmente, da célula atual àdireita.

Exemplo

=SUBPICK("local:Model", "Smith", TRUE, )

Este exemplo insere elementos selecionados do subconjunto Smith na planilha ativa. Os elementos sãodispostos verticalmente, iniciando da célula atual abaixo.

T_CLEART_CLEAR limpa todas as mudanças ou adições nos dados do cubo da memória.

Nota: T_CLEAR não solicita que você salve em disco nenhum dos dados do cubo na RAM. Os dados nãosalvos são limpos sem serem salvos no disco. Portanto, se desejar salvar dados do cubo que estão naRAM, chame a função T_SAVE primeiro.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

T_CLEAR

Argumentos

Nenhum.

T_CREATET_CREATE cria um cubo que tem até oito dimensões, que é o limite em versões anteriores do TM1.

Nota: Ao usar T_CREATE para criar um cubo com o nome de um cubo existente, o TM1 substitui o cuboexistente e exclui todos os seus dados.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

T_CREATE(cube,d1,d2[,d3,d4,d5,d6,d7,d8])

Argumento Descrição

cubo O nome do cubo a ser criado.

Use um prefixo de nome do servidor para indicar olocal do servidor. Para o servidor local, especifiquelocal:cube. Para um servidor remoto, especifiqueservername:cube.

182 IBM Planning Analytics: Referência do TM1

Argumento Descrição

d1...d8 Nomes de até oito dimensões existentes, na ordemque você deseja que eles sejam armazenados nocubo. Você deve especificar pelo menos duasdimensões.

Exemplo

=T_CREATE("local:Sales","Region","Products","Month")

Este exemplo cria um cubo chamado Sales. Este novo cubo possui três dimensões, na seguinte ordem:Região, Produtos e Mês.

T_CREATE16T_CREATE16 cria um cubo que tem até dezesseis dimensões.

Nota: Se o primeiro argumento para essa função for um nome de cubo existente, o TM1 substituirá ocubo existente e excluirá todos os seus dados.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

T_CREATE16(cube,d1,d2[,d3,...,d16])

Argumento Descrição

cubo O nome do cubo a ser criado.

Use um prefixo de nome do servidor para indicar olocal do servidor. Para o servidor local, especifiquelocal:cube. Para um servidor remoto, especifiqueservername:cube.

d1...d16 Nomes de até dezesseis dimensões existentes, naordem que você deseja que eles sejamarmazenados no cubo. Você deve especificar pelomenos duas dimensões.

Exemplo

=T_CREATE("Sales","Region","Products","Month")

Este exemplo cria um cubo chamado Sales. Este novo cubo possui três dimensões, na seguinte ordem:Região, Produtos e Mês.

T_PICKT_PICK chama uma caixa de diálogo que lista todos os cubos disponíveis nos servidores TM1 locais eremotos. O nome do cubo selecionado na caixa de diálogo torna-se o valor da função T_PICK. Sua macroinsere o nome do cubo na primeira célula da planilha ativa.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Capítulo 3. Funções de Macro 183

Sintaxe

T_PICK

Argumentos

Nenhum.

T_SAVET_SAVE salva todos os dados do cubo atualmente na RAM no disco. T_SAVE pode ser usado somentepara salvar dados em um servidor local; a função não funciona com servidores remotos. T_SAVE nãosolicita o salvamento de dados para cubos individuais.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

T_SAVE

Argumentos

Nenhum.

TM1RECALCTM1RECALC força um recálculo de todas as planilhas abertas. É equivalente a pressionar F9 no Excel.Uma função de macro semelhante, TM1RECALC1, força um recálculo apenas da planilha ativa.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

TM1RECALC

Argumentos

Nenhum.

TM1RECALC1TM1RECALC1 força um recálculo da planilha ativa. É equivalente a pressionar SHIFT-F9 no Excel. Umafunção de macro semelhante, TM1RECALC, força um recálculo de todas as planilhas abertas.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

TM1RECALC1

Argumentos

Nenhum.

184 IBM Planning Analytics: Referência do TM1

VUSLICEVUSLICE cria uma planilha da fatia a partir da visualização do cubo especificada. A fatia é inseridacomeçando na célula superior esquerda (A1 ou R1C1) na planilha ativa.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

VUSLICE(cube, view)

Argumento Descrição

cubo O nome de um cubo existente.

Use um prefixo de nome do servidor para indicar olocal do servidor. Para o servidor local, especifiquelocal:cube. Para um servidor remoto, especifiqueservername:cube.

visualização O nome de uma visualização associada ao cubo.

Exemplo

=VUSLICE("local:98sales","Quarterly")

Este exemplo copia dados da visualização Trimestral do cubo 98sales na planilha ativa.

W_DBSENABLEW_DBSENABLE ativa (ou desativa) o recálculo automático de funções DBS em uma planilha.

Normalmente, quando uma função DBS é inserida em uma planilha, a função não é executada até que aplanilha seja recalculada com as teclas F9 ou SHIFT+F9. A função W_DBSENABLE pode ser usada paraexecutar imediatamente funções DBS conforme são criadas em uma planilha.

Nota: As funções DBS não serão executadas em módulos VBA, a menos que W_DBSENABLE estejadefinida como TRUE.

Essa função macro do TM1 é válida apenas em macros do Excel e em módulos VBA.

Sintaxe

=W_DBSENABLE(LogicalFlag)

Argumento Descrição

LogicalFlag Se TRUE, as funções DBS serão executadasimediatamente quando inseridas ou chamadas apartir de uma planilha.

Se FALSE, as funções DBS serão executadasapenas quando a planilha for explicitamenterecalculada.

Capítulo 3. Funções de Macro 185

186 IBM Planning Analytics: Referência do TM1

Capítulo 4. Funções da PlanilhaAs funções de Planilha do IBM Planning Analytics retorna um valor numérico ou de sequência. As funçõesde planilha do TM1 podem ser usadas em qualquer lugar em uma planilha do IBM Planning Analytics forMicrosoft Excel ou do TM1 Perspectives.

Para acessar essas funções no Microsoft Excel, escolha Fórmulas > Inserir função.

Nota: Se estiver usando o Planning Analytics for Microsoft Excel, você deve primeiro ativar o suplementodo IBM Cognos Office Reporting TM1.

Se uma função da planilha fizer referência a um objeto em um servidor remoto, você deverá prefixar oobjeto com o nome do servidor e dois pontos. Por exemplo, para referir-se ao cubo SalesCube no servidorSData, use SData:SalesCube. Você deve estar conectado ao servidor referido pela função para recebervalores precisos em sua planilha. Se você não estiver conectado ao servidor, as funções de planilha doTM1 retornarão *KEY_ERR.

As funções de planilha do TM1 aceitam como argumentos sequências, valores ou referências de célula.As sequências de caracteres devem ser colocadas entre aspas. Os nomes de elementos numéricosdevem ser colocados entre aspas duplas. Por exemplo, ""14357"". As referências de célula devemreferir-se a argumentos válidos para uma determinada função. As convenções padrão podem ser usadaspara referências de células absolutas e relativas em funções da planilha.

Devido a uma limitação com o Microsoft Excel, as funções da planilha podem conter não mais do que 30argumentos. Ao construir uma referência do cubo, um argumento deve ser o nome do cubo, que deixa 29argumentos para especificar as dimensões de cubo.

Ao registrar uma macro de planilha no Microsoft Excel que inclua a funcionalidade do TM1, a macroresultante poderá incluir funções de planilha não documentadas do TM1. No entanto, você podemodificar ou descontinuar estas funções não documentadas em futuros releases sem notificação.

As funções de planilha não podem ser usadas em regras do TM1 ou em processos do Turbo Integrator.

DBRDBR recupera um valor de um cubo TM1 especificado.

Quando todos os argumentos do elemento (e1, e2, etc.) para a função forem elementos folha, a funçãoDBR também poderá ser usada para gravar valores no cubo especificado, desde que o usuário tenha osprivilégios de acesso apropriados para o cubo, dimensões, elementos e/ou células relevantes. Ao inserirum valor em uma célula que contém tal função DBR, o valor é enviado ao servidor.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

DBR(cube, e1, e2,[...en])

Argumento Descrição

cubo O nome do cubo do qual o valor será recuperado.

© Copyright IBM Corp. 2007, 2019 187

Argumento Descrição

e1,...en Os nomes de elementos de dimensão que definem a interseção do cubo quecontém o valor a ser recuperado.

Os argumentos e1 a en são sensíveis à sequência. e1 deve ser um elementoda primeira dimensão do cubo, e2 deve ser um elemento da segundadimensão e assim por diante. Esses argumentos também podem ser osnomes de aliases dos elementos de dimensão.

Os nomes de elementos numéricos devem ser colocados entre aspas duplas.Por exemplo, ""14357"".

Exemplo

DBR("92act4d", "California", "3.5 Diskettes", "Net Sales", "January")

Neste exemplo, 92act4d é o nome do cubo e a função retorna o valor na interseção de Califórnia,Disquetes 3.5, Vendas Líquidas e Janeiro.

DBRADBRA recupera o valor de um atributo de elemento especificado. O valor retornado pode ser umasequência de caracteres ou um valor numérico, dependendo do tipo de atributo.

A função DBRA também pode ser usada para gravar valor de atributo de elemento no servidor. Ao inserirum valor, de sequência ou numérico, em uma célula contendo uma função DBRA, o atributo de elementocorrespondente é atualizado no servidor.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

DBRA(server:dimension, element, attribute)

Argumento Descrição

server:dimension Um nome de dimensão válido, prefixado com o nome do servidor apropriadoe dois pontos; por exemplo, "SData:Region" faz referência à dimensãoRegião no servidor SData.

Se o prefixo da dimensão não incluir o nome de servidor, a função DBRAtenta executar contra o servidor local.

elemento Um elemento da dimensão.

atributo O atributo para o qual você deseja recuperar um valor. Este argumento deveser um atributo válido do elemento.

Exemplo

DBRA("SData:Model", "L Series 1.8L Sedan", "ManufactureCode")

Neste exemplo, a função retorna o valor do atributo Código de Fabricação do elemento Sedã Série L 1.8Lna dimensão do Modelo no servidor SData.

188 IBM Planning Analytics: Referência do TM1

DBRWDBRW recupera um valor de um cubo TM1 especificado.

Quando todos os argumentos do elemento (e1, e2, etc.) para a função forem elementos folha, a funçãoDBRW também poderá ser usada para gravar valores no cubo especificado, desde que o usuário tenha osprivilégios de acesso apropriados para o cubo, dimensões, elementos e/ou células relevantes.

DBRW funciona da mesma forma que a função DBR, com uma diferença principal: DBRW reduz o tráfegoda rede e pode melhorar o desempenho em redes de longa distância.

Em planilhas com um grande número de funções de planilha do TM1, o DBRW força o TM1 a executarfunções em "pacotes configuráveis", em vez de individualmente. As funções DBR normais são executadasindividualmente durante um recálculo da planilha. As funções DBRW forçam o TM1 a executar duastransmissões pela planilha. Na primeira transmissão, todos os valores alterados em células contendofunções DBRW são enviados em um único pacote configurável para o cubo. Na segunda transmissão, osvalores do cubo são enviados em um único pacote configurável de volta para a planilha. Portanto, aplanilha recalcula duas vezes quando são executadas funções DBRW.

O pacote configurável de DBRW ocorre quando a função é usada em uma célula independente. Quandofunções DBRW são usadas em cálculos complexos, a função opera como uma nova função DBR, portanto,não ocorre nenhum ganho de desempenho.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

DBRW(cube, e1, e2[,...en])

Argumento Descrição

cubo O nome do cubo do qual o valor será recuperado.

e1,...en Os nomes de elementos de dimensão que definem a interseção do cuboque contém o valor a ser recuperado.

Os argumentos e1 a en são sensíveis à sequência. e1 deve ser umelemento da primeira dimensão do cubo, e2 deve ser um elemento dasegunda dimensão e assim por diante. Esses argumentos também podemser os nomes de aliases dos elementos de dimensão.

Os nomes de elementos numéricos devem ser colocados entre aspasduplas.

Exemplo

DBRW("92act4d", "California", "3.5 Diskettes", "NetSales", "January")

Neste exemplo, a função retorna o valor na interseção de Califórnia, Disquetes 3.5, Vendas Líquidas eJaneiro no cubo 92act4d.

DBSA função DBS envia um valor numérico a um cubo do TM1. Essa função não pode enviar uma sequênciade caracteres a um cubo. Para enviar sequências de caracteres, use a função DBSS.

Ao construir uma função DBS com a opção > Editar fórmula do TM1 a caixa de diálogo Editar fórmulaapresentará prompts para uma série de etapas para a construção de cada argumento de função nasequência correta.

Capítulo 4. Funções da Planilha 189

Se o cubo não existir ou um dos argumentos for inválido, a função retornará KEY ERROR.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

DBS(value, cube, e1, e2[,...en])

Argumento Descrição

valor O valor sendo enviado.

cubo O cubo para o qual o valor é enviado.

e1, ...en Os nomes dos elementos que definem a interseção no cubo ao qual ovalor será enviado.

Os argumentos e1 a en são sensíveis à sequência. e1 deve ser umelemento da primeira dimensão do cubo, e2 deve ser um elemento dasegunda dimensão do cubo e assim por diante. Esses argumentostambém podem ser os nomes de aliases dos elementos de dimensão.

Os nomes de elementos numéricos devem ser colocados entre aspas.

ExemploNeste exemplo, a função envia o valor 5342 para o cubo 92act4d na interseção de Califórnia, Disquetes3.5, Vendas Líquidas e Janeiro.

DBS(5342,"92act4d","California","3.5 Diskettes", "NetSales", "January")

DBSADBSA envia um valor para um atributo de elemento especificado. O valor enviado pode ser umasequência de caracteres ou um valor numérico, dependendo do tipo de atributo.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

DBSA(att_value, dimension, element, att_name)

Argumento Descrição

att_value O valor que você deseja enviar.

dimensão Um nome de dimensão válido. O nome dadimensão deve ser prefixado com o nome doservidor apropriado e dois pontos; por exemplo,"SData:Region" faz referência à dimensão Regiãono servidor SData.

Se o prefixo da dimensão não incluir o nome deservidor, a função DBSA tentará executar contra oservidor local.

elemento Um elemento da dimensão.

190 IBM Planning Analytics: Referência do TM1

Argumento Descrição

att_name O atributo para o qual você deseja enviar um valoratt_name deve ser um atributo válido do elementoespecificado por elem_name.

Exemplo

DBSA(''LS-1.8-M7398", "SData:Model", "L Series 1.8LSedan", "Manufacture Code")

DBSSDBSS envia uma sequência para um cubo com qualquer número de dimensões. Essa função não podeenviar um valor numérico a um cubo. Use a função DBS para enviar valores numéricos.

Ao construir uma função DBSS com a opção > Editar fórmula do TM1 a caixa de diálogo Editar fórmulaapresentará prompts para uma série de etapas para a construção de cada argumento de função nasequência correta.

Se o cubo não existir ou um dos argumentos for inválido, a função retornará KEY ERROR.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

DBSn(string, cube, e1, e2,...en)

Argumento Descrição

sequência A sequência de caracteres sendo enviada.

cubo O cubo para o qual a sequência de caracteres éenviada.

e1, ...en Os nomes dos elementos que definem a interseçãono cubo ao qual a sequência de caracteres seráenviada.

Os argumentos e1 a en são sensíveis à sequência.e1 deve ser um elemento da primeira dimensão docubo, e2 deve ser um elemento da segundadimensão do cubo e assim por diante. Essesargumentos também podem ser os nomes dealiases dos elementos de dimensão.

Exemplo

DBSS("Smith","Info","California","Last Name")

Neste exemplo, a fórmula envia a sequência Smith para o cubo Info na interseção de Califórnia eSobrenome.

Capítulo 4. Funções da Planilha 191

DBSWA função DBSW envia um valor numérico a um cubo do TM1. Essa função não pode enviar uma sequênciade caracteres a um cubo. Para enviar sequências de caracteres, use a função DBSS.

Esta função funciona da mesma forma que a função DBS, com uma diferença principal: DBSW reduz otráfego da rede e pode melhorar o desempenho em redes de longa distância.

Em planilhas com um grande número de referências de cubo, DBSW força o TM1 a enviar valores empacotes configuráveis, em vez de individualmente. As funções DBS normais são atualizadasindividualmente durante um recálculo. As referências de DBSW forçam o TM1 a enviar todos os valoresalterados em uma planilha com um único pacote configurável.

Nestas circunstâncias, é possível usar seguramente uma função DBS/DBR como um argumento para umafunção DBS.

Nota: Ao usar VBA para calcular uma planilha que contém funções DBSW, deve-se chamar a funçãomacro do TM1 para calcular a planilha. Não use o método VB Calculate para calcular uma planilhacontendo funções DBSW; isso faz com que cada função DBSW seja executada individualmente, anulandoo propósito da função e resultando em uma redução no desempenho.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

DBSW(value, cube, e1, e2[,...en])

Argumento Descrição

valor O valor sendo enviado.

cubo O cubo para o qual o valor é enviado.

e1, ...en Os nomes dos elementos que definem a interseçãono cubo ao qual o valor será enviado.

Os argumentos e1 a en são sensíveis à sequência.e1 deve ser um elemento da primeira dimensão docubo, e2 deve ser um elemento da segundadimensão do cubo e assim por diante. Essesargumentos também podem ser os nomes dealiases dos elementos de dimensão.

Os nomes de elementos numéricos devem sercolocados entre aspas.

Exemplo

DBSW(5342,"92act4d","California","3.5 Diskettes", "NetSales", "January")

DFRSTO DFRST retorna o primeiro elemento de uma dimensão especificada.

Esta função da planilha é válida apenas em planilhas.

192 IBM Planning Analytics: Referência do TM1

Sintaxe

DFRST(server_name:dimension)

Argumento Descrição

dimensão Um nome de dimensão válido.

Exemplo

DFRST("planning_sample:Location")

Se a dimensão Local contiver os elementos ordenados Califórnia, Oregon e Washington, o exemploretornará Califórnia.

DIMIXO DIMIX retorna o número de índice de um elemento em uma dimensão.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

DIMIX(server_name:dimension, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento O nome de um elemento na dimensão.

Se o elemento não for membro da dimensãoespecificada, a função retornará 0. Este argumentotambém pode ser o nome de um alias para umelemento de dimensão.

Exemplo

DIMIX("planning_sample: Location","Washington")

Se a dimensão Local contiver os elementos ordenados Califórnia, Oregon e Washington, o exemploretornará o valor 3, pois Washington é o terceiro elemento da dimensão.

DIMNMDIMNM retorna o elemento de uma dimensão que corresponde ao argumento de Índice. Se você incluir oparâmetro Alias opcional nesta função, a função retornará o alias para o elemento selecionado.

Ao clicar duas vezes em uma célula contendo uma função DIMNM, a caixa de diálogo Dimensão se abre. Épossível então selecionar um novo elemento para colocar em sua planilha. A função DIMNM atualizaautomaticamente o argumento de índice para refletir o novo elemento.

Esta função da planilha é válida apenas em planilhas.

Capítulo 4. Funções da Planilha 193

Sintaxe

DIMNM(server_name:Dimension, Index, [Alias])

Argumento Descrição

Dimensão Um nome de dimensão válido.

Índice Um valor menor ou igual ao número de elementosna dimensão.

Alias O nome de um alias existente para a dimensão.Este é um argumento opcional. Se ele for usado, afunção retornará o alias do elemento especificado.

DIMSIZO DIMSIZ retorna o número de elementos em uma dimensão especificada.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

DIMSIZ(dimension)

Argumento Descrição

dimensão Um nome de dimensão válido.

Exemplo

DIMSIZ("Accounts")

Se a dimensão Contas contiver 19 elementos, o exemplo retornará o valor 19.

DNEXTO DNEXT retorna o nome de elemento que segue o elemento especificado como um argumento para afunção.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

DNEXT(server:dimension, element)

194 IBM Planning Analytics: Referência do TM1

Argumento Descrição

server:dimension Um nome de dimensão válido, prefixado com onome do servidor apropriado e dois pontos; porexemplo, "SData:Region" faz referência àdimensão Região no servidor SData.

Se a dimensão não for prefixada com um nome doservidor, a função DNEXT tentará executar noservidor local.

elemento O nome de um elemento na dimensão. Esteargumento também pode ser o nome de um aliaspara um elemento de dimensão.

Exemplo

DNEXT("Production:Location","Oregon")

Se a dimensão Local no servidor de Produção contiver os elementos ordenados Califórnia, Oregon eWashington, o exemplo retornará Washington.

DNLEVO DNLEV retorna o número de níveis de hierarquia em uma dimensão.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

DNLEV(dimension)

Argumento Descrição

dimensão Um nome de dimensão válido.

Exemplo

DNLEV("Region")

Na dimensão Região, as diversas nações (Nível 0) somam-se às regiões (Nível 1). As regiões são entãoincluídas em super-regiões (Nível 2) que, por sua vez, são incluídas no mundo (Nível 3).

Na dimensão Região existem quatro níveis de hierarquia (0, 1, 2 e 3). Portanto, o exemplo retorna o valor4.

Capítulo 4. Funções da Planilha 195

DTYPEO DTYPE retorna as informações sobre o tipo do elemento especificado. Ela retorna "N" se o elemento forum elemento numérico, "S" se o elemento for um elemento de sequência.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

DTYPE(dimension, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento O nome de um elemento na dimensão. Esteargumento também pode ser o nome de um aliaspara um elemento de dimensão.

Exemplo

DTYPE("Region","Europe")

O elemento Europa na dimensão Região é um elemento consolidado, portanto, o exemplo retorna "C".

ELCOMPO ELCOMP retorna o nome de um filho de elemento consolidado em uma dimensão especificada. Se oargumento do elemento não for um elemento consolidado, a função retornará 0.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

ELCOMP(dimension, element, index)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento O nome de um elemento consolidado na dimensão.Este argumento também pode ser o nome de umalias para um elemento de dimensão.

índice Um valor positivo menor ou igual ao total de filhosno elemento especificado.

Exemplo

ELCOMP("Region","Central Europe",2)

Na dimensão Região, o elemento consolidado Europa Central é uma consolidação dos filhos Alemanha eFrança. De forma apropriada, o exemplo retorna França.

196 IBM Planning Analytics: Referência do TM1

ELCOMPNO ELCOMPN retorna o número de componentes em um elemento especificado. Se o argumento doelemento não for um elemento consolidado, a função retornará 0.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

ELCOMPN(dimension, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento O nome de um elemento consolidado na dimensão.Este argumento também pode ser o nome de umalias para um elemento de dimensão.

Exemplo

Na dimensão Região, o elemento Escandinávia é uma consolidação de três elementos. O exemplo retorna3.

ELISCOMPO ELISCOMP determina se o elemento1 é um filho do elemento2 na dimensão especificada. A funçãoretornará TRUE se o elemento1 for um filho do elemento2, caso contrário, a função retornará FALSE.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

ELISCOMP(dimension, element1, element2)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento1 O nome de um elemento na dimensão. Esteargumento também pode ser o nome de um aliaspara um elemento de dimensão.

elemento2 O nome de um elemento na dimensão. Esteargumento também pode ser o nome de um aliaspara um elemento de dimensão.

Exemplo

ELISCOMP("Region","Germany","Central Europe")

Na dimensão Região, o elemento Europa Central é uma consolidação de dois elementos, Alemanha eFrança. O exemplo retorna TRUE.

Capítulo 4. Funções da Planilha 197

Observe que esta função retorna TRUE apenas para filhos imediatos. No exemplo acima, Alemanha é umfilho de Europa Central. Além disso, Europa Central é um filho de Europa. No entanto, como a função sóretorna TRUE para filhos imediatos, o exemplo a seguir retorna False:

ELISCOMP("Region","Germany","Europe")

ELISPARO ELISPAR determina se o elemento1 é um pai do elemento2 na dimensão especificada. A funçãoretornará TRUE se o elemento1 for um pai do elemento2, caso contrário, a função retornará FALSE.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

ELISPAR(dimension, element1, element2)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento1 O nome de um elemento na dimensão. Esteargumento também pode ser o nome de um aliaspara um elemento de dimensão.

elemento2 O nome de um elemento na dimensão. Esteargumento também pode ser o nome de um aliaspara um elemento de dimensão.

Exemplo

ELISPAR("Region","Central Europe","Germany")

Na dimensão Região, o elemento consolidado Europa Central é o pai de Alemanha e França. De formaapropriada, o exemplo retorna TRUE

Observe que esta função retorna TRUE apenas para pais imediatos. No exemplo acima, Europa é um paide Europa Central. Além disso, Europa Central é um pai de Alemanha. No entanto, como Europe não é umpai imediato de Germany, o exemplo a seguir retorna FALSE:

ELISPAR("Region","Europe","Germany")

ELLEVO ELLEV retorna o nível de um elemento em uma dimensão.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

ELLEV(dimension, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

198 IBM Planning Analytics: Referência do TM1

Argumento Descrição

elemento O nome de um elemento na dimensão. Este argumento também pode sero nome de um alias para um elemento de dimensão.

Exemplo

ELLEV("Region","Europe")

Na dimensão Região, as nações individuais (Nível 0) somam-se às regiões (Nível 1). As regiões são entãoincluídas em super-regiões (Nível 2) que, por sua vez, são incluídas no mundo (Nível 3).

O exemplo retorna 2, pois Europa é um elemento de Nível 2.

ELPARO ELPAR retorna o pai de um elemento em uma dimensão especificada

Esta função da planilha é válida apenas em planilhas.

Sintaxe

ELPAR(dimension, element, index)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento O nome de um elemento na dimensão. Esteargumento também pode ser o nome de um aliaspara um elemento de dimensão.

índice Um valor positivo menor ou igual ao número totalde elementos consolidados (pais) que usam oargumento do elemento como um filho.

Exemplo

ELPAR("Model","Wagon 4WD",2)

Na dimensão Modelo, o elemento Wagon 4x4 é um filho de Total de Wagons e de Total de 4x4. Portanto,Total de Wagons e Total de 4x4 são pais de Wagon 4x4. Na estrutura da dimensão do Modelo, Total deWagons é definido primeiro, Total de 4x4 é definido em segundo lugar.

O exemplo retorna Total de 4x4, pois esta é a segunda instância de um pai para Wagon 4x4 na dimensãodo Modelo.

Capítulo 4. Funções da Planilha 199

ELPARNO ELPARN retorna o número de pais de um elemento em uma dimensão especificada.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

ELPARN(dimension, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento O nome de um elemento na dimensão. Esteargumento também pode ser o nome de um aliaspara um elemento de dimensão.

Exemplo

ELPARN("Model","Wagon 4WD")

Na dimensão do Modelo, o elemento Wagon 4x4 é um filho de Total de Wagons e de Total de 4x4.Portanto, Total de Wagons e Total de 4x4 são pais de Wagon 4x4. A função retorna 2.

ELSLENO ELSLEN retorna o comprimento de um elemento de sequência de caracteres em uma dimensão. Se oelemento especificado não for um membro da dimensão especificada, ou se não for um elemento desequência de caracteres, a função retornará 0.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

ELSLEN(dimension, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento O nome de um elemento de sequência nadimensão. Este argumento também pode ser onome de um alias para um elemento de dimensão.

Exemplo

ELSLEN("Region","Washington")

O elemento Washington é um elemento de sequência com 10 caracteres. O exemplo retorna 10.

ELWEIGHTO ELWEIGHT retorna o peso de um filho em um elemento consolidado.

200 IBM Planning Analytics: Referência do TM1

Esta função da planilha é válida apenas em planilhas.

Sintaxe

ELWEIGHT(dimension, element1, element2)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento1 O nome de um elemento consolidado na dimensão.Este argumento também pode ser o nome de umalias para um elemento de dimensão.

elemento2 O nome de um filho do elemento consolidado. Esteargumento também pode ser o nome de um aliaspara um elemento de dimensão.

Exemplo

ELWEIGHT("Account1","Gross margin","Variable costs")

Conforme mostra a figura a seguir, o elemento Custos variáveis, que é um filho de Margem bruta, tem umpeso de -1.

O exemplo retorna -1.

SUBNMSUBNM retorna o elemento de um subconjunto de dimensões correspondente ao argumentoIndexOrName. Se você incluir o parâmetro Alias opcional nesta função, a função retornará o alias para oelemento selecionado.

Ao clicar duas vezes em uma célula contendo uma função SUBNM, o Editor de Subconjunto se abre. Épossível então selecionar um novo elemento para colocar em sua planilha. O elemento selecionadotorna-se o valor de retorno da função SUBNM, e a função atualiza automaticamente o argumentoIndexOrName para refletir o novo elemento.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

SUBNM(Dimension, Subset, IndexOrName, [Alias])

Argumento Descrição

Dimensão Um nome de dimensão válido.

Subconjunto O nome de um subconjunto da dimensão.

Capítulo 4. Funções da Planilha 201

Argumento Descrição

IndexOrName Um índice para o subconjunto ou o nome de umelemento no subconjunto.

Se for um índice, um número inteiro positivo menorou igual ao número total de elementos nosubconjunto especificado. Se um nome, umasequência que representa o nome de um elementodo subconjunto.

Alias O nome de um alias existente para o subconjunto.Este é um argumento opcional. Se ele for usado, oalias especificado será aplicado quando o Editor deSubconjunto for aberto e a função retornará o aliasdo elemento selecionado.

Exemplo

SUBNM("Region","Top Producers",2)

O subconjunto Principais Produtores da dimensão Região contém os elementos ordenados EstadosUnidos, Alemanha, Grã-Bretanha e México. Como o argumento de Índice aponta para o segundoelemento no subconjunto, o exemplo retorna Alemanha.

SUBNM("Region","TopProducers","Germany","Deutsch")

Este exemplo retorna o alias Deutsch para o elemento Alemanha (Deutschland) do subconjunto PrincipaisProdutores da dimensão Região.

SUBSIZO SUBSIZ retorna o número de elementos em um subconjunto de dimensão.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

SUBSIZ(dimension, subset)

Argumento Descrição

dimensão Um nome de dimensão válido.

subconjunto O nome de um subconjunto da dimensão.

Exemplo

SUBSIZ("Region","Top Producers")

O subconjunto Principais Produtores da dimensão Região contém quatro elementos: Estados Unidos,Alemanha, Grã-Bretanha e México.

O exemplo retorna 4.

202 IBM Planning Analytics: Referência do TM1

TABDIMTABDIM retorna o nome da dimensão que corresponde a um argumento de índice especificado.

A função sempre retorna uma dimensão com base na ordem original das dimensões no cuboespecificado, mesmo que a ordem das dimensões no cubo tenha sido alterada por meio do TM1 CubeOptimizer.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

TABDIM(cube, index)

Argumento Descrição

cubo Um nome de cubo válido.

índice Um valor positivo menor ou igual ao total dedimensões no cubo.

Exemplo

TABDIM("98sales",3)

O cubo 98sales contém cinco dimensões: account1, actvsbud, modelo, mês e região. O exemplo retornamodelo, a terceira dimensão de 98sales.

TM1ELLISTTM1ELLIST retorna um vetor de valores de matriz para baixo. Ele é útil porque você pode obter umconjunto de valores do elemento a partir de um modelo de TM1 usando uma única fórmula.

Nota:

• TM1ELLIST não sobrescreve ou insere em qualquer espaço não de fórmula como um RelatórioDinâmico. Cabe ao designer da pasta de trabalho consumir a resposta de valor plural corretamente.

• O TM1ELLIST retorna uma matriz de valores, no entanto, somente o primeiro elemento será exibido sea função for colocada em um armazenamento de valor singular.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

TM1ELLIST (ServerDimension, [ SetName ], [ ElementList ],[ AliasOverride ], [ ExpandAbove ], [ MDXOverride ], [ IndentRate ], [ IndentCharacter ])

Argumento Descrição Obrigatório / Opcional

ServerDimension Uma dimensão, especificada usando o formatoserver:dimension.

Necessário

SetName Um conjunto nomeado. Se este argumento estivervazio, todos os elementos da dimensão serãousados.

Opcional

Capítulo 4. Funções da Planilha 203

Argumento Descrição Obrigatório / Opcional

Elementlist Uma matriz de valores que especifica uma lista deelementos para constituir um conjunto. Porexemplo, ElementList pode referir-se a umintervalo de células.

Quando este argumento é fornecido, o conjuntonomeado especificado pelo argumento SetName éignorado.

Se este argumento estiver vazio, os elementos doconjunto especificado pelo argumento SetNameserão usados.

Opcional

AliasOverride Uma sequência de caracteres que define o aliasusado para o conjunto.

Quando este argumento é fornecido, ele substitui apropriedade de alias definida pelo subconjuntoespecificado pelo argumento SetName.

Se este argumento estiver vazio, o alias doconjunto especificado pelo argumentoSubsetName será usado.

Opcional

ExpandAbove Um sinalizador Booleano para ativar ou desativar apropriedade Expandir Acima do conjunto.

Quando este argumento é fornecido, ele substitui apropriedade padrão Expandir Acima definida pelosubconjunto especificado pelo argumento Set.

Se o valor do argumento for 1, os membrosconsolidados serão expandidos para cima ao fazerdrill.

Se o valor do argumento for 0, os membrosconsolidados irão expandir para baixo ao fazerdrill. Se este argumento estiver vazio, será usada apropriedade Expandir acima do subconjuntoespecificado pelo argumento de subconjunto.

Opcional

MDXOverride Uma instrução MDX que se aplica ao subconjuntoespecificado pelo argumento SubsetName/ElementList.

Quando este argumento é fornecido, ele substitui ofiltro MDX padrão definido pelo subconjuntoespecificado pelo argumento SetName.

Se este argumento estiver vazio ou omitido, serãousados os membros do conjunto especificado peloargumento SetName.

Opcional

204 IBM Planning Analytics: Referência do TM1

Argumento Descrição Obrigatório / Opcional

IndentRate Um valor de número inteiro para indicar quantasindentações são aplicadas a cada nível durante odrilling down em um membro consolidado.

Se o valor do argumento for 0, não há indentaçãoautomática. IndentRate é relativo ao nível doconjunto dos elementos do conjunto.

Se esse argumento estiver vazio ou omitido, umaindentação será aplicada a cada nível à medidaque você realizar drill down de um membroconsolidado.

Opcional

IndentCharacter IndentChar configura o símbolo usado parafornecer indentação em sequência, o padrão é ocaractere en-space (o símbolo de espaço normal).

Opcional

Exemplo

TM1ELLIST ("PlanSamp:plan_currency "," Todas as moedas ")

TM1ELLIST retorna uma matriz de elementos com base em determinados argumentos.

Para recuperar todos os valores retornados, um intervalo nomeado pode ser criado no Excel, referindo-seà fórmula. Para fazer isso, crie um intervalo nomeado e insira a fórmula TM1ELLIST na coluna Refere-sea.

Selecione o número desejado de células (com base no tamanho da matriz de retorno) no Excel, digite=[namedrange] e pressione CTRL + Shift + Enter.

A função INDEX do Excel pode, então, ser usada para extrair um elemento único para o intervalo.

Capítulo 4. Funções da Planilha 205

TM1GLOBALSANDBOXTM1GLOBALSANDBOX retorna o ambiente de simulação ativo global atual para o usuário.

Nota: Esta função é válida apenas em Planning Analytics for Microsoft Excel e nas planilhas do PlanningAnalytics. Não é suportado em IBM TM1 Perspectives.

Sintaxe

TM1GLOBALSANDBOX(SERVER)

Argumento Descrição Obrigatório / Opcional

Servidor O nome do servidor TM1. Necessário

Exemplo

TM1GLOBALSANDBOX("Planning Sample")

TM1INFOTM1INFO retorna informações sobre a versão e o cliente atuais do TM1.

Nota: Esta função é válida apenas em Planning Analytics for Microsoft Excel e nas planilhas do PlanningAnalytics. Não é suportado em IBM TM1 Perspectives.

Sintaxe

TM1INFO("Property Name")

206 IBM Planning Analytics: Referência do TM1

Argumento Descrição Obrigatório / Opcional

Nome da Propriedade O nome da propriedade pode ser um dos seguintesvalores:clientversion

Retorna o número integral da versão do cliente.Por exemplo, 10.2.10000

clientversionmajorRetorna o número maior da versão do cliente.

clientversionminorRetorna o número menor da versão do cliente.

clientversionpatchRetorna o número do hotfix e do fix pack.

clienteRetorna o nome do cliente. Por exemplo, cor ouplanilha da web.

Necessário

Exemplo

TM1INFO("clientversion")

TM1PRIMARYDBNAMEO TM1PRIMARYDBNAME retorna o nome do servidor TM1 primário através do qual o usuário foiautenticado, mesmo se o usuário estiver com login efetuado implicitamente em diversos servidores TM1.Esta função não aceita nenhum argumento.

Nota: Esta função é válida apenas em Planning Analytics for Microsoft Excel e nas planilhas do PlanningAnalytics. Não é suportado em IBM TM1 Perspectives.

Sintaxe

TM1PRIMARYDBNAME()

TM1RptElIsConsolidatedTM1RptElIsConsolidated retorna um valor booleano para indicar se um elemento em um Formulário Ativoé consolidado. Essa função da planilha é usada para criar Formulários ativos.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

TM1RptElIsConsolidated(RptRowFormula, Element)

Argumento Descrição

RptRowFormula Uma referência absoluta para uma célula contendouma fórmula TM1RptRow.

Elemento Uma referência relativa a uma célula contendo umelemento da fórmula TM1RptRow.

Capítulo 4. Funções da Planilha 207

TM1RptElIsExpandedTM1RptElIsExpanded retorna um valor booleano para indicar se um elemento é expandido em umsubconjunto de linhas dentro de um Formulário Ativo. Essa função da planilha é usada para criarFormulários ativos.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

TM1RptElIsExpanded(RptRowFormula, Element)

Argumento Descrição

RptRowFormula Uma referência absoluta para uma célula contendouma fórmula TM1RptRow.

Elemento Uma referência relativa a uma célula contendo umelemento da fórmula TM1RptRow.

TM1RptElLevTM1RptElLev retorna um valor de número inteiro para um nível de elemento relativo à raiz nosubconjunto. Essa função da planilha é usada para criar Formulários ativos. Essa função é diferente dafunção de planilha ElLev.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

TM1RptElLev(RptRowFormula, Element)

Argumento Descrição

RptRowFormula Uma referência absoluta para uma célula defórmula TM1RptRow.

Elemento Uma referência relativa a uma célula contendo umelemento da fórmula TM1RptRow.

TM1RptFilterTM1RptFilter define o filtro aplicado a uma dimensão da coluna Formulário Ativo. Essa função da planilhaé usada para criar Formulários ativos.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

TM1RptFilter(ReportView,Tuple,FilterFunction,FilterValue,SortOrder)

208 IBM Planning Analytics: Referência do TM1

Argumento Descrição

ReportView Uma referência de célula a uma célula que contémuma fórmula TM1RptView. O filtro se aplica àvisualização especificada pela fórmulaTM1RptView.

Tupla Uma sequência de caracteres de tuplaespecificando o elemento na dimensão da colunapara a qual o filtro se aplica. Por exemplo, [month].[Feb].

FilterFunction Um dos seguintes nomes de função de filtro:

TOPCOUNT

BOTTOMCOUNT

TOPPERCENT

BOTTOMPERCENT

TOPSUM

BOTTOMSUM

FilterValue Um valor de filtro.

SortOrder Uma das seguintes ordens de classificação:

asc

desc

Exemplo

=TM1RptFilter($B$4,"[month].[Jan]","TOPCOUNT",5,"asc")

TM1RptRowTM1RptRow configura a definição da linha principal do Formulário Ativo. A definição de linha principalrege o comportamento de todas as linhas no Formulário Ativo. Essa função da planilha é usada para criarFormulários ativos.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

TM1RptRow(ReportView, Dimension, Subset, SubsetElements,Alias, ExpandAbove,MDXStatement, Indentations, ConsolidationDrilling)

Argumento Descrição

ReportView Uma referência para uma célula que contém umafórmula TM1RptView.

Dimensão Uma dimensão, especificada usando o formatotm1_server_name:dimension_name.

Capítulo 4. Funções da Planilha 209

Argumento Descrição

Subconjunto Um subconjunto nomeado. Se este argumentoestiver vazio, todos os elementos da dimensãoserão usados.

SubsetElements Uma referência de faixa de células que especificauma lista de elementos para constituir umsubconjunto.

Quando este argumento é fornecido, o subconjuntoespecificado pelo argumento Subconjunto éignorado.

Se este argumento estiver vazio, os elementos desubconjunto especificado pelo argumento deSubconjunto serão usados.

Alias Uma sequência de caracteres que define o aliasusado para o subconjunto.

Quando este argumento é fornecido, ele substitui apropriedade de alias definida pelo subconjuntoespecificado pelo argumento Subconjunto.

Se este argumento estiver vazio, o alias dosubconjunto especificado pelo argumento deSubconjunto será usado.

ExpandAbove Um sinalizador Booleano para ativar ou desativar apropriedade Expandir Acima do subconjunto.Quando este argumento é fornecido, ele substitui apropriedade padrão Expandir Acima definida pelosubconjunto especificado pelo argumentoSubconjunto.

Se o valor do argumento for 1, os elementosconsolidados serão expandidos para cima ao fazerdrill.

Se o valor do argumento for 0, os elementosconsolidados serão expandidos para baixo ao fazerdrill.

Se este argumento estiver vazio, a propriedadeExpandir Acima do subconjunto especificado peloargumento de Subconjunto será usada.

MDXStatement Uma instrução MDX que é aplicável ao subconjuntoespecificado pelo argumento de Subconjunto.

Quando este argumento é fornecido, ele substitui ofiltro MDX padrão definido pelo subconjuntoespecificado pelo argumento de Subconjunto.

Se este argumento está vazio ou é omitido, oselementos de subconjunto especificado peloargumento de Subconjunto serão usados.

210 IBM Planning Analytics: Referência do TM1

Argumento Descrição

Indentações Um valor de número inteiro para indicar quantasindentações são aplicadas a cada nível durante odrilling em um elemento consolidado. Se o valor doargumento for 0, não há indentação automática.

Este é um argumento opcional. Quando o valorestiver ausente, será aplicada uma indentação acada nível conforme é feito drill down em umelemento consolidado.

ConsolidationDrilling Um sinalizador Booleano para ativar ou desativar odrill em elementos consolidados.

Quando este valor do argumento for 1, os usuáriospoderão fazer drill down em elementosconsolidados no Formulário Ativo.

Quando este valor do argumento for 0, os usuáriosnão poderão fazer drill down em elementosconsolidados no Formulário Ativo.

Este é um argumento opcional. Quando oargumento estiver ausente, o comportamentopadrão será permitir o drill em elementosconsolidados.

Exemplo

=TM1RptRow($B$9,"sdata:region","",'{AR}01'!$B$17:$B$18,"",1,"",5,0)

TM1RptTitleTM1RptTitle define uma dimensão de título Formulário Ativo. Essa função da planilha é usada para criarFormulários ativos.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

TM1RptTitle(Dimension,Element)

Argumento Descrição

Dimensão Uma dimensão, especificada usando o formatotm1_name:dimension_name.

Elemento Uma referência de célula a uma célula contendouma função SUBNM que retorna um nome deelemento.

Exemplo

TM1RptTitle("SData:model",$C$7)

Capítulo 4. Funções da Planilha 211

TM1RptViewO TM1RptView define a Visualização em um Formulário Ativo. Essa função da planilha é usada para criarFormulários ativos.

Essa função da planilha é válida apenas em planilhas.

Sintaxe

TM1RptView(ViewID,ZeroSuppression,TM1RptTitle,...)

Argumento Descrição

ViewID Um nome para a visualização, usando o formatoformat tm1_name:cube_name:unique_id.

ZeroSuppressio Um sinalizador booleano para ativar ou desativar apropriedade de supressão zero para a visualização.1 = ativar, 0 = desativar

TM1RptTitle Para cada dimensão do título do Formulário Ativo,inclua uma função TM1RptTitle como argumentopara TM1RptView.

FormatRange O intervalo de formatação do Formulário Ativo.

Ao criar um Formulário Ativo, um intervalonomeado chamado de TM1RPTFMTRNG é criadopara incluir todas as células do intervalo deformatação. É possível usar esse intervalonomeado como um argumento.

IDColumn A coluna que contém as IDs de formato noFormulário Ativo.

Ao criar um Formulário Ativo, um intervalonomeado chamado de TM1RPTFMTIDCOL é criadopara incluir todas as células do intervalo deformatação. É possível usar esse intervalonomeado como um argumento.

Exemplo

=TM1RPTVIEW("SData:SalesCube:6", 0, TM1RPTTITLE("SData:actvsbud",$C$6), TM1RPTTITLE("SData:model",$C$7), TM1RPTTITLE("SData:account1",$C$8), TM1RPTFMTRNG,TM1RPTFMTIDCOL)

TM1UserTM1User retorna o nome de usuário do usuário atual do TM1.

Caso o usuário atual do TM1 não esteja conectado a um servidor ou se o servidor especificado não estiverem execução, TM1User retornará uma sequência de caracteres vazia.

212 IBM Planning Analytics: Referência do TM1

Se o TM1User for executado em um servidor que está configurado para usar a autenticação de CAM, afunção retornará o nome/CAMID do usuário interno, não o nome de exibição.

Essa função da planilha é válida apenas em planilhas.

Sintaxe

TM1User("ServerName")

Argumento Descrição

Nome do Servidor O nome do servidor ao qual o usuário do TM1 estáconectado.

Exemplo

TM1User("SData")

Se um usuário chamado BrianT efetuar login no servidor SData e esse usuário executar a função doTM1User, o exemplo acima retornará BrianT.

VIEWVIEW cria uma visualização otimizada do cubo especificado pelo argumento de cubo.

Uma única função VIEW é criada quando você fatia uma visualização a partir de uma navegação do cubo.

Todas as fórmulas DBR e DBRW que fazem referência à função VIEW podem acessar essa visualizaçãootimizada. Dessa forma, os resultados são retornados muito mais rapidamente.

Várias funções VIEW podem residir na mesma planilha, caso haja blocos de fórmulas DBR que fazemreferência a diferentes visualizaões ou cubos do TM1.

Esta função da planilha é válida apenas em planilhas.

Sintaxe

VIEW(cube, e1,e2[,...en])

Argumento Descrição

cubo O nome do cubo do qual os dados serãorecuperados.

e1,...en Elementos específicos na fatia a serem usadoscomo títulos, ou a sequência "!". A sequência "!"indica que a dimensão correspondente é uma linhaou coluna na visualização. Esses argumentostambém podem ser os nomes de aliases doselementos de dimensão.

Exemplo

VIEW("93sales",$B$2,$B$3,$B$4,"!","!")

Capítulo 4. Funções da Planilha 213

214 IBM Planning Analytics: Referência do TM1

Capítulo 5. Funções do Turbo IntegratorO TM1 Turbo Integrator permite manipular dados e metadados do TM1 quando você define um processo.

Isto é feito usando funções nas subguias Prólogo, Metadados, Dados e Epílogo, na guia Avançado dajanela do Turbo Integrator. Estas subguias incluem instruções geradas com base em configurações eopções selecionadas ao definir um processo do Turbo Integrator. As funções criadas devem aparecerapós as instruções geradas. Para obter detalhes sobre como criar processos com o Turbo Integrator,consulte a documentação do TM1 Turbo Integrator.

As funções do Turbo Integrator nesta seção estão armazenadas por categoria.

Não existe nenhuma interface para ajudar na criação de funções do Turbo Integrator. Insira funçõesmanualmente na subguia apropriada dentro da guia Avançada. Os argumentos de sequência para funçõesdo Turbo Integrator devem ser colocados entre aspas simples. Deve ser incluído um ponto e vírgula (;)para indicar o final de cada função na janela do Turbo Integrator.

Além dessas funções do Turbo Integrator, também é possível incorporar todas as funções padrão do TM1Rules em uma definição de processo, com exceção da função STET.

Cada argumento para funções do Turbo Integrator é limitado em 256 bytes. Uma função do TurboIntegrator pode aceitar vários argumentos, e cada argumento é limitado em 256 bytes.

Palavras reservadas do Turbo IntegratorPara evitar erros nos scripts do Turbo Integrator, é necessário evitar a criação de variáveis com nomesque correspondam a qualquer uma das palavras listadas nas categorias a seguir.

Existem quatro categorias de palavras reservadas no Turbo Integrator:

• Nomes de funções de regras - consulte Capítulo 2, “Funções das Regras”, na página 101 para obteruma listagem completa de todos os nomes de funções de regras.

• Nomes de funções do Turbo Integrator - consulte Capítulo 5, “Funções do Turbo Integrator”, na página215 para obter uma listagem completa de todos os nomes de funções do Turbo Integrator.

• Nomes de variáveis locais implícitas - consulte “Variáveis Locais do Turbo Integrator” na página 417para obter uma listagem completa de todos os nomes de variáveis locais implícitas do Turbo Integrator.

• Palavras-chave do Turbo Integrator - essas palavras-chave são reservadas e não devem ser usadascomo variáveis nos scripts:

– break– else– elseif– end– endif– if– while

Funções ASCII e de Texto do Turbo IntegratorEstas funções referem-se a ASCII e Texto.

ASCIIDeleteASCIIDelete exclui um arquivo ASCII.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

© Copyright IBM Corp. 2007, 2019 215

Sintaxe

ASCIIDelete(FileName);

Argumento Descrição

FileName O nome do arquivo ASCII que você deseja excluir.Caso não seja especificado um caminho completo,o TM1 procurará o arquivo no diretório de dados doservidor.

Exemplo

Este exemplo exclui o arquivo ASCII chamado 2002Q1Results.cma do diretório C:\exported_data.

ASCIIDelete('C:\exported_data\2002Q1Results.cma');

ASCIIOutputASCIIOutput grava um registro delimitado por vírgulas para um arquivo ASCII.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

O arquivo ASCII é aberto quando o primeiro registro é gravado, e é fechado quando o procedimento doTurbo Integrator (Prólogo, Metadados, Dados ou Epílogo) que contém a função ASCIIIOutput conclui oprocessamento.

Cada registro de saída gerado por ASCIIOutput é limitado em 8000 bytes. Se um registro de saídaexceder 8000 bytes, o registro será truncado e será registrado um aviso no arquivo TM1ProcessError.log.

Quando ASCIIOutput encontrar um argumento de sequência que envia o registro de saída além do limitede 8000 bytes, ela ignorará esse argumento e quaisquer argumentos adicionais. Por exemplo, se houver10 argumentos de sequência e a saída para os primeiros sete argumentos totalizar 7950 bytes, enquantoa saída para o oitavo argumento for de 51 bytes, apenas a saída para os primeiros sete argumentos serágravada no registro. Se houver dez argumentos de sequência e o primeiro argumento for superior a 8000bytes, nenhuma saída será gravada no registro.

Se você usar a função ASCIIOutput para gravar no mesmo arquivo em vários procedimentos (guias) deum processo do Turbo Integrator, o arquivo será sobrescrito sempre que for aberto para um novoprocedimento.

A função ASCIIOutput gera um erro secundário se ocorrer um erro ao gravar o arquivo ASCII. Além disso,a função retorna um valor durante a execução: 1 se a função gravar com êxito o arquivo ASCII e 0 emcaso de falha.

Nota: O erro será gerado e o valor retornado apenas quando ASCIIOutput estiver gravando em um discodiferente daquele no qual o servidor está sendo executado. Por exemplo, se o servidor estiver emexecução na unidade C: e ASCIIOutput estiver gravando na unidade F:, e a unidade F: ficar sem espaço, oerro será capturado e o servidor permanecerá ativo. Se o servidor estiver sendo executado na unidade C:enquanto o ASCIIOutput também estiver gravando na unidade C:, e essa unidade ficar sem espaço, oservidor será encerrado (conforme esperado).

Nota: A capacidade de executar a função ASCIIOutput quando a origem de dados é uma visualização docubo é determinada pela designação de recursos Permitir Exportar como Texto, que é configurada porgrupo de usuários. Se um usuário for um membro de um grupo que tem a capacidade de exportar dadoscomo texto negada, qualquer tentativa do usuário de executar ASCIIOutput resultará no encerramento doprocesso com um erro de permissão. O log de mensagens do processo indica que a "Execução foiinterrompida. Nenhum acesso de segurança para ASCIIOutput."

Para obter detalhes sobre a configuração do recurso Permitir exportação como texto, consulte"Designações de capacidade" em Operações do TM1.

216 IBM Planning Analytics: Referência do TM1

Nota: A função ASCIIOutput coloca o caractere hexadecimal 0x1A no final de todos os arquivos gerados.No entanto, o TM1 Web não pode abrir uma Planilha da web que contém o caractere hexadecimal 0x1A.

Ao usar ASCIIOutput para exportar dados do TM1 para um arquivo ASCII e, em seguida, tentar abrir oarquivo em um TM1 Websheet, você encontrará o erro a seguir.

Erro ocorrido ao converter a pasta de trabalho do MS Excel em formato XML, o valor hexadecimal 0x1A éum caractere inválido.

Ao remover o caractere hexadecimal 0x1A da Planilha da web, o arquivo será aberto no TM1 Web.

Sintaxe

ASCIIOutput(FileName, String1, String2, ...Stringn);

Argumento Descrição

FileName Um caminho completo para o arquivo ASCII noqual você deseja gravar o registro. O caminho deveincluir uma extensão do arquivo.

Sequência1...Sequêncian Uma sequência que corresponde a cada campoque você deseja criar no arquivo ASCII. Esteargumento pode ser uma sequência ou umavariável do Turbo Integrator para uma sequência.

Exemplo

Este exemplo grava um registro no arquivo ASCII NewCube.cma. Cada arquivo no registro corresponde auma variável designada pelo Turbo Integrator a uma coluna em sua origem de dados.

ASCIIOutput('NewCube.cma', V1, V2, V3, V4, V5 );

NumberToStringNumberToString converte um número em uma sequência, usando o separador decimal para o código deidioma do usuário atual.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

No Microsoft Windows, o separador decimal é uma configuração de Opções Regionais.

A saída desta função é semelhante ao formato numérico 'geral'; ela não usa separadores de milhares eusa o sinal de menos (-) para indicar números negativos.

Sintaxe

NumberToString(Value);

Argumento Descrição

Valor O valor real que você deseja converter em umasequência.

Exemplo

nRET = NumberToString(1234.5);

Capítulo 5. Funções do Turbo Integrator 217

NumberToStringExNumberToStringEx converte um número em uma sequência, usando o formato de sequência, o separadordecimal e o separador de milhares transmitidos.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

NumberToStringEx(Value, NumericFormat, DecimalSep, ThousandsSep);

Argumento Descrição

Valor O valor real que você deseja converter em umasequência.

FormatString Uma sequência de formato numérico do TM1 quedefine o formato para a saída da função. Osformatos numéricos estão descritos nadocumentação do IBM Cognos TM1 Perspectives,TM1 Architect, and TM1 Web.

DecimalSep O separador decimal a ser usado na sequência desaída.

ThousandsSep O separador de milhares a ser usado na sequênciade saída.

Exemplo

sRet=NUMBERTOSTRINGEX(7895.23,'#,0.#########', ',', '.');

ASCIIOUTPUT('number_to_string.txt',sRet);

Will return in ascii file;

7.895,23

SetInputCharacterSetA função SetInputCharacterSet permite especificar o conjunto de caracteres usado em uma origem dedados do TurboIntegrator.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Quando um processo do Turbo Integrator ler um arquivo externo como entrada, ele precisará conhecer oconjunto de caracteres no qual esse arquivo externo foi gravado. Caso o arquivo contenha uma marca deordem de byte válida, as funções do TM1 converterão corretamente o arquivo em UTF-8, se necessário.

Para formatos que não possuem uma marca de ordem do byte válida, os caracteres deverão serconvertidos de alguma outra codificação em UTF-8. Se os conversores adequados estiverem presentesna máquina que hospeda o servidor, o arquivo de entrada será convertido para o conjunto de caracteresUnicode requerido pelo TM1.

Sintaxe

SetInputCharacterSet (CharacterSet);

218 IBM Planning Analytics: Referência do TM1

Argumento Descrição

CharacterSet A codificação de caracteres no arquivo de entradaa ser usada pelo processo do Turbo Integrator.

Se o argumento CharacterSet não for um tipo decaractere conhecido, o tipo será padronizado comoo código de idioma do sistema.

Codificação de Caracteres Código de Idioma do Sistema

TM1CS_ISO_8859_1 ISO-8859-1 Latim-1, Europa Ocidental

TM1CS_ISO_8859_2 ISO-8859-2 Latim-2, Europa Central

TM1CS_ISO_8859_3 ISO-8859-3 Latim-3, Sul da Europa

TM1CS_ISO_8859_4 ISO-8859-4 Latim-4, Norte Europeu

TM1CS_ISO_8859_5 ISO-8859-5 Latim/Cirílico

TM1CS_ISO_8859_6 ISO-8859-6 Latim/Árabe

TM1CS_ISO_8859_7 ISO-8859-7 Latim/Grego

TM1CS_ISO_8859_8 ISO-8859-8 Latim/Hebraico

TM1CS_ISO_8859_9 ISO-8859-9 Latim-5, Turco

TM1CS_ISO_8859_10 ISO-8859-10 Latim-6, Nórdico

TM1CS_ISO_8859_11 ISO-8859-11 Latim/Tai

TM1CS_ISO_8859_13 ISO-8859-13 Latim-7, Costa Báltica

TM1CS_ISO_8859_14 ISO-8859-14 Latim-8, Celta

TM1CS_ISO_8859_15 ISO-8859-15 Latim-9, substitui ISO-8859-1

TM1CS_ISO_8859_16 ISO-8859-16 Latim-10, Sudeste Europeu

TM1CS_WCP1250 Microsoft Windows Europa Central

TM1CS_WCP1251 Windows Cirílico

TM1CS_WCP1252 Windows Multilingual Latin-1

TM1CS_WCP1253 Windows Grego

TM1CS_WCP1254 Windows Turco

TM1CS_WCP1255 Windows Hebreu

TM1CS_WCP1256 Windows Árabe

Capítulo 5. Funções do Turbo Integrator 219

Codificação de Caracteres Código de Idioma do Sistema

TM1CS_WCP1257 Windows Báltico

TM1CS_WCP1258 Windows Vietnã

TM1CS_WCP874 Windows Thai

TM1CS_WCP932 Windows Japonês

TM1CS_WCP936 Windows chinês simplificado

TM1CS_WCP949 Windows Coréia

TM1CS_WCP950 Windows chinês tradicional

TM1CS_KOI8R Russo e Cirílico (KOI8-R)

TM1CS_GB18030 PRC versão UNICODE

TM1CS_BIG5 Chinês Tradicional

TM1CS_SHIFTJIS JIS 0201 + JIS 0208, um pouco diferente deCP932

TM1CS_SJIS0213 JIS 0213-2004, não BMP necessário.

TM1CS_EUC_JP EUC Japonês

TM1CS_EUC_CN EUC Chinês Simplificado

TM1CS_EUC_KR EUC Coreano

TM1CS_UTF8 UTF-8

TM1CS_UTF16 UTF-16 Little Endian

TM1CS_UTF16ESC Notação UNICODE

TM1CS_UTF32 UTF-32 Little Endian

TM1CS_OS_DEFAULT padrão do sistema operacional

TM1CS_LOCALPATH codificação local, mas notação UNICODE em nãonativa.

Exemplo

SetInputCharacterSet ('TM1CS_ISO_8859_11');

Este exemplo especifica que o conjunto de caracteres de entrada para a origem de dados do TurboIntegrator é ISO-8859-11 Latim/Tai.

220 IBM Planning Analytics: Referência do TM1

SetOutputCharacterSetSetOutputCharacterSet permite especificar o conjunto de caracteres a ser usado durante a composiçãode um arquivo de texto usando TextOutput em um processo TurboIntegrator.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

A função com a função TextOutput.

Usada com TextOutputs.

Sintaxe

SetOutputCharacterSet( FileName, CharacterSet );

Argumento Descrição

FileName Um caminho completo para o arquivo de texto parao qual você deseja especificar um conjunto decaracteres. O caminho deve incluir uma extensãodo arquivo.

Este argumento deve ser idêntico ao argumentoFileName para a função TextOutput.

CharacterSet A codificação de caracteres a ser usada ao gravarno arquivo de saída.

Para obter informações adicionais sobre os valores válidos para CharacterSet, consulte“SetInputCharacterSet” na página 218.

SetOutputEscapeDoubleQuoteSetOutputEscapeDoubleQuote permite escapar aspas duplas que aparecem em nomes de elementos ouvalores de dados ao exportar uma visualização do cubo para um arquivo .csv.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Quando o SetOutputEscapeDoubleQuote é incluído em seu script TurboIntegrator e configurado como 1,o arquivo exportado retém as posições de aspas duplas conforme aparecem na visualização de cubo deorigem, escapando cada aspas duplas em outro par de aspas duplas. Por exemplo, se um elemento navisualização de origem for denominada "Region", o elemento será exportado como """Region""" noarquivo de saída .csv.

Quando SetOutputEscapeDoubleQuote não for incluído no script TurboIntegrator ou for configuradocomo 0, o arquivo exportado não escapará qualquer aspa dupla que apareça no cubo de origem.

SetOutputEscapeDoubleQuote é usado em conjunto com a função ASCIIOutput, que é a função que gravarealmente o arquivo de saída. SetOutputEscapeDoubleQuote deve preceder ASCIIOutput no scriptTurboIntegrator e ambas as funções devem usar o mesmo valor de parâmetro FileName.

Sintaxe

SetOutputEscapeDoubleQuote(FileName, Num);

Argumento Descrição

FileName Um caminho completo no qual você deseja gravara visualização do cubo. O caminho deve incluir umaextensão do arquivo.

Capítulo 5. Funções do Turbo Integrator 221

Argumento Descrição

Num Um sinalizador que determina se as aspas duplassão escapadas no arquivo de saída.

1 indica que as aspas duplas serão escapadas noarquivo de saída.

0 indica que as aspas duplas não serão escapadasno arquivo de saída.

Exemplo

SetOutputEscapeDoubleQuote('C:\temp\cube1.csv', 1);

Este exemplo escapa quaisquer aspas duplas encontradas na visualização do cubo de origem ao gravar asaída para o arquivo C:\temp\cube1.csv.

StringToNumberStringToNumber converte uma sequência em um número, usando o separador decimal para o código deidioma do usuário atual. Se a sequência de entrada for uma sequência de número inválida, o valorretornado será um valor de ponto flutuante inválido. No Microsoft Windows, o separador decimal é umaconfiguração de Opções Regionais.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

StringToNumber(String);

Argumento Descrição

Sequência A sequência que você deseja converter em umnúmero.

Exemplo

nRET = StringToNumber('123.45');

StringToNumberExStringToNumberEx converte uma sequência em um número, usando o separador decimal e o separadorde milhares transmitidos. Se a sequência de entrada for uma sequência de número inválida, o valorretornado será um valor de ponto flutuante inválido.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

StringToNumberEx(String, DecimalSep, ThousandsSep);

Argumento Descrição

Sequência A sequência que você deseja converter em umnúmero.

222 IBM Planning Analytics: Referência do TM1

Argumento Descrição

DecimalSep O separador decimal a ser usado no número desaída.

ThousandsSep O separador de milhares a ser usado no número desaída.

Exemplo

nRET = StringToNumberEx('12453.45', ' . ', ' , ');

TextOutputTextOutput grava um registro delimitado por vírgulas em um arquivo de texto.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Por padrão, o TextOutput grava caracteres no conjunto de caracteres do código do idioma da máquinaservidor. Para criar um arquivo em um conjunto de caracteres diferente, chame a funçãoSetOutputCharacterSet antes de chamar TextOutput.

O arquivo de texto é aberto quando o primeiro registro é gravado, e é fechado quando o procedimento doTurbo Integrator (Prólogo, Metadados, Dados ou Epílogo) que contém a função TextOutput conclui oprocessamento.

Se você usar a função TextOutput para gravar no mesmo arquivo em vários procedimentos (guias) de umprocesso do Turbo Integrator, o arquivo será sobrescrito sempre que for aberto para um novoprocedimento.

Cada registro de saída gerado por TextOutput é limitado em 8000 bytes. Se um registro de saída exceder8000 bytes, o registro será truncado e será registrado um aviso no arquivo TM1ProcessError.log.

Quando TextOutput encontrar um argumento de sequência que envia o registro de saída além do limitede 8000 bytes, ela ignorará esse argumento e quaisquer argumentos adicionais. Por exemplo, se houver10 argumentos de sequência e a saída para os primeiros sete argumentos totalizar 7950 bytes, enquantoa saída para o oitavo argumento for de 51 bytes, apenas a saída para os primeiros sete argumentos serágravada no registro. Se houver dez argumentos de sequência e o primeiro argumento for superior a 8000bytes, nenhuma saída será gravada no registro.

A função TextOutput gera um erro secundário se ocorrer um erro ao gravar o arquivo de texto. Além disso,a função retorna um valor durante a execução: 1 se a função gravar com êxito o arquivo de texto e 0 emcaso de falha.

O erro será gerado e o valor retornado apenas quando TextOutput estiver gravando em um discodiferente daquele no qual o servidor está sendo executado. Por exemplo, se o servidor estiver emexecução na unidade C: e TextOutput estiver gravando na unidade F:, e a unidade F: ficar sem espaço, oerro será capturado e o servidor permanecerá ativo. Se o servidor estiver sendo executado na unidade C:enquanto o TextOutput também estiver gravando na unidade C:, e essa unidade ficar sem espaço, oservidor será encerrado (conforme esperado).

Nota: A capacidade de executar a função TextOutput quando a origem de dados é uma visualização docubo é determinada pela designação de recursos Permitir Exportar como Texto, que é configurada porgrupo de usuários. Se um usuário for um membro de um grupo que tem a capacidade de exportar dadoscomo texto negada, qualquer tentativa do usuário de executar TextOutput resultará no encerramento doprocesso com um erro de permissão. O log de mensagens do processo indica que a "Execução foiinterrompida. Nenhum acesso de segurança para TextOutput."

Para obter detalhes sobre como o recurso Permitir exportar como texto é configurado, consulte"Designações de recursos" na documentação do IBM Cognos TM1 Operations.

Capítulo 5. Funções do Turbo Integrator 223

Sintaxe

TextOutput(FileName, String1, String2, ...Stringn);

Argumento Descrição

FileName Um caminho completo para o arquivo de texto noqual você deseja gravar o registro. O caminho deveincluir uma extensão do arquivo.

Sequência1...Sequêncian Uma sequência que corresponde a cada campoque você deseja criar no arquivo de texto. Esteargumento pode ser uma sequência ou umavariável do Turbo Integrator para uma sequência.

Exemplo

TextOutput('NewCube.cma', V1, V2, V3, V4, V5 );

Este exemplo grava um registro no arquivo NewCube.cma. Cada arquivo no registro corresponde a umavariável designada pelo Turbo Integrator a uma coluna em sua origem de dados.

Funções de Manipulação de Atributos do Turbo IntegratorEstas funções facilitam a manipulação de atributos.

ATTRNLATTRNL retorna um atributo numérico para o elemento especificado de uma dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ATTRNL(DimName, ElName, AttrName, [LangLocaleCode]);

Argumento Descrição

DimName Um nome de dimensão válido.

ElName Um elemento da dimensão.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidodo elemento.

224 IBM Planning Analytics: Referência do TM1

Argumento Descrição

LangLocaleCode Este parâmetro opcional especifica o código deidioma para o qual deseja retornar um valor.

Valores válidos LangLocaleCode correspondem acódigos de idioma internacionais listados nadimensão do controle }Cultures.

Quando o LangLocaleCode não é especificado ouestá omitido, o código de idioma atual do usuário éusado como o argumento LangLocaleCode.

Se um valor de atributo não existir para oLangLocaleCode, o valor para um LangLocaleCodepai associado será retornado. Se um valor deatributo não existir para um LangLocaleCode paiassociado, o valor de atributo base será retornado.

Por exemplo, se LangLocaleCode for fr-CA, afunção retornará o valor de atributo para o códigode idioma fr-CA, caso disponível. Se o valor deatributo para fr-CA não estiver disponível, afunção tentará retornar o valor de atributo para ocódigo de idioma pai fr. Se o valor de atributo parafr não estiver disponível, o valor de atributo debase será retornado

Exemplo

Neste exemplo, a função retorna o valor numérico do atributo Tamanho de Motor do elemento Sedan LSeries 1.8L na dimensão Modelo para o código de idioma Francês.

ATTRNL('Model', 'L Series 1.8L Sedan', 'Engine Size', 'fr');

ATTRSLAttrSL retorna um atributo de sequência para um elemento especificado de uma dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

AttrSL(DimName, ElName, AttrName, [LangLocaleCode]);

Argumento Descrição

DimName Um nome de dimensão válido.

ElName Um elemento da dimensão.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidodo elemento.

Capítulo 5. Funções do Turbo Integrator 225

Argumento Descrição

LangLocaleCode Este parâmetro opcional especifica o código deidioma para o qual deseja retornar um valor.

Valores válidos LangLocaleCode correspondem acódigos de idioma internacionais listados nadimensão do controle }Cultures.

Quando o LangLocaleCode não é especificado ouestá omitido, o código de idioma atual do usuário éusado como o argumento LangLocaleCode.

Se um valor de atributo não existir para oLangLocaleCode, o valor para um LangLocaleCodepai associado será retornado. Se um valor deatributo não existir para um LangLocaleCode paiassociado, o valor de atributo base será retornado.

Por exemplo, se LangLocaleCode for fr-CA, afunção retornará o valor de atributo para o códigode idioma fr-CA, caso disponível. Se o valor deatributo para fr-CA não estiver disponível, afunção tentará retornar o valor de atributo para ocódigo de idioma pai fr. Se o valor de atributo parafr não estiver disponível, o valor de atributo debase será retornado

Exemplo

Neste exemplo, a função retorna o valor de sequência do atributo Moeda do elemento 10100 nadimensão Plan_Business_Unit para o código de idioma Francês.

AttrSL('Plan_Business_Unit', '10100', 'Currency', 'fr');

AttrDeleteO AttrDelete exclui um atributo de elemento do banco de dados do TM1.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

AttrDelete(DimName, AttrName);

Argumento Descrição

DimName A dimensão para a qual você deseja excluir umatributo de elemento.

AttrName O nome do atributo que você deseja excluir.

Exemplo

Este exemplo exclui o atributo de elemento InteriorColor para a dimensão do Modelo.

AttrDelete('Model', 'InteriorColor');

226 IBM Planning Analytics: Referência do TM1

AttrInsertAttrInsert cria um novo atributo de elemento para uma dimensão. A função pode criar um atributo desequência, numérico ou de alias.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

AttrInsert(DimName, PrevAttr, AttrName, Type);

Argumento Descrição

DimName A dimensão para a qual você deseja criar umatributo de elemento.

PrevAttr O atributo que precede o atributo que está sendocriado.

AttrName O nome que você deseja designar ao novo atributo.

Tipo O tipo de atributo. Existem três possíveis valorespara o argumento Type:

• N - Cria um atributo numérico.• S - Cria um atributo de sequência.• A - Cria um atributo de alias.

Exemplo

Este exemplo cria o atributo de sequência InteriorColor para a dimensão do Modelo. Este atributo éinserido após o atributo Transmission.

AttrInsert('Model', 'Transmission', 'InteriorColor', 'S');

AttrPutNAttrPutN designa um valor a um atributo de elemento numérico.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

AttrPutN( Value, DimName, ElName, AttrName, [LangLocaleCode] );

Argumento Descrição

Valor O valor numérico que você deseja designar a umatributo de elemento.

DimName A dimensão-pai do elemento para o qual vocêdeseja designar um valor de atributo.

ElName O elemento para o qual você deseja designar umvalor de atributo.

AttrName O atributo cujo valor você deseja designar.

Capítulo 5. Funções do Turbo Integrator 227

Argumento Descrição

LangLocaleCode Este parâmetro opcional especifica o código docódigo de idioma ao qual o NumericValue se aplica.

Os valores válidos do LangLocaleCodecorrespondem aos códigos de idiomainternacionais da ISO 639-1 listados na dimensãodo controle }Culturas.

Quando o LangLocaleCode não for especificado oufor emitido, o valor do atributo de base éatualizado.

Exemplo

Este exemplo designa o valor 2257993 ao atributo ProdCode de Sedã Série S 1.8L na dimensão doModelo.

AttrPutN(2257993, 'Model', ' S Series 1.8L Sedan ', 'ProdCode');

AttrPutSAttrPutS designa um valor a um atributo de elemento de sequência.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

AttrPutS(Value, DimName, ElName, AttrName, [LangLocaleCode] );

Argumento Descrição

Valor O valor que você deseja designar a um atributo deelemento.

DimName A dimensão-pai do elemento para o qual vocêdeseja designar um valor de atributo.

ElName O elemento para o qual você deseja designar umvalor de atributo.

AttrName O atributo cujo valor você deseja designar.

LangLocaleCode Este parâmetro opcional especifica o código docódigo de idioma ao qual o Valor se aplica.

Valores válidos LangLocaleCode correspondem acódigos de idioma internacionais listados nadimensão do controle }Cultures.

Quando o LangLocaleCode não for especificado oufor emitido, o valor do atributo de base éatualizado.

228 IBM Planning Analytics: Referência do TM1

Exemplo

Este exemplo designa a sequência Bege ao atributo InteriorColor da Sedã Série S 1.8L na dimensão doModelo.

AttrPutS('Beige', 'Model', 'S Series 1.8L Sedan', 'InteriorColor');

ChoreAttrDeleteO ChoreAttrDelete exclui um atributo de tarefa de organização de processos do banco de dados do TM1.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ChoreAttrDelete(AttrName);

Argumento Descrição

AttrName O nome do atributo de tarefa de organização deprocessos que deseja excluir.

Exemplo

Esse exemplo exclui o atributo de Descrição para tarefas de organização de processos em seu servidorTM1.

ChoreAttrDelete('Description');

ChoreAttrInsertO ChoreAttrInsert cria um novo atributo para tarefas de organização de processos em seu servidor TM1. Afunção pode criar um atributo de sequência, numérico ou de alias.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Atenção: Ao atualizar uma tarefa de organização de processos existente, é preciso primeiroexcluir o atributo existente usando a função ChoreAttrDelete. Em seguida, será possível usarChoreAttrInsert para recriar o atributo com suas mudanças desejadas.

Importante: Se você tentar atualizar um atributo existente sem primeiro excluí-lo, a inserção falhará semum aviso ou erro. O atributo existente permanece não alterado; ele não será nem atualizado e nemsobrescrito.

Sintaxe

ChoreAttrInsert( PrevAttrName, NewAttrName, AttrType);

Argumento Descrição

PrevAttrName O atributo que precede o atributo que está sendocriado. Se não houver nenhum atributo anterior ouse desejar que o novo atributo seja o primeiroatributo para tarefas de organização de processos,deixe esse argumento vazio.

NewAttrName O nome que deseja designar ao novo atributo detarefa de organização de processos.

Capítulo 5. Funções do Turbo Integrator 229

Argumento Descrição

AttrType O tipo de atributo. Existem três possíveis valorespara o argumento AttrType:

• N - Cria um atributo numérico.• S - Cria um atributo de sequência.• A - Cria um atributo de alias.

Exemplo

Esse exemplo cria o atributo de sequência de Descrição para tarefa de organização de processos. Esteatributo é inserido após o atributo Owner.

ChoreAttrInsert('Owner', 'Description', 'S');

ChoreAttrNChoreAttrN retorna um atributo numérico para uma tarefa de organização de processos especificada.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ChoreAttrN(ChoreName, AttrName);

Argumento Descrição

ChoreName Um nome de tarefa de organização de processosválido.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda tarefa de organização de processos.

Exemplo

Nesse exemplo, a função retorna o valor numérico do atributo Division_Code da tarefa de organização deprocessos Importação.

ChoreAttrN('Import', 'Division_Code');

ChoreAttrNLChoreAttrNL retorna o valor numérico de um atributo para uma tarefa de organização de processosespecificada com relação a um código de idioma fornecido.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ChoreAttrNL(ChoreName, AttrName, [LangLocaleCode]);

Argumento Descrição

ChoreName Um nome de tarefa de organização de processosválido.

230 IBM Planning Analytics: Referência do TM1

Argumento Descrição

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda tarefa de organização de processos.

LangLocaleCode Este parâmetro opcional especifica o código deidioma para o qual deseja retornar um valor.

Valores válidos LangLocaleCode correspondem acódigos de idioma internacionais listados nadimensão do controle }Cultures.

Quando o LangLocaleCode não é especificado ouestá omitido, o código de idioma atual do usuário éusado como o argumento LangLocaleCode.

Se um valor de atributo não existir para oLangLocaleCode, o valor para um LangLocaleCodepai associado será retornado. Se um valor deatributo não existir para um LangLocaleCode paiassociado, o valor de atributo base será retornado.

Por exemplo, se LangLocaleCode for fr-CA, afunção retornará o valor de atributo para o códigode idioma fr-CA (Francês-Canadá), casodisponível. Se o valor de atributo para fr-CA nãoestiver disponível, a função tentará retornar o valorde atributo para o código de idioma pai fr(Francês). Se o valor de atributo para fr nãoestiver disponível, o valor de atributo de base seráretornado

Exemplo

Nesse exemplo, a função retorna o valor numérico do atributo Division_Code da tarefa de organização deprocessos Importar para o código de idioma francês.

ChoreAttrNL('Import', 'Division_Code', 'fr');

ChoreAttrPutNChoreAttrPutN designa um valor a um atributo numérico de tarefa de organização de processos.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ChoreAttrPutN(NumericValue, ChoreName, AttrName, [LangLocaleCode] );

Argumento Descrição

NumericValue O valor que você deseja designar a um atributo detarefa de organização de processos.

ChoreName A tarefa de organização de processos para a qualdeseja designar um valor de atributo.

Capítulo 5. Funções do Turbo Integrator 231

Argumento Descrição

AttrName O atributo cujo valor você deseja designar.

LangLocaleCode Este parâmetro opcional especifica o código docódigo de idioma ao qual o NumericValue se aplica.

Os valores válidos do LangLocaleCodecorrespondem aos códigos de idiomainternacionais da ISO 639-1 listados na dimensãodo controle }Culturas.

Quando o LangLocaleCode não for especificado oufor emitido, o valor do atributo de base éatualizado.

Exemplo

Esse exemplo designa o valor 7161994 ao atributo Division_Code da tarefa de organização de processosImportação para o código de idioma Francês.

ChoreAttrPutN(7161994, 'Import', 'Division_Code','fr');

ChoreAttrPutSChoreAttrPutS designa um valor a um atributo de sequência de tarefa de organização de processos.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ChoreAttrPutS(String, ChoreName, AttrName, [LangLocaleCode] );

Argumento Descrição

Sequência A sequência que você deseja designar a umatributo de tarefa de organização de processos.

ChoreName A tarefa de organização de processos para a qualdeseja designar um valor de atributo.

AttrName O atributo cujo valor você deseja designar.

LangLocaleCode Este parâmetro opcional especifica o código docódigo de idioma ao qual o NumericValue se aplica.

Os valores válidos do LangLocaleCodecorrespondem aos códigos de idiomainternacionais da ISO 639-1 listados na dimensãodo controle }Culturas.

Quando o LangLocaleCode não for especificado oufor emitido, o valor do atributo de base éatualizado.

232 IBM Planning Analytics: Referência do TM1

Exemplo

Esse exemplo designa o valor de sequência Ricci para o atributo Owner da tarefa de organização deprocessos Importação para o código de idioma Francês.

ChoreAttrPutS('Ricci', 'Import', 'Owner', 'fr');

ChoreAttrSChoreAttrS retorna um atributo de sequência para uma tarefa de organização de processos especificada.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ChoreAttrS(ChoreName, AttrName);

Argumento Descrição

ChoreName Um nome de tarefa de organização de processosválido.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda tarefa de organização de processos.

Exemplo

Nesse exemplo, a função retorna o valor de sequência do atributo Owner da tarefa de organização deprocessos Exchange_Rate_Updates.

ChoreAttrS('Exchange_Rate_Updates', 'Owner');

ChoreAttrSLO ChoreAttrSL retorna um valor de atributo de sequência para uma tarefa de organização de processosespecificada com relação a um código de idioma fornecido.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ChoreAttrSL(ChoreName, AttrName, [LangLocaleCode]);

Argumento Descrição

ChoreName Um nome de tarefa de organização de processosválido.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda tarefa de organização de processos.

Capítulo 5. Funções do Turbo Integrator 233

Argumento Descrição

LangLocaleCode Este parâmetro opcional especifica o código deidioma para o qual deseja retornar um valor.

Valores válidos LangLocaleCode correspondem acódigos de idioma internacionais listados nadimensão do controle }Cultures.

Quando o LangLocaleCode não é especificado ouestá omitido, o código de idioma atual do usuário éusado como o argumento LangLocaleCode.

Se um valor de atributo não existir para oLangLocaleCode, o valor para um LangLocaleCodepai associado será retornado. Se um valor deatributo não existir para um LangLocaleCode paiassociado, o valor de atributo base será retornado.

Por exemplo, se LangLocaleCode for fr-CA, afunção retornará o valor de atributo para o códigode idioma fr-CA (Francês-Canadá), casodisponível. Se o valor de atributo para fr-CA nãoestiver disponível, a função tentará retornar o valorde atributo para o código de idioma pai fr(Francês). Se o valor de atributo para fr nãoestiver disponível, o valor de atributo de base seráretornado

Exemplo

Nesse exemplo, a função retorna o valor de sequência do atributo Owner da tarefa de organização deprocessos Depreciate_Inventory para o código de idioma francês.

ChoreAttrSL('Depreciate_Inventory', 'Owner', 'fr');

CreateHierarchyByAttributeO CreateHierarchyByAttribute cria uma hierarquia simples de 3 níveis por meio de um único atributo.

A nova hierarquia consiste em um elemento raiz único de alto nível, um nível médio de consolidações querepresentam valores de atributos existentes e um nível inferior de folhas de dimensão que incluem ovalor de atributo associado.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Nota: Esta função cria uma hierarquia por meio do conjunto atual de valores de atributo, mas o sistemanão mantém sincronizados a hierarquia e os dados do atributo automaticamente conforme ele muda. Osmodeladores devem gerar novamente a hierarquia conforme necessário.

Sintaxe

CreateHierarchyByAttribute(DimName, AttrName [, emptyParent [, rootName ] ] );

Argumento Descrição

DimName O nome da dimensão que contém o atributo. Umahierarquia de mesmo nome que a dimensão serácriada.

234 IBM Planning Analytics: Referência do TM1

Argumento Descrição

AttrName O nome do atributo por meio do qual criar ahierarquia.

emptyParent Especifica o nome de uma consolidação a sercriada, que coleta folhas de dimensão que não têmum valor de atributo. Se transmitida como umasequência vazia, a função não criará umaconsolidação.

rootName Substitui o nome do elemento raiz que, por padrão,é nomeado após o atributo.

Exemplo

CreateHierarchyByAttribute ('Country', 'City');

Esse exemplo cria uma hierarquia por meio do atributo Cidade na dimensão País.

CubeAttrDeleteO CubeAttrDelete exclui um atributo de cubo do banco de dados do TM1.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeAttrDelete(AttrName);

Argumento Descrição

AttrName O nome do atributo de cubo que você desejaexcluir.

Exemplo

Este exemplo exclui o atributo Description para os cubos de seu servidor do TM1.

CubeAttrDelete('Description');

CubeAttrInsertO CubeAttrInsert cria um novo atributo para os cubos em seu servidor do TM1. A função pode criar umatributo de sequência, numérico ou de alias.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Atenção: Se você atualizar um atributo de cubo existente, deve primeiro excluir o atributoexistente usando a função CubeAttrDelete. É possível, então, usar CubeAttrInsert para recriar oatributo com suas mudanças desejadas.

Importante: Se você tentar atualizar um atributo existente sem primeiro excluí-lo, a inserção falhará semum aviso ou erro. O atributo existente permanece não alterado; ele não será nem atualizado e nemsobrescrito.

Capítulo 5. Funções do Turbo Integrator 235

Sintaxe

CubeAttrInsert( PrevAttrName, NewAttrName, AttrType);

Argumento Descrição

PrevAttrName O atributo que precede o atributo que está sendocriado. Se não houver nenhum atributo anterior ouse você desejar que o novo atributo seja o primeiroatributo dos cubos, deixe este argumento vazio.

NewAttrName O nome que você deseja designar ao novo atributode cubo.

AttrType O tipo de atributo. Existem três possíveis valorespara o argumento AttrType:

• N - Cria um atributo numérico.• S - Cria um atributo de sequência.• A - Cria um atributo de alias.

Exemplo

Este exemplo cria o atributo de sequência Descrição para os cubos. Este atributo é inserido após oatributo Owner.

CubeAttrInsert('Owner', 'Description', 'S');

CubeAttrPutNO CubeAttrPutN designa um valor a um atributo de cubo numérico.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeAttrPutN(NumericValue, CubeName, AttrName, [LangLocaleCode] );

Argumento Descrição

NumericValue O valor que você deseja designar a um atributo decubo.

CubeName O cubo para o qual você deseja designar um valorde atributo.

AttrName O atributo cujo valor você deseja designar.

236 IBM Planning Analytics: Referência do TM1

Argumento Descrição

LangLocaleCode Este parâmetro opcional especifica o código docódigo de idioma ao qual o NumericValue se aplica.

Os valores válidos do LangLocaleCodecorrespondem aos códigos de idiomainternacionais da ISO 639-1 listados na dimensãodo controle }Culturas.

Quando o LangLocaleCode não for especificado oufor emitido, o valor do atributo de base éatualizado.

Exemplo

Este exemplo designa o valor 07161994 aos atributos do AccountingCode do cubo Vendas para o códigode idioma Francês.

CubeAttrPutN(07161994, 'Sales', 'AccountingCode','fr');

CubeAttrPutSO CubeAttrPutS designa um valor para um atributo de cubo de sequência.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeAttrPutS(String, CubeName, AttrName, [LangLocaleCode] );

Argumento Descrição

Sequência A sequência que você deseja designar a umatributo de cubo.

CubeName O cubo para o qual você deseja designar um valorde atributo.

AttrName O atributo cujo valor você deseja designar.

LangLocaleCode Este parâmetro opcional especifica o código docódigo de idioma ao qual o NumericValue se aplica.

Os valores válidos do LangLocaleCodecorrespondem aos códigos de idiomainternacionais da ISO 639-1 listados na dimensãodo controle }Culturas.

Quando o LangLocaleCode não for especificado oufor emitido, o valor do atributo de base éatualizado.

Capítulo 5. Funções do Turbo Integrator 237

Exemplo

Este exemplo designa o valor da sequência Protótipo ao atributo Descrição do cubo Vendas para o códigode idioma Francês.

CubeAttrPutS('Prototype', 'Sales', 'Description','fr');

CubeATTRNLCubeATTRNL retorna um valor de atributo numérico para um cubo especificado a respeito de um códigode idioma fornecido.

Esta função é válida em processos TM1 TurboIntegrator.

Sintaxe

CubeATTRNL(CubeName, AttrName, [LangLocaleCode]);

Argumento Descrição

CubeName Um nome de cubo válido.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidodo cubo.

LangLocaleCode Este parâmetro opcional especifica o código deidioma para o qual deseja retornar um valor.

Valores válidos LangLocaleCode correspondem acódigos de idioma internacionais listados nadimensão do controle }Cultures.

Quando o LangLocaleCode não é especificado ouestá omitido, o código de idioma atual do usuário éusado como o argumento LangLocaleCode.

Se um valor de atributo não existir para oLangLocaleCode, o valor para um LangLocaleCodepai associado será retornado. Se um valor deatributo não existir para um LangLocaleCode paiassociado, o valor de atributo base será retornado.

Por exemplo, se LangLocaleCode for fr-CA, afunção retornará o valor de atributo para o códigode idioma fr-CA (Francês-Canadá), casodisponível. Se o valor de atributo para fr-CA nãoestiver disponível, a função tentará retornar o valorde atributo para o código de idioma pai fr(Francês). Se o valor de atributo para fr nãoestiver disponível, o valor de atributo de base seráretornado

Exemplo

Neste exemplo, a função retorna o valor numérico do atributo Accounting_Code do cubo Produto para ocódigo de idioma Francês.

CubeATTRNL('Product', 'Accounting_Code', 'fr');

238 IBM Planning Analytics: Referência do TM1

CubeATTRSLCubeATTRSL retorna um valor de atributo de sequência para um cubo especificado a respeito de umcódigo de idioma fornecido.

Esta função é válida em processos TM1 TurboIntegrator.

Sintaxe

CubeATTRSL(CubeName, AttrName, [LangLocaleCode]);

Argumento Descrição

CubeName Um nome de cubo válido.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidodo cubo.

LangLocaleCode Este parâmetro opcional especifica o código deidioma para o qual deseja retornar um valor.

Valores válidos LangLocaleCode correspondem acódigos de idioma internacionais listados nadimensão do controle }Cultures.

Quando o LangLocaleCode não é especificado ouestá omitido, o código de idioma atual do usuário éusado como o argumento LangLocaleCode.

Se um valor de atributo não existir para oLangLocaleCode, o valor para um LangLocaleCodepai associado será retornado. Se um valor deatributo não existir para um LangLocaleCode paiassociado, o valor de atributo base será retornado.

Por exemplo, se LangLocaleCode for fr-CA, afunção retornará o valor de atributo para o códigode idioma fr-CA (Francês-Canadá), casodisponível. Se o valor de atributo para fr-CA nãoestiver disponível, a função tentará retornar o valorde atributo para o código de idioma pai fr(Francês). Se o valor de atributo para fr nãoestiver disponível, o valor de atributo de base seráretornado

Exemplo

Neste exemplo, a função retorna o valor de sequência do atributo Proprietário do cubo Produto para ocódigo de idioma Francês.

CubeATTRSL('Product', 'Owner', 'fr');

DimensionAttrDeleteO DimensionAttrDelete exclui um atributo de dimensão do banco de dados do TM1.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Capítulo 5. Funções do Turbo Integrator 239

Sintaxe

DimensionAttrDelete(AttrName);

Argumento Descrição

AttrName O nome do atributo de dimensão que você desejaexcluir.

Exemplo

Este exemplo exclui o atributo Description das dimensões de seu servidor do TM1.

DimensionAttrDelete('Description');

DimensionAttrInsertO DimensionAttrInsert cria um novo atributo para dimensões em seu servidor do TM1. A função podecriar um atributo de sequência, numérico ou de alias.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Atenção: Se você atualizar um atributo de dimensão existente, deve primeiro excluir o atributoexistente usando a função DimensionAttrDelete. É possível, então, usar DimensionAttrInsert pararecriar o atributo com suas mudanças desejadas.

Importante: Se você tentar atualizar um atributo existente sem primeiro excluí-lo, a inserção falhará semum aviso ou erro. O atributo existente permanece não alterado; ele não será nem atualizado e nemsobrescrito.

Sintaxe

DimensionAttrInsert( PrevAttrName, NewAttrName, AttrType);

Argumento Descrição

PrevAttrName O atributo que precede o atributo que está sendocriado. Se não houver nenhum atributo anterior ouse você desejar que o novo atributo seja o primeiroatributo das dimensões, deixe este argumentovazio.

NewAttrName O nome que você deseja designar ao novo atributode dimensão.

AttrType O tipo de atributo. Existem três possíveis valorespara o argumento AttrType:

• N - Cria um atributo numérico.• S - Cria um atributo de sequência.• A - Cria um atributo de alias.

240 IBM Planning Analytics: Referência do TM1

Exemplo

Este exemplo cria o atributo de sequência Descrição para as dimensões. Porque não há nenhumparâmetro PrevAttrName, este atributo é inserido como o primeiro atributo para as dimensões do seuservidor TM1.

DimensionAttrInsert('', 'Description', 'S');

DimensionAttrPutNO DimensionAttrPutN designa um valor a um atributo de dimensão numérica.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

DimensionAttrPutN(NumericValue, DimensionName, AttrName, [LocalLangCode] );

Argumento Descrição

NumericValue O valor que você deseja designar a um atributo dedimensão.

DimensionName A dimensão para a qual você deseja designar umvalor de atributo.

AttrName O atributo cujo valor você deseja designar.

LangLocaleCode Este parâmetro opcional especifica o código docódigo de idioma ao qual o NumericValue se aplica.

Os valores válidos do LangLocaleCodecorrespondem aos códigos de idiomainternacionais da ISO 639-1 listados na dimensãodo controle Cultures.

Quando o LangLocaleCode não for especificado oufor emitido, o valor do atributo de base éatualizado.

Exemplo

Este exemplo designa o valor 07161994 aos atributos do AccountingCode da dimensão Modelos para ocódigo de idioma Francês.

DimensionAttrPutN(07161994, 'Models', 'AccountingCode','fr');

DimensionAttrPutSO DimensionAttrPutS designa um valor a um atributo de dimensão da sequência.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

DimensionAttrPutS(String, DimensionName, AttrName, [LangLocaleCode] );

Capítulo 5. Funções do Turbo Integrator 241

Argumento Descrição

Sequência A sequência que você deseja designar a umatributo de dimensão.

DimensionName A dimensão para a qual você deseja designar umvalor de atributo.

AttrName O atributo cujo valor você deseja designar.

LangLocaleCode Este parâmetro opcional especifica o código docódigo de idioma ao qual o NumericValue se aplica.

Os valores válidos do LangLocaleCodecorrespondem aos códigos de idiomainternacionais da ISO 639-1 listados na dimensãodo controle }Culturas.

Quando o LangLocaleCode não for especificado oufor emitido, o valor do atributo de base éatualizado.

Exemplo

Este exemplo designa o valor da sequência Protótipo ao atributo Descrição da dimensão do Modelo parao código de idioma Francês.

DimensionAttrPutS('Prototype', 'Model', 'Description','fr');

DimensionATTRNLDimensionATTRNL retorna um valor de atributo numérico para uma dimensão especificada a respeito deum código de idioma fornecido.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

DimensionATTRNL(DimName, AttrName, [LangLocaleCode]);

Argumento Descrição

DimName Um nome de dimensão válido.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda dimensão.

242 IBM Planning Analytics: Referência do TM1

Argumento Descrição

LangLocaleCode Este parâmetro opcional especifica o código deidioma para o qual deseja retornar um valor.

Valores válidos LangLocaleCode correspondem acódigos de idioma internacionais listados nadimensão do controle }Cultures.

Quando o LangLocaleCode não é especificado ouestá omitido, o código de idioma atual do usuário éusado como o argumento LangLocaleCode.

Se um valor de atributo não existir para oLangLocaleCode, o valor para um LangLocaleCodepai associado será retornado. Se um valor deatributo não existir para um LangLocaleCode paiassociado, o valor de atributo base será retornado.

Por exemplo, se LangLocaleCode for fr-CA, afunção retornará o valor de atributo para o códigode idioma fr-CA (Francês-Canadá), casodisponível. Se o valor de atributo para fr-CA nãoestiver disponível, a função tentará retornar o valorde atributo para o código de idioma pai fr(Francês). Se o valor de atributo para fr nãoestiver disponível, o valor de atributo de base seráretornado

Exemplo

Neste exemplo, a função retornará o valor numérico do atributo Accounting_Code da dimensãoPlan_Business_Unit para o código de idioma Francês.

DimensionATTRNL('Plan_Business_Unit', 'Accounting_Code', 'fr');

DimensionATTRSLDimensionATTRSL retorna um valor de atributo de sequência para uma dimensão especificada a respeitode um código de idioma fornecido.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

DimensionATTRSL(DimName, AttrName, [LangLocaleCode]);

Argumento Descrição

DimName Um nome de dimensão válido.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda dimensão.

Capítulo 5. Funções do Turbo Integrator 243

Argumento Descrição

LangLocaleCode Este parâmetro opcional especifica o código deidioma para o qual deseja retornar um valor.

Valores válidos LangLocaleCode correspondem acódigos de idioma internacionais listados nadimensão do controle }Cultures.

Quando o LangLocaleCode não é especificado ouestá omitido, o código de idioma atual do usuário éusado como o argumento LangLocaleCode.

Se um valor de atributo não existir para oLangLocaleCode, o valor para um LangLocaleCodepai associado será retornado. Se um valor deatributo não existir para um LangLocaleCode paiassociado, o valor de atributo base será retornado.

Por exemplo, se LangLocaleCode for fr-CA, afunção retornará o valor de atributo para o códigode idioma fr-CA (Francês-Canadá), casodisponível. Se o valor de atributo para fr-CA nãoestiver disponível, a função tentará retornar o valorde atributo para o código de idioma pai fr(Francês). Se o valor de atributo para fr nãoestiver disponível, o valor de atributo de base seráretornado

Exemplo

Neste exemplo, a função retorna o valor de sequência do atributo Manager da dimensãoPlan_Business_Unit para o código de idioma Francês.

DimensionATTRSL('Plan_Business_Unit', 'Manager', 'fr');

ElementATTRNLElementATTRNL retorna um atributo numérico para um elemento especificado de uma dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ElementATTRNL(DimName, HierName, ElName, AttrName, [LangLocaleCode]);

Argumento Descrição

DimName Um nome de dimensão válido.

HierName O nome da hierarquia dentro da dimensão.

ElName Um elemento da dimensão.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidodo elemento.

244 IBM Planning Analytics: Referência do TM1

Argumento Descrição

LangLocaleCode Este parâmetro opcional especifica o código deidioma para o qual deseja retornar um valor.

Valores válidos LangLocaleCode correspondem acódigos de idioma internacionais listados nadimensão do controle }Cultures.

Quando o LangLocaleCode não é especificado ouestá omitido, o código de idioma atual do usuário éusado como o argumento LangLocaleCode.

Se um valor de atributo não existir para oLangLocaleCode, o valor para um LangLocaleCodepai associado será retornado. Se um valor deatributo não existir para um LangLocaleCode paiassociado, o valor de atributo base será retornado.

Por exemplo, se LangLocaleCode for fr-CA, afunção retornará o valor de atributo para o códigode idioma fr-CA, caso disponível. Se o valor deatributo para fr-CA não estiver disponível, afunção tentará retornar o valor de atributo para ocódigo de idioma pai fr. Se o valor de atributo parafr não estiver disponível, o valor de atributo debase será retornado

Exemplo

Neste exemplo, a função retorna o valor numérico do atributo Tamanho de Motor do elemento Sedan LSeries 1.8L na dimensão Modelo para o código de idioma Francês. Este exemplo se aplica à hierarquia2015.

ATTRNL('Model', '2015', 'L Series 1.8L Sedan', 'Engine Size', 'fr');

ElementATTRSLElementATTRSL retorna um atributo de sequência para um elemento especificado de uma dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ElementATTRSL(DimName, HierName, ElName, AttrName, [LangLocaleCode]);

Argumento Descrição

DimName Um nome de dimensão válido.

HierName O nome da hierarquia dentro da dimensão.

ElName Um elemento da dimensão.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidodo elemento.

Capítulo 5. Funções do Turbo Integrator 245

Argumento Descrição

LangLocaleCode Este parâmetro opcional especifica o código deidioma para o qual deseja retornar um valor.

Valores válidos LangLocaleCode correspondem acódigos de idioma internacionais listados nadimensão do controle }Cultures.

Quando o LangLocaleCode não é especificado ouestá omitido, o código de idioma atual do usuário éusado como o argumento LangLocaleCode.

Se um valor de atributo não existir para oLangLocaleCode, o valor para um LangLocaleCodepai associado será retornado. Se um valor deatributo não existir para um LangLocaleCode paiassociado, o valor de atributo base será retornado.

Por exemplo, se LangLocaleCode for fr-CA, afunção retornará o valor de atributo para o códigode idioma fr-CA, caso disponível. Se o valor deatributo para fr-CA não estiver disponível, afunção tentará retornar o valor de atributo para ocódigo de idioma pai fr. Se o valor de atributo parafr não estiver disponível, o valor de atributo debase será retornado

Exemplo

Neste exemplo, a função retorna o valor de sequência do atributo Moeda do elemento 10100 nadimensão Plan_Business_Unit para o código de idioma Francês.

ElementATTRSL('Plan_Business_Unit', '10100', 'Currency', 'fr');

ElementAttrPutNElementAttrPutN designa um valor a um atributo de elemento numérico.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ElementAttrPutN( Value, DimName, HierName, ElName, AttrName, [LangLocaleCode] );

Argumento Descrição

Valor O valor numérico que você deseja designar a umatributo de elemento.

DimName A dimensão-pai do elemento para o qual vocêdeseja designar um valor de atributo.

HierName O nome da hierarquia dentro da dimensão.

ElName O elemento para o qual você deseja designar umvalor de atributo.

246 IBM Planning Analytics: Referência do TM1

Argumento Descrição

AttrName O atributo cujo valor você deseja designar.

LangLocaleCode Este parâmetro opcional especifica o código docódigo de idioma ao qual o NumericValue se aplica.

Os valores válidos do LangLocaleCodecorrespondem aos códigos de idiomainternacionais da ISO 639-1 listados na dimensãodo controle Cultures.

Quando o LangLocaleCode não for especificado oufor emitido, o valor do atributo de base éatualizado.

Exemplo

Este exemplo designa o valor 2257993 para o atributo ProdCode de S Series S 1.8L Sedan na hierarquiaAutomobile da dimensão Model.

ElementAttrPutN(2257993, 'Model', 'Automobile', ' S Series 1.8L Sedan ','ProdCode');

ElementAttrPutSElementAttrPutS designa um valor a um atributo de elemento de sequência.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ElementAttrPutS(Value, DimName, HierName, ElName, AttrName, [LangLocaleCode] );

Argumento Descrição

Valor O valor que você deseja designar a um atributo deelemento.

DimName A dimensão-pai do elemento para o qual vocêdeseja designar um valor de atributo.

HierName O nome da hierarquia dentro da dimensão.

ElName O elemento para o qual você deseja designar umvalor de atributo.

AttrName O atributo cujo valor você deseja designar.

Capítulo 5. Funções do Turbo Integrator 247

Argumento Descrição

LangLocaleCode Este parâmetro opcional especifica o código docódigo de idioma ao qual o Valor se aplica.

Os valores válidos do LangLocaleCodecorrespondem aos códigos de idiomainternacionais listados na dimensão do controleCultures.

Quando o LangLocaleCode não for especificado oufor emitido, o valor do atributo de base éatualizado.

Exemplo

Este exemplo designa a sequência Beige ao atributo InteriorColor de S Series 1.8L Sedan na hierarquiaAutomobile da dimensão Model.

ElementAttrPutS('Beige', 'Model', 'Automobile', 'S Series 1.8L Sedan', 'InteriorColor');

ElementAttrInsertElementAttrInsert cria um novo atributo de elemento para uma dimensão. A função pode criar umatributo de sequência, numérico ou de alias.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ElementAttrInsert(DimName, HierName, PrevAttr, AttrName, Type);

Argumento Descrição

DimName A dimensão para a qual você deseja criar umatributo de elemento.

HierName O nome da hierarquia dentro da dimensão.

PrevAttr O atributo que precede o atributo que está sendocriado.

AttrName O nome que você deseja designar ao novo atributo.

Tipo O tipo de atributo. Existem três possíveis valorespara o argumento Type:

• N - Cria um atributo numérico.• S - Cria um atributo de sequência.• A - Cria um atributo de alias.

Exemplo

Este exemplo cria o atributo de sequência InteriorColor na hierarquia Automobile na dimensão Model.Este atributo é inserido após o atributo Transmission.

ElementAttrInsert('Model', 'Automobile', 'Transmission', 'InteriorColor','S');

248 IBM Planning Analytics: Referência do TM1

ElementAttrDeleteElementAttrDelete exclui um atributo de elemento do banco de dados TM1.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ElementAttrDelete(DimName, HierName, AttrName);

Argumento Descrição

DimName A dimensão para a qual você deseja excluir umatributo de elemento.

HierName O nome da hierarquia dentro da dimensão.

AttrName O nome do atributo que você deseja excluir.

Exemplo

Este exemplo exclui o atributo de elemento InteriorColor da hierarquia Automobile na dimensão Model.

ElementAttrDelete('Model', 'Automobile', 'InteriorColor');

HierarchyAttrPutNO HierarchyAttrPutN designa um valor a um atributo numérico em uma hierarquia especificada em umadimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchyAttrPutN(NumericValue, DimensionName, HierName, AttrName, [LocalLangCode] );

Argumento Descrição

NumericValue O valor que você deseja designar a um atributo dedimensão.

DimensionName A dimensão para a qual você deseja designar umvalor de atributo.

HierName O nome da hierarquia dentro da dimensão.

AttrName O atributo cujo valor você deseja designar.

Capítulo 5. Funções do Turbo Integrator 249

Argumento Descrição

LangLocaleCode Este parâmetro opcional especifica o código docódigo de idioma ao qual o NumericValue se aplica.

Os valores válidos do LangLocaleCodecorrespondem aos códigos de idiomainternacionais da ISO 639-1 listados na dimensãodo controle Cultures.

Quando o LangLocaleCode não for especificado oufor emitido, o valor do atributo de base éatualizado.

Exemplo

Este exemplo designa o valor 07161994 aos atributos do AccountingCode da dimensão Modelos para ocódigo de idioma Francês. Essa mudança é aplicada na hierarquia Receivables na dimensão Models.

HierarchyAttrPutN(07161994, 'Models', 'Receivables', 'AccountingCode','fr');

HierarchyAttrPutSO HierarchyAttrPutS designa um valor a um atributo de sequência em uma hierarquia especificada emuma dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchyAttrPutS(String, DimensionName, HierName, AttrName, [LangLocaleCode] );

Argumento Descrição

Sequência A sequência que você deseja designar a umatributo de dimensão.

DimensionName A dimensão para a qual você deseja designar umvalor de atributo.

HierName O nome da hierarquia dentro da dimensão.

AttrName O atributo cujo valor você deseja designar.

LangLocaleCode Este parâmetro opcional especifica o código docódigo de idioma ao qual o NumericValue se aplica.

Os valores válidos do LangLocaleCodecorrespondem aos códigos de idiomainternacionais da ISO 639-1 listados na dimensãodo controle }Culturas.

Quando o LangLocaleCode não for especificado oufor emitido, o valor do atributo de base éatualizado.

250 IBM Planning Analytics: Referência do TM1

Exemplo

Este exemplo designa o valor da sequência Protótipo ao atributo Descrição da dimensão do Modelo parao código de idioma Francês. Essa mudança é aplicada na hierarquia Receiveables na dimensão Model.

HierarchyAttrPutS('Prototype', 'Model', 'Receivables', 'Description','fr');

HierarchyATTRNO HierarchyATTRN retorna um atributo numérico para uma hierarquia especificada em uma dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchyATTRN(DimName, HierName, AttrName);

Argumento Descrição

DimName Um nome de dimensão válido.

HierName O nome da hierarquia dentro da dimensão.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda dimensão.

Exemplo

Neste exemplo, a função retorna o valor numérico do atributo Accounting_Code da dimensãoPlan_Business_Unit. Este exemplo se aplica à hierarquia Equipment.

HierarchyATTRN('Plan_Business_Unit', 'Equipment', 'Accounting_Code');

HierarchyATTRSO HierarchyATTRS retorna um atributo de sequência para uma hierarquia especificada em umadimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchyATTRS(DimName, AttrName);

Argumento Descrição

DimName Um nome de dimensão válido.

HierName O nome da hierarquia dentro da dimensão.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda dimensão.

Capítulo 5. Funções do Turbo Integrator 251

Exemplo

Neste exemplo, a função retorna o valor de sequência do atributo Manager da dimensãoPlan_Business_Unit. Este exemplo se aplica à hierarquia Equipment.

HierarchyATTRS('Plan_Business_Unit', 'Equipment', 'Manager');

HierarchyATTRNLO HierarchyATTRNL retorna um valor de atributo numérico para uma hierarquia especificada em umadimensão com relação a um código de idioma fornecido.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchyATTRNL(DimName, HierName, AttrName, [LangLocaleCode]);

Argumento Descrição

DimName Um nome de dimensão válido.

HierName O nome da hierarquia dentro da dimensão.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda dimensão.

LangLocaleCode Este parâmetro opcional especifica o código deidioma para o qual deseja retornar um valor.

Valores válidos LangLocaleCode correspondem acódigos de idioma internacionais listados nadimensão do controle }Cultures.

Quando o LangLocaleCode não é especificado ouestá omitido, o código de idioma atual do usuário éusado como o argumento LangLocaleCode.

Se um valor de atributo não existir para oLangLocaleCode, o valor para um LangLocaleCodepai associado será retornado. Se um valor deatributo não existir para um LangLocaleCode paiassociado, o valor de atributo base será retornado.

Por exemplo, se LangLocaleCode for fr-CA, afunção retornará o valor de atributo para o códigode idioma fr-CA (Francês-Canadá), casodisponível. Se o valor de atributo para fr-CA nãoestiver disponível, a função tentará retornar o valorde atributo para o código de idioma pai fr(Francês). Se o valor de atributo para fr nãoestiver disponível, o valor de atributo de base seráretornado

252 IBM Planning Analytics: Referência do TM1

Exemplo

Neste exemplo, a função retornará o valor numérico do atributo Accounting_Code da dimensãoPlan_Business_Unit para o código de idioma Francês. Essa função se aplica à hierarquia Equipment.

HierarchyATTRNL('Plan_Business_Unit', 'Equipment', 'Accounting_Code', 'fr');

HierarchyATTRSLO HierarchyATTRSL retorna um valor de atributo de sequência para uma hierarquia especificada em umadimensão com relação a um código de idioma fornecido.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchyATTRSL(DimName, HierName, AttrName, [LangLocaleCode]);

Argumento Descrição

DimName Um nome de dimensão válido.

HierName O nome da hierarquia dentro da dimensão.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda dimensão.

LangLocaleCode Este parâmetro opcional especifica o código deidioma para o qual deseja retornar um valor.

Valores válidos LangLocaleCode correspondem acódigos de idioma internacionais listados nadimensão do controle }Cultures.

Quando o LangLocaleCode não é especificado ouestá omitido, o código de idioma atual do usuário éusado como o argumento LangLocaleCode.

Se um valor de atributo não existir para oLangLocaleCode, o valor para um LangLocaleCodepai associado será retornado. Se um valor deatributo não existir para um LangLocaleCode paiassociado, o valor de atributo base será retornado.

Por exemplo, se LangLocaleCode for fr-CA, afunção retornará o valor de atributo para o códigode idioma fr-CA (Francês-Canadá), casodisponível. Se o valor de atributo para fr-CA nãoestiver disponível, a função tentará retornar o valorde atributo para o código de idioma pai fr(Francês). Se o valor de atributo para fr nãoestiver disponível, o valor de atributo de base seráretornado

Capítulo 5. Funções do Turbo Integrator 253

Exemplo

Neste exemplo, a função retorna o valor de sequência do atributo Manager da dimensãoPlan_Business_Unit para o código de idioma Francês. Essa função se aplica à hierarquia Equipment.

HierarchyATTRSL('Plan_Business_Unit', 'Equipment', 'Manager', 'fr');

HierarchySubsetATTRSO HierarchySubsetATTRS retorna um atributo de sequência para um subconjunto especificado eassociado a uma hierarquia em uma dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchySubsetATTRS(DimName, HierName, SubName, AttrName);

Argumento Descrição

DimName Um nome de dimensão válido.

HierName O nome de uma hierarquia em uma dimensão.

SubName O nome de um subconjunto em uma dimensão.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda dimensão.

Exemplo

Neste exemplo, a função retorna o valor de sequência do atributo Manager do subconjunto Sales dahierarquia Europe na dimensão Plan_Business_Unit.

HierarchySubsetATTRS('Plan_Business_Unit', 'Europe', 'Sales', 'Manager');

HierarchySubsetATTRNO HierarchySubsetATTRN retorna um atributo numérico para um subconjunto especificado e associado auma hierarquia em uma dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchySubsetATTRN(DimName, HierName, SubName, AttrName);

Argumento Descrição

DimName Um nome de dimensão válido.

HierName O nome de uma hierarquia em uma dimensão.

SubName O nome de um subconjunto em uma dimensão.

254 IBM Planning Analytics: Referência do TM1

Argumento Descrição

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda dimensão.

Exemplo

Neste exemplo, a função retorna o valor numérico do atributo Accounting_Code do subconjunto Sales dahierarquia Europe na dimensão Plan_Business_Unit.

HierarchySubsetATTRN('Plan_Business_Unit', 'Europe', 'Sales', 'Accounting_Code');

HierarchySubsetATTRSLO HierarchySubsetATTRSL retorna o valor de sequência de um atributo para um subconjunto (e umcódigo de idioma) especificado e associado a uma hierarquia em uma dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchySubsetATTRSL(DimName, HierName, SubName, AttrName, [LangLocaleCode]);

Argumento Descrição

DimName Um nome de dimensão válido.

HierName O nome de uma hierarquia em uma dimensão.

SubName O nome de um subconjunto em uma dimensão.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda dimensão.

Capítulo 5. Funções do Turbo Integrator 255

Argumento Descrição

LangLocaleCode Este parâmetro opcional especifica o código deidioma para o qual deseja retornar um valor.

Valores válidos LangLocaleCode correspondem acódigos de idioma internacionais listados nadimensão do controle }Cultures.

Quando o LangLocaleCode não é especificado ouestá omitido, o código de idioma atual do usuário éusado como o argumento LangLocaleCode.

Se um valor de atributo não existir para oLangLocaleCode, o valor para um LangLocaleCodepai associado será retornado. Se um valor deatributo não existir para um LangLocaleCode paiassociado, o valor de atributo base será retornado.

Por exemplo, se LangLocaleCode for fr-CA, afunção retornará o valor de atributo para o códigode idioma fr-CA (Francês-Canadá), casodisponível. Se o valor de atributo para fr-CA nãoestiver disponível, a função tentará retornar o valorde atributo para o código de idioma pai fr(Francês). Se o valor de atributo para fr nãoestiver disponível, o valor de atributo de base seráretornado

Exemplo

Neste exemplo, a função retorna o valor de sequência do atributo Manager do subconjunto Sales (dahierarquia Europe) para o código de idioma French.

HierarchySubsetATTRSL('Plan_Business_Unit', 'Europe', 'Sales', 'Manager', 'fr');

HierarchySubsetATTRNLO HierarchySubsetATTRNL retorna o valor numérico de um atributo para um subconjunto (e um código deidioma) especificado e associado a uma hierarquia em uma dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchySubsetATTRNL(DimName, HierName, SubName, AttrName, [LangLocaleCode]);

Argumento Descrição

DimName Um nome de dimensão válido.

HierName O nome de uma hierarquia em uma dimensão.

SubName O nome de um subconjunto em uma dimensão.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda dimensão.

256 IBM Planning Analytics: Referência do TM1

Argumento Descrição

LangLocaleCode Este parâmetro opcional especifica o código deidioma para o qual deseja retornar um valor.

Valores válidos LangLocaleCode correspondem acódigos de idioma internacionais listados nadimensão do controle }Cultures.

Quando o LangLocaleCode não é especificado ouestá omitido, o código de idioma atual do usuário éusado como o argumento LangLocaleCode.

Se um valor de atributo não existir para oLangLocaleCode, o valor para um LangLocaleCodepai associado será retornado. Se um valor deatributo não existir para um LangLocaleCode paiassociado, o valor de atributo base será retornado.

Por exemplo, se LangLocaleCode for fr-CA, afunção retornará o valor de atributo para o códigode idioma fr-CA (Francês-Canadá), casodisponível. Se o valor de atributo para fr-CA nãoestiver disponível, a função tentará retornar o valorde atributo para o código de idioma pai fr(Francês). Se o valor de atributo para fr nãoestiver disponível, o valor de atributo de base seráretornado

Exemplo

Neste exemplo, a função retorna o valor numérico do atributo Accounting_Code do subconjunto Sales (dahierarquia Europe) para o código de idioma French.

HierarchySubsetATTRNL('Plan_Business_Unit', 'Europe', 'Sales', 'Accounting_Code', 'fr');

HierarchySubsetAttrPutSO HierarchySubsetAttrPutS designa um valor de sequência a um atributo para um subconjuntoespecificado e associado a uma hierarquia em uma dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchySubsetAttrPutS(String, DimName, HierName, SubName, AttrName, [LangLocaleCode] );

Argumento Descrição

Sequência A sequência que você deseja designar a umatributo de dimensão.

DimName A dimensão para a qual você deseja designar umvalor de atributo.

HierName O nome de uma hierarquia em uma dimensão.

SubName O nome de um subconjunto em uma dimensão.

Capítulo 5. Funções do Turbo Integrator 257

Argumento Descrição

AttrName O atributo cujo valor você deseja designar.

LangLocaleCode Este parâmetro opcional especifica o código docódigo de idioma ao qual o NumericValue se aplica.

Os valores válidos do LangLocaleCodecorrespondem aos códigos de idiomainternacionais da ISO 639-1 listados na dimensãodo controle }Culturas.

Quando o LangLocaleCode não for especificado oufor emitido, o valor do atributo de base éatualizado.

Exemplo

Este exemplo designa o valor da sequência Prototype ao atributo Description do subconjunto Z (dahierarquia 2016 na dimensão Model) para o código de idioma do idioma francês.

HierarchySubsetAttrPutS('Prototype', 'Model', '2016', 'Z', 'Description','fr');

HierarchySubsetAttrPutNO HierarchySubsetAttrPutN designa um valor numérico a um atributo para um subconjunto especificado eassociado a uma hierarquia em uma dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchySubsetAttrPutN(NumericValue, DimName, HierName, SubName, AttrName, [LocalLangCode] );

Argumento Descrição

NumericValue O valor que você deseja designar a um atributo dedimensão.

DimName A dimensão para a qual você deseja designar umvalor de atributo.

HierName O nome de uma hierarquia em uma dimensão.

SubName O nome de um subconjunto em uma dimensão.

AttrName O atributo cujo valor você deseja designar.

258 IBM Planning Analytics: Referência do TM1

Argumento Descrição

LangLocaleCode Este parâmetro opcional especifica o código docódigo de idioma ao qual o NumericValue se aplica.

Os valores válidos do LangLocaleCodecorrespondem aos códigos de idiomainternacionais da ISO 639-1 listados na dimensãodo controle Cultures.

Quando o LangLocaleCode não for especificado oufor emitido, o valor do atributo de base éatualizado.

Exemplo

Este exemplo designa o valor 07161994 ao atributo AccountingCode do subconjunto Z (da hierarquia2016 na dimensão Models) para o código de idioma do idioma French.

HierarchySubsetAttrPutN(07161994, 'Models', '2016', 'Z', 'AccountingCode','fr');

HierarchySubsetAttrInsertHierarchySubsetAttrInsert cria um novo atributo para subconjuntos em seu servidor TM1. A função criaum atributo de sequência, numérico ou de alias.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

Atenção: Se você atualizar um atributo de subconjunto existente, deverá primeiro excluir oatributo existente usando a função HierarchySubsetAttrDelete. É possível, então, usarHierarchySubsetAttrInsert para recriar o atributo com suas mudanças desejadas.

Importante: Se você tentar atualizar um atributo existente sem primeiro excluí-lo, a inserção falhará semum aviso ou erro. O atributo existente permanece não alterado; ele não será nem atualizado e nemsobrescrito.

HierarchySubsetAttrInsert( Dimension, Hierarchy, PrevAttrName, NewAttrName, AttrType);

Argumento Descrição

Dimensão O nome da dimensão cujos subconjuntos estãosendo atualizados.

Hierarquia O nome de uma hierarquia em uma dimensão.

PrevAttrName O atributo que precede o atributo que está sendocriado. Se não houver nenhum atributo anterior ouse desejar que o novo atributo seja o primeiroatributo para subconjuntos, deixe este argumentovazio.

NewAttrName O nome que você deseja designar ao novo atributode subconjunto.

Capítulo 5. Funções do Turbo Integrator 259

Argumento Descrição

AttrType O tipo de atributo. Existem três possíveis valorespara o argumento AttrType:

• N - Cria um atributo numérico.• S - Cria um atributo de sequência.• A - Cria um atributo de alias.

Exemplo

Este exemplo cria o atributo de sequência Description para os subconjuntos na hierarquia Z da dimensãoModel. Como não há nenhum parâmetro PrevAttrName, este atributo é inserido como o primeiro atributopara subconjuntos em seu servidor TM1.

HierarchySubsetAttrInsert('Model', 'Z', '', 'Description', 'S');

HierarchySubsetAttrDeleteHierarchySubsetAttrDelete exclui um atributo de subconjunto do banco de dados do TM1.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchySubsetAttrDelete(Dimension, Hierarchy, AttrName);

Argumento Descrição

Dimensão O nome da dimensão cujo atributo de subconjuntoestá sendo excluído.

Hierarquia O nome de uma hierarquia em uma dimensão.

AttrName O nome do atributo de dimensão que você desejaexcluir.

Exemplo

Este exemplo exclui o atributo Description para subconjuntos da hierarquia Z na dimensão Model.

HierarchySubsetAttrDelete('Model', 'Z, 'Description');

ProcessAttrDeleteProcessAttrDelete exclui um atributo de processo do banco de dados do TM1.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ProcessAttrDelete(AttrName);

260 IBM Planning Analytics: Referência do TM1

Argumento Descrição

AttrName O nome do atributo de processo que você desejaexcluir.

Exemplo

Este exemplo exclui o atributo de descrição para processos em seu servidor TM1.

ProcessAttrDelete('Description');

ProcessAttrInsertO ProcessAttrInsert cria um novo atributo para processos em seu servidor TM1. A função pode criar umatributo de sequência, numérico ou de alias.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Atenção: Se você atualizar um atributo de processo existente, você deverá primeiro excluir oatributo existente usando a função ProcessAttrDelete. É possível, então, usar ProcessAttrInsertpara recriar o atributo com suas mudanças desejadas.

Importante: Se você tentar atualizar um atributo existente sem primeiro excluí-lo, a inserção falhará semum aviso ou erro. O atributo existente permanece não alterado; ele não será nem atualizado e nemsobrescrito.

Sintaxe

ProcessAttrInsert( PrevAttrName, NewAttrName, AttrType);

Argumento Descrição

PrevAttrName O atributo que precede o atributo que está sendocriado. Se não houver nenhum atributo anterior ouse desejar que o novo atributo seja o primeiroatributo para processos, deixe este argumentovazio.

NewAttrName O nome que você deseja designar ao novo atributode processo.

AttrType O tipo de atributo. Existem três possíveis valorespara o argumento AttrType:

• N - Cria um atributo numérico.• S - Cria um atributo de sequência.• A - Cria um atributo de alias.

Exemplo

Esse exemplo cria o atributo de sequência de descrição para processos. Este atributo é inserido após oatributo Owner.

ProcessAttrInsert('Owner', 'Description', 'S');

ProcessAttrNProcessAttrN retorna um atributo numérico para um processo especificado.

Capítulo 5. Funções do Turbo Integrator 261

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ProcessAttrN(ProcessName, AttrName);

Argumento Descrição

ProcessName Um nome de processo válido.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidodo processo.

Exemplo

Nesse exemplo, a função retorna o valor numérico do atributo Store_Code do processo Daily_Sales.

ProcessAttrN('Daily_Sales', 'Store_Code');

ProcessAttrNLProcessAttrNL retorna um valor numérico de um atributo para um processo especificado com relação aum código de idioma fornecido.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ProcessAttrNL(ProcessName, AttrName, [LangLocaleCode]);

Argumento Descrição

ProcessName Um nome de processo válido.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidodo processo.

262 IBM Planning Analytics: Referência do TM1

Argumento Descrição

LangLocaleCode Este parâmetro opcional especifica o código deidioma para o qual deseja retornar um valor.

Valores válidos LangLocaleCode correspondem acódigos de idioma internacionais listados nadimensão do controle }Cultures.

Quando o LangLocaleCode não é especificado ouestá omitido, o código de idioma atual do usuário éusado como o argumento LangLocaleCode.

Se um valor de atributo não existir para oLangLocaleCode, o valor para um LangLocaleCodepai associado será retornado. Se um valor deatributo não existir para um LangLocaleCode paiassociado, o valor de atributo base será retornado.

Por exemplo, se LangLocaleCode for fr-CA, afunção retornará o valor de atributo para o códigode idioma fr-CA (Francês-Canadá), casodisponível. Se o valor de atributo para fr-CA nãoestiver disponível, a função tentará retornar o valorde atributo para o código de idioma pai fr(Francês). Se o valor de atributo para fr nãoestiver disponível, o valor de atributo de base seráretornado

Exemplo

Nesse exemplo, a função retorna o valor numérico do atributo Store_Code do processo Daily_Sales para ocódigo de idioma francês.

ProcessAttrNL('Daily_Sales', 'Store_Code', 'fr');

ProcessAttrPutNProcessAttrPutN designa um valor a um atributo numérico de processo.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ProcessAttrPutN(NumericValue, CubeName, AttrName, [LangLocaleCode] );

Argumento Descrição

NumericValue O valor que você deseja designar a um atributo deprocesso.

ProcessName O processo para o qual deseja designar um valorde atributo.

AttrName O atributo cujo valor você deseja designar.

Capítulo 5. Funções do Turbo Integrator 263

Argumento Descrição

LangLocaleCode Este parâmetro opcional especifica o código docódigo de idioma ao qual o NumericValue se aplica.

Os valores válidos do LangLocaleCodecorrespondem aos códigos de idiomainternacionais da ISO 639-1 listados na dimensãodo controle }Culturas.

Quando o LangLocaleCode não for especificado oufor emitido, o valor do atributo de base éatualizado.

Exemplo

Esse exemplo designa o valor 8051997 ao atributo Store_Code do processo Daily_Sales para o código deidioma Francês.

ProcessAttrPutN(8051997, 'Daily_Sales', 'Store_Code','fr');

ProcessAttrPutSProcessAttrPutS designa um valor a um atributo de sequência de processo.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ProcessAttrPutS(String, ProcessName, AttrName, [LangLocaleCode] );

Argumento Descrição

Sequência A sequência que você deseja designar a umatributo de processo.

ProcessName O processo para o qual deseja designar um valorde atributo.

AttrName O atributo cujo valor você deseja designar.

LangLocaleCode Este parâmetro opcional especifica o código docódigo de idioma ao qual o NumericValue se aplica.

Os valores válidos do LangLocaleCodecorrespondem aos códigos de idiomainternacionais da ISO 639-1 listados na dimensãodo controle }Culturas.

Quando o LangLocaleCode não for especificado oufor emitido, o valor do atributo de base éatualizado.

264 IBM Planning Analytics: Referência do TM1

Exemplo

Esse exemplo designa o valor de sequência Ricci para o atributo Owner do processoImport_Transactional, para o código de idioma francês.

ProcessAttrPutS('Ricci', 'Import_transactional', 'Owner', 'fr');

ProcessAttrSProcessAttrS retorna um atributo de sequência para um processo especificado.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ProcessAttrS(ProcessName, AttrName);

Argumento Descrição

ProcessName Um nome de processo válido.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidodo processo.

Exemplo

Nesse exemplo, a função retorna o valor de sequência do atributo Owner do processo Refresh_Cubes.

ProcessAttrS('Refresh_Cubes', 'Owner');

ProcessAttrSLProcessAttrSL retorna um valor de atributo de sequência para um processo especificado com relação aum código de idioma fornecido.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ProcessAttrSL(ProcessName, AttrName, [LangLocaleCode]);

Argumento Descrição

ProcessName Um nome de processo válido.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidodo processo.

Capítulo 5. Funções do Turbo Integrator 265

Argumento Descrição

LangLocaleCode Este parâmetro opcional especifica o código deidioma para o qual deseja retornar um valor.

Valores válidos LangLocaleCode correspondem acódigos de idioma internacionais listados nadimensão do controle }Cultures.

Quando o LangLocaleCode não é especificado ouestá omitido, o código de idioma atual do usuário éusado como o argumento LangLocaleCode.

Se um valor de atributo não existir para oLangLocaleCode, o valor para um LangLocaleCodepai associado será retornado. Se um valor deatributo não existir para um LangLocaleCode paiassociado, o valor de atributo base será retornado.

Por exemplo, se LangLocaleCode for fr-CA, afunção retornará o valor de atributo para o códigode idioma fr-CA (Francês-Canadá), casodisponível. Se o valor de atributo para fr-CA nãoestiver disponível, a função tentará retornar o valorde atributo para o código de idioma pai fr(Francês). Se o valor de atributo para fr nãoestiver disponível, o valor de atributo de base seráretornado

Exemplo

Nesse exemplo, a função retorna o valor de sequência do atributo Owner do processoExchange_Rate_Update para o código de idioma francês canadense.

ProcessAttrSL('Exchange_Rate_Update', 'Owner', 'fr-CA');

SubsetATTRSSubsetATTRS retorna um atributo de sequência para um subconjunto especificado.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SubsetATTRS(DimName, SubName, AttrName);

Argumento Descrição

DimName Um nome de dimensão válido.

SubName O nome de um subconjunto em uma dimensão.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda dimensão.

266 IBM Planning Analytics: Referência do TM1

Exemplo

Neste exemplo, a função retorna o valor de sequência do atributo Manager do subconjunto Sales dadimensão Plan_Business_Unit.

SubsetATTRS('Plan_Business_Unit', 'Sales', 'Manager');

SubsetATTRNSubsetATTRN retorna um atributo numérico para um subconjunto especificado.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SubsetATTRN(DimName, SubName, AttrName);

Argumento Descrição

DimName Um nome de dimensão válido.

SubName O nome de um subconjunto em uma dimensão.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda dimensão.

Exemplo

Neste exemplo, a função retorna o valor numérico do atributo Accounting_Code do subconjunto Sales dadimensão Plan_Business_Unit.

SubsetATTRN('Plan_Business_Unit', 'Sales', 'Accounting_Code');

SubsetATTRSLSubsetATTRSL retorna o valor de sequência de um atributo para um subconjunto especificado comrelação a um código de idioma fornecido.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SubsetATTRSL(DimName, SubName, AttrName, [LangLocaleCode]);

Argumento Descrição

DimName Um nome de dimensão válido.

SubName O nome de um subconjunto em uma dimensão.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda dimensão.

Capítulo 5. Funções do Turbo Integrator 267

Argumento Descrição

LangLocaleCode Este parâmetro opcional especifica o código deidioma para o qual deseja retornar um valor.

Valores válidos LangLocaleCode correspondem acódigos de idioma internacionais listados nadimensão do controle }Cultures.

Quando o LangLocaleCode não é especificado ouestá omitido, o código de idioma atual do usuário éusado como o argumento LangLocaleCode.

Se um valor de atributo não existir para oLangLocaleCode, o valor para um LangLocaleCodepai associado será retornado. Se um valor deatributo não existir para um LangLocaleCode paiassociado, o valor de atributo base será retornado.

Por exemplo, se LangLocaleCode for fr-CA, afunção retornará o valor de atributo para o códigode idioma fr-CA (Francês-Canadá), casodisponível. Se o valor de atributo para fr-CA nãoestiver disponível, a função tentará retornar o valorde atributo para o código de idioma pai fr(Francês). Se o valor de atributo para fr nãoestiver disponível, o valor de atributo de base seráretornado

Exemplo

Neste exemplo, a função retorna o valor de sequência do atributo Manager do subconjunto Sales para ocódigo de idioma French.

SubsetATTRSL('Plan_Business_Unit', 'Sales', 'Manager', 'fr');

SubsetATTRNLSubsetATTRNL retorna o valor numérico de um atributo para um subconjunto especificado com relação aum código de idioma fornecido.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SubsetATTRNL(DimName, SubName, AttrName, [LangLocaleCode]);

Argumento Descrição

DimName Um nome de dimensão válido.

SubName O nome de um subconjunto em uma dimensão.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda dimensão.

268 IBM Planning Analytics: Referência do TM1

Argumento Descrição

LangLocaleCode Este parâmetro opcional especifica o código deidioma para o qual deseja retornar um valor.

Valores válidos LangLocaleCode correspondem acódigos de idioma internacionais listados nadimensão do controle }Cultures.

Quando o LangLocaleCode não é especificado ouestá omitido, o código de idioma atual do usuário éusado como o argumento LangLocaleCode.

Se um valor de atributo não existir para oLangLocaleCode, o valor para um LangLocaleCodepai associado será retornado. Se um valor deatributo não existir para um LangLocaleCode paiassociado, o valor de atributo base será retornado.

Por exemplo, se LangLocaleCode for fr-CA, afunção retornará o valor de atributo para o códigode idioma fr-CA (Francês-Canadá), casodisponível. Se o valor de atributo para fr-CA nãoestiver disponível, a função tentará retornar o valorde atributo para o código de idioma pai fr(Francês). Se o valor de atributo para fr nãoestiver disponível, o valor de atributo de base seráretornado

Exemplo

Neste exemplo, a função retorna o valor numérico do atributo Accounting_Code do subconjunto Sales docódigo de idioma francês.

SubsetATTRNL('Plan_Business_Unit', 'Sales', 'Accounting_Code', 'fr');

SubsetAttrPutSSubsetAttrPutS designa um valor de sequência para um atributo para um subconjunto especificado.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SubsetAttrPutS(String, DimensionName, SubName, AttrName, [LangLocaleCode] );

Argumento Descrição

Sequência A sequência que você deseja designar a umatributo de dimensão.

DimensionName A dimensão para a qual você deseja designar umvalor de atributo.

SubName O nome de um subconjunto em uma dimensão.

AttrName O atributo cujo valor você deseja designar.

Capítulo 5. Funções do Turbo Integrator 269

Argumento Descrição

LangLocaleCode Este parâmetro opcional especifica o código docódigo de idioma ao qual o NumericValue se aplica.

Os valores válidos do LangLocaleCodecorrespondem aos códigos de idiomainternacionais da ISO 639-1 listados na dimensãodo controle }Culturas.

Quando o LangLocaleCode não for especificado oufor emitido, o valor do atributo de base éatualizado.

Exemplo

Este exemplo designa o valor da sequência Prototype ao atributo Description do subconjunto Z (dadimensão do Modelo) para o código do código de idioma francês.

SubsetAttrPutS('Prototype', 'Model', 'Z', 'Description','fr');

SubsetAttrPutNSubsetAttrPutN designa um valor numérico a um atributo para um subconjunto especificado.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SubsetAttrPutN(NumericValue, DimensionName, SubName, AttrName, [LocalLangCode] );

Argumento Descrição

NumericValue O valor que você deseja designar a um atributo dedimensão.

DimensionName A dimensão para a qual você deseja designar umvalor de atributo.

SubName O nome de um subconjunto em uma dimensão.

AttrName O atributo cujo valor você deseja designar.

LangLocaleCode Este parâmetro opcional especifica o código docódigo de idioma ao qual o NumericValue se aplica.

Os valores válidos do LangLocaleCodecorrespondem aos códigos de idiomainternacionais da ISO 639-1 listados na dimensãodo controle Cultures.

Quando o LangLocaleCode não for especificado oufor emitido, o valor do atributo de base éatualizado.

270 IBM Planning Analytics: Referência do TM1

Exemplo

Este exemplo designa o valor 07161994 ao atributo AccountingCode do subconjunto Z (da dimensãoModels) para o código de idioma do idioma French.

SubsetAttrPutN(07161994, 'Models', 'Z', 'AccountingCode','fr');

SubsetAttrInsertSubsetAttrInsert cria um novo atributo para subconjuntos em seu servidor TM1. A função cria um atributode sequência, numérico ou de alias.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Atenção: Se você atualizar um atributo de subconjunto existente, deverá primeiro excluir oatributo existente usando a função SubsetAttrDelete. É possível, então, usar SubsetAttrInsert pararecriar o atributo com suas mudanças desejadas.

Importante: Se você tentar atualizar um atributo existente sem primeiro excluí-lo, a inserção falhará semum aviso ou erro. O atributo existente permanece não alterado; ele não será nem atualizado e nemsobrescrito.

Sintaxe

SubsetAttrInsert( Dimension, PrevAttrName, NewAttrName, AttrType);

Argumento Descrição

Dimensão O nome da dimensão cujos subconjuntos estãosendo atualizados.

PrevAttrName O atributo que precede o atributo que está sendocriado. Se não houver nenhum atributo anterior ouse desejar que o novo atributo seja o primeiroatributo para subconjuntos, deixe este argumentovazio.

NewAttrName O nome que você deseja designar ao novo atributode subconjunto.

AttrType O tipo de atributo. Existem três possíveis valorespara o argumento AttrType:

• N - Cria um atributo numérico.• S - Cria um atributo de sequência.• A - Cria um atributo de alias.

Exemplo

Este exemplo cria o atributo de sequência Description para os subconjuntos na dimensão Model. Comonão há nenhum parâmetro PrevAttrName, este atributo é inserido como o primeiro atributo parasubconjuntos em seu servidor TM1.

SubsetAttrInsert('Model', '', 'Description', 'S');

SubsetAttrDeleteSubsetAttrDelete exclui um atributo de subconjunto do banco de dados do TM1.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Capítulo 5. Funções do Turbo Integrator 271

Sintaxe

SubsetAttrDelete(Dimension, AttrName);

Argumento Descrição

Dimensão O nome da dimensão cujo atributo de subconjuntoestá sendo excluído.

AttrName O nome do atributo de dimensão que você desejaexcluir.

Exemplo

Este exemplo exclui o atributo Description para os subconjuntos na dimensão Model.

SubsetAttrDelete('Model', 'Description');

ViewAttrDeleteViewAttrDelete exclui um atributo de visualização para um cubo específico do banco de dados do TM1.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewAttrDelete(CubeName, AttrName);

Argumento Descrição

CubeName O nome do cubo cujo atributo de visualização estásendo excluído.

AttrName O nome do atributo de visualização que vocêdeseja excluir.

Exemplo

Esse exemplo exclui o atributo de descrição para visualizações do cubo Sales em seu servidor TM1.

ViewAttrDelete('Sales', 'Description');

ViewAttrInsertViewAttrInsert cria um novo atributo para visualizações de um cubo específico em seu servidor TM1. Afunção pode criar um atributo de sequência, numérico ou de alias.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Atenção: Se você atualizar um atributo de visualização existente, deverá primeiro excluir oatributo existente usando a função ViewAttrDelete. É possível, então, usar ViewAttrInsert pararecriar o atributo com suas mudanças desejadas.

Importante: Se você tentar atualizar um atributo existente sem primeiro excluí-lo, a inserção falhará semum aviso ou erro. O atributo existente permanece não alterado; ele não será nem atualizado e nemsobrescrito.

272 IBM Planning Analytics: Referência do TM1

Sintaxe

ViewAttrInsert( CubeName, PrevAttrName, NewAttrName, AttrType);

Argumento Descrição

CubeName O cubo pai para o qual você deseja inserir umatributo de visualização.

PrevAttrName O atributo que precede o atributo que está sendocriado. Se não houver nenhum atributo anterior ouse desejar que o novo atributo seja o primeiroatributo para visualizações, deixe este argumentovazio.

NewAttrName O nome que você deseja designar ao novo atributode visualização.

AttrType O tipo de atributo. Existem três possíveis valorespara o argumento AttrType:

• N - Cria um atributo numérico.• S - Cria um atributo de sequência.• A - Cria um atributo de alias.

Exemplo

Esse exemplo cria o atributo de sequência de descrição para visualizações do cubo Sales. Este atributo éinserido após o atributo Owner.

ViewAttrInsert('Sales', 'Owner', 'Description', 'S');

ViewAttrNViewAttrN retorna um atributo numérico para uma visualização especificada.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewAttrN(CubeName, ViewName, AttrName);

Argumento Descrição

CubeName Um nome de cubo válido.

ViewName Um nome de visualização válido.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda visualização.

Capítulo 5. Funções do Turbo Integrator 273

Exemplo

Nesse exemplo, a função retorna o valor numérico para o atributo Category_Code da visualização Produtodo cubo Vendas.

ViewAattrN('Sales', 'Product', 'Category_Code');

ViewAttrNLViewAttrNL retorna o valor numérico de um atributo para uma visualização especificada com relação a umcódigo de idioma fornecido.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewAttrNL(CubeName, ViewName, AttrName, [LangLocaleCode]);

Argumento Descrição

CubeName O cubo pai da visualização cujo valor de atributovocê deseja recuperar.

ViewName Um nome de visualização válido.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda visualização.

LangLocaleCode Este parâmetro opcional especifica o código deidioma para o qual deseja retornar um valor.

Valores válidos LangLocaleCode correspondem acódigos de idioma internacionais listados nadimensão do controle }Cultures.

Quando o LangLocaleCode não é especificado ouestá omitido, o código de idioma atual do usuário éusado como o argumento LangLocaleCode.

Se um valor de atributo não existir para oLangLocaleCode, o valor para um LangLocaleCodepai associado será retornado. Se um valor deatributo não existir para um LangLocaleCode paiassociado, o valor de atributo base será retornado.

Por exemplo, se LangLocaleCode for fr-CA, afunção retornará o valor de atributo para o códigode idioma fr-CA (Francês-Canadá), casodisponível. Se o valor de atributo para fr-CA nãoestiver disponível, a função tentará retornar o valorde atributo para o código de idioma pai fr(Francês). Se o valor de atributo para fr nãoestiver disponível, o valor de atributo de base seráretornado

274 IBM Planning Analytics: Referência do TM1

Exemplo

Nesse exemplo, a função retorna o valor numérico para o atributo Category_Code da visualização Produtodo cubo Vendas, para o código de idioma francês.

ViewAttrNL('Sales', 'Product', 'Category_Code', 'fr');

ViewAttrPutNViewAttrPutN designa um valor a um atributo de visualização numérica.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewAttrPutN(NumericValue, CubeName, ViewName, AttrName, [LangLocaleCode] );

Argumento Descrição

NumericValue O valor que você deseja designar a um atributo devisualização.

CubeName O cubo pai da visualização para a qual você desejadesignar um valor de atributo.

ViewName A visualização para a qual você deseja designar umvalor de atributo.

AttrName O atributo cujo valor você deseja designar.

LangLocaleCode Este parâmetro opcional especifica o código docódigo de idioma ao qual o NumericValue se aplica.

Os valores válidos do LangLocaleCodecorrespondem aos códigos de idiomainternacionais da ISO 639-1 listados na dimensãodo controle }Culturas.

Quando o LangLocaleCode não for especificado oufor emitido, o valor do atributo de base éatualizado.

Exemplo

Esse exemplo designa o valor 8222001 ao atributo Category_Code da visualização do produto do cuboSales, para o código de idioma Francês.

ViewAttrPutN(8222001, 'Sales', 'Product', 'Category_Code','fr');

ViewAttrPutSViewAttrPutS designa um valor de sequência para um atributo para uma visualização especificada.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewAttrPutS(String, CubeName, ViewName, AttrName, [LangLocaleCode] );

Capítulo 5. Funções do Turbo Integrator 275

Argumento Descrição

Sequência A sequência que você deseja designar a umatributo de visualização.

CubeName O pai cubo da visualização para a qual você desejadesignar um valor de atributo.

ViewName O nome da visualização para a qual você desejadesignar um valor de atributo.

AttrName O atributo cujo valor você deseja designar.

LangLocaleCode Este parâmetro opcional especifica o código docódigo de idioma ao qual o NumericValue se aplica.

Os valores válidos do LangLocaleCodecorrespondem aos códigos de idiomainternacionais da ISO 639-1 listados na dimensãodo controle }Culturas.

Quando o LangLocaleCode não for especificado oufor emitido, o valor do atributo de base éatualizado.

Exemplo

Esse exemplo designa o valor de sequência Rocheford para o atributo Owner da visualizaçãoIndividual_Stores do cubo Sales, para o código de idioma francês.

ViewAttrPutS('Rocheford', 'Sales', 'Individual_Stores', 'Owner','fr');

ViewAttrSViewAttrS retorna um atributo de sequência para uma visualização especificada.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewAttrS(CubeName, ViewName, AttrName);

Argumento Descrição

CubeName O cubo pai da visualização para o qual desejaretornar um valor de atributo.

ViewName A visualização para a qual deseja retornar um valorde atributo.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda visualização.

Exemplo

ViewAttrS('Plan_Business_Unit', 'Sales', 'Manager');

276 IBM Planning Analytics: Referência do TM1

Nesse exemplo, a função retorna o valor de sequência do atributo Manager da visualização Vendas docubo Plan_Business_Unit.

ViewAttrSLViewAttrSL retorna o valor de sequência de um atributo para uma visualização especificada com relação aum código de idioma fornecido.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewAttrSL(CubeName, ViewName, AttrName, [LangLocaleCode]);

Argumento Descrição

CubeName O cubo pai da visualização para o qual desejaretornar um valor de atributo.

ViewName A visualização para a qual deseja retornar um valorde atributo.

AttrName O atributo para o qual você deseja recuperar umvalor. Este argumento deve ser um atributo válidoda visualização.

LangLocaleCode Este parâmetro opcional especifica o código deidioma para o qual deseja retornar um valor.

Valores válidos LangLocaleCode correspondem acódigos de idioma internacionais listados nadimensão do controle }Cultures.

Quando o LangLocaleCode não é especificado ouestá omitido, o código de idioma atual do usuário éusado como o argumento LangLocaleCode.

Se um valor de atributo não existir para oLangLocaleCode, o valor para um LangLocaleCodepai associado será retornado. Se um valor deatributo não existir para um LangLocaleCode paiassociado, o valor de atributo base será retornado.

Por exemplo, se LangLocaleCode for fr-CA, afunção retornará o valor de atributo para o códigode idioma fr-CA (Francês-Canadá), casodisponível. Se o valor de atributo para fr-CA nãoestiver disponível, a função tentará retornar o valorde atributo para o código de idioma pai fr(Francês). Se o valor de atributo para fr nãoestiver disponível, o valor de atributo de base seráretornado

Exemplo

Nesse exemplo, a função retorna o valor de sequência do atributo Manager da visualização Vendas docubo Plan_Business_Unit, para o código de idioma francês canadense.

ViewAttrSL('Plan_Business_Unit', 'Sales', 'Manager', 'fr-CA');

Capítulo 5. Funções do Turbo Integrator 277

Funções de Gerenciamento de Tarefas de Organização de Processos doTurbo Integrator

Estas funções referem-se ao gerenciamento de tarefas de organização de processos.

ChoreErrorChoreError causa a finalização imediata de uma tarefa de organização de processos. Ela pode serchamada a partir de qualquer processo em uma tarefa de organização de processos. A função ChoreErrorTurboIntegrator causa uma finalização imediata de uma única tarefa de organização de processos. Astarefas de organização de processos terminadas com esta função são sinalizadas com um status de erro.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ChoreError;

Argumentos

Nenhum.

ChoreQuitChoreQuit causa a rescisão imediata de uma tarefa de organização de processos. Ela pode ser chamada apartir de qualquer processo em uma tarefa de organização de processos. A tarefa de organização deprocessos atual é finalizada com um status de erro e uma mensagem é gravada no arquivo de log doservidor, indicando que ChoreQuit foi chamada para finalizar a tarefa de organização de processos.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ChoreQuit;

Argumentos

Nenhum.

ChoreRollbackChoreRollback inicia o retrocesso de uma tarefa de organização de processos. Quando usada em umprocesso do TurboIntegrator, esta função descarta todas as edições pendentes e cancela oprocessamento adicional. Uma mensagem de erro é exibida nos arquivos tm1server.log etm1processorerrorXXX.log.

Quando usado em uma tarefa de organização de processos de único modo de confirmação,ChoreRollback lança todas as edições pendentes de todos os processos anteriores e a execução datarefa de organização de processos para com um código de erro. Quando usado em uma tarefa deorganização de processos de modo de multiconfirmação, ChoreRollback lança todas as ediçõespendentes dos processos atuais e a execução da tarefa de organização de processos para com um códigode erro. Mudanças confirmadas não podem ser desfeitas.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ChoreRollback;

278 IBM Planning Analytics: Referência do TM1

Argumentos

Nenhum.

SetChoreVerboseMessagesSetChoreVerboseMessages é usada para ativar (ou desativar) relatórios mais detalhados de mensagensno arquivo Tm1s.log. É possível usar essa função para depurar tarefas de organização de processos nasquais vários processos chamam uns aos outros com a função ExecuteProcess.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SetChoreVerboseMessages(Flag);

Transmitir um valor zero desativa a saída destas mensagens, transmitir um valor diferente de zero ativa asaída de mensagens mais detalhadas. Por padrão, este sinalizador é desativado.

Use esta função para ativar (ou desativar) relatórios mais detalhados de mensagens no arquivo Tm1s.log.Esta função é melhor usada como um auxílio na depuração de tarefas de organização de processos, emque vários processos chamam uns aos outros usando a função ExecuteProcess.

Transmitir um valor zero desativa a saída destas mensagens, transmitir um valor diferente de zero ativa asaída de mensagens mais detalhadas. Por padrão, este sinalizador é desativado.

Argumento Descrição

Sinalizador Definir um valor diferente de zero para ativar osistema de mensagens mais detalhadas. Definidocomo zero (padrão) para desativar o sistema demensagens detalhadas.

Funções de Manipulação de Cubos do Turbo IntegratorEstas funções referem-se à manipulação de cubos.

AddCubeDependencyAddCubeDependency permite predefinir interdependências de cubo para evitar problemas de contençãode bloqueio durante o uso normal do sistema.

Em operações normais, as dependências do cubo são estabelecidas quando os dados, que cruzam oslimites do cubo (tais como dados derivados por uma regra que faz referência a um cubo externo), sãorecuperados. Para criar as informações de dependência, o servidor deve bloquear os cubos enquanto adependência é estabelecida, mantendo, potencialmente, o bloqueio durante um cálculo de visualizaçãolonga. Visto que este é um bloqueio de 'gravação', outros usuários são impedidos de acessar os cubos. Afunção AddCubeDependency permite que a dependência seja estabelecida quando o servidor é iniciado,impedindo a contenção de bloqueio posterior, visto que nenhuma nova dependência precisa serestabelecida.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

AddCubeDependency(BaseCube, DependentCube);

Capítulo 5. Funções do Turbo Integrator 279

Argumento Descrição

BaseCube O nome do cubo do qual o DependentCube édependente.

DependentCube O nome de um cubo que depende de outro cubo(BaseCube) para obter dados. De forma maiscomum, isso seria um cubo que usa regras paraextrair dados de um cubo externo.

Exemplo

Considere um cubo chamado 'SalesCube', que inclui a regra ['net']=!Units *DB('PriceCube', ... );

Neste exemplo, 'SalesCube' é o cubo dependente, já que ele é dependente de valores no cubo basechamado 'PriceCube' para calcular o valor de 'net'. Para estabelecer essa dependência, é necessárioexecutar a função a seguir em um processo do Turbo Integrator:AddCubeDependency( 'PriceCube', 'SalesCube' );

Para estabelecer a dependência no tempo de carregamento do servidor, é possível criar um processo queexecuta a função AddCubeDependency, planejar o processo como uma tarefa de organização deprocessos e, em seguida, definir essa tarefa de organização de processos como um dos StartupChoresem Tm1s.cfg.

CellGetNCellGetN recupera um valor a partir de uma célula de cubo numérica.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CellGetN(Cube, e1, e2 [,...en]);

Argumento Descrição

Cubo O nome do cubo do qual você deseja recuperar umvalor.

280 IBM Planning Analytics: Referência do TM1

Argumento Descrição

e1,...en Os nomes de elementos de dimensão que definema interseção do cubo que contém o valor a serrecuperado.

Os argumentos e1 a en são sensíveis à sequência.e1 deve ser um elemento da primeira dimensão docubo, e2 deve ser um elemento da segundadimensão e assim por diante. Estes argumentostambém podem ser os nomes de aliases paraelementos de dimensão ou variáveis do TurboIntegrator.

Se qualquer uma das dimensões no cubo usarhierarquias, também é possível usar a convenção'HierarchyName':'ElementName' paraespecificar um elemento em uma hierarquiaespecífica. Nesse caso, a sequência de argumentosdeve ainda aderir à ordem de dimensões no cubo.Por exemplo, caso se queira fazer referência avários elementos de hierarquias na segundadimensão do cubo, todos esses argumentosdeverão aparecer após o argumento para aprimeira dimensão no cubo e antes do argumentopara a terceira dimensão no cubo.

Exemplo de CELLGETN e variáveis

Quando esta função for usada em uma instrução condicional (IF), a instrução será a parte que contém acondição, não o bloco condicional inteiro. Após um erro secundário, a execução continuará com apróxima instrução. O processamento do Turbo Integrator não tem ciência de que estava em umacondicional quando o erro secundário foi processado, portanto, a próxima instrução é a próxima linha enão a linha depois de ENDIF;.

Para evitar esta situação, use variáveis para qualquer operação que possa encontrar um erro secundárioe, em seguida, use as variáveis na instrução condicional.

V1 = CELLGETN('PNLCube', 'fred','argentina','Sales','Jan');IF(V1 = 454); ASCIIOUTPUT('bug.txt', 'if logic not working properly');ENDIF;

Exemplo de CellGetN sem hierarquias

Este exemplo ilustra uma função que usa nomes de elementos simples como argumentos e não fazreferência a nenhuma hierarquia. Recupera o valor numérico na interseção dos elementos Actual,Argentina, S Series 1.8L Sedan, Sales e Jan no cubo de Vendas.

CellGetN ('Sales', 'Actual', 'Argentina', 'S Series1.8L Sedan', 'Sales', 'Jan');

Exemplo de CellGetN fazendo referência a várias hierarquias

Este exemplo ilustra uma função que faz referência a várias hierarquias na dimensão Model. Recupera ovalor numérico na interseção dos elementos Actual, Argentina, S Serie (da hierarquia de veículos nadimensão do modelo), 2.8 Litre (da hierarquia enginesize na dimensão do modelo) e Jan no cubo Vendas.

CellGetN('Sales', 'Actual', 'Argentina', ('vehicles':'S Series', 'enginesize':'2.8 Litre'), 'Sales', 'Jan');

Capítulo 5. Funções do Turbo Integrator 281

Nota: Este exemplo quebra artificialmente a linha de código para facilitar a leitura.

CellGetSCellGetS recupera um valor de uma célula do cubo de sequência.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CellGetS(Cube, e1, e2 [,...en]);

Argumento Descrição

Cubo O nome do cubo do qual você deseja recuperar umvalor.

e1,...en Os nomes de elementos de dimensão que definema interseção do cubo que contém o valor a serrecuperado.

Os argumentos e1 a en são sensíveis à sequência.e1 deve ser um elemento da primeira dimensão docubo, e2 deve ser um elemento da segundadimensão e assim por diante. Estes argumentostambém podem ser os nomes de aliases paraelementos de dimensão ou variáveis do TurboIntegrator.

Consulte a nota em “CellGetN” na página 280 referente à lógica SE com esta função.

Exemplo

CellGetS('Personnel', 'Rep', 'Europe', 'Product');

Este exemplo recupera o valor de sequência na interseção dos elementos Rep, Europa e Produto no cuboPersonnel.

CellIncrementNCellIncrementN incrementa um valor de célula numérica existente por um valor especificado.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CellIncrementN(x, Cube, e1, e2 [,...en]);

Argumento Descrição

x Um valor numérico que você deseja incluir em umvalor da célula existente.

Cubo O nome do cubo para o qual você deseja enviar ovalor.

282 IBM Planning Analytics: Referência do TM1

Argumento Descrição

e1,...en Os nomes de elementos de dimensão que definema interseção do cubo para receber o valor.

Os argumentos e1 a en são sensíveis à sequência.e1 deve ser um elemento da primeira dimensão docubo, e2 deve ser um elemento da segundadimensão e assim por diante. Estes argumentostambém podem ser os nomes de aliases paraelementos de dimensão ou variáveis do TurboIntegrator.

Exemplo

CellIncrementN(1000, 'y2ksales', 'Actual', 'Argentina', 'S Series 1.8L Sedan', 'Sales', 'Jan');

Este exemplo incrementa o valor na interseção dos elementos Real, Argentina, Sedã Série S 1.8L, Vendase Jan no cubo y2ksales por 1000.

CellIsUpdateableCellIsUpdateable determina se é possível fazer gravações em uma célula do cubo. A função retornará 1se puder ser feita gravação na célula, caso contrário, retornará 0.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CellIsUpdateable(Cube, e1, e2 [,...en]);

Argumento Descrição

Cubo O nome do cubo no qual você deseja gravar umvalor.

e1,...en Nomes de elementos de dimensão que definem acélula na qual você deseja gravar um valor.

Os argumentos e1 a en são sensíveis à sequência.e1 deve ser um elemento da primeira dimensão docubo, e2 deve ser um elemento da segundadimensão e assim por diante. Estes argumentostambém podem ser os nomes de aliases paraelementos de dimensão ou variáveis do TurboIntegrator.

Exemplo

CellIsUpdateable ('y2ksales', 'Actual', 'Argentina', 'S Series1.8L Sedan', 'Sales', 'Jan');

Este exemplo determina se pode ser feita gravação na célula definida pelos elementos Real, Argentina,Sedã Série S 1.8L, Vendas e Jan no cubo y2ksales. Se a célula puder receber um valor, a função retornará1, caso contrário, retornará 0.

CellPutNCellPutN envia um valor numérico para uma célula do cubo.

Capítulo 5. Funções do Turbo Integrator 283

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CellPutN (x, Cubo, e1, e2 [, ..., en ]);

Argumento Descrição

x Um valor numérico.

Cubo O nome do cubo para o qual você deseja enviar ovalor.

e1, e2, ..., en Os nomes de elementos de dimensão que definema interseção do cubo para receber o valor.

Os argumentos e1 a en são sensíveis à sequência.e1 deve ser um elemento da primeira dimensão docubo, e2 deve ser um elemento da segundadimensão e assim por diante. Estes argumentostambém podem ser os nomes de aliases paraelementos de dimensão ou variáveis do TurboIntegrator.

Nota: Se você fornecer argumentos inválidos para a função CellPutN() em um processo doTurboIntegrator quando o cubo não existir, um erro será enviado para o tm1server.log.

Exemplo

CellPutN(12345, 'y2ksales', 'Actual', 'Argentina', 'S Series1.8L Sedan', 'Sales', 'Jan');

Este exemplo envia o valor 12345 para a interseção dos elementos Real, Argentina, Sedã Série S 1.8L,Vendas e Jan no cubo y2ksales.

CellPutProportionalSpreadCellPutProportionalSpread distribui para as folhas de uma consolidação um valor especificado,proporcional aos valores de célula existentes. CellPutProportionalSpread substitui valores de célulasexistentes; ela não pode ser usada para incluir ou subtrair de valores de células existentes.

A função é análoga ao método de difusão de dados em Difusão Proporcional, que está descrito emdetalhes na documentação do TM1 Perspectives e do TM1 Architect. Se precisar incluir ou subtrair devalores de células existentes, use o método Difusão Proporcional, que pode ser executado por meio dainterface com o usuário ou da sintaxe de difusão de dados.

Nota: Ao usar CellPutProportionalSpread para distribuir um valor para as folhas de uma consolidação,apenas as folhas que já contêm valores diferentes de zero são alteradas. Isto ocorre porque valores zeronão podem ser incrementados ou reduzidos proporcionalmente; qualquer proporção de zero ainda é zero.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CellPutProportionalSpread( value, cube, e1, e2, e3...,en );

Argumento Descrição

valor O valor que você deseja distribuir.

284 IBM Planning Analytics: Referência do TM1

Argumento Descrição

cubo O nome do cubo no qual você deseja distribuir ovalor.

e1...en Os nomes dos elementos que identificam aconsolidação cujas folhas aceitarão o valordistribuído.

Os argumentos e1 a en são sensíveis à sequência.e1 deve ser um elemento da primeira dimensão docubo, e2 deve ser um elemento da segundadimensão e assim por diante. Estes argumentostambém podem ser os nomes de aliases paraelementos de dimensão ou variáveis do TurboIntegrator.

Exemplo

CellPutProportionalSpread(7000,'SalesCube', 'Actual','North America', 'S Series 1.8L Sedan', 'Sales', 'Jan')

Este exemplo distribui o valor 7000 para os filhos da consolidação no SalesCube identificado peloselementos Real, América do Norte, Sedã Série S 1.8L, Vendas e Jan.

CellPutSCellPutS envia um valor de sequência para uma célula do cubo.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CellPutS(String, Cube, e1, e2 [,...en]);

Argumento Descrição

Sequência Uma sequência.

Cubo O nome do cubo para o qual você deseja enviar asequência.

e1,...en Os nomes de elementos de dimensão que definema interseção do cubo para receber a sequência.

Os argumentos e1 a en são sensíveis à sequência.e1 deve ser um elemento da primeira dimensão docubo, e2 deve ser um elemento da segundadimensão e assim por diante. Estes argumentostambém podem ser os nomes de aliases paraelementos de dimensão ou variáveis do TurboIntegrator.

Exemplo

CellPutS('jones', 'Personnel', 'Rep', 'Europe', 'Product');

Capítulo 5. Funções do Turbo Integrator 285

Este exemplo envia a sequência 'jones' para a interseção dos elementos Rep, Europa e Produto no cubopersonnel.

CubeClearDataCubeClearData limpa todos os dados em um cubo. Esta função é muito mais rápida do que executar umaoperação, como a criação de uma visualização para cobrir o cubo inteiro e, em seguida, executarViewZeroOut() para zerar o cubo inteiro.

Quando você usa CubeClearData para limpar dados de um cubo, todas as células no cubo que sãoalimentadas por alimentadores também são limpas. Você deve salvar novamente a regra que estabeleceos alimentadores ou usar a função CubeProcessFeeders para restaurar as células alimentadas.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Nota: Esta chamada apenas exclui os dados do cubo, ela não exclui e recria o próprio cubo. Isto temimplicações quando são usados ambientes de simulações. Se um cubo for excluído e, em seguida,recriado, os ambientes de simulações que um usuário pode ter serão descartados, pois o cubo no qualesses ambientes de simulações foram criados foi excluído (mesmo que um cubo possa ter sido recriadocom o mesmo nome). No entanto, se a chamada CubeClearData() for usada, os dados do ambiente desimulação ainda serão considerados válidos, pois o cubo no qual o ambiente de simulação foi criadocontinua existindo.

Sintaxe

CubeClearData( name-of-cube-as-string );

Argumento

O nome do cubo a ser limpo, como uma sequência.

Exemplo

CubeClearData( 'expense' );

CubeCreateCubeCreate cria um cubo a partir de dimensões especificadas. A ordem de dimensões especificada nafunção será a ordem de dimensões na definição do cubo. Após a execução, CubeCreate salvaautomaticamente o arquivo .cub resultante no disco.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeCreate(Cube, d1, d2 [,...dn]);

Argumento Descrição

Cubo O nome que você deseja designar ao cubo.

d1,...dn Os nomes de dimensões que formam o cubo. Vocêdeve especificar pelo menos duas, mas não maisque 256 dimensões.

Exemplo

CubeCreate('y2ksales', 'Actvsbud', 'Region', 'Model', 'Account1','Month');

286 IBM Planning Analytics: Referência do TM1

Este exemplo cria um cubo chamado y2ksales usando as dimensões Actvsbud, Região, Modelo, Account1e Mês.

CubeDestroyCubeDestroy exclui um cubo do TM1 especificado.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeDestroy(Cube);

Argumento Descrição

Cubo O nome do cubo que você deseja excluir.

Exemplo

CubeDestroy('y2ksales');

Este exemplo exclui o cubo chamado y2ksales.

CubeDimensionCountGetCubeDimensionCountGet retorna o número de dimensões em um cubo.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeDimensionCountGet(CubeName);

Argumento Descrição

CubeName O nome do cubo para o qual deseja determinar onúmero de dimensões.

ExemploCubeDimensionCountGet('Sales');

Neste exemplo, a função retorna o número de dimensões no cubo Vendas.

CubeExistsCubeExists determina se um cubo específico existe no servidor a partir do qual um processo do TurboIntegrator é executado. A função retornará 1 se o cubo existir no servidor, caso contrário, retornará 0.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeExists(CubeName);

Argumento Descrição

CubeName O nome do cubo cuja existência você desejaconfirmar.

Capítulo 5. Funções do Turbo Integrator 287

Exemplo

CubeExists('Inventory');

Este exemplo determina se o cubo Inventory existe no servidor.

CubeGetLogChangesCubeGetLogChanges retorna o valor booleano da propriedade de Criação de log para um cuboespecificado.

A propriedade Criação de log é configurada na caixa de diálogo Designações de segurança do TM1 earmazenada no cubo de controle }CubeProperties. Se a Criação de Log for ativada para um cubo, a funçãoretornará 1. Se a criação de log for desativada, a função retornará 0.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeGetLogChanges(CubeName);

Argumento Descrição

CubeName O cubo para o qual você deseja retornar o valor dapropriedade Criação de Log.

Exemplo

CubeGetLogChanges('2002sales');

Se Criação de Log estiver ativada para o cubo 2002sales, função retornará 1.

CubeSaveDataCubeSaveData() serializa um cubo.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Para melhorar o desempenho, a criação de logs de transações pode ser desativada durante ocarregamento de dados. Para proteger dados recém-carregados no improvável caso de um travamentodo servidor, as mudanças poderão ser serializadas no disco. SaveDataAll foi usado para serializar dadosno disco e truncar o log de transações. Ao processar um comando SaveDataAll, o servidor adquire umbloqueio de LEITURA em cada cubo e um bloqueio de IX em cada cubo alterado. Isso pode causar umacontenção significativa na atividade do usuário se SaveDataAll estiver em execução durante os períodosde atividade do usuário.

Normalmente nem todos os cubos afetados por SaveDataAll precisam ser serializados, já quenormalmente nem todos os cubos são carregados com novos dados. CubeSaveData é usado paraserializar um cubo individual no disco. CubeSaveData serializa os dados do cubo que foram confirmadosna memória, incluindo as modificações neles feitas durante o processo atual do Turbo Integrator mas queainda não foram confirmadas.

Sintaxe

CubeSaveData(Cube);

Argumento Descrição

Cubo O nome do cubo que deseja serializar.

288 IBM Planning Analytics: Referência do TM1

Exemplo

CubeSaveData ('SalesCube');

Considere o seguinte código do processo do Turbo Integrator:

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');

Quando o comando CubeSaveData é processado, o valor de 500 para a célula January Sales é incluído naserialização do cubo no disco, mesmo que ele ainda não tenha sido confirmado. A atualização da célulaVendas de Janeiro para 1000 não fará parte da serialização.

Log de Transações

Uma nova entrada de transação aparece no Log de Transações quando CubeSaveData é executado.Durante o processamento de um arquivo de log de transações durante a recuperação, todas asatualizações para um cubo que foram aplicadas até o momento serão descartadas quando uma diretivaCubeSaveData com relação ao cubo for encontrada, já que todas as atualizações já foram serializadaspara o cubo.

Recuperação de Falha do Servidor

O comando SaveDataAll aproveita o fato de que todos os cubos são bloqueados durante o seuprocessamento e trunca o log de transações, sabendo que todas as atualizações executadas antes daserialização foram seguramente armazenadas no disco. Esse não é o caso para CubeSaveData, portanto,você deve modificar a maneira como a recuperação de dados é executada quando um cubo é serializado.

O arquivo de log de transações contém registros que representam mudanças mais antigas do que osdados mais recentes no cubo e não devem ser aplicados quando dados estiverem sendo recuperados.

CubeSetConnParamsCubeSetConnParams é usada para criptografar a senha para um cubo virtual no cubo }CubeProperties.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeSetConnParams(cubeName, providerName, dataSourceLocation,dataSourceName, dataSourceCatalog, userID, password, sapClientID, sapClientLang, providerString);

Argumento Descrição

cubeName O nome do cubo para o qual você deseja definir asenha.

providerName

dataSourceLocation Nome designado por seu administrador a umconjunto de catálogos em um local específico. NosMicrosoft Analysis Services, esse é o nome de umservidor registrado.

dataSourceName

Capítulo 5. Funções do Turbo Integrator 289

Argumento Descrição

catálogo dataSource O nome designado por seu administrador a umacoleção específica de bancos de dados (Cubos,Dimensões e outros objetos). Para o MAS, este é onome do banco de dados.

UserID Um nome de usuário válido para o banco de dados.

Senha Senha a ser usada para esta origem de dados.

sapClientID ID de cliente do SAP

sapClientLang Configuração de idioma do SAP.

providerString

Exemplo

CubeSetConnParams(sc, TM1OLAP, tm1server, , sdata, admin, apple, , , );

CubeSetLogChangesCubeSetLogChanges configura a propriedade Logging para um cubo.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeSetLogChanges(Cube, LogChanges);

Argumento Descrição

Cubo O nome do cubo para o qual você deseja definir apropriedade CRIAÇÃO DE LOG.

LogChanges O valor Booleano que você deseja designar àpropriedade. 1= CRIAÇÃO DE LOG ativada, 0 =CRIAÇÃO DE LOG desativada.

CubeTimeLastUpdatedCubeTimeLastUpdated retorna um valor de série que indica a data e hora em que um cubo especificadofoi atualizado pela última vez.

O valor de série retornado por essa função usa como horário inicial 1º de janeiro de 1900, às 0h, o queequivale ao valor 1.0. As datas são representadas por números inteiros, enquanto os horários sãorepresentados como números decimais entre .0 e .999999. Isso é consistente com a maneira como osvalores de série de data e hora são armazenados e relatados no Microsoft Excel.

Nota: Por padrão, os valores de série de data e hora do TM1 usam como horário inicial 1º de janeiro de1960, às 0h. Para resolver a inconsistência entre os valores de série de data e hora do Excel e do TM1, épossível configurar UseExcelSerialDate=T no arquivo Tm1s.cfg para instruir o servidor TM1 a usarvalores de série de data e hora que estejam em conformidade com os padrões do Excel.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

290 IBM Planning Analytics: Referência do TM1

Sintaxe

CubeTimeLastUpdated(cube);

Argumento Descrição

cubo O nome do cubo.

Exemplo

CubeTimeLastUpdated ('Sales');

Esse exemplo retorna um valor correspondente ao horário em que o cubo Vendas foi atualizado pelaúltima vez.

CubeUnloadCubeUnload descarrega um cubo especificado, juntamente com todas as visualizações de cuboassociadas, da memória.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeUnload(CubeName);

Argumento Descrição

CubeName O cubo que você deseja descarregar da memória.

Exemplo

CubeUnload('ManufacturingBudget');

Este exemplo descarrega da memória do servidor o cubo ManufacturingBudget e as visualizaçõesassociadas.

Funções do Turbo Integrator de Reserva de DadosUse as seguintes funções do Turbo Integrator para obter, liberar e gerenciar programaticamenteReservas de Dados.

Para obter mais detalhes sobre como usar o recurso Reserva de dados, consulte "Usando Reservas dedados" na documentação do IBM Cognos TM1 for Developers.

CubeDataReservationAcquireCubeDataReservationAcquire adquire uma Reserva de Dados para o cubo, usuário e tupla especificados.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeDataReservationAcquire(Cube, User, bForce, Address, [AddressDelimiter])

Argumento Descrição

Cubo Nome do cubo.

Capítulo 5. Funções do Turbo Integrator 291

Argumento Descrição

Usuário Nome do proprietário para a nova reserva.

O nome de usuário fornecido será validado para assegurar que ele é umusuário existente.

bForce Valor booleano que determina o comportamento se a reserva solicitada entraem conflito com uma reserva existente.

Se configurado como 0 (false), o pedido será rejeitado se entrar em conflitocom uma reserva existente.

Se estiver configurado como 1 (true) e o usuário executando o processo doTurbo Integrator tiver o recurso DataReservationOverride, as reservasconflitantes serão liberadas e a solicitada será concedida.

Endereço Sequência convertida em token de nomes de elementos que definem a tupla.A ordem deve corresponder à ordem de dimensão original do cubo.

Todas as células no cubo contidas pela tupla constituem a região que estásendo reservada. É possível escolher um elemento de cada dimensão ou usaruma sequência vazia entre os delimitadores para selecionar uma dimensãointeira. Dependendo de onde o elemento está localizado na hierarquia, opedido reserva uma única célula, uma fatia ou o cubo inteiro.

AddressDelimiter Sequência de caracteres opcional que é usada para separar nomes deelementos no parâmetro Address.

O valor padrão é '|'.

Valor de Retorno

Booleano - retorna true se a aquisição foi bem-sucedida.

Exemplo

CubeDataReservationAcquire('DRTestCube','User1',0,'ElemX|ElemY|ElemZ');

O exemplo a seguir configura o parâmetro bForce como 1 para forçar o pedido da DR se um conflito existire usa um caractere delimitador diferente para o parâmetro AddressDelimiter.

CubeDataReservationAcquire('DRTestCube','User2',1,'ElemX*ElemY*ElemZ','*');

CubeDataReservationReleaseCubeDataReservationRelease libera a Reserva de Dados especificada.

Se o usuário especificado não for o mesmo que o proprietário da reserva, a liberação será bem-sucedidaapenas se o usuário especificado tiver o recurso DataReservationOverride ativado.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeDataReservationRelease(Cube, User, Address,[AddressDelimiter])

292 IBM Planning Analytics: Referência do TM1

Argumento Descrição

Cubo Nome do cubo.

Usuário Nome do proprietário da reserva.

O nome de usuário fornecido será validado para assegurar que ele é umusuário existente.

Endereço Sequência convertida em token de nomes de elementos que definem atupla. A ordem deve corresponder à ordem de dimensão original do cubo.

AddressDelimiter Sequência de caracteres opcional que é usada para separar nomes deelementos no parâmetro Address.

O valor padrão é '|'.

Valor de Retorno

Booleano - retorna true se a liberação foi bem-sucedida.

Exemplo

CubeDataReservationRelease('DRTestCube','User1','ElemX|ElemY|ElemZ');

O exemplo a seguir usa um caractere diferente para o parâmetro AddressDelimiter.

CubeDataReservationRelease('DRTestCube','User2','ElemX*ElemY*ElemZ','*');

CubeDataReservationReleaseAllCubeDataReservationReleaseAll libera várias Reservas de Dados existentes.

Todas as reservas totalmente contidas pelo endereço especificado que correspondem ao filtro do usuárioserão liberadas. Um filtro de usuário em branco significa todos os usuários.

Se o filtro de usuário especificado não for o mesmo que o usuário executando o processo do TurboIntegrator, o recurso DataReservationOverride deverá ser ativado.

O uso de um filtro de usuário em branco e de todos os curingas no campo de endereço libera todas asreservas.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeDataReservationReleaseAll(Cube, UserFilter, Address, [AddressDelimiter])

Argumento Descrição

Cubo Nome do cubo.

UserFilter Filtro do nome de usuário para corresponder com relação às reservasexistentes.

Endereço Sequência convertida em token de nomes de elementos que definem a tupla.A ordem deve corresponder à ordem de dimensão original do cubo.

Capítulo 5. Funções do Turbo Integrator 293

Argumento Descrição

AddressDelimiter Sequência de caracteres opcional que é usada para separar nomes deelementos no parâmetro Address.

O valor padrão é '|'.

Valor de Retorno

Booleano - retorna true se não houver nenhum erro.

Exemplo

CubeDataReservationReleaseAll('DRTestCube','User1','ElemX|ElemY|ElemZ');

O exemplo a seguir libera todas as reservas no cubo especificado para todos os usuários.

CubeDataReservationReleaseAll('DRTestCube','','||');

CubeDataReservationGetCubeDataReservationGet localiza reservas existentes em um cubo específico para todos os usuários oupara um usuário.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeDataReservationGet(Index, Cube, User, [AddressDelimiter]) returns Address;

Argumento Descrição

Índice Um índice de loop baseado em um usado para iterar através de reservas nocubo especificado.

Cubo Nome do cubo a procurar.

Usuário Nome do proprietário da reserva para usar como um filtro.

Se deixado em branco, a função retorna reservas para qualquer proprietário.

Se um nome for fornecido, a função filtrará os resultados para obter apenas oproprietário especificado.

AddressDelimiter Sequência de caracteres opcional que é usada para separar nomes deelementos no parâmetro Address retornado.

O valor padrão é '|'.

Valor de Retorno

Address - Data de criação da reserva, nome do proprietário da reserva e endereço do Elemento dareserva. A data de criação vem primeiro, seguido pelo delimitador, seguido pelo ID do usuário, seguidopelo delimitador, seguido pelos IDs dos Elementos separados pelo delimitador na ordem das dimensõesno cubo (ordem original).

Uma sequência vazia é retornada se não há entrada para o índice especificado.

O formato do valor de retorno é:

294 IBM Planning Analytics: Referência do TM1

[creation time][delimiter][owner name][delimiter][element1][delimiter][element2][delimiter]…[elementN]

Por exemplo:

"20100622211601|Fred Bloggs|Element1|Element2|Element3"

Nota: As reservas podem ser alteradas enquanto iteram a lista de reservas, portanto, o uso do índice nãotem garantia de fornecer uma lista completa de reservas. As reservas podem ser incluídas ou removidasem qualquer posição na lista, portanto, as reservas podem ser ignoradas ou repetidas ao fazer loopatravés dos valores de índice.

Se o filtro de proprietário for especificado, o índice se aplicará apenas aos membros da lista filtrada. Se alista de reservas tiver proprietários conforme a seguir: User1, User1, User2 e o pedido especificar umproprietário igual a User2, um índice igual a 1 recuperará o terceiro membro da lista.

Exemplo

CubeDataReservationGet(1,'DRTestCube','User1','*');

CubeDataReservationGet(1,'DRTestCube','');

A amostra a seguir localizará todas as reservas pertencentes ao usuário Fred Bloggs no cubo ExpenseInput e fará "algo útil" com elas:

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 localiza reservas existentes em um cubo específico que entrariam emconflito com o usuário, endereço e tupla especificados.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeDataReservationGetConflicts(Index, Cube, User, Address, [AddressDelimiter])returns ConflictAddress;

Argumento Descrição

Índice Um índice de loop baseado em um usado para iterar através de conflitosque satisfazem esta consulta.

Cubo Nome do cubo a ser procurado

Usuário A consulta procurará reservas que entrarão em conflito com este usuário.

Capítulo 5. Funções do Turbo Integrator 295

Argumento Descrição

Endereço Sequência convertida em token de nomes de elementos que definem atupla. A ordem deve corresponder à ordem de dimensão original do cubo.

AddressDelimiter Sequência de caracteres opcional que é usada para separar nomes deelementos no parâmetro Address.

O valor padrão é '|'.

Valor de Retorno

ConflictAddress - Data de criação da reserva, nome do proprietário da reserva e endereço do Elemento dareserva. A data de criação vem primeiro, seguido pelo delimitador, seguido pelo ID do usuário, seguidopelo delimitador, seguido pelos IDs de Elementos separados pelo delimitador na ordem das dimensõesno cubo (ordem original).

Uma sequência vazia é retornada se não há entrada para o índice especificado.

O formato do valor de retorno é:

[creation time][delimiter][owner name][delimiter][element1][delimiter][element2][delimiter]…[elementN]

Por exemplo:

"20100622211601|Fred Bloggs|Element1|Element2|Element3"

Nota: As reservas podem ser alteradas enquanto iteram a lista de reservas em conflito, portanto, o usodo índice não tem garantia de fornecer uma lista completa de reservas. As reservas podem ser incluídasou removidas em qualquer posição na lista, portanto, as reservas podem ser ignoradas ou repetidas aofazer loop através dos valores de índice.

CubeDRAcquireCubeDRAcquire adquire uma Reserva de Dados para o cubo, o usuário e a tupla especificados. Enquantoo CubeDataReservationAcquire se aplica a dimensões com uma única hierarquia, essa função seaplica a dimensões com uma ou mais hierarquias.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeDRAcquire(Cube, User, bForce, Element-list)

Argumento Descrição

Cubo Nome do cubo.

Usuário Nome do proprietário para a nova reserva.

O nome de usuário fornecido será validado para assegurar que ele é umusuário existente.

296 IBM Planning Analytics: Referência do TM1

Argumento Descrição

bForce Valor booleano que determina o comportamento se a reserva solicitada entraem conflito com uma reserva existente.

Se configurado como 0 (false), o pedido será rejeitado se entrar em conflitocom uma reserva existente.

Se estiver configurado como 1 (true) e o usuário executando o processo doTurbo Integrator tiver o recurso DataReservationOverride, as reservasconflitantes serão liberadas e a solicitada será concedida.

Lista de Elementos As coordenadas são expressas como uma lista de comprimento variável deargumentos de nome de elemento individuais. Cada um dos parâmetros denome de elemento deve ser qualificado para hierarquia. Se a dimensão possuisomente uma hierarquia, use o nome da dimensão. Caso contrário, use onome da hierarquia desejada.

Os elementos são especificados em um formato '<hierarchy>':'<element>',com cada instância separada por uma vírgula.

Valor de Retorno

Booleano - retorna true se a aquisição foi bem-sucedida.

Exemplo

CubeDRAcquire('DRTestCube','User1',0,'Hier1':'ElemX','Hier2':'ElemY','Hier3':'ElemZ');

O exemplo a seguir configura o parâmetro bForce como 1 para forçar o pedido da DR se um conflito existire usa um caractere delimitador diferente para o parâmetro AddressDelimiter.

CubeDRAcquire('DRTestCube','User2',1,'Hier1':'ElemX','Hier2':'ElemY','Hier3':'ElemZ');

CubeDRReleaseCubeDRRelease libera a Reserva de Dados especificada. Enquanto o CubeDataReservationReleasese aplica a dimensões com uma única hierarquia, essa função se aplica a dimensões com uma ou maishierarquias.

Se o usuário especificado não for o mesmo que o proprietário da reserva, a liberação será bem-sucedidaapenas se o usuário especificado tiver o recurso DataReservationOverride ativado.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeDRRelease(Cube, User, Element-list)

Argumento Descrição

Cubo Nome do cubo.

Usuário Nome do proprietário da reserva.

O nome de usuário fornecido será validado para assegurar que ele é umusuário existente.

Capítulo 5. Funções do Turbo Integrator 297

Argumento Descrição

Lista de Elementos As coordenadas são expressas como uma lista de comprimento variável deargumentos de nome de elemento individuais. Cada um dos parâmetros denome de elemento deve ser qualificado para hierarquia. Se a dimensãopossui somente uma hierarquia, use o nome da dimensão. Caso contrário,use o nome da hierarquia desejada.

Os elementos são especificados em um formato '<hierarchy>':'<element>',com cada instância separada por uma vírgula.

Valor de Retorno

Booleano - retorna true se a liberação foi bem-sucedida.

Exemplo

CubeDRRelease('DRTestCube','User1','Hier1':'ElemX','Hier2':'ElemY','Hier3':'ElemZ');

O exemplo a seguir usa um caractere diferente para o parâmetro AddressDelimiter.

CubeDRRelease('DRTestCube','User2','Hier1':'ElemX','Hier2':'ElemY','Hier3':'ElemZ');

CubeDRReleaseAllCubeDRReleaseAll libera várias Reservas de Dados existentes. Enquanto oCubeDataReservationReleaseAll se aplica a dimensões com uma única hierarquia, essa função seaplica a dimensões com uma ou mais hierarquias.

Todas as reservas totalmente contidas pelo endereço especificado que correspondem ao filtro do usuárioserão liberadas. Um filtro de usuário em branco significa todos os usuários.

Se o filtro de usuário especificado não for o mesmo que o usuário executando o processo do TurboIntegrator, o recurso DataReservationOverride deverá ser ativado.

O uso de um filtro de usuário em branco e de todos os curingas no campo de endereço libera todas asreservas.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeDRReleaseAll(Cube, UserFilter, Element-list)

Argumento Descrição

Cubo Nome do cubo.

UserFilter Filtro do nome de usuário para corresponder com relação às reservasexistentes.

Lista de Elementos As coordenadas são expressas como uma lista de comprimento variável deargumentos de nome de elemento individuais. Cada um dos parâmetros denome de elemento deve ser qualificado para hierarquia. Se a dimensãopossui somente uma hierarquia, use o nome da dimensão. Caso contrário,use o nome da hierarquia desejada.

Os elementos são especificados em um formato '<hierarchy>':'<element>',com cada instância separada por uma vírgula.

298 IBM Planning Analytics: Referência do TM1

Valor de Retorno

Booleano - retorna true se não houver nenhum erro.

Exemplo

CubeDRReleaseAll('DRTestCube','User1','Hier1':'ElemX','Hier2':'ElemY','Hier3':'ElemZ');

O exemplo a seguir libera todas as reservas no cubo especificado para todos os usuários.

CubeDRReleaseAll('DRTestCube','','');

CubeDRGetCubeDRGet localiza reservas existentes em um cubo específico para todos ou um usuário. Enquanto oCubeDataReservationGet se aplica a dimensões com uma única hierarquia, essa função se aplica adimensões com uma ou mais hierarquias.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeDRGet(Index, Cube, User, Element-list) returns Address;

Argumento Descrição

Índice Um índice de loop baseado em um usado para iterar através de reservas nocubo especificado.

Cubo Nome do cubo a procurar.

Usuário Nome do proprietário da reserva para usar como um filtro.

Se deixado em branco, a função retorna reservas para qualquer proprietário.

Se um nome for fornecido, a função filtrará os resultados para obter apenas oproprietário especificado.

Lista de Elementos As coordenadas são expressas como uma lista de comprimento variável deargumentos de nome de elemento individuais. Cada um dos parâmetros denome de elemento deve ser qualificado para hierarquia. Se a dimensão possuisomente uma hierarquia, use o nome da dimensão. Caso contrário, use onome da hierarquia desejada.

Os elementos são especificados em um formato '<hierarchy>':'<element>',com cada instância separada por uma vírgula.

Valor de Retorno

Address - Data de criação da reserva, nome do proprietário da reserva e endereço do Elemento dareserva. A data de criação vem primeiro, seguido pelo delimitador, seguido pelo ID do usuário, seguidopelo delimitador, seguido pelos IDs dos Elementos separados pelo delimitador na ordem das dimensõesno cubo (ordem original).

Uma sequência vazia é retornada se não há entrada para o índice especificado.

O formato do valor de retorno é:

[creation time][delimiter][owner name][delimiter][element1][delimiter][element2][delimiter]…[elementN]

Por exemplo:

Capítulo 5. Funções do Turbo Integrator 299

"20100622211601|Fred Bloggs|Element1|Element2|Element3"

Nota: As reservas podem ser alteradas enquanto iteram a lista de reservas, portanto, o uso do índice nãotem garantia de fornecer uma lista completa de reservas. As reservas podem ser incluídas ou removidasem qualquer posição na lista, portanto, as reservas podem ser ignoradas ou repetidas ao fazer loopatravés dos valores de índice.

Se o filtro de proprietário for especificado, o índice se aplicará apenas aos membros da lista filtrada. Se alista de reservas tiver proprietários conforme a seguir: User1, User1, User2 e o pedido especificar umproprietário igual a User2, um índice igual a 1 recuperará o terceiro membro da lista.

Exemplo

CubeDRGet(1,'DRTestCube','User1','*');

CubeDRGet(1,'DRTestCube','');

A amostra a seguir localizará todas as reservas pertencentes ao usuário Fred Bloggs no cubo ExpenseInput e fará "algo útil" com elas:

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 localiza reservas existentes em um cubo específico que entrariam em conflito com ousuário especificado. Enquanto o CubeDataReservationGetConflicts se aplica a dimensões comuma única hierarquia, essa função se aplica a dimensões com uma ou mais hierarquias.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeDRGetConflicts(Index, Cube, User, Element-list) returns ConflictAddress;

Argumento Descrição

Índice Um índice de loop baseado em um usado para iterar através de conflitosque satisfazem esta consulta.

Cubo Nome do cubo a ser procurado

Usuário A consulta procurará reservas que entrarão em conflito com este usuário.

300 IBM Planning Analytics: Referência do TM1

Argumento Descrição

Lista de Elementos As coordenadas são expressas como uma lista de comprimento variável deargumentos de nome de elemento individuais. Cada um dos parâmetros denome de elemento deve ser qualificado para hierarquia. Se a dimensãopossui somente uma hierarquia, use o nome da dimensão. Caso contrário,use o nome da hierarquia desejada.

Os elementos são especificados em um formato '<hierarchy>':'<element>',com cada instância separada por uma vírgula.

Valor de Retorno

ConflictAddress - Data de criação da reserva, nome do proprietário da reserva e endereço do Elemento dareserva. A data de criação vem primeiro, seguido pelo delimitador, seguido pelo ID do usuário, seguidopelo delimitador, seguido pelos IDs de Elementos separados pelo delimitador na ordem das dimensõesno cubo (ordem original).

Uma sequência vazia é retornada se não há entrada para o índice especificado.

O formato do valor de retorno é:

[creation time][delimiter][owner name][delimiter][element1][delimiter][element2][delimiter]…[elementN]

Por exemplo:

"20100622211601|Fred Bloggs|Element1|Element2|Element3"

Nota: As reservas podem ser alteradas enquanto iteram a lista de reservas em conflito, portanto, o usodo índice não tem garantia de fornecer uma lista completa de reservas. As reservas podem ser incluídasou removidas em qualquer posição na lista, portanto, as reservas podem ser ignoradas ou repetidas aofazer loop através dos valores de índice.

Funções Date e Time do TurboIntegratorEstas funções formatam e analisam datas e horas em vários formatos e códigos de idioma.

FormatDateFormatDate formata um valor de data de acordo com um formatador definido com a funçãoNewDateFormatter.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

FormatDate(Date, <Pattern>, <Index>)

Argumento Descrição

Date Um valor de data.

O tipo de valor, serial ou UNIX, deve corresponder ao formatador usado.

Capítulo 5. Funções do Turbo Integrator 301

Argumento Descrição

Pattern Padrão usado para formatação de data.

Consulte http://userguide.icu-project.org/formatparse/datetime para obter umalista completa de sintaxes de formato.

Se uma sequência vazia for passada, o formato será determinado pelo código deidioma com base nos parâmetros FormatterStyle e FormatterType que foramusados com a função NewDateFormatter.

Index Índice retornado por uma chamada para a função NewDateFormatter.

O valor padrão é 0.

Se não existir um formatador de data no índice, o formatador padrão será usadocomo se tivesse sido criado com a seguinte chamada:

NewDateFormatter('', 'Etc/UTC', 'serial', 'medium', 'date')

Exemplo

sDate = FormatDate(18000);

NewDateFormatterNewDateFormatter define um formatador de dados. Ela retorna um índice para ser usado nas funçõesParseDate e FormatDate. Os índices começam em 0 e aumentam de um em um para cada chamada paraNewDateFormat. Os formatadores de data são válidos durante a execução do processo.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

NewDateFormatter(Locale, <TimeZone>, <UseUNIXTime>, <FormatterStyle>, <FormatterType>, <TimeType>)

Argumento Descrição

Locale Código de idioma usado na análise ou na formatação de datas.

Se uma sequência vazia for passada, o código de idioma do sistema operacionalserá usado. Os códigos de idioma são especificados no formatolanguage[_territory][.variant]. Por exemplo, cs_CK é o idioma tcheco e a RepúblicaTcheca.

TimeZone Fuso horário usado para análise ou formatação de datas.

Consulte http://en.wikipedia.org/wiki/List_of_tz_database_time_zones para obteruma lista completa de fusos horários.

Se não especificado, o fuso horário usado é o UTC ('Etc/UTC').

UseUNIXTime Se 'unix' for especificado, os horários serão tratados como milissegundos desde1 de janeiro de 1970. Caso contrário, eles serão tratados no formato serial do TM1.

Observe que apenas as datas posteriores a 1 de janeiro de 1970 podem serprocessadas, mesmo se o formato serial do TM1 for usado.

302 IBM Planning Analytics: Referência do TM1

Argumento Descrição

FormatterStyle Controla o formato de data usado quando um padrão vazio é especificado para asfunções FormatDate ou ParseDate.

Os valores válidos são 'full', 'long', 'medium' ou 'short'.

O padrão é 'medium'.

FormatterType Controla o tipo de formato usado quando um padrão vazio é especificado para asfunções FormatDate ou ParseDate.

Os valores válidos são 'time', 'date' ou 'datetime'.

O padrão é 'date'.

Exemplo

dfUNIX = NewDateFormatter('', 'Etc/UTC', 'unix');

dfStyleFullDateTime = NewDateFormatter('en_us', 'America/Toronto', 'serial', 'full', 'datetime');

ParseDateParseDate analisa uma sequência de datas de acordo com um formatador definido com a funçãoNewDateFormatter.

Um valor de data serial ou UNIX, dependendo do formatador especificado, é retornado. Se a data nãopuder ser analisada, um valor indefinido será retornado. Isso pode ser testado com a função ISUND.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ParseDate (DateString, <Pattern>, <Index>)

Argumento Descrição

DateString Uma sequência de datas.

Pattern Padrão usado para análise de datas.

Consulte http://userguide.icu-project.org/formatparse/datetime para obter umalista completa de sintaxes de formato.

Se uma sequência vazia for passada, o formato será determinado pelo código deidioma com base nos parâmetros FormatterStyle e FormatterType que foramusados com a função NewDateFormatter.

Index Índice retornado por uma chamada para a função NewDateFormatter. O valorpadrão é 0. Se não existir um formatador de data no índice, o formatador padrãoserá usado como se tivesse sido criado com a seguinte chamada:

NewDateFormatter('', 'Etc/UTC', 'serial', 'medium', 'date')

Exemplo

nDate = ParseDate('2011/11/24', 'yyyy/MM/dd');

Capítulo 5. Funções do Turbo Integrator 303

Funções de Manipulação de Dimensões do Turbo IntegratorEstas funções facilitam a manipulação de dimensões.

DimensionCreateDimensionCreate cria uma nova dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

DimensionCreate(DimName);

Argumento Descrição

DimName O nome que você deseja designar à dimensão.

Exemplo

DimensionCreate('Product');

Este exemplo cria a dimensão Produto.

DimensionDeleteAllElementsDimensionDeleteAllElements exclui todos os elementos em uma dimensão. Esta função é útil para recriarhierarquias da dimensão.

Nota: A exclusão de um elemento exclui todos os dados do cubo identificados por esse elemento. Noentanto, se você usar DimensionDeleteAllElements para excluir elementos, em seguida, recriar esseselementos com os mesmos nomes na guia Metadados, os pontos de dados em um cubo identificadopelos elementos ficarão retidos após a reconstrução da dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

DimensionDeleteAllElements(DimName);

Argumento Descrição

DimName O nome da dimensão da qual você deseja excluirtodos os elementos.

Exemplo

DimensionDeleteAllElements('Model');

Este exemplo exclui todos os elementos na dimensão do Modelo.

DimensionDeleteElementsDimensionDeleteElements exclui todos os elementos de uma dimensão usando o subconjunto deelementos. Todos os elementos no subconjunto referenciado são excluídos, incluindo os elementos denível C.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

304 IBM Planning Analytics: Referência do TM1

Sintaxe

DimensionDeleteElements (DimensionName, Subconjunto)

Argumento Descrição

DimensionName O nome da dimensão da qual deseja excluir osubconjunto de elementos.

Subconjunto A lista de elementos a serem excluídos dadimensão indicada. O subconjunto é normalmentetemporário.

DimensionDestroyDimensionDestroy exclui uma dimensão do banco de dados do TM1.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

DimensionDestroy(DimName);

Argumento Descrição

DimName O nome da dimensão que você deseja excluir.

Exemplo

DimensionDestroy('Product');

Este exemplo exclui a dimensão Produto do banco de dados do TM1.

DimensionElementComponentAddDimensionElementComponentAdd inclui um componente (filho) em um elemento consolidado. Não épossível usar esta função no procedimento Epílogo de um processo do Turbo Integrator.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

DimensionElementComponentAdd(DimName, ConsolidatedElName,ElName, ElWeight);

Argumento Descrição

DimName A dimensão-pai do elemento consolidado no qualvocê deseja incluir um filho.

ConsolidatedElName O elemento no qual você deseja incluir um filho.

ElName O nome do elemento filho.

ElWeight O peso do elemento filho.

Capítulo 5. Funções do Turbo Integrator 305

Exemplo

DimensionElementComponentAdd('Measures', 'Net Sales', 'Expenses',-1);

Este exemplo inclui o filho Despesas na consolidação Vendas Líquidas na dimensão das Medidas. O filhotem um peso de -1 na consolidação.

DimensionElementComponentAddDirectDimensionElementComponentAddDirect inclui um componente (filho) para um elemento consolidadoeditando uma dimensão diretamente.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

A maneira padrão de editar uma dimensão no TM1 é usar um padrão de edição de cópia completa. Nessepadrão, uma cópia de edição da dimensão é criada, as edições são aplicadas à cópia de edição e, emseguida, finalmente a dimensão real é regravada usando a cópia de edição como um modelo. OTurboIntegrator suporta edição de cópia inteira automaticamente sempre que a edição de funções doTurboIntegrator (como DimensionElementComponentAdd) é usada no procedimento de Metadados doprocesso. O TurboIntegrator cria automaticamente a cópia de edição e aplica nela as operações deedição, em seguida, regrava a dimensão real no fim do procedimento de Metadados.

As edições diretas são diferentes porque nenhuma cópia de edição é envolvida. Em vez disso, asoperações são executadas diretamente na dimensão real. Existem dois casos de uso especializadosdiferentes para os quais esse tipo de edição direta é destinado:

• Quando o propósito do processo TurboIntegrator for fazer uma pequena mudança em uma grandedimensão. Nesse caso, a edição direta será mais eficiente porque evita copiar e regravarcompletamente a dimensão grande.

• Quando o propósito do processo TurboIntegrator for carregar grandes volumes de dados em um cubo.Nesse caso, o procedimento de Metadados do processo é deliberadamente mantido vazio e qualquermodificação de elemento necessária para suportar o carregamento de dados é executado usando aschamadas diretas no procedimento de Dados. Quando o procedimento de Metadados ficar vazio, oprocesso ignorará uma iteração inteira sobre a origem de dados externa, que pode resultar emcarregamentos de dados mais rápidos.

Sintaxe

DimensionElementComponentAddDirect(DimName, ConsolidatedElName,ElName, ElWeight);

Argumento Descrição

DimName A dimensão-pai do elemento consolidado no qualvocê deseja incluir um filho.

ConsolidatedElName O elemento consolidado ao qual você deseja incluirum filho.

ElName O nome do elemento filho.

ElWeight O peso do elemento filho.

Exemplo

DimensionElementComponentAddDirect('Measures', 'Net Sales', 'Expenses', -1);

Este exemplo inclui o filho Despesas na consolidação Vendas Líquidas na dimensão das Medidas. O filhotem um peso de -1 na consolidação.

306 IBM Planning Analytics: Referência do TM1

DimensionElementComponentDeleteDimensionElementComponentDelete exclui um componente (filho) de um elemento consolidado.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

DimensionElementComponentDelete(DimName, ConsolidatedElName,ElName);

Argumento Descrição

DimName A dimensão-pai do elemento consolidado do qualvocê deseja excluir um filho.

ConsolidatedElName O elemento consolidado do qual você desejaexcluir um filho.

ElName O nome do elemento filho que você deseja excluir.

Exemplo

DimensionElementComponentDelete('Region', 'Benelux', 'Belgium');

Este exemplo exclui o filho Bélgica da consolidação Benelux na dimensão Região.

DimensionElementComponentDeleteDirectDimensionElementComponentDeleteDirect exclui um componente (filho) de um elemento consolidado,editando diretamente a dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

A maneira padrão de editar uma dimensão no TM1 é usar um padrão de edição de cópia completa. Nessepadrão, uma cópia de edição da dimensão é criada, as edições são aplicadas à cópia de edição e, emseguida, finalmente a dimensão real é regravada usando a cópia de edição como um modelo. OTurboIntegrator suporta edição de cópia inteira automaticamente sempre que a edição de funções doTurboIntegrator (como DimensionElementComponentDelete) é usada no procedimento de Metadados doprocesso. O TurboIntegrator cria automaticamente a cópia de edição e aplica nela as operações deedição, em seguida, regrava a dimensão real no fim do procedimento de Metadados.

As edições diretas são diferentes porque nenhuma cópia de edição é envolvida. Em vez disso, asoperações são executadas diretamente na dimensão real. Existem dois casos de uso especializadosdiferentes para os quais esse tipo de edição direta é destinado:

• Quando o propósito do processo TurboIntegrator for fazer uma pequena mudança em uma grandedimensão. Nesse caso, a edição direta será mais eficiente porque evita copiar e regravarcompletamente a dimensão grande.

• Quando o propósito do processo TurboIntegrator for carregar grandes volumes de dados em um cubo.Nesse caso, o procedimento de Metadados do processo é deliberadamente mantido vazio e qualquermodificação de elemento necessária para suportar o carregamento de dados é executado usando aschamadas diretas no procedimento de Dados. Quando o procedimento de Metadados ficar vazio, oprocesso ignorará uma iteração inteira sobre a origem de dados externa, que pode resultar emcarregamentos de dados mais rápidos.

Sintaxe

DimensionElementComponentDeleteDirect(DimName, ConsolidatedElName,ElName);

Capítulo 5. Funções do Turbo Integrator 307

Argumento Descrição

DimName A dimensão-pai do elemento consolidado do qualvocê deseja excluir um filho.

ConsolidatedElName O elemento consolidado do qual você desejaexcluir um filho.

ElName O nome do elemento filho que você deseja excluir.

Exemplo

DimensionElementComponentDeleteDirect('Region', 'Benelux','Belgium');

Este exemplo exclui o filho Bélgica da consolidação Benelux na dimensão Região.

DimensionElementDeleteDimensionElementDelete exclui um elemento de uma dimensão.

Nota: A exclusão de um elemento exclui todos os dados do cubo identificados por esse elemento.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

DimensionElementDelete(DimName, ElName);

Argumento Descrição

DimName A dimensão que contém o elemento que vocêdeseja excluir.

ElName O elemento que você deseja excluir.

Exemplo

DimensionElementDelete('Region', 'Belgium');

Este exemplo exclui o elemento Bélgica da dimensão Região.

DimensionElementDeleteDirectDimensionElementDeleteDirect exclui um elemento de uma dimensão, editando diretamente a dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Nota: A exclusão de um elemento exclui todos os dados do cubo identificados por esse elemento.

A maneira padrão de editar uma dimensão no TM1 é usar um padrão de edição de cópia completa. Nessepadrão, uma cópia de edição da dimensão é criada, as edições são aplicadas à cópia de edição e, emseguida, finalmente a dimensão real é regravada usando a cópia de edição como um modelo. OTurboIntegrator suporta edição de cópia inteira automaticamente sempre que a edição de funções doTurboIntegrator (como DimensionElementDelete) é usada no procedimento de Metadados OTurboIntegrator cria automaticamente a cópia de edição e aplica nela as operações de edição, emseguida, regrava a dimensão real no fim do procedimento de Metadados.

As edições diretas são diferentes porque nenhuma cópia de edição é envolvida. Em vez disso, asoperações são executadas diretamente na dimensão real. Existem dois casos de uso especializadosdiferentes para os quais esse tipo de edição direta é destinado:

308 IBM Planning Analytics: Referência do TM1

• Quando o propósito do processo TurboIntegrator for fazer uma pequena mudança em uma grandedimensão. Nesse caso, a edição direta será mais eficiente porque evita copiar e regravarcompletamente a dimensão grande.

• Quando o propósito do processo TurboIntegrator for carregar grandes volumes de dados em um cubo.Nesse caso, o procedimento de Metadados do processo é deliberadamente mantido vazio e qualquermodificação de elemento necessária para suportar o carregamento de dados é executado usando aschamadas diretas no procedimento de Dados. Quando o procedimento de Metadados ficar vazio, oprocesso ignorará uma iteração inteira sobre a origem de dados externa, que pode resultar emcarregamentos de dados mais rápidos.

Sintaxe

DimensionElementDeleteDirect(DimName, ElName);

Argumento Descrição

DimName A dimensão que contém o elemento que vocêdeseja excluir.

ElName O elemento que você deseja excluir.

Exemplo

DimensionElementDeleteDirect('Region', 'Belgium');

Este exemplo exclui o elemento Bélgica da dimensão Região.

DimensionElementExistsDimensionElementExists determina se um elemento específico existe em uma dimensão no servidor apartir do qual um processo do Turbo Integrator é executado. A função retorna 1 se o elemento existir nadimensão no servidor, caso contrário, retorna 0.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

DimensionElementExists(DimName, ElName);

Argumento Descrição

DimName A dimensão que contém o elemento que vocêdeseja localizar. A dimensão deve existir noservidor no qual o processo do Turbo Integrator éexecutado.

ElName O elemento que você deseja localizar.

Exemplo

Este exemplo determina se o elemento Belgium existe na dimensão Region no servidor.

DimensionElementExists('Region', 'Belgium');

Capítulo 5. Funções do Turbo Integrator 309

DimensionElementInsertDimensionElementInsert inclui um elemento em uma dimensão. Esta função pode ser usada para incluirelementos numéricos, de sequência ou consolidados. Não é possível usar essa função nos procedimentosde Dados ou de Epílogo de um processo do Turbo Integrator.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

DimensionElementInsert(DimName, InsertionPoint, ElName,ElType);

Argumento Descrição

DimName A dimensão na qual o elemento será incluído.

InsertionPoint Um elemento de dimensão existente. O elementoque está sendo incluído na dimensão será inseridoimediatamente antes deste elemento existente. Seeste parâmetro for uma sequência vazia (''), o novoelemento será incluído ao final da dimensão.

ElName O nome que será designado ao novo elemento.

ElType O tipo de elemento. Existem três possíveis valoresElType:

N - Significa um elemento numérico.

S - Significa um elemento de sequência.

C - Significa um elemento consolidado.

Exemplo

DimensionElementInsert('Region','Belgium','Netherlands','S');

Este exemplo inclui o elemento de sequência Netherlands na dimensão Região. Netherlands é incluídoimediatamente antes da Belgium na dimensão.

Exemplo com um ponto de inserção vazio

DimensionElementInsert('Region','','Netherlands','S');

Este exemplo inclui o elemento de sequência Netherlands na dimensão Região. Netherlands é incluído aofinal da dimensão.

DimensionElementInsertDirectDimensionElementInsertDirect inclui um elemento em uma dimensão, editando diretamente a dimensão.Esta função pode ser usada para incluir elementos numéricos, de sequência ou consolidados.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

O método padrão para editar uma dimensão no TM1 é usando um padrão de edição de cópia inteira.Nesse padrão, uma cópia de edição da dimensão é criada, as edições são aplicadas à cópia de edição e,em seguida, finalmente a dimensão real é regravada usando a cópia de edição como um modelo. OTurboIntegrator suporta a edição de cópia inteira sempre que a dimensão que edita as funçõesTurboIntegrator (como DimensionElementInsert) for usada na guia de metadados do processo. OTurboIntegrator cria automaticamente a cópia de edição e aplica nela as operações de edição, emseguida, regrava a dimensão real no fim do procedimento de Metadados.

310 IBM Planning Analytics: Referência do TM1

As edições diretas são diferentes porque nenhuma cópia de edição é envolvida. Em vez disso, asoperações são executadas diretamente na dimensão real. Existem dois casos de uso especializadosdiferentes para os quais esse tipo de edição direta é destinado:

• Quando o propósito do processo TurboIntegrator for fazer uma pequena mudança em uma grandedimensão. Nesse caso, a edição direta será mais eficiente porque evita copiar e regravarcompletamente a dimensão grande.

• Quando o propósito do processo TurboIntegrator for carregar grandes volumes de dados em um cubo.Nesse caso, o procedimento de Metadados do processo é deliberadamente mantido vazio e qualquerinserção de elemento necessária para suportar o carregamento de dados é executado usando aschamadas diretas no procedimento de Dados. Quando o procedimento de Metadados ficar vazio, oprocesso ignorará uma iteração inteira sobre a origem de dados externa, que pode resultar emcarregamentos de dados mais rápidos.

Sintaxe

DimensionElementInsertDirect(DimName, InsertionPoint, ElName,ElType);

Argumento Descrição

DimName A dimensão na qual você deseja incluir um novoelemento.

InsertionPoint Um elemento de dimensão existente. O elementoque está sendo incluído na dimensão será inseridoimediatamente antes deste elemento existente. Seeste parâmetro estiver vazio, o novo elemento seráincluído no final da dimensão.

Observe que esta função é otimizada para o casoem que o InsertionPoint é passado como umasequência vazia.

ElName O nome que você deseja designar ao novoelemento.

ElType O tipo de elemento. Existem três possíveis valoresElType:

N - Significa um elemento numérico.

S - Significa um elemento de sequência.

C - Significa um elemento consolidado.

Exemplo

DimensionElementInsertDirect('Region', 'Belgium', 'Netherlands','N');

Este exemplo inclui o elemento numérico Países Baixos na dimensão Região. Países Baixos é exibidoimediatamente antes de Bélgica na definição de dimensão.

DimensionElementPrincipalNameDimensionElementPrincipalName retorna o nome principal de um elemento ou alias de elemento.

O Turbo Integrator deve usar nomes de elementos principais ao atualizar dimensões; os aliases deelementos não podem ser usados. Essa função é útil para determinar os nomes de elementos principaisao tentar atualizar uma dimensão quando apenas os aliases de elemento estão disponíveis para oprocesso do Turbo Integrator.

Capítulo 5. Funções do Turbo Integrator 311

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

DimensionElementPrincipalName( DimName, ElName )

Argumento Descrição

DimName O nome da dimensão da qual você desejarecuperar um nome de elemento principal.

ElName Um nome de elemento. ElName pode ser um aliasde elemento ou um nome de elemento principal.

Exemplo

Se ElName não estiver na versão salva de DimName, a função retornará ElName.

Se ElName estiver em DimName, se como um alias de elemento ou como um nome de elementoprincipal, será retornado o nome principal do elemento.

DimensionExistsDimensionExists determina se uma dimensão específica existe no servidor a partir do qual um processodo Turbo Integrator é executado. A função retornará 1 se a dimensão existir no servidor, caso contrário,retornará 0.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

DimensionExists(DimName);

Argumento Descrição

DimName O nome da dimensão cuja existência você desejaconfirmar.

Exemplo

DimensionExists('Region');

Este exemplo determina se a dimensão Região existe no servidor.

DimensionHierarchyCreateDimensionHierarchyCreate cria uma nova hierarquia em uma dimensão existente. A hierarquia não podeter o mesmo nome que a dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

DimensionHierarchyCreate(DimName, HierName);

312 IBM Planning Analytics: Referência do TM1

Argumento Descrição

DimName O nome da dimensão existente que conterá ahierarquia.

HierName O nome a ser designado para a hierarquia. Não épossível usar o nome da dimensão.

Exemplo

DimensionHierarchyCreate('Vehicles', 'Trucks');

Este exemplo cria a hierarquia Trucks vazia na dimensão Vehicles.

DimensionSortOrderDimensionSortOrder configura um tipo e uma direção de classificação para elementos de dimensão ecomponentes de elementos consolidados dentro de uma dimensão. A ordem de classificação definida porDimensionSortOrder determina como o subconjunto é exibido no Editor de Subconjunto.

DimensionSortOrder define propriedades para uma dimensão, a dimensão não é de fato armazenada atéque seja salva no servidor.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

DimensionSortOrder(DimName, CompSortType, CompSortSense, ElSortType , ElSortSense);

Argumento Descrição

DimName O nome da dimensão para a qual você desejadefinir uma ordem de classificação.

CompSortType Define como os componentes de elementosconsolidados aparecem na dimensão. Existem doisvalores CompSortType:

ByInput - Retém a ordem em que os componentesforam inseridos originalmente em consolidações.

ByName - Classifica componentes deconsolidações por nome.

CompSortSense Define a direção de classificação paracomponentes de consolidações. Este é umargumento necessário, mas é aplicável apenasquando CompSortType é ByName. Existem doispossíveis valores CompSortSense:

Ascending - Classifica componentes deconsolidações em ordem alfabética crescente.

Descending - Classifica componentes deconsolidações em ordem alfabética decrescente.

Capítulo 5. Funções do Turbo Integrator 313

Argumento Descrição

ElSortType Define uma ordem de classificação para elementosde dimensão. Existem quatro possíveis valoresElSortType:

ByInput - Retém a ordem em que os elementosforam originalmente inseridos na dimensão.

ByName - Classifica elementos de dimensão pornome.

ByLevel - Classifica elementos de dimensão pornível.

ByHierarchy - Classifica elementos de dimensãopor hierarquia.

ElSortSense Define a direção de classificação para elementosde dimensão. Este é um argumento necessário,mas é aplicável apenas quando ElSortType éByName ou ByLevel. Existem dois possíveisvalores ElSortSense:

Ascending - Classifica elementos de dimensão emordem crescente, em ordem alfabética ou pornível.

Descending - Classifica elementos de dimensãoem ordem decrescente, em ordem alfabética oupor nível.

Exemplo

DimensionSortOrder ('Region', 'ByName', 'Descending', 'ByLevel','Ascending');

Este exemplo define uma ordem de classificação para a dimensão Região. Todos os elementos dedimensão são classificados por nível em ordem crescente e quaisquer componentes de consolidaçõessão classificados em ordem alfabética decrescente.

DimensionTimeLastUpdatedDimensionTimeLastUpdated retorna um valor de série que indica a data e hora em que uma dimensãoespecificada foi atualizada pela última vez.

O valor de série retornado por esta função usa um horário de início de 1 de janeiro de 1900, 0h, que éequivalente ao valor 1.0. As datas são representadas por números inteiros, enquanto os horários sãorepresentados como números decimais entre .0 e .999999. Isso é consistente com a maneira como osvalores de série de data/hora são armazenados e relatados no Microsoft Excel.

Nota: Por padrão, os valores de série de data/hora do TM1 usam um horário de início de 1 de janeiro de1960, 0h. Para resolver a inconsistência entre os valores de série de data/hora do Excel e do TM1, épossível configurar UseExcelSerialDate=T em seu arquivo Tm1s.cfg para instruir o servidor TM1 ausar valores de séries de data/hora que estão em conformidade com os padrões do Excel.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

DimensionTimeLastUpdated(dimension);

314 IBM Planning Analytics: Referência do TM1

Argumento Descrição

dimensão O nome da dimensão.

Exemplo

DimensionTimeLastUpdated('Region');

Este exemplo retorna informações sobre quando a dimensão Region foi atualizada pela última vez.

DimensionTopElementInsertDimensionTopElementInsert cria um elemento raiz em uma dimensão. Se a dimensão já tiver uma únicaraiz, esse elemento não será criado.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

DimensionTopElementInsert(DimName, InsertionPoint, ElName);

Argumento Descrição

DimName A dimensão para a qual você deseja criar umelemento-raiz.

InsertionPoint Um elemento de dimensão existente. O elemento-raiz que está sendo incluído na dimensão seráinserido imediatamente antes deste elementoexistente.

ElName O nome que você deseja designar ao novoelemento-raiz.

Exemplo

DimensionTopElementInsert('Region', 'Netherlands', 'World');

Este exemplo inclui o elemento-raiz Mundo na dimensão Região. World é inserido imediatamente antesde Netherlands na definição de dimensão.

DimensionTopElementInsertDirectDimensionTopElementInsertDirect cria um elemento raiz em uma dimensão, editando diretamente adimensão. Se a dimensão já tiver uma única raiz, esse elemento não será criado.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

A maneira padrão de editar uma dimensão no TM1 é usar um padrão de edição de cópia completa. Nessepadrão, uma cópia de edição da dimensão é criada, as edições são aplicadas à cópia de edição e, emseguida, finalmente a dimensão real é regravada usando a cópia de edição como um modelo. OTurboIntegrator suporta edição de cópia inteira automaticamente sempre que a edição de funções doTurboIntegrator (como DimensionTopElementInsert) é usada no procedimento de Metadados doprocesso. O TurboIntegrator cria automaticamente a cópia de edição e aplica nela as operações deedição, em seguida, regrava a dimensão real no fim do procedimento de Metadados.

As edições diretas são diferentes porque nenhuma cópia de edição é envolvida. Em vez disso, asoperações são executadas diretamente na dimensão real. Existem dois casos de uso especializadosdiferentes para os quais esse tipo de edição direta é destinado:

Capítulo 5. Funções do Turbo Integrator 315

• Quando o propósito do processo TurboIntegrator for fazer uma pequena mudança em uma grandedimensão. Nesse caso, a edição direta será mais eficiente porque evita copiar e regravarcompletamente a dimensão grande.

• Quando o propósito do processo TurboIntegrator for carregar grandes volumes de dados em um cubo.Nesse caso, o procedimento de Metadados do processo é deliberadamente mantido vazio e qualquermodificação de elemento necessária para suportar o carregamento de dados é executado usando aschamadas diretas no procedimento de Dados. Quando o procedimento de Metadados ficar vazio, oprocesso ignorará uma iteração inteira sobre a origem de dados externa, que pode resultar emcarregamentos de dados mais rápidos.

Sintaxe

DimensionTopElementInsertDirect(DimName, InsertionPoint, ElName);

Argumento Descrição

DimName A dimensão para a qual você deseja criar umelemento-raiz.

InsertionPoint Um elemento de dimensão existente. O elemento-raiz que está sendo incluído na dimensão seráinserido imediatamente antes deste elementoexistente.

ElName O nome que você deseja designar ao novoelemento-raiz.

Exemplo

DimensionTopElementInsertDirect('Region', 'Netherlands', 'World');

Este exemplo inclui o elemento-raiz Mundo na dimensão Região. World é inserido imediatamente antesde Netherlands na definição de dimensão.

DimensionUpdateDirectDimensionUpdateDirect executa uma regravação completa de uma dimensão que passou por ediçãodireta em um processo do Turbo Integrator, compactando essencialmente a área de cobertura damemória da dimensão.

Uma dimensão que passa por uma série de edições de direção apenas (exclusões de elemento, emespecífico) usarão eventualmente mais memória do que sua contraparte totalmente regravada usaria.Opcionalmente, esta função pode ser usada após editar uma dimensão comDimensionElementInsertDirect, DimensionElementDeleteDirect,DimensionElementComponentAddDirect, DimensionElementComponentDeleteDirect e/ouDimensionTopElementInsertDirect. Chamar DimensionUpdateDirect incorre em um custo de memória decópia completa inicial; embora possa ser usado para garantir que a dimensão fique na menor área decobertura da memória possível depois que o processamento for concluído.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

DimensionUpdateDirect(DimName);

316 IBM Planning Analytics: Referência do TM1

Argumento Descrição

DimName O nome da dimensão que você deseja regravar.

Exemplo

DimensionUpdateDirect('Region');

Este exemplo regrava a dimensão da Região.

Funções do TurboIntegrator para manipulação de hierarquiaEssas funções facilitam a manipulação de hierarquia.

HierarchyContainsAllLeavesHierarchyContainsAllLeaves retorna true apenas caso a hierarquia especificada contenha o conjuntocompleto de elementos folha que estão presentes na dimensão. Ou seja, ela contém todos os elementosfolha que podem ser vistos na hierarquia especial Folhas. Se um ou mais elementos folha estiveremausentes da hierarquia especificada, essa função retornará false false.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchyContainsAllLeaves(DimName, HierName);

Argumento Descrição

DimName O nome da dimensão que contém a hierarquia detodas as folhas.

HierName O nome da hierarquia que você está determinandocomo uma hierarquia de todas as folhas.

Exemplo

HierarchyContainsAllLeaves('Region', 'Leaves');

Este exemplo determina se a hierarquia Folhas, na dimensão Região, contém todos os membros da folha.

HierarchyCreateHierarchyCreate cria uma nova hierarquia em uma dimensão existente. A hierarquia não pode ter omesmo nome que a dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchyCreate(DimName, HierName);

Argumento Descrição

DimName O nome da dimensão existente que conterá ahierarquia.

Capítulo 5. Funções do Turbo Integrator 317

Argumento Descrição

HierName O nome que deseja designar à hierarquia. Não épossível usar o nome da dimensão.

Exemplo

HierarchyCreate('Vehicles', 'Trucks');

Este exemplo cria a hierarquia Trucks vazia na dimensão Vehicles.

HierarchyDeleteAllElementsHierarchyDeleteAllElements exclui todos os elementos em uma hierarquia. Esta função é útil para recriarhierarquias da dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchyDeleteAllElements(DimName, HierName);

Argumento Descrição

DimName O nome da dimensão da qual você deseja excluirtodos os elementos.

HierName O nome da hierarquia dentro da dimensão.

Exemplo

HierarchyDeleteAllElements('Equipment','Helmets');

Este exemplo exclui todos os elementos na hierarquia Helmets na dimensão Equipment.

ExcluirElementos da HierarchyDeleteElementsHierarchyDeleteElements exclui elementos folha de uma hierarquia usando um subconjunto deelementos.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchyDeleteElements (DimensionName, HierarchyName, Subconjunto)

Argumento Descrição

DimensionName O nome da dimensão da qual deseja excluir osubconjunto de elementos.

318 IBM Planning Analytics: Referência do TM1

Argumento Descrição

NomeHierarquia O nome da hierarquia da qual você deseja excluir osubconjunto de elementos.

Se a hierarquia indicada for a hierarquia Folhas, osubconjunto deve listar as folhas que devem serexcluídas e elas serão completamente removidasda dimensão.

Subconjunto A lista de elementos a serem excluídos dahierarquia indicada. O subconjunto é normalmentetemporário.

HierarchyDestroyHierarchyDestroy exclui uma hierarquia do banco de dados do TM1.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchyDestroy(DimName, HierName);

Argumento Descrição

DimName O nome da dimensão que contém a hierarquia.

HierName O nome da hierarquia que deseja excluir.

Exemplo

HierarchyDestroy('Product','Transmissions');

Este exemplo exclui a hierarquia Transmissões do banco de dados do TM1.

HierarchyElementComponentAddHierarchyElementComponentAdd inclui um componente (filho) em um elemento consolidado. Não épossível usar esta função no procedimento Epílogo de um processo do Turbo Integrator.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchyElementComponentAdd(DimName, HierName, ConsolidatedElName, ElName, ElWeight);

Argumento Descrição

DimName A dimensão-pai do elemento consolidado no qualvocê deseja incluir um filho.

HierName A hierarquia da dimensão especificada.

ConsolidatedElName O elemento no qual você deseja incluir um filho.

ElName O nome do elemento filho.

Capítulo 5. Funções do Turbo Integrator 319

Argumento Descrição

ElWeight O peso do elemento filho.

ExemploHierarchyElementComponentAdd('Measures', 'Europe', 'Net Sales', 'Expenses',-1);

Este exemplo inclui o filho Expenses na consolidação Net Sales na hierarquia Europe da dimensãoMeasures. O filho tem um peso de -1 na consolidação.

HierarchyElementComponentAddDirectHierarchyElementComponentAddDirect inclui um componente (filho) em um elemento consolidadoeditando uma dimensão diretamente.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

O método padrão para editar uma dimensão no Cognos TM1 é usando um padrão de edição de cópiainteira. Nesse padrão, uma cópia de edição da dimensão é criada, as edições são aplicadas à cópia deedição e, em seguida, finalmente a dimensão real é regravada usando a cópia de edição como ummodelo. O Turbo Integrator suporta a edição de cópia inteira automaticamente sempre que as funções deedição de dimensão do Turbo Integrator (como HierarchyElementComponentAdd) são usadas noprocedimento de Metadados do processo. O TurboIntegrator cria automaticamente a cópia de edição eaplica nela as operações de edição, em seguida, regrava a dimensão real no fim do procedimento deMetadados.

As edições diretas são diferentes porque nenhuma cópia de edição é envolvida. Em vez disso, asoperações são executadas diretamente na dimensão real. Existem dois casos de uso especializadosdiferentes para os quais esse tipo de edição direta é destinado:

• Quando o propósito do processo TurboIntegrator for fazer uma pequena mudança em uma grandedimensão. Nesse caso, a edição direta será mais eficiente porque evita copiar e regravarcompletamente a dimensão grande.

• Quando o propósito do processo TurboIntegrator for carregar grandes volumes de dados em um cubo.Nesse caso, o procedimento de Metadados do processo é deliberadamente mantido vazio e qualquermodificação de elemento necessária para suportar o carregamento de dados é executado usando aschamadas diretas no procedimento de Dados. Quando o procedimento de Metadados ficar vazio, oprocesso ignorará uma iteração inteira sobre a origem de dados externa, que pode resultar emcarregamentos de dados mais rápidos.

Sintaxe

HierarchyElementComponentAddDirect(DimName, HierName, ConsolidatedElName, ElName, ElWeight);

Argumento Descrição

DimName A dimensão-pai do elemento consolidado no qualvocê deseja incluir um filho.

HierName A hierarquia da dimensão especificada.

ConsolidatedElName O elemento consolidado ao qual você deseja incluirum filho.

ElName O nome do elemento filho.

320 IBM Planning Analytics: Referência do TM1

Argumento Descrição

ElWeight O peso do elemento filho.

ExemploHierarchyElementComponentAddDirect('Measures', 'Europe', 'Net Sales','Expenses', -1);

Este exemplo inclui o filho Expenses na consolidação Net Sales na hierarquia Europe da dimensãoMeasures. O filho tem um peso de -1 na consolidação.

HierarchyElementComponentDeleteHierarchyElementComponentDelete exclui um componente (filho) de um elemento consolidado.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchyElementComponentDelete(DimName, HierName, ConsolidatedElName, ElName);

Argumento Descrição

DimName A dimensão-pai do elemento consolidado do qualvocê deseja excluir um filho.

HierName O nome da hierarquia dentro da dimensão.

ConsolidatedElName O elemento consolidado do qual você desejaexcluir um filho.

ElName O nome do elemento filho que você deseja excluir.

Exemplo

HierarchyElementComponentDelete('Region', 'Western', 'Benelux', 'Belgium');

Este exemplo exclui o filho Belgium da consolidação Benelux na hierarquia Western da dimensão Region.

HierarchyElementComponentDeleteDirectHierarchyElementComponentDeleteDirect exclui um componente (filho) de um elemento consolidado,editando diretamente a dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

O método padrão para editar uma dimensão no TM1 é usando um padrão de edição de cópia inteira.Nesse padrão, uma cópia de edição da dimensão é criada, as edições são aplicadas à cópia de edição e,em seguida, finalmente a dimensão real é regravada usando a cópia de edição como um modelo. O TurboIntegrator suporta a edição de cópia inteira automaticamente sempre que a edição de funções do TurboIntegrator (como HierarchyElementComponentDelete) é usada no procedimento de Metadados doprocesso. O TurboIntegrator cria automaticamente a cópia de edição e aplica nela as operações deedição, em seguida, regrava a dimensão real no fim do procedimento de Metadados.

As edições diretas são diferentes porque nenhuma cópia de edição é envolvida. Em vez disso, asoperações são executadas diretamente na dimensão real. Existem dois casos de uso especializadosdiferentes para os quais esse tipo de edição direta é destinado:

Capítulo 5. Funções do Turbo Integrator 321

• Quando o propósito do processo TurboIntegrator for fazer uma pequena mudança em uma grandedimensão. Nesse caso, a edição direta será mais eficiente porque evita copiar e regravarcompletamente a dimensão grande.

• Quando o propósito do processo TurboIntegrator for carregar grandes volumes de dados em um cubo.Nesse caso, o procedimento de Metadados do processo é deliberadamente mantido vazio e qualquermodificação de elemento necessária para suportar o carregamento de dados é executado usando aschamadas diretas no procedimento de Dados. Quando o procedimento de Metadados ficar vazio, oprocesso ignorará uma iteração inteira sobre a origem de dados externa, que pode resultar emcarregamentos de dados mais rápidos.

Sintaxe

HierarchyElementComponentDeleteDirect(DimName, HierName, ConsolidatedElName, ElName);

Argumento Descrição

DimName A dimensão-pai do elemento consolidado do qualvocê deseja excluir um filho.

HierName O nome da hierarquia dentro da dimensão.

ConsolidatedElName O elemento consolidado do qual você desejaexcluir um filho.

ElName O nome do elemento filho que você deseja excluir.

Exemplo

HierarchyElementComponentDeleteDirect('Region', 'Western', 'Benelux', 'Belgium');

Este exemplo exclui o filho Belgium da consolidação Benelux na hierarquia Western da dimensão Region.

HierarchyElementDeleteHierarchyElementDelete exclui um elemento de uma hierarquia.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchyElementDelete(DimName, HierName, ElName);

Argumento Descrição

DimName A dimensão que contém o elemento que vocêdeseja excluir.

HierName O nome da hierarquia dentro da dimensão.

ElName O elemento a ser excluído da hierarquia.

Exemplo

HierarchyElementDelete('Region', 'Western', 'Belgium');

Este exemplo exclui o elemento Belgium da hierarquia Western na dimensão Region.

322 IBM Planning Analytics: Referência do TM1

HierarchyElementDeleteDirectHierarchyElementDeleteDirect exclui um elemento de uma dimensão, editando diretamente a dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Nota: A exclusão de um elemento exclui todos os dados do cubo identificados por esse elemento.

A maneira padrão de editar uma dimensão no TM1 é usar um padrão de edição de cópia completa. Nessepadrão, uma cópia de edição da dimensão é criada, as edições são aplicadas à cópia de edição e, emseguida, finalmente a dimensão real é regravada usando a cópia de edição como um modelo. OTurboIntegrator suporta edição de cópia inteira automaticamente sempre que a edição de funções doTurboIntegrator (como DimensionElementDelete) é usada no procedimento de Metadados OTurboIntegrator cria automaticamente a cópia de edição e aplica nela as operações de edição, emseguida, regrava a dimensão real no fim do procedimento de Metadados.

As edições diretas são diferentes porque nenhuma cópia de edição é envolvida. Em vez disso, asoperações são executadas diretamente na dimensão real. Existem dois casos de uso especializadosdiferentes para os quais esse tipo de edição direta é destinado:

• Quando o propósito do processo TurboIntegrator for fazer uma pequena mudança em uma grandedimensão. Nesse caso, a edição direta será mais eficiente porque evita copiar e regravarcompletamente a dimensão grande.

• Quando o propósito do processo TurboIntegrator for carregar grandes volumes de dados em um cubo.Nesse caso, o procedimento de Metadados do processo é deliberadamente mantido vazio e qualquermodificação de elemento necessária para suportar o carregamento de dados é executado usando aschamadas diretas no procedimento de Dados. Quando o procedimento de Metadados ficar vazio, oprocesso ignorará uma iteração inteira sobre a origem de dados externa, que pode resultar emcarregamentos de dados mais rápidos.

Sintaxe

HierarchyElementDeleteDirect(DimName, HierName, ElName);

Argumento Descrição

DimName A dimensão que contém o elemento que vocêdeseja excluir.

HierName O nome da hierarquia dentro da dimensão.

ElName O elemento que você deseja excluir.

Exemplo

HierarchyElementDeleteDirect('Region', 'Western', 'Belgium');

Este exemplo exclui o elemento Belgium da hierarquia Western na dimensão Region.

HierarchyElementExistsHierarchyElementExists determina se um elemento específico existe em uma hierarquia no servidor apartir do qual um processo do Turbo Integrator é executado. A função retorna 1 se o elemento existir nahierarquia no servidor, caso contrário, retorna 0.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchyElementExists(DimName, HierName, ElemName);

Capítulo 5. Funções do Turbo Integrator 323

Argumento Descrição

DimName O nome da dimensão que contém o elemento cujaexistência se deseja confirmar.

HierName O nome da hierarquia dentro da dimensão.

ElName O elemento que você deseja localizar nahierarquia.

Exemplo

HierarchyElementExists('Region', 'Western', 'Belgium');

Este exemplo determina se o elemento Belgium da hierarquia Western na dimensão Region existe noservidor.

HierarchyElementInsertHierarchyElementInsert inclui um elemento em uma dimensão. Esta função pode ser usada para incluirelementos numéricos, de sequência ou consolidados. Não é possível usar essa função nos procedimentosde Dados ou de Epílogo de um processo do Turbo Integrator.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchyElementInsert(DimName, HierName, InsertionPoint, ElName, ElType);

Argumento Descrição

DimName A dimensão na qual você deseja incluir um novoelemento.

HierName O nome da hierarquia dentro da dimensão.

InsertionPoint Um elemento de dimensão existente. O elementoque está sendo incluído na dimensão será inseridoimediatamente antes deste elemento existente. Seeste parâmetro estiver vazio, o novo elemento seráincluído no final da dimensão.

ElName O nome que você deseja designar ao novoelemento.

ElType O tipo de elemento. Existem três possíveis valoresElType:

N - Significa um elemento numérico.

S - Significa um elemento de sequência.

C - Significa um elemento consolidado.

Exemplo

HierarchyElementInsert('Region', 'Western', 'Belgium', 'Netherlands','N');

324 IBM Planning Analytics: Referência do TM1

Este exemplo inclui o elemento numérico Netherlands na hierarquia Western na dimensão Region. PaísesBaixos é exibido imediatamente antes de Bélgica na definição de dimensão.

HierarchyElementInsertDirectHierarchyElementInsertDirect inclui um elemento em uma dimensão, editando diretamente a dimensão.Esta função pode ser usada para incluir elementos numéricos, de sequência ou consolidados.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

A maneira padrão de editar uma dimensão no TM1 é usar um padrão de edição de cópia completa. Nessepadrão, uma cópia de edição da dimensão é criada, as edições são aplicadas à cópia de edição e, emseguida, finalmente a dimensão real é regravada usando a cópia de edição como um modelo. O TurboIntegrator suporta edição de cópia inteira automaticamente sempre que as funções do Turbo Integratorde edição da dimensão (como HierarchyElementInsert) são usadas na guia de metadados do processo. OTurboIntegrator cria automaticamente a cópia de edição e aplica nela as operações de edição, emseguida, regrava a dimensão real no fim do procedimento de Metadados.

As edições diretas são diferentes porque nenhuma cópia de edição é envolvida. Em vez disso, asoperações são executadas diretamente na dimensão real. Existem dois casos de uso especializadosdiferentes para os quais esse tipo de edição direta é destinado:

• Quando o propósito do processo TurboIntegrator for fazer uma pequena mudança em uma grandedimensão. Nesse caso, a edição direta será mais eficiente porque evita copiar e regravarcompletamente a dimensão grande.

• Quando o propósito do processo TurboIntegrator for carregar grandes volumes de dados em um cubo.Nesse caso, o procedimento de Metadados do processo é deliberadamente mantido vazio e qualquerinserção de elemento necessária para suportar o carregamento de dados é executado usando aschamadas diretas no procedimento de Dados. Quando o procedimento de Metadados ficar vazio, oprocesso ignorará uma iteração inteira sobre a origem de dados externa, que pode resultar emcarregamentos de dados mais rápidos.

Sintaxe

HierarchyElementInsertDirect(DimName, HierName, InsertionPoint, ElName, ElType);

Argumento Descrição

DimName A dimensão na qual você deseja incluir um novoelemento.

HierName O nome da hierarquia dentro da dimensão.

InsertionPoint Um elemento de dimensão existente. O elementoque está sendo incluído na dimensão será inseridoimediatamente antes deste elemento existente. Seeste parâmetro estiver vazio, o novo elemento seráincluído no final da dimensão.

Observe que esta função é otimizada para o casoem que o InsertionPoint é passado como umasequência vazia.

ElName O nome que você deseja designar ao novoelemento.

Capítulo 5. Funções do Turbo Integrator 325

Argumento Descrição

ElType O tipo de elemento. Existem três possíveis valoresElType:

N - Significa um elemento numérico.

S - Significa um elemento de sequência.

C - Significa um elemento consolidado.

Exemplo

HierarchyElementInsertDirect('Region', 'Western', 'Belgium', 'Netherlands','N');

Este exemplo inclui o elemento numérico Netherlands na hierarquia Western na dimensão Region. PaísesBaixos é exibido imediatamente antes de Bélgica na definição de dimensão.

HierarchyElementPrincipalNameHierarchyElementPrincipalName retorna o nome principal de um elemento ou alias de elemento.

O Turbo Integrator deve usar nomes de elementos principais ao atualizar dimensões; os aliases deelementos não podem ser usados. Portanto, esta função é útil para determinar nomes de elementosprincipais ao tentar atualizar uma dimensão quando apenas os aliases de elementos estão disponíveispara o processo do Turbo Integrator.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchyElementPrincipalName( DimName, HierName, ElName )

Argumento Descrição

DimName O nome da dimensão da qual você desejarecuperar um nome de elemento principal.

HierName O nome da hierarquia dentro da dimensão.

ElName Um nome de elemento. ElName pode ser um aliasde elemento ou um nome de elemento principal.

Exemplo

Se ElName não estiver na versão salva de DimName, a função retornará ElName.

Se ElName estiver em DimName, se como um alias de elemento ou como um nome de elementoprincipal, será retornado o nome principal do elemento.

HierarchyExistsHierarchyExists determina se uma hierarquia específica existe no servidor a partir do qual um processodo Turbo Integrator é executado. A função retornará 1 se a hierarquia existir no servidor, do contrárioretornará 0.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

326 IBM Planning Analytics: Referência do TM1

Sintaxe

HierarchyExists(DimName, HierName);

Argumento Descrição

DimName O nome da dimensão que contém a hierarquia cujaexistência deseja confirmar.

HierName O nome da hierarquia dentro da dimensão.

Exemplo

HierarchyExists('Region', 'Europe');

Este exemplo determina se a hierarquia Europa, na dimensão Região, existe no servidor.

HierarchyHasOrphanedLeavesHierarchyHasOrphanedLeaves retorna 1 se houver um ou mais elementos na hierarquia especificada quenão sejam componentes de um elemento-pai nessa hierarquia.

A função retorna 1 se a hierarquia existir no servidor, caso contrário, retorna 0. Essa função retorna 0 setodos os elementos folha na hierarquia forem um componente de um ou mais elementos-pai. Os valoresarmazenados em relação a esses elementos não serão agregados.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchyHasOrphanedLeaves(DimName, HierName);

Argumento Descrição

DimName O nome da dimensão que contém a hierarquia queestá sendo revisada.

HierName O nome da hierarquia que está sendo revisada paramembros folha órfãos.

Exemplo

HierarchyHasOrphanedLeaves('Region', 'Europe');

Esse exemplo determina se a hierarquia Europa, na dimensão Região, contém qualquer folha órfão.

HierarchySortOrderHierarchySortOrder configura um tipo e uma direção de classificação para elementos de dimensão e paracomponentes de elementos consolidados em uma dimensão. A ordem de classificação definida porDimensionSortOrder determina como o subconjunto é exibido no Editor de Subconjunto.

DimensionSortOrder define propriedades para uma dimensão, a dimensão não é de fato armazenada atéque seja salva no servidor.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Capítulo 5. Funções do Turbo Integrator 327

Sintaxe

HierarchySortOrder(DimName, HierName, CompSortType, CompSortSense,ElSortType , ElSortSense);

Argumento Descrição

DimName O nome da dimensão para a qual você desejadefinir uma ordem de classificação.

HierName O nome da hierarquia dentro da dimensão.

CompSortType Define como os componentes de elementosconsolidados aparecem na dimensão. Existem doisvalores CompSortType:

ByInput - Retém a ordem em que os componentesforam inseridos originalmente em consolidações.

ByName - Classifica componentes deconsolidações por nome.

CompSortSense Define a direção de classificação paracomponentes de consolidações. Este é umargumento necessário, mas é aplicável apenasquando CompSortType é ByName. Existem doispossíveis valores CompSortSense:

Ascending - Classifica componentes deconsolidações em ordem alfabética crescente.

Descending - Classifica componentes deconsolidações em ordem alfabética decrescente.

ElSortType Define uma ordem de classificação para elementosde dimensão. Existem quatro possíveis valoresElSortType:

ByInput - Retém a ordem em que os elementosforam originalmente inseridos na dimensão.

ByName - Classifica elementos de dimensão pornome.

ByLevel - Classifica elementos de dimensão pornível.

ByHierarchy - Classifica elementos de dimensãopor hierarquia.

328 IBM Planning Analytics: Referência do TM1

Argumento Descrição

ElSortSense Define a direção de classificação para elementosde dimensão. Este é um argumento necessário,mas é aplicável apenas quando ElSortType éByName ou ByLevel. Existem dois possíveisvalores ElSortSense:

Ascending - Classifica elementos de dimensão emordem crescente, em ordem alfabética ou pornível.

Descending - Classifica elementos de dimensãoem ordem decrescente, em ordem alfabética oupor nível.

Exemplo

HierarchySortOrder ('Region', 'Europe', 'ByName', 'Descending','ByLevel', 'Ascending');

Este exemplo configura uma ordem de classificação para a hierarquia Europe na dimensão Region. Todosos elementos de dimensão são classificados por nível em ordem crescente e quaisquer componentes deconsolidações são classificados em ordem alfabética decrescente.

HierarchyTimeLastUpdatedHierarchyTimeLastUpdated indica quando uma hierarquia de dimensão especificada foi atualizada pelaúltima vez. A função retorna um número real que representa o dia atual (incluindo a hora, o minuto, osegundo e o milissegundo) desde o início do ano 1900.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchyTimeLastUpdated(dimension, hierarchy);

Argumento Descrição

dimensão O nome da dimensão.

hierarchy O nome da hierarquia.

Exemplo

HierarchyTimeLastUpdated('Region', 'Europe');

Este exemplo retorna informações sobre quando a hierarquia Europe da dimensão Region foi atualizadapela última vez. Caso um valor de 42548.<hours>.<minutes>.<milliseconds> seja retornado, é possíveldividir 42548 por 365 para obter (aproximadamente) 116. Quando incluído no início de 1900, o resultadoé um ano atual de 2016.

HierarchyTopElementInsertHierarchyTopElementInsert cria um elemento raiz em uma dimensão. Se a dimensão já tiver uma únicaraiz, esse elemento não será criado.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Capítulo 5. Funções do Turbo Integrator 329

Sintaxe

HierarchyTopElementInsert(DimName, HierName, InsertionPoint, ElName);

Argumento Descrição

DimName A dimensão para a qual você deseja criar umelemento-raiz.

HierName O nome da hierarquia dentro da dimensão.

InsertionPoint Um elemento de dimensão existente. O elemento-raiz que está sendo incluído na dimensão seráinserido imediatamente antes deste elementoexistente.

ElName O nome que você deseja designar ao novoelemento-raiz.

Exemplo

HierarchyTopElementInsert('Region', 'Western', 'Netherlands', 'World');

Este exemplo inclui o elemento-raiz World na hierarquia Western da dimensão Region. World é inseridoimediatamente antes de Netherlands na definição de dimensão.

HierarchyTopElementInsertDirectHierarchyTopElementInsertDirect cria um elemento raiz em uma dimensão, editando diretamente adimensão. Se a dimensão já tiver uma única raiz, esse elemento não será criado.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

A maneira padrão de editar uma dimensão no TM1 é usar um padrão de edição de cópia completa. Nessepadrão, uma cópia de edição da dimensão é criada, as edições são aplicadas à cópia de edição e, emseguida, finalmente a dimensão real é regravada usando a cópia de edição como um modelo. O TurboIntegrator suporta a edição de cópia inteira automaticamente sempre que as funções de edição dedimensão do Turbo Integrator (como HierarchyTopElementInsert) são usadas no procedimento deMetadados do processo. O TurboIntegrator cria automaticamente a cópia de edição e aplica nela asoperações de edição, em seguida, regrava a dimensão real no fim do procedimento de Metadados.

As edições diretas são diferentes porque nenhuma cópia de edição é envolvida. Em vez disso, asoperações são executadas diretamente na dimensão real. Existem dois casos de uso especializadosdiferentes para os quais esse tipo de edição direta é destinado:

• Quando o propósito do processo TurboIntegrator for fazer uma pequena mudança em uma grandedimensão. Nesse caso, a edição direta será mais eficiente porque evita copiar e regravarcompletamente a dimensão grande.

• Quando o propósito do processo TurboIntegrator for carregar grandes volumes de dados em um cubo.Nesse caso, o procedimento de Metadados do processo é deliberadamente mantido vazio e qualquermodificação de elemento necessária para suportar o carregamento de dados é executado usando aschamadas diretas no procedimento de Dados. Quando o procedimento de Metadados ficar vazio, oprocesso ignorará uma iteração inteira sobre a origem de dados externa, que pode resultar emcarregamentos de dados mais rápidos.

Sintaxe

HierarchyTopElementInsertDirect(DimName, HierName, InsertionPoint, ElName);

330 IBM Planning Analytics: Referência do TM1

Argumento Descrição

DimName A dimensão para a qual você deseja criar umelemento-raiz.

HierName O nome da hierarquia dentro da dimensão.

InsertionPoint Um elemento de dimensão existente. O elemento-raiz que está sendo incluído na dimensão seráinserido imediatamente antes deste elementoexistente.

ElName O nome que você deseja designar ao novoelemento-raiz.

Exemplo

HierarchyTopElementInsertDirect('Region', 'Western', 'Netherlands', 'World');

Este exemplo inclui o elemento-raiz World na hierarquia Western da dimensão Region. World é inseridoimediatamente antes de Netherlands na definição de dimensão.

HierarchyUpdateDirectHierarchyUpdateDirect executa uma regravação completa de uma hierarquia que passou por ediçãodireta em um processo do Turbo Integrator, compactando essencialmente a área de cobertura damemória da dimensão.

Uma dimensão que passa por uma série de edições de direção apenas (exclusões de elemento, emespecífico) usarão eventualmente mais memória do que sua contraparte totalmente regravada usaria.Esta função pode ser usada opcionalmente após editar uma dimensão diretamente comHierarchyElementInsertDirect, HierarchyElementDeleteDirect, HierarchyElementComponentAddDirect,HierarchyElementComponentDeleteDirect e/ou HierarchyTopElementInsertDirect. A chamada deHierarchyUpdateDirect incorre em um custo inicial de memória de cópia completa, no entanto, ela podeser usada para garantir que a dimensão esteja em sua menor área de cobertura da memória possível apóso processamento ser concluído.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchyUpdateDirect(DimName, HierName);

Argumento Descrição

DimName O nome da dimensão que você deseja regravar.

HierName O nome da hierarquia dentro da dimensão.

Exemplo

HierarchyUpdateDirect('Region', 'Western');

Este exemplo regrava a hierarquia Western da dimensão Region.

Capítulo 5. Funções do Turbo Integrator 331

Funções Open Database Connectivity do Turbo IntegratorEstas funções facilitam a manipulação de ODBC.

ODBCCloseODBCClose fecha uma conexão com uma origem de dados ODBC.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ODBCClose(Source);

Argumento Descrição

Origem O nome de uma origem de dados Open DatabaseConnectivity aberta.

Exemplo

ODBCClose('Accounting');

Este exemplo fecha a conexão com a origem Open Database Connectivity de Contabilidade.

ODBCOpenODBCOpen abre uma origem de dados ODBC para saída.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ODBCOpen(Source, ClientName, Password);

Argumento Descrição

Origem Um nome de origem de dados Open DatabaseConnectivity.

ClientName Um cliente válido na origem de dados.

Senha A senha para o ClientName.

Exemplo

ODBCOpen('Accounting', 'Jdoe', 'Bstone');

Este exemplo abre a origem de dados Open Database Connectivity de Contabilidade para o cliente Jdoeusando a senha Bstone.

ODBCOPENExODBCOPENEx abre uma origem de dados ODBC para saída, especificando que a conexão deve ser abertacomo uma conexão Unicode.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

332 IBM Planning Analytics: Referência do TM1

Sintaxe

O formato é: ODBCOPENEx (nome do conjunto de dados, nome do cliente do conjunto de dados, senha docliente, (usar sinalizador de interface Unicode) )

ODBCOpenEx(Source, ClientName, Password, UseUnicodeODBC);

Argumento Descrição

Origem Um nome de origem de dados Open DatabaseConnectivity.

ClientName Um cliente válido na origem de dados.

Senha A senha para o ClientName.

UseUnicodeODBC Define o tipo de conexão Unicode a ser usada.

Exemplo

ODBCOpenEx( TestTable, sa, , 1 );

chinese= ;chinese = CHARW( 37123 );fieldval = chinese | SomeNewText;sql = Update TestTable set ForeName = N | fieldval | WHERE CustomerId= 1ODBCOUTPUT( Unicode, sql );

A instrução SQL resultante é semelhante a:

Update TestTable set ForeName = N?SomeNewText WHERE CustomerId= 1

ODBCOutputODBCOutput executa uma consulta de atualização SQL em relação a uma origem de dados ODBC aberta.A função ODBCOpen deve ser usada para abrir a origem de dados antes de chamar ODBCOutput, eODBCClose deve ser usada para fechar a origem de dados antes de sair do processo.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ODBCOutput(Source, SQLQuery, [SQLQuery2, SQLQuery3, ...]);

Argumento Descrição

Origem A origem de dados Open Database Connectivity naqual você deseja executar uma consulta.

Capítulo 5. Funções do Turbo Integrator 333

Argumento Descrição

SQLQuery Uma instrução de consulta SQL.

Embora ODBCOutput foi desenvolvida paraatualizar tabelas, ela pode ser usada para executarqualquer consulta SQL na origem de dados.

Em circunstâncias nas quais a instrução deconsulta SQL excede 255 caracteres, você devedividir a consulta em vários argumentos SQLQuery(SQLQuery2, SQLQuery3, etc.). Isto permite criarinstruções de consulta que excedem o limite de255 caracteres para argumentos do TurboIntegrator. Quando a função ODBCOutput forexecutada, todos os argumentos SQLQuery serãoconcatenados e a consulta será executada comêxito.

Exemplo

ODBCOutput('Accounting', 'INSERT [CategoryID], [CategoryName]FROMCategories;');

Este exemplo executa a consulta especificada na origem de dados de Contabilidade.

SetODBCUnicodeInterfaceSetODBCUnicodeInterface define se a interface ODBC deve usar as funções de âmbito do Unicode ou asfunções regulares de caractere de byte único. Configurar essa função como 1 usa a interface OpenDatabase Connectivity de caractere largo.

Alguns drivers Open Database Connectivity suportam a interface de byte único mais antiga, bem comouma interface de 'caractere largo' de estilo Unicode, na qual os caracteres são transmitidos erecuperados como quantidades de 16 bits. Se o driver escolhido não suportar um ou o outro estilo, seráfornecido um sinalizador para forçar o Turbo Integrator a usar um estilo específico de interface.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SetODBCUnicodeInterface=1

Argumento Descrição

1 Usar a interface Open Database Connectivity decaractere largo.

0 Usar a interface de byte único.

Funções de Controle de Processo do Turbo IntegratorEstas funções referem-se ao controle de processo.

ExecuteCommandExecuteCommand executa uma linha de comandos durante um processo. É possível usarExecuteCommand para executar um aplicativo de desktop, mas não um serviço.

334 IBM Planning Analytics: Referência do TM1

Se você usar ExecuteCommand para executar um executável, as seguintes condições serão aplicáveis:

• Se o argumento CommandLine especifica somente o nome de um arquivo a ser executado, um servidorWindows procura pelo arquivo no banco de dados do servidor e no diretório onde o Tm1s.exe reside.Um servidor UNIX procura pelo arquivo somente o diretório do banco de dados do servidor.

• Se o argumento CommandLine utilize um prefixo de caminho relativo, ambos os servidores Windows e oUNIX tentam localizar o arquivo no diretório do banco de dados do servidor apenas.

• No servidor Microsoft Windows ou no servidor UNIX serve[]r, é possível transmitir um caminho absolutopara o argumento CommandLine executar um arquivo em qualquer local.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ExecuteCommand(CommandLine, Wait);

Argumento Descrição

CommandLine A linha de comandos que você deseja executar.

Espera Indica se o processo deve esperar a conclusão daexecução do comando antes de continuar napróxima instrução de processo. Um valor doargumento de 0 faz o processo prosseguir para apróxima instrução sem esperar a execução da linhade comandos. Um valor do argumento de 1 faz oprocesso esperar a execução bem-sucedida dalinha de comandos antes de prosseguir para apróxima instrução.

ExecuteProcessExecuteProcess permite executar um processo do Turbo Integrator a partir de outro processo.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ExecuteProcess(ProcessName, [ParamName1, ParamValue1,ParamName2, ParamValue2]);

Argumento Descrição

ProcessName O nome do processo a ser executado. Esse processo deve residir nomesmo servidor que o processo a partir do qual o ExecuteProcess échamado.

Se o processo nomeado por este argumento não for localizado notempo de execução, o processo de chamada será finalizadoimediatamente. (O Turbo Integrator não verifica um ProcessNameválido na compilação.)

ParamName O nome de um parâmetro existente do processo a ser executado. Esteargumento será necessário apenas se o processo a ser executado usarparâmetros.

Capítulo 5. Funções do Turbo Integrator 335

Argumento Descrição

ParamValue Um valor válido para o parâmetro ParamName. Se você especificar umargumento ParamName, deverá especificar um ParamValuecorrespondente.

Os argumentos ParamName e ParamValue devem ocorrer em paresordenados, com o nome do parâmetro seguido pelo valor. Você deveespecificar um ParamName e um ParamValue correspondente paracada parâmetro do processo a ser executado.

Os nomes de parâmetros transmitidos na função ExecuteProcess são correspondidos no tempo deexecução com os nomes de parâmetros especificados no processo a ser executado. Se os nomestransmitidos não forem localizados na lista de parâmetros do processo a ser executado, ocorrerá um errograve, causando a finalização imediata do processo a partir do qual ExecuteProcess é chamada.

Valores de Retorno

ExecuteProcess retorna um valor real que pode ser testado em uma das seguintes funções de valor deretorno:

Função Descrição

ProcessExitByChoreQuit() indica que o processo foi encerrado devido à execução da funçãoChoreQuit

ProcessExitNormal() indica que o processo foi executado normalmente

ProcessExitMinorError() indica que o processo foi executado normalmente, mas encontrouerros secundários

ProcessExitByQuit() indica que o processo foi encerrado devido a um comando "quit"explícito

ProcessExitWithMessage() indica que o processo foi encerramento normalmente com umamensagem gravada em tm1server.log

ProcessExitSeriousError() indica que o processo foi encerrado devido a um erro grave

ProcessExitOnInit() indica que o processo foi interrompido durante a inicialização

ProcessExitByBreak() indica que o processo foi encerrado porque encontrou uma funçãoProcessBreak

ExemploPara registrar uma falha de um processo chamado por ExecuteProcess devido a um erro grave, use umcódigo semelhante ao seguinte:

return_value = ExecuteProcess('create_sales_cube');ASCIIOutput('C:\temp\process_return_value.txt', 'Process exitedwith serious errors at', TIME, 'on', TODAY);if(return_value = ProcessExitSeriousError() )endif;

336 IBM Planning Analytics: Referência do TM1

GetProcessErrorFileDirectoryGetProcessErrorFileDirectory retorna o nome do caminho completo, com uma barra final, do diretório emque os arquivos de erro do processo do Turbo Integrator são gravados. Por padrão, todos os arquivos delog de erro de processo são gravados no diretório de dados do servidor em que o processo reside.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

GetProcessErrorFileDirectory;

Argumentos

Nenhum.

GetProcessErrorFilenameGetProcessErrorFilename retorna o nome do arquivo de log de erros do processo do Turbo Integratorassociado a um processo. Se o processo ainda não tiver gerado um arquivo de log de erros, a funçãoretornará uma sequência vazia (nula).

Importante: Um arquivo de log de erro de processo não é gerado até todas as instruções em umadeterminada guia do processo (Prólogo, Metadados, Dados ou Epílogo) terem sido executadas. De formaapropriada, é possível usar GetProcessErrorFilename para verificar se alguma guia anterior gerou umarquivo de log de erros, mas não é possível usar a função para determinar se a guia do processo atualcausa a gravação de erros em um arquivo de log.

Por exemplo, ao determinar que GetProcessErrorFilename retorna uma sequência não nula na guiaEpílogo, você pode informar que foram gerados erros nas guias Prólogo, Metadados ou Dados. Noentanto, não é possível usar GetProcessErrorFilename na guia Dados para determinar se a guia Dadosgera erros.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

GetProcessErrorFilename;

Argumentos

Nenhum.

GetProcessNameGetProcessName retorna uma sequência com o nome do processo atual.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

GetProcessName()

Argumentos

Nenhum.

Name = GetProcessName();

Capítulo 5. Funções do Turbo Integrator 337

SeA instrução Se permite que um processo execute uma instrução ou séries de instruções quando umadeterminada expressão é true. É possível usar operadores aritméticos, operadores lógicos e operadoresde comparação para construir uma expressão.

A instrução IF do TurboIntegrator é diferente da função IF de Regras porque a instrução doTurboIntegrator pode aceitar várias instruções ElseIf ou Else para avaliar diversas expressões, enquantoa função IF de Regras só pode avaliar uma expressão.

É possível aninhar até 20 instruções If/ElseIf/Else em um processo TurboIntegrator. Se exceder 20instruções If/ElseIf/Else aninhadas, você receberá um erro ao tentar salvar o processo.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

If(expression);statement1;ElseIf(expression);statement2;ElseIf(expression);statement3;Else;statement4;EndIf;

Argumentos

Nenhum.

Exemplos

If (x=5); ASCIIOutput('c:\temp\if.txt','x equals five');ElseIf (x=1); ASCIIOutput ('c:\temp\if.txt', 'x equals one');ElseIf (x=2); ASCIIOutput ('c:\temp\if.txt', 'x equals two');ElseIf (x=3); ASCIIOutput ('c:\temp\if.txt', 'x equals three');ElseIf (x=4); ASCIIOutput ('c:\temp\if.txt', 'x equals four');Else; ASCIIOutput ('c:\temp\if.txt', 'x falls outside expected range');EndIf;

Este exemplo avalia o valor de X. Se X=5, a função ASCIIOutput será executada para gravar a sequência"x equals five" em c:\temp\if.txt. Se X não for igual a 5, a primeira instrução ElseIf será avaliada. Se X=1, afunção ASCIIOutput será executada para gravar a sequência "x equals one" em c:\temp\if.txt. Esteprocessamento continuará até que EndIf seja executado.

Instruções If simples também podem ser construídas sem o uso de ElseIf, como neste exemplo:

IF(expression); statement1; ELSE; statement2; ENDIF;

ItemRejectItemReject rejeita um registro de origem e o coloca no log de erros, juntamente com uma mensagem deerro especificada.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

338 IBM Planning Analytics: Referência do TM1

Sintaxe

ItemReject(ErrorString);

Argumento Descrição

ErrorString A mensagem de erro que você deseja gravar no logde erros quando um registro é rejeitado.

Exemplo

ItemReject(' Valor fora do intervalo aceitável.');

Este exemplo coloca um registro de origem no log de erros, juntamente com a mensagem de erro 'Valorfora do intervalo aceitável.' quando o registro de origem contiver um valor que esteja além de umintervalo definido.

ItemSkipItemSkip força um processo a ignorar o item de origem de dados atual.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ItemSkip;

Argumentos

Nenhum.

ProcessBreakProcessBreak para o processamento da origem de dados e prossegue para a parte Epílogo de umprocesso.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ProcessBreak;

Argumentos

Nenhum.

ProcessErrorProcessError causa uma finalização imediata de um processo.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ProcessError;

Argumentos

Nenhum.

Capítulo 5. Funções do Turbo Integrator 339

ProcessExistsProcessExists determina se um processo específico do Turbo Integrator existe.

A função ProcessExists retorna um de três valores possíveis:

• Se um processo do Turbo Integrator com o nome especificado não existir, a função retornará 0.• Se um processo com o nome especificado existir e for válido, a função retornará 1.• Se um processo com o nome especificado existir, mas tiver erros de compilação, a função retornará -1.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ProcessExists(ProcessName);

Argumento Descrição

ProcessName O nome do processo para o qual você estátentando determinar o status.

ProcessQuitProcessQuit finaliza um processo do Turbo Integrator.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ProcessQuit;

Argumentos

Nenhum.

ProcessRollbackProcessRollback inicia um retrocesso de processo. Quando usada em um processo do TurboIntegrator,esta função descarta todas as edições pendentes e cancela o processamento adicional. Uma mensagemde erro é exibida nos arquivos tm1server.log e tm1processorerrorXXX.log.

Nota: No IBM Planning Analytics versão 2.0.8 ou mais recente, quando um processo do Turbo Integratorretrocede e reinicia, o processo agora é representado no arquivo tm1server.log como três etapas:início, reinício devido à contenção de bloqueio ou retrocesso e, em seguida, conclusão.

Uma entrada é incluída no arquivo tm1server.log, que mostra o processo do Turbo Integrator comoreiniciando devido à contenção de bloqueio ou retrocesso em vez de apenas iniciar. Essa criação de log éativada por padrão, sem configurar nenhuma opção de depuração específica.

Quando usada em uma tarefa de organização de processos de confirmação única, ProcessRollback lançatodas as edições pendentes de todos os processos anteriores e continua a execução no próximo processona tarefa de organização de processos. Caso uma contenção de bloqueio seja encontrada após achamada para ProcessRollback, a tarefa de organização de processos inteira será reiniciada.

Quando usada em uma tarefa de organização de processos de diversas confirmações, ProcessRollbacklança todas as edições pendentes do processo atual e, em seguida, continua a execução no próximoprocesso na tarefa de organização de processos. Mudanças confirmadas não podem ser desfeitas. Casouma contenção de bloqueio seja encontrada após a chamada para ProcessRollback, apenas o processoatual será reiniciado.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

340 IBM Planning Analytics: Referência do TM1

Sintaxe

ProcessRollback;

Argumentos

Nenhum.

RunProcessRunProcess permite a execução de processos do Turbo Integrator em paralelo, cada um em seu próprioencadeamento, que é gerenciado pelo TM1 Server. Essa abordagem acelera o carregamento de dados eoutras operações nas quais os processos do Turbo Integrator são usados para dividir o trabalho.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

RunProcess(ProcessName, [ParamName1, ParamValue1,ParamName2, ParamValue2]);

Argumento Descrição

ProcessName O nome do processo a ser executado. Esse processo pode residir nomesmo servidor que o processo a partir do qual RunProcess échamado.

Se o processo nomeado por este argumento não for localizado notempo de execução, o processo de chamada será finalizadoimediatamente. (O Turbo Integrator não verifica um ProcessNameválido na compilação.)

ParamName O nome de um parâmetro existente do processo a ser executado. Esseargumento é necessário apenas se o processo a ser executado usarparâmetros.

ParamValue Um valor válido para o parâmetro ParamName. Se você especificar umargumento ParamName, deverá especificar um ParamValuecorrespondente.

Os argumentos ParamName e ParamValue devem ocorrer em paresordenados, com o nome do parâmetro seguido pelo valor. Deve-seespecificar um ParamName e um ParamValue correspondente paracada parâmetro do processo a ser executado.

No tempo de execução, os nomes de parâmetros transmitidos na função RunProcess são correspondidoscom os nomes de parâmetros especificados no processo a ser executado. Caso os nomes transmitidosnão sejam localizados na lista de parâmetros do processo a ser executado, ocorrerá um erro grave,causando a finalização imediata do processo a partir do qual RunProcess é chamada.

Valores de retorno

RunProcess retorna uma sequência. A sequência é o JobID ou, em caso de erro, uma sequência decaracteres vazia.

SynchronizedSynchronized é usado em um script do Turbo Integrator para forçar a execução serial de um conjuntodesignado de processos do Turbo Integrator.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Capítulo 5. Funções do Turbo Integrator 341

Sintaxe

A função synchronized() usa a seguinte sintaxe.

synchronized (lockName);

Synchronized usa um único parâmetro necessário que é um nome definido pelo usuário para um objetode bloqueio. Esse nome de objeto de bloqueio pode ser usado em diversos processos do Turbo Integratorpara serializar sua execução como um grupo.

Argumento Descrição

lockName O nome definido pelo usuário de um objeto de bloqueio no qualsincronizar. Os nomes não fazem distinção entre maiúsculas eminúsculas e os espaços integrados são ignorados. Os nomes nãopodem exceder 1023 caracteres de comprimento.

Sequência/Sim/Nenhum

Semântica

Um processo do Turbo Integrator pode fazer qualquer número de chamadas para synchronized(), comqualquer número de objetos de bloqueio. A serialização tem efeito do momento em que synchronized() échamada, até a conclusão da transação de contenção.

Por exemplo, se synchronized() for chamada a partir de um subprocesso (Ps) de um processo principal(Pm) ou tarefa principal (Cm), o Objeto de Bloqueio será "liberado" com a conclusão de Pm ou Cm. Aexceção é que um SaveDataAll (SDA) "encerra" prematuramente uma execução de transação durante oprocesso; isso se aplica também a Objetos de Bloqueio.

A chamada de synchronized() pode ser colocada em qualquer lugar em um script do Turbo Integrator,mas a serialização se aplica a todo o processo do Turbo Integrator quando este é encontrado.

Considere um processo do Turbo Integrator com uma chamada synchronized() em algum lugar no "meio"de seu script, e a operação O1 precedendo essa chamada. Duas instâncias deste processo do TurboIntegrator podem ser iniciadas ao mesmo tempo. É possível que uma instância seja executada até aconclusão, incluindo sua chamada para synchronized(), antes que a segunda instância atinja suachamada synchronized(). Nesse caso, os dois processos serão exibidos para o usuário como executadossimultaneamente. Se, em vez disso, o segundo processo não atingir sua chamada synchronized() antes daconclusão do primeiro, ele desfará qualquer trabalho que tenha feito (O1) e aguardará a conclusão doprimeiro. Nesse caso, os dois processos serão exibidos para o usuário como serializados.

Para evitar essa confusão e para otimizar o uso da função synchronized(), é recomendado (mas nãoimposto) que as chamadas synchronized() sejam as primeiras instruções de um processo do TurboIntegrator.

Exemplo

Considere que o processo P do Turbo Integrator precise atualizar dois cubos Cube_1 e Cube_2.

É possível que outros processos do Turbo Integrator também precisem atualizar o Cube_1 ou o Cube_2.

Para fazer com que todos os processos do Turbo Integrator que irão atualizar o Cube_1 ou o Cube_2sejam executados ao mesmo tempo, P poderia chamar synchronized() da seguinte maneira:

sCube_1='Cube_1';sCube_2='Cube_2';sE1='Elm1';sE2='Elm2';sE4='Units';sE5='Price';

Synchronized( sCube_1 );Synchronized( sCube_2 );

342 IBM Planning Analytics: Referência do TM1

CellPutn( 111, sCube_1, sE1, sE2 );CellPutn( 9.99, sCube_2, sE4, sE5 );

# ...

Outros processos do Turbo Integrator que atualizarão o Cube_1 ou o Cube_2 também deverão serchamados synchronized( sCube_1 ) e/ou synchronized( sCube_2 ), de modo semelhante.

Nesse exemplo, os nomes dos dois objetos de bloqueio foram escolhidos para serem iguais aos nomesdos cubos. Mas o nome de um objeto de bloqueio não precisa ser igual ao de outros objetos (cubos,dimensões, subconjuntos) do TM1.

WhileA instrução While permite que um proceso repita uma série de instruções enquanto uma determinadacondição for true. As instruções While podem ser aninhadas.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

WHILE(logical expression);

statement1;

statement2;

...

statement n;

END;

Nota: Todas as instruções WHILE devem ser concluídas com uma instrução END.

Argumentos

Nenhum.

Funções de Gerenciamento de Regras do Turbo IntegratorEstas funções facilitam o gerenciamento de regras.

CubeProcessFeedersCubeProcessFeeders reprocessa todos os alimentadores nas regras para um cubo especificado.

Esta função reprocessa todos os alimentadores nas regras para um cubo especificado. Normalmente, osalimentadores são reprocessados automaticamente quando uma edição do arquivo de regras é salva, noentanto, se os dados forem alterados, e essas mudanças em dados alterarem alguns alimentadorescondicionais, esta função precisará ser chamada para que esses alimentadores condicionais sejamreavaliados.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeProcessFeeders(CubeName);

Argumento Descrição

CubeName O cubo para o qual você deseja reprocessaralimentadores.

Capítulo 5. Funções do Turbo Integrator 343

Exemplo

CubeProcessFeeders('2003sales');

Este exemplo reprocessa todos os alimentadores nas regras para o cubo 2003sales.

CubeRuleAppendCubeRuleAppend anexa uma única linha de texto de regra a uma regra de cubo do TM1.

Essencialmente, esta função inclui uma única linha de texto em um arquivo de regra (.rux). A linha detexto geralmente é uma instrução de regra, mas também pode ser um comentário. Se não houvernenhuma regra associada ao cubo no momento em que esta função é executada, uma nova regra serácriada, contendo apenas a linha passada.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeRuleAppend(CubeName, RuleText, IsCalculationRule);

Argumento Descrição

CubeName O nome do cubo associado à regra à qual vocêdeseja conectar uma linha de texto.

RuleText A linha única de texto que você deseja anexar àregra.

A linha inteira de texto que você inclui deve sercolocada entre aspas simples e deve aderir aconvenções de sintaxe de regras.

Se a linha de texto incluir alguma referência deelemento, os nomes de elemento devem sercolocados entre aspas simples duplas paraescapar as aspas simples que normalmentecercam os nomes de elemento. Por exemplo, umareferência a um elemento denominado CL3 deveser especificada como [''CL3''].

A seguir estão exemplos de linhas válidas de textoque você pode anexar a uma regra:

'[''CL3''] = [''CL4''] + [''Trial''];'

'skipcheck;'

'[''Trial''] => [''CL3''];'

344 IBM Planning Analytics: Referência do TM1

Argumento Descrição

IsCalculationRule O parâmetro IsCalculationRule declara se a linhadeve ser inserida pouco acima de alguma seção doalimentador que possa existir na regra do cubo. Seo parâmetro IsCalculationRule for omitido oupassado como 0.0, a nova linha simplesmente seráanexada ao fim da regra.

Como os arquivos de regra (.rux) consistem emuma seção de cálculo seguida por uma seçãoopcional do alimentado, qualquer linha anexadaque seja instrução de regra de cálculo (oucomentários correspondentes) deve usar um 1.0para que esse argumento assegure que a novalinha seja inserida no local apropriado no arquivode regra.

Exemplos

CubeRuleAppend( 'MyCube', '[''CL3''] = [''CL4''] + [''Trial''];', 1.0 );

Este exemplo insere a instrução de cálculo ['CL3'] = ['CL4'] + ['Trial']; no final da seção decálculo da regra para o cubo MyCube.

CubeRuleAppend( 'MyCube', '[''Trial''] => [''CL3''];', 0.0 );

Este exemplo insere a instrução do alimentador ['Trial'] => ['CL3']; no final da regra para o cuboMyCube.

CubeRuleDestroyCubeRuleDestroy exclui qualquer regra existente para um cubo especificado.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CubeRuleDestroy(CubeName);

Argumento Descrição

CubeName O nome do cubo associado à regra que você desejaexcluir

Exemplo

CubeRuleDestroy('SalesProjections');

Este exemplo exclui a regra para SalesProjectionscube.

DeleteAllPersistentFeedersDeleteAllPersistentFeeders exclui todos os arquivos .feeder que persistiram. Quando essa função éusada, todos os cubos são marcados como "não salvar alimentadores", portanto, um SaveDatasubsequente não persistirá os alimentadores, o que significa que todos os alimentadores serãorecalculados em caso de reinicialização do servidor.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Capítulo 5. Funções do Turbo Integrator 345

Sintaxe

DeleteAllPersistentFeeders;

Argumentos

Nenhum.

ForceSkipCheckForceSkipCheck força a execução da consulta, como se o cubo tivesse um SKIPCHECK nas regras.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Isso significa que a consulta processará somente valores realmente no cubo, como oposição ao (o casonão SKIPCHECK) local em que cada célula possível seria enumerada procurando valores. Esta funçãoconfigura o estado da consulta de visualização para selecionar somente valores no cubo. A função deveser incluída na seção Prólogo do processo TurboIntegrator. Ao colocar o ForceSkipCheck() no Prólogo, eleafeta a consulta inteira de visualização de elementos de dados a seguir.

Sintaxe

ForceSkipCheck()

Argumentos

Nenhum.

RuleLoadFromFileRuleLoadFromFile cria uma regra do TM1 para um cubo especificado a partir de um arquivo de texto.Cada instrução de regra deve terminar com um caractere de ponto e vírgula (;) e os comentários devemser prefixados com o caractere #. Se já houver uma regra para o cubo especificado, a regra serásobrescrita pela regra criada por RuleLoadFromFile.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

RuleLoadFromFile(Cube, TextFile);

Argumento Descrição

Cubo O nome do cubo para o qual você deseja criar umaregra.

TextFile O nome do arquivo de texto a partir do qual vocêdeseja criar uma regra.

É possível especificar o caminho completo paraeste arquivo, incluindo o nome e extensão doarquivo. (Exemplo 1 abaixo.)

Se especificar somente o nome e a extensão doarquivo, o Turbo Integrator procura o arquivo nodiretório de dados do servidor.

Se você não especificar uma extensão do arquivo,o Turbo Integrator considerará a extensão .rux porpadrão. (Exemplo 2 abaixo.)

346 IBM Planning Analytics: Referência do TM1

Se deixar o argumento TextFile vazio, o Turbo Integrator procura um arquivo de origem com o mesmonome que o cubo (mas com uma extensão .rux) no diretório de dados do servidor. (Exemplo 3 abaixo.)

Exemplo

RuleLoadFromFile('Sales', 'C:\temp\cuberule.txt');

Este exemplo usa o conteúdo do arquivo cuberule.txt no diretório C:\temp para criar uma regra para ocubo Sales.

RuleLoadFromFile('Sales', 'cuberule');

Este exemplo cria uma regra para o cubo Sales usando o arquivo denominado cuberule.rux no diretório dedados do servidor.

RuleLoadFromFile('Sales', ' ');

Este exemplo cria uma regra para o cubo Sales usando o arquivo denominado Sales.rux no diretório dedados do servidor.

Funções do Ambiente de SimulaçãoEstas funções são usadas com ambientes de simulações.

GetUseActiveSandboxPropertyGetUseActiveSandboxProperty retorna um valor booleano que indica se um processo lê e grava dados nodados de base ou no ambiente de simulação ativo do usuário.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

O padrão é para os processos lerem e gravarem nos dados base.

• Se o retorno for 0, isto indica que o processo está lendo e gravando nos dados base.• Se o retorno for 1, isto indica que o processo está lendo e gravando no ambiente de simulação ativo.

Nota: Esta função retorna o valor permanente para esta propriedade conforme definido na interface como usuário do Architect / Server Explorer, a menos que você tenha usado a funçãoSetUseActiveSandboxProperty no processo. Nesse caso, o valor para esta propriedade é determinadopelo valor que foi definido pela última vez com a função SetUseActiveSandboxProperty.

Sintaxe

GetUseActiveSandboxProperty()

Argumentos

Nenhum.

Exemplo

return_value = GetUseActiveSandboxProperty();

Este exemplo retornará um valor Booleano que indica se o processo está lendo e gravando dados do cubono ambiente de simulação ativo ou nos dados base.

ServerActiveSandboxGetServerActiveSandboxGet retorna o nome do ambiente de simulação ativo do usuário. Se o usuário nãotiver nenhum ambiente de simulação ativo, será retornada uma sequência vazia. Como as tarefas de

Capítulo 5. Funções do Turbo Integrator 347

organização de processos são executadas no contexto de um usuário administrativo especial e nãopodem ter um ambiente de simulação ativo, essa função sempre retorna uma sequência de caracteresvazia quando executada usando uma tarefa de organização de processos.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ServerActiveSandboxGet();

Argumentos

Nenhum.

Exemplo

return_value = ServerActiveSandboxGet();

Este exemplo retornará o ambiente de simulação ativo do usuário que está executando o processo do TIno qual é feita a chamada de função.

ServerActiveSandboxSetServerActiveSandboxSet configura o ambiente de simulação ativo do usuário executante. É usada umasequência vazia para limpar o ambiente de simulação ativo do usuário executante. Esta função lançaráum erro se o usuário executante não possuir um ambiente de simulação com o nome transmitido.

Como as tarefas de organização de processos são executadas no contexto de um usuário administrativoespecial e não podem ter um ambiente de simulação ativo, essa função sempre lança um erro quandoexecutada usando uma tarefa de organização de processos.

Nota: Para que um processo do Turbo Integrator leia e grave valores no contexto do ambiente desimulação ativo do usuário em execução, a propriedade UseActiveSandbox deve ser configurada.Consulte “GetUseActiveSandboxProperty” na página 347 e “SetUseActiveSandboxProperty” na página357.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ServerActiveSandboxSet(SandboxName)

Argumento Descrição

SandboxName Um valor de sequência. O nome de um ambientede simulação pertencente ao usuário executante.

Exemplo: configurar o ambiente de simulação ativo do usuário em execução como "Melhor caso"

ServerActiveSandboxSet('Best case');

Exemplo: limpar o ambiente de simulação ativo do usuário em execução e configurar o contexto devolta para os dados base

ServerActiveSandboxSet('');

ServerSandboxCloneServerSandboxClone clona um ambiente de simulação existente em um novo ambiente de simulação.

348 IBM Planning Analytics: Referência do TM1

Os ambientes de simulação são espaços de trabalho privados nos quais um usuário pode inserir earmazenar valores de dados separados dos dados de base do TM1. Ambientes de simulação sãoarmazenados em disco e, quando em uso, na memória.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ServerSandboxClone(sandboxName,newSandboxName );

Argumento Descrição

sandboxName Um valor de sequência. O nome de um ambientede simulação pertencente ao usuário executante.

newSandboxName Um valor de sequência. O nome de um ambientede simulação a ser criado como um clone desandboxName.

Exemplo

ServerSandboxClone( 'Best case', 'Second best case');

ServerSandboxCreateServerSandboxCreate cria um novo ambiente de simulação.

Os ambientes de simulação são espaços de trabalho privados nos quais um usuário pode inserir earmazenar valores de dados separados dos dados de base do TM1. Ambientes de simulação sãoarmazenados em disco e, quando em uso, na memória.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ServerSandboxCreate( sandboxName );

Argumento Descrição

sandboxName Um valor de sequência. O nome de um ambientede simulação a ser criado.

Exemplo

ServerSandboxCreate( 'My sandbox' );

ServerSandboxesDeleteServerSandboxesDelete permite que administradores descartem ambientes de simulação de usuáriosque correspondem a determinados critérios.

Os ambientes de simulação são espaços de trabalho privados nos quais um usuário pode inserir earmazenar valores de dados separados dos dados de base do TM1. Ambientes de simulação sãoarmazenados em disco e, quando em uso, na memória.

Essa função opera no lado do servidor e está disponível por meio do Turbo Integrator e da função de APIServerSandboxesDelete. Usando esse recurso em um processo do Turbo Integrator, os administradorespodem planejar a manutenção usando a tarefas de organização de processos automatizadas.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Capítulo 5. Funções do Turbo Integrator 349

Descrição

Esta função usa um "predicado" para descrever o ambiente de simulação sendo excluído. Um predicadopode ser lido como: "Excluir ambientes de simulação cujo atributo é condição valor."

Por exemplo: "Excluir ambientes de simulação cujo tamanho ultrapassa 10 MB." Nesse exemplo, oatributo é o "tamanho" do ambiente de simulação, a condição é "maior que" e o valor é "10 MB".

Há dois parâmetros de caractere delimitador opcionais para a função do Turbo Integrator. Como umambiente de simulação não tem restrições quanto a quais caracteres podem ser usados em seus nomes,os administradores podem fornecer seu próprio delimitador "seguro" quando necessário.

Por exemplo, ServerSandboxesDelete( 'client:=:Admin, name:=:best casescenario');"

No exemplo a seguir, o caractere dois pontos é usado no nome do ambiente de simulação ("cenário::deboas::práticas"), de modo que outro delimitador é necessário:

ServerSandboxesDelete( 'client|=|Admin# name|=|best::case::scenario', '|', '#' );"

Nota: A sintaxe exata de um predicado se difere entre o Turbo Integrator e os formulários de interface deprogramação de aplicativos dessa função.

Sintaxe

ServerSandboxesDelete(string,string,string)

Argumento Descrição

Predicados O nome do processo a ser executado. Esse processo pode residir nomesmo servidor que o processo a partir do qual RunProcess échamado.

Necessário

Sequência

Nenhum padrão

Uma lista de comprimento arbitrário de predicados. Cada predicado éuma sequência contendo três tokens. O primeiro token indica umatributo de um ambiente de simulação. O segundo indica umacondição, por exemplo, ">" or "=". O terceiro token é um possível valordo atributo em que ambientes de simulação devem sercondicionalmente filtrados. A sequência inteira não pode exceder10.000 caracteres de comprimento.

PredicateDelimiter Opcional

Sequência

padrão é : (ponto de vírgula)

Caractere delimitador opcional.

A sequência não pode exceder 1 caractere de comprimento.

350 IBM Planning Analytics: Referência do TM1

Argumento Descrição

PredicateListDelimiter Opcional

Sequência

padrão é , (vírgula)

Caractere delimitador opcional.

A sequência não pode exceder 1 caractere de comprimento.

Atributos de Filtro

Atributos de filtro são propriedades de um ambiente de simulação nos quais ele pode sercondicionalmente correspondido. Nomes de atributo e suas condições válidas correspondentes nãofazem distinção entre maiúsculas e minúsculas e ignoram espaços em branco integrados. Por exemplo,as duas chamadas a seguir são válidas:

ServerSandboxesDelete( 'client:=:Admin' );

ServerSandboxesDelete( 'C L I E N T : = :Admin' );

Tabela 1. Atributos de Filtro

Atributo DescriçãoCondiçõesVálidas Tipo de Valor

UpdateDate Registro de data e hora daúltima ação de gravaçãoexecutada no ambiente desimulação.

<, =, >. Registro de data e hora em formato padrãointernacional, isto é, YYYY-MM-DD. Diassão as unidades mais granulares.

AccessDate Registro de data e hora doúltimo descarregamentode um ambiente desimulação.

<, =, >. Registro de data e hora em formato padrãointernacional, isto é, YYYY-MM-DD. Diassão as unidades mais granulares.

CreationDate Registro de data e hora dacriação de um ambiente desimulação.

<, =, >. Registro de data e hora em formato padrãointernacional, isto é, YYYY-MM-DD. Diassão as unidades mais granulares.

Tamanho O tamanho na memória deum ambiente desimulação.

<, =, >. Tamanho seguindo as regras de conversãode log4cxx (consulte o parâmetro deconfiguração AuditLogMaxTemp FileSize).Por exemplo, 10 MB. Kilobytes são asunidades mais granulares.

Nome O nome de um ambientede simulação.

=,containing.

Sequência.

Cliente O cliente proprietário deum ambiente desimulação.

=. Sequência.

Grupo Um grupo do qual umcliente proprietário de umambiente de simulação émembro.

=. Sequência.

Capítulo 5. Funções do Turbo Integrator 351

Criação de Log e Retornos

A exclusão de um ambiente de simulação é registrada usando a funcionalidade de criação de log deauditoria pré-existente. Além disso, um relatório mais detalhado dos efeitos da administração de umambiente de simulação é incluído no log de depuração (tm1server.log) no nível INFO. Esse relatórioincluirá a lista dos ambientes de simulação afetados, bem como alguns dos atributos e errosencontrados.

ServerSandboxesDelete retorna apenas um status de sucesso ou falha.

SemânticaLista de Predicados

Diversos predicados passados em uma única chamada para ServerSandboxesDelete são conjuntivos.Em outras palavras, para que um ambiente de simulação corresponda aos critérios transmitidos,todos os predicados devem ser verdadeiros. Diversas chamadas para ServerSandboxesDelete podemser usadas para atingir o comportamento da partícula disjuntiva. Apenas uma ocorrência de cadaatributo é permitida por chamada para ServerSandboxesDelete. Por exemplo, a transmissão de umcliente duas vezes é inválida, já que um ambiente de simulação tem apenas um cliente proprietário.Quando diversas ocorrências de um atributo são detectadas, um aviso é exibido no relatóriodetalhado, porém, a operação não é interrompida com uma falha. Nesse caso, os predicados sãotestados como com qualquer outra consulta, mas o conjunto de resultados fica sempre vazio.

Bloqueio

Para evitar grandes problemas de bloqueio, ServerSandboxesDelete examina os ambientes desimulação de um cliente como uma captura instantânea point-in-time e, em seguida, quandopossível, libera os bloqueios que garantirão uma transação serializável. Por causa dessecomportamento, quando um cliente é "transmitido" na iteração de todos os clientes, um ambiente desimulação correspondente ao critério de filtragem pode ser incluído nesse cliente antes de atransação de manutenção ser concluída. Esse comportamento é semelhante ao comportamento queocorre quando um ambiente de simulação é incluído no cliente imediatamente após a transação serconcluída.

Escopo

Membros dos grupos ADMIN (super usuário) e DataAdmin terão acesso a todos os ambientes desimulação de todos os clientes. Eles devem especificar explicitamente o atributo do cliente paralimitar o escopo de sua chamada para ServerSandboxesDelete apenas para seus próprios ambientesde simulação. Todos os outros usuários possuem acesso a seus próprios ambientes de simulaçãoapenas; se especificarem um cliente diferente, ou um grupo para o qual eles não pertencem, a funçãoabortará com falhas e retornará um erro de privilégio.

Ambientes de Simulação em Uso

Quando um ambiente de simulação atende aos critérios para exclusão, mas está atualmente em uso,ele não é excluído. Uma entrada aparecerá no relatório de nível de informação de log de depuraçãoindicando a ocorrência.

Datas de Acesso e Atualização

Os atributos de data podem ser correspondências com, no máximo, uma granularidade de dia. Devidoa essa restrição, a gravação desses atributos é correspondentemente granular. A Data da ÚltimaAtualização não é atualizada em gravações de célula individual. Em vez disso, o sistema registra adata de descarregamento de um ambiente de simulação que tinha algo gravado nele quando estavasendo carregado na memória. Para esses ambientes de simulação, a Data do Último Acesso e a Datada Última Atualização serão as mesmas. Apenas a Data do Último Acesso será atualizada durante odescarregamento de um ambiente de simulação da memória. Além disso, como os ambientes desimulação na memória não estão sujeitos a ServerSandboxesDelete, a Data do Último Acesso nãoserá atualizada quando um ambiente de simulação estiver carregado na memória.

Por exemplo, considere o cenário de uso a seguir:

352 IBM Planning Analytics: Referência do TM1

Tabela 2. Exemplo do Dia do Último Acesso

Dia Hora Ação

1 1 Carregar Ambiente de Simulação S

1 2 Gravar 1

2 3 Ler 1

2 4 Descarregar Ambiente de Simulação

Um usuário está trabalhando com um ambiente de simulação no curso de dois dias (talvez por umperíodo de tempo muito menor incluindo a mudança de dia.) No horário 4, quando o ambiente desimulação é descarregado, a Data da Última Atualização está configurada como 2 em vez de 1, emque a última atualização ocorreu de fato. Data do Último Acesso também está configurada para 2 nohorário 4 nesse caso. Se Gravação 1 fosse uma leitura, apenas a Data do Último Acesso seriaconfigurada como 2, enquanto a Data da Última Atualização não seria alterada.

Exemplo

ServerSandboxesDelete( 'client:=:Admin, name:=:best case scenario' );

ServerSandboxDiscardAllChangesServerSandboxDiscardAllChanges descarta todas as mudanças em um ambiente de simulação existente.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ServerSandboxDiscardAllChanges( sandboxName );

Argumento Descrição

sandboxName Um valor de sequência. O nome de um ambientede simulação pertencente ao usuário executante.

Exemplo

ServerSandboxDiscardAllChanges( 'MySandbox' );

ServerSandboxMergeServerSandboxMerge mescla um ambiente de simulação de origem em um ambiente de simulação dedestino existente. Se o ambiente de simulação de destino não for especificado, o ambiente de simulaçãode origem será mesclado na base.

Os ambientes de simulação são espaços de trabalho privados nos quais um usuário pode inserir earmazenar valores de dados separados dos dados de base do TM1. Ambientes de simulação sãoarmazenados em disco e, quando em uso, na memória.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ServerSandboxMerge( src, tgt, conflictRes, waitForLocks);

Capítulo 5. Funções do Turbo Integrator 353

Argumento Descrição

src O nome do ambiente de simulação de origem pertencente ao usuáriode execução a ser mesclado com o ambiente de simulação <tgt>.

O ambiente de simulação <src> não muda.

Necessário

Sequência

tgt O nome de um ambiente de simulação pertencente ao usuário deexecução a ser mesclado com o ambiente de simulação <src>.

O ambiente de simulação <tgt> é atualizado.

Se <tgt> estiver em branco, você estará mesclando <src> com dadosde base e atualizando a base.

Obrigatório. Para deixar esse parâmetro em branco, use duas aspassimples concatenadas: ''.

Sequência

conflictRes O parâmetro <conflictRes> é ignorado.

Opcional

Numérico

waitForLocks O parâmetro <waitForlocks> é um número inteiro que indica se deve-se esperar por bloqueios para garantir a serialização.

1 significa esperar por bloqueios, capturar quaisquer exceções deconflito e tentar novamente em vez de permitir que a tarefa deorganização de processos ou o processo retroceda.

0 significa não esperar por bloqueios. Permitir exceções que causamretrocesso.

Opcional

Numérico

Exemplo

Mesclar mySandbox com base.

ServerSandboxMerge(mySandbox, '');

ServerSandboxExistsServerSandboxExists testa a existência do ambiente de simulação transmitido. Um valor igual a 1 éretornado quando o ambiente de simulação passado existe; caso contrário, é retornado um 0.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ServerSandboxExists( sandboxname )

ou

ServerSandboxExists( sandboxname , username )

354 IBM Planning Analytics: Referência do TM1

Argumentos

O nome do ambiente de simulação cuja existência está sendo testada. ServerSandboxExists usa umparâmetro de sequência opcional, o nome do cliente proprietário. O cliente da chamada usa o parâmetroopcional para especificar um cliente diferente de si se tiver os privilégios apropriados. Pode ocorrer umerro de privilégio se o cliente especificado não for o cliente da execução e se o cliente da execução nãofor membro dos grupos DataAdmin ou ADMIN. Se o parâmetro opcional não for usado, os ambientes desimulação do cliente ativo serão os sujeitos.

Exemplo

O fragmento a seguir mostra como as funções ServerSandboxExists, ServerSandboxGet eServerSandboxListCountGet podem ser usadas para iterar os ambientes de simulação de umusuário chamado User1 e emitir esses ambientes de simulação para um arquivo de texto. O processoTurboIntegrator seria executado com sucesso para membros dos grupos Administradores ouAdministradores de Dados e para o usuário chamado User1. O processo TurboIntegrator falharia com umerro de privilégio para quaisquer outros usuários.

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;

ServerSandboxGetServerSandboxGet retorna o nome do ambiente de simulação identificado pelo número N, em que N é oparâmetro inserido.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ServerSandboxGet( index )

ou

ServerSandboxGet( index, username)

Argumentos

O índice do ambiente de simulação solicitado na coleção de ambientes de simulação do usuário. Oespaço de índice será contíguo, de modo que a primeira ocorrência de um retorno de sequência vaziapossa ser usada para dividir a iteração. Além disso, a exclusão de um ambiente de simulação alterará osíndices de quaisquer ambientes de simulação que seguem esse ambiente de simulação na lista.

ServerSandboxGet usa um parâmetro de sequência opcional, o nome do cliente proprietário. O clienteda chamada usa o parâmetro opcional para especificar um cliente diferente de si se tiver os privilégiosapropriados. Pode ocorrer um erro de privilégio se o cliente especificado não for o cliente da execução ese o cliente da execução não for membro dos grupos DataAdmin ou ADMIN. Se o parâmetro opcional nãofor usado, os ambientes de simulação do cliente ativo serão os sujeitos.

Capítulo 5. Funções do Turbo Integrator 355

Exemplo

O fragmento a seguir mostra como as funções ServerSandboxExists, ServerSandboxGet eServerSandboxListCountGet podem ser usadas para iterar os ambientes de simulação de umusuário chamado User1 e emitir esses ambientes de simulação para um arquivo de texto. O processoTurboIntegrator seria executado com sucesso para membros dos grupos Administradores ouAdministradores de Dados e para o usuário chamado User1. O processo TurboIntegrator falharia com umerro de privilégio para quaisquer outros usuários.

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 retorna a contagem de ambientes de simulação como um número.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ServerSandboxListCountGet()

ou

ServerSandboxListCountGet( username )

Argumentos

ServerSandboxListCountGet usa um parâmetro de sequência opcional, o nome do clienteproprietário. O cliente da chamada usa o parâmetro opcional para especificar um cliente diferente de sise tiver os privilégios apropriados. Pode ocorrer um erro de privilégio se o cliente especificado não for ocliente da execução e se o cliente da execução não for membro dos grupos DataAdmin ou ADMIN. Se oparâmetro opcional não for usado, os ambientes de simulação do cliente ativo serão os sujeitos.

Exemplo

O fragmento a seguir mostra como as funções ServerSandboxExists, ServerSandboxGet eServerSandboxListCountGet podem ser usadas para iterar os ambientes de simulação de umusuário chamado User1 e emitir esses ambientes de simulação para um arquivo de texto. O processoTurboIntegrator seria executado com sucesso para membros dos grupos Administradores ouAdministradores de Dados e para o usuário chamado User1. O processo TurboIntegrator falharia com umerro de privilégio para quaisquer outros usuários.

SandboxIndex = 1;NumSandboxes = ServerSandboxListCountGet( 'User1' );

WHILE( SandboxIndex <= NumSandboxes );

SandboxName = ServerSandboxGet( SandboxIndex, 'User1' );

IF( ServerSandboxExists( SandboxName, 'User1' ) = 1 );

ASCIIOUTPUT( 'C:\User1Sandboxes.txt', SandboxName );

356 IBM Planning Analytics: Referência do TM1

ENDIF;

SandboxIndex = SandboxIndex + 1;

END;

SetUseActiveSandboxPropertySetUseActiveSandboxProperty controla se um processo lê e grava dados do cubo nos dados de base ouno ambiente de simulação ativo do usuário. O padrão é para os processos lerem e gravarem nos dadosbase.

O escopo desta função é aplicável apenas ao processo atual em execução e substitui temporariamente ovalor permanente para esta propriedade que está definida na interface com o usuário do Architect /Server Explorer.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SetUseActiveSandboxProperty(PropertyValue)

Argumento Descrição

PropertyValue Um valor Booleano que indica se o processo deveusar o contexto do ambiente de simulação ativo aoler e gravar dados do cubo.

Se PropertyValue = 0, o processo desconsiderará ocontexto do ambiente de simulação ativo e lerá/gravará nos dados base.

Se PropertyValue = 1, o processo lerá/gravarádados do cubo no ambiente de simulação ativo.

Exemplo

SetUseActiveSandboxProperty(1);

Este exemplo fará o processo ler/gravar dados do cubo no ambiente de simulação ativo para o restantedesta execução.

Funções de Segurança do Turbo IntegratorEstas funções referem-se à segurança.

AddClientAddClient cria um novo cliente no servidor. As mudanças aplicadas por meio das funções AddClient nãoentrarão em vigor até que o procedimento de Metadados em um processo esteja concluído. Esta função,como todas as funções que atualizam metadados, não deve ser usada nas guias Dados ou Epílogo de umprocesso.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

AddClient(ClientName);

Capítulo 5. Funções do Turbo Integrator 357

Argumento Descrição

ClientName O nome do cliente que deseja incluir no servidor.

O nome do cliente é limitado a 255 caracteres/bytes.

Exemplo

AddClient('Brian');

Este exemplo inclui o cliente Brian no servidor.

AddGroupAddGroup cria um novo grupo de usuários no servidor. As mudanças aplicadas por meio da funçãoAddGroup não entrarão em vigor até que o procedimento de Metadados em um processo estejaconcluído. Esta função, como todas as funções que atualizam metadados, não deve ser usada nas guiasDados ou Epílogo de um processo.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

AddGroup(GroupName);

Argumento Descrição

GroupName O nome do grupo que você deseja criar.

Exemplo

AddGroup('Finance');

Esta função inclui o grupo de usuários Finance no servidor.

AssignClientToGroupAssignClientToGroup designa um cliente existente em um servidor para um grupo de usuários existente.Esta função designa um cliente existente em um servidor a um grupo de usuários existente.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

AssignClientToGroup(ClientName, GroupName);

Argumento Descrição

ClientName O nome do cliente que você deseja designar a umgrupo.

GroupName O grupo ao qual você deseja designar o cliente.

Exemplo

AssignClientToGroup('Brian', 'Finance');

358 IBM Planning Analytics: Referência do TM1

Este exemplo designa o cliente existente Brian ao grupo de usuários Finanças.

AssignClientPasswordAssignClientPassword designa uma senha para um cliente existente em um servidor.AssignClientPassword retorna 1 se a designação de senha for bem-sucedida e retorna 0 se a designaçãofalhar.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

AssignClientPassword (ClientName, Password);

Argumento Descrição

ClientName O nome do cliente para o qual você desejadesignar uma senha.

Senha A senha que você deseja designar ao cliente. Aodesignar uma senha, use texto simples. O TM1criptografará a senha no servidor.

As senhas devem ter pelo menos cinco caracteres.

Exemplo

AssignClientPassword ('Brian', 'flyfisher');

Este exemplo designa a senha 'flyfisher' ao cliente chamado Brian.

AssociateCAMIDToGroupAssociateCAMIDToGroup cria uma associação entre um grupo de usuários do TM1 e um CAMID.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

AssociateCAMIDToGroup(GroupName, CAMID, CAMIDDisplayValue);

Argumento Descrição

GroupName O nome do grupo do TM1 que você deseja associarao CAMID.

CAMID O nome do grupo CAMID. Se o CAMID não existir,ele será criado no cubo decontrole }ClientCAMAssociatedGroups.

CAMIDDefDisplayValue O alias do grupo CAMID.

CellSecurityCubeCreateCellSecurityCubeCreate cria um cubo de segurança a partir de um cubo existente, usando um conjuntoreduzido de dimensões. Esta função, como todas as funções que atualizam metadados, não deve serusada nas guias Dados ou Epílogo de um processo.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Capítulo 5. Funções do Turbo Integrator 359

Sintaxe

CellSecurityCubeCreate (‘DataCube’, ‘0:0:1:0’);

Argumento Descrição

Cubo Nome do cubo de dados.

DimensionMap Sequência especificando se a dimensão em cadaposição deve ser usada no cubo de segurança. Aordem das dimensões é a ordem do cubo original.1 para cada dimensão incluída e 0 para umaexcluída. Cada valor é separado por dois pontos.

Retorno booleano Verdadeiro se a operação foi bem-sucedida. Casocontrário, erro grave.

Informações adicionais A propriedade GrantSecurityAccess deve serconfigurada para que este processoTurboIntegrator seja bem-sucedido. Ela cria ocubo de segurança da célula.

Exemplo

CellSecurityCubeCreate (‘DataCube’, ‘0:0:1:0’);

Esse exemplo cria um cubo RDCLS a partir do cubo chamado Cubo de Dados.

CellSecurityCubeDestroyCellSecurityCubeDestroy destrói um cubo de segurança que foi criado a partir de um cubo existente. Estafunção, como todas as funções que atualizam metadados, não deve ser usada nas guias Dados ou Epílogode um processo.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

CellSecurityCubeDestroy (‘DataCube’, ‘0:0:1:0’);

Argumento Descrição

Cubo Nome do cubo de dados.

Retorno booleano Verdadeiro se a operação foi bem-sucedida. Casocontrário, erro grave.

Informações adicionais A propriedade GrantSecurityAccess deve serconfigurada para que este processoTurboIntegrator seja bem-sucedido. Destrói o cubode segurança da célula.

Exemplo

CellSecurityCubeDestroy (‘DataCube’);

360 IBM Planning Analytics: Referência do TM1

DeleteClientDeleteClient exclui um cliente do servidor. As mudanças aplicadas por meio da função DeleteClient nãoentrarão em vigor até que o procedimento de Metadados em um processo esteja concluído. Esta função,como todas as funções que atualizam metadados, não devem ser usadas nas guias Dados ou Epílogo deum processo

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

DeleteClient(ClientName);

Argumento Descrição

ClientName O nome do cliente que deseja excluir do servidor.

Exemplo

DeleteClient('Brian');

Este exemplo remove o cliente Brian do servidor.

DeleteGroupDeleteGroup exclui um grupo de usuários do servidor. As mudanças aplicadas por meio da funçãoDeleteGroup não entrarão em vigor até que o procedimento de Metadados em um processo estejaconcluído. Esta função, como todas as funções que atualizam metadados, não deve ser usada nas guiasDados ou Epílogo de um processo.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

DeleteGroup(GroupName);

Argumento Descrição

GroupName O grupo que você deseja excluir.

Exemplo

DeleteGroup('Finance');

Este exemplo exclui o grupo de usuários Finance do servidor.

ElementSecurityGetElementSecurityGet recupera o nível de segurança designado a um grupo especificado para um elementode dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ElementSecurityGet(DimName, ElName, Group);

Capítulo 5. Funções do Turbo Integrator 361

Argumento Descrição

DimName A dimensão-pai do elemento para o qual você estárecuperando um nível de segurança.

ElName O elemento para o qual você está recuperando umnível de segurança.

Grupo O grupo de usuários para o qual você estárecuperando um nível de segurança.

Exemplo

ElementSecurityGet('Region', 'Germany', 'Budgeting');

Este exemplo retorna o nível de segurança designado ao grupo de usuários Orçamento para o elementoAlemanha da dimensão Região.

ElementSecurityPutElementSecurityPut designa um nível de segurança a um grupo especificado para um elemento dedimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ElementSecurityPut(Level, DimName, ElName, Group);

Argumento Descrição

Nível O nível de segurança que está sendo designado.Existem seis possíveis valores de Nível:

• Nenhum• Ler• Gravar• Reservar• Bloquear• Administrador

DimName A dimensão-pai do elemento para o qual você estádesignando um nível de segurança.

ElName O elemento para o qual você está designando umnível de segurança.

Grupo O grupo de usuários para o qual você estádesignando um nível de segurança.

Exemplo

ElementSecurityPut('Reserve', 'Region', 'Germany', 'Budgeting');

362 IBM Planning Analytics: Referência do TM1

Este exemplo designa a segurança Reserve ao grupo Orçamento para o elemento Alemanha da dimensãoRegião.

HierarchyElementSecurityGetHierarchyElementSecurityGet recupera o nível de segurança designado para um grupo especificado paraum elemento de dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchyElementSecurityGet(DimName, HierName, ElName, Group);

Argumento Descrição

DimName A dimensão-pai do elemento para o qual você estárecuperando um nível de segurança.

HierName O nome da hierarquia dentro da dimensão.

ElName O elemento para o qual você está recuperando umnível de segurança.

Grupo O grupo de usuários para o qual você estárecuperando um nível de segurança.

Exemplo

HierarchyElementSecurityGet('Region', 'Europe', 'Germany', 'Budgeting');

Este exemplo retorna o nível de segurança designado ao grupo de usuários Budgeting para o elementoGermany. O elemento aparece na hierarquia Europe da dimensão Region.

HierarchyElementSecurityPutHierarchyElementSecurityPut designa um nível de segurança para um grupo especificado de umelemento de dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchyElementSecurityPut(Level, DimName, HierName, ElName, Group);

Argumento Descrição

Nível O nível de segurança que está sendo designado.Existem seis possíveis valores de Nível:

• Nenhum• Ler• Gravação• Reserva• Bloqueio• Admininistrador

Capítulo 5. Funções do Turbo Integrator 363

Argumento Descrição

DimName A dimensão-pai do elemento para o qual você estádesignando um nível de segurança.

HierName O nome da hierarquia dentro da dimensão.

ElName O elemento para o qual você está designando umnível de segurança.

Grupo O grupo de usuários para o qual você estádesignando um nível de segurança.

Exemplo

HierarchyElementSecurityPut('Reserve', 'Region', 'Europe', 'Germany', 'Budgeting');

Este exemplo designa a segurança Reserve ao grupo Budgeting para o elemento Germany. O elementoaparece na hierarquia Europe da dimensão Region.

RemoveCAMIDAssociationRemoveCAMIDAssociation remove todas as associações entre os grupos de usuários do TM1 e um CAMIDespecificado.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

RemoveCAMIDAssociation(CAMID, RemoveCAMID);

Argumento Descrição

CAMID O nome do grupo CAMID para o qual você desejaremover todas as associações de segurança.

RemoveCAMID Determina se o CAMID especificado é excluído docubo de controle }ClientCAMAssociatedGroups.

0 deixa o CAMID no cubo decontrole }ClientCAMAssociatedGroups.

1 exclui o CAMID do cubo decontrole }ClientCAMAssociatedGroups.

RemoveCAMIDAssociationFromGroupRemoveCAMIDAssociationFromGroup remove uma associação entre um grupo de usuários do TM1 e umCAMID.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

RemoveCAMIDAssociationFromGroup(GroupName, CAMID);

364 IBM Planning Analytics: Referência do TM1

Argumento Descrição

GroupName O nome do grupo de usuários do TM1 para o qualdeseja remover a associação.

CAMID O nome do grupo CAMID para o qual desejaremover a associação.

RemoveClientFromGroupRemoveClientFromGroup remove um cliente especificado de um grupo de usuários.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

RemoveClientFromGroup(ClientName, GroupName);

Argumento Descrição

ClientName O cliente que você deseja remover.

GroupName O grupo de usuários do qual você deseja remover ocliente.

Exemplo

RemoveClientFromGroup('Brian', 'Finance');

Este exemplo remove o cliente Brian do grupo de usuários Finanças.

SetHierarchyGroupsSecuritySetHierarchyGroupsSecurity configura o nível de segurança de todos os grupos existentes para ahierarquia da dimensão especificada.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SetHierarchyGroupsSecurity(securityLevel, dimension, hierarchy)

Argumento Descrição

securityLevel O nível de segurança sendo designado. Existemseis valores possíveis:

• Nenhum• Ler• Gravação• Reserva• Bloqueio• Administrador

dimensão Nome da dimensão.

Capítulo 5. Funções do Turbo Integrator 365

Argumento Descrição

hierarchy Nome da hierarquia da dimensão.

Exemplo

SetHierarchyGroupsSecurity('Reserve', 'Region', 'Europe');

Este exemplo designa a segurança Reserve para todos os grupos existentes na hierarquia Europe dadimensão Region.

SetHierarchyElementGroupsSecuritySetHierarchyElementGroupsSecurity configura o nível de segurança para um elemento especificado apartir de uma hierarquia em uma dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SetHierarchyElementGroupsSecurity(securityLevel, dimension, hierarchy, element)

Argumento Descrição

securityLevel O nível de segurança que está sendo designado.Existem seis valores possíveis:

• Nenhum• Ler• Gravação• Reserva• Bloqueio• Admininistrador

dimensão Nome da dimensão.

hierarchy Nome da hierarquia da dimensão.

elemento O elemento para o qual você está designando umnível de segurança.

Exemplo

SetHierarchyElementGroupsSecurity('Reserve', 'Region', 'Europe', 'Germany');

Este exemplo designa a segurança Reserve ao elemento Germany da hierarquia Europe na dimensãoRegion.

SetDimensionGroupsSecuritySetDimensionGroupsSecurity configura o nível de segurança de todos os grupos existentes para adimensão especificada.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

366 IBM Planning Analytics: Referência do TM1

Sintaxe

SetDimensionGroupsSecurity(securityLevel, dimension)

Argumento Descrição

securityLevel O nível de segurança que está sendo designado.Existem seis valores possíveis:

• Nenhum• Ler• Gravação• Reserva• Bloqueio• Admininistrador

dimensão Nome da dimensão.

Exemplo

SetDimensionGroupsSecurity('Reserve', 'Region');

Este exemplo designa a segurança Reserve para todos os grupos existentes na dimensão Region.

SetElementGroupsSecuritySetElementGroupsSecurity configura o nível de segurança para um elemento especificado em umadimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SetElementGroupsSecurity(securityLevel, dimension, element)

Argumento Descrição

securityLevel O nível de segurança que está sendo designado.Existem seis valores possíveis:

• Nenhum• Ler• Gravação• Reserva• Bloqueio• Admininistrador

dimensão Nome da dimensão.

elemento O elemento para o qual você está designando umnível de segurança.

Exemplo

SetElementGroupsSecurity('Reserve', 'Region', 'Germany');

Capítulo 5. Funções do Turbo Integrator 367

Este exemplo designa a segurança Reserve ao elemento Germany da dimensão Region.

SecurityOverlayGlobalLockCellSecurityOverlayGlobalLockCell é usada para bloquear um nó e, assim, restringir seus direitos de acessopara somente leitura. Ela usa a sobreposição global para que todos os usuários sejam afetados. O cubode sobreposição deve ser criado antes de usar este comando. Os elementos fornecidos no endereçodevem ser somente para as dimensões usadas na sobreposição.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SecurityOverlayGlobalLockCell(bLock, Cube, element1,..., elementN)

Argumento Descrição

bLock Se 1, bloqueie-o. 0, desbloqueie-o.

Cubo Nome do cubo.

elementN O nome do elemento de sobreposição que define atupla. A ordem deve corresponder à ordem dedimensão original do cubo.

Retorno booleano Verdadeiro se a operação foi bem-sucedida. Casocontrário, erro grave.

Informações adicionais A propriedade GrantSecurityAccess deve serconfigurada para que este processoTurboIntegrator seja bem-sucedido. Cria o cubo desobreposição de segurança global padrão.Sobreposições globais se aplicam a todos osusuários.

Exemplo

SecurityOverlayGlobalLockCell(1,’Sales’,’MA’); SecurityOverlayGlobalLockCell(0,’Products’,’MA','2011’);

No primeiro exemplo, há apenas uma dimensão usada para a sobreposição. O segundo exemplo usa duasdimensões.

SecurityOverlayCreateGlobalDefaultSecurityOverlayCreateGlobalDefault é usada para criar ou destruir um cubo de Sobreposição desegurança e para configurar a sobreposição para uma determinada área de um cubo de dados.

A criação de um cubo de dados com um nome que significa um cubo de sobreposição fará com que ocubo se torne uma sobreposição caso o servidor seja reiniciado. Ao ser carregado, o cubo seráconfigurado como uma sobreposição se um cubo de dados correspondente for localizado.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SecurityOverlayCreateGlobalDefault (Cube, DimensionMap)

368 IBM Planning Analytics: Referência do TM1

Argumento Descrição

Cubo Nome do cubo.

DimensionMap Sequência que especifica se a dimensão em cadaposição deve ser usada na sobreposição. A ordemdas dimensões é a ordem do cubo original. 1 paracada dimensão incluída e 0 para uma excluída.Cada valor é separado por dois pontos.

Retorno booleano Verdadeiro se a operação foi bem-sucedida. Casocontrário, erro grave.

Informações adicionais A propriedade GrantSecurityAccess deve serconfigurada para que este processoTurboIntegrator seja bem-sucedido. Cria o cubo desobreposição de segurança global padrão.Sobreposições globais se aplicam a todos osusuários.

Exemplo

SecurityOverlayCreateGlobalDefault(‘DataCube’, ‘0:0:1:0’);

SecurityOverlayDestroyGlobalDefaultSecurityOverlayDestroyGlobalDefault é usada para destruir um cubo de Sobreposição de segurança epara configurar a sobreposição para uma determinada área de um cubo de dados.

A criação de um cubo de dados com um nome que significa um cubo de sobreposição fará com que ocubo de dadosse torne uma sobreposição caso o servidor seja reiniciado. Quando o cubo for carregado,ele será configurado como uma sobreposição se um cubo de dados correspondente for localizado.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SecurityOverlayDestroyGlobalDefault (Cube)

Argumento Descrição

Cubo Nome do cubo.

Retorno booleano Verdadeiro se a operação foi bem-sucedida. Casocontrário, erro grave.

Informações adicionais A propriedade GrantSecurityAccess deve serconfigurada para que este processoTurboIntegrator seja bem-sucedido. Cria o cubo desobreposição de segurança global padrão.Sobreposições globais se aplicam a todos osusuários.

Capítulo 5. Funções do Turbo Integrator 369

Exemplo

SecurityOverlayDestroyGlobalDefault(‘DataCube’);

SecurityOverlayGlobalLockNodeSecurityOverlayGlobalLockNode é usada para bloquear um nó e, assim, restringir seus direitos de acessopara somente leitura. Ela usa a sobreposição global para que todos os usuários sejam afetados. O cubode sobreposição deve ser criado antes de usar este comando. Os elementos fornecidos no endereçodevem ser somente para as dimensões usadas na sobreposição.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SecurityOverlayGlobalLockNode(bLock, Cube, Address, [AddressDelimiter])

Argumento Descrição

bLock Se 1, bloqueie-o. 0, desbloqueie-o.

Cubo Nome do cubo.

Endereço Sequência convertida em token de nomes deelementos de sobreposição que definem a tupla. Aordem deve corresponder à ordem de dimensãooriginal do cubo.

Retorno de endereço Sequência de caracteres opcional usada paraseparar nomes de elemento no

parâmetro Address. Valor padrão ‘|’.

Retorno booleano Verdadeiro se a operação foi bem-sucedida. Casocontrário, erro grave.

Informações adicionais A propriedade GrantSecurityAccess deve serconfigurada para que este processoTurboIntegrator seja bem-sucedido. Cria o cubo desobreposição de segurança global padrão.Sobreposições globais se aplicam a todos osusuários.

Exemplos

SecurityOverlayGlobalLockNode(1,’Sales’,’MA’); SecurityOverlayGlobalLockNode(0,’Products’,’MA | 2011’); SecurityOverlayGlobalLockNode(0,’Products’, ‘MA : 2011’, ‘:’);

No primeiro exemplo, há somente uma dimensão usada para a sobreposição. Os outros dois exemplosusam duas dimensões.

SecurityRefreshSecurityRefresh lê todos os cubos de controle de segurança e gera novamente as estruturas internas noservidor que são usadas pelas funções da API do TM1.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

370 IBM Planning Analytics: Referência do TM1

Sintaxe

SecurityRefresh;

Argumentos

Nenhum.

Funções de Manipulação do Servidor do Turbo IntegratorEstas funções facilitam a manipulação do servidor.

BatchUpdateFinishBatchUpdateFinish instrui o servidor a sair do modo de atualização de lote.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Semântica

Quando vários processos estão sendo executados no modo de atualização de lote e aplicando mudançasa um único cubo, o esquema de bloqueio do TM1 pode evitar que um dos processos atualize o cubo. Istoé intencional; quando um processo obtiver um bloqueio para gravar mudanças em um cubo, outrosprocessos serão impedidos de gravar nesse cubo com o objetivo de manter a integridade de dados.

Este esquema de bloqueio pode ser ilustrado usando um exemplo de dois processos, Processo 1 eProcesso 2, que atualizam um único cubo.

• Os dois processos iniciam e chamam a função BatchUpdateStart para iniciar atualizações de lote.• Cada processo opera em uma origem de dados exclusiva.• O Processo 1 conclui o processamento de dados e chama a função BatchUpdateFinish. O processo

obtém um bloqueio de gravação no cubo e confirma as mudanças.• Enquanto o Processo 1 ainda suspende um bloqueio de gravação no cubo, o Processo 2 conclui o

processamento de dados e chama a função BatchUpdateFinish. No entanto, como o Processo 1 retém obloqueio, o Processo 2 não pode obter um bloqueio para o cubo. Todas as mudanças em dadosaplicadas no Processo 2 são retrocedidas e o Processo 2 é reiniciado. Isto assegura a integridade dedados.

Capítulo 5. Funções do Turbo Integrator 371

Dependendo do tamanho da origem de dados para o Processo 2, o retrocesso de dados e a novaexecução do processo podem causar uma redução considerável no desempenho. Para tratar esteproblema de desempenho, é recomendável usar a função BatchUpdateFinishWait no lugar deBatchUpdateFinish.

Sintaxe

BatchUpdateFinish(SaveChanges);

Argumento Descrição

SaveChanges Um sinalizador que instrui o servidor a salvar oudescartar mudanças confirmadas durante o modode atualização de lote.

Especifique 0 para salvar mudanças, 1 paradescartá-las.

Exemplo

BatchUpdateFinish(0);

Esse exemplo orienta o servidor a salvar as alterações em dados do TM1 e a sair do modo de atualizaçãode lote.

BatchUpdateFinishWaitBatchUpdateFinishWait é idêntica a BatchUpdateFinish, com exceção de que o processo espera até que obloqueio fique disponível e, em seguida, confirma as mudanças. Se um processo chamarBatchUpdateFinishWait, mas não puder proteger um bloqueio de gravação do cubo para confirmarmudanças, o processo esperará até que o bloqueio fique disponível e, em seguida, confirmará asmudanças.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

372 IBM Planning Analytics: Referência do TM1

As mudanças em dados aplicadas no processo não são retrocedidas e o processo não é executadonovamente.

Nota: Enquanto espera o bloqueio de gravação do cubo, o processo libera os bloqueios de leitura que eleadquiriu para outros objetos durante a execução do processo. Como estes bloqueios de leitura sãoliberados antes de o processo confirmar mudanças no cubo, os objetos para os quais os bloqueios deleitura são liberados podem ser modificados antes da atualização do cubo. Isto pode gerar inconsistênciade dados ao usar BatchUpdateFinishWait.

É recomendável que BatchUpdateFinishWait seja usada apenas em situações controladas, nas quais vocêsabe que outros processos não estão modificando dados ou metadados relacionados ao processo quechama BatchUpdateFinishWait.

Sintaxe

BatchUpdateFinishWait(SaveChanges);

Argumento Descrição

SaveChanges Um sinalizador que instrui o servidor a salvar oudescartar mudanças confirmadas durante o modode atualização de lote. Especifique 0 para salvarmudanças, 1 para descartá-las.

Exemplo

BatchUpdateFinishWait(0);

Esse exemplo orienta o servidor a salvar as alterações em dados do TM1 e a sair do modo de atualizaçãode lote.

BatchUpdateStartBatchUpdateStart ativa atualizações de lote.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

BatchUpdateStart;

Argumentos

Nenhum.

DisableBulkLoadModeDisableBulkLoadMode desativa o processamento de carregamento em massa.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

Consulte “EnableBulkLoadMode” na página 373 para obter detalhes.

EnableBulkLoadModeEnableBulkLoadMode ativa o processamento de carregamento em massa para um processo do TurboIntegrator.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Capítulo 5. Funções do Turbo Integrator 373

Sintaxe

É possível ativar o modo de carregamento em massa na seção Prólogo ou Epílogo de um processoTurboIntegrator. Para eficiência, ative o Modo de Carregamento em Massa na primeira ou muito próximoda primeira instrução na seção Prólogo de seu processo.

Depois de ativar o Modo de Carregamento em Massa em um processo, ele poderá ser desativado apenasna última linha na seção Epílogo. Se você tentar desativar o Modo de Carregamento em Massa em algumoutro lugar no processo, o processo não será compilado.

Se o modo estiver ativado em um processo TurboIntegrator, ele permanecerá ativado até ser desativadoexplicitamente ou até a tarefa de organização de processos ser concluída. Isso significa que é possívelativar o modo em um processo dentro de uma tarefa de organização de processos e depois executar umasérie de processos TurboIntegrator antes de desativá-lo. Também é possível entrar e sair do Modo deCarregamento em Massa repetidamente, usando o modo apenas para algumas partes críticas de umatarefa de organização de processos.

Use os comandos do TurboIntegrator a seguir e desative o modo de carregamento em massa em umprocesso TurboIntegrator.

EnableBulkLoadMode();

Use a função do Turbo Integrator a seguir apenas na última linha na seção Epílogo do processo do TI aousar o modo de carregamento em massa.

DisableBulkLoadMode();

RefreshMdxHierarchyRefreshMdxHierarchy atualiza as hierarquias MDX em um servidor sem exigir a reinicialização do servidor.

Use esta função depois de configurar ou editar os níveis de hierarquia nomeados customizados para umadimensão no cubo de controle }HierarchyProperties.

Para obter detalhes sobre como usar níveis denominados com dimensões, consulte a seção relacionadana documentação do IBM Cognos TM1 for Developers.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

RefreshMdxHierarchy(dimensionName, hierarchy)

Argumento Descrição

dimensionName Parâmetro de sequência opcional para especificaruma dimensão específica para atualização.

Deixe este parâmetro em branco para atualizartodas as dimensões.

hierarchy O nome da hierarquia dentro da dimensão. Este éum parâmetro opcional.

Exemplo

Atualize todas as dimensões:

RefreshMdxHierarchy('');

374 IBM Planning Analytics: Referência do TM1

Para atualizar apenas a dimensão de clientes:

RefreshMdxHierarchy('customers');

SaveDataAllSaveDataAll salva todos os dados do TM1 da memória do servidor no disco e reinicia o arquivo de log.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Usando SaveDataAll em uma Tarefa de Organização de Processos

SaveDataAll confirma todas as mudanças feitas por um tarefa de organização de processos antes dechamar a função SaveDataAll.

Enquanto uma tarefa de organização de processos está em execução, ela acumula bloqueios nos objetosque acessa. A operação de confirmação iniciada pela função SaveDataAll libera temporariamente todosestes bloqueios. Quando a confirmação estiver concluída, SaveDataAll readquirirá todos os bloqueios queela possuía antes para poder continuar acessando os objetos nos quais estava trabalhando.

Há uma breve janela durante a operação de confirmação na qual os bloqueios são liberados e outrousuário ou processo do Turbo Integrator pode excluir objetos que estavam sendo usados pela tarefa deorganização de processos original. Quando a tarefa de organização de processos original tentar readquiriros bloqueios nestes objetos, os objetos não estarão disponíveis e a tarefa de organização de processosencerrará o processamento. Neste caso, um erro semelhante ao seguinte será gravado no arquivoTm1s.log:

844 WARN 2008-04-01 16:40:09,734 TM1.Server TM1ServerImpl::FileSave couldnot reacquire lock on object with index 0x200002ca

Contenção de Bloqueio e Uso de SaveDataAll no Final dos Processos do Turbo Integrator

O uso de SaveDataAll como o último comando em um processo do Turbo Integrator pode aumentar acontenção de bloqueio nos processos do TM1 TurboIntegrator.

Nas versões do IBM TM1, SaveDataAll era frequentemente incluído no final de um processo do TurboIntegrator que carrega dados com a criação de log desativada. O SaveDataAll fornecia uma maneira degravar dados da memória no disco diretamente após uma importação bem-sucedida, de modo que osdados recém-importados não seriam perdidos no caso de um contratempo, como um travamento doservidor.

No entanto, a inclusão de SaveDataAll como último comando pode resultar em inúmeros processos deimportação do Turbo Integrator, cada um com SaveDataAll como último comando. Essa técnicafuncionava no TM1 Versão 9.0 e anteriores devido ao modelo de bloqueio anterior, que usava apenas obloqueio de gravação global. Em versões anteriores, apenas uma operação de gravação por vez erapermitida. Portanto, operações SaveDataAll concorrentes simultâneas nunca ocorriam em diversasoperações de gravação simultâneas.

A Versão 9.1 e as mais recentes introduziram um modelo de bloqueio-por-objeto mais granular quepermite operações de gravação simultâneas, caso essas operações de gravação não disputem osmesmos recursos. Se elas competirem pelos mesmos recursos, ocorrerá uma contenção de bloqueio,forçando um dos processos a retroceder. Portanto, agora dois processos de importação do TurboIntegrator podem ser executados simultaneamente se não compartilharem nenhum objeto, por exemplo,se importarem em dois cubos diferentes.

A função SaveDataAll do Turbo Integrator conta com o arquivo de log de transação tm1s.log e envolvetodos os objetos dentro de um modelo de dados. Portanto, dois processos de importação do TurboIntegrator, usando a função SaveDataAll, não podem ser executados em paralelo: um será executado e ooutro (junto com seu processo do Turbo Integrator) será forçado a retroceder. O mesmo será verdade seos processos do Turbo Integrator fizerem parte das tarefas de organização de processos: apenas umatarefa de organização de processos continuará executando a função SaveDataAll do Turbo Integrator; aoutra será forçada a retroceder.

Capítulo 5. Funções do Turbo Integrator 375

Um retrocesso é indesejável do ponto de vista do desempenho, já que aumenta o tempo de execuçãototal de um processo do Turbo Integrator ou tarefa de organização de processos. Operações SaveDataAllsimultâneas concorrentes sempre levarão a uma contenção de bloqueio e a um retrocesso.

Há duas soluções possíveis para evitar operações SaveDataAll simultâneas concorrentes:

• Não usar a função SaveDataAll do Turbo Integrator. Em vez disso, ative a Criação de Log de Cubo paraos cubos de importação.

• Se, por motivos de desempenho, não for possível ativar a Criação de log do cubo para os cubos deimportação, dentro do aplicativo TM1 deve haver apenas um processo que chama a função SaveDataAlldo Turbo Integrator. Use uma tarefa de organização de processos distinta única independente paraexecutar a operação SaveDataAll.

Sintaxe

SaveDataAll;

Argumentos

Nenhum.

ServerShutdownServerShutdown encerra um servidor que está sendo executado como um aplicativo. ServerShutdownnão pode ser usado para encerrar um servidor que está executando como um serviço do Windows.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ServerShutDown(SaveData);

Argumento Descrição

SaveData Um valor Booleano que indica se o servidor devesalvar mudanças no disco antes de ser encerrado.

Se SaveData = 0, o servidor será encerrado semsalvar mudanças.

Se SaveData = 1, o servidor salvará mudanças damemória no disco antes de ser encerrado.

Exemplo

ServerShutdown(1);

Este exemplo encerra o servidor e salva os dados em disco.

Funções de Manipulação de Subconjunto do Turbo IntegratorEstas funções facilitam a manipulação de subconjunto.

HierarchySubsetAliasSetHierarchySubsetAliasSet configura o atributo de alias a ser usado em um subconjunto.HierarchySubsetAliasSet retorna 1 em caso de êxito, caso contrário, retorna 0.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

376 IBM Planning Analytics: Referência do TM1

Sintaxe

HierarchySubsetAliasSet( DimName, HierName, SubName, AliasName );

Argumento Descrição

DimName A dimensão-pai do subconjunto para o qual vocêdeseja definir o alias.

HierName O nome da hierarquia dentro da dimensão.

SubName O subconjunto para o qual você deseja definir oalias.

AliasName O alias que você deseja usar no subconjunto.

HierarchySubsetCreateHierarchySubsetCreate cria um subconjunto público vazio de uma hierarquia e uma dimensãoespecificadas.

Quando o argumento opcional AsTemporary estiver configurado para 1, o subconjunto será temporário epersistirá somente pela duração do processo ou da tarefa de organização de processos doTurboIntegrator para a qual o subconjunto foi criado.

Nota:

Para o TM1 Server versão 11.2.0 e anterior, os subconjuntos temporários eram visíveis e utilizáveissomente pelo processo que os criou e por qualquer um de seus processos-filho. Os subconjuntostemporários não eram visíveis para os processos antecessor e irmão. Era possível criar subconjuntos demesmo nome em processos-filhos com o mesmo processo pai.

Para o TM1 Server versão 11.3.0 e mais recentes, esses subconjuntos provisórios ficam visíveis para osprocessos antecessores e processos irmãos. Se um processo pai A do Turbo Integrator chamar doisprocessos-filhos A1 e A2 do Turbo Integrator e o processo-filho A1 do Turbo Integrator criar umsubconjunto provisório S, o subconjunto provisório S existirá pela duração do processo pai A do TurboIntegrator. Não é possível criar um subconjunto provisório com o mesmo nome S no processo irmão A2do Turbo Integrator, uma vez que o subconjunto fica visível e utilizável para os irmãos A1 e A2.

Durante a existência de um subconjunto provisório, o subconjunto provisório tem precedência sobrequalquer subconjunto público de mesmo nome. Se outra função do Turbo Integrator fizer referência a umsubconjunto que existe em um estado provisório e em um estado permanente, a função operará nosubconjunto provisório.

Não há nenhum bloqueio associado a um subconjunto provisório, visto que subconjuntos provisóriosnunca são salvos. Isso pode resultar em melhor desempenho, porque o Turbo Integrator não precisaesperar a liberação de bloqueios para poder operar em um subconjunto provisório.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchySubsetCreate(DimName, HierName, SubName, [AsTemporary]);

Argumento Descrição

DimName A dimensão-pai do subconjunto que está sendocriado.

HierName O nome da hierarquia dentro da dimensão.

SubName O nome que você deseja designar ao subconjunto.

Capítulo 5. Funções do Turbo Integrator 377

Argumento Descrição

AsTemporary Este é um argumento opcional que especifica se osubconjunto que está sendo criado é provisório. 1indica um subconjunto provisório, 0 indica umsubconjunto permanente.

Se esse argumento for omitido, o subconjunto épermanente.

Exemplo

HierarchySubsetCreate('Region', 'European', 'Northern Europe', 1);

Este exemplo cria o subconjunto provisório Northern Europe da hierarquia European na dimensão Region.É possível usar SubsetElementInsert para incluir elementos no subconjunto.

HierarchySubsetDeleteAllElementsHierarchySubsetDeleteAllElements exclui todos os elementos de um subconjunto público de umahierarquia da dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchySubsetDeleteAllElements(DimName, HierName, SubsetName);

Argumento Descrição

DimName A dimensão-pai do subconjunto do qual vocêdeseja excluir elementos.

HierName O nome da hierarquia dentro da dimensão.

SubsetName O subconjunto do qual você deseja excluirelementos. Este deve ser um subconjunto público.O Turbo Integrator não pode acessar objetosparticulares.

Exemplo

HierarchySubsetDeleteAllElements('Region', 'European', 'Central Europe');

Este exemplo exclui todos os elementos do subconjunto Central Europe da hierarquia European nadimensão Region.

HierarchySubsetDestroyHierarchySubsetDestroy exclui um subconjunto do banco de dados do TM1.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchySubsetDestroy(DimName, HierName, SubName);

378 IBM Planning Analytics: Referência do TM1

Argumento Descrição

DimName A dimensão-pai do subconjunto que está sendoexcluído.

HierName O nome da hierarquia dentro da dimensão.

SubName O nome do subconjunto que você deseja excluir.

Exemplo

HierarchySubsetDestroy('Region', 'European', 'Northern Europe');

Este exemplo exclui o subconjunto Northern Europe da hierarquia da European na dimensão Region.

HierarchySubsetElementExistsHierarchySubsetElementExists determina se um elemento específico existe em um subconjunto públicoespecífico no servidor a partir do qual um processo do Turbo Integrator é executado. OHierarchySubsetElementExists não pode ser usado para determinar se um elemento existe em umsubconjunto particular.

Se o elemento existir no subconjunto especificado, a função retornará 1; do contrário, retornará 0.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchySubsetElementExists(DimName, HierName, SubsetName, ElementName);

Argumento Descrição

DimName O pai da dimensão do subconjunto que contém oelemento cuja existência deseja confirmar.

HierName O nome da hierarquia na dimensão especificada.

SubsetName O subconjunto público que contém o elementocuja existência deseja confirmar.

NomeElemento O elemento cuja existência deseja confirmar.

Exemplo

HierarchySubsetElementExists('Region', 'Eastern', 'Europe', 'Italy');

Este exemplo determina se o elemento Itália existe no subconjunto Europa, da hierarquia Oriental, dadimensão Região.

HierarchySubsetElementDeleteHierarchySubsetElementDelete exclui um elemento de um subconjunto de uma hierarquia da dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchySubsetElementDelete(DimName, HierName, SubName, Index);

Capítulo 5. Funções do Turbo Integrator 379

Argumento Descrição

DimName A dimensão-pai do subconjunto do qual vocêdeseja excluir um elemento.

HierName O nome da hierarquia dentro da dimensão.

SubName O subconjunto do qual você deseja excluir umelemento.

Índice O número de índice do elemento que você desejaexcluir do subconjunto.

Exemplo

HierarchySubsetElementDelete('Region', 'European', 'Northern Europe', 3);

Este exemplo exclui o terceiro elemento do subconjunto Northern Europe da hierarquia European nadimensão Region.

HierarchySubsetElementGetIndexHierarchySubsetElementGetIndex recupera o índice de um elemento em um subconjunto de umahierarquia da dimensão.

A função retorna o índice da primeira ocorrência do elemento especificado. Se o elemento não existir nosubconjunto ou não puder ser localizado, então será retornado zero. Se a dimensão ou o subconjunto nãopuder ser localizado ou se for especificado um índice de início fora do intervalo, será lançado um erro e afunção do TurboIntegrator será interrompida.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchySubsetElementGetIndex(DimName, HierName, SubsetName, ElementName, StartIndex);

Argumento Descrição

DimName A dimensão pai do subconjunto.

HierName O nome da hierarquia dentro da dimensão.

SubsetName O subconjunto que contém o elemento.

NomeElemento O nome de elemento a ser procurado nosubconjunto.

StartIndex O número do índice a partir do qual começar aprocurar. O valor deve estar entre 1 e o tamanhodo subconjunto.

Exemplo

HierarchySubsetElementGetIndex('Region', 'Country', 'Europe', 'Italy', 3);

Este exemplo recupera o índice para Itália, do subconjunto Europa, da hierarquia de País na dimensãoRegião. A procura é iniciada no índice 3.

HierarchySubsetElementInsertHierarchySubsetElementInsert inclui um elemento em um subconjunto existente em uma hierarquia dadimensão.

380 IBM Planning Analytics: Referência do TM1

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchySubsetElementInsert(DimName, HierName, SubName, ElName, Position);

Argumento Descrição

DimName A dimensão-pai do subconjunto no qual vocêdeseja incluir um elemento.

HierName O nome da hierarquia dentro da dimensão.

SubName O nome do subconjunto no qual está sendoincluído um elemento.

ElName O nome do elemento que você deseja incluir nosubconjunto. O elemento deve existir no banco dedados do TM1.

Posição Um valor que indica a posição de índice doelemento no subconjunto.

Exemplo

HierarchySubsetElementInsert('Region', 'European', 'Northern Europe', 'Finland',3);

Este exemplo inclui o elemento Finland no subconjunto Northern Europe da hierarquia European nadimensão Region. Finland é o terceiro elemento na definição de subconjunto.

HierarchySubsetExistsHierarchySubsetExists determina se um subconjunto público específico existe no servidor a partir do qualum processo do Turbo Integrator é executado. A função retornará 1 se o subconjunto existir no servidor,caso contrário, retornará 0. Observe que esta função não pode ser usada para determinar a existência desubconjuntos particulares.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchySubsetExists(DimName, HierName, SubsetName);

Argumento Descrição

DimName O nome da dimensão que é o pai do subconjuntocuja existência você deseja confirmar.

HierName O nome da hierarquia dentro da dimensão.

SubsetName O nome do subconjunto público cuja existênciavocê deseja confirmar

Exemplo

HierarchySubsetExists('Region', 'Industrialized, 'Northern Europe');

Este exemplo determina se o subconjunto Northern Europe existe dentro da hierarquia Industrialized dadimensão Region.

Capítulo 5. Funções do Turbo Integrator 381

HierarchySubsetGetSizeHierarchySubsetGetSize retorna o número de elementos em um subconjunto de uma hierarquia dadimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchySubsetGetSize(DimName, HierName, SubsetName);

Argumento Descrição

DimName A dimensão-pai do subconjunto para o qual vocêdeseja determinar o tamanho.

HierName O nome da hierarquia dentro da dimensão.

SubsetName O subconjunto para o qual você deseja determinaro tamanho.

Exemplo

HierarchySubsetGetSize('Region', 'Eastern', 'EurAsia');

Esta função retorna o número de elementos no subconjunto EurAsia da hierarquia Eastern na dimensãoRegion.

HierarchySubsetGetElementNameHierarchySubsetGetElementName retorna o nome do elemento em um local de índice especificadodentro de um determinado subconjunto de uma hierarquia da dimensão.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchySubsetGetElementName(DimName, HierName, SubsetName, ElementIndex);

Argumento Descrição

DimName O pai do subconjunto do qual você desejarecuperar um nome de elemento.

HierName O nome da hierarquia dentro da dimensão.

SubsetName O subconjunto do qual você deseja recuperar umnome de elemento.

ElementIndex Um número que representa a posição nosubconjunto do elemento que você desejarecuperar.

Exemplo

HierarchySubsetGetElementName('Region', 'Western', 'Americas', 4);

Este exemplo retorna o nome do quarto elemento no subconjunto Americas da hierarquia Western nadimensão Region.

382 IBM Planning Analytics: Referência do TM1

HierarchySubsetIsAllSetHierarchySubsetIsAllSet configura um subconjunto para usar todos os elementos da dimensão pai.HierarchySubsetIsAllSet retorna 1 em caso de êxito, caso contrário, retorna 0.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchySubsetIsAllSet( DimName, HierName, SubName, Flag );

Argumento Descrição

DimName A dimensão-pai do subconjunto para o qual vocêdeseja usar todos os elementos.

HierName O nome da hierarquia dentro da dimensão.

SubName O subconjunto para o qual você deseja usar todosos elementos de dimensão.

Sinalizador Um valor diferente de zero especifica que osubconjunto usa todos os elementos atuais dadimensão-pai e será atualizado dinamicamentepara usar todos os elementos da dimensão-paisempre que o subconjunto for chamado.

Especificar um valor zero congelará os elementosno subconjunto como o conjunto atual de todos oselementos na dimensão-pai. O subconjunto nãoserá atualizado dinamicamente para usar todos oselementos de dimensão no futuro.

HierarchySubsetMDXGetHierarchySubsetMDXGet recupera a expressão MDX usada para criar um subconjunto.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchySubsetMDXGet(DimName, HierName, SubName);

Argumento Descrição

DimName A dimensão pai do subconjunto.

HierName O nome da hierarquia dentro da dimensão.

SubName O subconjunto para o qual você deseja recuperar aexpressão MDX.

Exemplo

mdxString = HierarchySubsetMDXGet('Cities', 'Italy', 'testsubset');

HierarchySubsetMDXSetHierarchySubsetMDXSet remove a expressão MDX de um subconjunto dinâmico e converte o subconjuntodinâmico em um subconjunto estático sem bloquear a dimensão subjacente. Os conteúdos dosubconjunto são preservados, mas a expressão é removida. Opcionalmente, também é possívelpreencher o subconjunto com uma nova expressão MDX.

Capítulo 5. Funções do Turbo Integrator 383

Todos os elementos antigos no momento da chamada são salvos como elementos do novo subconjuntoestático. A função retorna o número de elementos que o novo subconjunto contém.

Nota: Esta função funciona apenas com subconjuntos públicos.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

HierarchySubsetMDXSet(DimName, HierName, SubName, MDX_expression);

Argumento Descrição

DimName A dimensão pai do subconjunto.

HierName O nome da hierarquia dentro da dimensão.

SubName O subconjunto para o qual você deseja remover aexpressão MDX.

MDX_expression A expressão MDX com a qual você desejapreencher o subconjunto. Todos os elementos sãoexcluídos e o subconjunto é preenchido com oselementos, como definido pela nova expressãoMDX. Se a expressão MDX for inválida, oprocessamento do TurboIntegrator é interrompido,o conteúdo do subconjunto não é alterado e umerro é registrado.

Se você não usa este parâmetro, inclua umasequência de caracteres vazia, conforme mostradono exemplo.

Exemplo

countMem = HierarchySubsetMDXSet('Cities', 'Italy', 'testsubset', '');

SubsetAliasSetSubsetAliasSet configura o atributo de alias a ser usado em um subconjunto. SubsetAliasSet retornará 1se bem-sucedida, caso contrário, retornará 0.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SubsetAliasSet( DimName, SubName, AliasName );

Argumento Descrição

DimName A dimensão-pai do subconjunto para o qual vocêdeseja definir o alias.

SubName O subconjunto para o qual você deseja definir oalias.

AliasName O alias que você deseja usar no subconjunto.

SubsetCreateSubsetCreate cria um subconjunto público vazio de uma dimensão especificada.

384 IBM Planning Analytics: Referência do TM1

Quando o argumento AsTemporary estiver configurado como 1, o subconjunto será provisório epersistirá somente pela duração do processo do Turbo Integrator ou de uma tarefa de organização deprocessos de confirmação única na qual o subconjunto foi criado. Caso um processo pai do TurboIntegrator chame processos-filhos do Turbo Integrator utilizando a função ExecuteProcess ou a funçãoExecuteProcessWithReturn e o subconjunto provisório seja criado em um desses processos-filhos doTurbo Integrator, o subconjunto persistirá pela duração do processo pai do Turbo Integrator.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Nota:

Para o TM1 Server versão 11.2.0 e anteriores, as visualizações e os subconjuntos provisórios ficavamvisíveis e utilizáveis apenas para o processo que os criará e para qualquer um de seus processos-filhos.As visualizações e os subconjuntos temporários não ficavam visíveis para os processos antecessores eprocessos irmãos. Era possível criar subconjuntos de mesmo nome em processos-filhos com o mesmoprocesso pai.

Para o TM1 Server versão 11.3.0 e mais recentes, esses subconjuntos provisórios ficam visíveis para osprocessos antecessores e processos irmãos. Se um processo pai A do Turbo Integrator chamar doisprocessos-filhos A1 e A2 do Turbo Integrator e o processo-filho A1 do Turbo Integrator criar umsubconjunto provisório S, o subconjunto provisório S existirá pela duração do processo pai A do TurboIntegrator. Não é possível criar um subconjunto provisório com o mesmo nome S no processo irmão A2do Turbo Integrator, uma vez que o subconjunto fica visível e utilizável para os irmãos A1 e A2.

Uma tarefa de organização de processos é um caso especial de um processo pai do Turbo Integrator quechama um processo filho do Turbo Integrator que está planejado para execução em um horárioespecífico. É possível usar dois tipos de tarefas de organização de processos.

Confirmação únicaDentro do escopo / da árvore de execução de uma tarefa de organização de processos de confirmaçãoúnica, um subconjunto provisório com o mesmo nome pode ser criado apenas para um processo-filhodo Turbo Integrator.

Diversas confirmaçõesDentro do escopo / da árvore de execução de uma tarefa de organização de processos de diversasconfirmações, que faz confirmações após cada processo-filho do Turbo Integrator, cada processo-filho do Turbo Integrator pode criar um subconjunto provisório com o mesmo nome, porque osubconjunto temporário não persistirá após uma confirmação.

Durante a existência de um subconjunto provisório, o subconjunto provisório tem precedência sobrequalquer subconjunto público ou privado de mesmo nome. Se outra função do Turbo Integrator fizerreferência a um subconjunto que existe em um estado provisório e em um estado permanente, a funçãooperará no subconjunto provisório.

Não há nenhum bloqueio associado a um subconjunto provisório, visto que subconjuntos provisóriosnunca são salvos. Isso pode resultar em melhor desempenho, porque o Turbo Integrator não precisaesperar a liberação de bloqueios para poder operar em um subconjunto provisório.

Sintaxe

SubsetCreate(DimName, SubName, [AsTemporary]);

Argumento Descrição

DimName A dimensão-pai do subconjunto que está sendocriado.

SubName O nome que você deseja designar para osubconjunto.

Capítulo 5. Funções do Turbo Integrator 385

Argumento Descrição

AsTemporary Este é um argumento opcional que especifica se osubconjunto que está sendo criado é provisório. 1indica um subconjunto provisório. 0 indica umsubconjunto permanente.

Se esse argumento for omitido, o subconjunto épermanente.

Exemplo

SubsetCreate('Region', 'Northern Europe', 1);

Este exemplo cria o subconjunto provisório Norte Europeu da dimensão Região. É possível usarSubsetElementInsert para incluir elementos no subconjunto.

SubsetCreateByMDXSubsetCreateByMDX cria um subconjunto público baseado em uma expressão MDX transmitida.

Quando o argumento AsTemporary for configurado como 1, o subconjunto será temporário e persistiráenquanto o processo TurboIntegrator durar ou enquanto uma tarefa de organização de processos deconfirmação única na qual o subconjunto foi criado durar. Caso um processo pai do Turbo Integratorchame processos-filhos do Turbo Integrator utilizando a função ExecuteProcess ou a funçãoExecuteProcessWithReturn e o subconjunto provisório seja criado em um desses processos-filhos doTurbo Integrator, o subconjunto persistirá pela duração do processo pai do Turbo Integrator.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Nota:

Para o TM1 Server versão 11.2.0 e anteriores, as visualizações e os subconjuntos provisórios ficavamvisíveis e utilizáveis apenas para o processo que os criará e para qualquer um de seus processos-filhos.As visualizações e os subconjuntos temporários não ficavam visíveis para os processos antecessores eprocessos irmãos. Era possível criar subconjuntos de mesmo nome em processos-filhos com o mesmoprocesso pai.

Para o TM1 Server versão 11.3.0 e mais recentes, esses subconjuntos provisórios ficam visíveis para osprocessos antecessores e processos irmãos. Se um processo pai A do Turbo Integrator chamar doisprocessos-filhos A1 e A2 do Turbo Integrator e o processo-filho A1 do Turbo Integrator criar umsubconjunto provisório S, o subconjunto provisório S existirá pela duração do processo pai A do TurboIntegrator. Não é possível criar um subconjunto provisório com o mesmo nome S no processo irmão A2do Turbo Integrator, uma vez que o subconjunto fica visível e utilizável para os irmãos A1 e A2.

Uma tarefa de organização de processos é um caso especial de um processo pai do Turbo Integrator quechama um processo-filho do Turbo Integrator. É possível usar dois tipos de tarefas de organização deprocessos.

Confirmação únicaDentro do escopo / da árvore de execução de uma tarefa de organização de processos de confirmaçãoúnica, um subconjunto provisório com o mesmo nome pode ser criado apenas para um processo-filhodo Turbo Integrator.

Diversas confirmaçõesDentro do escopo / da árvore de execução de uma tarefa de organização de processos de diversasconfirmações, que faz confirmações após cada processo-filho do Turbo Integrator, cada processo-filho do Turbo Integrator pode criar um subconjunto provisório com o mesmo nome, porque osubconjunto temporário não persistirá após uma confirmação.

Durante a existência de um subconjunto provisório, o subconjunto provisório tem precedência sobrequalquer subconjunto público ou privado de mesmo nome. Se outra função do Turbo Integrator fizer

386 IBM Planning Analytics: Referência do TM1

referência a um subconjunto que existe em um estado provisório e em um estado permanente, a funçãooperará no subconjunto provisório.

Não há nenhum bloqueio associado a um subconjunto provisório, visto que subconjuntos provisóriosnunca são salvos. Isso pode resultar em melhor desempenho, porque o Turbo Integrator não precisaesperar a liberação de bloqueios para poder operar em um subconjunto provisório.

Sintaxe

SubsetCreatebyMDX(SubName, MDX_Expression, [AsTemporary]);

Argumento Descrição

SubName O nome que você deseja designar ao subconjunto.

MDX_Expression Uma expressão MDX que retorna um subconjunto.

AsTemporary Este é um argumento opcional que especifica se osubconjunto que está sendo criado é provisório. 1indica um subconjunto provisório. 0 indica umsubconjunto permanente.

Se esse argumento for omitido, o subconjunto épermanente.

Exemplo

SubsetCreatebyMDX('0-level months', '{TM1SORT( {TM1FILTERBYLEVEL( {TM1SUBSETALL([month] )}, 0)}, ASC)} ', 1 );

Este exemplo cria um subconjunto provisório chamado '0-level months' com base em uma expressãoMDX que retorna um subconjunto composto por todos os elementos de nível 0 na dimensão Month, que éclassificada em ordem alfabética crescente.

Exemplo de subconjunto temporário usado pelo processo pai

Neste exemplo, dois processos são criados. O processo pai, Process-A, chama o processo-filho, Process-B. O Process-B cria um subconjunto temporário que o Process-A usa como a origem de dados.

Process-A/prólogo:

ExecuteProcess('Process-B');DatasourceDimensionSubset = 'My2003Months';

Process-B/prólogo:

SubsetCreateByMdx('My2003Months', '{[plan_time].[Jan-2003],[plan_time].[Jul-2003]}', 1);

SubsetDeleteAllElementsSubsetDeleteAllElements exclui todos os elementos de um subconjunto público.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SubsetDeleteAllElements(DimName, SubsetName);

Capítulo 5. Funções do Turbo Integrator 387

Argumento Descrição

DimName A dimensão-pai do subconjunto do qual vocêdeseja excluir elementos.

SubsetName O subconjunto do qual você deseja excluirelementos. Este deve ser um subconjunto público.O Turbo Integrator não pode acessar objetosparticulares.

Exemplo

SubsetDeleteAllElements('Region', 'Central Europe');

Este exemplo exclui todos os elementos de subconjunto Europa Central da dimensão Região.

SubsetDestroySubsetDestroy exclui um subconjunto do banco de dados do TM1.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SubsetDestroy(DimName, SubName);

Argumento Descrição

DimName A dimensão-pai do subconjunto que está sendoexcluído.

SubName O nome do subconjunto que você deseja excluir.

Exemplo

SubsetDestroy('Region', 'Northern Europe');

Este exemplo exclui o subconjunto Norte Europeu da dimensão Região.

SubsetElementDeleteSubsetElementDelete exclui um elemento de um subconjunto.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SubsetElementDelete(DimName, SubName, Index);

Argumento Descrição

DimName A dimensão-pai do subconjunto do qual vocêdeseja excluir um elemento.

SubName O subconjunto do qual você deseja excluir umelemento.

Índice O número de índice do elemento que você desejaexcluir do subconjunto.

388 IBM Planning Analytics: Referência do TM1

Exemplo

SubsetElementDelete('Region', 'Northern Europe', 3);

Este exemplo exclui o terceiro elemento do subconjunto Norte Europeu da dimensão Região.

SubsetElementExistsSubsetElementExists determina se um elemento específico existe em um subconjunto público específicoa partir do qual um processo do Turbo Integrator é executado. O SubsetElementExists não pode serusado para determinar se um elemento existe em um subconjunto particular.

Se o elemento existir no subconjunto especificado, a função retornará 1; do contrário, retornará 0.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SubsetElementExists(DimName, SubsetName, ElementName);

Argumento Descrição

DimName O pai da dimensão do subconjunto que contém oelemento cuja existência deseja confirmar.

SubsetName O subconjunto público que contém o elementocuja existência deseja confirmar.

NomeElemento O elemento cuja existência deseja confirmar.

Exemplo

SubsetElementExists('Region', 'Europe', 'Italy');

Este exemplo determina se o elemento Itália existe no subconjunto Europa da dimensão Região.

SubsetElementGetIndexSubsetElementGetIndex recupera o índice de um elemento em um subconjunto. A função retorna oíndice da primeira ocorrência do elemento especificado.

Se o elemento não existir no subconjunto ou não puder ser localizado, então será retornado zero. Se adimensão ou o subconjunto não puder ser localizado ou se for especificado um índice de início fora dointervalo, será lançado um erro e a função do TurboIntegrator será interrompida.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SubsetElementGetIndex(DimName, SubsetName, ElementName, StartIndex);

Argumento Descrição

DimName A dimensão pai do subconjunto.

SubsetName O subconjunto que contém o elemento.

NomeElemento O nome (ou alias) de elemento a ser procurado nosubconjunto.

Capítulo 5. Funções do Turbo Integrator 389

Argumento Descrição

StartIndex O número do índice a partir do qual começar aprocurar. O valor deve estar entre 1 e o tamanhodo subconjunto.

Exemplo

SubsetElementGetIndex('Region', 'Europe', 'Italy', 3);

Este exemplo recupera o índice para Itália, do subconjunto Europa, da dimensão Região. A procura éiniciada no índice 3.

SubsetElementInsertSubsetElementInsert inclui um elemento em um subconjunto existente.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SubsetElementInsert(DimName, SubName, ElName, Position);

Argumento Descrição

DimName A dimensão-pai do subconjunto no qual vocêdeseja incluir um elemento.

SubName O nome do subconjunto no qual está sendoincluído um elemento.

ElName O nome do elemento que você deseja incluir nosubconjunto. O elemento deve existir no banco dedados do TM1.

Posição Um valor que indica a posição de índice doelemento no subconjunto.

Exemplo

SubsetElementInsert('Region', 'Northern Europe', 'Finland', 3);

Este exemplo inclui o elemento Finlândia no subconjunto Norte Europeu da dimensão Região. Finland é oterceiro elemento na definição de subconjunto.

SubsetExistsSubsetExists determina se um subconjunto público específico existe no servidor a partir do qual umprocesso do Turbo Integrator é executado.

A função retornará 1 se o subconjunto existir no servidor, caso contrário, retornará 0. Observe que estafunção não pode ser usada para determinar a existência de subconjuntos particulares.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SubsetExists(DimName, SubsetName);

390 IBM Planning Analytics: Referência do TM1

Argumento Descrição

DimName O nome da dimensão que é o pai do subconjuntocuja existência você deseja confirmar.

SubsetName O nome do subconjunto público cuja existênciavocê deseja confirmar

Exemplo

SubsetExists('Region', 'Northern Europe');

Este exemplo determina se o subconjunto Norte da Europa do cubo Região existe no servidor.

SubsetExpandAboveSetSubsetExpandAboveSet configura a propriedade Expand Above para um subconjunto. A função retornará1 se bem-sucedida, caso contrário, retornará 0.

Quando esta propriedade for definida como TRUE, os filhos de uma consolidação serão exibidos acima daconsolidação quando a consolidação for exibida uma linha, e à esquerda da consolidação quando aconsolidação for exibida em uma coluna.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SubsetExpandAboveSet( DimName, SubsetName, ExpandAboveFlag);

Argumento Descrição

DimName A dimensão-pai do subconjunto para o qual vocêdeseja definir a propriedade Expandir Acima.

SubsetName O subconjunto para o qual você deseja definir apropriedade Expandir Acima.

ExpandAboveFlag Defina ExpandAboveFlag como 1 para definir apropriedade Expandir Acima como TRUE. Quandoesta propriedade for TRUE, as consolidações serãoexpandidas acima nas linhas e à esquerda nascolunas.

Defina ExpandAboveFlag como 0 para definir apropriedade Expandir Acima como FALSE. Quandoesta propriedade for FALSE, as consolidaçõesserão expandidas abaixo nas linhas e à direita nascolunas.

Exemplo

SubsetExpandAboveSet('Region', 'Europe', 1 );

Este exemplo define a propriedade Expandir Acima como TRUE para o subconjunto Europa da dimensãoRegião.

SubsetFormatStyleSetSubsetFormatStyleSet aplica um estilo de exibição existente em um determinado subconjunto.

Capítulo 5. Funções do Turbo Integrator 391

Os estilos de exibição são definidos para elementos específicos. Se você aplicar um estilo de exibiçãoexistente a um subconjunto que inclui elementos que não estão incluídos no estilo de exibição, nenhumaformatação será aplicada a esses elementos.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SubsetFormatStyleSet( DimName, SubsetName, FormatName);

Argumento Descrição

DimName A dimensão-pai do subconjunto ao qual vocêdeseja aplicar um estilo de exibição.

SubsetName O nome do subconjunto ao qual está sendoaplicado um estilo de exibição.

FormatName O nome do estilo de exibição existente que vocêdeseja aplicar ao subconjunto.

Exemplo

SubsetFormatStyleSet ('Region', 'Northern Europe', 'BoldCurrencyLeftJustified');

Este exemplo aplica o estilo de exibição BoldCurrencyLeftJustified ao subconjunto Norte Europeu dadimensão Região.

SubsetGetElementNameSubsetGetElementName retorna o nome do elemento em um local de índice especificado dentro de umdeterminado subconjunto.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SubsetGetElementName(DimName, SubsetName, ElementIndex);

Argumento Descrição

DimName O pai do subconjunto do qual você desejarecuperar um nome de elemento.

SubsetName O subconjunto do qual você deseja recuperar umnome de elemento.

ElementIndex Um número que representa a posição nosubconjunto do elemento que você desejarecuperar.

Exemplo

SubsetGetElementName('Region', 'Americas', 4);

Este exemplo retorna o nome do quarto elemento no subconjunto Américas da dimensão Região.

SubsetGetSizeSubsetGetSize retorna o número de elementos em um subconjunto.

392 IBM Planning Analytics: Referência do TM1

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SubsetGetSize(DimName, SubsetName);

Argumento Descrição

DimName A dimensão-pai do subconjunto para o qual vocêdeseja determinar o tamanho.

SubsetName O subconjunto para o qual você deseja determinaro tamanho.

Exemplo

SubsetGetSize('Region', 'EurAsia');

Esta função retorna o número de elementos no subconjunto Eurásia da dimensão Região.

SubsetIsAllSetSubsetIsAllSet configura um subconjunto para usar todos os elementos da dimensão pai. SubsetIsAllSetretornará 1 se bem-sucedida, caso contrário, retornará 0.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SubsetIsAllSet( DimName, SubName, Flag );

Argumento Descrição

DimName A dimensão-pai do subconjunto para o qual vocêdeseja usar todos os elementos.

SubName O subconjunto para o qual você deseja usar todosos elementos de dimensão.

Sinalizador Um valor diferente de zero especifica que osubconjunto usa todos os elementos atuais dadimensão-pai e será atualizado dinamicamentepara usar todos os elementos da dimensão-paisempre que o subconjunto for chamado.

Especificar um valor zero congelará os elementosno subconjunto como o conjunto atual de todos oselementos na dimensão-pai. O subconjunto nãoserá atualizado dinamicamente para usar todos oselementos de dimensão no futuro.

SubsetMDXGetSubsetMDXGet recupera a expressão MDX usada para criar um subconjunto.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SubsetMDXGet(DimName, SubName);

Capítulo 5. Funções do Turbo Integrator 393

Argumento Descrição

DimName A dimensão pai do subconjunto.

SubName O subconjunto para o qual você deseja recuperar a expressão MDX.

Exemplo

mdxString = SubsetMDXGet('Cities', 'testsubset');

SubsetMDXSetSubsetMDXSet remove a expressão MDX de um subconjunto dinâmico e converte o subconjunto dinâmicopara um subconjunto estático sem bloquear a dimensão subjacente. Os conteúdos do subconjunto sãopreservados, mas a expressão é removida. Opcionalmente, também é possível preencher o subconjuntocom uma nova expressão MDX.

Todos os elementos antigos no momento da chamada são salvos como elementos do novo subconjuntoestático. A função retorna o número de elementos que o novo subconjunto contém.

Nota: Esta função funciona apenas com subconjuntos públicos.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

SubsetMDXSet(DimName, SubName, MDX_expression);

Argumento Descrição

DimName A dimensão pai do subconjunto.

SubName O subconjunto para o qual você deseja remover aexpressão MDX.

MDX_expression A expressão MDX com a qual você desejapreencher o subconjunto. Todos os elementos sãoexcluídos e o subconjunto é preenchido com oselementos, como definido pela nova expressãoMDX. Se a expressão MDX for inválida, oprocessamento do TurboIntegrator é interrompido,o conteúdo do subconjunto não é alterado e umerro é registrado.

Se você não usa este parâmetro, inclua umasequência de caracteres vazia, conforme mostradono exemplo.

Exemplo

countMem = SubsetMDXSet('Cities', 'testsubset', '');

Funções de Manipulação de Visualização do Turbo IntegratorEstas funções referem-se à manipulação de visualização.

PublishViewPublishView publica uma visualização privada nomeada no servidor.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

394 IBM Planning Analytics: Referência do TM1

Sintaxe

PublishView(Cube, View, PublishPrivateSubsets, OverwriteExistingView);

Argumento Descrição

Cubo O nome do cubo que contém a visualizaçãoparticular a ser publicada.

Visualizar O nome da visualização particular a ser publicada.

PublishPrivateSubsets Este argumento Booleano (1 ou 0) determina sealgum subconjunto particular presente navisualização também deve ser publicado.

Se PublishPrivateSubsets for true (1), todos ossubconjuntos particulares usados na visualizaçãoserão publicados juntamente com a visualização.

Se este argumento for false (0), os subconjuntosparticulares não serão publicados. Umavisualização pública não pode conter subconjuntosparticulares, portanto, a visualização não serápublicada e será gravado um erro no arquivo de logdo Turbo Integrator.

Nota: Se um subconjunto particular contiver outrosubconjunto particular como uma consolidaçãodefinida pelo usuário, o subconjunto nunca poderáser publicado usando a função PublishView,independentemente do valor do argumentoPublishPrivateSubsets.

OverwriteExistingView Este argumento Booleano (1 ou 0) determina sealguma visualização pública existente com nomeidêntico deve ser sobrescrita quando a visualizaçãoparticular for publicada.

Se OverwriteExistingView for true (1), qualquervisualização pública existente com nome idênticoserá sobrescrita quando a visualização particularfor publicada.

Se este argumento for false (0), a visualizaçãopública não será sobrescrita, a visualizaçãoparticular não será publicada e será gravado umerro no arquivo de log do Turbo Integrator.

DisableMTQViewConstructDisableMTQViewConstruct desativa o processamento de consultas multiencadeadas ao calcular umavisualização a ser usada como uma origem de dados do Turbo Integrator para um único processo doTurbo Integrator. Quando MTQQuery=T no arquivo tms1.cfg, DisableMTQViewConstruct pode serchamado para substituir esse valor em um processo do Turbo Integrator.

Essa função deve aparecer no Prólogo; ela não tem efeito em nenhum outro procedimento dentro de umprocesso.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Capítulo 5. Funções do Turbo Integrator 395

Sintaxe

Nota: Se o valor do parâmetro MTQ for 1 (ou OFF), esta funcionalidade será totalmente desativada e nãopoderá ser substituída.

O valor de MTQQuery pode ser substituído em um único processo do Turbo Integrator, chamando afunção DisableMTQViewConstruct.

Se MTQQuery=T (o padrão), DisableMTQViewConstruct poderá ser chamado para desativar afuncionalidade para processos individuais do Turbo Integrator.

Após a ativação de EnableMTQViewConstruct em um processo, só é possível desativá-lo na última linhana seção Epílogo. Se você tentar usar DisableMTQViewConstruct em qualquer outro lugar no processo, oprocesso não será compilado.

Se o modo estiver ativado em um processo TurboIntegrator, ele permanecerá ativado até ser desativadoexplicitamente ou até a tarefa de organização de processos ser concluída. Isso significa que é possívelativar o modo em um processo e, em seguida, executar uma série de processos do Turbo Integrator antesde desativá-lo.

Exemplo

Use os comandos do Turbo Integrator a seguir para desativar o processamento de consultasmultiencadeadas ao calcular uma visualização a ser usada como uma origem de dados do TurboIntegrator para um único processo do Turbo Integrator.

DisableMTQViewConstruct()

Consulte também “EnableMTQViewConstruct” na página 396.

EnableMTQViewConstructEnableMTQViewConstruct ativa o processamento de consultas multiencadeadas ao calcular umavisualização para ser usada como uma origem de dados do Turbo Integrator para um único processo doTurbo Integrator. Quando MTQQuery=F no arquivo tms1.cfg, EnableMTQViewConstruct pode serchamado para substituir esse valor em um processo do Turbo Integrator.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

Nota: Se o valor do parâmetro MTQ for 1 (ou OFF), esta funcionalidade será totalmente desativada e nãopoderá ser substituída.

O valor de MTQQuery pode ser substituído em um único processo do Turbo Integrator, chamando afunção EnableMTQViewConstruct.

Se MTQQuery=F no arquivo tms1.cfg no servidor no qual essa função é executada,EnableMTQViewConstruct pode ser chamado para substituir esse valor em um único processo do TurboIntegrator.

É possível ativar EnableMTQViewConstruct na seção Prólogo ou Epílogo de um processo do TurboIntegrator. Por questão de eficiência, ative EnableMTQViewConstruct na primeira instrução, ou em umainstrução muito próxima da primeira, na seção Prólogo do processo.

Exemplo

Use os comandos do Turbo Integrator a seguir para ativar o processamento de consultasmultiencadeadas ao calcular uma visualização a ser usada como uma origem de dados do TurboIntegrator para um único processo do Turbo Integrator.

EnableMTQViewConstruct()

Consulte também “DisableMTQViewConstruct” na página 395.

396 IBM Planning Analytics: Referência do TM1

Após a ativação de EnableMTQViewConstruct em um processo, só é possível desativá-lo na última linhana seção Epílogo. Ao tentar desativar DisableMTQViewConstruct em qualquer outro lugar no processo, oprocesso não será compilado.

Se o modo estiver ativado em um processo TurboIntegrator, ele permanecerá ativado até ser desativadoexplicitamente ou até a tarefa de organização de processos ser concluída. Isso significa que é possívelativar o modo em um processo e, em seguida, executar uma série de processos do Turbo Integrator antesde desativá-lo.

ViewColumnDimensionSetViewColumnDimensionSet configura uma dimensão de coluna para uma visualização do TM1.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewColumnDimensionSet(CubeName, ViewName, DimName, StackPosition);

Argumento Descrição

CubeName O cubo-pai da visualização para a qual está sendodefinida a dimensão da coluna.

ViewName A visualização para a qual está sendo definida adimensão da coluna.

DimName A dimensão que você deseja definir como umadimensão da coluna para a visualização.

StackPosition Um número que indica a posição da pilha dadimensão na visualização. Este é um númerobaseado em 1. 1 indica a posição da pilha maiselevada. 2 indica uma posição abaixo de 1, e assimpor diante.

Exemplo

ViewColumnDimensionSet('98sales', 'Quarter1', 'Month', 1);

Este exemplo define Mês como uma dimensão da coluna para a visualização 1Trimestre do cubo 98sales.No caso de dimensões da coluna empilhadas, Mês é colocado na posição mais elevada.

ViewColumnSuppressZeroesSetViewColumnSuppressZeroesSet suprime ou ativa a exibição de colunas que contêm apenas valores zeroem uma visualização do cubo do TM1.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewColumnSuppressZeroesSet(Cube, ViewName, Flag);

Argumento Descrição

Cubo O cubo-pai da visualização para a qual você desejasuprimir ou ativar a exibição de valores zero.

Capítulo 5. Funções do Turbo Integrator 397

Argumento Descrição

ViewName A visualização para a qual você deseja ativar ousuprimir a exibição de zeros.

Sinalizador Um valor binário que ativa ou suprime zeros.Especifique 1 para suprimir a exibição de colunascontendo apenas zeros na visualização.Especifique 0 para ativar a exibição de colunascontendo apenas zeros.

Exemplo

ViewColumnSuppressZeroesSet('99sales', '1st QuarterActuals', 1);

Este exemplo suprime a exibição de colunas contendo apenas zeros na visualização Valores Reais do 1ºTrimestre do cubo 99sales.

ViewConstructViewConstruct constrói, pré-calcula e armazena uma visualização Stargate na memória em um servidor.Esta função é útil para pré-calcular e armazenar visualizações grandes, para que elas possam serrapidamente acessadas após um carregamento ou atualização de dados.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewConstruct(CubeName, ViewName);

Argumento Descrição

CubeName O cubo a partir do qual você deseja construir avisualização.

ViewName A visualização que você deseja construir. Estavisualização deve ser uma visualização públicaexistente no servidor.

Exemplo

Viewconstruct('99sales', '1st Quarter Actuals');

Este exemplo cria a visualização 1st Quarter Actuals do cubo 99sales.

ViewCreateViewCreate cria uma visualização vazia de um cubo especificado.

Quando o argumento opcional AsTemporary estiver configurado para 1, a visualização será temporária epersistirá somente pela duração do processo ou da tarefa de organização de processos doTurboIntegrator para a qual o subconjunto foi criado.

Nota:

Para o TM1 Server versão 11.2.0 e anteriores, as visualizações temporárias eram visíveis e utilizáveissomente pelo processo que as criou e para qualquer um de seus processos-filho. As visualizaçõestemporárias não eram visíveis para os processos antecessor e irmão. Era possível criar visualizações como mesmo nome em processos-filho irmãos com o mesmo processo pai.

398 IBM Planning Analytics: Referência do TM1

Para o TM1 Server versão 11.3.0 e mais recente, essas visualizações temporárias são visíveis para osprocessos antecessor e irmão. Se um processo pai TurboIntegrator A chamar dois processos-filho TurboIntegrator A1 e A2 e o processo filho Turbo Integrator A1 criar uma visualização temporária S, avisualização temporária S existirá enquanto o processo pai TurboIntegrator A durar. Não será possívelcriar uma visualização temporária com o mesmo nome S no processo Turbo Integrator A2 porque avisualização é visível e utilizável pelos irmãos A1 e A2.

Durante a existência de uma visualização provisória, a visualização provisória tem precedência sobrequalquer visualização pública de mesmo nome. Se outra função Turbo Integrator fizer referência a umavisualização que existe em um estado temporário e em um estado permanente, a função operará navisualização temporária.

Objetos temporários têm escopo de transação. Quando uma transação é confirmada, todos os objetostemporários são limpos. Se uma tarefa de organização de processos for executada em modo deconfirmação única, em que todos os processos nela são executados logicamente dentro do contexto deuma transação, os objetos temporários criados em um processo ainda existirão, serão visíveis e estarãodisponíveis para uso em processos subsequentes executados pela mesma tarefa. No entanto, no modomulticonfirmação, esses processos são limpos no momento da confirmação da transação que agrupou aexecução do processo que criou o objeto temporário.

Não há nenhum bloqueio associado a uma visualização provisória, visto que visualizações provisóriasnunca são salvas. Isso pode resultar em melhor desempenho, porque o Turbo Integrator não precisaesperar a liberação de bloqueios para poder operar em uma visualização provisória.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewCreate(Cube, ViewName, <AsTemporary>);

Argumento Descrição

Cubo O cubo-pai da visualização que está sendo criada.

ViewName O nome que você deseja designar à visualização.

AsTemporary Este é um argumento opcional que especifica se avisualização que está sendo criada é provisória. 1indica uma visualização provisória, 0 indica umavisualização permanente.

Se esse argumento for omitido, a visualização épermanente.

Exemplo

Este exemplo cria uma visualização provisória chamada Valores Reais do 1° Trimestre do cubo Vendas.

ViewCreate('Sales', '1st Quarter Actuals', 1);

ViewCreateByMDXViewCreateByMDX cria uma visualização com uma expressão MDX especificada.

Quando o argumento opcional AsTemporary estiver configurado para 1, a visualização será temporária epersistirá somente pela duração do processo ou da tarefa de organização de processos doTurboIntegrator para a qual o subconjunto foi criado.

Nota:

Capítulo 5. Funções do Turbo Integrator 399

Para o TM1 Server versão 11.2.0 e anteriores, as visualizações temporárias eram visíveis e utilizáveissomente pelo processo que as criou e para qualquer um de seus processos-filho. As visualizaçõestemporárias não eram visíveis para os processos antecessor e irmão. Era possível criar visualizações como mesmo nome em processos-filho irmãos com o mesmo processo pai.

Para o TM1 Server versão 11.3.0 e mais recente, essas visualizações temporárias são visíveis para osprocessos antecessor e irmão. Se um processo pai TurboIntegrator A chamar dois processos-filho TurboIntegrator A1 e A2 e o processo filho Turbo Integrator A1 criar uma visualização temporária S, avisualização temporária S existirá enquanto o processo pai TurboIntegrator A durar. Não será possívelcriar uma visualização temporária com o mesmo nome S no processo Turbo Integrator A2 porque avisualização é visível e utilizável pelos irmãos A1 e A2.

Durante a existência de uma visualização provisória, a visualização provisória tem precedência sobrequalquer visualização pública de mesmo nome. Se outra função do Turbo Integrator fizer referência auma visualização que existe em um estado provisório e em um estado permanente, a função operará navisualização provisória.

Objetos temporários têm escopo de transação. Quando uma transação é confirmada, todos os objetostemporários são limpos. Se uma tarefa de organização de processos for executada em modo deconfirmação única, em que todos os processos nela são executados logicamente dentro do contexto deuma transação, os objetos temporários criados em um processo ainda existirão, serão visíveis e estarãodisponíveis para uso em processos subsequentes executados pela mesma tarefa. No entanto, no modomulticonfirmação, esses processos são limpos no momento da confirmação da transação que agrupou aexecução do processo que criou o objeto temporário.

Não há nenhum bloqueio associado a uma visualização provisória, visto que visualizações provisóriasnunca são salvas. Isso pode resultar em um desempenho melhorado porque não há necessidade de oTurboIntegrator esperar que bloqueios sejam liberados antes de operar em uma visualização temporária.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewCreateByMDX(Cube, ViewName, MDX_expression , <AsTemporary>);

Argumento Descrição

Cubo O cubo-pai da visualização que está sendo criada.

ViewName O nome que você deseja designar à visualização.

MDX_expression Um valor de sequência contendo uma expressãode visualização válida.

AsTemporary Este é um argumento opcional que especifica se avisualização que está sendo criada é provisória. 1indica uma visualização temporária e 0 indica umavisualização permanente.

Se esse argumento for omitido, a visualização épermanente.

Exemplo

Esse exemplo, com base no banco de dados de amostra do Planning, cria uma visualização temporáriadenominada Conta no cubo plan_BudgetPlan.

ViewCreateByMDX ('plan_BudgetPlan', 'Account', 'select {FY 2003 Budget]} on 0, {[plan_business_unit].[10300]} on 1 from plan_budgetplan where

400 IBM Planning Analytics: Referência do TM1

[plan_department].[200][plan_chart_of_accounts].[41101][plan_exchange_rates].[local][plan_source].[goal][plan_time].[Jan-2003 ] ' ,1);

ViewDestroyViewDestroy exclui uma visualização do banco de dados do TM1.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewDestroy(Cube, ViewName);

Argumento Descrição

Cubo O cubo-pai da visualização que está sendoexcluída.

ViewName O nome da visualização que você deseja excluir.

Exemplo

ViewDestroy('99sales', '1st Quarter Actuals');

Este exemplo exclui a visualização Valores Reais do 1º Trimestre do cubo 99sales.

ViewExistsViewExists determina se uma visualização pública específica existe no servidor a partir do qual umprocesso do Turbo Integrator é executado. A função retornará 1 se a visualização existir no servidor, casocontrário, retornará 0. Observe que esta função não pode ser usada para determinar a existência devisualizações particulares.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewExists(CubeName, ViewName);

Argumento Descrição

CubeName O nome do cubo que é o pai da visualização cujaexistência você deseja confirmar.

ViewName O nome da visualização pública cuja existênciavocê deseja confirmar

Exemplo

ViewExists('Inventory', 'FebClosing');

Este exemplo determina se a visualização FebClosing do cubo Inventário existe no servidor.

ViewExtractFilterByTitlesSetViewExtractFilterByTitlesSet configura uma opção para a filtragem por títulos em valores consolidadosque são excluídos de uma visualização ou de quaisquer extrações de visualização associadas.

Capítulo 5. Funções do Turbo Integrator 401

O TM1 permite o armazenamento de sequências em valores calculados. Ao excluir um valor calculado deuma visualização ou extração de visualização, você pode desejar excluir a sequência de caracteres damensagem também da visualização.

Nota: Esta função afeta as visualizações como elas existem no servidor. O escopo dessa função não érestrito às extrações geradas a partir de uma visualização.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewExtractFilterByTitlesSet (Cube, ViewName, FilterByTitles, Temporary);

Argumento Descrição

Cubo O cubo-pai da visualização para a qual está sendodefinida a opção.

ViewName A visualização para a qual está sendo definida aopção.

FilterByTitles Um valor binário que ativa ou desativa a opção.Especifique 0 para incluir os títulos armazenadosem valores consolidados. Este é comportamentoatual e padrão. Especifique 1 para excluir os títulosarmazenados em valores consolidados.

Provisório Um valor booleano que indica que as configuraçõessão provisórias.

Exemplo

ViewExtractFilterByTitlesSet ('99sales', '1st QuarterActuals', 1, 0);

ViewExtractSkipCalcsSetViewExtractSkipCalcsSet configura uma opção para incluir/excluir valores consolidados em umavisualização e quaisquer extrações de visualização associadas. Uma extração de visualização é umavisualização do TM1 exportada como um arquivo ASCII delimitado por vírgulas (.cma).

Nota: Esta função afeta as visualizações como elas existem no servidor. O escopo dessa função não érestrito às extrações geradas a partir de uma visualização.

ViewExtractSkipCalcsSet é o equivalente da opção Ignorar Valores Consolidados na caixa de diálogoExtração de Visualização.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewExtractSkipCalcsSet (Cube, ViewName, Flag);

Argumento Descrição

Cubo O cubo-pai da visualização para a qual está sendodefinida a opção.

402 IBM Planning Analytics: Referência do TM1

Argumento Descrição

ViewName A visualização para a qual está sendo definida aopção.

Sinalizador Um valor binário que ativa ou desativa a opção.Especifique 1 para excluir valores consolidados daextração de visualização. Especifique 0 para incluirvalores consolidados.

Exemplo

ViewExtractSkipCalcsSet ('99sales', '1st Quarter Actuals', 1);

Este exemplo ativa a opção Ignorar Valores Consolidados para a visualização Valores Reais do 1ºTrimestre. A extração de visualização não incluirá nenhum valor consolidado.

Observação sobre o impacto da ativação de uma combinação específica de funções de manipulaçãode visualização

Considere o cenário em que todas essas condições são verdadeiras:

• a medida é uma sequência• ViewExtractSkipCalcsSet = 1• ViewExtractSkipConsolidatedStringsSet = 0 (não é utilizada função)• ViewExtractSkipRuleValuesSet = 0 (não é utilizada função)

Nesse cenário, o resultado será diferente se função ViewExtractSkipZeroesSet for ativada ou não.

• Se a configuração for ViewExtractSkipZeroesSet = 0, o servidor TM1 irá enumerar todas as células docubo possíveis, não apenas as células de dados existentes. Essa situação é bastante incomum, vistoque a enumeração de todas as células possíveis significa que o número de células digitalizadas é oproduto dos lados de todas as dimensões do cubo. Esse produto pode se tornar muito granderapidamente. Nesse modo, a função ViewExtractSkipCalcsSet ignorará todas as células consolidadas,mesmo que a medida seja uma sequência.

• Se a configuração for ViewExtractSkipZeroesSet = 1, o servidor TM1 digitalizará apenas as células querealmente estão no cubo. Nesse modo, uma sequência armazenada em uma célula consolidada étratada como uma simples folha (afinal, a célula tem um valor simples e é uma folha). Portanto, emboraa função ViewExtractSkipCalcsSet esteja ativada, a entrada não é ignorada, visto que essa célula não éuma célula consolidada calculada. Nesse caso, se você desejar que as entradas sejam ignoradas,deverá ativar a função ViewExtractSkipConsolidatedStringsSet.

ViewExtractSkipConsolidatedStringsSetViewExtractSkipConsolidatedStringsSet configura uma opção para excluir sequências em valoresconsolidados que são excluídos de uma visualização ou de quaisquer extrações de visualizaçãoassociadas. Uma extração de visualização é uma visualização do TM1 exportada como um arquivo ASCIIdelimitado por vírgulas (.cma).

O TM1 permite o armazenamento de sequências em valores calculados. Ao excluir um valor calculado deuma visualização ou extração de visualização, você pode desejar excluir a sequência de caracteres damensagem também da visualização.

Nota: Esta função afeta as visualizações como elas existem no servidor. O escopo dessa função não érestrito às extrações geradas a partir de uma visualização.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Capítulo 5. Funções do Turbo Integrator 403

Sintaxe

ViewExtractSkipConsolidatedStringSet (Cube, ViewName, Flag);

Argumento Descrição

Cubo O cubo-pai da visualização para a qual está sendodefinida a opção.

ViewName A visualização para a qual está sendo definida aopção.

Sinalizador Um valor binário que ativa ou desativa a opção.Especifique 0 para incluir sequências armazenadasem valores consolidados. Este é comportamentoatual e padrão. Especifique 1 para excluirsequências de caracteres armazenadas em valoresconsolidados.

Nota: Leia sobre o impacto da ativação de uma combinação específica de funções de manipulação devisualização.

Exemplo

ViewExtractSkipConsolidatedStringsSet ('99sales', '1st QuarterActuals', 1);

Este exemplo ativa a opção Ignorar Regra para Sequência Consolidada para a extração criada a partir davisualização Valores Reais do 1º Trimestre. A extração não incluirá nenhuma sequência no valorconsolidado.

ViewExtractSkipRuleValuesSetViewExtractSkipRuleValuesSet configura uma opção para incluir/excluir valores calculados por regras emuma visualização e em quaisquer extrações de visualização associadas. Uma extração de visualização éuma visualização do TM1 exportada como um arquivo ASCII delimitado por vírgulas (.cma).

ViewExtractSkipRuleValuesSet é o equivalente da opção Ignorar Valores Calculados por Regras na caixade diálogo Extração de Visualização.

Nota: Esta função afeta as visualizações como elas existem no servidor. O escopo dessa função não érestrito às extrações geradas a partir de uma visualização.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewExtractSkipRuleValuesSet (Cube, ViewName, Flag);

Argumento Descrição

Cubo O cubo-pai da visualização para a qual está sendodefinida a opção.

ViewName A visualização para a qual está sendo definida aopção.

404 IBM Planning Analytics: Referência do TM1

Argumento Descrição

Sinalizador Um valor binário que ativa ou desativa a opção.Especifique 1 para excluir valores calculados porregras da extração. Especifique 0 para incluirvalores calculados por regras.

Nota: Leia sobre o impacto da ativação de uma combinação específica de funções de manipulação devisualização.

Exemplo

ViewExtractSkipRuleValuesSet ('99sales', '1st QuarterActuals', 1);

Este exemplo ativa a opção Ignorar Valores Calculados por Regras para a extração criada a partir davisualização Valores Reais do 1º Trimestre. A extração não incluirá nenhum valor calculado por regra.

ViewExtractSkipZeroesSetViewExtractSkipZeroesSet configura uma opção para incluir/excluir valores de zero em uma visualizaçãoe em quaisquer extrações de visualização associadas. Uma extração de visualização é uma visualizaçãodo TM1 exportada como um arquivo ASCII delimitado por vírgulas (.cma).

ViewExtractSkipZeroesSet é o equivalente da opção Ignorar Valores Zero/Em Branco na caixa de diálogoExtração de Visualização.

Nota: Esta função afeta as visualizações como elas existem no servidor. O escopo dessa função não érestrito às extrações geradas a partir de uma visualização.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewExtractSkipZeroesSet (Cube, ViewName, Flag);

Argumento Descrição

Cubo O cubo-pai da visualização para a qual está sendodefinida a opção Ignorar Zeros.

ViewName A visualização para a qual está sendo definida aopção Ignorar Zeros.

Sinalizador Um valor binário que ativa ou desativa a opção.Especifique 1 para excluir zeros da extração.Especifique 0 para incluir zeros.

Quando UNDEFVALS for usado para representarzeros, os valores não serão excluídos quando oargumento Sinalização for 1.

Nota: Leia sobre o impacto da ativação de uma combinação específica de funções de manipulação devisualização.

Exemplo

ViewExtractSkipZeroesSet ('99sales', '1st Quarter Actuals', 1);

Capítulo 5. Funções do Turbo Integrator 405

Este exemplo ativa a opção Ignorar Zeros para a extração criada a partir da visualização Valores Reais do1º Trimestre. A extração não incluirá nenhum valor zero ou em branco.

ViewMDXSetViewMDXSet configura a expressão MDX para uma visualização MDX existente.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewMDXSet(Cube, ViewName, MDX_expression);

Argumento Descrição

Cubo O cubo-pai da visualização que está sendo criada.

ViewName O nome que você deseja designar à visualização.

MDX_expression Um valor de sequência contendo uma expressãode visualização válida.

Exemplo

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 exemplo configura a expressão MDX para a visualização "Conta" do cubo "Vendas".

ViewMDXGetViewMDXGet recupera a expressão MDX para uma visualização MDX existente.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewMDXGet(Cube, ViewName);

Argumento Descrição

Cubo O cubo-pai da visualização que está sendo criada.

ViewName O nome que você deseja designar à visualização.

Exemplo

ViewMDXGet('Sales', 'Account');

Este exemplo recupera a expressão MDX da visualização "Conta".

ViewRowDimensionSetViewRowDimensionSet configura uma dimensão de linha para uma visualização do TM1.

406 IBM Planning Analytics: Referência do TM1

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewRowDimensionSet(CubeName, ViewName, DimName, StackPosition);

Argumento Descrição

CubeName O cubo-pai da visualização para a qual está sendodefinida a dimensão da linha.

ViewName A visualização para a qual está sendo definida adimensão da linha.

DimName A dimensão que você deseja definir como umadimensão da linha para a visualização.

StackPosition Um número que indica a posição da pilha dadimensão na visualização. Este é um númerobaseado em 1. 1 indica a posição da pilha daextremidade esquerda. 2 indica a posição à direitade 1, e assim por diante.

Nota: Um cliente do TM1 pode configurar umparâmetro Tm1p.ini(BrowseDisplayReadsRightToLeft=T) que reverte aorientação dos dados no Cube Viewer. Quando aorientação de dados for revertida, as posições depilhas também serão revertidas. 1 indica a posiçãoda pilha da extremidade direita. 2 indica a posiçãoà esquerda de 1, e assim por diante.

Exemplo

ViewRowDimensionSet('98sales', 'Quarter1', 'Month',1)

Este exemplo define Mês como uma dimensão da linha para a visualização 1Trimestre do cubo 98sales.No caso de dimensões da linha empilhadas, Mês é colocado na posição da extremidade esquerda.

ViewRowSuppressZeroesSetViewRowSuppressZeroesSet suprime ou ativa a exibição de linhas que contêm apenas valores zero emuma visualização do cubo do TM1.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewRowSuppressZeroesSet(Cube, ViewName, Flag);

Argumento Descrição

Cubo O cubo-pai da visualização para a qual você desejasuprimir ou ativar a exibição de valores zero.

ViewName A visualização para a qual você deseja ativar ousuprimir a exibição de zeros.

Capítulo 5. Funções do Turbo Integrator 407

Argumento Descrição

Sinalizador Um valor binário que ativa ou suprime zeros.Especifique 1 para suprimir a exibição de linhascontendo apenas zeros na visualização.Especifique 0 para ativar a exibição de linhascontendo apenas zeros.

Exemplo

ViewRowSuppressZeroesSet('99sales', '1st Quarter Actuals', 1);

Este exemplo suprime a exibição de linhas contendo apenas zeros na visualização Valores Reais do 1ºTrimestre do cubo 99sales.

ViewSubsetAssignViewSubsetAssign designa um subconjunto nomeado a uma visualização do cubo.

Nota: É possível criar um subconjunto provisório com as funções CreateSubset ou CreateSubsetByMDX.Se você tentar usar ViewSubsetAssign para designar um subconjunto provisório para uma visualizaçãopermanente, a função falhará com uma notificação de erro.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewSubsetAssign(Cube, ViewName, DimName, SubName);

Argumento Descrição

Cubo O cubo-pai da visualização para a qual está sendodesignado um subconjunto.

ViewName A visualização para a qual está sendo designadoum subconjunto.

DimName A dimensão-pai do subconjunto que está sendodesignado à visualização.

SubName O nome do subconjunto que você deseja designar àvisualização.

Exemplo

ViewSubsetAssign('99sales', '1st Quarter Actuals', 'Month', 'Q1');

Este exemplo designa o subconjunto Q1 da dimensão Mês à visualização 1º Trimestre.

ViewSuppressZeroesSetViewSuppressZeroesSet suprime ou ativa a exibição de todas as linhas e colunas que contêm apenasvalores zero em uma visualização do cubo do TM1.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

408 IBM Planning Analytics: Referência do TM1

Sintaxe

ViewSuppressZeroesSet(Cube, ViewName, Flag);

Argumento Descrição

Cubo O cubo-pai da visualização para a qual você desejasuprimir ou ativar a exibição de valores zero.

ViewName A visualização para a qual você deseja ativar ousuprimir a exibição de zeros.

Sinalizador Um valor binário que ativa ou suprime zeros.Especifique 1 para suprimir a exibição de linhas oucolunas contendo apenas zeros na visualização.Especifique 0 para ativar a exibição de linhas ecolunas contendo apenas zeros.

Exemplo

ViewSuppressZeroesSet('99sales', '1st Quarter Actuals', 1);

Este exemplo suprime a exibição de linhas ou colunas contendo apenas zeros na visualização ValoresReais do 1º Trimestre do cubo 99sales.

ViewTitleDimensionSetViewTitleDimensionSet configura uma dimensão de título para uma visualização do TM1.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewTitleDimensionSet(CubeName, ViewName, DimName);

Argumento Descrição

CubeName O cubo-pai da visualização para a qual está sendodefinida a dimensão de título.

ViewName A visualização para a qual está sendo definida adimensão de título.

DimName A dimensão que você deseja definir como umadimensão de título para a visualização.

Exemplo

ViewTitleDimensionSet('98sales', 'Quarter1', 'Month');

Este exemplo define Mês como uma dimensão de título para a visualização 1Trimestre do cubo 98sales.

ViewTitleElementSetViewTitleElementSet configura um elemento de título para uma visualização do TM1.ViewTitleElementSet é usada juntamente com a função ViewTitleDimensionSet.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Capítulo 5. Funções do Turbo Integrator 409

Sintaxe

ViewTitleElementSet(CubeName, ViewName, DimName, Index);

Argumento Descrição

CubeName O cubo-pai da visualização para a qual está sendodefinido o elemento do título.

ViewName A visualização para a qual está sendo definido oelemento do título.

DimName A dimensão-pai do elemento do título.

Índice Um índice para a dimensão especificada que indicao elemento a ser definido como o elemento dotítulo.

Exemplo

ViewTitleElementSet('98sales', 'Quarter1', 'Model', 3);

Este exemplo define o terceiro elemento da dimensão do Modelo como um elemento do título para avisualização Trimestre1 do cubo 98sales.

ViewZeroOutViewZeroOut configura todos os pontos de dados em uma visualização como zero.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ViewZeroOut(Cube, ViewName);

Argumento Descrição

Cubo O cubo-pai da visualização que você deseja zerar.

ViewName A visualização que você deseja zerar.

Exemplo

ViewZeroOut('99sales', '1st Quarter Actuals');

Este exemplo define todos os pontos de dados na visualização Valores Reais do 1º Trimestre como zero.

Diversas Funções do Turbo IntegratorEstas funções facilitam diversas tarefas.

AddInfoCubeRestrictionAddInfoCubeRestriction filtra os dados do InfoCube à medida em que eles são extraídos para o TM1. Useesta função para restringir os valores que são importados para uma característica especificada. Estafunção deve ser colocada no Prólogo. A função pode ser chamada várias vezes para filtrar mais de umacaracterística em um único processo.

410 IBM Planning Analytics: Referência do TM1

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

AddInfoCubeRestriction(STRING CharactName, STRING sign,STRING compOperator, STRING lowValue, STRING highValue)

Argumento Descrição

STRING CharactName Contém o nome técnico da característica a serrestringida. O tipo de dado precisa ser umasequência de caracteres com um comprimentoigual ou menor que 30.

STRING sign Contém I (= inclusive) ou E (= exclusivo). Exclusivoé o NÃO lógico para a restrição especificada poresta linha. O tipo de dado precisa ser um caracterede comprimento 1.

STRING compOperator Contém o operador comparativo relacional. O tipode dado precisa ser uma sequência de caracteresde comprimento 2. Os operadores comparativossão:

'EQ' = igual

'NE' = diferente

'LT' = menor que

'GT' = maior que

'LE' = menor ou igual

'GE' = maior ou igual

'BT' = entre

'NB' = não entre

STRING lowValue Contém o valor baixo para o operador especificadona linha anterior. O tipo de dado precisa ser umasequência de caracteres com um comprimentoigual ou menor que 60.

STRING highValue Contém o valor alto para o operador especificadoduas linhas antes. O tipo de dado precisa ser umasequência de caracteres com um comprimentoigual ou menor que 60. Ele é necessário apenaspara os operadores BT e NB, caso contrário, éignorado, e neste caso, uma sequência vazia deveser colocada aqui.

Exemplo

O exemplo a seguir retorna todos os valores característicos entre 1997 e 2000.

AddInfoCubeRestriction('0CALYEAR','E','BT','1997','2000');

Capítulo 5. Funções do Turbo Integrator 411

O exemplo a seguir retorna todos os valores característicos que não estão entre 1997 e 2000.

AddInfoCubeRestriction('0CALYEAR','I','NB','1997', '2000') ;

O exemplo a seguir retorna todos os valores característicos diferentes de USD.

AddInfoCubeRestriction('0DOC_CURRCY', 'I', 'NE', 'USD','') ;

ExecuteJavaNO ExecuteJavaN executa um processo Java™ Turbo Integrator que retorna um número. Se desejaexecutar um processo Java Turbo Integrator que retorna uma sequência, use o ExecuteJavaS.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

ExecuteJavaN('JavaTIClass', ['OptionalParameter1', 'OptionalParameter2', ...] )

Argumento Descrição

JavaTIClass O nome completo da classe do Java TurboIntegrator que você deseja executar.

OptionalParameters Os parâmetros opcionais que são passados para opróprio processo do Java Turbo Integrator. Épossível passar quantos parâmetros foremnecessários, incluindo nenhum.

Só é possível passar sequências como parâmetros,não é possível passar números. É possível usar afunção StringToNumber Turbo Integrator parapassar números para scripts do Java TurboIntegrator. Para obter mais informações, consulteo "StringToNumber" na Referência do TM1.

Uma classe Java Turbo Integrator, que retorna um número e pode ser chamada de ExecuteJavaN, deveusar o padrão a seguir:

package com.example;

import com.ibm.cognos.tm1.javati.JavaTI;

@JavaTIpublic class MyTestTI { public static double MyTestTI (String [] args) [ ... return...; }}

Exemplo

ExecuteJavaN('com.example.MyTestTI', 'First', 'Second', 'Third');

ExecuteJavaSO ExecuteJavaS executa um processo Java Turbo Integrator que retorna uma sequência. Se desejaexecutar um processo do Java Turbo Integrator que retorna um número, use ExecuteJavaN.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

412 IBM Planning Analytics: Referência do TM1

Sintaxe

ExecuteJavaS('JavaTIClass', ['OptionalParameter1', 'OptionalParameter2', ...] )

Argumento Descrição

JavaTIClass O nome completo da classe do Java TurboIntegrator que você deseja executar.

OptionalParameters Os parâmetros opcionais que são passados para opróprio processo do Java Turbo Integrator. Épossível passar quantos parâmetros foremnecessários, incluindo nenhum.

Só é possível passar sequências como parâmetros,não é possível passar números. É possível usar afunção StringToNumber Turbo Integrator parapassar números para scripts do Java TurboIntegrator. Para obter mais informações, consulteo "StringToNumber" na Referência do TM1.

Uma classe do Java Turbo Integrator, que retorna uma sequência e é chamada de ExecuteJavaS, deveusar o padrão a seguir.

package com.example;

import com.ibm.cognos.tm1.javati.JavaTI;

@JavaTIpublic class MyTestTI { public static String MyTestTI (String [] args) [ ... return...; }}

Exemplo

ExecuteJavaS('com.example.MyTestTI', 'First', 'Second', 'Third');

ExpandirExpande os nomes de variáveis do Turbo Integrator, colocados entre sinais de %, para seus valores notempo de execução. Um uso comum da função Expand é transmitir o valor de variáveis do TurboIntegrator para a função ODBCOutput.

Se o nome de variável representar uma variável de sequência, toda a expressão da variável deverá sercolocada entre aspas. Por exemplo, "%V1%".

Se Expandir for alimentado com um valor numérico, uma conversão de tipo implícita será executada e ovalor numérico convertido em uma sequência.

Essa sequência tem um comprimento mínimo fixo de 10 caracteres. Se o número convertido for muitopequeno para preencher 10 caracteres, ele será preenchido com espaços extras. Apenas três caracteresdecimais extras são convertidos. Por exemplo, um valor numérico de 0.123456789 é convertido nasequência "0.123".

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

Expand(String);

Capítulo 5. Funções do Turbo Integrator 413

Argumento Descrição

Sequência Qualquer sequência que inclui nomes de variáveisdo Turbo Integrator colocados entre sinais %.

Exemplo

ODBCOutPut( 'TransData', Expand( 'INSERT INTO SALES( MONTH, PRODUCT, SALES ) VALUES ( "%V0%", "%V1%",%V2% )' ) );

Este exemplo ilustra o uso da função Expand na função ODBCOutput. O exemplo insere registros em umatabela relacional chamada Vendas, que consiste em três colunas: Mês, Produto e Vendas.

A função Expand converte as variáveis V0, V1 e V2 em seus valores reais na visualização. Supondo que oprimeiro valor na visualização seja 123.456 e seja definido pelos elementos Jan e Widget

Expand( 'INSERT INTO SALES ( MONTH, PRODUCT, SALES ) VALUES ("%V0%", "%V1%",%V2% )' )

torna-se

'INSERTINTO SALES ( MONTH, PRODUCT, SALES ) VALUES ( Jan, Widget,123.456 )'

no tempo de execução.

FileExistsFileExists determina se um arquivo especificado existe. A função retornará 1 se o arquivo existir, 0 se elenão existir.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

FileExists(File);

Argumento Descrição

Arquivo O nome de um arquivo. Se um caminho completonão for especificado, o TM1 procurará o arquivo nodiretório de dados do servidor.

Exemplo

FileExists('C:\tm1s7\pdata\model.dim');

Este exemplo determina se existe o arquivo model.dim.

LogOutputLogOutput grava uma mensagem no arquivo tm1server.log quando um erro de um nível de severidadeespecificado é encontrado em um processo do Turbo Integrator.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Pré-requisitos

Para ativar a criação de log de mensagens do Turbo Integrator, deve-se incluir o depuradorTM1.TILogOutput no arquivo tm1-log.properties e configurar o depurador para o nível desejado.

414 IBM Planning Analytics: Referência do TM1

Por exemplo, incluir TM1.TILogOutput=DEBUG em tm1-log.properties permitirá a criação de logpara todos os níveis de severidade. Para obter detalhes sobre o arquivo tm1-log.properties, consulte"Configurando e ativando a criação de log de mensagens do servidor" em TM1 Operations.

Sintaxe

LogOutput('SeverityLevel', 'MessageString');

Argumento Descrição

SeverityLevel O nível de severidade que inicia a criação de log noarquivo tm1server.log. Os valores válidos para esseargumento são:

• 'DEBUG'• 'INFO'• 'WARN'• 'ERROR'• 'FATAL'

MessageString A mensagem que deseja gravar no arquivotm1server.log. A sequência de mensagem pode seruma sequência entre aspas simples ou pode seroutra função do TurboIntegrator que retorna umasequência.

Exemplos

LogOutput('WARN', 'TI process encountered a warning condition');

LogOutput('ERROR', TM1User() );

TM1UserTM1User retorna uma sequência que fornece o cliente atual do TM1. Quando executada em um processoexecutado diretamente pelo usuário, ela retornará o nome do cliente do TM1 do usuário. Quandoexecutada em uma tarefa de organização de processos executada diretamente pelo usuário, ela tambémretornará o nome do cliente do TM1 do usuário.

Se executada em uma tarefa de organização de processos planejada, ela retorna um nome no formatoR*<chore name>, por exemplo, R*UpdateRegionDimension.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Sintaxe

TM1User()

WildcardFileSearchWildcardFileSearch permite usar caracteres curinga para procurar arquivos em um diretório especificado.

Os resultados da função WildCardFileSearch podem variar, dependendo do sistema operacional em uso.Arquivos em um diretório do Windows são armazenados em ordem alfabética enquanto os arquivos emum diretório UNIX são armazenados em uma ordem aleatória. Como a ordem de classificação defereentre os sistemas operacionais, a função idêntica WildCardFileSearch executou em diretórios idênticos,um em Windows e um em UNIX, os resultados serão diferentes.

Essa função é válida apenas em processos do Turbo Integrator do TM1.

Capítulo 5. Funções do Turbo Integrator 415

Sintaxe

WildcardFileSearch( Pathname, PriorFilename);

Argumento Descrição

Pathname Um nome do caminho para arquivos que vocêdeseja procurar. O nome do caminho deve terminarcom um nome do arquivo, que pode conter umasequência de curingas usando os caracteres *e/ou? .

O caractere curinga ? corresponde a qualquercaractere único.

O caractere curinga * corresponde a zero ou maiscaracteres.

PriorFilename O nome de um arquivo existente no diretórioespecificado. Este nome do arquivo não podeconter caracteres curinga. A procura de caracterescuringa especificada pelo argumento Pathnamecomeçará DEPOIS deste arquivo.

Se for transmitida uma sequência vazia como oargumento PriorFilename, a funçãoWildcardFileSearch retornará o primeiro arquivoque corresponde à sequência de curingasespecificada pelo argumento Pathname.

Exemplo

O seguinte exemplo mostra o uso da função WildcardFileSearch para determinar o primeiro arquivo de logdo servidor gerado em 2004:

file = WildcardFileSearch( 'C:\Program Files\Cognos\TM1\Custom\TM1Data\SData\tm1s2004*.log', ' ');

Este exemplo retorna o primeiro arquivo que corresponde à sequência de curingas 'tm1s2004*.log' nodiretório C:\Program Files\Cognos\TM1\Custom\TM1Data\SData\.

Como os arquivos de log do servidor são nomeados e salvos com registros de data e hora sequenciais, ecomo o segundo parâmetro para WildcardFileSearch está vazio, a função retorna o primeiro arquivo delog do servidor, iniciando com os caracteres 'tm1s2004'. Este seria o primeiro arquivo de log do servidorgerado no ano 2004.

O seguinte exemplo mostra o uso da função WildcardFileSearch para retornar o primeiro arquivo de logdo servidor após o tm1s20040211153827.log ser gerado:

file = WildcardFileSearch( 'C:\Program Files\Cognos\TM1\Custom\TM1Data\SData\tm1s*.log', 'tm1s20040211153827.log');

Este exemplo começa procurando no diretório C:\Program Files\Cognos\TM1\Custom\TM1Data\SData\imediatamente após o arquivo tm1s20040211153827.log, e retorna o primeiro arquivo subsequente quecorresponde à sequência de curingas 'tm1s*.log'.

tm1s20040220175522.log é o primeiro arquivo que ocorre após tm1s20040211153827.log ecorresponde à sequência de curingas. De forma apropriada, o exemplo retornatm1s20040220175522.log.

416 IBM Planning Analytics: Referência do TM1

Capítulo 6. Variáveis do Turbo IntegratorAs variáveis do IBM Planning Analytics são listadas aquipor categorias.

Variáveis Locais do Turbo IntegratorAo executar um processo do Turbo Integrator, é gerado um conjunto de variáveis locais implícitas. Asvariáveis locais existem apenas no contexto do processo no qual elas são usadas, e não estão disponíveisfora do processo. As variáveis locais são destruídas quando um processo é encerrado. Estas variáveis,listadas abaixo, podem ser sobrescritas para manipular um processo.

DatasourceASCIIDecimalSeparatorEsta variável local do Turbo Integrator define o separador decimal a ser usado em qualquer conversão deuma sequência em um número ou de um número em uma sequência. Se você definir esta variável,também deverá definir a variável DatasourceASCIIThousandSeparator.

O caractere especificado deve ser um caractere ASCII para impressão padrão, com um valor decimal queesteja compreendido a partir de 33 e até 127.

Sintaxe

DatasourceASCIIDecimalSeparator='Char';

ou

DatasourceASCIIDecimalSeparator=Char(xx);

Argumento Descrição

Carac O caractere ASCII a ser usado como um separador.

O caractere pode ser especificado como umcaractere entre aspas simples ou como um códigodecimal ASCII Char sem aspas.

Qualquer um dos exemplos a seguir configura o caractere de vírgula (,) como o separador.

DatasourceASCIIDecimalSeparator=',';

DatasourceASCIIDecimalSeparator=Char(44);

DatasourceASCIIDelimiterEsta variável local do Turbo Integrator define o caractere ASCII a ser usado como um delimitador decampo quando DatasourceType for 'CHARACTERDELIMITED".

O caractere especificado deve ser um caractere ASCII para impressão padrão, com um valor decimal queesteja compreendido a partir de 33 e até 127.

Sintaxe

DatasourceASCIIDelimiter='Char';

© Copyright IBM Corp. 2007, 2019 417

ou

DatasourceASCIIDelimiter=Char(xx);

Argumento Descrição

Carac O caractere ASCII a ser usado como umdelimitador.

O caractere pode ser especificado como umcaractere entre aspas simples ou como um códigodecimal ASCII Char sem aspas.

Um dos seguintes exemplos configura o caractere de hífen (-) como o delimitador de campo.

DatasourceASCIIDelimiter='-';

DatasourceASCIIDelimiter=Char(45);

DatasourceASCIIHeaderRecordsEsta variável local do TurboIntegrator indica o número de registros a serem ignorados antes doprocessamento da origem de dados.

Sintaxe

DatasourceASCIIHeaderRecords=N;

Argumento Descrição

N O número de registros a serem ignorados antes doprocessamento da origem de dados.

DatasourceASCIIQuoteCharacterEsta variável local do Turbo Integrator define o caractere ASCII usado para delimitar os campos doarquivo de origem quando DatasourceType for 'CHARACTERDELIMITED'.

O caractere especificado deve ser um caractere ASCII para impressão padrão, com um valor decimal queesteja compreendido a partir de 33 e até 127.

Sintaxe

DatasourceASCIIQuoteCharacter='Char';

ou

DatasourceASCIIQuoteCharacter=Char(xx);

Argumento Descrição

Carac O caractere ASCII que delimita campos na origemde dados.

O caractere pode ser especificado como umcaractere entre aspas simples ou como um códigodecimal ASCII Char sem aspas.

418 IBM Planning Analytics: Referência do TM1

Um dos seguintes exemplos configura o caractere asterisco (*) como o delimitador de campo.

DatasourceASCIIQuoteCharacter='*';

DatasourceASCIIQuoteCharacter=Char(42);

DatasourceASCIIThousandSeparatorEsta variável local do Turbo Integrator define o separador de milhares a ser usado em qualquer conversãode uma sequência em um número ou de um número em uma sequência.

Se você definir esta variável, também deverá definir a variável DatasourceASCIIDecimalSeparator.

O caractere especificado deve ser um caractere ASCII para impressão padrão, com um valor decimal queesteja compreendido a partir de 33 e até 127.

Sintaxe

DatasourceASCIIThousandSeparator='Char';

ou

DatasourceASCIIThousandSeparator=Char(xx);

Argumento Descrição

Carac O caractere ASCII a ser usado como um separador.

O caractere pode ser especificado como umcaractere entre aspas simples ou como um códigodecimal ASCII Char sem aspas.

Um dos exemplos a seguir define o caractere ponto (.) como o separador de milhares.

DatasourceASCIIThousandSeparator='.';

DatasourceASCIIThousandSeparator=Char(46);

DatasourceCubeviewEsta variável local do Turbo Integrator define a visualização a ser processada, se DatasourceType for'VIEW'.

Sintaxe

DatasourceCubeview='ViewName';

Argumento Descrição

ViewName O nome da visualização a ser processada. Estadeve ser uma visualização existente do cuboespecificado pela variávelDataSourceNameForServer.

DatasourceDimensionSubsetEsta variável local do Turbo Integrator define o subconjunto a ser processado, se DatasourceType for'SUBSET.'

Capítulo 6. Variáveis do Turbo Integrator 419

DatasourceNameForServer=Nome da dimensão também é necessário, em conjunto comDATASOURCEDIMENSIONSUBSET, para que o TM1 possa identificar onde o subconjunto está localizado.

Sintaxe

DatasourceDimensionSubset='SubsetName';

Argumento Descrição

SubsetName O nome do subconjunto a ser processado.

DatasourceNameForServerEsta variável local do Turbo Integrator define o nome da origem de dados (arquivo .cma, nome do cubo,origem Open Database Connectivity) usada pelo servidor ao executar o processo.

Sintaxe

DatasourceNameForServer='Name';

Argumento Descrição

Nome Para uma origem de dados .cma, o caminhocompleto do arquivo .cma.

Para cubos, o nome do cubo precedido com asequência 'local:'.

Para uma origem Open Database Connectivity, onome de origem.

DatasourceNameForClientEsta variável local do Turbo Integrator define o nome da origem de dados (arquivo .cma, nome do cubo,origem Open Database Connectivity) usada pelo cliente ao criar ou editar o processo.

Sintaxe

DatasourceNameForClient='Name';

Argumento Descrição

Nome Para uma origem de dados .cma, o caminhocompleto do arquivo .cma.

Para cubos, o nome do cubo precedido com asequência 'local:'.

Para uma origem Open Database Connectivity, onome de origem.

DataSourceODBOCatalogEsta variável local do Turbo Integrator define o nome da coleção do banco de dados que contém oscubos, dimensões ou outros objetos aos quais você deseja conectar-se. Para Microsoft Analysis Services,esse é o nome do banco de dados.

420 IBM Planning Analytics: Referência do TM1

Sintaxe

DataSourceODBOCatalog='Catalog';

Argumento Descrição

Catálogo O nome da coleção do banco de dados à qual vocêdeseja conectar-se.

DataSourceODBOConnectionStringEsta variável local do Turbo Integrator define quaisquer parâmetros de conexão adicionais que podemser necessários para conectar-se ao servidor OLAP.

Sintaxe

DataSourceODBOConnectionString='String';

Argumento Descrição

Sequência O valor usado para definir parâmetros de conexãoadicionais.

Designe estes parâmetros a esta variável,delimitados por pontos e vírgulas.

DataSourceODBOCubeNameEsta variável local do Turbo Integrator define o nome do cubo do servidor OLAP que você deseja usarcomo uma origem de dados.

Sintaxe

DataSourceODBOCubeName='Name';

Argumento Descrição

Nome O nome do cubo a ser usado.

DataSourceODBOHierarchyNameEsta variável local do Turbo Integrator define o nome da hierarquia para a dimensão específica que estásendo usada como uma origem de dados. Use esta variável para outros produtos OLAP, tais como, SAPBW, nos quais uma hierarquia é um objeto separado.

Esta variável não é usada com as origens de dados do TM1.

Sintaxe

DataSourceODBOHierarchyName='Name';

Argumento Descrição

Nome O nome da hierarquia para uma dimensãoespecífica.

Capítulo 6. Variáveis do Turbo Integrator 421

DataSourceODBOLocationEsta variável local do Turbo Integrator define o nome do local (sistema) onde o servidor OLAP está emexecução.

O TM1 usa essa variável, mas outros servidores OLAP não o fazem. Para o TM1, este é o local no qual oHost Admin está em execução.

Sintaxe

DataSourceODBOLocation='Location';

Argumento Descrição

Local O nome do local (sistema) para o servidor OLAP.

DataSourceODBOProviderEsta variável local do Turbo Integrator define o nome do provedor ODBO que você deseja usar como umaorigem de dados. Este é o nome completo designado pelo fabricante do provedor ODBO para identificarseu servidor de banco de dados multidimensional.

Você deve usar o nome de um provedor ODBO que está instalado no servidor.

Sintaxe

DataSourceODBOProvider='Provider';

Argumento Descrição

Provedor O nome do provedor ODBO a ser usado como umaorigem de dados.

Os nomes de provedores comumente usadosincluem:

Provedor OLE DB MD do TM1

Microsoft OLE DB Provider for OLAP Services 8.0

Provedor OLE DB do SAP BW

DataSourceODBOSAPClientIDEsta variável local do Turbo Integrator define o número do cliente que corresponde à versão da UI noservidor SAP ao qual você deseja conectar-se.

Sintaxe

DataSourceODBOSAPClientID='ID';

Argumento Descrição

ID Um número que corresponde à versão da UI noservidor SAP.

Por exemplo, 498.

422 IBM Planning Analytics: Referência do TM1

DataSourceODBOSAPClientLanguageEsta variável local do Turbo Integrator define a especificação de idioma para o idioma do sistema SAP aoqual você deseja conectar-se.

Sintaxe

DataSourceODBOSAPClientLanguage='Language';

Argumento Descrição

Idioma A especificação de idioma do sistema SAP.

Para inglês norte-americano, use EN.

Para alemão, use DE.

Para outros idiomas, consulte a documentação doSAP.

DatasourcePasswordEsta variável local do Turbo Integrator define a senha usada para conectar-se à origem de dados.

Sintaxe

DatasourcePassword='Password';

Argumento Descrição

Senha A senha usada para conectar-se à origem de dadosdefinida com DatasourceNameForServer.

DatasourceQueryEsta variável local do Turbo Integrator define a sequência de consultas a ser usada com a origem dedados.

Sintaxe

DatasourceQuery='Query';

Argumento Descrição

Consulta A sequência de consultas a ser usada com aorigem de dados que foi definida comDatasourceNameForServer.

DataSourceSAPUsingRoleAuthsA variável local DataSourceSAPUsingRoleAuths instrui os processos do Turbo Integrator a ignorarinformações de segurança ao processar uma origem de dados SAP. Esta variável deve ser colocada noPrólogo.

Sintaxe

DataSourceSAPUsingRoleAuths='0'

Capítulo 6. Variáveis do Turbo Integrator 423

Argumento Descrição

0 As informações de segurança são ignoradasdurante o processamento de uma origem de dadosdo SAP.

1 As informações de segurança são lidas durante oprocessamento de uma origem de dados do SAP.

DataSourceSAPUsingTextsA variável local DataSourceSAPUsingTexts instrui o processo do Turbo Integrator a ignorar descrições decaracterísticas durante o processamento de uma origem de dados SAP, resultando na redução doconsumo de memória e no aumento do desempenho. Esta variável deve ser colocada no Prólogo.

Sintaxe

DataSourceSAPUsingTexts='0'

Argumento Descrição

0 As descrições de características são ignoradasdurante o processamento de uma origem de dadosdo SAP. O nome técnico da característica éimportado para o TM1 como um nome de elementoe um alias.

1 As descrições de características são lidas duranteo processamento de uma origem de dados do SAP.

DatasourceTypeEsta variável local do Turbo Integrator define o tipo da origem de dados.

Sintaxe

DataSourceType='Type';

Argumento Descrição

Tipo Os tipos válidos incluem:

'CHARACTERDELIMITED', 'POSITIONDELIMITED','VIEW', 'SUBSET', ODBC' e 'OLEDBOLAP','SAPCHARACTERISTICTEXTS'

DatasourceUsernameEsta variável local do Turbo Integrator define o nome usado para conectar-se à origem de dados.

Sintaxe

DatasourceUserName='Name';

424 IBM Planning Analytics: Referência do TM1

Argumento Descrição

Nome O nome usado para conectar-se à origem de dadosdefinida com DatasourceNameForServer.

MinorErrorLogMaxEsta variável local do Turbo Integrator define o número de erros secundários que serão gravados noarquivo TM1ProcessError.log durante a execução do processo. Se esta variável não estiver definida noprocesso, o número padrão de erros secundários gravados no arquivo de log será 1000.

Sintaxe

MinorErrorLogMax=N;

Argumento Descrição

N Valor que indica o número de erros que devem sergravados no arquivo de log.

Especifique um número inteiro maior que zero paradefinir o número máximo de erros gravados noarquivo de log.

Especifique um valor de 0 para não registrar errosdurante a execução do processo.

Especifique um valor de -1 para permitir que umnúmero ilimitado de erros secundários sejamgravados no arquivo de log.

A tabela a seguir fornece uma mensagem de log de erro deexemplo e o resultado correspondente.

Exemplo Resultado

MinorErrorLogMax=750; O arquivo de log aceitará até 750 erros.

MinorErrorLogMax=0; Nenhum erro será gravado no arquivo de log.

MinorErrorLogMax=-1; Não há limite no número de erros gravados noarquivo de log.

NValueQuando DatasourceType for 'VIEW', esta variável local do TurboIntegrator determinará o valor da célulaatual quando Value_Is_String for 0. (Isto é, quando a célula atual for numérica).

Sintaxe

Nvalue=N;

Argumento Descrição

N O valor da célula atual.

Capítulo 6. Variáveis do Turbo Integrator 425

OnMinorErrorDoItemSkipEsta variável local do Turbo Integrator instrui o Turbo Integrator a ignorar o próximo registro quando forencontrado um erro secundário ao processar um registro.

Esta variável é útil em cenários nos quais um único campo/valor inválido em um registro causa várioserros secundários.

Por exemplo, se você tiver 100 funções CELLPUTN em um processo e um dos campos em umdeterminado registro estiver 'incorreto' ou for inválido, a contagem de erros secundários seráincrementada em 100. (1 para cada função CELLPUTN que encontra o erro.) Estes 100 erros secundáriossão considerados em relação ao limite de erros secundários definido por MinorErrorLogMax. Um processodo Turbo Integrator falha quando ultrapassa o número de erros secundários definido porMinorErrorLogMax.

Se OnMinorErrorDoItemSkip=1; for incluído na guia Prólogo do processo, o processo irá imediatamentepara o próximo registro quando for encontrado um campo 'incorreto' ou inválido em um registro deorigem. Ao usar o exemplo acima, isto resulta na contagem de erros secundários sendo incrementadaapenas em 1, em vez de 100.

Sintaxe

OnMinorErrorDoItemSkip=N;

Argumento Descrição

N Valor que indica se o item deve ser ignoradoquando for encontrado um erro secundário.

1 (ou qualquer outro valor diferente de zero) indicaque o processo deve ir para o próximo registroquando for encontrado um erro secundário.

0 indica que o Turbo Integrator deve continuarprocessando o registro atual quando ocorrer umerro secundário.

SValueQuando DatasourceType for 'VIEW', esta variável local do TurboIntegrator determinará o valor da célulaatual quando Value_Is_String não for 0. (Isto é, quando a célula atual contém uma sequência decaracteres.)

Sintaxe

Svalue='String';

Argumento Descrição

Sequência O valor da célula atual.

Arquivo TM1ProcessError.logQuando um processo do Turbo Integrator encontrar um erro, ele gerará um arquivo TM1ProcessError.log.Este arquivo de log é salvo no diretório de dados do servidor no qual o processo reside.

Um arquivo TM1ProcessError.log contém uma lista de erros encontrados pelo processo. Para cada erroencontrado, o arquivo de log registra a guia e a linha que causaram o erro, juntamente com uma brevedescrição do erro.

426 IBM Planning Analytics: Referência do TM1

Quando um arquivo de log de erros de processo é gerado, o TM1 designa um nome exclusivo que permiteidentificar prontamente qual processo do Turbo Integrator gerou o arquivo de erro e o horário em que oarquivo foi criado. Os nomes de arquivos são designados com a convenção a seguir:

TM1ProcessError_<registro de data e hora>_<nome do processo>.log.

Nesta convenção, <time stamp> é a hora (expressa como aaaammddhhmmss GMT) em que o arquivo foigerado e <process name> é o nome do processo do Turbo Integrator que causou os erros.

Por exemplo, um arquivo de erro denominado TM1ProcessError_20040224203148_CreateSalesCube.log indica que o arquivo de erro foi gerado às 20:31:48 GMT em 24 de fevereiro de2004 e que ele contém erros causados pelo processo CreateSalesCube.

A intervenção manual é necessária para excluir ou arquivar estes arquivos de log. Um novo arquivo de logé gerado cada vez que um processo TurboIntegrator tem um erro (1 arquivo de log por execução doTurboIntegrator).

Muitos logs de erro do processo TurboIntegrator podem ser gerados para processos TurboIntegratorexecutados com frequência que geram um erro em cada execução. Muitos arquivos de log gerados nodiretório de log do banco de dados TM1 podem impactar o desempenho do banco de dados TM1 quandoele cria ou atualiza arquivos de log.

A capacidade do Planning Analytics Administration de fazer download de arquivos de log pode serimpactada por um grande número de arquivos no diretório de log do banco de dados TM1. Érecomendado limitar o número de arquivos no diretório de criação de log do banco de dados do TM1 paramenos de 2000 arquivos.

Value_Is_StringQuando DatasourceType for 'VIEW', esta variável local do Turbo Integrator determinará se a célula atualdeve ser tratada como uma sequência ou um valor numérico.

Sintaxe

Value_Is_String=N;

Argumento Descrição

N Valor que indica se a célula atual é uma sequênciaou um valor numérico.

0 indica que a célula é um número; qualquer outroitem significa que a célula é tratada como umasequência.

Variáveis Globais do Turbo IntegratorEste tipo de variável do Turbo Integrator está associado a uma tarefa de organização de processosindividual do TM1 ou a um processo individual e a quaisquer subprocessos participantes. Há dois tipos devariáveis globais: implícita e definida pelo usuário. As variáveis globais implícitas são descritas aqui. Asvariáveis globais definidas pelo usuário são descritas abaixo.

As variáveis globais podem ser usadas de duas maneiras:

• As variáveis globais podem ser declaradas em um processo que faz parte de uma tarefa de organizaçãode processos especificada. Depois de declaradas, as variáveis globais ficam disponíveis para os demaisprocessos que fazem parte da tarefa de organização de processos. As variáveis persistem enquanto atarefa de organização de processos está em execução e durante a sessão do servidor atual. As variáveisglobais são destruídas no encerramento do servidor.

Capítulo 6. Variáveis do Turbo Integrator 427

• As variáveis globais podem ser declaradas em um processo e podem ser disponibilizadas paraquaisquer processos subsequentes chamados pela função ExecuteProcess( ). Estes subprocessosdevem usar as mesmas instruções de declaração de variável global (descritas abaixo) para acessar asvariáveis globais.

No caso de um nome de variável global ser idêntico a um nome de variável local, a definição da variávellocal terá precedência e substituirá a variável global.

As variáveis globais são declaradas em um processo do Turbo Integrator usando uma das duas funções aseguir

NumericGlobalVariable('VariableName');Use esta função para declarar uma variável global numérica.

StringGlobalVariable('VariableName');Use esta função para definir uma variável global de sequência.

Variáveis Globais ImplícitasAo executar um processo do Turbo Integrator, é gerado um conjunto de variáveis globais implícitas. Se oprocesso que está gerando as variáveis fizer parte de uma tarefa de organização de processos, estasvariáveis globais estarão disponíveis e poderão ser compartilhadas pelos demais processos na tarefa deorganização de processos.

Além disso, todas as variáveis globais implícitas em um processo estão disponíveis e podem sercompartilhadas por quaisquer processos subsequentes chamados pela função ExecuteProcess( ).

Embora as variáveis implícitas sejam geradas pelo processo do Turbo Integrator, você deve declarar umavariável antes que ela seja usada em um processo

As variáveis globais implícitas são declaradas em um processo do Turbo Integrator usandoNumericGlobalVariable('VariableName');:

Clique em um link abaixo para obter detalhes sobre variáveis globais implícitas específicas.

• DataMinorErrorCount.• MetadataMinorErrorCount.• ProcessReturnCode.• PrologMinorErrorCount.

Por exemplo, para usar a variável global implícita PrologMinorErrorCount em um processo, primeiro, vocêdeve declarar a variável da seguinte forma:

NumericGlobalVariable('PrologMinorErrorCount');

DataMinorErrorCountEsta variável global do Turbo Integrator conta os erros secundários que ocorrem na parte Dados de umprocesso do Turbo Integrator. Para cada erro secundário encontrado, o valor da variável é incrementadoem 1.

Sintaxe

DataMinorErrorCount=N;

428 IBM Planning Analytics: Referência do TM1

Argumento Descrição

N O número de erros secundários encontrados naparte Dados do processo.

MetadataMinorErrorCountEsta variável global do Turbo Integrator conta os erros secundários que ocorrem na parte Metadados deum processo do Turbo Integrator. Para cada erro secundário encontrado, o valor da variável éincrementado em 1.

Sintaxe

MetadataMinorErrorCount=N;

Argumento Descrição

N O número de erros secundários encontrados naparte Metadados do processo.

ProcessReturnCodeEsta variável global do Turbo Integrator armazena o status de saída dos processos do Turbo Integratorexecutados mais recentemente.

Sintaxe

ProcessReturnCode=StatusCode;

Código de Status Descrição

ProcessExitByBreak() Indica que o processo foi encerrado porqueencontrou uma função ProcessBreak.

ProcessExitByChoreQuit() Indica que o processo foi encerrado devido àexecução da função ChoreQuit.

ProcessExitByChoreRollback() Indica que o processo foi encerrado porqueencontrou uma função ChoreRollback.

ProcessExitByProcessRollback() Indica que o processo foi encerrado porqueencontrou uma função ProcessRollback.

ProcessExitByQuit() Indica que o processo foi encerrado devido a umcomando quit explícito.

ProcessExitMinorError() Indica que o processo foi executado com êxito,mas encontrou erros secundários.

ProcessExitNormal() Indica que o processo foi executado normalmente.

ProcessExitOnInit() Indica que o processo foi interrompido durante ainicialização.

Capítulo 6. Variáveis do Turbo Integrator 429

Código de Status Descrição

ProcessExitSeriousError() Indica que o processo foi encerrado devido a umerro grave.

ProcessExitWithMessage() Indica que o processo foi encerrado normalmente,com uma mensagem gravada emtm1server.log.

PrologMinorErrorCountEsta variável global do Turbo Integrator conta os erros secundários que ocorrem na parte Prólogo de umprocesso do Turbo Integrator. Para cada erro secundário encontrado, o valor da variável é incrementadoem 1.

Sintaxe

PrologMinorErrorCount=N;

Argumento Descrição

N O número de erros secundários encontrados noPrólogo.

Variáveis de Usuário do Turbo IntegratorEste tipo de variável está associado a um usuário individual do TM1 e não a quaisquer processos outarefas de organização de processos específicos. As variáveis de usuário podem ser manipuladas a partirde qualquer processo ou tarefa de organização de processos do Turbo Integrator enquanto o usuário, aoqual a variável está associada, estiver com logon efetuado no servidor.

As variáveis de usuário devem ser declaradas explicitamente. Uma vez declaradas, as variáveis do usuáriopersistem por toda a duração da sessão do TM1 do usuário (até que o usuário efetue logoff ou sejadesconectado do servidor).

As variáveis de usuário são declaradas em um processo do Turbo Integrator usando uma das duasfunções a seguir:

• NumericGlobalVariable('VariableName');. Use esta função para declarar uma variável de usuárionumérica.

• StringGlobalVariable('VariableName');. Use esta função para definir uma variável de usuário desequência.

As variáveis de usuário são criadas na primeira vez que uma declaração é encontrada em qualquerprocesso do Turbo Integrator em execução.

Logo que criado, o nome da variável pode ser mencionado e usado da mesma forma que qualquer variávellocal ou global, exceto que o valor da variável persiste em processos e tarefas, contanto que o usuárioque criou a variável esteja com logon efetuado no servidor.

430 IBM Planning Analytics: Referência do TM1

Avisos

Estas informações foram desenvolvidas para produtos e serviços oferecidos em todo o mundo.

Este material pode estar disponível pela IBM em outros idiomas. No entanto, pode ser necessário apossuir uma cópia do produto ou da versão do produto neste idioma, a fim de acessá-lo.

É possível que a IBM não ofereça os produtos, serviços ou recursos discutidos nesta publicação emoutros países. Consulte um representante IBM local para obter informações sobre produtos e serviçosdisponíveis atualmente em sua área. Qualquer referência a produtos, programas ou serviços IBM nãosignifica que apenas produtos, programas ou serviços IBM possam ser utilizados. Qualquer produto,programa ou serviço funcionalmente equivalente, que não infrinja nenhum direito de propriedadeintelectual da IBM poderá ser utilizado em substituição a este produto, programa ou serviço. Entretanto,a avaliação e verificação da operação de qualquer produto, programa ou serviço não IBM são deresponsabilidade do Cliente. Este documento pode descrever produtos, serviços ou recursos que nãoestão incluídos no Programa ou autorização de licença adquirido pelo Cliente.

A IBM pode ter patentes ou solicitações de patentes pendentes relativas a assuntos tratados nestapublicação. O fornecimento desta publicação não lhe garante direito algum sobre tais patentes. Consultassobre licença devem ser enviadas, por escrito, para:

Gerência de Relações Comerciais e Industriais da IBM BrasilAv. Pasteur, 138-146BotafogoRio de Janeiro, RJCEP 22290-240

Para consultas sobre licença relacionadas a informações de DBCS (Conjunto de Caracteres de ByteDuplo), entre em contato com o Departamento de Propriedade Intelectual da IBM em seu país ou enviepedidos de licença, por escrito, para:

Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan Ltd.19-21, Nihonbashi-Hakozakicho, Chuo-kuTokyo 103-8510, Japan

O parágrafo a seguir não se aplica ao Reino Unido e a nenhum país em que tais disposições não estejamde acordo com a legislação local: A INTERNATIONAL BUSINESS MACHINES CORPORATION FORNECEESTA PUBLICAÇÃO "NO ESTADO EM QUE SE ENCONTRA", SEM GARANTIA DE NENHUM TIPO, SEJAEXPRESSA OU IMPLÍCITA, INCLUINDO, MAS A ELAS NÃO SE LIMITANDO, AS GARANTIAS IMPLÍCITASDE NÃO INFRAÇÃO, COMERCIALIZAÇÃO OU ADEQUAÇÃO A UM DETERMINADO PROPÓSITO. Algunspaíses não permitem a exclusão de garantias expressas ou implícitas em certas transações; portanto,essa disposição pode não se aplicar ao Cliente.

Essas informações podem incluir imprecisões técnicas ou erros tipográficos. São feitas alteraçõesperiódicas nas informações aqui contidas; tais alterações serão incorporadas em futuras edições destapublicação. A IBM pode, a qualquer momento, aperfeiçoar e/ou alterar os produtos e/ou programasdescritos nesta publicação, sem aviso prévio.

Quaisquer referências nestas informações a Web sites não IBM são fornecidas apenas para conveniênciae não funcionam, de maneira nenhuma, como um endosso desses Web sites. Os materiais nesses Websites não fazem parte dos materiais para este produto IBM e o uso desses Web sites é de inteiraresponsabilidade do Cliente.

A IBM pode utilizar ou distribuir as informações fornecidas da forma que julgar apropriada sem incorrerem qualquer obrigação para com o Cliente.

© Copyright IBM Corp. 2007, 2019 431

Licenciados deste programa que desejam obter informações sobre este assunto com objetivo de permitir:(i) a troca de informações entre programas criados independentemente e outros programas (incluindoeste) e (ii) a utilização mútua das informações trocadas, devem entrar em contato com:

Gerência de Relações Comerciais e Industriais da IBM Brasil Av. Pasteur, 138-146 Botafogo Rio de Janeiro, RJ CEP 22290-240

Tais informações podem estar disponíveis, sujeitas aos termos e condições apropriados, incluindo, emalguns casos, o pagamento de uma taxa.

O programa licenciado descrito nesta publicação e todo o material licenciado disponível a ele sãofornecidos pela IBM sob os termos do IBM Customer Agreement, do Contrato de Licença do ProgramaInternacional da IBM ou de qualquer contrato equivalente entre as partes.

Os dados de desempenho aqui contidos foram determinados em um ambiente controlado. Portanto, osresultados obtidos em outros ambientes operacionais podem variar significativamente. Foram tomadasalgumas medidas nos sistemas de nível de desenvolvimento e não há nenhuma garantia de que estasmedidas sejam as mesmas nos sistemas geralmente disponíveis. Além disso, algumas medidas podemter sido estimadas por meio de extrapolação. Os resultados reais podem variar. Os usuários destapublicação devem verificar os dados aplicáveis ao seu ambiente específico.

As informações relativas a produtos não IBM foram obtidas dos fornecedores desses produtos, dosanúncios publicados ou de outras fontes publicamente disponíveis. A IBM não testou esses produtos enão pode confirmar a exatidão do desempenho, da compatibilidade ou de outras solicitaçõesrelacionadas a produtos não IBM. Questões sobre os recursos de produtos não IBM devem serendereçadas aos fornecedores desses produtos.

Todas as instruções relativas a futuras orientações ou intenções da IBM estão sujeitas a alteração ouretirada sem aviso prévio e apenas representam metas e objetivos.

Essas informações são apenas para fins de planejamento. As informações aqui estão sujeitas a alteraçõesantes que os produtos descritos estejam disponíveis.

Estas informações contêm exemplos de dados e relatórios usados em operações de negócios diárias.Para ilustrá-las da maneira mais completa possível, os exemplos incluem os nomes de indivíduos,empresas, marcas e produtos. Todos esses nomes são fictícios e qualquer semelhança com nomes eendereços usados por uma empresa real é totalmente coincidência.

LICENÇA DE COPYRIGHT:

Essas informações contêm programas de aplicativos de amostra no idioma de origem, ilustrando astécnicas de programação em diversas plataformas operacionais. Você pode copiar, modificar e distribuirestes programas de amostra de qualquer maneira, sem pagamento à IBM, com objetivos dedesenvolvimento, de utilização, de marketing ou de distribuição de programas aplicativos emconformidade com a interface de programação de aplicativo para a plataforma operacional para a qual osprogramas de amostra são criados. Esses exemplos não foram testados completamente em todas ascondições. A IBM, portanto, não pode garantir ou implicar a confiabilidade, a capacidade de manutençãoou a função desses programas. Os programas de exemplo são fornecidos "NO ESTADO EM QUE SEENCONTRAM", sem garantia de nenhum tipo. A IBM não deve ser responsabilizado por quaisquer danosoriundos do uso dos programas de amostra.

Cada cópia ou qualquer parte desses programas de amostra ou qualquer trabalho derivado deverá incluirum aviso de copyright com os dizeres:© (nome da sua empresa) ( ano). Partes deste código são derivadas dos Programas de Amostra da IBMCorp. © Copyright IBM Corp. _inserir o ano ou os anos_.

Se estiver visualizando estas informações em formato eletrônico, as fotografias e ilustrações coloridaspoderão não aparecer.

432 Avisos

Esta Oferta de Software não usa cookies ou outras tecnologias para coletar informações pessoalmenteidentificáveis.

©

Informações do Produto

Este documento se aplica ao IBM Planning Analytics versão 2.0.0 e também pode se aplicar às liberaçõessubsequentes.

Direitos Autorais

Materiais Licenciados - Propriedade da IBM© Copyright IBM Corp. 2007, 2019.

Direitos restritos para usuários do governo dos Estados Unidos – Uso, duplicação ou divulgação restritospelo GSA ADP Schedule Contract com a IBM Corp.

IBM, o logotipo IBM e ibm.com são marcas comerciais ou marcas registradas da International BusinessMachines Corp., registradas em vários países no mundo todo. Outros nomes de produtos e serviçospodem ser marcas registradas da IBM ou de outras empresas. Uma lista atual de marcas comerciais daIBM está disponível na web em " Copyright and trademark information " em www.ibm.com/legal/copytrade.shtml.

Os termos a seguir são marcas ou marcas registradas de outras empresas:

• Microsoft, Windows, Windows NTe o logotipo Windows são marcas registradas da Microsoft Corporationnos Estados Unidos, em outros países ou em ambos.

• Adobe, o logotipo Adobe , PostScripte o logotipo PostScript são marcas registradas ou marcasregistradas da Adobe Systems Incorporated nos Estados Unidos, e / ou em outros países.

• A marca registrada Linux® é usada de acordo com uma sublicença da Linux Foundation, licenciadaexclusiva de Linus Torvalds, proprietário da marca em todo o mundo.

• UNIX é uma marca registrada do The Open Group nos Estados Unidos e em outros países.• Java e todas as marcas registradas e logotipos baseados em Javasão marcas comerciais ou marcas

registradas da Oracle e / ou de suas afiliadas.• Red Hat®, JBoss®, OpenShift®, Fedora®, Hibernate®, Ansible®, CloudForms®, RHCA®, RHCE®, RHCSA®,

Ceph® e Gluster® são marcas comerciais ou registradas da Red Hat, Inc. ou de suas subsidiárias nosEstados Unidos e em outros países.

Capturas de tela do produto Microsoft usadas com permissão da Microsoft.

Avisos 433

434 IBM Planning Analytics: Referência do TM1

Índice Remissivo

Caracteres Especiaisárea de janela direita (Área de Janela Propriedades)

Server Explorer 55área de janela esquerda (Área de Janela em Árvore)

Server Explorer 55

AABS 148acesso

Designações de Segurança de privilégios 50ACOS 148AddClient 357AddCubeDependency 279AddGroup 358AddInfoCubeRestriction 410Administrador

Designações de Segurança 53Segurança da Camada de Transporte do Servidor,Opções do 73

AGORA 121ALEATÓRIO 152ANO 126aplicativo

Server Explorer 58ARRED 152ARRUMAR 161ASCII

e Funções de Texto do Turbo Integrator 215ASCIIDelete 215ASCIIOutput 216ASEN 148AssignClientPassword 359AssignClientToGroup 358assistente de relatório de impressão 39assistente de Relatório de Impressão 39AssociateCAMIDToGroup 359ATAN 149atributo

Editor 7Editor do Turbo Integrator 91Funções de Manipulação do Turbo Integrator 224

AttrDelete 226AttrInsert 227ATTRN 102ATTRNL 224AttrPutN 227AttrPutS 228ATTRS 103AttrSL 225avançado

Grade de Mapeamento 4guia do Editor do Turbo Integrator 95Opções 4

Bbarra de ferramentas 47barra de status 47BatchUpdateFinish 288, 371BatchUpdateFinishWait 372BatchUpdateStart 373bloqueio

Designações de Segurança 53botão de ação

propriedades 1botão de ação aparência 4botões

Editor do Turbo Integrator 89

Ccaixa de diálogo abrir subconjunto 38caixa de diálogo abrir visualização 39Caixa de Diálogo Aliases do TM1 72Caixa de Diálogo Excluir Subconjuntos Nomeados 24Caixa de Diálogo Excluir Visualizações Nomeadas 24caixa de diálogo novo atributo 38Caixa de Diálogo Obter Visualização (In-SpreadsheetBrowser) 36caixa de diálogo opções de processo 43Caixa de Diálogo Opções do TM1 72caixas de diálogo 1caixas de diálogo janelas 1CAPIT 155CARACT 155CellGetN 280CellGetS 282CellIncrementN 282CellIsUpdateable 283CellPutN 283CellPutProportionalSpread 284CellPutS 285CellSecurityCubeCreate 359CellSecurityCubeDestroy 360CellValueN 113CellValueS 114Chinês 46ChoreAttrDelete 229ChoreAttrInsert 229ChoreAttrN 230ChoreAttrNL 230ChoreAttrPutN 231ChoreAttrPutS 232ChoreAttrS 233ChoreAttrSL 233ChoreError 278ChoreRollback 278Clientes

Caixa de Diálogo Centro de Mensagens 18Grupos/grade 15, 17Janela/Grupo 15

Índice Remissivo 435

Clientes (continuação)menu Clientes/Grupos 16

CÓDIGO 156comentários 46comparação 101conclusão automática 47conjunto de caracteres 218conjuntos de caracteres grandes 46Connect Server 36consolidação

Editor do Turbo Integrator 91ConsolidatedAvg 107ConsolidatedCount 110ConsolidatedCountUnique 111ConsolidatedMax 111ConsolidatedMin 112consulta do log de transações

caixa de diálogo 74caixa de diálogo resultados 74

contenção de bloqueio 375CONTINUE 146controle

objetos 47opções 48

Coreano 46COS 149CreateHierarchyByAttribute 234criar

caixa de diálogo dimensão 18caixa de diálogo do cubo 19objeto de replicação do servidor 18

CubeAttrDelete 235CubeAttrInsert 235CubeATTRN 104CubeATTRNL 238CubeAttrPutN 236CubeAttrPutS 237CubeATTRS 104CubeATTRSL 239CubeClearData 286CubeCreate 286CubeDataReservationAcquire 291CubeDataReservationGet 294CubeDataReservationGetConflicts 295CubeDataReservationRelease 292CubeDataReservationReleaseAll 293CubeDestroy 287CubeDimensionCountGet 287CubeDRAcquire 296CubeDRGet 299CubeDRGetConflicts 300CubeDRRelease 297CubeDRReleaseAll 298CubeExists 287CubeGetLogChanges 288CubeProcessFeeders 343CubeRuleAppend 344CubeRuleDestroy 345CubeSetConnParams 289CubeSetLogChanges 290CubeTimeLastUpdated 290CubeUnload 291CubeView

Server Explorer 62

cuboCaixa de Diálogo Propriedades 21Editor de Subconjunto de Informações 44Editor do Turbo Integrator 91funções de manipulação do Turbo Integrator 279otimizando 20Server Explorer 59Visualizador 21

DD_FSAVE 166D_PICK 165D_SAVE 167dados

Editor do Turbo Integrator 91, 95guia origem do Editor do Turbo Integrator 76

DATA 119data e hora

funções do Turbo Integrator 301DataMinorErrorCount 428DatasourceASCIIDecimalSeparator 417DatasourceASCIIDelimiter 417DatasourceASCIIHeaderRecords 418DatasourceASCIIQuoteCharacter 418DatasourceASCIIThousandSeparator 419DatasourceCubeview 419DatasourceDimensionSubset 419DatasourceNameForClient 420DatasourceNameForServer 420DataSourceODBOCatalog 420DataSourceODBOConnectionString 421DataSourceODBOCubeName 421DataSourceODBOHierarchyName 421DataSourceODBOLocation 422DataSourceODBOProvider 422DataSourceODBOSAPClientID 422DataSourceODBOSAPClientLanguage 423DatasourcePassword 423DatasourceQuery 423DataSourceSAPUsingRoleAuths 423DataSourceSAPUsingTexts 424DatasourceType 424DatasourceUsername 424DATES 119DAYNO 120DBProportionalSpread 167DBR 187DBRA 188DBRW 189DBS 189DBSA 190DBSS 191DBSW 192DELET 156DeleteAllPersistentFeeders 345DeleteClient 361DeleteGroup 361designar

grade Designações de Segurança 50DFRST 192DIA 120dicas de ferramentas 47dimensão

436 IBM Planning Analytics: Referência do TM1

dimensão (continuação)Caixa de Diálogo Inserir Elemento 28Caixa de Diálogo Ordenação de Elementos 29Caixa de Diálogo Propriedades do Elemento 30Editor de Subconjunto de Informações 44Editor do Turbo Integrator 91Funções de Manipulação do Turbo Integrator 304Funções de Regras de Informações 126menu Editor de Dimensão 25Server Explorer 61

DimensionAttrDelete 239DimensionAttrInsert 240DimensionATTRN 104DimensionATTRNL 242DimensionAttrPutN 241DimensionAttrPutS 241DimensionATTRS 105DimensionATTRSL 243DimensionCreate 304DimensionDeleteAllElements 304DimensionDeleteElements 304DimensionDestroy 305DimensionElementComponentAdd 305DimensionElementComponentAddDirect 306DimensionElementComponentDelete 307DimensionElementComponentDeleteDirect 307DimensionElementDelete 308DimensionElementDeleteDirect 308DimensionElementExists 309DimensionElementInsert 310DimensionElementInsertDirect 310, 315DimensionElementPrincipalName 311DimensionExists 312DimensionHierarchyCreate 312DimensionSortOrder 313DimensionTimeLastUpdated 314DimensionTopElementInsert 315DimensionUpdateDirect 316dimensões da coluna

Cube Viewer 21dimensões de título

Cube Viewer 21DIMIX 127, 193DIMNM 127, 193DIMSIZ 127, 194DisableBulkLoadMode 373DisableMTQViewConstruct 395diversas

Funções das Regras 162Funções do Turbo Integrator 410

DNEXT 128, 194DNLEV 128, 195DTYPE 129, 196

EE_PICK 168editar

Caixa de Diálogo Fórmula 31Caixa de Diálogo Referência ao Cubo 31

Editor 75ELCOMP 130, 196ELCOMPN 130, 197ElementAttrDelete 249

ElementAttrInsert 248ElementAttrN 105ElementATTRNL 244ElementAttrPutN 246ElementAttrPutS 247ElementAttrS 106ElementATTRSL 245ElementComponent 131ElementComponentCount 131ElementCount 132ElementFirst 132ElementIndex 133ElementIsAncestor 133ElementIsComponent 134ElementIsParent 134ElementLevel 135ElementNext 136elemento

área de janela Editor de Dimensão 24área de janela Editor de Subconjunto 67Funções de Regras de Informações 130

ElementParent 137ElementParentCount 137ElementSecurityGet 361ElementSecurityPut 362ElementType 138ElementWeight 138ELISANC 139ELISCOMP 139, 197ELISPAR 140, 198ELLEV 140, 198ELPAR 141, 199ELPARN 141, 200ELSEN 200ELWEIGHT 142, 200EnableBulkLoadMode 373EnableMTQViewConstruct 396epílogo

Editor do Turbo Integrator 95Excel

funções de macro 165ExcluirElementos da HierarchyDeleteElements 318ExecuteCommand 334ExecuteJavaN 412ExecuteJavaS 412ExecuteProcess 335, 427EXP 149Expandir 413Exponenciação 101

FFEEDERS 162FEEDSTRINGS 162FileExists 414FILL 157filtrar

caixa de diálogo do subconjunto 32caixa de diálogo elementos por atributo 32caixa de diálogo elementos por nível 32caixa de diálogo visualizar 34

ForceSkipCheck 346FormatDate 301Fórmula de Variável do Processo 90

Índice Remissivo 437

função RefreshMdxHierarchy 374funções

regras 101, 165Turbo Integrator 215

funções da planilha do TM1TM1ELLIST 203TM1GLOBALSANDBOX 206TM1INFO 206TM1PRIMARYDBNAME 207

Funções de Cálculo 107funções de macro

acessando 165lista 165

funções de regras de hierarquias 145funções de regras de texto 155funções de regras financeiras 143funções de regras matemáticas 148funções de Reserva de Dados do Turbo Integrator

CubeDataReservationAcquire 291CubeDataReservationGet 294CubeDataReservationGetConflicts 295CubeDataReservationRelease 292CubeDataReservationReleaseAll 293CubeDRAcquire 296CubeDRGet 299CubeDRGetConflicts 300CubeDRRelease 297CubeDRReleaseAll 298

funções do Ambiente de Simulação 347Funções Open Database Connectivity do Turbo Integrator332

GGetProcessErrorFileDirectory 337GetProcessErrorFilename 337GetProcessName 337GetUseActiveSandboxProperty 347grade

Editor do Turbo Integrator 89grade de visualização

Editor do Turbo Integrator 89gravar

Designações de Segurança 52Grupo de Servidores

Server Explorer 55guia mapas do Editor do Turbo Integrator 91guia Programação

Editor do Turbo Integrator 97guias

Editor do Turbo Integrator 76

Hhierarchy

funções de manipulação do Turbo Integrator 317HierarchyATTRN 251HierarchyATTRNL 252HierarchyAttrPutN 249HierarchyAttrPutS 250HierarchyATTRS 251HierarchyATTRSL 253HierarchyContainsAllLeaves 317

HierarchyCreate 317HierarchyDeleteAllElements 318HierarchyDestroy 319HierarchyElementComponentAdd 319HierarchyElementComponentAddDirect 320HierarchyElementComponentDelete 321HierarchyElementComponentDeleteDirect 321HierarchyElementDelete 322HierarchyElementDeleteDirect 323HierarchyElementExists 323HierarchyElementInsert 324HierarchyElementInsertDirect 325HierarchyElementPrincipalName 326HierarchyElementSecurityGet 363HierarchyElementSecurityPut 363HierarchyExists 326HierarchyHasOrphanedLeaves 327HierarchySortOrder 327HierarchySubsetAliasSet 376HierarchySubsetAttrDelete 260HierarchySubsetAttrInsert 259HierarchySubsetATTRN 254HierarchySubsetATTRNL 256HierarchySubsetAttrPutN 258HierarchySubsetAttrPutS 257HierarchySubsetATTRS 254HierarchySubsetATTRSL 255HierarchySubsetCreate 377HierarchySubsetDeleteAllElements 378HierarchySubsetDestroy 378HierarchySubsetElementDelete 379HierarchySubsetElementExists 379HierarchySubsetElementGetIndex 380HierarchySubsetElementInsert 380HierarchySubsetExists 381HierarchySubsetGetElementName 382HierarchySubsetGetSize 382HierarchySubsetIsAllSet 383HierarchySubsetMDXGet 383HierarchySubsetMDXSet 383HierarchyTimeLastUpdated 329HierarchyTopElementInsert 329HierarchyTopElementInsertDirect 330HierarchyUpdateDirect 331HOJE 125

II_EXPORT 169I_NAMES 170I_PROCESS 170ignorar parâmetros

Extração de Visualização 97importar 46Imprimir 46indentação 46inserir referência do cubo 48INSRT 157INT 150ISUND 150ISUNDEFINEDCELLVALUE 116ItemReject 338ItemSkip 339

438 IBM Planning Analytics: Referência do TM1

Jjanela Detalhes do log de auditoria 13janela Log de Auditoria 9janela log de mensagens 37Japonês 46

KKEY_ERR 187

Ller

Designações de Segurança 51LevelCount 142linha

Cube Viewer 21LN 150Localizar 46LOG 151Log de auditoria

janela 9janela detalhes 13

Log de mensagensjanela 37

lógicaFunções das Regras 146operadores 101

LONG 157

MM_CLEAR 171MAIÚSCULA 162mapeamento automático 4marcadores 46MÁXIMO 151menu ajuda

Janela Log de Mensagens 38menu arquivo

Atributos 7Cube Viewer 21Editor do Turbo Integrator 76Janela Log de Mensagens 37Server Explorer 55

menu de ferramentasEditor de Subconjunto 71

menu dinâmicoServer Explorer 55

Menu do In-Spreadsheet Browser 36menu Editar

Atributos 7Cube Viewer 22Editor de Dimensão 25Editor de Subconjunto 68Editor do Turbo Integrator 76Janela Log de Mensagens 38Resultados da Consulta ao Log da Transação 74Server Explorer 66

menu gruposClientes/Grupos 16

menu visualizar

menu visualizar (continuação)Cube Viewer 23Editor de Dimensão 28Editor de Subconjunto 70Server Explorer 66

MÊS 121metadados

Editor do Turbo Integrator 95MetadataMinorErrorCount 429método run 165MÍNIMO 151MinorErrorLogMax 425MINÚSCULA 158módulos VBA

funções de macro 165

NN_CONNECT 171N_DISCONNECT 171nenhum

Designações de Segurança 50NewDateFormatter 302NomeElemento 136NumberToString 217NumberToStringEx 218NUMBR 158NumericGlobalVariable(VariableName) 428NumericSessionVariable(ariableName 430números da linha 47NValue 425

OODBCClose 332ODBCOpen 332ODBCOPENEx 332ODBCOutput 333OnMinorErrorDoItemSkip 426opções

Atributos 8menu do cube viewer 23Propriedades do Elemento de Dimensão 30

operadores aritméticos 101OPTGET 172OPTSET 173otimizando cubos 20

Pparâmetros

Editor do Turbo Integrator 95parâmetros de login

Opções de TM1 72parâmetros do intervalo

Extração de Visualização 97ParseDate 303PAYMT 144planilha

botão de ação 2Preferências 48ProcessAttrDelete 260ProcessAttrInsert 261

Índice Remissivo 439

ProcessAttrN 261ProcessAttrNL 262ProcessAttrPutN 263ProcessAttrPutS 264ProcessAttrS 265ProcessAttrSL 265ProcessBreak 339ProcessError 339ProcessExists 340processo

botão de ação 2controlar funções do Turbo Integrator 334Server Explorer 65

ProcessQuit 340ProcessReturnCode 429ProcessRollback 340PrologMinorErrorCount 430prólogo

Editor do Turbo Integrator 95propriedades

área de janela Editor de Dimensão 24área de janela Editor de Subconjunto 67área de janela Elemento de Dimensão 30configurações regionais 8

propriedades de configurações regionais 8PublishSubset 173PublishView 174, 394

QQUDEFINE 174QUDEFINEEX 176quebra automática de linha 47QUEXPORT 178QULOOP 179QUSUBSET 179

RR_SAVE 180RAIZ 154regiões definidas pelo usuário 47regra

funções 101funções de gerenciamento do Turbo Integrator 343funções de macro 165Informações do Editor de Subconjunto 44

Relatórios dinâmicosTM1ELLIST 203TM1GLOBALSANDBOX 206TM1INFO 206TTM1PRIMARYDBNAME 207

RemoveCAMIDAssociation 364RemoveCAMIDAssociationFromGroup 364RemoveClientFromGroup 365remover comentário 46replicar

Server Explorer 64replicar cubo

caixa de diálogo 44Server Explorer 64

reservarDesignações de Segurança 52

Resto 152ROUNDP 153RuleLoadFromFile 346RunProcess 341

Ssalvar

caixa de diálogo do subconjunto 49caixa de diálogo Visualização do In-SpreadsheetBrowser 49Caixa de Diálogo Visualizar 49

SAPCharacteristicTexts 424SaveDataAll 375SCAN 158Se 338SE 147SecurityOverlayCreateGlobalDefault 368SecurityOverlayDestroyGlobalDefault 369SecurityOverlayGlobalLockCell 368SecurityOverlayGlobalLockNode 370SecurityRefresh 370segurança

caixa de diálogo Designações 50funções do Turbo Integrator 357menu Clientes/Grupos 16

selecionar cubocaixa de diálogo 54para caixa de diálogo de regras 54

selecionar dimensãocaixa de diálogo 54designações de segurança 54

selecionar elementocaixa de diálogo 54extração de visualização 97

SEN 154ServerActiveSandboxGet 347ServerActiveSandboxSet 348ServerSandboxesDelete 349ServerSandboxExists 354ServerSandboxGet 355ServerSandboxListCountGets 356ServerShutdown 376servidor

Explorer (Janela Principal) 55funções de manipulação do Turbo Integrator 371Server Explorer 55

servidor localOpções de TM1 72

SetChoreVerboseMessages 279SetDimensionGroupsSecurity 366SetElementGroupsSecurity 367SetHierarchyElementGroupsSecurity 366SetHierarchyGroupsSecurity 365SetInputCharacterSet 218SetODBCUnicodeInterface 334SetOutputEscapeDoubleQuote 221SetUseActiveSandboxProperty 357SINAL 154sintaxe 341STET 147, 215STR 159StringGlobalVariable(ariableName 428StringSessionVariable(ariableName 430

440 IBM Planning Analytics: Referência do TM1

StringToNumber 222StringToNumberEx 222subconjunto

editor 67funções de manipulação do Turbo Integrator 376menu Editor de Subconjunto 68Server Explorer 63

SUBDEFINE 180SUBNM 201SUBPICK 181SubsetAliasSet 384SubsetAttrDelete 271SubsetAttrInsert 271SubsetATTRN 267SubsetATTRNL 268SubsetAttrPutN 270SubsetAttrPutS 269SubsetATTRS 266SubsetATTRSL 267SubsetCreate 384SubsetCreateByMDX 386SubsetDeleteAllElements 387SubsetDestroy 388SubsetElementDelete 388SubsetElementExists 389SubsetElementGetIndex 389SubsetElementInsert 390SubsetExists 390SubsetExpandAboveSet 391SubsetFormatStyleSet 391SubsetGetElementName 392SubsetGetSize 392SubsetIsAllSet 393SubsetMDXGet 393SubsetMDXSet 394SUBSIZ 202SUBST 161SValue 426synchronized() 341

TT_CLEAR 182T_CREATE 182T_CREATE16 183T_PICK 183T_SAVE 184TABDIM 129, 203TAN 155tarefa de organização de processos

Assistente de Configuração 14Encerrar 278Funções de Gerenciamento do Turbo Integrator 278Server Explorer 65, 66

TextOutput 223TIME 121TIMST 121TIMVL 123TM1ELLIST 203TM1GLOBALSANDBOX 206TM1INFO 206Tm1p.xla 165TM1PRIMARYDBNAME 207TM1ProcessError.log 426

TM1RECALC 184TM1RECALC1 184TM1RptElIsConsolidated 207TM1RPTELISCONSOLIDATED 212TM1RptElIsExpanded 208TM1RptElLev 208TM1RPTELLSEXPANDED 212TM1RptFilter 208TM1RptRow 209TM1RptTitle 211TM1RptView 212TM1User 212, 415todas as telas

Assistente de Relatório de Impressão 39Turbo Integrator

funções 215limite 215Variáveis de Usuário 430Variáveis Globais 427

UUNDEFINEDCELLVALUE 117unindent 46UTF-8 218

VValue_Is_String 427variáveis

global 427global implícita 428Guia do Editor do Turbo Integrator 89usuário do Turbo Integrator 430

variáveis Globais 427variáveis globais implícitas 428variáveis locais 417verificar sintaxe 46VF 143VIEW 213ViewAttrDelete 272ViewAttrInsert 272ViewAttrN 273ViewAttrNL 274ViewAttrPutN 275ViewAttrPutS 275ViewAttrS 276ViewAttrSL 277ViewColumnDimensionSet 397ViewColumnSuppressZeroesSet 397ViewConstruct 398ViewCreate 398ViewCreateByMDX 399ViewDestroy 401ViewExists 401ViewExtractFilterByTitlesSet 401ViewExtractSkipCalcsSet 402ViewExtractSkipConsolidatedStringsSet 403ViewExtractSkipRuleValuesSet 404ViewExtractSkipZeroesSet 405ViewMDXGet 406ViewMDXSet 406ViewRowDimensionSet 406

Índice Remissivo 441

ViewRowSuppressZeroesSet 407ViewSubsetAssign 408ViewSuppressZeroesSet 408ViewTitleDimensionSet 409ViewTitleElementSet 409ViewZeroOut 410visualização

caixa de diálogo estilos 98funções de manipulação do Turbo Integrator 394Janela Extração 97

VP 144VUSLICE 185

WW_DBSENABLE 185While 343WildcardFileSearch 415

442 IBM Planning Analytics: Referência do TM1

IBM®