370
IBM Cognos TM1 Versão 10.2.0 Guia de Referência

Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

  • Upload
    others

  • View
    14

  • Download
    0

Embed Size (px)

Citation preview

Page 1: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

IBM Cognos TM1Versão 10.2.0

Guia de Referência

���

Page 2: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

NotaAntes de usar estas informações e o produto suportado por elas, leia as informações em “Avisos” na página 347.

Informações do Produto

Este documento se aplica ao IBM Cognos TM1 Versão 10.2.0 e também pode se aplicar a liberações subsequentes.

Materiais Licenciados - Propriedade da IBM

© Copyright IBM Corporation 2007, 2013.

Page 3: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Índice

Introdução . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii

Capítulo 1. O Que Há de Novo . . . . . . . . . . . . . . . . . . . . . . . . . . 1Novos Recursos na Versão 10.2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

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

Guia Processo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Guia Planilha . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Guia Aparência . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Caixa de Diálogo Opções Avançadas . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Grade Mapeamento Avançado . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Editor de Atributos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Menu Arquivo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Menu Editar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Opções de Formato . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Janela de Log de Auditoria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Painel Consulta . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Painel Resultados . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Janela Detalhes do Log de Auditoria . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Barra de Ferramentas Detalhes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Grade Detalhes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

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

Janela Clientes/Grupos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Menu Segurança. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Menu Clientes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Menu Grupos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Grade Clientes/Grupos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

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

Menu Arquivo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Menu Editar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Menu Visualizar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Menu de Opções . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

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

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

Caixa de Diálogo Inserir Elemento de Dimensão . . . . . . . . . . . . . . . . . . . . . . . 32Caixa de Diálogo Ordenação de Elementos de Dimensão . . . . . . . . . . . . . . . . . . . . 32Caixa de Diálogo Propriedades do Elemento de Dimensão . . . . . . . . . . . . . . . . . . . 33Drill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Caixa de Diálogo Editar Fórmula . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Caixa de Diálogo Editar Referência ao Cubo . . . . . . . . . . . . . . . . . . . . . . . . 35Caixa de Diálogo Filtrar Elementos por Atributo . . . . . . . . . . . . . . . . . . . . . . . 36Caixa de Diálogo Filtrar Elementos por Nível . . . . . . . . . . . . . . . . . . . . . . . . 36

© Copyright IBM Corp. 2007, 2013 iii

Page 4: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Caixa de Diálogo Filtrar Subconjunto . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Caixa de Diálogo Filtrar Visualização . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Caixa de Diálogo Obter Visualização (In-Spreadsheet Browser) . . . . . . . . . . . . . . . . . . 40Menu do In-Spreadsheet Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Janela Log de Mensagens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Menu Arquivo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Menu Editar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Menu Ajuda . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

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

Todas as Telas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Tela 1 de 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Tela 2 de 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Tela 3 de 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Caixa de Diálogo Opções de Processo . . . . . . . . . . . . . . . . . . . . . . . . . . 47Caixa de Diálogo Replicar Cubo . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

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

Editor de Regras. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Menu Arquivo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Menu Editar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Menu Visualizar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Menu Inserir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Menu Ferramentas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

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

Grade Designações . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Privilégios de Acesso . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Selecionar Dimensão . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Caixa de Diálogo Selecionar Cubo . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Caixa de Diálogo Selecionar Cubo para Regras . . . . . . . . . . . . . . . . . . . . . . . 59Caixa de Diálogo Selecionar Dimensão . . . . . . . . . . . . . . . . . . . . . . . . . . 59Caixa de Diálogo Selecionar Planilha de Dimensões . . . . . . . . . . . . . . . . . . . . . . 59Caixa de Diálogo Selecionar Elemento . . . . . . . . . . . . . . . . . . . . . . . . . . 59Caixa de Diálogo Selecionar Planilha de Regras . . . . . . . . . . . . . . . . . . . . . . . 60Server Explorer (Janela Principal) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Menu Arquivo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Menu Dinâmico . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Menu Editar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Menu Visualizar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Editor de Subconjunto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Menu Subconjunto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Menu Editar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Menu Visualizar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Menu Ferramentas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

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

Parâmetros de Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Servidor Local . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Secure Socket Layer do Servidor Administrativo . . . . . . . . . . . . . . . . . . . . . . 80

Caixa de Diálogo Consulta do Log de Transações. . . . . . . . . . . . . . . . . . . . . . . 80Caixa de Diálogo Resultados da Consulta do Log de Transações. . . . . . . . . . . . . . . . . . 81Editor do Turbo Integrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Menu Arquivo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Menu Editar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Guia Origem de Dados . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

iv IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 5: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Grade de Visualização . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Guia Variáveis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Guia Mapas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Guia Avançado . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Guia Programação. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Janela Extração de Visualização . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Caixa de Diálogo Estilos de Visualização . . . . . . . . . . . . . . . . . . . . . . . . . 108

Capítulo 3. Funções das Regras . . . . . . . . . . . . . . . . . . . . . . . . 111Operadores Aritméticos em Regras do TM1 . . . . . . . . . . . . . . . . . . . . . . . . 111Operadores de Comparação em Regras do TM1 . . . . . . . . . . . . . . . . . . . . . . . 111Operadores Lógicos em Regras do TM1 . . . . . . . . . . . . . . . . . . . . . . . . . 112Funções de Regras de Cálculo de Consolidação . . . . . . . . . . . . . . . . . . . . . . . 112

ConsolidatedMin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112ConsolidatedMax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113ConsolidatedAvg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114ConsolidatedCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115ConsolidatedCountUnique . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

Funções de Regras de Dados do Cubo . . . . . . . . . . . . . . . . . . . . . . . . . . 117BD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117ISLEAF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117ISUNDEFINEDCELLVALUE . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118UNDEF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118UNDEFINEDCELLVALUE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119UNDEFVALS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

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

Funções de Regras de Informações de Dimensão . . . . . . . . . . . . . . . . . . . . . . 130ATTRN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130ATTRS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131ConsolidateChildren . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132DIMNM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134DIMSIZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135DNEXT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135DNLEV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136TABDIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

Funções de Regras de Informações de Elementos . . . . . . . . . . . . . . . . . . . . . . 137DIMIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137DTYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137ELCOMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138ELCOMPN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138ELISANC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139ELISCOMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140ELISPAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140ELLEV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141ELPAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142ELPARN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142ELWEIGHT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

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

Índice v

Page 6: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

VP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Funções de Regras Lógicas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

CONTINUE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145SE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146STET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Funções de Regras Matemáticas . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147ABS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147ACOS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147ASEN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147ATAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148COS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148EXP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149INT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149ISUND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149LN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150LOG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150MÁXIMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151MÍNIMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Resto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151ALEATÓRIO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152ARRED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152ROUNDP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153SINAL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154SEN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154RAIZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154TAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

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

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

Capítulo 4. Funções de Macro . . . . . . . . . . . . . . . . . . . . . . . . . 165Acessando Funções de Macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Acessando Funções de Macro do Excel Versões 5 e 7 . . . . . . . . . . . . . . . . . . . . 165Acessando Funções de Macro do Excel Versão 8 e mais Recente . . . . . . . . . . . . . . . . 165Acessando Funções de Macro a partir de Módulos VBA . . . . . . . . . . . . . . . . . . . 166D_PICK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166DBProportionalSpread . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166D_FSAVE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167D_SAVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168E_PICK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169I_EXPORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170I_NAMES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171I_PROCESS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171M_CLEAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172N_CONNECT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

vi IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 7: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

OPTGET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173N_DISCONNECT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174OPTSET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174PublishSubset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175PublishView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176QUDEFINE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176QUDEFINEEX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179QUEXPORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181QULOOP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182QUSUBSET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183R_SAVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184SUBDEFINE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184SUBPICK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185T_CLEAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186T_CREATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186T_CREATE16 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187T_PICK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188T_SAVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188TM1RECALC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188TM1RECALC1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189VUSLICE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189W_DBSENABLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

Capítulo 5. Funções da Planilha . . . . . . . . . . . . . . . . . . . . . . . . 191Visão Geral de Funções da Planilha . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

DBR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191DBRA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192DBRW. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193DBS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194DBSA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194DBSS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195DBSW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196DFRST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197DIMIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197DIMNM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198DIMSIZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199DNEXT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199DNLEV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200DTYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200ELCOMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201ELCOMPN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201ELISCOMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202ELISPAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202ELLEV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203ELPAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204ELPARN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204ELSLEN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205ELWEIGHT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205SUBNM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206SUBSIZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207TABDIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208TM1RptElIsConsolidated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208TM1RptElIsExpanded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209TM1RptElLev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209TM1RptFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209TM1RptRow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210TM1RptTitle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212TM1RptView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213TM1User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214VIEW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

Índice vii

Page 8: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Capítulo 6. Funções do Turbo Integrator TM1 . . . . . . . . . . . . . . . . . . 217Funções ASCII e de Texto do Turbo Integrator . . . . . . . . . . . . . . . . . . . . . . . 217

ASCIIDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217ASCIIOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218SetInputCharacterSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219SetOutputCharacterSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221SetOutputEscapeDoubleQuote . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222TextOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

Funções de Manipulação de Atributos do Turbo Integrator . . . . . . . . . . . . . . . . . . . 224AttrDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224AttrInsert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225AttrPutN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225AttrPutS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

Funções de Gerenciamento de Tarefas de Organização de Processos do Turbo Integrator . . . . . . . . . 227ChoreQuit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227SetChoreVerboseMessages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

Funções de Manipulação de Cubos do Turbo Integrator . . . . . . . . . . . . . . . . . . . . 228AddCubeDependency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228CellGetN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229CellGetS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229CellIncrementN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230CellIsUpdateable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231CellPutN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232CellPutProportionalSpread . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232CellPutS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233CubeClearData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234CubeCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235CubeDestroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235CubeExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235CubeGetLogChanges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236CubeSaveData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236CubeSetConnParams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238CubeSetLogChanges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238CubeUnload. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

Funções do Turbo Integrator de Reserva de Dados . . . . . . . . . . . . . . . . . . . . . . 239CubeDataReservationAcquire . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239CubeDataReservationRelease . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240CubeDataReservationReleaseAll . . . . . . . . . . . . . . . . . . . . . . . . . . . 241CubeDataReservationGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242CubeDataReservationGetConflicts . . . . . . . . . . . . . . . . . . . . . . . . . . 244

Funções Date e Time do TurboIntegrator . . . . . . . . . . . . . . . . . . . . . . . . . 245FormatDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245NewDateFormatter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245ParseDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

Funções de Manipulação de Dimensões do Turbo Integrator. . . . . . . . . . . . . . . . . . . 247DimensionCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247DimensionDeleteAllElements . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248DimensionDestroy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248DimensionElementComponentAdd . . . . . . . . . . . . . . . . . . . . . . . . . . 249DimensionElementComponentAddDirect . . . . . . . . . . . . . . . . . . . . . . . . 249DimensionElementComponentDelete . . . . . . . . . . . . . . . . . . . . . . . . . 250DimensionElementComponentDeleteDirect . . . . . . . . . . . . . . . . . . . . . . . 251DimensionElementDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252DimensionElementDeleteDirect . . . . . . . . . . . . . . . . . . . . . . . . . . . 252DimensionElementInsert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253DimensionElementInsertDirect. . . . . . . . . . . . . . . . . . . . . . . . . . . . 254DimensionElementPrincipalName . . . . . . . . . . . . . . . . . . . . . . . . . . 255DimensionExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256DimensionSortOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256DimensionUpdateDirect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258DimensionTopElementInsert . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

viii IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 9: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

DimensionTopElementInsertDirect . . . . . . . . . . . . . . . . . . . . . . . . . . 259Funções Open Database Connectivity do Turbo Integrator . . . . . . . . . . . . . . . . . . . 260

ODBCClose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260ODBCOpen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261ODBCOPENEx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261ODBCOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262SetODBCUnicodeInterface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263

Funções de Controle de Processo do Turbo Integrator . . . . . . . . . . . . . . . . . . . . . 264ProcessError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264ExecuteCommand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264ExecuteProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265GetProcessErrorFileDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266GetProcessErrorFilename . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267GetProcessName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267Se . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267ItemReject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268ItemSkip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269ProcessBreak . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269ProcessError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269ProcessQuit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270While . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270Sincronizado . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

Funções de Gerenciamento de Regras do Turbo Integrator . . . . . . . . . . . . . . . . . . . 272CubeProcessFeeders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272CubeRuleAppend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273CubeRuleDestroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274DeleteAllPersistentFeeders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274ForceSkipCheck . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275RuleLoadFromFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

Funções do Ambiente de Simulação . . . . . . . . . . . . . . . . . . . . . . . . . . . 276GetUseActiveSandboxProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . 276ServerSandboxesDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277ServerActiveSandboxGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281ServerActiveSandboxSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281SetUseActiveSandboxProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282ServerSandboxExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283ServerSandboxGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284ServerSandboxListCountGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

Funções de Segurança do Turbo Integrator . . . . . . . . . . . . . . . . . . . . . . . . 285AddClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285AddGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286AssignClientToGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286AssignClientPassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286AssociateCAMIDToGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287CellSecurityCubeCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287CellSecurityCubeDestroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288DeleteClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289DeleteGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289ElementSecurityGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290ElementSecurityPut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290RemoveCAMIDAssociation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291RemoveCAMIDAssociationFromGroup . . . . . . . . . . . . . . . . . . . . . . . . . 291RemoveClientFromGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292SecurityRefresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

Funções de Manipulação do Servidor do Turbo Integrator . . . . . . . . . . . . . . . . . . . 292BatchUpdateFinish . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293BatchUpdateFinishWait . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294BatchUpdateStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295CubeSaveData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295DisableBulkLoadMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297EnableBulkLoadMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

Índice ix

Page 10: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SaveDataAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297ServerShutdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

Funções de Manipulação de Subconjunto do Turbo Integrator . . . . . . . . . . . . . . . . . . 300SubsetAliasSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300SubsetCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300SubsetCreateByMDX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301SubsetDeleteAllElements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301SubsetDestroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302SubsetElementDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302SubsetElementInsert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302SubsetExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303SubsetExpandAboveSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304SubsetFormatStyleSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304SubsetGetElementName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305SubsetGetSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306SubsetIsAllSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306

Funções de Manipulação de Visualização do Turbo Integrator . . . . . . . . . . . . . . . . . . 307PublishView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307ViewColumnDimensionSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308ViewColumnSuppressZeroesSet . . . . . . . . . . . . . . . . . . . . . . . . . . . 309ViewConstruct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310ViewCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310ViewDestroy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311ViewExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311ViewExtractSkipCalcsSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312ViewExtractSkipRuleValuesSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . 312ViewExtractSkipZeroesSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313ViewRowDimensionSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314ViewRowSuppressZeroesSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315ViewSubsetAssign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315ViewSuppressZeroesSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316ViewTitleDimensionSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316ViewTitleElementSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317ViewZeroOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

Diversas Funções do Turbo Integrator . . . . . . . . . . . . . . . . . . . . . . . . . . 318AddInfoCubeRestriction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318DataSourceSAPUsingRoleAuths . . . . . . . . . . . . . . . . . . . . . . . . . . . 319DataSourceSAPUsingTexts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320Expandir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320FileExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321NumberToString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322NumberToStringEx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322RefreshMdxHierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323StringToNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323StringToNumberEx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324Arquivo TM1ProcessError.log . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324TM1User() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325WildcardFileSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325

Capítulo 7. Variáveis do Turbo Integrator TM1 . . . . . . . . . . . . . . . . . . 327Variáveis Locais do Turbo Integrator . . . . . . . . . . . . . . . . . . . . . . . . . . 327

DatasourceNameForServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327DatasourceNameForClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327DatasourceType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328DatasourceUsername . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328DatasourcePassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328DatasourceQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328DatasourceCubeview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329DatasourceDimensionSubset . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329DatasourceASCIIDelimiter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329DatasourceASCIIDecimalSeparator . . . . . . . . . . . . . . . . . . . . . . . . . . 330

x IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 11: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

DatasourceASCIIThousandSeparator. . . . . . . . . . . . . . . . . . . . . . . . . . 330DatasourceASCIIQuoteCharacter . . . . . . . . . . . . . . . . . . . . . . . . . . . 330DatasourceASCIIHeaderRecords . . . . . . . . . . . . . . . . . . . . . . . . . . . 330Value_Is_String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331NValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331SValue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331OnMinorErrorDoItemSkip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332MinorErrorLogMax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332DataSourceODBOCatalog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333DataSourceODBOConnectionString . . . . . . . . . . . . . . . . . . . . . . . . . . 333DataSourceODBOCubeName . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334DataSourceODBOHierarchyName . . . . . . . . . . . . . . . . . . . . . . . . . . 334DataSourceODBOLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334DataSourceODBOProvider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335DataSourceODBOSAPClientID. . . . . . . . . . . . . . . . . . . . . . . . . . . . 335DataSourceODBOSAPClientLanguage . . . . . . . . . . . . . . . . . . . . . . . . . 335

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

Variáveis Globais Implícitas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337DataMinorErrorCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337MetadataMinorErrorCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337ProcessReturnCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338PrologMinorErrorCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338

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

Capítulo 8. Suporte a Funções MDX. . . . . . . . . . . . . . . . . . . . . . . 341Suporte para Expressões e Funções MDX Definidas pela Microsoft . . . . . . . . . . . . . . . . 341

Lista de Expressões de Membro Suportadas . . . . . . . . . . . . . . . . . . . . . . . 341Lista de Funções de Membro Suportadas . . . . . . . . . . . . . . . . . . . . . . . . 341Lista de Funções Numéricas Suportadas . . . . . . . . . . . . . . . . . . . . . . . . 341Lista de Expressões do Conjunto Suportadas . . . . . . . . . . . . . . . . . . . . . . . 342Lista de Funções do Conjunto Suportadas . . . . . . . . . . . . . . . . . . . . . . . . 342Lista de Expressões de Tupla Suportadas . . . . . . . . . . . . . . . . . . . . . . . . 343

TM1 - Funções MDX Específicas . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343TM1FILTERBYPATTERN(<configurar>, <pattern_str>). . . . . . . . . . . . . . . . . . . . 343TM1FILTERBYLEVEL( <set>, <level_number>) . . . . . . . . . . . . . . . . . . . . . . 343TM1DRILLDOWNMEMBER(<set1>, <set2>|TODOS [,RECURSIVE]) . . . . . . . . . . . . . . . 343TM1Member . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343TM1SORT(<Configurar>, ASC|DESC ) . . . . . . . . . . . . . . . . . . . . . . . . . 344TM1SORTBYINDEX( <Configurar>, ASC|DESC ) . . . . . . . . . . . . . . . . . . . . . 344TM1SUBSETALL( <dimname>) . . . . . . . . . . . . . . . . . . . . . . . . . . . 344TM1SubsetToSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344TM1TupleSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345TM1 -Expressões MDX Específicas . . . . . . . . . . . . . . . . . . . . . . . . . . 346<Dimensão>.<Subsetname> . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346<membro>.ANCESTORS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

Avisos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347

Índice Remissivo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

Índice xi

Page 12: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

xii IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 13: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Introdução

Este documento destina-se a ser usado com o IBM® Cognos TM1 .

Este documento é uma coleção de material de referência para as funções desoftware do IBM Cognos TM1 Business Analytics, variáveis e outros elementos deprogramação.

O Business Analytics fornece soluções de software para o monitoramento e ogerenciamento contínuos de desempenho Financeiro, Operacional, de Cliente eOrganizacional na empresa.

Localizando Informações

Para localizar a documentação do produto IBM Cognos na web, incluindo toda adocumentação traduzida, acesse um dos Centros de Informações do IBM Cognos(http://pic.dhe.ibm.com/infocenter/cogic/v1r0m0/index.jsp). As Notas sobre oRelease são publicadas diretamente nos Centros de Informações e incluem linkspara as mais recentes notas técnicas e APARs.

Termo de responsabilidade das amostras

A Companhia das Grandes Aventuras, as Vendas da GA, qualquer variação donome Grandes Aventuras e Amostra de Planejamento descrevem operações denegócios fictícias com dados de amostra usados para desenvolver aplicativos deamostra para a IBM e os clientes IBM. Esses registros fictícios incluem dados deamostra para transações de vendas, distribuição de produtos, finanças e recursoshumanos. Qualquer semelhança com nomes, endereços, números de contato ouvalores de transação reais é mera coincidência. Outros arquivos de amostraspodem conter dados fictícios gerados manualmente ou por máquinas, dados reaiscompilados de fontes acadêmicas ou públicas, ou dados usados com a permissãodo proprietário dos direitos autorais, para o uso como dados de amostra para odesenvolvimento de aplicativos de amostras. Os nomes de produtos citados podemser marcas registradas dos respectivos proprietários. A cópia não autorizada estáproibida.

Recursos de Acessibilidade

Os recursos de acessibilidade ajudam os usuários que têm deficiências físicas comomobilidade reduzida ou visão limitada a usar produtos de tecnologia dainformação.

Atualmente este produto não é compatível com recursos de acessibilidade queajudam usuários com deficiências físicas, como mobilidade ou visão restritas, ausá-lo.

Declarações prospectivas

Esta documentação descreve a funcionalidade atual do produto. Referências a itensque não estão disponíveis no momento poderão ser incluídas. Nenhumaimplicação sobre qualquer disponibilidade futura deve ser inferida. Referênciasdesse tipo não são um compromisso, promessa ou obrigação legal de fornecermateriais, códigos ou funcionalidades. O desenvolvimento, a liberação e a

© Copyright IBM Corp. 2007, 2013 xiii

Page 14: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

sincronização de recursos ou a funcionalidade permanecem a critério exclusivo daIBM.

xiv IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 15: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Capítulo 1. O Que Há de Novo

Esta seção contém uma lista de recursos novos, alterados e removidos para estaliberação.

Isso ajudará você a planejar sua atualização e as estratégias de implementação doaplicativo, como também os requisitos de treinamento para seus usuários.

Para localizar a documentação mais atual do produto, acesse o centro deinformações do IBM Cognos TM1(http://pic.dhe.ibm.com/infocenter/ctm1/v10r2m0/index.jsp)

Novos Recursos na Versão 10.2.0Listadas abaixo estão as novas funções incluídas na documentação do IBM CognosTM1 desde a última liberação.

As novas funções a seguir foram incluídas na documentação Funções doTurboIntegrator:v “ServerSandboxGet” na página 284v “ServerSandboxExists” na página 283v “ServerSandboxListCountGet” na página 284v “AssociateCAMIDToGroup” na página 287v “RemoveCAMIDAssociation” na página 291v “RemoveCAMIDAssociationFromGroup” na página 291v “CellSecurityCubeCreate” na página 287v “CellSecurityCubeDestroy” na página 288

© Copyright IBM Corp. 2007, 2013 1

Page 16: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

2 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 17: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Capítulo 2. Windows e Caixas de Diálogo

Esta seção descreve todas as janelas e caixas de diálogo significativas do IBMCognos TM1 .

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

Para obter exemplos e etapas sobre o uso de botões de Ação em planilhas, consulteo IBM Cognos TM1 Developer Guide.

Servidor

Esta lista inclui os nomes de todos os servidores TM1 atualmente disponíveisna 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 aoservidor atualmente selecionado na caixa de listagem de servidores.

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

Desconectar

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

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

Ação

Selecione a ação que deseja que o botão de Ação execute quando for clicado.v Executar um Processo do Turbo Integrator

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

v Ir para Outra PlanilhaSelecione esta opção para configurar um botão de Ação que navega paraoutra planilha. Ao selecionar esta opção, a guia Planilha torna-se ativada.

v Executar um Processo e ir para uma PlanilhaSelecione esta opção para configurar um botão de Ação que executa umprocesso e, então, navega para outra planilha. Ao selecionar esta opção, asguias Processo e Planilha tornam-se ativadas.

v Calcular/Reconstruir SomenteSelecione esta opção para recalcular ou reconstruir sem executar umprocesso do TI ou navegar para uma nova planilha. Isso poderá ser útil seatualizar somente a planilha atual ou recarregar a versão original de umFormulário Ativo.

© Copyright IBM Corp. 2007, 2013 3

Page 18: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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

OK

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

Cancelar

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

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 dasseguintes maneiras:v Para executar um processo disponível no servidor atual, selecione o nome do

processo na lista.v 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 ocomportamento do botão de Ação antes 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 47.

Nome do Processo

Esta opção aparece quando você seleciona Obter Informações do Processo daPlanilha na lista Processo.

Insira uma referência do Excel que forneça o nome do processo a ser executadode uma das seguintes maneiras.v Para fazer referência a uma única célula, use o seguinte formato:

=ColumnNameRowName. Por exemplo: =A1.v Para fazer referência a um intervalo nomeado no Excel, use o seguinte

formato: =NameOfRangev 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 do processo da lista Processo.v Se você selecionou um processo da lista Processo, a grade Parâmetros

aparecerá com uma lista dos parâmetros para o processo selecionado. Épossível inserir valores para cada parâmetro diretamente na grade ou usaruma referência do Excel que recupera dinamicamente um valor deparâmetro da planilha atual.

v Se você selecionou a opção Obter Informações do Processo da Planilha nalista Processo, deverá usar uma referência do Excel para recuperar os valoresde parâmetros da planilha atual. É possível inserir uma referência a umaúnica célula, a um intervalo de células ou a um intervalo nomeado.

4 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 19: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Qualquer referência deve apontar para o número apropriado de células,dependendo do número de parâmetros que o processo está esperando.

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

Para obter exemplos, consulte o IBM CognosTM1 Developer Guide.

Referência do Excel

Cria uma referência do Excel que recupera dinamicamente o nome do processoou o(s) valor(res) de parâmetros da planilha atual quando o botão Ação forclicado.

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

Consultar

Use um dos seguintes métodos para selecionar uma planilha:v Aplicativos do TM1 - Selecione esta opção se deseja escolher uma planilha

da árvore de Aplicativos TM1v 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.v Se você selecionou a opção Aplicativos do TM1 , será aberta uma caixa de

diálogo na qual é possível selecionar uma planilha da árvore Aplicativos doTM1 .

v Se você selecionou a opção Arquivos, aparecerá a caixa de diálogo Abrir, naqual é possível navegar e 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 valor pode ser inserido de uma das seguintes maneiras:v Clique no botão Navegar, próximo à opção Consultar, para selecionar uma

pasta de trabalho da árvore Aplicativos do TM1 ou dos arquivos em seucomputador.

v Clique no botão Referência do Excel para selecionar uma célula que sejaavaliada para um caminho e nome de pasta de trabalho.

v Insira manualmente um nome e caminho de pasta de trabalho.v 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 Aplicativos do TM1 usa oformato:

<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>

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

Page 20: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Por exemplo:

\\boston\reports\2007_summary.xls

Para obter detalhes e exemplos, consulte o Guia para Desenvolvedores do IBMCognos TM1 .

Planilha

Contém o nome da planilha para a qual você deseja navegar. Este valor podeser inserido de uma das seguintes maneiras:v Clique no botão Navegar para selecionar uma pasta de trabalho e, em

seguida, selecione uma planilha da lista Planilha.v Insira manualmente um nome de planilha.v Insira manualmente uma referência do Excel que seja avaliada para um

nome de planilha.v 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 o Guia para Desenvolvedores do IBMCognos TM1 .

Corresponder Elementos do Título

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

Para obter detalhes e exemplos, consulte o Guia para Desenvolvedores do IBMCognosTM1 .

Substituir Planilha Atual

Esta opção determina como a planilha de destino será aberta.v Se essa opção não for selecionada (padrão), a planilha de destino é aberta

em uma nova janela em Excel ou em uma nova guia em TM1 Web .v 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 nobotão e causar o fechamento 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 mapear manualmente campos entre as planilhas de origem e dedestino para um botão de Ação, que navega de uma planilha para outra.

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

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

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

6 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 21: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

FonteClique neste botão para exibir a caixa de diálogo Fonte, na qual é possíveldefinir o estilo e tamanho de 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 eselecionar o arquivo de imagem que você deseja usar.

Exibir como Hiperlink

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

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

VisualizarEsta área mostra uma visualização da legenda do texto, estilo de fonte, cor dafonte e cor do plano de fundo 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 dediálogo Cor, na qual é possível selecionar uma cor padrão ou definir uma corcustomizada.

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

Caixa de Diálogo Opções AvançadasUse a caixa de diálogo Opções Avançadas para mapear manualmente campos entreas planilhas de origem e de destino ao inserir um botão de Ação que navega deuma planilha para outra. Esta ferramenta ajuda-o a mapear dimensões, células evalores da planilha de origem para a planilha de destino.

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

Campo Descrição

Incluir Inclui uma nova linha na gradeMapeamento Avançado.

Excluir Exclui a linha selecionada da gradeMapeamento Avançado.

OK Fecha a caixa de diálogo Opções Avançadase salva suas configurações.

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

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

Page 22: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Para obter exemplos sobre como usar a caixa de diálogo de Opções Avançadas,consulte o Guia para Desenvolvedores do IBM Cognos TM1 .

Grade Mapeamento AvançadoUse a grade Mapeamento Avançado para definir o mapeamento de campos entreas planilhas de origem e de destino. A grade pode ser usada para especificar comoos elementos nas planilhas de origem e de destino são correspondidos quando aplanilha de destino é aberta. Cada linha na grade define uma configuração demapeamento.

Campo Descrição

Tipo de Origem Este campo representa o tipo de objeto parao valor que você deseja mapear.

Selecione o Tipo de Origem da seguinteforma:

v SUBNM - Indica que você está mapeandode uma célula que contém uma dimensãode título na planilha de origem.

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

v Valor - Indica que você inserirá um valorde sequência ou numérico que seráenviado para o destino.

Objeto de Origem Este campo usa um valor dependendo doque está selecionado no campo Tipo deOrigem.

Insira o Objeto de Origem da seguinteforma:

v Se Tipo de Origem for definido comoSUBNM, será necessário especificar onome da dimensão de título existente naplanilha de origem.

v Se Tipo de Origem for definido comoDBRW Selecionada, será necessárioespecificar o nome de uma dimensão detítulo da linha ou coluna existente naplanilha de origem.

v Se Tipo de Origem for definido comoValor, será necessário inserir um valor desequência ou numérico que será enviadopara a planilha de destino.

Também é possível recuperar estes valoresda planilha de origem, usando o símbolo =para criar uma referência do Excel.

8 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 23: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Campo Descrição

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

Selecione o Tipo de Destino da seguinteforma:

v SUBNM - Indica que o destino é umadimensão de título na planilha de destino.

v Intervalo Nomeado - Indica que o destinoé um intervalo nomeado na planilha dedestino.

v Intervalo - Indica que o local de destino éuma célula na planilha de destino.

CUIDADO:Se você definir um Tipo de Destino comoum Intervalo Nomeado ou Intervalo, osdados ou fórmulas preexistentes na célulade destino serão sobrescritos quando vocênavegar com o botão de Ação. Se a célulade destino contiver uma função TM1DBRW, então a função será perdida e acélula não poderá se conectar, ler ou gravarno servidor.

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

Insira o Objeto de Destino da seguinteforma, dependendo de sua seleção para Tipode Destino:

v Se Tipo de Destino for definido comoSUBNM, será necessário especificar onome da dimensão de título na planilhade destino.

v Se Tipo de Destino for definido comoIntervalo Nomeado, será necessárioespecificar o nome do intervalo naplanilha de destino.

v Se Tipo de Destino for definido comoIntervalo, será necessário especificar olocal da célula na planilha de destino.

Também é possível usar uma referência doExcel para recuperar o valor para o campoObjeto de Destino.

Para obter um exemplo detalhado, consulteo Guia para Desenvolvedores do IBM CognosTM1 .

Subconjunto Insira um valor para o campo Subconjuntoquando o campo Tipo de Destino fordefinido como SUBNM.

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

Page 24: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Campo Descrição

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

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 comoos valores de elementos são exibidos no Cube Viewer. O valor de atributo deFormato padrão é Sem Estilo.

Menu Arquivo

Item de Menu Descrição

Fechar Fecha o Editor de Atributos.

Menu Editar

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 umintervalo de células.

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

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

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

Incluir Novo Atributo Abre a caixa de diálogo Novo Atributo, apartir da qual é possível criar um novoatributo para os elementos na dimensão.

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

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

Editar Formato do Elemento Abre a caixa de diálogo Formato Numérico,a partir da qual é possível designar valoresde atributos de Formato.

10 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 25: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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

Selecione uma opção da caixa de listagem Categoria para especificar um formatode exibição para as cé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 pontodecimal. Os valores negativos são prefixadoscom um sinal de menos (-).

Use a opção Precisão para especificar onúmero de dígitos que seguem o pontodecimal. Observe que os valores derivadosde Regras retornam números inteiros apenasquando definidos como formato Geral.

Ajustado Este formato exibe números sem vírgulasseparando dígitos à esquerda do pontodecimal. Os valores negativos são prefixadoscom um sinal de menos (-); os usuários têma opção de usar parênteses para negativos,se preferirem.

Use a opção Precisão para especificar onúmero de dígitos que seguem o pontodecimal.

Moeda Este formato exibe números com o símbolomonetário especificado em seu WindowsRegionalSettingsProperties, e utiliza vírgulaspara separar dígitos da terceira casa daesquerda do ponto de decimal. Os valoresnegativos são prefixados com um sinal demenos (-).

Use a opção Precisão para especificar onúmero de dígitos que seguem o pontodecimal.

Data Exibe uma lista de formatos de datapredefinidos.

Hora Exibe uma lista de formatos de horáriopredefinidos.

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

Page 26: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Categoria de Formato Descrição

Porcentagem Este formato multiplica números por 100 eexibe o seguinte sinal de porcentagem (%).Os dígitos à esquerda do ponto decimal nãousam vírgulas, e os valores negativos sãoprefixados com um sinal de menos (-).

Use a opção Precisão para especificar onúmero de dígitos que seguem o pontodecimal.

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

Use a opção Precisão para especificar onúmero de dígitos que seguem o pontodecimal.

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

Precisão Esta opção determina o número de casasdecimais a serem exibidas para um formatoselecionado. Se um valor tiver mais casasdecimais do que a precisão especificada, eleserá arredondado apenas para propósitos deexibição; o valor de número inteiro éarmazenado no banco de dados do TM1 .

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

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

Painel ConsultaUse o painel Consulta para construir consultas que procuram no log de auditoriado TM1 .

A barra de ferramentas do painel Consulta contém um ícone Executar Consultapara consultar o log de auditoria depois de configurar as opções de consulta.

As opções de consulta estão organizadas nos seguintes grupos:v Data e Horav Proprietário do Eventov Tipo de Evento.

12 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 27: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Opções Data e Hora

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

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 predefinidoou selecione Período de TempoCustomizado para ativar as opções dehorário de Início e Encerramento.

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 Customizadopara a opção Período de Tempo.

O TM1 consulta todos os registros gravadospara o log de auditoria em ou após essadata/hora.

Clique em para abrir a ferramentacalendário, na qual é possível selecionaruma data e hora.

Horário de Encerramento A data/hora de encerramento para aconsulta.

Esta opção é ativada apenas quando vocêseleciona Período de Tempo Customizadopara a opção Período de Tempo.

O TM1 consulta todos os registros deauditoria até o horário de encerramento quevocê especificar.

Clique em para abrir a ferramentacalendário, na qual é possível selecionaruma data e hora.

O horário de encerramento padrão é a datae hora atuais.

Opções de Proprietário do Evento

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

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

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

Page 28: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Opção Descrição

Tudo Define a consulta para procurar eventos deauditoria causados por um usuário ou tarefade organização de processos planejada doTM1 .

Cliente Define a consulta para procurar eventos deauditoria causados apenas por usuários doTM1 .

Para procurar eventos causados por umusuário específico do TM1 , clique no botão

Selecionar Cliente . É possívelselecionar um único cliente ou váriosclientes.

O padrão é todos os clientes.

Tarefa de Organização de ProcessosPlanejada

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

Para procurar eventos causados por umatarefa de organização de processos planejadaespecífica, clique no botão Selecionar Tarefade Organização de Processos Planejada

. É possível selecionar uma únicatarefa de organização de processos planejadaou várias tarefas de organização deprocessos planejadas.

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

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

Opção Descrição

Tudo Define a consulta para procurar dois tiposde eventos de auditoria; eventos de todo osistema e relacionados a objetos.

Em todo o sistema Define a consulta para procurar apenaseventos de auditoria 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 oseventos de todo o sistema.

14 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 29: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Opção Descrição

Objeto Define a consulta para procurar apenaseventos de auditoria de tipo de objeto.

Para procurar um evento de objetoespecífico, use as opções conforme a seguir:

v Tipo de Objeto - Limita a consulta aapenas um tipo específico de objeto doTM1 . Por exemplo, eventos relacionadosapenas a dimensões.

v Nome do Objeto - Permite selecionar umnome do objeto específico.

Clique em para exibir uma caixa dediálogo na qual é possível selecionarobjetos por nome.Nota: Quando você define a opção Tipode Objeto para Elemento, o botão Seleçãode Nome do Objeto é desativado, pois alista pode ser muito grande para serexibida. Para procurar eventosrelacionados a um elemento específico,você deve inserir manualmente um nomede elemento usando o seguinte formato:DimensionName:ElementName. Porexemplo: region:italy

v Tipo de Evento - Limita a consulta aapenas um tipo específico de evento deobjetos. A configuração padrão procuratodos os eventos de tipo de objeto.

Painel ResultadosUse o painel Resultados para visualizar e navegar nos registros recuperados porsua 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 paraa área de transferência doWindows.

Localizar Abre a caixa de diálogoLocalizar, na qual é possívelprocurar texto nos registrosde eventos.

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

Page 30: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Ação Botão Descrição

Exportar Abre a caixa de diálogoSalvar como, na qual épossível salvar os registrosde eventos em um arquivoem um dos seguintesformatos:

v XML

v Delimitado por vírgula

v Delimitado por guia

Grade ResultadosO painel Resultados inclui uma grade que exibe os registros de log de auditoriarecuperados pela consulta. Os registros recuperados estão organizados nasseguintes colunas:

Coluna Descrição

Data Data e hora do evento.

Usuário O cliente TM1 (usuário) ou tarefa planejadaresponsável por 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 aoevento.

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

Se um evento tiver detalhes, será possívelvisualizar os detalhes clicando no ícone

Detalhes desse registro.

Os registros podem ser classificados na grade em ordem crescente ou decrescentepara 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 logde auditoria que foi exibido nos resultados da consulta da janela Log de Auditoriaprincipal.

16 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 31: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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

Botão Descrição

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

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

Exportar Abre a caixa de diálogo Salvar como, naqual é possível salvar os registros de eventosem um arquivo em um dos seguintesformatos:

v XML

v separado por vírgula

v separado por guia

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

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

Coluna Descrição

Data Data e hora do evento.

Usuário O cliente TM1 (usuário) ou tarefa planejadaresponsável por 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 aoevento.

Os registros podem ser classificados na grade em ordem crescente ou decrescentepara 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 paraplanejar uma replicação ou processo para sincronização ou execução em umintervalo regular.

O Assistente consiste em duas telas:

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

Page 32: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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

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

Tela 1 (Etapa 1)

Campo Descrição

Lista Disponível Lista todas as replicações e processosdisponíveis para programação como tarefasde organização de processos.

Lista Selecionado Lista as replicações ou processosselecionados para inclusão na tarefa deorganização de processos atual.

IncluirClique neste botão para mover replicaçõesou processos selecionados da listaDisponível para a lista Selecionado

Incluir TodosClique neste botão para mover todas asreplicações ou processos da lista Disponívelpara a lista Selecionado.

RemoverClique neste botão para mover replicaçõesou processos selecionados da listaSelecionado para a lista Disponível.

Remover TodosClique neste botão para mover todas asreplicações ou processos da lista Selecionadopara a lista Disponível.

Especificar Valores para Parâmetros Clique para abrir a caixa de diálogo Valoresde Parâmetros, a partir da qual é possívelespecificar valores para quaisquerparâmetros associados ao processoselecionado.

Tela 2 (Etapa 2)

Campo Descrição

Data e Hora de Início da Tarefa deOrganização de Processos

Selecione uma data de início no calendário eespecifique um horário de início no campode Tempo.

Frequência de Execução da Tarefa deOrganização de Processos

Preencha os campos apropriados paraestabelecer o intervalo no qual a tarefa deorganização de processos deve serexecutada.

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.Limpe esta caixa para ativar a tarefa deorganização de processos posteriormente.

18 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 33: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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

Grade Clientes/Grupos

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

A grade também inclui várias colunas que exibem propriedades para clientes noservidor.v A célula na interseção de um nome de cliente e a coluna Senha contém a senha

para o cliente.v 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ósdecorrer este número de dias, o cliente não poderá mais efetuar login noservidor 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 deexpiração.

v A célula na interseção do nome de cliente e a coluna Status indica se o clienteestá ativo no servidor.

v A célula na interseção do nome de cliente e a coluna Máximo de Conexõesindica o número máximo de conexões que podem ser estabelecidas no servidorcom 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 NovoCliente, a partir da qual é possível criar umnovo cliente no servidor.

Excluir Cliente Exclui do servidor o cliente selecionado nomomento.

Desconectar Cliente Desconecta do servidor o cliente selecionadono momento.

Definir Senha Define a senha para o cliente selecionado nomomento.

Limpar Senha Limpa a senha para o cliente selecionado nomomento.

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

Page 34: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Menu Grupos

Item de Menu Descrição

Incluir Novo Grupo Abre a caixa de diálogo Criando NovoGrupo, a partir da qual é possível criar umnovo grupo de usuários no servidor.

Excluir Grupo Exclui do servidor o grupo de usuáriosselecionado no 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 osclientes no servidor.

Senha Identifica se uma senha está definida paraum determinado cliente.

É possível clicar em uma célula nainterseção da coluna Senha e uma linha docliente, em seguida, digitar uma senha paradesignar uma senha ao cliente.

Depois de inserir uma senha, o TM1 solicitaque a senha seja inserida novamente paraconfirmação.

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

Para designar expiração para a senha de umcliente, clique na célula na interseção dacoluna Dias para Expiração e a linha docliente, em seguida, digite um valor deexpiração.

Conexões Máximas Identifica o número máximo de conexõesque podem ser feitas no servidor por umdeterminado cliente.

Para designar um número máximo deconexões para um cliente, clique na célulana interseção da coluna Máximo deConexões e a linha do cliente, em seguida,digite o número máximo de conexões para ocliente.

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

20 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 35: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Coluna Descrição

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

Para designar um cliente a um grupo deusuários, preencha a caixa de seleção nainterseção da coluna do grupo de usuários eo nome do cliente.

Os clientes podem pertencer a vários gruposde usuários.

Caixa de Diálogo Mensagens para os ClientesA caixa de diálogo Centro de Sistema de Mensagens para o Cliente permitegerenciar as conexões do cliente com um servidor. Também é possível usar estacaixa de diálogo para encerrar remotamente um servidor. Você deve ser membrodo 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álogoMensagens para os Clientes.

Campo Descrição

Encerrar Servidor Selecione esta opção para encerrar oservidor e, então, especifique um intervalode Minutos.

Desconectar Clientes Selecione esta opção para desconectarclientes do servidor e, então, especifique umintervalo de Minutos.

Você deve clicar em Selecionar Clientes paracriar ou selecionar um subconjunto declientes a serem desconectados.

Transmitir Mensagem para ClientesSelecionados

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

Insira a mensagem na caixa de texto, emseguida, clique em Selecionar Clientes paracriar ou selecionar um subconjunto declientes para receber a mensagem.

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

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

Para criar uma dimensão em um servidor remoto, prefixe o nome da dimensãocom o nome do servidor e dois pontos. Por exemplo, insira Sales:Product paracriar a dimensão Produto no servidor Vendas.

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

Page 36: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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

Campo Descrição

Para Servidor Selecione um servidor de origem da lista. Alista inclui os nomes de todos os servidoresdisponíveis no momento em sua rede.

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

Com Senha Insira sua senha para o servidor de origemselecionado.

Com Namespace Se o objeto utiliza segurança do CAMPassport, insira o ID de namespace do IBMCognos. Não insira, aqui, o nome descritivo.

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

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

Campo Descrição

Nome do Cubo Digite o nome para o cubo que está sendocriado neste campo.

Dimensões Disponíveis Uma lista de todas as dimensões disponíveisno servidor no qual o cubo está sendocriado.

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íveispara a lista Dimensões no Novo Cubo

Remover Clique neste botão para mover as dimensõesselecionadas da lista Dimensões no NovoCubo para 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 dobotão mover as dimensões selecionadas umaposição para cima.

22 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 37: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Campo Descrição

Mover para Baixo Clique neste botão para mover as dimensõesselecionadas para baixo por meio da listaDimensões no Novo Cubo. Cada clique dobotão mover as dimensões selecionadas umaposição para baixo.

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

Reconfigurar Clique para reconfigurar a lista DimensõesDisponíveis e limpar a lista Dimensões noNovo Cubo.

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

Propriedades Clique neste botão para designarpropriedades do cubo.

É possível designar propriedades quedefinem uma dimensão das medidas, umadimensão de tempo e status decarregamento sob demanda para o cubo.

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

Caixa de Diálogo do Cube OptimizerSe você não estiver muito familiarizado com seus dados de negócios, será possívelespecificar uma ordem de dimensões durante a criação do cubo, que resulta emum desempenho inferior ao ideal. De forma semelhante, é possível que adistribuição de dados em um cubo seja alterada no decorrer do tempo, tornando aordem de dimensões especificada durante a criação do cubo inferior à ideal. Paratratar estes problemas, o TM1 inclui um recurso que permite otimizar a ordem dedimensões em um cubo, consumindo, portanto, menos memória e melhorando odesempenho.

Quando otimizar a ordem da dimensão em um cubo, o TM1 não altera a ordemreal das dimensões na estrutura do cubo. O TM1 altera a maneira como asdimensões são ordenadas internamente no servidor, mas como a estrutura do cubonão é alterada, as regras, funções ou aplicativos que fazem referência ao cubopermanecem válidas.

Conforme você altera a ordem de dimensões, pode visualizar instantaneamente umrelatório que detalha o impacto de suas mudanças no consumo de memória docubo.

Pelas seguintes razões, você deve otimizar a ordem de dimensões em um cuboapenas em um ambiente de desenvolvimento, enquanto estiver tentandodeterminar a configuração ideal do cubo:v São necessários recursos expressivos de memória para que o servidor

reconfigure a ordem das dimensões em um cubo. Durante o processo dereordenação, a RAM temporária no servidor é aumentada por um fator de doispara o cubo que está sendo reordenado. Por exemplo, um cubo de 50 MB requer100 MB de RAM para reconfiguração.

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

Page 38: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

v A reordenação coloca um bloqueio de leitura no servidor, bloqueando todos ospedidos do usuário enquanto a reordenação é executada.

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

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

deseja otimizar.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 fornegativo, a nova ordem de 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 cubosindividuais.

Campo Descrição

Dimensão das Medidas Selecione uma dimensão das medidas dalista.

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

Carregar sob Demanda Preencha a caixa para carregar o cubo namemória do servidor apenas quando umcliente solicitar dados do cubo. Limpe estacaixa para carregar o cubo automaticamentequando o servidor for iniciado.

Cube Viewer

Dimensões de Título

As dimensões de título aparecem diretamente abaixo da Barra de Ferramentas naparte superior da janela do Cube Viewer. Cada dimensão é exibida em uma caixade listagem.

Dimensões da Linha

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

24 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 39: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Dimensões da Coluna

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

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çãodo TM1 , a partir da qual é possível abriroutras visualizações associadas ao cuboatual.

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 atualcom um novo nome.

Excluir Visualizações Abre a caixa de diálogo ExcluirVisualizações Nomeadas, a partir da qual épossível excluir visualizações nomeadas.

Fatiar Exporta a visualização atual para umaplanilha do Excel. A planilha Excel épreenchida com fórmulas que recuperam egravam valores no servidor da qual avisualização se origina.

Formulário Ativo Ativa a opção Formulário Ativo parapermitir incluir uma conexão de FormulárioAtivo na célula atual da planilha.

Captura Instantânea Exporta a visualização atual para umaplanilha do Excel como valores simples. Aplanilha não mantém uma conexão com oservidor a partir do qual a visualização seorigina.

Fechar Fecha a janela do Cube Viewer.

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

Page 40: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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 ouFechar encerra a coleção de ações quepodem ser desfeitas ou refeitas.

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

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

Copiar Copia o conteúdo de células selecionadas,conforme formatadas no momento, para aÁrea de Transferê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êncianas células selecionadas.

Excluir Exclui os valores de células selecionados.

Editar Atributos do Cubo Abre a janela do Editor de Atributos, apartir da qual é possível designar e editaratributos para todos os cubos no servidoratual.

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 naparte superior do Cube Viewer. Um vistoindica que a Barra de Ferramentas é exibida.

Barra de Status Oculta ou exibe a Barra de Status na parteinferior do Cube Viewer. Um visto indicaque a Barra de Status é exibida.

Da Direita para a Esquerda Esta alternância altera a posição dedimensões da coluna no Cube Viewer.

Uma seta apontando para a direita indicaque as colunas são organizadas da direitapara a esquerda. Uma seta apontando para aesquerda significa que as colunas sãoorganizadas da esquerda 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 linhase colunas contendo apenas valores zero navisualização do cubo. Um visto indica queas linhas e colunas contendo apenas zerossão suprimidas na visualização atual.

26 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 41: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Opção Descrição

Suprimir Zeros em Linhas Esta opção suprime ou exibe todas as linhascontendo apenas valores zero navisualização do cubo. Um visto indica queas linhas contendo apenas zeros sãosuprimidas na visualização atual.

Suprimir Zeros em Colunas Esta opção suprime ou exibe todas ascolunas contendo apenas valores zero navisualização do cubo. Um visto indica queas colunas contendo apenas zeros sãosuprimidas na visualização atual.

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

Formatar Abre a caixa de diálogo Formato Numérico,a partir da qual é possível definir o formatonumérico para valores na visualização atual.Observe que o formato selecionado éaplicável apenas aos valores para os quaisnão existe nenhum atributo de Formatoespecificado.

Largura da Coluna Abre a caixa de diálogo Largura da Coluna,que permite definir uma largura mínima euma máxima para colunas no Cube Viewer.

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

Um visto indica que as fatias são inseridasem uma nova pasta de trabalho quandovocê escolhe Arquivo, Fatia.

Se esta opção não estiver ativada, as fatiasserão inseridas em uma nova planilha dapasta de trabalho atual.

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

Para selecionar vários subconjuntos adjacentes, clique e arraste nos subconjuntos.Para selecionar vários subconjuntos não adjacentes, CRTL-clique em cadasubconjunto.

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

Para selecionar várias visualizações adjacentes, clique e arraste nas visualizações.Para selecionar várias visualizações não adjacentes, CRTL-clique em cadavisualização.

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

Page 42: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Editor de Dimensão

Área de Janela Elementos

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

Área de Janela Propriedades

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

Quando você seleciona um elemento folha, a área de janela Propriedades exibe aspropriedades do elemento folha.

Nota: Ao visualizar um conjunto de dimensões excepcionalmente grande no Editorde Dimensão com a área de janela Propriedades ativada, você talvez tenhaproblemas de desempenho. Isto pode acontecer quando você seleciona umaconsolidação na área de janela Elementos e o TM1 precisa exibir toda a lista deelementos e propriedades relacionados na área de janela Propriedades.

Se estiver trabalhando com conjuntos de dimensões grandes, poderá ser necessáriodesativar a área de janela Propriedades. Para desativar a área de janelaPropriedades, clique na opção Janela Propriedades no Menu Visualizar pararemover 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 umnovo nome.

Fechar Fecha o Editor de Dimensão.

Menu Editar

Item de Menu Descrição

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

Copiar Copia os elementos selecionados para a Áreade Transferência.

28 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 43: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Item de Menu Descrição

Colar Cola o conteúdo da Área de Transferênciacomo um novo elemento.

v Quando nenhum elemento estiverselecionado no Editor de Dimensão, estaopção inserirá um novo elemento acimado primeiro elemento exibido na área dejanela Elementos.

v Quando um elemento estiver selecionadona área de janela Elementos, esta opçãoexibirá um submenu com as opções ColarAcima, Colar como Filho e Colar Abaixo.

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

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

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

Inserir Filho Abre a caixa de diálogo Inserir Elemento deDimensão, a partir da qual é possível inserirum filho ou filhos de um elementoselecionado.

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 dejanela Elementos.

Filtrar por, Nível Abre a caixa de diálogo Filtrar por Nível, apartir da qual é possível selecionarelementos por nível de hierarquia.

Esta opção afeta apenas a exibição deelementos; ela não afeta a estrutura dadimensão. Quando você usar esta opção, aárea de janela Elementos exibirá apenas oselementos do nível especificado.

Filtrar por, Atributo Abre a caixa de diálogo Filtrar por Atributo,a partir da qual é possível selecionarelementos por valor de atributo.

Esta opção afeta apenas a exibição deelementos; ela não afeta a estrutura dadimensão. Quando você usar esta opção, aárea de janela Elementos exibirá apenas oselementos com o valor de atributoespecificado.

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

Page 44: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Item de Menu Descrição

Filtrar por, Curinga Permite selecionar elementos quecorrespondem a uma expressão de procuradefinida pelo usuário.

Esta opção afeta apenas a exibição deelementos; ela não afeta a estrutura dadimensão. Quando você usar esta opção, aárea de janela Elementos exibirá apenas oselementos correspondentes à expressão deprocura especificada.

Selecionar Alias Abre a caixa de diálogo Aliases do TM1 , apartir da qual é possível selecionar um aliasa ser usado para exibição no Editor deDimensão.

Classificar, Crescente Classifica todos os elementos na área dejanela Elementos em ordem alfabéticacrescente.

Esta opção afeta apenas a exibição deelementos; ela não afeta a estrutura dadimensão.

Classificar, Decrescente Classifica todos os elementos na área dejanela Elementos em ordem alfabéticadecrescente.

Esta opção afeta apenas a exibição deelementos; ela não afeta a estrutura dadimensão.

Classificar, Hierarquia Classifica todos os elementos na área dejanela Elementos em ordem hierárquica,portanto, é possível ver o relacionamentopai/filho de elementos.

Esta opção afeta apenas a exibição deelementos; ela não afeta a estrutura dadimensão.

Classificar, Índice Crescente Classifica todos os elementos na área dejanela Elementos em ordem crescente, deacordo com o valor de índice de elemento.

Esta opção afeta apenas a exibição deelementos; ela não afeta a estrutura dadimensão.

Classificar, Índice Decrescente Classifica todos os elementos na área dejanela Elementos em ordem decrescente, deacordo com o valor de índice de elemento.

Esta opção afeta apenas a exibição deelementos; ela não afeta a estrutura dadimensão.

30 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 45: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Item de Menu Descrição

Manter Altera a área de janela Elementos para queapenas os elementos selecionados nomomento sejam exibidos.

Esta opção afeta apenas a exibição deelementos; ela não afeta a estrutura dadimensão.

Ocultar Altera a área de janela Elementos para queos elementos selecionados no momentofiquem ocultos.

Esta opção afeta apenas a exibição deelementos; ela não afeta a estrutura dadimensão.

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

Excluir da Consolidação Exclui a instância de um elementoselecionado da consolidação atual.

Editar Formatos do Elemento Abre a planilha Editar Formatos deElemento, a partir da qual é possível definirestilos de exibição de elementos. Eles exibemestilos que são aplicados em fatias dinâmicase em Planilhas da web do TM1 Web .

Expandir Elemento Exibe todos os filhos de um elementoselecionado.

Reduzir Elemento Oculta todos os filhos de um elementoselecionado.

Propriedades Abre a caixa de diálogo Propriedades doElemento de Dimensão, a partir da qual épossível designar o tipo e peso de umelemento para um elemento selecionado.

Menu Visualizar

Item de Menu Descrição

Barras de Ferramentas Oculta ou exibe as várias barras deferramentas na parte superior da janela doEditor de Dimensão. Um visto indica queuma barra de ferramentas é exibida.

Barra de Status Oculta ou exibe a Barra de Status na parteinferior da janela do Editor de Dimensão.Um visto indica que a Barra de Status éexibida.

Janela Propriedades Oculta ou exibe a área de janelaPropriedades. Um visto indica que a área dejanela Propriedades é exibida.

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

Page 46: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Item de Menu Descrição

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

Caixa de Diálogo Inserir Elemento de DimensãoUse esta caixa de diálogo para incluir elementos simples, de sequência ouconsolidados em uma dimensã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 sendoincluídos elementos. Esta não é uma opçãoeditável.

Nome do Pai O nome do elemento-pai no qual estãosendo incluídos elementos. Esta não é umaopção editável.

Se um elemento foi selecionado no editor dedimensão quando você abriu a caixa dediálogo Inserir Elemento de Dimensão, esseelemento será exibido como o Nome do Pai.Se nenhum elemento foi selecionado, oNome do Pai será Raiz.

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

Tipo de Elemento Faça uma seleção apropriada para oelemento que você deseja inserir.

Peso do Elemento Se o tipo de elemento for Simples e o Nomedo Pai for algo diferente de Raiz, insira umpeso nesta caixa. O peso é um fator demultiplicação aplicado a um elementodurante a consolidação.

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

Incluir Clique em Incluir sempre que especificar umnovo elemento, tipo e peso.

OK Clique neste botão quando terminar deincluir elementos para confirmar os novoselementos na dimensã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 cadaelemento na dimensão. O primeiro elemento em uma dimensão possui um valorde índice de 1, o segundo elemento possui um valor de índice de 2, e assim pordiante. A ordem de elementos em uma dimensão é importante porque muitasfunções do TM1 (planilha, regras e Turbo Integrator) fazem referência a valores deíndice de elementos.

32 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 47: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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

Use as seguintes etapas para definir a ordem de elementos.

Procedimento1. Selecione um tipo de classificação.

Tipo Descrição

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

Manual Ordena elementos conforme eles existem naestrutura da dimensão e define apropriedade de classificação de dimensãocomo 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 ahierarquia da dimensão.

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 adimensão, você verá os elementos por ordem, de acordo com a opçãoClassificar por, especificada na etapa 3.

Resultados

Agora você tem a ordem dos elementos de dimensão. Quando abrir a dimensão,você verá os elementos por 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 um novo tipo da lista. Existem trêspossíveis tipos de elementos: simples,consolidado e de sequência.

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

Page 48: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Opções Descrição

Peso do Elemento Para alterar o peso do elemento atual, cliqueduas vezes no campo Peso do Elemento einsira um novo valor de peso.

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

Opções Descrição

Criar/Editar/Excluir Regras de Designaçãode Drill

Escolha estas opções para criar, editar ouexcluir designações de drill. A opção Criarabre o editor de regras para que sejapossível projetar a regra.

Criar/Editar Processo de Drill Um processo de drill é um processo doTurbo Integrator que define os dadosdetalhados, que são abertos em uma novajanela. Estas opções editam uma regra dedesignação de drill existente ou permitemcriar uma nova. As opções Criar exibem osparâmetros e valores a serem usados e osdetalhes para a origem de dados. Se vocêalterar a origem de dados para um processode drill, o Turbo Integrator não atualizará afunção com a nova origem de dados, porquea função está fora da área InstruçõesGeradas. Você deve editar a origem dedados de Visualização do Cubo na funçãoReturnViewHandle para o processo de drill.

Caixa de Diálogo Editar FórmulaA caixa de diálogo Editar Fórmula orienta-o na criação de funções DBR, DBRW eDBS. A caixa de diálogo Editar Fórmula também pode ser usada para editarqualquer função do TM1 em uma planilha.

Para exibir a caixa de diálogo Editar Fórmula, clique em uma célula na planilha eescolha TM1 , Editar Fórmula. Se a célula contiver uma função do TM1 , a funçãoserá exibida no campo de entrada da caixa de diálogo.

Campo Descrição

Ref. de BD Clique neste botão para inserir uma funçãoDBR na célula atual. O TM1 orienta-o emvárias caixas de diálogo que ajudam a criara função.

DBRW Clique neste botão para inserir uma funçãoDBRW na célula atual. O TM1 orienta-o emvárias caixas de diálogo que ajudam a criara função.

34 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 49: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Campo Descrição

Envio de BD Clique neste botão para inserir uma funçãoDBS na célula atual. O TM1 orienta-o emvárias caixas de diálogo que ajudam a criara função.

Ref. Célula Clique neste botão para inserir umareferência de célula em uma função. O TM1solicita que você selecione a célula à qualvocê deseja fazer referência e solicita umtipo de referência.

Nomes Clique neste botão para inserir um cubo,dimensão ou nome de elemento em umafunção

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

Caixa de Diálogo Editar Referência ao CuboEsta caixa de diálogo permite definir as referências de elemento usadas em funçõesda planilha do TM1 , tais como, DBRW e DBSW.

A caixa de diálogo contém botões e campos correspondentes a cada dimensão nocubo à qual a função da planilha do TM1 faz referência. Por exemplo, a imagem aseguir mostra a caixa de diálogo Editar Referência ao Cubo para uma funçãoDBRW que faz referência ao cubo SalesCube no banco de dados de amostra doTM1 . A caixa de diálogo inclui botões para todas as dimensões no cuboSalesCube.

Ao inserir uma função do TM1 em uma planilha, o TM1 tenta determinar seexistem referências de elemento relevantes na planilha. Neste caso, essasreferências são automaticamente inseridas nos campos apropriados na caixa dediálogo Editar Referência ao Cubo. Se as referências de elemento relevantes nãopuderem ser determinadas, o TM1 inserirá "Undef" nos campos.

É possível definir referências nesta caixa de diálogo:v clicando em um botão da dimensão e selecionando um elemento. Neste caso, a

referência é inserida como uma sequência no campo apropriado.v inserindo uma referência de célula diretamente em um campo. É possível usar

referências de célula relativas à linha, relativas à coluna ou absolutas.

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

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

Page 50: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Caixa de Diálogo Filtrar Elementos por AtributoUse esta caixa de diálogo para selecionar apenas os elementos de subconjunto quepossuem um valor de atributo 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 apenas elementos de um determinado nível, selecione o nível eclique em OK.

Para selecionar vários níveis adjacentes, clique e arraste nos níveis. Para selecionarvários níveis não adjacentes, CRTL-que em cada nível.

Caixa de Diálogo Filtrar SubconjuntoA caixa de diálogo Filtrar Subconjunto permite criar um subconjunto dinâmico combase em valores em um cubo especificado. Por exemplo, é possível criar umsubconjunto da dimensão Região que retorna os 10 elementos com os maioresvalores 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 filtrarvalores.

36 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 51: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Opção Descrição

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

Contagem dos Maiores

Filtra o subconjunto para retornarapenas os maiores n elementos, emque n é um número especificado naopção Valor.

Contagem dos Menores

Filtra o subconjunto para retornarapenas os menores n elementos, emque n é um número especificado naopção Valor.

Soma dos Maiores

Filtra o subconjunto para retornarapenas os maiores elementos cujasoma é maior ou igual a n, em quen é um número especificado naopção Valor.

Soma dos Menores

Filtra o subconjunto para retornarapenas os menores elementos cujasoma é maior ou igual a n, em quen é um número especificado naopção Valor.

Percentual dos Maiores

Filtra o subconjunto para retornarapenas os maiores elementos cujasoma é maior ou igual a n, em quen é uma porcentagem da dimensãototal especificada na opção Valor.

Percentual dos Menores

Filtra o subconjunto para retornarapenas os menores elementos cujasoma é maior ou igual a n, em quen é uma porcentagem da dimensãototal especificada na opção Valor.

Nenhum

Não aplicável à filtragem desubconjuntos.

Valor Um valor para o tipo de Filtro.

Selecionar Membro da Coluna O(s) elemento(s) da coluna no(s) qual(is) ofiltro ou classificação é aplicada. Clique nosbotões da dimensão para selecionar umúnico elemento para cada dimensão dacoluna.

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

Page 52: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Opção Descrição

Classificar A ordem de classificação que você desejaaplicar ao(s) elemento(s) da colunaselecionado(s).

Modo ascendente

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

Ordem decrescente

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

Nenhum

Nenhuma ordem de classificação.

Selecionar Membros da Coluna Você deve selecionar um único elemento decada dimensão do cubo restante. Porexemplo, se estiver filtrando a dimensãoRegião no banco de dados de amostra emrelação a valores no cubo Sales, você deveráespecificar um único elemento de cada umadas dimensões Modelo, Mês, ActVsBud eAccount1.

Para cada dimensão, clique no botãoapropriado e selecione um único elemento.

Se o cubo contiver mais de 16 dimensões,

clique em para voltar para a páginacom as 16 dimensões anteriores, ou clique

em para avançar para a página com as16 dimensões seguintes.

Caixa de Diálogo Filtrar VisualizaçãoA caixa de diálogo Filtrar Visualização permite filtrar e classificar colunas no CubeViewer 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 ouclassificar valores. Esta opção é sempredefinida para o cubo associado àvisualização atual. Ela não pode ser editada.

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

38 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 53: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Opção Filtro/Descrição

Contagem dos Maiores

Filtra a visualização para exibir apenas osmaiores n elementos, em que n é umnúmero especificado na opção Valor.

Contagem dos Menores

Filtra a visualização para exibir apenas osmenores n elementos, em que n é umnúmero especificado na opção Valor.

Soma dos Maiores

Filtra a visualização para exibir apenas osmaiores elementos cuja soma é maior ouigual a n, em que n é um númeroespecificado na opção Valor.

Soma dos Menores

Filtra a visualização para exibir apenas osmenores elementos cuja soma é maior ouigual a n, em que n é um númeroespecificado na opção Valor.

Percentual dos Maiores

Filtra a visualização para exibir apenas osmaiores elementos cuja soma é maior ouigual a n, em que n é uma porcentagem dadimensão total especificada na opção Valor.

Percentual dos Menores

Filtra a visualização para exibir apenas osmenores elementos cuja soma é maior ouigual a n, em que n é uma porcentagem dadimensão total especificada na opção Valor.

Nenhum

Nenhum filtro. Selecione esta opção sedesejar classificar 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) ofiltro ou classificação é aplicada. Clique nosbotões da dimensão para selecionar umúnico elemento para cada dimensão dacoluna.

Classificar A ordem de classificação que você desejaaplicar ao(s) elemento(s) da colunaselecionado(s).

Modo ascendente

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

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

Page 54: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Opção Filtro/Descrição

Ordem decrescente

Classifica valores para o(s) elemento(s) dacoluna especificado(s) do mais alto para omais 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 servidorlocal ou em qualquer servidor disponível na rede.

Campo Descrição

Servidor A lista Servidor exibe todos os servidoresdisponíveis em sua rede. Selecione oservidor no qual reside a visualização quevocê deseja abrir.

Se você não estiver com logon efetuado noservidor que contém a visualização quedeseja abrir, clique em Conectar para abrir acaixa de diálogo Conectar Servidor e efetuarlogon no servidor. Clique em IniciarServidor Local para iniciar o servidor local.

Cubo A lista Cubo exibe todos os cubosdisponíveis no servidor selecionado.Selecione o cubo associado à visualizaçãoque você deseja abrir.

Visualizar A lista Visualização exibe todas asvisualizações disponíveis no cuboselecionado. Selecione a visualização quevocê deseja abrir.

Menu do In-Spreadsheet BrowserO Menu do In-Spreadsheet Browser está disponível com um clique com o botãodireito do mouse no Controle de Visualização do TM1 . O menu permite abrir,atualizar, formatar, fatiar e salvar uma visualização. Ele também inclui váriasopções que controlam o comportamento do In-Spreadsheet Browser.

Item de Menu Descrição

AtualizarVisualização

Atualiza a visualização atual, enviando valores editados para o bancode dados 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ívelabrir uma visualização em qualquer servidor disponível.

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

40 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 55: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Item de Menu Descrição

Salvar Abre a caixa de diálogo Salvar Visualização, que permite salvar umavisualização do TM1 .

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

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

Recortar Recorta o Controle de Visualização do TM1 para a Área deTransferência.

Copiar Copia o Controle de Visualização do TM1 para a Área deTransferê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 docubo. Um visto indica que os zeros são suprimidos na visualizaçãoatual.

MostrarAutomaticamente

Esta alternância ativa ou desativa a atualização da visualizaçãoautomática durante a reconfiguração da visualização. Um visto indicaque a visualização é automaticamente atualizada sempre que aconfiguração de visualização é alterada.

AtualizarVisualização aoRecalcular

Esta alternância ativa ou desativa a atualização da visualizaçãoautomática durante o recálculo da planilha (F9). Um visto indica quea 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 atividadedo servidor. Essas mensagens são salvas no log de mensagens do servidor econtém detalhes sobre uma atividade, tais como processos, tarefas, cuboscarregados e dimensões e replicação sincronizada.

Para obter informações detalhadas sobre o log de mensagem do servidor, consulteo Guia de Operações do IBM Cognos TM1 .

Área de Janela Log de Mensagens

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

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

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

Page 56: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Para obter detalhes sobre os campos na área de janela Log de Mensagens, consulteo Guia de Operações do IBM Cognos TM1 .

Menu Arquivo

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 janelaLog de Mensagens para a Área deTransferência.

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

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çõescompleta do TM1 .

Caixa de Diálogo Novo Atributo

Campo Descrição

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

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

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

Alias Selecione esta opção se os valores deatributos forem nomes alternativos para osnomes atuais de elemento, dimensão, cuboou servidor.

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

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

42 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 57: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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

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

Assistente de Relatório de ImpressãoUse o Assistente de Relatório de Impressão para gerar relatórios de estilo "livro desínteses" a partir de fatias do TM1 .

O Assistente consiste em três telas.v Tela 1 - Selecionar as planilhas a serem incluídas no relatóriov 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 dapasta de trabalho

v 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 dorelatório.

Todas as Telas

Botão Descrição

Carregar Clique neste botão para carregar uma Tarefade Impressão existente do TM1 .

Salvar Clique neste botão para salvar asconfigurações do relatório atuais como umaTarefa de Impressão do TM1 .

Salvar como Clique neste botão para salvar asconfigurações do relatório atuais como umaTarefa de Impressão do TM1 com um novonome.

Próximo Clique neste botão para avançar para apróxima tela do Assistente.

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

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

Page 58: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Tela 1 de 3

Item Descrição

Incluir estas planilhas na lista de relatórios Lista as planilhas disponíveis na pasta detrabalho atual do Excel que podem serincluídas no relatório.

Para incluir uma planilha no relatório,selecione a caixa de seleção próxima aonome da planilha.

Selecionar Tudo Clique neste botão para incluir todas asplanilhas no relatório.

Limpar Tudo Clique neste botão para excluir todas asplanilhas do 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 nomedo subconjunto (se aplicável), o número deelementos na dimensão ou subconjunto e oendereço da célula da dimensão de título naplanilha.

Lista de Dimensões de Título Selecionadas Lista as dimensões de título a seremincluídas no relatório.

A ordem desta lista é usada quando o TM1gera o relató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 asdimensões da lista Dimensões de TítuloDisponíveis para a lista Dimensões de TítuloSelecionadas.

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

Remover Tudo Clique neste botão para mover todas asdimensões da lista Dimensões de TítuloSelecionadas para a lista Dimensões deTítulo Disponíveis.

44 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 59: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Item Descrição

Mover para Cima Clique neste botão para mover a dimensãoselecionada para cima na lista Dimensões deTítulo Selecionadas. A ordem nesta lista éusada quando o TM1 gera o relatório.

Mover para Baixo Clique neste botão para mover a dimensãoselecionada para baixo na lista Dimensõesde Título Selecionadas. A ordem nesta lista éusada quando o TM1 gera o relatório.

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õesde Título Selecionadas.

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

Cada planilha no relatório é impressa apenasuma vez, incluindo planilhas que nãocontêm dados de fatia do TM1 .

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

Esta opção cria um relatório com umnúmero maior de planilhas, porque éimpressa uma cópia de cada planilha paracada elemento do título.

Total de Pastas de Trabalho do Excel queserão geradas

Exibe o número total de planilhas do Excelque o TM1 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 orelatório como um arquivo do Excel.

Salvar Como Arquivos PDF Selecione esta opção se desejar gerar orelatório como um arquivo PDF.

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

Page 60: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Campo Descrição

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

Clique neste botão para visualizar o relatórioantes da impressão.

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

Use esta opção para especificar a impressorana qual o TM1 imprimirá o relatório.

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

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

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

Selecione esta opção para salvar o relatóriocomo um arquivo pronto para impressão.

Nome do Arquivo Esta opção fica disponível quando vocêseleciona as opções Imprimir na Impressorae Imprimir no Arquivo.

Insira um caminho completo e nome doarquivo no qual você deseja salvar orelatório. Você também deve especificar umtipo 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 a opção para imprimir ou salvar orelatório em um arquivo.

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

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

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

Gerar Nova Pasta de Trabalho para cadaTítulo

Esta opção fica disponível quando vocêescolhe salvar o relatório como um arquivodo Excel ou PDF.

Selecione esta opção se desejar criar umarquivo separado para cada dimensão detítulo no relatório.

46 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 61: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Campo Descrição

Nome de Diretório Esta opção está disponível ao salvar umrelatório como um arquivo do Excel ou PDFe quando você selecionar a opção GerarNova Pasta de Trabalho para cada Título.

Insira um diretório no qual salvar osarquivos de relatório. Para escolher um localdo diretório, clique no botão Navegar.

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

Selecione esta opção quando desejar salvar orelatório como um arquivo do Excel quecontém valores reais e não funções do TM1que recuperam valores.

Voltar Clique neste botão para voltar para a telaanterior do Assistente.

Concluir Clique neste botão para gerar o relatóriocom base nas opções selecionadas.

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

É possível usar um dos seguintes métodos para definir o texto para mensagens deconfirmação e de status que são exibidas quando o botão de Ação é clicado:v Insira o texto para uma mensagem diretamente na caixa de texto.v 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élulaA1, insira =A1 na caixa de texto para essa mensagem. Para fazer referência a umintervalo nomeado, use o formato: =Intervalo Nomeado.

Para obter informações sobre como usar o diálogo de Opções de Processamento,consulte o Guia para Desenvolvedores IBM Cognos TM1 .

Campo Descrição

Recalcular Planilha Automaticamente Selecione esta opção para que o TM1recalcule automaticamente a planilha após aexecução do processo.

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

Page 62: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Campo Descrição

Mostrar Mensagem de Êxito Selecione esta opção para exibir umamensagem após a execução bem-sucedida doprocesso.

Insira o texto da mensagem na caixaconforme descrito acima.

Mostrar Mensagem de Falha Selecione esta opção para exibir umamensagem se o processo não for executadocom êxito.

Insira o texto da mensagem na caixaconforme descrito acima.

Mostrar Caixa de Diálogo de Confirmação Selecione esta opção para exibir uma caixade mensagens de confirmação Sim/Nãoantes do início do processo. O usuário podeclicar em Sim para executar o processo, ouem Não para cancelar.

Insira o texto da mensagem na caixaconforme descrito acima.

OK Clique neste botão para salvar suasconfigurações e fechar a caixa de diálogo.

Cancelar Clique neste botão para fechar a caixa dediálogo sem salvar suas configurações.

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

Informações do Cubo

Item Descrição

Nome O nome do cubo espelhado no servidor dedestino.

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

Não altere o nome padrão se estiverreplicando regras nesse cubo.

Copiar Dados e Configurar paraSincronização

Selecione esta opção para copiar dadosquando a replicação for estabelecida e parasincronizar dados quando ocorrer asincronização entre os servidores de origeme de destino.

48 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 63: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Item Descrição

Copiar Dados mas não Definir paraSincronizar

Selecione esta opção para copiar dadosquando a replicação for estabelecida, maspara desativar posteriormente asincronizaçã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 docubo de origem para o cubo espelhado.

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

Limpe esta caixa para desativar asincronização da regra.

Não Copiar Regra Se você selecionar esta opção, o TM1 nãocopiará a regra do cubo de origem para ocubo espelhado.

Informações da Dimensão

Item Descrição

Caixa Informações de Dimensão Esta caixa exibe informações sobre asdimensões no cubo espelhado.

Se o cubo de origem não contiver regras, oTM1 renomeará as dimensões espelhadas,concatenando os nomes do servidor deorigem com os nomes da dimensão deorigem.

Se o cubo de origem contiver regras, o TM1não alterará os nomes da dimensão no cuboespelhado.

A caixa Informações de Dimensão tambémexibe o nome da dimensão de origem, doservidor de origem e o status de replicaçãopara cada dimensão no cubo.

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

Page 64: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Item Descrição

Selecionar Dimensão Local Para usar uma dimensão local no lugar deuma dimensão de origem, clique nadimensão de origem na caixa Informaçõesde Dimensão e clique em Selecionardimensão local. Selecione a dimensão localque deseja usar e clique em OK.

Reconfigurar a Seleção Atual para o Padrão Se você alterar quaisquer opções deInformações de Dimensão para umadimensão em um cubo replicado, poderárestaurar todas as opções para osvalores-padrão, selecionando a dimensão nacaixa Informações de Dimensão e clicandoneste botão.

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

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

Definir Dimensão a Ser Sincronizada Preencha esta caixa para sincronizarmudanças entre a dimensão de origem e aespelhada, quando ocorrer a sincronizaçãoentre os servidores de origem e de destino.

Limpe esta caixa para desativar asincronização da dimensão.

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

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

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

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

50 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 65: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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,para que seja possível selecionar um arquivode texto para importação. O texto importadosobrescreverá a regra atual, se existir uma.

Salvar Salva a regra atual no servidor.

Salvar como Salva a regra atual em um arquivo .rux deregra externo do TM1 .

Verificar Sintaxe Verifica erros de sintaxe na regra atual.

Imprimir Abre a caixa de diálogo Imprimir para queseja possível imprimir a regra atual.

Visualização de Impressão Abre a janela Visualização de Impressão, naqual é possível visualizar uma versãoimpressa de amostra da regra antes deenviá-la para uma impressora.

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 de transferência.

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

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

Selecionar Tudo Selecione todo o conteúdo do Editor deRegras.

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

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

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

Alternar Marcador Ativa ou desativa um marcador para a linhade código atual.

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

Page 66: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Nome Descrição

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

Marcador Anterior Move o cursor para o marcador anteriordisponível.

Limpar Todos os Marcadores Remove todos os marcadores.

Seleção de Comentário Inclui um símbolo de comentário # na frentede todas as linhas no texto selecionado nomomento para excluir as linhas da regracompilada.Nota: O comprimento do comentário élimitado a 255 bytes. Para conjuntos decaracteres ocidentais, como o inglês, umúnico caractere é representado por um únicobyte, permitindo inserir comentários com255 caracteres. No entanto, conjuntos decaracteres grandes, como chinês, japonês ecoreano, usam vários bytes para representarum caractere. Neste caso, o limite de 255bytes pode ser excedido mais rapidamente ede fato não permitir a entrada de 255caracteres.

Remover Comentários da Seleção Remove o símbolo de comentário # da frentede todas as linhas no texto selecionado nomomento para incluir as linhas na regra.

Indentação Indenta as linhas selecionadas no momento.

Retirar Indentação Remove a indentação das linhasselecionadas no momento.

Ir para Linha... Exibe a caixa de diálogo Ir para a Linha,para que seja possível inserir e ir para umnúmero da linha específico no Editor deRegras.

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 salvasquando você sair do Editor de Regras e serão automaticamente reaplicadas napróxima vez em que você abrir o Editor de Regras.

Nome Descrição

Quebra Automática de Linha Ativa/desativa o recurso de quebraautomática de linha, para que as linhas detexto sejam estendidas à direita ou sejamquebradas para exibição na área de janelaEditar.

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

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

52 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 67: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Nome Descrição

Autocompletar Ativa/desativa o recurso autocompletar aodigitar na área de janela Editar.

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

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

Objetos de Controle Ativa/desativa a exibição de objetos decontrole do TM1 ao selecionar cubos.

Expandir Todas as Regiões Expande todas as regiões definidas pelousuário na regra atual para mostrar todas aslinhas.

Recolher Todas as Regiões Reduz todas as regiões definidas pelousuário na regra atual para ocultar todas aslinhas que estão incluí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 parainserir uma nova função na regra atual.

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

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ível definir os atributos de fonte, comotipo de fonte, tamanho e cor a serem usadosna área de janela Editar.

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

Caixa de Diálogo Salvar Subconjunto

Campo Descrição

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

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

Page 68: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Campo Descrição

Particular Ative esta opção para salvar o subconjuntocomo um objeto particular. Desative estaopção para salvar o subconjunto como umobjeto público.

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

Salvar Expressão Se o subconjunto for dinâmico, ative estaopção para salvar a expressão MDX com osubconjunto.

Se o subconjunto for dinâmico e você nãoativar esta opção, a expressão MDX não serásalva e o subconjunto resultante seráestático, contendo os elementos presentesquando 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,ou selecione um nome da lista.

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

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

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

Campo Descrição

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

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

Padrão Ative esta opção para salvar a visualizaçãocomo uma 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 deacesso para cubos, dimensões, elementos individuais, processos e tarefas deorganização de processos. Os privilégios de acesso são designados por grupo deusuários.

54 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 69: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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

Quando você acessa a caixa de diálogo Designação de Segurança a partir de umgrupo Cubos, a grade inclui uma coluna Criação de Log. Esta coluna inclui umacaixa de seleção para cada cubo. Para ativar a criação de log para um cubo, ative acaixa de seleção na interseção do nome do cubo e a coluna Criação de Log. Paradesativar 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 umacélula selecionada na grade Designações:

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

Objeto Descrição

Cubo Os membros do grupo não podem ver ocubo no Server Explorer e, portanto, nãopodem navegar no cubo.

Elemento Os membros do grupo não podem ver oelemento no Editor de Subconjunto ou noEditor de Dimensão, e não podem visualizarcélulas identificadas pelo elemento aonavegar em um cubo.

Dimensão Os membros do grupo não podem ver adimensão no Server Explorer, e não podemnavegar em cubos que contêm a dimensão.

Processo Os membros do grupo não podem ver oprocesso no Server Explorer.Nota: Os privilégios designados a processossão ignorados quando um processo éexecutado a partir de uma tarefa deorganização de processos.

Tarefa de organização de processos Os membros do grupo não podem ver atarefa de organização de processos no ServerExplorer.

Aplicativo Os membros do grupo não podem ver oaplicativo ou seu conteúdo no ServerExplorer.

Referência Os membros do grupo não podem ver areferência no Server Explorer.

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

Page 70: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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

Objeto Descrição

Cubo Os membros do grupo podem visualizardados no cubo, mas não podem editar osdados.

Elemento Os membros do grupo podem visualizardados identificados pelo elemento, mas nãopodem editar os dados.

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

Processo Os membros do grupo podem ver oprocesso no Server Explorer e podemexecutá-lo, mas não podem editá-lo.Nota: Os privilégios designados a processossão ignorados quando um processo éexecutado a partir de uma tarefa deorganização de processos.

Tarefa de organização de processos Os membros do grupo podem ver a tarefade organização de processos no ServerExplorer e podem executá-la manualmente,mas não podem editá-la ou alterar o statusde ativação.

Aplicativo Os membros do grupo podem ver oaplicativo e usar as referências no aplicativo,para o qual você tem pelo menos oprivilégio Read. É possível criar referênciasparticulares no aplicativo, bem comosubaplicativos particulares

Referência Os membros do grupo podem abrir e usar areferência, mas não podem atualizá-la noaplicativo pai. No entanto, é possívelexecutar uma operação "salvar como" parasalvar uma nova versão particular dareferência em qualquer aplicativo para oqual você tem pelo menos privilégio Read.

Privilégio WriteA tabela a seguir descreve a capacidade de grupos de usuários do TM1 em acessarvários objetos do TM1 quando designado o privilégio de Gravação para um objeto.

56 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 71: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Objeto Descrição

Cubo Os membros do grupo podem visualizar eeditar dados do cubo, e podem criarvisualizações particulares do cubo.

O acesso de gravação não permite editardados identificados por elementosconsolidados ou derivados de regras. Pordefinição, os valores derivados porconsolidação ou por regras não podem sereditados.

Elemento Os membros do grupo podem visualizar eeditar dados identificados pelo elemento.

Dimensão Os membros do grupo podem editaratributos de elemento, editar formatos deelementos e criar subconjuntos particularespara a dimensão. Os membros do grupotambém podem editar atributos para aprópria dimensão.

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

Observe que, ao reservar um objeto, essa reserva expira quando o servidor quecontém o objeto for encerrado.

Objeto Descrição

Cubo Os membros do grupo podem visualizar eeditar dados no cubo, e podem reservar ocubo para impedir que outros clienteseditem dados do cubo. Você pode liberar umcubo reservado.

Elemento Os membros do grupo podem visualizar eeditar dados identificados pelo elemento epodem reservar o elemento para impedirque outros usuários editem dados. Vocêpode liberar um elemento reservado.

Dimensão Os membros do grupo podem incluir,remover e reordenar elementos na dimensãoe podem reservar a dimensão para impedirque outros usuários editem a estrutura dadimensão. Você pode liberar uma dimensãoreservada.

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

Capítulo 2. Windows e Caixas de Diálogo 57

Page 72: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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

Objeto Descrição

Cubo Os membros do grupo podem visualizar eeditar dados no cubo e podem bloquear ocubo.

Quando um cubo está bloqueado, ninguémpode atualizar seus dados.

Elemento Os membros do grupo podem visualizar eeditar dados identificados pelo elemento epodem bloquear o elemento.

Quando um elemento está bloqueado,ninguém pode atualizar dados identificadospelo elemento.

Dimensão Os membros do grupo podem incluir,remover e reordenar elementos na dimensãoe podem bloquear a dimensão para impedirque outros usuários editem a estrutura dadimensão.

Quando uma dimensão está bloqueada,ninguém pode editar a estrutura dadimensão.

Privilégio AdminA tabela a seguir descreve a capacidade de grupos de usuários do TM1 em acessarvários objetos do TM1 quando designado o privilégio Admin para um objeto.

Objeto Descrição

Cubo Os membros do grupo podem ler, gravar,reservar, liberar, bloquear, desbloquear eexcluir o cubo. Eles também podemconceder a outros usuários privilégios deacesso para este cubo.

Elemento Os membros do grupo podem visualizar,atualizar e excluir células identificadas peloelemento. Eles podem reservar, liberar,bloquear e desbloquear o elemento. Elestambém podem conceder a outros usuáriosprivilégios de acesso para este elemento.

Dimensão Os membros do grupo podem incluir,remover e reordenar elementos na dimensão.Eles podem reservar, liberar, bloquear edesbloquear a dimensão. Eles tambémpodem criar subconjuntos públicos para adimensão e conceder a outros usuáriosprivilégios de acesso para a dimensão.

58 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 73: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Objeto Descrição

Aplicativo Os membros do grupo podem ver oaplicativo, usar referências no aplicativo ecriar referências públicas e particulares noaplicativo. Eles também podem criarsubaplicativos públicos e particulares.

Quando um grupo tiver privilégio Adminpara um aplicativo, os membros do grupopoderão definir privilégios de segurançapara todas as referências e subaplicativos noaplicativo para outros grupos, mas não paraseu próprio grupo.

Referência Os membros do grupo podem usar areferência, bem como atualizar ou excluir areferência. Eles podem publicar referênciasparticulares e privatizar referências públicas.

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

Depois de designar privilégios de acesso para uma dimensão, clique em Salvar, emseguida, selecione uma nova dimensão da lista Selecionar Dimensão. Ao concluir adesignação de privilégios para todas as dimensões desejadas, clique em OK paradescartar 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 cliqueem 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 eclique em OK.

Caixa de Diálogo Selecionar Planilha de DimensõesSelecione a planilha de dimensões que deseja abrir e clique em OK.

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

Capítulo 2. Windows e Caixas de Diálogo 59

Page 74: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Caixa de Diálogo Selecionar Planilha de RegrasSelecione a planilha de regras que deseja abrir e clique em OK.

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 quaisvocê está conectado.

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

Exibe as propriedades do objeto selecionado na área de janela esquerda do ServerExplorer. As propriedades 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êsalve mudanças nos dados. Esta opção ficadisponível apenas quando o servidor localestá em execução.

Iniciar servidor local Inicia o servidor local. Esta opção ficadisponível apenas quando o servidor localnão está em execução.

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

Sair Fecha o Server Explorer e quaisquer outrasjanelas associadas ao TM1 Perspectives/TM1Architect.

Menu DinâmicoAs opções disponíveis no segundo menu no Server Explorer variam de acordo como tipo de objeto selecionado no momento.

Grupo de ServidoresAs seguintes opções estão disponíveis a partir do menu do TM1 , ao selecionar oGrupo de servidores no Server Explorer.

Opção Descrição

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

60 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 75: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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

Opção Descrição

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

Reciclar (Limpar memória para ServidorLocal)

Encerra e reinicia o servidor local. Aoescolher esta opção, você tem a possibilidadede reciclar e salvar dados no servidor local,ou de reciclar e abandonar mudanças noservidor local.

Encerrar Encerra o servidor local. Esta opção ficadisponível apenas quando o servidor localestá selecionado.

Segurança, Clientes/Grupos Abre o Editor de Clientes/Grupos para oservidor selecionado. Você deve terprivilégios Admin para o servidor paraacessar o Editor de Clientes/Grupos.

Segurança, Alterar Senha Abre a caixa de diálogo Mudança de Senha,a partir da qual é possível alterar sua senhano servidor selecionado.

Segurança, Atualizar Segurança Atualiza todas as estruturas/designações desegurança no servidor selecionado.

Capítulo 2. Windows e Caixas de Diálogo 61

Page 76: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Opção Descrição

Designações de Recursos Permite que o administrador definapermissões para recursos específicos porgrupo de usuários. Na interseção do grupode usuários e o recurso, os administradorespodem definir Conceder ou Negar (igual aem branco) para ativar ou desativar esserecurso. Algumas configurações de recursospodem ser ignoradas, dependendo dasdefinições de configuração feitas no servidor.

Os seguintes recursos podem ser definidospor grupo de usuários:

v Bloquear Acesso ao Server Explorer

Para impedir que o Server Explorer sejaativado, clique na interseção deste recursoe o grupo de usuários e selecioneConceder. Em Branco ou Negar significaque o Server Explorer é usado por estegrupo de usuários.

v Modo de Writeback de Área de TrabalhoPessoal

Para permitir que um grupo de usuáriosuse Áreas de Trabalho Pessoais, clique nainterseção do grupo de usuários e esterecurso e selecione Conceder. Em Brancoou Negar significa que este grupo deusuários não usa Áreas de TrabalhoPessoais.

Se DisableSandboxing for definido comoT, esta designação de recurso seráignorada.

v Ambiente de Simulação

Para permitir que um grupo de usuáriosuse Ambientes de Simulações para criarvários cenários what-if, clique nainterseção do grupo de usuários e esterecurso e selecione Conceder. Em Brancoou Negar significa que este grupo deusuários não pode usar vários Ambientesde Simulações.

Se DisableSandboxing for definido comoT, esta designação de recurso seráignorada.

Consulte os Guias de Operação e do Usuáriodo IBM CognosTM1 para obter maisinformações.

Visualizar Log de Transação Abre a caixa de diálogo Consulta do Log deTransações, a partir da qual é possívelvisualizar um log de transações no servidorselecionado.

62 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 77: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Opção Descrição

Visualizar Log de Mensagens Abre a caixa de diálogo Log de Mensagens,que exibe mensagens registradas no servidorselecionado.

Iniciar Monitor de Desempenho Inicia o monitoramento de desempenho.Quando o Monitor de Desempenho estiverem execução, o TM1 preencherá várioscubos de controle que permitem controlarestatísticas para cubos, clientes e servidor.

Parar Monitor de Desempenho Para o monitoramento de desempenho.

Atualizações Adiadas, Iniciar Atualizaçõesde Lote

Inicia as atualizações de lote a seremenviadas para o servidor selecionado.

Atualizações Adiadas, Encerrar Atualizaçõesde Lote

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 encerraro servidor selecionado, desconectar clientes etransmitir mensagens.

Cancelar Encerramento Cancela um encerramento do servidorexecutado anteriormente.

Desconectar Item Desconecta seu cliente do servidorselecionado.

Quem Sou Eu Retorna uma mensagem indicando seu nomede usuário no servidor.

AplicativosAs opções a seguir ficam disponíveis no Menu Aplicativos quando você selecionao grupo de Aplicativos ou um aplicativo individual no Server Explorer.

Opção Descrição

Abrir Expande o aplicativo selecionado ou o grupode Aplicativos para revelar referências esubaplicativos.

Fechar Reduz o aplicativo selecionado ou o grupode Aplicativos para ocultar referências esubaplicativos.

Excluir Exclui o aplicativo selecionado. Ao excluirum aplicativo, todos os subaplicativos ereferências no aplicativo sãoautomaticamente excluídos. Esta opção nãofica disponível quando o grupo deAplicativos está selecionado.

Capítulo 2. Windows e Caixas de Diálogo 63

Page 78: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Opção Descrição

Renomear Define o nome do aplicativo selecionado emmodo de edição, para que seja possíveldigitar um novo nome para o aplicativo.Esta opção não fica disponível quando ogrupo de Aplicativos está selecionado.

Segurança, Designações de Segurança Abre a janela Designações de Segurança doTM1 , a partir da qual é possível designarprivilégios de segurança para as referênciase subaplicativos imediatos contidos noaplicativo ou grupo de Aplicativosselecionado.

Segurança, Tornar Público Escolha esta opção para publicar umaplicativo particular. Ao publicar umaplicativo, todos os subaplicativos ereferências particulares a objetos públicos noaplicativo também são publicadosautomaticamente. Esta opção não ficadisponível quando o grupo de Aplicativosestá selecionado.

Segurança, Tornar Particular Escolha esta opção para privatizar umaplicativo público. Ao privatizar umaplicativo, todos os subaplicativos ereferências públicas no aplicativo tambémsão automaticamente privatizados. Estaopção não fica disponível quando o grupode Aplicativos está selecionado.

CubosAs opções a seguir ficam disponíveis no Menu Cubos quando você seleciona umgrupo de cubos no Server Explorer.

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 deSegurança do TM1 para os cubos no grupode cubos selecionado. Você deve ser membrodo grupo Admin no servidor que contém ogrupo de cubos para acessar esta caixa dediálogo.

CuboAs opções a seguir ficam disponíveis no Menu Cubo quando você seleciona umcubo no Server Explorer.

64 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 79: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Opção Descrição

Navegar Abre o cubo para navegação na janela doCube Viewer.

Navegar no Excel Abre o cubo para navegação noIn-Spreadsheet Browser.

Escolher Copia o nome do cubo para a Área deTransferência.

Criar Novo Cubo Abre a caixa de diálogo Criando Cubo.

Descarregar Cubo Descarrega o cubo selecionado da memóriado servidor.

Excluir Cubo Exclui o cubo selecionado e todos os dadosassociados. Você deve ter privilégios Adminpara excluir um cubo

Reordenar Dimensões Abre a janela do Cube Optimizer, a partir daqual é possível otimizar a ordem dedimensões no cubo selecionado.

Criar Regra Abre o Editor de Regras, a partir do qual épossível criar uma regra para o cuboselecionado.

Excluir Regra Exclui a regra associada ao cuboselecionado. Você deve ter privilégios Adminpara um cubo para excluir a regra associada.

Exportar como Dados ASCII Exporta os dados contidos no cuboselecionado para um arquivo ASCIIdelimitado por vírgula (.cma).

Sincronizar Dados Sincroniza os dados no cubo selecionadocom dados do servidor de replicaçãoassociado.

Segurança, Reserve Reserva temporariamente o cubo selecionadopara que outros clientes não possam editardados no cubo. Você deve ter privilégiosReserve para reservar um cubo.

Segurança, Release Libera um cubo reservado para que outrosclientes possam editar dados no cubo. Vocêdeve ter privilégios Reserve para liberar umcubo.

Segurança, Lock Bloqueia permanentemente o cuboselecionado para que outros clientes nãopossam editar dados no cubo. O cliente aoqual está conectado também é bloqueadodesses elementos. Você deve ter privilégiosLock para bloquear um cubo.

Capítulo 2. Windows e Caixas de Diálogo 65

Page 80: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Opção Descrição

Segurança, Unlock Desbloqueia o cubo selecionado para queoutros clientes possam editar dados. Vocêdeve ter privilégios Admin para desbloquearum cubo.

Propriedades Abre a caixa de diálogo Propriedades doCubo, a partir da qual é possível definirdimensões de medida e de tempo.

DimensõesAs opções a seguir ficam disponíveis no Menu Dimensões quando você selecionaum grupo de dimensões no Server Explorer.

Opção Descrição

Criar Nova Dimensão Abre a janela do Editor de Dimensão, apartir da qual é possível criar uma novadimensão.

Editar Atributos Abre a janela do Editor de Atributos, apartir da qual é possível designar e editaratributos para todas as dimensões no gruposelecionado.

Designações de Segurança Abre a caixa de diálogo Designações deSegurança do TM1 , a partir da qual épossível designar privilégios de segurançapara cada dimensão no grupo. Você deve sermembro do grupo Admin para usar estaopção.

DimensãoAs opções a seguir ficam disponíveis no Menu Dimensão quando você selecionauma dimensão no Server Explorer.

Opção Descrição

Inserir Novo Subconjunto Abre a janela do Editor de Subconjunto paraa dimensã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 najanela do Editor de Dimensão. Você deve terprivilégios Write para a dimensãoselecionada para usar esta opção.

66 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 81: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Opção Descrição

Criar Nova Dimensão Abre uma janela vazia do Editor deDimensão, a partir da qual é possível criaruma nova dimensão. Você deve ser membrodo grupo Admin para criar uma novadimensã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ê deveser membro do grupo Admin para excluiruma dimensão.

Definir Ordem de Elementos Abre a caixa de diálogo Ordenação deElementos de Dimensão, a partir da qual épossível definir a ordem de elementos nadimensão selecionada.

Editar Atributos de Elemento Abre a janela do Editor de Atributos, apartir da qual é possível designar e editaratributos para todos os elementos nadimensão selecionada.

Sincronizar Dados Sincroniza os dados na dimensãoselecionada com dados associados dequaisquer servidores replicados.

Segurança, Reserve Reserva temporariamente a dimensãoselecionada para que outros clientes nãopossam editar a estrutura da dimensão. Vocêdeve ter privilégios Reserve para reservaruma dimensão. Observe que esta opçãoreserva apenas a estrutura da dimensão. Elanão reserva nenhum dos dados identificadospor elementos na dimensão selecionada.

Segurança, Release Libera uma dimensão reservada para queoutros clientes possam editar a estrutura dadimensão. Você deve ter privilégios Reservepara liberar uma dimensão. Observe queesta opção libera apenas a estrutura dadimensão. Ela não libera nenhum dos dadosidentificados por elementos na dimensãoselecionada.

Segurança, Lock Bloqueia permanentemente a dimensãoselecionada para que outros clientes nãopossam editar a estrutura da dimensão. Vocêdeve ter privilégios Lock para bloquear umadimensão. Observe que esta opção bloqueiaapenas a estrutura da dimensão. Ela nãobloqueia nenhum dos dados identificadospor elementos na dimensão selecionada.

Capítulo 2. Windows e Caixas de Diálogo 67

Page 82: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Opção Descrição

Segurança, Unlock Desbloqueia a dimensão selecionada paraque outros clientes possam editar a estruturada dimensão. Você deve ter privilégiosAdmin para desbloquear uma dimensão.Observe que esta opção desbloqueia apenasa estrutura da dimensão. Ela nãodesbloqueia nenhum dos dados identificadospor elementos na dimensão selecionada.

Segurança, Designações de Segurança deElementos

Abre a caixa de diálogo Designações deSegurança do TM1 , a partir da qual épossível designar privilégios de segurançapara cada elemento na dimensão. Você deveter privilégios Write para a dimensãoselecionada 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 de visualizações no Server Explorer.

Opção Descrição

Criar Nova Visualização Abre a janela do Cube Viewer, a partir daqual é possível configurar uma novavisualização.

CubeViewAs opções a seguir ficam disponíveis no Menu Visualização do Cubo quando vocêseleciona uma visualização no Server Explorer.

Opção Descrição

Navegar Abre a visualização na janela do CubeViewer.

Navegar no Excel Abre a visualização no In-SpreadsheetBrowser.

Exportar como Dados de Texto Abre a janela Extração de Visualização, apartir da qual é possível exportar avisualização como um arquivo delimitadopor vírgula (.cma).

Publicar Esta opção fica disponível quando vocêseleciona uma visualização particular.Escolha esta opção para converter umavisualização de particular em pública. Asvisualizações públicas estão disponíveis paratodos os clientes com privilégios Read parao cubo que contém a visualização.

Excluir Visualização Exclui a visualização selecionada. Observeque esta opção exclui apenas a configuraçãode visualização, e não os dados contidos navisualização.

68 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 83: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SubconjuntosAs opções a seguir ficam disponíveis no Menu Subconjuntos quando vocêseleciona um grupo de subconjuntos no Server Explorer.

Opção Descrição

Inserir Novo Subconjunto Abre a janela do Editor de Subconjunto, apartir da qual é possível definir um novosubconjunto.

SubconjuntoAs opções a seguir ficam disponíveis no Menu Subconjunto quando você selecionaum subconjunto no Server Explorer.

Opção Descrição

Abrir Abre o subconjunto selecionado na janela doEditor de Subconjunto.

Criar Novo Subconjunto Abre a janela do Editor de Subconjunto paraa dimensão à qual o subconjuntoselecionado pertence. É possível definir umnovo subconjunto nesta janela

Publicar Esta opção fica disponível quando vocêseleciona um subconjunto particular. Escolhaesta opção para converter um subconjuntode particular em público. Os subconjuntospúblicos estão disponíveis para todos osclientes com privilégios Read para adimensão que contém o subconjunto.

Excluir Subconjunto Exclui o subconjunto selecionado. Observeque esta opção exclui apenas a configuraçãodo subconjunto, e não exclui os elementoscontidos no subconjunto da dimensão-pai.

ReplicaçõesAs opções a seguir ficam disponíveis no Menu Replicações quando você selecionaum grupo de replicações no Server Explorer.

Opção Descrição

Inserir Nova Replicação Abre a caixa de diálogo Criar Objeto deReplicação do Servidor, a partir da qual épossível estabelecer uma nova conexão dereplicação.

ReplicaçãoAs opções a seguir ficam disponíveis no Menu Replicação quando você selecionauma replicação no Server Explorer.

Opção Descrição

Sincronizar Dados Sincroniza dados entre os servidores dedestino e de origem.

Capítulo 2. Windows e Caixas de Diálogo 69

Page 84: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Opção Descrição

Modificar Parâmetros de Replicação Abre a caixa de diálogo Criar Objeto deReplicação do Servidor, a partir da qual épossível modificar os parâmetros para aconexão de replicação selecionada.

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 Tarefasde Organização de Processos paraModificação. Esta caixa de diálogo pode serusada para remover a replicação selecionadade quaisquer tarefas de organização deprocessos associadas.

Cubo ReplicadoAs opções a seguir ficam disponíveis no Menu Cubo quando você seleciona umcubo replicado no Server Explorer.

Opção Descrição

Replicar Abre a caixa de diálogo Replicar Cubo parao cubo selecionado, a partir da qual épossível definir parâmetros de replicação ereplicar 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ê selecionaum grupo de processos no Server Explorer.

Opção Descrição

Criar Novo Processo Abre o Turbo Integrator, a partir do qual épossível criar um novo processo.

Designações de Segurança Abre a caixa de diálogo Designações deSegurança do TM1 , a partir da qual épossível definir privilégios de segurançapara processos no servidor atual.

ProcessoAs opções a seguir ficam disponíveis no menu Processo quando você seleciona umprocesso no Server Explorer.

70 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 85: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Opção Descrição

Exibir Tarefas de Organização de ProcessosEnvolvidas

Abre a caixa de diálogo Selecionar Tarefasde Organização de Processos paraModificação. Esta caixa de diálogo pode serusada para remover o processo selecionadode quaisquer tarefas de organização deprocessos associadas.

Editar Processo Abre o processo selecionado em uma janelado Turbo Integrator.

Executar Processo Executa o processo selecionado.

Visualizar Visualiza um processo em modo somenteleitura. Permite que os membros dos gruposDataAdmin e SecurityAdmin visualizem umprocesso em modo somente leitura quando aopção Acesso de Segurança é ativada para oprocesso.

Acesso de Segurança Controla se um processo pode modificardados de segurança no script do processo.Apenas os membros dos grupos ADMIN eSecurityAdmin podem definir esta opção.Defina esta opção em uma base processo aprocesso.

Para obter detalhes, consulte a seção sobreprocessos de segurança no Guia doDesenvolvedor do IBM Cognos TM1 .

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 vezde dados base, ao executar o processo. Oambiente de simulação ativo é determinadopor qual ambiente de simulação estáselecionado no Cube Viewer.

Tarefas de organização de processosAs opções a seguir ficam disponíveis no Menu Tarefas de Organização deProcessos quando você seleciona um grupo de tarefas de organização de processosno Server Explorer.

Opção Descrição

Criar Nova Tarefa de Organização deProcessos

Abre o Assistente de Configuração de Tarefade Organização de Processos, a partir doqual é possível planejar uma nova tarefa deorganização de processos.

Capítulo 2. Windows e Caixas de Diálogo 71

Page 86: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Opção Descrição

Designações de Segurança Abre a caixa de diálogo Designações deSegurança do TM1 , a partir da qual épossível definir privilégios de segurançapara tarefas de organização de processos noservidor atual.

Tarefa de organização de processosAs opções a seguir ficam disponíveis no menu Tarefa de Organização de Processosquando você seleciona uma tarefa de organização de processos individual noServer Explorer.

Opção Descrição

Ativar Programação Esta opção alterna o status de execução detarefas de organização de processos.Selecione esta opção para ativar a tarefa deorganização de processos selecionada paraexecução. É exibido um visto próximo a estaopção quando uma tarefa de organização deprocessos é ativada.

Selecione esta opção novamente paradesativar a tarefa de organização deprocessos selecionada.

Editar Abre a tarefa de organização de processospara edição no Assistente de Configuraçãode Tarefa de Organização de Processos.

Você deve desativar uma tarefa deorganização de processos 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 deorganização de processos 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Área de Transferência.

Excluir Exclui o objeto selecionado do servidor.

72 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 87: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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

Opção Descrição

Barra de Status Oculta ou exibe a barra de status na parteinferior da janela do Server Explorer. Umvisto indica que a barra de status é exibida.

Barra de Ferramentas Oculta ou exibe a barra de ferramentas naparte superior da janela do Server Explorer.Um visto indica que a barra de ferramentasé exibida.

Janela Propriedades Oculta ou exibe a área de janelaPropriedades do Server Explorer. Um vistoindica que a área de janela Propriedades éexibida.

Objetos:

Aplicativos

Cubos

Dimensões

Replicações

Processos

Tarefas de organização de processos

Oculta ou exibe qualquer um dos objetos naárea de janela esquerda (área de janela emÁrvore) do Server Explorer.

Um visto indica que o objeto selecionado éexibido.

Reduzir Todos os Filhos Reduz a árvore na área de janela esquerdado Server Explorer para ocultar todos osfilhos de um objeto selecionado.

Expandir Todos os Filhos Expande a árvore na área de janela esquerdado Server Explorer para mostrar todos osfilhos de um objeto selecionado.

Exibir Objetos de Controle Oculta ou exibe os cubos de controle edimensões na área de janela esquerda dajanela do Server Explorer. Um visto indicaque os objetos de controle são exibidos.

Atualizar Atualiza a exibição hierárquica atual deobjetos na área de janela esquerda do ServerExplorer.

Editor de Subconjunto

Área de Janela Elementos

Exibe uma representação hierárquica de todos os elementos no subconjunto quevocê está visualizando.

Área de Janela Propriedades

Exibe as propriedades dos elementos selecionados na área de janela Elementos doEditor de Subconjunto. Quando você seleciona um elemento consolidado, esta áreade janela exibe os nomes, tipos e pesos de todos os filhos do elemento consolidado.

Capítulo 2. Windows e Caixas de Diálogo 73

Page 88: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Nota: Ao visualizar um conjunto de dimensões excepcionalmente grande no Editorde Subconjunto com a área de janela Propriedades ativada, você talvez tenhaproblemas de desempenho. Isto pode acontecer quando você seleciona umaconsolidação na área de janela Elementos e o TM1 precisa exibir toda a lista deelementos e propriedades relacionados na área de janela Propriedades.

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

Menu Subconjunto

Item de Menu Descrição

Abrir Abre a caixa de diálogo Salvar Subconjuntodo TM1 . Selecione um subconjunto da listae clique em 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 comum novo 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 de Transferência.

Copiar Copia os elementos selecionados para a Áreade Transferência.

Copiar Nome Exclusivo Copia o nome de elemento, como umaexpressão MDX, para a Área deTransferência. O nome de elemento copiadopode então ser colado na Janela deExpressão do Editor de Subconjunto.

Colar Cola o conteúdo da Área de Transferênciano ponto de inserção atual.

Colar Acima Cola o conteúdo da Área de Transferênciaacima do elemento selecionado no momento.

74 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 89: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Item de Menu Descrição

Colar Abaixo Cola o conteúdo da Área de Transferênciaabaixo do elemento selecionado nomomento.

Inserir Subconjunto Abre uma nova instância do Editor deSubconjunto para que seja possível incluiruma consolidação definida pelo usuário nosubconjunto atual.

Manter Mantém apenas os elementos selecionadosno momento na área de janela Elementos doEditor de Subconjunto e remove os demaiselementos.

Excluir Remove os elementos selecionados dadefinição de subconjunto atual.

Selecionar Elementos, Horizontal Copia os elementos selecionados para a Áreade Transferência em uma orientaçãohorizontal, para que eles possam ser coladosem uma linha da planilha.

Selecionar Elementos, Vertical Copia os elementos selecionados para a Áreade Transferência em uma orientação vertical,para que eles possam ser colados em umacoluna da planilha.

Classificar, Decrescente Classifica todos os elementos na área dejanela Elementos em ordem alfabéticadecrescente.

Classificar, Crescente Classifica todos os elementos na área dejanela Elementos em ordem alfabéticacrescente.

Classificar, Hierarquia Classifica todos os elementos na área dejanela Elementos em ordem hierárquica,portanto, é possível ver o relacionamentopai/filho de elementos.

Classificar, Índice Crescente Classifica todos os elementos na área dejanela Elementos em ordem crescente, deacordo com o valor de índice de elemento.

Classificar, Índice Decrescente Classifica todos os elementos na área dejanela Elementos em ordem decrescente, deacordo com o valor de índice de elemento.

Fazer Drill Down Exibe os filhos imediatos de elementosselecionados.

Sintetização Exibe os pais imediatos de elementosselecionados.

Capítulo 2. Windows e Caixas de Diálogo 75

Page 90: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Item de Menu Descrição

Expandir Elemento Exibe todos os filhos de elementosselecionados.

Reduzir Elemento Reduz as consolidações selecionadas paraque os filhos não sejam exibidos.

Filtrar por, Níveis Abre a caixa de diálogo Filtrar por Nível, apartir da qual é possível selecionarelementos por nível de hierarquia.

Filtrar por, Atributo Abre a caixa de diálogo Filtrar por Atributo,a partir da qual é possível selecionarelementos por valor de atributo.

Filtrar por, Extração de Visualização Permite selecionar apenas os elementos queatendem a uma consulta definida pelousuário.

Esta opção fica disponível apenas quandovocê abre o Editor de Subconjunto, clicandoem um rótulo da dimensão na janela doCube Viewer.

Filtrar por, Curinga Permite selecionar elementos quecorrespondem a uma sequência de procuradefinida pelo usuário.

Selecionar Alias Abre a caixa de diálogo Aliases do TM1 , apartir da qual é possível selecionar um aliasdefinido anteriormente, pelo qual exibirnomes de elementos.

Segurança, Reserve Reserva temporariamente o elementoselecionado para que outros clientes nãopossam editar dados identificados peloelemento. Você deve ter privilégios Reservepara reservar um elemento.

Segurança, Release Libera um elemento reservado para queoutros clientes possam editar dadosidentificados pelo elemento. Você deve terprivilégios Reserve para liberar umelemento.

Segurança, Lock Bloqueia permanentemente o elementoselecionado para que outros clientes nãopossam editar dados identificados peloelemento. Você deve ter privilégios Lockpara bloquear um elemento.

Segurança, Unlock Desbloqueia o elemento selecionado paraque outros clientes possam editar dadosidentificados pelo elemento. Você deve terprivilégios Admin para desbloquear umadimensão.

76 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 91: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Item de Menu Descrição

Editar Formatos do Elemento Abre a planilha Editar Formatos deElemento, na qual é possível definir estilosde exibição para fatias dinâmicas e planilhasda web do TM1 .

Menu Visualizar

Item de Menu Descrição

Barras de Ferramentas Abre um submenu que permite ativar oudesativar a exibição de todas as barras deferramentas do Editor de Subconjunto.

Um visto indica que uma barra deferramentas é exibida.

Barra de Status Oculta ou exibe a Barra de Status na parteinferior da janela do Editor de Subconjunto.

Um visto indica que a Barra de Status éexibida.

Janela Propriedades Oculta ou exibe a área de janelaPropriedades.

Um visto indica que a área de janelaPropriedades é exibida.

Janela de Expressão Oculta ou exibe a Janela de Expressão naparte inferior do Editor de Subconjunto. Umvisto indica que a Janela de Expressão éexibida.

Capítulo 2. Windows e Caixas de Diálogo 77

Page 92: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Item de Menu Descrição

Expandir Acima Esta opção determina como as consolidaçõessão expandidas e reduzidas ao fazer drilldown.

Quando esta opção for ativada, os filhos deuma consolidação serão expandidos acimada consolidação ao fazer drill down.

Quando esta opção for desativada, os filhosde uma consolidação serão expandidosabaixo da consolidação ao fazer drill down.

Quando a opção Expandir Acima for ativadaem um subconjunto, fazer drill down emuma consolidação no Cube Viewer, noIn-Spreadsheet Browser ou na fatia resultaráno seguinte comportamento:

Se a opção for ativada em um subconjuntode linhas, fazer drill down em umaconsolidação exibirá os filhos acima daconsolidação.

Se a opção for ativada em um subconjuntode colunas, fazer drill down em umaconsolidação exibirá os filhos à esquerda daconsolidação.

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

Menu Ferramentas

Item de Menu Descrição

Registrar Expressão Inicia o registro de ações no Editor deSubconjunto.

Parar Registro Para o registro de suas ações no Editor deSubconjunto.

Quando você para o registro, o TM1 gerauma expressão MDX que pode ser salvapara criar um subconjunto dinâmico.

Limpar Expressão Limpa o conteúdo da Janela de Expressão.

Filtrar Abre a caixa de diálogo Filtrar Subconjunto,que permite criar um subconjunto dinâmicocom base em valores do cubo.

78 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 93: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Caixa de Diálogo de AliasPara visualizar os elementos de subconjunto atuais por aliases designados,selecione um nome alternativo da lista e clique em OK.

Caixa de Diálogo de Opções do TM1As opções a seguir podem ser definidas 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 ServidorAdministrativo é executado.

Login Integrado Ative esta opção para usar o LoginIntegrado.

Desative esta opção para usar a segurançade login 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óriode Dados do Servidor Local, ou clique nobotão Navegar associado para navegar parao diretório. Também é possível clicar na setapara baixo para selecionar de uma lista dediretórios acessados recentemente.

Conectar ao Servidor Local ao Inicializar Altere essa opção para desligado para iniciaro TM1 Perspectives/TM1 Architect semativar o servidor local.

O padrão é ativado.

Nota: O servidor local é suportado apenas em versões de 32 bits do TM1. Odiretório de dados padrão para o servidor local é Pdata. Se você estiver executandouma versão de 64 bits do TM1, o servidor de amostra Sdata, que é instalado porpadrão com o servidor TM1, conterá os mesmos objetos e dados que os localizadosno Pdata.

Capítulo 2. Windows e Caixas de Diálogo 79

Page 94: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Secure Socket Layer do Servidor Administrativo

Opção Descrição

Autoridade de Certificação O caminho completo do arquivo daautoridade de certificação que emitiu ocertificado do Servidor Administrativo.

Lista de Revogação de Certificado O caminho completo do arquivo derevogação do certificado emitido pelaautoridade de certificação que originalmenteemitiu o certificado do ServidorAdministrativo. Um arquivo de revogaçãode certificado existirá apenas no caso de umcertificado ter sido revogado.

ID do Certificado O nome do principal para o qual ocertificado do Servidor Administrativo éemitido.

Usar Repositório de Certificados Selecione essa opção se deseja que ocertificado de autorização de certificação queemitiu originalmente o certificado doservidor administrativo seja exportado doarmazenamento de certificados do Windowsno tempo de execução.

Quando esta opção estiver selecionada, vocêtambém deverá configurar um valor para oID do Certificado de Exportação na caixa dediálogo Opções do TM1 .

Exportar ID do Certificado A chave de identidade usada para exportaro certificado de autorização de certificação,que originalmente emitiu o certificado doServidor Administrativo, a partir doarmazenamento de certificados.

Este parâmetro será necessário apenas sevocê ativar a opção Usar Armazenamento deCertificados.

Caixa de Diálogo Consulta do Log de TransaçõesA caixa de diálogo Consulta do Log de Transações permite consultar e visualizarregistros no log de transações do TM1 (Tm1s.log). A caixa de diálogo contémcampos para quatro parâmetros que devem ser especificados para executar umaconsulta.

80 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 95: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Opção Descrição

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

O TM1 consulta todos os registros gravadosno log de transações nesta data/hora ouapós. Você deve usar o formatoMM/DD/AAAA HH:MM:SS paraespecificar um horário de início.

A data/hora de início padrão é 00:01:00GMT na data de ativação da consulta.

Horário de Encerramento A data/hora de encerramento para aconsulta.

O padrão é __/__/____ __:__:__, que é umadata/hora de abertura-encerramento. Sevocê aceitar o padrão, o TM1 consultarátodos os registros até o horário de ativaçãoda consulta.

Cliente(s) O(s) cliente(s) no(s) qual(is) a consulta éaplicada. É possível consultar em um únicocliente ou em todos 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 únicocubo ou em todos os cubos. O padrão étodos os cubos (*).

Para definir qualquer um dos parâmetros acima, clique na seta próxima ao campoapropriado.

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 oresultado de uma consulta do log de transações em formato de tabela. A tabelacontém as seguintes colunas para cada registro retornado 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.

Capítulo 2. Windows e Caixas de Diálogo 81

Page 96: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Coluna Descrição

CHAVE N Existem várias colunas Chave N na tabela,cada coluna representando os elementos queidentificam o valor.

A caixa de diálogo Resultados da Consulta do Log de Transações inclui trêsmenus.

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 de transferência.

Ocultar Suprime a exibição do(s) registro(s)selecionado(s) na tabela.

É possível clicar em Atualizar para restaurara exibição de registros ocultos.

Classificar Abre um submenu a partir do qual épossível escolher colunas para classificar ouuma ordem de classificação a ser aplicada.

Localizar Abre a caixa de diálogo Localizar/Substituir,que permite 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). Quandoum registro for restaurado, OLDVALUE parao registro substituirá NEWVALUE para oregistro.

Quando vários registros para um único localdo cubo forem selecionados, os registrosserão restaurados para OLDVALUE doLOGTIME mais anterior.

82 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 97: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Editor do Turbo IntegratorO Editor do Turbo Integrator permite definir processos para importar dados oumetadados de várias origens possíveis. O editor é formado por cinco guias, váriasdas quais são dinâmicas ou contêm subguias. Defina um processo concluindo cadaguia em ordem sequencial.

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 umnovo nome.

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 procedimentoPró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ênciano campo 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 TM1 , o caminho para umaorigem de dados ASCII ou Open Database Connectivity pode diferir do caminhousado pelo servidor. Se isto ocorrer, o processo falhará. Para assegurar que seusprocessos funcionem corretamente:v Defina processos envolvendo origens de dados Open Database Connectivity no

servidor real, no qual o processo deve residir. Não use um cliente remoto paradefinir tal processo.

v Utilize o Ambiente de Rede do Windows para definir o caminho para origens dedados ASCII. Isto assegura que o caminho não seja ambíguo para clientes eservidores.

Os campos e opções disponíveis na guia Origem de Dados variam de acordo como Tipo de Origem de Dados selecionado. A tabela a seguir descreve os campos eopções necessários para cada origem.

Capítulo 2. Windows e Caixas de Diálogo 83

Page 98: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Open Database ConnectivityDefine uma origem de dados Open Database Connectivity:

Campos Descrição

Nome da Origem de Dados O caminho completo para a origem dedados Open Database Connectivity.

UserName Seu nome de usuário na origem.

Senha Sua senha.

Consulta Uma consulta SQL para extrair dados daorigem.

Usar Unicode Clique aqui para usar Unicode para estaorigem.

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 textode origem. Para assegurar que este caminhoseja reconhecido no cliente e no servidor,clique no botão Navegar e use o Ambientede Rede para definir o caminho.

Nome da Origem de Dados no Servidor Ao criar um novo processo, o TurboIntegrator presume que o nome da origemde dados no servidor seja idêntico ao nomeda origem de dados usado para criar oprocesso.

Se o nome da origem de dados no servidorfor diferente da origem de dados local usadapara criar o processo, insira o caminhocompleto para o arquivo da origem dedados no servidor.

Tipo de Delimitador Se a origem usar um caractere para definiras colunas, selecione Delimitado, emseguida, escolha o caractere na caixaDelimitador.

Largura Ajustada Se a origem usar uma largura fixa, selecioneLargura Fixa, em seguida, use o botãoDefinir Larguras de Campo para abrir acaixa de diálogo Visualização para definirlarguras da coluna.

Caractere Aspas Especifique o caractere aspas usado nosdados de origem.

Número de registros de título Se os registros de título forem expandidospara mais de uma linha, insira o número delinhas aqui. Caso contrário, deixe este campoem branco.

Delimitadores de Número Insira o caractere a ser usado paraSeparador Decimal e Separador de Milharesna origem.

84 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 99: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

ODBODefinir uma origem de dados ODBC estabelecida para um banco de dadosrelacional que pode ser construído utilizando o painel de controle do MicrosoftWindows Data Sources:

Cubo ou Dimensão:

Selecione o tipo de importação a ser feita:

Campos Descrição

Provedor de ODBO Para importar um cubo ODBO, utilize omenu suspenso para selecionar OLE DBpara origem de dados OLAP, inclusive parausar o Microsoft Analysis Services.

Local de ODBO Insira o local do arquivo para este provedor.

Ao importar uma dimensão, deixe estecampo em branco.

Origem de Dados ODBO Insira o nome designado por seuadministrador a um conjunto de catálogosem um local específico. Nos MicrosoftAnalysis Services, esse é o nome de umservidor registrado.

Catálogo ODBO O nome designado por seu administrador auma coleção específica de bancos de dados(Cubos, Dimensões e outros objetos). Para oMAS, este é o nome do banco de dados.

ID do Usuário de ODBO Um nome de usuário válido para o banco dedados.

Senha de ODBO Uma senha válida nesta origem de dados.

Parâmetros de Conexão Adicionais Insira aqui parâmetros adicionais requeridospela origem ODBO. Delimite os parâmetroscom pontos e vírgulas.

Ao importar uma dimensão, deixe estecampo em branco.

Consulta MDX:

Define uma consulta baseada em MDX:

Campos Descrição

Guia Conexão Insira as informações de conexãonecessárias. Os parâmetros de conexão sãoespecíficos do fornecedor.

Clique em Conectar. Se sua conexão forbem-sucedida, a guia Consulta MDX ficarádisponível.

Capítulo 2. Windows e Caixas de Diálogo 85

Page 100: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Campos Descrição

Guia Consulta MDX Insira a consulta MDX nesta guia ou coleuma consulta MDX ativa de outro aplicativo.

SAPDefine a origem de dados SAP RFC:

Guia Campo Descrição

Conexão Sistema O nome do sistema SAP aoqual você deseja conectar-se.

Se o nome do sistema incluirespaços, coloque o nomeentre aspas duplas.

Cliente Um número que correspondeà versão da UI no servidorSAP. Por exemplo, 498.

Usuário Seu nome de usuário nosistema SAP.

Senha Sua senha no sistema SAP.

Idioma O idioma que você desejausar para efetuar logon nosistema SAP.

Todas as descrições textuaissão retornadas no idiomaespecificado, se disponível.

O parâmetro de idioma éuma abreviação de duasletras, por exemplo,EN=English.

Parâmetros de ConexãoAdicionais

Insira outros parâmetros evalores usados paraconectar-se ao sistema SAPBW.

86 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 101: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Guia Campo Descrição

Tamanho do Pacote Um valor que limita onúmero de linhas em cadapacote enviado do SAP parao TM1 . Um tamanho dopacote menor resultará emmaior tráfego de rede compacotes pequenos, enquantoum tamanho do pacotemaior resultará em menortráfego de rede, mas compacotes maiores portransmissão.

O tamanho do pacotepadrão, que também é otamanho mínimo do pacote,é 50.000.

Info Cube

Área Campo Descrição

Info CubeMostrar Nomes Técnicos doSAP

Para usar nomes técnicos,selecione esta caixa deseleção. Deixe esta caixadesmarcada para exibir pornome descritivo.

Selecionar InfoCube do qualCarregar

Use a opção para indicar oInfoCube do qual você desejaimportar dados.

Selecione TM1 Cube para oqual Carregar

Para importar o SAPInfoCube para um cuboexistente do TM1 , cliquenesta opção e selecione ocubo para receber os dadosdo SAP InfoCube.

Selecione TM1 Cube para oqual Carregar

Para criar um novo cubo doTM1 ao importar o InfoCube,insira um nome para o novocubo do TM1 neste campo.

TM1 Cube Action Criar Importa dados e metadadosdo SAP InfoCube e cria umnovo cubo no TM1 . Use estaopção somente quandonenhum dos cubos edimensões sendo importadosexistirem no servidor.

Capítulo 2. Windows e Caixas de Diálogo 87

Page 102: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Área Campo Descrição

Recriar Destrói um cubo existente doTM1 e o reconstrói usandodados e metadados do SAPInfoCube. Use esta opçãosomente quando existir ocubo e as dimensões do TM1e desejar substituí-los pornovas estruturas e dados doSAP InfoCube.

Atualizar Importa dados de um cuboexistente do SAP InfoCube eos insere em um cuboexistente do TM1 . Estaopção não altera a estruturade cubos e dimensões noservidor.

Os processos que especificamNenhuma Ação não afetamos dados ou metadados doscubos do TM1 .

Use esta opção para testar edepurar processos ou paradefinir suas própriasoperações customizadas.

Ação de Dados Armazenar Valores Esta opção grava valores decélula do SAP InfoCube parao cubo do TM1 .

Se escolher esta opçãoquando a opção AtualizarCubo for selecionada, osvalores existentes do cubo doTM1 serão sobrescritos pelosvalores importados doInfoCube.

Acumular Valores A opção Valores Acumuladospermite agregar valoresexistentes do Cubo do TM1 aesses valores importados doSAP InfoCube.

88 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 103: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Área Campo Descrição

Porção Zerada do Cubo deDestino

Esta opção fica disponívelquando você seleciona a açãoAtualizar Cubo.

Selecione esta opção sedesejar definir todos ospontos de dados em umavisualização do cuboespecificada como zero.

Para definir a visualizaçãodo cubo para ser zerada,você pode:

v Clicar na lista Visualizaçãopara selecionar umavisualização existente paraser zerada.

v Clicar no botão Maispróximo à lista de opçõesVisualização para definiruma nova visualizaçãopara ser zerada.

Habilitar Criação de Log deCubos

Para registrar mudanças emdados do cubo ao importarde um SAP InfoCube,selecione esta opção.

Para desativar a criação delog ao importar, limpe estaopção.Nota: A desativação dacriação de log acelera ocarregamento e a atualizaçãode dados, mas tornaimpossível recuperaratualizações em caso de umafalha do sistema.

Guia Características

Campo Descrição

Selecionar Hierarquias Identifique as hierarquias na origem de dados.

Data de Avaliação A data em que todos os atributos SAP dependentes detempo são importados para o TM1 , conforme eles existiamna data especificada. Os atributos que não são dependentesde tempo são importados conforme existem no momento daexecução do processo.

Se esta data for limpa, todos os atributos SAP serãoimportadas conforme eles existem na data em que oprocesso do TM1 é executado.

Não importe uma hierarquia com intervalos.

Capítulo 2. Windows e Caixas de Diálogo 89

Page 104: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Campo Descrição

Dimensão do TM1 Selecione a dimensão do TM1 que é mapeada para estacaracterística.

Mantenha este campo vazio se não desejar importar acaracterística para o cubo do TM1 .

Ação de Dimensão do TM1 Criar Crie uma nova dimensão doTM1 a partir da característicado SAP.

Recriar Recrie totalmente umadimensão existente do TM1com elementos importadosda característica SAP.

Atualizar Atualizar uma estrutura dadimensão existente, incluindonovos elementos importadosda característica do SAP.

AsIs Processe a característica pormeio do Turbo Integrator,mas não use a característicapara criar ou modificarqualquer dimensão do TM1 .

Use esta opção para testar edepurar processos ou paramanipular a característica naguia Avançado do TurboIntegrator.

Não Carregar Não importe a característicado SAP para o TM1 . Acaracterística é totalmenteexcluída quando o SAPInfoCube é processado pormeio do Turbo Integrator.

Selecionar Atributos Atributos da Característica Define os atributos para estaorigem de dados.

Texto Identifica atributos com umvalor de sequência.

Numérico Identifica atributos com umvalor numé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 dadimensão reais

90 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 105: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Campo Descrição

Selecionar Key Figure Selecione cada key figure que deseja importar para o TM1 .

Se as key figures mapeiam para uma dimensão do TM1existente, clique na coluna de Dimensão do TM1 e selecionea dimensão que corresponde às key figures.

Restrições Incluir Restrições Crie uma nova restrição paraesta característica.

Característica do SAP Selecione a característica naqual definir uma restrição.

Sinal Indica se a restrição éinclusiva ou exclusiva.

Escolha Incluir se desejar queo processo do TurboIntegrator importe apenas osvalores que estão contidos nadefinição de restrição.

Escolha Excluir se desejarque o processo do TurboIntegrator importe apenas osvalores que estão fora dadefinição de restriçã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ísticasiguais ao 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 Baixoespecificado.

Capítulo 2. Windows e Caixas de Diálogo 91

Page 106: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Operador Descrição

> = A restrição identifica apenas característicasmaiores ou iguais ao Valor Baixoespecificado.

[ ] A restrição identifica apenas característicasque estão entre o Valor Baixo e o Valor Altoespecificados, inclusive.

] [ A restrição identifica apenas característicasque estão fora do Valor Baixo e do ValorAlto especificados, 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ê deveassegurar que as restrições inseridas sejam precisas e válidas para os dados doSAP.

Segurança

Campo Descrição

Importar Segurança Indica que as designações de segurança paraesta característica devem ser importadas.

Consolidação Superior Cria uma consolidação de nível superiorpara a dimensão do TM1 criada usando onome inserido aqui.

92 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 107: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Campo Descrição

Fazer Textos Únicos Para gerar aliases exclusivos para todos oselementos criados a partir da característicado SAP, selecione esta opção. Ao importaruma característica do SAP para o TM1 , osvalores da característica tornam-se elementosde dimensão do TM1 , enquanto que asdescrições de valores do SAP tornam-sealiases de elemento do TM1 . No TM1 ,todos os aliases de elementos em umadimensão devem ser exclusivos. Se umprocesso do Turbo Integrator tentar designaro mesmo alias a vários elementos, oprocesso gerará erros e a criação do aliasfalhará.

Quando a opção Tornar Textos Exclusivosestiver selecionada, o TM1 examina asdescrições do SAP importadas e convertidasem aliases do TM1 . Se o TM1 detectar quevalores múltiplos usam descrições idênticas,o TM1 anexará o nome do valor à descriçãopara gerar aliases exclusivos.

No TM1 versão 9.5.2, a variável V2 nãocontém nenhum valor, portanto, a únicamaneira de fazer a importação do atributoAlias é usar a opção Tornar TextosExclusivos.

Se Tornar Textos Exclusivos não formarcada, nenhum dado de SAP_Text serábuscado.

Quando Tornar Textos Exclusivos não formarcada, você poderá incluirDataSourceSAPUsingTexts=1; no prólogopara importar os valores de atributo doalias.

Consulte a função AttrPutS para obter omesmo comportamento usando um script doTI.

Data de Avaliação Todos os valores de características queexistiam entre a data selecionada e a data daexecução do processo serão importados parao TM1 . Quando não houver uma data deavaliação especificada, o padrão será a datada execução do processo do TurboIntegrator.

Capítulo 2. Windows e Caixas de Diálogo 93

Page 108: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Tabela do SAP

Campo Descrição

Tabela do SAP Indica que a origem de dados é umaconsulta de tabela 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 SQLSELECT gerada pelo Turbo Integrator forexecutada na tabela do SAP.

Tabela ODS

Campo Descrição

Tabela ODS Usado para exportar os dados do TM1 parauma tabela ODS que pode, então, ser usadapara importar dados por meio de um SAPInfocube.

Configuração de ODS Define os detalhes da tabela ODS.

Navegar Selecione a Visualização do TM1 a ser usadacomo a origem de dados.

Mostrar Nomes Técnicos Para usar nomes técnicos, selecione estacaixa de seleção. Deixe esta caixadesmarcada para exibir por nome descritivo.

Selecionar Tabela ODS Selecione a tabela ODS para a qual exportar.

94 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 109: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Campo Descrição

Colunas As colunas podem ser características ounúmeros principais do SAP. Você deve estarfamiliarizado com a estrutura da tabela ODSpara saber quais colunas são características equais são números principais; o TurboIntegrator não diferencia tipos de colunas databela ODS.

Você deve estar ciente dos seguintes detalhesao mapear dimensões para características:

v Você não precisa mapear uma dimensãopara cada coluna de característica natabela ODS. Algumas colunas poderãonão ter uma dimensão correspondente doTM1 quando o mapeamento estiverconcluído. Neste caso, qualquer coluna decaracterística que não foi mapeada ficarávazia quando a exportação estiverconcluída.

v Você não deve mapear uma dimensãoúnica do TM1 para múltiplas colunas databela de características ODS. A interfacecom o usuário do Turbo Integrator nãoimpede que você faça isso, mas esse tipode mapeamento resultará em valores decoluna redundantes na tabela ODS.

v Ao mapear uma dimensão de título devisualização do TM1 para umacaracterística, e a dimensão de título nãousar um subconjunto nomeado, somente oúltimo elemento no subconjunto de títulonão nomeado atual será exportado para atabela ODS. Se a dimensão de título usarum subconjunto nomeado, todos oselementos de subconjunto serãoexportados para a tabela ODS.

Selecionar Medida A última dimensão na visualização do cubode origem será considerada a dimensão dasmedidas. Ao mapear uma dimensão dasmedidas para uma coluna da tabela ODS, obotão Selecionar Medida fica disponível.

Selecione um único elemento que sejamapeado diretamente para a coluna de keyfigure na tabela ODS

Se sua tabela ODS incluir uma única colunade key figure, você também poderá usar okey figure alternativo.

Capítulo 2. Windows e Caixas de Diálogo 95

Page 110: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Campo Descrição

Dimensão do TM1 Se a tabela ODS incluir uma única coluna denúmero principal, será possível usar a opção_TM1CellValue_ para mapear valores docubo do TM1 para a tabela ODS. Você nãopode usar a opção _TM1CellValue_ se suatabela ODS contiver várias colunas de keyfigure.

Para usar esta opção, não mapeie adimensão das medidas do TM1 para acoluna de número principal. Em vez disso,clique na coluna Dimensão do TM1 eselecione _TM1CellValue_.

Quando você utiliza esse método alternativopara mapear os valores do cubo do TM1, adimensão das medidas do TM1 nãodeve sermapeada para nenhum coluna ODS.

Moeda

Campo Descrição

Moeda do SAP Usado para importar dados da moeda paraum cubo tridimensional novo ou existenteno servidor.

Mostrar Nomes Técnicos do SAP Para usar nomes técnicos, selecione estacaixa de seleção. Deixe esta caixadesmarcada para exibir por nome descritivo.

Inserir Nome do Cubo Insira um cubo tridimensional existente ouinsira um novo nome do cubo.

Da Moeda Selecione a moeda inicial a ser importada doSAP.

A lista de moedas disponíveis reflete asmoedas definidas no sistema SAP.

Dimensão de Destino Especifique a dimensão do TM1 a recebersequências de moeda do SAP.

Para a Moeda Selecione a segunda moeda a ser importadado SAP.

Tipo de Conversão Selecione o método de conversão a serusado durante a conversão da moeda inicialpara a segunda moeda.

96 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 111: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Cognos TM1Usa um cubo ou dimensão do IBM Cognos TM1 como 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 do TM1 a serusada como a origem de dados. Clique nobotão Visualização. Em seguida, preencha oscampos nas outras guias.

IBM Cognos Package ConnectorIndica que a origem de dados é um Pacote IBM Cognos publicado criado a partirde uma consulta SAP.

Pacote

Campo Descrição

Conexão Define a conexão com esta origem de dados.

Namespace de Autenticação Exibe todos os IBM CognosNamespaces atualmentedisponíveis.

UserID Senha

Pacote Selecionar Pacote Clique no botão Navegarpara selecionar um Pacote depublicação disponível.

Selecione o cubo do TM1para o qual carregar

Se estiver importando osdados diretamente para umcubo existente do TM1 ,insira o nome do cubo ouuse o menu suspenso.

Ação de Dados, Ação doCubo, Ativar Criação de Logdo Cubo

Consulte as descrições destescampos no SAP Info Cubeacima.

Dimensão

Campo Descrição

Dimensão Pacote Identifique o Pacote a serusado para esta dimensão.

Dimensão da qual carregar Identifique a dimensão a serusada.

Dimensão para a qualcarregar

Identifique a dimensão paraa qual importar.

Capítulo 2. Windows e Caixas de Diálogo 97

Page 112: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Campo Descrição

Ação de Dimensão do TM1 Consulte a descrição para aguia Características paraobter detalhes.

Recuperar Configurações deSegurança

Use a segurança nadimensão.

Consolidação Superior O nome de umaconsolidação de nívelsuperior para a dimensão doTM1 com todos os elementosimportados como filhos daconsolidação.

Selecionar Hierarquias Selecione e mapeie ashierarquias a serem usadasnesta importação e definacomo serão mapeadas para anova dimensão do TM1 .Consulte oIBM Cognos TM1TurboIntegrator Guide paraobter detalhes.

Selecionar Atributos Selecione os Atributos aserem usados e defina omapeamento. Consulte oIBMCognosTM1 TurboIntegratorGuide para 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 o procedimento do Epílogo após a conclusão do processamento doPrólogo.

Nota: Quando a origem de dados para um processo for Nenhum, osprocedimentos de Metadados e Dados serão ignorados. Neste caso, todos os scriptspara o processo devem ser criados nos procedimentos 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 para confirmar se a origem está correta e para ajudar a determinara estrutura de registros.

Se você alterar a origem de dados, clique em Visualização novamente paraatualizar a exibição da grade.

Guia VariáveisA guia Variáveis inclui uma grade e dois botões.

98 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 113: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Grade

Use a grade Variáveis para designar variáveis e identificar o conteúdo de cadacoluna em sua origem de dados. A grade Variáveis inclui as seguintes colunas.

Coluna Descrição

ID da Coluna Lista cada campo ou coluna exclusivaidentificada em sua origem de dados. Ascélulas nesta coluna não podem ser editadas.

Nome da Variável Contém uma variável geradaautomaticamente para cada coluna em suaorigem de dados. Todas as variáveis geradassão chamadas Vn, em que n é 0 para aprimeira coluna e é incrementada em 1 paracada coluna subsequente na origem.

Para designar uma variável diferente, cliquena célula apropriada e insira a novavariável.

Tipo de Variável Contém uma lista para cada coluna em suaorigem de dados. Use a lista para especificarse uma variável é de sequência ou numérica.

Valor de Exemplo Contém valores de amostra do primeiroregistro de sua origem. Estes valores deamostra ajudam a identificar o conteúdo decada coluna de sua origem. As células nacoluna Valor de Amostra não podem sereditadas.

Conteúdo Contém uma lista para cada coluna em suaorigem de dados. Use a lista para especificaro tipo de valor contido em cada coluna daorigem.

Fórmula Esta coluna fica esmaecida para todos oscampos na origem e fica disponível apenasquando você cria uma nova variável.

Ao criar uma nova variável, clique duasvezes na célula Fórmula associada para abrira caixa de diálogo Fórmula da Variável doProcesso, a partir da qual é possível definiruma fórmula para a variá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 defórmulas usadas em um processo do Turbo Integrator. Quando uma fórmula existee você clica em Fórmula, na guia Variáveis, a fórmula atualmente configurada éexibida na janela Fórmula. Clique em Nova Variável para definir a nova fórmula.

Capítulo 2. Windows e Caixas de Diálogo 99

Page 114: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Opção Descrição

Fórmula A fórmula atualmente inserida é exibidanesta janela. À medida em que insere o textoda fórmula, esta janela é atualizada.

Destino Escolha o local para esta fórmula,dependendo das necessidades deprogramação deste processo. SelecioneDados para colocar esta fórmula na seçãoDados do processo do Turbo Integrator.Selecione Metadados para posicionar afórmula na seção Metadados. Amboscolocam a fórmula em ambos os locais.

Avaliar Clique aqui para validar a fórmula.

Valor de Amostra Quando a fórmula é avaliada, asinformações sobre a fórmula são exibidasaqui. Por exemplo, Linha 1: Erro de sintaxe emou antes de: \n (fim da linha) ponto e vírgulaausentes.

Mostrar automaticamente cada vez que onome da variável é alterado.

Clique aqui para exibir esta caixa de diálogose o nome da variável for alterado. Se acaixa estiver desmarcada, você deverásolicitá-la manualmente ao clicar na caixaFórmula, na guia Variáveis.

Guia MapasUse a guia Mapas para especificar como os dados de origem são mapeados paracubos, 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 quepermitem mapear variáveis para os dados de origem para estruturas de metadadosexistentes do TM1 . As subguias que estão disponíveis variam de acordo com otipo de valores contidos nos dados de origem, conforme especificado na colunaConteú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 dadosimportados para cubos do TM1 . A subguia Cubo inclui as seguintes opções.

Opção Descrição

Ação do Cubo Selecione uma opção para criar, atualizar,recriar ou 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 onome do cubo no campo de entrada. Casocontrário, selecione um cubo existente dalista.

100 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 115: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Opção Descrição

Porção Zerada Esta opção fica disponível quando vocêseleciona a ação Atualizar Cubo. Selecioneesta caixa se desejar definir todos os pontosde dados em uma visualização do cubocomo zero.

Nome da Visualização Esta opção fica disponível quando vocêseleciona as opções Atualizar Cubo e ZerarParte.

Selecione ou defina a visualização quecontém os pontos de dados que você desejazerar.

Ação de Dados Selecione uma opção que determina como osdados processados são armazenados nocubo.

Armazenar Valores sobrescreve valores docubo existentes por valores importados peloprocesso.

Acumular Valores inclui valores importadospelo processo 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.Limpe esta caixa para processar cubos semregistrar mudanças no Tm1s.log.

Dimensões

Use a subguia Dimensões para mapear variáveis do elemento para elementos dedimensão.

A subguia inclui uma grade usada para mapear variáveis individuais paradimensões no banco de dados do TM1 . A grade inclui as seguintes colunas.

Coluna Descrição

Variável do Elemento Contém o nome de cada variável para aqual você especificou um valor Conteúdo deElemento. O valor de Conteúdo éespecificado na guia Variáveis.

Esta coluna também contém o rótulo(Variáveis de Dados) para quaisquervariáveis com um valor Conteúdo de Dados.

Valor de Exemplo Um valor de amostra do primeiro registrode sua origem de dados. Use este valor paraajudar a identificar a dimensão para a qual avariável do elemento é mapeada.

Capítulo 2. Windows e Caixas de Diálogo 101

Page 116: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Coluna Descrição

Dimensão Lista todas as dimensões disponíveis noservidor. Selecione a dimensão para a qual avariável do elemento é mapeada.

Para mapear a variável do elemento parauma nova dimensão, digite o nome da novadimensão no campo de entrada.

Ordem no Cubo Esta opção fica disponível quando a Ação doCubo é Criar.

Especifique a ordem de cada dimensão nocubo que está sendo criado.

Ação Lista as ações de dimensão disponíveis.Selecione uma ação.

Para criar uma nova dimensão, você deveespecificar uma ação Criar.

Tipo de Elemento Selecione um tipo de elemento para avariável, Numérico ou de Sequência.

Ordem do Elemento Selecione uma opção para ordenar elementosnas dimensões que estão sendo criadas ouatualizadas. Existem quatro ordens declassificação:

Entrada - Classifica elementos na ordem emque eles são criados na dimensão.

Nome - Classifica elementos em ordemalfabética, crescente ou decrescente.

Nível - Classifica elementos por nível dehierarquia, crescente ou decrescente.

Hierarquia - Classifica elementos conformeeles existem 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 paraelementos no banco de dados do TM1 . A grade inclui as seguintes colunas.

Coluna Descrição

Variável de Dados Contém o nome de cada variável para aqual você especificou um valor Conteúdo deDados. O valor de Conteúdo é especificadona guia Variáveis.

102 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 117: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Coluna Descrição

Elemento Clique no botão de seta à direita para abriro Editor de Subconjunto, no qual é possívelescolher o elemento para o qual a variável émapeada.

Para mapear a variável para um novoelemento, digite o nome de elemento nocampo de entrada.

Tipo de Elemento Selecione um tipo de elemento aqui.

Valor de Exemplo Um valor de amostra do primeiro registrode sua origem de dados. Use este valor paraajudar a identificar o elemento para o qual avariável de dados é 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 paradimensões no banco de dados do TM1 . A grade inclui as seguintes colunas.

Coluna Descrição

Variável de Variável Contém o nome de cada variável para aqual você especificou um valor Conteúdo deConsolidação. O valor de Conteúdo éespecificado na guia Variáveis.

Dimensão Lista de dimensões para as quais aconsolidação pode ser mapeada.

Variável Filha Lista as variáveis das quais você seleciona ofilho imediato da consolidação.

Peso Designa um peso à variável-filhoespecificada.

Valor de Exemplo Um valor de amostra do primeiro registrode sua origem de dados. Use este valor paraajudar a identificar o elemento para o qual aconsolidação é mapeada.

Capítulo 2. Windows e Caixas de Diálogo 103

Page 118: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Coluna Descrição

Ordem do Elemento Selecione uma opção para ordenar elementosnas consolidações que estão sendo criadasou atualizadas. Existem quatro ordens declassificação:

Entrada - Classifica elementos na ordem emque eles são criados na dimensão.

Nome - Classifica elementos em ordemalfabética, crescente ou decrescente.

Nível - Classifica elementos por nível dehierarquia, crescente ou decrescente.

Hierarquia - Classifica elementos conformeeles existem na hierarquia da dimensão.

Atributos

Use a subguia Atributos para mapear variáveis de atributo para atributosespecíficos.

A subguia inclui uma grade usada para mapear variáveis individuais paradimensões no banco de dados do TM1 . A grade inclui as seguintes colunas.

Coluna Descrição

Variável do Atributo Contém o nome de cada variável para aqual você especificou um valor Conteúdo deAtributo. O valor de Conteúdo éespecificado na guia Variáveis.

Valor de Exemplo Exibe um valor de amostra da origem dedados. Use esta amostra para ajudar amapear o atributo.

Dimensão Lista todas as dimensões disponíveis noservidor. Selecione a dimensão à qual oatributo é aplicável.

Variável do Elemento Lista as variáveis do elemento. Selecione avariável para o elemento ao qual a variávelde atributo é aplicável.

Atributo Lista os atributos para os quais a variávelpode ser mapeada. Selecione o atributoapropriado desta lista.

Ação Escolha Criar um novo atributo ou Atualizarum existente.

Tipo de Atributo Identifica o tipo de atributo selecionado nacoluna Atributo.

104 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 119: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Guia AvançadoA guia Avançado contém várias subguias que exibem instruções geradas pelo TM1com base nas opções selecionadas em outro lugar no Editor do Turbo Integrator. Aguia Avançado também inclui uma subguia na qual é possível definir parâmetrospara o processo.

Parâmetros

Item Descrição

Inserir Clique para inserir um novo parâmetro.

Excluir Clique para excluir um parâmetroselecionado.

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 valorpadrão para este parâmetro quando oprocesso do Turbo Integrator for executado.

Prompt de Pergunta Insira um prompt a ser usado para esteparâmetro quando o processo do TurboIntegrator for executado.

Prólogo

Item Descrição

Caixa de texto Instrução Exibe as instruções geradas que definemuma série de ações a serem executadas antesdo processamento da origem de dados.

É possível aprimorar um processo criandoinstruções adicionais com regras ou funçõesdo Turbo Integrator.

Botão Ir para a Linha Clique neste botão, insira a linha para a qualvocê deseja ir, em seguida, clique em OKpara ir diretamente para uma linha decódigo na caixa de texto da instrução.

Capítulo 2. Windows e Caixas de Diálogo 105

Page 120: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Metadados

Item Descrição

Caixa de texto Instrução Exibe as instruções geradas que definemuma série de ações a serem executadas emmetadados do TM1 antes do processamentoda origem de dados.

É possível aprimorar um processo criandoinstruções adicionais com regras ou funçõesdo Turbo Integrator.

Botão Ir para a Linha Clique neste botão, insira a linha para a qualvocê deseja ir, em seguida, clique em OKpara ir diretamente para uma linha decódigo na caixa de texto da instrução.

Dados

Item Descrição

Caixa de texto Instrução Exibe as instruções geradas que definemuma série de ações a serem executadasquando a origem de dados for processada.

É possível aprimorar um processo criandoinstruções adicionais com regras ou funçõesdo Turbo Integrator.

Botão Ir para a Linha Clique neste botão, insira a linha para a qualvocê deseja ir, em seguida, clique em OKpara ir diretamente para uma linha decódigo na caixa de texto da instrução.

Epílogo

Item Descrição

Caixa de texto Instrução Exibe as instruções geradas que definemuma série de ações a serem executadas apóso processamento da origem de dados.

É possível aprimorar um processo criandoinstruções adicionais com regras ou funçõesdo Turbo Integrator.

Botão Ir para a Linha Clique neste botão, insira a linha para a qualvocê deseja ir, em seguida, clique em OKpara ir diretamente para uma linha decódigo na caixa de texto da instrução.

106 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 121: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Guia ProgramaçãoUse esta guia para planejar um processo para ser executado em intervalosregulares.

Item Descrição

Planejar este Processo como uma Tarefa deOrganização de Processos Nomeada

Verifique aqui para executar este processocomo uma tarefa de organização deprocessos em intervalos regulares. Porpadrão, a tarefa de organização de processospossui o mesmo nome que o processo. Sedesejar designar um nome diferente à tarefade organização de processos, digite-o nocampo de entrada.

Data e Hora de Início da Tarefa deOrganização de Processos

Selecione uma data de início no calendário eespecifique um horário de início no campode Tempo.

Frequência de Execução da Tarefa deOrganização de Processos

Preencha os campos apropriados paraestabelecer o intervalo no qual a tarefa deorganização de processos deve serexecutada.

Janela Extração de VisualizaçãoUse a janela Extração de Visualização para criar uma visualização que incluaapenas os valores que atendem aos critérios definidos pelo usuário, ou para definiruma visualização para exportação.

Ignorar Parâmetros

Parâmetro Descrição

Ignorar Valores Consolidados Ative esta opção para ignorar valoresderivados por meio de consolidação aoextrair a visualização. Desative esta opçãopara incluir valores derivados por meio deconsolidação ao extrair a visualização. Opadrão é desativado.

Ignorar Valores Calculados por Regras Ative esta opção para ignorar valoresderivados por meio de regras ao extrair avisualização. Desative esta opção paraincluir valores derivados por meio de regrasao extrair a visualização. O padrão édesativado.

Ignorar Valores Zero/Em Branco Ative esta opção para ignorar zeros ouvalores em branco ao extrair a visualização.Desative esta opção para incluir zeros ouvalores em branco ao extrair a visualização.O padrão é ativado.

Parâmetros do Intervalo

Parâmetro Descrição

Operador Selecione um operador que define os valoresque você deseja extrair.

Capítulo 2. Windows e Caixas de Diálogo 107

Page 122: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Parâmetro Descrição

Limites Numéricos Insira um valor numérico para a(s)variável(is) no Operador.

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 ouo subconjunto que define 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 a página com as 16 dimensõesseguintes.

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 TM1 no In-Spreadsheet Browser. A caixa de diálogocontém várias listas que permitem aplicar um estilo existente do Excel a umintervalo 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 aplicarao plano de fundo do In-SpreadsheetBrowser.

Células de Dados Selecione um estilo desta lista para aplicar acélulas de dados.

O estilo Células de Dados tem precedênciasobre o estilo Plano de Fundo.

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 Colunatem precedência sobre o estilo Plano deFundo.

Botões Editar Estilo Clique no botão Editar Estilo apropriadopara editar ou criar estilos para o intervaloassociado do In-Spreadsheet Browser.

108 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 123: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Item Descrição

Congelar Áreas de Janela Alterne esta opção para congelar edescongelar áreas de janela noIn-Spreadsheet Browser.

Quando esta opção for ativada, os nomes deelementos da linha permanecerão visíveisquando você rolar horizontalmente por umavisualização, e os nomes de elementos dacoluna permanecerão visíveis quando vocêrolar verticalmente.

Quando esta opção for desativada, os nomesde elementos da linha e da coluna serãomovidos com os valores do cubo, conformevocê rola por uma visualização.

Capítulo 2. Windows e Caixas de Diálogo 109

Page 124: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

110 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 125: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Capítulo 3. Funções das Regras

Esta seção contém uma lista completa de todas as funções de regras do IBMCognos TM1 . Qualquer uma destas funções pode ser usada ao gravar regras doTM1 .

Também é possível incorporar todas as funções de regras, com exceção das funçõesSTET e ISLEAF, em processos do Turbo Integrator.

Operadores Aritméticos em Regras do TM1Os seguintes operadores matemáticos podem ser usados ao construir regras doTM1 .

Operador Significado

+ (sinal de mais) Adição

- (sinal de menos) Subtração

* (asterisco) Multiplicação

/ (barra) Divisão por zero usando este operadorretorna um valor indefinido.

\ (barra invertida) Divisão por zero usando este operadorretorna zero.

^ (sinal de intercalação/circunflexo) Exponenciação

Operadores de Comparação em Regras do TM1Os operadores de comparação comparam valores na parte da fórmula de umainstrução de cálculo de regra.

Operador Significado

> Maior que

< Menor que

>= Maior ou igual a

<= Menor ou igual a

= Igual a

<> Diferente de

© Copyright IBM Corp. 2007, 2013 111

Page 126: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Para comparar dois valores de sequência, insira o símbolo @ antes do operador decomparação, como no seguinte exemplo:

IF ('A' @= 'B',0,1) resulta no número 1.

Operadores Lógicos em Regras do TM1É possível combinar expressões em uma instrução de cálculo de regras usandooperadores lógicos.

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 que5.

~ (til) NÃO ~(Valor1 > 5) Equivalente a(Valor1 <= 5)

Funções de Regras de Cálculo de ConsolidaçãoConsolidatedMax; ConsolidatedMin; ConsolidatedAvg; ConsolidatedCount; eConsolidated CountUnique executam cálculos matemáticos em consolidações.

ConsolidatedMinConsolidatedMin calcula o valor mínimo em uma consolidação e retorna um valorúnico.

Essa é uma função do TM1 Rules válida em processos de Regras e TurboIntegrator.

SintaxeConsolidatedMin(flag-value, cube-name, element_1, element_2,... );

Argumentos

flag-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 estiverativado no valor bruto do elemento consolidado, ele será usado. �

2 - ignora valores iguais a zero. Se ele estiver configurado, os valores iguais azero não serão usados por essas funções.

Nota: Se zero for especificado como a ponderação de alguns elementosconsolidados, o parâmetro de configuração ZeroWeightOptimization=F deveráser configurado para esses elementos serem fatorados no cálculo dessasfunções. Sem esse parâmetro de configuração, os elementos para os quais aponderaçã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.

112 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 127: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

cube-name

Nome do cubo em que os valores residem.

Se a função estiver em execução como parte de uma regra do cubo, e NÃOcomo parte de um processo do Turbo Integrator, o argumento cube-namepoderá ser especificado como uma sequência vazia para representar o cuboatual. Isso significa que você pode gravar uma regracomo:[’Apr’]=ConsolidatedMin( 1, ’’, !actvsbud, ’1 Quarter’ );

element_1, element_2, ...

Os nomes de elementos de dimensão que definem a interseção do cubo quecontém o valor a ser recuperado.

Os argumentos element_1 a element_n são sensíveis à sequência. element_1deve ser um elemento da primeira dimensão do cubo, element_2 deve ser umelemento da segunda dimensão do cubo, e assim por diante. Estes argumentostambém podem ser os nomes de aliases para elementos de dimensão ouvariáveis do Turbo Integrator.

ConsolidatedMaxConsolidatedMax calcula o valor máximo em uma consolidação e retorna um valorúnico.

Essa é uma função do TM1 Rules válida em processos de Regras e TurboIntegrator.

SintaxeConsolidatedMax(flag-value, cube-name, element_1, element_2,... );

Argumentos

flag-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 estiverativado no valor bruto do elemento consolidado, ele será usado. �

2 - ignora valores iguais a zero. Se ele estiver configurado, os valores iguais azero não serão usados por essas funções.

Nota: Se zero for especificado como a ponderação de alguns elementosconsolidados, o parâmetro de configuração ZeroWeightOptimization=F deveráser configurado para esses elementos serem fatorados no cálculo dessasfunções. Sem esse parâmetro de configuração, os elementos para os quais aponderaçã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.

cube-name

Nome do cubo em que os valores residem.

Se a função estiver em execução como parte de uma regra do cubo, e NÃOcomo parte de um processo do Turbo Integrator, o argumento cube-namepoderá ser especificado como uma sequência vazia para representar o cuboatual. Isso significa que você pode gravar uma regracomo:[’Apr’]=ConsolidatedMax( 1, ’’, !actvsbud, ’1 Quarter’ );

element_1, element_2, ...

Capítulo 3. Funções das Regras 113

Page 128: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Os nomes de elementos de dimensão que definem a interseção do cubo quecontém o valor a ser recuperado.

Os argumentos element_1 a element_n são sensíveis à sequência. element_1deve ser um elemento da primeira dimensão do cubo, element_2 deve ser umelemento da segunda dimensão do cubo, e assim por diante. Estes argumentostambém podem ser os nomes de aliases para elementos de dimensão ouvariáveis do Turbo Integrator.

Exemplo

Considere um cubo chamado Declaração de Renda com três dimensões, "Área","Horário" e "Declaração de Renda". A dimensão Declaração de Renda contém umelemento "Vendas Brutas" para o número de vendas 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’ );

ConsolidatedAvgConsolidatedAvg calcula o valor médio em uma consolidação e retorna um valorúnico.

Essa é uma função do TM1 Rules válida em processos de Regras e TurboIntegrator.

SintaxeConsolidatedAvg(flag-value, cube-name, element_1, element_2,... );

Argumentos

flag-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 estiverativado no valor bruto do elemento consolidado, ele será usado. �

2 - ignora valores iguais a zero. Se ele estiver configurado, os valores iguais azero não serão usados por essas funções.

Nota: Se zero for especificado como a ponderação de alguns elementosconsolidados, o parâmetro de configuração ZeroWeightOptimization=F deveráser configurado para esses elementos serem fatorados no cálculo dessasfunções. Sem esse parâmetro de configuração, os elementos para os quais aponderaçã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.

cube-name

Nome do cubo em que os valores residem.

Se a função estiver em execução como parte de uma regra do cubo, e NÃOcomo parte de um processo do Turbo Integrator, o argumento cube-namepoderá ser especificado como uma sequência vazia para representar o cuboatual. Isso significa que você pode gravar uma regracomo:[’Apr’]=ConsolidatedAvg( 0, ’’, !actvsbud, ’1 Quarter’ );

element_1, element_2, ...

Os nomes de elementos de dimensão que definem a interseção do cubo quecontém o valor a ser recuperado.

114 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 129: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Os argumentos element_1 a element_n são sensíveis à sequência. element_1deve ser um elemento da primeira dimensão do cubo, element_2 deve ser umelemento da segunda dimensão do cubo, e assim por diante. Estes argumentostambé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: Regiões, Horárioe Declaração de Renda, a dimensão Declaração de Renda contém um elementochamado Vendas Brutas para o número de vendas geral.

Para calcular a média de vendas em todas as regiões no ano de 2010, grave:ConsolidatedAvg( 1, ’Income Statement’, ’All Regions’, ’2010’, ’Gross Sales’ );

ConsolidatedCountConsolidatedCount conta o valor em uma consolidação e retorna um valor único.

Essa é uma função do TM1 Rules válida em processos de Regras e TurboIntegrator.

SintaxeConsolidatedCount(flag-value, cube-name, element_1, element_2,... );

Argumentos

flag-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 estiverativado no valor bruto do elemento consolidado, ele será usado. �

2 - ignora valores iguais a zero. Se ele estiver configurado, os valores iguais azero não serão usados por essas funções.

Nota: Se zero for especificado como a ponderação de alguns elementosconsolidados, o parâmetro de configuração ZeroWeightOptimization=F deveráser configurado para esses elementos serem fatorados no cálculo dessasfunções. Sem esse parâmetro de configuração, os elementos para os quais aponderaçã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.

cube-name

Nome do cubo em que os valores residem.

Se a função estiver em execução como parte de uma regra do cubo, e NÃOcomo parte de um processo do Turbo Integrator, o argumento cube-namepoderá ser especificado como uma sequência vazia para representar o cuboatual. Isso significa que você pode gravar uma regracomo:[’Apr’]=ConsolidatedCount( 1, ’’, !actvsbud, ’1 Quarter’ );

element_1, element_2, ...

Os nomes de elementos de dimensão que definem a interseção do cubo quecontém o valor a ser recuperado.

Os argumentos element_1 a element_n são sensíveis à sequência. element_1deve ser um elemento da primeira dimensão do cubo, element_2 deve ser um

Capítulo 3. Funções das Regras 115

Page 130: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

elemento da segunda dimensão do cubo, e assim por diante. Estes argumentostambém podem ser os nomes de aliases para elementos de dimensão ouvariáveis do Turbo Integrator.

ConsolidatedCountUniqueConsolidatedCountUnique conta o número de elementos exclusivos para os quaispontos de dados realmente existem para a consolidação especificada.

Essa é uma função do TM1 Rules válida em processos de Regras e TurboIntegrator.

Os elementos exclusivos são contados ao longo de uma dimensão da célulaconsolidada.

SintaxeConsolidatedCountUnique( 0, unique-along-dimension-name, cube-name,elem_1, elem_2, . . . );

Argumentos

flag wordAtualmente especifica zero

Nota: Se zero for especificado como a ponderação de alguns elementosconsolidados, o parâmetro de configuração ZeroWeightOptimization=F deveráser configurado para esses elementos serem fatorados no cálculo dessasfunções. Sem esse parâmetro de configuração, os elementos para os quais aponderaçã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.

unique-along-dimension-nameA dimensão ao longo da qual entradas do elemento exclusivo para o qualexistem dados reais devem ser contadas.

cube-name

Nome do cubo em que os valores residem.

Se a função estiver em execução como parte de uma regra do cubo, e NÃOcomo parte de um processo do Turbo Integrator, o argumento cube-namepoderá ser especificado como uma sequência vazia para representar o cuboatual.

element_1, element_2, ...

Nomes de elemento de dimensão que definem a interseção do cubo que é ovalor consolidado a ser processado.

Os argumentos element_1 a element_n são sensíveis à sequência. element_1deve ser um elemento da primeira dimensão do cubo, element_2 deve ser umelemento da segunda dimensão do cubo, e assim por diante. Estes argumentostambé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: Regiões, Horárioe Declaração de Renda, a dimensão Declaração de Renda contém um elementochamado Vendas Brutas para o número de vendas geral. Para contar quantasregiões tinham alguma venda bruta no ano de 2010, grave:

116 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 131: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

ConsolidatedCountUnique( 0, ’Regions’, ’Income Statement’,’All Regions’, ’2010’, ’Gross Sales’ );

Funções de Regras de Dados do CuboFunções de regras que trabalham em dados do cubo.

BDDB retorna um valor de um cubo em um banco de dados do TM1 . DB retorna umvalor numérico se usado em uma expressão numérica, e um valor de sequência seusado em uma expressão de sequência.

Esta é uma função de regras do TM1 , válida apenas em regras do TM1 . O usodesta função em um processo do Turbo Integrator causará um erro.

SintaxeDB(cube, e1, e2, [...e256])

Parâmetros

cubo

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 aser recuperado.

Os argumentos e1 a en são sensíveis à sequência. e1 deve ser um elemento daprimeira dimensão do cubo, e2 deve ser um elemento da segunda dimensão eassim por diante.

ExemploDB(’Budget’, ’California’, ’15" Flat Panel Monitors’, ’Net Sales’, ’January’)

Neste exemplo, Budget é o nome do cubo e a função retorna o valor na interseçãode Califórnia, Monitores com Tela Plana 15", Vendas Líquidas e Janeiro.

ISLEAFISLEAF retorna 1 se uma célula especificada for uma célula folha (identificadaapenas por elementos folha/simples). Se a célula especificada for identificada porqualquer elemento consolidado, a função retornará 0.

Esta é uma função de regras do TM1 , válida apenas em regras do TM1 .

A função ISLEAF não pode ser usada em processos do Turbo Integrator. Apresença desta função em um processo impedirá a compilação do processo.

SintaxeISLEAF

Argumentos

Nenhum.

Capítulo 3. Funções das Regras 117

Page 132: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Exemplo

É possível usar ISLEAF em uma instrução SE para testar se uma célula atual é umacélula folha. Por exemplo,[]=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 cubonumérico padrão, que é influenciado pela presença da declaração UNDEFVALS naregra desse cubo. A função retorna 1 se o valor passado for igual ao valor padrãodo cubo, caso contrário, retorna 0.

Esta é uma função de regras do TM1 válida em regras do TM1 e em processosTurboIntegrator.

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 valorpadrão deve ser comparado.

Quando ISUNDEFINEDCELLVALUE é usada em uma regra, o cubo éassumido como cubo sujeito, a menos que seja especificado de outraforma.

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 quandoespecificado, um valor igual a 0 será usado para comparação.

Exemplo

ISUNDEFINEDCELLVALUE(TestValue) retorna 1 quando TestValue é o valor indefinidoespecial e é usado na regra de um cubo com UNDEFVALS declarado.

UNDEFUNDEF retorna o valor indefinido. Esta função pode ser usada para impedir queos dados sejam armazenados em um cubo baseado em um teste lógico.

Esta é uma função de regras do TM1, válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeUNDEF

118 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 133: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumentos

Nenhum.

Exemplo

UNDEF retorna o valor indefinido.

UNDEFINEDCELLVALUEUNDEFINEDCELLVALUE retorna o valor do cubo numérico padrão, que éinfluenciado pela presença da declaração UNDEFVALS na regra desse cubo.

Esta é uma função de regras do TM1 válida em regras do TM1 e em processosTurboIntegrator.

Sintaxe

UNDEFINEDCELLVALUE(<Cube>)

Argumentos

Argumento Descrição

Cube Um argumento String opcional que especifica o cubo cujo valorpadrão deve ser retornado.

Quando UNDEFINEDCELLVALUE é usada em uma regra, o cubo éassumido como cubo sujeito, a menos que seja especificado de outraforma.

Quando usado em um processo do TI, um cubo deve serespecificado.

Se o cubo for omitido em um processo do TI, ou se não for válidoquando especificado, um valor igual a 0 será retornado.

Exemplo

UNDEFINEDCELLVALUE retorna 0 quando é usado na regra de um cubo semUNDEFVALS declarado ou quando é usado em um processo do TI.

UNDEFINEDCELLVALUE retorna o valor indefinido especial quando usado naregra de um cubo com UNDEFVALS declarado.

UNDEFINEDCELLVALUE(’ExampleCube’) retorna o valor padrão de 'ExampleCube' ou 0se 'ExampleCube' não existir.

UNDEFVALSColocar UNDEFVALS nas regras para um cubo altera o valor-padrão do cubo, dezero para um valor indefinido especial.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTM1 Turbo Integrator.

Isso tem ramificações para como os dados são armazenados no cubo erecuperados.

Capítulo 3. Funções das Regras 119

Page 134: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

v Armazenamento de DadosPara um cubo sem UNDEFVALS nas regras, o valor padrão é zero. Se houveruma tentativa de armazenar um zero em uma célula do cubo, esse pedido dearmazenamento será ignorado, visto que um está tentando armazenar ovalor-padrão e isso consumiria, sem necessidade, espaço na memória.Se, entretanto, o cubo tiver UNDEFVALS definido nas regras, isso tornará ovalor-padrão um valor indefinido especial. Agora, quando um zero é armazenadoem uma célula de um cubo, ele é realmente armazenado, exatamente comoqualquer outro valor não zero.

v Recuperação de DadosPara um cubo sem UNDEFVALS nas regras, o valor padrão é zero. Quando umacélula é recuperada e não há nenhum valor atualmente armazenado para essevalor no cubo, um valor de zero (como o valor-padrão) é retornado.Se, entretanto, o cubo tiver UNDEFVALS definido, isso tornará o valor-padrãoum valor indefinido especial. Quando uma célula não existente é recuperada, ovalor recuperado será este valor indefinido especial. Isso pode ser usado paradiferenciar uma célula que não existe (valor indefinido) de uma célula que existe,mas cujo valor é zero (zero retornado).

Nota: Atualmente não é possível, no Turbo Integrator, testar esse valorindefinido especial diretamente. Este valor indefinido especial não é valorretornado pela função UNDEF() Turbo Integrator. O valor retornado peloUNDEF() é um valor indefinido usado para coisas como uma tentativa dedividir por zero ou usar o logaritmo de um número ilegal, etc.

É possível testar indiretamente esse valor indefinido especial da seguinte forma:vv = CellGetN( ’cube-name’, elements-list);if ( vv >0 );

# ’special undefined’ value is greater than zero# convert the value to a stringvv_str = str(vv,20,16);# convert the string back to a numberconverted_vv = NUMBR( vv_str );if ( converted_vv = 0 );

#converted number is now zero, but original was non-zero#this is the ’special undefined’ value

Else#normal non-zero cell value

Endif;Endif;

SintaxeUNDEFVALS

Argumentos

Nenhum.

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 umdeterminado número de série.

120 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 135: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeDATE(SerialNumber, ReturnFourDigitYear)

Argumento Descrição

SerialNumber Uma data expressa em formato serial.

ReturnFourDigitYear Um argumento Booleano opcional que determina se afunção DATE retorna uma sequência usando a notaçãode dois ou quatro dígitos para o ano.

Se ReturnFourDigitYear for true, a função retornará adata que está contida no intervalo de 1 de Jan. de 1960 a31 de Dez. de 9999, usando a notação de quatro dígitospara o ano. A data serial 0 corresponde a 1 de Jan. de1960 e a data serial 2936549 corresponde a 31 de Dez. de9999.

Se ReturnFourDigitYear for false, ou se este argumentoopcional for omitido da função DATE, a função retornaráuma data que está contida no intervalo de 1 de Jan. de1960 a 31 de Dez de 2059, usando a notação de doisdígitos para o ano. A data serial 0 corresponde a 1 deJan. de 1960 e a data serial 36524 corresponde a 31 deDez. de 2059.

Se ReturnFourDigitYear for false ou for omitido e vocêespecificar uma data serial maior que 36524, a data serialusada pela função será determinada pela fórmula n -36525. Por exemplo, se você especificar uma data serialde 36530, 36530 - 36525 = 5. Neste caso, DATE usará 5como a data serial e retornará a data 6 de Jan. 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 um determinado ano, mês e dia.

Esta é uma função de regras do TM1, válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeDATES(year, month, day)

Argumento Descrição

year Um ano, expresso em formato aa ou aaaa.

Capítulo 3. Funções das Regras 121

Page 136: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

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 dedatas.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeDAY(DateString)

Argumento Descrição

DateString Uma sequência de datas em formatoAA-MM-DD ou AAAA-MM-DD.

Exemplo

DAY('02-05-25') retorna 25.

DAYNODAYNO retorna o número de série de data correspondente a uma determinadasequência de datas.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

Nota: DAYNO pode retornar datas para sequências de datas, começando em 1 deJaneiro de 1960 (sequências de datas 1960-01-01 ou 60-01-01). Para datas após 31 deDezembro de 2059, você deve usar um ano de quatro dígitos na sequência dedatas. Por exemplo, a sequência de datas para 5 de Janeiro de 2061 seria2061-01-05.

122 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 137: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeDAYNO(’DateString’)

Argumento Descrição

DateString Uma sequência de datas em formatoAA-MM-DD ou AAAA-MM-DD.

Exemplo

DAYNO('98-03-09') retorna 13947.

MÊSMONTH retorna um valor numérico para o mês em uma determinada sequênciade datas.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeMONTH(date)

Argumento Descrição

data Uma sequência de datas em formatoAA-MM-DD ou 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 é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeNOW

Argumentos

Nenhum.

Exemplo

NOW retorna o valor data/hora atual em formato de número de série.

TIMETIME retorna uma sequência, em formato HH:MM, que representa a hora dosistema no servidor TM1 .

Capítulo 3. Funções das Regras 123

Page 138: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeTIME

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 é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeTIMST(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úmeroespecifica a data, e a parte decimal especificaa hora no dia. O dia número 0 correspondea '60-01-01'. Números negativoscorrespondem a anos anteriores. Os anos noSéculo 21, até 2059, são representados pelosanos 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 dafunção. Todos os caracteres no argumento deformato aparecem no resultado, exceto osseguintes caracteres, que retornam valoresde componente de data/hora:

\y

os últimos dois dígitos do ano (97, 98, etc.)

\Y

os quatro dígitos do ano (1997, 1998, etc.)

124 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 139: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento

Modificador/

Descrição

\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)

\s

o segundo (00 a 59)

\p

a.m. ou p.m.

Capítulo 3. Funções das Regras 125

Page 140: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento

Modificador/

Descrição

ExtendedYears Este parâmetro Booleano opcional especificase a função retorna uma data que estácontida no intervalo 1960 - 2059 ou 1960 -9999.

Se ExtendedYears for true, a funçãoretornará uma data que está contida nointervalo de 1 de Jan. de 1960 e 31 de Dez.de 9999. A data serial 0 corresponde a 1 deJan. de 1960 e a data serial 2936549corresponde a 31 de Dez. de 9999.

Se ExtendedYears for false, ou se esteargumento opcional for omitido da funçãoTIMST, a função retornará uma data queestá contida no intervalo de 1 de Jan. de1960 a 31 de Dez. de 2059. A data serial 0corresponde a 1 de Jan. de 1960 e a dataserial 36524 corresponde a 31 de Dez. de2059.

Se ExtendedYears for false ou for omitido evocê especificar uma data serial maior que36524, a data serial usada pela função serádeterminada pela fórmula n - 36525. Porexemplo, se você especificar uma data serialde 36530, 36530 - 36525 = 5. Neste caso,TIMST usará 5 como a data serial eretornará 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 at2a.m. 24min00sec'.

TIMST(11111.1100, 'On \M \D, \Y at \H\p \imin\ssec') retorna 'On JUN 3,1990 at2a.m. 38min24sec'.

TIMVLTIMVL retorna o valor numérico de um componente (ano, mês, etc.) de um valordata/hora.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

126 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 141: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeTIMVL(datetime, type, ExtendedYears)

Argumento

Modificador/

Descrição

datetime Um número de série de data/hora.

A parte do número inteiro do númeroespecifica a data, e a parte decimal especificaa hora no dia. O dia número 0 correspondea '60-01-01.' Números negativoscorrespondem a anos anteriores. Os anos noSéculo 21, até 2059, são representados pelosanos 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 decomponente a ser extraído. Os seguintes sãoargumentos de tipo 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)

Capítulo 3. Funções das Regras 127

Page 142: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento

Modificador/

Descrição

ExtendedYears Este parâmetro Booleano opcional especificase a função retorna uma data que estácontida no intervalo 1960 - 2059 ou 1960 -9999.

Se ExtendedYears for true, a funçãoretornará uma data que está contida nointervalo de 1 de Jan. de 1960 e 31 de Dez.de 9999. A data serial 0 corresponde a 1 deJan. de 1960 e a data serial 2936549corresponde a 31 de Dez. de 9999.

Se ExtendedYears for false, ou se esteargumento opcional for omitido da funçãoTIMVL, a função retornará uma data queestá contida no intervalo de 1 de Jan. de1960 a 31 de Dez. de 2059. A data serial 0corresponde a 1 de Jan. de 1960 e a dataserial 36524 corresponde a 31 de Dez. de2059.

Se ExtendedYears for false ou for omitido evocê especificar uma data serial maior que36524, a data serial usada pela função serádeterminada pela fórmula n - 36525. Porexemplo, se você especificar uma data serialde 36530, 36530 - 36525 = 5. Neste caso,TIMVL usará 5 como a data serial eretornará 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 é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

128 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 143: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeTODAY(<ReturnFourDigitYear>)

Argumento Descrição

ReturnFourDigitYear Um argumento Booleano opcional quedetermina se a função TODAY retorna umasequência usando a notação de dois ouquatro dígitos para o ano.

Se ReturnFourDigitYear for true, a funçãoretornará a data que está contida nointervalo de 1 de Jan. de 1960 a 31 de Dez.de 9999, usando a notação de quatro dígitospara o ano. A data serial 0 corresponde a 1de Jan. de 1960 e a data serial 2936549corresponde a 31 de Dez. de 9999.

Se ReturnFourDigitYear for false, ou se esteargumento opcional for omitido da funçãoTODAY, a função retornará uma data queestá contida no intervalo de 1 de Jan. de1960 a 31 de Dez de 2059, usando a notaçãode dois dígitos para o ano. A data serial 0corresponde a 1 de Jan. de 1960 e a dataserial 36524 corresponde a 31 de Dez. de2059.

Se ReturnFourDigitYear for false ou foromitido e você especificar uma data serialmaior que 36524, a data serial usada pelafunção será determinada pela fórmula n -36525. Por exemplo, se você especificar umadata serial de 36530, 36530 - 36525 = 5. Nestecaso, TODAY usará 5 como a data serial eretornará a data 6 de Jan. de 1960.

Exemplo

P1=TODAY(1) retorna uma sequência de dados em formato AAAA-MM-DD, porexemplo, 2009-06-05.

P1=TODAY(0) retorna uma sequência de datas em formato AA-MM-DD, porexemplo, 09-06-05

ANOYEAR retorna um valor numérico para o ano em uma determinada sequência dedatas.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

Capítulo 3. Funções das Regras 129

Page 144: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeYEAR(date)

Argumento Descrição

data Uma sequência de datas em formatoAA-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.

ATTRNATTRN retorna um atributo numérico para um elemento especificado de umadimensão.

Esta é uma função de regras do TM1, válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeATTRN(dimension, element, attribute)

Argumento Descrição

dimensão Um nome de dimensão válido.

element Um elemento da dimensão.

130 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 145: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

atributo O atributo para o qual você deseja recuperarum valor. Este argumento deve ser umatributo válido do elemento.Nota: : Quando esta função for usada emuma instrução condicional (SE), a instruçãoserá a parte que contém a condição, não obloco condicional inteiro. Após um errosecundário, a execução continuará com apróxima instrução. O processamento do TInão tem conhecimento de que ele estava emuma condicional quando o erro secundáriofoi processado, portanto, a próximainstrução é a próxima linha, não a linhadepois de endif.

Para evitar esta situação, use variáveis paraqualquer operação que possa encontrar umerro secundário e, em seguida, use asvariáveis na instrução condicional. Porexemplo:

V1 = CELLGETN(’PNLCube’, ’fred’,’argentina’,’Sales’,’Jan’);IF(V1 = 454);ASCIIOUTPUT(’bug.txt’, ’if logic not workingproperly’);

ENDIF;

Exemplo

ATTRN('Model', 'L Series 1.8L Sedan', 'Engine Size')

Neste exemplo, a função retorna o valor numérico do atributo Tamanho do Motordo elemento Sedã Série L 1.8L na dimensão do Modelo.

ATTRSATTRS retorna um atributo de sequência para um elemento especificado de umadimensão.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeATTRS(dimension, element, attribute)

Argumento Descrição

dimensão Um nome de dimensão válido.

element Um elemento da dimensão.

atributo O atributo para o qual você deseja recuperarum valor. Este argumento deve ser umatributo válido do elemento.

Capítulo 3. Funções das Regras 131

Page 146: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Exemplo

ATTRS('plan_business_unit', '10100', 'Currency')

Neste exemplo, a função retorna o valor de sequência do atributo Moeda doelemento 10100 na dimensão plan_business_unit.

ConsolidateChildrenConsolidateChildren força valores consolidados a serem calculados somando ofilho imediato em uma dimensão especificada.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

ConsolidateChildren é útil quando consolidações intermediárias são calculadas porregras e você quer que uma consolidação pai seja calculada somando asconsolidações intermediárias em vez de somar os valores de folha subjacentes.

SintaxeConsolidateChildren(DimName1, DimName2, ...)

Argumento Descrição

DimName1, DimName2, ... Nomes das dimensões nas quais asconsolidações serão executadas.

A função requer pelo menos um argumentoDimName e pode aceitar a mesmaquantidade de argumentos DimName e dedimensões no cubo para o qual a regra égravada.

Exemplo

Considere um cubo chamado Sales formado pelas dimensões ActVsBud, Região,Modelo, Account1 e Mês.

Neste exemplo, a dimensão Mês é definida da seguinte forma:

132 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 147: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Se nenhuma regra estiver em operação para este cubo, o valor da consolidaçãoAno será calculado, somando todos os valores de folha subjacentes, neste caso, Jana Dez. A figura a seguir ilustra esta consolidação.

Agora, suponha que você crie a seguinte regra para este cubo, que indica quetodos os valores trimestrais devem ser 1:[{’1 Quarter’, ’2 Quarter’, ’3 Quarter’, ’4 Quarter’}]=1;

O resultado é o seguinte:

Na figura, você pode ver que os valores trimestrais são de fato calculados pelaregra, mas a consolidação Ano ainda é calculada somando todos os valores defolha subjacentes. Se este não for o seu caminho de cálculo desejado, você poderáusar a função ConsolidateChildren para forçar o TM1 a calcular a consolidaçãoAno, somando seus filhos imediatos, especificamente 1 Trimestre, 2 Trimestres, 3Trimestres e 4 Trimestres.[’Year’]=ConsolidateChildren(’Month’);[{’1 Quarter’, ’2 Quarter’, ’3 Quarter’, ’4 Quarter’}]=1;

Na regra, a instrução [’Year’]=ConsolidateChildren(’Month’) diz que aconsolidação Ano deve ser calculada somando-se os filhos imediatos do Ano nadimensão Mês.

Capítulo 3. Funções das Regras 133

Page 148: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

A figura a seguir mostra o resultado da instrução[’Year’]=ConsolidateChildren(’Month’):

Observe que a consolidação Ano agora é calculada somando seus filhos imediatos.

É importante lembrar que, para uma determinada consolidação, a funçãoConsolidateChildren é aplicável apenas aos filhos imediatos da consolidação.

A função ConsolidateChildren também pode ser usada para especificar como asconsolidações são calculadas em várias dimensões, como no exemplo a seguir:

Argumento Descrição

['World','Year']=ConsolidateChildren('Region','Month')

Esta instrução aplica a funçãoConsolidateChildren às consolidaçõesMundo e Ano. Neste caso, Mundo écalculado somando todos os seus filhosimediatos na dimensão Região, enquantoAno é calculado somando seus filhosimediatos na dimensão Mês.

DIMNMDIMNM retorna o elemento de uma dimensão que corresponde ao argumento deíndice.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeDIMNM(server_name:dimension, index)

Argumento Descrição

dimensão Um nome de dimensão válido qualificadopelo nome do servidor.

índice Um valor menor ou igual ao número deelementos na dimensão.

Se este argumento for menor que 1 ou maiorque o número de elementos na dimensão, afunção retornará 0.

Exemplo

DIMNM(planning_sample:'Region',2)

134 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 149: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Este exemplo retorna 'Bélgica', que é o elemento na dimensão Região com umvalor de índice de 2.

DIMSIZO DIMSIZ retorna o número de elementos em uma dimensão especificada.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeDIMSIZ(dimension)

Argumento Descrição

dimensão Um nome de dimensão válido.

Algumas instalações podem precisarqualificar o nome da dimensão com o nomedo servidor, como emserver_name:dimension.

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 comoum argumento para a função.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeDNEXT(dimension, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

Algumas instalações podem precisarqualificar o nome da dimensão com o nomedo servidor, como emserver_name:dimension.

element O nome de um elemento na dimensão. Esteargumento também pode ser o nome de umalias para um elemento de dimensão.

Exemplo

DNEXT("Location","Oregon")

Capítulo 3. Funções das Regras 135

Page 150: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Se a dimensão Local contiver os elementos ordenados Califórnia, Oregon eWashington, o exemplo retornará Washington.

DNLEVDNLEV retorna os níveis de número em uma dimensão.

Esta é uma função de regras do TM1, válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeDNLEV(dimension)

Argumento Descrição

dimensão Um nome de dimensão válido.

Algumas instalações podem precisarqualificar o nome da dimensão com o nomedo servidor, como emserver_name:dimension.

ExemploDNLEV(’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ão incluídas em super-regiões (Nível 2) que, por sua vez, sãoincluídas no mundo (Nível 3).

Existem quatro níveis na dimensão Região, portanto, o exemplo retorna o valor 4.

TABDIMTABDIM retorna o nome da dimensão que corresponde ao argumento de índice.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

136 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 151: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeTABDIM(cube, index)

Argumento Descrição

cubo Um nome de cubo válido.

índice Um valor positivo menor ou igual ao totalde dimensões no cubo.

Exemplo

TABDIM('SalesCube',3)

O cubo SalesCube contém cinco dimensões: account1, actvsbud, modelo, mês eregião. O exemplo retorna modelo, a terceira dimensão de SalesCube.

Funções de Regras de Informações de ElementosFunções de regras que gerenciam informações de elementos.

DIMIXO DIMIX retorna o número de índice de um elemento em uma dimensão.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeDIMIX(server_name:dimension, element)

Argumento Descrição

dimensão Um nome de dimensão válido qualificadopelo nome do servidor.

element O nome de um elemento na dimensão.

Se o elemento não for membro da dimensãoespecificada, a função retornará 0.

Exemplo

DIMIX(planning_sample:'Region','Brazil')

Brasil possui um valor de índice de três na dimensão Região. O exemplo retorna 3.

DTYPEDTYPE retorna informações sobre o tipo de elemento de um elemento especificado.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

Capítulo 3. Funções das Regras 137

Page 152: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

DTYPE retorna N se o elemento for um elemento numérico, S se o elemento forum elemento de sequência e C se o elemento for um elemento consolidado.

SintaxeDTYPE(dimension, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento O nome de um elemento na dimensão.

Exemplo

DTYPE('Region','Europe')

O elemento Europa é um elemento consolidado da dimensão Região, portanto, oexemplo retorna C.

ELCOMPO ELCOMP retorna o nome de um filho de elemento consolidado em umadimensão especificada.

Esta é uma função de regras do TM1, válida em regras do TM1 e em processos doTurbo Integrator.

Se o argumento do elemento não for um elemento consolidado, a função retornará0.

SintaxeELCOMP(dimension, element, position)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento O nome de um elemento consolidado nadimensão.

posição Um valor positivo menor ou igual ao totalde filhos no elemento especificado.

Exemplo

ELCOMP('Region','Central Europe',2)

Na dimensão Região, o elemento consolidado Europa Central é uma consolidaçãodos filhos França e Alemanha. Alemanha é a segunda posição nesta consolidação.De forma apropriada, o exemplo retorna Alemanha.

ELCOMPNO ELCOMPN retorna o número de componentes em um elemento especificado.

138 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 153: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

Se o argumento do elemento não for um elemento consolidado, a função retornará0.

SintaxeELCOMPN(dimension, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento O nome de um elemento consolidado nadimensão.

Exemplo

ELCOMPN('Region','Scandanavia')

Na dimensão Região, o elemento Escandinávia é uma consolidação de trêselementos. O exemplo retorna 3.

ELISANCELISANC determina se element1 é um antecessor de element2 na dimensãoespecificada.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

A função retorna 1 se element1 for um antecessor de element2, caso contrário, afunção retorna 0.

SintaxeELISANC(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

ELISANC('Region', 'Europe', 'Germany')

Na dimensão Região, o elemento Europa é um antecessor de Alemanha. Oexemplo retorna 1.

Capítulo 3. Funções das Regras 139

Page 154: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

ELISCOMPO ELISCOMP determina se o elemento1 é um filho do elemento2 na dimensãoespecificada.

Esta é uma função de regras do TM1, válida em regras do TM1 e em processos doTurbo Integrator.

A função retorna 1 se element1 for um filho de element2, caso contrário, a funçãoretorna 0.

SintaxeELISCOMP(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

ELISCOMP('Region','Germany','Central Europe')

Na dimensão Região, o elemento Europa Central é uma consolidação de doiselementos, Alemanha e França. O exemplo retorna 1.

Nota: esta função retorna 1 apenas para filhos imediatos. No exemplo acima,Alemanha é um filho de Europa Central. Além disso, Europa Central é um filho deEuropa. No entanto, como a função retorna 1 apenas para filhos imediatos, oexemplo a seguir retorna 0:

ELISCOMP('Region','Germany','Europe')

ELISPARO ELISPAR determina se o elemento1 é um pai do elemento2 na dimensãoespecificada.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

A função retorna 1 se element1 for um pai de element2, caso contrário, a funçãoretorna 0.

SintaxeELISPAR(dimension, element1, element2)

Argumento Descrição

dimensão Um nome de dimensão válido.

140 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 155: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

elemento1 O nome de um elemento na dimensão.

elemento2 O nome de um elemento na dimensão.

Exemplo

ELISPAR('Region','Central Europe','Germany')

Na dimensão Região, o elemento consolidado Europa Central é o pai de Alemanhae França. De forma apropriada, o exemplo retorna 1.

Nota: esta função retorna 1 apenas para pais imediatos. No exemplo acima,Europa é um pai de Europa Central. Além disso, Europa Central é um pai deAlemanha. No entanto, como Europa não é um pai imediato de Alemanha, oexemplo a seguir retorna 0:

Nota: ELISPAR('Region','Europe','Germany')

ELLEVO ELLEV retorna o nível de um elemento em uma dimensão.

Esta é uma função de regras do TM1, válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeELLEV(dimension, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

element O nome de um elemento na dimensão.

ExemploELLEV(’Region’,’Europe’)

Na dimensão Região, as nações individuais (Nível 0) somam-se às regiões (Nível1). As regiões são então incluídas em super-regiões (Nível 2) que, por sua vez, sãoincluídas no mundo (Nível 3). O exemplo retorna 2, pois Europa é um elemento deNível 2.

Capítulo 3. Funções das Regras 141

Page 156: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

ELPARO ELPAR retorna o pai de um elemento em uma dimensão especificada

Esta é uma função de regras do TM1, válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeELPAR(dimension, element, index)

Argumento Descrição

dimensão Um nome de dimensão válido.

element O nome de um elemento na dimensão.

índice Um valor positivo menor ou igual aonúmero total de elementos consolidados(pais) que usam o argumento do elementocomo um filho.

Exemplo

ELPAR('Model','Wagon 4WD',2)

Na dimensão Modelo, o elemento Wagon 4x4 é um filho de Total de Wagons e deTotal de 4x4. Portanto, Total de Wagons e Total de 4x4 são pais de Wagon 4x4. Naestrutura da dimensão do Modelo, Total de Wagons é definido primeiro, Total de4x4 é definido em segundo lugar.

O exemplo retorna Total de 4x4, pois esta é a segunda instância de um pai paraWagon 4x4 na dimensão do Modelo.

ELPARNO ELPARN retorna o número de pais de um elemento em uma dimensãoespecificada.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

142 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 157: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeELPARN(dimension, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

element O nome de um elemento na dimensão.

Exemplo

ELPARN('Model','Wagon 4WD')

Na dimensão do Modelo, o elemento Wagon 4x4 é um filho de Total de Wagons ede Total de 4x4. Portanto, Total de Wagons e Total de 4x4 são pais de Wagon 4x4.A função retorna 2.

ELWEIGHTO ELWEIGHT retorna o peso de um filho em um elemento consolidado.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeELWEIGHT(dimension, element1, element2)

Argumento Descrição

dimensão Um nome de dimensão válido.

element1 O nome de um elemento consolidado nadimensão.

element2 O nome de um filho do elementoconsolidado.

Exemplo

ELWEIGHT('Account1','Gross margin','Variable Costs')

O elemento Custos Variáveis, que é um filho de Margem bruta, possui um peso de-1.

O exemplo retorna -1.

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.

Capítulo 3. Funções das Regras 143

Page 158: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

Uma anuidade é uma série de pagamentos feitos em intervalos iguais de tempo.Os pagamentos devem ser feitos no final de cada período.

SintaxeFV(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

FV(1000,.14,5)

Este exemplo retorna o valor de uma anuidade no final de 5 anos, compagamentos de R$ 1.000 por ano com 14% de juros.

PAYMTPAYMT retorna a quantia de pagamento de uma anuidade com base em umdeterminado valor ou principal, em uma taxa de juros e em uma quantidade deperíodos. Uma anuidade é uma série de pagamentos feitos em intervalos iguais detempo.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxePAYMT(principal, interest, periods)

Argumento Descrição

principal O valor presente, ou a quantia total que éequivalente no momento a uma série depagamentos futuros.

interest A taxa de juros paga por período.

periods O número de períodos na anuidade. Ospagamentos devem ser feitos no final decada período.

Exemplo

PAYMT(100000, .14, 5)

144 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 159: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Este exemplo retorna o pagamento em uma anuidade de 5 anos, que é pagoanualmente, com um principal de R$ 100.000 com 14% de juros.

VPPV retorna o valor inicial ou principal de uma anuidade.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxePV(payment, interest, periods)

Argumento Descrição

payment A quantia do pagamento feito.

interest A taxa de juros paga por período.

periods O número de períodos na anuidade. Ospagamentos devem ser feitos no final decada período.

Exemplo

PV(1000, .14, 5)

Este exemplo retorna o valor principal de uma anuidade com 5 pagamentos anuaisde R$ 1.000 com 14% de juros.

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 queuma regra subsequente com a mesma definição de área seja executada.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

Normalmente, o TM1 executa apenas a primeira regra encontrada para umadeterminada área.

SintaxeCONTINUE

Argumentos

Nenhum.

Capítulo 3. Funções das Regras 145

Page 160: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Exemplo

['Jan']= if(!region @= 'Argentina',10,CONTINUE);

['Jan']=20;

Neste exemplo, a todas as células identificadas por Janeiro e Argentina é designadoum valor de 10. Às cé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 valorse ela for FALSE.

Esta é uma função de regras do TM1 , válida apenas em regras do TM1 . (O TurboIntegrator usa sua própria função SE que é capaz de avaliar várias expressõeslógicas.)

SintaxeIF(expression, true_value, false_value)

Argumento Descrição

expression Qualquer valor ou expressão que pode seravaliada como TRUE ou FALSE.

true_value Um valor que é retornado se a expressão forTRUE.

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 em regras do TM1 . Estafunção não pode ser usada em processos do Turbo Integrator.

SintaxeSTET

Argumentos

Nenhum.

146 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 161: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Exemplo

['Sales'] = IF(!Region @= 'France',STET, 100);

Neste exemplo, a regra indica que o valor para Vendas é sempre 100, exceto para ainterseção de Vendas e o elemento França da dimensão Região.

Funções de Regras MatemáticasOperadores matemáticos para usar em regras.

ABSABS retorna o valor absoluto de um número.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeABS(x)

Argumento Descrição

x O número para o qual você deseja localizaro valor absoluto.

Exemplo

ABS(-1.2) retorna 1.2

ACOSACOS retorna o ângulo, em radianos, cujo cosseno é x.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeACOS(x)

Argumento Descrição

x O cosseno do ângulo que você desejalocalizar. x deve estar entre -1 e 1; casocontrário, a função retornará um erro.

Exemplo

ACOS(0) retorna 1.5708.

ASENASIN retorna o ângulo, em radianos, cujo seno é x.

Capítulo 3. Funções das Regras 147

Page 162: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeASIN(x)

Argumento Descrição

x O seno do ângulo que você deseja localizar.x deve estar entre -1 e 1; caso contrário, afunção retornará 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 é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeATAN(x)

Argumento Descrição

x A tangente do ângulo que você desejalocalizar.

Exemplo

ATAN(1) retorna .7854.

COSCOS retorna o cosseno de um ângulo expresso em radianos.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeCOS(x)

Argumento Descrição

x Um ângulo, expresso em radianos, para oqual você deseja localizar o cosseno.

148 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 163: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Exemplo

COS(0) retorna 1.

EXPEXP retorna o antilogaritmo natural de um número.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeEXP(x)

Argumento Descrição

x Um número para o qual você desejalocalizar o antilogaritmo natural.

Exemplo

EXP(1) retorna 2.71828.

INTINT retorna o maior número inteiro que é menor ou igual a um valor especificado.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeINT(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 é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

Capítulo 3. Funções das Regras 149

Page 164: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeISUND(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 é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeLN(x)

Argumento Descrição

x Um número positivo. A função retorna umerro se x for negativo ou zero.

Exemplo

LN(10) retorna 2.302585093.

LOGLOG retorna o logaritmo de base 10 de um número positivo.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeLOG(x)

Argumento Descrição

x Um número positivo. A função retorna umerro se x for negativo ou zero.

Exemplo

LOG(10) retorna 1.

150 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 165: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

MÁXIMOMAX retorna o maior número em um par de valores.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeMAX(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 é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeMIN(num1, num2)

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 é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

Capítulo 3. Funções das Regras 151

Page 166: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeMOD(number, divisor)

Argumento Descrição

number O número para o qual você deseja localizaro resto.

divisor O valor pelo qual o argumento do número édividido.

Exemplo

MOD(10, 3) retorna 1.

ALEATÓRIOALEATÓRIO gera um número aleatório distribuído uniformemente entre 0 e 1.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

O gerador de número aleatório é distribuído quando o TM1 é carregado.

SintaxeRAND.

Argumentos

Nenhum.

Exemplo

RAND gera um número aleatório que é distribuído de maneira uniforme entre 0 e1

ARREDROUND arredonda um número especificado para o número inteiro mais próximo.O arredondamento pode ser feito de diversas formas válidas.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

A forma mais básica de arredondamento é substituir um número arbitrário por umnúmero inteiro. Há muitas formas de arredondar um número y para um númerointeiro q.

As mais comuns são:v Arredondar para o mais próximo

q é o número inteiro mais próximo de y (consulte "Arredondar acima de zero"para obter regras de desempate).

v Arredondar em direção a zero (ou truncar)q é a parte inteira de y, sem os dígitos fracionais.

152 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 167: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

v Arredondar para baixo (ou obter o piso)q é o número inteiro maior que não excede y.

v Arredondar para cima (ou obter o limite)q é o menor inteiro que não é menos do que y.

v Arredondar acima de zero

Se y for um número inteiro, q é y; do contrário, q é o número inteiro maispróximo de 0 e de tal forma que y está entre 0 e q.

O Turbo Integrator usa, essencialmente, o método Arredondar para baixo de floor(x+ .5). O Microsoft Excel utiliza o método Arredondar para o mais próximo. Issopode resultar em números inteiros diferentes, dependendo de estar usando umprocesso do Turbo Integrator ou trabalhando no Excel.

SintaxeROUND(number)

Argumento Descrição

número O número que você deseja arredondar.

Exemplo

ROUND(1.46) retorna 1.

ROUNDPROUNDP arredonda um número especificado em uma precisão decimalespecificada.

Esta é uma função de regras do TM1, válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeROUNDP(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 forpositivo, a função arredondará o númeroespecificado de dígitos à direita do pontodecimal. Se este argumento for negativo, afunção arredondará o número especificadode dígitos à esquerda do ponto decimal.

O argumento decimal deve estar entre -15 e15, inclusive.

Capítulo 3. Funções das Regras 153

Page 168: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

A função retorna 1 se o número for positivo, -1 se o número for negativo e 0 se onúmero for zero.

SintaxeSIGN(number)

Argumento Descrição

número Um número.

Exemplo

SIGN(-2.5) retorna -1.

SENSIN retorna o seno de um determinado ângulo.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeSIN(x)

Argumento Descrição

x Um valor, expresso em radianos, para o qualvocê deseja o seno.

Exemplo

SIN(1.5708) retorna 1.

RAIZSQRT retorna a raiz quadrada de um determinado valor.

154 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 169: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeSQRT(x)

Argumento Descrição

x Qualquer valor positivo. SQRT retorna umerro se x for negativo.

Exemplo

SQRT(16) retorna 4.

TANTAN retorna a tangente de um determinado ângulo.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeTAN(x)

Argumento Descrição

x Um valor, expresso em radianos, para o qualvocê 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 é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeCAPIT(string)

Argumento Descrição

sequência Uma sequência de texto.

Capítulo 3. Funções das Regras 155

Page 170: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Exemplo

CAPIT('first quarter sales') retorna 'First Quarter Sales'.

CARACTCHAR retorna o caractere identificado por um determinado código numéricoASCII.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeCHAR(number)

Argumento Descrição

number Um número de código ASCII. Este númerodeve estar entre 1 e 255, inclusive.

Exemplo

CHAR(100) retorna 'd'.

CÓDIGOCODE retorna o código numérico ASCII para um caractere especificado em umasequência.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeCODE(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 ovalor de código ASCII.

Exemplo

CODE('321', 2) retorna 50.

CODE('End', 3) retorna 100.

156 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 171: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

DELETDELET retorna o resultado da exclusão de um número especificado de caracteresde um ponto de início especificado em uma sequência.

Esta é uma função de regras do TM1, válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeDELET(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.

Exemplo

DELET('payment', 3, 3) retorna 'pant'.

FILLFILL repete uma determinada sequência, conforme necessário, para retornar umasequência de um comprimento especificado.

Esta é uma função de regras do TM1, válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeFILL(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 que seja 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çãoespecificado.

Capítulo 3. Funções das Regras 157

Page 172: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Esta é uma função de regras do TM1, válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeINSRT(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ê desejainserir string1. A função insere string1 emstring2 imediatamente antes do caractereespecificado.

Exemplo

INSRT('ABC', 'DEF', 2) retorna 'DABCEF'.

LONGLONG retorna o comprimento de uma sequência.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeLONG(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 emminúsculos.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeLOWER(string)

Argumento Descrição

sequência Uma sequência de texto.

158 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 173: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Exemplo

LOWER('First Quarter Sales') retorna 'first quarter sales'.

NUMBRNUMBR converte uma sequência em um número.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

A sequência transmitida para a função NUMBR deve usar . (ponto) como oseparador decimal e , (vírgula) como o separador de milhares. Qualquer outroseparador decimal/de milhares causará resultados incorretos.

SintaxeNUMBR(string)

Argumento Descrição

sequência A sequência que você deseja converter emum número. Todos os caracteres diferentesde '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 inicial da primeira ocorrência de umasubsequência especificada em uma determinada sequência.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

Se a subsequência não ocorrer na sequência especificada, a função retornará zero.

SintaxeSCAN(substring, string)

Argumento Descrição

subsequência A subsequência que você está tentandolocalizar.

sequência A sequência na qual você está procurando asubsequência.

Capítulo 3. Funções das Regras 159

Page 174: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Exemplo

SCAN('scribe', 'described') retorna 3.

STRSTR converte um número em uma sequência.

Esta é uma função de regras do TM1, válida em regras do TM1 e em processos doTurbo Integrator.

O número transmitido para a função STR deve usar . (ponto) como o separadordecimal e , (vírgula) como o separador de milhares. Qualquer outro separadordecimal/de milhares causará resultados incorretos.

SintaxeSTR(number, length, decimal)

Argumento Descrição

number O número que está sendo convertido emuma sequência.

comprimento O comprimento da sequência. Se necessário,a função insere espaços em branco àesquerda para obter este comprimento.

decimal O número de casas decimais a seremincluídas no resultado da função.

Exemplo

STR(3.14159, 6, 2) retorna ' 3.14'.

STR(-3.14159, 6, 0) retorna ' -3'.

SUBSTSUBST retorna uma subsequência de uma determinada sequência.

Esta é uma função de regras do TM1, válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeSUBST(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.

160 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 175: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

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 deuma sequência.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeTRIM(string)

Argumento Descrição

sequência Uma sequência de texto.

Exemplo

TRIM(' First Quarter ') retorna 'First Quarter'.

MAIÚSCULAUPPER converte uma sequência de texto em maiúsculas.

Esta é uma função de regras do TM1 , válida em regras do TM1 e em processos doTurbo Integrator.

SintaxeUPPER(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.

Capítulo 3. Funções das Regras 161

Page 176: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

FEEDERSAo usar uma declaração SKIPCHECK para restaurar a consolidação espalhada emuma regra do TM1 , você também deve assegurar que todas as células derivadasde regras sejam identificadas por instruções do alimentador. Para isso, insira umadeclaração FEEDERS imediatamente após todas as instruções de regras:FEEDERS;

Imediatamente após a declaração FEEDERS, você deve criar instruções dealimentadores que identificam as células derivadas de regras no cubo.

Para obter uma discussão completa das regras do TM1, inclusive consolidaçãoespalhada e a criação de alimentadores, consulte o IBM Cognos TM1 Rules Guide.

FEEDSTRINGSOs valores de sequência gerados por regras não são exibidos quando umavisualização tem supressão de zeros, a menos que a sequência resida em umacélula alimentada. Para ativar a alimentação de células de sequência, insira adeclaração FEEDSTRINGS como a primeira linha de sua regra.FEEDSTRINGS;

Quando esta declaração estiver em operação, será possível configuraralimentadores para células de sequência em uma visualização do cubo, e contarcom a sequência que ficará disponível para outras regras, mesmo que avisualizaçã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 emsua regra.

Como no caso de alimentadores numéricos, uma alimentação para uma célulaconsolidada resulta na alimentação de todos os componentes da consolidação.Como é possível armazenar sequências em células consolidadas, você deve daruma atenção especial se tais células forem usadas para alimentar outras células. Ouso excessivo de alimentadores de sequência pode resultar em explosões decálculos e em um desempenho do aplicativo insatisfatório.

Para obter uma discussão completa das regras do TM1, inclusive a criação dealimentadores, consulte o IBM Cognos TM1 Rules Guide.

SKIPCHECKÉ possível restaurar a consolidação espalhada e melhorar o desempenho inserindouma declaração SKIPCHECK no início da regra TM1 .

Durante consolidações, o TM1 usa um algoritmo de consolidação dispersa paraignorar todas as células que contêm zero ou estão vazias. Este algoritmo acelera oscálculos de consolidação em cubos que são altamente dispersos. Um cubo dispersoé um cubo no qual o número de células preenchidas como uma porcentagem dototal de células é baixo.

Ao consolidar dados em cubos que possuem regras definidas, o TM1 desativa estealgoritmo de consolidação dispersa, porque uma ou mais células vazias podem defato ser calculadas por uma regra. (Ignorar células calculadas por regras resultaráem totais consolidados incorretos). Quando o algoritmo de consolidação dispersafor 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;

162 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 177: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Se sua regra usar uma instrução FEEDSTRINGS, a instrução SKIPCHECK deveráser a segunda instrução na regra. Se sua regra não usar uma instruçãoFEEDSTRINGS, a instrução SKIPCHECK deverá ser a primeira instrução na regra.

Ao usar SKIPCHECK para restaurar a consolidação espalhada, você também deveassegurar que sua regra inclua uma declaração FEEDERS e que todas as célulasderivadas de regras sejam identificadas por instruções do alimentador.

Para obter uma discussão completa das regras do TM1, inclusive consolidaçãoespalhada e a criação de alimentadores, consulte o IBM CognosTM1 Rules Guide.

Capítulo 3. Funções das Regras 163

Page 178: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

164 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 179: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Capítulo 4. Funções de Macro

O IBM CognosTM1 inclui um conjunto de funções de macro que podem serincorporadas em macros do Excel. É possível usar funções de macro para acessarservidores, dados e estruturas do cubo e opções do TM1 .

Nota: Antes de executar estas macros, você deve carregar o Suplemento do TM1(Tm1p.xla).

As seguintes funções de macro são descritas nesta seção:

Acessando Funções de MacroO produto que está sendo usado determina a forma como as funções de macro doTM1 são acessadas.

Acessando Funções de Macro do Excel Versões 5 e 7Acesse funções macro do Microsoft Excel versões 5 e 7.

Procedimento1. Escolha Inserir, Macro, Macro do MS Excel 4.0.2. Escolha Inserir, Função.3. Selecione TM1 da caixa de Categoria da Função.4. Clique duas vezes na função que você deseja inserir na caixa de listagem Nome

da Função.5. Digite os argumentos apropriados na caixa de diálogo Assistente de Função.6. Clique em Concluir para copiar a função completa para a célula atual na

planilha de macro.

Acessando Funções de Macro do Excel Versão 8 e maisRecente

Acesse funções de macro do Microsoft Excel versão 8 e posterior.

Procedimento1. 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. Escolha Inserir, Função.5. Selecione TM1 na caixa de categoria da Função.6. Clique duas vezes na função que deseja inserir a partir da caixa Nome da

Função.7. Digite os argumentos apropriados na Paleta de Fórmulas.8. Clique em OK para copiar a função completa para a célula atual na planilha de

macro.

© Copyright IBM Corp. 2007, 2013 165

Page 180: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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, ...)

ExemploSub 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 deelementos na dimensão Região. O elemento selecionado preenche uma célula naplanilha Planilha1.

D_PICKD_PICK chama uma caixa de diálogo que lista todas as dimensões disponíveis nodiretório de dados local e em servidores remotos conectados.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

A dimensão selecionada na caixa de diálogo torna-se o valor da função D_PICK.

SintaxeD_PICK

Argumentos

Nenhum.

DBProportionalSpreadDBProportionalSpread distribui um valor especificado para as folhas de umaconsolidação proporcional aos valores de célula existentes.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

A função é análoga ao método de difusão de dados em difusão proporcional, queestá descrito em detalhes no Guia do Usuário do IBM CognosTM1 .

SintaxeDBProportionalSpread( value, server:cube, e1, e2, e3...,e16 )

Argumento Descrição

valor O valor que você deseja distribuir.

166 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 181: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

servidor:cubo O nome do cubo, prefixado com o nome doservidor apropriado, no qual você desejadistribuir o valor.

Por exemplo, para distribuir valores para ocubo Sales no servidor de Contabilidade,especifique Accounting: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 Series1.8L Sedan", "Sales", "1 Quarter" )

Este exemplo distribui o valor 2000 para os filhos da consolidação identificadospelos elementos Real, Argentina, Sedã Série S 1.8L, Vendas e 1 Trimestre. Eledistribui valores para o cubo Sales no servidor de Contabilidade.

D_FSAVED_FSAVE permite criar ou atualizar dimensões muito grandes cujas planilhas dedimensões excederiam o limite da linha de uma planilha do Excel.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

Para usar a função D_FSAVE, crie um arquivo ASCII delimitado, chamado dim.dit,em que dim é o nome da dimensão que você deseja criar ou atualizar. Este arquivodeve residir no diretório de dados local.

A estrutura do arquivo ASCII deve corresponder a uma planilha de dimensões, daseguinte forma:v Inclua três campos por linha.v 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 componentede consolidação).

v No segundo campo, especifique o nome de elemento.v 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. NoWindows, esse delimitador é definido pela entrada de Separador de Lista nadiálogo de Propriedades de Configuração Regional.

Se houver erros na estrutura do arquivo ASCII, tais como, elementos fora do lugarou indefinidos, será exibida uma mensagem de erro.

Por exemplo

Capítulo 4. Funções de Macro 167

Page 182: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeD_FSAVE(file)

Argumento Descrição

arquivo O nome de um arquivo ASCII delimitadoque tem a extensão do arquivo .dit. Nãoinclua a extensão do arquivo. Este arquivodeve residir no diretório de dados local doTM1 .

Exemplo

=D_FSAVE("Region")

Este exemplo lê um arquivo ASCII chamado Region.dit e cria ou atualiza adimensão Região.

Nota: D_FSAVE pode ser usada para criar ou atualizar dimensões em servidoresremotos. No entanto, a função sempre procura o arquivo .dit no diretório de dadoslocal (conforme definido no Tm1p.ini). Certifique-se de que o arquivo .dit para adimensão que você deseja criar/atualizar resida em seu diretório de dados local,em seguida, especifique o servidor no qual deseja criar/atualizar a dimensão,prefixando o arquivo .dit com o nome do servidor.

=D_FSAVE("TM1Serv:Region")

procura um arquivo chamado Region.dit no diretório de dados do servidor local,mas grava a dimensão Região no diretório de dados para o servidor TM1Serv.

D_SAVED_SAVE salva a planilha ativa como um arquivo de planilha de dimensões(dim.xdi).

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

O nome da pasta de trabalho é usado como o nome do arquivo. O TM1 então criaou atualiza a dimensão especificada pelo nome da pasta de trabalho.

Se a planilha ativa não estiver em conformidade com um formato de planilha dedimensões ou não contiver algumas informações, será exibida uma mensagem deerro. Por exemplo, você deve definir todos os elementos usados em umaconsolidação de nível 1 como elementos numéricos (N).

SintaxeD_SAVE

Argumentos

Nenhum.

168 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 183: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

E_PICKE_PICK chama o Editor de Subconjunto listando todos os elementos na dimensãoespecificada.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

O nome de elemento selecionado no Editor de Subconjunto torna-se o valor deretorno da função E_PICK.

SintaxeE_PICK(Dimension, Alias, Subset, Element)

Argumento Descrição

Dimensão Um nome de dimensão válido. A dimensãopode residir no diretório de dados local ouem um servidor remoto ao qual estejaconectado.

Use um prefixo de nome do servidor paraindicar o local do servidor. Para o servidorlocal, especifique local:dim. Para umservidor remoto, especifiqueservername:dim.

Alias O nome de um alias existente para osubconjunto. Quando este parâmetro fordefinido, o alias será aplicado quando osubconjunto for aberto no Editor deSubconjunto e a função retornar o alias parao elemento selecionado.

Se optar por não definir um parâmetroAlias, você deverá transmitir uma sequênciavazia para a função.

Subconjunto O nome do subconjunto a ser aberto noEditor de Subconjunto quando E_PICK forchamada. O parâmetro Alias deve serfornecido para usar este parâmetro. Oparâmetro Alias pode ser definido comouma sequência vazia ("").

Se optar por não definir um parâmetroSubset, você deverá transmitir umasequência vazia para a função.

ElementNameOrIndex O nome ou número do índice do elemento aser pré-selecionado quando o Editor deSubconjunto for aberto.

Se optar por não definir um parâmetroElementNameOrIndex, você deverátransmitir uma sequência vazia para afunção.

Capítulo 4. Funções de Macro 169

Page 184: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Exemplo 1

=E_PICK("TM1SERV:Region"," "," "," ")

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 aliasDeutsche será aplicado e o elemento Argentina será pré-selecionado quando oEditor 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 de dimensão pré-selecionado.

I_EXPORTI_EXPORT exporta dados do cubo especificado para um arquivo ASCII delimitado,que é criado no diretório atual 'My Documents' do usuário. Na maioria dos casos,o diretório 'My Documents' é C:\Users\<user_name>\Documents.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

Nota: I_EXPORT aplica um bloqueio no servidor, evitando que outros usuáriosacessem o servidor durante a execução da função. Se esta função for usada paraexportar um cubo grande, o servidor poderá ficar inacessível por um longoperíodo de tempo.

SintaxeI_EXPORT(cube, file, zero, calcs)

Argumento Descrição

cubo Um nome de cubo válido. O cubo poderesidir em seu diretório de dados local ouem um servidor remoto ao qual você estáconectado. Use um prefixo de nome doservidor para indicar o local do servidor.Para o servidor local, especifique local:cube.Para um servidor remoto, especifiqueservername:cube.

arquivo O nome do arquivo ASCII delimitado a sercriado. É usada a extensão do arquivo .cma;não especifique-a.

zero Especifica se valores zero são incluídos.Especifique TRUE para incluí-los, FALSEpara excluí-los.

cálculos Especifica se valores calculados sãoincluídos. Especifique TRUE para incluí-los,FALSE para excluí-los.

170 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 185: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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 e valores calculados são incluídos.

I_NAMESI_NAMES pode ser usada para criar uma lista de nomes de elementos.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

Esta função lê por meio de um arquivo ASCII delimitado e grava todos os nomesexclusivos na coluna especificada para a coluna correspondente na planilha ativa.

SintaxeI_NAMES(file, column)

Argumento Descrição

arquivo O nome de um arquivo ASCII delimitado,cuja extensão do arquivo é .cma. Não incluaa extensão do arquivo.

coluna Um número que especifica o campo noarquivo ASCII a partir do qual ler nomes e acoluna na planilha ativa na qual esses nomessão gravados.

Exemplo

=I_NAMES("98Sales",3)

Este exemplo inspeciona o arquivo 98sales.cma. Todos os nomes exclusivos naterceira coluna são gravados na coluna C da planilha ativa.

I_PROCESSI_PROCESS lê os registros de um arquivo ASCII, um por vez, na primeira linha daplanilha ativa.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

Cada campo preenche uma célula diferente. A planilha é recalculada após a leituraem cada registro.

Capítulo 4. Funções de Macro 171

Page 186: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeI_PROCESS(file)

Argumento Descrição

arquivo O nome de um arquivo ASCII delimitado,cuja extensão do arquivo é .cma. Não incluaa extensão do arquivo.

Exemplo

=I_PROCESS("98Sales ")

Este exemplo lê em cada registro do arquivo 98sales.cma na primeira linha daplanilha ativa.

M_CLEARM_CLEAR limpa e recarrega todas as dimensões na memória. Ela não limpa oscubos e não reinicia o servidor.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

SintaxeM_CLEAR

Argumentos

Nenhum.

N_CONNECTN_CONNECT estabelece uma conexão com um servidor remoto.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

Se a conexão for bem-sucedida, N_CONNECT não retornará nenhum valor. Seuma conexão não puder ser estabelecida, serão retornadas mensagens de erro doservidor.

Nota: A função N_CONNECT não é suportada quando um servidor está usando oLogin Integrado ou a segurança do IBMCognos8 para autenticação. Essa funçãopode se conectar somente a um servidor que esteja configurado para usar aautenticação padrão do TM1 .

172 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 187: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeN_CONNECT(server, client, password)

Argumento Descrição

server O nome de um servidor remoto. Esteservidor deve ser registrado no ServidorAdministrativo ao qual seu cliente fazreferência.

cliente O nome de usuário que conecta-se aoservidor especificado.

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 do cliente USR2 e a senha Swordfish.

OPTGETOPTGET retorna o valor atual de uma opção no arquivo Tm1p.ini.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

SintaxeOPTGET(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 fazreferência.

AnsiFiles Retorna T se o conjunto de caracteres ANSIfor usado no momento para importar dadosde arquivos ASCII delimitados. Retorna F seo conjunto de caracteres ASCII for usado nomomento.

DataBaseDirectory Retorna o caminho completo para o diretóriode dados do servidor local.

Capítulo 4. Funções de Macro 173

Page 188: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Valores de Opção Válidos Descrição

GenDBRW Retorna F se a planilha da fatia contiverfórmulas DBR. Retorna T se a planilha dafatia contiver fórmulas DBRW.

NoChangeMessage Retorna T se esta opção for definida pararetornar a mensagem NENHUMAMUDANÇA quando uma fórmula DBSnapontar para uma célula de nível C. RetornaF se esta opção for definida como F.

Exemplo

=OPTGET("DataBaseDirectory")

Este exemplo retorna o caminho completo para o diretório de dados do servidorlocal.

N_DISCONNECTN_DISCONNECT desconecta você de todos os servidores remotos aos quais vocêestá conectado. A função não desconecta-o de seu servidor local.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

N_DISCONNECT retorna TRUE se ela desconectá-lo com êxito de todos osservidores aos quais você está conectado. Ela retorna FALSE se não puder fazer adesconexão de nenhum servidor remoto.

SintaxeN_DISCONNECT

Argumentos

Nenhum.

OPTSETOPTSET configura um valor para uma opção do TM1 especificada.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

SintaxeOPTSET(option, value)

Argumento Descrição

option Um nome de opção do TM1 válido.

value Um valor válido para a opção especificada.

174 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 189: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Valores de Opção Válidos Descrição

AdminHost Especifique o nome do Host Administradorno qual um Servidor Administrativo está emexecução.

AnsiFiles Especifique um valor que define o conjuntode caracteres usado durante importações dedados. Especifique T para usar o conjuntode caracteres ANSI. Especifique F para usaro conjunto de caracteres ASCII.

DataBaseDirectory Especifique um valor que configure ocaminho completo para o diretório de dadosdo servidor local.

GenDBRW Especifique um valor que determina qualfórmula o TM1 usa para vincular valores emplanilhas da fatia a cubos. Especifique Tpara gerar fórmulas DBRW quando asplanilhas da fatia forem criadas. EspecifiqueF para gerar fórmulas DBR.

NoChangeMessage Especifique um valor que determina se oTM1 exibirá a mensagem NENHUMAMUDANÇA quando uma fórmula DBSnapontar para uma célula de nível C.Especifique T para exibir a mensagem.Especifique F 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.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

Se você tentar publicar um subconjunto particular para o qual existe umsubconjunto público com nome idêntico, será solicitado que sobrescreva osubconjunto público existente.

Capítulo 4. Funções de Macro 175

Page 190: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxePublishSubset(dimension, subset)

Argumento Descrição

dimensão O nome prefixado pelo servidor dadimensão que contém o subconjuntoparticular que você deseja publicar. Porexemplo, para publicar um subconjunto dadimensão Região no servidor de Finanças,transmita "Finance:Region" como oargumento da dimensão.

subconjunto O nome do subconjunto particular que vocêdeseja publicar.

PublishViewPublishView publica uma visualização particular nomeada em um servidor.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

Esta função não pode publicar uma visualização particular que usa subconjuntosparticulares. Todos os subconjuntos particulares em uma visualização particulardevem primeiro ser publicados com a função de macro PublishSubset.

Se você tentar publicar uma visualização particular para a qual existe umavisualização pública com nome idêntico, será solicitado que sobrescreva avisualização pública existente.

SintaxePublishView(cube, view)

Argumento Descrição

cubo O nome prefixado pelo servidor do cuboque contém a visualização particular quevocê deseja publicar. Por exemplo, parapublicar uma visualização do cuboProjections no servidor de Finanças,transmita "Finance:Projections" como oargumento do cubo.

visualização O nome da visualização particular que vocêdeseja publicar.

QUDEFINEQUDEFINE configura e salva parâmetros para conjuntos de consultas do TM1 .

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

176 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 191: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

QUDEFINE equivale à criação de um conjunto de consultas usando a caixa dediálogo Extração de Visualização.

É possível executar consultas criadas com esta função usando a caixa de diálogoExtração de Visualização.

Também é possível usar o conjunto da consulta como um argumento para asfunções de macro QUEXPORT, QULOOP e QUSUBSET.

Nota: QUDEFINE aplica um bloqueio no servidor, evitando que outros usuáriosacessem o servidor durante a execução da função. Se esta função for usada paracriar uma consulta que inclua uma grande seção de um cubo, o servidor poderáficar inacessível por um longo período de tempo.

SintaxeQUDEFINE(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 paraindicar o local do servidor. Para o servidorlocal, especifique local:cube. Para umservidor remoto, especifiqueservername:cube.

consulta O nome do conjunto da consulta a ser salvopara uso futuro.

Capítulo 4. Funções de Macro 177

Page 192: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

intervalo Um intervalo de células da planilha queinclui uma coluna para cada dimensão nocubo. Quando você executar a consulta, oTM1 examinará apenas as células do cuboidentificadas pelos elementos especificadosou referidos no intervalo.

O intervalo deve conter uma coluna paracada dimensão no cubo. A ordem dascolunas deve ser igual à das dimensões nocubo.

Em cada coluna, especifique ou façareferência aos elementos a serem incluídos.Para incluir um subconjunto de elementos,liste os nomes de elementos ou especifiqueum nome do subconjunto. Escreva o nomedo subconjunto precedido pelo caracterebarra invertida (\). Por exemplo, \trimestreespecifica o subconjunto trimestre. Paraincluir todos os elementos em umadimensão (o subconjunto TODOS), deixe acoluna em branco.

As funções DBR podem ser usadas parapreencher as células no intervalo. Se asfunções retornarem valores em branco paraqualquer coluna no intervalo, QUDEFINEusará o subconjunto TODOS para adimensão associada a essa coluna.

LowLim O valor de célula mais baixo a serconsiderado para exportação.

HighLim O valor de célula mais alto a serconsiderado para exportação.

SkpZeroes Especifica se as células contendo zeros sãoignoradas. Especifique TRUE para excluí-las,FALSE para incluí-las.

SkpCons Especifica se as células contendo valoresconsolidados são ignoradas. EspecifiqueTRUE para 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 emPlanilha1, no intervalo de células B3:F5. Quando você executar esta consulta, oTM1 inspecionará apenas as células do cubo identificadas por estes elementos eexportará valores não consolidados no intervalo de 3000 a 5000.

178 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 193: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Nota: Se lowlim ou highlim for uma sequência formada de caracteres numéricos, oExcel exigirá que a sequência seja colocada entre uma série de quatro aspas duplase es comerciais únicos, da seguinte forma:""""&"0123"&""""

QUDEFINEEXQUDEFINEEX configura e salva parâmetros para conjuntos de consultas do TM1 .

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

É equivalente à criação de um conjunto da consulta usando a caixa de diálogoExtração de Visualização. Esta função é idêntica à macro QUDEFINE, com exceçãode que QUDEFINEEX inclui um argumento que permite excluir valores derivadosde regras da consulta.

É possível executar consultas criadas com esta função usando a caixa de diálogoExtração de Visualização.

Também é possível usar o conjunto da consulta como um argumento para asfunções de macro QUEXPORT, QULOOP e QUSUBSET.

Nota: QUDEFINEEX aplica um bloqueio no servidor, evitando que outros usuáriosacessem o servidor durante a execução da função. Se esta função for usada paracriar uma consulta que inclua uma grande seção de um cubo, o servidor poderáficar inacessível por um longo período de tempo.

SintaxeQUDEFINEEX(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 paraindicar o local do servidor. Para o servidorlocal, especifique local:cube. Para umservidor remoto, especifiqueservername:cube.

consulta O nome do conjunto da consulta a ser salvopara uso futuro.

Capítulo 4. Funções de Macro 179

Page 194: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

intervalo Um intervalo de células da planilha queinclui uma coluna para cada dimensão nocubo. Quando você executar a consulta, oTM1 examinará apenas as células do cuboidentificadas pelos elementos especificadosou referidos no intervalo.

O intervalo deve conter uma coluna paracada dimensão no cubo. A ordem dascolunas deve ser igual à das dimensões nocubo.

Em cada coluna, especifique ou façareferência aos elementos a serem incluídos.Para incluir um subconjunto de elementos,liste os nomes de elementos ou especifiqueum nome do subconjunto. Escreva o nomedo subconjunto precedido pelo caracterebarra invertida (\). Por exemplo, \trimestreespecifica o subconjunto trimestre. Paraincluir todos os elementos em umadimensão (o subconjunto TODOS), deixe acoluna em branco.

As funções DBR podem ser usadas parapreencher as células no intervalo. Se asfunções retornarem valores em branco paraqualquer coluna no intervalo, QUDEFINEEXusará o subconjunto TODOS para adimensão associada a essa coluna.

lowlim O valor de célula mais baixo a serconsiderado para exportação.

highlim O valor de célula mais alto a serconsiderado para exportação.

skpZeroes Especifica se as células contendo zeros sãoignoradas. Especifique TRUE para excluí-las,FALSE para incluí-las.

skpCons Especifica se as células contendo valoresconsolidados são ignoradas. EspecifiqueTRUE para excluí-las, FALSE para incluí-las.

skpRuleVals Especifica se as células contendo valoresderivados de regras são ignoradas.Especifique TRUE para excluí-las, FALSEpara incluí-las.

Exemplo

=QUDEFINEEX("local:SalesCube", "Topsell", Sheet1!B3:F5, 3000, 5000, TRUE, TRUE,FALSE)

180 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 195: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Este exemplo cria um conjunto da consulta que contém elementos listados emPlanilha1, no intervalo de células B3:F5. Quando você executar esta consulta, oTM1 inspecionará apenas as células do cubo identificadas por estes elementos eexportará valores não consolidados no intervalo de 3000 a 5000, incluindo osderivados por meio de regras.

Nota: Se lowlim ou highlim for uma sequência formada de caracteres numéricos, oExcel exigirá que a sequência seja colocada entre uma série de quatro aspas duplase es comerciais únicos, da seguinte forma:""""&"0123"&""""

QUEXPORTQUEXPORT exporta valores de células do cubo especificado para um arquivoASCII delimitado.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

Para criar o conjunto da consulta, use a função QUDEFINE.

Cada registro de saída possui o seguinte formato:v O nome do cubo que contém os valores exportadosv Nomes de elementos que identificam o local da célula de um único valor

exportadov O valor exportado

Para um cubo de cinco dimensões, o TM1 cria registros contendo sete campos:

"nome do cubo", "elem.1", "elem.2", "elem.3", "elem.4", "elem.5", valor

Nota: QUEXPORT aplica um bloqueio no servidor, evitando que outros usuáriosacessem o servidor durante a execução da função. Se esta função for usada paraexportar valores de um conjunto da consulta grande, o servidor poderá ficarinacessível por um longo período de tempo.

SintaxeQUEXPORT(cube, query, file)

Argumento Descrição

cubo O nome do cubo a ser consultado.

Use um prefixo de nome do servidor paraindicar o local do servidor. Para o servidorlocal, especifique local:cube. Para umservidor remoto, especifiqueservername:cube.

consulta O nome de um conjunto da consultaexistente.

Capítulo 4. Funções de Macro 181

Page 196: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

arquivo O nome do arquivo ASCII delimitado (.cma)para conter os dados do cubo exportados.Não inclua a extensão do arquivo. O arquivoé criado no diretó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ão gravados no arquivo Sedans.cma.

QULOOPQULOOP exporta dados que atendem aos critérios de conjunto de consulta docubo especificado.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

O TM1 lê em cada registro de saída, um de cada vez, na primeira linha da planilhaativa. Cada campo preenche uma célula diferente. A planilha é recalculada após aleitura em cada registro.

Cada registro de saída possui o seguinte formato:v O nome do cubo que contém os valores exportadosv Os nomes de elementos que identificam o local da célula de um único valor

exportadov O valor exportado

Para um cubo de cinco dimensões, o TM1 cria registros contendo sete campos:

"nome do cubo", "elem.1", "elem.2", "elem.3", "elem.4", "elem.5", valor

Use QULOOP juntamente com uma fórmula DBSn para preencher células em umcubo.

Nota: QULOOP aplica um bloqueio no servidor, evitando que outros usuáriosacessem o servidor durante a execução da função. Se esta função for usada paraexportar valores de um conjunto da consulta grande, o servidor poderá ficarinacessível por um longo período de tempo.

182 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 197: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeQULOOP(cube, query)

Argumento Descrição

cubo O nome do cubo a ser consultado. Use umprefixo de nome do servidor para indicar olocal do servidor. Para o servidor local,especifique local:cube. Para um servidorremoto, especifique servername:cube.

consulta O nome de um conjunto da consultaexistente.

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álogoExtração de Visualização quando chamada a partir do Editor de Subconjunto.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

Nota: QUSUBSET aplica um bloqueio no servidor, evitando que outros usuáriosacessem o servidor durante a execução da função. Se esta função for usada paraexecutar uma consulta que retorna um grande número de elementos, o servidorpoderá ficar inacessível por um longo período de tempo.

SintaxeQUSUBSET(cube, query, dimension, subset)

Argumento Descrição

cubo O nome do cubo a ser consultado. Use umprefixo de nome do servidor para indicar olocal do servidor. Para o servidor local,especifique local:cube. Para um servidorremoto, especifique servername:cube.

consulta O nome de uma consulta existente.

dimensão O nome de uma dimensão para a qual aconsulta existe.

subconjunto O nome do subconjunto de dimensões a sercriado, que conterá a lista de elementos queatendem aos critérios do subconjunto. Porexemplo, um subconjunto pode retornar alista de regiões nas quais as vendas decarros excedem um valor especificado.

Capítulo 4. Funções de Macro 183

Page 198: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Exemplo

=QUSUBSET("sales:98sales", "Top", "Region", "Topsales")

Este exemplo cria o subconjunto Vendas Principais para a dimensão Região, combase nos critérios da consulta Principal.

R_SAVER_SAVE salva a planilha ativa como uma planilha de regras e a compila em umarquivo .rux.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

A pasta de trabalho deve ter o mesmo nome que o cubo para o qual as regrasestão sendo compiladas.

As instruções de regras que impedem a compilação de regras são gravadas noarquivo tm1erlog.cma, no diretório de dados local.

SintaxeRSAVE

Argumentos

Nenhum.

SUBDEFINESUBDEFINE cria um subconjunto de dimensões que consiste em nomes deelementos localizados na planilha ativa.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

Quando SUBDEFINE criar o subconjunto, ele será criado como um subconjuntoparticular.

Se o subconjunto nomeado já existir como um subconjunto particular quando afunção for executada, ele sobrescreverá o subconjunto particular existente por essenome.

Se o subconjunto nomeado existir como um subconjunto público, SUBDEFINEainda criará o subconjunto como particular. Se desejar sobrescrever o subconjuntopúblico nomeado existente, será necessário publicar o subconjunto particular quefoi criado pela função SUBDEFINE para sobrescrever o subconjunto públicoexistente.

Nota: SUBDEFINE aplica um bloqueio no servidor, evitando que outros usuáriosacessem o servidor durante a execução da função. Se esta função for usada paracriar um subconjunto com um grande número de elementos, o servidor poderáficar inacessível por um longo período de tempo.

184 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 199: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeSUBDEFINE(dimension, subset, range)

Argumento Descrição

dimensão O nome da dimensão para a qual vocêdeseja criar um subconjunto. Use um prefixode nome do servidor para indicar o local doservidor. Para o servidor local, especifiquelocal:dim. Para um servidor remoto,especifique servername:dim.

subconjunto O nome do subconjunto de dimensões.

intervalo O intervalo de células da planilha contendoos nomes de elementos na dimensão. Osvalores de células no intervalo que não sãoelementos válidos são ignorados.

Exemplo

=SUBDEFINE("local:Model", "Smith", B7:M7)

Este exemplo cria um subconjunto chamado Smith para a dimensão do Modelo. Osubconjunto contém elementos localizados no intervalo de células B7:M7.

SUBPICKSUBPICK chama uma caixa de diálogo que lista todos os elementos nosubconjunto especificado.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

Os elementos selecionados são inseridos na planilha ativa, iniciando na posição dacélula atual.

SintaxeSUBPICK(dimension, subset, vertical)

Argumento Descrição

dimensão O nome da dimensão que contémsubconjuntos. Use um prefixo de nome doservidor para indicar o local do servidor.Para o servidor local, especifique local:dim.Para um servidor remoto, especifiqueservername:dim.

subconjunto O nome do subconjunto cujos elementosvocê deseja selecionar.

Capítulo 4. Funções de Macro 185

Page 200: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

vertical Especifique TRUE para inserir os nomes deelementos verticalmente, da célula atualabaixo. Especifique FALSE para inserir osnomes de elementos horizontalmente, dacélula atual à direita.

Exemplo

=SUBPICK("local:Model", "Smith", TRUE, )

Este exemplo insere elementos selecionados do subconjunto Smith na planilhaativa. Os elementos são dispostos 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.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

Nota: T_CLEAR não solicita que você salve em disco nenhum dos dados do cubona RAM. Os dados não salvos são limpos sem serem salvos no disco. Portanto, sedesejar salvar dados do cubo que estão na RAM, chame a função T_SAVEprimeiro.

SintaxeT_CLEAR

Argumentos

Nenhum.

T_CREATET_CREATE cria um cubo que tem até oito dimensões, que é o limite em versõesanteriores do TM1 .

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

Nota: Se você usar T_CREATE paara criar um cubo com o nome de um cuboexistente, o TM1 substituirá o cubo existente e excluirá todos os seus dados.

186 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 201: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeT_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 paraindicar o local do servidor. Para o servidorlocal, especifique local:cube. Para umservidor remoto, especifiqueservername:cube.

d1...d8 Nomes de até oito dimensões existentes, naordem que você deseja que eles sejamarmazenados no cubo. Você deve especificarpelo menos duas dimensõ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.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

Nota: Se o primeiro argumento para esta função for um nome do cubo existente, oTM1 substituirá o cubo existente e excluirá todos os seus dados.

SintaxeT_CREATE16(cube,d1,d2[,d3,...,d16])

Argumento Descrição

cubo O nome do cubo a ser criado.

Use um prefixo de nome do servidor paraindicar o local do servidor. Para o servidorlocal, especifique local:cube. Para umservidor remoto, especifiqueservername:cube.

d1...d16 Nomes de até dezesseis dimensõesexistentes, na ordem que você deseja queeles sejam armazenados no cubo. Você deveespecificar pelo menos duas dimensões.

Capítulo 4. Funções de Macro 187

Page 202: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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 nosservidores TM1 locais e remotos.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

O nome do cubo selecionado na caixa de diálogo torna-se o valor da funçãoT_PICK. Sua macro insere o nome do cubo na primeira célula da planilha ativa.

SintaxeT_PICK

Argumentos

Nenhum.

T_SAVET_SAVE salva todos os dados do cubo atualmente na RAM no disco.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

T_SAVE pode ser usado somente para salvar dados em um servidor local; a funçãonão funciona com servidores remotos. T_SAVE não solicita o salvamento de dadospara cubos individuais.

SintaxeT_SAVE

Argumentos

Nenhum.

TM1RECALCTM1RECALC força um recálculo de todas as planilhas abertas. É equivalente apressionar F9 no Excel.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

Uma função de macro semelhante, TM1RECALC1, força um recálculo apenas daplanilha ativa.

SintaxeTM1RECALC

188 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 203: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumentos

Nenhum.

TM1RECALC1TM1RECALC1 força um recálculo da planilha ativa. É equivalente a pressionarSHIFT-F9 no Excel.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

Uma função de macro semelhante, TM1RECALC, força um recálculo de todas asplanilhas abertas.

SintaxeTM1RECALC1

Argumentos

Nenhum.

VUSLICEVUSLICE cria uma planilha da fatia a partir da visualização do cubo especificada.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

A fatia é inserida começando na célula superior esquerda (A1 ou R1C1) na planilhaativa.

SintaxeVUSLICE(cube, view)

Argumento Descrição

cubo O nome de um cubo existente.

Use um prefixo de nome do servidor paraindicar o local do servidor. Para o servidorlocal, especifique local:cube. Para umservidor remoto, especifiqueservername:cube.

visualização O nome de uma visualização associada aocubo.

Exemplo

=VUSLICE("local:98sales","Quarterly")

Este exemplo copia dados da visualização Trimestral do cubo 98sales na planilhaativa.

Capítulo 4. Funções de Macro 189

Page 204: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

W_DBSENABLEW_DBSENABLE ativa (ou desativa) o recálculo automático de funções DBS emuma planilha.

Esta é uma função de macro do TM1 , válida apenas em macros do Excel emódulos VBA.

Normalmente, quando uma função DBS é inserida em uma planilha, a função nãoé executada até que a planilha seja recalculada com as teclas F9 ou SHIFT+F9. Afunção W_DBSENABLE pode ser usada para executar imediatamente funções DBSconforme são criadas em uma planilha.

Nota: As funções DBS não serão executadas em módulos VBA, a menos queW_DBSENABLE esteja definida como TRUE.

Sintaxe=W_DBSENABLE(LogicalFlag)

Argumento Descrição

LogicalFlag Se TRUE, as funções DBS serão executadasimediatamente quando inseridas ouchamadas a partir de uma planilha.

Se FALSE, as funções DBS serão executadasapenas quando a planilha for explicitamenterecalculada.

190 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 205: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Capítulo 5. Funções da Planilha

Este capítulo descreve as funções que podem ser usadas em uma planilha.

Visão Geral de Funções da PlanilhaAs funções da Planilha do IBM Cognos TM1 retornam um valor numérico ou valorde sequência, e podem ser usadas em qualquer parte em uma planilha do Excel.

Para acessar estas funções no Excel, escolha Inserir, Função da barra de menus doExcel ou clique em na barra de ferramentas do Excel.

Se uma função da planilha fizer referência a um objeto em um servidor remoto,você deverá prefixar o objeto com o nome do servidor e dois pontos. Por exemplo,para referir-se ao cubo 2k2sales no servidor de contabilidade, useaccounting:2k2sales. Você deve estar conectado ao servidor referido pela funçãopara receber valores precisos em sua planilha. Se não estiver conectado ao servidor,as funções da planilha do TM1 retornarão *KEY_ERR.

Você deve estar em conformidade com as convenções de formato de função paraseu programa de programa ao usar funções do TM1 .

As funções de planilha do TM1 aceitam sequências, valores ou referências decélula como argumentos. As sequências devem ser colocadas entre aspas, e asreferências de células devem referir-se a argumentos válidos para umadeterminada função. As convenções padrão podem ser usadas para referências decélulas absolutas e relativas em funções da planilha.

Se você registrar uma macro de planilha no Excel que inclui a funcionalidade doTM1 , a macro resultante poderá incluir funções da planilha do TM1 nãodocumentadas. No entanto, você pode modificar ou descontinuar estas funções nãodocumentadas em futuros releases sem notificação.

As funções da planilha não podem ser usadas em regras do TM1 ou em processosdo Turbo Integrator.

DBRDBR recupera um valor de um cubo do TM1 especificado.

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

Quando todos os argumentos do elemento (e1, e2, etc.) para a função foremelementos folha, a função DBR também poderá ser usada para gravar valores nocubo especificado, desde que o usuário tenha os privilégios de acesso apropriadospara o cubo, dimensões, elementos e/ou células relevantes. Ao inserir um valor emuma célula que contém tal função DBR, o valor é enviado ao servidor.

© Copyright IBM Corp. 2007, 2013 191

Page 206: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeDBR(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 docubo que 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 elementoda segunda dimensão e assim por diante. Esses argumentostambém podem ser os nomes de aliases dos elementos dedimensão.

Os nomes de elementos numéricos devem ser colocados entreaspas duplas. Por exemplo, ""14357"".

ExemploDBR("92act4d", "California", "3.5 Diskettes", "Net Sales","January")

Neste exemplo, 92act4d é o nome do cubo e a função retorna o valor na interseçãode Califórnia, Disquetes 3.5, Vendas Líquidas e Janeiro.

DBRADBRA recupera o valor de um atributo de elemento especificado.

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

O valor retornado pode ser uma sequê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 elementono servidor. Ao inserir um valor, de sequência ou numérico, em uma célulacontendo uma função DBRA, o atributo de elemento correspondente é atualizadono servidor.

SintaxeDBRA(server:dimension, element, attribute)

Argumento Descrição

server:dimension Um nome de dimensão válido, prefixado com o nome do servidorapropriado e dois pontos; por exemplo, "SData:Region" fazreferência à dimensão Região no servidor SData.

Se o prefixo da dimensão não incluir o nome de servidor, afunção DBRA tentará executar contra o servidor local.

element Um elemento da dimensão.

atributo O atributo para o qual você deseja recuperar um valor. Esteargumento deve ser um atributo válido do elemento.

192 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 207: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

ExemploDBRA("SData:Model", "L Series 1.8L Sedan", "ManufactureCode")

Neste exemplo, a função retorna o valor do atributo Código de Fabricação doelemento Sedã Série L 1.8L na dimensão do Modelo no servidor SData.

DBRWDBRW recupera um valor de um cubo do TM1 especificado.

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

Quando todos os argumentos do elemento (e1, e2, etc.) para a função foremelementos folha, a função DBRW também poderá ser usada para gravar valores nocubo especificado, desde que o usuário tenha os privilégios de acesso apropriadospara o cubo, dimensões, elementos e/ou células relevantes.

Esta função funciona da mesma forma que a função DBR, com uma diferençaprincipal: DBRW reduz o tráfego da rede e pode melhorar o desempenho em redesde longa distância.

Em planilhas com um grande número de funções do TM1 , DBRW força o TM1 aexecutar funções em "pacotes configuráveis" em vez de individualmente. Asfunções DBR normais são executadas individualmente durante um recálculo daplanilha. As funções DBRW forçam o TM1 a executar duas transmissões pelaplanilha. 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. Nasegunda transmissão, os valores do cubo são enviados em um único pacoteconfigurável de volta para a planilha. Portanto, a planilha recalcula duas vezesquando são executadas funções DBRW.

O pacote configurável de DBRW ocorre quando a função é usada em uma célulaindependente. Quando funções DBRW são usadas em cálculos complexos, a funçãoopera como uma nova função DBR, portanto, não ocorre nenhum ganho dedesempenho.

SintaxeDBRW(cube, e1, e2[,...en])

Argumento Descrição

cubo O nome do cubo de banco de dados do qual o valor serárecuperado.

e1,...en Os nomes de elementos de dimensão que definem a interseçãodo cubo que 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 umelemento da segunda dimensão e assim por diante. Essesargumentos também podem ser os nomes de aliases doselementos de dimensão.

Os nomes de elementos numéricos devem ser colocados entreaspas.

Capítulo 5. Funções da Planilha 193

Page 208: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

ExemploDBRW("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 e Janeiro no cubo 92act4d.

DBSDBS envia um valor numérico para um cubo do TM1 .

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

Essa função não pode enviar uma sequência de caracteres a um cubo. Para enviarsequências de caracteres, use a função DBSS.

Quando você construir uma função DBS com o TM1 , a opção Editar Fórmula, acaixa de diálogo Editar Fórmula solicitará uma séria de etapas para construir cadaargumento da função na sequência correta.

Se o cubo não existir ou um dos argumentos for inválido, a função retornará KEYERROR.

SintaxeDBS(value, cube, e1, e2[,...en])

Argumento Descrição

value 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 aoqual o valor será enviado.

Os argumentos e1 a en são sensíveis à sequência. e1 deve serum elemento da primeira dimensão do cubo, e2 deve ser umelemento da segunda dimensão do cubo e assim por diante.Esses argumentos também podem ser os nomes de aliases doselementos de dimensão.

Os nomes de elementos numéricos devem ser colocados entreaspas.

ExemploDBS(5342,"92act4d","California","3.5 Diskettes", "NetSales", "January")

Neste exemplo, a função envia o valor 5342 para o cubo 92act4d na interseção deCalifórnia, Disquetes 3.5, Vendas Líquidas e Janeiro.

DBSADBSA envia um valor para um atributo de elemento especificado.

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

194 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 209: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

O valor enviado pode ser uma sequência de caracteres ou um valor numérico,dependendo do tipo de atributo.

SintaxeDBSA(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 nomedo servidor apropriado e dois pontos; porexemplo, "SData:Region" faz referência àdimensão Região no servidor SData.

Se o prefixo da dimensão não incluir o nomede servidor, a função DBSA tentará executarcontra o servidor local.

elemento Um elemento da dimensão.

att_name O atributo para o qual você deseja enviarum valor att_name deve ser um atributoválido do elemento especificado porelem_name.

ExemploDBSA(’’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.

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

Essa função não pode enviar um valor numérico a um cubo. Use a função DBSpara enviar valores numéricos.

Quando você construir uma função do DBSS com a opção Editar Fórmula do TM1, a caixa de diálogo Editar Fórmula solicitará em uma série de etapas que vocêconstrua cada argumento na sequência correta.

Se o cubo não existir ou um dos argumentos for inválido, a função retornará KEYERROR.

SintaxeDBSn(string, cube, e1, e2,...en)

Argumento Descrição

sequência A sequência de caracteres sendo enviada.

Capítulo 5. Funções da Planilha 195

Page 210: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

cubo O cubo para o qual a sequência decaracteres é enviada.

e1, ...en Os nomes dos elementos que definem ainterseção no cubo ao qual a sequência decaracteres será enviada.

Os argumentos e1 a en são sensíveis àsequência. e1 deve ser um elemento daprimeira dimensão do cubo, e2 deve ser umelemento da segunda dimensão do cubo eassim por diante. Esses argumentos tambémpodem ser os nomes de aliases doselementos de dimensão.

ExemploDBSS("Smith","Info","California","Last Name")

Neste exemplo, a fórmula envia a sequência Smith para o cubo Info na interseçãode Califórnia e Sobrenome.

DBSWDBSW envia um valor numérico para um cubo do TM1 .

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

Essa função não pode enviar uma sequência de caracteres a um cubo. Para enviarsequências de caracteres, use a função DBSS.

Esta função funciona da mesma forma que a função DBS, com uma diferençaprincipal: DBSW reduz o tráfego da rede e pode melhorar o desempenho em redesde longa distância.

Em planilhas com um grande número de referências do cubo, DBSW força o TM1a enviar valores em pacotes configuráveis em vez de individualmente. As funçõesDBS normais são atualizadas individualmente durante um recálculo. As referênciasde DBSW forçam o TM1 a enviar todos os valores alterados em uma planilha emum único pacote configurável.

Nestas circunstâncias, é possível usar seguramente uma função DBS/DBR comoum argumento para uma função DBS.

Nota: Se você utiliza as funções VBA para calcular uma planilha que contémfunções DBSW, deve chamar a TM1 função de macro para calcular a planilha. Nãouse o método VB Calculate para calcular uma planilha contendo funções DBSW;isso faz com que cada função DBSW seja executada individualmente, anulando opropósito da função e resultando em uma redução no desempenho.

196 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 211: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeDBSW(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 ainterseção no cubo ao qual o valor seráenviado.

Os argumentos e1 a en são sensíveis àsequência. e1 deve ser um elemento daprimeira dimensão do cubo, e2 deve ser umelemento da segunda dimensão do cubo eassim por diante. Esses argumentos tambémpodem ser os nomes de aliases doselementos de dimensão.

Os nomes de elementos numéricos devemser colocados entre aspas.

ExemploDBSW(5342,"92act4d","California","3.5 Diskettes", "NetSales", "January")

DFRSTO DFRST retorna o primeiro elemento de uma dimensão especificada.

Esta é uma função da planilha do TM1, válida apenas em planilhas.

SintaxeDFRST(server_name:dimension)

Argumento Descrição

dimensão Um nome de dimensão válido.

ExemploDFRST("planning_sample:Location")

Se a dimensão Local contiver os elementos ordenados Califórnia, Oregon eWashington, o exemplo retornará Califórnia.

DIMIXEsta é uma função da planilha do TM1 , válida apenas em planilhas.

O DIMIX retorna o número de índice de um elemento em uma dimensão.

Capítulo 5. Funções da Planilha 197

Page 212: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeDIMIX(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. Esteargumento também pode ser o nome de umalias para um elemento de dimensão.

ExemploDIMIX("planning_sample: Location","Washington")

Se a dimensão Local contiver os elementos ordenados Califórnia, Oregon eWashington, o exemplo retornará o valor 3, pois Washington é o terceiro elementoda dimensão.

DIMNMDIMNM retorna o elemento de uma dimensão que corresponde ao argumento deÍndice.

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

Se você incluir o parâmetro Alias opcional nesta função, a função retornará o aliaspara o elemento selecionado

Ao clicar duas vezes em uma célula contendo uma função DIMNM, a caixa dediálogo Dimensão se abre. É possível então selecionar um novo elemento paracolocar em sua planilha. A função DIMNM atualiza automaticamente o argumentode índice para refletir o novo elemento.

SintaxeDIMNM(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 deelementos na dimensão.

Alias O nome de um alias existente para adimensão. Este é um argumento opcional. Seele for usado, a função retornará o alias doelemento especificado.

198 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 213: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Exemplo

Se a dimensão Local contiver os elementos ordenados Califórnia, Oregon eWashington, o exemplo retornará Oregon.

DIMSIZO DIMSIZ retorna o número de elementos em uma dimensão especificada.

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

SintaxeDIMSIZ(dimension)

Argumento Descrição

dimensão Um nome de dimensão válido.

ExemploDIMSIZ("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 comoum argumento para a função.

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

SintaxeDNEXT(server:dimension, element)

Argumento Descrição

server:dimension Um nome de dimensão válido, prefixadocom o nome do servidor apropriado e doispontos; por exemplo, "SData:Region" fazreferência à dimensão Região no servidorSData.

Se a dimensão não for prefixada com umnome do servidor, a função DNEXT tentaráexecutar no servidor local.

elemento O nome de um elemento na dimensão. Esteargumento também pode ser o nome de umalias para um elemento de dimensão.

ExemploDNEXT("Production:Location","Oregon")

Se a dimensão Local no servidor de Produção contiver os elementos ordenadosCalifórnia, Oregon e Washington, o exemplo retornará Washington.

Capítulo 5. Funções da Planilha 199

Page 214: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

DNLEVO DNLEV retorna o número de níveis de hierarquia em uma dimensão.

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

SintaxeDNLEV(dimension)

Argumento Descrição

dimensão Um nome de dimensão válido.

ExemploDNLEV("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ão incluídas em super-regiões (Nível 2) que, por sua vez, sãoincluídas no mundo (Nível 3).

Na dimensão Região existem quatro níveis de hierarquia (0, 1, 2 e 3). Portanto, oexemplo retorna o valor 4.

DTYPEO DTYPE retorna as informações sobre o tipo do elemento especificado. Elaretorna "N" se o elemento for um elemento numérico, "S" se o elemento for umelemento de sequência.

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

SintaxeDTYPE(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 umalias para um elemento de dimensão.

200 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 215: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

ExemploDTYPE("Region","Europe")

O elemento Europa na dimensão Região é um elemento consolidado, portanto, oexemplo retorna "C".

ELCOMPO ELCOMP retorna o nome de um filho de elemento consolidado em umadimensão especificada.

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

Se o argumento do elemento não for um elemento consolidado, a função retornará0.

SintaxeELCOMP(dimension, element, index)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento O nome de um elemento consolidado nadimensão. Este argumento também pode sero nome de um alias para um elemento dedimensão.

índice Um valor positivo menor ou igual ao totalde filhos no elemento especificado.

ExemploELCOMP("Region","Central Europe",2)

Na dimensão Região, o elemento consolidado Europa Central é uma consolidaçãodos filhos Alemanha e França. De forma apropriada, o exemplo retorna França.

ELCOMPNO ELCOMPN retorna o número de componentes em um elemento especificado.

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

Se o argumento do elemento não for um elemento consolidado, a função retornará0.

SintaxeELCOMPN(dimension, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

Capítulo 5. Funções da Planilha 201

Page 216: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

elemento O nome de um elemento consolidado nadimensão. Este argumento também pode sero nome de um alias para um elemento dedimensão.

Exemplo

Na dimensão Região, o elemento Escandinávia é uma consolidação de trêselementos. O exemplo retorna 3.

ELISCOMPO ELISCOMP determina se o elemento1 é um filho do elemento2 na dimensãoespecificada.

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

A função retornará TRUE se o elemento1 for um filho do elemento2, casocontrário, a função retornará FALSE.

SintaxeELISCOMP(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 umalias para um elemento de dimensão.

elemento2 O nome de um elemento na dimensão. Esteargumento também pode ser o nome de umalias para um elemento de dimensão.

ExemploELISCOMP("Region","Germany","Central Europe")

Na dimensão Região, o elemento Europa Central é uma consolidação de doiselementos, Alemanha e França. O exemplo retorna TRUE.

Observe que esta função retorna TRUE apenas para filhos imediatos. No exemploacima, Alemanha é um filho de Europa Central. Além disso, Europa Central é umfilho 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ãoespecificada.

202 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 217: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Esta é uma função da planilha do TM1, válida apenas em planilhas.

A função retornará TRUE se o elemento1 for um pai do elemento2, caso contrário,a função retornará FALSE.

SintaxeELISPAR(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 umalias para um elemento de dimensão.

elemento2 O nome de um elemento na dimensão. Esteargumento também pode ser o nome de umalias para um elemento de dimensão.

ExemploELISPAR("Region","Central Europe","Germany")

Na dimensão Região, o elemento consolidado Europa Central é o pai de Alemanhae França. De forma apropriada, o exemplo retorna TRUE

Observe que esta função retorna TRUE apenas para pais imediatos. No exemploacima, Europa é um pai de Europa Central. Além disso, Europa Central é um paide Alemanha. No entanto, como Europa não é um pai imediato de Alemanha, oexemplo a seguir retorna FALSE: ELISPAR("Region","Europe","Germany")

ELLEVO ELLEV retorna o nível de um elemento em uma dimensão.

Esta é uma função da planilha do TM1, válida apenas em planilhas.

SintaxeELLEV(dimension, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento O nome de um elemento na dimensão. Este argumento tambémpode ser o 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ível1). As regiões são então incluídas em super-regiões (Nível 2) que, por sua vez, são

Capítulo 5. Funções da Planilha 203

Page 218: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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 é uma função da planilha do TM1 , válida apenas em planilhas.

SintaxeELPAR(dimension, element, index)

Argumento Descrição

dimensão Um nome de dimensão válido.

element O nome de um elemento na dimensão. Esteargumento também pode ser o nome de umalias para um elemento de dimensão.

índice Um valor positivo menor ou igual aonúmero total de elementos consolidados(pais) que usam o argumento do elementocomo um filho.

Exemplo

ELPAR("Model","Wagon 4WD",2)

Na dimensão Modelo, o elemento Wagon 4x4 é um filho de Total de Wagons e deTotal de 4x4. Portanto, Total de Wagons e Total de 4x4 são pais de Wagon 4x4. Naestrutura da dimensão do Modelo, Total de Wagons é definido primeiro, Total de4x4 é definido em segundo lugar.

O exemplo retorna Total de 4x4, pois esta é a segunda instância de um pai paraWagon 4x4 na dimensão do Modelo.

ELPARNO ELPARN retorna o número de pais de um elemento em uma dimensãoespecificada.

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

204 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 219: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeELPARN(dimension, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

element O nome de um elemento na dimensão. Esteargumento também pode ser o nome de umalias para 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 ede 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 emuma dimensão.

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

Se o elemento especificado não for um membro da dimensão especificada, ou senão for um elemento de sequência de caracteres, a função retornará 0.

SintaxeELSLEN(dimension, element)

Argumento Descrição

dimensão Um nome de dimensão válido.

element O nome de um elemento de sequência nadimensão. Este argumento também pode sero nome de um alias para um elemento dedimensão.

Exemplo

ELSLEN("Region","Washington")

O elemento Washington é um elemento de sequência com 10 caracteres. O exemploretorna 10.

ELWEIGHTO ELWEIGHT retorna o peso de um filho em um elemento consolidado.

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

Capítulo 5. Funções da Planilha 205

Page 220: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeELWEIGHT(dimension, element1, element2)

Argumento Descrição

dimensão Um nome de dimensão válido.

elemento1 O nome de um elemento consolidado nadimensão. Este argumento também pode sero nome de um alias para um elemento dedimensão.

elemento2 O nome de um filho do elementoconsolidado. Este argumento também podeser o nome de um alias para um elementode dimensão.

Exemplo

ELWEIGHT("Account1","Gross margin","Variable costs")

Conforme mostra a figura a seguir, o elemento Custos variáveis, que é um filho deMargem bruta, tem um peso de -1.

O exemplo retorna -1.

SUBNMSUBNM retorna o elemento de um subconjunto de dimensões correspondente aoargumento IndexOrName.

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

Ao clicar duas vezes em uma célula contendo uma função SUBNM, o Editor deSubconjunto se abre. É possível então selecionar um novo elemento para colocarem sua planilha. O elemento selecionado torna-se o valor de retorno da funçãoSUBNM, e a função atualiza automaticamente o argumento IndexOrName pararefletir o novo elemento.

Se você incluir o parâmetro Alias opcional nesta função, a função retornará o aliaspara o elemento selecionado

206 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 221: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeSUBNM(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.

IndexOrName Um índice para o subconjunto ou o nome deum elemento no subconjunto.

Se for um índice, um número inteiropositivo menor ou igual ao número total deelementos no subconjunto especificado. Seum nome, uma sequência que representa onome de um elemento do subconjunto.

Alias O nome de um alias existente para osubconjunto. Este é um argumento opcional.Se ele for usado, o alias especificado seráaplicado quando o Editor de Subconjuntofor aberto e a função retornará o alias doelemento selecionado.

Exemplo

SUBNM("Region","Top Producers",2)

O subconjunto Principais Produtores da dimensão Região contém os elementosordenados Estados Unidos, Alemanha, Grã-Bretanha e México. Como o argumentode Índice aponta para o segundo elemento no subconjunto, o exemplo retornaAlemanha.

SUBNM("Region","Top Producers","Germany","Deutsch")

Este exemplo retorna o alias Deutsch para o elemento Alemanha (Deutschland) dosubconjunto Principais Produtores da dimensão Região.

SUBSIZO SUBSIZ retorna o número de elementos em um subconjunto de dimensão.

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

SintaxeSUBSIZ(dimension, subset)

Argumento Descrição

dimensão Um nome de dimensão válido.

subconjunto O nome de um subconjunto da dimensão.

Capítulo 5. Funções da Planilha 207

Page 222: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Exemplo

SUBSIZ("Region","Top Producers")

O subconjunto Principais Produtores da dimensão Região contém quatroelementos: Estados Unidos, Alemanha, Grã-Bretanha e México.

O exemplo retorna 4.

TABDIMTABDIM retorna o nome da dimensão que corresponde a um argumento de índiceespecificado.

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

A função sempre retorna uma dimensão baseada na ordem original de dimensõesno cubo especificado, mesmo que a ordem de dimensões no cubo tenha sidoalterada por meio do TM1 Cube Optimizer.

SintaxeTABDIM(cube, index)

Argumento Descrição

cubo Um nome de cubo válido.

índice Um valor positivo menor ou igual ao totalde dimensõ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 retorna modelo, a terceira dimensão de 98sales.

TM1RptElIsConsolidatedTM1RptElIsConsolidated retorna um valor booleano para indicar se um elementoem um Formulário Ativo é consolidado.

Esta é uma função da planilha do TM1 , usada para criar Formulários Ativos.

SintaxeTM1RptElIsConsolidated(RptRowFormula, Element)

Argumento Descrição

RptRowFormula Uma referência absoluta para uma célulacontendo uma fórmula TM1RptRow.

208 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 223: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

Elemento Uma referência relativa a uma célulacontendo um elemento da fórmulaTM1RptRow.

TM1RptElIsExpandedTM1RptElIsExpanded retorna um valor booleano para indicar se um elemento éexpandido em um subconjunto de linhas dentro de um Formulário Ativo.

Esta é uma função da planilha do TM1 , usada para criar Formulários Ativos.

SintaxeTM1RptElIsExpanded(RptRowFormula, Element)

Argumento Descrição

RptRowFormula Uma referência absoluta para uma célulacontendo uma fórmula TM1RptRow.

Elemento Uma referência relativa a uma célulacontendo um elemento da fórmulaTM1RptRow.

TM1RptElLevTM1RptElLev retorna um valor de número inteiro para um nível de elementorelativo à raiz no subconjunto.

Esta é uma função da planilha do TM1 , usada para criar Formulários Ativos.

Essa função é diferente da função de planilha ElLev.

SintaxeTM1RptElLev(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élulacontendo um elemento da fórmulaTM1RptRow.

TM1RptFilterTM1RptFilter define o filtro aplicado a uma dimensão da coluna Formulário Ativo.

Esta é uma função da planilha do TM1 , usada para criar Formulários Ativos.

Capítulo 5. Funções da Planilha 209

Page 224: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeTM1RptFilter(ReportView,Tuple,FilterFunction,FilterValue,SortOrder)

Argumento Descrição

ReportView Uma referência de célula a uma célula quecontém uma fórmula TM1RptView. O filtrose aplica à visualização especificada pelafórmula TM1RptView.

Tupla Uma sequência de caracteres de tuplaespecificando o elemento na dimensão dacoluna para a qual o filtro se aplica. Porexemplo, [mês].[Fev].

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.

Esta é uma função da planilha do TM1 , usada para criar Formulários Ativos.

A definição de linha principal rege o comportamento de todas as linhas noFormulário Ativo.

SintaxeTM1RptRow(ReportView, Dimension, Subset, SubsetElements,Alias, ExpandAbove,MDXStatement, Indentations, ConsolidationDrilling)

210 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 225: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

ReportView Uma referência para uma célula que contémuma fórmula TM1RptView.

Dimensão Uma dimensão, especificada usando oformato TM1_server_name:dimension_name.

Subconjunto Um subconjunto nomeado. Se esteargumento estiver vazio, todos os elementosda dimensão serão usados.

SubsetElements Uma referência de faixa de células queespecifica uma lista de elementos paraconstituir um subconjunto.

Quando este argumento é fornecido, osubconjunto especificado pelo argumentoSubconjunto é ignorado.

Se este argumento estiver vazio, oselementos de subconjunto especificado peloargumento de Subconjunto serão usados.

Alias Uma sequência de caracteres que define oalias usado para o subconjunto.

Quando este argumento é fornecido, elesubstitui a propriedade de alias definidapelo subconjunto especificado peloargumento Subconjunto.

Se este argumento estiver vazio, o alias dosubconjunto especificado pelo argumento deSubconjunto será usado.

ExpandAbove Um sinalizador Booleano para ativar oudesativar a propriedade Expandir Acima dosubconjunto. Quando este argumento éfornecido, ele substitui a propriedade padrãoExpandir Acima definida pelo subconjuntoespecificado pelo argumento Subconjunto.

Se o valor do argumento for 1, os elementosconsolidados serão expandidos para cima aofazer drill.

Se o valor do argumento for 0, os elementosconsolidados serão expandidos para baixoao fazer drill.

Se este argumento estiver vazio, apropriedade Expandir Acima do subconjuntoespecificado pelo argumento de Subconjuntoserá usada.

Capítulo 5. Funções da Planilha 211

Page 226: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

MDXStatement Uma instrução MDX que é aplicável aosubconjunto especificado pelo argumento deSubconjunto.

Quando este argumento é fornecido, elesubstitui o filtro MDX padrão definido pelosubconjunto especificado pelo argumento deSubconjunto.

Se este argumento está vazio ou é omitido,os elementos de subconjunto especificadopelo argumento de Subconjunto serãousados.

Indentações Um valor de número inteiro para indicarquantas indentações são aplicadas a cadanível durante o drilling em um elementoconsolidado. Se o valor do argumento for 0,não há indentação automática.

Este é um argumento opcional. Quando ovalor estiver ausente, será aplicada umaindentação a cada nível conforme é feitodrill down em um elemento consolidado.

ConsolidationDrilling Um sinalizador Booleano para ativar oudesativar o drill em elementos consolidados.

Quando este valor do argumento for 1, osusuários poderão fazer drill down emelementos consolidados no FormulárioAtivo.

Quando este valor do argumento for 0, osusuários não poderão fazer drill down emelementos consolidados no FormulárioAtivo.

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.

Esta é uma função da planilha do TM1 , usada para criar Formulários Ativos.

212 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 227: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeTM1RptTitle(Dimension,Element)

Argumento Descrição

Dimensão Uma dimensão, especificada usando oformato TM1 _name:dimension_name.

Elemento Uma referência de célula a uma célulacontendo uma função SUBNM que retornaum nome de elemento.

Exemplo

TM1RptTitle("SData:model",$C$7)

TM1RptViewO TM1RptView define a Visualização em um Formulário Ativo.

Esta é uma função da planilha do TM1 , usada para criar Formulários Ativos.

SintaxeTM1RptView(ViewID,ZeroSuppression,TM1RptTitle,...)

Argumento Descrição

ViewID Um nome de uma visualização usando oformato TM1 _name:cube_name:unique_id.

ZeroSuppressio Um sinalizador booleano para ativar oudesativar a propriedade de supressão zeropara a visualização. 1 = ativar, 0 = desativar

TM1RptTitle Para cada dimensão do título do FormulárioAtivo, inclua uma função TM1RptTitle comoargumento para TM1RptView.

FormatRange O intervalo de formatação do FormulárioAtivo.

Ao criar um Formulário Ativo, um intervalonomeado chamado de TM1RPTFMTRNG écriado para incluir todas as células dointervalo de formatação. É possível usar esseintervalo nomeado 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 écriado para incluir todas as células dointervalo de formatação. É possível usar esseintervalo nomeado como um argumento.

Capítulo 5. Funções da Planilha 213

Page 228: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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 atual usuário do TM1 .

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

Se o usuário atual do TM1 não estiver conectado a um servidor, ou se o servidorespecificado não estiver em execução, o TM1User retornará uma sequência vazia.

Se o TM1User for executado em um servidor que está configurado para usar aautenticação de CAM, a função retornará o nome/CAMID do usuário interno, nãoo nome de exibição.

SintaxeTM1User("ServerName")

Argumento Descrição

ServerName O nome do servidor ao qual o usuário doTM1 está conectado.

Exemplo

TM1User("SData")

Se um usuário chamado BrianT efetuar login no servidor SData e esse usuárioexecutar a função do TM1User, o exemplo acima retornará BrianT.

VIEWVIEW cria uma visualização otimizada do cubo especificado pelo argumento decubo.

Esta é uma função da planilha do TM1 , válida apenas em planilhas.

Uma única função VIEW é criada quando você fatia uma visualização a partir deuma navegação do cubo.

Todas as fórmulas DBR e DBRW que fazem referência à função VIEW podemacessar essa visualização otimizada. Dessa forma, os resultados são retornadosmuito mais rapidamente.

Várias funções VIEW podem residir na mesma planilha, se você tiver blocos defórmulas DBR que se referem a diferentes visualizações e/ou cubos do TM1 .

214 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 229: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeVIEW(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 seremusados como títulos, ou a sequência "!". Asequência "!" indica que a dimensãocorrespondente é uma linha ou coluna navisualização. Esses argumentos tambémpodem ser os nomes de aliases doselementos de dimensão.

Exemplo

VIEW("93sales",$B$2,$B$3,$B$4,"!","!")

Capítulo 5. Funções da Planilha 215

Page 230: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

216 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 231: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Capítulo 6. Funções do Turbo Integrator TM1

O TM1 Turbo Integrator permite que você manipule dados e metadados do TM1quando define um processo.

Isto é feito usando funções nas subguias Prólogo, Metadados, Dados e Epílogo, naguia Avançado da janela do Turbo Integrator. Estas subguias incluem instruçõesgeradas com base em configurações e opções selecionadas ao definir um processodo Turbo Integrator. As funções criadas devem aparecer após as instruções geradas.Para obter detalhes sobre como criar processos com o TurboIntegrator, consulte oGuia do IBM CognosTM1 TurboIntegrator.

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 TurboIntegrator. Insira funções manualmente na subguia apropriada dentro da guiaAvançada. Os argumentos de sequência para funções do Turbo Integrator devemser colocados entre aspas simples. Deve ser incluído um ponto e vírgula (;) paraindicar o final de cada função na janela do Turbo Integrator.

Além destas funções do Turbo Integrator, também é possível incorporar todas asfunções de Regras padrão do TM1 em uma definição de processo, com exceção dafunção STET.

Cada argumento para funções do Turbo Integrator é limitado em 256 bytes. Umafunção do Turbo Integrator pode aceitar vários argumentos, e cada argumento élimitado em 256 bytes.

Funções ASCII e de Texto do Turbo IntegratorEstas funções referem-se a ASCII e Texto.

ASCIIDeleteASCIIDelete exclui um arquivo ASCII.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeASCIIDelete(FileName);

FileName

O nome do arquivo ASCII que você deseja excluir. Se um caminho completonão for especificado, o TM1 procurará o arquivo no diretório de dados doservidor.

ExemploASCIIDelete(’C:\exported_data\2002Q1Results.cma’);

Este exemplo exclui o arquivo ASCII chamado 2002Q1Results.cma do diretórioC:\exported_data.

© Copyright IBM Corp. 2007, 2013 217

Page 232: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

ASCIIOutputASCIIOutput grava um registro delimitado por vírgulas para um arquivo ASCII.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

O arquivo ASCII é aberto quando o primeiro registro é gravado, e é fechadoquando o procedimento do Turbo Integrator (Prólogo, Metadados, Dados ouEpílogo) que contém a função ASCIIIOutput conclui o processamento.

Cada registro de saída gerado por ASCIIOutput é limitado em 8000 bytes. Se umregistro de saída exceder 8000 bytes, o registro será truncado e será registrado umaviso no arquivo TM1ProcessError.log.

Quando ASCIIOutput encontrar um argumento de sequência que envia o registrode saída além do limite de 8000 bytes, ela ignorará esse argumento e quaisquerargumentos adicionais. Por exemplo, se houver 10 argumentos de sequência e asaída para os primeiros sete argumentos totalizar 7950 bytes, enquanto a saídapara o oitavo argumento for de 51 bytes, apenas a saída para os primeiros seteargumentos será gravada no registro. Se houver dez argumentos de sequência e oprimeiro argumento for superior a 8000 bytes, nenhuma saída será gravada noregistro.

Se você usar a função ASCIIOutput para gravar no mesmo arquivo em váriosprocedimentos (guias) de um processo do Turbo Integrator, o arquivo serásobrescrito sempre que for aberto para um novo procedimento.

A função ASCIIOutput gera um erro secundário se ocorrer um erro ao gravar oarquivo ASCII. Além disso, a função retorna um valor durante a execução: 1 se afunção gravar com êxito o arquivo ASCII e 0 em caso de falha.

Observe que o erro será gerado e o valor retornado somente quando oASCIIOutput estiver gravando em um disco diferente daquele no qual o servidorestá sendo executado. Por exemplo, se o servidor estiver em execução na unidadeC: e ASCIIOutput estiver gravando na unidade F:, e a unidade F: ficar sem espaço,o erro será capturado e o servidor permanecerá ativo. Se o servidor estiver sendoexecutado na unidade C: enquanto o ASCIIOutput também estiver gravando naunidade C:, e essa unidade ficar sem espaço, o servidor será encerrado (conformeesperado).

Nota: A função ASCIIOutput coloca o caractere hexadecimal 0x1A no final detodos os arquivos gerados. Entretanto, o TM1 Web não pode abrir uma planilha daweb que contenha o caractere hexadecimal 0x1A.

Se usar ASCIIOutput para exportar dados do TM1 para um arquivo ASCII e, emseguida, tentar abrir o arquivo em uma planilha da web do TM1 , você encontraráo seguinte erro.

Erro ocorrido ao converter a pasta de trabalho do MS Excel em formato XML, ovalor hexadecimal 0x1A é um caractere inválido.

Se remover o caractere hexadecimal 0x1A da planilha da web, o arquivo seráaberto no TM1 Web.

218 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 233: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeASCIIOutput(FileName, String1, String2, ...Stringn);

Argumento Descrição

FileName Um caminho completo para o arquivo ASCIIno qual você deseja gravar o registro. Ocaminho deve incluir uma extensão doarquivo.

Sequência1...Sequêncian Uma sequência que corresponde a cadacampo que você deseja criar no arquivoASCII. Este argumento pode ser umasequência ou uma variável do TurboIntegrator para uma sequência.

ExemploASCIIOutput(’NewCube.cma’, V1, V2, V3, V4, V5 );

Este exemplo grava um registro no arquivo ASCII NewCube.cma. Cada arquivo noregistro corresponde a uma variável designada pelo Turbo Integrator a uma colunaem sua origem de dados.

SetInputCharacterSetA função SetInputCharacterSet permite especificar o conjunto de caracteres usadoem uma origem de dados do TurboIntegrator.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Quando um processo do Turbo Integrator ler um arquivo externo como entrada,ele precisará conhecer o conjunto de caracteres no qual esse arquivo externo foigravado. Se o arquivo contiver uma marca de ordem do byte válida, as funções doTM1 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 caracteresdeverão ser convertidos de alguma outra codificação em UTF-8. Se os conversoresapropriados estiverem presentes na máquina que hospeda o servidor, o arquivo deentrada será convertido no conjunto de caracteres Unicode necessário para o TM1 .

SintaxeSetInputCharacterSet (CharacterSet);

Argumento Descrição

CharacterSet A codificação de caracteres no arquivo deentrada a ser usada pelo processo do TurboIntegrator.

Se o argumento CharacterSet não for umtipo de caractere conhecido, o tipo serápadronizado como o código de idioma dosistema.

Capítulo 6. Funções do Turbo Integrator TM1 219

Page 234: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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

TM1CS_WCP1257 Windows Báltico

TM1CS_WCP1258 Windows Vietnã

TM1CS_WCP874 Windows Thai

220 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 235: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Codificação de Caracteres Código de Idioma do Sistema

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 emnão nativa.

ExemploSetInputCharacterSet (’TM1CS_ISO_8859_11’);

Este exemplo especifica que o conjunto de caracteres de entrada para a origem dedados do Turbo Integrator é ISO-8859-11 Latim/Tai.

SetOutputCharacterSetSetOutputCharacterSet permite especificar o conjunto de caracteres a ser usadodurante a composição de um arquivo de texto usando TextOutput em um processoTurboIntegrator.

Capítulo 6. Funções do Turbo Integrator TM1 221

Page 236: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

A função com a função TextOutput.

Usada com TextOutputs.

SintaxeSetOutputCharacterSet( FileName, CharacterSet );

Argumento Descrição

FileName Um caminho completo para o arquivo detexto para o qual você deseja especificar umconjunto de caracteres. O caminho deveincluir uma extensão do arquivo.

Este argumento deve ser idêntico aoargumento FileName para a funçãoTextOutput.

CharacterSet A codificação de caracteres a ser usada aogravar no arquivo de saída.

Para obter informações adicionais sobre os valores válidos para CharacterSet,consulte “SetInputCharacterSet” na página 219.

SetOutputEscapeDoubleQuoteSetOutputEscapeDoubleQuote permite escapar aspas duplas que aparecem emnomes de elementos ou valores de dados ao exportar uma visualização do cubopara um arquivo .csv.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Quando o SetOutputEscapeDoubleQuote é incluído em seu script TurboIntegratore configurado como 1, o arquivo exportado retém as posições de aspas duplasconforme aparecem na visualização de cubo de origem, escapando cada aspasduplas em outro par de aspas duplas. Por exemplo, se um elemento navisualização de origem for denominada "Region", o elemento será exportado como"""Region""" no arquivo de saída .csv.

Quando SetOutputEscapeDoubleQuote não for incluído no script TurboIntegratorou for configurado como 0, o arquivo exportado não escapará qualquer aspa duplaque apareça no cubo de origem.

SetOutputEscapeDoubleQuote é usado em conjunto com a função ASCIIOutput,que é a função que grava realmente o arquivo de saída.SetOutputEscapeDoubleQuote deve preceder ASCIIOutput no scriptTurboIntegrator e ambas as funções devem usar o mesmo valor de parâmetroFileName.

222 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 237: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeSetOutputEscapeDoubleQuote(FileName, Num);

Argumento Descrição

FileName Um caminho completo no qual você desejagravar a visualização do cubo. O caminhodeve incluir uma extensão do arquivo.

Num Um sinalizador que determina se as aspasduplas são escapadas no arquivo de saída.

1 indica que as aspas duplas serãoescapadas no arquivo de saída.

0 indica que as aspas duplas não serãoescapadas no arquivo de saída.

ExemploSetOutputEscapeDoubleQuote(’C:\temp\cube1.csv’, 1);

Este exemplo escapa quaisquer aspas duplas encontradas na visualização do cubode origem ao gravar a saída para o arquivo C:\temp\cube1.csv.

TextOutputTextOutput grava um registro delimitado por vírgulas em um arquivo de texto.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Por padrão, o TextOutput grava caracteres no conjunto de caracteres do código doidioma da máquina servidor. Para criar um arquivo em um conjunto de caracteresdiferente, chame a função SetOutputCharacterSet antes de chamar TextOutput.

O arquivo de texto é aberto quando o primeiro registro é gravado, e é fechadoquando o procedimento do Turbo Integrator (Prólogo, Metadados, Dados ouEpílogo) que contém a função TextOutput conclui o processamento.

Se você usar a função TextOutput para gravar no mesmo arquivo em váriosprocedimentos (guias) de um processo do Turbo Integrator, o arquivo serásobrescrito sempre que for aberto para um novo procedimento.

Cada registro de saída gerado por TextOutput é limitado em 8000 bytes. Se umregistro de saída exceder 8000 bytes, o registro será truncado e será registrado umaviso no arquivo TM1ProcessError.log.

Quando TextOutput encontrar um argumento de sequência que envia o registro desaída além do limite de 8000 bytes, ela ignorará esse argumento e quaisquerargumentos adicionais. Por exemplo, se houver 10 argumentos de sequência e asaída para os primeiros sete argumentos totalizar 7950 bytes, enquanto a saídapara o oitavo argumento for de 51 bytes, apenas a saída para os primeiros seteargumentos será gravada no registro. Se houver dez argumentos de sequência e oprimeiro argumento for superior a 8000 bytes, nenhuma saída será gravada noregistro.

Capítulo 6. Funções do Turbo Integrator TM1 223

Page 238: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

A função TextOutput gera um erro secundário se ocorrer um erro ao gravar oarquivo de texto. Além disso, a função retorna um valor durante a execução: 1 se afunção gravar com êxito o arquivo de texto e 0 em caso de falha.

O erro será gerado e o valor retornado apenas quando TextOutput estivergravando em um disco diferente daquele no qual o servidor está sendo executado.Por exemplo, se o servidor estiver em execução na unidade C: e TextOutput estivergravando na unidade F:, e a unidade F: ficar sem espaço, o erro será capturado e oservidor permanecerá ativo. Se o servidor estiver sendo executado na unidade C:enquanto o TextOutput também estiver gravando na unidade C:, e essa unidadeficar sem espaço, o servidor será encerrado (conforme esperado).

SintaxeTextOutput(FileName, String1, String2, ...Stringn);

Argumento Descrição

FileName Um caminho completo para o arquivo detexto no qual você deseja gravar o registro.O caminho deve incluir uma extensão doarquivo.

Sequência1...Sequêncian Uma sequência que corresponde a cadacampo que você deseja criar no arquivo detexto. Este argumento pode ser umasequência ou uma variável do TurboIntegrator para uma sequência.

ExemploTextOutput(’NewCube.cma’, V1, V2, V3, V4, V5 );

Este exemplo grava um registro no arquivo NewCube.cma. Cada arquivo noregistro corresponde a uma variável designada pelo Turbo Integrator a uma colunaem sua origem de dados.

Funções de Manipulação de Atributos do Turbo IntegratorEstas funções facilitam a manipulação de atributos.

AttrDeleteAttrDelete exclui um atributo de elemento do banco de dados do TM1 .

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeAttrDelete(DimName, AttrName);

Argumento Descrição

DimName A dimensão para a qual você deseja excluirum atributo de elemento.

224 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 239: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

AttrName O nome do atributo que você deseja excluir.

ExemploAttrDelete(’Model’, ’InteriorColor’);

Este exemplo exclui o atributo de elemento InteriorColor para a dimensão doModelo.

AttrInsertAttrInsert cria um novo atributo de elemento para uma dimensão. A função podecriar um atributo de sequência, numérico ou de alias.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeAttrInsert(DimName, PrevAttr, AttrName, Type);

Argumento Descrição

DimName A dimensão para a qual você deseja criarum atributo de elemento.

PrevAttr O atributo que precede o atributo que estásendo criado.

AttrName O nome que você deseja designar ao novoatributo.

Tipo O tipo de atributo. Existem três possíveisvalores para o argumento Type:

v N - Cria um atributo numérico.

v S - Cria um atributo de sequência.

v A - Cria um atributo de alias.

ExemploAttrInsert(’Model’, ’Transmission’, ’InteriorColor’,’S’);

Este exemplo cria o atributo de sequência InteriorColor para a dimensão doModelo. Este atributo é inserido após o atributo Transmission.

AttrPutNAttrPutN designa um valor a um atributo de elemento numérico.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Capítulo 6. Funções do Turbo Integrator TM1 225

Page 240: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeAttrPutN(Value, DimName, ElName, AttrName);

Argumento Descrição

Valor O valor que você deseja designar a umatributo de elemento.

DimName A dimensão-pai do elemento para o qualvocê deseja designar um valor de atributo.

ElName O elemento para o qual você deseja designarum valor de atributo.

AttrName O atributo cujo valor você deseja designar.

ExemploAttrPutN(2257993, ’Model’, ’ S Series 1.8L Sedan ’,’ProdCode’);

Este exemplo designa o valor 2257993 ao atributo ProdCode de Sedã Série S 1.8Lna dimensão do Modelo.

AttrPutSAttrPutS designa um valor a um atributo de elemento de sequência.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeAttrPutS(Value, DimName, ElName, AttrName);

Argumento Descrição

Valor O valor que você deseja designar a umatributo de elemento.

DimName A dimensão-pai do elemento para o qualvocê deseja designar um valor de atributo.

ElName O elemento para o qual você deseja designarum valor de atributo.

AttrName O atributo cujo valor você deseja designar.

ExemploAttrPutS(’Beige’, ’Model’, ’S Series 1.8L Sedan’, ’InteriorColor’);

Este exemplo designa a sequência Bege ao atributo InteriorColor da Sedã Série S1.8L na dimensão do Modelo.

226 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 241: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Funções de Gerenciamento de Tarefas de Organização de Processosdo Turbo Integrator

Estas funções referem-se ao gerenciamento de tarefas de organização de processos.

ChoreQuitChoreQuit causa a rescisão imediata de uma tarefa de organização de processos.Ela pode ser chamada a partir de qualquer processo em uma tarefa de organizaçãode processos.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Quando um processo encontra a função ChoreQuit, a tarefa de organização deprocessos atual é finalizada com um status de erro, e é gravada uma mensagem noarquivo de log do servidor, indicando que ChoreQuit foi chamada para finalizar atarefa de organização de processos.

SintaxeChoreQuit;

Argumentos

Nenhum.

SetChoreVerboseMessagesUse SetChoreVerboseMessages para ativar (ou desativar) o relatório mais detalhadode mensagens para o arquivo Tm1s.log.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Esta função é melhor usada como um auxílio na depuração de tarefas deorganização de processos, em que vários processos chamam uns aos outros usandoa função ExecuteProcess.

Transmitir um valor zero desativa a saída destas mensagens, transmitir um valordiferente de zero ativa a saída de mensagens mais detalhadas. Por padrão, estesinalizador é desativado.

Sintaxe

Use esta função para ativar (ou desativar) relatórios mais detalhados de mensagensno arquivo Tm1s.log. Esta função é melhor usada como um auxílio na depuraçãode tarefas de organização de processos, em que vários processos chamam uns aosoutros usando a função ExecuteProcess.

Transmitir um valor zero desativa a saída destas mensagens, transmitir um valordiferente de zero ativa a saída de mensagens mais detalhadas. Por padrão, estesinalizador é desativado.SetChoreVerboseMessages(Flag);

Capítulo 6. Funções do Turbo Integrator TM1 227

Page 242: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

Sinalizador Definir um valor diferente de zero paraativar o sistema de mensagens maisdetalhadas. Definido como zero (padrão)para desativar o sistema de mensagensdetalhadas.

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 evitarproblemas de contenção de bloqueio durante o uso normal do sistema.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Em operações normais, as dependências do cubo são estabelecidas quando osdados, que cruzam os limites do cubo (tais como dados derivados por uma regraque faz referência a um cubo externo), são recuperados. Para criar as informaçõesde dependência, o servidor deve bloquear os cubos enquanto a dependência éestabelecida, mantendo, potencialmente, o bloqueio durante um cálculo devisualização longa. Visto que este é um bloqueio de 'gravação', outros usuários sãoimpedidos de acessar os cubos. A função AddCubeDependency permite que adependência seja estabelecida quando o servidor é iniciado, impedindo a contençãode bloqueio posterior, visto que nenhuma nova dependência precisa serestabelecida.

SintaxeAddCubeDependency(BaseCube, DependentCube);

Argumento Descrição

BaseCube O nome de um cubo que depende de outrocubo para obter dados. De forma maiscomum, isso seria um cubo que usa regraspara extrair dados de um cubo externo.

DependentCube O nome do cubo do qual o BaseCube édependente.

Exemplo

AddCubeDependency(’A1’, ’A2’);

Considere dois cubos, A1 e A2. O cubo A1 tem essa regra para Jan-03, que obtémdados do cubo A2: [’Jan-03’]=DB(’A2’, elem_1, elem_2 , ...);

Nesse caso, A1 é dependente de A2. Para estabelecer a dependência em TurboIntegrator você deve incluir o exemplo mostrado acima.

228 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 243: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

CellGetNEsta função recupera um valor de uma célula do cubo numérica.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeCellGetN(Cube, e1, e2 [,...en]);

Argumento Descrição

Cubo O nome do cubo do qual você desejarecuperar um valor.

e1,...en Os nomes de elementos de dimensão quedefinem a interseção do cubo que contém ovalor a ser recuperado.

Os argumentos e1 a en são sensíveis àsequência. e1 deve ser um elemento daprimeira dimensão do cubo, e2 deve ser umelemento da segunda dimensão e assim pordiante. Estes argumentos também podem seros nomes de aliases para elementos dedimensão ou variáveis do Turbo Integrator.Nota: : Quando esta função for usada emuma instrução condicional (SE), a instruçãoserá a parte que contém a condição, não obloco condicional inteiro. Após um errosecundário, a execução continuará com apróxima instrução. O processamento do TInão tem conhecimento de que ele estava emuma condicional quando o erro secundáriofoi processado, portanto, a próximainstrução é a próxima linha, não a linhadepois de endif.

Para evitar esta situação, use variáveis paraqualquer operação que possa encontrar umerro secundário e, em seguida, use asvariáveis na instrução condicional. Porexemplo:

V1 = CELLGETN(’PNLCube’, ’fred’,’argentina’,’Sales’,’Jan’);IF(V1 = 454);ASCIIOUTPUT(’bug.txt’, ’if logic not working properly’);ENDIF;

ExemploCellGetN (’y2ksales’, ’Actual’, ’Argentina’, ’S Series1.8L Sedan’, ’Sales’, ’Jan’);

Este exemplo recupera o valor numérico na interseção dos elementos Real,Argentina, Sedã Série S 1.8L, Vendas e Jan no cubo y2ksales.

CellGetSEsta função recupera um valor de uma célula do cubo de sequência.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Capítulo 6. Funções do Turbo Integrator TM1 229

Page 244: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeCellGetS(Cube, e1, e2 [,...en]);

Argumento Descrição

Cubo O nome do cubo do qual você desejarecuperar um valor.

e1,...en Os nomes de elementos de dimensão quedefinem a interseção do cubo que contém ovalor a ser recuperado.

Os argumentos e1 a en são sensíveis àsequência. e1 deve ser um elemento daprimeira dimensão do cubo, e2 deve ser umelemento da segunda dimensão e assim pordiante. Estes argumentos também podem seros nomes de aliases para elementos dedimensão ou variáveis do Turbo Integrator.

Consulte a nota em “CellGetN” na página229 referente à lógica SE com esta função.

ExemploCellGetS(’Personnel’, ’Rep’, ’Europe’, ’Product’);

Este exemplo recupera o valor de sequência na interseção dos elementos Rep,Europa e Produto no cubo Personnel.

CellIncrementNEsta função incrementa um valor da célula numérica existente por um valorespecificado.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeCellIncrementN(x, Cube, e1, e2 [,...en]);

Argumento Descrição

x Um valor numérico que você deseja incluirem um valor da célula existente.

Cubo O nome do cubo para o qual você desejaenviar o valor.

230 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 245: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

e1,...en Os nomes de elementos de dimensão quedefinem a interseção do cubo para receber ovalor.

Os argumentos e1 a en são sensíveis àsequência. e1 deve ser um elemento daprimeira dimensão do cubo, e2 deve ser umelemento da segunda dimensão e assim pordiante. Estes argumentos também podem seros nomes de aliases para elementos dedimensão ou variáveis do Turbo Integrator.

ExemploCellIncrementN(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, Vendas e Jan no cubo y2ksales por 1000.

CellIsUpdateableEsta função permite determinar se pode ser feita gravação em uma célula do cubo.A função retornará 1 se puder ser feita gravação na célula, caso contrário, retornará0.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeCellIsUpdateable(Cube, e1, e2 [,...en]);

Argumento Descrição

Cubo O nome do cubo no qual você deseja gravarum valor.

e1,...en Nomes de elementos de dimensão quedefinem a célula na qual você deseja gravarum valor.

Os argumentos e1 a en são sensíveis àsequência. e1 deve ser um elemento daprimeira dimensão do cubo, e2 deve ser umelemento da segunda dimensão e assim pordiante. Estes argumentos também podem seros nomes de aliases para elementos dedimensão ou variáveis do Turbo Integrator.

ExemploCellIsUpdateable (’y2ksales’, ’Actual’, ’Argentina’,’S Series 1.8L Sedan’, ’Sales’, ’Jan’);

Este exemplo determina se pode ser feita gravação na célula definida peloselementos Real, Argentina, Sedã Série S 1.8L, Vendas e Jan no cubo y2ksales. Se a

Capítulo 6. Funções do Turbo Integrator TM1 231

Page 246: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

célula puder receber um valor, a função retornará 1, caso contrário, retornará 0.

CellPutNEsta função envia um valor numérico para uma célula do cubo.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeCellPutN(x, Cube, e1, e2 [,...en]);

Argumento Descrição

x Um valor numérico.

Cubo O nome do cubo para o qual você desejaenviar o valor.

e1,...en Os nomes de elementos de dimensão quedefinem a interseção do cubo para receber ovalor.

Os argumentos e1 a en são sensíveis àsequência. e1 deve ser um elemento daprimeira dimensão do cubo, e2 deve ser umelemento da segunda dimensão e assim pordiante. Estes argumentos também podem seros nomes de aliases para elementos dedimensão ou variáveis do Turbo Integrator.

ExemploCellPutN(12345, ’y2ksales’, ’Actual’, ’Argentina’, ’S Series 1.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.

CellPutProportionalSpreadEsta função distribui um valor especificado para as folhas de uma consolidaçãoproporcional aos valores de células existentes.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

CellPutProportionalSpread substitui valores de células existentes; ela não pode serusada 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, queestá descrito em detalhes no Guia do Usuário do IBM Cognos TM1 . Se precisarincluir ou subtrair de valores de células existentes, use o método DifusãoProporcional, que pode ser executado por meio da interface com o usuário ou dasintaxe de difusão de dados.

Nota: Ao usar CellPutProportionalSpread para distribuir um valor para as folhasde uma consolidação, apenas as folhas que já contêm valores diferentes de zero são

232 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 247: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

alteradas. Isto ocorre porque valores zero não podem ser incrementados oureduzidos proporcionalmente; qualquer proporção de zero ainda é zero.

SintaxeCellPutProportionalSpread( value, cube, e1, e2, e3...,en );

Argumento Descrição

valor O valor que você deseja distribuir.

cubo O nome do cubo no qual você desejadistribuir o valor.

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 daprimeira dimensão do cubo, e2 deve ser umelemento da segunda dimensão e assim pordiante. Estes argumentos também podem seros nomes de aliases para elementos dedimensão ou variáveis do Turbo Integrator.

ExemploCellPutProportionalSpread(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 SalesCubeidentificado pelos elementos Real, América do Norte, Sedã Série S 1.8L, Vendas eJan.

CellPutSEsta função envia um valor de sequência para uma célula do cubo.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeCellPutS(String, Cube, e1, e2 [,...en]);

Argumento Descrição

Sequência Uma sequência.

Cubo O nome do cubo para o qual você desejaenviar a sequência.

Capítulo 6. Funções do Turbo Integrator TM1 233

Page 248: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

e1,...en Os nomes de elementos de dimensão quedefinem a interseção do cubo para receber asequência.

Os argumentos e1 a en são sensíveis àsequência. e1 deve ser um elemento daprimeira dimensão do cubo, e2 deve ser umelemento da segunda dimensão e assim pordiante. Estes argumentos também podem seros nomes de aliases para elementos dedimensão ou variáveis do Turbo Integrator.

ExemploCellPutS(’jones’, ’Personnel’, ’Rep’, ’Europe’, ’Product’);

Este exemplo envia a sequência 'jones' para a interseção dos elementos Rep,Europa e Produto no cubo personnel.

CubeClearDataIsto limpa todos os dados em um cubo.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Esta função é muito mais rápida do que executar uma operação, como a criação deuma visualização para cobrir o cubo inteiro e, em seguida, executar ViewZeroOut()para zerar o cubo inteiro.

Quando você usa CubeClearData para limpar dados de um cubo, todas as célulasno cubo que são alimentadas por alimentadores também são limpas. Você devesalvar novamente a regra que estabelece os alimentadores ou usar a funçãoCubeProcessFeeders para restaurar as células alimentadas.

Nota: Esta chamada apenas exclui os dados do cubo, ela não exclui e recria opróprio cubo. Isto tem implicações quando são usados ambientes de simulações. Seum cubo for excluído e, em seguida, recriado, os ambientes de simulações que umusuário pode ter serão descartados, pois o cubo no qual esses ambientes desimulaçõ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, osdados do ambiente de simulação ainda serão considerados válidos, pois o cubo noqual o ambiente de simulação foi criado continua existindo.

SintaxeCubeClearData( name-of-cube-as-string );

Argumento

O nome do cubo a ser limpo, como uma sequência.

ExemploCubeClearData( ’expense’ );

234 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 249: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

CubeCreateEsta função cria um cubo a partir de dimensões especificadas. A ordem dedimensões especificada na função será a ordem de dimensões na definição docubo.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Após a execução, CubeCreate salva automaticamente o arquivo .cub resultante nodisco.

SintaxeCubeCreate(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, masnão mais que 256 dimensões.

ExemploCubeCreate(’y2ksales’, ’Actvsbud’, ’Region’, ’Model’,’Account1’, ’Month’);

Este exemplo cria um cubo chamado y2ksales usando as dimensões Actvsbud,Região, Modelo, Account1 e Mês.

CubeDestroyEsta função exclui um cubo especificado do TM1 .

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeCubeDestroy(Cube);

Argumento Descrição

Cubo O nome do cubo que você deseja excluir.

ExemploCubeDestroy(’y2ksales’);

Este exemplo exclui o cubo chamado y2ksales.

CubeExistsUse CubeExists para determinar se existe um cubo específico no servidor a partirdo qual um processo do Turbo Integrator é executado.

Capítulo 6. Funções do Turbo Integrator TM1 235

Page 250: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

A função retornará 1 se o cubo existir no servidor, caso contrário, retornará 0.

SintaxeCubeExists(CubeName);

Argumento Descrição

CubeName O nome do cubo cuja existência você desejaconfirmar.

ExemploCubeExists(’Inventory’);

Este exemplo determina se o cubo Inventory existe no servidor.

CubeGetLogChangesEsta função retorna o valor Booleano da propriedade Criação de Log para um cuboespecificado.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

A propriedade Criação de Log está definida na caixa de diálogo Designações deSegurança do TM1 e armazenada no cubo de controle }CubeProperties. Se aCriação de Log for ativada para um cubo, a função retornará 1. Se a criação de logfor desativada, a função retornará 0.

SintaxeCubeGetLogChanges(CubeName);

Argumento Descrição

CubeName O cubo para o qual você deseja retornar ovalor da propriedade Criação de Log.

ExemploCubeGetLogChanges(’2002sales’);

Se Criação de Log estiver ativada para o cubo 2002sales, função retornará 1.

CubeSaveDataCubeSaveData() serializa um cubo.

Sintaxe

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

236 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 251: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Para melhorar o desempenho, a criação de logs de transações pode ser desativadadurante o carregamento de dados. Para proteger dados recém-carregados noimprovável caso de um travamento do servidor, as mudanças poderão serserializadas no disco. SaveDataAll foi usado para serializar dados no disco etruncar o log de transações. Ao processar um comando SaveDataAll, o servidoradquire um bloqueio de LEITURA em cada cubo e um bloqueio de IX em cadacubo alterado. Isso pode causar uma contenção significativa na atividade dousuário se SaveDataAll estiver em execução durante os períodos de atividade dousuário.

Normalmente nem todos os cubos afetados por SaveDataAll precisam serserializados, já que normalmente nem todos os cubos são carregados com novosdados. CubeSaveData é usado para serializar um cubo individual no disco.CubeSaveData serializa os dados do cubo que foram confirmados na memória,incluindo as modificações que foram executadas com relação a eles no atualprocesso do Turbo Integrator mas que ainda não foram confirmadas.CubeSaveData(Cube);

Argumento Descrição

Cubo O nome do cubo que deseja serializar.

ExemploCubeSaveData (’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élulaVendas de Janeiro é incluído na serialização do disco do cubo no disco, mesmo queele ainda não tenha sido confirmado. A atualização da célula Vendas de Janeiropara 1000 não fará parte da serialização.

Log de Transações

Uma nova entrada de transação aparece no Log de Transações quandoCubeSaveData é executado. Durante o processamento de um arquivo de log detransações durante a recuperação, todas as atualizações para um cubo que foramaplicadas até o momento serão descartadas quando uma diretiva CubeSaveDatacom relação ao cubo for encontrada, já que todas as atualizações já foramserializadas para o cubo.

Recuperação de Falha do Servidor

O comando SaveDataAll aproveita o fato de que todos os cubos são bloqueadosdurante o seu processamento e trunca o log de transações, sabendo que todas asatualizações executadas antes da serialização foram seguramente armazenadas nodisco. Esse não é o caso para CubeSaveData, portanto, você deve modificar amaneira como a recuperação de dados é executada quando um cubo é serializado.

Capítulo 6. Funções do Turbo Integrator TM1 237

Page 252: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

O arquivo de log de transações contém registros que representam mudanças maisantigas do que os dados mais recentes no cubo e não devem ser aplicados quandodados estiverem sendo recuperados.

CubeSetConnParamsEsta função é usada para criptografar a senha para um cubo virtual no cubo}CubeProperties.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeCubeSetConnParams(cubeName, providerName, dataSourceLocation,dataSourceName,dataSourceCatalog, userID, password,sapClientLang,providerString);

Argumento Descrição

cubeName O nome do cubo para o qual você desejadefinir a senha.

providerName

dataSourceLocation Nome designado por seu administrador aum conjunto de catálogos em um localespecífico. Nos Microsoft Analysis Services,esse é o nome de um servidor registrado.

dataSourceName

catálogo dataSource O nome designado por seu administrador auma coleção específica de bancos de dados(Cubos, Dimensões e outros objetos). Para oMAS, este é o nome do banco de dados.

UserID Um nome de usuário válido para o banco dedados.

Senha Senha a ser usada para esta origem dedados.

sapClientLang Configuração de idioma do SAP.

providerString

ExemploCubeSetConnParams(sc, TM1OLAP, tm1server, , sdata, admin,apple,, ,);

CubeSetLogChangesEsta função define a propriedade CRIAÇÃO DE LOG para um cubo.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

238 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 253: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeCubeSetLogChanges(Cube, LogChanges);

Argumento Descrição

Cubo O nome do cubo para o qual você desejadefinir a propriedade 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.

CubeUnloadEsta função descarrega da memória um cubo especificado, juntamente com todasas visualizações do cubo associadas.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeCubeUnload(CubeName);

Argumento Descrição

CubeName O cubo que você deseja descarregar damemória.

ExemploCubeUnload(’ManufacturingBudget’);

Este exemplo descarrega da memória do servidor o cubo ManufacturingBudget eas visualizações associadas.

Funções do Turbo Integrator de Reserva de DadosUse as seguintes funções do Turbo Integrator para obter, liberar e gerenciarprogramaticamente Reservas de Dados.

Para obter mais detalhes sobre como usar o recurso Reserva de Dados, consulte"Usando Reservas de Dados" no Guia para Desenvolvedores do IBM Cognos TM1 .

CubeDataReservationAcquireCubeDataReservationAcquire adquire uma Reserva de Dados para o cubo, usuárioe tupla especificados.

Esta é uma função TurboIntegrator, válida apenas em processos TurboIntegrator.

Capítulo 6. Funções do Turbo Integrator TM1 239

Page 254: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Sintaxe

CubeDataReservationAcquire(Cube, User, bForce, Address, [AddressDelimiter])

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é um usuário existente.

bForce Valor booleano que determina o comportamento se a reservasolicitada entra em conflito com uma reserva existente.

Se configurado como 0 (false), o pedido será rejeitado se entrar emconflito com uma reserva existente.

Se estiver configurado como 1 (true) e o usuário executando oprocesso do Turbo Integrator tiver o recursoDataReservationOverride, as reservas conflitantes serão liberadas ea solicitada será concedida.

Endereço Sequência convertida em token de nomes de elementos quedefinem a tupla. A ordem deve corresponder à ordem de dimensãooriginal do cubo.

Todas as células no cubo contidas pela tupla constituem a regiãoque está sendo reservada. É possível escolher um elemento de cadadimensão ou usar uma sequência vazia entre os delimitadores paraselecionar uma dimensão inteira. Dependendo de onde o elementoestá localizado na hierarquia, o pedido reserva uma única célula,uma fatia ou o cubo inteiro.

AddressDelimiter Sequência de caracteres opcional que é usada para separar nomesde elementos no parâmetro Address.

O valor padrão é '|'.

Valor de Retorno

Booleano - retorna true se a aquisição foi bem-sucedida.

ExemploCubeDataReservationAcquire(’DRTestCube’,’User1’,0,’ElemX|ElemY|ElemZ’);

O exemplo a seguir configura o parâmetro bForce como 1 para forçar o pedido daDR se um conflito existir e usa um caractere delimitador diferente para oparâmetro AddressDelimiter.CubeDataReservationAcquire(’DRTestCube’,’User2’,1,’ElemX*ElemY*ElemZ’,’*’);

CubeDataReservationReleaseCubeDataReservationRelease libera a Reserva de Dados especificada.

Esta é uma função TurboIntegrator, válida apenas em processos TurboIntegrator.

240 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 255: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Se o usuário especificado não for o mesmo que o proprietário da reserva, aliberação será bem-sucedida apenas se o usuário especificado tiver o recursoDataReservationOverride ativado.

SintaxeCubeDataReservationRelease(Cube, User, Address,[AddressDelimiter])

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 queele é um usuário existente.

Endereço Sequência convertida em token de nomes de elementos quedefinem a tupla. A ordem deve corresponder à ordem dedimensão original do cubo.

AddressDelimiter Sequência de caracteres opcional que é usada para separar nomesde elementos no parâmetro Address.

O valor padrão é '|'.

Valor de Retorno

Booleano - retorna true se a liberação foi bem-sucedida.

ExemploCubeDataReservationRelease(’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.

Esta é uma função TurboIntegrator, válida apenas em processos TurboIntegrator.

Todas as reservas totalmente contidas pelo endereço especificado quecorrespondem ao filtro do usuário serão liberadas. Um filtro de usuário em brancosignifica todos os usuários.

Se o filtro de usuário especificado não for o mesmo que o usuário executando oprocesso do Turbo Integrator, o recurso DataReservationOverride deverá serativado.

O uso de um filtro de usuário em branco e de todos os curingas no campo deendereço libera todas as reservas.

Capítulo 6. Funções do Turbo Integrator TM1 241

Page 256: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeCubeDataReservationReleaseAll(Cube, UserFilter, Address, [AddressDelimiter])

Argumento Descrição

Cubo Nome do cubo.

UserFilter Filtro do nome de usuário para corresponder com relação àsreservas existentes.

Endereço Sequência convertida em token de nomes de elementos quedefinem a tupla. A ordem deve corresponder à ordem dedimensão original do cubo.

AddressDelimiter Sequência de caracteres opcional que é usada para separar nomesde elementos no parâmetro Address.

O valor padrão é '|'.

Valor de Retorno

Booleano - retorna true se não houver nenhum erro.

ExemploCubeDataReservationReleaseAll(’DRTestCube’,’User1’,’ElemX|ElemY|ElemZ’);

O exemplo a seguir libera todas as reservas no cubo especificado para todos osusuários.CubeDataReservationReleaseAll(’DRTestCube’,’’,’||’);

CubeDataReservationGetCubeDataReservationGet localiza reservas existentes em um cubo específico paratodos os usuários ou para um usuário.

Esta é uma função TurboIntegrator, válida apenas em processos TurboIntegrator.

Sintaxe

CubeDataReservationGet(Index, Cube, User, [AddressDelimiter]) returnsAddress;

Argumento Descrição

Índice Um índice de loop baseado em um usado para iterar através dereservas no cubo especificado.

Cubo Nome do cubo a procurar.

242 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 257: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

Usuário Nome do proprietário da reserva para usar como um filtro.

Se deixado em branco, a função retorna reservas para qualquerproprietário.

Se um nome for fornecido, a função filtrará os resultados paraobter apenas o proprietário especificado.

AddressDelimiter Sequência de caracteres opcional que é usada para separar nomesde elementos 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çodo Elemento da reserva. A data de criação vem primeiro, seguido pelo delimitador,seguido pelo ID do usuário, seguido pelo delimitador, seguido pelos IDs dosElementos separados pelo delimitador na ordem das dimensões no cubo (ordemoriginal).

Uma sequência vazia é retornada se não há entrada para o índice especificado.

O formato do valor de retorno é:

[creation time][delimiter][ownername][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ão tem garantia de fornecer uma lista completa dereservas. As reservas podem ser incluídas ou removidas em qualquer posição nalista, portanto, as reservas podem ser ignoradas ou repetidas ao fazer loop atravésdos valores de índice.

Se o filtro de proprietário for especificado, o índice se aplicará apenas aosmembros da lista filtrada. Se a lista de reservas tiver proprietários conforme aseguir: User1, User1, User2 e o pedido especificar um proprietário igual a User2,um índice igual a 1 recuperará o terceiro membro da lista.

ExemploCubeDataReservationGet(1,’DRTestCube’,’User1’,’*’);

CubeDataReservationGet(1,’DRTestCube’,’’);

A amostra a seguir localizará todas as reservas pertencentes ao usuário Fred Bloggsno cubo Expense Input e fará "algo útil" com elas:vIndex = 1;vCube = ’Expense Input’;vUserFilter = ’Fred Bloggs’;vDelim = ’|’;

Capítulo 6. Funções do Turbo Integrator TM1 243

Page 258: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

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 cuboespecífico que entrariam em conflito com o usuário, endereço e tupla especificados.

Esta é uma função TurboIntegrator, válida apenas em processos TurboIntegrator.

SintaxeCubeDataReservationGetConflicts(Index, Cube, User,Address, [AddressDelimiter])returns ConflictAddress;

Argumento Descrição

Índice Um índice de loop baseado em um usado para iterar através deconflitos que satisfazem esta consulta.

Cubo Nome do cubo a ser procurado

Usuário A consulta procurará reservas que entrarão em conflito com esteusuário.

Endereço Sequência convertida em token de nomes de elementos quedefinem a tupla. A ordem deve corresponder à ordem dedimensão original do cubo.

AddressDelimiter Sequência de caracteres opcional que é usada para separar nomesde elementos no parâmetro Address.

O valor padrão é '|'.

Valor de Retorno

ConflictAddress - Data de criação da reserva, nome do proprietário da reserva eendereço do Elemento da reserva. A data de criação vem primeiro, seguido pelodelimitador, seguido pelo ID do usuário, seguido pelo delimitador, seguido pelosIDs de Elementos separados pelo delimitador na ordem das dimensões no 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:

244 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 259: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

"20100622211601|Fred Bloggs|Element1|Element2|Element3"

Nota: As reservas podem ser alteradas enquanto iteram a lista de reservas emconflito, portanto, o uso do índice não tem garantia de fornecer uma lista completade reservas. As reservas podem ser incluídas ou removidas em qualquer posiçãona lista, portanto, as reservas podem ser ignoradas ou repetidas ao fazer loopatravé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 deidioma.

FormatDateA função FormatDate formata um valor de data de acordo com um formatadordefinido com a função NewDateFormatter.

Esta é uma função do TM1 Turbo Integrator, válida somente em processos doTurbo Integrator.

Sintaxe

FormatDate(Date, <Pattern>, <Index>)

Argumentos

Argumento Descrição

Date Um valor de data.

O tipo de valor, serial ou UNIX, deve corresponder ao formatadorusado.

Pattern Padrão usado para formatação de data.

Consulte http://userguide.icu-project.org/formatparse/datetime paraobter uma lista completa de sintaxes de formato.

Se uma sequência vazia for passada, o formato será determinado pelocódigo de idioma com base nos parâmetros FormatterStyle eFormatterType que foram usados 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ãoserá usado como se tivesse sido criado com a seguinte chamada:

NewDateFormatter(’’, ’Etc/UTC’, ’serial’, ’medium’, ’date’)

Exemplo

sDate = FormatDate(18000);

NewDateFormatterA função NewDateFormatter define um formatador de data. Ela retorna um índicepara ser usado nas funções ParseDate e FormatDate. Os índices começam em 0 e

Capítulo 6. Funções do Turbo Integrator TM1 245

Page 260: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

aumentam de um em um para cada chamada para NewDateFormat. Osformatadores de data são válidos durante a execução do processo.

Esta é uma função do TM1 Turbo Integrator, válida somente em processos doTurbo Integrator.

Sintaxe

NewDateFormatter(Locale, <TimeZone>, <UseUNIXTime>, <FormatterStyle>,<FormatterType>, <TimeType>)

Argumentos

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 sistemaoperacional será usado. Os códigos de idioma são especificados noformato language[_territory][.variant]. Por exemplo, cs_CK é o idiomaTcheco e República Tcheca.

TimeZone Fuso horário usado para análise ou formatação de datas.

Consulte http://en.wikipedia.org/wiki/List_of_tz_database_time_zonespara obter uma lista completa de fusos horários.

Se nenhum for especificado, o fuso horário usado será UTC (’Etc/UTC’).

UseUNIXTime Se ’unix’ for especificado, os horários serão tratados comomilissegundos desde 1 de janeiro de 1970. Caso contrário, eles serãotratados no formato serial do TM1.

Observe que apenas as datas posteriores a 1 de janeiro de 1970 podemser processadas, mesmo se o formato serial do TM1 for usado.

FormatterStyle Controla o formato de data usado quando um padrão vazio éespecificado para as funçõ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 as funçõ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’);

ParseDateA função ParseDate analisa uma sequência de datas de acordo com um formatadordefinido com a função NewDateFormatter.

246 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 261: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Um valor de data serial ou UNIX, dependendo do formatador especificado, éretornado. Se a data não puder ser analisada, um valor indefinido será retornado.Isso pode ser testado com a função ISUND.

Esta é uma função do TM1 Turbo Integrator, válida somente em processos doTurbo Integrator.

Sintaxe

ParseDate (DateString, <Pattern>, <Index>)

Argumentos

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 paraobter uma lista completa de sintaxes de formato.

Se uma sequência vazia for passada, o formato será determinado pelocódigo de idioma com base nos parâmetros FormatterStyle eFormatterType que foram usados 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, oformatador padrão será usado como se tivesse sido criado com aseguinte chamada:

NewDateFormatter(’’, ’Etc/UTC’, ’serial’, ’medium’, ’date’)

Exemplo

nDate = ParseDate(’2011/11/24’, ’yyyy/MM/dd’);

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.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeDimensionCreate(DimName);

Argumento Descrição

DimName O nome que você deseja designar àdimensão.

Capítulo 6. Funções do Turbo Integrator TM1 247

Page 262: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

ExemploDimensionCreate(’Product’);

Este exemplo cria a dimensão Produto.

DimensionDeleteAllElementsEsta função exclui todos os elementos em uma dimensão.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Nota: A exclusão de um elemento exclui todos os dados do cubo identificados poresse elemento. No entanto, se você usar DimensionDeleteAllElements para excluirelementos, em seguida, recriar esses elementos com os mesmos nomes na guiaMetadados, os pontos de dados em um cubo identificado pelos elementos ficarãoretidos após a reconstrução da dimensão.

Esta função é útil para recriar hierarquias da dimensão.

SintaxeDimensionDeleteAllElements(DimName);

Argumento Descrição

DimName O nome da dimensão da qual você desejaexcluir todos os elementos.

ExemploDimensionDeleteAllElements(’Model’);

Este exemplo exclui todos os elementos na dimensão do Modelo.

DimensionDestroyEsta função exclui uma dimensão do banco de dados do TM1 .

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeDimensionDestroy(DimName);

Argumento Descrição

DimName O nome da dimensão que você desejaexcluir.

ExemploDimensionDestroy(’Product’);

Este exemplo exclui a dimensão Produto do banco de dados do TM1 .

248 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 263: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

DimensionElementComponentAddInclui um componente (filho) em um elemento consolidado. Observe que não épossível usar esta função no procedimento do Epílogo de um processo TurboIntegrator.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeDimensionElementComponentAdd(DimName, ConsolidatedElName,ElName, ElWeight);

Argumento Descrição

DimName A dimensão-pai do elemento consolidado noqual você deseja incluir um filho.

ConsolidatedElName O elemento no qual você deseja incluir umfilho.

ElName O nome do elemento filho.

ElWeight O peso do elemento filho.

Exemplo

DimensionElementComponentAdd(’Measures’, ’Net Sales’, ’Expenses’, -1);

Este exemplo inclui o filho Despesas na consolidação Vendas Líquidas na dimensãodas Medidas. O filho tem um peso de -1 na consolidação.

DimensionElementComponentAddDirectDimensionElementComponentAddDirect inclui um componente (filho) para umelemento consolidado editando uma dimensão diretamente.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

O meio padrão de edição de uma dimensão no Cognos TM1 é usar um padrão deediçã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ãoreal é regravada usando a cópia de edição como um modelo. O TurboIntegratorsuporta edição de cópia inteira automaticamente sempre que a edição de funçõesdo TurboIntegrator (como DimensionElementComponentAdd) é usada noprocedimento de Metadados do processo. O TurboIntegrator cria automaticamentea cópia de edição e aplica nela as operações de edição, em seguida, regrava adimensão real no fim do procedimento de Metadados.

As edições diretas são diferentes porque nenhuma cópia de edição é envolvida. Emvez disso, as operações são executadas diretamente na dimensão real. Existem doiscasos de uso especializados diferentes para os quais esse tipo de edição direta édestinado:

Capítulo 6. Funções do Turbo Integrator TM1 249

Page 264: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

v Quando o propósito do processo TurboIntegrator for fazer uma pequenamudança em uma grande dimensão. Nesse caso, a edição direta será maiseficiente porque evita copiar e regravar completamente a dimensão grande.

v Quando o propósito do processo TurboIntegrator for carregar grandes volumesde dados em um cubo. Nesse caso, o procedimento de Metadados do processo édeliberadamente mantido vazio e qualquer modificação de elemento necessáriapara suportar o carregamento de dados é executado usando as chamadas diretasno procedimento de Dados. Quando o procedimento de Metadados ficar vazio, oprocesso ignorará uma iteração inteira sobre a origem de dados externa, quepode resultar em carregamentos de dados mais rápidos.

SintaxeDimensionElementComponentAddDirect(DimName, ConsolidatedElName,ElName, ElWeight);

Argumento Descrição

DimName A dimensão-pai do elemento consolidado noqual você deseja incluir um filho.

ConsolidatedElName O elemento consolidado ao qual você desejaincluir um 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ãodas Medidas. O filho tem um peso de -1 na consolidação.

DimensionElementComponentDeleteEsta função exclui um componente (filho) de um elemento consolidado.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeDimensionElementComponentDelete(DimName, ConsolidatedElName,ElName);

Argumento Descrição

DimName A dimensão-pai do elemento consolidado doqual você deseja excluir um filho.

ConsolidatedElName O elemento consolidado do qual você desejaexcluir um filho.

250 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 265: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

ElName O nome do elemento filho que você desejaexcluir.

ExemploDimensionElementComponentDelete(’Region’, ’Benelux’,’Belgium’);

Este exemplo exclui o filho Bélgica da consolidação Benelux na dimensão Região.

DimensionElementComponentDeleteDirectEsta função exclui um componente (filho) de um elemento consolidado editandodiretamente a dimensão.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

O meio padrão de edição de uma dimensão no Cognos TM1 é usar um padrão deediçã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ãoreal é regravada usando a cópia de edição como um modelo. O TurboIntegratorsuporta edição de cópia inteira automaticamente sempre que a edição de funçõesdo TurboIntegrator (como DimensionElementComponentDelete) é usada noprocedimento de Metadados do processo. O TurboIntegrator cria automaticamentea cópia de edição e aplica nela as operações de edição, em seguida, regrava adimensão real no fim do procedimento de Metadados.

As edições diretas são diferentes porque nenhuma cópia de edição é envolvida. Emvez disso, as operações são executadas diretamente na dimensão real. Existem doiscasos de uso especializados diferentes para os quais esse tipo de edição direta édestinado:v Quando o propósito do processo TurboIntegrator for fazer uma pequena

mudança em uma grande dimensão. Nesse caso, a edição direta será maiseficiente porque evita copiar e regravar completamente a dimensão grande.

v Quando o propósito do processo TurboIntegrator for carregar grandes volumesde dados em um cubo. Nesse caso, o procedimento de Metadados do processo édeliberadamente mantido vazio e qualquer modificação de elemento necessáriapara suportar o carregamento de dados é executado usando as chamadas diretasno procedimento de Dados. Quando o procedimento de Metadados ficar vazio, oprocesso ignorará uma iteração inteira sobre a origem de dados externa, quepode resultar em carregamentos de dados mais rápidos.

SintaxeDimensionElementComponentDeleteDirect(DimName, ConsolidatedElName,ElName);

Argumento Descrição

DimName A dimensão-pai do elemento consolidado doqual você deseja excluir um filho.

ConsolidatedElName O elemento consolidado do qual você desejaexcluir um filho.

Capítulo 6. Funções do Turbo Integrator TM1 251

Page 266: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

ElName O nome do elemento filho que você desejaexcluir.

ExemploDimensionElementComponentDeleteDirect(’Region’, ’Benelux’,’Belgium’);

Este exemplo exclui o filho Bélgica da consolidação Benelux na dimensão Região.

DimensionElementDeleteEsta função exclui um elemento de uma dimensão.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Nota: A exclusão de um elemento exclui todos os dados do cubo identificados poresse elemento.

SintaxeDimensionElementDelete(DimName, ElName);

Argumento Descrição

DimName A dimensão que contém o elemento quevocê deseja excluir.

ElName O elemento que você deseja excluir.

ExemploDimensionElementDelete(’Region’, ’Belgium’);

Este exemplo exclui o elemento Bélgica da dimensão Região.

DimensionElementDeleteDirectEsta função exclui um elemento a partir de uma dimensão editando diretamente adimensão.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Nota: A exclusão de um elemento exclui todos os dados do cubo identificados poresse elemento.

O meio padrão de edição de uma dimensão no Cognos TM1 é usar um padrão deediçã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ãoreal é regravada usando a cópia de edição como um modelo. O TurboIntegratorsuporta edição de cópia inteira automaticamente sempre que a edição de funçõesdo TurboIntegrator (como DimensionElementDelete) é usada no procedimento de

252 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 267: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Metadados O TurboIntegrator cria automaticamente a cópia de edição e aplica nelaas operações de edição, em seguida, regrava a dimensão real no fim doprocedimento de Metadados.

As edições diretas são diferentes porque nenhuma cópia de edição é envolvida. Emvez disso, as operações são executadas diretamente na dimensão real. Existem doiscasos de uso especializados diferentes para os quais esse tipo de edição direta édestinado:v Quando o propósito do processo TurboIntegrator for fazer uma pequena

mudança em uma grande dimensão. Nesse caso, a edição direta será maiseficiente porque evita copiar e regravar completamente a dimensão grande.

v Quando o propósito do processo TurboIntegrator for carregar grandes volumesde dados em um cubo. Nesse caso, o procedimento de Metadados do processo édeliberadamente mantido vazio e qualquer modificação de elemento necessáriapara suportar o carregamento de dados é executado usando as chamadas diretasno procedimento de Dados. Quando o procedimento de Metadados ficar vazio, oprocesso ignorará uma iteração inteira sobre a origem de dados externa, quepode resultar em carregamentos de dados mais rápidos.

SintaxeDimensionElementDeleteDirect(DimName, ElName);

Argumento Descrição

DimName A dimensão que contém o elemento quevocê deseja excluir.

ElName O elemento que você deseja excluir.

ExemploDimensionElementDeleteDirect(’Region’, ’Belgium’);

Este exemplo exclui o elemento Bélgica da dimensão Região.

DimensionElementInsertEsta função inclui um elemento em uma dimensão.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator. Esta função pode ser usada para incluir elementos numéricos, desequência ou consolidados. Observe que não é possível usar esta função nosprocedimentos de Dados ou do Epílogo de um processo do Turbo Integrator.

SintaxeDimensionElementInsert(DimName, InsertionPoint, ElName,ElType);

Argumento Descrição

DimName A dimensão na qual você deseja incluir umnovo elemento.

Capítulo 6. Funções do Turbo Integrator TM1 253

Page 268: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

InsertionPoint Um elemento de dimensão existente. Oelemento que está sendo incluído nadimensão será inserido imediatamente antesdeste elemento existente. Se este parâmetroestiver vazio, o novo elemento será incluídono final da dimensão.

ElName O nome que você deseja designar ao novoelemento.

ElType O tipo de elemento. Existem três possíveisvalores ElType:

N - Significa um elemento numérico.

S - Significa um elemento de sequência.

C - Significa um elemento consolidado.

ExemploDimensionElementInsert(’Region’, ’Belgium’, ’Netherlands’,’N’);

Este exemplo inclui o elemento numérico Países Baixos na dimensão Região. PaísesBaixos é exibido imediatamente antes de Bélgica na definição de dimensão.

DimensionElementInsertDirectEsta função inclui um elemento em uma dimensão editando diretamente adimensão.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator. Esta função pode ser usada para incluir elementos numéricos, desequência ou consolidados.

O meio padrão de edição de uma dimensão no TM1 é usar um padrão de ediçãode cópia inteira. Nesse padrão, uma cópia de edição da dimensão é criada, asediçõ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 TurboIntegratorsuporta a edição de cópia inteira sempre que a dimensão que edita as funçõesTurboIntegrator (como DimensionElementInsert) for usada na guia de metadadosdo processo. O TurboIntegrator cria automaticamente a cópia de edição e aplicanela as operações de edição, em seguida, regrava a dimensão real no fim doprocedimento de Metadados.

As edições diretas são diferentes porque nenhuma cópia de edição é envolvida. Emvez disso, as operações são executadas diretamente na dimensão real. Existem doiscasos de uso especializados diferentes para os quais esse tipo de edição direta édestinado:v Quando o propósito do processo TurboIntegrator for fazer uma pequena

mudança em uma grande dimensão. Nesse caso, a edição direta será maiseficiente porque evita copiar e regravar completamente a dimensão grande.

v Quando o propósito do processo TurboIntegrator for carregar grandes volumesde dados em um cubo. Nesse caso, o procedimento de Metadados do processo é

254 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 269: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

deliberadamente mantido vazio e qualquer inserção de elemento necessária parasuportar o carregamento de dados é executado usando as chamadas diretas noprocedimento de Dados. Quando o procedimento de Metadados ficar vazio, oprocesso ignorará uma iteração inteira sobre a origem de dados externa, quepode resultar em carregamentos de dados mais rápidos.

SintaxeDimensionElementInsertDirect(DimName, InsertionPoint, ElName,ElType);

Argumento Descrição

DimName A dimensão na qual você deseja incluir umnovo elemento.

InsertionPoint Um elemento de dimensão existente. Oelemento que está sendo incluído nadimensão será inserido imediatamente antesdeste elemento existente. Se este parâmetroestiver vazio, o novo elemento será incluídono final da dimensão.

Observe que esta função é otimizada para ocaso em que o InsertionPoint é passadocomo uma sequência vazia.

ElName O nome que você deseja designar ao novoelemento.

ElType O tipo de elemento. Existem três possíveisvalores ElType:

N - Significa um elemento numérico.

S - Significa um elemento de sequência.

C - Significa um elemento consolidado.

ExemploDimensionElementInsertDirect(’Region’, ’Belgium’, ’Netherlands’,’N’);

Este exemplo inclui o elemento numérico Países Baixos na dimensão Região. PaísesBaixos é exibido imediatamente antes de Bélgica na definição de dimensão.

DimensionElementPrincipalNameEsta função retorna o nome principal de um elemento ou alias de elemento.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

O Turbo Integrator deve usar nomes de elementos principais ao atualizardimensões; os aliases de elementos não podem ser usados. Portanto, esta função éútil para determinar nomes de elementos principais ao tentar atualizar umadimensão quando apenas os aliases de elementos estão disponíveis para o processodo Turbo Integrator.

Capítulo 6. Funções do Turbo Integrator TM1 255

Page 270: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeDimensionElementPrincipalName( 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 serum alias de elemento ou um nome deelemento 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 umnome de elemento principal, será retornado o nome principal do elemento.

DimensionExistsUse DimensionExists para determinar se existe uma dimensão específica noservidor a partir do qual um processo do Turbo Integrator é executado.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator. A função retornará 1 se a dimensão existir no servidor, caso contrário,retornará 0.

SintaxeDimensionExists(DimName);

Argumento Descrição

DimName O nome da dimensão cuja existência vocêdeseja confirmar.

ExemploDimensionExists(’Region’);

Este exemplo determina se a dimensão Região existe no servidor.

DimensionSortOrderEsta função define um tipo e direção de classificação para elementos de dimensãoe para componentes de elementos consolidados em uma dimensão.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator. A ordem de classificação definida por DimensionSortOrder determinacomo o subconjunto Todos é 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.

256 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 271: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeDimensionSortOrder(DimName, CompSortType, CompSortSense,ElSortType , ElSortSense);

Argumento Descrição

DimName O nome da dimensão para a qual vocêdeseja definir uma ordem de classificação.

CompSortType Define como os componentes de elementosconsolidados aparecem na dimensão.Existem dois valores CompSortType:

ByInput - Retém a ordem em que oscomponentes foram inseridos originalmenteem 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ávelapenas quando CompSortType é ByName.Existem dois possíveis valoresCompSortSense:

Ascending - Classifica componentes deconsolidações em ordem alfabética crescente.

Descending - Classifica componentes deconsolidações em ordem alfabéticadecrescente.

ElSortType Define uma ordem de classificação paraelementos de dimensão. Existem quatropossíveis valores ElSortType:

ByInput - Retém a ordem em que oselementos foram originalmente inseridos nadimensão.

ByName - Classifica elementos de dimensãopor nome.

ByLevel - Classifica elementos de dimensãopor nível.

ByHierarchy - Classifica elementos dedimensão por hierarquia.

Capítulo 6. Funções do Turbo Integrator TM1 257

Page 272: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

ElSortSense Define a direção de classificação paraelementos de dimensão. Este é umargumento necessário, mas é aplicávelapenas quando ElSortType é ByName ouByLevel. Existem dois possíveis valoresElSortSense:

Ascending - Classifica elementos dedimensão em ordem crescente, em ordemalfabética ou por nível.

Descending - Classifica elementos dedimensão em ordem decrescente, em ordemalfabética ou por nível.

ExemploDimensionSortOrder (’Region’, ’ByName’, ’Descending’,’ByLevel’, ’Ascending’);

Este exemplo define uma ordem de classificação para a dimensão Região. Todos oselementos de dimensão são classificados em ordem crescente por nível, e oscomponentes de consolidações são classificados em ordem alfabética decrescente.

DimensionUpdateDirectEsta função executa uma regravação integral de uma dimensão que estava sujeita adirecionar a edição em um processo TurboIntegrator, compactando essencialmentea área de cobertura da memória da dimensão.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Uma dimensão que passa por uma série de edições de direção apenas (exclusõesde elemento, em específico) usarão eventualmente mais memória do que suacontraparte totalmente regravada usaria. Opcionalmente, esta função pode serusada após editar uma dimensão com DimensionElementInsertDirect,DimensionElementDeleteDirect, DimensionElementComponentAddDirect,DimensionElementComponentDeleteDirect e/ouDimensionTopElementInsertDirect. Chamar DimensionUpdateDirect incorre em umcusto de memória de cópia completa inicial; embora possa ser usado para garantirque a dimensão fique na menor área de cobertura da memória possível depois queo processamento for concluído.

SintaxeDimensionUpdateDirect(DimName);

Argumento Descrição

DimName O nome da dimensão que você desejaregravar.

258 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 273: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

ExemploDimensionUpdateDirect(’Region’);

Este exemplo regrava a dimensão da Região.

DimensionTopElementInsertEsta função cria um elemento-raiz em uma dimensão.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator. Se a dimensão já tiver uma única raiz, esse elemento não será criado.

SintaxeDimensionTopElementInsert(DimName, InsertionPoint, ElName);

Argumento Descrição

DimName A dimensão para a qual você deseja criarum elemento-raiz.

InsertionPoint Um elemento de dimensão existente. Oelemento-raiz que está sendo incluído nadimensão será inserido imediatamente antesdeste elemento existente.

ElName O nome que você deseja designar ao novoelemento-raiz.

ExemploDimensionTopElementInsert(’Region’, ’Netherlands’, ’World’);

Este exemplo inclui o elemento-raiz Mundo na dimensão Região. Mundo é inseridoimediatamente antes dos Países Baixos na definição de dimensão.

DimensionTopElementInsertDirectEsta função cria um elemento-raiz em uma dimensão editando diretamente adimensão.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator. Se a dimensão já tiver uma única raiz, esse elemento não será criado.

O meio padrão de edição de uma dimensão no Cognos TM1 é usar um padrão deediçã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ãoreal é regravada usando a cópia de edição como um modelo. O TurboIntegratorsuporta edição de cópia inteira automaticamente sempre que a edição de funçõesdo TurboIntegrator (como DimensionTopElementInsert) é usada no procedimentode Metadados do processo. O TurboIntegrator cria automaticamente a cópia deedição e aplica nela as operações de edição, em seguida, regrava a dimensão realno fim do procedimento de Metadados.

Capítulo 6. Funções do Turbo Integrator TM1 259

Page 274: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

As edições diretas são diferentes porque nenhuma cópia de edição é envolvida. Emvez disso, as operações são executadas diretamente na dimensão real. Existem doiscasos de uso especializados diferentes para os quais esse tipo de edição direta édestinado:v Quando o propósito do processo TurboIntegrator for fazer uma pequena

mudança em uma grande dimensão. Nesse caso, a edição direta será maiseficiente porque evita copiar e regravar completamente a dimensão grande.

v Quando o propósito do processo TurboIntegrator for carregar grandes volumesde dados em um cubo. Nesse caso, o procedimento de Metadados do processo édeliberadamente mantido vazio e qualquer modificação de elemento necessáriapara suportar o carregamento de dados é executado usando as chamadas diretasno procedimento de Dados. Quando o procedimento de Metadados ficar vazio, oprocesso ignorará uma iteração inteira sobre a origem de dados externa, quepode resultar em carregamentos de dados mais rápidos.

SintaxeDimensionTopElementInsertDirect(DimName, InsertionPoint, ElName);

Argumento Descrição

DimName A dimensão para a qual você deseja criarum elemento-raiz.

InsertionPoint Um elemento de dimensão existente. Oelemento-raiz que está sendo incluído nadimensão será inserido imediatamente antesdeste elemento existente.

ElName O nome que você deseja designar ao novoelemento-raiz.

ExemploDimensionTopElementInsertDirect(’Region’, ’Netherlands’, ’World’);

Este exemplo inclui o elemento-raiz Mundo na dimensão Região. Mundo é inseridoimediatamente antes dos Países Baixos na definição de dimensão.

Funções Open Database Connectivity do Turbo IntegratorEstas funções facilitam a manipulação de ODBC.

ODBCCloseEsta função fecha uma conexão com uma origem de dados Open DatabaseConnectivity.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

260 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 275: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeODBCClose(Source);

Argumento Descrição

Origem O nome de uma origem de dados OpenDatabase Connectivity aberta.

ExemploODBCClose(’Accounting’);

Este exemplo fecha a conexão com a origem Open Database Connectivity deContabilidade.

ODBCOpenEsta função abre uma origem de dados Open Database Connectivity para saída.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeODBCOpen(Source, ClientName, Password);

Argumento Descrição

Origem Um nome de origem de dados OpenDatabase Connectivity.

ClientName Um cliente válido na origem de dados.

Senha A senha para o ClientName.

ExemploODBCOpen(’Accounting’, ’Jdoe’, ’Bstone’);

Este exemplo abre a origem de dados Open Database Connectivity deContabilidade para o cliente Jdoe usando a senha Bstone.

ODBCOPENExEsta função abre uma origem de dados Open Database Connectivity para saída,especificando que a conexão deve ser aberta como uma conexão Unicode.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

O formato é: ODBCOPENEx (nome do conjunto de dados, nome do cliente doconjunto de dados, senha do cliente, (usar sinalizador de interface Unicode) )

Capítulo 6. Funções do Turbo Integrator TM1 261

Page 276: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeODBCOpenEx(Source, ClientName, Password, UseUnicodeODBC);

Argumento Descrição

Origem Um nome de origem de dados OpenDatabase Connectivity.

ClientName Um cliente válido na origem de dados.

Senha A senha para o ClientName.

UseUnicodeODBC Define o tipo de conexão Unicode a serusada.

ExemploODBCOpenEx( 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 WHERECustomerId = 1

ODBCOutputEsta função executa uma consulta de atualização SQL em uma origem de dadosOpen Database Connectivity.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator. A função ODBCOpen deve ser usada para abrir a origem de dadosantes de chamar ODBCOutput, e ODBCClose deve ser usada para fechar a origemde dados antes de sair do processo.

SintaxeODBCOutput(Source, SQLQuery, [SQLQuery2, SQLQuery3, ...]);

Argumento Descrição

Origem A origem de dados Open DatabaseConnectivity na qual você deseja executaruma consulta.

262 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 277: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

SQLQuery Uma instrução de consulta SQL.

Embora ODBCOutput foi desenvolvida paraatualizar tabelas, ela pode ser usada paraexecutar qualquer consulta SQL na origemde dados.

Em circunstâncias nas quais a instrução deconsulta SQL excede 255 caracteres, vocêdeve dividir a consulta em váriosargumentos SQLQuery (SQLQuery2,SQLQuery3, etc.). Isto permite criarinstruções de consulta que excedem o limitede 255 caracteres para argumentos do TurboIntegrator. Quando a função ODBCOutputfor executada, todos os argumentosSQLQuery serão concatenados e a consultaserá executada com êxito.

ExemploODBCOutput(’Accounting’, ’INSERT [CategoryID], [CategoryName]FROM Categories;’);

Este exemplo executa a consulta especificada na origem de dados deContabilidade.

SetODBCUnicodeInterfaceEsta função define se a interface Open Database Connectivity deve usar as funções"largas" Unicode ou as funções regulares de caractere de byte único.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Configurar essa função como 1 usa a interface Open Database Connectivity decaractere largo.

Alguns drivers Open Database Connectivity suportam a interface de byte únicomais antiga, bem como uma interface de 'caractere largo' de estilo Unicode, na qualos caracteres são transmitidos e recuperados como quantidades de 16 bits. Se odriver escolhido não suportar um ou o outro estilo, será fornecido um sinalizadorpara forçar o Turbo Integrator a usar um estilo específico de interface.

SintaxeSetODBCUnicodeInterface=1

Argumento Descrição

1 Usar a interface Open Database Connectivityde caractere largo.

0 Usar a interface de byte único.

Capítulo 6. Funções do Turbo Integrator TM1 263

Page 278: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Funções de Controle de Processo do Turbo IntegratorEstas funções referem-se ao controle de processo.

ProcessErrorEsta função causa uma finalização imediata de um processo.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Os processos finalizados com esta função são sinalizados com um status de erro.

SintaxeProcessError;

Argumentos

Nenhum.

ExecuteCommandEsta função executa uma linha de comandos durante um processo. É possível usarExecuteCommand para executar um aplicativo de desktop, mas não um serviço.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Se você usar ExecuteCommand para executar um executável, as seguintescondições serão aplicáveis:v Se o argumento CommandLine especifica somente o nome de um arquivo a ser

executado, um servidor Windows procura pelo arquivo no banco de dados doservidor e no diretório onde o Tm1s.exe reside. Um servidor UNIX procura peloarquivo somente o diretório do banco de dados do servidor.

v Se o argumento CommandLine utilize um prefixo de caminho relativo, ambos osservidores Windows e o UNIX tentam localizar o arquivo no diretório do bancode dados do servidor apenas.

v No servidor Microsoft Windows ou no servidor UNIX serve[]r, é possíveltransmitir um caminho absoluto para o argumento CommandLine executar umarquivo em qualquer local.

SintaxeExecuteCommand(CommandLine, Wait);

Argumento Descrição

CommandLine A linha de comandos que você desejaexecutar.

264 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 279: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

Espera Indica se o processo deve esperar aconclusão da execução do comando antes decontinuar na próxima instrução de processo.Um valor do argumento de 0 faz o processoprosseguir para a próxima instrução semesperar a execução da linha de comandos.Um valor do argumento de 1 faz o processoesperar a execução bem-sucedida da linhade comandos antes de prosseguir para apróxima instrução.

ExecuteProcessEsta função permite executar um processo do Turbo Integrator a partir de outroprocesso.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeExecuteProcess(ProcessName, [ParamName1, ParamValue1,ParamName2, ParamValue2]);

Argumento Descrição

ProcessName O nome do processo a ser executado. Esse processo deveresidir no mesmo servidor que o processo a partir do qual oExecuteProcess é chamado.

Se o processo nomeado por este argumento não for localizadono tempo de execução, o processo de chamada será finalizadoimediatamente. (O Turbo Integrator não verifica umProcessName válido na compilação.)

ParamName O nome de um parâmetro existente do processo a serexecutado. Este argumento será necessário apenas se oprocesso a ser executado usar parâmetros.

ParamValue Um valor válido para o parâmetro ParamName. Se vocêespecificar um argumento ParamName, deverá especificar umParamValue correspondente.

Os argumentos ParamName e ParamValue devem ocorrer empares ordenados, com o nome do parâmetro seguido pelovalor. Você deve especificar um ParamName e umParamValue correspondente para cada parâmetro do processoa ser executado.

Os nomes de parâmetros transmitidos na função ExecuteProcess sãocorrespondidos no tempo de execução com os nomes de parâmetros especificadosno processo a ser executado. Se os nomes transmitidos não forem localizados nalista de parâmetros do processo a ser executado, ocorrerá um erro grave, causandoa finalização imediata do processo a partir do qual ExecuteProcess é chamada.

Capítulo 6. Funções do Turbo Integrator TM1 265

Page 280: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Valores de Retorno

ExecuteProcess retorna um valor real que pode ser testado em uma das seguintesfunções de valor de retorno:

Função Descrição

ProcessExitByChoreQuit() indica que o processo foi encerrado devido à execução dafunção ChoreQuit

ProcessExitNormal() indica que o processo foi executado normalmente

ProcessExitMinorError() indica que o processo foi executado normalmente, masencontrou erros secundários

ProcessExitByQuit() indica que o processo foi encerrado devido a um comando"quit" explícito

ProcessExitWithMessage() indica que o processo foi encerramento normalmente comuma mensagem 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 umafunção ProcessBreak

Exemplo

Para registrar uma falha de um processo chamado por ExecuteProcess devido a umerro grave, use um có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;

GetProcessErrorFileDirectoryEsta função retorna o nome do caminho completo, com uma barra à direita, dodiretório onde os arquivos de erro de processo do Turbo Integrator são gravados.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator. Por padrão, todos os arquivos de log de erro de processo são gravadosno diretório de dados do servidor em que o processo reside.

SintaxeGetProcessErrorFileDirectory;

Argumentos

Nenhum.

266 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 281: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

GetProcessErrorFilenameEsta função retorna o nome do arquivo de log de erros do processo do TurboIntegrator associado a um processo.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator. Se o processo ainda não tiver gerado um arquivo de log de erros, afunção retornará uma sequência vazia (nula).

Importante: Um arquivo de log de erro de processo não é gerado até todas asinstruções em uma determinada guia do processo (Prólogo, Metadados, Dados ouEpílogo) terem sido executadas. De forma apropriada, é possível usarGetProcessErrorFilename para verificar se alguma guia anterior gerou um arquivode log de erros, mas não é possível usar a função para determinar se a guia doprocesso atual causa a gravação de erros em um arquivo de log.

Por exemplo, ao determinar que GetProcessErrorFilename retorna uma sequêncianão nula na guia Epílogo, você pode informar que foram gerados erros nas guiasPrólogo, Metadados ou Dados. No entanto, não é possível usarGetProcessErrorFilename na guia Dados para determinar se a guia Dados geraerros.

SintaxeGetProcessErrorFilename;

Argumentos

Nenhum.

GetProcessNameEsta função retorna como uma sequência o nome do processo atual.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeGetProcessName()

Argumentos

Nenhum.Name = GetProcessName();

SeA instrução Se permite que um processo execute uma instrução ou séries deinstruções quando uma determinada expressão é true.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator. É 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 ainstrução do TurboIntegrator pode aceitar várias instruções ElseIf ou Else paraavaliar diversas expressões, enquanto a função IF de Regras só pode avaliar umaexpressão.

Capítulo 6. Funções do Turbo Integrator TM1 267

Page 282: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

É possível aninhar até 20 instruções If/ElseIf/Else em um processoTurboIntegrator. Se exceder 20 instruções If/ElseIf/Else aninhadas, você receberáum erro ao tentar salvar o processo.

SintaxeIf(expression);statement1;ElseIf(expression);statement2;ElseIf(expression);statement3;Else;statement4;EndIf;

Argumentos

Nenhum.

ExemplosIf (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á executadapara gravar a sequência "x equals five" em c:\temp\if.txt. Se X não for igual a 5, aprimeira instrução ElseIf será avaliada. Se X=1, a funçã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, comoneste exemplo:IF(expression);statement1;ELSE;statement2;ENDIF;

ItemRejectEsta função rejeita um registro de origem e coloca-o no log de erros, juntamentecom uma mensagem de erro especificada.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

268 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 283: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeItemReject(ErrorString);

Argumento Descrição

ErrorString A mensagem de erro que você deseja gravarno log de erros quando um registro érejeitado.

ExemploItemReject(’ Value outside of acceptable range.’);

Este exemplo coloca um registro de origem no log de erros, juntamente com amensagem de erro 'Valor fora do intervalo aceitável.' quando o registro de origemcontiver um valor que esteja além de um intervalo definido.

ItemSkipIsto força um processo a ignorar o item de origem de dados atual.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeItemSkip;

Argumentos

Nenhum.

ProcessBreakEsta função para o processamento de dados de origem e prossegue para a parteEpílogo de um processo.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeProcessBreak;

Argumentos

Nenhum.

ProcessErrorEsta função causa uma finalização imediata de um processo.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Os processos finalizados com esta função são sinalizados com um status de erro.

Capítulo 6. Funções do Turbo Integrator TM1 269

Page 284: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeProcessError;

Argumentos

Nenhum.

ProcessQuitEsta função finaliza um processo do Turbo Integrator.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeProcessQuit;

Argumentos

Nenhum.

WhileA instrução While do Turbo Integrator permite que um processo repita uma sériede instruções enquanto uma determinada condição é true.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

As instruções While podem ser aninhadas.

SintaxeWHILE(logical expression);

statement1;

statement2;

...

statement n;

END;

Nota: Todas as instruções WHILE devem ser concluídas com uma instrução END.

Argumentos

Nenhum.

SincronizadoSynchronized() é usado em um script do TurboIntegrator para forçar a execuçãoserial de um conjunto designado de processos TurboIntegrator.

A função synchronized() usa a seguinte sintaxe.synchronized(string)

270 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 285: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Parâmetros

A função synchronized() usa um único parâmetro obrigatório, que é um nomedefinido pelo usuário para um objeto de bloqueio. Esse nome de objeto debloqueio pode ser usado em diversos processos do Turbo Integrator para serializarsua execução como um grupo.

Parâmetro

Descrição

Valor/Obrigatório/Padrão

lockName O nome definido pelo usuário de um objetode bloqueio no qual sincronizar. Os nomesnão fazem distinção entre maiúsculas eminúsculas e os espaços integrados sãoignorados. Os nomes não podem exceder1023 caracteres de comprimento.

Sequência/Sim/Nenhum

Semântica

Um processo do Turbo Integrator pode fazer qualquer número de chamadas parasynchronized(), com qualquer número de objetos de bloqueio. A serialização temefeito do momento em que synchronized() é chamada, até a conclusão da transaçãode contenção.

Por exemplo, se synchronized() for chamada a partir de um subprocesso (Ps) deum processo principal (Pm) ou tarefa principal (Cm), o Objeto de Bloqueio será"liberado" com a conclusão de Pm ou Cm. A exceção é que um SaveDataAll (SDA)"encerra" prematuramente uma execução de transação durante o processo; isso seaplica também a Objetos de Bloqueio.

A chamada de synchronized() pode ser colocada em qualquer lugar em um scriptdo Turbo Integrator, mas a serialização se aplica a todo o processo do TurboIntegrator quando este é encontrado.

Considere um processo do Turbo Integrator com uma chamada synchronized() emalgum lugar no "meio" de seu script, e a operação O1 precedendo essa chamada.Duas instâncias deste processo do Turbo Integrator podem ser iniciadas ao mesmotempo. É possível que uma instância seja executada até a conclusão, incluindo suachamada para synchronized(), antes que a segunda instância atinja sua chamadasynchronized(). Nesse caso, os dois processos serão exibidos para o usuário comoexecutados simultaneamente. Se, em vez disso, o segundo processo não atingir suachamada synchronized() antes da conclusão do primeiro, ele desfará qualquertrabalho que tenha feito (O1) e aguardará a conclusão do primeiro. Nesse caso, osdois 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ão imposto) que as chamadas synchronized() sejam asprimeiras instruções de um processo do Turbo Integrator.

Exemplo

Considere que o processo P do Turbo Integrator precise atualizar dois cubosCube_1 e Cube_2.

Capítulo 6. Funções do Turbo Integrator TM1 271

Page 286: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

É possível que outros processos do Turbo Integrator também precisem atualizar oCube_1 ou o Cube_2.

Para fazer com que todos os processos do Turbo Integrator que irão atualizar oCube_1 ou o Cube_2 sejam executados ao mesmo tempo, P poderia chamarsynchronized() 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 );

CellPutn( 111, sCube_1, sE1, sE2 );CellPutn( 9.99, sCube_2, sE4, sE5 );

# ...

Os outros processos do Turbo Integrator que irão atualizar o Cube_1 ou o Cube_2também de vem chamar o synchronized( sCube_1 ) e/ou o synchronized(sCube_2 ) de modo semelhante.

Nesse exemplo, os nomes dos dois objetos de bloqueio foram escolhidos paraserem iguais aos nomes dos cubos. Mas o nome do objeto de bloqueio não precisaser igual ao de outros objetos do Cognos TM1 (cubos, dimensões, subconjuntos,etc.).

Funções de Gerenciamento de Regras do Turbo IntegratorEstas funções facilitam o gerenciamento de regras.

CubeProcessFeedersEsta função reprocessa todos os alimentadores nas regras para um cuboespecificado.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Esta função reprocessa todos os alimentadores nas regras para um cuboespecificado. Normalmente, os alimentadores são reprocessados automaticamentequando uma edição do arquivo de regras é salva, no entanto, se os dados foremalterados, e essas mudanças em dados alterarem alguns alimentadorescondicionais, esta função precisará ser chamada para que esses alimentadorescondicionais sejam reavaliados.

SintaxeCubeProcessFeeders(CubeName);

Argumento Descrição

CubeName O cubo para o qual você deseja reprocessaralimentadores.

272 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 287: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

ExemploCubeProcessFeeders(’2003sales’);

Este exemplo reprocessa todos os alimentadores nas regras para o cubo 2003sales.

CubeRuleAppendEsta função conecta uma única linha do texto da regra a uma regra do cubo TM1 .

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Essencialmente, esta função inclui uma única linha de texto em um arquivo deregra (.rux). A linha de texto geralmente é uma instrução de regra, mas tambémpode ser um comentário. Se não houver nenhuma regra associada ao cubo nomomento em que esta função é executada, uma nova regra será criada, contendoapenas a linha passada.

SintaxeCubeRuleAppend(CubeName, RuleText, IsCalculationRule);

Argumento Descrição

CubeName O nome do cubo associado à regra à qualvocê deseja conectar uma linha de texto.

RuleText A linha única de texto que você desejaanexar à regra.

A linha inteira de texto que você inclui deveser colocada entre aspas simples e deveaderir a convenções de sintaxe de regras.

Se a linha de texto incluir alguma referênciade elemento, os nomes de elemento devemser colocados entre aspas simples duplaspara escapar as aspas simples quenormalmente cercam os nomes de elemento.Por exemplo, uma referência a um elementodenominado CL3 deve ser especificada como[’’CL3’’].

A seguir estão exemplos de linhas válidas detexto que você pode anexar a uma regra:

’[’’CL3’’] = [’’CL4’’] + [’’Trial’’];’

’skipcheck;’

’[’’Trial’’] => [’’CL3’’];’

Capítulo 6. Funções do Turbo Integrator TM1 273

Page 288: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

IsCalculationRule O parâmetro IsCalculationRule declara se alinha deve ser inserida pouco acima dealguma seção do alimentador que possaexistir na regra do cubo. Se o parâmetroIsCalculationRule for omitido ou passadocomo 0.0, a nova linha simplesmente seráanexada ao fim da regra.

Como os arquivos de regra (.rux) consistemem uma seção de cálculo seguida por umaseção opcional do alimentado, qualquerlinha anexada que seja instrução de regra decálculo (ou comentários correspondentes)deve usar um 1.0 para que esse argumentoassegure que a nova linha seja inserida nolocal apropriado no arquivo de regra.

ExemplosCubeRuleAppend( ’MyCube’, ’[’’CL3’’] = [’’CL4’’] + [’’Trial’’];’, 1.0 );

Este exemplo insere a instrução de cálculo [’CL3’] = [’CL4’] + [’Trial’]; no fimda seção do cálculo da regra para o cubo MyCube.CubeRuleAppend( ’MyCube’, ’[’’Trial’’] => [’’CL3’’];’, 0.0 );

Este exemplo insere a instrução do alimentador [’Trial’] => [’CL3’]; no fim daregra para o cubo MyCube.

CubeRuleDestroyEsta função exclui qualquer regra existente para um cubo especificado.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeCubeRuleDestroy(CubeName);

Argumento Descrição

CubeName O nome do cubo associado à regra que vocêdeseja excluir

ExemploCubeRuleDestroy(’SalesProjections’);

Este exemplo exclui a regra para SalesProjectionscube.

DeleteAllPersistentFeedersExclui todos os arquivos .feeder que persistiram.

274 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 289: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Quando esta função for usada, todos os cubos serão marcados como "não salvaralimentadores", portanto, um "SaveData" não persistirá os alimentadores, quesignifica que todos os alimentadores serão recalculados em um reinício do servidor.

SintaxeDeleteAllPersistentFeeders;

Argumento Descrição

nenhum Não há nenhum argumento para essafunção.

ForceSkipCheckForça a consulta a executar como se o cubo tivesse um SKIPCHECK nas regras.

Isso significa que a consulta processará somente valores realmente no cubo, comooposição ao (o caso não SKIPCHECK) local em que cada célula possível seriaenumerada procurando valores. Esta função configura o estado da consulta devisualização para selecionar somente valores no cubo. A função deve ser incluídana seção Prólogo do processo do Turbo Integrator. Ao colocar o ForceSkipCheck()no Prólogo, ele afeta a consulta inteira de visualização de elementos de dados aseguir.

SintaxeForceSkipCheck()

Argumento Descrição

nenhum Não há nenhum argumento para essafunção.

RuleLoadFromFileEsta função cria uma regra do TM1 para um cubo especificado a partir de umarquivo de texto.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

O arquivo de texto deve ser formatado de acordo com convenções de regras doTM1 . Cada instrução de regra deve ser concluída com um ponto e vírgula (;) e oscomentários devem ser prefixados com o caractere #.

Se já existir uma regra para o cubo especificado, a regra existente será sobrescritapela regra criada por RuleLoadFromFile.

Capítulo 6. Funções do Turbo Integrator TM1 275

Page 290: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeRuleLoadFromFile(Cube, TextFile);

Argumento Descrição

Cubo O nome do cubo para o qual você desejacriar uma regra.

TextFile O nome do arquivo de texto a partir do qualvocê deseja criar uma regra.

É possível especificar o caminho completopara este arquivo, incluindo o nome eextensão do arquivo. (Exemplo 1 abaixo.)

Se especificar somente o nome e a extensãodo arquivo, o Turbo Integrator procura oarquivo no diretório de dados do servidor.

Se você não especificar uma extensão doarquivo, o Turbo Integrator considerará aextensão .rux por padrão. (Exemplo 2abaixo.)

Se deixar o argumento TextFile vazio, o Turbo Integrator procura um arquivo deorigem com o mesmo nome que o cubo (mas com uma extensão .rux) no diretóriode dados do servidor. (Exemplo 3 abaixo.)

ExemploRuleLoadFromFile(’Sales’, ’C:\temp\cuberule.txt’);

Este exemplo usa o conteúdo do arquivo cuberule.txt no diretório C:\temp paracriar uma regra para o cubo Sales.RuleLoadFromFile(’Sales’, ’cuberule’);

Este exemplo cria uma regra para o cubo Sales usando o arquivo denominadocuberule.rux no diretório de dados do servidor.RuleLoadFromFile(’Sales’, ’ ’);

Este exemplo cria uma regra para o cubo Sales usando o arquivo denominadoSales.rux no diretório de dados do servidor.

Funções do Ambiente de SimulaçãoEstas funções são usadas com ambientes de simulações.

GetUseActiveSandboxPropertyEsta função retorna um valor Booleano que indica se um processo lê e grava dadosnos dados base ou no ambiente de simulação ativo do usuário.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

O padrão é para os processos lerem e gravarem nos dados base.

276 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 291: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

v Se o retorno for 0, isto indica que o processo está lendo e gravando nos dadosbase.

v Se o retorno for 1, isto indica que o processo está lendo e gravando no ambientede simulação ativo.

Nota: Esta função retorna o valor permanente para esta propriedade conformedefinido na interface com o usuário do Architect / Server Explorer, a menos quevocê tenha usado a função SetUseActiveSandboxProperty no processo. Nesse caso,o valor para esta propriedade é determinado pelo valor que foi definido pelaúltima vez com a função SetUseActiveSandboxProperty.

SintaxeGetUseActiveSandboxProperty()

Nenhum.

Exemploreturn_value = GetUseActiveSandboxProperty();

Este exemplo retornará um valor Booleano que indica se o processo está lendo egravando dados do cubo no ambiente de simulação ativo ou nos dados base.

ServerSandboxesDeleteServerSandboxesDelete permite que administradores descartem ambientes desimulação de usuários que correspondem a determinados critérios.

Esta é uma função do TM1 Turbo Integrator válida em processos do TurboIntegrator.

Os ambientes de simulação são áreas de trabalho privadas nas quais o usuáriopode inserir ou armazenar valores de dados separados dos dados base do IBMCognos TM1 . Ambientes de simulação são armazenados em disco e, quando emuso, na memória. Essa funcionalidade opera do lado do servidor e está disponívelatravés do Turbo Integrator e da função da API ServerSandboxesDelete. Usandoesse recurso em um processo do Turbo Integrator, os administradores podemplanejar a manutenção usando a tarefas de organização de processosautomatizadas.

Descrição

Esta função usa um "predicado" para descrever o ambiente de simulação sendoexcluído. Um predicado pode ser lido como: "Excluir ambientes de simulação cujoatributo é condição valor."

Por exemplo: "Excluir ambientes de simulação cujo tamanho ultrapassa 10 MB."Nesse exemplo, o atributo é 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 TurboIntegrator. Como um ambiente de simulação não tem restrições quanto a quaiscaracteres podem ser usados em seus nomes, os administradores podem fornecerseu próprio delimitador "seguro" quando necessário.

Por exemplo, ServerSandboxesDelete( ’client:=:Admin, name:=:best casescenario’ );"

Capítulo 6. Funções do Turbo Integrator TM1 277

Page 292: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

No exemplo a seguir, o caractere dois pontos é usado no nome do ambiente desimulação ("cenário::de boas::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 osformulários de interface de programação de aplicativos dessa função.

SintaxeServerSandboxesDelete(string,string,string)

Argumentos

Predicados

Necessário

Sequência

Nenhum padrão

Uma lista de comprimento arbitrário de predicados. Cada predicado é umasequência contendo três tokens. O primeiro token indica um atributo de umambiente de simulação. O segundo indica uma condição, por exemplo, ">" ou"=". O terceiro token é um possível valor do atributo em que ambientes desimulação devem ser condicionalmente filtrados. A sequência inteira não podeexceder 10.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.

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 elepode ser condicionalmente correspondido. Nomes de atributo e suas condiçõesválidas correspondentes não fazem distinção entre maiúsculas e minúsculas eignoram espaços em branco integrados. Por exemplo, as duas chamadas a seguirsão válidas:

ServerSandboxesDelete( ’client:=:Admin’ );

ServerSandboxesDelete( ’C L I E N T : = :Admin’ );

278 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 293: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Tabela 1. Atributos de Filtro

Atributo DescriçãoCondiçõesVálidas Tipo de Valor

UpdateDate Registro de data e horada última ação degravação executada noambiente de simulação.

<, =, >. Registro de data e hora em formatopadrão internacional, isto é,YYYY-MM-DD. Dias são asunidades mais granulares.

AccessDate Registro de data e horado últimodescarregamento deum ambiente desimulação.

<, =, >. Registro de data e hora em formatopadrão internacional, isto é,YYYY-MM-DD. Dias são asunidades mais granulares.

CreationDate Registro de data e horada criação de umambiente de simulação.

<, =, >. Registro de data e hora em formatopadrão internacional, isto é,YYYY-MM-DD. Dias são asunidades mais granulares.

Tamanho O tamanho namemória de umambiente de simulação.

<, =, >. Tamanho seguindo as regras deconversão de log4cxx (consulte oparâmetro de configuraçãoAuditLogMaxTemp FileSize). Porexemplo, 10 MB. Kilobytes são asunidades mais granulares.

Nome O nome de umambiente de simulação.

=,containing.

Sequência.

Cliente O cliente proprietáriode um ambiente desimulação.

=. Sequência.

Grupo Um grupo do qual umcliente proprietário deum ambiente desimulação é membro.

=. Sequência.

Criação de Log e Retornos

A exclusão de um ambiente de simulação é registrada usando a funcionalidade decriação de log de auditoria pré-existente. Além disso, um relatório mais detalhadodos efeitos da administração de um ambiente de simulação é incluído no log dedepuração (tm1server.log) no nível INFO. Esse relatório incluirá a lista dosambientes de simulação afetados, bem como alguns dos atributos e errosencontrados.

ServerSandboxesDelete retorna apenas um status de sucesso ou falha.

Semântica

Lista de Predicados

Diversos predicados passados em uma única chamada paraServerSandboxesDelete são conjuntivos. Em outras palavras, para que umambiente de simulação corresponda aos critérios transmitidos, todos ospredicados devem ser verdadeiros. Diversas chamadas paraServerSandboxesDelete podem ser usadas para atingir o comportamento dapartícula disjuntiva. Apenas uma ocorrência de cada atributo é permitidapor chamada para ServerSandboxesDelete. Por exemplo, a transmissão deum cliente duas vezes é inválida, já que um ambiente de simulação tem

Capítulo 6. Funções do Turbo Integrator TM1 279

Page 294: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

apenas um cliente proprietário. Quando diversas ocorrências de umatributo são detectadas, um aviso é exibido no relatório detalhado, porém,a operação não é interrompida com uma falha. Nesse caso, os predicadossão testados como com qualquer outra consulta, mas o conjunto deresultados fica sempre vazio.

Bloqueio

Para evitar grandes problemas de bloqueio, ServerSandboxesDeleteexamina os ambientes de simulação de um cliente como uma capturainstantânea point-in-time e, em seguida, quando possível, libera osbloqueios que garantirão uma transação serializável. Por causa dessecomportamento, quando um cliente é "transmitido" na iteração de todos osclientes, um ambiente de simulação correspondente ao critério de filtragempode ser incluído nesse cliente antes de a transação de manutenção serconcluída. Esse comportamento é semelhante ao comportamento queocorre quando um ambiente de simulação é incluído no clienteimediatamente após a transação ser concluída.

Escopo

Membros dos grupos ADMIN (super usuário) e DataAdmin terão acesso atodos os ambientes de simulação de todos os clientes. Eles devemespecificar explicitamente o atributo do cliente para limitar o escopo de suachamada para ServerSandboxesDelete apenas para seus próprios ambientesde simulação. Todos os outros usuários possuem acesso a seus própriosambientes de simulação apenas; se especificarem um cliente diferente, ouum grupo para o qual eles não pertencem, a função abortará com falhas eretornará um erro de privilégio.

Ambientes de Simulação em Uso

Quando um ambiente de simulação atende aos critérios para exclusão, masestá atualmente em uso, ele não é excluído. Uma entrada aparecerá norelatório de nível de informação de log de depuração indicando aocorrência.

Datas de Acesso e Atualização

Os atributos de data podem ser correspondências com, no máximo, umagranularidade de dia. Devido a essa restrição, a gravação desses atributos écorrespondentemente granular. A Data da Última Atualização não éatualizada em gravações de célula individual. Em vez disso, o sistemaregistra a data de descarregamento de um ambiente de simulação quetinha algo gravado nele quando estava sendo carregado na memória. Paraesses ambientes de simulação, a Data do Último Acesso e a Data da ÚltimaAtualização serão as mesmas. Apenas a Data do Último Acesso seráatualizada durante o descarregamento de um ambiente de simulação damemória. Além disso, como os ambientes de simulação na memória nãoestão sujeitos a ServerSandboxesDelete, a Data do Último Acesso não seráatualizada quando um ambiente de simulação estiver carregado namemória.

Por exemplo, considere o cenário de uso a seguir:

Tabela 2. Exemplo do Dia do Último Acesso

Dia Hora Ação

1 1 Carregar Ambiente de Simulação S

1 2 Gravar 1

280 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 295: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Tabela 2. Exemplo do Dia do Último Acesso (continuação)

Dia Hora Ação

2 3 Ler 1

2 4 Descarregar Ambiente de Simulação

Um usuário está trabalhando com um ambiente de simulação no curso dedois dias (talvez por um período de tempo muito menor incluindo amudança de dia.) No horário 4, quando o ambiente de simulação édescarregado, a Data da Última Atualização está configurada como 2 emvez de 1, em que a última atualização ocorreu de fato. Data do ÚltimoAcesso também está configurada para 2 no horário 4 nesse caso. SeGravação 1 fosse uma leitura, apenas a Data do Último Acesso seriaconfigurada como 2, enquanto a Data da Última Atualização não seriaalterada.

ExemploServerSandboxesDelete( ’client:=:Admin, name:=:best case scenario’ );

ServerActiveSandboxGetEsta função retorna o nome do ambiente de simulação ativo do usuário executante.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Se o usuário não tiver nenhum ambiente de simulação ativo, será retornada umasequência vazia. Como as tarefas de organização de processos são executadas nocontexto de um usuário administrador especial e podem não ter nenhum ambientede simulação ativo, esta função sempre retornará uma sequência vazia quandoexecutada por meio de uma tarefa de organização de processos.

SintaxeServerActiveSandboxGet()

Argumentos

Nenhum.

Exemploreturn_value = ServerActiveSandboxGet();

Este exemplo retornará o ambiente de simulação ativo do usuário que estáexecutando o processo do TI no qual é feita a chamada de função.

ServerActiveSandboxSetEsta função define o ambiente de simulação ativo do usuário executante.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

É usada uma sequência vazia para limpar o ambiente de simulação ativo dousuário executante. Esta função lançará um erro se o usuário executante nãopossuir um ambiente de simulação com o nome transmitido. Como as tarefas deorganização de processos são executadas no contexto de um usuário administrador

Capítulo 6. Funções do Turbo Integrator TM1 281

Page 296: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

especial e podem não ter nenhum ambiente de simulação ativo, esta função semprelançará um erro quando executada por meio de uma tarefa de organização deprocessos.

Nota: Para um processo TurboIntegrator ler e gravar valores no contexto doambiente de simulação ativo do usuário da executante, a propriedadeUseActiveSandbox deve ser configurada. Consulte“GetUseActiveSandboxProperty” na página 276 e “SetUseActiveSandboxProperty”.

SintaxeServerActiveSandboxSet(SandboxName)

Argumento Descrição

SandboxName Um valor de sequência. O nome de umambiente de simulação pertencente aousuário executante.

ExemploServerActiveSandboxSet(’Best case’);

Este exemplo definirá o ambiente de simulação ativo do usuário executante como"Melhor caso".ServerActiveSandboxSet(’’);

Este exemplo limpará o ambiente de simulação ativo do usuário executante(definirá o contexto de volta para os dados base.)

SetUseActiveSandboxPropertyEsta função controla se um processo lê e grava dados do cubo nos dados base ouno ambiente de simulação ativo do usuário.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator. O padrão é para os processos lerem e gravarem nos dados base.

O escopo desta função é aplicável apenas ao processo atual em execução esubstitui temporariamente o valor permanente para esta propriedade que estádefinida na interface com o usuário do Architect / Server Explorer.

282 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 297: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeSetUseActiveSandboxProperty(PropertyValue)

Argumento Descrição

PropertyValue Um valor Booleano que indica se o processodeve usar o contexto do ambiente desimulação ativo ao ler e gravar dados docubo.

Se PropertyValue = 0, o processodesconsiderará o contexto do ambiente desimulação ativo e lerá/gravará nos dadosbase.

Se PropertyValue = 1, o processolerá/gravará dados do cubo no ambiente desimulação ativo.

ExemploSetUseActiveSandboxProperty(1);

Este exemplo fará o processo ler/gravar dados do cubo no ambiente de simulaçãoativo para o restante desta execução.

ServerSandboxExistsEsta função testa a existência do ambiente de simulação passado. Um valor igual a1 é retornado quando o ambiente de simulação passado existe; caso contrário, éretornado um 0.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeServerSandboxExists( sandboxname )

ouServerSandboxExists( sandboxname , username )

Argumentos

O nome do ambiente de simulação cuja existência está sendo testada.ServerSandboxExists usa um parâmetro de sequência opcional, o nome do clienteproprietário. O cliente da chamada usa o parâmetro opcional para especificar umcliente diferente de si se tiver os privilégios apropriados. Pode ocorrer um erro deprivilégio se o cliente especificado não for o cliente da execução e se o cliente daexecução não for membro dos grupos DataAdmin ou ADMIN. Se o parâmetroopcional não for usado, os ambientes de simulação do cliente ativo serão ossujeitos.

Exemplo

O fragmento a seguir mostra como as funções ServerSandboxExists,ServerSandboxGet e ServerSandboxListCountGet podem ser usadas para iterar osambientes de simulação de um usuário chamado User1 e emitir esses ambientes de

Capítulo 6. Funções do Turbo Integrator TM1 283

Page 298: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

simulação para um arquivo de texto. O processo TurboIntegrator seria executadocom sucesso para membros dos grupos Administradores ou Administradores deDados e para o usuário chamado User1. O processo TurboIntegrator falharia comum erro 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;

ServerSandboxGetEsta função retorna o nome do ambiente de simulação identificado pelo número N,em que N é o parâmetro inserido.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeServerSandboxGet( index )

ouServerSandboxGet( index, username)

Argumentos

O índice do ambiente de simulação solicitado na coleção de ambientes desimulação do usuário. O espaço de índice será contíguo, de modo que a primeiraocorrência de um retorno de sequência vazia possa ser usada para dividir aiteração. Além disso, a exclusão de um ambiente de simulação alterará os índicesde quaisquer ambientes de simulação que seguem esse ambiente de simulação nalista.

ServerSandboxGet usa um parâmetro de sequência opcional, o nome do clienteproprietário. O cliente da chamada usa o parâmetro opcional para especificar umcliente diferente de si se tiver os privilégios apropriados. Pode ocorrer um erro deprivilégio se o cliente especificado não for o cliente da execução e se o cliente daexecução não for membro dos grupos DataAdmin ou ADMIN. Se o parâmetroopcional não for usado, os ambientes de simulação do cliente ativo serão ossujeitos.

Exemplo

Consulte o “Exemplo” na página 283.

ServerSandboxListCountGetA função retorna a contagem de ambientes de simulação como um número.

284 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 299: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeServerSandboxListCountGet()

ouServerSandboxListCountGet( username )

Argumentos

ServerSandboxListCountGet usa um parâmetro de sequência opcional, o nome docliente proprietário. O cliente da chamada usa o parâmetro opcional paraespecificar um cliente diferente de si se tiver os privilégios apropriados. Podeocorrer um erro de privilégio se o cliente especificado não for o cliente da execuçãoe se o cliente da execução não for membro dos grupos DataAdmin ou ADMIN. Seo parâmetro opcional não for usado, os ambientes de simulação do cliente ativoserão os sujeitos.

Exemplo

Consulte o “Exemplo” na página 283.

Funções de Segurança do Turbo IntegratorEstas funções referem-se à segurança.

AddClientEsta função cria um novo cliente no servidor.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

As mudanças aplicadas por meio das funções AddClient não entrarã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 serusadas nas guias Dados ou Epílogo de um processo

SintaxeAddClient(ClientName);

Argumento Descrição

ClientName O nome do cliente que deseja incluir noservidor.

O nome do cliente é limitado a 255caracteres/bytes.

ExemploAddClient(’Brian’);

Este exemplo inclui o cliente Brian no servidor.

Capítulo 6. Funções do Turbo Integrator TM1 285

Page 300: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

AddGroupEsta função cria um novo grupo de usuários no servidor.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

As mudanças aplicadas por meio da função AddGroup não entrarã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 serusadas nas guias Dados ou Epílogo de um processo

SintaxeAddGroup(GroupName);

Argumento Descrição

GroupName O nome do grupo que você deseja criar.

ExemploAddGroup(’Finance’);

Esta função inclui o grupo de usuários Finance no servidor.

AssignClientToGroupEsta função designa um cliente existente em um servidor a um grupo de usuáriosexistente.

Esta é uma função TM1 TurboIntegrator válida apenas em processosTurboIntegrator. Ela designa um cliente existente em um servidor a um grupo deusuários existente.

SintaxeAssignClientToGroup(ClientName, GroupName);

Argumento Descrição

ClientName O nome do cliente que você deseja designara um grupo.

GroupName O grupo ao qual você deseja designar ocliente.

ExemploAssignClientToGroup(’Brian’, ’Finance’);

Este exemplo designa o cliente existente Brian ao grupo de usuários Finanças.

AssignClientPasswordEsta função designa uma senha a um cliente existente em um servidor.

286 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 301: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator. AssignClientPassword retorna 1 se a designação de senha forbem-sucedida e retorna 0 se a designação falhar.

SintaxeAssignClientPassword (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.Ao designar uma senha, use texto simples.O TM1 criptografará a senha no servidor.

As senhas devem ter pelo menos cincocaracteres.

ExemploAssignClientPassword (’Brian’, ’flyfisher’);

Este exemplo designa a senha 'flyfisher' ao cliente chamado Brian.

AssociateCAMIDToGroupEsta função cria uma associação entre um grupo de usuários do TM1 e umCAMID.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeAssociateCAMIDToGroup(GroupName, CAMID, CAMIDDisplayValue);

Argumento Descrição

GroupName O nome do grupo do TM1 que você desejaassociar ao CAMID.

CAMID O nome do grupo CAMID. Se o CAMID nãoexistir, ele será criado no cubo de controle}ClientCAMAssociatedGroups.

CAMIDDefDisplayValue O alias do grupo CAMID.

CellSecurityCubeCreateEsta função cria um cubo de segurança a partir de um cubo existente usando umconjunto de dimensões reduzido.

Esta é uma função TM1 TurboIntegrator válida apenas em processosTurboIntegrator.

Capítulo 6. Funções do Turbo Integrator TM1 287

Page 302: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Esta função, como todas as funções que atualizam metadados, não devem serusadas nas guias Dados ou Epílogo de um processo

SintaxeCellSecurityCubeCreate ('DataCube', '0:0:1:0');

Argumento Descrição

Cubo Nome do cubo de dados.

DimensionMap Sequência especificando se a dimensão emcada posição deve ser usada no cubo desegurança. A ordem das dimensões é aordem do cubo original. 1 para cadadimensã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.Caso contrário, erro grave.

Informações adicionais A propriedade GrantSecurityAccess deve serconfigurada para que este processoTurboIntegrator seja bem-sucedido. Ela criao cubo de segurança da célula.

ExemploCellSecurityCubeCreate ('DataCube', '0:0:1:0');

Esse exemplo cria um cubo RDCLS a partir do cubo chamado Cubo de Dados.

CellSecurityCubeDestroyEsta função destrói um cubo de segurança que foi criado a partir de um cuboexistente.

Esta é uma função TM1 TurboIntegrator válida apenas em processosTurboIntegrator.

Esta função, como todas as funções que atualizam metadados, não devem serusadas nas guias Dados ou Epílogo de um processo

SintaxeCellSecurityCubeCreate ('DataCube', '0:0:1:0');

Argumento Descrição

Cubo Nome do cubo de dados.

Retorno booleano Verdadeiro se a operação foi bem-sucedida.Caso contrário, erro grave.

Informações adicionais A propriedade GrantSecurityAccess deve serconfigurada para que este processoTurboIntegrator seja bem-sucedido. Destrói ocubo de segurança da célula.

288 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 303: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

ExemploCellSecurityCubeDestroy ('DataCube');

DeleteClientEsta função exclui um cliente do servidor.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

As mudanças aplicadas por meio da função DeleteClient não entrarã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 serusadas nas guias Dados ou Epílogo de um processo

SintaxeDeleteClient(ClientName);

Argumento Descrição

ClientName O nome do cliente que deseja excluir doservidor.

ExemploDeleteClient(’Brian’);

Este exemplo remove o cliente Brian do servidor.

DeleteGroupEsta função exclui um grupo de usuários do servidor.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

As mudanças aplicadas por meio da função DeleteGroup não entrarão em vigoraté 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 serusadas nas guias Dados ou Epílogo de um processo

SintaxeDeleteGroup(GroupName);

Argumento Descrição

GroupName O grupo que você deseja excluir.

ExemploDeleteGroup(’Finance’);

Este exemplo exclui o grupo de usuários Finance do servidor.

Capítulo 6. Funções do Turbo Integrator TM1 289

Page 304: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

ElementSecurityGetEsta função recupera o nível de segurança designado a um grupo especificado paraum elemento de dimensão.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeElementSecurityGet(DimName, ElName, Group);

Argumento Descrição

DimName A dimensão-pai do elemento para o qualvocê está recuperando um nível desegurança.

ElName O elemento para o qual você estárecuperando um nível de segurança.

Grupo O grupo de usuários para o qual você estárecuperando um nível de segurança.

ExemploElementSecurityGet(’Region’. ’Germany’, ’Budgeting’);

Este exemplo retorna o nível de segurança designado ao grupo de usuáriosOrçamento para o elemento Alemanha da dimensão Região.

ElementSecurityPutEsta função designa um nível de segurança a um grupo especificado para umelemento de dimensão.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeElementSecurityPut(Level, DimName, ElName, Group);

Argumento Descrição

Nível O nível de segurança que está sendodesignado. Existem seis possíveis valores deNível:

v Nenhum

v Ler

v Gravar

v Reservar

v Bloquear

v Administrador

290 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 305: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

DimName A dimensão-pai do elemento para o qualvocê está designando um nível desegurança.

ElName O elemento para o qual você estádesignando um nível de segurança.

Grupo O grupo de usuários para o qual você estádesignando um nível de segurança.

ExemploElementSecurityPut(’Reserve’, ’Region’, ’Germany’, ’Budgeting’);

Este exemplo designa a segurança Reserve ao grupo Orçamento para o elementoAlemanha da dimensão Região.

RemoveCAMIDAssociationEsta função remove todas as associações entre grupos de usuários do TM1 e umCAMID especificado.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeRemoveCAMIDAssociation(CAMID, RemoveCAMID);

Argumento Descrição

CAMID O nome do grupo CAMID para o qual vocêdeseja remover todas as associações desegurança.

RemoveCAMID Determina se o CAMID especificado éexcluído do cubo de controle}ClientCAMAssociatedGroups.

0 deixa o CAMID no cubo de controle}ClientCAMAssociatedGroups.

1 exclui o CAMID do cubo de controle}ClientCAMAssociatedGroups.

RemoveCAMIDAssociationFromGroupEsta função remove uma associação entre um grupo de usuários do TM1 e umCAMID.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Capítulo 6. Funções do Turbo Integrator TM1 291

Page 306: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeRemoveCAMIDAssociationFromGroup(GroupName, CAMID);

Argumento Descrição

GroupName O nome do grupo de usuários do TM1 parao qual deseja remover a associação.

CAMID O nome do grupo CAMID para o qualdeseja remover a associação.

RemoveClientFromGroupEsta função remove um cliente especificado de um grupo de usuários.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeRemoveClientFromGroup(ClientName, GroupName);

Argumento Descrição

ClientName O cliente que você deseja remover.

GroupName O grupo de usuários do qual você desejaremover o cliente.

ExemploRemoveClientFromGroup(’Brian’, ’Finance’);

Este exemplo remove o cliente Brian do grupo de usuários Finanças.

SecurityRefreshEsta função lê todos os cubos de controle de segurança e gera novamente asestruturas internas no servidor que são usadas por funções da Interface deProgramação de Aplicativos do TM1 .

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeSecurityRefresh;

Argumentos

Nenhum.

Funções de Manipulação do Servidor do Turbo IntegratorEstas funções facilitam a manipulação do servidor.

292 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 307: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

BatchUpdateFinishEsta função instrui o servidor a sair do modo de atualização de lote.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Quando vários processos estiverem em execução em modo de atualização de lote eaplicando mudanças em um único cubo, o esquema de bloqueio do TM1 poderáimpedir que um dos processos atualize o cubo. Isto é intencional; quando umprocesso obtiver um bloqueio para gravar mudanças em um cubo, outros processosserão impedidos de gravar nesse cubo com o objetivo de manter a integridade dedados.

Este esquema de bloqueio pode ser ilustrado usando um exemplo de doisprocessos, Processo 1 e Processo 2, que atualizam um único cubo.v Os dois processos iniciam e chamam a função BatchUpdateStart para iniciar

atualizações de lote.v Cada processo opera em uma origem de dados exclusiva.v 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 econfirma as mudanças.

v Enquanto o Processo 1 ainda suspende um bloqueio de gravação no cubo, oProcesso 2 conclui o processamento de dados e chama a funçãoBatchUpdateFinish. No entanto, como o Processo 1 retém o bloqueio, o Processo2 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. Istoassegura a integridade de dados.

Capítulo 6. Funções do Turbo Integrator TM1 293

Page 308: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Sintaxe

Dependendo do tamanho da origem de dados para o Processo 2, o retrocesso dedados e a nova execução do processo podem causar uma redução considerável nodesempenho. Para tratar este problema de desempenho, é recomendável usar afunção BatchUpdateFinishWait no lugar de BatchUpdateFinish.BatchUpdateFinish(SaveChanges);

Argumento Descrição

SaveChanges Um sinalizador que instrui o servidor asalvar ou descartar mudanças confirmadasdurante o modo de atualização de lote.

Especifique 0 para salvar mudanças, 1 paradescartá-las.

ExemploBatchUpdateFinish(0);

Este exemplo instrui o servidor a salvar mudanças em dados do TM1 e a sair domodo de atualização de lote.

BatchUpdateFinishWaitSe um processo chamar BatchUpdateFinishWait, mas não puder proteger umbloqueio de gravação do cubo para confirmar mudanças, o processo esperará atéque o bloqueio fique disponível e, em seguida, confirmará as mudanças.

294 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 309: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Esta função TurboIntegrator é idêntica à função BatchUpdateFinish com a seguinteexceção: o processo esperará até o bloqueio ficar disponível e confirmar asmudanças.

As mudanças em dados aplicadas no processo não são retrocedidas e o processonão é executado novamente.

Nota: Enquanto espera o bloqueio de gravação do cubo, o processo libera osbloqueios de leitura que ele adquiriu para outros objetos durante a execução doprocesso. Como estes bloqueios de leitura são liberados antes de o processoconfirmar mudanças no cubo, os objetos para os quais os bloqueios de leitura sãoliberados podem ser modificados antes da atualização do cubo. Isto pode gerarinconsistência de dados ao usar BatchUpdateFinishWait.

É recomendável que BatchUpdateFinishWait seja usada apenas em situaçõescontroladas, nas quais você sabe que outros processos não estão modificandodados ou metadados relacionados ao processo que chama BatchUpdateFinishWait.

SintaxeBatchUpdateFinishWait(SaveChanges);

Argumento Descrição

SaveChanges Um sinalizador que instrui o servidor asalvar ou descartar mudanças confirmadasdurante o modo de atualização de lote.Especifique 0 para salvar mudanças, 1 paradescartá-las.

ExemploBatchUpdateFinishWait(0);

Este exemplo instrui o servidor a salvar mudanças em dados do TM1 e a sair domodo de atualização de lote.

BatchUpdateStartEsta função ativa atualizações de lote.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeBatchUpdateStart;

Argumentos

Nenhum.

CubeSaveDataCubeSaveData() serializa um cubo.

Capítulo 6. Funções do Turbo Integrator TM1 295

Page 310: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Sintaxe

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Para melhorar o desempenho, a criação de logs de transações pode ser desativadadurante o carregamento de dados. Para proteger dados recém-carregados noimprovável caso de um travamento do servidor, as mudanças poderão serserializadas no disco. SaveDataAll foi usado para serializar dados no disco etruncar o log de transações. Ao processar um comando SaveDataAll, o servidoradquire um bloqueio de LEITURA em cada cubo e um bloqueio de IX em cadacubo alterado. Isso pode causar uma contenção significativa na atividade dousuário se SaveDataAll estiver em execução durante os períodos de atividade dousuário.

Normalmente nem todos os cubos afetados por SaveDataAll precisam serserializados, já que normalmente nem todos os cubos são carregados com novosdados. CubeSaveData é usado para serializar um cubo individual no disco.CubeSaveData serializa os dados do cubo que foram confirmados na memória,incluindo as modificações que foram executadas com relação a eles no atualprocesso do Turbo Integrator mas que ainda não foram confirmadas.CubeSaveData(Cube);

Argumento Descrição

Cubo O nome do cubo que deseja serializar.

ExemploCubeSaveData (’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élulaVendas de Janeiro é incluído na serialização do disco do cubo no disco, mesmo queele ainda não tenha sido confirmado. A atualização da célula Vendas de Janeiropara 1000 não fará parte da serialização.

Log de Transações

Uma nova entrada de transação aparece no Log de Transações quandoCubeSaveData é executado. Durante o processamento de um arquivo de log detransações durante a recuperação, todas as atualizações para um cubo que foramaplicadas até o momento serão descartadas quando uma diretiva CubeSaveDatacom relação ao cubo for encontrada, já que todas as atualizações já foramserializadas para o cubo.

Recuperação de Falha do Servidor

O comando SaveDataAll aproveita o fato de que todos os cubos são bloqueadosdurante o seu processamento e trunca o log de transações, sabendo que todas as

296 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 311: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

atualizações executadas antes da serialização foram seguramente armazenadas nodisco. Esse não é o caso para CubeSaveData, portanto, você deve modificar amaneira 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 maisantigas do que os dados mais recentes no cubo e não devem ser aplicados quandodados estiverem sendo recuperados.

DisableBulkLoadModeUsado para desativar o processamento de carregamento em massa.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator. Consulte “EnableBulkLoadMode” para obter detalhes.

EnableBulkLoadModeAtiva o modo de carregamento em massa para um processo TurboIntegrator.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

É possível ativar o modo de carregamento em massa na seção Prólogo ou Epílogode um processo TurboIntegrator. Para eficiência, ative o Modo de Carregamentoem Massa na primeira ou muito próximo da primeira instrução na seção Prólogode seu processo.

Depois de ativar o Modo de Carregamento em Massa em um processo, ele poderáser desativado apenas na última linha na seção Epílogo. Se você tentar desativar oModo de Carregamento em Massa em algum outro lugar no processo, o processonão será compilado.

Se o modo estiver ativado em um processo TurboIntegrator, ele permaneceráativado até ser desativado explicitamente ou até a tarefa de organização deprocessos ser concluída. Isso significa que é possível ativar o modo em umprocesso 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 esair do Modo de Carregamento em Massa repetidamente, usando o modo apenaspara algumas partes críticas de uma tarefa de organização de processos.

Use os comandos do TurboIntegrator a seguir e desative o modo de carregamentoem massa em um processo TurboIntegrator.

EnableBulkLoadMode()

DisableBulkLoadMode() - Esta função pode ser usada somente na última linha daseção Epílogo do processo do TI ao usar o Modo de Carregamento em Massa.

SaveDataAllEsta função salva todos os dados do TM1 da memória do servidor no disco ereinicia o arquivo de log.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Capítulo 6. Funções do Turbo Integrator TM1 297

Page 312: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Usando SaveDataAll em uma Tarefa de Organização deProcessos

SaveDataAll confirma todas as mudanças feitas por um tarefa de organização deprocessos antes de chamar a função SaveDataAll.

Enquanto uma tarefa de organização de processos está em execução, ela acumulabloqueios nos objetos que acessa. A operação de confirmação iniciada pela funçãoSaveDataAll libera temporariamente todos estes bloqueios. Quando a confirmaçãoestiver concluída, SaveDataAll readquirirá todos os bloqueios que ela possuía antespara 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ãoliberados e outro usuário ou processo do Turbo Integrator pode excluir objetos queestavam sendo usados pela tarefa de organização de processos original. Quando atarefa de organização de processos original tentar readquirir os bloqueios nestesobjetos, 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 arquivo Tm1s.log:844 WARN 2008-04-01 16:40:09,734 TM1.Server TM1ServerImpl::FileSavecouldnot reacquire lock on object with index 0x200002ca

Contenção de Bloqueio e Uso de SaveDataAll no Final dosProcessos do Turbo Integrator

O uso de SaveDataAll como último comando em um processo do Turbo Integratorpode aumentar a contenção de bloqueio em processos do TM1 Turbo Integrator.

Em versões do IBM Cognos TM1 , o SaveDataAll muitas vezes foi incluído no finalde um processo do Turbo Integrator que carrega dados com criação de logdesativada. O SaveDataAll fornecia uma maneira de gravar dados da memória nodisco diretamente após uma importação bem-sucedida, de modo que os dadosrecém-importados não seriam perdidos no caso de um contratempo, como umtravamento do servidor.

No entanto, a inclusão de SaveDataAll como último comando pode resultar eminúmeros processos de importação do Turbo Integrator, cada um com SaveDataAllcomo último comando. Essa técnica funcionava no TM1 Versão 9.0 e anterioresdevido a um modelo de bloqueio anterior que usava apenas bloqueio de gravaçãoglobal. Em versões anteriores, apenas uma operação de gravação por vez erapermitida. Portanto, operações SaveDataAll concorrentes simultâneas nuncaocorriam em diversas operações de gravação simultâneas.

A Versão 9.1 e as mais recentes introduziram um modelo de bloqueio-por-objetomais granular que permite operações de gravação simultâneas, caso essasoperações de gravação não disputem os mesmos recursos. Se elas competirempelos mesmos recursos, ocorrerá uma contenção de bloqueio, forçando um dosprocessos a retroceder. Portanto, agora dois processos de importação do TurboIntegrator podem ser executados simultaneamente se não compartilharem nenhumobjeto, por exemplo, se importarem em dois cubos diferentes.

A função SaveDataAll do Turbo Integrator conta com o arquivo de log detransação tm1s.log e envolve todos os objetos dentro de um modelo de dados.Portanto, dois processos de importação do Turbo Integrator, usando a funçãoSaveDataAll, não podem ser executados em paralelo: um será executado e o outro

298 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 313: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

(junto com seu processo do Turbo Integrator) será forçado a retroceder. O mesmoserá verdade se os processos do Turbo Integrator fizerem parte das tarefas deorganização de processos: apenas uma tarefa de organização de processoscontinuará executando a função SaveDataAll do Turbo Integrator; a outra seráforçada a retroceder.

Um retrocesso é indesejável do ponto de vista do desempenho, já que aumenta otempo de execução total de um processo do Turbo Integrator ou tarefa deorganização de processos. Operações SaveDataAll simultâneas concorrentes semprelevarão a uma contenção de bloqueio e a um retrocesso.

Há duas soluções possíveis para evitar operações SaveDataAll simultâneasconcorrentes:v Não usar a função SaveDataAll do Turbo Integrator. Em vez disso, ative a

Criação de Log de Cubo para os cubos de importação.v Se a ativação da Criação de Log de Cubo para os cubos de importação não

puder se feita por motivos de desempenho, dentro do aplicativo TM1 , devehaver apenas um processo chamando a função SaveDataAll do Turbo Integrator.Use uma tarefa de organização de processos distinta única independente paraexecutar a operação SaveDataAll.

SintaxeSaveDataAll;

Argumentos

Nenhum.

ServerShutdownEsta função encerra um servidor em execução como um aplicativo.ServerShutdown não pode ser usado para encerrar um servidor que estáexecutando como um serviço do Windows.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeServerShutDown(SaveData);

Argumento Descrição

SaveData Um valor Booleano que indica se o servidordeve salvar mudanças no disco antes de serencerrado.

Se SaveData = 0, o servidor será encerradosem salvar mudanças.

Se SaveData = 1, o servidor salvarámudanças da memória no disco antes de serencerrado.

Capítulo 6. Funções do Turbo Integrator TM1 299

Page 314: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

ExemploServerShutdown(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.

SubsetAliasSetEsta função define o atributo de alias a ser usado em um subconjunto.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SubsetAliasSet retornará 1 se bem-sucedida, caso contrário, retornará 0.

SintaxeSubsetAliasSet( DimName, SubName, AliasName );

Argumento Descrição

DimName A dimensão-pai do subconjunto para o qualvocê deseja definir o alias.

SubName O subconjunto para o qual você desejadefinir o alias.

Aliasname O alias que você deseja usar no subconjunto.

SubsetCreateEsta função cria um subconjunto público vazio de uma dimensão especificada.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeSubsetCreate(DimName, SubName);

Argumento Descrição

DimName A dimensão-pai do subconjunto que estásendo criado.

SubName O nome que você deseja designar aosubconjunto.

ExemploSubsetCreate(’Region’, ’Northern Europe’);

300 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 315: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Este exemplo cria o subconjunto vazio Norte Europeu da dimensão Região. Épossível usar SubsetElementInsert para incluir elementos no subconjunto.

SubsetCreateByMDXEsta função cria um subconjunto público com base em uma expressão MDXtransmitida.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeSubsetCreatebyMDX(SubName, MDX_Expression);

Argumento Descrição

SubName O nome que você deseja designar aosubconjunto.

MDX_Expression Uma expressão MDX que retorna umsubconjunto.

ExemploSubsetCreatebyMDX(’0-level months’, ’{TM1SORT( {TM1FILTERBYLEVEL( {TM1SUBSETALL([month] )}, 0)}, ASC)} ’ );

Este exemplo cria um subconjunto público chamado 'meses de nível 0' com baseem uma expressão MDX que retorna um subconjunto que consiste em todos oselementos de nível 0 na dimensão Mês, classificados em ordem alfabética crescente.

SubsetDeleteAllElementsEsta função exclui todos os elementos de um subconjunto público.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeSubsetDeleteAllElements(DimName, SubsetName);

Argumento Descrição

DimName A dimensão-pai do subconjunto do qualvocê deseja excluir elementos.

SubsetName O subconjunto do qual você deseja excluirelementos. Este deve ser um subconjuntopúblico. O Turbo Integrator não podeacessar objetos particulares.

ExemploSubsetDeleteAllElements(’Region’, ’Central Europe’);

Este exemplo exclui todos os elementos de subconjunto Europa Central dadimensão Região.

Capítulo 6. Funções do Turbo Integrator TM1 301

Page 316: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SubsetDestroyEsta função exclui um subconjunto do banco de dados do TM1 .

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeSubsetDestroy(DimName, SubName);

Argumento Descrição

Dimname A dimensão-pai do subconjunto que estásendo excluído.

SubName O nome do subconjunto que você desejaexcluir.

ExemploSubsetDestroy(’Region’, ’Northern Europe’);

Este exemplo exclui o subconjunto Norte Europeu da dimensão Região.

SubsetElementDeleteEsta função exclui um elemento em um subconjunto.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeSubsetElementDelete(DimName, SubName, Index);

Argumento Descrição

DimName A dimensão-pai do subconjunto do qualvocê deseja excluir um elemento.

SubName O subconjunto do qual você deseja excluirum elemento.

Índice O número de índice do elemento que vocêdeseja excluir do subconjunto.

ExemploSubsetElementDelete(’Region’, ’Northern Europe’, 3);

Este exemplo exclui o terceiro elemento do subconjunto Norte Europeu dadimensão Região.

SubsetElementInsertEsta função inclui um elemento em um subconjunto existente.

302 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 317: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeSubsetElementInsert(DimName, SubName, ElName, Position);

Argumento Descrição

DimName A dimensão-pai do subconjunto no qualvocê deseja incluir um elemento.

SubName O nome do subconjunto no qual está sendoincluído um elemento.

ElName O nome do elemento que você deseja incluirno subconjunto. O elemento deve existir nobanco de dados do TM1 .

Posição Um valor que indica a posição de índice doelemento no subconjunto.

ExemploSubsetElementInsert(’Region’, ’Northern Europe’, ’Finland’,3);

Este exemplo inclui o elemento Finlândia no subconjunto Norte Europeu dadimensão Região. Finlândia é o terceiro elemento na definição de subconjunto.

SubsetExistsUse SubsetExists para determinar se existe um subconjunto público específico noservidor a partir do qual um processo do Turbo Integrator é executado.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

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.

SintaxeSubsetExists(DimName, SubsetName);

Argumento Descrição

DimName O nome da dimensão que é o pai dosubconjunto cuja existência você desejaconfirmar.

SubsetName O nome do subconjunto público cujaexistência você deseja confirmar

ExemploSubsetExists(’Region’, ’Northern Europe’);

Capítulo 6. Funções do Turbo Integrator TM1 303

Page 318: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Este exemplo determina se o subconjunto Norte da Europa do cubo Região existeno servidor.

SubsetExpandAboveSetEsta função define a propriedade Expandir Acima para um subconjunto.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Quando esta propriedade for definida como TRUE, os filhos de uma consolidaçãoserão exibidos acima da consolidação quando a consolidação for exibida uma linha,e à esquerda da consolidação quando a consolidação for exibida em uma coluna.

A função retornará 1 se bem-sucedida, caso contrário, retornará 0.

SintaxeSubsetExpandAboveSet( DimName, SubsetName, ExpandAboveFlag);

Argumento Descrição

DimName A dimensão-pai do subconjunto para o qualvocê deseja definir a propriedade ExpandirAcima.

SubsetName O subconjunto para o qual você desejadefinir a propriedade Expandir Acima.

ExpandAboveFlag Defina ExpandAboveFlag como 1 paradefinir a propriedade Expandir Acima comoTRUE. Quando esta propriedade for TRUE,as consolidações serão expandidas acima naslinhas e à esquerda nas colunas.

Defina ExpandAboveFlag como 0 paradefinir a propriedade Expandir Acima comoFALSE. Quando esta propriedade for FALSE,as consolidações serão expandidas abaixonas linhas e à direita nas colunas.

ExemploSubsetExpandAboveSet(’Region’, ’Europe’, 1 );

Este exemplo define a propriedade Expandir Acima como TRUE para osubconjunto Europa da dimensão Região.

SubsetFormatStyleSetEsta função aplica um estilo de exibição existente a um subconjunto nomeado.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

304 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 319: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Os estilos de exibição são definidos para elementos específicos. Se você aplicar umestilo de exibição existente a um subconjunto que inclui elementos que não estãoincluídos no estilo de exibição, nenhuma formatação será aplicada a esseselementos.

SintaxeSubsetFormatStyleSet( 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 quevocê deseja aplicar ao subconjunto.

ExemploSubsetFormatStyleSet (’Region’, ’Northern Europe’, ’BoldCurrencyLeftJustified’);

Este exemplo aplica o estilo de exibição BoldCurrencyLeftJustified ao subconjuntoNorte Europeu da dimensão Região.

SubsetGetElementNameEsta função retorna o nome do elemento em um local de índice especificado emum determinado subconjunto.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeSubsetGetElementName(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 recuperarum nome de elemento.

ElementIndex Um número que representa a posição nosubconjunto do elemento que você desejarecuperar.

ExemploSubsetGetElementName(’Region’, ’Americas’, 4);

Capítulo 6. Funções do Turbo Integrator TM1 305

Page 320: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Este exemplo retorna o nome do quarto elemento no subconjunto Américas dadimensão Região.

SubsetGetSizeEsta função retorna o número de elementos em um subconjunto.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeSubsetGetSize(DimName, SubsetName);

Argumento Descrição

DimName A dimensão-pai do subconjunto para o qualvocê deseja determinar o tamanho.

SubsetName O subconjunto para o qual você desejadeterminar o tamanho.

ExemploSubsetGetSize(’Region’, ’EurAsia’);

Esta função retorna o número de elementos no subconjunto Eurásia da dimensãoRegião.

SubsetIsAllSetEsta função define um subconjunto para usar todos os elementos da dimensão-pai.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Ela é equivalente a um clique em no Editor de Subconjunto. SubsetIsAllSetretornará 1 se bem-sucedida, caso contrário, retornará 0.

SintaxeSubsetIsAllSet( DimName, SubName, Flag );

Argumento Descrição

DimName A dimensão-pai do subconjunto para o qualvocê deseja usar todos os elementos.

SubName O subconjunto para o qual você deseja usartodos os elementos de dimensão.

306 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 321: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

Sinalizador Um valor diferente de zero especifica que osubconjunto usa todos os elementos atuaisda dimensão-pai e será atualizadodinamicamente para usar todos os elementosda dimensão-pai sempre que o subconjuntofor chamado.

Especificar um valor zero congelará oselementos no subconjunto como o conjuntoatual de todos os elementos nadimensão-pai. O subconjunto não seráatualizado dinamicamente para usar todosos elementos de dimensão no futuro.

Funções de Manipulação de Visualização do Turbo IntegratorEstas funções referem-se à manipulação de visualização.

PublishViewEsta função publica uma visualização particular nomeada no servidor.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxePublishView(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 serpublicada.

Capítulo 6. Funções do Turbo Integrator TM1 307

Page 322: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

PublishPrivateSubsets Este argumento Booleano (1 ou 0) determinase algum subconjunto particular presente navisualização também deve ser publicado.

Se PublishPrivateSubsets for true (1), todosos subconjuntos particulares usados navisualização serão publicados juntamentecom a visualização.

Se este argumento for false (0), ossubconjuntos particulares não serãopublicados. Uma visualização pública nãopode conter subconjuntos particulares,portanto, a visualização não será publicada eserá gravado um erro no arquivo de log doTurbo Integrator.Nota: Se um subconjunto particular contiveroutro subconjunto particular como umaconsolidação definida pelo usuário, osubconjunto nunca poderá ser publicadousando a função PublishView,independentemente do valor do argumentoPublishPrivateSubsets.

OverwriteExistingView Este argumento Booleano (1 ou 0) determinase alguma visualização pública existentecom nome idêntico deve ser sobrescritaquando a visualização particular forpublicada.

Se OverwriteExistingView for true (1),qualquer visualização pública existente comnome idêntico será sobrescrita quando avisualização particular for publicada.

Se este argumento for false (0), avisualização pública não será sobrescrita, avisualização particular não será publicada eserá gravado um erro no arquivo de log doTurbo Integrator.

ViewColumnDimensionSetEsta função define uma dimensão da coluna para uma visualização do TM1 .

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeViewColumnDimensionSet(CubeName, ViewName, DimName, StackPosition);

Argumento Descrição

CubeName O cubo-pai da visualização para a qual estásendo definida a dimensão da coluna.

308 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 323: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

ViewName A visualização para a qual está sendodefinida a dimensão da coluna.

DimName A dimensão que você deseja definir comouma dimensão da coluna para avisualização.

StackPosition Um número que indica a posição da pilhada dimensão na visualização. Este é umnúmero baseado em 1. 1 indica a posição dapilha mais elevada. 2 indica uma posiçãoabaixo de 1, e assim por diante.

ExemploViewColumnDimensionSet(’98sales’, ’Quarter1’, ’Month’,1);

Este exemplo define Mês como uma dimensão da coluna para a visualização1Trimestre do cubo 98sales. No caso de dimensões da coluna empilhadas, Mês écolocado na posição mais elevada.

ViewColumnSuppressZeroesSetEsta função suprime ou ativa a exibição de colunas contendo apenas valores zeroem uma visualização do cubo do TM1 .

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeViewColumnSuppressZeroesSet(Cube, ViewName, Flag);

Argumento Descrição

Cubo O cubo-pai da visualização para a qual vocêdeseja suprimir ou ativar a exibição devalores zero.

ViewName A visualização para a qual você deseja ativarou suprimir a exibição de zeros.

Sinalizador Um valor binário que ativa ou suprimezeros. Especifique 1 para suprimir a exibiçãode colunas contendo apenas zeros navisualização. Especifique 0 para ativar aexibição de colunas contendo apenas zeros.

ExemploViewColumnSuppressZeroesSet(’99sales’, ’1st QuarterActuals’, 1);

Este exemplo suprime a exibição de colunas contendo apenas zeros na visualizaçãoValores Reais do 1º Trimestre do cubo 99sales.

Capítulo 6. Funções do Turbo Integrator TM1 309

Page 324: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

ViewConstructEsta função constrói, calcula previamente e armazena uma visualização Stargate namemória em um servidor.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Esta função é útil para pré-calcular e armazenar visualizações grandes, para queelas possam ser rapidamente acessadas após um carregamento ou atualização dedados.

SintaxeViewConstruct(CubeName, ViewName);

Argumento Descrição

CubeName O cubo a partir do qual você desejaconstruir a visualização.

ViewName A visualização que você deseja construir.Esta visualização deve ser uma visualizaçãopública existente no servidor.

ExemploViewconstruct(’99sales’, ’1st Quarter Actuals’)

Este exemplo exclui o terceiro elemento do subconjunto Norte Europeu dadimensão Região.

ViewCreateEsta função cria uma visualização vazia de um cubo especificado.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Nota: Se desejar executar uma operação de replicação ou de sincronização depoisde usar a função ViewCreate em um processo do TI, chame a função SaveDataAll apartir do procedimento do Epílogo do processo para garantir que a visualizaçãorecém criada esteja disponível para a replicação. Estas etapas são aplicáveis apenasquando você usa a função ViewCreate antes de uma operação de replicação ou desincronização.

SintaxeViewCreate(Cube, ViewName);

Argumento Descrição

Cubo O cubo-pai da visualização que está sendocriada.

ViewName O nome que você deseja designar àvisualização.

310 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 325: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

ExemploViewCreate(’99sales’, ’1st Quarter Actuals’);

ViewDestroyEsta função exclui uma visualização do banco de dados do TM1 .

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeViewDestroy(Cube, ViewName);

Argumento Descrição

Cubo O cubo-pai da visualização que está sendoexcluída.

ViewName O nome da visualização que você desejaexcluir.

ExemploViewDestroy(’99sales’, ’1st Quarter Actuals’);

Este exemplo exclui a visualização Valores Reais do 1º Trimestre do cubo 99sales.

ViewExistsUse ViewExists para determinar se existe uma visualização pública específica noservidor a partir do qual um processo do Turbo Integrator é executado.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

A função retornará 1 se a visualização existir no servidor, caso contrário, retornará0. Observe que essa função não pode ser usada para determinar a existência devisualizações particulares.

SintaxeViewExists(CubeName, ViewName);

Argumento Descrição

CubeName O nome do cubo que é o pai da visualizaçãocuja existência você deseja confirmar.

ViewName O nome da visualização pública cujaexistência você deseja confirmar

ExemploViewExists(’Inventory’, ’FebClosing’);

Capítulo 6. Funções do Turbo Integrator TM1 311

Page 326: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Este exemplo determina se a visualização FebClosing do cubo Inventário existe noservidor.

ViewExtractSkipCalcsSetEsta função configura uma opção para incluir/excluir valores consolidados emuma visualização e quaisquer extrações de visualização associada.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Uma extração de visualização é uma visualização do TM1 exportada como umarquivo ASCII delimitado por vírgula (.cma).

Nota: Esta função afeta as visualizações como elas existem no servidor. O escopodessa função não é restrito às extrações geradas a partir de uma visualização.

ViewExtractSkipCalcsSet é o equivalente da opção Ignorar Valores Consolidados nacaixa de diálogo Extração de Visualização.

SintaxeViewExtractSkipCalcsSet (Cube, ViewName, Flag);

Argumento Descrição

Cubo O cubo-pai da visualização para a qual estásendo definida a opção.

ViewName A visualização para a qual está sendodefinida a opção.

Sinalizador Um valor binário que ativa ou desativa aopção. Especifique 1 para excluir valoresconsolidados da extração de visualização.Especifique 0 para incluir valoresconsolidados.

ExemploViewExtractSkipCalcsSet (’99sales’, ’1st Quarter Actuals’,1);

Este exemplo ativa a opção Ignorar Valores Consolidados para a visualizaçãoValores Reais do 1º Trimestre. A extração de visualização não incluirá nenhumvalor consolidado.

ViewExtractSkipRuleValuesSetEsta função configura uma opção para incluir/excluir valores calculados por regraem uma visualização e quaisquer extrações de visualização associada.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Uma extração de visualização é uma visualização do TM1 exportada como umarquivo ASCII delimitado por vírgula (.cma).

312 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 327: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Nota: Esta função afeta as visualizações como elas existem no servidor. O escopodessa função não é restrito às extrações geradas a partir de uma visualização.

ViewExtractSkipRuleValuesSet é o equivalente da opção Ignorar Valores Calculadospor Regras na caixa de diálogo Extração de Visualização.

SintaxeViewExtractSkipRuleValuesSet (Cube, ViewName, Flag);

Argumento Descrição

Cubo O cubo-pai da visualização para a qual estásendo definida a opção.

ViewName A visualização para a qual está sendodefinida a opção.

Sinalizador Um valor binário que ativa ou desativa aopção. Especifique 1 para excluir valorescalculados por regras da extração.Especifique 0 para incluir valores calculadospor regras.

ExemploViewExtractSkipRuleValuesSet (’99sales’, ’1st QuarterActuals’, 1);

Este exemplo ativa a opção Ignorar Valores Calculados por Regras para a extraçãocriada a partir da visualização Valores Reais do 1º Trimestre. A extração nãoincluirá nenhum valor calculado por regra.

ViewExtractSkipZeroesSetEsta função configura uma opção para incluir/excluir valores zero em umavisualização e quaisquer extrações de visualização associada.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Uma extração de visualização é uma visualização do TM1 exportada como umarquivo ASCII delimitado por vírgula (.cma).

Nota: Esta função afeta as visualizações como elas existem no servidor. O escopodessa função não é restrito às extrações geradas a partir de uma visualização.

ViewExtractSkipZeroesSet é o equivalente da opção Ignorar Valores Zero/EmBranco na caixa de diálogo Extração de Visualização.

SintaxeViewExtractSkipZeroesSet (Cube, ViewName, Flag);

Argumento Descrição

Cubo O cubo-pai da visualização para a qual estásendo definida a opção Ignorar Zeros.

Capítulo 6. Funções do Turbo Integrator TM1 313

Page 328: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

ViewName A visualização para a qual está sendodefinida a opção Ignorar Zeros.

Sinalizador Um valor binário que ativa ou desativa aopção. Especifique 1 para excluir zeros daextração. Especifique 0 para incluir zeros.

ExemploViewExtractSkipZeroesSet (’99sales’, ’1st Quarter Actuals’,1);

Este exemplo ativa a opção Ignorar Zeros para a extração criada a partir davisualização Valores Reais do 1º Trimestre. A extração não incluirá nenhum valorzero ou em branco.

ViewRowDimensionSetEsta função define uma dimensão da linha para uma visualização do TM1 .

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeViewRowDimensionSet(CubeName, ViewName, DimName, StackPosition);

Argumento Descrição

CubeName O cubo-pai da visualização para a qual estásendo definida a dimensão da linha.

ViewName A visualização para a qual está sendodefinida a dimensão da linha.

DimName A dimensão que você deseja definir comouma dimensão da linha para a visualização.

StackPosition Um número que indica a posição da pilhada dimensão na visualização. Este é umnúmero baseado em 1. 1 indica a posição dapilha da extremidade esquerda. 2 indica aposição à direita de 1, e assim por diante.Nota: É possível que um cliente do TM1configure um parâmetro Tm1p.ini(BrowseDisplayReadsRightToLeft=T) quereverta a orientação de dados no CubeViewer. Quando a orientação de dados forrevertida, as posições de pilhas tambémserão revertidas. 1 indica a posição da pilhada extremidade direita. 2 indica a posição àesquerda de 1, e assim por diante.

ExemploViewRowDimensionSet(’98sales’, ’Quarter1’, ’Month’,1)

314 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 329: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Este exemplo define Mês como uma dimensão da linha para a visualização1Trimestre do cubo 98sales. No caso de dimensões da linha empilhadas, Mês écolocado na posição da extremidade esquerda.

ViewRowSuppressZeroesSetEsta função suprime ou ativa a exibição de linhas contendo apenas valores zero emuma visualização do cubo do TM1 .

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeViewRowSuppressZeroesSet(Cube, ViewName, Flag);

Argumento Descrição

Cubo O cubo-pai da visualização para a qual vocêdeseja suprimir ou ativar a exibição devalores zero.

ViewName A visualização para a qual você deseja ativarou suprimir a exibição de zeros.

Sinalizador Um valor binário que ativa ou suprimezeros. Especifique 1 para suprimir a exibiçãode linhas contendo apenas zeros navisualização. Especifique 0 para ativar aexibição de linhas contendo apenas zeros.

ExemploViewRowSuppressZeroesSet(’99sales’, ’1st Quarter Actuals’,1);

Este exemplo suprime a exibição de linhas contendo apenas zeros na visualizaçãoValores Reais do 1º Trimestre do cubo 99sales.

ViewSubsetAssignEsta função designa um subconjunto nomeado a uma visualização do cubo.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeViewSubsetAssign(Cube, ViewName, DimName, SubName);

Argumento Descrição

Cubo O cubo-pai da visualização para a qual estásendo designado um subconjunto.

ViewName A visualização para a qual está sendodesignado um subconjunto.

Capítulo 6. Funções do Turbo Integrator TM1 315

Page 330: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

DimName A dimensão-pai do subconjunto que estásendo designado à visualização.

SubName O nome do subconjunto que você desejadesignar à visualização.

ExemploViewSubsetAssign(’99sales’, ’1st Quarter Actuals’, ’Month’,’Q1’);

Este exemplo designa o subconjunto Q1 da dimensão Mês à visualização 1ºTrimestre.

ViewSuppressZeroesSetEsta função suprime ou ativa a exibição de todas as linhas e colunas contendoapenas valores zero em uma visualização do cubo do TM1 .

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeViewSuppressZeroesSet(Cube, ViewName, Flag);

Argumento Descrição

Cubo O cubo-pai da visualização para a qual vocêdeseja suprimir ou ativar a exibição devalores zero.

ViewName A visualização para a qual você deseja ativarou suprimir a exibição de zeros.

Sinalizador Um valor binário que ativa ou suprimezeros. Especifique 1 para suprimir a exibiçãode linhas ou colunas contendo apenas zerosna visualização. Especifique 0 para ativar aexibição de linhas e colunas contendoapenas zeros.

ExemploViewSuppressZeroesSet(’99sales’, ’1st Quarter Actuals’,1);

Este exemplo suprime a exibição de linhas ou colunas contendo apenas zeros navisualização Valores Reais do 1º Trimestre do cubo 99sales.

ViewTitleDimensionSetEsta função define uma dimensão de título para uma visualização do TM1 .

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

316 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 331: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeViewTitleDimensionSet(CubeName, ViewName, DimName);

Argumento Descrição

CubeName O cubo-pai da visualização para a qual estásendo definida a dimensão de título.

ViewName A visualização para a qual está sendodefinida a dimensão de título.

DimName A dimensão que você deseja definir comouma dimensão de título para a visualização.

ExemploViewTitleDimensionSet(’98sales’, ’Quarter1’, ’Month’);

Este exemplo define Mês como uma dimensão de título para a visualização1Trimestre do cubo 98sales.

ViewTitleElementSetEsta função define um elemento do título para uma visualização do TM1 .

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

ViewTitleElementSet é usada juntamente com a função ViewTitleDimensionSet.

SintaxeViewTitleElementSet(CubeName, ViewName, DimName, Index);

Argumento Descrição

CubeName O cubo-pai da visualização para a qual estásendo definido o elemento do título.

ViewName A visualização para a qual está sendodefinido o elemento do título.

DimName A dimensão-pai do elemento do título.

Índice Um índice para a dimensão especificada queindica o elemento a ser definido como oelemento do título.

ExemploViewTitleElementSet(’98sales’, ’Quarter1’, ’Model’,3);

Este exemplo define o terceiro elemento da dimensão do Modelo como umelemento do título para a visualização Trimestre1 do cubo 98sales.

Capítulo 6. Funções do Turbo Integrator TM1 317

Page 332: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

ViewZeroOutEsta função define todos os pontos de dados em uma visualização como zero.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeViewZeroOut(Cube, ViewName);

Argumento Descrição

Cubo O cubo-pai da visualização que você desejazerar.

ViewName A visualização que você deseja zerar.

ExemploViewZeroOut(’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.

AddInfoCubeRestrictionEsta função do Turbo Integrator filtra dados de InfoCube conforme eles sãoextraídos para o TM1 .

Use esta função para restringir os valores que são importados para umacaracterística especificada. Esta função deve ser colocada no Prólogo. A funçãopode ser chamada várias vezes para filtrar mais de uma característica em um únicoprocesso.

SintaxeAddInfoCubeRestriction(STRING CharactName, STRING sign,STRING compOperator,STRING lowValue, STRING highValue)

Argumento Descrição

STRING CharactName Contém o nome técnico da característica aser restringida. O tipo de dado precisa seruma sequência de caracteres com umcomprimento igual ou menor que 30.

STRING sign Contém I (= inclusive) ou E (= exclusivo).Exclusivo é o NÃO lógico para a restriçãoespecificada por esta linha. O tipo de dadoprecisa ser um caractere de comprimento 1.

318 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 333: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

STRING compOperator Contém o operador comparativo relacional.O tipo de dado precisa ser uma sequênciade caracteres de comprimento 2. Osoperadores comparativos sã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 operadorespecificado na linha anterior. O tipo dedado precisa ser uma sequência decaracteres com um comprimento igual oumenor que 60.

STRING highValue Contém o valor alto para o operadorespecificado duas linhas antes. O tipo dedado precisa ser uma sequência decaracteres com um comprimento igual oumenor que 60. Ele é necessário apenas paraos operadores BT e NB, caso contrário, éignorado, e neste caso, uma sequência vaziadeve ser colocada aqui.

ExemploAddInfoCubeRestriction(’0CALYEAR’,’E’,’BT’,’1997’,’2000’);

retorna todos os valores característicos entre 1997 e 2000.AddInfoCubeRestriction(’0CALYEAR’,’I’,’NB’,’1997’, ’2000’) ;

retorna todos os valores característicos que não estão entre 1997 e 2000.AddInfoCubeRestriction(’0DOC_CURRCY’, ’I’, ’NE’, ’USD’,’’) ;

retorna todos os valores característicos que não são iguais a USD.

DataSourceSAPUsingRoleAuthsEsta função do Turbo Integrator instrui o processo do Turbo Integrator a ignorarinformações de segurança ao processar uma origem de dados do SAP. Esta variáveldeve ser colocada no Prólogo.

Capítulo 6. Funções do Turbo Integrator TM1 319

Page 334: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeDataSourceSAPUsingRoleAuths=’0’

Argumento Descrição

0 As informações de segurança são ignoradasdurante o processamento de uma origem dedados do SAP.

1 As informações de segurança são lidasdurante o processamento de uma origem dedados do SAP.

DataSourceSAPUsingTextsEsta variável local do Turbo Integrator instrui o processo do Turbo Integrator aignorar descrições de características ao processar uma origem de dados do SAP,resultando na redução do consumo de memória e no aumento do desempenho.Esta variável deve ser colocada no Prólogo.

SintaxeDataSourceSAPUsingTexts=’0’

Argumento Descrição

0 As descrições de características são ignoradasdurante o processamento de uma origem dedados do SAP. O nome técnico característicoé importado para o TM1 como um nome ealias do elemento.

1 As descrições de características são lidasdurante o processamento de uma origem dedados do SAP.

ExpandirEsta função "expande" nomes de variáveis do Turbo Integrator, colocados entresinais %, para seus valores no tempo de execução.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Se o nome de variável representar uma variável de sequência, toda a expressão davariável deverá ser colocada entre aspas. Por exemplo, "%V1%".

Um uso comum da função Expand é transmitir o valor de variáveis do TurboIntegrator para a função ODBCOutput. Consulte o exemplo abaixo para obterdetalhes.

Se Expandir for alimentado com um valor numérico, uma conversão de tipoimplícita será executada e o valor numérico convertido em uma sequência.

Essa sequência tem um comprimento mínimo fixo de 10 caracteres. Se o númeroconvertido for muito pequeno para preencher 10 caracteres, ele será preenchido

320 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 335: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

com espaços extras. Apenas três caracteres decimais extras são convertidos. Porexemplo, um valor numérico de 0.123456789 é convertido na sequência "0.123".

SintaxeExpand(String);

Argumento Descrição

Sequência Qualquer sequência que inclui nomes devariáveis do Turbo Integrator colocadosentre sinais %.

ExemploODBCOutPut( ’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 exemploinsere registros em uma tabela relacional chamada Vendas, que consiste em trêscolunas: Mês, Produto e Vendas.

A função Expand converte as variáveis V0, V1 e V2 em seus valores reais navisualização. Supondo que o primeiro valor na visualização seja 123.456 e sejadefinido pelos elementos Jan e WidgetExpand( ’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.

FileExistsEsta função determina se existe um arquivo especificado. A função retornará 1 se oarquivo existir, 0 se ele não existir.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeFileExists(File);

Argumento Descrição

Arquivo O nome de um arquivo. Se não forespecificado um caminho completo, o TM1procurará o arquivo no diretório de dadosdo servidor.

ExemploFileExists(’C:\tm1s7\pdata\model.dim’);

Este exemplo determina se existe o arquivo model.dim.

Capítulo 6. Funções do Turbo Integrator TM1 321

Page 336: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

NumberToStringEsta função converte um número em uma sequência, usando o separador decimalpara o código do idioma do usuário atual.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

No Microsoft Windows, o separador decimal é uma configuração de OpçõesRegionais.

A saída desta função é semelhante ao formato numérico 'geral'; ela não usaseparadores de milhares e usa o sinal de menos (-) para indicar números negativos.

SintaxeNumberToString(Value);

Argumento Descrição

Valor O valor real que você deseja converter emuma sequência.

ExemplonRET = NumberToString(1234.5);

NumberToStringExEsta função converte um número em uma sequência, usando o formato desequência, o separador decimal e o separador de milhares transmitidos.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

SintaxeNumberToStringEx(Value, NumericFormat, DecimalSep, ThousandsSep);

Argumento Descrição

Valor O valor real que você deseja converter emuma sequência.

FormatString Uma sequência de formato numérico doTM1 que define o formato para a saída dafunção. Formatos numéricos estão descritosno Guia do Usuário do IBM Cognos TM1 .

DecimalSep O separador decimal a ser usado nasequência de saída.

ThousandsSep O separador de milhares a ser usado nasequência de saída.

322 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 337: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

ExemplosRet=NUMBERTOSTRINGEX(7895.23,’#,0.#########’, ’,’,’.’);

ASCIIOUTPUT(’number_to_string.txt’,sRet);

Will return in ascii file;

7.895,23

RefreshMdxHierarchyEsta função atualiza as hierarquias MDX em um servidor sem solicitar que reinicieo servidor.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Sintaxe

Use esta função depois de configurar ou editar os níveis de hierarquia nomeadoscustomizados para uma dimensão no cubo de controle }HierarchyProperties.

Para obter detalhes sobre como usar níveis denominados com dimensões, consultea seção relacionada no Guia para Desenvolvedores do IBM Cognos TM1 .RefreshMdxHierarchy(dimensionName)

Argumento Descrição

dimensionName Parâmetro de sequência opcional paraespecificar uma dimensão específica paraatualização.

Deixe este parâmetro em branco paraatualizar todas as dimensões.

Exemplo

Atualize todas as dimensões:RefreshMdxHierarchy(’’);

Para atualizar apenas a dimensão de clientes:RefreshMdxHierarchy(’customers’);

StringToNumberEsta função converte uma sequência em um número, usando o separador decimalpara o código do idioma do usuário atual.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

No Microsoft Windows, o separador decimal é uma configuração de OpçõesRegionais.

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.

Capítulo 6. Funções do Turbo Integrator TM1 323

Page 338: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeStringToNumber(String);

Argumento Descrição

Sequência A sequência que você deseja converter emum número.

ExemplonRET = StringToNumber(’123.45’);

StringToNumberExEsta função converte uma sequência em um número, usando o separador decimale o separador de milhares transmitidos.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

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.

SintaxeStringToNumberEx(String, DecimalSep, ThousandsSep);

Argumento Descrição

Sequência A sequência que você deseja converter emum número.

DecimalSep O separador decimal a ser usado no númerode saída.

ThousandsSep O separador de milhares a ser usado nonúmero de saída.

ExemplonRET = StringToNumberEx(’12453.45’, ’ . ’, ’ , ’);

Arquivo TM1ProcessError.logQuando um processo do Turbo Integrator encontrar um erro, ele gerará umarquivo TM1ProcessError.log. Este arquivo de log é salvo no diretório de dados doservidor no qual o processo reside.

Um arquivo TM1ProcessError.log contém uma lista de erros encontrados peloprocesso. Para cada erro encontrado, o arquivo de log registra a guia e a linha quecausaram o erro, juntamente com uma breve descrição do erro.

Quando um arquivo de log de erros do processo for gerado, o TM1 designará umnome exclusivo que permite identificar prontamente qual processo do TurboIntegrator gerou o arquivo de erro e a hora de criação do arquivo. Os nomes dearquivos são designados usando a convenção

324 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 339: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

TM1ProcessError_<registro de data e hora>_<nome do processo>.log. Nesta convenção,<time stamp> é a hora (expressa como aaaammddhhmmss GMT) em que o arquivofoi gerado e <process name> é o nome do processo do Turbo Integrator que causouos erros.

Por exemplo, um arquivo de erro chamado TM1ProcessError_20040224203148_CreateSalesCube.log indica que o arquivo de erro foi gerado às 20:31:48 GMT nodia 24 de fevereiro de 2004 e que ele contém erros causados pelo processoCreateSalesCube.

TM1User()Esta função retorna uma sequência que fornece o cliente TM1 atual.

Quando executada em um processo que o usuário está executando diretamente, elaretornará o nome do cliente TM1 do usuário. Quando executada em uma tarefa deorganização de processos que o usuário executa diretamente, ela também retornaráo nome do cliente TM1 do usuário.

Se executada a partir de uma tarefa de organização de processos planejada, elaretornará um nome no formato R*<chore name>, por exemplo,R*UpdateRegionDimension.

SintaxeTM1User()

WildcardFileSearchEsta função permite usar caracteres curinga para procurar arquivos em umdiretório especificado.

Esta é uma função do TM1 Turbo Integrator, válida apenas em processos do TurboIntegrator.

Os resultados da função WildCardFileSearch podem variar, dependendo do sistemaoperacional em uso. Arquivos em um diretório do Windows são armazenados emordem alfabética enquanto os arquivos em um diretório UNIX são armazenadosem uma ordem aleatória. Como a ordem de classificação defere entre os sistemasoperacionais, a função idêntica WildCardFileSearch executou em diretóriosidênticos, um em Windows e um em UNIX, os resultados serão diferentes.

SintaxeWildcardFileSearch( Pathname, PriorFilename);

Argumento Descrição

Pathname Um nome do caminho para arquivos quevocê deseja procurar. O nome do caminhodeve terminar com um nome do arquivo,que pode conter uma sequência de curingasusando os caracteres * e/ou? .

O caractere curinga ? corresponde aqualquer caractere único.

O caractere curinga * corresponde a zero oumais caracteres.

Capítulo 6. Funções do Turbo Integrator TM1 325

Page 340: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Argumento Descrição

PriorFilename O nome de um arquivo existente nodiretório especificado. Este nome do arquivonão pode conter caracteres curinga. Aprocura de caracteres curinga especificadapelo argumento Pathname começaráDEPOIS deste arquivo.

Se for transmitida uma sequência vaziacomo o argumento PriorFilename, a funçãoWildcardFileSearch retornará o primeiroarquivo que corresponde à sequência decuringas especificada pelo argumentoPathname.

Exemplo

O seguinte exemplo mostra o uso da função WildcardFileSearch para determinar oprimeiro arquivo de log do 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' no diretório C:\Program Files\Cognos\TM1\Custom\TM1Data\SData\.

Como os arquivos de log do servidor são nomeados e salvos com registros de datae hora sequenciais, e como o segundo parâmetro para WildcardFileSearch estávazio, a função retorna o primeiro arquivo de log do servidor, iniciando com oscaracteres 'tm1s2004'. Este seria o primeiro arquivo de log do servidor gerado noano 2004.

O seguinte exemplo mostra o uso da função WildcardFileSearch para retornar oprimeiro arquivo de log do 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 que corresponde à sequência de curingas'tm1s*.log'.

tm1s20040220175522.log é o primeiro arquivo que ocorre apóstm1s20040211153827.log e corresponde à sequência de curingas. De formaapropriada, o exemplo retorna tm1s20040220175522.log.

326 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 341: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Capítulo 7. Variáveis do Turbo Integrator TM1

As variáveis do IBM Cognos TM1 TurboIntegrator estão relacionadas aqui porcategorias.

Variáveis Locais do Turbo IntegratorAo executar um processo do Turbo Integrator, é gerado um conjunto de variáveislocais implícitas. As variáveis locais existem apenas no contexto do processo noqual elas são usadas, e não estão disponíveis fora do processo. As variáveis locaissão destruídas quando um processo é encerrado. Estas variáveis, listadas abaixo,podem ser sobrescritas para manipular um processo.

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 aoexecutar o processo.

SintaxeDatasourceNameForServer=’Name’;

Argumento Descrição

Nome Para uma origem de dados .cma, o caminhocompleto do arquivo .cma.

Para cubos, o nome do cubo precedido coma sequência 'local:'.

Para uma origem Open DatabaseConnectivity, o nome 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 aocriar ou editar o processo.

SintaxeDatasourceNameForClient=’Name’;

Argumento Descrição

Nome Para uma origem de dados .cma, o caminhocompleto do arquivo .cma.

Para cubos, o nome do cubo precedido coma sequência 'local:'.

Para uma origem Open DatabaseConnectivity, o nome de origem.

© Copyright IBM Corp. 2007, 2013 327

Page 342: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

DatasourceTypeEsta variável local do Turbo Integrator define o tipo da origem de dados.

SintaxeDataSourceType=’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.

SintaxeDatasourceUserName=’Name’;

Argumento Descrição

Nome O nome usado para conectar-se à origem dedados definida comDatasourceNameForServer.

DatasourcePasswordEsta variável local do Turbo Integrator define a senha usada para conectar-se àorigem de dados.

SintaxeDatasourcePassword=’Password’;

Argumento Descrição

Senha A senha usada para conectar-se à origem dedados definida comDatasourceNameForServer.

DatasourceQueryEsta variável local do Turbo Integrator define a sequência de consultas a ser usadacom a origem de dados.

328 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 343: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeDatasourceQuery=’Query’;

Argumento Descrição

Consulta A sequência de consultas a ser usada com aorigem de dados que foi definida comDatasourceNameForServer.

DatasourceCubeviewEsta variável local do Turbo Integrator define a visualização a ser processada, seDatasourceType for 'VIEW'.

SintaxeDatasourceCubeview=’ViewName’;

Argumento Descrição

ViewName O nome da visualização a ser processada.Esta deve ser uma visualização existente docubo especificado pela variávelDataSourceNameForServer.

DatasourceDimensionSubsetEsta variável local do Turbo Integrator define o subconjunto a ser processado, seDatasourceType for 'SUBSET.'

DatasourceNameForServer=Dimension name também é necessário, juntamente como DATASOURCEDIMENSIONSUBSET para que o TM1 possa identificar onde osubconjunto está localizado.

SintaxeDatasourceDimensionSubset=’SubsetName’;

Argumento Descrição

SubsetName O nome do subconjunto a ser processado.

DatasourceASCIIDelimiterEsta variável local do Turbo Integrator define o caractere ASCII a ser usado comoum delimitador de campo quando DatasourceType for 'CHARACTERDELIMITED".

SintaxeDatasourceASCIIDelimiter=’Character’;

Argumento Descrição

Caractere O caractere ASCII a ser usado como umdelimitador.

Capítulo 7. Variáveis do Turbo Integrator TM1 329

Page 344: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

DatasourceASCIIDecimalSeparatorEsta variável local do Turbo Integrator define o separador decimal a ser usado emqualquer conversão de uma sequência em um número ou de um número em umasequência. Se você definir esta variável, também deverá definir a variávelDatasourceASCIIThousandSeparator.

SintaxeDatasourceASCIIDecimalSeparator=’Character’;

Argumento Descrição

Caractere O caractere ASCII a ser usado como umseparador.

DatasourceASCIIThousandSeparatorEsta variável local do Turbo Integrator define o separador de milhares a ser usadoem qualquer conversão de uma sequência em um número ou de um número emuma sequência.

Se você definir esta variável, também deverá definir a variávelDatasourceASCIIDecimalSeparator.

SintaxeDatasourceASCIIThousandSeparator=’Character’;

Argumento Descrição

Caractere O caractere ASCII a ser usado como umseparador.

DatasourceASCIIQuoteCharacterEsta variável local do Turbo Integrator define o caractere ASCII usado paradelimitar os campos do arquivo de origem quando DatasourceType for'CHARACTERDELIMITED'.

SintaxeDatasourceASCIIQuoteCharacter=’Character’;

Argumento Descrição

Caractere O caractere ASCII que delimita campos naorigem de dados.

DatasourceASCIIHeaderRecordsEsta variável local do TurboIntegrator indica o número de registros a seremignorados antes do processamento da origem de dados.

330 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 345: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeDatasourceASCIIHeaderRecords=N;

Argumento Descrição

N O número de registros a serem ignoradosantes do processamento da origem de dados.

Value_Is_StringQuando DatasourceType for 'VIEW', esta variável local do Turbo Integratordeterminará se a célula atual deve ser tratada como uma sequência ou um valornumérico.

SintaxeValue_Is_String=N;

Argumento Descrição

N Valor que indica se a célula atual é umasequência ou um valor numérico.

0 indica que a célula é um número; qualqueroutro item significa que a célula é tratadacomo uma sequência.

NValueQuando DatasourceType for 'VIEW', esta variável local do Turbo Integratordeterminará o valor da célula atual quando Value_Is_String for 0. (Ou seja, quandoa célula atual é numérica.)

SintaxeNvalue=N;

Argumento Descrição

N O valor da célula atual.

SValueQuando DatasourceType for 'VIEW', esta variável local do Turbo Integratordeterminará o valor da célula atual quando Value_Is_String não for 0. (Ou seja,quando a célula atual contiver uma sequência.)

SintaxeSvalue=’String’;

Argumento Descrição

Sequência O valor da célula atual.

Capítulo 7. Variáveis do Turbo Integrator TM1 331

Page 346: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

OnMinorErrorDoItemSkipEsta variável local do Turbo Integrator instrui o Turbo Integrator a ignorar opróximo registro quando for encontrado um erro secundário ao processar umregistro.

Esta variável é útil em cenários nos quais um único campo/valor inválido em umregistro causa vários erros secundários.

Por exemplo, se você tiver 100 funções CELLPUTN em um processo e um doscampos em um determinado registro estiver 'incorreto' ou for inválido, a contagemde erros secundários será incrementada em 100. (1 para cada função CELLPUTNque encontra o erro.) Estes 100 erros secundários são considerados em relação aolimite de erros secundários definido por MinorErrorLogMax. Um processo doTurbo Integrator falha quando ultrapassa o número de erros secundários definidopor MinorErrorLogMax.

Se OnMinorErrorDoItemSkip=1; for incluído na guia Prólogo do processo, oprocesso irá imediatamente para o próximo registro quando for encontrado umcampo 'incorreto' ou inválido em um registro de origem. Ao usar o exemplo acima,isto resulta na contagem de erros secundários sendo incrementada apenas em 1,em vez de 100.

SintaxeOnMinorErrorDoItemSkip=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)indica que o processo deve ir para opróximo registro quando for encontrado umerro secundário.

0 indica que o Turbo Integrator devecontinuar processando o registro atualquando ocorrer um erro secundário.

MinorErrorLogMaxEsta variável local do Turbo Integrator define o número de erros secundários queserão gravados no arquivo TM1ProcessError.log durante a execução do processo.Se esta variável não estiver definida no processo, o número padrão de errossecundários gravados no arquivo de log será 1000.

332 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 347: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeMinorErrorLogMax=N;

Argumento Descrição

N Valor que indica o número de erros quedevem ser gravados no arquivo de log.

Especifique um número inteiro maior quezero para definir o número máximo de errosgravados no arquivo de log.

Especifique um valor de 0 para não registrarerros durante a execução do processo.

Especifique um valor de -1 para permitirque um número ilimitado de errossecundários sejam gravados no arquivo delog.

The following table provides an example error log messageand the corresponding result.

Exemplo Resultado

MinorErrorLogMax=750; O arquivo de log aceitará até 750 erros.

MinorErrorLogMax=0; Nenhum erro será gravado no arquivo delog.

MinorErrorLogMax=-1; Não há limite no número de erros gravadosno arquivo de log.

DataSourceODBOCatalogEsta variável local do Turbo Integrator define o nome da coleção do banco dedados que contém os cubos, dimensões ou outros objetos aos quais você desejaconectar-se. Para Microsoft Analysis Services, esse é o nome do banco de dados.

SintaxeDataSourceODBOCatalog=’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ãoadicionais que podem ser necessários para conectar-se ao servidor OLAP.

Capítulo 7. Variáveis do Turbo Integrator TM1 333

Page 348: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeDataSourceODBOConnectionString=’String’;

Argumento Descrição

Sequência O valor usado para definir parâmetros deconexão adicionais.

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 OLAPque você deseja usar como uma origem de dados.

SintaxeDataSourceODBOCubeName=’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 adimensão específica que está sendo usada como uma origem de dados. Use estavariável para outros produtos OLAP, tais como, SAP BW, nos quais uma hierarquiaé um objeto separado.

Esta variável não é usada com origens de dados do TM1 .

SintaxeDataSourceODBOHierarchyName=’Name’;

Argumento Descrição

Nome O nome da hierarquia para uma dimensãoespecífica.

DataSourceODBOLocationEsta variável local do Turbo Integrator define o nome do local (sistema) onde oservidor OLAP está em execução.

O TM1 utiliza essa variável, mas outros servidores OLAP não. Para o TM1 , este éo local onde o Host Administrador está em execução.

334 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 349: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeDataSourceODBOLocation=’Location’;

Argumento Descrição

Local O nome do local (sistema) para o servidorOLAP.

DataSourceODBOProviderEsta variável local do TurboIntegrator do IBM Cognos TM1 configura o nome doprovedor ODBO que você deseja usar como origem de dados. Este é o nomecompleto designado pelo fabricante do provedor ODBO para identificar seuservidor de banco de dados multidimensional.

Você deve usar o nome de um provedor ODBO que está instalado no servidor.

SintaxeDataSourceODBOProvider=’Provider’;

Argumento Descrição

Provedor O nome do provedor ODBO a ser usadocomo uma origem de dados.

Os nomes de provedores comumente usadosincluem:

Provedor OLE DB MD do TM1

Microsoft OLE DB Provider for OLAPServices 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 no servidor SAP ao qual você deseja conectar-se.

SintaxeDataSourceODBOSAPClientID=’ID’;

Argumento Descrição

ID Um número que corresponde à versão da UIno servidor SAP.

Por exemplo, 498.

DataSourceODBOSAPClientLanguageEsta variável local do Turbo Integrator define a especificação de idioma para oidioma do sistema SAP ao qual você deseja conectar-se.

Capítulo 7. Variáveis do Turbo Integrator TM1 335

Page 350: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeDataSourceODBOSAPClientLanguage=’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 adocumentação do SAP.

Variáveis Globais do Turbo IntegratorEste tipo de variável do Turbo Integrator está associado a uma tarefa deorganização de processos individual do TM1 ou a um processo individual equaisquer subprocessos do operador. Há dois tipos de variáveis globais: implícita edefinida 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:v As variáveis globais podem ser declaradas em um processo que faz parte de

uma tarefa de organização de processos especificada. Depois de declaradas, asvariáveis globais ficam disponíveis para os demais processos que fazem parte datarefa de organização de processos. As variáveis persistem enquanto a tarefa deorganização de processos está em execução e durante a sessão do servidor atual.As variáveis globais são destruídas no encerramento do servidor.

v As variáveis globais podem ser declaradas em um processo e podem serdisponibilizadas para quaisquer processos subsequentes chamados pela funçãoExecuteProcess( ). Estes subprocessos devem usar as mesmas instruções dedeclaração de variável global (descritas abaixo) para acessar as variá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ável local terá precedência e substituirá a variável global.

As variáveis globais são declaradas em um processo do Turbo Integrator usandouma das duas funções a seguir:v NumericGlobalVariable('VariableName');.v StringGlobalVariable('VariableName');.

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.

336 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 351: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Variáveis Globais ImplícitasAo executar um processo do Turbo Integrator, é gerado um conjunto de variáveisglobais implícitas. Se o processo que está gerando as variáveis fizer parte de umatarefa de organização de processos, estas variáveis globais estarão disponíveis epoderão ser compartilhadas pelos demais processos na tarefa de organização deprocessos. Além disso, todas as variáveis globais implícitas em um processo estãodisponíveis e podem ser compartilhadas por quaisquer processos subsequenteschamados pela função ExecuteProcess( ).

Embora as variáveis implícitas sejam geradas pelo processo do Turbo Integrator,você deve declarar uma variável antes que ela seja usada em um processo

As variáveis globais implícitas são declaradas em um processo do Turbo Integratorusando NumericGlobalVariable('VariableName');:

Clique em um link abaixo para obter detalhes sobre variáveis globais implícitasespecíficas.v DataMinorErrorCount.v MetadataMinorErrorCount.v ProcessReturnCode.v PrologMinorErrorCount.

Por exemplo, para usar a variável global implícita PrologMinorErrorCount em umprocesso, 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 naparte Dados de um processo do Turbo Integrator. Para cada erro secundárioencontrado, o valor da variável é incrementado em 1.

SintaxeDataMinorErrorCount=N;

Argumento Descrição

N O número de erros secundários encontradosna parte Dados do processo.

MetadataMinorErrorCountEsta variável global do Turbo Integrator conta os erros secundários que ocorrem naparte Metadados de um processo do Turbo Integrator. Para cada erro secundárioencontrado, o valor da variável é incrementado em 1.

Capítulo 7. Variáveis do Turbo Integrator TM1 337

Page 352: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeMetadataMinorErrorCount=N;

Argumento Descrição

N O número de erros secundários encontradosna parte Metadados do processo.

ProcessReturnCodeEsta variável global do Turbo Integrator armazena o status de saída dos processosdo Turbo Integrator executados mais recentemente.

SintaxeProcessReturnCode=StatusCode;

Código de Status Descrição

ProcessExitByChoreQuit() indica que o processo foi encerrado devido àexecução da função ChoreQuit

ProcessExitNormal() indica que o processo foi executadonormalmente

ProcessExitMinorError() indica que o processo foi executadonormalmente, mas encontrou errossecundários

ProcessExitByQuit() indica que o processo foi encerrado devido aum comando "quit" explícito

ProcessExitWithMessage() indica que o processo foi encerradonormalmente com uma mensagem gravadaem tm1server.log.

ProcessExitSeriousError() indica que o processo foi encerrado devido aum erro grave

ProcessExitOnInit() indica que o processo foi interrompidodurante a inicialização

ProcessExitByBreak() indica que o processo foi encerrado porqueencontrou uma função ProcessBreak

PrologMinorErrorCountEsta variável global do Turbo Integrator conta os erros secundários que ocorrem naparte Prólogo de um processo do Turbo Integrator. Para cada erro secundárioencontrado, o valor da variável é incrementado em 1.

338 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 353: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxePrologMinorErrorCount=N;

Argumento Descrição

N O número de erros secundários encontradosno Prólogo.

Variáveis de Usuário do Turbo IntegratorEste tipo de variável está associado a um usuário individual do TM1 , não aqualquer processo ou tarefa de organização de processos específica. As variáveis deusuário podem ser manipuladas a partir de qualquer processo ou tarefa deorganização de processos do Turbo Integrator enquanto o usuário, ao qual avariável está associada, estiver com logon efetuado no servidor.

As variáveis de usuário devem ser declaradas explicitamente. Logo que declaradas,as variáveis do usuário persistem durante a existência da sessão do usuário doTM1 (até que o usuário efetue logoff ou seja desconectado do servidor).

As variáveis de usuário são declaradas em um processo do Turbo Integratorusando uma das duas funções a seguir:v NumericSessionVariable('VariableName');.v StringSessionVariable('VariableName');.

As variáveis de usuário são criadas na primeira vez que uma declaração éencontrada em qualquer processo do Turbo Integrator em execução.

Logo que criado, o nome da variável pode ser mencionado e usado da mesmaforma que qualquer variável local ou global, exceto que o valor da variável persisteem processos e tarefas, contanto que o usuário que criou a variável esteja comlogon efetuado no servidor.

NumericSessionVariable('VariableName');Use esta função para declarar uma variável de usuário numérica.

StringSessionVariable('VariableName');Use esta função para definir uma variável de usuário de sequência.

Capítulo 7. Variáveis do Turbo Integrator TM1 339

Page 354: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

340 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 355: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Capítulo 8. Suporte a Funções MDX

Todas as funções suportadas do TM1 definidas pela Microsoft e as funçõesespecíficas do TM1 estão listadas nesta seção.

Suporte para Expressões e Funções MDX Definidas pela MicrosoftO TM1 suporta expressões e funções MDX definidas pela Microsoft.

A implementação do TM1 dessas funções e expressões é baseada em definições nabiblioteca Microsoft MSDN, que está disponível no web site do Microsoft MSDN.

Lista de Expressões de Membro SuportadasAs expressões de membro MDX a seguir são suportadas.v <dimension>.CURRENTMEMBERv <member>.FIRSTCHILDv <member>.FIRSTSIBLINGv <member>.LAGv <member>.LASTCHILDv <member>.LASTSIBLINGv <member>.LEADv <member>.NEXTMEMBERv <member>.PARENTv <member>.PREVMEMBER

Lista de Funções de Membro SuportadasAs funções de membro MDX a seguir são suportadas.v ANCESTOR(...)v COUSIN(...)v OPENINGPERIOD(...)v PARALLELPERIOD(...)

Lista de Funções Numéricas SuportadasAs funções numéricas MDX a seguir são suportadas.v AGGREGATE(...)v AVG(...)v CORRELATION(...)v COUNT(...)v COVARIANCE(...)v LINREGINTERCEPT(...)v LINREGPOINT(...)v LINREGR2(...)v LINREGSLOPE(...)v LINREGVARIANCE(...)v MAX(...)

© Copyright IBM Corp. 2007, 2013 341

Page 356: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

v MEDIAN(...)v MIN(...)v RANK(...)v STDDEV(...)v SUM(...)v VAR(...)

Lista de Expressões do Conjunto SuportadasAs expressões de conjunto MDX a seguir são suportadas.v <dimension>.MEMBERSv <level>.MEMBERSv <member>. CHILDRENv <member>.SIBLINGS

Lista de Funções do Conjunto SuportadasAs funções de conjunto MDX a seguir são suportadas.v ADDCALCULATEDMEMBERS(...)v BOTTOMCOUNT(...)v BOTTOMPERCENT(...)v BOTTOMSUM(...)v CROSSJOIN(...)v DESCENDANTS(...)v DISTINCT(...)v DRILLDOWNLEVEL(...)v DRILLDOWNLEVELBOTTOM(...)v DRILLDOWNLEVELTOP(...)v DRILLDOWNMEMBER(...)v DRILLDOWNMEMBERBOTTOM(...)v DRILLDOWNMEMBERTOP(...)v DRILLUPMEMBER(...)v DRILLUPLEVEL(...)v EXCEPT(...)v EXTRACT(...)v FILTER(...)v GENERATE(...)v HEAD(...)v HIERARCHIZE(...)v INTERSECT(...)v LASTPERIODS(...)v ORDER(...)v PERIODSTODATE(...)v TOPCOUNT(...)v TOGGLEDRILLSTATE(...)v TOPPERCENT(...)v TOPSUM(...)

342 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 357: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

v SUBSET(...)v UNION(...)

Lista de Expressões de Tupla SuportadasAs expressões de tupla MDX a seguir são suportadas.v <set>.CURRENTMEMBERv <set>[.ITEM](...)

TM1 - Funções MDX EspecíficasO TM1 suporta várias expressões MDX específicas do TM1 . É possível aplicaressas expressões ao desenvolver aplicativos MDX para serem executados noservidor ou ao criar/editar subconjuntos dinâmicos na Janela de Expressão doEditor de Subconjunto.

TM1FILTERBYPATTERN(<configurar>, <pattern_str>)Esta função MDX específica do TM1 retorna todos os membros em <set> comnomes correspondentes ao padrão <pattern_str>.

A sintaxe de <pattern_str> é a mesma usada para a opção Selecionar por ExpressãoRegular no Editor de Subconjunto.

TM1FILTERBYLEVEL( <set>, <level_number>)Esta função MDX específica do TM1 retorna todos os membros em <set> do<level_number> especificado.

<level_number> é um número que especifica o número de nível do TM1, não umnúmero de nível do MDX.

TM1DRILLDOWNMEMBER(<set1>, <set2>|TODOS[,RECURSIVE])

Essa função MDX específica do TM1 é similar à função DRILLDOWNMEMBERdeMicrosoft , mas ela foi ajustada para corresponder com a funcionalidade dobotão Expandir {bmct expand_button.bmp} no Editor de Subconjunto.

ALL significa fazer drilldown de todos os membros em <set1>.

RECURSIVE significa que está sendo feito drill down de um membro do <set1>;também será feito, recursivamente, o drill down de cada membro consolidadoresultante dessa expansão, até que o nível 0 (nível 0 do TM1 ) seja atingido.

TM1MemberEsta função retorna um membro de uma tupla especificada.

É retornada uma referência de membro nula quando é encontrada alguma dasseguintes condições:v Um parâmetro Tuple nulov Um parâmetro Index numérico fora do intervalov Um parâmetro de dimensão ou de hierarquia não localizado na tupla

transmitida.

Capítulo 8. Suporte a Funções MDX 343

Page 358: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeTM1Member(Tuple, MemberSpecifier);

Argumento Descrição

Tuple Uma expressão que é resolvida para umatupla.

MemberSpecifier Este parâmetro pode ser um índice numéricobaseado em 0 na tupla ou o nome de umadimensão/hierarquia associada à tupla.Consulte abaixo para obter exemplos quemostram os dois tipos de parâmetros.

Exemplo

TM1Member ( [model].Members.Item(23) ,0 ) ] Este exemplo usa um índicenumérico na tupla como o argumento MemberSpecifier.

TM1Member( [model].Members.Item(23), [Model] ) ] Este exemplo usa o nome deuma dimensão associada à tupla como o argumento MemberSpecifier.

TM1SORT(<Configurar>, ASC|DESC )Esta função MDX específica do TM1 classifica <set> em ordem alfabética.

ASC classifica A-Z

DESC classifica Z-A

TM1SORTBYINDEX( <Configurar>, ASC|DESC )Esta função MDX específica do TM1 classifica <set> pelo valor de índice dosmembros.

ASC classifica por valor de índice crescente.

DESC classifica por valor de índice decrescente.

TM1SUBSETALL( <dimname>)Esta função MDX específica do TM1 retorna o subconjunto Todos do TM1 de<dimname>.

TM1SubsetToSetEsta função retorna os membros de um subconjunto do TM1 .

TM1SubsetToSet é equivalente à expressão <dimension>.<subsetname>, mas nãorequer literais de sequência. Em vez disso, TM1SubsetToSet permite usarexpressões que são resolvidas para a dimensão e subconjunto apropriados.

Se dimensões com nomes idênticos forem localizadas em dois cubos diferentes,insira um nome completo, como [cube].[dimension].

344 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 359: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

SintaxeTM1SubsetToSet(Cube.Dimension_exp, Subset_exp);

Argumento Descrição

Dimension_exp Uma expressão que é resolvida para umnome da dimensão do TM1 válido.

Use o formato completo de[cube].[dimension] para identificar asdimensões se houver dimensões com nomesidênticos nos cubos.

Subset_exp Uma expressão que é resolvida para umsubconjunto válido da dimensão retornadapor Dimension_exp.

Ao resolver uma expressão de umsubconjunto, o servidor procura primeiro nalista de subconjuntos particulares na listapública.

Exemplo

Código de amostra MDX com o nome da dimensão [Corp Planning Hry] na últimalinha:{INTERSECT(EXCEPT(DESCENDANTS([Corp Planning Hry].[Fixed Assets]),TM1FILTERBYLEVEL(DESCENDANTS([Corp Planning Hry].[Fixed Assets]),0)),{TM1SubsetToSet([Corp Planning Hry],"elist")}),[Corp Planning Hry].[FixedAssets]}

Código de amostra MDX com o nome da dimensão completo [Corp PlanningHry].[Corp Planning Hry] e [Corp Planning Hry].[FixedAssets] na última linha:{INTERSECT(EXCEPT(DESCENDANTS([Corp Planning Hry].[Fixed Assets]),TM1FILTERBYLEVEL(DESCENDANTS([Corp Planning Hry].[Fixed Assets]),0)),{TM1SubsetToSet([Corp Planning Hry].[Corp Planning Hry],"elist")}),[Corp Planning Hry].[FixedAssets]}

TM1TupleSizeEsta função retorna o número de membros em uma tupla.

SintaxeTM1TupleSize(Tuple);

Argumento Descrição

Tupla Uma expressão que é resolvida para umatupla.

A função retorna 0 se o argumento Tuplenão for resolvido para uma tupla válida, ouse a tupla for nula ou estiver vazia.

Capítulo 8. Suporte a Funções MDX 345

Page 360: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

TM1 -Expressões MDX EspecíficasO TM1 suporta várias expressões MDX específicas do TM1 . É possível aplicaressas expressões ao desenvolver aplicativos MDX para serem executados noservidor ou ao criar/editar subconjuntos dinâmicos na Janela de Expressão doEditor de Subconjunto.

<Dimensão>.<Subsetname>Esta expressão MDX específica do TM1 retorna os membros de <subsetname> em<dimension>.

Como a mesma sintaxe ( <dimension>.IDENTIFIER ) é usada para membros eníveis, um subconjunto com o mesmo nome de um membro ou um nível nuncaserá instanciado.

Ao procurar um subconjunto, o servidor procura primeiro na lista de subconjuntosparticulares e, então, na lista pública.

<membro>.ANCESTORSEsta expressão MDX específica do TM1 retorna os antecessores de <member>.

Por exemplo, considerando a seguinte hierarquia da dimensão Mês:v Ano

– 1 Trimestre– Jan– Fev– Mar

a expressão

month.jan.ANCESTORS

retorna o conjunto

{ 1Trimestre, Ano }.

Se o membro tiver mais de um pai imediato, a expressão retornará o conjunto quecontém o primeiro pai na hierarquia padrão. Considere uma hierarquia de umadimensão Região, em que o membro Bélgica tem mais de um pai imediato, sendoBenelux e Europa. Neste caso, a expressão

region.belgium.ANCESTORS

retorna o conjunto

{ Benelux, Europa }.

346 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 361: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Avisos

Estas informações foram desenvolvidas para produtos e serviços oferecidos emtodo o mundo.

É possível que a IBM não ofereça os produtos, serviços ou recursos discutidosnesta publicação em outros países. Consulte um representante IBM local para obterinformações sobre produtos e serviços disponíveis atualmente em sua área.Qualquer referência a produtos, programas ou serviços IBM não significa queapenas produtos, programas ou serviços IBM possam ser utilizados. Qualquerproduto, programa ou serviço funcionalmente equivalente, que não infrinjanenhum direito de propriedade intelectual da IBM poderá ser utilizado emsubstituição a este produto, programa ou serviço. Entretanto, a avaliação everificaçã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 ourecursos que não estão incluídos no Programa ou autorização de licença adquiridopelo Cliente.

A IBM pode ter patentes ou solicitações de patentes pendentes relativas a assuntostratados nesta publicação. O fornecimento desta publicação não lhe garante direitoalgum sobre tais patentes. Consultas sobre 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 deCaracteres de Byte Duplo), entre em contato com o Departamento de PropriedadeIntelectual da IBM em seu país ou envie pedidos de licença, por escrito, para:

IBM World Trade Asia CorporationLicensing2-31 Roppongi 3-chome, Minato-kuTokyo 106Japan

O parágrafo a seguir não se aplica ao Reino Unido e a nenhum país em que taisdisposições não estejam de acordo com a legislação local: A INTERNATIONALBUSINESS MACHINES CORPORATION FORNECE ESTA PUBLICAÇÃO "NOESTADO EM QUE SE ENCONTRA", SEM GARANTIA DE NENHUM TIPO, SEJAEXPRESSA OU IMPLÍCITA, INCLUINDO, MAS A ELAS NÃO SE LIMITANDO,AS GARANTIAS IMPLÍCITAS DE NÃO INFRAÇÃO, COMERCIALIZAÇÃO OUADEQUAÇÃO A UM DETERMINADO PROPÓSITO. Alguns países não permitema exclusão de garantias expressas ou implícitas em certas transações; portanto, essadisposição pode não se aplicar ao Cliente.

Essas informações podem incluir imprecisões técnicas ou erros tipográficos. Sãofeitas alterações periódicas nas informações aqui contidas; tais alterações serão

© Copyright IBM Corp. 2007, 2013 347

Page 362: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

incorporadas em futuras edições desta publicação. A IBM pode, a qualquermomento, aperfeiçoar e/ou alterar os produtos e/ou programas descritos nestapublicação, sem aviso prévio.

Quaisquer referências nestas informações a Web sites não IBM são fornecidasapenas para conveniência e não funcionam, de maneira nenhuma, como umendosso desses Web sites. Os materiais nesses Web sites não fazem parte dosmateriais 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 julgarapropriada sem incorrer em qualquer obrigação para com o Cliente.

Licenciados deste programa que desejam obter informações sobre este assunto comobjetivo de permitir: (i) a troca de informações entre programas criadosindependentemente e outros programas (incluindo este) e (ii) a utilização mútuadas informações trocadas, devem entrar em contato com:

Gerência de Relações Comerciais e Industriais da IBM BrasilAv. Pasteur, 138-146BotafogoRio de Janeiro,RJCEP 22290-240

Tais informações podem estar disponíveis, sujeitas aos termos e condiçõesapropriados, incluindo, em alguns casos, o pagamento de uma taxa.

O programa licenciado descrito nesta publicação e todo o material licenciadodisponível a ele são fornecidos pela IBM sob os termos do IBM CustomerAgreement, do Contrato de Licença do Programa Internacional da IBM ou dequalquer contrato equivalente entre as partes.

Os dados de desempenho aqui contidos foram determinados em um ambientecontrolado. Portanto, os resultados obtidos em outros ambientes operacionaispodem variar significativamente. Foram tomadas algumas medidas nos sistemas denível de desenvolvimento e não há nenhuma garantia de que estas medidas sejamas mesmas nos sistemas geralmente disponíveis. Além disso, algumas medidaspodem ter sido estimadas por meio de extrapolação. Os resultados reais podemvariar. Os usuários desta publicação devem verificar os dados aplicáveis ao seuambiente específico.

As informações relativas a produtos não IBM foram obtidas dos fornecedoresdesses produtos, dos anúncios publicados ou de outras fontes publicamentedisponíveis. A IBM não testou esses produtos e não pode confirmar a exatidão dodesempenho, da compatibilidade ou de outras solicitações relacionadas a produtosnão IBM. Questões sobre os recursos de produtos não IBM devem ser endereçadasaos fornecedores desses produtos.

Todas as instruções relativas a futuras orientações ou intenções da IBM estãosujeitas a alteração ou retirada sem aviso prévio e apenas representam metas eobjetivos.

Estas informações contêm exemplos de dados e relatórios usados em operações denegócios diárias. Para ilustrá-las da maneira mais completa possível, os exemplos

348 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 363: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

incluem os nomes de indivíduos, empresas, marcas e produtos. Todos esses nomessão fictícios e qualquer semelhança com nomes e endereços usados por umaempresa real é totalmente coincidência.

Se estiver visualizando estas informações em formato eletrônico, as fotografias eilustrações coloridas poderão não aparecer.

Marcas Registradas

IBM, o logotipo IBM e ibm.com são marcas ou marcas registradas da InternationalBusiness Machines Corp., registradas em vários países no mundo todo. Outrosnomes de produtos e serviços podem ser marcas registradas da IBM ou de outrasempresas. Uma lista atual de marcas registradas IBM 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:v Adobe, o logotipo Adobe, PostScript e o logotipo PostScript são marcas ou

marcas registradas da Adobe Systems Incorporated nos Estados Unidos e/ou emoutros países.

v Microsoft, Windows, Windows NT e o logotipo Windows são marcas registradasda Microsoft Corporation nos Estados Unidos e/ou em outros países.

v UNIX é uma marca registrada do The Open Group nos Estados Unidos e/ou emoutros países.

Capturas de tela dos produtos Microsoft usadas com permissão da Microsoft.

Avisos 349

Page 364: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

350 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 365: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Índice Remissivo

AABS 147acesso

Designações de Segurança de privilégios 55funções de macro 165

ACOS 147AddClient 285AddCubeDependency 228AddGroup 286AddInfoCubeRestriction 318Administrador

Designações de Segurança 58Secure Socket Layer do Servidor, Opções do TM1 80

AGORA 123ALEATÓRIO 152ANO 129aplicativo

Server Explorer 63área de janela direita (Área de Janela Propriedades)

Server Explorer 60área de janela esquerda (Área de Janela em Árvore)

Server Explorer 60ARRUMAR 161ASCII

e Funções de Texto do Turbo Integrator 217ASCIIDelete 217ASCIIOutput 219ASEN 148assistente de relatório de impressão 43assistente de Relatório de Impressão 43AssociateCAMIDToGroup 287ATAN 148atributo

Editor 10Editor do Turbo Integrator 100Funções de Manipulação do Turbo Integrator 224

AttrDelete 224AttrInsert 225ATTRN 130AttrPutN 226AttrPutS 226ATTRS 131avançado

Grade de Mapeamento 7guia do Editor do Turbo Integrator 105Opções 7

Bbarra de ferramentas 52barra de status 52BatchUpdateFinish 236, 294, 296BatchUpdateFinishWait 295BatchUpdateStart 295bloqueio

Designações de Segurança 58botão de ação

propriedades 3botão de ação aparência 6

botõesEditor do Turbo Integrator 99

Ccaixa de diálogo abrir subconjunto 42caixa de diálogo abrir visualização 43Caixa de Diálogo Aliases do TM1 79Caixa de Diálogo Excluir Subconjuntos Nomeados 27Caixa de Diálogo Excluir Visualizações Nomeadas 27caixa de diálogo novo atributo 42Caixa de Diálogo Obter Visualização (In-Spreadsheet

Browser) 40caixa de diálogo opções de processo 47Caixa de Diálogo Opções do TM1 79caixas de diálogo 3caixas de diálogo janelas 3CAPIT 155CARACT 156CellGetN 229CellGetS 230CellIncrementN 230CellIsUpdateable 231CellPutN 232CellPutProportionalSpread 233CellPutS 233CellSecurityCubeCreate 288CellSecurityCubeDestroy 288Chinês 51Clientes

Caixa de Diálogo Centro de Mensagens 21Grupos/grade 19, 20Janela/Grupo 19menu Clientes/Grupos 19

CÓDIGO 156comentários 51comparação 111conclusão automática 52conjunto de caracteres 219conjuntos de caracteres grandes 51Connect Server 40consolidação

Editor do Turbo Integrator 100ConsolidatedAvg 114ConsolidatedCount 115ConsolidatedCountUnique 116ConsolidatedMax 113ConsolidatedMin 112consulta do log de transações

caixa de diálogo 81caixa de diálogo resultados 81

contenção de bloqueio 298CONTINUE 145controle

objetos 52opções 53

Coreano 51COS 148criar

caixa de diálogo dimensão 21caixa de diálogo do cubo 22

© Copyright IBM Corp. 2007, 2013 351

Page 366: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

criar (continuação)objeto de replicação do servidor 22

CubeClearData 234CubeCreate 235CubeDataReservationAcquire 239CubeDataReservationGet 242CubeDataReservationGetConflicts 244CubeDataReservationRelease 240CubeDataReservationReleaseAll 241CubeDestroy 235CubeExists 236CubeGetLogChanges 236CubeProcessFeeders 272CubeRuleAppend 273CubeRuleDestroy 274CubeSetConnParams 238CubeSetLogChanges 239CubeUnload 239CubeView

Server Explorer 68cubo

Caixa de Diálogo Propriedades 24Editor de Subconjunto de Informações 48Editor do Turbo Integrator 100funções de manipulação do Turbo Integrator 228otimizando 24Server Explorer 64, 65Visualizador 24

DD_FSAVE 168D_PICK 166D_SAVE 168dados

Editor do Turbo Integrator 100, 105guia origem do Editor do Turbo Integrator 83

DATA 121data e hora

funções do Turbo Integrator 245DataMinorErrorCount 337DatasourceASCIIDecimalSeparator 330DatasourceASCIIDelimiter 329DatasourceASCIIHeaderRecords 331DatasourceASCIIQuoteCharacter 330DatasourceASCIIThousandSeparator 330DatasourceCubeview 329DatasourceDimensionSubset 329DatasourceNameForClient 327DatasourceNameForServer 327DataSourceODBOCatalog 333DataSourceODBOConnectionString 334DataSourceODBOCubeName 334DataSourceODBOHierarchyName 334DataSourceODBOLocation 335DataSourceODBOProvider 335DataSourceODBOSAPClientID 335DataSourceODBOSAPClientLanguage 336DatasourcePassword 328DatasourceQuery 329DataSourceSAPUsingRoleAuths 320DataSourceSAPUsingTexts 320DatasourceType 328DatasourceUsername 328DATES 121DAYNO 122DBProportionalSpread 166

DBR 192DBRA 192DBRW 193DBS 194DBSA 195DBSS 195DBSW 197DELET 157DeleteAllPersistentFeeders 275DeleteClient 289DeleteGroup 289designar

ClientPassword 287ClientToGroup 286grade Designações de Segurança 55

DFRST 197DIA 122dicas de ferramentas 52dimensão

Caixa de Diálogo Inserir Elemento 32Caixa de Diálogo Ordenação de Elementos 33Caixa de Diálogo Propriedades do Elemento 33Editor de Subconjunto de Informações 49Editor do Turbo Integrator 100Funções de Manipulação do Turbo Integrator 247Funções de Regras de Informações 130menu Editor de Dimensão 28nome do subconjunto 346Server Explorer 66

DimensionCreate 247DimensionDeleteAllElements 248DimensionDestroy 248DimensionElementComponentAdd 249DimensionElementComponentAddDirect 250DimensionElementComponentDelete 250DimensionElementComponentDeleteDirect 251DimensionElementDelete 252DimensionElementDeleteDirect 253DimensionElementInsert 253DimensionElementInsertDirect 255, 260DimensionElementPrincipalName 256DimensionExists 256, 258DimensionSortOrder 257DimensionTopElementInsert 259dimensões da coluna

Cube Viewer 24dimensões de título

Cube Viewer 24DIMIX 137, 198DIMNM 134, 198DIMSIZ 135, 199DisableBulkLoadMode 297diversas

Funções das Regras 162Funções do Turbo Integrator 318

DNEXT 135, 199DNLEV 136, 200DTYPE 137, 200

EE_PICK 169editar

Caixa de Diálogo Fórmula 34Caixa de Diálogo Referência ao Cubo 35

Editor 83ELCOMP 138, 201

352 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 367: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

ELCOMPN 139, 201elemento

área de janela Editor de Dimensão 28área de janela Editor de Subconjunto 73Funções de Regras de Informações 137

ElementSecurityGet 290ElementSecurityPut 290ELISANC 139ELISCOMP 140, 202ELISPAR 140, 203ELLEV 141, 203ELPAR 142, 204ELPARN 142, 205ELSEN 205ELWEIGHT 143, 206EnableBulkLoadMode 297epílogo

Editor do Turbo Integrator 105Excel

funções de macro da versão 8 e mais recente 165funções de macro das versões 5 e 7 165

ExecuteCommand 264ExecuteProcess 265, 336EXP 149Expandir 321Exponenciação 111expressões MDX Específicas do TM1 346

FFEEDERS 162FEEDSTRINGS 162FileExists 321FILL 157filtrar

caixa de diálogo do subconjunto 36caixa de diálogo elementos por atributo 36caixa de diálogo elementos por nível 36caixa de diálogo visualizar 38

ForceSkipCheck 275FormatDate 245Fórmula de Variável do Processo 100função RefreshMdxHierarchy 323funções

MDX 341planilha 191regras 111, 165Turbo Integrator 217

Funções de Cálculo 112funções de macro

acessando 165lista 165

funções de regras de texto 155funções de regras financeiras 143funções de regras matemáticas 147funções de Reserva de Dados do Turbo Integrator

CubeDataReservationAcquire 239CubeDataReservationGet 242CubeDataReservationGetConflicts 244CubeDataReservationRelease 240CubeDataReservationReleaseAll 241

funções do Ambiente de Simulação 276funções do conjunto

MDX 342funções MDX Específicas do TM1 343Funções Open Database Connectivity do Turbo

Integrator 260

GGetProcessErrorFileDirectory 266GetProcessErrorFilename 267GetProcessName 267GetUseActiveSandboxProperty 277grade

Editor do Turbo Integrator 99grade de visualização

Editor do Turbo Integrator 98gravar

Designações de Segurança 57Grupo de Servidores

Server Explorer 60guia mapas do Editor do Turbo Integrator 100guia Programação

Editor do Turbo Integrator 107guias

Editor do Turbo Integrator 83

HHOJE 128

II_EXPORT 170I_NAMES 171I_PROCESS 172ignorar parâmetros

Extração de Visualização 107importar 51Imprimir 51indentação 51inserir referência do cubo 53INSRT 158INT 149ISUND 149ISUNDEFINEDCELLVALUE 118ItemReject 269ItemSkip 269

Jjanela Detalhes do log de auditoria 17janela Log de Auditoria 12janela log de mensagens 41Japonês 51

KKEY_ERR 191

Ller

Designações de Segurança 56linha

Cube Viewer 24LN 150Localizar 51LOG 150Log de auditoria

janela 12janela detalhes 17

Índice Remissivo 353

Page 368: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

Log de mensagensjanela 41

lógicaFunções das Regras 145operadores 112

LONG 158

MM_CLEAR 172MAIÚSCULA 161mapeamento automático 7marcadores 51MÁXIMO 151MDX

expressões específicas do TM1 346funções 341funções específicas do TM1 343

memberexpressões MDX 341

membroANCESTORS 346funções MDX 341

menu ajudaJanela Log de Mensagens 42

menu arquivoAtributos 10Cube Viewer 25Editor do Turbo Integrator 83Janela Log de Mensagens 42Server Explorer 60

menu de ferramentasEditor de Subconjunto 78

menu dinâmicoServer Explorer 60

Menu do In-Spreadsheet Browser 40menu Editar

Atributos 10Cube Viewer 26Editor de Dimensão 28Editor de Subconjunto 74Editor do Turbo Integrator 83Janela Log de Mensagens 42Resultados da Consulta ao Log da Transação 81Server Explorer 72

menu gruposClientes/Grupos 20

menu visualizarCube Viewer 26Editor de Dimensão 31Editor de Subconjunto 77Server Explorer 73

MÊS 123metadados

Editor do Turbo Integrator 105MetadataMinorErrorCount 338método run 166MÍNIMO 151MinorErrorLogMax 333MINÚSCULA 158módulos VBA

funções de macro 166

NN_CONNECT 173N_DISCONNECT 174nenhum

Designações de Segurança 55NewDateFormatter 246novos recursos 1NumberToString 322NumberToStringEx 322NUMBR 159NumericGlobalVariable(VariableName) 336numérico

funções MDX 341NumericSessionVariable(ariableName 339números da linha 52NValue 331

OODBCClose 261ODBCOpen 261ODBCOPENEx 262ODBCOutput 262OnMinorErrorDoItemSkip 332opções

Atributos 11menu do cube viewer 26Propriedades do Elemento de Dimensão 33

operadores aritméticos 111OPTGET 173OPTSET 174otimizando cubos 24

Pparâmetros

Editor do Turbo Integrator 105parâmetros de login

Opções de TM1 79parâmetros do intervalo

Extração de Visualização 107ParseDate 247PAYMT 144planilha

botão de ação 5funções 191

Preferências 53ProcessBreak 269ProcessError 264, 270processo

botão de ação 4controlar funções do Turbo Integrator 264Server Explorer 71

ProcessQuit 270ProcessReturnCode 338PrologMinorErrorCount 339prólogo

Editor do Turbo Integrator 105propriedades

área de janela Editor de Dimensão 28área de janela Editor de Subconjunto 73área de janela Elemento de Dimensão 33configurações regionais 11

propriedades de configurações regionais 11PublishSubset 176PublishView 176, 307

354 IBM Cognos TM1 Versão 10.2.0: Guia de Referência

Page 369: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

QQUDEFINE 177QUDEFINEEX 179quebra automática de linha 52QUEXPORT 181QULOOP 183QUSUBSET 183

RR_SAVE 184RAIZ 155regiões definidas pelo usuário 52regra

funções 111funções de gerenciamento do Turbo Integrator 272funções de macro 165Informações do Editor de Subconjunto 49

RemoveCAMIDAssociation 291RemoveCAMIDAssociationFromGroup 292RemoveClientFromGroup 292remover comentário 51replicar

Server Explorer 69replicar cubo

caixa de diálogo 48Server Explorer 70

reservarDesignações de Segurança 57

Resto 151ROUND 152ROUNDP 153RuleLoadFromFile 276

Ssalvar

caixa de diálogo do subconjunto 53caixa de diálogo Visualização do In-Spreadsheet

Browser 54Caixa de Diálogo Visualizar 54

SAPCharacteristicTexts 328SaveDataAll 298SCAN 159Se 268SE 146SecurityRefresh 292segurança

caixa de diálogo Designações 55funções do Turbo Integrator 285menu Clientes/Grupos 19

selecionar cubocaixa de diálogo 59para caixa de diálogo de regras 59

selecionar dimensãocaixa de diálogo 59caixa de diálogo planilha 59designações de segurança 59

selecionar elementocaixa de diálogo 60extração de visualização 107

selecionar regracaixa de diálogo planilha 60

SEN 154ServerActiveSandboxGet 281ServerActiveSandboxSet 282

ServerSandboxesDelete 277ServerSandboxExists 283ServerSandboxGet 284ServerSandboxListCountGets 285ServerShutdown 299servidor

Explorer (Janela Principal) 60funções de manipulação do Turbo Integrator 293Server Explorer 61

servidor localOpções de TM1 79

SetChoreVerboseMessages 227SetInputCharacterSet 219SetODBCUnicodeInterface 263SetOutputEscapeDoubleQuote 223SetUseActiveSandboxProperty 283SINAL 154sintaxe 270STET 146, 217STR 160StringGlobalVariable(ariableName 337StringSessionVariable(ariableName 339StringToNumber 324StringToNumberEx 324subconjunto

editor 73funções de manipulação do Turbo Integrator 300menu Editor de Subconjunto 74Server Explorer 69

SUBDEFINE 185SUBNM 207SUBPICK 185SubsetAliasSet 300SubsetCreate 300SubsetCreateByMDX 301SubsetDeleteAllElements 301SubsetDestroy 302SubsetElementDelete 302SubsetElementInsert 303SubsetExists 303SubsetExpandAboveSet 304SubsetFormatStyleSet 305SubsetGetElementName 305SubsetGetSize 306SubsetIsAllSet 306SUBSIZ 207SUBST 160SValue 331synchronized() 270

TT_CLEAR 186T_CREATE 187T_CREATE16 187T_PICK 188T_SAVE 188TABDIM 136, 208TAN 155tarefa de organização de processos 336

Assistente de Configuração 17Encerrar 227Funções de Gerenciamento do Turbo Integrator 227Server Explorer 71, 72

TextOutput 224TIME 124TIMST 124

Índice Remissivo 355

Page 370: Guia de Referência - IBMpublic.dhe.ibm.com/.../docs/pt-br/10.2.0/tm1_ref.pdf · VP.....145 Funções de Regras Lógicas .....145 CONTINUE .....145

TIMVL 126TM1DRILLDOWNMEMBER 343TM1FILTERBYLEVEL 343TM1FILTERBYPATTERN 343TM1Member 344Tm1p.xla 165TM1ProcessError.log 324TM1RECALC 188TM1RECALC1 189TM1RptElIsConsolidated 208TM1RPTELISCONSOLIDATED 214TM1RptElIsExpanded 209TM1RptElLev 209TM1RPTELLSEXPANDED 214TM1RptFilter 210TM1RptRow 210TM1RptTitle 213TM1RptView 213TM1SORTBYINDEX 344TM1SUBSETALL 344TM1SubsetToSet 345TM1TupleSize 345TM1User 214, 325todas as telas

Assistente de Relatório de Impressão 43Turbo Integrator 83, 298

funções 217limite 217Variáveis de Usuário 339Variáveis Globais 336

UUNDEFINEDCELLVALUE 119unindent 51UTF-8 219

VValue_Is_String 331

variáveisglobal 336global implícita 337Guia do Editor do Turbo Integrator 99usuário do Turbo Integrator 339

variáveis Globais 336variáveis globais implícitas 337variáveis locais 327verificar sintaxe 51VF 144VIEW 215ViewColumnDimensionSet 308ViewColumnSuppressZeroesSet 309ViewConstruct 310ViewCreate 310ViewDestroy 311ViewExists 311ViewExtractSkipCalcsSet 312ViewExtractSkipRuleValuesSet 313ViewExtractSkipZeroesSet 313ViewRowDimensionSet 314ViewRowSuppressZeroesSet 315ViewSubsetAssign 315ViewSuppressZeroesSet 316ViewTitleDimensionSet 317ViewTitleElementSet 317ViewZeroOut 318visualização

caixa de diálogo estilos 108funções de manipulação do Turbo Integrator 307Janela Extração 107

VP 145VUSLICE 189

WW_DBSENABLE 190While 270WildcardFileSearch 325

356 IBM Cognos TM1 Versão 10.2.0: Guia de Referência